4 * Copyright (C) 2008 - 2012 The Geeqie Team
8 * This software is released under the GNU General Public License (GNU GPL).
9 * Please read the included file COPYING for more information.
10 * This software comes with no warranty of any kind, use at your own risk!
18 #include "image-load.h"
20 #include "pixbuf_util.h"
21 #include "thumb_standard.h"
22 #include "ui_fileops.h"
29 static void thumb_loader_error_cb(ImageLoader *il, gpointer data);
30 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd);
32 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h);
36 *-----------------------------------------------------------------------------
37 * thumbnail routines: creation, caching, and maintenance (public)
38 *-----------------------------------------------------------------------------
41 /* Save thumbnail to disk
42 * or just mark failed thumbnail with 0 byte file (mark_failure = TRUE) */
43 static gboolean thumb_loader_save_thumbnail(ThumbLoader *tl, gboolean mark_failure)
46 gboolean success = FALSE;
49 if (!tl || !tl->fd) return FALSE;
50 if (!mark_failure && !tl->fd->thumb_pixbuf) return FALSE;
52 cache_dir = cache_get_location(CACHE_TYPE_THUMB, tl->fd->path, FALSE, &mode);
54 if (recursive_mkdir_if_not_exists(cache_dir, mode))
58 gchar *name = g_strconcat(filename_from_path(tl->fd->path), GQ_CACHE_EXT_THUMB, NULL);
60 cache_path = g_build_filename(cache_dir, name, NULL);
63 pathl = path_from_utf8(cache_path);
67 FILE *f = fopen(pathl, "w"); ;
69 DEBUG_1("Marking thumb failure: %s", cache_path);
78 DEBUG_1("Saving thumb: %s", cache_path);
79 success = pixbuf_to_file_as_png(tl->fd->thumb_pixbuf, pathl);
85 /* set thumb time to that of source file */
87 ut.actime = ut.modtime = filetime(tl->fd->path);
95 DEBUG_1("Saving failed: %s", pathl);
107 static void thumb_loader_percent_cb(ImageLoader *il, gdouble percent, gpointer data)
109 ThumbLoader *tl = data;
111 tl->percent_done = percent;
113 if (tl->func_progress) tl->func_progress(tl, tl->data);
116 static void thumb_loader_set_fallback(ThumbLoader *tl)
118 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
119 tl->fd->thumb_pixbuf = pixbuf_fallback(tl->fd, tl->max_w, tl->max_h);
122 static void thumb_loader_done_cb(ImageLoader *il, gpointer data)
124 ThumbLoader *tl = data;
128 GdkPixbuf *rotated = NULL;
130 DEBUG_1("thumb done: %s", tl->fd->path);
132 pixbuf = image_loader_get_pixbuf(tl->il);
135 DEBUG_1("...but no pixbuf: %s", tl->fd->path);
136 thumb_loader_error_cb(tl->il, tl);
141 if (!tl->cache_hit && options->image.exif_rotate_enable)
143 if (!tl->fd->exif_orientation)
145 tl->fd->exif_orientation = metadata_read_int(tl->fd, ORIENTATION_KEY, EXIF_ORIENTATION_TOP_LEFT);
148 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
150 rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
155 pw = gdk_pixbuf_get_width(pixbuf);
156 ph = gdk_pixbuf_get_height(pixbuf);
158 if (tl->cache_hit && pw != tl->max_w && ph != tl->max_h)
160 /* requested thumbnail size may have changed, load original */
161 DEBUG_1("thumbnail size mismatch, regenerating: %s", tl->fd->path);
162 tl->cache_hit = FALSE;
164 thumb_loader_setup(tl, tl->fd);
166 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
168 if (!image_loader_start(tl->il))
170 image_loader_free(tl->il);
173 DEBUG_1("regeneration failure: %s", tl->fd->path);
174 thumb_loader_error_cb(tl->il, tl);
181 if (pw > tl->max_w || ph > tl->max_h)
185 if (((gdouble)tl->max_w / pw) < ((gdouble)tl->max_h / ph))
188 h = (gdouble)w / pw * ph;
194 w = (gdouble)h / ph * pw;
200 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
201 tl->fd->thumb_pixbuf = gdk_pixbuf_scale_simple(pixbuf, w, h, (GdkInterpType)options->thumbnails.quality);
209 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
210 tl->fd->thumb_pixbuf = pixbuf;
212 g_object_ref(tl->fd->thumb_pixbuf);
214 save = image_loader_get_shrunk(il);
217 if (rotated) g_object_unref(rotated);
220 if (tl->cache_enable && save)
222 thumb_loader_save_thumbnail(tl, FALSE);
225 if (tl->func_done) tl->func_done(tl, tl->data);
228 static void thumb_loader_error_cb(ImageLoader *il, gpointer data)
230 ThumbLoader *tl = data;
232 /* if at least some of the image is available, go to done_cb */
233 if (image_loader_get_pixbuf(tl->il) != NULL)
235 thumb_loader_done_cb(il, data);
239 DEBUG_1("thumb error: %s", tl->fd->path);
241 image_loader_free(tl->il);
244 thumb_loader_set_fallback(tl);
246 if (tl->func_error) tl->func_error(tl, tl->data);
249 static gboolean thumb_loader_done_delay_cb(gpointer data)
251 ThumbLoader *tl = data;
253 tl->idle_done_id = 0;
255 if (tl->func_done) tl->func_done(tl, tl->data);
260 static void thumb_loader_delay_done(ThumbLoader *tl)
262 if (!tl->idle_done_id) tl->idle_done_id = g_idle_add(thumb_loader_done_delay_cb, tl);
265 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd)
267 image_loader_free(tl->il);
268 tl->il = image_loader_new(fd);
269 image_loader_set_priority(tl->il, G_PRIORITY_LOW);
271 /* this will speed up jpegs by up to 3x in some cases */
272 image_loader_set_requested_size(tl->il, tl->max_w, tl->max_h);
274 g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_error_cb, tl);
275 if (tl->func_progress) g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_percent_cb, tl);
278 void thumb_loader_set_callbacks(ThumbLoader *tl,
279 ThumbLoaderFunc func_done,
280 ThumbLoaderFunc func_error,
281 ThumbLoaderFunc func_progress,
286 if (tl->standard_loader)
288 thumb_loader_std_set_callbacks((ThumbLoaderStd *)tl,
289 (ThumbLoaderStdFunc) func_done,
290 (ThumbLoaderStdFunc) func_error,
291 (ThumbLoaderStdFunc) func_progress,
296 tl->func_done = func_done;
297 tl->func_error = func_error;
298 tl->func_progress = func_progress;
303 void thumb_loader_set_cache(ThumbLoader *tl, gboolean enable_cache, gboolean local, gboolean retry_failed)
307 if (tl->standard_loader)
309 thumb_loader_std_set_cache((ThumbLoaderStd *)tl, enable_cache, local, retry_failed);
313 tl->cache_enable = enable_cache;
315 tl->cache_local = local;
316 tl->cache_retry = retry_failed;
321 gboolean thumb_loader_start(ThumbLoader *tl, FileData *fd)
323 gchar *cache_path = NULL;
325 if (!tl) return FALSE;
327 if (tl->standard_loader)
329 return thumb_loader_std_start((ThumbLoaderStd *)tl, fd);
332 if (!tl->fd && !fd) return FALSE;
334 if (!tl->fd) tl->fd = file_data_ref(fd);
337 if (tl->cache_enable)
339 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
343 if (cache_time_valid(cache_path, tl->fd->path))
345 DEBUG_1("Found in cache:%s", tl->fd->path);
347 if (filesize(cache_path) == 0)
349 DEBUG_1("Broken image mark found:%s", cache_path);
351 thumb_loader_set_fallback(tl);
355 DEBUG_1("Cache location:%s", cache_path);
365 if (!cache_path && options->thumbnails.use_xvpics)
367 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
368 tl->fd->thumb_pixbuf = get_xv_thumbnail(tl->fd->path, tl->max_w, tl->max_h);
369 if (tl->fd->thumb_pixbuf)
371 thumb_loader_delay_done(tl);
378 FileData *fd = file_data_new_no_grouping(cache_path);
379 thumb_loader_setup(tl, fd);
382 tl->cache_hit = TRUE;
386 thumb_loader_setup(tl, tl->fd);
389 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
390 if (!image_loader_start(tl->il))
392 /* try from original if cache attempt */
395 tl->cache_hit = FALSE;
396 log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
398 thumb_loader_setup(tl, tl->fd);
399 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
400 if (image_loader_start(tl->il)) return TRUE;
402 /* mark failed thumbnail in cache with 0 byte file */
403 if (tl->cache_enable)
405 thumb_loader_save_thumbnail(tl, TRUE);
408 image_loader_free(tl->il);
410 thumb_loader_set_fallback(tl);
418 gint thumb_loader_to_pixmap(ThumbLoader *tl, GdkPixmap **pixmap, GdkBitmap **mask)
420 if (!tl || !tl->pixbuf) return -1;
422 gdk_pixbuf_render_pixmap_and_mask(tl->pixbuf, pixmap, mask, 128);
424 return thumb_loader_get_space(tl);
428 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
432 if (tl && tl->standard_loader)
434 return thumb_loader_std_get_pixbuf((ThumbLoaderStd *)tl);
437 if (tl && tl->fd && tl->fd->thumb_pixbuf)
439 pixbuf = tl->fd->thumb_pixbuf;
440 g_object_ref(pixbuf);
444 pixbuf = pixbuf_fallback(NULL, tl->max_w, tl->max_h);
451 gint thumb_loader_get_space(ThumbLoader *tl)
455 if (tl->pixbuf) return (tl->max_w - gdk_pixbuf_get_width(tl->pixbuf));
461 ThumbLoader *thumb_loader_new(gint width, gint height)
465 /* non-std thumb loader is more effective for configurations with disabled caching
466 because it loads the thumbnails at the required size. loader_std loads
467 the thumbnails at the sizes appropriate for standard cache (typically 256x256 pixels)
468 and then performs one additional scaling */
469 if (options->thumbnails.spec_standard && options->thumbnails.enable_caching)
471 return (ThumbLoader *)thumb_loader_std_new(width, height);
474 tl = g_new0(ThumbLoader, 1);
476 tl->cache_enable = options->thumbnails.enable_caching;
477 tl->percent_done = 0.0;
484 void thumb_loader_free(ThumbLoader *tl)
488 if (tl->standard_loader)
490 thumb_loader_std_free((ThumbLoaderStd *)tl);
494 image_loader_free(tl->il);
495 file_data_unref(tl->fd);
497 if (tl->idle_done_id) g_source_remove(tl->idle_done_id);
503 gint thumb_from_xpm_d(const gchar **data, gint max_w, gint max_h, GdkPixmap **pixmap, GdkBitmap **mask)
508 pixbuf = gdk_pixbuf_new_from_xpm_data(data);
509 w = gdk_pixbuf_get_width(pixbuf);
510 h = gdk_pixbuf_get_height(pixbuf);
512 if (pixbuf_scale_aspect(w, h, max_w, max_h, &w, &h))
518 pixbuf = gdk_pixbuf_scale_simple(tmp, w, h, GDK_INTERP_NEAREST);
519 gdk_pixbuf_unref(tmp);
522 gdk_pixbuf_render_pixmap_and_mask(pixbuf, pixmap, mask, 128);
523 gdk_pixbuf_unref(pixbuf);
530 /* release thumb_pixbuf on file change - this forces reload. */
531 void thumb_notify_cb(FileData *fd, NotifyType type, gpointer data)
533 if ((type & (NOTIFY_REREAD | NOTIFY_CHANGE)) && fd->thumb_pixbuf)
535 DEBUG_1("Notify thumb: %s %04x", fd->path, type);
536 g_object_unref(fd->thumb_pixbuf);
537 fd->thumb_pixbuf = NULL;
543 *-----------------------------------------------------------------------------
544 * xvpics thumbnail support, read-only (private)
545 *-----------------------------------------------------------------------------
549 * xvpics code originally supplied by:
550 * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
552 * Note: Code has been modified to fit the style of the other code, and to use
553 * a few more glib-isms.
554 * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dieing a death here.
557 #define XV_BUFFER 2048
558 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
561 gchar buffer[XV_BUFFER];
564 file = fopen(filename, "rt");
565 if (!file) return NULL;
567 if (fgets(buffer, XV_BUFFER, file) != NULL
568 && strncmp(buffer, "P7 332", 6) == 0)
570 gint width, height, depth;
572 while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
574 if (sscanf(buffer, "%d %d %d", &width, &height, &depth) == 3)
576 gsize size = width * height;
578 data = g_new(guchar, size);
579 if (data && fread(data, 1, size, file) == size)
592 static void free_rgb_buffer(guchar *pixels, gpointer data)
597 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
606 path = path_from_utf8(thumb_filename);
607 directory = g_path_get_dirname(path);
608 name = g_path_get_basename(path);
610 thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
616 packed_data = load_xv_thumbnail(thumb_name, &width, &height);
625 rgb_data = g_new(guchar, width * height * 3);
626 for (i = 0; i < width * height; i++)
628 rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
629 rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
630 rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
634 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
635 width, height, 3 * width, free_rgb_buffer, NULL);
637 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
643 pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
652 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */