gst/gstbin.c

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