3 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
4 * 2004 Wim Taymans <wim.taymans@gmail.com>
6 * gstbin.c: GstBin container object and support code
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
28 * @short_description: Base class and element that can contain other elements
30 * #GstBin is an element that can contain other #GstElement, allowing them to be
32 * Pads from the child elements can be ghosted to the bin, see #GstGhostPad.
33 * This makes the bin look like any other elements and enables creation of
34 * higher-level abstraction elements.
36 * A new #GstBin is created with gst_bin_new(). Use a #GstPipeline instead if you
37 * want to create a toplevel bin because a normal bin doesn't have a bus or
38 * handle clock distribution of its own.
40 * After the bin has been created you will typically add elements to it with
41 * gst_bin_add(). You can remove elements with gst_bin_remove().
43 * An element can be retrieved from a bin with gst_bin_get_by_name(), using the
44 * elements name. gst_bin_get_by_name_recurse_up() is mainly used for internal
45 * purposes and will query the parent bins when the element is not found in the
48 * An iterator of elements in a bin can be retrieved with
49 * gst_bin_iterate_elements(). Various other iterators exist to retrieve the
52 * gst_object_unref() is used to drop your reference to the bin.
54 * The #GstBin::element-added signal is fired whenever a new element is added to
55 * the bin. Likewise the #GstBin::element-removed signal is fired whenever an
56 * element is removed from the bin.
58 * <refsect2><title>Notes</title>
60 * A #GstBin internally intercepts every #GstMessage posted by its children and
61 * implements the following default behaviour for each of them:
64 * <term>GST_MESSAGE_EOS</term>
65 * <listitem><para>This message is only posted by sinks in the PLAYING
66 * state. If all sinks posted the EOS message, this bin will post and EOS
67 * message upwards.</para></listitem>
70 * <term>GST_MESSAGE_SEGMENT_START</term>
71 * <listitem><para>just collected and never forwarded upwards.
72 * The messages are used to decide when all elements have completed playback
73 * of their segment.</para></listitem>
76 * <term>GST_MESSAGE_SEGMENT_DONE</term>
77 * <listitem><para> Is posted by #GstBin when all elements that posted
78 * a SEGMENT_START have posted a SEGMENT_DONE.</para></listitem>
81 * <term>GST_MESSAGE_DURATION_CHANGED</term>
82 * <listitem><para> Is posted by an element that detected a change
83 * in the stream duration. The default bin behaviour is to clear any
84 * cached duration values so that the next duration query will perform
85 * a full duration recalculation. The duration change is posted to the
86 * application so that it can refetch the new duration with a duration
87 * query. Note that these messages can be posted before the bin is
88 * prerolled, in which case the duration query might fail.
92 * <term>GST_MESSAGE_CLOCK_LOST</term>
93 * <listitem><para> This message is posted by an element when it
94 * can no longer provide a clock. The default bin behaviour is to
95 * check if the lost clock was the one provided by the bin. If so and
96 * the bin is currently in the PLAYING state, the message is forwarded to
98 * This message is also generated when a clock provider is removed from
99 * the bin. If this message is received by the application, it should
100 * PAUSE the pipeline and set it back to PLAYING to force a new clock
105 * <term>GST_MESSAGE_CLOCK_PROVIDE</term>
106 * <listitem><para> This message is generated when an element
107 * can provide a clock. This mostly happens when a new clock
108 * provider is added to the bin. The default behaviour of the bin is to
109 * mark the currently selected clock as dirty, which will perform a clock
110 * recalculation the next time the bin is asked to provide a clock.
111 * This message is never sent tot the application but is forwarded to
112 * the parent of the bin.
116 * <term>OTHERS</term>
117 * <listitem><para> posted upwards.</para></listitem>
122 * A #GstBin implements the following default behaviour for answering to a
126 * <term>GST_QUERY_DURATION</term>
127 * <listitem><para>If the query has been asked before with the same format
128 * and the bin is a toplevel bin (ie. has no parent),
129 * use the cached previous value. If no previous value was cached, the
130 * query is sent to all sink elements in the bin and the MAXIMUM of all
131 * values is returned. If the bin is a toplevel bin the value is cached.
132 * If no sinks are available in the bin, the query fails.
136 * <term>GST_QUERY_POSITION</term>
137 * <listitem><para>The query is sent to all sink elements in the bin and the
138 * MAXIMUM of all values is returned. If no sinks are available in the bin,
143 * <term>OTHERS</term>
144 * <listitem><para>the query is forwarded to all sink elements, the result
145 * of the first sink that answers the query successfully is returned. If no
146 * sink is in the bin, the query fails.</para></listitem>
150 * A #GstBin will by default forward any event sent to it to all sink elements.
151 * If all the sinks return TRUE, the bin will also return TRUE, else FALSE is
152 * returned. If no sinks are in the bin, the event handler will return TRUE.
157 * Last reviewed on 2012-03-28 (0.11.3)
160 #include "gst_private.h"
162 #include "gstevent.h"
165 #include "gsterror.h"
167 #include "gstutils.h"
168 #include "gstchildproxy.h"
170 GST_DEBUG_CATEGORY_STATIC (bin_debug);
171 #define GST_CAT_DEFAULT bin_debug
173 /* a bin is toplevel if it has no parent or when it is configured to behave like
175 #define BIN_IS_TOPLEVEL(bin) ((GST_OBJECT_PARENT (bin) == NULL) || bin->priv->asynchandling)
177 #define GST_BIN_GET_PRIVATE(obj) \
178 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BIN, GstBinPrivate))
180 struct _GstBinPrivate
182 gboolean asynchandling;
183 /* if we get an ASYNC_DONE message from ourselves, this means that the
184 * subclass will simulate ASYNC behaviour without having ASYNC children. When
185 * such an ASYNC_DONE message is posted while we are doing a state change, we
186 * have to process the message after finishing the state change even when no
187 * child returned GST_STATE_CHANGE_ASYNC. */
188 gboolean pending_async_done;
190 guint32 structure_cookie;
197 /* forward messages from our children */
198 gboolean message_forward;
210 static void gst_bin_dispose (GObject * object);
212 static void gst_bin_set_property (GObject * object, guint prop_id,
213 const GValue * value, GParamSpec * pspec);
214 static void gst_bin_get_property (GObject * object, guint prop_id,
215 GValue * value, GParamSpec * pspec);
217 static GstStateChangeReturn gst_bin_change_state_func (GstElement * element,
218 GstStateChange transition);
219 static void gst_bin_state_changed (GstElement * element, GstState oldstate,
220 GstState newstate, GstState pending);
221 static GstStateChangeReturn gst_bin_get_state_func (GstElement * element,
222 GstState * state, GstState * pending, GstClockTime timeout);
223 static void bin_handle_async_done (GstBin * bin, GstStateChangeReturn ret,
224 gboolean flag_pending, GstClockTime running_time);
225 static void bin_handle_async_start (GstBin * bin);
226 static void bin_push_state_continue (BinContinueData * data);
227 static void bin_do_eos (GstBin * bin);
229 static gboolean gst_bin_add_func (GstBin * bin, GstElement * element);
230 static gboolean gst_bin_remove_func (GstBin * bin, GstElement * element);
233 static void gst_bin_set_index_func (GstElement * element, GstIndex * index);
234 static GstIndex *gst_bin_get_index_func (GstElement * element);
237 static GstClock *gst_bin_provide_clock_func (GstElement * element);
238 static gboolean gst_bin_set_clock_func (GstElement * element, GstClock * clock);
240 static void gst_bin_handle_message_func (GstBin * bin, GstMessage * message);
241 static gboolean gst_bin_send_event (GstElement * element, GstEvent * event);
242 static GstBusSyncReply bin_bus_handler (GstBus * bus,
243 GstMessage * message, GstBin * bin);
244 static gboolean gst_bin_query (GstElement * element, GstQuery * query);
245 static void gst_bin_set_context (GstElement * element, GstContext * context);
247 static gboolean gst_bin_do_latency_func (GstBin * bin);
249 static void bin_remove_messages (GstBin * bin, GstObject * src,
250 GstMessageType types);
251 static void gst_bin_continue_func (BinContinueData * data);
252 static gint bin_element_is_sink (GstElement * child, GstBin * bin);
253 static gint bin_element_is_src (GstElement * child, GstBin * bin);
255 static GstIterator *gst_bin_sort_iterator_new (GstBin * bin);
257 /* Bin signals and properties */
266 #define DEFAULT_ASYNC_HANDLING FALSE
267 #define DEFAULT_MESSAGE_FORWARD FALSE
273 PROP_MESSAGE_FORWARD,
277 static void gst_bin_child_proxy_init (gpointer g_iface, gpointer iface_data);
279 static guint gst_bin_signals[LAST_SIGNAL] = { 0 };
283 static const GInterfaceInfo iface_info = { \
284 gst_bin_child_proxy_init, \
288 g_type_add_interface_static (g_define_type_id, GST_TYPE_CHILD_PROXY, &iface_info); \
290 GST_DEBUG_CATEGORY_INIT (bin_debug, "bin", GST_DEBUG_BOLD, \
291 "debugging info for the 'bin' container element"); \
295 #define gst_bin_parent_class parent_class
296 G_DEFINE_TYPE_WITH_CODE (GstBin, gst_bin, GST_TYPE_ELEMENT, _do_init);
299 gst_bin_child_proxy_get_child_by_index (GstChildProxy * child_proxy,
305 bin = GST_BIN_CAST (child_proxy);
307 GST_OBJECT_LOCK (bin);
308 if ((res = g_list_nth_data (bin->children, index)))
309 gst_object_ref (res);
310 GST_OBJECT_UNLOCK (bin);
312 return (GObject *) res;
316 gst_bin_child_proxy_get_children_count (GstChildProxy * child_proxy)
321 bin = GST_BIN_CAST (child_proxy);
323 GST_OBJECT_LOCK (bin);
324 num = bin->numchildren;
325 GST_OBJECT_UNLOCK (bin);
331 gst_bin_child_proxy_init (gpointer g_iface, gpointer iface_data)
333 GstChildProxyInterface *iface = g_iface;
335 iface->get_children_count = gst_bin_child_proxy_get_children_count;
336 iface->get_child_by_index = gst_bin_child_proxy_get_child_by_index;
340 _gst_boolean_accumulator (GSignalInvocationHint * ihint,
341 GValue * return_accu, const GValue * handler_return, gpointer dummy)
345 myboolean = g_value_get_boolean (handler_return);
346 if (!(ihint->run_type & G_SIGNAL_RUN_CLEANUP))
347 g_value_set_boolean (return_accu, myboolean);
349 GST_DEBUG ("invocation %d, %d", ihint->run_type, myboolean);
356 gst_bin_class_init (GstBinClass * klass)
358 GObjectClass *gobject_class;
359 GstElementClass *gstelement_class;
362 gobject_class = (GObjectClass *) klass;
363 gstelement_class = (GstElementClass *) klass;
365 g_type_class_add_private (klass, sizeof (GstBinPrivate));
367 gobject_class->set_property = gst_bin_set_property;
368 gobject_class->get_property = gst_bin_get_property;
371 * GstBin:async-handling:
373 * If set to #TRUE, the bin will handle asynchronous state changes.
374 * This should be used only if the bin subclass is modifying the state
375 * of its children on its own.
377 g_object_class_install_property (gobject_class, PROP_ASYNC_HANDLING,
378 g_param_spec_boolean ("async-handling", "Async Handling",
379 "The bin will handle Asynchronous state changes",
380 DEFAULT_ASYNC_HANDLING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
383 * GstBin::element-added:
385 * @element: the #GstElement that was added to the bin
387 * Will be emitted after the element was added to the bin.
389 gst_bin_signals[ELEMENT_ADDED] =
390 g_signal_new ("element-added", G_TYPE_FROM_CLASS (klass),
391 G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstBinClass, element_added), NULL,
392 NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_ELEMENT);
394 * GstBin::element-removed:
396 * @element: the #GstElement that was removed from the bin
398 * Will be emitted after the element was removed from the bin.
400 gst_bin_signals[ELEMENT_REMOVED] =
401 g_signal_new ("element-removed", G_TYPE_FROM_CLASS (klass),
402 G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstBinClass, element_removed), NULL,
403 NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_ELEMENT);
405 * GstBin::do-latency:
408 * Will be emitted when the bin needs to perform latency calculations. This
409 * signal is only emited for toplevel bins or when async-handling is
412 * Only one signal handler is invoked. If no signals are connected, the
413 * default handler is invoked, which will query and distribute the lowest
414 * possible latency to all sinks.
416 * Connect to this signal if the default latency calculations are not
417 * sufficient, like when you need different latencies for different sinks in
420 gst_bin_signals[DO_LATENCY] =
421 g_signal_new ("do-latency", G_TYPE_FROM_CLASS (klass),
422 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstBinClass, do_latency),
423 _gst_boolean_accumulator, NULL, g_cclosure_marshal_generic,
424 G_TYPE_BOOLEAN, 0, G_TYPE_NONE);
427 * GstBin:message-forward:
429 * Forward all children messages, even those that would normally be filtered by
430 * the bin. This can be interesting when one wants to be notified of the EOS
431 * state of individual elements, for example.
433 * The messages are converted to an ELEMENT message with the bin as the
434 * source. The structure of the message is named 'GstBinForwarded' and contains
435 * a field named 'message' of type GST_TYPE_MESSAGE that contains the original
438 g_object_class_install_property (gobject_class, PROP_MESSAGE_FORWARD,
439 g_param_spec_boolean ("message-forward", "Message Forward",
440 "Forwards all children messages",
441 DEFAULT_MESSAGE_FORWARD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
443 gobject_class->dispose = gst_bin_dispose;
445 gst_element_class_set_static_metadata (gstelement_class, "Generic bin",
447 "Simple container object",
448 "Erik Walthinsen <omega@cse.ogi.edu>,"
449 "Wim Taymans <wim.taymans@gmail.com>");
451 gstelement_class->change_state =
452 GST_DEBUG_FUNCPTR (gst_bin_change_state_func);
453 gstelement_class->state_changed = GST_DEBUG_FUNCPTR (gst_bin_state_changed);
454 gstelement_class->get_state = GST_DEBUG_FUNCPTR (gst_bin_get_state_func);
456 gstelement_class->get_index = GST_DEBUG_FUNCPTR (gst_bin_get_index_func);
457 gstelement_class->set_index = GST_DEBUG_FUNCPTR (gst_bin_set_index_func);
459 gstelement_class->provide_clock =
460 GST_DEBUG_FUNCPTR (gst_bin_provide_clock_func);
461 gstelement_class->set_clock = GST_DEBUG_FUNCPTR (gst_bin_set_clock_func);
463 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_bin_send_event);
464 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_bin_query);
465 gstelement_class->set_context = GST_DEBUG_FUNCPTR (gst_bin_set_context);
467 klass->add_element = GST_DEBUG_FUNCPTR (gst_bin_add_func);
468 klass->remove_element = GST_DEBUG_FUNCPTR (gst_bin_remove_func);
469 klass->handle_message = GST_DEBUG_FUNCPTR (gst_bin_handle_message_func);
471 klass->do_latency = GST_DEBUG_FUNCPTR (gst_bin_do_latency_func);
473 GST_DEBUG ("creating bin thread pool");
476 g_thread_pool_new ((GFunc) gst_bin_continue_func, NULL, -1, FALSE, &err);
478 g_critical ("could alloc threadpool %s", err->message);
483 gst_bin_init (GstBin * bin)
487 bin->numchildren = 0;
488 bin->children = NULL;
489 bin->children_cookie = 0;
490 bin->messages = NULL;
491 bin->provided_clock = NULL;
492 bin->clock_dirty = FALSE;
494 /* Set up a bus for listening to child elements */
495 bus = g_object_new (GST_TYPE_BUS, "enable-async", FALSE, NULL);
496 bin->child_bus = bus;
497 GST_DEBUG_OBJECT (bin, "using bus %" GST_PTR_FORMAT " to listen to children",
499 gst_bus_set_sync_handler (bus, (GstBusSyncHandler) bin_bus_handler, bin,
502 bin->priv = GST_BIN_GET_PRIVATE (bin);
503 bin->priv->asynchandling = DEFAULT_ASYNC_HANDLING;
504 bin->priv->structure_cookie = 0;
505 bin->priv->message_forward = DEFAULT_MESSAGE_FORWARD;
509 gst_bin_dispose (GObject * object)
511 GstBin *bin = GST_BIN_CAST (object);
512 GstBus **child_bus_p = &bin->child_bus;
513 GstClock **provided_clock_p = &bin->provided_clock;
514 GstElement **clock_provider_p = &bin->clock_provider;
516 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object, "dispose");
518 GST_OBJECT_LOCK (object);
519 gst_object_replace ((GstObject **) child_bus_p, NULL);
520 gst_object_replace ((GstObject **) provided_clock_p, NULL);
521 gst_object_replace ((GstObject **) clock_provider_p, NULL);
522 bin_remove_messages (bin, NULL, GST_MESSAGE_ANY);
523 GST_OBJECT_UNLOCK (object);
525 while (bin->children) {
526 gst_bin_remove (bin, GST_ELEMENT_CAST (bin->children->data));
528 if (G_UNLIKELY (bin->children != NULL)) {
529 g_critical ("could not remove elements from bin '%s'",
530 GST_STR_NULL (GST_OBJECT_NAME (object)));
533 G_OBJECT_CLASS (parent_class)->dispose (object);
538 * @name: the name of the new bin
540 * Creates a new bin with the given name.
542 * Returns: (transfer floating): a new #GstBin
545 gst_bin_new (const gchar * name)
547 return gst_element_factory_make ("bin", name);
551 gst_bin_set_property (GObject * object, guint prop_id,
552 const GValue * value, GParamSpec * pspec)
556 gstbin = GST_BIN_CAST (object);
559 case PROP_ASYNC_HANDLING:
560 GST_OBJECT_LOCK (gstbin);
561 gstbin->priv->asynchandling = g_value_get_boolean (value);
562 GST_OBJECT_UNLOCK (gstbin);
564 case PROP_MESSAGE_FORWARD:
565 GST_OBJECT_LOCK (gstbin);
566 gstbin->priv->message_forward = g_value_get_boolean (value);
567 GST_OBJECT_UNLOCK (gstbin);
570 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
576 gst_bin_get_property (GObject * object, guint prop_id,
577 GValue * value, GParamSpec * pspec)
581 gstbin = GST_BIN_CAST (object);
584 case PROP_ASYNC_HANDLING:
585 GST_OBJECT_LOCK (gstbin);
586 g_value_set_boolean (value, gstbin->priv->asynchandling);
587 GST_OBJECT_UNLOCK (gstbin);
589 case PROP_MESSAGE_FORWARD:
590 GST_OBJECT_LOCK (gstbin);
591 g_value_set_boolean (value, gstbin->priv->message_forward);
592 GST_OBJECT_UNLOCK (gstbin);
595 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
601 /* return the cached index */
603 gst_bin_get_index_func (GstElement * element)
608 bin = GST_BIN_CAST (element);
610 GST_OBJECT_LOCK (bin);
611 if ((result = bin->priv->index))
612 gst_object_ref (result);
613 GST_OBJECT_UNLOCK (bin);
618 /* set the index on all elements in this bin
623 gst_bin_set_index_func (GstElement * element, GstIndex * index)
629 GValue data = { 0, };
631 bin = GST_BIN_CAST (element);
633 GST_OBJECT_LOCK (bin);
634 old = bin->priv->index;
635 if (G_UNLIKELY (old == index))
638 gst_object_ref (index);
639 bin->priv->index = index;
640 GST_OBJECT_UNLOCK (bin);
643 gst_object_unref (old);
645 it = gst_bin_iterate_elements (bin);
647 /* set the index on all elements in the bin */
650 switch (gst_iterator_next (it, &data)) {
651 case GST_ITERATOR_OK:
653 GstElement *child = g_value_get_object (&data);
655 GST_DEBUG_OBJECT (bin, "setting index on '%s'",
656 GST_ELEMENT_NAME (child));
657 gst_element_set_index (child, index);
659 g_value_reset (&data);
662 case GST_ITERATOR_RESYNC:
663 GST_DEBUG_OBJECT (bin, "iterator doing resync");
664 gst_iterator_resync (it);
667 case GST_ITERATOR_DONE:
668 GST_DEBUG_OBJECT (bin, "iterator done");
673 g_value_unset (&data);
674 gst_iterator_free (it);
679 GST_DEBUG_OBJECT (bin, "index was already set");
680 GST_OBJECT_UNLOCK (bin);
686 /* set the clock on all elements in this bin
691 gst_bin_set_clock_func (GstElement * element, GstClock * clock)
697 GValue data = { 0, };
699 bin = GST_BIN_CAST (element);
701 it = gst_bin_iterate_elements (bin);
705 switch (gst_iterator_next (it, &data)) {
706 case GST_ITERATOR_OK:
708 GstElement *child = g_value_get_object (&data);
710 res &= gst_element_set_clock (child, clock);
712 g_value_reset (&data);
715 case GST_ITERATOR_RESYNC:
716 GST_DEBUG_OBJECT (bin, "iterator doing resync");
717 gst_iterator_resync (it);
721 case GST_ITERATOR_DONE:
722 GST_DEBUG_OBJECT (bin, "iterator done");
727 g_value_unset (&data);
728 gst_iterator_free (it);
731 res = GST_ELEMENT_CLASS (parent_class)->set_clock (element, clock);
736 /* get the clock for this bin by asking all of the children in this bin
738 * The ref of the returned clock in increased so unref after usage.
740 * We loop the elements in state order and pick the last clock we can
741 * get. This makes sure we get a clock from the source.
746 gst_bin_provide_clock_func (GstElement * element)
748 GstClock *result = NULL;
749 GstElement *provider = NULL;
754 GstClock **provided_clock_p;
755 GstElement **clock_provider_p;
757 bin = GST_BIN_CAST (element);
759 GST_OBJECT_LOCK (bin);
760 if (!bin->clock_dirty)
763 GST_DEBUG_OBJECT (bin, "finding new clock");
765 it = gst_bin_sort_iterator_new (bin);
766 GST_OBJECT_UNLOCK (bin);
770 switch (gst_iterator_next (it, &val)) {
771 case GST_ITERATOR_OK:
773 GstElement *child = g_value_get_object (&val);
776 clock = gst_element_provide_clock (child);
778 GST_DEBUG_OBJECT (bin, "found candidate clock %p by element %s",
779 clock, GST_ELEMENT_NAME (child));
781 gst_object_unref (result);
782 gst_object_unref (provider);
785 provider = gst_object_ref (child);
788 g_value_reset (&val);
791 case GST_ITERATOR_RESYNC:
792 gst_iterator_resync (it);
795 case GST_ITERATOR_DONE:
800 g_value_unset (&val);
801 gst_iterator_free (it);
803 GST_OBJECT_LOCK (bin);
804 if (!bin->clock_dirty) {
806 gst_object_unref (provider);
808 gst_object_unref (result);
814 provided_clock_p = &bin->provided_clock;
815 clock_provider_p = &bin->clock_provider;
816 gst_object_replace ((GstObject **) provided_clock_p, (GstObject *) result);
817 gst_object_replace ((GstObject **) clock_provider_p, (GstObject *) provider);
818 bin->clock_dirty = FALSE;
819 GST_DEBUG_OBJECT (bin,
820 "provided new clock %" GST_PTR_FORMAT " by provider %" GST_PTR_FORMAT,
822 /* Provider is not being returned to caller, just the result */
824 gst_object_unref (provider);
825 GST_OBJECT_UNLOCK (bin);
831 if ((result = bin->provided_clock))
832 gst_object_ref (result);
833 GST_DEBUG_OBJECT (bin, "returning old clock %p", result);
834 GST_OBJECT_UNLOCK (bin);
841 * functions for manipulating cached messages
846 GstMessageType types;
849 /* check if a message is of given src and type */
851 message_check (GstMessage * message, MessageFind * target)
856 eq &= GST_MESSAGE_SRC (message) == target->src;
858 eq &= (GST_MESSAGE_TYPE (message) & target->types) != 0;
859 GST_LOG ("looking at message %p: %d", message, eq);
865 find_message (GstBin * bin, GstObject * src, GstMessageType types)
873 result = g_list_find_custom (bin->messages, &find,
874 (GCompareFunc) message_check);
877 GST_DEBUG_OBJECT (bin, "we found a message %p from %s matching types %08x",
878 result->data, GST_OBJECT_NAME (GST_MESSAGE_CAST (result->data)->src),
881 GST_DEBUG_OBJECT (bin, "no message found matching types %08x", types);
882 #ifndef GST_DISABLE_GST_DEBUG
886 for (i = 0; i < 32; i++)
887 if (types & (1 << i))
888 GST_DEBUG_OBJECT (bin, " %s", gst_message_type_get_name (1 << i));
896 /* with LOCK, returns TRUE if message had a valid SRC, takes ownership of
899 * A message that is cached and has the same SRC and type is replaced
900 * by the given message.
903 bin_replace_message (GstBin * bin, GstMessage * message, GstMessageType types)
909 if ((src = GST_MESSAGE_SRC (message))) {
910 /* first find the previous message posted by this element */
911 if ((previous = find_message (bin, src, types))) {
912 GstMessage *previous_msg;
914 /* if we found a previous message, replace it */
915 previous_msg = previous->data;
916 previous->data = message;
918 GST_DEBUG_OBJECT (bin, "replace old message %s from %s with %s message",
919 GST_MESSAGE_TYPE_NAME (previous_msg), GST_ELEMENT_NAME (src),
920 GST_MESSAGE_TYPE_NAME (message));
922 gst_message_unref (previous_msg);
924 /* keep new message */
925 bin->messages = g_list_prepend (bin->messages, message);
927 GST_DEBUG_OBJECT (bin, "got new message %p, %s from %s",
928 message, GST_MESSAGE_TYPE_NAME (message), GST_ELEMENT_NAME (src));
931 GST_DEBUG_OBJECT (bin, "got message %s from (NULL), not processing",
932 GST_MESSAGE_TYPE_NAME (message));
934 gst_message_unref (message);
939 /* with LOCK. Remove all messages of given types */
941 bin_remove_messages (GstBin * bin, GstObject * src, GstMessageType types)
949 for (walk = bin->messages; walk; walk = next) {
950 GstMessage *message = (GstMessage *) walk->data;
952 next = g_list_next (walk);
954 if (message_check (message, &find) == 0) {
955 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (message),
956 "deleting message %p of types 0x%08x", message, types);
957 bin->messages = g_list_delete_link (bin->messages, walk);
958 gst_message_unref (message);
960 GST_DEBUG_OBJECT (GST_MESSAGE_SRC (message),
961 "not deleting message %p of type 0x%08x", message,
962 GST_MESSAGE_TYPE (message));
968 /* Check if the bin is EOS. We do this by scanning all sinks and
969 * checking if they posted an EOS message.
971 * call with bin LOCK */
973 is_eos (GstBin * bin, guint32 * seqnum)
980 for (walk = bin->children; walk; walk = g_list_next (walk)) {
983 element = GST_ELEMENT_CAST (walk->data);
984 if (bin_element_is_sink (element, bin) == 0) {
985 /* check if element posted EOS */
987 find_message (bin, GST_OBJECT_CAST (element), GST_MESSAGE_EOS))) {
988 GST_DEBUG ("sink '%s' posted EOS", GST_ELEMENT_NAME (element));
989 *seqnum = gst_message_get_seqnum (GST_MESSAGE_CAST (msgs->data));
992 GST_DEBUG ("sink '%s' did not post EOS yet",
993 GST_ELEMENT_NAME (element));
999 /* FIXME: Some tests (e.g. elements/capsfilter) use
1000 * pipelines with a dangling sinkpad but no sink element.
1001 * These tests assume that no EOS message is ever
1002 * posted on the bus so let's keep that behaviour.
1003 * In valid pipelines this doesn't make a difference.
1005 return result && n_eos > 0;
1009 /* Check if the bin is STREAM_START. We do this by scanning all sinks and
1010 * checking if they posted an STREAM_START message.
1012 * call with bin LOCK */
1014 is_stream_start (GstBin * bin, guint32 * seqnum, gboolean * have_group_id,
1020 gboolean first = TRUE, same_group_id = TRUE;
1022 *have_group_id = TRUE;
1025 for (walk = bin->children; walk; walk = g_list_next (walk)) {
1026 GstElement *element;
1028 element = GST_ELEMENT_CAST (walk->data);
1029 if (bin_element_is_sink (element, bin) == 0) {
1030 /* check if element posted STREAM_START */
1032 find_message (bin, GST_OBJECT_CAST (element),
1033 GST_MESSAGE_STREAM_START))) {
1034 GST_DEBUG ("sink '%s' posted STREAM_START", GST_ELEMENT_NAME (element));
1035 *seqnum = gst_message_get_seqnum (GST_MESSAGE_CAST (msgs->data));
1036 if (gst_message_parse_group_id (GST_MESSAGE_CAST (msgs->data),
1040 *group_id = tmp_group_id;
1042 if (tmp_group_id != *group_id)
1043 same_group_id = FALSE;
1046 *have_group_id = FALSE;
1049 GST_DEBUG ("sink '%s' did not post STREAM_START yet",
1050 GST_ELEMENT_NAME (element));
1057 /* If all have a group_id we only consider this stream started
1058 * if all group ids were the same and all sinks posted a stream-start
1061 return same_group_id && result;
1062 /* otherwise consider this stream started after all sinks
1063 * have reported stream-start for backward compatibility.
1064 * FIXME 2.0: This should go away! */
1069 unlink_pads (const GValue * item, gpointer user_data)
1074 pad = g_value_get_object (item);
1076 if ((peer = gst_pad_get_peer (pad))) {
1077 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
1078 gst_pad_unlink (pad, peer);
1080 gst_pad_unlink (peer, pad);
1081 gst_object_unref (peer);
1085 /* vmethod that adds an element to a bin
1090 gst_bin_add_func (GstBin * bin, GstElement * element)
1094 gboolean is_sink, is_source, provides_clock, requires_clock;
1095 GstMessage *clock_message = NULL, *async_message = NULL;
1096 GstStateChangeReturn ret;
1098 GST_DEBUG_OBJECT (bin, "element :%s", GST_ELEMENT_NAME (element));
1100 /* we obviously can't add ourself to ourself */
1101 if (G_UNLIKELY (element == GST_ELEMENT_CAST (bin)))
1104 /* get the element name to make sure it is unique in this bin. */
1105 GST_OBJECT_LOCK (element);
1106 elem_name = g_strdup (GST_ELEMENT_NAME (element));
1107 is_sink = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_SINK);
1108 is_source = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_SOURCE);
1110 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
1112 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
1113 GST_OBJECT_UNLOCK (element);
1115 GST_OBJECT_LOCK (bin);
1117 /* then check to see if the element's name is already taken in the bin,
1118 * we can safely take the lock here. This check is probably bogus because
1119 * you can safely change the element name after this check and before setting
1120 * the object parent. The window is very small though... */
1121 if (G_UNLIKELY (!gst_object_check_uniqueness (bin->children, elem_name)))
1122 goto duplicate_name;
1124 /* set the element's parent and add the element to the bin's list of children */
1125 if (G_UNLIKELY (!gst_object_set_parent (GST_OBJECT_CAST (element),
1126 GST_OBJECT_CAST (bin))))
1129 /* if we add a sink we become a sink */
1131 GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "element \"%s\" was sink",
1133 GST_OBJECT_FLAG_SET (bin, GST_ELEMENT_FLAG_SINK);
1136 GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "element \"%s\" was source",
1138 GST_OBJECT_FLAG_SET (bin, GST_ELEMENT_FLAG_SOURCE);
1140 if (provides_clock) {
1141 GST_DEBUG_OBJECT (bin, "element \"%s\" can provide a clock", elem_name);
1143 gst_message_new_clock_provide (GST_OBJECT_CAST (element), NULL, TRUE);
1144 GST_OBJECT_FLAG_SET (bin, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
1146 if (requires_clock) {
1147 GST_DEBUG_OBJECT (bin, "element \"%s\" requires a clock", elem_name);
1148 GST_OBJECT_FLAG_SET (bin, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
1151 bin->children = g_list_prepend (bin->children, element);
1153 bin->children_cookie++;
1154 if (!GST_BIN_IS_NO_RESYNC (bin))
1155 bin->priv->structure_cookie++;
1157 /* distribute the bus */
1158 gst_element_set_bus (element, bin->child_bus);
1160 /* propagate the current base_time, start_time and clock */
1161 gst_element_set_base_time (element, GST_ELEMENT_CAST (bin)->base_time);
1162 gst_element_set_start_time (element, GST_ELEMENT_START_TIME (bin));
1163 /* it's possible that the element did not accept the clock but
1164 * that is not important right now. When the pipeline goes to PLAYING,
1165 * a new clock will be selected */
1166 gst_element_set_clock (element, GST_ELEMENT_CLOCK (bin));
1169 /* set the cached index on the children */
1170 if (bin->priv->index)
1171 gst_element_set_index (element, bin->priv->index);
1174 ret = GST_STATE_RETURN (bin);
1175 /* no need to update the state if we are in error */
1176 if (ret == GST_STATE_CHANGE_FAILURE)
1177 goto no_state_recalc;
1179 /* update the bin state, the new element could have been an ASYNC or
1180 * NO_PREROLL element */
1181 ret = GST_STATE_RETURN (element);
1182 GST_DEBUG_OBJECT (bin, "added %s element",
1183 gst_element_state_change_return_get_name (ret));
1186 case GST_STATE_CHANGE_ASYNC:
1188 /* create message to track this aync element when it posts an async-done
1190 async_message = gst_message_new_async_start (GST_OBJECT_CAST (element));
1193 case GST_STATE_CHANGE_NO_PREROLL:
1194 /* ignore all async elements we might have and commit our state */
1195 bin_handle_async_done (bin, ret, FALSE, GST_CLOCK_TIME_NONE);
1197 case GST_STATE_CHANGE_FAILURE:
1204 GST_OBJECT_UNLOCK (bin);
1206 /* post the messages on the bus of the element so that the bin can handle
1209 gst_element_post_message (element, clock_message);
1212 gst_element_post_message (element, async_message);
1214 /* unlink all linked pads */
1215 it = gst_element_iterate_pads (element);
1216 gst_iterator_foreach (it, (GstIteratorForeachFunction) unlink_pads, NULL);
1217 gst_iterator_free (it);
1219 GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "added element \"%s\"",
1222 g_signal_emit (bin, gst_bin_signals[ELEMENT_ADDED], 0, element);
1223 gst_child_proxy_child_added ((GstChildProxy *) bin, (GObject *) element,
1230 /* ERROR handling here */
1233 GST_OBJECT_LOCK (bin);
1234 g_warning ("Cannot add bin '%s' to itself", GST_ELEMENT_NAME (bin));
1235 GST_OBJECT_UNLOCK (bin);
1240 g_warning ("Name '%s' is not unique in bin '%s', not adding",
1241 elem_name, GST_ELEMENT_NAME (bin));
1242 GST_OBJECT_UNLOCK (bin);
1248 g_warning ("Element '%s' already has parent", elem_name);
1249 GST_OBJECT_UNLOCK (bin);
1258 * @element: (transfer full): the #GstElement to add
1260 * Adds the given element to the bin. Sets the element's parent, and thus
1261 * takes ownership of the element. An element can only be added to one bin.
1263 * If the element's pads are linked to other pads, the pads will be unlinked
1264 * before the element is added to the bin.
1267 * When you add an element to an already-running pipeline, you will have to
1268 * take care to set the state of the newly-added element to the desired
1269 * state (usually PLAYING or PAUSED, same you set the pipeline to originally)
1270 * with gst_element_set_state(), or use gst_element_sync_state_with_parent().
1271 * The bin or pipeline will not take care of this for you.
1276 * Returns: TRUE if the element could be added, FALSE if
1277 * the bin does not want to accept the element.
1280 gst_bin_add (GstBin * bin, GstElement * element)
1282 GstBinClass *bclass;
1285 g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
1286 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1288 bclass = GST_BIN_GET_CLASS (bin);
1290 if (G_UNLIKELY (bclass->add_element == NULL))
1293 GST_CAT_DEBUG (GST_CAT_PARENTAGE, "adding element %s to bin %s",
1294 GST_STR_NULL (GST_ELEMENT_NAME (element)),
1295 GST_STR_NULL (GST_ELEMENT_NAME (bin)));
1297 result = bclass->add_element (bin, element);
1301 /* ERROR handling */
1304 g_warning ("adding elements to bin '%s' is not supported",
1305 GST_ELEMENT_NAME (bin));
1310 /* remove an element from the bin
1315 gst_bin_remove_func (GstBin * bin, GstElement * element)
1319 gboolean is_sink, is_source, provides_clock, requires_clock;
1320 gboolean othersink, othersource, otherprovider, otherrequirer, found;
1321 GstMessage *clock_message = NULL;
1322 GstClock **provided_clock_p;
1323 GstElement **clock_provider_p;
1325 gboolean other_async, this_async, have_no_preroll;
1326 GstStateChangeReturn ret;
1328 GST_DEBUG_OBJECT (bin, "element :%s", GST_ELEMENT_NAME (element));
1330 GST_OBJECT_LOCK (bin);
1332 GST_OBJECT_LOCK (element);
1333 elem_name = g_strdup (GST_ELEMENT_NAME (element));
1335 if (GST_OBJECT_PARENT (element) != GST_OBJECT_CAST (bin))
1338 /* remove the parent ref */
1339 GST_OBJECT_PARENT (element) = NULL;
1341 /* grab element name so we can print it */
1342 is_sink = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_SINK);
1343 is_source = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_SOURCE);
1345 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
1347 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
1348 GST_OBJECT_UNLOCK (element);
1352 othersource = FALSE;
1353 otherprovider = FALSE;
1354 otherrequirer = FALSE;
1355 have_no_preroll = FALSE;
1356 /* iterate the elements, we collect which ones are async and no_preroll. We
1357 * also remove the element when we find it. */
1358 for (walk = bin->children; walk; walk = next) {
1359 GstElement *child = GST_ELEMENT_CAST (walk->data);
1361 next = g_list_next (walk);
1363 if (child == element) {
1365 /* remove the element */
1366 bin->children = g_list_delete_link (bin->children, walk);
1368 gboolean child_sink, child_source, child_provider, child_requirer;
1370 GST_OBJECT_LOCK (child);
1371 child_sink = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_SINK);
1372 child_source = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_SOURCE);
1374 GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
1376 GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
1377 /* when we remove a sink, check if there are other sinks. */
1378 if (is_sink && !othersink && child_sink)
1380 if (is_source && !othersource && child_source)
1382 if (provides_clock && !otherprovider && child_provider)
1383 otherprovider = TRUE;
1384 if (requires_clock && !otherrequirer && child_requirer)
1385 otherrequirer = TRUE;
1386 /* check if we have NO_PREROLL children */
1387 if (GST_STATE_RETURN (child) == GST_STATE_CHANGE_NO_PREROLL)
1388 have_no_preroll = TRUE;
1389 GST_OBJECT_UNLOCK (child);
1393 /* the element must have been in the bin's list of children */
1394 if (G_UNLIKELY (!found))
1397 /* we now removed the element from the list of elements, increment the cookie
1398 * so that others can detect a change in the children list. */
1400 bin->children_cookie++;
1401 if (!GST_BIN_IS_NO_RESYNC (bin))
1402 bin->priv->structure_cookie++;
1404 if (is_sink && !othersink) {
1405 /* we're not a sink anymore */
1406 GST_DEBUG_OBJECT (bin, "we removed the last sink");
1407 GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_FLAG_SINK);
1409 if (is_source && !othersource) {
1410 /* we're not a source anymore */
1411 GST_DEBUG_OBJECT (bin, "we removed the last source");
1412 GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_FLAG_SOURCE);
1414 if (provides_clock && !otherprovider) {
1415 /* we're not a clock provider anymore */
1416 GST_DEBUG_OBJECT (bin, "we removed the last clock provider");
1417 GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
1419 if (requires_clock && !otherrequirer) {
1420 /* we're not a clock requirer anymore */
1421 GST_DEBUG_OBJECT (bin, "we removed the last clock requirer");
1422 GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
1425 /* if the clock provider for this element is removed, we lost
1426 * the clock as well, we need to inform the parent of this
1427 * so that it can select a new clock */
1428 if (bin->clock_provider == element) {
1429 GST_DEBUG_OBJECT (bin, "element \"%s\" provided the clock", elem_name);
1430 bin->clock_dirty = TRUE;
1432 gst_message_new_clock_lost (GST_OBJECT_CAST (bin), bin->provided_clock);
1433 provided_clock_p = &bin->provided_clock;
1434 clock_provider_p = &bin->clock_provider;
1435 gst_object_replace ((GstObject **) provided_clock_p, NULL);
1436 gst_object_replace ((GstObject **) clock_provider_p, NULL);
1439 /* remove messages for the element, if there was a pending ASYNC_START
1440 * message we must see if removing the element caused the bin to lose its
1443 other_async = FALSE;
1444 for (walk = bin->messages; walk; walk = next) {
1445 GstMessage *message = (GstMessage *) walk->data;
1446 GstElement *src = GST_ELEMENT_CAST (GST_MESSAGE_SRC (message));
1449 next = g_list_next (walk);
1452 switch (GST_MESSAGE_TYPE (message)) {
1453 case GST_MESSAGE_ASYNC_START:
1459 GST_DEBUG_OBJECT (src, "looking at message %p", message);
1461 case GST_MESSAGE_STRUCTURE_CHANGE:
1465 GST_DEBUG_OBJECT (src, "looking at structure change message %p",
1467 /* it's unlikely that this message is still in the list of messages
1468 * because this would mean that a link/unlink is busy in another thread
1469 * while we remove the element. We still have to remove the message
1470 * because we might not receive the done message anymore when the element
1471 * is removed from the bin. */
1472 gst_message_parse_structure_change (message, NULL, &owner, NULL);
1473 if (owner == element)
1484 /* delete all message types */
1485 GST_DEBUG_OBJECT (src, "deleting message %p of element \"%s\"",
1486 message, elem_name);
1487 bin->messages = g_list_delete_link (bin->messages, walk);
1488 gst_message_unref (message);
1492 /* get last return */
1493 ret = GST_STATE_RETURN (bin);
1495 /* no need to update the state if we are in error */
1496 if (ret == GST_STATE_CHANGE_FAILURE)
1497 goto no_state_recalc;
1499 if (!other_async && this_async) {
1500 /* all other elements were not async and we removed the async one,
1501 * handle the async-done case because we are not async anymore now. */
1502 GST_DEBUG_OBJECT (bin,
1503 "we removed the last async element, have no_preroll %d",
1506 /* the current state return of the bin depends on if there are no_preroll
1507 * elements in the pipeline or not */
1508 if (have_no_preroll)
1509 ret = GST_STATE_CHANGE_NO_PREROLL;
1511 ret = GST_STATE_CHANGE_SUCCESS;
1513 bin_handle_async_done (bin, ret, FALSE, GST_CLOCK_TIME_NONE);
1515 GST_DEBUG_OBJECT (bin,
1516 "recalc state preroll: %d, other async: %d, this async %d",
1517 have_no_preroll, other_async, this_async);
1519 if (have_no_preroll) {
1520 ret = GST_STATE_CHANGE_NO_PREROLL;
1521 } else if (other_async) {
1522 /* there are other async elements and we were not doing an async state
1523 * change, change our pending state and go async */
1524 if (GST_STATE_PENDING (bin) == GST_STATE_VOID_PENDING) {
1525 GST_STATE_NEXT (bin) = GST_STATE (bin);
1526 GST_STATE_PENDING (bin) = GST_STATE (bin);
1528 ret = GST_STATE_CHANGE_ASYNC;
1530 GST_STATE_RETURN (bin) = ret;
1534 gst_element_set_bus (element, NULL);
1535 /* Clear the clock we provided to the element */
1536 gst_element_set_clock (element, NULL);
1537 GST_OBJECT_UNLOCK (bin);
1540 gst_element_post_message (GST_ELEMENT_CAST (bin), clock_message);
1542 /* unlink all linked pads */
1543 it = gst_element_iterate_pads (element);
1544 gst_iterator_foreach (it, (GstIteratorForeachFunction) unlink_pads, NULL);
1545 gst_iterator_free (it);
1547 GST_CAT_INFO_OBJECT (GST_CAT_PARENTAGE, bin, "removed child \"%s\"",
1550 g_signal_emit (bin, gst_bin_signals[ELEMENT_REMOVED], 0, element);
1551 gst_child_proxy_child_removed ((GstChildProxy *) bin, (GObject *) element,
1555 /* element is really out of our control now */
1556 gst_object_unref (element);
1560 /* ERROR handling */
1563 g_warning ("Element '%s' is not in bin '%s'", elem_name,
1564 GST_ELEMENT_NAME (bin));
1565 GST_OBJECT_UNLOCK (element);
1566 GST_OBJECT_UNLOCK (bin);
1575 * @element: (transfer none): the #GstElement to remove
1577 * Removes the element from the bin, unparenting it as well.
1578 * Unparenting the element means that the element will be dereferenced,
1579 * so if the bin holds the only reference to the element, the element
1580 * will be freed in the process of removing it from the bin. If you
1581 * want the element to still exist after removing, you need to call
1582 * gst_object_ref() before removing it from the bin.
1584 * If the element's pads are linked to other pads, the pads will be unlinked
1585 * before the element is removed from the bin.
1589 * Returns: TRUE if the element could be removed, FALSE if
1590 * the bin does not want to remove the element.
1593 gst_bin_remove (GstBin * bin, GstElement * element)
1595 GstBinClass *bclass;
1598 g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
1599 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1601 bclass = GST_BIN_GET_CLASS (bin);
1603 if (G_UNLIKELY (bclass->remove_element == NULL))
1606 GST_CAT_DEBUG (GST_CAT_PARENTAGE, "removing element %s from bin %s",
1607 GST_ELEMENT_NAME (element), GST_ELEMENT_NAME (bin));
1609 result = bclass->remove_element (bin, element);
1613 /* ERROR handling */
1616 g_warning ("removing elements from bin '%s' is not supported",
1617 GST_ELEMENT_NAME (bin));
1623 * gst_bin_iterate_elements:
1626 * Gets an iterator for the elements in this bin.
1628 * MT safe. Caller owns returned value.
1630 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1633 gst_bin_iterate_elements (GstBin * bin)
1635 GstIterator *result;
1637 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1639 GST_OBJECT_LOCK (bin);
1640 result = gst_iterator_new_list (GST_TYPE_ELEMENT,
1641 GST_OBJECT_GET_LOCK (bin),
1642 &bin->children_cookie, &bin->children, (GObject *) bin, NULL);
1643 GST_OBJECT_UNLOCK (bin);
1648 static GstIteratorItem
1649 iterate_child_recurse (GstIterator * it, const GValue * item)
1651 GstElement *child = g_value_get_object (item);
1653 if (GST_IS_BIN (child)) {
1654 GstIterator *other = gst_bin_iterate_recurse (GST_BIN_CAST (child));
1656 gst_iterator_push (it, other);
1658 return GST_ITERATOR_ITEM_PASS;
1662 * gst_bin_iterate_recurse:
1665 * Gets an iterator for the elements in this bin.
1666 * This iterator recurses into GstBin children.
1668 * MT safe. Caller owns returned value.
1670 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1673 gst_bin_iterate_recurse (GstBin * bin)
1675 GstIterator *result;
1677 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1679 GST_OBJECT_LOCK (bin);
1680 result = gst_iterator_new_list (GST_TYPE_ELEMENT,
1681 GST_OBJECT_GET_LOCK (bin),
1682 &bin->children_cookie,
1684 (GObject *) bin, (GstIteratorItemFunction) iterate_child_recurse);
1685 GST_OBJECT_UNLOCK (bin);
1690 /* returns 0 when TRUE because this is a GCompareFunc */
1693 bin_element_is_sink (GstElement * child, GstBin * bin)
1697 /* we lock the child here for the remainder of the function to
1698 * get its name and flag safely. */
1699 GST_OBJECT_LOCK (child);
1700 is_sink = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_SINK);
1702 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
1703 "child %s %s sink", GST_OBJECT_NAME (child), is_sink ? "is" : "is not");
1705 GST_OBJECT_UNLOCK (child);
1706 return is_sink ? 0 : 1;
1710 sink_iterator_filter (const GValue * vchild, GValue * vbin)
1712 GstBin *bin = g_value_get_object (vbin);
1713 GstElement *child = g_value_get_object (vchild);
1715 return (bin_element_is_sink (child, bin));
1719 * gst_bin_iterate_sinks:
1722 * Gets an iterator for all elements in the bin that have the
1723 * #GST_ELEMENT_FLAG_SINK flag set.
1725 * MT safe. Caller owns returned value.
1727 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1730 gst_bin_iterate_sinks (GstBin * bin)
1732 GstIterator *children;
1733 GstIterator *result;
1734 GValue vbin = { 0, };
1736 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1738 g_value_init (&vbin, GST_TYPE_BIN);
1739 g_value_set_object (&vbin, bin);
1741 children = gst_bin_iterate_elements (bin);
1742 result = gst_iterator_filter (children,
1743 (GCompareFunc) sink_iterator_filter, &vbin);
1745 g_value_unset (&vbin);
1750 /* returns 0 when TRUE because this is a GCompareFunc */
1753 bin_element_is_src (GstElement * child, GstBin * bin)
1757 /* we lock the child here for the remainder of the function to
1758 * get its name and other info safely. */
1759 GST_OBJECT_LOCK (child);
1760 is_src = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_SOURCE);
1762 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
1763 "child %s %s src", GST_OBJECT_NAME (child), is_src ? "is" : "is not");
1765 GST_OBJECT_UNLOCK (child);
1766 return is_src ? 0 : 1;
1770 src_iterator_filter (const GValue * vchild, GValue * vbin)
1772 GstBin *bin = g_value_get_object (vbin);
1773 GstElement *child = g_value_get_object (vchild);
1775 return (bin_element_is_src (child, bin));
1779 * gst_bin_iterate_sources:
1782 * Gets an iterator for all elements in the bin that have the
1783 * #GST_ELEMENT_FLAG_SOURCE flag set.
1785 * MT safe. Caller owns returned value.
1787 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1790 gst_bin_iterate_sources (GstBin * bin)
1792 GstIterator *children;
1793 GstIterator *result;
1794 GValue vbin = { 0, };
1796 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1798 g_value_init (&vbin, GST_TYPE_BIN);
1799 g_value_set_object (&vbin, bin);
1801 children = gst_bin_iterate_elements (bin);
1802 result = gst_iterator_filter (children,
1803 (GCompareFunc) src_iterator_filter, &vbin);
1805 g_value_unset (&vbin);
1813 static GstStateChangeReturn
1814 gst_bin_get_state_func (GstElement * element, GstState * state,
1815 GstState * pending, GstClockTime timeout)
1817 GstStateChangeReturn ret;
1819 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element, "getting state");
1822 GST_ELEMENT_CLASS (parent_class)->get_state (element, state, pending,
1828 /***********************************************
1829 * Topologically sorted iterator
1830 * see http://en.wikipedia.org/wiki/Topological_sorting
1832 * For each element in the graph, an entry is kept in a HashTable
1833 * with its number of srcpad connections (degree).
1834 * We then change state of all elements without dependencies
1835 * (degree 0) and decrement the degree of all elements connected
1836 * on the sinkpads. When an element reaches degree 0, its state is
1838 * When all elements are handled the algorithm stops.
1840 typedef struct _GstBinSortIterator
1843 GQueue queue; /* elements queued for state change */
1844 GstBin *bin; /* bin we iterate */
1845 gint mode; /* adding or removing dependency */
1846 GstElement *best; /* next element with least dependencies */
1847 gint best_deg; /* best degree */
1848 GHashTable *hash; /* hashtable with element dependencies */
1849 gboolean dirty; /* we detected structure change */
1850 } GstBinSortIterator;
1853 gst_bin_sort_iterator_copy (const GstBinSortIterator * it,
1854 GstBinSortIterator * copy)
1856 GHashTableIter iter;
1857 gpointer key, value;
1859 copy->queue = it->queue;
1860 g_queue_foreach (©->queue, (GFunc) gst_object_ref, NULL);
1862 copy->bin = gst_object_ref (it->bin);
1864 copy->best = gst_object_ref (it->best);
1866 copy->hash = g_hash_table_new (NULL, NULL);
1867 g_hash_table_iter_init (&iter, it->hash);
1868 while (g_hash_table_iter_next (&iter, &key, &value))
1869 g_hash_table_insert (copy->hash, key, value);
1872 /* we add and subtract 1 to make sure we don't confuse NULL and 0 */
1873 #define HASH_SET_DEGREE(bit, elem, deg) \
1874 g_hash_table_replace (bit->hash, elem, GINT_TO_POINTER(deg+1))
1875 #define HASH_GET_DEGREE(bit, elem) \
1876 (GPOINTER_TO_INT(g_hash_table_lookup (bit->hash, elem))-1)
1878 /* add element to queue of next elements in the iterator.
1879 * We push at the tail to give higher priority elements a
1882 add_to_queue (GstBinSortIterator * bit, GstElement * element)
1884 GST_DEBUG_OBJECT (bit->bin, "adding '%s' to queue",
1885 GST_ELEMENT_NAME (element));
1886 gst_object_ref (element);
1887 g_queue_push_tail (&bit->queue, element);
1888 HASH_SET_DEGREE (bit, element, -1);
1892 remove_from_queue (GstBinSortIterator * bit, GstElement * element)
1896 if ((find = g_queue_find (&bit->queue, element))) {
1897 GST_DEBUG_OBJECT (bit->bin, "removing '%s' from queue",
1898 GST_ELEMENT_NAME (element));
1900 g_queue_delete_link (&bit->queue, find);
1901 gst_object_unref (element);
1903 GST_DEBUG_OBJECT (bit->bin, "unable to remove '%s' from queue",
1904 GST_ELEMENT_NAME (element));
1908 /* clear the queue, unref all objects as we took a ref when
1909 * we added them to the queue */
1911 clear_queue (GQueue * queue)
1915 while ((p = g_queue_pop_head (queue)))
1916 gst_object_unref (p);
1919 /* set all degrees to 0. Elements marked as a sink are
1920 * added to the queue immediately. Since we only look at the SINK flag of the
1921 * element, it is possible that we add non-sinks to the queue. These will be
1922 * removed from the queue again when we can prove that it provides data for some
1925 reset_degree (GstElement * element, GstBinSortIterator * bit)
1929 /* sinks are added right away */
1930 GST_OBJECT_LOCK (element);
1931 is_sink = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_SINK);
1932 GST_OBJECT_UNLOCK (element);
1935 add_to_queue (bit, element);
1937 /* others are marked with 0 and handled when sinks are done */
1938 HASH_SET_DEGREE (bit, element, 0);
1942 /* adjust the degree of all elements connected to the given
1943 * element. If a degree of an element drops to 0, it is
1944 * added to the queue of elements to schedule next.
1946 * We have to make sure not to cross the bin boundary this element
1950 update_degree (GstElement * element, GstBinSortIterator * bit)
1952 gboolean linked = FALSE;
1954 GST_OBJECT_LOCK (element);
1955 /* don't touch degree if element has no sinkpads */
1956 if (element->numsinkpads != 0) {
1957 /* loop over all sinkpads, decrement degree for all connected
1958 * elements in this bin */
1961 for (pads = element->sinkpads; pads; pads = g_list_next (pads)) {
1964 pad = GST_PAD_CAST (pads->data);
1966 /* we're iterating over the sinkpads, check if it's busy in a link/unlink */
1967 if (G_UNLIKELY (find_message (bit->bin, GST_OBJECT_CAST (pad),
1968 GST_MESSAGE_STRUCTURE_CHANGE))) {
1969 /* mark the iterator as dirty because we won't be updating the degree
1970 * of the peer parent now. This would result in the 'loop detected'
1971 * later on because the peer parent element could become the best next
1972 * element with a degree > 0. We will simply continue our state
1973 * changes and we'll eventually resync when the unlink completed and
1974 * the iterator cookie is updated. */
1979 if ((peer = gst_pad_get_peer (pad))) {
1980 GstElement *peer_element;
1982 if ((peer_element = gst_pad_get_parent_element (peer))) {
1983 GST_OBJECT_LOCK (peer_element);
1984 /* check that we don't go outside of this bin */
1985 if (GST_OBJECT_CAST (peer_element)->parent ==
1986 GST_OBJECT_CAST (bit->bin)) {
1987 gint old_deg, new_deg;
1989 old_deg = HASH_GET_DEGREE (bit, peer_element);
1991 /* check to see if we added an element as sink that was not really a
1992 * sink because it was connected to some other element. */
1993 if (old_deg == -1) {
1994 remove_from_queue (bit, peer_element);
1997 new_deg = old_deg + bit->mode;
1999 GST_DEBUG_OBJECT (bit->bin,
2000 "change element %s, degree %d->%d, linked to %s",
2001 GST_ELEMENT_NAME (peer_element), old_deg, new_deg,
2002 GST_ELEMENT_NAME (element));
2004 /* update degree, it is possible that an element was in 0 and
2005 * reaches -1 here. This would mean that the element had no sinkpads
2006 * but became linked while the state change was happening. We will
2007 * resync on this with the structure change message. */
2009 /* degree hit 0, add to queue */
2010 add_to_queue (bit, peer_element);
2012 HASH_SET_DEGREE (bit, peer_element, new_deg);
2016 GST_OBJECT_UNLOCK (peer_element);
2017 gst_object_unref (peer_element);
2019 gst_object_unref (peer);
2024 GST_DEBUG_OBJECT (bit->bin, "element %s not linked on any sinkpads",
2025 GST_ELEMENT_NAME (element));
2027 GST_OBJECT_UNLOCK (element);
2030 /* find the next best element not handled yet. This is the one
2031 * with the lowest non-negative degree */
2033 find_element (GstElement * element, GstBinSortIterator * bit)
2037 /* element is already handled */
2038 if ((degree = HASH_GET_DEGREE (bit, element)) < 0)
2041 /* first element or element with smaller degree */
2042 if (bit->best == NULL || bit->best_deg > degree) {
2043 bit->best = element;
2044 bit->best_deg = degree;
2048 /* get next element in iterator. */
2049 static GstIteratorResult
2050 gst_bin_sort_iterator_next (GstBinSortIterator * bit, GValue * result)
2053 GstBin *bin = bit->bin;
2055 /* empty queue, we have to find a next best element */
2056 if (g_queue_is_empty (&bit->queue)) {
2058 bit->best_deg = G_MAXINT;
2059 g_list_foreach (bin->children, (GFunc) find_element, bit);
2060 if ((best = bit->best)) {
2061 /* when we detected an unlink, don't warn because our degrees might be
2062 * screwed up. We will resync later */
2063 if (bit->best_deg != 0 && !bit->dirty) {
2064 /* we don't fail on this one yet */
2065 GST_WARNING_OBJECT (bin, "loop dected in graph");
2066 g_warning ("loop detected in the graph of bin '%s'!!",
2067 GST_ELEMENT_NAME (bin));
2069 /* best unhandled element, schedule as next element */
2070 GST_DEBUG_OBJECT (bin, "queue empty, next best: %s",
2071 GST_ELEMENT_NAME (best));
2072 HASH_SET_DEGREE (bit, best, -1);
2073 g_value_set_object (result, best);
2075 GST_DEBUG_OBJECT (bin, "queue empty, elements exhausted");
2076 /* no more unhandled elements, we are done */
2077 return GST_ITERATOR_DONE;
2080 /* everything added to the queue got reffed */
2081 best = g_queue_pop_head (&bit->queue);
2082 g_value_set_object (result, best);
2083 gst_object_unref (best);
2086 GST_DEBUG_OBJECT (bin, "queue head gives %s", GST_ELEMENT_NAME (best));
2087 /* update degrees of linked elements */
2088 update_degree (best, bit);
2090 return GST_ITERATOR_OK;
2093 /* clear queues, recalculate the degrees and restart. */
2095 gst_bin_sort_iterator_resync (GstBinSortIterator * bit)
2097 GstBin *bin = bit->bin;
2099 GST_DEBUG_OBJECT (bin, "resync");
2101 clear_queue (&bit->queue);
2103 g_list_foreach (bin->children, (GFunc) reset_degree, bit);
2104 /* calc degrees, incrementing */
2106 g_list_foreach (bin->children, (GFunc) update_degree, bit);
2107 /* for the rest of the function we decrement the degrees */
2111 /* clear queues, unref bin and free iterator. */
2113 gst_bin_sort_iterator_free (GstBinSortIterator * bit)
2115 GstBin *bin = bit->bin;
2117 GST_DEBUG_OBJECT (bin, "free");
2118 clear_queue (&bit->queue);
2119 g_hash_table_destroy (bit->hash);
2120 gst_object_unref (bin);
2123 /* should be called with the bin LOCK held */
2124 static GstIterator *
2125 gst_bin_sort_iterator_new (GstBin * bin)
2127 GstBinSortIterator *result;
2129 /* we don't need an ItemFunction because we ref the items in the _next
2131 result = (GstBinSortIterator *)
2132 gst_iterator_new (sizeof (GstBinSortIterator),
2134 GST_OBJECT_GET_LOCK (bin),
2135 &bin->priv->structure_cookie,
2136 (GstIteratorCopyFunction) gst_bin_sort_iterator_copy,
2137 (GstIteratorNextFunction) gst_bin_sort_iterator_next,
2138 (GstIteratorItemFunction) NULL,
2139 (GstIteratorResyncFunction) gst_bin_sort_iterator_resync,
2140 (GstIteratorFreeFunction) gst_bin_sort_iterator_free);
2141 g_queue_init (&result->queue);
2142 result->hash = g_hash_table_new (NULL, NULL);
2143 gst_object_ref (bin);
2145 gst_bin_sort_iterator_resync (result);
2147 return (GstIterator *) result;
2151 * gst_bin_iterate_sorted:
2154 * Gets an iterator for the elements in this bin in topologically
2155 * sorted order. This means that the elements are returned from
2156 * the most downstream elements (sinks) to the sources.
2158 * This function is used internally to perform the state changes
2159 * of the bin elements and for clock selection.
2161 * MT safe. Caller owns returned value.
2163 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
2166 gst_bin_iterate_sorted (GstBin * bin)
2168 GstIterator *result;
2170 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
2172 GST_OBJECT_LOCK (bin);
2173 result = gst_bin_sort_iterator_new (bin);
2174 GST_OBJECT_UNLOCK (bin);
2179 static GstStateChangeReturn
2180 gst_bin_element_set_state (GstBin * bin, GstElement * element,
2181 GstClockTime base_time, GstClockTime start_time, GstState current,
2184 GstStateChangeReturn ret;
2185 GstState child_current, child_pending;
2189 GST_STATE_LOCK (element);
2191 GST_OBJECT_LOCK (element);
2192 /* set base_time and start time on child */
2193 GST_ELEMENT_START_TIME (element) = start_time;
2194 element->base_time = base_time;
2195 /* peel off the locked flag */
2196 locked = GST_ELEMENT_IS_LOCKED_STATE (element);
2197 /* Get the previous set_state result to preserve NO_PREROLL and ASYNC */
2198 ret = GST_STATE_RETURN (element);
2199 child_current = GST_STATE (element);
2200 child_pending = GST_STATE_PENDING (element);
2201 GST_OBJECT_UNLOCK (element);
2203 /* skip locked elements */
2204 if (G_UNLIKELY (locked))
2207 /* if the element was no preroll, just start changing the state regardless
2208 * if it had async elements (in the case of a bin) because they won't preroll
2210 if (G_UNLIKELY (ret == GST_STATE_CHANGE_NO_PREROLL)) {
2211 GST_DEBUG_OBJECT (element, "element is NO_PREROLL, ignore async elements");
2215 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2216 "current %s pending %s, desired next %s",
2217 gst_element_state_get_name (child_current),
2218 gst_element_state_get_name (child_pending),
2219 gst_element_state_get_name (next));
2221 /* always recurse into bins so that we can set the base time */
2222 if (GST_IS_BIN (element))
2225 /* Try not to change the state of elements that are already in the state we're
2227 if (child_current == next && child_pending == GST_STATE_VOID_PENDING) {
2228 /* child is already at the requested state, return previous return. Note that
2229 * if the child has a pending state to next, we will still call the
2230 * set_state function */
2232 } else if (next > current) {
2233 /* upward state change */
2234 if (child_pending == GST_STATE_VOID_PENDING) {
2235 /* .. and the child is not busy doing anything */
2236 if (child_current > next) {
2237 /* .. and is already past the requested state, assume it got there
2239 ret = GST_STATE_CHANGE_SUCCESS;
2242 } else if (child_pending > child_current) {
2243 /* .. and the child is busy going upwards */
2244 if (child_current >= next) {
2245 /* .. and is already past the requested state, assume it got there
2247 ret = GST_STATE_CHANGE_SUCCESS;
2251 /* .. and the child is busy going downwards */
2252 if (child_current > next) {
2253 /* .. and is already past the requested state, assume it got there
2255 ret = GST_STATE_CHANGE_SUCCESS;
2259 } else if (next < current) {
2260 /* downward state change */
2261 if (child_pending == GST_STATE_VOID_PENDING) {
2262 /* .. and the child is not busy doing anything */
2263 if (child_current < next) {
2264 /* .. and is already past the requested state, assume it got there
2266 ret = GST_STATE_CHANGE_SUCCESS;
2269 } else if (child_pending < child_current) {
2270 /* .. and the child is busy going downwards */
2271 if (child_current <= next) {
2272 /* .. and is already past the requested state, assume it got there
2274 ret = GST_STATE_CHANGE_SUCCESS;
2278 /* .. and the child is busy going upwards */
2279 if (child_current < next) {
2280 /* .. and is already past the requested state, assume it got there
2282 ret = GST_STATE_CHANGE_SUCCESS;
2289 GST_OBJECT_LOCK (bin);
2290 /* the element was busy with an upwards async state change, we must wait for
2291 * an ASYNC_DONE message before we attemp to change the state. */
2293 find_message (bin, GST_OBJECT_CAST (element),
2294 GST_MESSAGE_ASYNC_START))) {
2295 #ifndef GST_DISABLE_GST_DEBUG
2296 GstMessage *message = GST_MESSAGE_CAST (found->data);
2298 GST_DEBUG_OBJECT (element, "element message %p, %s async busy",
2299 message, GST_ELEMENT_NAME (GST_MESSAGE_SRC (message)));
2301 /* only wait for upward state changes */
2302 if (next > current) {
2303 /* We found an async element check if we can force its state to change or
2304 * if we have to wait for it to preroll. */
2308 GST_OBJECT_UNLOCK (bin);
2311 GST_DEBUG_OBJECT (bin,
2312 "setting element %s to %s, base_time %" GST_TIME_FORMAT,
2313 GST_ELEMENT_NAME (element), gst_element_state_get_name (next),
2314 GST_TIME_ARGS (base_time));
2317 ret = gst_element_set_state (element, next);
2319 GST_STATE_UNLOCK (element);
2325 GST_DEBUG_OBJECT (element,
2326 "element is locked, return previous return %s",
2327 gst_element_state_change_return_get_name (ret));
2328 GST_STATE_UNLOCK (element);
2333 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2334 "skipping transition from %s to %s",
2335 gst_element_state_get_name (child_current),
2336 gst_element_state_get_name (next));
2337 GST_STATE_UNLOCK (element);
2342 GST_DEBUG_OBJECT (element, "element was busy, delaying state change");
2343 GST_OBJECT_UNLOCK (bin);
2344 GST_STATE_UNLOCK (element);
2345 return GST_STATE_CHANGE_ASYNC;
2349 /* gst_iterator_fold functions for pads_activate
2350 * Stop the iterator if activating one pad failed. */
2352 activate_pads (const GValue * vpad, GValue * ret, gboolean * active)
2354 GstPad *pad = g_value_get_object (vpad);
2355 gboolean cont = TRUE;
2357 if (!(cont = gst_pad_set_active (pad, *active)))
2358 g_value_set_boolean (ret, FALSE);
2363 /* returns false on error or early cutout of the fold, true if all
2364 * pads in @iter were (de)activated successfully. */
2366 iterator_activate_fold_with_resync (GstIterator * iter, gpointer user_data)
2368 GstIteratorResult ires;
2371 /* no need to unset this later, it's just a boolean */
2372 g_value_init (&ret, G_TYPE_BOOLEAN);
2373 g_value_set_boolean (&ret, TRUE);
2376 ires = gst_iterator_fold (iter, (GstIteratorFoldFunction) activate_pads,
2379 case GST_ITERATOR_RESYNC:
2380 /* need to reset the result again */
2381 g_value_set_boolean (&ret, TRUE);
2382 gst_iterator_resync (iter);
2384 case GST_ITERATOR_DONE:
2385 /* all pads iterated, return collected value */
2388 /* iterator returned _ERROR or premature end with _OK,
2389 * mark an error and exit */
2390 g_value_set_boolean (&ret, FALSE);
2395 /* return collected value */
2396 return g_value_get_boolean (&ret);
2399 /* is called with STATE_LOCK
2402 gst_bin_src_pads_activate (GstBin * bin, gboolean active)
2407 GST_DEBUG_OBJECT (bin, "%s pads", active ? "activate" : "deactivate");
2409 iter = gst_element_iterate_src_pads ((GstElement *) bin);
2410 fold_ok = iterator_activate_fold_with_resync (iter, &active);
2411 gst_iterator_free (iter);
2412 if (G_UNLIKELY (!fold_ok))
2415 GST_DEBUG_OBJECT (bin, "pad %sactivation successful", active ? "" : "de");
2422 GST_DEBUG_OBJECT (bin, "pad %sactivation failed", active ? "" : "de");
2428 * gst_bin_recalculate_latency:
2431 * Query @bin for the current latency using and reconfigures this latency to all the
2432 * elements with a LATENCY event.
2434 * This method is typically called on the pipeline when a #GST_MESSAGE_LATENCY
2435 * is posted on the bus.
2437 * This function simply emits the 'do-latency' signal so any custom latency
2438 * calculations will be performed.
2440 * Returns: %TRUE if the latency could be queried and reconfigured.
2443 gst_bin_recalculate_latency (GstBin * bin)
2447 g_signal_emit (bin, gst_bin_signals[DO_LATENCY], 0, &res);
2448 GST_DEBUG_OBJECT (bin, "latency returned %d", res);
2454 gst_bin_do_latency_func (GstBin * bin)
2457 GstElement *element;
2458 GstClockTime min_latency, max_latency;
2461 g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
2463 element = GST_ELEMENT_CAST (bin);
2465 GST_DEBUG_OBJECT (element, "querying latency");
2467 query = gst_query_new_latency ();
2468 if ((res = gst_element_query (element, query))) {
2471 gst_query_parse_latency (query, &live, &min_latency, &max_latency);
2473 GST_DEBUG_OBJECT (element,
2474 "got min latency %" GST_TIME_FORMAT ", max latency %"
2475 GST_TIME_FORMAT ", live %d", GST_TIME_ARGS (min_latency),
2476 GST_TIME_ARGS (max_latency), live);
2478 if (max_latency < min_latency) {
2479 /* this is an impossible situation, some parts of the pipeline might not
2480 * work correctly. We post a warning for now. */
2481 GST_ELEMENT_WARNING (element, CORE, CLOCK, (NULL),
2482 ("Impossible to configure latency: max %" GST_TIME_FORMAT " < min %"
2483 GST_TIME_FORMAT ". Add queues or other buffering elements.",
2484 GST_TIME_ARGS (max_latency), GST_TIME_ARGS (min_latency)));
2487 /* configure latency on elements */
2488 res = gst_element_send_event (element, gst_event_new_latency (min_latency));
2490 GST_INFO_OBJECT (element, "configured latency of %" GST_TIME_FORMAT,
2491 GST_TIME_ARGS (min_latency));
2493 GST_WARNING_OBJECT (element,
2494 "did not really configure latency of %" GST_TIME_FORMAT,
2495 GST_TIME_ARGS (min_latency));
2498 /* this is not a real problem, we just don't configure any latency. */
2499 GST_WARNING_OBJECT (element, "failed to query latency");
2501 gst_query_unref (query);
2507 gst_bin_state_changed (GstElement * element, GstState oldstate,
2508 GstState newstate, GstState pending)
2510 GstElementClass *pklass = (GstElementClass *) parent_class;
2512 if (newstate == GST_STATE_PLAYING && pending == GST_STATE_VOID_PENDING)
2513 bin_do_eos (GST_BIN_CAST (element));
2515 if (pklass->state_changed)
2516 pklass->state_changed (element, oldstate, newstate, pending);
2519 static GstStateChangeReturn
2520 gst_bin_change_state_func (GstElement * element, GstStateChange transition)
2523 GstStateChangeReturn ret;
2524 GstState current, next;
2525 gboolean have_async;
2526 gboolean have_no_preroll;
2527 GstClockTime base_time, start_time;
2530 GValue data = { 0, };
2532 /* we don't need to take the STATE_LOCK, it is already taken */
2533 current = (GstState) GST_STATE_TRANSITION_CURRENT (transition);
2534 next = (GstState) GST_STATE_TRANSITION_NEXT (transition);
2536 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2537 "changing state of children from %s to %s",
2538 gst_element_state_get_name (current), gst_element_state_get_name (next));
2540 bin = GST_BIN_CAST (element);
2543 case GST_STATE_PLAYING:
2547 GST_OBJECT_LOCK (bin);
2548 toplevel = BIN_IS_TOPLEVEL (bin);
2549 GST_OBJECT_UNLOCK (bin);
2552 gst_bin_recalculate_latency (bin);
2555 case GST_STATE_PAUSED:
2556 /* Clear EOS list on next PAUSED */
2557 GST_OBJECT_LOCK (bin);
2558 GST_DEBUG_OBJECT (element, "clearing EOS elements");
2559 bin_remove_messages (bin, NULL, GST_MESSAGE_EOS);
2560 bin->priv->posted_eos = FALSE;
2561 if (current == GST_STATE_READY)
2562 bin_remove_messages (bin, NULL, GST_MESSAGE_STREAM_START);
2563 GST_OBJECT_UNLOCK (bin);
2564 if (current == GST_STATE_READY)
2565 if (!(gst_bin_src_pads_activate (bin, TRUE)))
2566 goto activate_failure;
2568 case GST_STATE_READY:
2569 /* Clear message list on next READY */
2570 GST_OBJECT_LOCK (bin);
2571 GST_DEBUG_OBJECT (element, "clearing all cached messages");
2572 bin_remove_messages (bin, NULL, GST_MESSAGE_ANY);
2573 GST_OBJECT_UNLOCK (bin);
2574 if (current == GST_STATE_PAUSED)
2575 if (!(gst_bin_src_pads_activate (bin, FALSE)))
2576 goto activate_failure;
2578 case GST_STATE_NULL:
2579 if (current == GST_STATE_READY)
2580 if (!(gst_bin_src_pads_activate (bin, FALSE)))
2581 goto activate_failure;
2587 /* this flag is used to make the async state changes return immediately. We
2588 * don't want them to interfere with this state change */
2589 GST_OBJECT_LOCK (bin);
2590 bin->polling = TRUE;
2591 GST_OBJECT_UNLOCK (bin);
2593 /* iterate in state change order */
2594 it = gst_bin_iterate_sorted (bin);
2596 /* mark if we've seen an ASYNC element in the bin when we did a state change.
2597 * Note how we don't reset this value when a resync happens, the reason being
2598 * that the async element posted ASYNC_START and we want to post ASYNC_DONE
2599 * even after a resync when the async element is gone */
2603 /* take base_time */
2604 base_time = gst_element_get_base_time (element);
2605 start_time = gst_element_get_start_time (element);
2607 have_no_preroll = FALSE;
2611 switch (gst_iterator_next (it, &data)) {
2612 case GST_ITERATOR_OK:
2616 child = g_value_get_object (&data);
2618 /* set state and base_time now */
2619 ret = gst_bin_element_set_state (bin, child, base_time, start_time,
2623 case GST_STATE_CHANGE_SUCCESS:
2624 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2625 "child '%s' changed state to %d(%s) successfully",
2626 GST_ELEMENT_NAME (child), next,
2627 gst_element_state_get_name (next));
2629 case GST_STATE_CHANGE_ASYNC:
2631 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2632 "child '%s' is changing state asynchronously to %s",
2633 GST_ELEMENT_NAME (child), gst_element_state_get_name (next));
2637 case GST_STATE_CHANGE_FAILURE:{
2640 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2641 "child '%s' failed to go to state %d(%s)",
2642 GST_ELEMENT_NAME (child),
2643 next, gst_element_state_get_name (next));
2645 /* Only fail if the child is still inside
2646 * this bin. It might've been removed already
2647 * because of the error by the bin subclass
2648 * to ignore the error. */
2649 parent = gst_object_get_parent (GST_OBJECT_CAST (child));
2650 if (parent == GST_OBJECT_CAST (element)) {
2651 /* element is still in bin, really error now */
2652 gst_object_unref (parent);
2655 /* child removed from bin, let the resync code redo the state
2657 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2658 "child '%s' was removed from the bin",
2659 GST_ELEMENT_NAME (child));
2662 gst_object_unref (parent);
2666 case GST_STATE_CHANGE_NO_PREROLL:
2667 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2668 "child '%s' changed state to %d(%s) successfully without preroll",
2669 GST_ELEMENT_NAME (child), next,
2670 gst_element_state_get_name (next));
2671 have_no_preroll = TRUE;
2674 g_assert_not_reached ();
2677 g_value_reset (&data);
2680 case GST_ITERATOR_RESYNC:
2681 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "iterator doing resync");
2682 gst_iterator_resync (it);
2685 case GST_ITERATOR_DONE:
2686 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "iterator done");
2692 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2693 if (G_UNLIKELY (ret == GST_STATE_CHANGE_FAILURE))
2696 if (have_no_preroll) {
2697 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2698 "we have NO_PREROLL elements %s -> NO_PREROLL",
2699 gst_element_state_change_return_get_name (ret));
2700 ret = GST_STATE_CHANGE_NO_PREROLL;
2701 } else if (have_async) {
2702 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2703 "we have ASYNC elements %s -> ASYNC",
2704 gst_element_state_change_return_get_name (ret));
2705 ret = GST_STATE_CHANGE_ASYNC;
2709 g_value_unset (&data);
2710 gst_iterator_free (it);
2712 GST_OBJECT_LOCK (bin);
2713 bin->polling = FALSE;
2714 /* it's possible that we did not get ASYNC from the children while the bin is
2715 * simulating ASYNC behaviour by posting an ASYNC_DONE message on the bus with
2716 * itself as the source. In that case we still want to check if the state
2717 * change completed. */
2718 if (ret != GST_STATE_CHANGE_ASYNC && !bin->priv->pending_async_done) {
2719 /* no element returned ASYNC and there are no pending async_done messages,
2720 * we can just complete. */
2721 GST_DEBUG_OBJECT (bin, "no async elements");
2724 /* when we get here an ASYNC element was found */
2725 if (GST_STATE_TARGET (bin) <= GST_STATE_READY) {
2726 /* we ignore ASYNC state changes when we go to READY or NULL */
2727 GST_DEBUG_OBJECT (bin, "target state %s <= READY",
2728 gst_element_state_get_name (GST_STATE_TARGET (bin)));
2732 GST_DEBUG_OBJECT (bin, "check async elements");
2733 /* check if all elements managed to commit their state already */
2734 if (!find_message (bin, NULL, GST_MESSAGE_ASYNC_START)) {
2735 /* nothing found, remove all old ASYNC_DONE messages. This can happen when
2736 * all the elements commited their state while we were doing the state
2737 * change. We will still return ASYNC for consistency but we commit the
2738 * state already so that a _get_state() will return immediately. */
2739 bin_remove_messages (bin, NULL, GST_MESSAGE_ASYNC_DONE);
2741 GST_DEBUG_OBJECT (bin, "async elements commited");
2742 bin_handle_async_done (bin, GST_STATE_CHANGE_SUCCESS, FALSE,
2743 GST_CLOCK_TIME_NONE);
2747 bin->priv->pending_async_done = FALSE;
2748 GST_OBJECT_UNLOCK (bin);
2750 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2751 "done changing bin's state from %s to %s, now in %s, ret %s",
2752 gst_element_state_get_name (current),
2753 gst_element_state_get_name (next),
2754 gst_element_state_get_name (GST_STATE (element)),
2755 gst_element_state_change_return_get_name (ret));
2762 GST_CAT_WARNING_OBJECT (GST_CAT_STATES, element,
2763 "failure (de)activating src pads");
2764 return GST_STATE_CHANGE_FAILURE;
2769 * This function is a utility event handler for seek events.
2770 * It will send the event to all sinks or sources and appropriate
2771 * ghost pads depending on the event-direction.
2773 * Applications are free to override this behaviour and
2774 * implement their own seek handler, but this will work for
2775 * pretty much all cases in practice.
2778 gst_bin_send_event (GstElement * element, GstEvent * event)
2780 GstBin *bin = GST_BIN_CAST (element);
2782 gboolean res = TRUE;
2783 gboolean done = FALSE;
2784 GValue data = { 0, };
2786 if (GST_EVENT_IS_DOWNSTREAM (event)) {
2787 iter = gst_bin_iterate_sources (bin);
2788 GST_DEBUG_OBJECT (bin, "Sending %s event to src children",
2789 GST_EVENT_TYPE_NAME (event));
2791 iter = gst_bin_iterate_sinks (bin);
2792 GST_DEBUG_OBJECT (bin, "Sending %s event to sink children",
2793 GST_EVENT_TYPE_NAME (event));
2797 switch (gst_iterator_next (iter, &data)) {
2798 case GST_ITERATOR_OK:
2800 GstElement *child = g_value_get_object (&data);
2802 gst_event_ref (event);
2803 res &= gst_element_send_event (child, event);
2805 GST_LOG_OBJECT (child, "After handling %s event: %d",
2806 GST_EVENT_TYPE_NAME (event), res);
2808 g_value_reset (&data);
2811 case GST_ITERATOR_RESYNC:
2812 gst_iterator_resync (iter);
2815 case GST_ITERATOR_DONE:
2818 case GST_ITERATOR_ERROR:
2819 g_assert_not_reached ();
2823 g_value_unset (&data);
2824 gst_iterator_free (iter);
2826 if (GST_EVENT_IS_DOWNSTREAM (event)) {
2827 iter = gst_element_iterate_sink_pads (GST_ELEMENT (bin));
2828 GST_DEBUG_OBJECT (bin, "Sending %s event to sink pads",
2829 GST_EVENT_TYPE_NAME (event));
2831 iter = gst_element_iterate_src_pads (GST_ELEMENT (bin));
2832 GST_DEBUG_OBJECT (bin, "Sending %s event to src pads",
2833 GST_EVENT_TYPE_NAME (event));
2838 switch (gst_iterator_next (iter, &data)) {
2839 case GST_ITERATOR_OK:
2841 GstPad *pad = g_value_get_object (&data);
2843 gst_event_ref (event);
2844 res &= gst_pad_send_event (pad, event);
2845 GST_LOG_OBJECT (pad, "After handling %s event: %d",
2846 GST_EVENT_TYPE_NAME (event), res);
2849 case GST_ITERATOR_RESYNC:
2850 gst_iterator_resync (iter);
2853 case GST_ITERATOR_DONE:
2856 case GST_ITERATOR_ERROR:
2857 g_assert_not_reached ();
2862 g_value_unset (&data);
2863 gst_iterator_free (iter);
2864 gst_event_unref (event);
2869 /* this is the function called by the threadpool. When async elements commit
2870 * their state, this function will attempt to bring the bin to the next state.
2873 gst_bin_continue_func (BinContinueData * data)
2876 GstState current, next, pending;
2877 GstStateChange transition;
2880 pending = data->pending;
2882 GST_DEBUG_OBJECT (bin, "waiting for state lock");
2883 GST_STATE_LOCK (bin);
2885 GST_DEBUG_OBJECT (bin, "doing state continue");
2886 GST_OBJECT_LOCK (bin);
2888 /* if a new state change happened after this thread was scheduled, we return
2890 if (data->cookie != GST_ELEMENT_CAST (bin)->state_cookie)
2893 current = GST_STATE (bin);
2894 next = GST_STATE_GET_NEXT (current, pending);
2895 transition = (GstStateChange) GST_STATE_TRANSITION (current, next);
2897 GST_STATE_NEXT (bin) = next;
2898 GST_STATE_PENDING (bin) = pending;
2900 GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
2901 GST_OBJECT_UNLOCK (bin);
2903 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2904 "continue state change %s to %s, final %s",
2905 gst_element_state_get_name (current),
2906 gst_element_state_get_name (next), gst_element_state_get_name (pending));
2908 gst_element_change_state (GST_ELEMENT_CAST (bin), transition);
2910 GST_STATE_UNLOCK (bin);
2911 GST_DEBUG_OBJECT (bin, "state continue done");
2913 gst_object_unref (bin);
2914 g_slice_free (BinContinueData, data);
2919 GST_OBJECT_UNLOCK (bin);
2920 GST_STATE_UNLOCK (bin);
2921 GST_DEBUG_OBJECT (bin, "state continue aborted due to intervening change");
2922 gst_object_unref (bin);
2923 g_slice_free (BinContinueData, data);
2928 static GstBusSyncReply
2929 bin_bus_handler (GstBus * bus, GstMessage * message, GstBin * bin)
2931 GstBinClass *bclass;
2933 bclass = GST_BIN_GET_CLASS (bin);
2934 if (bclass->handle_message)
2935 bclass->handle_message (bin, message);
2937 gst_message_unref (message);
2939 return GST_BUS_DROP;
2943 bin_push_state_continue (BinContinueData * data)
2950 klass = GST_BIN_GET_CLASS (bin);
2952 GST_DEBUG_OBJECT (bin, "pushing continue on thread pool");
2953 g_thread_pool_push (klass->pool, data, NULL);
2956 /* an element started an async state change, if we were not busy with a state
2957 * change, we perform a lost state.
2958 * This function is called with the OBJECT lock.
2961 bin_handle_async_start (GstBin * bin)
2963 GstState old_state, new_state;
2965 GstMessage *amessage = NULL;
2967 if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_FAILURE)
2970 /* get our toplevel state */
2971 toplevel = BIN_IS_TOPLEVEL (bin);
2973 /* prepare an ASYNC_START message, we always post the start message even if we
2974 * are busy with a state change or when we are NO_PREROLL. */
2976 /* non toplevel bin, prepare async-start for the parent */
2977 amessage = gst_message_new_async_start (GST_OBJECT_CAST (bin));
2979 if (bin->polling || GST_STATE_PENDING (bin) != GST_STATE_VOID_PENDING)
2982 /* async starts are ignored when we are NO_PREROLL */
2983 if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_NO_PREROLL)
2984 goto was_no_preroll;
2986 old_state = GST_STATE (bin);
2988 /* when we PLAYING we go back to PAUSED, when preroll happens, we go back to
2989 * PLAYING after optionally redistributing the base_time. */
2990 if (old_state > GST_STATE_PAUSED)
2991 new_state = GST_STATE_PAUSED;
2993 new_state = old_state;
2995 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2996 "lost state of %s, new %s", gst_element_state_get_name (old_state),
2997 gst_element_state_get_name (new_state));
2999 GST_STATE (bin) = new_state;
3000 GST_STATE_NEXT (bin) = new_state;
3001 GST_STATE_PENDING (bin) = new_state;
3002 GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
3003 GST_OBJECT_UNLOCK (bin);
3006 _priv_gst_element_state_changed (GST_ELEMENT_CAST (bin), new_state, new_state,
3011 /* post our ASYNC_START. */
3012 GST_DEBUG_OBJECT (bin, "posting ASYNC_START to parent");
3013 gst_element_post_message (GST_ELEMENT_CAST (bin), amessage);
3015 GST_OBJECT_LOCK (bin);
3021 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "we had an error");
3026 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "state change busy");
3027 GST_OBJECT_UNLOCK (bin);
3032 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "ignoring, we are NO_PREROLL");
3033 GST_OBJECT_UNLOCK (bin);
3038 /* this function is called when there are no more async elements in the bin. We
3039 * post a state changed message and an ASYNC_DONE message.
3040 * This function is called with the OBJECT lock.
3043 bin_handle_async_done (GstBin * bin, GstStateChangeReturn ret,
3044 gboolean flag_pending, GstClockTime running_time)
3046 GstState current, pending, target;
3047 GstStateChangeReturn old_ret;
3048 GstState old_state, old_next;
3049 gboolean toplevel, state_changed = FALSE;
3050 GstMessage *amessage = NULL;
3051 BinContinueData *cont = NULL;
3053 if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_FAILURE)
3056 pending = GST_STATE_PENDING (bin);
3061 /* check if there is something to commit */
3062 if (pending == GST_STATE_VOID_PENDING)
3063 goto nothing_pending;
3065 old_ret = GST_STATE_RETURN (bin);
3066 GST_STATE_RETURN (bin) = ret;
3068 /* move to the next target state */
3069 target = GST_STATE_TARGET (bin);
3070 pending = GST_STATE_PENDING (bin) = target;
3072 amessage = gst_message_new_async_done (GST_OBJECT_CAST (bin), running_time);
3074 old_state = GST_STATE (bin);
3075 /* this is the state we should go to next */
3076 old_next = GST_STATE_NEXT (bin);
3078 if (old_next != GST_STATE_PLAYING) {
3079 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
3080 "committing state from %s to %s, old pending %s",
3081 gst_element_state_get_name (old_state),
3082 gst_element_state_get_name (old_next),
3083 gst_element_state_get_name (pending));
3085 /* update current state */
3086 current = GST_STATE (bin) = old_next;
3088 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
3089 "setting state from %s to %s, pending %s",
3090 gst_element_state_get_name (old_state),
3091 gst_element_state_get_name (old_state),
3092 gst_element_state_get_name (pending));
3093 current = old_state;
3096 /* get our toplevel state */
3097 toplevel = BIN_IS_TOPLEVEL (bin);
3099 /* see if we reached the final state. If we are not toplevel, we also have to
3100 * stop here, the parent will continue our state. */
3101 if ((pending == current) || !toplevel) {
3102 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
3103 "completed state change, pending VOID");
3105 /* mark VOID pending */
3106 pending = GST_STATE_VOID_PENDING;
3107 GST_STATE_PENDING (bin) = pending;
3108 GST_STATE_NEXT (bin) = GST_STATE_VOID_PENDING;
3110 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
3111 "continue state change, pending %s",
3112 gst_element_state_get_name (pending));
3114 cont = g_slice_new (BinContinueData);
3116 /* ref to the bin */
3117 cont->bin = gst_object_ref (bin);
3118 /* cookie to detect concurrent state change */
3119 cont->cookie = GST_ELEMENT_CAST (bin)->state_cookie;
3120 /* pending target state */
3121 cont->pending = pending;
3123 GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
3124 GST_STATE_NEXT (bin) = GST_STATE_GET_NEXT (old_state, pending);
3127 if (old_next != GST_STATE_PLAYING) {
3128 if (old_state != old_next || old_ret == GST_STATE_CHANGE_ASYNC) {
3129 state_changed = TRUE;
3132 GST_OBJECT_UNLOCK (bin);
3134 if (state_changed) {
3135 _priv_gst_element_state_changed (GST_ELEMENT_CAST (bin), old_state,
3139 /* post our combined ASYNC_DONE when all is ASYNC_DONE. */
3140 GST_DEBUG_OBJECT (bin, "posting ASYNC_DONE to parent");
3141 gst_element_post_message (GST_ELEMENT_CAST (bin), amessage);
3144 GST_OBJECT_LOCK (bin);
3146 /* toplevel, start continue state */
3147 GST_DEBUG_OBJECT (bin, "all async-done, starting state continue");
3148 bin_push_state_continue (cont);
3150 GST_DEBUG_OBJECT (bin, "state change complete");
3151 GST_STATE_BROADCAST (bin);
3157 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "we had an error");
3162 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "state change busy");
3163 /* if we were busy with a state change and we are requested to flag a
3164 * pending async done, we do so here */
3166 bin->priv->pending_async_done = TRUE;
3171 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin, "nothing pending");
3177 bin_do_eos (GstBin * bin)
3182 GST_OBJECT_LOCK (bin);
3183 /* If all sinks are EOS, we're in PLAYING and no state change is pending
3184 * we forward the EOS message to the parent bin or application
3186 eos = GST_STATE (bin) == GST_STATE_PLAYING
3187 && GST_STATE_PENDING (bin) == GST_STATE_VOID_PENDING
3188 && is_eos (bin, &seqnum);
3189 GST_OBJECT_UNLOCK (bin);
3192 && g_atomic_int_compare_and_exchange (&bin->priv->posted_eos, FALSE,
3194 GstMessage *tmessage;
3196 /* Clear out any further messages, and reset posted_eos so we can
3197 detect any new EOS that happens (eg, after a seek). Since all
3198 sinks have now posted an EOS, there will be no further EOS events
3199 seen unless there is a new logical EOS */
3200 GST_OBJECT_LOCK (bin);
3201 bin_remove_messages (bin, NULL, GST_MESSAGE_EOS);
3202 bin->priv->posted_eos = FALSE;
3203 GST_OBJECT_UNLOCK (bin);
3205 tmessage = gst_message_new_eos (GST_OBJECT_CAST (bin));
3206 gst_message_set_seqnum (tmessage, seqnum);
3207 GST_DEBUG_OBJECT (bin,
3208 "all sinks posted EOS, posting seqnum #%" G_GUINT32_FORMAT, seqnum);
3209 gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3214 bin_do_stream_start (GstBin * bin)
3217 gboolean stream_start;
3218 gboolean have_group_id = FALSE;
3221 GST_OBJECT_LOCK (bin);
3222 /* If all sinks are STREAM_START we forward the STREAM_START message
3223 * to the parent bin or application
3225 stream_start = is_stream_start (bin, &seqnum, &have_group_id, &group_id);
3226 GST_OBJECT_UNLOCK (bin);
3229 GstMessage *tmessage;
3231 GST_OBJECT_LOCK (bin);
3232 bin_remove_messages (bin, NULL, GST_MESSAGE_STREAM_START);
3233 GST_OBJECT_UNLOCK (bin);
3235 tmessage = gst_message_new_stream_start (GST_OBJECT_CAST (bin));
3236 gst_message_set_seqnum (tmessage, seqnum);
3238 gst_message_set_group_id (tmessage, group_id);
3240 GST_DEBUG_OBJECT (bin,
3241 "all sinks posted STREAM_START, posting seqnum #%" G_GUINT32_FORMAT,
3243 gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3247 /* must be called with the object lock. This function releases the lock to post
3250 bin_do_message_forward (GstBin * bin, GstMessage * message)
3252 if (bin->priv->message_forward) {
3253 GstMessage *forwarded;
3255 GST_DEBUG_OBJECT (bin, "pass %s message upward",
3256 GST_MESSAGE_TYPE_NAME (message));
3257 GST_OBJECT_UNLOCK (bin);
3259 /* we need to convert these messages to element messages so that our parent
3260 * bin can easily ignore them and so that the application can easily
3261 * distinguish between the internally forwarded and the real messages. */
3262 forwarded = gst_message_new_element (GST_OBJECT_CAST (bin),
3263 gst_structure_new ("GstBinForwarded",
3264 "message", GST_TYPE_MESSAGE, message, NULL));
3266 gst_element_post_message (GST_ELEMENT_CAST (bin), forwarded);
3268 GST_OBJECT_LOCK (bin);
3272 /* handle child messages:
3274 * This method is called synchronously when a child posts a message on
3277 * GST_MESSAGE_EOS: This message is only posted by sinks
3278 * in the PLAYING state. If all sinks posted the EOS message, post
3281 * GST_MESSAGE_STATE_DIRTY: Deprecated
3283 * GST_MESSAGE_SEGMENT_START: just collect, never forward upwards. If an
3284 * element posts segment_start twice, only the last message is kept.
3286 * GST_MESSAGE_SEGMENT_DONE: replace SEGMENT_START message from same poster
3287 * with the segment_done message. If there are no more segment_start
3288 * messages, post segment_done message upwards.
3290 * GST_MESSAGE_DURATION_CHANGED: clear any cached durations.
3291 * Whenever someone performs a duration query on the bin, we store the
3292 * result so we can answer it quicker the next time. Any element that
3293 * changes its duration marks our cached values invalid.
3294 * This message is also posted upwards. This is currently disabled
3295 * because too many elements don't post DURATION_CHANGED messages when
3296 * the duration changes.
3298 * GST_MESSAGE_CLOCK_LOST: This message is posted by an element when it
3299 * can no longer provide a clock. The default bin behaviour is to
3300 * check if the lost clock was the one provided by the bin. If so and
3301 * we are currently in the PLAYING state, we forward the message to
3303 * This message is also generated when we remove a clock provider from
3304 * a bin. If this message is received by the application, it should
3305 * PAUSE the pipeline and set it back to PLAYING to force a new clock
3306 * and a new base_time distribution.
3308 * GST_MESSAGE_CLOCK_PROVIDE: This message is generated when an element
3309 * can provide a clock. This mostly happens when we add a new clock
3310 * provider to the bin. The default behaviour of the bin is to mark the
3311 * currently selected clock as dirty, which will perform a clock
3312 * recalculation the next time we are asked to provide a clock.
3313 * This message is never sent to the application but is forwarded to
3316 * GST_MESSAGE_ASYNC_START: Create an internal ELEMENT message that stores
3317 * the state of the element and the fact that the element will need a
3318 * new base_time. This message is not forwarded to the application.
3320 * GST_MESSAGE_ASYNC_DONE: Find the internal ELEMENT message we kept for the
3321 * element when it posted ASYNC_START. If all elements are done, post a
3322 * ASYNC_DONE message to the parent.
3324 * OTHER: post upwards.
3327 gst_bin_handle_message_func (GstBin * bin, GstMessage * message)
3330 GstMessageType type;
3331 GstMessage *tmessage;
3334 src = GST_MESSAGE_SRC (message);
3335 type = GST_MESSAGE_TYPE (message);
3337 GST_DEBUG_OBJECT (bin, "[msg %p] handling child %s message of type %s",
3338 message, src ? GST_ELEMENT_NAME (src) : "(NULL)",
3339 GST_MESSAGE_TYPE_NAME (message));
3342 case GST_MESSAGE_ERROR:
3344 GST_OBJECT_LOCK (bin);
3346 GST_DEBUG_OBJECT (bin, "got ERROR message, unlocking state change");
3347 GST_STATE_RETURN (bin) = GST_STATE_CHANGE_FAILURE;
3348 GST_STATE_BROADCAST (bin);
3349 GST_OBJECT_UNLOCK (bin);
3353 case GST_MESSAGE_EOS:
3356 /* collect all eos messages from the children */
3357 GST_OBJECT_LOCK (bin);
3358 bin_do_message_forward (bin, message);
3359 /* ref message for future use */
3360 bin_replace_message (bin, message, GST_MESSAGE_EOS);
3361 GST_OBJECT_UNLOCK (bin);
3366 case GST_MESSAGE_STREAM_START:
3369 /* collect all stream_start messages from the children */
3370 GST_OBJECT_LOCK (bin);
3371 /* ref message for future use */
3372 bin_replace_message (bin, message, GST_MESSAGE_STREAM_START);
3373 GST_OBJECT_UNLOCK (bin);
3375 bin_do_stream_start (bin);
3378 case GST_MESSAGE_STATE_DIRTY:
3380 GST_WARNING_OBJECT (bin, "received deprecated STATE_DIRTY message");
3383 gst_message_unref (message);
3386 case GST_MESSAGE_SEGMENT_START:{
3387 gboolean post = FALSE;
3391 gst_message_parse_segment_start (message, &format, &position);
3392 seqnum = gst_message_get_seqnum (message);
3394 GST_OBJECT_LOCK (bin);
3395 bin_do_message_forward (bin, message);
3396 /* if this is the first segment-start, post to parent but not to the
3398 if (!find_message (bin, NULL, GST_MESSAGE_SEGMENT_START) &&
3399 (GST_OBJECT_PARENT (bin) != NULL)) {
3402 /* replace any previous segment_start message from this source
3403 * with the new segment start message */
3404 bin_replace_message (bin, message, GST_MESSAGE_SEGMENT_START);
3405 GST_OBJECT_UNLOCK (bin);
3407 tmessage = gst_message_new_segment_start (GST_OBJECT_CAST (bin),
3409 gst_message_set_seqnum (tmessage, seqnum);
3411 /* post segment start with initial format and position. */
3412 GST_DEBUG_OBJECT (bin, "posting SEGMENT_START (%u) bus message: %p",
3414 gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3418 case GST_MESSAGE_SEGMENT_DONE:
3420 gboolean post = FALSE;
3424 gst_message_parse_segment_done (message, &format, &position);
3425 seqnum = gst_message_get_seqnum (message);
3427 GST_OBJECT_LOCK (bin);
3428 bin_do_message_forward (bin, message);
3429 bin_replace_message (bin, message, GST_MESSAGE_SEGMENT_START);
3430 /* if there are no more segment_start messages, everybody posted
3431 * a segment_done and we can post one on the bus. */
3433 /* we don't care who still has a pending segment start */
3434 if (!find_message (bin, NULL, GST_MESSAGE_SEGMENT_START)) {
3437 /* remove all old segment_done messages */
3438 bin_remove_messages (bin, NULL, GST_MESSAGE_SEGMENT_DONE);
3440 GST_OBJECT_UNLOCK (bin);
3442 tmessage = gst_message_new_segment_done (GST_OBJECT_CAST (bin),
3444 gst_message_set_seqnum (tmessage, seqnum);
3446 /* post segment done with latest format and position. */
3447 GST_DEBUG_OBJECT (bin, "posting SEGMENT_DONE (%u) bus message: %p",
3449 gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3453 case GST_MESSAGE_DURATION_CHANGED:
3455 /* FIXME: remove all cached durations, next time somebody asks
3456 * for duration, we will recalculate. */
3458 GST_OBJECT_LOCK (bin);
3459 bin_remove_messages (bin, NULL, GST_MESSAGE_DURATION_CHANGED);
3460 GST_OBJECT_UNLOCK (bin);
3464 case GST_MESSAGE_CLOCK_LOST:
3466 GstClock **provided_clock_p;
3467 GstElement **clock_provider_p;
3468 gboolean playing, toplevel, provided, forward;
3471 gst_message_parse_clock_lost (message, &clock);
3473 GST_OBJECT_LOCK (bin);
3474 bin->clock_dirty = TRUE;
3475 /* if we lost the clock that we provided, post to parent but
3476 * only if we are not a top-level bin or PLAYING.
3477 * The reason for this is that applications should be able
3478 * to PAUSE/PLAY if they receive this message without worrying
3479 * about the state of the pipeline. */
3480 provided = (clock == bin->provided_clock);
3481 playing = (GST_STATE (bin) == GST_STATE_PLAYING);
3482 toplevel = GST_OBJECT_PARENT (bin) == NULL;
3483 forward = provided && (playing || !toplevel);
3485 GST_DEBUG_OBJECT (bin,
3486 "Lost clock %" GST_PTR_FORMAT " provided by %" GST_PTR_FORMAT,
3487 bin->provided_clock, bin->clock_provider);
3488 provided_clock_p = &bin->provided_clock;
3489 clock_provider_p = &bin->clock_provider;
3490 gst_object_replace ((GstObject **) provided_clock_p, NULL);
3491 gst_object_replace ((GstObject **) clock_provider_p, NULL);
3493 GST_DEBUG_OBJECT (bin, "provided %d, playing %d, forward %d",
3494 provided, playing, forward);
3495 GST_OBJECT_UNLOCK (bin);
3501 gst_message_unref (message);
3504 case GST_MESSAGE_CLOCK_PROVIDE:
3508 GST_OBJECT_LOCK (bin);
3509 bin->clock_dirty = TRUE;
3510 /* a new clock is available, post to parent but not
3511 * to the application */
3512 forward = GST_OBJECT_PARENT (bin) != NULL;
3513 GST_OBJECT_UNLOCK (bin);
3519 gst_message_unref (message);
3522 case GST_MESSAGE_ASYNC_START:
3526 GST_DEBUG_OBJECT (bin, "ASYNC_START message %p, %s", message,
3527 src ? GST_OBJECT_NAME (src) : "(NULL)");
3529 GST_OBJECT_LOCK (bin);
3530 bin_do_message_forward (bin, message);
3532 /* we ignore the message if we are going to <= READY */
3533 if ((target = GST_STATE_TARGET (bin)) <= GST_STATE_READY)
3534 goto ignore_start_message;
3536 /* takes ownership of the message */
3537 bin_replace_message (bin, message, GST_MESSAGE_ASYNC_START);
3539 bin_handle_async_start (bin);
3540 GST_OBJECT_UNLOCK (bin);
3543 ignore_start_message:
3545 GST_DEBUG_OBJECT (bin, "ignoring message, target %s",
3546 gst_element_state_get_name (target));
3547 GST_OBJECT_UNLOCK (bin);
3548 gst_message_unref (message);
3552 case GST_MESSAGE_ASYNC_DONE:
3554 GstClockTime running_time;
3557 GST_DEBUG_OBJECT (bin, "ASYNC_DONE message %p, %s", message,
3558 src ? GST_OBJECT_NAME (src) : "(NULL)");
3560 gst_message_parse_async_done (message, &running_time);
3562 GST_OBJECT_LOCK (bin);
3563 bin_do_message_forward (bin, message);
3565 /* ignore messages if we are shutting down */
3566 if ((target = GST_STATE_TARGET (bin)) <= GST_STATE_READY)
3567 goto ignore_done_message;
3569 bin_replace_message (bin, message, GST_MESSAGE_ASYNC_START);
3570 /* if there are no more ASYNC_START messages, everybody posted
3571 * a ASYNC_DONE and we can post one on the bus. When checking, we
3572 * don't care who still has a pending ASYNC_START */
3573 if (!find_message (bin, NULL, GST_MESSAGE_ASYNC_START)) {
3574 /* nothing found, remove all old ASYNC_DONE messages */
3575 bin_remove_messages (bin, NULL, GST_MESSAGE_ASYNC_DONE);
3577 GST_DEBUG_OBJECT (bin, "async elements commited");
3578 /* when we get an async done message when a state change was busy, we
3579 * need to set the pending_done flag so that at the end of the state
3580 * change we can see if we need to verify pending async elements, hence
3581 * the TRUE argument here. */
3582 bin_handle_async_done (bin, GST_STATE_CHANGE_SUCCESS, TRUE,
3585 GST_DEBUG_OBJECT (bin, "there are more async elements pending");
3587 GST_OBJECT_UNLOCK (bin);
3590 ignore_done_message:
3592 GST_DEBUG_OBJECT (bin, "ignoring message, target %s",
3593 gst_element_state_get_name (target));
3594 GST_OBJECT_UNLOCK (bin);
3595 gst_message_unref (message);
3599 case GST_MESSAGE_STRUCTURE_CHANGE:
3603 gst_message_parse_structure_change (message, NULL, NULL, &busy);
3605 GST_OBJECT_LOCK (bin);
3607 /* while the pad is busy, avoid following it when doing state changes.
3608 * Don't update the cookie yet, we will do that after the structure
3609 * change finished and we are ready to inspect the new updated
3611 bin_replace_message (bin, message, GST_MESSAGE_STRUCTURE_CHANGE);
3614 /* a pad link/unlink ended, signal the state change iterator that we
3615 * need to resync by updating the structure_cookie. */
3616 bin_remove_messages (bin, GST_MESSAGE_SRC (message),
3617 GST_MESSAGE_STRUCTURE_CHANGE);
3618 if (!GST_BIN_IS_NO_RESYNC (bin))
3619 bin->priv->structure_cookie++;
3621 GST_OBJECT_UNLOCK (bin);
3624 gst_message_unref (message);
3635 /* Send all other messages upward */
3636 GST_DEBUG_OBJECT (bin, "posting message upward");
3637 gst_element_post_message (GST_ELEMENT_CAST (bin), message);
3642 /* generic struct passed to all query fold methods */
3651 typedef void (*QueryInitFunction) (GstBin * bin, QueryFold * fold);
3652 typedef void (*QueryDoneFunction) (GstBin * bin, QueryFold * fold);
3654 /* for duration/position we collect all durations/positions and take
3655 * the MAX of all valid results */
3657 bin_query_min_max_init (GstBin * bin, QueryFold * fold)
3665 bin_query_duration_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3667 gboolean res = FALSE;
3668 GstObject *item = g_value_get_object (vitem);
3669 if (GST_IS_PAD (item))
3670 res = gst_pad_query (GST_PAD (item), fold->query);
3672 res = gst_element_query (GST_ELEMENT (item), fold->query);
3677 g_value_set_boolean (ret, TRUE);
3679 gst_query_parse_duration (fold->query, NULL, &duration);
3681 GST_DEBUG_OBJECT (item, "got duration %" G_GINT64_FORMAT, duration);
3683 if (duration == -1) {
3684 /* duration query succeeded, but duration is unknown */
3689 if (duration > fold->max)
3690 fold->max = duration;
3697 bin_query_duration_done (GstBin * bin, QueryFold * fold)
3701 gst_query_parse_duration (fold->query, &format, NULL);
3702 /* store max in query result */
3703 gst_query_set_duration (fold->query, format, fold->max);
3705 GST_DEBUG_OBJECT (bin, "max duration %" G_GINT64_FORMAT, fold->max);
3707 /* FIXME: re-implement duration caching */
3710 GST_OBJECT_LOCK (bin);
3711 bin->messages = g_list_prepend (bin->messages,
3712 gst_message_new_duration (GST_OBJECT_CAST (bin), format, fold->max));
3713 GST_OBJECT_UNLOCK (bin);
3718 bin_query_position_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3720 gboolean res = FALSE;
3721 GstObject *item = g_value_get_object (vitem);
3722 if (GST_IS_PAD (item))
3723 res = gst_pad_query (GST_PAD (item), fold->query);
3725 res = gst_element_query (GST_ELEMENT (item), fold->query);
3730 g_value_set_boolean (ret, TRUE);
3732 gst_query_parse_position (fold->query, NULL, &position);
3734 GST_DEBUG_OBJECT (item, "got position %" G_GINT64_FORMAT, position);
3736 if (position > fold->max)
3737 fold->max = position;
3744 bin_query_position_done (GstBin * bin, QueryFold * fold)
3748 gst_query_parse_position (fold->query, &format, NULL);
3749 /* store max in query result */
3750 gst_query_set_position (fold->query, format, fold->max);
3752 GST_DEBUG_OBJECT (bin, "max position %" G_GINT64_FORMAT, fold->max);
3756 bin_query_latency_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3758 gboolean res = FALSE;
3759 GstObject *item = g_value_get_object (vitem);
3760 if (GST_IS_PAD (item))
3761 res = gst_pad_query (GST_PAD (item), fold->query);
3763 res = gst_element_query (GST_ELEMENT (item), fold->query);
3765 GstClockTime min, max;
3768 gst_query_parse_latency (fold->query, &live, &min, &max);
3770 GST_DEBUG_OBJECT (item,
3771 "got latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
3772 ", live %d", GST_TIME_ARGS (min), GST_TIME_ARGS (max), live);
3774 /* for the combined latency we collect the MAX of all min latencies and
3775 * the MIN of all max latencies */
3777 if (min > fold->min)
3779 if (fold->max == -1)
3781 else if (max < fold->max)
3783 if (fold->live == FALSE)
3787 g_value_set_boolean (ret, FALSE);
3788 GST_DEBUG_OBJECT (item, "failed query");
3795 bin_query_latency_done (GstBin * bin, QueryFold * fold)
3797 /* store max in query result */
3798 gst_query_set_latency (fold->query, fold->live, fold->min, fold->max);
3800 GST_DEBUG_OBJECT (bin,
3801 "latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
3802 ", live %d", GST_TIME_ARGS (fold->min), GST_TIME_ARGS (fold->max),
3806 /* generic fold, return first valid result */
3808 bin_query_generic_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3810 gboolean res = FALSE;
3811 GstObject *item = g_value_get_object (vitem);
3812 if (GST_IS_PAD (item))
3813 res = gst_pad_query (GST_PAD (item), fold->query);
3815 res = gst_element_query (GST_ELEMENT (item), fold->query);
3817 g_value_set_boolean (ret, TRUE);
3818 GST_DEBUG_OBJECT (item, "answered query %p", fold->query);
3821 /* and stop as soon as we have a valid result */
3825 /* Perform a query iteration for the given bin. The query is stored in
3826 * QueryFold and iter should be either a GstPad iterator or a
3827 * GstElement iterator. */
3829 bin_iterate_fold (GstBin * bin, GstIterator * iter, QueryInitFunction fold_init,
3830 QueryDoneFunction fold_done, GstIteratorFoldFunction fold_func,
3831 QueryFold fold_data, gboolean default_return)
3833 gboolean res = default_return;
3835 /* set the result of the query to FALSE initially */
3836 g_value_init (&ret, G_TYPE_BOOLEAN);
3837 g_value_set_boolean (&ret, res);
3840 GstIteratorResult ires;
3842 ires = gst_iterator_fold (iter, fold_func, &ret, &fold_data);
3845 case GST_ITERATOR_RESYNC:
3846 gst_iterator_resync (iter);
3848 fold_init (bin, &fold_data);
3849 g_value_set_boolean (&ret, res);
3851 case GST_ITERATOR_OK:
3852 case GST_ITERATOR_DONE:
3853 res = g_value_get_boolean (&ret);
3854 if (fold_done != NULL && res)
3855 fold_done (bin, &fold_data);
3867 gst_bin_query (GstElement * element, GstQuery * query)
3869 GstBin *bin = GST_BIN_CAST (element);
3871 gboolean default_return = FALSE;
3872 gboolean res = FALSE;
3873 gboolean src_pads_query_result = FALSE;
3874 GstIteratorFoldFunction fold_func;
3875 QueryInitFunction fold_init = NULL;
3876 QueryDoneFunction fold_done = NULL;
3877 QueryFold fold_data;
3879 switch (GST_QUERY_TYPE (query)) {
3880 case GST_QUERY_DURATION:
3882 /* FIXME: implement duration caching in GstBin again */
3887 gst_query_parse_duration (query, &qformat, NULL);
3889 /* find cached duration query */
3890 GST_OBJECT_LOCK (bin);
3891 for (cached = bin->messages; cached; cached = g_list_next (cached)) {
3892 GstMessage *message = (GstMessage *) cached->data;
3894 if (GST_MESSAGE_TYPE (message) == GST_MESSAGE_DURATION_CHANGED &&
3895 GST_MESSAGE_SRC (message) == GST_OBJECT_CAST (bin)) {
3899 gst_message_parse_duration (message, &format, &duration);
3901 /* if cached same format, copy duration in query result */
3902 if (format == qformat) {
3903 GST_DEBUG_OBJECT (bin, "return cached duration %" G_GINT64_FORMAT,
3905 GST_OBJECT_UNLOCK (bin);
3907 gst_query_set_duration (query, qformat, duration);
3913 GST_OBJECT_UNLOCK (bin);
3915 GST_FIXME ("implement duration caching in GstBin again");
3917 /* no cached value found, iterate and collect durations */
3918 fold_func = (GstIteratorFoldFunction) bin_query_duration_fold;
3919 fold_init = bin_query_min_max_init;
3920 fold_done = bin_query_duration_done;
3923 case GST_QUERY_POSITION:
3925 fold_func = (GstIteratorFoldFunction) bin_query_position_fold;
3926 fold_init = bin_query_min_max_init;
3927 fold_done = bin_query_position_done;
3930 case GST_QUERY_LATENCY:
3932 fold_func = (GstIteratorFoldFunction) bin_query_latency_fold;
3933 fold_init = bin_query_min_max_init;
3934 fold_done = bin_query_latency_done;
3935 default_return = TRUE;
3939 fold_func = (GstIteratorFoldFunction) bin_query_generic_fold;
3943 fold_data.query = query;
3945 iter = gst_bin_iterate_sinks (bin);
3946 GST_DEBUG_OBJECT (bin, "Sending query %p (type %s) to sink children",
3947 query, GST_QUERY_TYPE_NAME (query));
3950 fold_init (bin, &fold_data);
3953 bin_iterate_fold (bin, iter, fold_init, fold_done, fold_func, fold_data,
3955 gst_iterator_free (iter);
3958 /* Query the source pads of the element */
3959 iter = gst_element_iterate_src_pads (element);
3960 src_pads_query_result =
3961 bin_iterate_fold (bin, iter, fold_init, fold_done, fold_func,
3962 fold_data, default_return);
3963 gst_iterator_free (iter);
3965 if (src_pads_query_result)
3969 GST_DEBUG_OBJECT (bin, "query %p result %d", query, res);
3975 set_context (const GValue * item, gpointer user_data)
3977 GstElement *element = g_value_get_object (item);
3979 gst_element_set_context (element, user_data);
3983 gst_bin_set_context (GstElement * element, GstContext * context)
3986 GstIterator *children;
3988 g_return_if_fail (GST_IS_BIN (element));
3990 bin = GST_BIN (element);
3992 children = gst_bin_iterate_elements (bin);
3993 while (gst_iterator_foreach (children, set_context,
3994 context) == GST_ITERATOR_RESYNC);
3995 gst_iterator_free (children);
3999 compare_name (const GValue * velement, const gchar * name)
4002 GstElement *element = g_value_get_object (velement);
4004 GST_OBJECT_LOCK (element);
4005 eq = strcmp (GST_ELEMENT_NAME (element), name);
4006 GST_OBJECT_UNLOCK (element);
4012 * gst_bin_get_by_name:
4014 * @name: the element name to search for
4016 * Gets the element with the given name from a bin. This
4017 * function recurses into child bins.
4019 * Returns NULL if no element with the given name is found in the bin.
4021 * MT safe. Caller owns returned reference.
4023 * Returns: (transfer full): the #GstElement with the given name, or NULL
4026 gst_bin_get_by_name (GstBin * bin, const gchar * name)
4028 GstIterator *children;
4029 GValue result = { 0, };
4030 GstElement *element;
4033 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
4035 GST_CAT_INFO (GST_CAT_PARENTAGE, "[%s]: looking up child element %s",
4036 GST_ELEMENT_NAME (bin), name);
4038 children = gst_bin_iterate_recurse (bin);
4039 found = gst_iterator_find_custom (children,
4040 (GCompareFunc) compare_name, &result, (gpointer) name);
4041 gst_iterator_free (children);
4044 element = g_value_dup_object (&result);
4045 g_value_unset (&result);
4054 * gst_bin_get_by_name_recurse_up:
4056 * @name: the element name to search for
4058 * Gets the element with the given name from this bin. If the
4059 * element is not found, a recursion is performed on the parent bin.
4062 * - no element with the given name is found in the bin
4064 * MT safe. Caller owns returned reference.
4066 * Returns: (transfer full): the #GstElement with the given name, or NULL
4069 gst_bin_get_by_name_recurse_up (GstBin * bin, const gchar * name)
4073 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
4074 g_return_val_if_fail (name != NULL, NULL);
4076 result = gst_bin_get_by_name (bin, name);
4081 parent = gst_object_get_parent (GST_OBJECT_CAST (bin));
4083 if (GST_IS_BIN (parent)) {
4084 result = gst_bin_get_by_name_recurse_up (GST_BIN_CAST (parent), name);
4086 gst_object_unref (parent);
4094 compare_interface (const GValue * velement, GValue * interface)
4096 GstElement *element = g_value_get_object (velement);
4097 GType interface_type = (GType) g_value_get_pointer (interface);
4100 if (G_TYPE_CHECK_INSTANCE_TYPE (element, interface_type)) {
4109 * gst_bin_get_by_interface:
4111 * @iface: the #GType of an interface
4113 * Looks for an element inside the bin that implements the given
4114 * interface. If such an element is found, it returns the element.
4115 * You can cast this element to the given interface afterwards. If you want
4116 * all elements that implement the interface, use
4117 * gst_bin_iterate_all_by_interface(). This function recurses into child bins.
4119 * MT safe. Caller owns returned reference.
4121 * Returns: (transfer full): A #GstElement inside the bin implementing the interface
4124 gst_bin_get_by_interface (GstBin * bin, GType iface)
4126 GstIterator *children;
4127 GValue result = { 0, };
4128 GstElement *element;
4130 GValue viface = { 0, };
4132 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
4133 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL);
4135 g_value_init (&viface, G_TYPE_POINTER);
4136 g_value_set_pointer (&viface, (gpointer) iface);
4138 children = gst_bin_iterate_recurse (bin);
4139 found = gst_iterator_find_custom (children, (GCompareFunc) compare_interface,
4141 gst_iterator_free (children);
4144 element = g_value_dup_object (&result);
4145 g_value_unset (&result);
4149 g_value_unset (&viface);
4155 * gst_bin_iterate_all_by_interface:
4157 * @iface: the #GType of an interface
4159 * Looks for all elements inside the bin that implements the given
4160 * interface. You can safely cast all returned elements to the given interface.
4161 * The function recurses inside child bins. The iterator will yield a series
4162 * of #GstElement that should be unreffed after use.
4164 * MT safe. Caller owns returned value.
4166 * Returns: (transfer full): a #GstIterator of #GstElement for all elements
4167 * in the bin implementing the given interface, or NULL
4170 gst_bin_iterate_all_by_interface (GstBin * bin, GType iface)
4172 GstIterator *children;
4173 GstIterator *result;
4174 GValue viface = { 0, };
4176 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
4177 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL);
4179 g_value_init (&viface, G_TYPE_POINTER);
4180 g_value_set_pointer (&viface, (gpointer) iface);
4182 children = gst_bin_iterate_recurse (bin);
4183 result = gst_iterator_filter (children, (GCompareFunc) compare_interface,
4186 g_value_unset (&viface);