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