Trim trailing white spaces on empty lines.
[geeqie.git] / src / pixbuf-renderer.h
index f71806d..a0668a9 100644 (file)
@@ -1,6 +1,7 @@
 /*
- * GQview
+ * Geeqie
  * (C) 2006 John Ellis
+ * Copyright (C) 2008 - 2012 The Geeqie Team
  *
  * Author: John Ellis
  *
 #ifndef PIXBUF_RENDERER_H
 #define PIXBUF_RENDERER_H
 
-#include <gtk/gtkeventbox.h>
-#include <gtk/gtkwindow.h>
-
-
 #define TYPE_PIXBUF_RENDERER           (pixbuf_renderer_get_type())
 #define PIXBUF_RENDERER(obj)           (G_TYPE_CHECK_INSTANCE_CAST((obj), TYPE_PIXBUF_RENDERER, PixbufRenderer))
 #define PIXBUF_RENDERER_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
 #define IS_PIXBUF_RENDERER_CLASS(klass)        (G_TYPE_CHECK_CLASS_TYPE((klass), TYPE_PIXBUF_RENDERER))
 #define PIXBUF_RENDERER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
 
+/* alpha channel checkerboard background (same as gimp) */
+#define PR_ALPHA_CHECK1 0x00999999
+#define PR_ALPHA_CHECK2 0x00666666
+#define PR_ALPHA_CHECK_SIZE 16
+/* when scaling image to below this size, use nearest pixel for scaling
+ * (below about 4, the other scale types become slow generating their conversion tables)
+ */
+#define PR_MIN_SCALE_SIZE 8
+
+/* default size of tile cache (mb) */
+#define PR_CACHE_SIZE_DEFAULT 8
+
+/* round A up/down to integer count of B */
+#define ROUND_UP(A,B)   ((gint)(((A)+(B)-1)/(B))*(B))
+#define ROUND_DOWN(A,B) ((gint)(((A))/(B))*(B))
+
+
+typedef struct _RendererFuncs RendererFuncs;
 
 typedef struct _PixbufRenderer PixbufRenderer;
 typedef struct _PixbufRendererClass PixbufRendererClass;
@@ -32,27 +47,72 @@ typedef gint (* PixbufRendererTileRequestFunc)(PixbufRenderer *pr, gint x, gint
                                               gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
 typedef void (* PixbufRendererTileDisposeFunc)(PixbufRenderer *pr, gint x, gint y,
                                               gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
+
+typedef void (* PixbufRendererPostProcessFunc)(PixbufRenderer *pr, GdkPixbuf **pixbuf, gint x, gint y,
+                                              gint width, gint height, gpointer user_data);
+
 typedef enum {
        PR_SCROLL_RESET_TOPLEFT = 0,
        PR_SCROLL_RESET_CENTER,
-       PR_SCROLL_RESET_NOCHANGE
+       PR_SCROLL_RESET_NOCHANGE,
+       PR_SCROLL_RESET_COUNT,
 } PixbufRendererScrollResetType;
 
+typedef enum {
+       TILE_RENDER_NONE = 0,   /* do nothing */
+       TILE_RENDER_AREA,       /* render an area of the tile */
+       TILE_RENDER_ALL         /* render the whole tile */
+} ImageRenderType;
+
+typedef enum {
+       OVL_NORMAL      = 0,
+       OVL_RELATIVE    = 1 << 0, /* x,y coordinates are relative, negative values start bottom right */
+       /* OVL_HIDE_ON_SCROLL = 1 << 1*/ /* hide temporarily when scrolling (not yet implemented) */
+} OverlayRendererFlags;
+
+struct _RendererFuncs
+{
+//     void (*redraw)(void *renderer, gint x, gint y, gint w, gint h,
+  //                   gint clamp, ImageRenderType render, gboolean new_data, gboolean only_existing);
+        void (*area_changed)(void *renderer, gint src_x, gint src_y, gint src_w, gint src_h); /* pixbuf area changed */
+       void (*invalidate_region)(void *renderer, gint x, gint y, gint w, gint h);
+       void (*scroll)(void *renderer, gint x_off, gint y_off); /* scroll */
+       void (*update_viewport)(void *renderer); /* window / wiewport / border color has changed */
+       void (*update_pixbuf)(void *renderer, gboolean lazy); /* pixbuf has changed */
+       void (*update_zoom)(void *renderer, gboolean lazy); /* zoom has changed */
+
+       gint (*overlay_add)(void *renderer, GdkPixbuf *pixbuf, gint x, gint y, OverlayRendererFlags flags);
+       void (*overlay_set)(void *renderer, gint id, GdkPixbuf *pixbuf, gint x, gint y);
+       gboolean (*overlay_get)(void *renderer, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
+
+       void (*stereo_set)(void *renderer, gint stereo_mode); /* set stereo mode */
+
+       void (*free)(void *renderer);
+};
+
 struct _PixbufRenderer
 {
        GtkEventBox eventbox;
 
        gint image_width;       /* image actual dimensions (pixels) */
        gint image_height;
+       gint stereo_pixbuf_offset_right; /* offset of the right part of the stereo image in pixbuf */
+       gint stereo_pixbuf_offset_left; /* offset of the left part of the stereo image in pixbuf */
 
        GdkPixbuf *pixbuf;
 
        gint window_width;      /* allocated size of window (drawing area) */
        gint window_height;
 
-       gint x_offset;          /* offset of image start (non-zero when image < window) */
+       gint viewport_width;    /* allocated size of viewport (same as window for normal mode, half of window for SBS mode) */
+       gint viewport_height;
+
+       gint x_offset;          /* offset of image start (non-zero when viewport < window) */
        gint y_offset;
 
+       gint x_mouse; /* coordinates of the mouse taken from GtkEvent */
+       gint y_mouse;
+
        gint vis_width;         /* dimensions of visible part of image */
        gint vis_height;
 
@@ -62,17 +122,23 @@ struct _PixbufRenderer
        gint x_scroll;          /* scroll offset of image (into width, height to start drawing) */
        gint y_scroll;
 
+       gdouble norm_center_x;  /* coordinates of viewport center in the image, in range 0.0 - 1.0 */
+       gdouble norm_center_y;  /* these coordinates are used for PR_SCROLL_RESET_NOCHANGE and should be preserved over periods with NULL pixbuf */
+
+       gdouble subpixel_x_scroll; /* subpixel scroll alignment, used to prevent acumulation of rounding errors */
+       gdouble subpixel_y_scroll;
+
        gdouble zoom_min;
        gdouble zoom_max;
        gdouble zoom;           /* zoom we want (0 is auto) */
        gdouble scale;          /* zoom we got (should never be 0) */
 
+       gdouble aspect_ratio;   /* screen pixel aspect ratio (2.0 for 3DTV SBS mode) */
+
        GdkInterpType zoom_quality;
        gboolean zoom_2pass;
        gboolean zoom_expand;
 
-       GdkRgbDither dither_quality;
-
        PixbufRendererScrollResetType scroll_reset;
 
        gboolean has_frame;
@@ -83,21 +149,12 @@ struct _PixbufRenderer
        gboolean window_limit;
        gint window_limit_size;
 
-       gint tile_cache_max;            /* max mb to use for offscreen buffer */
-
-       /*< private >*/
+       gboolean autofit_limit;
+       gint autofit_limit_size;
 
-       gint tile_width;
-       gint tile_height;
-       gint tile_cols;         /* count of tile columns */
-       GList *tiles;           /* list of buffer tiles */
-       gint tile_cache_size;   /* allocated size of pixmaps/pixbufs */
-       GList *draw_queue;      /* list of areas to redraw */
-       GList *draw_queue_2pass;/* list when 2 pass is enabled */
 
-       gint draw_idle_id;
-       gint draw_idle_high;    /* current idle_id has high priority */
 
+       /*< private >*/
        gboolean in_drag;
        gint drag_last_x;
        gint drag_last_y;
@@ -115,11 +172,16 @@ struct _PixbufRenderer
 
        gpointer func_tile_data;
 
+       PixbufRendererPostProcessFunc func_post_process;
+       gpointer post_process_user_data;
+       gint post_process_slow;
+
        gboolean delay_flip;
        gboolean loading;
        gboolean complete;
+       gboolean debug_updated; /* debug only */
 
-       gint scroller_id;
+       guint scroller_id; /* event source id */
        gint scroller_overlay;
        gint scroller_x;
        gint scroller_y;
@@ -128,23 +190,40 @@ struct _PixbufRenderer
        gint scroller_xinc;
        gint scroller_yinc;
 
-       GList *overlay_list;
-       GdkPixmap *overlay_buffer;
+       gint orientation;
+
+       gint stereo_mode;
+
+       StereoPixbufData stereo_data;
+       gboolean stereo_temp_disable;
+       gint stereo_fixed_width;
+       gint stereo_fixed_height;
+       gint stereo_fixed_x_left;
+       gint stereo_fixed_y_left;
+       gint stereo_fixed_x_right;
+       gint stereo_fixed_y_right;
+
+       RendererFuncs *renderer;
+       RendererFuncs *renderer2;
 };
 
 struct _PixbufRendererClass
 {
        GtkEventBoxClass parent_class;
 
-       void (* zoom)           (PixbufRenderer *pr, gdouble zoom);
-       void (* clicked)        (PixbufRenderer *pr, GdkEventButton *event);
-       void (* scroll_notify)  (PixbufRenderer *pr);
+       void (*zoom)(PixbufRenderer *pr, gdouble zoom);
+       void (*clicked)(PixbufRenderer *pr, GdkEventButton *event);
+       void (*scroll_notify)(PixbufRenderer *pr);
+       void (*update_pixel)(PixbufRenderer *pr);
 
-       void (* render_complete)(PixbufRenderer *pr);
+       void (*render_complete)(PixbufRenderer *pr);
+       void (*drag)(PixbufRenderer *pr, GdkEventButton *event);
 };
 
 
-GType pixbuf_renderer_get_type (void);
+
+
+GType pixbuf_renderer_get_type(void);
 
 PixbufRenderer *pixbuf_renderer_new(void);
 
@@ -154,8 +233,21 @@ GtkWindow *pixbuf_renderer_get_parent(PixbufRenderer *pr);
 /* display a pixbuf */
 
 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
+
+/* same as pixbuf_renderer_set_pixbuf but waits with redrawing for pixbuf_renderer_area_changed */
+void pixbuf_renderer_set_pixbuf_lazy(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom, gint orientation, StereoPixbufData stereo_data);
+
+
 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
 
+void pixbuf_renderer_set_orientation(PixbufRenderer *pr, gint orientation);
+gint pixbuf_renderer_get_orientation(PixbufRenderer *pr);
+
+/* sets the format of stereo data in the input pixbuf */
+void pixbuf_renderer_set_stereo_data(PixbufRenderer *pr, StereoPixbufData stereo_data);
+
+void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gboolean slow);
+
 /* display an on-request array of pixbuf tiles */
 
 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
@@ -170,6 +262,7 @@ gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
 /* move image data from source to pr, source is then set to NULL image */
 
 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
+void pixbuf_renderer_copy(PixbufRenderer *pr, PixbufRenderer *source);
 
 /* update region of existing image */
 
@@ -181,6 +274,8 @@ void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
                                     gdouble x_align, gdouble y_align);
 
+void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
+void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
 /* zoom */
 
 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
@@ -194,30 +289,77 @@ void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble ma
 
 /* sizes */
 
-gint pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
-gint pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
+gboolean pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
+gboolean pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
 
 /* region of image in pixel coordinates */
-gint pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
+gboolean pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
 
 /* actual size of the PixbufRenderer window minus borders,
  * x and y are the scroll offset and include zoom factor.
  */
-gint pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
+gboolean pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
 
 /* background color */
-
 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
-void pixbuf_renderer_set_black(PixbufRenderer *pr, gint black);
 
 /* overlay */
 
 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
-                                gint relative, gint always);
+                                OverlayRendererFlags flags);
 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
-gint pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
+gboolean pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);
 
+gboolean pixbuf_renderer_get_mouse_position(PixbufRenderer *pr, gint *x_pixel, gint *y_pixel);
+/* x_pixel and y_pixel are the pixel coordinates \see pixbuf_renderer_get_mouse_position */
+gboolean pixbuf_renderer_get_pixel_colors(PixbufRenderer *pr, gint x_pixel, gint y_pixel,
+                                       gint *r_mouse, gint *g_mouse, gint *b_mouse);
 
-#endif
+void pixbuf_renderer_set_size_early(PixbufRenderer *pr, guint width, guint height);
 
+/* stereo */
+void pixbuf_renderer_stereo_set(PixbufRenderer *pr, gint stereo_mode);
+gint pixbuf_renderer_stereo_get(PixbufRenderer *pr);
+void pixbuf_renderer_stereo_fixed_set(PixbufRenderer *pr, gint width, gint height, gint x1, gint y1, gint x2, gint y2);
+
+/* protected - for renderer use only*/
+
+typedef struct _SourceTile SourceTile;
+struct _SourceTile
+{
+       gint x;
+       gint y;
+       GdkPixbuf *pixbuf;
+       gboolean blank;
+};
+
+
+gboolean pr_clip_region(gint x, gint y, gint w, gint h,
+                              gint clip_x, gint clip_y, gint clip_w, gint clip_h,
+                              gint *rx, gint *ry, gint *rw, gint *rh);
+void pr_render_complete_signal(PixbufRenderer *pr);
+
+void pr_tile_coords_map_orientation(gint orientation,
+                                    gdouble tile_x, gdouble tile_y, /* coordinates of the tile */
+                                    gdouble image_w, gdouble image_h,
+                                    gdouble tile_w, gdouble tile_h,
+                                    gdouble *res_x, gdouble *res_y);
+void pr_tile_region_map_orientation(gint orientation,
+                                    gint area_x, gint area_y, /* coordinates of the area inside tile */
+                                    gint tile_w, gint tile_h,
+                                    gint area_w, gint area_h,
+                                    gint *res_x, gint *res_y,
+                                    gint *res_w, gint *res_h);
+void pr_coords_map_orientation_reverse(gint orientation,
+                                    gint area_x, gint area_y,
+                                    gint tile_w, gint tile_h,
+                                    gint area_w, gint area_h,
+                                    gint *res_x, gint *res_y,
+                                    gint *res_w, gint *res_h);
+
+GList *pr_source_tile_compute_region(PixbufRenderer *pr, gint x, gint y, gint w, gint h, gboolean request);
+
+void pr_create_anaglyph(guint mode, GdkPixbuf *pixbuf, GdkPixbuf *right, gint x, gint y, gint w, gint h);
+#endif
+/* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */