*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
/**
*
* Note that a #GstPipeline will set its bus into flushing state when changing
* from READY to NULL state.
- *
- * Last reviewed on 2006-03-12 (0.10.5)
*/
#include "gst_private.h"
#endif
#include <sys/types.h>
+#include "gstatomicqueue.h"
#include "gstinfo.h"
#include "gstpoll.h"
};
static void gst_bus_dispose (GObject * object);
+static void gst_bus_finalize (GObject * object);
static guint gst_bus_signals[LAST_SIGNAL] = { 0 };
struct _GstBusPrivate
{
+ GstAtomicQueue *queue;
+ GMutex queue_lock;
+
+ GstBusSyncHandler sync_handler;
+ gpointer sync_handler_data;
+ GDestroyNotify sync_handler_notify;
+
+ guint signal_watch_id;
+ guint num_signal_watchers;
+
guint num_sync_message_emitters;
GSource *watch_id;
GObjectClass *gobject_class = (GObjectClass *) klass;
gobject_class->dispose = gst_bus_dispose;
+ gobject_class->finalize = gst_bus_finalize;
gobject_class->set_property = gst_bus_set_property;
gobject_class->constructed = gst_bus_constructed;
- /* GstBus:enable-async:
+ /**
+ * GstBus::enable-async:
*
* Enable async message delivery support for bus watches,
* gst_bus_pop() and similar API. Without this only the
*
* This property is used to create the child element buses
* in #GstBin.
- *
- * Since: 0.10.33
*/
g_object_class_install_property (gobject_class, PROP_ENABLE_ASYNC,
g_param_spec_boolean ("enable-async", "Enable Async",
* A message has been posted on the bus. This signal is emitted from the
* thread that posted the message so one has to be careful with locking.
*
- * This signal will not be emitted by default, you have to set up
- * gst_bus_sync_signal_handler() as a sync handler if you want this
- * signal to be emitted when a message is posted on the bus, like this:
- * <programlisting>
- * gst_bus_set_sync_handler (bus, gst_bus_sync_signal_handler, yourdata);
- * </programlisting>
+ * This signal will not be emitted by default, you have to call
+ * gst_bus_enable_sync_message_emission() before.
*/
gst_bus_signals[SYNC_MESSAGE] =
g_signal_new ("sync-message", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
G_STRUCT_OFFSET (GstBusClass, sync_message), NULL, NULL,
- g_cclosure_marshal_VOID__BOXED, G_TYPE_NONE, 1, GST_TYPE_MESSAGE);
+ g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_MESSAGE);
/**
* GstBus::message:
g_signal_new ("message", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
G_STRUCT_OFFSET (GstBusClass, message), NULL, NULL,
- g_cclosure_marshal_VOID__BOXED, G_TYPE_NONE, 1, GST_TYPE_MESSAGE);
+ g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_MESSAGE);
g_type_class_add_private (klass, sizeof (GstBusPrivate));
}
static void
gst_bus_init (GstBus * bus)
{
- bus->queue = gst_atomic_queue_new (32);
- bus->queue_lock = g_mutex_new ();
-
bus->priv = G_TYPE_INSTANCE_GET_PRIVATE (bus, GST_TYPE_BUS, GstBusPrivate);
bus->priv->enable_async = DEFAULT_ENABLE_ASYNC;
+ g_mutex_init (&bus->priv->queue_lock);
+ bus->priv->queue = gst_atomic_queue_new (32);
+
+ /* clear floating flag */
+ gst_object_ref_sink (bus);
GST_DEBUG_OBJECT (bus, "created");
}
{
GstBus *bus = GST_BUS (object);
- if (bus->queue) {
+ if (bus->priv->queue) {
GstMessage *message;
- g_mutex_lock (bus->queue_lock);
+ g_mutex_lock (&bus->priv->queue_lock);
do {
- message = gst_atomic_queue_pop (bus->queue);
+ message = gst_atomic_queue_pop (bus->priv->queue);
if (message)
gst_message_unref (message);
} while (message != NULL);
- gst_atomic_queue_unref (bus->queue);
- bus->queue = NULL;
- g_mutex_unlock (bus->queue_lock);
- g_mutex_free (bus->queue_lock);
- bus->queue_lock = NULL;
+ gst_atomic_queue_unref (bus->priv->queue);
+ bus->priv->queue = NULL;
+ g_mutex_unlock (&bus->priv->queue_lock);
+ g_mutex_clear (&bus->priv->queue_lock);
if (bus->priv->poll)
gst_poll_free (bus->priv->poll);
G_OBJECT_CLASS (parent_class)->dispose (object);
}
+static void
+gst_bus_finalize (GObject * object)
+{
+ GstBus *bus = GST_BUS (object);
+
+ if (bus->priv->sync_handler_notify)
+ bus->priv->sync_handler_notify (bus->priv->sync_handler_data);
+
+ G_OBJECT_CLASS (parent_class)->finalize (object);
+}
+
/**
* gst_bus_new:
*
* Post a message on the given bus. Ownership of the message
* is taken by the bus.
*
- * Returns: TRUE if the message could be posted, FALSE if the bus is flushing.
+ * Returns: %TRUE if the message could be posted, %FALSE if the bus is flushing.
*
* MT safe.
*/
if (GST_OBJECT_FLAG_IS_SET (bus, GST_BUS_FLUSHING))
goto is_flushing;
- handler = bus->sync_handler;
- handler_data = bus->sync_handler_data;
+ handler = bus->priv->sync_handler;
+ handler_data = bus->priv->sync_handler_data;
emit_sync_message = bus->priv->num_sync_message_emitters > 0;
GST_OBJECT_UNLOCK (bus);
case GST_BUS_PASS:
/* pass the message to the async queue, refcount passed in the queue */
GST_DEBUG_OBJECT (bus, "[msg %p] pushing on async queue", message);
- gst_atomic_queue_push (bus->queue, message);
+ gst_atomic_queue_push (bus->priv->queue, message);
gst_poll_write_control (bus->priv->poll);
GST_DEBUG_OBJECT (bus, "[msg %p] pushed on async queue", message);
{
/* async delivery, we need a mutex and a cond to block
* on */
- GMutex *lock = g_mutex_new ();
- GCond *cond = g_cond_new ();
+ GCond *cond = GST_MESSAGE_GET_COND (message);
+ GMutex *lock = GST_MESSAGE_GET_LOCK (message);
- GST_MESSAGE_COND (message) = cond;
- GST_MESSAGE_GET_LOCK (message) = lock;
+ g_cond_init (cond);
+ g_mutex_init (lock);
GST_DEBUG_OBJECT (bus, "[msg %p] waiting for async delivery", message);
* the cond will be signalled and we can continue */
g_mutex_lock (lock);
- gst_atomic_queue_push (bus->queue, message);
+ gst_atomic_queue_push (bus->priv->queue, message);
gst_poll_write_control (bus->priv->poll);
/* now block till the message is freed */
GST_DEBUG_OBJECT (bus, "[msg %p] delivered asynchronously", message);
- g_mutex_free (lock);
- g_cond_free (cond);
+ g_mutex_clear (lock);
+ g_cond_clear (cond);
break;
}
default:
* Check if there are pending messages on the bus that
* should be handled.
*
- * Returns: TRUE if there are messages on the bus to be handled, FALSE
+ * Returns: %TRUE if there are messages on the bus to be handled, %FALSE
* otherwise.
*
* MT safe.
g_return_val_if_fail (GST_IS_BUS (bus), FALSE);
/* see if there is a message on the bus */
- result = gst_atomic_queue_length (bus->queue) != 0;
+ result = gst_atomic_queue_length (bus->priv->queue) != 0;
return result;
}
*
* If @flushing, flush out and unref any messages queued in the bus. Releases
* references to the message origin objects. Will flush future messages until
- * gst_bus_set_flushing() sets @flushing to #FALSE.
+ * gst_bus_set_flushing() sets @flushing to %FALSE.
*
* MT safe.
*/
* matching message was posted on the bus.
*
* Returns: (transfer full): a #GstMessage matching the filter in @types,
- * or NULL if no matching message was found on the bus until the timeout
+ * or %NULL if no matching message was found on the bus until the timeout
* expired. The message is taken from the bus and needs to be unreffed
* with gst_message_unref() after usage.
*
* MT safe.
- *
- * Since: 0.10.15
*/
GstMessage *
gst_bus_timed_pop_filtered (GstBus * bus, GstClockTime timeout,
g_return_val_if_fail (types != 0, NULL);
g_return_val_if_fail (timeout == 0 || bus->priv->poll != NULL, NULL);
- g_mutex_lock (bus->queue_lock);
+ g_mutex_lock (&bus->priv->queue_lock);
while (TRUE) {
gint ret;
GST_LOG_OBJECT (bus, "have %d messages",
- gst_atomic_queue_length (bus->queue));
+ gst_atomic_queue_length (bus->priv->queue));
- while ((message = gst_atomic_queue_pop (bus->queue))) {
+ while ((message = gst_atomic_queue_pop (bus->priv->queue))) {
if (bus->priv->poll)
gst_poll_read_control (bus->priv->poll);
message, GST_MESSAGE_TYPE_NAME (message),
GST_MESSAGE_SRC_NAME (message), (guint) types);
if ((GST_MESSAGE_TYPE (message) & types) != 0) {
- /* exit the loop, we have a message */
- goto beach;
- } else {
- GST_DEBUG_OBJECT (bus, "discarding message, does not match mask");
- gst_message_unref (message);
- message = NULL;
+ /* Extra check to ensure extended types don't get matched unless
+ * asked for */
+ if ((GST_MESSAGE_TYPE_IS_EXTENDED (message) == FALSE)
+ || (types & GST_MESSAGE_EXTENDED)) {
+ /* exit the loop, we have a message */
+ goto beach;
+ }
}
+
+ GST_DEBUG_OBJECT (bus, "discarding message, does not match mask");
+ gst_message_unref (message);
+ message = NULL;
}
/* no need to wait, exit loop */
/* only here in timeout case */
g_assert (bus->priv->poll);
- g_mutex_unlock (bus->queue_lock);
+ g_mutex_unlock (&bus->priv->queue_lock);
ret = gst_poll_wait (bus->priv->poll, timeout - elapsed);
- g_mutex_lock (bus->queue_lock);
+ g_mutex_lock (&bus->priv->queue_lock);
if (ret == 0) {
GST_INFO_OBJECT (bus, "timed out, breaking loop");
beach:
- g_mutex_unlock (bus->queue_lock);
+ g_mutex_unlock (&bus->priv->queue_lock);
return message;
}
* posted on the bus.
*
* Returns: (transfer full): the #GstMessage that is on the bus after the
- * specified timeout or NULL if the bus is empty after the timeout expired.
+ * specified timeout or %NULL if the bus is empty after the timeout expired.
* The message is taken from the bus and needs to be unreffed with
* gst_message_unref() after usage.
*
* MT safe.
- *
- * Since: 0.10.12
*/
GstMessage *
gst_bus_timed_pop (GstBus * bus, GstClockTime timeout)
* Get a message matching @type from the bus. Will discard all messages on
* the bus that do not match @type and that have been posted before the first
* message that does match @type. If there is no message matching @type on
- * the bus, all messages will be discarded.
+ * the bus, all messages will be discarded. It is not possible to use message
+ * enums beyond #GST_MESSAGE_EXTENDED in the @events mask.
*
* Returns: (transfer full): the next #GstMessage matching @type that is on
- * the bus, or NULL if the bus is empty or there is no message matching
+ * the bus, or %NULL if the bus is empty or there is no message matching
* @type. The message is taken from the bus and needs to be unreffed with
* gst_message_unref() after usage.
*
* MT safe.
- *
- * Since: 0.10.15
*/
GstMessage *
gst_bus_pop_filtered (GstBus * bus, GstMessageType types)
*
* Get a message from the bus.
*
- * Returns: (transfer full): the #GstMessage that is on the bus, or NULL if the
+ * Returns: (transfer full): the #GstMessage that is on the bus, or %NULL if the
* bus is empty. The message is taken from the bus and needs to be unreffed
* with gst_message_unref() after usage.
*
* on the bus' message queue. A reference is returned, and needs to be unreffed
* by the caller.
*
- * Returns: (transfer full): the #GstMessage that is on the bus, or NULL if the
+ * Returns: (transfer full): the #GstMessage that is on the bus, or %NULL if the
* bus is empty.
*
* MT safe.
g_return_val_if_fail (GST_IS_BUS (bus), NULL);
- g_mutex_lock (bus->queue_lock);
- message = gst_atomic_queue_peek (bus->queue);
+ g_mutex_lock (&bus->priv->queue_lock);
+ message = gst_atomic_queue_peek (bus->priv->queue);
if (message)
gst_message_ref (message);
- g_mutex_unlock (bus->queue_lock);
+ g_mutex_unlock (&bus->priv->queue_lock);
GST_DEBUG_OBJECT (bus, "peek on bus, got message %p", message);
/**
* gst_bus_set_sync_handler:
* @bus: a #GstBus to install the handler on
- * @func: The handler function to install
- * @data: User data that will be sent to the handler function.
+ * @func: (allow-none): The handler function to install
+ * @user_data: User data that will be sent to the handler function.
+ * @notify: called when @user_data becomes unused
*
* Sets the synchronous handler on the bus. The function will be called
* every time a new message is posted on the bus. Note that the function
* should handle messages asynchronously using the gst_bus watch and poll
* functions.
*
- * You cannot replace an existing sync_handler. You can pass NULL to this
+ * You cannot replace an existing sync_handler. You can pass %NULL to this
* function, which will clear the existing handler.
*/
void
-gst_bus_set_sync_handler (GstBus * bus, GstBusSyncHandler func, gpointer data)
+gst_bus_set_sync_handler (GstBus * bus, GstBusSyncHandler func,
+ gpointer user_data, GDestroyNotify notify)
{
+ GDestroyNotify old_notify;
+
g_return_if_fail (GST_IS_BUS (bus));
GST_OBJECT_LOCK (bus);
-
/* Assert if the user attempts to replace an existing sync_handler,
* other than to clear it */
- if (func != NULL && bus->sync_handler != NULL)
+ if (func != NULL && bus->priv->sync_handler != NULL)
goto no_replace;
- bus->sync_handler = func;
- bus->sync_handler_data = data;
+ if ((old_notify = bus->priv->sync_handler_notify)) {
+ gpointer old_data = bus->priv->sync_handler_data;
+
+ bus->priv->sync_handler_data = NULL;
+ bus->priv->sync_handler_notify = NULL;
+ GST_OBJECT_UNLOCK (bus);
+
+ old_notify (old_data);
+
+ GST_OBJECT_LOCK (bus);
+ }
+ bus->priv->sync_handler = func;
+ bus->priv->sync_handler_data = user_data;
+ bus->priv->sync_handler_notify = notify;
GST_OBJECT_UNLOCK (bus);
return;
source = (GstBusSource *) g_source_new (&gst_bus_source_funcs,
sizeof (GstBusSource));
-#if GLIB_CHECK_VERSION(2,26,0)
g_source_set_name ((GSource *) source, "GStreamer message bus watch");
-#endif
source->bus = gst_object_ref (bus);
g_source_add_poll ((GSource *) source, &bus->priv->pollfd);
* @notify: the function to call when the source is removed.
*
* Adds a bus watch to the default main context with the given @priority (e.g.
- * %G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a non-default
- * main context set up using g_main_context_push_thread_default() (before
+ * %G_PRIORITY_DEFAULT). It is also possible to use a non-default main
+ * context set up using g_main_context_push_thread_default() (before
* one had to create a bus watch source and attach it to the desired main
* context 'manually').
*
* When @func is called, the message belongs to the caller; if you want to
* keep a copy of it, call gst_message_ref() before leaving @func.
*
- * The watch can be removed using g_source_remove() or by returning FALSE
+ * The watch can be removed using g_source_remove() or by returning %FALSE
* from @func.
*
+ * MT safe.
+ *
* Returns: The event source id.
* Rename to: gst_bus_add_watch
- * MT safe.
*/
guint
gst_bus_add_watch_full (GstBus * bus, gint priority,
* @user_data: user data passed to @func.
*
* Adds a bus watch to the default main context with the default priority
- * (%G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a non-default
- * main context set up using g_main_context_push_thread_default() (before
+ * (%G_PRIORITY_DEFAULT). It is also possible to use a non-default main
+ * context set up using g_main_context_push_thread_default() (before
* one had to create a bus watch source and attach it to the desired main
* context 'manually').
*
* There can only be a single bus watch per bus, you must remove it before you
* can set a new one.
*
- * The watch can be removed using g_source_remove() or by returning FALSE
+ * The watch can be removed using g_source_remove() or by returning %FALSE
* from @func.
*
* Returns: The event source id.
* gst_bus_poll:
* @bus: a #GstBus
* @events: a mask of #GstMessageType, representing the set of message types to
- * poll for.
- * @timeout: the poll timeout, as a #GstClockTimeDiff, or -1 to poll
+ * poll for (note special handling of extended message types below)
+ * @timeout: the poll timeout, as a #GstClockTime, or #GST_CLOCK_TIME_NONE to poll
* indefinitely.
*
* Poll the bus for messages. Will block while waiting for messages to come.
* @timeout is negative, this function will block indefinitely.
*
* All messages not in @events will be popped off the bus and will be ignored.
+ * It is not possible to use message enums beyond #GST_MESSAGE_EXTENDED in the
+ * @events mask
*
* Because poll is implemented using the "message" signal enabled by
* gst_bus_add_signal_watch(), calling gst_bus_poll() will cause the "message"
* better handled by setting up an asynchronous bus watch and doing things
* from there.
*
- * Returns: (transfer full): the message that was received, or NULL if the
+ * Returns: (transfer full): the message that was received, or %NULL if the
* poll timed out. The message is taken from the bus and needs to be
* unreffed with gst_message_unref() after usage.
*/
GstMessage *
-gst_bus_poll (GstBus * bus, GstMessageType events, GstClockTimeDiff timeout)
+gst_bus_poll (GstBus * bus, GstMessageType events, GstClockTime timeout)
{
GstBusPollData *poll_data;
GstMessage *ret;
poll_data->events = events;
poll_data->message = NULL;
- if (timeout >= 0)
+ if (timeout != GST_CLOCK_TIME_NONE)
poll_data->timeout_id = g_timeout_add_full (G_PRIORITY_DEFAULT_IDLE,
timeout / GST_MSECOND, (GSourceFunc) poll_timeout, poll_data,
(GDestroyNotify) poll_destroy_timeout);
* A helper #GstBusFunc that can be used to convert all asynchronous messages
* into signals.
*
- * Returns: TRUE
+ * Returns: %TRUE
*/
gboolean
gst_bus_async_signal_func (GstBus * bus, GstMessage * message, gpointer data)
gst_bus_disable_sync_message_emission (GstBus * bus)
{
g_return_if_fail (GST_IS_BUS (bus));
- g_return_if_fail (bus->num_signal_watchers == 0);
+ g_return_if_fail (bus->priv->num_sync_message_emitters > 0);
GST_OBJECT_LOCK (bus);
bus->priv->num_sync_message_emitters--;
* @priority: The priority of the watch.
*
* Adds a bus signal watch to the default main context with the given @priority
- * (e.g. %G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a
- * non-default main context set up using g_main_context_push_thread_default()
+ * (e.g. %G_PRIORITY_DEFAULT). It is also possible to use a non-default main
+ * context set up using g_main_context_push_thread_default()
* (before one had to create a bus watch source and attach it to the desired
* main context 'manually').
*
/* I know the callees don't take this lock, so go ahead and abuse it */
GST_OBJECT_LOCK (bus);
- if (bus->num_signal_watchers > 0)
+ if (bus->priv->num_signal_watchers > 0)
goto done;
/* this should not fail because the counter above takes care of it */
- g_assert (bus->signal_watch_id == 0);
+ g_assert (bus->priv->signal_watch_id == 0);
- bus->signal_watch_id =
+ bus->priv->signal_watch_id =
gst_bus_add_watch_full_unlocked (bus, priority, gst_bus_async_signal_func,
NULL, NULL);
- if (G_UNLIKELY (bus->signal_watch_id == 0))
+ if (G_UNLIKELY (bus->priv->signal_watch_id == 0))
goto add_failed;
done:
- bus->num_signal_watchers++;
+ bus->priv->num_signal_watchers++;
GST_OBJECT_UNLOCK (bus);
return;
* @bus: a #GstBus on which you want to receive the "message" signal
*
* Adds a bus signal watch to the default main context with the default priority
- * (%G_PRIORITY_DEFAULT). Since 0.10.33 it is also possible to use a non-default
+ * (%G_PRIORITY_DEFAULT). It is also possible to use a non-default
* main context set up using g_main_context_push_thread_default() (before
* one had to create a bus watch source and attach it to the desired main
* context 'manually').
/* I know the callees don't take this lock, so go ahead and abuse it */
GST_OBJECT_LOCK (bus);
- if (bus->num_signal_watchers == 0)
+ if (bus->priv->num_signal_watchers == 0)
goto error;
- bus->num_signal_watchers--;
+ bus->priv->num_signal_watchers--;
- if (bus->num_signal_watchers > 0)
+ if (bus->priv->num_signal_watchers > 0)
goto done;
- id = bus->signal_watch_id;
- bus->signal_watch_id = 0;
+ id = bus->priv->signal_watch_id;
+ bus->priv->signal_watch_id = 0;
GST_DEBUG_OBJECT (bus, "removing signal watch %u", id);
projects / platform / upstream / gstreamer.git / blobdiff