*
* 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.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
#ifndef __GST_CLOCK_H__
#define __GST_CLOCK_H__
-#include <gst/gstobject.h>
+#include <gst/gstconfig.h>
+#include <glib.h>
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_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))
/**
* GstClockTime:
*
* A datatype to hold a time, measured in nanoseconds.
*/
-typedef guint64 GstClockTime;
+typedef guint64 GstClockTime;
/**
* GST_TYPE_CLOCK_TIME:
*
- * The GType of a GstClockTime.
+ * The #GType of a #GstClockTime.
*/
#define GST_TYPE_CLOCK_TIME G_TYPE_UINT64
/**
* GstClockTimeDiff:
*
- * A datatype to hold a timedifference, measured in nanoseconds.
+ * A datatype to hold a time difference, measured in nanoseconds.
*/
typedef gint64 GstClockTimeDiff;
/**
* GstClockID:
*
- * A datatype to hold the handle to an outstanding async clock callback.
+ * A datatype to hold the handle to an outstanding sync or async clock callback.
*/
typedef gpointer GstClockID;
/**
- * GST_CLOCK_TIME_NONE:
+ * GST_CLOCK_TIME_NONE: (value 18446744073709551615) (type GstClockTime)
*
* Constant to define an undefined clock time.
*/
-#define GST_CLOCK_TIME_NONE ((GstClockTime) -1)
+#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) ((time) != GST_CLOCK_TIME_NONE)
+#define GST_CLOCK_TIME_IS_VALID(time) (((GstClockTime)(time)) != GST_CLOCK_TIME_NONE)
/**
- * GST_SECOND:
+ * GST_CLOCK_STIME_NONE: (value -9223372036854775808) (type GstClockTimeDiff)
+ *
+ * Constant to define an undefined clock time.
+ */
+#define GST_CLOCK_STIME_NONE ((GstClockTimeDiff)G_MININT64)
+/**
+ * GST_CLOCK_STIME_IS_VALID:
+ * @time: signed clock time to validate
+ *
+ * Tests if a given #GstClockTimeDiff of #gint64 represents a valid defined time.
+ *
+ * Since: 1.6
+ */
+#define GST_CLOCK_STIME_IS_VALID(time) (((GstClockTimeDiff)(time)) != GST_CLOCK_STIME_NONE)
+
+/**
+ * GST_SECOND: (value 1000000000) (type GstClockTimeDiff)
*
* Constant that defines one GStreamer second.
*/
-#define GST_SECOND (G_USEC_PER_SEC * G_GINT64_CONSTANT (1000))
+#define GST_SECOND ((GstClockTimeDiff)(G_USEC_PER_SEC * G_GINT64_CONSTANT (1000)))
/**
- * GST_MSECOND:
+ * GST_MSECOND: (value 1000000) (type GstClockTimeDiff)
*
* Constant that defines one GStreamer millisecond.
*/
-#define GST_MSECOND (GST_SECOND / G_GINT64_CONSTANT (1000))
+#define GST_MSECOND ((GstClockTimeDiff)(GST_SECOND / G_GINT64_CONSTANT (1000)))
/**
- * GST_USECOND:
+ * GST_USECOND: (value 1000) (type GstClockTimeDiff)
*
* Constant that defines one GStreamer microsecond.
*/
-#define GST_USECOND (GST_SECOND / G_GINT64_CONSTANT (1000000))
+#define GST_USECOND ((GstClockTimeDiff)(GST_SECOND / G_GINT64_CONSTANT (1000000)))
/**
- * GST_NSECOND:
+ * GST_NSECOND: (value 1) (type GstClockTimeDiff)
*
* Constant that defines one GStreamer nanosecond
*/
-#define GST_NSECOND (GST_SECOND / G_GINT64_CONSTANT (1000000000))
+#define GST_NSECOND ((GstClockTimeDiff)(GST_SECOND / G_GINT64_CONSTANT (1000000000)))
+
+
+/**
+ * GST_TIME_AS_SECONDS:
+ * @time: the time
+ *
+ * Convert a #GstClockTime to seconds.
+ */
+#define GST_TIME_AS_SECONDS(time) ((time) / GST_SECOND)
+/**
+ * GST_TIME_AS_MSECONDS:
+ * @time: the time
+ *
+ * Convert a #GstClockTime to milliseconds (1/1000 of a second).
+ */
+#define GST_TIME_AS_MSECONDS(time) ((time) / G_GINT64_CONSTANT (1000000))
+/**
+ * GST_TIME_AS_USECONDS:
+ * @time: the time
+ *
+ * Convert a #GstClockTime to microseconds (1/1000000 of a second).
+ */
+#define GST_TIME_AS_USECONDS(time) ((time) / G_GINT64_CONSTANT (1000))
+/**
+ * GST_TIME_AS_NSECONDS:
+ * @time: the time
+ *
+ * Convert a #GstClockTime to nanoseconds (1/1000000000 of a second).
+ */
+#define GST_TIME_AS_NSECONDS(time) (time)
/**
* GST_CLOCK_DIFF:
* @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))
+#define GST_CLOCK_DIFF(s, e) (GstClockTimeDiff)((e) - (s))
/**
* GST_TIMEVAL_TO_TIME:
* @tv: the timeval to convert
*
- * Convert a GTimeVal to a #GstClockTime.
+ * Convert a #GTimeVal to a #GstClockTime.
*/
-#define GST_TIMEVAL_TO_TIME(tv) ((tv).tv_sec * GST_SECOND + (tv).tv_usec * GST_USECOND)
+#define GST_TIMEVAL_TO_TIME(tv) (GstClockTime)((tv).tv_sec * GST_SECOND + (tv).tv_usec * GST_USECOND)
/**
* GST_TIME_TO_TIMEVAL:
- * @t: The GstClockTime to convert
+ * @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
*
- * Convert a GstClockTime to a GTimeVal
+ * > 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.
*/
-#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; \
+#define GST_TIME_TO_TIMEVAL(t,tv) \
+G_STMT_START { \
+ g_assert ("Value of time " #t " is out of timeval's range" && \
+ ((t) / GST_SECOND) < G_MAXLONG); \
+ (tv).tv_sec = (glong) (((GstClockTime) (t)) / GST_SECOND); \
+ (tv).tv_usec = (glong) ((((GstClockTime) (t)) - \
+ ((GstClockTime) (tv).tv_sec) * GST_SECOND) \
+ / GST_USECOND); \
} G_STMT_END
/**
*
* 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)
+#define GST_TIMESPEC_TO_TIME(ts) (GstClockTime)((ts).tv_sec * GST_SECOND + (ts).tv_nsec * GST_NSECOND)
/**
* GST_TIME_TO_TIMESPEC:
- * @t: The GstClockTime to convert
+ * @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; \
+#define GST_TIME_TO_TIMESPEC(t,ts) \
+G_STMT_START { \
+ g_assert ("Value of time " #t " is out of timespec's range" && \
+ ((t) / GST_SECOND) < G_MAXLONG); \
+ (ts).tv_sec = (glong) ((t) / GST_SECOND); \
+ (ts).tv_nsec = (glong) (((t) - (ts).tv_sec * GST_SECOND) / GST_NSECOND); \
} G_STMT_END
/* timestamp debugging macros */
/**
- * GST_TIME_FORMAT:
+ * GST_TIME_FORMAT: (skip):
*
- * A format that can be used in printf like format strings to format
- * a GstClockTime value.
+ * A string that can be used in printf-like format strings to display a
+ * #GstClockTime value in h:m:s format. Use GST_TIME_ARGS() to construct
+ * the matching arguments.
+ *
+ * Example:
+ * |[<!-- language="C" -->
+ * printf("%" GST_TIME_FORMAT "\n", GST_TIME_ARGS(ts));
+ * ]|
*/
#define GST_TIME_FORMAT "u:%02u:%02u.%09u"
/**
- * GST_TIME_ARGS:
+ * GST_TIME_ARGS: (skip):
* @t: a #GstClockTime
*
- * Format @t for the GST_TIME_FORMAT format string.
+ * Format @t for the #GST_TIME_FORMAT format string. Note: @t will be
+ * evaluated more than once.
*/
#define GST_TIME_ARGS(t) \
- (guint) (((GstClockTime)(t)) / (GST_SECOND * 60 * 60)), \
- (guint) ((((GstClockTime)(t)) / (GST_SECOND * 60)) % 60), \
- (guint) ((((GstClockTime)(t)) / GST_SECOND) % 60), \
- (guint) (((GstClockTime)(t)) % GST_SECOND)
-
-/**
- * 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;
+ 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_STIME_FORMAT: (skip):
+ *
+ * A string that can be used in printf-like format strings to display a signed
+ * #GstClockTimeDiff or #gint64 value in h:m:s format. Use GST_TIME_ARGS() to
+ * construct the matching arguments.
+ *
+ * Example:
+ * |[
+ * printf("%" GST_STIME_FORMAT "\n", GST_STIME_ARGS(ts));
+ * ]|
+ *
+ * Since: 1.6
+ */
+#define GST_STIME_FORMAT "c%" GST_TIME_FORMAT
+/**
+ * GST_STIME_ARGS: (skip):
+ * @t: a #GstClockTimeDiff or #gint64
+ *
+ * Format @t for the #GST_STIME_FORMAT format string. Note: @t will be
+ * evaluated more than once.
+ *
+ * Since: 1.6
+ */
+#define GST_STIME_ARGS(t) \
+ ((t) == GST_CLOCK_STIME_NONE || (t) >= 0) ? '+' : '-', \
+ GST_CLOCK_STIME_IS_VALID (t) ? \
+ (guint) (((GstClockTime)(ABS(t))) / (GST_SECOND * 60 * 60)) : 99, \
+ GST_CLOCK_STIME_IS_VALID (t) ? \
+ (guint) ((((GstClockTime)(ABS(t))) / (GST_SECOND * 60)) % 60) : 99, \
+ GST_CLOCK_STIME_IS_VALID (t) ? \
+ (guint) ((((GstClockTime)(ABS(t))) / GST_SECOND) % 60) : 99, \
+ GST_CLOCK_STIME_IS_VALID (t) ? \
+ (guint) (((GstClockTime)(ABS(t))) % GST_SECOND) : 999999999
+
+typedef struct _GstClockEntry GstClockEntry;
+typedef struct _GstClock GstClock;
+typedef struct _GstClockClass GstClockClass;
+typedef struct _GstClockPrivate GstClockPrivate;
/* --- prototype for async callbacks --- */
/**
* @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
+ * @user_data: user data passed in the gst_clock_id_wait_async() function
*
* The function prototype of the callback.
*
* Returns: %TRUE or %FALSE (currently unused)
*/
-typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time,
- GstClockID id, gpointer user_data);
+typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime time,
+ GstClockID id, gpointer user_data);
/**
* GstClockReturn:
- * @GST_CLOCK_OK: The operation succeded.
+ * @GST_CLOCK_OK: The operation succeeded.
* @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_ERROR: An error occurred
* @GST_CLOCK_UNSUPPORTED: Operation is not supported
+ * @GST_CLOCK_DONE: The ClockID is done waiting
*
* 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,
+ 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,
+ GST_CLOCK_DONE = 7
} GstClockReturn;
/**
*
* Cast to a clock entry
*/
-#define GST_CLOCK_ENTRY(entry) ((GstClockEntry *)(entry))
+#define GST_CLOCK_ENTRY(entry) ((GstClockEntry *)(entry))
+
+#ifndef GST_DISABLE_DEPRECATED
/**
* GST_CLOCK_ENTRY_CLOCK:
* @entry: the entry to query
*
* Get the owner clock of the entry
+ *
+ * Deprecated: Use gst_clock_id_get_clock() instead.
*/
-#define GST_CLOCK_ENTRY_CLOCK(entry) ((entry)->clock)
+#define GST_CLOCK_ENTRY_CLOCK(entry) ((entry)->clock)
+#endif
/**
* GST_CLOCK_ENTRY_TYPE:
* @entry: the entry to query
*
* Get the type of the clock entry
*/
-#define GST_CLOCK_ENTRY_TYPE(entry) ((entry)->type)
+#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)
+#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)
+#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)
+#define GST_CLOCK_ENTRY_STATUS(entry) ((entry)->status)
/**
* GstClockEntry:
*
* All pending timeouts or periodic notifies are converted into
* an entry.
+ * Note that GstClockEntry should be treated as an opaque structure. It must
+ * not be extended or allocated using a custom allocator.
*/
struct _GstClockEntry {
- gint refcount;
+ gint refcount;
/*< protected >*/
- GstClock *clock;
- GstClockEntryType type;
- GstClockTime time;
- GstClockTime interval;
- GstClockReturn status;
- GstClockCallback func;
- gpointer user_data;
+#ifndef GST_REMOVE_DEPRECATED
+#ifndef GST_DISABLE_DEPRECATED
+ GstClock *clock;
+#else
+ gpointer _clock;
+#endif
+#endif
+ GstClockEntryType type;
+ GstClockTime time;
+ GstClockTime interval;
+ GstClockReturn status;
+ GstClockCallback func;
+ gpointer user_data;
+ GDestroyNotify destroy_data;
+ gboolean unscheduled;
+ gboolean woken_up;
+
+ /*< private >*/
+ gpointer _gst_reserved[GST_PADDING];
};
+#include <gst/gstobject.h>
+
/**
* GstClockFlags:
* @GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC: clock can do a single sync 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_NEEDS_STARTUP_SYNC: clock needs to be synced before it can be used
+ * (Since: 1.6)
+ * @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 = (1 << 1),
- GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC = (1 << 2),
- GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC = (1 << 3),
- GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC = (1 << 4),
- GST_CLOCK_FLAG_CAN_SET_RESOLUTION = (1 << 5),
+ 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),
+ GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC = (GST_OBJECT_FLAG_LAST << 6),
+ /* padding */
+ GST_CLOCK_FLAG_LAST = (GST_OBJECT_FLAG_LAST << 8)
} GstClockFlags;
/**
*
* 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_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_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))
+#define GST_CLOCK_FLAGS(clock) GST_OBJECT_FLAGS(clock)
/**
* GstClock:
- * @flags: The flags specifying the capabilities of the clock.
*
- * GstClock base structure. The values of this structure are
+ * #GstClock base structure. The values of this structure are
* protected for subclasses, use the methods to use the #GstClock.
*/
struct _GstClock {
- GstObject object;
-
- /*< public >*/
- GstClockFlags flags;
-
- /*< protected >*/ /* with LOCK */
- GstClockTime internal_calibration;
- GstClockTime external_calibration;
- gdouble rate;
- GstClockTime last_time;
- GList *entries;
- GCond *entries_changed;
+ GstObject object;
/*< private >*/
- guint64 resolution;
- gboolean stats;
+ GstClockPrivate *priv;
- GstClockTime _gst_reserved[GST_PADDING];
+ gpointer _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.
+ * implement @wait_jitter instead.
+ * @wait: perform a blocking wait on the given #GstClockEntry and return
+ * the jitter.
+ * @wait_async: perform an asynchronous wait for the given #GstClockEntry.
+ * @unschedule: unblock a blocking or async wait operation.
+ *
+ * GStreamer clock class. Override the vmethods to implement the clock
+ * functionality.
+ */
struct _GstClockClass {
GstObjectClass parent_class;
- /*< protected >*/
+ /*< public >*/
/* vtable */
- guint64 (*change_resolution) (GstClock *clock, guint64 old_resolution,
- guint64 new_resolution);
- guint64 (*get_resolution) (GstClock *clock);
+ GstClockTime (*change_resolution) (GstClock *clock,
+ GstClockTime old_resolution,
+ GstClockTime new_resolution);
+ GstClockTime (*get_resolution) (GstClock *clock);
- GstClockTime (*get_internal_time) (GstClock *clock);
+ GstClockTime (*get_internal_time) (GstClock *clock);
/* waiting on an ID */
- GstClockReturn (*wait) (GstClock *clock, GstClockEntry *entry);
+ GstClockReturn (*wait) (GstClock *clock, GstClockEntry *entry,
+ GstClockTimeDiff *jitter);
GstClockReturn (*wait_async) (GstClock *clock, GstClockEntry *entry);
- void (*unschedule) (GstClock *clock, GstClockEntry *entry);
+ void (*unschedule) (GstClock *clock, GstClockEntry *entry);
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
-GType gst_clock_get_type (void);
-
-guint64 gst_clock_set_resolution (GstClock *clock, guint64 resolution);
-guint64 gst_clock_get_resolution (GstClock *clock);
-
-GstClockTime gst_clock_get_time (GstClock *clock);
-void gst_clock_set_calibration (GstClock *clock, GstClockTime internal,
- GstClockTime external, gdouble rate);
-void gst_clock_get_calibration (GstClock *clock, GstClockTime *internal,
- GstClockTime *external, gdouble *rate);
-
-GstClockTime gst_clock_get_internal_time (GstClock *clock);
-GstClockTime gst_clock_adjust_unlocked (GstClock *clock, GstClockTime internal);
-
+GST_API
+GType gst_clock_get_type (void);
+
+GST_API
+GstClockTime gst_clock_set_resolution (GstClock *clock,
+ GstClockTime resolution);
+GST_API
+GstClockTime gst_clock_get_resolution (GstClock *clock);
+
+GST_API
+GstClockTime gst_clock_get_time (GstClock *clock);
+
+GST_API
+void gst_clock_set_calibration (GstClock *clock, GstClockTime internal,
+ GstClockTime external,
+ GstClockTime rate_num,
+ GstClockTime rate_denom);
+GST_API
+void gst_clock_get_calibration (GstClock *clock, GstClockTime *internal,
+ GstClockTime *external,
+ GstClockTime *rate_num,
+ GstClockTime *rate_denom);
+
+/* master/slave clocks */
+
+GST_API
+gboolean gst_clock_set_master (GstClock *clock, GstClock *master);
+
+GST_API
+GstClock* gst_clock_get_master (GstClock *clock);
+
+GST_API
+void gst_clock_set_timeout (GstClock *clock,
+ GstClockTime timeout);
+GST_API
+GstClockTime gst_clock_get_timeout (GstClock *clock);
+
+GST_API
+gboolean gst_clock_add_observation (GstClock *clock, GstClockTime slave,
+ GstClockTime master, gdouble *r_squared);
+GST_API
+gboolean gst_clock_add_observation_unapplied (GstClock *clock, GstClockTime slave,
+ GstClockTime master, gdouble *r_squared,
+ GstClockTime *internal,
+ GstClockTime *external,
+ GstClockTime *rate_num,
+ GstClockTime *rate_denom);
+
+/* getting and adjusting internal/external time */
+
+GST_API
+GstClockTime gst_clock_get_internal_time (GstClock *clock);
+
+GST_API
+GstClockTime gst_clock_adjust_unlocked (GstClock *clock, GstClockTime internal);
+
+GST_API
+GstClockTime gst_clock_adjust_with_calibration (GstClock *clock,
+ GstClockTime internal_target,
+ GstClockTime cinternal,
+ GstClockTime cexternal,
+ GstClockTime cnum,
+ GstClockTime cdenom);
+GST_API
+GstClockTime gst_clock_unadjust_with_calibration (GstClock *clock,
+ GstClockTime external_target,
+ GstClockTime cinternal,
+ GstClockTime cexternal,
+ GstClockTime cnum,
+ GstClockTime cdenom);
+GST_API
+GstClockTime gst_clock_unadjust_unlocked (GstClock * clock, GstClockTime external);
+
+/* waiting for, signalling and checking for synchronization */
+
+GST_API
+gboolean gst_clock_wait_for_sync (GstClock * clock, GstClockTime timeout);
+
+GST_API
+gboolean gst_clock_is_synced (GstClock * clock);
+
+/* to be used by subclasses only */
+
+GST_API
+void gst_clock_set_synced (GstClock * clock, gboolean synced);
/* 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);
+
+GST_API
+GstClockID gst_clock_new_single_shot_id (GstClock *clock,
+ GstClockTime time);
+GST_API
+GstClockID gst_clock_new_periodic_id (GstClock *clock,
+ GstClockTime start_time,
+ GstClockTime interval);
/* reference counting */
+
+GST_API
GstClockID gst_clock_id_ref (GstClockID id);
+
+GST_API
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);
+
+GST_API
+gint gst_clock_id_compare_func (gconstpointer id1, gconstpointer id2);
+
+GST_API
+GstClock * gst_clock_id_get_clock (GstClockID id);
+
+GST_API
+gboolean gst_clock_id_uses_clock (GstClockID id, GstClock * clock);
+
+GST_API
+GstClockTime gst_clock_id_get_time (GstClockID id);
+
+GST_API
+GstClockReturn gst_clock_id_wait (GstClockID id,
+ GstClockTimeDiff *jitter);
+GST_API
+GstClockReturn gst_clock_id_wait_async (GstClockID id,
+ GstClockCallback func,
+ gpointer user_data,
+ GDestroyNotify destroy_data);
+GST_API
+void gst_clock_id_unschedule (GstClockID id);
+
+GST_API
+gboolean gst_clock_single_shot_id_reinit (GstClock * clock,
+ GstClockID id,
+ GstClockTime time);
+GST_API
+gboolean gst_clock_periodic_id_reinit (GstClock * clock,
+ GstClockID id,
+ GstClockTime start_time,
+ GstClockTime interval);
+
+#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstClock, gst_object_unref)
+#endif
G_END_DECLS