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));
1168 if (GST_ELEMENT_CAST (bin)->context)
1169 gst_element_set_context (element, GST_ELEMENT_CAST (bin)->context);
1172 /* set the cached index on the children */
1173 if (bin->priv->index)
1174 gst_element_set_index (element, bin->priv->index);
1177 ret = GST_STATE_RETURN (bin);
1178 /* no need to update the state if we are in error */
1179 if (ret == GST_STATE_CHANGE_FAILURE)
1180 goto no_state_recalc;
1182 /* update the bin state, the new element could have been an ASYNC or
1183 * NO_PREROLL element */
1184 ret = GST_STATE_RETURN (element);
1185 GST_DEBUG_OBJECT (bin, "added %s element",
1186 gst_element_state_change_return_get_name (ret));
1189 case GST_STATE_CHANGE_ASYNC:
1191 /* create message to track this aync element when it posts an async-done
1193 async_message = gst_message_new_async_start (GST_OBJECT_CAST (element));
1196 case GST_STATE_CHANGE_NO_PREROLL:
1197 /* ignore all async elements we might have and commit our state */
1198 bin_handle_async_done (bin, ret, FALSE, GST_CLOCK_TIME_NONE);
1200 case GST_STATE_CHANGE_FAILURE:
1207 GST_OBJECT_UNLOCK (bin);
1209 /* post the messages on the bus of the element so that the bin can handle
1212 gst_element_post_message (element, clock_message);
1215 gst_element_post_message (element, async_message);
1217 /* unlink all linked pads */
1218 it = gst_element_iterate_pads (element);
1219 gst_iterator_foreach (it, (GstIteratorForeachFunction) unlink_pads, NULL);
1220 gst_iterator_free (it);
1222 GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "added element \"%s\"",
1225 g_signal_emit (bin, gst_bin_signals[ELEMENT_ADDED], 0, element);
1226 gst_child_proxy_child_added ((GstChildProxy *) bin, (GObject *) element,
1233 /* ERROR handling here */
1236 GST_OBJECT_LOCK (bin);
1237 g_warning ("Cannot add bin '%s' to itself", GST_ELEMENT_NAME (bin));
1238 GST_OBJECT_UNLOCK (bin);
1243 g_warning ("Name '%s' is not unique in bin '%s', not adding",
1244 elem_name, GST_ELEMENT_NAME (bin));
1245 GST_OBJECT_UNLOCK (bin);
1251 g_warning ("Element '%s' already has parent", elem_name);
1252 GST_OBJECT_UNLOCK (bin);
1261 * @element: (transfer full): the #GstElement to add
1263 * Adds the given element to the bin. Sets the element's parent, and thus
1264 * takes ownership of the element. An element can only be added to one bin.
1266 * If the element's pads are linked to other pads, the pads will be unlinked
1267 * before the element is added to the bin.
1270 * When you add an element to an already-running pipeline, you will have to
1271 * take care to set the state of the newly-added element to the desired
1272 * state (usually PLAYING or PAUSED, same you set the pipeline to originally)
1273 * with gst_element_set_state(), or use gst_element_sync_state_with_parent().
1274 * The bin or pipeline will not take care of this for you.
1279 * Returns: TRUE if the element could be added, FALSE if
1280 * the bin does not want to accept the element.
1283 gst_bin_add (GstBin * bin, GstElement * element)
1285 GstBinClass *bclass;
1288 g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
1289 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1291 bclass = GST_BIN_GET_CLASS (bin);
1293 if (G_UNLIKELY (bclass->add_element == NULL))
1296 GST_CAT_DEBUG (GST_CAT_PARENTAGE, "adding element %s to bin %s",
1297 GST_STR_NULL (GST_ELEMENT_NAME (element)),
1298 GST_STR_NULL (GST_ELEMENT_NAME (bin)));
1300 result = bclass->add_element (bin, element);
1304 /* ERROR handling */
1307 g_warning ("adding elements to bin '%s' is not supported",
1308 GST_ELEMENT_NAME (bin));
1313 /* remove an element from the bin
1318 gst_bin_remove_func (GstBin * bin, GstElement * element)
1322 gboolean is_sink, is_source, provides_clock, requires_clock;
1323 gboolean othersink, othersource, otherprovider, otherrequirer, found;
1324 GstMessage *clock_message = NULL;
1325 GstClock **provided_clock_p;
1326 GstElement **clock_provider_p;
1328 gboolean other_async, this_async, have_no_preroll;
1329 GstStateChangeReturn ret;
1331 GST_DEBUG_OBJECT (bin, "element :%s", GST_ELEMENT_NAME (element));
1333 GST_OBJECT_LOCK (bin);
1335 GST_OBJECT_LOCK (element);
1336 elem_name = g_strdup (GST_ELEMENT_NAME (element));
1338 if (GST_OBJECT_PARENT (element) != GST_OBJECT_CAST (bin))
1341 /* remove the parent ref */
1342 GST_OBJECT_PARENT (element) = NULL;
1344 /* grab element name so we can print it */
1345 is_sink = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_SINK);
1346 is_source = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_SOURCE);
1348 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
1350 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
1351 GST_OBJECT_UNLOCK (element);
1355 othersource = FALSE;
1356 otherprovider = FALSE;
1357 otherrequirer = FALSE;
1358 have_no_preroll = FALSE;
1359 /* iterate the elements, we collect which ones are async and no_preroll. We
1360 * also remove the element when we find it. */
1361 for (walk = bin->children; walk; walk = next) {
1362 GstElement *child = GST_ELEMENT_CAST (walk->data);
1364 next = g_list_next (walk);
1366 if (child == element) {
1368 /* remove the element */
1369 bin->children = g_list_delete_link (bin->children, walk);
1371 gboolean child_sink, child_source, child_provider, child_requirer;
1373 GST_OBJECT_LOCK (child);
1374 child_sink = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_SINK);
1375 child_source = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_SOURCE);
1377 GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
1379 GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
1380 /* when we remove a sink, check if there are other sinks. */
1381 if (is_sink && !othersink && child_sink)
1383 if (is_source && !othersource && child_source)
1385 if (provides_clock && !otherprovider && child_provider)
1386 otherprovider = TRUE;
1387 if (requires_clock && !otherrequirer && child_requirer)
1388 otherrequirer = TRUE;
1389 /* check if we have NO_PREROLL children */
1390 if (GST_STATE_RETURN (child) == GST_STATE_CHANGE_NO_PREROLL)
1391 have_no_preroll = TRUE;
1392 GST_OBJECT_UNLOCK (child);
1396 /* the element must have been in the bin's list of children */
1397 if (G_UNLIKELY (!found))
1400 /* we now removed the element from the list of elements, increment the cookie
1401 * so that others can detect a change in the children list. */
1403 bin->children_cookie++;
1404 if (!GST_BIN_IS_NO_RESYNC (bin))
1405 bin->priv->structure_cookie++;
1407 if (is_sink && !othersink) {
1408 /* we're not a sink anymore */
1409 GST_DEBUG_OBJECT (bin, "we removed the last sink");
1410 GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_FLAG_SINK);
1412 if (is_source && !othersource) {
1413 /* we're not a source anymore */
1414 GST_DEBUG_OBJECT (bin, "we removed the last source");
1415 GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_FLAG_SOURCE);
1417 if (provides_clock && !otherprovider) {
1418 /* we're not a clock provider anymore */
1419 GST_DEBUG_OBJECT (bin, "we removed the last clock provider");
1420 GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
1422 if (requires_clock && !otherrequirer) {
1423 /* we're not a clock requirer anymore */
1424 GST_DEBUG_OBJECT (bin, "we removed the last clock requirer");
1425 GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
1428 /* if the clock provider for this element is removed, we lost
1429 * the clock as well, we need to inform the parent of this
1430 * so that it can select a new clock */
1431 if (bin->clock_provider == element) {
1432 GST_DEBUG_OBJECT (bin, "element \"%s\" provided the clock", elem_name);
1433 bin->clock_dirty = TRUE;
1435 gst_message_new_clock_lost (GST_OBJECT_CAST (bin), bin->provided_clock);
1436 provided_clock_p = &bin->provided_clock;
1437 clock_provider_p = &bin->clock_provider;
1438 gst_object_replace ((GstObject **) provided_clock_p, NULL);
1439 gst_object_replace ((GstObject **) clock_provider_p, NULL);
1442 /* remove messages for the element, if there was a pending ASYNC_START
1443 * message we must see if removing the element caused the bin to lose its
1446 other_async = FALSE;
1447 for (walk = bin->messages; walk; walk = next) {
1448 GstMessage *message = (GstMessage *) walk->data;
1449 GstElement *src = GST_ELEMENT_CAST (GST_MESSAGE_SRC (message));
1452 next = g_list_next (walk);
1455 switch (GST_MESSAGE_TYPE (message)) {
1456 case GST_MESSAGE_ASYNC_START:
1462 GST_DEBUG_OBJECT (src, "looking at message %p", message);
1464 case GST_MESSAGE_STRUCTURE_CHANGE:
1468 GST_DEBUG_OBJECT (src, "looking at structure change message %p",
1470 /* it's unlikely that this message is still in the list of messages
1471 * because this would mean that a link/unlink is busy in another thread
1472 * while we remove the element. We still have to remove the message
1473 * because we might not receive the done message anymore when the element
1474 * is removed from the bin. */
1475 gst_message_parse_structure_change (message, NULL, &owner, NULL);
1476 if (owner == element)
1487 /* delete all message types */
1488 GST_DEBUG_OBJECT (src, "deleting message %p of element \"%s\"",
1489 message, elem_name);
1490 bin->messages = g_list_delete_link (bin->messages, walk);
1491 gst_message_unref (message);
1495 /* get last return */
1496 ret = GST_STATE_RETURN (bin);
1498 /* no need to update the state if we are in error */
1499 if (ret == GST_STATE_CHANGE_FAILURE)
1500 goto no_state_recalc;
1502 if (!other_async && this_async) {
1503 /* all other elements were not async and we removed the async one,
1504 * handle the async-done case because we are not async anymore now. */
1505 GST_DEBUG_OBJECT (bin,
1506 "we removed the last async element, have no_preroll %d",
1509 /* the current state return of the bin depends on if there are no_preroll
1510 * elements in the pipeline or not */
1511 if (have_no_preroll)
1512 ret = GST_STATE_CHANGE_NO_PREROLL;
1514 ret = GST_STATE_CHANGE_SUCCESS;
1516 bin_handle_async_done (bin, ret, FALSE, GST_CLOCK_TIME_NONE);
1518 GST_DEBUG_OBJECT (bin,
1519 "recalc state preroll: %d, other async: %d, this async %d",
1520 have_no_preroll, other_async, this_async);
1522 if (have_no_preroll) {
1523 ret = GST_STATE_CHANGE_NO_PREROLL;
1524 } else if (other_async) {
1525 /* there are other async elements and we were not doing an async state
1526 * change, change our pending state and go async */
1527 if (GST_STATE_PENDING (bin) == GST_STATE_VOID_PENDING) {
1528 GST_STATE_NEXT (bin) = GST_STATE (bin);
1529 GST_STATE_PENDING (bin) = GST_STATE (bin);
1531 ret = GST_STATE_CHANGE_ASYNC;
1533 GST_STATE_RETURN (bin) = ret;
1537 gst_element_set_bus (element, NULL);
1538 /* Clear the clock we provided to the element */
1539 gst_element_set_clock (element, NULL);
1540 GST_OBJECT_UNLOCK (bin);
1543 gst_element_post_message (GST_ELEMENT_CAST (bin), clock_message);
1545 /* unlink all linked pads */
1546 it = gst_element_iterate_pads (element);
1547 gst_iterator_foreach (it, (GstIteratorForeachFunction) unlink_pads, NULL);
1548 gst_iterator_free (it);
1550 GST_CAT_INFO_OBJECT (GST_CAT_PARENTAGE, bin, "removed child \"%s\"",
1553 g_signal_emit (bin, gst_bin_signals[ELEMENT_REMOVED], 0, element);
1554 gst_child_proxy_child_removed ((GstChildProxy *) bin, (GObject *) element,
1558 /* element is really out of our control now */
1559 gst_object_unref (element);
1563 /* ERROR handling */
1566 g_warning ("Element '%s' is not in bin '%s'", elem_name,
1567 GST_ELEMENT_NAME (bin));
1568 GST_OBJECT_UNLOCK (element);
1569 GST_OBJECT_UNLOCK (bin);
1578 * @element: (transfer none): the #GstElement to remove
1580 * Removes the element from the bin, unparenting it as well.
1581 * Unparenting the element means that the element will be dereferenced,
1582 * so if the bin holds the only reference to the element, the element
1583 * will be freed in the process of removing it from the bin. If you
1584 * want the element to still exist after removing, you need to call
1585 * gst_object_ref() before removing it from the bin.
1587 * If the element's pads are linked to other pads, the pads will be unlinked
1588 * before the element is removed from the bin.
1592 * Returns: TRUE if the element could be removed, FALSE if
1593 * the bin does not want to remove the element.
1596 gst_bin_remove (GstBin * bin, GstElement * element)
1598 GstBinClass *bclass;
1601 g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
1602 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1604 bclass = GST_BIN_GET_CLASS (bin);
1606 if (G_UNLIKELY (bclass->remove_element == NULL))
1609 GST_CAT_DEBUG (GST_CAT_PARENTAGE, "removing element %s from bin %s",
1610 GST_ELEMENT_NAME (element), GST_ELEMENT_NAME (bin));
1612 result = bclass->remove_element (bin, element);
1616 /* ERROR handling */
1619 g_warning ("removing elements from bin '%s' is not supported",
1620 GST_ELEMENT_NAME (bin));
1626 * gst_bin_iterate_elements:
1629 * Gets an iterator for the elements in this bin.
1631 * MT safe. Caller owns returned value.
1633 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1636 gst_bin_iterate_elements (GstBin * bin)
1638 GstIterator *result;
1640 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1642 GST_OBJECT_LOCK (bin);
1643 result = gst_iterator_new_list (GST_TYPE_ELEMENT,
1644 GST_OBJECT_GET_LOCK (bin),
1645 &bin->children_cookie, &bin->children, (GObject *) bin, NULL);
1646 GST_OBJECT_UNLOCK (bin);
1651 static GstIteratorItem
1652 iterate_child_recurse (GstIterator * it, const GValue * item)
1654 GstElement *child = g_value_get_object (item);
1656 if (GST_IS_BIN (child)) {
1657 GstIterator *other = gst_bin_iterate_recurse (GST_BIN_CAST (child));
1659 gst_iterator_push (it, other);
1661 return GST_ITERATOR_ITEM_PASS;
1665 * gst_bin_iterate_recurse:
1668 * Gets an iterator for the elements in this bin.
1669 * This iterator recurses into GstBin children.
1671 * MT safe. Caller owns returned value.
1673 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1676 gst_bin_iterate_recurse (GstBin * bin)
1678 GstIterator *result;
1680 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1682 GST_OBJECT_LOCK (bin);
1683 result = gst_iterator_new_list (GST_TYPE_ELEMENT,
1684 GST_OBJECT_GET_LOCK (bin),
1685 &bin->children_cookie,
1687 (GObject *) bin, (GstIteratorItemFunction) iterate_child_recurse);
1688 GST_OBJECT_UNLOCK (bin);
1693 /* returns 0 when TRUE because this is a GCompareFunc */
1696 bin_element_is_sink (GstElement * child, GstBin * bin)
1700 /* we lock the child here for the remainder of the function to
1701 * get its name and flag safely. */
1702 GST_OBJECT_LOCK (child);
1703 is_sink = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_SINK);
1705 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
1706 "child %s %s sink", GST_OBJECT_NAME (child), is_sink ? "is" : "is not");
1708 GST_OBJECT_UNLOCK (child);
1709 return is_sink ? 0 : 1;
1713 sink_iterator_filter (const GValue * vchild, GValue * vbin)
1715 GstBin *bin = g_value_get_object (vbin);
1716 GstElement *child = g_value_get_object (vchild);
1718 return (bin_element_is_sink (child, bin));
1722 * gst_bin_iterate_sinks:
1725 * Gets an iterator for all elements in the bin that have the
1726 * #GST_ELEMENT_FLAG_SINK flag set.
1728 * MT safe. Caller owns returned value.
1730 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1733 gst_bin_iterate_sinks (GstBin * bin)
1735 GstIterator *children;
1736 GstIterator *result;
1737 GValue vbin = { 0, };
1739 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1741 g_value_init (&vbin, GST_TYPE_BIN);
1742 g_value_set_object (&vbin, bin);
1744 children = gst_bin_iterate_elements (bin);
1745 result = gst_iterator_filter (children,
1746 (GCompareFunc) sink_iterator_filter, &vbin);
1748 g_value_unset (&vbin);
1753 /* returns 0 when TRUE because this is a GCompareFunc */
1756 bin_element_is_src (GstElement * child, GstBin * bin)
1760 /* we lock the child here for the remainder of the function to
1761 * get its name and other info safely. */
1762 GST_OBJECT_LOCK (child);
1763 is_src = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_FLAG_SOURCE);
1765 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
1766 "child %s %s src", GST_OBJECT_NAME (child), is_src ? "is" : "is not");
1768 GST_OBJECT_UNLOCK (child);
1769 return is_src ? 0 : 1;
1773 src_iterator_filter (const GValue * vchild, GValue * vbin)
1775 GstBin *bin = g_value_get_object (vbin);
1776 GstElement *child = g_value_get_object (vchild);
1778 return (bin_element_is_src (child, bin));
1782 * gst_bin_iterate_sources:
1785 * Gets an iterator for all elements in the bin that have the
1786 * #GST_ELEMENT_FLAG_SOURCE flag set.
1788 * MT safe. Caller owns returned value.
1790 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1793 gst_bin_iterate_sources (GstBin * bin)
1795 GstIterator *children;
1796 GstIterator *result;
1797 GValue vbin = { 0, };
1799 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1801 g_value_init (&vbin, GST_TYPE_BIN);
1802 g_value_set_object (&vbin, bin);
1804 children = gst_bin_iterate_elements (bin);
1805 result = gst_iterator_filter (children,
1806 (GCompareFunc) src_iterator_filter, &vbin);
1808 g_value_unset (&vbin);
1816 static GstStateChangeReturn
1817 gst_bin_get_state_func (GstElement * element, GstState * state,
1818 GstState * pending, GstClockTime timeout)
1820 GstStateChangeReturn ret;
1822 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element, "getting state");
1825 GST_ELEMENT_CLASS (parent_class)->get_state (element, state, pending,
1831 /***********************************************
1832 * Topologically sorted iterator
1833 * see http://en.wikipedia.org/wiki/Topological_sorting
1835 * For each element in the graph, an entry is kept in a HashTable
1836 * with its number of srcpad connections (degree).
1837 * We then change state of all elements without dependencies
1838 * (degree 0) and decrement the degree of all elements connected
1839 * on the sinkpads. When an element reaches degree 0, its state is
1841 * When all elements are handled the algorithm stops.
1843 typedef struct _GstBinSortIterator
1846 GQueue queue; /* elements queued for state change */
1847 GstBin *bin; /* bin we iterate */
1848 gint mode; /* adding or removing dependency */
1849 GstElement *best; /* next element with least dependencies */
1850 gint best_deg; /* best degree */
1851 GHashTable *hash; /* hashtable with element dependencies */
1852 gboolean dirty; /* we detected structure change */
1853 } GstBinSortIterator;
1856 gst_bin_sort_iterator_copy (const GstBinSortIterator * it,
1857 GstBinSortIterator * copy)
1859 GHashTableIter iter;
1860 gpointer key, value;
1862 copy->queue = it->queue;
1863 g_queue_foreach (©->queue, (GFunc) gst_object_ref, NULL);
1865 copy->bin = gst_object_ref (it->bin);
1867 copy->best = gst_object_ref (it->best);
1869 copy->hash = g_hash_table_new (NULL, NULL);
1870 g_hash_table_iter_init (&iter, it->hash);
1871 while (g_hash_table_iter_next (&iter, &key, &value))
1872 g_hash_table_insert (copy->hash, key, value);
1875 /* we add and subtract 1 to make sure we don't confuse NULL and 0 */
1876 #define HASH_SET_DEGREE(bit, elem, deg) \
1877 g_hash_table_replace (bit->hash, elem, GINT_TO_POINTER(deg+1))
1878 #define HASH_GET_DEGREE(bit, elem) \
1879 (GPOINTER_TO_INT(g_hash_table_lookup (bit->hash, elem))-1)
1881 /* add element to queue of next elements in the iterator.
1882 * We push at the tail to give higher priority elements a
1885 add_to_queue (GstBinSortIterator * bit, GstElement * element)
1887 GST_DEBUG_OBJECT (bit->bin, "adding '%s' to queue",
1888 GST_ELEMENT_NAME (element));
1889 gst_object_ref (element);
1890 g_queue_push_tail (&bit->queue, element);
1891 HASH_SET_DEGREE (bit, element, -1);
1895 remove_from_queue (GstBinSortIterator * bit, GstElement * element)
1899 if ((find = g_queue_find (&bit->queue, element))) {
1900 GST_DEBUG_OBJECT (bit->bin, "removing '%s' from queue",
1901 GST_ELEMENT_NAME (element));
1903 g_queue_delete_link (&bit->queue, find);
1904 gst_object_unref (element);
1906 GST_DEBUG_OBJECT (bit->bin, "unable to remove '%s' from queue",
1907 GST_ELEMENT_NAME (element));
1911 /* clear the queue, unref all objects as we took a ref when
1912 * we added them to the queue */
1914 clear_queue (GQueue * queue)
1918 while ((p = g_queue_pop_head (queue)))
1919 gst_object_unref (p);
1922 /* set all degrees to 0. Elements marked as a sink are
1923 * added to the queue immediately. Since we only look at the SINK flag of the
1924 * element, it is possible that we add non-sinks to the queue. These will be
1925 * removed from the queue again when we can prove that it provides data for some
1928 reset_degree (GstElement * element, GstBinSortIterator * bit)
1932 /* sinks are added right away */
1933 GST_OBJECT_LOCK (element);
1934 is_sink = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_SINK);
1935 GST_OBJECT_UNLOCK (element);
1938 add_to_queue (bit, element);
1940 /* others are marked with 0 and handled when sinks are done */
1941 HASH_SET_DEGREE (bit, element, 0);
1945 /* adjust the degree of all elements connected to the given
1946 * element. If a degree of an element drops to 0, it is
1947 * added to the queue of elements to schedule next.
1949 * We have to make sure not to cross the bin boundary this element
1953 update_degree (GstElement * element, GstBinSortIterator * bit)
1955 gboolean linked = FALSE;
1957 GST_OBJECT_LOCK (element);
1958 /* don't touch degree if element has no sinkpads */
1959 if (element->numsinkpads != 0) {
1960 /* loop over all sinkpads, decrement degree for all connected
1961 * elements in this bin */
1964 for (pads = element->sinkpads; pads; pads = g_list_next (pads)) {
1967 pad = GST_PAD_CAST (pads->data);
1969 /* we're iterating over the sinkpads, check if it's busy in a link/unlink */
1970 if (G_UNLIKELY (find_message (bit->bin, GST_OBJECT_CAST (pad),
1971 GST_MESSAGE_STRUCTURE_CHANGE))) {
1972 /* mark the iterator as dirty because we won't be updating the degree
1973 * of the peer parent now. This would result in the 'loop detected'
1974 * later on because the peer parent element could become the best next
1975 * element with a degree > 0. We will simply continue our state
1976 * changes and we'll eventually resync when the unlink completed and
1977 * the iterator cookie is updated. */
1982 if ((peer = gst_pad_get_peer (pad))) {
1983 GstElement *peer_element;
1985 if ((peer_element = gst_pad_get_parent_element (peer))) {
1986 GST_OBJECT_LOCK (peer_element);
1987 /* check that we don't go outside of this bin */
1988 if (GST_OBJECT_CAST (peer_element)->parent ==
1989 GST_OBJECT_CAST (bit->bin)) {
1990 gint old_deg, new_deg;
1992 old_deg = HASH_GET_DEGREE (bit, peer_element);
1994 /* check to see if we added an element as sink that was not really a
1995 * sink because it was connected to some other element. */
1996 if (old_deg == -1) {
1997 remove_from_queue (bit, peer_element);
2000 new_deg = old_deg + bit->mode;
2002 GST_DEBUG_OBJECT (bit->bin,
2003 "change element %s, degree %d->%d, linked to %s",
2004 GST_ELEMENT_NAME (peer_element), old_deg, new_deg,
2005 GST_ELEMENT_NAME (element));
2007 /* update degree, it is possible that an element was in 0 and
2008 * reaches -1 here. This would mean that the element had no sinkpads
2009 * but became linked while the state change was happening. We will
2010 * resync on this with the structure change message. */
2012 /* degree hit 0, add to queue */
2013 add_to_queue (bit, peer_element);
2015 HASH_SET_DEGREE (bit, peer_element, new_deg);
2019 GST_OBJECT_UNLOCK (peer_element);
2020 gst_object_unref (peer_element);
2022 gst_object_unref (peer);
2027 GST_DEBUG_OBJECT (bit->bin, "element %s not linked on any sinkpads",
2028 GST_ELEMENT_NAME (element));
2030 GST_OBJECT_UNLOCK (element);
2033 /* find the next best element not handled yet. This is the one
2034 * with the lowest non-negative degree */
2036 find_element (GstElement * element, GstBinSortIterator * bit)
2040 /* element is already handled */
2041 if ((degree = HASH_GET_DEGREE (bit, element)) < 0)
2044 /* first element or element with smaller degree */
2045 if (bit->best == NULL || bit->best_deg > degree) {
2046 bit->best = element;
2047 bit->best_deg = degree;
2051 /* get next element in iterator. */
2052 static GstIteratorResult
2053 gst_bin_sort_iterator_next (GstBinSortIterator * bit, GValue * result)
2056 GstBin *bin = bit->bin;
2058 /* empty queue, we have to find a next best element */
2059 if (g_queue_is_empty (&bit->queue)) {
2061 bit->best_deg = G_MAXINT;
2062 g_list_foreach (bin->children, (GFunc) find_element, bit);
2063 if ((best = bit->best)) {
2064 /* when we detected an unlink, don't warn because our degrees might be
2065 * screwed up. We will resync later */
2066 if (bit->best_deg != 0 && !bit->dirty) {
2067 /* we don't fail on this one yet */
2068 GST_WARNING_OBJECT (bin, "loop dected in graph");
2069 g_warning ("loop detected in the graph of bin '%s'!!",
2070 GST_ELEMENT_NAME (bin));
2072 /* best unhandled element, schedule as next element */
2073 GST_DEBUG_OBJECT (bin, "queue empty, next best: %s",
2074 GST_ELEMENT_NAME (best));
2075 HASH_SET_DEGREE (bit, best, -1);
2076 g_value_set_object (result, best);
2078 GST_DEBUG_OBJECT (bin, "queue empty, elements exhausted");
2079 /* no more unhandled elements, we are done */
2080 return GST_ITERATOR_DONE;
2083 /* everything added to the queue got reffed */
2084 best = g_queue_pop_head (&bit->queue);
2085 g_value_set_object (result, best);
2086 gst_object_unref (best);
2089 GST_DEBUG_OBJECT (bin, "queue head gives %s", GST_ELEMENT_NAME (best));
2090 /* update degrees of linked elements */
2091 update_degree (best, bit);
2093 return GST_ITERATOR_OK;
2096 /* clear queues, recalculate the degrees and restart. */
2098 gst_bin_sort_iterator_resync (GstBinSortIterator * bit)
2100 GstBin *bin = bit->bin;
2102 GST_DEBUG_OBJECT (bin, "resync");
2104 clear_queue (&bit->queue);
2106 g_list_foreach (bin->children, (GFunc) reset_degree, bit);
2107 /* calc degrees, incrementing */
2109 g_list_foreach (bin->children, (GFunc) update_degree, bit);
2110 /* for the rest of the function we decrement the degrees */
2114 /* clear queues, unref bin and free iterator. */
2116 gst_bin_sort_iterator_free (GstBinSortIterator * bit)
2118 GstBin *bin = bit->bin;
2120 GST_DEBUG_OBJECT (bin, "free");
2121 clear_queue (&bit->queue);
2122 g_hash_table_destroy (bit->hash);
2123 gst_object_unref (bin);
2126 /* should be called with the bin LOCK held */
2127 static GstIterator *
2128 gst_bin_sort_iterator_new (GstBin * bin)
2130 GstBinSortIterator *result;
2132 /* we don't need an ItemFunction because we ref the items in the _next
2134 result = (GstBinSortIterator *)
2135 gst_iterator_new (sizeof (GstBinSortIterator),
2137 GST_OBJECT_GET_LOCK (bin),
2138 &bin->priv->structure_cookie,
2139 (GstIteratorCopyFunction) gst_bin_sort_iterator_copy,
2140 (GstIteratorNextFunction) gst_bin_sort_iterator_next,
2141 (GstIteratorItemFunction) NULL,
2142 (GstIteratorResyncFunction) gst_bin_sort_iterator_resync,
2143 (GstIteratorFreeFunction) gst_bin_sort_iterator_free);
2144 g_queue_init (&result->queue);
2145 result->hash = g_hash_table_new (NULL, NULL);
2146 gst_object_ref (bin);
2148 gst_bin_sort_iterator_resync (result);
2150 return (GstIterator *) result;
2154 * gst_bin_iterate_sorted:
2157 * Gets an iterator for the elements in this bin in topologically
2158 * sorted order. This means that the elements are returned from
2159 * the most downstream elements (sinks) to the sources.
2161 * This function is used internally to perform the state changes
2162 * of the bin elements and for clock selection.
2164 * MT safe. Caller owns returned value.
2166 * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
2169 gst_bin_iterate_sorted (GstBin * bin)
2171 GstIterator *result;
2173 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
2175 GST_OBJECT_LOCK (bin);
2176 result = gst_bin_sort_iterator_new (bin);
2177 GST_OBJECT_UNLOCK (bin);
2182 static GstStateChangeReturn
2183 gst_bin_element_set_state (GstBin * bin, GstElement * element,
2184 GstClockTime base_time, GstClockTime start_time, GstState current,
2187 GstStateChangeReturn ret;
2188 GstState child_current, child_pending;
2192 GST_STATE_LOCK (element);
2194 GST_OBJECT_LOCK (element);
2195 /* set base_time and start time on child */
2196 GST_ELEMENT_START_TIME (element) = start_time;
2197 element->base_time = base_time;
2198 /* peel off the locked flag */
2199 locked = GST_ELEMENT_IS_LOCKED_STATE (element);
2200 /* Get the previous set_state result to preserve NO_PREROLL and ASYNC */
2201 ret = GST_STATE_RETURN (element);
2202 child_current = GST_STATE (element);
2203 child_pending = GST_STATE_PENDING (element);
2204 GST_OBJECT_UNLOCK (element);
2206 /* skip locked elements */
2207 if (G_UNLIKELY (locked))
2210 /* if the element was no preroll, just start changing the state regardless
2211 * if it had async elements (in the case of a bin) because they won't preroll
2213 if (G_UNLIKELY (ret == GST_STATE_CHANGE_NO_PREROLL)) {
2214 GST_DEBUG_OBJECT (element, "element is NO_PREROLL, ignore async elements");
2218 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2219 "current %s pending %s, desired next %s",
2220 gst_element_state_get_name (child_current),
2221 gst_element_state_get_name (child_pending),
2222 gst_element_state_get_name (next));
2224 /* always recurse into bins so that we can set the base time */
2225 if (GST_IS_BIN (element))
2228 /* Try not to change the state of elements that are already in the state we're
2230 if (child_current == next && child_pending == GST_STATE_VOID_PENDING) {
2231 /* child is already at the requested state, return previous return. Note that
2232 * if the child has a pending state to next, we will still call the
2233 * set_state function */
2235 } else if (next > current) {
2236 /* upward state change */
2237 if (child_pending == GST_STATE_VOID_PENDING) {
2238 /* .. and the child is not busy doing anything */
2239 if (child_current > next) {
2240 /* .. and is already past the requested state, assume it got there
2242 ret = GST_STATE_CHANGE_SUCCESS;
2245 } else if (child_pending > child_current) {
2246 /* .. and the child is busy going upwards */
2247 if (child_current >= next) {
2248 /* .. and is already past the requested state, assume it got there
2250 ret = GST_STATE_CHANGE_SUCCESS;
2254 /* .. and the child is busy going downwards */
2255 if (child_current > next) {
2256 /* .. and is already past the requested state, assume it got there
2258 ret = GST_STATE_CHANGE_SUCCESS;
2262 } else if (next < current) {
2263 /* downward state change */
2264 if (child_pending == GST_STATE_VOID_PENDING) {
2265 /* .. and the child is not busy doing anything */
2266 if (child_current < next) {
2267 /* .. and is already past the requested state, assume it got there
2269 ret = GST_STATE_CHANGE_SUCCESS;
2272 } else if (child_pending < child_current) {
2273 /* .. and the child is busy going downwards */
2274 if (child_current <= next) {
2275 /* .. and is already past the requested state, assume it got there
2277 ret = GST_STATE_CHANGE_SUCCESS;
2281 /* .. and the child is busy going upwards */
2282 if (child_current < next) {
2283 /* .. and is already past the requested state, assume it got there
2285 ret = GST_STATE_CHANGE_SUCCESS;
2292 GST_OBJECT_LOCK (bin);
2293 /* the element was busy with an upwards async state change, we must wait for
2294 * an ASYNC_DONE message before we attemp to change the state. */
2296 find_message (bin, GST_OBJECT_CAST (element),
2297 GST_MESSAGE_ASYNC_START))) {
2298 #ifndef GST_DISABLE_GST_DEBUG
2299 GstMessage *message = GST_MESSAGE_CAST (found->data);
2301 GST_DEBUG_OBJECT (element, "element message %p, %s async busy",
2302 message, GST_ELEMENT_NAME (GST_MESSAGE_SRC (message)));
2304 /* only wait for upward state changes */
2305 if (next > current) {
2306 /* We found an async element check if we can force its state to change or
2307 * if we have to wait for it to preroll. */
2311 GST_OBJECT_UNLOCK (bin);
2314 GST_DEBUG_OBJECT (bin,
2315 "setting element %s to %s, base_time %" GST_TIME_FORMAT,
2316 GST_ELEMENT_NAME (element), gst_element_state_get_name (next),
2317 GST_TIME_ARGS (base_time));
2320 ret = gst_element_set_state (element, next);
2322 GST_STATE_UNLOCK (element);
2328 GST_DEBUG_OBJECT (element,
2329 "element is locked, return previous return %s",
2330 gst_element_state_change_return_get_name (ret));
2331 GST_STATE_UNLOCK (element);
2336 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2337 "skipping transition from %s to %s",
2338 gst_element_state_get_name (child_current),
2339 gst_element_state_get_name (next));
2340 GST_STATE_UNLOCK (element);
2345 GST_DEBUG_OBJECT (element, "element was busy, delaying state change");
2346 GST_OBJECT_UNLOCK (bin);
2347 GST_STATE_UNLOCK (element);
2348 return GST_STATE_CHANGE_ASYNC;
2352 /* gst_iterator_fold functions for pads_activate
2353 * Stop the iterator if activating one pad failed. */
2355 activate_pads (const GValue * vpad, GValue * ret, gboolean * active)
2357 GstPad *pad = g_value_get_object (vpad);
2358 gboolean cont = TRUE;
2360 if (!(cont = gst_pad_set_active (pad, *active)))
2361 g_value_set_boolean (ret, FALSE);
2366 /* returns false on error or early cutout of the fold, true if all
2367 * pads in @iter were (de)activated successfully. */
2369 iterator_activate_fold_with_resync (GstIterator * iter, gpointer user_data)
2371 GstIteratorResult ires;
2374 /* no need to unset this later, it's just a boolean */
2375 g_value_init (&ret, G_TYPE_BOOLEAN);
2376 g_value_set_boolean (&ret, TRUE);
2379 ires = gst_iterator_fold (iter, (GstIteratorFoldFunction) activate_pads,
2382 case GST_ITERATOR_RESYNC:
2383 /* need to reset the result again */
2384 g_value_set_boolean (&ret, TRUE);
2385 gst_iterator_resync (iter);
2387 case GST_ITERATOR_DONE:
2388 /* all pads iterated, return collected value */
2391 /* iterator returned _ERROR or premature end with _OK,
2392 * mark an error and exit */
2393 g_value_set_boolean (&ret, FALSE);
2398 /* return collected value */
2399 return g_value_get_boolean (&ret);
2402 /* is called with STATE_LOCK
2405 gst_bin_src_pads_activate (GstBin * bin, gboolean active)
2410 GST_DEBUG_OBJECT (bin, "%s pads", active ? "activate" : "deactivate");
2412 iter = gst_element_iterate_src_pads ((GstElement *) bin);
2413 fold_ok = iterator_activate_fold_with_resync (iter, &active);
2414 gst_iterator_free (iter);
2415 if (G_UNLIKELY (!fold_ok))
2418 GST_DEBUG_OBJECT (bin, "pad %sactivation successful", active ? "" : "de");
2425 GST_DEBUG_OBJECT (bin, "pad %sactivation failed", active ? "" : "de");
2431 * gst_bin_recalculate_latency:
2434 * Query @bin for the current latency using and reconfigures this latency to all the
2435 * elements with a LATENCY event.
2437 * This method is typically called on the pipeline when a #GST_MESSAGE_LATENCY
2438 * is posted on the bus.
2440 * This function simply emits the 'do-latency' signal so any custom latency
2441 * calculations will be performed.
2443 * Returns: %TRUE if the latency could be queried and reconfigured.
2446 gst_bin_recalculate_latency (GstBin * bin)
2450 g_signal_emit (bin, gst_bin_signals[DO_LATENCY], 0, &res);
2451 GST_DEBUG_OBJECT (bin, "latency returned %d", res);
2457 gst_bin_do_latency_func (GstBin * bin)
2460 GstElement *element;
2461 GstClockTime min_latency, max_latency;
2464 g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
2466 element = GST_ELEMENT_CAST (bin);
2468 GST_DEBUG_OBJECT (element, "querying latency");
2470 query = gst_query_new_latency ();
2471 if ((res = gst_element_query (element, query))) {
2474 gst_query_parse_latency (query, &live, &min_latency, &max_latency);
2476 GST_DEBUG_OBJECT (element,
2477 "got min latency %" GST_TIME_FORMAT ", max latency %"
2478 GST_TIME_FORMAT ", live %d", GST_TIME_ARGS (min_latency),
2479 GST_TIME_ARGS (max_latency), live);
2481 if (max_latency < min_latency) {
2482 /* this is an impossible situation, some parts of the pipeline might not
2483 * work correctly. We post a warning for now. */
2484 GST_ELEMENT_WARNING (element, CORE, CLOCK, (NULL),
2485 ("Impossible to configure latency: max %" GST_TIME_FORMAT " < min %"
2486 GST_TIME_FORMAT ". Add queues or other buffering elements.",
2487 GST_TIME_ARGS (max_latency), GST_TIME_ARGS (min_latency)));
2490 /* configure latency on elements */
2491 res = gst_element_send_event (element, gst_event_new_latency (min_latency));
2493 GST_INFO_OBJECT (element, "configured latency of %" GST_TIME_FORMAT,
2494 GST_TIME_ARGS (min_latency));
2496 GST_WARNING_OBJECT (element,
2497 "did not really configure latency of %" GST_TIME_FORMAT,
2498 GST_TIME_ARGS (min_latency));
2501 /* this is not a real problem, we just don't configure any latency. */
2502 GST_WARNING_OBJECT (element, "failed to query latency");
2504 gst_query_unref (query);
2510 gst_bin_state_changed (GstElement * element, GstState oldstate,
2511 GstState newstate, GstState pending)
2513 GstElementClass *pklass = (GstElementClass *) parent_class;
2515 if (newstate == GST_STATE_PLAYING && pending == GST_STATE_VOID_PENDING)
2516 bin_do_eos (GST_BIN_CAST (element));
2518 if (pklass->state_changed)
2519 pklass->state_changed (element, oldstate, newstate, pending);
2522 static GstStateChangeReturn
2523 gst_bin_change_state_func (GstElement * element, GstStateChange transition)
2526 GstStateChangeReturn ret;
2527 GstState current, next;
2528 gboolean have_async;
2529 gboolean have_no_preroll;
2530 GstClockTime base_time, start_time;
2533 GValue data = { 0, };
2535 /* we don't need to take the STATE_LOCK, it is already taken */
2536 current = (GstState) GST_STATE_TRANSITION_CURRENT (transition);
2537 next = (GstState) GST_STATE_TRANSITION_NEXT (transition);
2539 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2540 "changing state of children from %s to %s",
2541 gst_element_state_get_name (current), gst_element_state_get_name (next));
2543 bin = GST_BIN_CAST (element);
2546 case GST_STATE_PLAYING:
2550 GST_OBJECT_LOCK (bin);
2551 toplevel = BIN_IS_TOPLEVEL (bin);
2552 GST_OBJECT_UNLOCK (bin);
2555 gst_bin_recalculate_latency (bin);
2558 case GST_STATE_PAUSED:
2559 /* Clear EOS list on next PAUSED */
2560 GST_OBJECT_LOCK (bin);
2561 GST_DEBUG_OBJECT (element, "clearing EOS elements");
2562 bin_remove_messages (bin, NULL, GST_MESSAGE_EOS);
2563 bin->priv->posted_eos = FALSE;
2564 if (current == GST_STATE_READY)
2565 bin_remove_messages (bin, NULL, GST_MESSAGE_STREAM_START);
2566 GST_OBJECT_UNLOCK (bin);
2567 if (current == GST_STATE_READY)
2568 if (!(gst_bin_src_pads_activate (bin, TRUE)))
2569 goto activate_failure;
2571 case GST_STATE_READY:
2572 /* Clear message list on next READY */
2573 GST_OBJECT_LOCK (bin);
2574 GST_DEBUG_OBJECT (element, "clearing all cached messages");
2575 bin_remove_messages (bin, NULL, GST_MESSAGE_ANY);
2576 GST_OBJECT_UNLOCK (bin);
2577 if (current == GST_STATE_PAUSED)
2578 if (!(gst_bin_src_pads_activate (bin, FALSE)))
2579 goto activate_failure;
2581 case GST_STATE_NULL:
2582 if (current == GST_STATE_READY)
2583 if (!(gst_bin_src_pads_activate (bin, FALSE)))
2584 goto activate_failure;
2590 /* this flag is used to make the async state changes return immediately. We
2591 * don't want them to interfere with this state change */
2592 GST_OBJECT_LOCK (bin);
2593 bin->polling = TRUE;
2594 GST_OBJECT_UNLOCK (bin);
2596 /* iterate in state change order */
2597 it = gst_bin_iterate_sorted (bin);
2599 /* mark if we've seen an ASYNC element in the bin when we did a state change.
2600 * Note how we don't reset this value when a resync happens, the reason being
2601 * that the async element posted ASYNC_START and we want to post ASYNC_DONE
2602 * even after a resync when the async element is gone */
2606 /* take base_time */
2607 base_time = gst_element_get_base_time (element);
2608 start_time = gst_element_get_start_time (element);
2610 have_no_preroll = FALSE;
2614 switch (gst_iterator_next (it, &data)) {
2615 case GST_ITERATOR_OK:
2619 child = g_value_get_object (&data);
2621 /* set state and base_time now */
2622 ret = gst_bin_element_set_state (bin, child, base_time, start_time,
2626 case GST_STATE_CHANGE_SUCCESS:
2627 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2628 "child '%s' changed state to %d(%s) successfully",
2629 GST_ELEMENT_NAME (child), next,
2630 gst_element_state_get_name (next));
2632 case GST_STATE_CHANGE_ASYNC:
2634 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2635 "child '%s' is changing state asynchronously to %s",
2636 GST_ELEMENT_NAME (child), gst_element_state_get_name (next));
2640 case GST_STATE_CHANGE_FAILURE:{
2643 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2644 "child '%s' failed to go to state %d(%s)",
2645 GST_ELEMENT_NAME (child),
2646 next, gst_element_state_get_name (next));
2648 /* Only fail if the child is still inside
2649 * this bin. It might've been removed already
2650 * because of the error by the bin subclass
2651 * to ignore the error. */
2652 parent = gst_object_get_parent (GST_OBJECT_CAST (child));
2653 if (parent == GST_OBJECT_CAST (element)) {
2654 /* element is still in bin, really error now */
2655 gst_object_unref (parent);
2658 /* child removed from bin, let the resync code redo the state
2660 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2661 "child '%s' was removed from the bin",
2662 GST_ELEMENT_NAME (child));
2665 gst_object_unref (parent);
2669 case GST_STATE_CHANGE_NO_PREROLL:
2670 GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2671 "child '%s' changed state to %d(%s) successfully without preroll",
2672 GST_ELEMENT_NAME (child), next,
2673 gst_element_state_get_name (next));
2674 have_no_preroll = TRUE;
2677 g_assert_not_reached ();
2680 g_value_reset (&data);
2683 case GST_ITERATOR_RESYNC:
2684 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "iterator doing resync");
2685 gst_iterator_resync (it);
2688 case GST_ITERATOR_DONE:
2689 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "iterator done");
2695 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2696 if (G_UNLIKELY (ret == GST_STATE_CHANGE_FAILURE))
2699 if (have_no_preroll) {
2700 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2701 "we have NO_PREROLL elements %s -> NO_PREROLL",
2702 gst_element_state_change_return_get_name (ret));
2703 ret = GST_STATE_CHANGE_NO_PREROLL;
2704 } else if (have_async) {
2705 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2706 "we have ASYNC elements %s -> ASYNC",
2707 gst_element_state_change_return_get_name (ret));
2708 ret = GST_STATE_CHANGE_ASYNC;
2712 g_value_unset (&data);
2713 gst_iterator_free (it);
2715 GST_OBJECT_LOCK (bin);
2716 bin->polling = FALSE;
2717 /* it's possible that we did not get ASYNC from the children while the bin is
2718 * simulating ASYNC behaviour by posting an ASYNC_DONE message on the bus with
2719 * itself as the source. In that case we still want to check if the state
2720 * change completed. */
2721 if (ret != GST_STATE_CHANGE_ASYNC && !bin->priv->pending_async_done) {
2722 /* no element returned ASYNC and there are no pending async_done messages,
2723 * we can just complete. */
2724 GST_DEBUG_OBJECT (bin, "no async elements");
2727 /* when we get here an ASYNC element was found */
2728 if (GST_STATE_TARGET (bin) <= GST_STATE_READY) {
2729 /* we ignore ASYNC state changes when we go to READY or NULL */
2730 GST_DEBUG_OBJECT (bin, "target state %s <= READY",
2731 gst_element_state_get_name (GST_STATE_TARGET (bin)));
2735 GST_DEBUG_OBJECT (bin, "check async elements");
2736 /* check if all elements managed to commit their state already */
2737 if (!find_message (bin, NULL, GST_MESSAGE_ASYNC_START)) {
2738 /* nothing found, remove all old ASYNC_DONE messages. This can happen when
2739 * all the elements commited their state while we were doing the state
2740 * change. We will still return ASYNC for consistency but we commit the
2741 * state already so that a _get_state() will return immediately. */
2742 bin_remove_messages (bin, NULL, GST_MESSAGE_ASYNC_DONE);
2744 GST_DEBUG_OBJECT (bin, "async elements commited");
2745 bin_handle_async_done (bin, GST_STATE_CHANGE_SUCCESS, FALSE,
2746 GST_CLOCK_TIME_NONE);
2750 bin->priv->pending_async_done = FALSE;
2751 GST_OBJECT_UNLOCK (bin);
2753 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2754 "done changing bin's state from %s to %s, now in %s, ret %s",
2755 gst_element_state_get_name (current),
2756 gst_element_state_get_name (next),
2757 gst_element_state_get_name (GST_STATE (element)),
2758 gst_element_state_change_return_get_name (ret));
2765 GST_CAT_WARNING_OBJECT (GST_CAT_STATES, element,
2766 "failure (de)activating src pads");
2767 return GST_STATE_CHANGE_FAILURE;
2772 * This function is a utility event handler for seek events.
2773 * It will send the event to all sinks or sources and appropriate
2774 * ghost pads depending on the event-direction.
2776 * Applications are free to override this behaviour and
2777 * implement their own seek handler, but this will work for
2778 * pretty much all cases in practice.
2781 gst_bin_send_event (GstElement * element, GstEvent * event)
2783 GstBin *bin = GST_BIN_CAST (element);
2785 gboolean res = TRUE;
2786 gboolean done = FALSE;
2787 GValue data = { 0, };
2789 if (GST_EVENT_IS_DOWNSTREAM (event)) {
2790 iter = gst_bin_iterate_sources (bin);
2791 GST_DEBUG_OBJECT (bin, "Sending %s event to src children",
2792 GST_EVENT_TYPE_NAME (event));
2794 iter = gst_bin_iterate_sinks (bin);
2795 GST_DEBUG_OBJECT (bin, "Sending %s event to sink children",
2796 GST_EVENT_TYPE_NAME (event));
2800 switch (gst_iterator_next (iter, &data)) {
2801 case GST_ITERATOR_OK:
2803 GstElement *child = g_value_get_object (&data);
2805 gst_event_ref (event);
2806 res &= gst_element_send_event (child, event);
2808 GST_LOG_OBJECT (child, "After handling %s event: %d",
2809 GST_EVENT_TYPE_NAME (event), res);
2811 g_value_reset (&data);
2814 case GST_ITERATOR_RESYNC:
2815 gst_iterator_resync (iter);
2818 case GST_ITERATOR_DONE:
2821 case GST_ITERATOR_ERROR:
2822 g_assert_not_reached ();
2826 g_value_unset (&data);
2827 gst_iterator_free (iter);
2829 if (GST_EVENT_IS_DOWNSTREAM (event)) {
2830 iter = gst_element_iterate_sink_pads (GST_ELEMENT (bin));
2831 GST_DEBUG_OBJECT (bin, "Sending %s event to sink pads",
2832 GST_EVENT_TYPE_NAME (event));
2834 iter = gst_element_iterate_src_pads (GST_ELEMENT (bin));
2835 GST_DEBUG_OBJECT (bin, "Sending %s event to src pads",
2836 GST_EVENT_TYPE_NAME (event));
2841 switch (gst_iterator_next (iter, &data)) {
2842 case GST_ITERATOR_OK:
2844 GstPad *pad = g_value_get_object (&data);
2846 gst_event_ref (event);
2847 res &= gst_pad_send_event (pad, event);
2848 GST_LOG_OBJECT (pad, "After handling %s event: %d",
2849 GST_EVENT_TYPE_NAME (event), res);
2852 case GST_ITERATOR_RESYNC:
2853 gst_iterator_resync (iter);
2856 case GST_ITERATOR_DONE:
2859 case GST_ITERATOR_ERROR:
2860 g_assert_not_reached ();
2865 g_value_unset (&data);
2866 gst_iterator_free (iter);
2867 gst_event_unref (event);
2872 /* this is the function called by the threadpool. When async elements commit
2873 * their state, this function will attempt to bring the bin to the next state.
2876 gst_bin_continue_func (BinContinueData * data)
2879 GstState current, next, pending;
2880 GstStateChange transition;
2883 pending = data->pending;
2885 GST_DEBUG_OBJECT (bin, "waiting for state lock");
2886 GST_STATE_LOCK (bin);
2888 GST_DEBUG_OBJECT (bin, "doing state continue");
2889 GST_OBJECT_LOCK (bin);
2891 /* if a new state change happened after this thread was scheduled, we return
2893 if (data->cookie != GST_ELEMENT_CAST (bin)->state_cookie)
2896 current = GST_STATE (bin);
2897 next = GST_STATE_GET_NEXT (current, pending);
2898 transition = (GstStateChange) GST_STATE_TRANSITION (current, next);
2900 GST_STATE_NEXT (bin) = next;
2901 GST_STATE_PENDING (bin) = pending;
2903 GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
2904 GST_OBJECT_UNLOCK (bin);
2906 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2907 "continue state change %s to %s, final %s",
2908 gst_element_state_get_name (current),
2909 gst_element_state_get_name (next), gst_element_state_get_name (pending));
2911 gst_element_change_state (GST_ELEMENT_CAST (bin), transition);
2913 GST_STATE_UNLOCK (bin);
2914 GST_DEBUG_OBJECT (bin, "state continue done");
2916 gst_object_unref (bin);
2917 g_slice_free (BinContinueData, data);
2922 GST_OBJECT_UNLOCK (bin);
2923 GST_STATE_UNLOCK (bin);
2924 GST_DEBUG_OBJECT (bin, "state continue aborted due to intervening change");
2925 gst_object_unref (bin);
2926 g_slice_free (BinContinueData, data);
2931 static GstBusSyncReply
2932 bin_bus_handler (GstBus * bus, GstMessage * message, GstBin * bin)
2934 GstBinClass *bclass;
2936 bclass = GST_BIN_GET_CLASS (bin);
2937 if (bclass->handle_message)
2938 bclass->handle_message (bin, message);
2940 gst_message_unref (message);
2942 return GST_BUS_DROP;
2946 bin_push_state_continue (BinContinueData * data)
2953 klass = GST_BIN_GET_CLASS (bin);
2955 GST_DEBUG_OBJECT (bin, "pushing continue on thread pool");
2956 g_thread_pool_push (klass->pool, data, NULL);
2959 /* an element started an async state change, if we were not busy with a state
2960 * change, we perform a lost state.
2961 * This function is called with the OBJECT lock.
2964 bin_handle_async_start (GstBin * bin)
2966 GstState old_state, new_state;
2968 GstMessage *amessage = NULL;
2970 if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_FAILURE)
2973 /* get our toplevel state */
2974 toplevel = BIN_IS_TOPLEVEL (bin);
2976 /* prepare an ASYNC_START message, we always post the start message even if we
2977 * are busy with a state change or when we are NO_PREROLL. */
2979 /* non toplevel bin, prepare async-start for the parent */
2980 amessage = gst_message_new_async_start (GST_OBJECT_CAST (bin));
2982 if (bin->polling || GST_STATE_PENDING (bin) != GST_STATE_VOID_PENDING)
2985 /* async starts are ignored when we are NO_PREROLL */
2986 if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_NO_PREROLL)
2987 goto was_no_preroll;
2989 old_state = GST_STATE (bin);
2991 /* when we PLAYING we go back to PAUSED, when preroll happens, we go back to
2992 * PLAYING after optionally redistributing the base_time. */
2993 if (old_state > GST_STATE_PAUSED)
2994 new_state = GST_STATE_PAUSED;
2996 new_state = old_state;
2998 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2999 "lost state of %s, new %s", gst_element_state_get_name (old_state),
3000 gst_element_state_get_name (new_state));
3002 GST_STATE (bin) = new_state;
3003 GST_STATE_NEXT (bin) = new_state;
3004 GST_STATE_PENDING (bin) = new_state;
3005 GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
3006 GST_OBJECT_UNLOCK (bin);
3009 _priv_gst_element_state_changed (GST_ELEMENT_CAST (bin), new_state, new_state,
3014 /* post our ASYNC_START. */
3015 GST_DEBUG_OBJECT (bin, "posting ASYNC_START to parent");
3016 gst_element_post_message (GST_ELEMENT_CAST (bin), amessage);
3018 GST_OBJECT_LOCK (bin);
3024 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "we had an error");
3029 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "state change busy");
3030 GST_OBJECT_UNLOCK (bin);
3035 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "ignoring, we are NO_PREROLL");
3036 GST_OBJECT_UNLOCK (bin);
3041 /* this function is called when there are no more async elements in the bin. We
3042 * post a state changed message and an ASYNC_DONE message.
3043 * This function is called with the OBJECT lock.
3046 bin_handle_async_done (GstBin * bin, GstStateChangeReturn ret,
3047 gboolean flag_pending, GstClockTime running_time)
3049 GstState current, pending, target;
3050 GstStateChangeReturn old_ret;
3051 GstState old_state, old_next;
3052 gboolean toplevel, state_changed = FALSE;
3053 GstMessage *amessage = NULL;
3054 BinContinueData *cont = NULL;
3056 if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_FAILURE)
3059 pending = GST_STATE_PENDING (bin);
3064 /* check if there is something to commit */
3065 if (pending == GST_STATE_VOID_PENDING)
3066 goto nothing_pending;
3068 old_ret = GST_STATE_RETURN (bin);
3069 GST_STATE_RETURN (bin) = ret;
3071 /* move to the next target state */
3072 target = GST_STATE_TARGET (bin);
3073 pending = GST_STATE_PENDING (bin) = target;
3075 amessage = gst_message_new_async_done (GST_OBJECT_CAST (bin), running_time);
3077 old_state = GST_STATE (bin);
3078 /* this is the state we should go to next */
3079 old_next = GST_STATE_NEXT (bin);
3081 if (old_next != GST_STATE_PLAYING) {
3082 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
3083 "committing state from %s to %s, old pending %s",
3084 gst_element_state_get_name (old_state),
3085 gst_element_state_get_name (old_next),
3086 gst_element_state_get_name (pending));
3088 /* update current state */
3089 current = GST_STATE (bin) = old_next;
3091 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
3092 "setting state from %s to %s, pending %s",
3093 gst_element_state_get_name (old_state),
3094 gst_element_state_get_name (old_state),
3095 gst_element_state_get_name (pending));
3096 current = old_state;
3099 /* get our toplevel state */
3100 toplevel = BIN_IS_TOPLEVEL (bin);
3102 /* see if we reached the final state. If we are not toplevel, we also have to
3103 * stop here, the parent will continue our state. */
3104 if ((pending == current) || !toplevel) {
3105 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
3106 "completed state change, pending VOID");
3108 /* mark VOID pending */
3109 pending = GST_STATE_VOID_PENDING;
3110 GST_STATE_PENDING (bin) = pending;
3111 GST_STATE_NEXT (bin) = GST_STATE_VOID_PENDING;
3113 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
3114 "continue state change, pending %s",
3115 gst_element_state_get_name (pending));
3117 cont = g_slice_new (BinContinueData);
3119 /* ref to the bin */
3120 cont->bin = gst_object_ref (bin);
3121 /* cookie to detect concurrent state change */
3122 cont->cookie = GST_ELEMENT_CAST (bin)->state_cookie;
3123 /* pending target state */
3124 cont->pending = pending;
3126 GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
3127 GST_STATE_NEXT (bin) = GST_STATE_GET_NEXT (old_state, pending);
3130 if (old_next != GST_STATE_PLAYING) {
3131 if (old_state != old_next || old_ret == GST_STATE_CHANGE_ASYNC) {
3132 state_changed = TRUE;
3135 GST_OBJECT_UNLOCK (bin);
3137 if (state_changed) {
3138 _priv_gst_element_state_changed (GST_ELEMENT_CAST (bin), old_state,
3142 /* post our combined ASYNC_DONE when all is ASYNC_DONE. */
3143 GST_DEBUG_OBJECT (bin, "posting ASYNC_DONE to parent");
3144 gst_element_post_message (GST_ELEMENT_CAST (bin), amessage);
3147 GST_OBJECT_LOCK (bin);
3149 /* toplevel, start continue state */
3150 GST_DEBUG_OBJECT (bin, "all async-done, starting state continue");
3151 bin_push_state_continue (cont);
3153 GST_DEBUG_OBJECT (bin, "state change complete");
3154 GST_STATE_BROADCAST (bin);
3160 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "we had an error");
3165 GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "state change busy");
3166 /* if we were busy with a state change and we are requested to flag a
3167 * pending async done, we do so here */
3169 bin->priv->pending_async_done = TRUE;
3174 GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin, "nothing pending");
3180 bin_do_eos (GstBin * bin)
3185 GST_OBJECT_LOCK (bin);
3186 /* If all sinks are EOS, we're in PLAYING and no state change is pending
3187 * we forward the EOS message to the parent bin or application
3189 eos = GST_STATE (bin) == GST_STATE_PLAYING
3190 && GST_STATE_PENDING (bin) == GST_STATE_VOID_PENDING
3191 && is_eos (bin, &seqnum);
3192 GST_OBJECT_UNLOCK (bin);
3195 && g_atomic_int_compare_and_exchange (&bin->priv->posted_eos, FALSE,
3197 GstMessage *tmessage;
3199 /* Clear out any further messages, and reset posted_eos so we can
3200 detect any new EOS that happens (eg, after a seek). Since all
3201 sinks have now posted an EOS, there will be no further EOS events
3202 seen unless there is a new logical EOS */
3203 GST_OBJECT_LOCK (bin);
3204 bin_remove_messages (bin, NULL, GST_MESSAGE_EOS);
3205 bin->priv->posted_eos = FALSE;
3206 GST_OBJECT_UNLOCK (bin);
3208 tmessage = gst_message_new_eos (GST_OBJECT_CAST (bin));
3209 gst_message_set_seqnum (tmessage, seqnum);
3210 GST_DEBUG_OBJECT (bin,
3211 "all sinks posted EOS, posting seqnum #%" G_GUINT32_FORMAT, seqnum);
3212 gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3217 bin_do_stream_start (GstBin * bin)
3220 gboolean stream_start;
3221 gboolean have_group_id = FALSE;
3224 GST_OBJECT_LOCK (bin);
3225 /* If all sinks are STREAM_START we forward the STREAM_START message
3226 * to the parent bin or application
3228 stream_start = is_stream_start (bin, &seqnum, &have_group_id, &group_id);
3229 GST_OBJECT_UNLOCK (bin);
3232 GstMessage *tmessage;
3234 GST_OBJECT_LOCK (bin);
3235 bin_remove_messages (bin, NULL, GST_MESSAGE_STREAM_START);
3236 GST_OBJECT_UNLOCK (bin);
3238 tmessage = gst_message_new_stream_start (GST_OBJECT_CAST (bin));
3239 gst_message_set_seqnum (tmessage, seqnum);
3241 gst_message_set_group_id (tmessage, group_id);
3243 GST_DEBUG_OBJECT (bin,
3244 "all sinks posted STREAM_START, posting seqnum #%" G_GUINT32_FORMAT,
3246 gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3250 /* must be called with the object lock. This function releases the lock to post
3253 bin_do_message_forward (GstBin * bin, GstMessage * message)
3255 if (bin->priv->message_forward) {
3256 GstMessage *forwarded;
3258 GST_DEBUG_OBJECT (bin, "pass %s message upward",
3259 GST_MESSAGE_TYPE_NAME (message));
3260 GST_OBJECT_UNLOCK (bin);
3262 /* we need to convert these messages to element messages so that our parent
3263 * bin can easily ignore them and so that the application can easily
3264 * distinguish between the internally forwarded and the real messages. */
3265 forwarded = gst_message_new_element (GST_OBJECT_CAST (bin),
3266 gst_structure_new ("GstBinForwarded",
3267 "message", GST_TYPE_MESSAGE, message, NULL));
3269 gst_element_post_message (GST_ELEMENT_CAST (bin), forwarded);
3271 GST_OBJECT_LOCK (bin);
3275 /* handle child messages:
3277 * This method is called synchronously when a child posts a message on
3280 * GST_MESSAGE_EOS: This message is only posted by sinks
3281 * in the PLAYING state. If all sinks posted the EOS message, post
3284 * GST_MESSAGE_STATE_DIRTY: Deprecated
3286 * GST_MESSAGE_SEGMENT_START: just collect, never forward upwards. If an
3287 * element posts segment_start twice, only the last message is kept.
3289 * GST_MESSAGE_SEGMENT_DONE: replace SEGMENT_START message from same poster
3290 * with the segment_done message. If there are no more segment_start
3291 * messages, post segment_done message upwards.
3293 * GST_MESSAGE_DURATION_CHANGED: clear any cached durations.
3294 * Whenever someone performs a duration query on the bin, we store the
3295 * result so we can answer it quicker the next time. Any element that
3296 * changes its duration marks our cached values invalid.
3297 * This message is also posted upwards. This is currently disabled
3298 * because too many elements don't post DURATION_CHANGED messages when
3299 * the duration changes.
3301 * GST_MESSAGE_CLOCK_LOST: This message is posted by an element when it
3302 * can no longer provide a clock. The default bin behaviour is to
3303 * check if the lost clock was the one provided by the bin. If so and
3304 * we are currently in the PLAYING state, we forward the message to
3306 * This message is also generated when we remove a clock provider from
3307 * a bin. If this message is received by the application, it should
3308 * PAUSE the pipeline and set it back to PLAYING to force a new clock
3309 * and a new base_time distribution.
3311 * GST_MESSAGE_CLOCK_PROVIDE: This message is generated when an element
3312 * can provide a clock. This mostly happens when we add a new clock
3313 * provider to the bin. The default behaviour of the bin is to mark the
3314 * currently selected clock as dirty, which will perform a clock
3315 * recalculation the next time we are asked to provide a clock.
3316 * This message is never sent to the application but is forwarded to
3319 * GST_MESSAGE_ASYNC_START: Create an internal ELEMENT message that stores
3320 * the state of the element and the fact that the element will need a
3321 * new base_time. This message is not forwarded to the application.
3323 * GST_MESSAGE_ASYNC_DONE: Find the internal ELEMENT message we kept for the
3324 * element when it posted ASYNC_START. If all elements are done, post a
3325 * ASYNC_DONE message to the parent.
3327 * OTHER: post upwards.
3330 gst_bin_handle_message_func (GstBin * bin, GstMessage * message)
3333 GstMessageType type;
3334 GstMessage *tmessage;
3337 src = GST_MESSAGE_SRC (message);
3338 type = GST_MESSAGE_TYPE (message);
3340 GST_DEBUG_OBJECT (bin, "[msg %p] handling child %s message of type %s",
3341 message, src ? GST_ELEMENT_NAME (src) : "(NULL)",
3342 GST_MESSAGE_TYPE_NAME (message));
3345 case GST_MESSAGE_ERROR:
3347 GST_OBJECT_LOCK (bin);
3349 GST_DEBUG_OBJECT (bin, "got ERROR message, unlocking state change");
3350 GST_STATE_RETURN (bin) = GST_STATE_CHANGE_FAILURE;
3351 GST_STATE_BROADCAST (bin);
3352 GST_OBJECT_UNLOCK (bin);
3356 case GST_MESSAGE_EOS:
3359 /* collect all eos messages from the children */
3360 GST_OBJECT_LOCK (bin);
3361 bin_do_message_forward (bin, message);
3362 /* ref message for future use */
3363 bin_replace_message (bin, message, GST_MESSAGE_EOS);
3364 GST_OBJECT_UNLOCK (bin);
3369 case GST_MESSAGE_STREAM_START:
3372 /* collect all stream_start messages from the children */
3373 GST_OBJECT_LOCK (bin);
3374 /* ref message for future use */
3375 bin_replace_message (bin, message, GST_MESSAGE_STREAM_START);
3376 GST_OBJECT_UNLOCK (bin);
3378 bin_do_stream_start (bin);
3381 case GST_MESSAGE_STATE_DIRTY:
3383 GST_WARNING_OBJECT (bin, "received deprecated STATE_DIRTY message");
3386 gst_message_unref (message);
3389 case GST_MESSAGE_SEGMENT_START:{
3390 gboolean post = FALSE;
3394 gst_message_parse_segment_start (message, &format, &position);
3395 seqnum = gst_message_get_seqnum (message);
3397 GST_OBJECT_LOCK (bin);
3398 bin_do_message_forward (bin, message);
3399 /* if this is the first segment-start, post to parent but not to the
3401 if (!find_message (bin, NULL, GST_MESSAGE_SEGMENT_START) &&
3402 (GST_OBJECT_PARENT (bin) != NULL)) {
3405 /* replace any previous segment_start message from this source
3406 * with the new segment start message */
3407 bin_replace_message (bin, message, GST_MESSAGE_SEGMENT_START);
3408 GST_OBJECT_UNLOCK (bin);
3410 tmessage = gst_message_new_segment_start (GST_OBJECT_CAST (bin),
3412 gst_message_set_seqnum (tmessage, seqnum);
3414 /* post segment start with initial format and position. */
3415 GST_DEBUG_OBJECT (bin, "posting SEGMENT_START (%u) bus message: %p",
3417 gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3421 case GST_MESSAGE_SEGMENT_DONE:
3423 gboolean post = FALSE;
3427 gst_message_parse_segment_done (message, &format, &position);
3428 seqnum = gst_message_get_seqnum (message);
3430 GST_OBJECT_LOCK (bin);
3431 bin_do_message_forward (bin, message);
3432 bin_replace_message (bin, message, GST_MESSAGE_SEGMENT_START);
3433 /* if there are no more segment_start messages, everybody posted
3434 * a segment_done and we can post one on the bus. */
3436 /* we don't care who still has a pending segment start */
3437 if (!find_message (bin, NULL, GST_MESSAGE_SEGMENT_START)) {
3440 /* remove all old segment_done messages */
3441 bin_remove_messages (bin, NULL, GST_MESSAGE_SEGMENT_DONE);
3443 GST_OBJECT_UNLOCK (bin);
3445 tmessage = gst_message_new_segment_done (GST_OBJECT_CAST (bin),
3447 gst_message_set_seqnum (tmessage, seqnum);
3449 /* post segment done with latest format and position. */
3450 GST_DEBUG_OBJECT (bin, "posting SEGMENT_DONE (%u) bus message: %p",
3452 gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3456 case GST_MESSAGE_DURATION_CHANGED:
3458 /* FIXME: remove all cached durations, next time somebody asks
3459 * for duration, we will recalculate. */
3461 GST_OBJECT_LOCK (bin);
3462 bin_remove_messages (bin, NULL, GST_MESSAGE_DURATION_CHANGED);
3463 GST_OBJECT_UNLOCK (bin);
3467 case GST_MESSAGE_CLOCK_LOST:
3469 GstClock **provided_clock_p;
3470 GstElement **clock_provider_p;
3471 gboolean playing, toplevel, provided, forward;
3474 gst_message_parse_clock_lost (message, &clock);
3476 GST_OBJECT_LOCK (bin);
3477 bin->clock_dirty = TRUE;
3478 /* if we lost the clock that we provided, post to parent but
3479 * only if we are not a top-level bin or PLAYING.
3480 * The reason for this is that applications should be able
3481 * to PAUSE/PLAY if they receive this message without worrying
3482 * about the state of the pipeline. */
3483 provided = (clock == bin->provided_clock);
3484 playing = (GST_STATE (bin) == GST_STATE_PLAYING);
3485 toplevel = GST_OBJECT_PARENT (bin) == NULL;
3486 forward = provided && (playing || !toplevel);
3488 GST_DEBUG_OBJECT (bin,
3489 "Lost clock %" GST_PTR_FORMAT " provided by %" GST_PTR_FORMAT,
3490 bin->provided_clock, bin->clock_provider);
3491 provided_clock_p = &bin->provided_clock;
3492 clock_provider_p = &bin->clock_provider;
3493 gst_object_replace ((GstObject **) provided_clock_p, NULL);
3494 gst_object_replace ((GstObject **) clock_provider_p, NULL);
3496 GST_DEBUG_OBJECT (bin, "provided %d, playing %d, forward %d",
3497 provided, playing, forward);
3498 GST_OBJECT_UNLOCK (bin);
3504 gst_message_unref (message);
3507 case GST_MESSAGE_CLOCK_PROVIDE:
3511 GST_OBJECT_LOCK (bin);
3512 bin->clock_dirty = TRUE;
3513 /* a new clock is available, post to parent but not
3514 * to the application */
3515 forward = GST_OBJECT_PARENT (bin) != NULL;
3516 GST_OBJECT_UNLOCK (bin);
3522 gst_message_unref (message);
3525 case GST_MESSAGE_ASYNC_START:
3529 GST_DEBUG_OBJECT (bin, "ASYNC_START message %p, %s", message,
3530 src ? GST_OBJECT_NAME (src) : "(NULL)");
3532 GST_OBJECT_LOCK (bin);
3533 bin_do_message_forward (bin, message);
3535 /* we ignore the message if we are going to <= READY */
3536 if ((target = GST_STATE_TARGET (bin)) <= GST_STATE_READY)
3537 goto ignore_start_message;
3539 /* takes ownership of the message */
3540 bin_replace_message (bin, message, GST_MESSAGE_ASYNC_START);
3542 bin_handle_async_start (bin);
3543 GST_OBJECT_UNLOCK (bin);
3546 ignore_start_message:
3548 GST_DEBUG_OBJECT (bin, "ignoring message, target %s",
3549 gst_element_state_get_name (target));
3550 GST_OBJECT_UNLOCK (bin);
3551 gst_message_unref (message);
3555 case GST_MESSAGE_ASYNC_DONE:
3557 GstClockTime running_time;
3560 GST_DEBUG_OBJECT (bin, "ASYNC_DONE message %p, %s", message,
3561 src ? GST_OBJECT_NAME (src) : "(NULL)");
3563 gst_message_parse_async_done (message, &running_time);
3565 GST_OBJECT_LOCK (bin);
3566 bin_do_message_forward (bin, message);
3568 /* ignore messages if we are shutting down */
3569 if ((target = GST_STATE_TARGET (bin)) <= GST_STATE_READY)
3570 goto ignore_done_message;
3572 bin_replace_message (bin, message, GST_MESSAGE_ASYNC_START);
3573 /* if there are no more ASYNC_START messages, everybody posted
3574 * a ASYNC_DONE and we can post one on the bus. When checking, we
3575 * don't care who still has a pending ASYNC_START */
3576 if (!find_message (bin, NULL, GST_MESSAGE_ASYNC_START)) {
3577 /* nothing found, remove all old ASYNC_DONE messages */
3578 bin_remove_messages (bin, NULL, GST_MESSAGE_ASYNC_DONE);
3580 GST_DEBUG_OBJECT (bin, "async elements commited");
3581 /* when we get an async done message when a state change was busy, we
3582 * need to set the pending_done flag so that at the end of the state
3583 * change we can see if we need to verify pending async elements, hence
3584 * the TRUE argument here. */
3585 bin_handle_async_done (bin, GST_STATE_CHANGE_SUCCESS, TRUE,
3588 GST_DEBUG_OBJECT (bin, "there are more async elements pending");
3590 GST_OBJECT_UNLOCK (bin);
3593 ignore_done_message:
3595 GST_DEBUG_OBJECT (bin, "ignoring message, target %s",
3596 gst_element_state_get_name (target));
3597 GST_OBJECT_UNLOCK (bin);
3598 gst_message_unref (message);
3602 case GST_MESSAGE_STRUCTURE_CHANGE:
3606 gst_message_parse_structure_change (message, NULL, NULL, &busy);
3608 GST_OBJECT_LOCK (bin);
3610 /* while the pad is busy, avoid following it when doing state changes.
3611 * Don't update the cookie yet, we will do that after the structure
3612 * change finished and we are ready to inspect the new updated
3614 bin_replace_message (bin, message, GST_MESSAGE_STRUCTURE_CHANGE);
3617 /* a pad link/unlink ended, signal the state change iterator that we
3618 * need to resync by updating the structure_cookie. */
3619 bin_remove_messages (bin, GST_MESSAGE_SRC (message),
3620 GST_MESSAGE_STRUCTURE_CHANGE);
3621 if (!GST_BIN_IS_NO_RESYNC (bin))
3622 bin->priv->structure_cookie++;
3624 GST_OBJECT_UNLOCK (bin);
3627 gst_message_unref (message);
3638 /* Send all other messages upward */
3639 GST_DEBUG_OBJECT (bin, "posting message upward");
3640 gst_element_post_message (GST_ELEMENT_CAST (bin), message);
3645 /* generic struct passed to all query fold methods */
3654 typedef void (*QueryInitFunction) (GstBin * bin, QueryFold * fold);
3655 typedef void (*QueryDoneFunction) (GstBin * bin, QueryFold * fold);
3657 /* for duration/position we collect all durations/positions and take
3658 * the MAX of all valid results */
3660 bin_query_min_max_init (GstBin * bin, QueryFold * fold)
3668 bin_query_duration_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3670 gboolean res = FALSE;
3671 GstObject *item = g_value_get_object (vitem);
3672 if (GST_IS_PAD (item))
3673 res = gst_pad_query (GST_PAD (item), fold->query);
3675 res = gst_element_query (GST_ELEMENT (item), fold->query);
3680 g_value_set_boolean (ret, TRUE);
3682 gst_query_parse_duration (fold->query, NULL, &duration);
3684 GST_DEBUG_OBJECT (item, "got duration %" G_GINT64_FORMAT, duration);
3686 if (duration == -1) {
3687 /* duration query succeeded, but duration is unknown */
3692 if (duration > fold->max)
3693 fold->max = duration;
3700 bin_query_duration_done (GstBin * bin, QueryFold * fold)
3704 gst_query_parse_duration (fold->query, &format, NULL);
3705 /* store max in query result */
3706 gst_query_set_duration (fold->query, format, fold->max);
3708 GST_DEBUG_OBJECT (bin, "max duration %" G_GINT64_FORMAT, fold->max);
3710 /* FIXME: re-implement duration caching */
3713 GST_OBJECT_LOCK (bin);
3714 bin->messages = g_list_prepend (bin->messages,
3715 gst_message_new_duration (GST_OBJECT_CAST (bin), format, fold->max));
3716 GST_OBJECT_UNLOCK (bin);
3721 bin_query_position_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3723 gboolean res = FALSE;
3724 GstObject *item = g_value_get_object (vitem);
3725 if (GST_IS_PAD (item))
3726 res = gst_pad_query (GST_PAD (item), fold->query);
3728 res = gst_element_query (GST_ELEMENT (item), fold->query);
3733 g_value_set_boolean (ret, TRUE);
3735 gst_query_parse_position (fold->query, NULL, &position);
3737 GST_DEBUG_OBJECT (item, "got position %" G_GINT64_FORMAT, position);
3739 if (position > fold->max)
3740 fold->max = position;
3747 bin_query_position_done (GstBin * bin, QueryFold * fold)
3751 gst_query_parse_position (fold->query, &format, NULL);
3752 /* store max in query result */
3753 gst_query_set_position (fold->query, format, fold->max);
3755 GST_DEBUG_OBJECT (bin, "max position %" G_GINT64_FORMAT, fold->max);
3759 bin_query_latency_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3761 gboolean res = FALSE;
3762 GstObject *item = g_value_get_object (vitem);
3763 if (GST_IS_PAD (item))
3764 res = gst_pad_query (GST_PAD (item), fold->query);
3766 res = gst_element_query (GST_ELEMENT (item), fold->query);
3768 GstClockTime min, max;
3771 gst_query_parse_latency (fold->query, &live, &min, &max);
3773 GST_DEBUG_OBJECT (item,
3774 "got latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
3775 ", live %d", GST_TIME_ARGS (min), GST_TIME_ARGS (max), live);
3777 /* for the combined latency we collect the MAX of all min latencies and
3778 * the MIN of all max latencies */
3780 if (min > fold->min)
3782 if (fold->max == -1)
3784 else if (max < fold->max)
3786 if (fold->live == FALSE)
3790 g_value_set_boolean (ret, FALSE);
3791 GST_DEBUG_OBJECT (item, "failed query");
3798 bin_query_latency_done (GstBin * bin, QueryFold * fold)
3800 /* store max in query result */
3801 gst_query_set_latency (fold->query, fold->live, fold->min, fold->max);
3803 GST_DEBUG_OBJECT (bin,
3804 "latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
3805 ", live %d", GST_TIME_ARGS (fold->min), GST_TIME_ARGS (fold->max),
3809 /* generic fold, return first valid result */
3811 bin_query_generic_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3813 gboolean res = FALSE;
3814 GstObject *item = g_value_get_object (vitem);
3815 if (GST_IS_PAD (item))
3816 res = gst_pad_query (GST_PAD (item), fold->query);
3818 res = gst_element_query (GST_ELEMENT (item), fold->query);
3820 g_value_set_boolean (ret, TRUE);
3821 GST_DEBUG_OBJECT (item, "answered query %p", fold->query);
3824 /* and stop as soon as we have a valid result */
3828 /* Perform a query iteration for the given bin. The query is stored in
3829 * QueryFold and iter should be either a GstPad iterator or a
3830 * GstElement iterator. */
3832 bin_iterate_fold (GstBin * bin, GstIterator * iter, QueryInitFunction fold_init,
3833 QueryDoneFunction fold_done, GstIteratorFoldFunction fold_func,
3834 QueryFold fold_data, gboolean default_return)
3836 gboolean res = default_return;
3838 /* set the result of the query to FALSE initially */
3839 g_value_init (&ret, G_TYPE_BOOLEAN);
3840 g_value_set_boolean (&ret, res);
3843 GstIteratorResult ires;
3845 ires = gst_iterator_fold (iter, fold_func, &ret, &fold_data);
3848 case GST_ITERATOR_RESYNC:
3849 gst_iterator_resync (iter);
3851 fold_init (bin, &fold_data);
3852 g_value_set_boolean (&ret, res);
3854 case GST_ITERATOR_OK:
3855 case GST_ITERATOR_DONE:
3856 res = g_value_get_boolean (&ret);
3857 if (fold_done != NULL && res)
3858 fold_done (bin, &fold_data);
3870 gst_bin_query (GstElement * element, GstQuery * query)
3872 GstBin *bin = GST_BIN_CAST (element);
3874 gboolean default_return = FALSE;
3875 gboolean res = FALSE;
3876 gboolean src_pads_query_result = FALSE;
3877 GstIteratorFoldFunction fold_func;
3878 QueryInitFunction fold_init = NULL;
3879 QueryDoneFunction fold_done = NULL;
3880 QueryFold fold_data;
3882 switch (GST_QUERY_TYPE (query)) {
3883 case GST_QUERY_DURATION:
3885 /* FIXME: implement duration caching in GstBin again */
3890 gst_query_parse_duration (query, &qformat, NULL);
3892 /* find cached duration query */
3893 GST_OBJECT_LOCK (bin);
3894 for (cached = bin->messages; cached; cached = g_list_next (cached)) {
3895 GstMessage *message = (GstMessage *) cached->data;
3897 if (GST_MESSAGE_TYPE (message) == GST_MESSAGE_DURATION_CHANGED &&
3898 GST_MESSAGE_SRC (message) == GST_OBJECT_CAST (bin)) {
3902 gst_message_parse_duration (message, &format, &duration);
3904 /* if cached same format, copy duration in query result */
3905 if (format == qformat) {
3906 GST_DEBUG_OBJECT (bin, "return cached duration %" G_GINT64_FORMAT,
3908 GST_OBJECT_UNLOCK (bin);
3910 gst_query_set_duration (query, qformat, duration);
3916 GST_OBJECT_UNLOCK (bin);
3918 GST_FIXME ("implement duration caching in GstBin again");
3920 /* no cached value found, iterate and collect durations */
3921 fold_func = (GstIteratorFoldFunction) bin_query_duration_fold;
3922 fold_init = bin_query_min_max_init;
3923 fold_done = bin_query_duration_done;
3926 case GST_QUERY_POSITION:
3928 fold_func = (GstIteratorFoldFunction) bin_query_position_fold;
3929 fold_init = bin_query_min_max_init;
3930 fold_done = bin_query_position_done;
3933 case GST_QUERY_LATENCY:
3935 fold_func = (GstIteratorFoldFunction) bin_query_latency_fold;
3936 fold_init = bin_query_min_max_init;
3937 fold_done = bin_query_latency_done;
3938 default_return = TRUE;
3942 fold_func = (GstIteratorFoldFunction) bin_query_generic_fold;
3946 fold_data.query = query;
3948 iter = gst_bin_iterate_sinks (bin);
3949 GST_DEBUG_OBJECT (bin, "Sending query %p (type %s) to sink children",
3950 query, GST_QUERY_TYPE_NAME (query));
3953 fold_init (bin, &fold_data);
3956 bin_iterate_fold (bin, iter, fold_init, fold_done, fold_func, fold_data,
3958 gst_iterator_free (iter);
3961 /* Query the source pads of the element */
3962 iter = gst_element_iterate_src_pads (element);
3963 src_pads_query_result =
3964 bin_iterate_fold (bin, iter, fold_init, fold_done, fold_func,
3965 fold_data, default_return);
3966 gst_iterator_free (iter);
3968 if (src_pads_query_result)
3972 GST_DEBUG_OBJECT (bin, "query %p result %d", query, res);
3978 set_context (const GValue * item, gpointer user_data)
3980 GstElement *element = g_value_get_object (item);
3982 gst_element_set_context (element, user_data);
3986 gst_bin_set_context (GstElement * element, GstContext * context)
3989 GstIterator *children;
3991 g_return_if_fail (GST_IS_BIN (element));
3993 bin = GST_BIN (element);
3995 children = gst_bin_iterate_elements (bin);
3996 while (gst_iterator_foreach (children, set_context,
3997 context) == GST_ITERATOR_RESYNC);
3998 gst_iterator_free (children);
4002 compare_name (const GValue * velement, const gchar * name)
4005 GstElement *element = g_value_get_object (velement);
4007 GST_OBJECT_LOCK (element);
4008 eq = strcmp (GST_ELEMENT_NAME (element), name);
4009 GST_OBJECT_UNLOCK (element);
4015 * gst_bin_get_by_name:
4017 * @name: the element name to search for
4019 * Gets the element with the given name from a bin. This
4020 * function recurses into child bins.
4022 * Returns NULL if no element with the given name is found in the bin.
4024 * MT safe. Caller owns returned reference.
4026 * Returns: (transfer full): the #GstElement with the given name, or NULL
4029 gst_bin_get_by_name (GstBin * bin, const gchar * name)
4031 GstIterator *children;
4032 GValue result = { 0, };
4033 GstElement *element;
4036 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
4038 GST_CAT_INFO (GST_CAT_PARENTAGE, "[%s]: looking up child element %s",
4039 GST_ELEMENT_NAME (bin), name);
4041 children = gst_bin_iterate_recurse (bin);
4042 found = gst_iterator_find_custom (children,
4043 (GCompareFunc) compare_name, &result, (gpointer) name);
4044 gst_iterator_free (children);
4047 element = g_value_dup_object (&result);
4048 g_value_unset (&result);
4057 * gst_bin_get_by_name_recurse_up:
4059 * @name: the element name to search for
4061 * Gets the element with the given name from this bin. If the
4062 * element is not found, a recursion is performed on the parent bin.
4065 * - no element with the given name is found in the bin
4067 * MT safe. Caller owns returned reference.
4069 * Returns: (transfer full): the #GstElement with the given name, or NULL
4072 gst_bin_get_by_name_recurse_up (GstBin * bin, const gchar * name)
4076 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
4077 g_return_val_if_fail (name != NULL, NULL);
4079 result = gst_bin_get_by_name (bin, name);
4084 parent = gst_object_get_parent (GST_OBJECT_CAST (bin));
4086 if (GST_IS_BIN (parent)) {
4087 result = gst_bin_get_by_name_recurse_up (GST_BIN_CAST (parent), name);
4089 gst_object_unref (parent);
4097 compare_interface (const GValue * velement, GValue * interface)
4099 GstElement *element = g_value_get_object (velement);
4100 GType interface_type = (GType) g_value_get_pointer (interface);
4103 if (G_TYPE_CHECK_INSTANCE_TYPE (element, interface_type)) {
4112 * gst_bin_get_by_interface:
4114 * @iface: the #GType of an interface
4116 * Looks for an element inside the bin that implements the given
4117 * interface. If such an element is found, it returns the element.
4118 * You can cast this element to the given interface afterwards. If you want
4119 * all elements that implement the interface, use
4120 * gst_bin_iterate_all_by_interface(). This function recurses into child bins.
4122 * MT safe. Caller owns returned reference.
4124 * Returns: (transfer full): A #GstElement inside the bin implementing the interface
4127 gst_bin_get_by_interface (GstBin * bin, GType iface)
4129 GstIterator *children;
4130 GValue result = { 0, };
4131 GstElement *element;
4133 GValue viface = { 0, };
4135 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
4136 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL);
4138 g_value_init (&viface, G_TYPE_POINTER);
4139 g_value_set_pointer (&viface, (gpointer) iface);
4141 children = gst_bin_iterate_recurse (bin);
4142 found = gst_iterator_find_custom (children, (GCompareFunc) compare_interface,
4144 gst_iterator_free (children);
4147 element = g_value_dup_object (&result);
4148 g_value_unset (&result);
4152 g_value_unset (&viface);
4158 * gst_bin_iterate_all_by_interface:
4160 * @iface: the #GType of an interface
4162 * Looks for all elements inside the bin that implements the given
4163 * interface. You can safely cast all returned elements to the given interface.
4164 * The function recurses inside child bins. The iterator will yield a series
4165 * of #GstElement that should be unreffed after use.
4167 * MT safe. Caller owns returned value.
4169 * Returns: (transfer full): a #GstIterator of #GstElement for all elements
4170 * in the bin implementing the given interface, or NULL
4173 gst_bin_iterate_all_by_interface (GstBin * bin, GType iface)
4175 GstIterator *children;
4176 GstIterator *result;
4177 GValue viface = { 0, };
4179 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
4180 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL);
4182 g_value_init (&viface, G_TYPE_POINTER);
4183 g_value_set_pointer (&viface, (gpointer) iface);
4185 children = gst_bin_iterate_recurse (bin);
4186 result = gst_iterator_filter (children, (GCompareFunc) compare_interface,
4189 g_value_unset (&viface);