2 * Copyright (C) 2004 John Ellis
3 * Copyright (C) 2008 - 2016 The Geeqie Team
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.
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.
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.
26 #include "image-load.h"
28 #include "pixbuf_util.h"
29 #include "thumb_standard.h"
30 #include "ui_fileops.h"
37 static void thumb_loader_error_cb(ImageLoader *il, gpointer data);
38 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd);
40 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h);
44 *-----------------------------------------------------------------------------
45 * thumbnail routines: creation, caching, and maintenance (public)
46 *-----------------------------------------------------------------------------
49 /* Save thumbnail to disk
50 * or just mark failed thumbnail with 0 byte file (mark_failure = TRUE) */
51 static gboolean thumb_loader_save_thumbnail(ThumbLoader *tl, gboolean mark_failure)
54 gboolean success = FALSE;
57 if (!tl || !tl->fd) return FALSE;
58 if (!mark_failure && !tl->fd->thumb_pixbuf) return FALSE;
60 cache_dir = cache_get_location(CACHE_TYPE_THUMB, tl->fd->path, FALSE, &mode);
62 if (recursive_mkdir_if_not_exists(cache_dir, mode))
66 gchar *name = g_strconcat(filename_from_path(tl->fd->path), GQ_CACHE_EXT_THUMB, NULL);
68 cache_path = g_build_filename(cache_dir, name, NULL);
71 pathl = path_from_utf8(cache_path);
75 FILE *f = fopen(pathl, "w"); ;
77 DEBUG_1("Marking thumb failure: %s", cache_path);
86 DEBUG_1("Saving thumb: %s", cache_path);
87 success = pixbuf_to_file_as_png(tl->fd->thumb_pixbuf, pathl);
93 /* set thumb time to that of source file */
95 ut.actime = ut.modtime = filetime(tl->fd->path);
103 DEBUG_1("Saving failed: %s", pathl);
115 static void thumb_loader_percent_cb(ImageLoader *il, gdouble percent, gpointer data)
117 ThumbLoader *tl = data;
119 tl->percent_done = percent;
121 if (tl->func_progress) tl->func_progress(tl, tl->data);
124 static void thumb_loader_set_fallback(ThumbLoader *tl)
126 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
127 tl->fd->thumb_pixbuf = pixbuf_fallback(tl->fd, tl->max_w, tl->max_h);
130 static void thumb_loader_done_cb(ImageLoader *il, gpointer data)
132 ThumbLoader *tl = data;
136 GdkPixbuf *rotated = NULL;
138 DEBUG_1("thumb done: %s", tl->fd->path);
140 pixbuf = image_loader_get_pixbuf(tl->il);
143 DEBUG_1("...but no pixbuf: %s", tl->fd->path);
144 thumb_loader_error_cb(tl->il, tl);
150 // apply color correction, if required
151 thumb_loader_std_calibrate_pixbuf(tl->fd, pixbuf);
154 if (!tl->cache_hit && options->image.exif_rotate_enable)
156 if (!tl->fd->exif_orientation)
158 tl->fd->exif_orientation = metadata_read_int(tl->fd, ORIENTATION_KEY, EXIF_ORIENTATION_TOP_LEFT);
161 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
163 rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
168 pw = gdk_pixbuf_get_width(pixbuf);
169 ph = gdk_pixbuf_get_height(pixbuf);
171 if (tl->cache_hit && pw != tl->max_w && ph != tl->max_h)
173 /* requested thumbnail size may have changed, load original */
174 DEBUG_1("thumbnail size mismatch, regenerating: %s", tl->fd->path);
175 tl->cache_hit = FALSE;
177 thumb_loader_setup(tl, tl->fd);
179 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
181 if (!image_loader_start(tl->il))
183 image_loader_free(tl->il);
186 DEBUG_1("regeneration failure: %s", tl->fd->path);
187 thumb_loader_error_cb(tl->il, tl);
194 if (pw > tl->max_w || ph > tl->max_h)
198 if (((gdouble)tl->max_w / pw) < ((gdouble)tl->max_h / ph))
201 h = (gdouble)w / pw * ph;
207 w = (gdouble)h / ph * pw;
213 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
214 tl->fd->thumb_pixbuf = gdk_pixbuf_scale_simple(pixbuf, w, h, (GdkInterpType)options->thumbnails.quality);
222 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
223 tl->fd->thumb_pixbuf = pixbuf;
225 g_object_ref(tl->fd->thumb_pixbuf);
227 save = image_loader_get_shrunk(il);
230 if (rotated) g_object_unref(rotated);
233 if (tl->cache_enable && save)
235 thumb_loader_save_thumbnail(tl, FALSE);
238 if (tl->func_done) tl->func_done(tl, tl->data);
241 static void thumb_loader_error_cb(ImageLoader *il, gpointer data)
243 ThumbLoader *tl = data;
245 /* if at least some of the image is available, go to done_cb */
246 if (image_loader_get_pixbuf(tl->il) != NULL)
248 thumb_loader_done_cb(il, data);
252 DEBUG_1("thumb error: %s", tl->fd->path);
254 image_loader_free(tl->il);
257 thumb_loader_set_fallback(tl);
259 if (tl->func_error) tl->func_error(tl, tl->data);
262 static gboolean thumb_loader_done_delay_cb(gpointer data)
264 ThumbLoader *tl = data;
266 tl->idle_done_id = 0;
268 if (tl->func_done) tl->func_done(tl, tl->data);
273 static void thumb_loader_delay_done(ThumbLoader *tl)
275 if (!tl->idle_done_id) tl->idle_done_id = g_idle_add(thumb_loader_done_delay_cb, tl);
278 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd)
280 image_loader_free(tl->il);
281 tl->il = image_loader_new(fd);
282 image_loader_set_priority(tl->il, G_PRIORITY_LOW);
284 /* this will speed up jpegs by up to 3x in some cases */
285 image_loader_set_requested_size(tl->il, tl->max_w, tl->max_h);
287 g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_error_cb, tl);
288 if (tl->func_progress) g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_percent_cb, tl);
291 void thumb_loader_set_callbacks(ThumbLoader *tl,
292 ThumbLoaderFunc func_done,
293 ThumbLoaderFunc func_error,
294 ThumbLoaderFunc func_progress,
299 if (tl->standard_loader)
301 thumb_loader_std_set_callbacks((ThumbLoaderStd *)tl,
302 (ThumbLoaderStdFunc) func_done,
303 (ThumbLoaderStdFunc) func_error,
304 (ThumbLoaderStdFunc) func_progress,
309 tl->func_done = func_done;
310 tl->func_error = func_error;
311 tl->func_progress = func_progress;
316 void thumb_loader_set_cache(ThumbLoader *tl, gboolean enable_cache, gboolean local, gboolean retry_failed)
320 if (tl->standard_loader)
322 thumb_loader_std_set_cache((ThumbLoaderStd *)tl, enable_cache, local, retry_failed);
326 tl->cache_enable = enable_cache;
330 gboolean thumb_loader_start(ThumbLoader *tl, FileData *fd)
332 gchar *cache_path = NULL;
334 if (!tl) return FALSE;
336 if (tl->standard_loader)
338 return thumb_loader_std_start((ThumbLoaderStd *)tl, fd);
341 if (!tl->fd && !fd) return FALSE;
343 if (!tl->fd) tl->fd = file_data_ref(fd);
345 if (tl->fd->format_class != FORMAT_CLASS_IMAGE && tl->fd->format_class != FORMAT_CLASS_RAWIMAGE && tl->fd->format_class != FORMAT_CLASS_COLLECTION && tl->fd->format_class != FORMAT_CLASS_VIDEO && tl->fd->format_class != FORMAT_CLASS_DOCUMENT && !options->file_filter.disable)
347 thumb_loader_set_fallback(tl);
351 if (tl->cache_enable)
353 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
357 if (cache_time_valid(cache_path, tl->fd->path))
359 DEBUG_1("Found in cache:%s", tl->fd->path);
361 if (filesize(cache_path) == 0)
363 DEBUG_1("Broken image mark found:%s", cache_path);
365 thumb_loader_set_fallback(tl);
369 DEBUG_1("Cache location:%s", cache_path);
379 if (!cache_path && options->thumbnails.use_xvpics)
381 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
382 tl->fd->thumb_pixbuf = get_xv_thumbnail(tl->fd->path, tl->max_w, tl->max_h);
383 if (tl->fd->thumb_pixbuf)
385 thumb_loader_delay_done(tl);
392 FileData *fd = file_data_new_no_grouping(cache_path);
393 thumb_loader_setup(tl, fd);
396 tl->cache_hit = TRUE;
400 thumb_loader_setup(tl, tl->fd);
403 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
404 if (!image_loader_start(tl->il))
406 /* try from original if cache attempt */
409 tl->cache_hit = FALSE;
410 log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
412 thumb_loader_setup(tl, tl->fd);
413 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
414 if (image_loader_start(tl->il)) return TRUE;
416 /* mark failed thumbnail in cache with 0 byte file */
417 if (tl->cache_enable)
419 thumb_loader_save_thumbnail(tl, TRUE);
422 image_loader_free(tl->il);
424 thumb_loader_set_fallback(tl);
431 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
435 if (tl && tl->standard_loader)
437 return thumb_loader_std_get_pixbuf((ThumbLoaderStd *)tl);
440 if (tl && tl->fd && tl->fd->thumb_pixbuf)
442 pixbuf = tl->fd->thumb_pixbuf;
443 g_object_ref(pixbuf);
447 pixbuf = pixbuf_fallback(NULL, tl->max_w, tl->max_h);
453 ThumbLoader *thumb_loader_new(gint width, gint height)
457 /* non-std thumb loader is more effective for configurations with disabled caching
458 because it loads the thumbnails at the required size. loader_std loads
459 the thumbnails at the sizes appropriate for standard cache (typically 256x256 pixels)
460 and then performs one additional scaling */
461 if (options->thumbnails.spec_standard && options->thumbnails.enable_caching)
463 return (ThumbLoader *)thumb_loader_std_new(width, height);
466 tl = g_new0(ThumbLoader, 1);
468 tl->cache_enable = options->thumbnails.enable_caching;
469 tl->percent_done = 0.0;
476 void thumb_loader_free(ThumbLoader *tl)
480 if (tl->standard_loader)
482 thumb_loader_std_free((ThumbLoaderStd *)tl);
486 image_loader_free(tl->il);
487 file_data_unref(tl->fd);
489 if (tl->idle_done_id) g_source_remove(tl->idle_done_id);
494 /* release thumb_pixbuf on file change - this forces reload. */
495 void thumb_notify_cb(FileData *fd, NotifyType type, gpointer data)
497 if ((type & (NOTIFY_REREAD | NOTIFY_CHANGE)) && fd->thumb_pixbuf)
499 DEBUG_1("Notify thumb: %s %04x", fd->path, type);
500 g_object_unref(fd->thumb_pixbuf);
501 fd->thumb_pixbuf = NULL;
507 *-----------------------------------------------------------------------------
508 * xvpics thumbnail support, read-only (private)
509 *-----------------------------------------------------------------------------
513 * xvpics code originally supplied by:
514 * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
516 * Note: Code has been modified to fit the style of the other code, and to use
517 * a few more glib-isms.
518 * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dying a death here.
521 #define XV_BUFFER 2048
522 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
525 gchar buffer[XV_BUFFER];
528 file = fopen(filename, "rt");
529 if (!file) return NULL;
531 if (fgets(buffer, XV_BUFFER, file) != NULL
532 && strncmp(buffer, "P7 332", 6) == 0)
534 gint width, height, depth;
536 while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
538 if (sscanf(buffer, "%d %d %d", &width, &height, &depth) == 3)
540 gsize size = width * height;
542 data = g_new(guchar, size);
543 if (data && fread(data, 1, size, file) == size)
556 static void free_rgb_buffer(guchar *pixels, gpointer data)
561 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
570 path = path_from_utf8(thumb_filename);
571 directory = g_path_get_dirname(path);
572 name = g_path_get_basename(path);
574 thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
580 packed_data = load_xv_thumbnail(thumb_name, &width, &height);
589 rgb_data = g_new(guchar, width * height * 3);
590 for (i = 0; i < width * height; i++)
592 rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
593 rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
594 rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
598 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
599 width, height, 3 * width, free_rgb_buffer, NULL);
601 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
607 pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
616 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */