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