src/image-load.h

   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 #ifndef IMAGE_LOAD_H
  23 #define IMAGE_LOAD_H
  24
  25 #include <gdk-pixbuf/gdk-pixbuf.h>
  26
  27 struct FileData;
  28
  29 #define TYPE_IMAGE_LOADER               (image_loader_get_type())
  30
  31 using ImageLoaderBackendCbAreaPrepared = void (*)(gpointer, gpointer);
  32 using ImageLoaderBackendCbSize = void (*)(gpointer, gint, gint, gpointer);
  33 using ImageLoaderBackendCbAreaUpdated = void (*)(gpointer, guint, guint, guint, guint, gpointer);
  34
  35 using ImageLoaderBackendFuncLoaderNew = gpointer (*)(ImageLoaderBackendCbAreaUpdated, ImageLoaderBackendCbSize, ImageLoaderBackendCbAreaPrepared, gpointer);
  36 using ImageLoaderBackendFuncSetSize = void (*)(gpointer, int, int);
  37 using ImageLoaderBackendFuncLoad = gboolean (*)(gpointer, const guchar *, gsize, GError **); /* optional, load whole image at once */
  38 using ImageLoaderBackendFuncWrite = gboolean (*)(gpointer, const guchar *, gsize, GError **);
  39 using ImageLoaderBackendFuncGetPixbuf = GdkPixbuf *(*)(gpointer);
  40 using ImageLoaderBackendFuncClose = gboolean (*)(gpointer, GError **);
  41 using ImageLoaderBackendFuncAbort = void (*)(gpointer);
  42 using ImageLoaderBackendFuncFree = void (*)(gpointer);
  43 using ImageLoaderBackendFuncGetFormatName = gchar *(*)(gpointer);
  44 using ImageLoaderBackendFuncGetFormatMimeTypes = gchar **(*)(gpointer);
  45 using ImageLoaderBackendFuncSetPageNum = void (*)(gpointer, gint);
  46 using ImageLoaderBackendFuncGetPageTotal = gint (*)(gpointer);
  47
  48 struct ImageLoaderBackend
  49 {
  50         ImageLoaderBackendFuncLoaderNew loader_new;
  51         ImageLoaderBackendFuncSetSize set_size;
  52         ImageLoaderBackendFuncLoad load;
  53         ImageLoaderBackendFuncWrite write;
  54         ImageLoaderBackendFuncGetPixbuf get_pixbuf;
  55         ImageLoaderBackendFuncClose close;
  56         ImageLoaderBackendFuncAbort abort;
  57         ImageLoaderBackendFuncFree free;
  58         ImageLoaderBackendFuncGetFormatName get_format_name;
  59         ImageLoaderBackendFuncGetFormatMimeTypes get_format_mime_types;
  60         ImageLoaderBackendFuncSetPageNum set_page_num;
  61         ImageLoaderBackendFuncGetPageTotal get_page_total;
  62 };
  63
  64 enum ImageLoaderPreview {
  65         IMAGE_LOADER_PREVIEW_NONE = 0,
  66         IMAGE_LOADER_PREVIEW_EXIF = 1,
  67         IMAGE_LOADER_PREVIEW_LIBRAW = 2
  68 };
  69
  70
  71 struct ImageLoader
  72 {
  73         GObject parent;
  74
  75         /*< private >*/
  76         GdkPixbuf *pixbuf;
  77         FileData *fd;
  78         gchar *path;
  79
  80         gsize bytes_read;
  81         gsize bytes_total;
  82
  83         ImageLoaderPreview preview;
  84
  85         gint requested_width;
  86         gint requested_height;
  87
  88         gint actual_width;
  89         gint actual_height;
  90
  91         gboolean shrunk;
  92
  93         gboolean done;
  94         guint idle_id; /**< event source id */
  95         gint idle_priority;
  96
  97         gpointer *loader;
  98         GError *error;
  99         ImageLoaderBackend backend;
 100
 101         guint idle_done_id; /**< event source id */
 102         GList *area_param_list;
 103         GList *area_param_delayed_list;
 104
 105         gboolean delay_area_ready;
 106
 107         GMutex *data_mutex;
 108         gboolean stopping;
 109         gboolean can_destroy;
 110         GCond *can_destroy_cond;
 111         gboolean thread;
 112
 113         guchar *mapped_file;
 114         gsize read_buffer_size;
 115         guint idle_read_loop_count;
 116 };
 117
 118 struct ImageLoaderClass {
 119         GObjectClass parent;
 120
 121         /* class members */
 122         void (*area_ready)(ImageLoader *, guint x, guint y, guint w, guint h, gpointer);
 123         void (*error)(ImageLoader *, gpointer);
 124         void (*done)(ImageLoader *, gpointer);
 125         void (*percent)(ImageLoader *, gdouble, gpointer);
 126 };
 127
 128 GType image_loader_get_type();
 129
 130 ImageLoader *image_loader_new(FileData *fd);
 131
 132 void image_loader_free(ImageLoader *il);
 133
 134 /**
 135  * @headerfile image_loader_delay_area_ready
 136  * delay area_ready signals
 137  */
 138 void image_loader_delay_area_ready(ImageLoader *il, gboolean enable);
 139
 140 /**
 141  * @headerfile image_loader_set_requested_size
 142  * Speed up loading when you only need at most width x height size image,
 143  * only the jpeg GdkPixbuf loader benefits from it - so there is no
 144  * guarantee that the image will scale down to the requested size..
 145  */
 146 void image_loader_set_requested_size(ImageLoader *il, gint width, gint height);
 147
 148 void image_loader_set_buffer_size(ImageLoader *il, guint count);
 149
 150 /**
 151  * @headerfile image_loader_set_priority
 152  * this only has effect if used before image_loader_start()
 153  * default is G_PRIORITY_DEFAULT_IDLE
 154  */
 155 void image_loader_set_priority(ImageLoader *il, gint priority);
 156
 157 gboolean image_loader_start(ImageLoader *il);
 158
 159
 160 GdkPixbuf *image_loader_get_pixbuf(ImageLoader *il);
 161 gdouble image_loader_get_percent(ImageLoader *il);
 162 gboolean image_loader_get_is_done(ImageLoader *il);
 163 FileData *image_loader_get_fd(ImageLoader *il);
 164 gboolean image_loader_get_shrunk(ImageLoader *il);
 165 const gchar *image_loader_get_error(ImageLoader *il);
 166
 167 gboolean image_load_dimensions(FileData *fd, gint *width, gint *height);
 168
 169 #endif
 170 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */