info: Properly start and end dwfl sessions when getting stack traces
[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., 51 Franklin St, Fifth Floor,
20  * Boston, MA 02110-1301, 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, #GstQuery, #GstBuffer
27  *
28  * A #GstElement is linked to other elements via "pads", which are extremely
29  * light-weight generic link points.
30  *
31  * Pads have a #GstPadDirection, source pads produce data, sink pads consume
32  * data.
33  *
34  * Pads are typically created from a #GstPadTemplate with
35  * gst_pad_new_from_template() and are then added to a #GstElement. This usually
36  * happens when the element is created but it can also happen dynamically based
37  * on the data that the element is processing or based on the pads that the
38  * application requests.
39  *
40  * Pads without pad templates can be created with gst_pad_new(),
41  * which takes a direction and a name as an argument.  If the name is %NULL,
42  * then a guaranteed unique name will be assigned to it.
43  *
44  * A #GstElement creating a pad will typically use the various
45  * gst_pad_set_*_function() calls to register callbacks for events, queries or
46  * dataflow on the pads.
47  *
48  * gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
49  *
50  * After two pads are retrieved from an element by gst_element_get_static_pad(),
51  * the pads can be linked with gst_pad_link(). (For quick links,
52  * you can also use gst_element_link(), which will make the obvious
53  * link for you if it's straightforward.). Pads can be unlinked again with
54  * gst_pad_unlink(). gst_pad_get_peer() can be used to check what the pad is
55  * linked to.
56  *
57  * Before dataflow is possible on the pads, they need to be activated with
58  * gst_pad_set_active().
59  *
60  * gst_pad_query() and gst_pad_peer_query() can be used to query various
61  * properties of the pad and the stream.
62  *
63  * To send a #GstEvent on a pad, use gst_pad_send_event() and
64  * gst_pad_push_event(). Some events will be sticky on the pad, meaning that
65  * after they pass on the pad they can be queried later with
66  * gst_pad_get_sticky_event() and gst_pad_sticky_events_foreach().
67  * gst_pad_get_current_caps() and gst_pad_has_current_caps() are convenience
68  * functions to query the current sticky CAPS event on a pad.
69  *
70  * GstElements will use gst_pad_push() and gst_pad_pull_range() to push out
71  * or pull in a buffer.
72  *
73  * The dataflow, events and queries that happen on a pad can be monitored with
74  * probes that can be installed with gst_pad_add_probe(). gst_pad_is_blocked()
75  * can be used to check if a block probe is installed on the pad.
76  * gst_pad_is_blocking() checks if the blocking probe is currently blocking the
77  * pad. gst_pad_remove_probe() is used to remove a previously installed probe
78  * and unblock blocking probes if any.
79  *
80  * Pad have an offset that can be retrieved with gst_pad_get_offset(). This
81  * offset will be applied to the running_time of all data passing over the pad.
82  * gst_pad_set_offset() can be used to change the offset.
83  *
84  * Convenience functions exist to start, pause and stop the task on a pad with
85  * gst_pad_start_task(), gst_pad_pause_task() and gst_pad_stop_task()
86  * respectively.
87  */
88
89 #include "gst_private.h"
90
91 #include "gstpad.h"
92 #include "gstpadtemplate.h"
93 #include "gstenumtypes.h"
94 #include "gstutils.h"
95 #include "gstinfo.h"
96 #include "gsterror.h"
97 #include "gsttracerutils.h"
98 #include "gstvalue.h"
99 #include "glib-compat-private.h"
100
101 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
102 #define GST_CAT_DEFAULT GST_CAT_PADS
103
104 /* Pad signals and args */
105 enum
106 {
107   PAD_LINKED,
108   PAD_UNLINKED,
109   /* FILL ME */
110   LAST_SIGNAL
111 };
112
113 enum
114 {
115   PAD_PROP_0,
116   PAD_PROP_CAPS,
117   PAD_PROP_DIRECTION,
118   PAD_PROP_TEMPLATE,
119   PAD_PROP_OFFSET
120       /* FILL ME */
121 };
122
123 #define GST_PAD_GET_PRIVATE(obj)  \
124    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PAD, GstPadPrivate))
125
126 #define _PAD_PROBE_TYPE_ALL_BOTH_AND_FLUSH (GST_PAD_PROBE_TYPE_ALL_BOTH | GST_PAD_PROBE_TYPE_EVENT_FLUSH)
127
128 /* we have a pending and an active event on the pad. On source pads only the
129  * active event is used. On sinkpads, events are copied to the pending entry and
130  * moved to the active event when the eventfunc returned %TRUE. */
131 typedef struct
132 {
133   gboolean received;
134   GstEvent *event;
135 } PadEvent;
136
137 struct _GstPadPrivate
138 {
139   guint events_cookie;
140   GArray *events;
141   guint last_cookie;
142
143   gint using;
144   guint probe_list_cookie;
145   guint probe_cookie;
146
147   /* counter of how many idle probes are running directly from the add_probe
148    * call. Used to block any data flowing in the pad while the idle callback
149    * Doesn't finish its work */
150   gint idle_running;
151 };
152
153 typedef struct
154 {
155   GHook hook;
156   guint cookie;
157 } GstProbe;
158
159 #define PROBE_COOKIE(h) (((GstProbe *)(h))->cookie)
160 #define GST_PAD_IS_RUNNING_IDLE_PROBE(p) \
161     (((GstPad *)(p))->priv->idle_running > 0)
162
163 typedef struct
164 {
165   GstPad *pad;
166   GstPadProbeInfo *info;
167   gboolean dropped;
168   gboolean pass;
169   gboolean handled;
170   gboolean marshalled;
171   guint cookie;
172 } ProbeMarshall;
173
174 static void gst_pad_dispose (GObject * object);
175 static void gst_pad_finalize (GObject * object);
176 static void gst_pad_set_property (GObject * object, guint prop_id,
177     const GValue * value, GParamSpec * pspec);
178 static void gst_pad_get_property (GObject * object, guint prop_id,
179     GValue * value, GParamSpec * pspec);
180
181 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
182 static gboolean gst_pad_activate_default (GstPad * pad, GstObject * parent);
183 static GstFlowReturn gst_pad_chain_list_default (GstPad * pad,
184     GstObject * parent, GstBufferList * list);
185
186 static GstFlowReturn gst_pad_send_event_unchecked (GstPad * pad,
187     GstEvent * event, GstPadProbeType type);
188 static GstFlowReturn gst_pad_push_event_unchecked (GstPad * pad,
189     GstEvent * event, GstPadProbeType type);
190
191 static gboolean activate_mode_internal (GstPad * pad, GstObject * parent,
192     GstPadMode mode, gboolean active);
193
194 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
195
196 static GParamSpec *pspec_caps = NULL;
197
198 /* quarks for probe signals */
199 static GQuark buffer_quark;
200 static GQuark buffer_list_quark;
201 static GQuark event_quark;
202
203 typedef struct
204 {
205   const gint ret;
206   const gchar *name;
207   GQuark quark;
208 } GstFlowQuarks;
209
210 static GstFlowQuarks flow_quarks[] = {
211   {GST_FLOW_CUSTOM_SUCCESS, "custom-success", 0},
212   {GST_FLOW_OK, "ok", 0},
213   {GST_FLOW_NOT_LINKED, "not-linked", 0},
214   {GST_FLOW_FLUSHING, "flushing", 0},
215   {GST_FLOW_EOS, "eos", 0},
216   {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
217   {GST_FLOW_ERROR, "error", 0},
218   {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
219   {GST_FLOW_CUSTOM_ERROR, "custom-error", 0}
220 };
221
222 /**
223  * gst_flow_get_name:
224  * @ret: a #GstFlowReturn to get the name of.
225  *
226  * Gets a string representing the given flow return.
227  *
228  * Returns: a static string with the name of the flow return.
229  */
230 const gchar *
231 gst_flow_get_name (GstFlowReturn ret)
232 {
233   gint i;
234
235   ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
236
237   for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
238     if (ret == flow_quarks[i].ret)
239       return flow_quarks[i].name;
240   }
241   return "unknown";
242 }
243
244 /**
245  * gst_flow_to_quark:
246  * @ret: a #GstFlowReturn to get the quark of.
247  *
248  * Get the unique quark for the given GstFlowReturn.
249  *
250  * Returns: the quark associated with the flow return or 0 if an
251  * invalid return was specified.
252  */
253 GQuark
254 gst_flow_to_quark (GstFlowReturn ret)
255 {
256   gint i;
257
258   ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
259
260   for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
261     if (ret == flow_quarks[i].ret)
262       return flow_quarks[i].quark;
263   }
264   return 0;
265 }
266
267 /**
268  * gst_pad_link_get_name:
269  * @ret: a #GstPadLinkReturn to get the name of.
270  *
271  * Gets a string representing the given pad-link return.
272  *
273  * Returns: a static string with the name of the pad-link return.
274  *
275  * Since: 1.4
276  */
277 const gchar *
278 gst_pad_link_get_name (GstPadLinkReturn ret)
279 {
280   switch (ret) {
281     case GST_PAD_LINK_OK:
282       return "ok";
283     case GST_PAD_LINK_WRONG_HIERARCHY:
284       return "wrong hierarchy";
285     case GST_PAD_LINK_WAS_LINKED:
286       return "was linked";
287     case GST_PAD_LINK_WRONG_DIRECTION:
288       return "wrong direction";
289     case GST_PAD_LINK_NOFORMAT:
290       return "no common format";
291     case GST_PAD_LINK_NOSCHED:
292       return "incompatible scheduling";
293     case GST_PAD_LINK_REFUSED:
294       return "refused";
295   }
296   g_return_val_if_reached ("unknown");
297 }
298
299 #define _do_init \
300 { \
301   gint i; \
302   \
303   buffer_quark = g_quark_from_static_string ("buffer"); \
304   buffer_list_quark = g_quark_from_static_string ("bufferlist"); \
305   event_quark = g_quark_from_static_string ("event"); \
306   \
307   for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {                    \
308     flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name); \
309   } \
310   \
311   GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW", \
312       GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads"); \
313 }
314
315 #define gst_pad_parent_class parent_class
316 G_DEFINE_TYPE_WITH_CODE (GstPad, gst_pad, GST_TYPE_OBJECT, _do_init);
317
318 static void
319 gst_pad_class_init (GstPadClass * klass)
320 {
321   GObjectClass *gobject_class;
322   GstObjectClass *gstobject_class;
323
324   gobject_class = G_OBJECT_CLASS (klass);
325   gstobject_class = GST_OBJECT_CLASS (klass);
326
327   g_type_class_add_private (klass, sizeof (GstPadPrivate));
328
329   gobject_class->dispose = gst_pad_dispose;
330   gobject_class->finalize = gst_pad_finalize;
331   gobject_class->set_property = gst_pad_set_property;
332   gobject_class->get_property = gst_pad_get_property;
333
334   /**
335    * GstPad::linked:
336    * @pad: the pad that emitted the signal
337    * @peer: the peer pad that has been connected
338    *
339    * Signals that a pad has been linked to the peer pad.
340    */
341   gst_pad_signals[PAD_LINKED] =
342       g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
343       G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
344       g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
345   /**
346    * GstPad::unlinked:
347    * @pad: the pad that emitted the signal
348    * @peer: the peer pad that has been disconnected
349    *
350    * Signals that a pad has been unlinked from the peer pad.
351    */
352   gst_pad_signals[PAD_UNLINKED] =
353       g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
354       G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
355       g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
356
357   pspec_caps = g_param_spec_boxed ("caps", "Caps",
358       "The capabilities of the pad", GST_TYPE_CAPS,
359       G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
360   g_object_class_install_property (gobject_class, PAD_PROP_CAPS, pspec_caps);
361
362   g_object_class_install_property (gobject_class, PAD_PROP_DIRECTION,
363       g_param_spec_enum ("direction", "Direction", "The direction of the pad",
364           GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
365           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
366
367   /* FIXME, Make G_PARAM_CONSTRUCT_ONLY when we fix ghostpads. */
368   g_object_class_install_property (gobject_class, PAD_PROP_TEMPLATE,
369       g_param_spec_object ("template", "Template",
370           "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
371           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
372
373   /**
374    * GstPad:offset:
375    *
376    * The offset that will be applied to the running time of the pad.
377    *
378    * Since: 1.6
379    */
380   g_object_class_install_property (gobject_class, PAD_PROP_OFFSET,
381       g_param_spec_int64 ("offset", "Offset",
382           "The running time offset of the pad", 0, G_MAXINT64, 0,
383           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
384
385   gstobject_class->path_string_separator = ".";
386
387   /* Register common function pointer descriptions */
388   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_activate_default);
389   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_event_default);
390   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_query_default);
391   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_iterate_internal_links_default);
392   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_chain_list_default);
393 }
394
395 static void
396 gst_pad_init (GstPad * pad)
397 {
398   pad->priv = GST_PAD_GET_PRIVATE (pad);
399
400   GST_PAD_DIRECTION (pad) = GST_PAD_UNKNOWN;
401
402   GST_PAD_ACTIVATEFUNC (pad) = gst_pad_activate_default;
403   GST_PAD_EVENTFUNC (pad) = gst_pad_event_default;
404   GST_PAD_QUERYFUNC (pad) = gst_pad_query_default;
405   GST_PAD_ITERINTLINKFUNC (pad) = gst_pad_iterate_internal_links_default;
406   GST_PAD_CHAINLISTFUNC (pad) = gst_pad_chain_list_default;
407
408   GST_PAD_SET_FLUSHING (pad);
409
410   g_rec_mutex_init (&pad->stream_rec_lock);
411
412   g_cond_init (&pad->block_cond);
413
414   g_hook_list_init (&pad->probes, sizeof (GstProbe));
415
416   pad->priv->events = g_array_sized_new (FALSE, TRUE, sizeof (PadEvent), 16);
417   pad->priv->events_cookie = 0;
418   pad->priv->last_cookie = -1;
419   pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
420 }
421
422 /* called when setting the pad inactive. It removes all sticky events from
423  * the pad. must be called with object lock */
424 static void
425 remove_events (GstPad * pad)
426 {
427   guint i, len;
428   GArray *events;
429   gboolean notify = FALSE;
430
431   events = pad->priv->events;
432
433   len = events->len;
434   for (i = 0; i < len; i++) {
435     PadEvent *ev = &g_array_index (events, PadEvent, i);
436     GstEvent *event = ev->event;
437
438     ev->event = NULL;
439
440     if (event && GST_EVENT_TYPE (event) == GST_EVENT_CAPS)
441       notify = TRUE;
442
443     gst_event_unref (event);
444   }
445
446   GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
447   g_array_set_size (events, 0);
448   pad->priv->events_cookie++;
449
450   if (notify) {
451     GST_OBJECT_UNLOCK (pad);
452
453     GST_DEBUG_OBJECT (pad, "notify caps");
454     g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
455
456     GST_OBJECT_LOCK (pad);
457   }
458 }
459
460 /* should be called with object lock */
461 static PadEvent *
462 find_event_by_type (GstPad * pad, GstEventType type, guint idx)
463 {
464   guint i, len;
465   GArray *events;
466   PadEvent *ev;
467
468   events = pad->priv->events;
469   len = events->len;
470
471   for (i = 0; i < len; i++) {
472     ev = &g_array_index (events, PadEvent, i);
473     if (ev->event == NULL)
474       continue;
475
476     if (GST_EVENT_TYPE (ev->event) == type) {
477       if (idx == 0)
478         goto found;
479       idx--;
480     } else if (GST_EVENT_TYPE (ev->event) > type) {
481       break;
482     }
483   }
484   ev = NULL;
485 found:
486   return ev;
487 }
488
489 /* should be called with OBJECT lock */
490 static PadEvent *
491 find_event (GstPad * pad, GstEvent * event)
492 {
493   guint i, len;
494   GArray *events;
495   PadEvent *ev;
496
497   events = pad->priv->events;
498   len = events->len;
499
500   for (i = 0; i < len; i++) {
501     ev = &g_array_index (events, PadEvent, i);
502     if (event == ev->event)
503       goto found;
504     else if (GST_EVENT_TYPE (ev->event) > GST_EVENT_TYPE (event))
505       break;
506   }
507   ev = NULL;
508 found:
509   return ev;
510 }
511
512 /* should be called with OBJECT lock */
513 static void
514 remove_event_by_type (GstPad * pad, GstEventType type)
515 {
516   guint i, len;
517   GArray *events;
518   PadEvent *ev;
519
520   events = pad->priv->events;
521   len = events->len;
522
523   i = 0;
524   while (i < len) {
525     ev = &g_array_index (events, PadEvent, i);
526     if (ev->event == NULL)
527       goto next;
528
529     if (GST_EVENT_TYPE (ev->event) > type)
530       break;
531     else if (GST_EVENT_TYPE (ev->event) != type)
532       goto next;
533
534     gst_event_unref (ev->event);
535     g_array_remove_index (events, i);
536     len--;
537     pad->priv->events_cookie++;
538     continue;
539
540   next:
541     i++;
542   }
543 }
544
545 /* check all events on srcpad against those on sinkpad. All events that are not
546  * on sinkpad are marked as received=%FALSE and the PENDING_EVENTS is set on the
547  * srcpad so that the events will be sent next time */
548 /* should be called with srcpad and sinkpad LOCKS */
549 static void
550 schedule_events (GstPad * srcpad, GstPad * sinkpad)
551 {
552   gint i, len;
553   GArray *events;
554   PadEvent *ev;
555   gboolean pending = FALSE;
556
557   events = srcpad->priv->events;
558   len = events->len;
559
560   for (i = 0; i < len; i++) {
561     ev = &g_array_index (events, PadEvent, i);
562     if (ev->event == NULL)
563       continue;
564
565     if (sinkpad == NULL || !find_event (sinkpad, ev->event)) {
566       ev->received = FALSE;
567       pending = TRUE;
568     }
569   }
570   if (pending)
571     GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PENDING_EVENTS);
572 }
573
574 typedef gboolean (*PadEventFunction) (GstPad * pad, PadEvent * ev,
575     gpointer user_data);
576
577 /* should be called with pad LOCK */
578 static void
579 events_foreach (GstPad * pad, PadEventFunction func, gpointer user_data)
580 {
581   guint i, len;
582   GArray *events;
583   gboolean ret;
584   guint cookie;
585
586   events = pad->priv->events;
587
588 restart:
589   cookie = pad->priv->events_cookie;
590   i = 0;
591   len = events->len;
592   while (i < len) {
593     PadEvent *ev, ev_ret;
594
595     ev = &g_array_index (events, PadEvent, i);
596     if (G_UNLIKELY (ev->event == NULL))
597       goto next;
598
599     /* take aditional ref, func might release the lock */
600     ev_ret.event = gst_event_ref (ev->event);
601     ev_ret.received = ev->received;
602
603     ret = func (pad, &ev_ret, user_data);
604
605     /* recheck the cookie, lock might have been released and the list could have
606      * changed */
607     if (G_UNLIKELY (cookie != pad->priv->events_cookie)) {
608       if (G_LIKELY (ev_ret.event))
609         gst_event_unref (ev_ret.event);
610       goto restart;
611     }
612
613     /* store the received state */
614     ev->received = ev_ret.received;
615
616     /* if the event changed, we need to do something */
617     if (G_UNLIKELY (ev->event != ev_ret.event)) {
618       if (G_UNLIKELY (ev_ret.event == NULL)) {
619         /* function unreffed and set the event to NULL, remove it */
620         gst_event_unref (ev->event);
621         g_array_remove_index (events, i);
622         len--;
623         cookie = ++pad->priv->events_cookie;
624         continue;
625       } else {
626         /* function gave a new event for us */
627         gst_event_take (&ev->event, ev_ret.event);
628       }
629     } else {
630       /* just unref, nothing changed */
631       gst_event_unref (ev_ret.event);
632     }
633     if (!ret)
634       break;
635   next:
636     i++;
637   }
638 }
639
640 /* should be called with LOCK */
641 static GstEvent *
642 _apply_pad_offset (GstPad * pad, GstEvent * event, gboolean upstream)
643 {
644   gint64 offset;
645
646   GST_DEBUG_OBJECT (pad, "apply pad offset %" GST_STIME_FORMAT,
647       GST_STIME_ARGS (pad->offset));
648
649   if (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT) {
650     GstSegment segment;
651
652     g_assert (!upstream);
653
654     /* copy segment values */
655     gst_event_copy_segment (event, &segment);
656     gst_event_unref (event);
657
658     gst_segment_offset_running_time (&segment, segment.format, pad->offset);
659     event = gst_event_new_segment (&segment);
660   }
661
662   event = gst_event_make_writable (event);
663   offset = gst_event_get_running_time_offset (event);
664   if (upstream)
665     offset -= pad->offset;
666   else
667     offset += pad->offset;
668   gst_event_set_running_time_offset (event, offset);
669
670   return event;
671 }
672
673 static inline GstEvent *
674 apply_pad_offset (GstPad * pad, GstEvent * event, gboolean upstream)
675 {
676   if (G_UNLIKELY (pad->offset != 0))
677     return _apply_pad_offset (pad, event, upstream);
678   return event;
679 }
680
681
682 /* should be called with the OBJECT_LOCK */
683 static GstCaps *
684 get_pad_caps (GstPad * pad)
685 {
686   GstCaps *caps = NULL;
687   PadEvent *ev;
688
689   ev = find_event_by_type (pad, GST_EVENT_CAPS, 0);
690   if (ev && ev->event)
691     gst_event_parse_caps (ev->event, &caps);
692
693   return caps;
694 }
695
696 static void
697 gst_pad_dispose (GObject * object)
698 {
699   GstPad *pad = GST_PAD_CAST (object);
700   GstPad *peer;
701
702   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pad, "%p dispose", pad);
703
704   /* unlink the peer pad */
705   if ((peer = gst_pad_get_peer (pad))) {
706     /* window for MT unsafeness, someone else could unlink here
707      * and then we call unlink with wrong pads. The unlink
708      * function would catch this and safely return failed. */
709     if (GST_PAD_IS_SRC (pad))
710       gst_pad_unlink (pad, peer);
711     else
712       gst_pad_unlink (peer, pad);
713
714     gst_object_unref (peer);
715   }
716
717   gst_pad_set_pad_template (pad, NULL);
718
719   GST_OBJECT_LOCK (pad);
720   remove_events (pad);
721   GST_OBJECT_UNLOCK (pad);
722
723   g_hook_list_clear (&pad->probes);
724
725   G_OBJECT_CLASS (parent_class)->dispose (object);
726 }
727
728 static void
729 gst_pad_finalize (GObject * object)
730 {
731   GstPad *pad = GST_PAD_CAST (object);
732   GstTask *task;
733
734   /* in case the task is still around, clean it up */
735   if ((task = GST_PAD_TASK (pad))) {
736     gst_task_join (task);
737     GST_PAD_TASK (pad) = NULL;
738     gst_object_unref (task);
739   }
740
741   if (pad->activatenotify)
742     pad->activatenotify (pad->activatedata);
743   if (pad->activatemodenotify)
744     pad->activatemodenotify (pad->activatemodedata);
745   if (pad->linknotify)
746     pad->linknotify (pad->linkdata);
747   if (pad->unlinknotify)
748     pad->unlinknotify (pad->unlinkdata);
749   if (pad->chainnotify)
750     pad->chainnotify (pad->chaindata);
751   if (pad->chainlistnotify)
752     pad->chainlistnotify (pad->chainlistdata);
753   if (pad->getrangenotify)
754     pad->getrangenotify (pad->getrangedata);
755   if (pad->eventnotify)
756     pad->eventnotify (pad->eventdata);
757   if (pad->querynotify)
758     pad->querynotify (pad->querydata);
759   if (pad->iterintlinknotify)
760     pad->iterintlinknotify (pad->iterintlinkdata);
761
762   g_rec_mutex_clear (&pad->stream_rec_lock);
763   g_cond_clear (&pad->block_cond);
764   g_array_free (pad->priv->events, TRUE);
765
766   G_OBJECT_CLASS (parent_class)->finalize (object);
767 }
768
769 static void
770 gst_pad_set_property (GObject * object, guint prop_id,
771     const GValue * value, GParamSpec * pspec)
772 {
773   g_return_if_fail (GST_IS_PAD (object));
774
775   switch (prop_id) {
776     case PAD_PROP_DIRECTION:
777       GST_PAD_DIRECTION (object) = (GstPadDirection) g_value_get_enum (value);
778       break;
779     case PAD_PROP_TEMPLATE:
780       gst_pad_set_pad_template (GST_PAD_CAST (object),
781           (GstPadTemplate *) g_value_get_object (value));
782       break;
783     case PAD_PROP_OFFSET:
784       gst_pad_set_offset (GST_PAD_CAST (object), g_value_get_int64 (value));
785       break;
786     default:
787       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
788       break;
789   }
790 }
791
792 static void
793 gst_pad_get_property (GObject * object, guint prop_id,
794     GValue * value, GParamSpec * pspec)
795 {
796   g_return_if_fail (GST_IS_PAD (object));
797
798   switch (prop_id) {
799     case PAD_PROP_CAPS:
800       GST_OBJECT_LOCK (object);
801       g_value_set_boxed (value, get_pad_caps (GST_PAD_CAST (object)));
802       GST_OBJECT_UNLOCK (object);
803       break;
804     case PAD_PROP_DIRECTION:
805       g_value_set_enum (value, GST_PAD_DIRECTION (object));
806       break;
807     case PAD_PROP_TEMPLATE:
808       g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
809       break;
810     case PAD_PROP_OFFSET:
811       g_value_set_int64 (value, gst_pad_get_offset (GST_PAD_CAST (object)));
812       break;
813     default:
814       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
815       break;
816   }
817 }
818
819 /**
820  * gst_pad_new:
821  * @name: (allow-none): the name of the new pad.
822  * @direction: the #GstPadDirection of the pad.
823  *
824  * Creates a new pad with the given name in the given direction.
825  * If name is %NULL, a guaranteed unique name (across all pads)
826  * will be assigned.
827  * This function makes a copy of the name so you can safely free the name.
828  *
829  * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
830  * case of an error.
831  *
832  * MT safe.
833  */
834 GstPad *
835 gst_pad_new (const gchar * name, GstPadDirection direction)
836 {
837   return g_object_new (GST_TYPE_PAD,
838       "name", name, "direction", direction, NULL);
839 }
840
841 /**
842  * gst_pad_new_from_template:
843  * @templ: the pad template to use
844  * @name: (allow-none): the name of the pad
845  *
846  * Creates a new pad with the given name from the given template.
847  * If name is %NULL, a guaranteed unique name (across all pads)
848  * will be assigned.
849  * This function makes a copy of the name so you can safely free the name.
850  *
851  * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
852  * case of an error.
853  */
854 GstPad *
855 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
856 {
857   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
858
859   return g_object_new (GST_TYPE_PAD,
860       "name", name, "direction", templ->direction, "template", templ, NULL);
861 }
862
863 /**
864  * gst_pad_new_from_static_template:
865  * @templ: the #GstStaticPadTemplate to use
866  * @name: the name of the pad
867  *
868  * Creates a new pad with the given name from the given static template.
869  * If name is %NULL, a guaranteed unique name (across all pads)
870  * will be assigned.
871  * This function makes a copy of the name so you can safely free the name.
872  *
873  * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
874  * case of an error.
875  */
876 GstPad *
877 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
878     const gchar * name)
879 {
880   GstPad *pad;
881   GstPadTemplate *template;
882
883   template = gst_static_pad_template_get (templ);
884   pad = gst_pad_new_from_template (template, name);
885   gst_object_unref (template);
886   return pad;
887 }
888
889 #define ACQUIRE_PARENT(pad, parent, label)                      \
890   G_STMT_START {                                                \
891     if (G_LIKELY ((parent = GST_OBJECT_PARENT (pad))))          \
892       gst_object_ref (parent);                                  \
893     else if (G_LIKELY (GST_PAD_NEEDS_PARENT (pad)))             \
894       goto label;                                               \
895   } G_STMT_END
896
897 #define RELEASE_PARENT(parent)                                  \
898   G_STMT_START {                                                \
899     if (G_LIKELY (parent))                                      \
900       gst_object_unref (parent);                                \
901   } G_STMT_END
902
903 /**
904  * gst_pad_get_direction:
905  * @pad: a #GstPad to get the direction of.
906  *
907  * Gets the direction of the pad. The direction of the pad is
908  * decided at construction time so this function does not take
909  * the LOCK.
910  *
911  * Returns: the #GstPadDirection of the pad.
912  *
913  * MT safe.
914  */
915 GstPadDirection
916 gst_pad_get_direction (GstPad * pad)
917 {
918   GstPadDirection result;
919
920   /* PAD_UNKNOWN is a little silly but we need some sort of
921    * error return value */
922   g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
923
924   result = GST_PAD_DIRECTION (pad);
925
926   return result;
927 }
928
929 static gboolean
930 gst_pad_activate_default (GstPad * pad, GstObject * parent)
931 {
932   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
933
934   return activate_mode_internal (pad, parent, GST_PAD_MODE_PUSH, TRUE);
935 }
936
937 /**
938  * gst_pad_mode_get_name:
939  * @mode: the pad mode
940  *
941  * Return the name of a pad mode, for use in debug messages mostly.
942  *
943  * Returns: short mnemonic for pad mode @mode
944  */
945 const gchar *
946 gst_pad_mode_get_name (GstPadMode mode)
947 {
948   switch (mode) {
949     case GST_PAD_MODE_NONE:
950       return "none";
951     case GST_PAD_MODE_PUSH:
952       return "push";
953     case GST_PAD_MODE_PULL:
954       return "pull";
955     default:
956       break;
957   }
958   return "unknown";
959 }
960
961 static void
962 pre_activate (GstPad * pad, GstPadMode new_mode)
963 {
964   switch (new_mode) {
965     case GST_PAD_MODE_NONE:
966       GST_OBJECT_LOCK (pad);
967       GST_DEBUG_OBJECT (pad, "setting PAD_MODE NONE, set flushing");
968       GST_PAD_SET_FLUSHING (pad);
969       pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
970       GST_PAD_MODE (pad) = new_mode;
971       /* unlock blocked pads so element can resume and stop */
972       GST_PAD_BLOCK_BROADCAST (pad);
973       GST_OBJECT_UNLOCK (pad);
974       break;
975     case GST_PAD_MODE_PUSH:
976     case GST_PAD_MODE_PULL:
977       GST_OBJECT_LOCK (pad);
978       GST_DEBUG_OBJECT (pad, "setting pad into %s mode, unset flushing",
979           gst_pad_mode_get_name (new_mode));
980       GST_PAD_UNSET_FLUSHING (pad);
981       pad->ABI.abi.last_flowret = GST_FLOW_OK;
982       GST_PAD_MODE (pad) = new_mode;
983       if (GST_PAD_IS_SINK (pad)) {
984         GstPad *peer;
985         /* make sure the peer src pad sends us all events */
986         if ((peer = GST_PAD_PEER (pad))) {
987           gst_object_ref (peer);
988           GST_OBJECT_UNLOCK (pad);
989
990           GST_DEBUG_OBJECT (pad, "reschedule events on peer %s:%s",
991               GST_DEBUG_PAD_NAME (peer));
992
993           GST_OBJECT_LOCK (peer);
994           schedule_events (peer, NULL);
995           GST_OBJECT_UNLOCK (peer);
996
997           gst_object_unref (peer);
998         } else {
999           GST_OBJECT_UNLOCK (pad);
1000         }
1001       } else {
1002         GST_OBJECT_UNLOCK (pad);
1003       }
1004       break;
1005   }
1006 }
1007
1008 static void
1009 post_activate (GstPad * pad, GstPadMode new_mode)
1010 {
1011   switch (new_mode) {
1012     case GST_PAD_MODE_NONE:
1013       /* ensures that streaming stops */
1014       GST_PAD_STREAM_LOCK (pad);
1015       GST_DEBUG_OBJECT (pad, "stopped streaming");
1016       GST_OBJECT_LOCK (pad);
1017       remove_events (pad);
1018       GST_OBJECT_UNLOCK (pad);
1019       GST_PAD_STREAM_UNLOCK (pad);
1020       break;
1021     case GST_PAD_MODE_PUSH:
1022     case GST_PAD_MODE_PULL:
1023       /* NOP */
1024       break;
1025   }
1026 }
1027
1028 /**
1029  * gst_pad_set_active:
1030  * @pad: the #GstPad to activate or deactivate.
1031  * @active: whether or not the pad should be active.
1032  *
1033  * Activates or deactivates the given pad.
1034  * Normally called from within core state change functions.
1035  *
1036  * If @active, makes sure the pad is active. If it is already active, either in
1037  * push or pull mode, just return. Otherwise dispatches to the pad's activate
1038  * function to perform the actual activation.
1039  *
1040  * If not @active, calls gst_pad_activate_mode() with the pad's current mode
1041  * and a %FALSE argument.
1042  *
1043  * Returns: %TRUE if the operation was successful.
1044  *
1045  * MT safe.
1046  */
1047 gboolean
1048 gst_pad_set_active (GstPad * pad, gboolean active)
1049 {
1050   GstObject *parent;
1051   GstPadMode old;
1052   gboolean ret = FALSE;
1053
1054   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1055
1056   GST_OBJECT_LOCK (pad);
1057   old = GST_PAD_MODE (pad);
1058   ACQUIRE_PARENT (pad, parent, no_parent);
1059   GST_OBJECT_UNLOCK (pad);
1060
1061   if (active) {
1062     if (old == GST_PAD_MODE_NONE) {
1063       GST_DEBUG_OBJECT (pad, "activating pad from none");
1064       ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad, parent);
1065       if (ret)
1066         pad->ABI.abi.last_flowret = GST_FLOW_OK;
1067     } else {
1068       GST_DEBUG_OBJECT (pad, "pad was active in %s mode",
1069           gst_pad_mode_get_name (old));
1070       ret = TRUE;
1071     }
1072   } else {
1073     if (old == GST_PAD_MODE_NONE) {
1074       GST_DEBUG_OBJECT (pad, "pad was inactive");
1075       ret = TRUE;
1076     } else {
1077       GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1078           gst_pad_mode_get_name (old));
1079       ret = activate_mode_internal (pad, parent, old, FALSE);
1080       if (ret)
1081         pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
1082     }
1083   }
1084
1085   RELEASE_PARENT (parent);
1086
1087   if (G_UNLIKELY (!ret))
1088     goto failed;
1089
1090   return ret;
1091
1092   /* ERRORS */
1093 no_parent:
1094   {
1095     GST_DEBUG_OBJECT (pad, "no parent");
1096     GST_OBJECT_UNLOCK (pad);
1097     return FALSE;
1098   }
1099 failed:
1100   {
1101     GST_OBJECT_LOCK (pad);
1102     if (!active) {
1103       g_critical ("Failed to deactivate pad %s:%s, very bad",
1104           GST_DEBUG_PAD_NAME (pad));
1105     } else {
1106       GST_WARNING_OBJECT (pad, "Failed to activate pad");
1107     }
1108     GST_OBJECT_UNLOCK (pad);
1109     return FALSE;
1110   }
1111 }
1112
1113 static gboolean
1114 activate_mode_internal (GstPad * pad, GstObject * parent, GstPadMode mode,
1115     gboolean active)
1116 {
1117   gboolean res = FALSE;
1118   GstPadMode old, new;
1119   GstPadDirection dir;
1120   GstPad *peer;
1121
1122   GST_OBJECT_LOCK (pad);
1123   old = GST_PAD_MODE (pad);
1124   dir = GST_PAD_DIRECTION (pad);
1125   GST_OBJECT_UNLOCK (pad);
1126
1127   new = active ? mode : GST_PAD_MODE_NONE;
1128
1129   if (old == new)
1130     goto was_ok;
1131
1132   if (active && old != mode && old != GST_PAD_MODE_NONE) {
1133     /* pad was activate in the wrong direction, deactivate it
1134      * and reactivate it in the requested mode */
1135     GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1136         gst_pad_mode_get_name (old));
1137
1138     if (G_UNLIKELY (!activate_mode_internal (pad, parent, old, FALSE)))
1139       goto deactivate_failed;
1140     old = GST_PAD_MODE_NONE;
1141   }
1142
1143   switch (mode) {
1144     case GST_PAD_MODE_PULL:
1145     {
1146       if (dir == GST_PAD_SINK) {
1147         if ((peer = gst_pad_get_peer (pad))) {
1148           GST_DEBUG_OBJECT (pad, "calling peer");
1149           if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
1150             goto peer_failed;
1151           gst_object_unref (peer);
1152         } else {
1153           /* there is no peer, this is only fatal when we activate. When we
1154            * deactivate, we must assume the application has unlinked the peer and
1155            * will deactivate it eventually. */
1156           if (active)
1157             goto not_linked;
1158           else
1159             GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
1160         }
1161       } else {
1162         if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
1163           goto failure;         /* Can't activate pull on a src without a
1164                                    getrange function */
1165       }
1166       break;
1167     }
1168     default:
1169       break;
1170   }
1171
1172   /* Mark pad as needing reconfiguration */
1173   if (active)
1174     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1175   pre_activate (pad, new);
1176
1177   if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1178     if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1179                 active)))
1180       goto failure;
1181   } else {
1182     /* can happen for sinks of passthrough elements */
1183   }
1184
1185   post_activate (pad, new);
1186
1187   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in %s mode",
1188       active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1189
1190 exit_success:
1191   res = TRUE;
1192
1193   /* Clear sticky flags on deactivation */
1194   if (!active) {
1195     GST_OBJECT_LOCK (pad);
1196     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1197     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
1198     GST_OBJECT_UNLOCK (pad);
1199   }
1200
1201 exit:
1202   return res;
1203
1204 was_ok:
1205   {
1206     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in %s mode",
1207         active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1208     goto exit_success;
1209   }
1210 deactivate_failed:
1211   {
1212     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1213         "failed to %s in switch to %s mode from %s mode",
1214         (active ? "activate" : "deactivate"), gst_pad_mode_get_name (mode),
1215         gst_pad_mode_get_name (old));
1216     goto exit;
1217   }
1218 peer_failed:
1219   {
1220     GST_OBJECT_LOCK (peer);
1221     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1222         "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1223     GST_OBJECT_UNLOCK (peer);
1224     gst_object_unref (peer);
1225     goto exit;
1226   }
1227 not_linked:
1228   {
1229     GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1230         "pad in pull mode");
1231     goto exit;
1232   }
1233 failure:
1234   {
1235     GST_OBJECT_LOCK (pad);
1236     GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in %s mode",
1237         active ? "activate" : "deactivate", gst_pad_mode_get_name (mode));
1238     GST_PAD_SET_FLUSHING (pad);
1239     GST_PAD_MODE (pad) = old;
1240     GST_OBJECT_UNLOCK (pad);
1241     goto exit;
1242   }
1243 }
1244
1245 /**
1246  * gst_pad_activate_mode:
1247  * @pad: the #GstPad to activate or deactivate.
1248  * @mode: the requested activation mode
1249  * @active: whether or not the pad should be active.
1250  *
1251  * Activates or deactivates the given pad in @mode via dispatching to the
1252  * pad's activatemodefunc. For use from within pad activation functions only.
1253  *
1254  * If you don't know what this is, you probably don't want to call it.
1255  *
1256  * Returns: %TRUE if the operation was successful.
1257  *
1258  * MT safe.
1259  */
1260 gboolean
1261 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
1262 {
1263   GstObject *parent;
1264   gboolean res;
1265
1266   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1267
1268   GST_OBJECT_LOCK (pad);
1269   ACQUIRE_PARENT (pad, parent, no_parent);
1270   GST_OBJECT_UNLOCK (pad);
1271
1272   res = activate_mode_internal (pad, parent, mode, active);
1273
1274   RELEASE_PARENT (parent);
1275
1276   return res;
1277
1278 no_parent:
1279   {
1280     GST_WARNING_OBJECT (pad, "no parent");
1281     GST_OBJECT_UNLOCK (pad);
1282     return FALSE;
1283   }
1284 }
1285
1286 /**
1287  * gst_pad_is_active:
1288  * @pad: the #GstPad to query
1289  *
1290  * Query if a pad is active
1291  *
1292  * Returns: %TRUE if the pad is active.
1293  *
1294  * MT safe.
1295  */
1296 gboolean
1297 gst_pad_is_active (GstPad * pad)
1298 {
1299   gboolean result = FALSE;
1300
1301   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1302
1303   GST_OBJECT_LOCK (pad);
1304   result = GST_PAD_IS_ACTIVE (pad);
1305   GST_OBJECT_UNLOCK (pad);
1306
1307   return result;
1308 }
1309
1310 static void
1311 cleanup_hook (GstPad * pad, GHook * hook)
1312 {
1313   GstPadProbeType type;
1314
1315   if (!G_HOOK_IS_VALID (hook))
1316     return;
1317
1318   type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1319
1320   if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1321     /* unblock when we remove the last blocking probe */
1322     pad->num_blocked--;
1323     GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1324         pad->num_blocked);
1325
1326     /* Might have new probes now that want to be called */
1327     GST_PAD_BLOCK_BROADCAST (pad);
1328
1329     if (pad->num_blocked == 0) {
1330       GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1331       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1332     }
1333   }
1334   g_hook_destroy_link (&pad->probes, hook);
1335   pad->num_probes--;
1336 }
1337
1338 /**
1339  * gst_pad_add_probe:
1340  * @pad: the #GstPad to add the probe to
1341  * @mask: the probe mask
1342  * @callback: #GstPadProbeCallback that will be called with notifications of
1343  *           the pad state
1344  * @user_data: (closure): user data passed to the callback
1345  * @destroy_data: #GDestroyNotify for user_data
1346  *
1347  * Be notified of different states of pads. The provided callback is called for
1348  * every state that matches @mask.
1349  *
1350  * Probes are called in groups: First GST_PAD_PROBE_TYPE_BLOCK probes are
1351  * called, then others, then finally GST_PAD_PROBE_TYPE_IDLE. The only
1352  * exception here are GST_PAD_PROBE_TYPE_IDLE probes that are called
1353  * immediately if the pad is already idle while calling gst_pad_add_probe().
1354  * In each of the groups, probes are called in the order in which they were
1355  * added.
1356  *
1357  * Returns: an id or 0 if no probe is pending. The id can be used to remove the
1358  * probe with gst_pad_remove_probe(). When using GST_PAD_PROBE_TYPE_IDLE it can
1359  * happen that the probe can be run immediately and if the probe returns
1360  * GST_PAD_PROBE_REMOVE this functions returns 0.
1361  *
1362  * MT safe.
1363  */
1364 gulong
1365 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1366     GstPadProbeCallback callback, gpointer user_data,
1367     GDestroyNotify destroy_data)
1368 {
1369   GHook *hook;
1370   gulong res;
1371
1372   g_return_val_if_fail (GST_IS_PAD (pad), 0);
1373   g_return_val_if_fail (mask != 0, 0);
1374
1375   GST_OBJECT_LOCK (pad);
1376
1377   /* make a new probe */
1378   hook = g_hook_alloc (&pad->probes);
1379
1380   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1381       mask);
1382
1383   /* when no contraints are given for the types, assume all types are
1384    * acceptable */
1385   if ((mask & _PAD_PROBE_TYPE_ALL_BOTH_AND_FLUSH) == 0)
1386     mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1387   if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1388     mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1389
1390   /* store our flags and other fields */
1391   hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1392   hook->func = callback;
1393   hook->data = user_data;
1394   hook->destroy = destroy_data;
1395   PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1396
1397   /* add the probe */
1398   g_hook_append (&pad->probes, hook);
1399   pad->num_probes++;
1400   /* incremenent cookie so that the new hook get's called */
1401   pad->priv->probe_list_cookie++;
1402
1403   /* get the id of the hook, we return this and it can be used to remove the
1404    * probe later */
1405   res = hook->hook_id;
1406
1407   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1408
1409   if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1410     /* we have a block probe */
1411     pad->num_blocked++;
1412     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1413     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1414         "now %d blocking probes", pad->num_blocked);
1415
1416     /* Might have new probes now that want to be called */
1417     GST_PAD_BLOCK_BROADCAST (pad);
1418   }
1419
1420   /* call the callback if we need to be called for idle callbacks */
1421   if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1422     if (pad->priv->using > 0) {
1423       /* the pad is in use, we can't signal the idle callback yet. Since we set the
1424        * flag above, the last thread to leave the push will do the callback. New
1425        * threads going into the push will block. */
1426       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1427           "pad is in use, delay idle callback");
1428       GST_OBJECT_UNLOCK (pad);
1429     } else {
1430       GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1431       GstPadProbeReturn ret;
1432
1433       /* Keep another ref, the callback could destroy the pad */
1434       gst_object_ref (pad);
1435       pad->priv->idle_running++;
1436
1437       /* the pad is idle now, we can signal the idle callback now */
1438       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1439           "pad is idle, trigger idle callback");
1440       GST_OBJECT_UNLOCK (pad);
1441
1442       ret = callback (pad, &info, user_data);
1443
1444       GST_OBJECT_LOCK (pad);
1445       switch (ret) {
1446         case GST_PAD_PROBE_REMOVE:
1447           /* remove the probe */
1448           GST_DEBUG_OBJECT (pad, "asked to remove hook");
1449           cleanup_hook (pad, hook);
1450           res = 0;
1451           break;
1452         case GST_PAD_PROBE_DROP:
1453           GST_DEBUG_OBJECT (pad, "asked to drop item");
1454           break;
1455         case GST_PAD_PROBE_PASS:
1456           GST_DEBUG_OBJECT (pad, "asked to pass item");
1457           break;
1458         case GST_PAD_PROBE_OK:
1459           GST_DEBUG_OBJECT (pad, "probe returned OK");
1460           break;
1461         case GST_PAD_PROBE_HANDLED:
1462           GST_DEBUG_OBJECT (pad, "probe handled the data");
1463           break;
1464         default:
1465           GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
1466           break;
1467       }
1468       pad->priv->idle_running--;
1469       if (pad->priv->idle_running == 0) {
1470         GST_PAD_BLOCK_BROADCAST (pad);
1471       }
1472       GST_OBJECT_UNLOCK (pad);
1473
1474       gst_object_unref (pad);
1475     }
1476   } else {
1477     GST_OBJECT_UNLOCK (pad);
1478   }
1479   return res;
1480 }
1481
1482 /**
1483  * gst_pad_remove_probe:
1484  * @pad: the #GstPad with the probe
1485  * @id: the probe id to remove
1486  *
1487  * Remove the probe with @id from @pad.
1488  *
1489  * MT safe.
1490  */
1491 void
1492 gst_pad_remove_probe (GstPad * pad, gulong id)
1493 {
1494   GHook *hook;
1495
1496   g_return_if_fail (GST_IS_PAD (pad));
1497
1498   GST_OBJECT_LOCK (pad);
1499
1500   hook = g_hook_get (&pad->probes, id);
1501   if (hook == NULL)
1502     goto not_found;
1503
1504   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1505       hook->hook_id);
1506   cleanup_hook (pad, hook);
1507   GST_OBJECT_UNLOCK (pad);
1508
1509   return;
1510
1511 not_found:
1512   {
1513     GST_OBJECT_UNLOCK (pad);
1514     g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1515     return;
1516   }
1517 }
1518
1519 /**
1520  * gst_pad_is_blocked:
1521  * @pad: the #GstPad to query
1522  *
1523  * Checks if the pad is blocked or not. This function returns the
1524  * last requested state of the pad. It is not certain that the pad
1525  * is actually blocking at this point (see gst_pad_is_blocking()).
1526  *
1527  * Returns: %TRUE if the pad is blocked.
1528  *
1529  * MT safe.
1530  */
1531 gboolean
1532 gst_pad_is_blocked (GstPad * pad)
1533 {
1534   gboolean result = FALSE;
1535
1536   g_return_val_if_fail (GST_IS_PAD (pad), result);
1537
1538   GST_OBJECT_LOCK (pad);
1539   result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1540   GST_OBJECT_UNLOCK (pad);
1541
1542   return result;
1543 }
1544
1545 /**
1546  * gst_pad_is_blocking:
1547  * @pad: the #GstPad to query
1548  *
1549  * Checks if the pad is blocking or not. This is a guaranteed state
1550  * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1551  *
1552  * Returns: %TRUE if the pad is blocking.
1553  *
1554  * MT safe.
1555  */
1556 gboolean
1557 gst_pad_is_blocking (GstPad * pad)
1558 {
1559   gboolean result = FALSE;
1560
1561   g_return_val_if_fail (GST_IS_PAD (pad), result);
1562
1563   GST_OBJECT_LOCK (pad);
1564   /* the blocking flag is only valid if the pad is not flushing */
1565   result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1566   GST_OBJECT_UNLOCK (pad);
1567
1568   return result;
1569 }
1570
1571 /**
1572  * gst_pad_needs_reconfigure:
1573  * @pad: the #GstPad to check
1574  *
1575  * Check the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1576  * if the flag was set.
1577  *
1578  * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag is set on @pad.
1579  */
1580 gboolean
1581 gst_pad_needs_reconfigure (GstPad * pad)
1582 {
1583   gboolean reconfigure;
1584
1585   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1586
1587   GST_OBJECT_LOCK (pad);
1588   reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1589   GST_DEBUG_OBJECT (pad, "peeking RECONFIGURE flag %d", reconfigure);
1590   GST_OBJECT_UNLOCK (pad);
1591
1592   return reconfigure;
1593 }
1594
1595 /**
1596  * gst_pad_check_reconfigure:
1597  * @pad: the #GstPad to check
1598  *
1599  * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1600  * if the flag was set.
1601  *
1602  * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1603  */
1604 gboolean
1605 gst_pad_check_reconfigure (GstPad * pad)
1606 {
1607   gboolean reconfigure;
1608
1609   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1610
1611   GST_OBJECT_LOCK (pad);
1612   reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1613   if (reconfigure) {
1614     GST_DEBUG_OBJECT (pad, "remove RECONFIGURE flag");
1615     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1616   }
1617   GST_OBJECT_UNLOCK (pad);
1618
1619   return reconfigure;
1620 }
1621
1622 /**
1623  * gst_pad_mark_reconfigure:
1624  * @pad: the #GstPad to mark
1625  *
1626  * Mark a pad for needing reconfiguration. The next call to
1627  * gst_pad_check_reconfigure() will return %TRUE after this call.
1628  */
1629 void
1630 gst_pad_mark_reconfigure (GstPad * pad)
1631 {
1632   g_return_if_fail (GST_IS_PAD (pad));
1633
1634   GST_OBJECT_LOCK (pad);
1635   GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1636   GST_OBJECT_UNLOCK (pad);
1637 }
1638
1639 /**
1640  * gst_pad_set_activate_function:
1641  * @p: a #GstPad.
1642  * @f: the #GstPadActivateFunction to set.
1643  *
1644  * Calls gst_pad_set_activate_function_full() with %NULL for the user_data and
1645  * notify.
1646  */
1647 /**
1648  * gst_pad_set_activate_function_full:
1649  * @pad: a #GstPad.
1650  * @activate: the #GstPadActivateFunction to set.
1651  * @user_data: user_data passed to @notify
1652  * @notify: notify called when @activate will not be used anymore.
1653  *
1654  * Sets the given activate function for @pad. The activate function will
1655  * dispatch to gst_pad_activate_mode() to perform the actual activation.
1656  * Only makes sense to set on sink pads.
1657  *
1658  * Call this function if your sink pad can start a pull-based task.
1659  */
1660 void
1661 gst_pad_set_activate_function_full (GstPad * pad,
1662     GstPadActivateFunction activate, gpointer user_data, GDestroyNotify notify)
1663 {
1664   g_return_if_fail (GST_IS_PAD (pad));
1665
1666   if (pad->activatenotify)
1667     pad->activatenotify (pad->activatedata);
1668   GST_PAD_ACTIVATEFUNC (pad) = activate;
1669   pad->activatedata = user_data;
1670   pad->activatenotify = notify;
1671
1672   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1673       GST_DEBUG_FUNCPTR_NAME (activate));
1674 }
1675
1676 /**
1677  * gst_pad_set_activatemode_function:
1678  * @p: a #GstPad.
1679  * @f: the #GstPadActivateModeFunction to set.
1680  *
1681  * Calls gst_pad_set_activatemode_function_full() with %NULL for the user_data and
1682  * notify.
1683  */
1684 /**
1685  * gst_pad_set_activatemode_function_full:
1686  * @pad: a #GstPad.
1687  * @activatemode: the #GstPadActivateModeFunction to set.
1688  * @user_data: user_data passed to @notify
1689  * @notify: notify called when @activatemode will not be used anymore.
1690  *
1691  * Sets the given activate_mode function for the pad. An activate_mode function
1692  * prepares the element for data passing.
1693  */
1694 void
1695 gst_pad_set_activatemode_function_full (GstPad * pad,
1696     GstPadActivateModeFunction activatemode, gpointer user_data,
1697     GDestroyNotify notify)
1698 {
1699   g_return_if_fail (GST_IS_PAD (pad));
1700
1701   if (pad->activatemodenotify)
1702     pad->activatemodenotify (pad->activatemodedata);
1703   GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1704   pad->activatemodedata = user_data;
1705   pad->activatemodenotify = notify;
1706
1707   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1708       GST_DEBUG_FUNCPTR_NAME (activatemode));
1709 }
1710
1711 /**
1712  * gst_pad_set_chain_function:
1713  * @p: a sink #GstPad.
1714  * @f: the #GstPadChainFunction to set.
1715  *
1716  * Calls gst_pad_set_chain_function_full() with %NULL for the user_data and
1717  * notify.
1718  */
1719 /**
1720  * gst_pad_set_chain_function_full:
1721  * @pad: a sink #GstPad.
1722  * @chain: the #GstPadChainFunction to set.
1723  * @user_data: user_data passed to @notify
1724  * @notify: notify called when @chain will not be used anymore.
1725  *
1726  * Sets the given chain function for the pad. The chain function is called to
1727  * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1728  */
1729 void
1730 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1731     gpointer user_data, GDestroyNotify notify)
1732 {
1733   g_return_if_fail (GST_IS_PAD (pad));
1734   g_return_if_fail (GST_PAD_IS_SINK (pad));
1735
1736   if (pad->chainnotify)
1737     pad->chainnotify (pad->chaindata);
1738   GST_PAD_CHAINFUNC (pad) = chain;
1739   pad->chaindata = user_data;
1740   pad->chainnotify = notify;
1741
1742   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1743       GST_DEBUG_FUNCPTR_NAME (chain));
1744 }
1745
1746 /**
1747  * gst_pad_set_chain_list_function:
1748  * @p: a sink #GstPad.
1749  * @f: the #GstPadChainListFunction to set.
1750  *
1751  * Calls gst_pad_set_chain_list_function_full() with %NULL for the user_data and
1752  * notify.
1753  */
1754 /**
1755  * gst_pad_set_chain_list_function_full:
1756  * @pad: a sink #GstPad.
1757  * @chainlist: the #GstPadChainListFunction to set.
1758  * @user_data: user_data passed to @notify
1759  * @notify: notify called when @chainlist will not be used anymore.
1760  *
1761  * Sets the given chain list function for the pad. The chainlist function is
1762  * called to process a #GstBufferList input buffer list. See
1763  * #GstPadChainListFunction for more details.
1764  */
1765 void
1766 gst_pad_set_chain_list_function_full (GstPad * pad,
1767     GstPadChainListFunction chainlist, gpointer user_data,
1768     GDestroyNotify notify)
1769 {
1770   g_return_if_fail (GST_IS_PAD (pad));
1771   g_return_if_fail (GST_PAD_IS_SINK (pad));
1772
1773   if (pad->chainlistnotify)
1774     pad->chainlistnotify (pad->chainlistdata);
1775   GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1776   pad->chainlistdata = user_data;
1777   pad->chainlistnotify = notify;
1778
1779   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1780       GST_DEBUG_FUNCPTR_NAME (chainlist));
1781 }
1782
1783 /**
1784  * gst_pad_set_getrange_function:
1785  * @p: a source #GstPad.
1786  * @f: the #GstPadGetRangeFunction to set.
1787  *
1788  * Calls gst_pad_set_getrange_function_full() with %NULL for the user_data and
1789  * notify.
1790  */
1791 /**
1792  * gst_pad_set_getrange_function_full:
1793  * @pad: a source #GstPad.
1794  * @get: the #GstPadGetRangeFunction to set.
1795  * @user_data: user_data passed to @notify
1796  * @notify: notify called when @get will not be used anymore.
1797  *
1798  * Sets the given getrange function for the pad. The getrange function is
1799  * called to produce a new #GstBuffer to start the processing pipeline. see
1800  * #GstPadGetRangeFunction for a description of the getrange function.
1801  */
1802 void
1803 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1804     gpointer user_data, GDestroyNotify notify)
1805 {
1806   g_return_if_fail (GST_IS_PAD (pad));
1807   g_return_if_fail (GST_PAD_IS_SRC (pad));
1808
1809   if (pad->getrangenotify)
1810     pad->getrangenotify (pad->getrangedata);
1811   GST_PAD_GETRANGEFUNC (pad) = get;
1812   pad->getrangedata = user_data;
1813   pad->getrangenotify = notify;
1814
1815   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1816       GST_DEBUG_FUNCPTR_NAME (get));
1817 }
1818
1819 /**
1820  * gst_pad_set_event_function:
1821  * @p: a #GstPad of either direction.
1822  * @f: the #GstPadEventFunction to set.
1823  *
1824  * Calls gst_pad_set_event_function_full() with %NULL for the user_data and
1825  * notify.
1826  */
1827 /**
1828  * gst_pad_set_event_function_full:
1829  * @pad: a #GstPad of either direction.
1830  * @event: the #GstPadEventFunction to set.
1831  * @user_data: user_data passed to @notify
1832  * @notify: notify called when @event will not be used anymore.
1833  *
1834  * Sets the given event handler for the pad.
1835  */
1836 void
1837 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1838     gpointer user_data, GDestroyNotify notify)
1839 {
1840   g_return_if_fail (GST_IS_PAD (pad));
1841
1842   if (pad->eventnotify)
1843     pad->eventnotify (pad->eventdata);
1844   GST_PAD_EVENTFUNC (pad) = event;
1845   pad->eventdata = user_data;
1846   pad->eventnotify = notify;
1847
1848   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1849       GST_DEBUG_FUNCPTR_NAME (event));
1850 }
1851
1852 static gboolean
1853 event_wrap (GstPad * pad, GstObject * object, GstEvent * event)
1854 {
1855   GstFlowReturn ret;
1856
1857   ret = GST_PAD_EVENTFULLFUNC (pad) (pad, object, event);
1858   if (ret == GST_FLOW_OK)
1859     return TRUE;
1860   return FALSE;
1861 }
1862
1863 /**
1864  * gst_pad_set_event_full_function:
1865  * @p: a #GstPad of either direction.
1866  * @f: the #GstPadEventFullFunction to set.
1867  *
1868  * Calls gst_pad_set_event_full_function_full() with %NULL for the user_data and
1869  * notify.
1870  */
1871 /**
1872  * gst_pad_set_event_full_function_full:
1873  * @pad: a #GstPad of either direction.
1874  * @event: the #GstPadEventFullFunction to set.
1875  * @user_data: user_data passed to @notify
1876  * @notify: notify called when @event will not be used anymore.
1877  *
1878  * Sets the given event handler for the pad.
1879  *
1880  * Since: 1.8
1881  */
1882 void
1883 gst_pad_set_event_full_function_full (GstPad * pad,
1884     GstPadEventFullFunction event, gpointer user_data, GDestroyNotify notify)
1885 {
1886   g_return_if_fail (GST_IS_PAD (pad));
1887
1888   if (pad->eventnotify)
1889     pad->eventnotify (pad->eventdata);
1890   GST_PAD_EVENTFULLFUNC (pad) = event;
1891   GST_PAD_EVENTFUNC (pad) = event_wrap;
1892   pad->eventdata = user_data;
1893   pad->eventnotify = notify;
1894
1895   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfullfunc for set to %s",
1896       GST_DEBUG_FUNCPTR_NAME (event));
1897 }
1898
1899 /**
1900  * gst_pad_set_query_function:
1901  * @p: a #GstPad of either direction.
1902  * @f: the #GstPadQueryFunction to set.
1903  *
1904  * Calls gst_pad_set_query_function_full() with %NULL for the user_data and
1905  * notify.
1906  */
1907 /**
1908  * gst_pad_set_query_function_full:
1909  * @pad: a #GstPad of either direction.
1910  * @query: the #GstPadQueryFunction to set.
1911  * @user_data: user_data passed to @notify
1912  * @notify: notify called when @query will not be used anymore.
1913  *
1914  * Set the given query function for the pad.
1915  */
1916 void
1917 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1918     gpointer user_data, GDestroyNotify notify)
1919 {
1920   g_return_if_fail (GST_IS_PAD (pad));
1921
1922   if (pad->querynotify)
1923     pad->querynotify (pad->querydata);
1924   GST_PAD_QUERYFUNC (pad) = query;
1925   pad->querydata = user_data;
1926   pad->querynotify = notify;
1927
1928   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1929       GST_DEBUG_FUNCPTR_NAME (query));
1930 }
1931
1932 /**
1933  * gst_pad_set_iterate_internal_links_function:
1934  * @p: a #GstPad of either direction.
1935  * @f: the #GstPadIterIntLinkFunction to set.
1936  *
1937  * Calls gst_pad_set_iterate_internal_links_function_full() with %NULL
1938  * for the user_data and notify.
1939  */
1940 /**
1941  * gst_pad_set_iterate_internal_links_function_full:
1942  * @pad: a #GstPad of either direction.
1943  * @iterintlink: the #GstPadIterIntLinkFunction to set.
1944  * @user_data: user_data passed to @notify
1945  * @notify: notify called when @iterintlink will not be used anymore.
1946  *
1947  * Sets the given internal link iterator function for the pad.
1948  */
1949 void
1950 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1951     GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1952     GDestroyNotify notify)
1953 {
1954   g_return_if_fail (GST_IS_PAD (pad));
1955
1956   if (pad->iterintlinknotify)
1957     pad->iterintlinknotify (pad->iterintlinkdata);
1958   GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1959   pad->iterintlinkdata = user_data;
1960   pad->iterintlinknotify = notify;
1961
1962   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1963       GST_DEBUG_FUNCPTR_NAME (iterintlink));
1964 }
1965
1966 /**
1967  * gst_pad_set_link_function:
1968  * @p: a #GstPad.
1969  * @f: the #GstPadLinkFunction to set.
1970  *
1971  * Calls gst_pad_set_link_function_full() with %NULL
1972  * for the user_data and notify.
1973  */
1974 /**
1975  * gst_pad_set_link_function_full:
1976  * @pad: a #GstPad.
1977  * @link: the #GstPadLinkFunction to set.
1978  * @user_data: user_data passed to @notify
1979  * @notify: notify called when @link will not be used anymore.
1980  *
1981  * Sets the given link function for the pad. It will be called when
1982  * the pad is linked with another pad.
1983  *
1984  * The return value #GST_PAD_LINK_OK should be used when the connection can be
1985  * made.
1986  *
1987  * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1988  * cannot be made for some reason.
1989  *
1990  * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1991  * of the peer sink pad, if present.
1992  */
1993 void
1994 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1995     gpointer user_data, GDestroyNotify notify)
1996 {
1997   g_return_if_fail (GST_IS_PAD (pad));
1998
1999   if (pad->linknotify)
2000     pad->linknotify (pad->linkdata);
2001   GST_PAD_LINKFUNC (pad) = link;
2002   pad->linkdata = user_data;
2003   pad->linknotify = notify;
2004
2005   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
2006       GST_DEBUG_FUNCPTR_NAME (link));
2007 }
2008
2009 /**
2010  * gst_pad_set_unlink_function:
2011  * @p: a #GstPad.
2012  * @f: the #GstPadUnlinkFunction to set.
2013  *
2014  * Calls gst_pad_set_unlink_function_full() with %NULL
2015  * for the user_data and notify.
2016  */
2017 /**
2018  * gst_pad_set_unlink_function_full:
2019  * @pad: a #GstPad.
2020  * @unlink: the #GstPadUnlinkFunction to set.
2021  * @user_data: user_data passed to @notify
2022  * @notify: notify called when @unlink will not be used anymore.
2023  *
2024  * Sets the given unlink function for the pad. It will be called
2025  * when the pad is unlinked.
2026  */
2027 void
2028 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
2029     gpointer user_data, GDestroyNotify notify)
2030 {
2031   g_return_if_fail (GST_IS_PAD (pad));
2032
2033   if (pad->unlinknotify)
2034     pad->unlinknotify (pad->unlinkdata);
2035   GST_PAD_UNLINKFUNC (pad) = unlink;
2036   pad->unlinkdata = user_data;
2037   pad->unlinknotify = notify;
2038
2039   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
2040       GST_DEBUG_FUNCPTR_NAME (unlink));
2041 }
2042
2043 /**
2044  * gst_pad_unlink:
2045  * @srcpad: the source #GstPad to unlink.
2046  * @sinkpad: the sink #GstPad to unlink.
2047  *
2048  * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
2049  * signal on both pads.
2050  *
2051  * Returns: %TRUE if the pads were unlinked. This function returns %FALSE if
2052  * the pads were not linked together.
2053  *
2054  * MT safe.
2055  */
2056 gboolean
2057 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
2058 {
2059   gboolean result = FALSE;
2060   GstElement *parent = NULL;
2061
2062   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2063   g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
2064   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2065   g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
2066
2067   GST_TRACER_PAD_UNLINK_PRE (srcpad, sinkpad);
2068
2069   GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
2070       GST_DEBUG_PAD_NAME (srcpad), srcpad,
2071       GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
2072
2073   /* We need to notify the parent before taking any pad locks as the bin in
2074    * question might be waiting for a lock on the pad while holding its lock
2075    * that our message will try to take. */
2076   if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
2077     if (GST_IS_ELEMENT (parent)) {
2078       gst_element_post_message (parent,
2079           gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2080               GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
2081     } else {
2082       gst_object_unref (parent);
2083       parent = NULL;
2084     }
2085   }
2086
2087   GST_OBJECT_LOCK (srcpad);
2088   GST_OBJECT_LOCK (sinkpad);
2089
2090   if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
2091     goto not_linked_together;
2092
2093   if (GST_PAD_UNLINKFUNC (srcpad)) {
2094     GstObject *tmpparent;
2095
2096     ACQUIRE_PARENT (srcpad, tmpparent, no_src_parent);
2097
2098     GST_PAD_UNLINKFUNC (srcpad) (srcpad, tmpparent);
2099     RELEASE_PARENT (tmpparent);
2100   }
2101 no_src_parent:
2102   if (GST_PAD_UNLINKFUNC (sinkpad)) {
2103     GstObject *tmpparent;
2104
2105     ACQUIRE_PARENT (sinkpad, tmpparent, no_sink_parent);
2106
2107     GST_PAD_UNLINKFUNC (sinkpad) (sinkpad, tmpparent);
2108     RELEASE_PARENT (tmpparent);
2109   }
2110 no_sink_parent:
2111
2112   /* first clear peers */
2113   GST_PAD_PEER (srcpad) = NULL;
2114   GST_PAD_PEER (sinkpad) = NULL;
2115
2116   GST_OBJECT_UNLOCK (sinkpad);
2117   GST_OBJECT_UNLOCK (srcpad);
2118
2119   /* fire off a signal to each of the pads telling them
2120    * that they've been unlinked */
2121   g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
2122   g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
2123
2124   GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
2125       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2126
2127   result = TRUE;
2128
2129 done:
2130   if (parent != NULL) {
2131     gst_element_post_message (parent,
2132         gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2133             GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
2134     gst_object_unref (parent);
2135   }
2136   GST_TRACER_PAD_UNLINK_POST (srcpad, sinkpad, result);
2137   return result;
2138
2139   /* ERRORS */
2140 not_linked_together:
2141   {
2142     /* we do not emit a warning in this case because unlinking cannot
2143      * be made MT safe.*/
2144     GST_OBJECT_UNLOCK (sinkpad);
2145     GST_OBJECT_UNLOCK (srcpad);
2146     goto done;
2147   }
2148 }
2149
2150 /**
2151  * gst_pad_is_linked:
2152  * @pad: pad to check
2153  *
2154  * Checks if a @pad is linked to another pad or not.
2155  *
2156  * Returns: %TRUE if the pad is linked, %FALSE otherwise.
2157  *
2158  * MT safe.
2159  */
2160 gboolean
2161 gst_pad_is_linked (GstPad * pad)
2162 {
2163   gboolean result;
2164
2165   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2166
2167   GST_OBJECT_LOCK (pad);
2168   result = (GST_PAD_PEER (pad) != NULL);
2169   GST_OBJECT_UNLOCK (pad);
2170
2171   return result;
2172 }
2173
2174 /* get the caps from both pads and see if the intersection
2175  * is not empty.
2176  *
2177  * This function should be called with the pad LOCK on both
2178  * pads
2179  */
2180 static gboolean
2181 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
2182     GstPadLinkCheck flags)
2183 {
2184   GstCaps *srccaps = NULL;
2185   GstCaps *sinkcaps = NULL;
2186   gboolean compatible = FALSE;
2187
2188   if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
2189     return TRUE;
2190
2191   /* Doing the expensive caps checking takes priority over only checking the template caps */
2192   if (flags & GST_PAD_LINK_CHECK_CAPS) {
2193     GST_OBJECT_UNLOCK (sink);
2194     GST_OBJECT_UNLOCK (src);
2195
2196     srccaps = gst_pad_query_caps (src, NULL);
2197     sinkcaps = gst_pad_query_caps (sink, NULL);
2198
2199     GST_OBJECT_LOCK (src);
2200     GST_OBJECT_LOCK (sink);
2201   } else {
2202     /* If one of the two pads doesn't have a template, consider the intersection
2203      * as valid.*/
2204     if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
2205             || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
2206       compatible = TRUE;
2207       goto done;
2208     }
2209     srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
2210     sinkcaps =
2211         gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
2212   }
2213
2214   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
2215       srccaps);
2216   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
2217       sinkcaps);
2218
2219   /* if we have caps on both pads we can check the intersection. If one
2220    * of the caps is %NULL, we return %TRUE. */
2221   if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
2222     if (srccaps)
2223       gst_caps_unref (srccaps);
2224     if (sinkcaps)
2225       gst_caps_unref (sinkcaps);
2226     goto done;
2227   }
2228
2229   compatible = gst_caps_can_intersect (srccaps, sinkcaps);
2230   gst_caps_unref (srccaps);
2231   gst_caps_unref (sinkcaps);
2232
2233 done:
2234   GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
2235       (compatible ? "" : "not "));
2236
2237   return compatible;
2238 }
2239
2240 /* check if the grandparents of both pads are the same.
2241  * This check is required so that we don't try to link
2242  * pads from elements in different bins without ghostpads.
2243  *
2244  * The LOCK should be held on both pads
2245  */
2246 static gboolean
2247 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
2248 {
2249   GstObject *psrc, *psink;
2250
2251   psrc = GST_OBJECT_PARENT (src);
2252   psink = GST_OBJECT_PARENT (sink);
2253
2254   /* if one of the pads has no parent, we allow the link */
2255   if (G_UNLIKELY (psrc == NULL || psink == NULL))
2256     goto no_parent;
2257
2258   /* only care about parents that are elements */
2259   if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
2260     goto no_element_parent;
2261
2262   /* if the parents are the same, we have a loop */
2263   if (G_UNLIKELY (psrc == psink))
2264     goto same_parents;
2265
2266   /* if they both have a parent, we check the grandparents. We can not lock
2267    * the parent because we hold on the child (pad) and the locking order is
2268    * parent >> child. */
2269   psrc = GST_OBJECT_PARENT (psrc);
2270   psink = GST_OBJECT_PARENT (psink);
2271
2272   /* if they have grandparents but they are not the same */
2273   if (G_UNLIKELY (psrc != psink))
2274     goto wrong_grandparents;
2275
2276   return TRUE;
2277
2278   /* ERRORS */
2279 no_parent:
2280   {
2281     GST_CAT_DEBUG (GST_CAT_CAPS,
2282         "one of the pads has no parent %" GST_PTR_FORMAT " and %"
2283         GST_PTR_FORMAT, psrc, psink);
2284     return TRUE;
2285   }
2286 no_element_parent:
2287   {
2288     GST_CAT_DEBUG (GST_CAT_CAPS,
2289         "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
2290         GST_PTR_FORMAT, psrc, psink);
2291     return TRUE;
2292   }
2293 same_parents:
2294   {
2295     GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
2296         psrc);
2297     return FALSE;
2298   }
2299 wrong_grandparents:
2300   {
2301     GST_CAT_DEBUG (GST_CAT_CAPS,
2302         "pads have different grandparents %" GST_PTR_FORMAT " and %"
2303         GST_PTR_FORMAT, psrc, psink);
2304     return FALSE;
2305   }
2306 }
2307
2308 /* FIXME leftover from an attempt at refactoring... */
2309 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
2310  * the two pads will be locked in the srcpad, sinkpad order. */
2311 static GstPadLinkReturn
2312 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2313 {
2314   GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2315       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2316
2317   GST_OBJECT_LOCK (srcpad);
2318
2319   if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
2320     goto src_was_linked;
2321
2322   GST_OBJECT_LOCK (sinkpad);
2323
2324   if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
2325     goto sink_was_linked;
2326
2327   /* check hierarchy, pads can only be linked if the grandparents
2328    * are the same. */
2329   if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
2330       && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
2331     goto wrong_hierarchy;
2332
2333   /* check pad caps for non-empty intersection */
2334   if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
2335     goto no_format;
2336
2337   /* FIXME check pad scheduling for non-empty intersection */
2338
2339   return GST_PAD_LINK_OK;
2340
2341 src_was_linked:
2342   {
2343     GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
2344         GST_DEBUG_PAD_NAME (srcpad),
2345         GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
2346     /* we do not emit a warning in this case because unlinking cannot
2347      * be made MT safe.*/
2348     GST_OBJECT_UNLOCK (srcpad);
2349     return GST_PAD_LINK_WAS_LINKED;
2350   }
2351 sink_was_linked:
2352   {
2353     GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
2354         GST_DEBUG_PAD_NAME (sinkpad),
2355         GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
2356     /* we do not emit a warning in this case because unlinking cannot
2357      * be made MT safe.*/
2358     GST_OBJECT_UNLOCK (sinkpad);
2359     GST_OBJECT_UNLOCK (srcpad);
2360     return GST_PAD_LINK_WAS_LINKED;
2361   }
2362 wrong_hierarchy:
2363   {
2364     GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
2365     GST_OBJECT_UNLOCK (sinkpad);
2366     GST_OBJECT_UNLOCK (srcpad);
2367     return GST_PAD_LINK_WRONG_HIERARCHY;
2368   }
2369 no_format:
2370   {
2371     GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
2372     GST_OBJECT_UNLOCK (sinkpad);
2373     GST_OBJECT_UNLOCK (srcpad);
2374     return GST_PAD_LINK_NOFORMAT;
2375   }
2376 }
2377
2378 /**
2379  * gst_pad_can_link:
2380  * @srcpad: the source #GstPad.
2381  * @sinkpad: the sink #GstPad.
2382  *
2383  * Checks if the source pad and the sink pad are compatible so they can be
2384  * linked.
2385  *
2386  * Returns: %TRUE if the pads can be linked.
2387  */
2388 gboolean
2389 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2390 {
2391   GstPadLinkReturn result;
2392
2393   /* generic checks */
2394   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2395   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2396
2397   GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
2398       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2399
2400   /* gst_pad_link_prepare does everything for us, we only release the locks
2401    * on the pads that it gets us. If this function returns !OK the locks are not
2402    * taken anymore. */
2403   result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2404   if (result != GST_PAD_LINK_OK)
2405     goto done;
2406
2407   GST_OBJECT_UNLOCK (srcpad);
2408   GST_OBJECT_UNLOCK (sinkpad);
2409
2410 done:
2411   return result == GST_PAD_LINK_OK;
2412 }
2413
2414 /**
2415  * gst_pad_link_full:
2416  * @srcpad: the source #GstPad to link.
2417  * @sinkpad: the sink #GstPad to link.
2418  * @flags: the checks to validate when linking
2419  *
2420  * Links the source pad and the sink pad.
2421  *
2422  * This variant of #gst_pad_link provides a more granular control on the
2423  * checks being done when linking. While providing some considerable speedups
2424  * the caller of this method must be aware that wrong usage of those flags
2425  * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
2426  * for more information.
2427  *
2428  * MT Safe.
2429  *
2430  * Returns: A result code indicating if the connection worked or
2431  *          what went wrong.
2432  */
2433 GstPadLinkReturn
2434 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2435 {
2436   GstPadLinkReturn result;
2437   GstElement *parent;
2438   GstPadLinkFunction srcfunc, sinkfunc;
2439
2440   g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2441   g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2442   g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2443   g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2444       GST_PAD_LINK_WRONG_DIRECTION);
2445
2446   /* Notify the parent early. See gst_pad_unlink for details. */
2447   if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2448     if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2449       gst_element_post_message (parent,
2450           gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2451               GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2452     } else {
2453       gst_object_unref (parent);
2454       parent = NULL;
2455     }
2456   }
2457
2458   /* prepare will also lock the two pads */
2459   result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2460
2461   if (G_UNLIKELY (result != GST_PAD_LINK_OK)) {
2462     GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2463         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2464         gst_pad_link_get_name (result));
2465     goto done;
2466   }
2467
2468   /* must set peers before calling the link function */
2469   GST_PAD_PEER (srcpad) = sinkpad;
2470   GST_PAD_PEER (sinkpad) = srcpad;
2471
2472   /* check events, when something is different, mark pending */
2473   schedule_events (srcpad, sinkpad);
2474
2475   /* get the link functions */
2476   srcfunc = GST_PAD_LINKFUNC (srcpad);
2477   sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2478
2479   if (G_UNLIKELY (srcfunc || sinkfunc)) {
2480     /* custom link functions, execute them */
2481     GST_OBJECT_UNLOCK (sinkpad);
2482     GST_OBJECT_UNLOCK (srcpad);
2483
2484     if (srcfunc) {
2485       GstObject *tmpparent;
2486
2487       ACQUIRE_PARENT (srcpad, tmpparent, no_parent);
2488       /* this one will call the peer link function */
2489       result = srcfunc (srcpad, tmpparent, sinkpad);
2490       RELEASE_PARENT (tmpparent);
2491     } else if (sinkfunc) {
2492       GstObject *tmpparent;
2493
2494       ACQUIRE_PARENT (sinkpad, tmpparent, no_parent);
2495       /* if no source link function, we need to call the sink link
2496        * function ourselves. */
2497       result = sinkfunc (sinkpad, tmpparent, srcpad);
2498       RELEASE_PARENT (tmpparent);
2499     }
2500   no_parent:
2501
2502     GST_OBJECT_LOCK (srcpad);
2503     GST_OBJECT_LOCK (sinkpad);
2504
2505     /* we released the lock, check if the same pads are linked still */
2506     if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2507       goto concurrent_link;
2508
2509     if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2510       goto link_failed;
2511   }
2512   GST_OBJECT_UNLOCK (sinkpad);
2513   GST_OBJECT_UNLOCK (srcpad);
2514
2515   /* fire off a signal to each of the pads telling them
2516    * that they've been linked */
2517   g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2518   g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2519
2520   GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2521       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2522
2523   if (!(flags & GST_PAD_LINK_CHECK_NO_RECONFIGURE))
2524     gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2525
2526 done:
2527   if (G_LIKELY (parent)) {
2528     gst_element_post_message (parent,
2529         gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2530             GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2531     gst_object_unref (parent);
2532   }
2533
2534   return result;
2535
2536   /* ERRORS */
2537 concurrent_link:
2538   {
2539     GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2540         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2541     GST_OBJECT_UNLOCK (sinkpad);
2542     GST_OBJECT_UNLOCK (srcpad);
2543
2544     /* The other link operation succeeded first */
2545     result = GST_PAD_LINK_WAS_LINKED;
2546     goto done;
2547   }
2548 link_failed:
2549   {
2550     GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2551         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2552         gst_pad_link_get_name (result));
2553
2554     GST_PAD_PEER (srcpad) = NULL;
2555     GST_PAD_PEER (sinkpad) = NULL;
2556
2557     GST_OBJECT_UNLOCK (sinkpad);
2558     GST_OBJECT_UNLOCK (srcpad);
2559
2560     goto done;
2561   }
2562 }
2563
2564 /**
2565  * gst_pad_link:
2566  * @srcpad: the source #GstPad to link.
2567  * @sinkpad: the sink #GstPad to link.
2568  *
2569  * Links the source pad and the sink pad.
2570  *
2571  * Returns: A result code indicating if the connection worked or
2572  *          what went wrong.
2573  *
2574  * MT Safe.
2575  */
2576 GstPadLinkReturn
2577 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2578 {
2579   GstPadLinkReturn ret;
2580
2581   GST_TRACER_PAD_LINK_PRE (srcpad, sinkpad);
2582   ret = gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2583   GST_TRACER_PAD_LINK_POST (srcpad, sinkpad, ret);
2584
2585   return ret;
2586 }
2587
2588 static void
2589 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2590 {
2591   GstPadTemplate **template_p;
2592
2593   /* this function would need checks if it weren't static */
2594
2595   GST_OBJECT_LOCK (pad);
2596   template_p = &pad->padtemplate;
2597   gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2598   GST_OBJECT_UNLOCK (pad);
2599
2600   if (templ)
2601     gst_pad_template_pad_created (templ, pad);
2602 }
2603
2604 /**
2605  * gst_pad_get_pad_template:
2606  * @pad: a #GstPad.
2607  *
2608  * Gets the template for @pad.
2609  *
2610  * Returns: (transfer full) (nullable): the #GstPadTemplate from which
2611  *     this pad was instantiated, or %NULL if this pad has no
2612  *     template. Unref after usage.
2613  */
2614 GstPadTemplate *
2615 gst_pad_get_pad_template (GstPad * pad)
2616 {
2617   GstPadTemplate *templ;
2618
2619   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2620
2621   templ = GST_PAD_PAD_TEMPLATE (pad);
2622
2623   return (templ ? gst_object_ref (templ) : NULL);
2624 }
2625
2626 /**
2627  * gst_pad_has_current_caps:
2628  * @pad: a  #GstPad to check
2629  *
2630  * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2631  *
2632  * Returns: %TRUE when @pad has caps associated with it.
2633  */
2634 gboolean
2635 gst_pad_has_current_caps (GstPad * pad)
2636 {
2637   gboolean result;
2638   GstCaps *caps;
2639
2640   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2641
2642   GST_OBJECT_LOCK (pad);
2643   caps = get_pad_caps (pad);
2644   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2645       "check current pad caps %" GST_PTR_FORMAT, caps);
2646   result = (caps != NULL);
2647   GST_OBJECT_UNLOCK (pad);
2648
2649   return result;
2650 }
2651
2652 /**
2653  * gst_pad_get_current_caps:
2654  * @pad: a  #GstPad to get the current capabilities of.
2655  *
2656  * Gets the capabilities currently configured on @pad with the last
2657  * #GST_EVENT_CAPS event.
2658  *
2659  * Returns: (transfer full) (nullable): the current caps of the pad with
2660  * incremented ref-count or %NULL when pad has no caps. Unref after usage.
2661  */
2662 GstCaps *
2663 gst_pad_get_current_caps (GstPad * pad)
2664 {
2665   GstCaps *result;
2666
2667   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2668
2669   GST_OBJECT_LOCK (pad);
2670   if ((result = get_pad_caps (pad)))
2671     gst_caps_ref (result);
2672   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2673       "get current pad caps %" GST_PTR_FORMAT, result);
2674   GST_OBJECT_UNLOCK (pad);
2675
2676   return result;
2677 }
2678
2679 /**
2680  * gst_pad_get_pad_template_caps:
2681  * @pad: a #GstPad to get the template capabilities from.
2682  *
2683  * Gets the capabilities for @pad's template.
2684  *
2685  * Returns: (transfer full): the #GstCaps of this pad template.
2686  * Unref after usage.
2687  */
2688 GstCaps *
2689 gst_pad_get_pad_template_caps (GstPad * pad)
2690 {
2691   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2692
2693   if (GST_PAD_PAD_TEMPLATE (pad))
2694     return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2695
2696   return gst_caps_ref (GST_CAPS_ANY);
2697 }
2698
2699 /**
2700  * gst_pad_get_peer:
2701  * @pad: a #GstPad to get the peer of.
2702  *
2703  * Gets the peer of @pad. This function refs the peer pad so
2704  * you need to unref it after use.
2705  *
2706  * Returns: (transfer full): the peer #GstPad. Unref after usage.
2707  *
2708  * MT safe.
2709  */
2710 GstPad *
2711 gst_pad_get_peer (GstPad * pad)
2712 {
2713   GstPad *result;
2714
2715   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2716
2717   GST_OBJECT_LOCK (pad);
2718   result = GST_PAD_PEER (pad);
2719   if (result)
2720     gst_object_ref (result);
2721   GST_OBJECT_UNLOCK (pad);
2722
2723   return result;
2724 }
2725
2726 /**
2727  * gst_pad_get_allowed_caps:
2728  * @pad: a #GstPad.
2729  *
2730  * Gets the capabilities of the allowed media types that can flow through
2731  * @pad and its peer.
2732  *
2733  * The allowed capabilities is calculated as the intersection of the results of
2734  * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2735  * on the resulting caps.
2736  *
2737  * Returns: (transfer full) (nullable): the allowed #GstCaps of the
2738  *     pad link. Unref the caps when you no longer need it. This
2739  *     function returns %NULL when @pad has no peer.
2740  *
2741  * MT safe.
2742  */
2743 GstCaps *
2744 gst_pad_get_allowed_caps (GstPad * pad)
2745 {
2746   GstCaps *mycaps;
2747   GstCaps *caps = NULL;
2748   GstQuery *query;
2749
2750   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2751
2752   GST_OBJECT_LOCK (pad);
2753   if (G_UNLIKELY (GST_PAD_PEER (pad) == NULL))
2754     goto no_peer;
2755   GST_OBJECT_UNLOCK (pad);
2756
2757   GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2758
2759   mycaps = gst_pad_query_caps (pad, NULL);
2760
2761   /* Query peer caps */
2762   query = gst_query_new_caps (mycaps);
2763   if (!gst_pad_peer_query (pad, query)) {
2764     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "Caps query failed");
2765     goto end;
2766   }
2767
2768   gst_query_parse_caps_result (query, &caps);
2769   if (caps == NULL) {
2770     g_warn_if_fail (caps != NULL);
2771     goto end;
2772   }
2773   gst_caps_ref (caps);
2774
2775   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2776       caps);
2777
2778 end:
2779   gst_query_unref (query);
2780   gst_caps_unref (mycaps);
2781
2782   return caps;
2783
2784 no_peer:
2785   {
2786     GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2787     GST_OBJECT_UNLOCK (pad);
2788
2789     return NULL;
2790   }
2791 }
2792
2793 /**
2794  * gst_pad_iterate_internal_links_default:
2795  * @pad: the #GstPad to get the internal links of.
2796  * @parent: (allow-none): the parent of @pad or %NULL
2797  *
2798  * Iterate the list of pads to which the given pad is linked to inside of
2799  * the parent element.
2800  * This is the default handler, and thus returns an iterator of all of the
2801  * pads inside the parent element with opposite direction.
2802  *
2803  * The caller must free this iterator after use with gst_iterator_free().
2804  *
2805  * Returns: (nullable): a #GstIterator of #GstPad, or %NULL if @pad
2806  * has no parent. Unref each returned pad with gst_object_unref().
2807  */
2808 GstIterator *
2809 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2810 {
2811   GstIterator *res;
2812   GList **padlist;
2813   guint32 *cookie;
2814   GMutex *lock;
2815   gpointer owner;
2816   GstElement *eparent;
2817
2818   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2819
2820   if (parent != NULL && GST_IS_ELEMENT (parent)) {
2821     eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2822   } else {
2823     GST_OBJECT_LOCK (pad);
2824     eparent = GST_PAD_PARENT (pad);
2825     if (!eparent || !GST_IS_ELEMENT (eparent))
2826       goto no_parent;
2827
2828     gst_object_ref (eparent);
2829     GST_OBJECT_UNLOCK (pad);
2830   }
2831
2832   if (pad->direction == GST_PAD_SRC)
2833     padlist = &eparent->sinkpads;
2834   else
2835     padlist = &eparent->srcpads;
2836
2837   GST_DEBUG_OBJECT (pad, "Making iterator");
2838
2839   cookie = &eparent->pads_cookie;
2840   owner = eparent;
2841   lock = GST_OBJECT_GET_LOCK (eparent);
2842
2843   res = gst_iterator_new_list (GST_TYPE_PAD,
2844       lock, cookie, padlist, (GObject *) owner, NULL);
2845
2846   gst_object_unref (owner);
2847
2848   return res;
2849
2850   /* ERRORS */
2851 no_parent:
2852   {
2853     GST_OBJECT_UNLOCK (pad);
2854     GST_DEBUG_OBJECT (pad, "no parent element");
2855     return NULL;
2856   }
2857 }
2858
2859 /**
2860  * gst_pad_iterate_internal_links:
2861  * @pad: the GstPad to get the internal links of.
2862  *
2863  * Gets an iterator for the pads to which the given pad is linked to inside
2864  * of the parent element.
2865  *
2866  * Each #GstPad element yielded by the iterator will have its refcount increased,
2867  * so unref after use.
2868  *
2869  * Free-function: gst_iterator_free
2870  *
2871  * Returns: (transfer full) (nullable): a new #GstIterator of #GstPad
2872  *     or %NULL when the pad does not have an iterator function
2873  *     configured. Use gst_iterator_free() after usage.
2874  */
2875 GstIterator *
2876 gst_pad_iterate_internal_links (GstPad * pad)
2877 {
2878   GstIterator *res = NULL;
2879   GstObject *parent;
2880
2881   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2882
2883   GST_OBJECT_LOCK (pad);
2884   ACQUIRE_PARENT (pad, parent, no_parent);
2885   GST_OBJECT_UNLOCK (pad);
2886
2887   if (GST_PAD_ITERINTLINKFUNC (pad))
2888     res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2889
2890   RELEASE_PARENT (parent);
2891
2892   return res;
2893
2894   /* ERRORS */
2895 no_parent:
2896   {
2897     GST_DEBUG_OBJECT (pad, "no parent");
2898     GST_OBJECT_UNLOCK (pad);
2899     return NULL;
2900   }
2901 }
2902
2903 /**
2904  * gst_pad_forward:
2905  * @pad: a #GstPad
2906  * @forward: (scope call): a #GstPadForwardFunction
2907  * @user_data: user data passed to @forward
2908  *
2909  * Calls @forward for all internally linked pads of @pad. This function deals with
2910  * dynamically changing internal pads and will make sure that the @forward
2911  * function is only called once for each pad.
2912  *
2913  * When @forward returns %TRUE, no further pads will be processed.
2914  *
2915  * Returns: %TRUE if one of the dispatcher functions returned %TRUE.
2916  */
2917 gboolean
2918 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2919     gpointer user_data)
2920 {
2921   gboolean result = FALSE;
2922   GstIterator *iter;
2923   gboolean done = FALSE;
2924   GValue item = { 0, };
2925   GList *pushed_pads = NULL;
2926
2927   iter = gst_pad_iterate_internal_links (pad);
2928
2929   if (!iter)
2930     goto no_iter;
2931
2932   while (!done) {
2933     switch (gst_iterator_next (iter, &item)) {
2934       case GST_ITERATOR_OK:
2935       {
2936         GstPad *intpad;
2937
2938         intpad = g_value_get_object (&item);
2939
2940         /* if already pushed, skip. FIXME, find something faster to tag pads */
2941         if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2942           g_value_reset (&item);
2943           break;
2944         }
2945
2946         GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2947             GST_DEBUG_PAD_NAME (intpad));
2948         done = result = forward (intpad, user_data);
2949
2950         pushed_pads = g_list_prepend (pushed_pads, intpad);
2951
2952         g_value_reset (&item);
2953         break;
2954       }
2955       case GST_ITERATOR_RESYNC:
2956         /* We don't reset the result here because we don't push the event
2957          * again on pads that got the event already and because we need
2958          * to consider the result of the previous pushes */
2959         gst_iterator_resync (iter);
2960         break;
2961       case GST_ITERATOR_ERROR:
2962         GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2963         done = TRUE;
2964         break;
2965       case GST_ITERATOR_DONE:
2966         done = TRUE;
2967         break;
2968     }
2969   }
2970   g_value_unset (&item);
2971   gst_iterator_free (iter);
2972
2973   g_list_free (pushed_pads);
2974
2975 no_iter:
2976   return result;
2977 }
2978
2979 typedef struct
2980 {
2981   GstEvent *event;
2982   gboolean result;
2983   gboolean dispatched;
2984 } EventData;
2985
2986 static gboolean
2987 event_forward_func (GstPad * pad, EventData * data)
2988 {
2989   /* for each pad we send to, we should ref the event; it's up
2990    * to downstream to unref again when handled. */
2991   GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2992       data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2993
2994   data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2995
2996   data->dispatched = TRUE;
2997
2998   /* don't stop */
2999   return FALSE;
3000 }
3001
3002 /**
3003  * gst_pad_event_default:
3004  * @pad: a #GstPad to call the default event handler on.
3005  * @parent: (allow-none): the parent of @pad or %NULL
3006  * @event: (transfer full): the #GstEvent to handle.
3007  *
3008  * Invokes the default event handler for the given pad.
3009  *
3010  * The EOS event will pause the task associated with @pad before it is forwarded
3011  * to all internally linked pads,
3012  *
3013  * The event is sent to all pads internally linked to @pad. This function
3014  * takes ownership of @event.
3015  *
3016  * Returns: %TRUE if the event was sent successfully.
3017  */
3018 gboolean
3019 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
3020 {
3021   gboolean result, forward = TRUE;
3022
3023   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3024   g_return_val_if_fail (event != NULL, FALSE);
3025
3026   GST_LOG_OBJECT (pad, "default event handler for event %" GST_PTR_FORMAT,
3027       event);
3028
3029   switch (GST_EVENT_TYPE (event)) {
3030     case GST_EVENT_CAPS:
3031       forward = GST_PAD_IS_PROXY_CAPS (pad);
3032       result = TRUE;
3033       break;
3034     default:
3035       break;
3036   }
3037
3038   if (forward) {
3039     EventData data;
3040
3041     data.event = event;
3042     data.dispatched = FALSE;
3043     data.result = FALSE;
3044
3045     gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
3046
3047     /* for sinkpads without a parent element or without internal links, nothing
3048      * will be dispatched but we still want to return TRUE. */
3049     if (data.dispatched)
3050       result = data.result;
3051     else
3052       result = TRUE;
3053   }
3054
3055   gst_event_unref (event);
3056
3057   return result;
3058 }
3059
3060 /* Default accept caps implementation just checks against
3061  * the allowed caps for the pad */
3062 static gboolean
3063 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
3064 {
3065   /* get the caps and see if it intersects to something not empty */
3066   GstCaps *caps, *allowed = NULL;
3067   gboolean result;
3068
3069   GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
3070
3071   /* first forward the query to internally linked pads when we are dealing with
3072    * a PROXY CAPS */
3073   if (GST_PAD_IS_PROXY_CAPS (pad)) {
3074     result = gst_pad_proxy_query_accept_caps (pad, query);
3075     if (result)
3076       allowed = gst_pad_get_pad_template_caps (pad);
3077     else
3078       goto done;
3079   }
3080
3081   gst_query_parse_accept_caps (query, &caps);
3082   if (!allowed) {
3083     GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
3084         "fallback ACCEPT_CAPS query, consider implementing a specialized version");
3085     if (GST_PAD_IS_ACCEPT_TEMPLATE (pad))
3086       allowed = gst_pad_get_pad_template_caps (pad);
3087     else
3088       allowed = gst_pad_query_caps (pad, caps);
3089   }
3090
3091   if (allowed) {
3092     if (GST_PAD_IS_ACCEPT_INTERSECT (pad)) {
3093       GST_DEBUG_OBJECT (pad,
3094           "allowed caps intersect %" GST_PTR_FORMAT ", caps %" GST_PTR_FORMAT,
3095           allowed, caps);
3096       result = gst_caps_can_intersect (caps, allowed);
3097     } else {
3098       GST_DEBUG_OBJECT (pad, "allowed caps subset %" GST_PTR_FORMAT ", caps %"
3099           GST_PTR_FORMAT, allowed, caps);
3100       result = gst_caps_is_subset (caps, allowed);
3101     }
3102     gst_caps_unref (allowed);
3103   } else {
3104     GST_DEBUG_OBJECT (pad, "no compatible caps allowed on the pad");
3105     result = FALSE;
3106   }
3107   gst_query_set_accept_caps_result (query, result);
3108
3109 done:
3110   return TRUE;
3111 }
3112
3113 /* Default caps implementation */
3114 static gboolean
3115 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
3116 {
3117   GstCaps *result = NULL, *filter;
3118   GstPadTemplate *templ;
3119   gboolean fixed_caps;
3120
3121   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "query caps %" GST_PTR_FORMAT,
3122       query);
3123
3124   /* first try to proxy if we must */
3125   if (GST_PAD_IS_PROXY_CAPS (pad)) {
3126     if ((gst_pad_proxy_query_caps (pad, query))) {
3127       goto done;
3128     }
3129   }
3130
3131   gst_query_parse_caps (query, &filter);
3132
3133   /* no proxy or it failed, do default handling */
3134   fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
3135
3136   GST_OBJECT_LOCK (pad);
3137   if (fixed_caps) {
3138     /* fixed caps, try the negotiated caps first */
3139     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
3140     if ((result = get_pad_caps (pad)))
3141       goto filter_done_unlock;
3142   }
3143
3144   if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
3145     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
3146     if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
3147       goto filter_done_unlock;
3148   }
3149
3150   if (!fixed_caps) {
3151     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3152         "non-fixed pad caps: trying pad caps");
3153     /* non fixed caps, try the negotiated caps */
3154     if ((result = get_pad_caps (pad)))
3155       goto filter_done_unlock;
3156   }
3157
3158   /* this almost never happens */
3159   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
3160   result = GST_CAPS_ANY;
3161
3162 filter_done_unlock:
3163   GST_OBJECT_UNLOCK (pad);
3164
3165   /* run the filter on the result */
3166   if (filter) {
3167     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3168         "using caps %p %" GST_PTR_FORMAT " with filter %p %"
3169         GST_PTR_FORMAT, result, result, filter, filter);
3170     result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
3171     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
3172         result, result);
3173   } else {
3174     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3175         "using caps %p %" GST_PTR_FORMAT, result, result);
3176     result = gst_caps_ref (result);
3177   }
3178   gst_query_set_caps_result (query, result);
3179   gst_caps_unref (result);
3180
3181 done:
3182   return TRUE;
3183 }
3184
3185 /* Default latency implementation */
3186 typedef struct
3187 {
3188   guint count;
3189   gboolean live;
3190   GstClockTime min, max;
3191 } LatencyFoldData;
3192
3193 static gboolean
3194 query_latency_default_fold (const GValue * item, GValue * ret,
3195     gpointer user_data)
3196 {
3197   GstPad *pad = g_value_get_object (item), *peer;
3198   LatencyFoldData *fold_data = user_data;
3199   GstQuery *query;
3200   gboolean res = FALSE;
3201
3202   query = gst_query_new_latency ();
3203
3204   peer = gst_pad_get_peer (pad);
3205   if (peer) {
3206     res = gst_pad_peer_query (pad, query);
3207   } else {
3208     GST_LOG_OBJECT (pad, "No peer pad found, ignoring this pad");
3209   }
3210
3211   if (res) {
3212     gboolean live;
3213     GstClockTime min, max;
3214
3215     gst_query_parse_latency (query, &live, &min, &max);
3216
3217     GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3218         " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
3219
3220     /* FIXME : Why do we only take values into account if it's live ? */
3221     if (live || fold_data->count == 0) {
3222       if (min > fold_data->min)
3223         fold_data->min = min;
3224
3225       if (fold_data->max == GST_CLOCK_TIME_NONE)
3226         fold_data->max = max;
3227       else if (max < fold_data->max)
3228         fold_data->max = max;
3229
3230       fold_data->live = live;
3231     }
3232     fold_data->count += 1;
3233   } else if (peer) {
3234     GST_DEBUG_OBJECT (pad, "latency query failed");
3235     g_value_set_boolean (ret, FALSE);
3236   }
3237
3238   gst_query_unref (query);
3239   if (peer)
3240     gst_object_unref (peer);
3241
3242   return TRUE;
3243 }
3244
3245 static gboolean
3246 gst_pad_query_latency_default (GstPad * pad, GstQuery * query)
3247 {
3248   GstIterator *it;
3249   GstIteratorResult res;
3250   GValue ret = G_VALUE_INIT;
3251   gboolean query_ret;
3252   LatencyFoldData fold_data;
3253
3254   it = gst_pad_iterate_internal_links (pad);
3255   if (!it) {
3256     GST_DEBUG_OBJECT (pad, "Can't iterate internal links");
3257     return FALSE;
3258   }
3259
3260   g_value_init (&ret, G_TYPE_BOOLEAN);
3261
3262 retry:
3263   fold_data.count = 0;
3264   fold_data.live = FALSE;
3265   fold_data.min = 0;
3266   fold_data.max = GST_CLOCK_TIME_NONE;
3267
3268   g_value_set_boolean (&ret, TRUE);
3269   res = gst_iterator_fold (it, query_latency_default_fold, &ret, &fold_data);
3270   switch (res) {
3271     case GST_ITERATOR_OK:
3272       g_assert_not_reached ();
3273       break;
3274     case GST_ITERATOR_DONE:
3275       break;
3276     case GST_ITERATOR_ERROR:
3277       g_value_set_boolean (&ret, FALSE);
3278       break;
3279     case GST_ITERATOR_RESYNC:
3280       gst_iterator_resync (it);
3281       goto retry;
3282     default:
3283       g_assert_not_reached ();
3284       break;
3285   }
3286   gst_iterator_free (it);
3287
3288   query_ret = g_value_get_boolean (&ret);
3289   if (query_ret) {
3290     GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3291         " max:%" G_GINT64_FORMAT, fold_data.live ? "true" : "false",
3292         fold_data.min, fold_data.max);
3293
3294     if (fold_data.min > fold_data.max) {
3295       GST_ERROR_OBJECT (pad, "minimum latency bigger than maximum latency");
3296     }
3297
3298     gst_query_set_latency (query, fold_data.live, fold_data.min, fold_data.max);
3299   } else {
3300     GST_LOG_OBJECT (pad, "latency query failed");
3301   }
3302
3303   return query_ret;
3304 }
3305
3306 typedef struct
3307 {
3308   GstQuery *query;
3309   gboolean result;
3310   gboolean dispatched;
3311 } QueryData;
3312
3313 static gboolean
3314 query_forward_func (GstPad * pad, QueryData * data)
3315 {
3316   GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
3317       data->query, GST_QUERY_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
3318
3319   data->result |= gst_pad_peer_query (pad, data->query);
3320
3321   data->dispatched = TRUE;
3322
3323   /* stop on first successful reply */
3324   return data->result;
3325 }
3326
3327 /**
3328  * gst_pad_query_default:
3329  * @pad: a #GstPad to call the default query handler on.
3330  * @parent: (allow-none): the parent of @pad or %NULL
3331  * @query: (transfer none): the #GstQuery to handle.
3332  *
3333  * Invokes the default query handler for the given pad.
3334  * The query is sent to all pads internally linked to @pad. Note that
3335  * if there are many possible sink pads that are internally linked to
3336  * @pad, only one will be sent the query.
3337  * Multi-sinkpad elements should implement custom query handlers.
3338  *
3339  * Returns: %TRUE if the query was performed successfully.
3340  */
3341 gboolean
3342 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
3343 {
3344   gboolean forward, ret = FALSE;
3345
3346   switch (GST_QUERY_TYPE (query)) {
3347     case GST_QUERY_SCHEDULING:
3348       forward = GST_PAD_IS_PROXY_SCHEDULING (pad);
3349       break;
3350     case GST_QUERY_ALLOCATION:
3351       forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
3352       break;
3353     case GST_QUERY_ACCEPT_CAPS:
3354       ret = gst_pad_query_accept_caps_default (pad, query);
3355       forward = FALSE;
3356       break;
3357     case GST_QUERY_CAPS:
3358       ret = gst_pad_query_caps_default (pad, query);
3359       forward = FALSE;
3360       break;
3361     case GST_QUERY_LATENCY:
3362       ret = gst_pad_query_latency_default (pad, query);
3363       forward = FALSE;
3364       break;
3365     case GST_QUERY_POSITION:
3366     case GST_QUERY_SEEKING:
3367     case GST_QUERY_FORMATS:
3368     case GST_QUERY_JITTER:
3369     case GST_QUERY_RATE:
3370     case GST_QUERY_CONVERT:
3371     default:
3372       forward = TRUE;
3373       break;
3374   }
3375
3376   GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
3377       query, GST_QUERY_TYPE_NAME (query));
3378
3379   if (forward) {
3380     QueryData data;
3381
3382     data.query = query;
3383     data.dispatched = FALSE;
3384     data.result = FALSE;
3385
3386     gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
3387
3388     if (data.dispatched) {
3389       ret = data.result;
3390     } else {
3391       /* nothing dispatched, assume drained */
3392       if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
3393         ret = TRUE;
3394       else
3395         ret = FALSE;
3396     }
3397   }
3398   return ret;
3399 }
3400
3401 static void
3402 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
3403 {
3404   GstPad *pad = data->pad;
3405   GstPadProbeInfo *info = data->info;
3406   GstPadProbeType type, flags;
3407   GstPadProbeCallback callback;
3408   GstPadProbeReturn ret;
3409   gpointer original_data;
3410
3411   /* if we have called this callback, do nothing */
3412   if (PROBE_COOKIE (hook) == data->cookie) {
3413     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3414         "hook %lu, cookie %u already called", hook->hook_id,
3415         PROBE_COOKIE (hook));
3416     return;
3417   }
3418
3419   PROBE_COOKIE (hook) = data->cookie;
3420
3421   flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
3422   type = info->type;
3423   original_data = info->data;
3424
3425   /* one of the scheduling types */
3426   if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
3427     goto no_match;
3428
3429   if (type & GST_PAD_PROBE_TYPE_PUSH) {
3430     /* one of the data types for non-idle probes */
3431     if ((type & GST_PAD_PROBE_TYPE_IDLE) == 0
3432         && (flags & _PAD_PROBE_TYPE_ALL_BOTH_AND_FLUSH & type) == 0)
3433       goto no_match;
3434   } else if (type & GST_PAD_PROBE_TYPE_PULL) {
3435     /* one of the data types for non-idle probes */
3436     if ((type & GST_PAD_PROBE_TYPE_BLOCKING) == 0
3437         && (flags & _PAD_PROBE_TYPE_ALL_BOTH_AND_FLUSH & type) == 0)
3438       goto no_match;
3439   } else {
3440     /* Type must have PULL or PUSH probe types */
3441     g_assert_not_reached ();
3442   }
3443
3444   /* one of the blocking types must match */
3445   if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
3446       (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
3447     goto no_match;
3448   if ((type & GST_PAD_PROBE_TYPE_BLOCKING) == 0 &&
3449       (flags & GST_PAD_PROBE_TYPE_BLOCKING))
3450     goto no_match;
3451   /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
3452   if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
3453       (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
3454     goto no_match;
3455
3456   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3457       "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
3458       PROBE_COOKIE (hook), flags);
3459
3460   data->marshalled = TRUE;
3461
3462   callback = (GstPadProbeCallback) hook->func;
3463   if (callback == NULL)
3464     return;
3465
3466   info->id = hook->hook_id;
3467
3468   GST_OBJECT_UNLOCK (pad);
3469
3470   ret = callback (pad, info, hook->data);
3471
3472   GST_OBJECT_LOCK (pad);
3473
3474   if (original_data != NULL && info->data == NULL) {
3475     GST_DEBUG_OBJECT (pad, "data item in pad probe info was dropped");
3476     info->type = GST_PAD_PROBE_TYPE_INVALID;
3477     data->dropped = TRUE;
3478   }
3479
3480   switch (ret) {
3481     case GST_PAD_PROBE_REMOVE:
3482       /* remove the probe */
3483       GST_DEBUG_OBJECT (pad, "asked to remove hook");
3484       cleanup_hook (pad, hook);
3485       break;
3486     case GST_PAD_PROBE_DROP:
3487       /* need to drop the data, make sure other probes don't get called
3488        * anymore */
3489       GST_DEBUG_OBJECT (pad, "asked to drop item");
3490       info->type = GST_PAD_PROBE_TYPE_INVALID;
3491       data->dropped = TRUE;
3492       break;
3493     case GST_PAD_PROBE_HANDLED:
3494       GST_DEBUG_OBJECT (pad, "probe handled data");
3495       data->handled = TRUE;
3496       break;
3497     case GST_PAD_PROBE_PASS:
3498       /* inform the pad block to let things pass */
3499       GST_DEBUG_OBJECT (pad, "asked to pass item");
3500       data->pass = TRUE;
3501       break;
3502     case GST_PAD_PROBE_OK:
3503       GST_DEBUG_OBJECT (pad, "probe returned OK");
3504       break;
3505     default:
3506       GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
3507       break;
3508   }
3509   return;
3510
3511 no_match:
3512   {
3513     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3514         "hook %lu, cookie %u with flags 0x%08x does not match %08x",
3515         hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
3516     return;
3517   }
3518 }
3519
3520 /* a probe that does not take or return any data */
3521 #define PROBE_NO_DATA(pad,mask,label,defaultval)                \
3522   G_STMT_START {                                                \
3523     if (G_UNLIKELY (pad->num_probes)) {                         \
3524       GstFlowReturn pval = defaultval;                          \
3525       /* pass NULL as the data item */                          \
3526       GstPadProbeInfo info = { mask, 0, NULL, 0, 0 };           \
3527       info.ABI.abi.flow_ret = defaultval;                       \
3528       ret = do_probe_callbacks (pad, &info, defaultval);        \
3529       if (G_UNLIKELY (ret != pval && ret != GST_FLOW_OK))       \
3530         goto label;                                             \
3531     }                                                           \
3532   } G_STMT_END
3533
3534 #define PROBE_FULL(pad,mask,data,offs,size,label,handleable,handle_label) \
3535   G_STMT_START {                                                        \
3536     if (G_UNLIKELY (pad->num_probes)) {                                 \
3537       /* pass the data item */                                          \
3538       GstPadProbeInfo info = { mask, 0, data, offs, size };             \
3539       info.ABI.abi.flow_ret = GST_FLOW_OK;                              \
3540       ret = do_probe_callbacks (pad, &info, GST_FLOW_OK);               \
3541       /* store the possibly updated data item */                        \
3542       data = GST_PAD_PROBE_INFO_DATA (&info);                           \
3543       /* if something went wrong, exit */                               \
3544       if (G_UNLIKELY (ret != GST_FLOW_OK)) {                            \
3545         if (handleable && ret == GST_FLOW_CUSTOM_SUCCESS_1) {           \
3546           ret = info.ABI.abi.flow_ret;                                          \
3547           goto handle_label;                                            \
3548         }                                                               \
3549         goto label;                                                     \
3550       }                                                                 \
3551     }                                                                   \
3552   } G_STMT_END
3553
3554 #define PROBE_PUSH(pad,mask,data,label)         \
3555   PROBE_FULL(pad, mask, data, -1, -1, label, FALSE, label);
3556 #define PROBE_HANDLE(pad,mask,data,label,handle_label)  \
3557   PROBE_FULL(pad, mask, data, -1, -1, label, TRUE, handle_label);
3558 #define PROBE_PULL(pad,mask,data,offs,size,label)               \
3559   PROBE_FULL(pad, mask, data, offs, size, label, FALSE, label);
3560
3561 static GstFlowReturn
3562 do_pad_idle_probe_wait (GstPad * pad)
3563 {
3564   while (GST_PAD_IS_RUNNING_IDLE_PROBE (pad)) {
3565     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3566         "waiting idle probe to be removed");
3567     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3568     GST_PAD_BLOCK_WAIT (pad);
3569     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3570     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3571
3572     if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3573       return GST_FLOW_FLUSHING;
3574   }
3575   return GST_FLOW_OK;
3576 }
3577
3578 #define PROBE_TYPE_IS_SERIALIZED(i) \
3579     ( \
3580       ( \
3581         (((i)->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM | \
3582         GST_PAD_PROBE_TYPE_EVENT_FLUSH)) && \
3583         GST_EVENT_IS_SERIALIZED ((i)->data)) \
3584       ) || ( \
3585         (((i)->type & GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM) && \
3586         GST_QUERY_IS_SERIALIZED ((i)->data)) \
3587       ) || ( \
3588         ((i)->type & (GST_PAD_PROBE_TYPE_BUFFER | \
3589         GST_PAD_PROBE_TYPE_BUFFER_LIST))  \
3590       ) \
3591     )
3592
3593 static GstFlowReturn
3594 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3595     GstFlowReturn defaultval)
3596 {
3597   ProbeMarshall data;
3598   guint cookie;
3599   gboolean is_block;
3600
3601   data.pad = pad;
3602   data.info = info;
3603   data.pass = FALSE;
3604   data.handled = FALSE;
3605   data.marshalled = FALSE;
3606   data.dropped = FALSE;
3607   data.cookie = ++pad->priv->probe_cookie;
3608
3609   is_block =
3610       (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3611
3612   if (is_block && PROBE_TYPE_IS_SERIALIZED (info)) {
3613     if (do_pad_idle_probe_wait (pad) == GST_FLOW_FLUSHING)
3614       goto flushing;
3615   }
3616
3617 again:
3618   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3619       "do probes cookie %u", data.cookie);
3620   cookie = pad->priv->probe_list_cookie;
3621
3622   g_hook_list_marshal (&pad->probes, TRUE,
3623       (GHookMarshaller) probe_hook_marshal, &data);
3624
3625   /* if the list changed, call the new callbacks (they will not have their
3626    * cookie set to data.cookie */
3627   if (cookie != pad->priv->probe_list_cookie) {
3628     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3629         "probe list changed, restarting");
3630     goto again;
3631   }
3632
3633   /* the first item that dropped will stop the hooks and then we drop here */
3634   if (data.dropped)
3635     goto dropped;
3636
3637   /* If one handler took care of it, let the the item pass */
3638   if (data.handled) {
3639     goto handled;
3640   }
3641
3642   /* if no handler matched and we are blocking, let the item pass */
3643   if (!data.marshalled && is_block)
3644     goto passed;
3645
3646   /* At this point, all handlers returned either OK or PASS. If one handler
3647    * returned PASS, let the item pass */
3648   if (data.pass)
3649     goto passed;
3650
3651   if (is_block) {
3652     while (GST_PAD_IS_BLOCKED (pad)) {
3653       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3654           "we are blocked %d times", pad->num_blocked);
3655
3656       /* we might have released the lock */
3657       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3658         goto flushing;
3659
3660       /* now we block the streaming thread. It can be unlocked when we
3661        * deactivate the pad (which will also set the FLUSHING flag) or
3662        * when the pad is unblocked. A flushing event will also unblock
3663        * the pad after setting the FLUSHING flag. */
3664       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3665           "Waiting to be unblocked or set flushing");
3666       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3667       GST_PAD_BLOCK_WAIT (pad);
3668       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3669       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3670
3671       /* if the list changed, call the new callbacks (they will not have their
3672        * cookie set to data.cookie */
3673       if (cookie != pad->priv->probe_list_cookie) {
3674         GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3675             "probe list changed, restarting");
3676         goto again;
3677       }
3678
3679       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3680         goto flushing;
3681     }
3682   }
3683
3684   return defaultval;
3685
3686   /* ERRORS */
3687 flushing:
3688   {
3689     GST_DEBUG_OBJECT (pad, "pad is flushing");
3690     return GST_FLOW_FLUSHING;
3691   }
3692 dropped:
3693   {
3694     GST_DEBUG_OBJECT (pad, "data is dropped");
3695     return GST_FLOW_CUSTOM_SUCCESS;
3696   }
3697 passed:
3698   {
3699     /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3700     GST_DEBUG_OBJECT (pad, "data is passed");
3701     return GST_FLOW_OK;
3702   }
3703 handled:
3704   {
3705     GST_DEBUG_OBJECT (pad, "data was handled");
3706     return GST_FLOW_CUSTOM_SUCCESS_1;
3707   }
3708 }
3709
3710 /* pad offsets */
3711
3712 /**
3713  * gst_pad_get_offset:
3714  * @pad: a #GstPad
3715  *
3716  * Get the offset applied to the running time of @pad. @pad has to be a source
3717  * pad.
3718  *
3719  * Returns: the offset.
3720  */
3721 gint64
3722 gst_pad_get_offset (GstPad * pad)
3723 {
3724   gint64 result;
3725
3726   g_return_val_if_fail (GST_IS_PAD (pad), 0);
3727
3728   GST_OBJECT_LOCK (pad);
3729   result = pad->offset;
3730   GST_OBJECT_UNLOCK (pad);
3731
3732   return result;
3733 }
3734
3735 static gboolean
3736 mark_event_not_received (GstPad * pad, PadEvent * ev, gpointer user_data)
3737 {
3738   ev->received = FALSE;
3739   return TRUE;
3740 }
3741
3742 /**
3743  * gst_pad_set_offset:
3744  * @pad: a #GstPad
3745  * @offset: the offset
3746  *
3747  * Set the offset that will be applied to the running time of @pad.
3748  */
3749 void
3750 gst_pad_set_offset (GstPad * pad, gint64 offset)
3751 {
3752   g_return_if_fail (GST_IS_PAD (pad));
3753
3754   GST_OBJECT_LOCK (pad);
3755   /* if nothing changed, do nothing */
3756   if (pad->offset == offset)
3757     goto done;
3758
3759   pad->offset = offset;
3760   GST_DEBUG_OBJECT (pad, "changed offset to %" GST_STIME_FORMAT,
3761       GST_STIME_ARGS (offset));
3762
3763   /* resend all sticky events with updated offset on next buffer push */
3764   events_foreach (pad, mark_event_not_received, NULL);
3765   GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3766
3767 done:
3768   GST_OBJECT_UNLOCK (pad);
3769 }
3770
3771 typedef struct
3772 {
3773   GstFlowReturn ret;
3774
3775   /* If TRUE and ret is not OK this means
3776    * that pushing the EOS event failed
3777    */
3778   gboolean was_eos;
3779
3780   /* If called for an event this is
3781    * the event that would be pushed
3782    * next. Don't forward sticky events
3783    * that would come after that */
3784   GstEvent *event;
3785 } PushStickyData;
3786
3787 /* should be called with pad LOCK */
3788 static gboolean
3789 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3790 {
3791   PushStickyData *data = user_data;
3792   GstEvent *event = ev->event;
3793
3794   if (ev->received) {
3795     GST_DEBUG_OBJECT (pad, "event %s was already received",
3796         GST_EVENT_TYPE_NAME (event));
3797     return TRUE;
3798   }
3799
3800   /* If we're called because of an sticky event, only forward
3801    * events that would come before this new event and the
3802    * event itself */
3803   if (data->event && GST_EVENT_IS_STICKY (data->event) &&
3804       GST_EVENT_TYPE (data->event) <= GST_EVENT_SEGMENT &&
3805       GST_EVENT_TYPE (data->event) < GST_EVENT_TYPE (event)) {
3806     data->ret = GST_FLOW_CUSTOM_SUCCESS_1;
3807   } else {
3808     data->ret = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3809         GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3810   }
3811
3812   switch (data->ret) {
3813     case GST_FLOW_OK:
3814       ev->received = TRUE;
3815       GST_DEBUG_OBJECT (pad, "event %s marked received",
3816           GST_EVENT_TYPE_NAME (event));
3817       break;
3818     case GST_FLOW_CUSTOM_SUCCESS:
3819       /* we can't assume the event is received when it was dropped */
3820       GST_DEBUG_OBJECT (pad, "event %s was dropped, mark pending",
3821           GST_EVENT_TYPE_NAME (event));
3822       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3823       data->ret = GST_FLOW_OK;
3824       break;
3825     case GST_FLOW_CUSTOM_SUCCESS_1:
3826       /* event was ignored and should be sent later */
3827       GST_DEBUG_OBJECT (pad, "event %s was ignored, mark pending",
3828           GST_EVENT_TYPE_NAME (event));
3829       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3830       data->ret = GST_FLOW_OK;
3831       break;
3832     case GST_FLOW_NOT_LINKED:
3833       /* not linked is not a problem, we are sticky so the event will be
3834        * rescheduled to be sent later on re-link, but only for non-EOS events */
3835       GST_DEBUG_OBJECT (pad, "pad was not linked, mark pending");
3836       if (GST_EVENT_TYPE (event) != GST_EVENT_EOS) {
3837         data->ret = GST_FLOW_OK;
3838         ev->received = TRUE;
3839       }
3840       break;
3841     default:
3842       GST_DEBUG_OBJECT (pad, "result %s, mark pending events",
3843           gst_flow_get_name (data->ret));
3844       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3845       break;
3846   }
3847
3848   if (data->ret != GST_FLOW_OK && GST_EVENT_TYPE (event) == GST_EVENT_EOS)
3849     data->was_eos = TRUE;
3850
3851   return data->ret == GST_FLOW_OK;
3852 }
3853
3854 /* check sticky events and push them when needed. should be called
3855  * with pad LOCK */
3856 static inline GstFlowReturn
3857 check_sticky (GstPad * pad, GstEvent * event)
3858 {
3859   PushStickyData data = { GST_FLOW_OK, FALSE, event };
3860
3861   if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3862     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3863
3864     GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3865     events_foreach (pad, push_sticky, &data);
3866
3867     /* If there's an EOS event we must push it downstream
3868      * even if sending a previous sticky event failed.
3869      * Otherwise the pipeline might wait forever for EOS.
3870      *
3871      * Only do this if pushing another event than the EOS
3872      * event failed.
3873      */
3874     if (data.ret != GST_FLOW_OK && !data.was_eos) {
3875       PadEvent *ev = find_event_by_type (pad, GST_EVENT_EOS, 0);
3876
3877       if (ev && !ev->received) {
3878         data.ret = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3879             GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3880         /* the event could have been dropped. Because this can only
3881          * happen if the user asked for it, it's not an error */
3882         if (data.ret == GST_FLOW_CUSTOM_SUCCESS)
3883           data.ret = GST_FLOW_OK;
3884       }
3885     }
3886   }
3887   return data.ret;
3888 }
3889
3890
3891 /**
3892  * gst_pad_query:
3893  * @pad: a #GstPad to invoke the default query on.
3894  * @query: (transfer none): the #GstQuery to perform.
3895  *
3896  * Dispatches a query to a pad. The query should have been allocated by the
3897  * caller via one of the type-specific allocation functions. The element that
3898  * the pad belongs to is responsible for filling the query with an appropriate
3899  * response, which should then be parsed with a type-specific query parsing
3900  * function.
3901  *
3902  * Again, the caller is responsible for both the allocation and deallocation of
3903  * the query structure.
3904  *
3905  * Please also note that some queries might need a running pipeline to work.
3906  *
3907  * Returns: %TRUE if the query could be performed.
3908  */
3909 gboolean
3910 gst_pad_query (GstPad * pad, GstQuery * query)
3911 {
3912   GstObject *parent;
3913   gboolean res, serialized;
3914   GstPadQueryFunction func;
3915   GstPadProbeType type;
3916   GstFlowReturn ret;
3917
3918   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3919   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3920
3921   if (GST_PAD_IS_SRC (pad)) {
3922     if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3923       goto wrong_direction;
3924     type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3925   } else if (GST_PAD_IS_SINK (pad)) {
3926     if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3927       goto wrong_direction;
3928     type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3929   } else
3930     goto unknown_direction;
3931
3932   GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3933       GST_QUERY_TYPE_NAME (query));
3934   GST_TRACER_PAD_QUERY_PRE (pad, query);
3935
3936   serialized = GST_QUERY_IS_SERIALIZED (query);
3937   if (G_UNLIKELY (serialized))
3938     GST_PAD_STREAM_LOCK (pad);
3939
3940   GST_OBJECT_LOCK (pad);
3941   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3942       GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3943   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3944
3945   ACQUIRE_PARENT (pad, parent, no_parent);
3946   GST_OBJECT_UNLOCK (pad);
3947
3948   if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3949     goto no_func;
3950
3951   res = func (pad, parent, query);
3952
3953   RELEASE_PARENT (parent);
3954
3955   GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3956       GST_QUERY_TYPE_NAME (query), res);
3957   GST_TRACER_PAD_QUERY_POST (pad, query, res);
3958
3959   if (res != TRUE)
3960     goto query_failed;
3961
3962   GST_OBJECT_LOCK (pad);
3963   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3964   GST_OBJECT_UNLOCK (pad);
3965
3966   if (G_UNLIKELY (serialized))
3967     GST_PAD_STREAM_UNLOCK (pad);
3968
3969   return res;
3970
3971   /* ERRORS */
3972 wrong_direction:
3973   {
3974     g_warning ("pad %s:%s query %s in wrong direction",
3975         GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3976     return FALSE;
3977   }
3978 unknown_direction:
3979   {
3980     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3981     return FALSE;
3982   }
3983 no_parent:
3984   {
3985     GST_DEBUG_OBJECT (pad, "had no parent");
3986     GST_OBJECT_UNLOCK (pad);
3987     if (G_UNLIKELY (serialized))
3988       GST_PAD_STREAM_UNLOCK (pad);
3989     return FALSE;
3990   }
3991 no_func:
3992   {
3993     GST_DEBUG_OBJECT (pad, "had no query function");
3994     RELEASE_PARENT (parent);
3995     if (G_UNLIKELY (serialized))
3996       GST_PAD_STREAM_UNLOCK (pad);
3997     return FALSE;
3998   }
3999 query_failed:
4000   {
4001     GST_DEBUG_OBJECT (pad, "query failed");
4002     if (G_UNLIKELY (serialized))
4003       GST_PAD_STREAM_UNLOCK (pad);
4004     return FALSE;
4005   }
4006 probe_stopped:
4007   {
4008     GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
4009     GST_OBJECT_UNLOCK (pad);
4010     if (G_UNLIKELY (serialized))
4011       GST_PAD_STREAM_UNLOCK (pad);
4012
4013     /* if a probe dropped without handling, we don't sent it further but assume
4014      * that the probe did not answer the query and return FALSE */
4015     if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
4016       res = FALSE;
4017     else
4018       res = TRUE;
4019
4020     return res;
4021   }
4022 }
4023
4024 /**
4025  * gst_pad_peer_query:
4026  * @pad: a #GstPad to invoke the peer query on.
4027  * @query: (transfer none): the #GstQuery to perform.
4028  *
4029  * Performs gst_pad_query() on the peer of @pad.
4030  *
4031  * The caller is responsible for both the allocation and deallocation of
4032  * the query structure.
4033  *
4034  * Returns: %TRUE if the query could be performed. This function returns %FALSE
4035  * if @pad has no peer.
4036  */
4037 gboolean
4038 gst_pad_peer_query (GstPad * pad, GstQuery * query)
4039 {
4040   GstPad *peerpad;
4041   GstPadProbeType type;
4042   gboolean res, serialized;
4043   GstFlowReturn ret;
4044
4045   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4046   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
4047
4048   if (GST_PAD_IS_SRC (pad)) {
4049     if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
4050       goto wrong_direction;
4051     type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
4052   } else if (GST_PAD_IS_SINK (pad)) {
4053     if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
4054       goto wrong_direction;
4055     type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
4056   } else
4057     goto unknown_direction;
4058
4059   GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
4060       GST_QUERY_TYPE_NAME (query));
4061
4062   serialized = GST_QUERY_IS_SERIALIZED (query);
4063
4064   GST_OBJECT_LOCK (pad);
4065   if (GST_PAD_IS_SRC (pad) && serialized) {
4066     /* all serialized queries on the srcpad trigger push of
4067      * sticky events */
4068     if (check_sticky (pad, NULL) != GST_FLOW_OK)
4069       goto sticky_failed;
4070   }
4071
4072   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4073       GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
4074   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
4075
4076   peerpad = GST_PAD_PEER (pad);
4077   if (G_UNLIKELY (peerpad == NULL))
4078     goto no_peer;
4079
4080   gst_object_ref (peerpad);
4081   GST_OBJECT_UNLOCK (pad);
4082
4083   res = gst_pad_query (peerpad, query);
4084
4085   gst_object_unref (peerpad);
4086
4087   if (res != TRUE)
4088     goto query_failed;
4089
4090   GST_OBJECT_LOCK (pad);
4091   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
4092   GST_OBJECT_UNLOCK (pad);
4093
4094   return res;
4095
4096   /* ERRORS */
4097 wrong_direction:
4098   {
4099     g_warning ("pad %s:%s query %s in wrong direction",
4100         GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
4101     return FALSE;
4102   }
4103 unknown_direction:
4104   {
4105     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4106     return FALSE;
4107   }
4108 sticky_failed:
4109   {
4110     GST_WARNING_OBJECT (pad, "could not send sticky events");
4111     GST_OBJECT_UNLOCK (pad);
4112     return FALSE;
4113   }
4114 no_peer:
4115   {
4116     GST_INFO_OBJECT (pad, "pad has no peer");
4117     GST_OBJECT_UNLOCK (pad);
4118     return FALSE;
4119   }
4120 query_failed:
4121   {
4122     GST_DEBUG_OBJECT (pad, "query failed");
4123     return FALSE;
4124   }
4125 probe_stopped:
4126   {
4127     GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
4128     GST_OBJECT_UNLOCK (pad);
4129
4130     /* if a probe dropped without handling, we don't sent it further but
4131      * assume that the probe did not answer the query and return FALSE */
4132     if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
4133       res = FALSE;
4134     else
4135       res = TRUE;
4136
4137     return res;
4138   }
4139 }
4140
4141 /**********************************************************************
4142  * Data passing functions
4143  */
4144
4145 /* this is the chain function that does not perform the additional argument
4146  * checking for that little extra speed.
4147  */
4148 static inline GstFlowReturn
4149 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
4150 {
4151   GstFlowReturn ret;
4152   GstObject *parent;
4153   gboolean handled = FALSE;
4154
4155   GST_PAD_STREAM_LOCK (pad);
4156
4157   GST_OBJECT_LOCK (pad);
4158   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4159     goto flushing;
4160
4161   if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4162     goto eos;
4163
4164   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4165     goto wrong_mode;
4166
4167 #ifdef GST_ENABLE_EXTRA_CHECKS
4168   if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4169     if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4170       g_warning (G_STRLOC
4171           ":%s:<%s:%s> Got data flow before stream-start event",
4172           G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4173     }
4174     if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4175       g_warning (G_STRLOC
4176           ":%s:<%s:%s> Got data flow before segment event",
4177           G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4178     }
4179     pad->priv->last_cookie = pad->priv->events_cookie;
4180   }
4181 #endif
4182
4183   PROBE_HANDLE (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped,
4184       probe_handled);
4185
4186   PROBE_HANDLE (pad, type, data, probe_stopped, probe_handled);
4187
4188   ACQUIRE_PARENT (pad, parent, no_parent);
4189   GST_OBJECT_UNLOCK (pad);
4190
4191   /* NOTE: we read the chainfunc unlocked.
4192    * we cannot hold the lock for the pad so we might send
4193    * the data to the wrong function. This is not really a
4194    * problem since functions are assigned at creation time
4195    * and don't change that often... */
4196   if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
4197     GstPadChainFunction chainfunc;
4198
4199     if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
4200       goto no_function;
4201
4202     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4203         "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
4204         GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
4205
4206     ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
4207
4208     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4209         "called chainfunction &%s with buffer %p, returned %s",
4210         GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
4211   } else {
4212     GstPadChainListFunction chainlistfunc;
4213
4214     if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
4215       goto no_function;
4216
4217     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4218         "calling chainlistfunction &%s",
4219         GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
4220
4221     ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
4222
4223     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4224         "called chainlistfunction &%s, returned %s",
4225         GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
4226   }
4227
4228   RELEASE_PARENT (parent);
4229
4230   GST_PAD_STREAM_UNLOCK (pad);
4231
4232   return ret;
4233
4234   /* ERRORS */
4235 flushing:
4236   {
4237     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4238         "chaining, but pad was flushing");
4239     GST_OBJECT_UNLOCK (pad);
4240     GST_PAD_STREAM_UNLOCK (pad);
4241     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4242     return GST_FLOW_FLUSHING;
4243   }
4244 eos:
4245   {
4246     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "chaining, but pad was EOS");
4247     GST_OBJECT_UNLOCK (pad);
4248     GST_PAD_STREAM_UNLOCK (pad);
4249     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4250     return GST_FLOW_EOS;
4251   }
4252 wrong_mode:
4253   {
4254     g_critical ("chain on pad %s:%s but it was not in push mode",
4255         GST_DEBUG_PAD_NAME (pad));
4256     GST_OBJECT_UNLOCK (pad);
4257     GST_PAD_STREAM_UNLOCK (pad);
4258     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4259     return GST_FLOW_ERROR;
4260   }
4261 probe_handled:
4262   handled = TRUE;
4263   /* PASSTHROUGH */
4264 probe_stopped:
4265   {
4266     GST_OBJECT_UNLOCK (pad);
4267     GST_PAD_STREAM_UNLOCK (pad);
4268     /* We unref the buffer, except if the probe handled it (CUSTOM_SUCCESS_1) */
4269     if (!handled)
4270       gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4271
4272     switch (ret) {
4273       case GST_FLOW_CUSTOM_SUCCESS:
4274       case GST_FLOW_CUSTOM_SUCCESS_1:
4275         GST_DEBUG_OBJECT (pad, "dropped or handled buffer");
4276         ret = GST_FLOW_OK;
4277         break;
4278       default:
4279         GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4280         break;
4281     }
4282     return ret;
4283   }
4284 no_parent:
4285   {
4286     GST_DEBUG_OBJECT (pad, "No parent when chaining %" GST_PTR_FORMAT, data);
4287     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4288     GST_OBJECT_UNLOCK (pad);
4289     GST_PAD_STREAM_UNLOCK (pad);
4290     return GST_FLOW_FLUSHING;
4291   }
4292 no_function:
4293   {
4294     RELEASE_PARENT (parent);
4295     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4296     g_critical ("chain on pad %s:%s but it has no chainfunction",
4297         GST_DEBUG_PAD_NAME (pad));
4298     GST_PAD_STREAM_UNLOCK (pad);
4299     return GST_FLOW_NOT_SUPPORTED;
4300   }
4301 }
4302
4303 /**
4304  * gst_pad_chain:
4305  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4306  * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
4307  *     if not.
4308  *
4309  * Chain a buffer to @pad.
4310  *
4311  * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4312  *
4313  * If the buffer type is not acceptable for @pad (as negotiated with a
4314  * preceding GST_EVENT_CAPS event), this function returns
4315  * #GST_FLOW_NOT_NEGOTIATED.
4316  *
4317  * The function proceeds calling the chain function installed on @pad (see
4318  * gst_pad_set_chain_function()) and the return value of that function is
4319  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4320  * chain function.
4321  *
4322  * In all cases, success or failure, the caller loses its reference to @buffer
4323  * after calling this function.
4324  *
4325  * Returns: a #GstFlowReturn from the pad.
4326  *
4327  * MT safe.
4328  */
4329 GstFlowReturn
4330 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
4331 {
4332   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4333   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4334   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4335
4336   return gst_pad_chain_data_unchecked (pad,
4337       GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4338 }
4339
4340 static GstFlowReturn
4341 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
4342     GstBufferList * list)
4343 {
4344   guint i, len;
4345   GstBuffer *buffer;
4346   GstFlowReturn ret;
4347
4348   GST_INFO_OBJECT (pad, "chaining each buffer in list individually");
4349
4350   len = gst_buffer_list_length (list);
4351
4352   ret = GST_FLOW_OK;
4353   for (i = 0; i < len; i++) {
4354     buffer = gst_buffer_list_get (list, i);
4355     ret =
4356         gst_pad_chain_data_unchecked (pad,
4357         GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
4358         gst_buffer_ref (buffer));
4359     if (ret != GST_FLOW_OK)
4360       break;
4361   }
4362   gst_buffer_list_unref (list);
4363
4364   return ret;
4365 }
4366
4367 /**
4368  * gst_pad_chain_list:
4369  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4370  * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
4371  *     if not.
4372  *
4373  * Chain a bufferlist to @pad.
4374  *
4375  * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4376  *
4377  * If @pad was not negotiated properly with a CAPS event, this function
4378  * returns #GST_FLOW_NOT_NEGOTIATED.
4379  *
4380  * The function proceeds calling the chainlist function installed on @pad (see
4381  * gst_pad_set_chain_list_function()) and the return value of that function is
4382  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4383  * chainlist function.
4384  *
4385  * In all cases, success or failure, the caller loses its reference to @list
4386  * after calling this function.
4387  *
4388  * MT safe.
4389  *
4390  * Returns: a #GstFlowReturn from the pad.
4391  */
4392 GstFlowReturn
4393 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
4394 {
4395   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4396   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4397   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4398
4399   return gst_pad_chain_data_unchecked (pad,
4400       GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4401 }
4402
4403 static GstFlowReturn
4404 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
4405 {
4406   GstPad *peer;
4407   GstFlowReturn ret;
4408   gboolean handled = FALSE;
4409
4410   GST_OBJECT_LOCK (pad);
4411   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4412     goto flushing;
4413
4414   if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4415     goto eos;
4416
4417   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4418     goto wrong_mode;
4419
4420 #ifdef GST_ENABLE_EXTRA_CHECKS
4421   if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4422     if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4423       g_warning (G_STRLOC
4424           ":%s:<%s:%s> Got data flow before stream-start event",
4425           G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4426     }
4427     if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4428       g_warning (G_STRLOC
4429           ":%s:<%s:%s> Got data flow before segment event",
4430           G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4431     }
4432     pad->priv->last_cookie = pad->priv->events_cookie;
4433   }
4434 #endif
4435
4436   if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4437     goto events_error;
4438
4439   /* do block probes */
4440   PROBE_HANDLE (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped,
4441       probe_handled);
4442
4443   /* recheck sticky events because the probe might have cause a relink */
4444   if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4445     goto events_error;
4446
4447   /* do post-blocking probes */
4448   PROBE_HANDLE (pad, type, data, probe_stopped, probe_handled);
4449
4450   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4451     goto not_linked;
4452
4453   /* take ref to peer pad before releasing the lock */
4454   gst_object_ref (peer);
4455   pad->priv->using++;
4456   GST_OBJECT_UNLOCK (pad);
4457
4458   ret = gst_pad_chain_data_unchecked (peer, type, data);
4459   data = NULL;
4460
4461   gst_object_unref (peer);
4462
4463   GST_OBJECT_LOCK (pad);
4464   pad->ABI.abi.last_flowret = ret;
4465   pad->priv->using--;
4466   if (pad->priv->using == 0) {
4467     /* pad is not active anymore, trigger idle callbacks */
4468     PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4469         probe_stopped, ret);
4470   }
4471   GST_OBJECT_UNLOCK (pad);
4472
4473   return ret;
4474
4475   /* ERROR recovery here */
4476   /* ERRORS */
4477 flushing:
4478   {
4479     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4480         "pushing, but pad was flushing");
4481     pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4482     GST_OBJECT_UNLOCK (pad);
4483     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4484     return GST_FLOW_FLUSHING;
4485   }
4486 eos:
4487   {
4488     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pushing, but pad was EOS");
4489     pad->ABI.abi.last_flowret = GST_FLOW_EOS;
4490     GST_OBJECT_UNLOCK (pad);
4491     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4492     return GST_FLOW_EOS;
4493   }
4494 wrong_mode:
4495   {
4496     g_critical ("pushing on pad %s:%s but it was not activated in push mode",
4497         GST_DEBUG_PAD_NAME (pad));
4498     pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4499     GST_OBJECT_UNLOCK (pad);
4500     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4501     return GST_FLOW_ERROR;
4502   }
4503 events_error:
4504   {
4505     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4506         "error pushing events, return %s", gst_flow_get_name (ret));
4507     pad->ABI.abi.last_flowret = ret;
4508     GST_OBJECT_UNLOCK (pad);
4509     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4510     return ret;
4511   }
4512 probe_handled:
4513   handled = TRUE;
4514   /* PASSTHROUGH */
4515 probe_stopped:
4516   {
4517     GST_OBJECT_UNLOCK (pad);
4518     if (data != NULL && !handled)
4519       gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4520
4521     switch (ret) {
4522       case GST_FLOW_CUSTOM_SUCCESS:
4523       case GST_FLOW_CUSTOM_SUCCESS_1:
4524         GST_DEBUG_OBJECT (pad, "dropped or handled buffer");
4525         ret = GST_FLOW_OK;
4526         break;
4527       default:
4528         GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4529         break;
4530     }
4531     pad->ABI.abi.last_flowret = ret;
4532     return ret;
4533   }
4534 not_linked:
4535   {
4536     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4537         "pushing, but it was not linked");
4538     pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4539     GST_OBJECT_UNLOCK (pad);
4540     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4541     return GST_FLOW_NOT_LINKED;
4542   }
4543 }
4544
4545 /**
4546  * gst_pad_push:
4547  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4548  * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
4549  *     if not.
4550  *
4551  * Pushes a buffer to the peer of @pad.
4552  *
4553  * This function will call installed block probes before triggering any
4554  * installed data probes.
4555  *
4556  * The function proceeds calling gst_pad_chain() on the peer pad and returns
4557  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4558  * be returned.
4559  *
4560  * In all cases, success or failure, the caller loses its reference to @buffer
4561  * after calling this function.
4562  *
4563  * Returns: a #GstFlowReturn from the peer pad.
4564  *
4565  * MT safe.
4566  */
4567 GstFlowReturn
4568 gst_pad_push (GstPad * pad, GstBuffer * buffer)
4569 {
4570   GstFlowReturn res;
4571
4572   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4573   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4574   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4575
4576   GST_TRACER_PAD_PUSH_PRE (pad, buffer);
4577   res = gst_pad_push_data (pad,
4578       GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4579   GST_TRACER_PAD_PUSH_POST (pad, res);
4580   return res;
4581 }
4582
4583 /**
4584  * gst_pad_push_list:
4585  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4586  * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
4587  *     if not.
4588  *
4589  * Pushes a buffer list to the peer of @pad.
4590  *
4591  * This function will call installed block probes before triggering any
4592  * installed data probes.
4593  *
4594  * The function proceeds calling the chain function on the peer pad and returns
4595  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4596  * be returned. If the peer pad does not have any installed chainlist function
4597  * every group buffer of the list will be merged into a normal #GstBuffer and
4598  * chained via gst_pad_chain().
4599  *
4600  * In all cases, success or failure, the caller loses its reference to @list
4601  * after calling this function.
4602  *
4603  * Returns: a #GstFlowReturn from the peer pad.
4604  *
4605  * MT safe.
4606  */
4607 GstFlowReturn
4608 gst_pad_push_list (GstPad * pad, GstBufferList * list)
4609 {
4610   GstFlowReturn res;
4611
4612   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4613   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4614   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4615
4616   GST_TRACER_PAD_PUSH_LIST_PRE (pad, list);
4617   res = gst_pad_push_data (pad,
4618       GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4619   GST_TRACER_PAD_PUSH_LIST_POST (pad, res);
4620   return res;
4621 }
4622
4623 static GstFlowReturn
4624 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
4625     GstBuffer ** buffer)
4626 {
4627   GstFlowReturn ret;
4628   GstPadGetRangeFunction getrangefunc;
4629   GstObject *parent;
4630   GstBuffer *res_buf;
4631
4632   GST_PAD_STREAM_LOCK (pad);
4633
4634   GST_OBJECT_LOCK (pad);
4635   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4636     goto flushing;
4637
4638   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4639     goto wrong_mode;
4640
4641   if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4642     goto events_error;
4643
4644   res_buf = *buffer;
4645
4646   /* when one of the probes returns DROPPED, probe_stopped will be called
4647    * and we skip calling the getrange function, res_buf should then contain a
4648    * valid result buffer */
4649   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4650       res_buf, offset, size, probe_stopped);
4651
4652   /* recheck sticky events because the probe might have cause a relink */
4653   if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4654     goto events_error;
4655
4656   ACQUIRE_PARENT (pad, parent, no_parent);
4657   GST_OBJECT_UNLOCK (pad);
4658
4659   if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
4660     goto no_function;
4661
4662   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4663       "calling getrangefunc %s, offset %"
4664       G_GUINT64_FORMAT ", size %u",
4665       GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
4666
4667   ret = getrangefunc (pad, parent, offset, size, &res_buf);
4668
4669   RELEASE_PARENT (parent);
4670
4671   GST_OBJECT_LOCK (pad);
4672   if (G_UNLIKELY (ret != GST_FLOW_OK))
4673     goto get_range_failed;
4674
4675   /* can only fire the signal if we have a valid buffer */
4676 probed_data:
4677   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4678       res_buf, offset, size, probe_stopped_unref);
4679   pad->ABI.abi.last_flowret = ret;
4680   GST_OBJECT_UNLOCK (pad);
4681
4682   GST_PAD_STREAM_UNLOCK (pad);
4683
4684   *buffer = res_buf;
4685
4686   return ret;
4687
4688   /* ERRORS */
4689 flushing:
4690   {
4691     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4692         "getrange, but pad was flushing");
4693     pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4694     GST_OBJECT_UNLOCK (pad);
4695     GST_PAD_STREAM_UNLOCK (pad);
4696     return GST_FLOW_FLUSHING;
4697   }
4698 wrong_mode:
4699   {
4700     g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
4701         GST_DEBUG_PAD_NAME (pad));
4702     pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4703     GST_OBJECT_UNLOCK (pad);
4704     GST_PAD_STREAM_UNLOCK (pad);
4705     return GST_FLOW_ERROR;
4706   }
4707 events_error:
4708   {
4709     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
4710     pad->ABI.abi.last_flowret = ret;
4711     GST_OBJECT_UNLOCK (pad);
4712     GST_PAD_STREAM_UNLOCK (pad);
4713     return ret;
4714   }
4715 no_parent:
4716   {
4717     GST_DEBUG_OBJECT (pad, "no parent");
4718     pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4719     GST_OBJECT_UNLOCK (pad);
4720     GST_PAD_STREAM_UNLOCK (pad);
4721     return GST_FLOW_FLUSHING;
4722   }
4723 no_function:
4724   {
4725     g_critical ("getrange on pad %s:%s but it has no getrangefunction",
4726         GST_DEBUG_PAD_NAME (pad));
4727     RELEASE_PARENT (parent);
4728     GST_PAD_STREAM_UNLOCK (pad);
4729     return GST_FLOW_NOT_SUPPORTED;
4730   }
4731 probe_stopped:
4732   {
4733     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4734         "probe returned %s", gst_flow_get_name (ret));
4735     if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4736       if (res_buf) {
4737         /* the probe filled the buffer and asks us to not call the getrange
4738          * anymore, we continue with the post probes then. */
4739         GST_DEBUG_OBJECT (pad, "handled buffer");
4740         ret = GST_FLOW_OK;
4741         goto probed_data;
4742       } else {
4743         /* no buffer, we are EOS */
4744         GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4745         ret = GST_FLOW_EOS;
4746       }
4747     }
4748     pad->ABI.abi.last_flowret = ret;
4749     GST_OBJECT_UNLOCK (pad);
4750     GST_PAD_STREAM_UNLOCK (pad);
4751
4752     return ret;
4753   }
4754 probe_stopped_unref:
4755   {
4756     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4757         "probe returned %s", gst_flow_get_name (ret));
4758     /* if we drop here, it signals EOS */
4759     if (ret == GST_FLOW_CUSTOM_SUCCESS)
4760       ret = GST_FLOW_EOS;
4761     pad->ABI.abi.last_flowret = ret;
4762     GST_OBJECT_UNLOCK (pad);
4763     GST_PAD_STREAM_UNLOCK (pad);
4764     if (*buffer == NULL)
4765       gst_buffer_unref (res_buf);
4766     return ret;
4767   }
4768 get_range_failed:
4769   {
4770     pad->ABI.abi.last_flowret = ret;
4771     GST_OBJECT_UNLOCK (pad);
4772     GST_PAD_STREAM_UNLOCK (pad);
4773     GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4774         (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4775         pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
4776     return ret;
4777   }
4778 }
4779
4780 /**
4781  * gst_pad_get_range:
4782  * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4783  * @offset: The start offset of the buffer
4784  * @size: The length of the buffer
4785  * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
4786  *     returns #GST_FLOW_ERROR if %NULL.
4787  *
4788  * When @pad is flushing this function returns #GST_FLOW_FLUSHING
4789  * immediately and @buffer is %NULL.
4790  *
4791  * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4792  * description of a getrange function. If @pad has no getrange function
4793  * installed (see gst_pad_set_getrange_function()) this function returns
4794  * #GST_FLOW_NOT_SUPPORTED.
4795  *
4796  * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4797  * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4798  * must be freed with gst_buffer_unref() after usage.
4799  *
4800  * When @buffer points to a variable that points to a valid #GstBuffer, the
4801  * buffer will be filled with the result data when this function returns
4802  * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4803  * @size bytes will be filled in the result buffer and its size will be updated
4804  * accordingly.
4805  *
4806  * Note that less than @size bytes can be returned in @buffer when, for example,
4807  * an EOS condition is near or when @buffer is not large enough to hold @size
4808  * bytes. The caller should check the result buffer size to get the result size.
4809  *
4810  * When this function returns any other result value than #GST_FLOW_OK, @buffer
4811  * will be unchanged.
4812  *
4813  * This is a lowlevel function. Usually gst_pad_pull_range() is used.
4814  *
4815  * Returns: a #GstFlowReturn from the pad.
4816  *
4817  * MT safe.
4818  */
4819 GstFlowReturn
4820 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4821     GstBuffer ** buffer)
4822 {
4823   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4824   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4825   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4826   g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4827           && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4828
4829   return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4830 }
4831
4832 /**
4833  * gst_pad_pull_range:
4834  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4835  * @offset: The start offset of the buffer
4836  * @size: The length of the buffer
4837  * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4838  *     GST_FLOW_ERROR if %NULL.
4839  *
4840  * Pulls a @buffer from the peer pad or fills up a provided buffer.
4841  *
4842  * This function will first trigger the pad block signal if it was
4843  * installed.
4844  *
4845  * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4846  * function returns the result of gst_pad_get_range() on the peer pad.
4847  * See gst_pad_get_range() for a list of return values and for the
4848  * semantics of the arguments of this function.
4849  *
4850  * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4851  * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4852  * must be freed with gst_buffer_unref() after usage. When this function
4853  * returns any other result value, @buffer will still point to %NULL.
4854  *
4855  * When @buffer points to a variable that points to a valid #GstBuffer, the
4856  * buffer will be filled with the result data when this function returns
4857  * #GST_FLOW_OK. When this function returns any other result value,
4858  * @buffer will be unchanged. If the provided buffer is larger than @size, only
4859  * @size bytes will be filled in the result buffer and its size will be updated
4860  * accordingly.
4861  *
4862  * Note that less than @size bytes can be returned in @buffer when, for example,
4863  * an EOS condition is near or when @buffer is not large enough to hold @size
4864  * bytes. The caller should check the result buffer size to get the result size.
4865  *
4866  * Returns: a #GstFlowReturn from the peer pad.
4867  *
4868  * MT safe.
4869  */
4870 GstFlowReturn
4871 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4872     GstBuffer ** buffer)
4873 {
4874   GstPad *peer;
4875   GstFlowReturn ret;
4876   GstBuffer *res_buf;
4877
4878   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4879   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4880   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4881   g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4882           && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4883
4884   GST_TRACER_PAD_PULL_RANGE_PRE (pad, offset, size);
4885
4886   GST_OBJECT_LOCK (pad);
4887   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4888     goto flushing;
4889
4890   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4891     goto wrong_mode;
4892
4893   res_buf = *buffer;
4894
4895   /* when one of the probes returns DROPPED, probe_stopped will be
4896    * called and we skip calling the peer getrange function. *buffer should then
4897    * contain a valid buffer */
4898   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4899       res_buf, offset, size, probe_stopped);
4900
4901   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4902     goto not_linked;
4903
4904   gst_object_ref (peer);
4905   pad->priv->using++;
4906   GST_OBJECT_UNLOCK (pad);
4907
4908   ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4909
4910   gst_object_unref (peer);
4911
4912   GST_OBJECT_LOCK (pad);
4913   pad->priv->using--;
4914   pad->ABI.abi.last_flowret = ret;
4915   if (pad->priv->using == 0) {
4916     /* pad is not active anymore, trigger idle callbacks */
4917     PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4918         probe_stopped_unref, ret);
4919   }
4920
4921   if (G_UNLIKELY (ret != GST_FLOW_OK))
4922     goto pull_range_failed;
4923
4924 probed_data:
4925   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4926       res_buf, offset, size, probe_stopped_unref);
4927
4928   GST_OBJECT_UNLOCK (pad);
4929
4930   *buffer = res_buf;
4931
4932   GST_TRACER_PAD_PULL_RANGE_POST (pad, *buffer, ret);
4933   return ret;
4934
4935   /* ERROR recovery here */
4936 flushing:
4937   {
4938     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4939         "pullrange, but pad was flushing");
4940     pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4941     GST_OBJECT_UNLOCK (pad);
4942     ret = GST_FLOW_FLUSHING;
4943     goto done;
4944   }
4945 wrong_mode:
4946   {
4947     g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4948         GST_DEBUG_PAD_NAME (pad));
4949     pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4950     GST_OBJECT_UNLOCK (pad);
4951     ret = GST_FLOW_ERROR;
4952     goto done;
4953   }
4954 probe_stopped:
4955   {
4956     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4957         gst_flow_get_name (ret));
4958     if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4959       if (res_buf) {
4960         /* the probe filled the buffer and asks us to not forward to the peer
4961          * anymore, we continue with the post probes then */
4962         GST_DEBUG_OBJECT (pad, "handled buffer");
4963         ret = GST_FLOW_OK;
4964         goto probed_data;
4965       } else {
4966         /* no buffer, we are EOS then */
4967         GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4968         ret = GST_FLOW_EOS;
4969       }
4970     }
4971     pad->ABI.abi.last_flowret = ret;
4972     GST_OBJECT_UNLOCK (pad);
4973     goto done;
4974   }
4975 not_linked:
4976   {
4977     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4978         "pulling range, but it was not linked");
4979     pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4980     GST_OBJECT_UNLOCK (pad);
4981     ret = GST_FLOW_NOT_LINKED;
4982     goto done;
4983   }
4984 pull_range_failed:
4985   {
4986     pad->ABI.abi.last_flowret = ret;
4987     GST_OBJECT_UNLOCK (pad);
4988     GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4989         (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4990         pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4991     goto done;
4992   }
4993 probe_stopped_unref:
4994   {
4995     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4996         "post probe returned %s", gst_flow_get_name (ret));
4997
4998     /* if we drop here, it signals EOS */
4999     if (ret == GST_FLOW_CUSTOM_SUCCESS)
5000       ret = GST_FLOW_EOS;
5001
5002     pad->ABI.abi.last_flowret = ret;
5003     GST_OBJECT_UNLOCK (pad);
5004
5005     if (*buffer == NULL)
5006       gst_buffer_unref (res_buf);
5007     goto done;
5008   }
5009 done:
5010   GST_TRACER_PAD_PULL_RANGE_POST (pad, NULL, ret);
5011   return ret;
5012 }
5013
5014 /* must be called with pad object lock */
5015 static GstFlowReturn
5016 store_sticky_event (GstPad * pad, GstEvent * event)
5017 {
5018   guint i, len;
5019   GstEventType type;
5020   GArray *events;
5021   gboolean res = FALSE;
5022   const gchar *name = NULL;
5023   gboolean insert = TRUE;
5024
5025   type = GST_EVENT_TYPE (event);
5026
5027   /* Store all sticky events except SEGMENT/EOS when we're flushing,
5028    * otherwise they can be dropped and nothing would ever resend them.
5029    * Only do that for activated pads though, everything else is a bug!
5030    */
5031   if (G_UNLIKELY (GST_PAD_MODE (pad) == GST_PAD_MODE_NONE
5032           || (GST_PAD_IS_FLUSHING (pad) && (type == GST_EVENT_SEGMENT
5033                   || type == GST_EVENT_EOS))))
5034     goto flushed;
5035
5036   /* Unset the EOS flag when received STREAM_START event, so pad can
5037    * store sticky event and then push it later */
5038   if (type == GST_EVENT_STREAM_START) {
5039     GST_LOG_OBJECT (pad, "Removing pending EOS and StreamGroupDone events");
5040     remove_event_by_type (pad, GST_EVENT_EOS);
5041     remove_event_by_type (pad, GST_EVENT_STREAM_GROUP_DONE);
5042     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5043   }
5044
5045   if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5046     goto eos;
5047
5048   if (type & GST_EVENT_TYPE_STICKY_MULTI)
5049     name = gst_structure_get_name (gst_event_get_structure (event));
5050
5051   events = pad->priv->events;
5052   len = events->len;
5053
5054   for (i = 0; i < len; i++) {
5055     PadEvent *ev = &g_array_index (events, PadEvent, i);
5056
5057     if (ev->event == NULL)
5058       continue;
5059
5060     if (type == GST_EVENT_TYPE (ev->event)) {
5061       /* matching types, check matching name if needed */
5062       if (name && !gst_event_has_name (ev->event, name))
5063         continue;
5064
5065       /* overwrite */
5066       if ((res = gst_event_replace (&ev->event, event)))
5067         ev->received = FALSE;
5068
5069       insert = FALSE;
5070       break;
5071     }
5072
5073     if (type < GST_EVENT_TYPE (ev->event) || (type != GST_EVENT_TYPE (ev->event)
5074             && GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS)) {
5075       /* STREAM_START, CAPS and SEGMENT must be delivered in this order. By
5076        * storing the sticky ordered we can check that this is respected. */
5077       if (G_UNLIKELY (GST_EVENT_TYPE (ev->event) <= GST_EVENT_SEGMENT
5078               || GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS))
5079         g_warning (G_STRLOC
5080             ":%s:<%s:%s> Sticky event misordering, got '%s' before '%s'",
5081             G_STRFUNC, GST_DEBUG_PAD_NAME (pad),
5082             gst_event_type_get_name (GST_EVENT_TYPE (ev->event)),
5083             gst_event_type_get_name (type));
5084       break;
5085     }
5086   }
5087   if (insert) {
5088     PadEvent ev;
5089     ev.event = gst_event_ref (event);
5090     ev.received = FALSE;
5091     g_array_insert_val (events, i, ev);
5092     res = TRUE;
5093   }
5094
5095   if (res) {
5096     pad->priv->events_cookie++;
5097     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5098
5099     GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
5100
5101     switch (GST_EVENT_TYPE (event)) {
5102       case GST_EVENT_CAPS:
5103         GST_OBJECT_UNLOCK (pad);
5104
5105         GST_DEBUG_OBJECT (pad, "notify caps");
5106         g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
5107
5108         GST_OBJECT_LOCK (pad);
5109         break;
5110       default:
5111         break;
5112     }
5113   }
5114   if (type == GST_EVENT_EOS) {
5115     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
5116     pad->ABI.abi.last_flowret = GST_FLOW_EOS;
5117   }
5118
5119   return GST_PAD_IS_FLUSHING (pad) ? GST_FLOW_FLUSHING : GST_FLOW_OK;
5120
5121   /* ERRORS */
5122 flushed:
5123   {
5124     GST_DEBUG_OBJECT (pad, "pad is flushing");
5125     return GST_FLOW_FLUSHING;
5126   }
5127 eos:
5128   {
5129     GST_DEBUG_OBJECT (pad, "pad is EOS");
5130     return GST_FLOW_EOS;
5131   }
5132 }
5133
5134 /**
5135  * gst_pad_store_sticky_event:
5136  * @pad: a #GstPad
5137  * @event: (transfer none): a #GstEvent
5138  *
5139  * Store the sticky @event on @pad
5140  *
5141  * Returns: #GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad
5142  * was flushing or #GST_FLOW_EOS when the pad was EOS.
5143  *
5144  * Since: 1.2
5145  */
5146 GstFlowReturn
5147 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event)
5148 {
5149   GstFlowReturn ret;
5150
5151   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5152   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
5153
5154   GST_OBJECT_LOCK (pad);
5155   ret = store_sticky_event (pad, event);
5156   GST_OBJECT_UNLOCK (pad);
5157
5158   return ret;
5159 }
5160
5161 static gboolean
5162 sticky_changed (GstPad * pad, PadEvent * ev, gpointer user_data)
5163 {
5164   PushStickyData *data = user_data;
5165
5166   /* Forward all sticky events before our current one that are pending */
5167   if (ev->event != data->event
5168       && GST_EVENT_TYPE (ev->event) < GST_EVENT_TYPE (data->event))
5169     return push_sticky (pad, ev, data);
5170
5171   return TRUE;
5172 }
5173
5174 /* should be called with pad LOCK */
5175 static GstFlowReturn
5176 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
5177     GstPadProbeType type)
5178 {
5179   GstFlowReturn ret;
5180   GstPad *peerpad;
5181   GstEventType event_type;
5182
5183   /* pass the adjusted event on. We need to do this even if
5184    * there is no peer pad because of the probes. */
5185   event = apply_pad_offset (pad, event, GST_PAD_IS_SINK (pad));
5186
5187   /* Two checks to be made:
5188    * . (un)set the FLUSHING flag for flushing events,
5189    * . handle pad blocking */
5190   event_type = GST_EVENT_TYPE (event);
5191   switch (event_type) {
5192     case GST_EVENT_FLUSH_START:
5193       GST_PAD_SET_FLUSHING (pad);
5194
5195       GST_PAD_BLOCK_BROADCAST (pad);
5196       type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5197       break;
5198     case GST_EVENT_FLUSH_STOP:
5199       if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
5200         goto inactive;
5201
5202       GST_PAD_UNSET_FLUSHING (pad);
5203
5204       /* Remove sticky EOS events */
5205       GST_LOG_OBJECT (pad, "Removing pending EOS events");
5206       remove_event_by_type (pad, GST_EVENT_EOS);
5207       remove_event_by_type (pad, GST_EVENT_STREAM_GROUP_DONE);
5208       remove_event_by_type (pad, GST_EVENT_SEGMENT);
5209       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5210       pad->ABI.abi.last_flowret = GST_FLOW_OK;
5211
5212       type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5213       break;
5214     default:
5215     {
5216       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5217         goto flushed;
5218
5219       /* No need to check for EOS here as either the caller (gst_pad_push_event())
5220        * checked already or this is called as part of pushing sticky events,
5221        * in which case we still want to forward the EOS event downstream.
5222        */
5223
5224       switch (GST_EVENT_TYPE (event)) {
5225         case GST_EVENT_RECONFIGURE:
5226           if (GST_PAD_IS_SINK (pad))
5227             GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5228           break;
5229         default:
5230           break;
5231       }
5232       PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
5233           GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5234       break;
5235     }
5236   }
5237
5238   /* send probes after modifying the events above */
5239   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5240
5241   /* recheck sticky events because the probe might have cause a relink */
5242   if (GST_PAD_HAS_PENDING_EVENTS (pad) && GST_PAD_IS_SRC (pad)
5243       && (GST_EVENT_IS_SERIALIZED (event)
5244           || GST_EVENT_IS_STICKY (event))) {
5245     PushStickyData data = { GST_FLOW_OK, FALSE, event };
5246     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5247
5248     /* Push all sticky events before our current one
5249      * that have changed */
5250     events_foreach (pad, sticky_changed, &data);
5251   }
5252
5253   /* now check the peer pad */
5254   peerpad = GST_PAD_PEER (pad);
5255   if (peerpad == NULL)
5256     goto not_linked;
5257
5258   gst_object_ref (peerpad);
5259   pad->priv->using++;
5260   GST_OBJECT_UNLOCK (pad);
5261
5262   GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
5263       event, gst_event_type_get_name (event_type), peerpad);
5264
5265   ret = gst_pad_send_event_unchecked (peerpad, event, type);
5266
5267   /* Note: we gave away ownership of the event at this point but we can still
5268    * print the old pointer */
5269   GST_LOG_OBJECT (pad,
5270       "sent event %p (%s) to peerpad %" GST_PTR_FORMAT ", ret %s", event,
5271       gst_event_type_get_name (event_type), peerpad, gst_flow_get_name (ret));
5272
5273   gst_object_unref (peerpad);
5274
5275   GST_OBJECT_LOCK (pad);
5276   pad->priv->using--;
5277   if (pad->priv->using == 0) {
5278     /* pad is not active anymore, trigger idle callbacks */
5279     PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
5280         idle_probe_stopped, ret);
5281   }
5282   return ret;
5283
5284   /* ERROR handling */
5285 flushed:
5286   {
5287     GST_DEBUG_OBJECT (pad, "We're flushing");
5288     gst_event_unref (event);
5289     return GST_FLOW_FLUSHING;
5290   }
5291 inactive:
5292   {
5293     GST_DEBUG_OBJECT (pad, "flush-stop on inactive pad");
5294     gst_event_unref (event);
5295     return GST_FLOW_FLUSHING;
5296   }
5297 probe_stopped:
5298   {
5299     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5300     if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
5301       gst_event_unref (event);
5302
5303     switch (ret) {
5304       case GST_FLOW_CUSTOM_SUCCESS_1:
5305         GST_DEBUG_OBJECT (pad, "handled event");
5306         break;
5307       case GST_FLOW_CUSTOM_SUCCESS:
5308         GST_DEBUG_OBJECT (pad, "dropped event");
5309         break;
5310       default:
5311         GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5312         break;
5313     }
5314     return ret;
5315   }
5316 not_linked:
5317   {
5318     GST_DEBUG_OBJECT (pad, "Dropping event %s because pad is not linked",
5319         gst_event_type_get_name (GST_EVENT_TYPE (event)));
5320     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5321     gst_event_unref (event);
5322
5323     /* unlinked pads should not influence latency configuration */
5324     if (event_type == GST_EVENT_LATENCY)
5325       return GST_FLOW_OK;
5326
5327     return GST_FLOW_NOT_LINKED;
5328   }
5329 idle_probe_stopped:
5330   {
5331     GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
5332     return ret;
5333   }
5334 }
5335
5336 /**
5337  * gst_pad_push_event:
5338  * @pad: a #GstPad to push the event to.
5339  * @event: (transfer full): the #GstEvent to send to the pad.
5340  *
5341  * Sends the event to the peer of the given pad. This function is
5342  * mainly used by elements to send events to their peer
5343  * elements.
5344  *
5345  * This function takes ownership of the provided event so you should
5346  * gst_event_ref() it if you want to reuse the event after this call.
5347  *
5348  * Returns: %TRUE if the event was handled.
5349  *
5350  * MT safe.
5351  */
5352 gboolean
5353 gst_pad_push_event (GstPad * pad, GstEvent * event)
5354 {
5355   gboolean res = FALSE;
5356   GstPadProbeType type;
5357   gboolean sticky, serialized;
5358
5359   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5360   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
5361
5362   GST_TRACER_PAD_PUSH_EVENT_PRE (pad, event);
5363
5364   if (GST_PAD_IS_SRC (pad)) {
5365     if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5366       goto wrong_direction;
5367     type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5368   } else if (GST_PAD_IS_SINK (pad)) {
5369     if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5370       goto wrong_direction;
5371     /* events pushed on sinkpad never are sticky */
5372     type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5373   } else
5374     goto unknown_direction;
5375
5376   GST_OBJECT_LOCK (pad);
5377   sticky = GST_EVENT_IS_STICKY (event);
5378   serialized = GST_EVENT_IS_SERIALIZED (event);
5379
5380   if (sticky) {
5381     /* srcpad sticky events are stored immediately, the received flag is set
5382      * to FALSE and will be set to TRUE when we can successfully push the
5383      * event to the peer pad */
5384     switch (store_sticky_event (pad, event)) {
5385       case GST_FLOW_FLUSHING:
5386         goto flushed;
5387       case GST_FLOW_EOS:
5388         goto eos;
5389       default:
5390         break;
5391     }
5392   }
5393   if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
5394     /* all serialized or sticky events on the srcpad trigger push of
5395      * sticky events */
5396     res = (check_sticky (pad, event) == GST_FLOW_OK);
5397   }
5398   if (!sticky) {
5399     GstFlowReturn ret;
5400
5401     /* other events are pushed right away */
5402     ret = gst_pad_push_event_unchecked (pad, event, type);
5403     /* dropped events by a probe are not an error */
5404     res = (ret == GST_FLOW_OK || ret == GST_FLOW_CUSTOM_SUCCESS
5405         || ret == GST_FLOW_CUSTOM_SUCCESS_1);
5406   } else {
5407     /* Errors in sticky event pushing are no problem and ignored here
5408      * as they will cause more meaningful errors during data flow.
5409      * For EOS events, that are not followed by data flow, we still
5410      * return FALSE here though.
5411      */
5412     if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
5413       res = TRUE;
5414     gst_event_unref (event);
5415   }
5416   GST_OBJECT_UNLOCK (pad);
5417
5418   GST_TRACER_PAD_PUSH_EVENT_POST (pad, res);
5419   return res;
5420
5421   /* ERROR handling */
5422 wrong_direction:
5423   {
5424     g_warning ("pad %s:%s pushing %s event in wrong direction",
5425         GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5426     gst_event_unref (event);
5427     goto done;
5428   }
5429 unknown_direction:
5430   {
5431     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5432     gst_event_unref (event);
5433     goto done;
5434   }
5435 flushed:
5436   {
5437     GST_DEBUG_OBJECT (pad, "We're flushing");
5438     GST_OBJECT_UNLOCK (pad);
5439     gst_event_unref (event);
5440     goto done;
5441   }
5442 eos:
5443   {
5444     GST_DEBUG_OBJECT (pad, "We're EOS");
5445     GST_OBJECT_UNLOCK (pad);
5446     gst_event_unref (event);
5447     goto done;
5448   }
5449 done:
5450   GST_TRACER_PAD_PUSH_EVENT_POST (pad, FALSE);
5451   return FALSE;
5452 }
5453
5454 /* Check if we can call the event function with the given event */
5455 static GstFlowReturn
5456 pre_eventfunc_check (GstPad * pad, GstEvent * event)
5457 {
5458   GstCaps *caps;
5459
5460   switch (GST_EVENT_TYPE (event)) {
5461     case GST_EVENT_CAPS:
5462     {
5463       /* backwards compatibility mode for caps */
5464       gst_event_parse_caps (event, &caps);
5465
5466       if (!gst_pad_query_accept_caps (pad, caps))
5467         goto not_accepted;
5468       break;
5469     }
5470     default:
5471       break;
5472   }
5473   return GST_FLOW_OK;
5474
5475   /* ERRORS */
5476 not_accepted:
5477   {
5478     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
5479         "caps %" GST_PTR_FORMAT " not accepted", caps);
5480     return GST_FLOW_NOT_NEGOTIATED;
5481   }
5482 }
5483
5484 static GstFlowReturn
5485 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
5486     GstPadProbeType type)
5487 {
5488   GstFlowReturn ret;
5489   GstEventType event_type;
5490   gboolean serialized, need_unlock = FALSE, sticky;
5491   GstPadEventFunction eventfunc;
5492   GstPadEventFullFunction eventfullfunc = NULL;
5493   GstObject *parent;
5494
5495   GST_OBJECT_LOCK (pad);
5496
5497   event = apply_pad_offset (pad, event, GST_PAD_IS_SRC (pad));
5498
5499   if (GST_PAD_IS_SINK (pad))
5500     serialized = GST_EVENT_IS_SERIALIZED (event);
5501   else
5502     serialized = FALSE;
5503   sticky = GST_EVENT_IS_STICKY (event);
5504   event_type = GST_EVENT_TYPE (event);
5505   switch (event_type) {
5506     case GST_EVENT_FLUSH_START:
5507       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5508           "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
5509
5510       /* can't even accept a flush begin event when flushing */
5511       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5512         goto flushing;
5513
5514       GST_PAD_SET_FLUSHING (pad);
5515       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
5516       GST_PAD_BLOCK_BROADCAST (pad);
5517       type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5518       break;
5519     case GST_EVENT_FLUSH_STOP:
5520       /* we can't accept flush-stop on inactive pads else the flushing flag
5521        * would be cleared and it would look like the pad can accept data.
5522        * Also, some elements restart a streaming thread in flush-stop which we
5523        * can't allow on inactive pads */
5524       if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
5525         goto inactive;
5526
5527       GST_PAD_UNSET_FLUSHING (pad);
5528       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
5529       /* Remove pending EOS events */
5530       GST_LOG_OBJECT (pad, "Removing pending EOS and SEGMENT events");
5531       remove_event_by_type (pad, GST_EVENT_EOS);
5532       remove_event_by_type (pad, GST_EVENT_STREAM_GROUP_DONE);
5533       remove_event_by_type (pad, GST_EVENT_SEGMENT);
5534       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5535       pad->ABI.abi.last_flowret = GST_FLOW_OK;
5536
5537       GST_OBJECT_UNLOCK (pad);
5538       /* grab stream lock */
5539       GST_PAD_STREAM_LOCK (pad);
5540       need_unlock = TRUE;
5541       GST_OBJECT_LOCK (pad);
5542       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5543         goto flushing;
5544       break;
5545     case GST_EVENT_RECONFIGURE:
5546       if (GST_PAD_IS_SRC (pad))
5547         GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5548     default:
5549       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5550           "have event type %" GST_PTR_FORMAT, event);
5551
5552       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5553         goto flushing;
5554
5555       switch (event_type) {
5556         case GST_EVENT_STREAM_START:
5557           /* Remove sticky EOS events */
5558           GST_LOG_OBJECT (pad, "Removing pending EOS events");
5559           remove_event_by_type (pad, GST_EVENT_EOS);
5560           remove_event_by_type (pad, GST_EVENT_STREAM_GROUP_DONE);
5561           GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5562           break;
5563         default:
5564           break;
5565       }
5566
5567       if (serialized) {
5568         if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5569           goto eos;
5570
5571         /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
5572         GST_OBJECT_UNLOCK (pad);
5573         GST_PAD_STREAM_LOCK (pad);
5574         need_unlock = TRUE;
5575         GST_OBJECT_LOCK (pad);
5576         if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5577           goto flushing;
5578
5579         if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5580           goto eos;
5581       }
5582       break;
5583   }
5584
5585   /* now do the probe */
5586   PROBE_PUSH (pad,
5587       type | GST_PAD_PROBE_TYPE_PUSH |
5588       GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5589
5590   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5591
5592   eventfullfunc = GST_PAD_EVENTFULLFUNC (pad);
5593   eventfunc = GST_PAD_EVENTFUNC (pad);
5594   if (G_UNLIKELY (eventfunc == NULL && eventfullfunc == NULL))
5595     goto no_function;
5596
5597   ACQUIRE_PARENT (pad, parent, no_parent);
5598   GST_OBJECT_UNLOCK (pad);
5599
5600   ret = pre_eventfunc_check (pad, event);
5601   if (G_UNLIKELY (ret != GST_FLOW_OK))
5602     goto precheck_failed;
5603
5604   if (sticky)
5605     gst_event_ref (event);
5606
5607   if (eventfullfunc) {
5608     ret = eventfullfunc (pad, parent, event);
5609   } else if (eventfunc (pad, parent, event)) {
5610     ret = GST_FLOW_OK;
5611   } else {
5612     /* something went wrong */
5613     switch (event_type) {
5614       case GST_EVENT_CAPS:
5615         ret = GST_FLOW_NOT_NEGOTIATED;
5616         break;
5617       default:
5618         ret = GST_FLOW_ERROR;
5619         break;
5620     }
5621   }
5622   RELEASE_PARENT (parent);
5623
5624   GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
5625
5626   if (sticky) {
5627     if (ret == GST_FLOW_OK) {
5628       GST_OBJECT_LOCK (pad);
5629       /* after the event function accepted the event, we can store the sticky
5630        * event on the pad */
5631       switch (store_sticky_event (pad, event)) {
5632         case GST_FLOW_FLUSHING:
5633           goto flushing;
5634         case GST_FLOW_EOS:
5635           goto eos;
5636         default:
5637           break;
5638       }
5639       GST_OBJECT_UNLOCK (pad);
5640     }
5641     gst_event_unref (event);
5642   }
5643
5644   if (need_unlock)
5645     GST_PAD_STREAM_UNLOCK (pad);
5646
5647   return ret;
5648
5649   /* ERROR handling */
5650 flushing:
5651   {
5652     GST_OBJECT_UNLOCK (pad);
5653     if (need_unlock)
5654       GST_PAD_STREAM_UNLOCK (pad);
5655     GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5656         "Received event on flushing pad. Discarding");
5657     gst_event_unref (event);
5658     return GST_FLOW_FLUSHING;
5659   }
5660 inactive:
5661   {
5662     GST_OBJECT_UNLOCK (pad);
5663     if (need_unlock)
5664       GST_PAD_STREAM_UNLOCK (pad);
5665     GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5666         "Received flush-stop on inactive pad. Discarding");
5667     gst_event_unref (event);
5668     return GST_FLOW_FLUSHING;
5669   }
5670 eos:
5671   {
5672     GST_OBJECT_UNLOCK (pad);
5673     if (need_unlock)
5674       GST_PAD_STREAM_UNLOCK (pad);
5675     GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5676         "Received event on EOS pad. Discarding");
5677     gst_event_unref (event);
5678     return GST_FLOW_EOS;
5679   }
5680 probe_stopped:
5681   {
5682     GST_OBJECT_UNLOCK (pad);
5683     if (need_unlock)
5684       GST_PAD_STREAM_UNLOCK (pad);
5685     /* Only unref if unhandled */
5686     if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
5687       gst_event_unref (event);
5688
5689     switch (ret) {
5690       case GST_FLOW_CUSTOM_SUCCESS_1:
5691       case GST_FLOW_CUSTOM_SUCCESS:
5692         GST_DEBUG_OBJECT (pad, "dropped or handled event");
5693         ret = GST_FLOW_OK;
5694         break;
5695       default:
5696         GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5697         break;
5698     }
5699     return ret;
5700   }
5701 no_function:
5702   {
5703     g_warning ("pad %s:%s has no event handler, file a bug.",
5704         GST_DEBUG_PAD_NAME (pad));
5705     GST_OBJECT_UNLOCK (pad);
5706     if (need_unlock)
5707       GST_PAD_STREAM_UNLOCK (pad);
5708     gst_event_unref (event);
5709     return GST_FLOW_NOT_SUPPORTED;
5710   }
5711 no_parent:
5712   {
5713     GST_DEBUG_OBJECT (pad, "no parent");
5714     GST_OBJECT_UNLOCK (pad);
5715     if (need_unlock)
5716       GST_PAD_STREAM_UNLOCK (pad);
5717     gst_event_unref (event);
5718     return GST_FLOW_FLUSHING;
5719   }
5720 precheck_failed:
5721   {
5722     GST_DEBUG_OBJECT (pad, "pre event check failed");
5723     RELEASE_PARENT (parent);
5724     if (need_unlock)
5725       GST_PAD_STREAM_UNLOCK (pad);
5726     gst_event_unref (event);
5727     return ret;
5728   }
5729 }
5730
5731 /**
5732  * gst_pad_send_event:
5733  * @pad: a #GstPad to send the event to.
5734  * @event: (transfer full): the #GstEvent to send to the pad.
5735  *
5736  * Sends the event to the pad. This function can be used
5737  * by applications to send events in the pipeline.
5738  *
5739  * If @pad is a source pad, @event should be an upstream event. If @pad is a
5740  * sink pad, @event should be a downstream event. For example, you would not
5741  * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
5742  * Furthermore, some downstream events have to be serialized with data flow,
5743  * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
5744  * the event needs to be serialized with data flow, this function will take the
5745  * pad's stream lock while calling its event function.
5746  *
5747  * To find out whether an event type is upstream, downstream, or downstream and
5748  * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
5749  * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
5750  * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
5751  * plugin doesn't need to bother itself with this information; the core handles
5752  * all necessary locks and checks.
5753  *
5754  * This function takes ownership of the provided event so you should
5755  * gst_event_ref() it if you want to reuse the event after this call.
5756  *
5757  * Returns: %TRUE if the event was handled.
5758  */
5759 gboolean
5760 gst_pad_send_event (GstPad * pad, GstEvent * event)
5761 {
5762   gboolean result;
5763   GstPadProbeType type;
5764
5765   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5766   g_return_val_if_fail (event != NULL, FALSE);
5767
5768   if (GST_PAD_IS_SINK (pad)) {
5769     if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5770       goto wrong_direction;
5771     type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5772   } else if (GST_PAD_IS_SRC (pad)) {
5773     if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5774       goto wrong_direction;
5775     type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5776   } else
5777     goto unknown_direction;
5778
5779   if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
5780     result = FALSE;
5781   else
5782     result = TRUE;
5783
5784   return result;
5785
5786   /* ERROR handling */
5787 wrong_direction:
5788   {
5789     g_warning ("pad %s:%s sending %s event in wrong direction",
5790         GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5791     gst_event_unref (event);
5792     return FALSE;
5793   }
5794 unknown_direction:
5795   {
5796     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5797     gst_event_unref (event);
5798     return FALSE;
5799   }
5800 }
5801
5802 /**
5803  * gst_pad_set_element_private:
5804  * @pad: the #GstPad to set the private data of.
5805  * @priv: The private data to attach to the pad.
5806  *
5807  * Set the given private data gpointer on the pad.
5808  * This function can only be used by the element that owns the pad.
5809  * No locking is performed in this function.
5810  */
5811 void
5812 gst_pad_set_element_private (GstPad * pad, gpointer priv)
5813 {
5814   pad->element_private = priv;
5815 }
5816
5817 /**
5818  * gst_pad_get_element_private:
5819  * @pad: the #GstPad to get the private data of.
5820  *
5821  * Gets the private data of a pad.
5822  * No locking is performed in this function.
5823  *
5824  * Returns: (transfer none): a #gpointer to the private data.
5825  */
5826 gpointer
5827 gst_pad_get_element_private (GstPad * pad)
5828 {
5829   return pad->element_private;
5830 }
5831
5832 /**
5833  * gst_pad_get_sticky_event:
5834  * @pad: the #GstPad to get the event from.
5835  * @event_type: the #GstEventType that should be retrieved.
5836  * @idx: the index of the event
5837  *
5838  * Returns a new reference of the sticky event of type @event_type
5839  * from the event.
5840  *
5841  * Returns: (transfer full) (nullable): a #GstEvent of type
5842  * @event_type or %NULL when no event of @event_type was on
5843  * @pad. Unref after usage.
5844  */
5845 GstEvent *
5846 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
5847 {
5848   GstEvent *event = NULL;
5849   PadEvent *ev;
5850
5851   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
5852   g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
5853
5854   GST_OBJECT_LOCK (pad);
5855   ev = find_event_by_type (pad, event_type, idx);
5856   if (ev && (event = ev->event))
5857     gst_event_ref (event);
5858   GST_OBJECT_UNLOCK (pad);
5859
5860   return event;
5861 }
5862
5863 typedef struct
5864 {
5865   GstPadStickyEventsForeachFunction func;
5866   gpointer user_data;
5867 } ForeachDispatch;
5868
5869 static gboolean
5870 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
5871 {
5872   ForeachDispatch *data = user_data;
5873   gboolean ret = TRUE;
5874
5875   if (ev->event) {
5876     GST_OBJECT_UNLOCK (pad);
5877
5878     ret = data->func (pad, &ev->event, data->user_data);
5879
5880     GST_OBJECT_LOCK (pad);
5881   }
5882
5883   return ret;
5884 }
5885
5886 /**
5887  * gst_pad_sticky_events_foreach:
5888  * @pad: the #GstPad that should be used for iteration.
5889  * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
5890  *                should be called for every event.
5891  * @user_data: (closure): the optional user data.
5892  *
5893  * Iterates all sticky events on @pad and calls @foreach_func for every
5894  * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
5895  */
5896 void
5897 gst_pad_sticky_events_foreach (GstPad * pad,
5898     GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
5899 {
5900   ForeachDispatch data;
5901
5902   g_return_if_fail (GST_IS_PAD (pad));
5903   g_return_if_fail (foreach_func != NULL);
5904
5905   data.func = foreach_func;
5906   data.user_data = user_data;
5907
5908   GST_OBJECT_LOCK (pad);
5909   events_foreach (pad, foreach_dispatch_function, &data);
5910   GST_OBJECT_UNLOCK (pad);
5911 }
5912
5913 static void
5914 do_stream_status (GstPad * pad, GstStreamStatusType type,
5915     GThread * thread, GstTask * task)
5916 {
5917   GstElement *parent;
5918
5919   GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5920
5921   if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5922     if (GST_IS_ELEMENT (parent)) {
5923       GstMessage *message;
5924       GValue value = { 0 };
5925
5926       if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5927         gchar *tname, *ename, *pname;
5928
5929         /* create a good task name */
5930         ename = gst_element_get_name (parent);
5931         pname = gst_pad_get_name (pad);
5932         tname = g_strdup_printf ("%s:%s", ename, pname);
5933         g_free (ename);
5934         g_free (pname);
5935
5936         gst_object_set_name (GST_OBJECT_CAST (task), tname);
5937         g_free (tname);
5938       }
5939
5940       message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5941           type, parent);
5942
5943       g_value_init (&value, GST_TYPE_TASK);
5944       g_value_set_object (&value, task);
5945       gst_message_set_stream_status_object (message, &value);
5946       g_value_unset (&value);
5947
5948       GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5949       gst_element_post_message (parent, message);
5950     }
5951     gst_object_unref (parent);
5952   }
5953 }
5954
5955 static void
5956 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5957 {
5958   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5959       thread, task);
5960 }
5961
5962 static void
5963 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5964 {
5965   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5966       thread, task);
5967 }
5968
5969 /**
5970  * gst_pad_start_task:
5971  * @pad: the #GstPad to start the task of
5972  * @func: the task function to call
5973  * @user_data: user data passed to the task function
5974  * @notify: called when @user_data is no longer referenced
5975  *
5976  * Starts a task that repeatedly calls @func with @user_data. This function
5977  * is mostly used in pad activation functions to start the dataflow.
5978  * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5979  * before @func is called.
5980  *
5981  * Returns: a %TRUE if the task could be started.
5982  */
5983 gboolean
5984 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer user_data,
5985     GDestroyNotify notify)
5986 {
5987   GstTask *task;
5988   gboolean res;
5989
5990   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5991   g_return_val_if_fail (func != NULL, FALSE);
5992
5993   GST_DEBUG_OBJECT (pad, "start task");
5994
5995   GST_OBJECT_LOCK (pad);
5996   task = GST_PAD_TASK (pad);
5997   if (task == NULL) {
5998     task = gst_task_new (func, user_data, notify);
5999     gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
6000     gst_task_set_enter_callback (task, pad_enter_thread, pad, NULL);
6001     gst_task_set_leave_callback (task, pad_leave_thread, pad, NULL);
6002     GST_INFO_OBJECT (pad, "created task %p", task);
6003     GST_PAD_TASK (pad) = task;
6004     gst_object_ref (task);
6005     /* release lock to post the message */
6006     GST_OBJECT_UNLOCK (pad);
6007
6008     do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
6009
6010     gst_object_unref (task);
6011
6012     GST_OBJECT_LOCK (pad);
6013     /* nobody else is supposed to have changed the pad now */
6014     if (GST_PAD_TASK (pad) != task)
6015       goto concurrent_stop;
6016   }
6017   res = gst_task_set_state (task, GST_TASK_STARTED);
6018   GST_OBJECT_UNLOCK (pad);
6019
6020   return res;
6021
6022   /* ERRORS */
6023 concurrent_stop:
6024   {
6025     GST_OBJECT_UNLOCK (pad);
6026     return TRUE;
6027   }
6028 }
6029
6030 /**
6031  * gst_pad_pause_task:
6032  * @pad: the #GstPad to pause the task of
6033  *
6034  * Pause the task of @pad. This function will also wait until the
6035  * function executed by the task is finished if this function is not
6036  * called from the task function.
6037  *
6038  * Returns: a %TRUE if the task could be paused or %FALSE when the pad
6039  * has no task.
6040  */
6041 gboolean
6042 gst_pad_pause_task (GstPad * pad)
6043 {
6044   GstTask *task;
6045   gboolean res;
6046
6047   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
6048
6049   GST_DEBUG_OBJECT (pad, "pause task");
6050
6051   GST_OBJECT_LOCK (pad);
6052   task = GST_PAD_TASK (pad);
6053   if (task == NULL)
6054     goto no_task;
6055   res = gst_task_set_state (task, GST_TASK_PAUSED);
6056   GST_OBJECT_UNLOCK (pad);
6057
6058   /* wait for task function to finish, this lock is recursive so it does nothing
6059    * when the pause is called from the task itself */
6060   GST_PAD_STREAM_LOCK (pad);
6061   GST_PAD_STREAM_UNLOCK (pad);
6062
6063   return res;
6064
6065 no_task:
6066   {
6067     GST_DEBUG_OBJECT (pad, "pad has no task");
6068     GST_OBJECT_UNLOCK (pad);
6069     return FALSE;
6070   }
6071 }
6072
6073 /**
6074  * gst_pad_stop_task:
6075  * @pad: the #GstPad to stop the task of
6076  *
6077  * Stop the task of @pad. This function will also make sure that the
6078  * function executed by the task will effectively stop if not called
6079  * from the GstTaskFunction.
6080  *
6081  * This function will deadlock if called from the GstTaskFunction of
6082  * the task. Use gst_task_pause() instead.
6083  *
6084  * Regardless of whether the pad has a task, the stream lock is acquired and
6085  * released so as to ensure that streaming through this pad has finished.
6086  *
6087  * Returns: a %TRUE if the task could be stopped or %FALSE on error.
6088  */
6089 gboolean
6090 gst_pad_stop_task (GstPad * pad)
6091 {
6092   GstTask *task;
6093   gboolean res;
6094
6095   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
6096
6097   GST_DEBUG_OBJECT (pad, "stop task");
6098
6099   GST_OBJECT_LOCK (pad);
6100   task = GST_PAD_TASK (pad);
6101   if (task == NULL)
6102     goto no_task;
6103   GST_PAD_TASK (pad) = NULL;
6104   res = gst_task_set_state (task, GST_TASK_STOPPED);
6105   GST_OBJECT_UNLOCK (pad);
6106
6107   GST_PAD_STREAM_LOCK (pad);
6108   GST_PAD_STREAM_UNLOCK (pad);
6109
6110   if (!gst_task_join (task))
6111     goto join_failed;
6112
6113   gst_object_unref (task);
6114
6115   return res;
6116
6117 no_task:
6118   {
6119     GST_DEBUG_OBJECT (pad, "no task");
6120     GST_OBJECT_UNLOCK (pad);
6121
6122     GST_PAD_STREAM_LOCK (pad);
6123     GST_PAD_STREAM_UNLOCK (pad);
6124
6125     /* this is not an error */
6126     return TRUE;
6127   }
6128 join_failed:
6129   {
6130     /* this is bad, possibly the application tried to join the task from
6131      * the task's thread. We install the task again so that it will be stopped
6132      * again from the right thread next time hopefully. */
6133     GST_OBJECT_LOCK (pad);
6134     GST_DEBUG_OBJECT (pad, "join failed");
6135     /* we can only install this task if there was no other task */
6136     if (GST_PAD_TASK (pad) == NULL)
6137       GST_PAD_TASK (pad) = task;
6138     GST_OBJECT_UNLOCK (pad);
6139
6140     return FALSE;
6141   }
6142 }
6143
6144 /**
6145  * gst_pad_probe_info_get_event:
6146  * @info: a #GstPadProbeInfo
6147  *
6148  * Returns: (transfer none): The #GstEvent from the probe
6149  */
6150
6151 GstEvent *
6152 gst_pad_probe_info_get_event (GstPadProbeInfo * info)
6153 {
6154   g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM |
6155           GST_PAD_PROBE_TYPE_EVENT_UPSTREAM), NULL);
6156
6157   return GST_PAD_PROBE_INFO_EVENT (info);
6158 }
6159
6160
6161 /**
6162  * gst_pad_probe_info_get_query:
6163  * @info: a #GstPadProbeInfo
6164  *
6165  * Returns: (transfer none): The #GstQuery from the probe
6166  */
6167
6168 GstQuery *
6169 gst_pad_probe_info_get_query (GstPadProbeInfo * info)
6170 {
6171   g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM |
6172           GST_PAD_PROBE_TYPE_QUERY_UPSTREAM), NULL);
6173
6174   return GST_PAD_PROBE_INFO_QUERY (info);
6175 }
6176
6177 /**
6178  * gst_pad_probe_info_get_buffer:
6179  * @info: a #GstPadProbeInfo
6180  *
6181  * Returns: (transfer none): The #GstBuffer from the probe
6182  */
6183
6184 GstBuffer *
6185 gst_pad_probe_info_get_buffer (GstPadProbeInfo * info)
6186 {
6187   g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER, NULL);
6188
6189   return GST_PAD_PROBE_INFO_BUFFER (info);
6190 }
6191
6192 /**
6193  * gst_pad_probe_info_get_buffer_list:
6194  * @info: a #GstPadProbeInfo
6195  *
6196  * Returns: (transfer none): The #GstBufferList from the probe
6197  */
6198
6199 GstBufferList *
6200 gst_pad_probe_info_get_buffer_list (GstPadProbeInfo * info)
6201 {
6202   g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER_LIST, NULL);
6203
6204   return GST_PAD_PROBE_INFO_BUFFER_LIST (info);
6205 }
6206
6207 /**
6208  * gst_pad_get_last_flow_return:
6209  * @pad: the #GstPad
6210  *
6211  * Gets the #GstFlowReturn return from the last data passed by this pad.
6212  *
6213  * Since: 1.4
6214  */
6215 GstFlowReturn
6216 gst_pad_get_last_flow_return (GstPad * pad)
6217 {
6218   GstFlowReturn ret;
6219
6220   GST_OBJECT_LOCK (pad);
6221   ret = GST_PAD_LAST_FLOW_RETURN (pad);
6222   GST_OBJECT_UNLOCK (pad);
6223
6224   return ret;
6225 }