gstclock.c 37 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 31 32
 * Different clock implementations are possible by implementing this abstract
 * base class.
 *
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
 *
Wim Taymans's avatar
Wim Taymans committed
40
 * The pipeline uses the clock to calculate the stream 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 55
 * 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
 * unscheduled a return value of GST_CLOCK_UNSCHEDULED is returned.
Wim Taymans's avatar
Wim Taymans committed
56
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
57
 * Periodic callbacks scheduled async will be repeadedly called automatically
Wim Taymans's avatar
Wim Taymans committed
58
 * until it is unscheduled. To schedule a sync periodic callback,
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
59
 * gst_clock_id_wait() should be called repeadedly.
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 66
 * operation, a new #GstClockID should be created and the old unscheduled one
 * should be destroyed wirth 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 81 82 83 84
 *
 * These clock operations do not operate on the stream time, so the callbacks
 * 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.
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
85 86 87 88 89 90 91 92
 * When a clock has the GST_CLOCK_FLAG_CAN_SET_MASTER flag set, it can be
 * slaved to another #GstClock with the gst_clock_set_master(). The clock will
 * then automatically be synchronized to this master clock by repeadedly
 * sampling the master clock and the slave clock and recalibrating the slave
 * clock with gst_clock_set_calibration(). This feature is mostly usefull for
 * 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 95 96 97 98 99 100
 * gst_clock_get_calibration() function. 
 *
 * The master/slave synchronisation can be tuned with the "timeout", "window-size"
 * and "window-threshold" properties. The "timeout" property defines the interval
 * to sample the master clock and run the calibration functions. 
 * "window-size" defines the number of samples to use when calibrating and
 * "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 2006-08-11 (0.10.10)
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 121 122 123 124 125 126
#if GLIB_CHECK_VERSION (2, 10, 0)
#define ALLOC_ENTRY()     g_slice_new (GstClockEntry)
#define FREE_ENTRY(entry) g_slice_free (GstClockEntry, entry)
#else
#define ALLOC_ENTRY()     g_new (GstClockEntry, 1)
#define FREE_ENTRY(entry) g_free (entry)
#endif

127 128
/* #define DEBUGGING_ENABLED */

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
129 130 131 132
#define DEFAULT_STATS                   FALSE
#define DEFAULT_WINDOW_SIZE             32
#define DEFAULT_WINDOW_THRESHOLD        4
#define DEFAULT_TIMEOUT                 GST_SECOND / 10
133

134 135
enum
{
136 137 138 139 140
  PROP_0,
  PROP_STATS,
  PROP_WINDOW_SIZE,
  PROP_WINDOW_THRESHOLD,
  PROP_TIMEOUT
141 142
};

143 144
static void gst_clock_class_init (GstClockClass * klass);
static void gst_clock_init (GstClock * clock);
145
static void gst_clock_dispose (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
146
static void gst_clock_finalize (GObject * object);
Wim Taymans's avatar
Wim Taymans committed
147

148 149 150 151 152
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);
153

154

155
static GstObjectClass *parent_class = NULL;
156

157 158
/* static guint gst_clock_signals[LAST_SIGNAL] = { 0 }; */

Wim Taymans's avatar
Wim Taymans committed
159
static GstClockID
160 161
gst_clock_entry_new (GstClock * clock, GstClockTime time,
    GstClockTime interval, GstClockEntryType type)
162 163
{
  GstClockEntry *entry;
164

165
  entry = ALLOC_ENTRY ();
Wim Taymans's avatar
Wim Taymans committed
166
#ifndef GST_DISABLE_TRACE
Wim Taymans's avatar
Wim Taymans committed
167
  gst_alloc_trace_new (_gst_clock_entry_trace, entry);
Wim Taymans's avatar
Wim Taymans committed
168
#endif
169 170
  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
      "created entry %p, time %" GST_TIME_FORMAT, entry, GST_TIME_ARGS (time));
171

172
  gst_atomic_int_set (&entry->refcount, 1);
173
  entry->clock = clock;
174
  entry->type = type;
175
  entry->time = time;
176
  entry->interval = interval;
177
  entry->status = GST_CLOCK_BUSY;
178 179
  entry->func = NULL;
  entry->user_data = NULL;
180

181 182
  return (GstClockID) entry;
}
183

184 185
/**
 * gst_clock_id_ref:
Wim Taymans's avatar
Wim Taymans committed
186
 * @id: The #GstClockID to ref
187
 *
Wim Taymans's avatar
Wim Taymans committed
188
 * Increase the refcount of given @id.
189 190 191 192 193 194 195 196 197 198
 *
 * Returns: The same #GstClockID with increased refcount.
 *
 * MT safe.
 */
GstClockID
gst_clock_id_ref (GstClockID id)
{
  g_return_val_if_fail (id != NULL, NULL);

199
  g_atomic_int_inc (&((GstClockEntry *) id)->refcount);
200 201 202 203 204 205 206 207 208 209 210 211 212 213

  return id;
}

static void
_gst_clock_id_free (GstClockID id)
{
  g_return_if_fail (id != NULL);

  GST_CAT_DEBUG (GST_CAT_CLOCK, "freed entry %p", id);

#ifndef GST_DISABLE_TRACE
  gst_alloc_trace_free (_gst_clock_entry_trace, id);
#endif
214
  FREE_ENTRY (id);
215 216 217 218
}

/**
 * gst_clock_id_unref:
Wim Taymans's avatar
Wim Taymans committed
219
 * @id: The #GstClockID to unref
220
 *
Wim Taymans's avatar
Wim Taymans committed
221
 * Unref given @id. When the refcount reaches 0 the
222 223 224 225 226 227 228 229 230 231 232
 * #GstClockID will be freed.
 *
 * MT safe.
 */
void
gst_clock_id_unref (GstClockID id)
{
  gint zero;

  g_return_if_fail (id != NULL);

233
  zero = g_atomic_int_dec_and_test (&((GstClockEntry *) id)->refcount);
234 235 236 237 238 239
  /* if we ended up with the refcount at zero, free the id */
  if (zero) {
    _gst_clock_id_free (id);
  }
}

240 241
/**
 * gst_clock_new_single_shot_id
Wim Taymans's avatar
Wim Taymans committed
242
 * @clock: The #GstClockID to get a single shot notification from
243 244
 * @time: the requested time
 *
Wim Taymans's avatar
Wim Taymans committed
245
 * Get a #GstClockID from @clock to trigger a single shot
246 247
 * notification at the requested time. The single shot id should be
 * unreffed after usage.
248
 *
Wim Taymans's avatar
Wim Taymans committed
249
 * Returns: A #GstClockID that can be used to request the time notification.
250 251
 *
 * MT safe.
252 253
 */
GstClockID
254
gst_clock_new_single_shot_id (GstClock * clock, GstClockTime time)
255
{
256 257
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);

258 259
  return gst_clock_entry_new (clock,
      time, GST_CLOCK_TIME_NONE, GST_CLOCK_ENTRY_SINGLE);
260 261 262
}

/**
Wim Taymans's avatar
Wim Taymans committed
263
 * gst_clock_new_periodic_id
Wim Taymans's avatar
Wim Taymans committed
264
 * @clock: The #GstClockID to get a periodic notification id from
265 266 267
 * @start_time: the requested start time
 * @interval: the requested interval
 *
Wim Taymans's avatar
Wim Taymans committed
268
 * Get an ID from @clock to trigger a periodic notification.
269
 * The periodeic notifications will be start at time start_time and
Wim Taymans's avatar
Wim Taymans committed
270
 * will then be fired with the given interval. @id should be unreffed
271
 * after usage.
272
 *
Wim Taymans's avatar
Wim Taymans committed
273
 * Returns: A #GstClockID that can be used to request the time notification.
274 275
 *
 * MT safe.
276 277
 */
GstClockID
278 279
gst_clock_new_periodic_id (GstClock * clock, GstClockTime start_time,
    GstClockTime interval)
280
{
281
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);
282
  g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (start_time), NULL);
283 284
  g_return_val_if_fail (interval != 0, NULL);

285 286
  return gst_clock_entry_new (clock,
      start_time, interval, GST_CLOCK_ENTRY_PERIODIC);
287 288
}

289 290
/**
 * gst_clock_id_compare_func
Wim Taymans's avatar
Wim Taymans committed
291 292
 * @id1: A #GstClockID
 * @id2: A #GstClockID to compare with
293
 *
Wim Taymans's avatar
Wim Taymans committed
294
 * Compares the two #GstClockID instances. This function can be used
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
 * 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
315
  return 0;
316 317
}

318 319
/**
 * gst_clock_id_get_time
Wim Taymans's avatar
Wim Taymans committed
320
 * @id: The #GstClockID to query
321 322 323
 *
 * Get the time of the clock ID
 *
324 325 326
 * Returns: the time of the given clock id.
 *
 * MT safe.
327 328 329 330 331 332
 */
GstClockTime
gst_clock_id_get_time (GstClockID id)
{
  g_return_val_if_fail (id != NULL, GST_CLOCK_TIME_NONE);

333
  return GST_CLOCK_ENTRY_TIME ((GstClockEntry *) id);
334 335 336 337 338
}


/**
 * gst_clock_id_wait
Wim Taymans's avatar
Wim Taymans committed
339 340 341 342 343 344 345 346 347 348 349
 * @id: The #GstClockID to wait on
 * @jitter: A pointer that will contain the jitter, can be NULL.
 *
 * 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(). 
 *
 * If the @jitter argument is not NULL and this function returns #GST_CLOCK_OK
 * or #GST_CLOCK_EARLY, it will contain the difference
 * against the clock and the time of @id when this method was
350 351
 * called. 
 * Positive values indicate how late @id was relative to the clock
352
 * (in which case this function will return #GST_CLOCK_EARLY). 
353
 * Negative values indicate how much time was spent waiting on the clock 
354
 * before this function returned.
Wim Taymans's avatar
Wim Taymans committed
355 356 357 358 359
 *
 * 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().
360 361
 *
 * MT safe.
362 363
 */
GstClockReturn
364
gst_clock_id_wait (GstClockID id, GstClockTimeDiff * jitter)
365 366
{
  GstClockEntry *entry;
367
  GstClock *clock;
368
  GstClockReturn res;
369
  GstClockTime requested;
Wim Taymans's avatar
Wim Taymans committed
370
  GstClockClass *cclass;
371

372
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
373

374 375
  entry = (GstClockEntry *) id;
  requested = GST_CLOCK_ENTRY_TIME (entry);
376

377 378
  clock = GST_CLOCK_ENTRY_CLOCK (entry);

Wim Taymans's avatar
Wim Taymans committed
379
  /* can't sync on invalid times */
380 381 382
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
383
  /* a previously unscheduled entry cannot be scheduled again */
384 385
  if (G_UNLIKELY (entry->status == GST_CLOCK_UNSCHEDULED))
    goto unscheduled;
386

Wim Taymans's avatar
Wim Taymans committed
387
  cclass = GST_CLOCK_GET_CLASS (clock);
388

Wim Taymans's avatar
Wim Taymans committed
389 390
  if (G_UNLIKELY (cclass->wait == NULL))
    goto not_supported;
391

Wim Taymans's avatar
Wim Taymans committed
392 393 394 395 396
  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "waiting on clock entry %p", id);

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

397 398 399
    /* 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. */
Wim Taymans's avatar
Wim Taymans committed
400 401 402 403 404 405 406 407 408
    *jitter = GST_CLOCK_DIFF (requested, now);
  }
  res = cclass->wait (clock, entry);

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

  if (entry->type == GST_CLOCK_ENTRY_PERIODIC) {
    entry->time += entry->interval;
409
  }
Wim Taymans's avatar
Wim Taymans committed
410 411 412 413

  if (clock->stats)
    gst_clock_update_stats (clock);

414
  return res;
415 416 417 418

  /* ERRORS */
invalid_time:
  {
419 420
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
421 422 423 424
    return GST_CLOCK_BADTIME;
  }
unscheduled:
  {
425 426
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "entry was unscheduled return _UNSCHEDULED");
427 428
    return GST_CLOCK_UNSCHEDULED;
  }
Wim Taymans's avatar
Wim Taymans committed
429 430 431 432 433
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
434 435 436
}

/**
Wim Taymans's avatar
Wim Taymans committed
437 438
 * gst_clock_id_wait_async:
 * @id: a #GstClockID to wait on
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
439
 * @func: The callback function
440 441
 * @user_data: User data passed in the calback
 *
Wim Taymans's avatar
Wim Taymans committed
442 443
 * Register a callback on the given #GstClockID @id with the given
 * function and user_data. When passing a #GstClockID with an invalid
444 445
 * time to this function, the callback will be called immediatly
 * with  a time set to GST_CLOCK_TIME_NONE. The callback will
Wim Taymans's avatar
Wim Taymans committed
446
 * be called when the time of @id has been reached.
447
 *
448
 * Returns: the result of the non blocking wait.
449 450
 *
 * MT safe.
451 452 453
 */
GstClockReturn
gst_clock_id_wait_async (GstClockID id,
454
    GstClockCallback func, gpointer user_data)
455 456 457
{
  GstClockEntry *entry;
  GstClock *clock;
458
  GstClockReturn res;
Wim Taymans's avatar
Wim Taymans committed
459
  GstClockClass *cclass;
460
  GstClockTime requested;
461

462
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
463
  g_return_val_if_fail (func != NULL, GST_CLOCK_ERROR);
464 465

  entry = (GstClockEntry *) id;
466 467
  requested = GST_CLOCK_ENTRY_TIME (entry);
  clock = GST_CLOCK_ENTRY_CLOCK (entry);
468

Wim Taymans's avatar
Wim Taymans committed
469
  /* can't sync on invalid times */
470 471 472
  if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (requested)))
    goto invalid_time;

Wim Taymans's avatar
Wim Taymans committed
473
  /* a previously unscheduled entry cannot be scheduled again */
474 475
  if (G_UNLIKELY (entry->status == GST_CLOCK_UNSCHEDULED))
    goto unscheduled;
476

Wim Taymans's avatar
Wim Taymans committed
477 478
  cclass = GST_CLOCK_GET_CLASS (clock);

Wim Taymans's avatar
Wim Taymans committed
479 480 481 482 483 484 485
  if (G_UNLIKELY (cclass->wait_async == NULL))
    goto not_supported;

  entry->func = func;
  entry->user_data = user_data;

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

487 488
  return res;

489 490 491 492
  /* ERRORS */
invalid_time:
  {
    (func) (clock, GST_CLOCK_TIME_NONE, id, user_data);
493 494
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "invalid time requested, returning _BADTIME");
495 496 497 498
    return GST_CLOCK_BADTIME;
  }
unscheduled:
  {
499 500
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "entry was unscheduled return _UNSCHEDULED");
501 502
    return GST_CLOCK_UNSCHEDULED;
  }
Wim Taymans's avatar
Wim Taymans committed
503 504 505 506 507
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "clock wait is not supported");
    return GST_CLOCK_UNSUPPORTED;
  }
508 509
}

510
/**
Wim Taymans's avatar
Wim Taymans committed
511 512
 * gst_clock_id_unschedule:
 * @id: The id to unschedule
513
 *
Wim Taymans's avatar
Wim Taymans committed
514
 * Cancel an outstanding request with @id. This can either
515
 * be an outstanding async notification or a pending sync notification.
Wim Taymans's avatar
Wim Taymans committed
516 517
 * After this call, @id cannot be used anymore to receive sync or
 * async notifications, you need to create a new #GstClockID.
518 519
 *
 * MT safe.
520 521 522 523 524 525
 */
void
gst_clock_id_unschedule (GstClockID id)
{
  GstClockEntry *entry;
  GstClock *clock;
Wim Taymans's avatar
Wim Taymans committed
526
  GstClockClass *cclass;
527

528 529 530 531
  g_return_if_fail (id != NULL);

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

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

Wim Taymans's avatar
Wim Taymans committed
535
  if (G_LIKELY (cclass->unschedule))
Wim Taymans's avatar
Wim Taymans committed
536
    cclass->unschedule (clock, entry);
537 538
}

539 540 541 542

/**
 * GstClock abstract base class implementation
 */
543 544
GType
gst_clock_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
545
{
546 547
  static GType clock_type = 0;

548
  if (G_UNLIKELY (clock_type == 0)) {
549
    static const GTypeInfo clock_info = {
550
      sizeof (GstClockClass),
551 552 553 554 555
      NULL,
      NULL,
      (GClassInitFunc) gst_clock_class_init,
      NULL,
      NULL,
556
      sizeof (GstClock),
557
      0,
558 559 560
      (GInstanceInitFunc) gst_clock_init,
      NULL
    };
561

562
    clock_type = g_type_register_static (GST_TYPE_OBJECT, "GstClock",
563
        &clock_info, G_TYPE_FLAG_ABSTRACT);
564 565 566
  }
  return clock_type;
}
567

568
static void
569
gst_clock_class_init (GstClockClass * klass)
570 571 572
{
  GObjectClass *gobject_class;
  GstObjectClass *gstobject_class;
573

574 575
  gobject_class = G_OBJECT_CLASS (klass);
  gstobject_class = GST_OBJECT_CLASS (klass);
576

577
  parent_class = g_type_class_peek_parent (klass);
578

Wim Taymans's avatar
Wim Taymans committed
579 580 581
  if (!g_thread_supported ())
    g_thread_init (NULL);

Wim Taymans's avatar
Wim Taymans committed
582
#ifndef GST_DISABLE_TRACE
583 584
  _gst_clock_entry_trace =
      gst_alloc_trace_register (GST_CLOCK_ENTRY_TRACE_NAME);
Wim Taymans's avatar
Wim Taymans committed
585
#endif
586

587
  gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_clock_dispose);
Wim Taymans's avatar
Wim Taymans committed
588
  gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_clock_finalize);
589 590 591
  gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_clock_set_property);
  gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_clock_get_property);

592
  g_object_class_install_property (gobject_class, PROP_STATS,
593 594 595
      g_param_spec_boolean ("stats", "Stats",
          "Enable clock stats (unimplemented)", DEFAULT_STATS,
          G_PARAM_READWRITE));
596
  g_object_class_install_property (gobject_class, PROP_WINDOW_SIZE,
597 598 599
      g_param_spec_int ("window-size", "Window size",
          "The size of the window used to calculate rate and offset", 2, 1024,
          DEFAULT_WINDOW_SIZE, G_PARAM_READWRITE));
600 601
  g_object_class_install_property (gobject_class, PROP_WINDOW_THRESHOLD,
      g_param_spec_int ("window-threshold", "Window threshold",
602 603
          "The threshold to start calculating rate and offset", 2, 1024,
          DEFAULT_WINDOW_THRESHOLD, G_PARAM_READWRITE));
604
  g_object_class_install_property (gobject_class, PROP_TIMEOUT,
605 606 607
      g_param_spec_uint64 ("timeout", "Timeout",
          "The amount of time, in nanoseconds, to sample master and slave clocks",
          0, G_MAXUINT64, DEFAULT_TIMEOUT, G_PARAM_READWRITE));
Wim Taymans's avatar
Wim Taymans committed
608 609
}

610
static void
611
gst_clock_init (GstClock * clock)
Wim Taymans's avatar
Wim Taymans committed
612
{
613 614
  clock->last_time = 0;
  clock->entries = NULL;
615
  clock->entries_changed = g_cond_new ();
616
  clock->stats = FALSE;
617

618 619
  clock->internal_calibration = 0;
  clock->external_calibration = 0;
620 621 622 623
  clock->rate_numerator = 1;
  clock->rate_denominator = 1;

  clock->slave_lock = g_mutex_new ();
624 625
  clock->window_size = DEFAULT_WINDOW_SIZE;
  clock->window_threshold = DEFAULT_WINDOW_THRESHOLD;
Wim Taymans's avatar
Wim Taymans committed
626
  clock->filling = TRUE;
627 628 629
  clock->time_index = 0;
  clock->timeout = DEFAULT_TIMEOUT;
  clock->times = g_new0 (GstClockTime, 4 * clock->window_size);
Wim Taymans's avatar
Wim Taymans committed
630 631
}

632 633 634 635
static void
gst_clock_dispose (GObject * object)
{
  GstClock *clock = GST_CLOCK (object);
636
  GstClock **master_p;
637 638

  GST_OBJECT_LOCK (clock);
639 640
  master_p = &clock->master;
  gst_object_replace ((GstObject **) master_p, NULL);
641 642 643 644 645
  GST_OBJECT_UNLOCK (clock);

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

Wim Taymans's avatar
Wim Taymans committed
646
static void
Wim Taymans's avatar
Wim Taymans committed
647
gst_clock_finalize (GObject * object)
Wim Taymans's avatar
Wim Taymans committed
648 649 650
{
  GstClock *clock = GST_CLOCK (object);

651
  GST_CLOCK_SLAVE_LOCK (clock);
652 653 654 655 656 657 658
  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;
659
  GST_CLOCK_SLAVE_UNLOCK (clock);
660

661
  g_cond_free (clock->entries_changed);
662 663
  g_mutex_free (clock->slave_lock);

Wim Taymans's avatar
Wim Taymans committed
664
  G_OBJECT_CLASS (parent_class)->finalize (object);
Wim Taymans's avatar
Wim Taymans committed
665 666
}

Wim Taymans's avatar
Wim Taymans committed
667
/**
668
 * gst_clock_set_resolution
669
 * @clock: a #GstClock
670
 * @resolution: The resolution to set
Wim Taymans's avatar
Wim Taymans committed
671
 *
672 673 674
 * Set the accuracy of the clock.
 *
 * Returns: the new resolution of the clock.
Wim Taymans's avatar
Wim Taymans committed
675
 */
676 677
GstClockTime
gst_clock_set_resolution (GstClock * clock, GstClockTime resolution)
Wim Taymans's avatar
Wim Taymans committed
678
{
Wim Taymans's avatar
Wim Taymans committed
679 680
  GstClockClass *cclass;

681 682
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
  g_return_val_if_fail (resolution != 0, 0);
683

Wim Taymans's avatar
Wim Taymans committed
684 685 686
  cclass = GST_CLOCK_GET_CLASS (clock);

  if (cclass->change_resolution)
687
    clock->resolution =
688
        cclass->change_resolution (clock, clock->resolution, resolution);
689

690 691
  return clock->resolution;
}
692

693 694
/**
 * gst_clock_get_resolution
695
 * @clock: a #GstClock
696 697 698
 *
 * Get the accuracy of the clock.
 *
699
 * Returns: the resolution of the clock in units of #GstClockTime.
700 701
 *
 * MT safe.
702
 */
703
GstClockTime
704
gst_clock_get_resolution (GstClock * clock)
705
{
Wim Taymans's avatar
Wim Taymans committed
706 707
  GstClockClass *cclass;

708
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0);
709

Wim Taymans's avatar
Wim Taymans committed
710 711 712 713
  cclass = GST_CLOCK_GET_CLASS (clock);

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

715
  return 1;
Wim Taymans's avatar
Wim Taymans committed
716 717
}

Wim Taymans's avatar
Wim Taymans committed
718
/**
719 720 721
 * gst_clock_adjust_unlocked
 * @clock: a #GstClock to use
 * @internal: a clock time
Wim Taymans's avatar
Wim Taymans committed
722
 *
723
 * Converts the given @internal clock time to the real time, adjusting for the
724 725
 * 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
726
 * clock's OBJECT_LOCK held and is mainly used by clock subclasses.
Wim Taymans's avatar
Wim Taymans committed
727
 *
728
 * Returns: the converted time of the clock.
729
 *
730
 * MT safe.
731
 */
732 733
GstClockTime
gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
734
{
735
  GstClockTime ret;
736

737 738
  ret = gst_util_uint64_scale (internal - clock->internal_calibration,
      clock->rate_numerator, clock->rate_denominator);
739
  ret += clock->external_calibration;
740 741 742 743 744

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

  return clock->last_time;
745 746
}

Wim Taymans's avatar
Wim Taymans committed
747
/**
748
 * gst_clock_get_internal_time
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
749
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
750
 *
751 752
 * Gets the current internal time of the given clock. The time is returned
 * unadjusted for the offset and the rate.
753
 *
754
 * Returns: the internal time of the clock. Or GST_CLOCK_TIME_NONE when
755 756 757
 * giving wrong input.
 *
 * MT safe.
Wim Taymans's avatar
Wim Taymans committed
758
 */
759
GstClockTime
760
gst_clock_get_internal_time (GstClock * clock)
761
{
762
  GstClockTime ret;
763
  GstClockClass *cclass;
764

765
  g_return_val_if_fail (GST_IS_CLOCK (clock), GST_CLOCK_TIME_NONE);
766

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

Wim Taymans's avatar
Wim Taymans committed
769 770 771 772 773
  if (G_UNLIKELY (cclass->get_internal_time == NULL))
    goto not_supported;

  ret = cclass->get_internal_time (clock);

774
  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "internal time %" GST_TIME_FORMAT,
775
      GST_TIME_ARGS (ret));
776

777
  return ret;
Wim Taymans's avatar
Wim Taymans committed
778 779 780 781 782 783 784 785

  /* ERRORS */
not_supported:
  {
    GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock,
        "internal time not supported, return 0");
    return G_GINT64_CONSTANT (0);
  }
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
}

/**
 * gst_clock_get_time
 * @clock: a #GstClock to query
 *
 * Gets the current time of the given clock. The time is always
 * monotonically increasing and adjusted according to the current
 * offset and rate.
 *
 * Returns: the time of the clock. Or GST_CLOCK_TIME_NONE when
 * giving wrong input.
 *
 * MT safe.
 */
GstClockTime
gst_clock_get_time (GstClock * clock)
{
  GstClockTime ret;

  g_return_val_if_fail (GST_IS_CLOCK (clock), GST_CLOCK_TIME_NONE);

  ret = gst_clock_get_internal_time (clock);

810
  GST_OBJECT_LOCK (clock);
811
  /* this will scale for rate and offset */
812
  ret = gst_clock_adjust_unlocked (clock, ret);
813
  GST_OBJECT_UNLOCK (clock);
814

815
  GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, clock, "adjusted time %" GST_TIME_FORMAT,
816
      GST_TIME_ARGS (ret));
817

818
  return ret;
819 820
}

821 822 823 824 825
/**
 * gst_clock_set_calibration
 * @clock: a #GstClock to calibrate
 * @internal: a reference internal time
 * @external: a reference external time
826 827 828
 * @rate_num: the numerator of the rate of the clock relative to its
 *            internal time 
 * @rate_denom: the denominator of the rate of the clock
829
 *
830 831
 * Adjusts the rate and time of @clock. A rate of 1/1 is the normal speed of
 * the clock. Values bigger than 1/1 make the clock go faster.
832 833 834 835 836
 *
 * @internal and @external are calibration parameters that arrange that
 * gst_clock_get_time() should have been @external at internal time @internal.
 * This internal time should not be in the future; that is, it should be less
 * than the value of gst_clock_get_internal_time() when this function is called.
837 838 839 840 841
 *
 * Subsequent calls to gst_clock_get_time() will return clock times computed as
 * follows:
 *
 * <programlisting>
842
 *   time = (internal_time - @internal) * @rate_num / @rate_denom + @external
843 844
 * </programlisting>
 *
845 846 847
 * This formula is implemented in gst_clock_adjust_unlocked(). Of course, it
 * tries to do the integer arithmetic as precisely as possible.
 *
848 849 850 851 852 853 854
 * Note that gst_clock_get_time() always returns increasing values so when you
 * move the clock backwards, gst_clock_get_time() will report the previous value
 * until the clock catches up.
 *
 * MT safe.
 */
void
855
gst_clock_set_calibration (GstClock * clock, GstClockTime internal, GstClockTime
856
    external, GstClockTime rate_num, GstClockTime rate_denom)
857 858
{
  g_return_if_fail (GST_IS_CLOCK (clock));
859
  g_return_if_fail (rate_num >= 0);
860
  g_return_if_fail (rate_denom > 0);
861
  g_return_if_fail (internal <= gst_clock_get_internal_time (clock));
862

863
  GST_OBJECT_LOCK (clock);
864 865
  clock->internal_calibration = internal;
  clock->external_calibration = external;
866 867
  clock->rate_numerator = rate_num;
  clock->rate_denominator = rate_denom;
868
  GST_OBJECT_UNLOCK (clock);
869 870 871
}

/**
872 873 874 875
 * gst_clock_get_calibration
 * @clock: a #GstClock 
 * @internal: a location to store the internal time
 * @external: a location to store the external time
876 877
 * @rate_num: a location to store the rate numerator
 * @rate_denom: a location to store the rate denominator