src/pixbuf-renderer.h

   1 /*
   2  * Copyright (C) 2006 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 PIXBUF_RENDERER_H
  23 #define PIXBUF_RENDERER_H
  24
  25 #define TYPE_PIXBUF_RENDERER            (pixbuf_renderer_get_type())
  26 #define PIXBUF_RENDERER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), TYPE_PIXBUF_RENDERER, PixbufRenderer))
  27 #define PIXBUF_RENDERER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
  28 #define IS_PIXBUF_RENDERER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), TYPE_PIXBUF_RENDERER))
  29 #define IS_PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), TYPE_PIXBUF_RENDERER))
  30 #define PIXBUF_RENDERER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
  31
  32 /**
  33  * @def PR_ALPHA_CHECK_SIZE
  34  * alpha channel checkerboard (same as gimp)
  35  */
  36 #define PR_ALPHA_CHECK_SIZE 16
  37
  38 /**
  39  * @def PR_MIN_SCALE_SIZE
  40  * when scaling image to below this size, use nearest pixel for scaling
  41  * (below about 4, the other scale types become slow generating their conversion tables)
  42  */
  43 #define PR_MIN_SCALE_SIZE 8
  44
  45 /**
  46  * @def PR_CACHE_SIZE_DEFAULT
  47  * default size of tile cache (MiB)
  48  */
  49 #define PR_CACHE_SIZE_DEFAULT 8
  50
  51 /**
  52  * @def ROUND_UP
  53  * round A up to integer count of B
  54  */
  55 #define ROUND_UP(A,B)   ((gint)(((A)+(B)-1)/(B))*(B))
  56
  57 /**
  58  * @def ROUND_DOWN
  59  * round A down to integer count of B
  60  */
  61 #define ROUND_DOWN(A,B) ((gint)(((A))/(B))*(B))
  62
  63
  64 struct RendererFuncs;
  65
  66 struct PixbufRenderer;
  67 struct PixbufRendererClass;
  68
  69
  70 using PixbufRendererTileRequestFunc = gint (*)(PixbufRenderer *, gint, gint, gint, gint, GdkPixbuf *, gpointer);
  71 using PixbufRendererTileDisposeFunc = void (*)(PixbufRenderer *, gint, gint, gint, gint, GdkPixbuf *, gpointer);
  72
  73 using PixbufRendererPostProcessFunc = void (*)(PixbufRenderer *, GdkPixbuf **, gint, gint, gint, gint, gpointer);
  74
  75 enum PixbufRendererScrollResetType {
  76         PR_SCROLL_RESET_TOPLEFT = 0,
  77         PR_SCROLL_RESET_CENTER,
  78         PR_SCROLL_RESET_NOCHANGE,
  79         PR_SCROLL_RESET_COUNT,
  80 };
  81
  82 enum ImageRenderType {
  83         TILE_RENDER_NONE = 0, /**< do nothing */
  84         TILE_RENDER_AREA, /**< render an area of the tile */
  85         TILE_RENDER_ALL /**< render the whole tile */
  86 };
  87
  88 enum OverlayRendererFlags {
  89         OVL_NORMAL      = 0,
  90         OVL_RELATIVE    = 1 << 0, /**< x,y coordinates are relative, negative values start bottom right */
  91         /* OVL_HIDE_ON_SCROLL = 1 << 1*/ /**< hide temporarily when scrolling (not yet implemented) */
  92 };
  93
  94 struct RendererFuncs
  95 {
  96     void (*area_changed)(void *renderer, gint src_x, gint src_y, gint src_w, gint src_h); /**< pixbuf area changed */
  97         void (*invalidate_region)(void *renderer, gint x, gint y, gint w, gint h);
  98         void (*scroll)(void *renderer, gint x_off, gint y_off); /**< scroll */
  99         void (*update_viewport)(void *renderer); /**< window / wiewport / border color has changed */
 100         void (*update_pixbuf)(void *renderer, gboolean lazy); /**< pixbuf has changed */
 101         void (*update_zoom)(void *renderer, gboolean lazy); /**< zoom has changed */
 102
 103         gint (*overlay_add)(void *renderer, GdkPixbuf *pixbuf, gint x, gint y, OverlayRendererFlags flags);
 104         void (*overlay_set)(void *renderer, gint id, GdkPixbuf *pixbuf, gint x, gint y);
 105         gboolean (*overlay_get)(void *renderer, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
 106
 107         void (*stereo_set)(void *renderer, gint stereo_mode); /**< set stereo mode */
 108
 109         void (*free)(void *renderer);
 110 };
 111
 112 struct PixbufRenderer
 113 {
 114         GtkEventBox eventbox;
 115
 116         gint image_width;       /**< image actual dimensions (pixels) */
 117         gint image_height;
 118         gint stereo_pixbuf_offset_right; /**< offset of the right part of the stereo image in pixbuf */
 119         gint stereo_pixbuf_offset_left; /**< offset of the left part of the stereo image in pixbuf */
 120
 121         GdkPixbuf *pixbuf;
 122
 123         gint window_width;      /**< allocated size of window (drawing area) */
 124         gint window_height;
 125
 126         gint viewport_width;    /**< allocated size of viewport (same as window for normal mode, half of window for SBS mode) */
 127         gint viewport_height;
 128
 129         gint x_offset;          /**< offset of image start (non-zero when viewport < window) */
 130         gint y_offset;
 131
 132         gint x_mouse; /**< coordinates of the mouse taken from GtkEvent */
 133         gint y_mouse;
 134
 135         gint vis_width;         /**< dimensions of visible part of image */
 136         gint vis_height;
 137
 138         gint width;             /**< size of scaled image (result) */
 139         gint height;
 140
 141         gint x_scroll;          /**< scroll offset of image (into width, height to start drawing) */
 142         gint y_scroll;
 143
 144         gdouble norm_center_x;  /**< coordinates of viewport center in the image, in range 0.0 - 1.0 */
 145         gdouble norm_center_y;  /**< these coordinates are used for PR_SCROLL_RESET_NOCHANGE and should be preserved over periods with NULL pixbuf */
 146
 147         gdouble subpixel_x_scroll; /**< subpixel scroll alignment, used to prevent accumulation of rounding errors */
 148         gdouble subpixel_y_scroll;
 149
 150         gdouble zoom_min;
 151         gdouble zoom_max;
 152         gdouble zoom;           /**< zoom we want (0 is auto) */
 153         gdouble scale;          /**< zoom we got (should never be 0) */
 154
 155         gdouble aspect_ratio;   /**< screen pixel aspect ratio (2.0 for 3DTV SBS mode) */
 156
 157         GdkInterpType zoom_quality;
 158         gboolean zoom_2pass;
 159         gboolean zoom_expand;
 160
 161         PixbufRendererScrollResetType scroll_reset;
 162
 163         gboolean has_frame;
 164
 165         GtkWidget *parent_window;       /**< resize parent_window when image dimensions change */
 166
 167         gboolean window_fit;
 168         gboolean window_limit;
 169         gint window_limit_size;
 170
 171         gboolean autofit_limit;
 172         gint autofit_limit_size;
 173         gint enlargement_limit_size;
 174
 175         GdkRGBA color;
 176
 177         /*< private >*/
 178         gboolean in_drag;
 179         gint drag_last_x;
 180         gint drag_last_y;
 181         gint drag_moved;
 182
 183         gboolean source_tiles_enabled;
 184         gint source_tiles_cache_size;
 185
 186         GList *source_tiles;    /**< list of active source tiles */
 187         gint source_tile_width;
 188         gint source_tile_height;
 189
 190         PixbufRendererTileRequestFunc func_tile_request;
 191         PixbufRendererTileDisposeFunc func_tile_dispose;
 192
 193         gpointer func_tile_data;
 194
 195         PixbufRendererPostProcessFunc func_post_process;
 196         gpointer post_process_user_data;
 197         gint post_process_slow;
 198
 199         gboolean delay_flip;
 200         gboolean loading;
 201         gboolean complete;
 202         gboolean debug_updated; /**< debug only */
 203
 204         guint scroller_id; /**< event source id */
 205         gint scroller_overlay;
 206         gint scroller_x;
 207         gint scroller_y;
 208         gint scroller_xpos;
 209         gint scroller_ypos;
 210         gint scroller_xinc;
 211         gint scroller_yinc;
 212
 213         gint orientation;
 214
 215         gint stereo_mode;
 216
 217         StereoPixbufData stereo_data;
 218         gboolean stereo_temp_disable;
 219         gint stereo_fixed_width;
 220         gint stereo_fixed_height;
 221         gint stereo_fixed_x_left;
 222         gint stereo_fixed_y_left;
 223         gint stereo_fixed_x_right;
 224         gint stereo_fixed_y_right;
 225
 226         RendererFuncs *renderer;
 227         RendererFuncs *renderer2;
 228
 229         gboolean ignore_alpha;
 230 };
 231
 232 struct PixbufRendererClass
 233 {
 234         GtkEventBoxClass parent_class;
 235
 236         void (*zoom)(PixbufRenderer *pr, gdouble zoom);
 237         void (*clicked)(PixbufRenderer *pr, GdkEventButton *event);
 238         void (*scroll_notify)(PixbufRenderer *pr);
 239         void (*update_pixel)(PixbufRenderer *pr);
 240
 241         void (*render_complete)(PixbufRenderer *pr);
 242         void (*drag)(PixbufRenderer *pr, GdkEventMotion *event);
 243 };
 244
 245
 246
 247
 248 GType pixbuf_renderer_get_type();
 249
 250 PixbufRenderer *pixbuf_renderer_new();
 251
 252 void pixbuf_renderer_set_parent(PixbufRenderer *pr, GtkWindow *window);
 253
 254 /**
 255  * @headerfile pixbuf_renderer_set_pixbuf
 256  * display a pixbuf
 257  */
 258 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
 259
 260 /**
 261  * @headerfile  pixbuf_renderer_set_pixbuf_lazy
 262  * same as pixbuf_renderer_set_pixbuf but waits with redrawing for pixbuf_renderer_area_changed */
 263 void pixbuf_renderer_set_pixbuf_lazy(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom, gint orientation, StereoPixbufData stereo_data);
 264
 265
 266 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
 267
 268 void pixbuf_renderer_set_orientation(PixbufRenderer *pr, gint orientation);
 269
 270 /**
 271  * @headerfile pixbuf_renderer_set_stereo_data
 272  * sets the format of stereo data in the input pixbuf
 273  */
 274 void pixbuf_renderer_set_stereo_data(PixbufRenderer *pr, StereoPixbufData stereo_data);
 275
 276 void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gboolean slow);
 277
 278 /**
 279  * @headerfile pixbuf_renderer_set_tiles
 280  * display an on-request array of pixbuf tiles
 281  */
 282 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
 283                                gint tile_width, gint tile_height, gint cache_size,
 284                                PixbufRendererTileRequestFunc func_request,
 285                                PixbufRendererTileDisposeFunc func_dispose,
 286                                gpointer user_data,
 287                                gdouble zoom);
 288 void pixbuf_renderer_set_tiles_size(PixbufRenderer *pr, gint width, gint height);
 289 gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
 290
 291 /**
 292  * @headerfile pixbuf_renderer_move
 293  * move image data from source to pr, source is then set to NULL image
 294  */
 295 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
 296 void pixbuf_renderer_copy(PixbufRenderer *pr, PixbufRenderer *source);
 297
 298 /**
 299  * @headerfile pixbuf_renderer_area_changed
 300  * update region of existing image
 301  */
 302 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
 303
 304 /* scrolling */
 305
 306 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
 307 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
 308                                      gdouble x_align, gdouble y_align);
 309
 310 void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
 311 void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
 312 /* zoom */
 313
 314 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
 315 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
 316
 317 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
 318 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
 319 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
 320
 321 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
 322
 323 /* sizes */
 324
 325 gboolean pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
 326 gboolean pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
 327
 328 /**
 329  * @headerfile pixbuf_renderer_get_visible_rect
 330  * region of image in pixel coordinates
 331  */
 332 gboolean pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
 333
 334 /**
 335  * @headerfile pixbuf_renderer_set_color
 336  *  background color
 337  */
 338 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkRGBA *color);
 339
 340 /* overlay */
 341
 342 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
 343                                  OverlayRendererFlags flags);
 344 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
 345 gboolean pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
 346 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);
 347
 348 gboolean pixbuf_renderer_get_mouse_position(PixbufRenderer *pr, gint *x_pixel, gint *y_pixel);
 349
 350 /**
 351  * @headerfile pixbuf_renderer_get_pixel_colors
 352  * x_pixel and y_pixel are the pixel coordinates see #pixbuf_renderer_get_mouse_position
 353  */
 354 gboolean pixbuf_renderer_get_pixel_colors(PixbufRenderer *pr, gint x_pixel, gint y_pixel,
 355                                         gint *r_mouse, gint *g_mouse, gint *b_mouse);
 356
 357 void pixbuf_renderer_set_size_early(PixbufRenderer *pr, guint width, guint height);
 358
 359 /* stereo */
 360 void pixbuf_renderer_stereo_set(PixbufRenderer *pr, gint stereo_mode);
 361 gint pixbuf_renderer_stereo_get(PixbufRenderer *pr);
 362 void pixbuf_renderer_stereo_fixed_set(PixbufRenderer *pr, gint width, gint height, gint x1, gint y1, gint x2, gint y2);
 363
 364 /**
 365  * @struct SourceTile
 366  * protected - for renderer use only
 367  */
 368 struct SourceTile
 369 {
 370         gint x;
 371         gint y;
 372         GdkPixbuf *pixbuf;
 373         gboolean blank;
 374 };
 375
 376
 377 gboolean pr_clip_region(gint x, gint y, gint w, gint h,
 378                                gint clip_x, gint clip_y, gint clip_w, gint clip_h,
 379                                gint *rx, gint *ry, gint *rw, gint *rh);
 380 void pr_render_complete_signal(PixbufRenderer *pr);
 381
 382 void pr_tile_coords_map_orientation(gint orientation,
 383                                      gdouble tile_x, gdouble tile_y, /**< coordinates of the tile */
 384                                      gdouble image_w, gdouble image_h,
 385                                      gdouble tile_w, gdouble tile_h,
 386                                      gdouble *res_x, gdouble *res_y);
 387 void pr_tile_region_map_orientation(gint orientation,
 388                                      gint area_x, gint area_y, /**< coordinates of the area inside tile */
 389                                      gint tile_w, gint tile_h,
 390                                      gint area_w, gint area_h,
 391                                      gint *res_x, gint *res_y,
 392                                      gint *res_w, gint *res_h);
 393 void pr_coords_map_orientation_reverse(gint orientation,
 394                                      gint area_x, gint area_y,
 395                                      gint tile_w, gint tile_h,
 396                                      gint area_w, gint area_h,
 397                                      gint *res_x, gint *res_y,
 398                                      gint *res_w, gint *res_h);
 399
 400 GList *pr_source_tile_compute_region(PixbufRenderer *pr, gint x, gint y, gint w, gint h, gboolean request);
 401
 402 void pr_create_anaglyph(guint mode, GdkPixbuf *pixbuf, GdkPixbuf *right, gint x, gint y, gint w, gint h);
 403
 404 void pixbuf_renderer_set_ignore_alpha(PixbufRenderer *pr, gint ignore_alpha);
 405 #endif
 406 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */