src/image-load.c

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