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);
149 if (!tl->cache_hit && options->image.exif_rotate_enable)
151 if (!tl->fd->exif_orientation)
153 tl->fd->exif_orientation = metadata_read_int(tl->fd, ORIENTATION_KEY, EXIF_ORIENTATION_TOP_LEFT);
156 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
158 rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
163 pw = gdk_pixbuf_get_width(pixbuf);
164 ph = gdk_pixbuf_get_height(pixbuf);
166 if (tl->cache_hit && pw != tl->max_w && ph != tl->max_h)
168 /* requested thumbnail size may have changed, load original */
169 DEBUG_1("thumbnail size mismatch, regenerating: %s", tl->fd->path);
170 tl->cache_hit = FALSE;
172 thumb_loader_setup(tl, tl->fd);
174 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
176 if (!image_loader_start(tl->il))
178 image_loader_free(tl->il);
181 DEBUG_1("regeneration failure: %s", tl->fd->path);
182 thumb_loader_error_cb(tl->il, tl);
189 if (pw > tl->max_w || ph > tl->max_h)
193 if (((gdouble)tl->max_w / pw) < ((gdouble)tl->max_h / ph))
196 h = (gdouble)w / pw * ph;
202 w = (gdouble)h / ph * pw;
208 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
209 tl->fd->thumb_pixbuf = gdk_pixbuf_scale_simple(pixbuf, w, h, (GdkInterpType)options->thumbnails.quality);
217 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
218 tl->fd->thumb_pixbuf = pixbuf;
220 g_object_ref(tl->fd->thumb_pixbuf);
222 save = image_loader_get_shrunk(il);
225 if (rotated) g_object_unref(rotated);
228 if (tl->cache_enable && save)
230 thumb_loader_save_thumbnail(tl, FALSE);
233 if (tl->func_done) tl->func_done(tl, tl->data);
236 static void thumb_loader_error_cb(ImageLoader *il, gpointer data)
238 ThumbLoader *tl = data;
240 /* if at least some of the image is available, go to done_cb */
241 if (image_loader_get_pixbuf(tl->il) != NULL)
243 thumb_loader_done_cb(il, data);
247 DEBUG_1("thumb error: %s", tl->fd->path);
249 image_loader_free(tl->il);
252 thumb_loader_set_fallback(tl);
254 if (tl->func_error) tl->func_error(tl, tl->data);
257 static gboolean thumb_loader_done_delay_cb(gpointer data)
259 ThumbLoader *tl = data;
261 tl->idle_done_id = 0;
263 if (tl->func_done) tl->func_done(tl, tl->data);
268 static void thumb_loader_delay_done(ThumbLoader *tl)
270 if (!tl->idle_done_id) tl->idle_done_id = g_idle_add(thumb_loader_done_delay_cb, tl);
273 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd)
275 image_loader_free(tl->il);
276 tl->il = image_loader_new(fd);
277 image_loader_set_priority(tl->il, G_PRIORITY_LOW);
279 /* this will speed up jpegs by up to 3x in some cases */
280 image_loader_set_requested_size(tl->il, tl->max_w, tl->max_h);
282 g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_error_cb, tl);
283 if (tl->func_progress) g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_percent_cb, tl);
286 void thumb_loader_set_callbacks(ThumbLoader *tl,
287 ThumbLoaderFunc func_done,
288 ThumbLoaderFunc func_error,
289 ThumbLoaderFunc func_progress,
294 if (tl->standard_loader)
296 thumb_loader_std_set_callbacks((ThumbLoaderStd *)tl,
297 (ThumbLoaderStdFunc) func_done,
298 (ThumbLoaderStdFunc) func_error,
299 (ThumbLoaderStdFunc) func_progress,
304 tl->func_done = func_done;
305 tl->func_error = func_error;
306 tl->func_progress = func_progress;
311 void thumb_loader_set_cache(ThumbLoader *tl, gboolean enable_cache, gboolean local, gboolean retry_failed)
315 if (tl->standard_loader)
317 thumb_loader_std_set_cache((ThumbLoaderStd *)tl, enable_cache, local, retry_failed);
321 tl->cache_enable = enable_cache;
325 gboolean thumb_loader_start(ThumbLoader *tl, FileData *fd)
327 gchar *cache_path = NULL;
329 if (!tl) return FALSE;
331 if (tl->standard_loader)
333 return thumb_loader_std_start((ThumbLoaderStd *)tl, fd);
336 if (!tl->fd && !fd) return FALSE;
338 if (!tl->fd) tl->fd = file_data_ref(fd);
341 if (tl->cache_enable)
343 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
347 if (cache_time_valid(cache_path, tl->fd->path))
349 DEBUG_1("Found in cache:%s", tl->fd->path);
351 if (filesize(cache_path) == 0)
353 DEBUG_1("Broken image mark found:%s", cache_path);
355 thumb_loader_set_fallback(tl);
359 DEBUG_1("Cache location:%s", cache_path);
369 if (!cache_path && options->thumbnails.use_xvpics)
371 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
372 tl->fd->thumb_pixbuf = get_xv_thumbnail(tl->fd->path, tl->max_w, tl->max_h);
373 if (tl->fd->thumb_pixbuf)
375 thumb_loader_delay_done(tl);
382 FileData *fd = file_data_new_no_grouping(cache_path);
383 thumb_loader_setup(tl, fd);
386 tl->cache_hit = TRUE;
390 thumb_loader_setup(tl, tl->fd);
393 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
394 if (!image_loader_start(tl->il))
396 /* try from original if cache attempt */
399 tl->cache_hit = FALSE;
400 log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
402 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)) return TRUE;
406 /* mark failed thumbnail in cache with 0 byte file */
407 if (tl->cache_enable)
409 thumb_loader_save_thumbnail(tl, TRUE);
412 image_loader_free(tl->il);
414 thumb_loader_set_fallback(tl);
421 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
425 if (tl && tl->standard_loader)
427 return thumb_loader_std_get_pixbuf((ThumbLoaderStd *)tl);
430 if (tl && tl->fd && tl->fd->thumb_pixbuf)
432 pixbuf = tl->fd->thumb_pixbuf;
433 g_object_ref(pixbuf);
437 pixbuf = pixbuf_fallback(NULL, tl->max_w, tl->max_h);
443 ThumbLoader *thumb_loader_new(gint width, gint height)
447 /* non-std thumb loader is more effective for configurations with disabled caching
448 because it loads the thumbnails at the required size. loader_std loads
449 the thumbnails at the sizes appropriate for standard cache (typically 256x256 pixels)
450 and then performs one additional scaling */
451 if (options->thumbnails.spec_standard && options->thumbnails.enable_caching)
453 return (ThumbLoader *)thumb_loader_std_new(width, height);
456 tl = g_new0(ThumbLoader, 1);
458 tl->cache_enable = options->thumbnails.enable_caching;
459 tl->percent_done = 0.0;
466 void thumb_loader_free(ThumbLoader *tl)
470 if (tl->standard_loader)
472 thumb_loader_std_free((ThumbLoaderStd *)tl);
476 image_loader_free(tl->il);
477 file_data_unref(tl->fd);
479 if (tl->idle_done_id) g_source_remove(tl->idle_done_id);
484 /* release thumb_pixbuf on file change - this forces reload. */
485 void thumb_notify_cb(FileData *fd, NotifyType type, gpointer data)
487 if ((type & (NOTIFY_REREAD | NOTIFY_CHANGE)) && fd->thumb_pixbuf)
489 DEBUG_1("Notify thumb: %s %04x", fd->path, type);
490 g_object_unref(fd->thumb_pixbuf);
491 fd->thumb_pixbuf = NULL;
497 *-----------------------------------------------------------------------------
498 * xvpics thumbnail support, read-only (private)
499 *-----------------------------------------------------------------------------
503 * xvpics code originally supplied by:
504 * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
506 * Note: Code has been modified to fit the style of the other code, and to use
507 * a few more glib-isms.
508 * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dieing a death here.
511 #define XV_BUFFER 2048
512 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
515 gchar buffer[XV_BUFFER];
518 file = fopen(filename, "rt");
519 if (!file) return NULL;
521 if (fgets(buffer, XV_BUFFER, file) != NULL
522 && strncmp(buffer, "P7 332", 6) == 0)
524 gint width, height, depth;
526 while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
528 if (sscanf(buffer, "%d %d %d", &width, &height, &depth) == 3)
530 gsize size = width * height;
532 data = g_new(guchar, size);
533 if (data && fread(data, 1, size, file) == size)
546 static void free_rgb_buffer(guchar *pixels, gpointer data)
551 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
560 path = path_from_utf8(thumb_filename);
561 directory = g_path_get_dirname(path);
562 name = g_path_get_basename(path);
564 thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
570 packed_data = load_xv_thumbnail(thumb_name, &width, &height);
579 rgb_data = g_new(guchar, width * height * 3);
580 for (i = 0; i < width * height; i++)
582 rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
583 rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
584 rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
588 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
589 width, height, 3 * width, free_rgb_buffer, NULL);
591 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
597 pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
606 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */