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