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