gst/gstclock.h

   1 /* GStreamer
   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>
   5  *
   6  * gstclock.h: Header for clock subsystem
   7  *
   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.
  12  *
  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.
  17  *
  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.
  22  */
  23
  24 #ifndef __GST_CLOCK_H__
  25 #define __GST_CLOCK_H__
  26
  27 #include <gst/gstobject.h>
  28
  29 G_BEGIN_DECLS
  30
  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))
  39
  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)
  42
  43 /**
  44  * GstClockTime:
  45  *
  46  * A datatype to hold a time, measured in nanoseconds.
  47  */
  48 typedef guint64 GstClockTime;
  49
  50 /**
  51  * GST_TYPE_CLOCK_TIME:
  52  *
  53  * The #GType of a #GstClockTime.
  54  */
  55 #define GST_TYPE_CLOCK_TIME G_TYPE_UINT64
  56
  57 /**
  58  * GstClockTimeDiff:
  59  *
  60  * A datatype to hold a time difference, measured in nanoseconds.
  61  */
  62 typedef gint64 GstClockTimeDiff;
  63 /**
  64  * GstClockID:
  65  *
  66  * A datatype to hold the handle to an outstanding sync or async clock callback.
  67  */
  68 typedef gpointer GstClockID;
  69
  70 /**
  71  * GST_CLOCK_TIME_NONE:
  72  *
  73  * Constant to define an undefined clock time.
  74  */
  75 #define GST_CLOCK_TIME_NONE             ((GstClockTime) -1)
  76 /**
  77  * GST_CLOCK_TIME_IS_VALID:
  78  * @time: clock time to validate
  79  *
  80  * Tests if a given #GstClockTime represents a valid defined time.
  81  */
  82 #define GST_CLOCK_TIME_IS_VALID(time)   (((GstClockTime)(time)) != GST_CLOCK_TIME_NONE)
  83
  84 /**
  85  * GST_SECOND:
  86  *
  87  * Constant that defines one GStreamer second.
  88  */
  89 #define GST_SECOND  (G_USEC_PER_SEC * G_GINT64_CONSTANT (1000))
  90 /**
  91  * GST_MSECOND:
  92  *
  93  * Constant that defines one GStreamer millisecond.
  94  */
  95 #define GST_MSECOND (GST_SECOND / G_GINT64_CONSTANT (1000))
  96 /**
  97  * GST_USECOND:
  98  *
  99  * Constant that defines one GStreamer microsecond.
 100  */
 101 #define GST_USECOND (GST_SECOND / G_GINT64_CONSTANT (1000000))
 102 /**
 103  * GST_NSECOND:
 104  *
 105  * Constant that defines one GStreamer nanosecond
 106  */
 107 #define GST_NSECOND (GST_SECOND / G_GINT64_CONSTANT (1000000000))
 108
 109
 110 /**
 111  * GST_TIME_AS_SECONDS:
 112  * @time: the time
 113  *
 114  * Convert a #GstClockTime to seconds.
 115  *
 116  * Since: 0.10.16
 117  */
 118 #define GST_TIME_AS_SECONDS(time)  ((time) / GST_SECOND)
 119 /**
 120  * GST_TIME_AS_MSECONDS:
 121  * @time: the time
 122  *
 123  * Convert a #GstClockTime to milliseconds (1/1000 of a second).
 124  *
 125  * Since: 0.10.16
 126  */
 127 #define GST_TIME_AS_MSECONDS(time) ((time) / G_GINT64_CONSTANT (1000000))
 128 /**
 129  * GST_TIME_AS_USECONDS:
 130  * @time: the time
 131  *
 132  * Convert a #GstClockTime to microseconds (1/1000000 of a second).
 133  *
 134  * Since: 0.10.16
 135  */
 136 #define GST_TIME_AS_USECONDS(time) ((time) / G_GINT64_CONSTANT (1000))
 137 /**
 138  * GST_TIME_AS_NSECONDS:
 139  * @time: the time
 140  *
 141  * Convert a #GstClockTime to nanoseconds (1/1000000000 of a second).
 142  *
 143  * Since: 0.10.16
 144  */
 145 #define GST_TIME_AS_NSECONDS(time) (time)
 146
 147 /**
 148  * GST_CLOCK_DIFF:
 149  * @s: the first time
 150  * @e: the second time
 151  *
 152  * Calculate a difference between two clock times as a #GstClockTimeDiff.
 153  * The difference is calculated as @e - @s.
 154  */
 155 #define GST_CLOCK_DIFF(s, e)            (GstClockTimeDiff)((e) - (s))
 156
 157 /**
 158  * GST_TIMEVAL_TO_TIME:
 159  * @tv: the timeval to convert
 160  *
 161  * Convert a #GTimeVal to a #GstClockTime.
 162  */
 163 #define GST_TIMEVAL_TO_TIME(tv)         (GstClockTime)((tv).tv_sec * GST_SECOND + (tv).tv_usec * GST_USECOND)
 164
 165 /**
 166  * GST_TIME_TO_TIMEVAL:
 167  * @t: The #GstClockTime to convert
 168  * @tv: The target timeval
 169  *
 170  * Convert a #GstClockTime to a #GTimeVal
 171  *
 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>
 175  */
 176 #define GST_TIME_TO_TIMEVAL(t,tv)                               \
 177 G_STMT_START {                                                  \
 178   (tv).tv_sec  = ((GstClockTime) (t)) / GST_SECOND;             \
 179   (tv).tv_usec = (((GstClockTime) (t)) -                        \
 180                   ((GstClockTime) (tv).tv_sec) * GST_SECOND)    \
 181                  / GST_USECOND;                                 \
 182 } G_STMT_END
 183
 184 /**
 185  * GST_TIMESPEC_TO_TIME:
 186  * @ts: the timespec to convert
 187  *
 188  * Convert a struct timespec (see man pselect) to a #GstClockTime.
 189  */
 190 #define GST_TIMESPEC_TO_TIME(ts)        (GstClockTime)((ts).tv_sec * GST_SECOND + (ts).tv_nsec * GST_NSECOND)
 191 /**
 192  * GST_TIME_TO_TIMESPEC:
 193  * @t: The #GstClockTime to convert
 194  * @ts: The target timespec
 195  *
 196  * Convert a #GstClockTime to a struct timespec (see man pselect)
 197  */
 198 #define GST_TIME_TO_TIMESPEC(t,ts)                      \
 199 G_STMT_START {                                          \
 200   (ts).tv_sec  =  (t) / GST_SECOND;                     \
 201   (ts).tv_nsec = ((t) - (ts).tv_sec * GST_SECOND) / GST_NSECOND;        \
 202 } G_STMT_END
 203
 204 /* timestamp debugging macros */
 205 /**
 206  * GST_TIME_FORMAT:
 207  *
 208  * A format that can be used in printf like format strings to format
 209  * a #GstClockTime value.
 210  */
 211 #define GST_TIME_FORMAT "u:%02u:%02u.%09u"
 212 /**
 213  * GST_TIME_ARGS:
 214  * @t: a #GstClockTime
 215  *
 216  * Format @t for the GST_TIME_FORMAT format string.
 217  */
 218 #define GST_TIME_ARGS(t) \
 219         GST_CLOCK_TIME_IS_VALID (t) ? \
 220         (guint) (((GstClockTime)(t)) / (GST_SECOND * 60 * 60)) : 99, \
 221         GST_CLOCK_TIME_IS_VALID (t) ? \
 222         (guint) ((((GstClockTime)(t)) / (GST_SECOND * 60)) % 60) : 99, \
 223         GST_CLOCK_TIME_IS_VALID (t) ? \
 224         (guint) ((((GstClockTime)(t)) / GST_SECOND) % 60) : 99, \
 225         GST_CLOCK_TIME_IS_VALID (t) ? \
 226         (guint) (((GstClockTime)(t)) % GST_SECOND) : 999999999
 227
 228 /**
 229  * GST_CLOCK_ENTRY_TRACE_NAME:
 230  *
 231  * The name used for tracing clock entry allocations.
 232  */
 233 #define GST_CLOCK_ENTRY_TRACE_NAME "GstClockEntry"
 234
 235 typedef struct _GstClockEntry   GstClockEntry;
 236 typedef struct _GstClock        GstClock;
 237 typedef struct _GstClockClass   GstClockClass;
 238
 239 /* --- prototype for async callbacks --- */
 240 /**
 241  * GstClockCallback:
 242  * @clock: The clock that triggered the callback
 243  * @time: The time it was triggered
 244  * @id: The #GstClockID that expired
 245  * @user_data: user data passed in the gst_clock_id_wait_async() function
 246  *
 247  * The function prototype of the callback.
 248  *
 249  * Returns: %TRUE or %FALSE (currently unused)
 250  */
 251 typedef gboolean        (*GstClockCallback)     (GstClock *clock, GstClockTime time,
 252                                                  GstClockID id, gpointer user_data);
 253 /**
 254  * GstClockReturn:
 255  * @GST_CLOCK_OK: The operation succeeded.
 256  * @GST_CLOCK_EARLY: The operation was scheduled too late.
 257  * @GST_CLOCK_UNSCHEDULED: The clockID was unscheduled
 258  * @GST_CLOCK_BUSY: The ClockID is busy
 259  * @GST_CLOCK_BADTIME: A bad time was provided to a function.
 260  * @GST_CLOCK_ERROR: An error occurred
 261  * @GST_CLOCK_UNSUPPORTED: Operation is not supported
 262  *
 263  * The return value of a clock operation.
 264  */
 265 typedef enum
 266 {
 267   GST_CLOCK_OK          =  0,
 268   GST_CLOCK_EARLY       =  1,
 269   GST_CLOCK_UNSCHEDULED =  2,
 270   GST_CLOCK_BUSY        =  3,
 271   GST_CLOCK_BADTIME     =  4,
 272   GST_CLOCK_ERROR       =  5,
 273   GST_CLOCK_UNSUPPORTED =  6
 274 } GstClockReturn;
 275
 276 /**
 277  * GstClockEntryType:
 278  * @GST_CLOCK_ENTRY_SINGLE: a single shot timeout
 279  * @GST_CLOCK_ENTRY_PERIODIC: a periodic timeout request
 280  *
 281  * The type of the clock entry
 282  */
 283 typedef enum {
 284   GST_CLOCK_ENTRY_SINGLE,
 285   GST_CLOCK_ENTRY_PERIODIC
 286 } GstClockEntryType;
 287
 288 /**
 289  * GST_CLOCK_ENTRY:
 290  * @entry: the entry to cast
 291  *
 292  * Cast to a clock entry
 293  */
 294 #define GST_CLOCK_ENTRY(entry)          ((GstClockEntry *)(entry))
 295 /**
 296  * GST_CLOCK_ENTRY_CLOCK:
 297  * @entry: the entry to query
 298  *
 299  * Get the owner clock of the entry
 300  */
 301 #define GST_CLOCK_ENTRY_CLOCK(entry)    ((entry)->clock)
 302 /**
 303  * GST_CLOCK_ENTRY_TYPE:
 304  * @entry: the entry to query
 305  *
 306  * Get the type of the clock entry
 307  */
 308 #define GST_CLOCK_ENTRY_TYPE(entry)     ((entry)->type)
 309 /**
 310  * GST_CLOCK_ENTRY_TIME:
 311  * @entry: the entry to query
 312  *
 313  * Get the requested time of this entry
 314  */
 315 #define GST_CLOCK_ENTRY_TIME(entry)     ((entry)->time)
 316 /**
 317  * GST_CLOCK_ENTRY_INTERVAL:
 318  * @entry: the entry to query
 319  *
 320  * Get the interval of this periodic entry
 321  */
 322 #define GST_CLOCK_ENTRY_INTERVAL(entry) ((entry)->interval)
 323 /**
 324  * GST_CLOCK_ENTRY_STATUS:
 325  * @entry: the entry to query
 326  *
 327  * The status of the entry
 328  */
 329 #define GST_CLOCK_ENTRY_STATUS(entry)   ((entry)->status)
 330
 331 /**
 332  * GstClockEntry:
 333  * @refcount: reference counter (read-only)
 334  *
 335  * All pending timeouts or periodic notifies are converted into
 336  * an entry.
 337  */
 338 struct _GstClockEntry {
 339   gint                  refcount;
 340   /*< protected >*/
 341   GstClock              *clock;
 342   GstClockEntryType      type;
 343   GstClockTime           time;
 344   GstClockTime           interval;
 345   GstClockReturn         status;
 346   GstClockCallback       func;
 347   gpointer               user_data;
 348 };
 349
 350 /**
 351  * GstClockFlags:
 352  * @GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC: clock can do a single sync timeout request
 353  * @GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC: clock can do a single async timeout request
 354  * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC: clock can do sync periodic timeout requests
 355  * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC: clock can do async periodic timeout callbacks
 356  * @GST_CLOCK_FLAG_CAN_SET_RESOLUTION: clock's resolution can be changed
 357  * @GST_CLOCK_FLAG_CAN_SET_MASTER: clock can be slaved to a master clock
 358  * @GST_CLOCK_FLAG_LAST: subclasses can add additional flags starting from this flag
 359  *
 360  * The capabilities of this clock
 361  */
 362 typedef enum {
 363   GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC     = (GST_OBJECT_FLAG_LAST << 0),
 364   GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC    = (GST_OBJECT_FLAG_LAST << 1),
 365   GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC   = (GST_OBJECT_FLAG_LAST << 2),
 366   GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC  = (GST_OBJECT_FLAG_LAST << 3),
 367   GST_CLOCK_FLAG_CAN_SET_RESOLUTION     = (GST_OBJECT_FLAG_LAST << 4),
 368   GST_CLOCK_FLAG_CAN_SET_MASTER         = (GST_OBJECT_FLAG_LAST << 5),
 369   /* padding */
 370   GST_CLOCK_FLAG_LAST                   = (GST_OBJECT_FLAG_LAST << 8)
 371 } GstClockFlags;
 372
 373 /**
 374  * GST_CLOCK_FLAGS:
 375  * @clock: the clock to query
 376  *
 377  * Gets the #GstClockFlags clock flags.
 378  */
 379 #define GST_CLOCK_FLAGS(clock)  GST_OBJECT_FLAGS(clock)
 380
 381 /**
 382  * GST_CLOCK_COND:
 383  * @clock: the clock to query
 384  *
 385  * Gets the #GCond that gets signalled when the entries of the clock
 386  * changed.
 387  */
 388 #define GST_CLOCK_COND(clock)            (GST_CLOCK_CAST(clock)->entries_changed)
 389 /**
 390  * GST_CLOCK_WAIT:
 391  * @clock: the clock to wait on
 392  *
 393  * Wait on the clock until the entries changed.
 394  */
 395 #define GST_CLOCK_WAIT(clock)            g_cond_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock))
 396 /**
 397  * GST_CLOCK_TIMED_WAIT:
 398  * @clock: the clock to wait on
 399  * @tv: a #GTimeVal to wait.
 400  *
 401  * Wait on the clock until the entries changed or the specified timeout
 402  * occurred.
 403  */
 404 #define GST_CLOCK_TIMED_WAIT(clock,tv)   g_cond_timed_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock),tv)
 405 /**
 406  * GST_CLOCK_BROADCAST:
 407  * @clock: the clock to broadcast
 408  *
 409  * Signal that the entries in the clock have changed.
 410  */
 411 #define GST_CLOCK_BROADCAST(clock)       g_cond_broadcast(GST_CLOCK_COND(clock))
 412
 413 /**
 414  * GstClock:
 415  *
 416  * #GstClock base structure. The values of this structure are
 417  * protected for subclasses, use the methods to use the #GstClock.
 418  */
 419 struct _GstClock {
 420   GstObject      object;
 421
 422   GMutex        *slave_lock; /* order: SLAVE_LOCK, OBJECT_LOCK */
 423
 424   /*< protected >*/ /* with LOCK */
 425   GstClockTime   internal_calibration;
 426   GstClockTime   external_calibration;
 427   GstClockTime   rate_numerator;
 428   GstClockTime   rate_denominator;
 429   GstClockTime   last_time;
 430   GList         *entries;
 431   GCond         *entries_changed;
 432
 433   /*< private >*/ /* with LOCK */
 434   GstClockTime   resolution;
 435   gboolean       stats;
 436
 437   /* for master/slave clocks */
 438   GstClock      *master;
 439
 440   /* with SLAVE_LOCK */
 441   gboolean       filling;
 442   gint           window_size;
 443   gint           window_threshold;
 444   gint           time_index;
 445   GstClockTime   timeout;
 446   GstClockTime  *times;
 447   GstClockID     clockid;
 448
 449   /*< private >*/
 450   GstClockTime   _gst_reserved[GST_PADDING];
 451 };
 452
 453 /**
 454  * GstClockClass:
 455  * @parent_class: the parent class structure
 456  * @change_resolution: change the resolution of the clock. Not all values might
 457  *                     be acceptable. The new resolution should be returned.
 458  * @get_resolution: get the resolution of the clock.
 459  * @get_internal_time: get the internal unadjusted time of the clock.
 460  * @wait: perform a blocking wait for the given #GstClockEntry. Deprecated,
 461  *        implement @wait_jitter instead.
 462  * @wait_async: perform an asynchronous wait for the given #GstClockEntry.
 463  * @unschedule: unblock a blocking or async wait operation.
 464  * @wait_jitter: perform a blocking wait on the given #GstClockEntry and return
 465  *               the jitter. (Since: 0.10.10)
 466  *
 467  * GStreamer clock class. Override the vmethods to implement the clock
 468  * functionality.
 469  */
 470 struct _GstClockClass {
 471   GstObjectClass        parent_class;
 472
 473   /*< public >*/
 474   /* vtable */
 475   GstClockTime          (*change_resolution)    (GstClock *clock,
 476                                                  GstClockTime old_resolution,
 477                                                  GstClockTime new_resolution);
 478   GstClockTime          (*get_resolution)       (GstClock *clock);
 479
 480   GstClockTime          (*get_internal_time)    (GstClock *clock);
 481
 482   /* waiting on an ID */
 483   GstClockReturn        (*wait)                 (GstClock *clock, GstClockEntry *entry);
 484   GstClockReturn        (*wait_async)           (GstClock *clock, GstClockEntry *entry);
 485   void                  (*unschedule)           (GstClock *clock, GstClockEntry *entry);
 486
 487   /* ABI added to replace the deprecated wait */
 488   GstClockReturn        (*wait_jitter)          (GstClock *clock, GstClockEntry *entry,
 489                                                  GstClockTimeDiff *jitter);
 490   /*< private >*/
 491   gpointer _gst_reserved[GST_PADDING - 1];
 492 };
 493
 494 GType                   gst_clock_get_type              (void);
 495
 496 GstClockTime            gst_clock_set_resolution        (GstClock *clock,
 497                                                          GstClockTime resolution);
 498 GstClockTime            gst_clock_get_resolution        (GstClock *clock);
 499
 500 GstClockTime            gst_clock_get_time              (GstClock *clock);
 501 void                    gst_clock_set_calibration       (GstClock *clock, GstClockTime internal,
 502                                                          GstClockTime external,
 503                                                          GstClockTime rate_num,
 504                                                          GstClockTime rate_denom);
 505 void                    gst_clock_get_calibration       (GstClock *clock, GstClockTime *internal,
 506                                                          GstClockTime *external,
 507                                                          GstClockTime *rate_num,
 508                                                          GstClockTime *rate_denom);
 509
 510 /* master/slave clocks */
 511 gboolean                gst_clock_set_master            (GstClock *clock, GstClock *master);
 512 GstClock*               gst_clock_get_master            (GstClock *clock);
 513 gboolean                gst_clock_add_observation       (GstClock *clock, GstClockTime slave,
 514                                                          GstClockTime master, gdouble *r_squared);
 515
 516
 517 /* getting and adjusting internal/external time */
 518 GstClockTime            gst_clock_get_internal_time     (GstClock *clock);
 519 GstClockTime            gst_clock_adjust_unlocked       (GstClock *clock, GstClockTime internal);
 520 GstClockTime            gst_clock_unadjust_unlocked     (GstClock * clock, GstClockTime external);
 521
 522
 523 /* creating IDs that can be used to get notifications */
 524 GstClockID              gst_clock_new_single_shot_id    (GstClock *clock,
 525                                                          GstClockTime time);
 526 GstClockID              gst_clock_new_periodic_id       (GstClock *clock,
 527                                                          GstClockTime start_time,
 528                                                          GstClockTime interval);
 529
 530 /* reference counting */
 531 GstClockID              gst_clock_id_ref                (GstClockID id);
 532 void                    gst_clock_id_unref              (GstClockID id);
 533
 534 /* operations on IDs */
 535 gint                    gst_clock_id_compare_func       (gconstpointer id1, gconstpointer id2);
 536
 537 GstClockTime            gst_clock_id_get_time           (GstClockID id);
 538 GstClockReturn          gst_clock_id_wait               (GstClockID id,
 539                                                          GstClockTimeDiff *jitter);
 540 GstClockReturn          gst_clock_id_wait_async         (GstClockID id,
 541                                                          GstClockCallback func,
 542                                                          gpointer user_data);
 543 void                    gst_clock_id_unschedule         (GstClockID id);
 544
 545
 546 G_END_DECLS
 547
 548 #endif /* __GST_CLOCK_H__ */