cleanups
[platform/upstream/gstreamer.git] / 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 typedef struct _GstClockPrivate GstClockPrivate;
239
240 /* --- prototype for async callbacks --- */
241 /**
242  * GstClockCallback:
243  * @clock: The clock that triggered the callback
244  * @time: The time it was triggered
245  * @id: The #GstClockID that expired
246  * @user_data: user data passed in the gst_clock_id_wait_async() function
247  *
248  * The function prototype of the callback.
249  *
250  * Returns: %TRUE or %FALSE (currently unused)
251  */
252 typedef gboolean        (*GstClockCallback)     (GstClock *clock, GstClockTime time,
253                                                  GstClockID id, gpointer user_data);
254 /**
255  * GstClockReturn:
256  * @GST_CLOCK_OK: The operation succeeded.
257  * @GST_CLOCK_EARLY: The operation was scheduled too late.
258  * @GST_CLOCK_UNSCHEDULED: The clockID was unscheduled
259  * @GST_CLOCK_BUSY: The ClockID is busy
260  * @GST_CLOCK_BADTIME: A bad time was provided to a function.
261  * @GST_CLOCK_ERROR: An error occurred
262  * @GST_CLOCK_UNSUPPORTED: Operation is not supported
263  * @GST_CLOCK_DONE: The ClockID is done waiting (Since: 0.10.32)
264  *
265  * The return value of a clock operation.
266  */
267 typedef enum
268 {
269   GST_CLOCK_OK          =  0,
270   GST_CLOCK_EARLY       =  1,
271   GST_CLOCK_UNSCHEDULED =  2,
272   GST_CLOCK_BUSY        =  3,
273   GST_CLOCK_BADTIME     =  4,
274   GST_CLOCK_ERROR       =  5,
275   GST_CLOCK_UNSUPPORTED =  6,
276   GST_CLOCK_DONE        =  7
277 } GstClockReturn;
278
279 /**
280  * GstClockEntryType:
281  * @GST_CLOCK_ENTRY_SINGLE: a single shot timeout
282  * @GST_CLOCK_ENTRY_PERIODIC: a periodic timeout request
283  *
284  * The type of the clock entry
285  */
286 typedef enum {
287   GST_CLOCK_ENTRY_SINGLE,
288   GST_CLOCK_ENTRY_PERIODIC
289 } GstClockEntryType;
290
291 /**
292  * GST_CLOCK_ENTRY:
293  * @entry: the entry to cast
294  *
295  * Cast to a clock entry
296  */
297 #define GST_CLOCK_ENTRY(entry)          ((GstClockEntry *)(entry))
298 /**
299  * GST_CLOCK_ENTRY_CLOCK:
300  * @entry: the entry to query
301  *
302  * Get the owner clock of the entry
303  */
304 #define GST_CLOCK_ENTRY_CLOCK(entry)    ((entry)->clock)
305 /**
306  * GST_CLOCK_ENTRY_TYPE:
307  * @entry: the entry to query
308  *
309  * Get the type of the clock entry
310  */
311 #define GST_CLOCK_ENTRY_TYPE(entry)     ((entry)->type)
312 /**
313  * GST_CLOCK_ENTRY_TIME:
314  * @entry: the entry to query
315  *
316  * Get the requested time of this entry
317  */
318 #define GST_CLOCK_ENTRY_TIME(entry)     ((entry)->time)
319 /**
320  * GST_CLOCK_ENTRY_INTERVAL:
321  * @entry: the entry to query
322  *
323  * Get the interval of this periodic entry
324  */
325 #define GST_CLOCK_ENTRY_INTERVAL(entry) ((entry)->interval)
326 /**
327  * GST_CLOCK_ENTRY_STATUS:
328  * @entry: the entry to query
329  *
330  * The status of the entry
331  */
332 #define GST_CLOCK_ENTRY_STATUS(entry)   ((entry)->status)
333
334 /**
335  * GstClockEntry:
336  * @refcount: reference counter (read-only)
337  *
338  * All pending timeouts or periodic notifies are converted into
339  * an entry.
340  * Note that GstClockEntry should be treated as an opaque structure. It must
341  * not be extended or allocated using a custom allocator.
342  */
343 struct _GstClockEntry {
344   gint                  refcount;
345   /*< protected >*/
346   GstClock              *clock;
347   GstClockEntryType      type;
348   GstClockTime           time;
349   GstClockTime           interval;
350   GstClockReturn         status;
351   GstClockCallback       func;
352   gpointer               user_data;
353   GDestroyNotify         destroy_data;
354   gboolean               unscheduled;
355   gboolean               woken_up;
356 };
357
358 /**
359  * GstClockFlags:
360  * @GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC: clock can do a single sync timeout request
361  * @GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC: clock can do a single async timeout request
362  * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC: clock can do sync periodic timeout requests
363  * @GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC: clock can do async periodic timeout callbacks
364  * @GST_CLOCK_FLAG_CAN_SET_RESOLUTION: clock's resolution can be changed
365  * @GST_CLOCK_FLAG_CAN_SET_MASTER: clock can be slaved to a master clock
366  * @GST_CLOCK_FLAG_LAST: subclasses can add additional flags starting from this flag
367  *
368  * The capabilities of this clock
369  */
370 typedef enum {
371   GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC     = (GST_OBJECT_FLAG_LAST << 0),
372   GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC    = (GST_OBJECT_FLAG_LAST << 1),
373   GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC   = (GST_OBJECT_FLAG_LAST << 2),
374   GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC  = (GST_OBJECT_FLAG_LAST << 3),
375   GST_CLOCK_FLAG_CAN_SET_RESOLUTION     = (GST_OBJECT_FLAG_LAST << 4),
376   GST_CLOCK_FLAG_CAN_SET_MASTER         = (GST_OBJECT_FLAG_LAST << 5),
377   /* padding */
378   GST_CLOCK_FLAG_LAST                   = (GST_OBJECT_FLAG_LAST << 8)
379 } GstClockFlags;
380
381 /**
382  * GST_CLOCK_FLAGS:
383  * @clock: the clock to query
384  *
385  * Gets the #GstClockFlags clock flags.
386  */
387 #define GST_CLOCK_FLAGS(clock)  GST_OBJECT_FLAGS(clock)
388
389 /**
390  * GST_CLOCK_COND:
391  * @clock: the clock to query
392  *
393  * Gets the #GCond that gets signalled when the entries of the clock
394  * changed.
395  */
396 #define GST_CLOCK_COND(clock)            (GST_CLOCK_CAST(clock)->entries_changed)
397 /**
398  * GST_CLOCK_WAIT:
399  * @clock: the clock to wait on
400  *
401  * Wait on the clock until the entries changed.
402  */
403 #define GST_CLOCK_WAIT(clock)            g_cond_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock))
404 /**
405  * GST_CLOCK_TIMED_WAIT:
406  * @clock: the clock to wait on
407  * @tv: a #GTimeVal to wait.
408  *
409  * Wait on the clock until the entries changed or the specified timeout
410  * occurred. 
411  */
412 #define GST_CLOCK_TIMED_WAIT(clock,tv)   g_cond_timed_wait(GST_CLOCK_COND(clock),GST_OBJECT_GET_LOCK(clock),tv)
413 /**
414  * GST_CLOCK_BROADCAST:
415  * @clock: the clock to broadcast
416  *
417  * Signal that the entries in the clock have changed.
418  */
419 #define GST_CLOCK_BROADCAST(clock)       g_cond_broadcast(GST_CLOCK_COND(clock))
420
421 /**
422  * GstClock:
423  *
424  * #GstClock base structure. The values of this structure are
425  * protected for subclasses, use the methods to use the #GstClock.
426  */
427 struct _GstClock {
428   GstObject      object;
429
430   GMutex        *slave_lock; /* order: SLAVE_LOCK, OBJECT_LOCK */
431
432   /*< protected >*/ /* with LOCK */
433   GstClockTime   internal_calibration; 
434   GstClockTime   external_calibration;
435   GstClockTime   rate_numerator;
436   GstClockTime   rate_denominator;
437   GstClockTime   last_time;
438   GList         *entries;
439   GCond         *entries_changed;
440
441   /*< private >*/ /* with LOCK */
442   GstClockTime   resolution;
443   gboolean       stats;
444
445   /* for master/slave clocks */
446   GstClock      *master;
447
448   /* with SLAVE_LOCK */
449   gboolean       filling;
450   gint           window_size;
451   gint           window_threshold;
452   gint           time_index;
453   GstClockTime   timeout;
454   GstClockTime  *times;
455   GstClockID     clockid;
456
457   /*< private >*/
458   union {
459     GstClockPrivate *priv;
460     GstClockTime     _gst_reserved[GST_PADDING];
461   } ABI;
462 };
463
464 /**
465  * GstClockClass:
466  * @parent_class: the parent class structure
467  * @change_resolution: change the resolution of the clock. Not all values might
468  *                     be acceptable. The new resolution should be returned.
469  * @get_resolution: get the resolution of the clock.
470  * @get_internal_time: get the internal unadjusted time of the clock.
471  *        implement @wait_jitter instead.
472  * @wait: perform a blocking wait on the given #GstClockEntry and return
473  *               the jitter.
474  * @wait_async: perform an asynchronous wait for the given #GstClockEntry.
475  * @unschedule: unblock a blocking or async wait operation.
476  *
477  * GStreamer clock class. Override the vmethods to implement the clock
478  * functionality.
479  */
480 struct _GstClockClass {
481   GstObjectClass        parent_class;
482
483   /*< public >*/
484   /* vtable */
485   GstClockTime          (*change_resolution)    (GstClock *clock,
486                                                  GstClockTime old_resolution,
487                                                  GstClockTime new_resolution);
488   GstClockTime          (*get_resolution)       (GstClock *clock);
489
490   GstClockTime          (*get_internal_time)    (GstClock *clock);
491
492   /* waiting on an ID */
493   GstClockReturn        (*wait)                 (GstClock *clock, GstClockEntry *entry,
494                                                  GstClockTimeDiff *jitter);
495   GstClockReturn        (*wait_async)           (GstClock *clock, GstClockEntry *entry);
496   void                  (*unschedule)           (GstClock *clock, GstClockEntry *entry);
497
498   /*< private >*/
499   gpointer _gst_reserved[GST_PADDING];
500 };
501
502 GType                   gst_clock_get_type              (void);
503
504 GstClockTime            gst_clock_set_resolution        (GstClock *clock,
505                                                          GstClockTime resolution);
506 GstClockTime            gst_clock_get_resolution        (GstClock *clock);
507
508 GstClockTime            gst_clock_get_time              (GstClock *clock);
509 void                    gst_clock_set_calibration       (GstClock *clock, GstClockTime internal,
510                                                          GstClockTime external,
511                                                          GstClockTime rate_num,
512                                                          GstClockTime rate_denom);
513 void                    gst_clock_get_calibration       (GstClock *clock, GstClockTime *internal,
514                                                          GstClockTime *external,
515                                                          GstClockTime *rate_num,
516                                                          GstClockTime *rate_denom);
517
518 /* master/slave clocks */
519 gboolean                gst_clock_set_master            (GstClock *clock, GstClock *master);
520 GstClock*               gst_clock_get_master            (GstClock *clock);
521 gboolean                gst_clock_add_observation       (GstClock *clock, GstClockTime slave, 
522                                                          GstClockTime master, gdouble *r_squared);
523
524
525 /* getting and adjusting internal/external time */
526 GstClockTime            gst_clock_get_internal_time     (GstClock *clock);
527 GstClockTime            gst_clock_adjust_unlocked       (GstClock *clock, GstClockTime internal);
528 GstClockTime            gst_clock_unadjust_unlocked     (GstClock * clock, GstClockTime external);
529
530
531 /* creating IDs that can be used to get notifications */
532 GstClockID              gst_clock_new_single_shot_id    (GstClock *clock,
533                                                          GstClockTime time);
534 GstClockID              gst_clock_new_periodic_id       (GstClock *clock,
535                                                          GstClockTime start_time,
536                                                          GstClockTime interval);
537
538 /* reference counting */
539 GstClockID              gst_clock_id_ref                (GstClockID id);
540 void                    gst_clock_id_unref              (GstClockID id);
541
542 /* operations on IDs */
543 gint                    gst_clock_id_compare_func       (gconstpointer id1, gconstpointer id2);
544
545 GstClockTime            gst_clock_id_get_time           (GstClockID id);
546 GstClockReturn          gst_clock_id_wait               (GstClockID id,
547                                                          GstClockTimeDiff *jitter);
548 GstClockReturn          gst_clock_id_wait_async         (GstClockID id,
549                                                          GstClockCallback func,
550                                                          gpointer user_data);
551 GstClockReturn          gst_clock_id_wait_async_full    (GstClockID id,
552                                                          GstClockCallback func,
553                                                          gpointer user_data,
554                                                          GDestroyNotify destroy_data);
555 void                    gst_clock_id_unschedule         (GstClockID id);
556
557 gboolean                gst_clock_single_shot_id_reinit (GstClock * clock,
558                                                          GstClockID id,
559                                                          GstClockTime time);
560 gboolean                gst_clock_periodic_id_reinit    (GstClock * clock,
561                                                          GstClockID id,
562                                                          GstClockTime start_time,
563                                                          GstClockTime interval);
564
565 G_END_DECLS
566
567 #endif /* __GST_CLOCK_H__ */