Send _NET_WM_FRAME_TIMINGS messages

We previously had timestamp information stubbed out in
_NET_WM_FRAME_DRAWN. Instead of this, add a high-resolution timestamp
in _NET_WM_FRAME_DRAWN then send a _NET_WM_FRAME_TIMINGS message
after when we have complete frame timing information, representing
the "presentation time" of the frame as an offset from the timestamp
in _NET_WM_FRAME_DRAWN.

To provide maximum space in the messages,_NET_WM_FRAME_DRAWN and
_NET_WM_FRAME_TIMINGS are not done as WM_PROTOCOLS messages but
have their own message types.

https://bugzilla.gnome.org/show_bug.cgi?id=685463
This commit is contained in:
Owen W. Taylor 2012-11-12 14:11:08 -05:00
parent 74b1a9e2b9
commit 2d9b8bb2d0
5 changed files with 208 additions and 20 deletions

View File

@ -45,6 +45,9 @@ struct _MetaCompScreen
GHashTable *windows_by_xid; GHashTable *windows_by_xid;
Window output; Window output;
CoglOnscreen *onscreen;
CoglFrameClosure *frame_closure;
/* Used for unredirecting fullscreen windows */ /* Used for unredirecting fullscreen windows */
guint disable_unredirect_count; guint disable_unredirect_count;
MetaWindowActor *unredirected_window; MetaWindowActor *unredirected_window;
@ -57,6 +60,9 @@ struct _MetaCompScreen
MetaPluginManager *plugin_mgr; MetaPluginManager *plugin_mgr;
}; };
/* Wait 2ms after vblank before starting to draw next frame */
#define META_SYNC_DELAY 2
void meta_switch_workspace_completed (MetaScreen *screen); void meta_switch_workspace_completed (MetaScreen *screen);
gboolean meta_begin_modal_for_plugin (MetaScreen *screen, gboolean meta_begin_modal_for_plugin (MetaScreen *screen,

View File

@ -552,8 +552,7 @@ meta_compositor_manage_screen (MetaCompositor *compositor,
g_signal_connect_after (info->stage, "paint", g_signal_connect_after (info->stage, "paint",
G_CALLBACK (after_stage_paint), info); G_CALLBACK (after_stage_paint), info);
/* Wait 2ms after vblank before starting to draw next frame */ clutter_stage_set_sync_delay (CLUTTER_STAGE (info->stage), META_SYNC_DELAY);
clutter_stage_set_sync_delay (CLUTTER_STAGE (info->stage), 2);
meta_screen_get_size (screen, &width, &height); meta_screen_get_size (screen, &width, &height);
clutter_actor_realize (info->stage); clutter_actor_realize (info->stage);
@ -1210,6 +1209,48 @@ meta_compositor_sync_screen_size (MetaCompositor *compositor,
width, height); width, height);
} }
static void
frame_callback (CoglOnscreen *onscreen,
CoglFrameEvent event,
CoglFrameInfo *frame_info,
void *user_data)
{
MetaCompScreen *info = user_data;
GList *l;
if (event == COGL_FRAME_EVENT_COMPLETE)
{
gint64 presentation_time_cogl = cogl_frame_info_get_presentation_time (frame_info);
gint64 presentation_time;
if (presentation_time_cogl != 0)
{
/* Cogl reports presentation in terms of its own clock, which is
* guaranteed to be in nanoseconds but with no specified base. The
* normal case with the open source GPU drivers on Linux 3.8 and
* newer is that the base of cogl_get_clock_time() is that of
* clock_gettime(CLOCK_MONOTONIC), so the same as g_get_monotonic_time),
* but there's no exposure of that through the API. clock_gettime()
* is fairly fast, so calling it twice and subtracting to get a
* nearly-zero number is acceptable, if a litle ugly.
*/
CoglContext *context = cogl_framebuffer_get_context (COGL_FRAMEBUFFER (onscreen));
gint64 current_cogl_time = cogl_get_clock_time (context);
gint64 current_monotonic_time = g_get_monotonic_time ();
presentation_time =
current_monotonic_time + (presentation_time_cogl - current_cogl_time) / 1000;
}
else
{
presentation_time = 0;
}
for (l = info->windows; l; l = l->next)
meta_window_actor_frame_complete (l->data, frame_info, presentation_time);
}
}
static void static void
pre_paint_windows (MetaCompScreen *info) pre_paint_windows (MetaCompScreen *info)
{ {
@ -1217,6 +1258,15 @@ pre_paint_windows (MetaCompScreen *info)
MetaWindowActor *top_window; MetaWindowActor *top_window;
MetaWindowActor *expected_unredirected_window = NULL; MetaWindowActor *expected_unredirected_window = NULL;
if (info->onscreen == NULL)
{
info->onscreen = COGL_ONSCREEN (cogl_get_draw_framebuffer ());
info->frame_closure = cogl_onscreen_add_frame_callback (info->onscreen,
frame_callback,
info,
NULL);
}
if (info->windows == NULL) if (info->windows == NULL)
return; return;

View File

@ -29,6 +29,9 @@ void meta_window_actor_process_damage (MetaWindowActor *self,
void meta_window_actor_pre_paint (MetaWindowActor *self); void meta_window_actor_pre_paint (MetaWindowActor *self);
void meta_window_actor_post_paint (MetaWindowActor *self); void meta_window_actor_post_paint (MetaWindowActor *self);
void meta_window_actor_frame_complete (MetaWindowActor *self,
CoglFrameInfo *frame_info,
gint64 presentation_time);
void meta_window_actor_invalidate_shadow (MetaWindowActor *self); void meta_window_actor_invalidate_shadow (MetaWindowActor *self);

View File

@ -96,9 +96,8 @@ struct _MetaWindowActorPrivate
gint map_in_progress; gint map_in_progress;
gint destroy_in_progress; gint destroy_in_progress;
/* If non-zero, the client needs to be sent a _NET_WM_FRAME_DRAWN /* List of FrameData for recent frames */
* client message with this value */ GList *frames;
gint64 frame_drawn_serial;
guint visible : 1; guint visible : 1;
guint mapped : 1; guint mapped : 1;
@ -109,6 +108,10 @@ struct _MetaWindowActorPrivate
guint needs_damage_all : 1; guint needs_damage_all : 1;
guint received_damage : 1; guint received_damage : 1;
/* If set, the client needs to be sent a _NET_WM_FRAME_DRAWN
* client message using the most recent frame in ->frames */
guint needs_frame_drawn : 1;
guint needs_pixmap : 1; guint needs_pixmap : 1;
guint needs_reshape : 1; guint needs_reshape : 1;
guint recompute_focused_shadow : 1; guint recompute_focused_shadow : 1;
@ -129,6 +132,15 @@ struct _MetaWindowActorPrivate
guint does_full_damage : 1; guint does_full_damage : 1;
}; };
typedef struct _FrameData FrameData;
struct _FrameData
{
int64_t frame_counter;
guint64 sync_request_serial;
gint64 frame_drawn_time;
};
enum enum
{ {
PROP_META_WINDOW = 1, PROP_META_WINDOW = 1,
@ -159,10 +171,18 @@ static gboolean meta_window_actor_get_paint_volume (ClutterActor *actor,
static void meta_window_actor_detach (MetaWindowActor *self); static void meta_window_actor_detach (MetaWindowActor *self);
static gboolean meta_window_actor_has_shadow (MetaWindowActor *self); static gboolean meta_window_actor_has_shadow (MetaWindowActor *self);
static void meta_window_actor_handle_updates (MetaWindowActor *self);
static void check_needs_reshape (MetaWindowActor *self); static void check_needs_reshape (MetaWindowActor *self);
G_DEFINE_TYPE (MetaWindowActor, meta_window_actor, CLUTTER_TYPE_GROUP); G_DEFINE_TYPE (MetaWindowActor, meta_window_actor, CLUTTER_TYPE_GROUP);
static void
frame_data_free (FrameData *frame)
{
g_slice_free (FrameData, frame);
}
static void static void
meta_window_actor_class_init (MetaWindowActorClass *klass) meta_window_actor_class_init (MetaWindowActorClass *klass)
{ {
@ -667,7 +687,7 @@ meta_window_actor_get_paint_volume (ClutterActor *actor,
/* The paint volume is computed before paint functions are called /* The paint volume is computed before paint functions are called
* so our bounds might not be updated yet. Force an update. */ * so our bounds might not be updated yet. Force an update. */
meta_window_actor_pre_paint (self); meta_window_actor_handle_updates (self);
meta_window_actor_get_shape_bounds (self, &bounds); meta_window_actor_get_shape_bounds (self, &bounds);
@ -934,14 +954,14 @@ meta_window_actor_thaw (MetaWindowActor *self)
/* We do this now since we might be going right back into the /* We do this now since we might be going right back into the
* frozen state */ * frozen state */
meta_window_actor_pre_paint (self); meta_window_actor_handle_updates (self);
/* Since we ignore damage events while a window is frozen for certain effects /* Since we ignore damage events while a window is frozen for certain effects
* we may need to issue an update_area() covering the whole pixmap if we * we may need to issue an update_area() covering the whole pixmap if we
* don't know what real damage has happened. */ * don't know what real damage has happened. */
if (self->priv->needs_damage_all) if (self->priv->needs_damage_all)
meta_window_actor_damage_all (self); meta_window_actor_damage_all (self);
else if (self->priv->frame_drawn_serial != 0) else if (self->priv->needs_frame_drawn != 0)
{ {
/* A frame was marked by the client without actually doing any damage; /* A frame was marked by the client without actually doing any damage;
* we need to make sure that the pre_paint/post_paint functions * we need to make sure that the pre_paint/post_paint functions
@ -2270,8 +2290,8 @@ meta_window_actor_update_shape (MetaWindowActor *self)
clutter_actor_queue_redraw (priv->actor); clutter_actor_queue_redraw (priv->actor);
} }
void static void
meta_window_actor_pre_paint (MetaWindowActor *self) meta_window_actor_handle_updates (MetaWindowActor *self)
{ {
MetaWindowActorPrivate *priv = self->priv; MetaWindowActorPrivate *priv = self->priv;
MetaScreen *screen = priv->screen; MetaScreen *screen = priv->screen;
@ -2326,39 +2346,147 @@ meta_window_actor_pre_paint (MetaWindowActor *self)
if (priv->window->needs_frame_drawn) if (priv->window->needs_frame_drawn)
{ {
priv->frame_drawn_serial = priv->window->sync_request_serial; FrameData *frame = g_slice_new0 (FrameData);
priv->needs_frame_drawn = TRUE;
frame->sync_request_serial = priv->window->sync_request_serial;
priv->frames = g_list_prepend (priv->frames, frame);
priv->window->needs_frame_drawn = FALSE; priv->window->needs_frame_drawn = FALSE;
} }
} }
void
meta_window_actor_pre_paint (MetaWindowActor *self)
{
MetaWindowActorPrivate *priv = self->priv;
GList *l;
meta_window_actor_handle_updates (self);
for (l = priv->frames; l != NULL; l = l->next)
{
FrameData *frame = l->data;
if (frame->frame_counter == 0)
{
CoglOnscreen *onscreen = COGL_ONSCREEN (cogl_get_draw_framebuffer());
frame->frame_counter = cogl_onscreen_get_frame_counter (onscreen);
}
}
}
void void
meta_window_actor_post_paint (MetaWindowActor *self) meta_window_actor_post_paint (MetaWindowActor *self)
{ {
MetaWindowActorPrivate *priv = self->priv; MetaWindowActorPrivate *priv = self->priv;
if (priv->frame_drawn_serial != 0) if (priv->needs_frame_drawn)
{ {
MetaScreen *screen = priv->screen; MetaScreen *screen = priv->screen;
MetaDisplay *display = meta_screen_get_display (screen); MetaDisplay *display = meta_screen_get_display (screen);
Display *xdisplay = meta_display_get_xdisplay (display); Display *xdisplay = meta_display_get_xdisplay (display);
XClientMessageEvent ev; XClientMessageEvent ev = { 0, };
FrameData *frame = priv->frames->data;
frame->frame_drawn_time = meta_compositor_monotonic_time_to_server_time (display,
g_get_monotonic_time ());
ev.type = ClientMessage; ev.type = ClientMessage;
ev.window = meta_window_get_xwindow (priv->window); ev.window = meta_window_get_xwindow (priv->window);
ev.message_type = display->atom_WM_PROTOCOLS; ev.message_type = display->atom__NET_WM_FRAME_DRAWN;
ev.format = 32; ev.format = 32;
ev.data.l[0] = display->atom__NET_WM_FRAME_DRAWN; ev.data.l[0] = frame->sync_request_serial & G_GUINT64_CONSTANT(0xffffffff);
ev.data.l[1] = 0; /* timestamp */ ev.data.l[1] = frame->sync_request_serial >> 32;
ev.data.l[2] = priv->frame_drawn_serial & G_GUINT64_CONSTANT(0xffffffff); ev.data.l[2] = frame->frame_drawn_time & G_GUINT64_CONSTANT(0xffffffff);
ev.data.l[3] = priv->frame_drawn_serial >> 32; ev.data.l[3] = frame->frame_drawn_time >> 32;
ev.data.l[4] = 0; /* vblank estimate */
meta_error_trap_push (display); meta_error_trap_push (display);
XSendEvent (xdisplay, ev.window, False, 0, (XEvent*) &ev); XSendEvent (xdisplay, ev.window, False, 0, (XEvent*) &ev);
XFlush (xdisplay);
meta_error_trap_pop (display); meta_error_trap_pop (display);
priv->frame_drawn_serial = 0; priv->needs_frame_drawn = FALSE;
}
}
static void
send_frame_timings (MetaWindowActor *self,
FrameData *frame,
CoglFrameInfo *frame_info,
gint64 presentation_time)
{
MetaWindowActorPrivate *priv = self->priv;
MetaDisplay *display = meta_screen_get_display (priv->screen);
Display *xdisplay = meta_display_get_xdisplay (display);
float refresh_rate;
int refresh_interval;
XClientMessageEvent ev = { 0, };
ev.type = ClientMessage;
ev.window = meta_window_get_xwindow (priv->window);
ev.message_type = display->atom__NET_WM_FRAME_TIMINGS;
ev.format = 32;
ev.data.l[0] = frame->sync_request_serial & G_GUINT64_CONSTANT(0xffffffff);
ev.data.l[1] = frame->sync_request_serial >> 32;
refresh_rate = cogl_frame_info_get_refresh_rate (frame_info);
/* 0.0 is a flag for not known, but sanity-check against other odd numbers */
if (refresh_rate >= 1.0)
refresh_interval = (int) (0.5 + 1000000 / refresh_rate);
else
refresh_interval = 0;
if (presentation_time != 0)
{
gint64 presentation_time_server = meta_compositor_monotonic_time_to_server_time (display,
presentation_time);
gint64 presentation_time_offset = presentation_time_server - frame->frame_drawn_time;
if (presentation_time_offset == 0)
presentation_time_offset = 1;
if ((gint32)presentation_time_offset == presentation_time_offset)
ev.data.l[2] = presentation_time_offset;
}
ev.data.l[3] = refresh_interval;
ev.data.l[4] = 1000 * META_SYNC_DELAY;
meta_error_trap_push (display);
XSendEvent (xdisplay, ev.window, False, 0, (XEvent*) &ev);
XFlush (xdisplay);
meta_error_trap_pop (display);
}
void
meta_window_actor_frame_complete (MetaWindowActor *self,
CoglFrameInfo *frame_info,
gint64 presentation_time)
{
MetaWindowActorPrivate *priv = self->priv;
GList *l;
for (l = priv->frames; l;)
{
GList *l_next = l->next;
FrameData *frame = l->data;
if (frame->frame_counter == cogl_frame_info_get_frame_counter (frame_info))
{
if (frame->frame_drawn_time != 0)
{
priv->frames = g_list_delete_link (priv->frames, l);
send_frame_timings (self, frame, frame_info, presentation_time);
frame_data_free (frame);
}
}
l = l_next;
} }
} }

View File

@ -175,6 +175,7 @@ item(_NET_WM_STATE_FOCUSED)
item(_NET_WM_BYPASS_COMPOSITOR) item(_NET_WM_BYPASS_COMPOSITOR)
item(_NET_WM_OPAQUE_REGION) item(_NET_WM_OPAQUE_REGION)
item(_NET_WM_FRAME_DRAWN) item(_NET_WM_FRAME_DRAWN)
item(_NET_WM_FRAME_TIMINGS)
#if 0 #if 0
/* We apparently never use: */ /* We apparently never use: */