gstclock.c 14.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"
Wim Taymans's avatar
Wim Taymans committed
29

30
#define CLASS(clock)  GST_CLOCK_CLASS (G_OBJECT_GET_CLASS (clock))
31

32 33 34
static GMemChunk *_gst_clock_entries_chunk;
static GMutex *_gst_clock_entries_chunk_lock;
static GList *_gst_clock_entries_pool;
Wim Taymans's avatar
Wim Taymans committed
35

36 37 38
static void		gst_clock_class_init		(GstClockClass *klass);
static void		gst_clock_init			(GstClock *clock);

39

40 41 42
static GstObjectClass *parent_class = NULL;
/* static guint gst_clock_signals[LAST_SIGNAL] = { 0 }; */

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
typedef struct _GstClockEntry GstClockEntry;

static void 		gst_clock_free_entry 		(GstClock *clock, GstClockEntry *entry);

typedef enum {
  GST_ENTRY_OK,
  GST_ENTRY_RESTART,
} GstEntryStatus;

struct _GstClockEntry {
  GstClockTime 		 time;
  GstEntryStatus 	 status;
  GstClockCallback 	 func;
  gpointer		 user_data;
  GMutex 		*lock;
  GCond 		*cond;
};

#define GST_CLOCK_ENTRY(entry)          ((GstClockEntry *)(entry))
#define GST_CLOCK_ENTRY_TIME(entry)     (((GstClockEntry *)(entry))->time)
#define GST_CLOCK_ENTRY_LOCK(entry)     (g_mutex_lock ((entry)->lock))
#define GST_CLOCK_ENTRY_UNLOCK(entry)   (g_mutex_unlock ((entry)->lock))
#define GST_CLOCK_ENTRY_SIGNAL(entry)   (g_cond_signal ((entry)->cond))
#define GST_CLOCK_ENTRY_WAIT(entry)     (g_cond_wait (entry->cond, entry->lock))
#define GST_CLOCK_ENTRY_TIMED_WAIT(entry, time)         (g_cond_timed_wait (entry->cond, entry->lock, (time)))

static GstClockEntry*
gst_clock_entry_new (GstClockTime time,
		     GstClockCallback func, gpointer user_data)
{
  GstClockEntry *entry;

  g_mutex_lock (_gst_clock_entries_chunk_lock);
  if (_gst_clock_entries_pool) {
    entry = GST_CLOCK_ENTRY (_gst_clock_entries_pool->data);

    _gst_clock_entries_pool = g_list_remove (_gst_clock_entries_pool, entry);
    g_mutex_unlock (_gst_clock_entries_chunk_lock);
  }
  else {
    entry = g_mem_chunk_alloc (_gst_clock_entries_chunk);
    g_mutex_unlock (_gst_clock_entries_chunk_lock);

    entry->lock = g_mutex_new ();
    entry->cond = g_cond_new ();
  }
  entry->time = time;
  entry->func = func;
  entry->user_data = user_data;

  return entry;
}

static gint
clock_compare_func (gconstpointer a,
                    gconstpointer b)
{
  GstClockEntry *entry1 = (GstClockEntry *)a;
  GstClockEntry *entry2 = (GstClockEntry *)b;

  return (entry1->time - entry2->time);
}

106 107
GType
gst_clock_get_type (void)
Wim Taymans's avatar
Wim Taymans committed
108
{
109 110 111 112
  static GType clock_type = 0;

  if (!clock_type) {
    static const GTypeInfo clock_info = {
113
      sizeof (GstClockClass),
114 115 116 117 118
      NULL,
      NULL,
      (GClassInitFunc) gst_clock_class_init,
      NULL,
      NULL,
119
      sizeof (GstClock),
120 121 122 123 124
      4,
      (GInstanceInitFunc) gst_clock_init,
      NULL
    };
    clock_type = g_type_register_static (GST_TYPE_OBJECT, "GstClock", 
125
		    			 &clock_info,  G_TYPE_FLAG_ABSTRACT);
126 127 128
  }
  return clock_type;
}
129

130 131 132 133 134
static void
gst_clock_class_init (GstClockClass *klass)
{
  GObjectClass *gobject_class;
  GstObjectClass *gstobject_class;
135

136 137
  gobject_class = (GObjectClass*) klass;
  gstobject_class = (GstObjectClass*) klass;
138

139
  parent_class = g_type_class_ref (GST_TYPE_OBJECT);
140

Wim Taymans's avatar
Wim Taymans committed
141 142 143
  if (!g_thread_supported ())
    g_thread_init (NULL);

144 145 146 147 148
  _gst_clock_entries_chunk = g_mem_chunk_new ("GstClockEntries",
                     sizeof (GstClockEntry), sizeof (GstClockEntry) * 32,
                     G_ALLOC_AND_FREE);
  _gst_clock_entries_chunk_lock = g_mutex_new ();
  _gst_clock_entries_pool = NULL;
Wim Taymans's avatar
Wim Taymans committed
149 150
}

151 152
static void
gst_clock_init (GstClock *clock)
Wim Taymans's avatar
Wim Taymans committed
153
{
154 155 156
  clock->speed = 1.0;
  clock->active = FALSE;
  clock->start_time = 0;
157 158 159
  clock->last_time = 0;
  clock->entries = NULL;
  clock->async_supported = FALSE;
160 161 162

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

Wim Taymans's avatar
Wim Taymans committed
165 166
/**
 * gst_clock_async_supported
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
167
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
168
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
169
 * Checks if this clock can support asynchronous notification.
Wim Taymans's avatar
Wim Taymans committed
170 171 172
 *
 * Returns: TRUE if async notification is supported.
 */
173 174 175 176 177 178 179 180
gboolean
gst_clock_async_supported (GstClock *clock)
{
  g_return_val_if_fail (GST_IS_CLOCK (clock), FALSE);

  return clock->async_supported;
}

Wim Taymans's avatar
Wim Taymans committed
181 182
/**
 * gst_clock_set_speed
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
183 184
 * @clock: a #GstClock to modify
 * @speed: the speed to set on the clock
Wim Taymans's avatar
Wim Taymans committed
185
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
186
 * Sets the speed on the given clock. 1.0 is the default 
Wim Taymans's avatar
Wim Taymans committed
187 188 189 190 191 192 193 194 195 196 197 198
 * speed.
 */
void
gst_clock_set_speed (GstClock *clock, gdouble speed)
{
  g_return_if_fail (GST_IS_CLOCK (clock));

  clock->speed = speed;
}

/**
 * gst_clock_get_speed
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
199
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
200
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
201
 * Gets the speed of the given clock.
Wim Taymans's avatar
Wim Taymans committed
202 203 204 205 206 207 208 209 210 211 212
 *
 * 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;
}

213

Wim Taymans's avatar
Wim Taymans committed
214 215
/**
 * gst_clock_reset
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
216
 * @clock: a #GstClock to reset
Wim Taymans's avatar
Wim Taymans committed
217 218 219
 *
 * Reset the clock to time 0.
 */
220
void
221
gst_clock_reset (GstClock *clock)
Wim Taymans's avatar
Wim Taymans committed
222
{
223 224
  GstClockTime time = 0LL;

225 226
  g_return_if_fail (GST_IS_CLOCK (clock));

227 228 229
  if (CLASS (clock)->get_internal_time) {
    time = CLASS (clock)->get_internal_time (clock);
  }
230

231 232 233 234 235
  GST_LOCK (clock);
  clock->active = FALSE;
  clock->start_time = time;
  clock->last_time = 0LL;
  GST_UNLOCK (clock);
Wim Taymans's avatar
Wim Taymans committed
236 237
}

Wim Taymans's avatar
Wim Taymans committed
238
/**
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
239 240 241
 * 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
242
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
243
 * Activates or deactivates the clock based on the active parameter.
Wim Taymans's avatar
Wim Taymans committed
244 245
 * As soon as the clock is activated, the time will start ticking.
 */
246
void
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
247
gst_clock_set_active (GstClock *clock, gboolean active)
Wim Taymans's avatar
Wim Taymans committed
248
{
249 250
  GstClockTime time = 0LL;

251 252 253
  g_return_if_fail (GST_IS_CLOCK (clock));

  clock->active = active;
254 255 256 257
	        
  if (CLASS (clock)->get_internal_time) {
    time = CLASS (clock)->get_internal_time (clock);
  }
258

259 260 261 262 263 264 265 266
  GST_LOCK (clock);
  if (active) {
    clock->start_time = time - clock->last_time;;
  }
  else {
    clock->last_time = time - clock->start_time;
  }
  GST_UNLOCK (clock);
267 268

  g_mutex_lock (clock->active_mutex);	
269
  g_cond_broadcast (clock->active_cond);	
270
  g_mutex_unlock (clock->active_mutex);	
271 272
}

Wim Taymans's avatar
Wim Taymans committed
273 274
/**
 * gst_clock_is_active
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
275
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
276 277 278 279 280
 *
 * Checks if the given clock is active.
 * 
 * Returns: TRUE if the clock is active.
 */
281 282
gboolean
gst_clock_is_active (GstClock *clock)
283
{
284
  g_return_val_if_fail (GST_IS_CLOCK (clock), FALSE);
285

286
  return clock->active;
Wim Taymans's avatar
Wim Taymans committed
287 288
}

Wim Taymans's avatar
Wim Taymans committed
289 290
/**
 * gst_clock_get_time
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
291
 * @clock: a #GstClock to query
Wim Taymans's avatar
Wim Taymans committed
292
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
293
 * Gets the current time of the given clock. The time is always
Wim Taymans's avatar
Wim Taymans committed
294 295 296 297
 * monotonically increasing.
 * 
 * Returns: the time of the clock.
 */
298 299 300
GstClockTime
gst_clock_get_time (GstClock *clock)
{
301 302
  GstClockTime ret = 0LL;

303 304
  g_return_val_if_fail (GST_IS_CLOCK (clock), 0LL);

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
  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 */
    if (ret < clock->last_time) {
      ret = clock->last_time;
    }
    else {
      clock->last_time = ret;
    }
  }
321

322
  return ret;
323 324
}

325 326 327
static GstClockID
gst_clock_wait_async_func (GstClock *clock, GstClockTime time,
		           GstClockCallback func, gpointer user_data)
Wim Taymans's avatar
Wim Taymans committed
328
{
329 330
  GstClockEntry *entry = NULL;
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);
331 332

  if (!clock->active) {
333
    GST_DEBUG (GST_CAT_CLOCK, "blocking on clock\n");
334 335 336
    g_mutex_lock (clock->active_mutex);	
    g_cond_wait (clock->active_cond, clock->active_mutex);	
    g_mutex_unlock (clock->active_mutex);	
Wim Taymans's avatar
Wim Taymans committed
337
  }
338

339 340 341 342 343 344 345 346 347
  entry = gst_clock_entry_new (time, func, user_data);

  GST_LOCK (clock);
  clock->entries = g_list_insert_sorted (clock->entries, entry, clock_compare_func);
  GST_UNLOCK (clock);

  return entry;
}

Wim Taymans's avatar
Wim Taymans committed
348 349
/**
 * gst_clock_wait
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
350 351
 * @clock: a #GstClock to wait on
 * @time: The #GstClockTime to wait for
Wim Taymans's avatar
Wim Taymans committed
352 353 354
 *
 * Wait and block till the clock reaches the specified time.
 *
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
355
 * Returns: the #GstClockReturn result of the operation.
Wim Taymans's avatar
Wim Taymans committed
356
 */
357 358 359 360 361 362 363 364 365 366 367 368 369 370
GstClockReturn
gst_clock_wait (GstClock *clock, GstClockTime time)
{
  GstClockID id;
  GstClockReturn res;
  
  g_return_val_if_fail (GST_IS_CLOCK (clock), GST_CLOCK_STOPPED);

  id = gst_clock_wait_async_func (clock, time, NULL, NULL);
  res = gst_clock_wait_id (clock, id);

  return res;
}

Wim Taymans's avatar
Wim Taymans committed
371 372
/**
 * gst_clock_wait_async
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
373 374
 * @clock: a #GstClock to wait on
 * @time: The #GstClockTime to wait for
Wim Taymans's avatar
Wim Taymans committed
375 376 377 378 379 380 381 382 383
 * @func: The callback function 
 * @user_data: User data passed in the calback
 *
 * Register a callback on the given clock that will be triggered 
 * when the clock has reached the given time. A ClockID is returned
 * that can be used to cancel the request.
 *
 * Returns: the clock id or NULL when async notification is not supported.
 */
384 385 386 387 388 389 390 391 392 393 394 395
GstClockID
gst_clock_wait_async (GstClock *clock, GstClockTime time,
		      GstClockCallback func, gpointer user_data)
{
  g_return_val_if_fail (GST_IS_CLOCK (clock), NULL);

  if (clock->async_supported) {
    return gst_clock_wait_async_func (clock, time, func, user_data);
  }
  return NULL;
}

Wim Taymans's avatar
Wim Taymans committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
/**
 * gst_clock_cancel_wait_async
 * @clock: The clock to cancel the request on
 * @id: The id to cancel
 *
 * Cancel an outstanding async notification request with the given ID.
 */
void
gst_clock_cancel_wait_async (GstClock *clock, GstClockID id)
{
  g_warning ("not supported");
}

/**
 * gst_clock_notify_async
 * @clock: The clock to wait on
 * @interval: The interval between notifications
 * @func: The callback function 
 * @user_data: User data passed in the calback
 *
 * Register a callback on the given clock that will be periodically
 * triggered with the specified interval. A ClockID is returned
 * that can be used to cancel the request.
 *
 * Returns: the clock id or NULL when async notification is not supported.
 */
GstClockID
gst_clock_notify_async (GstClock *clock, GstClockTime interval,
		        GstClockCallback func, gpointer user_data) 
{
  g_warning ("not supported");
Benjamin Otte's avatar
Benjamin Otte committed
427
  return NULL;
Wim Taymans's avatar
Wim Taymans committed
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
}

/**
 * gst_clock_remove_notify_async
 * @clock: The clock to cancel the request on
 * @id: The id to cancel
 *
 * Cancel an outstanding async notification request with the given ID.
 */
void
gst_clock_remove_notify_async (GstClock *clock, GstClockID id)
{
  g_warning ("not supported");
}

443 444 445 446 447 448 449 450 451 452
static void
gst_clock_unlock_func (GstClock *clock, GstClockTime time, GstClockID id, gpointer user_data)
{
  GstClockEntry *entry = (GstClockEntry *) id;

  GST_CLOCK_ENTRY_LOCK (entry);
  GST_CLOCK_ENTRY_SIGNAL (entry);
  GST_CLOCK_ENTRY_UNLOCK (entry);
}

Wim Taymans's avatar
Wim Taymans committed
453 454 455 456 457 458 459 460 461
/**
 * gst_clock_wait_id
 * @clock: The clock to wait on
 * @id: The clock id to wait on
 *
 * Wait and block on the clockid obtained with gst_clock_wait_async.
 *
 * Returns: result of the operation.
 */
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
GstClockReturn
gst_clock_wait_id (GstClock *clock, GstClockID id)
{
  GstClockReturn res = GST_CLOCK_TIMEOUT;
  GstClockEntry *entry = (GstClockEntry *) id;
  GstClockTime current_real, current, target;
  GTimeVal timeval;
  
  g_return_val_if_fail (GST_IS_CLOCK (clock), GST_CLOCK_ERROR);
  g_return_val_if_fail (entry, GST_CLOCK_ERROR);

  current = gst_clock_get_time (clock);

  g_get_current_time (&timeval);
  current_real = GST_TIMEVAL_TO_TIME (timeval);

  GST_CLOCK_ENTRY_LOCK (entry);
  entry->func = gst_clock_unlock_func;
  target = GST_CLOCK_ENTRY_TIME (entry) - current + current_real;

482
  GST_DEBUG (GST_CAT_CLOCK, "%llu %llu %llu\n", target, current, current_real); 
483 484 485 486 487 488 489 490 491 492 493 494 495 496
  
  if (target > current_real) {
    timeval.tv_usec = target % 1000000;
    timeval.tv_sec = target / 1000000;

    GST_CLOCK_ENTRY_TIMED_WAIT (entry, &timeval);
  }
  GST_CLOCK_ENTRY_UNLOCK (entry);

  gst_clock_free_entry (clock, entry);

  return res;
}

Wim Taymans's avatar
Wim Taymans committed
497 498 499 500 501 502 503 504
/**
 * 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.
 */
505 506 507 508 509 510 511 512 513 514 515 516 517
GstClockID
gst_clock_get_next_id (GstClock *clock)
{
  GstClockEntry *entry = NULL;

  GST_LOCK (clock);
  if (clock->entries)
    entry = GST_CLOCK_ENTRY (clock->entries->data);
  GST_UNLOCK (clock);

  return (GstClockID *) entry;
}

Wim Taymans's avatar
Wim Taymans committed
518 519 520 521 522 523 524 525
/**
 * 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
 */
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
GstClockTime
gst_clock_id_get_time (GstClockID id)
{
  return GST_CLOCK_ENTRY_TIME (id);
}

static void
gst_clock_free_entry (GstClock *clock, GstClockEntry *entry)
{
  GST_LOCK (clock);
  clock->entries = g_list_remove (clock->entries, entry);
  GST_UNLOCK (clock);

  g_mutex_lock (_gst_clock_entries_chunk_lock);
  _gst_clock_entries_pool = g_list_prepend (_gst_clock_entries_pool, entry);
  g_mutex_unlock (_gst_clock_entries_chunk_lock);
}

Wim Taymans's avatar
Wim Taymans committed
544 545 546 547 548 549 550
/**
 * gst_clock_unlock_id
 * @clock: The clock that own the id
 * @id: The clockid to unlock
 *
 * Unlock the ClockID.
 */
551 552 553 554 555 556 557 558 559
void
gst_clock_unlock_id (GstClock *clock, GstClockID id)
{
  GstClockEntry *entry = (GstClockEntry *) id;

  if (entry->func)
    entry->func (clock, gst_clock_get_time (clock), id, entry->user_data);

  gst_clock_free_entry (clock, entry);
560 561
}

Wim Taymans's avatar
Wim Taymans committed
562 563 564 565 566 567 568
/**
 * gst_clock_set_resolution
 * @clock: The clock set the resolution on
 * @resolution: The resolution to set
 *
 * Set the accuracy of the clock.
 */
569 570 571 572 573 574 575
void
gst_clock_set_resolution (GstClock *clock, guint64 resolution)
{
  g_return_if_fail (GST_IS_CLOCK (clock));

  if (CLASS (clock)->set_resolution)
    CLASS (clock)->set_resolution (clock, resolution);
Wim Taymans's avatar
Wim Taymans committed
576
}
577

Wim Taymans's avatar
Wim Taymans committed
578 579 580 581 582 583 584 585
/**
 * 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.
 */
586 587 588 589 590 591 592 593
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);

594
  return 1LL;
595 596
}