gst/gstsystemclock.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2004 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gstsystemclock.c: Default clock, uses the system clock
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstsystemclock
  25  * @short_description: Default clock that uses the current system time
  26  * @see_also: #GstClock
  27  *
  28  * The GStreamer core provides a GstSystemClock based on the system time.
  29  * Asynchronous callbacks are scheduled from an internal thread.
  30  *
  31  * Clock implementors are encouraged to subclass this systemclock as it
  32  * implements the async notification.
  33  *
  34  * Subclasses can however override all of the important methods for sync and
  35  * async notifications to implement their own callback methods or blocking
  36  * wait operations.
  37  *
  38  * Last reviewed on 2006-03-08 (0.10.4)
  39  */
  40
  41 #include "gst_private.h"
  42 #include "gstinfo.h"
  43 #include "gstsystemclock.h"
  44 #include "gstenumtypes.h"
  45 #include "gstpoll.h"
  46 #include "gstutils.h"
  47 #include "glib-compat-private.h"
  48
  49 #include <errno.h>
  50
  51 #ifdef G_OS_WIN32
  52 #  define WIN32_LEAN_AND_MEAN   /* prevents from including too many things */
  53 #  include <windows.h>          /* QueryPerformance* stuff */
  54 #  undef WIN32_LEAN_AND_MEAN
  55 #  define EWOULDBLOCK EAGAIN    /* This is just to placate gcc */
  56 #endif /* G_OS_WIN32 */
  57
  58 #define GET_ENTRY_STATUS(e)          (g_atomic_int_get(&GST_CLOCK_ENTRY_STATUS(e)))
  59 #define SET_ENTRY_STATUS(e,val)      (g_atomic_int_set(&GST_CLOCK_ENTRY_STATUS(e),(val)))
  60 #define CAS_ENTRY_STATUS(e,old,val)  (G_ATOMIC_INT_COMPARE_AND_EXCHANGE(\
  61                                        (&GST_CLOCK_ENTRY_STATUS(e)), (old), (val)))
  62
  63 /* Define this to get some extra debug about jitter from each clock_wait */
  64 #undef WAIT_DEBUGGING
  65
  66 struct _GstSystemClockPrivate
  67 {
  68   GstClockType clock_type;
  69   GstPoll *timer;
  70   gint wakeup_count;            /* the number of entries with a pending wakeup */
  71   gboolean async_wakeup;        /* if the wakeup was because of a async list change */
  72
  73 #ifdef G_OS_WIN32
  74   LARGE_INTEGER start;
  75   LARGE_INTEGER frequency;
  76 #endif                          /* G_OS_WIN32 */
  77 };
  78
  79 #define GST_SYSTEM_CLOCK_GET_PRIVATE(obj)  \
  80    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_SYSTEM_CLOCK, \
  81         GstSystemClockPrivate))
  82
  83 #ifdef HAVE_POSIX_TIMERS
  84 # ifdef HAVE_MONOTONIC_CLOCK
  85 #  define DEFAULT_CLOCK_TYPE GST_CLOCK_TYPE_MONOTONIC
  86 # else
  87 #  define DEFAULT_CLOCK_TYPE GST_CLOCK_TYPE_REALTIME
  88 # endif
  89 #else
  90 #define DEFAULT_CLOCK_TYPE GST_CLOCK_TYPE_REALTIME
  91 #endif
  92
  93 enum
  94 {
  95   PROP_0,
  96   PROP_CLOCK_TYPE,
  97   /* FILL ME */
  98 };
  99
 100 /* the one instance of the systemclock */
 101 static GstClock *_the_system_clock = NULL;
 102
 103 static void gst_system_clock_dispose (GObject * object);
 104 static void gst_system_clock_set_property (GObject * object, guint prop_id,
 105     const GValue * value, GParamSpec * pspec);
 106 static void gst_system_clock_get_property (GObject * object, guint prop_id,
 107     GValue * value, GParamSpec * pspec);
 108
 109 static GstClockTime gst_system_clock_get_internal_time (GstClock * clock);
 110 static guint64 gst_system_clock_get_resolution (GstClock * clock);
 111 static GstClockReturn gst_system_clock_id_wait_jitter (GstClock * clock,
 112     GstClockEntry * entry, GstClockTimeDiff * jitter);
 113 static GstClockReturn gst_system_clock_id_wait_jitter_unlocked
 114     (GstClock * clock, GstClockEntry * entry, GstClockTimeDiff * jitter,
 115     gboolean restart);
 116 static GstClockReturn gst_system_clock_id_wait_async (GstClock * clock,
 117     GstClockEntry * entry);
 118 static void gst_system_clock_id_unschedule (GstClock * clock,
 119     GstClockEntry * entry);
 120 static void gst_system_clock_async_thread (GstClock * clock);
 121 static gboolean gst_system_clock_start_async (GstSystemClock * clock);
 122 static void gst_system_clock_add_wakeup (GstSystemClock * sysclock);
 123
 124 static GStaticMutex _gst_sysclock_mutex = G_STATIC_MUTEX_INIT;
 125
 126 static GstClockClass *parent_class = NULL;
 127
 128 /* static guint gst_system_clock_signals[LAST_SIGNAL] = { 0 }; */
 129
 130 G_DEFINE_TYPE (GstSystemClock, gst_system_clock, GST_TYPE_CLOCK);
 131
 132 static void
 133 gst_system_clock_class_init (GstSystemClockClass * klass)
 134 {
 135   GObjectClass *gobject_class;
 136   GstClockClass *gstclock_class;
 137
 138   gobject_class = (GObjectClass *) klass;
 139   gstclock_class = (GstClockClass *) klass;
 140
 141   parent_class = g_type_class_peek_parent (klass);
 142
 143   g_type_class_add_private (klass, sizeof (GstSystemClockPrivate));
 144
 145   gobject_class->dispose = gst_system_clock_dispose;
 146   gobject_class->set_property = gst_system_clock_set_property;
 147   gobject_class->get_property = gst_system_clock_get_property;
 148
 149   g_object_class_install_property (gobject_class, PROP_CLOCK_TYPE,
 150       g_param_spec_enum ("clock-type", "Clock type",
 151           "The type of underlying clock implementation used",
 152           GST_TYPE_CLOCK_TYPE, DEFAULT_CLOCK_TYPE,
 153           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 154
 155   gstclock_class->get_internal_time = gst_system_clock_get_internal_time;
 156   gstclock_class->get_resolution = gst_system_clock_get_resolution;
 157   gstclock_class->wait_jitter = gst_system_clock_id_wait_jitter;
 158   gstclock_class->wait_async = gst_system_clock_id_wait_async;
 159   gstclock_class->unschedule = gst_system_clock_id_unschedule;
 160 }
 161
 162 static void
 163 gst_system_clock_init (GstSystemClock * clock)
 164 {
 165   GST_OBJECT_FLAG_SET (clock,
 166       GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC |
 167       GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC |
 168       GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC |
 169       GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC);
 170
 171   clock->priv = GST_SYSTEM_CLOCK_GET_PRIVATE (clock);
 172
 173   clock->priv->clock_type = DEFAULT_CLOCK_TYPE;
 174   clock->priv->timer = gst_poll_new_timer ();
 175
 176 #ifdef G_OS_WIN32
 177   QueryPerformanceFrequency (&clock->priv->frequency);
 178   /* can be 0 if the hardware does not have hardware support */
 179   if (clock->priv->frequency.QuadPart != 0)
 180     /* we take a base time so that time starts from 0 to ease debugging */
 181     QueryPerformanceCounter (&clock->priv->start);
 182 #endif /* G_OS_WIN32 */
 183
 184 #if 0
 185   /* Uncomment this to start the async clock thread straight away */
 186   GST_OBJECT_LOCK (clock);
 187   gst_system_clock_start_async (clock);
 188   GST_OBJECT_UNLOCK (clock);
 189 #endif
 190 }
 191
 192 static void
 193 gst_system_clock_dispose (GObject * object)
 194 {
 195   GstClock *clock = (GstClock *) object;
 196   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 197   GList *entries;
 198
 199   /* else we have to stop the thread */
 200   GST_OBJECT_LOCK (clock);
 201   sysclock->stopping = TRUE;
 202   /* unschedule all entries */
 203   for (entries = clock->entries; entries; entries = g_list_next (entries)) {
 204     GstClockEntry *entry = (GstClockEntry *) entries->data;
 205
 206     GST_CAT_DEBUG (GST_CAT_CLOCK, "unscheduling entry %p", entry);
 207     SET_ENTRY_STATUS (entry, GST_CLOCK_UNSCHEDULED);
 208   }
 209   GST_CLOCK_BROADCAST (clock);
 210   gst_system_clock_add_wakeup (sysclock);
 211   GST_OBJECT_UNLOCK (clock);
 212
 213   if (sysclock->thread)
 214     g_thread_join (sysclock->thread);
 215   sysclock->thread = NULL;
 216   GST_CAT_DEBUG (GST_CAT_CLOCK, "joined thread");
 217
 218   g_list_foreach (clock->entries, (GFunc) gst_clock_id_unref, NULL);
 219   g_list_free (clock->entries);
 220   clock->entries = NULL;
 221
 222   gst_poll_free (sysclock->priv->timer);
 223
 224   G_OBJECT_CLASS (parent_class)->dispose (object);
 225
 226   if (_the_system_clock == clock) {
 227     _the_system_clock = NULL;
 228     GST_CAT_DEBUG (GST_CAT_CLOCK, "disposed system clock");
 229   }
 230 }
 231
 232 static void
 233 gst_system_clock_set_property (GObject * object, guint prop_id,
 234     const GValue * value, GParamSpec * pspec)
 235 {
 236   GstSystemClock *sysclock = GST_SYSTEM_CLOCK (object);
 237
 238   switch (prop_id) {
 239     case PROP_CLOCK_TYPE:
 240       sysclock->priv->clock_type = g_value_get_enum (value);
 241       GST_CAT_DEBUG (GST_CAT_CLOCK, "clock-type set to %d",
 242           sysclock->priv->clock_type);
 243       break;
 244     default:
 245       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 246       break;
 247   }
 248 }
 249
 250 static void
 251 gst_system_clock_get_property (GObject * object, guint prop_id, GValue * value,
 252     GParamSpec * pspec)
 253 {
 254   GstSystemClock *sysclock = GST_SYSTEM_CLOCK (object);
 255
 256   switch (prop_id) {
 257     case PROP_CLOCK_TYPE:
 258       g_value_set_enum (value, sysclock->priv->clock_type);
 259       break;
 260     default:
 261       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 262       break;
 263   }
 264 }
 265
 266 /**
 267  * gst_system_clock_obtain:
 268  *
 269  * Get a handle to the default system clock. The refcount of the
 270  * clock will be increased so you need to unref the clock after
 271  * usage.
 272  *
 273  * Returns: (transfer full): the default clock.
 274  *
 275  * MT safe.
 276  */
 277 GstClock *
 278 gst_system_clock_obtain (void)
 279 {
 280   GstClock *clock;
 281
 282   g_static_mutex_lock (&_gst_sysclock_mutex);
 283   clock = _the_system_clock;
 284
 285   if (clock == NULL) {
 286     GST_CAT_DEBUG (GST_CAT_CLOCK, "creating new static system clock");
 287     clock = g_object_new (GST_TYPE_SYSTEM_CLOCK,
 288         "name", "GstSystemClock", NULL);
 289
 290     /* we created the global clock; take ownership so
 291      * we can hand out instances later */
 292     gst_object_ref_sink (clock);
 293
 294     _the_system_clock = clock;
 295     g_static_mutex_unlock (&_gst_sysclock_mutex);
 296   } else {
 297     g_static_mutex_unlock (&_gst_sysclock_mutex);
 298     GST_CAT_DEBUG (GST_CAT_CLOCK, "returning static system clock");
 299   }
 300
 301   /* we ref it since we are a clock factory. */
 302   gst_object_ref (clock);
 303   return clock;
 304 }
 305
 306 static void
 307 gst_system_clock_remove_wakeup (GstSystemClock * sysclock)
 308 {
 309   g_return_if_fail (sysclock->priv->wakeup_count > 0);
 310
 311   sysclock->priv->wakeup_count--;
 312   if (sysclock->priv->wakeup_count == 0) {
 313     /* read the control socket byte when we removed the last wakeup count */
 314     GST_CAT_DEBUG (GST_CAT_CLOCK, "reading control");
 315     while (!gst_poll_read_control (sysclock->priv->timer)) {
 316       g_warning ("gstsystemclock: read control failed, trying again\n");
 317     }
 318     GST_CLOCK_BROADCAST (sysclock);
 319   }
 320   GST_CAT_DEBUG (GST_CAT_CLOCK, "wakeup count %d",
 321       sysclock->priv->wakeup_count);
 322 }
 323
 324 static void
 325 gst_system_clock_add_wakeup (GstSystemClock * sysclock)
 326 {
 327   /* only write the control socket for the first wakeup */
 328   if (sysclock->priv->wakeup_count == 0) {
 329     GST_CAT_DEBUG (GST_CAT_CLOCK, "writing control");
 330     while (!gst_poll_write_control (sysclock->priv->timer)) {
 331       g_warning
 332           ("gstsystemclock: write control failed in wakeup_async, trying again : %d:%s\n",
 333           errno, g_strerror (errno));
 334     }
 335   }
 336   sysclock->priv->wakeup_count++;
 337   GST_CAT_DEBUG (GST_CAT_CLOCK, "wakeup count %d",
 338       sysclock->priv->wakeup_count);
 339 }
 340
 341 static void
 342 gst_system_clock_wait_wakeup (GstSystemClock * sysclock)
 343 {
 344   while (sysclock->priv->wakeup_count > 0) {
 345     GST_CLOCK_WAIT (sysclock);
 346   }
 347 }
 348
 349 /* this thread reads the sorted clock entries from the queue.
 350  *
 351  * It waits on each of them and fires the callback when the timeout occurs.
 352  *
 353  * When an entry in the queue was canceled before we wait for it, it is
 354  * simply skipped.
 355  *
 356  * When waiting for an entry, it can become canceled, in that case we don't
 357  * call the callback but move to the next item in the queue.
 358  *
 359  * MT safe.
 360  */
 361 static void
 362 gst_system_clock_async_thread (GstClock * clock)
 363 {
 364   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 365
 366   GST_CAT_DEBUG (GST_CAT_CLOCK, "enter system clock thread");
 367   GST_OBJECT_LOCK (clock);
 368   /* signal spinup */
 369   GST_CLOCK_BROADCAST (clock);
 370   /* now enter our (almost) infinite loop */
 371   while (!sysclock->stopping) {
 372     GstClockEntry *entry;
 373     GstClockTime requested;
 374     GstClockReturn res;
 375
 376     /* check if something to be done */
 377     while (clock->entries == NULL) {
 378       GST_CAT_DEBUG (GST_CAT_CLOCK, "no clock entries, waiting..");
 379       /* wait for work to do */
 380       GST_CLOCK_WAIT (clock);
 381       GST_CAT_DEBUG (GST_CAT_CLOCK, "got signal");
 382       /* clock was stopping, exit */
 383       if (sysclock->stopping)
 384         goto exit;
 385     }
 386
 387     /* see if we have a pending wakeup because the order of the list
 388      * changed. */
 389     if (sysclock->priv->async_wakeup) {
 390       GST_CAT_DEBUG (GST_CAT_CLOCK, "clear async wakeup");
 391       gst_system_clock_remove_wakeup (sysclock);
 392       sysclock->priv->async_wakeup = FALSE;
 393     }
 394
 395     /* pick the next entry */
 396     entry = clock->entries->data;
 397     GST_OBJECT_UNLOCK (clock);
 398
 399     requested = entry->time;
 400
 401     /* now wait for the entry, we already hold the lock */
 402     res =
 403         gst_system_clock_id_wait_jitter_unlocked (clock, (GstClockID) entry,
 404         NULL, FALSE);
 405
 406     GST_OBJECT_LOCK (clock);
 407
 408     switch (res) {
 409       case GST_CLOCK_UNSCHEDULED:
 410         /* entry was unscheduled, move to the next */
 411         GST_CAT_DEBUG (GST_CAT_CLOCK, "async entry %p unscheduled", entry);
 412         goto next_entry;
 413       case GST_CLOCK_OK:
 414       case GST_CLOCK_EARLY:
 415       {
 416         /* entry timed out normally, fire the callback and move to the next
 417          * entry */
 418         GST_CAT_DEBUG (GST_CAT_CLOCK, "async entry %p timed out", entry);
 419         if (entry->func) {
 420           /* unlock before firing the callback */
 421           GST_OBJECT_UNLOCK (clock);
 422           entry->func (clock, entry->time, (GstClockID) entry,
 423               entry->user_data);
 424           GST_OBJECT_LOCK (clock);
 425         }
 426         if (entry->type == GST_CLOCK_ENTRY_PERIODIC) {
 427           GST_CAT_DEBUG (GST_CAT_CLOCK, "updating periodic entry %p", entry);
 428           /* adjust time now */
 429           entry->time = requested + entry->interval;
 430           /* and resort the list now */
 431           clock->entries =
 432               g_list_sort (clock->entries, gst_clock_id_compare_func);
 433           /* and restart */
 434           continue;
 435         } else {
 436           GST_CAT_DEBUG (GST_CAT_CLOCK, "moving to next entry");
 437           goto next_entry;
 438         }
 439       }
 440       case GST_CLOCK_BUSY:
 441         /* somebody unlocked the entry but is was not canceled, This means that
 442          * either a new entry was added in front of the queue or some other entry
 443          * was canceled. Whatever it is, pick the head entry of the list and
 444          * continue waiting. */
 445         GST_CAT_DEBUG (GST_CAT_CLOCK, "async entry %p needs restart", entry);
 446
 447         /* we set the entry back to the OK state. This is needed so that the
 448          * _unschedule() code can see if an entry is currently being waited
 449          * on (when its state is BUSY). */
 450         SET_ENTRY_STATUS (entry, GST_CLOCK_OK);
 451         continue;
 452       default:
 453         GST_CAT_DEBUG (GST_CAT_CLOCK,
 454             "strange result %d waiting for %p, skipping", res, entry);
 455         g_warning ("%s: strange result %d waiting for %p, skipping",
 456             GST_OBJECT_NAME (clock), res, entry);
 457         goto next_entry;
 458     }
 459   next_entry:
 460     /* we remove the current entry and unref it */
 461     clock->entries = g_list_remove (clock->entries, entry);
 462     gst_clock_id_unref ((GstClockID) entry);
 463   }
 464 exit:
 465   /* signal exit */
 466   GST_CLOCK_BROADCAST (clock);
 467   GST_OBJECT_UNLOCK (clock);
 468   GST_CAT_DEBUG (GST_CAT_CLOCK, "exit system clock thread");
 469 }
 470
 471 #ifdef HAVE_POSIX_TIMERS
 472 static inline clockid_t
 473 clock_type_to_posix_id (GstClockType clock_type)
 474 {
 475 #ifdef HAVE_MONOTONIC_CLOCK
 476   if (clock_type == GST_CLOCK_TYPE_MONOTONIC)
 477     return CLOCK_MONOTONIC;
 478   else
 479 #endif
 480     return CLOCK_REALTIME;
 481 }
 482 #endif
 483
 484 /* MT safe */
 485 static GstClockTime
 486 gst_system_clock_get_internal_time (GstClock * clock)
 487 {
 488 #ifdef G_OS_WIN32
 489   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 490
 491   if (sysclock->priv->frequency.QuadPart != 0) {
 492     LARGE_INTEGER now;
 493
 494     /* we prefer the highly accurate performance counters on windows */
 495     QueryPerformanceCounter (&now);
 496
 497     return gst_util_uint64_scale (now.QuadPart - sysclock->priv->start.QuadPart,
 498         GST_SECOND, sysclock->priv->frequency.QuadPart);
 499   } else
 500 #endif /* G_OS_WIN32 */
 501 #if !defined HAVE_POSIX_TIMERS
 502   {
 503     GTimeVal timeval;
 504
 505     g_get_current_time (&timeval);
 506
 507     return GST_TIMEVAL_TO_TIME (timeval);
 508   }
 509 #else
 510   {
 511     GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 512     clockid_t ptype;
 513     struct timespec ts;
 514
 515     ptype = clock_type_to_posix_id (sysclock->priv->clock_type);
 516
 517     if (G_UNLIKELY (clock_gettime (ptype, &ts)))
 518       return GST_CLOCK_TIME_NONE;
 519
 520     return GST_TIMESPEC_TO_TIME (ts);
 521   }
 522 #endif
 523 }
 524
 525 static guint64
 526 gst_system_clock_get_resolution (GstClock * clock)
 527 {
 528 #ifdef G_OS_WIN32
 529   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 530
 531   if (sysclock->priv->frequency.QuadPart != 0) {
 532     return GST_SECOND / sysclock->priv->frequency.QuadPart;
 533   } else
 534 #endif /* G_OS_WIN32 */
 535 #ifdef HAVE_POSIX_TIMERS
 536   {
 537     GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 538     clockid_t ptype;
 539     struct timespec ts;
 540
 541     ptype = clock_type_to_posix_id (sysclock->priv->clock_type);
 542
 543     if (G_UNLIKELY (clock_getres (ptype, &ts)))
 544       return GST_CLOCK_TIME_NONE;
 545
 546     return GST_TIMESPEC_TO_TIME (ts);
 547   }
 548 #else
 549   {
 550     return 1 * GST_USECOND;
 551   }
 552 #endif
 553 }
 554
 555 /* synchronously wait on the given GstClockEntry.
 556  *
 557  * We do this by blocking on the global GstPoll timer with
 558  * the requested timeout. This allows us to unblock the
 559  * entry by writing on the control fd.
 560  *
 561  * Note that writing the global GstPoll unlocks all waiting entries. So
 562  * we need to check if an unlocked entry has changed when it unlocks.
 563  *
 564  * Entries that arrive too late are simply not waited on and a
 565  * GST_CLOCK_EARLY result is returned.
 566  *
 567  * MT safe.
 568  */
 569 static GstClockReturn
 570 gst_system_clock_id_wait_jitter_unlocked (GstClock * clock,
 571     GstClockEntry * entry, GstClockTimeDiff * jitter, gboolean restart)
 572 {
 573   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 574   GstClockTime entryt, now;
 575   GstClockTimeDiff diff;
 576   GstClockReturn status;
 577
 578   if (G_UNLIKELY (GET_ENTRY_STATUS (entry) == GST_CLOCK_UNSCHEDULED))
 579     return GST_CLOCK_UNSCHEDULED;
 580
 581   /* need to call the overridden method because we want to sync against the time
 582    * of the clock, whatever the subclass uses as a clock. */
 583   now = gst_clock_get_time (clock);
 584
 585   /* get the time of the entry */
 586   entryt = GST_CLOCK_ENTRY_TIME (entry);
 587
 588   /* the diff of the entry with the clock is the amount of time we have to
 589    * wait */
 590   diff = GST_CLOCK_DIFF (now, entryt);
 591   if (G_LIKELY (jitter))
 592     *jitter = -diff;
 593
 594   GST_CAT_DEBUG (GST_CAT_CLOCK, "entry %p"
 595       " time %" GST_TIME_FORMAT
 596       " now %" GST_TIME_FORMAT
 597       " diff (time-now) %" G_GINT64_FORMAT,
 598       entry, GST_TIME_ARGS (entryt), GST_TIME_ARGS (now), diff);
 599
 600   if (G_LIKELY (diff > 0)) {
 601 #ifdef WAIT_DEBUGGING
 602     GstClockTime final;
 603 #endif
 604
 605     while (TRUE) {
 606       gint pollret;
 607
 608       do {
 609         status = GET_ENTRY_STATUS (entry);
 610
 611         /* stop when we are unscheduled */
 612         if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED))
 613           goto done;
 614
 615         /* mark the entry as busy but watch out for intermediate unscheduled
 616          * statuses */
 617       } while (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status, GST_CLOCK_BUSY)));
 618
 619       /* now wait on the entry, it either times out or the fd is written. The
 620        * status of the entry is only BUSY around the poll. */
 621       pollret = gst_poll_wait (sysclock->priv->timer, diff);
 622
 623       /* get the new status, mark as DONE. We do this so that the unschedule
 624        * function knows when we left the poll and doesn't need to wakeup the
 625        * poll anymore. */
 626       do {
 627         status = GET_ENTRY_STATUS (entry);
 628         /* we were unscheduled, exit immediately */
 629         if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED))
 630           break;
 631       } while (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status, GST_CLOCK_DONE)));
 632
 633       GST_CAT_DEBUG (GST_CAT_CLOCK, "entry %p unlocked, status %d, ret %d",
 634           entry, status, pollret);
 635
 636       if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
 637         /* try to clean up The unschedule function managed to set the status to
 638          * unscheduled. We now take the lock and mark the entry as unscheduled.
 639          * This makes sure that the unschedule function doesn't perform a
 640          * wakeup anymore. If the unschedule function has a change to perform
 641          * the wakeup before us, we clean up here */
 642         GST_OBJECT_LOCK (sysclock);
 643         entry->unscheduled = TRUE;
 644         if (entry->woken_up) {
 645           gst_system_clock_remove_wakeup (sysclock);
 646         }
 647         GST_OBJECT_UNLOCK (sysclock);
 648         goto done;
 649       } else {
 650         if (G_UNLIKELY (pollret != 0)) {
 651           /* some other id got unlocked */
 652           if (!restart) {
 653             /* this can happen if the entry got unlocked because of an async
 654              * entry was added to the head of the async queue. */
 655             GST_CAT_DEBUG (GST_CAT_CLOCK, "wakeup waiting for entry %p", entry);
 656             goto done;
 657           }
 658
 659           /* wait till all the entries got woken up */
 660           GST_OBJECT_LOCK (sysclock);
 661           gst_system_clock_wait_wakeup (sysclock);
 662           GST_OBJECT_UNLOCK (sysclock);
 663
 664           GST_CAT_DEBUG (GST_CAT_CLOCK, "entry %p needs to be restarted",
 665               entry);
 666         } else {
 667           GST_CAT_DEBUG (GST_CAT_CLOCK, "entry %p unlocked after timeout",
 668               entry);
 669         }
 670
 671         /* reschedule if gst_poll_wait returned early or we have to reschedule after
 672          * an unlock*/
 673         now = gst_clock_get_time (clock);
 674         diff = GST_CLOCK_DIFF (now, entryt);
 675
 676         if (diff <= 0) {
 677           /* timeout, this is fine, we can report success now */
 678           status = GST_CLOCK_OK;
 679           SET_ENTRY_STATUS (entry, status);
 680
 681           GST_CAT_DEBUG (GST_CAT_CLOCK,
 682               "entry %p finished, diff %" G_GINT64_FORMAT, entry, diff);
 683
 684 #ifdef WAIT_DEBUGGING
 685           final = gst_system_clock_get_internal_time (clock);
 686           GST_CAT_DEBUG (GST_CAT_CLOCK, "Waited for %" G_GINT64_FORMAT
 687               " got %" G_GINT64_FORMAT " diff %" G_GINT64_FORMAT
 688               " %g target-offset %" G_GINT64_FORMAT " %g", entryt, now,
 689               now - entryt,
 690               (double) (GstClockTimeDiff) (now - entryt) / GST_SECOND,
 691               (final - target),
 692               ((double) (GstClockTimeDiff) (final - target)) / GST_SECOND);
 693 #endif
 694           goto done;
 695         } else {
 696           GST_CAT_DEBUG (GST_CAT_CLOCK,
 697               "entry %p restart, diff %" G_GINT64_FORMAT, entry, diff);
 698         }
 699       }
 700     }
 701   } else {
 702     /* we are right on time or too late */
 703     if (G_UNLIKELY (diff == 0))
 704       status = GST_CLOCK_OK;
 705     else
 706       status = GST_CLOCK_EARLY;
 707
 708     SET_ENTRY_STATUS (entry, status);
 709   }
 710 done:
 711   return status;
 712 }
 713
 714 static GstClockReturn
 715 gst_system_clock_id_wait_jitter (GstClock * clock, GstClockEntry * entry,
 716     GstClockTimeDiff * jitter)
 717 {
 718   return gst_system_clock_id_wait_jitter_unlocked (clock, entry, jitter, TRUE);
 719 }
 720
 721 /* Start the async clock thread. Must be called with the object lock
 722  * held */
 723 static gboolean
 724 gst_system_clock_start_async (GstSystemClock * clock)
 725 {
 726   GError *error = NULL;
 727
 728   if (G_LIKELY (clock->thread != NULL))
 729     return TRUE;                /* Thread already running. Nothing to do */
 730
 731   clock->thread = g_thread_create ((GThreadFunc) gst_system_clock_async_thread,
 732       clock, TRUE, &error);
 733   if (G_UNLIKELY (error))
 734     goto no_thread;
 735
 736   /* wait for it to spin up */
 737   GST_CLOCK_WAIT (clock);
 738
 739   return TRUE;
 740
 741   /* ERRORS */
 742 no_thread:
 743   {
 744     g_warning ("could not create async clock thread: %s", error->message);
 745     g_error_free (error);
 746   }
 747   return FALSE;
 748 }
 749
 750 /* Add an entry to the list of pending async waits. The entry is inserted
 751  * in sorted order. If we inserted the entry at the head of the list, we
 752  * need to signal the thread as it might either be waiting on it or waiting
 753  * for a new entry.
 754  *
 755  * MT safe.
 756  */
 757 static GstClockReturn
 758 gst_system_clock_id_wait_async (GstClock * clock, GstClockEntry * entry)
 759 {
 760   GstSystemClock *sysclock;
 761   GstClockEntry *head;
 762
 763   sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 764
 765   GST_CAT_DEBUG (GST_CAT_CLOCK, "adding async entry %p", entry);
 766
 767   GST_OBJECT_LOCK (clock);
 768   /* Start the clock async thread if needed */
 769   if (G_UNLIKELY (!gst_system_clock_start_async (sysclock)))
 770     goto thread_error;
 771
 772   if (G_UNLIKELY (GET_ENTRY_STATUS (entry) == GST_CLOCK_UNSCHEDULED))
 773     goto was_unscheduled;
 774
 775   if (clock->entries)
 776     head = clock->entries->data;
 777   else
 778     head = NULL;
 779
 780   /* need to take a ref */
 781   gst_clock_id_ref ((GstClockID) entry);
 782   /* insert the entry in sorted order */
 783   clock->entries = g_list_insert_sorted (clock->entries, entry,
 784       gst_clock_id_compare_func);
 785
 786   /* only need to send the signal if the entry was added to the
 787    * front, else the thread is just waiting for another entry and
 788    * will get to this entry automatically. */
 789   if (clock->entries->data == entry) {
 790     GST_CAT_DEBUG (GST_CAT_CLOCK, "async entry added to head %p", head);
 791     if (head == NULL) {
 792       /* the list was empty before, signal the cond so that the async thread can
 793        * start taking a look at the queue */
 794       GST_CAT_DEBUG (GST_CAT_CLOCK, "first entry, sending signal");
 795       GST_CLOCK_BROADCAST (clock);
 796     } else {
 797       GstClockReturn status;
 798
 799       status = GET_ENTRY_STATUS (head);
 800       GST_CAT_DEBUG (GST_CAT_CLOCK, "head entry %p status %d", head, status);
 801
 802       if (status == GST_CLOCK_BUSY) {
 803         GST_CAT_DEBUG (GST_CAT_CLOCK, "head entry is busy");
 804         /* the async thread was waiting for an entry, unlock the wait so that it
 805          * looks at the new head entry instead, we only need to do this once */
 806         if (!sysclock->priv->async_wakeup) {
 807           GST_CAT_DEBUG (GST_CAT_CLOCK, "wakeup async thread");
 808           sysclock->priv->async_wakeup = TRUE;
 809           gst_system_clock_add_wakeup (sysclock);
 810         }
 811       }
 812     }
 813   }
 814   GST_OBJECT_UNLOCK (clock);
 815
 816   return GST_CLOCK_OK;
 817
 818   /* ERRORS */
 819 thread_error:
 820   {
 821     /* Could not start the async clock thread */
 822     GST_OBJECT_UNLOCK (clock);
 823     return GST_CLOCK_ERROR;
 824   }
 825 was_unscheduled:
 826   {
 827     GST_OBJECT_UNLOCK (clock);
 828     return GST_CLOCK_UNSCHEDULED;
 829   }
 830 }
 831
 832 /* unschedule an entry. This will set the state of the entry to GST_CLOCK_UNSCHEDULED
 833  * and will signal any thread waiting for entries to recheck their entry.
 834  * We cannot really decide if the signal is needed or not because the entry
 835  * could be waited on in async or sync mode.
 836  *
 837  * MT safe.
 838  */
 839 static void
 840 gst_system_clock_id_unschedule (GstClock * clock, GstClockEntry * entry)
 841 {
 842   GstSystemClock *sysclock;
 843   GstClockReturn status;
 844
 845   sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 846
 847   GST_CAT_DEBUG (GST_CAT_CLOCK, "unscheduling entry %p", entry);
 848
 849   GST_OBJECT_LOCK (clock);
 850   /* change the entry status to unscheduled */
 851   do {
 852     status = GET_ENTRY_STATUS (entry);
 853   } while (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status,
 854               GST_CLOCK_UNSCHEDULED)));
 855
 856   if (G_LIKELY (status == GST_CLOCK_BUSY)) {
 857     /* the entry was being busy, wake up all entries so that they recheck their
 858      * status. We cannot wake up just one entry because allocating such a
 859      * datastructure for each entry would be too heavy and unlocking an entry
 860      * is usually done when shutting down or some other exceptional case. */
 861     GST_CAT_DEBUG (GST_CAT_CLOCK, "entry was BUSY, doing wakeup");
 862     if (!entry->unscheduled && !entry->woken_up) {
 863       gst_system_clock_add_wakeup (sysclock);
 864       entry->woken_up = TRUE;
 865     }
 866   }
 867   GST_OBJECT_UNLOCK (clock);
 868 }