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