tracer: move the PAD_LINK tracer hook to _pad_link_full()
[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   GST_TRACER_PAD_LINK_PRE (srcpad, sinkpad);
2447
2448   /* Notify the parent early. See gst_pad_unlink for details. */
2449   if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2450     if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2451       gst_element_post_message (parent,
2452           gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2453               GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2454     } else {
2455       gst_object_unref (parent);
2456       parent = NULL;
2457     }
2458   }
2459
2460   /* prepare will also lock the two pads */
2461   result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2462
2463   if (G_UNLIKELY (result != GST_PAD_LINK_OK)) {
2464     GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2465         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2466         gst_pad_link_get_name (result));
2467     goto done;
2468   }
2469
2470   /* must set peers before calling the link function */
2471   GST_PAD_PEER (srcpad) = sinkpad;
2472   GST_PAD_PEER (sinkpad) = srcpad;
2473
2474   /* check events, when something is different, mark pending */
2475   schedule_events (srcpad, sinkpad);
2476
2477   /* get the link functions */
2478   srcfunc = GST_PAD_LINKFUNC (srcpad);
2479   sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2480
2481   if (G_UNLIKELY (srcfunc || sinkfunc)) {
2482     /* custom link functions, execute them */
2483     GST_OBJECT_UNLOCK (sinkpad);
2484     GST_OBJECT_UNLOCK (srcpad);
2485
2486     if (srcfunc) {
2487       GstObject *tmpparent;
2488
2489       ACQUIRE_PARENT (srcpad, tmpparent, no_parent);
2490       /* this one will call the peer link function */
2491       result = srcfunc (srcpad, tmpparent, sinkpad);
2492       RELEASE_PARENT (tmpparent);
2493     } else if (sinkfunc) {
2494       GstObject *tmpparent;
2495
2496       ACQUIRE_PARENT (sinkpad, tmpparent, no_parent);
2497       /* if no source link function, we need to call the sink link
2498        * function ourselves. */
2499       result = sinkfunc (sinkpad, tmpparent, srcpad);
2500       RELEASE_PARENT (tmpparent);
2501     }
2502   no_parent:
2503
2504     GST_OBJECT_LOCK (srcpad);
2505     GST_OBJECT_LOCK (sinkpad);
2506
2507     /* we released the lock, check if the same pads are linked still */
2508     if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2509       goto concurrent_link;
2510
2511     if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2512       goto link_failed;
2513   }
2514   GST_OBJECT_UNLOCK (sinkpad);
2515   GST_OBJECT_UNLOCK (srcpad);
2516
2517   /* fire off a signal to each of the pads telling them
2518    * that they've been linked */
2519   g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2520   g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2521
2522   GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2523       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2524
2525   if (!(flags & GST_PAD_LINK_CHECK_NO_RECONFIGURE))
2526     gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2527
2528 done:
2529   if (G_LIKELY (parent)) {
2530     gst_element_post_message (parent,
2531         gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2532             GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2533     gst_object_unref (parent);
2534   }
2535
2536   GST_TRACER_PAD_LINK_POST (srcpad, sinkpad, result);
2537   return result;
2538
2539   /* ERRORS */
2540 concurrent_link:
2541   {
2542     GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2543         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2544     GST_OBJECT_UNLOCK (sinkpad);
2545     GST_OBJECT_UNLOCK (srcpad);
2546
2547     /* The other link operation succeeded first */
2548     result = GST_PAD_LINK_WAS_LINKED;
2549     goto done;
2550   }
2551 link_failed:
2552   {
2553     GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2554         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2555         gst_pad_link_get_name (result));
2556
2557     GST_PAD_PEER (srcpad) = NULL;
2558     GST_PAD_PEER (sinkpad) = NULL;
2559
2560     GST_OBJECT_UNLOCK (sinkpad);
2561     GST_OBJECT_UNLOCK (srcpad);
2562
2563     goto done;
2564   }
2565 }
2566
2567 /**
2568  * gst_pad_link:
2569  * @srcpad: the source #GstPad to link.
2570  * @sinkpad: the sink #GstPad to link.
2571  *
2572  * Links the source pad and the sink pad.
2573  *
2574  * Returns: A result code indicating if the connection worked or
2575  *          what went wrong.
2576  *
2577  * MT Safe.
2578  */
2579 GstPadLinkReturn
2580 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2581 {
2582   return gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2583 }
2584
2585 static void
2586 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2587 {
2588   GstPadTemplate **template_p;
2589
2590   /* this function would need checks if it weren't static */
2591
2592   GST_OBJECT_LOCK (pad);
2593   template_p = &pad->padtemplate;
2594   gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2595   GST_OBJECT_UNLOCK (pad);
2596
2597   if (templ)
2598     gst_pad_template_pad_created (templ, pad);
2599 }
2600
2601 /**
2602  * gst_pad_get_pad_template:
2603  * @pad: a #GstPad.
2604  *
2605  * Gets the template for @pad.
2606  *
2607  * Returns: (transfer full) (nullable): the #GstPadTemplate from which
2608  *     this pad was instantiated, or %NULL if this pad has no
2609  *     template. Unref after usage.
2610  */
2611 GstPadTemplate *
2612 gst_pad_get_pad_template (GstPad * pad)
2613 {
2614   GstPadTemplate *templ;
2615
2616   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2617
2618   templ = GST_PAD_PAD_TEMPLATE (pad);
2619
2620   return (templ ? gst_object_ref (templ) : NULL);
2621 }
2622
2623 /**
2624  * gst_pad_has_current_caps:
2625  * @pad: a  #GstPad to check
2626  *
2627  * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2628  *
2629  * Returns: %TRUE when @pad has caps associated with it.
2630  */
2631 gboolean
2632 gst_pad_has_current_caps (GstPad * pad)
2633 {
2634   gboolean result;
2635   GstCaps *caps;
2636
2637   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2638
2639   GST_OBJECT_LOCK (pad);
2640   caps = get_pad_caps (pad);
2641   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2642       "check current pad caps %" GST_PTR_FORMAT, caps);
2643   result = (caps != NULL);
2644   GST_OBJECT_UNLOCK (pad);
2645
2646   return result;
2647 }
2648
2649 /**
2650  * gst_pad_get_current_caps:
2651  * @pad: a  #GstPad to get the current capabilities of.
2652  *
2653  * Gets the capabilities currently configured on @pad with the last
2654  * #GST_EVENT_CAPS event.
2655  *
2656  * Returns: (transfer full) (nullable): the current caps of the pad with
2657  * incremented ref-count or %NULL when pad has no caps. Unref after usage.
2658  */
2659 GstCaps *
2660 gst_pad_get_current_caps (GstPad * pad)
2661 {
2662   GstCaps *result;
2663
2664   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2665
2666   GST_OBJECT_LOCK (pad);
2667   if ((result = get_pad_caps (pad)))
2668     gst_caps_ref (result);
2669   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2670       "get current pad caps %" GST_PTR_FORMAT, result);
2671   GST_OBJECT_UNLOCK (pad);
2672
2673   return result;
2674 }
2675
2676 /**
2677  * gst_pad_get_pad_template_caps:
2678  * @pad: a #GstPad to get the template capabilities from.
2679  *
2680  * Gets the capabilities for @pad's template.
2681  *
2682  * Returns: (transfer full): the #GstCaps of this pad template.
2683  * Unref after usage.
2684  */
2685 GstCaps *
2686 gst_pad_get_pad_template_caps (GstPad * pad)
2687 {
2688   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2689
2690   if (GST_PAD_PAD_TEMPLATE (pad))
2691     return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2692
2693   return gst_caps_ref (GST_CAPS_ANY);
2694 }
2695
2696 /**
2697  * gst_pad_get_peer:
2698  * @pad: a #GstPad to get the peer of.
2699  *
2700  * Gets the peer of @pad. This function refs the peer pad so
2701  * you need to unref it after use.
2702  *
2703  * Returns: (transfer full): the peer #GstPad. Unref after usage.
2704  *
2705  * MT safe.
2706  */
2707 GstPad *
2708 gst_pad_get_peer (GstPad * pad)
2709 {
2710   GstPad *result;
2711
2712   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2713
2714   GST_OBJECT_LOCK (pad);
2715   result = GST_PAD_PEER (pad);
2716   if (result)
2717     gst_object_ref (result);
2718   GST_OBJECT_UNLOCK (pad);
2719
2720   return result;
2721 }
2722
2723 /**
2724  * gst_pad_get_allowed_caps:
2725  * @pad: a #GstPad.
2726  *
2727  * Gets the capabilities of the allowed media types that can flow through
2728  * @pad and its peer.
2729  *
2730  * The allowed capabilities is calculated as the intersection of the results of
2731  * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2732  * on the resulting caps.
2733  *
2734  * Returns: (transfer full) (nullable): the allowed #GstCaps of the
2735  *     pad link. Unref the caps when you no longer need it. This
2736  *     function returns %NULL when @pad has no peer.
2737  *
2738  * MT safe.
2739  */
2740 GstCaps *
2741 gst_pad_get_allowed_caps (GstPad * pad)
2742 {
2743   GstCaps *mycaps;
2744   GstCaps *caps = NULL;
2745   GstQuery *query;
2746
2747   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2748
2749   GST_OBJECT_LOCK (pad);
2750   if (G_UNLIKELY (GST_PAD_PEER (pad) == NULL))
2751     goto no_peer;
2752   GST_OBJECT_UNLOCK (pad);
2753
2754   GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2755
2756   mycaps = gst_pad_query_caps (pad, NULL);
2757
2758   /* Query peer caps */
2759   query = gst_query_new_caps (mycaps);
2760   if (!gst_pad_peer_query (pad, query)) {
2761     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "Caps query failed");
2762     goto end;
2763   }
2764
2765   gst_query_parse_caps_result (query, &caps);
2766   if (caps == NULL) {
2767     g_warn_if_fail (caps != NULL);
2768     goto end;
2769   }
2770   gst_caps_ref (caps);
2771
2772   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2773       caps);
2774
2775 end:
2776   gst_query_unref (query);
2777   gst_caps_unref (mycaps);
2778
2779   return caps;
2780
2781 no_peer:
2782   {
2783     GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2784     GST_OBJECT_UNLOCK (pad);
2785
2786     return NULL;
2787   }
2788 }
2789
2790 /**
2791  * gst_pad_iterate_internal_links_default:
2792  * @pad: the #GstPad to get the internal links of.
2793  * @parent: (allow-none): the parent of @pad or %NULL
2794  *
2795  * Iterate the list of pads to which the given pad is linked to inside of
2796  * the parent element.
2797  * This is the default handler, and thus returns an iterator of all of the
2798  * pads inside the parent element with opposite direction.
2799  *
2800  * The caller must free this iterator after use with gst_iterator_free().
2801  *
2802  * Returns: (nullable): a #GstIterator of #GstPad, or %NULL if @pad
2803  * has no parent. Unref each returned pad with gst_object_unref().
2804  */
2805 GstIterator *
2806 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2807 {
2808   GstIterator *res;
2809   GList **padlist;
2810   guint32 *cookie;
2811   GMutex *lock;
2812   gpointer owner;
2813   GstElement *eparent;
2814
2815   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2816
2817   if (parent != NULL && GST_IS_ELEMENT (parent)) {
2818     eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2819   } else {
2820     GST_OBJECT_LOCK (pad);
2821     eparent = GST_PAD_PARENT (pad);
2822     if (!eparent || !GST_IS_ELEMENT (eparent))
2823       goto no_parent;
2824
2825     gst_object_ref (eparent);
2826     GST_OBJECT_UNLOCK (pad);
2827   }
2828
2829   if (pad->direction == GST_PAD_SRC)
2830     padlist = &eparent->sinkpads;
2831   else
2832     padlist = &eparent->srcpads;
2833
2834   GST_DEBUG_OBJECT (pad, "Making iterator");
2835
2836   cookie = &eparent->pads_cookie;
2837   owner = eparent;
2838   lock = GST_OBJECT_GET_LOCK (eparent);
2839
2840   res = gst_iterator_new_list (GST_TYPE_PAD,
2841       lock, cookie, padlist, (GObject *) owner, NULL);
2842
2843   gst_object_unref (owner);
2844
2845   return res;
2846
2847   /* ERRORS */
2848 no_parent:
2849   {
2850     GST_OBJECT_UNLOCK (pad);
2851     GST_DEBUG_OBJECT (pad, "no parent element");
2852     return NULL;
2853   }
2854 }
2855
2856 /**
2857  * gst_pad_iterate_internal_links:
2858  * @pad: the GstPad to get the internal links of.
2859  *
2860  * Gets an iterator for the pads to which the given pad is linked to inside
2861  * of the parent element.
2862  *
2863  * Each #GstPad element yielded by the iterator will have its refcount increased,
2864  * so unref after use.
2865  *
2866  * Free-function: gst_iterator_free
2867  *
2868  * Returns: (transfer full) (nullable): a new #GstIterator of #GstPad
2869  *     or %NULL when the pad does not have an iterator function
2870  *     configured. Use gst_iterator_free() after usage.
2871  */
2872 GstIterator *
2873 gst_pad_iterate_internal_links (GstPad * pad)
2874 {
2875   GstIterator *res = NULL;
2876   GstObject *parent;
2877
2878   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2879
2880   GST_OBJECT_LOCK (pad);
2881   ACQUIRE_PARENT (pad, parent, no_parent);
2882   GST_OBJECT_UNLOCK (pad);
2883
2884   if (GST_PAD_ITERINTLINKFUNC (pad))
2885     res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2886
2887   RELEASE_PARENT (parent);
2888
2889   return res;
2890
2891   /* ERRORS */
2892 no_parent:
2893   {
2894     GST_DEBUG_OBJECT (pad, "no parent");
2895     GST_OBJECT_UNLOCK (pad);
2896     return NULL;
2897   }
2898 }
2899
2900 /**
2901  * gst_pad_forward:
2902  * @pad: a #GstPad
2903  * @forward: (scope call): a #GstPadForwardFunction
2904  * @user_data: user data passed to @forward
2905  *
2906  * Calls @forward for all internally linked pads of @pad. This function deals with
2907  * dynamically changing internal pads and will make sure that the @forward
2908  * function is only called once for each pad.
2909  *
2910  * When @forward returns %TRUE, no further pads will be processed.
2911  *
2912  * Returns: %TRUE if one of the dispatcher functions returned %TRUE.
2913  */
2914 gboolean
2915 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2916     gpointer user_data)
2917 {
2918   gboolean result = FALSE;
2919   GstIterator *iter;
2920   gboolean done = FALSE;
2921   GValue item = { 0, };
2922   GList *pushed_pads = NULL;
2923
2924   iter = gst_pad_iterate_internal_links (pad);
2925
2926   if (!iter)
2927     goto no_iter;
2928
2929   while (!done) {
2930     switch (gst_iterator_next (iter, &item)) {
2931       case GST_ITERATOR_OK:
2932       {
2933         GstPad *intpad;
2934
2935         intpad = g_value_get_object (&item);
2936
2937         /* if already pushed, skip. FIXME, find something faster to tag pads */
2938         if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2939           g_value_reset (&item);
2940           break;
2941         }
2942
2943         GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2944             GST_DEBUG_PAD_NAME (intpad));
2945         done = result = forward (intpad, user_data);
2946
2947         pushed_pads = g_list_prepend (pushed_pads, intpad);
2948
2949         g_value_reset (&item);
2950         break;
2951       }
2952       case GST_ITERATOR_RESYNC:
2953         /* We don't reset the result here because we don't push the event
2954          * again on pads that got the event already and because we need
2955          * to consider the result of the previous pushes */
2956         gst_iterator_resync (iter);
2957         break;
2958       case GST_ITERATOR_ERROR:
2959         GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2960         done = TRUE;
2961         break;
2962       case GST_ITERATOR_DONE:
2963         done = TRUE;
2964         break;
2965     }
2966   }
2967   g_value_unset (&item);
2968   gst_iterator_free (iter);
2969
2970   g_list_free (pushed_pads);
2971
2972 no_iter:
2973   return result;
2974 }
2975
2976 typedef struct
2977 {
2978   GstEvent *event;
2979   gboolean result;
2980   gboolean dispatched;
2981 } EventData;
2982
2983 static gboolean
2984 event_forward_func (GstPad * pad, EventData * data)
2985 {
2986   /* for each pad we send to, we should ref the event; it's up
2987    * to downstream to unref again when handled. */
2988   GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2989       data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2990
2991   data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2992
2993   data->dispatched = TRUE;
2994
2995   /* don't stop */
2996   return FALSE;
2997 }
2998
2999 /**
3000  * gst_pad_event_default:
3001  * @pad: a #GstPad to call the default event handler on.
3002  * @parent: (allow-none): the parent of @pad or %NULL
3003  * @event: (transfer full): the #GstEvent to handle.
3004  *
3005  * Invokes the default event handler for the given pad.
3006  *
3007  * The EOS event will pause the task associated with @pad before it is forwarded
3008  * to all internally linked pads,
3009  *
3010  * The event is sent to all pads internally linked to @pad. This function
3011  * takes ownership of @event.
3012  *
3013  * Returns: %TRUE if the event was sent successfully.
3014  */
3015 gboolean
3016 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
3017 {
3018   gboolean result, forward = TRUE;
3019
3020   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3021   g_return_val_if_fail (event != NULL, FALSE);
3022
3023   GST_LOG_OBJECT (pad, "default event handler for event %" GST_PTR_FORMAT,
3024       event);
3025
3026   switch (GST_EVENT_TYPE (event)) {
3027     case GST_EVENT_CAPS:
3028       forward = GST_PAD_IS_PROXY_CAPS (pad);
3029       result = TRUE;
3030       break;
3031     default:
3032       break;
3033   }
3034
3035   if (forward) {
3036     EventData data;
3037
3038     data.event = event;
3039     data.dispatched = FALSE;
3040     data.result = FALSE;
3041
3042     gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
3043
3044     /* for sinkpads without a parent element or without internal links, nothing
3045      * will be dispatched but we still want to return TRUE. */
3046     if (data.dispatched)
3047       result = data.result;
3048     else
3049       result = TRUE;
3050   }
3051
3052   gst_event_unref (event);
3053
3054   return result;
3055 }
3056
3057 /* Default accept caps implementation just checks against
3058  * the allowed caps for the pad */
3059 static gboolean
3060 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
3061 {
3062   /* get the caps and see if it intersects to something not empty */
3063   GstCaps *caps, *allowed = NULL;
3064   gboolean result;
3065
3066   GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
3067
3068   /* first forward the query to internally linked pads when we are dealing with
3069    * a PROXY CAPS */
3070   if (GST_PAD_IS_PROXY_CAPS (pad)) {
3071     result = gst_pad_proxy_query_accept_caps (pad, query);
3072     if (result)
3073       allowed = gst_pad_get_pad_template_caps (pad);
3074     else
3075       goto done;
3076   }
3077
3078   gst_query_parse_accept_caps (query, &caps);
3079   if (!allowed) {
3080     GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
3081         "fallback ACCEPT_CAPS query, consider implementing a specialized version");
3082     if (GST_PAD_IS_ACCEPT_TEMPLATE (pad))
3083       allowed = gst_pad_get_pad_template_caps (pad);
3084     else
3085       allowed = gst_pad_query_caps (pad, caps);
3086   }
3087
3088   if (allowed) {
3089     if (GST_PAD_IS_ACCEPT_INTERSECT (pad)) {
3090       GST_DEBUG_OBJECT (pad,
3091           "allowed caps intersect %" GST_PTR_FORMAT ", caps %" GST_PTR_FORMAT,
3092           allowed, caps);
3093       result = gst_caps_can_intersect (caps, allowed);
3094     } else {
3095       GST_DEBUG_OBJECT (pad, "allowed caps subset %" GST_PTR_FORMAT ", caps %"
3096           GST_PTR_FORMAT, allowed, caps);
3097       result = gst_caps_is_subset (caps, allowed);
3098     }
3099     gst_caps_unref (allowed);
3100   } else {
3101     GST_DEBUG_OBJECT (pad, "no compatible caps allowed on the pad");
3102     result = FALSE;
3103   }
3104   gst_query_set_accept_caps_result (query, result);
3105
3106 done:
3107   return TRUE;
3108 }
3109
3110 /* Default caps implementation */
3111 static gboolean
3112 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
3113 {
3114   GstCaps *result = NULL, *filter;
3115   GstPadTemplate *templ;
3116   gboolean fixed_caps;
3117
3118   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "query caps %" GST_PTR_FORMAT,
3119       query);
3120
3121   /* first try to proxy if we must */
3122   if (GST_PAD_IS_PROXY_CAPS (pad)) {
3123     if ((gst_pad_proxy_query_caps (pad, query))) {
3124       goto done;
3125     }
3126   }
3127
3128   gst_query_parse_caps (query, &filter);
3129
3130   /* no proxy or it failed, do default handling */
3131   fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
3132
3133   GST_OBJECT_LOCK (pad);
3134   if (fixed_caps) {
3135     /* fixed caps, try the negotiated caps first */
3136     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
3137     if ((result = get_pad_caps (pad)))
3138       goto filter_done_unlock;
3139   }
3140
3141   if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
3142     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
3143     if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
3144       goto filter_done_unlock;
3145   }
3146
3147   if (!fixed_caps) {
3148     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3149         "non-fixed pad caps: trying pad caps");
3150     /* non fixed caps, try the negotiated caps */
3151     if ((result = get_pad_caps (pad)))
3152       goto filter_done_unlock;
3153   }
3154
3155   /* this almost never happens */
3156   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
3157   result = GST_CAPS_ANY;
3158
3159 filter_done_unlock:
3160   GST_OBJECT_UNLOCK (pad);
3161
3162   /* run the filter on the result */
3163   if (filter) {
3164     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3165         "using caps %p %" GST_PTR_FORMAT " with filter %p %"
3166         GST_PTR_FORMAT, result, result, filter, filter);
3167     result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
3168     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
3169         result, result);
3170   } else {
3171     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3172         "using caps %p %" GST_PTR_FORMAT, result, result);
3173     result = gst_caps_ref (result);
3174   }
3175   gst_query_set_caps_result (query, result);
3176   gst_caps_unref (result);
3177
3178 done:
3179   return TRUE;
3180 }
3181
3182 /* Default latency implementation */
3183 typedef struct
3184 {
3185   guint count;
3186   gboolean live;
3187   GstClockTime min, max;
3188 } LatencyFoldData;
3189
3190 static gboolean
3191 query_latency_default_fold (const GValue * item, GValue * ret,
3192     gpointer user_data)
3193 {
3194   GstPad *pad = g_value_get_object (item), *peer;
3195   LatencyFoldData *fold_data = user_data;
3196   GstQuery *query;
3197   gboolean res = FALSE;
3198
3199   query = gst_query_new_latency ();
3200
3201   peer = gst_pad_get_peer (pad);
3202   if (peer) {
3203     res = gst_pad_peer_query (pad, query);
3204   } else {
3205     GST_LOG_OBJECT (pad, "No peer pad found, ignoring this pad");
3206   }
3207
3208   if (res) {
3209     gboolean live;
3210     GstClockTime min, max;
3211
3212     gst_query_parse_latency (query, &live, &min, &max);
3213
3214     GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3215         " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
3216
3217     /* FIXME : Why do we only take values into account if it's live ? */
3218     if (live || fold_data->count == 0) {
3219       if (min > fold_data->min)
3220         fold_data->min = min;
3221
3222       if (fold_data->max == GST_CLOCK_TIME_NONE)
3223         fold_data->max = max;
3224       else if (max < fold_data->max)
3225         fold_data->max = max;
3226
3227       fold_data->live = live;
3228     }
3229     fold_data->count += 1;
3230   } else if (peer) {
3231     GST_DEBUG_OBJECT (pad, "latency query failed");
3232     g_value_set_boolean (ret, FALSE);
3233   }
3234
3235   gst_query_unref (query);
3236   if (peer)
3237     gst_object_unref (peer);
3238
3239   return TRUE;
3240 }
3241
3242 static gboolean
3243 gst_pad_query_latency_default (GstPad * pad, GstQuery * query)
3244 {
3245   GstIterator *it;
3246   GstIteratorResult res;
3247   GValue ret = G_VALUE_INIT;
3248   gboolean query_ret;
3249   LatencyFoldData fold_data;
3250
3251   it = gst_pad_iterate_internal_links (pad);
3252   if (!it) {
3253     GST_DEBUG_OBJECT (pad, "Can't iterate internal links");
3254     return FALSE;
3255   }
3256
3257   g_value_init (&ret, G_TYPE_BOOLEAN);
3258
3259 retry:
3260   fold_data.count = 0;
3261   fold_data.live = FALSE;
3262   fold_data.min = 0;
3263   fold_data.max = GST_CLOCK_TIME_NONE;
3264
3265   g_value_set_boolean (&ret, TRUE);
3266   res = gst_iterator_fold (it, query_latency_default_fold, &ret, &fold_data);
3267   switch (res) {
3268     case GST_ITERATOR_OK:
3269       g_assert_not_reached ();
3270       break;
3271     case GST_ITERATOR_DONE:
3272       break;
3273     case GST_ITERATOR_ERROR:
3274       g_value_set_boolean (&ret, FALSE);
3275       break;
3276     case GST_ITERATOR_RESYNC:
3277       gst_iterator_resync (it);
3278       goto retry;
3279     default:
3280       g_assert_not_reached ();
3281       break;
3282   }
3283   gst_iterator_free (it);
3284
3285   query_ret = g_value_get_boolean (&ret);
3286   if (query_ret) {
3287     GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3288         " max:%" G_GINT64_FORMAT, fold_data.live ? "true" : "false",
3289         fold_data.min, fold_data.max);
3290
3291     if (fold_data.min > fold_data.max) {
3292       GST_ERROR_OBJECT (pad, "minimum latency bigger than maximum latency");
3293     }
3294
3295     gst_query_set_latency (query, fold_data.live, fold_data.min, fold_data.max);
3296   } else {
3297     GST_LOG_OBJECT (pad, "latency query failed");
3298   }
3299
3300   return query_ret;
3301 }
3302
3303 typedef struct
3304 {
3305   GstQuery *query;
3306   gboolean result;
3307   gboolean dispatched;
3308 } QueryData;
3309
3310 static gboolean
3311 query_forward_func (GstPad * pad, QueryData * data)
3312 {
3313   GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
3314       data->query, GST_QUERY_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
3315
3316   data->result |= gst_pad_peer_query (pad, data->query);
3317
3318   data->dispatched = TRUE;
3319
3320   /* stop on first successful reply */
3321   return data->result;
3322 }
3323
3324 /**
3325  * gst_pad_query_default:
3326  * @pad: a #GstPad to call the default query handler on.
3327  * @parent: (allow-none): the parent of @pad or %NULL
3328  * @query: (transfer none): the #GstQuery to handle.
3329  *
3330  * Invokes the default query handler for the given pad.
3331  * The query is sent to all pads internally linked to @pad. Note that
3332  * if there are many possible sink pads that are internally linked to
3333  * @pad, only one will be sent the query.
3334  * Multi-sinkpad elements should implement custom query handlers.
3335  *
3336  * Returns: %TRUE if the query was performed successfully.
3337  */
3338 gboolean
3339 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
3340 {
3341   gboolean forward, ret = FALSE;
3342
3343   switch (GST_QUERY_TYPE (query)) {
3344     case GST_QUERY_SCHEDULING:
3345       forward = GST_PAD_IS_PROXY_SCHEDULING (pad);
3346       break;
3347     case GST_QUERY_ALLOCATION:
3348       forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
3349       break;
3350     case GST_QUERY_ACCEPT_CAPS:
3351       ret = gst_pad_query_accept_caps_default (pad, query);
3352       forward = FALSE;
3353       break;
3354     case GST_QUERY_CAPS:
3355       ret = gst_pad_query_caps_default (pad, query);
3356       forward = FALSE;
3357       break;
3358     case GST_QUERY_LATENCY:
3359       ret = gst_pad_query_latency_default (pad, query);
3360       forward = FALSE;
3361       break;
3362     case GST_QUERY_POSITION:
3363     case GST_QUERY_SEEKING:
3364     case GST_QUERY_FORMATS:
3365     case GST_QUERY_JITTER:
3366     case GST_QUERY_RATE:
3367     case GST_QUERY_CONVERT:
3368     default:
3369       forward = TRUE;
3370       break;
3371   }
3372
3373   GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
3374       query, GST_QUERY_TYPE_NAME (query));
3375
3376   if (forward) {
3377     QueryData data;
3378
3379     data.query = query;
3380     data.dispatched = FALSE;
3381     data.result = FALSE;
3382
3383     gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
3384
3385     if (data.dispatched) {
3386       ret = data.result;
3387     } else {
3388       /* nothing dispatched, assume drained */
3389       if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
3390         ret = TRUE;
3391       else
3392         ret = FALSE;
3393     }
3394   }
3395   return ret;
3396 }
3397
3398 static void
3399 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
3400 {
3401   GstPad *pad = data->pad;
3402   GstPadProbeInfo *info = data->info;
3403   GstPadProbeType type, flags;
3404   GstPadProbeCallback callback;
3405   GstPadProbeReturn ret;
3406   gpointer original_data;
3407
3408   /* if we have called this callback, do nothing */
3409   if (PROBE_COOKIE (hook) == data->cookie) {
3410     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3411         "hook %lu, cookie %u already called", hook->hook_id,
3412         PROBE_COOKIE (hook));
3413     return;
3414   }
3415
3416   PROBE_COOKIE (hook) = data->cookie;
3417
3418   flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
3419   type = info->type;
3420   original_data = info->data;
3421
3422   /* one of the scheduling types */
3423   if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
3424     goto no_match;
3425
3426   if (type & GST_PAD_PROBE_TYPE_PUSH) {
3427     /* one of the data types for non-idle probes */
3428     if ((type & GST_PAD_PROBE_TYPE_IDLE) == 0
3429         && (flags & _PAD_PROBE_TYPE_ALL_BOTH_AND_FLUSH & type) == 0)
3430       goto no_match;
3431   } else if (type & GST_PAD_PROBE_TYPE_PULL) {
3432     /* one of the data types for non-idle probes */
3433     if ((type & GST_PAD_PROBE_TYPE_BLOCKING) == 0
3434         && (flags & _PAD_PROBE_TYPE_ALL_BOTH_AND_FLUSH & type) == 0)
3435       goto no_match;
3436   } else {
3437     /* Type must have PULL or PUSH probe types */
3438     g_assert_not_reached ();
3439   }
3440
3441   /* one of the blocking types must match */
3442   if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
3443       (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
3444     goto no_match;
3445   if ((type & GST_PAD_PROBE_TYPE_BLOCKING) == 0 &&
3446       (flags & GST_PAD_PROBE_TYPE_BLOCKING))
3447     goto no_match;
3448   /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
3449   if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
3450       (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
3451     goto no_match;
3452
3453   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3454       "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
3455       PROBE_COOKIE (hook), flags);
3456
3457   data->marshalled = TRUE;
3458
3459   callback = (GstPadProbeCallback) hook->func;
3460   if (callback == NULL)
3461     return;
3462
3463   info->id = hook->hook_id;
3464
3465   GST_OBJECT_UNLOCK (pad);
3466
3467   ret = callback (pad, info, hook->data);
3468
3469   GST_OBJECT_LOCK (pad);
3470
3471   if (original_data != NULL && info->data == NULL) {
3472     GST_DEBUG_OBJECT (pad, "data item in pad probe info was dropped");
3473     info->type = GST_PAD_PROBE_TYPE_INVALID;
3474     data->dropped = TRUE;
3475   }
3476
3477   switch (ret) {
3478     case GST_PAD_PROBE_REMOVE:
3479       /* remove the probe */
3480       GST_DEBUG_OBJECT (pad, "asked to remove hook");
3481       cleanup_hook (pad, hook);
3482       break;
3483     case GST_PAD_PROBE_DROP:
3484       /* need to drop the data, make sure other probes don't get called
3485        * anymore */
3486       GST_DEBUG_OBJECT (pad, "asked to drop item");
3487       info->type = GST_PAD_PROBE_TYPE_INVALID;
3488       data->dropped = TRUE;
3489       break;
3490     case GST_PAD_PROBE_HANDLED:
3491       GST_DEBUG_OBJECT (pad, "probe handled data");
3492       data->handled = TRUE;
3493       break;
3494     case GST_PAD_PROBE_PASS:
3495       /* inform the pad block to let things pass */
3496       GST_DEBUG_OBJECT (pad, "asked to pass item");
3497       data->pass = TRUE;
3498       break;
3499     case GST_PAD_PROBE_OK:
3500       GST_DEBUG_OBJECT (pad, "probe returned OK");
3501       break;
3502     default:
3503       GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
3504       break;
3505   }
3506   return;
3507
3508 no_match:
3509   {
3510     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3511         "hook %lu, cookie %u with flags 0x%08x does not match %08x",
3512         hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
3513     return;
3514   }
3515 }
3516
3517 /* a probe that does not take or return any data */
3518 #define PROBE_NO_DATA(pad,mask,label,defaultval)                \
3519   G_STMT_START {                                                \
3520     if (G_UNLIKELY (pad->num_probes)) {                         \
3521       GstFlowReturn pval = defaultval;                          \
3522       /* pass NULL as the data item */                          \
3523       GstPadProbeInfo info = { mask, 0, NULL, 0, 0 };           \
3524       info.ABI.abi.flow_ret = defaultval;                       \
3525       ret = do_probe_callbacks (pad, &info, defaultval);        \
3526       if (G_UNLIKELY (ret != pval && ret != GST_FLOW_OK))       \
3527         goto label;                                             \
3528     }                                                           \
3529   } G_STMT_END
3530
3531 #define PROBE_FULL(pad,mask,data,offs,size,label,handleable,handle_label) \
3532   G_STMT_START {                                                        \
3533     if (G_UNLIKELY (pad->num_probes)) {                                 \
3534       /* pass the data item */                                          \
3535       GstPadProbeInfo info = { mask, 0, data, offs, size };             \
3536       info.ABI.abi.flow_ret = GST_FLOW_OK;                              \
3537       ret = do_probe_callbacks (pad, &info, GST_FLOW_OK);               \
3538       /* store the possibly updated data item */                        \
3539       data = GST_PAD_PROBE_INFO_DATA (&info);                           \
3540       /* if something went wrong, exit */                               \
3541       if (G_UNLIKELY (ret != GST_FLOW_OK)) {                            \
3542         if (handleable && ret == GST_FLOW_CUSTOM_SUCCESS_1) {           \
3543           ret = info.ABI.abi.flow_ret;                                          \
3544           goto handle_label;                                            \
3545         }                                                               \
3546         goto label;                                                     \
3547       }                                                                 \
3548     }                                                                   \
3549   } G_STMT_END
3550
3551 #define PROBE_PUSH(pad,mask,data,label)         \
3552   PROBE_FULL(pad, mask, data, -1, -1, label, FALSE, label);
3553 #define PROBE_HANDLE(pad,mask,data,label,handle_label)  \
3554   PROBE_FULL(pad, mask, data, -1, -1, label, TRUE, handle_label);
3555 #define PROBE_PULL(pad,mask,data,offs,size,label)               \
3556   PROBE_FULL(pad, mask, data, offs, size, label, FALSE, label);
3557
3558 static GstFlowReturn
3559 do_pad_idle_probe_wait (GstPad * pad)
3560 {
3561   while (GST_PAD_IS_RUNNING_IDLE_PROBE (pad)) {
3562     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3563         "waiting idle probe to be removed");
3564     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3565     GST_PAD_BLOCK_WAIT (pad);
3566     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3567     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3568
3569     if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3570       return GST_FLOW_FLUSHING;
3571   }
3572   return GST_FLOW_OK;
3573 }
3574
3575 #define PROBE_TYPE_IS_SERIALIZED(i) \
3576     ( \
3577       ( \
3578         (((i)->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM | \
3579         GST_PAD_PROBE_TYPE_EVENT_FLUSH)) && \
3580         GST_EVENT_IS_SERIALIZED ((i)->data)) \
3581       ) || ( \
3582         (((i)->type & GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM) && \
3583         GST_QUERY_IS_SERIALIZED ((i)->data)) \
3584       ) || ( \
3585         ((i)->type & (GST_PAD_PROBE_TYPE_BUFFER | \
3586         GST_PAD_PROBE_TYPE_BUFFER_LIST))  \
3587       ) \
3588     )
3589
3590 static GstFlowReturn
3591 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3592     GstFlowReturn defaultval)
3593 {
3594   ProbeMarshall data;
3595   guint cookie;
3596   gboolean is_block;
3597
3598   data.pad = pad;
3599   data.info = info;
3600   data.pass = FALSE;
3601   data.handled = FALSE;
3602   data.marshalled = FALSE;
3603   data.dropped = FALSE;
3604   data.cookie = ++pad->priv->probe_cookie;
3605
3606   is_block =
3607       (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3608
3609   if (is_block && PROBE_TYPE_IS_SERIALIZED (info)) {
3610     if (do_pad_idle_probe_wait (pad) == GST_FLOW_FLUSHING)
3611       goto flushing;
3612   }
3613
3614 again:
3615   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3616       "do probes cookie %u", data.cookie);
3617   cookie = pad->priv->probe_list_cookie;
3618
3619   g_hook_list_marshal (&pad->probes, TRUE,
3620       (GHookMarshaller) probe_hook_marshal, &data);
3621
3622   /* if the list changed, call the new callbacks (they will not have their
3623    * cookie set to data.cookie */
3624   if (cookie != pad->priv->probe_list_cookie) {
3625     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3626         "probe list changed, restarting");
3627     goto again;
3628   }
3629
3630   /* the first item that dropped will stop the hooks and then we drop here */
3631   if (data.dropped)
3632     goto dropped;
3633
3634   /* If one handler took care of it, let the the item pass */
3635   if (data.handled) {
3636     goto handled;
3637   }
3638
3639   /* if no handler matched and we are blocking, let the item pass */
3640   if (!data.marshalled && is_block)
3641     goto passed;
3642
3643   /* At this point, all handlers returned either OK or PASS. If one handler
3644    * returned PASS, let the item pass */
3645   if (data.pass)
3646     goto passed;
3647
3648   if (is_block) {
3649     while (GST_PAD_IS_BLOCKED (pad)) {
3650       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3651           "we are blocked %d times", pad->num_blocked);
3652
3653       /* we might have released the lock */
3654       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3655         goto flushing;
3656
3657       /* now we block the streaming thread. It can be unlocked when we
3658        * deactivate the pad (which will also set the FLUSHING flag) or
3659        * when the pad is unblocked. A flushing event will also unblock
3660        * the pad after setting the FLUSHING flag. */
3661       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3662           "Waiting to be unblocked or set flushing");
3663       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3664       GST_PAD_BLOCK_WAIT (pad);
3665       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3666       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3667
3668       /* if the list changed, call the new callbacks (they will not have their
3669        * cookie set to data.cookie */
3670       if (cookie != pad->priv->probe_list_cookie) {
3671         GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3672             "probe list changed, restarting");
3673         goto again;
3674       }
3675
3676       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3677         goto flushing;
3678     }
3679   }
3680
3681   return defaultval;
3682
3683   /* ERRORS */
3684 flushing:
3685   {
3686     GST_DEBUG_OBJECT (pad, "pad is flushing");
3687     return GST_FLOW_FLUSHING;
3688   }
3689 dropped:
3690   {
3691     GST_DEBUG_OBJECT (pad, "data is dropped");
3692     return GST_FLOW_CUSTOM_SUCCESS;
3693   }
3694 passed:
3695   {
3696     /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3697     GST_DEBUG_OBJECT (pad, "data is passed");
3698     return GST_FLOW_OK;
3699   }
3700 handled:
3701   {
3702     GST_DEBUG_OBJECT (pad, "data was handled");
3703     return GST_FLOW_CUSTOM_SUCCESS_1;
3704   }
3705 }
3706
3707 /* pad offsets */
3708
3709 /**
3710  * gst_pad_get_offset:
3711  * @pad: a #GstPad
3712  *
3713  * Get the offset applied to the running time of @pad. @pad has to be a source
3714  * pad.
3715  *
3716  * Returns: the offset.
3717  */
3718 gint64
3719 gst_pad_get_offset (GstPad * pad)
3720 {
3721   gint64 result;
3722
3723   g_return_val_if_fail (GST_IS_PAD (pad), 0);
3724
3725   GST_OBJECT_LOCK (pad);
3726   result = pad->offset;
3727   GST_OBJECT_UNLOCK (pad);
3728
3729   return result;
3730 }
3731
3732 static gboolean
3733 mark_event_not_received (GstPad * pad, PadEvent * ev, gpointer user_data)
3734 {
3735   ev->received = FALSE;
3736   return TRUE;
3737 }
3738
3739 /**
3740  * gst_pad_set_offset:
3741  * @pad: a #GstPad
3742  * @offset: the offset
3743  *
3744  * Set the offset that will be applied to the running time of @pad.
3745  */
3746 void
3747 gst_pad_set_offset (GstPad * pad, gint64 offset)
3748 {
3749   g_return_if_fail (GST_IS_PAD (pad));
3750
3751   GST_OBJECT_LOCK (pad);
3752   /* if nothing changed, do nothing */
3753   if (pad->offset == offset)
3754     goto done;
3755
3756   pad->offset = offset;
3757   GST_DEBUG_OBJECT (pad, "changed offset to %" GST_STIME_FORMAT,
3758       GST_STIME_ARGS (offset));
3759
3760   /* resend all sticky events with updated offset on next buffer push */
3761   events_foreach (pad, mark_event_not_received, NULL);
3762   GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3763
3764 done:
3765   GST_OBJECT_UNLOCK (pad);
3766 }
3767
3768 typedef struct
3769 {
3770   GstFlowReturn ret;
3771
3772   /* If TRUE and ret is not OK this means
3773    * that pushing the EOS event failed
3774    */
3775   gboolean was_eos;
3776
3777   /* If called for an event this is
3778    * the event that would be pushed
3779    * next. Don't forward sticky events
3780    * that would come after that */
3781   GstEvent *event;
3782 } PushStickyData;
3783
3784 /* should be called with pad LOCK */
3785 static gboolean
3786 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3787 {
3788   PushStickyData *data = user_data;
3789   GstEvent *event = ev->event;
3790
3791   if (ev->received) {
3792     GST_DEBUG_OBJECT (pad, "event %s was already received",
3793         GST_EVENT_TYPE_NAME (event));
3794     return TRUE;
3795   }
3796
3797   /* If we're called because of an sticky event, only forward
3798    * events that would come before this new event and the
3799    * event itself */
3800   if (data->event && GST_EVENT_IS_STICKY (data->event) &&
3801       GST_EVENT_TYPE (data->event) <= GST_EVENT_SEGMENT &&
3802       GST_EVENT_TYPE (data->event) < GST_EVENT_TYPE (event)) {
3803     data->ret = GST_FLOW_CUSTOM_SUCCESS_1;
3804   } else {
3805     data->ret = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3806         GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3807   }
3808
3809   switch (data->ret) {
3810     case GST_FLOW_OK:
3811       ev->received = TRUE;
3812       GST_DEBUG_OBJECT (pad, "event %s marked received",
3813           GST_EVENT_TYPE_NAME (event));
3814       break;
3815     case GST_FLOW_CUSTOM_SUCCESS:
3816       /* we can't assume the event is received when it was dropped */
3817       GST_DEBUG_OBJECT (pad, "event %s was dropped, mark pending",
3818           GST_EVENT_TYPE_NAME (event));
3819       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3820       data->ret = GST_FLOW_OK;
3821       break;
3822     case GST_FLOW_CUSTOM_SUCCESS_1:
3823       /* event was ignored and should be sent later */
3824       GST_DEBUG_OBJECT (pad, "event %s was ignored, mark pending",
3825           GST_EVENT_TYPE_NAME (event));
3826       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3827       data->ret = GST_FLOW_OK;
3828       break;
3829     case GST_FLOW_NOT_LINKED:
3830       /* not linked is not a problem, we are sticky so the event will be
3831        * rescheduled to be sent later on re-link, but only for non-EOS events */
3832       GST_DEBUG_OBJECT (pad, "pad was not linked, mark pending");
3833       if (GST_EVENT_TYPE (event) != GST_EVENT_EOS) {
3834         data->ret = GST_FLOW_OK;
3835         ev->received = TRUE;
3836       }
3837       break;
3838     default:
3839       GST_DEBUG_OBJECT (pad, "result %s, mark pending events",
3840           gst_flow_get_name (data->ret));
3841       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3842       break;
3843   }
3844
3845   if (data->ret != GST_FLOW_OK && GST_EVENT_TYPE (event) == GST_EVENT_EOS)
3846     data->was_eos = TRUE;
3847
3848   return data->ret == GST_FLOW_OK;
3849 }
3850
3851 /* check sticky events and push them when needed. should be called
3852  * with pad LOCK */
3853 static inline GstFlowReturn
3854 check_sticky (GstPad * pad, GstEvent * event)
3855 {
3856   PushStickyData data = { GST_FLOW_OK, FALSE, event };
3857
3858   if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3859     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3860
3861     GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3862     events_foreach (pad, push_sticky, &data);
3863
3864     /* If there's an EOS event we must push it downstream
3865      * even if sending a previous sticky event failed.
3866      * Otherwise the pipeline might wait forever for EOS.
3867      *
3868      * Only do this if pushing another event than the EOS
3869      * event failed.
3870      */
3871     if (data.ret != GST_FLOW_OK && !data.was_eos) {
3872       PadEvent *ev = find_event_by_type (pad, GST_EVENT_EOS, 0);
3873
3874       if (ev && !ev->received) {
3875         data.ret = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3876             GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3877         /* the event could have been dropped. Because this can only
3878          * happen if the user asked for it, it's not an error */
3879         if (data.ret == GST_FLOW_CUSTOM_SUCCESS)
3880           data.ret = GST_FLOW_OK;
3881       }
3882     }
3883   }
3884   return data.ret;
3885 }
3886
3887
3888 /**
3889  * gst_pad_query:
3890  * @pad: a #GstPad to invoke the default query on.
3891  * @query: (transfer none): the #GstQuery to perform.
3892  *
3893  * Dispatches a query to a pad. The query should have been allocated by the
3894  * caller via one of the type-specific allocation functions. The element that
3895  * the pad belongs to is responsible for filling the query with an appropriate
3896  * response, which should then be parsed with a type-specific query parsing
3897  * function.
3898  *
3899  * Again, the caller is responsible for both the allocation and deallocation of
3900  * the query structure.
3901  *
3902  * Please also note that some queries might need a running pipeline to work.
3903  *
3904  * Returns: %TRUE if the query could be performed.
3905  */
3906 gboolean
3907 gst_pad_query (GstPad * pad, GstQuery * query)
3908 {
3909   GstObject *parent;
3910   gboolean res, serialized;
3911   GstPadQueryFunction func;
3912   GstPadProbeType type;
3913   GstFlowReturn ret;
3914
3915   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3916   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3917
3918   if (GST_PAD_IS_SRC (pad)) {
3919     if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3920       goto wrong_direction;
3921     type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3922   } else if (GST_PAD_IS_SINK (pad)) {
3923     if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3924       goto wrong_direction;
3925     type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3926   } else
3927     goto unknown_direction;
3928
3929   GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3930       GST_QUERY_TYPE_NAME (query));
3931   GST_TRACER_PAD_QUERY_PRE (pad, query);
3932
3933   serialized = GST_QUERY_IS_SERIALIZED (query);
3934   if (G_UNLIKELY (serialized))
3935     GST_PAD_STREAM_LOCK (pad);
3936
3937   GST_OBJECT_LOCK (pad);
3938   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3939       GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3940   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3941
3942   ACQUIRE_PARENT (pad, parent, no_parent);
3943   GST_OBJECT_UNLOCK (pad);
3944
3945   if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3946     goto no_func;
3947
3948   res = func (pad, parent, query);
3949
3950   RELEASE_PARENT (parent);
3951
3952   GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3953       GST_QUERY_TYPE_NAME (query), res);
3954   GST_TRACER_PAD_QUERY_POST (pad, query, res);
3955
3956   if (res != TRUE)
3957     goto query_failed;
3958
3959   GST_OBJECT_LOCK (pad);
3960   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3961   GST_OBJECT_UNLOCK (pad);
3962
3963   if (G_UNLIKELY (serialized))
3964     GST_PAD_STREAM_UNLOCK (pad);
3965
3966   return res;
3967
3968   /* ERRORS */
3969 wrong_direction:
3970   {
3971     g_warning ("pad %s:%s query %s in wrong direction",
3972         GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3973     return FALSE;
3974   }
3975 unknown_direction:
3976   {
3977     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3978     return FALSE;
3979   }
3980 no_parent:
3981   {
3982     GST_DEBUG_OBJECT (pad, "had no parent");
3983     GST_OBJECT_UNLOCK (pad);
3984     if (G_UNLIKELY (serialized))
3985       GST_PAD_STREAM_UNLOCK (pad);
3986     return FALSE;
3987   }
3988 no_func:
3989   {
3990     GST_DEBUG_OBJECT (pad, "had no query function");
3991     RELEASE_PARENT (parent);
3992     if (G_UNLIKELY (serialized))
3993       GST_PAD_STREAM_UNLOCK (pad);
3994     return FALSE;
3995   }
3996 query_failed:
3997   {
3998     GST_DEBUG_OBJECT (pad, "query failed");
3999     if (G_UNLIKELY (serialized))
4000       GST_PAD_STREAM_UNLOCK (pad);
4001     return FALSE;
4002   }
4003 probe_stopped:
4004   {
4005     GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
4006     GST_OBJECT_UNLOCK (pad);
4007     if (G_UNLIKELY (serialized))
4008       GST_PAD_STREAM_UNLOCK (pad);
4009
4010     /* if a probe dropped without handling, we don't sent it further but assume
4011      * that the probe did not answer the query and return FALSE */
4012     if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
4013       res = FALSE;
4014     else
4015       res = TRUE;
4016
4017     return res;
4018   }
4019 }
4020
4021 /**
4022  * gst_pad_peer_query:
4023  * @pad: a #GstPad to invoke the peer query on.
4024  * @query: (transfer none): the #GstQuery to perform.
4025  *
4026  * Performs gst_pad_query() on the peer of @pad.
4027  *
4028  * The caller is responsible for both the allocation and deallocation of
4029  * the query structure.
4030  *
4031  * Returns: %TRUE if the query could be performed. This function returns %FALSE
4032  * if @pad has no peer.
4033  */
4034 gboolean
4035 gst_pad_peer_query (GstPad * pad, GstQuery * query)
4036 {
4037   GstPad *peerpad;
4038   GstPadProbeType type;
4039   gboolean res, serialized;
4040   GstFlowReturn ret;
4041
4042   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4043   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
4044
4045   if (GST_PAD_IS_SRC (pad)) {
4046     if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
4047       goto wrong_direction;
4048     type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
4049   } else if (GST_PAD_IS_SINK (pad)) {
4050     if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
4051       goto wrong_direction;
4052     type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
4053   } else
4054     goto unknown_direction;
4055
4056   GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
4057       GST_QUERY_TYPE_NAME (query));
4058
4059   serialized = GST_QUERY_IS_SERIALIZED (query);
4060
4061   GST_OBJECT_LOCK (pad);
4062   if (GST_PAD_IS_SRC (pad) && serialized) {
4063     /* all serialized queries on the srcpad trigger push of
4064      * sticky events */
4065     if (check_sticky (pad, NULL) != GST_FLOW_OK)
4066       goto sticky_failed;
4067   }
4068
4069   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4070       GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
4071   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
4072
4073   peerpad = GST_PAD_PEER (pad);
4074   if (G_UNLIKELY (peerpad == NULL))
4075     goto no_peer;
4076
4077   gst_object_ref (peerpad);
4078   GST_OBJECT_UNLOCK (pad);
4079
4080   res = gst_pad_query (peerpad, query);
4081
4082   gst_object_unref (peerpad);
4083
4084   if (res != TRUE)
4085     goto query_failed;
4086
4087   GST_OBJECT_LOCK (pad);
4088   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
4089   GST_OBJECT_UNLOCK (pad);
4090
4091   return res;
4092
4093   /* ERRORS */
4094 wrong_direction:
4095   {
4096     g_warning ("pad %s:%s query %s in wrong direction",
4097         GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
4098     return FALSE;
4099   }
4100 unknown_direction:
4101   {
4102     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4103     return FALSE;
4104   }
4105 sticky_failed:
4106   {
4107     GST_WARNING_OBJECT (pad, "could not send sticky events");
4108     GST_OBJECT_UNLOCK (pad);
4109     return FALSE;
4110   }
4111 no_peer:
4112   {
4113     GST_INFO_OBJECT (pad, "pad has no peer");
4114     GST_OBJECT_UNLOCK (pad);
4115     return FALSE;
4116   }
4117 query_failed:
4118   {
4119     GST_DEBUG_OBJECT (pad, "query failed");
4120     return FALSE;
4121   }
4122 probe_stopped:
4123   {
4124     GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
4125     GST_OBJECT_UNLOCK (pad);
4126
4127     /* if a probe dropped without handling, we don't sent it further but
4128      * assume that the probe did not answer the query and return FALSE */
4129     if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
4130       res = FALSE;
4131     else
4132       res = TRUE;
4133
4134     return res;
4135   }
4136 }
4137
4138 /**********************************************************************
4139  * Data passing functions
4140  */
4141
4142 /* this is the chain function that does not perform the additional argument
4143  * checking for that little extra speed.
4144  */
4145 static inline GstFlowReturn
4146 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
4147 {
4148   GstFlowReturn ret;
4149   GstObject *parent;
4150   gboolean handled = FALSE;
4151
4152   GST_PAD_STREAM_LOCK (pad);
4153
4154   GST_OBJECT_LOCK (pad);
4155   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4156     goto flushing;
4157
4158   if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4159     goto eos;
4160
4161   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4162     goto wrong_mode;
4163
4164 #ifdef GST_ENABLE_EXTRA_CHECKS
4165   if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4166     if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4167       g_warning (G_STRLOC
4168           ":%s:<%s:%s> Got data flow before stream-start event",
4169           G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4170     }
4171     if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4172       g_warning (G_STRLOC
4173           ":%s:<%s:%s> Got data flow before segment event",
4174           G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4175     }
4176     pad->priv->last_cookie = pad->priv->events_cookie;
4177   }
4178 #endif
4179
4180   PROBE_HANDLE (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped,
4181       probe_handled);
4182
4183   PROBE_HANDLE (pad, type, data, probe_stopped, probe_handled);
4184
4185   ACQUIRE_PARENT (pad, parent, no_parent);
4186   GST_OBJECT_UNLOCK (pad);
4187
4188   /* NOTE: we read the chainfunc unlocked.
4189    * we cannot hold the lock for the pad so we might send
4190    * the data to the wrong function. This is not really a
4191    * problem since functions are assigned at creation time
4192    * and don't change that often... */
4193   if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
4194     GstPadChainFunction chainfunc;
4195
4196     if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
4197       goto no_function;
4198
4199     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4200         "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
4201         GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
4202
4203     ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
4204
4205     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4206         "called chainfunction &%s with buffer %p, returned %s",
4207         GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
4208   } else {
4209     GstPadChainListFunction chainlistfunc;
4210
4211     if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
4212       goto no_function;
4213
4214     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4215         "calling chainlistfunction &%s",
4216         GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
4217
4218     ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
4219
4220     GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4221         "called chainlistfunction &%s, returned %s",
4222         GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
4223   }
4224
4225   RELEASE_PARENT (parent);
4226
4227   GST_PAD_STREAM_UNLOCK (pad);
4228
4229   return ret;
4230
4231   /* ERRORS */
4232 flushing:
4233   {
4234     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4235         "chaining, but pad was flushing");
4236     GST_OBJECT_UNLOCK (pad);
4237     GST_PAD_STREAM_UNLOCK (pad);
4238     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4239     return GST_FLOW_FLUSHING;
4240   }
4241 eos:
4242   {
4243     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "chaining, but pad was EOS");
4244     GST_OBJECT_UNLOCK (pad);
4245     GST_PAD_STREAM_UNLOCK (pad);
4246     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4247     return GST_FLOW_EOS;
4248   }
4249 wrong_mode:
4250   {
4251     g_critical ("chain on pad %s:%s but it was not in push mode",
4252         GST_DEBUG_PAD_NAME (pad));
4253     GST_OBJECT_UNLOCK (pad);
4254     GST_PAD_STREAM_UNLOCK (pad);
4255     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4256     return GST_FLOW_ERROR;
4257   }
4258 probe_handled:
4259   handled = TRUE;
4260   /* PASSTHROUGH */
4261 probe_stopped:
4262   {
4263     GST_OBJECT_UNLOCK (pad);
4264     GST_PAD_STREAM_UNLOCK (pad);
4265     /* We unref the buffer, except if the probe handled it (CUSTOM_SUCCESS_1) */
4266     if (!handled)
4267       gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4268
4269     switch (ret) {
4270       case GST_FLOW_CUSTOM_SUCCESS:
4271       case GST_FLOW_CUSTOM_SUCCESS_1:
4272         GST_DEBUG_OBJECT (pad, "dropped or handled buffer");
4273         ret = GST_FLOW_OK;
4274         break;
4275       default:
4276         GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4277         break;
4278     }
4279     return ret;
4280   }
4281 no_parent:
4282   {
4283     GST_DEBUG_OBJECT (pad, "No parent when chaining %" GST_PTR_FORMAT, data);
4284     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4285     GST_OBJECT_UNLOCK (pad);
4286     GST_PAD_STREAM_UNLOCK (pad);
4287     return GST_FLOW_FLUSHING;
4288   }
4289 no_function:
4290   {
4291     RELEASE_PARENT (parent);
4292     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4293     g_critical ("chain on pad %s:%s but it has no chainfunction",
4294         GST_DEBUG_PAD_NAME (pad));
4295     GST_PAD_STREAM_UNLOCK (pad);
4296     return GST_FLOW_NOT_SUPPORTED;
4297   }
4298 }
4299
4300 /**
4301  * gst_pad_chain:
4302  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4303  * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
4304  *     if not.
4305  *
4306  * Chain a buffer to @pad.
4307  *
4308  * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4309  *
4310  * If the buffer type is not acceptable for @pad (as negotiated with a
4311  * preceding GST_EVENT_CAPS event), this function returns
4312  * #GST_FLOW_NOT_NEGOTIATED.
4313  *
4314  * The function proceeds calling the chain function installed on @pad (see
4315  * gst_pad_set_chain_function()) and the return value of that function is
4316  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4317  * chain function.
4318  *
4319  * In all cases, success or failure, the caller loses its reference to @buffer
4320  * after calling this function.
4321  *
4322  * Returns: a #GstFlowReturn from the pad.
4323  *
4324  * MT safe.
4325  */
4326 GstFlowReturn
4327 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
4328 {
4329   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4330   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4331   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4332
4333   return gst_pad_chain_data_unchecked (pad,
4334       GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4335 }
4336
4337 static GstFlowReturn
4338 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
4339     GstBufferList * list)
4340 {
4341   guint i, len;
4342   GstBuffer *buffer;
4343   GstFlowReturn ret;
4344
4345   GST_INFO_OBJECT (pad, "chaining each buffer in list individually");
4346
4347   len = gst_buffer_list_length (list);
4348
4349   ret = GST_FLOW_OK;
4350   for (i = 0; i < len; i++) {
4351     buffer = gst_buffer_list_get (list, i);
4352     ret =
4353         gst_pad_chain_data_unchecked (pad,
4354         GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
4355         gst_buffer_ref (buffer));
4356     if (ret != GST_FLOW_OK)
4357       break;
4358   }
4359   gst_buffer_list_unref (list);
4360
4361   return ret;
4362 }
4363
4364 /**
4365  * gst_pad_chain_list:
4366  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4367  * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
4368  *     if not.
4369  *
4370  * Chain a bufferlist to @pad.
4371  *
4372  * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4373  *
4374  * If @pad was not negotiated properly with a CAPS event, this function
4375  * returns #GST_FLOW_NOT_NEGOTIATED.
4376  *
4377  * The function proceeds calling the chainlist function installed on @pad (see
4378  * gst_pad_set_chain_list_function()) and the return value of that function is
4379  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4380  * chainlist function.
4381  *
4382  * In all cases, success or failure, the caller loses its reference to @list
4383  * after calling this function.
4384  *
4385  * MT safe.
4386  *
4387  * Returns: a #GstFlowReturn from the pad.
4388  */
4389 GstFlowReturn
4390 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
4391 {
4392   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4393   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4394   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4395
4396   return gst_pad_chain_data_unchecked (pad,
4397       GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4398 }
4399
4400 static GstFlowReturn
4401 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
4402 {
4403   GstPad *peer;
4404   GstFlowReturn ret;
4405   gboolean handled = FALSE;
4406
4407   GST_OBJECT_LOCK (pad);
4408   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4409     goto flushing;
4410
4411   if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4412     goto eos;
4413
4414   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4415     goto wrong_mode;
4416
4417 #ifdef GST_ENABLE_EXTRA_CHECKS
4418   if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4419     if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4420       g_warning (G_STRLOC
4421           ":%s:<%s:%s> Got data flow before stream-start event",
4422           G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4423     }
4424     if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4425       g_warning (G_STRLOC
4426           ":%s:<%s:%s> Got data flow before segment event",
4427           G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4428     }
4429     pad->priv->last_cookie = pad->priv->events_cookie;
4430   }
4431 #endif
4432
4433   if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4434     goto events_error;
4435
4436   /* do block probes */
4437   PROBE_HANDLE (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped,
4438       probe_handled);
4439
4440   /* recheck sticky events because the probe might have cause a relink */
4441   if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4442     goto events_error;
4443
4444   /* do post-blocking probes */
4445   PROBE_HANDLE (pad, type, data, probe_stopped, probe_handled);
4446
4447   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4448     goto not_linked;
4449
4450   /* take ref to peer pad before releasing the lock */
4451   gst_object_ref (peer);
4452   pad->priv->using++;
4453   GST_OBJECT_UNLOCK (pad);
4454
4455   ret = gst_pad_chain_data_unchecked (peer, type, data);
4456   data = NULL;
4457
4458   gst_object_unref (peer);
4459
4460   GST_OBJECT_LOCK (pad);
4461   pad->ABI.abi.last_flowret = ret;
4462   pad->priv->using--;
4463   if (pad->priv->using == 0) {
4464     /* pad is not active anymore, trigger idle callbacks */
4465     PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4466         probe_stopped, ret);
4467   }
4468   GST_OBJECT_UNLOCK (pad);
4469
4470   return ret;
4471
4472   /* ERROR recovery here */
4473   /* ERRORS */
4474 flushing:
4475   {
4476     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4477         "pushing, but pad was flushing");
4478     pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4479     GST_OBJECT_UNLOCK (pad);
4480     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4481     return GST_FLOW_FLUSHING;
4482   }
4483 eos:
4484   {
4485     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pushing, but pad was EOS");
4486     pad->ABI.abi.last_flowret = GST_FLOW_EOS;
4487     GST_OBJECT_UNLOCK (pad);
4488     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4489     return GST_FLOW_EOS;
4490   }
4491 wrong_mode:
4492   {
4493     g_critical ("pushing on pad %s:%s but it was not activated in push mode",
4494         GST_DEBUG_PAD_NAME (pad));
4495     pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4496     GST_OBJECT_UNLOCK (pad);
4497     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4498     return GST_FLOW_ERROR;
4499   }
4500 events_error:
4501   {
4502     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4503         "error pushing events, return %s", gst_flow_get_name (ret));
4504     pad->ABI.abi.last_flowret = ret;
4505     GST_OBJECT_UNLOCK (pad);
4506     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4507     return ret;
4508   }
4509 probe_handled:
4510   handled = TRUE;
4511   /* PASSTHROUGH */
4512 probe_stopped:
4513   {
4514     GST_OBJECT_UNLOCK (pad);
4515     if (data != NULL && !handled)
4516       gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4517
4518     switch (ret) {
4519       case GST_FLOW_CUSTOM_SUCCESS:
4520       case GST_FLOW_CUSTOM_SUCCESS_1:
4521         GST_DEBUG_OBJECT (pad, "dropped or handled buffer");
4522         ret = GST_FLOW_OK;
4523         break;
4524       default:
4525         GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4526         break;
4527     }
4528     pad->ABI.abi.last_flowret = ret;
4529     return ret;
4530   }
4531 not_linked:
4532   {
4533     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4534         "pushing, but it was not linked");
4535     pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4536     GST_OBJECT_UNLOCK (pad);
4537     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4538     return GST_FLOW_NOT_LINKED;
4539   }
4540 }
4541
4542 /**
4543  * gst_pad_push:
4544  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4545  * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
4546  *     if not.
4547  *
4548  * Pushes a buffer to the peer of @pad.
4549  *
4550  * This function will call installed block probes before triggering any
4551  * installed data probes.
4552  *
4553  * The function proceeds calling gst_pad_chain() on the peer pad and returns
4554  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4555  * be returned.
4556  *
4557  * In all cases, success or failure, the caller loses its reference to @buffer
4558  * after calling this function.
4559  *
4560  * Returns: a #GstFlowReturn from the peer pad.
4561  *
4562  * MT safe.
4563  */
4564 GstFlowReturn
4565 gst_pad_push (GstPad * pad, GstBuffer * buffer)
4566 {
4567   GstFlowReturn res;
4568
4569   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4570   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4571   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4572
4573   GST_TRACER_PAD_PUSH_PRE (pad, buffer);
4574   res = gst_pad_push_data (pad,
4575       GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4576   GST_TRACER_PAD_PUSH_POST (pad, res);
4577   return res;
4578 }
4579
4580 /**
4581  * gst_pad_push_list:
4582  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4583  * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
4584  *     if not.
4585  *
4586  * Pushes a buffer list to the peer of @pad.
4587  *
4588  * This function will call installed block probes before triggering any
4589  * installed data probes.
4590  *
4591  * The function proceeds calling the chain function on the peer pad and returns
4592  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4593  * be returned. If the peer pad does not have any installed chainlist function
4594  * every group buffer of the list will be merged into a normal #GstBuffer and
4595  * chained via gst_pad_chain().
4596  *
4597  * In all cases, success or failure, the caller loses its reference to @list
4598  * after calling this function.
4599  *
4600  * Returns: a #GstFlowReturn from the peer pad.
4601  *
4602  * MT safe.
4603  */
4604 GstFlowReturn
4605 gst_pad_push_list (GstPad * pad, GstBufferList * list)
4606 {
4607   GstFlowReturn res;
4608
4609   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4610   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4611   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4612
4613   GST_TRACER_PAD_PUSH_LIST_PRE (pad, list);
4614   res = gst_pad_push_data (pad,
4615       GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4616   GST_TRACER_PAD_PUSH_LIST_POST (pad, res);
4617   return res;
4618 }
4619
4620 static GstFlowReturn
4621 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
4622     GstBuffer ** buffer)
4623 {
4624   GstFlowReturn ret;
4625   GstPadGetRangeFunction getrangefunc;
4626   GstObject *parent;
4627   GstBuffer *res_buf;
4628
4629   GST_PAD_STREAM_LOCK (pad);
4630
4631   GST_OBJECT_LOCK (pad);
4632   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4633     goto flushing;
4634
4635   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4636     goto wrong_mode;
4637
4638   if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4639     goto events_error;
4640
4641   res_buf = *buffer;
4642
4643   /* when one of the probes returns DROPPED, probe_stopped will be called
4644    * and we skip calling the getrange function, res_buf should then contain a
4645    * valid result buffer */
4646   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4647       res_buf, offset, size, probe_stopped);
4648
4649   /* recheck sticky events because the probe might have cause a relink */
4650   if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4651     goto events_error;
4652
4653   ACQUIRE_PARENT (pad, parent, no_parent);
4654   GST_OBJECT_UNLOCK (pad);
4655
4656   if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
4657     goto no_function;
4658
4659   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4660       "calling getrangefunc %s, offset %"
4661       G_GUINT64_FORMAT ", size %u",
4662       GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
4663
4664   ret = getrangefunc (pad, parent, offset, size, &res_buf);
4665
4666   RELEASE_PARENT (parent);
4667
4668   GST_OBJECT_LOCK (pad);
4669   if (G_UNLIKELY (ret != GST_FLOW_OK))
4670     goto get_range_failed;
4671
4672   /* can only fire the signal if we have a valid buffer */
4673 probed_data:
4674   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4675       res_buf, offset, size, probe_stopped_unref);
4676   pad->ABI.abi.last_flowret = ret;
4677   GST_OBJECT_UNLOCK (pad);
4678
4679   GST_PAD_STREAM_UNLOCK (pad);
4680
4681   *buffer = res_buf;
4682
4683   return ret;
4684
4685   /* ERRORS */
4686 flushing:
4687   {
4688     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4689         "getrange, but pad was flushing");
4690     pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4691     GST_OBJECT_UNLOCK (pad);
4692     GST_PAD_STREAM_UNLOCK (pad);
4693     return GST_FLOW_FLUSHING;
4694   }
4695 wrong_mode:
4696   {
4697     g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
4698         GST_DEBUG_PAD_NAME (pad));
4699     pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4700     GST_OBJECT_UNLOCK (pad);
4701     GST_PAD_STREAM_UNLOCK (pad);
4702     return GST_FLOW_ERROR;
4703   }
4704 events_error:
4705   {
4706     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
4707     pad->ABI.abi.last_flowret = ret;
4708     GST_OBJECT_UNLOCK (pad);
4709     GST_PAD_STREAM_UNLOCK (pad);
4710     return ret;
4711   }
4712 no_parent:
4713   {
4714     GST_DEBUG_OBJECT (pad, "no parent");
4715     pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4716     GST_OBJECT_UNLOCK (pad);
4717     GST_PAD_STREAM_UNLOCK (pad);
4718     return GST_FLOW_FLUSHING;
4719   }
4720 no_function:
4721   {
4722     g_critical ("getrange on pad %s:%s but it has no getrangefunction",
4723         GST_DEBUG_PAD_NAME (pad));
4724     RELEASE_PARENT (parent);
4725     GST_PAD_STREAM_UNLOCK (pad);
4726     return GST_FLOW_NOT_SUPPORTED;
4727   }
4728 probe_stopped:
4729   {
4730     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4731         "probe returned %s", gst_flow_get_name (ret));
4732     if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4733       if (res_buf) {
4734         /* the probe filled the buffer and asks us to not call the getrange
4735          * anymore, we continue with the post probes then. */
4736         GST_DEBUG_OBJECT (pad, "handled buffer");
4737         ret = GST_FLOW_OK;
4738         goto probed_data;
4739       } else {
4740         /* no buffer, we are EOS */
4741         GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4742         ret = GST_FLOW_EOS;
4743       }
4744     }
4745     pad->ABI.abi.last_flowret = ret;
4746     GST_OBJECT_UNLOCK (pad);
4747     GST_PAD_STREAM_UNLOCK (pad);
4748
4749     return ret;
4750   }
4751 probe_stopped_unref:
4752   {
4753     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4754         "probe returned %s", gst_flow_get_name (ret));
4755     /* if we drop here, it signals EOS */
4756     if (ret == GST_FLOW_CUSTOM_SUCCESS)
4757       ret = GST_FLOW_EOS;
4758     pad->ABI.abi.last_flowret = ret;
4759     GST_OBJECT_UNLOCK (pad);
4760     GST_PAD_STREAM_UNLOCK (pad);
4761     if (*buffer == NULL)
4762       gst_buffer_unref (res_buf);
4763     return ret;
4764   }
4765 get_range_failed:
4766   {
4767     pad->ABI.abi.last_flowret = ret;
4768     GST_OBJECT_UNLOCK (pad);
4769     GST_PAD_STREAM_UNLOCK (pad);
4770     GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4771         (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4772         pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
4773     return ret;
4774   }
4775 }
4776
4777 /**
4778  * gst_pad_get_range:
4779  * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4780  * @offset: The start offset of the buffer
4781  * @size: The length of the buffer
4782  * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
4783  *     returns #GST_FLOW_ERROR if %NULL.
4784  *
4785  * When @pad is flushing this function returns #GST_FLOW_FLUSHING
4786  * immediately and @buffer is %NULL.
4787  *
4788  * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4789  * description of a getrange function. If @pad has no getrange function
4790  * installed (see gst_pad_set_getrange_function()) this function returns
4791  * #GST_FLOW_NOT_SUPPORTED.
4792  *
4793  * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4794  * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4795  * must be freed with gst_buffer_unref() after usage.
4796  *
4797  * When @buffer points to a variable that points to a valid #GstBuffer, the
4798  * buffer will be filled with the result data when this function returns
4799  * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4800  * @size bytes will be filled in the result buffer and its size will be updated
4801  * accordingly.
4802  *
4803  * Note that less than @size bytes can be returned in @buffer when, for example,
4804  * an EOS condition is near or when @buffer is not large enough to hold @size
4805  * bytes. The caller should check the result buffer size to get the result size.
4806  *
4807  * When this function returns any other result value than #GST_FLOW_OK, @buffer
4808  * will be unchanged.
4809  *
4810  * This is a lowlevel function. Usually gst_pad_pull_range() is used.
4811  *
4812  * Returns: a #GstFlowReturn from the pad.
4813  *
4814  * MT safe.
4815  */
4816 GstFlowReturn
4817 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4818     GstBuffer ** buffer)
4819 {
4820   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4821   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4822   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4823   g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4824           && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4825
4826   return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4827 }
4828
4829 /**
4830  * gst_pad_pull_range:
4831  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4832  * @offset: The start offset of the buffer
4833  * @size: The length of the buffer
4834  * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4835  *     GST_FLOW_ERROR if %NULL.
4836  *
4837  * Pulls a @buffer from the peer pad or fills up a provided buffer.
4838  *
4839  * This function will first trigger the pad block signal if it was
4840  * installed.
4841  *
4842  * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4843  * function returns the result of gst_pad_get_range() on the peer pad.
4844  * See gst_pad_get_range() for a list of return values and for the
4845  * semantics of the arguments of this function.
4846  *
4847  * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4848  * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4849  * must be freed with gst_buffer_unref() after usage. When this function
4850  * returns any other result value, @buffer will still point to %NULL.
4851  *
4852  * When @buffer points to a variable that points to a valid #GstBuffer, the
4853  * buffer will be filled with the result data when this function returns
4854  * #GST_FLOW_OK. When this function returns any other result value,
4855  * @buffer will be unchanged. If the provided buffer is larger than @size, only
4856  * @size bytes will be filled in the result buffer and its size will be updated
4857  * accordingly.
4858  *
4859  * Note that less than @size bytes can be returned in @buffer when, for example,
4860  * an EOS condition is near or when @buffer is not large enough to hold @size
4861  * bytes. The caller should check the result buffer size to get the result size.
4862  *
4863  * Returns: a #GstFlowReturn from the peer pad.
4864  *
4865  * MT safe.
4866  */
4867 GstFlowReturn
4868 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4869     GstBuffer ** buffer)
4870 {
4871   GstPad *peer;
4872   GstFlowReturn ret;
4873   GstBuffer *res_buf;
4874
4875   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4876   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4877   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4878   g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4879           && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4880
4881   GST_TRACER_PAD_PULL_RANGE_PRE (pad, offset, size);
4882
4883   GST_OBJECT_LOCK (pad);
4884   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4885     goto flushing;
4886
4887   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4888     goto wrong_mode;
4889
4890   res_buf = *buffer;
4891
4892   /* when one of the probes returns DROPPED, probe_stopped will be
4893    * called and we skip calling the peer getrange function. *buffer should then
4894    * contain a valid buffer */
4895   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4896       res_buf, offset, size, probe_stopped);
4897
4898   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4899     goto not_linked;
4900
4901   gst_object_ref (peer);
4902   pad->priv->using++;
4903   GST_OBJECT_UNLOCK (pad);
4904
4905   ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4906
4907   gst_object_unref (peer);
4908
4909   GST_OBJECT_LOCK (pad);
4910   pad->priv->using--;
4911   pad->ABI.abi.last_flowret = ret;
4912   if (pad->priv->using == 0) {
4913     /* pad is not active anymore, trigger idle callbacks */
4914     PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4915         probe_stopped_unref, ret);
4916   }
4917
4918   if (G_UNLIKELY (ret != GST_FLOW_OK))
4919     goto pull_range_failed;
4920
4921 probed_data:
4922   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4923       res_buf, offset, size, probe_stopped_unref);
4924
4925   GST_OBJECT_UNLOCK (pad);
4926
4927   *buffer = res_buf;
4928
4929   GST_TRACER_PAD_PULL_RANGE_POST (pad, *buffer, ret);
4930   return ret;
4931
4932   /* ERROR recovery here */
4933 flushing:
4934   {
4935     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4936         "pullrange, but pad was flushing");
4937     pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4938     GST_OBJECT_UNLOCK (pad);
4939     ret = GST_FLOW_FLUSHING;
4940     goto done;
4941   }
4942 wrong_mode:
4943   {
4944     g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4945         GST_DEBUG_PAD_NAME (pad));
4946     pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4947     GST_OBJECT_UNLOCK (pad);
4948     ret = GST_FLOW_ERROR;
4949     goto done;
4950   }
4951 probe_stopped:
4952   {
4953     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4954         gst_flow_get_name (ret));
4955     if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4956       if (res_buf) {
4957         /* the probe filled the buffer and asks us to not forward to the peer
4958          * anymore, we continue with the post probes then */
4959         GST_DEBUG_OBJECT (pad, "handled buffer");
4960         ret = GST_FLOW_OK;
4961         goto probed_data;
4962       } else {
4963         /* no buffer, we are EOS then */
4964         GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4965         ret = GST_FLOW_EOS;
4966       }
4967     }
4968     pad->ABI.abi.last_flowret = ret;
4969     GST_OBJECT_UNLOCK (pad);
4970     goto done;
4971   }
4972 not_linked:
4973   {
4974     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4975         "pulling range, but it was not linked");
4976     pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4977     GST_OBJECT_UNLOCK (pad);
4978     ret = GST_FLOW_NOT_LINKED;
4979     goto done;
4980   }
4981 pull_range_failed:
4982   {
4983     pad->ABI.abi.last_flowret = ret;
4984     GST_OBJECT_UNLOCK (pad);
4985     GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4986         (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4987         pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4988     goto done;
4989   }
4990 probe_stopped_unref:
4991   {
4992     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4993         "post probe returned %s", gst_flow_get_name (ret));
4994
4995     /* if we drop here, it signals EOS */
4996     if (ret == GST_FLOW_CUSTOM_SUCCESS)
4997       ret = GST_FLOW_EOS;
4998
4999     pad->ABI.abi.last_flowret = ret;
5000     GST_OBJECT_UNLOCK (pad);
5001
5002     if (*buffer == NULL)
5003       gst_buffer_unref (res_buf);
5004     goto done;
5005   }
5006 done:
5007   GST_TRACER_PAD_PULL_RANGE_POST (pad, NULL, ret);
5008   return ret;
5009 }
5010
5011 /* must be called with pad object lock */
5012 static GstFlowReturn
5013 store_sticky_event (GstPad * pad, GstEvent * event)
5014 {
5015   guint i, len;
5016   GstEventType type;
5017   GArray *events;
5018   gboolean res = FALSE;
5019   const gchar *name = NULL;
5020   gboolean insert = TRUE;
5021
5022   type = GST_EVENT_TYPE (event);
5023
5024   /* Store all sticky events except SEGMENT/EOS when we're flushing,
5025    * otherwise they can be dropped and nothing would ever resend them.
5026    * Only do that for activated pads though, everything else is a bug!
5027    */
5028   if (G_UNLIKELY (GST_PAD_MODE (pad) == GST_PAD_MODE_NONE
5029           || (GST_PAD_IS_FLUSHING (pad) && (type == GST_EVENT_SEGMENT
5030                   || type == GST_EVENT_EOS))))
5031     goto flushed;
5032
5033   /* Unset the EOS flag when received STREAM_START event, so pad can
5034    * store sticky event and then push it later */
5035   if (type == GST_EVENT_STREAM_START) {
5036     GST_LOG_OBJECT (pad, "Removing pending EOS and StreamGroupDone events");
5037     remove_event_by_type (pad, GST_EVENT_EOS);
5038     remove_event_by_type (pad, GST_EVENT_STREAM_GROUP_DONE);
5039     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5040   }
5041
5042   if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5043     goto eos;
5044
5045   if (type & GST_EVENT_TYPE_STICKY_MULTI)
5046     name = gst_structure_get_name (gst_event_get_structure (event));
5047
5048   events = pad->priv->events;
5049   len = events->len;
5050
5051   for (i = 0; i < len; i++) {
5052     PadEvent *ev = &g_array_index (events, PadEvent, i);
5053
5054     if (ev->event == NULL)
5055       continue;
5056
5057     if (type == GST_EVENT_TYPE (ev->event)) {
5058       /* matching types, check matching name if needed */
5059       if (name && !gst_event_has_name (ev->event, name))
5060         continue;
5061
5062       /* overwrite */
5063       if ((res = gst_event_replace (&ev->event, event)))
5064         ev->received = FALSE;
5065
5066       insert = FALSE;
5067       break;
5068     }
5069
5070     if (type < GST_EVENT_TYPE (ev->event) || (type != GST_EVENT_TYPE (ev->event)
5071             && GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS)) {
5072       /* STREAM_START, CAPS and SEGMENT must be delivered in this order. By
5073        * storing the sticky ordered we can check that this is respected. */
5074       if (G_UNLIKELY (GST_EVENT_TYPE (ev->event) <= GST_EVENT_SEGMENT
5075               || GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS))
5076         g_warning (G_STRLOC
5077             ":%s:<%s:%s> Sticky event misordering, got '%s' before '%s'",
5078             G_STRFUNC, GST_DEBUG_PAD_NAME (pad),
5079             gst_event_type_get_name (GST_EVENT_TYPE (ev->event)),
5080             gst_event_type_get_name (type));
5081       break;
5082     }
5083   }
5084   if (insert) {
5085     PadEvent ev;
5086     ev.event = gst_event_ref (event);
5087     ev.received = FALSE;
5088     g_array_insert_val (events, i, ev);
5089     res = TRUE;
5090   }
5091
5092   if (res) {
5093     pad->priv->events_cookie++;
5094     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5095
5096     GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
5097
5098     switch (GST_EVENT_TYPE (event)) {
5099       case GST_EVENT_CAPS:
5100         GST_OBJECT_UNLOCK (pad);
5101
5102         GST_DEBUG_OBJECT (pad, "notify caps");
5103         g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
5104
5105         GST_OBJECT_LOCK (pad);
5106         break;
5107       default:
5108         break;
5109     }
5110   }
5111   if (type == GST_EVENT_EOS) {
5112     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
5113     pad->ABI.abi.last_flowret = GST_FLOW_EOS;
5114   }
5115
5116   return GST_PAD_IS_FLUSHING (pad) ? GST_FLOW_FLUSHING : GST_FLOW_OK;
5117
5118   /* ERRORS */
5119 flushed:
5120   {
5121     GST_DEBUG_OBJECT (pad, "pad is flushing");
5122     return GST_FLOW_FLUSHING;
5123   }
5124 eos:
5125   {
5126     GST_DEBUG_OBJECT (pad, "pad is EOS");
5127     return GST_FLOW_EOS;
5128   }
5129 }
5130
5131 /**
5132  * gst_pad_store_sticky_event:
5133  * @pad: a #GstPad
5134  * @event: (transfer none): a #GstEvent
5135  *
5136  * Store the sticky @event on @pad
5137  *
5138  * Returns: #GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad
5139  * was flushing or #GST_FLOW_EOS when the pad was EOS.
5140  *
5141  * Since: 1.2
5142  */
5143 GstFlowReturn
5144 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event)
5145 {
5146   GstFlowReturn ret;
5147
5148   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5149   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
5150
5151   GST_OBJECT_LOCK (pad);
5152   ret = store_sticky_event (pad, event);
5153   GST_OBJECT_UNLOCK (pad);
5154
5155   return ret;
5156 }
5157
5158 static gboolean
5159 sticky_changed (GstPad * pad, PadEvent * ev, gpointer user_data)
5160 {
5161   PushStickyData *data = user_data;
5162
5163   /* Forward all sticky events before our current one that are pending */
5164   if (ev->event != data->event
5165       && GST_EVENT_TYPE (ev->event) < GST_EVENT_TYPE (data->event))
5166     return push_sticky (pad, ev, data);
5167
5168   return TRUE;
5169 }
5170
5171 /* should be called with pad LOCK */
5172 static GstFlowReturn
5173 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
5174     GstPadProbeType type)
5175 {
5176   GstFlowReturn ret;
5177   GstPad *peerpad;
5178   GstEventType event_type;
5179
5180   /* pass the adjusted event on. We need to do this even if
5181    * there is no peer pad because of the probes. */
5182   event = apply_pad_offset (pad, event, GST_PAD_IS_SINK (pad));
5183
5184   /* Two checks to be made:
5185    * . (un)set the FLUSHING flag for flushing events,
5186    * . handle pad blocking */
5187   event_type = GST_EVENT_TYPE (event);
5188   switch (event_type) {
5189     case GST_EVENT_FLUSH_START:
5190       GST_PAD_SET_FLUSHING (pad);
5191
5192       GST_PAD_BLOCK_BROADCAST (pad);
5193       type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5194       break;
5195     case GST_EVENT_FLUSH_STOP:
5196       if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
5197         goto inactive;
5198
5199       GST_PAD_UNSET_FLUSHING (pad);
5200
5201       /* Remove sticky EOS events */
5202       GST_LOG_OBJECT (pad, "Removing pending EOS events");
5203       remove_event_by_type (pad, GST_EVENT_EOS);
5204       remove_event_by_type (pad, GST_EVENT_STREAM_GROUP_DONE);
5205       remove_event_by_type (pad, GST_EVENT_SEGMENT);
5206       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5207       pad->ABI.abi.last_flowret = GST_FLOW_OK;
5208
5209       type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5210       break;
5211     default:
5212     {
5213       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5214         goto flushed;
5215
5216       /* No need to check for EOS here as either the caller (gst_pad_push_event())
5217        * checked already or this is called as part of pushing sticky events,
5218        * in which case we still want to forward the EOS event downstream.
5219        */
5220
5221       switch (GST_EVENT_TYPE (event)) {
5222         case GST_EVENT_RECONFIGURE:
5223           if (GST_PAD_IS_SINK (pad))
5224             GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5225           break;
5226         default:
5227           break;
5228       }
5229       PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
5230           GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5231       break;
5232     }
5233   }
5234
5235   /* send probes after modifying the events above */
5236   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5237
5238   /* recheck sticky events because the probe might have cause a relink */
5239   if (GST_PAD_HAS_PENDING_EVENTS (pad) && GST_PAD_IS_SRC (pad)
5240       && (GST_EVENT_IS_SERIALIZED (event)
5241           || GST_EVENT_IS_STICKY (event))) {
5242     PushStickyData data = { GST_FLOW_OK, FALSE, event };
5243     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5244
5245     /* Push all sticky events before our current one
5246      * that have changed */
5247     events_foreach (pad, sticky_changed, &data);
5248   }
5249
5250   /* now check the peer pad */
5251   peerpad = GST_PAD_PEER (pad);
5252   if (peerpad == NULL)
5253     goto not_linked;
5254
5255   gst_object_ref (peerpad);
5256   pad->priv->using++;
5257   GST_OBJECT_UNLOCK (pad);
5258
5259   GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
5260       event, gst_event_type_get_name (event_type), peerpad);
5261
5262   ret = gst_pad_send_event_unchecked (peerpad, event, type);
5263
5264   /* Note: we gave away ownership of the event at this point but we can still
5265    * print the old pointer */
5266   GST_LOG_OBJECT (pad,
5267       "sent event %p (%s) to peerpad %" GST_PTR_FORMAT ", ret %s", event,
5268       gst_event_type_get_name (event_type), peerpad, gst_flow_get_name (ret));
5269
5270   gst_object_unref (peerpad);
5271
5272   GST_OBJECT_LOCK (pad);
5273   pad->priv->using--;
5274   if (pad->priv->using == 0) {
5275     /* pad is not active anymore, trigger idle callbacks */
5276     PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
5277         idle_probe_stopped, ret);
5278   }
5279   return ret;
5280
5281   /* ERROR handling */
5282 flushed:
5283   {
5284     GST_DEBUG_OBJECT (pad, "We're flushing");
5285     gst_event_unref (event);
5286     return GST_FLOW_FLUSHING;
5287   }
5288 inactive:
5289   {
5290     GST_DEBUG_OBJECT (pad, "flush-stop on inactive pad");
5291     gst_event_unref (event);
5292     return GST_FLOW_FLUSHING;
5293   }
5294 probe_stopped:
5295   {
5296     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5297     if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
5298       gst_event_unref (event);
5299
5300     switch (ret) {
5301       case GST_FLOW_CUSTOM_SUCCESS_1:
5302         GST_DEBUG_OBJECT (pad, "handled event");
5303         break;
5304       case GST_FLOW_CUSTOM_SUCCESS:
5305         GST_DEBUG_OBJECT (pad, "dropped event");
5306         break;
5307       default:
5308         GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5309         break;
5310     }
5311     return ret;
5312   }
5313 not_linked:
5314   {
5315     GST_DEBUG_OBJECT (pad, "Dropping event %s because pad is not linked",
5316         gst_event_type_get_name (GST_EVENT_TYPE (event)));
5317     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5318     gst_event_unref (event);
5319
5320     /* unlinked pads should not influence latency configuration */
5321     if (event_type == GST_EVENT_LATENCY)
5322       return GST_FLOW_OK;
5323
5324     return GST_FLOW_NOT_LINKED;
5325   }
5326 idle_probe_stopped:
5327   {
5328     GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
5329     return ret;
5330   }
5331 }
5332
5333 /**
5334  * gst_pad_push_event:
5335  * @pad: a #GstPad to push the event to.
5336  * @event: (transfer full): the #GstEvent to send to the pad.
5337  *
5338  * Sends the event to the peer of the given pad. This function is
5339  * mainly used by elements to send events to their peer
5340  * elements.
5341  *
5342  * This function takes ownership of the provided event so you should
5343  * gst_event_ref() it if you want to reuse the event after this call.
5344  *
5345  * Returns: %TRUE if the event was handled.
5346  *
5347  * MT safe.
5348  */
5349 gboolean
5350 gst_pad_push_event (GstPad * pad, GstEvent * event)
5351 {
5352   gboolean res = FALSE;
5353   GstPadProbeType type;
5354   gboolean sticky, serialized;
5355
5356   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5357   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
5358
5359   GST_TRACER_PAD_PUSH_EVENT_PRE (pad, event);
5360
5361   if (GST_PAD_IS_SRC (pad)) {
5362     if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5363       goto wrong_direction;
5364     type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5365   } else if (GST_PAD_IS_SINK (pad)) {
5366     if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5367       goto wrong_direction;
5368     /* events pushed on sinkpad never are sticky */
5369     type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5370   } else
5371     goto unknown_direction;
5372
5373   GST_OBJECT_LOCK (pad);
5374   sticky = GST_EVENT_IS_STICKY (event);
5375   serialized = GST_EVENT_IS_SERIALIZED (event);
5376
5377   if (sticky) {
5378     /* srcpad sticky events are stored immediately, the received flag is set
5379      * to FALSE and will be set to TRUE when we can successfully push the
5380      * event to the peer pad */
5381     switch (store_sticky_event (pad, event)) {
5382       case GST_FLOW_FLUSHING:
5383         goto flushed;
5384       case GST_FLOW_EOS:
5385         goto eos;
5386       default:
5387         break;
5388     }
5389   }
5390   if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
5391     /* all serialized or sticky events on the srcpad trigger push of
5392      * sticky events */
5393     res = (check_sticky (pad, event) == GST_FLOW_OK);
5394   }
5395   if (!sticky) {
5396     GstFlowReturn ret;
5397
5398     /* other events are pushed right away */
5399     ret = gst_pad_push_event_unchecked (pad, event, type);
5400     /* dropped events by a probe are not an error */
5401     res = (ret == GST_FLOW_OK || ret == GST_FLOW_CUSTOM_SUCCESS
5402         || ret == GST_FLOW_CUSTOM_SUCCESS_1);
5403   } else {
5404     /* Errors in sticky event pushing are no problem and ignored here
5405      * as they will cause more meaningful errors during data flow.
5406      * For EOS events, that are not followed by data flow, we still
5407      * return FALSE here though.
5408      */
5409     if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
5410       res = TRUE;
5411     gst_event_unref (event);
5412   }
5413   GST_OBJECT_UNLOCK (pad);
5414
5415   GST_TRACER_PAD_PUSH_EVENT_POST (pad, res);
5416   return res;
5417
5418   /* ERROR handling */
5419 wrong_direction:
5420   {
5421     g_warning ("pad %s:%s pushing %s event in wrong direction",
5422         GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5423     gst_event_unref (event);
5424     goto done;
5425   }
5426 unknown_direction:
5427   {
5428     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5429     gst_event_unref (event);
5430     goto done;
5431   }
5432 flushed:
5433   {
5434     GST_DEBUG_OBJECT (pad, "We're flushing");
5435     GST_OBJECT_UNLOCK (pad);
5436     gst_event_unref (event);
5437     goto done;
5438   }
5439 eos:
5440   {
5441     GST_DEBUG_OBJECT (pad, "We're EOS");
5442     GST_OBJECT_UNLOCK (pad);
5443     gst_event_unref (event);
5444     goto done;
5445   }
5446 done:
5447   GST_TRACER_PAD_PUSH_EVENT_POST (pad, FALSE);
5448   return FALSE;
5449 }
5450
5451 /* Check if we can call the event function with the given event */
5452 static GstFlowReturn
5453 pre_eventfunc_check (GstPad * pad, GstEvent * event)
5454 {
5455   GstCaps *caps;
5456
5457   switch (GST_EVENT_TYPE (event)) {
5458     case GST_EVENT_CAPS:
5459     {
5460       /* backwards compatibility mode for caps */
5461       gst_event_parse_caps (event, &caps);
5462
5463       if (!gst_pad_query_accept_caps (pad, caps))
5464         goto not_accepted;
5465       break;
5466     }
5467     default:
5468       break;
5469   }
5470   return GST_FLOW_OK;
5471
5472   /* ERRORS */
5473 not_accepted:
5474   {
5475     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
5476         "caps %" GST_PTR_FORMAT " not accepted", caps);
5477     return GST_FLOW_NOT_NEGOTIATED;
5478   }
5479 }
5480
5481 static GstFlowReturn
5482 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
5483     GstPadProbeType type)
5484 {
5485   GstFlowReturn ret;
5486   GstEventType event_type;
5487   gboolean serialized, need_unlock = FALSE, sticky;
5488   GstPadEventFunction eventfunc;
5489   GstPadEventFullFunction eventfullfunc = NULL;
5490   GstObject *parent;
5491
5492   GST_OBJECT_LOCK (pad);
5493
5494   event = apply_pad_offset (pad, event, GST_PAD_IS_SRC (pad));
5495
5496   if (GST_PAD_IS_SINK (pad))
5497     serialized = GST_EVENT_IS_SERIALIZED (event);
5498   else
5499     serialized = FALSE;
5500   sticky = GST_EVENT_IS_STICKY (event);
5501   event_type = GST_EVENT_TYPE (event);
5502   switch (event_type) {
5503     case GST_EVENT_FLUSH_START:
5504       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5505           "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
5506
5507       /* can't even accept a flush begin event when flushing */
5508       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5509         goto flushing;
5510
5511       GST_PAD_SET_FLUSHING (pad);
5512       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
5513       GST_PAD_BLOCK_BROADCAST (pad);
5514       type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5515       break;
5516     case GST_EVENT_FLUSH_STOP:
5517       /* we can't accept flush-stop on inactive pads else the flushing flag
5518        * would be cleared and it would look like the pad can accept data.
5519        * Also, some elements restart a streaming thread in flush-stop which we
5520        * can't allow on inactive pads */
5521       if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
5522         goto inactive;
5523
5524       GST_PAD_UNSET_FLUSHING (pad);
5525       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
5526       /* Remove pending EOS events */
5527       GST_LOG_OBJECT (pad, "Removing pending EOS and SEGMENT events");
5528       remove_event_by_type (pad, GST_EVENT_EOS);
5529       remove_event_by_type (pad, GST_EVENT_STREAM_GROUP_DONE);
5530       remove_event_by_type (pad, GST_EVENT_SEGMENT);
5531       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5532       pad->ABI.abi.last_flowret = GST_FLOW_OK;
5533
5534       GST_OBJECT_UNLOCK (pad);
5535       /* grab stream lock */
5536       GST_PAD_STREAM_LOCK (pad);
5537       need_unlock = TRUE;
5538       GST_OBJECT_LOCK (pad);
5539       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5540         goto flushing;
5541       break;
5542     case GST_EVENT_RECONFIGURE:
5543       if (GST_PAD_IS_SRC (pad))
5544         GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5545     default:
5546       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5547           "have event type %" GST_PTR_FORMAT, event);
5548
5549       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5550         goto flushing;
5551
5552       switch (event_type) {
5553         case GST_EVENT_STREAM_START:
5554           /* Remove sticky EOS events */
5555           GST_LOG_OBJECT (pad, "Removing pending EOS events");
5556           remove_event_by_type (pad, GST_EVENT_EOS);
5557           remove_event_by_type (pad, GST_EVENT_STREAM_GROUP_DONE);
5558           GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5559           break;
5560         default:
5561           break;
5562       }
5563
5564       if (serialized) {
5565         if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5566           goto eos;
5567
5568         /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
5569         GST_OBJECT_UNLOCK (pad);
5570         GST_PAD_STREAM_LOCK (pad);
5571         need_unlock = TRUE;
5572         GST_OBJECT_LOCK (pad);
5573         if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5574           goto flushing;
5575
5576         if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5577           goto eos;
5578       }
5579       break;
5580   }
5581
5582   /* now do the probe */
5583   PROBE_PUSH (pad,
5584       type | GST_PAD_PROBE_TYPE_PUSH |
5585       GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5586
5587   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5588
5589   eventfullfunc = GST_PAD_EVENTFULLFUNC (pad);
5590   eventfunc = GST_PAD_EVENTFUNC (pad);
5591   if (G_UNLIKELY (eventfunc == NULL && eventfullfunc == NULL))
5592     goto no_function;
5593
5594   ACQUIRE_PARENT (pad, parent, no_parent);
5595   GST_OBJECT_UNLOCK (pad);
5596
5597   ret = pre_eventfunc_check (pad, event);
5598   if (G_UNLIKELY (ret != GST_FLOW_OK))
5599     goto precheck_failed;
5600
5601   if (sticky)
5602     gst_event_ref (event);
5603
5604   if (eventfullfunc) {
5605     ret = eventfullfunc (pad, parent, event);
5606   } else if (eventfunc (pad, parent, event)) {
5607     ret = GST_FLOW_OK;
5608   } else {
5609     /* something went wrong */
5610     switch (event_type) {
5611       case GST_EVENT_CAPS:
5612         ret = GST_FLOW_NOT_NEGOTIATED;
5613         break;
5614       default:
5615         ret = GST_FLOW_ERROR;
5616         break;
5617     }
5618   }
5619   RELEASE_PARENT (parent);
5620
5621   GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
5622
5623   if (sticky) {
5624     if (ret == GST_FLOW_OK) {
5625       GST_OBJECT_LOCK (pad);
5626       /* after the event function accepted the event, we can store the sticky
5627        * event on the pad */
5628       switch (store_sticky_event (pad, event)) {
5629         case GST_FLOW_FLUSHING:
5630           goto flushing;
5631         case GST_FLOW_EOS:
5632           goto eos;
5633         default:
5634           break;
5635       }
5636       GST_OBJECT_UNLOCK (pad);
5637     }
5638     gst_event_unref (event);
5639   }
5640
5641   if (need_unlock)
5642     GST_PAD_STREAM_UNLOCK (pad);
5643
5644   return ret;
5645
5646   /* ERROR handling */
5647 flushing:
5648   {
5649     GST_OBJECT_UNLOCK (pad);
5650     if (need_unlock)
5651       GST_PAD_STREAM_UNLOCK (pad);
5652     GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5653         "Received event on flushing pad. Discarding");
5654     gst_event_unref (event);
5655     return GST_FLOW_FLUSHING;
5656   }
5657 inactive:
5658   {
5659     GST_OBJECT_UNLOCK (pad);
5660     if (need_unlock)
5661       GST_PAD_STREAM_UNLOCK (pad);
5662     GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5663         "Received flush-stop on inactive pad. Discarding");
5664     gst_event_unref (event);
5665     return GST_FLOW_FLUSHING;
5666   }
5667 eos:
5668   {
5669     GST_OBJECT_UNLOCK (pad);
5670     if (need_unlock)
5671       GST_PAD_STREAM_UNLOCK (pad);
5672     GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5673         "Received event on EOS pad. Discarding");
5674     gst_event_unref (event);
5675     return GST_FLOW_EOS;
5676   }
5677 probe_stopped:
5678   {
5679     GST_OBJECT_UNLOCK (pad);
5680     if (need_unlock)
5681       GST_PAD_STREAM_UNLOCK (pad);
5682     /* Only unref if unhandled */
5683     if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
5684       gst_event_unref (event);
5685
5686     switch (ret) {
5687       case GST_FLOW_CUSTOM_SUCCESS_1:
5688       case GST_FLOW_CUSTOM_SUCCESS:
5689         GST_DEBUG_OBJECT (pad, "dropped or handled event");
5690         ret = GST_FLOW_OK;
5691         break;
5692       default:
5693         GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5694         break;
5695     }
5696     return ret;
5697   }
5698 no_function:
5699   {
5700     g_warning ("pad %s:%s has no event handler, file a bug.",
5701         GST_DEBUG_PAD_NAME (pad));
5702     GST_OBJECT_UNLOCK (pad);
5703     if (need_unlock)
5704       GST_PAD_STREAM_UNLOCK (pad);
5705     gst_event_unref (event);
5706     return GST_FLOW_NOT_SUPPORTED;
5707   }
5708 no_parent:
5709   {
5710     GST_DEBUG_OBJECT (pad, "no parent");
5711     GST_OBJECT_UNLOCK (pad);
5712     if (need_unlock)
5713       GST_PAD_STREAM_UNLOCK (pad);
5714     gst_event_unref (event);
5715     return GST_FLOW_FLUSHING;
5716   }
5717 precheck_failed:
5718   {
5719     GST_DEBUG_OBJECT (pad, "pre event check failed");
5720     RELEASE_PARENT (parent);
5721     if (need_unlock)
5722       GST_PAD_STREAM_UNLOCK (pad);
5723     gst_event_unref (event);
5724     return ret;
5725   }
5726 }
5727
5728 /**
5729  * gst_pad_send_event:
5730  * @pad: a #GstPad to send the event to.
5731  * @event: (transfer full): the #GstEvent to send to the pad.
5732  *
5733  * Sends the event to the pad. This function can be used
5734  * by applications to send events in the pipeline.
5735  *
5736  * If @pad is a source pad, @event should be an upstream event. If @pad is a
5737  * sink pad, @event should be a downstream event. For example, you would not
5738  * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
5739  * Furthermore, some downstream events have to be serialized with data flow,
5740  * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
5741  * the event needs to be serialized with data flow, this function will take the
5742  * pad's stream lock while calling its event function.
5743  *
5744  * To find out whether an event type is upstream, downstream, or downstream and
5745  * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
5746  * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
5747  * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
5748  * plugin doesn't need to bother itself with this information; the core handles
5749  * all necessary locks and checks.
5750  *
5751  * This function takes ownership of the provided event so you should
5752  * gst_event_ref() it if you want to reuse the event after this call.
5753  *
5754  * Returns: %TRUE if the event was handled.
5755  */
5756 gboolean
5757 gst_pad_send_event (GstPad * pad, GstEvent * event)
5758 {
5759   gboolean result;
5760   GstPadProbeType type;
5761
5762   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5763   g_return_val_if_fail (event != NULL, FALSE);
5764
5765   if (GST_PAD_IS_SINK (pad)) {
5766     if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5767       goto wrong_direction;
5768     type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5769   } else if (GST_PAD_IS_SRC (pad)) {
5770     if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5771       goto wrong_direction;
5772     type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5773   } else
5774     goto unknown_direction;
5775
5776   if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
5777     result = FALSE;
5778   else
5779     result = TRUE;
5780
5781   return result;
5782
5783   /* ERROR handling */
5784 wrong_direction:
5785   {
5786     g_warning ("pad %s:%s sending %s event in wrong direction",
5787         GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5788     gst_event_unref (event);
5789     return FALSE;
5790   }
5791 unknown_direction:
5792   {
5793     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5794     gst_event_unref (event);
5795     return FALSE;
5796   }
5797 }
5798
5799 /**
5800  * gst_pad_set_element_private:
5801  * @pad: the #GstPad to set the private data of.
5802  * @priv: The private data to attach to the pad.
5803  *
5804  * Set the given private data gpointer on the pad.
5805  * This function can only be used by the element that owns the pad.
5806  * No locking is performed in this function.
5807  */
5808 void
5809 gst_pad_set_element_private (GstPad * pad, gpointer priv)
5810 {
5811   pad->element_private = priv;
5812 }
5813
5814 /**
5815  * gst_pad_get_element_private:
5816  * @pad: the #GstPad to get the private data of.
5817  *
5818  * Gets the private data of a pad.
5819  * No locking is performed in this function.
5820  *
5821  * Returns: (transfer none): a #gpointer to the private data.
5822  */
5823 gpointer
5824 gst_pad_get_element_private (GstPad * pad)
5825 {
5826   return pad->element_private;
5827 }
5828
5829 /**
5830  * gst_pad_get_sticky_event:
5831  * @pad: the #GstPad to get the event from.
5832  * @event_type: the #GstEventType that should be retrieved.
5833  * @idx: the index of the event
5834  *
5835  * Returns a new reference of the sticky event of type @event_type
5836  * from the event.
5837  *
5838  * Returns: (transfer full) (nullable): a #GstEvent of type
5839  * @event_type or %NULL when no event of @event_type was on
5840  * @pad. Unref after usage.
5841  */
5842 GstEvent *
5843 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
5844 {
5845   GstEvent *event = NULL;
5846   PadEvent *ev;
5847
5848   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
5849   g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
5850
5851   GST_OBJECT_LOCK (pad);
5852   ev = find_event_by_type (pad, event_type, idx);
5853   if (ev && (event = ev->event))
5854     gst_event_ref (event);
5855   GST_OBJECT_UNLOCK (pad);
5856
5857   return event;
5858 }
5859
5860 typedef struct
5861 {
5862   GstPadStickyEventsForeachFunction func;
5863   gpointer user_data;
5864 } ForeachDispatch;
5865
5866 static gboolean
5867 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
5868 {
5869   ForeachDispatch *data = user_data;
5870   gboolean ret = TRUE;
5871
5872   if (ev->event) {
5873     GST_OBJECT_UNLOCK (pad);
5874
5875     ret = data->func (pad, &ev->event, data->user_data);
5876
5877     GST_OBJECT_LOCK (pad);
5878   }
5879
5880   return ret;
5881 }
5882
5883 /**
5884  * gst_pad_sticky_events_foreach:
5885  * @pad: the #GstPad that should be used for iteration.
5886  * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
5887  *                should be called for every event.
5888  * @user_data: (closure): the optional user data.
5889  *
5890  * Iterates all sticky events on @pad and calls @foreach_func for every
5891  * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
5892  */
5893 void
5894 gst_pad_sticky_events_foreach (GstPad * pad,
5895     GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
5896 {
5897   ForeachDispatch data;
5898
5899   g_return_if_fail (GST_IS_PAD (pad));
5900   g_return_if_fail (foreach_func != NULL);
5901
5902   data.func = foreach_func;
5903   data.user_data = user_data;
5904
5905   GST_OBJECT_LOCK (pad);
5906   events_foreach (pad, foreach_dispatch_function, &data);
5907   GST_OBJECT_UNLOCK (pad);
5908 }
5909
5910 static void
5911 do_stream_status (GstPad * pad, GstStreamStatusType type,
5912     GThread * thread, GstTask * task)
5913 {
5914   GstElement *parent;
5915
5916   GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5917
5918   if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5919     if (GST_IS_ELEMENT (parent)) {
5920       GstMessage *message;
5921       GValue value = { 0 };
5922
5923       if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5924         gchar *tname, *ename, *pname;
5925
5926         /* create a good task name */
5927         ename = gst_element_get_name (parent);
5928         pname = gst_pad_get_name (pad);
5929         tname = g_strdup_printf ("%s:%s", ename, pname);
5930         g_free (ename);
5931         g_free (pname);
5932
5933         gst_object_set_name (GST_OBJECT_CAST (task), tname);
5934         g_free (tname);
5935       }
5936
5937       message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5938           type, parent);
5939
5940       g_value_init (&value, GST_TYPE_TASK);
5941       g_value_set_object (&value, task);
5942       gst_message_set_stream_status_object (message, &value);
5943       g_value_unset (&value);
5944
5945       GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5946       gst_element_post_message (parent, message);
5947     }
5948     gst_object_unref (parent);
5949   }
5950 }
5951
5952 static void
5953 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5954 {
5955   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5956       thread, task);
5957 }
5958
5959 static void
5960 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5961 {
5962   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5963       thread, task);
5964 }
5965
5966 /**
5967  * gst_pad_start_task:
5968  * @pad: the #GstPad to start the task of
5969  * @func: the task function to call
5970  * @user_data: user data passed to the task function
5971  * @notify: called when @user_data is no longer referenced
5972  *
5973  * Starts a task that repeatedly calls @func with @user_data. This function
5974  * is mostly used in pad activation functions to start the dataflow.
5975  * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5976  * before @func is called.
5977  *
5978  * Returns: a %TRUE if the task could be started.
5979  */
5980 gboolean
5981 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer user_data,
5982     GDestroyNotify notify)
5983 {
5984   GstTask *task;
5985   gboolean res;
5986
5987   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5988   g_return_val_if_fail (func != NULL, FALSE);
5989
5990   GST_DEBUG_OBJECT (pad, "start task");
5991
5992   GST_OBJECT_LOCK (pad);
5993   task = GST_PAD_TASK (pad);
5994   if (task == NULL) {
5995     task = gst_task_new (func, user_data, notify);
5996     gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5997     gst_task_set_enter_callback (task, pad_enter_thread, pad, NULL);
5998     gst_task_set_leave_callback (task, pad_leave_thread, pad, NULL);
5999     GST_INFO_OBJECT (pad, "created task %p", task);
6000     GST_PAD_TASK (pad) = task;
6001     gst_object_ref (task);
6002     /* release lock to post the message */
6003     GST_OBJECT_UNLOCK (pad);
6004
6005     do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
6006
6007     gst_object_unref (task);
6008
6009     GST_OBJECT_LOCK (pad);
6010     /* nobody else is supposed to have changed the pad now */
6011     if (GST_PAD_TASK (pad) != task)
6012       goto concurrent_stop;
6013   }
6014   res = gst_task_set_state (task, GST_TASK_STARTED);
6015   GST_OBJECT_UNLOCK (pad);
6016
6017   return res;
6018
6019   /* ERRORS */
6020 concurrent_stop:
6021   {
6022     GST_OBJECT_UNLOCK (pad);
6023     return TRUE;
6024   }
6025 }
6026
6027 /**
6028  * gst_pad_pause_task:
6029  * @pad: the #GstPad to pause the task of
6030  *
6031  * Pause the task of @pad. This function will also wait until the
6032  * function executed by the task is finished if this function is not
6033  * called from the task function.
6034  *
6035  * Returns: a %TRUE if the task could be paused or %FALSE when the pad
6036  * has no task.
6037  */
6038 gboolean
6039 gst_pad_pause_task (GstPad * pad)
6040 {
6041   GstTask *task;
6042   gboolean res;
6043
6044   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
6045
6046   GST_DEBUG_OBJECT (pad, "pause task");
6047
6048   GST_OBJECT_LOCK (pad);
6049   task = GST_PAD_TASK (pad);
6050   if (task == NULL)
6051     goto no_task;
6052   res = gst_task_set_state (task, GST_TASK_PAUSED);
6053   GST_OBJECT_UNLOCK (pad);
6054
6055   /* wait for task function to finish, this lock is recursive so it does nothing
6056    * when the pause is called from the task itself */
6057   GST_PAD_STREAM_LOCK (pad);
6058   GST_PAD_STREAM_UNLOCK (pad);
6059
6060   return res;
6061
6062 no_task:
6063   {
6064     GST_DEBUG_OBJECT (pad, "pad has no task");
6065     GST_OBJECT_UNLOCK (pad);
6066     return FALSE;
6067   }
6068 }
6069
6070 /**
6071  * gst_pad_stop_task:
6072  * @pad: the #GstPad to stop the task of
6073  *
6074  * Stop the task of @pad. This function will also make sure that the
6075  * function executed by the task will effectively stop if not called
6076  * from the GstTaskFunction.
6077  *
6078  * This function will deadlock if called from the GstTaskFunction of
6079  * the task. Use gst_task_pause() instead.
6080  *
6081  * Regardless of whether the pad has a task, the stream lock is acquired and
6082  * released so as to ensure that streaming through this pad has finished.
6083  *
6084  * Returns: a %TRUE if the task could be stopped or %FALSE on error.
6085  */
6086 gboolean
6087 gst_pad_stop_task (GstPad * pad)
6088 {
6089   GstTask *task;
6090   gboolean res;
6091
6092   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
6093
6094   GST_DEBUG_OBJECT (pad, "stop task");
6095
6096   GST_OBJECT_LOCK (pad);
6097   task = GST_PAD_TASK (pad);
6098   if (task == NULL)
6099     goto no_task;
6100   GST_PAD_TASK (pad) = NULL;
6101   res = gst_task_set_state (task, GST_TASK_STOPPED);
6102   GST_OBJECT_UNLOCK (pad);
6103
6104   GST_PAD_STREAM_LOCK (pad);
6105   GST_PAD_STREAM_UNLOCK (pad);
6106
6107   if (!gst_task_join (task))
6108     goto join_failed;
6109
6110   gst_object_unref (task);
6111
6112   return res;
6113
6114 no_task:
6115   {
6116     GST_DEBUG_OBJECT (pad, "no task");
6117     GST_OBJECT_UNLOCK (pad);
6118
6119     GST_PAD_STREAM_LOCK (pad);
6120     GST_PAD_STREAM_UNLOCK (pad);
6121
6122     /* this is not an error */
6123     return TRUE;
6124   }
6125 join_failed:
6126   {
6127     /* this is bad, possibly the application tried to join the task from
6128      * the task's thread. We install the task again so that it will be stopped
6129      * again from the right thread next time hopefully. */
6130     GST_OBJECT_LOCK (pad);
6131     GST_DEBUG_OBJECT (pad, "join failed");
6132     /* we can only install this task if there was no other task */
6133     if (GST_PAD_TASK (pad) == NULL)
6134       GST_PAD_TASK (pad) = task;
6135     GST_OBJECT_UNLOCK (pad);
6136
6137     return FALSE;
6138   }
6139 }
6140
6141 /**
6142  * gst_pad_probe_info_get_event:
6143  * @info: a #GstPadProbeInfo
6144  *
6145  * Returns: (transfer none): The #GstEvent from the probe
6146  */
6147
6148 GstEvent *
6149 gst_pad_probe_info_get_event (GstPadProbeInfo * info)
6150 {
6151   g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM |
6152           GST_PAD_PROBE_TYPE_EVENT_UPSTREAM), NULL);
6153
6154   return GST_PAD_PROBE_INFO_EVENT (info);
6155 }
6156
6157
6158 /**
6159  * gst_pad_probe_info_get_query:
6160  * @info: a #GstPadProbeInfo
6161  *
6162  * Returns: (transfer none): The #GstQuery from the probe
6163  */
6164
6165 GstQuery *
6166 gst_pad_probe_info_get_query (GstPadProbeInfo * info)
6167 {
6168   g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM |
6169           GST_PAD_PROBE_TYPE_QUERY_UPSTREAM), NULL);
6170
6171   return GST_PAD_PROBE_INFO_QUERY (info);
6172 }
6173
6174 /**
6175  * gst_pad_probe_info_get_buffer:
6176  * @info: a #GstPadProbeInfo
6177  *
6178  * Returns: (transfer none): The #GstBuffer from the probe
6179  */
6180
6181 GstBuffer *
6182 gst_pad_probe_info_get_buffer (GstPadProbeInfo * info)
6183 {
6184   g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER, NULL);
6185
6186   return GST_PAD_PROBE_INFO_BUFFER (info);
6187 }
6188
6189 /**
6190  * gst_pad_probe_info_get_buffer_list:
6191  * @info: a #GstPadProbeInfo
6192  *
6193  * Returns: (transfer none): The #GstBufferList from the probe
6194  */
6195
6196 GstBufferList *
6197 gst_pad_probe_info_get_buffer_list (GstPadProbeInfo * info)
6198 {
6199   g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER_LIST, NULL);
6200
6201   return GST_PAD_PROBE_INFO_BUFFER_LIST (info);
6202 }
6203
6204 /**
6205  * gst_pad_get_last_flow_return:
6206  * @pad: the #GstPad
6207  *
6208  * Gets the #GstFlowReturn return from the last data passed by this pad.
6209  *
6210  * Since: 1.4
6211  */
6212 GstFlowReturn
6213 gst_pad_get_last_flow_return (GstPad * pad)
6214 {
6215   GstFlowReturn ret;
6216
6217   GST_OBJECT_LOCK (pad);
6218   ret = GST_PAD_LAST_FLOW_RETURN (pad);
6219   GST_OBJECT_UNLOCK (pad);
6220
6221   return ret;
6222 }