2 * Copyright (C) 2006 John Ellis
3 * Copyright (C) 2008 - 2016 The Geeqie Team
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.
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.
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.
28 #include "pixbuf-renderer.h"
29 #include "renderer-clutter.h"
39 #define COGL_ENABLE_EXPERIMENTAL_API
40 #define CLUTTER_ENABLE_EXPERIMENTAL_API
42 #include <clutter/clutter.h>
44 #include <clutter-gtk/clutter-gtk.h>
52 #include "pixbuf_util.h"
56 EXIF_ORIENTATION_UNKNOWN = 0,
57 EXIF_ORIENTATION_TOP_LEFT = 1,
58 EXIF_ORIENTATION_TOP_RIGHT = 2,
59 EXIF_ORIENTATION_BOTTOM_RIGHT = 3,
60 EXIF_ORIENTATION_BOTTOM_LEFT = 4,
61 EXIF_ORIENTATION_LEFT_TOP = 5,
62 EXIF_ORIENTATION_RIGHT_TOP = 6,
63 EXIF_ORIENTATION_RIGHT_BOTTOM = 7,
64 EXIF_ORIENTATION_LEFT_BOTTOM = 8
65 } ExifOrientationType;
68 #define GET_RIGHT_PIXBUF_OFFSET(rc) \
69 (( (rc->stereo_mode & PR_STEREO_RIGHT) && !(rc->stereo_mode & PR_STEREO_SWAP)) || \
70 (!(rc->stereo_mode & PR_STEREO_RIGHT) && (rc->stereo_mode & PR_STEREO_SWAP)) ? \
71 rc->pr->stereo_pixbuf_offset_right : rc->pr->stereo_pixbuf_offset_left )
73 #define GET_LEFT_PIXBUF_OFFSET(rc) \
74 ((!(rc->stereo_mode & PR_STEREO_RIGHT) && !(rc->stereo_mode & PR_STEREO_SWAP)) || \
75 ( (rc->stereo_mode & PR_STEREO_RIGHT) && (rc->stereo_mode & PR_STEREO_SWAP)) ? \
76 rc->pr->stereo_pixbuf_offset_right : rc->pr->stereo_pixbuf_offset_left )
79 typedef struct _OverlayData OverlayData;
90 OverlayRendererFlags flags;
93 typedef struct _RendererClutter RendererClutter;
95 struct _RendererClutter
106 GList *pending_updates;
111 GtkWidget *widget; /* widget and stage may be shared with other renderers */
113 ClutterActor *texture;
116 gboolean clut_updated;
117 gint64 last_pixbuf_change;
119 GdkPixbuf *display_pixbuf;
122 typedef struct _RendererClutterAreaParam RendererClutterAreaParam;
123 struct _RendererClutterAreaParam {
131 static void rc_sync_actor(RendererClutter *rc)
133 PixbufRenderer *pr = rc->pr;
139 clutter_actor_set_anchor_point(CLUTTER_ACTOR(rc->texture), 0, 0);
141 DEBUG_3("scale %d %d", rc->pr->width, rc->pr->height);
142 DEBUG_3("pos %d %d", rc->pr->x_offset, rc->pr->y_offset);
144 clutter_actor_set_scale(CLUTTER_ACTOR(rc->texture),
145 (gfloat)pr->width / pr->image_width,
146 (gfloat)pr->height / pr->image_height);
148 switch (pr->orientation)
150 case EXIF_ORIENTATION_TOP_LEFT:
151 /* 1 - Horizontal (normal) */
153 case EXIF_ORIENTATION_TOP_RIGHT:
154 /* 2 - Mirror horizontal */
156 anchor_x = pr->width;
158 case EXIF_ORIENTATION_BOTTOM_RIGHT:
161 anchor_x = pr->width;
162 anchor_y = pr->height;
164 case EXIF_ORIENTATION_BOTTOM_LEFT:
165 /* 4 - Mirror vertical */
168 anchor_y = pr->height;
170 case EXIF_ORIENTATION_LEFT_TOP:
171 /* 5 - Mirror horizontal and rotate 270 CW */
175 case EXIF_ORIENTATION_RIGHT_TOP:
176 /* 6 - Rotate 90 CW */
178 anchor_x = pr->width;
180 case EXIF_ORIENTATION_RIGHT_BOTTOM:
181 /* 7 - Mirror horizontal and rotate 90 CW */
184 anchor_x = pr->width;
185 anchor_y = pr->height;
187 case EXIF_ORIENTATION_LEFT_BOTTOM:
188 /* 8 - Rotate 270 CW */
190 anchor_y = pr->height;
193 /* The other values are out of range */
197 clutter_actor_set_rotation( CLUTTER_ACTOR(rc->texture),
200 clutter_actor_set_rotation( CLUTTER_ACTOR(rc->texture),
204 clutter_actor_set_position(CLUTTER_ACTOR(rc->texture),
205 pr->x_offset - pr->x_scroll + anchor_x,
206 pr->y_offset - pr->y_scroll + anchor_y);
211 static void rc_area_clip_add(RendererClutter *rc, gfloat x, gfloat y, gfloat w, gfloat h)
214 gfloat clip_x, clip_y, clip_w, clip_h, clip_x2, clip_y2;
219 clutter_actor_get_clip(rc->texture, &clip_x, &clip_y, &clip_w, &clip_h);
221 clip_x2 = clip_x + clip_w;
222 clip_y2 = clip_y + clip_h;
224 if (clip_x > x) clip_x = x;
225 if (clip_x2 < x2) clip_x2 = x2;
226 if (clip_y > y) clip_y = y;
227 if (clip_y2 < y2) clip_y2 = y2;
229 clip_w = clip_x2 - clip_x;
230 clip_h = clip_y2 - clip_y;
232 clutter_actor_set_clip(rc->texture, clip_x, clip_y, clip_w, clip_h);
235 #define MAX_REGION_AREA (32768 * 1024)
237 static gboolean rc_area_changed_cb(gpointer data);
239 static void rc_schedule_texture_upload(RendererClutter *rc)
241 if (g_get_monotonic_time() - rc->last_pixbuf_change < 50000)
243 /* delay clutter redraw until the texture has some data
244 set priority between gtk redraw and clutter redraw */
245 DEBUG_3("%s tex upload high prio", get_exec_time());
246 rc->idle_update = g_idle_add_full(CLUTTER_PRIORITY_REDRAW - 10, rc_area_changed_cb, rc, NULL);
250 /* higher prio than histogram */
251 DEBUG_3("%s tex upload low prio", get_exec_time());
253 rc->idle_update = g_idle_add_full(G_PRIORITY_DEFAULT_IDLE - 5, rc_area_changed_cb, rc, NULL);
257 static void update_display_pixbuf(RendererClutter *rc);
259 static gboolean rc_area_changed_cb(gpointer data)
261 RendererClutter *rc = (RendererClutter *)data;
262 PixbufRenderer *pr = rc->pr;
264 RendererClutterAreaParam *par = rc->pending_updates->data;
266 gint h = MAX_REGION_AREA / par->w;
268 if (h > par->h) h = par->h;
272 CoglHandle texture = clutter_texture_get_cogl_texture(CLUTTER_TEXTURE(rc->texture));
274 cogl_texture_set_region(texture,
275 par->x + GET_RIGHT_PIXBUF_OFFSET(rc),
283 gdk_pixbuf_get_has_alpha(pr->pixbuf) ? COGL_PIXEL_FORMAT_RGBA_8888 : COGL_PIXEL_FORMAT_RGB_888,
284 gdk_pixbuf_get_rowstride(pr->pixbuf),
285 gdk_pixbuf_get_pixels(pr->pixbuf));
287 rc_area_clip_add(rc, par->x, par->y, par->w, h);
295 rc->pending_updates = g_list_remove(rc->pending_updates, par);
298 if (!rc->pending_updates)
300 clutter_actor_queue_redraw(CLUTTER_ACTOR(rc->texture));
303 update_display_pixbuf(rc);
305 if (pr->func_post_process)
307 pr->func_post_process(pr, &rc->display_pixbuf, 0, 0, gdk_pixbuf_get_width(pr->pixbuf), gdk_pixbuf_get_height(pr->pixbuf), pr->post_process_user_data);
312 CoglHandle texture = clutter_texture_get_cogl_texture(CLUTTER_TEXTURE(rc->texture));
314 cogl_texture_set_region(texture,
315 0 + GET_RIGHT_PIXBUF_OFFSET(rc),
319 gdk_pixbuf_get_width(pr->pixbuf),
320 gdk_pixbuf_get_height(pr->pixbuf),
321 gdk_pixbuf_get_width(pr->pixbuf),
322 gdk_pixbuf_get_height(pr->pixbuf),
323 gdk_pixbuf_get_has_alpha(pr->pixbuf) ? COGL_PIXEL_FORMAT_RGBA_8888 : COGL_PIXEL_FORMAT_RGB_888,
324 gdk_pixbuf_get_rowstride(pr->pixbuf),
325 gdk_pixbuf_get_pixels(rc->display_pixbuf));
326 DEBUG_3("%s upload end", get_exec_time());
332 rc_schedule_texture_upload(rc);
334 return FALSE; /* it was rescheduled, possibly with different prio */
338 static void rc_area_changed(void *renderer, gint src_x, gint src_y, gint src_w, gint src_h)
340 RendererClutter *rc = (RendererClutter *)renderer;
341 PixbufRenderer *pr = rc->pr;
342 RendererClutterAreaParam *par;
344 gint width = gdk_pixbuf_get_width(pr->pixbuf);
345 gint height = gdk_pixbuf_get_height(pr->pixbuf);
347 if (pr->stereo_data == STEREO_PIXBUF_SBS || pr->stereo_data == STEREO_PIXBUF_CROSS)
352 if (!pr_clip_region(src_x, src_y, src_w, src_h,
353 GET_RIGHT_PIXBUF_OFFSET(rc), 0, width, height,
354 &src_x, &src_y, &src_w, &src_h)) return;
356 par = g_new0(RendererClutterAreaParam, 1);
358 par->x = src_x - GET_RIGHT_PIXBUF_OFFSET(rc);
362 rc->pending_updates = g_list_append(rc->pending_updates, par);
363 if (!rc->idle_update)
365 rc_schedule_texture_upload(rc);
369 static void rc_remove_pending_updates(RendererClutter *rc)
371 if (rc->idle_update) g_idle_remove_by_data(rc);
373 while (rc->pending_updates)
375 RendererClutterAreaParam *par = rc->pending_updates->data;
376 rc->pending_updates = g_list_remove(rc->pending_updates, par);
381 static void update_display_pixbuf(RendererClutter *rc)
383 PixbufRenderer *pr = rc->pr;
384 GdkPixbuf* tmppixbuf = NULL;
388 if (rc->display_pixbuf)
390 g_object_unref(rc->display_pixbuf);
393 if (!gdk_pixbuf_get_has_alpha(pr->pixbuf))
395 rc->display_pixbuf = gdk_pixbuf_copy(pr->pixbuf);
399 if (pr->ignore_alpha)
401 tmppixbuf = gdk_pixbuf_add_alpha(pr->pixbuf, FALSE, 0, 0, 0);
403 pixbuf_ignore_alpha_rect(tmppixbuf, 0, 0, gdk_pixbuf_get_width(pr->pixbuf), gdk_pixbuf_get_height(pr->pixbuf));
405 rc->display_pixbuf = gdk_pixbuf_composite_color_simple (tmppixbuf,
406 gdk_pixbuf_get_width(pr->pixbuf),
407 gdk_pixbuf_get_height(pr->pixbuf),
411 ((options->image.alpha_color_1.red << 8 & 0x00FF0000) +
412 (options->image.alpha_color_1.green & 0x00FF00) +
413 (options->image.alpha_color_1.blue >> 8 & 0x00FF)),
414 ((options->image.alpha_color_2.red << 8 & 0x00FF0000) +
415 (options->image.alpha_color_2.green & 0x00FF00) +
416 (options->image.alpha_color_2.blue >> 8 & 0x00FF)));
417 g_object_unref(tmppixbuf);
421 rc->display_pixbuf = gdk_pixbuf_composite_color_simple (pr->pixbuf,
422 gdk_pixbuf_get_width(pr->pixbuf),
423 gdk_pixbuf_get_height(pr->pixbuf),
427 ((options->image.alpha_color_1.red << 8 & 0x00FF0000) +
428 (options->image.alpha_color_1.green & 0x00FF00) +
429 (options->image.alpha_color_1.blue >> 8 & 0x00FF)),
430 ((options->image.alpha_color_2.red << 8 & 0x00FF0000) +
431 (options->image.alpha_color_2.green & 0x00FF00) +
432 (options->image.alpha_color_2.blue >> 8 & 0x00FF)));
438 static void rc_update_pixbuf(void *renderer, gboolean lazy)
440 RendererClutter *rc = (RendererClutter *)renderer;
441 PixbufRenderer *pr = rc->pr;
443 DEBUG_3("rc_update_pixbuf");
445 rc_remove_pending_updates(rc);
447 rc->last_pixbuf_change = g_get_monotonic_time();
448 DEBUG_3("%s change time reset", get_exec_time());
452 gint width = gdk_pixbuf_get_width(pr->pixbuf);
453 gint height = gdk_pixbuf_get_height(pr->pixbuf);
455 DEBUG_3("pixbuf size %d x %d (%d)", width, height, gdk_pixbuf_get_has_alpha(pr->pixbuf) ? 32 : 24);
457 gint prev_width, prev_height;
459 if (pr->stereo_data == STEREO_PIXBUF_SBS || pr->stereo_data == STEREO_PIXBUF_CROSS)
465 clutter_texture_get_base_size(CLUTTER_TEXTURE(rc->texture), &prev_width, &prev_height);
467 if (width != prev_width || height != prev_height)
469 /* FIXME use CoglMaterial with multiple textures for background, color management, anaglyph, ... */
470 CoglHandle texture = cogl_texture_new_with_size(width,
472 COGL_TEXTURE_NO_AUTO_MIPMAP,
473 gdk_pixbuf_get_has_alpha(pr->pixbuf) ? COGL_PIXEL_FORMAT_RGBA_8888 : COGL_PIXEL_FORMAT_RGB_888);
475 if (texture != COGL_INVALID_HANDLE)
477 clutter_texture_set_cogl_texture(CLUTTER_TEXTURE(rc->texture), texture);
478 cogl_handle_unref(texture);
481 clutter_actor_set_clip(rc->texture, 0, 0, 0, 0); /* visible area is extended as area_changed events arrive */
484 rc_area_changed(renderer, GET_RIGHT_PIXBUF_OFFSET(rc), 0, width, height);
487 rc->clut_updated = FALSE;
493 static void rc_update_zoom(void *renderer, gboolean lazy)
495 RendererClutter *rc = (RendererClutter *)renderer;
497 DEBUG_3("rc_update_zoom");
501 static void rc_invalidate_region(void *renderer, gint x, gint y, gint w, gint h)
505 static OverlayData *rc_overlay_find(RendererClutter *rc, gint id)
509 work = rc->overlay_list;
512 OverlayData *od = work->data;
515 if (od->id == id) return od;
521 static void rc_overlay_actor_destroy_cb(ClutterActor *actor, gpointer user_data)
523 OverlayData *od = user_data;
527 static void rc_overlay_free(RendererClutter *rc, OverlayData *od)
529 rc->overlay_list = g_list_remove(rc->overlay_list, od);
531 if (od->pixbuf) g_object_unref(G_OBJECT(od->pixbuf));
532 if (od->actor) clutter_actor_destroy(od->actor);
536 static void rc_overlay_update_position(RendererClutter *rc, OverlayData *od)
540 pw = gdk_pixbuf_get_width(od->pixbuf);
541 ph = gdk_pixbuf_get_height(od->pixbuf);
545 if (od->flags & OVL_RELATIVE)
547 if (px < 0) px = rc->pr->viewport_width - pw + px;
548 if (py < 0) py = rc->pr->viewport_height - ph + py;
550 if (od->actor) clutter_actor_set_position(od->actor, px, py);
553 static void rc_overlay_update_positions(RendererClutter *rc)
557 work = rc->overlay_list;
560 OverlayData *od = work->data;
563 rc_overlay_update_position(rc, od);
567 static void rc_overlay_free_all(RendererClutter *rc)
571 work = rc->overlay_list;
574 OverlayData *od = work->data;
577 rc_overlay_free(rc, od);
581 static gint rc_overlay_add(void *renderer, GdkPixbuf *pixbuf, gint x, gint y, OverlayRendererFlags flags)
583 RendererClutter *rc = (RendererClutter *)renderer;
584 PixbufRenderer *pr = rc->pr;
588 g_return_val_if_fail(IS_PIXBUF_RENDERER(pr), -1);
589 g_return_val_if_fail(pixbuf != NULL, -1);
592 while (rc_overlay_find(rc, id)) id++;
594 od = g_new0(OverlayData, 1);
597 g_object_ref(G_OBJECT(od->pixbuf));
602 od->actor = gtk_clutter_texture_new();
603 g_signal_connect (od->actor, "destroy", G_CALLBACK(rc_overlay_actor_destroy_cb), od);
605 gtk_clutter_texture_set_from_pixbuf(GTK_CLUTTER_TEXTURE (od->actor), pixbuf, NULL);
606 clutter_container_add_actor(CLUTTER_CONTAINER(rc->group), od->actor);
608 rc->overlay_list = g_list_append(rc->overlay_list, od);
609 rc_overlay_update_position(rc, od);
614 static void rc_overlay_set(void *renderer, gint id, GdkPixbuf *pixbuf, gint x, gint y)
616 RendererClutter *rc = (RendererClutter *)renderer;
617 PixbufRenderer *pr = rc->pr;
620 g_return_if_fail(IS_PIXBUF_RENDERER(pr));
622 od = rc_overlay_find(rc, id);
627 g_object_ref(G_OBJECT(pixbuf));
628 g_object_unref(G_OBJECT(od->pixbuf));
634 if (od->actor) gtk_clutter_texture_set_from_pixbuf(GTK_CLUTTER_TEXTURE(od->actor), pixbuf, NULL);
635 rc_overlay_update_position(rc, od);
639 rc_overlay_free(rc, od);
643 static gboolean rc_overlay_get(void *renderer, gint id, GdkPixbuf **pixbuf, gint *x, gint *y)
645 RendererClutter *rc = (RendererClutter *)renderer;
647 PixbufRenderer *pr = rc->pr;
650 g_return_val_if_fail(IS_PIXBUF_RENDERER(pr), FALSE);
652 od = rc_overlay_find(rc, id);
653 if (!od) return FALSE;
655 if (pixbuf) *pixbuf = od->pixbuf;
663 static void rc_update_viewport(void *renderer)
665 RendererClutter *rc = (RendererClutter *)renderer;
666 ClutterColor stage_color = { rc->pr->color.red / 256, rc->pr->color.green / 256, rc->pr->color.blue / 256, 0xff };
668 rc->stereo_off_x = 0;
669 rc->stereo_off_y = 0;
671 if (rc->stereo_mode & PR_STEREO_RIGHT)
673 if (rc->stereo_mode & PR_STEREO_HORIZ)
675 rc->stereo_off_x = rc->pr->viewport_width;
677 else if (rc->stereo_mode & PR_STEREO_VERT)
679 rc->stereo_off_y = rc->pr->viewport_height;
681 else if (rc->stereo_mode & PR_STEREO_FIXED)
683 rc->stereo_off_x = rc->pr->stereo_fixed_x_right;
684 rc->stereo_off_y = rc->pr->stereo_fixed_y_right;
689 if (rc->stereo_mode & PR_STEREO_FIXED)
691 rc->stereo_off_x = rc->pr->stereo_fixed_x_left;
692 rc->stereo_off_y = rc->pr->stereo_fixed_y_left;
695 DEBUG_3("rc_update_viewport scale %d %d", rc->pr->width, rc->pr->height);
697 clutter_stage_set_color(CLUTTER_STAGE(rc->stage), &stage_color);
700 clutter_actor_set_size(rc->group, rc->pr->viewport_width, rc->pr->viewport_height);
701 clutter_actor_set_position(rc->group, rc->stereo_off_x, rc->stereo_off_y);
703 clutter_actor_set_rotation(CLUTTER_ACTOR(rc->group),
705 (rc->stereo_mode & PR_STEREO_MIRROR) ? 180 : 0,
706 rc->pr->viewport_width / 2.0, 0, 0);
708 clutter_actor_set_rotation(CLUTTER_ACTOR(rc->group),
710 (rc->stereo_mode & PR_STEREO_FLIP) ? 180 : 0,
711 0, rc->pr->viewport_height / 2.0, 0);
714 rc_overlay_update_positions(rc);
717 static void rc_scroll(void *renderer, gint x_off, gint y_off)
719 DEBUG_3("rc_scroll");
720 RendererClutter *rc = (RendererClutter *)renderer;
725 static void rc_stereo_set(void *renderer, gint stereo_mode)
727 RendererClutter *rc = (RendererClutter *)renderer;
729 rc->stereo_mode = stereo_mode;
732 static void rc_free(void *renderer)
734 RendererClutter *rc = (RendererClutter *)renderer;
735 GtkWidget *widget = gtk_bin_get_child(GTK_BIN(rc->pr));
737 if (rc->display_pixbuf)
739 g_object_unref(rc->display_pixbuf);
742 rc_remove_pending_updates(rc);
744 rc_overlay_free_all(rc);
748 /* widget still exists */
749 clutter_actor_destroy(rc->group);
750 if (clutter_group_get_n_children(CLUTTER_GROUP(rc->stage)) == 0)
752 DEBUG_1("destroy %p", rc->widget);
753 /* this was the last user */
754 gtk_widget_destroy(rc->widget);
758 DEBUG_1("keep %p", rc->widget);
759 g_object_unref(G_OBJECT(rc->widget));
765 RendererFuncs *renderer_clutter_new(PixbufRenderer *pr)
767 RendererClutter *rc = g_new0(RendererClutter, 1);
771 rc->f.area_changed = rc_area_changed;
772 rc->f.update_pixbuf = rc_update_pixbuf;
773 rc->f.free = rc_free;
774 rc->f.update_zoom = rc_update_zoom;
775 rc->f.invalidate_region = rc_invalidate_region;
776 rc->f.scroll = rc_scroll;
777 rc->f.update_viewport = rc_update_viewport;
780 rc->f.overlay_add = rc_overlay_add;
781 rc->f.overlay_set = rc_overlay_set;
782 rc->f.overlay_get = rc_overlay_get;
784 rc->f.stereo_set = rc_stereo_set;
788 rc->stereo_off_x = 0;
789 rc->stereo_off_y = 0;
792 rc->pending_updates = NULL;
794 rc->display_pixbuf = NULL;
796 rc->widget = gtk_bin_get_child(GTK_BIN(rc->pr));
800 if (!GTK_CLUTTER_IS_EMBED(rc->widget))
803 DEBUG_3("pixbuf renderer has a child of other type than gtk_clutter_embed");
809 rc->widget = gtk_clutter_embed_new();
810 gtk_container_add(GTK_CONTAINER(rc->pr), rc->widget);
813 gtk_event_box_set_above_child (GTK_EVENT_BOX(rc->pr), TRUE);
814 rc->stage = gtk_clutter_embed_get_stage (GTK_CLUTTER_EMBED (rc->widget));
816 rc->group = clutter_group_new();
817 clutter_container_add_actor(CLUTTER_CONTAINER(rc->stage), rc->group);
818 clutter_actor_set_clip_to_allocation(CLUTTER_ACTOR(rc->group), TRUE);
820 rc->texture = clutter_texture_new ();
821 clutter_container_add_actor(CLUTTER_CONTAINER(rc->group), rc->texture);
823 clutter_actor_set_content_scaling_filters(rc->texture, CLUTTER_SCALING_FILTER_TRILINEAR, CLUTTER_SCALING_FILTER_NEAREST);
825 g_object_ref(G_OBJECT(rc->widget));
827 gtk_widget_show(rc->widget);
828 return (RendererFuncs *) rc;
832 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */