2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2005 Wim Taymans <wim@fluendo.com>
6 * gstclock.h: Header for clock subsystem
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 #ifndef __GST_CLOCK_H__
25 #define __GST_CLOCK_H__
27 #include <gst/gstobject.h>
31 /* --- standard type macros --- */
32 #define GST_TYPE_CLOCK (gst_clock_get_type ())
33 #define GST_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_CAST ((clock), GST_TYPE_CLOCK, GstClock))
34 #define GST_IS_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_TYPE ((clock), GST_TYPE_CLOCK))
35 #define GST_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_CAST ((cclass), GST_TYPE_CLOCK, GstClockClass))
36 #define GST_IS_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_TYPE ((cclass), GST_TYPE_CLOCK))
37 #define GST_CLOCK_GET_CLASS(clock) (G_TYPE_INSTANCE_GET_CLASS ((clock), GST_TYPE_CLOCK, GstClockClass))
38 #define GST_CLOCK_CAST(clock) ((GstClock*)(clock))
40 #define GST_CLOCK_SLAVE_LOCK(clock) g_mutex_lock (GST_CLOCK_CAST (clock)->slave_lock)
41 #define GST_CLOCK_SLAVE_UNLOCK(clock) g_mutex_unlock (GST_CLOCK_CAST (clock)->slave_lock)
46 * A datatype to hold a time, measured in nanoseconds.
48 typedef guint64 GstClockTime;
51 * GST_TYPE_CLOCK_TIME:
53 * The #GType of a #GstClockTime.
55 #define GST_TYPE_CLOCK_TIME G_TYPE_UINT64
60 * A datatype to hold a time difference, measured in nanoseconds.
62 typedef gint64 GstClockTimeDiff;
66 * A datatype to hold the handle to an outstanding sync or async clock callback.
68 typedef gpointer GstClockID;
71 * GST_CLOCK_TIME_NONE:
73 * Constant to define an undefined clock time.
75 #define GST_CLOCK_TIME_NONE ((GstClockTime) -1)
77 * GST_CLOCK_TIME_IS_VALID:
78 * @time: clock time to validate
80 * Tests if a given #GstClockTime represents a valid defined time.
82 #define GST_CLOCK_TIME_IS_VALID(time) (((GstClockTime)(time)) != GST_CLOCK_TIME_NONE)
87 * Constant that defines one GStreamer second.
89 #define GST_SECOND (G_USEC_PER_SEC * G_GINT64_CONSTANT (1000))
93 * Constant that defines one GStreamer millisecond.
95 #define GST_MSECOND (GST_SECOND / G_GINT64_CONSTANT (1000))
99 * Constant that defines one GStreamer microsecond.
101 #define GST_USECOND (GST_SECOND / G_GINT64_CONSTANT (1000000))
105 * Constant that defines one GStreamer nanosecond
107 #define GST_NSECOND (GST_SECOND / G_GINT64_CONSTANT (1000000000))
111 * GST_TIME_AS_SECONDS:
114 * Convert a #GstClockTime to seconds.
118 #define GST_TIME_AS_SECONDS(time) ((time) / GST_SECOND)
120 * GST_TIME_AS_MSECONDS:
123 * Convert a #GstClockTime to milliseconds (1/1000 of a second).
127 #define GST_TIME_AS_MSECONDS(time) ((time) / G_GINT64_CONSTANT (1000000))
129 * GST_TIME_AS_USECONDS:
132 * Convert a #GstClockTime to microseconds (1/1000000 of a second).
136 #define GST_TIME_AS_USECONDS(time) ((time) / G_GINT64_CONSTANT (1000))
138 * GST_TIME_AS_NSECONDS:
141 * Convert a #GstClockTime to nanoseconds (1/1000000000 of a second).
145 #define GST_TIME_AS_NSECONDS(time) (time)
150 * @e: the second time
152 * Calculate a difference between two clock times as a #GstClockTimeDiff.
153 * The difference is calculated as @e - @s.
155 #define GST_CLOCK_DIFF(s, e) (GstClockTimeDiff)((e) - (s))
158 * GST_TIMEVAL_TO_TIME:
159 * @tv: the timeval to convert
161 * Convert a #GTimeVal to a #GstClockTime.
163 #define GST_TIMEVAL_TO_TIME(tv) (GstClockTime)((tv).tv_sec * GST_SECOND + (tv).tv_usec * GST_USECOND)
166 * GST_TIME_TO_TIMEVAL:
167 * @t: The #GstClockTime to convert
168 * @tv: The target timeval
170 * Convert a #GstClockTime to a #GTimeVal
172 * <note>on 32-bit systems, a timeval has a range of only 2^32 - 1 seconds,
173 * which is about 68 years. Expect trouble if you want to schedule stuff
174 * in your pipeline for 2038.</note>
176 #define GST_TIME_TO_TIMEVAL(t,tv) \
178 (tv).tv_sec = ((GstClockTime) (t)) / GST_SECOND; \
179 (tv).tv_usec = (((GstClockTime) (t)) - \
180 ((GstClockTime) (tv).tv_sec) * GST_SECOND) \
185 * GST_TIMESPEC_TO_TIME:
186 * @ts: the timespec to convert
188 * Convert a struct timespec (see man pselect) to a #GstClockTime.
190 #define GST_TIMESPEC_TO_TIME(ts) (GstClockTime)((ts).tv_sec * GST_SECOND + (ts).tv_nsec * GST_NSECOND)
192 * GST_TIME_TO_TIMESPEC:
193 * @t: The #GstClockTime to convert
194 * @ts: The target timespec
196 * Convert a #GstClockTime to a struct timespec (see man pselect)
198 #define GST_TIME_TO_TIMESPEC(t,ts) \
200 (ts).tv_sec = (t) / GST_SECOND; \
201 (ts).tv_nsec = ((t) - (ts).tv_sec * GST_SECOND) / GST_NSECOND; \
204 /* timestamp debugging macros */
208 * A string that can be used in printf-like format strings to display a
209 * #GstClockTime value in h:m:s format. Use GST_TIME_ARGS() to construct
210 * the matching arguments.
214 * printf("%" GST_TIME_FORMAT "\n", GST_TIME_ARGS(ts));
217 #define GST_TIME_FORMAT "u:%02u:%02u.%09u"
220 * @t: a #GstClockTime
222 * Format @t for the #GST_TIME_FORMAT format string. Note: @t will be
223 * evaluated more than once.
225 #define GST_TIME_ARGS(t) \
226 GST_CLOCK_TIME_IS_VALID (t) ? \
227 (guint) (((GstClockTime)(t)) / (GST_SECOND * 60 * 60)) : 99, \
228 GST_CLOCK_TIME_IS_VALID (t) ? \
229 (guint) ((((GstClockTime)(t)) / (GST_SECOND * 60)) % 60) : 99, \
230 GST_CLOCK_TIME_IS_VALID (t) ? \
231 (guint) ((((GstClockTime)(t)) / GST_SECOND) % 60) : 99, \
232 GST_CLOCK_TIME_IS_VALID (t) ? \
233 (guint) (((GstClockTime)(t)) % GST_SECOND) : 999999999
236 * GST_CLOCK_ENTRY_TRACE_NAME:
238 * The name used for tracing clock entry allocations.
240 #define GST_CLOCK_ENTRY_TRACE_NAME "GstClockEntry"
242 typedef struct _GstClockEntry GstClockEntry;
243 typedef struct _GstClock GstClock;
244 typedef struct _GstClockClass GstClockClass;
245 typedef struct _GstClockPrivate GstClockPrivate;
247 /* --- prototype for async callbacks --- */
250 * @clock: The clock that triggered the callback
251 * @time: The time it was triggered
252 * @id: The #GstClockID that expired
253 * @user_data: user data passed in the gst_clock_id_wait_async() function
255 * The function prototype of the callback.
257 * Returns: %TRUE or %FALSE (currently unused)
259 typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time,
260 GstClockID id, gpointer user_data);
263 * @GST_CLOCK_OK: The operation succeeded.
264 * @GST_CLOCK_EARLY: The operation was scheduled too late.
265 * @GST_CLOCK_UNSCHEDULED: The clockID was unscheduled
266 * @GST_CLOCK_BUSY: The ClockID is busy
267 * @GST_CLOCK_BADTIME: A bad time was provided to a function.
268 * @GST_CLOCK_ERROR: An error occurred
269 * @GST_CLOCK_UNSUPPORTED: Operation is not supported
270 * @GST_CLOCK_DONE: The ClockID is done waiting (Since: 0.10.32)
272 * The return value of a clock operation.
278 GST_CLOCK_UNSCHEDULED = 2,
280 GST_CLOCK_BADTIME = 4,
282 GST_CLOCK_UNSUPPORTED = 6,
288 * @GST_CLOCK_ENTRY_SINGLE: a single shot timeout
289 * @GST_CLOCK_ENTRY_PERIODIC: a periodic timeout request
291 * The type of the clock entry
294 GST_CLOCK_ENTRY_SINGLE,
295 GST_CLOCK_ENTRY_PERIODIC
300 * @entry: the entry to cast
302 * Cast to a clock entry
304 #define GST_CLOCK_ENTRY(entry) ((GstClockEntry *)(entry))
306 * GST_CLOCK_ENTRY_CLOCK:
307 * @entry: the entry to query
309 * Get the owner clock of the entry
311 #define GST_CLOCK_ENTRY_CLOCK(entry) ((entry)->clock)
313 * GST_CLOCK_ENTRY_TYPE:
314 * @entry: the entry to query
316 * Get the type of the clock entry
318 #define GST_CLOCK_ENTRY_TYPE(entry) ((entry)->type)
320 * GST_CLOCK_ENTRY_TIME:
321 * @entry: the entry to query
323 * Get the requested time of this entry
325 #define GST_CLOCK_ENTRY_TIME(entry) ((entry)->time)
327 * GST_CLOCK_ENTRY_INTERVAL:
328 * @entry: the entry to query
330 * Get the interval of this periodic entry
332 #define GST_CLOCK_ENTRY_INTERVAL(entry) ((entry)->interval)
334 * GST_CLOCK_ENTRY_STATUS:
335 * @entry: the entry to query
337 * The status of the entry
339 #define GST_CLOCK_ENTRY_STATUS(entry) ((entry)->status)
343 * @refcount: reference counter (read-only)
345 * All pending timeouts or periodic notifies are converted into
347 * Note that GstClockEntry should be treated as an opaque structure. It must
348 * not be extended or allocated using a custom allocator.
350 struct _GstClockEntry {
354 GstClockEntryType type;
356 GstClockTime interval;
357 GstClockReturn status;
358 GstClockCallback func;
360 GDestroyNotify destroy_data;
361 gboolean unscheduled;
367 * @GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC: clock can do a single sync timeout request
368 * @GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC: clock can do a single async timeout request
369 * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC: clock can do sync periodic timeout requests
370 * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC: clock can do async periodic timeout callbacks
371 * @GST_CLOCK_FLAG_CAN_SET_RESOLUTION: clock's resolution can be changed
372 * @GST_CLOCK_FLAG_CAN_SET_MASTER: clock can be slaved to a master clock
373 * @GST_CLOCK_FLAG_LAST: subclasses can add additional flags starting from this flag
375 * The capabilities of this clock
378 GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC = (GST_OBJECT_FLAG_LAST << 0),
379 GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC = (GST_OBJECT_FLAG_LAST << 1),
380 GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC = (GST_OBJECT_FLAG_LAST << 2),
381 GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC = (GST_OBJECT_FLAG_LAST << 3),
382 GST_CLOCK_FLAG_CAN_SET_RESOLUTION = (GST_OBJECT_FLAG_LAST << 4),
383 GST_CLOCK_FLAG_CAN_SET_MASTER = (GST_OBJECT_FLAG_LAST << 5),
385 GST_CLOCK_FLAG_LAST = (GST_OBJECT_FLAG_LAST << 8)
390 * @clock: the clock to query
392 * Gets the #GstClockFlags clock flags.
394 #define GST_CLOCK_FLAGS(clock) GST_OBJECT_FLAGS(clock)
398 * @clock: the clock to query
400 * Gets the #GCond that gets signalled when the entries of the clock
403 #define GST_CLOCK_COND(clock) (GST_CLOCK_CAST(clock)->entries_changed)
406 * @clock: the clock to wait on
408 * Wait on the clock until the entries changed.
410 #define GST_CLOCK_WAIT(clock) g_cond_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock))
412 * GST_CLOCK_TIMED_WAIT:
413 * @clock: the clock to wait on
414 * @tv: a #GTimeVal to wait.
416 * Wait on the clock until the entries changed or the specified timeout
419 #define GST_CLOCK_TIMED_WAIT(clock,tv) g_cond_timed_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock),tv)
421 * GST_CLOCK_BROADCAST:
422 * @clock: the clock to broadcast
424 * Signal that the entries in the clock have changed.
426 #define GST_CLOCK_BROADCAST(clock) g_cond_broadcast(GST_CLOCK_COND(clock))
431 * #GstClock base structure. The values of this structure are
432 * protected for subclasses, use the methods to use the #GstClock.
437 GMutex *slave_lock; /* order: SLAVE_LOCK, OBJECT_LOCK */
439 /*< protected >*/ /* with LOCK */
440 GstClockTime internal_calibration;
441 GstClockTime external_calibration;
442 GstClockTime rate_numerator;
443 GstClockTime rate_denominator;
444 GstClockTime last_time;
446 GCond *entries_changed;
448 /*< private >*/ /* with LOCK */
449 GstClockTime resolution;
452 /* for master/slave clocks */
455 /* with SLAVE_LOCK */
458 gint window_threshold;
460 GstClockTime timeout;
466 GstClockPrivate *priv;
467 GstClockTime _gst_reserved[GST_PADDING];
473 * @parent_class: the parent class structure
474 * @change_resolution: change the resolution of the clock. Not all values might
475 * be acceptable. The new resolution should be returned.
476 * @get_resolution: get the resolution of the clock.
477 * @get_internal_time: get the internal unadjusted time of the clock.
478 * implement @wait_jitter instead.
479 * @wait: perform a blocking wait on the given #GstClockEntry and return
481 * @wait_async: perform an asynchronous wait for the given #GstClockEntry.
482 * @unschedule: unblock a blocking or async wait operation.
484 * GStreamer clock class. Override the vmethods to implement the clock
487 struct _GstClockClass {
488 GstObjectClass parent_class;
492 GstClockTime (*change_resolution) (GstClock *clock,
493 GstClockTime old_resolution,
494 GstClockTime new_resolution);
495 GstClockTime (*get_resolution) (GstClock *clock);
497 GstClockTime (*get_internal_time) (GstClock *clock);
499 /* waiting on an ID */
500 GstClockReturn (*wait) (GstClock *clock, GstClockEntry *entry,
501 GstClockTimeDiff *jitter);
502 GstClockReturn (*wait_async) (GstClock *clock, GstClockEntry *entry);
503 void (*unschedule) (GstClock *clock, GstClockEntry *entry);
506 gpointer _gst_reserved[GST_PADDING];
509 GType gst_clock_get_type (void);
511 GstClockTime gst_clock_set_resolution (GstClock *clock,
512 GstClockTime resolution);
513 GstClockTime gst_clock_get_resolution (GstClock *clock);
515 GstClockTime gst_clock_get_time (GstClock *clock);
516 void gst_clock_set_calibration (GstClock *clock, GstClockTime internal,
517 GstClockTime external,
518 GstClockTime rate_num,
519 GstClockTime rate_denom);
520 void gst_clock_get_calibration (GstClock *clock, GstClockTime *internal,
521 GstClockTime *external,
522 GstClockTime *rate_num,
523 GstClockTime *rate_denom);
525 /* master/slave clocks */
526 gboolean gst_clock_set_master (GstClock *clock, GstClock *master);
527 GstClock* gst_clock_get_master (GstClock *clock);
528 gboolean gst_clock_add_observation (GstClock *clock, GstClockTime slave,
529 GstClockTime master, gdouble *r_squared);
532 /* getting and adjusting internal/external time */
533 GstClockTime gst_clock_get_internal_time (GstClock *clock);
534 GstClockTime gst_clock_adjust_unlocked (GstClock *clock, GstClockTime internal);
535 GstClockTime gst_clock_unadjust_unlocked (GstClock * clock, GstClockTime external);
538 /* creating IDs that can be used to get notifications */
539 GstClockID gst_clock_new_single_shot_id (GstClock *clock,
541 GstClockID gst_clock_new_periodic_id (GstClock *clock,
542 GstClockTime start_time,
543 GstClockTime interval);
545 /* reference counting */
546 GstClockID gst_clock_id_ref (GstClockID id);
547 void gst_clock_id_unref (GstClockID id);
549 /* operations on IDs */
550 gint gst_clock_id_compare_func (gconstpointer id1, gconstpointer id2);
552 GstClockTime gst_clock_id_get_time (GstClockID id);
553 GstClockReturn gst_clock_id_wait (GstClockID id,
554 GstClockTimeDiff *jitter);
555 GstClockReturn gst_clock_id_wait_async (GstClockID id,
556 GstClockCallback func,
558 GstClockReturn gst_clock_id_wait_async_full (GstClockID id,
559 GstClockCallback func,
561 GDestroyNotify destroy_data);
562 void gst_clock_id_unschedule (GstClockID id);
564 gboolean gst_clock_single_shot_id_reinit (GstClock * clock,
567 gboolean gst_clock_periodic_id_reinit (GstClock * clock,
569 GstClockTime start_time,
570 GstClockTime interval);
574 #endif /* __GST_CLOCK_H__ */