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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, 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
  39 #include "gst_private.h"
  40 #include "gstinfo.h"
  41 #include "gstsystemclock.h"
  42 #include "gstenumtypes.h"
  43 #include "gstpoll.h"
  44 #include "gstutils.h"
  45 #include "glib-compat-private.h"
  46
  47 #include <errno.h>
  48
  49 #ifdef G_OS_WIN32
  50 #  define WIN32_LEAN_AND_MEAN   /* prevents from including too many things */
  51 #  include <windows.h>          /* QueryPerformance* stuff */
  52 #  undef WIN32_LEAN_AND_MEAN
  53 #  ifndef EWOULDBLOCK
  54 #  define EWOULDBLOCK EAGAIN    /* This is just to placate gcc */
  55 #  endif
  56 #endif /* G_OS_WIN32 */
  57
  58 #ifdef __APPLE__
  59 #include <mach/mach_time.h>
  60 #endif
  61
  62 #define GET_ENTRY_STATUS(e)          ((GstClockReturn) g_atomic_int_get(&GST_CLOCK_ENTRY_STATUS(e)))
  63 #define SET_ENTRY_STATUS(e,val)      (g_atomic_int_set(&GST_CLOCK_ENTRY_STATUS(e),(val)))
  64 #define CAS_ENTRY_STATUS(e,old,val)  (g_atomic_int_compare_and_exchange(\
  65                                        (&GST_CLOCK_ENTRY_STATUS(e)), (old), (val)))
  66
  67 /* Define this to get some extra debug about jitter from each clock_wait */
  68 #undef WAIT_DEBUGGING
  69
  70 #define GST_SYSTEM_CLOCK_GET_COND(clock)        (&GST_SYSTEM_CLOCK_CAST(clock)->priv->entries_changed)
  71 #define GST_SYSTEM_CLOCK_WAIT(clock)            g_cond_wait(GST_SYSTEM_CLOCK_GET_COND(clock),GST_OBJECT_GET_LOCK(clock))
  72 #define GST_SYSTEM_CLOCK_TIMED_WAIT(clock,tv)   g_cond_timed_wait(GST_SYSTEM_CLOCK_GET_COND(clock),GST_OBJECT_GET_LOCK(clock),tv)
  73 #define GST_SYSTEM_CLOCK_BROADCAST(clock)       g_cond_broadcast(GST_SYSTEM_CLOCK_GET_COND(clock))
  74
  75 struct _GstSystemClockPrivate
  76 {
  77   GThread *thread;              /* thread for async notify */
  78   gboolean stopping;
  79
  80   GList *entries;
  81   GCond entries_changed;
  82
  83   GstClockType clock_type;
  84   GstPoll *timer;
  85   gint wakeup_count;            /* the number of entries with a pending wakeup */
  86   gboolean async_wakeup;        /* if the wakeup was because of a async list change */
  87
  88 #ifdef G_OS_WIN32
  89   LARGE_INTEGER start;
  90   LARGE_INTEGER frequency;
  91 #endif                          /* G_OS_WIN32 */
  92 #ifdef __APPLE__
  93   struct mach_timebase_info mach_timebase;
  94 #endif
  95 };
  96
  97 #define GST_SYSTEM_CLOCK_GET_PRIVATE(obj)  \
  98    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_SYSTEM_CLOCK, \
  99         GstSystemClockPrivate))
 100
 101 #ifdef HAVE_POSIX_TIMERS
 102 # ifdef HAVE_MONOTONIC_CLOCK
 103 #  define DEFAULT_CLOCK_TYPE GST_CLOCK_TYPE_MONOTONIC
 104 # else
 105 #  define DEFAULT_CLOCK_TYPE GST_CLOCK_TYPE_REALTIME
 106 # endif
 107 #else
 108 #define DEFAULT_CLOCK_TYPE GST_CLOCK_TYPE_REALTIME
 109 #endif
 110
 111 enum
 112 {
 113   PROP_0,
 114   PROP_CLOCK_TYPE,
 115   /* FILL ME */
 116 };
 117
 118 /* the one instance of the systemclock */
 119 static GstClock *_the_system_clock = NULL;
 120 static gboolean _external_default_clock = FALSE;
 121
 122 static void gst_system_clock_dispose (GObject * object);
 123 static void gst_system_clock_set_property (GObject * object, guint prop_id,
 124     const GValue * value, GParamSpec * pspec);
 125 static void gst_system_clock_get_property (GObject * object, guint prop_id,
 126     GValue * value, GParamSpec * pspec);
 127
 128 static GstClockTime gst_system_clock_get_internal_time (GstClock * clock);
 129 static guint64 gst_system_clock_get_resolution (GstClock * clock);
 130 static GstClockReturn gst_system_clock_id_wait_jitter (GstClock * clock,
 131     GstClockEntry * entry, GstClockTimeDiff * jitter);
 132 static GstClockReturn gst_system_clock_id_wait_jitter_unlocked
 133     (GstClock * clock, GstClockEntry * entry, GstClockTimeDiff * jitter,
 134     gboolean restart);
 135 static GstClockReturn gst_system_clock_id_wait_async (GstClock * clock,
 136     GstClockEntry * entry);
 137 static void gst_system_clock_id_unschedule (GstClock * clock,
 138     GstClockEntry * entry);
 139 static void gst_system_clock_async_thread (GstClock * clock);
 140 static gboolean gst_system_clock_start_async (GstSystemClock * clock);
 141 static void gst_system_clock_add_wakeup (GstSystemClock * sysclock);
 142
 143 static GMutex _gst_sysclock_mutex;
 144
 145 /* static guint gst_system_clock_signals[LAST_SIGNAL] = { 0 }; */
 146
 147 #define gst_system_clock_parent_class parent_class
 148 G_DEFINE_TYPE (GstSystemClock, gst_system_clock, GST_TYPE_CLOCK);
 149
 150 static void
 151 gst_system_clock_class_init (GstSystemClockClass * klass)
 152 {
 153   GObjectClass *gobject_class;
 154   GstClockClass *gstclock_class;
 155
 156   gobject_class = (GObjectClass *) klass;
 157   gstclock_class = (GstClockClass *) klass;
 158
 159   g_type_class_add_private (klass, sizeof (GstSystemClockPrivate));
 160
 161   gobject_class->dispose = gst_system_clock_dispose;
 162   gobject_class->set_property = gst_system_clock_set_property;
 163   gobject_class->get_property = gst_system_clock_get_property;
 164
 165   g_object_class_install_property (gobject_class, PROP_CLOCK_TYPE,
 166       g_param_spec_enum ("clock-type", "Clock type",
 167           "The type of underlying clock implementation used",
 168           GST_TYPE_CLOCK_TYPE, DEFAULT_CLOCK_TYPE,
 169           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 170
 171   gstclock_class->get_internal_time = gst_system_clock_get_internal_time;
 172   gstclock_class->get_resolution = gst_system_clock_get_resolution;
 173   gstclock_class->wait = gst_system_clock_id_wait_jitter;
 174   gstclock_class->wait_async = gst_system_clock_id_wait_async;
 175   gstclock_class->unschedule = gst_system_clock_id_unschedule;
 176 }
 177
 178 static void
 179 gst_system_clock_init (GstSystemClock * clock)
 180 {
 181   GstSystemClockPrivate *priv;
 182
 183   GST_OBJECT_FLAG_SET (clock,
 184       GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC |
 185       GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC |
 186       GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC |
 187       GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC);
 188
 189   clock->priv = priv = GST_SYSTEM_CLOCK_GET_PRIVATE (clock);
 190
 191   priv->clock_type = DEFAULT_CLOCK_TYPE;
 192   priv->timer = gst_poll_new_timer ();
 193
 194   priv->entries = NULL;
 195   g_cond_init (&priv->entries_changed);
 196
 197 #ifdef G_OS_WIN32
 198   QueryPerformanceFrequency (&priv->frequency);
 199   /* can be 0 if the hardware does not have hardware support */
 200   if (priv->frequency.QuadPart != 0)
 201     /* we take a base time so that time starts from 0 to ease debugging */
 202     QueryPerformanceCounter (&priv->start);
 203 #endif /* G_OS_WIN32 */
 204
 205 #ifdef __APPLE__
 206   mach_timebase_info (&priv->mach_timebase);
 207 #endif
 208
 209 #if 0
 210   /* Uncomment this to start the async clock thread straight away */
 211   GST_OBJECT_LOCK (clock);
 212   gst_system_clock_start_async (clock);
 213   GST_OBJECT_UNLOCK (clock);
 214 #endif
 215 }
 216
 217 static void
 218 gst_system_clock_dispose (GObject * object)
 219 {
 220   GstClock *clock = (GstClock *) object;
 221   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 222   GstSystemClockPrivate *priv = sysclock->priv;
 223   GList *entries;
 224
 225   /* else we have to stop the thread */
 226   GST_OBJECT_LOCK (clock);
 227   priv->stopping = TRUE;
 228   /* unschedule all entries */
 229   for (entries = priv->entries; entries; entries = g_list_next (entries)) {
 230     GstClockEntry *entry = (GstClockEntry *) entries->data;
 231
 232     GST_CAT_DEBUG (GST_CAT_CLOCK, "unscheduling entry %p", entry);
 233     SET_ENTRY_STATUS (entry, GST_CLOCK_UNSCHEDULED);
 234   }
 235   GST_SYSTEM_CLOCK_BROADCAST (clock);
 236   gst_system_clock_add_wakeup (sysclock);
 237   GST_OBJECT_UNLOCK (clock);
 238
 239   if (priv->thread)
 240     g_thread_join (priv->thread);
 241   priv->thread = NULL;
 242   GST_CAT_DEBUG (GST_CAT_CLOCK, "joined thread");
 243
 244   g_list_foreach (priv->entries, (GFunc) gst_clock_id_unref, NULL);
 245   g_list_free (priv->entries);
 246   priv->entries = NULL;
 247
 248   gst_poll_free (priv->timer);
 249   g_cond_clear (&priv->entries_changed);
 250
 251   G_OBJECT_CLASS (parent_class)->dispose (object);
 252
 253   if (_the_system_clock == clock) {
 254     _the_system_clock = NULL;
 255     GST_CAT_DEBUG (GST_CAT_CLOCK, "disposed system clock");
 256   }
 257 }
 258
 259 static void
 260 gst_system_clock_set_property (GObject * object, guint prop_id,
 261     const GValue * value, GParamSpec * pspec)
 262 {
 263   GstSystemClock *sysclock = GST_SYSTEM_CLOCK (object);
 264
 265   switch (prop_id) {
 266     case PROP_CLOCK_TYPE:
 267       sysclock->priv->clock_type = (GstClockType) g_value_get_enum (value);
 268       GST_CAT_DEBUG (GST_CAT_CLOCK, "clock-type set to %d",
 269           sysclock->priv->clock_type);
 270       break;
 271     default:
 272       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 273       break;
 274   }
 275 }
 276
 277 static void
 278 gst_system_clock_get_property (GObject * object, guint prop_id, GValue * value,
 279     GParamSpec * pspec)
 280 {
 281   GstSystemClock *sysclock = GST_SYSTEM_CLOCK (object);
 282
 283   switch (prop_id) {
 284     case PROP_CLOCK_TYPE:
 285       g_value_set_enum (value, sysclock->priv->clock_type);
 286       break;
 287     default:
 288       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 289       break;
 290   }
 291 }
 292
 293 /**
 294  * gst_system_clock_set_default:
 295  * @new_clock: a #GstClock
 296  *
 297  * Sets the default system clock that can be obtained with
 298  * gst_system_clock_obtain().
 299  *
 300  * This is mostly used for testing and debugging purposes when you
 301  * want to have control over the time reported by the default system
 302  * clock.
 303  *
 304  * MT safe.
 305  *
 306  * Since: 1.4
 307  */
 308 void
 309 gst_system_clock_set_default (GstClock * new_clock)
 310 {
 311   GstClock *clock;
 312
 313   g_mutex_lock (&_gst_sysclock_mutex);
 314   clock = _the_system_clock;
 315
 316   if (clock != NULL)
 317     g_object_unref (clock);
 318
 319   if (new_clock == NULL) {
 320     GST_CAT_DEBUG (GST_CAT_CLOCK, "resetting default system clock");
 321     _external_default_clock = FALSE;
 322   } else {
 323     GST_CAT_DEBUG (GST_CAT_CLOCK, "setting new default system clock to %p",
 324         new_clock);
 325     _external_default_clock = TRUE;
 326     g_object_ref (new_clock);
 327   }
 328   _the_system_clock = new_clock;
 329   g_mutex_unlock (&_gst_sysclock_mutex);
 330 }
 331
 332 /**
 333  * gst_system_clock_obtain:
 334  *
 335  * Get a handle to the default system clock. The refcount of the
 336  * clock will be increased so you need to unref the clock after
 337  * usage.
 338  *
 339  * Returns: (transfer full): the default clock.
 340  *
 341  * MT safe.
 342  */
 343 GstClock *
 344 gst_system_clock_obtain (void)
 345 {
 346   GstClock *clock;
 347
 348   g_mutex_lock (&_gst_sysclock_mutex);
 349   clock = _the_system_clock;
 350
 351   if (clock == NULL) {
 352     GST_CAT_DEBUG (GST_CAT_CLOCK, "creating new static system clock");
 353     g_assert (!_external_default_clock);
 354     clock = g_object_new (GST_TYPE_SYSTEM_CLOCK,
 355         "name", "GstSystemClock", NULL);
 356
 357     g_assert (!g_object_is_floating (G_OBJECT (clock)));
 358
 359     _the_system_clock = clock;
 360     g_mutex_unlock (&_gst_sysclock_mutex);
 361   } else {
 362     g_mutex_unlock (&_gst_sysclock_mutex);
 363     GST_CAT_DEBUG (GST_CAT_CLOCK, "returning static system clock");
 364   }
 365
 366   /* we ref it since we are a clock factory. */
 367   gst_object_ref (clock);
 368   return clock;
 369 }
 370
 371 static void
 372 gst_system_clock_remove_wakeup (GstSystemClock * sysclock)
 373 {
 374   g_return_if_fail (sysclock->priv->wakeup_count > 0);
 375
 376   sysclock->priv->wakeup_count--;
 377   if (sysclock->priv->wakeup_count == 0) {
 378     /* read the control socket byte when we removed the last wakeup count */
 379     GST_CAT_DEBUG (GST_CAT_CLOCK, "reading control");
 380     while (!gst_poll_read_control (sysclock->priv->timer)) {
 381       g_warning ("gstsystemclock: read control failed, trying again\n");
 382     }
 383     GST_SYSTEM_CLOCK_BROADCAST (sysclock);
 384   }
 385   GST_CAT_DEBUG (GST_CAT_CLOCK, "wakeup count %d",
 386       sysclock->priv->wakeup_count);
 387 }
 388
 389 static void
 390 gst_system_clock_add_wakeup (GstSystemClock * sysclock)
 391 {
 392   /* only write the control socket for the first wakeup */
 393   if (sysclock->priv->wakeup_count == 0) {
 394     GST_CAT_DEBUG (GST_CAT_CLOCK, "writing control");
 395     while (!gst_poll_write_control (sysclock->priv->timer)) {
 396       if (errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR) {
 397         g_warning
 398             ("gstsystemclock: write control failed in wakeup_async, trying again: %d:%s\n",
 399             errno, g_strerror (errno));
 400       } else {
 401         g_critical
 402             ("gstsystemclock: write control failed in wakeup_async: %d:%s\n",
 403             errno, g_strerror (errno));
 404         return;
 405       }
 406     }
 407   }
 408   sysclock->priv->wakeup_count++;
 409   GST_CAT_DEBUG (GST_CAT_CLOCK, "wakeup count %d",
 410       sysclock->priv->wakeup_count);
 411 }
 412
 413 static void
 414 gst_system_clock_wait_wakeup (GstSystemClock * sysclock)
 415 {
 416   while (sysclock->priv->wakeup_count > 0) {
 417     GST_SYSTEM_CLOCK_WAIT (sysclock);
 418   }
 419 }
 420
 421 /* this thread reads the sorted clock entries from the queue.
 422  *
 423  * It waits on each of them and fires the callback when the timeout occurs.
 424  *
 425  * When an entry in the queue was canceled before we wait for it, it is
 426  * simply skipped.
 427  *
 428  * When waiting for an entry, it can become canceled, in that case we don't
 429  * call the callback but move to the next item in the queue.
 430  *
 431  * MT safe.
 432  */
 433 static void
 434 gst_system_clock_async_thread (GstClock * clock)
 435 {
 436   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 437   GstSystemClockPrivate *priv = sysclock->priv;
 438   GstClockReturn status;
 439
 440   GST_CAT_DEBUG (GST_CAT_CLOCK, "enter system clock thread");
 441   GST_OBJECT_LOCK (clock);
 442   /* signal spinup */
 443   GST_SYSTEM_CLOCK_BROADCAST (clock);
 444   /* now enter our (almost) infinite loop */
 445   while (!priv->stopping) {
 446     GstClockEntry *entry;
 447     GstClockTime requested;
 448     GstClockReturn res;
 449
 450     /* check if something to be done */
 451     while (priv->entries == NULL) {
 452       GST_CAT_DEBUG (GST_CAT_CLOCK, "no clock entries, waiting..");
 453       /* wait for work to do */
 454       GST_SYSTEM_CLOCK_WAIT (clock);
 455       GST_CAT_DEBUG (GST_CAT_CLOCK, "got signal");
 456       /* clock was stopping, exit */
 457       if (priv->stopping)
 458         goto exit;
 459     }
 460
 461     /* see if we have a pending wakeup because the order of the list
 462      * changed. */
 463     if (priv->async_wakeup) {
 464       GST_CAT_DEBUG (GST_CAT_CLOCK, "clear async wakeup");
 465       gst_system_clock_remove_wakeup (sysclock);
 466       priv->async_wakeup = FALSE;
 467     }
 468
 469     /* pick the next entry */
 470     entry = priv->entries->data;
 471
 472     /* set entry status to busy before we release the clock lock */
 473     do {
 474       status = GET_ENTRY_STATUS (entry);
 475
 476       /* check for unscheduled */
 477       if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
 478         /* entry was unscheduled, move to the next one */
 479         GST_CAT_DEBUG (GST_CAT_CLOCK, "async entry %p unscheduled", entry);
 480         goto next_entry;
 481       }
 482
 483       /* for periodic timers, status can be EARLY from a previous run */
 484       if (G_UNLIKELY (status != GST_CLOCK_OK && status != GST_CLOCK_EARLY))
 485         GST_CAT_ERROR (GST_CAT_CLOCK, "unexpected status %d for entry %p",
 486             status, entry);
 487
 488       /* mark the entry as busy but watch out for intermediate unscheduled
 489        * statuses */
 490     } while (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status, GST_CLOCK_BUSY)));
 491
 492     GST_OBJECT_UNLOCK (clock);
 493
 494     requested = entry->time;
 495
 496     /* now wait for the entry */
 497     res =
 498         gst_system_clock_id_wait_jitter_unlocked (clock, (GstClockID) entry,
 499         NULL, FALSE);
 500
 501     GST_OBJECT_LOCK (clock);
 502
 503     switch (res) {
 504       case GST_CLOCK_UNSCHEDULED:
 505         /* entry was unscheduled, move to the next */
 506         GST_CAT_DEBUG (GST_CAT_CLOCK, "async entry %p unscheduled", entry);
 507         goto next_entry;
 508       case GST_CLOCK_OK:
 509       case GST_CLOCK_EARLY:
 510       {
 511         /* entry timed out normally, fire the callback and move to the next
 512          * entry */
 513         GST_CAT_DEBUG (GST_CAT_CLOCK, "async entry %p timed out", entry);
 514         if (entry->func) {
 515           /* unlock before firing the callback */
 516           GST_OBJECT_UNLOCK (clock);
 517           entry->func (clock, entry->time, (GstClockID) entry,
 518               entry->user_data);
 519           GST_OBJECT_LOCK (clock);
 520         }
 521         if (entry->type == GST_CLOCK_ENTRY_PERIODIC) {
 522           GST_CAT_DEBUG (GST_CAT_CLOCK, "updating periodic entry %p", entry);
 523           /* adjust time now */
 524           entry->time = requested + entry->interval;
 525           /* and resort the list now */
 526           priv->entries =
 527               g_list_sort (priv->entries, gst_clock_id_compare_func);
 528           /* and restart */
 529           continue;
 530         } else {
 531           GST_CAT_DEBUG (GST_CAT_CLOCK, "moving to next entry");
 532           goto next_entry;
 533         }
 534       }
 535       case GST_CLOCK_BUSY:
 536         /* somebody unlocked the entry but is was not canceled, This means that
 537          * either a new entry was added in front of the queue or some other entry
 538          * was canceled. Whatever it is, pick the head entry of the list and
 539          * continue waiting. */
 540         GST_CAT_DEBUG (GST_CAT_CLOCK, "async entry %p needs restart", entry);
 541
 542         /* we set the entry back to the OK state. This is needed so that the
 543          * _unschedule() code can see if an entry is currently being waited
 544          * on (when its state is BUSY). */
 545         SET_ENTRY_STATUS (entry, GST_CLOCK_OK);
 546         continue;
 547       default:
 548         GST_CAT_DEBUG (GST_CAT_CLOCK,
 549             "strange result %d waiting for %p, skipping", res, entry);
 550         g_warning ("%s: strange result %d waiting for %p, skipping",
 551             GST_OBJECT_NAME (clock), res, entry);
 552         goto next_entry;
 553     }
 554   next_entry:
 555     /* we remove the current entry and unref it */
 556     priv->entries = g_list_remove (priv->entries, entry);
 557     gst_clock_id_unref ((GstClockID) entry);
 558   }
 559 exit:
 560   /* signal exit */
 561   GST_SYSTEM_CLOCK_BROADCAST (clock);
 562   GST_OBJECT_UNLOCK (clock);
 563   GST_CAT_DEBUG (GST_CAT_CLOCK, "exit system clock thread");
 564 }
 565
 566 #ifdef HAVE_POSIX_TIMERS
 567 static inline clockid_t
 568 clock_type_to_posix_id (GstClockType clock_type)
 569 {
 570 #ifdef HAVE_MONOTONIC_CLOCK
 571   if (clock_type == GST_CLOCK_TYPE_MONOTONIC)
 572     return CLOCK_MONOTONIC;
 573   else
 574 #endif
 575     return CLOCK_REALTIME;
 576 }
 577 #endif
 578
 579 /* MT safe */
 580 static GstClockTime
 581 gst_system_clock_get_internal_time (GstClock * clock)
 582 {
 583 #if defined __APPLE__
 584   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 585   uint64_t mach_t = mach_absolute_time ();
 586   return gst_util_uint64_scale (mach_t, sysclock->priv->mach_timebase.numer,
 587       sysclock->priv->mach_timebase.denom);
 588 #else
 589 #ifdef G_OS_WIN32
 590   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 591
 592   if (sysclock->priv->frequency.QuadPart != 0) {
 593     LARGE_INTEGER now;
 594
 595     /* we prefer the highly accurate performance counters on windows */
 596     QueryPerformanceCounter (&now);
 597
 598     return gst_util_uint64_scale (now.QuadPart - sysclock->priv->start.QuadPart,
 599         GST_SECOND, sysclock->priv->frequency.QuadPart);
 600   } else
 601 #endif /* G_OS_WIN32 */
 602 #if !defined HAVE_POSIX_TIMERS || !defined HAVE_CLOCK_GETTIME
 603   {
 604     GTimeVal timeval;
 605
 606     g_get_current_time (&timeval);
 607
 608     return GST_TIMEVAL_TO_TIME (timeval);
 609   }
 610 #else
 611   {
 612     GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 613     clockid_t ptype;
 614     struct timespec ts;
 615
 616     ptype = clock_type_to_posix_id (sysclock->priv->clock_type);
 617
 618     if (G_UNLIKELY (clock_gettime (ptype, &ts)))
 619       return GST_CLOCK_TIME_NONE;
 620
 621     return GST_TIMESPEC_TO_TIME (ts);
 622   }
 623 #endif
 624 #endif /* __APPLE__ */
 625 }
 626
 627 static guint64
 628 gst_system_clock_get_resolution (GstClock * clock)
 629 {
 630 #if defined __APPLE__
 631   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 632   return gst_util_uint64_scale (GST_NSECOND,
 633       sysclock->priv->mach_timebase.numer, sysclock->priv->mach_timebase.denom);
 634 #else
 635 #ifdef G_OS_WIN32
 636   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 637
 638   if (sysclock->priv->frequency.QuadPart != 0) {
 639     return GST_SECOND / sysclock->priv->frequency.QuadPart;
 640   } else
 641 #endif /* G_OS_WIN32 */
 642 #if defined(HAVE_POSIX_TIMERS) && defined(HAVE_CLOCK_GETTIME)
 643   {
 644     GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 645     clockid_t ptype;
 646     struct timespec ts;
 647
 648     ptype = clock_type_to_posix_id (sysclock->priv->clock_type);
 649
 650     if (G_UNLIKELY (clock_getres (ptype, &ts)))
 651       return GST_CLOCK_TIME_NONE;
 652
 653     return GST_TIMESPEC_TO_TIME (ts);
 654   }
 655 #else
 656   {
 657     return 1 * GST_USECOND;
 658   }
 659 #endif
 660 #endif /* __APPLE__ */
 661 }
 662
 663 static inline void
 664 gst_system_clock_cleanup_unscheduled (GstSystemClock * sysclock,
 665     GstClockEntry * entry)
 666 {
 667   /* try to clean up.
 668    * The unschedule function managed to set the status to
 669    * unscheduled. We now take the lock and mark the entry as unscheduled.
 670    * This makes sure that the unschedule function doesn't perform a
 671    * wakeup anymore. If the unschedule function has a change to perform
 672    * the wakeup before us, we clean up here */
 673   GST_OBJECT_LOCK (sysclock);
 674   entry->unscheduled = TRUE;
 675   if (entry->woken_up) {
 676     gst_system_clock_remove_wakeup (sysclock);
 677   }
 678   GST_OBJECT_UNLOCK (sysclock);
 679 }
 680
 681 /* synchronously wait on the given GstClockEntry.
 682  *
 683  * We do this by blocking on the global GstPoll timer with
 684  * the requested timeout. This allows us to unblock the
 685  * entry by writing on the control fd.
 686  *
 687  * Note that writing the global GstPoll unlocks all waiting entries. So
 688  * we need to check if an unlocked entry has changed when it unlocks.
 689  *
 690  * Entries that arrive too late are simply not waited on and a
 691  * GST_CLOCK_EARLY result is returned.
 692  *
 693  * MT safe.
 694  */
 695 static GstClockReturn
 696 gst_system_clock_id_wait_jitter_unlocked (GstClock * clock,
 697     GstClockEntry * entry, GstClockTimeDiff * jitter, gboolean restart)
 698 {
 699   GstSystemClock *sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 700   GstClockTime entryt, now;
 701   GstClockTimeDiff diff;
 702   GstClockReturn status;
 703
 704   status = GET_ENTRY_STATUS (entry);
 705   if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED))
 706     return GST_CLOCK_UNSCHEDULED;
 707
 708   /* need to call the overridden method because we want to sync against the time
 709    * of the clock, whatever the subclass uses as a clock. */
 710   now = gst_clock_get_time (clock);
 711
 712   /* get the time of the entry */
 713   entryt = GST_CLOCK_ENTRY_TIME (entry);
 714
 715   /* the diff of the entry with the clock is the amount of time we have to
 716    * wait */
 717   diff = GST_CLOCK_DIFF (now, entryt);
 718   if (G_LIKELY (jitter))
 719     *jitter = -diff;
 720
 721   GST_CAT_DEBUG (GST_CAT_CLOCK, "entry %p"
 722       " time %" GST_TIME_FORMAT
 723       " now %" GST_TIME_FORMAT
 724       " diff (time-now) %" G_GINT64_FORMAT,
 725       entry, GST_TIME_ARGS (entryt), GST_TIME_ARGS (now), diff);
 726
 727   if (G_LIKELY (diff > 0)) {
 728 #ifdef WAIT_DEBUGGING
 729     GstClockTime final;
 730 #endif
 731
 732     while (TRUE) {
 733       gint pollret;
 734
 735       /* now wait on the entry, it either times out or the fd is written. The
 736        * status of the entry is BUSY only around the poll. */
 737       pollret = gst_poll_wait (sysclock->priv->timer, diff);
 738
 739       /* get the new status, mark as DONE. We do this so that the unschedule
 740        * function knows when we left the poll and doesn't need to wakeup the
 741        * poll anymore. */
 742       do {
 743         status = GET_ENTRY_STATUS (entry);
 744         /* we were unscheduled, exit immediately */
 745         if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED))
 746           break;
 747         if (G_UNLIKELY (status != GST_CLOCK_BUSY))
 748           GST_CAT_ERROR (GST_CAT_CLOCK, "unexpected status %d for entry %p",
 749               status, entry);
 750       } while (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status, GST_CLOCK_DONE)));
 751
 752       GST_CAT_DEBUG (GST_CAT_CLOCK, "entry %p unlocked, status %d, ret %d",
 753           entry, status, pollret);
 754
 755       if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
 756         gst_system_clock_cleanup_unscheduled (sysclock, entry);
 757         goto done;
 758       } else {
 759         if (G_UNLIKELY (pollret != 0)) {
 760           /* some other id got unlocked */
 761           if (!restart) {
 762             /* this can happen if the entry got unlocked because of an async
 763              * entry was added to the head of the async queue. */
 764             GST_CAT_DEBUG (GST_CAT_CLOCK, "wakeup waiting for entry %p", entry);
 765             goto done;
 766           }
 767
 768           /* wait till all the entries got woken up */
 769           GST_OBJECT_LOCK (sysclock);
 770           gst_system_clock_wait_wakeup (sysclock);
 771           GST_OBJECT_UNLOCK (sysclock);
 772
 773           GST_CAT_DEBUG (GST_CAT_CLOCK, "entry %p needs to be restarted",
 774               entry);
 775         } else {
 776           GST_CAT_DEBUG (GST_CAT_CLOCK, "entry %p unlocked after timeout",
 777               entry);
 778         }
 779
 780         /* reschedule if gst_poll_wait returned early or we have to reschedule after
 781          * an unlock*/
 782         now = gst_clock_get_time (clock);
 783         diff = GST_CLOCK_DIFF (now, entryt);
 784
 785         if (diff <= 0) {
 786           /* timeout, this is fine, we can report success now */
 787           if (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, GST_CLOCK_DONE,
 788                       GST_CLOCK_OK))) {
 789             status = GET_ENTRY_STATUS (entry);
 790             if (status != GST_CLOCK_UNSCHEDULED)
 791               GST_CAT_ERROR (GST_CAT_CLOCK, "unexpected status %d for entry %p",
 792                   status, entry);
 793             goto done;
 794           } else {
 795             status = GST_CLOCK_OK;
 796           }
 797
 798           GST_CAT_DEBUG (GST_CAT_CLOCK,
 799               "entry %p finished, diff %" G_GINT64_FORMAT, entry, diff);
 800
 801 #ifdef WAIT_DEBUGGING
 802           final = gst_system_clock_get_internal_time (clock);
 803           GST_CAT_DEBUG (GST_CAT_CLOCK, "Waited for %" G_GINT64_FORMAT
 804               " got %" G_GINT64_FORMAT " diff %" G_GINT64_FORMAT
 805               " %g target-offset %" G_GINT64_FORMAT " %g", entryt, now,
 806               now - entryt,
 807               (double) (GstClockTimeDiff) (now - entryt) / GST_SECOND,
 808               (final - target),
 809               ((double) (GstClockTimeDiff) (final - target)) / GST_SECOND);
 810 #endif
 811           goto done;
 812         } else {
 813           GST_CAT_DEBUG (GST_CAT_CLOCK,
 814               "entry %p restart, diff %" G_GINT64_FORMAT, entry, diff);
 815           /* we are going to poll again, set status back to busy */
 816           do {
 817             status = GET_ENTRY_STATUS (entry);
 818             /* we were unscheduled, exit immediately */
 819             if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED))
 820               goto done;
 821             if (G_UNLIKELY (status != GST_CLOCK_DONE))
 822               GST_CAT_ERROR (GST_CAT_CLOCK, "unexpected status %d for entry %p",
 823                   status, entry);
 824           } while (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status,
 825                       GST_CLOCK_BUSY)));
 826         }
 827       }
 828     }
 829   } else {
 830     /* we are right on time or too late */
 831     if (G_UNLIKELY (diff == 0)) {
 832       if (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status, GST_CLOCK_OK))) {
 833         status = GET_ENTRY_STATUS (entry);
 834         if (G_LIKELY (status == GST_CLOCK_UNSCHEDULED))
 835           gst_system_clock_cleanup_unscheduled (sysclock, entry);
 836         else
 837           GST_CAT_ERROR (GST_CAT_CLOCK, "unexpected status %d for entry %p",
 838               status, entry);
 839       } else {
 840         status = GST_CLOCK_OK;
 841       }
 842     } else {
 843       if (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status, GST_CLOCK_EARLY))) {
 844         status = GET_ENTRY_STATUS (entry);
 845         if (G_LIKELY (status == GST_CLOCK_UNSCHEDULED))
 846           gst_system_clock_cleanup_unscheduled (sysclock, entry);
 847         else
 848           GST_CAT_ERROR (GST_CAT_CLOCK, "unexpected status %d for entry %p",
 849               status, entry);
 850       } else {
 851         status = GST_CLOCK_EARLY;
 852       }
 853     }
 854   }
 855 done:
 856   return status;
 857 }
 858
 859 static GstClockReturn
 860 gst_system_clock_id_wait_jitter (GstClock * clock, GstClockEntry * entry,
 861     GstClockTimeDiff * jitter)
 862 {
 863   GstClockReturn status;
 864   do {
 865     status = GET_ENTRY_STATUS (entry);
 866
 867     /* stop when we are unscheduled */
 868     if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED))
 869       return status;
 870
 871     if (G_UNLIKELY (status != GST_CLOCK_OK))
 872       GST_CAT_ERROR (GST_CAT_CLOCK, "unexpected status %d for entry %p",
 873           status, entry);
 874
 875     /* mark the entry as busy but watch out for intermediate unscheduled
 876      * statuses */
 877   } while (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status, GST_CLOCK_BUSY)));
 878
 879   return gst_system_clock_id_wait_jitter_unlocked (clock, entry, jitter, TRUE);
 880 }
 881
 882 /* Start the async clock thread. Must be called with the object lock
 883  * held */
 884 static gboolean
 885 gst_system_clock_start_async (GstSystemClock * clock)
 886 {
 887   GError *error = NULL;
 888   GstSystemClockPrivate *priv = clock->priv;
 889
 890   if (G_LIKELY (priv->thread != NULL))
 891     return TRUE;                /* Thread already running. Nothing to do */
 892
 893   priv->thread = g_thread_try_new ("GstSystemClock",
 894       (GThreadFunc) gst_system_clock_async_thread, clock, &error);
 895
 896   if (G_UNLIKELY (error))
 897     goto no_thread;
 898
 899   /* wait for it to spin up */
 900   GST_SYSTEM_CLOCK_WAIT (clock);
 901
 902   return TRUE;
 903
 904   /* ERRORS */
 905 no_thread:
 906   {
 907     g_warning ("could not create async clock thread: %s", error->message);
 908     g_error_free (error);
 909   }
 910   return FALSE;
 911 }
 912
 913 /* Add an entry to the list of pending async waits. The entry is inserted
 914  * in sorted order. If we inserted the entry at the head of the list, we
 915  * need to signal the thread as it might either be waiting on it or waiting
 916  * for a new entry.
 917  *
 918  * MT safe.
 919  */
 920 static GstClockReturn
 921 gst_system_clock_id_wait_async (GstClock * clock, GstClockEntry * entry)
 922 {
 923   GstSystemClock *sysclock;
 924   GstSystemClockPrivate *priv;
 925   GstClockEntry *head;
 926
 927   sysclock = GST_SYSTEM_CLOCK_CAST (clock);
 928   priv = sysclock->priv;
 929
 930   GST_CAT_DEBUG (GST_CAT_CLOCK, "adding async entry %p", entry);
 931
 932   GST_OBJECT_LOCK (clock);
 933   /* Start the clock async thread if needed */
 934   if (G_UNLIKELY (!gst_system_clock_start_async (sysclock)))
 935     goto thread_error;
 936
 937   if (G_UNLIKELY (GET_ENTRY_STATUS (entry) == GST_CLOCK_UNSCHEDULED))
 938     goto was_unscheduled;
 939
 940   if (priv->entries)
 941     head = priv->entries->data;
 942   else
 943     head = NULL;
 944
 945   /* need to take a ref */
 946   gst_clock_id_ref ((GstClockID) entry);
 947   /* insert the entry in sorted order */
 948   priv->entries = g_list_insert_sorted (priv->entries, entry,
 949       gst_clock_id_compare_func);
 950
 951   /* only need to send the signal if the entry was added to the
 952    * front, else the thread is just waiting for another entry and
 953    * will get to this entry automatically. */
 954   if (priv->entries->data == entry) {
 955     GST_CAT_DEBUG (GST_CAT_CLOCK, "async entry added to head %p", head);
 956     if (head == NULL) {
 957       /* the list was empty before, signal the cond so that the async thread can
 958        * start taking a look at the queue */
 959       GST_CAT_DEBUG (GST_CAT_CLOCK, "first entry, sending signal");
 960       GST_SYSTEM_CLOCK_BROADCAST (clock);
 961     } else {
 962       GstClockReturn status;
 963
 964       status = GET_ENTRY_STATUS (head);
 965       GST_CAT_DEBUG (GST_CAT_CLOCK, "head entry %p status %d", head, status);
 966
 967       if (status == GST_CLOCK_BUSY) {
 968         GST_CAT_DEBUG (GST_CAT_CLOCK, "head entry is busy");
 969         /* the async thread was waiting for an entry, unlock the wait so that it
 970          * looks at the new head entry instead, we only need to do this once */
 971         if (!priv->async_wakeup) {
 972           GST_CAT_DEBUG (GST_CAT_CLOCK, "wakeup async thread");
 973           priv->async_wakeup = TRUE;
 974           gst_system_clock_add_wakeup (sysclock);
 975         }
 976       }
 977     }
 978   }
 979   GST_OBJECT_UNLOCK (clock);
 980
 981   return GST_CLOCK_OK;
 982
 983   /* ERRORS */
 984 thread_error:
 985   {
 986     /* Could not start the async clock thread */
 987     GST_OBJECT_UNLOCK (clock);
 988     return GST_CLOCK_ERROR;
 989   }
 990 was_unscheduled:
 991   {
 992     GST_OBJECT_UNLOCK (clock);
 993     return GST_CLOCK_UNSCHEDULED;
 994   }
 995 }
 996
 997 /* unschedule an entry. This will set the state of the entry to GST_CLOCK_UNSCHEDULED
 998  * and will signal any thread waiting for entries to recheck their entry.
 999  * We cannot really decide if the signal is needed or not because the entry
1000  * could be waited on in async or sync mode.
1001  *
1002  * MT safe.
1003  */
1004 static void
1005 gst_system_clock_id_unschedule (GstClock * clock, GstClockEntry * entry)
1006 {
1007   GstSystemClock *sysclock;
1008   GstClockReturn status;
1009
1010   sysclock = GST_SYSTEM_CLOCK_CAST (clock);
1011
1012   GST_CAT_DEBUG (GST_CAT_CLOCK, "unscheduling entry %p", entry);
1013
1014   GST_OBJECT_LOCK (clock);
1015   /* change the entry status to unscheduled */
1016   do {
1017     status = GET_ENTRY_STATUS (entry);
1018   } while (G_UNLIKELY (!CAS_ENTRY_STATUS (entry, status,
1019               GST_CLOCK_UNSCHEDULED)));
1020
1021   if (G_LIKELY (status == GST_CLOCK_BUSY)) {
1022     /* the entry was being busy, wake up all entries so that they recheck their
1023      * status. We cannot wake up just one entry because allocating such a
1024      * datastructure for each entry would be too heavy and unlocking an entry
1025      * is usually done when shutting down or some other exceptional case. */
1026     GST_CAT_DEBUG (GST_CAT_CLOCK, "entry was BUSY, doing wakeup");
1027     if (!entry->unscheduled && !entry->woken_up) {
1028       gst_system_clock_add_wakeup (sysclock);
1029       entry->woken_up = TRUE;
1030     }
1031   }
1032   GST_OBJECT_UNLOCK (clock);
1033 }