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 #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 (*redraw)(void *renderer, gint x, gint y, gint w, gint h,
  80                      gint clamp, ImageRenderType render, gboolean new_data, gboolean only_existing);
  81         void (*area_changed)(void *renderer, gint src_x, gint src_y, gint src_w, gint src_h);
  82         void (*queue_clear)(void *renderer);
  83         void (*border_clear)(void *renderer);
  84         void (*invalidate_all)(void *renderer);
  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);
  87         void (*update_sizes)(void *renderer);
  88
  89         gint (*overlay_add)(void *renderer, GdkPixbuf *pixbuf, gint x, gint y, OverlayRendererFlags flags);
  90         void (*overlay_set)(void *renderer, gint id, GdkPixbuf *pixbuf, gint x, gint y);
  91         gboolean (*overlay_get)(void *renderer, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
  92         void (*overlay_draw)(void *renderer, gint x, gint y, gint w, gint h);
  93
  94         void (*stereo_set)(void *renderer, gint stereo_mode);
  95
  96         void (*free)(void *renderer);
  97 };
  98
  99 struct _PixbufRenderer
 100 {
 101         GtkEventBox eventbox;
 102
 103         gint image_width;       /* image actual dimensions (pixels) */
 104         gint image_height;
 105         gint stereo_pixbuf_offset_right; /* offset of the right part of the stereo image in pixbuf */
 106         gint stereo_pixbuf_offset_left; /* offset of the left part of the stereo image in pixbuf */
 107
 108         GdkPixbuf *pixbuf;
 109
 110         gint window_width;      /* allocated size of window (drawing area) */
 111         gint window_height;
 112
 113         gint viewport_width;    /* allocated size of viewport (same as window for normal mode, half of window for SBS mode) */
 114         gint viewport_height;
 115
 116         gint x_offset;          /* offset of image start (non-zero when viewport < window) */
 117         gint y_offset;
 118
 119         gint x_mouse; /* coordinates of the mouse taken from GtkEvent */
 120         gint y_mouse;
 121
 122         gint vis_width;         /* dimensions of visible part of image */
 123         gint vis_height;
 124
 125         gint width;             /* size of scaled image (result) */
 126         gint height;
 127
 128         gint x_scroll;          /* scroll offset of image (into width, height to start drawing) */
 129         gint y_scroll;
 130
 131         gdouble norm_center_x;  /* coordinates of viewport center in the image, in range 0.0 - 1.0 */
 132         gdouble norm_center_y;  /* these coordinates are used for PR_SCROLL_RESET_NOCHANGE and should be preserved over periods with NULL pixbuf */
 133
 134         gdouble subpixel_x_scroll; /* subpixel scroll alignment, used to prevent acumulation of rounding errors */
 135         gdouble subpixel_y_scroll;
 136
 137         gdouble zoom_min;
 138         gdouble zoom_max;
 139         gdouble zoom;           /* zoom we want (0 is auto) */
 140         gdouble scale;          /* zoom we got (should never be 0) */
 141
 142         gdouble aspect_ratio;   /* screen pixel aspect ratio (2.0 for 3DTV SBS mode) */
 143
 144         GdkInterpType zoom_quality;
 145         gboolean zoom_2pass;
 146         gboolean zoom_expand;
 147
 148         GdkRgbDither dither_quality;
 149
 150         PixbufRendererScrollResetType scroll_reset;
 151
 152         gboolean has_frame;
 153
 154         GtkWidget *parent_window;       /* resize parent_window when image dimensions change */
 155
 156         gboolean window_fit;
 157         gboolean window_limit;
 158         gint window_limit_size;
 159
 160         gboolean autofit_limit;
 161         gint autofit_limit_size;
 162
 163
 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, GdkEventButton *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
 274 /* update region of existing image */
 275
 276 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
 277
 278 /* scrolling */
 279
 280 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
 281 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
 282                                      gdouble x_align, gdouble y_align);
 283
 284 void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
 285 void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
 286 /* zoom */
 287
 288 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
 289 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
 290
 291 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
 292 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
 293 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
 294
 295 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
 296
 297 /* sizes */
 298
 299 gboolean pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
 300 gboolean pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
 301
 302 /* region of image in pixel coordinates */
 303 gboolean pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
 304
 305 /* actual size of the PixbufRenderer window minus borders,
 306  * x and y are the scroll offset and include zoom factor.
 307  */
 308 gboolean pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
 309
 310 /* background color */
 311 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
 312
 313 /* overlay */
 314
 315 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
 316                                  OverlayRendererFlags flags);
 317 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
 318 gboolean pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
 319 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);
 320
 321 gboolean pixbuf_renderer_get_mouse_position(PixbufRenderer *pr, gint *x_pixel, gint *y_pixel);
 322 /* x_pixel and y_pixel are the pixel coordinates \see pixbuf_renderer_get_mouse_position */
 323 gboolean pixbuf_renderer_get_pixel_colors(PixbufRenderer *pr, gint x_pixel, gint y_pixel,
 324                                         gint *r_mouse, gint *g_mouse, gint *b_mouse);
 325
 326 void pixbuf_renderer_set_size_early(PixbufRenderer *pr, guint width, guint height);
 327
 328 /* stereo */
 329 void pixbuf_renderer_stereo_set(PixbufRenderer *pr, gint stereo_mode);
 330 gint pixbuf_renderer_stereo_get(PixbufRenderer *pr);
 331 void pixbuf_renderer_stereo_fixed_set(PixbufRenderer *pr, gint width, gint height, gint x1, gint y1, gint x2, gint y2);
 332
 333 /* protected - for renderer use only*/
 334
 335 typedef struct _SourceTile SourceTile;
 336 struct _SourceTile
 337 {
 338         gint x;
 339         gint y;
 340         GdkPixbuf *pixbuf;
 341         gboolean blank;
 342 };
 343
 344
 345 gboolean pr_clip_region(gint x, gint y, gint w, gint h,
 346                                gint clip_x, gint clip_y, gint clip_w, gint clip_h,
 347                                gint *rx, gint *ry, gint *rw, gint *rh);
 348 void pr_render_complete_signal(PixbufRenderer *pr);
 349
 350 void pr_tile_coords_map_orientation(gint orientation,
 351                                      gdouble tile_x, gdouble tile_y, /* coordinates of the tile */
 352                                      gdouble image_w, gdouble image_h,
 353                                      gdouble tile_w, gdouble tile_h,
 354                                      gdouble *res_x, gdouble *res_y);
 355 void pr_tile_region_map_orientation(gint orientation,
 356                                      gint area_x, gint area_y, /* coordinates of the area inside tile */
 357                                      gint tile_w, gint tile_h,
 358                                      gint area_w, gint area_h,
 359                                      gint *res_x, gint *res_y,
 360                                      gint *res_w, gint *res_h);
 361 void pr_coords_map_orientation_reverse(gint orientation,
 362                                      gint area_x, gint area_y,
 363                                      gint tile_w, gint tile_h,
 364                                      gint area_w, gint area_h,
 365                                      gint *res_x, gint *res_y,
 366                                      gint *res_w, gint *res_h);
 367
 368 GList *pr_source_tile_compute_region(PixbufRenderer *pr, gint x, gint y, gint w, gint h, gboolean request);
 369
 370 void pr_create_anaglyph(guint mode, GdkPixbuf *pixbuf, GdkPixbuf *right, gint x, gint y, gint w, gint h);
 371 #endif
 372 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */