Cleanup main.h header
[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 #include <gdk-pixbuf/gdk-pixbuf.h>
26
27 #include "main-defines.h"
28
29 struct FileData;
30 struct ImageLoader;
31
32 #if GLIB_CHECK_VERSION (2, 34, 0)
33 #define THUMB_FOLDER_GLOBAL "thumbnails"
34 #else
35 #define THUMB_FOLDER_GLOBAL ".thumbnails"
36 #endif
37 #define THUMB_FOLDER_LOCAL  ".thumblocal"
38 #define THUMB_FOLDER_NORMAL "normal"
39 #define THUMB_FOLDER_LARGE  "large"
40 #define THUMB_FOLDER_FAIL   "fail" G_DIR_SEPARATOR_S GQ_APPNAME_LC "-" VERSION
41 #define THUMB_NAME_EXTENSION ".png"
42
43
44 struct ThumbLoaderStd
45 {
46         gboolean standard_loader;
47
48         ImageLoader *il;
49         FileData *fd;
50
51         time_t source_mtime;
52         off_t source_size;
53         mode_t source_mode;
54
55         gchar *thumb_path;
56         gchar *thumb_uri;
57         const gchar *local_uri;
58
59         gboolean thumb_path_local;
60
61         gint requested_width;
62         gint requested_height;
63
64         gboolean cache_enable;
65         gboolean cache_local;
66         gboolean cache_hit;
67         gboolean cache_retry;
68
69         gdouble progress;
70
71         using Func = void (*)(ThumbLoaderStd *, gpointer);
72         Func func_done;
73         Func func_error;
74         Func func_progress;
75
76         gpointer data;
77 };
78
79
80 ThumbLoaderStd *thumb_loader_std_new(gint width, gint height);
81 void thumb_loader_std_set_callbacks(ThumbLoaderStd *tl,
82                                     ThumbLoaderStd::Func func_done,
83                                     ThumbLoaderStd::Func func_error,
84                                     ThumbLoaderStd::Func func_progress,
85                                     gpointer data);
86 void thumb_loader_std_set_cache(ThumbLoaderStd *tl, gboolean enable_cache, gboolean local, gboolean retry_failed);
87 gboolean thumb_loader_std_start(ThumbLoaderStd *tl, FileData *fd);
88 void thumb_loader_std_free(ThumbLoaderStd *tl);
89
90 GdkPixbuf *thumb_loader_std_get_pixbuf(ThumbLoaderStd *tl);
91
92 void thumb_loader_std_calibrate_pixbuf(FileData *fd, GdkPixbuf *pixbuf);
93
94 /**
95  * @headerfile thumb_loader_std_thumb_file_validate
96  * validates a non local thumbnail file,
97  * calling func_valid with the information when app is idle
98  * for thumbnail's without a file: uri, validates against allowed_age in days
99  */
100 ThumbLoaderStd *thumb_loader_std_thumb_file_validate(const gchar *thumb_path, gint allowed_days,
101                                                      void (*func_valid)(const gchar *path, gboolean valid, gpointer data),
102                                                      gpointer data);
103 void thumb_loader_std_thumb_file_validate_cancel(ThumbLoaderStd *tl);
104
105
106 void thumb_std_maint_removed(const gchar *source);
107 void thumb_std_maint_moved(const gchar *source, const gchar *dest);
108
109
110 #endif
111 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */