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