caps: Do not allow fixating empty caps
[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   g_return_if_fail (!gst_caps_is_empty (caps));
2424
2425   if (gst_caps_is_fixed (caps))
2426     return;
2427
2428   fixatefunc = GST_PAD_FIXATECAPSFUNC (pad);
2429   if (fixatefunc) {
2430     fixatefunc (pad, caps);
2431   }
2432
2433   /* default fixation */
2434   len = gst_caps_get_size (caps);
2435   if (len > 0) {
2436     GstStructure *s = gst_caps_get_structure (caps, 0);
2437
2438     gst_structure_foreach (s, gst_pad_default_fixate, s);
2439   }
2440
2441   if (len > 1) {
2442     gst_caps_truncate (caps);
2443   }
2444 }
2445
2446 /* Default accept caps implementation just checks against
2447  * against the allowed caps for the pad */
2448 static gboolean
2449 gst_pad_acceptcaps_default (GstPad * pad, GstCaps * caps)
2450 {
2451   /* get the caps and see if it intersects to something not empty */
2452   GstCaps *allowed;
2453   gboolean result = FALSE;
2454
2455   GST_DEBUG_OBJECT (pad, "caps %" GST_PTR_FORMAT, caps);
2456
2457   allowed = gst_pad_get_caps_reffed (pad);
2458   if (!allowed)
2459     goto nothing_allowed;
2460
2461   GST_DEBUG_OBJECT (pad, "allowed caps %" GST_PTR_FORMAT, allowed);
2462
2463   result = gst_caps_can_intersect (allowed, caps);
2464
2465   gst_caps_unref (allowed);
2466
2467   return result;
2468
2469   /* ERRORS */
2470 nothing_allowed:
2471   {
2472     GST_DEBUG_OBJECT (pad, "no caps allowed on the pad");
2473     return FALSE;
2474   }
2475 }
2476
2477 /**
2478  * gst_pad_accept_caps:
2479  * @pad: a #GstPad to check
2480  * @caps: a #GstCaps to check on the pad
2481  *
2482  * Check if the given pad accepts the caps.
2483  *
2484  * Returns: TRUE if the pad can accept the caps.
2485  */
2486 gboolean
2487 gst_pad_accept_caps (GstPad * pad, GstCaps * caps)
2488 {
2489   gboolean result;
2490   GstPadAcceptCapsFunction acceptfunc;
2491   GstCaps *existing = NULL;
2492
2493   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2494
2495   /* any pad can be unnegotiated */
2496   if (caps == NULL)
2497     return TRUE;
2498
2499   /* lock for checking the existing caps */
2500   GST_OBJECT_LOCK (pad);
2501   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "accept caps of %p", caps);
2502   /* The current caps on a pad are trivially acceptable */
2503   if (G_LIKELY ((existing = GST_PAD_CAPS (pad)))) {
2504     if (caps == existing || gst_caps_is_equal (caps, existing))
2505       goto is_same_caps;
2506   }
2507   acceptfunc = GST_PAD_ACCEPTCAPSFUNC (pad);
2508   GST_OBJECT_UNLOCK (pad);
2509
2510   if (G_LIKELY (acceptfunc)) {
2511     /* we can call the function */
2512     result = acceptfunc (pad, caps);
2513     GST_DEBUG_OBJECT (pad, "acceptfunc returned %d", result);
2514   } else {
2515     /* Only null if the element explicitly unset it */
2516     result = gst_pad_acceptcaps_default (pad, caps);
2517     GST_DEBUG_OBJECT (pad, "default acceptcaps returned %d", result);
2518   }
2519   return result;
2520
2521 is_same_caps:
2522   {
2523     GST_DEBUG_OBJECT (pad, "pad had same caps");
2524     GST_OBJECT_UNLOCK (pad);
2525     return TRUE;
2526   }
2527 }
2528
2529 /**
2530  * gst_pad_peer_accept_caps:
2531  * @pad: a  #GstPad to check the peer of
2532  * @caps: a #GstCaps to check on the pad
2533  *
2534  * Check if the peer of @pad accepts @caps. If @pad has no peer, this function
2535  * returns TRUE.
2536  *
2537  * Returns: TRUE if the peer of @pad can accept the caps or @pad has no peer.
2538  */
2539 gboolean
2540 gst_pad_peer_accept_caps (GstPad * pad, GstCaps * caps)
2541 {
2542   GstPad *peerpad;
2543   gboolean result;
2544
2545   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2546
2547   GST_OBJECT_LOCK (pad);
2548
2549   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "peer accept caps of (%p)", pad);
2550
2551   peerpad = GST_PAD_PEER (pad);
2552   if (G_UNLIKELY (peerpad == NULL))
2553     goto no_peer;
2554
2555   gst_object_ref (peerpad);
2556   /* release lock before calling external methods but keep ref to pad */
2557   GST_OBJECT_UNLOCK (pad);
2558
2559   result = gst_pad_accept_caps (peerpad, caps);
2560
2561   gst_object_unref (peerpad);
2562
2563   return result;
2564
2565 no_peer:
2566   {
2567     GST_OBJECT_UNLOCK (pad);
2568     return TRUE;
2569   }
2570 }
2571
2572 /**
2573  * gst_pad_set_caps:
2574  * @pad: a  #GstPad to set the capabilities of.
2575  * @caps: a #GstCaps to set.
2576  *
2577  * Sets the capabilities of this pad. The caps must be fixed. Any previous
2578  * caps on the pad will be unreffed. This function refs the caps so you should
2579  * unref if as soon as you don't need it anymore.
2580  * It is possible to set NULL caps, which will make the pad unnegotiated
2581  * again.
2582  *
2583  * Returns: TRUE if the caps could be set. FALSE if the caps were not fixed
2584  * or bad parameters were provided to this function.
2585  *
2586  * MT safe.
2587  */
2588 gboolean
2589 gst_pad_set_caps (GstPad * pad, GstCaps * caps)
2590 {
2591   GstPadSetCapsFunction setcaps;
2592   GstCaps *existing;
2593
2594   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2595   g_return_val_if_fail (caps == NULL || gst_caps_is_fixed (caps), FALSE);
2596
2597   GST_OBJECT_LOCK (pad);
2598   existing = GST_PAD_CAPS (pad);
2599   if (existing == caps)
2600     goto was_ok;
2601
2602   if (gst_caps_is_equal (caps, existing))
2603     goto setting_same_caps;
2604
2605   setcaps = GST_PAD_SETCAPSFUNC (pad);
2606
2607   /* call setcaps function to configure the pad only if the
2608    * caps is not NULL */
2609   if (setcaps != NULL && caps) {
2610     if (!GST_PAD_IS_IN_SETCAPS (pad)) {
2611       GST_OBJECT_FLAG_SET (pad, GST_PAD_IN_SETCAPS);
2612       GST_OBJECT_UNLOCK (pad);
2613       if (!setcaps (pad, caps))
2614         goto could_not_set;
2615       GST_OBJECT_LOCK (pad);
2616       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_IN_SETCAPS);
2617     } else {
2618       GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad was dispatching");
2619     }
2620   }
2621
2622   gst_caps_replace (&GST_PAD_CAPS (pad), caps);
2623   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "caps %p %" GST_PTR_FORMAT, caps,
2624       caps);
2625   GST_OBJECT_UNLOCK (pad);
2626
2627   g_object_notify (G_OBJECT (pad), "caps");
2628
2629   return TRUE;
2630
2631 was_ok:
2632   {
2633     GST_OBJECT_UNLOCK (pad);
2634     return TRUE;
2635   }
2636 setting_same_caps:
2637   {
2638     gst_caps_replace (&GST_PAD_CAPS (pad), caps);
2639     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2640         "caps %p %" GST_PTR_FORMAT " same as existing, updating ptr only", caps,
2641         caps);
2642     GST_OBJECT_UNLOCK (pad);
2643     return TRUE;
2644   }
2645
2646   /* ERRORS */
2647 could_not_set:
2648   {
2649     GST_OBJECT_LOCK (pad);
2650     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_IN_SETCAPS);
2651     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2652         "caps %" GST_PTR_FORMAT " could not be set", caps);
2653     GST_OBJECT_UNLOCK (pad);
2654
2655     return FALSE;
2656   }
2657 }
2658
2659 static gboolean
2660 gst_pad_configure_sink (GstPad * pad, GstCaps * caps)
2661 {
2662   gboolean res;
2663
2664   /* See if pad accepts the caps */
2665   if (!gst_pad_accept_caps (pad, caps))
2666     goto not_accepted;
2667
2668   /* set caps on pad if call succeeds */
2669   res = gst_pad_set_caps (pad, caps);
2670   /* no need to unref the caps here, set_caps takes a ref and
2671    * our ref goes away when we leave this function. */
2672
2673   return res;
2674
2675 not_accepted:
2676   {
2677     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2678         "caps %" GST_PTR_FORMAT " not accepted", caps);
2679     return FALSE;
2680   }
2681 }
2682
2683 /* returns TRUE if the src pad could be configured to accept the given caps */
2684 static gboolean
2685 gst_pad_configure_src (GstPad * pad, GstCaps * caps, gboolean dosetcaps)
2686 {
2687   gboolean res;
2688
2689   if (dosetcaps) {
2690     /* See if pad accepts the caps */
2691     if (!gst_pad_accept_caps (pad, caps))
2692       goto not_accepted;
2693
2694     res = gst_pad_set_caps (pad, caps);
2695   } else {
2696     res = TRUE;
2697   }
2698   return res;
2699
2700 not_accepted:
2701   {
2702     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2703         "caps %" GST_PTR_FORMAT " not accepted", caps);
2704     return FALSE;
2705   }
2706 }
2707
2708 /**
2709  * gst_pad_get_pad_template_caps:
2710  * @pad: a #GstPad to get the template capabilities from.
2711  *
2712  * Gets the capabilities for @pad's template.
2713  *
2714  * Returns: the #GstCaps of this pad template. If you intend to keep a
2715  * reference on the caps, make a copy (see gst_caps_copy ()).
2716  */
2717 const GstCaps *
2718 gst_pad_get_pad_template_caps (GstPad * pad)
2719 {
2720   static GstStaticCaps anycaps = GST_STATIC_CAPS ("ANY");
2721
2722   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2723
2724   if (GST_PAD_PAD_TEMPLATE (pad))
2725     return GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
2726
2727   return gst_static_caps_get (&anycaps);
2728 }
2729
2730 /**
2731  * gst_pad_get_peer:
2732  * @pad: a #GstPad to get the peer of.
2733  *
2734  * Gets the peer of @pad. This function refs the peer pad so
2735  * you need to unref it after use.
2736  *
2737  * Returns: the peer #GstPad. Unref after usage.
2738  *
2739  * MT safe.
2740  */
2741 GstPad *
2742 gst_pad_get_peer (GstPad * pad)
2743 {
2744   GstPad *result;
2745
2746   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2747
2748   GST_OBJECT_LOCK (pad);
2749   result = GST_PAD_PEER (pad);
2750   if (result)
2751     gst_object_ref (result);
2752   GST_OBJECT_UNLOCK (pad);
2753
2754   return result;
2755 }
2756
2757 /**
2758  * gst_pad_get_allowed_caps:
2759  * @pad: a #GstPad.
2760  *
2761  * Gets the capabilities of the allowed media types that can flow through
2762  * @pad and its peer.
2763  *
2764  * The allowed capabilities is calculated as the intersection of the results of
2765  * calling gst_pad_get_caps() on @pad and its peer. The caller owns a reference
2766  * on the resulting caps.
2767  *
2768  * Returns: the allowed #GstCaps of the pad link. Unref the caps when you no
2769  * longer need it. This function returns NULL when @pad has no peer.
2770  *
2771  * MT safe.
2772  */
2773 GstCaps *
2774 gst_pad_get_allowed_caps (GstPad * pad)
2775 {
2776   GstCaps *mycaps;
2777   GstCaps *caps;
2778   GstCaps *peercaps;
2779   GstPad *peer;
2780
2781   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2782
2783   GST_OBJECT_LOCK (pad);
2784
2785   peer = GST_PAD_PEER (pad);
2786   if (G_UNLIKELY (peer == NULL))
2787     goto no_peer;
2788
2789   GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2790
2791   gst_object_ref (peer);
2792   GST_OBJECT_UNLOCK (pad);
2793   mycaps = gst_pad_get_caps_reffed (pad);
2794
2795   peercaps = gst_pad_get_caps_reffed (peer);
2796   gst_object_unref (peer);
2797
2798   caps = gst_caps_intersect (mycaps, peercaps);
2799   gst_caps_unref (peercaps);
2800   gst_caps_unref (mycaps);
2801
2802   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2803       caps);
2804
2805   return caps;
2806
2807 no_peer:
2808   {
2809     GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2810     GST_OBJECT_UNLOCK (pad);
2811
2812     return NULL;
2813   }
2814 }
2815
2816 /**
2817  * gst_pad_get_negotiated_caps:
2818  * @pad: a #GstPad.
2819  *
2820  * Gets the capabilities of the media type that currently flows through @pad
2821  * and its peer.
2822  *
2823  * This function can be used on both src and sinkpads. Note that srcpads are
2824  * always negotiated before sinkpads so it is possible that the negotiated caps
2825  * on the srcpad do not match the negotiated caps of the peer.
2826  *
2827  * Returns: the negotiated #GstCaps of the pad link.  Unref the caps when
2828  * you no longer need it. This function returns NULL when the @pad has no
2829  * peer or is not negotiated yet.
2830  *
2831  * MT safe.
2832  */
2833 GstCaps *
2834 gst_pad_get_negotiated_caps (GstPad * pad)
2835 {
2836   GstCaps *caps;
2837   GstPad *peer;
2838
2839   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2840
2841   GST_OBJECT_LOCK (pad);
2842
2843   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
2844     goto no_peer;
2845
2846   GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting negotiated caps");
2847
2848   caps = GST_PAD_CAPS (pad);
2849   if (caps)
2850     gst_caps_ref (caps);
2851   GST_OBJECT_UNLOCK (pad);
2852
2853   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "negotiated caps %" GST_PTR_FORMAT,
2854       caps);
2855
2856   return caps;
2857
2858 no_peer:
2859   {
2860     GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2861     GST_OBJECT_UNLOCK (pad);
2862
2863     return NULL;
2864   }
2865 }
2866
2867 /* calls the buffer_alloc function on the given pad */
2868 static GstFlowReturn
2869 gst_pad_buffer_alloc_unchecked (GstPad * pad, guint64 offset, gint size,
2870     GstCaps * caps, GstBuffer ** buf)
2871 {
2872   GstFlowReturn ret;
2873   GstPadBufferAllocFunction bufferallocfunc;
2874
2875   GST_OBJECT_LOCK (pad);
2876   /* when the pad is flushing we cannot give a buffer */
2877   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
2878     goto flushing;
2879
2880   bufferallocfunc = pad->bufferallocfunc;
2881
2882   if (offset == GST_BUFFER_OFFSET_NONE) {
2883     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2884         "calling bufferallocfunc &%s (@%p) for size %d offset NONE",
2885         GST_DEBUG_FUNCPTR_NAME (bufferallocfunc), bufferallocfunc, size);
2886   } else {
2887     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2888         "calling bufferallocfunc &%s (@%p) of for size %d offset %"
2889         G_GUINT64_FORMAT, GST_DEBUG_FUNCPTR_NAME (bufferallocfunc),
2890         bufferallocfunc, size, offset);
2891   }
2892   GST_OBJECT_UNLOCK (pad);
2893
2894   /* G_LIKELY for now since most elements don't implement a buffer alloc
2895    * function and there is no default alloc proxy function as this is usually
2896    * not possible. */
2897   if (G_LIKELY (bufferallocfunc == NULL))
2898     goto fallback;
2899
2900   ret = bufferallocfunc (pad, offset, size, caps, buf);
2901
2902   if (G_UNLIKELY (ret != GST_FLOW_OK))
2903     goto error;
2904
2905   /* no error, but NULL buffer means fallback to the default */
2906   if (G_UNLIKELY (*buf == NULL))
2907     goto fallback;
2908
2909   /* If the buffer alloc function didn't set up the caps like it should,
2910    * do it for it */
2911   if (G_UNLIKELY (caps && (GST_BUFFER_CAPS (*buf) == NULL))) {
2912     GST_WARNING_OBJECT (pad,
2913         "Buffer allocation function did not set caps. Setting");
2914     gst_buffer_set_caps (*buf, caps);
2915   }
2916   return ret;
2917
2918 flushing:
2919   {
2920     /* pad was flushing */
2921     GST_OBJECT_UNLOCK (pad);
2922     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "pad was flushing");
2923     return GST_FLOW_WRONG_STATE;
2924   }
2925 error:
2926   {
2927     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2928         "alloc function returned error (%d) %s", ret, gst_flow_get_name (ret));
2929     return ret;
2930   }
2931 fallback:
2932   {
2933     /* fallback case, allocate a buffer of our own, add pad caps. */
2934     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "fallback buffer alloc");
2935
2936     if ((*buf = gst_buffer_try_new_and_alloc (size))) {
2937       GST_BUFFER_OFFSET (*buf) = offset;
2938       gst_buffer_set_caps (*buf, caps);
2939       return GST_FLOW_OK;
2940     } else {
2941       GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2942           "out of memory allocating %d bytes", size);
2943       return GST_FLOW_ERROR;
2944     }
2945   }
2946 }
2947
2948 /* FIXME 0.11: size should be unsigned */
2949 static GstFlowReturn
2950 gst_pad_alloc_buffer_full (GstPad * pad, guint64 offset, gint size,
2951     GstCaps * caps, GstBuffer ** buf, gboolean setcaps)
2952 {
2953   GstPad *peer;
2954   GstFlowReturn ret;
2955   GstCaps *newcaps;
2956   gboolean caps_changed;
2957
2958   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
2959   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
2960   g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
2961   g_return_val_if_fail (size >= 0, GST_FLOW_ERROR);
2962
2963   GST_DEBUG_OBJECT (pad, "offset %" G_GUINT64_FORMAT ", size %d, caps %"
2964       GST_PTR_FORMAT, offset, size, caps);
2965
2966   GST_OBJECT_LOCK (pad);
2967   while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
2968     if ((ret = handle_pad_block (pad)) != GST_FLOW_OK)
2969       goto flushed;
2970
2971   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
2972     goto no_peer;
2973
2974   gst_object_ref (peer);
2975   GST_OBJECT_UNLOCK (pad);
2976
2977   ret = gst_pad_buffer_alloc_unchecked (peer, offset, size, caps, buf);
2978   gst_object_unref (peer);
2979
2980   if (G_UNLIKELY (ret != GST_FLOW_OK))
2981     goto peer_error;
2982
2983   /* FIXME, move capnego this into a base class? */
2984   newcaps = GST_BUFFER_CAPS (*buf);
2985
2986   /* Lock for checking caps, pretty pointless as the _pad_push() function might
2987    * change it concurrently, one of the problems with automatic caps setting in
2988    * pad_alloc_and_set_caps. Worst case, if does a check too much, but only
2989    * when there is heavy renegotiation going on in both directions. */
2990   GST_OBJECT_LOCK (pad);
2991   caps_changed = newcaps && newcaps != GST_PAD_CAPS (pad);
2992   GST_OBJECT_UNLOCK (pad);
2993
2994   /* we got a new datatype on the pad, see if it can handle it */
2995   if (G_UNLIKELY (caps_changed)) {
2996     GST_DEBUG_OBJECT (pad,
2997         "caps changed from %" GST_PTR_FORMAT " to %p %" GST_PTR_FORMAT,
2998         GST_PAD_CAPS (pad), newcaps, newcaps);
2999     if (G_UNLIKELY (!gst_pad_configure_src (pad, newcaps, setcaps)))
3000       goto not_negotiated;
3001   }
3002
3003   /* sanity check (only if caps are the same) */
3004   if (G_LIKELY (newcaps == caps) && G_UNLIKELY (GST_BUFFER_SIZE (*buf) < size))
3005     goto wrong_size_fallback;
3006
3007   return ret;
3008
3009 flushed:
3010   {
3011     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "pad block stopped by flush");
3012     GST_OBJECT_UNLOCK (pad);
3013     return ret;
3014   }
3015 no_peer:
3016   {
3017     /* pad has no peer */
3018     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3019         "called bufferallocfunc but had no peer");
3020     GST_OBJECT_UNLOCK (pad);
3021     return GST_FLOW_NOT_LINKED;
3022   }
3023 peer_error:
3024   {
3025     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3026         "alloc function returned error %s", gst_flow_get_name (ret));
3027     return ret;
3028   }
3029 not_negotiated:
3030   {
3031     gst_buffer_unref (*buf);
3032     *buf = NULL;
3033     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3034         "alloc function returned unacceptable buffer");
3035     return GST_FLOW_NOT_NEGOTIATED;
3036   }
3037 wrong_size_fallback:
3038   {
3039     GST_CAT_ERROR_OBJECT (GST_CAT_PADS, pad, "buffer returned by alloc "
3040         "function is too small (%u < %d), doing fallback buffer alloc",
3041         GST_BUFFER_SIZE (*buf), size);
3042
3043     gst_buffer_unref (*buf);
3044
3045     if ((*buf = gst_buffer_try_new_and_alloc (size))) {
3046       GST_BUFFER_OFFSET (*buf) = offset;
3047       gst_buffer_set_caps (*buf, caps);
3048       return GST_FLOW_OK;
3049     } else {
3050       GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3051           "out of memory allocating %d bytes", size);
3052       return GST_FLOW_ERROR;
3053     }
3054   }
3055 }
3056
3057 /**
3058  * gst_pad_alloc_buffer:
3059  * @pad: a source #GstPad
3060  * @offset: the offset of the new buffer in the stream
3061  * @size: the size of the new buffer
3062  * @caps: the caps of the new buffer
3063  * @buf: a newly allocated buffer
3064  *
3065  * Allocates a new, empty buffer optimized to push to pad @pad.  This
3066  * function only works if @pad is a source pad and has a peer.
3067  *
3068  * A new, empty #GstBuffer will be put in the @buf argument.
3069  * You need to check the caps of the buffer after performing this
3070  * function and renegotiate to the format if needed. If the caps changed, it is
3071  * possible that the buffer returned in @buf is not of the right size for the
3072  * new format, @buf needs to be unreffed and reallocated if this is the case.
3073  *
3074  * Returns: a result code indicating success of the operation. Any
3075  * result code other than #GST_FLOW_OK is an error and @buf should
3076  * not be used.
3077  * An error can occur if the pad is not connected or when the downstream
3078  * peer elements cannot provide an acceptable buffer.
3079  *
3080  * MT safe.
3081  */
3082
3083 /* FIXME 0.11: size should be unsigned */
3084 GstFlowReturn
3085 gst_pad_alloc_buffer (GstPad * pad, guint64 offset, gint size, GstCaps * caps,
3086     GstBuffer ** buf)
3087 {
3088   return gst_pad_alloc_buffer_full (pad, offset, size, caps, buf, FALSE);
3089 }
3090
3091 /**
3092  * gst_pad_alloc_buffer_and_set_caps:
3093  * @pad: a source #GstPad
3094  * @offset: the offset of the new buffer in the stream
3095  * @size: the size of the new buffer
3096  * @caps: the caps of the new buffer
3097  * @buf: a newly allocated buffer
3098  *
3099  * In addition to the function gst_pad_alloc_buffer(), this function
3100  * automatically calls gst_pad_set_caps() when the caps of the
3101  * newly allocated buffer are different from the @pad caps.
3102  *
3103  * After a renegotiation, the size of the new buffer returned in @buf could
3104  * be of the wrong size for the new format and must be unreffed an reallocated
3105  * in that case.
3106  *
3107  * Returns: a result code indicating success of the operation. Any
3108  * result code other than #GST_FLOW_OK is an error and @buf should
3109  * not be used.
3110  * An error can occur if the pad is not connected or when the downstream
3111  * peer elements cannot provide an acceptable buffer.
3112  *
3113  * MT safe.
3114  */
3115
3116 /* FIXME 0.11: size should be unsigned */
3117 GstFlowReturn
3118 gst_pad_alloc_buffer_and_set_caps (GstPad * pad, guint64 offset, gint size,
3119     GstCaps * caps, GstBuffer ** buf)
3120 {
3121   return gst_pad_alloc_buffer_full (pad, offset, size, caps, buf, TRUE);
3122 }
3123
3124
3125 #ifndef GST_REMOVE_DEPRECATED
3126 typedef struct
3127 {
3128   GList *list;
3129   guint32 cookie;
3130 } IntLinkIterData;
3131
3132 static void
3133 int_link_iter_data_free (IntLinkIterData * data)
3134 {
3135   g_list_free (data->list);
3136   g_slice_free (IntLinkIterData, data);
3137 }
3138 #endif
3139
3140 static GstIteratorItem
3141 iterate_pad (GstIterator * it, GstPad * pad)
3142 {
3143   gst_object_ref (pad);
3144   return GST_ITERATOR_ITEM_PASS;
3145 }
3146
3147 /**
3148  * gst_pad_iterate_internal_links_default:
3149  * @pad: the #GstPad to get the internal links of.
3150  *
3151  * Iterate the list of pads to which the given pad is linked to inside of
3152  * the parent element.
3153  * This is the default handler, and thus returns an iterator of all of the
3154  * pads inside the parent element with opposite direction.
3155  *
3156  * The caller must free this iterator after use with gst_iterator_free().
3157  *
3158  * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
3159  * returned pad with gst_object_unref().
3160  *
3161  * Since: 0.10.21
3162  */
3163 GstIterator *
3164 gst_pad_iterate_internal_links_default (GstPad * pad)
3165 {
3166   GstIterator *res;
3167   GList **padlist;
3168   guint32 *cookie;
3169   GMutex *lock;
3170   gpointer owner;
3171   GstIteratorDisposeFunction dispose;
3172
3173   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3174
3175 #ifndef GST_REMOVE_DEPRECATED
3176   /* when we get here, the default handler for the iterate links is called,
3177    * which means that the user has not installed a custom one. We first check if
3178    * there is maybe a custom legacy function we can call. */
3179   if (GST_PAD_INTLINKFUNC (pad) &&
3180       GST_PAD_INTLINKFUNC (pad) != gst_pad_get_internal_links_default) {
3181     IntLinkIterData *data;
3182
3183     /* make an iterator for the list. We can't protect the list with a
3184      * cookie. If we would take the cookie of the parent element, we need to
3185      * have a parent, which is not required for GST_PAD_INTLINKFUNC(). We could
3186      * cache the per-pad list and invalidate the list when a new call to
3187      * INTLINKFUNC() returned a different list but then this would only work if
3188      * two concurrent iterators were used and the last iterator would still be
3189      * thread-unsafe. Just don't use this method anymore. */
3190     data = g_slice_new (IntLinkIterData);
3191     data->list = GST_PAD_INTLINKFUNC (pad) (pad);
3192     data->cookie = 0;
3193
3194     GST_WARNING_OBJECT (pad, "Making unsafe iterator");
3195
3196     cookie = &data->cookie;
3197     padlist = &data->list;
3198     owner = data;
3199     dispose = (GstIteratorDisposeFunction) int_link_iter_data_free;
3200     /* reuse the pad lock, it's all we have here */
3201     lock = GST_OBJECT_GET_LOCK (pad);
3202   } else
3203 #endif
3204   {
3205     GstElement *parent;
3206
3207     GST_OBJECT_LOCK (pad);
3208     parent = GST_PAD_PARENT (pad);
3209     if (!parent || !GST_IS_ELEMENT (parent))
3210       goto no_parent;
3211
3212     gst_object_ref (parent);
3213     GST_OBJECT_UNLOCK (pad);
3214
3215     if (pad->direction == GST_PAD_SRC)
3216       padlist = &parent->sinkpads;
3217     else
3218       padlist = &parent->srcpads;
3219
3220     GST_DEBUG_OBJECT (pad, "Making iterator");
3221
3222     cookie = &parent->pads_cookie;
3223     owner = parent;
3224     dispose = (GstIteratorDisposeFunction) gst_object_unref;
3225     lock = GST_OBJECT_GET_LOCK (parent);
3226   }
3227
3228   res = gst_iterator_new_list (GST_TYPE_PAD,
3229       lock, cookie, padlist, owner, (GstIteratorItemFunction) iterate_pad,
3230       dispose);
3231
3232   return res;
3233
3234   /* ERRORS */
3235 no_parent:
3236   {
3237     GST_OBJECT_UNLOCK (pad);
3238     GST_DEBUG_OBJECT (pad, "no parent element");
3239     return NULL;
3240   }
3241 }
3242
3243 /**
3244  * gst_pad_iterate_internal_links:
3245  * @pad: the GstPad to get the internal links of.
3246  *
3247  * Gets an iterator for the pads to which the given pad is linked to inside
3248  * of the parent element.
3249  *
3250  * Each #GstPad element yielded by the iterator will have its refcount increased,
3251  * so unref after use.
3252  *
3253  * Returns: a new #GstIterator of #GstPad or %NULL when the pad does not have an
3254  * iterator function configured. Use gst_iterator_free() after usage.
3255  *
3256  * Since: 0.10.21
3257  */
3258 GstIterator *
3259 gst_pad_iterate_internal_links (GstPad * pad)
3260 {
3261   GstIterator *res = NULL;
3262
3263   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3264
3265   if (GST_PAD_ITERINTLINKFUNC (pad))
3266     res = GST_PAD_ITERINTLINKFUNC (pad) (pad);
3267
3268   return res;
3269 }
3270
3271 #ifndef GST_REMOVE_DEPRECATED
3272 static void
3273 add_unref_pad_to_list (GstPad * pad, GList * list)
3274 {
3275   list = g_list_prepend (list, pad);
3276   gst_object_unref (pad);
3277 }
3278 #endif
3279
3280 /**
3281  * gst_pad_get_internal_links_default:
3282  * @pad: the #GstPad to get the internal links of.
3283  *
3284  * Gets a list of pads to which the given pad is linked to
3285  * inside of the parent element.
3286  * This is the default handler, and thus returns a list of all of the
3287  * pads inside the parent element with opposite direction.
3288  *
3289  * The caller must free this list after use with g_list_free().
3290  *
3291  * Returns: a newly allocated #GList of pads, or NULL if the pad has no parent.
3292  *
3293  * Not MT safe.
3294  *
3295  * Deprecated: This function does not ref the pads in the list so that they
3296  * could become invalid by the time the application accesses them. It's also
3297  * possible that the list changes while handling the pads, which the caller of
3298  * this function is unable to know. Use the thread-safe 
3299  * gst_pad_iterate_internal_links_default() instead.
3300  */
3301 #ifndef GST_REMOVE_DEPRECATED
3302 GList *
3303 gst_pad_get_internal_links_default (GstPad * pad)
3304 {
3305   GList *res = NULL;
3306   GstElement *parent;
3307
3308   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3309
3310   GST_WARNING_OBJECT (pad, "Unsafe internal links used");
3311
3312   /* when we get here, the default handler for get_internal_links is called,
3313    * which means that the user has not installed a custom one. We first check if
3314    * there is maybe a custom iterate function we can call. */
3315   if (GST_PAD_ITERINTLINKFUNC (pad) &&
3316       GST_PAD_ITERINTLINKFUNC (pad) != gst_pad_iterate_internal_links_default) {
3317     GstIterator *it;
3318     GstIteratorResult ires;
3319     gboolean done = FALSE;
3320
3321     it = gst_pad_iterate_internal_links (pad);
3322     /* loop over the iterator and put all elements into a list, we also
3323      * immediatly unref them, which is bad. */
3324     do {
3325       ires = gst_iterator_foreach (it, (GFunc) add_unref_pad_to_list, res);
3326       switch (ires) {
3327         case GST_ITERATOR_OK:
3328         case GST_ITERATOR_DONE:
3329         case GST_ITERATOR_ERROR:
3330           done = TRUE;
3331           break;
3332         case GST_ITERATOR_RESYNC:
3333           /* restart, discard previous list */
3334           gst_iterator_resync (it);
3335           g_list_free (res);
3336           res = NULL;
3337           break;
3338       }
3339     } while (!done);
3340
3341     gst_iterator_free (it);
3342   } else {
3343     /* lock pad, check and ref parent */
3344     GST_OBJECT_LOCK (pad);
3345     parent = GST_PAD_PARENT (pad);
3346     if (!parent || !GST_IS_ELEMENT (parent))
3347       goto no_parent;
3348
3349     parent = gst_object_ref (parent);
3350     GST_OBJECT_UNLOCK (pad);
3351
3352     /* now lock the parent while we copy the pads */
3353     GST_OBJECT_LOCK (parent);
3354     if (pad->direction == GST_PAD_SRC)
3355       res = g_list_copy (parent->sinkpads);
3356     else
3357       res = g_list_copy (parent->srcpads);
3358     GST_OBJECT_UNLOCK (parent);
3359
3360     gst_object_unref (parent);
3361   }
3362
3363   /* At this point pads can be changed and unreffed. Nothing we can do about it
3364    * because for compatibility reasons this function cannot ref the pads or
3365    * notify the app that the list changed. */
3366
3367   return res;
3368
3369 no_parent:
3370   {
3371     GST_DEBUG_OBJECT (pad, "no parent");
3372     GST_OBJECT_UNLOCK (pad);
3373     return NULL;
3374   }
3375 }
3376 #endif /* GST_REMOVE_DEPRECATED */
3377
3378 /**
3379  * gst_pad_get_internal_links:
3380  * @pad: the #GstPad to get the internal links of.
3381  *
3382  * Gets a list of pads to which the given pad is linked to
3383  * inside of the parent element.
3384  * The caller must free this list after use.
3385  *
3386  * Not MT safe.
3387  *
3388  * Returns: a newly allocated #GList of pads, free with g_list_free().
3389  * 
3390  * Deprecated: This function does not ref the pads in the list so that they
3391  * could become invalid by the time the application accesses them. It's also
3392  * possible that the list changes while handling the pads, which the caller of
3393  * this function is unable to know. Use the thread-safe 
3394  * gst_pad_iterate_internal_links() instead.
3395  */
3396 #ifndef GST_REMOVE_DEPRECATED
3397 #ifdef GST_DISABLE_DEPRECATED
3398 GList *gst_pad_get_internal_links (GstPad * pad);
3399 #endif
3400 GList *
3401 gst_pad_get_internal_links (GstPad * pad)
3402 {
3403   GList *res = NULL;
3404
3405   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3406
3407   GST_WARNING_OBJECT (pad, "Calling unsafe internal links");
3408
3409   if (GST_PAD_INTLINKFUNC (pad))
3410     res = GST_PAD_INTLINKFUNC (pad) (pad);
3411
3412   return res;
3413 }
3414 #endif /* GST_REMOVE_DEPRECATED */
3415
3416 static gboolean
3417 gst_pad_event_default_dispatch (GstPad * pad, GstEvent * event)
3418 {
3419   gboolean result = FALSE;
3420   GstIterator *iter;
3421   gboolean done = FALSE;
3422   gpointer item;
3423   GstPad *eventpad;
3424   GList *pushed_pads = NULL;
3425
3426   GST_INFO_OBJECT (pad, "Sending event %p (%s) to all internally linked pads",
3427       event, GST_EVENT_TYPE_NAME (event));
3428
3429   iter = gst_pad_iterate_internal_links (pad);
3430
3431   if (!iter)
3432     goto no_iter;
3433
3434   while (!done) {
3435     switch (gst_iterator_next (iter, &item)) {
3436       case GST_ITERATOR_OK:
3437         eventpad = GST_PAD_CAST (item);
3438
3439         /* if already pushed,  skip */
3440         if (g_list_find (pushed_pads, eventpad)) {
3441           gst_object_unref (item);
3442           break;
3443         }
3444
3445         if (GST_PAD_IS_SRC (eventpad)) {
3446           /* for each pad we send to, we should ref the event; it's up
3447            * to downstream to unref again when handled. */
3448           GST_LOG_OBJECT (pad, "Reffing and sending event %p (%s) to %s:%s",
3449               event, GST_EVENT_TYPE_NAME (event),
3450               GST_DEBUG_PAD_NAME (eventpad));
3451           gst_event_ref (event);
3452           result |= gst_pad_push_event (eventpad, event);
3453         } else {
3454           /* we only send the event on one pad, multi-sinkpad elements
3455            * should implement a handler */
3456           GST_LOG_OBJECT (pad, "sending event %p (%s) to one sink pad %s:%s",
3457               event, GST_EVENT_TYPE_NAME (event),
3458               GST_DEBUG_PAD_NAME (eventpad));
3459           result = gst_pad_push_event (eventpad, event);
3460           done = TRUE;
3461           event = NULL;
3462         }
3463
3464         pushed_pads = g_list_prepend (pushed_pads, eventpad);
3465
3466         gst_object_unref (item);
3467         break;
3468       case GST_ITERATOR_RESYNC:
3469         /* FIXME, if we want to reset the result value we need to remember which
3470          * pads pushed with which result */
3471         gst_iterator_resync (iter);
3472         break;
3473       case GST_ITERATOR_ERROR:
3474         GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
3475         done = TRUE;
3476         break;
3477       case GST_ITERATOR_DONE:
3478         done = TRUE;
3479         break;
3480     }
3481   }
3482   gst_iterator_free (iter);
3483
3484 no_iter:
3485
3486   /* If this is a sinkpad and we don't have pads to send the event to, we
3487    * return TRUE. This is so that when using the default handler on a sink
3488    * element, we don't fail to push it. */
3489   if (!pushed_pads)
3490     result = GST_PAD_IS_SINK (pad);
3491
3492   g_list_free (pushed_pads);
3493
3494   /* we handled the incoming event so we unref once */
3495   if (event) {
3496     GST_LOG_OBJECT (pad, "handled event %p, unreffing", event);
3497     gst_event_unref (event);
3498   }
3499
3500   return result;
3501 }
3502
3503 /**
3504  * gst_pad_event_default:
3505  * @pad: a #GstPad to call the default event handler on.
3506  * @event: the #GstEvent to handle.
3507  *
3508  * Invokes the default event handler for the given pad. End-of-stream and
3509  * discontinuity events are handled specially, and then the event is sent to all
3510  * pads internally linked to @pad. Note that if there are many possible sink
3511  * pads that are internally linked to @pad, only one will be sent an event.
3512  * Multi-sinkpad elements should implement custom event handlers.
3513  *
3514  * Returns: TRUE if the event was sent succesfully.
3515  */
3516 gboolean
3517 gst_pad_event_default (GstPad * pad, GstEvent * event)
3518 {
3519   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3520   g_return_val_if_fail (event != NULL, FALSE);
3521
3522   GST_LOG_OBJECT (pad, "default event handler");
3523
3524   switch (GST_EVENT_TYPE (event)) {
3525     case GST_EVENT_EOS:
3526     {
3527       GST_DEBUG_OBJECT (pad, "pausing task because of eos");
3528       gst_pad_pause_task (pad);
3529     }
3530       /* fall thru */
3531     default:
3532       break;
3533   }
3534
3535   return gst_pad_event_default_dispatch (pad, event);
3536 }
3537
3538 /**
3539  * gst_pad_dispatcher:
3540  * @pad: a #GstPad to dispatch.
3541  * @dispatch: the #GstPadDispatcherFunction to call.
3542  * @data: gpointer user data passed to the dispatcher function.
3543  *
3544  * Invokes the given dispatcher function on each respective peer of
3545  * all pads that are internally linked to the given pad.
3546  * The GstPadDispatcherFunction should return TRUE when no further pads
3547  * need to be processed.
3548  *
3549  * Returns: TRUE if one of the dispatcher functions returned TRUE.
3550  */
3551 gboolean
3552 gst_pad_dispatcher (GstPad * pad, GstPadDispatcherFunction dispatch,
3553     gpointer data)
3554 {
3555   gboolean res = FALSE;
3556   GstIterator *iter = NULL;
3557   gboolean done = FALSE;
3558   gpointer item;
3559
3560   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3561   g_return_val_if_fail (dispatch != NULL, FALSE);
3562
3563   iter = gst_pad_iterate_internal_links (pad);
3564
3565   if (!iter)
3566     goto no_iter;
3567
3568   while (!done) {
3569     switch (gst_iterator_next (iter, &item)) {
3570       case GST_ITERATOR_OK:
3571       {
3572         GstPad *int_pad = GST_PAD_CAST (item);
3573         GstPad *int_peer = gst_pad_get_peer (int_pad);
3574
3575         if (int_peer) {
3576           GST_DEBUG_OBJECT (int_pad, "dispatching to peer %s:%s",
3577               GST_DEBUG_PAD_NAME (int_peer));
3578           done = res = dispatch (int_peer, data);
3579           gst_object_unref (int_peer);
3580         } else {
3581           GST_DEBUG_OBJECT (int_pad, "no peer");
3582         }
3583       }
3584         gst_object_unref (item);
3585         break;
3586       case GST_ITERATOR_RESYNC:
3587         gst_iterator_resync (iter);
3588         break;
3589       case GST_ITERATOR_ERROR:
3590         done = TRUE;
3591         GST_ERROR_OBJECT (pad, "Could not iterate internally linked pads");
3592         break;
3593       case GST_ITERATOR_DONE:
3594         done = TRUE;
3595         break;
3596     }
3597   }
3598   gst_iterator_free (iter);
3599
3600   GST_DEBUG_OBJECT (pad, "done, result %d", res);
3601
3602 no_iter:
3603
3604   return res;
3605 }
3606
3607 /**
3608  * gst_pad_query:
3609  * @pad: a #GstPad to invoke the default query on.
3610  * @query: the #GstQuery to perform.
3611  *
3612  * Dispatches a query to a pad. The query should have been allocated by the
3613  * caller via one of the type-specific allocation functions in gstquery.h. The
3614  * element is responsible for filling the query with an appropriate response,
3615  * which should then be parsed with a type-specific query parsing function.
3616  *
3617  * Again, the caller is responsible for both the allocation and deallocation of
3618  * the query structure.
3619  *
3620  * Returns: TRUE if the query could be performed.
3621  */
3622 gboolean
3623 gst_pad_query (GstPad * pad, GstQuery * query)
3624 {
3625   GstPadQueryFunction func;
3626
3627   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3628   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3629
3630   GST_DEBUG_OBJECT (pad, "sending query %p", query);
3631
3632   if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3633     goto no_func;
3634
3635   return func (pad, query);
3636
3637 no_func:
3638   {
3639     GST_DEBUG_OBJECT (pad, "had no query function");
3640     return FALSE;
3641   }
3642 }
3643
3644 /**
3645  * gst_pad_peer_query:
3646  * @pad: a #GstPad to invoke the peer query on.
3647  * @query: the #GstQuery to perform.
3648  *
3649  * Performs gst_pad_query() on the peer of @pad.
3650  *
3651  * The caller is responsible for both the allocation and deallocation of
3652  * the query structure.
3653  *
3654  * Returns: TRUE if the query could be performed. This function returns %FALSE
3655  * if @pad has no peer.
3656  *
3657  * Since: 0.10.15
3658  */
3659 gboolean
3660 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3661 {
3662   GstPad *peerpad;
3663   gboolean result;
3664
3665   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3666   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3667
3668   GST_OBJECT_LOCK (pad);
3669
3670   GST_DEBUG_OBJECT (pad, "peer query");
3671
3672   peerpad = GST_PAD_PEER (pad);
3673   if (G_UNLIKELY (peerpad == NULL))
3674     goto no_peer;
3675
3676   gst_object_ref (peerpad);
3677   GST_OBJECT_UNLOCK (pad);
3678
3679   result = gst_pad_query (peerpad, query);
3680
3681   gst_object_unref (peerpad);
3682
3683   return result;
3684
3685   /* ERRORS */
3686 no_peer:
3687   {
3688     GST_WARNING_OBJECT (pad, "pad has no peer");
3689     GST_OBJECT_UNLOCK (pad);
3690     return FALSE;
3691   }
3692 }
3693
3694 /**
3695  * gst_pad_query_default:
3696  * @pad: a #GstPad to call the default query handler on.
3697  * @query: the #GstQuery to handle.
3698  *
3699  * Invokes the default query handler for the given pad.
3700  * The query is sent to all pads internally linked to @pad. Note that
3701  * if there are many possible sink pads that are internally linked to
3702  * @pad, only one will be sent the query.
3703  * Multi-sinkpad elements should implement custom query handlers.
3704  *
3705  * Returns: TRUE if the query was performed succesfully.
3706  */
3707 gboolean
3708 gst_pad_query_default (GstPad * pad, GstQuery * query)
3709 {
3710   switch (GST_QUERY_TYPE (query)) {
3711     case GST_QUERY_POSITION:
3712     case GST_QUERY_SEEKING:
3713     case GST_QUERY_FORMATS:
3714     case GST_QUERY_LATENCY:
3715     case GST_QUERY_JITTER:
3716     case GST_QUERY_RATE:
3717     case GST_QUERY_CONVERT:
3718     default:
3719       return gst_pad_dispatcher
3720           (pad, (GstPadDispatcherFunction) gst_pad_query, query);
3721   }
3722 }
3723
3724 #ifndef GST_DISABLE_LOADSAVE
3725 /* FIXME: why isn't this on a GstElement ? */
3726 /**
3727  * gst_pad_load_and_link:
3728  * @self: an #xmlNodePtr to read the description from.
3729  * @parent: the #GstObject element that owns the pad.
3730  *
3731  * Reads the pad definition from the XML node and links the given pad
3732  * in the element to a pad of an element up in the hierarchy.
3733  */
3734 void
3735 gst_pad_load_and_link (xmlNodePtr self, GstObject * parent)
3736 {
3737   xmlNodePtr field = self->xmlChildrenNode;
3738   GstPad *pad = NULL, *targetpad;
3739   GstPadTemplate *tmpl;
3740   gchar *peer = NULL;
3741   gchar **split;
3742   GstElement *target;
3743   GstObject *grandparent;
3744   gchar *name = NULL;
3745
3746   while (field) {
3747     if (!strcmp ((char *) field->name, "name")) {
3748       name = (gchar *) xmlNodeGetContent (field);
3749       pad = gst_element_get_static_pad (GST_ELEMENT (parent), name);
3750       if ((!pad) || ((tmpl = gst_pad_get_pad_template (pad))
3751               && (GST_PAD_REQUEST == GST_PAD_TEMPLATE_PRESENCE (tmpl))))
3752         pad = gst_element_get_request_pad (GST_ELEMENT (parent), name);
3753       g_free (name);
3754     } else if (!strcmp ((char *) field->name, "peer")) {
3755       peer = (gchar *) xmlNodeGetContent (field);
3756     }
3757     field = field->next;
3758   }
3759   g_return_if_fail (pad != NULL);
3760
3761   if (peer == NULL)
3762     return;
3763
3764   split = g_strsplit (peer, ".", 2);
3765
3766   if (split[0] == NULL || split[1] == NULL) {
3767     GST_CAT_DEBUG_OBJECT (GST_CAT_XML, pad,
3768         "Could not parse peer '%s', leaving unlinked", peer);
3769
3770     g_free (peer);
3771     return;
3772   }
3773   g_free (peer);
3774
3775   g_return_if_fail (split[0] != NULL);
3776   g_return_if_fail (split[1] != NULL);
3777
3778   grandparent = gst_object_get_parent (parent);
3779
3780   if (grandparent && GST_IS_BIN (grandparent)) {
3781     target = gst_bin_get_by_name_recurse_up (GST_BIN (grandparent), split[0]);
3782   } else
3783     goto cleanup;
3784
3785   if (target == NULL)
3786     goto cleanup;
3787
3788   targetpad = gst_element_get_static_pad (target, split[1]);
3789   if (!targetpad)
3790     targetpad = gst_element_get_request_pad (target, split[1]);
3791
3792   if (targetpad == NULL)
3793     goto cleanup;
3794
3795   if (gst_pad_get_direction (pad) == GST_PAD_SRC)
3796     gst_pad_link (pad, targetpad);
3797   else
3798     gst_pad_link (targetpad, pad);
3799
3800 cleanup:
3801   g_strfreev (split);
3802 }
3803
3804 /**
3805  * gst_pad_save_thyself:
3806  * @pad: a #GstPad to save.
3807  * @parent: the parent #xmlNodePtr to save the description in.
3808  *
3809  * Saves the pad into an xml representation.
3810  *
3811  * Returns: the #xmlNodePtr representation of the pad.
3812  */
3813 static xmlNodePtr
3814 gst_pad_save_thyself (GstObject * object, xmlNodePtr parent)
3815 {
3816   GstPad *pad;
3817   GstPad *peer;
3818
3819   g_return_val_if_fail (GST_IS_PAD (object), NULL);
3820
3821   pad = GST_PAD_CAST (object);
3822
3823   xmlNewChild (parent, NULL, (xmlChar *) "name",
3824       (xmlChar *) GST_PAD_NAME (pad));
3825
3826   if (GST_PAD_IS_SRC (pad)) {
3827     xmlNewChild (parent, NULL, (xmlChar *) "direction", (xmlChar *) "source");
3828   } else if (GST_PAD_IS_SINK (pad)) {
3829     xmlNewChild (parent, NULL, (xmlChar *) "direction", (xmlChar *) "sink");
3830   } else {
3831     xmlNewChild (parent, NULL, (xmlChar *) "direction", (xmlChar *) "unknown");
3832   }
3833
3834   if (GST_PAD_PEER (pad) != NULL) {
3835     gchar *content;
3836
3837     peer = GST_PAD_PEER (pad);
3838     /* first check to see if the peer's parent's parent is the same */
3839     /* we just save it off */
3840     content = g_strdup_printf ("%s.%s",
3841         GST_OBJECT_NAME (GST_PAD_PARENT (peer)), GST_PAD_NAME (peer));
3842     xmlNewChild (parent, NULL, (xmlChar *) "peer", (xmlChar *) content);
3843     g_free (content);
3844   } else
3845     xmlNewChild (parent, NULL, (xmlChar *) "peer", NULL);
3846
3847   return parent;
3848 }
3849
3850 #if 0
3851 /**
3852  * gst_ghost_pad_save_thyself:
3853  * @pad: a ghost #GstPad to save.
3854  * @parent: the parent #xmlNodePtr to save the description in.
3855  *
3856  * Saves the ghost pad into an xml representation.
3857  *
3858  * Returns: the #xmlNodePtr representation of the pad.
3859  */
3860 xmlNodePtr
3861 gst_ghost_pad_save_thyself (GstPad * pad, xmlNodePtr parent)
3862 {
3863   xmlNodePtr self;
3864
3865   g_return_val_if_fail (GST_IS_GHOST_PAD (pad), NULL);
3866
3867   self = xmlNewChild (parent, NULL, (xmlChar *) "ghostpad", NULL);
3868   xmlNewChild (self, NULL, (xmlChar *) "name", (xmlChar *) GST_PAD_NAME (pad));
3869   xmlNewChild (self, NULL, (xmlChar *) "parent",
3870       (xmlChar *) GST_OBJECT_NAME (GST_PAD_PARENT (pad)));
3871
3872   /* FIXME FIXME FIXME! */
3873
3874   return self;
3875 }
3876 #endif /* 0 */
3877 #endif /* GST_DISABLE_LOADSAVE */
3878
3879 /*
3880  * should be called with pad OBJECT_LOCK and STREAM_LOCK held.
3881  * GST_PAD_IS_BLOCKED (pad) == TRUE when this function is
3882  * called.
3883  *
3884  * This function performs the pad blocking when an event, buffer push
3885  * or buffer_alloc is performed on a _SRC_ pad. It blocks the
3886  * streaming thread after informing the pad has been blocked.
3887  *
3888  * An application can with this method wait and block any streaming
3889  * thread and perform operations such as seeking or linking.
3890  *
3891  * Two methods are available for notifying the application of the
3892  * block:
3893  * - the callback method, which happens in the STREAMING thread with
3894  *   the STREAM_LOCK held. With this method, the most useful way of
3895  *   dealing with the callback is to post a message to the main thread
3896  *   where the pad block can then be handled outside of the streaming
3897  *   thread. With the last method one can perform all operations such
3898  *   as doing a state change, linking, unblocking, seeking etc on the
3899  *   pad.
3900  * - the GCond signal method, which makes any thread unblock when
3901  *   the pad block happens.
3902  *
3903  * During the actual blocking state, the GST_PAD_BLOCKING flag is set.
3904  * The GST_PAD_BLOCKING flag is unset when the pad was unblocked.
3905  *
3906  * MT safe.
3907  */
3908 static GstFlowReturn
3909 handle_pad_block (GstPad * pad)
3910 {
3911   GstPadBlockCallback callback;
3912   gpointer user_data;
3913   GstFlowReturn ret = GST_FLOW_OK;
3914
3915   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "signal block taken");
3916
3917   /* flushing, don't bother trying to block and return WRONG_STATE
3918    * right away */
3919   if (GST_PAD_IS_FLUSHING (pad))
3920     goto flushingnonref;
3921
3922   /* we grab an extra ref for the callbacks, this is probably not
3923    * needed (callback code does not have a ref and cannot unref). I
3924    * think this was done to make it possible to unref the element in
3925    * the callback, which is in the end totally impossible as it
3926    * requires grabbing the STREAM_LOCK and OBJECT_LOCK which are
3927    * all taken when calling this function. */
3928   gst_object_ref (pad);
3929
3930   while (GST_PAD_IS_BLOCKED (pad)) {
3931     do {
3932       /* we either have a callback installed to notify the block or
3933        * some other thread is doing a GCond wait. */
3934       callback = pad->block_callback;
3935       pad->abidata.ABI.block_callback_called = TRUE;
3936       if (callback) {
3937         /* there is a callback installed, call it. We release the
3938          * lock so that the callback can do something usefull with the
3939          * pad */
3940         user_data = pad->block_data;
3941         GST_OBJECT_UNLOCK (pad);
3942         callback (pad, TRUE, user_data);
3943         GST_OBJECT_LOCK (pad);
3944
3945         /* we released the lock, recheck flushing */
3946         if (GST_PAD_IS_FLUSHING (pad))
3947           goto flushing;
3948       } else {
3949         /* no callback, signal the thread that is doing a GCond wait
3950          * if any. */
3951         GST_PAD_BLOCK_BROADCAST (pad);
3952       }
3953     } while (pad->abidata.ABI.block_callback_called == FALSE
3954         && GST_PAD_IS_BLOCKED (pad));
3955
3956     /* OBJECT_LOCK could have been released when we did the callback, which
3957      * then could have made the pad unblock so we need to check the blocking
3958      * condition again.   */
3959     if (!GST_PAD_IS_BLOCKED (pad))
3960       break;
3961
3962     /* now we block the streaming thread. It can be unlocked when we
3963      * deactivate the pad (which will also set the FLUSHING flag) or
3964      * when the pad is unblocked. A flushing event will also unblock
3965      * the pad after setting the FLUSHING flag. */
3966     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3967         "Waiting to be unblocked or set flushing");
3968     GST_OBJECT_FLAG_SET (pad, GST_PAD_BLOCKING);
3969     GST_PAD_BLOCK_WAIT (pad);
3970     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_BLOCKING);
3971
3972     /* see if we got unblocked by a flush or not */
3973     if (GST_PAD_IS_FLUSHING (pad))
3974       goto flushing;
3975   }
3976
3977   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got unblocked");
3978
3979   /* when we get here, the pad is unblocked again and we perform
3980    * the needed unblock code. */
3981   callback = pad->block_callback;
3982   if (callback) {
3983     /* we need to call the callback */
3984     user_data = pad->block_data;
3985     GST_OBJECT_UNLOCK (pad);
3986     callback (pad, FALSE, user_data);
3987     GST_OBJECT_LOCK (pad);
3988   } else {
3989     /* we need to signal the thread waiting on the GCond */
3990     GST_PAD_BLOCK_BROADCAST (pad);
3991   }
3992
3993   gst_object_unref (pad);
3994
3995   return ret;
3996
3997 flushingnonref:
3998   {
3999     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pad was flushing");
4000     return GST_FLOW_WRONG_STATE;
4001   }
4002 flushing:
4003   {
4004     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pad became flushing");
4005     gst_object_unref (pad);
4006     return GST_FLOW_WRONG_STATE;
4007   }
4008 }
4009
4010 /**********************************************************************
4011  * Data passing functions
4012  */
4013
4014 static gboolean
4015 gst_pad_emit_have_data_signal (GstPad * pad, GstMiniObject * obj)
4016 {
4017   GValue ret = { 0 };
4018   GValue args[2] = { {0}, {0} };
4019   gboolean res;
4020   GQuark detail;
4021
4022   /* init */
4023   g_value_init (&ret, G_TYPE_BOOLEAN);
4024   g_value_set_boolean (&ret, TRUE);
4025   g_value_init (&args[0], GST_TYPE_PAD);
4026   g_value_set_object (&args[0], pad);
4027   g_value_init (&args[1], GST_TYPE_MINI_OBJECT);
4028   gst_value_set_mini_object (&args[1], obj);
4029
4030   if (GST_IS_EVENT (obj))
4031     detail = event_quark;
4032   else
4033     detail = buffer_quark;
4034
4035   /* actually emit */
4036   g_signal_emitv (args, gst_pad_signals[PAD_HAVE_DATA], detail, &ret);
4037   res = g_value_get_boolean (&ret);
4038
4039   /* clean up */
4040   g_value_unset (&ret);
4041   g_value_unset (&args[0]);
4042   g_value_unset (&args[1]);
4043
4044   return res;
4045 }
4046
4047 static void
4048 gst_pad_data_unref (gboolean is_buffer, void *data)
4049 {
4050   if (G_LIKELY (is_buffer)) {
4051     gst_buffer_unref (data);
4052   } else {
4053     gst_buffer_list_unref (data);
4054   }
4055 }
4056
4057 static GstCaps *
4058 gst_pad_data_get_caps (gboolean is_buffer, void *data)
4059 {
4060   GstCaps *caps;
4061
4062   if (G_LIKELY (is_buffer)) {
4063     caps = GST_BUFFER_CAPS (data);
4064   } else {
4065     GstBuffer *buf;
4066
4067     if ((buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (data), 0, 0)))
4068       caps = GST_BUFFER_CAPS (buf);
4069     else
4070       caps = NULL;
4071   }
4072   return caps;
4073 }
4074
4075 /* this is the chain function that does not perform the additional argument
4076  * checking for that little extra speed.
4077  */
4078 static inline GstFlowReturn
4079 gst_pad_chain_data_unchecked (GstPad * pad, gboolean is_buffer, void *data)
4080 {
4081   GstCaps *caps;
4082   gboolean caps_changed;
4083   GstFlowReturn ret;
4084   gboolean emit_signal;
4085
4086   GST_PAD_STREAM_LOCK (pad);
4087
4088   GST_OBJECT_LOCK (pad);
4089   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4090     goto flushing;
4091
4092   caps = gst_pad_data_get_caps (is_buffer, data);
4093   caps_changed = caps && caps != GST_PAD_CAPS (pad);
4094
4095   emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
4096   GST_OBJECT_UNLOCK (pad);
4097
4098   /* see if the signal should be emited, we emit before caps nego as
4099    * we might drop the buffer and do capsnego for nothing. */
4100   if (G_UNLIKELY (emit_signal)) {
4101     if (G_LIKELY (is_buffer)) {
4102       if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (data)))
4103         goto dropping;
4104     } else {
4105       /* chain all groups in the buffer list one by one to avoid problems with
4106        * buffer probes that push buffers or events */
4107       goto chain_groups;
4108     }
4109   }
4110
4111   /* we got a new datatype on the pad, see if it can handle it */
4112   if (G_UNLIKELY (caps_changed)) {
4113     GST_DEBUG_OBJECT (pad, "caps changed to %p %" GST_PTR_FORMAT, caps, caps);
4114     if (G_UNLIKELY (!gst_pad_configure_sink (pad, caps)))
4115       goto not_negotiated;
4116   }
4117
4118   /* NOTE: we read the chainfunc unlocked.
4119    * we cannot hold the lock for the pad so we might send
4120    * the data to the wrong function. This is not really a
4121    * problem since functions are assigned at creation time
4122    * and don't change that often... */
4123   if (G_LIKELY (is_buffer)) {
4124     GstPadChainFunction chainfunc;
4125
4126     if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
4127       goto no_function;
4128
4129     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4130         "calling chainfunction &%s", GST_DEBUG_FUNCPTR_NAME (chainfunc));
4131
4132     ret = chainfunc (pad, GST_BUFFER_CAST (data));
4133
4134     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4135         "called chainfunction &%s, returned %s",
4136         GST_DEBUG_FUNCPTR_NAME (chainfunc), gst_flow_get_name (ret));
4137   } else {
4138     GstPadChainListFunction chainlistfunc;
4139
4140     if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
4141       goto chain_groups;
4142
4143     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4144         "calling chainlistfunction &%s",
4145         GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
4146
4147     ret = chainlistfunc (pad, GST_BUFFER_LIST_CAST (data));
4148
4149     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4150         "called chainlistfunction &%s, returned %s",
4151         GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
4152   }
4153
4154   GST_PAD_STREAM_UNLOCK (pad);
4155
4156   return ret;
4157
4158 chain_groups:
4159   {
4160     GstBufferList *list;
4161     GstBufferListIterator *it;
4162     GstBuffer *group;
4163
4164     GST_PAD_STREAM_UNLOCK (pad);
4165
4166     GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
4167
4168     list = GST_BUFFER_LIST_CAST (data);
4169     it = gst_buffer_list_iterate (list);
4170
4171     if (gst_buffer_list_iterator_next_group (it)) {
4172       do {
4173         group = gst_buffer_list_iterator_merge_group (it);
4174         if (group == NULL) {
4175           group = gst_buffer_new ();
4176           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
4177         } else {
4178           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
4179         }
4180         ret = gst_pad_chain_data_unchecked (pad, TRUE, group);
4181       } while (ret == GST_FLOW_OK && gst_buffer_list_iterator_next_group (it));
4182     } else {
4183       GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
4184       ret = gst_pad_chain_data_unchecked (pad, TRUE, gst_buffer_new ());
4185     }
4186
4187     gst_buffer_list_iterator_free (it);
4188     gst_buffer_list_unref (list);
4189
4190     return ret;
4191   }
4192
4193   /* ERRORS */
4194 flushing:
4195   {
4196     gst_pad_data_unref (is_buffer, data);
4197     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4198         "pushing, but pad was flushing");
4199     GST_OBJECT_UNLOCK (pad);
4200     GST_PAD_STREAM_UNLOCK (pad);
4201     return GST_FLOW_WRONG_STATE;
4202   }
4203 dropping:
4204   {
4205     gst_pad_data_unref (is_buffer, data);
4206     GST_DEBUG_OBJECT (pad, "Dropping buffer due to FALSE probe return");
4207     GST_PAD_STREAM_UNLOCK (pad);
4208     return GST_FLOW_OK;
4209   }
4210 not_negotiated:
4211   {
4212     gst_pad_data_unref (is_buffer, data);
4213     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4214         "pushing data but pad did not accept");
4215     GST_PAD_STREAM_UNLOCK (pad);
4216     return GST_FLOW_NOT_NEGOTIATED;
4217   }
4218 no_function:
4219   {
4220     gst_pad_data_unref (is_buffer, data);
4221     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4222         "pushing, but not chainhandler");
4223     GST_ELEMENT_ERROR (GST_PAD_PARENT (pad), CORE, PAD, (NULL),
4224         ("push on pad %s:%s but it has no chainfunction",
4225             GST_DEBUG_PAD_NAME (pad)));
4226     GST_PAD_STREAM_UNLOCK (pad);
4227     return GST_FLOW_NOT_SUPPORTED;
4228   }
4229 }
4230
4231 /**
4232  * gst_pad_chain:
4233  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4234  * @buffer: the #GstBuffer to send, return GST_FLOW_ERROR if not.
4235  *
4236  * Chain a buffer to @pad.
4237  *
4238  * The function returns #GST_FLOW_WRONG_STATE if the pad was flushing.
4239  *
4240  * If the caps on @buffer are different from the current caps on @pad, this
4241  * function will call any setcaps function (see gst_pad_set_setcaps_function())
4242  * installed on @pad. If the new caps are not acceptable for @pad, this
4243  * function returns #GST_FLOW_NOT_NEGOTIATED.
4244  *
4245  * The function proceeds calling the chain function installed on @pad (see
4246  * gst_pad_set_chain_function()) and the return value of that function is
4247  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4248  * chain function.
4249  *
4250  * In all cases, success or failure, the caller loses its reference to @buffer
4251  * after calling this function.
4252  *
4253  * Returns: a #GstFlowReturn from the pad.
4254  *
4255  * MT safe.
4256  */
4257 GstFlowReturn
4258 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
4259 {
4260   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4261   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4262   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4263
4264   return gst_pad_chain_data_unchecked (pad, TRUE, buffer);
4265 }
4266
4267 /**
4268  * gst_pad_chain_list:
4269  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4270  * @list: the #GstBufferList to send, return GST_FLOW_ERROR if not.
4271  *
4272  * Chain a bufferlist to @pad.
4273  *
4274  * The function returns #GST_FLOW_WRONG_STATE if the pad was flushing.
4275  *
4276  * If the caps on the first buffer of @list are different from the current
4277  * caps on @pad, this function will call any setcaps function
4278  * (see gst_pad_set_setcaps_function()) installed on @pad. If the new caps
4279  * are not acceptable for @pad, this function returns #GST_FLOW_NOT_NEGOTIATED.
4280  *
4281  * The function proceeds calling the chainlist function installed on @pad (see
4282  * gst_pad_set_chain_list_function()) and the return value of that function is
4283  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4284  * chainlist function.
4285  *
4286  * In all cases, success or failure, the caller loses its reference to @list
4287  * after calling this function.
4288  *
4289  * MT safe.
4290  *
4291  * Returns: a #GstFlowReturn from the pad.
4292  *
4293  * Since: 0.10.24
4294  */
4295 GstFlowReturn
4296 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
4297 {
4298   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4299   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4300   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4301
4302   return gst_pad_chain_data_unchecked (pad, FALSE, list);
4303 }
4304
4305 static GstFlowReturn
4306 gst_pad_push_data (GstPad * pad, gboolean is_buffer, void *data)
4307 {
4308   GstPad *peer;
4309   GstFlowReturn ret;
4310   GstCaps *caps;
4311   gboolean caps_changed;
4312
4313   GST_OBJECT_LOCK (pad);
4314
4315   /* FIXME: this check can go away; pad_set_blocked could be implemented with
4316    * probes completely or probes with an extended pad block. */
4317   while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
4318     if ((ret = handle_pad_block (pad)) != GST_FLOW_OK)
4319       goto flushed;
4320
4321   /* we emit signals on the pad arg, the peer will have a chance to
4322    * emit in the _chain() function */
4323   if (G_UNLIKELY (GST_PAD_DO_BUFFER_SIGNALS (pad) > 0)) {
4324     /* unlock before emitting */
4325     GST_OBJECT_UNLOCK (pad);
4326
4327     if (G_LIKELY (is_buffer)) {
4328       /* if the signal handler returned FALSE, it means we should just drop the
4329        * buffer */
4330       if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (data)))
4331         goto dropped;
4332     } else {
4333       /* push all buffers in the list */
4334       goto push_groups;
4335     }
4336     GST_OBJECT_LOCK (pad);
4337   }
4338
4339   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4340     goto not_linked;
4341
4342   /* Before pushing the buffer to the peer pad, ensure that caps
4343    * are set on this pad */
4344   caps = gst_pad_data_get_caps (is_buffer, data);
4345   caps_changed = caps && caps != GST_PAD_CAPS (pad);
4346
4347   /* take ref to peer pad before releasing the lock */
4348   gst_object_ref (peer);
4349
4350   GST_OBJECT_UNLOCK (pad);
4351
4352   /* we got a new datatype from the pad, it had better handle it */
4353   if (G_UNLIKELY (caps_changed)) {
4354     GST_DEBUG_OBJECT (pad,
4355         "caps changed from %" GST_PTR_FORMAT " to %p %" GST_PTR_FORMAT,
4356         GST_PAD_CAPS (pad), caps, caps);
4357     if (G_UNLIKELY (!gst_pad_set_caps (pad, caps)))
4358       goto not_negotiated;
4359   }
4360
4361   ret = gst_pad_chain_data_unchecked (peer, is_buffer, data);
4362
4363   gst_object_unref (peer);
4364
4365   return ret;
4366
4367 push_groups:
4368   {
4369     GstBufferList *list;
4370     GstBufferListIterator *it;
4371     GstBuffer *group;
4372
4373     GST_INFO_OBJECT (pad, "pushing each group in list as a merged buffer");
4374
4375     list = GST_BUFFER_LIST_CAST (data);
4376     it = gst_buffer_list_iterate (list);
4377
4378     if (gst_buffer_list_iterator_next_group (it)) {
4379       do {
4380         group = gst_buffer_list_iterator_merge_group (it);
4381         if (group == NULL) {
4382           group = gst_buffer_new ();
4383           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "pushing empty group");
4384         } else {
4385           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "pushing group");
4386         }
4387         ret = gst_pad_push_data (pad, TRUE, group);
4388       } while (ret == GST_FLOW_OK && gst_buffer_list_iterator_next_group (it));
4389     } else {
4390       GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "pushing empty group");
4391       ret = gst_pad_push_data (pad, TRUE, gst_buffer_new ());
4392     }
4393
4394     gst_buffer_list_iterator_free (it);
4395     gst_buffer_list_unref (list);
4396
4397     return ret;
4398   }
4399
4400   /* ERROR recovery here */
4401 flushed:
4402   {
4403     gst_pad_data_unref (is_buffer, data);
4404     GST_DEBUG_OBJECT (pad, "pad block stopped by flush");
4405     GST_OBJECT_UNLOCK (pad);
4406     return ret;
4407   }
4408 dropped:
4409   {
4410     gst_pad_data_unref (is_buffer, data);
4411     GST_DEBUG_OBJECT (pad, "Dropping buffer due to FALSE probe return");
4412     return GST_FLOW_OK;
4413   }
4414 not_linked:
4415   {
4416     gst_pad_data_unref (is_buffer, data);
4417     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4418         "pushing, but it was not linked");
4419     GST_OBJECT_UNLOCK (pad);
4420     return GST_FLOW_NOT_LINKED;
4421   }
4422 not_negotiated:
4423   {
4424     gst_pad_data_unref (is_buffer, data);
4425     gst_object_unref (peer);
4426     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4427         "element pushed data then refused to accept the caps");
4428     return GST_FLOW_NOT_NEGOTIATED;
4429   }
4430 }
4431
4432 /**
4433  * gst_pad_push:
4434  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4435  * @buffer: the #GstBuffer to push returns GST_FLOW_ERROR if not.
4436  *
4437  * Pushes a buffer to the peer of @pad.
4438  *
4439  * This function will call an installed pad block before triggering any
4440  * installed pad probes.
4441  *
4442  * If the caps on @buffer are different from the currently configured caps on
4443  * @pad, this function will call any installed setcaps function on @pad (see
4444  * gst_pad_set_setcaps_function()). In case of failure to renegotiate the new
4445  * format, this function returns #GST_FLOW_NOT_NEGOTIATED.
4446  *
4447  * The function proceeds calling gst_pad_chain() on the peer pad and returns
4448  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4449  * be returned.
4450  *
4451  * In all cases, success or failure, the caller loses its reference to @buffer
4452  * after calling this function.
4453  *
4454  * Returns: a #GstFlowReturn from the peer pad.
4455  *
4456  * MT safe.
4457  */
4458 GstFlowReturn
4459 gst_pad_push (GstPad * pad, GstBuffer * buffer)
4460 {
4461   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4462   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4463   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4464
4465   return gst_pad_push_data (pad, TRUE, buffer);
4466 }
4467
4468 /**
4469  * gst_pad_push_list:
4470  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4471  * @list: the #GstBufferList to push returns GST_FLOW_ERROR if not.
4472  *
4473  * Pushes a buffer list to the peer of @pad.
4474  *
4475  * This function will call an installed pad block before triggering any
4476  * installed pad probes.
4477  *
4478  * If the caps on the first buffer in the first group of @list are different
4479  * from the currently configured caps on @pad, this function will call any
4480  * installed setcaps function on @pad (see gst_pad_set_setcaps_function()). In
4481  * case of failure to renegotiate the new format, this function returns
4482  * #GST_FLOW_NOT_NEGOTIATED.
4483  *
4484  * If there are any probes installed on @pad every group of the buffer list
4485  * will be merged into a normal #GstBuffer and pushed via gst_pad_push and the
4486  * buffer list will be unreffed.
4487  *
4488  * The function proceeds calling the chain function on the peer pad and returns
4489  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4490  * be returned. If the peer pad does not have any installed chainlist function
4491  * every group buffer of the list will be merged into a normal #GstBuffer and
4492  * chained via gst_pad_chain().
4493  *
4494  * In all cases, success or failure, the caller loses its reference to @list
4495  * after calling this function.
4496  *
4497  * Returns: a #GstFlowReturn from the peer pad.
4498  *
4499  * MT safe.
4500  *
4501  * Since: 0.10.24
4502  */
4503 GstFlowReturn
4504 gst_pad_push_list (GstPad * pad, GstBufferList * list)
4505 {
4506   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4507   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4508   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4509
4510   return gst_pad_push_data (pad, FALSE, list);
4511 }
4512
4513 /**
4514  * gst_pad_check_pull_range:
4515  * @pad: a sink #GstPad.
4516  *
4517  * Checks if a gst_pad_pull_range() can be performed on the peer
4518  * source pad. This function is used by plugins that want to check
4519  * if they can use random access on the peer source pad.
4520  *
4521  * The peer sourcepad can implement a custom #GstPadCheckGetRangeFunction
4522  * if it needs to perform some logic to determine if pull_range is
4523  * possible.
4524  *
4525  * Returns: a gboolean with the result.
4526  *
4527  * MT safe.
4528  */
4529 gboolean
4530 gst_pad_check_pull_range (GstPad * pad)
4531 {
4532   GstPad *peer;
4533   gboolean ret;
4534   GstPadCheckGetRangeFunction checkgetrangefunc;
4535
4536   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4537
4538   GST_OBJECT_LOCK (pad);
4539   if (!GST_PAD_IS_SINK (pad))
4540     goto wrong_direction;
4541
4542   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4543     goto not_connected;
4544
4545   gst_object_ref (peer);
4546   GST_OBJECT_UNLOCK (pad);
4547
4548   /* see note in above function */
4549   if (G_LIKELY ((checkgetrangefunc = peer->checkgetrangefunc) == NULL)) {
4550     /* FIXME, kindoff ghetto */
4551     ret = GST_PAD_GETRANGEFUNC (peer) != NULL;
4552     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4553         "no checkgetrangefunc, assuming %d", ret);
4554   } else {
4555     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4556         "calling checkgetrangefunc %s of peer pad %s:%s",
4557         GST_DEBUG_FUNCPTR_NAME (checkgetrangefunc), GST_DEBUG_PAD_NAME (peer));
4558
4559     ret = checkgetrangefunc (peer);
4560   }
4561
4562   gst_object_unref (peer);
4563
4564   return ret;
4565
4566   /* ERROR recovery here */
4567 wrong_direction:
4568   {
4569     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4570         "checking pull range, but pad must be a sinkpad");
4571     GST_OBJECT_UNLOCK (pad);
4572     return FALSE;
4573   }
4574 not_connected:
4575   {
4576     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4577         "checking pull range, but it was not linked");
4578     GST_OBJECT_UNLOCK (pad);
4579     return FALSE;
4580   }
4581 }
4582
4583 /**
4584  * gst_pad_get_range:
4585  * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4586  * @offset: The start offset of the buffer
4587  * @size: The length of the buffer
4588  * @buffer: a pointer to hold the #GstBuffer, returns #GST_FLOW_ERROR if %NULL.
4589  *
4590  * When @pad is flushing this function returns #GST_FLOW_WRONG_STATE
4591  * immediatly.
4592  *
4593  * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4594  * description of a getrange function. If @pad has no getrange function
4595  * installed (see gst_pad_set_getrange_function()) this function returns
4596  * #GST_FLOW_NOT_SUPPORTED.
4597  *
4598  * This is a lowlevel function. Usualy gst_pad_pull_range() is used.
4599  *
4600  * Returns: a #GstFlowReturn from the pad.
4601  *
4602  * MT safe.
4603  */
4604 GstFlowReturn
4605 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4606     GstBuffer ** buffer)
4607 {
4608   GstFlowReturn ret;
4609   GstPadGetRangeFunction getrangefunc;
4610   gboolean emit_signal;
4611   GstCaps *caps;
4612   gboolean caps_changed;
4613
4614   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4615   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4616   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4617
4618   GST_PAD_STREAM_LOCK (pad);
4619
4620   GST_OBJECT_LOCK (pad);
4621   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4622     goto flushing;
4623
4624   emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
4625   GST_OBJECT_UNLOCK (pad);
4626
4627   if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
4628     goto no_function;
4629
4630   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4631       "calling getrangefunc %s, offset %"
4632       G_GUINT64_FORMAT ", size %u",
4633       GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
4634
4635   ret = getrangefunc (pad, offset, size, buffer);
4636
4637   /* can only fire the signal if we have a valid buffer */
4638   if (G_UNLIKELY (emit_signal) && (ret == GST_FLOW_OK)) {
4639     if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (*buffer)))
4640       goto dropping;
4641   }
4642
4643   GST_PAD_STREAM_UNLOCK (pad);
4644
4645   if (G_UNLIKELY (ret != GST_FLOW_OK))
4646     goto get_range_failed;
4647
4648   GST_OBJECT_LOCK (pad);
4649   /* Before pushing the buffer to the peer pad, ensure that caps
4650    * are set on this pad */
4651   caps = GST_BUFFER_CAPS (*buffer);
4652   caps_changed = caps && caps != GST_PAD_CAPS (pad);
4653   GST_OBJECT_UNLOCK (pad);
4654
4655   if (G_UNLIKELY (caps_changed)) {
4656     GST_DEBUG_OBJECT (pad, "caps changed to %p %" GST_PTR_FORMAT, caps, caps);
4657     /* this should usually work because the element produced the buffer */
4658     if (G_UNLIKELY (!gst_pad_configure_src (pad, caps, TRUE)))
4659       goto not_negotiated;
4660   }
4661   return ret;
4662
4663   /* ERRORS */
4664 flushing:
4665   {
4666     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4667         "pulling range, but pad was flushing");
4668     GST_OBJECT_UNLOCK (pad);
4669     GST_PAD_STREAM_UNLOCK (pad);
4670     return GST_FLOW_WRONG_STATE;
4671   }
4672 no_function:
4673   {
4674     GST_ELEMENT_ERROR (GST_PAD_PARENT (pad), CORE, PAD, (NULL),
4675         ("pullrange on pad %s:%s but it has no getrangefunction",
4676             GST_DEBUG_PAD_NAME (pad)));
4677     GST_PAD_STREAM_UNLOCK (pad);
4678     return GST_FLOW_NOT_SUPPORTED;
4679   }
4680 dropping:
4681   {
4682     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4683         "Dropping data after FALSE probe return");
4684     GST_PAD_STREAM_UNLOCK (pad);
4685     gst_buffer_unref (*buffer);
4686     *buffer = NULL;
4687     return GST_FLOW_UNEXPECTED;
4688   }
4689 get_range_failed:
4690   {
4691     *buffer = NULL;
4692     GST_CAT_WARNING_OBJECT (GST_CAT_SCHEDULING, pad,
4693         "getrange failed %s", gst_flow_get_name (ret));
4694     return ret;
4695   }
4696 not_negotiated:
4697   {
4698     gst_buffer_unref (*buffer);
4699     *buffer = NULL;
4700     GST_CAT_WARNING_OBJECT (GST_CAT_SCHEDULING, pad,
4701         "getrange returned buffer of unaccaptable caps");
4702     return GST_FLOW_NOT_NEGOTIATED;
4703   }
4704 }
4705
4706
4707 /**
4708  * gst_pad_pull_range:
4709  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4710  * @offset: The start offset of the buffer
4711  * @size: The length of the buffer
4712  * @buffer: a pointer to hold the #GstBuffer, returns GST_FLOW_ERROR if %NULL.
4713  *
4714  * Pulls a @buffer from the peer pad.
4715  *
4716  * This function will first trigger the pad block signal if it was
4717  * installed.
4718  *
4719  * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4720  * function returns the result of gst_pad_get_range() on the peer pad.
4721  * See gst_pad_get_range() for a list of return values and for the
4722  * semantics of the arguments of this function.
4723  *
4724  * @buffer's caps must either be unset or the same as what is already
4725  * configured on @pad. Renegotiation within a running pull-mode pipeline is not
4726  * supported.
4727  *
4728  * Returns: a #GstFlowReturn from the peer pad.
4729  * When this function returns #GST_FLOW_OK, @buffer will contain a valid
4730  * #GstBuffer that should be freed with gst_buffer_unref() after usage.
4731  * @buffer may not be used or freed when any other return value than
4732  * #GST_FLOW_OK is returned.
4733  *
4734  * MT safe.
4735  */
4736 GstFlowReturn
4737 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4738     GstBuffer ** buffer)
4739 {
4740   GstPad *peer;
4741   GstFlowReturn ret;
4742   gboolean emit_signal;
4743   GstCaps *caps;
4744   gboolean caps_changed;
4745
4746   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4747   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4748   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4749
4750   GST_OBJECT_LOCK (pad);
4751
4752   while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
4753     handle_pad_block (pad);
4754
4755   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4756     goto not_connected;
4757
4758   /* signal emision for the pad, peer has chance to emit when
4759    * we call _get_range() */
4760   emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
4761
4762   gst_object_ref (peer);
4763   GST_OBJECT_UNLOCK (pad);
4764
4765   ret = gst_pad_get_range (peer, offset, size, buffer);
4766
4767   gst_object_unref (peer);
4768
4769   if (G_UNLIKELY (ret != GST_FLOW_OK))
4770     goto pull_range_failed;
4771
4772   /* can only fire the signal if we have a valid buffer */
4773   if (G_UNLIKELY (emit_signal)) {
4774     if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (*buffer)))
4775       goto dropping;
4776   }
4777
4778   GST_OBJECT_LOCK (pad);
4779   /* Before pushing the buffer to the peer pad, ensure that caps
4780    * are set on this pad */
4781   caps = GST_BUFFER_CAPS (*buffer);
4782   caps_changed = caps && caps != GST_PAD_CAPS (pad);
4783   GST_OBJECT_UNLOCK (pad);
4784
4785   /* we got a new datatype on the pad, see if it can handle it */
4786   if (G_UNLIKELY (caps_changed)) {
4787     GST_DEBUG_OBJECT (pad, "caps changed to %p %" GST_PTR_FORMAT, caps, caps);
4788     if (G_UNLIKELY (!gst_pad_configure_sink (pad, caps)))
4789       goto not_negotiated;
4790   }
4791   return ret;
4792
4793   /* ERROR recovery here */
4794 not_connected:
4795   {
4796     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4797         "pulling range, but it was not linked");
4798     GST_OBJECT_UNLOCK (pad);
4799     return GST_FLOW_NOT_LINKED;
4800   }
4801 pull_range_failed:
4802   {
4803     *buffer = NULL;
4804     GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4805         (ret >= GST_FLOW_UNEXPECTED) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4806         pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4807     return ret;
4808   }
4809 dropping:
4810   {
4811     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4812         "Dropping data after FALSE probe return");
4813     gst_buffer_unref (*buffer);
4814     *buffer = NULL;
4815     return GST_FLOW_UNEXPECTED;
4816   }
4817 not_negotiated:
4818   {
4819     gst_buffer_unref (*buffer);
4820     *buffer = NULL;
4821     GST_CAT_WARNING_OBJECT (GST_CAT_SCHEDULING, pad,
4822         "pullrange returned buffer of different caps");
4823     return GST_FLOW_NOT_NEGOTIATED;
4824   }
4825 }
4826
4827 /**
4828  * gst_pad_push_event:
4829  * @pad: a #GstPad to push the event to.
4830  * @event: the #GstEvent to send to the pad.
4831  *
4832  * Sends the event to the peer of the given pad. This function is
4833  * mainly used by elements to send events to their peer
4834  * elements.
4835  *
4836  * This function takes owership of the provided event so you should
4837  * gst_event_ref() it if you want to reuse the event after this call.
4838  *
4839  * Returns: TRUE if the event was handled.
4840  *
4841  * MT safe.
4842  */
4843 gboolean
4844 gst_pad_push_event (GstPad * pad, GstEvent * event)
4845 {
4846   GstPad *peerpad;
4847   gboolean result;
4848
4849   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4850   g_return_val_if_fail (event != NULL, FALSE);
4851   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4852
4853   GST_LOG_OBJECT (pad, "event: %s", GST_EVENT_TYPE_NAME (event));
4854
4855   GST_OBJECT_LOCK (pad);
4856
4857   /* Two checks to be made:
4858    * . (un)set the FLUSHING flag for flushing events,
4859    * . handle pad blocking */
4860   switch (GST_EVENT_TYPE (event)) {
4861     case GST_EVENT_FLUSH_START:
4862       GST_PAD_SET_FLUSHING (pad);
4863
4864       if (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad))) {
4865         /* flush start will have set the FLUSHING flag and will then
4866          * unlock all threads doing a GCond wait on the blocking pad. This
4867          * will typically unblock the STREAMING thread blocked on a pad. */
4868         GST_LOG_OBJECT (pad, "Pad is blocked, not forwarding flush-start, "
4869             "doing block signal.");
4870         GST_PAD_BLOCK_BROADCAST (pad);
4871         goto flushed;
4872       }
4873       break;
4874     case GST_EVENT_FLUSH_STOP:
4875       GST_PAD_UNSET_FLUSHING (pad);
4876
4877       /* if we are blocked, flush away the FLUSH_STOP event */
4878       if (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad))) {
4879         GST_LOG_OBJECT (pad, "Pad is blocked, not forwarding flush-stop");
4880         goto flushed;
4881       }
4882       break;
4883     default:
4884       while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad))) {
4885         /* block the event as long as the pad is blocked */
4886         if (handle_pad_block (pad) != GST_FLOW_OK)
4887           goto flushed;
4888       }
4889       break;
4890   }
4891
4892   if (G_UNLIKELY (GST_PAD_DO_EVENT_SIGNALS (pad) > 0)) {
4893     GST_OBJECT_UNLOCK (pad);
4894
4895     if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (event)))
4896       goto dropping;
4897
4898     GST_OBJECT_LOCK (pad);
4899   }
4900   peerpad = GST_PAD_PEER (pad);
4901   if (peerpad == NULL)
4902     goto not_linked;
4903
4904   GST_LOG_OBJECT (pad, "sending event %s to peerpad %" GST_PTR_FORMAT,
4905       GST_EVENT_TYPE_NAME (event), peerpad);
4906   gst_object_ref (peerpad);
4907   GST_OBJECT_UNLOCK (pad);
4908
4909   result = gst_pad_send_event (peerpad, event);
4910
4911   /* Note: we gave away ownership of the event at this point */
4912   GST_LOG_OBJECT (pad, "sent event to peerpad %" GST_PTR_FORMAT ", result %d",
4913       peerpad, result);
4914   gst_object_unref (peerpad);
4915
4916   return result;
4917
4918   /* ERROR handling */
4919 dropping:
4920   {
4921     GST_DEBUG_OBJECT (pad, "Dropping event after FALSE probe return");
4922     gst_event_unref (event);
4923     return FALSE;
4924   }
4925 not_linked:
4926   {
4927     GST_DEBUG_OBJECT (pad, "Dropping event because pad is not linked");
4928     gst_event_unref (event);
4929     GST_OBJECT_UNLOCK (pad);
4930     return FALSE;
4931   }
4932 flushed:
4933   {
4934     GST_DEBUG_OBJECT (pad,
4935         "Not forwarding event since we're flushing and blocking");
4936     gst_event_unref (event);
4937     GST_OBJECT_UNLOCK (pad);
4938     return TRUE;
4939   }
4940 }
4941
4942 /**
4943  * gst_pad_send_event:
4944  * @pad: a #GstPad to send the event to.
4945  * @event: the #GstEvent to send to the pad.
4946  *
4947  * Sends the event to the pad. This function can be used
4948  * by applications to send events in the pipeline.
4949  *
4950  * If @pad is a source pad, @event should be an upstream event. If @pad is a
4951  * sink pad, @event should be a downstream event. For example, you would not
4952  * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
4953  * Furthermore, some downstream events have to be serialized with data flow,
4954  * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
4955  * the event needs to be serialized with data flow, this function will take the
4956  * pad's stream lock while calling its event function.
4957  *
4958  * To find out whether an event type is upstream, downstream, or downstream and
4959  * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
4960  * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
4961  * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
4962  * plugin doesn't need to bother itself with this information; the core handles
4963  * all necessary locks and checks.
4964  *
4965  * This function takes owership of the provided event so you should
4966  * gst_event_ref() it if you want to reuse the event after this call.
4967  *
4968  * Returns: TRUE if the event was handled.
4969  */
4970 gboolean
4971 gst_pad_send_event (GstPad * pad, GstEvent * event)
4972 {
4973   gboolean result = FALSE;
4974   GstPadEventFunction eventfunc;
4975   gboolean serialized, need_unlock = FALSE;
4976
4977   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4978   g_return_val_if_fail (event != NULL, FALSE);
4979
4980   GST_OBJECT_LOCK (pad);
4981   if (GST_PAD_IS_SINK (pad)) {
4982     if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4983       goto wrong_direction;
4984     serialized = GST_EVENT_IS_SERIALIZED (event);
4985   } else if (GST_PAD_IS_SRC (pad)) {
4986     if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4987       goto wrong_direction;
4988     /* events on srcpad never are serialized */
4989     serialized = FALSE;
4990   } else
4991     goto unknown_direction;
4992
4993   if (G_UNLIKELY (GST_EVENT_SRC (event) == NULL)) {
4994     GST_LOG_OBJECT (pad, "event had no source, setting pad as event source");
4995     GST_EVENT_SRC (event) = gst_object_ref (pad);
4996   }
4997
4998   /* pad signals */
4999   if (G_UNLIKELY (GST_PAD_DO_EVENT_SIGNALS (pad) > 0)) {
5000     GST_OBJECT_UNLOCK (pad);
5001
5002     if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT_CAST (event)))
5003       goto dropping;
5004
5005     GST_OBJECT_LOCK (pad);
5006   }
5007
5008   switch (GST_EVENT_TYPE (event)) {
5009     case GST_EVENT_FLUSH_START:
5010       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5011           "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
5012
5013       /* can't even accept a flush begin event when flushing */
5014       if (GST_PAD_IS_FLUSHING (pad))
5015         goto flushing;
5016       GST_PAD_SET_FLUSHING (pad);
5017       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
5018       break;
5019     case GST_EVENT_FLUSH_STOP:
5020       GST_PAD_UNSET_FLUSHING (pad);
5021       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
5022       GST_OBJECT_UNLOCK (pad);
5023       /* grab stream lock */
5024       GST_PAD_STREAM_LOCK (pad);
5025       need_unlock = TRUE;
5026       GST_OBJECT_LOCK (pad);
5027       break;
5028     default:
5029       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "have event type %s",
5030           GST_EVENT_TYPE_NAME (event));
5031
5032       /* make this a little faster, no point in grabbing the lock
5033        * if the pad is allready flushing. */
5034       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5035         goto flushing;
5036
5037       if (serialized) {
5038         /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
5039         GST_OBJECT_UNLOCK (pad);
5040         GST_PAD_STREAM_LOCK (pad);
5041         need_unlock = TRUE;
5042         GST_OBJECT_LOCK (pad);
5043         if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5044           goto flushing;
5045       }
5046       break;
5047   }
5048   if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
5049     goto no_function;
5050
5051   GST_OBJECT_UNLOCK (pad);
5052
5053   result = eventfunc (pad, event);
5054
5055   if (need_unlock)
5056     GST_PAD_STREAM_UNLOCK (pad);
5057
5058   GST_DEBUG_OBJECT (pad, "sent event, result %d", result);
5059
5060   return result;
5061
5062   /* ERROR handling */
5063 wrong_direction:
5064   {
5065     g_warning ("pad %s:%s sending %s event in wrong direction",
5066         GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5067     GST_OBJECT_UNLOCK (pad);
5068     gst_event_unref (event);
5069     return FALSE;
5070   }
5071 unknown_direction:
5072   {
5073     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5074     GST_OBJECT_UNLOCK (pad);
5075     gst_event_unref (event);
5076     return FALSE;
5077   }
5078 no_function:
5079   {
5080     g_warning ("pad %s:%s has no event handler, file a bug.",
5081         GST_DEBUG_PAD_NAME (pad));
5082     GST_OBJECT_UNLOCK (pad);
5083     if (need_unlock)
5084       GST_PAD_STREAM_UNLOCK (pad);
5085     gst_event_unref (event);
5086     return FALSE;
5087   }
5088 flushing:
5089   {
5090     GST_OBJECT_UNLOCK (pad);
5091     if (need_unlock)
5092       GST_PAD_STREAM_UNLOCK (pad);
5093     GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5094         "Received event on flushing pad. Discarding");
5095     gst_event_unref (event);
5096     return FALSE;
5097   }
5098 dropping:
5099   {
5100     GST_DEBUG_OBJECT (pad, "Dropping event after FALSE probe return");
5101     gst_event_unref (event);
5102     return FALSE;
5103   }
5104 }
5105
5106 /**
5107  * gst_pad_set_element_private:
5108  * @pad: the #GstPad to set the private data of.
5109  * @priv: The private data to attach to the pad.
5110  *
5111  * Set the given private data gpointer on the pad.
5112  * This function can only be used by the element that owns the pad.
5113  * No locking is performed in this function.
5114  */
5115 void
5116 gst_pad_set_element_private (GstPad * pad, gpointer priv)
5117 {
5118   pad->element_private = priv;
5119 }
5120
5121 /**
5122  * gst_pad_get_element_private:
5123  * @pad: the #GstPad to get the private data of.
5124  *
5125  * Gets the private data of a pad.
5126  * No locking is performed in this function.
5127  *
5128  * Returns: a #gpointer to the private data.
5129  */
5130 gpointer
5131 gst_pad_get_element_private (GstPad * pad)
5132 {
5133   return pad->element_private;
5134 }
5135
5136 static void
5137 do_stream_status (GstPad * pad, GstStreamStatusType type,
5138     GThread * thread, GstTask * task)
5139 {
5140   GstElement *parent;
5141
5142   GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5143
5144   if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5145     if (GST_IS_ELEMENT (parent)) {
5146       GstMessage *message;
5147       GValue value = { 0 };
5148
5149       if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5150         gchar *tname, *ename, *pname;
5151
5152         /* create a good task name */
5153         ename = gst_element_get_name (parent);
5154         pname = gst_pad_get_name (pad);
5155         tname = g_strdup_printf ("%s:%s", ename, pname);
5156         g_free (ename);
5157         g_free (pname);
5158
5159         gst_object_set_name (GST_OBJECT_CAST (task), tname);
5160         g_free (tname);
5161       }
5162
5163       message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5164           type, parent);
5165
5166       g_value_init (&value, GST_TYPE_TASK);
5167       g_value_set_object (&value, task);
5168       gst_message_set_stream_status_object (message, &value);
5169       g_value_unset (&value);
5170
5171       GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5172       gst_element_post_message (parent, message);
5173     }
5174     gst_object_unref (parent);
5175   }
5176 }
5177
5178 static void
5179 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5180 {
5181   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5182       thread, task);
5183 }
5184
5185 static void
5186 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5187 {
5188   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5189       thread, task);
5190 }
5191
5192 static GstTaskThreadCallbacks thr_callbacks = {
5193   pad_enter_thread,
5194   pad_leave_thread,
5195 };
5196
5197 /**
5198  * gst_pad_start_task:
5199  * @pad: the #GstPad to start the task of
5200  * @func: the task function to call
5201  * @data: data passed to the task function
5202  *
5203  * Starts a task that repeatedly calls @func with @data. This function
5204  * is mostly used in pad activation functions to start the dataflow.
5205  * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5206  * before @func is called.
5207  *
5208  * Returns: a %TRUE if the task could be started.
5209  */
5210 gboolean
5211 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer data)
5212 {
5213   GstTask *task;
5214   gboolean res;
5215
5216   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5217   g_return_val_if_fail (func != NULL, FALSE);
5218
5219   GST_DEBUG_OBJECT (pad, "start task");
5220
5221   GST_OBJECT_LOCK (pad);
5222   task = GST_PAD_TASK (pad);
5223   if (task == NULL) {
5224     task = gst_task_create (func, data);
5225     gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5226     gst_task_set_thread_callbacks (task, &thr_callbacks, pad, NULL);
5227     GST_DEBUG_OBJECT (pad, "created task");
5228     GST_PAD_TASK (pad) = task;
5229     gst_object_ref (task);
5230     /* release lock to post the message */
5231     GST_OBJECT_UNLOCK (pad);
5232
5233     do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
5234
5235     gst_object_unref (task);
5236
5237     GST_OBJECT_LOCK (pad);
5238     /* nobody else is supposed to have changed the pad now */
5239     if (GST_PAD_TASK (pad) != task)
5240       goto concurrent_stop;
5241   }
5242   res = gst_task_set_state (task, GST_TASK_STARTED);
5243   GST_OBJECT_UNLOCK (pad);
5244
5245   return res;
5246
5247   /* ERRORS */
5248 concurrent_stop:
5249   {
5250     GST_OBJECT_UNLOCK (pad);
5251     return TRUE;
5252   }
5253 }
5254
5255 /**
5256  * gst_pad_pause_task:
5257  * @pad: the #GstPad to pause the task of
5258  *
5259  * Pause the task of @pad. This function will also wait until the
5260  * function executed by the task is finished if this function is not
5261  * called from the task function.
5262  *
5263  * Returns: a TRUE if the task could be paused or FALSE when the pad
5264  * has no task.
5265  */
5266 gboolean
5267 gst_pad_pause_task (GstPad * pad)
5268 {
5269   GstTask *task;
5270   gboolean res;
5271
5272   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5273
5274   GST_DEBUG_OBJECT (pad, "pause task");
5275
5276   GST_OBJECT_LOCK (pad);
5277   task = GST_PAD_TASK (pad);
5278   if (task == NULL)
5279     goto no_task;
5280   res = gst_task_set_state (task, GST_TASK_PAUSED);
5281   GST_OBJECT_UNLOCK (pad);
5282
5283   /* wait for task function to finish, this lock is recursive so it does nothing
5284    * when the pause is called from the task itself */
5285   GST_PAD_STREAM_LOCK (pad);
5286   GST_PAD_STREAM_UNLOCK (pad);
5287
5288   return res;
5289
5290 no_task:
5291   {
5292     GST_DEBUG_OBJECT (pad, "pad has no task");
5293     GST_OBJECT_UNLOCK (pad);
5294     return FALSE;
5295   }
5296 }
5297
5298 /**
5299  * gst_pad_stop_task:
5300  * @pad: the #GstPad to stop the task of
5301  *
5302  * Stop the task of @pad. This function will also make sure that the
5303  * function executed by the task will effectively stop if not called
5304  * from the GstTaskFunction.
5305  *
5306  * This function will deadlock if called from the GstTaskFunction of
5307  * the task. Use gst_task_pause() instead.
5308  *
5309  * Regardless of whether the pad has a task, the stream lock is acquired and
5310  * released so as to ensure that streaming through this pad has finished.
5311  *
5312  * Returns: a TRUE if the task could be stopped or FALSE on error.
5313  */
5314 gboolean
5315 gst_pad_stop_task (GstPad * pad)
5316 {
5317   GstTask *task;
5318   gboolean res;
5319
5320   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5321
5322   GST_DEBUG_OBJECT (pad, "stop task");
5323
5324   GST_OBJECT_LOCK (pad);
5325   task = GST_PAD_TASK (pad);
5326   if (task == NULL)
5327     goto no_task;
5328   GST_PAD_TASK (pad) = NULL;
5329   res = gst_task_set_state (task, GST_TASK_STOPPED);
5330   GST_OBJECT_UNLOCK (pad);
5331
5332   GST_PAD_STREAM_LOCK (pad);
5333   GST_PAD_STREAM_UNLOCK (pad);
5334
5335   if (!gst_task_join (task))
5336     goto join_failed;
5337
5338   gst_object_unref (task);
5339
5340   return res;
5341
5342 no_task:
5343   {
5344     GST_DEBUG_OBJECT (pad, "no task");
5345     GST_OBJECT_UNLOCK (pad);
5346
5347     GST_PAD_STREAM_LOCK (pad);
5348     GST_PAD_STREAM_UNLOCK (pad);
5349
5350     /* this is not an error */
5351     return TRUE;
5352   }
5353 join_failed:
5354   {
5355     /* this is bad, possibly the application tried to join the task from
5356      * the task's thread. We install the task again so that it will be stopped
5357      * again from the right thread next time hopefully. */
5358     GST_OBJECT_LOCK (pad);
5359     GST_DEBUG_OBJECT (pad, "join failed");
5360     /* we can only install this task if there was no other task */
5361     if (GST_PAD_TASK (pad) == NULL)
5362       GST_PAD_TASK (pad) = task;
5363     GST_OBJECT_UNLOCK (pad);
5364
5365     return FALSE;
5366   }
5367 }