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, gboolean reset_time);
 231 static void bin_handle_async_start (GstBin * bin);
 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   GstElementClass *gstelement_class;
 372   GError *err;
 373
 374   gobject_class = (GObjectClass *) klass;
 375   gstelement_class = (GstElementClass *) klass;
 376
 377   g_type_class_add_private (klass, sizeof (GstBinPrivate));
 378
 379   gobject_class->set_property = gst_bin_set_property;
 380   gobject_class->get_property = gst_bin_get_property;
 381
 382   /**
 383    * GstBin:async-handling
 384    *
 385    * If set to #TRUE, the bin will handle asynchronous state changes.
 386    * This should be used only if the bin subclass is modifying the state
 387    * of its children on its own.
 388    *
 389    * Since: 0.10.13
 390    */
 391   g_object_class_install_property (gobject_class, PROP_ASYNC_HANDLING,
 392       g_param_spec_boolean ("async-handling", "Async Handling",
 393           "The bin will handle Asynchronous state changes",
 394           DEFAULT_ASYNC_HANDLING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 395
 396   /**
 397    * GstBin::element-added:
 398    * @bin: the #GstBin
 399    * @element: the #GstElement that was added to the bin
 400    *
 401    * Will be emitted after the element was added to the bin.
 402    */
 403   gst_bin_signals[ELEMENT_ADDED] =
 404       g_signal_new ("element-added", G_TYPE_FROM_CLASS (klass),
 405       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstBinClass, element_added), NULL,
 406       NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_ELEMENT);
 407   /**
 408    * GstBin::element-removed:
 409    * @bin: the #GstBin
 410    * @element: the #GstElement that was removed from the bin
 411    *
 412    * Will be emitted after the element was removed from the bin.
 413    */
 414   gst_bin_signals[ELEMENT_REMOVED] =
 415       g_signal_new ("element-removed", G_TYPE_FROM_CLASS (klass),
 416       G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstBinClass, element_removed), NULL,
 417       NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_ELEMENT);
 418   /**
 419    * GstBin::do-latency:
 420    * @bin: the #GstBin
 421    *
 422    * Will be emitted when the bin needs to perform latency calculations. This
 423    * signal is only emited for toplevel bins or when async-handling is
 424    * enabled.
 425    *
 426    * Only one signal handler is invoked. If no signals are connected, the
 427    * default handler is invoked, which will query and distribute the lowest
 428    * possible latency to all sinks.
 429    *
 430    * Connect to this signal if the default latency calculations are not
 431    * sufficient, like when you need different latencies for different sinks in
 432    * the same pipeline.
 433    *
 434    * Since: 0.10.22
 435    */
 436   gst_bin_signals[DO_LATENCY] =
 437       g_signal_new ("do-latency", G_TYPE_FROM_CLASS (klass),
 438       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstBinClass, do_latency),
 439       _gst_boolean_accumulator, NULL, gst_marshal_BOOLEAN__VOID,
 440       G_TYPE_BOOLEAN, 0, G_TYPE_NONE);
 441
 442   /**
 443    * GstBin:message-forward
 444    *
 445    * Forward all children messages, even those that would normally be filtered by
 446    * the bin. This can be interesting when one wants to be notified of the EOS
 447    * state of individual elements, for example.
 448    *
 449    * The messages are converted to an ELEMENT message with the bin as the
 450    * source. The structure of the message is named 'GstBinForwarded' and contains
 451    * a field named 'message' of type GST_TYPE_MESSAGE that contains the original
 452    * forwarded message.
 453    *
 454    * Since: 0.10.31
 455    */
 456   g_object_class_install_property (gobject_class, PROP_MESSAGE_FORWARD,
 457       g_param_spec_boolean ("message-forward", "Message Forward",
 458           "Forwards all children messages",
 459           DEFAULT_MESSAGE_FORWARD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 460
 461   gobject_class->dispose = gst_bin_dispose;
 462
 463   gst_element_class_set_metadata (gstelement_class, "Generic bin",
 464       "Generic/Bin",
 465       "Simple container object",
 466       "Erik Walthinsen <omega@cse.ogi.edu>,"
 467       "Wim Taymans <wim.taymans@gmail.com>");
 468
 469   gstelement_class->change_state =
 470       GST_DEBUG_FUNCPTR (gst_bin_change_state_func);
 471   gstelement_class->state_changed = GST_DEBUG_FUNCPTR (gst_bin_state_changed);
 472   gstelement_class->get_state = GST_DEBUG_FUNCPTR (gst_bin_get_state_func);
 473   gstelement_class->get_index = GST_DEBUG_FUNCPTR (gst_bin_get_index_func);
 474   gstelement_class->set_index = GST_DEBUG_FUNCPTR (gst_bin_set_index_func);
 475   gstelement_class->provide_clock =
 476       GST_DEBUG_FUNCPTR (gst_bin_provide_clock_func);
 477   gstelement_class->set_clock = GST_DEBUG_FUNCPTR (gst_bin_set_clock_func);
 478
 479   gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_bin_send_event);
 480   gstelement_class->query = GST_DEBUG_FUNCPTR (gst_bin_query);
 481
 482   klass->add_element = GST_DEBUG_FUNCPTR (gst_bin_add_func);
 483   klass->remove_element = GST_DEBUG_FUNCPTR (gst_bin_remove_func);
 484   klass->handle_message = GST_DEBUG_FUNCPTR (gst_bin_handle_message_func);
 485
 486   klass->do_latency = GST_DEBUG_FUNCPTR (gst_bin_do_latency_func);
 487
 488   GST_DEBUG ("creating bin thread pool");
 489   err = NULL;
 490   klass->pool =
 491       g_thread_pool_new ((GFunc) gst_bin_continue_func, NULL, -1, FALSE, &err);
 492   if (err != NULL) {
 493     g_critical ("could alloc threadpool %s", err->message);
 494   }
 495 }
 496
 497 static void
 498 gst_bin_init (GstBin * bin)
 499 {
 500   GstBus *bus;
 501
 502   bin->numchildren = 0;
 503   bin->children = NULL;
 504   bin->children_cookie = 0;
 505   bin->messages = NULL;
 506   bin->provided_clock = NULL;
 507   bin->clock_dirty = FALSE;
 508
 509   /* Set up a bus for listening to child elements */
 510   bus = g_object_new (GST_TYPE_BUS, "enable-async", FALSE, NULL);
 511   bin->child_bus = bus;
 512   GST_DEBUG_OBJECT (bin, "using bus %" GST_PTR_FORMAT " to listen to children",
 513       bus);
 514   gst_bus_set_sync_handler (bus, (GstBusSyncHandler) bin_bus_handler, bin);
 515
 516   bin->priv = GST_BIN_GET_PRIVATE (bin);
 517   bin->priv->asynchandling = DEFAULT_ASYNC_HANDLING;
 518   bin->priv->structure_cookie = 0;
 519   bin->priv->message_forward = DEFAULT_MESSAGE_FORWARD;
 520 }
 521
 522 static void
 523 gst_bin_dispose (GObject * object)
 524 {
 525   GstBin *bin = GST_BIN_CAST (object);
 526   GstBus **child_bus_p = &bin->child_bus;
 527   GstClock **provided_clock_p = &bin->provided_clock;
 528   GstElement **clock_provider_p = &bin->clock_provider;
 529   GstIndex **index_p = &bin->priv->index;
 530
 531   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object, "dispose");
 532
 533   GST_OBJECT_LOCK (object);
 534   gst_object_replace ((GstObject **) child_bus_p, NULL);
 535   gst_object_replace ((GstObject **) provided_clock_p, NULL);
 536   gst_object_replace ((GstObject **) clock_provider_p, NULL);
 537   gst_object_replace ((GstObject **) index_p, NULL);
 538   bin_remove_messages (bin, NULL, GST_MESSAGE_ANY);
 539   GST_OBJECT_UNLOCK (object);
 540
 541   while (bin->children) {
 542     gst_bin_remove (bin, GST_ELEMENT_CAST (bin->children->data));
 543   }
 544   if (G_UNLIKELY (bin->children != NULL)) {
 545     g_critical ("could not remove elements from bin '%s'",
 546         GST_STR_NULL (GST_OBJECT_NAME (object)));
 547   }
 548
 549   G_OBJECT_CLASS (parent_class)->dispose (object);
 550 }
 551
 552 /**
 553  * gst_bin_new:
 554  * @name: the name of the new bin
 555  *
 556  * Creates a new bin with the given name.
 557  *
 558  * Returns: (transfer full): a new #GstBin
 559  */
 560 GstElement *
 561 gst_bin_new (const gchar * name)
 562 {
 563   return gst_element_factory_make ("bin", name);
 564 }
 565
 566 static void
 567 gst_bin_set_property (GObject * object, guint prop_id,
 568     const GValue * value, GParamSpec * pspec)
 569 {
 570   GstBin *gstbin;
 571
 572   gstbin = GST_BIN_CAST (object);
 573
 574   switch (prop_id) {
 575     case PROP_ASYNC_HANDLING:
 576       GST_OBJECT_LOCK (gstbin);
 577       gstbin->priv->asynchandling = g_value_get_boolean (value);
 578       GST_OBJECT_UNLOCK (gstbin);
 579       break;
 580     case PROP_MESSAGE_FORWARD:
 581       GST_OBJECT_LOCK (gstbin);
 582       gstbin->priv->message_forward = g_value_get_boolean (value);
 583       GST_OBJECT_UNLOCK (gstbin);
 584       break;
 585     default:
 586       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 587       break;
 588   }
 589 }
 590
 591 static void
 592 gst_bin_get_property (GObject * object, guint prop_id,
 593     GValue * value, GParamSpec * pspec)
 594 {
 595   GstBin *gstbin;
 596
 597   gstbin = GST_BIN_CAST (object);
 598
 599   switch (prop_id) {
 600     case PROP_ASYNC_HANDLING:
 601       GST_OBJECT_LOCK (gstbin);
 602       g_value_set_boolean (value, gstbin->priv->asynchandling);
 603       GST_OBJECT_UNLOCK (gstbin);
 604       break;
 605     case PROP_MESSAGE_FORWARD:
 606       GST_OBJECT_LOCK (gstbin);
 607       g_value_set_boolean (value, gstbin->priv->message_forward);
 608       GST_OBJECT_UNLOCK (gstbin);
 609       break;
 610     default:
 611       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 612       break;
 613   }
 614 }
 615
 616 /* return the cached index */
 617 static GstIndex *
 618 gst_bin_get_index_func (GstElement * element)
 619 {
 620   GstBin *bin;
 621   GstIndex *result;
 622
 623   bin = GST_BIN_CAST (element);
 624
 625   GST_OBJECT_LOCK (bin);
 626   if ((result = bin->priv->index))
 627     gst_object_ref (result);
 628   GST_OBJECT_UNLOCK (bin);
 629
 630   return result;
 631 }
 632
 633 /* set the index on all elements in this bin
 634  *
 635  * MT safe
 636  */
 637 static void
 638 gst_bin_set_index_func (GstElement * element, GstIndex * index)
 639 {
 640   GstBin *bin;
 641   gboolean done;
 642   GstIterator *it;
 643   GstIndex *old;
 644   GValue data = { 0, };
 645
 646   bin = GST_BIN_CAST (element);
 647
 648   GST_OBJECT_LOCK (bin);
 649   old = bin->priv->index;
 650   if (G_UNLIKELY (old == index))
 651     goto was_set;
 652   if (index)
 653     gst_object_ref (index);
 654   bin->priv->index = index;
 655   GST_OBJECT_UNLOCK (bin);
 656
 657   if (old)
 658     gst_object_unref (old);
 659
 660   it = gst_bin_iterate_elements (bin);
 661
 662   /* set the index on all elements in the bin */
 663   done = FALSE;
 664   while (!done) {
 665     switch (gst_iterator_next (it, &data)) {
 666       case GST_ITERATOR_OK:
 667       {
 668         GstElement *child = g_value_get_object (&data);
 669
 670         GST_DEBUG_OBJECT (bin, "setting index on '%s'",
 671             GST_ELEMENT_NAME (child));
 672         gst_element_set_index (child, index);
 673
 674         g_value_reset (&data);
 675         break;
 676       }
 677       case GST_ITERATOR_RESYNC:
 678         GST_DEBUG_OBJECT (bin, "iterator doing resync");
 679         gst_iterator_resync (it);
 680         break;
 681       default:
 682       case GST_ITERATOR_DONE:
 683         GST_DEBUG_OBJECT (bin, "iterator done");
 684         done = TRUE;
 685         break;
 686     }
 687   }
 688   g_value_unset (&data);
 689   gst_iterator_free (it);
 690   return;
 691
 692 was_set:
 693   {
 694     GST_DEBUG_OBJECT (bin, "index was already set");
 695     GST_OBJECT_UNLOCK (bin);
 696     return;
 697   }
 698 }
 699
 700 /* set the clock on all elements in this bin
 701  *
 702  * MT safe
 703  */
 704 static gboolean
 705 gst_bin_set_clock_func (GstElement * element, GstClock * clock)
 706 {
 707   GstBin *bin;
 708   gboolean done;
 709   GstIterator *it;
 710   gboolean res = TRUE;
 711   GValue data = { 0, };
 712
 713   bin = GST_BIN_CAST (element);
 714
 715   it = gst_bin_iterate_elements (bin);
 716
 717   done = FALSE;
 718   while (!done) {
 719     switch (gst_iterator_next (it, &data)) {
 720       case GST_ITERATOR_OK:
 721       {
 722         GstElement *child = g_value_get_object (&data);
 723
 724         res &= gst_element_set_clock (child, clock);
 725
 726         g_value_reset (&data);
 727         break;
 728       }
 729       case GST_ITERATOR_RESYNC:
 730         GST_DEBUG_OBJECT (bin, "iterator doing resync");
 731         gst_iterator_resync (it);
 732         res = TRUE;
 733         break;
 734       default:
 735       case GST_ITERATOR_DONE:
 736         GST_DEBUG_OBJECT (bin, "iterator done");
 737         done = TRUE;
 738         break;
 739     }
 740   }
 741   g_value_unset (&data);
 742   gst_iterator_free (it);
 743
 744   if (res)
 745     res = GST_ELEMENT_CLASS (parent_class)->set_clock (element, clock);
 746
 747   return res;
 748 }
 749
 750 /* get the clock for this bin by asking all of the children in this bin
 751  *
 752  * The ref of the returned clock in increased so unref after usage.
 753  *
 754  * We loop the elements in state order and pick the last clock we can
 755  * get. This makes sure we get a clock from the source.
 756  *
 757  * MT safe
 758  */
 759 static GstClock *
 760 gst_bin_provide_clock_func (GstElement * element)
 761 {
 762   GstClock *result = NULL;
 763   GstElement *provider = NULL;
 764   GstBin *bin;
 765   GstIterator *it;
 766   gboolean done;
 767   GValue val = { 0, };
 768   GstClock **provided_clock_p;
 769   GstElement **clock_provider_p;
 770
 771   bin = GST_BIN_CAST (element);
 772
 773   GST_OBJECT_LOCK (bin);
 774   if (!bin->clock_dirty)
 775     goto not_dirty;
 776
 777   GST_DEBUG_OBJECT (bin, "finding new clock");
 778
 779   it = gst_bin_sort_iterator_new (bin);
 780   GST_OBJECT_UNLOCK (bin);
 781
 782   done = FALSE;
 783   while (!done) {
 784     switch (gst_iterator_next (it, &val)) {
 785       case GST_ITERATOR_OK:
 786       {
 787         GstElement *child = g_value_get_object (&val);
 788         GstClock *clock;
 789
 790         clock = gst_element_provide_clock (child);
 791         if (clock) {
 792           GST_DEBUG_OBJECT (bin, "found candidate clock %p by element %s",
 793               clock, GST_ELEMENT_NAME (child));
 794           if (result) {
 795             gst_object_unref (result);
 796             gst_object_unref (provider);
 797           }
 798           result = clock;
 799           provider = gst_object_ref (child);
 800         }
 801
 802         g_value_reset (&val);
 803         break;
 804       }
 805       case GST_ITERATOR_RESYNC:
 806         gst_iterator_resync (it);
 807         break;
 808       default:
 809       case GST_ITERATOR_DONE:
 810         done = TRUE;
 811         break;
 812     }
 813   }
 814   g_value_unset (&val);
 815   gst_iterator_free (it);
 816
 817   GST_OBJECT_LOCK (bin);
 818   if (!bin->clock_dirty) {
 819     if (provider)
 820       gst_object_unref (provider);
 821     if (result)
 822       gst_object_unref (result);
 823     result = NULL;
 824
 825     goto not_dirty;
 826   }
 827
 828   provided_clock_p = &bin->provided_clock;
 829   clock_provider_p = &bin->clock_provider;
 830   gst_object_replace ((GstObject **) provided_clock_p, (GstObject *) result);
 831   gst_object_replace ((GstObject **) clock_provider_p, (GstObject *) provider);
 832   bin->clock_dirty = FALSE;
 833   GST_DEBUG_OBJECT (bin,
 834       "provided new clock %" GST_PTR_FORMAT " by provider %" GST_PTR_FORMAT,
 835       result, provider);
 836   /* Provider is not being returned to caller, just the result */
 837   if (provider)
 838     gst_object_unref (provider);
 839   GST_OBJECT_UNLOCK (bin);
 840
 841   return result;
 842
 843 not_dirty:
 844   {
 845     if ((result = bin->provided_clock))
 846       gst_object_ref (result);
 847     GST_DEBUG_OBJECT (bin, "returning old clock %p", result);
 848     GST_OBJECT_UNLOCK (bin);
 849
 850     return result;
 851   }
 852 }
 853
 854 /*
 855  * functions for manipulating cached messages
 856  */
 857 typedef struct
 858 {
 859   GstObject *src;
 860   GstMessageType types;
 861 } MessageFind;
 862
 863 /* check if a message is of given src and type */
 864 static gint
 865 message_check (GstMessage * message, MessageFind * target)
 866 {
 867   gboolean eq = TRUE;
 868
 869   if (target->src)
 870     eq &= GST_MESSAGE_SRC (message) == target->src;
 871   if (target->types)
 872     eq &= (GST_MESSAGE_TYPE (message) & target->types) != 0;
 873   GST_LOG ("looking at message %p: %d", message, eq);
 874
 875   return (eq ? 0 : 1);
 876 }
 877
 878 static GList *
 879 find_message (GstBin * bin, GstObject * src, GstMessageType types)
 880 {
 881   GList *result;
 882   MessageFind find;
 883
 884   find.src = src;
 885   find.types = types;
 886
 887   result = g_list_find_custom (bin->messages, &find,
 888       (GCompareFunc) message_check);
 889
 890   if (result) {
 891     GST_DEBUG_OBJECT (bin, "we found a message %p from %s matching types %08x",
 892         result->data, GST_OBJECT_NAME (GST_MESSAGE_CAST (result->data)->src),
 893         types);
 894   } else {
 895     GST_DEBUG_OBJECT (bin, "no message found matching types %08x", types);
 896 #ifndef GST_DISABLE_GST_DEBUG
 897     {
 898       guint i;
 899
 900       for (i = 0; i < 32; i++)
 901         if (types & (1 << i))
 902           GST_DEBUG_OBJECT (bin, "  %s", gst_message_type_get_name (1 << i));
 903     }
 904 #endif
 905   }
 906
 907   return result;
 908 }
 909
 910 /* with LOCK, returns TRUE if message had a valid SRC, takes ownership of
 911  * the message.
 912  *
 913  * A message that is cached and has the same SRC and type is replaced
 914  * by the given message.
 915  */
 916 static gboolean
 917 bin_replace_message (GstBin * bin, GstMessage * message, GstMessageType types)
 918 {
 919   GList *previous;
 920   GstObject *src;
 921   gboolean res = TRUE;
 922
 923   if ((src = GST_MESSAGE_SRC (message))) {
 924     /* first find the previous message posted by this element */
 925     if ((previous = find_message (bin, src, types))) {
 926       GstMessage *previous_msg;
 927
 928       /* if we found a previous message, replace it */
 929       previous_msg = previous->data;
 930       previous->data = message;
 931
 932       GST_DEBUG_OBJECT (bin, "replace old message %s from %s with %s message",
 933           GST_MESSAGE_TYPE_NAME (previous_msg), GST_ELEMENT_NAME (src),
 934           GST_MESSAGE_TYPE_NAME (message));
 935
 936       gst_message_unref (previous_msg);
 937     } else {
 938       /* keep new message */
 939       bin->messages = g_list_prepend (bin->messages, message);
 940
 941       GST_DEBUG_OBJECT (bin, "got new message %p, %s from %s",
 942           message, GST_MESSAGE_TYPE_NAME (message), GST_ELEMENT_NAME (src));
 943     }
 944   } else {
 945     GST_DEBUG_OBJECT (bin, "got message %s from (NULL), not processing",
 946         GST_MESSAGE_TYPE_NAME (message));
 947     res = FALSE;
 948     gst_message_unref (message);
 949   }
 950   return res;
 951 }
 952
 953 /* with LOCK. Remove all messages of given types */
 954 static void
 955 bin_remove_messages (GstBin * bin, GstObject * src, GstMessageType types)
 956 {
 957   MessageFind find;
 958   GList *walk, *next;
 959
 960   find.src = src;
 961   find.types = types;
 962
 963   for (walk = bin->messages; walk; walk = next) {
 964     GstMessage *message = (GstMessage *) walk->data;
 965
 966     next = g_list_next (walk);
 967
 968     if (message_check (message, &find) == 0) {
 969       GST_DEBUG_OBJECT (GST_MESSAGE_SRC (message),
 970           "deleting message %p of types 0x%08x", message, types);
 971       bin->messages = g_list_delete_link (bin->messages, walk);
 972       gst_message_unref (message);
 973     } else {
 974       GST_DEBUG_OBJECT (GST_MESSAGE_SRC (message),
 975           "not deleting message %p of type 0x%08x", message,
 976           GST_MESSAGE_TYPE (message));
 977     }
 978   }
 979 }
 980
 981
 982 /* Check if the bin is EOS. We do this by scanning all sinks and
 983  * checking if they posted an EOS message.
 984  *
 985  * call with bin LOCK */
 986 static gboolean
 987 is_eos (GstBin * bin, guint32 * seqnum)
 988 {
 989   gboolean result;
 990   gint n_eos = 0;
 991   GList *walk, *msgs;
 992
 993   result = TRUE;
 994   for (walk = bin->children; walk; walk = g_list_next (walk)) {
 995     GstElement *element;
 996
 997     element = GST_ELEMENT_CAST (walk->data);
 998     if (bin_element_is_sink (element, bin) == 0) {
 999       /* check if element posted EOS */
1000       if ((msgs =
1001               find_message (bin, GST_OBJECT_CAST (element), GST_MESSAGE_EOS))) {
1002         GST_DEBUG ("sink '%s' posted EOS", GST_ELEMENT_NAME (element));
1003         *seqnum = gst_message_get_seqnum (GST_MESSAGE_CAST (msgs->data));
1004         n_eos++;
1005       } else {
1006         GST_DEBUG ("sink '%s' did not post EOS yet",
1007             GST_ELEMENT_NAME (element));
1008         result = FALSE;
1009         break;
1010       }
1011     }
1012   }
1013   /* FIXME: Some tests (e.g. elements/capsfilter) use
1014    * pipelines with a dangling sinkpad but no sink element.
1015    * These tests assume that no EOS message is ever
1016    * posted on the bus so let's keep that behaviour.
1017    * In valid pipelines this doesn't make a difference.
1018    */
1019   return result && n_eos > 0;
1020 }
1021
1022 static void
1023 unlink_pads (const GValue * item, gpointer user_data)
1024 {
1025   GstPad *pad;
1026   GstPad *peer;
1027
1028   pad = g_value_get_object (item);
1029
1030   if ((peer = gst_pad_get_peer (pad))) {
1031     if (gst_pad_get_direction (pad) == GST_PAD_SRC)
1032       gst_pad_unlink (pad, peer);
1033     else
1034       gst_pad_unlink (peer, pad);
1035     gst_object_unref (peer);
1036   }
1037 }
1038
1039 /* vmethod that adds an element to a bin
1040  *
1041  * MT safe
1042  */
1043 static gboolean
1044 gst_bin_add_func (GstBin * bin, GstElement * element)
1045 {
1046   gchar *elem_name;
1047   GstIterator *it;
1048   gboolean is_sink, is_source;
1049   GstMessage *clock_message = NULL, *async_message = NULL;
1050   GstStateChangeReturn ret;
1051
1052   GST_DEBUG_OBJECT (bin, "element :%s", GST_ELEMENT_NAME (element));
1053
1054   /* we obviously can't add ourself to ourself */
1055   if (G_UNLIKELY (GST_ELEMENT_CAST (element) == GST_ELEMENT_CAST (bin)))
1056     goto adding_itself;
1057
1058   /* get the element name to make sure it is unique in this bin. */
1059   GST_OBJECT_LOCK (element);
1060   elem_name = g_strdup (GST_ELEMENT_NAME (element));
1061   is_sink = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_IS_SINK);
1062   is_source = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_IS_SOURCE);
1063   GST_OBJECT_UNLOCK (element);
1064
1065   GST_OBJECT_LOCK (bin);
1066
1067   /* then check to see if the element's name is already taken in the bin,
1068    * we can safely take the lock here. This check is probably bogus because
1069    * you can safely change the element name after this check and before setting
1070    * the object parent. The window is very small though... */
1071   if (G_UNLIKELY (!gst_object_check_uniqueness (bin->children, elem_name)))
1072     goto duplicate_name;
1073
1074   /* set the element's parent and add the element to the bin's list of children */
1075   if (G_UNLIKELY (!gst_object_set_parent (GST_OBJECT_CAST (element),
1076               GST_OBJECT_CAST (bin))))
1077     goto had_parent;
1078
1079   /* if we add a sink we become a sink */
1080   if (is_sink) {
1081     GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "element \"%s\" was sink",
1082         elem_name);
1083     GST_OBJECT_FLAG_SET (bin, GST_ELEMENT_IS_SINK);
1084   }
1085   if (is_source) {
1086     GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, bin, "element \"%s\" was source",
1087         elem_name);
1088     GST_OBJECT_FLAG_SET (bin, GST_ELEMENT_IS_SOURCE);
1089   }
1090   if (gst_element_provides_clock (element)) {
1091     GST_DEBUG_OBJECT (bin, "element \"%s\" can provide a clock", elem_name);
1092     clock_message =
1093         gst_message_new_clock_provide (GST_OBJECT_CAST (element), NULL, TRUE);
1094   }
1095
1096   bin->children = g_list_prepend (bin->children, element);
1097   bin->numchildren++;
1098   bin->children_cookie++;
1099   bin->priv->structure_cookie++;
1100
1101   /* distribute the bus */
1102   gst_element_set_bus (element, bin->child_bus);
1103
1104   /* propagate the current base_time, start_time and clock */
1105   gst_element_set_base_time (element, GST_ELEMENT_CAST (bin)->base_time);
1106   gst_element_set_start_time (element, GST_ELEMENT_START_TIME (bin));
1107   /* it's possible that the element did not accept the clock but
1108    * that is not important right now. When the pipeline goes to PLAYING,
1109    * a new clock will be selected */
1110   gst_element_set_clock (element, GST_ELEMENT_CLOCK (bin));
1111   /* set the cached index on the children */
1112   if (bin->priv->index)
1113     gst_element_set_index (element, bin->priv->index);
1114
1115   ret = GST_STATE_RETURN (bin);
1116   /* no need to update the state if we are in error */
1117   if (ret == GST_STATE_CHANGE_FAILURE)
1118     goto no_state_recalc;
1119
1120   /* update the bin state, the new element could have been an ASYNC or
1121    * NO_PREROLL element */
1122   ret = GST_STATE_RETURN (element);
1123   GST_DEBUG_OBJECT (bin, "added %s element",
1124       gst_element_state_change_return_get_name (ret));
1125
1126   switch (ret) {
1127     case GST_STATE_CHANGE_ASYNC:
1128     {
1129       /* create message to track this aync element when it posts an async-done
1130        * message */
1131       async_message = gst_message_new_async_start (GST_OBJECT_CAST (element));
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, 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, 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 = 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 immediately. 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     bit->best = NULL;
1997     bit->best_deg = G_MAXINT;
1998     g_list_foreach (bin->children, (GFunc) find_element, bit);
1999     if ((best = bit->best)) {
2000       /* when we detected an unlink, don't warn because our degrees might be
2001        * screwed up. We will resync later */
2002       if (bit->best_deg != 0 && !bit->dirty) {
2003         /* we don't fail on this one yet */
2004         GST_WARNING_OBJECT (bin, "loop dected in graph");
2005         g_warning ("loop detected in the graph of bin '%s'!!",
2006             GST_ELEMENT_NAME (bin));
2007       }
2008       /* best unhandled element, schedule as next element */
2009       GST_DEBUG_OBJECT (bin, "queue empty, next best: %s",
2010           GST_ELEMENT_NAME (best));
2011       HASH_SET_DEGREE (bit, best, -1);
2012       g_value_set_object (result, best);
2013     } else {
2014       GST_DEBUG_OBJECT (bin, "queue empty, elements exhausted");
2015       /* no more unhandled elements, we are done */
2016       return GST_ITERATOR_DONE;
2017     }
2018   } else {
2019     /* everything added to the queue got reffed */
2020     best = g_queue_pop_head (&bit->queue);
2021     g_value_set_object (result, best);
2022     gst_object_unref (best);
2023   }
2024
2025   GST_DEBUG_OBJECT (bin, "queue head gives %s", GST_ELEMENT_NAME (best));
2026   /* update degrees of linked elements */
2027   update_degree (best, bit);
2028
2029   return GST_ITERATOR_OK;
2030 }
2031
2032 /* clear queues, recalculate the degrees and restart. */
2033 static void
2034 gst_bin_sort_iterator_resync (GstBinSortIterator * bit)
2035 {
2036   GstBin *bin = bit->bin;
2037
2038   GST_DEBUG_OBJECT (bin, "resync");
2039   bit->dirty = FALSE;
2040   clear_queue (&bit->queue);
2041   /* reset degrees */
2042   g_list_foreach (bin->children, (GFunc) reset_degree, bit);
2043   /* calc degrees, incrementing */
2044   bit->mode = 1;
2045   g_list_foreach (bin->children, (GFunc) update_degree, bit);
2046   /* for the rest of the function we decrement the degrees */
2047   bit->mode = -1;
2048 }
2049
2050 /* clear queues, unref bin and free iterator. */
2051 static void
2052 gst_bin_sort_iterator_free (GstBinSortIterator * bit)
2053 {
2054   GstBin *bin = bit->bin;
2055
2056   GST_DEBUG_OBJECT (bin, "free");
2057   clear_queue (&bit->queue);
2058   g_hash_table_destroy (bit->hash);
2059   gst_object_unref (bin);
2060 }
2061
2062 /* should be called with the bin LOCK held */
2063 static GstIterator *
2064 gst_bin_sort_iterator_new (GstBin * bin)
2065 {
2066   GstBinSortIterator *result;
2067
2068   /* we don't need an ItemFunction because we ref the items in the _next
2069    * method already */
2070   result = (GstBinSortIterator *)
2071       gst_iterator_new (sizeof (GstBinSortIterator),
2072       GST_TYPE_ELEMENT,
2073       GST_OBJECT_GET_LOCK (bin),
2074       &bin->priv->structure_cookie,
2075       (GstIteratorCopyFunction) gst_bin_sort_iterator_copy,
2076       (GstIteratorNextFunction) gst_bin_sort_iterator_next,
2077       (GstIteratorItemFunction) NULL,
2078       (GstIteratorResyncFunction) gst_bin_sort_iterator_resync,
2079       (GstIteratorFreeFunction) gst_bin_sort_iterator_free);
2080   g_queue_init (&result->queue);
2081   result->hash = g_hash_table_new (NULL, NULL);
2082   gst_object_ref (bin);
2083   result->bin = bin;
2084   gst_bin_sort_iterator_resync (result);
2085
2086   return (GstIterator *) result;
2087 }
2088
2089 /**
2090  * gst_bin_iterate_sorted:
2091  * @bin: a #GstBin
2092  *
2093  * Gets an iterator for the elements in this bin in topologically
2094  * sorted order. This means that the elements are returned from
2095  * the most downstream elements (sinks) to the sources.
2096  *
2097  * This function is used internally to perform the state changes
2098  * of the bin elements and for clock selection.
2099  *
2100  * Each element yielded by the iterator will have its refcount increased, so
2101  * unref after use.
2102  *
2103  * MT safe.  Caller owns returned value.
2104  *
2105  * Returns: (transfer full): a #GstIterator of #GstElement, or NULL
2106  */
2107 GstIterator *
2108 gst_bin_iterate_sorted (GstBin * bin)
2109 {
2110   GstIterator *result;
2111
2112   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
2113
2114   GST_OBJECT_LOCK (bin);
2115   result = gst_bin_sort_iterator_new (bin);
2116   GST_OBJECT_UNLOCK (bin);
2117
2118   return result;
2119 }
2120
2121 static GstStateChangeReturn
2122 gst_bin_element_set_state (GstBin * bin, GstElement * element,
2123     GstClockTime base_time, GstClockTime start_time, GstState current,
2124     GstState next)
2125 {
2126   GstStateChangeReturn ret;
2127   GstState pending, child_current, child_pending;
2128   gboolean locked;
2129   GList *found;
2130
2131   GST_STATE_LOCK (element);
2132
2133   GST_OBJECT_LOCK (element);
2134   /* set base_time and start time on child */
2135   GST_ELEMENT_START_TIME (element) = start_time;
2136   element->base_time = base_time;
2137   /* peel off the locked flag */
2138   locked = GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_LOCKED_STATE);
2139   /* Get the previous set_state result to preserve NO_PREROLL and ASYNC */
2140   ret = GST_STATE_RETURN (element);
2141   child_current = GST_STATE (element);
2142   child_pending = GST_STATE_PENDING (element);
2143   GST_OBJECT_UNLOCK (element);
2144
2145   /* skip locked elements */
2146   if (G_UNLIKELY (locked))
2147     goto locked;
2148
2149   /* if the element was no preroll, just start changing the state regardless
2150    * if it had async elements (in the case of a bin) because they won't preroll
2151    * anyway. */
2152   if (G_UNLIKELY (ret == GST_STATE_CHANGE_NO_PREROLL)) {
2153     GST_DEBUG_OBJECT (element, "element is NO_PREROLL, ignore async elements");
2154     goto no_preroll;
2155   }
2156
2157   GST_OBJECT_LOCK (bin);
2158   pending = GST_STATE_PENDING (bin);
2159
2160   /* Try not to change the state of elements that are already in the state we're
2161    * going to */
2162   if (!(next == GST_STATE_PLAYING || child_pending != GST_STATE_VOID_PENDING ||
2163           (child_pending == GST_STATE_VOID_PENDING &&
2164               ((pending > child_current && next > child_current) ||
2165                   (pending < child_current && next < child_current)))))
2166     goto unneeded;
2167
2168   /* the element was busy with an upwards async state change, we must wait for
2169    * an ASYNC_DONE message before we attemp to change the state. */
2170   if ((found =
2171           find_message (bin, GST_OBJECT_CAST (element),
2172               GST_MESSAGE_ASYNC_START))) {
2173 #ifndef GST_DISABLE_GST_DEBUG
2174     GstMessage *message = GST_MESSAGE_CAST (found->data);
2175
2176     GST_DEBUG_OBJECT (element, "element message %p, %s async busy",
2177         message, GST_ELEMENT_NAME (GST_MESSAGE_SRC (message)));
2178 #endif
2179     /* only wait for upward state changes */
2180     if (next > current) {
2181       /* We found an async element check if we can force its state to change or
2182        * if we have to wait for it to preroll. */
2183       if (G_UNLIKELY (!enable_latency)) {
2184         g_warning ("Future versions of GStreamer will wait for element \"%s\"\n"
2185             "\tto preroll in order to perform correct latency calculations.\n"
2186             "\tPlease verify that the application continues to work correctly by\n"
2187             "\tsetting the environment variable GST_COMPAT to a value containing\n"
2188             "\tthe string 'live-preroll'.", GST_ELEMENT_NAME (element));
2189         goto no_latency;
2190       }
2191       goto was_busy;
2192     }
2193   }
2194 no_latency:
2195   GST_OBJECT_UNLOCK (bin);
2196
2197 no_preroll:
2198   GST_DEBUG_OBJECT (bin,
2199       "setting element %s to %s, base_time %" GST_TIME_FORMAT,
2200       GST_ELEMENT_NAME (element), gst_element_state_get_name (next),
2201       GST_TIME_ARGS (base_time));
2202
2203   /* change state */
2204   ret = gst_element_set_state (element, next);
2205
2206   GST_STATE_UNLOCK (element);
2207
2208   return ret;
2209
2210 locked:
2211   {
2212     GST_DEBUG_OBJECT (element,
2213         "element is locked, return previous return %s",
2214         gst_element_state_change_return_get_name (ret));
2215     GST_STATE_UNLOCK (element);
2216     return ret;
2217   }
2218 was_busy:
2219   {
2220     GST_DEBUG_OBJECT (element, "element was busy, delaying state change");
2221     GST_OBJECT_UNLOCK (bin);
2222     GST_STATE_UNLOCK (element);
2223     return GST_STATE_CHANGE_ASYNC;
2224   }
2225 unneeded:
2226   {
2227     GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2228         "skipping transition from %s to  %s, since bin pending"
2229         " is %s : last change state return follows",
2230         gst_element_state_get_name (child_current),
2231         gst_element_state_get_name (next),
2232         gst_element_state_get_name (pending));
2233     GST_OBJECT_UNLOCK (bin);
2234     GST_STATE_UNLOCK (element);
2235     return ret;
2236   }
2237 }
2238
2239 /* gst_iterator_fold functions for pads_activate
2240  * Stop the iterator if activating one pad failed. */
2241 static gboolean
2242 activate_pads (const GValue * vpad, GValue * ret, gboolean * active)
2243 {
2244   GstPad *pad = g_value_get_object (vpad);
2245   gboolean cont = TRUE;
2246
2247   if (!(cont = gst_pad_set_active (pad, *active)))
2248     g_value_set_boolean (ret, FALSE);
2249
2250   return cont;
2251 }
2252
2253 /* returns false on error or early cutout of the fold, true if all
2254  * pads in @iter were (de)activated successfully. */
2255 static gboolean
2256 iterator_activate_fold_with_resync (GstIterator * iter, gpointer user_data)
2257 {
2258   GstIteratorResult ires;
2259   GValue ret = { 0 };
2260
2261   /* no need to unset this later, it's just a boolean */
2262   g_value_init (&ret, G_TYPE_BOOLEAN);
2263   g_value_set_boolean (&ret, TRUE);
2264
2265   while (1) {
2266     ires = gst_iterator_fold (iter, (GstIteratorFoldFunction) activate_pads,
2267         &ret, user_data);
2268     switch (ires) {
2269       case GST_ITERATOR_RESYNC:
2270         /* need to reset the result again */
2271         g_value_set_boolean (&ret, TRUE);
2272         gst_iterator_resync (iter);
2273         break;
2274       case GST_ITERATOR_DONE:
2275         /* all pads iterated, return collected value */
2276         goto done;
2277       default:
2278         /* iterator returned _ERROR or premature end with _OK,
2279          * mark an error and exit */
2280         g_value_set_boolean (&ret, FALSE);
2281         goto done;
2282     }
2283   }
2284 done:
2285   /* return collected value */
2286   return g_value_get_boolean (&ret);
2287 }
2288
2289 /* is called with STATE_LOCK
2290  */
2291 static gboolean
2292 gst_bin_src_pads_activate (GstBin * bin, gboolean active)
2293 {
2294   GstIterator *iter;
2295   gboolean fold_ok;
2296
2297   GST_DEBUG_OBJECT (bin, "src_pads_activate with active %d", active);
2298
2299   iter = gst_element_iterate_src_pads ((GstElement *) bin);
2300   fold_ok = iterator_activate_fold_with_resync (iter, &active);
2301   gst_iterator_free (iter);
2302   if (G_UNLIKELY (!fold_ok))
2303     goto failed;
2304
2305   GST_DEBUG_OBJECT (bin, "pads_activate successful");
2306
2307   return TRUE;
2308
2309   /* ERRORS */
2310 failed:
2311   {
2312     GST_DEBUG_OBJECT (bin, "source pads_activate failed");
2313     return FALSE;
2314   }
2315 }
2316
2317 /**
2318  * gst_bin_recalculate_latency:
2319  * @bin: a #GstBin
2320  *
2321  * Query @bin for the current latency using and reconfigures this latency to all the
2322  * elements with a LATENCY event.
2323  *
2324  * This method is typically called on the pipeline when a #GST_MESSAGE_LATENCY
2325  * is posted on the bus.
2326  *
2327  * This function simply emits the 'do-latency' signal so any custom latency
2328  * calculations will be performed.
2329  *
2330  * Returns: %TRUE if the latency could be queried and reconfigured.
2331  *
2332  * Since: 0.10.22.
2333  */
2334 gboolean
2335 gst_bin_recalculate_latency (GstBin * bin)
2336 {
2337   gboolean res;
2338
2339   g_signal_emit (bin, gst_bin_signals[DO_LATENCY], 0, &res);
2340   GST_DEBUG_OBJECT (bin, "latency returned %d", res);
2341
2342   return res;
2343 }
2344
2345 static gboolean
2346 gst_bin_do_latency_func (GstBin * bin)
2347 {
2348   GstQuery *query;
2349   GstElement *element;
2350   GstClockTime min_latency, max_latency;
2351   gboolean res;
2352
2353   g_return_val_if_fail (GST_IS_BIN (bin), FALSE);
2354
2355   element = GST_ELEMENT_CAST (bin);
2356
2357   GST_DEBUG_OBJECT (element, "querying latency");
2358
2359   query = gst_query_new_latency ();
2360   if ((res = gst_element_query (element, query))) {
2361     gboolean live;
2362
2363     gst_query_parse_latency (query, &live, &min_latency, &max_latency);
2364
2365     GST_DEBUG_OBJECT (element,
2366         "got min latency %" GST_TIME_FORMAT ", max latency %"
2367         GST_TIME_FORMAT ", live %d", GST_TIME_ARGS (min_latency),
2368         GST_TIME_ARGS (max_latency), live);
2369
2370     if (max_latency < min_latency) {
2371       /* this is an impossible situation, some parts of the pipeline might not
2372        * work correctly. We post a warning for now. */
2373       GST_ELEMENT_WARNING (element, CORE, CLOCK, (NULL),
2374           ("Impossible to configure latency: max %" GST_TIME_FORMAT " < min %"
2375               GST_TIME_FORMAT ". Add queues or other buffering elements.",
2376               GST_TIME_ARGS (max_latency), GST_TIME_ARGS (min_latency)));
2377     }
2378
2379     /* configure latency on elements */
2380     res = gst_element_send_event (element, gst_event_new_latency (min_latency));
2381     if (res) {
2382       GST_INFO_OBJECT (element, "configured latency of %" GST_TIME_FORMAT,
2383           GST_TIME_ARGS (min_latency));
2384     } else {
2385       GST_WARNING_OBJECT (element,
2386           "did not really configure latency of %" GST_TIME_FORMAT,
2387           GST_TIME_ARGS (min_latency));
2388     }
2389   } else {
2390     /* this is not a real problem, we just don't configure any latency. */
2391     GST_WARNING_OBJECT (element, "failed to query latency");
2392   }
2393   gst_query_unref (query);
2394
2395   return res;
2396 }
2397
2398 static void
2399 gst_bin_state_changed (GstElement * element, GstState oldstate,
2400     GstState newstate, GstState pending)
2401 {
2402   GstElementClass *pklass = (GstElementClass *) parent_class;
2403
2404   if (newstate == GST_STATE_PLAYING && pending == GST_STATE_VOID_PENDING)
2405     bin_do_eos (GST_BIN_CAST (element));
2406
2407   if (pklass->state_changed)
2408     pklass->state_changed (element, oldstate, newstate, pending);
2409 }
2410
2411 static GstStateChangeReturn
2412 gst_bin_change_state_func (GstElement * element, GstStateChange transition)
2413 {
2414   GstBin *bin;
2415   GstStateChangeReturn ret;
2416   GstState current, next;
2417   gboolean have_async;
2418   gboolean have_no_preroll;
2419   GstClockTime base_time, start_time;
2420   GstIterator *it;
2421   gboolean done;
2422   GValue data = { 0, };
2423
2424   /* we don't need to take the STATE_LOCK, it is already taken */
2425   current = (GstState) GST_STATE_TRANSITION_CURRENT (transition);
2426   next = (GstState) GST_STATE_TRANSITION_NEXT (transition);
2427
2428   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2429       "changing state of children from %s to %s",
2430       gst_element_state_get_name (current), gst_element_state_get_name (next));
2431
2432   bin = GST_BIN_CAST (element);
2433
2434   switch (next) {
2435     case GST_STATE_PLAYING:
2436     {
2437       gboolean toplevel;
2438
2439       GST_OBJECT_LOCK (bin);
2440       toplevel = BIN_IS_TOPLEVEL (bin);
2441       GST_OBJECT_UNLOCK (bin);
2442
2443       if (toplevel)
2444         gst_bin_recalculate_latency (bin);
2445       break;
2446     }
2447     case GST_STATE_PAUSED:
2448       /* Clear EOS list on next PAUSED */
2449       GST_OBJECT_LOCK (bin);
2450       GST_DEBUG_OBJECT (element, "clearing EOS elements");
2451       bin_remove_messages (bin, NULL, GST_MESSAGE_EOS);
2452       bin->priv->posted_eos = FALSE;
2453       GST_OBJECT_UNLOCK (bin);
2454       if (current == GST_STATE_READY)
2455         if (!(gst_bin_src_pads_activate (bin, TRUE)))
2456           goto activate_failure;
2457       break;
2458     case GST_STATE_READY:
2459       /* Clear message list on next READY */
2460       GST_OBJECT_LOCK (bin);
2461       GST_DEBUG_OBJECT (element, "clearing all cached messages");
2462       bin_remove_messages (bin, NULL, GST_MESSAGE_ANY);
2463       GST_OBJECT_UNLOCK (bin);
2464       if (current == GST_STATE_PAUSED)
2465         if (!(gst_bin_src_pads_activate (bin, FALSE)))
2466           goto activate_failure;
2467       break;
2468     case GST_STATE_NULL:
2469       if (current == GST_STATE_READY)
2470         if (!(gst_bin_src_pads_activate (bin, FALSE)))
2471           goto activate_failure;
2472       break;
2473     default:
2474       break;
2475   }
2476
2477   /* this flag is used to make the async state changes return immediately. We
2478    * don't want them to interfere with this state change */
2479   GST_OBJECT_LOCK (bin);
2480   bin->polling = TRUE;
2481   GST_OBJECT_UNLOCK (bin);
2482
2483   /* iterate in state change order */
2484   it = gst_bin_iterate_sorted (bin);
2485
2486   /* mark if we've seen an ASYNC element in the bin when we did a state change.
2487    * Note how we don't reset this value when a resync happens, the reason being
2488    * that the async element posted ASYNC_START and we want to post ASYNC_DONE
2489    * even after a resync when the async element is gone */
2490   have_async = FALSE;
2491
2492 restart:
2493   /* take base_time */
2494   base_time = gst_element_get_base_time (element);
2495   start_time = gst_element_get_start_time (element);
2496
2497   have_no_preroll = FALSE;
2498
2499   done = FALSE;
2500   while (!done) {
2501     switch (gst_iterator_next (it, &data)) {
2502       case GST_ITERATOR_OK:
2503       {
2504         GstElement *child;
2505
2506         child = g_value_get_object (&data);
2507
2508         /* set state and base_time now */
2509         ret = gst_bin_element_set_state (bin, child, base_time, start_time,
2510             current, next);
2511
2512         switch (ret) {
2513           case GST_STATE_CHANGE_SUCCESS:
2514             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2515                 "child '%s' changed state to %d(%s) successfully",
2516                 GST_ELEMENT_NAME (child), next,
2517                 gst_element_state_get_name (next));
2518             break;
2519           case GST_STATE_CHANGE_ASYNC:
2520           {
2521             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2522                 "child '%s' is changing state asynchronously to %s",
2523                 GST_ELEMENT_NAME (child), gst_element_state_get_name (next));
2524             have_async = TRUE;
2525             break;
2526           }
2527           case GST_STATE_CHANGE_FAILURE:{
2528             GstObject *parent;
2529
2530             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2531                 "child '%s' failed to go to state %d(%s)",
2532                 GST_ELEMENT_NAME (child),
2533                 next, gst_element_state_get_name (next));
2534
2535             /* Only fail if the child is still inside
2536              * this bin. It might've been removed already
2537              * because of the error by the bin subclass
2538              * to ignore the error.  */
2539             parent = gst_object_get_parent (GST_OBJECT_CAST (child));
2540             if (parent == GST_OBJECT_CAST (element)) {
2541               /* element is still in bin, really error now */
2542               gst_object_unref (parent);
2543               goto done;
2544             }
2545             /* child removed from bin, let the resync code redo the state
2546              * change */
2547             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2548                 "child '%s' was removed from the bin",
2549                 GST_ELEMENT_NAME (child));
2550
2551             if (parent)
2552               gst_object_unref (parent);
2553
2554             break;
2555           }
2556           case GST_STATE_CHANGE_NO_PREROLL:
2557             GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2558                 "child '%s' changed state to %d(%s) successfully without preroll",
2559                 GST_ELEMENT_NAME (child), next,
2560                 gst_element_state_get_name (next));
2561             have_no_preroll = TRUE;
2562             break;
2563           default:
2564             g_assert_not_reached ();
2565             break;
2566         }
2567         g_value_reset (&data);
2568         break;
2569       }
2570       case GST_ITERATOR_RESYNC:
2571         GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "iterator doing resync");
2572         gst_iterator_resync (it);
2573         goto restart;
2574       default:
2575       case GST_ITERATOR_DONE:
2576         GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "iterator done");
2577         done = TRUE;
2578         break;
2579     }
2580   }
2581
2582   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
2583   if (G_UNLIKELY (ret == GST_STATE_CHANGE_FAILURE))
2584     goto done;
2585
2586   if (have_no_preroll) {
2587     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2588         "we have NO_PREROLL elements %s -> NO_PREROLL",
2589         gst_element_state_change_return_get_name (ret));
2590     ret = GST_STATE_CHANGE_NO_PREROLL;
2591   } else if (have_async) {
2592     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2593         "we have ASYNC elements %s -> ASYNC",
2594         gst_element_state_change_return_get_name (ret));
2595     ret = GST_STATE_CHANGE_ASYNC;
2596   }
2597
2598 done:
2599   g_value_unset (&data);
2600   gst_iterator_free (it);
2601
2602   GST_OBJECT_LOCK (bin);
2603   bin->polling = FALSE;
2604   /* it's possible that we did not get ASYNC from the children while the bin is
2605    * simulating ASYNC behaviour by posting an ASYNC_DONE message on the bus with
2606    * itself as the source. In that case we still want to check if the state
2607    * change completed. */
2608   if (ret != GST_STATE_CHANGE_ASYNC && !bin->priv->pending_async_done) {
2609     /* no element returned ASYNC and there are no pending async_done messages,
2610      * we can just complete. */
2611     GST_DEBUG_OBJECT (bin, "no async elements");
2612     goto state_end;
2613   }
2614   /* when we get here an ASYNC element was found */
2615   if (GST_STATE_TARGET (bin) <= GST_STATE_READY) {
2616     /* we ignore ASYNC state changes when we go to READY or NULL */
2617     GST_DEBUG_OBJECT (bin, "target state %s <= READY",
2618         gst_element_state_get_name (GST_STATE_TARGET (bin)));
2619     goto state_end;
2620   }
2621
2622   GST_DEBUG_OBJECT (bin, "check async elements");
2623   /* check if all elements managed to commit their state already */
2624   if (!find_message (bin, NULL, GST_MESSAGE_ASYNC_START)) {
2625     /* nothing found, remove all old ASYNC_DONE messages. This can happen when
2626      * all the elements commited their state while we were doing the state
2627      * change. We will still return ASYNC for consistency but we commit the
2628      * state already so that a _get_state() will return immediately. */
2629     bin_remove_messages (bin, NULL, GST_MESSAGE_ASYNC_DONE);
2630
2631     GST_DEBUG_OBJECT (bin, "async elements commited");
2632     bin_handle_async_done (bin, GST_STATE_CHANGE_SUCCESS, FALSE, FALSE);
2633   }
2634
2635 state_end:
2636   bin->priv->pending_async_done = FALSE;
2637   GST_OBJECT_UNLOCK (bin);
2638
2639   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2640       "done changing bin's state from %s to %s, now in %s, ret %s",
2641       gst_element_state_get_name (current),
2642       gst_element_state_get_name (next),
2643       gst_element_state_get_name (GST_STATE (element)),
2644       gst_element_state_change_return_get_name (ret));
2645
2646   return ret;
2647
2648   /* ERRORS */
2649 activate_failure:
2650   {
2651     GST_CAT_WARNING_OBJECT (GST_CAT_STATES, element,
2652         "failure (de)activating src pads");
2653     return GST_STATE_CHANGE_FAILURE;
2654   }
2655 }
2656
2657 /*
2658  * This function is a utility event handler for seek events.
2659  * It will send the event to all sinks or sources depending on the
2660  * event-direction.
2661  *
2662  * Applications are free to override this behaviour and
2663  * implement their own seek handler, but this will work for
2664  * pretty much all cases in practice.
2665  */
2666 static gboolean
2667 gst_bin_send_event (GstElement * element, GstEvent * event)
2668 {
2669   GstBin *bin = GST_BIN_CAST (element);
2670   GstIterator *iter;
2671   gboolean res = TRUE;
2672   gboolean done = FALSE;
2673   GValue data = { 0, };
2674
2675   if (GST_EVENT_IS_DOWNSTREAM (event)) {
2676     iter = gst_bin_iterate_sources (bin);
2677     GST_DEBUG_OBJECT (bin, "Sending %s event to src children",
2678         GST_EVENT_TYPE_NAME (event));
2679   } else {
2680     iter = gst_bin_iterate_sinks (bin);
2681     GST_DEBUG_OBJECT (bin, "Sending %s event to sink children",
2682         GST_EVENT_TYPE_NAME (event));
2683   }
2684
2685   while (!done) {
2686     switch (gst_iterator_next (iter, &data)) {
2687       case GST_ITERATOR_OK:
2688       {
2689         GstElement *child = g_value_get_object (&data);;
2690
2691         gst_event_ref (event);
2692         res &= gst_element_send_event (child, event);
2693         GST_LOG_OBJECT (child, "After handling %s event: %d",
2694             GST_EVENT_TYPE_NAME (event), res);
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    * immediately. */
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)
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 = gst_message_new_async_start (GST_OBJECT_CAST (bin));
2825
2826   if (bin->polling || GST_STATE_PENDING (bin) != GST_STATE_VOID_PENDING)
2827     goto was_busy;
2828
2829   /* async starts are ignored when we are NO_PREROLL */
2830   if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_NO_PREROLL)
2831     goto was_no_preroll;
2832
2833   old_state = GST_STATE (bin);
2834
2835   /* when we PLAYING we go back to PAUSED, when preroll happens, we go back to
2836    * PLAYING after optionally redistributing the base_time. */
2837   if (old_state > GST_STATE_PAUSED)
2838     new_state = GST_STATE_PAUSED;
2839   else
2840     new_state = old_state;
2841
2842   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin,
2843       "lost state of %s, new %s", gst_element_state_get_name (old_state),
2844       gst_element_state_get_name (new_state));
2845
2846   GST_STATE (bin) = new_state;
2847   GST_STATE_NEXT (bin) = new_state;
2848   GST_STATE_PENDING (bin) = new_state;
2849   GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
2850   GST_OBJECT_UNLOCK (bin);
2851
2852   /* post message */
2853   _priv_gst_element_state_changed (GST_ELEMENT_CAST (bin), new_state, new_state,
2854       new_state);
2855
2856 post_start:
2857   if (amessage) {
2858     /* post our ASYNC_START. */
2859     GST_DEBUG_OBJECT (bin, "posting ASYNC_START to parent");
2860     gst_element_post_message (GST_ELEMENT_CAST (bin), amessage);
2861   }
2862   GST_OBJECT_LOCK (bin);
2863
2864   return;
2865
2866 had_error:
2867   {
2868     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "we had an error");
2869     return;
2870   }
2871 was_busy:
2872   {
2873     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "state change busy");
2874     GST_OBJECT_UNLOCK (bin);
2875     goto post_start;
2876   }
2877 was_no_preroll:
2878   {
2879     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "ignoring, we are NO_PREROLL");
2880     GST_OBJECT_UNLOCK (bin);
2881     goto post_start;
2882   }
2883 }
2884
2885 /* this function is called when there are no more async elements in the bin. We
2886  * post a state changed message and an ASYNC_DONE message.
2887  * This function is called with the OBJECT lock.
2888  */
2889 static void
2890 bin_handle_async_done (GstBin * bin, GstStateChangeReturn ret,
2891     gboolean flag_pending, gboolean reset_time)
2892 {
2893   GstState current, pending, target;
2894   GstStateChangeReturn old_ret;
2895   GstState old_state, old_next;
2896   gboolean toplevel, state_changed = FALSE;
2897   GstMessage *amessage = NULL;
2898   BinContinueData *cont = NULL;
2899
2900   if (GST_STATE_RETURN (bin) == GST_STATE_CHANGE_FAILURE)
2901     goto had_error;
2902
2903   pending = GST_STATE_PENDING (bin);
2904
2905   if (bin->polling)
2906     goto was_busy;
2907
2908   /* check if there is something to commit */
2909   if (pending == GST_STATE_VOID_PENDING)
2910     goto nothing_pending;
2911
2912   old_ret = GST_STATE_RETURN (bin);
2913   GST_STATE_RETURN (bin) = ret;
2914
2915   /* move to the next target state */
2916   target = GST_STATE_TARGET (bin);
2917   pending = GST_STATE_PENDING (bin) = target;
2918
2919   amessage = gst_message_new_async_done (GST_OBJECT_CAST (bin), reset_time);
2920
2921   old_state = GST_STATE (bin);
2922   /* this is the state we should go to next */
2923   old_next = GST_STATE_NEXT (bin);
2924
2925   if (old_next != GST_STATE_PLAYING) {
2926     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2927         "committing state from %s to %s, old pending %s",
2928         gst_element_state_get_name (old_state),
2929         gst_element_state_get_name (old_next),
2930         gst_element_state_get_name (pending));
2931
2932     /* update current state */
2933     current = GST_STATE (bin) = old_next;
2934   } else {
2935     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2936         "setting state from %s to %s, pending %s",
2937         gst_element_state_get_name (old_state),
2938         gst_element_state_get_name (old_state),
2939         gst_element_state_get_name (pending));
2940     current = old_state;
2941   }
2942
2943   /* get our toplevel state */
2944   toplevel = BIN_IS_TOPLEVEL (bin);
2945
2946   /* see if we reached the final state. If we are not toplevel, we also have to
2947    * stop here, the parent will continue our state. */
2948   if ((pending == current) || !toplevel) {
2949     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2950         "completed state change, pending VOID");
2951
2952     /* mark VOID pending */
2953     pending = GST_STATE_VOID_PENDING;
2954     GST_STATE_PENDING (bin) = pending;
2955     GST_STATE_NEXT (bin) = GST_STATE_VOID_PENDING;
2956   } else {
2957     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin,
2958         "continue state change, pending %s",
2959         gst_element_state_get_name (pending));
2960
2961     cont = g_slice_new (BinContinueData);
2962
2963     /* ref to the bin */
2964     cont->bin = gst_object_ref (bin);
2965     /* cookie to detect concurrent state change */
2966     cont->cookie = GST_ELEMENT_CAST (bin)->state_cookie;
2967     /* pending target state */
2968     cont->pending = pending;
2969     /* mark busy */
2970     GST_STATE_RETURN (bin) = GST_STATE_CHANGE_ASYNC;
2971     GST_STATE_NEXT (bin) = GST_STATE_GET_NEXT (old_state, pending);
2972   }
2973
2974   if (old_next != GST_STATE_PLAYING) {
2975     if (old_state != old_next || old_ret == GST_STATE_CHANGE_ASYNC) {
2976       state_changed = TRUE;
2977     }
2978   }
2979   GST_OBJECT_UNLOCK (bin);
2980
2981   if (state_changed) {
2982     _priv_gst_element_state_changed (GST_ELEMENT_CAST (bin), old_state,
2983         old_next, pending);
2984   }
2985   if (amessage) {
2986     /* post our combined ASYNC_DONE when all is ASYNC_DONE. */
2987     GST_DEBUG_OBJECT (bin, "posting ASYNC_DONE to parent");
2988     gst_element_post_message (GST_ELEMENT_CAST (bin), amessage);
2989   }
2990
2991   GST_OBJECT_LOCK (bin);
2992   if (cont) {
2993     /* toplevel, start continue state */
2994     GST_DEBUG_OBJECT (bin, "all async-done, starting state continue");
2995     bin_push_state_continue (cont);
2996   } else {
2997     GST_DEBUG_OBJECT (bin, "state change complete");
2998     GST_STATE_BROADCAST (bin);
2999   }
3000   return;
3001
3002 had_error:
3003   {
3004     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "we had an error");
3005     return;
3006   }
3007 was_busy:
3008   {
3009     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, bin, "state change busy");
3010     /* if we were busy with a state change and we are requested to flag a
3011      * pending async done, we do so here */
3012     if (flag_pending)
3013       bin->priv->pending_async_done = TRUE;
3014     return;
3015   }
3016 nothing_pending:
3017   {
3018     GST_CAT_INFO_OBJECT (GST_CAT_STATES, bin, "nothing pending");
3019     return;
3020   }
3021 }
3022
3023 static void
3024 bin_do_eos (GstBin * bin)
3025 {
3026   guint32 seqnum = 0;
3027   gboolean eos;
3028
3029   GST_OBJECT_LOCK (bin);
3030   /* If all sinks are EOS, we're in PLAYING and no state change is pending
3031    * we forward the EOS message to the parent bin or application
3032    */
3033   eos = GST_STATE (bin) == GST_STATE_PLAYING
3034       && GST_STATE_PENDING (bin) == GST_STATE_VOID_PENDING
3035       && is_eos (bin, &seqnum);
3036   GST_OBJECT_UNLOCK (bin);
3037
3038   if (eos
3039       && g_atomic_int_compare_and_exchange (&bin->priv->posted_eos, FALSE,
3040           TRUE)) {
3041     GstMessage *tmessage;
3042     tmessage = gst_message_new_eos (GST_OBJECT_CAST (bin));
3043     gst_message_set_seqnum (tmessage, seqnum);
3044     GST_DEBUG_OBJECT (bin,
3045         "all sinks posted EOS, posting seqnum #%" G_GUINT32_FORMAT, seqnum);
3046     gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3047   }
3048 }
3049
3050 /* must be called with the object lock. This function releases the lock to post
3051  * the message. */
3052 static void
3053 bin_do_message_forward (GstBin * bin, GstMessage * message)
3054 {
3055   if (bin->priv->message_forward) {
3056     GstMessage *forwarded;
3057
3058     GST_DEBUG_OBJECT (bin, "pass %s message upward",
3059         GST_MESSAGE_TYPE_NAME (message));
3060     GST_OBJECT_UNLOCK (bin);
3061
3062     /* we need to convert these messages to element messages so that our parent
3063      * bin can easily ignore them and so that the application can easily
3064      * distinguish between the internally forwarded and the real messages. */
3065     forwarded = gst_message_new_element (GST_OBJECT_CAST (bin),
3066         gst_structure_new ("GstBinForwarded",
3067             "message", GST_TYPE_MESSAGE, message, NULL));
3068
3069     gst_element_post_message (GST_ELEMENT_CAST (bin), forwarded);
3070
3071     GST_OBJECT_LOCK (bin);
3072   }
3073 }
3074
3075 /* handle child messages:
3076  *
3077  * This method is called synchronously when a child posts a message on
3078  * the internal bus.
3079  *
3080  * GST_MESSAGE_EOS: This message is only posted by sinks
3081  *     in the PLAYING state. If all sinks posted the EOS message, post
3082  *     one upwards.
3083  *
3084  * GST_MESSAGE_STATE_DIRTY: Deprecated
3085  *
3086  * GST_MESSAGE_SEGMENT_START: just collect, never forward upwards. If an
3087  *     element posts segment_start twice, only the last message is kept.
3088  *
3089  * GST_MESSAGE_SEGMENT_DONE: replace SEGMENT_START message from same poster
3090  *     with the segment_done message. If there are no more segment_start
3091  *     messages, post segment_done message upwards.
3092  *
3093  * GST_MESSAGE_DURATION: remove all previously cached duration messages.
3094  *     Whenever someone performs a duration query on the bin, we store the
3095  *     result so we can answer it quicker the next time. Any element that
3096  *     changes its duration marks our cached values invalid.
3097  *     This message is also posted upwards. This is currently disabled
3098  *     because too many elements don't post DURATION messages when the
3099  *     duration changes.
3100  *
3101  * GST_MESSAGE_CLOCK_LOST: This message is posted by an element when it
3102  *     can no longer provide a clock. The default bin behaviour is to
3103  *     check if the lost clock was the one provided by the bin. If so and
3104  *     we are currently in the PLAYING state, we forward the message to
3105  *     our parent.
3106  *     This message is also generated when we remove a clock provider from
3107  *     a bin. If this message is received by the application, it should
3108  *     PAUSE the pipeline and set it back to PLAYING to force a new clock
3109  *     and a new base_time distribution.
3110  *
3111  * GST_MESSAGE_CLOCK_PROVIDE: This message is generated when an element
3112  *     can provide a clock. This mostly happens when we add a new clock
3113  *     provider to the bin. The default behaviour of the bin is to mark the
3114  *     currently selected clock as dirty, which will perform a clock
3115  *     recalculation the next time we are asked to provide a clock.
3116  *     This message is never sent to the application but is forwarded to
3117  *     the parent.
3118  *
3119  * GST_MESSAGE_ASYNC_START: Create an internal ELEMENT message that stores
3120  *     the state of the element and the fact that the element will need a
3121  *     new base_time. This message is not forwarded to the application.
3122  *
3123  * GST_MESSAGE_ASYNC_DONE: Find the internal ELEMENT message we kept for the
3124  *     element when it posted ASYNC_START. If all elements are done, post a
3125  *     ASYNC_DONE message to the parent.
3126  *
3127  * OTHER: post upwards.
3128  */
3129 static void
3130 gst_bin_handle_message_func (GstBin * bin, GstMessage * message)
3131 {
3132   GstObject *src;
3133   GstMessageType type;
3134   GstMessage *tmessage;
3135   guint32 seqnum;
3136
3137   src = GST_MESSAGE_SRC (message);
3138   type = GST_MESSAGE_TYPE (message);
3139
3140   GST_DEBUG_OBJECT (bin, "[msg %p] handling child %s message of type %s",
3141       message, src ? GST_ELEMENT_NAME (src) : "(NULL)",
3142       GST_MESSAGE_TYPE_NAME (message));
3143
3144   switch (type) {
3145     case GST_MESSAGE_ERROR:
3146     {
3147       GST_OBJECT_LOCK (bin);
3148       /* flag error */
3149       GST_DEBUG_OBJECT (bin, "got ERROR message, unlocking state change");
3150       GST_STATE_RETURN (bin) = GST_STATE_CHANGE_FAILURE;
3151       GST_STATE_BROADCAST (bin);
3152       GST_OBJECT_UNLOCK (bin);
3153
3154       goto forward;
3155     }
3156     case GST_MESSAGE_EOS:
3157     {
3158
3159       /* collect all eos messages from the children */
3160       GST_OBJECT_LOCK (bin);
3161       bin_do_message_forward (bin, message);
3162       /* ref message for future use  */
3163       bin_replace_message (bin, message, GST_MESSAGE_EOS);
3164       GST_OBJECT_UNLOCK (bin);
3165
3166       bin_do_eos (bin);
3167       break;
3168     }
3169     case GST_MESSAGE_STATE_DIRTY:
3170     {
3171       GST_WARNING_OBJECT (bin, "received deprecated STATE_DIRTY message");
3172
3173       /* free message */
3174       gst_message_unref (message);
3175       break;
3176     }
3177     case GST_MESSAGE_SEGMENT_START:{
3178       gboolean post = FALSE;
3179       GstFormat format;
3180       gint64 position;
3181
3182       gst_message_parse_segment_start (message, &format, &position);
3183       seqnum = gst_message_get_seqnum (message);
3184
3185       GST_OBJECT_LOCK (bin);
3186       bin_do_message_forward (bin, message);
3187       /* if this is the first segment-start, post to parent but not to the
3188        * application */
3189       if (!find_message (bin, NULL, GST_MESSAGE_SEGMENT_START) &&
3190           (GST_OBJECT_PARENT (bin) != NULL)) {
3191         post = TRUE;
3192       }
3193       /* replace any previous segment_start message from this source
3194        * with the new segment start message */
3195       bin_replace_message (bin, message, GST_MESSAGE_SEGMENT_START);
3196       GST_OBJECT_UNLOCK (bin);
3197       if (post) {
3198         tmessage = gst_message_new_segment_start (GST_OBJECT_CAST (bin),
3199             format, position);
3200         gst_message_set_seqnum (tmessage, seqnum);
3201
3202         /* post segment start with initial format and position. */
3203         GST_DEBUG_OBJECT (bin, "posting SEGMENT_START (%u) bus message: %p",
3204             seqnum, message);
3205         gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3206       }
3207       break;
3208     }
3209     case GST_MESSAGE_SEGMENT_DONE:
3210     {
3211       gboolean post = FALSE;
3212       GstFormat format;
3213       gint64 position;
3214
3215       gst_message_parse_segment_done (message, &format, &position);
3216       seqnum = gst_message_get_seqnum (message);
3217
3218       GST_OBJECT_LOCK (bin);
3219       bin_do_message_forward (bin, message);
3220       bin_replace_message (bin, message, GST_MESSAGE_SEGMENT_START);
3221       /* if there are no more segment_start messages, everybody posted
3222        * a segment_done and we can post one on the bus. */
3223
3224       /* we don't care who still has a pending segment start */
3225       if (!find_message (bin, NULL, GST_MESSAGE_SEGMENT_START)) {
3226         /* nothing found */
3227         post = TRUE;
3228         /* remove all old segment_done messages */
3229         bin_remove_messages (bin, NULL, GST_MESSAGE_SEGMENT_DONE);
3230       }
3231       GST_OBJECT_UNLOCK (bin);
3232       if (post) {
3233         tmessage = gst_message_new_segment_done (GST_OBJECT_CAST (bin),
3234             format, position);
3235         gst_message_set_seqnum (tmessage, seqnum);
3236
3237         /* post segment done with latest format and position. */
3238         GST_DEBUG_OBJECT (bin, "posting SEGMENT_DONE (%u) bus message: %p",
3239             seqnum, message);
3240         gst_element_post_message (GST_ELEMENT_CAST (bin), tmessage);
3241       }
3242       break;
3243     }
3244     case GST_MESSAGE_DURATION:
3245     {
3246       /* remove all cached duration messages, next time somebody asks
3247        * for duration, we will recalculate. */
3248       GST_OBJECT_LOCK (bin);
3249       bin_remove_messages (bin, NULL, GST_MESSAGE_DURATION);
3250       GST_OBJECT_UNLOCK (bin);
3251       goto forward;
3252     }
3253     case GST_MESSAGE_CLOCK_LOST:
3254     {
3255       GstClock **provided_clock_p;
3256       GstElement **clock_provider_p;
3257       gboolean playing, provided, forward;
3258       GstClock *clock;
3259
3260       gst_message_parse_clock_lost (message, &clock);
3261
3262       GST_OBJECT_LOCK (bin);
3263       bin->clock_dirty = TRUE;
3264       /* if we lost the clock that we provided, post to parent but
3265        * only if we are PLAYING. */
3266       provided = (clock == bin->provided_clock);
3267       playing = (GST_STATE (bin) == GST_STATE_PLAYING);
3268       forward = playing & provided;
3269       if (provided) {
3270         GST_DEBUG_OBJECT (bin,
3271             "Lost clock %" GST_PTR_FORMAT " provided by %" GST_PTR_FORMAT,
3272             bin->provided_clock, bin->clock_provider);
3273         provided_clock_p = &bin->provided_clock;
3274         clock_provider_p = &bin->clock_provider;
3275         gst_object_replace ((GstObject **) provided_clock_p, NULL);
3276         gst_object_replace ((GstObject **) clock_provider_p, NULL);
3277       }
3278       GST_DEBUG_OBJECT (bin, "provided %d, playing %d, forward %d",
3279           provided, playing, forward);
3280       GST_OBJECT_UNLOCK (bin);
3281
3282       if (forward)
3283         goto forward;
3284
3285       /* free message */
3286       gst_message_unref (message);
3287       break;
3288     }
3289     case GST_MESSAGE_CLOCK_PROVIDE:
3290     {
3291       gboolean forward;
3292
3293       GST_OBJECT_LOCK (bin);
3294       bin->clock_dirty = TRUE;
3295       /* a new clock is available, post to parent but not
3296        * to the application */
3297       forward = GST_OBJECT_PARENT (bin) != NULL;
3298       GST_OBJECT_UNLOCK (bin);
3299
3300       if (forward)
3301         goto forward;
3302
3303       /* free message */
3304       gst_message_unref (message);
3305       break;
3306     }
3307     case GST_MESSAGE_ASYNC_START:
3308     {
3309       GstState target;
3310
3311       GST_DEBUG_OBJECT (bin, "ASYNC_START message %p, %s", message,
3312           src ? GST_OBJECT_NAME (src) : "(NULL)");
3313
3314       GST_OBJECT_LOCK (bin);
3315       bin_do_message_forward (bin, message);
3316
3317       /* we ignore the message if we are going to <= READY */
3318       if ((target = GST_STATE_TARGET (bin)) <= GST_STATE_READY)
3319         goto ignore_start_message;
3320
3321       /* takes ownership of the message */
3322       bin_replace_message (bin, message, GST_MESSAGE_ASYNC_START);
3323
3324       bin_handle_async_start (bin);
3325       GST_OBJECT_UNLOCK (bin);
3326       break;
3327
3328     ignore_start_message:
3329       {
3330         GST_DEBUG_OBJECT (bin, "ignoring message, target %s",
3331             gst_element_state_get_name (target));
3332         GST_OBJECT_UNLOCK (bin);
3333         gst_message_unref (message);
3334         break;
3335       }
3336     }
3337     case GST_MESSAGE_ASYNC_DONE:
3338     {
3339       gboolean reset_time;
3340       GstState target;
3341
3342       GST_DEBUG_OBJECT (bin, "ASYNC_DONE message %p, %s", message,
3343           src ? GST_OBJECT_NAME (src) : "(NULL)");
3344
3345       gst_message_parse_async_done (message, &reset_time);
3346
3347       GST_OBJECT_LOCK (bin);
3348       bin_do_message_forward (bin, message);
3349
3350       /* ignore messages if we are shutting down */
3351       if ((target = GST_STATE_TARGET (bin)) <= GST_STATE_READY)
3352         goto ignore_done_message;
3353
3354       bin_replace_message (bin, message, GST_MESSAGE_ASYNC_START);
3355       /* if there are no more ASYNC_START messages, everybody posted
3356        * a ASYNC_DONE and we can post one on the bus. When checking, we
3357        * don't care who still has a pending ASYNC_START */
3358       if (!find_message (bin, NULL, GST_MESSAGE_ASYNC_START)) {
3359         /* nothing found, remove all old ASYNC_DONE messages */
3360         bin_remove_messages (bin, NULL, GST_MESSAGE_ASYNC_DONE);
3361
3362         GST_DEBUG_OBJECT (bin, "async elements commited");
3363         /* when we get an async done message when a state change was busy, we
3364          * need to set the pending_done flag so that at the end of the state
3365          * change we can see if we need to verify pending async elements, hence
3366          * the TRUE argument here. */
3367         bin_handle_async_done (bin, GST_STATE_CHANGE_SUCCESS, TRUE, reset_time);
3368       } else {
3369         GST_DEBUG_OBJECT (bin, "there are more async elements pending");
3370       }
3371       GST_OBJECT_UNLOCK (bin);
3372       break;
3373
3374     ignore_done_message:
3375       {
3376         GST_DEBUG_OBJECT (bin, "ignoring message, target %s",
3377             gst_element_state_get_name (target));
3378         GST_OBJECT_UNLOCK (bin);
3379         gst_message_unref (message);
3380         break;
3381       }
3382     }
3383     case GST_MESSAGE_STRUCTURE_CHANGE:
3384     {
3385       gboolean busy;
3386
3387       gst_message_parse_structure_change (message, NULL, NULL, &busy);
3388
3389       GST_OBJECT_LOCK (bin);
3390       if (busy) {
3391         /* while the pad is busy, avoid following it when doing state changes.
3392          * Don't update the cookie yet, we will do that after the structure
3393          * change finished and we are ready to inspect the new updated
3394          * structure. */
3395         bin_replace_message (bin, message, GST_MESSAGE_STRUCTURE_CHANGE);
3396         message = NULL;
3397       } else {
3398         /* a pad link/unlink ended, signal the state change iterator that we
3399          * need to resync by updating the structure_cookie. */
3400         bin_remove_messages (bin, GST_MESSAGE_SRC (message),
3401             GST_MESSAGE_STRUCTURE_CHANGE);
3402         bin->priv->structure_cookie++;
3403       }
3404       GST_OBJECT_UNLOCK (bin);
3405
3406       if (message)
3407         gst_message_unref (message);
3408
3409       break;
3410     }
3411     default:
3412       goto forward;
3413   }
3414   return;
3415
3416 forward:
3417   {
3418     /* Send all other messages upward */
3419     GST_DEBUG_OBJECT (bin, "posting message upward");
3420     gst_element_post_message (GST_ELEMENT_CAST (bin), message);
3421     return;
3422   }
3423 }
3424
3425 /* generic struct passed to all query fold methods */
3426 typedef struct
3427 {
3428   GstQuery *query;
3429   gint64 min;
3430   gint64 max;
3431   gboolean live;
3432 } QueryFold;
3433
3434 typedef void (*QueryInitFunction) (GstBin * bin, QueryFold * fold);
3435 typedef void (*QueryDoneFunction) (GstBin * bin, QueryFold * fold);
3436
3437 /* for duration/position we collect all durations/positions and take
3438  * the MAX of all valid results */
3439 static void
3440 bin_query_min_max_init (GstBin * bin, QueryFold * fold)
3441 {
3442   fold->min = 0;
3443   fold->max = -1;
3444   fold->live = FALSE;
3445 }
3446
3447 static gboolean
3448 bin_query_duration_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3449 {
3450   GstElement *item = g_value_get_object (vitem);
3451
3452   if (gst_element_query (item, fold->query)) {
3453     gint64 duration;
3454
3455     g_value_set_boolean (ret, TRUE);
3456
3457     gst_query_parse_duration (fold->query, NULL, &duration);
3458
3459     GST_DEBUG_OBJECT (item, "got duration %" G_GINT64_FORMAT, duration);
3460
3461     if (duration > fold->max)
3462       fold->max = duration;
3463   }
3464
3465   return TRUE;
3466 }
3467
3468 static void
3469 bin_query_duration_done (GstBin * bin, QueryFold * fold)
3470 {
3471   GstFormat format;
3472
3473   gst_query_parse_duration (fold->query, &format, NULL);
3474   /* store max in query result */
3475   gst_query_set_duration (fold->query, format, fold->max);
3476
3477   GST_DEBUG_OBJECT (bin, "max duration %" G_GINT64_FORMAT, fold->max);
3478
3479   /* and cache now */
3480   GST_OBJECT_LOCK (bin);
3481   bin->messages = g_list_prepend (bin->messages,
3482       gst_message_new_duration (GST_OBJECT_CAST (bin), format, fold->max));
3483   GST_OBJECT_UNLOCK (bin);
3484 }
3485
3486 static gboolean
3487 bin_query_position_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3488 {
3489   GstElement *item = g_value_get_object (vitem);
3490
3491   if (gst_element_query (item, fold->query)) {
3492     gint64 position;
3493
3494     g_value_set_boolean (ret, TRUE);
3495
3496     gst_query_parse_position (fold->query, NULL, &position);
3497
3498     GST_DEBUG_OBJECT (item, "got position %" G_GINT64_FORMAT, position);
3499
3500     if (position > fold->max)
3501       fold->max = position;
3502   }
3503
3504   return TRUE;
3505 }
3506
3507 static void
3508 bin_query_position_done (GstBin * bin, QueryFold * fold)
3509 {
3510   GstFormat format;
3511
3512   gst_query_parse_position (fold->query, &format, NULL);
3513   /* store max in query result */
3514   gst_query_set_position (fold->query, format, fold->max);
3515
3516   GST_DEBUG_OBJECT (bin, "max position %" G_GINT64_FORMAT, fold->max);
3517 }
3518
3519 static gboolean
3520 bin_query_latency_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3521 {
3522   GstElement *item = g_value_get_object (vitem);
3523
3524   if (gst_element_query (item, fold->query)) {
3525     GstClockTime min, max;
3526     gboolean live;
3527
3528     gst_query_parse_latency (fold->query, &live, &min, &max);
3529
3530     GST_DEBUG_OBJECT (item,
3531         "got latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
3532         ", live %d", GST_TIME_ARGS (min), GST_TIME_ARGS (max), live);
3533
3534     /* for the combined latency we collect the MAX of all min latencies and
3535      * the MIN of all max latencies */
3536     if (live) {
3537       if (min > fold->min)
3538         fold->min = min;
3539       if (fold->max == -1)
3540         fold->max = max;
3541       else if (max < fold->max)
3542         fold->max = max;
3543       if (fold->live == FALSE)
3544         fold->live = live;
3545     }
3546   } else {
3547     g_value_set_boolean (ret, FALSE);
3548     GST_DEBUG_OBJECT (item, "failed query");
3549   }
3550
3551   return TRUE;
3552 }
3553
3554 static void
3555 bin_query_latency_done (GstBin * bin, QueryFold * fold)
3556 {
3557   /* store max in query result */
3558   gst_query_set_latency (fold->query, fold->live, fold->min, fold->max);
3559
3560   GST_DEBUG_OBJECT (bin,
3561       "latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
3562       ", live %d", GST_TIME_ARGS (fold->min), GST_TIME_ARGS (fold->max),
3563       fold->live);
3564 }
3565
3566 /* generic fold, return first valid result */
3567 static gboolean
3568 bin_query_generic_fold (const GValue * vitem, GValue * ret, QueryFold * fold)
3569 {
3570   GstElement *item = g_value_get_object (vitem);
3571   gboolean res;
3572
3573   if ((res = gst_element_query (item, fold->query))) {
3574     g_value_set_boolean (ret, TRUE);
3575     GST_DEBUG_OBJECT (item, "answered query %p", fold->query);
3576   }
3577
3578   /* and stop as soon as we have a valid result */
3579   return !res;
3580 }
3581
3582 static gboolean
3583 gst_bin_query (GstElement * element, GstQuery * query)
3584 {
3585   GstBin *bin = GST_BIN_CAST (element);
3586   GstIterator *iter;
3587   gboolean res = FALSE;
3588   GstIteratorFoldFunction fold_func;
3589   QueryInitFunction fold_init = NULL;
3590   QueryDoneFunction fold_done = NULL;
3591   QueryFold fold_data;
3592   GValue ret = { 0 };
3593
3594   switch (GST_QUERY_TYPE (query)) {
3595     case GST_QUERY_DURATION:
3596     {
3597       GList *cached;
3598       GstFormat qformat;
3599
3600       gst_query_parse_duration (query, &qformat, NULL);
3601
3602       /* find cached duration query */
3603       GST_OBJECT_LOCK (bin);
3604       for (cached = bin->messages; cached; cached = g_list_next (cached)) {
3605         GstMessage *message = (GstMessage *) cached->data;
3606
3607         if (GST_MESSAGE_TYPE (message) == GST_MESSAGE_DURATION &&
3608             GST_MESSAGE_SRC (message) == GST_OBJECT_CAST (bin)) {
3609           GstFormat format;
3610           gint64 duration;
3611
3612           gst_message_parse_duration (message, &format, &duration);
3613
3614           /* if cached same format, copy duration in query result */
3615           if (format == qformat) {
3616             GST_DEBUG_OBJECT (bin, "return cached duration %" G_GINT64_FORMAT,
3617                 duration);
3618             GST_OBJECT_UNLOCK (bin);
3619
3620             gst_query_set_duration (query, qformat, duration);
3621             res = TRUE;
3622             goto exit;
3623           }
3624         }
3625       }
3626       GST_OBJECT_UNLOCK (bin);
3627       /* no cached value found, iterate and collect durations */
3628       fold_func = (GstIteratorFoldFunction) bin_query_duration_fold;
3629       fold_init = bin_query_min_max_init;
3630       fold_done = bin_query_duration_done;
3631       break;
3632     }
3633     case GST_QUERY_POSITION:
3634     {
3635       fold_func = (GstIteratorFoldFunction) bin_query_position_fold;
3636       fold_init = bin_query_min_max_init;
3637       fold_done = bin_query_position_done;
3638       break;
3639     }
3640     case GST_QUERY_LATENCY:
3641     {
3642       fold_func = (GstIteratorFoldFunction) bin_query_latency_fold;
3643       fold_init = bin_query_min_max_init;
3644       fold_done = bin_query_latency_done;
3645       res = TRUE;
3646       break;
3647     }
3648     default:
3649       fold_func = (GstIteratorFoldFunction) bin_query_generic_fold;
3650       break;
3651   }
3652
3653   fold_data.query = query;
3654
3655   /* set the result of the query to FALSE initially */
3656   g_value_init (&ret, G_TYPE_BOOLEAN);
3657   g_value_set_boolean (&ret, res);
3658
3659   iter = gst_bin_iterate_sinks (bin);
3660   GST_DEBUG_OBJECT (bin, "Sending query %p (type %s) to sink children",
3661       query, GST_QUERY_TYPE_NAME (query));
3662
3663   if (fold_init)
3664     fold_init (bin, &fold_data);
3665
3666   while (TRUE) {
3667     GstIteratorResult ires;
3668
3669     ires = gst_iterator_fold (iter, fold_func, &ret, &fold_data);
3670
3671     switch (ires) {
3672       case GST_ITERATOR_RESYNC:
3673         gst_iterator_resync (iter);
3674         if (fold_init)
3675           fold_init (bin, &fold_data);
3676         g_value_set_boolean (&ret, res);
3677         break;
3678       case GST_ITERATOR_OK:
3679       case GST_ITERATOR_DONE:
3680         res = g_value_get_boolean (&ret);
3681         if (fold_done != NULL && res)
3682           fold_done (bin, &fold_data);
3683         goto done;
3684       default:
3685         res = FALSE;
3686         goto done;
3687     }
3688   }
3689 done:
3690   gst_iterator_free (iter);
3691
3692 exit:
3693   GST_DEBUG_OBJECT (bin, "query %p result %d", query, res);
3694
3695   return res;
3696 }
3697
3698 static gint
3699 compare_name (const GValue * velement, const gchar * name)
3700 {
3701   gint eq;
3702   GstElement *element = g_value_get_object (velement);
3703
3704   GST_OBJECT_LOCK (element);
3705   eq = strcmp (GST_ELEMENT_NAME (element), name);
3706   GST_OBJECT_UNLOCK (element);
3707
3708   return eq;
3709 }
3710
3711 /**
3712  * gst_bin_get_by_name:
3713  * @bin: a #GstBin
3714  * @name: the element name to search for
3715  *
3716  * Gets the element with the given name from a bin. This
3717  * function recurses into child bins.
3718  *
3719  * Returns NULL if no element with the given name is found in the bin.
3720  *
3721  * MT safe.  Caller owns returned reference.
3722  *
3723  * Returns: (transfer full): the #GstElement with the given name, or NULL
3724  */
3725 GstElement *
3726 gst_bin_get_by_name (GstBin * bin, const gchar * name)
3727 {
3728   GstIterator *children;
3729   GValue result = { 0, };
3730   GstElement *element;
3731   gboolean found;
3732
3733   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3734
3735   GST_CAT_INFO (GST_CAT_PARENTAGE, "[%s]: looking up child element %s",
3736       GST_ELEMENT_NAME (bin), name);
3737
3738   children = gst_bin_iterate_recurse (bin);
3739   found = gst_iterator_find_custom (children,
3740       (GCompareFunc) compare_name, &result, (gpointer) name);
3741   gst_iterator_free (children);
3742
3743   if (found) {
3744     element = g_value_dup_object (&result);
3745     g_value_unset (&result);
3746   } else {
3747     element = NULL;
3748   }
3749
3750   return element;
3751 }
3752
3753 /**
3754  * gst_bin_get_by_name_recurse_up:
3755  * @bin: a #GstBin
3756  * @name: the element name to search for
3757  *
3758  * Gets the element with the given name from this bin. If the
3759  * element is not found, a recursion is performed on the parent bin.
3760  *
3761  * Returns NULL if:
3762  * - no element with the given name is found in the bin
3763  *
3764  * MT safe.  Caller owns returned reference.
3765  *
3766  * Returns: (transfer full): the #GstElement with the given name, or NULL
3767  */
3768 GstElement *
3769 gst_bin_get_by_name_recurse_up (GstBin * bin, const gchar * name)
3770 {
3771   GstElement *result;
3772
3773   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3774   g_return_val_if_fail (name != NULL, NULL);
3775
3776   result = gst_bin_get_by_name (bin, name);
3777
3778   if (!result) {
3779     GstObject *parent;
3780
3781     parent = gst_object_get_parent (GST_OBJECT_CAST (bin));
3782     if (parent) {
3783       if (GST_IS_BIN (parent)) {
3784         result = gst_bin_get_by_name_recurse_up (GST_BIN_CAST (parent), name);
3785       }
3786       gst_object_unref (parent);
3787     }
3788   }
3789
3790   return result;
3791 }
3792
3793 static gint
3794 compare_interface (const GValue * velement, GValue * interface)
3795 {
3796   GstElement *element = g_value_get_object (velement);
3797   GType interface_type = (GType) g_value_get_pointer (interface);
3798   gint ret;
3799
3800   if (G_TYPE_CHECK_INSTANCE_TYPE (element, interface_type)) {
3801     ret = 0;
3802   } else {
3803     ret = 1;
3804   }
3805   return ret;
3806 }
3807
3808 /**
3809  * gst_bin_get_by_interface:
3810  * @bin: a #GstBin
3811  * @iface: the #GType of an interface
3812  *
3813  * Looks for an element inside the bin that implements the given
3814  * interface. If such an element is found, it returns the element.
3815  * You can cast this element to the given interface afterwards.  If you want
3816  * all elements that implement the interface, use
3817  * gst_bin_iterate_all_by_interface(). This function recurses into child bins.
3818  *
3819  * MT safe.  Caller owns returned reference.
3820  *
3821  * Returns: (transfer full): A #GstElement inside the bin implementing the interface
3822  */
3823 GstElement *
3824 gst_bin_get_by_interface (GstBin * bin, GType iface)
3825 {
3826   GstIterator *children;
3827   GValue result = { 0, };
3828   GstElement *element;
3829   gboolean found;
3830   GValue viface = { 0, };
3831
3832   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3833   g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL);
3834
3835   g_value_init (&viface, G_TYPE_POINTER);
3836   g_value_set_pointer (&viface, (gpointer) iface);
3837
3838   children = gst_bin_iterate_recurse (bin);
3839   found = gst_iterator_find_custom (children, (GCompareFunc) compare_interface,
3840       &result, &viface);
3841   gst_iterator_free (children);
3842
3843   if (found) {
3844     element = g_value_dup_object (&result);
3845     g_value_unset (&result);
3846   } else {
3847     element = NULL;
3848   }
3849   g_value_unset (&viface);
3850
3851   return element;
3852 }
3853
3854 /**
3855  * gst_bin_iterate_all_by_interface:
3856  * @bin: a #GstBin
3857  * @iface: the #GType of an interface
3858  *
3859  * Looks for all elements inside the bin that implements the given
3860  * interface. You can safely cast all returned elements to the given interface.
3861  * The function recurses inside child bins. The iterator will yield a series
3862  * of #GstElement that should be unreffed after use.
3863  *
3864  * Each element yielded by the iterator will have its refcount increased, so
3865  * unref after use.
3866  *
3867  * MT safe.  Caller owns returned value.
3868  *
3869  * Returns: (transfer full): a #GstIterator of #GstElement for all elements
3870  *          in the bin implementing the given interface, or NULL
3871  */
3872 GstIterator *
3873 gst_bin_iterate_all_by_interface (GstBin * bin, GType iface)
3874 {
3875   GstIterator *children;
3876   GstIterator *result;
3877   GValue viface = { 0, };
3878
3879   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3880   g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL);
3881
3882   g_value_init (&viface, G_TYPE_POINTER);
3883   g_value_set_pointer (&viface, (gpointer) iface);
3884
3885   children = gst_bin_iterate_recurse (bin);
3886   result = gst_iterator_filter (children, (GCompareFunc) compare_interface,
3887       &viface);
3888
3889   g_value_unset (&viface);
3890
3891   return result;
3892 }