gstclock.c 48.4 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

111 112
/* #define DEBUGGING_ENABLED */

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
113 114 115
#define DEFAULT_WINDOW_SIZE             32
#define DEFAULT_WINDOW_THRESHOLD        4
#define DEFAULT_TIMEOUT                 GST_SECOND / 10
116

117 118
enum
{
119 120 121 122
  PROP_0,
  PROP_WINDOW_SIZE,
  PROP_WINDOW_THRESHOLD,
  PROP_TIMEOUT
123 124
};

125 126 127 128 129 130
enum
{
  SIGNAL_SYNCED,
  SIGNAL_LAST
};

Wim Taymans's avatar
Wim Taymans committed
131 132 133
#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)

134 135
struct _GstClockPrivate
{
Wim Taymans's avatar
Wim Taymans committed
136 137
  GMutex slave_lock;            /* order: SLAVE_LOCK, OBJECT_LOCK */

138 139
  GCond sync_cond;

Wim Taymans's avatar
Wim Taymans committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
  /* 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;

162 163
  gint pre_count;
  gint post_count;
164 165

  gboolean synced;
166 167 168 169
};

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

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

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

197
#ifndef GST_DISABLE_GST_DEBUG
198 199 200
static const gchar *
gst_clock_return_get_name (GstClockReturn ret)
{
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
  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;
220
  }
221

222 223
  return "unknown";
}
224
#endif /* GST_DISABLE_GST_DEBUG */
225

226
static void gst_clock_dispose (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
227
static void gst_clock_finalize (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
228

229 230 231 232
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);
233

234
static guint gst_clock_signals[SIGNAL_LAST] = { 0 };
235

Wim Taymans's avatar
Wim Taymans committed
236
static GstClockID
237 238
gst_clock_entry_new (GstClock * clock, GstClockTime time,
    GstClockTime interval, GstClockEntryType type)
239 240
{
  GstClockEntry *entry;
241

242
  entry = g_slice_new (GstClockEntry);
243 244 245

  /* FIXME: add tracer hook for struct allocations such as clock entries */

246 247
  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
      "created entry %p, time %" GST_TIME_FORMAT, entry, GST_TIME_ARGS (time));
248

249
  entry->refcount = 1;
250
  entry->clock = clock;
251
  entry->type = type;
252
  entry->time = time;
253
  entry->interval = interval;
254
  entry->status = GST_CLOCK_OK;
255 256
  entry->func = NULL;
  entry->user_data = NULL;
257
  entry->destroy_data = NULL;
258 259
  entry->unscheduled = FALSE;
  entry->woken_up = FALSE;
260

261 262
  return (GstClockID) entry;
}
263

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

  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);
}

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
/**
 * 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);
}

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

339
  g_atomic_int_inc (&((GstClockEntry *) id)->refcount);
340 341 342 343 344 345 346

  return id;
}

static void
_gst_clock_id_free (GstClockID id)
{
347
  GstClockEntry *entry;
348 349 350
  g_return_if_fail (id != NULL);

  GST_CAT_DEBUG (GST_CAT_CLOCK, "freed entry %p", id);
351 352 353
  entry = (GstClockEntry *) id;
  if (entry->destroy_data)
    entry->destroy_data (entry->user_data);
354

355 356
  /* FIXME: add tracer hook for struct allocations such as clock entries */

357
  g_slice_free (GstClockEntry, id);
358 359 360 361
}

/**
 * gst_clock_id_unref:
362
 * @id: (transfer full): The #GstClockID to unref
363
 *
Wim Taymans's avatar
Wim Taymans committed
364
 * Unref given @id. When the refcount reaches 0 the
365 366 367 368 369 370 371 372 373 374 375
 * #GstClockID will be freed.
 *
 * MT safe.
 */
void
gst_clock_id_unref (GstClockID id)
{
  gint zero;

  g_return_if_fail (id != NULL);

376
  zero = g_atomic_int_dec_and_test (&((GstClockEntry *) id)->refcount);
377 378 379 380 381 382
  /* if we ended up with the refcount at zero, free the id */
  if (zero) {
    _gst_clock_id_free (id);
  }
}

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

404 405
  return gst_clock_entry_new (clock,
      time, GST_CLOCK_TIME_NONE, GST_CLOCK_ENTRY_SINGLE);
406 407 408
}

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

435 436
  return gst_clock_entry_new (clock,
      start_time, interval, GST_CLOCK_ENTRY_PERIODIC);
437 438
}

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

468
/**
469
 * gst_clock_id_get_time:
Wim Taymans's avatar
Wim Taymans committed
470
 * @id: The #GstClockID to query
471 472 473
 *
 * Get the time of the clock ID
 *
474 475 476
 * Returns: the time of the given clock id.
 *
 * MT safe.
477 478 479 480 481 482
 */
GstClockTime
gst_clock_id_get_time (GstClockID id)
{
  g_return_val_if_fail (id != NULL, GST_CLOCK_TIME_NONE);

483
  return GST_CLOCK_ENTRY_TIME ((GstClockEntry *) id);
484 485 486
}

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

522
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
523

524 525
  entry = (GstClockEntry *) id;
  requested = GST_CLOCK_ENTRY_TIME (entry);
526

527 528
  clock = GST_CLOCK_ENTRY_CLOCK (entry);

Wim Taymans's avatar
Wim Taymans committed
529
  /* can't sync on invalid times */
530 531 532
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
533
  cclass = GST_CLOCK_GET_CLASS (clock);
534

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

537
  /* if we have a wait_jitter function, use that */
Wim Taymans's avatar
Wim Taymans committed
538 539 540 541
  if (G_UNLIKELY (cclass->wait == NULL))
    goto not_supported;

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

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

547 548
  if (entry->type == GST_CLOCK_ENTRY_PERIODIC)
    entry->time = requested + entry->interval;
Wim Taymans's avatar
Wim Taymans committed
549

550
  return res;
551 552 553 554

  /* ERRORS */
invalid_time:
  {
555 556
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
557 558
    return GST_CLOCK_BADTIME;
  }
Wim Taymans's avatar
Wim Taymans committed
559 560 561 562 563
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
564 565 566
}

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

596
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
597
  g_return_val_if_fail (func != NULL, GST_CLOCK_ERROR);
598 599

  entry = (GstClockEntry *) id;
600 601
  requested = GST_CLOCK_ENTRY_TIME (entry);
  clock = GST_CLOCK_ENTRY_CLOCK (entry);
602

Wim Taymans's avatar
Wim Taymans committed
603
  /* can't sync on invalid times */
604 605 606
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
607 608
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
609 610 611 612 613
  if (G_UNLIKELY (cclass->wait_async == NULL))
    goto not_supported;

  entry->func = func;
  entry->user_data = user_data;
614
  entry->destroy_data = destroy_data;
Wim Taymans's avatar
Wim Taymans committed
615 616

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

618 619
  return res;

620 621 622 623
  /* ERRORS */
invalid_time:
  {
    (func) (clock, GST_CLOCK_TIME_NONE, id, user_data);
624 625
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
626 627
    return GST_CLOCK_BADTIME;
  }
Wim Taymans's avatar
Wim Taymans committed
628 629 630 631 632
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
633 634
}

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

653 654 655 656
  g_return_if_fail (id != NULL);

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

Wim Taymans's avatar
Wim Taymans committed
658 659
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
660
  if (G_LIKELY (cclass->unschedule))
Wim Taymans's avatar
Wim Taymans committed
661
    cclass->unschedule (clock, entry);
662 663
}

664

Stefan Kost's avatar
Stefan Kost committed
665
/*
666 667
 * GstClock abstract base class implementation
 */
Wim Taymans's avatar
Wim Taymans committed
668
#define gst_clock_parent_class parent_class
Wim Taymans's avatar
Wim Taymans committed
669
G_DEFINE_ABSTRACT_TYPE (GstClock, gst_clock, GST_TYPE_OBJECT);
670

671
static void
672
gst_clock_class_init (GstClockClass * klass)
673
{
674
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
675

676 677 678 679
  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;
680

681
  g_object_class_install_property (gobject_class, PROP_WINDOW_SIZE,
682 683
      g_param_spec_int ("window-size", "Window size",
          "The size of the window used to calculate rate and offset", 2, 1024,
684
          DEFAULT_WINDOW_SIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
685 686
  g_object_class_install_property (gobject_class, PROP_WINDOW_THRESHOLD,
      g_param_spec_int ("window-threshold", "Window threshold",
687
          "The threshold to start calculating rate and offset", 2, 1024,
688 689
          DEFAULT_WINDOW_THRESHOLD,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
690
  g_object_class_install_property (gobject_class, PROP_TIMEOUT,
691 692
      g_param_spec_uint64 ("timeout", "Timeout",
          "The amount of time, in nanoseconds, to sample master and slave clocks",
693 694
          0, G_MAXUINT64, DEFAULT_TIMEOUT,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
695

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
  /**
   * 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);

715
  g_type_class_add_private (klass, sizeof (GstClockPrivate));
Wim Taymans's avatar
Wim Taymans committed
716 717
}

718
static void
719
gst_clock_init (GstClock * clock)
Wim Taymans's avatar
Wim Taymans committed
720
{
Wim Taymans's avatar
Wim Taymans committed
721
  GstClockPrivate *priv;
722

Wim Taymans's avatar
Wim Taymans committed
723
  clock->priv = priv =
724 725
      G_TYPE_INSTANCE_GET_PRIVATE (clock, GST_TYPE_CLOCK, GstClockPrivate);

Wim Taymans's avatar
Wim Taymans committed
726 727 728 729 730 731 732 733
  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);
734
  g_cond_init (&priv->sync_cond);
Wim Taymans's avatar
Wim Taymans committed
735 736 737 738 739 740
  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);
741 742 743

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

746 747 748 749
static void
gst_clock_dispose (GObject * object)
{
  GstClock *clock = GST_CLOCK (object);
750
  GstClock **master_p;
751 752

  GST_OBJECT_LOCK (clock);
Wim Taymans's avatar
Wim Taymans committed
753
  master_p = &clock->priv->master;
754
  gst_object_replace ((GstObject **) master_p, NULL);
755 756 757 758 759
  GST_OBJECT_UNLOCK (clock);

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

Wim Taymans's avatar
Wim Taymans committed
760
static void
Wim Taymans's avatar
Wim Taymans committed
761
gst_clock_finalize (GObject * object)
Wim Taymans's avatar
Wim Taymans committed
762 763 764
{
  GstClock *clock = GST_CLOCK (object);

765
  GST_CLOCK_SLAVE_LOCK (clock);
Wim Taymans's avatar
Wim Taymans committed
766 767 768 769
  if (clock->priv->clockid) {
    gst_clock_id_unschedule (clock->priv->clockid);
    gst_clock_id_unref (clock->priv->clockid);
    clock->priv->clockid = NULL;
770
  }
Wim Taymans's avatar
Wim Taymans committed
771 772
  g_free (clock->priv->times);
  clock->priv->times = NULL;
773
  GST_CLOCK_SLAVE_UNLOCK (clock);
774

Wim Taymans's avatar
Wim Taymans committed
775
  g_mutex_clear (&clock->priv->slave_lock);
776
  g_cond_clear (&clock->priv->sync_cond);
777

Wim Taymans's avatar
Wim Taymans committed
778
  G_OBJECT_CLASS (parent_class)->finalize (object);
Wim Taymans's avatar
Wim Taymans committed
779 780
}

Wim Taymans's avatar
Wim Taymans committed
781
/**
782
 * gst_clock_set_resolution:
783
 * @clock: a #GstClock
784
 * @resolution: The resolution to set
Wim Taymans's avatar
Wim Taymans committed
785
 *
786 787 788 789 790
 * 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.
791 792
 *
 * Returns: the new resolution of the clock.
Wim Taymans's avatar
Wim Taymans committed
793
 */
794 795
GstClockTime
gst_clock_set_resolution (GstClock * clock, GstClockTime resolution)
Wim Taymans's avatar
Wim Taymans committed
796
{
Wim Taymans's avatar
Wim Taymans committed
797
  GstClockPrivate *priv;
Wim Taymans's avatar
Wim Taymans committed
798 799
  GstClockClass *cclass;

800 801
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
  g_return_val_if_fail (resolution != 0, 0);
802

Wim Taymans's avatar
Wim Taymans committed
803
  cclass = GST_CLOCK_GET_CLASS (clock);
Wim Taymans's avatar
Wim Taymans committed
804
  priv = clock->priv;
Wim Taymans's avatar
Wim Taymans committed
805 806

  if (cclass->change_resolution)
Wim Taymans's avatar
Wim Taymans committed
807 808
    priv->resolution =
        cclass->change_resolution (clock, priv->resolution, resolution);
809

Wim Taymans's avatar
Wim Taymans committed
810
  return priv->resolution;
811
}
812

813
/**
814
 * gst_clock_get_resolution:
815
 * @clock: a #GstClock
816
 *
817 818
 * Get the accuracy of the clock. The accuracy of the clock is the granularity
 * of the values returned by gst_clock_get_time().
819
 *
820
 * Returns: the resolution of the clock in units of #GstClockTime.
821 822
 *
 * MT safe.
823
 */
824
GstClockTime
825
gst_clock_get_resolution (GstClock * clock)
826
{
Wim Taymans's avatar
Wim Taymans committed
827 828
  GstClockClass *cclass;

829
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
830

Wim Taymans's avatar
Wim Taymans committed
831 832 833 834
  cclass = GST_CLOCK_GET_CLASS (clock);

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

836
  return 1;
Wim Taymans's avatar
Wim Taymans committed
837 838
}

839
/* FIXME 2.0: Remove clock parameter below */
Wim Taymans's avatar
Wim Taymans committed
840
/**
841
 * gst_clock_adjust_with_calibration:
842
 * @clock: (allow-none): a #GstClock to use
843 844 845 846 847 848 849 850 851 852 853 854
 * @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.
855
 *
856 857
 * Note: The @clock parameter is unused and can be NULL
 *
858
 * Returns: the converted time of the clock.
859 860
 *
 * Since: 1.6
861
 */
862
GstClockTime
863 864 865
gst_clock_adjust_with_calibration (GstClock * clock,
    GstClockTime internal_target, GstClockTime cinternal,
    GstClockTime cexternal, GstClockTime cnum, GstClockTime cdenom)
866
{
867
  GstClockTime ret;
868 869

  /* avoid divide by 0 */
870
  if (G_UNLIKELY (cdenom == 0))
871 872 873 874 875
    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
876
   * internal < cinternal to get the sign right. this case is not very common,
877 878
   * though.
   */
879 880
  if (G_LIKELY (internal_target >= cinternal)) {
    ret = internal_target - cinternal;
881
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
882 883
    ret += cexternal;
  } else {
884
    ret = cinternal - internal_target;
885
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
886
    /* clamp to 0 */
887
    if (G_LIKELY (cexternal > ret))
888 889 890 891
      ret = cexternal - ret;
    else
      ret = 0;
  }
892

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
  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);

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

Wim Taymans's avatar
Wim Taymans committed
929
  return priv->last_time;
930 931
}

932
/* FIXME 2.0: Remove clock parameter below */
933 934
/**
 * gst_clock_unadjust_with_calibration:
935
 * @clock: (allow-none): a #GstClock to use
936 937 938 939 940 941 942 943 944 945 946 947
 * @external_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 @external_target clock time to the internal time,
 * using the passed calibration parameters. This function performs the
 * same calculation as gst_clock_unadjust_unlocked() when called using the
 * current calibration parameters.
 *