Convert GET_{LEFT,RIGHT}_PIXBUF_OFFSET macro to function
[geeqie.git] / src / image-load.cc
1 /*
2  * Copyright (C) 2004 John Ellis
3  * Copyright (C) 2008 - 2016 The Geeqie Team
4  *
5  * Author: John Ellis
6  *
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.
11  *
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.
16  *
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.
20  */
21
22 #include "image-load.h"
23
24 #include <fcntl.h>
25 #include <sys/mman.h>
26 #include <sys/stat.h>
27 #include <unistd.h>
28
29 #include <cstring>
30
31 #include <config.h>
32
33 #include "debug.h"
34 #include "exif.h"
35 #include "filedata.h"
36 #include "gq-marshal.h"
37 #include "image-load-collection.h"
38 #include "image-load-dds.h"
39 #if HAVE_DJVU
40 #  include "image-load-djvu.h"
41 #endif
42 #include "image-load-external.h"
43 #if HAVE_FFMPEGTHUMBNAILER
44 #  include "image-load-ffmpegthumbnailer.h"
45 #endif
46 #include "image-load-gdk.h"
47 #if HAVE_HEIF
48 #  include "image-load-heif.h"
49 #endif
50 #if HAVE_J2K
51 #  include "image-load-j2k.h"
52 #endif
53 #if HAVE_JPEG
54 #  if !HAVE_RAW
55 #    include "image-load-cr3.h"
56 #  endif
57 #  include "image-load-jpeg.h"
58 #endif
59 #if HAVE_JPEGXL
60 #  include "image-load-jpegxl.h"
61 #endif
62 #include "image-load-libraw.h"
63 #if HAVE_PDF
64 #  include "image-load-pdf.h"
65 #endif
66 #include "image-load-psd.h"
67 #include "image-load-svgz.h"
68 #if HAVE_TIFF
69 #  include "image-load-tiff.h"
70 #endif
71 #include "image-load-webp.h"
72 #include "image-load-zxscr.h"
73 #include "misc.h"
74 #include "options.h"
75 #include "typedefs.h"
76 #include "ui-fileops.h"
77
78 struct ExifData;
79
80 enum {
81         IMAGE_LOADER_READ_BUFFER_SIZE_DEFAULT =         4096,
82         IMAGE_LOADER_IDLE_READ_LOOP_COUNT_DEFAULT =     1
83 };
84
85 /* image loader class */
86
87
88 enum {
89         SIGNAL_AREA_READY = 0,
90         SIGNAL_ERROR,
91         SIGNAL_DONE,
92         SIGNAL_PERCENT,
93         SIGNAL_SIZE,
94         SIGNAL_COUNT
95 };
96
97 static guint signals[SIGNAL_COUNT] = { 0 };
98
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);
104
105 GType image_loader_get_type()
106 {
107         static GType type = 0;
108         if (type == 0)
109                 {
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 */
117                         sizeof(ImageLoader),
118                         0,      /* n_preallocs */
119                         static_cast<GInstanceInitFunc>(image_loader_init), /* instance_init */
120                         nullptr /* value_table */
121                         };
122                 type = g_type_register_static(G_TYPE_OBJECT, "ImageLoaderType", &info, static_cast<GTypeFlags>(0));
123                 }
124         return type;
125 }
126
127 static void image_loader_init(GTypeInstance *instance, gpointer)
128 {
129         auto il = reinterpret_cast<ImageLoader *>(instance);
130
131         il->pixbuf = nullptr;
132         il->idle_id = 0;
133         il->idle_priority = G_PRIORITY_DEFAULT_IDLE;
134         il->done = FALSE;
135         il->backend.reset(nullptr);
136
137         il->bytes_read = 0;
138         il->bytes_total = 0;
139
140         il->idle_done_id = 0;
141
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;
146
147         il->requested_width = 0;
148         il->requested_height = 0;
149         il->actual_width = 0;
150         il->actual_height = 0;
151         il->shrunk = FALSE;
152
153         il->can_destroy = TRUE;
154
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);
159
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);
161 }
162
163 static void image_loader_class_init_wrapper(void *data, void *)
164 {
165         image_loader_class_init(static_cast<ImageLoaderClass *>(data));
166 }
167
168 static void image_loader_class_init(ImageLoaderClass *loader_class)
169 {
170         GObjectClass *gobject_class = G_OBJECT_CLASS (loader_class);
171
172         gobject_class->finalize = image_loader_finalize;
173
174
175         signals[SIGNAL_AREA_READY] =
176                 g_signal_new("area_ready",
177                              G_OBJECT_CLASS_TYPE(gobject_class),
178                              G_SIGNAL_RUN_LAST,
179                              G_STRUCT_OFFSET(ImageLoaderClass, area_ready),
180                              nullptr, nullptr,
181                              gq_marshal_VOID__INT_INT_INT_INT,
182                              G_TYPE_NONE, 4,
183                              G_TYPE_INT,
184                              G_TYPE_INT,
185                              G_TYPE_INT,
186                              G_TYPE_INT);
187
188         signals[SIGNAL_ERROR] =
189                 g_signal_new("error",
190                              G_OBJECT_CLASS_TYPE(gobject_class),
191                              G_SIGNAL_RUN_LAST,
192                              G_STRUCT_OFFSET(ImageLoaderClass, error),
193                              nullptr, nullptr,
194                              g_cclosure_marshal_VOID__VOID,
195                              G_TYPE_NONE, 0);
196
197         signals[SIGNAL_DONE] =
198                 g_signal_new("done",
199                              G_OBJECT_CLASS_TYPE(gobject_class),
200                              G_SIGNAL_RUN_LAST,
201                              G_STRUCT_OFFSET(ImageLoaderClass, done),
202                              nullptr, nullptr,
203                              g_cclosure_marshal_VOID__VOID,
204                              G_TYPE_NONE, 0);
205
206         signals[SIGNAL_PERCENT] =
207                 g_signal_new("percent",
208                              G_OBJECT_CLASS_TYPE(gobject_class),
209                              G_SIGNAL_RUN_LAST,
210                              G_STRUCT_OFFSET(ImageLoaderClass, percent),
211                              nullptr, nullptr,
212                              g_cclosure_marshal_VOID__DOUBLE,
213                              G_TYPE_NONE, 1,
214                              G_TYPE_DOUBLE);
215
216         signals[SIGNAL_SIZE] =
217                 g_signal_new("size_prepared",
218                              G_OBJECT_CLASS_TYPE(gobject_class),
219                              G_SIGNAL_RUN_LAST,
220                              G_STRUCT_OFFSET(ImageLoaderClass, area_ready),
221                              nullptr, nullptr,
222                              gq_marshal_VOID__INT_INT,
223                              G_TYPE_NONE, 2,
224                              G_TYPE_INT,
225                              G_TYPE_INT);
226
227 }
228
229 static void image_loader_finalize(GObject *object)
230 {
231         auto il = reinterpret_cast<ImageLoader *>(object);
232
233         image_loader_stop(il);
234
235         if (il->error) DEBUG_1("%s", image_loader_get_error(il));
236
237         DEBUG_1("freeing image loader %p bytes_read=%" G_GSIZE_FORMAT, (void *)il, il->bytes_read);
238
239         if (il->idle_done_id)
240                 {
241                 g_source_remove(il->idle_done_id);
242                 il->idle_done_id = 0;
243                 }
244
245         while (g_source_remove_by_user_data(il))
246                 {
247                 DEBUG_2("pending signals detected");
248                 }
249
250         while (il->area_param_list)
251                 {
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);
256                 }
257
258         while (il->area_param_delayed_list)
259                 {
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);
262                 }
263
264         if (il->pixbuf) g_object_unref(il->pixbuf);
265
266         if (il->error) g_error_free(il->error);
267
268         file_data_unref(il->fd);
269
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);
274 }
275
276 void image_loader_free(ImageLoader *il)
277 {
278         if (!il) return;
279         g_object_unref(G_OBJECT(il));
280 }
281
282
283 ImageLoader *image_loader_new(FileData *fd)
284 {
285         ImageLoader *il;
286
287         if (!fd) return nullptr;
288
289         il = static_cast<ImageLoader *>(g_object_new(TYPE_IMAGE_LOADER, nullptr));
290
291         il->fd = file_data_ref(fd);
292
293         return il;
294 }
295
296 /**************************************************************************************/
297 /* send signals via idle calbacks - the callback are executed in the main thread */
298
299 struct ImageLoaderAreaParam {
300         ImageLoader *il;
301         guint x;
302         guint y;
303         guint w;
304         guint h;
305 };
306
307
308 static gboolean image_loader_emit_area_ready_cb(gpointer data)
309 {
310         auto par = static_cast<ImageLoaderAreaParam *>(data);
311         ImageLoader *il = par->il;
312         guint x;
313         guint y;
314         guint w;
315         guint h;
316         g_mutex_lock(il->data_mutex);
317         il->area_param_list = g_list_remove(il->area_param_list, par);
318         x = par->x;
319         y = par->y;
320         w = par->w;
321         h = par->h;
322         g_free(par);
323         g_mutex_unlock(il->data_mutex);
324
325         g_signal_emit(il, signals[SIGNAL_AREA_READY], 0, x, y, w, h);
326
327         return G_SOURCE_REMOVE;
328 }
329
330 static gboolean image_loader_emit_done_cb(gpointer data)
331 {
332         auto il = static_cast<ImageLoader *>(data);
333         g_signal_emit(il, signals[SIGNAL_DONE], 0);
334         return G_SOURCE_REMOVE;
335 }
336
337 static gboolean image_loader_emit_error_cb(gpointer data)
338 {
339         auto il = static_cast<ImageLoader *>(data);
340         g_signal_emit(il, signals[SIGNAL_ERROR], 0);
341         return G_SOURCE_REMOVE;
342 }
343
344 static gboolean image_loader_emit_percent_cb(gpointer data)
345 {
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;
349 }
350
351 static gboolean image_loader_emit_size_cb(gpointer data)
352 {
353         gint width;
354         gint height;
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;
362 }
363
364
365 /* DONE and ERROR are emitted only once, thus they can have normal priority
366    PERCENT and AREA_READY should be processed ASAP
367 */
368
369 static void image_loader_emit_done(ImageLoader *il)
370 {
371         g_idle_add_full(il->idle_priority, image_loader_emit_done_cb, il, nullptr);
372 }
373
374 static void image_loader_emit_error(ImageLoader *il)
375 {
376         g_idle_add_full(il->idle_priority, image_loader_emit_error_cb, il, nullptr);
377 }
378
379 static void image_loader_emit_percent(ImageLoader *il)
380 {
381         g_idle_add_full(G_PRIORITY_HIGH, image_loader_emit_percent_cb, il, nullptr);
382 }
383
384 static void image_loader_emit_size(ImageLoader *il)
385 {
386         g_idle_add_full(G_PRIORITY_HIGH, image_loader_emit_size_cb, il, nullptr);
387 }
388
389 static ImageLoaderAreaParam *image_loader_queue_area_ready(ImageLoader *il, GList **list, guint x, guint y, guint w, guint h)
390 {
391         if (*list)
392                 {
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)
396                         {
397                         /* we can merge the notifications */
398                         prev_par->h += h;
399                         return nullptr;
400                         }
401                 if (prev_par->x == x && prev_par->w == w &&
402                     y + h == prev_par->y)
403                         {
404                         /* we can merge the notifications */
405                         prev_par->h += h;
406                         prev_par->y = y;
407                         return nullptr;
408                         }
409                 if (prev_par->y == y && prev_par->h == h &&
410                     prev_par->x + prev_par->w == x)
411                         {
412                         /* we can merge the notifications */
413                         prev_par->w += w;
414                         return nullptr;
415                         }
416                 if (prev_par->y == y && prev_par->h == h &&
417                     x + w == prev_par->x)
418                         {
419                         /* we can merge the notifications */
420                         prev_par->w += w;
421                         prev_par->x = x;
422                         return nullptr;
423                         }
424                 }
425
426         auto par = g_new0(ImageLoaderAreaParam, 1);
427         par->il = il;
428         par->x = x;
429         par->y = y;
430         par->w = w;
431         par->h = h;
432
433         *list = g_list_prepend(*list, par);
434         return par;
435 }
436
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)
439 {
440         ImageLoaderAreaParam *par = image_loader_queue_area_ready(il, &il->area_param_list, x, y, w, h);
441
442         if (par)
443                 {
444                 g_idle_add_full(G_PRIORITY_HIGH, image_loader_emit_area_ready_cb, par, nullptr);
445                 }
446 }
447
448 /**************************************************************************************/
449 /* the following functions may be executed in separate thread */
450
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)
453 {
454         image_loader_queue_area_ready(il, &il->area_param_delayed_list, x, y, w, h);
455 }
456
457
458
459 static gboolean image_loader_get_stopping(ImageLoader *il)
460 {
461         gboolean ret;
462         if (!il) return FALSE;
463
464         g_mutex_lock(il->data_mutex);
465         ret = il->stopping;
466         g_mutex_unlock(il->data_mutex);
467
468         return ret;
469 }
470
471
472 static void image_loader_sync_pixbuf(ImageLoader *il)
473 {
474         GdkPixbuf *pb;
475
476         g_mutex_lock(il->data_mutex);
477
478         if (!il->backend)
479                 {
480                 g_mutex_unlock(il->data_mutex);
481                 return;
482                 }
483
484         pb = il->backend->get_pixbuf();
485
486         if (pb == il->pixbuf)
487                 {
488                 g_mutex_unlock(il->data_mutex);
489                 return;
490                 }
491
492         if (g_ascii_strcasecmp(".jps", il->fd->extension) == 0)
493                 {
494                 g_object_set_data(G_OBJECT(pb), "stereo_data", GINT_TO_POINTER(STEREO_PIXBUF_CROSS));
495                 }
496
497         if (il->pixbuf) g_object_unref(il->pixbuf);
498
499         il->pixbuf = pb;
500         if (il->pixbuf) g_object_ref(il->pixbuf);
501
502         g_mutex_unlock(il->data_mutex);
503 }
504
505 static void image_loader_area_updated_cb(gpointer,
506                                  guint x, guint y, guint w, guint h,
507                                  gpointer data)
508 {
509         auto il = static_cast<ImageLoader *>(data);
510
511         if (!image_loader_get_pixbuf(il))
512                 {
513                 image_loader_sync_pixbuf(il);
514                 if (!image_loader_get_pixbuf(il))
515                         {
516                         log_printf("critical: area_ready signal with NULL pixbuf (out of mem?)\n");
517                         }
518                 }
519
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);
523         else
524                 image_loader_emit_area_ready(il, x, y, w, h);
525
526         if (il->stopping) il->backend->abort();
527
528         g_mutex_unlock(il->data_mutex);
529 }
530
531 static void image_loader_area_prepared_cb(gpointer, gpointer data)
532 {
533         auto il = static_cast<ImageLoader *>(data);
534         GdkPixbuf *pb;
535         guchar *pix;
536         size_t h;
537         size_t rs;
538
539         /* a workaround for
540            https://bugzilla.gnome.org/show_bug.cgi?id=547669
541            https://bugzilla.gnome.org/show_bug.cgi?id=589334
542         */
543         gchar *format = il->backend->get_format_name();
544         if (strcmp(format, "svg") == 0 ||
545             strcmp(format, "xpm") == 0)
546                 {
547                 g_free(format);
548                 return;
549                 }
550
551         g_free(format);
552
553         pb = il->backend->get_pixbuf();
554
555         h = gdk_pixbuf_get_height(pb);
556         rs = gdk_pixbuf_get_rowstride(pb);
557         pix = gdk_pixbuf_get_pixels(pb);
558
559         memset(pix, 0, rs * h); /*this should be faster than pixbuf_fill */
560
561 }
562
563 static void image_loader_size_cb(gpointer,
564                                  gint width, gint height, gpointer data)
565 {
566         auto il = static_cast<ImageLoader *>(data);
567         gchar **mime_types;
568         gboolean scale = FALSE;
569         gint n;
570
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)
575                 {
576                 g_mutex_unlock(il->data_mutex);
577                 image_loader_emit_size(il);
578                 return;
579                 }
580         g_mutex_unlock(il->data_mutex);
581
582 #if HAVE_FFMPEGTHUMBNAILER
583         if (il->fd->format_class == FORMAT_CLASS_VIDEO)
584                 scale = TRUE;
585 #endif
586         mime_types = il->backend->get_format_mime_types();
587         n = 0;
588         while (mime_types[n] && !scale)
589                 {
590                 if (strstr(mime_types[n], "jpeg")) scale = TRUE;
591                 n++;
592                 }
593         g_strfreev(mime_types);
594
595         if (!scale)
596                 {
597                 image_loader_emit_size(il);
598                 return;
599                 }
600
601         g_mutex_lock(il->data_mutex);
602
603         gint nw;
604         gint nh;
605         if (width > il->requested_width || height > il->requested_height)
606                 {
607
608                 if ((static_cast<gdouble>(il->requested_width) / width) < (static_cast<gdouble>(il->requested_height) / height))
609                         {
610                         nw = il->requested_width;
611                         nh = static_cast<gdouble>(nw) / width * height;
612                         if (nh < 1) nh = 1;
613                         }
614                 else
615                         {
616                         nh = il->requested_height;
617                         nw = static_cast<gdouble>(nh) / height * width;
618                         if (nw < 1) nw = 1;
619                         }
620
621                 il->actual_width = nw;
622                 il->actual_height = nh;
623                 il->backend->set_size(nw, nh);
624                 il->shrunk = TRUE;
625                 }
626
627         g_mutex_unlock(il->data_mutex);
628         image_loader_emit_size(il);
629 }
630
631 static void image_loader_stop_loader(ImageLoader *il)
632 {
633         if (!il) return;
634
635         if (il->backend)
636                 {
637                 /* some loaders do not have a pixbuf till close, order is important here */
638                 il->backend->close(il->error ? nullptr : &il->error); /* we are interested in the first error only */
639                 image_loader_sync_pixbuf(il);
640                 il->backend.reset(nullptr);
641                 }
642         g_mutex_lock(il->data_mutex);
643         il->done = TRUE;
644         g_mutex_unlock(il->data_mutex);
645 }
646
647 static void image_loader_setup_loader(ImageLoader *il)
648 {
649         gint external_preview = 1;
650
651         g_mutex_lock(il->data_mutex);
652
653         if (options->external_preview.enable)
654                 {
655                 gchar *cmd_line;
656                 gchar *tilde_filename;
657
658                 tilde_filename = expand_tilde(options->external_preview.select);
659
660                 cmd_line = g_strdup_printf("\"%s\" \"%s\"" , tilde_filename, il->fd->path);
661
662                 external_preview = runcmd(cmd_line);
663                 g_free(cmd_line);
664                 g_free(tilde_filename);
665                 }
666
667         if (external_preview == 0)
668                 {
669                 DEBUG_1("Using custom external loader");
670                 il->backend = get_image_loader_backend_external();
671                 }
672         else
673                 {
674 #if HAVE_FFMPEGTHUMBNAILER
675                 if (il->fd->format_class == FORMAT_CLASS_VIDEO)
676                         {
677                         DEBUG_1("Using custom ffmpegthumbnailer loader");
678                         il->backend = get_image_loader_backend_ft();
679                         }
680                 else
681 #endif
682 #if HAVE_PDF
683                 if (il->bytes_total >= 4 &&
684                     (memcmp(il->mapped_file + 0, "%PDF", 4) == 0))
685                         {
686                         DEBUG_1("Using custom pdf loader");
687                         il->backend = get_image_loader_backend_pdf();
688                         }
689                 else
690 #endif
691 #if HAVE_HEIF
692                 if (il->bytes_total >= 12 &&
693                     ((memcmp(il->mapped_file + 4, "ftypheic", 8) == 0) ||
694                      (memcmp(il->mapped_file + 4, "ftypheix", 8) == 0) ||
695                      (memcmp(il->mapped_file + 4, "ftypmsf1", 8) == 0) ||
696                      (memcmp(il->mapped_file + 4, "ftypmif1", 8) == 0) ||
697                      (memcmp(il->mapped_file + 4, "ftypavif", 8) == 0)))
698                         {
699                         DEBUG_1("Using custom heif loader");
700                         il->backend = get_image_loader_backend_heif();
701                         }
702                 else
703         #endif
704         #if HAVE_WEBP
705                 if (il->bytes_total >= 12 &&
706                         (memcmp(il->mapped_file, "RIFF", 4) == 0) &&
707                         (memcmp(il->mapped_file + 8, "WEBP", 4) == 0))
708                         {
709                         DEBUG_1("Using custom webp loader");
710                         il->backend = get_image_loader_backend_webp();
711                         }
712                 else
713 #endif
714 #if HAVE_DJVU
715                 if (il->bytes_total >= 16 &&
716                         (memcmp(il->mapped_file, "AT&TFORM", 8) == 0) &&
717                         (memcmp(il->mapped_file + 12, "DJV", 3) == 0))
718                         {
719                         DEBUG_1("Using custom djvu loader");
720                         il->backend = get_image_loader_backend_djvu();
721                         }
722                 else
723 #endif
724 #if HAVE_JPEG
725                 if (il->bytes_total >= 2 && il->mapped_file[0] == 0xff && il->mapped_file[1] == 0xd8)
726                         {
727                         DEBUG_1("Using custom jpeg loader");
728                         il->backend = get_image_loader_backend_jpeg();
729                         }
730 #if !HAVE_RAW
731                 else
732                 if (il->bytes_total >= 11 &&
733                     (memcmp(il->mapped_file + 4, "ftypcrx", 7) == 0) &&
734                     (memcmp(il->mapped_file + 64, "CanonCR3", 8) == 0))
735                         {
736                         DEBUG_1("Using custom cr3 loader");
737                         il->backend = get_image_loader_backend_cr3();
738                         }
739 #endif
740                 else
741 #endif
742 #if HAVE_TIFF
743                 if (il->bytes_total >= 10 &&
744                     (memcmp(il->mapped_file, "MM\0*", 4) == 0 ||
745                      memcmp(il->mapped_file, "MM\0+\0\x08\0\0", 8) == 0 ||
746                      memcmp(il->mapped_file, "II+\0\x08\0\0\0", 8) == 0 ||
747                      memcmp(il->mapped_file, "II*\0", 4) == 0))
748                         {
749                         DEBUG_1("Using custom tiff loader");
750                         il->backend = get_image_loader_backend_tiff();
751                         }
752                 else
753 #endif
754                 if (il->bytes_total >= 3 && il->mapped_file[0] == 0x44 && il->mapped_file[1] == 0x44 && il->mapped_file[2] == 0x53)
755                         {
756                         DEBUG_1("Using dds loader");
757                         il->backend = get_image_loader_backend_dds();
758                         }
759                 else
760                 if (il->bytes_total >= 6 &&
761                         (memcmp(il->mapped_file, "8BPS\0\x01", 6) == 0))
762                         {
763                         DEBUG_1("Using custom psd loader");
764                         il->backend = get_image_loader_backend_psd();
765                         }
766                 else
767 #if HAVE_J2K
768                 if (il->bytes_total >= 12 &&
769                         (memcmp(il->mapped_file, "\0\0\0\x0CjP\x20\x20\x0D\x0A\x87\x0A", 12) == 0))
770                         {
771                         DEBUG_1("Using custom j2k loader");
772                         il->backend = get_image_loader_backend_j2k();
773                         }
774                 else
775 #endif
776 #if HAVE_JPEGXL
777                 if ((il->bytes_total >= 12 &&
778                      (memcmp(il->mapped_file, "\0\0\0\x0C\x4A\x58\x4C\x20\x0D\x0A\x87\x0A", 12) == 0)) ||
779                     (il->bytes_total >= 2 &&
780                      (memcmp(il->mapped_file, "\xFF\x0A", 2) == 0)))
781                         {
782                         DEBUG_1("Using custom jpeg xl loader");
783                         il->backend = get_image_loader_backend_jpegxl();
784                         }
785                 else
786 #endif
787                 if ((il->bytes_total == 6144 || il->bytes_total == 6912) &&
788                         (file_extension_match(il->fd->path, ".scr")))
789                         {
790                         DEBUG_1("Using custom zxscr loader");
791                         il->backend = get_image_loader_backend_zxscr();
792                         }
793                 else
794                 if (il->fd->format_class == FORMAT_CLASS_COLLECTION)
795                         {
796                         DEBUG_1("Using custom collection loader");
797                         il->backend = get_image_loader_backend_collection();
798                         }
799                 else
800                 if (g_strcmp0(strrchr(il->fd->path, '.'), ".svgz") == 0)
801                         {
802                         DEBUG_1("Using custom svgz loader");
803                         il->backend = get_image_loader_backend_svgz();
804                         }
805                 else
806                         il->backend = get_image_loader_backend_default();
807                 }
808
809         il->backend->init(image_loader_area_updated_cb, image_loader_size_cb, image_loader_area_prepared_cb, il);
810         il->backend->set_page_num(il->fd->page_num);
811
812         il->fd->format_name = il->backend->get_format_name();
813
814         g_mutex_unlock(il->data_mutex);
815 }
816
817
818 static void image_loader_done(ImageLoader *il)
819 {
820         image_loader_stop_loader(il);
821
822         image_loader_emit_done(il);
823 }
824
825 static void image_loader_error(ImageLoader *il)
826 {
827         image_loader_stop_loader(il);
828
829         DEBUG_1("pixbuf_loader reported load error for: %s", il->fd->path);
830
831         image_loader_emit_error(il);
832 }
833
834 static gboolean image_loader_continue(ImageLoader *il)
835 {
836         gint c;
837
838         if (!il) return G_SOURCE_REMOVE;
839
840         c = il->idle_read_loop_count ? il->idle_read_loop_count : 1;
841         while (c > 0 && !image_loader_get_stopping(il))
842                 {
843                 if (il->bytes_total == il->bytes_read)
844                         {
845                         image_loader_done(il);
846                         return G_SOURCE_REMOVE;
847                         }
848
849                 if (il->bytes_total < il->bytes_read)
850                         {
851                         image_loader_error(il);
852                         return G_SOURCE_REMOVE;
853                         }
854
855                 gsize b = MIN(il->read_buffer_size, il->bytes_total - il->bytes_read);
856
857                 if (!il->backend->write(il->mapped_file + il->bytes_read, b, il->bytes_total, &il->error))
858                         {
859                         image_loader_error(il);
860                         return G_SOURCE_REMOVE;
861                         }
862
863                 il->bytes_read += b;
864
865                 c--;
866                 }
867
868         if (il->bytes_total > 0)
869                 {
870                 image_loader_emit_percent(il);
871                 }
872
873         return G_SOURCE_CONTINUE;
874 }
875
876 static gboolean image_loader_begin(ImageLoader *il)
877 {
878         if (il->pixbuf) return FALSE;
879
880         if (il->bytes_total <= il->bytes_read) return FALSE;
881
882         gsize b = MIN(il->read_buffer_size, il->bytes_total - il->bytes_read);
883
884         image_loader_setup_loader(il);
885
886         g_assert(il->bytes_read == 0);
887         if (!il->backend->write(il->mapped_file, b, il->bytes_total, &il->error))
888                 {
889                 image_loader_stop_loader(il);
890                 return FALSE;
891                 }
892
893         file_data_set_page_total(il->fd, il->backend->get_page_total());
894
895         il->bytes_read += b;
896
897         /* read until size is known */
898         while (il->backend && !il->backend->get_pixbuf() && b > 0 && !image_loader_get_stopping(il))
899                 {
900                 if (il->bytes_total < il->bytes_read)
901                         {
902                         image_loader_stop_loader(il);
903                         return FALSE;
904                         }
905
906                 b = MIN(il->read_buffer_size, il->bytes_total - il->bytes_read);
907                 if (b > 0 && !il->backend->write(il->mapped_file + il->bytes_read, b, il->bytes_total, &il->error))
908                         {
909                         image_loader_stop_loader(il);
910                         return FALSE;
911                         }
912                 il->bytes_read += b;
913                 }
914         if (!il->pixbuf) image_loader_sync_pixbuf(il);
915
916         if (il->bytes_read == il->bytes_total || b < 1)
917                 {
918                 /* done, handle (broken) loaders that do not have pixbuf till close */
919                 image_loader_stop_loader(il);
920
921                 if (!il->pixbuf) return FALSE;
922
923                 image_loader_done(il);
924                 return TRUE;
925                 }
926
927         if (!il->pixbuf)
928                 {
929                 image_loader_stop_loader(il);
930                 return FALSE;
931                 }
932
933         return TRUE;
934 }
935
936 /**************************************************************************************/
937 /* the following functions are always executed in the main thread */
938
939
940 static gboolean image_loader_setup_source(ImageLoader *il)
941 {
942         struct stat st;
943         gchar *pathl;
944
945         if (!il || il->backend || il->mapped_file) return FALSE;
946
947         il->mapped_file = nullptr;
948
949         if (il->fd)
950                 {
951                 ExifData *exif = exif_read_fd(il->fd);
952
953                 if (options->thumbnails.use_exif)
954                         {
955                         il->mapped_file = exif_get_preview(exif, reinterpret_cast<guint *>(&il->bytes_total), il->requested_width, il->requested_height);
956
957                         if (il->mapped_file)
958                                 {
959                                 il->preview = IMAGE_LOADER_PREVIEW_EXIF;
960                                 }
961                         }
962                 else
963                         {
964                         il->mapped_file = libraw_get_preview(il, reinterpret_cast<guint *>(&il->bytes_total));
965
966                         if (il->mapped_file)
967                                 {
968                                 /* Both exiv2 and libraw sometimes return a pointer to a file
969                                  * section that is not a jpeg */
970                                 if (il->mapped_file[0] != 0xFF || il->mapped_file[1] != 0xD8)
971                                         {
972                                         il->mapped_file = nullptr;
973                                         }
974                                 else
975                                         {
976                                         il->preview = IMAGE_LOADER_PREVIEW_LIBRAW;
977                                         }
978                                 }
979                         }
980
981                 /* If libraw does not find a thumbnail, try exiv2 */
982                 if (!il->mapped_file)
983                         {
984                         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*/
985
986                         if (il->mapped_file)
987                                 {
988                                 /* Both exiv2 and libraw sometimes return a pointer to a file
989                                  * section that is not a jpeg */
990                                 if (il->mapped_file[0] != 0xFF || il->mapped_file[1] != 0xD8)
991                                         {
992                                         il->mapped_file = nullptr;
993                                         }
994                                 else
995                                         {
996                                         il->preview = IMAGE_LOADER_PREVIEW_EXIF;
997                                         }
998                                 }
999                         }
1000
1001                 if (il->mapped_file)
1002                         {
1003                         DEBUG_1("Usable reduced size (preview) image loaded from file %s", il->fd->path);
1004                         }
1005                 exif_free_fd(il->fd, exif);
1006                 }
1007
1008
1009         if (!il->mapped_file)
1010                 {
1011                 /* normal file */
1012                 gint load_fd;
1013
1014                 pathl = path_from_utf8(il->fd->path);
1015                 load_fd = open(pathl, O_RDONLY | O_NONBLOCK);
1016                 g_free(pathl);
1017                 if (load_fd == -1) return FALSE;
1018
1019                 if (fstat(load_fd, &st) == 0)
1020                         {
1021                         il->bytes_total = st.st_size;
1022                         }
1023                 else
1024                         {
1025                         close(load_fd);
1026                         return FALSE;
1027                         }
1028
1029                 il->mapped_file = static_cast<guchar *>(mmap(nullptr, il->bytes_total, PROT_READ|PROT_WRITE, MAP_PRIVATE, load_fd, 0));
1030                 close(load_fd);
1031                 if (il->mapped_file == MAP_FAILED)
1032                         {
1033                         il->mapped_file = nullptr;
1034                         return FALSE;
1035                         }
1036                 il->preview = IMAGE_LOADER_PREVIEW_NONE;
1037                 }
1038
1039         return TRUE;
1040 }
1041
1042 static void image_loader_stop_source(ImageLoader *il)
1043 {
1044         if (!il) return;
1045
1046         if (il->mapped_file)
1047                 {
1048                 if (il->preview == IMAGE_LOADER_PREVIEW_EXIF)
1049                         {
1050                         exif_free_preview(il->mapped_file);
1051                         }
1052                 else if (il->preview == IMAGE_LOADER_PREVIEW_LIBRAW)
1053                         {
1054                         libraw_free_preview(il->mapped_file);
1055                         }
1056                 else
1057                         {
1058                         munmap(il->mapped_file, il->bytes_total);
1059                         }
1060                 il->mapped_file = nullptr;
1061                 }
1062 }
1063
1064 static void image_loader_stop(ImageLoader *il)
1065 {
1066         if (!il) return;
1067
1068         if (il->idle_id)
1069                 {
1070                 g_source_remove(il->idle_id);
1071                 il->idle_id = 0;
1072                 }
1073
1074         if (il->thread)
1075                 {
1076                 /* stop loader in the other thread */
1077                 g_mutex_lock(il->data_mutex);
1078                 il->stopping = TRUE;
1079                 while (!il->can_destroy) g_cond_wait(il->can_destroy_cond, il->data_mutex);
1080                 g_mutex_unlock(il->data_mutex);
1081                 }
1082
1083         image_loader_stop_loader(il);
1084         image_loader_stop_source(il);
1085
1086 }
1087
1088 void image_loader_delay_area_ready(ImageLoader *il, gboolean enable)
1089 {
1090         g_mutex_lock(il->data_mutex);
1091         il->delay_area_ready = enable;
1092         if (!enable)
1093                 {
1094                 /* send delayed */
1095                 GList *list;
1096                 GList *work;
1097                 list = g_list_reverse(il->area_param_delayed_list);
1098                 il->area_param_delayed_list = nullptr;
1099                 g_mutex_unlock(il->data_mutex);
1100
1101                 work = list;
1102
1103                 while (work)
1104                         {
1105                         auto par = static_cast<ImageLoaderAreaParam *>(work->data);
1106                         work = work->next;
1107
1108                         g_signal_emit(il, signals[SIGNAL_AREA_READY], 0, par->x, par->y, par->w, par->h);
1109                         }
1110                 g_list_free_full(list, g_free);
1111                 }
1112         else
1113                 {
1114                 /* just unlock */
1115                 g_mutex_unlock(il->data_mutex);
1116                 }
1117 }
1118
1119
1120 /**************************************************************************************/
1121 /* execution via idle calls */
1122
1123 static gboolean image_loader_idle_cb(gpointer data)
1124 {
1125         gboolean ret = G_SOURCE_REMOVE;
1126         auto il = static_cast<ImageLoader *>(data);
1127
1128         if (il->idle_id)
1129                 {
1130                 ret = image_loader_continue(il);
1131                 }
1132
1133         if (!ret)
1134                 {
1135                 image_loader_stop_source(il);
1136                 }
1137
1138         return ret;
1139 }
1140
1141 static gboolean image_loader_start_idle(ImageLoader *il)
1142 {
1143         gboolean ret;
1144
1145         if (!il) return FALSE;
1146
1147         if (!il->fd) return FALSE;
1148
1149         if (!image_loader_setup_source(il)) return FALSE;
1150
1151         ret = image_loader_begin(il);
1152
1153         if (ret && !il->done) il->idle_id = g_idle_add_full(il->idle_priority, image_loader_idle_cb, il, nullptr);
1154         return ret;
1155 }
1156
1157 /**************************************************************************************/
1158 /* execution via thread */
1159
1160 static GThreadPool *image_loader_thread_pool = nullptr;
1161
1162 static GCond *image_loader_prio_cond = nullptr;
1163 static GMutex *image_loader_prio_mutex = nullptr;
1164 static gint image_loader_prio_num = 0;
1165
1166
1167 static void image_loader_thread_enter_high()
1168 {
1169         g_mutex_lock(image_loader_prio_mutex);
1170         image_loader_prio_num++;
1171         g_mutex_unlock(image_loader_prio_mutex);
1172 }
1173
1174 static void image_loader_thread_leave_high()
1175 {
1176         g_mutex_lock(image_loader_prio_mutex);
1177         image_loader_prio_num--;
1178         if (image_loader_prio_num == 0) g_cond_broadcast(image_loader_prio_cond); /* wake up all low prio threads */
1179         g_mutex_unlock(image_loader_prio_mutex);
1180 }
1181
1182 static void image_loader_thread_wait_high()
1183 {
1184         g_mutex_lock(image_loader_prio_mutex);
1185         while (image_loader_prio_num)
1186                 {
1187                 g_cond_wait(image_loader_prio_cond, image_loader_prio_mutex);
1188                 }
1189
1190         g_mutex_unlock(image_loader_prio_mutex);
1191 }
1192
1193
1194 static void image_loader_thread_run(gpointer data, gpointer)
1195 {
1196         auto il = static_cast<ImageLoader *>(data);
1197         gboolean cont;
1198         gboolean err;
1199
1200         if (il->idle_priority > G_PRIORITY_DEFAULT_IDLE)
1201                 {
1202                 /* low prio, wait until high prio tasks finishes */
1203                 image_loader_thread_wait_high();
1204                 }
1205         else
1206                 {
1207                 /* high prio */
1208                 image_loader_thread_enter_high();
1209                 }
1210
1211         err = !image_loader_begin(il);
1212
1213         if (err)
1214                 {
1215                 /*
1216                 loader failed, we have to send signal
1217                 (idle mode returns the image_loader_begin return value directly)
1218                 (success is always reported indirectly from image_loader_begin)
1219                 */
1220                 image_loader_emit_error(il);
1221                 }
1222
1223         cont = !err;
1224
1225         while (cont && !image_loader_get_is_done(il) && !image_loader_get_stopping(il))
1226                 {
1227                 if (il->idle_priority > G_PRIORITY_DEFAULT_IDLE)
1228                         {
1229                         /* low prio, wait until high prio tasks finishes */
1230                         image_loader_thread_wait_high();
1231                         }
1232                 cont = image_loader_continue(il);
1233                 }
1234         image_loader_stop_loader(il);
1235
1236         if (il->idle_priority <= G_PRIORITY_DEFAULT_IDLE)
1237                 {
1238                 /* high prio */
1239                 image_loader_thread_leave_high();
1240                 }
1241
1242         g_mutex_lock(il->data_mutex);
1243         il->can_destroy = TRUE;
1244         g_cond_signal(il->can_destroy_cond);
1245         g_mutex_unlock(il->data_mutex);
1246
1247 }
1248
1249
1250 static gboolean image_loader_start_thread(ImageLoader *il)
1251 {
1252         if (!il) return FALSE;
1253
1254         if (!il->fd) return FALSE;
1255
1256         il->thread = TRUE;
1257
1258         if (!image_loader_setup_source(il)) return FALSE;
1259
1260         if (!image_loader_thread_pool)
1261                 {
1262                 image_loader_thread_pool = g_thread_pool_new(image_loader_thread_run, nullptr, -1, FALSE, nullptr);
1263                 if (!image_loader_prio_cond) image_loader_prio_cond = g_new(GCond, 1);
1264                 g_cond_init(image_loader_prio_cond);
1265                 if (!image_loader_prio_mutex) image_loader_prio_mutex = g_new(GMutex, 1);
1266                 g_mutex_init(image_loader_prio_mutex);
1267                 }
1268
1269         il->can_destroy = FALSE; /* ImageLoader can't be freed until image_loader_thread_run finishes */
1270
1271         g_thread_pool_push(image_loader_thread_pool, il, nullptr);
1272         DEBUG_1("Thread pool num threads: %d", g_thread_pool_get_num_threads(image_loader_thread_pool));
1273
1274         return TRUE;
1275 }
1276
1277
1278 /**************************************************************************************/
1279 /* public interface */
1280
1281
1282 gboolean image_loader_start(ImageLoader *il)
1283 {
1284         if (!il) return FALSE;
1285
1286         if (!il->fd) return FALSE;
1287
1288         return image_loader_start_thread(il);
1289 }
1290
1291
1292 /* don't forget to gdk_pixbuf_ref() it if you want to use it after image_loader_free() */
1293 GdkPixbuf *image_loader_get_pixbuf(ImageLoader *il)
1294 {
1295         GdkPixbuf *ret;
1296         if (!il) return nullptr;
1297
1298         g_mutex_lock(il->data_mutex);
1299         ret = il->pixbuf;
1300         g_mutex_unlock(il->data_mutex);
1301         return ret;
1302 }
1303
1304 void image_loader_set_requested_size(ImageLoader *il, gint width, gint height)
1305 {
1306         if (!il) return;
1307
1308         g_mutex_lock(il->data_mutex);
1309         il->requested_width = width;
1310         il->requested_height = height;
1311         g_mutex_unlock(il->data_mutex);
1312 }
1313
1314 void image_loader_set_buffer_size(ImageLoader *il, guint count)
1315 {
1316         if (!il) return;
1317
1318         g_mutex_lock(il->data_mutex);
1319         il->idle_read_loop_count = count ? count : 1;
1320         g_mutex_unlock(il->data_mutex);
1321 }
1322
1323 void image_loader_set_priority(ImageLoader *il, gint priority)
1324 {
1325         if (!il) return;
1326
1327         if (il->thread) return; /* can't change prio if the thread already runs */
1328         il->idle_priority = priority;
1329 }
1330
1331
1332 gdouble image_loader_get_percent(ImageLoader *il)
1333 {
1334         gdouble ret;
1335         if (!il) return 0.0;
1336
1337         g_mutex_lock(il->data_mutex);
1338         if (il->bytes_total == 0)
1339                 {
1340                 ret = 0.0;
1341                 }
1342         else
1343                 {
1344                 ret = static_cast<gdouble>(il->bytes_read) / il->bytes_total;
1345                 }
1346         g_mutex_unlock(il->data_mutex);
1347         return ret;
1348 }
1349
1350 gboolean image_loader_get_is_done(ImageLoader *il)
1351 {
1352         gboolean ret;
1353         if (!il) return FALSE;
1354
1355         g_mutex_lock(il->data_mutex);
1356         ret = il->done;
1357         g_mutex_unlock(il->data_mutex);
1358
1359         return ret;
1360 }
1361
1362 FileData *image_loader_get_fd(ImageLoader *il)
1363 {
1364         FileData *ret;
1365         if (!il) return nullptr;
1366
1367         g_mutex_lock(il->data_mutex);
1368         ret = il->fd;
1369         g_mutex_unlock(il->data_mutex);
1370
1371         return ret;
1372 }
1373
1374 gboolean image_loader_get_shrunk(ImageLoader *il)
1375 {
1376         gboolean ret;
1377         if (!il) return FALSE;
1378
1379         g_mutex_lock(il->data_mutex);
1380         ret = il->shrunk;
1381         g_mutex_unlock(il->data_mutex);
1382         return ret;
1383 }
1384
1385 const gchar *image_loader_get_error(ImageLoader *il)
1386 {
1387         const gchar *ret = nullptr;
1388         if (!il) return nullptr;
1389         g_mutex_lock(il->data_mutex);
1390         if (il->error) ret = il->error->message;
1391         g_mutex_unlock(il->data_mutex);
1392         return ret;
1393 }
1394
1395
1396 /**
1397  *  @FIXME this can be rather slow and blocks until the size is known
1398  */
1399 gboolean image_load_dimensions(FileData *fd, gint *width, gint *height)
1400 {
1401         ImageLoader *il;
1402         gboolean success;
1403
1404         il = image_loader_new(fd);
1405
1406         success = image_loader_start_idle(il);
1407
1408         if (success && il->pixbuf)
1409                 {
1410                 if (width) *width = gdk_pixbuf_get_width(il->pixbuf);
1411                 if (height) *height = gdk_pixbuf_get_height(il->pixbuf);;
1412                 }
1413         else
1414                 {
1415                 if (width) *width = -1;
1416                 if (height) *height = -1;
1417                 }
1418
1419         image_loader_free(il);
1420
1421         return success;
1422 }
1423 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */