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