src/pixbuf-renderer.h

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