gstclock.c 48.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
 *
 * 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
Tim-Philipp Müller's avatar
Tim-Philipp Müller committed
20 21
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
Wim Taymans's avatar
Wim Taymans committed
22
 */
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.
101
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
102

103
#include "gst_private.h"
104
#include <time.h>
105

106
#include "gstclock.h"
107
#include "gstinfo.h"
108
#include "gstutils.h"
109
#include "glib-compat-private.h"
Wim Taymans's avatar
Wim Taymans committed
110

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

117 118
/* #define DEBUGGING_ENABLED */

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
119 120 121
#define DEFAULT_WINDOW_SIZE             32
#define DEFAULT_WINDOW_THRESHOLD        4
#define DEFAULT_TIMEOUT                 GST_SECOND / 10
122

123 124
enum
{
125 126 127 128
  PROP_0,
  PROP_WINDOW_SIZE,
  PROP_WINDOW_THRESHOLD,
  PROP_TIMEOUT
129 130
};

131 132 133 134 135 136
enum
{
  SIGNAL_SYNCED,
  SIGNAL_LAST
};

Wim Taymans's avatar
Wim Taymans committed
137 138 139
#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)

140 141
struct _GstClockPrivate
{
Wim Taymans's avatar
Wim Taymans committed
142 143
  GMutex slave_lock;            /* order: SLAVE_LOCK, OBJECT_LOCK */

144 145
  GCond sync_cond;

Wim Taymans's avatar
Wim Taymans committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
  /* 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;

168 169
  gint pre_count;
  gint post_count;
170 171

  gboolean synced;
172 173 174 175
};

/* seqlocks */
#define read_seqbegin(clock)                                   \
Wim Taymans's avatar
Wim Taymans committed
176
  g_atomic_int_get (&clock->priv->post_count);
177 178 179 180 181

static inline gboolean
read_seqretry (GstClock * clock, gint seq)
{
  /* no retry if the seqnum did not change */
Wim Taymans's avatar
Wim Taymans committed
182
  if (G_LIKELY (seq == g_atomic_int_get (&clock->priv->pre_count)))
183 184 185 186 187 188 189 190 191 192 193
    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
194
  g_atomic_int_inc (&clock->priv->pre_count);     \
195 196 197 198
} G_STMT_END;

#define write_sequnlock(clock)                    \
G_STMT_START {                                    \
Wim Taymans's avatar
Wim Taymans committed
199
  g_atomic_int_inc (&clock->priv->post_count);    \
200 201 202
  GST_OBJECT_UNLOCK (clock);                      \
} G_STMT_END;

203
#ifndef GST_DISABLE_GST_DEBUG
204 205 206
static const gchar *
gst_clock_return_get_name (GstClockReturn ret)
{
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
  switch (ret) {
    case GST_CLOCK_OK:
      return "ok";
    case GST_CLOCK_EARLY:
      return "early";
    case GST_CLOCK_UNSCHEDULED:
      return "unscheduled";
    case GST_CLOCK_BUSY:
      return "busy";
    case GST_CLOCK_BADTIME:
      return "bad-time";
    case GST_CLOCK_ERROR:
      return "error";
    case GST_CLOCK_UNSUPPORTED:
      return "unsupported";
    case GST_CLOCK_DONE:
      return "done";
    default:
      break;
226
  }
227

228 229
  return "unknown";
}
230
#endif /* GST_DISABLE_GST_DEBUG */
231

232
static void gst_clock_dispose (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
233
static void gst_clock_finalize (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
234

235 236 237 238
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);
239

240
static guint gst_clock_signals[SIGNAL_LAST] = { 0 };
241

Wim Taymans's avatar
Wim Taymans committed
242
static GstClockID
243 244
gst_clock_entry_new (GstClock * clock, GstClockTime time,
    GstClockTime interval, GstClockEntryType type)
245 246
{
  GstClockEntry *entry;
247

248
  entry = g_slice_new (GstClockEntry);
Wim Taymans's avatar
Wim Taymans committed
249
#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
250
  _gst_alloc_trace_new (_gst_clock_entry_trace, entry);
Wim Taymans's avatar
Wim Taymans committed
251
#endif
252 253
  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
      "created entry %p, time %" GST_TIME_FORMAT, entry, GST_TIME_ARGS (time));
254

255
  entry->refcount = 1;
256
  entry->clock = clock;
257
  entry->type = type;
258
  entry->time = time;
259
  entry->interval = interval;
260
  entry->status = GST_CLOCK_OK;
261 262
  entry->func = NULL;
  entry->user_data = NULL;
263
  entry->destroy_data = NULL;
264 265
  entry->unscheduled = FALSE;
  entry->woken_up = FALSE;
266

267 268
  return (GstClockID) entry;
}
269

270
/* WARNING : Does not modify the refcount
271 272 273 274 275 276 277 278 279 280 281 282
 * 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;
283 284
  entry->unscheduled = FALSE;
  entry->woken_up = FALSE;
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308

  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.
 */
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);
}

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
/**
 * 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.
 */
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);
}

330 331
/**
 * gst_clock_id_ref:
Wim Taymans's avatar
Wim Taymans committed
332
 * @id: The #GstClockID to ref
333
 *
Wim Taymans's avatar
Wim Taymans committed
334
 * Increase the refcount of given @id.
335
 *
336
 * Returns: (transfer full): The same #GstClockID with increased refcount.
337 338 339 340 341 342 343 344
 *
 * MT safe.
 */
GstClockID
gst_clock_id_ref (GstClockID id)
{
  g_return_val_if_fail (id != NULL, NULL);

345
  g_atomic_int_inc (&((GstClockEntry *) id)->refcount);
346 347 348 349 350 351 352

  return id;
}

static void
_gst_clock_id_free (GstClockID id)
{
353
  GstClockEntry *entry;
354 355 356
  g_return_if_fail (id != NULL);

  GST_CAT_DEBUG (GST_CAT_CLOCK, "freed entry %p", id);
357 358 359
  entry = (GstClockEntry *) id;
  if (entry->destroy_data)
    entry->destroy_data (entry->user_data);
360 361

#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
362
  _gst_alloc_trace_free (_gst_clock_entry_trace, id);
363
#endif
364
  g_slice_free (GstClockEntry, id);
365 366 367 368
}

/**
 * gst_clock_id_unref:
369
 * @id: (transfer full): The #GstClockID to unref
370
 *
Wim Taymans's avatar
Wim Taymans committed
371
 * Unref given @id. When the refcount reaches 0 the
372 373 374 375 376 377 378 379 380 381 382
 * #GstClockID will be freed.
 *
 * MT safe.
 */
void
gst_clock_id_unref (GstClockID id)
{
  gint zero;

  g_return_if_fail (id != NULL);

383
  zero = g_atomic_int_dec_and_test (&((GstClockEntry *) id)->refcount);
384 385 386 387 388 389
  /* if we ended up with the refcount at zero, free the id */
  if (zero) {
    _gst_clock_id_free (id);
  }
}

390
/**
391
 * gst_clock_new_single_shot_id:
Wim Taymans's avatar
Wim Taymans committed
392
 * @clock: The #GstClockID to get a single shot notification from
393 394
 * @time: the requested time
 *
Wim Taymans's avatar
Wim Taymans committed
395
 * Get a #GstClockID from @clock to trigger a single shot
396 397
 * notification at the requested time. The single shot id should be
 * unreffed after usage.
398
 *
399 400 401 402
 * Free-function: gst_clock_id_unref
 *
 * Returns: (transfer full): a #GstClockID that can be used to request the
 *     time notification.
403 404
 *
 * MT safe.
405 406
 */
GstClockID
407
gst_clock_new_single_shot_id (GstClock * clock, GstClockTime time)
408
{
409 410
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);

411 412
  return gst_clock_entry_new (clock,
      time, GST_CLOCK_TIME_NONE, GST_CLOCK_ENTRY_SINGLE);
413 414 415
}

/**
416
 * gst_clock_new_periodic_id:
Wim Taymans's avatar
Wim Taymans committed
417
 * @clock: The #GstClockID to get a periodic notification id from
418 419 420
 * @start_time: the requested start time
 * @interval: the requested interval
 *
Wim Taymans's avatar
Wim Taymans committed
421
 * Get an ID from @clock to trigger a periodic notification.
422 423
 * The periodic notifications will start at time @start_time and
 * will then be fired with the given @interval. @id should be unreffed
424
 * after usage.
425
 *
426 427 428 429
 * Free-function: gst_clock_id_unref
 *
 * Returns: (transfer full): a #GstClockID that can be used to request the
 *     time notification.
430 431
 *
 * MT safe.
432 433
 */
GstClockID
434 435
gst_clock_new_periodic_id (GstClock * clock, GstClockTime start_time,
    GstClockTime interval)
436
{
437
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);
438
  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (start_time), NULL);
439
  g_return_val_if_fail (interval != 0, NULL);
440
  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), NULL);
441

442 443
  return gst_clock_entry_new (clock,
      start_time, interval, GST_CLOCK_ENTRY_PERIODIC);
444 445
}

446
/**
447
 * gst_clock_id_compare_func:
Wim Taymans's avatar
Wim Taymans committed
448 449
 * @id1: A #GstClockID
 * @id2: A #GstClockID to compare with
450
 *
Wim Taymans's avatar
Wim Taymans committed
451
 * Compares the two #GstClockID instances. This function can be used
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
 * 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
472
  return 0;
473 474
}

475
/**
476
 * gst_clock_id_get_time:
Wim Taymans's avatar
Wim Taymans committed
477
 * @id: The #GstClockID to query
478 479 480
 *
 * Get the time of the clock ID
 *
481 482 483
 * Returns: the time of the given clock id.
 *
 * MT safe.
484 485 486 487 488 489
 */
GstClockTime
gst_clock_id_get_time (GstClockID id)
{
  g_return_val_if_fail (id != NULL, GST_CLOCK_TIME_NONE);

490
  return GST_CLOCK_ENTRY_TIME ((GstClockEntry *) id);
491 492 493
}

/**
494
 * gst_clock_id_wait:
Wim Taymans's avatar
Wim Taymans committed
495
 * @id: The #GstClockID to wait on
Wim Taymans's avatar
Wim Taymans committed
496
 * @jitter: (out) (allow-none): a pointer that will contain the jitter,
497
 *     can be %NULL.
Wim Taymans's avatar
Wim Taymans committed
498 499 500 501 502 503
 *
 * 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(). 
 *
504
 * If the @jitter argument is not %NULL and this function returns #GST_CLOCK_OK
Wim Taymans's avatar
Wim Taymans committed
505 506
 * or #GST_CLOCK_EARLY, it will contain the difference
 * against the clock and the time of @id when this method was
507 508
 * called. 
 * Positive values indicate how late @id was relative to the clock
509
 * (in which case this function will return #GST_CLOCK_EARLY). 
510
 * Negative values indicate how much time was spent waiting on the clock 
511
 * before this function returned.
Wim Taymans's avatar
Wim Taymans committed
512 513 514 515 516
 *
 * 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().
517 518
 *
 * MT safe.
519 520
 */
GstClockReturn
521
gst_clock_id_wait (GstClockID id, GstClockTimeDiff * jitter)
522 523
{
  GstClockEntry *entry;
524
  GstClock *clock;
525
  GstClockReturn res;
526
  GstClockTime requested;
Wim Taymans's avatar
Wim Taymans committed
527
  GstClockClass *cclass;
528

529
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
530

531 532
  entry = (GstClockEntry *) id;
  requested = GST_CLOCK_ENTRY_TIME (entry);
533

534 535
  clock = GST_CLOCK_ENTRY_CLOCK (entry);

Wim Taymans's avatar
Wim Taymans committed
536
  /* can't sync on invalid times */
537 538 539
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
540
  cclass = GST_CLOCK_GET_CLASS (clock);
541

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

544
  /* if we have a wait_jitter function, use that */
Wim Taymans's avatar
Wim Taymans committed
545 546 547 548
  if (G_UNLIKELY (cclass->wait == NULL))
    goto not_supported;

  res = cclass->wait (clock, entry, jitter);
Wim Taymans's avatar
Wim Taymans committed
549 550

  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
551 552
      "done waiting entry %p, res: %d (%s)", id, res,
      gst_clock_return_get_name (res));
Wim Taymans's avatar
Wim Taymans committed
553

554 555
  if (entry->type == GST_CLOCK_ENTRY_PERIODIC)
    entry->time = requested + entry->interval;
Wim Taymans's avatar
Wim Taymans committed
556

557
  return res;
558 559 560 561

  /* ERRORS */
invalid_time:
  {
562 563
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
564 565
    return GST_CLOCK_BADTIME;
  }
Wim Taymans's avatar
Wim Taymans committed
566 567 568 569 570
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
571 572 573
}

/**
Wim Taymans's avatar
Wim Taymans committed
574
 * gst_clock_id_wait_async:
Wim Taymans's avatar
Wim Taymans committed
575
 * @id: a #GstClockID to wait on
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
576
 * @func: The callback function
577
 * @user_data: User data passed in the callback
578
 * @destroy_data: #GDestroyNotify for user_data
579
 *
Wim Taymans's avatar
Wim Taymans committed
580 581
 * Register a callback on the given #GstClockID @id with the given
 * function and user_data. When passing a #GstClockID with an invalid
582
 * time to this function, the callback will be called immediately
583
 * with  a time set to GST_CLOCK_TIME_NONE. The callback will
Wim Taymans's avatar
Wim Taymans committed
584
 * be called when the time of @id has been reached.
585
 *
586 587 588
 * 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.
 *
589
 * Returns: the result of the non blocking wait.
590 591
 *
 * MT safe.
592 593
 */
GstClockReturn
Wim Taymans's avatar
Wim Taymans committed
594
gst_clock_id_wait_async (GstClockID id,
595
    GstClockCallback func, gpointer user_data, GDestroyNotify destroy_data)
596 597 598
{
  GstClockEntry *entry;
  GstClock *clock;
599
  GstClockReturn res;
Wim Taymans's avatar
Wim Taymans committed
600
  GstClockClass *cclass;
601
  GstClockTime requested;
602

603
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
604
  g_return_val_if_fail (func != NULL, GST_CLOCK_ERROR);
605 606

  entry = (GstClockEntry *) id;
607 608
  requested = GST_CLOCK_ENTRY_TIME (entry);
  clock = GST_CLOCK_ENTRY_CLOCK (entry);
609

Wim Taymans's avatar
Wim Taymans committed
610
  /* can't sync on invalid times */
611 612 613
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
614 615
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
616 617 618 619 620
  if (G_UNLIKELY (cclass->wait_async == NULL))
    goto not_supported;

  entry->func = func;
  entry->user_data = user_data;
621
  entry->destroy_data = destroy_data;
Wim Taymans's avatar
Wim Taymans committed
622 623

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

625 626
  return res;

627 628 629 630
  /* ERRORS */
invalid_time:
  {
    (func) (clock, GST_CLOCK_TIME_NONE, id, user_data);
631 632
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
633 634
    return GST_CLOCK_BADTIME;
  }
Wim Taymans's avatar
Wim Taymans committed
635 636 637 638 639
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
640 641
}

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

660 661 662 663
  g_return_if_fail (id != NULL);

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

Wim Taymans's avatar
Wim Taymans committed
665 666
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
667
  if (G_LIKELY (cclass->unschedule))
Wim Taymans's avatar
Wim Taymans committed
668
    cclass->unschedule (clock, entry);
669 670
}

671

Stefan Kost's avatar
Stefan Kost committed
672
/*
673 674
 * GstClock abstract base class implementation
 */
Wim Taymans's avatar
Wim Taymans committed
675
#define gst_clock_parent_class parent_class
Wim Taymans's avatar
Wim Taymans committed
676
G_DEFINE_ABSTRACT_TYPE (GstClock, gst_clock, GST_TYPE_OBJECT);
677

678
static void
679
gst_clock_class_init (GstClockClass * klass)
680
{
681
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
682

Wim Taymans's avatar
Wim Taymans committed
683
#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
684
  _gst_clock_entry_trace = _gst_alloc_trace_register ("GstClockEntry", -1);
Wim Taymans's avatar
Wim Taymans committed
685
#endif
686

687 688 689 690
  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;
691

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

707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
  /**
   * GstClock::synced:
   * @clock: the clock
   * @synced: if the clock is synced now
   *
   * Signaled on clocks with GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC set once
   * the clock is synchronized, or when it completely lost synchronization.
   * This signal will not be emitted on clocks without the flag.
   *
   * This signal will be emitted from an arbitrary thread, most likely not
   * the application's main thread.
   *
   * Since: 1.6
   */
  gst_clock_signals[SIGNAL_SYNCED] =
      g_signal_new ("synced", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
      0, NULL, NULL,
      g_cclosure_marshal_generic, G_TYPE_NONE, 1, G_TYPE_BOOLEAN);

726
  g_type_class_add_private (klass, sizeof (GstClockPrivate));
Wim Taymans's avatar
Wim Taymans committed
727 728
}

729
static void
730
gst_clock_init (GstClock * clock)
Wim Taymans's avatar
Wim Taymans committed
731
{
Wim Taymans's avatar
Wim Taymans committed
732
  GstClockPrivate *priv;
733

Wim Taymans's avatar
Wim Taymans committed
734
  clock->priv = priv =
735 736
      G_TYPE_INSTANCE_GET_PRIVATE (clock, GST_TYPE_CLOCK, GstClockPrivate);

Wim Taymans's avatar
Wim Taymans committed
737 738 739 740 741 742 743 744
  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);
745
  g_cond_init (&priv->sync_cond);
Wim Taymans's avatar
Wim Taymans committed
746 747 748 749 750 751
  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);
752 753 754

  /* clear floating flag */
  gst_object_ref_sink (clock);
Wim Taymans's avatar
Wim Taymans committed
755 756
}

757 758 759 760
static void
gst_clock_dispose (GObject * object)
{
  GstClock *clock = GST_CLOCK (object);
761
  GstClock **master_p;
762 763

  GST_OBJECT_LOCK (clock);
Wim Taymans's avatar
Wim Taymans committed
764
  master_p = &clock->priv->master;
765
  gst_object_replace ((GstObject **) master_p, NULL);
766 767 768 769 770
  GST_OBJECT_UNLOCK (clock);

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

Wim Taymans's avatar
Wim Taymans committed
771
static void
Wim Taymans's avatar
Wim Taymans committed
772
gst_clock_finalize (GObject * object)
Wim Taymans's avatar
Wim Taymans committed
773 774 775
{
  GstClock *clock = GST_CLOCK (object);

776
  GST_CLOCK_SLAVE_LOCK (clock);
Wim Taymans's avatar
Wim Taymans committed
777 778 779 780
  if (clock->priv->clockid) {
    gst_clock_id_unschedule (clock->priv->clockid);
    gst_clock_id_unref (clock->priv->clockid);
    clock->priv->clockid = NULL;
781
  }
Wim Taymans's avatar
Wim Taymans committed
782 783
  g_free (clock->priv->times);
  clock->priv->times = NULL;
784
  GST_CLOCK_SLAVE_UNLOCK (clock);
785

Wim Taymans's avatar
Wim Taymans committed
786
  g_mutex_clear (&clock->priv->slave_lock);
787
  g_cond_clear (&clock->priv->sync_cond);
788

Wim Taymans's avatar
Wim Taymans committed
789
  G_OBJECT_CLASS (parent_class)->finalize (object);
Wim Taymans's avatar
Wim Taymans committed
790 791
}

Wim Taymans's avatar
Wim Taymans committed
792
/**
793
 * gst_clock_set_resolution:
794
 * @clock: a #GstClock
795
 * @resolution: The resolution to set
Wim Taymans's avatar
Wim Taymans committed
796
 *
797 798 799 800 801
 * 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.
802 803
 *
 * Returns: the new resolution of the clock.
Wim Taymans's avatar
Wim Taymans committed
804
 */
805 806
GstClockTime
gst_clock_set_resolution (GstClock * clock, GstClockTime resolution)
Wim Taymans's avatar
Wim Taymans committed
807
{
Wim Taymans's avatar
Wim Taymans committed
808
  GstClockPrivate *priv;
Wim Taymans's avatar
Wim Taymans committed
809 810
  GstClockClass *cclass;

811 812
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
  g_return_val_if_fail (resolution != 0, 0);
813

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

  if (cclass->change_resolution)
Wim Taymans's avatar
Wim Taymans committed
818 819
    priv->resolution =
        cclass->change_resolution (clock, priv->resolution, resolution);
820

Wim Taymans's avatar
Wim Taymans committed
821
  return priv->resolution;
822
}
823

824
/**
825
 * gst_clock_get_resolution:
826
 * @clock: a #GstClock
827
 *
828 829
 * Get the accuracy of the clock. The accuracy of the clock is the granularity
 * of the values returned by gst_clock_get_time().
830
 *
831
 * Returns: the resolution of the clock in units of #GstClockTime.
832 833
 *
 * MT safe.
834
 */
835
GstClockTime
836
gst_clock_get_resolution (GstClock * clock)
837
{
Wim Taymans's avatar
Wim Taymans committed
838 839
  GstClockClass *cclass;

840
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
841

Wim Taymans's avatar
Wim Taymans committed
842 843 844 845
  cclass = GST_CLOCK_GET_CLASS (clock);

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

847
  return 1;
Wim Taymans's avatar
Wim Taymans committed
848 849
}

850
/* FIXME 2.0: Remove clock parameter below */
Wim Taymans's avatar
Wim Taymans committed
851
/**
852
 * gst_clock_adjust_with_calibration:
853
 * @clock: (allow-none): a #GstClock to use
854 855 856 857 858 859 860 861 862 863 864 865
 * @internal_target: a clock time
 * @cinternal: a reference internal time
 * @cexternal: a reference external time
 * @cnum: the numerator of the rate of the clock relative to its
 *        internal time
 * @cdenom: the denominator of the rate of the clock
 *
 * Converts the given @internal_target clock time to the external time,
 * using the passed calibration parameters. This function performs the
 * same calculation as gst_clock_adjust_unlocked() when called using the
 * current calibration parameters, but doesn't ensure a monotonically
 * increasing result as gst_clock_adjust_unlocked() does.
866
 *
867 868
 * Note: The @clock parameter is unused and can be NULL
 *
869
 * Returns: the converted time of the clock.
870 871
 *
 * Since: 1.6
872
 */
873
GstClockTime
874 875 876
gst_clock_adjust_with_calibration (GstClock * clock,
    GstClockTime internal_target, GstClockTime cinternal,
    GstClockTime cexternal, GstClockTime cnum, GstClockTime cdenom)
877
{
878
  GstClockTime ret;
879 880

  /* avoid divide by 0 */
881
  if (G_UNLIKELY (cdenom == 0))
882 883 884 885 886
    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
887
   * internal < cinternal to get the sign right. this case is not very common,
888 889
   * though.
   */
890 891
  if (G_LIKELY (internal_target >= cinternal)) {
    ret = internal_target - cinternal;
892
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
893 894
    ret += cexternal;
  } else {
895
    ret = cinternal - internal_target;
896
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
897
    /* clamp to 0 */
898
    if (G_LIKELY (cexternal > ret))
899 900 901 902
      ret = cexternal - ret;
    else
      ret = 0;
  }
903

904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
  return ret;
}

/**
 * gst_clock_adjust_unlocked:
 * @clock: a #GstClock to use
 * @internal: a clock time
 *
 * Converts the given @internal clock time to the external time, adjusting for the
 * 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
 * clock's OBJECT_LOCK held and is mainly used by clock subclasses.
 *
 * This function is the reverse of gst_clock_unadjust_unlocked().
 *
 * Returns: the converted time of the clock.
 */
GstClockTime
gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
{
  GstClockTime ret, cinternal, cexternal, cnum, cdenom;
  GstClockPrivate *priv = clock->priv;

  /* get calibration values for readability */
  cinternal = priv->internal_calibration;
  cexternal = priv->external_calibration;
  cnum = priv->rate_numerator;
  cdenom = priv->rate_denominator;

  ret =
      gst_clock_adjust_with_calibration (clock, internal, cinternal, cexternal,
      cnum, cdenom);

937
  /* make sure the time is increasing */