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 event_wrap (GstPad * pad, GstObject * object, GstEvent * event)
1834 ret = GST_PAD_EVENTFULLFUNC (pad) (pad, object, event);
1835 if (ret == GST_FLOW_OK)
1841 * gst_pad_set_event_full_function:
1842 * @p: a #GstPad of either direction.
1843 * @f: the #GstPadEventFullFunction to set.
1845 * Calls gst_pad_set_event_full_function_full() with %NULL for the user_data and
1849 * gst_pad_set_event_full_function_full:
1850 * @pad: a #GstPad of either direction.
1851 * @event: the #GstPadEventFullFunction to set.
1852 * @user_data: user_data passed to @notify
1853 * @notify: notify called when @event will not be used anymore.
1855 * Sets the given event handler for the pad.
1860 gst_pad_set_event_full_function_full (GstPad * pad,
1861 GstPadEventFullFunction event, gpointer user_data, GDestroyNotify notify)
1863 g_return_if_fail (GST_IS_PAD (pad));
1865 if (pad->eventnotify)
1866 pad->eventnotify (pad->eventdata);
1867 GST_PAD_EVENTFULLFUNC (pad) = event;
1868 GST_PAD_EVENTFUNC (pad) = event_wrap;
1869 pad->eventdata = user_data;
1870 pad->eventnotify = notify;
1872 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfullfunc for set to %s",
1873 GST_DEBUG_FUNCPTR_NAME (event));
1877 * gst_pad_set_query_function:
1878 * @p: a #GstPad of either direction.
1879 * @f: the #GstPadQueryFunction to set.
1881 * Calls gst_pad_set_query_function_full() with %NULL for the user_data and
1885 * gst_pad_set_query_function_full:
1886 * @pad: a #GstPad of either direction.
1887 * @query: the #GstPadQueryFunction to set.
1888 * @user_data: user_data passed to @notify
1889 * @notify: notify called when @query will not be used anymore.
1891 * Set the given query function for the pad.
1894 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1895 gpointer user_data, GDestroyNotify notify)
1897 g_return_if_fail (GST_IS_PAD (pad));
1899 if (pad->querynotify)
1900 pad->querynotify (pad->querydata);
1901 GST_PAD_QUERYFUNC (pad) = query;
1902 pad->querydata = user_data;
1903 pad->querynotify = notify;
1905 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1906 GST_DEBUG_FUNCPTR_NAME (query));
1910 * gst_pad_set_iterate_internal_links_function:
1911 * @p: a #GstPad of either direction.
1912 * @f: the #GstPadIterIntLinkFunction to set.
1914 * Calls gst_pad_set_iterate_internal_links_function_full() with %NULL
1915 * for the user_data and notify.
1918 * gst_pad_set_iterate_internal_links_function_full:
1919 * @pad: a #GstPad of either direction.
1920 * @iterintlink: the #GstPadIterIntLinkFunction to set.
1921 * @user_data: user_data passed to @notify
1922 * @notify: notify called when @iterintlink will not be used anymore.
1924 * Sets the given internal link iterator function for the pad.
1927 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1928 GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1929 GDestroyNotify notify)
1931 g_return_if_fail (GST_IS_PAD (pad));
1933 if (pad->iterintlinknotify)
1934 pad->iterintlinknotify (pad->iterintlinkdata);
1935 GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1936 pad->iterintlinkdata = user_data;
1937 pad->iterintlinknotify = notify;
1939 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1940 GST_DEBUG_FUNCPTR_NAME (iterintlink));
1944 * gst_pad_set_link_function:
1946 * @f: the #GstPadLinkFunction to set.
1948 * Calls gst_pad_set_link_function_full() with %NULL
1949 * for the user_data and notify.
1952 * gst_pad_set_link_function_full:
1954 * @link: the #GstPadLinkFunction to set.
1955 * @user_data: user_data passed to @notify
1956 * @notify: notify called when @link will not be used anymore.
1958 * Sets the given link function for the pad. It will be called when
1959 * the pad is linked with another pad.
1961 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1964 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1965 * cannot be made for some reason.
1967 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1968 * of the peer sink pad, if present.
1971 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1972 gpointer user_data, GDestroyNotify notify)
1974 g_return_if_fail (GST_IS_PAD (pad));
1976 if (pad->linknotify)
1977 pad->linknotify (pad->linkdata);
1978 GST_PAD_LINKFUNC (pad) = link;
1979 pad->linkdata = user_data;
1980 pad->linknotify = notify;
1982 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1983 GST_DEBUG_FUNCPTR_NAME (link));
1987 * gst_pad_set_unlink_function:
1989 * @f: the #GstPadUnlinkFunction to set.
1991 * Calls gst_pad_set_unlink_function_full() with %NULL
1992 * for the user_data and notify.
1995 * gst_pad_set_unlink_function_full:
1997 * @unlink: the #GstPadUnlinkFunction to set.
1998 * @user_data: user_data passed to @notify
1999 * @notify: notify called when @unlink will not be used anymore.
2001 * Sets the given unlink function for the pad. It will be called
2002 * when the pad is unlinked.
2005 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
2006 gpointer user_data, GDestroyNotify notify)
2008 g_return_if_fail (GST_IS_PAD (pad));
2010 if (pad->unlinknotify)
2011 pad->unlinknotify (pad->unlinkdata);
2012 GST_PAD_UNLINKFUNC (pad) = unlink;
2013 pad->unlinkdata = user_data;
2014 pad->unlinknotify = notify;
2016 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
2017 GST_DEBUG_FUNCPTR_NAME (unlink));
2022 * @srcpad: the source #GstPad to unlink.
2023 * @sinkpad: the sink #GstPad to unlink.
2025 * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
2026 * signal on both pads.
2028 * Returns: %TRUE if the pads were unlinked. This function returns %FALSE if
2029 * the pads were not linked together.
2034 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
2036 gboolean result = FALSE;
2037 GstElement *parent = NULL;
2039 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2040 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
2041 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2042 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
2044 GST_TRACER_PAD_UNLINK_PRE (srcpad, sinkpad);
2046 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
2047 GST_DEBUG_PAD_NAME (srcpad), srcpad,
2048 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
2050 /* We need to notify the parent before taking any pad locks as the bin in
2051 * question might be waiting for a lock on the pad while holding its lock
2052 * that our message will try to take. */
2053 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
2054 if (GST_IS_ELEMENT (parent)) {
2055 gst_element_post_message (parent,
2056 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2057 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
2059 gst_object_unref (parent);
2064 GST_OBJECT_LOCK (srcpad);
2065 GST_OBJECT_LOCK (sinkpad);
2067 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
2068 goto not_linked_together;
2070 if (GST_PAD_UNLINKFUNC (srcpad)) {
2071 GstObject *tmpparent;
2073 ACQUIRE_PARENT (srcpad, tmpparent, no_src_parent);
2075 GST_PAD_UNLINKFUNC (srcpad) (srcpad, tmpparent);
2076 RELEASE_PARENT (tmpparent);
2079 if (GST_PAD_UNLINKFUNC (sinkpad)) {
2080 GstObject *tmpparent;
2082 ACQUIRE_PARENT (sinkpad, tmpparent, no_sink_parent);
2084 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad, tmpparent);
2085 RELEASE_PARENT (tmpparent);
2089 /* first clear peers */
2090 GST_PAD_PEER (srcpad) = NULL;
2091 GST_PAD_PEER (sinkpad) = NULL;
2093 GST_OBJECT_UNLOCK (sinkpad);
2094 GST_OBJECT_UNLOCK (srcpad);
2096 /* fire off a signal to each of the pads telling them
2097 * that they've been unlinked */
2098 g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
2099 g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
2101 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
2102 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2107 if (parent != NULL) {
2108 gst_element_post_message (parent,
2109 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2110 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
2111 gst_object_unref (parent);
2113 GST_TRACER_PAD_UNLINK_POST (srcpad, sinkpad, result);
2117 not_linked_together:
2119 /* we do not emit a warning in this case because unlinking cannot
2120 * be made MT safe.*/
2121 GST_OBJECT_UNLOCK (sinkpad);
2122 GST_OBJECT_UNLOCK (srcpad);
2128 * gst_pad_is_linked:
2129 * @pad: pad to check
2131 * Checks if a @pad is linked to another pad or not.
2133 * Returns: %TRUE if the pad is linked, %FALSE otherwise.
2138 gst_pad_is_linked (GstPad * pad)
2142 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2144 GST_OBJECT_LOCK (pad);
2145 result = (GST_PAD_PEER (pad) != NULL);
2146 GST_OBJECT_UNLOCK (pad);
2151 /* get the caps from both pads and see if the intersection
2154 * This function should be called with the pad LOCK on both
2158 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
2159 GstPadLinkCheck flags)
2161 GstCaps *srccaps = NULL;
2162 GstCaps *sinkcaps = NULL;
2163 gboolean compatible = FALSE;
2165 if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
2168 /* Doing the expensive caps checking takes priority over only checking the template caps */
2169 if (flags & GST_PAD_LINK_CHECK_CAPS) {
2170 GST_OBJECT_UNLOCK (sink);
2171 GST_OBJECT_UNLOCK (src);
2173 srccaps = gst_pad_query_caps (src, NULL);
2174 sinkcaps = gst_pad_query_caps (sink, NULL);
2176 GST_OBJECT_LOCK (src);
2177 GST_OBJECT_LOCK (sink);
2179 /* If one of the two pads doesn't have a template, consider the intersection
2181 if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
2182 || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
2186 srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
2188 gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
2191 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
2193 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
2196 /* if we have caps on both pads we can check the intersection. If one
2197 * of the caps is %NULL, we return %TRUE. */
2198 if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
2200 gst_caps_unref (srccaps);
2202 gst_caps_unref (sinkcaps);
2206 compatible = gst_caps_can_intersect (srccaps, sinkcaps);
2207 gst_caps_unref (srccaps);
2208 gst_caps_unref (sinkcaps);
2211 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
2212 (compatible ? "" : "not "));
2217 /* check if the grandparents of both pads are the same.
2218 * This check is required so that we don't try to link
2219 * pads from elements in different bins without ghostpads.
2221 * The LOCK should be held on both pads
2224 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
2226 GstObject *psrc, *psink;
2228 psrc = GST_OBJECT_PARENT (src);
2229 psink = GST_OBJECT_PARENT (sink);
2231 /* if one of the pads has no parent, we allow the link */
2232 if (G_UNLIKELY (psrc == NULL || psink == NULL))
2235 /* only care about parents that are elements */
2236 if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
2237 goto no_element_parent;
2239 /* if the parents are the same, we have a loop */
2240 if (G_UNLIKELY (psrc == psink))
2243 /* if they both have a parent, we check the grandparents. We can not lock
2244 * the parent because we hold on the child (pad) and the locking order is
2245 * parent >> child. */
2246 psrc = GST_OBJECT_PARENT (psrc);
2247 psink = GST_OBJECT_PARENT (psink);
2249 /* if they have grandparents but they are not the same */
2250 if (G_UNLIKELY (psrc != psink))
2251 goto wrong_grandparents;
2258 GST_CAT_DEBUG (GST_CAT_CAPS,
2259 "one of the pads has no parent %" GST_PTR_FORMAT " and %"
2260 GST_PTR_FORMAT, psrc, psink);
2265 GST_CAT_DEBUG (GST_CAT_CAPS,
2266 "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
2267 GST_PTR_FORMAT, psrc, psink);
2272 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
2278 GST_CAT_DEBUG (GST_CAT_CAPS,
2279 "pads have different grandparents %" GST_PTR_FORMAT " and %"
2280 GST_PTR_FORMAT, psrc, psink);
2285 /* FIXME leftover from an attempt at refactoring... */
2286 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
2287 * the two pads will be locked in the srcpad, sinkpad order. */
2288 static GstPadLinkReturn
2289 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2291 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2292 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2294 GST_OBJECT_LOCK (srcpad);
2296 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
2297 goto src_was_linked;
2299 GST_OBJECT_LOCK (sinkpad);
2301 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
2302 goto sink_was_linked;
2304 /* check hierarchy, pads can only be linked if the grandparents
2306 if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
2307 && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
2308 goto wrong_hierarchy;
2310 /* check pad caps for non-empty intersection */
2311 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
2314 /* FIXME check pad scheduling for non-empty intersection */
2316 return GST_PAD_LINK_OK;
2320 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
2321 GST_DEBUG_PAD_NAME (srcpad),
2322 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
2323 /* we do not emit a warning in this case because unlinking cannot
2324 * be made MT safe.*/
2325 GST_OBJECT_UNLOCK (srcpad);
2326 return GST_PAD_LINK_WAS_LINKED;
2330 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
2331 GST_DEBUG_PAD_NAME (sinkpad),
2332 GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
2333 /* we do not emit a warning in this case because unlinking cannot
2334 * be made MT safe.*/
2335 GST_OBJECT_UNLOCK (sinkpad);
2336 GST_OBJECT_UNLOCK (srcpad);
2337 return GST_PAD_LINK_WAS_LINKED;
2341 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
2342 GST_OBJECT_UNLOCK (sinkpad);
2343 GST_OBJECT_UNLOCK (srcpad);
2344 return GST_PAD_LINK_WRONG_HIERARCHY;
2348 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
2349 GST_OBJECT_UNLOCK (sinkpad);
2350 GST_OBJECT_UNLOCK (srcpad);
2351 return GST_PAD_LINK_NOFORMAT;
2357 * @srcpad: the source #GstPad.
2358 * @sinkpad: the sink #GstPad.
2360 * Checks if the source pad and the sink pad are compatible so they can be
2363 * Returns: %TRUE if the pads can be linked.
2366 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2368 GstPadLinkReturn result;
2370 /* generic checks */
2371 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2372 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2374 GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
2375 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2377 /* gst_pad_link_prepare does everything for us, we only release the locks
2378 * on the pads that it gets us. If this function returns !OK the locks are not
2380 result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2381 if (result != GST_PAD_LINK_OK)
2384 GST_OBJECT_UNLOCK (srcpad);
2385 GST_OBJECT_UNLOCK (sinkpad);
2388 return result == GST_PAD_LINK_OK;
2392 * gst_pad_link_full:
2393 * @srcpad: the source #GstPad to link.
2394 * @sinkpad: the sink #GstPad to link.
2395 * @flags: the checks to validate when linking
2397 * Links the source pad and the sink pad.
2399 * This variant of #gst_pad_link provides a more granular control on the
2400 * checks being done when linking. While providing some considerable speedups
2401 * the caller of this method must be aware that wrong usage of those flags
2402 * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
2403 * for more information.
2407 * Returns: A result code indicating if the connection worked or
2411 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2413 GstPadLinkReturn result;
2415 GstPadLinkFunction srcfunc, sinkfunc;
2417 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2418 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2419 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2420 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2421 GST_PAD_LINK_WRONG_DIRECTION);
2423 /* Notify the parent early. See gst_pad_unlink for details. */
2424 if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2425 if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2426 gst_element_post_message (parent,
2427 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2428 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2430 gst_object_unref (parent);
2435 /* prepare will also lock the two pads */
2436 result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2438 if (G_UNLIKELY (result != GST_PAD_LINK_OK)) {
2439 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2440 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2441 gst_pad_link_get_name (result));
2445 /* must set peers before calling the link function */
2446 GST_PAD_PEER (srcpad) = sinkpad;
2447 GST_PAD_PEER (sinkpad) = srcpad;
2449 /* check events, when something is different, mark pending */
2450 schedule_events (srcpad, sinkpad);
2452 /* get the link functions */
2453 srcfunc = GST_PAD_LINKFUNC (srcpad);
2454 sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2456 if (G_UNLIKELY (srcfunc || sinkfunc)) {
2457 /* custom link functions, execute them */
2458 GST_OBJECT_UNLOCK (sinkpad);
2459 GST_OBJECT_UNLOCK (srcpad);
2462 GstObject *tmpparent;
2464 ACQUIRE_PARENT (srcpad, tmpparent, no_parent);
2465 /* this one will call the peer link function */
2466 result = srcfunc (srcpad, tmpparent, sinkpad);
2467 RELEASE_PARENT (tmpparent);
2468 } else if (sinkfunc) {
2469 GstObject *tmpparent;
2471 ACQUIRE_PARENT (sinkpad, tmpparent, no_parent);
2472 /* if no source link function, we need to call the sink link
2473 * function ourselves. */
2474 result = sinkfunc (sinkpad, tmpparent, srcpad);
2475 RELEASE_PARENT (tmpparent);
2479 GST_OBJECT_LOCK (srcpad);
2480 GST_OBJECT_LOCK (sinkpad);
2482 /* we released the lock, check if the same pads are linked still */
2483 if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2484 goto concurrent_link;
2486 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2489 GST_OBJECT_UNLOCK (sinkpad);
2490 GST_OBJECT_UNLOCK (srcpad);
2492 /* fire off a signal to each of the pads telling them
2493 * that they've been linked */
2494 g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2495 g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2497 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2498 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2500 gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2503 if (G_LIKELY (parent)) {
2504 gst_element_post_message (parent,
2505 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2506 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2507 gst_object_unref (parent);
2515 GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2516 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2517 GST_OBJECT_UNLOCK (sinkpad);
2518 GST_OBJECT_UNLOCK (srcpad);
2520 /* The other link operation succeeded first */
2521 result = GST_PAD_LINK_WAS_LINKED;
2526 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2527 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2528 gst_pad_link_get_name (result));
2530 GST_PAD_PEER (srcpad) = NULL;
2531 GST_PAD_PEER (sinkpad) = NULL;
2533 GST_OBJECT_UNLOCK (sinkpad);
2534 GST_OBJECT_UNLOCK (srcpad);
2542 * @srcpad: the source #GstPad to link.
2543 * @sinkpad: the sink #GstPad to link.
2545 * Links the source pad and the sink pad.
2547 * Returns: A result code indicating if the connection worked or
2553 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2555 GstPadLinkReturn ret;
2557 GST_TRACER_PAD_LINK_PRE (srcpad, sinkpad);
2558 ret = gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2559 GST_TRACER_PAD_LINK_POST (srcpad, sinkpad, ret);
2565 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2567 GstPadTemplate **template_p;
2569 /* this function would need checks if it weren't static */
2571 GST_OBJECT_LOCK (pad);
2572 template_p = &pad->padtemplate;
2573 gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2574 GST_OBJECT_UNLOCK (pad);
2577 gst_pad_template_pad_created (templ, pad);
2581 * gst_pad_get_pad_template:
2584 * Gets the template for @pad.
2586 * Returns: (transfer full) (nullable): the #GstPadTemplate from which
2587 * this pad was instantiated, or %NULL if this pad has no
2588 * template. Unref after usage.
2591 gst_pad_get_pad_template (GstPad * pad)
2593 GstPadTemplate *templ;
2595 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2597 templ = GST_PAD_PAD_TEMPLATE (pad);
2599 return (templ ? gst_object_ref (templ) : NULL);
2603 * gst_pad_has_current_caps:
2604 * @pad: a #GstPad to check
2606 * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2608 * Returns: %TRUE when @pad has caps associated with it.
2611 gst_pad_has_current_caps (GstPad * pad)
2616 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2618 GST_OBJECT_LOCK (pad);
2619 caps = get_pad_caps (pad);
2620 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2621 "check current pad caps %" GST_PTR_FORMAT, caps);
2622 result = (caps != NULL);
2623 GST_OBJECT_UNLOCK (pad);
2629 * gst_pad_get_current_caps:
2630 * @pad: a #GstPad to get the current capabilities of.
2632 * Gets the capabilities currently configured on @pad with the last
2633 * #GST_EVENT_CAPS event.
2635 * Returns: the current caps of the pad with incremented ref-count.
2638 gst_pad_get_current_caps (GstPad * pad)
2642 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2644 GST_OBJECT_LOCK (pad);
2645 if ((result = get_pad_caps (pad)))
2646 gst_caps_ref (result);
2647 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2648 "get current pad caps %" GST_PTR_FORMAT, result);
2649 GST_OBJECT_UNLOCK (pad);
2655 * gst_pad_get_pad_template_caps:
2656 * @pad: a #GstPad to get the template capabilities from.
2658 * Gets the capabilities for @pad's template.
2660 * Returns: (transfer full): the #GstCaps of this pad template.
2661 * Unref after usage.
2664 gst_pad_get_pad_template_caps (GstPad * pad)
2666 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2668 if (GST_PAD_PAD_TEMPLATE (pad))
2669 return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2671 return gst_caps_ref (GST_CAPS_ANY);
2676 * @pad: a #GstPad to get the peer of.
2678 * Gets the peer of @pad. This function refs the peer pad so
2679 * you need to unref it after use.
2681 * Returns: (transfer full): the peer #GstPad. Unref after usage.
2686 gst_pad_get_peer (GstPad * pad)
2690 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2692 GST_OBJECT_LOCK (pad);
2693 result = GST_PAD_PEER (pad);
2695 gst_object_ref (result);
2696 GST_OBJECT_UNLOCK (pad);
2702 * gst_pad_get_allowed_caps:
2705 * Gets the capabilities of the allowed media types that can flow through
2706 * @pad and its peer.
2708 * The allowed capabilities is calculated as the intersection of the results of
2709 * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2710 * on the resulting caps.
2712 * Returns: (transfer full) (nullable): the allowed #GstCaps of the
2713 * pad link. Unref the caps when you no longer need it. This
2714 * function returns %NULL when @pad has no peer.
2719 gst_pad_get_allowed_caps (GstPad * pad)
2722 GstCaps *caps = NULL;
2725 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2727 GST_OBJECT_LOCK (pad);
2728 if (G_UNLIKELY (GST_PAD_PEER (pad) == NULL))
2730 GST_OBJECT_UNLOCK (pad);
2732 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2734 mycaps = gst_pad_query_caps (pad, NULL);
2736 /* Query peer caps */
2737 query = gst_query_new_caps (mycaps);
2738 gst_pad_peer_query (pad, query);
2739 gst_query_parse_caps_result (query, &caps);
2740 gst_caps_ref (caps);
2741 gst_query_unref (query);
2743 gst_caps_unref (mycaps);
2745 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2752 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2753 GST_OBJECT_UNLOCK (pad);
2760 * gst_pad_iterate_internal_links_default:
2761 * @pad: the #GstPad to get the internal links of.
2762 * @parent: (allow-none): the parent of @pad or %NULL
2764 * Iterate the list of pads to which the given pad is linked to inside of
2765 * the parent element.
2766 * This is the default handler, and thus returns an iterator of all of the
2767 * pads inside the parent element with opposite direction.
2769 * The caller must free this iterator after use with gst_iterator_free().
2771 * Returns: (nullable): a #GstIterator of #GstPad, or %NULL if @pad
2772 * has no parent. Unref each returned pad with gst_object_unref().
2775 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2782 GstElement *eparent;
2784 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2786 if (parent != NULL && GST_IS_ELEMENT (parent)) {
2787 eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2789 GST_OBJECT_LOCK (pad);
2790 eparent = GST_PAD_PARENT (pad);
2791 if (!eparent || !GST_IS_ELEMENT (eparent))
2794 gst_object_ref (eparent);
2795 GST_OBJECT_UNLOCK (pad);
2798 if (pad->direction == GST_PAD_SRC)
2799 padlist = &eparent->sinkpads;
2801 padlist = &eparent->srcpads;
2803 GST_DEBUG_OBJECT (pad, "Making iterator");
2805 cookie = &eparent->pads_cookie;
2807 lock = GST_OBJECT_GET_LOCK (eparent);
2809 res = gst_iterator_new_list (GST_TYPE_PAD,
2810 lock, cookie, padlist, (GObject *) owner, NULL);
2812 gst_object_unref (owner);
2819 GST_OBJECT_UNLOCK (pad);
2820 GST_DEBUG_OBJECT (pad, "no parent element");
2826 * gst_pad_iterate_internal_links:
2827 * @pad: the GstPad to get the internal links of.
2829 * Gets an iterator for the pads to which the given pad is linked to inside
2830 * of the parent element.
2832 * Each #GstPad element yielded by the iterator will have its refcount increased,
2833 * so unref after use.
2835 * Free-function: gst_iterator_free
2837 * Returns: (transfer full) (nullable): a new #GstIterator of #GstPad
2838 * or %NULL when the pad does not have an iterator function
2839 * configured. Use gst_iterator_free() after usage.
2842 gst_pad_iterate_internal_links (GstPad * pad)
2844 GstIterator *res = NULL;
2847 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2849 GST_OBJECT_LOCK (pad);
2850 ACQUIRE_PARENT (pad, parent, no_parent);
2851 GST_OBJECT_UNLOCK (pad);
2853 if (GST_PAD_ITERINTLINKFUNC (pad))
2854 res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2856 RELEASE_PARENT (parent);
2863 GST_DEBUG_OBJECT (pad, "no parent");
2864 GST_OBJECT_UNLOCK (pad);
2872 * @forward: (scope call): a #GstPadForwardFunction
2873 * @user_data: user data passed to @forward
2875 * Calls @forward for all internally linked pads of @pad. This function deals with
2876 * dynamically changing internal pads and will make sure that the @forward
2877 * function is only called once for each pad.
2879 * When @forward returns %TRUE, no further pads will be processed.
2881 * Returns: %TRUE if one of the dispatcher functions returned %TRUE.
2884 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2887 gboolean result = FALSE;
2889 gboolean done = FALSE;
2890 GValue item = { 0, };
2891 GList *pushed_pads = NULL;
2893 iter = gst_pad_iterate_internal_links (pad);
2899 switch (gst_iterator_next (iter, &item)) {
2900 case GST_ITERATOR_OK:
2904 intpad = g_value_get_object (&item);
2906 /* if already pushed, skip. FIXME, find something faster to tag pads */
2907 if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2908 g_value_reset (&item);
2912 GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2913 GST_DEBUG_PAD_NAME (intpad));
2914 done = result = forward (intpad, user_data);
2916 pushed_pads = g_list_prepend (pushed_pads, intpad);
2918 g_value_reset (&item);
2921 case GST_ITERATOR_RESYNC:
2922 /* We don't reset the result here because we don't push the event
2923 * again on pads that got the event already and because we need
2924 * to consider the result of the previous pushes */
2925 gst_iterator_resync (iter);
2927 case GST_ITERATOR_ERROR:
2928 GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2931 case GST_ITERATOR_DONE:
2936 g_value_unset (&item);
2937 gst_iterator_free (iter);
2939 g_list_free (pushed_pads);
2949 gboolean dispatched;
2953 event_forward_func (GstPad * pad, EventData * data)
2955 /* for each pad we send to, we should ref the event; it's up
2956 * to downstream to unref again when handled. */
2957 GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2958 data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2960 data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2962 data->dispatched = TRUE;
2969 * gst_pad_event_default:
2970 * @pad: a #GstPad to call the default event handler on.
2971 * @parent: (allow-none): the parent of @pad or %NULL
2972 * @event: (transfer full): the #GstEvent to handle.
2974 * Invokes the default event handler for the given pad.
2976 * The EOS event will pause the task associated with @pad before it is forwarded
2977 * to all internally linked pads,
2979 * The event is sent to all pads internally linked to @pad. This function
2980 * takes ownership of @event.
2982 * Returns: %TRUE if the event was sent successfully.
2985 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2987 gboolean result, forward = TRUE;
2989 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2990 g_return_val_if_fail (event != NULL, FALSE);
2992 GST_LOG_OBJECT (pad, "default event handler for event %" GST_PTR_FORMAT,
2995 switch (GST_EVENT_TYPE (event)) {
2996 case GST_EVENT_CAPS:
2997 forward = GST_PAD_IS_PROXY_CAPS (pad);
3008 data.dispatched = FALSE;
3009 data.result = FALSE;
3011 gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
3013 /* for sinkpads without a parent element or without internal links, nothing
3014 * will be dispatched but we still want to return TRUE. */
3015 if (data.dispatched)
3016 result = data.result;
3021 gst_event_unref (event);
3026 /* Default accept caps implementation just checks against
3027 * the allowed caps for the pad */
3029 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
3031 /* get the caps and see if it intersects to something not empty */
3032 GstCaps *caps, *allowed = NULL;
3035 GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
3037 /* first forward the query to internally linked pads when we are dealing with
3039 if (GST_PAD_IS_PROXY_CAPS (pad)) {
3040 result = gst_pad_proxy_query_accept_caps (pad, query);
3042 allowed = gst_pad_get_pad_template_caps (pad);
3047 gst_query_parse_accept_caps (query, &caps);
3049 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
3050 "fallback ACCEPT_CAPS query, consider implementing a specialized version");
3051 if (GST_PAD_IS_ACCEPT_TEMPLATE (pad))
3052 allowed = gst_pad_get_pad_template_caps (pad);
3054 allowed = gst_pad_query_caps (pad, caps);
3058 if (GST_PAD_IS_ACCEPT_INTERSECT (pad)) {
3059 GST_DEBUG_OBJECT (pad,
3060 "allowed caps intersect %" GST_PTR_FORMAT ", caps %" GST_PTR_FORMAT,
3062 result = gst_caps_can_intersect (caps, allowed);
3064 GST_DEBUG_OBJECT (pad, "allowed caps subset %" GST_PTR_FORMAT ", caps %"
3065 GST_PTR_FORMAT, allowed, caps);
3066 result = gst_caps_is_subset (caps, allowed);
3068 gst_caps_unref (allowed);
3070 GST_DEBUG_OBJECT (pad, "no compatible caps allowed on the pad");
3073 gst_query_set_accept_caps_result (query, result);
3079 /* Default caps implementation */
3081 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
3083 GstCaps *result = NULL, *filter;
3084 GstPadTemplate *templ;
3085 gboolean fixed_caps;
3087 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "query caps %" GST_PTR_FORMAT,
3090 /* first try to proxy if we must */
3091 if (GST_PAD_IS_PROXY_CAPS (pad)) {
3092 if ((gst_pad_proxy_query_caps (pad, query))) {
3097 gst_query_parse_caps (query, &filter);
3099 /* no proxy or it failed, do default handling */
3100 fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
3102 GST_OBJECT_LOCK (pad);
3104 /* fixed caps, try the negotiated caps first */
3105 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
3106 if ((result = get_pad_caps (pad)))
3107 goto filter_done_unlock;
3110 if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
3111 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
3112 if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
3113 goto filter_done_unlock;
3117 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3118 "non-fixed pad caps: trying pad caps");
3119 /* non fixed caps, try the negotiated caps */
3120 if ((result = get_pad_caps (pad)))
3121 goto filter_done_unlock;
3124 /* this almost never happens */
3125 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
3126 result = GST_CAPS_ANY;
3129 GST_OBJECT_UNLOCK (pad);
3131 /* run the filter on the result */
3133 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3134 "using caps %p %" GST_PTR_FORMAT " with filter %p %"
3135 GST_PTR_FORMAT, result, result, filter, filter);
3136 result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
3137 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
3140 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3141 "using caps %p %" GST_PTR_FORMAT, result, result);
3142 result = gst_caps_ref (result);
3144 gst_query_set_caps_result (query, result);
3145 gst_caps_unref (result);
3151 /* Default latency implementation */
3155 GstClockTime min, max;
3159 query_latency_default_fold (const GValue * item, GValue * ret,
3162 GstPad *pad = g_value_get_object (item), *peer;
3163 LatencyFoldData *fold_data = user_data;
3165 gboolean res = FALSE;
3167 query = gst_query_new_latency ();
3169 peer = gst_pad_get_peer (pad);
3171 res = gst_pad_peer_query (pad, query);
3173 GST_LOG_OBJECT (pad, "No peer pad found, ignoring this pad");
3178 GstClockTime min, max;
3180 gst_query_parse_latency (query, &live, &min, &max);
3182 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3183 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
3186 if (min > fold_data->min)
3187 fold_data->min = min;
3189 if (fold_data->max == GST_CLOCK_TIME_NONE)
3190 fold_data->max = max;
3191 else if (max < fold_data->max)
3192 fold_data->max = max;
3194 fold_data->live = TRUE;
3197 GST_DEBUG_OBJECT (pad, "latency query failed");
3198 g_value_set_boolean (ret, FALSE);
3201 gst_query_unref (query);
3203 gst_object_unref (peer);
3209 gst_pad_query_latency_default (GstPad * pad, GstQuery * query)
3212 GstIteratorResult res;
3213 GValue ret = G_VALUE_INIT;
3215 LatencyFoldData fold_data;
3217 it = gst_pad_iterate_internal_links (pad);
3219 GST_DEBUG_OBJECT (pad, "Can't iterate internal links");
3223 g_value_init (&ret, G_TYPE_BOOLEAN);
3226 fold_data.live = FALSE;
3228 fold_data.max = GST_CLOCK_TIME_NONE;
3230 g_value_set_boolean (&ret, TRUE);
3231 res = gst_iterator_fold (it, query_latency_default_fold, &ret, &fold_data);
3233 case GST_ITERATOR_OK:
3234 g_assert_not_reached ();
3236 case GST_ITERATOR_DONE:
3238 case GST_ITERATOR_ERROR:
3239 g_value_set_boolean (&ret, FALSE);
3241 case GST_ITERATOR_RESYNC:
3242 gst_iterator_resync (it);
3245 g_assert_not_reached ();
3248 gst_iterator_free (it);
3250 query_ret = g_value_get_boolean (&ret);
3252 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3253 " max:%" G_GINT64_FORMAT, fold_data.live ? "true" : "false",
3254 fold_data.min, fold_data.max);
3256 if (fold_data.min > fold_data.max) {
3257 GST_ERROR_OBJECT (pad, "minimum latency bigger than maximum latency");
3260 gst_query_set_latency (query, fold_data.live, fold_data.min, fold_data.max);
3262 GST_LOG_OBJECT (pad, "latency query failed");
3272 gboolean dispatched;
3276 query_forward_func (GstPad * pad, QueryData * data)
3278 GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
3279 data->query, GST_QUERY_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
3281 data->result |= gst_pad_peer_query (pad, data->query);
3283 data->dispatched = TRUE;
3285 /* stop on first successful reply */
3286 return data->result;
3290 * gst_pad_query_default:
3291 * @pad: a #GstPad to call the default query handler on.
3292 * @parent: (allow-none): the parent of @pad or %NULL
3293 * @query: (transfer none): the #GstQuery to handle.
3295 * Invokes the default query handler for the given pad.
3296 * The query is sent to all pads internally linked to @pad. Note that
3297 * if there are many possible sink pads that are internally linked to
3298 * @pad, only one will be sent the query.
3299 * Multi-sinkpad elements should implement custom query handlers.
3301 * Returns: %TRUE if the query was performed successfully.
3304 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
3306 gboolean forward, ret = FALSE;
3308 switch (GST_QUERY_TYPE (query)) {
3309 case GST_QUERY_SCHEDULING:
3310 forward = GST_PAD_IS_PROXY_SCHEDULING (pad);
3312 case GST_QUERY_ALLOCATION:
3313 forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
3315 case GST_QUERY_ACCEPT_CAPS:
3316 ret = gst_pad_query_accept_caps_default (pad, query);
3319 case GST_QUERY_CAPS:
3320 ret = gst_pad_query_caps_default (pad, query);
3323 case GST_QUERY_LATENCY:
3324 ret = gst_pad_query_latency_default (pad, query);
3327 case GST_QUERY_POSITION:
3328 case GST_QUERY_SEEKING:
3329 case GST_QUERY_FORMATS:
3330 case GST_QUERY_JITTER:
3331 case GST_QUERY_RATE:
3332 case GST_QUERY_CONVERT:
3338 GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
3339 query, GST_QUERY_TYPE_NAME (query));
3345 data.dispatched = FALSE;
3346 data.result = FALSE;
3348 gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
3350 if (data.dispatched) {
3353 /* nothing dispatched, assume drained */
3354 if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
3364 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
3366 GstPad *pad = data->pad;
3367 GstPadProbeInfo *info = data->info;
3368 GstPadProbeType type, flags;
3369 GstPadProbeCallback callback;
3370 GstPadProbeReturn ret;
3371 gpointer original_data;
3373 /* if we have called this callback, do nothing */
3374 if (PROBE_COOKIE (hook) == data->cookie) {
3375 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3376 "hook %lu, cookie %u already called", hook->hook_id,
3377 PROBE_COOKIE (hook));
3381 PROBE_COOKIE (hook) = data->cookie;
3383 flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
3385 original_data = info->data;
3387 /* one of the data types for non-idle probes */
3388 if ((type & GST_PAD_PROBE_TYPE_IDLE) == 0
3389 && (flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
3391 /* one of the scheduling types */
3392 if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
3394 /* one of the blocking types must match */
3395 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
3396 (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
3398 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) == 0 &&
3399 (flags & GST_PAD_PROBE_TYPE_BLOCKING))
3401 /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
3402 if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
3403 (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
3406 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3407 "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
3408 PROBE_COOKIE (hook), flags);
3410 data->marshalled = TRUE;
3412 callback = (GstPadProbeCallback) hook->func;
3413 if (callback == NULL)
3416 info->id = hook->hook_id;
3418 GST_OBJECT_UNLOCK (pad);
3420 ret = callback (pad, info, hook->data);
3422 GST_OBJECT_LOCK (pad);
3424 if (original_data != NULL && info->data == NULL) {
3425 GST_DEBUG_OBJECT (pad, "data item in pad probe info was dropped");
3426 info->type = GST_PAD_PROBE_TYPE_INVALID;
3427 data->dropped = TRUE;
3431 case GST_PAD_PROBE_REMOVE:
3432 /* remove the probe */
3433 GST_DEBUG_OBJECT (pad, "asked to remove hook");
3434 cleanup_hook (pad, hook);
3436 case GST_PAD_PROBE_DROP:
3437 /* need to drop the data, make sure other probes don't get called
3439 GST_DEBUG_OBJECT (pad, "asked to drop item");
3440 info->type = GST_PAD_PROBE_TYPE_INVALID;
3441 data->dropped = TRUE;
3443 case GST_PAD_PROBE_HANDLED:
3444 GST_DEBUG_OBJECT (pad, "probe handled data");
3445 data->handled = TRUE;
3447 case GST_PAD_PROBE_PASS:
3448 /* inform the pad block to let things pass */
3449 GST_DEBUG_OBJECT (pad, "asked to pass item");
3452 case GST_PAD_PROBE_OK:
3453 GST_DEBUG_OBJECT (pad, "probe returned OK");
3456 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
3463 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3464 "hook %lu, cookie %u with flags 0x%08x does not match %08x",
3465 hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
3470 /* a probe that does not take or return any data */
3471 #define PROBE_NO_DATA(pad,mask,label,defaultval) \
3473 if (G_UNLIKELY (pad->num_probes)) { \
3474 GstFlowReturn pval = defaultval; \
3475 /* pass NULL as the data item */ \
3476 GstPadProbeInfo info = { mask, 0, NULL, 0, 0 }; \
3477 info.ABI.abi.flow_ret = defaultval; \
3478 ret = do_probe_callbacks (pad, &info, defaultval); \
3479 if (G_UNLIKELY (ret != pval && ret != GST_FLOW_OK)) \
3484 #define PROBE_FULL(pad,mask,data,offs,size,label,handleable,handle_label) \
3486 if (G_UNLIKELY (pad->num_probes)) { \
3487 /* pass the data item */ \
3488 GstPadProbeInfo info = { mask, 0, data, offs, size }; \
3489 info.ABI.abi.flow_ret = GST_FLOW_OK; \
3490 ret = do_probe_callbacks (pad, &info, GST_FLOW_OK); \
3491 /* store the possibly updated data item */ \
3492 data = GST_PAD_PROBE_INFO_DATA (&info); \
3493 /* if something went wrong, exit */ \
3494 if (G_UNLIKELY (ret != GST_FLOW_OK)) { \
3495 if (handleable && ret == GST_FLOW_CUSTOM_SUCCESS_1) { \
3496 ret = info.ABI.abi.flow_ret; \
3497 goto handle_label; \
3504 #define PROBE_PUSH(pad,mask,data,label) \
3505 PROBE_FULL(pad, mask, data, -1, -1, label, FALSE, label);
3506 #define PROBE_HANDLE(pad,mask,data,label,handle_label) \
3507 PROBE_FULL(pad, mask, data, -1, -1, label, TRUE, handle_label);
3508 #define PROBE_PULL(pad,mask,data,offs,size,label) \
3509 PROBE_FULL(pad, mask, data, offs, size, label, FALSE, label);
3511 static GstFlowReturn
3512 do_pad_idle_probe_wait (GstPad * pad)
3514 while (GST_PAD_IS_RUNNING_IDLE_PROBE (pad)) {
3515 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3516 "waiting idle probe to be removed");
3517 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3518 GST_PAD_BLOCK_WAIT (pad);
3519 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3520 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3522 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3523 return GST_FLOW_FLUSHING;
3528 #define PROBE_TYPE_IS_SERIALIZED(i) \
3531 (((i)->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM | \
3532 GST_PAD_PROBE_TYPE_EVENT_FLUSH)) && \
3533 GST_EVENT_IS_SERIALIZED ((i)->data)) \
3535 (((i)->type & GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM) && \
3536 GST_QUERY_IS_SERIALIZED ((i)->data)) \
3538 ((i)->type & (GST_PAD_PROBE_TYPE_BUFFER | \
3539 GST_PAD_PROBE_TYPE_BUFFER_LIST)) \
3543 static GstFlowReturn
3544 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3545 GstFlowReturn defaultval)
3554 data.handled = FALSE;
3555 data.marshalled = FALSE;
3556 data.dropped = FALSE;
3557 data.cookie = ++pad->priv->probe_cookie;
3560 (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3562 if (is_block && PROBE_TYPE_IS_SERIALIZED (info)) {
3563 if (do_pad_idle_probe_wait (pad) == GST_FLOW_FLUSHING)
3568 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3569 "do probes cookie %u", data.cookie);
3570 cookie = pad->priv->probe_list_cookie;
3572 g_hook_list_marshal (&pad->probes, TRUE,
3573 (GHookMarshaller) probe_hook_marshal, &data);
3575 /* if the list changed, call the new callbacks (they will not have their
3576 * cookie set to data.cookie */
3577 if (cookie != pad->priv->probe_list_cookie) {
3578 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3579 "probe list changed, restarting");
3583 /* the first item that dropped will stop the hooks and then we drop here */
3587 /* If one handler took care of it, let the the item pass */
3592 /* if no handler matched and we are blocking, let the item pass */
3593 if (!data.marshalled && is_block)
3596 /* At this point, all handlers returned either OK or PASS. If one handler
3597 * returned PASS, let the item pass */
3602 while (GST_PAD_IS_BLOCKED (pad)) {
3603 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3604 "we are blocked %d times", pad->num_blocked);
3606 /* we might have released the lock */
3607 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3610 /* now we block the streaming thread. It can be unlocked when we
3611 * deactivate the pad (which will also set the FLUSHING flag) or
3612 * when the pad is unblocked. A flushing event will also unblock
3613 * the pad after setting the FLUSHING flag. */
3614 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3615 "Waiting to be unblocked or set flushing");
3616 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3617 GST_PAD_BLOCK_WAIT (pad);
3618 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3619 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3621 /* if the list changed, call the new callbacks (they will not have their
3622 * cookie set to data.cookie */
3623 if (cookie != pad->priv->probe_list_cookie) {
3624 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3625 "probe list changed, restarting");
3629 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3639 GST_DEBUG_OBJECT (pad, "pad is flushing");
3640 return GST_FLOW_FLUSHING;
3644 GST_DEBUG_OBJECT (pad, "data is dropped");
3645 return GST_FLOW_CUSTOM_SUCCESS;
3649 /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3650 GST_DEBUG_OBJECT (pad, "data is passed");
3655 GST_DEBUG_OBJECT (pad, "data was handled");
3656 return GST_FLOW_CUSTOM_SUCCESS_1;
3663 * gst_pad_get_offset:
3666 * Get the offset applied to the running time of @pad. @pad has to be a source
3669 * Returns: the offset.
3672 gst_pad_get_offset (GstPad * pad)
3676 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3678 GST_OBJECT_LOCK (pad);
3679 result = pad->offset;
3680 GST_OBJECT_UNLOCK (pad);
3686 mark_event_not_received (GstPad * pad, PadEvent * ev, gpointer user_data)
3688 ev->received = FALSE;
3693 * gst_pad_set_offset:
3695 * @offset: the offset
3697 * Set the offset that will be applied to the running time of @pad.
3700 gst_pad_set_offset (GstPad * pad, gint64 offset)
3702 g_return_if_fail (GST_IS_PAD (pad));
3704 GST_OBJECT_LOCK (pad);
3705 /* if nothing changed, do nothing */
3706 if (pad->offset == offset)
3709 pad->offset = offset;
3710 GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3712 /* resend all sticky events with updated offset on next buffer push */
3713 events_foreach (pad, mark_event_not_received, NULL);
3714 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3717 GST_OBJECT_UNLOCK (pad);
3724 /* If TRUE and ret is not OK this means
3725 * that pushing the EOS event failed
3729 /* If called for an event this is
3730 * the event that would be pushed
3731 * next. Don't forward sticky events
3732 * that would come after that */
3736 /* should be called with pad LOCK */
3738 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3740 PushStickyData *data = user_data;
3741 GstEvent *event = ev->event;
3744 GST_DEBUG_OBJECT (pad, "event %s was already received",
3745 GST_EVENT_TYPE_NAME (event));
3749 /* If we're called because of an sticky event, only forward
3750 * events that would come before this new event and the
3752 if (data->event && GST_EVENT_IS_STICKY (data->event) &&
3753 GST_EVENT_TYPE (data->event) <= GST_EVENT_SEGMENT &&
3754 GST_EVENT_TYPE (data->event) < GST_EVENT_TYPE (event)) {
3755 data->ret = GST_FLOW_CUSTOM_SUCCESS_1;
3757 data->ret = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3758 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3761 switch (data->ret) {
3763 ev->received = TRUE;
3764 GST_DEBUG_OBJECT (pad, "event %s marked received",
3765 GST_EVENT_TYPE_NAME (event));
3767 case GST_FLOW_CUSTOM_SUCCESS:
3768 /* we can't assume the event is received when it was dropped */
3769 GST_DEBUG_OBJECT (pad, "event %s was dropped, mark pending",
3770 GST_EVENT_TYPE_NAME (event));
3771 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3772 data->ret = GST_FLOW_OK;
3774 case GST_FLOW_CUSTOM_SUCCESS_1:
3775 /* event was ignored and should be sent later */
3776 GST_DEBUG_OBJECT (pad, "event %s was ignored, mark pending",
3777 GST_EVENT_TYPE_NAME (event));
3778 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3779 data->ret = GST_FLOW_OK;
3781 case GST_FLOW_NOT_LINKED:
3782 /* not linked is not a problem, we are sticky so the event will be
3783 * rescheduled to be sent later on re-link, but only for non-EOS events */
3784 GST_DEBUG_OBJECT (pad, "pad was not linked, mark pending");
3785 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS) {
3786 data->ret = GST_FLOW_OK;
3787 ev->received = TRUE;
3791 GST_DEBUG_OBJECT (pad, "result %s, mark pending events",
3792 gst_flow_get_name (data->ret));
3793 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3797 if (data->ret != GST_FLOW_OK && GST_EVENT_TYPE (event) == GST_EVENT_EOS)
3798 data->was_eos = TRUE;
3800 return data->ret == GST_FLOW_OK;
3803 /* check sticky events and push them when needed. should be called
3805 static inline GstFlowReturn
3806 check_sticky (GstPad * pad, GstEvent * event)
3808 PushStickyData data = { GST_FLOW_OK, FALSE, event };
3810 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3811 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3813 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3814 events_foreach (pad, push_sticky, &data);
3816 /* If there's an EOS event we must push it downstream
3817 * even if sending a previous sticky event failed.
3818 * Otherwise the pipeline might wait forever for EOS.
3820 * Only do this if pushing another event than the EOS
3823 if (data.ret != GST_FLOW_OK && !data.was_eos) {
3824 PadEvent *ev = find_event_by_type (pad, GST_EVENT_EOS, 0);
3826 if (ev && !ev->received) {
3827 data.ret = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3828 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3829 /* the event could have been dropped. Because this can only
3830 * happen if the user asked for it, it's not an error */
3831 if (data.ret == GST_FLOW_CUSTOM_SUCCESS)
3832 data.ret = GST_FLOW_OK;
3842 * @pad: a #GstPad to invoke the default query on.
3843 * @query: (transfer none): the #GstQuery to perform.
3845 * Dispatches a query to a pad. The query should have been allocated by the
3846 * caller via one of the type-specific allocation functions. The element that
3847 * the pad belongs to is responsible for filling the query with an appropriate
3848 * response, which should then be parsed with a type-specific query parsing
3851 * Again, the caller is responsible for both the allocation and deallocation of
3852 * the query structure.
3854 * Please also note that some queries might need a running pipeline to work.
3856 * Returns: %TRUE if the query could be performed.
3859 gst_pad_query (GstPad * pad, GstQuery * query)
3862 gboolean res, serialized;
3863 GstPadQueryFunction func;
3864 GstPadProbeType type;
3867 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3868 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3870 if (GST_PAD_IS_SRC (pad)) {
3871 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3872 goto wrong_direction;
3873 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3874 } else if (GST_PAD_IS_SINK (pad)) {
3875 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3876 goto wrong_direction;
3877 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3879 goto unknown_direction;
3881 GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3882 GST_QUERY_TYPE_NAME (query));
3883 GST_TRACER_PAD_QUERY_PRE (pad, query);
3885 serialized = GST_QUERY_IS_SERIALIZED (query);
3886 if (G_UNLIKELY (serialized))
3887 GST_PAD_STREAM_LOCK (pad);
3889 GST_OBJECT_LOCK (pad);
3890 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3891 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3892 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3894 ACQUIRE_PARENT (pad, parent, no_parent);
3895 GST_OBJECT_UNLOCK (pad);
3897 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3900 res = func (pad, parent, query);
3902 RELEASE_PARENT (parent);
3904 GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3905 GST_QUERY_TYPE_NAME (query), res);
3906 GST_TRACER_PAD_QUERY_POST (pad, query, res);
3911 GST_OBJECT_LOCK (pad);
3912 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3913 GST_OBJECT_UNLOCK (pad);
3915 if (G_UNLIKELY (serialized))
3916 GST_PAD_STREAM_UNLOCK (pad);
3923 g_warning ("pad %s:%s query %s in wrong direction",
3924 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3929 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3934 GST_DEBUG_OBJECT (pad, "had no parent");
3935 GST_OBJECT_UNLOCK (pad);
3936 if (G_UNLIKELY (serialized))
3937 GST_PAD_STREAM_UNLOCK (pad);
3942 GST_DEBUG_OBJECT (pad, "had no query function");
3943 RELEASE_PARENT (parent);
3944 if (G_UNLIKELY (serialized))
3945 GST_PAD_STREAM_UNLOCK (pad);
3950 GST_DEBUG_OBJECT (pad, "query failed");
3951 if (G_UNLIKELY (serialized))
3952 GST_PAD_STREAM_UNLOCK (pad);
3957 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3958 GST_OBJECT_UNLOCK (pad);
3959 if (G_UNLIKELY (serialized))
3960 GST_PAD_STREAM_UNLOCK (pad);
3962 /* if a probe dropped without handling, we don't sent it further but assume
3963 * that the probe did not answer the query and return FALSE */
3964 if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
3974 * gst_pad_peer_query:
3975 * @pad: a #GstPad to invoke the peer query on.
3976 * @query: (transfer none): the #GstQuery to perform.
3978 * Performs gst_pad_query() on the peer of @pad.
3980 * The caller is responsible for both the allocation and deallocation of
3981 * the query structure.
3983 * Returns: %TRUE if the query could be performed. This function returns %FALSE
3984 * if @pad has no peer.
3987 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3990 GstPadProbeType type;
3991 gboolean res, serialized;
3994 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3995 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3997 if (GST_PAD_IS_SRC (pad)) {
3998 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3999 goto wrong_direction;
4000 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
4001 } else if (GST_PAD_IS_SINK (pad)) {
4002 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
4003 goto wrong_direction;
4004 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
4006 goto unknown_direction;
4008 GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
4009 GST_QUERY_TYPE_NAME (query));
4011 serialized = GST_QUERY_IS_SERIALIZED (query);
4013 GST_OBJECT_LOCK (pad);
4014 if (GST_PAD_IS_SRC (pad) && serialized) {
4015 /* all serialized queries on the srcpad trigger push of
4017 if (check_sticky (pad, NULL) != GST_FLOW_OK)
4021 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4022 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
4023 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
4025 peerpad = GST_PAD_PEER (pad);
4026 if (G_UNLIKELY (peerpad == NULL))
4029 gst_object_ref (peerpad);
4030 GST_OBJECT_UNLOCK (pad);
4032 res = gst_pad_query (peerpad, query);
4034 gst_object_unref (peerpad);
4039 GST_OBJECT_LOCK (pad);
4040 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
4041 GST_OBJECT_UNLOCK (pad);
4048 g_warning ("pad %s:%s query %s in wrong direction",
4049 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
4054 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4059 GST_WARNING_OBJECT (pad, "could not send sticky events");
4060 GST_OBJECT_UNLOCK (pad);
4065 GST_INFO_OBJECT (pad, "pad has no peer");
4066 GST_OBJECT_UNLOCK (pad);
4071 GST_DEBUG_OBJECT (pad, "query failed");
4076 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
4077 GST_OBJECT_UNLOCK (pad);
4079 /* if a probe dropped without handling, we don't sent it further but
4080 * assume that the probe did not answer the query and return FALSE */
4081 if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
4090 /**********************************************************************
4091 * Data passing functions
4094 /* this is the chain function that does not perform the additional argument
4095 * checking for that little extra speed.
4097 static inline GstFlowReturn
4098 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
4102 gboolean handled = FALSE;
4104 GST_PAD_STREAM_LOCK (pad);
4106 GST_OBJECT_LOCK (pad);
4107 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4110 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4113 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4116 #ifdef GST_ENABLE_EXTRA_CHECKS
4117 if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4118 if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4120 ":%s:<%s:%s> Got data flow before stream-start event",
4121 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4123 if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4125 ":%s:<%s:%s> Got data flow before segment event",
4126 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4128 pad->priv->last_cookie = pad->priv->events_cookie;
4132 PROBE_HANDLE (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped,
4135 PROBE_HANDLE (pad, type, data, probe_stopped, probe_handled);
4137 ACQUIRE_PARENT (pad, parent, no_parent);
4138 GST_OBJECT_UNLOCK (pad);
4140 /* NOTE: we read the chainfunc unlocked.
4141 * we cannot hold the lock for the pad so we might send
4142 * the data to the wrong function. This is not really a
4143 * problem since functions are assigned at creation time
4144 * and don't change that often... */
4145 if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
4146 GstPadChainFunction chainfunc;
4148 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
4151 GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4152 "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
4153 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
4155 ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
4157 GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4158 "called chainfunction &%s with buffer %p, returned %s",
4159 GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
4161 GstPadChainListFunction chainlistfunc;
4163 if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
4166 GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4167 "calling chainlistfunction &%s",
4168 GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
4170 ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
4172 GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
4173 "called chainlistfunction &%s, returned %s",
4174 GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
4177 RELEASE_PARENT (parent);
4179 GST_PAD_STREAM_UNLOCK (pad);
4186 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4187 "chaining, but pad was flushing");
4188 GST_OBJECT_UNLOCK (pad);
4189 GST_PAD_STREAM_UNLOCK (pad);
4190 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4191 return GST_FLOW_FLUSHING;
4195 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "chaining, but pad was EOS");
4196 GST_OBJECT_UNLOCK (pad);
4197 GST_PAD_STREAM_UNLOCK (pad);
4198 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4199 return GST_FLOW_EOS;
4203 g_critical ("chain on pad %s:%s but it was not in push mode",
4204 GST_DEBUG_PAD_NAME (pad));
4205 GST_OBJECT_UNLOCK (pad);
4206 GST_PAD_STREAM_UNLOCK (pad);
4207 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4208 return GST_FLOW_ERROR;
4215 GST_OBJECT_UNLOCK (pad);
4216 GST_PAD_STREAM_UNLOCK (pad);
4217 /* We unref the buffer, except if the probe handled it (CUSTOM_SUCCESS_1) */
4219 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4222 case GST_FLOW_CUSTOM_SUCCESS:
4223 case GST_FLOW_CUSTOM_SUCCESS_1:
4224 GST_DEBUG_OBJECT (pad, "dropped or handled buffer");
4228 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4235 GST_DEBUG_OBJECT (pad, "No parent when chaining %" GST_PTR_FORMAT, data);
4236 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4237 GST_OBJECT_UNLOCK (pad);
4238 GST_PAD_STREAM_UNLOCK (pad);
4239 return GST_FLOW_FLUSHING;
4243 RELEASE_PARENT (parent);
4244 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4245 g_critical ("chain on pad %s:%s but it has no chainfunction",
4246 GST_DEBUG_PAD_NAME (pad));
4247 GST_PAD_STREAM_UNLOCK (pad);
4248 return GST_FLOW_NOT_SUPPORTED;
4254 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4255 * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
4258 * Chain a buffer to @pad.
4260 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4262 * If the buffer type is not acceptable for @pad (as negotiated with a
4263 * preceding GST_EVENT_CAPS event), this function returns
4264 * #GST_FLOW_NOT_NEGOTIATED.
4266 * The function proceeds calling the chain function installed on @pad (see
4267 * gst_pad_set_chain_function()) and the return value of that function is
4268 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4271 * In all cases, success or failure, the caller loses its reference to @buffer
4272 * after calling this function.
4274 * Returns: a #GstFlowReturn from the pad.
4279 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
4281 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4282 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4283 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4285 return gst_pad_chain_data_unchecked (pad,
4286 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4289 static GstFlowReturn
4290 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
4291 GstBufferList * list)
4297 GST_INFO_OBJECT (pad, "chaining each buffer in list individually");
4299 len = gst_buffer_list_length (list);
4302 for (i = 0; i < len; i++) {
4303 buffer = gst_buffer_list_get (list, i);
4305 gst_pad_chain_data_unchecked (pad,
4306 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
4307 gst_buffer_ref (buffer));
4308 if (ret != GST_FLOW_OK)
4311 gst_buffer_list_unref (list);
4317 * gst_pad_chain_list:
4318 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4319 * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
4322 * Chain a bufferlist to @pad.
4324 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4326 * If @pad was not negotiated properly with a CAPS event, this function
4327 * returns #GST_FLOW_NOT_NEGOTIATED.
4329 * The function proceeds calling the chainlist function installed on @pad (see
4330 * gst_pad_set_chain_list_function()) and the return value of that function is
4331 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4332 * chainlist function.
4334 * In all cases, success or failure, the caller loses its reference to @list
4335 * after calling this function.
4339 * Returns: a #GstFlowReturn from the pad.
4342 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
4344 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4345 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4346 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4348 return gst_pad_chain_data_unchecked (pad,
4349 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4352 static GstFlowReturn
4353 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
4357 gboolean handled = FALSE;
4359 GST_OBJECT_LOCK (pad);
4360 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4363 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4366 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4369 #ifdef GST_ENABLE_EXTRA_CHECKS
4370 if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4371 if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4373 ":%s:<%s:%s> Got data flow before stream-start event",
4374 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4376 if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4378 ":%s:<%s:%s> Got data flow before segment event",
4379 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4381 pad->priv->last_cookie = pad->priv->events_cookie;
4385 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4388 /* do block probes */
4389 PROBE_HANDLE (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped,
4392 /* recheck sticky events because the probe might have cause a relink */
4393 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4396 /* do post-blocking probes */
4397 PROBE_HANDLE (pad, type, data, probe_stopped, probe_handled);
4399 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4402 /* take ref to peer pad before releasing the lock */
4403 gst_object_ref (peer);
4405 GST_OBJECT_UNLOCK (pad);
4407 ret = gst_pad_chain_data_unchecked (peer, type, data);
4410 gst_object_unref (peer);
4412 GST_OBJECT_LOCK (pad);
4413 pad->ABI.abi.last_flowret = ret;
4415 if (pad->priv->using == 0) {
4416 /* pad is not active anymore, trigger idle callbacks */
4417 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4418 probe_stopped, ret);
4420 GST_OBJECT_UNLOCK (pad);
4424 /* ERROR recovery here */
4428 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4429 "pushing, but pad was flushing");
4430 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4431 GST_OBJECT_UNLOCK (pad);
4432 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4433 return GST_FLOW_FLUSHING;
4437 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pushing, but pad was EOS");
4438 pad->ABI.abi.last_flowret = GST_FLOW_EOS;
4439 GST_OBJECT_UNLOCK (pad);
4440 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4441 return GST_FLOW_EOS;
4445 g_critical ("pushing on pad %s:%s but it was not activated in push mode",
4446 GST_DEBUG_PAD_NAME (pad));
4447 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4448 GST_OBJECT_UNLOCK (pad);
4449 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4450 return GST_FLOW_ERROR;
4454 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4455 "error pushing events, return %s", gst_flow_get_name (ret));
4456 pad->ABI.abi.last_flowret = ret;
4457 GST_OBJECT_UNLOCK (pad);
4458 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4466 GST_OBJECT_UNLOCK (pad);
4467 if (data != NULL && !handled)
4468 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4471 case GST_FLOW_CUSTOM_SUCCESS:
4472 case GST_FLOW_CUSTOM_SUCCESS_1:
4473 GST_DEBUG_OBJECT (pad, "dropped or handled buffer");
4477 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4480 pad->ABI.abi.last_flowret = ret;
4485 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4486 "pushing, but it was not linked");
4487 pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4488 GST_OBJECT_UNLOCK (pad);
4489 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4490 return GST_FLOW_NOT_LINKED;
4496 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4497 * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
4500 * Pushes a buffer to the peer of @pad.
4502 * This function will call installed block probes before triggering any
4503 * installed data probes.
4505 * The function proceeds calling gst_pad_chain() on the peer pad and returns
4506 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4509 * In all cases, success or failure, the caller loses its reference to @buffer
4510 * after calling this function.
4512 * Returns: a #GstFlowReturn from the peer pad.
4517 gst_pad_push (GstPad * pad, GstBuffer * buffer)
4521 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4522 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4523 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4525 GST_TRACER_PAD_PUSH_PRE (pad, buffer);
4526 res = gst_pad_push_data (pad,
4527 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4528 GST_TRACER_PAD_PUSH_POST (pad, res);
4533 * gst_pad_push_list:
4534 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4535 * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
4538 * Pushes a buffer list to the peer of @pad.
4540 * This function will call installed block probes before triggering any
4541 * installed data probes.
4543 * The function proceeds calling the chain function on the peer pad and returns
4544 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4545 * be returned. If the peer pad does not have any installed chainlist function
4546 * every group buffer of the list will be merged into a normal #GstBuffer and
4547 * chained via gst_pad_chain().
4549 * In all cases, success or failure, the caller loses its reference to @list
4550 * after calling this function.
4552 * Returns: a #GstFlowReturn from the peer pad.
4557 gst_pad_push_list (GstPad * pad, GstBufferList * list)
4561 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4562 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4563 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4565 GST_TRACER_PAD_PUSH_LIST_PRE (pad, list);
4566 res = gst_pad_push_data (pad,
4567 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4568 GST_TRACER_PAD_PUSH_LIST_POST (pad, res);
4572 static GstFlowReturn
4573 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
4574 GstBuffer ** buffer)
4577 GstPadGetRangeFunction getrangefunc;
4581 GST_PAD_STREAM_LOCK (pad);
4583 GST_OBJECT_LOCK (pad);
4584 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4587 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4590 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4595 /* when one of the probes returns DROPPED, probe_stopped will be called
4596 * and we skip calling the getrange function, res_buf should then contain a
4597 * valid result buffer */
4598 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4599 res_buf, offset, size, probe_stopped);
4601 /* recheck sticky events because the probe might have cause a relink */
4602 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4605 ACQUIRE_PARENT (pad, parent, no_parent);
4606 GST_OBJECT_UNLOCK (pad);
4608 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
4611 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4612 "calling getrangefunc %s, offset %"
4613 G_GUINT64_FORMAT ", size %u",
4614 GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
4616 ret = getrangefunc (pad, parent, offset, size, &res_buf);
4618 RELEASE_PARENT (parent);
4620 GST_OBJECT_LOCK (pad);
4621 if (G_UNLIKELY (ret != GST_FLOW_OK))
4622 goto get_range_failed;
4624 /* can only fire the signal if we have a valid buffer */
4626 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4627 res_buf, offset, size, probe_stopped_unref);
4628 pad->ABI.abi.last_flowret = ret;
4629 GST_OBJECT_UNLOCK (pad);
4631 GST_PAD_STREAM_UNLOCK (pad);
4640 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4641 "getrange, but pad was flushing");
4642 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4643 GST_OBJECT_UNLOCK (pad);
4644 GST_PAD_STREAM_UNLOCK (pad);
4645 return GST_FLOW_FLUSHING;
4649 g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
4650 GST_DEBUG_PAD_NAME (pad));
4651 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4652 GST_OBJECT_UNLOCK (pad);
4653 GST_PAD_STREAM_UNLOCK (pad);
4654 return GST_FLOW_ERROR;
4658 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
4659 pad->ABI.abi.last_flowret = ret;
4660 GST_OBJECT_UNLOCK (pad);
4661 GST_PAD_STREAM_UNLOCK (pad);
4666 GST_DEBUG_OBJECT (pad, "no parent");
4667 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4668 GST_OBJECT_UNLOCK (pad);
4669 GST_PAD_STREAM_UNLOCK (pad);
4670 return GST_FLOW_FLUSHING;
4674 g_critical ("getrange on pad %s:%s but it has no getrangefunction",
4675 GST_DEBUG_PAD_NAME (pad));
4676 RELEASE_PARENT (parent);
4677 GST_PAD_STREAM_UNLOCK (pad);
4678 return GST_FLOW_NOT_SUPPORTED;
4682 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4683 "probe returned %s", gst_flow_get_name (ret));
4684 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4686 /* the probe filled the buffer and asks us to not call the getrange
4687 * anymore, we continue with the post probes then. */
4688 GST_DEBUG_OBJECT (pad, "handled buffer");
4692 /* no buffer, we are EOS */
4693 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4697 pad->ABI.abi.last_flowret = ret;
4698 GST_OBJECT_UNLOCK (pad);
4699 GST_PAD_STREAM_UNLOCK (pad);
4703 probe_stopped_unref:
4705 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4706 "probe returned %s", gst_flow_get_name (ret));
4707 /* if we drop here, it signals EOS */
4708 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4710 pad->ABI.abi.last_flowret = ret;
4711 GST_OBJECT_UNLOCK (pad);
4712 GST_PAD_STREAM_UNLOCK (pad);
4713 if (*buffer == NULL)
4714 gst_buffer_unref (res_buf);
4719 pad->ABI.abi.last_flowret = ret;
4720 GST_OBJECT_UNLOCK (pad);
4721 GST_PAD_STREAM_UNLOCK (pad);
4722 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4723 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4724 pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
4730 * gst_pad_get_range:
4731 * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4732 * @offset: The start offset of the buffer
4733 * @size: The length of the buffer
4734 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
4735 * returns #GST_FLOW_ERROR if %NULL.
4737 * When @pad is flushing this function returns #GST_FLOW_FLUSHING
4738 * immediately and @buffer is %NULL.
4740 * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4741 * description of a getrange function. If @pad has no getrange function
4742 * installed (see gst_pad_set_getrange_function()) this function returns
4743 * #GST_FLOW_NOT_SUPPORTED.
4745 * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4746 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4747 * must be freed with gst_buffer_unref() after usage.
4749 * When @buffer points to a variable that points to a valid #GstBuffer, the
4750 * buffer will be filled with the result data when this function returns
4751 * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4752 * @size bytes will be filled in the result buffer and its size will be updated
4755 * Note that less than @size bytes can be returned in @buffer when, for example,
4756 * an EOS condition is near or when @buffer is not large enough to hold @size
4757 * bytes. The caller should check the result buffer size to get the result size.
4759 * When this function returns any other result value than #GST_FLOW_OK, @buffer
4760 * will be unchanged.
4762 * This is a lowlevel function. Usually gst_pad_pull_range() is used.
4764 * Returns: a #GstFlowReturn from the pad.
4769 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4770 GstBuffer ** buffer)
4772 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4773 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4774 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4775 g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4776 && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4778 return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4782 * gst_pad_pull_range:
4783 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4784 * @offset: The start offset of the buffer
4785 * @size: The length of the buffer
4786 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4787 * GST_FLOW_ERROR if %NULL.
4789 * Pulls a @buffer from the peer pad or fills up a provided buffer.
4791 * This function will first trigger the pad block signal if it was
4794 * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4795 * function returns the result of gst_pad_get_range() on the peer pad.
4796 * See gst_pad_get_range() for a list of return values and for the
4797 * semantics of the arguments of this function.
4799 * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4800 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4801 * must be freed with gst_buffer_unref() after usage. When this function
4802 * returns any other result value, @buffer will still point to %NULL.
4804 * When @buffer points to a variable that points to a valid #GstBuffer, the
4805 * buffer will be filled with the result data when this function returns
4806 * #GST_FLOW_OK. When this function returns any other result value,
4807 * @buffer will be unchanged. If the provided buffer is larger than @size, only
4808 * @size bytes will be filled in the result buffer and its size will be updated
4811 * Note that less than @size bytes can be returned in @buffer when, for example,
4812 * an EOS condition is near or when @buffer is not large enough to hold @size
4813 * bytes. The caller should check the result buffer size to get the result size.
4815 * Returns: a #GstFlowReturn from the peer pad.
4820 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4821 GstBuffer ** buffer)
4827 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4828 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4829 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4830 g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4831 && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4833 GST_TRACER_PAD_PULL_RANGE_PRE (pad, offset, size);
4835 GST_OBJECT_LOCK (pad);
4836 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4839 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4844 /* when one of the probes returns DROPPED, probe_stopped will be
4845 * called and we skip calling the peer getrange function. *buffer should then
4846 * contain a valid buffer */
4847 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4848 res_buf, offset, size, probe_stopped);
4850 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4853 gst_object_ref (peer);
4855 GST_OBJECT_UNLOCK (pad);
4857 ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4859 gst_object_unref (peer);
4861 GST_OBJECT_LOCK (pad);
4863 pad->ABI.abi.last_flowret = ret;
4864 if (pad->priv->using == 0) {
4865 /* pad is not active anymore, trigger idle callbacks */
4866 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4867 probe_stopped_unref, ret);
4870 if (G_UNLIKELY (ret != GST_FLOW_OK))
4871 goto pull_range_failed;
4874 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4875 res_buf, offset, size, probe_stopped_unref);
4877 GST_OBJECT_UNLOCK (pad);
4881 GST_TRACER_PAD_PULL_RANGE_POST (pad, *buffer, ret);
4884 /* ERROR recovery here */
4887 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4888 "pullrange, but pad was flushing");
4889 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4890 GST_OBJECT_UNLOCK (pad);
4891 ret = GST_FLOW_FLUSHING;
4896 g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4897 GST_DEBUG_PAD_NAME (pad));
4898 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4899 GST_OBJECT_UNLOCK (pad);
4900 ret = GST_FLOW_ERROR;
4905 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4906 gst_flow_get_name (ret));
4907 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4909 /* the probe filled the buffer and asks us to not forward to the peer
4910 * anymore, we continue with the post probes then */
4911 GST_DEBUG_OBJECT (pad, "handled buffer");
4915 /* no buffer, we are EOS then */
4916 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4920 pad->ABI.abi.last_flowret = ret;
4921 GST_OBJECT_UNLOCK (pad);
4926 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4927 "pulling range, but it was not linked");
4928 pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4929 GST_OBJECT_UNLOCK (pad);
4930 ret = GST_FLOW_NOT_LINKED;
4935 pad->ABI.abi.last_flowret = ret;
4936 GST_OBJECT_UNLOCK (pad);
4937 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4938 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4939 pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4942 probe_stopped_unref:
4944 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4945 "post probe returned %s", gst_flow_get_name (ret));
4947 /* if we drop here, it signals EOS */
4948 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4951 pad->ABI.abi.last_flowret = ret;
4952 GST_OBJECT_UNLOCK (pad);
4954 if (*buffer == NULL)
4955 gst_buffer_unref (res_buf);
4959 GST_TRACER_PAD_PULL_RANGE_POST (pad, NULL, ret);
4963 /* must be called with pad object lock */
4964 static GstFlowReturn
4965 store_sticky_event (GstPad * pad, GstEvent * event)
4970 gboolean res = FALSE;
4971 const gchar *name = NULL;
4972 gboolean insert = TRUE;
4974 type = GST_EVENT_TYPE (event);
4976 /* Store all sticky events except SEGMENT/EOS when we're flushing,
4977 * otherwise they can be dropped and nothing would ever resend them.
4978 * Only do that for activated pads though, everything else is a bug!
4980 if (G_UNLIKELY (GST_PAD_MODE (pad) == GST_PAD_MODE_NONE
4981 || (GST_PAD_IS_FLUSHING (pad) && (type == GST_EVENT_SEGMENT
4982 || type == GST_EVENT_EOS))))
4985 /* Unset the EOS flag when received STREAM_START event, so pad can
4986 * store sticky event and then push it later */
4987 if (type == GST_EVENT_STREAM_START) {
4988 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4989 remove_event_by_type (pad, GST_EVENT_EOS);
4990 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
4993 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4996 if (type & GST_EVENT_TYPE_STICKY_MULTI)
4997 name = gst_structure_get_name (gst_event_get_structure (event));
4999 events = pad->priv->events;
5002 for (i = 0; i < len; i++) {
5003 PadEvent *ev = &g_array_index (events, PadEvent, i);
5005 if (ev->event == NULL)
5008 if (type == GST_EVENT_TYPE (ev->event)) {
5009 /* matching types, check matching name if needed */
5010 if (name && !gst_event_has_name (ev->event, name))
5014 if ((res = gst_event_replace (&ev->event, event)))
5015 ev->received = FALSE;
5021 if (type < GST_EVENT_TYPE (ev->event) || (type != GST_EVENT_TYPE (ev->event)
5022 && GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS)) {
5023 /* STREAM_START, CAPS and SEGMENT must be delivered in this order. By
5024 * storing the sticky ordered we can check that this is respected. */
5025 if (G_UNLIKELY (GST_EVENT_TYPE (ev->event) <= GST_EVENT_SEGMENT
5026 || GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS))
5028 ":%s:<%s:%s> Sticky event misordering, got '%s' before '%s'",
5029 G_STRFUNC, GST_DEBUG_PAD_NAME (pad),
5030 gst_event_type_get_name (GST_EVENT_TYPE (ev->event)),
5031 gst_event_type_get_name (type));
5037 ev.event = gst_event_ref (event);
5038 ev.received = FALSE;
5039 g_array_insert_val (events, i, ev);
5044 pad->priv->events_cookie++;
5045 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5047 GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
5049 switch (GST_EVENT_TYPE (event)) {
5050 case GST_EVENT_CAPS:
5051 GST_OBJECT_UNLOCK (pad);
5053 GST_DEBUG_OBJECT (pad, "notify caps");
5054 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
5056 GST_OBJECT_LOCK (pad);
5062 if (type == GST_EVENT_EOS) {
5063 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
5064 pad->ABI.abi.last_flowret = GST_FLOW_EOS;
5067 return GST_PAD_IS_FLUSHING (pad) ? GST_FLOW_FLUSHING : GST_FLOW_OK;
5072 GST_DEBUG_OBJECT (pad, "pad is flushing");
5073 return GST_FLOW_FLUSHING;
5077 GST_DEBUG_OBJECT (pad, "pad is EOS");
5078 return GST_FLOW_EOS;
5083 * gst_pad_store_sticky_event:
5085 * @event: a #GstEvent
5087 * Store the sticky @event on @pad
5089 * Returns: #GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad
5090 * was flushing or #GST_FLOW_EOS when the pad was EOS.
5095 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event)
5099 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5100 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
5102 GST_OBJECT_LOCK (pad);
5103 ret = store_sticky_event (pad, event);
5104 GST_OBJECT_UNLOCK (pad);
5110 sticky_changed (GstPad * pad, PadEvent * ev, gpointer user_data)
5112 PushStickyData *data = user_data;
5114 /* Forward all sticky events before our current one that are pending */
5115 if (ev->event != data->event
5116 && GST_EVENT_TYPE (ev->event) < GST_EVENT_TYPE (data->event))
5117 return push_sticky (pad, ev, data);
5122 /* should be called with pad LOCK */
5123 static GstFlowReturn
5124 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
5125 GstPadProbeType type)
5129 GstEventType event_type;
5131 /* pass the adjusted event on. We need to do this even if
5132 * there is no peer pad because of the probes. */
5133 event = apply_pad_offset (pad, event, GST_PAD_IS_SINK (pad));
5135 /* Two checks to be made:
5136 * . (un)set the FLUSHING flag for flushing events,
5137 * . handle pad blocking */
5138 event_type = GST_EVENT_TYPE (event);
5139 switch (event_type) {
5140 case GST_EVENT_FLUSH_START:
5141 GST_PAD_SET_FLUSHING (pad);
5143 GST_PAD_BLOCK_BROADCAST (pad);
5144 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5146 case GST_EVENT_FLUSH_STOP:
5147 if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
5150 GST_PAD_UNSET_FLUSHING (pad);
5152 /* Remove sticky EOS events */
5153 GST_LOG_OBJECT (pad, "Removing pending EOS events");
5154 remove_event_by_type (pad, GST_EVENT_EOS);
5155 remove_event_by_type (pad, GST_EVENT_SEGMENT);
5156 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5157 pad->ABI.abi.last_flowret = GST_FLOW_OK;
5159 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5163 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5166 /* No need to check for EOS here as either the caller (gst_pad_push_event())
5167 * checked already or this is called as part of pushing sticky events,
5168 * in which case we still want to forward the EOS event downstream.
5171 switch (GST_EVENT_TYPE (event)) {
5172 case GST_EVENT_RECONFIGURE:
5173 if (GST_PAD_IS_SINK (pad))
5174 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5179 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
5180 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5185 /* send probes after modifying the events above */
5186 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5188 /* recheck sticky events because the probe might have cause a relink */
5189 if (GST_PAD_HAS_PENDING_EVENTS (pad) && GST_PAD_IS_SRC (pad)
5190 && (GST_EVENT_IS_SERIALIZED (event)
5191 || GST_EVENT_IS_STICKY (event))) {
5192 PushStickyData data = { GST_FLOW_OK, FALSE, event };
5193 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5195 /* Push all sticky events before our current one
5196 * that have changed */
5197 events_foreach (pad, sticky_changed, &data);
5200 /* now check the peer pad */
5201 peerpad = GST_PAD_PEER (pad);
5202 if (peerpad == NULL)
5205 gst_object_ref (peerpad);
5207 GST_OBJECT_UNLOCK (pad);
5209 GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
5210 event, gst_event_type_get_name (event_type), peerpad);
5212 ret = gst_pad_send_event_unchecked (peerpad, event, type);
5214 /* Note: we gave away ownership of the event at this point but we can still
5215 * print the old pointer */
5216 GST_LOG_OBJECT (pad,
5217 "sent event %p (%s) to peerpad %" GST_PTR_FORMAT ", ret %s", event,
5218 gst_event_type_get_name (event_type), peerpad, gst_flow_get_name (ret));
5220 gst_object_unref (peerpad);
5222 GST_OBJECT_LOCK (pad);
5224 if (pad->priv->using == 0) {
5225 /* pad is not active anymore, trigger idle callbacks */
5226 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
5227 idle_probe_stopped, ret);
5231 /* ERROR handling */
5234 GST_DEBUG_OBJECT (pad, "We're flushing");
5235 gst_event_unref (event);
5236 return GST_FLOW_FLUSHING;
5240 GST_DEBUG_OBJECT (pad, "flush-stop on inactive pad");
5241 gst_event_unref (event);
5242 return GST_FLOW_FLUSHING;
5246 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5247 if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
5248 gst_event_unref (event);
5251 case GST_FLOW_CUSTOM_SUCCESS_1:
5252 GST_DEBUG_OBJECT (pad, "handled event");
5254 case GST_FLOW_CUSTOM_SUCCESS:
5255 GST_DEBUG_OBJECT (pad, "dropped event");
5258 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5265 GST_DEBUG_OBJECT (pad, "Dropping event %s because pad is not linked",
5266 gst_event_type_get_name (GST_EVENT_TYPE (event)));
5267 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5268 gst_event_unref (event);
5270 /* unlinked pads should not influence latency configuration */
5271 if (event_type == GST_EVENT_LATENCY)
5274 return GST_FLOW_NOT_LINKED;
5278 GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
5284 * gst_pad_push_event:
5285 * @pad: a #GstPad to push the event to.
5286 * @event: (transfer full): the #GstEvent to send to the pad.
5288 * Sends the event to the peer of the given pad. This function is
5289 * mainly used by elements to send events to their peer
5292 * This function takes ownership of the provided event so you should
5293 * gst_event_ref() it if you want to reuse the event after this call.
5295 * Returns: %TRUE if the event was handled.
5300 gst_pad_push_event (GstPad * pad, GstEvent * event)
5302 gboolean res = FALSE;
5303 GstPadProbeType type;
5304 gboolean sticky, serialized;
5306 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5307 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
5309 GST_TRACER_PAD_PUSH_EVENT_PRE (pad, event);
5311 if (GST_PAD_IS_SRC (pad)) {
5312 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5313 goto wrong_direction;
5314 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5315 } else if (GST_PAD_IS_SINK (pad)) {
5316 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5317 goto wrong_direction;
5318 /* events pushed on sinkpad never are sticky */
5319 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5321 goto unknown_direction;
5323 GST_OBJECT_LOCK (pad);
5324 sticky = GST_EVENT_IS_STICKY (event);
5325 serialized = GST_EVENT_IS_SERIALIZED (event);
5328 /* srcpad sticky events are stored immediately, the received flag is set
5329 * to FALSE and will be set to TRUE when we can successfully push the
5330 * event to the peer pad */
5331 switch (store_sticky_event (pad, event)) {
5332 case GST_FLOW_FLUSHING:
5340 if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
5341 /* all serialized or sticky events on the srcpad trigger push of
5343 res = (check_sticky (pad, event) == GST_FLOW_OK);
5348 /* other events are pushed right away */
5349 ret = gst_pad_push_event_unchecked (pad, event, type);
5350 /* dropped events by a probe are not an error */
5351 res = (ret == GST_FLOW_OK || ret == GST_FLOW_CUSTOM_SUCCESS
5352 || ret == GST_FLOW_CUSTOM_SUCCESS_1);
5354 /* Errors in sticky event pushing are no problem and ignored here
5355 * as they will cause more meaningful errors during data flow.
5356 * For EOS events, that are not followed by data flow, we still
5357 * return FALSE here though.
5359 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
5361 gst_event_unref (event);
5363 GST_OBJECT_UNLOCK (pad);
5365 GST_TRACER_PAD_PUSH_EVENT_POST (pad, res);
5368 /* ERROR handling */
5371 g_warning ("pad %s:%s pushing %s event in wrong direction",
5372 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5373 gst_event_unref (event);
5378 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5379 gst_event_unref (event);
5384 GST_DEBUG_OBJECT (pad, "We're flushing");
5385 GST_OBJECT_UNLOCK (pad);
5386 gst_event_unref (event);
5391 GST_DEBUG_OBJECT (pad, "We're EOS");
5392 GST_OBJECT_UNLOCK (pad);
5393 gst_event_unref (event);
5397 GST_TRACER_PAD_PUSH_EVENT_POST (pad, FALSE);
5401 /* Check if we can call the event function with the given event */
5402 static GstFlowReturn
5403 pre_eventfunc_check (GstPad * pad, GstEvent * event)
5407 switch (GST_EVENT_TYPE (event)) {
5408 case GST_EVENT_CAPS:
5410 /* backwards compatibility mode for caps */
5411 gst_event_parse_caps (event, &caps);
5413 if (!gst_pad_query_accept_caps (pad, caps))
5425 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
5426 "caps %" GST_PTR_FORMAT " not accepted", caps);
5427 return GST_FLOW_NOT_NEGOTIATED;
5431 static GstFlowReturn
5432 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
5433 GstPadProbeType type)
5436 GstEventType event_type;
5437 gboolean serialized, need_unlock = FALSE, sticky;
5438 GstPadEventFunction eventfunc;
5439 GstPadEventFullFunction eventfullfunc = NULL;
5442 GST_OBJECT_LOCK (pad);
5444 event = apply_pad_offset (pad, event, GST_PAD_IS_SRC (pad));
5446 if (GST_PAD_IS_SINK (pad))
5447 serialized = GST_EVENT_IS_SERIALIZED (event);
5450 sticky = GST_EVENT_IS_STICKY (event);
5451 event_type = GST_EVENT_TYPE (event);
5452 switch (event_type) {
5453 case GST_EVENT_FLUSH_START:
5454 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5455 "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
5457 /* can't even accept a flush begin event when flushing */
5458 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5461 GST_PAD_SET_FLUSHING (pad);
5462 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
5463 GST_PAD_BLOCK_BROADCAST (pad);
5464 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
5466 case GST_EVENT_FLUSH_STOP:
5467 /* we can't accept flush-stop on inactive pads else the flushing flag
5468 * would be cleared and it would look like the pad can accept data.
5469 * Also, some elements restart a streaming thread in flush-stop which we
5470 * can't allow on inactive pads */
5471 if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
5474 GST_PAD_UNSET_FLUSHING (pad);
5475 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
5476 /* Remove pending EOS events */
5477 GST_LOG_OBJECT (pad, "Removing pending EOS and SEGMENT events");
5478 remove_event_by_type (pad, GST_EVENT_EOS);
5479 remove_event_by_type (pad, GST_EVENT_SEGMENT);
5480 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5481 pad->ABI.abi.last_flowret = GST_FLOW_OK;
5483 GST_OBJECT_UNLOCK (pad);
5484 /* grab stream lock */
5485 GST_PAD_STREAM_LOCK (pad);
5487 GST_OBJECT_LOCK (pad);
5488 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5491 case GST_EVENT_RECONFIGURE:
5492 if (GST_PAD_IS_SRC (pad))
5493 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5495 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5496 "have event type %" GST_PTR_FORMAT, event);
5498 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5501 switch (event_type) {
5502 case GST_EVENT_STREAM_START:
5503 /* Remove sticky EOS events */
5504 GST_LOG_OBJECT (pad, "Removing pending EOS events");
5505 remove_event_by_type (pad, GST_EVENT_EOS);
5506 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5513 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5516 /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
5517 GST_OBJECT_UNLOCK (pad);
5518 GST_PAD_STREAM_LOCK (pad);
5520 GST_OBJECT_LOCK (pad);
5521 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5524 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5530 /* now do the probe */
5532 type | GST_PAD_PROBE_TYPE_PUSH |
5533 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5535 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5537 eventfullfunc = GST_PAD_EVENTFULLFUNC (pad);
5538 eventfunc = GST_PAD_EVENTFUNC (pad);
5539 if (G_UNLIKELY (eventfunc == NULL && eventfullfunc == NULL))
5542 ACQUIRE_PARENT (pad, parent, no_parent);
5543 GST_OBJECT_UNLOCK (pad);
5545 ret = pre_eventfunc_check (pad, event);
5546 if (G_UNLIKELY (ret != GST_FLOW_OK))
5547 goto precheck_failed;
5550 gst_event_ref (event);
5552 if (eventfullfunc) {
5553 ret = eventfullfunc (pad, parent, event);
5554 } else if (eventfunc (pad, parent, event)) {
5557 /* something went wrong */
5558 switch (event_type) {
5559 case GST_EVENT_CAPS:
5560 ret = GST_FLOW_NOT_NEGOTIATED;
5563 ret = GST_FLOW_ERROR;
5567 RELEASE_PARENT (parent);
5569 GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
5572 if (ret == GST_FLOW_OK) {
5573 GST_OBJECT_LOCK (pad);
5574 /* after the event function accepted the event, we can store the sticky
5575 * event on the pad */
5576 switch (store_sticky_event (pad, event)) {
5577 case GST_FLOW_FLUSHING:
5584 GST_OBJECT_UNLOCK (pad);
5586 gst_event_unref (event);
5590 GST_PAD_STREAM_UNLOCK (pad);
5594 /* ERROR handling */
5597 GST_OBJECT_UNLOCK (pad);
5599 GST_PAD_STREAM_UNLOCK (pad);
5600 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5601 "Received event on flushing pad. Discarding");
5602 gst_event_unref (event);
5603 return GST_FLOW_FLUSHING;
5607 GST_OBJECT_UNLOCK (pad);
5609 GST_PAD_STREAM_UNLOCK (pad);
5610 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5611 "Received flush-stop on inactive pad. Discarding");
5612 gst_event_unref (event);
5613 return GST_FLOW_FLUSHING;
5617 GST_OBJECT_UNLOCK (pad);
5619 GST_PAD_STREAM_UNLOCK (pad);
5620 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5621 "Received event on EOS pad. Discarding");
5622 gst_event_unref (event);
5623 return GST_FLOW_EOS;
5627 GST_OBJECT_UNLOCK (pad);
5629 GST_PAD_STREAM_UNLOCK (pad);
5630 /* Only unref if unhandled */
5631 if (ret != GST_FLOW_CUSTOM_SUCCESS_1)
5632 gst_event_unref (event);
5635 case GST_FLOW_CUSTOM_SUCCESS_1:
5636 case GST_FLOW_CUSTOM_SUCCESS:
5637 GST_DEBUG_OBJECT (pad, "dropped or handled event");
5641 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5648 g_warning ("pad %s:%s has no event handler, file a bug.",
5649 GST_DEBUG_PAD_NAME (pad));
5650 GST_OBJECT_UNLOCK (pad);
5652 GST_PAD_STREAM_UNLOCK (pad);
5653 gst_event_unref (event);
5654 return GST_FLOW_NOT_SUPPORTED;
5658 GST_DEBUG_OBJECT (pad, "no parent");
5659 GST_OBJECT_UNLOCK (pad);
5661 GST_PAD_STREAM_UNLOCK (pad);
5662 gst_event_unref (event);
5663 return GST_FLOW_FLUSHING;
5667 GST_DEBUG_OBJECT (pad, "pre event check failed");
5668 RELEASE_PARENT (parent);
5670 GST_PAD_STREAM_UNLOCK (pad);
5671 gst_event_unref (event);
5677 * gst_pad_send_event:
5678 * @pad: a #GstPad to send the event to.
5679 * @event: (transfer full): the #GstEvent to send to the pad.
5681 * Sends the event to the pad. This function can be used
5682 * by applications to send events in the pipeline.
5684 * If @pad is a source pad, @event should be an upstream event. If @pad is a
5685 * sink pad, @event should be a downstream event. For example, you would not
5686 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
5687 * Furthermore, some downstream events have to be serialized with data flow,
5688 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
5689 * the event needs to be serialized with data flow, this function will take the
5690 * pad's stream lock while calling its event function.
5692 * To find out whether an event type is upstream, downstream, or downstream and
5693 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
5694 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
5695 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
5696 * plugin doesn't need to bother itself with this information; the core handles
5697 * all necessary locks and checks.
5699 * This function takes ownership of the provided event so you should
5700 * gst_event_ref() it if you want to reuse the event after this call.
5702 * Returns: %TRUE if the event was handled.
5705 gst_pad_send_event (GstPad * pad, GstEvent * event)
5708 GstPadProbeType type;
5710 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5711 g_return_val_if_fail (event != NULL, FALSE);
5713 if (GST_PAD_IS_SINK (pad)) {
5714 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5715 goto wrong_direction;
5716 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5717 } else if (GST_PAD_IS_SRC (pad)) {
5718 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5719 goto wrong_direction;
5720 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5722 goto unknown_direction;
5724 if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
5731 /* ERROR handling */
5734 g_warning ("pad %s:%s sending %s event in wrong direction",
5735 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5736 gst_event_unref (event);
5741 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5742 gst_event_unref (event);
5748 * gst_pad_set_element_private:
5749 * @pad: the #GstPad to set the private data of.
5750 * @priv: The private data to attach to the pad.
5752 * Set the given private data gpointer on the pad.
5753 * This function can only be used by the element that owns the pad.
5754 * No locking is performed in this function.
5757 gst_pad_set_element_private (GstPad * pad, gpointer priv)
5759 pad->element_private = priv;
5763 * gst_pad_get_element_private:
5764 * @pad: the #GstPad to get the private data of.
5766 * Gets the private data of a pad.
5767 * No locking is performed in this function.
5769 * Returns: (transfer none): a #gpointer to the private data.
5772 gst_pad_get_element_private (GstPad * pad)
5774 return pad->element_private;
5778 * gst_pad_get_sticky_event:
5779 * @pad: the #GstPad to get the event from.
5780 * @event_type: the #GstEventType that should be retrieved.
5781 * @idx: the index of the event
5783 * Returns a new reference of the sticky event of type @event_type
5786 * Returns: (transfer full) (nullable): a #GstEvent of type
5787 * @event_type or %NULL when no event of @event_type was on
5788 * @pad. Unref after usage.
5791 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
5793 GstEvent *event = NULL;
5796 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
5797 g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
5799 GST_OBJECT_LOCK (pad);
5800 ev = find_event_by_type (pad, event_type, idx);
5801 if (ev && (event = ev->event))
5802 gst_event_ref (event);
5803 GST_OBJECT_UNLOCK (pad);
5810 GstPadStickyEventsForeachFunction func;
5815 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
5817 ForeachDispatch *data = user_data;
5818 gboolean ret = TRUE;
5821 GST_OBJECT_UNLOCK (pad);
5823 ret = data->func (pad, &ev->event, data->user_data);
5825 GST_OBJECT_LOCK (pad);
5832 * gst_pad_sticky_events_foreach:
5833 * @pad: the #GstPad that should be used for iteration.
5834 * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
5835 * should be called for every event.
5836 * @user_data: (closure): the optional user data.
5838 * Iterates all sticky events on @pad and calls @foreach_func for every
5839 * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
5842 gst_pad_sticky_events_foreach (GstPad * pad,
5843 GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
5845 ForeachDispatch data;
5847 g_return_if_fail (GST_IS_PAD (pad));
5848 g_return_if_fail (foreach_func != NULL);
5850 data.func = foreach_func;
5851 data.user_data = user_data;
5853 GST_OBJECT_LOCK (pad);
5854 events_foreach (pad, foreach_dispatch_function, &data);
5855 GST_OBJECT_UNLOCK (pad);
5859 do_stream_status (GstPad * pad, GstStreamStatusType type,
5860 GThread * thread, GstTask * task)
5864 GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5866 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5867 if (GST_IS_ELEMENT (parent)) {
5868 GstMessage *message;
5869 GValue value = { 0 };
5871 if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5872 gchar *tname, *ename, *pname;
5874 /* create a good task name */
5875 ename = gst_element_get_name (parent);
5876 pname = gst_pad_get_name (pad);
5877 tname = g_strdup_printf ("%s:%s", ename, pname);
5881 gst_object_set_name (GST_OBJECT_CAST (task), tname);
5885 message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5888 g_value_init (&value, GST_TYPE_TASK);
5889 g_value_set_object (&value, task);
5890 gst_message_set_stream_status_object (message, &value);
5891 g_value_unset (&value);
5893 GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5894 gst_element_post_message (parent, message);
5896 gst_object_unref (parent);
5901 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5903 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5908 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5910 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5915 * gst_pad_start_task:
5916 * @pad: the #GstPad to start the task of
5917 * @func: the task function to call
5918 * @user_data: user data passed to the task function
5919 * @notify: called when @user_data is no longer referenced
5921 * Starts a task that repeatedly calls @func with @user_data. This function
5922 * is mostly used in pad activation functions to start the dataflow.
5923 * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5924 * before @func is called.
5926 * Returns: a %TRUE if the task could be started.
5929 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer user_data,
5930 GDestroyNotify notify)
5935 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5936 g_return_val_if_fail (func != NULL, FALSE);
5938 GST_DEBUG_OBJECT (pad, "start task");
5940 GST_OBJECT_LOCK (pad);
5941 task = GST_PAD_TASK (pad);
5943 task = gst_task_new (func, user_data, notify);
5944 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5945 gst_task_set_enter_callback (task, pad_enter_thread, pad, NULL);
5946 gst_task_set_leave_callback (task, pad_leave_thread, pad, NULL);
5947 GST_INFO_OBJECT (pad, "created task %p", task);
5948 GST_PAD_TASK (pad) = task;
5949 gst_object_ref (task);
5950 /* release lock to post the message */
5951 GST_OBJECT_UNLOCK (pad);
5953 do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
5955 gst_object_unref (task);
5957 GST_OBJECT_LOCK (pad);
5958 /* nobody else is supposed to have changed the pad now */
5959 if (GST_PAD_TASK (pad) != task)
5960 goto concurrent_stop;
5962 res = gst_task_set_state (task, GST_TASK_STARTED);
5963 GST_OBJECT_UNLOCK (pad);
5970 GST_OBJECT_UNLOCK (pad);
5976 * gst_pad_pause_task:
5977 * @pad: the #GstPad to pause the task of
5979 * Pause the task of @pad. This function will also wait until the
5980 * function executed by the task is finished if this function is not
5981 * called from the task function.
5983 * Returns: a %TRUE if the task could be paused or %FALSE when the pad
5987 gst_pad_pause_task (GstPad * pad)
5992 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5994 GST_DEBUG_OBJECT (pad, "pause task");
5996 GST_OBJECT_LOCK (pad);
5997 task = GST_PAD_TASK (pad);
6000 res = gst_task_set_state (task, GST_TASK_PAUSED);
6001 GST_OBJECT_UNLOCK (pad);
6003 /* wait for task function to finish, this lock is recursive so it does nothing
6004 * when the pause is called from the task itself */
6005 GST_PAD_STREAM_LOCK (pad);
6006 GST_PAD_STREAM_UNLOCK (pad);
6012 GST_DEBUG_OBJECT (pad, "pad has no task");
6013 GST_OBJECT_UNLOCK (pad);
6019 * gst_pad_stop_task:
6020 * @pad: the #GstPad to stop the task of
6022 * Stop the task of @pad. This function will also make sure that the
6023 * function executed by the task will effectively stop if not called
6024 * from the GstTaskFunction.
6026 * This function will deadlock if called from the GstTaskFunction of
6027 * the task. Use gst_task_pause() instead.
6029 * Regardless of whether the pad has a task, the stream lock is acquired and
6030 * released so as to ensure that streaming through this pad has finished.
6032 * Returns: a %TRUE if the task could be stopped or %FALSE on error.
6035 gst_pad_stop_task (GstPad * pad)
6040 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
6042 GST_DEBUG_OBJECT (pad, "stop task");
6044 GST_OBJECT_LOCK (pad);
6045 task = GST_PAD_TASK (pad);
6048 GST_PAD_TASK (pad) = NULL;
6049 res = gst_task_set_state (task, GST_TASK_STOPPED);
6050 GST_OBJECT_UNLOCK (pad);
6052 GST_PAD_STREAM_LOCK (pad);
6053 GST_PAD_STREAM_UNLOCK (pad);
6055 if (!gst_task_join (task))
6058 gst_object_unref (task);
6064 GST_DEBUG_OBJECT (pad, "no task");
6065 GST_OBJECT_UNLOCK (pad);
6067 GST_PAD_STREAM_LOCK (pad);
6068 GST_PAD_STREAM_UNLOCK (pad);
6070 /* this is not an error */
6075 /* this is bad, possibly the application tried to join the task from
6076 * the task's thread. We install the task again so that it will be stopped
6077 * again from the right thread next time hopefully. */
6078 GST_OBJECT_LOCK (pad);
6079 GST_DEBUG_OBJECT (pad, "join failed");
6080 /* we can only install this task if there was no other task */
6081 if (GST_PAD_TASK (pad) == NULL)
6082 GST_PAD_TASK (pad) = task;
6083 GST_OBJECT_UNLOCK (pad);
6090 * gst_pad_probe_info_get_event:
6091 * @info: a #GstPadProbeInfo
6093 * Returns: (transfer none): The #GstEvent from the probe
6097 gst_pad_probe_info_get_event (GstPadProbeInfo * info)
6099 g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM |
6100 GST_PAD_PROBE_TYPE_EVENT_UPSTREAM), NULL);
6102 return GST_PAD_PROBE_INFO_EVENT (info);
6107 * gst_pad_probe_info_get_query:
6108 * @info: a #GstPadProbeInfo
6110 * Returns: (transfer none): The #GstQuery from the probe
6114 gst_pad_probe_info_get_query (GstPadProbeInfo * info)
6116 g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM |
6117 GST_PAD_PROBE_TYPE_QUERY_UPSTREAM), NULL);
6119 return GST_PAD_PROBE_INFO_QUERY (info);
6123 * gst_pad_probe_info_get_buffer:
6124 * @info: a #GstPadProbeInfo
6126 * Returns: (transfer none): The #GstBuffer from the probe
6130 gst_pad_probe_info_get_buffer (GstPadProbeInfo * info)
6132 g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER, NULL);
6134 return GST_PAD_PROBE_INFO_BUFFER (info);
6138 * gst_pad_probe_info_get_buffer_list:
6139 * @info: a #GstPadProbeInfo
6141 * Returns: (transfer none): The #GstBufferList from the probe
6145 gst_pad_probe_info_get_buffer_list (GstPadProbeInfo * info)
6147 g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER_LIST, NULL);
6149 return GST_PAD_PROBE_INFO_BUFFER_LIST (info);
6153 * gst_pad_get_last_flow_return:
6156 * Gets the #GstFlowReturn return from the last data passed by this pad.
6161 gst_pad_get_last_flow_return (GstPad * pad)
6165 GST_OBJECT_LOCK (pad);
6166 ret = GST_PAD_LAST_FLOW_RETURN (pad);
6167 GST_OBJECT_UNLOCK (pad);