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