gstclock.c 15.2 KB
Newer Older
1 2 3 4 5
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
 *
 * gstclock.c: Clock subsystem for maintaining time sync
Wim Taymans's avatar
Wim Taymans committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * 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.
 */

#include <sys/time.h>
24

25
/* #define GST_DEBUG_ENABLED */
26 27
#include "gst_private.h"

28
#include "gstclock.h"
29 30
#include "gstlog.h"
#include "gstmemchunk.h"
Wim Taymans's avatar
Wim Taymans committed
31

32 33 34 35 36
enum {
  ARG_0,
  ARG_STATS,
};

37
#define CLASS(clock)  GST_CLOCK_CLASS (G_OBJECT_GET_CLASS (clock))
38

39
static GstMemChunk *_gst_clock_entries_chunk;
Wim Taymans's avatar
Wim Taymans committed
40

41 42
static void		gst_clock_class_init		(GstClockClass *klass);
static void		gst_clock_init			(GstClock *clock);
43 44 45 46 47
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);
48

49

50 51 52
static GstObjectClass *parent_class = NULL;
/* static guint gst_clock_signals[LAST_SIGNAL] = { 0 }; */

53 54
static GMutex *_gst_clock_mutex;
static GCond  *_gst_clock_cond;
55

56 57 58 59 60
static inline GstClockID
gst_clock_entry_new (GstClock *clock, GstClockTime time, 
		     GstClockTime interval, GstClockEntryType type)
{
  GstClockEntry *entry;
61

62
  entry = gst_mem_chunk_alloc (_gst_clock_entries_chunk);
63

64 65 66 67 68
  entry->clock = clock;
  entry->time = time;
  entry->interval = time;
  entry->type = type;
  entry->status = GST_CLOCK_ENTRY_OK;
69

70 71
  return (GstClockID) entry;
}
72

73 74 75 76 77 78 79 80 81 82 83 84 85
/**
 * gst_clock_new_single_shot_id
 * @clock: The clockid to get a single shot notification from
 * @time: the requested time
 *
 * Get an ID from the given clock to trigger a single shot 
 * notification at the requested time.
 *
 * Returns: An id that can be used to request the time notification.
 */
GstClockID
gst_clock_new_single_shot_id (GstClock *clock, GstClockTime time)
{
86 87
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);

88 89 90 91 92 93 94
  return gst_clock_entry_new (clock, 
		  	      time, 
			      GST_CLOCK_TIME_NONE, 
			      GST_CLOCK_ENTRY_SINGLE);
}

/**
Wim Taymans's avatar
Wim Taymans committed
95
 * gst_clock_new_periodic_id
96 97 98 99 100 101 102 103 104 105 106 107 108 109
 * @clock: The clockid to get a periodic notification id from
 * @start_time: the requested start time
 * @interval: the requested interval
 *
 * Get an ID from the given clock to trigger a periodic notification.
 * The periodeic notifications will be start at time start_time and
 * will then be fired with the given interval.
 *
 * Returns: An id that can be used to request the time notification.
 */
GstClockID
gst_clock_new_periodic_id (GstClock *clock, GstClockTime start_time,
                           GstClockTime interval)
{
110 111 112 113
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);
  g_return_val_if_fail (start_time != GST_CLOCK_TIME_NONE, NULL);
  g_return_val_if_fail (interval != 0, NULL);

114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
  return gst_clock_entry_new (clock, 
		  	      start_time, 
			      interval, 
			      GST_CLOCK_ENTRY_PERIODIC);
}

/**
 * gst_clock_id_get_time
 * @id: The clockid to query
 *
 * Get the time of the clock ID
 *
 * Returns: the time of the given clock id
 */
GstClockTime
gst_clock_id_get_time (GstClockID id)
{
  g_return_val_if_fail (id != NULL, GST_CLOCK_TIME_NONE);

  return GST_CLOCK_ENTRY_TIME ((GstClockEntry *)id);
}


/**
 * gst_clock_id_wait
 * @id: The clockid to wait on
 * @jitter: A pointer that will contain the jitter
 *
 * Perform a blocking wait on the given ID. The jitter arg can be
 * NULL
 *
 * Returns: the result of the blocking wait.
 */
GstClockReturn
gst_clock_id_wait (GstClockID id, GstClockTimeDiff *jitter)
149 150
{
  GstClockEntry *entry;
151 152 153 154 155
  GstClock *clock;
  GstClockReturn res = GST_CLOCK_UNSUPPORTED;
  GstClockTime requested;
  
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
156

157 158
  entry = (GstClockEntry *) id;
  requested = GST_CLOCK_ENTRY_TIME (entry);
159 160 161 162 163 164 165

  if (requested == GST_CLOCK_TIME_NONE) {
    res = GST_CLOCK_TIMEOUT;
    goto done;
  }
  
  clock = GST_CLOCK_ENTRY_CLOCK (entry);
166 167 168
  
  if (CLASS (clock)->wait) {
    GstClockTime now;
169

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    do {
      res = CLASS (clock)->wait (clock, entry);
    }
    while (res == GST_CLOCK_ENTRY_RESTART);

    if (jitter) {
      now = gst_clock_get_time (clock);
      *jitter = now - requested;
    }

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

185
done:
186 187 188 189 190 191 192 193
  if (entry->type == GST_CLOCK_ENTRY_SINGLE) {
    gst_clock_id_free (id);
  }

  return res;
}

/**
Wim Taymans's avatar
Wim Taymans committed
194 195
 * gst_clock_id_wait_async:
 * @id: a #GstClockID to wait on
196 197 198
 * @func: The callback function 
 * @user_data: User data passed in the calback
 *
Wim Taymans's avatar
Wim Taymans committed
199 200
 * Register a callback on the given clockid with the given
 * function and user_data.
201
 *
202
 * Returns: the result of the non blocking wait.
203 204 205 206 207 208 209 210 211 212
 */
GstClockReturn
gst_clock_id_wait_async (GstClockID id,
		         GstClockCallback func, gpointer user_data)
{
  GstClockEntry *entry;
  GstClock *clock;
  GstClockReturn res = GST_CLOCK_UNSUPPORTED;
  
  g_return_val_if_fail (id != NULL, GST_CLOCK_ERROR);
213
  g_return_val_if_fail (func != NULL, GST_CLOCK_ERROR);
214 215 216 217

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

218 219 220 221 222
  if (GST_CLOCK_ENTRY_TIME (entry) == GST_CLOCK_TIME_NONE) {
    (func) (clock, GST_CLOCK_TIME_NONE, id, user_data);
    return GST_CLOCK_TIMEOUT;
  }

223 224 225 226 227 228 229 230
  if (CLASS (clock)->wait_async) {
    res = CLASS (clock)->wait_async (clock, entry, func, user_data);
  }

  return res;
}

/**
Wim Taymans's avatar
Wim Taymans committed
231 232
 * gst_clock_id_unschedule:
 * @id: The id to unschedule
233 234 235 236 237 238 239 240 241 242 243 244 245
 *
 * Cancel an outstanding async notification request with the given ID.
 */
void
gst_clock_id_unschedule (GstClockID id)
{
  GstClockEntry *entry;
  GstClock *clock;
  
  g_return_if_fail (id != NULL);

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

247 248
  if (CLASS (clock)->unschedule)
    CLASS (clock)->unschedule (clock, entry);
249 250
}

251
/**
Wim Taymans's avatar
Wim Taymans committed
252
 * gst_clock_id_free:
253 254 255 256 257 258
 * @id: The clockid to free
 *
 * Free the resources held by the given id
 */
void
gst_clock_id_free (GstClockID id)
259
{
260 261
  g_return_if_fail (id != NULL);

262 263
  gst_mem_chunk_free (_gst_clock_entries_chunk, id);
}
264

265
/**
Wim Taymans's avatar
Wim Taymans committed
266
 * gst_clock_id_unlock:
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
 * @id: The clockid to unlock
 *
 * Unlock the givan ClockID.
 */
void
gst_clock_id_unlock (GstClockID id)
{
  GstClockEntry *entry;
  GstClock *clock;
  
  g_return_if_fail (id != NULL);

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

  if (CLASS (clock)->unlock)
    CLASS (clock)->unlock (clock, entry);
284 285
}

286 287 288 289

/**
 * GstClock abstract base class implementation
 */
290 291
GType
gst_clock_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
292
{
293 294 295 296
  static GType clock_type = 0;

  if (!clock_type) {
    static const GTypeInfo clock_info = {
297
      sizeof (GstClockClass),
298 299 300 301 302
      NULL,
      NULL,
      (GClassInitFunc) gst_clock_class_init,
      NULL,
      NULL,
303
      sizeof (GstClock),
304 305 306 307 308
      4,
      (GInstanceInitFunc) gst_clock_init,
      NULL
    };
    clock_type = g_type_register_static (GST_TYPE_OBJECT, "GstClock", 
309
		    			 &clock_info,  G_TYPE_FLAG_ABSTRACT);
310 311 312
  }
  return clock_type;
}
313

314 315 316 317 318
static void
gst_clock_class_init (GstClockClass *klass)
{
  GObjectClass *gobject_class;
  GstObjectClass *gstobject_class;
319

320 321
  gobject_class = (GObjectClass*) klass;
  gstobject_class = (GstObjectClass*) klass;
322

323
  parent_class = g_type_class_ref (GST_TYPE_OBJECT);
324

Wim Taymans's avatar
Wim Taymans committed
325 326 327
  if (!g_thread_supported ())
    g_thread_init (NULL);

328
  _gst_clock_entries_chunk = gst_mem_chunk_new ("GstClockEntries",
329 330
                     sizeof (GstClockEntry), sizeof (GstClockEntry) * 32,
                     G_ALLOC_AND_FREE);
331 332 333 334 335 336 337 338 339 340

  _gst_clock_mutex = g_mutex_new ();
  _gst_clock_cond  = g_cond_new ();

  gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_clock_set_property);
  gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_clock_get_property);

  g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_STATS,
    g_param_spec_boolean ("stats", "Stats", "Enable clock stats",
                          FALSE, G_PARAM_READWRITE));
Wim Taymans's avatar
Wim Taymans committed
341 342
}

343 344
static void
gst_clock_init (GstClock *clock)
Wim Taymans's avatar
Wim Taymans committed
345
{
346 347 348
  clock->speed = 1.0;
  clock->active = FALSE;
  clock->start_time = 0;
349 350
  clock->last_time = 0;
  clock->entries = NULL;
351 352
  clock->flags = 0;
  clock->stats = FALSE;
353 354 355

  clock->active_mutex = g_mutex_new ();
  clock->active_cond = g_cond_new ();
Wim Taymans's avatar
Wim Taymans committed
356 357
}

Wim Taymans's avatar
Wim Taymans committed
358 359
/**
 * gst_clock_set_speed
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
360 361
 * @clock: a #GstClock to modify
 * @speed: the speed to set on the clock
Wim Taymans's avatar
Wim Taymans committed
362
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
363
 * Sets the speed on the given clock. 1.0 is the default 
Wim Taymans's avatar
Wim Taymans committed
364
 * speed.
365 366
 *
 * Returns: the new speed of the clock.
Wim Taymans's avatar
Wim Taymans committed
367
 */
368
gdouble
Wim Taymans's avatar
Wim Taymans committed
369 370
gst_clock_set_speed (GstClock *clock, gdouble speed)
{
371 372 373 374
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0.0);

  if (CLASS (clock)->change_speed)
    clock->speed = CLASS (clock)->change_speed (clock, clock->speed, speed);
Wim Taymans's avatar
Wim Taymans committed
375

376
  return clock->speed;
Wim Taymans's avatar
Wim Taymans committed
377 378 379 380
}

/**
 * gst_clock_get_speed
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
381
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
382
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
383
 * Gets the speed of the given clock.
Wim Taymans's avatar
Wim Taymans committed
384 385 386 387 388 389 390 391 392 393 394 395
 *
 * Returns: the speed of the clock.
 */
gdouble
gst_clock_get_speed (GstClock *clock)
{
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0.0);

  return clock->speed;
}

/**
396 397 398
 * gst_clock_set_resolution
 * @clock: The clock set the resolution on
 * @resolution: The resolution to set
Wim Taymans's avatar
Wim Taymans committed
399
 *
400 401 402
 * Set the accuracy of the clock.
 *
 * Returns: the new resolution of the clock.
Wim Taymans's avatar
Wim Taymans committed
403
 */
404 405
guint64
gst_clock_set_resolution (GstClock *clock, guint64 resolution)
Wim Taymans's avatar
Wim Taymans committed
406
{
407
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0LL);
408
  g_return_val_if_fail (resolution != 0, 0LL);
409

410 411
  if (CLASS (clock)->change_resolution)
    clock->resolution = CLASS (clock)->change_resolution (clock, clock->resolution, resolution);
412

413 414
  return clock->resolution;
}
415

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
/**
 * gst_clock_get_resolution
 * @clock: The clock get the resolution of
 *
 * Get the accuracy of the clock.
 *
 * Returns: the resolution of the clock in microseconds.
 */
guint64
gst_clock_get_resolution (GstClock *clock)
{
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0LL);

  if (CLASS (clock)->get_resolution)
    return CLASS (clock)->get_resolution (clock);

  return 1LL;
Wim Taymans's avatar
Wim Taymans committed
433 434
}

Wim Taymans's avatar
Wim Taymans committed
435
/**
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
436 437 438
 * gst_clock_set_active
 * @clock: a #GstClock to set state of
 * @active: flag indicating if the clock should be activated (TRUE) or deactivated
Wim Taymans's avatar
Wim Taymans committed
439
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
440
 * Activates or deactivates the clock based on the active parameter.
Wim Taymans's avatar
Wim Taymans committed
441 442
 * As soon as the clock is activated, the time will start ticking.
 */
443
void
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
444
gst_clock_set_active (GstClock *clock, gboolean active)
Wim Taymans's avatar
Wim Taymans committed
445
{
446 447
  GstClockTime time = 0LL;

448 449 450
  g_return_if_fail (GST_IS_CLOCK (clock));

  clock->active = active;
451 452 453 454
	        
  if (CLASS (clock)->get_internal_time) {
    time = CLASS (clock)->get_internal_time (clock);
  }
455

456 457
  GST_LOCK (clock);
  if (active) {
458 459
    clock->start_time = time - clock->last_time;
    clock->accept_discont = TRUE;
460 461 462
  }
  else {
    clock->last_time = time - clock->start_time;
463
    clock->accept_discont = FALSE;
464 465
  }
  GST_UNLOCK (clock);
466 467

  g_mutex_lock (clock->active_mutex);	
468
  g_cond_broadcast (clock->active_cond);	
469
  g_mutex_unlock (clock->active_mutex);	
470 471
}

Wim Taymans's avatar
Wim Taymans committed
472 473
/**
 * gst_clock_is_active
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
474
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
475 476 477 478 479
 *
 * Checks if the given clock is active.
 * 
 * Returns: TRUE if the clock is active.
 */
480 481
gboolean
gst_clock_is_active (GstClock *clock)
482
{
483
  g_return_val_if_fail (GST_IS_CLOCK (clock), FALSE);
484

485
  return clock->active;
Wim Taymans's avatar
Wim Taymans committed
486 487
}

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
/**
 * gst_clock_reset
 * @clock: a #GstClock to reset
 *
 * Reset the clock to time 0.
 */
void
gst_clock_reset (GstClock *clock)
{
  GstClockTime time = 0LL;

  g_return_if_fail (GST_IS_CLOCK (clock));

  if (CLASS (clock)->get_internal_time) {
    time = CLASS (clock)->get_internal_time (clock);
  }

  GST_LOCK (clock);
  clock->active = FALSE;
  clock->start_time = time;
  clock->last_time = 0LL;
  GST_UNLOCK (clock);
}

Wim Taymans's avatar
Wim Taymans committed
512 513 514 515 516 517
/**
 * gst_clock_handle_discont
 * @clock: a #GstClock to notify of the discontinuity
 * @time: The new time
 *
 * Notifies the clock of a discontinuity in time.
518
 *
Wim Taymans's avatar
Wim Taymans committed
519 520 521 522
 * Returns: TRUE if the clock was updated. It is possible that
 * the clock was not updated by this call because only the first
 * discontinuitity in the pipeline is honoured.
 */
523 524 525 526
gboolean
gst_clock_handle_discont (GstClock *clock, guint64 time)
{
  GstClockTime itime = 0LL;
527 528 529 530

  GST_DEBUG (GST_CAT_CLOCK, "clock discont %" G_GUINT64_FORMAT
		            " %" G_GUINT64_FORMAT " %d",
			    time, clock->start_time, clock->accept_discont);
531

532 533 534
  if (time == GST_CLOCK_TIME_NONE)
    return TRUE;

535 536 537 538 539 540 541 542
  GST_LOCK (clock);
  if (clock->accept_discont) {
    if (CLASS (clock)->get_internal_time) {
      itime = CLASS (clock)->get_internal_time (clock);
    }
  }
  else {
    GST_UNLOCK (clock);
543 544 545
    GST_DEBUG (GST_CAT_CLOCK, "clock discont refused %" G_GUINT64_FORMAT
		              " %" G_GUINT64_FORMAT,
			      time, clock->start_time);
546 547 548 549 550 551 552 553
    return FALSE;
  }

  clock->start_time = itime - time;
  clock->last_time = time;
  clock->accept_discont = FALSE;
  GST_UNLOCK (clock);

554 555
  GST_DEBUG (GST_CAT_CLOCK, "new time %" G_GUINT64_FORMAT,
	     gst_clock_get_time (clock));
556

557 558 559
  g_mutex_lock (clock->active_mutex);
  g_cond_broadcast (clock->active_cond);
  g_mutex_unlock (clock->active_mutex);
560 561 562 563

  return TRUE;
}

Wim Taymans's avatar
Wim Taymans committed
564 565
/**
 * gst_clock_get_time
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
566
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
567
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
568
 * Gets the current time of the given clock. The time is always
Wim Taymans's avatar
Wim Taymans committed
569
 * monotonically increasing.
570
 *
Wim Taymans's avatar
Wim Taymans committed
571 572
 * Returns: the time of the clock.
 */
573 574 575
GstClockTime
gst_clock_get_time (GstClock *clock)
{
576 577
  GstClockTime ret = 0LL;

578 579
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0LL);

580 581 582 583 584 585 586 587 588
  if (!clock->active) {
    /* clock is not activen return previous time */
    ret = clock->last_time;
  }
  else {
    if (CLASS (clock)->get_internal_time) {
      ret = CLASS (clock)->get_internal_time (clock) - clock->start_time;
    }
    /* make sure the time is increasing, else return last_time */
589
    if ((gint64) ret < (gint64) clock->last_time) {
590 591 592 593 594 595
      ret = clock->last_time;
    }
    else {
      clock->last_time = ret;
    }
  }
596

597
  return ret;
598 599
}

Wim Taymans's avatar
Wim Taymans committed
600 601 602 603 604 605 606 607
/**
 * gst_clock_get_next_id
 * @clock: The clock to query
 *
 * Get the clockid of the next event.
 *
 * Returns: a clockid or NULL is no event is pending.
 */
608 609 610 611 612
GstClockID
gst_clock_get_next_id (GstClock *clock)
{
  GstClockEntry *entry = NULL;

613 614
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);

615 616 617 618 619 620 621 622 623
  GST_LOCK (clock);
  if (clock->entries)
    entry = GST_CLOCK_ENTRY (clock->entries->data);
  GST_UNLOCK (clock);

  return (GstClockID *) entry;
}

static void
624
gst_clock_update_stats (GstClock *clock)
625
{
626 627
}

628 629 630
static void
gst_clock_set_property (GObject *object, guint prop_id,
     		        const GValue *value, GParamSpec *pspec)
631
{
632 633 634 635 636 637 638 639 640 641 642 643
  GstClock *clock;
	     
  clock = GST_CLOCK (object);

  switch (prop_id) {
    case ARG_STATS:
      clock->stats = g_value_get_boolean (value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
   }
Wim Taymans's avatar
Wim Taymans committed
644
}
645

646 647 648
static void
gst_clock_get_property (GObject *object, guint prop_id, 
			GValue *value, GParamSpec * pspec)
649
{
650 651 652 653 654 655 656 657 658 659 660 661
  GstClock *clock;
	     
  clock = GST_CLOCK (object);

  switch (prop_id) {
    case ARG_STATS:
      g_value_set_boolean (value, clock->stats);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
   }
662
}