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
  87         gint (*overlay_add)(void *renderer, GdkPixbuf *pixbuf, gint x, gint y, OverlayRendererFlags flags);
  88         void (*overlay_set)(void *renderer, gint id, GdkPixbuf *pixbuf, gint x, gint y);
  89         gboolean (*overlay_get)(void *renderer, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
  90         void (*overlay_update_sizes)(void *renderer);
  91         void (*overlay_draw)(void *renderer, gint x, gint y, gint w, gint h);
  92
  93         void (*free)(void *renderer);
  94 };
  95
  96 struct _PixbufRenderer
  97 {
  98         GtkEventBox eventbox;
  99
 100         gint image_width;       /* image actual dimensions (pixels) */
 101         gint image_height;
 102
 103         GdkPixbuf *pixbuf;
 104
 105         gint window_width;      /* allocated size of window (drawing area) */
 106         gint window_height;
 107
 108         gint viewport_width;    /* allocated size of viewport (same as window for normal mode, half of window for SBS mode) */
 109         gint viewport_height;
 110
 111         gint x_offset;          /* offset of image start (non-zero when viewport < window) */
 112         gint y_offset;
 113
 114         gint x_mouse; /* coordinates of the mouse taken from GtkEvent */
 115         gint y_mouse;
 116
 117         gint vis_width;         /* dimensions of visible part of image */
 118         gint vis_height;
 119
 120         gint width;             /* size of scaled image (result) */
 121         gint height;
 122
 123         gint x_scroll;          /* scroll offset of image (into width, height to start drawing) */
 124         gint y_scroll;
 125
 126         gdouble norm_center_x;  /* coordinates of viewport center in the image, in range 0.0 - 1.0 */
 127         gdouble norm_center_y;  /* these coordinates are used for PR_SCROLL_RESET_NOCHANGE and should be preserved over periods with NULL pixbuf */
 128
 129         gdouble subpixel_x_scroll; /* subpixel scroll alignment, used to prevent acumulation of rounding errors */
 130         gdouble subpixel_y_scroll;
 131
 132         gdouble zoom_min;
 133         gdouble zoom_max;
 134         gdouble zoom;           /* zoom we want (0 is auto) */
 135         gdouble scale;          /* zoom we got (should never be 0) */
 136
 137         GdkInterpType zoom_quality;
 138         gboolean zoom_2pass;
 139         gboolean zoom_expand;
 140
 141         GdkRgbDither dither_quality;
 142
 143         PixbufRendererScrollResetType scroll_reset;
 144
 145         gboolean has_frame;
 146
 147         GtkWidget *parent_window;       /* resize parent_window when image dimensions change */
 148
 149         gboolean window_fit;
 150         gboolean window_limit;
 151         gint window_limit_size;
 152
 153         gboolean autofit_limit;
 154         gint autofit_limit_size;
 155
 156
 157
 158         /*< private >*/
 159         gboolean in_drag;
 160         gint drag_last_x;
 161         gint drag_last_y;
 162         gint drag_moved;
 163
 164         gboolean source_tiles_enabled;
 165         gint source_tiles_cache_size;
 166
 167         GList *source_tiles;    /* list of active source tiles */
 168         gint source_tile_width;
 169         gint source_tile_height;
 170
 171         PixbufRendererTileRequestFunc func_tile_request;
 172         PixbufRendererTileDisposeFunc func_tile_dispose;
 173
 174         gpointer func_tile_data;
 175
 176         PixbufRendererPostProcessFunc func_post_process;
 177         gpointer post_process_user_data;
 178         gint post_process_slow;
 179
 180         gboolean delay_flip;
 181         gboolean loading;
 182         gboolean complete;
 183         gboolean debug_updated; /* debug only */
 184
 185         guint scroller_id; /* event source id */
 186         gint scroller_overlay;
 187         gint scroller_x;
 188         gint scroller_y;
 189         gint scroller_xpos;
 190         gint scroller_ypos;
 191         gint scroller_xinc;
 192         gint scroller_yinc;
 193
 194         gint orientation;
 195
 196         RendererFuncs *renderer;
 197 };
 198
 199 struct _PixbufRendererClass
 200 {
 201         GtkEventBoxClass parent_class;
 202
 203         void (*zoom)(PixbufRenderer *pr, gdouble zoom);
 204         void (*clicked)(PixbufRenderer *pr, GdkEventButton *event);
 205         void (*scroll_notify)(PixbufRenderer *pr);
 206         void (*update_pixel)(PixbufRenderer *pr);
 207
 208         void (*render_complete)(PixbufRenderer *pr);
 209         void (*drag)(PixbufRenderer *pr, GdkEventButton *event);
 210 };
 211
 212
 213
 214
 215 GType pixbuf_renderer_get_type(void);
 216
 217 PixbufRenderer *pixbuf_renderer_new(void);
 218
 219 void pixbuf_renderer_set_parent(PixbufRenderer *pr, GtkWindow *window);
 220 GtkWindow *pixbuf_renderer_get_parent(PixbufRenderer *pr);
 221
 222 /* display a pixbuf */
 223
 224 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
 225
 226 /* same as pixbuf_renderer_set_pixbuf but waits with redrawing for pixbuf_renderer_area_changed */
 227 void pixbuf_renderer_set_pixbuf_lazy(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom, gint orientation);
 228
 229
 230 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
 231
 232 void pixbuf_renderer_set_orientation(PixbufRenderer *pr, gint orientation);
 233 gint pixbuf_renderer_get_orientation(PixbufRenderer *pr);
 234
 235 void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gboolean slow);
 236
 237 /* display an on-request array of pixbuf tiles */
 238
 239 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
 240                                gint tile_width, gint tile_height, gint cache_size,
 241                                PixbufRendererTileRequestFunc func_request,
 242                                PixbufRendererTileDisposeFunc func_dispose,
 243                                gpointer user_data,
 244                                gdouble zoom);
 245 void pixbuf_renderer_set_tiles_size(PixbufRenderer *pr, gint width, gint height);
 246 gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
 247
 248 /* move image data from source to pr, source is then set to NULL image */
 249
 250 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
 251
 252 /* update region of existing image */
 253
 254 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
 255
 256 /* scrolling */
 257
 258 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
 259 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
 260                                      gdouble x_align, gdouble y_align);
 261
 262 void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
 263 void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
 264 /* zoom */
 265
 266 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
 267 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
 268
 269 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
 270 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
 271 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
 272
 273 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
 274
 275 /* sizes */
 276
 277 gboolean pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
 278 gboolean pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
 279
 280 /* region of image in pixel coordinates */
 281 gboolean pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
 282
 283 /* actual size of the PixbufRenderer window minus borders,
 284  * x and y are the scroll offset and include zoom factor.
 285  */
 286 gboolean pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
 287
 288 /* background color */
 289 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
 290
 291 /* overlay */
 292
 293 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
 294                                  OverlayRendererFlags flags);
 295 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
 296 gboolean pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
 297 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);
 298
 299 gboolean pixbuf_renderer_get_mouse_position(PixbufRenderer *pr, gint *x_pixel, gint *y_pixel);
 300 /* x_pixel and y_pixel are the pixel coordinates \see pixbuf_renderer_get_mouse_position */
 301 gboolean pixbuf_renderer_get_pixel_colors(PixbufRenderer *pr, gint x_pixel, gint y_pixel,
 302                                         gint *r_mouse, gint *g_mouse, gint *b_mouse);
 303
 304 void pixbuf_renderer_set_size_early(PixbufRenderer *pr, guint width, guint height);
 305
 306 /* protected - for renderer use only*/
 307
 308 typedef struct _SourceTile SourceTile;
 309 struct _SourceTile
 310 {
 311         gint x;
 312         gint y;
 313         GdkPixbuf *pixbuf;
 314         gboolean blank;
 315 };
 316
 317
 318 gboolean pr_clip_region(gint x, gint y, gint w, gint h,
 319                                gint clip_x, gint clip_y, gint clip_w, gint clip_h,
 320                                gint *rx, gint *ry, gint *rw, gint *rh);
 321 void pr_render_complete_signal(PixbufRenderer *pr);
 322
 323 void pr_tile_coords_map_orientation(gint orientation,
 324                                      gdouble tile_x, gdouble tile_y, /* coordinates of the tile */
 325                                      gdouble image_w, gdouble image_h,
 326                                      gdouble tile_w, gdouble tile_h,
 327                                      gdouble *res_x, gdouble *res_y);
 328 void pr_tile_region_map_orientation(gint orientation,
 329                                      gint area_x, gint area_y, /* coordinates of the area inside tile */
 330                                      gint tile_w, gint tile_h,
 331                                      gint area_w, gint area_h,
 332                                      gint *res_x, gint *res_y,
 333                                      gint *res_w, gint *res_h);
 334 void pr_coords_map_orientation_reverse(gint orientation,
 335                                      gint area_x, gint area_y,
 336                                      gint tile_w, gint tile_h,
 337                                      gint area_w, gint area_h,
 338                                      gint *res_x, gint *res_y,
 339                                      gint *res_w, gint *res_h);
 340
 341 GList *pr_source_tile_compute_region(PixbufRenderer *pr, gint x, gint y, gint w, gint h, gboolean request);
 342 #endif
 343 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */