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