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 242 243 244 245 246 247 248 249 250

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

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

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

  return id;
}

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

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

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

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

  g_return_if_fail (id != NULL);

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

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

332 333
  return gst_clock_entry_new (clock,
      time, GST_CLOCK_TIME_NONE, GST_CLOCK_ENTRY_SINGLE);
334 335 336
}

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

363 364
  return gst_clock_entry_new (clock,
      start_time, interval, GST_CLOCK_ENTRY_PERIODIC);
365 366
}

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

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

411
  return GST_CLOCK_ENTRY_TIME ((GstClockEntry *) id);
412 413 414 415
}

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

450
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
451

452 453
  entry = (GstClockEntry *) id;
  requested = GST_CLOCK_ENTRY_TIME (entry);
454

455 456
  clock = GST_CLOCK_ENTRY_CLOCK (entry);

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

Wim Taymans's avatar
Wim Taymans committed
461
  cclass = GST_CLOCK_GET_CLASS (clock);
462

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

465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
  /* 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
485 486 487 488 489
  }

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

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

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

496
  return res;
497 498 499 500

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

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

544
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
545
  g_return_val_if_fail (func != NULL, GST_CLOCK_ERROR);
546 547

  entry = (GstClockEntry *) id;
548 549
  requested = GST_CLOCK_ENTRY_TIME (entry);
  clock = GST_CLOCK_ENTRY_CLOCK (entry);
550

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

Wim Taymans's avatar
Wim Taymans committed
555 556
  cclass = GST_CLOCK_GET_CLASS (clock);

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

  entry->func = func;
  entry->user_data = user_data;
562
  entry->destroy_data = destroy_data;
Wim Taymans's avatar
Wim Taymans committed
563 564

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

566 567
  return res;

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

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

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

627 628 629 630
  g_return_if_fail (id != NULL);

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

Wim Taymans's avatar
Wim Taymans committed
632 633
  cclass = GST_CLOCK_GET_CLASS (clock);

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

638

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

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

649
  parent_class = g_type_class_peek_parent (klass);
650

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

656 657 658 659
  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;
660

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

  g_type_class_add_private (klass, sizeof (GstClockPrivate));
Wim Taymans's avatar
Wim Taymans committed
681 682
}

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

691
  clock->ABI.priv =
692 693
      G_TYPE_INSTANCE_GET_PRIVATE (clock, GST_TYPE_CLOCK, GstClockPrivate);

694 695
  clock->internal_calibration = 0;
  clock->external_calibration = 0;
696 697 698 699
  clock->rate_numerator = 1;
  clock->rate_denominator = 1;

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

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

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

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

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

727
  GST_CLOCK_SLAVE_LOCK (clock);
728 729 730 731 732 733 734
  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;
735
  GST_CLOCK_SLAVE_UNLOCK (clock);
736

737
  g_cond_free (clock->entries_changed);
738 739
  g_mutex_free (clock->slave_lock);

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

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

761 762
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
  g_return_val_if_fail (resolution != 0, 0);
763

Wim Taymans's avatar
Wim Taymans committed
764 765 766
  cclass = GST_CLOCK_GET_CLASS (clock);

  if (cclass->change_resolution)
767
    clock->resolution =
768
        cclass->change_resolution (clock, clock->resolution, resolution);
769

770 771
  return clock->resolution;
}
772

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

789
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
790

Wim Taymans's avatar
Wim Taymans committed
791 792 793 794
  cclass = GST_CLOCK_GET_CLASS (clock);

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

796
  return 1;
Wim Taymans's avatar
Wim Taymans committed
797 798
}

Wim Taymans's avatar
Wim Taymans committed
799
/**
800 801 802
 * gst_clock_adjust_unlocked
 * @clock: a #GstClock to use
 * @internal: a clock time
Wim Taymans's avatar
Wim Taymans committed
803
 *
804
 * Converts the given @internal clock time to the external time, adjusting for the
805 806
 * 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
807
 * clock's OBJECT_LOCK held and is mainly used by clock subclasses.
Wim Taymans's avatar
Wim Taymans committed
808
 *
809
 * This function is the reverse of gst_clock_unadjust_unlocked().
810
 *
811
 * Returns: the converted time of the clock.
812
 */
813 814
GstClockTime
gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
815
{
816 817 818 819 820 821 822 823 824
  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 */
825
  if (G_UNLIKELY (cdenom == 0))
826 827 828 829 830
    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
831
   * internal < cinternal to get the sign right. this case is not very common,
832 833 834
   * though.
   */
  if (G_LIKELY (internal >= cinternal)) {
835 836
    ret = internal - cinternal;
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
837 838
    ret += cexternal;
  } else {
839 840
    ret = cinternal - internal;
    ret = gst_util_uint64_scale (ret, cnum, cdenom);
841
    /* clamp to 0 */
842
    if (G_LIKELY (cexternal > ret))
843 844 845 846
      ret = cexternal - ret;
    else
      ret = 0;
  }
847 848 849 850 851

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

  return clock->last_time;
852 853
}

854 855 856 857 858 859 860 861 862 863
/**
 * 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.
 *
864
 * This function is the reverse of gst_clock_adjust_unlocked().
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
 *
 * 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 */
882
  if (G_UNLIKELY (cnum == 0))
883 884 885
    cnum = cdenom = 1;

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

Wim Taymans's avatar
Wim Taymans committed
901
/**
902
 * gst_clock_get_internal_time
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
903
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
904
 *
905 906
 * Gets the current internal time of the given clock. The time is returned
 * unadjusted for the offset and the rate.
907
 *
Andy Wingo Wingo's avatar