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