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