src/pixbuf-renderer.h

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