src/pixbuf-renderer.h

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