#include "config.h"
+#include "gdkinternals.h"
+#include "gdkframeclockprivate.h"
#include "gdkframeclockidle.h"
#include "gdk.h"
+#ifdef G_OS_WIN32
+#include <windows.h>
+#endif
+
+#define FRAME_INTERVAL 16667 // microseconds
+
struct _GdkFrameClockIdlePrivate
{
GTimer *timer;
/* timer_base is used to avoid ever going backward */
- guint64 timer_base;
- guint64 frame_time;
+ gint64 timer_base;
+ gint64 frame_time;
+ gint64 min_next_frame_time;
+ gint64 sleep_serial;
- guint idle_id;
+ guint flush_idle_id;
+ guint paint_idle_id;
guint freeze_count;
+ guint updating_count;
GdkFrameClockPhase requested;
GdkFrameClockPhase phase;
+
+ guint in_paint_idle : 1;
+#ifdef G_OS_WIN32
+ guint begin_period : 1;
+#endif
};
+static gboolean gdk_frame_clock_flush_idle (void *data);
static gboolean gdk_frame_clock_paint_idle (void *data);
-static void gdk_frame_clock_idle_finalize (GObject *object);
-static void gdk_frame_clock_idle_interface_init (GdkFrameClockInterface *iface);
+G_DEFINE_TYPE (GdkFrameClockIdle, gdk_frame_clock_idle, GDK_TYPE_FRAME_CLOCK)
-G_DEFINE_TYPE_WITH_CODE (GdkFrameClockIdle, gdk_frame_clock_idle, G_TYPE_OBJECT,
- G_IMPLEMENT_INTERFACE (GDK_TYPE_FRAME_CLOCK,
- gdk_frame_clock_idle_interface_init))
+static gint64 sleep_serial;
+static gint64 sleep_source_prepare_time;
+static GSource *sleep_source;
-static void
-gdk_frame_clock_idle_class_init (GdkFrameClockIdleClass *klass)
+static gboolean
+sleep_source_prepare (GSource *source,
+ gint *timeout)
{
- GObjectClass *gobject_class = (GObjectClass*) klass;
+ sleep_source_prepare_time = g_source_get_time (source);
+ *timeout = -1;
+ return FALSE;
+}
- gobject_class->finalize = gdk_frame_clock_idle_finalize;
+static gboolean
+sleep_source_check (GSource *source)
+{
+ if (g_source_get_time (source) != sleep_source_prepare_time)
+ sleep_serial++;
- g_type_class_add_private (klass, sizeof (GdkFrameClockIdlePrivate));
+ return FALSE;
+}
+
+static gboolean
+sleep_source_dispatch (GSource *source,
+ GSourceFunc callback,
+ gpointer user_data)
+{
+ return TRUE;
+}
+
+static GSourceFuncs sleep_source_funcs = {
+ sleep_source_prepare,
+ sleep_source_check,
+ sleep_source_dispatch,
+ NULL /* finalize */
+};
+
+static gint64
+get_sleep_serial (void)
+{
+ if (sleep_source == NULL)
+ {
+ sleep_source = g_source_new (&sleep_source_funcs, sizeof (GSource));
+
+ g_source_set_priority (sleep_source, G_PRIORITY_HIGH);
+ g_source_attach (sleep_source, NULL);
+ g_source_unref (sleep_source);
+ }
+
+ return sleep_serial;
}
static void
GdkFrameClockIdlePrivate);
priv = frame_clock_idle->priv;
- priv->timer = g_timer_new ();
priv->freeze_count = 0;
}
static void
-gdk_frame_clock_idle_finalize (GObject *object)
+gdk_frame_clock_idle_dispose (GObject *object)
{
GdkFrameClockIdlePrivate *priv = GDK_FRAME_CLOCK_IDLE (object)->priv;
- g_timer_destroy (priv->timer);
+ if (priv->flush_idle_id != 0)
+ {
+ g_source_remove (priv->flush_idle_id);
+ priv->flush_idle_id = 0;
+ }
+
+ if (priv->paint_idle_id != 0)
+ {
+ g_source_remove (priv->paint_idle_id);
+ priv->paint_idle_id = 0;
+ }
- G_OBJECT_CLASS (gdk_frame_clock_idle_parent_class)->finalize (object);
+#ifdef G_OS_WIN32
+ if (priv->begin_period)
+ {
+ timeEndPeriod(1);
+ priv->begin_period = FALSE;
+ }
+#endif
+
+ G_OBJECT_CLASS (gdk_frame_clock_idle_parent_class)->dispose (object);
}
-static guint64
+static gint64
compute_frame_time (GdkFrameClockIdle *idle)
{
GdkFrameClockIdlePrivate *priv = idle->priv;
- guint64 computed_frame_time;
- guint64 elapsed;
+ gint64 computed_frame_time;
+ gint64 elapsed;
- elapsed = ((guint64) (g_timer_elapsed (priv->timer, NULL) * 1000)) + priv->timer_base;
+ elapsed = g_get_monotonic_time () + priv->timer_base;
if (elapsed < priv->frame_time)
{
/* clock went backward. adapt to that by forevermore increasing
return computed_frame_time;
}
-static guint64
+static gint64
gdk_frame_clock_idle_get_frame_time (GdkFrameClock *clock)
{
GdkFrameClockIdlePrivate *priv = GDK_FRAME_CLOCK_IDLE (clock)->priv;
- guint64 computed_frame_time;
+ gint64 computed_frame_time;
/* can't change frame time during a paint */
- if (priv->phase != GDK_FRAME_CLOCK_PHASE_NONE)
+ if (priv->phase != GDK_FRAME_CLOCK_PHASE_NONE &&
+ priv->phase != GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS)
return priv->frame_time;
/* Outside a paint, pick something close to "now" */
* get_frame_time() would normally be used outside of a paint to
* record an animation start time for example.
*/
- if ((computed_frame_time - priv->frame_time) > 16)
+ if ((computed_frame_time - priv->frame_time) > FRAME_INTERVAL)
priv->frame_time = computed_frame_time;
return priv->frame_time;
}
+#define RUN_FLUSH_IDLE(priv) \
+ ((priv)->freeze_count == 0 && \
+ ((priv)->requested & GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS) != 0)
+
+/* The reason why we track updating_count separately here and don't
+ * just add GDK_FRAME_CLOCK_PHASE_UPDATE into ->request on every frame
+ * is so that we can avoid doing one more frame when an animation
+ * is cancelled.
+ */
+#define RUN_PAINT_IDLE(priv) \
+ ((priv)->freeze_count == 0 && \
+ (((priv)->requested & ~GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS) != 0 || \
+ (priv)->updating_count > 0))
+
static void
maybe_start_idle (GdkFrameClockIdle *clock_idle)
{
GdkFrameClockIdlePrivate *priv = clock_idle->priv;
- if (priv->idle_id == 0 && priv->freeze_count == 0 && priv->requested != 0)
+ if (RUN_FLUSH_IDLE (priv) || RUN_PAINT_IDLE (priv))
+ {
+ guint min_interval = 0;
+
+ if (priv->min_next_frame_time != 0)
+ {
+ gint64 now = compute_frame_time (clock_idle);
+ gint64 min_interval_us = MAX (priv->min_next_frame_time, now) - now;
+ min_interval = (min_interval_us + 500) / 1000;
+ }
+
+ if (priv->flush_idle_id == 0 && RUN_FLUSH_IDLE (priv))
+ {
+ priv->flush_idle_id = gdk_threads_add_timeout_full (GDK_PRIORITY_EVENTS + 1,
+ min_interval,
+ gdk_frame_clock_flush_idle,
+ g_object_ref (clock_idle),
+ (GDestroyNotify) g_object_unref);
+ }
+
+ if (priv->paint_idle_id == 0 && RUN_PAINT_IDLE (priv))
+ {
+ priv->paint_idle_id = gdk_threads_add_timeout_full (GDK_PRIORITY_REDRAW,
+ min_interval,
+ gdk_frame_clock_paint_idle,
+ g_object_ref (clock_idle),
+ (GDestroyNotify) g_object_unref);
+ }
+ }
+}
+
+static void
+maybe_stop_idle (GdkFrameClockIdle *clock_idle)
+{
+ GdkFrameClockIdlePrivate *priv = clock_idle->priv;
+
+ if (priv->flush_idle_id != 0 && !RUN_FLUSH_IDLE (priv))
{
- priv->idle_id = gdk_threads_add_idle_full (GDK_PRIORITY_REDRAW,
- gdk_frame_clock_paint_idle,
- g_object_ref (clock_idle),
- (GDestroyNotify) g_object_unref);
+ g_source_remove (priv->flush_idle_id);
+ priv->flush_idle_id = 0;
+ }
- gdk_frame_clock_frame_requested (GDK_FRAME_CLOCK (clock_idle));
+ if (priv->paint_idle_id != 0 && !RUN_PAINT_IDLE (priv))
+ {
+ g_source_remove (priv->paint_idle_id);
+ priv->paint_idle_id = 0;
}
}
+static gint64
+compute_min_next_frame_time (GdkFrameClockIdle *clock_idle,
+ gint64 last_frame_time)
+{
+ gint64 presentation_time;
+ gint64 refresh_interval;
+
+ gdk_frame_clock_get_refresh_info (GDK_FRAME_CLOCK (clock_idle),
+ last_frame_time,
+ &refresh_interval, &presentation_time);
+
+ if (presentation_time == 0)
+ return last_frame_time + refresh_interval;
+ else
+ return presentation_time + refresh_interval / 2;
+}
+
+static gboolean
+gdk_frame_clock_flush_idle (void *data)
+{
+ GdkFrameClock *clock = GDK_FRAME_CLOCK (data);
+ GdkFrameClockIdle *clock_idle = GDK_FRAME_CLOCK_IDLE (clock);
+ GdkFrameClockIdlePrivate *priv = clock_idle->priv;
+
+ priv->flush_idle_id = 0;
+
+ if (priv->phase != GDK_FRAME_CLOCK_PHASE_NONE)
+ return FALSE;
+
+ priv->phase = GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS;
+ priv->requested &= ~GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS;
+
+ g_signal_emit_by_name (G_OBJECT (clock), "flush-events");
+
+ if ((priv->requested & ~GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS) != 0 ||
+ priv->updating_count > 0)
+ priv->phase = GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT;
+ else
+ priv->phase = GDK_FRAME_CLOCK_PHASE_NONE;
+
+ return FALSE;
+}
+
static gboolean
gdk_frame_clock_paint_idle (void *data)
{
GdkFrameClock *clock = GDK_FRAME_CLOCK (data);
GdkFrameClockIdle *clock_idle = GDK_FRAME_CLOCK_IDLE (clock);
GdkFrameClockIdlePrivate *priv = clock_idle->priv;
+ gboolean skip_to_resume_events;
+ GdkFrameTimings *timings = NULL;
- priv->idle_id = 0;
+ priv->paint_idle_id = 0;
+ priv->in_paint_idle = TRUE;
+ priv->min_next_frame_time = 0;
- priv->frame_time = compute_frame_time (clock_idle);
+ skip_to_resume_events =
+ (priv->requested & ~(GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS | GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS)) == 0 &&
+ priv->updating_count == 0;
- switch (priv->phase)
+ if (priv->phase > GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT)
{
- case GDK_FRAME_CLOCK_PHASE_NONE:
- case GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT:
- if (priv->freeze_count == 0)
- {
- priv->phase = GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT;
- priv->requested &= ~GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT;
- /* We always emit ::before-paint and ::after-paint even if
- * not explicitly requested, and unlike other phases,
- * they don't get repeated if you freeze/thaw while
- * in them. */
- g_signal_emit_by_name (G_OBJECT (clock), "before-paint");
- priv->phase = GDK_FRAME_CLOCK_PHASE_LAYOUT;
- }
- case GDK_FRAME_CLOCK_PHASE_LAYOUT:
- if (priv->freeze_count == 0)
- {
- priv->phase = GDK_FRAME_CLOCK_PHASE_LAYOUT;
- if (priv->requested & GDK_FRAME_CLOCK_PHASE_LAYOUT)
+ timings = gdk_frame_clock_get_current_timings (clock);
+ }
+
+ if (!skip_to_resume_events)
+ {
+ switch (priv->phase)
+ {
+ case GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS:
+ break;
+ case GDK_FRAME_CLOCK_PHASE_NONE:
+ case GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT:
+ if (priv->freeze_count == 0)
{
- priv->requested &= ~GDK_FRAME_CLOCK_PHASE_LAYOUT;
- g_signal_emit_by_name (G_OBJECT (clock), "layout");
+ priv->frame_time = compute_frame_time (clock_idle);
+
+ _gdk_frame_clock_begin_frame (clock);
+ timings = gdk_frame_clock_get_current_timings (clock);
+
+ timings->frame_time = priv->frame_time;
+ timings->slept_before = priv->sleep_serial != get_sleep_serial ();
+
+ priv->phase = GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT;
+
+ /* We always emit ::before-paint and ::after-paint if
+ * any of the intermediate phases are requested and
+ * they don't get repeated if you freeze/thaw while
+ * in them. */
+ priv->requested &= ~GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT;
+ g_signal_emit_by_name (G_OBJECT (clock), "before-paint");
+ priv->phase = GDK_FRAME_CLOCK_PHASE_UPDATE;
+ }
+ case GDK_FRAME_CLOCK_PHASE_UPDATE:
+ if (priv->freeze_count == 0)
+ {
+ if ((priv->requested & GDK_FRAME_CLOCK_PHASE_UPDATE) != 0 ||
+ priv->updating_count > 0)
+ {
+ priv->requested &= ~GDK_FRAME_CLOCK_PHASE_UPDATE;
+ g_signal_emit_by_name (G_OBJECT (clock), "update");
+ }
+ }
+ case GDK_FRAME_CLOCK_PHASE_LAYOUT:
+ if (priv->freeze_count == 0)
+ {
+#ifdef G_ENABLE_DEBUG
+ if ((_gdk_debug_flags & GDK_DEBUG_FRAMES) != 0)
+ {
+ if (priv->phase != GDK_FRAME_CLOCK_PHASE_LAYOUT &&
+ (priv->requested & GDK_FRAME_CLOCK_PHASE_LAYOUT))
+ timings->layout_start_time = g_get_monotonic_time ();
+ }
+#endif /* G_ENABLE_DEBUG */
+
+ priv->phase = GDK_FRAME_CLOCK_PHASE_LAYOUT;
+ if (priv->requested & GDK_FRAME_CLOCK_PHASE_LAYOUT)
+ {
+ priv->requested &= ~GDK_FRAME_CLOCK_PHASE_LAYOUT;
+ g_signal_emit_by_name (G_OBJECT (clock), "layout");
+ }
}
- }
- case GDK_FRAME_CLOCK_PHASE_PAINT:
- if (priv->freeze_count == 0)
- {
- priv->phase = GDK_FRAME_CLOCK_PHASE_PAINT;
- if (priv->requested & GDK_FRAME_CLOCK_PHASE_PAINT)
+ case GDK_FRAME_CLOCK_PHASE_PAINT:
+ if (priv->freeze_count == 0)
{
- priv->requested &= ~GDK_FRAME_CLOCK_PHASE_PAINT;
- g_signal_emit_by_name (G_OBJECT (clock), "paint");
+#ifdef G_ENABLE_DEBUG
+ if ((_gdk_debug_flags & GDK_DEBUG_FRAMES) != 0)
+ {
+ if (priv->phase != GDK_FRAME_CLOCK_PHASE_PAINT &&
+ (priv->requested & GDK_FRAME_CLOCK_PHASE_PAINT))
+ timings->paint_start_time = g_get_monotonic_time ();
+ }
+#endif /* G_ENABLE_DEBUG */
+
+ priv->phase = GDK_FRAME_CLOCK_PHASE_PAINT;
+ if (priv->requested & GDK_FRAME_CLOCK_PHASE_PAINT)
+ {
+ priv->requested &= ~GDK_FRAME_CLOCK_PHASE_PAINT;
+ g_signal_emit_by_name (G_OBJECT (clock), "paint");
+ }
}
- }
- case GDK_FRAME_CLOCK_PHASE_AFTER_PAINT:
- if (priv->freeze_count == 0)
- {
- priv->phase = GDK_FRAME_CLOCK_PHASE_AFTER_PAINT;
- priv->requested &= ~GDK_FRAME_CLOCK_PHASE_AFTER_PAINT;
- g_signal_emit_by_name (G_OBJECT (clock), "after-paint");
- /* the ::after-paint phase doesn't get repeated on freeze/thaw */
- priv->phase = GDK_FRAME_CLOCK_PHASE_NONE;
- }
+ case GDK_FRAME_CLOCK_PHASE_AFTER_PAINT:
+ if (priv->freeze_count == 0)
+ {
+ priv->requested &= ~GDK_FRAME_CLOCK_PHASE_AFTER_PAINT;
+ g_signal_emit_by_name (G_OBJECT (clock), "after-paint");
+ /* the ::after-paint phase doesn't get repeated on freeze/thaw,
+ */
+ priv->phase = GDK_FRAME_CLOCK_PHASE_NONE;
+
+#ifdef G_ENABLE_DEBUG
+ if ((_gdk_debug_flags & GDK_DEBUG_FRAMES) != 0)
+ timings->frame_end_time = g_get_monotonic_time ();
+#endif /* G_ENABLE_DEBUG */
+ }
+ case GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS:
+ ;
+ }
}
- maybe_start_idle (clock_idle);
+#ifdef G_ENABLE_DEBUG
+ if ((_gdk_debug_flags & GDK_DEBUG_FRAMES) != 0)
+ {
+ if (timings->complete)
+ _gdk_frame_clock_debug_print_timings (clock, timings);
+ }
+#endif /* G_ENABLE_DEBUG */
+
+ if (priv->requested & GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS)
+ {
+ priv->requested &= ~GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS;
+ g_signal_emit_by_name (G_OBJECT (clock), "resume-events");
+ }
+
+ if (priv->freeze_count == 0)
+ priv->phase = GDK_FRAME_CLOCK_PHASE_NONE;
+
+ priv->in_paint_idle = FALSE;
+
+ /* If there is throttling in the backend layer, then we'll do another
+ * update as soon as the backend unthrottles (if there is work to do),
+ * otherwise we need to figure when the next frame should be.
+ */
+ if (priv->freeze_count == 0)
+ {
+ priv->min_next_frame_time = compute_min_next_frame_time (clock_idle,
+ priv->frame_time);
+ maybe_start_idle (clock_idle);
+ }
+
+ if (priv->freeze_count == 0)
+ priv->sleep_serial = get_sleep_serial ();
return FALSE;
}
maybe_start_idle (clock_idle);
}
-static GdkFrameClockPhase
-gdk_frame_clock_idle_get_requested (GdkFrameClock *clock)
+static void
+gdk_frame_clock_idle_begin_updating (GdkFrameClock *clock)
{
- GdkFrameClockIdlePrivate *priv = GDK_FRAME_CLOCK_IDLE (clock)->priv;
+ GdkFrameClockIdle *clock_idle = GDK_FRAME_CLOCK_IDLE (clock);
+ GdkFrameClockIdlePrivate *priv = clock_idle->priv;
+
+#ifdef G_OS_WIN32
+ /* We need a higher resolution timer while doing animations */
+ if (priv->updating_count == 0 && !priv->begin_period)
+ {
+ timeBeginPeriod(1);
+ priv->begin_period = TRUE;
+ }
+#endif
- return priv->requested;
+ priv->updating_count++;
+ maybe_start_idle (clock_idle);
}
static void
-gdk_frame_clock_idle_freeze (GdkFrameClock *clock)
+gdk_frame_clock_idle_end_updating (GdkFrameClock *clock)
{
- GdkFrameClockIdlePrivate *priv = GDK_FRAME_CLOCK_IDLE (clock)->priv;
+ GdkFrameClockIdle *clock_idle = GDK_FRAME_CLOCK_IDLE (clock);
+ GdkFrameClockIdlePrivate *priv = clock_idle->priv;
- priv->freeze_count++;
+ g_return_if_fail (priv->updating_count > 0);
- if (priv->freeze_count == 1)
+ priv->updating_count--;
+ maybe_stop_idle (clock_idle);
+
+#ifdef G_OS_WIN32
+ if (priv->updating_count == 0 && priv->begin_period)
{
- if (priv->idle_id)
- {
- g_source_remove (priv->idle_id);
- priv->idle_id = 0;
- }
+ timeEndPeriod(1);
+ priv->begin_period = FALSE;
}
+#endif
+}
+
+static void
+gdk_frame_clock_idle_freeze (GdkFrameClock *clock)
+{
+ GdkFrameClockIdle *clock_idle = GDK_FRAME_CLOCK_IDLE (clock);
+ GdkFrameClockIdlePrivate *priv = clock_idle->priv;
+
+ priv->freeze_count++;
+ maybe_stop_idle (clock_idle);
}
static void
priv->freeze_count--;
if (priv->freeze_count == 0)
- maybe_start_idle (clock_idle);
+ {
+ maybe_start_idle (clock_idle);
+ /* If nothing is requested so we didn't start an idle, we need
+ * to skip to the end of the state chain, since the idle won't
+ * run and do it for us. */
+ if (priv->paint_idle_id == 0)
+ priv->phase = GDK_FRAME_CLOCK_PHASE_NONE;
+
+ priv->sleep_serial = get_sleep_serial ();
+ }
}
static void
-gdk_frame_clock_idle_interface_init (GdkFrameClockInterface *iface)
+gdk_frame_clock_idle_class_init (GdkFrameClockIdleClass *klass)
{
- iface->get_frame_time = gdk_frame_clock_idle_get_frame_time;
- iface->request_phase = gdk_frame_clock_idle_request_phase;
- iface->get_requested = gdk_frame_clock_idle_get_requested;
- iface->freeze = gdk_frame_clock_idle_freeze;
- iface->thaw = gdk_frame_clock_idle_thaw;
+ GObjectClass *gobject_class = (GObjectClass*) klass;
+ GdkFrameClockClass *frame_clock_class = (GdkFrameClockClass *)klass;
+
+ gobject_class->dispose = gdk_frame_clock_idle_dispose;
+
+ frame_clock_class->get_frame_time = gdk_frame_clock_idle_get_frame_time;
+ frame_clock_class->request_phase = gdk_frame_clock_idle_request_phase;
+ frame_clock_class->begin_updating = gdk_frame_clock_idle_begin_updating;
+ frame_clock_class->end_updating = gdk_frame_clock_idle_end_updating;
+ frame_clock_class->freeze = gdk_frame_clock_idle_freeze;
+ frame_clock_class->thaw = gdk_frame_clock_idle_thaw;
+
+ g_type_class_add_private (klass, sizeof (GdkFrameClockIdlePrivate));
}
GdkFrameClock *