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