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