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