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