src/image.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_H
  23 #define IMAGE_H
  24
  25 #include <gtk/gtk.h>
  26
  27 #include "typedefs.h"
  28
  29 struct CollectInfo;
  30 struct CollectionData;
  31 struct FileData;
  32 struct ImageLoader;
  33
  34 enum ImageState {
  35         IMAGE_STATE_NONE        = 0,
  36         IMAGE_STATE_IMAGE       = 1 << 0,
  37         IMAGE_STATE_LOADING     = 1 << 1,
  38         IMAGE_STATE_ERROR       = 1 << 2,
  39         IMAGE_STATE_COLOR_ADJ   = 1 << 3,
  40         IMAGE_STATE_ROTATE_AUTO = 1 << 4,
  41         IMAGE_STATE_ROTATE_USER = 1 << 5,
  42         IMAGE_STATE_DELAY_FLIP  = 1 << 6
  43 };
  44
  45 struct ImageWindow
  46 {
  47         GtkWidget *widget;      /**< use this to add it and show it */
  48         GtkWidget *pr;
  49         GtkWidget *frame;
  50
  51         FileData *image_fd;
  52
  53         gboolean unknown;               /**< failed to load image */
  54
  55         ImageLoader *il;        /**< @FIXME image loader should probably go to FileData, but it must first support
  56                                    sending callbacks to multiple ImageWindows in parallel */
  57
  58         gint has_frame;  /**< not boolean, see image_new() */
  59
  60         /* top level (not necessarily parent) window */
  61         gboolean top_window_sync;       /**< resize top_window when image dimensions change */
  62         GtkWidget *top_window;  /**< window that gets title, and window to resize when 'fitting' */
  63         gchar *title;           /**< window title to display left of file name */
  64         gchar *title_right;     /**< window title to display right of file name */
  65         gboolean title_show_zoom;       /**< option to include zoom in window title */
  66
  67         gboolean completed;
  68         ImageState state;       /**< mask of IMAGE_STATE_* flags about current image */
  69
  70         void (*func_update)(ImageWindow *imd, gpointer data);
  71         void (*func_complete)(ImageWindow *imd, gint preload, gpointer data);
  72         void (*func_state)(ImageWindow *imd, ImageState state, gpointer data);
  73
  74         using TileRequestFunc = gint (*)(ImageWindow *, gint, gint, gint, gint, GdkPixbuf *, gpointer);
  75         TileRequestFunc func_tile_request;
  76
  77         using TileDisposeFunc = void (*)(ImageWindow *, gint, gint, gint, gint, GdkPixbuf *, gpointer);
  78         TileDisposeFunc func_tile_dispose;
  79
  80         gpointer data_update;
  81         gpointer data_complete;
  82         gpointer data_state;
  83         gpointer data_tile;
  84
  85         /* button, scroll functions */
  86         void (*func_button)(ImageWindow *, GdkEventButton *event, gpointer);
  87         void (*func_drag)(ImageWindow *, GdkEventMotion *event, gdouble dx, gdouble dy, gpointer);
  88         void (*func_scroll)(ImageWindow *, GdkEventScroll *event, gpointer);
  89         void (*func_focus_in)(ImageWindow *, gpointer);
  90
  91         gpointer data_button;
  92         gpointer data_drag;
  93         gpointer data_scroll;
  94         gpointer data_focus_in;
  95
  96         /**
  97          * @headerfile func_scroll_notify
  98          * scroll notification (for scroll bar implementation)
  99          */
 100         void (*func_scroll_notify)(ImageWindow *, gint x, gint y, gint width, gint height, gpointer);
 101
 102         gpointer data_scroll_notify;
 103
 104         /* collection info */
 105         CollectionData *collection;
 106         CollectInfo *collection_info;
 107
 108         /* color profiles */
 109         gboolean color_profile_enable;
 110         gint color_profile_input;
 111         gboolean color_profile_use_image;
 112         gint color_profile_from_image;
 113         gpointer cm;
 114
 115         AlterType delay_alter_type;
 116
 117         FileData *read_ahead_fd;
 118         ImageLoader *read_ahead_il;
 119
 120         gint prev_color_row;
 121
 122         gboolean auto_refresh;
 123
 124         gboolean delay_flip;
 125         gint orientation;
 126         gboolean desaturate;
 127         gboolean overunderexposed;
 128         gint user_stereo;
 129
 130         gboolean mouse_wheel_mode;
 131 };
 132
 133 void image_set_frame(ImageWindow *imd, gboolean frame);
 134 ImageWindow *image_new(gboolean frame);
 135
 136 /* additional setup */
 137 void image_attach_window(ImageWindow *imd, GtkWidget *window,
 138                          const gchar *title, const gchar *title_right, gboolean show_zoom);
 139 void image_set_update_func(ImageWindow *imd,
 140                            void (*func)(ImageWindow *imd, gpointer data),
 141                            gpointer data);
 142 void image_set_button_func(ImageWindow *imd,
 143         void (*func)(ImageWindow *, GdkEventButton *event, gpointer),
 144         gpointer data);
 145 void image_set_drag_func(ImageWindow *imd,
 146         void (*func)(ImageWindow *, GdkEventMotion *event, gdouble dx, gdouble dy, gpointer),
 147         gpointer data);
 148 void image_set_scroll_func(ImageWindow *imd,
 149         void (*func)(ImageWindow *, GdkEventScroll *event, gpointer),
 150         gpointer data);
 151 void image_set_focus_in_func(ImageWindow *imd,
 152         void (*func)(ImageWindow *, gpointer),
 153         gpointer data);
 154 void image_set_complete_func(ImageWindow *imd,
 155                              void (*func)(ImageWindow *imd, gint preload, gpointer data),
 156                              gpointer data);
 157 void image_set_state_func(ImageWindow *imd,
 158                           void (*func)(ImageWindow *imd, ImageState state, gpointer data),
 159                           gpointer data);
 160
 161 void image_select(ImageWindow *imd, gboolean select);
 162 void image_set_selectable(ImageWindow *imd, gboolean selectable);
 163
 164 void image_grab_focus(ImageWindow *imd);
 165 /* path, name */
 166 const gchar *image_get_path(ImageWindow *imd);
 167 const gchar *image_get_name(ImageWindow *imd);
 168 FileData *image_get_fd(ImageWindow *imd);
 169
 170 /**
 171  * @headerfile image_set_fd
 172  * merely changes path string, does not change the image!
 173  */
 174 void image_set_fd(ImageWindow *imd, FileData *fd);
 175
 176 /* load a new image */
 177 void image_change_fd(ImageWindow *imd, FileData *fd, gdouble zoom);
 178 void image_change_pixbuf(ImageWindow *imd, GdkPixbuf *pixbuf, gdouble zoom, gboolean lazy);
 179 void image_change_from_collection(ImageWindow *imd, CollectionData *cd, CollectInfo *info, gdouble zoom);
 180 CollectionData *image_get_collection(ImageWindow *imd, CollectInfo **info);
 181 void image_copy_from_image(ImageWindow *imd, ImageWindow *source);
 182 void image_move_from_image(ImageWindow *imd, ImageWindow *source);
 183
 184 gboolean image_get_image_size(ImageWindow *imd, gint *width, gint *height);
 185 GdkPixbuf *image_get_pixbuf(ImageWindow *imd);
 186
 187 /* manipulation */
 188 void image_area_changed(ImageWindow *imd, gint x, gint y, gint width, gint height);
 189 void image_reload(ImageWindow *imd);
 190 void image_scroll(ImageWindow *imd, gint x, gint y);
 191 void image_scroll_to_point(ImageWindow *imd, gint x, gint y,
 192                            gdouble x_align, gdouble y_align);
 193 void image_get_scroll_center(ImageWindow *imd, gdouble *x, gdouble *y);
 194 void image_set_scroll_center(ImageWindow *imd, gdouble x, gdouble y);
 195 void image_alter_orientation(ImageWindow *imd, FileData *fd, AlterType type);
 196 void image_set_desaturate(ImageWindow *imd, gboolean desaturate);
 197 gboolean image_get_desaturate(ImageWindow *imd);
 198 void image_set_overunderexposed(ImageWindow *imd, gboolean overunderexposed);
 199 void image_set_ignore_alpha(ImageWindow *imd, gboolean ignore_alpha);
 200
 201 /* zoom */
 202 void image_zoom_adjust(ImageWindow *imd, gdouble increment);
 203 void image_zoom_adjust_at_point(ImageWindow *imd, gdouble increment, gint x, gint y);
 204 void image_zoom_set_limits(ImageWindow *imd, gdouble min, gdouble max);
 205 void image_zoom_set(ImageWindow *imd, gdouble zoom);
 206 void image_zoom_set_fill_geometry(ImageWindow *imd, gboolean vertical);
 207 gdouble image_zoom_get(ImageWindow *imd);
 208 gdouble image_zoom_get_real(ImageWindow *imd);
 209 gchar *image_zoom_get_as_text(ImageWindow *imd);
 210 gdouble image_zoom_get_default(ImageWindow *imd);
 211
 212 /* stereo */
 213 void image_stereo_set(ImageWindow *imd, gint stereo_mode);
 214
 215 StereoPixbufData image_stereo_pixbuf_get(ImageWindow *imd);
 216 void image_stereo_pixbuf_set(ImageWindow *imd, StereoPixbufData stereo_mode);
 217
 218 /**
 219  * @headerfile image_prebuffer_set
 220  * read ahead, pass NULL to cancel
 221  */
 222 void image_prebuffer_set(ImageWindow *imd, FileData *fd);
 223
 224 /**
 225  * @headerfile image_auto_refresh_enable
 226  * auto refresh
 227  */
 228 void image_auto_refresh_enable(ImageWindow *imd, gboolean enable);
 229
 230 /**
 231  * @headerfile image_top_window_set_sync
 232  * allow top window to be resized ?
 233  */
 234 void image_top_window_set_sync(ImageWindow *imd, gboolean allow_sync);
 235
 236 /* background of image */
 237 void image_background_set_color(ImageWindow *imd, GdkRGBA *color);
 238 void image_background_set_color_from_options(ImageWindow *imd, gboolean fullscreen);
 239
 240 /* color profiles */
 241 void image_color_profile_set(ImageWindow *imd,
 242                              gint input_type,
 243                              gboolean use_image);
 244 gboolean image_color_profile_get(ImageWindow *imd,
 245                              gint *input_type,
 246                              gboolean *use_image);
 247 void image_color_profile_set_use(ImageWindow *imd, gboolean enable);
 248 gboolean image_color_profile_get_use(ImageWindow *imd);
 249 gboolean image_color_profile_get_status(ImageWindow *imd, gchar **image_profile, gchar **screen_profile);
 250
 251 /**
 252  * @headerfile image_set_delay_flip
 253  * set delayed page flipping
 254  */
 255 void image_set_delay_flip(ImageWindow *imd, gint delay);
 256
 257 /**
 258  * @headerfile image_to_root_window
 259  * wallpaper util
 260  */
 261 void image_to_root_window(ImageWindow *imd, gboolean scaled);
 262
 263
 264
 265 void image_set_image_as_tiles(ImageWindow *imd, gint width, gint height,
 266                               gint tile_width, gint tile_height, gint cache_size,
 267                               ImageWindow::TileRequestFunc func_tile_request,
 268                               ImageWindow::TileDisposeFunc func_tile_dispose,
 269                               gpointer data,
 270                               gdouble zoom);
 271
 272 /**
 273  * @headerfile image_options_sync
 274  * reset default options
 275  */
 276 void image_options_sync();
 277
 278 void image_get_rectangle(gint *x1, gint *y1, gint *x2, gint *y2);
 279 void image_update_title(ImageWindow *imd);
 280 #endif
 281 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */