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