gst/gstbus.c

   1 /* GStreamer
   2  * Copyright (C) 2004 Wim Taymans <wim@fluendo.com>
   3  *
   4  * gstbus.c: GstBus subsystem
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 /**
  23  * SECTION:gstbus
  24  * @short_description: Asynchronous message bus subsystem
  25  * @see_also: #GstMessage, #GstElement
  26  *
  27  * The #GstBus is an object responsible for delivering #GstMessage packets in
  28  * a first-in first-out way from the streaming threads (see #GstTask) to the
  29  * application.
  30  *
  31  * Since the application typically only wants to deal with delivery of these
  32  * messages from one thread, the GstBus will marshall the messages between
  33  * different threads. This is important since the actual streaming of media
  34  * is done in another thread than the application.
  35  *
  36  * The GstBus provides support for #GSource based notifications. This makes it
  37  * possible to handle the delivery in the glib mainloop.
  38  *
  39  * The #GSource callback function gst_bus_async_signal_func() can be used to
  40  * convert all bus messages into signal emissions.
  41  *
  42  * A message is posted on the bus with the gst_bus_post() method. With the
  43  * gst_bus_peek() and gst_bus_pop() methods one can look at or retrieve a
  44  * previously posted message.
  45  *
  46  * The bus can be polled with the gst_bus_poll() method. This methods blocks
  47  * up to the specified timeout value until one of the specified messages types
  48  * is posted on the bus. The application can then gst_bus_pop() the messages
  49  * from the bus to handle them.
  50  * Alternatively the application can register an asynchronous bus function
  51  * using gst_bus_add_watch_full() or gst_bus_add_watch(). This function will
  52  * install a #GSource in the default glib main loop and will deliver messages
  53  * a short while after they have been posted. Note that the main loop should
  54  * be running for the asynchronous callbacks.
  55  *
  56  * It is also possible to get messages from the bus without any thread
  57  * marshalling with the gst_bus_set_sync_handler() method. This makes it
  58  * possible to react to a message in the same thread that posted the
  59  * message on the bus. This should only be used if the application is able
  60  * to deal with messages from different threads.
  61  *
  62  * Every #GstPipeline has one bus.
  63  *
  64  * Note that a #GstPipeline will set its bus into flushing state when changing
  65  * from READY to NULL state.
  66  *
  67  * Last reviewed on 2012-03-28 (0.11.3)
  68  */
  69
  70 #include "gst_private.h"
  71 #include <errno.h>
  72 #ifdef HAVE_UNISTD_H
  73 #  include <unistd.h>
  74 #endif
  75 #include <sys/types.h>
  76
  77 #include "gstatomicqueue.h"
  78 #include "gstinfo.h"
  79 #include "gstpoll.h"
  80
  81 #include "gstbus.h"
  82 #include "glib-compat-private.h"
  83
  84 #define GST_CAT_DEFAULT GST_CAT_BUS
  85 /* bus signals */
  86 enum
  87 {
  88   SYNC_MESSAGE,
  89   ASYNC_MESSAGE,
  90   /* add more above */
  91   LAST_SIGNAL
  92 };
  93
  94 #define DEFAULT_ENABLE_ASYNC (TRUE)
  95
  96 enum
  97 {
  98   PROP_0,
  99   PROP_ENABLE_ASYNC
 100 };
 101
 102 static void gst_bus_dispose (GObject * object);
 103
 104 static guint gst_bus_signals[LAST_SIGNAL] = { 0 };
 105
 106 struct _GstBusPrivate
 107 {
 108   GstAtomicQueue *queue;
 109   GMutex queue_lock;
 110
 111   GstBusSyncHandler sync_handler;
 112   gpointer sync_handler_data;
 113
 114   guint signal_watch_id;
 115   guint num_signal_watchers;
 116
 117   guint num_sync_message_emitters;
 118   GSource *watch_id;
 119
 120   gboolean enable_async;
 121   GstPoll *poll;
 122   GPollFD pollfd;
 123 };
 124
 125 #define gst_bus_parent_class parent_class
 126 G_DEFINE_TYPE (GstBus, gst_bus, GST_TYPE_OBJECT);
 127
 128 static void
 129 gst_bus_set_property (GObject * object,
 130     guint prop_id, const GValue * value, GParamSpec * pspec)
 131 {
 132   GstBus *bus = GST_BUS_CAST (object);
 133
 134   switch (prop_id) {
 135     case PROP_ENABLE_ASYNC:
 136       bus->priv->enable_async = g_value_get_boolean (value);
 137       break;
 138     default:
 139       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 140       break;
 141   }
 142 }
 143
 144 static void
 145 gst_bus_constructed (GObject * object)
 146 {
 147   GstBus *bus = GST_BUS_CAST (object);
 148
 149   if (bus->priv->enable_async) {
 150     bus->priv->poll = gst_poll_new_timer ();
 151     gst_poll_get_read_gpollfd (bus->priv->poll, &bus->priv->pollfd);
 152   }
 153 }
 154
 155 static void
 156 gst_bus_class_init (GstBusClass * klass)
 157 {
 158   GObjectClass *gobject_class = (GObjectClass *) klass;
 159
 160   gobject_class->dispose = gst_bus_dispose;
 161   gobject_class->set_property = gst_bus_set_property;
 162   gobject_class->constructed = gst_bus_constructed;
 163
 164   /* GstBus:enable-async:
 165    *
 166    * Enable async message delivery support for bus watches,
 167    * gst_bus_pop() and similar API. Without this only the
 168    * synchronous message handlers are called.
 169    *
 170    * This property is used to create the child element buses
 171    * in #GstBin.
 172    *
 173    * Since: 0.10.33
 174    */
 175   g_object_class_install_property (gobject_class, PROP_ENABLE_ASYNC,
 176       g_param_spec_boolean ("enable-async", "Enable Async",
 177           "Enable async message delivery for bus watches and gst_bus_pop()",
 178           DEFAULT_ENABLE_ASYNC,
 179           G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
 180
 181   /**
 182    * GstBus::sync-message:
 183    * @bus: the object which received the signal
 184    * @message: the message that has been posted synchronously
 185    *
 186    * A message has been posted on the bus. This signal is emitted from the
 187    * thread that posted the message so one has to be careful with locking.
 188    *
 189    * This signal will not be emitted by default, you have to set up
 190    * gst_bus_sync_signal_handler() as a sync handler if you want this
 191    * signal to be emitted when a message is posted on the bus, like this:
 192    * <programlisting>
 193    * gst_bus_set_sync_handler (bus, gst_bus_sync_signal_handler, yourdata);
 194    * </programlisting>
 195    */
 196   gst_bus_signals[SYNC_MESSAGE] =
 197       g_signal_new ("sync-message", G_TYPE_FROM_CLASS (klass),
 198       G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
 199       G_STRUCT_OFFSET (GstBusClass, sync_message), NULL, NULL,
 200       g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_MESSAGE);
 201
 202   /**
 203    * GstBus::message:
 204    * @bus: the object which received the signal
 205    * @message: the message that has been posted asynchronously
 206    *
 207    * A message has been posted on the bus. This signal is emitted from a
 208    * GSource added to the mainloop. this signal will only be emitted when
 209    * there is a mainloop running.
 210    */
 211   gst_bus_signals[ASYNC_MESSAGE] =
 212       g_signal_new ("message", G_TYPE_FROM_CLASS (klass),
 213       G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
 214       G_STRUCT_OFFSET (GstBusClass, message), NULL, NULL,
 215       g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_MESSAGE);
 216
 217   g_type_class_add_private (klass, sizeof (GstBusPrivate));
 218 }
 219
 220 static void
 221 gst_bus_init (GstBus * bus)
 222 {
 223   bus->priv = G_TYPE_INSTANCE_GET_PRIVATE (bus, GST_TYPE_BUS, GstBusPrivate);
 224   bus->priv->enable_async = DEFAULT_ENABLE_ASYNC;
 225   g_mutex_init (&bus->priv->queue_lock);
 226   bus->priv->queue = gst_atomic_queue_new (32);
 227
 228   GST_DEBUG_OBJECT (bus, "created");
 229 }
 230
 231 static void
 232 gst_bus_dispose (GObject * object)
 233 {
 234   GstBus *bus = GST_BUS (object);
 235
 236   if (bus->priv->queue) {
 237     GstMessage *message;
 238
 239     g_mutex_lock (&bus->priv->queue_lock);
 240     do {
 241       message = gst_atomic_queue_pop (bus->priv->queue);
 242       if (message)
 243         gst_message_unref (message);
 244     } while (message != NULL);
 245     gst_atomic_queue_unref (bus->priv->queue);
 246     bus->priv->queue = NULL;
 247     g_mutex_unlock (&bus->priv->queue_lock);
 248     g_mutex_clear (&bus->priv->queue_lock);
 249
 250     if (bus->priv->poll)
 251       gst_poll_free (bus->priv->poll);
 252     bus->priv->poll = NULL;
 253   }
 254
 255   G_OBJECT_CLASS (parent_class)->dispose (object);
 256 }
 257
 258 /**
 259  * gst_bus_new:
 260  *
 261  * Creates a new #GstBus instance.
 262  *
 263  * Returns: (transfer full): a new #GstBus instance
 264  */
 265 GstBus *
 266 gst_bus_new (void)
 267 {
 268   GstBus *result;
 269
 270   result = g_object_newv (gst_bus_get_type (), 0, NULL);
 271   GST_DEBUG_OBJECT (result, "created new bus");
 272
 273   return result;
 274 }
 275
 276 /**
 277  * gst_bus_post:
 278  * @bus: a #GstBus to post on
 279  * @message: (transfer full): the #GstMessage to post
 280  *
 281  * Post a message on the given bus. Ownership of the message
 282  * is taken by the bus.
 283  *
 284  * Returns: TRUE if the message could be posted, FALSE if the bus is flushing.
 285  *
 286  * MT safe.
 287  */
 288 gboolean
 289 gst_bus_post (GstBus * bus, GstMessage * message)
 290 {
 291   GstBusSyncReply reply = GST_BUS_PASS;
 292   GstBusSyncHandler handler;
 293   gboolean emit_sync_message;
 294   gpointer handler_data;
 295
 296   g_return_val_if_fail (GST_IS_BUS (bus), FALSE);
 297   g_return_val_if_fail (GST_IS_MESSAGE (message), FALSE);
 298
 299   GST_DEBUG_OBJECT (bus, "[msg %p] posting on bus %" GST_PTR_FORMAT, message,
 300       message);
 301
 302   GST_OBJECT_LOCK (bus);
 303   /* check if the bus is flushing */
 304   if (GST_OBJECT_FLAG_IS_SET (bus, GST_BUS_FLUSHING))
 305     goto is_flushing;
 306
 307   handler = bus->priv->sync_handler;
 308   handler_data = bus->priv->sync_handler_data;
 309   emit_sync_message = bus->priv->num_sync_message_emitters > 0;
 310   GST_OBJECT_UNLOCK (bus);
 311
 312   /* first call the sync handler if it is installed */
 313   if (handler)
 314     reply = handler (bus, message, handler_data);
 315
 316   /* emit sync-message if requested to do so via
 317      gst_bus_enable_sync_message_emission. terrible but effective */
 318   if (emit_sync_message && reply != GST_BUS_DROP
 319       && handler != gst_bus_sync_signal_handler)
 320     gst_bus_sync_signal_handler (bus, message, NULL);
 321
 322   /* If this is a bus without async message delivery
 323    * always drop the message */
 324   if (!bus->priv->poll)
 325     reply = GST_BUS_DROP;
 326
 327   /* now see what we should do with the message */
 328   switch (reply) {
 329     case GST_BUS_DROP:
 330       /* drop the message */
 331       GST_DEBUG_OBJECT (bus, "[msg %p] dropped", message);
 332       break;
 333     case GST_BUS_PASS:
 334       /* pass the message to the async queue, refcount passed in the queue */
 335       GST_DEBUG_OBJECT (bus, "[msg %p] pushing on async queue", message);
 336       gst_atomic_queue_push (bus->priv->queue, message);
 337       gst_poll_write_control (bus->priv->poll);
 338       GST_DEBUG_OBJECT (bus, "[msg %p] pushed on async queue", message);
 339
 340       break;
 341     case GST_BUS_ASYNC:
 342     {
 343       /* async delivery, we need a mutex and a cond to block
 344        * on */
 345       GCond *cond = GST_MESSAGE_GET_COND (message);
 346       GMutex *lock = GST_MESSAGE_GET_LOCK (message);
 347
 348       g_cond_init (cond);
 349       g_mutex_init (lock);
 350
 351       GST_DEBUG_OBJECT (bus, "[msg %p] waiting for async delivery", message);
 352
 353       /* now we lock the message mutex, send the message to the async
 354        * queue. When the message is handled by the app and destroyed,
 355        * the cond will be signalled and we can continue */
 356       g_mutex_lock (lock);
 357
 358       gst_atomic_queue_push (bus->priv->queue, message);
 359       gst_poll_write_control (bus->priv->poll);
 360
 361       /* now block till the message is freed */
 362       g_cond_wait (cond, lock);
 363       g_mutex_unlock (lock);
 364
 365       GST_DEBUG_OBJECT (bus, "[msg %p] delivered asynchronously", message);
 366
 367       g_mutex_clear (lock);
 368       g_cond_clear (cond);
 369       break;
 370     }
 371     default:
 372       g_warning ("invalid return from bus sync handler");
 373       break;
 374   }
 375   return TRUE;
 376
 377   /* ERRORS */
 378 is_flushing:
 379   {
 380     GST_DEBUG_OBJECT (bus, "bus is flushing");
 381     gst_message_unref (message);
 382     GST_OBJECT_UNLOCK (bus);
 383
 384     return FALSE;
 385   }
 386 }
 387
 388 /**
 389  * gst_bus_have_pending:
 390  * @bus: a #GstBus to check
 391  *
 392  * Check if there are pending messages on the bus that
 393  * should be handled.
 394  *
 395  * Returns: TRUE if there are messages on the bus to be handled, FALSE
 396  * otherwise.
 397  *
 398  * MT safe.
 399  */
 400 gboolean
 401 gst_bus_have_pending (GstBus * bus)
 402 {
 403   gboolean result;
 404
 405   g_return_val_if_fail (GST_IS_BUS (bus), FALSE);
 406
 407   /* see if there is a message on the bus */
 408   result = gst_atomic_queue_length (bus->priv->queue) != 0;
 409
 410   return result;
 411 }
 412
 413 /**
 414  * gst_bus_set_flushing:
 415  * @bus: a #GstBus
 416  * @flushing: whether or not to flush the bus
 417  *
 418  * If @flushing, flush out and unref any messages queued in the bus. Releases
 419  * references to the message origin objects. Will flush future messages until
 420  * gst_bus_set_flushing() sets @flushing to #FALSE.
 421  *
 422  * MT safe.
 423  */
 424 void
 425 gst_bus_set_flushing (GstBus * bus, gboolean flushing)
 426 {
 427   GstMessage *message;
 428
 429   GST_OBJECT_LOCK (bus);
 430
 431   if (flushing) {
 432     GST_OBJECT_FLAG_SET (bus, GST_BUS_FLUSHING);
 433
 434     GST_DEBUG_OBJECT (bus, "set bus flushing");
 435
 436     while ((message = gst_bus_pop (bus)))
 437       gst_message_unref (message);
 438   } else {
 439     GST_DEBUG_OBJECT (bus, "unset bus flushing");
 440     GST_OBJECT_FLAG_UNSET (bus, GST_BUS_FLUSHING);
 441   }
 442
 443   GST_OBJECT_UNLOCK (bus);
 444 }
 445
 446 /**
 447  * gst_bus_timed_pop_filtered:
 448  * @bus: a #GstBus to pop from
 449  * @timeout: a timeout in nanoseconds, or GST_CLOCK_TIME_NONE to wait forever
 450  * @types: message types to take into account, GST_MESSAGE_ANY for any type
 451  *
 452  * Get a message from the bus whose type matches the message type mask @types,
 453  * waiting up to the specified timeout (and discarding any messages that do not
 454  * match the mask provided).
 455  *
 456  * If @timeout is 0, this function behaves like gst_bus_pop_filtered(). If
 457  * @timeout is #GST_CLOCK_TIME_NONE, this function will block forever until a
 458  * matching message was posted on the bus.
 459  *
 460  * Returns: (transfer full): a #GstMessage matching the filter in @types,
 461  *     or NULL if no matching message was found on the bus until the timeout
 462  *     expired. The message is taken from the bus and needs to be unreffed
 463  *     with gst_message_unref() after usage.
 464  *
 465  * MT safe.
 466  *
 467  * Since: 0.10.15
 468  */
 469 GstMessage *
 470 gst_bus_timed_pop_filtered (GstBus * bus, GstClockTime timeout,
 471     GstMessageType types)
 472 {
 473   GstMessage *message;
 474   GTimeVal now, then;
 475   gboolean first_round = TRUE;
 476   GstClockTime elapsed = 0;
 477
 478   g_return_val_if_fail (GST_IS_BUS (bus), NULL);
 479   g_return_val_if_fail (types != 0, NULL);
 480   g_return_val_if_fail (timeout == 0 || bus->priv->poll != NULL, NULL);
 481
 482   g_mutex_lock (&bus->priv->queue_lock);
 483
 484   while (TRUE) {
 485     gint ret;
 486
 487     GST_LOG_OBJECT (bus, "have %d messages",
 488         gst_atomic_queue_length (bus->priv->queue));
 489
 490     while ((message = gst_atomic_queue_pop (bus->priv->queue))) {
 491       if (bus->priv->poll)
 492         gst_poll_read_control (bus->priv->poll);
 493
 494       GST_DEBUG_OBJECT (bus, "got message %p, %s from %s, type mask is %u",
 495           message, GST_MESSAGE_TYPE_NAME (message),
 496           GST_MESSAGE_SRC_NAME (message), (guint) types);
 497       if ((GST_MESSAGE_TYPE (message) & types) != 0) {
 498         /* exit the loop, we have a message */
 499         goto beach;
 500       } else {
 501         GST_DEBUG_OBJECT (bus, "discarding message, does not match mask");
 502         gst_message_unref (message);
 503         message = NULL;
 504       }
 505     }
 506
 507     /* no need to wait, exit loop */
 508     if (timeout == 0)
 509       break;
 510
 511     else if (timeout != GST_CLOCK_TIME_NONE) {
 512       if (first_round) {
 513         g_get_current_time (&then);
 514         first_round = FALSE;
 515       } else {
 516         g_get_current_time (&now);
 517
 518         elapsed = GST_TIMEVAL_TO_TIME (now) - GST_TIMEVAL_TO_TIME (then);
 519
 520         if (elapsed > timeout)
 521           break;
 522       }
 523     }
 524
 525     /* only here in timeout case */
 526     g_assert (bus->priv->poll);
 527     g_mutex_unlock (&bus->priv->queue_lock);
 528     ret = gst_poll_wait (bus->priv->poll, timeout - elapsed);
 529     g_mutex_lock (&bus->priv->queue_lock);
 530
 531     if (ret == 0) {
 532       GST_INFO_OBJECT (bus, "timed out, breaking loop");
 533       break;
 534     } else {
 535       GST_INFO_OBJECT (bus, "we got woken up, recheck for message");
 536     }
 537   }
 538
 539 beach:
 540
 541   g_mutex_unlock (&bus->priv->queue_lock);
 542
 543   return message;
 544 }
 545
 546
 547 /**
 548  * gst_bus_timed_pop:
 549  * @bus: a #GstBus to pop
 550  * @timeout: a timeout
 551  *
 552  * Get a message from the bus, waiting up to the specified timeout.
 553  *
 554  * If @timeout is 0, this function behaves like gst_bus_pop(). If @timeout is
 555  * #GST_CLOCK_TIME_NONE, this function will block forever until a message was
 556  * posted on the bus.
 557  *
 558  * Returns: (transfer full): the #GstMessage that is on the bus after the
 559  *     specified timeout or NULL if the bus is empty after the timeout expired.
 560  * The message is taken from the bus and needs to be unreffed with
 561  * gst_message_unref() after usage.
 562  *
 563  * MT safe.
 564  *
 565  * Since: 0.10.12
 566  */
 567 GstMessage *
 568 gst_bus_timed_pop (GstBus * bus, GstClockTime timeout)
 569 {
 570   g_return_val_if_fail (GST_IS_BUS (bus), NULL);
 571
 572   return gst_bus_timed_pop_filtered (bus, timeout, GST_MESSAGE_ANY);
 573 }
 574
 575 /**
 576  * gst_bus_pop_filtered:
 577  * @bus: a #GstBus to pop
 578  * @types: message types to take into account
 579  *
 580  * Get a message matching @type from the bus.  Will discard all messages on
 581  * the bus that do not match @type and that have been posted before the first
 582  * message that does match @type.  If there is no message matching @type on
 583  * the bus, all messages will be discarded.
 584  *
 585  * Returns: (transfer full): the next #GstMessage matching @type that is on
 586  *     the bus, or NULL if the bus is empty or there is no message matching
 587  *     @type. The message is taken from the bus and needs to be unreffed with
 588  *     gst_message_unref() after usage.
 589  *
 590  * MT safe.
 591  *
 592  * Since: 0.10.15
 593  */
 594 GstMessage *
 595 gst_bus_pop_filtered (GstBus * bus, GstMessageType types)
 596 {
 597   g_return_val_if_fail (GST_IS_BUS (bus), NULL);
 598   g_return_val_if_fail (types != 0, NULL);
 599
 600   return gst_bus_timed_pop_filtered (bus, 0, types);
 601 }
 602
 603 /**
 604  * gst_bus_pop:
 605  * @bus: a #GstBus to pop
 606  *
 607  * Get a message from the bus.
 608  *
 609  * Returns: (transfer full): the #GstMessage that is on the bus, or NULL if the
 610  *     bus is empty. The message is taken from the bus and needs to be unreffed
 611  *     with gst_message_unref() after usage.
 612  *
 613  * MT safe.
 614  */
 615 GstMessage *
 616 gst_bus_pop (GstBus * bus)
 617 {
 618   g_return_val_if_fail (GST_IS_BUS (bus), NULL);
 619
 620   return gst_bus_timed_pop_filtered (bus, 0, GST_MESSAGE_ANY);
 621 }
 622
 623 /**
 624  * gst_bus_peek:
 625  * @bus: a #GstBus
 626  *
 627  * Peek the message on the top of the bus' queue. The message will remain
 628  * on the bus' message queue. A reference is returned, and needs to be unreffed
 629  * by the caller.
 630  *
 631  * Returns: (transfer full): the #GstMessage that is on the bus, or NULL if the
 632  *     bus is empty.
 633  *
 634  * MT safe.
 635  */
 636 GstMessage *
 637 gst_bus_peek (GstBus * bus)
 638 {
 639   GstMessage *message;
 640
 641   g_return_val_if_fail (GST_IS_BUS (bus), NULL);
 642
 643   g_mutex_lock (&bus->priv->queue_lock);
 644   message = gst_atomic_queue_peek (bus->priv->queue);
 645   if (message)
 646     gst_message_ref (message);
 647   g_mutex_unlock (&bus->priv->queue_lock);
 648
 649   GST_DEBUG_OBJECT (bus, "peek on bus, got message %p", message);
 650
 651   return message;
 652 }
 653
 654 /**
 655  * gst_bus_set_sync_handler:
 656  * @bus: a #GstBus to install the handler on
 657  * @func: The handler function to install
 658  * @data: User data that will be sent to the handler function.
 659  *
 660  * Sets the synchronous handler on the bus. The function will be called
 661  * every time a new message is posted on the bus. Note that the function
 662  * will be called in the same thread context as the posting object. This
 663  * function is usually only called by the creator of the bus. Applications
 664  * should handle messages asynchronously using the gst_bus watch and poll
 665  * functions.
 666  *
 667  * You cannot replace an existing sync_handler. You can pass NULL to this
 668  * function, which will clear the existing handler.
 669  */
 670 void
 671 gst_bus_set_sync_handler (GstBus * bus, GstBusSyncHandler func, gpointer data)
 672 {
 673   g_return_if_fail (GST_IS_BUS (bus));
 674
 675   GST_OBJECT_LOCK (bus);
 676
 677   /* Assert if the user attempts to replace an existing sync_handler,
 678    * other than to clear it */
 679   if (func != NULL && bus->priv->sync_handler != NULL)
 680     goto no_replace;
 681
 682   bus->priv->sync_handler = func;
 683   bus->priv->sync_handler_data = data;
 684   GST_OBJECT_UNLOCK (bus);
 685
 686   return;
 687
 688 no_replace:
 689   {
 690     GST_OBJECT_UNLOCK (bus);
 691     g_warning ("cannot replace existing sync handler");
 692     return;
 693   }
 694 }
 695
 696 /* GSource for the bus
 697  */
 698 typedef struct
 699 {
 700   GSource source;
 701   GstBus *bus;
 702 } GstBusSource;
 703
 704 static gboolean
 705 gst_bus_source_prepare (GSource * source, gint * timeout)
 706 {
 707   *timeout = -1;
 708   return FALSE;
 709 }
 710
 711 static gboolean
 712 gst_bus_source_check (GSource * source)
 713 {
 714   GstBusSource *bsrc = (GstBusSource *) source;
 715
 716   return bsrc->bus->priv->pollfd.revents & (G_IO_IN | G_IO_HUP | G_IO_ERR);
 717 }
 718
 719 static gboolean
 720 gst_bus_source_dispatch (GSource * source, GSourceFunc callback,
 721     gpointer user_data)
 722 {
 723   GstBusFunc handler = (GstBusFunc) callback;
 724   GstBusSource *bsource = (GstBusSource *) source;
 725   GstMessage *message;
 726   gboolean keep;
 727   GstBus *bus;
 728
 729   g_return_val_if_fail (bsource != NULL, FALSE);
 730
 731   bus = bsource->bus;
 732
 733   g_return_val_if_fail (GST_IS_BUS (bus), FALSE);
 734
 735   message = gst_bus_pop (bus);
 736
 737   /* The message queue might be empty if some other thread or callback set
 738    * the bus to flushing between check/prepare and dispatch */
 739   if (G_UNLIKELY (message == NULL))
 740     return TRUE;
 741
 742   if (!handler)
 743     goto no_handler;
 744
 745   GST_DEBUG_OBJECT (bus, "source %p calling dispatch with %" GST_PTR_FORMAT,
 746       source, message);
 747
 748   keep = handler (bus, message, user_data);
 749   gst_message_unref (message);
 750
 751   GST_DEBUG_OBJECT (bus, "source %p handler returns %d", source, keep);
 752
 753   return keep;
 754
 755 no_handler:
 756   {
 757     g_warning ("GstBus watch dispatched without callback\n"
 758         "You must call g_source_set_callback().");
 759     gst_message_unref (message);
 760     return FALSE;
 761   }
 762 }
 763
 764 static void
 765 gst_bus_source_finalize (GSource * source)
 766 {
 767   GstBusSource *bsource = (GstBusSource *) source;
 768   GstBus *bus;
 769
 770   bus = bsource->bus;
 771
 772   GST_DEBUG_OBJECT (bus, "finalize source %p", source);
 773
 774   GST_OBJECT_LOCK (bus);
 775   if (bus->priv->watch_id == source)
 776     bus->priv->watch_id = NULL;
 777   GST_OBJECT_UNLOCK (bus);
 778
 779   gst_object_unref (bsource->bus);
 780   bsource->bus = NULL;
 781 }
 782
 783 static GSourceFuncs gst_bus_source_funcs = {
 784   gst_bus_source_prepare,
 785   gst_bus_source_check,
 786   gst_bus_source_dispatch,
 787   gst_bus_source_finalize
 788 };
 789
 790 /**
 791  * gst_bus_create_watch:
 792  * @bus: a #GstBus to create the watch for
 793  *
 794  * Create watch for this bus. The GSource will be dispatched whenever
 795  * a message is on the bus. After the GSource is dispatched, the
 796  * message is popped off the bus and unreffed.
 797  *
 798  * Returns: (transfer full): a #GSource that can be added to a mainloop.
 799  */
 800 GSource *
 801 gst_bus_create_watch (GstBus * bus)
 802 {
 803   GstBusSource *source;
 804
 805   g_return_val_if_fail (GST_IS_BUS (bus), NULL);
 806   g_return_val_if_fail (bus->priv->poll != NULL, NULL);
 807
 808   source = (GstBusSource *) g_source_new (&gst_bus_source_funcs,
 809       sizeof (GstBusSource));
 810
 811   g_source_set_name ((GSource *) source, "GStreamer message bus watch");
 812
 813   source->bus = gst_object_ref (bus);
 814   g_source_add_poll ((GSource *) source, &bus->priv->pollfd);
 815
 816   return (GSource *) source;
 817 }
 818
 819 /* must be called with the bus OBJECT LOCK */
 820 static guint
 821 gst_bus_add_watch_full_unlocked (GstBus * bus, gint priority,
 822     GstBusFunc func, gpointer user_data, GDestroyNotify notify)
 823 {
 824   GMainContext *ctx;
 825   guint id;
 826   GSource *source;
 827
 828   if (bus->priv->watch_id) {
 829     GST_ERROR_OBJECT (bus,
 830         "Tried to add new watch while one was already there");
 831     return 0;
 832   }
 833
 834   source = gst_bus_create_watch (bus);
 835
 836   if (priority != G_PRIORITY_DEFAULT)
 837     g_source_set_priority (source, priority);
 838
 839   g_source_set_callback (source, (GSourceFunc) func, user_data, notify);
 840
 841   ctx = g_main_context_get_thread_default ();
 842   id = g_source_attach (source, ctx);
 843   g_source_unref (source);
 844
 845   if (id) {
 846     bus->priv->watch_id = source;
 847   }
 848
 849   GST_DEBUG_OBJECT (bus, "New source %p with id %u", source, id);
 850   return id;
 851 }
 852
 853 /**
 854  * gst_bus_add_watch_full:
 855  * @bus: a #GstBus to create the watch for.
 856  * @priority: The priority of the watch.
 857  * @func: A function to call when a message is received.
 858  * @user_data: user data passed to @func.
 859  * @notify: the function to call when the source is removed.
 860  *
 861  * Adds a bus watch to the default main context with the given @priority (e.g.
 862  * %G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a non-default
 863  * main context set up using g_main_context_push_thread_default() (before
 864  * one had to create a bus watch source and attach it to the desired main
 865  * context 'manually').
 866  *
 867  * This function is used to receive asynchronous messages in the main loop.
 868  * There can only be a single bus watch per bus, you must remove it before you
 869  * can set a new one.
 870  *
 871  * When @func is called, the message belongs to the caller; if you want to
 872  * keep a copy of it, call gst_message_ref() before leaving @func.
 873  *
 874  * The watch can be removed using g_source_remove() or by returning FALSE
 875  * from @func.
 876  *
 877  * Returns: The event source id.
 878  * Rename to: gst_bus_add_watch
 879  * MT safe.
 880  */
 881 guint
 882 gst_bus_add_watch_full (GstBus * bus, gint priority,
 883     GstBusFunc func, gpointer user_data, GDestroyNotify notify)
 884 {
 885   guint id;
 886
 887   g_return_val_if_fail (GST_IS_BUS (bus), 0);
 888
 889   GST_OBJECT_LOCK (bus);
 890   id = gst_bus_add_watch_full_unlocked (bus, priority, func, user_data, notify);
 891   GST_OBJECT_UNLOCK (bus);
 892
 893   return id;
 894 }
 895
 896 /**
 897  * gst_bus_add_watch: (skip)
 898  * @bus: a #GstBus to create the watch for
 899  * @func: A function to call when a message is received.
 900  * @user_data: user data passed to @func.
 901  *
 902  * Adds a bus watch to the default main context with the default priority
 903  * (%G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a non-default
 904  * main context set up using g_main_context_push_thread_default() (before
 905  * one had to create a bus watch source and attach it to the desired main
 906  * context 'manually').
 907  *
 908  * This function is used to receive asynchronous messages in the main loop.
 909  * There can only be a single bus watch per bus, you must remove it before you
 910  * can set a new one.
 911  *
 912  * The watch can be removed using g_source_remove() or by returning FALSE
 913  * from @func.
 914  *
 915  * Returns: The event source id.
 916  *
 917  * MT safe.
 918  */
 919 guint
 920 gst_bus_add_watch (GstBus * bus, GstBusFunc func, gpointer user_data)
 921 {
 922   return gst_bus_add_watch_full (bus, G_PRIORITY_DEFAULT, func,
 923       user_data, NULL);
 924 }
 925
 926 typedef struct
 927 {
 928   GMainLoop *loop;
 929   guint timeout_id;
 930   gboolean source_running;
 931   GstMessageType events;
 932   GstMessage *message;
 933 } GstBusPollData;
 934
 935 static void
 936 poll_func (GstBus * bus, GstMessage * message, GstBusPollData * poll_data)
 937 {
 938   GstMessageType type;
 939
 940   if (!g_main_loop_is_running (poll_data->loop)) {
 941     GST_DEBUG ("mainloop %p not running", poll_data->loop);
 942     return;
 943   }
 944
 945   type = GST_MESSAGE_TYPE (message);
 946
 947   if (type & poll_data->events) {
 948     g_assert (poll_data->message == NULL);
 949     /* keep ref to message */
 950     poll_data->message = gst_message_ref (message);
 951     GST_DEBUG ("mainloop %p quit", poll_data->loop);
 952     g_main_loop_quit (poll_data->loop);
 953   } else {
 954     GST_DEBUG ("type %08x does not match %08x", type, poll_data->events);
 955   }
 956 }
 957
 958 static gboolean
 959 poll_timeout (GstBusPollData * poll_data)
 960 {
 961   GST_DEBUG ("mainloop %p quit", poll_data->loop);
 962   g_main_loop_quit (poll_data->loop);
 963
 964   /* we don't remove the GSource as this would free our poll_data,
 965    * which we still need */
 966   return TRUE;
 967 }
 968
 969 static void
 970 poll_destroy (GstBusPollData * poll_data, gpointer unused)
 971 {
 972   poll_data->source_running = FALSE;
 973   if (!poll_data->timeout_id) {
 974     g_main_loop_unref (poll_data->loop);
 975     g_slice_free (GstBusPollData, poll_data);
 976   }
 977 }
 978
 979 static void
 980 poll_destroy_timeout (GstBusPollData * poll_data)
 981 {
 982   poll_data->timeout_id = 0;
 983   if (!poll_data->source_running) {
 984     g_main_loop_unref (poll_data->loop);
 985     g_slice_free (GstBusPollData, poll_data);
 986   }
 987 }
 988
 989 /**
 990  * gst_bus_poll:
 991  * @bus: a #GstBus
 992  * @events: a mask of #GstMessageType, representing the set of message types to
 993  * poll for.
 994  * @timeout: the poll timeout, as a #GstClockTime, or #GST_CLOCK_TIME_NONE to poll
 995  * indefinitely.
 996  *
 997  * Poll the bus for messages. Will block while waiting for messages to come.
 998  * You can specify a maximum time to poll with the @timeout parameter. If
 999  * @timeout is negative, this function will block indefinitely.
1000  *
1001  * All messages not in @events will be popped off the bus and will be ignored.
1002  *
1003  * Because poll is implemented using the "message" signal enabled by
1004  * gst_bus_add_signal_watch(), calling gst_bus_poll() will cause the "message"
1005  * signal to be emitted for every message that poll sees. Thus a "message"
1006  * signal handler will see the same messages that this function sees -- neither
1007  * will steal messages from the other.
1008  *
1009  * This function will run a main loop from the default main context when
1010  * polling.
1011  *
1012  * You should never use this function, since it is pure evil. This is
1013  * especially true for GUI applications based on Gtk+ or Qt, but also for any
1014  * other non-trivial application that uses the GLib main loop. As this function
1015  * runs a GLib main loop, any callback attached to the default GLib main
1016  * context may be invoked. This could be timeouts, GUI events, I/O events etc.;
1017  * even if gst_bus_poll() is called with a 0 timeout. Any of these callbacks
1018  * may do things you do not expect, e.g. destroy the main application window or
1019  * some other resource; change other application state; display a dialog and
1020  * run another main loop until the user clicks it away. In short, using this
1021  * function may add a lot of complexity to your code through unexpected
1022  * re-entrancy and unexpected changes to your application's state.
1023  *
1024  * For 0 timeouts use gst_bus_pop_filtered() instead of this function; for
1025  * other short timeouts use gst_bus_timed_pop_filtered(); everything else is
1026  * better handled by setting up an asynchronous bus watch and doing things
1027  * from there.
1028  *
1029  * Returns: (transfer full): the message that was received, or NULL if the
1030  *     poll timed out. The message is taken from the bus and needs to be
1031  *     unreffed with gst_message_unref() after usage.
1032  */
1033 GstMessage *
1034 gst_bus_poll (GstBus * bus, GstMessageType events, GstClockTime timeout)
1035 {
1036   GstBusPollData *poll_data;
1037   GstMessage *ret;
1038   gulong id;
1039
1040   poll_data = g_slice_new (GstBusPollData);
1041   poll_data->source_running = TRUE;
1042   poll_data->loop = g_main_loop_new (NULL, FALSE);
1043   poll_data->events = events;
1044   poll_data->message = NULL;
1045
1046   if (timeout != GST_CLOCK_TIME_NONE)
1047     poll_data->timeout_id = g_timeout_add_full (G_PRIORITY_DEFAULT_IDLE,
1048         timeout / GST_MSECOND, (GSourceFunc) poll_timeout, poll_data,
1049         (GDestroyNotify) poll_destroy_timeout);
1050   else
1051     poll_data->timeout_id = 0;
1052
1053   id = g_signal_connect_data (bus, "message", G_CALLBACK (poll_func), poll_data,
1054       (GClosureNotify) poll_destroy, 0);
1055
1056   /* these can be nested, so it's ok */
1057   gst_bus_add_signal_watch (bus);
1058
1059   GST_DEBUG ("running mainloop %p", poll_data->loop);
1060   g_main_loop_run (poll_data->loop);
1061   GST_DEBUG ("mainloop stopped %p", poll_data->loop);
1062
1063   gst_bus_remove_signal_watch (bus);
1064
1065   /* holds a ref */
1066   ret = poll_data->message;
1067
1068   if (poll_data->timeout_id)
1069     g_source_remove (poll_data->timeout_id);
1070
1071   /* poll_data will be freed now */
1072   g_signal_handler_disconnect (bus, id);
1073
1074   GST_DEBUG_OBJECT (bus, "finished poll with message %p", ret);
1075
1076   return ret;
1077 }
1078
1079 /**
1080  * gst_bus_async_signal_func:
1081  * @bus: a #GstBus
1082  * @message: the #GstMessage received
1083  * @data: user data
1084  *
1085  * A helper #GstBusFunc that can be used to convert all asynchronous messages
1086  * into signals.
1087  *
1088  * Returns: TRUE
1089  */
1090 gboolean
1091 gst_bus_async_signal_func (GstBus * bus, GstMessage * message, gpointer data)
1092 {
1093   GQuark detail = 0;
1094
1095   g_return_val_if_fail (GST_IS_BUS (bus), TRUE);
1096   g_return_val_if_fail (message != NULL, TRUE);
1097
1098   detail = gst_message_type_to_quark (GST_MESSAGE_TYPE (message));
1099
1100   g_signal_emit (bus, gst_bus_signals[ASYNC_MESSAGE], detail, message);
1101
1102   /* we never remove this source based on signal emission return values */
1103   return TRUE;
1104 }
1105
1106 /**
1107  * gst_bus_sync_signal_handler:
1108  * @bus: a #GstBus
1109  * @message: the #GstMessage received
1110  * @data: user data
1111  *
1112  * A helper GstBusSyncHandler that can be used to convert all synchronous
1113  * messages into signals.
1114  *
1115  * Returns: GST_BUS_PASS
1116  */
1117 GstBusSyncReply
1118 gst_bus_sync_signal_handler (GstBus * bus, GstMessage * message, gpointer data)
1119 {
1120   GQuark detail = 0;
1121
1122   g_return_val_if_fail (GST_IS_BUS (bus), GST_BUS_DROP);
1123   g_return_val_if_fail (message != NULL, GST_BUS_DROP);
1124
1125   detail = gst_message_type_to_quark (GST_MESSAGE_TYPE (message));
1126
1127   g_signal_emit (bus, gst_bus_signals[SYNC_MESSAGE], detail, message);
1128
1129   return GST_BUS_PASS;
1130 }
1131
1132 /**
1133  * gst_bus_enable_sync_message_emission:
1134  * @bus: a #GstBus on which you want to receive the "sync-message" signal
1135  *
1136  * Instructs GStreamer to emit the "sync-message" signal after running the bus's
1137  * sync handler. This function is here so that code can ensure that they can
1138  * synchronously receive messages without having to affect what the bin's sync
1139  * handler is.
1140  *
1141  * This function may be called multiple times. To clean up, the caller is
1142  * responsible for calling gst_bus_disable_sync_message_emission() as many times
1143  * as this function is called.
1144  *
1145  * While this function looks similar to gst_bus_add_signal_watch(), it is not
1146  * exactly the same -- this function enables <emphasis>synchronous</emphasis> emission of
1147  * signals when messages arrive; gst_bus_add_signal_watch() adds an idle callback
1148  * to pop messages off the bus <emphasis>asynchronously</emphasis>. The sync-message signal
1149  * comes from the thread of whatever object posted the message; the "message"
1150  * signal is marshalled to the main thread via the main loop.
1151  *
1152  * MT safe.
1153  */
1154 void
1155 gst_bus_enable_sync_message_emission (GstBus * bus)
1156 {
1157   g_return_if_fail (GST_IS_BUS (bus));
1158
1159   GST_OBJECT_LOCK (bus);
1160   bus->priv->num_sync_message_emitters++;
1161   GST_OBJECT_UNLOCK (bus);
1162 }
1163
1164 /**
1165  * gst_bus_disable_sync_message_emission:
1166  * @bus: a #GstBus on which you previously called
1167  * gst_bus_enable_sync_message_emission()
1168  *
1169  * Instructs GStreamer to stop emitting the "sync-message" signal for this bus.
1170  * See gst_bus_enable_sync_message_emission() for more information.
1171  *
1172  * In the event that multiple pieces of code have called
1173  * gst_bus_enable_sync_message_emission(), the sync-message emissions will only
1174  * be stopped after all calls to gst_bus_enable_sync_message_emission() were
1175  * "cancelled" by calling this function. In this way the semantics are exactly
1176  * the same as gst_object_ref() that which calls enable should also call
1177  * disable.
1178  *
1179  * MT safe.
1180  */
1181 void
1182 gst_bus_disable_sync_message_emission (GstBus * bus)
1183 {
1184   g_return_if_fail (GST_IS_BUS (bus));
1185   g_return_if_fail (bus->priv->num_signal_watchers == 0);
1186
1187   GST_OBJECT_LOCK (bus);
1188   bus->priv->num_sync_message_emitters--;
1189   GST_OBJECT_UNLOCK (bus);
1190 }
1191
1192 /**
1193  * gst_bus_add_signal_watch_full:
1194  * @bus: a #GstBus on which you want to receive the "message" signal
1195  * @priority: The priority of the watch.
1196  *
1197  * Adds a bus signal watch to the default main context with the given @priority
1198  * (e.g. %G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a
1199  * non-default main context set up using g_main_context_push_thread_default()
1200  * (before one had to create a bus watch source and attach it to the desired
1201  * main context 'manually').
1202  *
1203  * After calling this statement, the bus will emit the "message" signal for each
1204  * message posted on the bus when the main loop is running.
1205  *
1206  * This function may be called multiple times. To clean up, the caller is
1207  * responsible for calling gst_bus_remove_signal_watch() as many times as this
1208  * function is called.
1209  *
1210  * There can only be a single bus watch per bus, you must remove any signal
1211  * watch before you can set another type of watch.
1212  *
1213  * MT safe.
1214  */
1215 void
1216 gst_bus_add_signal_watch_full (GstBus * bus, gint priority)
1217 {
1218   g_return_if_fail (GST_IS_BUS (bus));
1219
1220   /* I know the callees don't take this lock, so go ahead and abuse it */
1221   GST_OBJECT_LOCK (bus);
1222
1223   if (bus->priv->num_signal_watchers > 0)
1224     goto done;
1225
1226   /* this should not fail because the counter above takes care of it */
1227   g_assert (bus->priv->signal_watch_id == 0);
1228
1229   bus->priv->signal_watch_id =
1230       gst_bus_add_watch_full_unlocked (bus, priority, gst_bus_async_signal_func,
1231       NULL, NULL);
1232
1233   if (G_UNLIKELY (bus->priv->signal_watch_id == 0))
1234     goto add_failed;
1235
1236 done:
1237
1238   bus->priv->num_signal_watchers++;
1239
1240   GST_OBJECT_UNLOCK (bus);
1241   return;
1242
1243   /* ERRORS */
1244 add_failed:
1245   {
1246     g_critical ("Could not add signal watch to bus %s", GST_OBJECT_NAME (bus));
1247     GST_OBJECT_UNLOCK (bus);
1248     return;
1249   }
1250 }
1251
1252 /**
1253  * gst_bus_add_signal_watch:
1254  * @bus: a #GstBus on which you want to receive the "message" signal
1255  *
1256  * Adds a bus signal watch to the default main context with the default priority
1257  * (%G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a non-default
1258  * main context set up using g_main_context_push_thread_default() (before
1259  * one had to create a bus watch source and attach it to the desired main
1260  * context 'manually').
1261  *
1262  * After calling this statement, the bus will emit the "message" signal for each
1263  * message posted on the bus.
1264  *
1265  * This function may be called multiple times. To clean up, the caller is
1266  * responsible for calling gst_bus_remove_signal_watch() as many times as this
1267  * function is called.
1268  *
1269  * MT safe.
1270  */
1271 void
1272 gst_bus_add_signal_watch (GstBus * bus)
1273 {
1274   gst_bus_add_signal_watch_full (bus, G_PRIORITY_DEFAULT);
1275 }
1276
1277 /**
1278  * gst_bus_remove_signal_watch:
1279  * @bus: a #GstBus you previously added a signal watch to
1280  *
1281  * Removes a signal watch previously added with gst_bus_add_signal_watch().
1282  *
1283  * MT safe.
1284  */
1285 void
1286 gst_bus_remove_signal_watch (GstBus * bus)
1287 {
1288   guint id = 0;
1289
1290   g_return_if_fail (GST_IS_BUS (bus));
1291
1292   /* I know the callees don't take this lock, so go ahead and abuse it */
1293   GST_OBJECT_LOCK (bus);
1294
1295   if (bus->priv->num_signal_watchers == 0)
1296     goto error;
1297
1298   bus->priv->num_signal_watchers--;
1299
1300   if (bus->priv->num_signal_watchers > 0)
1301     goto done;
1302
1303   id = bus->priv->signal_watch_id;
1304   bus->priv->signal_watch_id = 0;
1305
1306   GST_DEBUG_OBJECT (bus, "removing signal watch %u", id);
1307
1308 done:
1309   GST_OBJECT_UNLOCK (bus);
1310
1311   if (id)
1312     g_source_remove (id);
1313
1314   return;
1315
1316   /* ERRORS */
1317 error:
1318   {
1319     g_critical ("Bus %s has no signal watches attached", GST_OBJECT_NAME (bus));
1320     GST_OBJECT_UNLOCK (bus);
1321     return;
1322   }
1323 }