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 20 21 22
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
23

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

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

119 120
/* #define DEBUGGING_ENABLED */

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

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

135 136 137 138 139 140 141 142
struct _GstClockPrivate
{
  gint pre_count;
  gint post_count;
};

/* seqlocks */
#define read_seqbegin(clock)                                   \
143
  g_atomic_int_get (&clock->ABI.priv->post_count);
144 145 146 147 148

static inline gboolean
read_seqretry (GstClock * clock, gint seq)
{
  /* no retry if the seqnum did not change */
149
  if (G_LIKELY (seq == g_atomic_int_get (&clock->ABI.priv->pre_count)))
150 151 152 153 154 155 156 157 158 159 160
    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);                        \
161
  g_atomic_int_inc (&clock->ABI.priv->pre_count);     \
162 163 164 165
} G_STMT_END;

#define write_sequnlock(clock)                    \
G_STMT_START {                                    \
166
  g_atomic_int_inc (&clock->ABI.priv->post_count);    \
167 168 169
  GST_OBJECT_UNLOCK (clock);                      \
} G_STMT_END;

170
static void gst_clock_dispose (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
171
static void gst_clock_finalize (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
172

173 174 175 176 177
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);
static void gst_clock_update_stats (GstClock * clock);
178

179

180
static GstObjectClass *parent_class = NULL;
181

182 183
/* static guint gst_clock_signals[LAST_SIGNAL] = { 0 }; */

Wim Taymans's avatar
Wim Taymans committed
184
static GstClockID
185 186
gst_clock_entry_new (GstClock * clock, GstClockTime time,
    GstClockTime interval, GstClockEntryType type)
187 188
{
  GstClockEntry *entry;
189

190
  entry = g_slice_new (GstClockEntry);
Wim Taymans's avatar
Wim Taymans committed
191
#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
192
  gst_alloc_trace_new (_gst_clock_entry_trace, entry);
Wim Taymans's avatar
Wim Taymans committed
193
#endif
194 195
  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
      "created entry %p, time %" GST_TIME_FORMAT, entry, GST_TIME_ARGS (time));
196

197
  entry->refcount = 1;
198
  entry->clock = clock;
199
  entry->type = type;
200
  entry->time = time;
201
  entry->interval = interval;
202
  entry->status = GST_CLOCK_OK;
203 204
  entry->func = NULL;
  entry->user_data = NULL;
205
  entry->destroy_data = NULL;
206 207
  entry->unscheduled = FALSE;
  entry->woken_up = FALSE;
208

209 210
  return (GstClockID) entry;
}
211

212 213 214 215 216 217 218 219 220 221 222 223 224
/* WARNING : Does not modify the refoucnt
 * 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;
225 226
  entry->unscheduled = FALSE;
  entry->woken_up = FALSE;
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

  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.
242 243
 *
 * Since: 0.10.32
244 245 246 247 248 249 250 251 252
 */
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);
}

253 254
/**
 * gst_clock_id_ref:
Wim Taymans's avatar
Wim Taymans committed
255
 * @id: The #GstClockID to ref
256
 *
Wim Taymans's avatar
Wim Taymans committed
257
 * Increase the refcount of given @id.
258
 *
259
 * Returns: (transfer full): The same #GstClockID with increased refcount.
260 261 262 263 264 265 266 267
 *
 * MT safe.
 */
GstClockID
gst_clock_id_ref (GstClockID id)
{
  g_return_val_if_fail (id != NULL, NULL);

268
  g_atomic_int_inc (&((GstClockEntry *) id)->refcount);
269 270 271 272 273 274 275

  return id;
}

static void
_gst_clock_id_free (GstClockID id)
{
276
  GstClockEntry *entry;
277 278 279
  g_return_if_fail (id != NULL);

  GST_CAT_DEBUG (GST_CAT_CLOCK, "freed entry %p", id);
280 281 282
  entry = (GstClockEntry *) id;
  if (entry->destroy_data)
    entry->destroy_data (entry->user_data);
283 284 285 286

#ifndef GST_DISABLE_TRACE
  gst_alloc_trace_free (_gst_clock_entry_trace, id);
#endif
287
  g_slice_free (GstClockEntry, id);
288 289 290 291
}

/**
 * gst_clock_id_unref:
292
 * @id: (transfer full): The #GstClockID to unref
293
 *
Wim Taymans's avatar
Wim Taymans committed
294
 * Unref given @id. When the refcount reaches 0 the
295 296 297 298 299 300 301 302 303 304 305
 * #GstClockID will be freed.
 *
 * MT safe.
 */
void
gst_clock_id_unref (GstClockID id)
{
  gint zero;

  g_return_if_fail (id != NULL);

306
  zero = g_atomic_int_dec_and_test (&((GstClockEntry *) id)->refcount);
307 308 309 310 311 312
  /* if we ended up with the refcount at zero, free the id */
  if (zero) {
    _gst_clock_id_free (id);
  }
}

313
/**
314
 * gst_clock_new_single_shot_id:
Wim Taymans's avatar
Wim Taymans committed
315
 * @clock: The #GstClockID to get a single shot notification from
316 317
 * @time: the requested time
 *
Wim Taymans's avatar
Wim Taymans committed
318
 * Get a #GstClockID from @clock to trigger a single shot
319 320
 * notification at the requested time. The single shot id should be
 * unreffed after usage.
321
 *
322 323 324 325
 * Free-function: gst_clock_id_unref
 *
 * Returns: (transfer full): a #GstClockID that can be used to request the
 *     time notification.
326 327
 *
 * MT safe.
328 329
 */
GstClockID
330
gst_clock_new_single_shot_id (GstClock * clock, GstClockTime time)
331
{
332 333
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);

334 335
  return gst_clock_entry_new (clock,
      time, GST_CLOCK_TIME_NONE, GST_CLOCK_ENTRY_SINGLE);
336 337 338
}

/**
339
 * gst_clock_new_periodic_id:
Wim Taymans's avatar
Wim Taymans committed
340
 * @clock: The #GstClockID to get a periodic notification id from
341 342 343
 * @start_time: the requested start time
 * @interval: the requested interval
 *
Wim Taymans's avatar
Wim Taymans committed
344
 * Get an ID from @clock to trigger a periodic notification.
345 346
 * The periodic notifications will start at time @start_time and
 * will then be fired with the given @interval. @id should be unreffed
347
 * after usage.
348
 *
349 350 351 352
 * Free-function: gst_clock_id_unref
 *
 * Returns: (transfer full): a #GstClockID that can be used to request the
 *     time notification.
353 354
 *
 * MT safe.
355 356
 */
GstClockID
357 358
gst_clock_new_periodic_id (GstClock * clock, GstClockTime start_time,
    GstClockTime interval)
359
{
360
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);
361
  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (start_time), NULL);
362
  g_return_val_if_fail (interval != 0, NULL);
363
  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), NULL);
364

365 366
  return gst_clock_entry_new (clock,
      start_time, interval, GST_CLOCK_ENTRY_PERIODIC);
367 368
}

369 370
/**
 * gst_clock_id_compare_func
Wim Taymans's avatar
Wim Taymans committed
371 372
 * @id1: A #GstClockID
 * @id2: A #GstClockID to compare with
373
 *
Wim Taymans's avatar
Wim Taymans committed
374
 * Compares the two #GstClockID instances. This function can be used
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
 * 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
395
  return 0;
396 397
}

398 399
/**
 * gst_clock_id_get_time
Wim Taymans's avatar
Wim Taymans committed
400
 * @id: The #GstClockID to query
401 402 403
 *
 * Get the time of the clock ID
 *
404 405 406
 * Returns: the time of the given clock id.
 *
 * MT safe.
407 408 409 410 411 412
 */
GstClockTime
gst_clock_id_get_time (GstClockID id)
{
  g_return_val_if_fail (id != NULL, GST_CLOCK_TIME_NONE);

413
  return GST_CLOCK_ENTRY_TIME ((GstClockEntry *) id);
414 415 416 417
}

/**
 * gst_clock_id_wait
Wim Taymans's avatar
Wim Taymans committed
418
 * @id: The #GstClockID to wait on
419 420
 * @jitter (out) (allow-none): a pointer that will contain the jitter,
 *     can be %NULL.
Wim Taymans's avatar
Wim Taymans committed
421 422 423 424 425 426
 *
 * 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(). 
 *
427
 * If the @jitter argument is not %NULL and this function returns #GST_CLOCK_OK
Wim Taymans's avatar
Wim Taymans committed
428 429
 * or #GST_CLOCK_EARLY, it will contain the difference
 * against the clock and the time of @id when this method was
430 431
 * called. 
 * Positive values indicate how late @id was relative to the clock
432
 * (in which case this function will return #GST_CLOCK_EARLY). 
433
 * Negative values indicate how much time was spent waiting on the clock 
434
 * before this function returned.
Wim Taymans's avatar
Wim Taymans committed
435 436 437 438 439
 *
 * 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().
440 441
 *
 * MT safe.
442 443
 */
GstClockReturn
444
gst_clock_id_wait (GstClockID id, GstClockTimeDiff * jitter)
445 446
{
  GstClockEntry *entry;
447
  GstClock *clock;
448
  GstClockReturn res;
449
  GstClockTime requested;
Wim Taymans's avatar
Wim Taymans committed
450
  GstClockClass *cclass;
451

452
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
453

454 455
  entry = (GstClockEntry *) id;
  requested = GST_CLOCK_ENTRY_TIME (entry);
456

457 458
  clock = GST_CLOCK_ENTRY_CLOCK (entry);

Wim Taymans's avatar
Wim Taymans committed
459
  /* can't sync on invalid times */
460 461 462
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
463
  cclass = GST_CLOCK_GET_CLASS (clock);
464

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

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
  /* if we have a wait_jitter function, use that */
  if (G_LIKELY (cclass->wait_jitter)) {
    res = cclass->wait_jitter (clock, entry, jitter);
  } else {
    /* check if we have a simple _wait function otherwise. The function without
     * the jitter arg is less optimal as we need to do an additional _get_time()
     * which is not atomic with the _wait() and a typical _wait() function does
     * yet another _get_time() anyway. */
    if (G_UNLIKELY (cclass->wait == NULL))
      goto not_supported;

    if (jitter) {
      GstClockTime now = gst_clock_get_time (clock);

      /* jitter is the diff against the clock when this entry is scheduled. Negative
       * values mean that the entry was in time, a positive value means that the
       * entry was too late. */
      *jitter = GST_CLOCK_DIFF (requested, now);
    }
    res = cclass->wait (clock, entry);
Wim Taymans's avatar
Wim Taymans committed
487 488 489 490 491
  }

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

492 493
  if (entry->type == GST_CLOCK_ENTRY_PERIODIC)
    entry->time = requested + entry->interval;
Wim Taymans's avatar
Wim Taymans committed
494

495
  if (G_UNLIKELY (clock->stats))
Wim Taymans's avatar
Wim Taymans committed
496 497
    gst_clock_update_stats (clock);

498
  return res;
499 500 501 502

  /* ERRORS */
invalid_time:
  {
503 504
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
505 506
    return GST_CLOCK_BADTIME;
  }
Wim Taymans's avatar
Wim Taymans committed
507 508 509 510 511
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
512 513 514
}

/**
515
 * gst_clock_id_wait_async_full:
Wim Taymans's avatar
Wim Taymans committed
516
 * @id: a #GstClockID to wait on
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
517
 * @func: The callback function
518
 * @user_data: User data passed in the callback
519
 * @destroy_data: #GDestroyNotify for user_data
520
 *
Wim Taymans's avatar
Wim Taymans committed
521 522
 * Register a callback on the given #GstClockID @id with the given
 * function and user_data. When passing a #GstClockID with an invalid
523
 * time to this function, the callback will be called immediately
524
 * with  a time set to GST_CLOCK_TIME_NONE. The callback will
Wim Taymans's avatar
Wim Taymans committed
525
 * be called when the time of @id has been reached.
526
 *
527 528 529
 * 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.
 *
530
 * Returns: the result of the non blocking wait.
531 532
 *
 * MT safe.
533 534
 *
 * Since: 0.10.30
535 536
 */
GstClockReturn
537 538
gst_clock_id_wait_async_full (GstClockID id,
    GstClockCallback func, gpointer user_data, GDestroyNotify destroy_data)
539 540 541
{
  GstClockEntry *entry;
  GstClock *clock;
542
  GstClockReturn res;
Wim Taymans's avatar
Wim Taymans committed
543
  GstClockClass *cclass;
544
  GstClockTime requested;
545

546
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
547
  g_return_val_if_fail (func != NULL, GST_CLOCK_ERROR);
548 549

  entry = (GstClockEntry *) id;
550 551
  requested = GST_CLOCK_ENTRY_TIME (entry);
  clock = GST_CLOCK_ENTRY_CLOCK (entry);
552

Wim Taymans's avatar
Wim Taymans committed
553
  /* can't sync on invalid times */
554 555 556
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
557 558
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
559 560 561 562 563
  if (G_UNLIKELY (cclass->wait_async == NULL))
    goto not_supported;

  entry->func = func;
  entry->user_data = user_data;
564
  entry->destroy_data = destroy_data;
Wim Taymans's avatar
Wim Taymans committed
565 566

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

568 569
  return res;

570 571 572 573
  /* ERRORS */
invalid_time:
  {
    (func) (clock, GST_CLOCK_TIME_NONE, id, user_data);
574 575
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
576 577
    return GST_CLOCK_BADTIME;
  }
Wim Taymans's avatar
Wim Taymans committed
578 579 580 581 582
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
583 584
}

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
/**
 * gst_clock_id_wait_async:
 * @id: a #GstClockID to wait on
 * @func: The callback function
 * @user_data: User data passed in the callback
 *
 * Register a callback on the given #GstClockID @id with the given
 * function and user_data. When passing a #GstClockID with an invalid
 * time to this function, the callback will be called immediately
 * with  a time set to GST_CLOCK_TIME_NONE. The callback will
 * be called when the time of @id has been reached.
 *
 * The callback @func can be invoked from any thread, either provided by the
 * core or from a streaming thread. The application should be prepared for this.
 *
 * Returns: the result of the non blocking wait.
 *
 * MT safe.
 */
GstClockReturn
gst_clock_id_wait_async (GstClockID id,
    GstClockCallback func, gpointer user_data)
{
  return gst_clock_id_wait_async_full (id, func, user_data, NULL);
}

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

629 630 631 632
  g_return_if_fail (id != NULL);

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

Wim Taymans's avatar
Wim Taymans committed
634 635
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
636
  if (G_LIKELY (cclass->unschedule))
Wim Taymans's avatar
Wim Taymans committed
637
    cclass->unschedule (clock, entry);
638 639
}

640

Stefan Kost's avatar
Stefan Kost committed
641
/*
642 643
 * GstClock abstract base class implementation
 */
644
G_DEFINE_TYPE (GstClock, gst_clock, GST_TYPE_OBJECT);
645

646
static void
647
gst_clock_class_init (GstClockClass * klass)
648
{
649
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
650

651
  parent_class = g_type_class_peek_parent (klass);
652

Wim Taymans's avatar
Wim Taymans committed
653
#ifndef GST_DISABLE_TRACE
654 655
  _gst_clock_entry_trace =
      gst_alloc_trace_register (GST_CLOCK_ENTRY_TRACE_NAME);
Wim Taymans's avatar
Wim Taymans committed
656
#endif
657

658 659 660 661
  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;
662

663
  g_object_class_install_property (gobject_class, PROP_STATS,
664 665
      g_param_spec_boolean ("stats", "Stats",
          "Enable clock stats (unimplemented)", DEFAULT_STATS,
666
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
667
  g_object_class_install_property (gobject_class, PROP_WINDOW_SIZE,
668 669
      g_param_spec_int ("window-size", "Window size",
          "The size of the window used to calculate rate and offset", 2, 1024,
670
          DEFAULT_WINDOW_SIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
671 672
  g_object_class_install_property (gobject_class, PROP_WINDOW_THRESHOLD,
      g_param_spec_int ("window-threshold", "Window threshold",
673
          "The threshold to start calculating rate and offset", 2, 1024,
674 675
          DEFAULT_WINDOW_THRESHOLD,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
676
  g_object_class_install_property (gobject_class, PROP_TIMEOUT,
677 678
      g_param_spec_uint64 ("timeout", "Timeout",
          "The amount of time, in nanoseconds, to sample master and slave clocks",
679 680
          0, G_MAXUINT64, DEFAULT_TIMEOUT,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
681 682

  g_type_class_add_private (klass, sizeof (GstClockPrivate));
Wim Taymans's avatar
Wim Taymans committed
683 684
}

685
static void
686
gst_clock_init (GstClock * clock)
Wim Taymans's avatar
Wim Taymans committed
687
{
688 689
  clock->last_time = 0;
  clock->entries = NULL;
690
  clock->entries_changed = g_cond_new ();
691
  clock->stats = FALSE;
692

693
  clock->ABI.priv =
694 695
      G_TYPE_INSTANCE_GET_PRIVATE (clock, GST_TYPE_CLOCK, GstClockPrivate);

696 697
  clock->internal_calibration = 0;
  clock->external_calibration = 0;
698 699 700 701
  clock->rate_numerator = 1;
  clock->rate_denominator = 1;

  clock->slave_lock = g_mutex_new ();
702 703
  clock->window_size = DEFAULT_WINDOW_SIZE;
  clock->window_threshold = DEFAULT_WINDOW_THRESHOLD;
Wim Taymans's avatar
Wim Taymans committed
704
  clock->filling = TRUE;
705 706 707
  clock->time_index = 0;
  clock->timeout = DEFAULT_TIMEOUT;
  clock->times = g_new0 (GstClockTime, 4 * clock->window_size);
Wim Taymans's avatar
Wim Taymans committed
708 709
}

710 711 712 713
static void
gst_clock_dispose (GObject * object)
{
  GstClock *clock = GST_CLOCK (object);
714
  GstClock **master_p;
715 716

  GST_OBJECT_LOCK (clock);
717 718
  master_p = &clock->master;
  gst_object_replace ((GstObject **) master_p, NULL);
719 720 721 722 723
  GST_OBJECT_UNLOCK (clock);

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

Wim Taymans's avatar
Wim Taymans committed
724
static void
Wim Taymans's avatar
Wim Taymans committed
725
gst_clock_finalize (GObject * object)
Wim Taymans's avatar
Wim Taymans committed
726 727 728
{
  GstClock *clock = GST_CLOCK (object);

729
  GST_CLOCK_SLAVE_LOCK (clock);
730 731 732 733 734 735 736
  if (clock->clockid) {
    gst_clock_id_unschedule (clock->clockid);
    gst_clock_id_unref (clock->clockid);
    clock->clockid = NULL;
  }
  g_free (clock->times);
  clock->times = NULL;
737
  GST_CLOCK_SLAVE_UNLOCK (clock);
738

739
  g_cond_free (clock->entries_changed);
740 741
  g_mutex_free (clock->slave_lock);

Wim Taymans's avatar
Wim Taymans committed
742
  G_OBJECT_CLASS (parent_class)->finalize (object);
Wim Taymans's avatar
Wim Taymans committed
743 744
}

Wim Taymans's avatar
Wim Taymans committed
745
/**
746
 * gst_clock_set_resolution
747
 * @clock: a #GstClock
748
 * @resolution: The resolution to set
Wim Taymans's avatar
Wim Taymans committed
749
 *
750 751 752 753 754
 * 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.
755 756
 *
 * Returns: the new resolution of the clock.
Wim Taymans's avatar
Wim Taymans committed
757
 */
758 759
GstClockTime
gst_clock_set_resolution (GstClock * clock, GstClockTime resolution)
Wim Taymans's avatar
Wim Taymans committed
760
{
Wim Taymans's avatar
Wim Taymans committed
761 762
  GstClockClass *cclass;

763 764
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
  g_return_val_if_fail (resolution != 0, 0);
765

Wim Taymans's avatar
Wim Taymans committed
766 767 768
  cclass = GST_CLOCK_GET_CLASS (clock);

  if (cclass->change_resolution)
769
    clock->resolution =
770
        cclass->change_resolution (clock, clock->resolution, resolution);
771

772 773
  return clock->resolution;
}
774

775 776
/**
 * gst_clock_get_resolution
777
 * @clock: a #GstClock
778
 *
779 780
 * Get the accuracy of the clock. The accuracy of the clock is the granularity
 * of the values returned by gst_clock_get_time().
781
 *
782
 * Returns: the resolution of the clock in units of #GstClockTime.
783 784
 *
 * MT safe.
785
 */
786
GstClockTime
787
gst_clock_get_resolution (GstClock * clock)
788
{
Wim Taymans's avatar
Wim Taymans committed
789 790
  GstClockClass *cclass;

791
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
792

Wim Taymans's avatar
Wim Taymans committed
793 794 795 796
  cclass = GST_CLOCK_GET_CLASS (clock);

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

798
  return 1;
Wim Taymans's avatar
Wim Taymans committed
799 800
}

Wim Taymans's avatar
Wim Taymans committed
801
/**
802 803 804
 * gst_clock_adjust_unlocked
 * @clock: a #GstClock to use
 * @internal: a clock time
Wim Taymans's avatar
Wim Taymans committed
805
 *
806
 * Converts the given @internal clock time to the external time, adjusting for the
807 808
 * 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
809
 * clock's OBJECT_LOCK held and is mainly used by clock subclasses.
Wim Taymans's avatar
Wim Taymans committed
810
 *
811
 * This function is the reverse of gst_clock_unadjust_unlocked().
812
 *
813
 * Returns: the converted time of the clock.
814
 */
815 816
GstClockTime
gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
817
{
818 819 820 821 822 823 824 825 826
  GstClockTime ret, cinternal, cexternal, cnum, cdenom;

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

  /* avoid divide by 0 */
827
  if (G_UNLIKELY (cdenom == 0))
828 829 830 831 832
    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
833
   * internal < cinternal to get the sign right. this case is not very common,
834 835 836
   * though.
   */
  if (G_LIKELY (internal >= cinternal)) {
837 838
    ret = internal - cinternal;
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
839 840
    ret += cexternal;
  } else {
841 842
    ret = cinternal - internal;
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
843
    /* clamp to 0 */
844
    if (G_LIKELY (cexternal > ret))
845 846 847 848
      ret = cexternal - ret;
    else
      ret = 0;
  }
849 850 851 852 853

  /* make sure the time is increasing */
  clock->last_time = MAX (ret, clock->last_time);

  return clock->last_time;
854 855
}

856 857 858 859 860 861 862 863 864 865
/**
 * gst_clock_unadjust_unlocked
 * @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.
 *
866
 * This function is the reverse of gst_clock_adjust_unlocked().
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
 *
 * Returns: the internal time of the clock corresponding to @external.
 *
 * Since: 0.10.13
 */
GstClockTime
gst_clock_unadjust_unlocked (GstClock * clock, GstClockTime external)
{
  GstClockTime ret, cinternal, cexternal, cnum, cdenom;

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

  /* avoid divide by 0 */
884
  if (G_UNLIKELY (cnum == 0))
885 886 887
    cnum = cdenom = 1;

  /* The formula is (external - cexternal) * cdenom / cnum + cinternal */
888 889 890
  if (G_LIKELY (external >= cexternal)) {
    ret = external - cexternal;
    ret = gst_util_uint64_scale (ret, cdenom, cnum);
891 892
    ret += cinternal;
  } else {
893 894 895
    ret = cexternal - external;
    ret = gst_util_uint64_scale (ret, cdenom, cnum);
    if (G_LIKELY (cinternal > ret))
896 897 898 899 900 901 902
      ret = cinternal - ret;
    else
      ret = 0;
  }
  return ret;
}

Wim Taymans's avatar
Wim Taymans committed
903
/**
904
 * gst_clock_get_internal_time
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
905
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
906
 *
907 908
 * Gets the current internal time of the given clock. The time is returned
 * unadjusted for the offset and the rate.
909
 *
910
 * Returns: the internal time of the clock. Or GST_CLOCK_TIME_NONE when
911
 * given invalid input.
912 913
 *
 * MT safe.
Wim Taymans's avatar
Wim Taymans committed
914
 */
915
GstClockTime
916
gst_clock_get_internal_time (GstClock * clock)
917
{
918
  GstClockTime ret;
919
  GstClockClass *cclass;
920

921
  g_return_val_if_fail (GST_IS_CLOCK (clock), GST_CLOCK_TIME_NONE);
922

923
  cclass = GST_CLOCK_GET_CLASS (clock);
Wim Taymans's avatar
Wim Taymans committed
924

Wim Taymans's avatar
Wim Taymans committed
925 926 927