2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstpad.c: Pads for linking elements together
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.
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.
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.
24 * @short_description: Object contained by elements that allows links to
26 * @see_also: #GstPadTemplate, #GstElement, #GstEvent, #GstQuery, #GstBuffer
28 * A #GstElement is linked to other elements via "pads", which are extremely
29 * light-weight generic link points.
31 * Pads have a #GstPadDirection, source pads produce data, sink pads consume
34 * Pads are typically created from a #GstPadTemplate with
35 * gst_pad_new_from_template() and are then added to a #GstElement. This usually
36 * happens when the element is created but it can also happen dynamically based
37 * on the data that the element is processing or based on the pads that the
38 * application requests.
40 * Pads without pad templates can be created with gst_pad_new(),
41 * which takes a direction and a name as an argument. If the name is %NULL,
42 * then a guaranteed unique name will be assigned to it.
44 * A #GstElement creating a pad will typically use the various
45 * gst_pad_set_*_function() calls to register callbacks for events, queries or
46 * dataflow on the pads.
48 * gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
50 * After two pads are retrieved from an element by gst_element_get_static_pad(),
51 * the pads can be linked with gst_pad_link(). (For quick links,
52 * you can also use gst_element_link(), which will make the obvious
53 * link for you if it's straightforward.). Pads can be unlinked again with
54 * gst_pad_unlink(). gst_pad_get_peer() can be used to check what the pad is
57 * Before dataflow is possible on the pads, they need to be activated with
58 * gst_pad_set_active().
60 * gst_pad_query() and gst_pad_peer_query() can be used to query various
61 * properties of the pad and the stream.
63 * To send a #GstEvent on a pad, use gst_pad_send_event() and
64 * gst_pad_push_event(). Some events will be sticky on the pad, meaning that
65 * after they pass on the pad they can be queried later with
66 * gst_pad_get_sticky_event() and gst_pad_sticky_events_foreach().
67 * gst_pad_get_current_caps() and gst_pad_has_current_caps() are convenience
68 * functions to query the current sticky CAPS event on a pad.
70 * GstElements will use gst_pad_push() and gst_pad_pull_range() to push out
71 * or pull in a buffer.
73 * The dataflow, events and queries that happen on a pad can be monitored with
74 * probes that can be installed with gst_pad_add_probe(). gst_pad_is_blocked()
75 * can be used to check if a block probe is installed on the pad.
76 * gst_pad_is_blocking() checks if the blocking probe is currently blocking the
77 * pad. gst_pad_remove_probe() is used to remove a previously installed probe
78 * and unblock blocking probes if any.
80 * Pad have an offset that can be retrieved with gst_pad_get_offset(). This
81 * offset will be applied to the running_time of all data passing over the pad.
82 * gst_pad_set_offset() can be used to change the offset.
84 * Convenience functions exist to start, pause and stop the task on a pad with
85 * gst_pad_start_task(), gst_pad_pause_task() and gst_pad_stop_task()
89 #include "gst_private.h"
92 #include "gstpadtemplate.h"
93 #include "gstenumtypes.h"
97 #include "gsttracerutils.h"
99 #include "glib-compat-private.h"
101 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
102 #define GST_CAT_DEFAULT GST_CAT_PADS
104 /* Pad signals and args */
123 #define GST_PAD_GET_PRIVATE(obj) \
124 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PAD, GstPadPrivate))
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. */
135 struct _GstPadPrivate
142 guint probe_list_cookie;
145 /* counter of how many idle probes are running directly from the add_probe
146 * call. Used to block any data flowing in the pad while the idle callback
147 * Doesn't finish its work */
157 #define PROBE_COOKIE(h) (((GstProbe *)(h))->cookie)
158 #define GST_PAD_IS_RUNNING_IDLE_PROBE(p) \
159 (((GstPad *)(p))->priv->idle_running > 0)
164 GstPadProbeInfo *info;
172 static void gst_pad_dispose (GObject * object);
173 static void gst_pad_finalize (GObject * object);
174 static void gst_pad_set_property (GObject * object, guint prop_id,
175 const GValue * value, GParamSpec * pspec);
176 static void gst_pad_get_property (GObject * object, guint prop_id,
177 GValue * value, GParamSpec * pspec);
179 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
180 static gboolean gst_pad_activate_default (GstPad * pad, GstObject * parent);
181 static GstFlowReturn gst_pad_chain_list_default (GstPad * pad,
182 GstObject * parent, GstBufferList * list);
184 static GstFlowReturn gst_pad_send_event_unchecked (GstPad * pad,
185 GstEvent * event, GstPadProbeType type);
186 static GstFlowReturn gst_pad_push_event_unchecked (GstPad * pad,
187 GstEvent * event, GstPadProbeType type);
189 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
191 static GParamSpec *pspec_caps = NULL;
193 /* quarks for probe signals */
194 static GQuark buffer_quark;
195 static GQuark buffer_list_quark;
196 static GQuark event_quark;
205 static GstFlowQuarks flow_quarks[] = {
206 {GST_FLOW_CUSTOM_SUCCESS, "custom-success", 0},
207 {GST_FLOW_OK, "ok", 0},
208 {GST_FLOW_NOT_LINKED, "not-linked", 0},
209 {GST_FLOW_FLUSHING, "flushing", 0},
210 {GST_FLOW_EOS, "eos", 0},
211 {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
212 {GST_FLOW_ERROR, "error", 0},
213 {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
214 {GST_FLOW_CUSTOM_ERROR, "custom-error", 0}
219 * @ret: a #GstFlowReturn to get the name of.
221 * Gets a string representing the given flow return.
223 * Returns: a static string with the name of the flow return.
226 gst_flow_get_name (GstFlowReturn ret)
230 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
232 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
233 if (ret == flow_quarks[i].ret)
234 return flow_quarks[i].name;
241 * @ret: a #GstFlowReturn to get the quark of.
243 * Get the unique quark for the given GstFlowReturn.
245 * Returns: the quark associated with the flow return or 0 if an
246 * invalid return was specified.
249 gst_flow_to_quark (GstFlowReturn ret)
253 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
255 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
256 if (ret == flow_quarks[i].ret)
257 return flow_quarks[i].quark;
263 * gst_pad_link_get_name:
264 * @ret: a #GstPadLinkReturn to get the name of.
266 * Gets a string representing the given pad-link return.
268 * Returns: a static string with the name of the pad-link return.
273 gst_pad_link_get_name (GstPadLinkReturn ret)
276 case GST_PAD_LINK_OK:
278 case GST_PAD_LINK_WRONG_HIERARCHY:
279 return "wrong hierarchy";
280 case GST_PAD_LINK_WAS_LINKED:
282 case GST_PAD_LINK_WRONG_DIRECTION:
283 return "wrong direction";
284 case GST_PAD_LINK_NOFORMAT:
285 return "no common format";
286 case GST_PAD_LINK_NOSCHED:
287 return "incompatible scheduling";
288 case GST_PAD_LINK_REFUSED:
291 g_return_val_if_reached ("unknown");
298 buffer_quark = g_quark_from_static_string ("buffer"); \
299 buffer_list_quark = g_quark_from_static_string ("bufferlist"); \
300 event_quark = g_quark_from_static_string ("event"); \
302 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) { \
303 flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name); \
306 GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW", \
307 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads"); \
310 #define gst_pad_parent_class parent_class
311 G_DEFINE_TYPE_WITH_CODE (GstPad, gst_pad, GST_TYPE_OBJECT, _do_init);
314 gst_pad_class_init (GstPadClass * klass)
316 GObjectClass *gobject_class;
317 GstObjectClass *gstobject_class;
319 gobject_class = G_OBJECT_CLASS (klass);
320 gstobject_class = GST_OBJECT_CLASS (klass);
322 g_type_class_add_private (klass, sizeof (GstPadPrivate));
324 gobject_class->dispose = gst_pad_dispose;
325 gobject_class->finalize = gst_pad_finalize;
326 gobject_class->set_property = gst_pad_set_property;
327 gobject_class->get_property = gst_pad_get_property;
331 * @pad: the pad that emitted the signal
332 * @peer: the peer pad that has been connected
334 * Signals that a pad has been linked to the peer pad.
336 gst_pad_signals[PAD_LINKED] =
337 g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
338 G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
339 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
342 * @pad: the pad that emitted the signal
343 * @peer: the peer pad that has been disconnected
345 * Signals that a pad has been unlinked from the peer pad.
347 gst_pad_signals[PAD_UNLINKED] =
348 g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
349 G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
350 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
352 pspec_caps = g_param_spec_boxed ("caps", "Caps",
353 "The capabilities of the pad", GST_TYPE_CAPS,
354 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
355 g_object_class_install_property (gobject_class, PAD_PROP_CAPS, pspec_caps);
357 g_object_class_install_property (gobject_class, PAD_PROP_DIRECTION,
358 g_param_spec_enum ("direction", "Direction", "The direction of the pad",
359 GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
360 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
362 /* FIXME, Make G_PARAM_CONSTRUCT_ONLY when we fix ghostpads. */
363 g_object_class_install_property (gobject_class, PAD_PROP_TEMPLATE,
364 g_param_spec_object ("template", "Template",
365 "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
366 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
371 * The offset that will be applied to the running time of the pad.
375 g_object_class_install_property (gobject_class, PAD_PROP_OFFSET,
376 g_param_spec_int64 ("offset", "Offset",
377 "The running time offset of the pad", 0, G_MAXINT64, 0,
378 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
380 gstobject_class->path_string_separator = ".";
382 /* Register common function pointer descriptions */
383 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_activate_default);
384 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_event_default);
385 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_query_default);
386 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_iterate_internal_links_default);
387 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_chain_list_default);
391 gst_pad_init (GstPad * pad)
393 pad->priv = GST_PAD_GET_PRIVATE (pad);
395 GST_PAD_DIRECTION (pad) = GST_PAD_UNKNOWN;
397 GST_PAD_ACTIVATEFUNC (pad) = gst_pad_activate_default;
398 GST_PAD_EVENTFUNC (pad) = gst_pad_event_default;
399 GST_PAD_QUERYFUNC (pad) = gst_pad_query_default;
400 GST_PAD_ITERINTLINKFUNC (pad) = gst_pad_iterate_internal_links_default;
401 GST_PAD_CHAINLISTFUNC (pad) = gst_pad_chain_list_default;
403 GST_PAD_SET_FLUSHING (pad);
405 g_rec_mutex_init (&pad->stream_rec_lock);
407 g_cond_init (&pad->block_cond);
409 g_hook_list_init (&pad->probes, sizeof (GstProbe));
411 pad->priv->events = g_array_sized_new (FALSE, TRUE, sizeof (PadEvent), 16);
412 pad->priv->events_cookie = 0;
413 pad->priv->last_cookie = -1;
414 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
417 /* called when setting the pad inactive. It removes all sticky events from
418 * the pad. must be called with object lock */
420 remove_events (GstPad * pad)
424 gboolean notify = FALSE;
426 events = pad->priv->events;
429 for (i = 0; i < len; i++) {
430 PadEvent *ev = &g_array_index (events, PadEvent, i);
431 GstEvent *event = ev->event;
435 if (event && GST_EVENT_TYPE (event) == GST_EVENT_CAPS)
438 gst_event_unref (event);
441 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
442 g_array_set_size (events, 0);
443 pad->priv->events_cookie++;
446 GST_OBJECT_UNLOCK (pad);
448 GST_DEBUG_OBJECT (pad, "notify caps");
449 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
451 GST_OBJECT_LOCK (pad);
455 /* should be called with object lock */
457 find_event_by_type (GstPad * pad, GstEventType type, guint idx)
463 events = pad->priv->events;
466 for (i = 0; i < len; i++) {
467 ev = &g_array_index (events, PadEvent, i);
468 if (ev->event == NULL)
471 if (GST_EVENT_TYPE (ev->event) == type) {
475 } else if (GST_EVENT_TYPE (ev->event) > type) {
484 /* should be called with OBJECT lock */
486 find_event (GstPad * pad, GstEvent * event)
492 events = pad->priv->events;
495 for (i = 0; i < len; i++) {
496 ev = &g_array_index (events, PadEvent, i);
497 if (event == ev->event)
499 else if (GST_EVENT_TYPE (ev->event) > GST_EVENT_TYPE (event))
507 /* should be called with OBJECT lock */
509 remove_event_by_type (GstPad * pad, GstEventType type)
515 events = pad->priv->events;
520 ev = &g_array_index (events, PadEvent, i);
521 if (ev->event == NULL)
524 if (GST_EVENT_TYPE (ev->event) > type)
526 else if (GST_EVENT_TYPE (ev->event) != type)
529 gst_event_unref (ev->event);
530 g_array_remove_index (events, i);
532 pad->priv->events_cookie++;
540 /* check all events on srcpad against those on sinkpad. All events that are not
541 * on sinkpad are marked as received=%FALSE and the PENDING_EVENTS is set on the
542 * srcpad so that the events will be sent next time */
543 /* should be called with srcpad and sinkpad LOCKS */
545 schedule_events (GstPad * srcpad, GstPad * sinkpad)
550 gboolean pending = FALSE;
552 events = srcpad->priv->events;
555 for (i = 0; i < len; i++) {
556 ev = &g_array_index (events, PadEvent, i);
557 if (ev->event == NULL)
560 if (sinkpad == NULL || !find_event (sinkpad, ev->event)) {
561 ev->received = FALSE;
566 GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PENDING_EVENTS);
569 typedef gboolean (*PadEventFunction) (GstPad * pad, PadEvent * ev,
572 /* should be called with pad LOCK */
574 events_foreach (GstPad * pad, PadEventFunction func, gpointer user_data)
581 events = pad->priv->events;
584 cookie = pad->priv->events_cookie;
588 PadEvent *ev, ev_ret;
590 ev = &g_array_index (events, PadEvent, i);
591 if (G_UNLIKELY (ev->event == NULL))
594 /* take aditional ref, func might release the lock */
595 ev_ret.event = gst_event_ref (ev->event);
596 ev_ret.received = ev->received;
598 ret = func (pad, &ev_ret, user_data);
600 /* recheck the cookie, lock might have been released and the list could have
602 if (G_UNLIKELY (cookie != pad->priv->events_cookie)) {
603 if (G_LIKELY (ev_ret.event))
604 gst_event_unref (ev_ret.event);
608 /* store the received state */
609 ev->received = ev_ret.received;
611 /* if the event changed, we need to do something */
612 if (G_UNLIKELY (ev->event != ev_ret.event)) {
613 if (G_UNLIKELY (ev_ret.event == NULL)) {
614 /* function unreffed and set the event to NULL, remove it */
615 gst_event_unref (ev->event);
616 g_array_remove_index (events, i);
618 cookie = ++pad->priv->events_cookie;
621 /* function gave a new event for us */
622 gst_event_take (&ev->event, ev_ret.event);
625 /* just unref, nothing changed */
626 gst_event_unref (ev_ret.event);
635 /* should be called with LOCK */
637 _apply_pad_offset (GstPad * pad, GstEvent * event, gboolean upstream)
641 GST_DEBUG_OBJECT (pad, "apply pad offset %" GST_TIME_FORMAT,
642 GST_TIME_ARGS (pad->offset));
644 if (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT) {
647 g_assert (!upstream);
649 /* copy segment values */
650 gst_event_copy_segment (event, &segment);
651 gst_event_unref (event);
653 gst_segment_offset_running_time (&segment, segment.format, pad->offset);
654 event = gst_event_new_segment (&segment);
657 event = gst_event_make_writable (event);
658 offset = gst_event_get_running_time_offset (event);
660 offset -= pad->offset;
662 offset += pad->offset;
663 gst_event_set_running_time_offset (event, offset);
668 static inline GstEvent *
669 apply_pad_offset (GstPad * pad, GstEvent * event, gboolean upstream)
671 if (G_UNLIKELY (pad->offset != 0))
672 return _apply_pad_offset (pad, event, upstream);
677 /* should be called with the OBJECT_LOCK */
679 get_pad_caps (GstPad * pad)
681 GstCaps *caps = NULL;
684 ev = find_event_by_type (pad, GST_EVENT_CAPS, 0);
686 gst_event_parse_caps (ev->event, &caps);
692 gst_pad_dispose (GObject * object)
694 GstPad *pad = GST_PAD_CAST (object);
697 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pad, "dispose");
699 /* unlink the peer pad */
700 if ((peer = gst_pad_get_peer (pad))) {
701 /* window for MT unsafeness, someone else could unlink here
702 * and then we call unlink with wrong pads. The unlink
703 * function would catch this and safely return failed. */
704 if (GST_PAD_IS_SRC (pad))
705 gst_pad_unlink (pad, peer);
707 gst_pad_unlink (peer, pad);
709 gst_object_unref (peer);
712 gst_pad_set_pad_template (pad, NULL);
714 GST_OBJECT_LOCK (pad);
716 GST_OBJECT_UNLOCK (pad);
718 g_hook_list_clear (&pad->probes);
720 G_OBJECT_CLASS (parent_class)->dispose (object);
724 gst_pad_finalize (GObject * object)
726 GstPad *pad = GST_PAD_CAST (object);
729 /* in case the task is still around, clean it up */
730 if ((task = GST_PAD_TASK (pad))) {
731 gst_task_join (task);
732 GST_PAD_TASK (pad) = NULL;
733 gst_object_unref (task);
736 if (pad->activatenotify)
737 pad->activatenotify (pad->activatedata);
738 if (pad->activatemodenotify)
739 pad->activatemodenotify (pad->activatemodedata);
741 pad->linknotify (pad->linkdata);
742 if (pad->unlinknotify)
743 pad->unlinknotify (pad->unlinkdata);
744 if (pad->chainnotify)
745 pad->chainnotify (pad->chaindata);
746 if (pad->chainlistnotify)
747 pad->chainlistnotify (pad->chainlistdata);
748 if (pad->getrangenotify)
749 pad->getrangenotify (pad->getrangedata);
750 if (pad->eventnotify)
751 pad->eventnotify (pad->eventdata);
752 if (pad->querynotify)
753 pad->querynotify (pad->querydata);
754 if (pad->iterintlinknotify)
755 pad->iterintlinknotify (pad->iterintlinkdata);
757 g_rec_mutex_clear (&pad->stream_rec_lock);
758 g_cond_clear (&pad->block_cond);
759 g_array_free (pad->priv->events, TRUE);
761 G_OBJECT_CLASS (parent_class)->finalize (object);
765 gst_pad_set_property (GObject * object, guint prop_id,
766 const GValue * value, GParamSpec * pspec)
768 g_return_if_fail (GST_IS_PAD (object));
771 case PAD_PROP_DIRECTION:
772 GST_PAD_DIRECTION (object) = (GstPadDirection) g_value_get_enum (value);
774 case PAD_PROP_TEMPLATE:
775 gst_pad_set_pad_template (GST_PAD_CAST (object),
776 (GstPadTemplate *) g_value_get_object (value));
778 case PAD_PROP_OFFSET:
779 gst_pad_set_offset (GST_PAD_CAST (object), g_value_get_int64 (value));
782 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
788 gst_pad_get_property (GObject * object, guint prop_id,
789 GValue * value, GParamSpec * pspec)
791 g_return_if_fail (GST_IS_PAD (object));
795 GST_OBJECT_LOCK (object);
796 g_value_set_boxed (value, get_pad_caps (GST_PAD_CAST (object)));
797 GST_OBJECT_UNLOCK (object);
799 case PAD_PROP_DIRECTION:
800 g_value_set_enum (value, GST_PAD_DIRECTION (object));
802 case PAD_PROP_TEMPLATE:
803 g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
805 case PAD_PROP_OFFSET:
806 g_value_set_int64 (value, gst_pad_get_offset (GST_PAD_CAST (object)));
809 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
816 * @name: (allow-none): the name of the new pad.
817 * @direction: the #GstPadDirection of the pad.
819 * Creates a new pad with the given name in the given direction.
820 * If name is %NULL, a guaranteed unique name (across all pads)
822 * This function makes a copy of the name so you can safely free the name.
824 * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
830 gst_pad_new (const gchar * name, GstPadDirection direction)
832 return g_object_new (GST_TYPE_PAD,
833 "name", name, "direction", direction, NULL);
837 * gst_pad_new_from_template:
838 * @templ: the pad template to use
839 * @name: (allow-none): the name of the pad
841 * Creates a new pad with the given name from the given template.
842 * If name is %NULL, a guaranteed unique name (across all pads)
844 * This function makes a copy of the name so you can safely free the name.
846 * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
850 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
852 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
854 return g_object_new (GST_TYPE_PAD,
855 "name", name, "direction", templ->direction, "template", templ, NULL);
859 * gst_pad_new_from_static_template:
860 * @templ: the #GstStaticPadTemplate to use
861 * @name: the name of the pad
863 * Creates a new pad with the given name from the given static template.
864 * If name is %NULL, a guaranteed unique name (across all pads)
866 * This function makes a copy of the name so you can safely free the name.
868 * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
872 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
876 GstPadTemplate *template;
878 template = gst_static_pad_template_get (templ);
879 pad = gst_pad_new_from_template (template, name);
880 gst_object_unref (template);
884 #define ACQUIRE_PARENT(pad, parent, label) \
886 if (G_LIKELY ((parent = GST_OBJECT_PARENT (pad)))) \
887 gst_object_ref (parent); \
888 else if (G_LIKELY (GST_PAD_NEEDS_PARENT (pad))) \
892 #define RELEASE_PARENT(parent) \
894 if (G_LIKELY (parent)) \
895 gst_object_unref (parent); \
899 * gst_pad_get_direction:
900 * @pad: a #GstPad to get the direction of.
902 * Gets the direction of the pad. The direction of the pad is
903 * decided at construction time so this function does not take
906 * Returns: the #GstPadDirection of the pad.
911 gst_pad_get_direction (GstPad * pad)
913 GstPadDirection result;
915 /* PAD_UNKNOWN is a little silly but we need some sort of
916 * error return value */
917 g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
919 result = GST_PAD_DIRECTION (pad);
925 gst_pad_activate_default (GstPad * pad, GstObject * parent)
927 return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
931 * gst_pad_mode_get_name:
932 * @mode: the pad mode
934 * Return the name of a pad mode, for use in debug messages mostly.
936 * Returns: short mnemonic for pad mode @mode
939 gst_pad_mode_get_name (GstPadMode mode)
942 case GST_PAD_MODE_NONE:
944 case GST_PAD_MODE_PUSH:
946 case GST_PAD_MODE_PULL:
955 pre_activate (GstPad * pad, GstPadMode new_mode)
958 case GST_PAD_MODE_NONE:
959 GST_OBJECT_LOCK (pad);
960 GST_DEBUG_OBJECT (pad, "setting PAD_MODE NONE, set flushing");
961 GST_PAD_SET_FLUSHING (pad);
962 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
963 GST_PAD_MODE (pad) = new_mode;
964 /* unlock blocked pads so element can resume and stop */
965 GST_PAD_BLOCK_BROADCAST (pad);
966 GST_OBJECT_UNLOCK (pad);
968 case GST_PAD_MODE_PUSH:
969 case GST_PAD_MODE_PULL:
970 GST_OBJECT_LOCK (pad);
971 GST_DEBUG_OBJECT (pad, "setting pad into %s mode, unset flushing",
972 gst_pad_mode_get_name (new_mode));
973 GST_PAD_UNSET_FLUSHING (pad);
974 pad->ABI.abi.last_flowret = GST_FLOW_OK;
975 GST_PAD_MODE (pad) = new_mode;
976 if (GST_PAD_IS_SINK (pad)) {
978 /* make sure the peer src pad sends us all events */
979 if ((peer = GST_PAD_PEER (pad))) {
980 gst_object_ref (peer);
981 GST_OBJECT_UNLOCK (pad);
983 GST_DEBUG_OBJECT (pad, "reschedule events on peer %s:%s",
984 GST_DEBUG_PAD_NAME (peer));
986 GST_OBJECT_LOCK (peer);
987 schedule_events (peer, NULL);
988 GST_OBJECT_UNLOCK (peer);
990 gst_object_unref (peer);
992 GST_OBJECT_UNLOCK (pad);
995 GST_OBJECT_UNLOCK (pad);
1002 post_activate (GstPad * pad, GstPadMode new_mode)
1005 case GST_PAD_MODE_NONE:
1006 /* ensures that streaming stops */
1007 GST_PAD_STREAM_LOCK (pad);
1008 GST_DEBUG_OBJECT (pad, "stopped streaming");
1009 GST_OBJECT_LOCK (pad);
1010 remove_events (pad);
1011 GST_OBJECT_UNLOCK (pad);
1012 GST_PAD_STREAM_UNLOCK (pad);
1014 case GST_PAD_MODE_PUSH:
1015 case GST_PAD_MODE_PULL:
1022 * gst_pad_set_active:
1023 * @pad: the #GstPad to activate or deactivate.
1024 * @active: whether or not the pad should be active.
1026 * Activates or deactivates the given pad.
1027 * Normally called from within core state change functions.
1029 * If @active, makes sure the pad is active. If it is already active, either in
1030 * push or pull mode, just return. Otherwise dispatches to the pad's activate
1031 * function to perform the actual activation.
1033 * If not @active, calls gst_pad_activate_mode() with the pad's current mode
1034 * and a %FALSE argument.
1036 * Returns: %TRUE if the operation was successful.
1041 gst_pad_set_active (GstPad * pad, gboolean active)
1045 gboolean ret = FALSE;
1047 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1049 GST_OBJECT_LOCK (pad);
1050 old = GST_PAD_MODE (pad);
1051 ACQUIRE_PARENT (pad, parent, no_parent);
1052 GST_OBJECT_UNLOCK (pad);
1055 if (old == GST_PAD_MODE_NONE) {
1056 GST_DEBUG_OBJECT (pad, "activating pad from none");
1057 ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad, parent);
1059 pad->ABI.abi.last_flowret = GST_FLOW_OK;
1061 GST_DEBUG_OBJECT (pad, "pad was active in %s mode",
1062 gst_pad_mode_get_name (old));
1066 if (old == GST_PAD_MODE_NONE) {
1067 GST_DEBUG_OBJECT (pad, "pad was inactive");
1070 GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1071 gst_pad_mode_get_name (old));
1072 ret = gst_pad_activate_mode (pad, old, FALSE);
1074 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
1078 RELEASE_PARENT (parent);
1080 if (G_UNLIKELY (!ret))
1088 GST_DEBUG_OBJECT (pad, "no parent");
1089 GST_OBJECT_UNLOCK (pad);
1094 GST_OBJECT_LOCK (pad);
1096 g_critical ("Failed to deactivate pad %s:%s, very bad",
1097 GST_DEBUG_PAD_NAME (pad));
1099 GST_WARNING_OBJECT (pad, "Failed to activate pad");
1101 GST_OBJECT_UNLOCK (pad);
1107 * gst_pad_activate_mode:
1108 * @pad: the #GstPad to activate or deactivate.
1109 * @mode: the requested activation mode
1110 * @active: whether or not the pad should be active.
1112 * Activates or deactivates the given pad in @mode via dispatching to the
1113 * pad's activatemodefunc. For use from within pad activation functions only.
1115 * If you don't know what this is, you probably don't want to call it.
1117 * Returns: %TRUE if the operation was successful.
1122 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
1124 gboolean res = FALSE;
1126 GstPadMode old, new;
1127 GstPadDirection dir;
1130 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1132 GST_OBJECT_LOCK (pad);
1133 old = GST_PAD_MODE (pad);
1134 dir = GST_PAD_DIRECTION (pad);
1135 ACQUIRE_PARENT (pad, parent, no_parent);
1136 GST_OBJECT_UNLOCK (pad);
1138 new = active ? mode : GST_PAD_MODE_NONE;
1143 if (active && old != mode && old != GST_PAD_MODE_NONE) {
1144 /* pad was activate in the wrong direction, deactivate it
1145 * and reactivate it in the requested mode */
1146 GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1147 gst_pad_mode_get_name (old));
1149 if (G_UNLIKELY (!gst_pad_activate_mode (pad, old, FALSE)))
1150 goto deactivate_failed;
1154 case GST_PAD_MODE_PULL:
1156 if (dir == GST_PAD_SINK) {
1157 if ((peer = gst_pad_get_peer (pad))) {
1158 GST_DEBUG_OBJECT (pad, "calling peer");
1159 if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
1161 gst_object_unref (peer);
1163 /* there is no peer, this is only fatal when we activate. When we
1164 * deactivate, we must assume the application has unlinked the peer and
1165 * will deactivate it eventually. */
1169 GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
1172 if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
1173 goto failure; /* Can't activate pull on a src without a
1174 getrange function */
1182 /* Mark pad as needing reconfiguration */
1184 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1185 pre_activate (pad, new);
1187 if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1188 if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1192 /* can happen for sinks of passthrough elements */
1195 post_activate (pad, new);
1197 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in %s mode",
1198 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1203 /* Clear sticky flags on deactivation */
1205 GST_OBJECT_LOCK (pad);
1206 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1207 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
1208 GST_OBJECT_UNLOCK (pad);
1212 RELEASE_PARENT (parent);
1218 GST_DEBUG_OBJECT (pad, "no parent");
1219 GST_OBJECT_UNLOCK (pad);
1224 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in %s mode",
1225 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1230 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1231 "failed to %s in switch to %s mode from %s mode",
1232 (active ? "activate" : "deactivate"), gst_pad_mode_get_name (mode),
1233 gst_pad_mode_get_name (old));
1238 GST_OBJECT_LOCK (peer);
1239 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1240 "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1241 GST_OBJECT_UNLOCK (peer);
1242 gst_object_unref (peer);
1247 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1248 "pad in pull mode");
1253 GST_OBJECT_LOCK (pad);
1254 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in %s mode",
1255 active ? "activate" : "deactivate", gst_pad_mode_get_name (mode));
1256 GST_PAD_SET_FLUSHING (pad);
1257 GST_PAD_MODE (pad) = old;
1258 GST_OBJECT_UNLOCK (pad);
1264 * gst_pad_is_active:
1265 * @pad: the #GstPad to query
1267 * Query if a pad is active
1269 * Returns: %TRUE if the pad is active.
1274 gst_pad_is_active (GstPad * pad)
1276 gboolean result = FALSE;
1278 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1280 GST_OBJECT_LOCK (pad);
1281 result = GST_PAD_IS_ACTIVE (pad);
1282 GST_OBJECT_UNLOCK (pad);
1288 cleanup_hook (GstPad * pad, GHook * hook)
1290 GstPadProbeType type;
1292 if (!G_HOOK_IS_VALID (hook))
1295 type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1297 if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1298 /* unblock when we remove the last blocking probe */
1300 GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1303 /* Might have new probes now that want to be called */
1304 GST_PAD_BLOCK_BROADCAST (pad);
1306 if (pad->num_blocked == 0) {
1307 GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1308 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1311 g_hook_destroy_link (&pad->probes, hook);
1316 * gst_pad_add_probe:
1317 * @pad: the #GstPad to add the probe to
1318 * @mask: the probe mask
1319 * @callback: #GstPadProbeCallback that will be called with notifications of
1321 * @user_data: (closure): user data passed to the callback
1322 * @destroy_data: #GDestroyNotify for user_data
1324 * Be notified of different states of pads. The provided callback is called for
1325 * every state that matches @mask.
1327 * Probes are called in groups: First GST_PAD_PROBE_TYPE_BLOCK probes are
1328 * called, then others, then finally GST_PAD_PROBE_TYPE_IDLE. The only
1329 * exception here are GST_PAD_PROBE_TYPE_IDLE probes that are called
1330 * immediately if the pad is already idle while calling gst_pad_add_probe().
1331 * In each of the groups, probes are called in the order in which they were
1334 * Returns: an id or 0 if no probe is pending. The id can be used to remove the
1335 * probe with gst_pad_remove_probe(). When using GST_PAD_PROBE_TYPE_IDLE it can
1336 * happen that the probe can be run immediately and if the probe returns
1337 * GST_PAD_PROBE_REMOVE this functions returns 0.
1342 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1343 GstPadProbeCallback callback, gpointer user_data,
1344 GDestroyNotify destroy_data)
1349 g_return_val_if_fail (GST_IS_PAD (pad), 0);
1350 g_return_val_if_fail (mask != 0, 0);
1352 GST_OBJECT_LOCK (pad);
1354 /* make a new probe */
1355 hook = g_hook_alloc (&pad->probes);
1357 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1360 /* when no contraints are given for the types, assume all types are
1362 if ((mask & GST_PAD_PROBE_TYPE_ALL_BOTH) == 0)
1363 mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1364 if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1365 mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1367 /* store our flags and other fields */
1368 hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1369 hook->func = callback;
1370 hook->data = user_data;
1371 hook->destroy = destroy_data;
1372 PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1375 g_hook_append (&pad->probes, hook);
1377 /* incremenent cookie so that the new hook get's called */
1378 pad->priv->probe_list_cookie++;
1380 /* get the id of the hook, we return this and it can be used to remove the
1382 res = hook->hook_id;
1384 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1386 if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1387 /* we have a block probe */
1389 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1390 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1391 "now %d blocking probes", pad->num_blocked);
1393 /* Might have new probes now that want to be called */
1394 GST_PAD_BLOCK_BROADCAST (pad);
1397 /* call the callback if we need to be called for idle callbacks */
1398 if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1399 if (pad->priv->using > 0) {
1400 /* the pad is in use, we can't signal the idle callback yet. Since we set the
1401 * flag above, the last thread to leave the push will do the callback. New
1402 * threads going into the push will block. */
1403 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1404 "pad is in use, delay idle callback");
1405 GST_OBJECT_UNLOCK (pad);
1407 GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1408 GstPadProbeReturn ret;
1410 /* Keep another ref, the callback could destroy the pad */
1411 gst_object_ref (pad);
1412 pad->priv->idle_running++;
1414 /* the pad is idle now, we can signal the idle callback now */
1415 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1416 "pad is idle, trigger idle callback");
1417 GST_OBJECT_UNLOCK (pad);
1419 ret = callback (pad, &info, user_data);
1421 GST_OBJECT_LOCK (pad);
1423 case GST_PAD_PROBE_REMOVE:
1424 /* remove the probe */
1425 GST_DEBUG_OBJECT (pad, "asked to remove hook");
1426 cleanup_hook (pad, hook);
1429 case GST_PAD_PROBE_DROP:
1430 GST_DEBUG_OBJECT (pad, "asked to drop item");
1432 case GST_PAD_PROBE_PASS:
1433 GST_DEBUG_OBJECT (pad, "asked to pass item");
1435 case GST_PAD_PROBE_OK:
1436 GST_DEBUG_OBJECT (pad, "probe returned OK");
1438 case GST_PAD_PROBE_HANDLED:
1439 GST_DEBUG_OBJECT (pad, "probe handled the data");
1442 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
1445 pad->priv->idle_running--;
1446 if (pad->priv->idle_running == 0) {
1447 GST_PAD_BLOCK_BROADCAST (pad);
1449 GST_OBJECT_UNLOCK (pad);
1451 gst_object_unref (pad);
1454 GST_OBJECT_UNLOCK (pad);
1460 * gst_pad_remove_probe:
1461 * @pad: the #GstPad with the probe
1462 * @id: the probe id to remove
1464 * Remove the probe with @id from @pad.
1469 gst_pad_remove_probe (GstPad * pad, gulong id)
1473 g_return_if_fail (GST_IS_PAD (pad));
1475 GST_OBJECT_LOCK (pad);
1477 hook = g_hook_get (&pad->probes, id);
1481 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1483 cleanup_hook (pad, hook);
1484 GST_OBJECT_UNLOCK (pad);
1490 GST_OBJECT_UNLOCK (pad);
1491 g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1497 * gst_pad_is_blocked:
1498 * @pad: the #GstPad to query
1500 * Checks if the pad is blocked or not. This function returns the
1501 * last requested state of the pad. It is not certain that the pad
1502 * is actually blocking at this point (see gst_pad_is_blocking()).
1504 * Returns: %TRUE if the pad is blocked.
1509 gst_pad_is_blocked (GstPad * pad)
1511 gboolean result = FALSE;
1513 g_return_val_if_fail (GST_IS_PAD (pad), result);
1515 GST_OBJECT_LOCK (pad);
1516 result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1517 GST_OBJECT_UNLOCK (pad);
1523 * gst_pad_is_blocking:
1524 * @pad: the #GstPad to query
1526 * Checks if the pad is blocking or not. This is a guaranteed state
1527 * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1529 * Returns: %TRUE if the pad is blocking.
1534 gst_pad_is_blocking (GstPad * pad)
1536 gboolean result = FALSE;
1538 g_return_val_if_fail (GST_IS_PAD (pad), result);
1540 GST_OBJECT_LOCK (pad);
1541 /* the blocking flag is only valid if the pad is not flushing */
1542 result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1543 GST_OBJECT_UNLOCK (pad);
1549 * gst_pad_needs_reconfigure:
1550 * @pad: the #GstPad to check
1552 * Check the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1553 * if the flag was set.
1555 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag is set on @pad.
1558 gst_pad_needs_reconfigure (GstPad * pad)
1560 gboolean reconfigure;
1562 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1564 GST_OBJECT_LOCK (pad);
1565 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1566 GST_DEBUG_OBJECT (pad, "peeking RECONFIGURE flag %d", reconfigure);
1567 GST_OBJECT_UNLOCK (pad);
1573 * gst_pad_check_reconfigure:
1574 * @pad: the #GstPad to check
1576 * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1577 * if the flag was set.
1579 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1582 gst_pad_check_reconfigure (GstPad * pad)
1584 gboolean reconfigure;
1586 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1588 GST_OBJECT_LOCK (pad);
1589 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1591 GST_DEBUG_OBJECT (pad, "remove RECONFIGURE flag");
1592 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1594 GST_OBJECT_UNLOCK (pad);
1600 * gst_pad_mark_reconfigure:
1601 * @pad: the #GstPad to mark
1603 * Mark a pad for needing reconfiguration. The next call to
1604 * gst_pad_check_reconfigure() will return %TRUE after this call.
1607 gst_pad_mark_reconfigure (GstPad * pad)
1609 g_return_if_fail (GST_IS_PAD (pad));
1611 GST_OBJECT_LOCK (pad);
1612 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1613 GST_OBJECT_UNLOCK (pad);
1617 * gst_pad_set_activate_function:
1619 * @f: the #GstPadActivateFunction to set.
1621 * Calls gst_pad_set_activate_function_full() with %NULL for the user_data and
1625 * gst_pad_set_activate_function_full:
1627 * @activate: the #GstPadActivateFunction to set.
1628 * @user_data: user_data passed to @notify
1629 * @notify: notify called when @activate will not be used anymore.
1631 * Sets the given activate function for @pad. The activate function will
1632 * dispatch to gst_pad_activate_mode() to perform the actual activation.
1633 * Only makes sense to set on sink pads.
1635 * Call this function if your sink pad can start a pull-based task.
1638 gst_pad_set_activate_function_full (GstPad * pad,
1639 GstPadActivateFunction activate, gpointer user_data, GDestroyNotify notify)
1641 g_return_if_fail (GST_IS_PAD (pad));
1643 if (pad->activatenotify)
1644 pad->activatenotify (pad->activatedata);
1645 GST_PAD_ACTIVATEFUNC (pad) = activate;
1646 pad->activatedata = user_data;
1647 pad->activatenotify = notify;
1649 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1650 GST_DEBUG_FUNCPTR_NAME (activate));
1654 * gst_pad_set_activatemode_function:
1656 * @f: the #GstPadActivateModeFunction to set.
1658 * Calls gst_pad_set_activatemode_function_full() with %NULL for the user_data and
1662 * gst_pad_set_activatemode_function_full:
1664 * @activatemode: the #GstPadActivateModeFunction to set.
1665 * @user_data: user_data passed to @notify
1666 * @notify: notify called when @activatemode will not be used anymore.
1668 * Sets the given activate_mode function for the pad. An activate_mode function
1669 * prepares the element for data passing.
1672 gst_pad_set_activatemode_function_full (GstPad * pad,
1673 GstPadActivateModeFunction activatemode, gpointer user_data,
1674 GDestroyNotify notify)
1676 g_return_if_fail (GST_IS_PAD (pad));
1678 if (pad->activatemodenotify)
1679 pad->activatemodenotify (pad->activatemodedata);
1680 GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1681 pad->activatemodedata = user_data;
1682 pad->activatemodenotify = notify;
1684 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1685 GST_DEBUG_FUNCPTR_NAME (activatemode));
1689 * gst_pad_set_chain_function:
1690 * @p: a sink #GstPad.
1691 * @f: the #GstPadChainFunction to set.
1693 * Calls gst_pad_set_chain_function_full() with %NULL for the user_data and
1697 * gst_pad_set_chain_function_full:
1698 * @pad: a sink #GstPad.
1699 * @chain: the #GstPadChainFunction to set.
1700 * @user_data: user_data passed to @notify
1701 * @notify: notify called when @chain will not be used anymore.
1703 * Sets the given chain function for the pad. The chain function is called to
1704 * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1707 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1708 gpointer user_data, GDestroyNotify notify)
1710 g_return_if_fail (GST_IS_PAD (pad));
1711 g_return_if_fail (GST_PAD_IS_SINK (pad));
1713 if (pad->chainnotify)
1714 pad->chainnotify (pad->chaindata);
1715 GST_PAD_CHAINFUNC (pad) = chain;
1716 pad->chaindata = user_data;
1717 pad->chainnotify = notify;
1719 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1720 GST_DEBUG_FUNCPTR_NAME (chain));
1724 * gst_pad_set_chain_list_function:
1725 * @p: a sink #GstPad.
1726 * @f: the #GstPadChainListFunction to set.
1728 * Calls gst_pad_set_chain_list_function_full() with %NULL for the user_data and
1732 * gst_pad_set_chain_list_function_full:
1733 * @pad: a sink #GstPad.
1734 * @chainlist: the #GstPadChainListFunction to set.
1735 * @user_data: user_data passed to @notify
1736 * @notify: notify called when @chainlist will not be used anymore.
1738 * Sets the given chain list function for the pad. The chainlist function is
1739 * called to process a #GstBufferList input buffer list. See
1740 * #GstPadChainListFunction for more details.
1743 gst_pad_set_chain_list_function_full (GstPad * pad,
1744 GstPadChainListFunction chainlist, gpointer user_data,
1745 GDestroyNotify notify)
1747 g_return_if_fail (GST_IS_PAD (pad));
1748 g_return_if_fail (GST_PAD_IS_SINK (pad));
1750 if (pad->chainlistnotify)
1751 pad->chainlistnotify (pad->chainlistdata);
1752 GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1753 pad->chainlistdata = user_data;
1754 pad->chainlistnotify = notify;
1756 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1757 GST_DEBUG_FUNCPTR_NAME (chainlist));
1761 * gst_pad_set_getrange_function:
1762 * @p: a source #GstPad.
1763 * @f: the #GstPadGetRangeFunction to set.
1765 * Calls gst_pad_set_getrange_function_full() with %NULL for the user_data and
1769 * gst_pad_set_getrange_function_full:
1770 * @pad: a source #GstPad.
1771 * @get: the #GstPadGetRangeFunction to set.
1772 * @user_data: user_data passed to @notify
1773 * @notify: notify called when @get will not be used anymore.
1775 * Sets the given getrange function for the pad. The getrange function is
1776 * called to produce a new #GstBuffer to start the processing pipeline. see
1777 * #GstPadGetRangeFunction for a description of the getrange function.
1780 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1781 gpointer user_data, GDestroyNotify notify)
1783 g_return_if_fail (GST_IS_PAD (pad));
1784 g_return_if_fail (GST_PAD_IS_SRC (pad));
1786 if (pad->getrangenotify)
1787 pad->getrangenotify (pad->getrangedata);
1788 GST_PAD_GETRANGEFUNC (pad) = get;
1789 pad->getrangedata = user_data;
1790 pad->getrangenotify = notify;
1792 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1793 GST_DEBUG_FUNCPTR_NAME (get));
1797 * gst_pad_set_event_function:
1798 * @p: a #GstPad of either direction.
1799 * @f: the #GstPadEventFunction to set.
1801 * Calls gst_pad_set_event_function_full() with %NULL for the user_data and
1805 * gst_pad_set_event_function_full:
1806 * @pad: a #GstPad of either direction.
1807 * @event: the #GstPadEventFunction to set.
1808 * @user_data: user_data passed to @notify
1809 * @notify: notify called when @event will not be used anymore.
1811 * Sets the given event handler for the pad.
1814 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1815 gpointer user_data, GDestroyNotify notify)
1817 g_return_if_fail (GST_IS_PAD (pad));
1819 if (pad->eventnotify)
1820 pad->eventnotify (pad->eventdata);
1821 GST_PAD_EVENTFUNC (pad) = event;
1822 pad->eventdata = user_data;
1823 pad->eventnotify = notify;
1825 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1826 GST_DEBUG_FUNCPTR_NAME (event));
1830 * gst_pad_set_query_function:
1831 * @p: a #GstPad of either direction.
1832 * @f: the #GstPadQueryFunction to set.
1834 * Calls gst_pad_set_query_function_full() with %NULL for the user_data and
1838 * gst_pad_set_query_function_full:
1839 * @pad: a #GstPad of either direction.
1840 * @query: the #GstPadQueryFunction to set.
1841 * @user_data: user_data passed to @notify
1842 * @notify: notify called when @query will not be used anymore.
1844 * Set the given query function for the pad.
1847 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1848 gpointer user_data, GDestroyNotify notify)
1850 g_return_if_fail (GST_IS_PAD (pad));
1852 if (pad->querynotify)
1853 pad->querynotify (pad->querydata);
1854 GST_PAD_QUERYFUNC (pad) = query;
1855 pad->querydata = user_data;
1856 pad->querynotify = notify;
1858 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1859 GST_DEBUG_FUNCPTR_NAME (query));
1863 * gst_pad_set_iterate_internal_links_function:
1864 * @p: a #GstPad of either direction.
1865 * @f: the #GstPadIterIntLinkFunction to set.
1867 * Calls gst_pad_set_iterate_internal_links_function_full() with %NULL
1868 * for the user_data and notify.
1871 * gst_pad_set_iterate_internal_links_function_full:
1872 * @pad: a #GstPad of either direction.
1873 * @iterintlink: the #GstPadIterIntLinkFunction to set.
1874 * @user_data: user_data passed to @notify
1875 * @notify: notify called when @iterintlink will not be used anymore.
1877 * Sets the given internal link iterator function for the pad.
1880 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1881 GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1882 GDestroyNotify notify)
1884 g_return_if_fail (GST_IS_PAD (pad));
1886 if (pad->iterintlinknotify)
1887 pad->iterintlinknotify (pad->iterintlinkdata);
1888 GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1889 pad->iterintlinkdata = user_data;
1890 pad->iterintlinknotify = notify;
1892 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1893 GST_DEBUG_FUNCPTR_NAME (iterintlink));
1897 * gst_pad_set_link_function:
1899 * @f: the #GstPadLinkFunction to set.
1901 * Calls gst_pad_set_link_function_full() with %NULL
1902 * for the user_data and notify.
1905 * gst_pad_set_link_function_full:
1907 * @link: the #GstPadLinkFunction to set.
1908 * @user_data: user_data passed to @notify
1909 * @notify: notify called when @link will not be used anymore.
1911 * Sets the given link function for the pad. It will be called when
1912 * the pad is linked with another pad.
1914 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1917 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1918 * cannot be made for some reason.
1920 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1921 * of the peer sink pad, if present.
1924 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1925 gpointer user_data, GDestroyNotify notify)
1927 g_return_if_fail (GST_IS_PAD (pad));
1929 if (pad->linknotify)
1930 pad->linknotify (pad->linkdata);
1931 GST_PAD_LINKFUNC (pad) = link;
1932 pad->linkdata = user_data;
1933 pad->linknotify = notify;
1935 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1936 GST_DEBUG_FUNCPTR_NAME (link));
1940 * gst_pad_set_unlink_function:
1942 * @f: the #GstPadUnlinkFunction to set.
1944 * Calls gst_pad_set_unlink_function_full() with %NULL
1945 * for the user_data and notify.
1948 * gst_pad_set_unlink_function_full:
1950 * @unlink: the #GstPadUnlinkFunction to set.
1951 * @user_data: user_data passed to @notify
1952 * @notify: notify called when @unlink will not be used anymore.
1954 * Sets the given unlink function for the pad. It will be called
1955 * when the pad is unlinked.
1958 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
1959 gpointer user_data, GDestroyNotify notify)
1961 g_return_if_fail (GST_IS_PAD (pad));
1963 if (pad->unlinknotify)
1964 pad->unlinknotify (pad->unlinkdata);
1965 GST_PAD_UNLINKFUNC (pad) = unlink;
1966 pad->unlinkdata = user_data;
1967 pad->unlinknotify = notify;
1969 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1970 GST_DEBUG_FUNCPTR_NAME (unlink));
1975 * @srcpad: the source #GstPad to unlink.
1976 * @sinkpad: the sink #GstPad to unlink.
1978 * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1979 * signal on both pads.
1981 * Returns: %TRUE if the pads were unlinked. This function returns %FALSE if
1982 * the pads were not linked together.
1987 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1989 gboolean result = FALSE;
1990 GstElement *parent = NULL;
1992 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1993 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1994 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1995 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1997 GST_TRACER_PAD_UNLINK_PRE (srcpad, sinkpad);
1999 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
2000 GST_DEBUG_PAD_NAME (srcpad), srcpad,
2001 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
2003 /* We need to notify the parent before taking any pad locks as the bin in
2004 * question might be waiting for a lock on the pad while holding its lock
2005 * that our message will try to take. */
2006 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
2007 if (GST_IS_ELEMENT (parent)) {
2008 gst_element_post_message (parent,
2009 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2010 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
2012 gst_object_unref (parent);
2017 GST_OBJECT_LOCK (srcpad);
2018 GST_OBJECT_LOCK (sinkpad);
2020 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
2021 goto not_linked_together;
2023 if (GST_PAD_UNLINKFUNC (srcpad)) {
2024 GstObject *tmpparent;
2026 ACQUIRE_PARENT (srcpad, tmpparent, no_src_parent);
2028 GST_PAD_UNLINKFUNC (srcpad) (srcpad, tmpparent);
2029 RELEASE_PARENT (tmpparent);
2032 if (GST_PAD_UNLINKFUNC (sinkpad)) {
2033 GstObject *tmpparent;
2035 ACQUIRE_PARENT (sinkpad, tmpparent, no_sink_parent);
2037 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad, tmpparent);
2038 RELEASE_PARENT (tmpparent);
2042 /* first clear peers */
2043 GST_PAD_PEER (srcpad) = NULL;
2044 GST_PAD_PEER (sinkpad) = NULL;
2046 GST_OBJECT_UNLOCK (sinkpad);
2047 GST_OBJECT_UNLOCK (srcpad);
2049 /* fire off a signal to each of the pads telling them
2050 * that they've been unlinked */
2051 g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
2052 g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
2054 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
2055 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2060 if (parent != NULL) {
2061 gst_element_post_message (parent,
2062 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2063 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
2064 gst_object_unref (parent);
2066 GST_TRACER_PAD_UNLINK_POST (srcpad, sinkpad, result);
2070 not_linked_together:
2072 /* we do not emit a warning in this case because unlinking cannot
2073 * be made MT safe.*/
2074 GST_OBJECT_UNLOCK (sinkpad);
2075 GST_OBJECT_UNLOCK (srcpad);
2081 * gst_pad_is_linked:
2082 * @pad: pad to check
2084 * Checks if a @pad is linked to another pad or not.
2086 * Returns: %TRUE if the pad is linked, %FALSE otherwise.
2091 gst_pad_is_linked (GstPad * pad)
2095 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2097 GST_OBJECT_LOCK (pad);
2098 result = (GST_PAD_PEER (pad) != NULL);
2099 GST_OBJECT_UNLOCK (pad);
2104 /* get the caps from both pads and see if the intersection
2107 * This function should be called with the pad LOCK on both
2111 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
2112 GstPadLinkCheck flags)
2114 GstCaps *srccaps = NULL;
2115 GstCaps *sinkcaps = NULL;
2116 gboolean compatible = FALSE;
2118 if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
2121 /* Doing the expensive caps checking takes priority over only checking the template caps */
2122 if (flags & GST_PAD_LINK_CHECK_CAPS) {
2123 GST_OBJECT_UNLOCK (sink);
2124 GST_OBJECT_UNLOCK (src);
2126 srccaps = gst_pad_query_caps (src, NULL);
2127 sinkcaps = gst_pad_query_caps (sink, NULL);
2129 GST_OBJECT_LOCK (src);
2130 GST_OBJECT_LOCK (sink);
2132 /* If one of the two pads doesn't have a template, consider the intersection
2134 if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
2135 || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
2139 srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
2141 gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
2144 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
2146 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
2149 /* if we have caps on both pads we can check the intersection. If one
2150 * of the caps is %NULL, we return %TRUE. */
2151 if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
2153 gst_caps_unref (srccaps);
2155 gst_caps_unref (sinkcaps);
2159 compatible = gst_caps_can_intersect (srccaps, sinkcaps);
2160 gst_caps_unref (srccaps);
2161 gst_caps_unref (sinkcaps);
2164 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
2165 (compatible ? "" : "not "));
2170 /* check if the grandparents of both pads are the same.
2171 * This check is required so that we don't try to link
2172 * pads from elements in different bins without ghostpads.
2174 * The LOCK should be held on both pads
2177 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
2179 GstObject *psrc, *psink;
2181 psrc = GST_OBJECT_PARENT (src);
2182 psink = GST_OBJECT_PARENT (sink);
2184 /* if one of the pads has no parent, we allow the link */
2185 if (G_UNLIKELY (psrc == NULL || psink == NULL))
2188 /* only care about parents that are elements */
2189 if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
2190 goto no_element_parent;
2192 /* if the parents are the same, we have a loop */
2193 if (G_UNLIKELY (psrc == psink))
2196 /* if they both have a parent, we check the grandparents. We can not lock
2197 * the parent because we hold on the child (pad) and the locking order is
2198 * parent >> child. */
2199 psrc = GST_OBJECT_PARENT (psrc);
2200 psink = GST_OBJECT_PARENT (psink);
2202 /* if they have grandparents but they are not the same */
2203 if (G_UNLIKELY (psrc != psink))
2204 goto wrong_grandparents;
2211 GST_CAT_DEBUG (GST_CAT_CAPS,
2212 "one of the pads has no parent %" GST_PTR_FORMAT " and %"
2213 GST_PTR_FORMAT, psrc, psink);
2218 GST_CAT_DEBUG (GST_CAT_CAPS,
2219 "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
2220 GST_PTR_FORMAT, psrc, psink);
2225 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
2231 GST_CAT_DEBUG (GST_CAT_CAPS,
2232 "pads have different grandparents %" GST_PTR_FORMAT " and %"
2233 GST_PTR_FORMAT, psrc, psink);
2238 /* FIXME leftover from an attempt at refactoring... */
2239 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
2240 * the two pads will be locked in the srcpad, sinkpad order. */
2241 static GstPadLinkReturn
2242 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2244 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2245 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2247 GST_OBJECT_LOCK (srcpad);
2249 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
2250 goto src_was_linked;
2252 GST_OBJECT_LOCK (sinkpad);
2254 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
2255 goto sink_was_linked;
2257 /* check hierarchy, pads can only be linked if the grandparents
2259 if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
2260 && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
2261 goto wrong_hierarchy;
2263 /* check pad caps for non-empty intersection */
2264 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
2267 /* FIXME check pad scheduling for non-empty intersection */
2269 return GST_PAD_LINK_OK;
2273 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
2274 GST_DEBUG_PAD_NAME (srcpad),
2275 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
2276 /* we do not emit a warning in this case because unlinking cannot
2277 * be made MT safe.*/
2278 GST_OBJECT_UNLOCK (srcpad);
2279 return GST_PAD_LINK_WAS_LINKED;
2283 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
2284 GST_DEBUG_PAD_NAME (sinkpad),
2285 GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
2286 /* we do not emit a warning in this case because unlinking cannot
2287 * be made MT safe.*/
2288 GST_OBJECT_UNLOCK (sinkpad);
2289 GST_OBJECT_UNLOCK (srcpad);
2290 return GST_PAD_LINK_WAS_LINKED;
2294 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
2295 GST_OBJECT_UNLOCK (sinkpad);
2296 GST_OBJECT_UNLOCK (srcpad);
2297 return GST_PAD_LINK_WRONG_HIERARCHY;
2301 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
2302 GST_OBJECT_UNLOCK (sinkpad);
2303 GST_OBJECT_UNLOCK (srcpad);
2304 return GST_PAD_LINK_NOFORMAT;
2310 * @srcpad: the source #GstPad.
2311 * @sinkpad: the sink #GstPad.
2313 * Checks if the source pad and the sink pad are compatible so they can be
2316 * Returns: %TRUE if the pads can be linked.
2319 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2321 GstPadLinkReturn result;
2323 /* generic checks */
2324 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2325 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2327 GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
2328 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2330 /* gst_pad_link_prepare does everything for us, we only release the locks
2331 * on the pads that it gets us. If this function returns !OK the locks are not
2333 result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2334 if (result != GST_PAD_LINK_OK)
2337 GST_OBJECT_UNLOCK (srcpad);
2338 GST_OBJECT_UNLOCK (sinkpad);
2341 return result == GST_PAD_LINK_OK;
2345 * gst_pad_link_full:
2346 * @srcpad: the source #GstPad to link.
2347 * @sinkpad: the sink #GstPad to link.
2348 * @flags: the checks to validate when linking
2350 * Links the source pad and the sink pad.
2352 * This variant of #gst_pad_link provides a more granular control on the
2353 * checks being done when linking. While providing some considerable speedups
2354 * the caller of this method must be aware that wrong usage of those flags
2355 * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
2356 * for more information.
2360 * Returns: A result code indicating if the connection worked or
2364 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2366 GstPadLinkReturn result;
2368 GstPadLinkFunction srcfunc, sinkfunc;
2370 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2371 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2372 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2373 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2374 GST_PAD_LINK_WRONG_DIRECTION);
2376 /* Notify the parent early. See gst_pad_unlink for details. */
2377 if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2378 if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2379 gst_element_post_message (parent,
2380 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2381 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2383 gst_object_unref (parent);
2388 /* prepare will also lock the two pads */
2389 result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2391 if (G_UNLIKELY (result != GST_PAD_LINK_OK)) {
2392 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2393 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2394 gst_pad_link_get_name (result));
2398 /* must set peers before calling the link function */
2399 GST_PAD_PEER (srcpad) = sinkpad;
2400 GST_PAD_PEER (sinkpad) = srcpad;
2402 /* check events, when something is different, mark pending */
2403 schedule_events (srcpad, sinkpad);
2405 /* get the link functions */
2406 srcfunc = GST_PAD_LINKFUNC (srcpad);
2407 sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2409 if (G_UNLIKELY (srcfunc || sinkfunc)) {
2410 /* custom link functions, execute them */
2411 GST_OBJECT_UNLOCK (sinkpad);
2412 GST_OBJECT_UNLOCK (srcpad);
2415 GstObject *tmpparent;
2417 ACQUIRE_PARENT (srcpad, tmpparent, no_parent);
2418 /* this one will call the peer link function */
2419 result = srcfunc (srcpad, tmpparent, sinkpad);
2420 RELEASE_PARENT (tmpparent);
2421 } else if (sinkfunc) {
2422 GstObject *tmpparent;
2424 ACQUIRE_PARENT (sinkpad, tmpparent, no_parent);
2425 /* if no source link function, we need to call the sink link
2426 * function ourselves. */
2427 result = sinkfunc (sinkpad, tmpparent, srcpad);
2428 RELEASE_PARENT (tmpparent);
2432 GST_OBJECT_LOCK (srcpad);
2433 GST_OBJECT_LOCK (sinkpad);
2435 /* we released the lock, check if the same pads are linked still */
2436 if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2437 goto concurrent_link;
2439 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2442 GST_OBJECT_UNLOCK (sinkpad);
2443 GST_OBJECT_UNLOCK (srcpad);
2445 /* fire off a signal to each of the pads telling them
2446 * that they've been linked */
2447 g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2448 g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2450 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2451 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2453 gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2456 if (G_LIKELY (parent)) {
2457 gst_element_post_message (parent,
2458 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2459 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2460 gst_object_unref (parent);
2468 GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2469 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2470 GST_OBJECT_UNLOCK (sinkpad);
2471 GST_OBJECT_UNLOCK (srcpad);
2473 /* The other link operation succeeded first */
2474 result = GST_PAD_LINK_WAS_LINKED;
2479 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2480 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2481 gst_pad_link_get_name (result));
2483 GST_PAD_PEER (srcpad) = NULL;
2484 GST_PAD_PEER (sinkpad) = NULL;
2486 GST_OBJECT_UNLOCK (sinkpad);
2487 GST_OBJECT_UNLOCK (srcpad);
2495 * @srcpad: the source #GstPad to link.
2496 * @sinkpad: the sink #GstPad to link.
2498 * Links the source pad and the sink pad.
2500 * Returns: A result code indicating if the connection worked or
2506 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2508 GstPadLinkReturn ret;
2510 GST_TRACER_PAD_LINK_PRE (srcpad, sinkpad);
2511 ret = gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2512 GST_TRACER_PAD_LINK_POST (srcpad, sinkpad, ret);
2518 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2520 GstPadTemplate **template_p;
2522 /* this function would need checks if it weren't static */
2524 GST_OBJECT_LOCK (pad);
2525 template_p = &pad->padtemplate;
2526 gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2527 GST_OBJECT_UNLOCK (pad);
2530 gst_pad_template_pad_created (templ, pad);
2534 * gst_pad_get_pad_template:
2537 * Gets the template for @pad.
2539 * Returns: (transfer full) (nullable): the #GstPadTemplate from which
2540 * this pad was instantiated, or %NULL if this pad has no
2541 * template. Unref after usage.
2544 gst_pad_get_pad_template (GstPad * pad)
2546 GstPadTemplate *templ;
2548 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2550 templ = GST_PAD_PAD_TEMPLATE (pad);
2552 return (templ ? gst_object_ref (templ) : NULL);
2556 * gst_pad_has_current_caps:
2557 * @pad: a #GstPad to check
2559 * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2561 * Returns: %TRUE when @pad has caps associated with it.
2564 gst_pad_has_current_caps (GstPad * pad)
2569 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2571 GST_OBJECT_LOCK (pad);
2572 caps = get_pad_caps (pad);
2573 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2574 "check current pad caps %" GST_PTR_FORMAT, caps);
2575 result = (caps != NULL);
2576 GST_OBJECT_UNLOCK (pad);
2582 * gst_pad_get_current_caps:
2583 * @pad: a #GstPad to get the current capabilities of.
2585 * Gets the capabilities currently configured on @pad with the last
2586 * #GST_EVENT_CAPS event.
2588 * Returns: the current caps of the pad with incremented ref-count.
2591 gst_pad_get_current_caps (GstPad * pad)
2595 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2597 GST_OBJECT_LOCK (pad);
2598 if ((result = get_pad_caps (pad)))
2599 gst_caps_ref (result);
2600 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2601 "get current pad caps %" GST_PTR_FORMAT, result);
2602 GST_OBJECT_UNLOCK (pad);
2608 * gst_pad_get_pad_template_caps:
2609 * @pad: a #GstPad to get the template capabilities from.
2611 * Gets the capabilities for @pad's template.
2613 * Returns: (transfer full): the #GstCaps of this pad template.
2614 * Unref after usage.
2617 gst_pad_get_pad_template_caps (GstPad * pad)
2619 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2621 if (GST_PAD_PAD_TEMPLATE (pad))
2622 return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2624 return gst_caps_ref (GST_CAPS_ANY);
2629 * @pad: a #GstPad to get the peer of.
2631 * Gets the peer of @pad. This function refs the peer pad so
2632 * you need to unref it after use.
2634 * Returns: (transfer full): the peer #GstPad. Unref after usage.
2639 gst_pad_get_peer (GstPad * pad)
2643 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2645 GST_OBJECT_LOCK (pad);
2646 result = GST_PAD_PEER (pad);
2648 gst_object_ref (result);
2649 GST_OBJECT_UNLOCK (pad);
2655 * gst_pad_get_allowed_caps:
2658 * Gets the capabilities of the allowed media types that can flow through
2659 * @pad and its peer.
2661 * The allowed capabilities is calculated as the intersection of the results of
2662 * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2663 * on the resulting caps.
2665 * Returns: (transfer full) (nullable): the allowed #GstCaps of the
2666 * pad link. Unref the caps when you no longer need it. This
2667 * function returns %NULL when @pad has no peer.
2672 gst_pad_get_allowed_caps (GstPad * pad)
2675 GstCaps *caps = NULL;
2678 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2680 GST_OBJECT_LOCK (pad);
2681 if (G_UNLIKELY (GST_PAD_PEER (pad) == NULL))
2683 GST_OBJECT_UNLOCK (pad);
2685 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2687 mycaps = gst_pad_query_caps (pad, NULL);
2689 /* Query peer caps */
2690 query = gst_query_new_caps (mycaps);
2691 gst_pad_peer_query (pad, query);
2692 gst_query_parse_caps_result (query, &caps);
2693 gst_caps_ref (caps);
2694 gst_query_unref (query);
2696 gst_caps_unref (mycaps);
2698 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2705 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2706 GST_OBJECT_UNLOCK (pad);
2713 * gst_pad_iterate_internal_links_default:
2714 * @pad: the #GstPad to get the internal links of.
2715 * @parent: (allow-none): the parent of @pad or %NULL
2717 * Iterate the list of pads to which the given pad is linked to inside of
2718 * the parent element.
2719 * This is the default handler, and thus returns an iterator of all of the
2720 * pads inside the parent element with opposite direction.
2722 * The caller must free this iterator after use with gst_iterator_free().
2724 * Returns: (nullable): a #GstIterator of #GstPad, or %NULL if @pad
2725 * has no parent. Unref each returned pad with gst_object_unref().
2728 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2735 GstElement *eparent;
2737 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2739 if (parent != NULL && GST_IS_ELEMENT (parent)) {
2740 eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2742 GST_OBJECT_LOCK (pad);
2743 eparent = GST_PAD_PARENT (pad);
2744 if (!eparent || !GST_IS_ELEMENT (eparent))
2747 gst_object_ref (eparent);
2748 GST_OBJECT_UNLOCK (pad);
2751 if (pad->direction == GST_PAD_SRC)
2752 padlist = &eparent->sinkpads;
2754 padlist = &eparent->srcpads;
2756 GST_DEBUG_OBJECT (pad, "Making iterator");
2758 cookie = &eparent->pads_cookie;
2760 lock = GST_OBJECT_GET_LOCK (eparent);
2762 res = gst_iterator_new_list (GST_TYPE_PAD,
2763 lock, cookie, padlist, (GObject *) owner, NULL);
2765 gst_object_unref (owner);
2772 GST_OBJECT_UNLOCK (pad);
2773 GST_DEBUG_OBJECT (pad, "no parent element");
2779 * gst_pad_iterate_internal_links:
2780 * @pad: the GstPad to get the internal links of.
2782 * Gets an iterator for the pads to which the given pad is linked to inside
2783 * of the parent element.
2785 * Each #GstPad element yielded by the iterator will have its refcount increased,
2786 * so unref after use.
2788 * Free-function: gst_iterator_free
2790 * Returns: (transfer full) (nullable): a new #GstIterator of #GstPad
2791 * or %NULL when the pad does not have an iterator function
2792 * configured. Use gst_iterator_free() after usage.
2795 gst_pad_iterate_internal_links (GstPad * pad)
2797 GstIterator *res = NULL;
2800 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2802 GST_OBJECT_LOCK (pad);
2803 ACQUIRE_PARENT (pad, parent, no_parent);
2804 GST_OBJECT_UNLOCK (pad);
2806 if (GST_PAD_ITERINTLINKFUNC (pad))
2807 res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2809 RELEASE_PARENT (parent);
2816 GST_DEBUG_OBJECT (pad, "no parent");
2817 GST_OBJECT_UNLOCK (pad);
2825 * @forward: (scope call): a #GstPadForwardFunction
2826 * @user_data: user data passed to @forward
2828 * Calls @forward for all internally linked pads of @pad. This function deals with
2829 * dynamically changing internal pads and will make sure that the @forward
2830 * function is only called once for each pad.
2832 * When @forward returns %TRUE, no further pads will be processed.
2834 * Returns: %TRUE if one of the dispatcher functions returned %TRUE.
2837 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2840 gboolean result = FALSE;
2842 gboolean done = FALSE;
2843 GValue item = { 0, };
2844 GList *pushed_pads = NULL;
2846 iter = gst_pad_iterate_internal_links (pad);
2852 switch (gst_iterator_next (iter, &item)) {
2853 case GST_ITERATOR_OK:
2857 intpad = g_value_get_object (&item);
2859 /* if already pushed, skip. FIXME, find something faster to tag pads */
2860 if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2861 g_value_reset (&item);
2865 GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2866 GST_DEBUG_PAD_NAME (intpad));
2867 done = result = forward (intpad, user_data);
2869 pushed_pads = g_list_prepend (pushed_pads, intpad);
2871 g_value_reset (&item);
2874 case GST_ITERATOR_RESYNC:
2875 /* We don't reset the result here because we don't push the event
2876 * again on pads that got the event already and because we need
2877 * to consider the result of the previous pushes */
2878 gst_iterator_resync (iter);
2880 case GST_ITERATOR_ERROR:
2881 GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2884 case GST_ITERATOR_DONE:
2889 g_value_unset (&item);
2890 gst_iterator_free (iter);
2892 g_list_free (pushed_pads);
2902 gboolean dispatched;
2906 event_forward_func (GstPad * pad, EventData * data)
2908 /* for each pad we send to, we should ref the event; it's up
2909 * to downstream to unref again when handled. */
2910 GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2911 data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2913 data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2915 data->dispatched = TRUE;
2922 * gst_pad_event_default:
2923 * @pad: a #GstPad to call the default event handler on.
2924 * @parent: (allow-none): the parent of @pad or %NULL
2925 * @event: (transfer full): the #GstEvent to handle.
2927 * Invokes the default event handler for the given pad.
2929 * The EOS event will pause the task associated with @pad before it is forwarded
2930 * to all internally linked pads,
2932 * The event is sent to all pads internally linked to @pad. This function
2933 * takes ownership of @event.
2935 * Returns: %TRUE if the event was sent successfully.
2938 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2940 gboolean result, forward = TRUE;
2942 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2943 g_return_val_if_fail (event != NULL, FALSE);
2945 GST_LOG_OBJECT (pad, "default event handler for event %" GST_PTR_FORMAT,
2948 switch (GST_EVENT_TYPE (event)) {
2949 case GST_EVENT_CAPS:
2950 forward = GST_PAD_IS_PROXY_CAPS (pad);
2961 data.dispatched = FALSE;
2962 data.result = FALSE;
2964 gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
2966 /* for sinkpads without a parent element or without internal links, nothing
2967 * will be dispatched but we still want to return TRUE. */
2968 if (data.dispatched)
2969 result = data.result;
2974 gst_event_unref (event);
2979 /* Default accept caps implementation just checks against
2980 * the allowed caps for the pad */
2982 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
2984 /* get the caps and see if it intersects to something not empty */
2985 GstCaps *caps, *allowed = NULL;
2988 GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
2990 /* first forward the query to internally linked pads when we are dealing with
2992 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2993 result = gst_pad_proxy_query_accept_caps (pad, query);
2995 allowed = gst_pad_get_pad_template_caps (pad);
3000 gst_query_parse_accept_caps (query, &caps);
3002 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
3003 "fallback ACCEPT_CAPS query, consider implementing a specialized version");
3004 if (GST_PAD_IS_ACCEPT_TEMPLATE (pad))
3005 allowed = gst_pad_get_pad_template_caps (pad);
3007 allowed = gst_pad_query_caps (pad, caps);
3011 if (GST_PAD_IS_ACCEPT_INTERSECT (pad)) {
3012 GST_DEBUG_OBJECT (pad,
3013 "allowed caps intersect %" GST_PTR_FORMAT ", caps %" GST_PTR_FORMAT,
3015 result = gst_caps_can_intersect (caps, allowed);
3017 GST_DEBUG_OBJECT (pad, "allowed caps subset %" GST_PTR_FORMAT ", caps %"
3018 GST_PTR_FORMAT, allowed, caps);
3019 result = gst_caps_is_subset (caps, allowed);
3021 gst_caps_unref (allowed);
3023 GST_DEBUG_OBJECT (pad, "no compatible caps allowed on the pad");
3026 gst_query_set_accept_caps_result (query, result);
3032 /* Default caps implementation */
3034 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
3036 GstCaps *result = NULL, *filter;
3037 GstPadTemplate *templ;
3038 gboolean fixed_caps;
3040 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "query caps %" GST_PTR_FORMAT,
3043 /* first try to proxy if we must */
3044 if (GST_PAD_IS_PROXY_CAPS (pad)) {
3045 if ((gst_pad_proxy_query_caps (pad, query))) {
3050 gst_query_parse_caps (query, &filter);
3052 /* no proxy or it failed, do default handling */
3053 fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
3055 GST_OBJECT_LOCK (pad);
3057 /* fixed caps, try the negotiated caps first */
3058 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
3059 if ((result = get_pad_caps (pad)))
3060 goto filter_done_unlock;
3063 if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
3064 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
3065 if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
3066 goto filter_done_unlock;
3070 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3071 "non-fixed pad caps: trying pad caps");
3072 /* non fixed caps, try the negotiated caps */
3073 if ((result = get_pad_caps (pad)))
3074 goto filter_done_unlock;
3077 /* this almost never happens */
3078 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
3079 result = GST_CAPS_ANY;
3082 GST_OBJECT_UNLOCK (pad);
3084 /* run the filter on the result */
3086 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3087 "using caps %p %" GST_PTR_FORMAT " with filter %p %"
3088 GST_PTR_FORMAT, result, result, filter, filter);
3089 result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
3090 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
3093 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3094 "using caps %p %" GST_PTR_FORMAT, result, result);
3095 result = gst_caps_ref (result);
3097 gst_query_set_caps_result (query, result);
3098 gst_caps_unref (result);
3104 /* Default latency implementation */
3108 GstClockTime min, max;
3112 query_latency_default_fold (const GValue * item, GValue * ret,
3115 GstPad *pad = g_value_get_object (item), *peer;
3116 LatencyFoldData *fold_data = user_data;
3118 gboolean res = FALSE;
3120 query = gst_query_new_latency ();
3122 peer = gst_pad_get_peer (pad);
3124 res = gst_pad_peer_query (pad, query);
3126 GST_LOG_OBJECT (pad, "No peer pad found, ignoring this pad");
3131 GstClockTime min, max;
3133 gst_query_parse_latency (query, &live, &min, &max);
3135 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3136 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
3139 if (min > fold_data->min)
3140 fold_data->min = min;
3142 if (fold_data->max == GST_CLOCK_TIME_NONE)
3143 fold_data->max = max;
3144 else if (max < fold_data->max)
3145 fold_data->max = max;
3147 fold_data->live = TRUE;
3150 GST_DEBUG_OBJECT (pad, "latency query failed");
3151 g_value_set_boolean (ret, FALSE);
3154 gst_query_unref (query);
3156 gst_object_unref (peer);
3162 gst_pad_query_latency_default (GstPad * pad, GstQuery * query)
3165 GstIteratorResult res;
3166 GValue ret = G_VALUE_INIT;
3168 LatencyFoldData fold_data;
3170 it = gst_pad_iterate_internal_links (pad);
3172 GST_DEBUG_OBJECT (pad, "Can't iterate internal links");
3176 g_value_init (&ret, G_TYPE_BOOLEAN);
3179 fold_data.live = FALSE;
3181 fold_data.max = GST_CLOCK_TIME_NONE;
3183 g_value_set_boolean (&ret, TRUE);
3184 res = gst_iterator_fold (it, query_latency_default_fold, &ret, &fold_data);
3186 case GST_ITERATOR_OK:
3187 g_assert_not_reached ();
3189 case GST_ITERATOR_DONE:
3191 case GST_ITERATOR_ERROR:
3192 g_value_set_boolean (&ret, FALSE);
3194 case GST_ITERATOR_RESYNC:
3195 gst_iterator_resync (it);
3198 g_assert_not_reached ();
3201 gst_iterator_free (it);
3203 query_ret = g_value_get_boolean (&ret);
3205 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3206 " max:%" G_GINT64_FORMAT, fold_data.live ? "true" : "false",
3207 fold_data.min, fold_data.max);
3209 if (fold_data.min > fold_data.max) {
3210 GST_ERROR_OBJECT (pad, "minimum latency bigger than maximum latency");
3213 gst_query_set_latency (query, fold_data.live, fold_data.min, fold_data.max);
3215 GST_LOG_OBJECT (pad, "latency query failed");
3225 gboolean dispatched;
3229 query_forward_func (GstPad * pad, QueryData * data)
3231 GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
3232 data->query, GST_QUERY_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
3234 data->result |= gst_pad_peer_query (pad, data->query);
3236 data->dispatched = TRUE;
3238 /* stop on first successful reply */
3239 return data->result;
3243 * gst_pad_query_default:
3244 * @pad: a #GstPad to call the default query handler on.
3245 * @parent: (allow-none): the parent of @pad or %NULL
3246 * @query: (transfer none): the #GstQuery to handle.
3248 * Invokes the default query handler for the given pad.
3249 * The query is sent to all pads internally linked to @pad. Note that
3250 * if there are many possible sink pads that are internally linked to
3251 * @pad, only one will be sent the query.
3252 * Multi-sinkpad elements should implement custom query handlers.
3254 * Returns: %TRUE if the query was performed successfully.
3257 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
3259 gboolean forward, ret = FALSE;
3261 switch (GST_QUERY_TYPE (query)) {
3262 case GST_QUERY_SCHEDULING:
3263 forward = GST_PAD_IS_PROXY_SCHEDULING (pad);
3265 case GST_QUERY_ALLOCATION:
3266 forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
3268 case GST_QUERY_ACCEPT_CAPS:
3269 ret = gst_pad_query_accept_caps_default (pad, query);
3272 case GST_QUERY_CAPS:
3273 ret = gst_pad_query_caps_default (pad, query);
3276 case GST_QUERY_LATENCY:
3277 ret = gst_pad_query_latency_default (pad, query);
3280 case GST_QUERY_POSITION:
3281 case GST_QUERY_SEEKING:
3282 case GST_QUERY_FORMATS:
3283 case GST_QUERY_JITTER:
3284 case GST_QUERY_RATE:
3285 case GST_QUERY_CONVERT:
3291 GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
3292 query, GST_QUERY_TYPE_NAME (query));
3298 data.dispatched = FALSE;
3299 data.result = FALSE;
3301 gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
3303 if (data.dispatched) {
3306 /* nothing dispatched, assume drained */
3307 if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
3317 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
3319 GstPad *pad = data->pad;
3320 GstPadProbeInfo *info = data->info;
3321 GstPadProbeType type, flags;
3322 GstPadProbeCallback callback;
3323 GstPadProbeReturn ret;
3324 gpointer original_data;
3326 /* if we have called this callback, do nothing */
3327 if (PROBE_COOKIE (hook) == data->cookie) {
3328 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3329 "hook %lu, cookie %u already called", hook->hook_id,
3330 PROBE_COOKIE (hook));
3334 PROBE_COOKIE (hook) = data->cookie;
3336 flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
3338 original_data = info->data;
3340 /* one of the data types for non-idle probes */
3341 if ((type & GST_PAD_PROBE_TYPE_IDLE) == 0
3342 && (flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
3344 /* one of the scheduling types */
3345 if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
3347 /* one of the blocking types must match */
3348 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
3349 (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
3351 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) == 0 &&
3352 (flags & GST_PAD_PROBE_TYPE_BLOCKING))
3354 /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
3355 if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
3356 (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
3359 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3360 "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
3361 PROBE_COOKIE (hook), flags);
3363 data->marshalled = TRUE;
3365 callback = (GstPadProbeCallback) hook->func;
3366 if (callback == NULL)
3369 info->id = hook->hook_id;
3371 GST_OBJECT_UNLOCK (pad);
3373 ret = callback (pad, info, hook->data);
3375 GST_OBJECT_LOCK (pad);
3377 if (original_data != NULL && info->data == NULL) {
3378 GST_DEBUG_OBJECT (pad, "data item in pad probe info was dropped");
3379 info->type = GST_PAD_PROBE_TYPE_INVALID;
3380 data->dropped = TRUE;
3384 case GST_PAD_PROBE_REMOVE:
3385 /* remove the probe */
3386 GST_DEBUG_OBJECT (pad, "asked to remove hook");
3387 cleanup_hook (pad, hook);
3389 case GST_PAD_PROBE_DROP:
3390 /* need to drop the data, make sure other probes don't get called
3392 GST_DEBUG_OBJECT (pad, "asked to drop item");
3393 info->type = GST_PAD_PROBE_TYPE_INVALID;
3394 data->dropped = TRUE;
3396 case GST_PAD_PROBE_HANDLED:
3397 GST_DEBUG_OBJECT (pad, "probe handled data");
3398 data->handled = TRUE;
3400 case GST_PAD_PROBE_PASS:
3401 /* inform the pad block to let things pass */
3402 GST_DEBUG_OBJECT (pad, "asked to pass item");
3405 case GST_PAD_PROBE_OK:
3406 GST_DEBUG_OBJECT (pad, "probe returned OK");
3409 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
3416 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3417 "hook %lu, cookie %u with flags 0x%08x does not match %08x",
3418 hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
3423 /* a probe that does not take or return any data */
3424 #define PROBE_NO_DATA(pad,mask,label,defaultval) \
3426 if (G_UNLIKELY (pad->num_probes)) { \
3427 GstFlowReturn pval = defaultval; \
3428 /* pass NULL as the data item */ \
3429 GstPadProbeInfo info = { mask, 0, NULL, 0, 0 }; \
3430 info.ABI.abi.flow_ret = defaultval; \
3431 ret = do_probe_callbacks (pad, &info, defaultval); \
3432 if (G_UNLIKELY (ret != pval && ret != GST_FLOW_OK)) \
3437 #define PROBE_FULL(pad,mask,data,offs,size,label,handleable,handle_label) \
3439 if (G_UNLIKELY (pad->num_probes)) { \
3440 /* pass the data item */ \
3441 GstPadProbeInfo info = { mask, 0, data, offs, size }; \
3442 info.ABI.abi.flow_ret = GST_FLOW_OK; \
3443 ret = do_probe_callbacks (pad, &info, GST_FLOW_OK); \
3444 /* store the possibly updated data item */ \
3445 data = GST_PAD_PROBE_INFO_DATA (&info); \
3446 /* if something went wrong, exit */ \
3447 if (G_UNLIKELY (ret != GST_FLOW_OK)) { \
3448 if (handleable && ret == GST_FLOW_CUSTOM_SUCCESS_1) { \
3449 ret = info.ABI.abi.flow_ret; \
3450 goto handle_label; \
3457 #define PROBE_PUSH(pad,mask,data,label) \
3458 PROBE_FULL(pad, mask, data, -1, -1, label, FALSE, label);
3459 #define PROBE_HANDLE(pad,mask,data,label,handle_label) \
3460 PROBE_FULL(pad, mask, data, -1, -1, label, TRUE, handle_label);
3461 #define PROBE_PULL(pad,mask,data,offs,size,label) \
3462 PROBE_FULL(pad, mask, data, offs, size, label, FALSE, label);
3464 static GstFlowReturn
3465 do_pad_idle_probe_wait (GstPad * pad)
3467 while (GST_PAD_IS_RUNNING_IDLE_PROBE (pad)) {
3468 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3469 "waiting idle probe to be removed");
3470 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3471 GST_PAD_BLOCK_WAIT (pad);
3472 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3473 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3475 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3476 return GST_FLOW_FLUSHING;
3481 #define PROBE_TYPE_IS_SERIALIZED(i) \
3484 (((i)->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM | \
3485 GST_PAD_PROBE_TYPE_EVENT_FLUSH)) && \
3486 GST_EVENT_IS_SERIALIZED ((i)->data)) \
3488 (((i)->type & GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM) && \
3489 GST_QUERY_IS_SERIALIZED ((i)->data)) \
3491 ((i)->type & (GST_PAD_PROBE_TYPE_BUFFER | \
3492 GST_PAD_PROBE_TYPE_BUFFER_LIST)) \
3496 static GstFlowReturn
3497 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3498 GstFlowReturn defaultval)
3507 data.handled = FALSE;
3508 data.marshalled = FALSE;
3509 data.dropped = FALSE;
3510 data.cookie = ++pad->priv->probe_cookie;
3513 (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3515 if (is_block && PROBE_TYPE_IS_SERIALIZED (info)) {
3516 if (do_pad_idle_probe_wait (pad) == GST_FLOW_FLUSHING)
3521 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3522 "do probes cookie %u", data.cookie);
3523 cookie = pad->priv->probe_list_cookie;
3525 g_hook_list_marshal (&pad->probes, TRUE,
3526 (GHookMarshaller) probe_hook_marshal, &data);
3528 /* if the list changed, call the new callbacks (they will not have their
3529 * cookie set to data.cookie */
3530 if (cookie != pad->priv->probe_list_cookie) {
3531 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3532 "probe list changed, restarting");
3536 /* the first item that dropped will stop the hooks and then we drop here */
3540 /* If one handler took care of it, let the the item pass */
3545 /* if no handler matched and we are blocking, let the item pass */
3546 if (!data.marshalled && is_block)
3549 /* At this point, all handlers returned either OK or PASS. If one handler
3550 * returned PASS, let the item pass */
3555 while (GST_PAD_IS_BLOCKED (pad)) {
3556 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3557 "we are blocked %d times", pad->num_blocked);
3559 /* we might have released the lock */
3560 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3563 /* now we block the streaming thread. It can be unlocked when we
3564 * deactivate the pad (which will also set the FLUSHING flag) or
3565 * when the pad is unblocked. A flushing event will also unblock
3566 * the pad after setting the FLUSHING flag. */
3567 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3568 "Waiting to be unblocked or set flushing");
3569 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3570 GST_PAD_BLOCK_WAIT (pad);
3571 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3572 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3574 /* if the list changed, call the new callbacks (they will not have their
3575 * cookie set to data.cookie */
3576 if (cookie != pad->priv->probe_list_cookie) {
3577 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3578 "probe list changed, restarting");
3582 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3592 GST_DEBUG_OBJECT (pad, "pad is flushing");
3593 return GST_FLOW_FLUSHING;
3597 GST_DEBUG_OBJECT (pad, "data is dropped");
3598 return GST_FLOW_CUSTOM_SUCCESS;
3602 /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3603 GST_DEBUG_OBJECT (pad, "data is passed");
3608 GST_DEBUG_OBJECT (pad, "data was handled");
3609 return GST_FLOW_CUSTOM_SUCCESS_1;
3616 * gst_pad_get_offset:
3619 * Get the offset applied to the running time of @pad. @pad has to be a source
3622 * Returns: the offset.
3625 gst_pad_get_offset (GstPad * pad)
3629 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3631 GST_OBJECT_LOCK (pad);
3632 result = pad->offset;
3633 GST_OBJECT_UNLOCK (pad);
3639 mark_event_not_received (GstPad * pad, PadEvent * ev, gpointer user_data)
3641 ev->received = FALSE;
3646 * gst_pad_set_offset:
3648 * @offset: the offset
3650 * Set the offset that will be applied to the running time of @pad.
3653 gst_pad_set_offset (GstPad * pad, gint64 offset)
3655 g_return_if_fail (GST_IS_PAD (pad));
3657 GST_OBJECT_LOCK (pad);
3658 /* if nothing changed, do nothing */
3659 if (pad->offset == offset)
3662 pad->offset = offset;
3663 GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3665 /* resend all sticky events with updated offset on next buffer push */
3666 events_foreach (pad, mark_event_not_received, NULL);
3667 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3670 GST_OBJECT_UNLOCK (pad);
3677 /* If TRUE and ret is not OK this means
3678 * that pushing the EOS event failed
3682 /* If called for an event this is
3683 * the event that would be pushed
3684 * next. Don't forward sticky events
3685 * that would come after that */
3689 /* should be called with pad LOCK */
3691 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3693 PushStickyData *data = user_data;
3694 GstEvent *event = ev->event;
3697 GST_DEBUG_OBJECT (pad, "event %s was already received",
3698 GST_EVENT_TYPE_NAME (event));
3702 /* If we're called because of an sticky event, only forward
3703 * events that would come before this new event and the
3705 if (data->event && GST_EVENT_IS_STICKY (data->event) &&
3706 GST_EVENT_TYPE (data->event) <= GST_EVENT_SEGMENT &&
3707 GST_EVENT_TYPE (data->event) < GST_EVENT_TYPE (event)) {
3708 data->ret = GST_FLOW_CUSTOM_SUCCESS_1;
3710 data->ret = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3711 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3714 switch (data->ret) {
3716 ev->received = TRUE;
3717 GST_DEBUG_OBJECT (pad, "event %s marked received",
3718 GST_EVENT_TYPE_NAME (event));
3720 case GST_FLOW_CUSTOM_SUCCESS:
3721 /* we can't assume the event is received when it was dropped */
3722 GST_DEBUG_OBJECT (pad, "event %s was dropped, mark pending",
3723 GST_EVENT_TYPE_NAME (event));
3724 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3725 data->ret = GST_FLOW_OK;
3727 case GST_FLOW_CUSTOM_SUCCESS_1:
3728 /* event was ignored and should be sent later */
3729 GST_DEBUG_OBJECT (pad, "event %s was ignored, mark pending",
3730 GST_EVENT_TYPE_NAME (event));
3731 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3732 data->ret = GST_FLOW_OK;
3734 case GST_FLOW_NOT_LINKED:
3735 /* not linked is not a problem, we are sticky so the event will be
3736 * rescheduled to be sent later on re-link, but only for non-EOS events */
3737 GST_DEBUG_OBJECT (pad, "pad was not linked, mark pending");
3738 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS) {
3739 data->ret = GST_FLOW_OK;
3740 ev->received = TRUE;
3744 GST_DEBUG_OBJECT (pad, "result %s, mark pending events",
3745 gst_flow_get_name (data->ret));
3746 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3750 if (data->ret != GST_FLOW_OK && GST_EVENT_TYPE (event) == GST_EVENT_EOS)
3751 data->was_eos = TRUE;
3753 return data->ret == GST_FLOW_OK;
3756 /* check sticky events and push them when needed. should be called
3758 static inline GstFlowReturn
3759 check_sticky (GstPad * pad, GstEvent * event)
3761 PushStickyData data = { GST_FLOW_OK, FALSE, event };
3763 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3764 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3766 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3767 events_foreach (pad, push_sticky, &data);
3769 /* If there's an EOS event we must push it downstream
3770 * even if sending a previous sticky event failed.
3771 * Otherwise the pipeline might wait forever for EOS.
3773 * Only do this if pushing another event than the EOS
3776 if (data.ret != GST_FLOW_OK && !data.was_eos) {
3777 PadEvent *ev = find_event_by_type (pad, GST_EVENT_EOS, 0);
3779 if (ev && !ev->received) {
3780 data.ret = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3781 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3782 /* the event could have been dropped. Because this can only
3783 * happen if the user asked for it, it's not an error */
3784 if (data.ret == GST_FLOW_CUSTOM_SUCCESS)
3785 data.ret = GST_FLOW_OK;
3795 * @pad: a #GstPad to invoke the default query on.
3796 * @query: (transfer none): the #GstQuery to perform.
3798 * Dispatches a query to a pad. The query should have been allocated by the
3799 * caller via one of the type-specific allocation functions. The element that
3800 * the pad belongs to is responsible for filling the query with an appropriate
3801 * response, which should then be parsed with a type-specific query parsing
3804 * Again, the caller is responsible for both the allocation and deallocation of
3805 * the query structure.
3807 * Please also note that some queries might need a running pipeline to work.
3809 * Returns: %TRUE if the query could be performed.
3812 gst_pad_query (GstPad * pad, GstQuery * query)
3815 gboolean res, serialized;
3816 GstPadQueryFunction func;
3817 GstPadProbeType type;
3820 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3821 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3823 if (GST_PAD_IS_SRC (pad)) {
3824 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3825 goto wrong_direction;
3826 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3827 } else if (GST_PAD_IS_SINK (pad)) {
3828 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3829 goto wrong_direction;
3830 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3832 goto unknown_direction;
3834 GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3835 GST_QUERY_TYPE_NAME (query));
3836 GST_TRACER_PAD_QUERY_PRE (pad, query);
3838 serialized = GST_QUERY_IS_SERIALIZED (query);
3839 if (G_UNLIKELY (serialized))
3840 GST_PAD_STREAM_LOCK (pad);
3842 GST_OBJECT_LOCK (pad);
3843 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3844 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3845 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3847 ACQUIRE_PARENT (pad, parent, no_parent);
3848 GST_OBJECT_UNLOCK (pad);
3850 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3853 res = func (pad, parent, query);
3855 RELEASE_PARENT (parent);
3857 GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3858 GST_QUERY_TYPE_NAME (query), res);
3859 GST_TRACER_PAD_QUERY_POST (pad, res, query);
3864 GST_OBJECT_LOCK (pad);
3865 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3866 GST_OBJECT_UNLOCK (pad);
3868 if (G_UNLIKELY (serialized))
3869 GST_PAD_STREAM_UNLOCK (pad);
3876 g_warning ("pad %s:%s query %s in wrong direction",
3877 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3882 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3887 GST_DEBUG_OBJECT (pad, "had no parent");
3888 GST_OBJECT_UNLOCK (pad);
3889 if (G_UNLIKELY (serialized))
3890 GST_PAD_STREAM_UNLOCK (pad);
3895 GST_DEBUG_OBJECT (pad, "had no query function");
3896 RELEASE_PARENT (parent);
3897 if (G_UNLIKELY (serialized))
3898 GST_PAD_STREAM_UNLOCK (pad);
3903 GST_DEBUG_OBJECT (pad, "query failed");
3904 if (G_UNLIKELY (serialized))
3905 GST_PAD_STREAM_UNLOCK (pad);
3910 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3911 GST_OBJECT_UNLOCK (pad);
3912 if (G_UNLIKELY (serialized))
3913 GST_PAD_STREAM_UNLOCK (pad);
3915 /* if a probe dropped without handling, we don't sent it further but assume
3916 * that the probe did not answer the query and return FALSE */
3917 if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
3927 * gst_pad_peer_query:
3928 * @pad: a #GstPad to invoke the peer query on.
3929 * @query: (transfer none): the #GstQuery to perform.
3931 * Performs gst_pad_query() on the peer of @pad.
3933 * The caller is responsible for both the allocation and deallocation of
3934 * the query structure.
3936 * Returns: %TRUE if the query could be performed. This function returns %FALSE
3937 * if @pad has no peer.
3940 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3943 GstPadProbeType type;
3944 gboolean res, serialized;
3947 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3948 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3950 if (GST_PAD_IS_SRC (pad)) {
3951 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3952 goto wrong_direction;
3953 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3954 } else if (GST_PAD_IS_SINK (pad)) {
3955 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3956 goto wrong_direction;
3957 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3959 goto unknown_direction;
3961 GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
3962 GST_QUERY_TYPE_NAME (query));
3964 serialized = GST_QUERY_IS_SERIALIZED (query);
3966 GST_OBJECT_LOCK (pad);
3967 if (GST_PAD_IS_SRC (pad) && serialized) {
3968 /* all serialized queries on the srcpad trigger push of
3970 if (check_sticky (pad, NULL) != GST_FLOW_OK)
3974 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3975 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3976 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3978 peerpad = GST_PAD_PEER (pad);
3979 if (G_UNLIKELY (peerpad == NULL))
3982 gst_object_ref (peerpad);
3983 GST_OBJECT_UNLOCK (pad);
3985 res = gst_pad_query (peerpad, query);
3987 gst_object_unref (peerpad);
3992 GST_OBJECT_LOCK (pad);
3993 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3994 GST_OBJECT_UNLOCK (pad);
4001 g_warning ("pad %s:%s query %s in wrong direction",
4002 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
4007 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4012 GST_WARNING_OBJECT (pad, "could not send sticky events");
4013 GST_OBJECT_UNLOCK (pad);
4018 GST_INFO_OBJECT (pad, "pad has no peer");
4019 GST_OBJECT_UNLOCK (pad);
4024 GST_DEBUG_OBJECT (pad, "query failed");
4029 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
4030 GST_OBJECT_UNLOCK (pad);
4032 /* if a probe dropped without handling, we don't sent it further but
4033 * assume that the probe did not answer the query and return FALSE */
4034 if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
4043 /**********************************************************************
4044 * Data passing functions
4047 /* this is the chain function that does not perform the additional argument
4048 * checking for that little extra speed.
4050 static inline GstFlowReturn
4051 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
4055 gboolean handled = FALSE;
4057 GST_PAD_STREAM_LOCK (pad);
4059 GST_OBJECT_LOCK (pad);
4060 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4063 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4066 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4069 #ifdef GST_ENABLE_EXTRA_CHECKS
4070 if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4071 if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4073 ":%s:<%s:%s> Got data flow before stream-start event",
4074 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4076 if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4078 ":%s:<%s:%s> Got data flow before segment event",
4079 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4081 pad->priv->last_cookie = pad->priv->events_cookie;
4085 PROBE_HANDLE (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped,
4088 PROBE_HANDLE (pad, type, data, probe_stopped, probe_handled);
4090 ACQUIRE_PARENT (pad, parent, no_parent);
4091 GST_OBJECT_UNLOCK (pad);
4093 /* NOTE: we read the chainfunc unlocked.
4094 * we cannot hold the lock for the pad so we might send
4095 * the data to the wrong function. This is not really a
4096 * problem since functions are assigned at creation time
4097 * and don't change that often... */
4098 if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
4099 GstPadChainFunction chainfunc;
4101 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
4104 GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4105 "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
4106 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
4108 ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
4110 GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4111 "called chainfunction &%s with buffer %p, returned %s",
4112 GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
4114 GstPadChainListFunction chainlistfunc;
4116 if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
4119 GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4120 "calling chainlistfunction &%s",
4121 GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
4123 ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
4125 GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4126 "called chainlistfunction &%s, returned %s",
4127 GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
4130 RELEASE_PARENT (parent);
4132 GST_PAD_STREAM_UNLOCK (pad);
4139 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4140 "chaining, but pad was flushing");
4141 GST_OBJECT_UNLOCK (pad);
4142 GST_PAD_STREAM_UNLOCK (pad);
4143 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4144 return GST_FLOW_FLUSHING;
4148 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "chaining, but pad was EOS");
4149 GST_OBJECT_UNLOCK (pad);
4150 GST_PAD_STREAM_UNLOCK (pad);
4151 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4152 return GST_FLOW_EOS;
4156 g_critical ("chain on pad %s:%s but it was not in push mode",
4157 GST_DEBUG_PAD_NAME (pad));
4158 GST_OBJECT_UNLOCK (pad);
4159 GST_PAD_STREAM_UNLOCK (pad);
4160 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4161 return GST_FLOW_ERROR;
4168 GST_OBJECT_UNLOCK (pad);
4169 GST_PAD_STREAM_UNLOCK (pad);
4170 /* We unref the buffer, except if the probe handled it (CUSTOM_SUCCESS_1) */
4172 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4175 case GST_FLOW_CUSTOM_SUCCESS:
4176 case GST_FLOW_CUSTOM_SUCCESS_1:
4177 GST_DEBUG_OBJECT (pad, "dropped or handled buffer");
4181 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4188 GST_DEBUG_OBJECT (pad, "No parent when chaining %" GST_PTR_FORMAT, data);
4189 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4190 GST_OBJECT_UNLOCK (pad);
4191 GST_PAD_STREAM_UNLOCK (pad);
4192 return GST_FLOW_FLUSHING;
4196 RELEASE_PARENT (parent);
4197 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4198 g_critical ("chain on pad %s:%s but it has no chainfunction",
4199 GST_DEBUG_PAD_NAME (pad));
4200 GST_PAD_STREAM_UNLOCK (pad);
4201 return GST_FLOW_NOT_SUPPORTED;
4207 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4208 * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
4211 * Chain a buffer to @pad.
4213 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4215 * If the buffer type is not acceptable for @pad (as negotiated with a
4216 * preceding GST_EVENT_CAPS event), this function returns
4217 * #GST_FLOW_NOT_NEGOTIATED.
4219 * The function proceeds calling the chain function installed on @pad (see
4220 * gst_pad_set_chain_function()) and the return value of that function is
4221 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4224 * In all cases, success or failure, the caller loses its reference to @buffer
4225 * after calling this function.
4227 * Returns: a #GstFlowReturn from the pad.
4232 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
4234 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4235 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4236 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4238 return gst_pad_chain_data_unchecked (pad,
4239 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4242 static GstFlowReturn
4243 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
4244 GstBufferList * list)
4250 GST_INFO_OBJECT (pad, "chaining each buffer in list individually");
4252 len = gst_buffer_list_length (list);
4255 for (i = 0; i < len; i++) {
4256 buffer = gst_buffer_list_get (list, i);
4258 gst_pad_chain_data_unchecked (pad,
4259 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
4260 gst_buffer_ref (buffer));
4261 if (ret != GST_FLOW_OK)
4264 gst_buffer_list_unref (list);
4270 * gst_pad_chain_list:
4271 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4272 * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
4275 * Chain a bufferlist to @pad.
4277 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4279 * If @pad was not negotiated properly with a CAPS event, this function
4280 * returns #GST_FLOW_NOT_NEGOTIATED.
4282 * The function proceeds calling the chainlist function installed on @pad (see
4283 * gst_pad_set_chain_list_function()) and the return value of that function is
4284 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4285 * chainlist function.
4287 * In all cases, success or failure, the caller loses its reference to @list
4288 * after calling this function.
4292 * Returns: a #GstFlowReturn from the pad.
4295 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
4297 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4298 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4299 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4301 return gst_pad_chain_data_unchecked (pad,
4302 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4305 static GstFlowReturn
4306 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
4310 gboolean handled = FALSE;
4312 GST_OBJECT_LOCK (pad);
4313 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4316 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4319 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4322 #ifdef GST_ENABLE_EXTRA_CHECKS
4323 if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4324 if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4326 ":%s:<%s:%s> Got data flow before stream-start event",
4327 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4329 if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4331 ":%s:<%s:%s> Got data flow before segment event",
4332 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4334 pad->priv->last_cookie = pad->priv->events_cookie;
4338 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4341 /* do block probes */
4342 PROBE_HANDLE (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped,
4345 /* recheck sticky events because the probe might have cause a relink */
4346 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4349 /* do post-blocking probes */
4350 PROBE_HANDLE (pad, type, data, probe_stopped, probe_handled);
4352 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4355 /* take ref to peer pad before releasing the lock */
4356 gst_object_ref (peer);
4358 GST_OBJECT_UNLOCK (pad);
4360 ret = gst_pad_chain_data_unchecked (peer, type, data);
4363 gst_object_unref (peer);
4365 GST_OBJECT_LOCK (pad);
4366 pad->ABI.abi.last_flowret = ret;
4368 if (pad->priv->using == 0) {
4369 /* pad is not active anymore, trigger idle callbacks */
4370 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4371 probe_stopped, ret);
4373 GST_OBJECT_UNLOCK (pad);
4377 /* ERROR recovery here */
4381 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4382 "pushing, but pad was flushing");
4383 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4384 GST_OBJECT_UNLOCK (pad);
4385 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4386 return GST_FLOW_FLUSHING;
4390 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pushing, but pad was EOS");
4391 pad->ABI.abi.last_flowret = GST_FLOW_EOS;
4392 GST_OBJECT_UNLOCK (pad);
4393 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4394 return GST_FLOW_EOS;
4398 g_critical ("pushing on pad %s:%s but it was not activated in push mode",
4399 GST_DEBUG_PAD_NAME (pad));
4400 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4401 GST_OBJECT_UNLOCK (pad);
4402 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4403 return GST_FLOW_ERROR;
4407 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4408 "error pushing events, return %s", gst_flow_get_name (ret));
4409 pad->ABI.abi.last_flowret = ret;
4410 GST_OBJECT_UNLOCK (pad);
4411 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4419 GST_OBJECT_UNLOCK (pad);
4420 if (data != NULL && !handled)
4421 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4424 case GST_FLOW_CUSTOM_SUCCESS:
4425 case GST_FLOW_CUSTOM_SUCCESS_1:
4426 GST_DEBUG_OBJECT (pad, "dropped or handled buffer");
4430 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4433 pad->ABI.abi.last_flowret = ret;
4438 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4439 "pushing, but it was not linked");
4440 pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4441 GST_OBJECT_UNLOCK (pad);
4442 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4443 return GST_FLOW_NOT_LINKED;
4449 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4450 * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
4453 * Pushes a buffer to the peer of @pad.
4455 * This function will call installed block probes before triggering any
4456 * installed data probes.
4458 * The function proceeds calling gst_pad_chain() on the peer pad and returns
4459 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4462 * In all cases, success or failure, the caller loses its reference to @buffer
4463 * after calling this function.
4465 * Returns: a #GstFlowReturn from the peer pad.
4470 gst_pad_push (GstPad * pad, GstBuffer * buffer)
4474 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4475 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4476 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4478 GST_TRACER_PAD_PUSH_PRE (pad, buffer);
4479 res = gst_pad_push_data (pad,
4480 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4481 GST_TRACER_PAD_PUSH_POST (pad, res);
4486 * gst_pad_push_list:
4487 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4488 * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
4491 * Pushes a buffer list to the peer of @pad.
4493 * This function will call installed block probes before triggering any
4494 * installed data probes.
4496 * The function proceeds calling the chain function on the peer pad and returns
4497 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4498 * be returned. If the peer pad does not have any installed chainlist function
4499 * every group buffer of the list will be merged into a normal #GstBuffer and
4500 * chained via gst_pad_chain().
4502 * In all cases, success or failure, the caller loses its reference to @list
4503 * after calling this function.
4505 * Returns: a #GstFlowReturn from the peer pad.
4510 gst_pad_push_list (GstPad * pad, GstBufferList * list)
4514 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4515 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4516 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4518 GST_TRACER_PAD_PUSH_LIST_PRE (pad, list);
4519 res = gst_pad_push_data (pad,
4520 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4521 GST_TRACER_PAD_PUSH_LIST_POST (pad, res);
4525 static GstFlowReturn
4526 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
4527 GstBuffer ** buffer)
4530 GstPadGetRangeFunction getrangefunc;
4534 GST_PAD_STREAM_LOCK (pad);
4536 GST_OBJECT_LOCK (pad);
4537 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4540 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4543 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4548 /* when one of the probes returns DROPPED, probe_stopped will be called
4549 * and we skip calling the getrange function, res_buf should then contain a
4550 * valid result buffer */
4551 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4552 res_buf, offset, size, probe_stopped);
4554 /* recheck sticky events because the probe might have cause a relink */
4555 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4558 ACQUIRE_PARENT (pad, parent, no_parent);
4559 GST_OBJECT_UNLOCK (pad);
4561 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
4564 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4565 "calling getrangefunc %s, offset %"
4566 G_GUINT64_FORMAT ", size %u",
4567 GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
4569 ret = getrangefunc (pad, parent, offset, size, &res_buf);
4571 RELEASE_PARENT (parent);
4573 GST_OBJECT_LOCK (pad);
4574 if (G_UNLIKELY (ret != GST_FLOW_OK))
4575 goto get_range_failed;
4577 /* can only fire the signal if we have a valid buffer */
4579 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4580 res_buf, offset, size, probe_stopped_unref);
4581 pad->ABI.abi.last_flowret = ret;
4582 GST_OBJECT_UNLOCK (pad);
4584 GST_PAD_STREAM_UNLOCK (pad);
4593 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4594 "getrange, but pad was flushing");
4595 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4596 GST_OBJECT_UNLOCK (pad);
4597 GST_PAD_STREAM_UNLOCK (pad);
4598 return GST_FLOW_FLUSHING;
4602 g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
4603 GST_DEBUG_PAD_NAME (pad));
4604 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4605 GST_OBJECT_UNLOCK (pad);
4606 GST_PAD_STREAM_UNLOCK (pad);
4607 return GST_FLOW_ERROR;
4611 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
4612 pad->ABI.abi.last_flowret = ret;
4613 GST_OBJECT_UNLOCK (pad);
4614 GST_PAD_STREAM_UNLOCK (pad);
4619 GST_DEBUG_OBJECT (pad, "no parent");
4620 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4621 GST_OBJECT_UNLOCK (pad);
4622 GST_PAD_STREAM_UNLOCK (pad);
4623 return GST_FLOW_FLUSHING;
4627 g_critical ("getrange on pad %s:%s but it has no getrangefunction",
4628 GST_DEBUG_PAD_NAME (pad));
4629 RELEASE_PARENT (parent);
4630 GST_PAD_STREAM_UNLOCK (pad);
4631 return GST_FLOW_NOT_SUPPORTED;
4635 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4636 "probe returned %s", gst_flow_get_name (ret));
4637 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4639 /* the probe filled the buffer and asks us to not call the getrange
4640 * anymore, we continue with the post probes then. */
4641 GST_DEBUG_OBJECT (pad, "handled buffer");
4645 /* no buffer, we are EOS */
4646 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4650 pad->ABI.abi.last_flowret = ret;
4651 GST_OBJECT_UNLOCK (pad);
4652 GST_PAD_STREAM_UNLOCK (pad);
4656 probe_stopped_unref:
4658 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4659 "probe returned %s", gst_flow_get_name (ret));
4660 /* if we drop here, it signals EOS */
4661 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4663 pad->ABI.abi.last_flowret = ret;
4664 GST_OBJECT_UNLOCK (pad);
4665 GST_PAD_STREAM_UNLOCK (pad);
4666 if (*buffer == NULL)
4667 gst_buffer_unref (res_buf);
4672 pad->ABI.abi.last_flowret = ret;
4673 GST_OBJECT_UNLOCK (pad);
4674 GST_PAD_STREAM_UNLOCK (pad);
4675 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4676 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4677 pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
4683 * gst_pad_get_range:
4684 * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4685 * @offset: The start offset of the buffer
4686 * @size: The length of the buffer
4687 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
4688 * returns #GST_FLOW_ERROR if %NULL.
4690 * When @pad is flushing this function returns #GST_FLOW_FLUSHING
4691 * immediately and @buffer is %NULL.
4693 * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4694 * description of a getrange function. If @pad has no getrange function
4695 * installed (see gst_pad_set_getrange_function()) this function returns
4696 * #GST_FLOW_NOT_SUPPORTED.
4698 * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4699 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4700 * must be freed with gst_buffer_unref() after usage.
4702 * When @buffer points to a variable that points to a valid #GstBuffer, the
4703 * buffer will be filled with the result data when this function returns
4704 * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4705 * @size bytes will be filled in the result buffer and its size will be updated
4708 * Note that less than @size bytes can be returned in @buffer when, for example,
4709 * an EOS condition is near or when @buffer is not large enough to hold @size
4710 * bytes. The caller should check the result buffer size to get the result size.
4712 * When this function returns any other result value than #GST_FLOW_OK, @buffer
4713 * will be unchanged.
4715 * This is a lowlevel function. Usually gst_pad_pull_range() is used.
4717 * Returns: a #GstFlowReturn from the pad.
4722 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4723 GstBuffer ** buffer)
4725 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4726 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4727 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4728 g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4729 && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4731 return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4735 * gst_pad_pull_range:
4736 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4737 * @offset: The start offset of the buffer
4738 * @size: The length of the buffer
4739 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4740 * GST_FLOW_ERROR if %NULL.
4742 * Pulls a @buffer from the peer pad or fills up a provided buffer.
4744 * This function will first trigger the pad block signal if it was
4747 * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4748 * function returns the result of gst_pad_get_range() on the peer pad.
4749 * See gst_pad_get_range() for a list of return values and for the
4750 * semantics of the arguments of this function.
4752 * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4753 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4754 * must be freed with gst_buffer_unref() after usage. When this function
4755 * returns any other result value, @buffer will still point to %NULL.
4757 * When @buffer points to a variable that points to a valid #GstBuffer, the
4758 * buffer will be filled with the result data when this function returns
4759 * #GST_FLOW_OK. When this function returns any other result value,
4760 * @buffer will be unchanged. If the provided buffer is larger than @size, only
4761 * @size bytes will be filled in the result buffer and its size will be updated
4764 * Note that less than @size bytes can be returned in @buffer when, for example,
4765 * an EOS condition is near or when @buffer is not large enough to hold @size
4766 * bytes. The caller should check the result buffer size to get the result size.
4768 * Returns: a #GstFlowReturn from the peer pad.
4773 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4774 GstBuffer ** buffer)
4780 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4781 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4782 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4783 g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4784 && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4786 GST_TRACER_PAD_PULL_RANGE_PRE (pad, offset, size);
4788 GST_OBJECT_LOCK (pad);
4789 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4792 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4797 /* when one of the probes returns DROPPED, probe_stopped will be
4798 * called and we skip calling the peer getrange function. *buffer should then
4799 * contain a valid buffer */
4800 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4801 res_buf, offset, size, probe_stopped);
4803 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4806 gst_object_ref (peer);
4808 GST_OBJECT_UNLOCK (pad);
4810 ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4812 gst_object_unref (peer);
4814 GST_OBJECT_LOCK (pad);
4816 pad->ABI.abi.last_flowret = ret;
4817 if (pad->priv->using == 0) {
4818 /* pad is not active anymore, trigger idle callbacks */
4819 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4820 probe_stopped_unref, ret);
4823 if (G_UNLIKELY (ret != GST_FLOW_OK))
4824 goto pull_range_failed;
4827 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4828 res_buf, offset, size, probe_stopped_unref);
4830 GST_OBJECT_UNLOCK (pad);
4834 GST_TRACER_PAD_PULL_RANGE_POST (pad, *buffer, ret);
4837 /* ERROR recovery here */
4840 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4841 "pullrange, but pad was flushing");
4842 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4843 GST_OBJECT_UNLOCK (pad);
4844 ret = GST_FLOW_FLUSHING;
4849 g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4850 GST_DEBUG_PAD_NAME (pad));
4851 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4852 GST_OBJECT_UNLOCK (pad);
4853 ret = GST_FLOW_ERROR;
4858 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4859 gst_flow_get_name (ret));
4860 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4862 /* the probe filled the buffer and asks us to not forward to the peer
4863 * anymore, we continue with the post probes then */
4864 GST_DEBUG_OBJECT (pad, "handled buffer");
4868 /* no buffer, we are EOS then */
4869 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4873 pad->ABI.abi.last_flowret = ret;
4874 GST_OBJECT_UNLOCK (pad);
4879 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4880 "pulling range, but it was not linked");
4881 pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4882 GST_OBJECT_UNLOCK (pad);
4883 ret = GST_FLOW_NOT_LINKED;
4888 pad->ABI.abi.last_flowret = ret;
4889 GST_OBJECT_UNLOCK (pad);
4890 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4891 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4892 pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4895 probe_stopped_unref:
4897 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4898 "post probe returned %s", gst_flow_get_name (ret));
4900 /* if we drop here, it signals EOS */
4901 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4904 pad->ABI.abi.last_flowret = ret;
4905 GST_OBJECT_UNLOCK (pad);
4907 if (*buffer == NULL)
4908 gst_buffer_unref (res_buf);
4912 GST_TRACER_PAD_PULL_RANGE_POST (pad, NULL, ret);
4916 /* must be called with pad object lock */
4917 static GstFlowReturn
4918 store_sticky_event (GstPad * pad, GstEvent * event)
4923 gboolean res = FALSE;
4924 const gchar *name = NULL;
4925 gboolean insert = TRUE;
4927 type = GST_EVENT_TYPE (event);
4929 /* Store all sticky events except SEGMENT/EOS when we're flushing,
4930 * otherwise they can be dropped and nothing would ever resend them.
4931 * Only do that for activated pads though, everything else is a bug!
4933 if (G_UNLIKELY (GST_PAD_MODE (pad) == GST_PAD_MODE_NONE
4934 || (GST_PAD_IS_FLUSHING (pad) && (type == GST_EVENT_SEGMENT
4935 || type == GST_EVENT_EOS))))
4938 /* Unset the EOS flag when received STREAM_START event, so pad can
4939 * store sticky event and then push it later */
4940 if (type == GST_EVENT_STREAM_START) {
4941 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4942 remove_event_by_type (pad, GST_EVENT_EOS);
4943 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
4946 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4949 if (type & GST_EVENT_TYPE_STICKY_MULTI)
4950 name = gst_structure_get_name (gst_event_get_structure (event));
4952 events = pad->priv->events;
4955 for (i = 0; i < len; i++) {
4956 PadEvent *ev = &g_array_index (events, PadEvent, i);
4958 if (ev->event == NULL)
4961 if (type == GST_EVENT_TYPE (ev->event)) {
4962 /* matching types, check matching name if needed */
4963 if (name && !gst_event_has_name (ev->event, name))
4967 if ((res = gst_event_replace (&ev->event, event)))
4968 ev->received = FALSE;
4974 if (type < GST_EVENT_TYPE (ev->event) || (type != GST_EVENT_TYPE (ev->event)
4975 && GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS)) {
4976 /* STREAM_START, CAPS and SEGMENT must be delivered in this order. By
4977 * storing the sticky ordered we can check that this is respected. */
4978 if (G_UNLIKELY (GST_EVENT_TYPE (ev->event) <= GST_EVENT_SEGMENT
4979 || GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS))
4981 ":%s:<%s:%s> Sticky event misordering, got '%s' before '%s'",
4982 G_STRFUNC, GST_DEBUG_PAD_NAME (pad),
4983 gst_event_type_get_name (GST_EVENT_TYPE (ev->event)),
4984 gst_event_type_get_name (type));
4990 ev.event = gst_event_ref (event);
4991 ev.received = FALSE;
4992 g_array_insert_val (events, i, ev);
4997 pad->priv->events_cookie++;
4998 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5000 GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
5002 switch (GST_EVENT_TYPE (event)) {
5003 case GST_EVENT_CAPS:
5004 GST_OBJECT_UNLOCK (pad);
5006 GST_DEBUG_OBJECT (pad, "notify caps");
5007 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
5009 GST_OBJECT_LOCK (pad);
5015 if (type == GST_EVENT_EOS) {
5016 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
5017 pad->ABI.abi.last_flowret = GST_FLOW_EOS;
5020 return GST_PAD_IS_FLUSHING (pad) ? GST_FLOW_FLUSHING : GST_FLOW_OK;
5025 GST_DEBUG_OBJECT (pad, "pad is flushing");
5026 return GST_FLOW_FLUSHING;
5030 GST_DEBUG_OBJECT (pad, "pad is EOS");
5031 return GST_FLOW_EOS;
5036 * gst_pad_store_sticky_event:
5038 * @event: a #GstEvent
5040 * Store the sticky @event on @pad
5042 * Returns: #GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad
5043 * was flushing or #GST_FLOW_EOS when the pad was EOS.
5048 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event)
5052 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5053 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
5055 GST_OBJECT_LOCK (pad);
5056 ret = store_sticky_event (pad, event);
5057 GST_OBJECT_UNLOCK (pad);
5063 sticky_changed (GstPad * pad, PadEvent * ev, gpointer user_data)
5065 PushStickyData *data = user_data;
5067 /* Forward all sticky events before our current one that are pending */
5068 if (ev->event != data->event
5069 && GST_EVENT_TYPE (ev->event) < GST_EVENT_TYPE (data->event))
5070 return push_sticky (pad, ev, data);
5075 /* should be called with pad LOCK */
5076 static GstFlowReturn
5077 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
5078 GstPadProbeType type)
5082 GstEventType event_type;
5084 /* pass the adjusted event on. We need to do this even if
5085 * there is no peer pad because of the probes. */
5086 event = apply_pad_offset (pad, event, GST_PAD_IS_SINK (pad));
5088 /* Two checks to be made:
5089 * . (un)set the FLUSHING flag for flushing events,
5090 * . handle pad blocking */
5091 event_type = GST_EVENT_TYPE (event);
5092 switch (event_type) {
5093 case GST_EVENT_FLUSH_START:
5094 GST_PAD_SET_FLUSHING (pad);
5096 GST_PAD_BLOCK_BROADCAST (pad);
5097 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5099 case GST_EVENT_FLUSH_STOP:
5100 if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
5103 GST_PAD_UNSET_FLUSHING (pad);
5105 /* Remove sticky EOS events */
5106 GST_LOG_OBJECT (pad, "Removing pending EOS events");
5107 remove_event_by_type (pad, GST_EVENT_EOS);
5108 remove_event_by_type (pad, GST_EVENT_SEGMENT);
5109 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5110 pad->ABI.abi.last_flowret = GST_FLOW_OK;
5112 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5116 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5119 /* No need to check for EOS here as either the caller (gst_pad_push_event())
5120 * checked already or this is called as part of pushing sticky events,
5121 * in which case we still want to forward the EOS event downstream.
5124 switch (GST_EVENT_TYPE (event)) {
5125 case GST_EVENT_RECONFIGURE:
5126 if (GST_PAD_IS_SINK (pad))
5127 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5132 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
5133 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5138 /* send probes after modifying the events above */
5139 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5141 /* recheck sticky events because the probe might have cause a relink */
5142 if (GST_PAD_HAS_PENDING_EVENTS (pad) && GST_PAD_IS_SRC (pad)
5143 && (GST_EVENT_IS_SERIALIZED (event)
5144 || GST_EVENT_IS_STICKY (event))) {
5145 PushStickyData data = { GST_FLOW_OK, FALSE, event };
5146 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5148 /* Push all sticky events before our current one
5149 * that have changed */
5150 events_foreach (pad, sticky_changed, &data);
5153 /* now check the peer pad */
5154 peerpad = GST_PAD_PEER (pad);
5155 if (peerpad == NULL)
5158 gst_object_ref (peerpad);
5160 GST_OBJECT_UNLOCK (pad);
5162 GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
5163 event, gst_event_type_get_name (event_type), peerpad);
5165 ret = gst_pad_send_event_unchecked (peerpad, event, type);
5167 /* Note: we gave away ownership of the event at this point but we can still
5168 * print the old pointer */
5169 GST_LOG_OBJECT (pad,
5170 "sent event %p (%s) to peerpad %" GST_PTR_FORMAT ", ret %s", event,
5171 gst_event_type_get_name (event_type), peerpad, gst_flow_get_name (ret));
5173 gst_object_unref (peerpad);
5175 GST_OBJECT_LOCK (pad);
5177 if (pad->priv->using == 0) {
5178 /* pad is not active anymore, trigger idle callbacks */
5179 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
5180 idle_probe_stopped, ret);
5184 /* ERROR handling */
5187 GST_DEBUG_OBJECT (pad, "We're flushing");
5188 gst_event_unref (event);
5189 return GST_FLOW_FLUSHING;
5193 GST_DEBUG_OBJECT (pad, "flush-stop on inactive pad");
5194 gst_event_unref (event);
5195 return GST_FLOW_FLUSHING;
5199 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5200 if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
5201 gst_event_unref (event);
5204 case GST_FLOW_CUSTOM_SUCCESS_1:
5205 GST_DEBUG_OBJECT (pad, "handled event");
5207 case GST_FLOW_CUSTOM_SUCCESS:
5208 GST_DEBUG_OBJECT (pad, "dropped event");
5211 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5218 GST_DEBUG_OBJECT (pad, "Dropping event %s because pad is not linked",
5219 gst_event_type_get_name (GST_EVENT_TYPE (event)));
5220 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5221 gst_event_unref (event);
5223 /* unlinked pads should not influence latency configuration */
5224 if (event_type == GST_EVENT_LATENCY)
5227 return GST_FLOW_NOT_LINKED;
5231 GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
5237 * gst_pad_push_event:
5238 * @pad: a #GstPad to push the event to.
5239 * @event: (transfer full): the #GstEvent to send to the pad.
5241 * Sends the event to the peer of the given pad. This function is
5242 * mainly used by elements to send events to their peer
5245 * This function takes ownership of the provided event so you should
5246 * gst_event_ref() it if you want to reuse the event after this call.
5248 * Returns: %TRUE if the event was handled.
5253 gst_pad_push_event (GstPad * pad, GstEvent * event)
5255 gboolean res = FALSE;
5256 GstPadProbeType type;
5257 gboolean sticky, serialized;
5259 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5260 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
5262 GST_TRACER_PAD_PUSH_EVENT_PRE (pad, event);
5264 if (GST_PAD_IS_SRC (pad)) {
5265 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5266 goto wrong_direction;
5267 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5268 } else if (GST_PAD_IS_SINK (pad)) {
5269 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5270 goto wrong_direction;
5271 /* events pushed on sinkpad never are sticky */
5272 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5274 goto unknown_direction;
5276 GST_OBJECT_LOCK (pad);
5277 sticky = GST_EVENT_IS_STICKY (event);
5278 serialized = GST_EVENT_IS_SERIALIZED (event);
5281 /* srcpad sticky events are stored immediately, the received flag is set
5282 * to FALSE and will be set to TRUE when we can successfully push the
5283 * event to the peer pad */
5284 switch (store_sticky_event (pad, event)) {
5285 case GST_FLOW_FLUSHING:
5293 if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
5294 /* all serialized or sticky events on the srcpad trigger push of
5296 res = (check_sticky (pad, event) == GST_FLOW_OK);
5301 /* other events are pushed right away */
5302 ret = gst_pad_push_event_unchecked (pad, event, type);
5303 /* dropped events by a probe are not an error */
5304 res = (ret == GST_FLOW_OK || ret == GST_FLOW_CUSTOM_SUCCESS
5305 || ret == GST_FLOW_CUSTOM_SUCCESS_1);
5307 /* Errors in sticky event pushing are no problem and ignored here
5308 * as they will cause more meaningful errors during data flow.
5309 * For EOS events, that are not followed by data flow, we still
5310 * return FALSE here though.
5312 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
5314 gst_event_unref (event);
5316 GST_OBJECT_UNLOCK (pad);
5318 GST_TRACER_PAD_PUSH_EVENT_POST (pad, res);
5321 /* ERROR handling */
5324 g_warning ("pad %s:%s pushing %s event in wrong direction",
5325 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5326 gst_event_unref (event);
5331 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5332 gst_event_unref (event);
5337 GST_DEBUG_OBJECT (pad, "We're flushing");
5338 GST_OBJECT_UNLOCK (pad);
5339 gst_event_unref (event);
5344 GST_DEBUG_OBJECT (pad, "We're EOS");
5345 GST_OBJECT_UNLOCK (pad);
5346 gst_event_unref (event);
5350 GST_TRACER_PAD_PUSH_EVENT_POST (pad, FALSE);
5354 /* Check if we can call the event function with the given event */
5355 static GstFlowReturn
5356 pre_eventfunc_check (GstPad * pad, GstEvent * event)
5360 switch (GST_EVENT_TYPE (event)) {
5361 case GST_EVENT_CAPS:
5363 /* backwards compatibility mode for caps */
5364 gst_event_parse_caps (event, &caps);
5366 if (!gst_pad_query_accept_caps (pad, caps))
5378 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
5379 "caps %" GST_PTR_FORMAT " not accepted", caps);
5380 return GST_FLOW_NOT_NEGOTIATED;
5384 static GstFlowReturn
5385 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
5386 GstPadProbeType type)
5389 GstEventType event_type;
5390 gboolean serialized, need_unlock = FALSE, sticky;
5391 GstPadEventFunction eventfunc;
5394 GST_OBJECT_LOCK (pad);
5396 event = apply_pad_offset (pad, event, GST_PAD_IS_SRC (pad));
5398 if (GST_PAD_IS_SINK (pad))
5399 serialized = GST_EVENT_IS_SERIALIZED (event);
5402 sticky = GST_EVENT_IS_STICKY (event);
5403 event_type = GST_EVENT_TYPE (event);
5404 switch (event_type) {
5405 case GST_EVENT_FLUSH_START:
5406 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5407 "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
5409 /* can't even accept a flush begin event when flushing */
5410 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5413 GST_PAD_SET_FLUSHING (pad);
5414 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
5415 GST_PAD_BLOCK_BROADCAST (pad);
5416 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5418 case GST_EVENT_FLUSH_STOP:
5419 /* we can't accept flush-stop on inactive pads else the flushing flag
5420 * would be cleared and it would look like the pad can accept data.
5421 * Also, some elements restart a streaming thread in flush-stop which we
5422 * can't allow on inactive pads */
5423 if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
5426 GST_PAD_UNSET_FLUSHING (pad);
5427 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
5428 /* Remove pending EOS events */
5429 GST_LOG_OBJECT (pad, "Removing pending EOS and SEGMENT events");
5430 remove_event_by_type (pad, GST_EVENT_EOS);
5431 remove_event_by_type (pad, GST_EVENT_SEGMENT);
5432 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5433 pad->ABI.abi.last_flowret = GST_FLOW_OK;
5435 GST_OBJECT_UNLOCK (pad);
5436 /* grab stream lock */
5437 GST_PAD_STREAM_LOCK (pad);
5439 GST_OBJECT_LOCK (pad);
5440 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5443 case GST_EVENT_RECONFIGURE:
5444 if (GST_PAD_IS_SRC (pad))
5445 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5447 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5448 "have event type %" GST_PTR_FORMAT, event);
5450 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5453 switch (event_type) {
5454 case GST_EVENT_STREAM_START:
5455 /* Remove sticky EOS events */
5456 GST_LOG_OBJECT (pad, "Removing pending EOS events");
5457 remove_event_by_type (pad, GST_EVENT_EOS);
5458 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5465 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5468 /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
5469 GST_OBJECT_UNLOCK (pad);
5470 GST_PAD_STREAM_LOCK (pad);
5472 GST_OBJECT_LOCK (pad);
5473 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5476 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5482 /* now do the probe */
5484 type | GST_PAD_PROBE_TYPE_PUSH |
5485 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5487 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5489 if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
5492 ACQUIRE_PARENT (pad, parent, no_parent);
5493 GST_OBJECT_UNLOCK (pad);
5495 ret = pre_eventfunc_check (pad, event);
5496 if (G_UNLIKELY (ret != GST_FLOW_OK))
5497 goto precheck_failed;
5500 gst_event_ref (event);
5502 if (eventfunc (pad, parent, event)) {
5505 /* something went wrong */
5506 switch (event_type) {
5507 case GST_EVENT_CAPS:
5508 ret = GST_FLOW_NOT_NEGOTIATED;
5511 ret = GST_FLOW_ERROR;
5515 RELEASE_PARENT (parent);
5517 GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
5520 if (ret == GST_FLOW_OK) {
5521 GST_OBJECT_LOCK (pad);
5522 /* after the event function accepted the event, we can store the sticky
5523 * event on the pad */
5524 switch (store_sticky_event (pad, event)) {
5525 case GST_FLOW_FLUSHING:
5532 GST_OBJECT_UNLOCK (pad);
5534 gst_event_unref (event);
5538 GST_PAD_STREAM_UNLOCK (pad);
5542 /* ERROR handling */
5545 GST_OBJECT_UNLOCK (pad);
5547 GST_PAD_STREAM_UNLOCK (pad);
5548 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5549 "Received event on flushing pad. Discarding");
5550 gst_event_unref (event);
5551 return GST_FLOW_FLUSHING;
5555 GST_OBJECT_UNLOCK (pad);
5557 GST_PAD_STREAM_UNLOCK (pad);
5558 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5559 "Received flush-stop on inactive pad. Discarding");
5560 gst_event_unref (event);
5561 return GST_FLOW_FLUSHING;
5565 GST_OBJECT_UNLOCK (pad);
5567 GST_PAD_STREAM_UNLOCK (pad);
5568 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5569 "Received event on EOS pad. Discarding");
5570 gst_event_unref (event);
5571 return GST_FLOW_EOS;
5575 GST_OBJECT_UNLOCK (pad);
5577 GST_PAD_STREAM_UNLOCK (pad);
5578 /* Only unref if unhandled */
5579 if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
5580 gst_event_unref (event);
5583 case GST_FLOW_CUSTOM_SUCCESS_1:
5584 case GST_FLOW_CUSTOM_SUCCESS:
5585 GST_DEBUG_OBJECT (pad, "dropped or handled event");
5589 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5596 g_warning ("pad %s:%s has no event handler, file a bug.",
5597 GST_DEBUG_PAD_NAME (pad));
5598 GST_OBJECT_UNLOCK (pad);
5600 GST_PAD_STREAM_UNLOCK (pad);
5601 gst_event_unref (event);
5602 return GST_FLOW_NOT_SUPPORTED;
5606 GST_DEBUG_OBJECT (pad, "no parent");
5607 GST_OBJECT_UNLOCK (pad);
5609 GST_PAD_STREAM_UNLOCK (pad);
5610 gst_event_unref (event);
5611 return GST_FLOW_FLUSHING;
5615 GST_DEBUG_OBJECT (pad, "pre event check failed");
5616 RELEASE_PARENT (parent);
5618 GST_PAD_STREAM_UNLOCK (pad);
5619 gst_event_unref (event);
5625 * gst_pad_send_event:
5626 * @pad: a #GstPad to send the event to.
5627 * @event: (transfer full): the #GstEvent to send to the pad.
5629 * Sends the event to the pad. This function can be used
5630 * by applications to send events in the pipeline.
5632 * If @pad is a source pad, @event should be an upstream event. If @pad is a
5633 * sink pad, @event should be a downstream event. For example, you would not
5634 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
5635 * Furthermore, some downstream events have to be serialized with data flow,
5636 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
5637 * the event needs to be serialized with data flow, this function will take the
5638 * pad's stream lock while calling its event function.
5640 * To find out whether an event type is upstream, downstream, or downstream and
5641 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
5642 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
5643 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
5644 * plugin doesn't need to bother itself with this information; the core handles
5645 * all necessary locks and checks.
5647 * This function takes ownership of the provided event so you should
5648 * gst_event_ref() it if you want to reuse the event after this call.
5650 * Returns: %TRUE if the event was handled.
5653 gst_pad_send_event (GstPad * pad, GstEvent * event)
5656 GstPadProbeType type;
5658 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5659 g_return_val_if_fail (event != NULL, FALSE);
5661 if (GST_PAD_IS_SINK (pad)) {
5662 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5663 goto wrong_direction;
5664 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5665 } else if (GST_PAD_IS_SRC (pad)) {
5666 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5667 goto wrong_direction;
5668 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5670 goto unknown_direction;
5672 if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
5679 /* ERROR handling */
5682 g_warning ("pad %s:%s sending %s event in wrong direction",
5683 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5684 gst_event_unref (event);
5689 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5690 gst_event_unref (event);
5696 * gst_pad_set_element_private:
5697 * @pad: the #GstPad to set the private data of.
5698 * @priv: The private data to attach to the pad.
5700 * Set the given private data gpointer on the pad.
5701 * This function can only be used by the element that owns the pad.
5702 * No locking is performed in this function.
5705 gst_pad_set_element_private (GstPad * pad, gpointer priv)
5707 pad->element_private = priv;
5711 * gst_pad_get_element_private:
5712 * @pad: the #GstPad to get the private data of.
5714 * Gets the private data of a pad.
5715 * No locking is performed in this function.
5717 * Returns: (transfer none): a #gpointer to the private data.
5720 gst_pad_get_element_private (GstPad * pad)
5722 return pad->element_private;
5726 * gst_pad_get_sticky_event:
5727 * @pad: the #GstPad to get the event from.
5728 * @event_type: the #GstEventType that should be retrieved.
5729 * @idx: the index of the event
5731 * Returns a new reference of the sticky event of type @event_type
5734 * Returns: (transfer full) (nullable): a #GstEvent of type
5735 * @event_type or %NULL when no event of @event_type was on
5736 * @pad. Unref after usage.
5739 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
5741 GstEvent *event = NULL;
5744 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
5745 g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
5747 GST_OBJECT_LOCK (pad);
5748 ev = find_event_by_type (pad, event_type, idx);
5749 if (ev && (event = ev->event))
5750 gst_event_ref (event);
5751 GST_OBJECT_UNLOCK (pad);
5758 GstPadStickyEventsForeachFunction func;
5763 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
5765 ForeachDispatch *data = user_data;
5766 gboolean ret = TRUE;
5769 GST_OBJECT_UNLOCK (pad);
5771 ret = data->func (pad, &ev->event, data->user_data);
5773 GST_OBJECT_LOCK (pad);
5780 * gst_pad_sticky_events_foreach:
5781 * @pad: the #GstPad that should be used for iteration.
5782 * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
5783 * should be called for every event.
5784 * @user_data: (closure): the optional user data.
5786 * Iterates all sticky events on @pad and calls @foreach_func for every
5787 * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
5790 gst_pad_sticky_events_foreach (GstPad * pad,
5791 GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
5793 ForeachDispatch data;
5795 g_return_if_fail (GST_IS_PAD (pad));
5796 g_return_if_fail (foreach_func != NULL);
5798 data.func = foreach_func;
5799 data.user_data = user_data;
5801 GST_OBJECT_LOCK (pad);
5802 events_foreach (pad, foreach_dispatch_function, &data);
5803 GST_OBJECT_UNLOCK (pad);
5807 do_stream_status (GstPad * pad, GstStreamStatusType type,
5808 GThread * thread, GstTask * task)
5812 GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5814 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5815 if (GST_IS_ELEMENT (parent)) {
5816 GstMessage *message;
5817 GValue value = { 0 };
5819 if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5820 gchar *tname, *ename, *pname;
5822 /* create a good task name */
5823 ename = gst_element_get_name (parent);
5824 pname = gst_pad_get_name (pad);
5825 tname = g_strdup_printf ("%s:%s", ename, pname);
5829 gst_object_set_name (GST_OBJECT_CAST (task), tname);
5833 message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5836 g_value_init (&value, GST_TYPE_TASK);
5837 g_value_set_object (&value, task);
5838 gst_message_set_stream_status_object (message, &value);
5839 g_value_unset (&value);
5841 GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5842 gst_element_post_message (parent, message);
5844 gst_object_unref (parent);
5849 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5851 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5856 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5858 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5863 * gst_pad_start_task:
5864 * @pad: the #GstPad to start the task of
5865 * @func: the task function to call
5866 * @user_data: user data passed to the task function
5867 * @notify: called when @user_data is no longer referenced
5869 * Starts a task that repeatedly calls @func with @user_data. This function
5870 * is mostly used in pad activation functions to start the dataflow.
5871 * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5872 * before @func is called.
5874 * Returns: a %TRUE if the task could be started.
5877 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer user_data,
5878 GDestroyNotify notify)
5883 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5884 g_return_val_if_fail (func != NULL, FALSE);
5886 GST_DEBUG_OBJECT (pad, "start task");
5888 GST_OBJECT_LOCK (pad);
5889 task = GST_PAD_TASK (pad);
5891 task = gst_task_new (func, user_data, notify);
5892 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5893 gst_task_set_enter_callback (task, pad_enter_thread, pad, NULL);
5894 gst_task_set_leave_callback (task, pad_leave_thread, pad, NULL);
5895 GST_INFO_OBJECT (pad, "created task %p", task);
5896 GST_PAD_TASK (pad) = task;
5897 gst_object_ref (task);
5898 /* release lock to post the message */
5899 GST_OBJECT_UNLOCK (pad);
5901 do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
5903 gst_object_unref (task);
5905 GST_OBJECT_LOCK (pad);
5906 /* nobody else is supposed to have changed the pad now */
5907 if (GST_PAD_TASK (pad) != task)
5908 goto concurrent_stop;
5910 res = gst_task_set_state (task, GST_TASK_STARTED);
5911 GST_OBJECT_UNLOCK (pad);
5918 GST_OBJECT_UNLOCK (pad);
5924 * gst_pad_pause_task:
5925 * @pad: the #GstPad to pause the task of
5927 * Pause the task of @pad. This function will also wait until the
5928 * function executed by the task is finished if this function is not
5929 * called from the task function.
5931 * Returns: a %TRUE if the task could be paused or %FALSE when the pad
5935 gst_pad_pause_task (GstPad * pad)
5940 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5942 GST_DEBUG_OBJECT (pad, "pause task");
5944 GST_OBJECT_LOCK (pad);
5945 task = GST_PAD_TASK (pad);
5948 res = gst_task_set_state (task, GST_TASK_PAUSED);
5949 GST_OBJECT_UNLOCK (pad);
5951 /* wait for task function to finish, this lock is recursive so it does nothing
5952 * when the pause is called from the task itself */
5953 GST_PAD_STREAM_LOCK (pad);
5954 GST_PAD_STREAM_UNLOCK (pad);
5960 GST_DEBUG_OBJECT (pad, "pad has no task");
5961 GST_OBJECT_UNLOCK (pad);
5967 * gst_pad_stop_task:
5968 * @pad: the #GstPad to stop the task of
5970 * Stop the task of @pad. This function will also make sure that the
5971 * function executed by the task will effectively stop if not called
5972 * from the GstTaskFunction.
5974 * This function will deadlock if called from the GstTaskFunction of
5975 * the task. Use gst_task_pause() instead.
5977 * Regardless of whether the pad has a task, the stream lock is acquired and
5978 * released so as to ensure that streaming through this pad has finished.
5980 * Returns: a %TRUE if the task could be stopped or %FALSE on error.
5983 gst_pad_stop_task (GstPad * pad)
5988 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5990 GST_DEBUG_OBJECT (pad, "stop task");
5992 GST_OBJECT_LOCK (pad);
5993 task = GST_PAD_TASK (pad);
5996 GST_PAD_TASK (pad) = NULL;
5997 res = gst_task_set_state (task, GST_TASK_STOPPED);
5998 GST_OBJECT_UNLOCK (pad);
6000 GST_PAD_STREAM_LOCK (pad);
6001 GST_PAD_STREAM_UNLOCK (pad);
6003 if (!gst_task_join (task))
6006 gst_object_unref (task);
6012 GST_DEBUG_OBJECT (pad, "no task");
6013 GST_OBJECT_UNLOCK (pad);
6015 GST_PAD_STREAM_LOCK (pad);
6016 GST_PAD_STREAM_UNLOCK (pad);
6018 /* this is not an error */
6023 /* this is bad, possibly the application tried to join the task from
6024 * the task's thread. We install the task again so that it will be stopped
6025 * again from the right thread next time hopefully. */
6026 GST_OBJECT_LOCK (pad);
6027 GST_DEBUG_OBJECT (pad, "join failed");
6028 /* we can only install this task if there was no other task */
6029 if (GST_PAD_TASK (pad) == NULL)
6030 GST_PAD_TASK (pad) = task;
6031 GST_OBJECT_UNLOCK (pad);
6038 * gst_pad_probe_info_get_event:
6039 * @info: a #GstPadProbeInfo
6041 * Returns: (transfer none): The #GstEvent from the probe
6045 gst_pad_probe_info_get_event (GstPadProbeInfo * info)
6047 g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM |
6048 GST_PAD_PROBE_TYPE_EVENT_UPSTREAM), NULL);
6050 return GST_PAD_PROBE_INFO_EVENT (info);
6055 * gst_pad_probe_info_get_query:
6056 * @info: a #GstPadProbeInfo
6058 * Returns: (transfer none): The #GstQuery from the probe
6062 gst_pad_probe_info_get_query (GstPadProbeInfo * info)
6064 g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM |
6065 GST_PAD_PROBE_TYPE_QUERY_UPSTREAM), NULL);
6067 return GST_PAD_PROBE_INFO_QUERY (info);
6071 * gst_pad_probe_info_get_buffer:
6072 * @info: a #GstPadProbeInfo
6074 * Returns: (transfer none): The #GstBuffer from the probe
6078 gst_pad_probe_info_get_buffer (GstPadProbeInfo * info)
6080 g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER, NULL);
6082 return GST_PAD_PROBE_INFO_BUFFER (info);
6086 * gst_pad_probe_info_get_buffer_list:
6087 * @info: a #GstPadProbeInfo
6089 * Returns: (transfer none): The #GstBufferlist from the probe
6093 gst_pad_probe_info_get_buffer_list (GstPadProbeInfo * info)
6095 g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER_LIST, NULL);
6097 return GST_PAD_PROBE_INFO_BUFFER_LIST (info);
6101 * gst_pad_get_last_flow_return:
6104 * Gets the #GstFlowReturn return from the last data passed by this pad.
6109 gst_pad_get_last_flow_return (GstPad * pad)
6113 GST_OBJECT_LOCK (pad);
6114 ret = GST_PAD_LAST_FLOW_RETURN (pad);
6115 GST_OBJECT_UNLOCK (pad);