X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gst%2Fgstclock.h;h=f34c97dac526d8c442afaf8e69336b264a50d5af;hb=2fa00da84e49ac37cbc07a31534575d10c13a6cd;hp=253fc09eea3a2d166bff6fcf74b453380d93da66;hpb=91e13d4970a8860325bab361c7144bfa7c649c71;p=platform%2Fupstream%2Fgstreamer.git diff --git a/gst/gstclock.h b/gst/gstclock.h index 253fc09..f34c97d 100644 --- a/gst/gstclock.h +++ b/gst/gstclock.h @@ -17,13 +17,16 @@ * * 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 +#include + G_BEGIN_DECLS /* --- standard type macros --- */ @@ -63,7 +66,7 @@ typedef gint64 GstClockTimeDiff; typedef gpointer GstClockID; /** - * GST_CLOCK_TIME_NONE: + * GST_CLOCK_TIME_NONE: (value 18446744073709551615) (type GstClockTime) * * Constant to define an undefined clock time. */ @@ -76,43 +79,46 @@ typedef gpointer GstClockID; */ #define GST_CLOCK_TIME_IS_VALID(time) (((GstClockTime)(time)) != GST_CLOCK_TIME_NONE) -/* FIXME: still need to explicitly force types on the defines below */ /** - * GST_SECOND: + * GST_CLOCK_STIME_NONE: (value -9223372036854775808) (type GstClockTimeDiff) * - * Constant that defines one GStreamer second. + * 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 * - * Value: 1000000000 + * Tests if a given #GstClockTimeDiff of #gint64 represents a valid defined time. * + * Since: 1.6 */ -#define GST_SECOND (G_USEC_PER_SEC * G_GINT64_CONSTANT (1000)) +#define GST_CLOCK_STIME_IS_VALID(time) (((GstClockTimeDiff)(time)) != GST_CLOCK_STIME_NONE) + /** - * GST_MSECOND: - * - * Constant that defines one GStreamer millisecond. + * GST_SECOND: (value 1000000000) (type GstClockTimeDiff) * - * Value: 1000000 + * Constant that defines one GStreamer second. + */ +#define GST_SECOND ((GstClockTimeDiff)(G_USEC_PER_SEC * G_GINT64_CONSTANT (1000))) +/** + * 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. - * - * Value: 1000 - * */ -#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 - * - * Value: 1 - * */ -#define GST_NSECOND (GST_SECOND / G_GINT64_CONSTANT (1000000000)) +#define GST_NSECOND ((GstClockTimeDiff)(GST_SECOND / G_GINT64_CONSTANT (1000000000))) /** @@ -120,8 +126,6 @@ typedef gpointer GstClockID; * @time: the time * * Convert a #GstClockTime to seconds. - * - * Since: 0.10.16 */ #define GST_TIME_AS_SECONDS(time) ((time) / GST_SECOND) /** @@ -129,8 +133,6 @@ typedef gpointer GstClockID; * @time: the time * * Convert a #GstClockTime to milliseconds (1/1000 of a second). - * - * Since: 0.10.16 */ #define GST_TIME_AS_MSECONDS(time) ((time) / G_GINT64_CONSTANT (1000000)) /** @@ -138,8 +140,6 @@ typedef gpointer GstClockID; * @time: the time * * Convert a #GstClockTime to microseconds (1/1000000 of a second). - * - * Since: 0.10.16 */ #define GST_TIME_AS_USECONDS(time) ((time) / G_GINT64_CONSTANT (1000)) /** @@ -147,8 +147,6 @@ typedef gpointer GstClockID; * @time: the time * * Convert a #GstClockTime to nanoseconds (1/1000000000 of a second). - * - * Since: 0.10.16 */ #define GST_TIME_AS_NSECONDS(time) (time) @@ -177,16 +175,18 @@ typedef gpointer GstClockID; * * 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. + * > 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)) - \ + 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; \ + / GST_USECOND); \ } G_STMT_END /** @@ -203,28 +203,30 @@ G_STMT_START { \ * * 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 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: - * |[ + * |[ * 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. Note: @t will be @@ -239,6 +241,40 @@ G_STMT_START { \ (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; @@ -268,7 +304,7 @@ typedef gboolean (*GstClockCallback) (GstClock *clock, GstClockTime t * @GST_CLOCK_BADTIME: A bad time was provided to a function. * @GST_CLOCK_ERROR: An error occurred * @GST_CLOCK_UNSUPPORTED: Operation is not supported - * @GST_CLOCK_DONE: The ClockID is done waiting (Since: 0.10.32) + * @GST_CLOCK_DONE: The ClockID is done waiting * * The return value of a clock operation. */ @@ -303,13 +339,18 @@ typedef enum { * Cast to a clock 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) +#endif /** * GST_CLOCK_ENTRY_TYPE: * @entry: the entry to query @@ -351,7 +392,13 @@ typedef enum { struct _GstClockEntry { gint refcount; /*< protected >*/ +#ifndef GST_REMOVE_DEPRECATED +#ifndef GST_DISABLE_DEPRECATED GstClock *clock; +#else + gpointer _clock; +#endif +#endif GstClockEntryType type; GstClockTime time; GstClockTime interval; @@ -362,6 +409,7 @@ struct _GstClockEntry { gboolean unscheduled; gboolean woken_up; + /*< private >*/ gpointer _gst_reserved[GST_PADDING]; }; @@ -375,6 +423,8 @@ struct _GstClockEntry { * @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 @@ -386,6 +436,7 @@ typedef enum { 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; @@ -451,74 +502,149 @@ struct _GstClockClass { gpointer _gst_reserved[GST_PADDING]; }; +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 */ + +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 */ + +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); -GstClockReturn gst_clock_id_wait_async_full (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 #endif /* __GST_CLOCK_H__ */