abe3a2d3de07b4fbde9860cc1784a99046303b68
[platform/upstream/gstreamer.git] / gst / gstpad.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstpad.c: Pads for linking elements together
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22 /**
23  * SECTION:gstpad
24  * @short_description: Object contained by elements that allows links to
25  *                     other elements
26  * @see_also: #GstPadTemplate, #GstElement, #GstEvent
27  *
28  * A #GstElement is linked to other elements via "pads", which are extremely
29  * light-weight generic link points.
30  * After two pads are retrieved from an element with gst_element_get_pad(),
31  * the pads can be link with gst_pad_link(). (For quick links,
32  * you can also use gst_element_link(), which will make the obvious
33  * link for you if it's straightforward.)
34  *
35  * Pads are typically created from a #GstPadTemplate with
36  * gst_pad_new_from_template().
37  *
38  * Pads have #GstCaps attached to it to describe the media type they are
39  * capable of dealing with.  gst_pad_get_caps() and gst_pad_set_caps() are
40  * used to manipulate the caps of the pads.
41  * Pads created from a pad template cannot set capabilities that are
42  * incompatible with the pad template capabilities.
43  *
44  * Pads without pad templates can be created with gst_pad_new(),
45  * which takes a direction and a name as an argument.  If the name is NULL,
46  * then a guaranteed unique name will be assigned to it.
47  *
48  * gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
49  *
50  * A #GstElement creating a pad will typically use the various
51  * gst_pad_set_*_function() calls to register callbacks for various events
52  * on the pads.
53  *
54  * GstElements will use gst_pad_push() and gst_pad_pull_range() to push out
55  * or pull in a buffer.
56  *
57  * To send a #GstEvent on a pad, use gst_pad_send_event() and
58  * gst_pad_push_event().
59  *
60  * Last reviewed on 2006-07-06 (0.10.9)
61  */
62
63 #include "gst_private.h"
64
65 #include "gstpad.h"
66 #include "gstpadtemplate.h"
67 #include "gstenumtypes.h"
68 #include "gstmarshal.h"
69 #include "gstutils.h"
70 #include "gstinfo.h"
71 #include "gsterror.h"
72 #include "gstvalue.h"
73 #include "glib-compat-private.h"
74
75 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
76 #define GST_CAT_DEFAULT GST_CAT_PADS
77
78 /* Pad signals and args */
79 enum
80 {
81   PAD_LINKED,
82   PAD_UNLINKED,
83   PAD_REQUEST_LINK,
84   PAD_HAVE_DATA,
85   /* FILL ME */
86   LAST_SIGNAL
87 };
88
89 enum
90 {
91   PAD_PROP_0,
92   PAD_PROP_CAPS,
93   PAD_PROP_DIRECTION,
94   PAD_PROP_TEMPLATE,
95   /* FILL ME */
96 };
97
98 #define GST_PAD_GET_PRIVATE(obj)  \
99    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PAD, GstPadPrivate))
100
101 #define GST_PAD_CHAINLISTFUNC(pad) ((pad)->abidata.ABI.priv->chainlistfunc)
102
103 struct _GstPadPrivate
104 {
105   GstPadChainListFunction chainlistfunc;
106 };
107
108 static void gst_pad_dispose (GObject * object);
109 static void gst_pad_finalize (GObject * object);
110 static void gst_pad_set_property (GObject * object, guint prop_id,
111     const GValue * value, GParamSpec * pspec);
112 static void gst_pad_get_property (GObject * object, guint prop_id,
113     GValue * value, GParamSpec * pspec);
114
115 static GstFlowReturn handle_pad_block (GstPad * pad);
116 static GstCaps *gst_pad_get_caps_unlocked (GstPad * pad);
117 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
118 static gboolean gst_pad_activate_default (GstPad * pad);
119 static gboolean gst_pad_acceptcaps_default (GstPad * pad, GstCaps * caps);
120
121 #ifndef GST_DISABLE_LOADSAVE
122 static xmlNodePtr gst_pad_save_thyself (GstObject * object, xmlNodePtr parent);
123 #endif
124
125 /* Some deprecated stuff that we need inside here for
126  * backwards compatibility */
127 #ifdef GST_DISABLE_DEPRECATED
128 #ifndef GST_REMOVE_DEPRECATED
129 #define GST_PAD_INTLINKFUNC(pad)        (GST_PAD_CAST(pad)->intlinkfunc)
130 GList *gst_pad_get_internal_links_default (GstPad * pad);
131 #endif
132 #endif
133
134 static GstObjectClass *parent_class = NULL;
135 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
136
137 /* quarks for probe signals */
138 static GQuark buffer_quark;
139 static GQuark event_quark;
140
141 typedef struct
142 {
143   const gint ret;
144   const gchar *name;
145   GQuark quark;
146 } GstFlowQuarks;
147
148 static GstFlowQuarks flow_quarks[] = {
149   {GST_FLOW_CUSTOM_SUCCESS, "custom-success", 0},
150   {GST_FLOW_RESEND, "resend", 0},
151   {GST_FLOW_OK, "ok", 0},
152   {GST_FLOW_NOT_LINKED, "not-linked", 0},
153   {GST_FLOW_WRONG_STATE, "wrong-state", 0},
154   {GST_FLOW_UNEXPECTED, "unexpected", 0},
155   {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
156   {GST_FLOW_ERROR, "error", 0},
157   {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
158   {GST_FLOW_CUSTOM_ERROR, "custom-error", 0}
159 };
160
161 /**
162  * gst_flow_get_name:
163  * @ret: a #GstFlowReturn to get the name of.
164  *
165  * Gets a string representing the given flow return.
166  *
167  * Returns: a static string with the name of the flow return.
168  */
169 G_CONST_RETURN gchar *
170 gst_flow_get_name (GstFlowReturn ret)
171 {
172   gint i;
173
174   ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
175
176   for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
177     if (ret == flow_quarks[i].ret)
178       return flow_quarks[i].name;
179   }
180   return "unknown";
181 }
182
183 /**
184  * gst_flow_to_quark:
185  * @ret: a #GstFlowReturn to get the quark of.
186  *
187  * Get the unique quark for the given GstFlowReturn.
188  *
189  * Returns: the quark associated with the flow return or 0 if an
190  * invalid return was specified.
191  */
192 GQuark
193 gst_flow_to_quark (GstFlowReturn ret)
194 {
195   gint i;
196
197   ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
198
199   for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
200     if (ret == flow_quarks[i].ret)
201       return flow_quarks[i].quark;
202   }
203   return 0;
204 }
205
206 #define _do_init \
207 { \
208   gint i; \
209   \
210   buffer_quark = g_quark_from_static_string ("buffer"); \
211   event_quark = g_quark_from_static_string ("event"); \
212   \
213   for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {                    \
214     flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name); \
215   } \
216   \
217   GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW", \
218       GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads"); \
219 }
220
221 G_DEFINE_TYPE_WITH_CODE (GstPad, gst_pad, GST_TYPE_OBJECT, _do_init);
222
223 static gboolean
224 _gst_do_pass_data_accumulator (GSignalInvocationHint * ihint,
225     GValue * return_accu, const GValue * handler_return, gpointer dummy)
226 {
227   gboolean ret = g_value_get_boolean (handler_return);
228
229   GST_DEBUG ("accumulated %d", ret);
230   g_value_set_boolean (return_accu, ret);
231
232   return ret;
233 }
234
235 static gboolean
236 default_have_data (GstPad * pad, GstMiniObject * o)
237 {
238   return TRUE;
239 }
240
241 static void
242 gst_pad_class_init (GstPadClass * klass)
243 {
244   GObjectClass *gobject_class;
245   GstObjectClass *gstobject_class;
246
247   gobject_class = G_OBJECT_CLASS (klass);
248   gstobject_class = GST_OBJECT_CLASS (klass);
249
250   g_type_class_add_private (klass, sizeof (GstPadPrivate));
251
252   parent_class = g_type_class_peek_parent (klass);
253
254   gobject_class->dispose = gst_pad_dispose;
255   gobject_class->finalize = gst_pad_finalize;
256   gobject_class->set_property = gst_pad_set_property;
257   gobject_class->get_property = gst_pad_get_property;
258
259   /**
260    * GstPad::linked:
261    * @pad: the pad that emitted the signal
262    * @peer: the peer pad that has been connected
263    *
264    * Signals that a pad has been linked to the peer pad.
265    */
266   gst_pad_signals[PAD_LINKED] =
267       g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
268       G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
269       gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
270   /**
271    * GstPad::unlinked:
272    * @pad: the pad that emitted the signal
273    * @peer: the peer pad that has been disconnected
274    *
275    * Signals that a pad has been unlinked from the peer pad.
276    */
277   gst_pad_signals[PAD_UNLINKED] =
278       g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
279       G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
280       gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
281   /**
282    * GstPad::request-link:
283    * @pad: the pad that emitted the signal
284    * @peer: the peer pad for which a connection is requested
285    *
286    * Signals that a pad connection has been requested.
287    */
288   gst_pad_signals[PAD_REQUEST_LINK] =
289       g_signal_new ("request-link", G_TYPE_FROM_CLASS (klass),
290       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstPadClass, request_link), NULL,
291       NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 0);
292
293   /**
294    * GstPad::have-data:
295    * @pad: the pad that emitted the signal
296    * @mini_obj: new data
297    *
298    * Signals that new data is available on the pad. This signal is used
299    * internally for implementing pad probes.
300    * See gst_pad_add_*_probe functions.
301    *
302    * Returns: %TRUE to keep the data, %FALSE to drop it
303    */
304   gst_pad_signals[PAD_HAVE_DATA] =
305       g_signal_new ("have-data", G_TYPE_FROM_CLASS (klass),
306       G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
307       G_STRUCT_OFFSET (GstPadClass, have_data),
308       _gst_do_pass_data_accumulator,
309       NULL, gst_marshal_BOOLEAN__POINTER, G_TYPE_BOOLEAN, 1,
310       GST_TYPE_MINI_OBJECT);
311
312   g_object_class_install_property (gobject_class, PAD_PROP_CAPS,
313       g_param_spec_boxed ("caps", "Caps", "The capabilities of the pad",
314           GST_TYPE_CAPS, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
315   g_object_class_install_property (gobject_class, PAD_PROP_DIRECTION,
316       g_param_spec_enum ("direction", "Direction", "The direction of the pad",
317           GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
318           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
319   /* FIXME, Make G_PARAM_CONSTRUCT_ONLY when we fix ghostpads. */
320   g_object_class_install_property (gobject_class, PAD_PROP_TEMPLATE,
321       g_param_spec_object ("template", "Template",
322           "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
323           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
324
325 #ifndef GST_DISABLE_LOADSAVE
326   gstobject_class->save_thyself = GST_DEBUG_FUNCPTR (gst_pad_save_thyself);
327 #endif
328   gstobject_class->path_string_separator = ".";
329
330   /* Register common function pointer descriptions */
331   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_activate_default);
332   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_event_default);
333   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_get_query_types_default);
334   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_query_default);
335 #ifndef GST_REMOVE_DEPRECATED
336   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_get_internal_links_default);
337 #endif
338   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_iterate_internal_links_default);
339   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_acceptcaps_default);
340
341   klass->have_data = default_have_data;
342 }
343
344 static void
345 gst_pad_init (GstPad * pad)
346 {
347   pad->abidata.ABI.priv = GST_PAD_GET_PRIVATE (pad);
348
349   GST_PAD_DIRECTION (pad) = GST_PAD_UNKNOWN;
350   GST_PAD_PEER (pad) = NULL;
351
352   GST_PAD_CHAINFUNC (pad) = NULL;
353
354   GST_PAD_LINKFUNC (pad) = NULL;
355
356   GST_PAD_CAPS (pad) = NULL;
357   GST_PAD_GETCAPSFUNC (pad) = NULL;
358
359   GST_PAD_ACTIVATEFUNC (pad) = gst_pad_activate_default;
360   GST_PAD_EVENTFUNC (pad) = gst_pad_event_default;
361   GST_PAD_QUERYTYPEFUNC (pad) = gst_pad_get_query_types_default;
362   GST_PAD_QUERYFUNC (pad) = gst_pad_query_default;
363 #ifndef GST_REMOVE_DEPRECATED
364   GST_PAD_INTLINKFUNC (pad) = gst_pad_get_internal_links_default;
365 #endif
366   GST_PAD_ITERINTLINKFUNC (pad) = gst_pad_iterate_internal_links_default;
367
368   GST_PAD_ACCEPTCAPSFUNC (pad) = gst_pad_acceptcaps_default;
369
370   pad->do_buffer_signals = 0;
371   pad->do_event_signals = 0;
372
373   GST_PAD_SET_FLUSHING (pad);
374
375   pad->preroll_lock = g_mutex_new ();
376   pad->preroll_cond = g_cond_new ();
377
378   /* FIXME 0.11: Store this directly in the instance struct */
379   pad->stream_rec_lock = g_slice_new (GStaticRecMutex);
380   g_static_rec_mutex_init (pad->stream_rec_lock);
381
382   pad->block_cond = g_cond_new ();
383 }
384
385 static void
386 gst_pad_dispose (GObject * object)
387 {
388   GstPad *pad = GST_PAD_CAST (object);
389   GstPad *peer;
390
391   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pad, "dispose");
392
393   /* unlink the peer pad */
394   if ((peer = gst_pad_get_peer (pad))) {
395     /* window for MT unsafeness, someone else could unlink here
396      * and then we call unlink with wrong pads. The unlink
397      * function would catch this and safely return failed. */
398     if (GST_PAD_IS_SRC (pad))
399       gst_pad_unlink (pad, peer);
400     else
401       gst_pad_unlink (peer, pad);
402
403     gst_object_unref (peer);
404   }
405
406   /* clear the caps */
407   gst_caps_replace (&GST_PAD_CAPS (pad), NULL);
408
409   gst_pad_set_pad_template (pad, NULL);
410
411   if (pad->block_destroy_data && pad->block_data) {
412     pad->block_destroy_data (pad->block_data);
413     pad->block_data = NULL;
414   }
415
416   G_OBJECT_CLASS (parent_class)->dispose (object);
417 }
418
419 static void
420 gst_pad_finalize (GObject * object)
421 {
422   GstPad *pad = GST_PAD_CAST (object);
423   GstTask *task;
424
425   /* in case the task is still around, clean it up */
426   if ((task = GST_PAD_TASK (pad))) {
427     gst_task_join (task);
428     GST_PAD_TASK (pad) = NULL;
429     gst_object_unref (task);
430   }
431
432   if (pad->stream_rec_lock) {
433     g_static_rec_mutex_free (pad->stream_rec_lock);
434     g_slice_free (GStaticRecMutex, pad->stream_rec_lock);
435     pad->stream_rec_lock = NULL;
436   }
437   if (pad->preroll_lock) {
438     g_mutex_free (pad->preroll_lock);
439     g_cond_free (pad->preroll_cond);
440     pad->preroll_lock = NULL;
441     pad->preroll_cond = NULL;
442   }
443   if (pad->block_cond) {
444     g_cond_free (pad->block_cond);
445     pad->block_cond = NULL;
446   }
447
448   G_OBJECT_CLASS (parent_class)->finalize (object);
449 }
450
451 static void
452 gst_pad_set_property (GObject * object, guint prop_id,
453     const GValue * value, GParamSpec * pspec)
454 {
455   g_return_if_fail (GST_IS_PAD (object));
456
457   switch (prop_id) {
458     case PAD_PROP_DIRECTION:
459       GST_PAD_DIRECTION (object) = g_value_get_enum (value);
460       break;
461     case PAD_PROP_TEMPLATE:
462       gst_pad_set_pad_template (GST_PAD_CAST (object),
463           (GstPadTemplate *) g_value_get_object (value));
464       break;
465     default:
466       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
467       break;
468   }
469 }
470
471 static void
472 gst_pad_get_property (GObject * object, guint prop_id,
473     GValue * value, GParamSpec * pspec)
474 {
475   g_return_if_fail (GST_IS_PAD (object));
476
477   switch (prop_id) {
478     case PAD_PROP_CAPS:
479       GST_OBJECT_LOCK (object);
480       g_value_set_boxed (value, GST_PAD_CAPS (object));
481       GST_OBJECT_UNLOCK (object);
482       break;
483     case PAD_PROP_DIRECTION:
484       g_value_set_enum (value, GST_PAD_DIRECTION (object));
485       break;
486     case PAD_PROP_TEMPLATE:
487       g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
488       break;
489     default:
490       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
491       break;
492   }
493 }
494
495 /**
496  * gst_pad_new:
497  * @name: the name of the new pad.
498  * @direction: the #GstPadDirection of the pad.
499  *
500  * Creates a new pad with the given name in the given direction.
501  * If name is NULL, a guaranteed unique name (across all pads)
502  * will be assigned.
503  * This function makes a copy of the name so you can safely free the name.
504  *
505  * Returns: a new #GstPad, or NULL in case of an error.
506  *
507  * MT safe.
508  */
509 GstPad *
510 gst_pad_new (const gchar * name, GstPadDirection direction)
511 {
512   return g_object_new (GST_TYPE_PAD,
513       "name", name, "direction", direction, NULL);
514 }
515
516 /**
517  * gst_pad_new_from_template:
518  * @templ: the pad template to use
519  * @name: the name of the element
520  *
521  * Creates a new pad with the given name from the given template.
522  * If name is NULL, a guaranteed unique name (across all pads)
523  * will be assigned.
524  * This function makes a copy of the name so you can safely free the name.
525  *
526  * Returns: a new #GstPad, or NULL in case of an error.
527  */
528 GstPad *
529 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
530 {
531   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
532
533   return g_object_new (GST_TYPE_PAD,
534       "name", name, "direction", templ->direction, "template", templ, NULL);
535 }
536
537 /**
538  * gst_pad_new_from_static_template:
539  * @templ: the #GstStaticPadTemplate to use
540  * @name: the name of the element
541  *
542  * Creates a new pad with the given name from the given static template.
543  * If name is NULL, a guaranteed unique name (across all pads)
544  * will be assigned.
545  * This function makes a copy of the name so you can safely free the name.
546  *
547  * Returns: a new #GstPad, or NULL in case of an error.
548  */
549 GstPad *
550 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
551     const gchar * name)
552 {
553   GstPad *pad;
554   GstPadTemplate *template;
555
556   template = gst_static_pad_template_get (templ);
557   pad = gst_pad_new_from_template (template, name);
558   gst_object_unref (template);
559   return pad;
560 }
561
562 /**
563  * gst_pad_get_direction:
564  * @pad: a #GstPad to get the direction of.
565  *
566  * Gets the direction of the pad. The direction of the pad is
567  * decided at construction time so this function does not take
568  * the LOCK.
569  *
570  * Returns: the #GstPadDirection of the pad.
571  *
572  * MT safe.
573  */
574 GstPadDirection
575 gst_pad_get_direction (GstPad * pad)
576 {
577   GstPadDirection result;
578
579   /* PAD_UNKNOWN is a little silly but we need some sort of
580    * error return value */
581   g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
582
583   result = GST_PAD_DIRECTION (pad);
584
585   return result;
586 }
587
588 static gboolean
589 gst_pad_activate_default (GstPad * pad)
590 {
591   return gst_pad_activate_push (pad, TRUE);
592 }
593
594 static void
595 pre_activate (GstPad * pad, GstActivateMode new_mode)
596 {
597   switch (new_mode) {
598     case GST_ACTIVATE_PUSH:
599     case GST_ACTIVATE_PULL:
600       GST_OBJECT_LOCK (pad);
601       GST_DEBUG_OBJECT (pad, "setting ACTIVATE_MODE %d, unset flushing",
602           new_mode);
603       GST_PAD_UNSET_FLUSHING (pad);
604       GST_PAD_ACTIVATE_MODE (pad) = new_mode;
605       GST_OBJECT_UNLOCK (pad);
606       break;
607     case GST_ACTIVATE_NONE:
608       GST_OBJECT_LOCK (pad);
609       GST_DEBUG_OBJECT (pad, "setting ACTIVATE_MODE NONE, set flushing");
610       GST_PAD_SET_FLUSHING (pad);
611       GST_PAD_ACTIVATE_MODE (pad) = new_mode;
612       /* unlock blocked pads so element can resume and stop */
613       GST_PAD_BLOCK_BROADCAST (pad);
614       GST_OBJECT_UNLOCK (pad);
615       break;
616   }
617 }
618
619 static void
620 post_activate (GstPad * pad, GstActivateMode new_mode)
621 {
622   switch (new_mode) {
623     case GST_ACTIVATE_PUSH:
624     case GST_ACTIVATE_PULL:
625       /* nop */
626       break;
627     case GST_ACTIVATE_NONE:
628       /* ensures that streaming stops */
629       GST_PAD_STREAM_LOCK (pad);
630       GST_DEBUG_OBJECT (pad, "stopped streaming");
631       GST_PAD_STREAM_UNLOCK (pad);
632       break;
633   }
634 }
635
636 /**
637  * gst_pad_set_active:
638  * @pad: the #GstPad to activate or deactivate.
639  * @active: whether or not the pad should be active.
640  *
641  * Activates or deactivates the given pad.
642  * Normally called from within core state change functions.
643  *
644  * If @active, makes sure the pad is active. If it is already active, either in
645  * push or pull mode, just return. Otherwise dispatches to the pad's activate
646  * function to perform the actual activation.
647  *
648  * If not @active, checks the pad's current mode and calls
649  * gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a
650  * FALSE argument.
651  *
652  * Returns: #TRUE if the operation was successful.
653  *
654  * MT safe.
655  */
656 gboolean
657 gst_pad_set_active (GstPad * pad, gboolean active)
658 {
659   GstActivateMode old;
660   gboolean ret = FALSE;
661
662   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
663
664   GST_OBJECT_LOCK (pad);
665   old = GST_PAD_ACTIVATE_MODE (pad);
666   GST_OBJECT_UNLOCK (pad);
667
668   if (active) {
669     switch (old) {
670       case GST_ACTIVATE_PUSH:
671         GST_DEBUG_OBJECT (pad, "activating pad from push");
672         ret = TRUE;
673         break;
674       case GST_ACTIVATE_PULL:
675         GST_DEBUG_OBJECT (pad, "activating pad from pull");
676         ret = TRUE;
677         break;
678       case GST_ACTIVATE_NONE:
679         GST_DEBUG_OBJECT (pad, "activating pad from none");
680         ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad);
681         break;
682     }
683   } else {
684     switch (old) {
685       case GST_ACTIVATE_PUSH:
686         GST_DEBUG_OBJECT (pad, "deactivating pad from push");
687         ret = gst_pad_activate_push (pad, FALSE);
688         break;
689       case GST_ACTIVATE_PULL:
690         GST_DEBUG_OBJECT (pad, "deactivating pad from pull");
691         ret = gst_pad_activate_pull (pad, FALSE);
692         break;
693       case GST_ACTIVATE_NONE:
694         GST_DEBUG_OBJECT (pad, "deactivating pad from none");
695         ret = TRUE;
696         break;
697     }
698   }
699
700   if (!ret) {
701     GST_OBJECT_LOCK (pad);
702     if (!active) {
703       g_critical ("Failed to deactivate pad %s:%s, very bad",
704           GST_DEBUG_PAD_NAME (pad));
705     } else {
706       GST_WARNING_OBJECT (pad, "Failed to activate pad");
707     }
708     GST_OBJECT_UNLOCK (pad);
709   }
710
711   return ret;
712 }
713
714 /**
715  * gst_pad_activate_pull:
716  * @pad: the #GstPad to activate or deactivate.
717  * @active: whether or not the pad should be active.
718  *
719  * Activates or deactivates the given pad in pull mode via dispatching to the
720  * pad's activatepullfunc. For use from within pad activation functions only.
721  * When called on sink pads, will first proxy the call to the peer pad, which
722  * is expected to activate its internally linked pads from within its
723  * activate_pull function.
724  *
725  * If you don't know what this is, you probably don't want to call it.
726  *
727  * Returns: TRUE if the operation was successful.
728  *
729  * MT safe.
730  */
731 gboolean
732 gst_pad_activate_pull (GstPad * pad, gboolean active)
733 {
734   GstActivateMode old, new;
735   GstPad *peer;
736
737   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
738
739   GST_OBJECT_LOCK (pad);
740   old = GST_PAD_ACTIVATE_MODE (pad);
741   GST_OBJECT_UNLOCK (pad);
742
743   if (active) {
744     switch (old) {
745       case GST_ACTIVATE_PULL:
746         GST_DEBUG_OBJECT (pad, "activating pad from pull, was ok");
747         goto was_ok;
748       case GST_ACTIVATE_PUSH:
749         GST_DEBUG_OBJECT (pad,
750             "activating pad from push, deactivate push first");
751         /* pad was activate in the wrong direction, deactivate it
752          * and reactivate it in pull mode */
753         if (G_UNLIKELY (!gst_pad_activate_push (pad, FALSE)))
754           goto deactivate_failed;
755         /* fallthrough, pad is deactivated now. */
756       case GST_ACTIVATE_NONE:
757         GST_DEBUG_OBJECT (pad, "activating pad from none");
758         break;
759     }
760   } else {
761     switch (old) {
762       case GST_ACTIVATE_NONE:
763         GST_DEBUG_OBJECT (pad, "deactivating pad from none, was ok");
764         goto was_ok;
765       case GST_ACTIVATE_PUSH:
766         GST_DEBUG_OBJECT (pad, "deactivating pad from push, weird");
767         /* pad was activated in the other direction, deactivate it
768          * in push mode, this should not happen... */
769         if (G_UNLIKELY (!gst_pad_activate_push (pad, FALSE)))
770           goto deactivate_failed;
771         /* everything is fine now */
772         goto was_ok;
773       case GST_ACTIVATE_PULL:
774         GST_DEBUG_OBJECT (pad, "deactivating pad from pull");
775         break;
776     }
777   }
778
779   if (gst_pad_get_direction (pad) == GST_PAD_SINK) {
780     if ((peer = gst_pad_get_peer (pad))) {
781       GST_DEBUG_OBJECT (pad, "calling peer");
782       if (G_UNLIKELY (!gst_pad_activate_pull (peer, active)))
783         goto peer_failed;
784       gst_object_unref (peer);
785     } else {
786       /* there is no peer, this is only fatal when we activate. When we
787        * deactivate, we must assume the application has unlinked the peer and
788        * will deactivate it eventually. */
789       if (active)
790         goto not_linked;
791       else
792         GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
793     }
794   } else {
795     if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
796       goto failure;             /* Can't activate pull on a src without a
797                                    getrange function */
798   }
799
800   new = active ? GST_ACTIVATE_PULL : GST_ACTIVATE_NONE;
801   pre_activate (pad, new);
802
803   if (GST_PAD_ACTIVATEPULLFUNC (pad)) {
804     if (G_UNLIKELY (!GST_PAD_ACTIVATEPULLFUNC (pad) (pad, active)))
805       goto failure;
806   } else {
807     /* can happen for sinks of passthrough elements */
808   }
809
810   post_activate (pad, new);
811
812   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in pull mode",
813       active ? "activated" : "deactivated");
814
815   return TRUE;
816
817 was_ok:
818   {
819     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in pull mode",
820         active ? "activated" : "deactivated");
821     return TRUE;
822   }
823 deactivate_failed:
824   {
825     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
826         "failed to %s in switch to pull from mode %d",
827         (active ? "activate" : "deactivate"), old);
828     return FALSE;
829   }
830 peer_failed:
831   {
832     GST_OBJECT_LOCK (peer);
833     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
834         "activate_pull on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
835     GST_OBJECT_UNLOCK (peer);
836     gst_object_unref (peer);
837     return FALSE;
838   }
839 not_linked:
840   {
841     GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
842         "pad in pull mode");
843     return FALSE;
844   }
845 failure:
846   {
847     GST_OBJECT_LOCK (pad);
848     GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in pull mode",
849         active ? "activate" : "deactivate");
850     GST_PAD_SET_FLUSHING (pad);
851     GST_PAD_ACTIVATE_MODE (pad) = old;
852     GST_OBJECT_UNLOCK (pad);
853     return FALSE;
854   }
855 }
856
857 /**
858  * gst_pad_activate_push:
859  * @pad: the #GstPad to activate or deactivate.
860  * @active: whether the pad should be active or not.
861  *
862  * Activates or deactivates the given pad in push mode via dispatching to the
863  * pad's activatepushfunc. For use from within pad activation functions only.
864  *
865  * If you don't know what this is, you probably don't want to call it.
866  *
867  * Returns: %TRUE if the operation was successful.
868  *
869  * MT safe.
870  */
871 gboolean
872 gst_pad_activate_push (GstPad * pad, gboolean active)
873 {
874   GstActivateMode old, new;
875
876   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
877   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "trying to set %s in push mode",
878       active ? "activated" : "deactivated");
879
880   GST_OBJECT_LOCK (pad);
881   old = GST_PAD_ACTIVATE_MODE (pad);
882   GST_OBJECT_UNLOCK (pad);
883
884   if (active) {
885     switch (old) {
886       case GST_ACTIVATE_PUSH:
887         GST_DEBUG_OBJECT (pad, "activating pad from push, was ok");
888         goto was_ok;
889       case GST_ACTIVATE_PULL:
890         GST_DEBUG_OBJECT (pad,
891             "activating pad from push, deactivating pull first");
892         /* pad was activate in the wrong direction, deactivate it
893          * an reactivate it in push mode */
894         if (G_UNLIKELY (!gst_pad_activate_pull (pad, FALSE)))
895           goto deactivate_failed;
896         /* fallthrough, pad is deactivated now. */
897       case GST_ACTIVATE_NONE:
898         GST_DEBUG_OBJECT (pad, "activating pad from none");
899         break;
900     }
901   } else {
902     switch (old) {
903       case GST_ACTIVATE_NONE:
904         GST_DEBUG_OBJECT (pad, "deactivating pad from none, was ok");
905         goto was_ok;
906       case GST_ACTIVATE_PULL:
907         GST_DEBUG_OBJECT (pad, "deactivating pad from pull, weird");
908         /* pad was activated in the other direction, deactivate it
909          * in pull mode, this should not happen... */
910         if (G_UNLIKELY (!gst_pad_activate_pull (pad, FALSE)))
911           goto deactivate_failed;
912         /* everything is fine now */
913         goto was_ok;
914       case GST_ACTIVATE_PUSH:
915         GST_DEBUG_OBJECT (pad, "deactivating pad from push");
916         break;
917     }
918   }
919
920   new = active ? GST_ACTIVATE_PUSH : GST_ACTIVATE_NONE;
921   pre_activate (pad, new);
922
923   if (GST_PAD_ACTIVATEPUSHFUNC (pad)) {
924     if (G_UNLIKELY (!GST_PAD_ACTIVATEPUSHFUNC (pad) (pad, active))) {
925       goto failure;
926     }
927   } else {
928     /* quite ok, element relies on state change func to prepare itself */
929   }
930
931   post_activate (pad, new);
932
933   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in push mode",
934       active ? "activated" : "deactivated");
935   return TRUE;
936
937 was_ok:
938   {
939     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in push mode",
940         active ? "activated" : "deactivated");
941     return TRUE;
942   }
943 deactivate_failed:
944   {
945     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
946         "failed to %s in switch to push from mode %d",
947         (active ? "activate" : "deactivate"), old);
948     return FALSE;
949   }
950 failure:
951   {
952     GST_OBJECT_LOCK (pad);
953     GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in push mode",
954         active ? "activate" : "deactivate");
955     GST_PAD_SET_FLUSHING (pad);
956     GST_PAD_ACTIVATE_MODE (pad) = old;
957     GST_OBJECT_UNLOCK (pad);
958     return FALSE;
959   }
960 }
961
962 /**
963  * gst_pad_is_active:
964  * @pad: the #GstPad to query
965  *
966  * Query if a pad is active
967  *
968  * Returns: TRUE if the pad is active.
969  *
970  * MT safe.
971  */
972 gboolean
973 gst_pad_is_active (GstPad * pad)
974 {
975   gboolean result = FALSE;
976
977   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
978
979   GST_OBJECT_LOCK (pad);
980   result = GST_PAD_MODE_ACTIVATE (GST_PAD_ACTIVATE_MODE (pad));
981   GST_OBJECT_UNLOCK (pad);
982
983   return result;
984 }
985
986 /**
987  * gst_pad_set_blocked_async_full:
988  * @pad: the #GstPad to block or unblock
989  * @blocked: boolean indicating whether the pad should be blocked or unblocked
990  * @callback: #GstPadBlockCallback that will be called when the
991  *            operation succeeds
992  * @user_data: user data passed to the callback
993  * @destroy_data: #GDestroyNotify for user_data
994  *
995  * Blocks or unblocks the dataflow on a pad. The provided callback
996  * is called when the operation succeeds; this happens right before the next
997  * attempt at pushing a buffer on the pad.
998  *
999  * This can take a while as the pad can only become blocked when real dataflow
1000  * is happening.
1001  * When the pipeline is stalled, for example in PAUSED, this can
1002  * take an indeterminate amount of time.
1003  * You can pass NULL as the callback to make this call block. Be careful with
1004  * this blocking call as it might not return for reasons stated above.
1005  *
1006  * Returns: TRUE if the pad could be blocked. This function can fail if the
1007  * wrong parameters were passed or the pad was already in the requested state.
1008  *
1009  * MT safe.
1010  *
1011  * Since: 0.10.23
1012  */
1013 gboolean
1014 gst_pad_set_blocked_async_full (GstPad * pad, gboolean blocked,
1015     GstPadBlockCallback callback, gpointer user_data,
1016     GDestroyNotify destroy_data)
1017 {
1018   gboolean was_blocked = FALSE;
1019
1020   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1021
1022   GST_OBJECT_LOCK (pad);
1023
1024   was_blocked = GST_PAD_IS_BLOCKED (pad);
1025
1026   if (G_UNLIKELY (was_blocked == blocked))
1027     goto had_right_state;
1028
1029   if (blocked) {
1030     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "blocking pad");
1031
1032     GST_OBJECT_FLAG_SET (pad, GST_PAD_BLOCKED);
1033
1034     if (pad->block_destroy_data && pad->block_data)
1035       pad->block_destroy_data (pad->block_data);
1036
1037     pad->block_callback = callback;
1038     pad->block_data = user_data;
1039     pad->block_destroy_data = destroy_data;
1040     pad->abidata.ABI.block_callback_called = FALSE;
1041     if (!callback) {
1042       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "waiting for block");
1043       GST_PAD_BLOCK_WAIT (pad);
1044       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "blocked");
1045     }
1046   } else {
1047     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "unblocking pad");
1048
1049     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_BLOCKED);
1050
1051     if (pad->block_destroy_data && pad->block_data)
1052       pad->block_destroy_data (pad->block_data);
1053
1054     pad->block_callback = callback;
1055     pad->block_data = user_data;
1056     pad->block_destroy_data = destroy_data;
1057     pad->abidata.ABI.block_callback_called = FALSE;
1058
1059     GST_PAD_BLOCK_BROADCAST (pad);
1060     if (!callback) {
1061       /* no callback, wait for the unblock to happen */
1062       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "waiting for unblock");
1063       GST_PAD_BLOCK_WAIT (pad);
1064       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "unblocked");
1065     }
1066   }
1067   GST_OBJECT_UNLOCK (pad);
1068
1069   return TRUE;
1070
1071 had_right_state:
1072   {
1073     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1074         "pad was in right state (%d)", was_blocked);
1075     GST_OBJECT_UNLOCK (pad);
1076
1077     return FALSE;
1078   }
1079 }
1080
1081 /**
1082  * gst_pad_set_blocked_async:
1083  * @pad: the #GstPad to block or unblock
1084  * @blocked: boolean indicating whether the pad should be blocked or unblocked
1085  * @callback: #GstPadBlockCallback that will be called when the
1086  *            operation succeeds
1087  * @user_data: user data passed to the callback
1088  *
1089  * Blocks or unblocks the dataflow on a pad. The provided callback
1090  * is called when the operation succeeds; this happens right before the next
1091  * attempt at pushing a buffer on the pad.
1092  *
1093  * This can take a while as the pad can only become blocked when real dataflow
1094  * is happening.
1095  * When the pipeline is stalled, for example in PAUSED, this can
1096  * take an indeterminate amount of time.
1097  * You can pass NULL as the callback to make this call block. Be careful with
1098  * this blocking call as it might not return for reasons stated above.
1099  *
1100  * Returns: TRUE if the pad could be blocked. This function can fail if the
1101  * wrong parameters were passed or the pad was already in the requested state.
1102  *
1103  * MT safe.
1104  */
1105 gboolean
1106 gst_pad_set_blocked_async (GstPad * pad, gboolean blocked,
1107     GstPadBlockCallback callback, gpointer user_data)
1108 {
1109   return gst_pad_set_blocked_async_full (pad, blocked,
1110       callback, user_data, NULL);
1111 }
1112
1113 /**
1114  * gst_pad_set_blocked:
1115  * @pad: the #GstPad to block or unblock
1116  * @blocked: boolean indicating we should block or unblock
1117  *
1118  * Blocks or unblocks the dataflow on a pad. This function is
1119  * a shortcut for gst_pad_set_blocked_async() with a NULL
1120  * callback.
1121  *
1122  * Returns: TRUE if the pad could be blocked. This function can fail if the
1123  * wrong parameters were passed or the pad was already in the requested state.
1124  *
1125  * MT safe.
1126  */
1127 gboolean
1128 gst_pad_set_blocked (GstPad * pad, gboolean blocked)
1129 {
1130   return gst_pad_set_blocked_async (pad, blocked, NULL, NULL);
1131 }
1132
1133 /**
1134  * gst_pad_is_blocked:
1135  * @pad: the #GstPad to query
1136  *
1137  * Checks if the pad is blocked or not. This function returns the
1138  * last requested state of the pad. It is not certain that the pad
1139  * is actually blocking at this point (see gst_pad_is_blocking()).
1140  *
1141  * Returns: TRUE if the pad is blocked.
1142  *
1143  * MT safe.
1144  */
1145 gboolean
1146 gst_pad_is_blocked (GstPad * pad)
1147 {
1148   gboolean result = FALSE;
1149
1150   g_return_val_if_fail (GST_IS_PAD (pad), result);
1151
1152   GST_OBJECT_LOCK (pad);
1153   result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKED);
1154   GST_OBJECT_UNLOCK (pad);
1155
1156   return result;
1157 }
1158
1159 /**
1160  * gst_pad_is_blocking:
1161  * @pad: the #GstPad to query
1162  *
1163  * Checks if the pad is blocking or not. This is a guaranteed state
1164  * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1165  *
1166  * Returns: TRUE if the pad is blocking.
1167  *
1168  * MT safe.
1169  *
1170  * Since: 0.10.11
1171  */
1172 gboolean
1173 gst_pad_is_blocking (GstPad * pad)
1174 {
1175   gboolean result = FALSE;
1176
1177   g_return_val_if_fail (GST_IS_PAD (pad), result);
1178
1179   GST_OBJECT_LOCK (pad);
1180   /* the blocking flag is only valid if the pad is not flushing */
1181   result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKING) &&
1182       !GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLUSHING);
1183   GST_OBJECT_UNLOCK (pad);
1184
1185   return result;
1186 }
1187
1188 /**
1189  * gst_pad_set_activate_function:
1190  * @pad: a #GstPad.
1191  * @activate: the #GstPadActivateFunction to set.
1192  *
1193  * Sets the given activate function for @pad. The activate function will
1194  * dispatch to gst_pad_activate_push() or gst_pad_activate_pull() to perform
1195  * the actual activation. Only makes sense to set on sink pads.
1196  *
1197  * Call this function if your sink pad can start a pull-based task.
1198  */
1199 void
1200 gst_pad_set_activate_function (GstPad * pad, GstPadActivateFunction activate)
1201 {
1202   g_return_if_fail (GST_IS_PAD (pad));
1203
1204   GST_PAD_ACTIVATEFUNC (pad) = activate;
1205   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1206       GST_DEBUG_FUNCPTR_NAME (activate));
1207 }
1208
1209 /**
1210  * gst_pad_set_activatepull_function:
1211  * @pad: a #GstPad.
1212  * @activatepull: the #GstPadActivateModeFunction to set.
1213  *
1214  * Sets the given activate_pull function for the pad. An activate_pull function
1215  * prepares the element and any upstream connections for pulling. See XXX
1216  * part-activation.txt for details.
1217  */
1218 void
1219 gst_pad_set_activatepull_function (GstPad * pad,
1220     GstPadActivateModeFunction activatepull)
1221 {
1222   g_return_if_fail (GST_IS_PAD (pad));
1223
1224   GST_PAD_ACTIVATEPULLFUNC (pad) = activatepull;
1225   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatepullfunc set to %s",
1226       GST_DEBUG_FUNCPTR_NAME (activatepull));
1227 }
1228
1229 /**
1230  * gst_pad_set_activatepush_function:
1231  * @pad: a #GstPad.
1232  * @activatepush: the #GstPadActivateModeFunction to set.
1233  *
1234  * Sets the given activate_push function for the pad. An activate_push function
1235  * prepares the element for pushing. See XXX part-activation.txt for details.
1236  */
1237 void
1238 gst_pad_set_activatepush_function (GstPad * pad,
1239     GstPadActivateModeFunction activatepush)
1240 {
1241   g_return_if_fail (GST_IS_PAD (pad));
1242
1243   GST_PAD_ACTIVATEPUSHFUNC (pad) = activatepush;
1244   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatepushfunc set to %s",
1245       GST_DEBUG_FUNCPTR_NAME (activatepush));
1246 }
1247
1248 /**
1249  * gst_pad_set_chain_function:
1250  * @pad: a sink #GstPad.
1251  * @chain: the #GstPadChainFunction to set.
1252  *
1253  * Sets the given chain function for the pad. The chain function is called to
1254  * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1255  */
1256 void
1257 gst_pad_set_chain_function (GstPad * pad, GstPadChainFunction chain)
1258 {
1259   g_return_if_fail (GST_IS_PAD (pad));
1260   g_return_if_fail (GST_PAD_IS_SINK (pad));
1261
1262   GST_PAD_CHAINFUNC (pad) = chain;
1263   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1264       GST_DEBUG_FUNCPTR_NAME (chain));
1265 }
1266
1267 /**
1268  * gst_pad_set_chain_list_function:
1269  * @pad: a sink #GstPad.
1270  * @chainlist: the #GstPadChainListFunction to set.
1271  *
1272  * Sets the given chain list function for the pad. The chainlist function is
1273  * called to process a #GstBufferList input buffer list. See
1274  * #GstPadChainListFunction for more details.
1275  *
1276  * Since: 0.10.24
1277  */
1278 void
1279 gst_pad_set_chain_list_function (GstPad * pad,
1280     GstPadChainListFunction chainlist)
1281 {
1282   g_return_if_fail (GST_IS_PAD (pad));
1283   g_return_if_fail (GST_PAD_IS_SINK (pad));
1284
1285   GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1286   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1287       GST_DEBUG_FUNCPTR_NAME (chainlist));
1288 }
1289
1290 /**
1291  * gst_pad_set_getrange_function:
1292  * @pad: a source #GstPad.
1293  * @get: the #GstPadGetRangeFunction to set.
1294  *
1295  * Sets the given getrange function for the pad. The getrange function is
1296  * called to produce a new #GstBuffer to start the processing pipeline. see
1297  * #GstPadGetRangeFunction for a description of the getrange function.
1298  */
1299 void
1300 gst_pad_set_getrange_function (GstPad * pad, GstPadGetRangeFunction get)
1301 {
1302   g_return_if_fail (GST_IS_PAD (pad));
1303   g_return_if_fail (GST_PAD_IS_SRC (pad));
1304
1305   GST_PAD_GETRANGEFUNC (pad) = get;
1306
1307   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1308       GST_DEBUG_FUNCPTR_NAME (get));
1309 }
1310
1311 /**
1312  * gst_pad_set_checkgetrange_function:
1313  * @pad: a source #GstPad.
1314  * @check: the #GstPadCheckGetRangeFunction to set.
1315  *
1316  * Sets the given checkgetrange function for the pad. Implement this function
1317  * on a pad if you dynamically support getrange based scheduling on the pad.
1318  */
1319 void
1320 gst_pad_set_checkgetrange_function (GstPad * pad,
1321     GstPadCheckGetRangeFunction check)
1322 {
1323   g_return_if_fail (GST_IS_PAD (pad));
1324   g_return_if_fail (GST_PAD_IS_SRC (pad));
1325
1326   GST_PAD_CHECKGETRANGEFUNC (pad) = check;
1327
1328   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "checkgetrangefunc set to %s",
1329       GST_DEBUG_FUNCPTR_NAME (check));
1330 }
1331
1332 /**
1333  * gst_pad_set_event_function:
1334  * @pad: a #GstPad of either direction.
1335  * @event: the #GstPadEventFunction to set.
1336  *
1337  * Sets the given event handler for the pad.
1338  */
1339 void
1340 gst_pad_set_event_function (GstPad * pad, GstPadEventFunction event)
1341 {
1342   g_return_if_fail (GST_IS_PAD (pad));
1343
1344   GST_PAD_EVENTFUNC (pad) = event;
1345
1346   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1347       GST_DEBUG_FUNCPTR_NAME (event));
1348 }
1349
1350 /**
1351  * gst_pad_set_query_function:
1352  * @pad: a #GstPad of either direction.
1353  * @query: the #GstPadQueryFunction to set.
1354  *
1355  * Set the given query function for the pad.
1356  */
1357 void
1358 gst_pad_set_query_function (GstPad * pad, GstPadQueryFunction query)
1359 {
1360   g_return_if_fail (GST_IS_PAD (pad));
1361
1362   GST_PAD_QUERYFUNC (pad) = query;
1363
1364   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1365       GST_DEBUG_FUNCPTR_NAME (query));
1366 }
1367
1368 /**
1369  * gst_pad_set_query_type_function:
1370  * @pad: a #GstPad of either direction.
1371  * @type_func: the #GstPadQueryTypeFunction to set.
1372  *
1373  * Set the given query type function for the pad.
1374  */
1375 void
1376 gst_pad_set_query_type_function (GstPad * pad,
1377     GstPadQueryTypeFunction type_func)
1378 {
1379   g_return_if_fail (GST_IS_PAD (pad));
1380
1381   GST_PAD_QUERYTYPEFUNC (pad) = type_func;
1382
1383   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "querytypefunc set to %s",
1384       GST_DEBUG_FUNCPTR_NAME (type_func));
1385 }
1386
1387 /**
1388  * gst_pad_get_query_types:
1389  * @pad: a #GstPad.
1390  *
1391  * Get an array of supported queries that can be performed
1392  * on this pad.
1393  *
1394  * Returns: a zero-terminated array of #GstQueryType.
1395  */
1396 const GstQueryType *
1397 gst_pad_get_query_types (GstPad * pad)
1398 {
1399   GstPadQueryTypeFunction func;
1400
1401   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1402
1403   if (G_UNLIKELY ((func = GST_PAD_QUERYTYPEFUNC (pad)) == NULL))
1404     goto no_func;
1405
1406   return func (pad);
1407
1408 no_func:
1409   {
1410     return NULL;
1411   }
1412 }
1413
1414 static gboolean
1415 gst_pad_get_query_types_dispatcher (GstPad * pad, const GstQueryType ** data)
1416 {
1417   *data = gst_pad_get_query_types (pad);
1418
1419   return TRUE;
1420 }
1421
1422 /**
1423  * gst_pad_get_query_types_default:
1424  * @pad: a #GstPad.
1425  *
1426  * Invoke the default dispatcher for the query types on
1427  * the pad.
1428  *
1429  * Returns: an zero-terminated array of #GstQueryType, or NULL if none of the
1430  * internally-linked pads has a query types function.
1431  */
1432 const GstQueryType *
1433 gst_pad_get_query_types_default (GstPad * pad)
1434 {
1435   GstQueryType *result = NULL;
1436
1437   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1438
1439   gst_pad_dispatcher (pad, (GstPadDispatcherFunction)
1440       gst_pad_get_query_types_dispatcher, &result);
1441
1442   return result;
1443 }
1444
1445 /**
1446  * gst_pad_set_iterate_internal_links_function:
1447  * @pad: a #GstPad of either direction.
1448  * @iterintlink: the #GstPadIterIntLinkFunction to set.
1449  *
1450  * Sets the given internal link iterator function for the pad.
1451  *
1452  * Since: 0.10.21
1453  */
1454 void
1455 gst_pad_set_iterate_internal_links_function (GstPad * pad,
1456     GstPadIterIntLinkFunction iterintlink)
1457 {
1458   g_return_if_fail (GST_IS_PAD (pad));
1459
1460   GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1461   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1462       GST_DEBUG_FUNCPTR_NAME (iterintlink));
1463 }
1464
1465 /**
1466  * gst_pad_set_internal_link_function:
1467  * @pad: a #GstPad of either direction.
1468  * @intlink: the #GstPadIntLinkFunction to set.
1469  *
1470  * Sets the given internal link function for the pad.
1471  *
1472  * Deprecated: Use the thread-safe gst_pad_set_iterate_internal_links_function()
1473  */
1474 #ifndef GST_REMOVE_DEPRECATED
1475 #ifdef GST_DISABLE_DEPRECATED
1476 void
1477 gst_pad_set_internal_link_function (GstPad * pad,
1478     GstPadIntLinkFunction intlink);
1479 #endif
1480 void
1481 gst_pad_set_internal_link_function (GstPad * pad, GstPadIntLinkFunction intlink)
1482 {
1483   g_return_if_fail (GST_IS_PAD (pad));
1484
1485   GST_PAD_INTLINKFUNC (pad) = intlink;
1486   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link set to %s",
1487       GST_DEBUG_FUNCPTR_NAME (intlink));
1488 }
1489 #endif /* GST_REMOVE_DEPRECATED */
1490
1491 /**
1492  * gst_pad_set_link_function:
1493  * @pad: a #GstPad.
1494  * @link: the #GstPadLinkFunction to set.
1495  *
1496  * Sets the given link function for the pad. It will be called when
1497  * the pad is linked with another pad.
1498  *
1499  * The return value #GST_PAD_LINK_OK should be used when the connection can be
1500  * made.
1501  *
1502  * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1503  * cannot be made for some reason.
1504  *
1505  * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1506  * of the peer sink pad, if present.
1507  */
1508 void
1509 gst_pad_set_link_function (GstPad * pad, GstPadLinkFunction link)
1510 {
1511   g_return_if_fail (GST_IS_PAD (pad));
1512
1513   GST_PAD_LINKFUNC (pad) = link;
1514   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1515       GST_DEBUG_FUNCPTR_NAME (link));
1516 }
1517
1518 /**
1519  * gst_pad_set_unlink_function:
1520  * @pad: a #GstPad.
1521  * @unlink: the #GstPadUnlinkFunction to set.
1522  *
1523  * Sets the given unlink function for the pad. It will be called
1524  * when the pad is unlinked.
1525  */
1526 void
1527 gst_pad_set_unlink_function (GstPad * pad, GstPadUnlinkFunction unlink)
1528 {
1529   g_return_if_fail (GST_IS_PAD (pad));
1530
1531   GST_PAD_UNLINKFUNC (pad) = unlink;
1532   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1533       GST_DEBUG_FUNCPTR_NAME (unlink));
1534 }
1535
1536 /**
1537  * gst_pad_set_getcaps_function:
1538  * @pad: a #GstPad.
1539  * @getcaps: the #GstPadGetCapsFunction to set.
1540  *
1541  * Sets the given getcaps function for the pad. @getcaps should return the
1542  * allowable caps for a pad in the context of the element's state, its link to
1543  * other elements, and the devices or files it has opened. These caps must be a
1544  * subset of the pad template caps. In the NULL state with no links, @getcaps
1545  * should ideally return the same caps as the pad template. In rare
1546  * circumstances, an object property can affect the caps returned by @getcaps,
1547  * but this is discouraged.
1548  *
1549  * You do not need to call this function if @pad's allowed caps are always the
1550  * same as the pad template caps. This can only be true if the padtemplate
1551  * has fixed simple caps.
1552  *
1553  * For most filters, the caps returned by @getcaps is directly affected by the
1554  * allowed caps on other pads. For demuxers and decoders, the caps returned by
1555  * the srcpad's getcaps function is directly related to the stream data. Again,
1556  * @getcaps should return the most specific caps it reasonably can, since this
1557  * helps with autoplugging.
1558  *
1559  * Note that the return value from @getcaps is owned by the caller, so the
1560  * caller should unref the caps after usage.
1561  */
1562 void
1563 gst_pad_set_getcaps_function (GstPad * pad, GstPadGetCapsFunction getcaps)
1564 {
1565   g_return_if_fail (GST_IS_PAD (pad));
1566
1567   GST_PAD_GETCAPSFUNC (pad) = getcaps;
1568   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getcapsfunc set to %s",
1569       GST_DEBUG_FUNCPTR_NAME (getcaps));
1570 }
1571
1572 /**
1573  * gst_pad_set_acceptcaps_function:
1574  * @pad: a #GstPad.
1575  * @acceptcaps: the #GstPadAcceptCapsFunction to set.
1576  *
1577  * Sets the given acceptcaps function for the pad.  The acceptcaps function
1578  * will be called to check if the pad can accept the given caps. Setting the
1579  * acceptcaps function to NULL restores the default behaviour of allowing
1580  * any caps that matches the caps from gst_pad_get_caps.
1581  */
1582 void
1583 gst_pad_set_acceptcaps_function (GstPad * pad,
1584     GstPadAcceptCapsFunction acceptcaps)
1585 {
1586   g_return_if_fail (GST_IS_PAD (pad));
1587
1588   GST_PAD_ACCEPTCAPSFUNC (pad) = acceptcaps;
1589   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "acceptcapsfunc set to %s",
1590       GST_DEBUG_FUNCPTR_NAME (acceptcaps));
1591 }
1592
1593 /**
1594  * gst_pad_set_fixatecaps_function:
1595  * @pad: a #GstPad.
1596  * @fixatecaps: the #GstPadFixateCapsFunction to set.
1597  *
1598  * Sets the given fixatecaps function for the pad.  The fixatecaps function
1599  * will be called whenever the default values for a GstCaps needs to be
1600  * filled in.
1601  */
1602 void
1603 gst_pad_set_fixatecaps_function (GstPad * pad,
1604     GstPadFixateCapsFunction fixatecaps)
1605 {
1606   g_return_if_fail (GST_IS_PAD (pad));
1607
1608   GST_PAD_FIXATECAPSFUNC (pad) = fixatecaps;
1609   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "fixatecapsfunc set to %s",
1610       GST_DEBUG_FUNCPTR_NAME (fixatecaps));
1611 }
1612
1613 /**
1614  * gst_pad_set_setcaps_function:
1615  * @pad: a #GstPad.
1616  * @setcaps: the #GstPadSetCapsFunction to set.
1617  *
1618  * Sets the given setcaps function for the pad.  The setcaps function
1619  * will be called whenever a buffer with a new media type is pushed or
1620  * pulled from the pad. The pad/element needs to update its internal
1621  * structures to process the new media type. If this new type is not
1622  * acceptable, the setcaps function should return FALSE.
1623  */
1624 void
1625 gst_pad_set_setcaps_function (GstPad * pad, GstPadSetCapsFunction setcaps)
1626 {
1627   g_return_if_fail (GST_IS_PAD (pad));
1628
1629   GST_PAD_SETCAPSFUNC (pad) = setcaps;
1630   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "setcapsfunc set to %s",
1631       GST_DEBUG_FUNCPTR_NAME (setcaps));
1632 }
1633
1634 /**
1635  * gst_pad_set_bufferalloc_function:
1636  * @pad: a sink #GstPad.
1637  * @bufalloc: the #GstPadBufferAllocFunction to set.
1638  *
1639  * Sets the given bufferalloc function for the pad. Note that the
1640  * bufferalloc function can only be set on sinkpads.
1641  */
1642 void
1643 gst_pad_set_bufferalloc_function (GstPad * pad,
1644     GstPadBufferAllocFunction bufalloc)
1645 {
1646   g_return_if_fail (GST_IS_PAD (pad));
1647   g_return_if_fail (GST_PAD_IS_SINK (pad));
1648
1649   GST_PAD_BUFFERALLOCFUNC (pad) = bufalloc;
1650   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "bufferallocfunc set to %s",
1651       GST_DEBUG_FUNCPTR_NAME (bufalloc));
1652 }
1653
1654 /**
1655  * gst_pad_unlink:
1656  * @srcpad: the source #GstPad to unlink.
1657  * @sinkpad: the sink #GstPad to unlink.
1658  *
1659  * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1660  * signal on both pads.
1661  *
1662  * Returns: TRUE if the pads were unlinked. This function returns FALSE if
1663  * the pads were not linked together.
1664  *
1665  * MT safe.
1666  */
1667 gboolean
1668 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1669 {
1670   gboolean result = FALSE;
1671   GstElement *parent = NULL;
1672
1673   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1674   g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1675   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1676   g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1677
1678   GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1679       GST_DEBUG_PAD_NAME (srcpad), srcpad,
1680       GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1681
1682   /* We need to notify the parent before taking any pad locks as the bin in
1683    * question might be waiting for a lock on the pad while holding its lock
1684    * that our message will try to take. */
1685   if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
1686     if (GST_IS_ELEMENT (parent)) {
1687       gst_element_post_message (parent,
1688           gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1689               GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
1690     } else {
1691       gst_object_unref (parent);
1692       parent = NULL;
1693     }
1694   }
1695
1696   GST_OBJECT_LOCK (srcpad);
1697
1698   GST_OBJECT_LOCK (sinkpad);
1699
1700   if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1701     goto not_linked_together;
1702
1703   if (GST_PAD_UNLINKFUNC (srcpad)) {
1704     GST_PAD_UNLINKFUNC (srcpad) (srcpad);
1705   }
1706   if (GST_PAD_UNLINKFUNC (sinkpad)) {
1707     GST_PAD_UNLINKFUNC (sinkpad) (sinkpad);
1708   }
1709
1710   /* first clear peers */
1711   GST_PAD_PEER (srcpad) = NULL;
1712   GST_PAD_PEER (sinkpad) = NULL;
1713
1714   GST_OBJECT_UNLOCK (sinkpad);
1715   GST_OBJECT_UNLOCK (srcpad);
1716
1717   /* fire off a signal to each of the pads telling them
1718    * that they've been unlinked */
1719   g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1720   g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1721
1722   GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1723       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1724
1725   result = TRUE;
1726
1727 done:
1728   if (parent != NULL) {
1729     gst_element_post_message (parent,
1730         gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1731             GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
1732     gst_object_unref (parent);
1733   }
1734   return result;
1735
1736   /* ERRORS */
1737 not_linked_together:
1738   {
1739     /* we do not emit a warning in this case because unlinking cannot
1740      * be made MT safe.*/
1741     GST_OBJECT_UNLOCK (sinkpad);
1742     GST_OBJECT_UNLOCK (srcpad);
1743     goto done;
1744   }
1745 }
1746
1747 /**
1748  * gst_pad_is_linked:
1749  * @pad: pad to check
1750  *
1751  * Checks if a @pad is linked to another pad or not.
1752  *
1753  * Returns: TRUE if the pad is linked, FALSE otherwise.
1754  *
1755  * MT safe.
1756  */
1757 gboolean
1758 gst_pad_is_linked (GstPad * pad)
1759 {
1760   gboolean result;
1761
1762   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1763
1764   GST_OBJECT_LOCK (pad);
1765   result = (GST_PAD_PEER (pad) != NULL);
1766   GST_OBJECT_UNLOCK (pad);
1767
1768   return result;
1769 }
1770
1771 /* get the caps from both pads and see if the intersection
1772  * is not empty.
1773  *
1774  * This function should be called with the pad LOCK on both
1775  * pads
1776  */
1777 static gboolean
1778 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink)
1779 {
1780   GstCaps *srccaps;
1781   GstCaps *sinkcaps;
1782   gboolean compatible = FALSE;
1783
1784   srccaps = gst_pad_get_caps_unlocked (src);
1785   sinkcaps = gst_pad_get_caps_unlocked (sink);
1786
1787   GST_CAT_DEBUG (GST_CAT_CAPS, "src caps %" GST_PTR_FORMAT, srccaps);
1788   GST_CAT_DEBUG (GST_CAT_CAPS, "sink caps %" GST_PTR_FORMAT, sinkcaps);
1789
1790   /* if we have caps on both pads we can check the intersection. If one
1791    * of the caps is NULL, we return TRUE. */
1792   if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
1793     if (srccaps)
1794       gst_caps_unref (srccaps);
1795     if (sinkcaps)
1796       gst_caps_unref (sinkcaps);
1797     goto done;
1798   }
1799
1800   compatible = gst_caps_can_intersect (srccaps, sinkcaps);
1801   gst_caps_unref (srccaps);
1802   gst_caps_unref (sinkcaps);
1803
1804 done:
1805   GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
1806       (compatible ? "" : "not"));
1807
1808   return compatible;
1809 }
1810
1811 /* check if the grandparents of both pads are the same.
1812  * This check is required so that we don't try to link
1813  * pads from elements in different bins without ghostpads.
1814  *
1815  * The LOCK should be held on both pads
1816  */
1817 static gboolean
1818 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
1819 {
1820   GstObject *psrc, *psink;
1821
1822   psrc = GST_OBJECT_PARENT (src);
1823   psink = GST_OBJECT_PARENT (sink);
1824
1825   /* if one of the pads has no parent, we allow the link */
1826   if (G_UNLIKELY (psrc == NULL || psink == NULL))
1827     goto no_parent;
1828
1829   /* only care about parents that are elements */
1830   if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
1831     goto no_element_parent;
1832
1833   /* if the parents are the same, we have a loop */
1834   if (G_UNLIKELY (psrc == psink))
1835     goto same_parents;
1836
1837   /* if they both have a parent, we check the grandparents. We can not lock
1838    * the parent because we hold on the child (pad) and the locking order is
1839    * parent >> child. */
1840   psrc = GST_OBJECT_PARENT (psrc);
1841   psink = GST_OBJECT_PARENT (psink);
1842
1843   /* if they have grandparents but they are not the same */
1844   if (G_UNLIKELY (psrc != psink))
1845     goto wrong_grandparents;
1846
1847   return TRUE;
1848
1849   /* ERRORS */
1850 no_parent:
1851   {
1852     GST_CAT_DEBUG (GST_CAT_CAPS,
1853         "one of the pads has no parent %" GST_PTR_FORMAT " and %"
1854         GST_PTR_FORMAT, psrc, psink);
1855     return TRUE;
1856   }
1857 no_element_parent:
1858   {
1859     GST_CAT_DEBUG (GST_CAT_CAPS,
1860         "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
1861         GST_PTR_FORMAT, psrc, psink);
1862     return TRUE;
1863   }
1864 same_parents:
1865   {
1866     GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
1867         psrc);
1868     return FALSE;
1869   }
1870 wrong_grandparents:
1871   {
1872     GST_CAT_DEBUG (GST_CAT_CAPS,
1873         "pads have different grandparents %" GST_PTR_FORMAT " and %"
1874         GST_PTR_FORMAT, psrc, psink);
1875     return FALSE;
1876   }
1877 }
1878
1879 /* FIXME leftover from an attempt at refactoring... */
1880 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
1881  * the two pads will be locked in the srcpad, sinkpad order. */
1882 static GstPadLinkReturn
1883 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad)
1884 {
1885   GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1886       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1887
1888   GST_OBJECT_LOCK (srcpad);
1889
1890   if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
1891     goto src_was_linked;
1892
1893   GST_OBJECT_LOCK (sinkpad);
1894
1895   if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
1896     goto sink_was_linked;
1897
1898   /* check hierarchy, pads can only be linked if the grandparents
1899    * are the same. */
1900   if (!gst_pad_link_check_hierarchy (srcpad, sinkpad))
1901     goto wrong_hierarchy;
1902
1903   /* check pad caps for non-empty intersection */
1904   if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad))
1905     goto no_format;
1906
1907   /* FIXME check pad scheduling for non-empty intersection */
1908
1909   return GST_PAD_LINK_OK;
1910
1911 src_was_linked:
1912   {
1913     GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
1914         GST_DEBUG_PAD_NAME (srcpad),
1915         GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1916     /* we do not emit a warning in this case because unlinking cannot
1917      * be made MT safe.*/
1918     GST_OBJECT_UNLOCK (srcpad);
1919     return GST_PAD_LINK_WAS_LINKED;
1920   }
1921 sink_was_linked:
1922   {
1923     GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
1924         GST_DEBUG_PAD_NAME (sinkpad),
1925         GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
1926     /* we do not emit a warning in this case because unlinking cannot
1927      * be made MT safe.*/
1928     GST_OBJECT_UNLOCK (sinkpad);
1929     GST_OBJECT_UNLOCK (srcpad);
1930     return GST_PAD_LINK_WAS_LINKED;
1931   }
1932 wrong_hierarchy:
1933   {
1934     GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
1935     GST_OBJECT_UNLOCK (sinkpad);
1936     GST_OBJECT_UNLOCK (srcpad);
1937     return GST_PAD_LINK_WRONG_HIERARCHY;
1938   }
1939 no_format:
1940   {
1941     GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
1942     GST_OBJECT_UNLOCK (sinkpad);
1943     GST_OBJECT_UNLOCK (srcpad);
1944     return GST_PAD_LINK_NOFORMAT;
1945   }
1946 }
1947
1948 /**
1949  * gst_pad_can_link:
1950  * @srcpad: the source #GstPad.
1951  * @sinkpad: the sink #GstPad.
1952  *
1953  * Checks if the source pad and the sink pad are compatible so they can be
1954  * linked. 
1955  *
1956  * Returns: TRUE if the pads can be linked.
1957  */
1958 gboolean
1959 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
1960 {
1961   GstPadLinkReturn result;
1962
1963   /* generic checks */
1964   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1965   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1966
1967   GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
1968       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1969
1970   /* gst_pad_link_prepare does everything for us, we only release the locks
1971    * on the pads that it gets us. If this function returns !OK the locks are not
1972    * taken anymore. */
1973   result = gst_pad_link_prepare (srcpad, sinkpad);
1974   if (result != GST_PAD_LINK_OK)
1975     goto done;
1976
1977   GST_OBJECT_UNLOCK (srcpad);
1978   GST_OBJECT_UNLOCK (sinkpad);
1979
1980 done:
1981   return result == GST_PAD_LINK_OK;
1982 }
1983
1984 /**
1985  * gst_pad_link:
1986  * @srcpad: the source #GstPad to link.
1987  * @sinkpad: the sink #GstPad to link.
1988  *
1989  * Links the source pad and the sink pad.
1990  *
1991  * Returns: A result code indicating if the connection worked or
1992  *          what went wrong.
1993  *
1994  * MT Safe.
1995  */
1996 GstPadLinkReturn
1997 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
1998 {
1999   GstPadLinkReturn result;
2000   GstElement *parent;
2001
2002   g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2003   g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2004   g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2005   g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2006       GST_PAD_LINK_WRONG_DIRECTION);
2007
2008   /* Notify the parent early. See gst_pad_unlink for details. */
2009   if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
2010     if (GST_IS_ELEMENT (parent)) {
2011       gst_element_post_message (parent,
2012           gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2013               GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2014     } else {
2015       gst_object_unref (parent);
2016       parent = NULL;
2017     }
2018   }
2019
2020   /* prepare will also lock the two pads */
2021   result = gst_pad_link_prepare (srcpad, sinkpad);
2022
2023   if (result != GST_PAD_LINK_OK)
2024     goto done;
2025
2026   /* must set peers before calling the link function */
2027   GST_PAD_PEER (srcpad) = sinkpad;
2028   GST_PAD_PEER (sinkpad) = srcpad;
2029
2030   GST_OBJECT_UNLOCK (sinkpad);
2031   GST_OBJECT_UNLOCK (srcpad);
2032
2033   /* FIXME released the locks here, concurrent thread might link
2034    * something else. */
2035   if (GST_PAD_LINKFUNC (srcpad)) {
2036     /* this one will call the peer link function */
2037     result = GST_PAD_LINKFUNC (srcpad) (srcpad, sinkpad);
2038   } else if (GST_PAD_LINKFUNC (sinkpad)) {
2039     /* if no source link function, we need to call the sink link
2040      * function ourselves. */
2041     result = GST_PAD_LINKFUNC (sinkpad) (sinkpad, srcpad);
2042   } else {
2043     result = GST_PAD_LINK_OK;
2044   }
2045
2046   GST_OBJECT_LOCK (srcpad);
2047   GST_OBJECT_LOCK (sinkpad);
2048
2049   if (result == GST_PAD_LINK_OK) {
2050     GST_OBJECT_UNLOCK (sinkpad);
2051     GST_OBJECT_UNLOCK (srcpad);
2052
2053     /* fire off a signal to each of the pads telling them
2054      * that they've been linked */
2055     g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2056     g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2057
2058     GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2059         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2060   } else {
2061     GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed",
2062         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2063
2064     GST_PAD_PEER (srcpad) = NULL;
2065     GST_PAD_PEER (sinkpad) = NULL;
2066
2067     GST_OBJECT_UNLOCK (sinkpad);
2068     GST_OBJECT_UNLOCK (srcpad);
2069   }
2070
2071 done:
2072   if (parent) {
2073     gst_element_post_message (parent,
2074         gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2075             GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2076     gst_object_unref (parent);
2077   }
2078
2079   return result;
2080 }
2081
2082 static void
2083 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2084 {
2085   GstPadTemplate **template_p;
2086
2087   /* this function would need checks if it weren't static */
2088
2089   GST_OBJECT_LOCK (pad);
2090   template_p = &pad->padtemplate;
2091   gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2092   GST_OBJECT_UNLOCK (pad);
2093
2094   if (templ)
2095     gst_pad_template_pad_created (templ, pad);
2096 }
2097
2098 /**
2099  * gst_pad_get_pad_template:
2100  * @pad: a #GstPad.
2101  *
2102  * Gets the template for @pad.
2103  *
2104  * Returns: the #GstPadTemplate from which this pad was instantiated, or %NULL
2105  * if this pad has no template.
2106  *
2107  * FIXME: currently returns an unrefcounted padtemplate.
2108  */
2109 GstPadTemplate *
2110 gst_pad_get_pad_template (GstPad * pad)
2111 {
2112   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2113
2114   return GST_PAD_PAD_TEMPLATE (pad);
2115 }
2116
2117
2118 /* should be called with the pad LOCK held */
2119 /* refs the caps, so caller is responsible for getting it unreffed */
2120 static GstCaps *
2121 gst_pad_get_caps_unlocked (GstPad * pad)
2122 {
2123   GstCaps *result = NULL;
2124   GstPadTemplate *templ;
2125
2126   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
2127
2128   if (GST_PAD_GETCAPSFUNC (pad)) {
2129     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2130         "dispatching to pad getcaps function");
2131
2132     GST_OBJECT_FLAG_SET (pad, GST_PAD_IN_GETCAPS);
2133     GST_OBJECT_UNLOCK (pad);
2134     result = GST_PAD_GETCAPSFUNC (pad) (pad);
2135     GST_OBJECT_LOCK (pad);
2136     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_IN_GETCAPS);
2137
2138     if (result == NULL) {
2139       g_critical ("pad %s:%s returned NULL caps from getcaps function",
2140           GST_DEBUG_PAD_NAME (pad));
2141     } else {
2142       GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2143           "pad getcaps returned %" GST_PTR_FORMAT, result);
2144 #ifndef G_DISABLE_ASSERT
2145       /* check that the returned caps are a real subset of the template caps */
2146       if (GST_PAD_PAD_TEMPLATE (pad)) {
2147         const GstCaps *templ_caps =
2148             GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
2149         if (!gst_caps_is_subset (result, templ_caps)) {
2150           GstCaps *temp;
2151
2152           GST_CAT_ERROR_OBJECT (GST_CAT_CAPS, pad,
2153               "pad returned caps %" GST_PTR_FORMAT
2154               " which are not a real subset of its template caps %"
2155               GST_PTR_FORMAT, result, templ_caps);
2156           g_warning
2157               ("pad %s:%s returned caps which are not a real "
2158               "subset of its template caps", GST_DEBUG_PAD_NAME (pad));
2159           temp = gst_caps_intersect (templ_caps, result);
2160           gst_caps_unref (result);
2161           result = temp;
2162         }
2163       }
2164 #endif
2165       goto done;
2166     }
2167   }
2168   if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
2169     result = GST_PAD_TEMPLATE_CAPS (templ);
2170     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2171         "using pad template %p with caps %p %" GST_PTR_FORMAT, templ, result,
2172         result);
2173
2174     result = gst_caps_ref (result);
2175     goto done;
2176   }
2177   if ((result = GST_PAD_CAPS (pad))) {
2178     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2179         "using pad caps %p %" GST_PTR_FORMAT, result, result);
2180
2181     result = gst_caps_ref (result);
2182     goto done;
2183   }
2184
2185   /* this almost never happens */
2186   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
2187   result = gst_caps_new_empty ();
2188
2189 done:
2190   return result;
2191 }
2192
2193 /* FIXME-0.11: what about making this the default and using
2194  * gst_caps_make_writable() explicitely where needed
2195  */
2196 /**
2197  * gst_pad_get_caps_reffed:
2198  * @pad: a  #GstPad to get the capabilities of.
2199  *
2200  * Gets the capabilities this pad can produce or consume. Preferred function if
2201  * one only wants to read or intersect the caps.
2202  *
2203  * Returns: the caps of the pad with incremented ref-count.
2204  *
2205  * Since: 0.10.26
2206  */
2207 GstCaps *
2208 gst_pad_get_caps_reffed (GstPad * pad)
2209 {
2210   GstCaps *result = NULL;
2211
2212   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2213
2214   GST_OBJECT_LOCK (pad);
2215
2216   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
2217
2218   result = gst_pad_get_caps_unlocked (pad);
2219
2220   GST_OBJECT_UNLOCK (pad);
2221
2222   return result;
2223 }
2224
2225 /**
2226  * gst_pad_get_caps:
2227  * @pad: a  #GstPad to get the capabilities of.
2228  *
2229  * Gets the capabilities this pad can produce or consume.
2230  * Note that this method doesn't necessarily return the caps set by
2231  * gst_pad_set_caps() - use GST_PAD_CAPS() for that instead.
2232  * gst_pad_get_caps returns all possible caps a pad can operate with, using
2233  * the pad's get_caps function;
2234  * this returns the pad template caps if not explicitly set.
2235  *
2236  * Returns: a newly allocated copy of the #GstCaps of this pad.
2237  *
2238  * MT safe.
2239  */
2240 GstCaps *
2241 gst_pad_get_caps (GstPad * pad)
2242 {
2243   GstCaps *result = gst_pad_get_caps_reffed (pad);
2244
2245   /* be sure that we have a copy */
2246   if (G_LIKELY (result))
2247     result = gst_caps_make_writable (result);
2248
2249   return result;
2250 }
2251
2252 /* FIXME-0.11: what about making this the default and using
2253  * gst_caps_make_writable() explicitely where needed
2254  */
2255 /**
2256  * gst_pad_peer_get_caps_reffed:
2257  * @pad: a  #GstPad to get the capabilities of.
2258  *
2259  * Gets the capabilities of the peer connected to this pad. Preferred function
2260  * if one only wants to read or intersect the caps.
2261  *
2262  * Returns: the caps of the pad with incremented ref-count.
2263  *
2264  * Since: 0.10.26
2265  */
2266 GstCaps *
2267 gst_pad_peer_get_caps_reffed (GstPad * pad)
2268 {
2269   GstPad *peerpad;
2270   GstCaps *result = NULL;
2271
2272   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2273
2274   GST_OBJECT_LOCK (pad);
2275
2276   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get peer caps");
2277
2278   peerpad = GST_PAD_PEER (pad);
2279   if (G_UNLIKELY (peerpad == NULL))
2280     goto no_peer;
2281
2282   gst_object_ref (peerpad);
2283   GST_OBJECT_UNLOCK (pad);
2284
2285   result = gst_pad_get_caps_reffed (peerpad);
2286
2287   gst_object_unref (peerpad);
2288
2289   return result;
2290
2291 no_peer:
2292   {
2293     GST_OBJECT_UNLOCK (pad);
2294     return NULL;
2295   }
2296 }
2297
2298 /**
2299  * gst_pad_peer_get_caps:
2300  * @pad: a  #GstPad to get the peer capabilities of.
2301  *
2302  * Gets the capabilities of the peer connected to this pad. Similar to
2303  * gst_pad_get_caps().
2304  *
2305  * Returns: a newly allocated copy of the #GstCaps of the peer pad. Use
2306  * gst_caps_unref() to get rid of it. This function returns %NULL if there is
2307  * no peer pad.
2308  */
2309 GstCaps *
2310 gst_pad_peer_get_caps (GstPad * pad)
2311 {
2312   GstPad *peerpad;
2313   GstCaps *result = NULL;
2314
2315   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2316
2317   GST_OBJECT_LOCK (pad);
2318
2319   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get peer caps");
2320
2321   peerpad = GST_PAD_PEER (pad);
2322   if (G_UNLIKELY (peerpad == NULL))
2323     goto no_peer;
2324
2325   gst_object_ref (peerpad);
2326   GST_OBJECT_UNLOCK (pad);
2327
2328   result = gst_pad_get_caps (peerpad);
2329
2330   gst_object_unref (peerpad);
2331
2332   return result;
2333
2334 no_peer:
2335   {
2336     GST_OBJECT_UNLOCK (pad);
2337     return NULL;
2338   }
2339 }
2340
2341 static gboolean
2342 fixate_value (GValue * dest, const GValue * src)
2343 {
2344   if (G_VALUE_TYPE (src) == GST_TYPE_INT_RANGE) {
2345     g_value_init (dest, G_TYPE_INT);
2346     g_value_set_int (dest, gst_value_get_int_range_min (src));
2347   } else if (G_VALUE_TYPE (src) == GST_TYPE_DOUBLE_RANGE) {
2348     g_value_init (dest, G_TYPE_DOUBLE);
2349     g_value_set_double (dest, gst_value_get_double_range_min (src));
2350   } else if (G_VALUE_TYPE (src) == GST_TYPE_FRACTION_RANGE) {
2351     gst_value_init_and_copy (dest, gst_value_get_fraction_range_min (src));
2352   } else if (G_VALUE_TYPE (src) == GST_TYPE_LIST) {
2353     GValue temp = { 0 };
2354
2355     /* list could be empty */
2356     if (gst_value_list_get_size (src) <= 0)
2357       return FALSE;
2358
2359     gst_value_init_and_copy (&temp, gst_value_list_get_value (src, 0));
2360
2361     if (!fixate_value (dest, &temp))
2362       gst_value_init_and_copy (dest, &temp);
2363     g_value_unset (&temp);
2364   } else if (G_VALUE_TYPE (src) == GST_TYPE_ARRAY) {
2365     gboolean res = FALSE;
2366     guint n, len;
2367
2368     len = gst_value_array_get_size (src);
2369     g_value_init (dest, GST_TYPE_ARRAY);
2370     for (n = 0; n < len; n++) {
2371       GValue kid = { 0 };
2372       const GValue *orig_kid = gst_value_array_get_value (src, n);
2373
2374       if (!fixate_value (&kid, orig_kid))
2375         gst_value_init_and_copy (&kid, orig_kid);
2376       else
2377         res = TRUE;
2378       gst_value_array_append_value (dest, &kid);
2379       g_value_unset (&kid);
2380     }
2381
2382     if (!res)
2383       g_value_unset (dest);
2384
2385     return res;
2386   } else {
2387     return FALSE;
2388   }
2389
2390   return TRUE;
2391 }
2392
2393 static gboolean
2394 gst_pad_default_fixate (GQuark field_id, const GValue * value, gpointer data)
2395 {
2396   GstStructure *s = data;
2397   GValue v = { 0 };
2398
2399   if (fixate_value (&v, value)) {
2400     gst_structure_id_set_value (s, field_id, &v);
2401     g_value_unset (&v);
2402   }
2403
2404   return TRUE;
2405 }
2406
2407 /**
2408  * gst_pad_fixate_caps:
2409  * @pad: a  #GstPad to fixate
2410  * @caps: the  #GstCaps to fixate
2411  *
2412  * Fixate a caps on the given pad. Modifies the caps in place, so you should
2413  * make sure that the caps are actually writable (see gst_caps_make_writable()).
2414  */
2415 void
2416 gst_pad_fixate_caps (GstPad * pad, GstCaps * caps)
2417 {
2418   GstPadFixateCapsFunction fixatefunc;
2419   guint len;
2420
2421   g_return_if_fail (GST_IS_PAD (pad));
2422   g_return_if_fail (caps != NULL);
2423
2424   if (gst_caps_is_fixed (caps))
2425     return;
2426
2427   fixatefunc = GST_PAD_FIXATECAPSFUNC (pad);
2428   if (fixatefunc) {
2429     fixatefunc (pad, caps);
2430   }
2431
2432   /* default fixation */
2433   len = gst_caps_get_size (caps);
2434   if (len > 0) {
2435     GstStructure *s = gst_caps_get_structure (caps, 0);
2436
2437     gst_structure_foreach (s, gst_pad_default_fixate, s);
2438   }
2439
2440   if (len > 1) {
2441     gst_caps_truncate (caps);
2442   }
2443 }
2444
2445 /* Default accept caps implementation just checks against
2446  * against the allowed caps for the pad */
2447 static gboolean
2448 gst_pad_acceptcaps_default (GstPad * pad, GstCaps * caps)
2449 {
2450   /* get the caps and see if it intersects to something not empty */
2451   GstCaps *allowed;
2452   gboolean result = FALSE;
2453
2454   GST_DEBUG_OBJECT (pad, "caps %" GST_PTR_FORMAT, caps);
2455
2456   allowed = gst_pad_get_caps_reffed (pad);
2457   if (!allowed)
2458     goto nothing_allowed;
2459
2460   GST_DEBUG_OBJECT (pad, "allowed caps %" GST_PTR_FORMAT, allowed);
2461
2462   result = gst_caps_can_intersect (allowed, caps);
2463
2464   gst_caps_unref (allowed);
2465
2466   return result;
2467
2468   /* ERRORS */
2469 nothing_allowed:
2470   {
2471     GST_DEBUG_OBJECT (pad, "no caps allowed on the pad");
2472     return FALSE;
2473   }
2474 }
2475
2476 /**
2477  * gst_pad_accept_caps:
2478  * @pad: a #GstPad to check
2479  * @caps: a #GstCaps to check on the pad
2480  *
2481  * Check if the given pad accepts the caps.
2482  *
2483  * Returns: TRUE if the pad can accept the caps.
2484  */
2485 gboolean
2486 gst_pad_accept_caps (GstPad * pad, GstCaps * caps)
2487 {
2488   gboolean result;
2489   GstPadAcceptCapsFunction acceptfunc;
2490   GstCaps *existing = NULL;
2491
2492   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2493
2494   /* any pad can be unnegotiated */
2495   if (caps == NULL)
2496     return TRUE;
2497
2498   /* lock for checking the existing caps */
2499   GST_OBJECT_LOCK (pad);
2500   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "accept caps of %p", caps);
2501   /* The current caps on a pad are trivially acceptable */
2502   if (G_LIKELY ((existing = GST_PAD_CAPS (pad)))) {
2503     if (caps == existing || gst_caps_is_equal (caps, existing))
2504       goto is_same_caps;
2505   }
2506   acceptfunc = GST_PAD_ACCEPTCAPSFUNC (pad);
2507   GST_OBJECT_UNLOCK (pad);
2508
2509   if (G_LIKELY (acceptfunc)) {
2510     /* we can call the function */
2511     result = acceptfunc (pad, caps);
2512     GST_DEBUG_OBJECT (pad, "acceptfunc returned %d", result);
2513   } else {
2514     /* Only null if the element explicitly unset it */
2515     result = gst_pad_acceptcaps_default (pad, caps);
2516     GST_DEBUG_OBJECT (pad, "default acceptcaps returned %d", result);
2517   }
2518   return result;
2519
2520 is_same_caps:
2521   {
2522     GST_DEBUG_OBJECT (pad, "pad had same caps");
2523     GST_OBJECT_UNLOCK (pad);
2524     return TRUE;
2525   }
2526 }
2527
2528 /**
2529  * gst_pad_peer_accept_caps:
2530  * @pad: a  #GstPad to check the peer of
2531  * @caps: a #GstCaps to check on the pad
2532  *
2533  * Check if the peer of @pad accepts @caps. If @pad has no peer, this function
2534  * returns TRUE.
2535  *
2536  * Returns: TRUE if the peer of @pad can accept the caps or @pad has no peer.
2537  */
2538 gboolean
2539 gst_pad_peer_accept_caps (GstPad * pad, GstCaps * caps)
2540 {
2541   GstPad *peerpad;
2542   gboolean result;
2543
2544   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2545
2546   GST_OBJECT_LOCK (pad);
2547
2548   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "peer accept caps of (%p)", pad);
2549
2550   peerpad = GST_PAD_PEER (pad);
2551   if (G_UNLIKELY (peerpad == NULL))
2552     goto no_peer;
2553
2554   gst_object_ref (peerpad);
2555   /* release lock before calling external methods but keep ref to pad */
2556   GST_OBJECT_UNLOCK (pad);
2557
2558   result = gst_pad_accept_caps (peerpad, caps);
2559
2560   gst_object_unref (peerpad);
2561
2562   return result;
2563
2564 no_peer:
2565   {
2566     GST_OBJECT_UNLOCK (pad);
2567     return TRUE;
2568   }
2569 }
2570
2571 /**
2572  * gst_pad_set_caps:
2573  * @pad: a  #GstPad to set the capabilities of.
2574  * @caps: a #GstCaps to set.
2575  *
2576  * Sets the capabilities of this pad. The caps must be fixed. Any previous
2577  * caps on the pad will be unreffed. This function refs the caps so you should
2578  * unref if as soon as you don't need it anymore.
2579  * It is possible to set NULL caps, which will make the pad unnegotiated
2580  * again.
2581  *
2582  * Returns: TRUE if the caps could be set. FALSE if the caps were not fixed
2583  * or bad parameters were provided to this function.
2584  *
2585  * MT safe.
2586  */
2587 gboolean
2588 gst_pad_set_caps (GstPad * pad, GstCaps * caps)
2589 {
2590   GstPadSetCapsFunction setcaps;
2591   GstCaps *existing;
2592
2593   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2594   g_return_val_if_fail (caps == NULL || gst_caps_is_fixed (caps), FALSE);
2595
2596   GST_OBJECT_LOCK (pad);
2597   existing = GST_PAD_CAPS (pad);
2598   if (existing == caps)
2599     goto was_ok;
2600
2601   if (gst_caps_is_equal (caps, existing))
2602     goto setting_same_caps;
2603
2604   setcaps = GST_PAD_SETCAPSFUNC (pad);
2605
2606   /* call setcaps function to configure the pad only if the
2607    * caps is not NULL */
2608   if (setcaps != NULL && caps) {
2609     if (!GST_PAD_IS_IN_SETCAPS (pad)) {
2610       GST_OBJECT_FLAG_SET (pad, GST_PAD_IN_SETCAPS);
2611       GST_OBJECT_UNLOCK (pad);
2612       if (!setcaps (pad, caps))
2613         goto could_not_set;
2614       GST_OBJECT_LOCK (pad);
2615       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_IN_SETCAPS);
2616     } else {
2617       GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad was dispatching");
2618     }
2619   }
2620
2621   gst_caps_replace (&GST_PAD_CAPS (pad), caps);
2622   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "caps %p %" GST_PTR_FORMAT, caps,
2623       caps);
2624   GST_OBJECT_UNLOCK (pad);
2625
2626   g_object_notify (G_OBJECT (pad), "caps");
2627
2628   return TRUE;
2629
2630 was_ok:
2631   {
2632     GST_OBJECT_UNLOCK (pad);
2633     return TRUE;
2634   }
2635 setting_same_caps:
2636   {
2637     gst_caps_replace (&GST_PAD_CAPS (pad), caps);
2638     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2639         "caps %p %" GST_PTR_FORMAT " same as existing, updating ptr only", caps,
2640         caps);
2641     GST_OBJECT_UNLOCK (pad);
2642     return TRUE;
2643   }
2644
2645   /* ERRORS */
2646 could_not_set:
2647   {
2648     GST_OBJECT_LOCK (pad);
2649     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_IN_SETCAPS);
2650     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2651         "caps %" GST_PTR_FORMAT " could not be set", caps);
2652     GST_OBJECT_UNLOCK (pad);
2653
2654     return FALSE;
2655   }
2656 }
2657
2658 static gboolean
2659 gst_pad_configure_sink (GstPad * pad, GstCaps * caps)
2660 {
2661   gboolean res;
2662
2663   /* See if pad accepts the caps */
2664   if (!gst_pad_accept_caps (pad, caps))
2665     goto not_accepted;
2666
2667   /* set caps on pad if call succeeds */
2668   res = gst_pad_set_caps (pad, caps);
2669   /* no need to unref the caps here, set_caps takes a ref and
2670    * our ref goes away when we leave this function. */
2671
2672   return res;
2673
2674 not_accepted:
2675   {
2676     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2677         "caps %" GST_PTR_FORMAT " not accepted", caps);
2678     return FALSE;
2679   }
2680 }
2681
2682 /* returns TRUE if the src pad could be configured to accept the given caps */
2683 static gboolean
2684 gst_pad_configure_src (GstPad * pad, GstCaps * caps, gboolean dosetcaps)
2685 {
2686   gboolean res;
2687
2688   if (dosetcaps) {
2689     /* See if pad accepts the caps */
2690     if (!gst_pad_accept_caps (pad, caps))
2691       goto not_accepted;
2692
2693     res = gst_pad_set_caps (pad, caps);
2694   } else {
2695     res = TRUE;
2696   }
2697   return res;
2698
2699 not_accepted:
2700   {
2701     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2702         "caps %" GST_PTR_FORMAT " not accepted", caps);
2703     return FALSE;
2704   }
2705 }
2706
2707 /**
2708  * gst_pad_get_pad_template_caps:
2709  * @pad: a #GstPad to get the template capabilities from.
2710  *
2711  * Gets the capabilities for @pad's template.
2712  *
2713  * Returns: the #GstCaps of this pad template. If you intend to keep a
2714  * reference on the caps, make a copy (see gst_caps_copy ()).
2715  */
2716 const GstCaps *
2717 gst_pad_get_pad_template_caps (GstPad * pad)
2718 {
2719   static GstStaticCaps anycaps = GST_STATIC_CAPS ("ANY");
2720
2721   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2722
2723   if (GST_PAD_PAD_TEMPLATE (pad))
2724     return GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
2725
2726   return gst_static_caps_get (&anycaps);
2727 }
2728
2729 /**
2730  * gst_pad_get_peer:
2731  * @pad: a #GstPad to get the peer of.
2732  *
2733  * Gets the peer of @pad. This function refs the peer pad so
2734  * you need to unref it after use.
2735  *
2736  * Returns: the peer #GstPad. Unref after usage.
2737  *
2738  * MT safe.
2739  */
2740 GstPad *
2741 gst_pad_get_peer (GstPad * pad)
2742 {
2743   GstPad *result;
2744
2745   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2746
2747   GST_OBJECT_LOCK (pad);
2748   result = GST_PAD_PEER (pad);
2749   if (result)
2750     gst_object_ref (result);
2751   GST_OBJECT_UNLOCK (pad);
2752
2753   return result;
2754 }
2755
2756 /**
2757  * gst_pad_get_allowed_caps:
2758  * @pad: a #GstPad.
2759  *
2760  * Gets the capabilities of the allowed media types that can flow through
2761  * @pad and its peer.
2762  *
2763  * The allowed capabilities is calculated as the intersection of the results of
2764  * calling gst_pad_get_caps() on @pad and its peer. The caller owns a reference
2765  * on the resulting caps.
2766  *
2767  * Returns: the allowed #GstCaps of the pad link. Unref the caps when you no
2768  * longer need it. This function returns NULL when @pad has no peer.
2769  *
2770  * MT safe.
2771  */
2772 GstCaps *
2773 gst_pad_get_allowed_caps (GstPad * pad)
2774 {
2775   GstCaps *mycaps;
2776   GstCaps *caps;
2777   GstCaps *peercaps;
2778   GstPad *peer;
2779
2780   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2781
2782   GST_OBJECT_LOCK (pad);
2783
2784   peer = GST_PAD_PEER (pad);
2785   if (G_UNLIKELY (peer == NULL))
2786     goto no_peer;
2787
2788   GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2789
2790   gst_object_ref (peer);
2791   GST_OBJECT_UNLOCK (pad);
2792   mycaps = gst_pad_get_caps_reffed (pad);
2793
2794   peercaps = gst_pad_get_caps_reffed (peer);
2795   gst_object_unref (peer);
2796
2797   caps = gst_caps_intersect (mycaps, peercaps);
2798   gst_caps_unref (peercaps);
2799   gst_caps_unref (mycaps);
2800
2801   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2802       caps);
2803
2804   return caps;
2805
2806 no_peer:
2807   {
2808     GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2809     GST_OBJECT_UNLOCK (pad);
2810
2811     return NULL;
2812   }
2813 }
2814
2815 /**
2816  * gst_pad_get_negotiated_caps:
2817  * @pad: a #GstPad.
2818  *
2819  * Gets the capabilities of the media type that currently flows through @pad
2820  * and its peer.
2821  *
2822  * This function can be used on both src and sinkpads. Note that srcpads are
2823  * always negotiated before sinkpads so it is possible that the negotiated caps
2824  * on the srcpad do not match the negotiated caps of the peer.
2825  *
2826  * Returns: the negotiated #GstCaps of the pad link.  Unref the caps when
2827  * you no longer need it. This function returns NULL when the @pad has no
2828  * peer or is not negotiated yet.
2829  *
2830  * MT safe.
2831  */
2832 GstCaps *
2833 gst_pad_get_negotiated_caps (GstPad * pad)
2834 {
2835   GstCaps *caps;
2836   GstPad *peer;
2837
2838   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2839
2840   GST_OBJECT_LOCK (pad);
2841
2842   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
2843     goto no_peer;
2844
2845   GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting negotiated caps");
2846
2847   caps = GST_PAD_CAPS (pad);
2848   if (caps)
2849     gst_caps_ref (caps);
2850   GST_OBJECT_UNLOCK (pad);
2851
2852   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "negotiated caps %" GST_PTR_FORMAT,
2853       caps);
2854
2855   return caps;
2856
2857 no_peer:
2858   {
2859     GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2860     GST_OBJECT_UNLOCK (pad);
2861
2862     return NULL;
2863   }
2864 }
2865
2866 /* calls the buffer_alloc function on the given pad */
2867 static GstFlowReturn
2868 gst_pad_buffer_alloc_unchecked (GstPad * pad, guint64 offset, gint size,
2869     GstCaps * caps, GstBuffer ** buf)
2870 {
2871   GstFlowReturn ret;
2872   GstPadBufferAllocFunction bufferallocfunc;
2873
2874   GST_OBJECT_LOCK (pad);
2875   /* when the pad is flushing we cannot give a buffer */
2876   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
2877     goto flushing;
2878
2879   bufferallocfunc = pad->bufferallocfunc;
2880
2881   if (offset == GST_BUFFER_OFFSET_NONE) {
2882     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2883         "calling bufferallocfunc &%s (@%p) for size %d offset NONE",
2884         GST_DEBUG_FUNCPTR_NAME (bufferallocfunc), bufferallocfunc, size);
2885   } else {
2886     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2887         "calling bufferallocfunc &%s (@%p) of for size %d offset %"
2888         G_GUINT64_FORMAT, GST_DEBUG_FUNCPTR_NAME (bufferallocfunc),
2889         bufferallocfunc, size, offset);
2890   }
2891   GST_OBJECT_UNLOCK (pad);
2892
2893   /* G_LIKELY for now since most elements don't implement a buffer alloc
2894    * function and there is no default alloc proxy function as this is usually
2895    * not possible. */
2896   if (G_LIKELY (bufferallocfunc == NULL))
2897     goto fallback;
2898
2899   ret = bufferallocfunc (pad, offset, size, caps, buf);
2900
2901   if (G_UNLIKELY (ret != GST_FLOW_OK))
2902     goto error;
2903
2904   /* no error, but NULL buffer means fallback to the default */
2905   if (G_UNLIKELY (*buf == NULL))
2906     goto fallback;
2907
2908   /* If the buffer alloc function didn't set up the caps like it should,
2909    * do it for it */
2910   if (G_UNLIKELY (caps && (GST_BUFFER_CAPS (*buf) == NULL))) {
2911     GST_WARNING_OBJECT (pad,
2912         "Buffer allocation function did not set caps. Setting");
2913     gst_buffer_set_caps (*buf, caps);
2914   }
2915   return ret;
2916
2917 flushing:
2918   {
2919     /* pad was flushing */
2920     GST_OBJECT_UNLOCK (pad);
2921     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "pad was flushing");
2922     return GST_FLOW_WRONG_STATE;
2923   }
2924 error:
2925   {
2926     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2927         "alloc function returned error (%d) %s", ret, gst_flow_get_name (ret));
2928     return ret;
2929   }
2930 fallback:
2931   {
2932     /* fallback case, allocate a buffer of our own, add pad caps. */
2933     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "fallback buffer alloc");
2934
2935     if ((*buf = gst_buffer_try_new_and_alloc (size))) {
2936       GST_BUFFER_OFFSET (*buf) = offset;
2937       gst_buffer_set_caps (*buf, caps);
2938       return GST_FLOW_OK;
2939     } else {
2940       GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2941           "out of memory allocating %d bytes", size);
2942       return GST_FLOW_ERROR;
2943     }
2944   }
2945 }
2946
2947 /* FIXME 0.11: size should be unsigned */
2948 static GstFlowReturn
2949 gst_pad_alloc_buffer_full (GstPad * pad, guint64 offset, gint size,
2950     GstCaps * caps, GstBuffer ** buf, gboolean setcaps)
2951 {
2952   GstPad *peer;
2953   GstFlowReturn ret;
2954   GstCaps *newcaps;
2955   gboolean caps_changed;
2956
2957   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
2958   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
2959   g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
2960   g_return_val_if_fail (size >= 0, GST_FLOW_ERROR);
2961
2962   GST_DEBUG_OBJECT (pad, "offset %" G_GUINT64_FORMAT ", size %d, caps %"
2963       GST_PTR_FORMAT, offset, size, caps);
2964
2965   GST_OBJECT_LOCK (pad);
2966   while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
2967     if ((ret = handle_pad_block (pad)) != GST_FLOW_OK)
2968       goto flushed;
2969
2970   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
2971     goto no_peer;
2972
2973   gst_object_ref (peer);
2974   GST_OBJECT_UNLOCK (pad);
2975
2976   ret = gst_pad_buffer_alloc_unchecked (peer, offset, size, caps, buf);
2977   gst_object_unref (peer);
2978
2979   if (G_UNLIKELY (ret != GST_FLOW_OK))
2980     goto peer_error;
2981
2982   /* FIXME, move capnego this into a base class? */
2983   newcaps = GST_BUFFER_CAPS (*buf);
2984
2985   /* Lock for checking caps, pretty pointless as the _pad_push() function might
2986    * change it concurrently, one of the problems with automatic caps setting in
2987    * pad_alloc_and_set_caps. Worst case, if does a check too much, but only
2988    * when there is heavy renegotiation going on in both directions. */
2989   GST_OBJECT_LOCK (pad);
2990   caps_changed = newcaps && newcaps != GST_PAD_CAPS (pad);
2991   GST_OBJECT_UNLOCK (pad);
2992
2993   /* we got a new datatype on the pad, see if it can handle it */
2994   if (G_UNLIKELY (caps_changed)) {
2995     GST_DEBUG_OBJECT (pad,
2996         "caps changed from %" GST_PTR_FORMAT " to %p %" GST_PTR_FORMAT,
2997         GST_PAD_CAPS (pad), newcaps, newcaps);
2998     if (G_UNLIKELY (!gst_pad_configure_src (pad, newcaps, setcaps)))
2999       goto not_negotiated;
3000   }
3001
3002   /* sanity check (only if caps are the same) */
3003   if (G_LIKELY (newcaps == caps) && G_UNLIKELY (GST_BUFFER_SIZE (*buf) < size))
3004     goto wrong_size_fallback;
3005
3006   return ret;
3007
3008 flushed:
3009   {
3010     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "pad block stopped by flush");
3011     GST_OBJECT_UNLOCK (pad);
3012     return ret;
3013   }
3014 no_peer:
3015   {
3016     /* pad has no peer */
3017     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3018         "called bufferallocfunc but had no peer");
3019     GST_OBJECT_UNLOCK (pad);
3020     return GST_FLOW_NOT_LINKED;
3021   }
3022 peer_error:
3023   {
3024     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3025         "alloc function returned error %s", gst_flow_get_name (ret));
3026     return ret;
3027   }
3028 not_negotiated:
3029   {
3030     gst_buffer_unref (*buf);
3031     *buf = NULL;
3032     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3033         "alloc function returned unacceptable buffer");
3034     return GST_FLOW_NOT_NEGOTIATED;
3035   }
3036 wrong_size_fallback:
3037   {
3038     GST_CAT_ERROR_OBJECT (GST_CAT_PADS, pad, "buffer returned by alloc "
3039         "function is too small (%u < %d), doing fallback buffer alloc",
3040         GST_BUFFER_SIZE (*buf), size);
3041
3042     gst_buffer_unref (*buf);
3043
3044     if ((*buf = gst_buffer_try_new_and_alloc (size))) {
3045       GST_BUFFER_OFFSET (*buf) = offset;
3046       gst_buffer_set_caps (*buf, caps);
3047       return GST_FLOW_OK;
3048     } else {
3049       GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3050           "out of memory allocating %d bytes", size);
3051       return GST_FLOW_ERROR;
3052     }
3053   }
3054 }
3055
3056 /**
3057  * gst_pad_alloc_buffer:
3058  * @pad: a source #GstPad
3059  * @offset: the offset of the new buffer in the stream
3060  * @size: the size of the new buffer
3061  * @caps: the caps of the new buffer
3062  * @buf: a newly allocated buffer
3063  *
3064  * Allocates a new, empty buffer optimized to push to pad @pad.  This
3065  * function only works if @pad is a source pad and has a peer.
3066  *
3067  * A new, empty #GstBuffer will be put in the @buf argument.
3068  * You need to check the caps of the buffer after performing this
3069  * function and renegotiate to the format if needed. If the caps changed, it is
3070  * possible that the buffer returned in @buf is not of the right size for the
3071  * new format, @buf needs to be unreffed and reallocated if this is the case.
3072  *
3073  * Returns: a result code indicating success of the operation. Any
3074  * result code other than #GST_FLOW_OK is an error and @buf should
3075  * not be used.
3076  * An error can occur if the pad is not connected or when the downstream
3077  * peer elements cannot provide an acceptable buffer.
3078  *
3079  * MT safe.
3080  */
3081
3082 /* FIXME 0.11: size should be unsigned */
3083 GstFlowReturn
3084 gst_pad_alloc_buffer (GstPad * pad, guint64 offset, gint size, GstCaps * caps,
3085     GstBuffer ** buf)
3086 {
3087   return gst_pad_alloc_buffer_full (pad, offset, size, caps, buf, FALSE);
3088 }
3089
3090 /**
3091  * gst_pad_alloc_buffer_and_set_caps:
3092  * @pad: a source #GstPad
3093  * @offset: the offset of the new buffer in the stream
3094  * @size: the size of the new buffer
3095  * @caps: the caps of the new buffer
3096  * @buf: a newly allocated buffer
3097  *
3098  * In addition to the function gst_pad_alloc_buffer(), this function
3099  * automatically calls gst_pad_set_caps() when the caps of the
3100  * newly allocated buffer are different from the @pad caps.
3101  *
3102  * After a renegotiation, the size of the new buffer returned in @buf could
3103  * be of the wrong size for the new format and must be unreffed an reallocated
3104  * in that case.
3105  *
3106  * Returns: a result code indicating success of the operation. Any
3107  * result code other than #GST_FLOW_OK is an error and @buf should
3108  * not be used.
3109  * An error can occur if the pad is not connected or when the downstream
3110  * peer elements cannot provide an acceptable buffer.
3111  *
3112  * MT safe.
3113  */
3114
3115 /* FIXME 0.11: size should be unsigned */
3116 GstFlowReturn
3117 gst_pad_alloc_buffer_and_set_caps (GstPad * pad, guint64 offset, gint size,
3118     GstCaps * caps, GstBuffer ** buf)
3119 {
3120   return gst_pad_alloc_buffer_full (pad, offset, size, caps, buf, TRUE);
3121 }
3122
3123
3124 #ifndef GST_REMOVE_DEPRECATED
3125 typedef struct
3126 {
3127   GList *list;
3128   guint32 cookie;
3129 } IntLinkIterData;
3130
3131 static void
3132 int_link_iter_data_free (IntLinkIterData * data)
3133 {
3134   g_list_free (data->list);
3135   g_slice_free (IntLinkIterData, data);
3136 }
3137 #endif
3138
3139 static GstIteratorItem
3140 iterate_pad (GstIterator * it, GstPad * pad)
3141 {
3142   gst_object_ref (pad);
3143   return GST_ITERATOR_ITEM_PASS;
3144 }
3145
3146 /**
3147  * gst_pad_iterate_internal_links_default:
3148  * @pad: the #GstPad to get the internal links of.
3149  *
3150  * Iterate the list of pads to which the given pad is linked to inside of
3151  * the parent element.
3152  * This is the default handler, and thus returns an iterator of all of the
3153  * pads inside the parent element with opposite direction.
3154  *
3155  * The caller must free this iterator after use with gst_iterator_free().
3156  *
3157  * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
3158  * returned pad with gst_object_unref().
3159  *
3160  * Since: 0.10.21
3161  */
3162 GstIterator *
3163 gst_pad_iterate_internal_links_default (GstPad * pad)
3164 {
3165   GstIterator *res;
3166   GList **padlist;
3167   guint32 *cookie;
3168   GMutex *lock;
3169   gpointer owner;
3170   GstIteratorDisposeFunction dispose;
3171
3172   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3173
3174 #ifndef GST_REMOVE_DEPRECATED
3175   /* when we get here, the default handler for the iterate links is called,
3176    * which means that the user has not installed a custom one. We first check if
3177    * there is maybe a custom legacy function we can call. */
3178   if (GST_PAD_INTLINKFUNC (pad) &&
3179       GST_PAD_INTLINKFUNC (pad) != gst_pad_get_internal_links_default) {
3180     IntLinkIterData *data;
3181
3182     /* make an iterator for the list. We can't protect the list with a
3183      * cookie. If we would take the cookie of the parent element, we need to
3184      * have a parent, which is not required for GST_PAD_INTLINKFUNC(). We could
3185      * cache the per-pad list and invalidate the list when a new call to
3186      * INTLINKFUNC() returned a different list but then this would only work if
3187      * two concurrent iterators were used and the last iterator would still be
3188      * thread-unsafe. Just don't use this method anymore. */
3189     data = g_slice_new (IntLinkIterData);
3190     data->list = GST_PAD_INTLINKFUNC (pad) (pad);
3191     data->cookie = 0;
3192
3193     GST_WARNING_OBJECT (pad, "Making unsafe iterator");
3194
3195     cookie = &data->cookie;
3196     padlist = &data->list;
3197     owner = data;
3198     dispose = (GstIteratorDisposeFunction) int_link_iter_data_free;
3199     /* reuse the pad lock, it's all we have here */
3200     lock = GST_OBJECT_GET_LOCK (pad);
3201   } else
3202 #endif
3203   {
3204     GstElement *parent;
3205
3206     GST_OBJECT_LOCK (pad);
3207     parent = GST_PAD_PARENT (pad);
3208     if (!parent || !GST_IS_ELEMENT (parent))
3209       goto no_parent;
3210
3211     gst_object_ref (parent);
3212     GST_OBJECT_UNLOCK (pad);
3213
3214     if (pad->direction == GST_PAD_SRC)
3215       padlist = &parent->sinkpads;
3216     else
3217       padlist = &parent->srcpads;
3218
3219     GST_DEBUG_OBJECT (pad, "Making iterator");
3220
3221     cookie = &parent->pads_cookie;
3222     owner = parent;
3223     dispose = (GstIteratorDisposeFunction) gst_object_unref;
3224     lock = GST_OBJECT_GET_LOCK (parent);
3225   }
3226
3227   res = gst_iterator_new_list (GST_TYPE_PAD,
3228       lock, cookie, padlist, owner, (GstIteratorItemFunction) iterate_pad,
3229       dispose);
3230
3231   return res;
3232
3233   /* ERRORS */
3234 no_parent:
3235   {
3236     GST_OBJECT_UNLOCK (pad);
3237     GST_DEBUG_OBJECT (pad, "no parent element");
3238     return NULL;
3239   }
3240 }
3241
3242 /**
3243  * gst_pad_iterate_internal_links:
3244  * @pad: the GstPad to get the internal links of.
3245  *
3246  * Gets an iterator for the pads to which the given pad is linked to inside
3247  * of the parent element.
3248  *
3249  * Each #GstPad element yielded by the iterator will have its refcount increased,
3250  * so unref after use.
3251  *
3252  * Returns: a new #GstIterator of #GstPad or %NULL when the pad does not have an
3253  * iterator function configured. Use gst_iterator_free() after usage.
3254  *
3255  * Since: 0.10.21
3256  */
3257 GstIterator *
3258 gst_pad_iterate_internal_links (GstPad * pad)
3259 {
3260   GstIterator *res = NULL;
3261
3262   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3263
3264   if (GST_PAD_ITERINTLINKFUNC (pad))
3265     res = GST_PAD_ITERINTLINKFUNC (pad) (pad);
3266
3267   return res;
3268 }
3269
3270 #ifndef GST_REMOVE_DEPRECATED
3271 static void
3272 add_unref_pad_to_list (GstPad * pad, GList * list)
3273 {
3274   list = g_list_prepend (list, pad);
3275   gst_object_unref (pad);
3276 }
3277 #endif
3278
3279 /**
3280  * gst_pad_get_internal_links_default:
3281  * @pad: the #GstPad to get the internal links of.
3282  *
3283  * Gets a list of pads to which the given pad is linked to
3284  * inside of the parent element.
3285  * This is the default handler, and thus returns a list of all of the
3286  * pads inside the parent element with opposite direction.
3287  *
3288  * The caller must free this list after use with g_list_free().
3289  *
3290  * Returns: a newly allocated #GList of pads, or NULL if the pad has no parent.
3291  *
3292  * Not MT safe.
3293  *
3294  * Deprecated: This function does not ref the pads in the list so that they
3295  * could become invalid by the time the application accesses them. It's also
3296  * possible that the list changes while handling the pads, which the caller of
3297  * this function is unable to know. Use the thread-safe 
3298  * gst_pad_iterate_internal_links_default() instead.
3299  */
3300 #ifndef GST_REMOVE_DEPRECATED
3301 GList *
3302 gst_pad_get_internal_links_default (GstPad * pad)
3303 {
3304   GList *res = NULL;
3305   GstElement *parent;
3306
3307   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3308
3309   GST_WARNING_OBJECT (pad, "Unsafe internal links used");
3310
3311   /* when we get here, the default handler for get_internal_links is called,
3312    * which means that the user has not installed a custom one. We first check if
3313    * there is maybe a custom iterate function we can call. */
3314   if (GST_PAD_ITERINTLINKFUNC (pad) &&
3315       GST_PAD_ITERINTLINKFUNC (pad) != gst_pad_iterate_internal_links_default) {
3316     GstIterator *it;
3317     GstIteratorResult ires;
3318     gboolean done = FALSE;
3319
3320     it = gst_pad_iterate_internal_links (pad);
3321     /* loop over the iterator and put all elements into a list, we also
3322      * immediatly unref them, which is bad. */
3323     do {
3324       ires = gst_iterator_foreach (it, (GFunc) add_unref_pad_to_list, res);
3325       switch (ires) {
3326         case GST_ITERATOR_OK:
3327         case GST_ITERATOR_DONE:
3328         case GST_ITERATOR_ERROR:
3329           done = TRUE;
3330           break;
3331         case GST_ITERATOR_RESYNC:
3332           /* restart, discard previous list */
3333           gst_iterator_resync (it);
3334           g_list_free (res);
3335           res = NULL;
3336           break;
3337       }
3338     } while (!done);
3339
3340     gst_iterator_free (it);
3341   } else {
3342     /* lock pad, check and ref parent */
3343     GST_OBJECT_LOCK (pad);
3344     parent = GST_PAD_PARENT (pad);
3345     if (!parent || !GST_IS_ELEMENT (parent))
3346       goto no_parent;
3347
3348     parent = gst_object_ref (parent);
3349     GST_OBJECT_UNLOCK (pad);
3350
3351     /* now lock the parent while we copy the pads */
3352     GST_OBJECT_LOCK (parent);
3353     if (pad->direction == GST_PAD_SRC)
3354       res = g_list_copy (parent->sinkpads);
3355     else
3356       res = g_list_copy (parent->srcpads);
3357     GST_OBJECT_UNLOCK (parent);
3358
3359     gst_object_unref (parent);
3360   }
3361
3362   /* At this point pads can be changed and unreffed. Nothing we can do about it
3363    * because for compatibility reasons this function cannot ref the pads or
3364    * notify the app that the list changed. */
3365
3366   return res;
3367
3368 no_parent:
3369   {
3370     GST_DEBUG_OBJECT (pad, "no parent");
3371     GST_OBJECT_UNLOCK (pad);
3372     return NULL;
3373   }
3374 }
3375 #endif /* GST_REMOVE_DEPRECATED */
3376
3377 /**
3378  * gst_pad_get_internal_links:
3379  * @pad: the #GstPad to get the internal links of.
3380  *
3381  * Gets a list of pads to which the given pad is linked to
3382  * inside of the parent element.
3383  * The caller must free this list after use.
3384  *
3385  * Not MT safe.
3386  *
3387  * Returns: a newly allocated #GList of pads, free with g_list_free().
3388  * 
3389  * Deprecated: This function does not ref the pads in the list so that they
3390  * could become invalid by the time the application accesses them. It's also
3391  * possible that the list changes while handling the pads, which the caller of
3392  * this function is unable to know. Use the thread-safe 
3393  * gst_pad_iterate_internal_links() instead.
3394  */
3395 #ifndef GST_REMOVE_DEPRECATED
3396 #ifdef GST_DISABLE_DEPRECATED
3397 GList *gst_pad_get_internal_links (GstPad * pad);
3398 #endif
3399 GList *
3400 gst_pad_get_internal_links (GstPad * pad)
3401 {
3402   GList *res = NULL;
3403
3404   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3405
3406   GST_WARNING_OBJECT (pad, "Calling unsafe internal links");
3407
3408   if (GST_PAD_INTLINKFUNC (pad))
3409     res = GST_PAD_INTLINKFUNC (pad) (pad);
3410
3411   return res;
3412 }
3413 #endif /* GST_REMOVE_DEPRECATED */
3414
3415 static gboolean
3416 gst_pad_event_default_dispatch (GstPad * pad, GstEvent * event)
3417 {
3418   gboolean result = FALSE;
3419   GstIterator *iter;
3420   gboolean done = FALSE;
3421   gpointer item;
3422   GstPad *eventpad;
3423   GList *pushed_pads = NULL;
3424
3425   GST_INFO_OBJECT (pad, "Sending event %p (%s) to all internally linked pads",
3426       event, GST_EVENT_TYPE_NAME (event));
3427
3428   iter = gst_pad_iterate_internal_links (pad);
3429
3430   if (!iter)
3431     goto no_iter;
3432
3433   while (!done) {
3434     switch (gst_iterator_next (iter, &item)) {
3435       case GST_ITERATOR_OK:
3436         eventpad = GST_PAD_CAST (item);
3437
3438         /* if already pushed,  skip */
3439         if (g_list_find (pushed_pads, eventpad)) {
3440           gst_object_unref (item);
3441           break;
3442         }
3443
3444         if (GST_PAD_IS_SRC (eventpad)) {
3445           /* for each pad we send to, we should ref the event; it's up
3446            * to downstream to unref again when handled. */
3447           GST_LOG_OBJECT (pad, "Reffing and sending event %p (%s) to %s:%s",
3448               event, GST_EVENT_TYPE_NAME (event),
3449               GST_DEBUG_PAD_NAME (eventpad));
3450           gst_event_ref (event);
3451           result |= gst_pad_push_event (eventpad, event);
3452         } else {
3453           /* we only send the event on one pad, multi-sinkpad elements
3454            * should implement a handler */
3455           GST_LOG_OBJECT (pad, "sending event %p (%s) to one sink pad %s:%s",
3456               event, GST_EVENT_TYPE_NAME (event),
3457               GST_DEBUG_PAD_NAME (eventpad));
3458           result = gst_pad_push_event (eventpad, event);
3459           done = TRUE;
3460           event = NULL;
3461         }
3462
3463         pushed_pads = g_list_prepend (pushed_pads, eventpad);
3464
3465         gst_object_unref (item);
3466         break;
3467       case GST_ITERATOR_RESYNC:
3468         /* FIXME, if we want to reset the result value we need to remember which
3469          * pads pushed with which result */
3470         gst_iterator_resync (iter);
3471         break;
3472       case GST_ITERATOR_ERROR:
3473         GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
3474         done = TRUE;
3475         break;
3476       case GST_ITERATOR_DONE:
3477         done = TRUE;
3478         break;
3479     }
3480   }
3481   gst_iterator_free (iter);
3482
3483 no_iter:
3484
3485   /* If this is a sinkpad and we don't have pads to send the event to, we
3486    * return TRUE. This is so that when using the default handler on a sink
3487    * element, we don't fail to push it. */
3488   if (!pushed_pads)
3489     result = GST_PAD_IS_SINK (pad);
3490
3491   g_list_free (pushed_pads);
3492
3493   /* we handled the incoming event so we unref once */
3494   if (event) {
3495     GST_LOG_OBJECT (pad, "handled event %p, unreffing", event);
3496     gst_event_unref (event);
3497   }
3498
3499   return result;
3500 }
3501
3502 /**
3503  * gst_pad_event_default:
3504  * @pad: a #GstPad to call the default event handler on.
3505  * @event: the #GstEvent to handle.
3506  *
3507  * Invokes the default event handler for the given pad. End-of-stream and
3508  * discontinuity events are handled specially, and then the event is sent to all
3509  * pads internally linked to @pad. Note that if there are many possible sink
3510  * pads that are internally linked to @pad, only one will be sent an event.
3511  * Multi-sinkpad elements should implement custom event handlers.
3512  *
3513  * Returns: TRUE if the event was sent succesfully.
3514  */
3515 gboolean
3516 gst_pad_event_default (GstPad * pad, GstEvent * event)
3517 {
3518   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3519   g_return_val_if_fail (event != NULL, FALSE);
3520
3521   GST_LOG_OBJECT (pad, "default event handler");
3522
3523   switch (GST_EVENT_TYPE (event)) {
3524     case GST_EVENT_EOS:
3525     {
3526       GST_DEBUG_OBJECT (pad, "pausing task because of eos");
3527       gst_pad_pause_task (pad);
3528     }
3529       /* fall thru */
3530     default:
3531       break;
3532   }
3533
3534   return gst_pad_event_default_dispatch (pad, event);
3535 }
3536
3537 /**
3538  * gst_pad_dispatcher:
3539  * @pad: a #GstPad to dispatch.
3540  * @dispatch: the #GstPadDispatcherFunction to call.
3541  * @data: gpointer user data passed to the dispatcher function.
3542  *
3543  * Invokes the given dispatcher function on each respective peer of
3544  * all pads that are internally linked to the given pad.
3545  * The GstPadDispatcherFunction should return TRUE when no further pads
3546  * need to be processed.
3547  *
3548  * Returns: TRUE if one of the dispatcher functions returned TRUE.
3549  */
3550 gboolean
3551 gst_pad_dispatcher (GstPad * pad, GstPadDispatcherFunction dispatch,
3552     gpointer data)
3553 {
3554   gboolean res = FALSE;
3555   GstIterator *iter = NULL;
3556   gboolean done = FALSE;
3557   gpointer item;
3558
3559   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3560   g_return_val_if_fail (dispatch != NULL, FALSE);
3561
3562   iter = gst_pad_iterate_internal_links (pad);
3563
3564   if (!iter)
3565     goto no_iter;
3566
3567   while (!done) {
3568     switch (gst_iterator_next (iter, &item)) {
3569       case GST_ITERATOR_OK:
3570       {
3571         GstPad *int_pad = GST_PAD_CAST (item);
3572         GstPad *int_peer = gst_pad_get_peer (int_pad);
3573
3574         if (int_peer) {
3575           GST_DEBUG_OBJECT (int_pad, "dispatching to peer %s:%s",
3576               GST_DEBUG_PAD_NAME (int_peer));
3577           done = res = dispatch (int_peer, data);
3578           gst_object_unref (int_peer);
3579         } else {
3580           GST_DEBUG_OBJECT (int_pad, "no peer");
3581         }
3582       }
3583         gst_object_unref (item);
3584         break;
3585       case GST_ITERATOR_RESYNC:
3586         gst_iterator_resync (iter);
3587         break;
3588       case GST_ITERATOR_ERROR:
3589         done = TRUE;
3590         GST_ERROR_OBJECT (pad, "Could not iterate internally linked pads");
3591         break;
3592       case GST_ITERATOR_DONE:
3593         done = TRUE;
3594         break;
3595     }
3596   }
3597   gst_iterator_free (iter);
3598
3599   GST_DEBUG_OBJECT (pad, "done, result %d", res);
3600
3601 no_iter:
3602
3603   return res;
3604 }
3605
3606 /**
3607  * gst_pad_query:
3608  * @pad: a #GstPad to invoke the default query on.
3609  * @query: the #GstQuery to perform.
3610  *
3611  * Dispatches a query to a pad. The query should have been allocated by the
3612  * caller via one of the type-specific allocation functions in gstquery.h. The
3613  * element is responsible for filling the query with an appropriate response,
3614  * which should then be parsed with a type-specific query parsing function.
3615  *
3616  * Again, the caller is responsible for both the allocation and deallocation of
3617  * the query structure.
3618  *
3619  * Returns: TRUE if the query could be performed.
3620  */
3621 gboolean
3622 gst_pad_query (GstPad * pad, GstQuery * query)
3623 {
3624   GstPadQueryFunction func;
3625
3626   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3627   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3628
3629   GST_DEBUG_OBJECT (pad, "sending query %p", query);
3630
3631   if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3632     goto no_func;
3633
3634   return func (pad, query);
3635
3636 no_func:
3637   {
3638     GST_DEBUG_OBJECT (pad, "had no query function");
3639     return FALSE;
3640   }
3641 }
3642
3643 /**
3644  * gst_pad_peer_query:
3645  * @pad: a #GstPad to invoke the peer query on.
3646  * @query: the #GstQuery to perform.
3647  *
3648  * Performs gst_pad_query() on the peer of @pad.
3649  *
3650  * The caller is responsible for both the allocation and deallocation of
3651  * the query structure.
3652  *
3653  * Returns: TRUE if the query could be performed. This function returns %FALSE
3654  * if @pad has no peer.
3655  *
3656  * Since: 0.10.15
3657  */
3658 gboolean
3659 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3660 {
3661   GstPad *peerpad;
3662   gboolean result;
3663
3664   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3665   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3666
3667   GST_OBJECT_LOCK (pad);
3668
3669   GST_DEBUG_OBJECT (pad, "peer query");
3670
3671   peerpad = GST_PAD_PEER (pad);
3672   if (G_UNLIKELY (peerpad == NULL))
3673     goto no_peer;
3674
3675   gst_object_ref (peerpad);
3676   GST_OBJECT_UNLOCK (pad);
3677
3678   result = gst_pad_query (peerpad, query);
3679
3680   gst_object_unref (peerpad);
3681
3682   return result;
3683
3684   /* ERRORS */
3685 no_peer:
3686   {
3687     GST_WARNING_OBJECT (pad, "pad has no peer");
3688     GST_OBJECT_UNLOCK (pad);
3689     return FALSE;
3690   }
3691 }
3692
3693 /**
3694  * gst_pad_query_default:
3695  * @pad: a #GstPad to call the default query handler on.
3696  * @query: the #GstQuery to handle.
3697  *
3698  * Invokes the default query handler for the given pad.
3699  * The query is sent to all pads internally linked to @pad. Note that
3700  * if there are many possible sink pads that are internally linked to
3701  * @pad, only one will be sent the query.
3702  * Multi-sinkpad elements should implement custom query handlers.
3703  *
3704  * Returns: TRUE if the query was performed succesfully.
3705  */
3706 gboolean
3707 gst_pad_query_default (GstPad * pad, GstQuery * query)
3708 {
3709   switch (GST_QUERY_TYPE (query)) {
3710     case GST_QUERY_POSITION:
3711     case GST_QUERY_SEEKING:
3712     case GST_QUERY_FORMATS:
3713     case GST_QUERY_LATENCY:
3714     case GST_QUERY_JITTER:
3715     case GST_QUERY_RATE:
3716     case GST_QUERY_CONVERT:
3717     default:
3718       return gst_pad_dispatcher
3719           (pad, (GstPadDispatcherFunction) gst_pad_query, query);
3720   }
3721 }
3722
3723 #ifndef GST_DISABLE_LOADSAVE
3724 /* FIXME: why isn't this on a GstElement ? */
3725 /**
3726  * gst_pad_load_and_link:
3727  * @self: an #xmlNodePtr to read the description from.
3728  * @parent: the #GstObject element that owns the pad.
3729  *
3730  * Reads the pad definition from the XML node and links the given pad
3731  * in the element to a pad of an element up in the hierarchy.
3732  */
3733 void
3734 gst_pad_load_and_link (xmlNodePtr self, GstObject * parent)
3735 {
3736   xmlNodePtr field = self->xmlChildrenNode;
3737   GstPad *pad = NULL, *targetpad;
3738   GstPadTemplate *tmpl;
3739   gchar *peer = NULL;
3740   gchar **split;
3741   GstElement *target;
3742   GstObject *grandparent;
3743   gchar *name = NULL;
3744
3745   while (field) {
3746     if (!strcmp ((char *) field->name, "name")) {
3747       name = (gchar *) xmlNodeGetContent (field);
3748       pad = gst_element_get_static_pad (GST_ELEMENT (parent), name);
3749       if ((!pad) || ((tmpl = gst_pad_get_pad_template (pad))
3750               && (GST_PAD_REQUEST == GST_PAD_TEMPLATE_PRESENCE (tmpl))))
3751         pad = gst_element_get_request_pad (GST_ELEMENT (parent), name);
3752       g_free (name);
3753     } else if (!strcmp ((char *) field->name, "peer")) {
3754       peer = (gchar *) xmlNodeGetContent (field);
3755     }
3756     field = field->next;
3757   }
3758   g_return_if_fail (pad != NULL);
3759
3760   if (peer == NULL)
3761     return;
3762
3763   split = g_strsplit (peer, ".", 2);
3764
3765   if (split[0] == NULL || split[1] == NULL) {
3766     GST_CAT_DEBUG_OBJECT (GST_CAT_XML, pad,
3767         "Could not parse peer '%s', leaving unlinked", peer);
3768
3769     g_free (peer);
3770     return;
3771   }
3772   g_free (peer);
3773
3774   g_return_if_fail (split[0] != NULL);
3775   g_return_if_fail (split[1] != NULL);
3776
3777   grandparent = gst_object_get_parent (parent);
3778
3779   if (grandparent && GST_IS_BIN (grandparent)) {
3780     target = gst_bin_get_by_name_recurse_up (GST_BIN (grandparent), split[0]);
3781   } else
3782     goto cleanup;
3783
3784   if (target == NULL)
3785     goto cleanup;
3786
3787   targetpad = gst_element_get_static_pad (target, split[1]);
3788   if (!targetpad)
3789     targetpad = gst_element_get_request_pad (target, split[1]);
3790
3791   if (targetpad == NULL)
3792     goto cleanup;
3793
3794   if (gst_pad_get_direction (pad) == GST_PAD_SRC)
3795     gst_pad_link (pad, targetpad);
3796   else
3797     gst_pad_link (targetpad, pad);
3798
3799 cleanup:
3800   g_strfreev (split);
3801 }
3802
3803 /**
3804  * gst_pad_save_thyself:
3805  * @pad: a #GstPad to save.
3806  * @parent: the parent #xmlNodePtr to save the description in.
3807  *
3808  * Saves the pad into an xml representation.
3809  *
3810  * Returns: the #xmlNodePtr representation of the pad.
3811  */
3812 static xmlNodePtr
3813 gst_pad_save_thyself (GstObject * object, xmlNodePtr parent)
3814 {
3815   GstPad *pad;
3816   GstPad *peer;
3817
3818   g_return_val_if_fail (GST_IS_PAD (object), NULL);
3819
3820   pad = GST_PAD_CAST (object);
3821
3822   xmlNewChild (parent, NULL, (xmlChar *) "name",
3823       (xmlChar *) GST_PAD_NAME (pad));
3824
3825   if (GST_PAD_IS_SRC (pad)) {
3826     xmlNewChild (parent, NULL, (xmlChar *) "direction", (xmlChar *) "source");
3827   } else if (GST_PAD_IS_SINK (pad)) {
3828     xmlNewChild (parent, NULL, (xmlChar *) "direction", (xmlChar *) "sink");
3829   } else {
3830     xmlNewChild (parent, NULL, (xmlChar *) "direction", (xmlChar *) "unknown");
3831   }
3832
3833   if (GST_PAD_PEER (pad) != NULL) {
3834     gchar *content;
3835
3836     peer = GST_PAD_PEER (pad);
3837     /* first check to see if the peer's parent's parent is the same */
3838     /* we just save it off */
3839     content = g_strdup_printf ("%s.%s",
3840         GST_OBJECT_NAME (GST_PAD_PARENT (peer)), GST_PAD_NAME (peer));
3841     xmlNewChild (parent, NULL, (xmlChar *) "peer", (xmlChar *) content);
3842     g_free (content);
3843   } else
3844     xmlNewChild (parent, NULL, (xmlChar *) "peer", NULL);
3845
3846   return parent;
3847 }
3848
3849 #if 0
3850 /**
3851  * gst_ghost_pad_save_thyself:
3852  * @pad: a ghost #GstPad to save.
3853  * @parent: the parent #xmlNodePtr to save the description in.
3854  *
3855  * Saves the ghost pad into an xml representation.
3856  *
3857  * Returns: the #xmlNodePtr representation of the pad.
3858  */
3859 xmlNodePtr
3860 gst_ghost_pad_save_thyself (GstPad * pad, xmlNodePtr parent)
3861 {
3862   xmlNodePtr self;
3863
3864   g_return_val_if_fail (GST_IS_GHOST_PAD (pad), NULL);
3865
3866   self = xmlNewChild (parent, NULL, (xmlChar *) "ghostpad", NULL);
3867   xmlNewChild (self, NULL, (xmlChar *) "name", (xmlChar *) GST_PAD_NAME (pad));
3868   xmlNewChild (self, NULL, (xmlChar *) "parent",
3869       (xmlChar *) GST_OBJECT_NAME (GST_PAD_PARENT (pad)));
3870
3871   /* FIXME FIXME FIXME! */
3872
3873   return self;
3874 }
3875 #endif /* 0 */
3876 #endif /* GST_DISABLE_LOADSAVE */
3877
3878 /*
3879  * should be called with pad OBJECT_LOCK and STREAM_LOCK held.
3880  * GST_PAD_IS_BLOCKED (pad) == TRUE when this function is
3881  * called.
3882  *
3883  * This function performs the pad blocking when an event, buffer push
3884  * or buffer_alloc is performed on a _SRC_ pad. It blocks the
3885  * streaming thread after informing the pad has been blocked.
3886  *
3887  * An application can with this method wait and block any streaming
3888  * thread and perform operations such as seeking or linking.
3889  *
3890  * Two methods are available for notifying the application of the
3891  * block:
3892  * - the callback method, which happens in the STREAMING thread with
3893  *   the STREAM_LOCK held. With this method, the most useful way of
3894  *   dealing with the callback is to post a message to the main thread
3895  *   where the pad block can then be handled outside of the streaming
3896  *   thread. With the last method one can perform all operations such
3897  *   as doing a state change, linking, unblocking, seeking etc on the
3898  *   pad.
3899  * - the GCond signal method, which makes any thread unblock when
3900  *   the pad block happens.
3901  *
3902  * During the actual blocking state, the GST_PAD_BLOCKING flag is set.
3903  * The GST_PAD_BLOCKING flag is unset when the pad was unblocked.
3904  *
3905  * MT safe.
3906  */
3907 static GstFlowReturn
3908 handle_pad_block (GstPad * pad)
3909 {
3910   GstPadBlockCallback callback;
3911   gpointer user_data;
3912   GstFlowReturn ret = GST_FLOW_OK;
3913
3914   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "signal block taken");
3915
3916   /* flushing, don't bother trying to block and return WRONG_STATE
3917    * right away */
3918   if (GST_PAD_IS_FLUSHING (pad))
3919     goto flushingnonref;
3920
3921   /* we grab an extra ref for the callbacks, this is probably not
3922    * needed (callback code does not have a ref and cannot unref). I
3923    * think this was done to make it possible to unref the element in
3924    * the callback, which is in the end totally impossible as it
3925    * requires grabbing the STREAM_LOCK and OBJECT_LOCK which are
3926    * all taken when calling this function. */
3927   gst_object_ref (pad);
3928
3929   while (GST_PAD_IS_BLOCKED (pad)) {
3930     do {
3931       /* we either have a callback installed to notify the block or
3932        * some other thread is doing a GCond wait. */
3933       callback = pad->block_callback;
3934       pad->abidata.ABI.block_callback_called = TRUE;
3935       if (callback) {
3936         /* there is a callback installed, call it. We release the
3937          * lock so that the callback can do something usefull with the
3938          * pad */
3939         user_data = pad->block_data;
3940         GST_OBJECT_UNLOCK (pad);
3941         callback (pad, TRUE, user_data);
3942         GST_OBJECT_LOCK (pad);
3943
3944         /* we released the lock, recheck flushing */
3945         if (GST_PAD_IS_FLUSHING (pad))
3946           goto flushing;
3947       } else {
3948         /* no callback, signal the thread that is doing a GCond wait
3949          * if any. */
3950         GST_PAD_BLOCK_BROADCAST (pad);
3951       }
3952     } while (pad->abidata.ABI.block_callback_called == FALSE
3953         && GST_PAD_IS_BLOCKED (pad));
3954
3955     /* OBJECT_LOCK could have been released when we did the callback, which
3956      * then could have made the pad unblock so we need to check the blocking
3957      * condition again.   */
3958     if (!GST_PAD_IS_BLOCKED (pad))
3959       break;
3960
3961     /* now we block the streaming thread. It can be unlocked when we
3962      * deactivate the pad (which will also set the FLUSHING flag) or
3963      * when the pad is unblocked. A flushing event will also unblock
3964      * the pad after setting the FLUSHING flag. */
3965     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3966         "Waiting to be unblocked or set flushing");
3967     GST_OBJECT_FLAG_SET (pad, GST_PAD_BLOCKING);
3968     GST_PAD_BLOCK_WAIT (pad);
3969     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_BLOCKING);
3970
3971     /* see if we got unblocked by a flush or not */
3972     if (GST_PAD_IS_FLUSHING (pad))
3973       goto flushing;
3974   }
3975
3976   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got unblocked");
3977
3978   /* when we get here, the pad is unblocked again and we perform
3979    * the needed unblock code. */
3980   callback = pad->block_callback;
3981   if (callback) {
3982     /* we need to call the callback */
3983     user_data = pad->block_data;
3984     GST_OBJECT_UNLOCK (pad);
3985     callback (pad, FALSE, user_data);
3986     GST_OBJECT_LOCK (pad);
3987   } else {
3988     /* we need to signal the thread waiting on the GCond */
3989     GST_PAD_BLOCK_BROADCAST (pad);
3990   }
3991
3992   gst_object_unref (pad);
3993
3994   return ret;
3995
3996 flushingnonref:
3997   {
3998     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pad was flushing");
3999     return GST_FLOW_WRONG_STATE;
4000   }
4001 flushing:
4002   {
4003     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pad became flushing");
4004     gst_object_unref (pad);
4005     return GST_FLOW_WRONG_STATE;
4006   }
4007 }
4008
4009 /**********************************************************************
4010  * Data passing functions
4011  */
4012
4013 static gboolean
4014 gst_pad_emit_have_data_signal (GstPad * pad, GstMiniObject * obj)
4015 {
4016   GValue ret = { 0 };
4017   GValue args[2] = { {0}, {0} };
4018   gboolean res;
4019   GQuark detail;
4020
4021   /* init */
4022   g_value_init (&ret, G_TYPE_BOOLEAN);
4023   g_value_set_boolean (&ret, TRUE);
4024   g_value_init (&args[0], GST_TYPE_PAD);
4025   g_value_set_object (&args[0], pad);
4026   g_value_init (&args[1], GST_TYPE_MINI_OBJECT);
4027   gst_value_set_mini_object (&args[1], obj);
4028
4029   if (GST_IS_EVENT (obj))
4030     detail = event_quark;
4031   else
4032     detail = buffer_quark;
4033
4034   /* actually emit */
4035   g_signal_emitv (args, gst_pad_signals[PAD_HAVE_DATA], detail, &ret);
4036   res = g_value_get_boolean (&ret);
4037
4038   /* clean up */
4039   g_value_unset (&ret);
4040   g_value_unset (&args[0]);
4041   g_value_unset (&args[1]);
4042
4043   return res;
4044 }
4045
4046 static void
4047 gst_pad_data_unref (gboolean is_buffer, void *data)
4048 {
4049   if (G_LIKELY (is_buffer)) {
4050     gst_buffer_unref (data);
4051   } else {
4052     gst_buffer_list_unref (data);
4053   }
4054 }
4055
4056 static GstCaps *
4057 gst_pad_data_get_caps (gboolean is_buffer, void *data)
4058 {
4059   GstCaps *caps;
4060
4061   if (G_LIKELY (is_buffer)) {
4062     caps = GST_BUFFER_CAPS (data);
4063   } else {
4064     GstBuffer *buf;
4065
4066     if ((buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (data), 0, 0)))
4067       caps = GST_BUFFER_CAPS (buf);
4068     else
4069       caps = NULL;
4070   }
4071   return caps;
4072 }
4073
4074 /* this is the chain function that does not perform the additional argument
4075  * checking for that little extra speed.
4076  */
4077 static inline GstFlowReturn
4078 gst_pad_chain_data_unchecked (GstPad * pad, gboolean is_buffer, void *data)
4079 {
4080   GstCaps *caps;
4081   gboolean caps_changed;
4082   GstFlowReturn ret;
4083   gboolean emit_signal;
4084
4085   GST_PAD_STREAM_LOCK (pad);
4086
4087   GST_OBJECT_LOCK (pad);
4088   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4089     goto flushing;
4090
4091   caps = gst_pad_data_get_caps (is_buffer, data);
4092   caps_changed = caps && caps != GST_PAD_CAPS (pad);
4093
4094   emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
4095   GST_OBJECT_UNLOCK (pad);
4096
4097   /* see if the signal should be emited, we emit before caps nego as
4098    * we might drop the buffer and do capsnego for nothing. */
4099   if (G_UNLIKELY (emit_signal)) {
4100     if (G_LIKELY (is_buffer)) {
4101       if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (data)))
4102         goto dropping;
4103     } else {
4104       /* chain all groups in the buffer list one by one to avoid problems with
4105        * buffer probes that push buffers or events */
4106       goto chain_groups;
4107     }
4108   }
4109
4110   /* we got a new datatype on the pad, see if it can handle it */
4111   if (G_UNLIKELY (caps_changed)) {
4112     GST_DEBUG_OBJECT (pad, "caps changed to %p %" GST_PTR_FORMAT, caps, caps);
4113     if (G_UNLIKELY (!gst_pad_configure_sink (pad, caps)))
4114       goto not_negotiated;
4115   }
4116
4117   /* NOTE: we read the chainfunc unlocked.
4118    * we cannot hold the lock for the pad so we might send
4119    * the data to the wrong function. This is not really a
4120    * problem since functions are assigned at creation time
4121    * and don't change that often... */
4122   if (G_LIKELY (is_buffer)) {
4123     GstPadChainFunction chainfunc;
4124
4125     if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
4126       goto no_function;
4127
4128     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4129         "calling chainfunction &%s", GST_DEBUG_FUNCPTR_NAME (chainfunc));
4130
4131     ret = chainfunc (pad, GST_BUFFER_CAST (data));
4132
4133     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4134         "called chainfunction &%s, returned %s",
4135         GST_DEBUG_FUNCPTR_NAME (chainfunc), gst_flow_get_name (ret));
4136   } else {
4137     GstPadChainListFunction chainlistfunc;
4138
4139     if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
4140       goto chain_groups;
4141
4142     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4143         "calling chainlistfunction &%s",
4144         GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
4145
4146     ret = chainlistfunc (pad, GST_BUFFER_LIST_CAST (data));
4147
4148     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4149         "called chainlistfunction &%s, returned %s",
4150         GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
4151   }
4152
4153   GST_PAD_STREAM_UNLOCK (pad);
4154
4155   return ret;
4156
4157 chain_groups:
4158   {
4159     GstBufferList *list;
4160     GstBufferListIterator *it;
4161     GstBuffer *group;
4162
4163     GST_PAD_STREAM_UNLOCK (pad);
4164
4165     GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
4166
4167     list = GST_BUFFER_LIST_CAST (data);
4168     it = gst_buffer_list_iterate (list);
4169
4170     if (gst_buffer_list_iterator_next_group (it)) {
4171       do {
4172         group = gst_buffer_list_iterator_merge_group (it);
4173         if (group == NULL) {
4174           group = gst_buffer_new ();
4175           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
4176         } else {
4177           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
4178         }
4179         ret = gst_pad_chain_data_unchecked (pad, TRUE, group);
4180       } while (ret == GST_FLOW_OK && gst_buffer_list_iterator_next_group (it));
4181     } else {
4182       GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
4183       ret = gst_pad_chain_data_unchecked (pad, TRUE, gst_buffer_new ());
4184     }
4185
4186     gst_buffer_list_iterator_free (it);
4187     gst_buffer_list_unref (list);
4188
4189     return ret;
4190   }
4191
4192   /* ERRORS */
4193 flushing:
4194   {
4195     gst_pad_data_unref (is_buffer, data);
4196     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4197         "pushing, but pad was flushing");
4198     GST_OBJECT_UNLOCK (pad);
4199     GST_PAD_STREAM_UNLOCK (pad);
4200     return GST_FLOW_WRONG_STATE;
4201   }
4202 dropping:
4203   {
4204     gst_pad_data_unref (is_buffer, data);
4205     GST_DEBUG_OBJECT (pad, "Dropping buffer due to FALSE probe return");
4206     GST_PAD_STREAM_UNLOCK (pad);
4207     return GST_FLOW_OK;
4208   }
4209 not_negotiated:
4210   {
4211     gst_pad_data_unref (is_buffer, data);
4212     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4213         "pushing data but pad did not accept");
4214     GST_PAD_STREAM_UNLOCK (pad);
4215     return GST_FLOW_NOT_NEGOTIATED;
4216   }
4217 no_function:
4218   {
4219     gst_pad_data_unref (is_buffer, data);
4220     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4221         "pushing, but not chainhandler");
4222     GST_ELEMENT_ERROR (GST_PAD_PARENT (pad), CORE, PAD, (NULL),
4223         ("push on pad %s:%s but it has no chainfunction",
4224             GST_DEBUG_PAD_NAME (pad)));
4225     GST_PAD_STREAM_UNLOCK (pad);
4226     return GST_FLOW_NOT_SUPPORTED;
4227   }
4228 }
4229
4230 /**
4231  * gst_pad_chain:
4232  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4233  * @buffer: the #GstBuffer to send, return GST_FLOW_ERROR if not.
4234  *
4235  * Chain a buffer to @pad.
4236  *
4237  * The function returns #GST_FLOW_WRONG_STATE if the pad was flushing.
4238  *
4239  * If the caps on @buffer are different from the current caps on @pad, this
4240  * function will call any setcaps function (see gst_pad_set_setcaps_function())
4241  * installed on @pad. If the new caps are not acceptable for @pad, this
4242  * function returns #GST_FLOW_NOT_NEGOTIATED.
4243  *
4244  * The function proceeds calling the chain function installed on @pad (see
4245  * gst_pad_set_chain_function()) and the return value of that function is
4246  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4247  * chain function.
4248  *
4249  * In all cases, success or failure, the caller loses its reference to @buffer
4250  * after calling this function.
4251  *
4252  * Returns: a #GstFlowReturn from the pad.
4253  *
4254  * MT safe.
4255  */
4256 GstFlowReturn
4257 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
4258 {
4259   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4260   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4261   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4262
4263   return gst_pad_chain_data_unchecked (pad, TRUE, buffer);
4264 }
4265
4266 /**
4267  * gst_pad_chain_list:
4268  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4269  * @list: the #GstBufferList to send, return GST_FLOW_ERROR if not.
4270  *
4271  * Chain a bufferlist to @pad.
4272  *
4273  * The function returns #GST_FLOW_WRONG_STATE if the pad was flushing.
4274  *
4275  * If the caps on the first buffer of @list are different from the current
4276  * caps on @pad, this function will call any setcaps function
4277  * (see gst_pad_set_setcaps_function()) installed on @pad. If the new caps
4278  * are not acceptable for @pad, this function returns #GST_FLOW_NOT_NEGOTIATED.
4279  *
4280  * The function proceeds calling the chainlist function installed on @pad (see
4281  * gst_pad_set_chain_list_function()) and the return value of that function is
4282  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4283  * chainlist function.
4284  *
4285  * In all cases, success or failure, the caller loses its reference to @list
4286  * after calling this function.
4287  *
4288  * MT safe.
4289  *
4290  * Returns: a #GstFlowReturn from the pad.
4291  *
4292  * Since: 0.10.24
4293  */
4294 GstFlowReturn
4295 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
4296 {
4297   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4298   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4299   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4300
4301   return gst_pad_chain_data_unchecked (pad, FALSE, list);
4302 }
4303
4304 static GstFlowReturn
4305 gst_pad_push_data (GstPad * pad, gboolean is_buffer, void *data)
4306 {
4307   GstPad *peer;
4308   GstFlowReturn ret;
4309   GstCaps *caps;
4310   gboolean caps_changed;
4311
4312   GST_OBJECT_LOCK (pad);
4313
4314   /* FIXME: this check can go away; pad_set_blocked could be implemented with
4315    * probes completely or probes with an extended pad block. */
4316   while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
4317     if ((ret = handle_pad_block (pad)) != GST_FLOW_OK)
4318       goto flushed;
4319
4320   /* we emit signals on the pad arg, the peer will have a chance to
4321    * emit in the _chain() function */
4322   if (G_UNLIKELY (GST_PAD_DO_BUFFER_SIGNALS (pad) > 0)) {
4323     /* unlock before emitting */
4324     GST_OBJECT_UNLOCK (pad);
4325
4326     if (G_LIKELY (is_buffer)) {
4327       /* if the signal handler returned FALSE, it means we should just drop the
4328        * buffer */
4329       if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (data)))
4330         goto dropped;
4331     } else {
4332       /* push all buffers in the list */
4333       goto push_groups;
4334     }
4335     GST_OBJECT_LOCK (pad);
4336   }
4337
4338   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4339     goto not_linked;
4340
4341   /* Before pushing the buffer to the peer pad, ensure that caps
4342    * are set on this pad */
4343   caps = gst_pad_data_get_caps (is_buffer, data);
4344   caps_changed = caps && caps != GST_PAD_CAPS (pad);
4345
4346   /* take ref to peer pad before releasing the lock */
4347   gst_object_ref (peer);
4348
4349   GST_OBJECT_UNLOCK (pad);
4350
4351   /* we got a new datatype from the pad, it had better handle it */
4352   if (G_UNLIKELY (caps_changed)) {
4353     GST_DEBUG_OBJECT (pad,
4354         "caps changed from %" GST_PTR_FORMAT " to %p %" GST_PTR_FORMAT,
4355         GST_PAD_CAPS (pad), caps, caps);
4356     if (G_UNLIKELY (!gst_pad_set_caps (pad, caps)))
4357       goto not_negotiated;
4358   }
4359
4360   ret = gst_pad_chain_data_unchecked (peer, is_buffer, data);
4361
4362   gst_object_unref (peer);
4363
4364   return ret;
4365
4366 push_groups:
4367   {
4368     GstBufferList *list;
4369     GstBufferListIterator *it;
4370     GstBuffer *group;
4371
4372     GST_INFO_OBJECT (pad, "pushing each group in list as a merged buffer");
4373
4374     list = GST_BUFFER_LIST_CAST (data);
4375     it = gst_buffer_list_iterate (list);
4376
4377     if (gst_buffer_list_iterator_next_group (it)) {
4378       do {
4379         group = gst_buffer_list_iterator_merge_group (it);
4380         if (group == NULL) {
4381           group = gst_buffer_new ();
4382           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "pushing empty group");
4383         } else {
4384           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "pushing group");
4385         }
4386         ret = gst_pad_push_data (pad, TRUE, group);
4387       } while (ret == GST_FLOW_OK && gst_buffer_list_iterator_next_group (it));
4388     } else {
4389       GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "pushing empty group");
4390       ret = gst_pad_push_data (pad, TRUE, gst_buffer_new ());
4391     }
4392
4393     gst_buffer_list_iterator_free (it);
4394     gst_buffer_list_unref (list);
4395
4396     return ret;
4397   }
4398
4399   /* ERROR recovery here */
4400 flushed:
4401   {
4402     gst_pad_data_unref (is_buffer, data);
4403     GST_DEBUG_OBJECT (pad, "pad block stopped by flush");
4404     GST_OBJECT_UNLOCK (pad);
4405     return ret;
4406   }
4407 dropped:
4408   {
4409     gst_pad_data_unref (is_buffer, data);
4410     GST_DEBUG_OBJECT (pad, "Dropping buffer due to FALSE probe return");
4411     return GST_FLOW_OK;
4412   }
4413 not_linked:
4414   {
4415     gst_pad_data_unref (is_buffer, data);
4416     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4417         "pushing, but it was not linked");
4418     GST_OBJECT_UNLOCK (pad);
4419     return GST_FLOW_NOT_LINKED;
4420   }
4421 not_negotiated:
4422   {
4423     gst_pad_data_unref (is_buffer, data);
4424     gst_object_unref (peer);
4425     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4426         "element pushed data then refused to accept the caps");
4427     return GST_FLOW_NOT_NEGOTIATED;
4428   }
4429 }
4430
4431 /**
4432  * gst_pad_push:
4433  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4434  * @buffer: the #GstBuffer to push returns GST_FLOW_ERROR if not.
4435  *
4436  * Pushes a buffer to the peer of @pad.
4437  *
4438  * This function will call an installed pad block before triggering any
4439  * installed pad probes.
4440  *
4441  * If the caps on @buffer are different from the currently configured caps on
4442  * @pad, this function will call any installed setcaps function on @pad (see
4443  * gst_pad_set_setcaps_function()). In case of failure to renegotiate the new
4444  * format, this function returns #GST_FLOW_NOT_NEGOTIATED.
4445  *
4446  * The function proceeds calling gst_pad_chain() on the peer pad and returns
4447  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4448  * be returned.
4449  *
4450  * In all cases, success or failure, the caller loses its reference to @buffer
4451  * after calling this function.
4452  *
4453  * Returns: a #GstFlowReturn from the peer pad.
4454  *
4455  * MT safe.
4456  */
4457 GstFlowReturn
4458 gst_pad_push (GstPad * pad, GstBuffer * buffer)
4459 {
4460   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4461   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4462   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4463
4464   return gst_pad_push_data (pad, TRUE, buffer);
4465 }
4466
4467 /**
4468  * gst_pad_push_list:
4469  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4470  * @list: the #GstBufferList to push returns GST_FLOW_ERROR if not.
4471  *
4472  * Pushes a buffer list to the peer of @pad.
4473  *
4474  * This function will call an installed pad block before triggering any
4475  * installed pad probes.
4476  *
4477  * If the caps on the first buffer in the first group of @list are different
4478  * from the currently configured caps on @pad, this function will call any
4479  * installed setcaps function on @pad (see gst_pad_set_setcaps_function()). In
4480  * case of failure to renegotiate the new format, this function returns
4481  * #GST_FLOW_NOT_NEGOTIATED.
4482  *
4483  * If there are any probes installed on @pad every group of the buffer list
4484  * will be merged into a normal #GstBuffer and pushed via gst_pad_push and the
4485  * buffer list will be unreffed.
4486  *
4487  * The function proceeds calling the chain function on the peer pad and returns
4488  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4489  * be returned. If the peer pad does not have any installed chainlist function
4490  * every group buffer of the list will be merged into a normal #GstBuffer and
4491  * chained via gst_pad_chain().
4492  *
4493  * In all cases, success or failure, the caller loses its reference to @list
4494  * after calling this function.
4495  *
4496  * Returns: a #GstFlowReturn from the peer pad.
4497  *
4498  * MT safe.
4499  *
4500  * Since: 0.10.24
4501  */
4502 GstFlowReturn
4503 gst_pad_push_list (GstPad * pad, GstBufferList * list)
4504 {
4505   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4506   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4507   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4508
4509   return gst_pad_push_data (pad, FALSE, list);
4510 }
4511
4512 /**
4513  * gst_pad_check_pull_range:
4514  * @pad: a sink #GstPad.
4515  *
4516  * Checks if a gst_pad_pull_range() can be performed on the peer
4517  * source pad. This function is used by plugins that want to check
4518  * if they can use random access on the peer source pad.
4519  *
4520  * The peer sourcepad can implement a custom #GstPadCheckGetRangeFunction
4521  * if it needs to perform some logic to determine if pull_range is
4522  * possible.
4523  *
4524  * Returns: a gboolean with the result.
4525  *
4526  * MT safe.
4527  */
4528 gboolean
4529 gst_pad_check_pull_range (GstPad * pad)
4530 {
4531   GstPad *peer;
4532   gboolean ret;
4533   GstPadCheckGetRangeFunction checkgetrangefunc;
4534
4535   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4536
4537   GST_OBJECT_LOCK (pad);
4538   if (!GST_PAD_IS_SINK (pad))
4539     goto wrong_direction;
4540
4541   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4542     goto not_connected;
4543
4544   gst_object_ref (peer);
4545   GST_OBJECT_UNLOCK (pad);
4546
4547   /* see note in above function */
4548   if (G_LIKELY ((checkgetrangefunc = peer->checkgetrangefunc) == NULL)) {
4549     /* FIXME, kindoff ghetto */
4550     ret = GST_PAD_GETRANGEFUNC (peer) != NULL;
4551     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4552         "no checkgetrangefunc, assuming %d", ret);
4553   } else {
4554     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4555         "calling checkgetrangefunc %s of peer pad %s:%s",
4556         GST_DEBUG_FUNCPTR_NAME (checkgetrangefunc), GST_DEBUG_PAD_NAME (peer));
4557
4558     ret = checkgetrangefunc (peer);
4559   }
4560
4561   gst_object_unref (peer);
4562
4563   return ret;
4564
4565   /* ERROR recovery here */
4566 wrong_direction:
4567   {
4568     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4569         "checking pull range, but pad must be a sinkpad");
4570     GST_OBJECT_UNLOCK (pad);
4571     return FALSE;
4572   }
4573 not_connected:
4574   {
4575     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4576         "checking pull range, but it was not linked");
4577     GST_OBJECT_UNLOCK (pad);
4578     return FALSE;
4579   }
4580 }
4581
4582 /**
4583  * gst_pad_get_range:
4584  * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4585  * @offset: The start offset of the buffer
4586  * @size: The length of the buffer
4587  * @buffer: a pointer to hold the #GstBuffer, returns #GST_FLOW_ERROR if %NULL.
4588  *
4589  * When @pad is flushing this function returns #GST_FLOW_WRONG_STATE
4590  * immediatly.
4591  *
4592  * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4593  * description of a getrange function. If @pad has no getrange function
4594  * installed (see gst_pad_set_getrange_function()) this function returns
4595  * #GST_FLOW_NOT_SUPPORTED.
4596  *
4597  * This is a lowlevel function. Usualy gst_pad_pull_range() is used.
4598  *
4599  * Returns: a #GstFlowReturn from the pad.
4600  *
4601  * MT safe.
4602  */
4603 GstFlowReturn
4604 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4605     GstBuffer ** buffer)
4606 {
4607   GstFlowReturn ret;
4608   GstPadGetRangeFunction getrangefunc;
4609   gboolean emit_signal;
4610   GstCaps *caps;
4611   gboolean caps_changed;
4612
4613   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4614   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4615   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4616
4617   GST_PAD_STREAM_LOCK (pad);
4618
4619   GST_OBJECT_LOCK (pad);
4620   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4621     goto flushing;
4622
4623   emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
4624   GST_OBJECT_UNLOCK (pad);
4625
4626   if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
4627     goto no_function;
4628
4629   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4630       "calling getrangefunc %s, offset %"
4631       G_GUINT64_FORMAT ", size %u",
4632       GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
4633
4634   ret = getrangefunc (pad, offset, size, buffer);
4635
4636   /* can only fire the signal if we have a valid buffer */
4637   if (G_UNLIKELY (emit_signal) && (ret == GST_FLOW_OK)) {
4638     if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (*buffer)))
4639       goto dropping;
4640   }
4641
4642   GST_PAD_STREAM_UNLOCK (pad);
4643
4644   if (G_UNLIKELY (ret != GST_FLOW_OK))
4645     goto get_range_failed;
4646
4647   GST_OBJECT_LOCK (pad);
4648   /* Before pushing the buffer to the peer pad, ensure that caps
4649    * are set on this pad */
4650   caps = GST_BUFFER_CAPS (*buffer);
4651   caps_changed = caps && caps != GST_PAD_CAPS (pad);
4652   GST_OBJECT_UNLOCK (pad);
4653
4654   if (G_UNLIKELY (caps_changed)) {
4655     GST_DEBUG_OBJECT (pad, "caps changed to %p %" GST_PTR_FORMAT, caps, caps);
4656     /* this should usually work because the element produced the buffer */
4657     if (G_UNLIKELY (!gst_pad_configure_src (pad, caps, TRUE)))
4658       goto not_negotiated;
4659   }
4660   return ret;
4661
4662   /* ERRORS */
4663 flushing:
4664   {
4665     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4666         "pulling range, but pad was flushing");
4667     GST_OBJECT_UNLOCK (pad);
4668     GST_PAD_STREAM_UNLOCK (pad);
4669     return GST_FLOW_WRONG_STATE;
4670   }
4671 no_function:
4672   {
4673     GST_ELEMENT_ERROR (GST_PAD_PARENT (pad), CORE, PAD, (NULL),
4674         ("pullrange on pad %s:%s but it has no getrangefunction",
4675             GST_DEBUG_PAD_NAME (pad)));
4676     GST_PAD_STREAM_UNLOCK (pad);
4677     return GST_FLOW_NOT_SUPPORTED;
4678   }
4679 dropping:
4680   {
4681     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4682         "Dropping data after FALSE probe return");
4683     GST_PAD_STREAM_UNLOCK (pad);
4684     gst_buffer_unref (*buffer);
4685     *buffer = NULL;
4686     return GST_FLOW_UNEXPECTED;
4687   }
4688 get_range_failed:
4689   {
4690     *buffer = NULL;
4691     GST_CAT_WARNING_OBJECT (GST_CAT_SCHEDULING, pad,
4692         "getrange failed %s", gst_flow_get_name (ret));
4693     return ret;
4694   }
4695 not_negotiated:
4696   {
4697     gst_buffer_unref (*buffer);
4698     *buffer = NULL;
4699     GST_CAT_WARNING_OBJECT (GST_CAT_SCHEDULING, pad,
4700         "getrange returned buffer of unaccaptable caps");
4701     return GST_FLOW_NOT_NEGOTIATED;
4702   }
4703 }
4704
4705
4706 /**
4707  * gst_pad_pull_range:
4708  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4709  * @offset: The start offset of the buffer
4710  * @size: The length of the buffer
4711  * @buffer: a pointer to hold the #GstBuffer, returns GST_FLOW_ERROR if %NULL.
4712  *
4713  * Pulls a @buffer from the peer pad.
4714  *
4715  * This function will first trigger the pad block signal if it was
4716  * installed.
4717  *
4718  * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4719  * function returns the result of gst_pad_get_range() on the peer pad.
4720  * See gst_pad_get_range() for a list of return values and for the
4721  * semantics of the arguments of this function.
4722  *
4723  * @buffer's caps must either be unset or the same as what is already
4724  * configured on @pad. Renegotiation within a running pull-mode pipeline is not
4725  * supported.
4726  *
4727  * Returns: a #GstFlowReturn from the peer pad.
4728  * When this function returns #GST_FLOW_OK, @buffer will contain a valid
4729  * #GstBuffer that should be freed with gst_buffer_unref() after usage.
4730  * @buffer may not be used or freed when any other return value than
4731  * #GST_FLOW_OK is returned.
4732  *
4733  * MT safe.
4734  */
4735 GstFlowReturn
4736 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4737     GstBuffer ** buffer)
4738 {
4739   GstPad *peer;
4740   GstFlowReturn ret;
4741   gboolean emit_signal;
4742   GstCaps *caps;
4743   gboolean caps_changed;
4744
4745   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4746   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4747   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4748
4749   GST_OBJECT_LOCK (pad);
4750
4751   while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
4752     handle_pad_block (pad);
4753
4754   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4755     goto not_connected;
4756
4757   /* signal emision for the pad, peer has chance to emit when
4758    * we call _get_range() */
4759   emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
4760
4761   gst_object_ref (peer);
4762   GST_OBJECT_UNLOCK (pad);
4763
4764   ret = gst_pad_get_range (peer, offset, size, buffer);
4765
4766   gst_object_unref (peer);
4767
4768   if (G_UNLIKELY (ret != GST_FLOW_OK))
4769     goto pull_range_failed;
4770
4771   /* can only fire the signal if we have a valid buffer */
4772   if (G_UNLIKELY (emit_signal)) {
4773     if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (*buffer)))
4774       goto dropping;
4775   }
4776
4777   GST_OBJECT_LOCK (pad);
4778   /* Before pushing the buffer to the peer pad, ensure that caps
4779    * are set on this pad */
4780   caps = GST_BUFFER_CAPS (*buffer);
4781   caps_changed = caps && caps != GST_PAD_CAPS (pad);
4782   GST_OBJECT_UNLOCK (pad);
4783
4784   /* we got a new datatype on the pad, see if it can handle it */
4785   if (G_UNLIKELY (caps_changed)) {
4786     GST_DEBUG_OBJECT (pad, "caps changed to %p %" GST_PTR_FORMAT, caps, caps);
4787     if (G_UNLIKELY (!gst_pad_configure_sink (pad, caps)))
4788       goto not_negotiated;
4789   }
4790   return ret;
4791
4792   /* ERROR recovery here */
4793 not_connected:
4794   {
4795     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4796         "pulling range, but it was not linked");
4797     GST_OBJECT_UNLOCK (pad);
4798     return GST_FLOW_NOT_LINKED;
4799   }
4800 pull_range_failed:
4801   {
4802     *buffer = NULL;
4803     GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4804         (ret >= GST_FLOW_UNEXPECTED) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4805         pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4806     return ret;
4807   }
4808 dropping:
4809   {
4810     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4811         "Dropping data after FALSE probe return");
4812     gst_buffer_unref (*buffer);
4813     *buffer = NULL;
4814     return GST_FLOW_UNEXPECTED;
4815   }
4816 not_negotiated:
4817   {
4818     gst_buffer_unref (*buffer);
4819     *buffer = NULL;
4820     GST_CAT_WARNING_OBJECT (GST_CAT_SCHEDULING, pad,
4821         "pullrange returned buffer of different caps");
4822     return GST_FLOW_NOT_NEGOTIATED;
4823   }
4824 }
4825
4826 /**
4827  * gst_pad_push_event:
4828  * @pad: a #GstPad to push the event to.
4829  * @event: the #GstEvent to send to the pad.
4830  *
4831  * Sends the event to the peer of the given pad. This function is
4832  * mainly used by elements to send events to their peer
4833  * elements.
4834  *
4835  * This function takes owership of the provided event so you should
4836  * gst_event_ref() it if you want to reuse the event after this call.
4837  *
4838  * Returns: TRUE if the event was handled.
4839  *
4840  * MT safe.
4841  */
4842 gboolean
4843 gst_pad_push_event (GstPad * pad, GstEvent * event)
4844 {
4845   GstPad *peerpad;
4846   gboolean result;
4847
4848   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4849   g_return_val_if_fail (event != NULL, FALSE);
4850   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4851
4852   GST_LOG_OBJECT (pad, "event: %s", GST_EVENT_TYPE_NAME (event));
4853
4854   GST_OBJECT_LOCK (pad);
4855
4856   /* Two checks to be made:
4857    * . (un)set the FLUSHING flag for flushing events,
4858    * . handle pad blocking */
4859   switch (GST_EVENT_TYPE (event)) {
4860     case GST_EVENT_FLUSH_START:
4861       GST_PAD_SET_FLUSHING (pad);
4862
4863       if (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad))) {
4864         /* flush start will have set the FLUSHING flag and will then
4865          * unlock all threads doing a GCond wait on the blocking pad. This
4866          * will typically unblock the STREAMING thread blocked on a pad. */
4867         GST_LOG_OBJECT (pad, "Pad is blocked, not forwarding flush-start, "
4868             "doing block signal.");
4869         GST_PAD_BLOCK_BROADCAST (pad);
4870         goto flushed;
4871       }
4872       break;
4873     case GST_EVENT_FLUSH_STOP:
4874       GST_PAD_UNSET_FLUSHING (pad);
4875
4876       /* if we are blocked, flush away the FLUSH_STOP event */
4877       if (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad))) {
4878         GST_LOG_OBJECT (pad, "Pad is blocked, not forwarding flush-stop");
4879         goto flushed;
4880       }
4881       break;
4882     default:
4883       while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad))) {
4884         /* block the event as long as the pad is blocked */
4885         if (handle_pad_block (pad) != GST_FLOW_OK)
4886           goto flushed;
4887       }
4888       break;
4889   }
4890
4891   if (G_UNLIKELY (GST_PAD_DO_EVENT_SIGNALS (pad) > 0)) {
4892     GST_OBJECT_UNLOCK (pad);
4893
4894     if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (event)))
4895       goto dropping;
4896
4897     GST_OBJECT_LOCK (pad);
4898   }
4899   peerpad = GST_PAD_PEER (pad);
4900   if (peerpad == NULL)
4901     goto not_linked;
4902
4903   GST_LOG_OBJECT (pad, "sending event %s to peerpad %" GST_PTR_FORMAT,
4904       GST_EVENT_TYPE_NAME (event), peerpad);
4905   gst_object_ref (peerpad);
4906   GST_OBJECT_UNLOCK (pad);
4907
4908   result = gst_pad_send_event (peerpad, event);
4909
4910   /* Note: we gave away ownership of the event at this point */
4911   GST_LOG_OBJECT (pad, "sent event to peerpad %" GST_PTR_FORMAT ", result %d",
4912       peerpad, result);
4913   gst_object_unref (peerpad);
4914
4915   return result;
4916
4917   /* ERROR handling */
4918 dropping:
4919   {
4920     GST_DEBUG_OBJECT (pad, "Dropping event after FALSE probe return");
4921     gst_event_unref (event);
4922     return FALSE;
4923   }
4924 not_linked:
4925   {
4926     GST_DEBUG_OBJECT (pad, "Dropping event because pad is not linked");
4927     gst_event_unref (event);
4928     GST_OBJECT_UNLOCK (pad);
4929     return FALSE;
4930   }
4931 flushed:
4932   {
4933     GST_DEBUG_OBJECT (pad,
4934         "Not forwarding event since we're flushing and blocking");
4935     gst_event_unref (event);
4936     GST_OBJECT_UNLOCK (pad);
4937     return TRUE;
4938   }
4939 }
4940
4941 /**
4942  * gst_pad_send_event:
4943  * @pad: a #GstPad to send the event to.
4944  * @event: the #GstEvent to send to the pad.
4945  *
4946  * Sends the event to the pad. This function can be used
4947  * by applications to send events in the pipeline.
4948  *
4949  * If @pad is a source pad, @event should be an upstream event. If @pad is a
4950  * sink pad, @event should be a downstream event. For example, you would not
4951  * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
4952  * Furthermore, some downstream events have to be serialized with data flow,
4953  * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
4954  * the event needs to be serialized with data flow, this function will take the
4955  * pad's stream lock while calling its event function.
4956  *
4957  * To find out whether an event type is upstream, downstream, or downstream and
4958  * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
4959  * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
4960  * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
4961  * plugin doesn't need to bother itself with this information; the core handles
4962  * all necessary locks and checks.
4963  *
4964  * This function takes owership of the provided event so you should
4965  * gst_event_ref() it if you want to reuse the event after this call.
4966  *
4967  * Returns: TRUE if the event was handled.
4968  */
4969 gboolean
4970 gst_pad_send_event (GstPad * pad, GstEvent * event)
4971 {
4972   gboolean result = FALSE;
4973   GstPadEventFunction eventfunc;
4974   gboolean serialized, need_unlock = FALSE;
4975
4976   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4977   g_return_val_if_fail (event != NULL, FALSE);
4978
4979   GST_OBJECT_LOCK (pad);
4980   if (GST_PAD_IS_SINK (pad)) {
4981     if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4982       goto wrong_direction;
4983     serialized = GST_EVENT_IS_SERIALIZED (event);
4984   } else if (GST_PAD_IS_SRC (pad)) {
4985     if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4986       goto wrong_direction;
4987     /* events on srcpad never are serialized */
4988     serialized = FALSE;
4989   } else
4990     goto unknown_direction;
4991
4992   if (G_UNLIKELY (GST_EVENT_SRC (event) == NULL)) {
4993     GST_LOG_OBJECT (pad, "event had no source, setting pad as event source");
4994     GST_EVENT_SRC (event) = gst_object_ref (pad);
4995   }
4996
4997   /* pad signals */
4998   if (G_UNLIKELY (GST_PAD_DO_EVENT_SIGNALS (pad) > 0)) {
4999     GST_OBJECT_UNLOCK (pad);
5000
5001     if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT_CAST (event)))
5002       goto dropping;
5003
5004     GST_OBJECT_LOCK (pad);
5005   }
5006
5007   switch (GST_EVENT_TYPE (event)) {
5008     case GST_EVENT_FLUSH_START:
5009       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5010           "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
5011
5012       /* can't even accept a flush begin event when flushing */
5013       if (GST_PAD_IS_FLUSHING (pad))
5014         goto flushing;
5015       GST_PAD_SET_FLUSHING (pad);
5016       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
5017       break;
5018     case GST_EVENT_FLUSH_STOP:
5019       GST_PAD_UNSET_FLUSHING (pad);
5020       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
5021       GST_OBJECT_UNLOCK (pad);
5022       /* grab stream lock */
5023       GST_PAD_STREAM_LOCK (pad);
5024       need_unlock = TRUE;
5025       GST_OBJECT_LOCK (pad);
5026       break;
5027     default:
5028       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "have event type %s",
5029           GST_EVENT_TYPE_NAME (event));
5030
5031       /* make this a little faster, no point in grabbing the lock
5032        * if the pad is allready flushing. */
5033       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5034         goto flushing;
5035
5036       if (serialized) {
5037         /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
5038         GST_OBJECT_UNLOCK (pad);
5039         GST_PAD_STREAM_LOCK (pad);
5040         need_unlock = TRUE;
5041         GST_OBJECT_LOCK (pad);
5042         if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5043           goto flushing;
5044       }
5045       break;
5046   }
5047   if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
5048     goto no_function;
5049
5050   GST_OBJECT_UNLOCK (pad);
5051
5052   result = eventfunc (pad, event);
5053
5054   if (need_unlock)
5055     GST_PAD_STREAM_UNLOCK (pad);
5056
5057   GST_DEBUG_OBJECT (pad, "sent event, result %d", result);
5058
5059   return result;
5060
5061   /* ERROR handling */
5062 wrong_direction:
5063   {
5064     g_warning ("pad %s:%s sending %s event in wrong direction",
5065         GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5066     GST_OBJECT_UNLOCK (pad);
5067     gst_event_unref (event);
5068     return FALSE;
5069   }
5070 unknown_direction:
5071   {
5072     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5073     GST_OBJECT_UNLOCK (pad);
5074     gst_event_unref (event);
5075     return FALSE;
5076   }
5077 no_function:
5078   {
5079     g_warning ("pad %s:%s has no event handler, file a bug.",
5080         GST_DEBUG_PAD_NAME (pad));
5081     GST_OBJECT_UNLOCK (pad);
5082     if (need_unlock)
5083       GST_PAD_STREAM_UNLOCK (pad);
5084     gst_event_unref (event);
5085     return FALSE;
5086   }
5087 flushing:
5088   {
5089     GST_OBJECT_UNLOCK (pad);
5090     if (need_unlock)
5091       GST_PAD_STREAM_UNLOCK (pad);
5092     GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5093         "Received event on flushing pad. Discarding");
5094     gst_event_unref (event);
5095     return FALSE;
5096   }
5097 dropping:
5098   {
5099     GST_DEBUG_OBJECT (pad, "Dropping event after FALSE probe return");
5100     gst_event_unref (event);
5101     return FALSE;
5102   }
5103 }
5104
5105 /**
5106  * gst_pad_set_element_private:
5107  * @pad: the #GstPad to set the private data of.
5108  * @priv: The private data to attach to the pad.
5109  *
5110  * Set the given private data gpointer on the pad.
5111  * This function can only be used by the element that owns the pad.
5112  * No locking is performed in this function.
5113  */
5114 void
5115 gst_pad_set_element_private (GstPad * pad, gpointer priv)
5116 {
5117   pad->element_private = priv;
5118 }
5119
5120 /**
5121  * gst_pad_get_element_private:
5122  * @pad: the #GstPad to get the private data of.
5123  *
5124  * Gets the private data of a pad.
5125  * No locking is performed in this function.
5126  *
5127  * Returns: a #gpointer to the private data.
5128  */
5129 gpointer
5130 gst_pad_get_element_private (GstPad * pad)
5131 {
5132   return pad->element_private;
5133 }
5134
5135 static void
5136 do_stream_status (GstPad * pad, GstStreamStatusType type,
5137     GThread * thread, GstTask * task)
5138 {
5139   GstElement *parent;
5140
5141   GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5142
5143   if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5144     if (GST_IS_ELEMENT (parent)) {
5145       GstMessage *message;
5146       GValue value = { 0 };
5147
5148       if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5149         gchar *tname, *ename, *pname;
5150
5151         /* create a good task name */
5152         ename = gst_element_get_name (parent);
5153         pname = gst_pad_get_name (pad);
5154         tname = g_strdup_printf ("%s:%s", ename, pname);
5155         g_free (ename);
5156         g_free (pname);
5157
5158         gst_object_set_name (GST_OBJECT_CAST (task), tname);
5159         g_free (tname);
5160       }
5161
5162       message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5163           type, parent);
5164
5165       g_value_init (&value, GST_TYPE_TASK);
5166       g_value_set_object (&value, task);
5167       gst_message_set_stream_status_object (message, &value);
5168       g_value_unset (&value);
5169
5170       GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5171       gst_element_post_message (parent, message);
5172     }
5173     gst_object_unref (parent);
5174   }
5175 }
5176
5177 static void
5178 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5179 {
5180   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5181       thread, task);
5182 }
5183
5184 static void
5185 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5186 {
5187   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5188       thread, task);
5189 }
5190
5191 static GstTaskThreadCallbacks thr_callbacks = {
5192   pad_enter_thread,
5193   pad_leave_thread,
5194 };
5195
5196 /**
5197  * gst_pad_start_task:
5198  * @pad: the #GstPad to start the task of
5199  * @func: the task function to call
5200  * @data: data passed to the task function
5201  *
5202  * Starts a task that repeatedly calls @func with @data. This function
5203  * is mostly used in pad activation functions to start the dataflow.
5204  * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5205  * before @func is called.
5206  *
5207  * Returns: a %TRUE if the task could be started.
5208  */
5209 gboolean
5210 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer data)
5211 {
5212   GstTask *task;
5213   gboolean res;
5214
5215   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5216   g_return_val_if_fail (func != NULL, FALSE);
5217
5218   GST_DEBUG_OBJECT (pad, "start task");
5219
5220   GST_OBJECT_LOCK (pad);
5221   task = GST_PAD_TASK (pad);
5222   if (task == NULL) {
5223     task = gst_task_create (func, data);
5224     gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5225     gst_task_set_thread_callbacks (task, &thr_callbacks, pad, NULL);
5226     GST_DEBUG_OBJECT (pad, "created task");
5227     GST_PAD_TASK (pad) = task;
5228     gst_object_ref (task);
5229     /* release lock to post the message */
5230     GST_OBJECT_UNLOCK (pad);
5231
5232     do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
5233
5234     gst_object_unref (task);
5235
5236     GST_OBJECT_LOCK (pad);
5237     /* nobody else is supposed to have changed the pad now */
5238     if (GST_PAD_TASK (pad) != task)
5239       goto concurrent_stop;
5240   }
5241   res = gst_task_set_state (task, GST_TASK_STARTED);
5242   GST_OBJECT_UNLOCK (pad);
5243
5244   return res;
5245
5246   /* ERRORS */
5247 concurrent_stop:
5248   {
5249     GST_OBJECT_UNLOCK (pad);
5250     return TRUE;
5251   }
5252 }
5253
5254 /**
5255  * gst_pad_pause_task:
5256  * @pad: the #GstPad to pause the task of
5257  *
5258  * Pause the task of @pad. This function will also wait until the
5259  * function executed by the task is finished if this function is not
5260  * called from the task function.
5261  *
5262  * Returns: a TRUE if the task could be paused or FALSE when the pad
5263  * has no task.
5264  */
5265 gboolean
5266 gst_pad_pause_task (GstPad * pad)
5267 {
5268   GstTask *task;
5269   gboolean res;
5270
5271   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5272
5273   GST_DEBUG_OBJECT (pad, "pause task");
5274
5275   GST_OBJECT_LOCK (pad);
5276   task = GST_PAD_TASK (pad);
5277   if (task == NULL)
5278     goto no_task;
5279   res = gst_task_set_state (task, GST_TASK_PAUSED);
5280   GST_OBJECT_UNLOCK (pad);
5281
5282   /* wait for task function to finish, this lock is recursive so it does nothing
5283    * when the pause is called from the task itself */
5284   GST_PAD_STREAM_LOCK (pad);
5285   GST_PAD_STREAM_UNLOCK (pad);
5286
5287   return res;
5288
5289 no_task:
5290   {
5291     GST_DEBUG_OBJECT (pad, "pad has no task");
5292     GST_OBJECT_UNLOCK (pad);
5293     return FALSE;
5294   }
5295 }
5296
5297 /**
5298  * gst_pad_stop_task:
5299  * @pad: the #GstPad to stop the task of
5300  *
5301  * Stop the task of @pad. This function will also make sure that the
5302  * function executed by the task will effectively stop if not called
5303  * from the GstTaskFunction.
5304  *
5305  * This function will deadlock if called from the GstTaskFunction of
5306  * the task. Use gst_task_pause() instead.
5307  *
5308  * Regardless of whether the pad has a task, the stream lock is acquired and
5309  * released so as to ensure that streaming through this pad has finished.
5310  *
5311  * Returns: a TRUE if the task could be stopped or FALSE on error.
5312  */
5313 gboolean
5314 gst_pad_stop_task (GstPad * pad)
5315 {
5316   GstTask *task;
5317   gboolean res;
5318
5319   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5320
5321   GST_DEBUG_OBJECT (pad, "stop task");
5322
5323   GST_OBJECT_LOCK (pad);
5324   task = GST_PAD_TASK (pad);
5325   if (task == NULL)
5326     goto no_task;
5327   GST_PAD_TASK (pad) = NULL;
5328   res = gst_task_set_state (task, GST_TASK_STOPPED);
5329   GST_OBJECT_UNLOCK (pad);
5330
5331   GST_PAD_STREAM_LOCK (pad);
5332   GST_PAD_STREAM_UNLOCK (pad);
5333
5334   if (!gst_task_join (task))
5335     goto join_failed;
5336
5337   gst_object_unref (task);
5338
5339   return res;
5340
5341 no_task:
5342   {
5343     GST_DEBUG_OBJECT (pad, "no task");
5344     GST_OBJECT_UNLOCK (pad);
5345
5346     GST_PAD_STREAM_LOCK (pad);
5347     GST_PAD_STREAM_UNLOCK (pad);
5348
5349     /* this is not an error */
5350     return TRUE;
5351   }
5352 join_failed:
5353   {
5354     /* this is bad, possibly the application tried to join the task from
5355      * the task's thread. We install the task again so that it will be stopped
5356      * again from the right thread next time hopefully. */
5357     GST_OBJECT_LOCK (pad);
5358     GST_DEBUG_OBJECT (pad, "join failed");
5359     /* we can only install this task if there was no other task */
5360     if (GST_PAD_TASK (pad) == NULL)
5361       GST_PAD_TASK (pad) = task;
5362     GST_OBJECT_UNLOCK (pad);
5363
5364     return FALSE;
5365   }
5366 }