/* GStreamer * Copyright (C) 1999,2000 Erik Walthinsen * 2000 Wim Taymans * 2005 Wim Taymans * * gstclock.h: Header for clock subsystem * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library 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 * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ #ifndef __GST_CLOCK_H__ #define __GST_CLOCK_H__ #include G_BEGIN_DECLS /* --- standard type macros --- */ #define GST_TYPE_CLOCK (gst_clock_get_type ()) #define GST_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_CAST ((clock), GST_TYPE_CLOCK, GstClock)) #define GST_IS_CLOCK(clock) (G_TYPE_CHECK_INSTANCE_TYPE ((clock), GST_TYPE_CLOCK)) #define GST_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_CAST ((cclass), GST_TYPE_CLOCK, GstClockClass)) #define GST_IS_CLOCK_CLASS(cclass) (G_TYPE_CHECK_CLASS_TYPE ((cclass), GST_TYPE_CLOCK)) #define GST_CLOCK_GET_CLASS(clock) (G_TYPE_INSTANCE_GET_CLASS ((clock), GST_TYPE_CLOCK, GstClockClass)) #define GST_CLOCK_CAST(clock) ((GstClock*)(clock)) #define GST_CLOCK_SLAVE_LOCK(clock) g_mutex_lock (GST_CLOCK_CAST (clock)->slave_lock) #define GST_CLOCK_SLAVE_UNLOCK(clock) g_mutex_unlock (GST_CLOCK_CAST (clock)->slave_lock) /** * GstClockTime: * * A datatype to hold a time, measured in nanoseconds. */ typedef guint64 GstClockTime; /** * GST_TYPE_CLOCK_TIME: * * The GType of a GstClockTime. */ #define GST_TYPE_CLOCK_TIME G_TYPE_UINT64 /** * GstClockTimeDiff: * * A datatype to hold a timedifference, measured in nanoseconds. */ typedef gint64 GstClockTimeDiff; /** * GstClockID: * * A datatype to hold the handle to an outstanding sync or async clock callback. */ typedef gpointer GstClockID; /** * GST_CLOCK_TIME_NONE: * * Constant to define an undefined clock time. */ #define GST_CLOCK_TIME_NONE ((GstClockTime) -1) /** * GST_CLOCK_TIME_IS_VALID: * @time: clock time to validate * * Tests if a given #GstClockTime represents a valid defined time. */ #define GST_CLOCK_TIME_IS_VALID(time) (((GstClockTime)(time)) != GST_CLOCK_TIME_NONE) /** * GST_SECOND: * * Constant that defines one GStreamer second. */ #define GST_SECOND (G_USEC_PER_SEC * G_GINT64_CONSTANT (1000)) /** * GST_MSECOND: * * Constant that defines one GStreamer millisecond. */ #define GST_MSECOND (GST_SECOND / G_GINT64_CONSTANT (1000)) /** * GST_USECOND: * * Constant that defines one GStreamer microsecond. */ #define GST_USECOND (GST_SECOND / G_GINT64_CONSTANT (1000000)) /** * GST_NSECOND: * * Constant that defines one GStreamer nanosecond */ #define GST_NSECOND (GST_SECOND / G_GINT64_CONSTANT (1000000000)) /** * GST_CLOCK_DIFF: * @s: the first time * @e: the second time * * Calculate a difference between two clock times as a #GstClockTimeDiff. * The difference is calculated as @e - @s. */ #define GST_CLOCK_DIFF(s, e) (GstClockTimeDiff)((e) - (s)) /** * GST_TIMEVAL_TO_TIME: * @tv: the timeval to convert * * Convert a GTimeVal to a #GstClockTime. */ #define GST_TIMEVAL_TO_TIME(tv) ((tv).tv_sec * GST_SECOND + (tv).tv_usec * GST_USECOND) /** * GST_TIME_TO_TIMEVAL: * @t: The GstClockTime to convert * @tv: The target timeval * * Note: on 32-bit systems, a timeval has a range of only 2^32 - 1 seconds, * which is about 68 years. Expect trouble if you want to schedule stuff * in your pipeline for 2038. * * Convert a GstClockTime to a GTimeVal */ #define GST_TIME_TO_TIMEVAL(t,tv) \ G_STMT_START { \ (tv).tv_sec = ((GstClockTime) (t)) / GST_SECOND; \ (tv).tv_usec = (((GstClockTime) (t)) - \ ((GstClockTime) (tv).tv_sec) * GST_SECOND) \ / GST_USECOND; \ } G_STMT_END /** * GST_TIMESPEC_TO_TIME: * @ts: the timespec to convert * * Convert a struct timespec (see man pselect) to a #GstClockTime. */ #define GST_TIMESPEC_TO_TIME(ts) ((ts).tv_sec * GST_SECOND + (ts).tv_nsec * GST_NSECOND) /** * GST_TIME_TO_TIMESPEC: * @t: The GstClockTime to convert * @ts: The target timespec * * Convert a #GstClockTime to a struct timespec (see man pselect) */ #define GST_TIME_TO_TIMESPEC(t,ts) \ G_STMT_START { \ (ts).tv_sec = (t) / GST_SECOND; \ (ts).tv_nsec = ((t) - (ts).tv_sec * GST_SECOND) / GST_NSECOND; \ } G_STMT_END /* timestamp debugging macros */ /** * GST_TIME_FORMAT: * * A format that can be used in printf like format strings to format * a GstClockTime value. */ #define GST_TIME_FORMAT "u:%02u:%02u.%09u" /** * GST_TIME_ARGS: * @t: a #GstClockTime * * Format @t for the GST_TIME_FORMAT format string. */ #define GST_TIME_ARGS(t) \ GST_CLOCK_TIME_IS_VALID (t) ? \ (guint) (((GstClockTime)(t)) / (GST_SECOND * 60 * 60)) : 99, \ GST_CLOCK_TIME_IS_VALID (t) ? \ (guint) ((((GstClockTime)(t)) / (GST_SECOND * 60)) % 60) : 99, \ GST_CLOCK_TIME_IS_VALID (t) ? \ (guint) ((((GstClockTime)(t)) / GST_SECOND) % 60) : 99, \ GST_CLOCK_TIME_IS_VALID (t) ? \ (guint) (((GstClockTime)(t)) % GST_SECOND) : 999999999 /** * GST_CLOCK_ENTRY_TRACE_NAME: * * The name used for tracing clock entry allocations. */ #define GST_CLOCK_ENTRY_TRACE_NAME "GstClockEntry" typedef struct _GstClockEntry GstClockEntry; typedef struct _GstClock GstClock; typedef struct _GstClockClass GstClockClass; /* --- prototype for async callbacks --- */ /** * GstClockCallback: * @clock: The clock that triggered the callback * @time: The time it was triggered * @id: The #GstClockID that expired * @user_data: user data passed in the async_wait call * * The function prototype of the callback. * * Returns: %TRUE or %FALSE (currently unused) */ typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time, GstClockID id, gpointer user_data); /** * GstClockReturn: * @GST_CLOCK_OK: The operation succeded. * @GST_CLOCK_EARLY: The operation was scheduled too late. * @GST_CLOCK_UNSCHEDULED: The clockID was unscheduled * @GST_CLOCK_BUSY: The ClockID is busy * @GST_CLOCK_BADTIME: A bad time was provided to a function. * @GST_CLOCK_ERROR: An error occured * @GST_CLOCK_UNSUPPORTED: Operation is not supported * * The return value of a clock operation. */ typedef enum { GST_CLOCK_OK = 0, GST_CLOCK_EARLY = 1, GST_CLOCK_UNSCHEDULED = 2, GST_CLOCK_BUSY = 3, GST_CLOCK_BADTIME = 4, GST_CLOCK_ERROR = 5, GST_CLOCK_UNSUPPORTED = 6 } GstClockReturn; /** * GstClockEntryType: * @GST_CLOCK_ENTRY_SINGLE: a single shot timeout * @GST_CLOCK_ENTRY_PERIODIC: a periodic timeout request * * The type of the clock entry */ typedef enum { GST_CLOCK_ENTRY_SINGLE, GST_CLOCK_ENTRY_PERIODIC } GstClockEntryType; /** * GST_CLOCK_ENTRY: * @entry: the entry to cast * * Cast to a clock entry */ #define GST_CLOCK_ENTRY(entry) ((GstClockEntry *)(entry)) /** * GST_CLOCK_ENTRY_CLOCK: * @entry: the entry to query * * Get the owner clock of the entry */ #define GST_CLOCK_ENTRY_CLOCK(entry) ((entry)->clock) /** * GST_CLOCK_ENTRY_TYPE: * @entry: the entry to query * * Get the type of the clock entry */ #define GST_CLOCK_ENTRY_TYPE(entry) ((entry)->type) /** * GST_CLOCK_ENTRY_TIME: * @entry: the entry to query * * Get the requested time of this entry */ #define GST_CLOCK_ENTRY_TIME(entry) ((entry)->time) /** * GST_CLOCK_ENTRY_INTERVAL: * @entry: the entry to query * * Get the interval of this periodic entry */ #define GST_CLOCK_ENTRY_INTERVAL(entry) ((entry)->interval) /** * GST_CLOCK_ENTRY_STATUS: * @entry: the entry to query * * The status of the entry */ #define GST_CLOCK_ENTRY_STATUS(entry) ((entry)->status) /** * GstClockEntry: * @refcount: reference counter (read-only) * * All pending timeouts or periodic notifies are converted into * an entry. */ struct _GstClockEntry { gint refcount; /*< protected >*/ GstClock *clock; GstClockEntryType type; GstClockTime time; GstClockTime interval; GstClockReturn status; GstClockCallback func; gpointer user_data; }; /** * GstClockFlags: * @GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC: clock can do a single sync timeout request * @GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC: clock can do a single async timeout request * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC: clock can do sync periodic timeout requests * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC: clock can do async periodic timeout callbacks * @GST_CLOCK_FLAG_CAN_SET_RESOLUTION: clock's resolution can be changed * @GST_CLOCK_FLAG_CAN_SET_MASTER: clock can be slaved to a master clock * @GST_CLOCK_FLAG_LAST: subclasses can add additional flags starting from this flag * * The capabilities of this clock */ typedef enum { GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC = (GST_OBJECT_FLAG_LAST << 0), GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC = (GST_OBJECT_FLAG_LAST << 1), GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC = (GST_OBJECT_FLAG_LAST << 2), GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC = (GST_OBJECT_FLAG_LAST << 3), GST_CLOCK_FLAG_CAN_SET_RESOLUTION = (GST_OBJECT_FLAG_LAST << 4), GST_CLOCK_FLAG_CAN_SET_MASTER = (GST_OBJECT_FLAG_LAST << 5), /* padding */ GST_CLOCK_FLAG_LAST = (GST_OBJECT_FLAG_LAST << 8) } GstClockFlags; /** * GST_CLOCK_FLAGS: * @clock: the clock to query * * Gets the #GstClockFlags clock flags. */ #define GST_CLOCK_FLAGS(clock) (GST_CLOCK(clock)->flags) /** * GST_CLOCK_COND: * @clock: the clock to query * * Gets the #GCond that gets signaled when the entries of the clock * changed. */ #define GST_CLOCK_COND(clock) (GST_CLOCK_CAST(clock)->entries_changed) /** * GST_CLOCK_WAIT: * @clock: the clock to wait on * * Wait on the clock until the entries changed. */ #define GST_CLOCK_WAIT(clock) g_cond_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock)) /** * GST_CLOCK_TIMED_WAIT: * @clock: the clock to wait on * @tv: a GTimeVal to wait. * * Wait on the clock until the entries changed or the specified timeout * occured. */ #define GST_CLOCK_TIMED_WAIT(clock,tv) g_cond_timed_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock),tv) /** * GST_CLOCK_BROADCAST: * @clock: the clock to broadcast * * Signal that the entries in the clock have changed. */ #define GST_CLOCK_BROADCAST(clock) g_cond_broadcast(GST_CLOCK_COND(clock)) /** * GstClock: * @flags: The flags specifying the capabilities of the clock. * * GstClock base structure. The values of this structure are * protected for subclasses, use the methods to use the #GstClock. */ struct _GstClock { GstObject object; GMutex *slave_lock; /* order: SLAVE_LOCK, OBJECT_LOCK */ /*< protected >*/ /* with LOCK */ GstClockTime internal_calibration; GstClockTime external_calibration; GstClockTime rate_numerator; GstClockTime rate_denominator; GstClockTime last_time; GList *entries; GCond *entries_changed; /*< private >*/ /* with LOCK */ GstClockTime resolution; gboolean stats; /* for master/slave clocks */ GstClock *master; /* with SLAVE_LOCK */ gboolean filling; gint window_size; gint window_threshold; gint time_index; GstClockTime timeout; GstClockTime *times; GstClockID clockid; /*< private >*/ GstClockTime _gst_reserved[GST_PADDING]; }; /** * GstClockClass: * @parent_class: the parent class structure * @change_resolution: change the resolution of the clock. Not all values might * be acceptable. The new resolution should be returned. * @get_resolution: get the resolution of the clock. * @get_internal_time: get the internal unadjusted time of the clock. * @wait: perform a blocking wait for the given GstClockEntry. Deprecated, * implement @wait_jitter instead. * @wait_async: perform an asynchronous wait for the given GstClockEntry. * @unschedule: unblock a blocking or async wait operation. * @wait_jitter: perform a blocking wait on the given GstClockEntry and return * the jitter. * * GStreamer clock class. Override the vmethods to implement the clock * functionality. */ struct _GstClockClass { GstObjectClass parent_class; /*< public >*/ /* vtable */ GstClockTime (*change_resolution) (GstClock *clock, GstClockTime old_resolution, GstClockTime new_resolution); GstClockTime (*get_resolution) (GstClock *clock); GstClockTime (*get_internal_time) (GstClock *clock); /* waiting on an ID */ GstClockReturn (*wait) (GstClock *clock, GstClockEntry *entry); GstClockReturn (*wait_async) (GstClock *clock, GstClockEntry *entry); void (*unschedule) (GstClock *clock, GstClockEntry *entry); /* ABI added to replace the deprecated wait */ GstClockReturn (*wait_jitter) (GstClock *clock, GstClockEntry *entry, GstClockTimeDiff *jitter); /*< private >*/ gpointer _gst_reserved[GST_PADDING - 1]; }; GType gst_clock_get_type (void); GstClockTime gst_clock_set_resolution (GstClock *clock, GstClockTime resolution); GstClockTime gst_clock_get_resolution (GstClock *clock); GstClockTime gst_clock_get_time (GstClock *clock); void gst_clock_set_calibration (GstClock *clock, GstClockTime internal, GstClockTime external, GstClockTime rate_num, GstClockTime rate_denom); void gst_clock_get_calibration (GstClock *clock, GstClockTime *internal, GstClockTime *external, GstClockTime *rate_num, GstClockTime *rate_denom); /* master/slave clocks */ gboolean gst_clock_set_master (GstClock *clock, GstClock *master); GstClock* gst_clock_get_master (GstClock *clock); gboolean gst_clock_add_observation (GstClock *clock, GstClockTime slave, GstClockTime master, gdouble *r_squared); /* getting and adjusting internal time */ GstClockTime gst_clock_get_internal_time (GstClock *clock); GstClockTime gst_clock_adjust_unlocked (GstClock *clock, GstClockTime internal); /* creating IDs that can be used to get notifications */ GstClockID gst_clock_new_single_shot_id (GstClock *clock, GstClockTime time); GstClockID gst_clock_new_periodic_id (GstClock *clock, GstClockTime start_time, GstClockTime interval); /* reference counting */ GstClockID gst_clock_id_ref (GstClockID id); void gst_clock_id_unref (GstClockID id); /* operations on IDs */ gint gst_clock_id_compare_func (gconstpointer id1, gconstpointer id2); GstClockTime gst_clock_id_get_time (GstClockID id); GstClockReturn gst_clock_id_wait (GstClockID id, GstClockTimeDiff *jitter); GstClockReturn gst_clock_id_wait_async (GstClockID id, GstClockCallback func, gpointer user_data); void gst_clock_id_unschedule (GstClockID id); G_END_DECLS #endif /* __GST_CLOCK_H__ */