gstclock.c 43.8 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.
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 264 265 266 267 268 269 270 271 272

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

273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
/**
 * 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);
}

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

309
  g_atomic_int_inc (&((GstClockEntry *) id)->refcount);
310 311 312 313 314 315 316

  return id;
}

static void
_gst_clock_id_free (GstClockID id)
{
317
  GstClockEntry *entry;
318 319 320
  g_return_if_fail (id != NULL);

  GST_CAT_DEBUG (GST_CAT_CLOCK, "freed entry %p", id);
321 322 323
  entry = (GstClockEntry *) id;
  if (entry->destroy_data)
    entry->destroy_data (entry->user_data);
324 325

#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
326
  _gst_alloc_trace_free (_gst_clock_entry_trace, id);
327
#endif
328
  g_slice_free (GstClockEntry, id);
329 330 331 332
}

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

  g_return_if_fail (id != NULL);

347
  zero = g_atomic_int_dec_and_test (&((GstClockEntry *) id)->refcount);
348 349 350 351 352 353
  /* if we ended up with the refcount at zero, free the id */
  if (zero) {
    _gst_clock_id_free (id);
  }
}

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

375 376
  return gst_clock_entry_new (clock,
      time, GST_CLOCK_TIME_NONE, GST_CLOCK_ENTRY_SINGLE);
377 378 379
}

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

406 407
  return gst_clock_entry_new (clock,
      start_time, interval, GST_CLOCK_ENTRY_PERIODIC);
408 409
}

410
/**
411
 * gst_clock_id_compare_func:
Wim Taymans's avatar
Wim Taymans committed
412 413
 * @id1: A #GstClockID
 * @id2: A #GstClockID to compare with
414
 *
Wim Taymans's avatar
Wim Taymans committed
415
 * Compares the two #GstClockID instances. This function can be used
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
 * 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
436
  return 0;
437 438
}

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

454
  return GST_CLOCK_ENTRY_TIME ((GstClockEntry *) id);
455 456 457
}

/**
458
 * gst_clock_id_wait:
Wim Taymans's avatar
Wim Taymans committed
459
 * @id: The #GstClockID to wait on
Wim Taymans's avatar
Wim Taymans committed
460
 * @jitter: (out) (allow-none): a pointer that will contain the jitter,
461
 *     can be %NULL.
Wim Taymans's avatar
Wim Taymans committed
462 463 464 465 466 467
 *
 * 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(). 
 *
468
 * If the @jitter argument is not %NULL and this function returns #GST_CLOCK_OK
Wim Taymans's avatar
Wim Taymans committed
469 470
 * or #GST_CLOCK_EARLY, it will contain the difference
 * against the clock and the time of @id when this method was
471 472
 * called. 
 * Positive values indicate how late @id was relative to the clock
473
 * (in which case this function will return #GST_CLOCK_EARLY). 
474
 * Negative values indicate how much time was spent waiting on the clock 
475
 * before this function returned.
Wim Taymans's avatar
Wim Taymans committed
476 477 478 479 480
 *
 * 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().
481 482
 *
 * MT safe.
483 484
 */
GstClockReturn
485
gst_clock_id_wait (GstClockID id, GstClockTimeDiff * jitter)
486 487
{
  GstClockEntry *entry;
488
  GstClock *clock;
489
  GstClockReturn res;
490
  GstClockTime requested;
Wim Taymans's avatar
Wim Taymans committed
491
  GstClockClass *cclass;
492

493
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
494

495 496
  entry = (GstClockEntry *) id;
  requested = GST_CLOCK_ENTRY_TIME (entry);
497

498 499
  clock = GST_CLOCK_ENTRY_CLOCK (entry);

Wim Taymans's avatar
Wim Taymans committed
500
  /* can't sync on invalid times */
501 502 503
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
504
  cclass = GST_CLOCK_GET_CLASS (clock);
505

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

508
  /* if we have a wait_jitter function, use that */
Wim Taymans's avatar
Wim Taymans committed
509 510 511 512
  if (G_UNLIKELY (cclass->wait == NULL))
    goto not_supported;

  res = cclass->wait (clock, entry, jitter);
Wim Taymans's avatar
Wim Taymans committed
513 514 515 516

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

517 518
  if (entry->type == GST_CLOCK_ENTRY_PERIODIC)
    entry->time = requested + entry->interval;
Wim Taymans's avatar
Wim Taymans committed
519

520
  return res;
521 522 523 524

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

/**
Wim Taymans's avatar
Wim Taymans committed
537
 * gst_clock_id_wait_async:
Wim Taymans's avatar
Wim Taymans committed
538
 * @id: a #GstClockID to wait on
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
539
 * @func: The callback function
540
 * @user_data: User data passed in the callback
541
 * @destroy_data: #GDestroyNotify for user_data
542
 *
Wim Taymans's avatar
Wim Taymans committed
543 544
 * Register a callback on the given #GstClockID @id with the given
 * function and user_data. When passing a #GstClockID with an invalid
545
 * time to this function, the callback will be called immediately
546
 * with  a time set to GST_CLOCK_TIME_NONE. The callback will
Wim Taymans's avatar
Wim Taymans committed
547
 * be called when the time of @id has been reached.
548
 *
549 550 551
 * 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.
 *
552
 * Returns: the result of the non blocking wait.
553 554
 *
 * MT safe.
555 556
 */
GstClockReturn
Wim Taymans's avatar
Wim Taymans committed
557
gst_clock_id_wait_async (GstClockID id,
558
    GstClockCallback func, gpointer user_data, GDestroyNotify destroy_data)
559 560 561
{
  GstClockEntry *entry;
  GstClock *clock;
562
  GstClockReturn res;
Wim Taymans's avatar
Wim Taymans committed
563
  GstClockClass *cclass;
564
  GstClockTime requested;
565

566
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
567
  g_return_val_if_fail (func != NULL, GST_CLOCK_ERROR);
568 569

  entry = (GstClockEntry *) id;
570 571
  requested = GST_CLOCK_ENTRY_TIME (entry);
  clock = GST_CLOCK_ENTRY_CLOCK (entry);
572

Wim Taymans's avatar
Wim Taymans committed
573
  /* can't sync on invalid times */
574 575 576
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
577 578
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
579 580 581 582 583
  if (G_UNLIKELY (cclass->wait_async == NULL))
    goto not_supported;

  entry->func = func;
  entry->user_data = user_data;
584
  entry->destroy_data = destroy_data;
Wim Taymans's avatar
Wim Taymans committed
585 586

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

588 589
  return res;

590 591 592 593
  /* ERRORS */
invalid_time:
  {
    (func) (clock, GST_CLOCK_TIME_NONE, id, user_data);
594 595
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
596 597
    return GST_CLOCK_BADTIME;
  }
Wim Taymans's avatar
Wim Taymans committed
598 599 600 601 602
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
603 604
}

605
/**
Wim Taymans's avatar
Wim Taymans committed
606 607
 * gst_clock_id_unschedule:
 * @id: The id to unschedule
608
 *
Wim Taymans's avatar
Wim Taymans committed
609
 * Cancel an outstanding request with @id. This can either
610
 * be an outstanding async notification or a pending sync notification.
Wim Taymans's avatar
Wim Taymans committed
611 612
 * After this call, @id cannot be used anymore to receive sync or
 * async notifications, you need to create a new #GstClockID.
613 614
 *
 * MT safe.
615 616 617 618 619 620
 */
void
gst_clock_id_unschedule (GstClockID id)
{
  GstClockEntry *entry;
  GstClock *clock;
Wim Taymans's avatar
Wim Taymans committed
621
  GstClockClass *cclass;
622

623 624 625 626
  g_return_if_fail (id != NULL);

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

Wim Taymans's avatar
Wim Taymans committed
628 629
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
630
  if (G_LIKELY (cclass->unschedule))
Wim Taymans's avatar
Wim Taymans committed
631
    cclass->unschedule (clock, entry);
632 633
}

634

Stefan Kost's avatar
Stefan Kost committed
635
/*
636 637
 * GstClock abstract base class implementation
 */
Wim Taymans's avatar
Wim Taymans committed
638
#define gst_clock_parent_class parent_class
Wim Taymans's avatar
Wim Taymans committed
639
G_DEFINE_ABSTRACT_TYPE (GstClock, gst_clock, GST_TYPE_OBJECT);
640

641
static void
642
gst_clock_class_init (GstClockClass * klass)
643
{
644
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
645

Wim Taymans's avatar
Wim Taymans committed
646
#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
647
  _gst_clock_entry_trace = _gst_alloc_trace_register ("GstClockEntry", -1);
Wim Taymans's avatar
Wim Taymans committed
648
#endif
649

650 651 652 653
  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;
654

655
  g_object_class_install_property (gobject_class, PROP_WINDOW_SIZE,
656 657
      g_param_spec_int ("window-size", "Window size",
          "The size of the window used to calculate rate and offset", 2, 1024,
658
          DEFAULT_WINDOW_SIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
659 660
  g_object_class_install_property (gobject_class, PROP_WINDOW_THRESHOLD,
      g_param_spec_int ("window-threshold", "Window threshold",
661
          "The threshold to start calculating rate and offset", 2, 1024,
662 663
          DEFAULT_WINDOW_THRESHOLD,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
664
  g_object_class_install_property (gobject_class, PROP_TIMEOUT,
665 666
      g_param_spec_uint64 ("timeout", "Timeout",
          "The amount of time, in nanoseconds, to sample master and slave clocks",
667 668
          0, G_MAXUINT64, DEFAULT_TIMEOUT,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
669 670

  g_type_class_add_private (klass, sizeof (GstClockPrivate));
Wim Taymans's avatar
Wim Taymans committed
671 672
}

673
static void
674
gst_clock_init (GstClock * clock)
Wim Taymans's avatar
Wim Taymans committed
675
{
Wim Taymans's avatar
Wim Taymans committed
676
  GstClockPrivate *priv;
677

Wim Taymans's avatar
Wim Taymans committed
678
  clock->priv = priv =
679 680
      G_TYPE_INSTANCE_GET_PRIVATE (clock, GST_TYPE_CLOCK, GstClockPrivate);

Wim Taymans's avatar
Wim Taymans committed
681 682 683 684 685 686 687 688 689 690 691 692 693 694
  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);
695 696 697

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

700 701 702 703
static void
gst_clock_dispose (GObject * object)
{
  GstClock *clock = GST_CLOCK (object);
704
  GstClock **master_p;
705 706

  GST_OBJECT_LOCK (clock);
Wim Taymans's avatar
Wim Taymans committed
707
  master_p = &clock->priv->master;
708
  gst_object_replace ((GstObject **) master_p, NULL);
709 710 711 712 713
  GST_OBJECT_UNLOCK (clock);

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

Wim Taymans's avatar
Wim Taymans committed
714
static void
Wim Taymans's avatar
Wim Taymans committed
715
gst_clock_finalize (GObject * object)
Wim Taymans's avatar
Wim Taymans committed
716 717 718
{
  GstClock *clock = GST_CLOCK (object);

719
  GST_CLOCK_SLAVE_LOCK (clock);
Wim Taymans's avatar
Wim Taymans committed
720 721 722 723
  if (clock->priv->clockid) {
    gst_clock_id_unschedule (clock->priv->clockid);
    gst_clock_id_unref (clock->priv->clockid);
    clock->priv->clockid = NULL;
724
  }
Wim Taymans's avatar
Wim Taymans committed
725 726
  g_free (clock->priv->times);
  clock->priv->times = NULL;
727
  GST_CLOCK_SLAVE_UNLOCK (clock);
728

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

Wim Taymans's avatar
Wim Taymans committed
731
  G_OBJECT_CLASS (parent_class)->finalize (object);
Wim Taymans's avatar
Wim Taymans committed
732 733
}

Wim Taymans's avatar
Wim Taymans committed
734
/**
735
 * gst_clock_set_resolution:
736
 * @clock: a #GstClock
737
 * @resolution: The resolution to set
Wim Taymans's avatar
Wim Taymans committed
738
 *
739 740 741 742 743
 * 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.
744 745
 *
 * Returns: the new resolution of the clock.
Wim Taymans's avatar
Wim Taymans committed
746
 */
747 748
GstClockTime
gst_clock_set_resolution (GstClock * clock, GstClockTime resolution)
Wim Taymans's avatar
Wim Taymans committed
749
{
Wim Taymans's avatar
Wim Taymans committed
750
  GstClockPrivate *priv;
Wim Taymans's avatar
Wim Taymans committed
751 752
  GstClockClass *cclass;

753 754
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
  g_return_val_if_fail (resolution != 0, 0);
755

Wim Taymans's avatar
Wim Taymans committed
756
  cclass = GST_CLOCK_GET_CLASS (clock);
Wim Taymans's avatar
Wim Taymans committed
757
  priv = clock->priv;
Wim Taymans's avatar
Wim Taymans committed
758 759

  if (cclass->change_resolution)
Wim Taymans's avatar
Wim Taymans committed
760 761
    priv->resolution =
        cclass->change_resolution (clock, priv->resolution, resolution);
762

Wim Taymans's avatar
Wim Taymans committed
763
  return priv->resolution;
764
}
765

766
/**
767
 * gst_clock_get_resolution:
768
 * @clock: a #GstClock
769
 *
770 771
 * Get the accuracy of the clock. The accuracy of the clock is the granularity
 * of the values returned by gst_clock_get_time().
772
 *
773
 * Returns: the resolution of the clock in units of #GstClockTime.
774 775
 *
 * MT safe.
776
 */
777
GstClockTime
778
gst_clock_get_resolution (GstClock * clock)
779
{
Wim Taymans's avatar
Wim Taymans committed
780 781
  GstClockClass *cclass;

782
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
783

Wim Taymans's avatar
Wim Taymans committed
784 785 786 787
  cclass = GST_CLOCK_GET_CLASS (clock);

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

789
  return 1;
Wim Taymans's avatar
Wim Taymans committed
790 791
}

Wim Taymans's avatar
Wim Taymans committed
792
/**
793
 * gst_clock_adjust_unlocked:
794 795
 * @clock: a #GstClock to use
 * @internal: a clock time
Wim Taymans's avatar
Wim Taymans committed
796
 *
797
 * Converts the given @internal clock time to the external time, adjusting for the
798 799
 * 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
800
 * clock's OBJECT_LOCK held and is mainly used by clock subclasses.
Wim Taymans's avatar
Wim Taymans committed
801
 *
802
 * This function is the reverse of gst_clock_unadjust_unlocked().
803
 *
804
 * Returns: the converted time of the clock.
805
 */
806 807
GstClockTime
gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
808
{
809
  GstClockTime ret, cinternal, cexternal, cnum, cdenom;
Wim Taymans's avatar
Wim Taymans committed
810
  GstClockPrivate *priv = clock->priv;
811 812

  /* get calibration values for readability */
Wim Taymans's avatar
Wim Taymans committed
813 814 815 816
  cinternal = priv->internal_calibration;
  cexternal = priv->external_calibration;
  cnum = priv->rate_numerator;
  cdenom = priv->rate_denominator;
817 818

  /* avoid divide by 0 */
819
  if (G_UNLIKELY (cdenom == 0))
820 821 822 823 824
    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
825
   * internal < cinternal to get the sign right. this case is not very common,
826 827 828
   * though.
   */
  if (G_LIKELY (internal >= cinternal)) {
829 830
    ret = internal - cinternal;
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
831 832
    ret += cexternal;
  } else {
833 834
    ret = cinternal - internal;
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
835
    /* clamp to 0 */
836
    if (G_LIKELY (cexternal > ret))
837 838 839 840
      ret = cexternal - ret;
    else
      ret = 0;
  }
841 842

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

Wim Taymans's avatar
Wim Taymans committed
845
  return priv->last_time;
846 847
}

848
/**
849
 * gst_clock_unadjust_unlocked:
850 851 852 853 854 855 856 857
 * @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.
 *
858
 * This function is the reverse of gst_clock_adjust_unlocked().
859 860 861 862 863 864 865
 *
 * Returns: the internal time of the clock corresponding to @external.
 */
GstClockTime
gst_clock_unadjust_unlocked (GstClock * clock, GstClockTime external)
{
  GstClockTime ret, cinternal, cexternal, cnum, cdenom;
Wim Taymans's avatar
Wim Taymans committed
866
  GstClockPrivate *priv = clock->priv;
867 868

  /* get calibration values for readability */
Wim Taymans's avatar
Wim Taymans committed
869 870 871 872
  cinternal = priv->internal_calibration;
  cexternal = priv->external_calibration;
  cnum = priv->rate_numerator;
  cdenom = priv->rate_denominator;
873 874

  /* avoid divide by 0 */
875
  if (G_UNLIKELY (cnum == 0))
876 877 878
    cnum = cdenom = 1;

  /* The formula is (external - cexternal) * cdenom / cnum + cinternal */
879 880 881
  if (G_LIKELY (external >= cexternal)) {
    ret = external - cexternal;
    ret = gst_util_uint64_scale (ret, cdenom, cnum);
882 883
    ret += cinternal;
  } else {
884 885 886
    ret = cexternal - external;
    ret = gst_util_uint64_scale (ret, cdenom, cnum);
    if (G_LIKELY (cinternal > ret))
887 888 889 890 891 892 893
      ret = cinternal - ret;
    else
      ret = 0;
  }
  return ret;
}

Wim Taymans's avatar
Wim Taymans committed
894
/**
895
 * gst_clock_get_internal_time:
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
896
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
897
 *
898 899
 * Gets the current internal time of the given clock. The time is returned
 * unadjusted for the offset and the rate.
900
 *
901
 * Returns: the internal time of the clock. Or GST_CLOCK_TIME_NONE when
902
 * given invalid input.
903