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