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.
22 #include "image-load.h"
36 #include "gq-marshal.h"
37 #include "image-load-collection.h"
38 #include "image-load-dds.h"
40 # include "image-load-djvu.h"
42 #include "image-load-external.h"
43 #if HAVE_FFMPEGTHUMBNAILER
44 # include "image-load-ffmpegthumbnailer.h"
46 #include "image-load-gdk.h"
48 # include "image-load-heif.h"
51 # include "image-load-j2k.h"
55 # include "image-load-cr3.h"
57 # include "image-load-jpeg.h"
60 # include "image-load-jpegxl.h"
62 #include "image-load-libraw.h"
64 # include "image-load-pdf.h"
66 #include "image-load-psd.h"
67 #include "image-load-svgz.h"
69 # include "image-load-tiff.h"
71 #include "image-load-webp.h"
72 #include "image-load-zxscr.h"
76 #include "ui-fileops.h"
81 IMAGE_LOADER_READ_BUFFER_SIZE_DEFAULT = 4096,
82 IMAGE_LOADER_IDLE_READ_LOOP_COUNT_DEFAULT = 1
85 /* image loader class */
89 SIGNAL_AREA_READY = 0,
97 static guint signals[SIGNAL_COUNT] = { 0 };
99 static void image_loader_init(GTypeInstance *instance, gpointer g_class);
100 static void image_loader_class_init_wrapper(void *data, void *user_data);
101 static void image_loader_class_init(ImageLoaderClass *loader_class);
102 static void image_loader_finalize(GObject *object);
103 static void image_loader_stop(ImageLoader *il);
105 GType image_loader_get_type()
107 static GType type = 0;
110 static const GTypeInfo info = {
111 sizeof(ImageLoaderClass),
112 nullptr, /* base_init */
113 nullptr, /* base_finalize */
114 static_cast<GClassInitFunc>(image_loader_class_init_wrapper), /* class_init */
115 nullptr, /* class_finalize */
116 nullptr, /* class_data */
119 static_cast<GInstanceInitFunc>(image_loader_init), /* instance_init */
120 nullptr /* value_table */
122 type = g_type_register_static(G_TYPE_OBJECT, "ImageLoaderType", &info, static_cast<GTypeFlags>(0));
127 static void image_loader_init(GTypeInstance *instance, gpointer)
129 auto il = reinterpret_cast<ImageLoader *>(instance);
131 il->pixbuf = nullptr;
133 il->idle_priority = G_PRIORITY_DEFAULT_IDLE;
135 il->loader = nullptr;
140 il->idle_done_id = 0;
142 il->idle_read_loop_count = IMAGE_LOADER_IDLE_READ_LOOP_COUNT_DEFAULT;
143 il->read_buffer_size = IMAGE_LOADER_READ_BUFFER_SIZE_DEFAULT;
144 il->mapped_file = nullptr;
145 il->preview = IMAGE_LOADER_PREVIEW_NONE;
147 il->requested_width = 0;
148 il->requested_height = 0;
149 il->actual_width = 0;
150 il->actual_height = 0;
153 il->can_destroy = TRUE;
155 il->data_mutex = g_new(GMutex, 1);
156 g_mutex_init(il->data_mutex);
157 il->can_destroy_cond = g_new(GCond, 1);
158 g_cond_init(il->can_destroy_cond);
160 DEBUG_1("new image loader %p, bufsize=%" G_GSIZE_FORMAT " idle_loop=%u", (void *)il, il->read_buffer_size, il->idle_read_loop_count);
163 static void image_loader_class_init_wrapper(void *data, void *)
165 image_loader_class_init(static_cast<ImageLoaderClass *>(data));
168 static void image_loader_class_init(ImageLoaderClass *loader_class)
170 GObjectClass *gobject_class = G_OBJECT_CLASS (loader_class);
172 gobject_class->finalize = image_loader_finalize;
175 signals[SIGNAL_AREA_READY] =
176 g_signal_new("area_ready",
177 G_OBJECT_CLASS_TYPE(gobject_class),
179 G_STRUCT_OFFSET(ImageLoaderClass, area_ready),
181 gq_marshal_VOID__INT_INT_INT_INT,
188 signals[SIGNAL_ERROR] =
189 g_signal_new("error",
190 G_OBJECT_CLASS_TYPE(gobject_class),
192 G_STRUCT_OFFSET(ImageLoaderClass, error),
194 g_cclosure_marshal_VOID__VOID,
197 signals[SIGNAL_DONE] =
199 G_OBJECT_CLASS_TYPE(gobject_class),
201 G_STRUCT_OFFSET(ImageLoaderClass, done),
203 g_cclosure_marshal_VOID__VOID,
206 signals[SIGNAL_PERCENT] =
207 g_signal_new("percent",
208 G_OBJECT_CLASS_TYPE(gobject_class),
210 G_STRUCT_OFFSET(ImageLoaderClass, percent),
212 g_cclosure_marshal_VOID__DOUBLE,
216 signals[SIGNAL_SIZE] =
217 g_signal_new("size_prepared",
218 G_OBJECT_CLASS_TYPE(gobject_class),
220 G_STRUCT_OFFSET(ImageLoaderClass, area_ready),
222 gq_marshal_VOID__INT_INT,
229 static void image_loader_finalize(GObject *object)
231 auto il = reinterpret_cast<ImageLoader *>(object);
233 image_loader_stop(il);
235 if (il->error) DEBUG_1("%s", image_loader_get_error(il));
237 DEBUG_1("freeing image loader %p bytes_read=%" G_GSIZE_FORMAT, (void *)il, il->bytes_read);
239 if (il->idle_done_id)
241 g_source_remove(il->idle_done_id);
242 il->idle_done_id = 0;
245 while (g_source_remove_by_user_data(il))
247 DEBUG_2("pending signals detected");
250 while (il->area_param_list)
252 DEBUG_1("pending area_ready signals detected");
253 while (g_source_remove_by_user_data(il->area_param_list->data)) {}
254 g_free(il->area_param_list->data);
255 il->area_param_list = g_list_delete_link(il->area_param_list, il->area_param_list);
258 while (il->area_param_delayed_list)
260 g_free(il->area_param_delayed_list->data);
261 il->area_param_delayed_list = g_list_delete_link(il->area_param_delayed_list, il->area_param_delayed_list);
264 if (il->pixbuf) g_object_unref(il->pixbuf);
266 if (il->error) g_error_free(il->error);
268 file_data_unref(il->fd);
270 g_mutex_clear(il->data_mutex);
271 g_free(il->data_mutex);
272 g_cond_clear(il->can_destroy_cond);
273 g_free(il->can_destroy_cond);
276 void image_loader_free(ImageLoader *il)
279 g_object_unref(G_OBJECT(il));
283 ImageLoader *image_loader_new(FileData *fd)
287 if (!fd) return nullptr;
289 il = static_cast<ImageLoader *>(g_object_new(TYPE_IMAGE_LOADER, nullptr));
291 il->fd = file_data_ref(fd);
296 /**************************************************************************************/
297 /* send signals via idle calbacks - the callback are executed in the main thread */
299 struct ImageLoaderAreaParam {
308 static gboolean image_loader_emit_area_ready_cb(gpointer data)
310 auto par = static_cast<ImageLoaderAreaParam *>(data);
311 ImageLoader *il = par->il;
316 g_mutex_lock(il->data_mutex);
317 il->area_param_list = g_list_remove(il->area_param_list, par);
323 g_mutex_unlock(il->data_mutex);
325 g_signal_emit(il, signals[SIGNAL_AREA_READY], 0, x, y, w, h);
327 return G_SOURCE_REMOVE;
330 static gboolean image_loader_emit_done_cb(gpointer data)
332 auto il = static_cast<ImageLoader *>(data);
333 g_signal_emit(il, signals[SIGNAL_DONE], 0);
334 return G_SOURCE_REMOVE;
337 static gboolean image_loader_emit_error_cb(gpointer data)
339 auto il = static_cast<ImageLoader *>(data);
340 g_signal_emit(il, signals[SIGNAL_ERROR], 0);
341 return G_SOURCE_REMOVE;
344 static gboolean image_loader_emit_percent_cb(gpointer data)
346 auto il = static_cast<ImageLoader *>(data);
347 g_signal_emit(il, signals[SIGNAL_PERCENT], 0, image_loader_get_percent(il));
348 return G_SOURCE_REMOVE;
351 static gboolean image_loader_emit_size_cb(gpointer data)
355 auto il = static_cast<ImageLoader *>(data);
356 g_mutex_lock(il->data_mutex);
357 width = il->actual_width;
358 height = il->actual_height;
359 g_mutex_unlock(il->data_mutex);
360 g_signal_emit(il, signals[SIGNAL_SIZE], 0, width, height);
361 return G_SOURCE_REMOVE;
365 /* DONE and ERROR are emitted only once, thus they can have normal priority
366 PERCENT and AREA_READY should be processed ASAP
369 static void image_loader_emit_done(ImageLoader *il)
371 g_idle_add_full(il->idle_priority, image_loader_emit_done_cb, il, nullptr);
374 static void image_loader_emit_error(ImageLoader *il)
376 g_idle_add_full(il->idle_priority, image_loader_emit_error_cb, il, nullptr);
379 static void image_loader_emit_percent(ImageLoader *il)
381 g_idle_add_full(G_PRIORITY_HIGH, image_loader_emit_percent_cb, il, nullptr);
384 static void image_loader_emit_size(ImageLoader *il)
386 g_idle_add_full(G_PRIORITY_HIGH, image_loader_emit_size_cb, il, nullptr);
389 static ImageLoaderAreaParam *image_loader_queue_area_ready(ImageLoader *il, GList **list, guint x, guint y, guint w, guint h)
393 auto prev_par = static_cast<ImageLoaderAreaParam *>((*list)->data);
394 if (prev_par->x == x && prev_par->w == w &&
395 prev_par->y + prev_par->h == y)
397 /* we can merge the notifications */
401 if (prev_par->x == x && prev_par->w == w &&
402 y + h == prev_par->y)
404 /* we can merge the notifications */
409 if (prev_par->y == y && prev_par->h == h &&
410 prev_par->x + prev_par->w == x)
412 /* we can merge the notifications */
416 if (prev_par->y == y && prev_par->h == h &&
417 x + w == prev_par->x)
419 /* we can merge the notifications */
426 auto par = g_new0(ImageLoaderAreaParam, 1);
433 *list = g_list_prepend(*list, par);
437 /* this function expects that il->data_mutex is locked by caller */
438 static void image_loader_emit_area_ready(ImageLoader *il, guint x, guint y, guint w, guint h)
440 ImageLoaderAreaParam *par = image_loader_queue_area_ready(il, &il->area_param_list, x, y, w, h);
444 g_idle_add_full(G_PRIORITY_HIGH, image_loader_emit_area_ready_cb, par, nullptr);
448 /**************************************************************************************/
449 /* the following functions may be executed in separate thread */
451 /* this function expects that il->data_mutex is locked by caller */
452 static void image_loader_queue_delayed_area_ready(ImageLoader *il, guint x, guint y, guint w, guint h)
454 image_loader_queue_area_ready(il, &il->area_param_delayed_list, x, y, w, h);
459 static gboolean image_loader_get_stopping(ImageLoader *il)
462 if (!il) return FALSE;
464 g_mutex_lock(il->data_mutex);
466 g_mutex_unlock(il->data_mutex);
472 static void image_loader_sync_pixbuf(ImageLoader *il)
476 g_mutex_lock(il->data_mutex);
480 g_mutex_unlock(il->data_mutex);
484 pb = il->backend.get_pixbuf(il->loader);
486 if (pb == il->pixbuf)
488 g_mutex_unlock(il->data_mutex);
492 if (g_ascii_strcasecmp(".jps", il->fd->extension) == 0)
494 g_object_set_data(G_OBJECT(pb), "stereo_data", GINT_TO_POINTER(STEREO_PIXBUF_CROSS));
497 if (il->pixbuf) g_object_unref(il->pixbuf);
500 if (il->pixbuf) g_object_ref(il->pixbuf);
502 g_mutex_unlock(il->data_mutex);
505 static void image_loader_area_updated_cb(gpointer,
506 guint x, guint y, guint w, guint h,
509 auto il = static_cast<ImageLoader *>(data);
511 if (!image_loader_get_pixbuf(il))
513 image_loader_sync_pixbuf(il);
514 if (!image_loader_get_pixbuf(il))
516 log_printf("critical: area_ready signal with NULL pixbuf (out of mem?)\n");
520 g_mutex_lock(il->data_mutex);
521 if (il->delay_area_ready)
522 image_loader_queue_delayed_area_ready(il, x, y, w, h);
524 image_loader_emit_area_ready(il, x, y, w, h);
526 if (il->stopping) il->backend.abort(il->loader);
528 g_mutex_unlock(il->data_mutex);
531 static void image_loader_area_prepared_cb(gpointer loader, gpointer data)
533 auto il = static_cast<ImageLoader *>(data);
540 https://bugzilla.gnome.org/show_bug.cgi?id=547669
541 https://bugzilla.gnome.org/show_bug.cgi?id=589334
543 gchar *format = il->backend.get_format_name(loader);
544 if (strcmp(format, "svg") == 0 ||
545 strcmp(format, "xpm") == 0)
553 pb = il->backend.get_pixbuf(loader);
555 h = gdk_pixbuf_get_height(pb);
556 rs = gdk_pixbuf_get_rowstride(pb);
557 pix = gdk_pixbuf_get_pixels(pb);
559 memset(pix, 0, rs * h); /*this should be faster than pixbuf_fill */
563 static void image_loader_size_cb(gpointer loader,
564 gint width, gint height, gpointer data)
566 auto il = static_cast<ImageLoader *>(data);
568 gboolean scale = FALSE;
571 g_mutex_lock(il->data_mutex);
572 il->actual_width = width;
573 il->actual_height = height;
574 if (il->requested_width < 1 || il->requested_height < 1)
576 g_mutex_unlock(il->data_mutex);
577 image_loader_emit_size(il);
580 g_mutex_unlock(il->data_mutex);
582 #if HAVE_FFMPEGTHUMBNAILER
583 if (il->fd->format_class == FORMAT_CLASS_VIDEO)
586 mime_types = il->backend.get_format_mime_types(loader);
588 while (mime_types[n] && !scale)
590 if (strstr(mime_types[n], "jpeg")) scale = TRUE;
593 g_strfreev(mime_types);
597 image_loader_emit_size(il);
601 g_mutex_lock(il->data_mutex);
605 if (width > il->requested_width || height > il->requested_height)
608 if ((static_cast<gdouble>(il->requested_width) / width) < (static_cast<gdouble>(il->requested_height) / height))
610 nw = il->requested_width;
611 nh = static_cast<gdouble>(nw) / width * height;
616 nh = il->requested_height;
617 nw = static_cast<gdouble>(nh) / height * width;
621 il->actual_width = nw;
622 il->actual_height = nh;
623 il->backend.set_size(loader, nw, nh);
627 g_mutex_unlock(il->data_mutex);
628 image_loader_emit_size(il);
631 static void image_loader_stop_loader(ImageLoader *il)
637 /* some loaders do not have a pixbuf till close, order is important here */
638 il->backend.close(il->loader, il->error ? nullptr : &il->error); /* we are interested in the first error only */
639 image_loader_sync_pixbuf(il);
640 il->backend.free(il->loader);
641 il->loader = nullptr;
643 g_mutex_lock(il->data_mutex);
645 g_mutex_unlock(il->data_mutex);
648 static void image_loader_setup_loader(ImageLoader *il)
650 #if defined HAVE_TIFF || defined HAVE_PDF || defined HAVE_HEIF || defined HAVE_DJVU
654 gint external_preview = 1;
656 g_mutex_lock(il->data_mutex);
658 if (options->external_preview.enable)
661 gchar *tilde_filename;
663 tilde_filename = expand_tilde(options->external_preview.select);
665 cmd_line = g_strdup_printf("\"%s\" \"%s\"" , tilde_filename, il->fd->path);
667 external_preview = runcmd(cmd_line);
669 g_free(tilde_filename);
672 if (external_preview == 0)
674 DEBUG_1("Using custom external loader");
675 image_loader_backend_set_external(&il->backend);
679 #if HAVE_FFMPEGTHUMBNAILER
680 if (il->fd->format_class == FORMAT_CLASS_VIDEO)
682 DEBUG_1("Using custom ffmpegthumbnailer loader");
683 image_loader_backend_set_ft(&il->backend);
688 if (il->bytes_total >= 4 &&
689 (memcmp(il->mapped_file + 0, "%PDF", 4) == 0))
691 DEBUG_1("Using custom pdf loader");
692 image_loader_backend_set_pdf(&il->backend);
697 if (il->bytes_total >= 12 &&
698 ((memcmp(il->mapped_file + 4, "ftypheic", 8) == 0) ||
699 (memcmp(il->mapped_file + 4, "ftypheix", 8) == 0) ||
700 (memcmp(il->mapped_file + 4, "ftypmsf1", 8) == 0) ||
701 (memcmp(il->mapped_file + 4, "ftypmif1", 8) == 0) ||
702 (memcmp(il->mapped_file + 4, "ftypavif", 8) == 0)))
704 DEBUG_1("Using custom heif loader");
705 image_loader_backend_set_heif(&il->backend);
710 if (il->bytes_total >= 12 &&
711 (memcmp(il->mapped_file, "RIFF", 4) == 0) &&
712 (memcmp(il->mapped_file + 8, "WEBP", 4) == 0))
714 DEBUG_1("Using custom webp loader");
715 image_loader_backend_set_webp(&il->backend);
720 if (il->bytes_total >= 16 &&
721 (memcmp(il->mapped_file, "AT&TFORM", 8) == 0) &&
722 (memcmp(il->mapped_file + 12, "DJV", 3) == 0))
724 DEBUG_1("Using custom djvu loader");
725 image_loader_backend_set_djvu(&il->backend);
730 if (il->bytes_total >= 2 && il->mapped_file[0] == 0xff && il->mapped_file[1] == 0xd8)
732 DEBUG_1("Using custom jpeg loader");
733 image_loader_backend_set_jpeg(&il->backend);
737 if (il->bytes_total >= 11 &&
738 (memcmp(il->mapped_file + 4, "ftypcrx", 7) == 0) &&
739 (memcmp(il->mapped_file + 64, "CanonCR3", 8) == 0))
741 DEBUG_1("Using custom cr3 loader");
742 image_loader_backend_set_cr3(&il->backend);
748 if (il->bytes_total >= 10 &&
749 (memcmp(il->mapped_file, "MM\0*", 4) == 0 ||
750 memcmp(il->mapped_file, "MM\0+\0\x08\0\0", 8) == 0 ||
751 memcmp(il->mapped_file, "II+\0\x08\0\0\0", 8) == 0 ||
752 memcmp(il->mapped_file, "II*\0", 4) == 0))
754 DEBUG_1("Using custom tiff loader");
755 image_loader_backend_set_tiff(&il->backend);
759 if (il->bytes_total >= 3 && il->mapped_file[0] == 0x44 && il->mapped_file[1] == 0x44 && il->mapped_file[2] == 0x53)
761 DEBUG_1("Using dds loader");
762 image_loader_backend_set_dds(&il->backend);
765 if (il->bytes_total >= 6 &&
766 (memcmp(il->mapped_file, "8BPS\0\x01", 6) == 0))
768 DEBUG_1("Using custom psd loader");
769 image_loader_backend_set_psd(&il->backend);
773 if (il->bytes_total >= 12 &&
774 (memcmp(il->mapped_file, "\0\0\0\x0CjP\x20\x20\x0D\x0A\x87\x0A", 12) == 0))
776 DEBUG_1("Using custom j2k loader");
777 image_loader_backend_set_j2k(&il->backend);
782 if (il->bytes_total >= 12 &&
783 (memcmp(il->mapped_file, "\0\0\0\x0C\x4A\x58\x4C\x20\x0D\x0A\x87\x0A", 12) == 0))
785 DEBUG_1("Using custom jpeg xl loader");
786 image_loader_backend_set_jpegxl(&il->backend);
789 if (il->bytes_total >= 2 &&
790 (memcmp(il->mapped_file, "\xFF\x0A", 2) == 0))
792 DEBUG_1("Using custom jpeg xl loader");
793 image_loader_backend_set_jpegxl(&il->backend);
797 if ((il->bytes_total == 6144 || il->bytes_total == 6912) &&
798 (file_extension_match(il->fd->path, ".scr")))
800 DEBUG_1("Using custom zxscr loader");
801 image_loader_backend_set_zxscr(&il->backend);
804 if (il->fd->format_class == FORMAT_CLASS_COLLECTION)
806 DEBUG_1("Using custom collection loader");
807 image_loader_backend_set_collection(&il->backend);
810 if (g_strcmp0(strrchr(il->fd->path, '.'), ".svgz") == 0)
812 DEBUG_1("Using custom svgz loader");
813 image_loader_backend_set_svgz(&il->backend);
816 image_loader_backend_set_default(&il->backend);
819 il->loader = static_cast<void **>(il->backend.loader_new(image_loader_area_updated_cb, image_loader_size_cb, image_loader_area_prepared_cb, il));
822 format = il->backend.get_format_name(il->loader);
823 if (g_strcmp0(format, "tiff") == 0)
825 il->backend.set_page_num(il->loader, il->fd->page_num);
831 format = il->backend.get_format_name(il->loader);
832 if (g_strcmp0(format, "pdf") == 0)
834 il->backend.set_page_num(il->loader, il->fd->page_num);
840 format = il->backend.get_format_name(il->loader);
841 if (g_strcmp0(format, "heif") == 0)
843 il->backend.set_page_num(il->loader, il->fd->page_num);
849 format = il->backend.get_format_name(il->loader);
850 if (g_strcmp0(format, "djvu") == 0)
852 il->backend.set_page_num(il->loader, il->fd->page_num);
857 il->fd->format_name = il->backend.get_format_name(il->loader);
859 g_mutex_unlock(il->data_mutex);
863 static void image_loader_done(ImageLoader *il)
865 image_loader_stop_loader(il);
867 image_loader_emit_done(il);
870 static void image_loader_error(ImageLoader *il)
872 image_loader_stop_loader(il);
874 DEBUG_1("pixbuf_loader reported load error for: %s", il->fd->path);
876 image_loader_emit_error(il);
879 static gboolean image_loader_continue(ImageLoader *il)
884 if (!il) return G_SOURCE_REMOVE;
886 c = il->idle_read_loop_count ? il->idle_read_loop_count : 1;
887 while (c > 0 && !image_loader_get_stopping(il))
889 b = MIN(il->read_buffer_size, il->bytes_total - il->bytes_read);
893 image_loader_done(il);
894 return G_SOURCE_REMOVE;
897 if (b < 0 || (b > 0 && !il->backend.write(il->loader, il->mapped_file + il->bytes_read, b, &il->error)))
899 image_loader_error(il);
900 return G_SOURCE_REMOVE;
908 if (il->bytes_total > 0)
910 image_loader_emit_percent(il);
913 return G_SOURCE_CONTINUE;
916 static gboolean image_loader_begin(ImageLoader *il)
918 #if defined HAVE_TIFF || defined HAVE_PDF || defined HAVE_HEIF || defined HAVE_DJVU
923 if (il->pixbuf) return FALSE;
925 b = MIN(il->read_buffer_size, il->bytes_total - il->bytes_read);
926 if (b < 1) return FALSE;
928 image_loader_setup_loader(il);
930 g_assert(il->bytes_read == 0);
931 if (il->backend.load) {
933 if (!il->backend.load(il->loader, il->mapped_file, b, &il->error))
935 image_loader_stop_loader(il);
939 else if (!il->backend.write(il->loader, il->mapped_file, b, &il->error))
941 image_loader_stop_loader(il);
946 format = il->backend.get_format_name(il->loader);
947 if (g_strcmp0(format, "pdf") == 0)
949 gint i = il->backend.get_page_total(il->loader);
950 file_data_set_page_total(il->fd, i);
955 format = il->backend.get_format_name(il->loader);
956 if (g_strcmp0(format, "heif") == 0)
958 gint i = il->backend.get_page_total(il->loader);
959 file_data_set_page_total(il->fd, i);
964 format = il->backend.get_format_name(il->loader);
965 if (g_strcmp0(format, "djvu") == 0)
967 gint i = il->backend.get_page_total(il->loader);
968 file_data_set_page_total(il->fd, i);
973 format = il->backend.get_format_name(il->loader);
974 if (g_strcmp0(format, "tiff") == 0)
976 gint i = il->backend.get_page_total(il->loader);
977 file_data_set_page_total(il->fd, i);
984 /* read until size is known */
985 while (il->loader && !il->backend.get_pixbuf(il->loader) && b > 0 && !image_loader_get_stopping(il))
987 b = MIN(il->read_buffer_size, il->bytes_total - il->bytes_read);
988 if (b < 0 || (b > 0 && !il->backend.write(il->loader, il->mapped_file + il->bytes_read, b, &il->error)))
990 image_loader_stop_loader(il);
995 if (!il->pixbuf) image_loader_sync_pixbuf(il);
997 if (il->bytes_read == il->bytes_total || b < 1)
999 /* done, handle (broken) loaders that do not have pixbuf till close */
1000 image_loader_stop_loader(il);
1002 if (!il->pixbuf) return FALSE;
1004 image_loader_done(il);
1010 image_loader_stop_loader(il);
1017 /**************************************************************************************/
1018 /* the following functions are always executed in the main thread */
1021 static gboolean image_loader_setup_source(ImageLoader *il)
1026 if (!il || il->loader || il->mapped_file) return FALSE;
1028 il->mapped_file = nullptr;
1032 ExifData *exif = exif_read_fd(il->fd);
1034 if (options->thumbnails.use_exif)
1036 il->mapped_file = exif_get_preview(exif, reinterpret_cast<guint *>(&il->bytes_total), il->requested_width, il->requested_height);
1038 if (il->mapped_file)
1040 il->preview = IMAGE_LOADER_PREVIEW_EXIF;
1045 il->mapped_file = libraw_get_preview(il, reinterpret_cast<guint *>(&il->bytes_total));
1047 if (il->mapped_file)
1049 /* Both exiv2 and libraw sometimes return a pointer to a file
1050 * section that is not a jpeg */
1051 if (il->mapped_file[0] != 0xFF || il->mapped_file[1] != 0xD8)
1053 il->mapped_file = nullptr;
1057 il->preview = IMAGE_LOADER_PREVIEW_LIBRAW;
1062 /* If libraw does not find a thumbnail, try exiv2 */
1063 if (!il->mapped_file)
1065 il->mapped_file = exif_get_preview(exif, reinterpret_cast<guint *>(&il->bytes_total), 0, 0); /* get the largest available preview image or NULL for normal images*/
1067 if (il->mapped_file)
1069 /* Both exiv2 and libraw sometimes return a pointer to a file
1070 * section that is not a jpeg */
1071 if (il->mapped_file[0] != 0xFF || il->mapped_file[1] != 0xD8)
1073 il->mapped_file = nullptr;
1077 il->preview = IMAGE_LOADER_PREVIEW_EXIF;
1082 if (il->mapped_file)
1084 DEBUG_1("Usable reduced size (preview) image loaded from file %s", il->fd->path);
1086 exif_free_fd(il->fd, exif);
1090 if (!il->mapped_file)
1095 pathl = path_from_utf8(il->fd->path);
1096 load_fd = open(pathl, O_RDONLY | O_NONBLOCK);
1098 if (load_fd == -1) return FALSE;
1100 if (fstat(load_fd, &st) == 0)
1102 il->bytes_total = st.st_size;
1110 il->mapped_file = static_cast<guchar *>(mmap(nullptr, il->bytes_total, PROT_READ|PROT_WRITE, MAP_PRIVATE, load_fd, 0));
1112 if (il->mapped_file == MAP_FAILED)
1114 il->mapped_file = nullptr;
1117 il->preview = IMAGE_LOADER_PREVIEW_NONE;
1123 static void image_loader_stop_source(ImageLoader *il)
1127 if (il->mapped_file)
1129 if (il->preview == IMAGE_LOADER_PREVIEW_EXIF)
1131 exif_free_preview(il->mapped_file);
1133 else if (il->preview == IMAGE_LOADER_PREVIEW_LIBRAW)
1135 libraw_free_preview(il->mapped_file);
1139 munmap(il->mapped_file, il->bytes_total);
1141 il->mapped_file = nullptr;
1145 static void image_loader_stop(ImageLoader *il)
1151 g_source_remove(il->idle_id);
1157 /* stop loader in the other thread */
1158 g_mutex_lock(il->data_mutex);
1159 il->stopping = TRUE;
1160 while (!il->can_destroy) g_cond_wait(il->can_destroy_cond, il->data_mutex);
1161 g_mutex_unlock(il->data_mutex);
1164 image_loader_stop_loader(il);
1165 image_loader_stop_source(il);
1169 void image_loader_delay_area_ready(ImageLoader *il, gboolean enable)
1171 g_mutex_lock(il->data_mutex);
1172 il->delay_area_ready = enable;
1178 list = g_list_reverse(il->area_param_delayed_list);
1179 il->area_param_delayed_list = nullptr;
1180 g_mutex_unlock(il->data_mutex);
1186 auto par = static_cast<ImageLoaderAreaParam *>(work->data);
1189 g_signal_emit(il, signals[SIGNAL_AREA_READY], 0, par->x, par->y, par->w, par->h);
1191 g_list_free_full(list, g_free);
1196 g_mutex_unlock(il->data_mutex);
1201 /**************************************************************************************/
1202 /* execution via idle calls */
1204 static gboolean image_loader_idle_cb(gpointer data)
1206 gboolean ret = G_SOURCE_REMOVE;
1207 auto il = static_cast<ImageLoader *>(data);
1211 ret = image_loader_continue(il);
1216 image_loader_stop_source(il);
1222 static gboolean image_loader_start_idle(ImageLoader *il)
1226 if (!il) return FALSE;
1228 if (!il->fd) return FALSE;
1230 if (!image_loader_setup_source(il)) return FALSE;
1232 ret = image_loader_begin(il);
1234 if (ret && !il->done) il->idle_id = g_idle_add_full(il->idle_priority, image_loader_idle_cb, il, nullptr);
1238 /**************************************************************************************/
1239 /* execution via thread */
1241 static GThreadPool *image_loader_thread_pool = nullptr;
1243 static GCond *image_loader_prio_cond = nullptr;
1244 static GMutex *image_loader_prio_mutex = nullptr;
1245 static gint image_loader_prio_num = 0;
1248 static void image_loader_thread_enter_high()
1250 g_mutex_lock(image_loader_prio_mutex);
1251 image_loader_prio_num++;
1252 g_mutex_unlock(image_loader_prio_mutex);
1255 static void image_loader_thread_leave_high()
1257 g_mutex_lock(image_loader_prio_mutex);
1258 image_loader_prio_num--;
1259 if (image_loader_prio_num == 0) g_cond_broadcast(image_loader_prio_cond); /* wake up all low prio threads */
1260 g_mutex_unlock(image_loader_prio_mutex);
1263 static void image_loader_thread_wait_high()
1265 g_mutex_lock(image_loader_prio_mutex);
1266 while (image_loader_prio_num)
1268 g_cond_wait(image_loader_prio_cond, image_loader_prio_mutex);
1271 g_mutex_unlock(image_loader_prio_mutex);
1275 static void image_loader_thread_run(gpointer data, gpointer)
1277 auto il = static_cast<ImageLoader *>(data);
1281 if (il->idle_priority > G_PRIORITY_DEFAULT_IDLE)
1283 /* low prio, wait until high prio tasks finishes */
1284 image_loader_thread_wait_high();
1289 image_loader_thread_enter_high();
1292 err = !image_loader_begin(il);
1297 loader failed, we have to send signal
1298 (idle mode returns the image_loader_begin return value directly)
1299 (success is always reported indirectly from image_loader_begin)
1301 image_loader_emit_error(il);
1306 while (cont && !image_loader_get_is_done(il) && !image_loader_get_stopping(il))
1308 if (il->idle_priority > G_PRIORITY_DEFAULT_IDLE)
1310 /* low prio, wait until high prio tasks finishes */
1311 image_loader_thread_wait_high();
1313 cont = image_loader_continue(il);
1315 image_loader_stop_loader(il);
1317 if (il->idle_priority <= G_PRIORITY_DEFAULT_IDLE)
1320 image_loader_thread_leave_high();
1323 g_mutex_lock(il->data_mutex);
1324 il->can_destroy = TRUE;
1325 g_cond_signal(il->can_destroy_cond);
1326 g_mutex_unlock(il->data_mutex);
1331 static gboolean image_loader_start_thread(ImageLoader *il)
1333 if (!il) return FALSE;
1335 if (!il->fd) return FALSE;
1339 if (!image_loader_setup_source(il)) return FALSE;
1341 if (!image_loader_thread_pool)
1343 image_loader_thread_pool = g_thread_pool_new(image_loader_thread_run, nullptr, -1, FALSE, nullptr);
1344 if (!image_loader_prio_cond) image_loader_prio_cond = g_new(GCond, 1);
1345 g_cond_init(image_loader_prio_cond);
1346 if (!image_loader_prio_mutex) image_loader_prio_mutex = g_new(GMutex, 1);
1347 g_mutex_init(image_loader_prio_mutex);
1350 il->can_destroy = FALSE; /* ImageLoader can't be freed until image_loader_thread_run finishes */
1352 g_thread_pool_push(image_loader_thread_pool, il, nullptr);
1353 DEBUG_1("Thread pool num threads: %d", g_thread_pool_get_num_threads(image_loader_thread_pool));
1359 /**************************************************************************************/
1360 /* public interface */
1363 gboolean image_loader_start(ImageLoader *il)
1365 if (!il) return FALSE;
1367 if (!il->fd) return FALSE;
1369 return image_loader_start_thread(il);
1373 /* don't forget to gdk_pixbuf_ref() it if you want to use it after image_loader_free() */
1374 GdkPixbuf *image_loader_get_pixbuf(ImageLoader *il)
1377 if (!il) return nullptr;
1379 g_mutex_lock(il->data_mutex);
1381 g_mutex_unlock(il->data_mutex);
1385 void image_loader_set_requested_size(ImageLoader *il, gint width, gint height)
1389 g_mutex_lock(il->data_mutex);
1390 il->requested_width = width;
1391 il->requested_height = height;
1392 g_mutex_unlock(il->data_mutex);
1395 void image_loader_set_buffer_size(ImageLoader *il, guint count)
1399 g_mutex_lock(il->data_mutex);
1400 il->idle_read_loop_count = count ? count : 1;
1401 g_mutex_unlock(il->data_mutex);
1404 void image_loader_set_priority(ImageLoader *il, gint priority)
1408 if (il->thread) return; /* can't change prio if the thread already runs */
1409 il->idle_priority = priority;
1413 gdouble image_loader_get_percent(ImageLoader *il)
1416 if (!il) return 0.0;
1418 g_mutex_lock(il->data_mutex);
1419 if (il->bytes_total == 0)
1425 ret = static_cast<gdouble>(il->bytes_read) / il->bytes_total;
1427 g_mutex_unlock(il->data_mutex);
1431 gboolean image_loader_get_is_done(ImageLoader *il)
1434 if (!il) return FALSE;
1436 g_mutex_lock(il->data_mutex);
1438 g_mutex_unlock(il->data_mutex);
1443 FileData *image_loader_get_fd(ImageLoader *il)
1446 if (!il) return nullptr;
1448 g_mutex_lock(il->data_mutex);
1450 g_mutex_unlock(il->data_mutex);
1455 gboolean image_loader_get_shrunk(ImageLoader *il)
1458 if (!il) return FALSE;
1460 g_mutex_lock(il->data_mutex);
1462 g_mutex_unlock(il->data_mutex);
1466 const gchar *image_loader_get_error(ImageLoader *il)
1468 const gchar *ret = nullptr;
1469 if (!il) return nullptr;
1470 g_mutex_lock(il->data_mutex);
1471 if (il->error) ret = il->error->message;
1472 g_mutex_unlock(il->data_mutex);
1478 * @FIXME this can be rather slow and blocks until the size is known
1480 gboolean image_load_dimensions(FileData *fd, gint *width, gint *height)
1485 il = image_loader_new(fd);
1487 success = image_loader_start_idle(il);
1489 if (success && il->pixbuf)
1491 if (width) *width = gdk_pixbuf_get_width(il->pixbuf);
1492 if (height) *height = gdk_pixbuf_get_height(il->pixbuf);;
1496 if (width) *width = -1;
1497 if (height) *height = -1;
1500 image_loader_free(il);
1504 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */