gstclock.c 44.7 KB
Newer Older
1 2 3
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
4
 *                    2004 Wim Taymans <wim@fluendo.com>
5 6
 *
 * gstclock.c: Clock subsystem for maintaining time sync
Wim Taymans's avatar
Wim Taymans committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * 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.
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
23

24 25 26
/**
 * SECTION:gstclock
 * @short_description: Abstract class for global clocks
Wim Taymans's avatar
Wim Taymans committed
27
 * @see_also: #GstSystemClock, #GstPipeline
28
 *
Wim Taymans's avatar
Wim Taymans committed
29
 * GStreamer uses a global clock to synchronize the plugins in a pipeline.
30
 * Different clock implementations are possible by implementing this abstract
31
 * base class or, more conveniently, by subclassing #GstSystemClock.
32
 *
Wim Taymans's avatar
Wim Taymans committed
33
 * The #GstClock returns a monotonically increasing time with the method
Wim Taymans's avatar
Wim Taymans committed
34 35
 * gst_clock_get_time(). Its accuracy and base time depend on the specific
 * clock implementation but time is always expressed in nanoseconds. Since the
Wim Taymans's avatar
Wim Taymans committed
36
 * baseline of the clock is undefined, the clock time returned is not
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
37
 * meaningful in itself, what matters are the deltas between two clock times.
Wim Taymans's avatar
Wim Taymans committed
38
 * The time returned by a clock is called the absolute time.
Wim Taymans's avatar
Wim Taymans committed
39
 *
40
 * The pipeline uses the clock to calculate the running time. Usually all
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
41
 * renderers synchronize to the global clock using the buffer timestamps, the
Wim Taymans's avatar
Wim Taymans committed
42
 * newsegment events and the element's base time, see #GstPipeline.
Wim Taymans's avatar
Wim Taymans committed
43
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
44 45
 * A clock implementation can support periodic and single shot clock
 * notifications both synchronous and asynchronous.
Wim Taymans's avatar
Wim Taymans committed
46 47
 *
 * One first needs to create a #GstClockID for the periodic or single shot
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
48 49
 * notification using gst_clock_new_single_shot_id() or
 * gst_clock_new_periodic_id().
Wim Taymans's avatar
Wim Taymans committed
50 51 52
 *
 * To perform a blocking wait for the specific time of the #GstClockID use the
 * gst_clock_id_wait(). To receive a callback when the specific time is reached
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
53 54
 * in the clock use gst_clock_id_wait_async(). Both these calls can be
 * interrupted with the gst_clock_id_unschedule() call. If the blocking wait is
Stefan Kost's avatar
Stefan Kost committed
55
 * unscheduled a return value of #GST_CLOCK_UNSCHEDULED is returned.
Wim Taymans's avatar
Wim Taymans committed
56
 *
57
 * Periodic callbacks scheduled async will be repeatedly called automatically
Wim Taymans's avatar
Wim Taymans committed
58
 * until it is unscheduled. To schedule a sync periodic callback,
59
 * gst_clock_id_wait() should be called repeatedly.
60
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
61 62
 * The async callbacks can happen from any thread, either provided by the core
 * or from a streaming thread. The application should be prepared for this.
Wim Taymans's avatar
Wim Taymans committed
63 64
 *
 * A #GstClockID that has been unscheduled cannot be used again for any wait
Wim Taymans's avatar
Wim Taymans committed
65
 * operation, a new #GstClockID should be created and the old unscheduled one
66
 * should be destroyed with gst_clock_id_unref().
Wim Taymans's avatar
Wim Taymans committed
67
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
68 69
 * It is possible to perform a blocking wait on the same #GstClockID from
 * multiple threads. However, registering the same #GstClockID for multiple
Wim Taymans's avatar
Wim Taymans committed
70 71
 * async notifications is not possible, the callback will only be called for
 * the thread registering the entry last.
Wim Taymans's avatar
Wim Taymans committed
72
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
73 74 75 76
 * None of the wait operations unref the #GstClockID, the owner is responsible
 * for unreffing the ids itself. This holds for both periodic and single shot
 * notifications. The reason being that the owner of the #GstClockID has to
 * keep a handle to the #GstClockID to unblock the wait on FLUSHING events or
Wim Taymans's avatar
Wim Taymans committed
77 78
 * state changes and if the entry would be unreffed automatically, the handle 
 * might become invalid without any notification.
Wim Taymans's avatar
Wim Taymans committed
79
 *
80
 * These clock operations do not operate on the running time, so the callbacks
Wim Taymans's avatar
Wim Taymans committed
81 82 83 84
 * will also occur when not in PLAYING state as if the clock just keeps on
 * running. Some clocks however do not progress when the element that provided
 * the clock is not PLAYING.
 *
85
 * When a clock has the #GST_CLOCK_FLAG_CAN_SET_MASTER flag set, it can be
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
86
 * slaved to another #GstClock with the gst_clock_set_master(). The clock will
87
 * then automatically be synchronized to this master clock by repeatedly
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
88
 * sampling the master clock and the slave clock and recalibrating the slave
Kjartan Maraas's avatar
Kjartan Maraas committed
89
 * clock with gst_clock_set_calibration(). This feature is mostly useful for
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
90 91 92
 * plugins that have an internal clock but must operate with another clock
 * selected by the #GstPipeline.  They can track the offset and rate difference
 * of their internal clock relative to the master clock by using the
Wim Taymans's avatar
Wim Taymans committed
93 94
 * gst_clock_get_calibration() function. 
 *
Stefan Kost's avatar
Stefan Kost committed
95 96 97 98 99 100
 * The master/slave synchronisation can be tuned with the #GstClock:timeout,
 * #GstClock:window-size and #GstClock:window-threshold properties.
 * The #GstClock:timeout property defines the interval to sample the master
 * clock and run the calibration functions. #GstClock:window-size defines the
 * number of samples to use when calibrating and #GstClock:window-threshold
 * defines the minimum number of samples before the calibration is performed.
Wim Taymans's avatar
Wim Taymans committed
101
 *
Wim Taymans's avatar
Wim Taymans committed
102
 * Last reviewed on 2012-03-28 (0.11.3)
103
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
104

105 106

#include "gst_private.h"
107
#include <time.h>
108

109
#include "gstclock.h"
110
#include "gstinfo.h"
111
#include "gstutils.h"
112
#include "glib-compat-private.h"
Wim Taymans's avatar
Wim Taymans committed
113

Wim Taymans's avatar
Wim Taymans committed
114
#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
115
/* #define GST_WITH_ALLOC_TRACE */
Wim Taymans's avatar
Wim Taymans committed
116 117 118
#include "gsttrace.h"
static GstAllocTrace *_gst_clock_entry_trace;
#endif
Wim Taymans's avatar
Wim Taymans committed
119

120 121
/* #define DEBUGGING_ENABLED */

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
122 123 124
#define DEFAULT_WINDOW_SIZE             32
#define DEFAULT_WINDOW_THRESHOLD        4
#define DEFAULT_TIMEOUT                 GST_SECOND / 10
125

126 127
enum
{
128 129 130 131
  PROP_0,
  PROP_WINDOW_SIZE,
  PROP_WINDOW_THRESHOLD,
  PROP_TIMEOUT
132 133
};

Wim Taymans's avatar
Wim Taymans committed
134 135 136
#define GST_CLOCK_SLAVE_LOCK(clock)     g_mutex_lock (&GST_CLOCK_CAST (clock)->priv->slave_lock)
#define GST_CLOCK_SLAVE_UNLOCK(clock)   g_mutex_unlock (&GST_CLOCK_CAST (clock)->priv->slave_lock)

137 138
struct _GstClockPrivate
{
Wim Taymans's avatar
Wim Taymans committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
  GMutex slave_lock;            /* order: SLAVE_LOCK, OBJECT_LOCK */

  /* with LOCK */
  GstClockTime internal_calibration;
  GstClockTime external_calibration;
  GstClockTime rate_numerator;
  GstClockTime rate_denominator;
  GstClockTime last_time;

  /* with LOCK */
  GstClockTime resolution;

  /* 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;

163 164 165 166 167 168
  gint pre_count;
  gint post_count;
};

/* seqlocks */
#define read_seqbegin(clock)                                   \
Wim Taymans's avatar
Wim Taymans committed
169
  g_atomic_int_get (&clock->priv->post_count);
170 171 172 173 174

static inline gboolean
read_seqretry (GstClock * clock, gint seq)
{
  /* no retry if the seqnum did not change */
Wim Taymans's avatar
Wim Taymans committed
175
  if (G_LIKELY (seq == g_atomic_int_get (&clock->priv->pre_count)))
176 177 178 179 180 181 182 183 184 185 186
    return FALSE;

  /* wait for the writer to finish and retry */
  GST_OBJECT_LOCK (clock);
  GST_OBJECT_UNLOCK (clock);
  return TRUE;
}

#define write_seqlock(clock)                      \
G_STMT_START {                                    \
  GST_OBJECT_LOCK (clock);                        \
Wim Taymans's avatar
Wim Taymans committed
187
  g_atomic_int_inc (&clock->priv->pre_count);     \
188 189 190 191
} G_STMT_END;

#define write_sequnlock(clock)                    \
G_STMT_START {                                    \
Wim Taymans's avatar
Wim Taymans committed
192
  g_atomic_int_inc (&clock->priv->post_count);    \
193 194 195
  GST_OBJECT_UNLOCK (clock);                      \
} G_STMT_END;

196
static void gst_clock_dispose (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
197
static void gst_clock_finalize (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
198

199 200 201 202
static void gst_clock_set_property (GObject * object, guint prop_id,
    const GValue * value, GParamSpec * pspec);
static void gst_clock_get_property (GObject * object, guint prop_id,
    GValue * value, GParamSpec * pspec);
203

204 205
/* static guint gst_clock_signals[LAST_SIGNAL] = { 0 }; */

Wim Taymans's avatar
Wim Taymans committed
206
static GstClockID
207 208
gst_clock_entry_new (GstClock * clock, GstClockTime time,
    GstClockTime interval, GstClockEntryType type)
209 210
{
  GstClockEntry *entry;
211

212
  entry = g_slice_new (GstClockEntry);
Wim Taymans's avatar
Wim Taymans committed
213
#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
214
  _gst_alloc_trace_new (_gst_clock_entry_trace, entry);
Wim Taymans's avatar
Wim Taymans committed
215
#endif
216 217
  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
      "created entry %p, time %" GST_TIME_FORMAT, entry, GST_TIME_ARGS (time));
218

219
  entry->refcount = 1;
220
  entry->clock = clock;
221
  entry->type = type;
222
  entry->time = time;
223
  entry->interval = interval;
224
  entry->status = GST_CLOCK_OK;
225 226
  entry->func = NULL;
  entry->user_data = NULL;
227
  entry->destroy_data = NULL;
228 229
  entry->unscheduled = FALSE;
  entry->woken_up = FALSE;
230

231 232
  return (GstClockID) entry;
}
233

234
/* WARNING : Does not modify the refcount
235 236 237 238 239 240 241 242 243 244 245 246
 * WARNING : Do not use if a pending clock operation is happening on that entry */
static gboolean
gst_clock_entry_reinit (GstClock * clock, GstClockEntry * entry,
    GstClockTime time, GstClockTime interval, GstClockEntryType type)
{
  g_return_val_if_fail (entry->status != GST_CLOCK_BUSY, FALSE);
  g_return_val_if_fail (entry->clock == clock, FALSE);

  entry->type = type;
  entry->time = time;
  entry->interval = interval;
  entry->status = GST_CLOCK_OK;
247 248
  entry->unscheduled = FALSE;
  entry->woken_up = FALSE;
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263

  return TRUE;
}

/**
 * gst_clock_single_shot_id_reinit:
 * @clock: a #GstClock
 * @id: a #GstClockID
 * @time: The requested time.
 *
 * Reinitializes the provided single shot @id to the provided time. Does not
 * modify the reference count.
 *
 * Returns: %TRUE if the GstClockID could be reinitialized to the provided
 * @time, else %FALSE.
264 265
 *
 * Since: 0.10.32
266 267 268 269 270 271 272 273 274
 */
gboolean
gst_clock_single_shot_id_reinit (GstClock * clock, GstClockID id,
    GstClockTime time)
{
  return gst_clock_entry_reinit (clock, (GstClockEntry *) id, time,
      GST_CLOCK_TIME_NONE, GST_CLOCK_ENTRY_SINGLE);
}

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
/**
 * gst_clock_periodic_id_reinit:
 * @clock: a #GstClock
 * @id: a #GstClockID
 * @start_time: the requested start time
 * @interval: the requested interval
 *
 * Reinitializes the provided periodic @id to the provided start time and
 * interval. Does not modify the reference count.
 *
 * Returns: %TRUE if the GstClockID could be reinitialized to the provided
 * @time, else %FALSE.
 *
 * Since: 0.10.33
 *
 */
gboolean
gst_clock_periodic_id_reinit (GstClock * clock, GstClockID id,
    GstClockTime start_time, GstClockTime interval)
{
  return gst_clock_entry_reinit (clock, (GstClockEntry *) id, start_time,
      interval, GST_CLOCK_ENTRY_PERIODIC);
}

299 300
/**
 * gst_clock_id_ref:
Wim Taymans's avatar
Wim Taymans committed
301
 * @id: The #GstClockID to ref
302
 *
Wim Taymans's avatar
Wim Taymans committed
303
 * Increase the refcount of given @id.
304
 *
305
 * Returns: (transfer full): The same #GstClockID with increased refcount.
306 307 308 309 310 311 312 313
 *
 * MT safe.
 */
GstClockID
gst_clock_id_ref (GstClockID id)
{
  g_return_val_if_fail (id != NULL, NULL);

314
  g_atomic_int_inc (&((GstClockEntry *) id)->refcount);
315 316 317 318 319 320 321

  return id;
}

static void
_gst_clock_id_free (GstClockID id)
{
322
  GstClockEntry *entry;
323 324 325
  g_return_if_fail (id != NULL);

  GST_CAT_DEBUG (GST_CAT_CLOCK, "freed entry %p", id);
326 327 328
  entry = (GstClockEntry *) id;
  if (entry->destroy_data)
    entry->destroy_data (entry->user_data);
329 330

#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
331
  _gst_alloc_trace_free (_gst_clock_entry_trace, id);
332
#endif
333
  g_slice_free (GstClockEntry, id);
334 335 336 337
}

/**
 * gst_clock_id_unref:
338
 * @id: (transfer full): The #GstClockID to unref
339
 *
Wim Taymans's avatar
Wim Taymans committed
340
 * Unref given @id. When the refcount reaches 0 the
341 342 343 344 345 346 347 348 349 350 351
 * #GstClockID will be freed.
 *
 * MT safe.
 */
void
gst_clock_id_unref (GstClockID id)
{
  gint zero;

  g_return_if_fail (id != NULL);

352
  zero = g_atomic_int_dec_and_test (&((GstClockEntry *) id)->refcount);
353 354 355 356 357 358
  /* if we ended up with the refcount at zero, free the id */
  if (zero) {
    _gst_clock_id_free (id);
  }
}

359
/**
360
 * gst_clock_new_single_shot_id:
Wim Taymans's avatar
Wim Taymans committed
361
 * @clock: The #GstClockID to get a single shot notification from
362 363
 * @time: the requested time
 *
Wim Taymans's avatar
Wim Taymans committed
364
 * Get a #GstClockID from @clock to trigger a single shot
365 366
 * notification at the requested time. The single shot id should be
 * unreffed after usage.
367
 *
368 369 370 371
 * Free-function: gst_clock_id_unref
 *
 * Returns: (transfer full): a #GstClockID that can be used to request the
 *     time notification.
372 373
 *
 * MT safe.
374 375
 */
GstClockID
376
gst_clock_new_single_shot_id (GstClock * clock, GstClockTime time)
377
{
378 379
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);

380 381
  return gst_clock_entry_new (clock,
      time, GST_CLOCK_TIME_NONE, GST_CLOCK_ENTRY_SINGLE);
382 383 384
}

/**
385
 * gst_clock_new_periodic_id:
Wim Taymans's avatar
Wim Taymans committed
386
 * @clock: The #GstClockID to get a periodic notification id from
387 388 389
 * @start_time: the requested start time
 * @interval: the requested interval
 *
Wim Taymans's avatar
Wim Taymans committed
390
 * Get an ID from @clock to trigger a periodic notification.
391 392
 * The periodic notifications will start at time @start_time and
 * will then be fired with the given @interval. @id should be unreffed
393
 * after usage.
394
 *
395 396 397 398
 * Free-function: gst_clock_id_unref
 *
 * Returns: (transfer full): a #GstClockID that can be used to request the
 *     time notification.
399 400
 *
 * MT safe.
401 402
 */
GstClockID
403 404
gst_clock_new_periodic_id (GstClock * clock, GstClockTime start_time,
    GstClockTime interval)
405
{
406
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);
407
  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (start_time), NULL);
408
  g_return_val_if_fail (interval != 0, NULL);
409
  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), NULL);
410

411 412
  return gst_clock_entry_new (clock,
      start_time, interval, GST_CLOCK_ENTRY_PERIODIC);
413 414
}

415
/**
416
 * gst_clock_id_compare_func:
Wim Taymans's avatar
Wim Taymans committed
417 418
 * @id1: A #GstClockID
 * @id2: A #GstClockID to compare with
419
 *
Wim Taymans's avatar
Wim Taymans committed
420
 * Compares the two #GstClockID instances. This function can be used
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
 * as a GCompareFunc when sorting ids.
 *
 * Returns: negative value if a < b; zero if a = b; positive value if a > b
 *
 * MT safe.
 */
gint
gst_clock_id_compare_func (gconstpointer id1, gconstpointer id2)
{
  GstClockEntry *entry1, *entry2;

  entry1 = (GstClockEntry *) id1;
  entry2 = (GstClockEntry *) id2;

  if (GST_CLOCK_ENTRY_TIME (entry1) > GST_CLOCK_ENTRY_TIME (entry2)) {
    return 1;
  }
  if (GST_CLOCK_ENTRY_TIME (entry1) < GST_CLOCK_ENTRY_TIME (entry2)) {
    return -1;
  }
Wim Taymans's avatar
Wim Taymans committed
441
  return 0;
442 443
}

444
/**
445
 * gst_clock_id_get_time:
Wim Taymans's avatar
Wim Taymans committed
446
 * @id: The #GstClockID to query
447 448 449
 *
 * Get the time of the clock ID
 *
450 451 452
 * Returns: the time of the given clock id.
 *
 * MT safe.
453 454 455 456 457 458
 */
GstClockTime
gst_clock_id_get_time (GstClockID id)
{
  g_return_val_if_fail (id != NULL, GST_CLOCK_TIME_NONE);

459
  return GST_CLOCK_ENTRY_TIME ((GstClockEntry *) id);
460 461 462
}

/**
463
 * gst_clock_id_wait:
Wim Taymans's avatar
Wim Taymans committed
464
 * @id: The #GstClockID to wait on
Wim Taymans's avatar
Wim Taymans committed
465
 * @jitter: (out) (allow-none): a pointer that will contain the jitter,
466
 *     can be %NULL.
Wim Taymans's avatar
Wim Taymans committed
467 468 469 470 471 472
 *
 * Perform a blocking wait on @id. 
 * @id should have been created with gst_clock_new_single_shot_id()
 * or gst_clock_new_periodic_id() and should not have been unscheduled
 * with a call to gst_clock_id_unschedule(). 
 *
473
 * If the @jitter argument is not %NULL and this function returns #GST_CLOCK_OK
Wim Taymans's avatar
Wim Taymans committed
474 475
 * or #GST_CLOCK_EARLY, it will contain the difference
 * against the clock and the time of @id when this method was
476 477
 * called. 
 * Positive values indicate how late @id was relative to the clock
478
 * (in which case this function will return #GST_CLOCK_EARLY). 
479
 * Negative values indicate how much time was spent waiting on the clock 
480
 * before this function returned.
Wim Taymans's avatar
Wim Taymans committed
481 482 483 484 485
 *
 * Returns: the result of the blocking wait. #GST_CLOCK_EARLY will be returned
 * if the current clock time is past the time of @id, #GST_CLOCK_OK if 
 * @id was scheduled in time. #GST_CLOCK_UNSCHEDULED if @id was 
 * unscheduled with gst_clock_id_unschedule().
486 487
 *
 * MT safe.
488 489
 */
GstClockReturn
490
gst_clock_id_wait (GstClockID id, GstClockTimeDiff * jitter)
491 492
{
  GstClockEntry *entry;
493
  GstClock *clock;
494
  GstClockReturn res;
495
  GstClockTime requested;
Wim Taymans's avatar
Wim Taymans committed
496
  GstClockClass *cclass;
497

498
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
499

500 501
  entry = (GstClockEntry *) id;
  requested = GST_CLOCK_ENTRY_TIME (entry);
502

503 504
  clock = GST_CLOCK_ENTRY_CLOCK (entry);

Wim Taymans's avatar
Wim Taymans committed
505
  /* can't sync on invalid times */
506 507 508
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
509
  cclass = GST_CLOCK_GET_CLASS (clock);
510

Wim Taymans's avatar
Wim Taymans committed
511 512
  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "waiting on clock entry %p", id);

513
  /* if we have a wait_jitter function, use that */
Wim Taymans's avatar
Wim Taymans committed
514 515 516 517
  if (G_UNLIKELY (cclass->wait == NULL))
    goto not_supported;

  res = cclass->wait (clock, entry, jitter);
Wim Taymans's avatar
Wim Taymans committed
518 519 520 521

  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
      "done waiting entry %p, res: %d", id, res);

522 523
  if (entry->type == GST_CLOCK_ENTRY_PERIODIC)
    entry->time = requested + entry->interval;
Wim Taymans's avatar
Wim Taymans committed
524

525
  return res;
526 527 528 529

  /* ERRORS */
invalid_time:
  {
530 531
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
532 533
    return GST_CLOCK_BADTIME;
  }
Wim Taymans's avatar
Wim Taymans committed
534 535 536 537 538
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
539 540 541
}

/**
542
 * gst_clock_id_wait_async_full:
Wim Taymans's avatar
Wim Taymans committed
543
 * @id: a #GstClockID to wait on
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
544
 * @func: The callback function
545
 * @user_data: User data passed in the callback
546
 * @destroy_data: #GDestroyNotify for user_data
547
 *
Wim Taymans's avatar
Wim Taymans committed
548 549
 * Register a callback on the given #GstClockID @id with the given
 * function and user_data. When passing a #GstClockID with an invalid
550
 * time to this function, the callback will be called immediately
551
 * with  a time set to GST_CLOCK_TIME_NONE. The callback will
Wim Taymans's avatar
Wim Taymans committed
552
 * be called when the time of @id has been reached.
553
 *
554 555 556
 * The callback @func can be invoked from any thread, either provided by the
 * core or from a streaming thread. The application should be prepared for this.
 *
557
 * Returns: the result of the non blocking wait.
558 559
 *
 * MT safe.
560 561
 *
 * Since: 0.10.30
562 563
 */
GstClockReturn
564 565
gst_clock_id_wait_async_full (GstClockID id,
    GstClockCallback func, gpointer user_data, GDestroyNotify destroy_data)
566 567 568
{
  GstClockEntry *entry;
  GstClock *clock;
569
  GstClockReturn res;
Wim Taymans's avatar
Wim Taymans committed
570
  GstClockClass *cclass;
571
  GstClockTime requested;
572

573
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
574
  g_return_val_if_fail (func != NULL, GST_CLOCK_ERROR);
575 576

  entry = (GstClockEntry *) id;
577 578
  requested = GST_CLOCK_ENTRY_TIME (entry);
  clock = GST_CLOCK_ENTRY_CLOCK (entry);
579

Wim Taymans's avatar
Wim Taymans committed
580
  /* can't sync on invalid times */
581 582 583
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
584 585
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
586 587 588 589 590
  if (G_UNLIKELY (cclass->wait_async == NULL))
    goto not_supported;

  entry->func = func;
  entry->user_data = user_data;
591
  entry->destroy_data = destroy_data;
Wim Taymans's avatar
Wim Taymans committed
592 593

  res = cclass->wait_async (clock, entry);
Wim Taymans's avatar
Wim Taymans committed
594

595 596
  return res;

597 598 599 600
  /* ERRORS */
invalid_time:
  {
    (func) (clock, GST_CLOCK_TIME_NONE, id, user_data);
601 602
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
603 604
    return GST_CLOCK_BADTIME;
  }
Wim Taymans's avatar
Wim Taymans committed
605 606 607 608 609
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
610 611
}

612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
/**
 * gst_clock_id_wait_async:
 * @id: a #GstClockID to wait on
 * @func: The callback function
 * @user_data: User data passed in the callback
 *
 * Register a callback on the given #GstClockID @id with the given
 * function and user_data. When passing a #GstClockID with an invalid
 * time to this function, the callback will be called immediately
 * with  a time set to GST_CLOCK_TIME_NONE. The callback will
 * be called when the time of @id has been reached.
 *
 * The callback @func can be invoked from any thread, either provided by the
 * core or from a streaming thread. The application should be prepared for this.
 *
 * Returns: the result of the non blocking wait.
 *
 * MT safe.
 */
GstClockReturn
gst_clock_id_wait_async (GstClockID id,
    GstClockCallback func, gpointer user_data)
{
  return gst_clock_id_wait_async_full (id, func, user_data, NULL);
}

638
/**
Wim Taymans's avatar
Wim Taymans committed
639 640
 * gst_clock_id_unschedule:
 * @id: The id to unschedule
641
 *
Wim Taymans's avatar
Wim Taymans committed
642
 * Cancel an outstanding request with @id. This can either
643
 * be an outstanding async notification or a pending sync notification.
Wim Taymans's avatar
Wim Taymans committed
644 645
 * After this call, @id cannot be used anymore to receive sync or
 * async notifications, you need to create a new #GstClockID.
646 647
 *
 * MT safe.
648 649 650 651 652 653
 */
void
gst_clock_id_unschedule (GstClockID id)
{
  GstClockEntry *entry;
  GstClock *clock;
Wim Taymans's avatar
Wim Taymans committed
654
  GstClockClass *cclass;
655

656 657 658 659
  g_return_if_fail (id != NULL);

  entry = (GstClockEntry *) id;
  clock = entry->clock;
660

Wim Taymans's avatar
Wim Taymans committed
661 662
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
663
  if (G_LIKELY (cclass->unschedule))
Wim Taymans's avatar
Wim Taymans committed
664
    cclass->unschedule (clock, entry);
665 666
}

667

Stefan Kost's avatar
Stefan Kost committed
668
/*
669 670
 * GstClock abstract base class implementation
 */
Wim Taymans's avatar
Wim Taymans committed
671
#define gst_clock_parent_class parent_class
672
G_DEFINE_TYPE (GstClock, gst_clock, GST_TYPE_OBJECT);
673

674
static void
675
gst_clock_class_init (GstClockClass * klass)
676
{
677
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
678

Wim Taymans's avatar
Wim Taymans committed
679
#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
680
  _gst_clock_entry_trace = _gst_alloc_trace_register ("GstClockEntry", -1);
Wim Taymans's avatar
Wim Taymans committed
681
#endif
682

683 684 685 686
  gobject_class->dispose = gst_clock_dispose;
  gobject_class->finalize = gst_clock_finalize;
  gobject_class->set_property = gst_clock_set_property;
  gobject_class->get_property = gst_clock_get_property;
687

688
  g_object_class_install_property (gobject_class, PROP_WINDOW_SIZE,
689 690
      g_param_spec_int ("window-size", "Window size",
          "The size of the window used to calculate rate and offset", 2, 1024,
691
          DEFAULT_WINDOW_SIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
692 693
  g_object_class_install_property (gobject_class, PROP_WINDOW_THRESHOLD,
      g_param_spec_int ("window-threshold", "Window threshold",
694
          "The threshold to start calculating rate and offset", 2, 1024,
695 696
          DEFAULT_WINDOW_THRESHOLD,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
697
  g_object_class_install_property (gobject_class, PROP_TIMEOUT,
698 699
      g_param_spec_uint64 ("timeout", "Timeout",
          "The amount of time, in nanoseconds, to sample master and slave clocks",
700 701
          0, G_MAXUINT64, DEFAULT_TIMEOUT,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
702 703

  g_type_class_add_private (klass, sizeof (GstClockPrivate));
Wim Taymans's avatar
Wim Taymans committed
704 705
}

706
static void
707
gst_clock_init (GstClock * clock)
Wim Taymans's avatar
Wim Taymans committed
708
{
Wim Taymans's avatar
Wim Taymans committed
709
  GstClockPrivate *priv;
710

Wim Taymans's avatar
Wim Taymans committed
711
  clock->priv = priv =
712 713
      G_TYPE_INSTANCE_GET_PRIVATE (clock, GST_TYPE_CLOCK, GstClockPrivate);

Wim Taymans's avatar
Wim Taymans committed
714 715 716 717 718 719 720 721 722 723 724 725 726 727
  priv->last_time = 0;

  priv->internal_calibration = 0;
  priv->external_calibration = 0;
  priv->rate_numerator = 1;
  priv->rate_denominator = 1;

  g_mutex_init (&priv->slave_lock);
  priv->window_size = DEFAULT_WINDOW_SIZE;
  priv->window_threshold = DEFAULT_WINDOW_THRESHOLD;
  priv->filling = TRUE;
  priv->time_index = 0;
  priv->timeout = DEFAULT_TIMEOUT;
  priv->times = g_new0 (GstClockTime, 4 * priv->window_size);
Wim Taymans's avatar
Wim Taymans committed
728 729
}

730 731 732 733
static void
gst_clock_dispose (GObject * object)
{
  GstClock *clock = GST_CLOCK (object);
734
  GstClock **master_p;
735 736

  GST_OBJECT_LOCK (clock);
Wim Taymans's avatar
Wim Taymans committed
737
  master_p = &clock->priv->master;
738
  gst_object_replace ((GstObject **) master_p, NULL);
739 740 741 742 743
  GST_OBJECT_UNLOCK (clock);

  G_OBJECT_CLASS (parent_class)->dispose (object);
}

Wim Taymans's avatar
Wim Taymans committed
744
static void
Wim Taymans's avatar
Wim Taymans committed
745
gst_clock_finalize (GObject * object)
Wim Taymans's avatar
Wim Taymans committed
746 747 748
{
  GstClock *clock = GST_CLOCK (object);

749
  GST_CLOCK_SLAVE_LOCK (clock);
Wim Taymans's avatar
Wim Taymans committed
750 751 752 753
  if (clock->priv->clockid) {
    gst_clock_id_unschedule (clock->priv->clockid);
    gst_clock_id_unref (clock->priv->clockid);
    clock->priv->clockid = NULL;
754
  }
Wim Taymans's avatar
Wim Taymans committed
755 756
  g_free (clock->priv->times);
  clock->priv->times = NULL;
757
  GST_CLOCK_SLAVE_UNLOCK (clock);
758

Wim Taymans's avatar
Wim Taymans committed
759
  g_mutex_clear (&clock->priv->slave_lock);
760

Wim Taymans's avatar
Wim Taymans committed
761
  G_OBJECT_CLASS (parent_class)->finalize (object);
Wim Taymans's avatar
Wim Taymans committed
762 763
}

Wim Taymans's avatar
Wim Taymans committed
764
/**
765
 * gst_clock_set_resolution:
766
 * @clock: a #GstClock
767
 * @resolution: The resolution to set
Wim Taymans's avatar
Wim Taymans committed
768
 *
769 770 771 772 773
 * Set the accuracy of the clock. Some clocks have the possibility to operate
 * with different accuracy at the expense of more resource usage. There is
 * normally no need to change the default resolution of a clock. The resolution
 * of a clock can only be changed if the clock has the
 * #GST_CLOCK_FLAG_CAN_SET_RESOLUTION flag set.
774 775
 *
 * Returns: the new resolution of the clock.
Wim Taymans's avatar
Wim Taymans committed
776
 */
777 778
GstClockTime
gst_clock_set_resolution (GstClock * clock, GstClockTime resolution)
Wim Taymans's avatar
Wim Taymans committed
779
{
Wim Taymans's avatar
Wim Taymans committed
780
  GstClockPrivate *priv;
Wim Taymans's avatar
Wim Taymans committed
781 782
  GstClockClass *cclass;

783 784
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
  g_return_val_if_fail (resolution != 0, 0);
785

Wim Taymans's avatar
Wim Taymans committed
786
  cclass = GST_CLOCK_GET_CLASS (clock);
Wim Taymans's avatar
Wim Taymans committed
787
  priv = clock->priv;
Wim Taymans's avatar
Wim Taymans committed
788 789

  if (cclass->change_resolution)
Wim Taymans's avatar
Wim Taymans committed
790 791
    priv->resolution =
        cclass->change_resolution (clock, priv->resolution, resolution);
792

Wim Taymans's avatar
Wim Taymans committed
793
  return priv->resolution;
794
}
795

796
/**
797
 * gst_clock_get_resolution:
798
 * @clock: a #GstClock
799
 *
800 801
 * Get the accuracy of the clock. The accuracy of the clock is the granularity
 * of the values returned by gst_clock_get_time().
802
 *
803
 * Returns: the resolution of the clock in units of #GstClockTime.
804 805
 *
 * MT safe.
806
 */
807
GstClockTime
808
gst_clock_get_resolution (GstClock * clock)
809
{
Wim Taymans's avatar
Wim Taymans committed
810 811
  GstClockClass *cclass;

812
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
813

Wim Taymans's avatar
Wim Taymans committed
814 815 816 817
  cclass = GST_CLOCK_GET_CLASS (clock);

  if (cclass->get_resolution)
    return cclass->get_resolution (clock);
818

819
  return 1;
Wim Taymans's avatar
Wim Taymans committed
820 821
}

Wim Taymans's avatar
Wim Taymans committed
822
/**
823
 * gst_clock_adjust_unlocked:
824 825
 * @clock: a #GstClock to use
 * @internal: a clock time
Wim Taymans's avatar
Wim Taymans committed
826
 *
827
 * Converts the given @internal clock time to the external time, adjusting for the
828 829
 * rate and reference time set with gst_clock_set_calibration() and making sure
 * that the returned time is increasing. This function should be called with the
830
 * clock's OBJECT_LOCK held and is mainly used by clock subclasses.
Wim Taymans's avatar
Wim Taymans committed
831
 *
832
 * This function is the reverse of gst_clock_unadjust_unlocked().
833
 *
834
 * Returns: the converted time of the clock.
835
 */
836 837
GstClockTime
gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
838
{
839
  GstClockTime ret, cinternal, cexternal, cnum, cdenom;
Wim Taymans's avatar
Wim Taymans committed
840
  GstClockPrivate *priv = clock->priv;
841 842

  /* get calibration values for readability */
Wim Taymans's avatar
Wim Taymans committed
843 844 845 846
  cinternal = priv->internal_calibration;
  cexternal = priv->external_calibration;
  cnum = priv->rate_numerator;
  cdenom = priv->rate_denominator;
847 848

  /* avoid divide by 0 */
849
  if (G_UNLIKELY (cdenom == 0))
850 851 852 853 854
    cnum = cdenom = 1;

  /* The formula is (internal - cinternal) * cnum / cdenom + cexternal
   *
   * Since we do math on unsigned 64-bit ints we have to special case for
855
   * internal < cinternal to get the sign right. this case is not very common,
856 857 858
   * though.
   */
  if (G_LIKELY (internal >= cinternal)) {
859 860
    ret = internal - cinternal;
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
861 862
    ret += cexternal;
  } else {
863 864
    ret = cinternal - internal;
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
865
    /* clamp to 0 */
866
    if (G_LIKELY (cexternal > ret))
867 868 869 870
      ret = cexternal - ret;
    else
      ret = 0;
  }
871 872

  /* make sure the time is increasing */
Wim Taymans's avatar
Wim Taymans committed
873
  priv->last_time = MAX (ret, priv->last_time);
874

Wim Taymans's avatar
Wim Taymans committed
875
  return priv->last_time;
876 877
}

878
/**
879
 * gst_clock_unadjust_unlocked:
880 881 882 883 884 885 886 887
 * @clock: a #GstClock to use
 * @external: an external clock time
 *
 * Converts the given @external clock time to the internal time of @clock,
 * using the rate and reference time set with gst_clock_set_calibration().
 * This function should be called with the clock's OBJECT_LOCK held and
 * is mainly used by clock subclasses.
 *
888
 * This function is the reverse of gst_clock_adjust_unlocked().
889 890 891 892 893 894 895 896 897
 *
 * Returns: the internal time of the clock corresponding to @external.
 *
 * Since: 0.10.13
 */
GstClockTime
gst_clock_unadjust_unlocked (GstClock * clock, GstClockTime external)
{
  GstClockTime ret, cinternal, cexternal, cnum, cdenom;
Wim Taymans's avatar
Wim Taymans committed
898
  GstClockPrivate *priv = clock->priv;
899 900

  /* get calibration values for readability */
Wim Taymans's avatar
Wim Taymans committed
901 902 903 904
  cinternal = priv->internal_calibration;
  cexternal = priv->external_calibration;
  cnum = priv->rate_numerator;
  cdenom = priv->rate_denominator;
905 906

  /* avoid divide by 0 */
907
  if (G_UNLIKELY (cnum == 0))
908 909 910
    cnum = cdenom = 1;

  /* The formula is (external - cexternal) * cdenom / cnum + cinternal */
911 912 913
  if (G_LIKELY (external >= cexternal)) {
    ret = external - cexternal;
    ret = gst_util_uint64_scale (ret, cdenom, cnum);
914 915
    ret += cinternal;
  } else {
916 917 918
    ret = cexternal - external;
    ret = gst_util_uint64_scale (ret, cdenom, cnum);
    if (G_LIKELY (cinternal > ret))
919 920 921 922 923 924 925
      ret = cinternal - ret;
    else
      ret = 0;
  }
  return ret;
}

Wim Taymans's avatar
Wim Taymans committed
926
/**
927
 * gst_clock_get_internal_time:
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed