Simplify vflist_get_formatted()
[geeqie.git] / src / thumb_standard.h
1 /*
2  * Copyright (C) 2006 John Ellis
3  * Copyright (C) 2008 - 2016 The Geeqie Team
4  *
5  * Author: John Ellis
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 #ifndef THUMB_STANDARD_H
23 #define THUMB_STANDARD_H
24
25
26 #if GLIB_CHECK_VERSION (2, 34, 0)
27 #define THUMB_FOLDER_GLOBAL "thumbnails"
28 #else
29 #define THUMB_FOLDER_GLOBAL ".thumbnails"
30 #endif
31 #define THUMB_FOLDER_LOCAL  ".thumblocal"
32 #define THUMB_FOLDER_NORMAL "normal"
33 #define THUMB_FOLDER_LARGE  "large"
34 #define THUMB_FOLDER_FAIL   "fail" G_DIR_SEPARATOR_S GQ_APPNAME_LC "-" VERSION
35 #define THUMB_NAME_EXTENSION ".png"
36
37
38 typedef struct _ThumbLoaderStd ThumbLoaderStd;
39 typedef void (* ThumbLoaderStdFunc)(ThumbLoaderStd *tl, gpointer data);
40
41 struct _ThumbLoaderStd
42 {
43         gboolean standard_loader;
44
45         ImageLoader *il;
46         FileData *fd;
47
48         time_t source_mtime;
49         off_t source_size;
50         mode_t source_mode;
51
52         gchar *thumb_path;
53         gchar *thumb_uri;
54         const gchar *local_uri;
55
56         gboolean thumb_path_local;
57
58         gint requested_width;
59         gint requested_height;
60
61         gboolean cache_enable;
62         gboolean cache_local;
63         gboolean cache_hit;
64         gboolean cache_retry;
65
66         gdouble progress;
67
68         ThumbLoaderStdFunc func_done;
69         ThumbLoaderStdFunc func_error;
70         ThumbLoaderStdFunc func_progress;
71
72         gpointer data;
73 };
74
75
76 ThumbLoaderStd *thumb_loader_std_new(gint width, gint height);
77 void thumb_loader_std_set_callbacks(ThumbLoaderStd *tl,
78                                     ThumbLoaderStdFunc func_done,
79                                     ThumbLoaderStdFunc func_error,
80                                     ThumbLoaderStdFunc func_progress,
81                                     gpointer data);
82 void thumb_loader_std_set_cache(ThumbLoaderStd *tl, gboolean enable_cache, gboolean local, gboolean retry_failed);
83 gboolean thumb_loader_std_start(ThumbLoaderStd *tl, FileData *fd);
84 void thumb_loader_std_free(ThumbLoaderStd *tl);
85
86 GdkPixbuf *thumb_loader_std_get_pixbuf(ThumbLoaderStd *tl);
87
88 void thumb_loader_std_calibrate_pixbuf(FileData *fd, GdkPixbuf *pixbuf);
89
90 /**
91  * @headerfile thumb_loader_std_thumb_file_validate
92  * validates a non local thumbnail file,
93  * calling func_valid with the information when app is idle
94  * for thumbnail's without a file: uri, validates against allowed_age in days
95  */
96 ThumbLoaderStd *thumb_loader_std_thumb_file_validate(const gchar *thumb_path, gint allowed_age,
97                                                      void (*func_valid)(const gchar *path, gboolean valid, gpointer data),
98                                                      gpointer data);
99 void thumb_loader_std_thumb_file_validate_cancel(ThumbLoaderStd *tl);
100
101
102 void thumb_std_maint_removed(const gchar *source);
103 void thumb_std_maint_moved(const gchar *source, const gchar *dest);
104
105
106 #endif
107 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */