/* * Clutter. * * An OpenGL based 'interactive canvas' library. * * Copyright (C) 2007,2008,2009,2010,2011 Intel Corporation. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library. If not, see . * Authors: * Matthew Allum * Robert Bragg * Neil Roberts * Emmanuele Bassi */ #include "config.h" #include "backends/meta-stage-impl-private.h" #include #include #include "backends/meta-stage-view-private.h" #include "clutter/clutter-mutter.h" #include "cogl/cogl.h" #include "core/util-private.h" #define MAX_STACK_RECTS 256 typedef struct _MetaStageImplPrivate { int64_t global_frame_counter; } MetaStageImplPrivate; static void clutter_stage_window_iface_init (ClutterStageWindowInterface *iface); G_DEFINE_TYPE_WITH_CODE (MetaStageImpl, meta_stage_impl, G_TYPE_OBJECT, G_ADD_PRIVATE (MetaStageImpl) G_IMPLEMENT_INTERFACE (CLUTTER_TYPE_STAGE_WINDOW, clutter_stage_window_iface_init)); enum { PROP_0, PROP_WRAPPER, PROP_BACKEND, PROP_LAST }; static void meta_stage_impl_unrealize (ClutterStageWindow *stage_window) { meta_topic (META_DEBUG_BACKEND, "Unrealizing Cogl stage [%p]", stage_window); } static gboolean meta_stage_impl_realize (ClutterStageWindow *stage_window) { ClutterBackend *backend; meta_topic (META_DEBUG_BACKEND, "Realizing stage '%s' [%p]", G_OBJECT_TYPE_NAME (stage_window), stage_window); backend = clutter_get_default_backend (); if (backend->cogl_context == NULL) { g_warning ("Failed to realize stage: missing Cogl context"); return FALSE; } return TRUE; } static int64_t meta_stage_impl_get_frame_counter (ClutterStageWindow *stage_window) { MetaStageImpl *stage_impl = META_STAGE_IMPL (stage_window); MetaStageImplPrivate *priv = meta_stage_impl_get_instance_private (stage_impl); return priv->global_frame_counter; } static ClutterActor * meta_stage_impl_get_wrapper (ClutterStageWindow *stage_window) { return CLUTTER_ACTOR (META_STAGE_IMPL (stage_window)->wrapper); } static void meta_stage_impl_show (ClutterStageWindow *stage_window, gboolean do_raise) { MetaStageImpl *stage_impl = META_STAGE_IMPL (stage_window); clutter_actor_map (CLUTTER_ACTOR (stage_impl->wrapper)); } static void meta_stage_impl_hide (ClutterStageWindow *stage_window) { MetaStageImpl *stage_impl = META_STAGE_IMPL (stage_window); clutter_actor_unmap (CLUTTER_ACTOR (stage_impl->wrapper)); } static void meta_stage_impl_resize (ClutterStageWindow *stage_window, gint width, gint height) { } static void paint_damage_region (ClutterStageWindow *stage_window, ClutterStageView *view, cairo_region_t *swap_region, cairo_region_t *queued_redraw_clip) { CoglFramebuffer *framebuffer = clutter_stage_view_get_framebuffer (view); CoglContext *ctx = cogl_framebuffer_get_context (framebuffer); static CoglPipeline *overlay_blue = NULL; MetaStageImpl *stage_impl = META_STAGE_IMPL (stage_window); ClutterActor *actor = CLUTTER_ACTOR (stage_impl->wrapper); graphene_matrix_t transform; int n_rects, i; cogl_framebuffer_push_matrix (framebuffer); clutter_actor_get_transform (actor, &transform); cogl_framebuffer_transform (framebuffer, &transform); /* Blue for the swap region */ if (G_UNLIKELY (overlay_blue == NULL)) { overlay_blue = cogl_pipeline_new (ctx); cogl_pipeline_set_color4ub (overlay_blue, 0x00, 0x00, 0x33, 0x33); } n_rects = cairo_region_num_rectangles (swap_region); for (i = 0; i < n_rects; i++) { cairo_rectangle_int_t rect; float x_1, x_2, y_1, y_2; cairo_region_get_rectangle (swap_region, i, &rect); x_1 = rect.x; x_2 = rect.x + rect.width; y_1 = rect.y; y_2 = rect.y + rect.height; cogl_framebuffer_draw_rectangle (framebuffer, overlay_blue, x_1, y_1, x_2, y_2); } /* Red for the clip */ if (queued_redraw_clip) { static CoglPipeline *overlay_red = NULL; if (G_UNLIKELY (overlay_red == NULL)) { overlay_red = cogl_pipeline_new (ctx); cogl_pipeline_set_color4ub (overlay_red, 0x33, 0x00, 0x00, 0x33); } n_rects = cairo_region_num_rectangles (queued_redraw_clip); for (i = 0; i < n_rects; i++) { cairo_rectangle_int_t rect; float x_1, x_2, y_1, y_2; cairo_region_get_rectangle (queued_redraw_clip, i, &rect); x_1 = rect.x; x_2 = rect.x + rect.width; y_1 = rect.y; y_2 = rect.y + rect.height; cogl_framebuffer_draw_rectangle (framebuffer, overlay_red, x_1, y_1, x_2, y_2); } } cogl_framebuffer_pop_matrix (framebuffer); } static void swap_framebuffer (ClutterStageWindow *stage_window, ClutterStageView *stage_view, cairo_region_t *swap_region, gboolean swap_with_damage, ClutterFrame *frame) { MetaStageImpl *stage_impl = META_STAGE_IMPL (stage_window); MetaStageImplPrivate *priv = meta_stage_impl_get_instance_private (stage_impl); CoglFramebuffer *framebuffer = clutter_stage_view_get_onscreen (stage_view); CoglContext *cogl_context = cogl_framebuffer_get_context (framebuffer); clutter_stage_view_before_swap_buffer (stage_view, swap_region); if (COGL_IS_ONSCREEN (framebuffer)) { CoglOnscreen *onscreen = COGL_ONSCREEN (framebuffer); int *damage, n_rects, i; CoglFrameInfo *frame_info; n_rects = cairo_region_num_rectangles (swap_region); damage = g_newa (int, n_rects * 4); for (i = 0; i < n_rects; i++) { cairo_rectangle_int_t rect; cairo_region_get_rectangle (swap_region, i, &rect); damage[i * 4] = rect.x; damage[i * 4 + 1] = rect.y; damage[i * 4 + 2] = rect.width; damage[i * 4 + 3] = rect.height; } frame_info = cogl_frame_info_new (cogl_context, priv->global_frame_counter); priv->global_frame_counter++; /* push on the screen */ if (n_rects > 0 && !swap_with_damage) { meta_topic (META_DEBUG_BACKEND, "cogl_onscreen_swap_region (onscreen: %p)", onscreen); cogl_onscreen_swap_region (onscreen, damage, n_rects, frame_info, frame); } else { meta_topic (META_DEBUG_BACKEND, "cogl_onscreen_swap_buffers (onscreen: %p)", onscreen); cogl_onscreen_swap_buffers_with_damage (onscreen, damage, n_rects, frame_info, frame); } } else { MetaStageView *view = META_STAGE_VIEW (stage_view); meta_topic (META_DEBUG_BACKEND, "fake offscreen swap (framebuffer: %p)", framebuffer); meta_stage_view_perform_fake_swap (view, priv->global_frame_counter); priv->global_frame_counter++; } } static cairo_region_t * offset_scale_and_clamp_region (const cairo_region_t *region, int offset_x, int offset_y, float scale) { int n_rects, i; cairo_rectangle_int_t *rects; g_autofree cairo_rectangle_int_t *freeme = NULL; n_rects = cairo_region_num_rectangles (region); if (n_rects == 0) return cairo_region_create (); if (n_rects < MAX_STACK_RECTS) rects = g_newa (cairo_rectangle_int_t, n_rects); else rects = freeme = g_new (cairo_rectangle_int_t, n_rects); for (i = 0; i < n_rects; i++) { cairo_rectangle_int_t *rect = &rects[i]; graphene_rect_t tmp; cairo_region_get_rectangle (region, i, rect); _clutter_util_rect_from_rectangle (rect, &tmp); graphene_rect_offset (&tmp, offset_x, offset_y); graphene_rect_scale (&tmp, scale, scale, &tmp); _clutter_util_rectangle_int_extents (&tmp, rect); } return cairo_region_create_rectangles (rects, n_rects); } static cairo_region_t * scale_offset_and_clamp_region (const cairo_region_t *region, float scale, int offset_x, int offset_y) { int n_rects, i; cairo_rectangle_int_t *rects; g_autofree cairo_rectangle_int_t *freeme = NULL; n_rects = cairo_region_num_rectangles (region); if (n_rects == 0) return cairo_region_create (); if (n_rects < MAX_STACK_RECTS) rects = g_newa (cairo_rectangle_int_t, n_rects); else rects = freeme = g_new (cairo_rectangle_int_t, n_rects); for (i = 0; i < n_rects; i++) { cairo_rectangle_int_t *rect = &rects[i]; graphene_rect_t tmp; cairo_region_get_rectangle (region, i, rect); _clutter_util_rect_from_rectangle (rect, &tmp); graphene_rect_scale (&tmp, scale, scale, &tmp); graphene_rect_offset (&tmp, offset_x, offset_y); _clutter_util_rectangle_int_extents (&tmp, rect); } return cairo_region_create_rectangles (rects, n_rects); } static void paint_stage (MetaStageImpl *stage_impl, ClutterStageView *stage_view, cairo_region_t *redraw_clip) { ClutterStage *stage = stage_impl->wrapper; _clutter_stage_maybe_setup_viewport (stage, stage_view); clutter_stage_paint_view (stage, stage_view, redraw_clip); clutter_stage_view_after_paint (stage_view, redraw_clip); } static cairo_region_t * transform_swap_region_to_onscreen (ClutterStageView *stage_view, cairo_region_t *swap_region) { CoglFramebuffer *onscreen = clutter_stage_view_get_onscreen (stage_view); int n_rects, i; cairo_rectangle_int_t *rects; cairo_region_t *transformed_region; int width, height; width = cogl_framebuffer_get_width (onscreen); height = cogl_framebuffer_get_height (onscreen); n_rects = cairo_region_num_rectangles (swap_region); rects = g_newa (cairo_rectangle_int_t, n_rects); for (i = 0; i < n_rects; i++) { cairo_region_get_rectangle (swap_region, i, &rects[i]); clutter_stage_view_transform_rect_to_onscreen (stage_view, &rects[i], width, height, &rects[i]); } transformed_region = cairo_region_create_rectangles (rects, n_rects); return transformed_region; } static void meta_stage_impl_redraw_view_primary (MetaStageImpl *stage_impl, ClutterStageView *stage_view, ClutterFrame *frame) { ClutterStageWindow *stage_window = CLUTTER_STAGE_WINDOW (stage_impl); MetaStageView *view = META_STAGE_VIEW (stage_view); CoglFramebuffer *fb = clutter_stage_view_get_framebuffer (stage_view); CoglFramebuffer *onscreen = clutter_stage_view_get_onscreen (stage_view); cairo_rectangle_int_t view_rect; gboolean is_full_redraw; gboolean use_clipped_redraw = TRUE; gboolean can_blit_sub_buffer; gboolean has_buffer_age; gboolean swap_with_damage; cairo_region_t *redraw_clip; cairo_region_t *queued_redraw_clip = NULL; cairo_region_t *fb_clip_region; cairo_region_t *swap_region; ClutterDrawDebugFlag paint_debug_flags; ClutterDamageHistory *damage_history; float fb_scale; int fb_width, fb_height; int buffer_age = 0; clutter_stage_view_get_layout (stage_view, &view_rect); fb_scale = clutter_stage_view_get_scale (stage_view); fb_width = cogl_framebuffer_get_width (fb); fb_height = cogl_framebuffer_get_height (fb); can_blit_sub_buffer = COGL_IS_ONSCREEN (onscreen) && cogl_clutter_winsys_has_feature (COGL_WINSYS_FEATURE_SWAP_REGION); has_buffer_age = COGL_IS_ONSCREEN (onscreen) && cogl_clutter_winsys_has_feature (COGL_WINSYS_FEATURE_BUFFER_AGE); redraw_clip = clutter_stage_view_take_redraw_clip (stage_view); /* NB: a NULL redraw clip == full stage redraw */ if (!redraw_clip) is_full_redraw = TRUE; else is_full_redraw = FALSE; damage_history = meta_stage_view_get_damage_history (view); if (has_buffer_age) { buffer_age = cogl_onscreen_get_buffer_age (COGL_ONSCREEN (onscreen)); if (!clutter_damage_history_is_age_valid (damage_history, buffer_age)) { meta_topic (META_DEBUG_BACKEND, "Invalid back buffer(age=%d): forcing full redraw", buffer_age); use_clipped_redraw = FALSE; } } meta_get_clutter_debug_flags (NULL, &paint_debug_flags, NULL); use_clipped_redraw = use_clipped_redraw && !(paint_debug_flags & CLUTTER_DEBUG_DISABLE_CLIPPED_REDRAWS) && _clutter_stage_window_can_clip_redraws (stage_window) && (can_blit_sub_buffer || has_buffer_age) && !is_full_redraw && /* some drivers struggle to get going and produce some junk * frames when starting up... */ cogl_onscreen_get_frame_counter (COGL_ONSCREEN (onscreen)) > 3; if (use_clipped_redraw) { fb_clip_region = offset_scale_and_clamp_region (redraw_clip, -view_rect.x, -view_rect.y, fb_scale); if (G_UNLIKELY (paint_debug_flags & CLUTTER_DEBUG_PAINT_DAMAGE_REGION)) { queued_redraw_clip = scale_offset_and_clamp_region (fb_clip_region, 1.0 / fb_scale, view_rect.x, view_rect.y); } } else { cairo_rectangle_int_t fb_rect; fb_rect = (cairo_rectangle_int_t) { .width = fb_width, .height = fb_height, }; fb_clip_region = cairo_region_create_rectangle (&fb_rect); g_clear_pointer (&redraw_clip, cairo_region_destroy); redraw_clip = cairo_region_create_rectangle (&view_rect); if (G_UNLIKELY (paint_debug_flags & CLUTTER_DEBUG_PAINT_DAMAGE_REGION)) queued_redraw_clip = cairo_region_reference (redraw_clip); } g_return_if_fail (!cairo_region_is_empty (fb_clip_region)); swap_with_damage = FALSE; if (has_buffer_age) { clutter_damage_history_record (damage_history, fb_clip_region); if (use_clipped_redraw) { int age; for (age = 1; age <= buffer_age; age++) { const cairo_region_t *old_damage; old_damage = clutter_damage_history_lookup (damage_history, age); cairo_region_union (fb_clip_region, old_damage); } meta_topic (META_DEBUG_BACKEND, "Reusing back buffer(age=%d) - repairing region: num rects: %d", buffer_age, cairo_region_num_rectangles (fb_clip_region)); swap_with_damage = TRUE; } clutter_damage_history_step (damage_history); } if (use_clipped_redraw) { /* Regenerate redraw_clip because: * 1. It's missing the regions added from damage_history above; and * 2. If using fractional scaling then it might be a fraction of a * logical pixel (or one physical pixel) smaller than * fb_clip_region, due to the clamping from * offset_scale_and_clamp_region. So we need to ensure redraw_clip * is a superset of fb_clip_region to avoid such gaps. */ cairo_region_destroy (redraw_clip); redraw_clip = scale_offset_and_clamp_region (fb_clip_region, 1.0 / fb_scale, view_rect.x, view_rect.y); } if (paint_debug_flags & CLUTTER_DEBUG_PAINT_DAMAGE_REGION) { cairo_region_t *debug_redraw_clip; debug_redraw_clip = cairo_region_create_rectangle (&view_rect); paint_stage (stage_impl, stage_view, debug_redraw_clip); cairo_region_destroy (debug_redraw_clip); } else if (use_clipped_redraw) { cogl_framebuffer_push_region_clip (fb, fb_clip_region); paint_stage (stage_impl, stage_view, redraw_clip); cogl_framebuffer_pop_clip (fb); } else { meta_topic (META_DEBUG_BACKEND, "Unclipped stage paint"); paint_stage (stage_impl, stage_view, redraw_clip); } /* XXX: It seems there will be a race here in that the stage * window may be resized before the cogl_onscreen_swap_region * is handled and so we may copy the wrong region. I can't * really see how we can handle this with the current state of X * but at least in this case a full redraw should be queued by * the resize anyway so it should only exhibit temporary * artefacts. */ if (use_clipped_redraw) swap_region = cairo_region_reference (fb_clip_region); else swap_region = cairo_region_create (); g_clear_pointer (&redraw_clip, cairo_region_destroy); g_clear_pointer (&fb_clip_region, cairo_region_destroy); COGL_TRACE_BEGIN_SCOPED (MetaStageImplRedrawViewSwapFramebuffer, "Paint (swap framebuffer)"); if (clutter_stage_view_get_onscreen (stage_view) != clutter_stage_view_get_framebuffer (stage_view)) { cairo_region_t *transformed_swap_region; transformed_swap_region = transform_swap_region_to_onscreen (stage_view, swap_region); cairo_region_destroy (swap_region); swap_region = transformed_swap_region; } if (queued_redraw_clip) { cairo_region_t *swap_region_in_stage_space; swap_region_in_stage_space = scale_offset_and_clamp_region (swap_region, 1.0f / fb_scale, view_rect.x, view_rect.y); cairo_region_subtract (swap_region_in_stage_space, queued_redraw_clip); paint_damage_region (stage_window, stage_view, swap_region_in_stage_space, queued_redraw_clip); cairo_region_destroy (queued_redraw_clip); cairo_region_destroy (swap_region_in_stage_space); } swap_framebuffer (stage_window, stage_view, swap_region, swap_with_damage, frame); cairo_region_destroy (swap_region); } static gboolean meta_stage_impl_scanout_view (MetaStageImpl *stage_impl, ClutterStageView *stage_view, CoglScanout *scanout, ClutterFrame *frame, GError **error) { MetaStageImplPrivate *priv = meta_stage_impl_get_instance_private (stage_impl); CoglFramebuffer *framebuffer = clutter_stage_view_get_framebuffer (stage_view); CoglContext *cogl_context = cogl_framebuffer_get_context (framebuffer); CoglOnscreen *onscreen; CoglFrameInfo *frame_info; g_assert (COGL_IS_ONSCREEN (framebuffer)); onscreen = COGL_ONSCREEN (framebuffer); frame_info = cogl_frame_info_new (cogl_context, priv->global_frame_counter); if (!cogl_onscreen_direct_scanout (onscreen, scanout, frame_info, frame, error)) { cogl_object_unref (frame_info); return FALSE; } priv->global_frame_counter++; return TRUE; } static void meta_stage_impl_redraw_view (ClutterStageWindow *stage_window, ClutterStageView *stage_view, ClutterFrame *frame) { MetaStageImpl *stage_impl = META_STAGE_IMPL (stage_window); g_autoptr (CoglScanout) scanout = NULL; scanout = clutter_stage_view_take_scanout (stage_view); if (scanout) { g_autoptr (GError) error = NULL; if (meta_stage_impl_scanout_view (stage_impl, stage_view, scanout, frame, &error)) return; if (!g_error_matches (error, COGL_SCANOUT_ERROR, COGL_SCANOUT_ERROR_INHIBITED)) g_warning ("Failed to scan out client buffer: %s", error->message); } meta_stage_impl_redraw_view_primary (stage_impl, stage_view, frame); } void meta_stage_impl_add_onscreen_frame_info (MetaStageImpl *stage_impl, ClutterStageView *stage_view) { MetaStageImplPrivate *priv = meta_stage_impl_get_instance_private (stage_impl); CoglFramebuffer *framebuffer = clutter_stage_view_get_onscreen (stage_view); CoglContext *cogl_context = cogl_framebuffer_get_context (framebuffer); CoglFrameInfo *frame_info; frame_info = cogl_frame_info_new (cogl_context, priv->global_frame_counter); priv->global_frame_counter++; cogl_onscreen_add_frame_info (COGL_ONSCREEN (framebuffer), frame_info); } static void clutter_stage_window_iface_init (ClutterStageWindowInterface *iface) { iface->realize = meta_stage_impl_realize; iface->unrealize = meta_stage_impl_unrealize; iface->get_wrapper = meta_stage_impl_get_wrapper; iface->resize = meta_stage_impl_resize; iface->show = meta_stage_impl_show; iface->hide = meta_stage_impl_hide; iface->get_frame_counter = meta_stage_impl_get_frame_counter; iface->redraw_view = meta_stage_impl_redraw_view; } static void meta_stage_impl_set_property (GObject *gobject, guint prop_id, const GValue *value, GParamSpec *pspec) { MetaStageImpl *self = META_STAGE_IMPL (gobject); switch (prop_id) { case PROP_WRAPPER: self->wrapper = g_value_get_object (value); break; case PROP_BACKEND: self->backend = g_value_get_object (value); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec); break; } } static void meta_stage_impl_class_init (MetaStageImplClass *klass) { GObjectClass *gobject_class = G_OBJECT_CLASS (klass); gobject_class->set_property = meta_stage_impl_set_property; g_object_class_override_property (gobject_class, PROP_WRAPPER, "wrapper"); g_object_class_override_property (gobject_class, PROP_BACKEND, "backend"); } static void meta_stage_impl_init (MetaStageImpl *stage) { }