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