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);
136 GdkPixbuf *rotated = nullptr;
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 if (g_strcmp0(il->fd->format_name, "heif") != 0)
160 tl->fd->exif_orientation = metadata_read_int(tl->fd, ORIENTATION_KEY, EXIF_ORIENTATION_TOP_LEFT);
164 tl->fd->exif_orientation = EXIF_ORIENTATION_TOP_LEFT;
168 if (tl->fd->exif_orientation != EXIF_ORIENTATION_TOP_LEFT)
170 rotated = pixbuf_apply_orientation(pixbuf, tl->fd->exif_orientation);
175 pw = gdk_pixbuf_get_width(pixbuf);
176 ph = gdk_pixbuf_get_height(pixbuf);
178 if (tl->cache_hit && pw != tl->max_w && ph != tl->max_h)
180 /* requested thumbnail size may have changed, load original */
181 DEBUG_1("thumbnail size mismatch, regenerating: %s", tl->fd->path);
182 tl->cache_hit = FALSE;
184 thumb_loader_setup(tl, tl->fd);
186 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
188 if (!image_loader_start(tl->il))
190 image_loader_free(tl->il);
193 DEBUG_1("regeneration failure: %s", tl->fd->path);
194 thumb_loader_error_cb(tl->il, tl);
201 if (pw > tl->max_w || ph > tl->max_h)
205 if ((static_cast<gdouble>(tl->max_w) / pw) < (static_cast<gdouble>(tl->max_h) / ph))
208 h = static_cast<gdouble>(w) / pw * ph;
214 w = static_cast<gdouble>(h) / ph * pw;
220 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
221 tl->fd->thumb_pixbuf = gdk_pixbuf_scale_simple(pixbuf, w, h, static_cast<GdkInterpType>(options->thumbnails.quality));
229 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
230 tl->fd->thumb_pixbuf = pixbuf;
232 g_object_ref(tl->fd->thumb_pixbuf);
234 save = image_loader_get_shrunk(il);
237 if (rotated) g_object_unref(rotated);
240 if (tl->cache_enable && save)
242 thumb_loader_save_thumbnail(tl, FALSE);
245 if (tl->func_done) tl->func_done(tl, tl->data);
248 static void thumb_loader_error_cb(ImageLoader *il, gpointer data)
250 auto tl = static_cast<ThumbLoader *>(data);
252 /* if at least some of the image is available, go to done_cb */
253 if (image_loader_get_pixbuf(tl->il) != nullptr)
255 thumb_loader_done_cb(il, data);
259 DEBUG_1("thumb error: %s", tl->fd->path);
261 image_loader_free(tl->il);
264 thumb_loader_set_fallback(tl);
266 if (tl->func_error) tl->func_error(tl, tl->data);
269 static gboolean thumb_loader_done_delay_cb(gpointer data)
271 auto tl = static_cast<ThumbLoader *>(data);
273 tl->idle_done_id = 0;
275 if (tl->func_done) tl->func_done(tl, tl->data);
277 return G_SOURCE_REMOVE;
280 static void thumb_loader_delay_done(ThumbLoader *tl)
282 if (!tl->idle_done_id) tl->idle_done_id = g_idle_add(thumb_loader_done_delay_cb, tl);
285 static void thumb_loader_setup(ThumbLoader *tl, FileData *fd)
287 image_loader_free(tl->il);
288 tl->il = image_loader_new(fd);
289 image_loader_set_priority(tl->il, G_PRIORITY_LOW);
291 /* this will speed up jpegs by up to 3x in some cases */
292 image_loader_set_requested_size(tl->il, tl->max_w, tl->max_h);
294 g_signal_connect(G_OBJECT(tl->il), "error", (GCallback)thumb_loader_error_cb, tl);
295 if (tl->func_progress) g_signal_connect(G_OBJECT(tl->il), "percent", (GCallback)thumb_loader_percent_cb, tl);
298 void thumb_loader_set_callbacks(ThumbLoader *tl,
299 ThumbLoader::Func func_done,
300 ThumbLoader::Func func_error,
301 ThumbLoader::Func func_progress,
306 if (tl->standard_loader)
308 thumb_loader_std_set_callbacks(reinterpret_cast<ThumbLoaderStd *>(tl),
309 reinterpret_cast<ThumbLoaderStd::Func>(func_done),
310 reinterpret_cast<ThumbLoaderStd::Func>(func_error),
311 reinterpret_cast<ThumbLoaderStd::Func>(func_progress),
316 tl->func_done = func_done;
317 tl->func_error = func_error;
318 tl->func_progress = func_progress;
323 void thumb_loader_set_cache(ThumbLoader *tl, gboolean enable_cache, gboolean local, gboolean retry_failed)
327 if (tl->standard_loader)
329 thumb_loader_std_set_cache(reinterpret_cast<ThumbLoaderStd *>(tl), enable_cache, local, retry_failed);
333 tl->cache_enable = enable_cache;
337 gboolean thumb_loader_start(ThumbLoader *tl, FileData *fd)
339 gchar *cache_path = nullptr;
341 if (!tl) return FALSE;
343 if (tl->standard_loader)
345 return thumb_loader_std_start(reinterpret_cast<ThumbLoaderStd *>(tl), fd);
348 if (!tl->fd && !fd) return FALSE;
350 if (!tl->fd) tl->fd = file_data_ref(fd);
352 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)
354 thumb_loader_set_fallback(tl);
358 if (tl->cache_enable)
360 cache_path = cache_find_location(CACHE_TYPE_THUMB, tl->fd->path);
364 if (cache_time_valid(cache_path, tl->fd->path))
366 DEBUG_1("Found in cache:%s", tl->fd->path);
368 if (filesize(cache_path) == 0)
370 DEBUG_1("Broken image mark found:%s", cache_path);
372 thumb_loader_set_fallback(tl);
376 DEBUG_1("Cache location:%s", cache_path);
381 cache_path = nullptr;
386 if (!cache_path && options->thumbnails.use_xvpics)
388 if (tl->fd->thumb_pixbuf) g_object_unref(tl->fd->thumb_pixbuf);
389 tl->fd->thumb_pixbuf = get_xv_thumbnail(tl->fd->path, tl->max_w, tl->max_h);
390 if (tl->fd->thumb_pixbuf)
392 thumb_loader_delay_done(tl);
399 FileData *fd = file_data_new_no_grouping(cache_path);
400 thumb_loader_setup(tl, fd);
403 tl->cache_hit = TRUE;
407 thumb_loader_setup(tl, tl->fd);
410 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
411 if (!image_loader_start(tl->il))
413 /* try from original if cache attempt */
416 tl->cache_hit = FALSE;
417 log_printf("%s", _("Thumbnail image in cache failed to load, trying to recreate.\n"));
419 thumb_loader_setup(tl, tl->fd);
420 g_signal_connect(G_OBJECT(tl->il), "done", (GCallback)thumb_loader_done_cb, tl);
421 if (image_loader_start(tl->il)) return TRUE;
423 /* mark failed thumbnail in cache with 0 byte file */
424 if (tl->cache_enable)
426 thumb_loader_save_thumbnail(tl, TRUE);
429 image_loader_free(tl->il);
431 thumb_loader_set_fallback(tl);
438 GdkPixbuf *thumb_loader_get_pixbuf(ThumbLoader *tl)
442 if (tl && tl->standard_loader)
444 return thumb_loader_std_get_pixbuf(reinterpret_cast<ThumbLoaderStd *>(tl));
447 if (tl && tl->fd && tl->fd->thumb_pixbuf)
449 pixbuf = tl->fd->thumb_pixbuf;
450 g_object_ref(pixbuf);
454 pixbuf = pixbuf_fallback(nullptr, tl->max_w, tl->max_h);
460 ThumbLoader *thumb_loader_new(gint width, gint height)
464 /* non-std thumb loader is more effective for configurations with disabled caching
465 because it loads the thumbnails at the required size. loader_std loads
466 the thumbnails at the sizes appropriate for standard cache (typically 256x256 pixels)
467 and then performs one additional scaling */
468 if (options->thumbnails.spec_standard && options->thumbnails.enable_caching)
470 return reinterpret_cast<ThumbLoader *>(thumb_loader_std_new(width, height));
473 tl = g_new0(ThumbLoader, 1);
475 tl->cache_enable = options->thumbnails.enable_caching;
476 tl->percent_done = 0.0;
483 void thumb_loader_free(ThumbLoader *tl)
487 if (tl->standard_loader)
489 thumb_loader_std_free(reinterpret_cast<ThumbLoaderStd *>(tl));
493 image_loader_free(tl->il);
494 file_data_unref(tl->fd);
496 if (tl->idle_done_id) g_source_remove(tl->idle_done_id);
501 /* release thumb_pixbuf on file change - this forces reload. */
502 void thumb_notify_cb(FileData *fd, NotifyType type, gpointer)
504 if ((type & (NOTIFY_REREAD | NOTIFY_CHANGE)) && fd->thumb_pixbuf)
506 DEBUG_1("Notify thumb: %s %04x", fd->path, type);
507 g_object_unref(fd->thumb_pixbuf);
508 fd->thumb_pixbuf = nullptr;
514 *-----------------------------------------------------------------------------
515 * xvpics thumbnail support, read-only (private)
516 *-----------------------------------------------------------------------------
520 * xvpics code originally supplied by:
521 * "Diederen Damien" <D.Diederen@student.ulg.ac.be>
523 * Note: Code has been modified to fit the style of the other code, and to use
524 * a few more glib-isms.
525 * 08-28-2000: Updated to return a gdk_pixbuf, Imlib is dying a death here.
528 #define XV_BUFFER 2048
529 static guchar *load_xv_thumbnail(gchar *filename, gint *widthp, gint *heightp)
532 gchar buffer[XV_BUFFER];
533 guchar *data = nullptr;
535 file = fopen(filename, "rt");
536 if (!file) return nullptr;
538 if (fgets(buffer, XV_BUFFER, file) != nullptr
539 && strncmp(buffer, "P7 332", 6) == 0)
541 gint width, height, depth;
543 while (fgets(buffer, XV_BUFFER, file) && buffer[0] == '#') /* do_nothing() */;
545 if (sscanf(buffer, "%d %d %d", &width, &height, &depth) == 3)
547 gsize size = width * height;
549 data = g_new(guchar, size);
550 if (data && fread(data, 1, size, file) == size)
563 static void free_rgb_buffer(guchar *pixels, gpointer)
568 static GdkPixbuf *get_xv_thumbnail(gchar *thumb_filename, gint max_w, gint max_h)
577 path = path_from_utf8(thumb_filename);
578 directory = g_path_get_dirname(path);
579 name = g_path_get_basename(path);
581 thumb_name = g_build_filename(directory, ".xvpics", name, NULL);
587 packed_data = load_xv_thumbnail(thumb_name, &width, &height);
596 rgb_data = g_new(guchar, width * height * 3);
597 for (i = 0; i < width * height; i++)
599 rgb_data[i * 3 + 0] = (packed_data[i] >> 5) * 36;
600 rgb_data[i * 3 + 1] = ((packed_data[i] & 28) >> 2) * 36;
601 rgb_data[i * 3 + 2] = (packed_data[i] & 3) * 85;
605 pixbuf = gdk_pixbuf_new_from_data(rgb_data, GDK_COLORSPACE_RGB, FALSE, 8,
606 width, height, 3 * width, free_rgb_buffer, nullptr);
608 if (pixbuf_scale_aspect(width, height, max_w, max_h, &width, &height))
614 pixbuf = gdk_pixbuf_scale_simple(tmp, width, height, GDK_INTERP_NEAREST);
623 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */