gst/gstbin.c

   1 /* GStreamer
   2  *
   3  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   4  *                    2004 Wim Taymans <wim.taymans@gmail.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 /**
  27  * SECTION:gstbin
  28  * @short_description: Base class and element that can contain other elements
  29  *
  30  * #GstBin is an element that can contain other #GstElement, allowing them to be
  31  * managed as a group.
  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.
  35  *
  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.
  39  *
  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().
  42  *
  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
  46  * current bin.
  47  *
  48  * An iterator of elements in a bin can be retrieved with
  49  * gst_bin_iterate_elements(). Various other iterators exist to retrieve the
  50  * elements in a bin.
  51  *
  52  * gst_object_unref() is used to drop your reference to the bin.
  53  *
  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.
  57  *
  58  * <refsect2><title>Notes</title>
  59  * <para>
  60  * A #GstBin internally intercepts every #GstMessage posted by its children and
  61  * implements the following default behaviour for each of them:
  62  * <variablelist>
  63  *   <varlistentry>
  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>
  68  *   </varlistentry>
  69  *   <varlistentry>
  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>
  74  *   </varlistentry>
  75  *   <varlistentry>
  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>
  79  *   </varlistentry>
  80  *   <varlistentry>
  81  *     <term>GST_MESSAGE_DURATION</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.
  89  *     </para></listitem>
  90  *   </varlistentry>
  91  *   <varlistentry>
  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
  97  *     the bin parent.
  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
 101  *     distribution.
 102  *     </para></listitem>
 103  *   </varlistentry>
 104  *   <varlistentry>
 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.
 113  *     </para></listitem>
 114  *   </varlistentry>
 115  *   <varlistentry>
 116  *     <term>OTHERS</term>
 117  *     <listitem><para> posted upwards.</para></listitem>
 118  *   </varlistentry>
 119  * </variablelist>
 120  *
 121  *
 122  * A #GstBin implements the following default behaviour for answering to a
 123  * #GstQuery:
 124  * <variablelist>
 125  *   <varlistentry>
 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.
 133  *     </para></listitem>
 134  *   </varlistentry>
 135  *   <varlistentry>
 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,
 139  *     the query fails.
 140  *     </para></listitem>
 141  *   </varlistentry>
 142  *   <varlistentry>
 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>
 147  *   </varlistentry>
 148  * </variablelist>
 149  *
 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.
 153  *
 154  * </para>
 155  * </refsect2>
 156  *
 157  * Last reviewed on 2006-04-28 (0.10.6)
 158  */
 159
 160 #include "gst_private.h"
 161
 162 #include "gstevent.h"
 163 #include "gstbin.h"
 164 #include "gstmarshal.h"
 165 #include "gstinfo.h"
 166 #include "gsterror.h"
 167
 168 #include "gstindex.h"
 169 #include "gstindexfactory.h"
 170 #include "gstutils.h"
 171 #include "gstchildproxy.h"
 172
 173 /* latency is by default enabled now.
 174  * live-preroll and no-live-preroll in the environment var GST_COMPAT
 175  * to enables or disable it respectively.
 176  */
 177 static gboolean enable_latency = TRUE;
 178
 179 GST_DEBUG_CATEGORY_STATIC (bin_debug);
 180 #define GST_CAT_DEFAULT bin_debug
 181
 182 /* a bin is toplevel if it has no parent or when it is configured to behave like
 183  * a toplevel bin */
 184 #define BIN_IS_TOPLEVEL(bin) ((GST_OBJECT_PARENT (bin) == NULL) || bin->priv->asynchandling)
 185
 186 #define GST_BIN_GET_PRIVATE(obj)  \
 187    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BIN, GstBinPrivate))
 188
 189 struct _GstBinPrivate
 190 {
 191   gboolean asynchandling;
 192   /* if we get an ASYNC_DONE message from ourselves, this means that the
 193    * subclass will simulate ASYNC behaviour without having ASYNC children. When
 194    * such an ASYNC_DONE message is posted while we are doing a state change, we
 195    * have to process the message after finishing the state change even when no
 196    * child returned GST_STATE_CHANGE_ASYNC. */
 197   gboolean pending_async_done;
 198
 199   guint32 structure_cookie;
 200
 201   /* cached index */
 202   GstIndex *index;
 203   /* forward messages from our children */
 204   gboolean message_forward;
 205
 206   gboolean posted_eos;
 207 };
 208
 209 typedef struct
 210 {
 211   GstBin *bin;
 212   guint32 cookie;
 213   GstState pending;
 214 } BinContinueData;
 215
 216 static void gst_bin_dispose (GObject * object);
 217
 218 static void gst_bin_set_property (GObject * object, guint prop_id,
 219     const GValue * value, GParamSpec * pspec);
 220 static void gst_bin_get_property (GObject * object, guint prop_id,
 221     GValue * value, GParamSpec * pspec);
 222
 223 static GstStateChangeReturn gst_bin_change_state_func (GstElement * element,
 224     GstStateChange transition);
 225 static void gst_bin_state_changed (GstElement * element, GstState oldstate,
 226     GstState newstate, GstState pending);
 227 static GstStateChangeReturn gst_bin_get_state_func (GstElement * element,
 228     GstState * state, GstState * pending, GstClockTime timeout);
 229 static void bin_handle_async_done (GstBin * bin, GstStateChangeReturn ret,
 230     gboolean flag_pending);
 231 static void bin_handle_async_start (GstBin * bin, gboolean new_base_time);
 232 static void bin_push_state_continue (BinContinueData * data);
 233 static void bin_do_eos (GstBin * bin);
 234
 235 static gboolean gst_bin_add_func (GstBin * bin, GstElement * element);
 236 static gboolean gst_bin_remove_func (GstBin * bin, GstElement * element);
 237
 238 static void gst_bin_set_index_func (GstElement * element, GstIndex * index);
 239 static GstIndex *gst_bin_get_index_func (GstElement * element);
 240
 241 static GstClock *gst_bin_provide_clock_func (GstElement * element);
 242 static gboolean gst_bin_set_clock_func (GstElement * element, GstClock * clock);
 243
 244 static void gst_bin_handle_message_func (GstBin * bin, GstMessage * message);
 245 static gboolean gst_bin_send_event (GstElement * element, GstEvent * event);
 246 static GstBusSyncReply bin_bus_handler (GstBus * bus,
 247     GstMessage * message, GstBin * bin);
 248 static gboolean gst_bin_query (GstElement * element, GstQuery * query);
 249
 250 static gboolean gst_bin_do_latency_func (GstBin * bin);
 251
 252 static void bin_remove_messages (GstBin * bin, GstObject * src,
 253     GstMessageType types);
 254 static void gst_bin_continue_func (BinContinueData * data);
 255 static gint bin_element_is_sink (GstElement * child, GstBin * bin);
 256 static gint bin_element_is_src (GstElement * child, GstBin * bin);
 257
 258 static GstIterator *gst_bin_sort_iterator_new (GstBin * bin);
 259
 260 /* Bin signals and properties */
 261 enum
 262 {
 263   ELEMENT_ADDED,
 264   ELEMENT_REMOVED,
 265   DO_LATENCY,
 266   LAST_SIGNAL
 267 };
 268
 269 #define DEFAULT_ASYNC_HANDLING  FALSE
 270 #define DEFAULT_MESSAGE_FORWARD FALSE
 271
 272 enum
 273 {
 274   PROP_0,
 275   PROP_ASYNC_HANDLING,
 276   PROP_MESSAGE_FORWARD,
 277   PROP_LAST
 278 };
 279
 280 static void gst_bin_child_proxy_init (gpointer g_iface, gpointer iface_data);
 281
 282 static guint gst_bin_signals[LAST_SIGNAL] = { 0 };
 283
 284 #define _do_init \
 285 { \
 286   const gchar *compat; \
 287   static const GInterfaceInfo iface_info = { \
 288     gst_bin_child_proxy_init, \
 289     NULL, \
 290     NULL}; \
 291   \
 292   g_type_add_interface_static (g_define_type_id, GST_TYPE_CHILD_PROXY, &iface_info); \
 293   \
 294   GST_DEBUG_CATEGORY_INIT (bin_debug, "bin", GST_DEBUG_BOLD, \
 295       "debugging info for the 'bin' container element"); \
 296   \
 297   /* compatibility stuff */ \
 298   compat = g_getenv ("GST_COMPAT"); \
 299   if (compat != NULL) { \
 300     if (strstr (compat, "no-live-preroll")) \
 301       enable_latency = FALSE; \
 302     else if (strstr (compat, "live-preroll")) \
 303       enable_latency = TRUE; \
 304   } \
 305 }
 306
 307 #define gst_bin_parent_class parent_class
 308 G_DEFINE_TYPE_WITH_CODE (GstBin, gst_bin, GST_TYPE_ELEMENT, _do_init);
 309
 310 static GstObject *
 311 gst_bin_child_proxy_get_child_by_index (GstChildProxy * child_proxy,
 312     guint index)
 313 {
 314   GstObject *res;
 315   GstBin *bin;
 316
 317   bin = GST_BIN_CAST (child_proxy);
 318
 319   GST_OBJECT_LOCK (bin);
 320   if ((res = g_list_nth_data (bin->children, index)))
 321     gst_object_ref (res);
 322   GST_OBJECT_UNLOCK (bin);
 323
 324   return res;
 325 }
 326
 327 static guint
 328 gst_bin_child_proxy_get_children_count (GstChildProxy * child_proxy)
 329 {
 330   guint num;
 331   GstBin *bin;
 332
 333   bin = GST_BIN_CAST (child_proxy);
 334
 335   GST_OBJECT_LOCK (bin);
 336   num = bin->numchildren;
 337   GST_OBJECT_UNLOCK (bin);
 338
 339   return num;
 340 }
 341
 342 static void
 343 gst_bin_child_proxy_init (gpointer g_iface, gpointer iface_data)
 344 {
 345   GstChildProxyInterface *iface = g_iface;
 346
 347   iface->get_children_count = gst_bin_child_proxy_get_children_count;
 348   iface->get_child_by_index = gst_bin_child_proxy_get_child_by_index;
 349 }
 350
 351 static gboolean
 352 _gst_boolean_accumulator (GSignalInvocationHint * ihint,
 353     GValue * return_accu, const GValue * handler_return, gpointer dummy)
 354 {
 355   gboolean myboolean;
 356
 357   myboolean = g_value_get_boolean (handler_return);
 358   if (!(ihint->run_type & G_SIGNAL_RUN_CLEANUP))
 359     g_value_set_boolean (return_accu, myboolean);
 360
 361   GST_DEBUG ("invocation %d, %d", ihint->run_type, myboolean);
 362
 363   /* stop emission */
 364   return FALSE;
 365 }
 366
 367 static void
 368 gst_bin_class_init (GstBinClass * klass)
 369 {
 370   GObjectClass *gobject_class;
 371   GstObjectClass *gstobject_class;
 372   GstElementClass *gstelement_class;
 373   GError *err;
 374
 375   gobject_class = (GObjectClass *) klass;
 376   gstobject_class = (GstObjectClass *) klass;
 377   gstelement_class = (GstElementClass *) klass;
 378
 379   g_type_class_add_private (klass, sizeof (GstBinPrivate));
 380
 381   gobject_class->set_property = gst_bin_set_property;
 382   gobject_class->get_property = gst_bin_get_property;
 383
 384   /**
 385    * GstBin:async-handling
 386    *
 387    * If set to #TRUE, the bin will handle asynchronous state changes.
 388    * This should be used only if the bin subclass is modifying the state
 389    * of its children on its own.
 390    *
 391    * Since: 0.10.13
 392    */
 393   g_object_class_install_property (gobject_class, PROP_ASYNC_HANDLING,
 394       g_param_spec_boolean ("async-handling", "Async Handling",
 395           "The bin will handle Asynchronous state changes",
 396           DEFAULT_ASYNC_HANDLING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 397
 398   /**
 399    * GstBin::element-added:
 400    * @bin: the #GstBin
 401    * @element: the #GstElement that was added to the bin
 402    *
 403    * Will be emitted after the element was added to the bin.
 404    */
 405   gst_bin_signals[ELEMENT_ADDED] =
 406       g_signal_new ("element-added", G_TYPE_FROM_CLASS (klass),
 407       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstBinClass, element_added), NULL,
 408       NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_ELEMENT);
 409   /**
 410    * GstBin::element-removed:
 411    * @bin: the #GstBin
 412    * @element: the #GstElement that was removed from the bin
 413    *
 414    * Will be emitted after the element was removed from the bin.
 415    */
 416   gst_bin_signals[ELEMENT_REMOVED] =
 417       g_signal_new ("element-removed", G_TYPE_FROM_CLASS (klass),
 418       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstBinClass, element_removed), NULL,
 419       NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_ELEMENT);
 420   /**
 421    * GstBin::do-latency:
 422    * @bin: the #GstBin
 423    *
 424    * Will be emitted when the bin needs to perform latency calculations. This
 425    * signal is only emited for toplevel bins or when async-handling is
 426    * enabled.
 427    *
 428    * Only one signal handler is invoked. If no signals are connected, the
 429    * default handler is invoked, which will query and distribute the lowest
 430    * possible latency to all sinks.
 431    *
 432    * Connect to this signal if the default latency calculations are not
 433    * sufficient, like when you need different latencies for different sinks in
 434    * the same pipeline.
 435    *
 436    * Since: 0.10.22
 437    */
 438   gst_bin_signals[DO_LATENCY] =
 439       g_signal_new ("do-latency", G_TYPE_FROM_CLASS (klass),
 440       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstBinClass, do_latency),
 441       _gst_boolean_accumulator, NULL, gst_marshal_BOOLEAN__VOID,
 442       G_TYPE_BOOLEAN, 0, G_TYPE_NONE);
 443
 444   /**
 445    * GstBin:message-forward
 446    *
 447    * Forward all children messages, even those that would normally be filtered by
 448    * the bin. This can be interesting when one wants to be notified of the EOS
 449    * state of individual elements, for example.
 450    *
 451    * The messages are converted to an ELEMENT message with the bin as the
 452    * source. The structure of the message is named 'GstBinForwarded' and contains
 453    * a field named 'message' of type GST_TYPE_MESSAGE that contains the original
 454    * forwarded message.
 455    *
 456    * Since: 0.10.31
 457    */
 458   g_object_class_install_property (gobject_class, PROP_MESSAGE_FORWARD,
 459       g_param_spec_boolean ("message-forward", "Message Forward",
 460           "Forwards all children messages",
 461           DEFAULT_MESSAGE_FORWARD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 462
 463   gobject_class->dispose = gst_bin_dispose;
 464
 465   gst_element_class_set_metadata (gstelement_class, "Generic bin",
 466       "Generic/Bin",
 467       "Simple container object",
 468       "Erik Walthinsen <omega@cse.ogi.edu>,"
 469       "Wim Taymans <wim.taymans@gmail.com>");
 470
 471   gstelement_class->change_state =
 472       GST_DEBUG_FUNCPTR (gst_bin_change_state_func);
 473   gstelement_class->state_changed = GST_DEBUG_FUNCPTR (gst_bin_state_changed);
 474   gstelement_class->get_state = GST_DEBUG_FUNCPTR (gst_bin_get_state_func);
 475   gstelement_class->get_index = GST_DEBUG_FUNCPTR (gst_bin_get_index_func);
 476   gstelement_class->set_index = GST_DEBUG_FUNCPTR (gst_bin_set_index_func);
 477   gstelement_class->provide_clock =
 478       GST_DEBUG_FUNCPTR (gst_bin_provide_clock_func);
 479   gstelement_class->set_clock = GST_DEBUG_FUNCPTR (gst_bin_set_clock_func);
 480
 481   gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_bin_send_event);
 482   gstelement_class->query = GST_DEBUG_FUNCPTR (gst_bin_query);
 483
 484   klass->add_element = GST_DEBUG_FUNCPTR (gst_bin_add_func);
 485   klass->remove_element = GST_DEBUG_FUNCPTR (gst_bin_remove_func);
 486   klass->handle_message = GST_DEBUG_FUNCPTR (gst_bin_handle_message_func);
 487
 488   klass->do_latency = GST_DEBUG_FUNCPTR (gst_bin_do_latency_func);
 489
 490   GST_DEBUG ("creating bin thread pool");
 491   err = NULL;
 492   klass->pool =
 493       g_thread_pool_new ((GFunc) gst_bin_continue_func, NULL, -1, FALSE, &err);
 494   if (err != NULL) {
 495     g_critical ("could alloc threadpool %s", err->message);
 496   }
 497 }
 498
 499 static void
 500 gst_bin_init (GstBin * bin)
 501 {
 502   GstBus *bus;
 503
 504   bin->numchildren = 0;
 505   bin->children = NULL;
 506   bin->children_cookie = 0;
 507   bin->messages = NULL;
 508   bin->provided_clock = NULL;
 509   bin->clock_dirty = FALSE;
 510
 511   /* Set up a bus for listening to child elements */
 512   bus = g_object_new (GST_TYPE_BUS, "enable-async", FALSE, NULL);
 513   bin->child_bus = bus;
 514   GST_DEBUG_OBJECT (bin, "using bus %" GST_PTR_FORMAT " to listen to children",
 515       bus);
 516   gst_bus_set_sync_handler (bus, (GstBusSyncHandler) bin_bus_handler, bin);
 517
 518   bin->priv = GST_BIN_GET_PRIVATE (bin);
 519   bin->priv->asynchandling = DEFAULT_ASYNC_HANDLING;
 520   bin->priv->structure_cookie = 0;
 521   bin->priv->message_forward = DEFAULT_MESSAGE_FORWARD;
 522 }
 523
 524 static void
 525 gst_bin_dispose (GObject * object)
 526 {
 527   GstBin *bin = GST_BIN_CAST (object);
 528   GstBus **child_bus_p = &bin->child_bus;
 529   GstClock **provided_clock_p = &bin->provided_clock;
 530   GstElement **clock_provider_p = &bin->clock_provider;
 531   GstIndex **index_p = &bin->priv->index;
 532
 533   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object, "dispose");
 534
 535   GST_OBJECT_LOCK (object);
 536   gst_object_replace ((GstObject **) child_bus_p, NULL);
 537   gst_object_replace ((GstObject **) provided_clock_p, NULL);
 538   gst_object_replace ((GstObject **) clock_provider_p, NULL);
 539   gst_object_replace ((GstObject **) index_p, NULL);
 540   bin_remove_messages (bin, NULL, GST_MESSAGE_ANY);
 541   GST_OBJECT_UNLOCK (object);
 542
 543   while (bin->children) {
 544     gst_bin_remove (bin, GST_ELEMENT_CAST (bin->children->data));
 545   }
 546   if (G_UNLIKELY (bin->children != NULL)) {
 547     g_critical ("could not remove elements from bin '%s'",
 548         GST_STR_NULL (GST_OBJECT_NAME (object)));
 549   }
 550
 551   G_OBJECT_CLASS (parent_class)->dispose (object);
 552 }
 553
 554 /**
 555  * gst_bin_new:
 556  * @name: the name of the new bin
 557  *
 558  * Creates a new bin with the given name.
 559  *
 560  * Returns: (transfer full): a new #GstBin
 561  */
 562 GstElement *
 563 gst_bin_new (const gchar * name)
 564 {
 565   return gst_element_factory_make ("bin", name);
 566 }
 567
 568 static void
 569 gst_bin_set_property (GObject * object, guint prop_id,
 570     const GValue * value, GParamSpec * pspec)
 571 {
 572   GstBin *gstbin;
 573
 574   gstbin = GST_BIN_CAST (object);
 575
 576   switch (prop_id) {
 577     case PROP_ASYNC_HANDLING:
 578       GST_OBJECT_LOCK (gstbin);
 579       gstbin->priv->asynchandling = g_value_get_boolean (value);
 580       GST_OBJECT_UNLOCK (gstbin);
 581       break;
 582     case PROP_MESSAGE_FORWARD:
 583       GST_OBJECT_LOCK (gstbin);
 584       gstbin->priv->message_forward = g_value_get_boolean (value);
 585       GST_OBJECT_UNLOCK (gstbin);
 586       break;
 587     default:
 588       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 589       break;
 590   }
 591 }
 592
 593 static void
 594 gst_bin_get_property (GObject * object, guint prop_id,
 595     GValue * value, GParamSpec * pspec)
 596 {
 597   GstBin *gstbin;
 598
 599   gstbin = GST_BIN_CAST (object);
 600
 601   switch (prop_id) {
 602     case PROP_ASYNC_HANDLING:
 603       GST_OBJECT_LOCK (gstbin);
 604       g_value_set_boolean (value, gstbin->priv->asynchandling);
 605       GST_OBJECT_UNLOCK (gstbin);
 606       break;
 607     case PROP_MESSAGE_FORWARD:
 608       GST_OBJECT_LOCK (gstbin);
 609       g_value_set_boolean (value, gstbin->priv->message_forward);
 610       GST_OBJECT_UNLOCK (gstbin);
 611       break;
 612     default:
 613       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 614       break;
 615   }
 616 }
 617
 618 /* return the cached index */
 619 static GstIndex *
 620 gst_bin_get_index_func (GstElement * element)
 621 {
 622   GstBin *bin;
 623   GstIndex *result;
 624
 625   bin = GST_BIN_CAST (element);
 626
 627   GST_OBJECT_LOCK (bin);
 628   if ((result = bin->priv->index))
 629     gst_object_ref (result);
 630   GST_OBJECT_UNLOCK (bin);
 631
 632   return result;
 633 }
 634
 635 /* set the index on all elements in this bin
 636  *
 637  * MT safe
 638  */
 639 static void
 640 gst_bin_set_index_func (GstElement * element, GstIndex * index)
 641 {
 642   GstBin *bin;
 643   gboolean done;
 644   GstIterator *it;
 645   GstIndex *old;
 646   GValue data = { 0, };
 647
 648   bin = GST_BIN_CAST (element);
 649
 650   GST_OBJECT_LOCK (bin);
 651   old = bin->priv->index;
 652   if (G_UNLIKELY (old == index))
 653     goto was_set;
 654   if (index)
 655     gst_object_ref (index);
 656   bin->priv->index = index;
 657   GST_OBJECT_UNLOCK (bin);
 658
 659   if (old)
 660     gst_object_unref (old);
 661
 662   it = gst_bin_iterate_elements (bin);
 663
 664   /* set the index on all elements in the bin */
 665   done = FALSE;
 666   while (!done) {
 667     switch (gst_iterator_next (it, &data)) {
 668       case GST_ITERATOR_OK:
 669       {
 670         GstElement *child = g_value_get_object (&data);
 671
 672         GST_DEBUG_OBJECT (bin, "setting index on '%s'",
 673             GST_ELEMENT_NAME (child));
 674         gst_element_set_index (child, index);
 675
 676         g_value_reset (&data);
 677         break;
 678       }
 679       case GST_ITERATOR_RESYNC:
 680         GST_DEBUG_OBJECT (bin, "iterator doing resync");
 681         gst_iterator_resync (it);
 682         break;
 683       default:
 684       case GST_ITERATOR_DONE:
 685         GST_DEBUG_OBJECT (bin, "iterator done");
 686         done = TRUE;
 687         break;
 688     }
 689   }
 690   g_value_unset (&data);
 691   gst_iterator_free (it);
 692   return;
 693
 694 was_set:
 695   {
 696     GST_DEBUG_OBJECT (bin, "index was already set");
 697     GST_OBJECT_UNLOCK (bin);
 698     return;
 699   }
 700 }
 701
 702 /* set the clock on all elements in this bin
 703  *
 704  * MT safe
 705  */
 706 static gboolean
 707 gst_bin_set_clock_func (GstElement * element, GstClock * clock)
 708 {
 709   GstBin *bin;
 710   gboolean done;
 711   GstIterator *it;
 712   gboolean res = TRUE;
 713   GValue data = { 0, };
 714
 715   bin = GST_BIN_CAST (element);
 716
 717   it = gst_bin_iterate_elements (bin);
 718
 719   done = FALSE;
 720   while (!done) {
 721     switch (gst_iterator_next (it, &data)) {
 722       case GST_ITERATOR_OK:
 723       {
 724         GstElement *child = g_value_get_object (&data);
 725
 726         res &= gst_element_set_clock (child, clock);
 727
 728         g_value_reset (&data);
 729         break;
 730       }
 731       case GST_ITERATOR_RESYNC:
 732         GST_DEBUG_OBJECT (bin, "iterator doing resync");
 733         gst_iterator_resync (it);
 734         res = TRUE;
 735         break;
 736       default:
 737       case GST_ITERATOR_DONE:
 738         GST_DEBUG_OBJECT (bin, "iterator done");
 739         done = TRUE;
 740         break;
 741     }
 742   }
 743   g_value_unset (&data);
 744   gst_iterator_free (it);
 745
 746   return res;
 747 }
 748
 749 /* get the clock for this bin by asking all of the children in this bin
 750  *
 751  * The ref of the returned clock in increased so unref after usage.
 752  *
 753  * We loop the elements in state order and pick the last clock we can
 754  * get. This makes sure we get a clock from the source.
 755  *
 756  * MT safe
 757  */
 758 static GstClock *
 759 gst_bin_provide_clock_func (GstElement * element)
 760 {
 761   GstClock *result = NULL;
 762   GstElement *provider = NULL;
 763   GstBin *bin;
 764   GstIterator *it;
 765   gboolean done;
 766   GValue val = { 0, };
 767   GstClock **provided_clock_p;
 768   GstElement **clock_provider_p;
 769
 770   bin = GST_BIN_CAST (element);
 771
 772   GST_OBJECT_LOCK (bin);
 773   if (!bin->clock_dirty)
 774     goto not_dirty;
 775
 776   GST_DEBUG_OBJECT (bin, "finding new clock");
 777
 778   it = gst_bin_sort_iterator_new (bin);
 779   GST_OBJECT_UNLOCK (bin);
 780
 781   done = FALSE;
 782   while (!done) {
 783     switch (gst_iterator_next (it, &val)) {
 784       case GST_ITERATOR_OK:
 785       {
 786         GstElement *child = g_value_get_object (&val);
 787         GstClock *clock;
 788
 789         clock = gst_element_provide_clock (child);
 790         if (clock) {
 791           GST_DEBUG_OBJECT (bin, "found candidate clock %p by element %s",
 792               clock, GST_ELEMENT_NAME (child));
 793           if (result) {
 794             gst_object_unref (result);
 795             gst_object_unref (provider);
 796           }
 797           result = clock;
 798           provider = gst_object_ref (child);
 799         }
 800
 801         g_value_reset (&val);
 802         break;
 803       }
 804       case GST_ITERATOR_RESYNC:
 805         gst_iterator_resync (it);
 806         break;
 807       default:
 808       case GST_ITERATOR_DONE:
 809         done = TRUE;
 810         break;
 811     }
 812   }
 813   g_value_unset (&val);
 814   gst_iterator_free (it);
 815
 816   GST_OBJECT_LOCK (bin);
 817   if (!bin->clock_dirty) {
 818     if (provider)
 819       gst_object_unref (provider);
 820     if (result)
 821       gst_object_unref (result);
 822     result = NULL;
 823
 824     goto not_dirty;
 825   }
 826
 827   provided_clock_p = &bin->provided_clock;
 828   clock_provider_p = &bin->clock_provider;
 829   gst_object_replace ((GstObject **) provided_clock_p, (GstObject *) result);
 830   gst_object_replace ((GstObject **) clock_provider_p, (GstObject *) provider);
 831   bin->clock_dirty = FALSE;
 832   GST_DEBUG_OBJECT (bin,
 833       "provided new clock %" GST_PTR_FORMAT " by provider %" GST_PTR_FORMAT,
 834       result, provider);
 835   /* Provider is not being returned to caller, just the result */
 836   if (provider)
 837     gst_object_unref (provider);
 838   GST_OBJECT_UNLOCK (bin);
 839
 840   return result;
 841
 842 not_dirty:
 843   {
 844     if ((result = bin->provided_clock))
 845       gst_object_ref (result);
 846     GST_DEBUG_OBJECT (bin, "returning old clock %p", result);
 847     GST_OBJECT_UNLOCK (bin);
 848
 849     return result;
 850   }
 851 }
 852
 853 /*
 854  * functions for manipulating cached messages
 855  */
 856 typedef struct
 857 {
 858   GstObject *src;
 859   GstMessageType types;
 860 } MessageFind;
 861
 862 /* check if a message is of given src and type */
 863 static gint
 864 message_check (GstMessage * message, MessageFind * target)
 865 {
 866   gboolean eq = TRUE;
 867
 868   if (target->src)
 869     eq &= GST_MESSAGE_SRC (message) == target->src;
 870   if (target->types)
 871     eq &= (GST_MESSAGE_TYPE (message) & target->types) != 0;
 872   GST_LOG ("looking at message %p: %d", message, eq);
 873
 874   return (eq ? 0 : 1);
 875 }
 876
 877 static GList *
 878 find_message (GstBin * bin, GstObject * src, GstMessageType types)
 879 {
 880   GList *result;
 881   MessageFind find;
 882
 883   find.src = src;
 884   find.types = types;
 885
 886   result = g_list_find_custom (bin->messages, &find,
 887       (GCompareFunc) message_check);
 888
 889   if (result) {
 890     GST_DEBUG_OBJECT (bin, "we found a message %p from %s matching types %08x",
 891         result->data, GST_OBJECT_NAME (GST_MESSAGE_CAST (result->data)->src),
 892         types);
 893   } else {
 894     GST_DEBUG_OBJECT (bin, "no message found matching types %08x", types);
 895 #ifndef GST_DISABLE_GST_DEBUG
 896     {
 897       guint i;
 898
 899       for (i = 0; i < 32; i++)
 900         if (types & (1 << i))
 901           GST_DEBUG_OBJECT (bin, "  %s", gst_message_type_get_name (1 << i));
 902     }
 903 #endif
 904   }
 905
 906   return result;
 907 }
 908
 909 /* with LOCK, returns TRUE if message had a valid SRC, takes ownership of
 910  * the message.
 911  *
 912  * A message that is cached and has the same SRC and type is replaced
 913  * by the given message.
 914  */
 915 static gboolean
 916 bin_replace_message (GstBin * bin, GstMessage * message, GstMessageType types)
 917 {
 918   GList *previous;
 919   GstObject *src;
 920   gboolean res = TRUE;
 921
 922   if ((src = GST_MESSAGE_SRC (message))) {
 923     /* first find the previous message posted by this element */
 924     if ((previous = find_message (bin, src, types))) {
 925       GstMessage *previous_msg;
 926
 927       /* if we found a previous message, replace it */
 928       previous_msg = previous->data;
 929       previous->data = message;
 930
 931       GST_DEBUG_OBJECT (bin, "replace old message %s from %s with %s message",
 932           GST_MESSAGE_TYPE_NAME (previous_msg), GST_ELEMENT_NAME (src),
 933           GST_MESSAGE_TYPE_NAME (message));
 934
 935       gst_message_unref (previous_msg);
 936     } else {
 937       /* keep new message */
 938       bin->messages = g_list_prepend (bin->messages, message);
 939
 940       GST_DEBUG_OBJECT (bin, "got new message %p, %s from %s",
 941           message, GST_MESSAGE_TYPE_NAME (message), GST_ELEMENT_NAME (src));
 942     }
 943   } else {
 944     GST_DEBUG_OBJECT (bin, "got message %s from (NULL), not processing",
 945         GST_MESSAGE_TYPE_NAME (message));
 946     res = FALSE;
 947     gst_message_unref (message);
 948   }
 949   return res;
 950 }
 951
 952 /* with LOCK. Remove all messages of given types */
 953 static void
 954 bin_remove_messages (GstBin * bin, GstObject * src, GstMessageType types)
 955 {
 956   MessageFind find;
 957   GList *walk, *next;
 958
 959   find.src = src;
 960   find.types = types;
 961
 962   for (walk = bin->messages; walk; walk = next) {
 963     GstMessage *message = (GstMessage *) walk->data;
 964
 965     next = g_list_next (walk);
 966
 967     if (message_check (message, &find) == 0) {
 968       GST_DEBUG_OBJECT (GST_MESSAGE_SRC (message),
 969           "deleting message %p of types 0x%08x", message, types);
 970       bin->messages = g_list_delete_link (bin->messages, walk);
 971       gst_message_unref (message);
 972     } else {
 973       GST_DEBUG_OBJECT (GST_MESSAGE_SRC (message),
 974           "not deleting message %p of type 0x%08x", message,
 975           GST_MESSAGE_TYPE (message));
 976     }
 977   }
 978 }
 979
 980
 981 /* Check if the bin is EOS. We do this by scanning all sinks and
 982  * checking if they posted an EOS message.
 983  *
 984  * call with bin LOCK */
 985 static gboolean
 986 is_eos (GstBin * bin, guint32 * seqnum)
 987 {
 988   gboolean result;
 989   gint n_eos = 0;
 990   GList *walk, *msgs;
 991
 992   result = TRUE;
 993   for (walk = bin->children; walk; walk = g_list_next (walk)) {
 994     GstElement *element;
 995
 996     element = GST_ELEMENT_CAST (walk->data);
 997     if (bin_element_is_sink (element, bin) == 0) {
 998       /* check if element posted EOS */
 999       if ((msgs =
1000               find_message (bin, GST_OBJECT_CAST (element), GST_MESSAGE_EOS))) {
1001         GST_DEBUG ("sink '%s' posted EOS", GST_ELEMENT_NAME (element));
1002         *seqnum = gst_message_get_seqnum (GST_MESSAGE_CAST (msgs->data));
1003         n_eos++;
1004       } else {
1005         GST_DEBUG ("sink '%s' did not post EOS yet",
1006             GST_ELEMENT_NAME (element));
1007         result = FALSE;
1008         break;
1009       }
1010     }
1011   }
1012   /* FIXME: Some tests (e.g. elements/capsfilter) use
1013    * pipelines with a dangling sinkpad but no sink element.
1014    * These tests assume that no EOS message is ever
1015    * posted on the bus so let's keep that behaviour.
1016    * In valid pipelines this doesn't make a difference.
1017    */
1018   return result && n_eos > 0;
1019 }
1020
1021 static void
1022 unlink_pads (const GValue * item, gpointer user_data)
1023 {
1024   GstPad *pad;
1025   GstPad *peer;
1026
1027   pad = g_value_get_object (item);
1028
1029   if ((peer = gst_pad_get_peer (pad))) {
1030     if (gst_pad_get_direction (pad) == GST_PAD_SRC)
1031       gst_pad_unlink (pad, peer);
1032     else
1033       gst_pad_unlink (peer, pad);
1034     gst_object_unref (peer);
1035   }
1036 }
1037
1038 /* vmethod that adds an element to a bin
1039  *
1040  * MT safe
1041  */
1042 static gboolean
1043 gst_bin_add_func (GstBin * bin, GstElement * element)
1044 {
1045   gchar *elem_name;
1046   GstIterator *it;
1047   gboolean is_sink, is_source;
1048   GstMessage *clock_message = NULL, *async_message = NULL;
1049   GstStateChangeReturn ret;
1050
1051   GST_DEBUG_OBJECT (bin, "element :%s", GST_ELEMENT_NAME (element));
1052
1053   /* we obviously can't add ourself to ourself */
1054   if (G_UNLIKELY (GST_ELEMENT_CAST (element) == GST_ELEMENT_CAST (bin)))
1055     goto adding_itself;
1056
1057   /* get the element name to make sure it is unique in this bin. */
1058   GST_OBJECT_LOCK (element);
1059   elem_name = g_strdup (GST_ELEMENT_NAME (element));
1060   is_sink = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_IS_SINK);
1061   is_source = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_IS_SOURCE);
1062   GST_OBJECT_UNLOCK (element);
1063
1064   GST_OBJECT_LOCK (bin);
1065
1066   /* then check to see if the element's name is already taken in the bin,
1067    * we can safely take the lock here. This check is probably bogus because
1068    * you can safely change the element name after this check and before setting
1069    * the object parent. The window is very small though... */
1070   if (G_UNLIKELY (!gst_object_check_uniqueness (bin->children, elem_name)))
1071     goto duplicate_name;
1072
1073   /* set the element's parent and add the element to the bin's list of children */
1074   if (G_UNLIKELY (!gst_object_set_parent (GST_OBJECT_CAST (element),
1075               GST_OBJECT_CAST (bin))))
1076     goto had_parent;
1077
1078   /* if we add a sink we become a sink */
1079   if (is_sink) {
1080     GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "element \"%s\" was sink",
1081         elem_name);
1082     GST_OBJECT_FLAG_SET (bin, GST_ELEMENT_IS_SINK);
1083   }
1084   if (is_source) {
1085     GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "element \"%s\" was source",
1086         elem_name);
1087     GST_OBJECT_FLAG_SET (bin, GST_ELEMENT_IS_SOURCE);
1088   }
1089   if (gst_element_provides_clock (element)) {
1090     GST_DEBUG_OBJECT (bin, "element \"%s\" can provide a clock", elem_name);
1091     clock_message =
1092         gst_message_new_clock_provide (GST_OBJECT_CAST (element), NULL, TRUE);
1093   }
1094
1095   bin->children = g_list_prepend (bin->children, element);
1096   bin->numchildren++;
1097   bin->children_cookie++;
1098   bin->priv->structure_cookie++;
1099
1100   /* distribute the bus */
1101   gst_element_set_bus (element, bin->child_bus);
1102
1103   /* propagate the current base_time, start_time and clock */
1104   gst_element_set_base_time (element, GST_ELEMENT_CAST (bin)->base_time);
1105   gst_element_set_start_time (element, GST_ELEMENT_START_TIME (bin));
1106   /* it's possible that the element did not accept the clock but
1107    * that is not important right now. When the pipeline goes to PLAYING,
1108    * a new clock will be selected */
1109   gst_element_set_clock (element, GST_ELEMENT_CLOCK (bin));
1110   /* set the cached index on the children */
1111   if (bin->priv->index)
1112     gst_element_set_index (element, bin->priv->index);
1113
1114   ret = GST_STATE_RETURN (bin);
1115   /* no need to update the state if we are in error */
1116   if (ret == GST_STATE_CHANGE_FAILURE)
1117     goto no_state_recalc;
1118
1119   /* update the bin state, the new element could have been an ASYNC or
1120    * NO_PREROLL element */
1121   ret = GST_STATE_RETURN (element);
1122   GST_DEBUG_OBJECT (bin, "added %s element",
1123       gst_element_state_change_return_get_name (ret));
1124
1125   switch (ret) {
1126     case GST_STATE_CHANGE_ASYNC:
1127     {
1128       /* create message to track this aync element when it posts an async-done
1129        * message */
1130       async_message =
1131           gst_message_new_async_start (GST_OBJECT_CAST (element), FALSE);
1132       break;
1133     }
1134     case GST_STATE_CHANGE_NO_PREROLL:
1135       /* ignore all async elements we might have and commit our state */
1136       bin_handle_async_done (bin, ret, FALSE);
1137       break;
1138     case GST_STATE_CHANGE_FAILURE:
1139       break;
1140     default:
1141       break;
1142   }
1143
1144 no_state_recalc:
1145   GST_OBJECT_UNLOCK (bin);
1146
1147   /* post the messages on the bus of the element so that the bin can handle
1148    * them */
1149   if (clock_message)
1150     gst_element_post_message (GST_ELEMENT_CAST (element), clock_message);
1151
1152   if (async_message)
1153     gst_element_post_message (GST_ELEMENT_CAST (element), async_message);
1154
1155   /* unlink all linked pads */
1156   it = gst_element_iterate_pads (element);
1157   gst_iterator_foreach (it, (GstIteratorForeachFunction) unlink_pads, NULL);
1158   gst_iterator_free (it);
1159
1160   GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "added element \"%s\"",
1161       elem_name);
1162   g_free (elem_name);
1163
1164   g_signal_emit (bin, gst_bin_signals[ELEMENT_ADDED], 0, element);
1165   gst_child_proxy_child_added ((GstObject *) bin, (GstObject *) element);
1166
1167   return TRUE;
1168
1169   /* ERROR handling here */
1170 adding_itself:
1171   {
1172     GST_OBJECT_LOCK (bin);
1173     g_warning ("Cannot add bin '%s' to itself", GST_ELEMENT_NAME (bin));
1174     GST_OBJECT_UNLOCK (bin);
1175     return FALSE;
1176   }
1177 duplicate_name:
1178   {
1179     g_warning ("Name '%s' is not unique in bin '%s', not adding",
1180         elem_name, GST_ELEMENT_NAME (bin));
1181     GST_OBJECT_UNLOCK (bin);
1182     g_free (elem_name);
1183     return FALSE;
1184   }
1185 had_parent:
1186   {
1187     g_warning ("Element '%s' already has parent", elem_name);
1188     GST_OBJECT_UNLOCK (bin);
1189     g_free (elem_name);
1190     return FALSE;
1191   }
1192 }
1193
1194 /**
1195  * gst_bin_add:
1196  * @bin: a #GstBin
1197  * @element: (transfer full): the #GstElement to add
1198  *
1199  * Adds the given element to the bin.  Sets the element's parent, and thus
1200  * takes ownership of the element. An element can only be added to one bin.
1201  *
1202  * If the element's pads are linked to other pads, the pads will be unlinked
1203  * before the element is added to the bin.
1204  *
1205  * <note>
1206  * When you add an element to an already-running pipeline, you will have to
1207  * take care to set the state of the newly-added element to the desired
1208  * state (usually PLAYING or PAUSED, same you set the pipeline to originally)
1209  * with gst_element_set_state(), or use gst_element_sync_state_with_parent().
1210  * The bin or pipeline will not take care of this for you.
1211  * </note>
1212  *
1213  * MT safe.
1214  *
1215  * Returns: TRUE if the element could be added, FALSE if
1216  * the bin does not want to accept the element.
1217  */
1218 gboolean
1219 gst_bin_add (GstBin * bin, GstElement * element)
1220 {
1221   GstBinClass *bclass;
1222   gboolean result;
1223
1224   g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
1225   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1226
1227   bclass = GST_BIN_GET_CLASS (bin);
1228
1229   if (G_UNLIKELY (bclass->add_element == NULL))
1230     goto no_function;
1231
1232   GST_CAT_DEBUG (GST_CAT_PARENTAGE, "adding element %s to bin %s",
1233       GST_STR_NULL (GST_ELEMENT_NAME (element)),
1234       GST_STR_NULL (GST_ELEMENT_NAME (bin)));
1235
1236   result = bclass->add_element (bin, element);
1237
1238   return result;
1239
1240   /* ERROR handling */
1241 no_function:
1242   {
1243     g_warning ("adding elements to bin '%s' is not supported",
1244         GST_ELEMENT_NAME (bin));
1245     return FALSE;
1246   }
1247 }
1248
1249 /* remove an element from the bin
1250  *
1251  * MT safe
1252  */
1253 static gboolean
1254 gst_bin_remove_func (GstBin * bin, GstElement * element)
1255 {
1256   gchar *elem_name;
1257   GstIterator *it;
1258   gboolean is_sink, is_source, othersink, othersource, found;
1259   GstMessage *clock_message = NULL;
1260   GstClock **provided_clock_p;
1261   GstElement **clock_provider_p;
1262   GList *walk, *next;
1263   gboolean other_async, this_async, have_no_preroll;
1264   GstStateChangeReturn ret;
1265
1266   GST_DEBUG_OBJECT (bin, "element :%s", GST_ELEMENT_NAME (element));
1267
1268   GST_OBJECT_LOCK (element);
1269   /* Check if the element is already being removed and immediately
1270    * return */
1271   if (G_UNLIKELY (GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_UNPARENTING)))
1272     goto already_removing;
1273
1274   GST_OBJECT_FLAG_SET (element, GST_ELEMENT_UNPARENTING);
1275   /* grab element name so we can print it */
1276   elem_name = g_strdup (GST_ELEMENT_NAME (element));
1277   is_sink = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_IS_SINK);
1278   is_source = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_IS_SOURCE);
1279   GST_OBJECT_UNLOCK (element);
1280
1281   /* unlink all linked pads */
1282   it = gst_element_iterate_pads (element);
1283   gst_iterator_foreach (it, (GstIteratorForeachFunction) unlink_pads, NULL);
1284   gst_iterator_free (it);
1285
1286   GST_OBJECT_LOCK (bin);
1287   found = FALSE;
1288   othersink = FALSE;
1289   othersource = FALSE;
1290   have_no_preroll = FALSE;
1291   /* iterate the elements, we collect which ones are async and no_preroll. We
1292    * also remove the element when we find it. */
1293   for (walk = bin->children; walk; walk = next) {
1294     GstElement *child = GST_ELEMENT_CAST (walk->data);
1295
1296     next = g_list_next (walk);
1297
1298     if (child == element) {
1299       found = TRUE;
1300       /* remove the element */
1301       bin->children = g_list_delete_link (bin->children, walk);
1302     } else {
1303       gboolean child_sink, child_source;
1304
1305       GST_OBJECT_LOCK (child);
1306       child_sink = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_IS_SINK);
1307       child_source = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_IS_SOURCE);
1308       /* when we remove a sink, check if there are other sinks. */
1309       if (is_sink && !othersink && child_sink)
1310         othersink = TRUE;
1311       if (is_source && !othersource && child_source)
1312         othersource = TRUE;
1313       /* check if we have NO_PREROLL children */
1314       if (GST_STATE_RETURN (child) == GST_STATE_CHANGE_NO_PREROLL)
1315         have_no_preroll = TRUE;
1316       GST_OBJECT_UNLOCK (child);
1317     }
1318   }
1319
1320   /* the element must have been in the bin's list of children */
1321   if (G_UNLIKELY (!found))
1322     goto not_in_bin;
1323
1324   /* we now removed the element from the list of elements, increment the cookie
1325    * so that others can detect a change in the children list. */
1326   bin->numchildren--;
1327   bin->children_cookie++;
1328   bin->priv->structure_cookie++;
1329
1330   if (is_sink && !othersink) {
1331     /* we're not a sink anymore */
1332     GST_DEBUG_OBJECT (bin, "we removed the last sink");
1333     GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_IS_SINK);
1334   }
1335   if (is_source && !othersource) {
1336     /* we're not a source anymore */
1337     GST_DEBUG_OBJECT (bin, "we removed the last source");
1338     GST_OBJECT_FLAG_UNSET (bin, GST_ELEMENT_IS_SOURCE);
1339   }
1340
1341
1342   /* if the clock provider for this element is removed, we lost
1343    * the clock as well, we need to inform the parent of this
1344    * so that it can select a new clock */
1345   if (bin->clock_provider == element) {
1346     GST_DEBUG_OBJECT (bin, "element \"%s\" provided the clock", elem_name);
1347     bin->clock_dirty = TRUE;
1348     clock_message =
1349         gst_message_new_clock_lost (GST_OBJECT_CAST (bin), bin->provided_clock);
1350     provided_clock_p = &bin->provided_clock;
1351     clock_provider_p = &bin->clock_provider;
1352     gst_object_replace ((GstObject **) provided_clock_p, NULL);
1353     gst_object_replace ((GstObject **) clock_provider_p, NULL);
1354   }
1355
1356   /* remove messages for the element, if there was a pending ASYNC_START
1357    * message we must see if removing the element caused the bin to lose its
1358    * async state. */
1359   this_async = FALSE;
1360   other_async = FALSE;
1361   for (walk = bin->messages; walk; walk = next) {
1362     GstMessage *message = (GstMessage *) walk->data;
1363     GstElement *src = GST_ELEMENT_CAST (GST_MESSAGE_SRC (message));
1364     gboolean remove;
1365
1366     next = g_list_next (walk);
1367     remove = FALSE;
1368
1369     switch (GST_MESSAGE_TYPE (message)) {
1370       case GST_MESSAGE_ASYNC_START:
1371         if (src == element)
1372           this_async = TRUE;
1373         else
1374           other_async = TRUE;
1375
1376         GST_DEBUG_OBJECT (src, "looking at message %p", message);
1377         break;
1378       case GST_MESSAGE_STRUCTURE_CHANGE:
1379       {
1380         GstElement *owner;
1381
1382         GST_DEBUG_OBJECT (src, "looking at structure change message %p",
1383             message);
1384         /* it's unlikely that this message is still in the list of messages
1385          * because this would mean that a link/unlink is busy in another thread
1386          * while we remove the element. We still have to remove the message
1387          * because we might not receive the done message anymore when the element
1388          * is removed from the bin. */
1389         gst_message_parse_structure_change (message, NULL, &owner, NULL);
1390         if (owner == element)
1391           remove = TRUE;
1392         break;
1393       }
1394       default:
1395         break;
1396     }
1397     if (src == element)
1398       remove = TRUE;
1399
1400     if (remove) {
1401       /* delete all message types */
1402       GST_DEBUG_OBJECT (src, "deleting message %p of element \"%s\"",
1403           message, elem_name);
1404       bin->messages = g_list_delete_link (bin->messages, walk);
1405       gst_message_unref (message);
1406     }
1407   }
1408
1409   /* get last return */
1410   ret = GST_STATE_RETURN (bin);
1411
1412   /* no need to update the state if we are in error */
1413   if (ret == GST_STATE_CHANGE_FAILURE)
1414     goto no_state_recalc;
1415
1416   if (!other_async && this_async) {
1417     /* all other elements were not async and we removed the async one,
1418      * handle the async-done case because we are not async anymore now. */
1419     GST_DEBUG_OBJECT (bin,
1420         "we removed the last async element, have no_preroll %d",
1421         have_no_preroll);
1422
1423     /* the current state return of the bin depends on if there are no_preroll
1424      * elements in the pipeline or not */
1425     if (have_no_preroll)
1426       ret = GST_STATE_CHANGE_NO_PREROLL;
1427     else
1428       ret = GST_STATE_CHANGE_SUCCESS;
1429
1430     bin_handle_async_done (bin, ret, FALSE);
1431   } else {
1432     GST_DEBUG_OBJECT (bin,
1433         "recalc state preroll: %d, other async: %d, this async %d",
1434         have_no_preroll, other_async, this_async);
1435
1436     if (have_no_preroll) {
1437       ret = GST_STATE_CHANGE_NO_PREROLL;
1438     } else if (other_async) {
1439       /* there are other async elements and we were not doing an async state
1440        * change, change our pending state and go async */
1441       if (GST_STATE_PENDING (bin) == GST_STATE_VOID_PENDING) {
1442         GST_STATE_NEXT (bin) = GST_STATE (bin);
1443         GST_STATE_PENDING (bin) = GST_STATE (bin);
1444       }
1445       ret = GST_STATE_CHANGE_ASYNC;
1446     }
1447     GST_STATE_RETURN (bin) = ret;
1448   }
1449 no_state_recalc:
1450   GST_OBJECT_UNLOCK (bin);
1451
1452   if (clock_message)
1453     gst_element_post_message (GST_ELEMENT_CAST (bin), clock_message);
1454
1455   GST_CAT_INFO_OBJECT (GST_CAT_PARENTAGE, bin, "removed child \"%s\"",
1456       elem_name);
1457   g_free (elem_name);
1458
1459   gst_element_set_bus (element, NULL);
1460
1461   /* Clear the clock we provided to the element */
1462   gst_element_set_clock (element, NULL);
1463
1464   /* we ref here because after the _unparent() the element can be disposed
1465    * and we still need it to reset the UNPARENTING flag and fire a signal. */
1466   gst_object_ref (element);
1467   gst_object_unparent (GST_OBJECT_CAST (element));
1468
1469   GST_OBJECT_LOCK (element);
1470   GST_OBJECT_FLAG_UNSET (element, GST_ELEMENT_UNPARENTING);
1471   GST_OBJECT_UNLOCK (element);
1472
1473   g_signal_emit (bin, gst_bin_signals[ELEMENT_REMOVED], 0, element);
1474   gst_child_proxy_child_removed ((GstObject *) bin, (GstObject *) element);
1475
1476   /* element is really out of our control now */
1477   gst_object_unref (element);
1478
1479   return TRUE;
1480
1481   /* ERROR handling */
1482 not_in_bin:
1483   {
1484     g_warning ("Element '%s' is not in bin '%s'", elem_name,
1485         GST_ELEMENT_NAME (bin));
1486     GST_OBJECT_UNLOCK (bin);
1487     g_free (elem_name);
1488     return FALSE;
1489   }
1490 already_removing:
1491   {
1492     GST_CAT_INFO_OBJECT (GST_CAT_PARENTAGE, bin, "already removing child");
1493     GST_OBJECT_UNLOCK (element);
1494     return FALSE;
1495   }
1496 }
1497
1498 /**
1499  * gst_bin_remove:
1500  * @bin: a #GstBin
1501  * @element: (transfer none): the #GstElement to remove
1502  *
1503  * Removes the element from the bin, unparenting it as well.
1504  * Unparenting the element means that the element will be dereferenced,
1505  * so if the bin holds the only reference to the element, the element
1506  * will be freed in the process of removing it from the bin.  If you
1507  * want the element to still exist after removing, you need to call
1508  * gst_object_ref() before removing it from the bin.
1509  *
1510  * If the element's pads are linked to other pads, the pads will be unlinked
1511  * before the element is removed from the bin.
1512  *
1513  * MT safe.
1514  *
1515  * Returns: TRUE if the element could be removed, FALSE if
1516  * the bin does not want to remove the element.
1517  */
1518 gboolean
1519 gst_bin_remove (GstBin * bin, GstElement * element)
1520 {
1521   GstBinClass *bclass;
1522   gboolean result;
1523
1524   g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
1525   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1526
1527   bclass = GST_BIN_GET_CLASS (bin);
1528
1529   if (G_UNLIKELY (bclass->remove_element == NULL))
1530     goto no_function;
1531
1532   GST_CAT_DEBUG (GST_CAT_PARENTAGE, "removing element %s from bin %s",
1533       GST_ELEMENT_NAME (element), GST_ELEMENT_NAME (bin));
1534
1535   result = bclass->remove_element (bin, element);
1536
1537   return result;
1538
1539   /* ERROR handling */
1540 no_function:
1541   {
1542     g_warning ("removing elements from bin '%s' is not supported",
1543         GST_ELEMENT_NAME (bin));
1544     return FALSE;
1545   }
1546 }
1547
1548 /**
1549  * gst_bin_iterate_elements:
1550  * @bin: a #GstBin
1551  *
1552  * Gets an iterator for the elements in this bin.
1553  *
1554  * Each element yielded by the iterator will have its refcount increased, so
1555  * unref after use.
1556  *
1557  * MT safe.  Caller owns returned value.
1558  *
1559  * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1560  */
1561 GstIterator *
1562 gst_bin_iterate_elements (GstBin * bin)
1563 {
1564   GstIterator *result;
1565
1566   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1567
1568   GST_OBJECT_LOCK (bin);
1569   result = gst_iterator_new_list (GST_TYPE_ELEMENT,
1570       GST_OBJECT_GET_LOCK (bin),
1571       &bin->children_cookie, &bin->children, (GObject *) bin, NULL);
1572   GST_OBJECT_UNLOCK (bin);
1573
1574   return result;
1575 }
1576
1577 static GstIteratorItem
1578 iterate_child_recurse (GstIterator * it, const GValue * item)
1579 {
1580   GstElement *child = g_value_get_object (item);
1581
1582   if (GST_IS_BIN (child)) {
1583     GstIterator *other = gst_bin_iterate_recurse (GST_BIN_CAST (child));
1584
1585     gst_iterator_push (it, other);
1586   }
1587   return GST_ITERATOR_ITEM_PASS;
1588 }
1589
1590 /**
1591  * gst_bin_iterate_recurse:
1592  * @bin: a #GstBin
1593  *
1594  * Gets an iterator for the elements in this bin.
1595  * This iterator recurses into GstBin children.
1596  *
1597  * Each element yielded by the iterator will have its refcount increased, so
1598  * unref after use.
1599  *
1600  * MT safe.  Caller owns returned value.
1601  *
1602  * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1603  */
1604 GstIterator *
1605 gst_bin_iterate_recurse (GstBin * bin)
1606 {
1607   GstIterator *result;
1608
1609   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1610
1611   GST_OBJECT_LOCK (bin);
1612   result = gst_iterator_new_list (GST_TYPE_ELEMENT,
1613       GST_OBJECT_GET_LOCK (bin),
1614       &bin->children_cookie,
1615       &bin->children,
1616       (GObject *) bin, (GstIteratorItemFunction) iterate_child_recurse);
1617   GST_OBJECT_UNLOCK (bin);
1618
1619   return result;
1620 }
1621
1622 /* returns 0 when TRUE because this is a GCompareFunc */
1623 /* MT safe */
1624 static gint
1625 bin_element_is_sink (GstElement * child, GstBin * bin)
1626 {
1627   gboolean is_sink;
1628
1629   /* we lock the child here for the remainder of the function to
1630    * get its name and flag safely. */
1631   GST_OBJECT_LOCK (child);
1632   is_sink = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_IS_SINK);
1633
1634   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
1635       "child %s %s sink", GST_OBJECT_NAME (child), is_sink ? "is" : "is not");
1636
1637   GST_OBJECT_UNLOCK (child);
1638   return is_sink ? 0 : 1;
1639 }
1640
1641 static gint
1642 sink_iterator_filter (const GValue * vchild, GValue * vbin)
1643 {
1644   GstBin *bin = g_value_get_object (vbin);
1645   GstElement *child = g_value_get_object (vchild);
1646
1647   return (bin_element_is_sink (child, bin));
1648 }
1649
1650 /**
1651  * gst_bin_iterate_sinks:
1652  * @bin: a #GstBin
1653  *
1654  * Gets an iterator for all elements in the bin that have the
1655  * #GST_ELEMENT_IS_SINK flag set.
1656  *
1657  * Each element yielded by the iterator will have its refcount increased, so
1658  * unref after use.
1659  *
1660  * MT safe.  Caller owns returned value.
1661  *
1662  * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1663  */
1664 GstIterator *
1665 gst_bin_iterate_sinks (GstBin * bin)
1666 {
1667   GstIterator *children;
1668   GstIterator *result;
1669   GValue vbin = { 0, };
1670
1671   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1672
1673   g_value_init (&vbin, GST_TYPE_BIN);
1674   g_value_set_object (&vbin, bin);
1675
1676   children = gst_bin_iterate_elements (bin);
1677   result = gst_iterator_filter (children,
1678       (GCompareFunc) sink_iterator_filter, &vbin);
1679
1680   g_value_unset (&vbin);
1681
1682   return result;
1683 }
1684
1685 /* returns 0 when TRUE because this is a GCompareFunc */
1686 /* MT safe */
1687 static gint
1688 bin_element_is_src (GstElement * child, GstBin * bin)
1689 {
1690   gboolean is_src;
1691
1692   /* we lock the child here for the remainder of the function to
1693    * get its name and other info safely. */
1694   GST_OBJECT_LOCK (child);
1695   is_src = GST_OBJECT_FLAG_IS_SET (child, GST_ELEMENT_IS_SOURCE);
1696
1697   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
1698       "child %s %s src", GST_OBJECT_NAME (child), is_src ? "is" : "is not");
1699
1700   GST_OBJECT_UNLOCK (child);
1701   return is_src ? 0 : 1;
1702 }
1703
1704 static gint
1705 src_iterator_filter (const GValue * vchild, GValue * vbin)
1706 {
1707   GstBin *bin = g_value_get_object (vbin);
1708   GstElement *child = g_value_get_object (vchild);
1709
1710   return (bin_element_is_src (child, bin));
1711 }
1712
1713 /**
1714  * gst_bin_iterate_sources:
1715  * @bin: a #GstBin
1716  *
1717  * Gets an iterator for all elements in the bin that have the
1718  * #GST_ELEMENT_IS_SOURCE flag set.
1719  *
1720  * Each element yielded by the iterator will have its refcount increased, so
1721  * unref after use.
1722  *
1723  * MT safe.  Caller owns returned value.
1724  *
1725  * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
1726  */
1727 GstIterator *
1728 gst_bin_iterate_sources (GstBin * bin)
1729 {
1730   GstIterator *children;
1731   GstIterator *result;
1732   GValue vbin = { 0, };
1733
1734   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
1735
1736   g_value_init (&vbin, GST_TYPE_BIN);
1737   g_value_set_object (&vbin, bin);
1738
1739   children = gst_bin_iterate_elements (bin);
1740   result = gst_iterator_filter (children,
1741       (GCompareFunc) src_iterator_filter, &vbin);
1742
1743   g_value_unset (&vbin);
1744
1745   return result;
1746 }
1747
1748 /*
1749  * MT safe
1750  */
1751 static GstStateChangeReturn
1752 gst_bin_get_state_func (GstElement * element, GstState * state,
1753     GstState * pending, GstClockTime timeout)
1754 {
1755   GstStateChangeReturn ret;
1756
1757   GST_CAT_INFO_OBJECT (GST_CAT_STATES, element, "getting state");
1758
1759   ret =
1760       GST_ELEMENT_CLASS (parent_class)->get_state (element, state, pending,
1761       timeout);
1762
1763   return ret;
1764 }
1765
1766 /***********************************************
1767  * Topologically sorted iterator
1768  * see http://en.wikipedia.org/wiki/Topological_sorting
1769  *
1770  * For each element in the graph, an entry is kept in a HashTable
1771  * with its number of srcpad connections (degree).
1772  * We then change state of all elements without dependencies
1773  * (degree 0) and decrement the degree of all elements connected
1774  * on the sinkpads. When an element reaches degree 0, its state is
1775  * changed next.
1776  * When all elements are handled the algorithm stops.
1777  */
1778 typedef struct _GstBinSortIterator
1779 {
1780   GstIterator it;
1781   GQueue *queue;                /* elements queued for state change */
1782   GstBin *bin;                  /* bin we iterate */
1783   gint mode;                    /* adding or removing dependency */
1784   GstElement *best;             /* next element with least dependencies */
1785   gint best_deg;                /* best degree */
1786   GHashTable *hash;             /* hashtable with element dependencies */
1787   gboolean dirty;               /* we detected structure change */
1788 } GstBinSortIterator;
1789
1790 static void
1791 gst_bin_sort_iterator_copy (const GstBinSortIterator * it,
1792     GstBinSortIterator * copy)
1793 {
1794   GHashTableIter iter;
1795   gpointer key, value;
1796
1797   copy->queue = g_queue_copy (it->queue);
1798   g_queue_foreach (copy->queue, (GFunc) gst_object_ref, NULL);
1799
1800   copy->bin = gst_object_ref (it->bin);
1801   if (it->best)
1802     copy->best = gst_object_ref (it->best);
1803
1804   copy->hash = g_hash_table_new (NULL, NULL);
1805   g_hash_table_iter_init (&iter, it->hash);
1806   while (g_hash_table_iter_next (&iter, &key, &value))
1807     g_hash_table_insert (copy->hash, key, value);
1808 }
1809
1810 /* we add and subtract 1 to make sure we don't confuse NULL and 0 */
1811 #define HASH_SET_DEGREE(bit, elem, deg) \
1812     g_hash_table_replace (bit->hash, elem, GINT_TO_POINTER(deg+1))
1813 #define HASH_GET_DEGREE(bit, elem) \
1814     (GPOINTER_TO_INT(g_hash_table_lookup (bit->hash, elem))-1)
1815
1816 /* add element to queue of next elements in the iterator.
1817  * We push at the tail to give higher priority elements a
1818  * chance first */
1819 static void
1820 add_to_queue (GstBinSortIterator * bit, GstElement * element)
1821 {
1822   GST_DEBUG_OBJECT (bit->bin, "adding '%s' to queue",
1823       GST_ELEMENT_NAME (element));
1824   gst_object_ref (element);
1825   g_queue_push_tail (bit->queue, element);
1826   HASH_SET_DEGREE (bit, element, -1);
1827 }
1828
1829 static void
1830 remove_from_queue (GstBinSortIterator * bit, GstElement * element)
1831 {
1832   GList *find;
1833
1834   if ((find = g_queue_find (bit->queue, element))) {
1835     GST_DEBUG_OBJECT (bit->bin, "removing '%s' from queue",
1836         GST_ELEMENT_NAME (element));
1837
1838     g_queue_delete_link (bit->queue, find);
1839     gst_object_unref (element);
1840   } else {
1841     GST_DEBUG_OBJECT (bit->bin, "unable to remove '%s' from queue",
1842         GST_ELEMENT_NAME (element));
1843   }
1844 }
1845
1846 /* clear the queue, unref all objects as we took a ref when
1847  * we added them to the queue */
1848 static void
1849 clear_queue (GQueue * queue)
1850 {
1851   gpointer p;
1852
1853   while ((p = g_queue_pop_head (queue)))
1854     gst_object_unref (p);
1855 }
1856
1857 /* set all degrees to 0. Elements marked as a sink are
1858  * added to the queue immediatly. Since we only look at the SINK flag of the
1859  * element, it is possible that we add non-sinks to the queue. These will be
1860  * removed from the queue again when we can prove that it provides data for some
1861  * other element. */
1862 static void
1863 reset_degree (GstElement * element, GstBinSortIterator * bit)
1864 {
1865   gboolean is_sink;
1866
1867   /* sinks are added right away */
1868   GST_OBJECT_LOCK (element);
1869   is_sink = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_IS_SINK);
1870   GST_OBJECT_UNLOCK (element);
1871
1872   if (is_sink) {
1873     add_to_queue (bit, element);
1874   } else {
1875     /* others are marked with 0 and handled when sinks are done */
1876     HASH_SET_DEGREE (bit, element, 0);
1877   }
1878 }
1879
1880 /* adjust the degree of all elements connected to the given
1881  * element. If a degree of an element drops to 0, it is
1882  * added to the queue of elements to schedule next.
1883  *
1884  * We have to make sure not to cross the bin boundary this element
1885  * belongs to.
1886  */
1887 static void
1888 update_degree (GstElement * element, GstBinSortIterator * bit)
1889 {
1890   gboolean linked = FALSE;
1891
1892   GST_OBJECT_LOCK (element);
1893   /* don't touch degree if element has no sinkpads */
1894   if (element->numsinkpads != 0) {
1895     /* loop over all sinkpads, decrement degree for all connected
1896      * elements in this bin */
1897     GList *pads;
1898
1899     for (pads = element->sinkpads; pads; pads = g_list_next (pads)) {
1900       GstPad *pad, *peer;
1901
1902       pad = GST_PAD_CAST (pads->data);
1903
1904       /* we're iterating over the sinkpads, check if it's busy in a link/unlink */
1905       if (G_UNLIKELY (find_message (bit->bin, GST_OBJECT_CAST (pad),
1906                   GST_MESSAGE_STRUCTURE_CHANGE))) {
1907         /* mark the iterator as dirty because we won't be updating the degree
1908          * of the peer parent now. This would result in the 'loop detected'
1909          * later on because the peer parent element could become the best next
1910          * element with a degree > 0. We will simply continue our state
1911          * changes and we'll eventually resync when the unlink completed and
1912          * the iterator cookie is updated. */
1913         bit->dirty = TRUE;
1914         continue;
1915       }
1916
1917       if ((peer = gst_pad_get_peer (pad))) {
1918         GstElement *peer_element;
1919
1920         if ((peer_element = gst_pad_get_parent_element (peer))) {
1921           GST_OBJECT_LOCK (peer_element);
1922           /* check that we don't go outside of this bin */
1923           if (GST_OBJECT_CAST (peer_element)->parent ==
1924               GST_OBJECT_CAST (bit->bin)) {
1925             gint old_deg, new_deg;
1926
1927             old_deg = HASH_GET_DEGREE (bit, peer_element);
1928
1929             /* check to see if we added an element as sink that was not really a
1930              * sink because it was connected to some other element. */
1931             if (old_deg == -1) {
1932               remove_from_queue (bit, peer_element);
1933               old_deg = 0;
1934             }
1935             new_deg = old_deg + bit->mode;
1936
1937             GST_DEBUG_OBJECT (bit->bin,
1938                 "change element %s, degree %d->%d, linked to %s",
1939                 GST_ELEMENT_NAME (peer_element), old_deg, new_deg,
1940                 GST_ELEMENT_NAME (element));
1941
1942             /* update degree, it is possible that an element was in 0 and
1943              * reaches -1 here. This would mean that the element had no sinkpads
1944              * but became linked while the state change was happening. We will
1945              * resync on this with the structure change message. */
1946             if (new_deg == 0) {
1947               /* degree hit 0, add to queue */
1948               add_to_queue (bit, peer_element);
1949             } else {
1950               HASH_SET_DEGREE (bit, peer_element, new_deg);
1951             }
1952             linked = TRUE;
1953           }
1954           GST_OBJECT_UNLOCK (peer_element);
1955           gst_object_unref (peer_element);
1956         }
1957         gst_object_unref (peer);
1958       }
1959     }
1960   }
1961   if (!linked) {
1962     GST_DEBUG_OBJECT (bit->bin, "element %s not linked on any sinkpads",
1963         GST_ELEMENT_NAME (element));
1964   }
1965   GST_OBJECT_UNLOCK (element);
1966 }
1967
1968 /* find the next best element not handled yet. This is the one
1969  * with the lowest non-negative degree */
1970 static void
1971 find_element (GstElement * element, GstBinSortIterator * bit)
1972 {
1973   gint degree;
1974
1975   /* element is already handled */
1976   if ((degree = HASH_GET_DEGREE (bit, element)) < 0)
1977     return;
1978
1979   /* first element or element with smaller degree */
1980   if (bit->best == NULL || bit->best_deg > degree) {
1981     bit->best = element;
1982     bit->best_deg = degree;
1983   }
1984 }
1985
1986 /* get next element in iterator. the returned element has the
1987  * refcount increased */
1988 static GstIteratorResult
1989 gst_bin_sort_iterator_next (GstBinSortIterator * bit, GValue * result)
1990 {
1991   GstElement *best;
1992   GstBin *bin = bit->bin;
1993
1994   /* empty queue, we have to find a next best element */
1995   if (g_queue_is_empty (bit->queue)) {
1996
1997     bit->best = NULL;
1998     bit->best_deg = G_MAXINT;
1999     g_list_foreach (bin->children, (GFunc) find_element, bit);
2000     if ((best = bit->best)) {
2001       /* when we detected an unlink, don't warn because our degrees might be
2002        * screwed up. We will resync later */
2003       if (bit->best_deg != 0 && !bit->dirty) {
2004         /* we don't fail on this one yet */
2005         GST_WARNING_OBJECT (bin, "loop dected in graph");
2006         g_warning ("loop detected in the graph of bin '%s'!!",
2007             GST_ELEMENT_NAME (bin));
2008       }
2009       /* best unhandled element, schedule as next element */
2010       GST_DEBUG_OBJECT (bin, "queue empty, next best: %s",
2011           GST_ELEMENT_NAME (best));
2012       HASH_SET_DEGREE (bit, best, -1);
2013       g_value_set_object (result, best);
2014     } else {
2015       GST_DEBUG_OBJECT (bin, "queue empty, elements exhausted");
2016       /* no more unhandled elements, we are done */
2017       return GST_ITERATOR_DONE;
2018     }
2019   } else {
2020     /* everything added to the queue got reffed */
2021     best = g_queue_pop_head (bit->queue);
2022     g_value_set_object (result, best);
2023     gst_object_unref (best);
2024   }
2025
2026   GST_DEBUG_OBJECT (bin, "queue head gives %s", GST_ELEMENT_NAME (best));
2027   /* update degrees of linked elements */
2028   update_degree (best, bit);
2029
2030   return GST_ITERATOR_OK;
2031 }
2032
2033 /* clear queues, recalculate the degrees and restart. */
2034 static void
2035 gst_bin_sort_iterator_resync (GstBinSortIterator * bit)
2036 {
2037   GstBin *bin = bit->bin;
2038
2039   GST_DEBUG_OBJECT (bin, "resync");
2040   bit->dirty = FALSE;
2041   clear_queue (bit->queue);
2042   /* reset degrees */
2043   g_list_foreach (bin->children, (GFunc) reset_degree, bit);
2044   /* calc degrees, incrementing */
2045   bit->mode = 1;
2046   g_list_foreach (bin->children, (GFunc) update_degree, bit);
2047   /* for the rest of the function we decrement the degrees */
2048   bit->mode = -1;
2049 }
2050
2051 /* clear queues, unref bin and free iterator. */
2052 static void
2053 gst_bin_sort_iterator_free (GstBinSortIterator * bit)
2054 {
2055   GstBin *bin = bit->bin;
2056
2057   GST_DEBUG_OBJECT (bin, "free");
2058   clear_queue (bit->queue);
2059   g_queue_free (bit->queue);
2060   g_hash_table_destroy (bit->hash);
2061   gst_object_unref (bin);
2062 }
2063
2064 /* should be called with the bin LOCK held */
2065 static GstIterator *
2066 gst_bin_sort_iterator_new (GstBin * bin)
2067 {
2068   GstBinSortIterator *result;
2069
2070   /* we don't need an ItemFunction because we ref the items in the _next
2071    * method already */
2072   result = (GstBinSortIterator *)
2073       gst_iterator_new (sizeof (GstBinSortIterator),
2074       GST_TYPE_ELEMENT,
2075       GST_OBJECT_GET_LOCK (bin),
2076       &bin->priv->structure_cookie,
2077       (GstIteratorCopyFunction) gst_bin_sort_iterator_copy,
2078       (GstIteratorNextFunction) gst_bin_sort_iterator_next,
2079       (GstIteratorItemFunction) NULL,
2080       (GstIteratorResyncFunction) gst_bin_sort_iterator_resync,
2081       (GstIteratorFreeFunction) gst_bin_sort_iterator_free);
2082   result->queue = g_queue_new ();
2083   result->hash = g_hash_table_new (NULL, NULL);
2084   gst_object_ref (bin);
2085   result->bin = bin;
2086   gst_bin_sort_iterator_resync (result);
2087
2088   return (GstIterator *) result;
2089 }
2090
2091 /**
2092  * gst_bin_iterate_sorted:
2093  * @bin: a #GstBin
2094  *
2095  * Gets an iterator for the elements in this bin in topologically
2096  * sorted order. This means that the elements are returned from
2097  * the most downstream elements (sinks) to the sources.
2098  *
2099  * This function is used internally to perform the state changes
2100  * of the bin elements and for clock selection.
2101  *
2102  * Each element yielded by the iterator will have its refcount increased, so
2103  * unref after use.
2104  *
2105  * MT safe.  Caller owns returned value.
2106  *
2107  * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
2108  */
2109 GstIterator *
2110 gst_bin_iterate_sorted (GstBin * bin)
2111 {
2112   GstIterator *result;
2113
2114   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
2115
2116   GST_OBJECT_LOCK (bin);
2117   result = gst_bin_sort_iterator_new (bin);
2118   GST_OBJECT_UNLOCK (bin);
2119
2120   return result;
2121 }
2122
2123 static GstStateChangeReturn
2124 gst_bin_element_set_state (GstBin * bin, GstElement * element,
2125     GstClockTime base_time, GstClockTime start_time, GstState current,
2126     GstState next)
2127 {
2128   GstStateChangeReturn ret;
2129   GstState pending, child_current, child_pending;
2130   gboolean locked;
2131   GList *found;
2132
2133   GST_STATE_LOCK (element);
2134
2135   GST_OBJECT_LOCK (element);
2136   /* set base_time and start time on child */
2137   GST_ELEMENT_START_TIME (element) = start_time;
2138   element->base_time = base_time;
2139   /* peel off the locked flag */
2140   locked = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_LOCKED_STATE);
2141   /* Get the previous set_state result to preserve NO_PREROLL and ASYNC */
2142   ret = GST_STATE_RETURN (element);
2143   child_current = GST_STATE (element);
2144   child_pending = GST_STATE_PENDING (element);
2145   GST_OBJECT_UNLOCK (element);
2146
2147   /* skip locked elements */
2148   if (G_UNLIKELY (locked))
2149     goto locked;
2150
2151   /* if the element was no preroll, just start changing the state regardless
2152    * if it had async elements (in the case of a bin) because they won't preroll
2153    * anyway. */
2154   if (G_UNLIKELY (ret == GST_STATE_CHANGE_NO_PREROLL)) {
2155     GST_DEBUG_OBJECT (element, "element is NO_PREROLL, ignore async elements");
2156     goto no_preroll;
2157   }
2158
2159   GST_OBJECT_LOCK (bin);
2160   pending = GST_STATE_PENDING (bin);
2161
2162   /* Try not to change the state of elements that are already in the state we're
2163    * going to */
2164   if (!(next == GST_STATE_PLAYING || child_pending != GST_STATE_VOID_PENDING ||
2165           (child_pending == GST_STATE_VOID_PENDING &&
2166               ((pending > child_current && next > child_current) ||
2167                   (pending < child_current && next < child_current)))))
2168     goto unneeded;
2169
2170   /* the element was busy with an upwards async state change, we must wait for
2171    * an ASYNC_DONE message before we attemp to change the state. */
2172   if ((found =
2173           find_message (bin, GST_OBJECT_CAST (element),
2174               GST_MESSAGE_ASYNC_START))) {
2175 #ifndef GST_DISABLE_GST_DEBUG
2176     GstMessage *message = GST_MESSAGE_CAST (found->data);
2177
2178     GST_DEBUG_OBJECT (element, "element message %p, %s async busy",
2179         message, GST_ELEMENT_NAME (GST_MESSAGE_SRC (message)));
2180 #endif
2181     /* only wait for upward state changes */
2182     if (next > current) {
2183       /* We found an async element check if we can force its state to change or
2184        * if we have to wait for it to preroll. */
2185       if (G_UNLIKELY (!enable_latency)) {
2186         g_warning ("Future versions of GStreamer will wait for element \"%s\"\n"
2187             "\tto preroll in order to perform correct latency calculations.\n"
2188             "\tPlease verify that the application continues to work correctly by\n"
2189             "\tsetting the environment variable GST_COMPAT to a value containing\n"
2190             "\tthe string 'live-preroll'.", GST_ELEMENT_NAME (element));
2191         goto no_latency;
2192       }
2193       goto was_busy;
2194     }
2195   }
2196 no_latency:
2197   GST_OBJECT_UNLOCK (bin);
2198
2199 no_preroll:
2200   GST_DEBUG_OBJECT (bin,
2201       "setting element %s to %s, base_time %" GST_TIME_FORMAT,
2202       GST_ELEMENT_NAME (element), gst_element_state_get_name (next),
2203       GST_TIME_ARGS (base_time));
2204
2205   /* change state */
2206   ret = gst_element_set_state (element, next);
2207
2208   GST_STATE_UNLOCK (element);
2209
2210   return ret;
2211
2212 locked:
2213   {
2214     GST_DEBUG_OBJECT (element,
2215         "element is locked, return previous return %s",
2216         gst_element_state_change_return_get_name (ret));
2217     GST_STATE_UNLOCK (element);
2218     return ret;
2219   }
2220 was_busy:
2221   {
2222     GST_DEBUG_OBJECT (element, "element was busy, delaying state change");
2223     GST_OBJECT_UNLOCK (bin);
2224     GST_STATE_UNLOCK (element);
2225     return GST_STATE_CHANGE_ASYNC;
2226   }
2227 unneeded:
2228   {
2229     GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2230         "skipping transition from %s to  %s, since bin pending"
2231         " is %s : last change state return follows",
2232         gst_element_state_get_name (child_current),
2233         gst_element_state_get_name (next),
2234         gst_element_state_get_name (pending));
2235     GST_OBJECT_UNLOCK (bin);
2236     GST_STATE_UNLOCK (element);
2237     return ret;
2238   }
2239 }
2240
2241 /* gst_iterator_fold functions for pads_activate
2242  * Stop the iterator if activating one pad failed. */
2243 static gboolean
2244 activate_pads (const GValue * vpad, GValue * ret, gboolean * active)
2245 {
2246   GstPad *pad = g_value_get_object (vpad);
2247   gboolean cont = TRUE;
2248
2249   if (!(cont = gst_pad_set_active (pad, *active)))
2250     g_value_set_boolean (ret, FALSE);
2251
2252   return cont;
2253 }
2254
2255 /* returns false on error or early cutout of the fold, true if all
2256  * pads in @iter were (de)activated successfully. */
2257 static gboolean
2258 iterator_activate_fold_with_resync (GstIterator * iter, gpointer user_data)
2259 {
2260   GstIteratorResult ires;
2261   GValue ret = { 0 };
2262
2263   /* no need to unset this later, it's just a boolean */
2264   g_value_init (&ret, G_TYPE_BOOLEAN);
2265   g_value_set_boolean (&ret, TRUE);
2266
2267   while (1) {
2268     ires = gst_iterator_fold (iter, (GstIteratorFoldFunction) activate_pads,
2269         &ret, user_data);
2270     switch (ires) {
2271       case GST_ITERATOR_RESYNC:
2272         /* need to reset the result again */
2273         g_value_set_boolean (&ret, TRUE);
2274         gst_iterator_resync (iter);
2275         break;
2276       case GST_ITERATOR_DONE:
2277         /* all pads iterated, return collected value */
2278         goto done;
2279       default:
2280         /* iterator returned _ERROR or premature end with _OK,
2281          * mark an error and exit */
2282         g_value_set_boolean (&ret, FALSE);
2283         goto done;
2284     }
2285   }
2286 done:
2287   /* return collected value */
2288   return g_value_get_boolean (&ret);
2289 }
2290
2291 /* is called with STATE_LOCK
2292  */
2293 static gboolean
2294 gst_bin_src_pads_activate (GstBin * bin, gboolean active)
2295 {
2296   GstIterator *iter;
2297   gboolean fold_ok;
2298
2299   GST_DEBUG_OBJECT (bin, "src_pads_activate with active %d", active);
2300
2301   iter = gst_element_iterate_src_pads ((GstElement *) bin);
2302   fold_ok = iterator_activate_fold_with_resync (iter, &active);
2303   gst_iterator_free (iter);
2304   if (G_UNLIKELY (!fold_ok))
2305     goto failed;
2306
2307   GST_DEBUG_OBJECT (bin, "pads_activate successful");
2308
2309   return TRUE;
2310
2311   /* ERRORS */
2312 failed:
2313   {
2314     GST_DEBUG_OBJECT (bin, "source pads_activate failed");
2315     return FALSE;
2316   }
2317 }
2318
2319 /**
2320  * gst_bin_recalculate_latency:
2321  * @bin: a #GstBin
2322  *
2323  * Query @bin for the current latency using and reconfigures this latency to all the
2324  * elements with a LATENCY event.
2325  *
2326  * This method is typically called on the pipeline when a #GST_MESSAGE_LATENCY
2327  * is posted on the bus.
2328  *
2329  * This function simply emits the 'do-latency' signal so any custom latency
2330  * calculations will be performed.
2331  *
2332  * Returns: %TRUE if the latency could be queried and reconfigured.
2333  *
2334  * Since: 0.10.22.
2335  */
2336 gboolean
2337 gst_bin_recalculate_latency (GstBin * bin)
2338 {
2339   gboolean res;
2340
2341   g_signal_emit (bin, gst_bin_signals[DO_LATENCY], 0, &res);
2342   GST_DEBUG_OBJECT (bin, "latency returned %d", res);
2343
2344   return res;
2345 }
2346
2347 static gboolean
2348 gst_bin_do_latency_func (GstBin * bin)
2349 {
2350   GstQuery *query;
2351   GstElement *element;
2352   GstClockTime min_latency, max_latency;
2353   gboolean res;
2354
2355   g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
2356
2357   element = GST_ELEMENT_CAST (bin);
2358
2359   GST_DEBUG_OBJECT (element, "querying latency");
2360
2361   query = gst_query_new_latency ();
2362   if ((res = gst_element_query (element, query))) {
2363     gboolean live;
2364
2365     gst_query_parse_latency (query, &live, &min_latency, &max_latency);
2366
2367     GST_DEBUG_OBJECT (element,
2368         "got min latency %" GST_TIME_FORMAT ", max latency %"
2369         GST_TIME_FORMAT ", live %d", GST_TIME_ARGS (min_latency),
2370         GST_TIME_ARGS (max_latency), live);
2371
2372     if (max_latency < min_latency) {
2373       /* this is an impossible situation, some parts of the pipeline might not
2374        * work correctly. We post a warning for now. */
2375       GST_ELEMENT_WARNING (element, CORE, CLOCK, (NULL),
2376           ("Impossible to configure latency: max %" GST_TIME_FORMAT " < min %"
2377               GST_TIME_FORMAT ". Add queues or other buffering elements.",
2378               GST_TIME_ARGS (max_latency), GST_TIME_ARGS (min_latency)));
2379     }
2380
2381     /* configure latency on elements */
2382     res = gst_element_send_event (element, gst_event_new_latency (min_latency));
2383     if (res) {
2384       GST_INFO_OBJECT (element, "configured latency of %" GST_TIME_FORMAT,
2385           GST_TIME_ARGS (min_latency));
2386     } else {
2387       GST_WARNING_OBJECT (element,
2388           "did not really configure latency of %" GST_TIME_FORMAT,
2389           GST_TIME_ARGS (min_latency));
2390     }
2391   } else {
2392     /* this is not a real problem, we just don't configure any latency. */
2393     GST_WARNING_OBJECT (element, "failed to query latency");
2394   }
2395   gst_query_unref (query);
2396
2397   return res;
2398 }
2399
2400 static void
2401 gst_bin_state_changed (GstElement * element, GstState oldstate,
2402     GstState newstate, GstState pending)
2403 {
2404   GstElementClass *pklass = (GstElementClass *) parent_class;
2405
2406   if (newstate == GST_STATE_PLAYING && pending == GST_STATE_VOID_PENDING)
2407     bin_do_eos (GST_BIN_CAST (element));
2408
2409   if (pklass->state_changed)
2410     pklass->state_changed (element, oldstate, newstate, pending);
2411 }
2412
2413 static GstStateChangeReturn
2414 gst_bin_change_state_func (GstElement * element, GstStateChange transition)
2415 {
2416   GstBin *bin;
2417   GstStateChangeReturn ret;
2418   GstState current, next;
2419   gboolean have_async;
2420   gboolean have_no_preroll;
2421   GstClockTime base_time, start_time;
2422   GstIterator *it;
2423   gboolean done;
2424   GValue data = { 0, };
2425
2426   /* we don't need to take the STATE_LOCK, it is already taken */
2427   current = (GstState) GST_STATE_TRANSITION_CURRENT (transition);
2428   next = (GstState) GST_STATE_TRANSITION_NEXT (transition);
2429
2430   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2431       "changing state of children from %s to %s",
2432       gst_element_state_get_name (current), gst_element_state_get_name (next));
2433
2434   bin = GST_BIN_CAST (element);
2435
2436   switch (next) {
2437     case GST_STATE_PLAYING:
2438     {
2439       gboolean toplevel;
2440
2441       GST_OBJECT_LOCK (bin);
2442       toplevel = BIN_IS_TOPLEVEL (bin);
2443       GST_OBJECT_UNLOCK (bin);
2444
2445       if (toplevel)
2446         gst_bin_recalculate_latency (bin);
2447       break;
2448     }
2449     case GST_STATE_PAUSED:
2450       /* Clear EOS list on next PAUSED */
2451       GST_OBJECT_LOCK (bin);
2452       GST_DEBUG_OBJECT (element, "clearing EOS elements");
2453       bin_remove_messages (bin, NULL, GST_MESSAGE_EOS);
2454       bin->priv->posted_eos = FALSE;
2455       GST_OBJECT_UNLOCK (bin);
2456       if (current == GST_STATE_READY)
2457         if (!(gst_bin_src_pads_activate (bin, TRUE)))
2458           goto activate_failure;
2459       break;
2460     case GST_STATE_READY:
2461       /* Clear message list on next READY */
2462       GST_OBJECT_LOCK (bin);
2463       GST_DEBUG_OBJECT (element, "clearing all cached messages");
2464       bin_remove_messages (bin, NULL, GST_MESSAGE_ANY);
2465       GST_OBJECT_UNLOCK (bin);
2466       if (current == GST_STATE_PAUSED)
2467         if (!(gst_bin_src_pads_activate (bin, FALSE)))
2468           goto activate_failure;
2469       break;
2470     case GST_STATE_NULL:
2471       if (current == GST_STATE_READY)
2472         if (!(gst_bin_src_pads_activate (bin, FALSE)))
2473           goto activate_failure;
2474       break;
2475     default:
2476       break;
2477   }
2478
2479   /* this flag is used to make the async state changes return immediatly. We
2480    * don't want them to interfere with this state change */
2481   GST_OBJECT_LOCK (bin);
2482   bin->polling = TRUE;
2483   GST_OBJECT_UNLOCK (bin);
2484
2485   /* iterate in state change order */
2486   it = gst_bin_iterate_sorted (bin);
2487
2488   /* mark if we've seen an ASYNC element in the bin when we did a state change.
2489    * Note how we don't reset this value when a resync happens, the reason being
2490    * that the async element posted ASYNC_START and we want to post ASYNC_DONE
2491    * even after a resync when the async element is gone */
2492   have_async = FALSE;
2493
2494 restart:
2495   /* take base_time */
2496   base_time = gst_element_get_base_time (element);
2497   start_time = gst_element_get_start_time (element);
2498
2499   have_no_preroll = FALSE;
2500
2501   done = FALSE;
2502   while (!done) {
2503     switch (gst_iterator_next (it, &data)) {
2504       case GST_ITERATOR_OK:
2505       {
2506         GstElement *child;
2507
2508         child = g_value_get_object (&data);
2509
2510         /* set state and base_time now */
2511         ret = gst_bin_element_set_state (bin, child, base_time, start_time,
2512             current, next);
2513
2514         switch (ret) {
2515           case GST_STATE_CHANGE_SUCCESS:
2516             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2517                 "child '%s' changed state to %d(%s) successfully",
2518                 GST_ELEMENT_NAME (child), next,
2519                 gst_element_state_get_name (next));
2520             break;
2521           case GST_STATE_CHANGE_ASYNC:
2522           {
2523             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2524                 "child '%s' is changing state asynchronously to %s",
2525                 GST_ELEMENT_NAME (child), gst_element_state_get_name (next));
2526             have_async = TRUE;
2527             break;
2528           }
2529           case GST_STATE_CHANGE_FAILURE:{
2530             GstObject *parent;
2531
2532             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2533                 "child '%s' failed to go to state %d(%s)",
2534                 GST_ELEMENT_NAME (child),
2535                 next, gst_element_state_get_name (next));
2536
2537             /* Only fail if the child is still inside
2538              * this bin. It might've been removed already
2539              * because of the error by the bin subclass
2540              * to ignore the error.  */
2541             parent = gst_object_get_parent (GST_OBJECT_CAST (child));
2542             if (parent == GST_OBJECT_CAST (element)) {
2543               /* element is still in bin, really error now */
2544               gst_object_unref (parent);
2545               goto done;
2546             }
2547             /* child removed from bin, let the resync code redo the state
2548              * change */
2549             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2550                 "child '%s' was removed from the bin",
2551                 GST_ELEMENT_NAME (child));
2552
2553             if (parent)
2554               gst_object_unref (parent);
2555
2556             break;
2557           }
2558           case GST_STATE_CHANGE_NO_PREROLL:
2559             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2560                 "child '%s' changed state to %d(%s) successfully without preroll",
2561                 GST_ELEMENT_NAME (child), next,
2562                 gst_element_state_get_name (next));
2563             have_no_preroll = TRUE;
2564             break;
2565           default:
2566             g_assert_not_reached ();
2567             break;
2568         }
2569         g_value_reset (&data);
2570         break;
2571       }
2572       case GST_ITERATOR_RESYNC:
2573         GST_CAT_DEBUG (GST_CAT_STATES, "iterator doing resync");
2574         gst_iterator_resync (it);
2575         goto restart;
2576       default:
2577       case GST_ITERATOR_DONE:
2578         GST_CAT_DEBUG (GST_CAT_STATES, "iterator done");
2579         done = TRUE;
2580         break;
2581     }
2582   }
2583
2584   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2585   if (G_UNLIKELY (ret == GST_STATE_CHANGE_FAILURE))
2586     goto done;
2587
2588   if (have_no_preroll) {
2589     GST_CAT_DEBUG (GST_CAT_STATES,
2590         "we have NO_PREROLL elements %s -> NO_PREROLL",
2591         gst_element_state_change_return_get_name (ret));
2592     ret = GST_STATE_CHANGE_NO_PREROLL;
2593   } else if (have_async) {
2594     GST_CAT_DEBUG (GST_CAT_STATES, "we have ASYNC elements %s -> ASYNC",
2595         gst_element_state_change_return_get_name (ret));
2596     ret = GST_STATE_CHANGE_ASYNC;
2597   }
2598
2599 done:
2600   g_value_unset (&data);
2601   gst_iterator_free (it);
2602
2603   GST_OBJECT_LOCK (bin);
2604   bin->polling = FALSE;
2605   /* it's possible that we did not get ASYNC from the children while the bin is
2606    * simulating ASYNC behaviour by posting an ASYNC_DONE message on the bus with
2607    * itself as the source. In that case we still want to check if the state
2608    * change completed. */
2609   if (ret != GST_STATE_CHANGE_ASYNC && !bin->priv->pending_async_done) {
2610     /* no element returned ASYNC and there are no pending async_done messages,
2611      * we can just complete. */
2612     GST_DEBUG_OBJECT (bin, "no async elements");
2613     goto state_end;
2614   }
2615   /* when we get here an ASYNC element was found */
2616   if (GST_STATE_TARGET (bin) <= GST_STATE_READY) {
2617     /* we ignore ASYNC state changes when we go to READY or NULL */
2618     GST_DEBUG_OBJECT (bin, "target state %s <= READY",
2619         gst_element_state_get_name (GST_STATE_TARGET (bin)));
2620     goto state_end;
2621   }
2622
2623   GST_DEBUG_OBJECT (bin, "check async elements");
2624   /* check if all elements managed to commit their state already */
2625   if (!find_message (bin, NULL, GST_MESSAGE_ASYNC_START)) {
2626     /* nothing found, remove all old ASYNC_DONE messages. This can happen when
2627      * all the elements commited their state while we were doing the state
2628      * change. We will still return ASYNC for consistency but we commit the
2629      * state already so that a _get_state() will return immediatly. */
2630     bin_remove_messages (bin, NULL, GST_MESSAGE_ASYNC_DONE);
2631
2632     GST_DEBUG_OBJECT (bin, "async elements commited");
2633     bin_handle_async_done (bin, GST_STATE_CHANGE_SUCCESS, FALSE);
2634   }
2635
2636 state_end:
2637   bin->priv->pending_async_done = FALSE;
2638   GST_OBJECT_UNLOCK (bin);
2639
2640   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2641       "done changing bin's state from %s to %s, now in %s, ret %s",
2642       gst_element_state_get_name (current),
2643       gst_element_state_get_name (next),
2644       gst_element_state_get_name (GST_STATE (element)),
2645       gst_element_state_change_return_get_name (ret));
2646
2647   return ret;
2648
2649   /* ERRORS */
2650 activate_failure:
2651   {
2652     GST_CAT_WARNING_OBJECT (GST_CAT_STATES, element,
2653         "failure (de)activating src pads");
2654     return GST_STATE_CHANGE_FAILURE;
2655   }
2656 }
2657
2658 /*
2659  * This function is a utility event handler for seek events.
2660  * It will send the event to all sinks or sources depending on the
2661  * event-direction.
2662  *
2663  * Applications are free to override this behaviour and
2664  * implement their own seek handler, but this will work for
2665  * pretty much all cases in practice.
2666  */
2667 static gboolean
2668 gst_bin_send_event (GstElement * element, GstEvent * event)
2669 {
2670   GstBin *bin = GST_BIN_CAST (element);
2671   GstIterator *iter;
2672   gboolean res = TRUE;
2673   gboolean done = FALSE;
2674   GValue data = { 0, };
2675
2676   if (GST_EVENT_IS_DOWNSTREAM (event)) {
2677     iter = gst_bin_iterate_sources (bin);
2678     GST_DEBUG_OBJECT (bin, "Sending %s event to src children",
2679         GST_EVENT_TYPE_NAME (event));
2680   } else {
2681     iter = gst_bin_iterate_sinks (bin);
2682     GST_DEBUG_OBJECT (bin, "Sending %s event to sink children",
2683         GST_EVENT_TYPE_NAME (event));
2684   }
2685
2686   while (!done) {
2687     switch (gst_iterator_next (iter, &data)) {
2688       case GST_ITERATOR_OK:
2689       {
2690         GstElement *child = g_value_get_object (&data);;
2691
2692         gst_event_ref (event);
2693         res &= gst_element_send_event (child, event);
2694         g_value_reset (&data);
2695         break;
2696       }
2697       case GST_ITERATOR_RESYNC:
2698         gst_iterator_resync (iter);
2699         res = TRUE;
2700         break;
2701       case GST_ITERATOR_DONE:
2702         done = TRUE;
2703         break;
2704       case GST_ITERATOR_ERROR:
2705         g_assert_not_reached ();
2706         break;
2707     }
2708   }
2709   g_value_unset (&data);
2710   gst_iterator_free (iter);
2711   gst_event_unref (event);
2712
2713   return res;
2714 }
2715
2716 /* this is the function called by the threadpool. When async elements commit
2717  * their state, this function will attempt to bring the bin to the next state.
2718  */
2719 static void
2720 gst_bin_continue_func (BinContinueData * data)
2721 {
2722   GstBin *bin;
2723   GstState current, next, pending;
2724   GstStateChange transition;
2725
2726   bin = data->bin;
2727   pending = data->pending;
2728
2729   GST_DEBUG_OBJECT (bin, "waiting for state lock");
2730   GST_STATE_LOCK (bin);
2731
2732   GST_DEBUG_OBJECT (bin, "doing state continue");
2733   GST_OBJECT_LOCK (bin);
2734
2735   /* if a new state change happened after this thread was scheduled, we return
2736    * immediatly. */
2737   if (data->cookie != GST_ELEMENT_CAST (bin)->state_cookie)
2738     goto interrupted;
2739
2740   current = GST_STATE (bin);
2741   next = GST_STATE_GET_NEXT (current, pending);
2742   transition = (GstStateChange) GST_STATE_TRANSITION (current, next);
2743
2744   GST_STATE_NEXT (bin) = next;
2745   GST_STATE_PENDING (bin) = pending;
2746   /* mark busy */
2747   GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
2748   GST_OBJECT_UNLOCK (bin);
2749
2750   GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2751       "continue state change %s to %s, final %s",
2752       gst_element_state_get_name (current),
2753       gst_element_state_get_name (next), gst_element_state_get_name (pending));
2754
2755   gst_element_change_state (GST_ELEMENT_CAST (bin), transition);
2756
2757   GST_STATE_UNLOCK (bin);
2758   GST_DEBUG_OBJECT (bin, "state continue done");
2759
2760   gst_object_unref (bin);
2761   g_slice_free (BinContinueData, data);
2762   return;
2763
2764 interrupted:
2765   {
2766     GST_OBJECT_UNLOCK (bin);
2767     GST_STATE_UNLOCK (bin);
2768     GST_DEBUG_OBJECT (bin, "state continue aborted due to intervening change");
2769     gst_object_unref (bin);
2770     g_slice_free (BinContinueData, data);
2771     return;
2772   }
2773 }
2774
2775 static GstBusSyncReply
2776 bin_bus_handler (GstBus * bus, GstMessage * message, GstBin * bin)
2777 {
2778   GstBinClass *bclass;
2779
2780   bclass = GST_BIN_GET_CLASS (bin);
2781   if (bclass->handle_message)
2782     bclass->handle_message (bin, message);
2783   else
2784     gst_message_unref (message);
2785
2786   return GST_BUS_DROP;
2787 }
2788
2789 static void
2790 bin_push_state_continue (BinContinueData * data)
2791 {
2792   GstBinClass *klass;
2793   GstBin *bin;
2794
2795   /* ref was taken */
2796   bin = data->bin;
2797   klass = GST_BIN_GET_CLASS (bin);
2798
2799   GST_DEBUG_OBJECT (bin, "pushing continue on thread pool");
2800   g_thread_pool_push (klass->pool, data, NULL);
2801 }
2802
2803 /* an element started an async state change, if we were not busy with a state
2804  * change, we perform a lost state.
2805  * This function is called with the OBJECT lock.
2806  */
2807 static void
2808 bin_handle_async_start (GstBin * bin, gboolean new_base_time)
2809 {
2810   GstState old_state, new_state;
2811   gboolean toplevel;
2812   GstMessage *amessage = NULL;
2813
2814   if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_FAILURE)
2815     goto had_error;
2816
2817   /* get our toplevel state */
2818   toplevel = BIN_IS_TOPLEVEL (bin);
2819
2820   /* prepare an ASYNC_START message, we always post the start message even if we
2821    * are busy with a state change or when we are NO_PREROLL. */
2822   if (!toplevel)
2823     /* non toplevel bin, prepare async-start for the parent */
2824     amessage =
2825         gst_message_new_async_start (GST_OBJECT_CAST (bin), new_base_time);
2826
2827   if (bin->polling || GST_STATE_PENDING (bin) != GST_STATE_VOID_PENDING)
2828     goto was_busy;
2829
2830   /* async starts are ignored when we are NO_PREROLL */
2831   if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_NO_PREROLL)
2832     goto was_no_preroll;
2833
2834   old_state = GST_STATE (bin);
2835
2836   /* when we PLAYING we go back to PAUSED, when preroll happens, we go back to
2837    * PLAYING after optionally redistributing the base_time. */
2838   if (old_state > GST_STATE_PAUSED)
2839     new_state = GST_STATE_PAUSED;
2840   else
2841     new_state = old_state;
2842
2843   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2844       "lost state of %s, new %s", gst_element_state_get_name (old_state),
2845       gst_element_state_get_name (new_state));
2846
2847   GST_STATE (bin) = new_state;
2848   GST_STATE_NEXT (bin) = new_state;
2849   GST_STATE_PENDING (bin) = new_state;
2850   GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
2851   GST_OBJECT_UNLOCK (bin);
2852
2853   /* post message */
2854   _priv_gst_element_state_changed (GST_ELEMENT_CAST (bin), new_state, new_state,
2855       new_state);
2856
2857 post_start:
2858   if (amessage) {
2859     /* post our ASYNC_START. */
2860     GST_DEBUG_OBJECT (bin, "posting ASYNC_START to parent");
2861     gst_element_post_message (GST_ELEMENT_CAST (bin), amessage);
2862   }
2863   GST_OBJECT_LOCK (bin);
2864
2865   return;
2866
2867 had_error:
2868   {
2869     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "we had an error");
2870     return;
2871   }
2872 was_busy:
2873   {
2874     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "state change busy");
2875     GST_OBJECT_UNLOCK (bin);
2876     goto post_start;
2877   }
2878 was_no_preroll:
2879   {
2880     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "ignoring, we are NO_PREROLL");
2881     GST_OBJECT_UNLOCK (bin);
2882     goto post_start;
2883   }
2884 }
2885
2886 /* this function is called when there are no more async elements in the bin. We
2887  * post a state changed message and an ASYNC_DONE message.
2888  * This function is called with the OBJECT lock.
2889  */
2890 static void
2891 bin_handle_async_done (GstBin * bin, GstStateChangeReturn ret,
2892     gboolean flag_pending)
2893 {
2894   GstState current, pending, target;
2895   GstStateChangeReturn old_ret;
2896   GstState old_state, old_next;
2897   gboolean toplevel, state_changed = FALSE;
2898   GstMessage *amessage = NULL;
2899   BinContinueData *cont = NULL;
2900
2901   if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_FAILURE)
2902     goto had_error;
2903
2904   pending = GST_STATE_PENDING (bin);
2905
2906   if (bin->polling)
2907     goto was_busy;
2908
2909   /* check if there is something to commit */
2910   if (pending == GST_STATE_VOID_PENDING)
2911     goto nothing_pending;
2912
2913   old_ret = GST_STATE_RETURN (bin);
2914   GST_STATE_RETURN (bin) = ret;
2915
2916   /* move to the next target state */
2917   target = GST_STATE_TARGET (bin);
2918   pending = GST_STATE_PENDING (bin) = target;
2919
2920   amessage = gst_message_new_async_done (GST_OBJECT_CAST (bin));
2921
2922   old_state = GST_STATE (bin);
2923   /* this is the state we should go to next */
2924   old_next = GST_STATE_NEXT (bin);
2925
2926   if (old_next != GST_STATE_PLAYING) {
2927     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2928         "committing state from %s to %s, old pending %s",
2929         gst_element_state_get_name (old_state),
2930         gst_element_state_get_name (old_next),
2931         gst_element_state_get_name (pending));
2932
2933     /* update current state */
2934     current = GST_STATE (bin) = old_next;
2935   } else {
2936     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2937         "setting state from %s to %s, pending %s",
2938         gst_element_state_get_name (old_state),
2939         gst_element_state_get_name (old_state),
2940         gst_element_state_get_name (pending));
2941     current = old_state;
2942   }
2943
2944   /* get our toplevel state */
2945   toplevel = BIN_IS_TOPLEVEL (bin);
2946
2947   /* see if we reached the final state. If we are not toplevel, we also have to
2948    * stop here, the parent will continue our state. */
2949   if ((pending == current) || !toplevel) {
2950     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2951         "completed state change, pending VOID");
2952
2953     /* mark VOID pending */
2954     pending = GST_STATE_VOID_PENDING;
2955     GST_STATE_PENDING (bin) = pending;
2956     GST_STATE_NEXT (bin) = GST_STATE_VOID_PENDING;
2957   } else {
2958     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2959         "continue state change, pending %s",
2960         gst_element_state_get_name (pending));
2961
2962     cont = g_slice_new (BinContinueData);
2963
2964     /* ref to the bin */
2965     cont->bin = gst_object_ref (bin);
2966     /* cookie to detect concurrent state change */
2967     cont->cookie = GST_ELEMENT_CAST (bin)->state_cookie;
2968     /* pending target state */
2969     cont->pending = pending;
2970     /* mark busy */
2971     GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
2972     GST_STATE_NEXT (bin) = GST_STATE_GET_NEXT (old_state, pending);
2973   }
2974
2975   if (old_next != GST_STATE_PLAYING) {
2976     if (old_state != old_next || old_ret == GST_STATE_CHANGE_ASYNC) {
2977       state_changed = TRUE;
2978     }
2979   }
2980   GST_OBJECT_UNLOCK (bin);
2981
2982   if (state_changed) {
2983     _priv_gst_element_state_changed (GST_ELEMENT_CAST (bin), old_state,
2984         old_next, pending);
2985   }
2986   if (amessage) {
2987     /* post our combined ASYNC_DONE when all is ASYNC_DONE. */
2988     GST_DEBUG_OBJECT (bin, "posting ASYNC_DONE to parent");
2989     gst_element_post_message (GST_ELEMENT_CAST (bin), amessage);
2990   }
2991
2992   GST_OBJECT_LOCK (bin);
2993   if (cont) {
2994     /* toplevel, start continue state */
2995     GST_DEBUG_OBJECT (bin, "all async-done, starting state continue");
2996     bin_push_state_continue (cont);
2997   } else {
2998     GST_DEBUG_OBJECT (bin, "state change complete");
2999     GST_STATE_BROADCAST (bin);
3000   }
3001   return;
3002
3003 had_error:
3004   {
3005     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "we had an error");
3006     return;
3007   }
3008 was_busy:
3009   {
3010     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "state change busy");
3011     /* if we were busy with a state change and we are requested to flag a
3012      * pending async done, we do so here */
3013     if (flag_pending)
3014       bin->priv->pending_async_done = TRUE;
3015     return;
3016   }
3017 nothing_pending:
3018   {
3019     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin, "nothing pending");
3020     return;
3021   }
3022 }
3023
3024 static void
3025 bin_do_eos (GstBin * bin)
3026 {
3027   guint32 seqnum = 0;
3028   gboolean eos;
3029
3030   GST_OBJECT_LOCK (bin);
3031   /* If all sinks are EOS, we're in PLAYING and no state change is pending
3032    * we forward the EOS message to the parent bin or application
3033    */
3034   eos = GST_STATE (bin) == GST_STATE_PLAYING
3035       && GST_STATE_PENDING (bin) == GST_STATE_VOID_PENDING
3036       && is_eos (bin, &seqnum);
3037   GST_OBJECT_UNLOCK (bin);
3038
3039   if (eos
3040       && g_atomic_int_compare_and_exchange (&bin->priv->posted_eos, FALSE,
3041           TRUE)) {
3042     GstMessage *tmessage;
3043     tmessage = gst_message_new_eos (GST_OBJECT_CAST (bin));
3044     gst_message_set_seqnum (tmessage, seqnum);
3045     GST_DEBUG_OBJECT (bin,
3046         "all sinks posted EOS, posting seqnum #%" G_GUINT32_FORMAT, seqnum);
3047     gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3048   }
3049 }
3050
3051 /* must be called with the object lock. This function releases the lock to post
3052  * the message. */
3053 static void
3054 bin_do_message_forward (GstBin * bin, GstMessage * message)
3055 {
3056   if (bin->priv->message_forward) {
3057     GstMessage *forwarded;
3058
3059     GST_DEBUG_OBJECT (bin, "pass %s message upward",
3060         GST_MESSAGE_TYPE_NAME (message));
3061     GST_OBJECT_UNLOCK (bin);
3062
3063     /* we need to convert these messages to element messages so that our parent
3064      * bin can easily ignore them and so that the application can easily
3065      * distinguish between the internally forwarded and the real messages. */
3066     forwarded = gst_message_new_element (GST_OBJECT_CAST (bin),
3067         gst_structure_new ("GstBinForwarded",
3068             "message", GST_TYPE_MESSAGE, message, NULL));
3069
3070     gst_element_post_message (GST_ELEMENT_CAST (bin), forwarded);
3071
3072     GST_OBJECT_LOCK (bin);
3073   }
3074 }
3075
3076 /* handle child messages:
3077  *
3078  * This method is called synchronously when a child posts a message on
3079  * the internal bus.
3080  *
3081  * GST_MESSAGE_EOS: This message is only posted by sinks
3082  *     in the PLAYING state. If all sinks posted the EOS message, post
3083  *     one upwards.
3084  *
3085  * GST_MESSAGE_STATE_DIRTY: Deprecated
3086  *
3087  * GST_MESSAGE_SEGMENT_START: just collect, never forward upwards. If an
3088  *     element posts segment_start twice, only the last message is kept.
3089  *
3090  * GST_MESSAGE_SEGMENT_DONE: replace SEGMENT_START message from same poster
3091  *     with the segment_done message. If there are no more segment_start
3092  *     messages, post segment_done message upwards.
3093  *
3094  * GST_MESSAGE_DURATION: remove all previously cached duration messages.
3095  *     Whenever someone performs a duration query on the bin, we store the
3096  *     result so we can answer it quicker the next time. Any element that
3097  *     changes its duration marks our cached values invalid.
3098  *     This message is also posted upwards. This is currently disabled
3099  *     because too many elements don't post DURATION messages when the
3100  *     duration changes.
3101  *
3102  * GST_MESSAGE_CLOCK_LOST: This message is posted by an element when it
3103  *     can no longer provide a clock. The default bin behaviour is to
3104  *     check if the lost clock was the one provided by the bin. If so and
3105  *     we are currently in the PLAYING state, we forward the message to
3106  *     our parent.
3107  *     This message is also generated when we remove a clock provider from
3108  *     a bin. If this message is received by the application, it should
3109  *     PAUSE the pipeline and set it back to PLAYING to force a new clock
3110  *     and a new base_time distribution.
3111  *
3112  * GST_MESSAGE_CLOCK_PROVIDE: This message is generated when an element
3113  *     can provide a clock. This mostly happens when we add a new clock
3114  *     provider to the bin. The default behaviour of the bin is to mark the
3115  *     currently selected clock as dirty, which will perform a clock
3116  *     recalculation the next time we are asked to provide a clock.
3117  *     This message is never sent to the application but is forwarded to
3118  *     the parent.
3119  *
3120  * GST_MESSAGE_ASYNC_START: Create an internal ELEMENT message that stores
3121  *     the state of the element and the fact that the element will need a
3122  *     new base_time. This message is not forwarded to the application.
3123  *
3124  * GST_MESSAGE_ASYNC_DONE: Find the internal ELEMENT message we kept for the
3125  *     element when it posted ASYNC_START. If all elements are done, post a
3126  *     ASYNC_DONE message to the parent.
3127  *
3128  * OTHER: post upwards.
3129  */
3130 static void
3131 gst_bin_handle_message_func (GstBin * bin, GstMessage * message)
3132 {
3133   GstObject *src;
3134   GstMessageType type;
3135   GstMessage *tmessage;
3136   guint32 seqnum;
3137
3138   src = GST_MESSAGE_SRC (message);
3139   type = GST_MESSAGE_TYPE (message);
3140
3141   GST_DEBUG_OBJECT (bin, "[msg %p] handling child %s message of type %s",
3142       message, src ? GST_ELEMENT_NAME (src) : "(NULL)",
3143       GST_MESSAGE_TYPE_NAME (message));
3144
3145   switch (type) {
3146     case GST_MESSAGE_ERROR:
3147     {
3148       GST_OBJECT_LOCK (bin);
3149       /* flag error */
3150       GST_DEBUG_OBJECT (bin, "got ERROR message, unlocking state change");
3151       GST_STATE_RETURN (bin) = GST_STATE_CHANGE_FAILURE;
3152       GST_STATE_BROADCAST (bin);
3153       GST_OBJECT_UNLOCK (bin);
3154
3155       goto forward;
3156     }
3157     case GST_MESSAGE_EOS:
3158     {
3159
3160       /* collect all eos messages from the children */
3161       GST_OBJECT_LOCK (bin);
3162       bin_do_message_forward (bin, message);
3163       /* ref message for future use  */
3164       bin_replace_message (bin, message, GST_MESSAGE_EOS);
3165       GST_OBJECT_UNLOCK (bin);
3166
3167       bin_do_eos (bin);
3168       break;
3169     }
3170     case GST_MESSAGE_STATE_DIRTY:
3171     {
3172       GST_WARNING_OBJECT (bin, "received deprecated STATE_DIRTY message");
3173
3174       /* free message */
3175       gst_message_unref (message);
3176       break;
3177     }
3178     case GST_MESSAGE_SEGMENT_START:{
3179       gboolean post = FALSE;
3180       GstFormat format;
3181       gint64 position;
3182
3183       gst_message_parse_segment_start (message, &format, &position);
3184       seqnum = gst_message_get_seqnum (message);
3185
3186       GST_OBJECT_LOCK (bin);
3187       bin_do_message_forward (bin, message);
3188       /* if this is the first segment-start, post to parent but not to the
3189        * application */
3190       if (!find_message (bin, NULL, GST_MESSAGE_SEGMENT_START) &&
3191           (GST_OBJECT_PARENT (bin) != NULL)) {
3192         post = TRUE;
3193       }
3194       /* replace any previous segment_start message from this source
3195        * with the new segment start message */
3196       bin_replace_message (bin, message, GST_MESSAGE_SEGMENT_START);
3197       GST_OBJECT_UNLOCK (bin);
3198       if (post) {
3199         tmessage = gst_message_new_segment_start (GST_OBJECT_CAST (bin),
3200             format, position);
3201         gst_message_set_seqnum (tmessage, seqnum);
3202
3203         /* post segment start with initial format and position. */
3204         GST_DEBUG_OBJECT (bin, "posting SEGMENT_START (%u) bus message: %p",
3205             seqnum, message);
3206         gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3207       }
3208       break;
3209     }
3210     case GST_MESSAGE_SEGMENT_DONE:
3211     {
3212       gboolean post = FALSE;
3213       GstFormat format;
3214       gint64 position;
3215
3216       gst_message_parse_segment_done (message, &format, &position);
3217       seqnum = gst_message_get_seqnum (message);
3218
3219       GST_OBJECT_LOCK (bin);
3220       bin_do_message_forward (bin, message);
3221       bin_replace_message (bin, message, GST_MESSAGE_SEGMENT_START);
3222       /* if there are no more segment_start messages, everybody posted
3223        * a segment_done and we can post one on the bus. */
3224
3225       /* we don't care who still has a pending segment start */
3226       if (!find_message (bin, NULL, GST_MESSAGE_SEGMENT_START)) {
3227         /* nothing found */
3228         post = TRUE;
3229         /* remove all old segment_done messages */
3230         bin_remove_messages (bin, NULL, GST_MESSAGE_SEGMENT_DONE);
3231       }
3232       GST_OBJECT_UNLOCK (bin);
3233       if (post) {
3234         tmessage = gst_message_new_segment_done (GST_OBJECT_CAST (bin),
3235             format, position);
3236         gst_message_set_seqnum (tmessage, seqnum);
3237
3238         /* post segment done with latest format and position. */
3239         GST_DEBUG_OBJECT (bin, "posting SEGMENT_DONE (%u) bus message: %p",
3240             seqnum, message);
3241         gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3242       }
3243       break;
3244     }
3245     case GST_MESSAGE_DURATION:
3246     {
3247       /* remove all cached duration messages, next time somebody asks
3248        * for duration, we will recalculate. */
3249       GST_OBJECT_LOCK (bin);
3250       bin_remove_messages (bin, NULL, GST_MESSAGE_DURATION);
3251       GST_OBJECT_UNLOCK (bin);
3252       goto forward;
3253     }
3254     case GST_MESSAGE_CLOCK_LOST:
3255     {
3256       GstClock **provided_clock_p;
3257       GstElement **clock_provider_p;
3258       gboolean playing, provided, forward;
3259       GstClock *clock;
3260
3261       gst_message_parse_clock_lost (message, &clock);
3262
3263       GST_OBJECT_LOCK (bin);
3264       bin->clock_dirty = TRUE;
3265       /* if we lost the clock that we provided, post to parent but
3266        * only if we are PLAYING. */
3267       provided = (clock == bin->provided_clock);
3268       playing = (GST_STATE (bin) == GST_STATE_PLAYING);
3269       forward = playing & provided;
3270       if (provided) {
3271         GST_DEBUG_OBJECT (bin,
3272             "Lost clock %" GST_PTR_FORMAT " provided by %" GST_PTR_FORMAT,
3273             bin->provided_clock, bin->clock_provider);
3274         provided_clock_p = &bin->provided_clock;
3275         clock_provider_p = &bin->clock_provider;
3276         gst_object_replace ((GstObject **) provided_clock_p, NULL);
3277         gst_object_replace ((GstObject **) clock_provider_p, NULL);
3278       }
3279       GST_DEBUG_OBJECT (bin, "provided %d, playing %d, forward %d",
3280           provided, playing, forward);
3281       GST_OBJECT_UNLOCK (bin);
3282
3283       if (forward)
3284         goto forward;
3285
3286       /* free message */
3287       gst_message_unref (message);
3288       break;
3289     }
3290     case GST_MESSAGE_CLOCK_PROVIDE:
3291     {
3292       gboolean forward;
3293
3294       GST_OBJECT_LOCK (bin);
3295       bin->clock_dirty = TRUE;
3296       /* a new clock is available, post to parent but not
3297        * to the application */
3298       forward = GST_OBJECT_PARENT (bin) != NULL;
3299       GST_OBJECT_UNLOCK (bin);
3300
3301       if (forward)
3302         goto forward;
3303
3304       /* free message */
3305       gst_message_unref (message);
3306       break;
3307     }
3308     case GST_MESSAGE_ASYNC_START:
3309     {
3310       gboolean new_base_time;
3311       GstState target;
3312
3313       GST_DEBUG_OBJECT (bin, "ASYNC_START message %p, %s", message,
3314           src ? GST_OBJECT_NAME (src) : "(NULL)");
3315
3316       gst_message_parse_async_start (message, &new_base_time);
3317
3318       GST_OBJECT_LOCK (bin);
3319       bin_do_message_forward (bin, message);
3320
3321       /* we ignore the message if we are going to <= READY */
3322       if ((target = GST_STATE_TARGET (bin)) <= GST_STATE_READY)
3323         goto ignore_start_message;
3324
3325       /* takes ownership of the message */
3326       bin_replace_message (bin, message, GST_MESSAGE_ASYNC_START);
3327
3328       bin_handle_async_start (bin, new_base_time);
3329       GST_OBJECT_UNLOCK (bin);
3330       break;
3331
3332     ignore_start_message:
3333       {
3334         GST_DEBUG_OBJECT (bin, "ignoring message, target %s",
3335             gst_element_state_get_name (target));
3336         GST_OBJECT_UNLOCK (bin);
3337         gst_message_unref (message);
3338         break;
3339       }
3340     }
3341     case GST_MESSAGE_ASYNC_DONE:
3342     {
3343       GstState target;
3344
3345       GST_DEBUG_OBJECT (bin, "ASYNC_DONE message %p, %s", message,
3346           src ? GST_OBJECT_NAME (src) : "(NULL)");
3347
3348       GST_OBJECT_LOCK (bin);
3349       bin_do_message_forward (bin, message);
3350
3351       /* ignore messages if we are shutting down */
3352       if ((target = GST_STATE_TARGET (bin)) <= GST_STATE_READY)
3353         goto ignore_done_message;
3354
3355       bin_replace_message (bin, message, GST_MESSAGE_ASYNC_START);
3356       /* if there are no more ASYNC_START messages, everybody posted
3357        * a ASYNC_DONE and we can post one on the bus. When checking, we
3358        * don't care who still has a pending ASYNC_START */
3359       if (!find_message (bin, NULL, GST_MESSAGE_ASYNC_START)) {
3360         /* nothing found, remove all old ASYNC_DONE messages */
3361         bin_remove_messages (bin, NULL, GST_MESSAGE_ASYNC_DONE);
3362
3363         GST_DEBUG_OBJECT (bin, "async elements commited");
3364         /* when we get an async done message when a state change was busy, we
3365          * need to set the pending_done flag so that at the end of the state
3366          * change we can see if we need to verify pending async elements, hence
3367          * the TRUE argument here. */
3368         bin_handle_async_done (bin, GST_STATE_CHANGE_SUCCESS, TRUE);
3369       } else {
3370         GST_DEBUG_OBJECT (bin, "there are more async elements pending");
3371       }
3372       GST_OBJECT_UNLOCK (bin);
3373       break;
3374
3375     ignore_done_message:
3376       {
3377         GST_DEBUG_OBJECT (bin, "ignoring message, target %s",
3378             gst_element_state_get_name (target));
3379         GST_OBJECT_UNLOCK (bin);
3380         gst_message_unref (message);
3381         break;
3382       }
3383     }
3384     case GST_MESSAGE_STRUCTURE_CHANGE:
3385     {
3386       gboolean busy;
3387
3388       gst_message_parse_structure_change (message, NULL, NULL, &busy);
3389
3390       GST_OBJECT_LOCK (bin);
3391       if (busy) {
3392         /* while the pad is busy, avoid following it when doing state changes.
3393          * Don't update the cookie yet, we will do that after the structure
3394          * change finished and we are ready to inspect the new updated
3395          * structure. */
3396         bin_replace_message (bin, message, GST_MESSAGE_STRUCTURE_CHANGE);
3397         message = NULL;
3398       } else {
3399         /* a pad link/unlink ended, signal the state change iterator that we
3400          * need to resync by updating the structure_cookie. */
3401         bin_remove_messages (bin, GST_MESSAGE_SRC (message),
3402             GST_MESSAGE_STRUCTURE_CHANGE);
3403         bin->priv->structure_cookie++;
3404       }
3405       GST_OBJECT_UNLOCK (bin);
3406
3407       if (message)
3408         gst_message_unref (message);
3409
3410       break;
3411     }
3412     default:
3413       goto forward;
3414   }
3415   return;
3416
3417 forward:
3418   {
3419     /* Send all other messages upward */
3420     GST_DEBUG_OBJECT (bin, "posting message upward");
3421     gst_element_post_message (GST_ELEMENT_CAST (bin), message);
3422     return;
3423   }
3424 }
3425
3426 /* generic struct passed to all query fold methods */
3427 typedef struct
3428 {
3429   GstQuery *query;
3430   gint64 min;
3431   gint64 max;
3432   gboolean live;
3433 } QueryFold;
3434
3435 typedef void (*QueryInitFunction) (GstBin * bin, QueryFold * fold);
3436 typedef void (*QueryDoneFunction) (GstBin * bin, QueryFold * fold);
3437
3438 /* for duration/position we collect all durations/positions and take
3439  * the MAX of all valid results */
3440 static void
3441 bin_query_min_max_init (GstBin * bin, QueryFold * fold)
3442 {
3443   fold->min = 0;
3444   fold->max = -1;
3445   fold->live = FALSE;
3446 }
3447
3448 static gboolean
3449 bin_query_duration_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3450 {
3451   GstElement *item = g_value_get_object (vitem);
3452
3453   if (gst_element_query (item, fold->query)) {
3454     gint64 duration;
3455
3456     g_value_set_boolean (ret, TRUE);
3457
3458     gst_query_parse_duration (fold->query, NULL, &duration);
3459
3460     GST_DEBUG_OBJECT (item, "got duration %" G_GINT64_FORMAT, duration);
3461
3462     if (duration > fold->max)
3463       fold->max = duration;
3464   }
3465
3466   return TRUE;
3467 }
3468
3469 static void
3470 bin_query_duration_done (GstBin * bin, QueryFold * fold)
3471 {
3472   GstFormat format;
3473
3474   gst_query_parse_duration (fold->query, &format, NULL);
3475   /* store max in query result */
3476   gst_query_set_duration (fold->query, format, fold->max);
3477
3478   GST_DEBUG_OBJECT (bin, "max duration %" G_GINT64_FORMAT, fold->max);
3479
3480   /* and cache now */
3481   GST_OBJECT_LOCK (bin);
3482   bin->messages = g_list_prepend (bin->messages,
3483       gst_message_new_duration (GST_OBJECT_CAST (bin), format, fold->max));
3484   GST_OBJECT_UNLOCK (bin);
3485 }
3486
3487 static gboolean
3488 bin_query_position_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3489 {
3490   GstElement *item = g_value_get_object (vitem);
3491
3492   if (gst_element_query (item, fold->query)) {
3493     gint64 position;
3494
3495     g_value_set_boolean (ret, TRUE);
3496
3497     gst_query_parse_position (fold->query, NULL, &position);
3498
3499     GST_DEBUG_OBJECT (item, "got position %" G_GINT64_FORMAT, position);
3500
3501     if (position > fold->max)
3502       fold->max = position;
3503   }
3504
3505   return TRUE;
3506 }
3507
3508 static void
3509 bin_query_position_done (GstBin * bin, QueryFold * fold)
3510 {
3511   GstFormat format;
3512
3513   gst_query_parse_position (fold->query, &format, NULL);
3514   /* store max in query result */
3515   gst_query_set_position (fold->query, format, fold->max);
3516
3517   GST_DEBUG_OBJECT (bin, "max position %" G_GINT64_FORMAT, fold->max);
3518 }
3519
3520 static gboolean
3521 bin_query_latency_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3522 {
3523   GstElement *item = g_value_get_object (vitem);
3524
3525   if (gst_element_query (item, fold->query)) {
3526     GstClockTime min, max;
3527     gboolean live;
3528
3529     gst_query_parse_latency (fold->query, &live, &min, &max);
3530
3531     GST_DEBUG_OBJECT (item,
3532         "got latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
3533         ", live %d", GST_TIME_ARGS (min), GST_TIME_ARGS (max), live);
3534
3535     /* for the combined latency we collect the MAX of all min latencies and
3536      * the MIN of all max latencies */
3537     if (live) {
3538       if (min > fold->min)
3539         fold->min = min;
3540       if (fold->max == -1)
3541         fold->max = max;
3542       else if (max < fold->max)
3543         fold->max = max;
3544       if (fold->live == FALSE)
3545         fold->live = live;
3546     }
3547   } else {
3548     g_value_set_boolean (ret, FALSE);
3549     GST_DEBUG_OBJECT (item, "failed query");
3550   }
3551
3552   return TRUE;
3553 }
3554
3555 static void
3556 bin_query_latency_done (GstBin * bin, QueryFold * fold)
3557 {
3558   /* store max in query result */
3559   gst_query_set_latency (fold->query, fold->live, fold->min, fold->max);
3560
3561   GST_DEBUG_OBJECT (bin,
3562       "latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
3563       ", live %d", GST_TIME_ARGS (fold->min), GST_TIME_ARGS (fold->max),
3564       fold->live);
3565 }
3566
3567 /* generic fold, return first valid result */
3568 static gboolean
3569 bin_query_generic_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3570 {
3571   GstElement *item = g_value_get_object (vitem);
3572   gboolean res;
3573
3574   if ((res = gst_element_query (item, fold->query))) {
3575     g_value_set_boolean (ret, TRUE);
3576     GST_DEBUG_OBJECT (item, "answered query %p", fold->query);
3577   }
3578
3579   /* and stop as soon as we have a valid result */
3580   return !res;
3581 }
3582
3583 static gboolean
3584 gst_bin_query (GstElement * element, GstQuery * query)
3585 {
3586   GstBin *bin = GST_BIN_CAST (element);
3587   GstIterator *iter;
3588   gboolean res = FALSE;
3589   GstIteratorFoldFunction fold_func;
3590   QueryInitFunction fold_init = NULL;
3591   QueryDoneFunction fold_done = NULL;
3592   QueryFold fold_data;
3593   GValue ret = { 0 };
3594
3595   switch (GST_QUERY_TYPE (query)) {
3596     case GST_QUERY_DURATION:
3597     {
3598       GList *cached;
3599       GstFormat qformat;
3600
3601       gst_query_parse_duration (query, &qformat, NULL);
3602
3603       /* find cached duration query */
3604       GST_OBJECT_LOCK (bin);
3605       for (cached = bin->messages; cached; cached = g_list_next (cached)) {
3606         GstMessage *message = (GstMessage *) cached->data;
3607
3608         if (GST_MESSAGE_TYPE (message) == GST_MESSAGE_DURATION &&
3609             GST_MESSAGE_SRC (message) == GST_OBJECT_CAST (bin)) {
3610           GstFormat format;
3611           gint64 duration;
3612
3613           gst_message_parse_duration (message, &format, &duration);
3614
3615           /* if cached same format, copy duration in query result */
3616           if (format == qformat) {
3617             GST_DEBUG_OBJECT (bin, "return cached duration %" G_GINT64_FORMAT,
3618                 duration);
3619             GST_OBJECT_UNLOCK (bin);
3620
3621             gst_query_set_duration (query, qformat, duration);
3622             res = TRUE;
3623             goto exit;
3624           }
3625         }
3626       }
3627       GST_OBJECT_UNLOCK (bin);
3628       /* no cached value found, iterate and collect durations */
3629       fold_func = (GstIteratorFoldFunction) bin_query_duration_fold;
3630       fold_init = bin_query_min_max_init;
3631       fold_done = bin_query_duration_done;
3632       break;
3633     }
3634     case GST_QUERY_POSITION:
3635     {
3636       fold_func = (GstIteratorFoldFunction) bin_query_position_fold;
3637       fold_init = bin_query_min_max_init;
3638       fold_done = bin_query_position_done;
3639       break;
3640     }
3641     case GST_QUERY_LATENCY:
3642     {
3643       fold_func = (GstIteratorFoldFunction) bin_query_latency_fold;
3644       fold_init = bin_query_min_max_init;
3645       fold_done = bin_query_latency_done;
3646       res = TRUE;
3647       break;
3648     }
3649     default:
3650       fold_func = (GstIteratorFoldFunction) bin_query_generic_fold;
3651       break;
3652   }
3653
3654   fold_data.query = query;
3655
3656   /* set the result of the query to FALSE initially */
3657   g_value_init (&ret, G_TYPE_BOOLEAN);
3658   g_value_set_boolean (&ret, res);
3659
3660   iter = gst_bin_iterate_sinks (bin);
3661   GST_DEBUG_OBJECT (bin, "Sending query %p (type %s) to sink children",
3662       query, GST_QUERY_TYPE_NAME (query));
3663
3664   if (fold_init)
3665     fold_init (bin, &fold_data);
3666
3667   while (TRUE) {
3668     GstIteratorResult ires;
3669
3670     ires = gst_iterator_fold (iter, fold_func, &ret, &fold_data);
3671
3672     switch (ires) {
3673       case GST_ITERATOR_RESYNC:
3674         gst_iterator_resync (iter);
3675         if (fold_init)
3676           fold_init (bin, &fold_data);
3677         g_value_set_boolean (&ret, res);
3678         break;
3679       case GST_ITERATOR_OK:
3680       case GST_ITERATOR_DONE:
3681         res = g_value_get_boolean (&ret);
3682         if (fold_done != NULL && res)
3683           fold_done (bin, &fold_data);
3684         goto done;
3685       default:
3686         res = FALSE;
3687         goto done;
3688     }
3689   }
3690 done:
3691   gst_iterator_free (iter);
3692
3693 exit:
3694   GST_DEBUG_OBJECT (bin, "query %p result %d", query, res);
3695
3696   return res;
3697 }
3698
3699 static gint
3700 compare_name (const GValue * velement, const gchar * name)
3701 {
3702   gint eq;
3703   GstElement *element = g_value_get_object (velement);
3704
3705   GST_OBJECT_LOCK (element);
3706   eq = strcmp (GST_ELEMENT_NAME (element), name);
3707   GST_OBJECT_UNLOCK (element);
3708
3709   return eq;
3710 }
3711
3712 /**
3713  * gst_bin_get_by_name:
3714  * @bin: a #GstBin
3715  * @name: the element name to search for
3716  *
3717  * Gets the element with the given name from a bin. This
3718  * function recurses into child bins.
3719  *
3720  * Returns NULL if no element with the given name is found in the bin.
3721  *
3722  * MT safe.  Caller owns returned reference.
3723  *
3724  * Returns: (transfer full): the #GstElement with the given name, or NULL
3725  */
3726 GstElement *
3727 gst_bin_get_by_name (GstBin * bin, const gchar * name)
3728 {
3729   GstIterator *children;
3730   GValue result = { 0, };
3731   GstElement *element;
3732   gboolean found;
3733
3734   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3735
3736   GST_CAT_INFO (GST_CAT_PARENTAGE, "[%s]: looking up child element %s",
3737       GST_ELEMENT_NAME (bin), name);
3738
3739   children = gst_bin_iterate_recurse (bin);
3740   found = gst_iterator_find_custom (children,
3741       (GCompareFunc) compare_name, &result, (gpointer) name);
3742   gst_iterator_free (children);
3743
3744   if (found) {
3745     element = g_value_dup_object (&result);
3746     g_value_unset (&result);
3747   } else {
3748     element = NULL;
3749   }
3750
3751   return element;
3752 }
3753
3754 /**
3755  * gst_bin_get_by_name_recurse_up:
3756  * @bin: a #GstBin
3757  * @name: the element name to search for
3758  *
3759  * Gets the element with the given name from this bin. If the
3760  * element is not found, a recursion is performed on the parent bin.
3761  *
3762  * Returns NULL if:
3763  * - no element with the given name is found in the bin
3764  *
3765  * MT safe.  Caller owns returned reference.
3766  *
3767  * Returns: (transfer full): the #GstElement with the given name, or NULL
3768  */
3769 GstElement *
3770 gst_bin_get_by_name_recurse_up (GstBin * bin, const gchar * name)
3771 {
3772   GstElement *result;
3773
3774   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3775   g_return_val_if_fail (name != NULL, NULL);
3776
3777   result = gst_bin_get_by_name (bin, name);
3778
3779   if (!result) {
3780     GstObject *parent;
3781
3782     parent = gst_object_get_parent (GST_OBJECT_CAST (bin));
3783     if (parent) {
3784       if (GST_IS_BIN (parent)) {
3785         result = gst_bin_get_by_name_recurse_up (GST_BIN_CAST (parent), name);
3786       }
3787       gst_object_unref (parent);
3788     }
3789   }
3790
3791   return result;
3792 }
3793
3794 static gint
3795 compare_interface (const GValue * velement, GValue * interface)
3796 {
3797   GstElement *element = g_value_get_object (velement);
3798   GType interface_type = (GType) g_value_get_pointer (interface);
3799   gint ret;
3800
3801   if (G_TYPE_CHECK_INSTANCE_TYPE (element, interface_type)) {
3802     ret = 0;
3803   } else {
3804     ret = 1;
3805   }
3806   return ret;
3807 }
3808
3809 /**
3810  * gst_bin_get_by_interface:
3811  * @bin: a #GstBin
3812  * @iface: the #GType of an interface
3813  *
3814  * Looks for an element inside the bin that implements the given
3815  * interface. If such an element is found, it returns the element.
3816  * You can cast this element to the given interface afterwards.  If you want
3817  * all elements that implement the interface, use
3818  * gst_bin_iterate_all_by_interface(). This function recurses into child bins.
3819  *
3820  * MT safe.  Caller owns returned reference.
3821  *
3822  * Returns: (transfer full): A #GstElement inside the bin implementing the interface
3823  */
3824 GstElement *
3825 gst_bin_get_by_interface (GstBin * bin, GType iface)
3826 {
3827   GstIterator *children;
3828   GValue result = { 0, };
3829   GstElement *element;
3830   gboolean found;
3831   GValue viface = { 0, };
3832
3833   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3834   g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL);
3835
3836   g_value_init (&viface, G_TYPE_POINTER);
3837   g_value_set_pointer (&viface, (gpointer) iface);
3838
3839   children = gst_bin_iterate_recurse (bin);
3840   found = gst_iterator_find_custom (children, (GCompareFunc) compare_interface,
3841       &result, &viface);
3842   gst_iterator_free (children);
3843
3844   if (found) {
3845     element = g_value_dup_object (&result);
3846     g_value_unset (&result);
3847   } else {
3848     element = NULL;
3849   }
3850   g_value_unset (&viface);
3851
3852   return element;
3853 }
3854
3855 /**
3856  * gst_bin_iterate_all_by_interface:
3857  * @bin: a #GstBin
3858  * @iface: the #GType of an interface
3859  *
3860  * Looks for all elements inside the bin that implements the given
3861  * interface. You can safely cast all returned elements to the given interface.
3862  * The function recurses inside child bins. The iterator will yield a series
3863  * of #GstElement that should be unreffed after use.
3864  *
3865  * Each element yielded by the iterator will have its refcount increased, so
3866  * unref after use.
3867  *
3868  * MT safe.  Caller owns returned value.
3869  *
3870  * Returns: (transfer full): a #GstIterator of #GstElement for all elements
3871  *          in the bin implementing the given interface, or NULL
3872  */
3873 GstIterator *
3874 gst_bin_iterate_all_by_interface (GstBin * bin, GType iface)
3875 {
3876   GstIterator *children;
3877   GstIterator *result;
3878   GValue viface = { 0, };
3879
3880   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3881   g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL);
3882
3883   g_value_init (&viface, G_TYPE_POINTER);
3884   g_value_set_pointer (&viface, (gpointer) iface);
3885
3886   children = gst_bin_iterate_recurse (bin);
3887   result = gst_iterator_filter (children, (GCompareFunc) compare_interface,
3888       &viface);
3889
3890   g_value_unset (&viface);
3891
3892   return result;
3893 }