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 *, gdouble percent, gpointer data)
117 auto tl = static_cast<ThumbLoader *>(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 auto tl = static_cast<ThumbLoader *>(data);
137 GdkPixbuf *rotated = nullptr;
139 DEBUG_1("thumb done: %s", tl->fd->path);
141 pixbuf = image_loader_get_pixbuf(tl->il);
144 DEBUG_1("...but no pixbuf: %s", tl->fd->path);
145 thumb_loader_error_cb(tl->il, tl);
151 // apply color correction, if required
152 thumb_loader_std_calibrate_pixbuf(tl->fd, pixbuf);
155 if (!tl->cache_hit && options->image.exif_rotate_enable)
157 if (!tl->fd->exif_orientation)
159 if (g_strcmp0(il->fd->format_name, "heif") != 0)
161 tl->fd->exif_orientation = metadata_read_int(tl->fd, ORIENTATION_KEY, EXIF_ORIENTATION_TOP_LEFT);
165 tl->fd->exif_orientation = EXIF_ORIENTATION_TOP_LEFT;
169 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
171 rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
176 pw = gdk_pixbuf_get_width(pixbuf);
177 ph = gdk_pixbuf_get_height(pixbuf);
179 if (tl->cache_hit && pw != tl->max_w && ph != tl->max_h)
181 /* requested thumbnail size may have changed, load original */
182 DEBUG_1("thumbnail size mismatch, regenerating: %s", tl->fd->path);
183 tl->cache_hit = FALSE;
185 thumb_loader_setup(tl, tl->fd);
187 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
189 if (!image_loader_start(tl->il))
191 image_loader_free(tl->il);
194 DEBUG_1("regeneration failure: %s", tl->fd->path);
195 thumb_loader_error_cb(tl->il, tl);
202 if (pw > tl->max_w || ph > tl->max_h)
207 if ((static_cast<gdouble>(tl->max_w) / pw) < (static_cast<gdouble>(tl->max_h) / ph))
210 h = static_cast<gdouble>(w) / pw * ph;
216 w = static_cast<gdouble>(h) / ph * pw;
222 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
223 tl->fd->thumb_pixbuf = gdk_pixbuf_scale_simple(pixbuf, w, h, static_cast<GdkInterpType>(options->thumbnails.quality));
231 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
232 tl->fd->thumb_pixbuf = pixbuf;
234 g_object_ref(tl->fd->thumb_pixbuf);
236 save = image_loader_get_shrunk(il);
239 if (rotated) g_object_unref(rotated);
242 if (tl->cache_enable && save)
244 thumb_loader_save_thumbnail(tl, FALSE);
247 if (tl->func_done) tl->func_done(tl, tl->data);
250 static void thumb_loader_error_cb(ImageLoader *il, gpointer data)
252 auto tl = static_cast<ThumbLoader *>(data);
254 /* if at least some of the image is available, go to done_cb */
255 if (image_loader_get_pixbuf(tl->il) != nullptr)
257 thumb_loader_done_cb(il, data);
261 DEBUG_1("thumb error: %s", tl->fd->path);
263 image_loader_free(tl->il);
266 thumb_loader_set_fallback(tl);
268 if (tl->func_error) tl->func_error(tl, tl->data);
271 static gboolean thumb_loader_done_delay_cb(gpointer data)
273 auto tl = static_cast<ThumbLoader *>(data);
275 tl->idle_done_id = 0;
277 if (tl->func_done) tl->func_done(tl, tl->data);
279 return G_SOURCE_REMOVE;
282 static void thumb_loader_delay_done(ThumbLoader *tl)
284 if (!tl->idle_done_id) tl->idle_done_id = g_idle_add(thumb_loader_done_delay_cb, tl);
287 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd)
289 image_loader_free(tl->il);
290 tl->il = image_loader_new(fd);
291 image_loader_set_priority(tl->il, G_PRIORITY_LOW);
293 /* this will speed up jpegs by up to 3x in some cases */
294 image_loader_set_requested_size(tl->il, tl->max_w, tl->max_h);
296 g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_error_cb, tl);
297 if (tl->func_progress) g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_percent_cb, tl);
300 void thumb_loader_set_callbacks(ThumbLoader *tl,
301 ThumbLoader::Func func_done,
302 ThumbLoader::Func func_error,
303 ThumbLoader::Func func_progress,
308 if (tl->standard_loader)
310 thumb_loader_std_set_callbacks(reinterpret_cast<ThumbLoaderStd *>(tl),
311 reinterpret_cast<ThumbLoaderStd::Func>(func_done),
312 reinterpret_cast<ThumbLoaderStd::Func>(func_error),
313 reinterpret_cast<ThumbLoaderStd::Func>(func_progress),
318 tl->func_done = func_done;
319 tl->func_error = func_error;
320 tl->func_progress = func_progress;
325 void thumb_loader_set_cache(ThumbLoader *tl, gboolean enable_cache, gboolean local, gboolean retry_failed)
329 if (tl->standard_loader)
331 thumb_loader_std_set_cache(reinterpret_cast<ThumbLoaderStd *>(tl), enable_cache, local, retry_failed);
335 tl->cache_enable = enable_cache;
339 gboolean thumb_loader_start(ThumbLoader *tl, FileData *fd)
341 gchar *cache_path = nullptr;
343 if (!tl) return FALSE;
345 if (tl->standard_loader)
347 return thumb_loader_std_start(reinterpret_cast<ThumbLoaderStd *>(tl), fd);
350 if (!tl->fd && !fd) return FALSE;
352 if (!tl->fd) tl->fd = file_data_ref(fd);
354 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)
356 thumb_loader_set_fallback(tl);
360 if (tl->cache_enable)
362 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
366 if (cache_time_valid(cache_path, tl->fd->path))
368 DEBUG_1("Found in cache:%s", tl->fd->path);
370 if (filesize(cache_path) == 0)
372 DEBUG_1("Broken image mark found:%s", cache_path);
374 thumb_loader_set_fallback(tl);
378 DEBUG_1("Cache location:%s", cache_path);
383 cache_path = nullptr;
388 if (!cache_path && options->thumbnails.use_xvpics)
390 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
391 tl->fd->thumb_pixbuf = get_xv_thumbnail(tl->fd->path, tl->max_w, tl->max_h);
392 if (tl->fd->thumb_pixbuf)
394 thumb_loader_delay_done(tl);
401 FileData *fd = file_data_new_no_grouping(cache_path);
402 thumb_loader_setup(tl, fd);
405 tl->cache_hit = TRUE;
409 thumb_loader_setup(tl, tl->fd);
412 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
413 if (!image_loader_start(tl->il))
415 /* try from original if cache attempt */
418 tl->cache_hit = FALSE;
419 log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
421 thumb_loader_setup(tl, tl->fd);
422 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
423 if (image_loader_start(tl->il)) return TRUE;
425 /* mark failed thumbnail in cache with 0 byte file */
426 if (tl->cache_enable)
428 thumb_loader_save_thumbnail(tl, TRUE);
431 image_loader_free(tl->il);
433 thumb_loader_set_fallback(tl);
440 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
444 if (tl && tl->standard_loader)
446 return thumb_loader_std_get_pixbuf(reinterpret_cast<ThumbLoaderStd *>(tl));
449 if (tl && tl->fd && tl->fd->thumb_pixbuf)
451 pixbuf = tl->fd->thumb_pixbuf;
452 g_object_ref(pixbuf);
456 pixbuf = pixbuf_fallback(nullptr, tl->max_w, tl->max_h);
462 ThumbLoader *thumb_loader_new(gint width, gint height)
466 /* non-std thumb loader is more effective for configurations with disabled caching
467 because it loads the thumbnails at the required size. loader_std loads
468 the thumbnails at the sizes appropriate for standard cache (typically 256x256 pixels)
469 and then performs one additional scaling */
470 if (options->thumbnails.spec_standard && options->thumbnails.enable_caching)
472 return reinterpret_cast<ThumbLoader *>(thumb_loader_std_new(width, height));
475 tl = g_new0(ThumbLoader, 1);
477 tl->cache_enable = options->thumbnails.enable_caching;
478 tl->percent_done = 0.0;
485 void thumb_loader_free(ThumbLoader *tl)
489 if (tl->standard_loader)
491 thumb_loader_std_free(reinterpret_cast<ThumbLoaderStd *>(tl));
495 image_loader_free(tl->il);
496 file_data_unref(tl->fd);
498 if (tl->idle_done_id) g_source_remove(tl->idle_done_id);
503 /* release thumb_pixbuf on file change - this forces reload. */
504 void thumb_notify_cb(FileData *fd, NotifyType type, gpointer)
506 if ((type & (NOTIFY_REREAD | NOTIFY_CHANGE)) && fd->thumb_pixbuf)
508 DEBUG_1("Notify thumb: %s %04x", fd->path, type);
509 g_object_unref(fd->thumb_pixbuf);
510 fd->thumb_pixbuf = nullptr;
516 *-----------------------------------------------------------------------------
517 * xvpics thumbnail support, read-only (private)
518 *-----------------------------------------------------------------------------
522 * xvpics code originally supplied by:
523 * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
525 * Note: Code has been modified to fit the style of the other code, and to use
526 * a few more glib-isms.
527 * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dying a death here.
530 #define XV_BUFFER 2048
531 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
534 gchar buffer[XV_BUFFER];
535 guchar *data = nullptr;
537 file = fopen(filename, "rt");
538 if (!file) return nullptr;
540 if (fgets(buffer, XV_BUFFER, file) != nullptr
541 && strncmp(buffer, "P7 332", 6) == 0)
547 while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
549 if (sscanf(buffer, "%d %d %d", &width, &height, &depth) == 3)
551 gsize size = width * height;
553 data = g_new(guchar, size);
554 if (data && fread(data, 1, size, file) == size)
567 static void free_rgb_buffer(guchar *pixels, gpointer)
572 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
582 path = path_from_utf8(thumb_filename);
583 directory = g_path_get_dirname(path);
584 name = g_path_get_basename(path);
586 thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
592 packed_data = load_xv_thumbnail(thumb_name, &width, &height);
601 rgb_data = g_new(guchar, width * height * 3);
602 for (i = 0; i < width * height; i++)
604 rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
605 rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
606 rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
610 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
611 width, height, 3 * width, free_rgb_buffer, nullptr);
613 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
619 pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
628 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */