gst/gstbin.c: Some documentation updates.
[glsdk/gstreamer0-10.git] / gst / gstbin.c
1 /* GStreamer
2  *
3  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
4  *                    2004 Wim Taymans <wim@fluendo.com>
5  *
6  * gstbin.c: GstBin container object and support code
7  *
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.
12  *
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.
17  *
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., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  *
23  * MT safe.
24  */
25 /**
26  * SECTION:gstbin
27  * @short_description: Base class for elements that contain other elements
28  *
29  * GstBin is the simplest of the container elements, allowing elements to
30  * become children of itself.  Pads from the child elements can be ghosted to
31  * the bin, making the bin itself look transparently like any other element,
32  * allowing for deep nesting of predefined sub-pipelines.
33  *
34  * A new GstBin is created with gst_bin_new(). Use a #GstPipeline instead if you
35  * want to create a toplevel bin because a normal bin doesn't have a bus or
36  * handle clock distribution of its own.
37  * 
38  * After the bin has been created you will typically add elements to it with
39  * gst_bin_add(). You can remove elements with gst_bin_remove().
40  *
41  * An element can be retrieved from a bin with gst_bin_get_by_name(), using the
42  * elements name. gst_bin_get_by_name_recurse_up() is mainly used for internal
43  * purposes and will query the parent bins when the element is not found in the
44  * current bin.
45  * 
46  * An iterator of elements in a bin can be retrieved with 
47  * gst_bin_iterate_elements(). Various other iterators exist to retrieve the
48  * elements in a bin.
49  * 
50  * The "element_added" signal is fired whenever a new element is added to the
51  * bin. Likewise the "element_removed" signal is fired whenever an element is
52  * removed from the bin.
53  *
54  * gst_bin_unref() is used to destroy the bin. 
55  */
57 #include "gst_private.h"
59 #include "gstevent.h"
60 #include "gstbin.h"
61 #include "gstmarshal.h"
62 #include "gstxml.h"
63 #include "gstinfo.h"
64 #include "gsterror.h"
66 #include "gstindex.h"
67 #include "gstindexfactory.h"
68 #include "gstutils.h"
69 #include "gstchildproxy.h"
71 GST_DEBUG_CATEGORY_STATIC (bin_debug);
72 #define GST_CAT_DEFAULT bin_debug
73 #define GST_LOG_BIN_CONTENTS(bin, text) GST_LOG_OBJECT ((bin), \
74         text ": %d elements: %u PLAYING, %u PAUSED, %u READY, %u NULL, own state: %s", \
75         (bin)->numchildren, (guint) (bin)->child_states[3], \
76         (guint) (bin)->child_states[2], (bin)->child_states[1], \
77         (bin)->child_states[0], gst_element_state_get_name (GST_STATE (bin)))
80 static GstElementDetails gst_bin_details = GST_ELEMENT_DETAILS ("Generic bin",
81     "Generic/Bin",
82     "Simple container object",
83     "Erik Walthinsen <omega@cse.ogi.edu>," "Wim Taymans <wim@fluendo.com>");
85 GType _gst_bin_type = 0;
87 static void gst_bin_dispose (GObject * object);
89 static GstStateChangeReturn gst_bin_change_state (GstElement * element,
90     GstStateChange transition);
91 static GstStateChangeReturn gst_bin_get_state (GstElement * element,
92     GstState * state, GstState * pending, GTimeVal * timeout);
94 static gboolean gst_bin_add_func (GstBin * bin, GstElement * element);
95 static gboolean gst_bin_remove_func (GstBin * bin, GstElement * element);
97 #ifndef GST_DISABLE_INDEX
98 static void gst_bin_set_index_func (GstElement * element, GstIndex * index);
99 #endif
100 static GstClock *gst_bin_get_clock_func (GstElement * element);
101 static void gst_bin_set_clock_func (GstElement * element, GstClock * clock);
103 static gboolean gst_bin_send_event (GstElement * element, GstEvent * event);
104 static GstBusSyncReply bin_bus_handler (GstBus * bus,
105     GstMessage * message, GstBin * bin);
106 static gboolean gst_bin_query (GstElement * element, GstQuery * query);
108 #ifndef GST_DISABLE_LOADSAVE
109 static xmlNodePtr gst_bin_save_thyself (GstObject * object, xmlNodePtr parent);
110 static void gst_bin_restore_thyself (GstObject * object, xmlNodePtr self);
111 #endif
113 static gint bin_element_is_sink (GstElement * child, GstBin * bin);
115 /* Bin signals and args */
116 enum
118   ELEMENT_ADDED,
119   ELEMENT_REMOVED,
120   LAST_SIGNAL
121 };
123 enum
125   ARG_0
126       /* FILL ME */
127 };
129 static void gst_bin_base_init (gpointer g_class);
130 static void gst_bin_class_init (GstBinClass * klass);
131 static void gst_bin_init (GstBin * bin);
132 static void gst_bin_child_proxy_init (gpointer g_iface, gpointer iface_data);
134 static GstElementClass *parent_class = NULL;
135 static guint gst_bin_signals[LAST_SIGNAL] = { 0 };
137 /**
138  * gst_bin_get_type:
139  *
140  * Returns: the type of #GstBin
141  */
142 GType
143 gst_bin_get_type (void)
145   if (!_gst_bin_type) {
146     static const GTypeInfo bin_info = {
147       sizeof (GstBinClass),
148       gst_bin_base_init,
149       NULL,
150       (GClassInitFunc) gst_bin_class_init,
151       NULL,
152       NULL,
153       sizeof (GstBin),
154       0,
155       (GInstanceInitFunc) gst_bin_init,
156       NULL
157     };
158     static const GInterfaceInfo child_proxy_info = {
159       gst_bin_child_proxy_init,
160       NULL,
161       NULL
162     };
164     _gst_bin_type =
165         g_type_register_static (GST_TYPE_ELEMENT, "GstBin", &bin_info, 0);
167     g_type_add_interface_static (_gst_bin_type, GST_TYPE_CHILD_PROXY,
168         &child_proxy_info);
170     GST_DEBUG_CATEGORY_INIT (bin_debug, "bin", GST_DEBUG_BOLD,
171         "debugging info for the 'bin' container element");
172   }
173   return _gst_bin_type;
176 static void
177 gst_bin_base_init (gpointer g_class)
179   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
181   gst_element_class_set_details (gstelement_class, &gst_bin_details);
184 static GstObject *
185 gst_bin_child_proxy_get_child_by_index (GstChildProxy * child_proxy,
186     guint index)
188   return g_list_nth_data (GST_BIN (child_proxy)->children, index);
191 guint
192 gst_bin_child_proxy_get_children_count (GstChildProxy * child_proxy)
194   return GST_BIN (child_proxy)->numchildren;
197 static void
198 gst_bin_child_proxy_init (gpointer g_iface, gpointer iface_data)
200   GstChildProxyInterface *iface = g_iface;
202   iface->get_children_count = gst_bin_child_proxy_get_children_count;
203   iface->get_child_by_index = gst_bin_child_proxy_get_child_by_index;
206 static void
207 gst_bin_class_init (GstBinClass * klass)
209   GObjectClass *gobject_class;
210   GstObjectClass *gstobject_class;
211   GstElementClass *gstelement_class;
213   gobject_class = (GObjectClass *) klass;
214   gstobject_class = (GstObjectClass *) klass;
215   gstelement_class = (GstElementClass *) klass;
217   parent_class = g_type_class_peek_parent (klass);
219   /**
220    * GstBin::element-added:
221    * @bin: the object which emitted the signal.
222    * @element: the element that was added to the bin
223    *
224    * Will be emitted if a new element was removed/added to this bin.
225    */
226   gst_bin_signals[ELEMENT_ADDED] =
227       g_signal_new ("element-added", G_TYPE_FROM_CLASS (klass),
228       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstBinClass, element_added), NULL,
229       NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_ELEMENT);
230   /**
231    * GstBin::element-removed:
232    * @bin: the object which emitted the signal.
233    * @element: the element that was removed from the bin
234    *
235    * Will be emitted if an element was removed from this bin.
236    */
237   gst_bin_signals[ELEMENT_REMOVED] =
238       g_signal_new ("element-removed", G_TYPE_FROM_CLASS (klass),
239       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstBinClass, element_removed), NULL,
240       NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_ELEMENT);
242   gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_bin_dispose);
244 #ifndef GST_DISABLE_LOADSAVE
245   gstobject_class->save_thyself = GST_DEBUG_FUNCPTR (gst_bin_save_thyself);
246   gstobject_class->restore_thyself =
247       GST_DEBUG_FUNCPTR (gst_bin_restore_thyself);
248 #endif
250   gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_bin_change_state);
251   gstelement_class->get_state = GST_DEBUG_FUNCPTR (gst_bin_get_state);
252 #ifndef GST_DISABLE_INDEX
253   gstelement_class->set_index = GST_DEBUG_FUNCPTR (gst_bin_set_index_func);
254 #endif
255   gstelement_class->get_clock = GST_DEBUG_FUNCPTR (gst_bin_get_clock_func);
256   gstelement_class->set_clock = GST_DEBUG_FUNCPTR (gst_bin_set_clock_func);
258   gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_bin_send_event);
259   gstelement_class->query = GST_DEBUG_FUNCPTR (gst_bin_query);
261   klass->add_element = GST_DEBUG_FUNCPTR (gst_bin_add_func);
262   klass->remove_element = GST_DEBUG_FUNCPTR (gst_bin_remove_func);
265 static void
266 gst_bin_init (GstBin * bin)
268   GstBus *bus;
270   bin->numchildren = 0;
271   bin->children = NULL;
272   bin->children_cookie = 0;
273   bin->eosed = NULL;
275   /* Set up a bus for listening to child elements,
276    * and one for sending messages up the hierarchy */
277   bus = g_object_new (gst_bus_get_type (), NULL);
278   bin->child_bus = bus;
279   gst_bus_set_sync_handler (bus, (GstBusSyncHandler) bin_bus_handler, bin);
281   bus = g_object_new (gst_bus_get_type (), NULL);
282   gst_element_set_bus (GST_ELEMENT (bin), bus);
283   /* set_bus refs the bus via gst_object_replace, we drop our ref */
284   gst_object_unref (bus);
287 /**
288  * gst_bin_new:
289  * @name: name of new bin
290  *
291  * Create a new bin with given name.
292  *
293  * Returns: new bin
294  */
295 GstElement *
296 gst_bin_new (const gchar * name)
298   return gst_element_factory_make ("bin", name);
301 /* set the index on all elements in this bin
302  *
303  * MT safe
304  */
305 #ifndef GST_DISABLE_INDEX
306 static void
307 gst_bin_set_index_func (GstElement * element, GstIndex * index)
309   GstBin *bin;
310   GList *children;
312   bin = GST_BIN (element);
314   GST_LOCK (bin);
315   for (children = bin->children; children; children = g_list_next (children)) {
316     GstElement *child = GST_ELEMENT (children->data);
318     gst_element_set_index (child, index);
319   }
320   GST_UNLOCK (bin);
322 #endif
324 /* set the clock on all elements in this bin
325  *
326  * MT safe
327  */
328 static void
329 gst_bin_set_clock_func (GstElement * element, GstClock * clock)
331   GList *children;
332   GstBin *bin;
334   bin = GST_BIN (element);
336   GST_LOCK (bin);
337   for (children = bin->children; children; children = g_list_next (children)) {
338     GstElement *child = GST_ELEMENT (children->data);
340     gst_element_set_clock (child, clock);
341   }
342   GST_UNLOCK (bin);
345 /* get the clock for this bin by asking all of the children in this bin
346  *
347  * MT safe
348  */
349 static GstClock *
350 gst_bin_get_clock_func (GstElement * element)
352   GstClock *result = NULL;
353   GstBin *bin;
354   GList *children;
356   bin = GST_BIN (element);
358   GST_LOCK (bin);
359   for (children = bin->children; children; children = g_list_next (children)) {
360     GstElement *child = GST_ELEMENT (children->data);
362     result = gst_element_get_clock (child);
363     if (result)
364       break;
365   }
366   GST_UNLOCK (bin);
368   return result;
371 static gboolean
372 is_eos (GstBin * bin)
374   GstIterator *sinks;
375   gboolean result = TRUE;
376   gboolean done = FALSE;
378   sinks = gst_bin_iterate_sinks (bin);
379   while (!done) {
380     gpointer data;
382     switch (gst_iterator_next (sinks, &data)) {
383       case GST_ITERATOR_OK:
384       {
385         GstElement *element = GST_ELEMENT (data);
386         GList *eosed;
387         gchar *name;
389         name = gst_element_get_name (element);
390         eosed = g_list_find (bin->eosed, element);
391         if (!eosed) {
392           GST_DEBUG ("element %s did not post EOS yet", name);
393           result = FALSE;
394           done = TRUE;
395         } else {
396           GST_DEBUG ("element %s posted EOS", name);
397         }
398         g_free (name);
399         gst_object_unref (element);
400         break;
401       }
402       case GST_ITERATOR_RESYNC:
403         result = TRUE;
404         gst_iterator_resync (sinks);
405         break;
406       case GST_ITERATOR_DONE:
407         done = TRUE;
408         break;
409       default:
410         g_assert_not_reached ();
411         break;
412     }
413   }
414   gst_iterator_free (sinks);
415   return result;
418 static void
419 unlink_pads (GstPad * pad)
421   GstPad *peer;
423   if ((peer = gst_pad_get_peer (pad))) {
424     if (gst_pad_get_direction (pad) == GST_PAD_SRC)
425       gst_pad_unlink (pad, peer);
426     else
427       gst_pad_unlink (peer, pad);
428     gst_object_unref (peer);
429   }
430   gst_object_unref (pad);
433 /* add an element to this bin
434  *
435  * MT safe
436  */
437 static gboolean
438 gst_bin_add_func (GstBin * bin, GstElement * element)
440   gchar *elem_name;
441   GstIterator *it;
443   /* we obviously can't add ourself to ourself */
444   if (G_UNLIKELY (GST_ELEMENT_CAST (element) == GST_ELEMENT_CAST (bin)))
445     goto adding_itself;
447   /* get the element name to make sure it is unique in this bin. */
448   GST_LOCK (element);
449   elem_name = g_strdup (GST_ELEMENT_NAME (element));
450   GST_UNLOCK (element);
452   GST_LOCK (bin);
454   /* then check to see if the element's name is already taken in the bin,
455    * we can safely take the lock here. This check is probably bogus because
456    * you can safely change the element name after this check and before setting
457    * the object parent. The window is very small though... */
458   if (G_UNLIKELY (!gst_object_check_uniqueness (bin->children, elem_name)))
459     goto duplicate_name;
461   /* set the element's parent and add the element to the bin's list of children */
462   if (G_UNLIKELY (!gst_object_set_parent (GST_OBJECT_CAST (element),
463               GST_OBJECT_CAST (bin))))
464     goto had_parent;
466   /* if we add a sink we become a sink */
467   if (GST_FLAG_IS_SET (element, GST_ELEMENT_IS_SINK)) {
468     GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "element \"%s\" was sink",
469         elem_name);
470     GST_FLAG_SET (bin, GST_ELEMENT_IS_SINK);
471   }
473   bin->children = g_list_prepend (bin->children, element);
474   bin->numchildren++;
475   bin->children_cookie++;
477   /* distribute the bus */
478   gst_element_set_bus (element, bin->child_bus);
480   /* propagate the current base time and clock */
481   gst_element_set_base_time (element, GST_ELEMENT (bin)->base_time);
482   gst_element_set_clock (element, GST_ELEMENT_CLOCK (bin));
484   GST_UNLOCK (bin);
486   /* unlink all linked pads */
487   it = gst_element_iterate_pads (element);
488   gst_iterator_foreach (it, (GFunc) unlink_pads, element);
489   gst_iterator_free (it);
491   GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "added element \"%s\"",
492       elem_name);
493   g_free (elem_name);
495   g_signal_emit (G_OBJECT (bin), gst_bin_signals[ELEMENT_ADDED], 0, element);
497   return TRUE;
499   /* ERROR handling here */
500 adding_itself:
501   {
502     GST_LOCK (bin);
503     g_warning ("Cannot add bin %s to itself", GST_ELEMENT_NAME (bin));
504     GST_UNLOCK (bin);
505     return FALSE;
506   }
507 duplicate_name:
508   {
509     g_warning ("Name %s is not unique in bin %s, not adding",
510         elem_name, GST_ELEMENT_NAME (bin));
511     GST_UNLOCK (bin);
512     g_free (elem_name);
513     return FALSE;
514   }
515 had_parent:
516   {
517     g_warning ("Element %s already has parent", elem_name);
518     GST_UNLOCK (bin);
519     g_free (elem_name);
520     return FALSE;
521   }
525 /**
526  * gst_bin_add:
527  * @bin: #GstBin to add element to
528  * @element: #GstElement to add to bin
529  *
530  * Adds the given element to the bin.  Sets the element's parent, and thus
531  * takes ownership of the element. An element can only be added to one bin.
532  *
533  * If the element's pads are linked to other pads, the pads will be unlinked
534  * before the element is added to the bin.
535  *
536  * MT safe.
537  *
538  * Returns: TRUE if the element could be added, FALSE on wrong parameters or
539  * the bin does not want to accept the element.
540  */
541 gboolean
542 gst_bin_add (GstBin * bin, GstElement * element)
544   GstBinClass *bclass;
545   gboolean result;
547   g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
548   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
550   bclass = GST_BIN_GET_CLASS (bin);
552   if (G_UNLIKELY (bclass->add_element == NULL))
553     goto no_function;
555   GST_CAT_DEBUG (GST_CAT_PARENTAGE, "adding element %s to bin %s",
556       GST_ELEMENT_NAME (element), GST_ELEMENT_NAME (bin));
558   result = bclass->add_element (bin, element);
560   return result;
562   /* ERROR handling */
563 no_function:
564   {
565     g_warning ("adding elements to bin %s is not supported",
566         GST_ELEMENT_NAME (bin));
567     return FALSE;
568   }
571 /* remove an element from the bin
572  *
573  * MT safe
574  */
575 static gboolean
576 gst_bin_remove_func (GstBin * bin, GstElement * element)
578   gchar *elem_name;
579   GstIterator *it;
581   GST_LOCK (element);
582   /* Check if the element is already being removed and immediately
583    * return */
584   if (G_UNLIKELY (GST_FLAG_IS_SET (element, GST_ELEMENT_UNPARENTING)))
585     goto already_removing;
587   GST_FLAG_SET (element, GST_ELEMENT_UNPARENTING);
588   /* grab element name so we can print it */
589   elem_name = g_strdup (GST_ELEMENT_NAME (element));
590   GST_UNLOCK (element);
592   /* unlink all linked pads */
593   it = gst_element_iterate_pads (element);
594   gst_iterator_foreach (it, (GFunc) unlink_pads, element);
595   gst_iterator_free (it);
597   GST_LOCK (bin);
598   /* the element must be in the bin's list of children */
599   if (G_UNLIKELY (g_list_find (bin->children, element) == NULL))
600     goto not_in_bin;
602   /* now remove the element from the list of elements */
603   bin->children = g_list_remove (bin->children, element);
604   bin->numchildren--;
605   bin->children_cookie++;
607   /* check if we removed a sink */
608   if (GST_FLAG_IS_SET (element, GST_ELEMENT_IS_SINK)) {
609     GList *other_sink;
611     /* check if we removed the last sink */
612     other_sink = g_list_find_custom (bin->children,
613         bin, (GCompareFunc) bin_element_is_sink);
614     if (!other_sink) {
615       /* yups, we're not a sink anymore */
616       GST_FLAG_UNSET (bin, GST_ELEMENT_IS_SINK);
617     }
618   }
619   GST_UNLOCK (bin);
621   GST_CAT_INFO_OBJECT (GST_CAT_PARENTAGE, bin, "removed child \"%s\"",
622       elem_name);
623   g_free (elem_name);
625   gst_element_set_bus (element, NULL);
627   /* unlock any waiters for the state change. It is possible that
628    * we are waiting for an ASYNC state change on this element. The
629    * element cannot be added to another bin yet as it is not yet
630    * unparented. */
631   GST_STATE_LOCK (element);
632   GST_STATE_BROADCAST (element);
633   GST_STATE_UNLOCK (element);
635   /* we ref here because after the _unparent() the element can be disposed
636    * and we still need it to reset the UNPARENTING flag and fire a signal. */
637   gst_object_ref (element);
638   gst_object_unparent (GST_OBJECT_CAST (element));
640   GST_LOCK (element);
641   GST_FLAG_UNSET (element, GST_ELEMENT_UNPARENTING);
642   GST_UNLOCK (element);
644   g_signal_emit (G_OBJECT (bin), gst_bin_signals[ELEMENT_REMOVED], 0, element);
646   /* element is really out of our control now */
647   gst_object_unref (element);
649   return TRUE;
651   /* ERROR handling */
652 not_in_bin:
653   {
654     g_warning ("Element %s is not in bin %s", elem_name,
655         GST_ELEMENT_NAME (bin));
656     GST_UNLOCK (bin);
657     g_free (elem_name);
658     return FALSE;
659   }
660 already_removing:
661   {
662     GST_UNLOCK (element);
663     return FALSE;
664   }
667 /**
668  * gst_bin_remove:
669  * @bin: #GstBin to remove element from
670  * @element: #GstElement to remove
671  *
672  * Remove the element from its associated bin, unparenting it as well.
673  * Unparenting the element means that the element will be dereferenced,
674  * so if the bin holds the only reference to the element, the element
675  * will be freed in the process of removing it from the bin.  If you
676  * want the element to still exist after removing, you need to call
677  * gst_object_ref() before removing it from the bin.
678  *
679  * If the element's pads are linked to other pads, the pads will be unlinked
680  * before the element is removed from the bin.
681  *
682  * MT safe.
683  *
684  * Returns: TRUE if the element could be removed, FALSE on wrong parameters or
685  * the bin does not want to remove the element.
686  */
687 gboolean
688 gst_bin_remove (GstBin * bin, GstElement * element)
690   GstBinClass *bclass;
691   gboolean result;
693   g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
694   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
696   bclass = GST_BIN_GET_CLASS (bin);
698   if (G_UNLIKELY (bclass->remove_element == NULL))
699     goto no_function;
701   GST_CAT_DEBUG (GST_CAT_PARENTAGE, "removing element %s from bin %s",
702       GST_ELEMENT_NAME (element), GST_ELEMENT_NAME (bin));
704   result = bclass->remove_element (bin, element);
706   return result;
708   /* ERROR handling */
709 no_function:
710   {
711     g_warning ("removing elements from bin %s is not supported",
712         GST_ELEMENT_NAME (bin));
713     return FALSE;
714   }
717 static GstIteratorItem
718 iterate_child (GstIterator * it, GstElement * child)
720   gst_object_ref (child);
721   return GST_ITERATOR_ITEM_PASS;
724 /**
725  * gst_bin_iterate_elements:
726  * @bin: #Gstbin to iterate the elements of
727  *
728  * Get an iterator for the elements in this bin.
729  * Each element will have its refcount increased, so unref
730  * after use.
731  *
732  * MT safe.
733  *
734  * Returns: a #GstIterator of #GstElements. gst_iterator_free after
735  * use. returns NULL when passing bad parameters.
736  */
737 GstIterator *
738 gst_bin_iterate_elements (GstBin * bin)
740   GstIterator *result;
742   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
744   GST_LOCK (bin);
745   /* add ref because the iterator refs the bin. When the iterator
746    * is freed it will unref the bin again using the provided dispose
747    * function. */
748   gst_object_ref (bin);
749   result = gst_iterator_new_list (GST_GET_LOCK (bin),
750       &bin->children_cookie,
751       &bin->children,
752       bin,
753       (GstIteratorItemFunction) iterate_child,
754       (GstIteratorDisposeFunction) gst_object_unref);
755   GST_UNLOCK (bin);
757   return result;
760 static GstIteratorItem
761 iterate_child_recurse (GstIterator * it, GstElement * child)
763   gst_object_ref (child);
764   if (GST_IS_BIN (child)) {
765     GstIterator *other = gst_bin_iterate_recurse (GST_BIN (child));
767     gst_iterator_push (it, other);
768   }
769   return GST_ITERATOR_ITEM_PASS;
772 /**
773  * gst_bin_iterate_recurse:
774  * @bin: #Gstbin to iterate the elements of
775  *
776  * Get an iterator for the elements in this bin.
777  * Each element will have its refcount increased, so unref
778  * after use. This iterator recurses into GstBin children.
779  *
780  * MT safe.
781  *
782  * Returns: a #GstIterator of #GstElements. gst_iterator_free after
783  * use. returns NULL when passing bad parameters.
784  */
785 GstIterator *
786 gst_bin_iterate_recurse (GstBin * bin)
788   GstIterator *result;
790   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
792   GST_LOCK (bin);
793   /* add ref because the iterator refs the bin. When the iterator
794    * is freed it will unref the bin again using the provided dispose
795    * function. */
796   gst_object_ref (bin);
797   result = gst_iterator_new_list (GST_GET_LOCK (bin),
798       &bin->children_cookie,
799       &bin->children,
800       bin,
801       (GstIteratorItemFunction) iterate_child_recurse,
802       (GstIteratorDisposeFunction) gst_object_unref);
803   GST_UNLOCK (bin);
805   return result;
808 /* returns 0 when TRUE because this is a GCompareFunc */
809 /* MT safe */
810 static gint
811 bin_element_is_sink (GstElement * child, GstBin * bin)
813   gboolean is_sink;
815   /* we lock the child here for the remainder of the function to
816    * get its name safely. */
817   GST_LOCK (child);
818   is_sink = GST_FLAG_IS_SET (child, GST_ELEMENT_IS_SINK);
820   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
821       "child %s %s sink", GST_OBJECT_NAME (child), is_sink ? "is" : "is not");
823   GST_UNLOCK (child);
824   return is_sink ? 0 : 1;
827 static gint
828 sink_iterator_filter (GstElement * child, GstBin * bin)
830   if (bin_element_is_sink (child, bin) == 0) {
831     /* returns 0 because this is a GCompareFunc */
832     return 0;
833   } else {
834     /* child carries a ref from gst_bin_iterate_elements -- drop if not passing
835        through */
836     gst_object_unref ((GstObject *) child);
837     return 1;
838   }
841 /**
842  * gst_bin_iterate_sinks:
843  * @bin: #Gstbin to iterate on
844  *
845  * Get an iterator for the sink elements in this bin.
846  * Each element will have its refcount increased, so unref
847  * after use.
848  *
849  * The sink elements are those without any linked srcpads.
850  *
851  * MT safe.
852  *
853  * Returns: a #GstIterator of #GstElements. gst_iterator_free after use.
854  */
855 GstIterator *
856 gst_bin_iterate_sinks (GstBin * bin)
858   GstIterator *children;
859   GstIterator *result;
861   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
863   children = gst_bin_iterate_elements (bin);
864   result = gst_iterator_filter (children,
865       (GCompareFunc) sink_iterator_filter, bin);
867   return result;
870 /* 2 phases:
871  *  1) check state of all children with 0 timeout to find ERROR and
872  *     NO_PREROLL elements. return if found.
873  *  2) perform full blocking wait with requested timeout.
874  *
875  * 2) cannot be performed when 1) returns results as the sinks might
876  *    not be able to complete the state change making 2) block forever.
877  *
878  * MT safe
879  */
880 static GstStateChangeReturn
881 gst_bin_get_state (GstElement * element, GstState * state,
882     GstState * pending, GTimeVal * timeout)
884   GstBin *bin = GST_BIN (element);
885   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
886   GList *children;
887   guint32 children_cookie;
888   gboolean have_no_preroll;
890   GST_CAT_INFO_OBJECT (GST_CAT_STATES, element, "getting state");
892   /* lock bin, no element can be added or removed between going into
893    * the quick scan and the blocking wait. */
894   GST_LOCK (bin);
896 restart:
897   have_no_preroll = FALSE;
899   /* first we need to poll with a non zero timeout to make sure we don't block
900    * on the sinks when we have NO_PREROLL elements. This is why we do
901    * a quick check if there are still NO_PREROLL elements. We also
902    * catch the error elements this way. */
903   {
904     GTimeVal tv;
905     gboolean have_async = FALSE;
907     GST_CAT_INFO_OBJECT (GST_CAT_STATES, element, "checking for NO_PREROLL");
908     /* use 0 timeout so we don't block on the sinks */
909     GST_TIME_TO_TIMEVAL (0, tv);
910     children = bin->children;
911     children_cookie = bin->children_cookie;
912     while (children) {
913       GstElement *child = GST_ELEMENT_CAST (children->data);
915       gst_object_ref (child);
916       /* now we release the lock to enter a non blocking wait. We
917        * release the lock anyway since we can. */
918       GST_UNLOCK (bin);
920       ret = gst_element_get_state (child, NULL, NULL, &tv);
922       gst_object_unref (child);
924       /* now grab the lock to iterate to the next child */
925       GST_LOCK (bin);
926       if (G_UNLIKELY (children_cookie != bin->children_cookie)) {
927         /* child added/removed during state change, restart. We need
928          * to restart with the quick check as a no-preroll element could
929          * have been added here and we don't want to block on sinks then.*/
930         goto restart;
931       }
933       switch (ret) {
934           /* report FAILURE  immediatly */
935         case GST_STATE_CHANGE_FAILURE:
936           goto done;
937         case GST_STATE_CHANGE_NO_PREROLL:
938           /* we have to continue scanning as there might be
939            * ERRORS too */
940           have_no_preroll = TRUE;
941           break;
942         case GST_STATE_CHANGE_ASYNC:
943           have_async = TRUE;
944           break;
945         default:
946           break;
947       }
948       children = g_list_next (children);
949     }
950     /* if we get here, we have no FAILURES, check for any NO_PREROLL
951      * elements then. */
952     if (have_no_preroll) {
953       ret = GST_STATE_CHANGE_NO_PREROLL;
954       goto done;
955     }
957     /* if we get here, no NO_PREROLL elements are in the pipeline */
958     GST_CAT_INFO_OBJECT (GST_CAT_STATES, element, "no NO_PREROLL elements");
960     /* if no ASYNC elements exist we don't even have to poll with a
961      * timeout again */
962     if (!have_async) {
963       ret = GST_STATE_CHANGE_SUCCESS;
964       goto done;
965     }
966   }
968   /* next we poll all children for their state to see if one of them
969    * is still busy with its state change. We did not release the bin lock
970    * yet so the elements are the same as the ones from the quick scan. */
971   children = bin->children;
972   children_cookie = bin->children_cookie;
973   while (children) {
974     GstElement *child = GST_ELEMENT_CAST (children->data);
976     gst_object_ref (child);
977     /* now we release the lock to enter the potentialy blocking wait */
978     GST_UNLOCK (bin);
980     /* ret is ASYNC if some child is still performing the state change
981      * ater the timeout. */
982     ret = gst_element_get_state (child, NULL, NULL, timeout);
984     gst_object_unref (child);
986     /* now grab the lock to iterate to the next child */
987     GST_LOCK (bin);
988     if (G_UNLIKELY (children_cookie != bin->children_cookie)) {
989       /* child added/removed during state change, restart. We need
990        * to restart with the quick check as a no-preroll element could
991        * have been added here and we don't want to block on sinks then.*/
992       goto restart;
993     }
995     switch (ret) {
996       case GST_STATE_CHANGE_SUCCESS:
997         break;
998       case GST_STATE_CHANGE_FAILURE:
999       case GST_STATE_CHANGE_NO_PREROLL:
1000         /* report FAILURE and NO_PREROLL immediatly */
1001         goto done;
1002       case GST_STATE_CHANGE_ASYNC:
1003         goto done;
1004       default:
1005         g_assert_not_reached ();
1006     }
1007     children = g_list_next (children);
1008   }
1009   /* if we got here, all elements can do preroll */
1010   have_no_preroll = FALSE;
1012 done:
1013   GST_UNLOCK (bin);
1015   /* now we can take the state lock, it is possible that new elements
1016    * are added now and we still report the old state. No problem though as
1017    * the return is still consistent, the effect is as if the element was
1018    * added after this function completed. */
1019   GST_STATE_LOCK (bin);
1020   switch (ret) {
1021     case GST_STATE_CHANGE_SUCCESS:
1022       /* we can commit the state */
1023       gst_element_commit_state (element);
1024       break;
1025     case GST_STATE_CHANGE_FAILURE:
1026       /* some element failed, abort the state change */
1027       gst_element_abort_state (element);
1028       break;
1029     default:
1030       /* other cases are just passed along */
1031       break;
1032   }
1034   /* and report the state if needed */
1035   if (state)
1036     *state = GST_STATE (element);
1037   if (pending)
1038     *pending = GST_STATE_PENDING (element);
1040   GST_STATE_NO_PREROLL (element) = have_no_preroll;
1042   GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
1043       "state current: %s, pending: %s, error: %d, no_preroll: %d, result: %d",
1044       gst_element_state_get_name (GST_STATE (element)),
1045       gst_element_state_get_name (GST_STATE_PENDING (element)),
1046       GST_STATE_ERROR (element), GST_STATE_NO_PREROLL (element), ret);
1048   GST_STATE_UNLOCK (bin);
1050   return ret;
1053 /***********************************************
1054  * Topologically sorted iterator 
1055  * see http://en.wikipedia.org/wiki/Topological_sorting
1056  *
1057  * For each element in the graph, an entry is kept in a HashTable
1058  * with its number of srcpad connections (degree). 
1059  * We then change state of all elements without dependencies 
1060  * (degree 0) and decrement the degree of all elements connected
1061  * on the sinkpads. When an element reaches degree 0, its state is
1062  * changed next.
1063  * When all elements are handled the algorithm stops.
1064  */
1065 typedef struct _GstBinSortIterator
1067   GstIterator it;
1068   GQueue *queue;                /* elements queued for state change */
1069   GstBin *bin;                  /* bin we iterate */
1070   gint mode;                    /* adding or removing dependency */
1071   GstElement *best;             /* next element with least dependencies */
1072   gint best_deg;                /* best degree */
1073   GHashTable *hash;             /* has table with element dependencies */
1074 } GstBinSortIterator;
1076 /* we add and subtract 1 to make sure we don't confuse NULL and 0 */
1077 #define HASH_SET_DEGREE(bit, elem, deg) \
1078     g_hash_table_replace (bit->hash, elem, GINT_TO_POINTER(deg+1))
1079 #define HASH_GET_DEGREE(bit, elem) \
1080     (GPOINTER_TO_INT(g_hash_table_lookup (bit->hash, elem))-1)
1082 /* add element to queue of next elements in the iterator.
1083  * We push at the tail to give higher priority elements a
1084  * chance first */
1085 static void
1086 add_to_queue (GstBinSortIterator * bit, GstElement * element)
1088   GST_DEBUG ("%s add to queue", GST_ELEMENT_NAME (element));
1089   gst_object_ref (element);
1090   g_queue_push_tail (bit->queue, element);
1091   HASH_SET_DEGREE (bit, element, -1);
1094 /* clear the queue, unref all objects as we took a ref when
1095  * we added them to the queue */
1096 static void
1097 clear_queue (GQueue * queue)
1099   gpointer p;
1101   while ((p = g_queue_pop_head (queue)))
1102     gst_object_unref (p);
1105 /* set all outdegrees to 0. Elements marked as a sink are
1106  * added to the queue immediatly. */
1107 static void
1108 reset_outdegree (GstElement * element, GstBinSortIterator * bit)
1110   /* sinks are added right away */
1111   if (GST_FLAG_IS_SET (element, GST_ELEMENT_IS_SINK)) {
1112     add_to_queue (bit, element);
1113   } else {
1114     /* others are marked with 0 and handled when sinks are done */
1115     HASH_SET_DEGREE (bit, element, 0);
1116   }
1119 /* adjust the outdegree of all elements connected to the given
1120  * element. If an outdegree of an element drops to 0, it is
1121  * added to the queue of elements to schedule next.
1122  *
1123  * We have to make sure not to cross the bin boundary this element
1124  * belongs to.
1125  */
1126 static void
1127 update_outdegree (GstElement * element, GstBinSortIterator * bit)
1129   gboolean linked = FALSE;
1131   GST_LOCK (element);
1132   /* don't touch outdegree is element has no sourcepads */
1133   if (element->numsinkpads != 0) {
1134     /* loop over all sinkpads, decrement outdegree for all connected
1135      * elements in this bin */
1136     GList *pads;
1138     for (pads = element->sinkpads; pads; pads = g_list_next (pads)) {
1139       GstPad *peer;
1141       if ((peer = gst_pad_get_peer (GST_PAD_CAST (pads->data)))) {
1142         GstElement *peer_element;
1144         if ((peer_element = gst_pad_get_parent_element (peer))) {
1145           GST_LOCK (peer_element);
1146           if (GST_OBJECT_CAST (peer_element)->parent ==
1147               GST_OBJECT_CAST (bit->bin)) {
1148             gint old_deg, new_deg;
1150             old_deg = HASH_GET_DEGREE (bit, peer_element);
1151             new_deg = old_deg + bit->mode;
1153             GST_DEBUG ("change element %s, degree %d->%d, linked to %s",
1154                 GST_ELEMENT_NAME (peer_element),
1155                 old_deg, new_deg, GST_ELEMENT_NAME (element));
1157             /* update outdegree */
1158             if (new_deg == 0) {
1159               /* outdegree hit 0, add to queue */
1160               add_to_queue (bit, peer_element);
1161             } else {
1162               HASH_SET_DEGREE (bit, peer_element, new_deg);
1163             }
1164             linked = TRUE;
1165           }
1166           GST_UNLOCK (peer_element);
1167           gst_object_unref (peer_element);
1168         }
1169         gst_object_unref (peer);
1170       }
1171     }
1172   }
1173   if (!linked) {
1174     GST_DEBUG ("element %s not linked to anything", GST_ELEMENT_NAME (element));
1175   }
1176   GST_UNLOCK (element);
1179 /* find the next best element not handled yet. This is the one
1180  * with the lowest non-negative outdegree */
1181 static void
1182 find_element (GstElement * element, GstBinSortIterator * bit)
1184   gint outdegree;
1186   /* element is already handled */
1187   if ((outdegree = HASH_GET_DEGREE (bit, element)) < 0)
1188     return;
1190   /* first element or element with smaller outdegree */
1191   if (bit->best == NULL || bit->best_deg > outdegree) {
1192     bit->best = element;
1193     bit->best_deg = outdegree;
1194   }
1197 /* get next element in iterator. the returned element has the
1198  * refcount increased */
1199 static GstIteratorResult
1200 gst_bin_sort_iterator_next (GstBinSortIterator * bit, gpointer * result)
1202   /* empty queue, we have to find a next best element */
1203   if (g_queue_is_empty (bit->queue)) {
1204     bit->best = NULL;
1205     bit->best_deg = G_MAXINT;
1206     g_list_foreach (bit->bin->children, (GFunc) find_element, bit);
1207     if (bit->best) {
1208       if (bit->best_deg != 0) {
1209         /* we don't fail on this one yet */
1210         g_warning ("loop detected in the graph !!");
1211       }
1212       /* best unhandled element, schedule as next element */
1213       GST_DEBUG ("queue empty, next best: %s", GST_ELEMENT_NAME (bit->best));
1214       gst_object_ref (bit->best);
1215       HASH_SET_DEGREE (bit, bit->best, -1);
1216       *result = bit->best;
1217     } else {
1218       GST_DEBUG ("queue empty, elements exhausted");
1219       /* no more unhandled elements, we are done */
1220       return GST_ITERATOR_DONE;
1221     }
1222   } else {
1223     /* everything added to the queue got reffed */
1224     *result = g_queue_pop_head (bit->queue);
1225   }
1227   GST_DEBUG ("queue head gives %s", GST_ELEMENT_NAME (*result));
1228   /* update outdegrees of linked elements */
1229   update_outdegree (GST_ELEMENT_CAST (*result), bit);
1231   return GST_ITERATOR_OK;
1234 /* clear queues, recalculate the outdegrees and restart. */
1235 static void
1236 gst_bin_sort_iterator_resync (GstBinSortIterator * bit)
1238   clear_queue (bit->queue);
1239   /* reset outdegrees */
1240   g_list_foreach (bit->bin->children, (GFunc) reset_outdegree, bit);
1241   /* calc outdegrees, incrementing */
1242   bit->mode = 1;
1243   g_list_foreach (bit->bin->children, (GFunc) update_outdegree, bit);
1244   /* for the rest of the function we decrement the outdegrees */
1245   bit->mode = -1;
1248 /* clear queues, unref bin and free iterator. */
1249 static void
1250 gst_bin_sort_iterator_free (GstBinSortIterator * bit)
1252   clear_queue (bit->queue);
1253   g_queue_free (bit->queue);
1254   g_hash_table_destroy (bit->hash);
1255   gst_object_unref (bit->bin);
1256   g_free (bit);
1259 /**
1260  * gst_bin_iterate_sorted:
1261  * @bin: #Gstbin to iterate on
1262  *
1263  * Get an iterator for the elements in this bin in topologically
1264  * sorted order. This means that the elements are returned from
1265  * the most downstream elements (sinks) to the sources.
1266  *
1267  * This function is used internally to perform the state changes 
1268  * of the bin elements.
1269  *
1270  * Each element will have its refcount increased, so unref
1271  * after use.
1272  *
1273  * MT safe. 
1274  *
1275  * Returns: a #GstIterator of #GstElements. gst_iterator_free after use.
1276  */
1277 GstIterator *
1278 gst_bin_iterate_sorted (GstBin * bin)
1280   GstBinSortIterator *result;
1282   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1284   GST_LOCK (bin);
1285   gst_object_ref (bin);
1286   /* we don't need a NextFunction because we ref the items in the _next
1287    * method already */
1288   result = (GstBinSortIterator *)
1289       gst_iterator_new (sizeof (GstBinSortIterator),
1290       GST_GET_LOCK (bin),
1291       &bin->children_cookie,
1292       (GstIteratorNextFunction) gst_bin_sort_iterator_next,
1293       (GstIteratorItemFunction) NULL,
1294       (GstIteratorResyncFunction) gst_bin_sort_iterator_resync,
1295       (GstIteratorFreeFunction) gst_bin_sort_iterator_free);
1296   result->queue = g_queue_new ();
1297   result->hash = g_hash_table_new (NULL, NULL);
1298   result->bin = bin;
1299   gst_bin_sort_iterator_resync (result);
1300   GST_UNLOCK (bin);
1302   return (GstIterator *) result;
1305 static GstStateChangeReturn
1306 gst_bin_element_set_state (GstBin * bin, GstElement * element, GstState pending)
1308   GstStateChangeReturn ret;
1309   gboolean locked;
1311   /* peel off the locked flag */
1312   GST_LOCK (element);
1313   locked = GST_FLAG_IS_SET (element, GST_ELEMENT_LOCKED_STATE);
1314   GST_UNLOCK (element);
1316   /* skip locked elements */
1317   if (G_UNLIKELY (locked)) {
1318     ret = GST_STATE_CHANGE_SUCCESS;
1319     goto done;
1320   }
1322   /* change state */
1323   ret = gst_element_set_state (element, pending);
1325 done:
1326   return ret;
1329 static GstStateChangeReturn
1330 gst_bin_change_state (GstElement * element, GstStateChange transition)
1332   GstBin *bin;
1333   GstStateChangeReturn ret;
1334   GstState old_state, pending;
1335   gboolean have_async;
1336   gboolean have_no_preroll;
1337   GstClockTime base_time;
1338   GstIterator *it;
1339   gboolean done;
1341   /* we don't need to take the STATE_LOCK, it is already taken */
1342   old_state = GST_STATE (element);
1343   pending = GST_STATE_PENDING (element);
1345   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
1346       "changing state of children from %s to %s",
1347       gst_element_state_get_name (old_state),
1348       gst_element_state_get_name (pending));
1350   if (pending == GST_STATE_VOID_PENDING)
1351     return GST_STATE_CHANGE_SUCCESS;
1353   bin = GST_BIN_CAST (element);
1355   /* Clear eosed element list on READY-> PAUSED */
1356   if (transition == GST_STATE_CHANGE_READY_TO_PAUSED) {
1357     g_list_free (bin->eosed);
1358     bin->eosed = NULL;
1359   }
1361   /* iterate in state change order */
1362   it = gst_bin_iterate_sorted (bin);
1364 restart:
1365   /* take base time */
1366   base_time = element->base_time;
1368   have_async = FALSE;
1369   have_no_preroll = FALSE;
1371   done = FALSE;
1372   while (!done) {
1373     gpointer data;
1375     switch (gst_iterator_next (it, &data)) {
1376       case GST_ITERATOR_OK:
1377       {
1378         GstElement *element;
1380         element = GST_ELEMENT_CAST (data);
1382         /* set base time on element */
1383         gst_element_set_base_time (element, base_time);
1385         /* set state now */
1386         ret = gst_bin_element_set_state (bin, element, pending);
1388         switch (ret) {
1389           case GST_STATE_CHANGE_SUCCESS:
1390             GST_CAT_DEBUG (GST_CAT_STATES,
1391                 "child '%s' changed state to %d(%s) successfully",
1392                 GST_ELEMENT_NAME (element), pending,
1393                 gst_element_state_get_name (pending));
1394             break;
1395           case GST_STATE_CHANGE_ASYNC:
1396             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
1397                 "child '%s' is changing state asynchronously",
1398                 GST_ELEMENT_NAME (element));
1399             have_async = TRUE;
1400             break;
1401           case GST_STATE_CHANGE_FAILURE:
1402             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
1403                 "child '%s' failed to go to state %d(%s)",
1404                 GST_ELEMENT_NAME (element),
1405                 pending, gst_element_state_get_name (pending));
1406             gst_object_unref (element);
1407             goto done;
1408           case GST_STATE_CHANGE_NO_PREROLL:
1409             GST_CAT_DEBUG (GST_CAT_STATES,
1410                 "child '%s' changed state to %d(%s) successfully without preroll",
1411                 GST_ELEMENT_NAME (element), pending,
1412                 gst_element_state_get_name (pending));
1413             have_no_preroll = TRUE;
1414             break;
1415           default:
1416             g_assert_not_reached ();
1417             break;
1418         }
1419         gst_object_unref (element);
1420         break;
1421       }
1422       case GST_ITERATOR_RESYNC:
1423         gst_iterator_resync (it);
1424         goto restart;
1425         break;
1426       default:
1427       case GST_ITERATOR_DONE:
1428         done = TRUE;
1429         break;
1430     }
1431   }
1433   if (have_no_preroll) {
1434     ret = GST_STATE_CHANGE_NO_PREROLL;
1435   } else if (have_async) {
1436     ret = GST_STATE_CHANGE_ASYNC;
1437   } else {
1438     ret = parent_class->change_state (element, transition);
1439   }
1441 done:
1442   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
1443       "done changing bin's state from %s to %s, now in %s, ret %d",
1444       gst_element_state_get_name (old_state),
1445       gst_element_state_get_name (pending),
1446       gst_element_state_get_name (GST_STATE (element)), ret);
1448   gst_iterator_free (it);
1450   return ret;
1453 static void
1454 gst_bin_dispose (GObject * object)
1456   GstBin *bin = GST_BIN (object);
1458   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object, "dispose");
1460   g_list_free (bin->eosed);
1461   bin->eosed = NULL;
1462   gst_object_unref (bin->child_bus);
1463   bin->child_bus = NULL;
1464   gst_element_set_bus (GST_ELEMENT (bin), NULL);
1466   while (bin->children) {
1467     gst_bin_remove (bin, GST_ELEMENT (bin->children->data));
1468   }
1469   if (G_UNLIKELY (bin->children != NULL)) {
1470     g_critical ("could not remove elements from bin %s",
1471         GST_STR_NULL (GST_OBJECT_NAME (object)));
1472   }
1474   G_OBJECT_CLASS (parent_class)->dispose (object);
1477 /*
1478  * This function is a utility event handler for seek events.
1479  * It will send the event to all sinks.
1480  * Applications are free to override this behaviour and
1481  * implement their own seek handler, but this will work for
1482  * pretty much all cases in practice.
1483  */
1484 static gboolean
1485 gst_bin_send_event (GstElement * element, GstEvent * event)
1487   GstBin *bin = GST_BIN (element);
1488   GstIterator *iter;
1489   gboolean res = TRUE;
1490   gboolean done = FALSE;
1492   iter = gst_bin_iterate_sinks (bin);
1493   GST_DEBUG_OBJECT (bin, "Sending event to sink children");
1495   while (!done) {
1496     gpointer data;
1498     switch (gst_iterator_next (iter, &data)) {
1499       case GST_ITERATOR_OK:
1500       {
1501         GstElement *sink;
1503         gst_event_ref (event);
1504         sink = GST_ELEMENT_CAST (data);
1505         res &= gst_element_send_event (sink, event);
1506         gst_object_unref (sink);
1507         break;
1508       }
1509       case GST_ITERATOR_RESYNC:
1510         gst_iterator_resync (iter);
1511         res = TRUE;
1512         break;
1513       default:
1514       case GST_ITERATOR_DONE:
1515         done = TRUE;
1516         break;
1517     }
1518   }
1519   gst_iterator_free (iter);
1520   gst_event_unref (event);
1522   return res;
1525 static GstBusSyncReply
1526 bin_bus_handler (GstBus * bus, GstMessage * message, GstBin * bin)
1528   GST_DEBUG_OBJECT (bin, "[msg %p] handling child message of type %d",
1529       message, GST_MESSAGE_TYPE (message));
1531   switch (GST_MESSAGE_TYPE (message)) {
1532     case GST_MESSAGE_EOS:{
1533       GstObject *src = GST_MESSAGE_SRC (message);
1535       if (src) {
1536         gchar *name;
1538         name = gst_object_get_name (src);
1539         GST_DEBUG_OBJECT (bin, "got EOS message from %s", name);
1540         g_free (name);
1542         /* collect all eos messages from the children */
1543         GST_LOCK (bin->child_bus);
1544         bin->eosed = g_list_prepend (bin->eosed, src);
1545         GST_UNLOCK (bin->child_bus);
1547         /* if we are completely EOS, we forward an EOS message */
1548         if (is_eos (bin)) {
1549           GST_DEBUG_OBJECT (bin, "all sinks posted EOS");
1550           gst_element_post_message (GST_ELEMENT (bin),
1551               gst_message_new_eos (GST_OBJECT (bin)));
1552         }
1553       } else {
1554         GST_DEBUG_OBJECT (bin, "got EOS message from (NULL), not processing");
1555       }
1557       /* we drop all EOS messages */
1558       gst_message_unref (message);
1559       break;
1560     }
1561     default:
1562       /* Send all other messages upward */
1563       GST_DEBUG_OBJECT (bin, "posting message upward");
1564       gst_element_post_message (GST_ELEMENT (bin), message);
1565       break;
1566   }
1568   return GST_BUS_DROP;
1571 static gboolean
1572 gst_bin_query (GstElement * element, GstQuery * query)
1574   GstBin *bin = GST_BIN (element);
1575   GstIterator *iter;
1576   gboolean res = FALSE, done = FALSE;
1578   iter = gst_bin_iterate_sinks (bin);
1579   GST_DEBUG_OBJECT (bin, "Sending event to sink children");
1581   while (!(res || done)) {
1582     gpointer data;
1584     switch (gst_iterator_next (iter, &data)) {
1585       case GST_ITERATOR_OK:
1586       {
1587         GstElement *sink;
1589         sink = GST_ELEMENT_CAST (data);
1590         res = gst_element_query (sink, query);
1591         gst_object_unref (sink);
1592         break;
1593       }
1594       case GST_ITERATOR_RESYNC:
1595         gst_iterator_resync (iter);
1596         break;
1597       default:
1598       case GST_ITERATOR_DONE:
1599         done = TRUE;
1600         break;
1601     }
1602   }
1603   gst_iterator_free (iter);
1605   return res;
1608 static gint
1609 compare_name (GstElement * element, const gchar * name)
1611   gint eq;
1613   GST_LOCK (element);
1614   eq = strcmp (GST_ELEMENT_NAME (element), name);
1615   GST_UNLOCK (element);
1617   if (eq != 0) {
1618     gst_object_unref (element);
1619   }
1620   return eq;
1623 /**
1624  * gst_bin_get_by_name:
1625  * @bin: #Gstbin to search
1626  * @name: the element name to search for
1627  *
1628  * Get the element with the given name from this bin. This
1629  * function recurses into subbins.
1630  *
1631  * MT safe.
1632  *
1633  * Returns: the element with the given name. Returns NULL if the
1634  * element is not found or when bad parameters were given. Unref after
1635  * use.
1636  */
1637 GstElement *
1638 gst_bin_get_by_name (GstBin * bin, const gchar * name)
1640   GstIterator *children;
1641   GstIterator *result;
1643   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1645   GST_CAT_INFO (GST_CAT_PARENTAGE, "[%s]: looking up child element %s",
1646       GST_ELEMENT_NAME (bin), name);
1648   children = gst_bin_iterate_recurse (bin);
1649   result = gst_iterator_find_custom (children,
1650       (GCompareFunc) compare_name, (gpointer) name);
1651   gst_iterator_free (children);
1653   return GST_ELEMENT_CAST (result);
1656 /**
1657  * gst_bin_get_by_name_recurse_up:
1658  * @bin: #Gstbin to search
1659  * @name: the element name to search for
1660  *
1661  * MT safe.
1662  *
1663  * Get the element with the given name from this bin. If the
1664  * element is not found, a recursion is performed on the parent bin.
1665  *
1666  * Returns: the element with the given name or NULL when the element
1667  * was not found or bad parameters were given. Unref after use.
1668  */
1669 GstElement *
1670 gst_bin_get_by_name_recurse_up (GstBin * bin, const gchar * name)
1672   GstElement *result;
1674   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1675   g_return_val_if_fail (name != NULL, NULL);
1677   result = gst_bin_get_by_name (bin, name);
1679   if (!result) {
1680     GstObject *parent;
1682     parent = gst_object_get_parent (GST_OBJECT_CAST (bin));
1683     if (parent) {
1684       if (GST_IS_BIN (parent)) {
1685         result = gst_bin_get_by_name_recurse_up (GST_BIN_CAST (parent), name);
1686       }
1687       gst_object_unref (parent);
1688     }
1689   }
1691   return result;
1694 static gint
1695 compare_interface (GstElement * element, gpointer interface)
1697   gint ret;
1699   if (G_TYPE_CHECK_INSTANCE_TYPE (element, GPOINTER_TO_INT (interface))) {
1700     ret = 0;
1701   } else {
1702     /* we did not find the element, need to release the ref
1703      * added by the iterator */
1704     gst_object_unref (element);
1705     ret = 1;
1706   }
1707   return ret;
1710 /**
1711  * gst_bin_get_by_interface:
1712  * @bin: bin to find element in
1713  * @interface: interface to be implemented by interface
1714  *
1715  * Looks for the first element inside the bin that implements the given
1716  * interface. If such an element is found, it returns the element. You can
1717  * cast this element to the given interface afterwards.
1718  * If you want all elements that implement the interface, use
1719  * gst_bin_iterate_all_by_interface(). The function recurses inside bins.
1720  *
1721  * MT safe.
1722  *
1723  * Returns: An #GstElement inside the bin implementing the interface.
1724  *          Unref after use.
1725  */
1726 GstElement *
1727 gst_bin_get_by_interface (GstBin * bin, GType interface)
1729   GstIterator *children;
1730   GstIterator *result;
1732   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1734   children = gst_bin_iterate_recurse (bin);
1735   result = gst_iterator_find_custom (children, (GCompareFunc) compare_interface,
1736       GINT_TO_POINTER (interface));
1737   gst_iterator_free (children);
1739   return GST_ELEMENT_CAST (result);
1742 /**
1743  * gst_bin_iterate_all_by_interface:
1744  * @bin: bin to find elements in
1745  * @interface: interface to be implemented by interface
1746  *
1747  * Looks for all elements inside the bin that implements the given
1748  * interface. You can safely cast all returned elements to the given interface.
1749  * The function recurses bins inside bins. The iterator will return a series
1750  * of #GstElement that should be unreffed after use.
1751  *
1752  * MT safe.
1753  *
1754  * Returns: A #GstIterator for the elements inside the bin implementing the
1755  *          given interface.
1756  */
1757 GstIterator *
1758 gst_bin_iterate_all_by_interface (GstBin * bin, GType interface)
1760   GstIterator *children;
1761   GstIterator *result;
1763   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1765   children = gst_bin_iterate_recurse (bin);
1766   result = gst_iterator_filter (children, (GCompareFunc) compare_interface,
1767       GINT_TO_POINTER (interface));
1769   return result;
1772 #ifndef GST_DISABLE_LOADSAVE
1773 static xmlNodePtr
1774 gst_bin_save_thyself (GstObject * object, xmlNodePtr parent)
1776   GstBin *bin = GST_BIN (object);
1777   xmlNodePtr childlist, elementnode;
1778   GList *children;
1779   GstElement *child;
1781   if (GST_OBJECT_CLASS (parent_class)->save_thyself)
1782     GST_OBJECT_CLASS (parent_class)->save_thyself (GST_OBJECT (bin), parent);
1784   childlist = xmlNewChild (parent, NULL, (xmlChar *) "children", NULL);
1786   GST_CAT_INFO (GST_CAT_XML, "[%s]: saving %d children",
1787       GST_ELEMENT_NAME (bin), bin->numchildren);
1789   children = bin->children;
1790   while (children) {
1791     child = GST_ELEMENT (children->data);
1792     elementnode = xmlNewChild (childlist, NULL, (xmlChar *) "element", NULL);
1793     gst_object_save_thyself (GST_OBJECT (child), elementnode);
1794     children = g_list_next (children);
1795   }
1796   return childlist;
1799 static void
1800 gst_bin_restore_thyself (GstObject * object, xmlNodePtr self)
1802   GstBin *bin = GST_BIN (object);
1803   xmlNodePtr field = self->xmlChildrenNode;
1804   xmlNodePtr childlist;
1806   while (field) {
1807     if (!strcmp ((char *) field->name, "children")) {
1808       GST_CAT_INFO (GST_CAT_XML, "[%s]: loading children",
1809           GST_ELEMENT_NAME (object));
1810       childlist = field->xmlChildrenNode;
1811       while (childlist) {
1812         if (!strcmp ((char *) childlist->name, "element")) {
1813           GstElement *element =
1814               gst_xml_make_element (childlist, GST_OBJECT (bin));
1816           /* it had to be parented to find the pads, now we ref and unparent so
1817            * we can add it to the bin */
1818           gst_object_ref (element);
1819           gst_object_unparent (GST_OBJECT (element));
1821           gst_bin_add (bin, element);
1822         }
1823         childlist = childlist->next;
1824       }
1825     }
1827     field = field->next;
1828   }
1829   if (GST_OBJECT_CLASS (parent_class)->restore_thyself)
1830     (GST_OBJECT_CLASS (parent_class)->restore_thyself) (object, self);
1832 #endif /* GST_DISABLE_LOADSAVE */