Include a Other Software section in Help file
[geeqie.git] / src / image-load.c
index 1af4285..07588cb 100644 (file)
@@ -1,21 +1,43 @@
 /*
- * Geeqie
- * (C) 2004 John Ellis
- * Copyright (C) 2008 - 2012 The Geeqie Team
+ * Copyright (C) 2004 John Ellis
+ * Copyright (C) 2008 - 2016 The Geeqie Team
  *
  * Author: John Ellis
  *
- * This software is released under the GNU General Public License (GNU GPL).
- * Please read the included file COPYING for more information.
- * This software comes with no warranty of any kind, use at your own risk!
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-
 #include "main.h"
 #include "image-load.h"
+#include "image_load_cr3.h"
 #include "image_load_gdk.h"
 #include "image_load_jpeg.h"
 #include "image_load_tiff.h"
+#include "image_load_dds.h"
+#include "image_load_djvu.h"
+#include "image_load_external.h"
+#include "image_load_pdf.h"
+#include "image_load_psd.h"
+#include "image_load_heif.h"
+#include "image_load_ffmpegthumbnailer.h"
+#include "image_load_collection.h"
+#include "image_load_webp.h"
+#include "image_load_j2k.h"
+#include "image_load_libraw.h"
+#include "image_load_svgz.h"
+#include "misc.h"
 
 #include "exif.h"
 #include "filedata.h"
 #define IMAGE_LOADER_READ_BUFFER_SIZE_DEFAULT  4096
 #define IMAGE_LOADER_IDLE_READ_LOOP_COUNT_DEFAULT      1
 
-
+/**
+ * @page diagrams Diagrams
+ * @section image_load_overview Image Load Overview
+ * @startuml
+ * object image_change
+ * object image_change_complete
+ * object image_load_begin
+ * object image_loader_start
+ * object image_loader_start_thread
+ * object image_loader_start_idle
+ * object image_loader_setup_source
+ * object image_loader_thread_run
+ * object image_loader_begin
+ * object image_loader_setuploader
+ * circle "il->memory_mapped"
+ * object exif_get_preview_
+ * object exif_get_preview
+ * object libraw_get_preview
+ * 
+ * image_change : image.c
+ * image_change_complete : image.c
+ * image_load_begin : image.c
+ * image_loader_start : image_load.c
+ * image_loader_start_thread : image_load.c
+ * image_loader_start_idle : image_load.c
+ * image_loader_thread_run : image_load.c
+ * image_loader_begin : image_load.c
+ * image_loader_setuploader : image_load.c
+ * image_loader_setuploader : -
+ * image_loader_setuploader : Select backend using magic
+ * image_loader_setup_source : image_load.c
+ * exif_get_preview : exiv2.cc
+ * exif_get_preview : EXIV2_TEST_VERSION(0,17,90)
+ * exif_get_preview_ : exif.c
+ * exif_get_preview_ : -
+ * exif_get_preview_ : If exiv2 not installed
+ * libraw_get_preview : image_load_libraw.c
+ * 
+ * image_change --> image_change_complete
+ * image_change_complete --> image_load_begin
+ * image_load_begin --> image_loader_start
+ * image_loader_start --> image_loader_start_thread
+ * image_loader_start --> image_loader_start_idle : Obsolete - no threads version
+ * image_loader_start_thread --> image_loader_thread_run
+ * image_loader_start_thread --> image_loader_setup_source
+ * image_loader_setup_source --> exif_get_preview_
+ * image_loader_setup_source --> exif_get_preview
+ * image_loader_setup_source --> libraw_get_preview : Try libraw if exiv2 fails
+ * exif_get_preview_ ..> "il->memory_mapped"
+ * exif_get_preview ..> "il->memory_mapped"
+ * libraw_get_preview ..> "il->memory_mapped"
+ * image_loader_thread_run --> image_loader_begin
+ * image_loader_begin --> image_loader_setuploader
+ * "il->memory_mapped" ..> image_loader_setuploader
+ * note left of "il->memory_mapped" : Points to first byte of embedded jpeg (#FFD8)\n if preview found, otherwise to first byte of file
+ * @enduml
+ */
+ /**
+  * @file
+  * @ref image_load_overview "Image Load Overview"
+  */
+  
 /**************************************************************************************/
 /* image loader class */
 
@@ -45,6 +128,7 @@ enum {
 static guint signals[SIGNAL_COUNT] = { 0 };
 
 static void image_loader_init(GTypeInstance *instance, gpointer g_class);
+static void image_loader_class_init_wrapper(void *data, void *user_data);
 static void image_loader_class_init(ImageLoaderClass *class);
 static void image_loader_finalize(GObject *object);
 static void image_loader_stop(ImageLoader *il);
@@ -58,7 +142,7 @@ GType image_loader_get_type(void)
                        sizeof(ImageLoaderClass),
                        NULL,   /* base_init */
                        NULL,   /* base_finalize */
-                       (GClassInitFunc)image_loader_class_init, /* class_init */
+                       (GClassInitFunc)image_loader_class_init_wrapper, /* class_init */
                        NULL,   /* class_finalize */
                        NULL,   /* class_data */
                        sizeof(ImageLoader),
@@ -89,6 +173,7 @@ static void image_loader_init(GTypeInstance *instance, gpointer g_class)
        il->idle_read_loop_count = IMAGE_LOADER_IDLE_READ_LOOP_COUNT_DEFAULT;
        il->read_buffer_size = IMAGE_LOADER_READ_BUFFER_SIZE_DEFAULT;
        il->mapped_file = NULL;
+       il->preview = IMAGE_LOADER_PREVIEW_NONE;
 
        il->requested_width = 0;
        il->requested_height = 0;
@@ -99,12 +184,24 @@ static void image_loader_init(GTypeInstance *instance, gpointer g_class)
        il->can_destroy = TRUE;
 
 #ifdef HAVE_GTHREAD
+#if GLIB_CHECK_VERSION(2,32,0)
+       il->data_mutex = g_new(GMutex, 1);
+       g_mutex_init(il->data_mutex);
+       il->can_destroy_cond = g_new(GCond, 1);
+       g_cond_init(il->can_destroy_cond);
+#else
        il->data_mutex = g_mutex_new();
        il->can_destroy_cond = g_cond_new();
+#endif
 #endif
        DEBUG_1("new image loader %p, bufsize=%" G_GSIZE_FORMAT " idle_loop=%u", il, il->read_buffer_size, il->idle_read_loop_count);
 }
 
+static void image_loader_class_init_wrapper(void *data, void *user_data)
+{
+       image_loader_class_init(data);
+}
+
 static void image_loader_class_init(ImageLoaderClass *class)
 {
        GObjectClass *gobject_class = G_OBJECT_CLASS (class);
@@ -210,9 +307,16 @@ static void image_loader_finalize(GObject *object)
 
        file_data_unref(il->fd);
 #ifdef HAVE_GTHREAD
+#if GLIB_CHECK_VERSION(2,32,0)
+       g_mutex_clear(il->data_mutex);
+       g_free(il->data_mutex);
+       g_cond_clear(il->can_destroy_cond);
+       g_free(il->can_destroy_cond);
+#else
        g_mutex_free(il->data_mutex);
        g_cond_free(il->can_destroy_cond);
 #endif
+#endif
 }
 
 void image_loader_free(ImageLoader *il)
@@ -301,7 +405,7 @@ static gboolean image_loader_emit_size_cb(gpointer data)
 }
 
 
-/* DONE and ERROR are emited only once, thus they can have normal priority
+/* DONE and ERROR are emitted only once, thus they can have normal priority
    PERCENT and AREA_READY should be processed ASAP
 */
 
@@ -517,9 +621,13 @@ static void image_loader_size_cb(gpointer loader,
                }
        g_mutex_unlock(il->data_mutex);
 
+#ifdef HAVE_FFMPEGTHUMBNAILER
+       if (il->fd->format_class == FORMAT_CLASS_VIDEO)
+               scale = TRUE;
+#endif
        mime_types = il->backend.get_format_mime_types(loader);
        n = 0;
-       while (mime_types[n])
+       while (mime_types[n] && !scale)
                {
                if (strstr(mime_types[n], "jpeg")) scale = TRUE;
                n++;
@@ -580,18 +688,107 @@ static void image_loader_stop_loader(ImageLoader *il)
 
 static void image_loader_setup_loader(ImageLoader *il)
 {
+#if defined HAVE_TIFF || defined HAVE_PDF || defined HAVE_HEIF || defined HAVE_DJVU
+       gchar *format;
+#endif
+
+       gint external_preview = 1;
+
        g_mutex_lock(il->data_mutex);
+
+       if (options->external_preview.enable)
+               {
+               gchar *cmd_line;
+               gchar *tilde_filename;
+
+               tilde_filename = expand_tilde(options->external_preview.select);
+
+               cmd_line = g_strdup_printf("\"%s\" \"%s\"" , tilde_filename, il->fd->path);
+
+               external_preview = runcmd(cmd_line);
+               g_free(cmd_line);
+               g_free(tilde_filename);
+               }
+
+       if (external_preview == 0)
+               {
+               DEBUG_1("Using custom external loader");
+               image_loader_backend_set_external(&il->backend);
+               }
+       else
+
+#ifdef HAVE_FFMPEGTHUMBNAILER
+       if (il->fd->format_class == FORMAT_CLASS_VIDEO)
+               {
+               DEBUG_1("Using custom ffmpegthumbnailer loader");
+               image_loader_backend_set_ft(&il->backend);
+               }
+       else
+#endif
+#ifdef HAVE_PDF
+       if (il->bytes_total >= 4 &&
+           (memcmp(il->mapped_file + 0, "%PDF", 4) == 0))
+               {
+               DEBUG_1("Using custom pdf loader");
+               image_loader_backend_set_pdf(&il->backend);
+               }
+       else
+#endif
+#ifdef HAVE_HEIF
+       if (il->bytes_total >= 12 &&
+               ((memcmp(il->mapped_file + 4, "ftypheic", 8) == 0) ||
+               (memcmp(il->mapped_file + 4, "ftypmsf1", 8) == 0) ||
+               (memcmp(il->mapped_file + 4, "ftypmif1", 8) == 0) ||
+               (memcmp(il->mapped_file + 4, "ftypavif", 8) == 0)))
+               {
+               DEBUG_1("Using custom heif loader");
+               image_loader_backend_set_heif(&il->backend);
+               }
+       else
+#endif
+#ifdef HAVE_WEBP
+       if (il->bytes_total >= 12 &&
+               (memcmp(il->mapped_file, "RIFF", 4) == 0) &&
+               (memcmp(il->mapped_file + 8, "WEBP", 4) == 0))
+               {
+               DEBUG_1("Using custom webp loader");
+               image_loader_backend_set_webp(&il->backend);
+               }
+       else
+#endif
+#ifdef HAVE_DJVU
+       if (il->bytes_total >= 16 &&
+               (memcmp(il->mapped_file, "AT&TFORM", 8) == 0) &&
+               (memcmp(il->mapped_file + 12, "DJV", 3) == 0))
+               {
+               DEBUG_1("Using custom djvu loader");
+               image_loader_backend_set_djvu(&il->backend);
+               }
+       else
+#endif
 #ifdef HAVE_JPEG
        if (il->bytes_total >= 2 && il->mapped_file[0] == 0xff && il->mapped_file[1] == 0xd8)
                {
                DEBUG_1("Using custom jpeg loader");
                image_loader_backend_set_jpeg(&il->backend);
                }
+#ifndef HAVE_RAW
+       else
+       if (il->bytes_total >= 11 &&
+               (memcmp(il->mapped_file + 4, "ftypcrx", 7) == 0) &&
+               (memcmp(il->mapped_file + 64, "CanonCR3", 8) == 0))
+               {
+               DEBUG_1("Using custom cr3 loader");
+               image_loader_backend_set_cr3(&il->backend);
+               }
+#endif
        else
 #endif
 #ifdef HAVE_TIFF
        if (il->bytes_total >= 10 &&
            (memcmp(il->mapped_file, "MM\0*", 4) == 0 ||
+            memcmp(il->mapped_file, "MM\0+\0\x08\0\0", 8) == 0 ||
+            memcmp(il->mapped_file, "II+\0\x08\0\0\0", 8) == 0 ||
             memcmp(il->mapped_file, "II*\0", 4) == 0))
                {
                DEBUG_1("Using custom tiff loader");
@@ -599,9 +796,80 @@ static void image_loader_setup_loader(ImageLoader *il)
                }
        else
 #endif
+       if (il->bytes_total >= 3 && il->mapped_file[0] == 0x44 && il->mapped_file[1] == 0x44 && il->mapped_file[2] == 0x53)
+               {
+               DEBUG_1("Using dds loader");
+               image_loader_backend_set_dds(&il->backend);
+               }
+       else
+       if (il->bytes_total >= 6 &&
+               (memcmp(il->mapped_file, "8BPS\0\x01", 6) == 0))
+               {
+               DEBUG_1("Using custom psd loader");
+               image_loader_backend_set_psd(&il->backend);
+               }
+       else
+#ifdef HAVE_J2K
+       if (il->bytes_total >= 12 &&
+               (memcmp(il->mapped_file, "\0\0\0\x0CjP\x20\x20\x0D\x0A\x87\x0A", 12) == 0))
+               {
+               DEBUG_1("Using custom j2k loader");
+               image_loader_backend_set_j2k(&il->backend);
+               }
+       else
+#endif
+       if (il->fd->format_class == FORMAT_CLASS_COLLECTION)
+               {
+               DEBUG_1("Using custom collection loader");
+               image_loader_backend_set_collection(&il->backend);
+               }
+       else
+       if (g_strcmp0(strrchr(il->fd->path, '.'), ".svgz") == 0)
+               {
+               DEBUG_1("Using custom svgz loader");
+               image_loader_backend_set_svgz(&il->backend);
+               }
+       else
                image_loader_backend_set_default(&il->backend);
 
        il->loader = il->backend.loader_new(image_loader_area_updated_cb, image_loader_size_cb, image_loader_area_prepared_cb, il);
+
+#ifdef HAVE_TIFF
+       format = il->backend.get_format_name(il->loader);
+       if (g_strcmp0(format, "tiff") == 0)
+               {
+               il->backend.set_page_num(il->loader, il->fd->page_num);
+               }
+       g_free(format);
+#endif
+
+#ifdef HAVE_PDF
+       format = il->backend.get_format_name(il->loader);
+       if (g_strcmp0(format, "pdf") == 0)
+               {
+               il->backend.set_page_num(il->loader, il->fd->page_num);
+               }
+       g_free(format);
+#endif
+
+#ifdef HAVE_HEIF
+       format = il->backend.get_format_name(il->loader);
+       if (g_strcmp0(format, "heif") == 0)
+               {
+               il->backend.set_page_num(il->loader, il->fd->page_num);
+               }
+       g_free(format);
+#endif
+
+#ifdef HAVE_DJVU
+       format = il->backend.get_format_name(il->loader);
+       if (g_strcmp0(format, "djvu") == 0)
+               {
+               il->backend.set_page_num(il->loader, il->fd->page_num);
+               }
+       g_free(format);
+#endif
+
        g_mutex_unlock(il->data_mutex);
 }
 
@@ -661,6 +929,9 @@ static gboolean image_loader_continue(ImageLoader *il)
 
 static gboolean image_loader_begin(ImageLoader *il)
 {
+#if defined HAVE_TIFF || defined HAVE_PDF || defined HAVE_HEIF || defined HAVE_DJVU
+       gchar *format;
+#endif
        gssize b;
 
        if (il->pixbuf) return FALSE;
@@ -685,6 +956,43 @@ static gboolean image_loader_begin(ImageLoader *il)
                return FALSE;
                }
 
+#ifdef HAVE_PDF
+       format = il->backend.get_format_name(il->loader);
+       if (g_strcmp0(format, "pdf") == 0)
+               {
+               gint i = il->backend.get_page_total(il->loader);
+               file_data_set_page_total(il->fd, i);
+               }
+       g_free(format);
+#endif
+#ifdef HAVE_HEIF
+       format = il->backend.get_format_name(il->loader);
+       if (g_strcmp0(format, "heif") == 0)
+               {
+               gint i = il->backend.get_page_total(il->loader);
+               file_data_set_page_total(il->fd, i);
+               }
+       g_free(format);
+#endif
+#ifdef HAVE_DJVU
+       format = il->backend.get_format_name(il->loader);
+       if (g_strcmp0(format, "djvu") == 0)
+               {
+               gint i = il->backend.get_page_total(il->loader);
+               file_data_set_page_total(il->fd, i);
+               }
+       g_free(format);
+#endif
+#ifdef HAVE_TIFF
+       format = il->backend.get_format_name(il->loader);
+       if (g_strcmp0(format, "tiff") == 0)
+               {
+               gint i = il->backend.get_page_total(il->loader);
+               file_data_set_page_total(il->fd, i);
+               }
+       g_free(format);
+#endif
+
        il->bytes_read += b;
 
        /* read until size is known */
@@ -738,13 +1046,53 @@ static gboolean image_loader_setup_source(ImageLoader *il)
                ExifData *exif = exif_read_fd(il->fd);
 
                if (options->thumbnails.use_exif)
+                       {
                        il->mapped_file = exif_get_preview(exif, (guint *)&il->bytes_total, il->requested_width, il->requested_height);
+
+                       if (il->mapped_file)
+                               {
+                               il->preview = IMAGE_LOADER_PREVIEW_EXIF;
+                               }
+                       }
                else
+                       {
                        il->mapped_file = exif_get_preview(exif, (guint *)&il->bytes_total, 0, 0); /* get the largest available preview image or NULL for normal images*/
 
+                       if (il->mapped_file)
+                               {
+                               /* Both exiv2 and libraw sometimes return a pointer to a file
+                                * section that is not a jpeg */
+                               if (!(il->mapped_file[0] == 0xFF && il->mapped_file[1] == 0xD8))
+                                       {
+                                       il->mapped_file = NULL;
+                                       }
+                               else
+                                       {
+                                       il->preview = IMAGE_LOADER_PREVIEW_EXIF;
+                                       }
+                               }
+                       }
+
+               /* If exiv2 does not find a thumbnail, try libraw (which may be slower) */
+               if (!il->mapped_file)
+                       {
+                       il->mapped_file = libraw_get_preview(il, (guint *)&il->bytes_total);
+
+                       if (il->mapped_file)
+                               {
+                               if (!(il->mapped_file[0] == 0xFF && il->mapped_file[1] == 0xD8))
+                                       {
+                                       il->mapped_file = NULL;
+                                       }
+                               else
+                                       {
+                                       il->preview = IMAGE_LOADER_PREVIEW_LIBRAW;
+                                       }
+                               }
+                       }
+
                if (il->mapped_file)
                        {
-                       il->preview = TRUE;
                        DEBUG_1("Usable reduced size (preview) image loaded from file %s", il->fd->path);
                        }
                exif_free_fd(il->fd, exif);
@@ -778,7 +1126,7 @@ static gboolean image_loader_setup_source(ImageLoader *il)
                        il->mapped_file = 0;
                        return FALSE;
                        }
-               il->preview = FALSE;
+               il->preview = IMAGE_LOADER_PREVIEW_NONE;
                }
 
        return TRUE;
@@ -790,10 +1138,14 @@ static void image_loader_stop_source(ImageLoader *il)
 
        if (il->mapped_file)
                {
-               if (il->preview)
+               if (il->preview == IMAGE_LOADER_PREVIEW_EXIF)
                        {
                        exif_free_preview(il->mapped_file);
                        }
+               else if (il->preview == IMAGE_LOADER_PREVIEW_LIBRAW)
+                       {
+                       libraw_free_preview(il->mapped_file);
+                       }
                else
                        {
                        munmap(il->mapped_file, il->bytes_total);
@@ -942,7 +1294,7 @@ static void image_loader_thread_run(gpointer data, gpointer user_data)
 
        if (il->idle_priority > G_PRIORITY_DEFAULT_IDLE)
                {
-               /* low prio, wait untill high prio tasks finishes */
+               /* low prio, wait until high prio tasks finishes */
                image_loader_thread_wait_high();
                }
        else
@@ -969,7 +1321,7 @@ static void image_loader_thread_run(gpointer data, gpointer user_data)
                {
                if (il->idle_priority > G_PRIORITY_DEFAULT_IDLE)
                        {
-                       /* low prio, wait untill high prio tasks finishes */
+                       /* low prio, wait until high prio tasks finishes */
                        image_loader_thread_wait_high();
                        }
                cont = image_loader_continue(il);
@@ -1003,8 +1355,15 @@ static gboolean image_loader_start_thread(ImageLoader *il)
         if (!image_loader_thread_pool)
                {
                image_loader_thread_pool = g_thread_pool_new(image_loader_thread_run, NULL, -1, FALSE, NULL);
+#if GLIB_CHECK_VERSION(2,32,0)
+               if (!image_loader_prio_cond) image_loader_prio_cond = g_new(GCond, 1);
+               g_cond_init(image_loader_prio_cond);
+               if (!image_loader_prio_mutex) image_loader_prio_mutex = g_new(GMutex, 1);
+               g_mutex_init(image_loader_prio_mutex);
+#else
                image_loader_prio_cond = g_cond_new();
                image_loader_prio_mutex = g_mutex_new();
+#endif
                }
 
        il->can_destroy = FALSE; /* ImageLoader can't be freed until image_loader_thread_run finishes */
@@ -1047,23 +1406,6 @@ GdkPixbuf *image_loader_get_pixbuf(ImageLoader *il)
        return ret;
 }
 
-gchar *image_loader_get_format(ImageLoader *il)
-{
-       gchar **mimev;
-       gchar *mime;
-
-       if (!il || !il->loader) return NULL;
-
-       mimev = il->backend.get_format_mime_types(il->loader);
-       if (!mimev) return NULL;
-
-       /* return first member of mimev, as GdkPixbufLoader has no way to tell us which exact one ? */
-       mime = g_strdup(mimev[0]);
-       g_strfreev(mimev);
-
-       return mime;
-}
-
 void image_loader_set_requested_size(ImageLoader *il, gint width, gint height)
 {
        if (!il) return;
@@ -1156,7 +1498,9 @@ const gchar *image_loader_get_error(ImageLoader *il)
 }
 
 
-/* FIXME - this can be rather slow and blocks until the size is known */
+/**
+ *  @FIXME this can be rather slow and blocks until the size is known
+ */
 gboolean image_load_dimensions(FileData *fd, gint *width, gint *height)
 {
        ImageLoader *il;