gst/gstelement.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2004 Wim Taymans <wim@fluendo.com>
   4  *
   5  * gstelement.c: The base element, all elements derive from this
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstelement
  25  * @short_description: Abstract base class for all pipeline elements
  26  * @see_also: #GstElementFactory, #GstPad
  27  *
  28  * GstElement is the abstract base class needed to construct an element that
  29  * can be used in a GStreamer pipeline. Please refer to the plugin writers
  30  * guide for more information on creating #GstElement subclasses.
  31  *
  32  * The name of a #GstElement can be get with gst_element_get_name() and set with
  33  * gst_element_set_name().  For speed, GST_ELEMENT_NAME() can be used in the
  34  * core when using the appropriate locking. Do not use this in plug-ins or
  35  * applications in order to retain ABI compatibility.
  36  *
  37  * All elements have pads (of the type #GstPad).  These pads link to pads on
  38  * other elements.  #GstBuffer flow between these linked pads.
  39  * A #GstElement has a #GList of #GstPad structures for all their input (or sink)
  40  * and output (or source) pads.
  41  * Core and plug-in writers can add and remove pads with gst_element_add_pad()
  42  * and gst_element_remove_pad().
  43  *
  44  * An existing pad of an element can be retrieved by name with
  45  * gst_element_get_static_pad(). A new dynamic pad can be created using
  46  * gst_element_request_pad() with a #GstPadTemplate or
  47  * gst_element_get_request_pad() with the template name such as "src_\%d".
  48  * An iterator of all pads can be retrieved with gst_element_iterate_pads().
  49  *
  50  * Elements can be linked through their pads.
  51  * If the link is straightforward, use the gst_element_link()
  52  * convenience function to link two elements, or gst_element_link_many()
  53  * for more elements in a row.
  54  * Use gst_element_link_filtered() to link two elements constrained by
  55  * a specified set of #GstCaps.
  56  * For finer control, use gst_element_link_pads() and
  57  * gst_element_link_pads_filtered() to specify the pads to link on
  58  * each element by name.
  59  *
  60  * Each element has a state (see #GstState).  You can get and set the state
  61  * of an element with gst_element_get_state() and gst_element_set_state().
  62  * Setting a state triggers a #GstStateChange. To get a string representation
  63  * of a #GstState, use gst_element_state_get_name().
  64  *
  65  * You can get and set a #GstClock on an element using gst_element_get_clock()
  66  * and gst_element_set_clock().
  67  * Some elements can provide a clock for the pipeline if
  68  * gst_element_provides_clock() returns %TRUE. With the
  69  * gst_element_provide_clock() method one can retrieve the clock provided by
  70  * such an element.
  71  * Not all elements require a clock to operate correctly. If
  72  * gst_element_requires_clock() returns %TRUE, a clock should be set on the
  73  * element with gst_element_set_clock().
  74  *
  75  * Note that clock slection and distribution is normally handled by the
  76  * toplevel #GstPipeline so the clock functions are only to be used in very
  77  * specific situations.
  78  *
  79  * Last reviewed on 2009-05-29 (0.10.24)
  80  */
  81
  82 #include "gst_private.h"
  83 #include <glib.h>
  84 #include <stdarg.h>
  85 #include <gobject/gvaluecollector.h>
  86
  87 #include "gstelement.h"
  88 #include "gstelementmetadata.h"
  89 #include "gstenumtypes.h"
  90 #include "gstbus.h"
  91 #include "gstmarshal.h"
  92 #include "gsterror.h"
  93 #include "gstevent.h"
  94 #include "gstutils.h"
  95 #include "gstinfo.h"
  96 #include "gstvalue.h"
  97 #include "gst-i18n-lib.h"
  98 #include "glib-compat-private.h"
  99
 100 /* Element signals and args */
 101 enum
 102 {
 103   PAD_ADDED,
 104   PAD_REMOVED,
 105   NO_MORE_PADS,
 106   /* add more above */
 107   LAST_SIGNAL
 108 };
 109
 110 enum
 111 {
 112   ARG_0
 113       /* FILL ME */
 114 };
 115
 116 static void gst_element_class_init (GstElementClass * klass);
 117 static void gst_element_init (GstElement * element);
 118 static void gst_element_base_class_init (gpointer g_class);
 119 static void gst_element_base_class_finalize (gpointer g_class);
 120
 121 static void gst_element_dispose (GObject * object);
 122 static void gst_element_finalize (GObject * object);
 123
 124 static GstStateChangeReturn gst_element_change_state_func (GstElement * element,
 125     GstStateChange transition);
 126 static GstStateChangeReturn gst_element_get_state_func (GstElement * element,
 127     GstState * state, GstState * pending, GstClockTime timeout);
 128 static GstStateChangeReturn gst_element_set_state_func (GstElement * element,
 129     GstState state);
 130 static gboolean gst_element_set_clock_func (GstElement * element,
 131     GstClock * clock);
 132 static void gst_element_set_bus_func (GstElement * element, GstBus * bus);
 133
 134 static gboolean gst_element_default_send_event (GstElement * element,
 135     GstEvent * event);
 136 static gboolean gst_element_default_query (GstElement * element,
 137     GstQuery * query);
 138
 139 static GstPadTemplate
 140     * gst_element_class_get_request_pad_template (GstElementClass *
 141     element_class, const gchar * name);
 142
 143 static GstObjectClass *parent_class = NULL;
 144 static guint gst_element_signals[LAST_SIGNAL] = { 0 };
 145
 146 /* this is used in gstelementfactory.c:gst_element_register() */
 147 GQuark __gst_elementclass_factory = 0;
 148
 149 GType
 150 gst_element_get_type (void)
 151 {
 152   static volatile gsize gst_element_type = 0;
 153
 154   if (g_once_init_enter (&gst_element_type)) {
 155     GType _type;
 156     static const GTypeInfo element_info = {
 157       sizeof (GstElementClass),
 158       gst_element_base_class_init,
 159       gst_element_base_class_finalize,
 160       (GClassInitFunc) gst_element_class_init,
 161       NULL,
 162       NULL,
 163       sizeof (GstElement),
 164       0,
 165       (GInstanceInitFunc) gst_element_init,
 166       NULL
 167     };
 168
 169     _type = g_type_register_static (GST_TYPE_OBJECT, "GstElement",
 170         &element_info, G_TYPE_FLAG_ABSTRACT);
 171
 172     __gst_elementclass_factory =
 173         g_quark_from_static_string ("GST_ELEMENTCLASS_FACTORY");
 174     g_once_init_leave (&gst_element_type, _type);
 175   }
 176   return gst_element_type;
 177 }
 178
 179 static void
 180 gst_element_class_init (GstElementClass * klass)
 181 {
 182   GObjectClass *gobject_class;
 183
 184   gobject_class = (GObjectClass *) klass;
 185
 186   parent_class = g_type_class_peek_parent (klass);
 187
 188   /**
 189    * GstElement::pad-added:
 190    * @gstelement: the object which received the signal
 191    * @new_pad: the pad that has been added
 192    *
 193    * a new #GstPad has been added to the element. Note that this signal will
 194    * usually be emitted from the context of the streaming thread. Also keep in
 195    * mind that if you add new elements to the pipeline in the signal handler
 196    * you will need to set them to the desired target state with
 197    * gst_element_set_state() or gst_element_sync_state_with_parent().
 198    */
 199   gst_element_signals[PAD_ADDED] =
 200       g_signal_new ("pad-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 201       G_STRUCT_OFFSET (GstElementClass, pad_added), NULL, NULL,
 202       gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
 203   /**
 204    * GstElement::pad-removed:
 205    * @gstelement: the object which received the signal
 206    * @old_pad: the pad that has been removed
 207    *
 208    * a #GstPad has been removed from the element
 209    */
 210   gst_element_signals[PAD_REMOVED] =
 211       g_signal_new ("pad-removed", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 212       G_STRUCT_OFFSET (GstElementClass, pad_removed), NULL, NULL,
 213       gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
 214   /**
 215    * GstElement::no-more-pads:
 216    * @gstelement: the object which received the signal
 217    *
 218    * This signals that the element will not generate more dynamic pads.
 219    * Note that this signal will usually be emitted from the context of
 220    * the streaming thread.
 221    */
 222   gst_element_signals[NO_MORE_PADS] =
 223       g_signal_new ("no-more-pads", G_TYPE_FROM_CLASS (klass),
 224       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstElementClass, no_more_pads), NULL,
 225       NULL, gst_marshal_VOID__VOID, G_TYPE_NONE, 0);
 226
 227   gobject_class->dispose = gst_element_dispose;
 228   gobject_class->finalize = gst_element_finalize;
 229
 230   klass->change_state = GST_DEBUG_FUNCPTR (gst_element_change_state_func);
 231   klass->set_state = GST_DEBUG_FUNCPTR (gst_element_set_state_func);
 232   klass->get_state = GST_DEBUG_FUNCPTR (gst_element_get_state_func);
 233   klass->set_clock = GST_DEBUG_FUNCPTR (gst_element_set_clock_func);
 234   klass->set_bus = GST_DEBUG_FUNCPTR (gst_element_set_bus_func);
 235   klass->query = GST_DEBUG_FUNCPTR (gst_element_default_query);
 236   klass->send_event = GST_DEBUG_FUNCPTR (gst_element_default_send_event);
 237   klass->numpadtemplates = 0;
 238
 239   klass->elementfactory = NULL;
 240 }
 241
 242 static void
 243 gst_element_base_class_init (gpointer g_class)
 244 {
 245   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 246   GList *node, *padtemplates;
 247
 248   /* Copy the element details here so elements can inherit the
 249    * details from their base class and classes only need to set
 250    * the details in class_init instead of base_init */
 251   element_class->metadata =
 252       element_class->metadata ? gst_structure_copy (element_class->metadata) :
 253       gst_structure_new_empty ("metadata");
 254
 255   /* Copy the pad templates so elements inherit them
 256    * from their base class but elements can add pad templates in class_init
 257    * instead of base_init.
 258    */
 259   padtemplates = g_list_copy (element_class->padtemplates);
 260   for (node = padtemplates; node != NULL; node = node->next) {
 261     GstPadTemplate *tmpl = (GstPadTemplate *) node->data;
 262     gst_object_ref (tmpl);
 263   }
 264   element_class->padtemplates = padtemplates;
 265
 266   /* set the factory, see gst_element_register() */
 267   element_class->elementfactory =
 268       g_type_get_qdata (G_TYPE_FROM_CLASS (element_class),
 269       __gst_elementclass_factory);
 270   GST_DEBUG ("type %s : factory %p", G_OBJECT_CLASS_NAME (element_class),
 271       element_class->elementfactory);
 272 }
 273
 274 static void
 275 gst_element_base_class_finalize (gpointer g_class)
 276 {
 277   GstElementClass *klass = GST_ELEMENT_CLASS (g_class);
 278
 279   g_list_foreach (klass->padtemplates, (GFunc) gst_object_unref, NULL);
 280   g_list_free (klass->padtemplates);
 281
 282   gst_structure_free (klass->metadata);
 283 }
 284
 285 static void
 286 gst_element_init (GstElement * element)
 287 {
 288   GST_STATE (element) = GST_STATE_NULL;
 289   GST_STATE_TARGET (element) = GST_STATE_NULL;
 290   GST_STATE_NEXT (element) = GST_STATE_VOID_PENDING;
 291   GST_STATE_PENDING (element) = GST_STATE_VOID_PENDING;
 292   GST_STATE_RETURN (element) = GST_STATE_CHANGE_SUCCESS;
 293
 294   g_rec_mutex_init (&element->state_lock);
 295   g_cond_init (&element->state_cond);
 296 }
 297
 298 /**
 299  * gst_element_release_request_pad:
 300  * @element: a #GstElement to release the request pad of.
 301  * @pad: the #GstPad to release.
 302  *
 303  * Makes the element free the previously requested pad as obtained
 304  * with gst_element_get_request_pad().
 305  *
 306  * This does not unref the pad. If the pad was created by using
 307  * gst_element_get_request_pad(), gst_element_release_request_pad() needs to be
 308  * followed by gst_object_unref() to free the @pad.
 309  *
 310  * MT safe.
 311  */
 312 void
 313 gst_element_release_request_pad (GstElement * element, GstPad * pad)
 314 {
 315   GstElementClass *oclass;
 316
 317   g_return_if_fail (GST_IS_ELEMENT (element));
 318   g_return_if_fail (GST_IS_PAD (pad));
 319   g_return_if_fail (GST_PAD_PAD_TEMPLATE (pad) == NULL ||
 320       GST_PAD_TEMPLATE_PRESENCE (GST_PAD_PAD_TEMPLATE (pad)) ==
 321       GST_PAD_REQUEST);
 322
 323   oclass = GST_ELEMENT_GET_CLASS (element);
 324
 325   /* if the element implements a custom release function we call that, else we
 326    * simply remove the pad from the element */
 327   if (oclass->release_pad)
 328     (oclass->release_pad) (element, pad);
 329   else
 330     gst_element_remove_pad (element, pad);
 331 }
 332
 333 /**
 334  * gst_element_provide_clock:
 335  * @element: a #GstElement to query
 336  *
 337  * Get the clock provided by the given element.
 338  * <note>An element is only required to provide a clock in the PAUSED
 339  * state. Some elements can provide a clock in other states.</note>
 340  *
 341  * Returns: (transfer full): the GstClock provided by the element or %NULL
 342  * if no clock could be provided.  Unref after usage.
 343  *
 344  * MT safe.
 345  */
 346 GstClock *
 347 gst_element_provide_clock (GstElement * element)
 348 {
 349   GstClock *result = NULL;
 350   GstElementClass *oclass;
 351
 352   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 353
 354   oclass = GST_ELEMENT_GET_CLASS (element);
 355
 356   if (oclass->provide_clock)
 357     result = oclass->provide_clock (element);
 358
 359   return result;
 360 }
 361
 362 static gboolean
 363 gst_element_set_clock_func (GstElement * element, GstClock * clock)
 364 {
 365   GstClock **clock_p;
 366
 367   GST_OBJECT_LOCK (element);
 368   clock_p = &element->clock;
 369   gst_object_replace ((GstObject **) clock_p, (GstObject *) clock);
 370   GST_OBJECT_UNLOCK (element);
 371
 372   return TRUE;
 373 }
 374
 375 /**
 376  * gst_element_set_clock:
 377  * @element: a #GstElement to set the clock for.
 378  * @clock: the #GstClock to set for the element.
 379  *
 380  * Sets the clock for the element. This function increases the
 381  * refcount on the clock. Any previously set clock on the object
 382  * is unreffed.
 383  *
 384  * Returns: %TRUE if the element accepted the clock. An element can refuse a
 385  * clock when it, for example, is not able to slave its internal clock to the
 386  * @clock or when it requires a specific clock to operate.
 387  *
 388  * MT safe.
 389  */
 390 gboolean
 391 gst_element_set_clock (GstElement * element, GstClock * clock)
 392 {
 393   GstElementClass *oclass;
 394   gboolean res = FALSE;
 395
 396   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
 397   g_return_val_if_fail (clock == NULL || GST_IS_CLOCK (clock), FALSE);
 398
 399   oclass = GST_ELEMENT_GET_CLASS (element);
 400
 401   GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, element, "setting clock %p", clock);
 402
 403   if (oclass->set_clock)
 404     res = oclass->set_clock (element, clock);
 405
 406   return res;
 407 }
 408
 409 /**
 410  * gst_element_get_clock:
 411  * @element: a #GstElement to get the clock of.
 412  *
 413  * Gets the currently configured clock of the element. This is the clock as was
 414  * last set with gst_element_set_clock().
 415  *
 416  * Returns: (transfer full): the #GstClock of the element. unref after usage.
 417  *
 418  * MT safe.
 419  */
 420 GstClock *
 421 gst_element_get_clock (GstElement * element)
 422 {
 423   GstClock *result;
 424
 425   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 426
 427   GST_OBJECT_LOCK (element);
 428   if ((result = element->clock))
 429     gst_object_ref (result);
 430   GST_OBJECT_UNLOCK (element);
 431
 432   return result;
 433 }
 434
 435 /**
 436  * gst_element_set_base_time:
 437  * @element: a #GstElement.
 438  * @time: the base time to set.
 439  *
 440  * Set the base time of an element. See gst_element_get_base_time().
 441  *
 442  * MT safe.
 443  */
 444 void
 445 gst_element_set_base_time (GstElement * element, GstClockTime time)
 446 {
 447   GstClockTime old;
 448
 449   g_return_if_fail (GST_IS_ELEMENT (element));
 450
 451   GST_OBJECT_LOCK (element);
 452   old = element->base_time;
 453   element->base_time = time;
 454   GST_OBJECT_UNLOCK (element);
 455
 456   GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, element,
 457       "set base_time=%" GST_TIME_FORMAT ", old %" GST_TIME_FORMAT,
 458       GST_TIME_ARGS (time), GST_TIME_ARGS (old));
 459 }
 460
 461 /**
 462  * gst_element_get_base_time:
 463  * @element: a #GstElement.
 464  *
 465  * Returns the base time of the element. The base time is the
 466  * absolute time of the clock when this element was last put to
 467  * PLAYING. Subtracting the base time from the clock time gives
 468  * the running time of the element.
 469  *
 470  * Returns: the base time of the element.
 471  *
 472  * MT safe.
 473  */
 474 GstClockTime
 475 gst_element_get_base_time (GstElement * element)
 476 {
 477   GstClockTime result;
 478
 479   g_return_val_if_fail (GST_IS_ELEMENT (element), GST_CLOCK_TIME_NONE);
 480
 481   GST_OBJECT_LOCK (element);
 482   result = element->base_time;
 483   GST_OBJECT_UNLOCK (element);
 484
 485   return result;
 486 }
 487
 488 /**
 489  * gst_element_set_start_time:
 490  * @element: a #GstElement.
 491  * @time: the base time to set.
 492  *
 493  * Set the start time of an element. The start time of the element is the
 494  * running time of the element when it last went to the PAUSED state. In READY
 495  * or after a flushing seek, it is set to 0.
 496  *
 497  * Toplevel elements like #GstPipeline will manage the start_time and
 498  * base_time on its children. Setting the start_time to #GST_CLOCK_TIME_NONE
 499  * on such a toplevel element will disable the distribution of the base_time to
 500  * the children and can be useful if the application manages the base_time
 501  * itself, for example if you want to synchronize capture from multiple
 502  * pipelines, and you can also ensure that the pipelines have the same clock.
 503  *
 504  * MT safe.
 505  *
 506  * Since: 0.10.24
 507  */
 508 void
 509 gst_element_set_start_time (GstElement * element, GstClockTime time)
 510 {
 511   GstClockTime old;
 512
 513   g_return_if_fail (GST_IS_ELEMENT (element));
 514
 515   GST_OBJECT_LOCK (element);
 516   old = GST_ELEMENT_START_TIME (element);
 517   GST_ELEMENT_START_TIME (element) = time;
 518   GST_OBJECT_UNLOCK (element);
 519
 520   GST_CAT_DEBUG_OBJECT (GST_CAT_CLOCK, element,
 521       "set start_time=%" GST_TIME_FORMAT ", old %" GST_TIME_FORMAT,
 522       GST_TIME_ARGS (time), GST_TIME_ARGS (old));
 523 }
 524
 525 /**
 526  * gst_element_get_start_time:
 527  * @element: a #GstElement.
 528  *
 529  * Returns the start time of the element. The start time is the
 530  * running time of the clock when this element was last put to PAUSED.
 531  *
 532  * Usually the start_time is managed by a toplevel element such as
 533  * #GstPipeline.
 534  *
 535  * MT safe.
 536  *
 537  * Returns: the start time of the element.
 538  *
 539  * Since: 0.10.24
 540  */
 541 GstClockTime
 542 gst_element_get_start_time (GstElement * element)
 543 {
 544   GstClockTime result;
 545
 546   g_return_val_if_fail (GST_IS_ELEMENT (element), GST_CLOCK_TIME_NONE);
 547
 548   GST_OBJECT_LOCK (element);
 549   result = GST_ELEMENT_START_TIME (element);
 550   GST_OBJECT_UNLOCK (element);
 551
 552   return result;
 553 }
 554
 555 #if 0
 556 /**
 557  * gst_element_set_index:
 558  * @element: a #GstElement.
 559  * @index: (transfer none): a #GstIndex.
 560  *
 561  * Set @index on the element. The refcount of the index
 562  * will be increased, any previously set index is unreffed.
 563  *
 564  * MT safe.
 565  */
 566 void
 567 gst_element_set_index (GstElement * element, GstIndex * index)
 568 {
 569   GstElementClass *oclass;
 570
 571   g_return_if_fail (GST_IS_ELEMENT (element));
 572   g_return_if_fail (index == NULL || GST_IS_INDEX (index));
 573
 574   oclass = GST_ELEMENT_GET_CLASS (element);
 575
 576   if (oclass->set_index)
 577     oclass->set_index (element, index);
 578 }
 579
 580 /**
 581  * gst_element_get_index:
 582  * @element: a #GstElement.
 583  *
 584  * Gets the index from the element.
 585  *
 586  * Returns: (transfer full): a #GstIndex or %NULL when no index was set on the
 587  * element. unref after usage.
 588  *
 589  * MT safe.
 590  */
 591 GstIndex *
 592 gst_element_get_index (GstElement * element)
 593 {
 594   GstElementClass *oclass;
 595   GstIndex *result = NULL;
 596
 597   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 598
 599   oclass = GST_ELEMENT_GET_CLASS (element);
 600
 601   if (oclass->get_index)
 602     result = oclass->get_index (element);
 603
 604   return result;
 605 }
 606 #endif
 607
 608 /**
 609  * gst_element_add_pad:
 610  * @element: a #GstElement to add the pad to.
 611  * @pad: (transfer full): the #GstPad to add to the element.
 612  *
 613  * Adds a pad (link point) to @element. @pad's parent will be set to @element;
 614  * see gst_object_set_parent() for refcounting information.
 615  *
 616  * Pads are not automatically activated so elements should perform the needed
 617  * steps to activate the pad in case this pad is added in the PAUSED or PLAYING
 618  * state. See gst_pad_set_active() for more information about activating pads.
 619  *
 620  * The pad and the element should be unlocked when calling this function.
 621  *
 622  * This function will emit the #GstElement::pad-added signal on the element.
 623  *
 624  * Returns: %TRUE if the pad could be added. This function can fail when
 625  * a pad with the same name already existed or the pad already had another
 626  * parent.
 627  *
 628  * MT safe.
 629  */
 630 gboolean
 631 gst_element_add_pad (GstElement * element, GstPad * pad)
 632 {
 633   gchar *pad_name;
 634   gboolean flushing;
 635
 636   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
 637   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
 638
 639   /* locking pad to look at the name */
 640   GST_OBJECT_LOCK (pad);
 641   pad_name = g_strdup (GST_PAD_NAME (pad));
 642   GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element, "adding pad '%s'",
 643       GST_STR_NULL (pad_name));
 644   flushing = GST_PAD_IS_FLUSHING (pad);
 645   GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_PARENT);
 646   GST_OBJECT_UNLOCK (pad);
 647
 648   /* then check to see if there's already a pad by that name here */
 649   GST_OBJECT_LOCK (element);
 650   if (G_UNLIKELY (!gst_object_check_uniqueness (element->pads, pad_name)))
 651     goto name_exists;
 652
 653   /* try to set the pad's parent */
 654   if (G_UNLIKELY (!gst_object_set_parent (GST_OBJECT_CAST (pad),
 655               GST_OBJECT_CAST (element))))
 656     goto had_parent;
 657
 658   /* check for flushing pads */
 659   if (flushing && (GST_STATE (element) > GST_STATE_READY ||
 660           GST_STATE_NEXT (element) == GST_STATE_PAUSED)) {
 661     g_warning ("adding flushing pad '%s' to running element '%s', you need to "
 662         "use gst_pad_set_active(pad,TRUE) before adding it.",
 663         GST_STR_NULL (pad_name), GST_ELEMENT_NAME (element));
 664     /* unset flushing */
 665     GST_OBJECT_LOCK (pad);
 666     GST_PAD_UNSET_FLUSHING (pad);
 667     GST_OBJECT_UNLOCK (pad);
 668   }
 669
 670   g_free (pad_name);
 671
 672   /* add it to the list */
 673   switch (gst_pad_get_direction (pad)) {
 674     case GST_PAD_SRC:
 675       element->srcpads = g_list_prepend (element->srcpads, pad);
 676       element->numsrcpads++;
 677       break;
 678     case GST_PAD_SINK:
 679       element->sinkpads = g_list_prepend (element->sinkpads, pad);
 680       element->numsinkpads++;
 681       break;
 682     default:
 683       goto no_direction;
 684   }
 685   element->pads = g_list_prepend (element->pads, pad);
 686   element->numpads++;
 687   element->pads_cookie++;
 688   GST_OBJECT_UNLOCK (element);
 689
 690   /* emit the PAD_ADDED signal */
 691   g_signal_emit (element, gst_element_signals[PAD_ADDED], 0, pad);
 692
 693   return TRUE;
 694
 695   /* ERROR cases */
 696 name_exists:
 697   {
 698     g_critical ("Padname %s is not unique in element %s, not adding",
 699         pad_name, GST_ELEMENT_NAME (element));
 700     GST_OBJECT_UNLOCK (element);
 701     g_free (pad_name);
 702     return FALSE;
 703   }
 704 had_parent:
 705   {
 706     g_critical
 707         ("Pad %s already has parent when trying to add to element %s",
 708         pad_name, GST_ELEMENT_NAME (element));
 709     GST_OBJECT_UNLOCK (element);
 710     g_free (pad_name);
 711     return FALSE;
 712   }
 713 no_direction:
 714   {
 715     GST_OBJECT_LOCK (pad);
 716     g_critical
 717         ("Trying to add pad %s to element %s, but it has no direction",
 718         GST_OBJECT_NAME (pad), GST_ELEMENT_NAME (element));
 719     GST_OBJECT_UNLOCK (pad);
 720     GST_OBJECT_UNLOCK (element);
 721     return FALSE;
 722   }
 723 }
 724
 725 /**
 726  * gst_element_remove_pad:
 727  * @element: a #GstElement to remove pad from.
 728  * @pad: (transfer none): the #GstPad to remove from the element.
 729  *
 730  * Removes @pad from @element. @pad will be destroyed if it has not been
 731  * referenced elsewhere using gst_object_unparent().
 732  *
 733  * This function is used by plugin developers and should not be used
 734  * by applications. Pads that were dynamically requested from elements
 735  * with gst_element_get_request_pad() should be released with the
 736  * gst_element_release_request_pad() function instead.
 737  *
 738  * Pads are not automatically deactivated so elements should perform the needed
 739  * steps to deactivate the pad in case this pad is removed in the PAUSED or
 740  * PLAYING state. See gst_pad_set_active() for more information about
 741  * deactivating pads.
 742  *
 743  * The pad and the element should be unlocked when calling this function.
 744  *
 745  * This function will emit the #GstElement::pad-removed signal on the element.
 746  *
 747  * Returns: %TRUE if the pad could be removed. Can return %FALSE if the
 748  * pad does not belong to the provided element.
 749  *
 750  * MT safe.
 751  */
 752 gboolean
 753 gst_element_remove_pad (GstElement * element, GstPad * pad)
 754 {
 755   GstPad *peer;
 756
 757   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
 758   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
 759
 760   /* locking pad to look at the name and parent */
 761   GST_OBJECT_LOCK (pad);
 762   GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element, "removing pad '%s'",
 763       GST_STR_NULL (GST_PAD_NAME (pad)));
 764
 765   if (G_UNLIKELY (GST_PAD_PARENT (pad) != element))
 766     goto not_our_pad;
 767   GST_OBJECT_UNLOCK (pad);
 768
 769   /* unlink */
 770   if ((peer = gst_pad_get_peer (pad))) {
 771     /* window for MT unsafeness, someone else could unlink here
 772      * and then we call unlink with wrong pads. The unlink
 773      * function would catch this and safely return failed. */
 774     if (GST_PAD_IS_SRC (pad))
 775       gst_pad_unlink (pad, peer);
 776     else
 777       gst_pad_unlink (peer, pad);
 778
 779     gst_object_unref (peer);
 780   }
 781
 782   GST_OBJECT_LOCK (element);
 783   /* remove it from the list */
 784   switch (gst_pad_get_direction (pad)) {
 785     case GST_PAD_SRC:
 786       element->srcpads = g_list_remove (element->srcpads, pad);
 787       element->numsrcpads--;
 788       break;
 789     case GST_PAD_SINK:
 790       element->sinkpads = g_list_remove (element->sinkpads, pad);
 791       element->numsinkpads--;
 792       break;
 793     default:
 794       g_critical ("Removing pad without direction???");
 795       break;
 796   }
 797   element->pads = g_list_remove (element->pads, pad);
 798   element->numpads--;
 799   element->pads_cookie++;
 800   GST_OBJECT_UNLOCK (element);
 801
 802   /* emit the PAD_REMOVED signal before unparenting and losing the last ref. */
 803   g_signal_emit (element, gst_element_signals[PAD_REMOVED], 0, pad);
 804
 805   gst_object_unparent (GST_OBJECT_CAST (pad));
 806
 807   return TRUE;
 808
 809   /* ERRORS */
 810 not_our_pad:
 811   {
 812     /* locking order is element > pad */
 813     GST_OBJECT_UNLOCK (pad);
 814
 815     GST_OBJECT_LOCK (element);
 816     GST_OBJECT_LOCK (pad);
 817     g_critical ("Padname %s:%s does not belong to element %s when removing",
 818         GST_DEBUG_PAD_NAME (pad), GST_ELEMENT_NAME (element));
 819     GST_OBJECT_UNLOCK (pad);
 820     GST_OBJECT_UNLOCK (element);
 821     return FALSE;
 822   }
 823 }
 824
 825 /**
 826  * gst_element_no_more_pads:
 827  * @element: a #GstElement
 828  *
 829  * Use this function to signal that the element does not expect any more pads
 830  * to show up in the current pipeline. This function should be called whenever
 831  * pads have been added by the element itself. Elements with #GST_PAD_SOMETIMES
 832  * pad templates use this in combination with autopluggers to figure out that
 833  * the element is done initializing its pads.
 834  *
 835  * This function emits the #GstElement::no-more-pads signal.
 836  *
 837  * MT safe.
 838  */
 839 void
 840 gst_element_no_more_pads (GstElement * element)
 841 {
 842   g_return_if_fail (GST_IS_ELEMENT (element));
 843
 844   g_signal_emit (element, gst_element_signals[NO_MORE_PADS], 0);
 845 }
 846
 847 static gint
 848 pad_compare_name (GstPad * pad1, const gchar * name)
 849 {
 850   gint result;
 851
 852   GST_OBJECT_LOCK (pad1);
 853   result = strcmp (GST_PAD_NAME (pad1), name);
 854   GST_OBJECT_UNLOCK (pad1);
 855
 856   return result;
 857 }
 858
 859 /**
 860  * gst_element_get_static_pad:
 861  * @element: a #GstElement to find a static pad of.
 862  * @name: the name of the static #GstPad to retrieve.
 863  *
 864  * Retrieves a pad from @element by name. This version only retrieves
 865  * already-existing (i.e. 'static') pads.
 866  *
 867  * Returns: (transfer full): the requested #GstPad if found, otherwise %NULL.
 868  *     unref after usage.
 869  *
 870  * MT safe.
 871  */
 872 GstPad *
 873 gst_element_get_static_pad (GstElement * element, const gchar * name)
 874 {
 875   GList *find;
 876   GstPad *result = NULL;
 877
 878   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 879   g_return_val_if_fail (name != NULL, NULL);
 880
 881   GST_OBJECT_LOCK (element);
 882   find =
 883       g_list_find_custom (element->pads, name, (GCompareFunc) pad_compare_name);
 884   if (find) {
 885     result = GST_PAD_CAST (find->data);
 886     gst_object_ref (result);
 887   }
 888
 889   if (result == NULL) {
 890     GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "no such pad '%s' in element \"%s\"",
 891         name, GST_ELEMENT_NAME (element));
 892   } else {
 893     GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "found pad %s:%s",
 894         GST_ELEMENT_NAME (element), name);
 895   }
 896   GST_OBJECT_UNLOCK (element);
 897
 898   return result;
 899 }
 900
 901 static GstPad *
 902 _gst_element_request_pad (GstElement * element, GstPadTemplate * templ,
 903     const gchar * name, const GstCaps * caps)
 904 {
 905   GstPad *newpad = NULL;
 906   GstElementClass *oclass;
 907
 908   oclass = GST_ELEMENT_GET_CLASS (element);
 909
 910 #ifndef G_DISABLE_CHECKS
 911   /* Some sanity checking here */
 912   if (name) {
 913     GstPad *pad;
 914
 915     /* Is this the template name? */
 916     if (strstr (name, "%") || !strchr (templ->name_template, '%')) {
 917       g_return_val_if_fail (strcmp (name, templ->name_template) == 0, NULL);
 918     } else {
 919       const gchar *str, *data;
 920       gchar *endptr;
 921
 922       /* Otherwise check if it's a valid name for the name template */
 923       str = strchr (templ->name_template, '%');
 924       g_return_val_if_fail (str != NULL, NULL);
 925       g_return_val_if_fail (strncmp (templ->name_template, name,
 926               str - templ->name_template) == 0, NULL);
 927       g_return_val_if_fail (strlen (name) > str - templ->name_template, NULL);
 928
 929       data = name + (str - templ->name_template);
 930
 931       /* Can either be %s or %d or %u, do sanity checking for %d */
 932       if (*(str + 1) == 'd') {
 933         gint64 tmp;
 934
 935         /* it's an int */
 936         tmp = g_ascii_strtoll (data, &endptr, 10);
 937         g_return_val_if_fail (tmp >= G_MININT && tmp <= G_MAXINT
 938             && *endptr == '\0', NULL);
 939       } else if (*(str + 1) == 'u') {
 940         guint64 tmp;
 941
 942         /* it's an int */
 943         tmp = g_ascii_strtoull (data, &endptr, 10);
 944         g_return_val_if_fail (tmp <= G_MAXUINT && *endptr == '\0', NULL);
 945       }
 946     }
 947
 948     pad = gst_element_get_static_pad (element, name);
 949     if (pad) {
 950       gst_object_unref (pad);
 951       /* FIXME 0.11: Change this to g_return_val_if_fail() */
 952       g_critical ("Element %s already has a pad named %s, the behaviour of "
 953           " gst_element_get_request_pad() for existing pads is undefined!",
 954           GST_ELEMENT_NAME (element), name);
 955     }
 956   }
 957 #endif
 958
 959   if (oclass->request_new_pad)
 960     newpad = (oclass->request_new_pad) (element, templ, name, caps);
 961
 962   if (newpad)
 963     gst_object_ref (newpad);
 964
 965   return newpad;
 966 }
 967
 968 /**
 969  * gst_element_get_request_pad:
 970  * @element: a #GstElement to find a request pad of.
 971  * @name: the name of the request #GstPad to retrieve.
 972  *
 973  * Retrieves a pad from the element by name (e.g. "src_\%d"). This version only
 974  * retrieves request pads. The pad should be released with
 975  * gst_element_release_request_pad().
 976  *
 977  * This method is slow and will be deprecated in the future. New code should
 978  * use gst_element_request_pad() with the requested template.
 979  *
 980  * Returns: (transfer full): requested #GstPad if found, otherwise %NULL.
 981  *     Release after usage.
 982  */
 983 GstPad *
 984 gst_element_get_request_pad (GstElement * element, const gchar * name)
 985 {
 986   GstPadTemplate *templ = NULL;
 987   GstPad *pad;
 988   const gchar *req_name = NULL;
 989   gboolean templ_found = FALSE;
 990   GList *list;
 991   const gchar *data;
 992   gchar *str, *endptr = NULL;
 993   GstElementClass *class;
 994
 995   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 996   g_return_val_if_fail (name != NULL, NULL);
 997
 998   class = GST_ELEMENT_GET_CLASS (element);
 999
1000   /* if the name contains a %, we assume it's the complete template name. Get
1001    * the template and try to get a pad */
1002   if (strstr (name, "%")) {
1003     templ = gst_element_class_get_request_pad_template (class, name);
1004     req_name = NULL;
1005     if (templ)
1006       templ_found = TRUE;
1007   } else {
1008     /* there is no % in the name, try to find a matching template */
1009     list = class->padtemplates;
1010     while (!templ_found && list) {
1011       templ = (GstPadTemplate *) list->data;
1012       if (templ->presence == GST_PAD_REQUEST) {
1013         GST_CAT_DEBUG (GST_CAT_PADS, "comparing %s to %s", name,
1014             templ->name_template);
1015         /* see if we find an exact match */
1016         if (strcmp (name, templ->name_template) == 0) {
1017           templ_found = TRUE;
1018           req_name = name;
1019           break;
1020         }
1021         /* Because of sanity checks in gst_pad_template_new(), we know that %s
1022            and %d and %u, occurring at the end of the name_template, are the only
1023            possibilities. */
1024         else if ((str = strchr (templ->name_template, '%'))
1025             && strncmp (templ->name_template, name,
1026                 str - templ->name_template) == 0
1027             && strlen (name) > str - templ->name_template) {
1028           data = name + (str - templ->name_template);
1029           if (*(str + 1) == 'd') {
1030             glong tmp;
1031
1032             /* it's an int */
1033             tmp = strtol (data, &endptr, 10);
1034             if (tmp != G_MINLONG && tmp != G_MAXLONG && endptr &&
1035                 *endptr == '\0') {
1036               templ_found = TRUE;
1037               req_name = name;
1038               break;
1039             }
1040           } else if (*(str + 1) == 'u') {
1041             gulong tmp;
1042
1043             /* it's an int */
1044             tmp = strtoul (data, &endptr, 10);
1045             if (tmp != G_MAXULONG && endptr && *endptr == '\0') {
1046               templ_found = TRUE;
1047               req_name = name;
1048               break;
1049             }
1050           } else {
1051             /* it's a string */
1052             templ_found = TRUE;
1053             req_name = name;
1054             break;
1055           }
1056         }
1057       }
1058       list = list->next;
1059     }
1060   }
1061
1062   if (!templ_found)
1063     return NULL;
1064
1065   pad = _gst_element_request_pad (element, templ, req_name, NULL);
1066
1067   return pad;
1068 }
1069
1070 /**
1071  * gst_element_request_pad:
1072  * @element: a #GstElement to find a request pad of.
1073  * @templ: a #GstPadTemplate of which we want a pad of.
1074  * @name: (transfer none) (allow-none): the name of the request #GstPad
1075  * to retrieve. Can be %NULL.
1076  * @caps: (transfer none) (allow-none): the caps of the pad we want to
1077  * request. Can be %NULL.
1078  *
1079  * Retrieves a request pad from the element according to the provided template.
1080  * Pad templates can be looked up using
1081  * gst_element_factory_get_static_pad_templates().
1082  *
1083  * The pad should be released with gst_element_release_request_pad().
1084  *
1085  * Returns: (transfer full): requested #GstPad if found, otherwise %NULL.
1086  *     Release after usage.
1087  *
1088  * Since: 0.10.32
1089  */
1090 GstPad *
1091 gst_element_request_pad (GstElement * element,
1092     GstPadTemplate * templ, const gchar * name, const GstCaps * caps)
1093 {
1094   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
1095   g_return_val_if_fail (templ != NULL, NULL);
1096
1097   return _gst_element_request_pad (element, templ, name, caps);
1098 }
1099
1100 static GstIterator *
1101 gst_element_iterate_pad_list (GstElement * element, GList ** padlist)
1102 {
1103   GstIterator *result;
1104
1105   GST_OBJECT_LOCK (element);
1106   result = gst_iterator_new_list (GST_TYPE_PAD,
1107       GST_OBJECT_GET_LOCK (element),
1108       &element->pads_cookie, padlist, (GObject *) element, NULL);
1109   GST_OBJECT_UNLOCK (element);
1110
1111   return result;
1112 }
1113
1114 /**
1115  * gst_element_iterate_pads:
1116  * @element: a #GstElement to iterate pads of.
1117  *
1118  * Retrieves an iterator of @element's pads. The iterator should
1119  * be freed after usage. Also more specialized iterators exists such as
1120  * gst_element_iterate_src_pads() or gst_element_iterate_sink_pads().
1121  *
1122  * Returns: (transfer full): the #GstIterator of #GstPad. Unref each pad
1123  *     after use.
1124  *
1125  * MT safe.
1126  */
1127 GstIterator *
1128 gst_element_iterate_pads (GstElement * element)
1129 {
1130   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
1131
1132   return gst_element_iterate_pad_list (element, &element->pads);
1133 }
1134
1135 /**
1136  * gst_element_iterate_src_pads:
1137  * @element: a #GstElement.
1138  *
1139  * Retrieves an iterator of @element's source pads.
1140  *
1141  * Returns: (transfer full): the #GstIterator of #GstPad. Unref each pad
1142  *     after use.
1143  *
1144  * MT safe.
1145  */
1146 GstIterator *
1147 gst_element_iterate_src_pads (GstElement * element)
1148 {
1149   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
1150
1151   return gst_element_iterate_pad_list (element, &element->srcpads);
1152 }
1153
1154 /**
1155  * gst_element_iterate_sink_pads:
1156  * @element: a #GstElement.
1157  *
1158  * Retrieves an iterator of @element's sink pads.
1159  *
1160  * Returns: (transfer full): the #GstIterator of #GstPad. Unref each pad
1161  *     after use.
1162  *
1163  * MT safe.
1164  */
1165 GstIterator *
1166 gst_element_iterate_sink_pads (GstElement * element)
1167 {
1168   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
1169
1170   return gst_element_iterate_pad_list (element, &element->sinkpads);
1171 }
1172
1173 /**
1174  * gst_element_class_add_pad_template:
1175  * @klass: the #GstElementClass to add the pad template to.
1176  * @templ: (transfer full): a #GstPadTemplate to add to the element class.
1177  *
1178  * Adds a padtemplate to an element class. This is mainly used in the _class_init
1179  * functions of classes. If a pad template with the same name as an already
1180  * existing one is added the old one is replaced by the new one.
1181  *
1182  */
1183 void
1184 gst_element_class_add_pad_template (GstElementClass * klass,
1185     GstPadTemplate * templ)
1186 {
1187   GList *template_list = klass->padtemplates;
1188
1189   g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
1190   g_return_if_fail (GST_IS_PAD_TEMPLATE (templ));
1191
1192   /* If we already have a pad template with the same name replace the
1193    * old one. */
1194   while (template_list) {
1195     GstPadTemplate *padtempl = (GstPadTemplate *) template_list->data;
1196
1197     /* Found pad with the same name, replace and return */
1198     if (strcmp (templ->name_template, padtempl->name_template) == 0) {
1199       gst_object_unref (padtempl);
1200       template_list->data = templ;
1201       return;
1202     }
1203     template_list = g_list_next (template_list);
1204   }
1205
1206   /* Take ownership of the floating ref */
1207   gst_object_ref_sink (templ);
1208
1209   klass->padtemplates = g_list_append (klass->padtemplates, templ);
1210   klass->numpadtemplates++;
1211 }
1212
1213 /**
1214  * gst_element_class_add_metadata:
1215  * @klass: class to set metadata for
1216  * @key: the key to set
1217  * @value: the value to set
1218  *
1219  * Set @key with @value as metadata in @klass.
1220  */
1221 void
1222 gst_element_class_add_metadata (GstElementClass * klass,
1223     const gchar * key, const gchar * value)
1224 {
1225   g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
1226   g_return_if_fail (key != NULL);
1227   g_return_if_fail (value != NULL);
1228
1229   gst_structure_set ((GstStructure *) klass->metadata,
1230       key, G_TYPE_STRING, value, NULL);
1231 }
1232
1233 /**
1234  * gst_element_class_set_metadata:
1235  * @klass: class to set metadata for
1236  * @longname: The long English name of the element. E.g. "File Sink"
1237  * @classification: String describing the type of element, as an unordered list
1238  * separated with slashes ('/'). See draft-klass.txt of the design docs
1239  * for more details and common types. E.g: "Sink/File"
1240  * @description: Sentence describing the purpose of the element.
1241  * E.g: "Write stream to a file"
1242  * @author: Name and contact details of the author(s). Use \n to separate
1243  * multiple author metadata. E.g: "Joe Bloggs &lt;joe.blogs at foo.com&gt;"
1244  *
1245  * Sets the detailed information for a #GstElementClass.
1246  * <note>This function is for use in _class_init functions only.</note>
1247  */
1248 void
1249 gst_element_class_set_metadata (GstElementClass * klass,
1250     const gchar * longname, const gchar * classification,
1251     const gchar * description, const gchar * author)
1252 {
1253   g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
1254
1255   gst_structure_set ((GstStructure *) klass->metadata,
1256       GST_ELEMENT_METADATA_LONGNAME, G_TYPE_STRING, longname,
1257       GST_ELEMENT_METADATA_KLASS, G_TYPE_STRING, classification,
1258       GST_ELEMENT_METADATA_DESCRIPTION, G_TYPE_STRING, description,
1259       GST_ELEMENT_METADATA_AUTHOR, G_TYPE_STRING, author, NULL);
1260 }
1261
1262 /**
1263  * gst_element_class_get_metadata:
1264  * @klass: class to get metadata for
1265  * @key: the key to get
1266  *
1267  * Get metadata with @key in @klass.
1268  *
1269  * Returns: the metadata for @key.
1270  */
1271 const gchar *
1272 gst_element_class_get_metadata (GstElementClass * klass, const gchar * key)
1273 {
1274   g_return_val_if_fail (GST_IS_ELEMENT_CLASS (klass), NULL);
1275   g_return_val_if_fail (key != NULL, NULL);
1276
1277   return gst_structure_get_string ((GstStructure *) klass->metadata, key);
1278 }
1279
1280 /**
1281  * gst_element_class_get_pad_template_list:
1282  * @element_class: a #GstElementClass to get pad templates of.
1283  *
1284  * Retrieves a list of the pad templates associated with @element_class. The
1285  * list must not be modified by the calling code.
1286  * <note>If you use this function in the #GInstanceInitFunc of an object class
1287  * that has subclasses, make sure to pass the g_class parameter of the
1288  * #GInstanceInitFunc here.</note>
1289  *
1290  * Returns: (transfer none) (element-type Gst.PadTemplate): the #GList of
1291  *     pad templates.
1292  */
1293 GList *
1294 gst_element_class_get_pad_template_list (GstElementClass * element_class)
1295 {
1296   g_return_val_if_fail (GST_IS_ELEMENT_CLASS (element_class), NULL);
1297
1298   return element_class->padtemplates;
1299 }
1300
1301 /**
1302  * gst_element_class_get_pad_template:
1303  * @element_class: a #GstElementClass to get the pad template of.
1304  * @name: the name of the #GstPadTemplate to get.
1305  *
1306  * Retrieves a padtemplate from @element_class with the given name.
1307  * <note>If you use this function in the #GInstanceInitFunc of an object class
1308  * that has subclasses, make sure to pass the g_class parameter of the
1309  * #GInstanceInitFunc here.</note>
1310  *
1311  * Returns: (transfer none): the #GstPadTemplate with the given name, or %NULL
1312  *     if none was found. No unreferencing is necessary.
1313  */
1314 GstPadTemplate *
1315 gst_element_class_get_pad_template (GstElementClass *
1316     element_class, const gchar * name)
1317 {
1318   GList *padlist;
1319
1320   g_return_val_if_fail (GST_IS_ELEMENT_CLASS (element_class), NULL);
1321   g_return_val_if_fail (name != NULL, NULL);
1322
1323   padlist = element_class->padtemplates;
1324
1325   while (padlist) {
1326     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
1327
1328     if (strcmp (padtempl->name_template, name) == 0)
1329       return padtempl;
1330
1331     padlist = g_list_next (padlist);
1332   }
1333
1334   return NULL;
1335 }
1336
1337 static GstPadTemplate *
1338 gst_element_class_get_request_pad_template (GstElementClass *
1339     element_class, const gchar * name)
1340 {
1341   GstPadTemplate *tmpl;
1342
1343   tmpl = gst_element_class_get_pad_template (element_class, name);
1344   if (tmpl != NULL && tmpl->presence == GST_PAD_REQUEST)
1345     return tmpl;
1346
1347   return NULL;
1348 }
1349
1350 /* get a random pad on element of the given direction.
1351  * The pad is random in a sense that it is the first pad that is (optionaly) linked.
1352  */
1353 static GstPad *
1354 gst_element_get_random_pad (GstElement * element,
1355     gboolean need_linked, GstPadDirection dir)
1356 {
1357   GstPad *result = NULL;
1358   GList *pads;
1359
1360   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "getting a random pad");
1361
1362   switch (dir) {
1363     case GST_PAD_SRC:
1364       GST_OBJECT_LOCK (element);
1365       pads = element->srcpads;
1366       break;
1367     case GST_PAD_SINK:
1368       GST_OBJECT_LOCK (element);
1369       pads = element->sinkpads;
1370       break;
1371     default:
1372       goto wrong_direction;
1373   }
1374   for (; pads; pads = g_list_next (pads)) {
1375     GstPad *pad = GST_PAD_CAST (pads->data);
1376
1377     GST_OBJECT_LOCK (pad);
1378     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "checking pad %s:%s",
1379         GST_DEBUG_PAD_NAME (pad));
1380
1381     if (need_linked && !GST_PAD_IS_LINKED (pad)) {
1382       /* if we require a linked pad, and it is not linked, continue the
1383        * search */
1384       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is not linked",
1385           GST_DEBUG_PAD_NAME (pad));
1386       GST_OBJECT_UNLOCK (pad);
1387       continue;
1388     } else {
1389       /* found a pad, stop search */
1390       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "found pad %s:%s",
1391           GST_DEBUG_PAD_NAME (pad));
1392       GST_OBJECT_UNLOCK (pad);
1393       result = pad;
1394       break;
1395     }
1396   }
1397   if (result)
1398     gst_object_ref (result);
1399
1400   GST_OBJECT_UNLOCK (element);
1401
1402   return result;
1403
1404   /* ERROR handling */
1405 wrong_direction:
1406   {
1407     g_warning ("unknown pad direction %d", dir);
1408     return NULL;
1409   }
1410 }
1411
1412 static gboolean
1413 gst_element_default_send_event (GstElement * element, GstEvent * event)
1414 {
1415   gboolean result = FALSE;
1416   GstPad *pad;
1417
1418   pad = GST_EVENT_IS_DOWNSTREAM (event) ?
1419       gst_element_get_random_pad (element, TRUE, GST_PAD_SRC) :
1420       gst_element_get_random_pad (element, TRUE, GST_PAD_SINK);
1421
1422   if (pad) {
1423     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1424         "pushing %s event to random %s pad %s:%s",
1425         GST_EVENT_TYPE_NAME (event),
1426         (GST_PAD_DIRECTION (pad) == GST_PAD_SRC ? "src" : "sink"),
1427         GST_DEBUG_PAD_NAME (pad));
1428
1429     result = gst_pad_push_event (pad, event);
1430     gst_object_unref (pad);
1431   } else {
1432     GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "can't send %s event on element %s",
1433         GST_EVENT_TYPE_NAME (event), GST_ELEMENT_NAME (element));
1434     gst_event_unref (event);
1435   }
1436   return result;
1437 }
1438
1439 /**
1440  * gst_element_send_event:
1441  * @element: a #GstElement to send the event to.
1442  * @event: (transfer full): the #GstEvent to send to the element.
1443  *
1444  * Sends an event to an element. If the element doesn't implement an
1445  * event handler, the event will be pushed on a random linked sink pad for
1446  * upstream events or a random linked source pad for downstream events.
1447  *
1448  * This function takes owership of the provided event so you should
1449  * gst_event_ref() it if you want to reuse the event after this call.
1450  *
1451  * Returns: %TRUE if the event was handled.
1452  *
1453  * MT safe.
1454  */
1455 gboolean
1456 gst_element_send_event (GstElement * element, GstEvent * event)
1457 {
1458   GstElementClass *oclass;
1459   gboolean result = FALSE;
1460
1461   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1462   g_return_val_if_fail (event != NULL, FALSE);
1463
1464   oclass = GST_ELEMENT_GET_CLASS (element);
1465
1466   GST_STATE_LOCK (element);
1467   if (oclass->send_event) {
1468     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "send %s event on element %s",
1469         GST_EVENT_TYPE_NAME (event), GST_ELEMENT_NAME (element));
1470     result = oclass->send_event (element, event);
1471   }
1472   GST_STATE_UNLOCK (element);
1473
1474   return result;
1475 }
1476
1477 /**
1478  * gst_element_seek:
1479  * @element: a #GstElement to send the event to.
1480  * @rate: The new playback rate
1481  * @format: The format of the seek values
1482  * @flags: The optional seek flags.
1483  * @cur_type: The type and flags for the new current position
1484  * @cur: The value of the new current position
1485  * @stop_type: The type and flags for the new stop position
1486  * @stop: The value of the new stop position
1487  *
1488  * Sends a seek event to an element. See gst_event_new_seek() for the details of
1489  * the parameters. The seek event is sent to the element using
1490  * gst_element_send_event().
1491  *
1492  * Returns: %TRUE if the event was handled.
1493  *
1494  * MT safe.
1495  */
1496 gboolean
1497 gst_element_seek (GstElement * element, gdouble rate, GstFormat format,
1498     GstSeekFlags flags, GstSeekType cur_type, gint64 cur,
1499     GstSeekType stop_type, gint64 stop)
1500 {
1501   GstEvent *event;
1502   gboolean result;
1503
1504   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1505
1506   event =
1507       gst_event_new_seek (rate, format, flags, cur_type, cur, stop_type, stop);
1508   result = gst_element_send_event (element, event);
1509
1510   return result;
1511 }
1512
1513 static gboolean
1514 gst_element_default_query (GstElement * element, GstQuery * query)
1515 {
1516   gboolean result = FALSE;
1517   GstPad *pad;
1518
1519   pad = gst_element_get_random_pad (element, FALSE, GST_PAD_SRC);
1520   if (pad) {
1521     result = gst_pad_query (pad, query);
1522
1523     gst_object_unref (pad);
1524   } else {
1525     pad = gst_element_get_random_pad (element, TRUE, GST_PAD_SINK);
1526     if (pad) {
1527       GstPad *peer = gst_pad_get_peer (pad);
1528
1529       if (peer) {
1530         result = gst_pad_query (peer, query);
1531
1532         gst_object_unref (peer);
1533       }
1534       gst_object_unref (pad);
1535     }
1536   }
1537   return result;
1538 }
1539
1540 /**
1541  * gst_element_query:
1542  * @element: a #GstElement to perform the query on.
1543  * @query: (transfer none): the #GstQuery.
1544  *
1545  * Performs a query on the given element.
1546  *
1547  * For elements that don't implement a query handler, this function
1548  * forwards the query to a random srcpad or to the peer of a
1549  * random linked sinkpad of this element.
1550  *
1551  * Please note that some queries might need a running pipeline to work.
1552  *
1553  * Returns: TRUE if the query could be performed.
1554  *
1555  * MT safe.
1556  */
1557 gboolean
1558 gst_element_query (GstElement * element, GstQuery * query)
1559 {
1560   GstElementClass *oclass;
1561   gboolean result = FALSE;
1562
1563   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1564   g_return_val_if_fail (query != NULL, FALSE);
1565
1566   oclass = GST_ELEMENT_GET_CLASS (element);
1567
1568   if (oclass->query) {
1569     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "send query on element %s",
1570         GST_ELEMENT_NAME (element));
1571     result = oclass->query (element, query);
1572   }
1573   return result;
1574 }
1575
1576 /**
1577  * gst_element_post_message:
1578  * @element: a #GstElement posting the message
1579  * @message: (transfer full): a #GstMessage to post
1580  *
1581  * Post a message on the element's #GstBus. This function takes ownership of the
1582  * message; if you want to access the message after this call, you should add an
1583  * additional reference before calling.
1584  *
1585  * Returns: %TRUE if the message was successfully posted. The function returns
1586  * %FALSE if the element did not have a bus.
1587  *
1588  * MT safe.
1589  */
1590 gboolean
1591 gst_element_post_message (GstElement * element, GstMessage * message)
1592 {
1593   GstBus *bus;
1594   gboolean result = FALSE;
1595
1596   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1597   g_return_val_if_fail (message != NULL, FALSE);
1598
1599   GST_OBJECT_LOCK (element);
1600   bus = element->bus;
1601
1602   if (G_UNLIKELY (bus == NULL))
1603     goto no_bus;
1604
1605   gst_object_ref (bus);
1606   GST_OBJECT_UNLOCK (element);
1607
1608   /* we release the element lock when posting the message so that any
1609    * (synchronous) message handlers can operate on the element */
1610   result = gst_bus_post (bus, message);
1611   gst_object_unref (bus);
1612
1613   return result;
1614
1615   /* ERRORS */
1616 no_bus:
1617   {
1618     GST_CAT_DEBUG_OBJECT (GST_CAT_MESSAGE, element,
1619         "not posting message %p: no bus", message);
1620     GST_OBJECT_UNLOCK (element);
1621     gst_message_unref (message);
1622     return FALSE;
1623   }
1624 }
1625
1626 /**
1627  * _gst_element_error_printf:
1628  * @format: the printf-like format to use, or %NULL
1629  *
1630  * This function is only used internally by the gst_element_error() macro.
1631  *
1632  * Returns: (transfer full): a newly allocated string, or %NULL if the format
1633  *     was %NULL or ""
1634  *
1635  * MT safe.
1636  */
1637 gchar *
1638 _gst_element_error_printf (const gchar * format, ...)
1639 {
1640   va_list args;
1641   gchar *buffer;
1642
1643   if (format == NULL)
1644     return NULL;
1645   if (format[0] == 0)
1646     return NULL;
1647
1648   va_start (args, format);
1649   buffer = g_strdup_vprintf (format, args);
1650   va_end (args);
1651   return buffer;
1652 }
1653
1654 /**
1655  * gst_element_message_full:
1656  * @element:  a #GstElement to send message from
1657  * @type:     the #GstMessageType
1658  * @domain:   the GStreamer GError domain this message belongs to
1659  * @code:     the GError code belonging to the domain
1660  * @text:     (allow-none) (transfer full): an allocated text string to be used
1661  *            as a replacement for the default message connected to code,
1662  *            or %NULL
1663  * @debug:    (allow-none) (transfer full): an allocated debug message to be
1664  *            used as a replacement for the default debugging information,
1665  *            or %NULL
1666  * @file:     the source code file where the error was generated
1667  * @function: the source code function where the error was generated
1668  * @line:     the source code line where the error was generated
1669  *
1670  * Post an error, warning or info message on the bus from inside an element.
1671  *
1672  * @type must be of #GST_MESSAGE_ERROR, #GST_MESSAGE_WARNING or
1673  * #GST_MESSAGE_INFO.
1674  *
1675  * MT safe.
1676  */
1677 void gst_element_message_full
1678     (GstElement * element, GstMessageType type,
1679     GQuark domain, gint code, gchar * text,
1680     gchar * debug, const gchar * file, const gchar * function, gint line)
1681 {
1682   GError *gerror = NULL;
1683   gchar *name;
1684   gchar *sent_text;
1685   gchar *sent_debug;
1686   gboolean has_debug = TRUE;
1687   GstMessage *message = NULL;
1688
1689   /* checks */
1690   GST_CAT_DEBUG_OBJECT (GST_CAT_MESSAGE, element, "start");
1691   g_return_if_fail (GST_IS_ELEMENT (element));
1692   g_return_if_fail ((type == GST_MESSAGE_ERROR) ||
1693       (type == GST_MESSAGE_WARNING) || (type == GST_MESSAGE_INFO));
1694
1695   /* check if we send the given text or the default error text */
1696   if ((text == NULL) || (text[0] == 0)) {
1697     /* text could have come from g_strdup_printf (""); */
1698     g_free (text);
1699     sent_text = gst_error_get_message (domain, code);
1700   } else
1701     sent_text = text;
1702
1703   /* construct a sent_debug with extra information from source */
1704   if ((debug == NULL) || (debug[0] == 0)) {
1705     /* debug could have come from g_strdup_printf (""); */
1706     has_debug = FALSE;
1707   }
1708
1709   name = gst_object_get_path_string (GST_OBJECT_CAST (element));
1710   if (has_debug)
1711     sent_debug = g_strdup_printf ("%s(%d): %s (): %s:\n%s",
1712         file, line, function, name, debug);
1713   else
1714     sent_debug = g_strdup_printf ("%s(%d): %s (): %s",
1715         file, line, function, name);
1716   g_free (name);
1717   g_free (debug);
1718
1719   /* create gerror and post message */
1720   GST_CAT_INFO_OBJECT (GST_CAT_ERROR_SYSTEM, element, "posting message: %s",
1721       sent_text);
1722   gerror = g_error_new_literal (domain, code, sent_text);
1723
1724   switch (type) {
1725     case GST_MESSAGE_ERROR:
1726       message =
1727           gst_message_new_error (GST_OBJECT_CAST (element), gerror, sent_debug);
1728       break;
1729     case GST_MESSAGE_WARNING:
1730       message = gst_message_new_warning (GST_OBJECT_CAST (element), gerror,
1731           sent_debug);
1732       break;
1733     case GST_MESSAGE_INFO:
1734       message = gst_message_new_info (GST_OBJECT_CAST (element), gerror,
1735           sent_debug);
1736       break;
1737     default:
1738       g_assert_not_reached ();
1739       break;
1740   }
1741   gst_element_post_message (element, message);
1742
1743   GST_CAT_INFO_OBJECT (GST_CAT_ERROR_SYSTEM, element, "posted %s message: %s",
1744       (type == GST_MESSAGE_ERROR ? "error" : "warning"), sent_text);
1745
1746   /* cleanup */
1747   g_error_free (gerror);
1748   g_free (sent_debug);
1749   g_free (sent_text);
1750 }
1751
1752 /**
1753  * gst_element_is_locked_state:
1754  * @element: a #GstElement.
1755  *
1756  * Checks if the state of an element is locked.
1757  * If the state of an element is locked, state changes of the parent don't
1758  * affect the element.
1759  * This way you can leave currently unused elements inside bins. Just lock their
1760  * state before changing the state from #GST_STATE_NULL.
1761  *
1762  * MT safe.
1763  *
1764  * Returns: TRUE, if the element's state is locked.
1765  */
1766 gboolean
1767 gst_element_is_locked_state (GstElement * element)
1768 {
1769   gboolean result;
1770
1771   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1772
1773   GST_OBJECT_LOCK (element);
1774   result = GST_ELEMENT_IS_LOCKED_STATE (element);
1775   GST_OBJECT_UNLOCK (element);
1776
1777   return result;
1778 }
1779
1780 /**
1781  * gst_element_set_locked_state:
1782  * @element: a #GstElement
1783  * @locked_state: TRUE to lock the element's state
1784  *
1785  * Locks the state of an element, so state changes of the parent don't affect
1786  * this element anymore.
1787  *
1788  * MT safe.
1789  *
1790  * Returns: TRUE if the state was changed, FALSE if bad parameters were given
1791  * or the elements state-locking needed no change.
1792  */
1793 gboolean
1794 gst_element_set_locked_state (GstElement * element, gboolean locked_state)
1795 {
1796   gboolean old;
1797
1798   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1799
1800   GST_OBJECT_LOCK (element);
1801   old = GST_ELEMENT_IS_LOCKED_STATE (element);
1802
1803   if (G_UNLIKELY (old == locked_state))
1804     goto was_ok;
1805
1806   if (locked_state) {
1807     GST_CAT_DEBUG (GST_CAT_STATES, "locking state of element %s",
1808         GST_ELEMENT_NAME (element));
1809     GST_OBJECT_FLAG_SET (element, GST_ELEMENT_FLAG_LOCKED_STATE);
1810   } else {
1811     GST_CAT_DEBUG (GST_CAT_STATES, "unlocking state of element %s",
1812         GST_ELEMENT_NAME (element));
1813     GST_OBJECT_FLAG_UNSET (element, GST_ELEMENT_FLAG_LOCKED_STATE);
1814   }
1815   GST_OBJECT_UNLOCK (element);
1816
1817   return TRUE;
1818
1819 was_ok:
1820   {
1821     GST_CAT_DEBUG (GST_CAT_STATES,
1822         "elements %s was already in locked state %d",
1823         GST_ELEMENT_NAME (element), old);
1824     GST_OBJECT_UNLOCK (element);
1825
1826     return FALSE;
1827   }
1828 }
1829
1830 /**
1831  * gst_element_sync_state_with_parent:
1832  * @element: a #GstElement.
1833  *
1834  * Tries to change the state of the element to the same as its parent.
1835  * If this function returns FALSE, the state of element is undefined.
1836  *
1837  * Returns: TRUE, if the element's state could be synced to the parent's state.
1838  *
1839  * MT safe.
1840  */
1841 gboolean
1842 gst_element_sync_state_with_parent (GstElement * element)
1843 {
1844   GstElement *parent;
1845   GstState target;
1846   GstStateChangeReturn ret;
1847
1848   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1849
1850   if ((parent = GST_ELEMENT_CAST (gst_element_get_parent (element)))) {
1851     GstState parent_current, parent_pending;
1852
1853     GST_OBJECT_LOCK (parent);
1854     parent_current = GST_STATE (parent);
1855     parent_pending = GST_STATE_PENDING (parent);
1856     GST_OBJECT_UNLOCK (parent);
1857
1858     /* set to pending if there is one, else we set it to the current state of
1859      * the parent */
1860     if (parent_pending != GST_STATE_VOID_PENDING)
1861       target = parent_pending;
1862     else
1863       target = parent_current;
1864
1865     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
1866         "syncing state (%s) to parent %s %s (%s, %s)",
1867         gst_element_state_get_name (GST_STATE (element)),
1868         GST_ELEMENT_NAME (parent), gst_element_state_get_name (target),
1869         gst_element_state_get_name (parent_current),
1870         gst_element_state_get_name (parent_pending));
1871
1872     ret = gst_element_set_state (element, target);
1873     if (ret == GST_STATE_CHANGE_FAILURE)
1874       goto failed;
1875
1876     gst_object_unref (parent);
1877
1878     return TRUE;
1879   } else {
1880     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "element has no parent");
1881   }
1882   return FALSE;
1883
1884   /* ERROR */
1885 failed:
1886   {
1887     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
1888         "syncing state failed (%s)",
1889         gst_element_state_change_return_get_name (ret));
1890     gst_object_unref (parent);
1891     return FALSE;
1892   }
1893 }
1894
1895 /* MT safe */
1896 static GstStateChangeReturn
1897 gst_element_get_state_func (GstElement * element,
1898     GstState * state, GstState * pending, GstClockTime timeout)
1899 {
1900   GstStateChangeReturn ret = GST_STATE_CHANGE_FAILURE;
1901   GstState old_pending;
1902
1903   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "getting state, timeout %"
1904       GST_TIME_FORMAT, GST_TIME_ARGS (timeout));
1905
1906   GST_OBJECT_LOCK (element);
1907   ret = GST_STATE_RETURN (element);
1908   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "RETURN is %s",
1909       gst_element_state_change_return_get_name (ret));
1910
1911   /* we got an error, report immediately */
1912   if (ret == GST_STATE_CHANGE_FAILURE)
1913     goto done;
1914
1915   /* we got no_preroll, report immediately */
1916   if (ret == GST_STATE_CHANGE_NO_PREROLL)
1917     goto done;
1918
1919   /* no need to wait async if we are not async */
1920   if (ret != GST_STATE_CHANGE_ASYNC)
1921     goto done;
1922
1923   old_pending = GST_STATE_PENDING (element);
1924   if (old_pending != GST_STATE_VOID_PENDING) {
1925     gboolean signaled;
1926     guint32 cookie;
1927
1928     /* get cookie to detect state changes during waiting */
1929     cookie = element->state_cookie;
1930
1931     GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
1932         "waiting for element to commit state");
1933
1934     /* we have a pending state change, wait for it to complete */
1935     if (timeout != GST_CLOCK_TIME_NONE) {
1936       gint64 end_time;
1937       /* make timeout absolute */
1938       end_time = g_get_monotonic_time () + (timeout / 1000);
1939       signaled = GST_STATE_WAIT_UNTIL (element, end_time);
1940     } else {
1941       GST_STATE_WAIT (element);
1942       signaled = TRUE;
1943     }
1944
1945     if (!signaled) {
1946       GST_CAT_INFO_OBJECT (GST_CAT_STATES, element, "timed out");
1947       /* timeout triggered */
1948       ret = GST_STATE_CHANGE_ASYNC;
1949     } else {
1950       if (cookie != element->state_cookie)
1951         goto interrupted;
1952
1953       /* could be success or failure */
1954       if (old_pending == GST_STATE (element)) {
1955         GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "got success");
1956         ret = GST_STATE_CHANGE_SUCCESS;
1957       } else {
1958         GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "got failure");
1959         ret = GST_STATE_CHANGE_FAILURE;
1960       }
1961     }
1962     /* if nothing is pending anymore we can return SUCCESS */
1963     if (GST_STATE_PENDING (element) == GST_STATE_VOID_PENDING) {
1964       GST_CAT_LOG_OBJECT (GST_CAT_STATES, element, "nothing pending");
1965       ret = GST_STATE_CHANGE_SUCCESS;
1966     }
1967   }
1968
1969 done:
1970   if (state)
1971     *state = GST_STATE (element);
1972   if (pending)
1973     *pending = GST_STATE_PENDING (element);
1974
1975   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
1976       "state current: %s, pending: %s, result: %s",
1977       gst_element_state_get_name (GST_STATE (element)),
1978       gst_element_state_get_name (GST_STATE_PENDING (element)),
1979       gst_element_state_change_return_get_name (ret));
1980   GST_OBJECT_UNLOCK (element);
1981
1982   return ret;
1983
1984 interrupted:
1985   {
1986     if (state)
1987       *state = GST_STATE_VOID_PENDING;
1988     if (pending)
1989       *pending = GST_STATE_VOID_PENDING;
1990
1991     GST_CAT_INFO_OBJECT (GST_CAT_STATES, element, "interruped");
1992
1993     GST_OBJECT_UNLOCK (element);
1994
1995     return GST_STATE_CHANGE_FAILURE;
1996   }
1997 }
1998
1999 /**
2000  * gst_element_get_state:
2001  * @element: a #GstElement to get the state of.
2002  * @state: (out) (allow-none): a pointer to #GstState to hold the state.
2003  *     Can be %NULL.
2004  * @pending: (out) (allow-none): a pointer to #GstState to hold the pending
2005  *     state. Can be %NULL.
2006  * @timeout: a #GstClockTime to specify the timeout for an async
2007  *           state change or %GST_CLOCK_TIME_NONE for infinite timeout.
2008  *
2009  * Gets the state of the element.
2010  *
2011  * For elements that performed an ASYNC state change, as reported by
2012  * gst_element_set_state(), this function will block up to the
2013  * specified timeout value for the state change to complete.
2014  * If the element completes the state change or goes into
2015  * an error, this function returns immediately with a return value of
2016  * %GST_STATE_CHANGE_SUCCESS or %GST_STATE_CHANGE_FAILURE respectively.
2017  *
2018  * For elements that did not return %GST_STATE_CHANGE_ASYNC, this function
2019  * returns the current and pending state immediately.
2020  *
2021  * This function returns %GST_STATE_CHANGE_NO_PREROLL if the element
2022  * successfully changed its state but is not able to provide data yet.
2023  * This mostly happens for live sources that only produce data in
2024  * %GST_STATE_PLAYING. While the state change return is equivalent to
2025  * %GST_STATE_CHANGE_SUCCESS, it is returned to the application to signal that
2026  * some sink elements might not be able to complete their state change because
2027  * an element is not producing data to complete the preroll. When setting the
2028  * element to playing, the preroll will complete and playback will start.
2029  *
2030  * Returns: %GST_STATE_CHANGE_SUCCESS if the element has no more pending state
2031  *          and the last state change succeeded, %GST_STATE_CHANGE_ASYNC if the
2032  *          element is still performing a state change or
2033  *          %GST_STATE_CHANGE_FAILURE if the last state change failed.
2034  *
2035  * MT safe.
2036  */
2037 GstStateChangeReturn
2038 gst_element_get_state (GstElement * element,
2039     GstState * state, GstState * pending, GstClockTime timeout)
2040 {
2041   GstElementClass *oclass;
2042   GstStateChangeReturn result = GST_STATE_CHANGE_FAILURE;
2043
2044   g_return_val_if_fail (GST_IS_ELEMENT (element), GST_STATE_CHANGE_FAILURE);
2045
2046   oclass = GST_ELEMENT_GET_CLASS (element);
2047
2048   if (oclass->get_state)
2049     result = (oclass->get_state) (element, state, pending, timeout);
2050
2051   return result;
2052 }
2053
2054 /**
2055  * gst_element_abort_state:
2056  * @element: a #GstElement to abort the state of.
2057  *
2058  * Abort the state change of the element. This function is used
2059  * by elements that do asynchronous state changes and find out
2060  * something is wrong.
2061  *
2062  * This function should be called with the STATE_LOCK held.
2063  *
2064  * MT safe.
2065  */
2066 void
2067 gst_element_abort_state (GstElement * element)
2068 {
2069   GstState pending;
2070
2071 #ifndef GST_DISABLE_GST_DEBUG
2072   GstState old_state;
2073 #endif
2074
2075   g_return_if_fail (GST_IS_ELEMENT (element));
2076
2077   GST_OBJECT_LOCK (element);
2078   pending = GST_STATE_PENDING (element);
2079
2080   if (pending == GST_STATE_VOID_PENDING ||
2081       GST_STATE_RETURN (element) == GST_STATE_CHANGE_FAILURE)
2082     goto nothing_aborted;
2083
2084 #ifndef GST_DISABLE_GST_DEBUG
2085   old_state = GST_STATE (element);
2086
2087   GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2088       "aborting state from %s to %s", gst_element_state_get_name (old_state),
2089       gst_element_state_get_name (pending));
2090 #endif
2091
2092   /* flag error */
2093   GST_STATE_RETURN (element) = GST_STATE_CHANGE_FAILURE;
2094
2095   GST_STATE_BROADCAST (element);
2096   GST_OBJECT_UNLOCK (element);
2097
2098   return;
2099
2100 nothing_aborted:
2101   {
2102     GST_OBJECT_UNLOCK (element);
2103     return;
2104   }
2105 }
2106
2107 /* Not static because GstBin has manual state handling too */
2108 void
2109 _priv_gst_element_state_changed (GstElement * element, GstState oldstate,
2110     GstState newstate, GstState pending)
2111 {
2112   GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
2113   GstMessage *message;
2114
2115   GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2116       "notifying about state-changed %s to %s (%s pending)",
2117       gst_element_state_get_name (oldstate),
2118       gst_element_state_get_name (newstate),
2119       gst_element_state_get_name (pending));
2120
2121   if (klass->state_changed)
2122     klass->state_changed (element, oldstate, newstate, pending);
2123
2124   message = gst_message_new_state_changed (GST_OBJECT_CAST (element),
2125       oldstate, newstate, pending);
2126   gst_element_post_message (element, message);
2127 }
2128
2129 /**
2130  * gst_element_continue_state:
2131  * @element: a #GstElement to continue the state change of.
2132  * @ret: The previous state return value
2133  *
2134  * Commit the state change of the element and proceed to the next
2135  * pending state if any. This function is used
2136  * by elements that do asynchronous state changes.
2137  * The core will normally call this method automatically when an
2138  * element returned %GST_STATE_CHANGE_SUCCESS from the state change function.
2139  *
2140  * If after calling this method the element still has not reached
2141  * the pending state, the next state change is performed.
2142  *
2143  * This method is used internally and should normally not be called by plugins
2144  * or applications.
2145  *
2146  * Returns: The result of the commit state change.
2147  *
2148  * MT safe.
2149  */
2150 GstStateChangeReturn
2151 gst_element_continue_state (GstElement * element, GstStateChangeReturn ret)
2152 {
2153   GstStateChangeReturn old_ret;
2154   GstState old_state, old_next;
2155   GstState current, next, pending;
2156   GstStateChange transition;
2157
2158   GST_OBJECT_LOCK (element);
2159   old_ret = GST_STATE_RETURN (element);
2160   GST_STATE_RETURN (element) = ret;
2161   pending = GST_STATE_PENDING (element);
2162
2163   /* check if there is something to commit */
2164   if (pending == GST_STATE_VOID_PENDING)
2165     goto nothing_pending;
2166
2167   old_state = GST_STATE (element);
2168   /* this is the state we should go to next */
2169   old_next = GST_STATE_NEXT (element);
2170   /* update current state */
2171   current = GST_STATE (element) = old_next;
2172
2173   /* see if we reached the final state */
2174   if (pending == current)
2175     goto complete;
2176
2177   next = GST_STATE_GET_NEXT (current, pending);
2178   transition = (GstStateChange) GST_STATE_TRANSITION (current, next);
2179
2180   GST_STATE_NEXT (element) = next;
2181   /* mark busy */
2182   GST_STATE_RETURN (element) = GST_STATE_CHANGE_ASYNC;
2183   GST_OBJECT_UNLOCK (element);
2184
2185   GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2186       "committing state from %s to %s, pending %s, next %s",
2187       gst_element_state_get_name (old_state),
2188       gst_element_state_get_name (old_next),
2189       gst_element_state_get_name (pending), gst_element_state_get_name (next));
2190
2191   _priv_gst_element_state_changed (element, old_state, old_next, pending);
2192
2193   GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2194       "continue state change %s to %s, final %s",
2195       gst_element_state_get_name (current),
2196       gst_element_state_get_name (next), gst_element_state_get_name (pending));
2197
2198   ret = gst_element_change_state (element, transition);
2199
2200   return ret;
2201
2202 nothing_pending:
2203   {
2204     GST_CAT_INFO_OBJECT (GST_CAT_STATES, element, "nothing pending");
2205     GST_OBJECT_UNLOCK (element);
2206     return ret;
2207   }
2208 complete:
2209   {
2210     GST_STATE_PENDING (element) = GST_STATE_VOID_PENDING;
2211     GST_STATE_NEXT (element) = GST_STATE_VOID_PENDING;
2212
2213     GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2214         "completed state change to %s", gst_element_state_get_name (pending));
2215     GST_OBJECT_UNLOCK (element);
2216
2217     /* don't post silly messages with the same state. This can happen
2218      * when an element state is changed to what it already was. For bins
2219      * this can be the result of a lost state, which we check with the
2220      * previous return value.
2221      * We do signal the cond though as a _get_state() might be blocking
2222      * on it. */
2223     if (old_state != old_next || old_ret == GST_STATE_CHANGE_ASYNC)
2224       _priv_gst_element_state_changed (element, old_state, old_next,
2225           GST_STATE_VOID_PENDING);
2226
2227     GST_STATE_BROADCAST (element);
2228
2229     return ret;
2230   }
2231 }
2232
2233 /**
2234  * gst_element_lost_state:
2235  * @element: a #GstElement the state is lost of
2236  *
2237  * Brings the element to the lost state. The current state of the
2238  * element is copied to the pending state so that any call to
2239  * gst_element_get_state() will return %GST_STATE_CHANGE_ASYNC.
2240  *
2241  * An ASYNC_START message is posted. If the element was PLAYING, it will
2242  * go to PAUSED. The element will be restored to its PLAYING state by
2243  * the parent pipeline when it prerolls again.
2244  *
2245  * This is mostly used for elements that lost their preroll buffer
2246  * in the %GST_STATE_PAUSED or %GST_STATE_PLAYING state after a flush,
2247  * they will go to their pending state again when a new preroll buffer is
2248  * queued. This function can only be called when the element is currently
2249  * not in error or an async state change.
2250  *
2251  * This function is used internally and should normally not be called from
2252  * plugins or applications.
2253  */
2254 void
2255 gst_element_lost_state (GstElement * element)
2256 {
2257   GstState old_state, new_state;
2258   GstMessage *message;
2259
2260   g_return_if_fail (GST_IS_ELEMENT (element));
2261
2262   GST_OBJECT_LOCK (element);
2263   if (GST_STATE_RETURN (element) == GST_STATE_CHANGE_FAILURE)
2264     goto nothing_lost;
2265
2266   if (GST_STATE_PENDING (element) != GST_STATE_VOID_PENDING)
2267     goto only_async_start;
2268
2269   old_state = GST_STATE (element);
2270
2271   /* when we were PLAYING, the new state is PAUSED. We will also not
2272    * automatically go to PLAYING but let the parent bin(s) set us to PLAYING
2273    * when we preroll. */
2274   if (old_state > GST_STATE_PAUSED)
2275     new_state = GST_STATE_PAUSED;
2276   else
2277     new_state = old_state;
2278
2279   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2280       "lost state of %s to %s", gst_element_state_get_name (old_state),
2281       gst_element_state_get_name (new_state));
2282
2283   GST_STATE (element) = new_state;
2284   GST_STATE_NEXT (element) = new_state;
2285   GST_STATE_PENDING (element) = new_state;
2286   GST_STATE_RETURN (element) = GST_STATE_CHANGE_ASYNC;
2287   GST_OBJECT_UNLOCK (element);
2288
2289   _priv_gst_element_state_changed (element, new_state, new_state, new_state);
2290
2291   message = gst_message_new_async_start (GST_OBJECT_CAST (element));
2292   gst_element_post_message (element, message);
2293
2294   return;
2295
2296 nothing_lost:
2297   {
2298     GST_OBJECT_UNLOCK (element);
2299     return;
2300   }
2301 only_async_start:
2302   {
2303     GST_OBJECT_UNLOCK (element);
2304
2305     message = gst_message_new_async_start (GST_OBJECT_CAST (element));
2306     gst_element_post_message (element, message);
2307     return;
2308   }
2309 }
2310
2311 /**
2312  * gst_element_set_state:
2313  * @element: a #GstElement to change state of.
2314  * @state: the element's new #GstState.
2315  *
2316  * Sets the state of the element. This function will try to set the
2317  * requested state by going through all the intermediary states and calling
2318  * the class's state change function for each.
2319  *
2320  * This function can return #GST_STATE_CHANGE_ASYNC, in which case the
2321  * element will perform the remainder of the state change asynchronously in
2322  * another thread.
2323  * An application can use gst_element_get_state() to wait for the completion
2324  * of the state change or it can wait for a state change message on the bus.
2325  *
2326  * State changes to %GST_STATE_READY or %GST_STATE_NULL never return
2327  * #GST_STATE_CHANGE_ASYNC.
2328  *
2329  * Returns: Result of the state change using #GstStateChangeReturn.
2330  *
2331  * MT safe.
2332  */
2333 GstStateChangeReturn
2334 gst_element_set_state (GstElement * element, GstState state)
2335 {
2336   GstElementClass *oclass;
2337   GstStateChangeReturn result = GST_STATE_CHANGE_FAILURE;
2338
2339   g_return_val_if_fail (GST_IS_ELEMENT (element), GST_STATE_CHANGE_FAILURE);
2340
2341   oclass = GST_ELEMENT_GET_CLASS (element);
2342
2343   if (oclass->set_state)
2344     result = (oclass->set_state) (element, state);
2345
2346   return result;
2347 }
2348
2349 /*
2350  * default set state function, calculates the next state based
2351  * on current state and calls the change_state function
2352  */
2353 static GstStateChangeReturn
2354 gst_element_set_state_func (GstElement * element, GstState state)
2355 {
2356   GstState current, next, old_pending;
2357   GstStateChangeReturn ret;
2358   GstStateChange transition;
2359   GstStateChangeReturn old_ret;
2360
2361   g_return_val_if_fail (GST_IS_ELEMENT (element), GST_STATE_CHANGE_FAILURE);
2362
2363   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "set_state to %s",
2364       gst_element_state_get_name (state));
2365
2366   /* state lock is taken to protect the set_state() and get_state()
2367    * procedures, it does not lock any variables. */
2368   GST_STATE_LOCK (element);
2369
2370   /* now calculate how to get to the new state */
2371   GST_OBJECT_LOCK (element);
2372   old_ret = GST_STATE_RETURN (element);
2373   /* previous state change returned an error, remove all pending
2374    * and next states */
2375   if (old_ret == GST_STATE_CHANGE_FAILURE) {
2376     GST_STATE_NEXT (element) = GST_STATE_VOID_PENDING;
2377     GST_STATE_PENDING (element) = GST_STATE_VOID_PENDING;
2378     GST_STATE_RETURN (element) = GST_STATE_CHANGE_SUCCESS;
2379   }
2380
2381   current = GST_STATE (element);
2382   next = GST_STATE_NEXT (element);
2383   old_pending = GST_STATE_PENDING (element);
2384
2385   /* this is the (new) state we should go to. TARGET is the last state we set on
2386    * the element. */
2387   if (state != GST_STATE_TARGET (element)) {
2388     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2389         "setting target state to %s", gst_element_state_get_name (state));
2390     GST_STATE_TARGET (element) = state;
2391     /* increment state cookie so that we can track each state change. We only do
2392      * this if this is actually a new state change. */
2393     element->state_cookie++;
2394   }
2395   GST_STATE_PENDING (element) = state;
2396
2397   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2398       "current %s, old_pending %s, next %s, old return %s",
2399       gst_element_state_get_name (current),
2400       gst_element_state_get_name (old_pending),
2401       gst_element_state_get_name (next),
2402       gst_element_state_change_return_get_name (old_ret));
2403
2404   /* if the element was busy doing a state change, we just update the
2405    * target state, it'll get to it async then. */
2406   if (old_pending != GST_STATE_VOID_PENDING) {
2407     /* upwards state change will happen ASYNC */
2408     if (old_pending <= state)
2409       goto was_busy;
2410     /* element is going to this state already */
2411     else if (next == state)
2412       goto was_busy;
2413     /* element was performing an ASYNC upward state change and
2414      * we request to go downward again. Start from the next pending
2415      * state then. */
2416     else if (next > state
2417         && GST_STATE_RETURN (element) == GST_STATE_CHANGE_ASYNC) {
2418       current = next;
2419     }
2420   }
2421   next = GST_STATE_GET_NEXT (current, state);
2422   /* now we store the next state */
2423   GST_STATE_NEXT (element) = next;
2424   /* mark busy, we need to check that there is actually a state change
2425    * to be done else we could accidentally override SUCCESS/NO_PREROLL and
2426    * the default element change_state function has no way to know what the
2427    * old value was... could consider this a FIXME...*/
2428   if (current != next)
2429     GST_STATE_RETURN (element) = GST_STATE_CHANGE_ASYNC;
2430
2431   transition = (GstStateChange) GST_STATE_TRANSITION (current, next);
2432
2433   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2434       "%s: setting state from %s to %s",
2435       (next != state ? "intermediate" : "final"),
2436       gst_element_state_get_name (current), gst_element_state_get_name (next));
2437
2438   /* now signal any waiters, they will error since the cookie was incremented */
2439   GST_STATE_BROADCAST (element);
2440
2441   GST_OBJECT_UNLOCK (element);
2442
2443   ret = gst_element_change_state (element, transition);
2444
2445   GST_STATE_UNLOCK (element);
2446
2447   GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element, "returned %s",
2448       gst_element_state_change_return_get_name (ret));
2449
2450   return ret;
2451
2452 was_busy:
2453   {
2454     GST_STATE_RETURN (element) = GST_STATE_CHANGE_ASYNC;
2455     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2456         "element was busy with async state change");
2457     GST_OBJECT_UNLOCK (element);
2458
2459     GST_STATE_UNLOCK (element);
2460
2461     return GST_STATE_CHANGE_ASYNC;
2462   }
2463 }
2464
2465 /**
2466  * gst_element_change_state:
2467  * @element: a #GstElement
2468  * @transition: the requested transition
2469  *
2470  * Perform @transition on @element.
2471  *
2472  * This function must be called with STATE_LOCK held and is mainly used
2473  * internally.
2474  *
2475  * Returns: the #GstStateChangeReturn of the state transition.
2476  */
2477 GstStateChangeReturn
2478 gst_element_change_state (GstElement * element, GstStateChange transition)
2479 {
2480   GstElementClass *oclass;
2481   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
2482
2483   oclass = GST_ELEMENT_GET_CLASS (element);
2484
2485   /* call the state change function so it can set the state */
2486   if (oclass->change_state)
2487     ret = (oclass->change_state) (element, transition);
2488   else
2489     ret = GST_STATE_CHANGE_FAILURE;
2490
2491   switch (ret) {
2492     case GST_STATE_CHANGE_FAILURE:
2493       GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2494           "have FAILURE change_state return");
2495       /* state change failure */
2496       gst_element_abort_state (element);
2497       break;
2498     case GST_STATE_CHANGE_ASYNC:
2499     {
2500       GstState target;
2501
2502       GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2503           "element will change state ASYNC");
2504
2505       target = GST_STATE_TARGET (element);
2506
2507       if (target > GST_STATE_READY)
2508         goto async;
2509
2510       /* else we just continue the state change downwards */
2511       GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
2512           "forcing commit state %s <= %s",
2513           gst_element_state_get_name (target),
2514           gst_element_state_get_name (GST_STATE_READY));
2515
2516       ret = gst_element_continue_state (element, GST_STATE_CHANGE_SUCCESS);
2517       break;
2518     }
2519     case GST_STATE_CHANGE_SUCCESS:
2520       GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2521           "element changed state SUCCESS");
2522       /* we can commit the state now which will proceeed to
2523        * the next state */
2524       ret = gst_element_continue_state (element, ret);
2525       break;
2526     case GST_STATE_CHANGE_NO_PREROLL:
2527       GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2528           "element changed state NO_PREROLL");
2529       /* we can commit the state now which will proceeed to
2530        * the next state */
2531       ret = gst_element_continue_state (element, ret);
2532       break;
2533     default:
2534       goto invalid_return;
2535   }
2536
2537   GST_CAT_LOG_OBJECT (GST_CAT_STATES, element, "exit state change %d", ret);
2538
2539   return ret;
2540
2541 async:
2542   GST_CAT_LOG_OBJECT (GST_CAT_STATES, element, "exit async state change %d",
2543       ret);
2544
2545   return ret;
2546
2547   /* ERROR */
2548 invalid_return:
2549   {
2550     GST_OBJECT_LOCK (element);
2551     /* somebody added a GST_STATE_ and forgot to do stuff here ! */
2552     g_critical ("%s: unknown return value %d from a state change function",
2553         GST_ELEMENT_NAME (element), ret);
2554
2555     /* we are in error now */
2556     ret = GST_STATE_CHANGE_FAILURE;
2557     GST_STATE_RETURN (element) = ret;
2558     GST_OBJECT_UNLOCK (element);
2559
2560     return ret;
2561   }
2562 }
2563
2564 /* gst_iterator_fold functions for pads_activate
2565  * Stop the iterator if activating one pad failed. */
2566 static gboolean
2567 activate_pads (const GValue * vpad, GValue * ret, gboolean * active)
2568 {
2569   GstPad *pad = g_value_get_object (vpad);
2570   gboolean cont = TRUE;
2571
2572   if (!(cont = gst_pad_set_active (pad, *active)))
2573     g_value_set_boolean (ret, FALSE);
2574
2575   return cont;
2576 }
2577
2578 /* returns false on error or early cutout of the fold, true if all
2579  * pads in @iter were (de)activated successfully. */
2580 static gboolean
2581 iterator_activate_fold_with_resync (GstIterator * iter,
2582     GstIteratorFoldFunction func, gpointer user_data)
2583 {
2584   GstIteratorResult ires;
2585   GValue ret = { 0 };
2586
2587   /* no need to unset this later, it's just a boolean */
2588   g_value_init (&ret, G_TYPE_BOOLEAN);
2589   g_value_set_boolean (&ret, TRUE);
2590
2591   while (1) {
2592     ires = gst_iterator_fold (iter, func, &ret, user_data);
2593     switch (ires) {
2594       case GST_ITERATOR_RESYNC:
2595         /* need to reset the result again */
2596         g_value_set_boolean (&ret, TRUE);
2597         gst_iterator_resync (iter);
2598         break;
2599       case GST_ITERATOR_DONE:
2600         /* all pads iterated, return collected value */
2601         goto done;
2602       default:
2603         /* iterator returned _ERROR or premature end with _OK,
2604          * mark an error and exit */
2605         g_value_set_boolean (&ret, FALSE);
2606         goto done;
2607     }
2608   }
2609 done:
2610   /* return collected value */
2611   return g_value_get_boolean (&ret);
2612 }
2613
2614 /* is called with STATE_LOCK
2615  *
2616  * Pads are activated from source pads to sinkpads.
2617  */
2618 static gboolean
2619 gst_element_pads_activate (GstElement * element, gboolean active)
2620 {
2621   GstIterator *iter;
2622   gboolean res;
2623
2624   GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
2625       "pads_activate with active %d", active);
2626
2627   iter = gst_element_iterate_src_pads (element);
2628   res =
2629       iterator_activate_fold_with_resync (iter,
2630       (GstIteratorFoldFunction) activate_pads, &active);
2631   gst_iterator_free (iter);
2632   if (G_UNLIKELY (!res))
2633     goto src_failed;
2634
2635   iter = gst_element_iterate_sink_pads (element);
2636   res =
2637       iterator_activate_fold_with_resync (iter,
2638       (GstIteratorFoldFunction) activate_pads, &active);
2639   gst_iterator_free (iter);
2640   if (G_UNLIKELY (!res))
2641     goto sink_failed;
2642
2643   GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
2644       "pads_activate successful");
2645
2646   return TRUE;
2647
2648   /* ERRORS */
2649 src_failed:
2650   {
2651     GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
2652         "source pads_activate failed");
2653     return FALSE;
2654   }
2655 sink_failed:
2656   {
2657     GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
2658         "sink pads_activate failed");
2659     return FALSE;
2660   }
2661 }
2662
2663 /* is called with STATE_LOCK */
2664 static GstStateChangeReturn
2665 gst_element_change_state_func (GstElement * element, GstStateChange transition)
2666 {
2667   GstState state, next;
2668   GstStateChangeReturn result = GST_STATE_CHANGE_SUCCESS;
2669
2670   g_return_val_if_fail (GST_IS_ELEMENT (element), GST_STATE_CHANGE_FAILURE);
2671
2672   state = (GstState) GST_STATE_TRANSITION_CURRENT (transition);
2673   next = GST_STATE_TRANSITION_NEXT (transition);
2674
2675   /* if the element already is in the given state, we just return success */
2676   if (next == GST_STATE_VOID_PENDING || state == next)
2677     goto was_ok;
2678
2679   GST_CAT_LOG_OBJECT (GST_CAT_STATES, element,
2680       "default handler tries setting state from %s to %s (%04x)",
2681       gst_element_state_get_name (state),
2682       gst_element_state_get_name (next), transition);
2683
2684   switch (transition) {
2685     case GST_STATE_CHANGE_NULL_TO_READY:
2686       break;
2687     case GST_STATE_CHANGE_READY_TO_PAUSED:
2688       if (!gst_element_pads_activate (element, TRUE)) {
2689         result = GST_STATE_CHANGE_FAILURE;
2690       }
2691       break;
2692     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
2693       break;
2694     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
2695       break;
2696     case GST_STATE_CHANGE_PAUSED_TO_READY:
2697     case GST_STATE_CHANGE_READY_TO_NULL:
2698       /* deactivate pads in both cases, since they are activated on
2699          ready->paused but the element might not have made it to paused */
2700       if (!gst_element_pads_activate (element, FALSE)) {
2701         result = GST_STATE_CHANGE_FAILURE;
2702       }
2703       break;
2704     default:
2705       /* this will catch real but unhandled state changes;
2706        * can only be caused by:
2707        * - a new state was added
2708        * - somehow the element was asked to jump across an intermediate state
2709        */
2710       g_warning ("Unhandled state change from %s to %s",
2711           gst_element_state_get_name (state),
2712           gst_element_state_get_name (next));
2713       break;
2714   }
2715   return result;
2716
2717 was_ok:
2718   {
2719     GST_OBJECT_LOCK (element);
2720     result = GST_STATE_RETURN (element);
2721     GST_CAT_DEBUG_OBJECT (GST_CAT_STATES, element,
2722         "element is already in the %s state",
2723         gst_element_state_get_name (state));
2724     GST_OBJECT_UNLOCK (element);
2725
2726     return result;
2727   }
2728 }
2729
2730 /**
2731  * gst_element_get_factory:
2732  * @element: a #GstElement to request the element factory of.
2733  *
2734  * Retrieves the factory that was used to create this element.
2735  *
2736  * Returns: (transfer none): the #GstElementFactory used for creating this
2737  *     element. no refcounting is needed.
2738  */
2739 GstElementFactory *
2740 gst_element_get_factory (GstElement * element)
2741 {
2742   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
2743
2744   return GST_ELEMENT_GET_CLASS (element)->elementfactory;
2745 }
2746
2747 static void
2748 gst_element_dispose (GObject * object)
2749 {
2750   GstElement *element = GST_ELEMENT_CAST (object);
2751   GstClock **clock_p;
2752   GstBus **bus_p;
2753   GstElementClass *oclass;
2754
2755   oclass = GST_ELEMENT_GET_CLASS (element);
2756
2757   GST_CAT_INFO_OBJECT (GST_CAT_REFCOUNTING, element, "dispose");
2758
2759   if (GST_STATE (element) != GST_STATE_NULL)
2760     goto not_null;
2761
2762   GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
2763       "removing %d pads", g_list_length (element->pads));
2764   /* first we break all our links with the outside */
2765   while (element->pads && element->pads->data) {
2766     GstPad *pad = GST_PAD_CAST (element->pads->data);
2767
2768     /* don't call _remove_pad with NULL */
2769     if (oclass->release_pad && GST_PAD_PAD_TEMPLATE (pad) &&
2770         GST_PAD_TEMPLATE_PRESENCE (GST_PAD_PAD_TEMPLATE (pad))
2771         == GST_PAD_REQUEST)
2772       (oclass->release_pad) (element, GST_PAD_CAST (element->pads->data));
2773     else
2774       gst_element_remove_pad (element, GST_PAD_CAST (element->pads->data));
2775   }
2776   if (G_UNLIKELY (element->pads != NULL)) {
2777     g_critical ("could not remove pads from element %s",
2778         GST_STR_NULL (GST_OBJECT_NAME (object)));
2779   }
2780
2781   GST_OBJECT_LOCK (element);
2782   clock_p = &element->clock;
2783   bus_p = &element->bus;
2784   gst_object_replace ((GstObject **) clock_p, NULL);
2785   gst_object_replace ((GstObject **) bus_p, NULL);
2786   GST_OBJECT_UNLOCK (element);
2787
2788   GST_CAT_INFO_OBJECT (GST_CAT_REFCOUNTING, element, "parent class dispose");
2789
2790   G_OBJECT_CLASS (parent_class)->dispose (object);
2791
2792   return;
2793
2794   /* ERRORS */
2795 not_null:
2796   {
2797     gboolean is_locked;
2798
2799     is_locked = GST_ELEMENT_IS_LOCKED_STATE (element);
2800     g_critical
2801         ("\nTrying to dispose element %s, but it is in %s%s instead of the NULL"
2802         " state.\n"
2803         "You need to explicitly set elements to the NULL state before\n"
2804         "dropping the final reference, to allow them to clean up.\n"
2805         "This problem may also be caused by a refcounting bug in the\n"
2806         "application or some element.\n",
2807         GST_OBJECT_NAME (element),
2808         gst_element_state_get_name (GST_STATE (element)),
2809         is_locked ? " (locked)" : "");
2810     return;
2811   }
2812 }
2813
2814 static void
2815 gst_element_finalize (GObject * object)
2816 {
2817   GstElement *element = GST_ELEMENT_CAST (object);
2818
2819   GST_CAT_INFO_OBJECT (GST_CAT_REFCOUNTING, element, "finalize");
2820
2821   g_cond_clear (&element->state_cond);
2822   g_rec_mutex_clear (&element->state_lock);
2823
2824   GST_CAT_INFO_OBJECT (GST_CAT_REFCOUNTING, element, "finalize parent");
2825
2826   G_OBJECT_CLASS (parent_class)->finalize (object);
2827 }
2828
2829 static void
2830 gst_element_set_bus_func (GstElement * element, GstBus * bus)
2831 {
2832   GstBus **bus_p;
2833
2834   g_return_if_fail (GST_IS_ELEMENT (element));
2835
2836   GST_CAT_DEBUG_OBJECT (GST_CAT_PARENTAGE, element, "setting bus to %p", bus);
2837
2838   GST_OBJECT_LOCK (element);
2839   bus_p = &GST_ELEMENT_BUS (element);
2840   gst_object_replace ((GstObject **) bus_p, GST_OBJECT_CAST (bus));
2841   GST_OBJECT_UNLOCK (element);
2842 }
2843
2844 /**
2845  * gst_element_set_bus:
2846  * @element: a #GstElement to set the bus of.
2847  * @bus: (transfer none): the #GstBus to set.
2848  *
2849  * Sets the bus of the element. Increases the refcount on the bus.
2850  * For internal use only, unless you're testing elements.
2851  *
2852  * MT safe.
2853  */
2854 void
2855 gst_element_set_bus (GstElement * element, GstBus * bus)
2856 {
2857   GstElementClass *oclass;
2858
2859   g_return_if_fail (GST_IS_ELEMENT (element));
2860
2861   oclass = GST_ELEMENT_GET_CLASS (element);
2862
2863   if (oclass->set_bus)
2864     oclass->set_bus (element, bus);
2865 }
2866
2867 /**
2868  * gst_element_get_bus:
2869  * @element: a #GstElement to get the bus of.
2870  *
2871  * Returns the bus of the element. Note that only a #GstPipeline will provide a
2872  * bus for the application.
2873  *
2874  * Returns: (transfer full): the element's #GstBus. unref after usage.
2875  *
2876  * MT safe.
2877  */
2878 GstBus *
2879 gst_element_get_bus (GstElement * element)
2880 {
2881   GstBus *result = NULL;
2882
2883   g_return_val_if_fail (GST_IS_ELEMENT (element), result);
2884
2885   GST_OBJECT_LOCK (element);
2886   if ((result = GST_ELEMENT_BUS (element)))
2887     gst_object_ref (result);
2888   GST_OBJECT_UNLOCK (element);
2889
2890   GST_CAT_DEBUG_OBJECT (GST_CAT_BUS, element, "got bus %" GST_PTR_FORMAT,
2891       result);
2892
2893   return result;
2894 }