1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2010. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 #include "gdkinternals.h"
30 #include "gdkframeclockprivate.h"
31 #include "gdkframeclockidle.h"
34 #define FRAME_INTERVAL 16667 // microseconds
36 struct _GdkFrameClockIdlePrivate
39 /* timer_base is used to avoid ever going backward */
42 guint64 min_next_frame_time;
49 GdkFrameClockPhase requested;
50 GdkFrameClockPhase phase;
52 guint in_paint_idle : 1;
55 static gboolean gdk_frame_clock_flush_idle (void *data);
56 static gboolean gdk_frame_clock_paint_idle (void *data);
58 static void gdk_frame_clock_idle_finalize (GObject *object);
60 G_DEFINE_TYPE (GdkFrameClockIdle, gdk_frame_clock_idle, GDK_TYPE_FRAME_CLOCK)
62 static gint64 sleep_serial;
63 static gint64 sleep_source_prepare_time;
64 static GSource *sleep_source;
67 sleep_source_prepare (GSource *source,
70 sleep_source_prepare_time = g_source_get_time (source);
76 sleep_source_check (GSource *source)
78 if (g_source_get_time (source) != sleep_source_prepare_time)
85 sleep_source_dispatch (GSource *source,
92 static GSourceFuncs sleep_source_funcs = {
95 sleep_source_dispatch,
100 get_sleep_serial (void)
102 if (sleep_source == NULL)
104 sleep_source = g_source_new (&sleep_source_funcs, sizeof (GSource));
106 g_source_set_priority (sleep_source, G_PRIORITY_HIGH);
107 g_source_attach (sleep_source, NULL);
108 g_source_unref (sleep_source);
115 gdk_frame_clock_idle_init (GdkFrameClockIdle *frame_clock_idle)
117 GdkFrameClockIdlePrivate *priv;
119 frame_clock_idle->priv = G_TYPE_INSTANCE_GET_PRIVATE (frame_clock_idle,
120 GDK_TYPE_FRAME_CLOCK_IDLE,
121 GdkFrameClockIdlePrivate);
122 priv = frame_clock_idle->priv;
124 priv->timer = g_timer_new ();
125 priv->freeze_count = 0;
129 gdk_frame_clock_idle_finalize (GObject *object)
131 GdkFrameClockIdlePrivate *priv = GDK_FRAME_CLOCK_IDLE (object)->priv;
133 g_timer_destroy (priv->timer);
135 G_OBJECT_CLASS (gdk_frame_clock_idle_parent_class)->finalize (object);
139 compute_frame_time (GdkFrameClockIdle *idle)
141 GdkFrameClockIdlePrivate *priv = idle->priv;
142 guint64 computed_frame_time;
145 elapsed = g_get_monotonic_time () + priv->timer_base;
146 if (elapsed < priv->frame_time)
148 /* clock went backward. adapt to that by forevermore increasing
149 * timer_base. For now, assume we've gone forward in time 1ms.
151 /* hmm. just fix GTimer? */
152 computed_frame_time = priv->frame_time + 1;
153 priv->timer_base += (priv->frame_time - elapsed) + 1;
157 computed_frame_time = elapsed;
160 return computed_frame_time;
164 gdk_frame_clock_idle_get_frame_time (GdkFrameClock *clock)
166 GdkFrameClockIdlePrivate *priv = GDK_FRAME_CLOCK_IDLE (clock)->priv;
167 guint64 computed_frame_time;
169 /* can't change frame time during a paint */
170 if (priv->phase != GDK_FRAME_CLOCK_PHASE_NONE &&
171 priv->phase != GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS)
172 return priv->frame_time;
174 /* Outside a paint, pick something close to "now" */
175 computed_frame_time = compute_frame_time (GDK_FRAME_CLOCK_IDLE (clock));
177 /* 16ms is 60fps. We only update frame time that often because we'd
178 * like to try to keep animations on the same start times.
179 * get_frame_time() would normally be used outside of a paint to
180 * record an animation start time for example.
182 if ((computed_frame_time - priv->frame_time) > FRAME_INTERVAL)
183 priv->frame_time = computed_frame_time;
185 return priv->frame_time;
189 maybe_start_idle (GdkFrameClockIdle *clock_idle)
191 GdkFrameClockIdlePrivate *priv = clock_idle->priv;
193 if (priv->freeze_count == 0 && priv->requested != 0)
195 guint min_interval = 0;
197 if (priv->min_next_frame_time != 0)
199 guint64 now = compute_frame_time (clock_idle);
200 guint64 min_interval_us = MAX (priv->min_next_frame_time, now) - now;
201 min_interval = (min_interval_us + 500) / 1000;
204 if (priv->flush_idle_id == 0 &&
205 (priv->requested & GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS) != 0)
207 priv->flush_idle_id = gdk_threads_add_timeout_full (GDK_PRIORITY_EVENTS + 1,
209 gdk_frame_clock_flush_idle,
210 g_object_ref (clock_idle),
211 (GDestroyNotify) g_object_unref);
214 if (priv->paint_idle_id == 0 &&
215 !priv->in_paint_idle &&
216 (priv->requested & ~GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS) != 0)
218 priv->paint_idle_id = gdk_threads_add_timeout_full (GDK_PRIORITY_REDRAW,
220 gdk_frame_clock_paint_idle,
221 g_object_ref (clock_idle),
222 (GDestroyNotify) g_object_unref);
224 g_signal_emit_by_name (clock_idle, "frame-requested");
230 compute_min_next_frame_time (GdkFrameClockIdle *clock_idle,
231 gint64 last_frame_time)
233 gint64 presentation_time;
234 gint64 refresh_interval;
236 gdk_frame_clock_get_refresh_info (GDK_FRAME_CLOCK (clock_idle),
238 &refresh_interval, &presentation_time);
240 if (presentation_time == 0)
241 return last_frame_time + refresh_interval;
243 return presentation_time + refresh_interval / 2;
247 gdk_frame_clock_flush_idle (void *data)
249 GdkFrameClock *clock = GDK_FRAME_CLOCK (data);
250 GdkFrameClockIdle *clock_idle = GDK_FRAME_CLOCK_IDLE (clock);
251 GdkFrameClockIdlePrivate *priv = clock_idle->priv;
253 priv->flush_idle_id = 0;
255 if (priv->phase != GDK_FRAME_CLOCK_PHASE_NONE)
258 priv->phase = GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS;
259 priv->requested &= ~GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS;
261 g_signal_emit_by_name (G_OBJECT (clock), "flush-events");
263 if ((priv->requested & ~GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS) != 0)
264 priv->phase = GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT;
266 priv->phase = GDK_FRAME_CLOCK_PHASE_NONE;
272 gdk_frame_clock_paint_idle (void *data)
274 GdkFrameClock *clock = GDK_FRAME_CLOCK (data);
275 GdkFrameClockIdle *clock_idle = GDK_FRAME_CLOCK_IDLE (clock);
276 GdkFrameClockIdlePrivate *priv = clock_idle->priv;
277 gboolean skip_to_resume_events;
278 GdkFrameTimings *timings = NULL;
280 priv->paint_idle_id = 0;
281 priv->in_paint_idle = TRUE;
282 priv->min_next_frame_time = 0;
284 skip_to_resume_events =
285 (priv->requested & ~(GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS | GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS)) == 0;
287 if (priv->phase > GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT)
289 timings = gdk_frame_clock_get_current_frame_timings (clock);
292 if (!skip_to_resume_events)
296 case GDK_FRAME_CLOCK_PHASE_FLUSH_EVENTS:
298 case GDK_FRAME_CLOCK_PHASE_NONE:
299 case GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT:
300 if (priv->freeze_count == 0)
302 priv->frame_time = compute_frame_time (clock_idle);
304 _gdk_frame_clock_begin_frame (clock);
305 timings = gdk_frame_clock_get_current_frame_timings (clock);
307 gdk_frame_timings_set_frame_time (timings, priv->frame_time);
309 gdk_frame_timings_set_slept_before (timings,
310 priv->sleep_serial != get_sleep_serial ());
312 priv->phase = GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT;
314 /* We always emit ::before-paint and ::after-paint if
315 * any of the intermediate phases are requested and
316 * they don't get repeated if you freeze/thaw while
318 priv->requested &= ~GDK_FRAME_CLOCK_PHASE_BEFORE_PAINT;
319 g_signal_emit_by_name (G_OBJECT (clock), "before-paint");
320 priv->phase = GDK_FRAME_CLOCK_PHASE_UPDATE;
322 case GDK_FRAME_CLOCK_PHASE_UPDATE:
323 if (priv->freeze_count == 0)
325 if (priv->requested & GDK_FRAME_CLOCK_PHASE_UPDATE)
327 priv->requested &= ~GDK_FRAME_CLOCK_PHASE_UPDATE;
328 g_signal_emit_by_name (G_OBJECT (clock), "update");
331 case GDK_FRAME_CLOCK_PHASE_LAYOUT:
332 if (priv->freeze_count == 0)
334 #ifdef G_ENABLE_DEBUG
335 if ((_gdk_debug_flags & GDK_DEBUG_FRAMES) != 0)
337 if (priv->phase != GDK_FRAME_CLOCK_PHASE_LAYOUT &&
338 (priv->requested & GDK_FRAME_CLOCK_PHASE_LAYOUT))
339 _gdk_frame_timings_set_layout_start_time (timings, g_get_monotonic_time ());
341 #endif /* G_ENABLE_DEBUG */
343 priv->phase = GDK_FRAME_CLOCK_PHASE_LAYOUT;
344 if (priv->requested & GDK_FRAME_CLOCK_PHASE_LAYOUT)
346 priv->requested &= ~GDK_FRAME_CLOCK_PHASE_LAYOUT;
347 g_signal_emit_by_name (G_OBJECT (clock), "layout");
350 case GDK_FRAME_CLOCK_PHASE_PAINT:
351 if (priv->freeze_count == 0)
353 #ifdef G_ENABLE_DEBUG
354 if ((_gdk_debug_flags & GDK_DEBUG_FRAMES) != 0)
356 if (priv->phase != GDK_FRAME_CLOCK_PHASE_PAINT &&
357 (priv->requested & GDK_FRAME_CLOCK_PHASE_PAINT))
358 _gdk_frame_timings_set_paint_start_time (timings, g_get_monotonic_time ());
360 #endif /* G_ENABLE_DEBUG */
362 priv->phase = GDK_FRAME_CLOCK_PHASE_PAINT;
363 if (priv->requested & GDK_FRAME_CLOCK_PHASE_PAINT)
365 priv->requested &= ~GDK_FRAME_CLOCK_PHASE_PAINT;
366 g_signal_emit_by_name (G_OBJECT (clock), "paint");
369 case GDK_FRAME_CLOCK_PHASE_AFTER_PAINT:
370 if (priv->freeze_count == 0)
372 priv->requested &= ~GDK_FRAME_CLOCK_PHASE_AFTER_PAINT;
373 g_signal_emit_by_name (G_OBJECT (clock), "after-paint");
374 /* the ::after-paint phase doesn't get repeated on freeze/thaw,
376 priv->phase = GDK_FRAME_CLOCK_PHASE_NONE;
378 #ifdef G_ENABLE_DEBUG
379 if ((_gdk_debug_flags & GDK_DEBUG_FRAMES) != 0)
380 _gdk_frame_timings_set_frame_end_time (timings, g_get_monotonic_time ());
381 #endif /* G_ENABLE_DEBUG */
383 case GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS:
388 #ifdef G_ENABLE_DEBUG
389 if ((_gdk_debug_flags & GDK_DEBUG_FRAMES) != 0)
391 if (gdk_frame_timings_get_complete (timings))
392 _gdk_frame_clock_debug_print_timings (clock, timings);
394 #endif /* G_ENABLE_DEBUG */
396 if (priv->requested & GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS)
398 priv->requested &= ~GDK_FRAME_CLOCK_PHASE_RESUME_EVENTS;
399 g_signal_emit_by_name (G_OBJECT (clock), "resume-events");
402 if (priv->freeze_count == 0)
403 priv->phase = GDK_FRAME_CLOCK_PHASE_NONE;
405 priv->in_paint_idle = FALSE;
407 /* If there is throttling in the backend layer, then we'll do another
408 * update as soon as the backend unthrottles (if there is work to do),
409 * otherwise we need to figure when the next frame should be.
411 if (priv->freeze_count == 0)
413 priv->min_next_frame_time = compute_min_next_frame_time (clock_idle,
415 maybe_start_idle (clock_idle);
418 if (priv->freeze_count == 0)
419 priv->sleep_serial = get_sleep_serial ();
425 gdk_frame_clock_idle_request_phase (GdkFrameClock *clock,
426 GdkFrameClockPhase phase)
428 GdkFrameClockIdle *clock_idle = GDK_FRAME_CLOCK_IDLE (clock);
429 GdkFrameClockIdlePrivate *priv = clock_idle->priv;
431 priv->requested |= phase;
432 maybe_start_idle (clock_idle);
435 static GdkFrameClockPhase
436 gdk_frame_clock_idle_get_requested (GdkFrameClock *clock)
438 GdkFrameClockIdlePrivate *priv = GDK_FRAME_CLOCK_IDLE (clock)->priv;
440 return priv->requested;
444 gdk_frame_clock_idle_freeze (GdkFrameClock *clock)
446 GdkFrameClockIdlePrivate *priv = GDK_FRAME_CLOCK_IDLE (clock)->priv;
448 priv->freeze_count++;
450 if (priv->freeze_count == 1)
452 if (priv->flush_idle_id)
454 g_source_remove (priv->flush_idle_id);
455 priv->flush_idle_id = 0;
457 if (priv->paint_idle_id)
459 g_source_remove (priv->paint_idle_id);
460 priv->paint_idle_id = 0;
466 gdk_frame_clock_idle_thaw (GdkFrameClock *clock)
468 GdkFrameClockIdle *clock_idle = GDK_FRAME_CLOCK_IDLE (clock);
469 GdkFrameClockIdlePrivate *priv = clock_idle->priv;
471 g_return_if_fail (priv->freeze_count > 0);
473 priv->freeze_count--;
474 if (priv->freeze_count == 0)
476 maybe_start_idle (clock_idle);
477 /* If nothing is requested so we didn't start an idle, we need
478 * to skip to the end of the state chain, since the idle won't
479 * run and do it for us. */
480 if (priv->paint_idle_id == 0)
481 priv->phase = GDK_FRAME_CLOCK_PHASE_NONE;
483 priv->sleep_serial = get_sleep_serial ();
488 gdk_frame_clock_idle_class_init (GdkFrameClockIdleClass *klass)
490 GObjectClass *gobject_class = (GObjectClass*) klass;
491 GdkFrameClockClass *frame_clock_class = (GdkFrameClockClass *)klass;
493 gobject_class->finalize = gdk_frame_clock_idle_finalize;
495 frame_clock_class->get_frame_time = gdk_frame_clock_idle_get_frame_time;
496 frame_clock_class->request_phase = gdk_frame_clock_idle_request_phase;
497 frame_clock_class->get_requested = gdk_frame_clock_idle_get_requested;
498 frame_clock_class->freeze = gdk_frame_clock_idle_freeze;
499 frame_clock_class->thaw = gdk_frame_clock_idle_thaw;
501 g_type_class_add_private (klass, sizeof (GdkFrameClockIdlePrivate));
505 _gdk_frame_clock_idle_new (void)
507 GdkFrameClockIdle *clock;
509 clock = g_object_new (GDK_TYPE_FRAME_CLOCK_IDLE, NULL);
511 return GDK_FRAME_CLOCK (clock);