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"
98 #include "glib-compat-private.h"
100 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
101 #define GST_CAT_DEFAULT GST_CAT_PADS
103 /* Pad signals and args */
121 #define GST_PAD_GET_PRIVATE(obj) \
122 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PAD, GstPadPrivate))
124 /* we have a pending and an active event on the pad. On source pads only the
125 * active event is used. On sinkpads, events are copied to the pending entry and
126 * moved to the active event when the eventfunc returned %TRUE. */
133 struct _GstPadPrivate
140 guint probe_list_cookie;
150 #define PROBE_COOKIE(h) (((GstProbe *)(h))->cookie)
155 GstPadProbeInfo *info;
162 static void gst_pad_dispose (GObject * object);
163 static void gst_pad_finalize (GObject * object);
164 static void gst_pad_set_property (GObject * object, guint prop_id,
165 const GValue * value, GParamSpec * pspec);
166 static void gst_pad_get_property (GObject * object, guint prop_id,
167 GValue * value, GParamSpec * pspec);
169 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
170 static gboolean gst_pad_activate_default (GstPad * pad, GstObject * parent);
171 static GstFlowReturn gst_pad_chain_list_default (GstPad * pad,
172 GstObject * parent, GstBufferList * list);
174 static GstFlowReturn gst_pad_send_event_unchecked (GstPad * pad,
175 GstEvent * event, GstPadProbeType type);
176 static GstFlowReturn gst_pad_push_event_unchecked (GstPad * pad,
177 GstEvent * event, GstPadProbeType type);
179 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
181 static GParamSpec *pspec_caps = NULL;
183 /* quarks for probe signals */
184 static GQuark buffer_quark;
185 static GQuark buffer_list_quark;
186 static GQuark event_quark;
195 static GstFlowQuarks flow_quarks[] = {
196 {GST_FLOW_CUSTOM_SUCCESS, "custom-success", 0},
197 {GST_FLOW_OK, "ok", 0},
198 {GST_FLOW_NOT_LINKED, "not-linked", 0},
199 {GST_FLOW_FLUSHING, "flushing", 0},
200 {GST_FLOW_EOS, "eos", 0},
201 {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
202 {GST_FLOW_ERROR, "error", 0},
203 {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
204 {GST_FLOW_CUSTOM_ERROR, "custom-error", 0}
209 * @ret: a #GstFlowReturn to get the name of.
211 * Gets a string representing the given flow return.
213 * Returns: a static string with the name of the flow return.
216 gst_flow_get_name (GstFlowReturn ret)
220 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
222 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
223 if (ret == flow_quarks[i].ret)
224 return flow_quarks[i].name;
231 * @ret: a #GstFlowReturn to get the quark of.
233 * Get the unique quark for the given GstFlowReturn.
235 * Returns: the quark associated with the flow return or 0 if an
236 * invalid return was specified.
239 gst_flow_to_quark (GstFlowReturn ret)
243 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
245 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
246 if (ret == flow_quarks[i].ret)
247 return flow_quarks[i].quark;
253 * gst_pad_link_get_name:
254 * @ret: a #GstPadLinkReturn to get the name of.
256 * Gets a string representing the given pad-link return.
258 * Returns: a static string with the name of the pad-link return.
263 gst_pad_link_get_name (GstPadLinkReturn ret)
266 case GST_PAD_LINK_OK:
268 case GST_PAD_LINK_WRONG_HIERARCHY:
269 return "wrong hierarchy";
270 case GST_PAD_LINK_WAS_LINKED:
272 case GST_PAD_LINK_WRONG_DIRECTION:
273 return "wrong direction";
274 case GST_PAD_LINK_NOFORMAT:
275 return "no common format";
276 case GST_PAD_LINK_NOSCHED:
277 return "incompatible scheduling";
278 case GST_PAD_LINK_REFUSED:
281 g_return_val_if_reached ("unknown");
288 buffer_quark = g_quark_from_static_string ("buffer"); \
289 buffer_list_quark = g_quark_from_static_string ("bufferlist"); \
290 event_quark = g_quark_from_static_string ("event"); \
292 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) { \
293 flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name); \
296 GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW", \
297 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads"); \
300 #define gst_pad_parent_class parent_class
301 G_DEFINE_TYPE_WITH_CODE (GstPad, gst_pad, GST_TYPE_OBJECT, _do_init);
304 gst_pad_class_init (GstPadClass * klass)
306 GObjectClass *gobject_class;
307 GstObjectClass *gstobject_class;
309 gobject_class = G_OBJECT_CLASS (klass);
310 gstobject_class = GST_OBJECT_CLASS (klass);
312 g_type_class_add_private (klass, sizeof (GstPadPrivate));
314 gobject_class->dispose = gst_pad_dispose;
315 gobject_class->finalize = gst_pad_finalize;
316 gobject_class->set_property = gst_pad_set_property;
317 gobject_class->get_property = gst_pad_get_property;
321 * @pad: the pad that emitted the signal
322 * @peer: the peer pad that has been connected
324 * Signals that a pad has been linked to the peer pad.
326 gst_pad_signals[PAD_LINKED] =
327 g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
328 G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
329 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
332 * @pad: the pad that emitted the signal
333 * @peer: the peer pad that has been disconnected
335 * Signals that a pad has been unlinked from the peer pad.
337 gst_pad_signals[PAD_UNLINKED] =
338 g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
339 G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
340 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
342 pspec_caps = g_param_spec_boxed ("caps", "Caps",
343 "The capabilities of the pad", GST_TYPE_CAPS,
344 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
345 g_object_class_install_property (gobject_class, PAD_PROP_CAPS, pspec_caps);
347 g_object_class_install_property (gobject_class, PAD_PROP_DIRECTION,
348 g_param_spec_enum ("direction", "Direction", "The direction of the pad",
349 GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
350 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
352 /* FIXME, Make G_PARAM_CONSTRUCT_ONLY when we fix ghostpads. */
353 g_object_class_install_property (gobject_class, PAD_PROP_TEMPLATE,
354 g_param_spec_object ("template", "Template",
355 "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
356 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
358 gstobject_class->path_string_separator = ".";
360 /* Register common function pointer descriptions */
361 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_activate_default);
362 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_event_default);
363 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_query_default);
364 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_iterate_internal_links_default);
365 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_chain_list_default);
369 gst_pad_init (GstPad * pad)
371 pad->priv = GST_PAD_GET_PRIVATE (pad);
373 GST_PAD_DIRECTION (pad) = GST_PAD_UNKNOWN;
375 GST_PAD_ACTIVATEFUNC (pad) = gst_pad_activate_default;
376 GST_PAD_EVENTFUNC (pad) = gst_pad_event_default;
377 GST_PAD_QUERYFUNC (pad) = gst_pad_query_default;
378 GST_PAD_ITERINTLINKFUNC (pad) = gst_pad_iterate_internal_links_default;
379 GST_PAD_CHAINLISTFUNC (pad) = gst_pad_chain_list_default;
381 GST_PAD_SET_FLUSHING (pad);
383 g_rec_mutex_init (&pad->stream_rec_lock);
385 g_cond_init (&pad->block_cond);
387 g_hook_list_init (&pad->probes, sizeof (GstProbe));
389 pad->priv->events = g_array_sized_new (FALSE, TRUE, sizeof (PadEvent), 16);
390 pad->priv->events_cookie = 0;
391 pad->priv->last_cookie = -1;
392 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
395 /* called when setting the pad inactive. It removes all sticky events from
396 * the pad. must be called with object lock */
398 remove_events (GstPad * pad)
403 events = pad->priv->events;
406 for (i = 0; i < len; i++) {
407 PadEvent *ev = &g_array_index (events, PadEvent, i);
408 GstEvent *event = ev->event;
412 if (event && GST_EVENT_TYPE (event) == GST_EVENT_CAPS) {
413 GST_OBJECT_UNLOCK (pad);
415 GST_DEBUG_OBJECT (pad, "notify caps");
416 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
418 GST_OBJECT_LOCK (pad);
420 gst_event_unref (event);
422 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
423 g_array_set_size (events, 0);
424 pad->priv->events_cookie++;
427 /* should be called with object lock */
429 find_event_by_type (GstPad * pad, GstEventType type, guint idx)
435 events = pad->priv->events;
438 for (i = 0; i < len; i++) {
439 ev = &g_array_index (events, PadEvent, i);
440 if (ev->event == NULL)
443 if (GST_EVENT_TYPE (ev->event) == type) {
454 /* should be called with OBJECT lock */
456 find_event (GstPad * pad, GstEvent * event)
462 events = pad->priv->events;
465 for (i = 0; i < len; i++) {
466 ev = &g_array_index (events, PadEvent, i);
467 if (event == ev->event)
475 /* should be called with OBJECT lock */
477 remove_event_by_type (GstPad * pad, GstEventType type)
483 events = pad->priv->events;
488 ev = &g_array_index (events, PadEvent, i);
489 if (ev->event == NULL)
492 if (GST_EVENT_TYPE (ev->event) != type)
495 gst_event_unref (ev->event);
496 g_array_remove_index (events, i);
498 pad->priv->events_cookie++;
506 /* check all events on srcpad against those on sinkpad. All events that are not
507 * on sinkpad are marked as received=%FALSE and the PENDING_EVENTS is set on the
508 * srcpad so that the events will be sent next time */
509 /* should be called with srcpad and sinkpad LOCKS */
511 schedule_events (GstPad * srcpad, GstPad * sinkpad)
516 gboolean pending = FALSE;
518 events = srcpad->priv->events;
521 for (i = 0; i < len; i++) {
522 ev = &g_array_index (events, PadEvent, i);
523 if (ev->event == NULL)
526 if (sinkpad == NULL || !find_event (sinkpad, ev->event)) {
527 ev->received = FALSE;
532 GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PENDING_EVENTS);
535 typedef gboolean (*PadEventFunction) (GstPad * pad, PadEvent * ev,
538 /* should be called with pad LOCK */
540 events_foreach (GstPad * pad, PadEventFunction func, gpointer user_data)
547 events = pad->priv->events;
550 cookie = pad->priv->events_cookie;
554 PadEvent *ev, ev_ret;
556 ev = &g_array_index (events, PadEvent, i);
557 if (G_UNLIKELY (ev->event == NULL))
560 /* take aditional ref, func might release the lock */
561 ev_ret.event = gst_event_ref (ev->event);
562 ev_ret.received = ev->received;
564 ret = func (pad, &ev_ret, user_data);
566 /* recheck the cookie, lock might have been released and the list could have
568 if (G_UNLIKELY (cookie != pad->priv->events_cookie)) {
569 if (G_LIKELY (ev_ret.event))
570 gst_event_unref (ev_ret.event);
574 /* store the received state */
575 ev->received = ev_ret.received;
577 /* if the event changed, we need to do something */
578 if (G_UNLIKELY (ev->event != ev_ret.event)) {
579 if (G_UNLIKELY (ev_ret.event == NULL)) {
580 /* function unreffed and set the event to NULL, remove it */
581 gst_event_unref (ev->event);
582 g_array_remove_index (events, i);
584 cookie = ++pad->priv->events_cookie;
587 /* function gave a new event for us */
588 gst_event_take (&ev->event, ev_ret.event);
591 /* just unref, nothing changed */
592 gst_event_unref (ev_ret.event);
601 /* should be called with LOCK */
603 apply_pad_offset (GstPad * pad, GstEvent * event, gboolean upstream)
605 /* check if we need to adjust the segment */
606 if (pad->offset != 0) {
609 GST_DEBUG_OBJECT (pad, "apply pad offset %" GST_TIME_FORMAT,
610 GST_TIME_ARGS (pad->offset));
612 if (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT) {
615 g_assert (!upstream);
617 /* copy segment values */
618 gst_event_copy_segment (event, &segment);
619 gst_event_unref (event);
621 gst_segment_offset_running_time (&segment, segment.format, pad->offset);
622 event = gst_event_new_segment (&segment);
625 event = gst_event_make_writable (event);
626 offset = gst_event_get_running_time_offset (event);
628 offset -= pad->offset;
630 offset += pad->offset;
631 gst_event_set_running_time_offset (event, offset);
636 /* should be called with the OBJECT_LOCK */
638 get_pad_caps (GstPad * pad)
640 GstCaps *caps = NULL;
643 ev = find_event_by_type (pad, GST_EVENT_CAPS, 0);
645 gst_event_parse_caps (ev->event, &caps);
651 gst_pad_dispose (GObject * object)
653 GstPad *pad = GST_PAD_CAST (object);
656 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pad, "dispose");
658 /* unlink the peer pad */
659 if ((peer = gst_pad_get_peer (pad))) {
660 /* window for MT unsafeness, someone else could unlink here
661 * and then we call unlink with wrong pads. The unlink
662 * function would catch this and safely return failed. */
663 if (GST_PAD_IS_SRC (pad))
664 gst_pad_unlink (pad, peer);
666 gst_pad_unlink (peer, pad);
668 gst_object_unref (peer);
671 gst_pad_set_pad_template (pad, NULL);
673 GST_OBJECT_LOCK (pad);
675 GST_OBJECT_UNLOCK (pad);
677 g_hook_list_clear (&pad->probes);
679 G_OBJECT_CLASS (parent_class)->dispose (object);
683 gst_pad_finalize (GObject * object)
685 GstPad *pad = GST_PAD_CAST (object);
688 /* in case the task is still around, clean it up */
689 if ((task = GST_PAD_TASK (pad))) {
690 gst_task_join (task);
691 GST_PAD_TASK (pad) = NULL;
692 gst_object_unref (task);
695 if (pad->activatenotify)
696 pad->activatenotify (pad->activatedata);
697 if (pad->activatemodenotify)
698 pad->activatemodenotify (pad->activatemodedata);
700 pad->linknotify (pad->linkdata);
701 if (pad->unlinknotify)
702 pad->unlinknotify (pad->unlinkdata);
703 if (pad->chainnotify)
704 pad->chainnotify (pad->chaindata);
705 if (pad->chainlistnotify)
706 pad->chainlistnotify (pad->chainlistdata);
707 if (pad->getrangenotify)
708 pad->getrangenotify (pad->getrangedata);
709 if (pad->eventnotify)
710 pad->eventnotify (pad->eventdata);
711 if (pad->querynotify)
712 pad->querynotify (pad->querydata);
713 if (pad->iterintlinknotify)
714 pad->iterintlinknotify (pad->iterintlinkdata);
716 g_rec_mutex_clear (&pad->stream_rec_lock);
717 g_cond_clear (&pad->block_cond);
718 g_array_free (pad->priv->events, TRUE);
720 G_OBJECT_CLASS (parent_class)->finalize (object);
724 gst_pad_set_property (GObject * object, guint prop_id,
725 const GValue * value, GParamSpec * pspec)
727 g_return_if_fail (GST_IS_PAD (object));
730 case PAD_PROP_DIRECTION:
731 GST_PAD_DIRECTION (object) = (GstPadDirection) g_value_get_enum (value);
733 case PAD_PROP_TEMPLATE:
734 gst_pad_set_pad_template (GST_PAD_CAST (object),
735 (GstPadTemplate *) g_value_get_object (value));
738 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
744 gst_pad_get_property (GObject * object, guint prop_id,
745 GValue * value, GParamSpec * pspec)
747 g_return_if_fail (GST_IS_PAD (object));
751 GST_OBJECT_LOCK (object);
752 g_value_set_boxed (value, get_pad_caps (GST_PAD_CAST (object)));
753 GST_OBJECT_UNLOCK (object);
755 case PAD_PROP_DIRECTION:
756 g_value_set_enum (value, GST_PAD_DIRECTION (object));
758 case PAD_PROP_TEMPLATE:
759 g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
762 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
769 * @name: the name of the new pad.
770 * @direction: the #GstPadDirection of the pad.
772 * Creates a new pad with the given name in the given direction.
773 * If name is %NULL, a guaranteed unique name (across all pads)
775 * This function makes a copy of the name so you can safely free the name.
777 * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
783 gst_pad_new (const gchar * name, GstPadDirection direction)
785 return g_object_new (GST_TYPE_PAD,
786 "name", name, "direction", direction, NULL);
790 * gst_pad_new_from_template:
791 * @templ: the pad template to use
792 * @name: the name of the element
794 * Creates a new pad with the given name from the given template.
795 * If name is %NULL, a guaranteed unique name (across all pads)
797 * This function makes a copy of the name so you can safely free the name.
799 * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
803 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
805 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
807 return g_object_new (GST_TYPE_PAD,
808 "name", name, "direction", templ->direction, "template", templ, NULL);
812 * gst_pad_new_from_static_template:
813 * @templ: the #GstStaticPadTemplate to use
814 * @name: the name of the element
816 * Creates a new pad with the given name from the given static template.
817 * If name is %NULL, a guaranteed unique name (across all pads)
819 * This function makes a copy of the name so you can safely free the name.
821 * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
825 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
829 GstPadTemplate *template;
831 template = gst_static_pad_template_get (templ);
832 pad = gst_pad_new_from_template (template, name);
833 gst_object_unref (template);
837 #define ACQUIRE_PARENT(pad, parent, label) \
839 if (G_LIKELY ((parent = GST_OBJECT_PARENT (pad)))) \
840 gst_object_ref (parent); \
841 else if (G_LIKELY (GST_PAD_NEEDS_PARENT (pad))) \
845 #define RELEASE_PARENT(parent) \
847 if (G_LIKELY (parent)) \
848 gst_object_unref (parent); \
852 * gst_pad_get_direction:
853 * @pad: a #GstPad to get the direction of.
855 * Gets the direction of the pad. The direction of the pad is
856 * decided at construction time so this function does not take
859 * Returns: the #GstPadDirection of the pad.
864 gst_pad_get_direction (GstPad * pad)
866 GstPadDirection result;
868 /* PAD_UNKNOWN is a little silly but we need some sort of
869 * error return value */
870 g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
872 result = GST_PAD_DIRECTION (pad);
878 gst_pad_activate_default (GstPad * pad, GstObject * parent)
880 return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
884 * gst_pad_mode_get_name:
885 * @mode: the pad mode
887 * Return the name of a pad mode, for use in debug messages mostly.
889 * Returns: short mnemonic for pad mode @mode
892 gst_pad_mode_get_name (GstPadMode mode)
895 case GST_PAD_MODE_NONE:
897 case GST_PAD_MODE_PUSH:
899 case GST_PAD_MODE_PULL:
908 pre_activate (GstPad * pad, GstPadMode new_mode)
911 case GST_PAD_MODE_NONE:
912 GST_OBJECT_LOCK (pad);
913 GST_DEBUG_OBJECT (pad, "setting PAD_MODE NONE, set flushing");
914 GST_PAD_SET_FLUSHING (pad);
915 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
916 GST_PAD_MODE (pad) = new_mode;
917 /* unlock blocked pads so element can resume and stop */
918 GST_PAD_BLOCK_BROADCAST (pad);
919 GST_OBJECT_UNLOCK (pad);
921 case GST_PAD_MODE_PUSH:
922 case GST_PAD_MODE_PULL:
923 GST_OBJECT_LOCK (pad);
924 GST_DEBUG_OBJECT (pad, "setting pad into %s mode, unset flushing",
925 gst_pad_mode_get_name (new_mode));
926 GST_PAD_UNSET_FLUSHING (pad);
927 pad->ABI.abi.last_flowret = GST_FLOW_OK;
928 GST_PAD_MODE (pad) = new_mode;
929 if (GST_PAD_IS_SINK (pad)) {
931 /* make sure the peer src pad sends us all events */
932 if ((peer = GST_PAD_PEER (pad))) {
933 gst_object_ref (peer);
934 GST_OBJECT_UNLOCK (pad);
936 GST_DEBUG_OBJECT (pad, "reschedule events on peer %s:%s",
937 GST_DEBUG_PAD_NAME (peer));
939 GST_OBJECT_LOCK (peer);
940 schedule_events (peer, NULL);
941 GST_OBJECT_UNLOCK (peer);
943 gst_object_unref (peer);
945 GST_OBJECT_UNLOCK (pad);
948 GST_OBJECT_UNLOCK (pad);
955 post_activate (GstPad * pad, GstPadMode new_mode)
958 case GST_PAD_MODE_NONE:
959 /* ensures that streaming stops */
960 GST_PAD_STREAM_LOCK (pad);
961 GST_DEBUG_OBJECT (pad, "stopped streaming");
962 GST_OBJECT_LOCK (pad);
964 GST_OBJECT_UNLOCK (pad);
965 GST_PAD_STREAM_UNLOCK (pad);
967 case GST_PAD_MODE_PUSH:
968 case GST_PAD_MODE_PULL:
975 * gst_pad_set_active:
976 * @pad: the #GstPad to activate or deactivate.
977 * @active: whether or not the pad should be active.
979 * Activates or deactivates the given pad.
980 * Normally called from within core state change functions.
982 * If @active, makes sure the pad is active. If it is already active, either in
983 * push or pull mode, just return. Otherwise dispatches to the pad's activate
984 * function to perform the actual activation.
986 * If not @active, calls gst_pad_activate_mode() with the pad's current mode
987 * and a %FALSE argument.
989 * Returns: %TRUE if the operation was successful.
994 gst_pad_set_active (GstPad * pad, gboolean active)
998 gboolean ret = FALSE;
1000 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1002 GST_OBJECT_LOCK (pad);
1003 old = GST_PAD_MODE (pad);
1004 ACQUIRE_PARENT (pad, parent, no_parent);
1005 GST_OBJECT_UNLOCK (pad);
1008 if (old == GST_PAD_MODE_NONE) {
1009 GST_DEBUG_OBJECT (pad, "activating pad from none");
1010 ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad, parent);
1012 pad->ABI.abi.last_flowret = GST_FLOW_OK;
1014 GST_DEBUG_OBJECT (pad, "pad was active in %s mode",
1015 gst_pad_mode_get_name (old));
1019 if (old == GST_PAD_MODE_NONE) {
1020 GST_DEBUG_OBJECT (pad, "pad was inactive");
1023 GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1024 gst_pad_mode_get_name (old));
1025 ret = gst_pad_activate_mode (pad, old, FALSE);
1027 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
1031 RELEASE_PARENT (parent);
1033 if (G_UNLIKELY (!ret))
1041 GST_DEBUG_OBJECT (pad, "no parent");
1042 GST_OBJECT_UNLOCK (pad);
1047 GST_OBJECT_LOCK (pad);
1049 g_critical ("Failed to deactivate pad %s:%s, very bad",
1050 GST_DEBUG_PAD_NAME (pad));
1052 GST_WARNING_OBJECT (pad, "Failed to activate pad");
1054 GST_OBJECT_UNLOCK (pad);
1060 * gst_pad_activate_mode:
1061 * @pad: the #GstPad to activate or deactivate.
1062 * @mode: the requested activation mode
1063 * @active: whether or not the pad should be active.
1065 * Activates or deactivates the given pad in @mode via dispatching to the
1066 * pad's activatemodefunc. For use from within pad activation functions only.
1068 * If you don't know what this is, you probably don't want to call it.
1070 * Returns: %TRUE if the operation was successful.
1075 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
1077 gboolean res = FALSE;
1079 GstPadMode old, new;
1080 GstPadDirection dir;
1083 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1085 GST_OBJECT_LOCK (pad);
1086 old = GST_PAD_MODE (pad);
1087 dir = GST_PAD_DIRECTION (pad);
1088 ACQUIRE_PARENT (pad, parent, no_parent);
1089 GST_OBJECT_UNLOCK (pad);
1091 new = active ? mode : GST_PAD_MODE_NONE;
1096 if (active && old != mode && old != GST_PAD_MODE_NONE) {
1097 /* pad was activate in the wrong direction, deactivate it
1098 * and reactivate it in the requested mode */
1099 GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1100 gst_pad_mode_get_name (old));
1102 if (G_UNLIKELY (!gst_pad_activate_mode (pad, old, FALSE)))
1103 goto deactivate_failed;
1107 case GST_PAD_MODE_PULL:
1109 if (dir == GST_PAD_SINK) {
1110 if ((peer = gst_pad_get_peer (pad))) {
1111 GST_DEBUG_OBJECT (pad, "calling peer");
1112 if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
1114 gst_object_unref (peer);
1116 /* there is no peer, this is only fatal when we activate. When we
1117 * deactivate, we must assume the application has unlinked the peer and
1118 * will deactivate it eventually. */
1122 GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
1125 if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
1126 goto failure; /* Can't activate pull on a src without a
1127 getrange function */
1135 /* Mark pad as needing reconfiguration */
1137 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1138 pre_activate (pad, new);
1140 if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1141 if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1145 /* can happen for sinks of passthrough elements */
1148 post_activate (pad, new);
1150 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in %s mode",
1151 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1156 /* Clear sticky flags on deactivation */
1158 GST_OBJECT_LOCK (pad);
1159 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1160 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
1161 GST_OBJECT_UNLOCK (pad);
1165 RELEASE_PARENT (parent);
1171 GST_DEBUG_OBJECT (pad, "no parent");
1172 GST_OBJECT_UNLOCK (pad);
1177 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in %s mode",
1178 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1183 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1184 "failed to %s in switch to %s mode from %s mode",
1185 (active ? "activate" : "deactivate"), gst_pad_mode_get_name (mode),
1186 gst_pad_mode_get_name (old));
1191 GST_OBJECT_LOCK (peer);
1192 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1193 "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1194 GST_OBJECT_UNLOCK (peer);
1195 gst_object_unref (peer);
1200 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1201 "pad in pull mode");
1206 GST_OBJECT_LOCK (pad);
1207 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in %s mode",
1208 active ? "activate" : "deactivate", gst_pad_mode_get_name (mode));
1209 GST_PAD_SET_FLUSHING (pad);
1210 GST_PAD_MODE (pad) = old;
1211 GST_OBJECT_UNLOCK (pad);
1217 * gst_pad_is_active:
1218 * @pad: the #GstPad to query
1220 * Query if a pad is active
1222 * Returns: %TRUE if the pad is active.
1227 gst_pad_is_active (GstPad * pad)
1229 gboolean result = FALSE;
1231 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1233 GST_OBJECT_LOCK (pad);
1234 result = GST_PAD_IS_ACTIVE (pad);
1235 GST_OBJECT_UNLOCK (pad);
1241 cleanup_hook (GstPad * pad, GHook * hook)
1243 GstPadProbeType type;
1245 if (!G_HOOK_IS_VALID (hook))
1248 type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1250 if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1251 /* unblock when we remove the last blocking probe */
1253 GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1256 /* Might have new probes now that want to be called */
1257 GST_PAD_BLOCK_BROADCAST (pad);
1259 if (pad->num_blocked == 0) {
1260 GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1261 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1264 g_hook_destroy_link (&pad->probes, hook);
1269 * gst_pad_add_probe:
1270 * @pad: the #GstPad to add the probe to
1271 * @mask: the probe mask
1272 * @callback: #GstPadProbeCallback that will be called with notifications of
1274 * @user_data: (closure): user data passed to the callback
1275 * @destroy_data: #GDestroyNotify for user_data
1277 * Be notified of different states of pads. The provided callback is called for
1278 * every state that matches @mask.
1280 * Returns: an id or 0 if no probe is pending. The id can be used to remove the
1281 * probe with gst_pad_remove_probe(). When using GST_PAD_PROBE_TYPE_IDLE it can
1282 * happend that the probe can be run immediately and if the probe returns
1283 * GST_PAD_PROBE_REMOVE this functions returns 0.
1288 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1289 GstPadProbeCallback callback, gpointer user_data,
1290 GDestroyNotify destroy_data)
1295 g_return_val_if_fail (GST_IS_PAD (pad), 0);
1296 g_return_val_if_fail (mask != 0, 0);
1298 GST_OBJECT_LOCK (pad);
1300 /* make a new probe */
1301 hook = g_hook_alloc (&pad->probes);
1303 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1306 /* when no contraints are given for the types, assume all types are
1308 if ((mask & GST_PAD_PROBE_TYPE_ALL_BOTH) == 0)
1309 mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1310 if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1311 mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1313 /* store our flags and other fields */
1314 hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1315 hook->func = callback;
1316 hook->data = user_data;
1317 hook->destroy = destroy_data;
1318 PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1321 g_hook_prepend (&pad->probes, hook);
1323 /* incremenent cookie so that the new hook get's called */
1324 pad->priv->probe_list_cookie++;
1326 /* get the id of the hook, we return this and it can be used to remove the
1328 res = hook->hook_id;
1330 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1332 if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1333 /* we have a block probe */
1335 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1336 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1337 "now %d blocking probes", pad->num_blocked);
1339 /* Might have new probes now that want to be called */
1340 GST_PAD_BLOCK_BROADCAST (pad);
1343 /* call the callback if we need to be called for idle callbacks */
1344 if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1345 if (pad->priv->using > 0) {
1346 /* the pad is in use, we can't signal the idle callback yet. Since we set the
1347 * flag above, the last thread to leave the push will do the callback. New
1348 * threads going into the push will block. */
1349 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1350 "pad is in use, delay idle callback");
1351 GST_OBJECT_UNLOCK (pad);
1353 GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1354 GstPadProbeReturn ret;
1356 /* Keep another ref, the callback could destroy the pad */
1357 gst_object_ref (pad);
1359 /* the pad is idle now, we can signal the idle callback now */
1360 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1361 "pad is idle, trigger idle callback");
1362 GST_OBJECT_UNLOCK (pad);
1364 ret = callback (pad, &info, user_data);
1366 GST_OBJECT_LOCK (pad);
1368 case GST_PAD_PROBE_REMOVE:
1369 /* remove the probe */
1370 GST_DEBUG_OBJECT (pad, "asked to remove hook");
1371 cleanup_hook (pad, hook);
1374 case GST_PAD_PROBE_DROP:
1375 GST_DEBUG_OBJECT (pad, "asked to drop item");
1377 case GST_PAD_PROBE_PASS:
1378 GST_DEBUG_OBJECT (pad, "asked to pass item");
1380 case GST_PAD_PROBE_OK:
1381 GST_DEBUG_OBJECT (pad, "probe returned OK");
1384 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
1387 GST_OBJECT_UNLOCK (pad);
1389 gst_object_unref (pad);
1392 GST_OBJECT_UNLOCK (pad);
1398 * gst_pad_remove_probe:
1399 * @pad: the #GstPad with the probe
1400 * @id: the probe id to remove
1402 * Remove the probe with @id from @pad.
1407 gst_pad_remove_probe (GstPad * pad, gulong id)
1411 g_return_if_fail (GST_IS_PAD (pad));
1413 GST_OBJECT_LOCK (pad);
1415 hook = g_hook_get (&pad->probes, id);
1419 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1421 cleanup_hook (pad, hook);
1422 GST_OBJECT_UNLOCK (pad);
1428 GST_OBJECT_UNLOCK (pad);
1429 g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1435 * gst_pad_is_blocked:
1436 * @pad: the #GstPad to query
1438 * Checks if the pad is blocked or not. This function returns the
1439 * last requested state of the pad. It is not certain that the pad
1440 * is actually blocking at this point (see gst_pad_is_blocking()).
1442 * Returns: %TRUE if the pad is blocked.
1447 gst_pad_is_blocked (GstPad * pad)
1449 gboolean result = FALSE;
1451 g_return_val_if_fail (GST_IS_PAD (pad), result);
1453 GST_OBJECT_LOCK (pad);
1454 result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1455 GST_OBJECT_UNLOCK (pad);
1461 * gst_pad_is_blocking:
1462 * @pad: the #GstPad to query
1464 * Checks if the pad is blocking or not. This is a guaranteed state
1465 * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1467 * Returns: %TRUE if the pad is blocking.
1472 gst_pad_is_blocking (GstPad * pad)
1474 gboolean result = FALSE;
1476 g_return_val_if_fail (GST_IS_PAD (pad), result);
1478 GST_OBJECT_LOCK (pad);
1479 /* the blocking flag is only valid if the pad is not flushing */
1480 result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1481 GST_OBJECT_UNLOCK (pad);
1487 * gst_pad_needs_reconfigure:
1488 * @pad: the #GstPad to check
1490 * Check the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1491 * if the flag was set.
1493 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag is set on @pad.
1496 gst_pad_needs_reconfigure (GstPad * pad)
1498 gboolean reconfigure;
1500 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1502 GST_OBJECT_LOCK (pad);
1503 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1504 GST_DEBUG_OBJECT (pad, "peeking RECONFIGURE flag %d", reconfigure);
1505 GST_OBJECT_UNLOCK (pad);
1511 * gst_pad_check_reconfigure:
1512 * @pad: the #GstPad to check
1514 * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1515 * if the flag was set.
1517 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1520 gst_pad_check_reconfigure (GstPad * pad)
1522 gboolean reconfigure;
1524 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1526 GST_OBJECT_LOCK (pad);
1527 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1529 GST_DEBUG_OBJECT (pad, "remove RECONFIGURE flag");
1530 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1532 GST_OBJECT_UNLOCK (pad);
1538 * gst_pad_mark_reconfigure:
1539 * @pad: the #GstPad to mark
1541 * Mark a pad for needing reconfiguration. The next call to
1542 * gst_pad_check_reconfigure() will return %TRUE after this call.
1545 gst_pad_mark_reconfigure (GstPad * pad)
1547 g_return_if_fail (GST_IS_PAD (pad));
1549 GST_OBJECT_LOCK (pad);
1550 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1551 GST_OBJECT_UNLOCK (pad);
1555 * gst_pad_set_activate_function:
1557 * @f: the #GstPadActivateFunction to set.
1559 * Calls gst_pad_set_activate_function_full() with %NULL for the user_data and
1563 * gst_pad_set_activate_function_full:
1565 * @activate: the #GstPadActivateFunction to set.
1566 * @user_data: user_data passed to @notify
1567 * @notify: notify called when @activate will not be used anymore.
1569 * Sets the given activate function for @pad. The activate function will
1570 * dispatch to gst_pad_activate_mode() to perform the actual activation.
1571 * Only makes sense to set on sink pads.
1573 * Call this function if your sink pad can start a pull-based task.
1576 gst_pad_set_activate_function_full (GstPad * pad,
1577 GstPadActivateFunction activate, gpointer user_data, GDestroyNotify notify)
1579 g_return_if_fail (GST_IS_PAD (pad));
1581 if (pad->activatenotify)
1582 pad->activatenotify (pad->activatedata);
1583 GST_PAD_ACTIVATEFUNC (pad) = activate;
1584 pad->activatedata = user_data;
1585 pad->activatenotify = notify;
1587 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1588 GST_DEBUG_FUNCPTR_NAME (activate));
1592 * gst_pad_set_activatemode_function:
1594 * @f: the #GstPadActivateModeFunction to set.
1596 * Calls gst_pad_set_activatemode_function_full() with %NULL for the user_data and
1600 * gst_pad_set_activatemode_function_full:
1602 * @activatemode: the #GstPadActivateModeFunction to set.
1603 * @user_data: user_data passed to @notify
1604 * @notify: notify called when @activatemode will not be used anymore.
1606 * Sets the given activate_mode function for the pad. An activate_mode function
1607 * prepares the element for data passing.
1610 gst_pad_set_activatemode_function_full (GstPad * pad,
1611 GstPadActivateModeFunction activatemode, gpointer user_data,
1612 GDestroyNotify notify)
1614 g_return_if_fail (GST_IS_PAD (pad));
1616 if (pad->activatemodenotify)
1617 pad->activatemodenotify (pad->activatemodedata);
1618 GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1619 pad->activatemodedata = user_data;
1620 pad->activatemodenotify = notify;
1622 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1623 GST_DEBUG_FUNCPTR_NAME (activatemode));
1627 * gst_pad_set_chain_function:
1628 * @p: a sink #GstPad.
1629 * @f: the #GstPadChainFunction to set.
1631 * Calls gst_pad_set_chain_function_full() with %NULL for the user_data and
1635 * gst_pad_set_chain_function_full:
1636 * @pad: a sink #GstPad.
1637 * @chain: the #GstPadChainFunction to set.
1638 * @user_data: user_data passed to @notify
1639 * @notify: notify called when @chain will not be used anymore.
1641 * Sets the given chain function for the pad. The chain function is called to
1642 * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1645 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1646 gpointer user_data, GDestroyNotify notify)
1648 g_return_if_fail (GST_IS_PAD (pad));
1649 g_return_if_fail (GST_PAD_IS_SINK (pad));
1651 if (pad->chainnotify)
1652 pad->chainnotify (pad->chaindata);
1653 GST_PAD_CHAINFUNC (pad) = chain;
1654 pad->chaindata = user_data;
1655 pad->chainnotify = notify;
1657 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1658 GST_DEBUG_FUNCPTR_NAME (chain));
1662 * gst_pad_set_chain_list_function:
1663 * @p: a sink #GstPad.
1664 * @f: the #GstPadChainListFunction to set.
1666 * Calls gst_pad_set_chain_list_function_full() with %NULL for the user_data and
1670 * gst_pad_set_chain_list_function_full:
1671 * @pad: a sink #GstPad.
1672 * @chainlist: the #GstPadChainListFunction to set.
1673 * @user_data: user_data passed to @notify
1674 * @notify: notify called when @chainlist will not be used anymore.
1676 * Sets the given chain list function for the pad. The chainlist function is
1677 * called to process a #GstBufferList input buffer list. See
1678 * #GstPadChainListFunction for more details.
1681 gst_pad_set_chain_list_function_full (GstPad * pad,
1682 GstPadChainListFunction chainlist, gpointer user_data,
1683 GDestroyNotify notify)
1685 g_return_if_fail (GST_IS_PAD (pad));
1686 g_return_if_fail (GST_PAD_IS_SINK (pad));
1688 if (pad->chainlistnotify)
1689 pad->chainlistnotify (pad->chainlistdata);
1690 GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1691 pad->chainlistdata = user_data;
1692 pad->chainlistnotify = notify;
1694 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1695 GST_DEBUG_FUNCPTR_NAME (chainlist));
1699 * gst_pad_set_getrange_function:
1700 * @p: a source #GstPad.
1701 * @f: the #GstPadGetRangeFunction to set.
1703 * Calls gst_pad_set_getrange_function_full() with %NULL for the user_data and
1707 * gst_pad_set_getrange_function_full:
1708 * @pad: a source #GstPad.
1709 * @get: the #GstPadGetRangeFunction to set.
1710 * @user_data: user_data passed to @notify
1711 * @notify: notify called when @get will not be used anymore.
1713 * Sets the given getrange function for the pad. The getrange function is
1714 * called to produce a new #GstBuffer to start the processing pipeline. see
1715 * #GstPadGetRangeFunction for a description of the getrange function.
1718 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1719 gpointer user_data, GDestroyNotify notify)
1721 g_return_if_fail (GST_IS_PAD (pad));
1722 g_return_if_fail (GST_PAD_IS_SRC (pad));
1724 if (pad->getrangenotify)
1725 pad->getrangenotify (pad->getrangedata);
1726 GST_PAD_GETRANGEFUNC (pad) = get;
1727 pad->getrangedata = user_data;
1728 pad->getrangenotify = notify;
1730 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1731 GST_DEBUG_FUNCPTR_NAME (get));
1735 * gst_pad_set_event_function:
1736 * @p: a #GstPad of either direction.
1737 * @f: the #GstPadEventFunction to set.
1739 * Calls gst_pad_set_event_function_full() with %NULL for the user_data and
1743 * gst_pad_set_event_function_full:
1744 * @pad: a #GstPad of either direction.
1745 * @event: the #GstPadEventFunction to set.
1746 * @user_data: user_data passed to @notify
1747 * @notify: notify called when @event will not be used anymore.
1749 * Sets the given event handler for the pad.
1752 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1753 gpointer user_data, GDestroyNotify notify)
1755 g_return_if_fail (GST_IS_PAD (pad));
1757 if (pad->eventnotify)
1758 pad->eventnotify (pad->eventdata);
1759 GST_PAD_EVENTFUNC (pad) = event;
1760 pad->eventdata = user_data;
1761 pad->eventnotify = notify;
1763 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1764 GST_DEBUG_FUNCPTR_NAME (event));
1768 * gst_pad_set_query_function:
1769 * @p: a #GstPad of either direction.
1770 * @f: the #GstPadQueryFunction to set.
1772 * Calls gst_pad_set_query_function_full() with %NULL for the user_data and
1776 * gst_pad_set_query_function_full:
1777 * @pad: a #GstPad of either direction.
1778 * @query: the #GstPadQueryFunction to set.
1779 * @user_data: user_data passed to @notify
1780 * @notify: notify called when @query will not be used anymore.
1782 * Set the given query function for the pad.
1785 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1786 gpointer user_data, GDestroyNotify notify)
1788 g_return_if_fail (GST_IS_PAD (pad));
1790 if (pad->querynotify)
1791 pad->querynotify (pad->querydata);
1792 GST_PAD_QUERYFUNC (pad) = query;
1793 pad->querydata = user_data;
1794 pad->querynotify = notify;
1796 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1797 GST_DEBUG_FUNCPTR_NAME (query));
1801 * gst_pad_set_iterate_internal_links_function:
1802 * @p: a #GstPad of either direction.
1803 * @f: the #GstPadIterIntLinkFunction to set.
1805 * Calls gst_pad_set_iterate_internal_links_function_full() with %NULL
1806 * for the user_data and notify.
1809 * gst_pad_set_iterate_internal_links_function_full:
1810 * @pad: a #GstPad of either direction.
1811 * @iterintlink: the #GstPadIterIntLinkFunction to set.
1812 * @user_data: user_data passed to @notify
1813 * @notify: notify called when @iterintlink will not be used anymore.
1815 * Sets the given internal link iterator function for the pad.
1818 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1819 GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1820 GDestroyNotify notify)
1822 g_return_if_fail (GST_IS_PAD (pad));
1824 if (pad->iterintlinknotify)
1825 pad->iterintlinknotify (pad->iterintlinkdata);
1826 GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1827 pad->iterintlinkdata = user_data;
1828 pad->iterintlinknotify = notify;
1830 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1831 GST_DEBUG_FUNCPTR_NAME (iterintlink));
1835 * gst_pad_set_link_function:
1837 * @f: the #GstPadLinkFunction to set.
1839 * Calls gst_pad_set_link_function_full() with %NULL
1840 * for the user_data and notify.
1843 * gst_pad_set_link_function_full:
1845 * @link: the #GstPadLinkFunction to set.
1846 * @user_data: user_data passed to @notify
1847 * @notify: notify called when @link will not be used anymore.
1849 * Sets the given link function for the pad. It will be called when
1850 * the pad is linked with another pad.
1852 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1855 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1856 * cannot be made for some reason.
1858 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1859 * of the peer sink pad, if present.
1862 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1863 gpointer user_data, GDestroyNotify notify)
1865 g_return_if_fail (GST_IS_PAD (pad));
1867 if (pad->linknotify)
1868 pad->linknotify (pad->linkdata);
1869 GST_PAD_LINKFUNC (pad) = link;
1870 pad->linkdata = user_data;
1871 pad->linknotify = notify;
1873 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1874 GST_DEBUG_FUNCPTR_NAME (link));
1878 * gst_pad_set_unlink_function:
1880 * @f: the #GstPadUnlinkFunction to set.
1882 * Calls gst_pad_set_unlink_function_full() with %NULL
1883 * for the user_data and notify.
1886 * gst_pad_set_unlink_function_full:
1888 * @unlink: the #GstPadUnlinkFunction to set.
1889 * @user_data: user_data passed to @notify
1890 * @notify: notify called when @unlink will not be used anymore.
1892 * Sets the given unlink function for the pad. It will be called
1893 * when the pad is unlinked.
1896 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
1897 gpointer user_data, GDestroyNotify notify)
1899 g_return_if_fail (GST_IS_PAD (pad));
1901 if (pad->unlinknotify)
1902 pad->unlinknotify (pad->unlinkdata);
1903 GST_PAD_UNLINKFUNC (pad) = unlink;
1904 pad->unlinkdata = user_data;
1905 pad->unlinknotify = notify;
1907 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1908 GST_DEBUG_FUNCPTR_NAME (unlink));
1913 * @srcpad: the source #GstPad to unlink.
1914 * @sinkpad: the sink #GstPad to unlink.
1916 * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1917 * signal on both pads.
1919 * Returns: %TRUE if the pads were unlinked. This function returns %FALSE if
1920 * the pads were not linked together.
1925 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1927 gboolean result = FALSE;
1928 GstElement *parent = NULL;
1930 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1931 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1932 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1933 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1935 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1936 GST_DEBUG_PAD_NAME (srcpad), srcpad,
1937 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1939 /* We need to notify the parent before taking any pad locks as the bin in
1940 * question might be waiting for a lock on the pad while holding its lock
1941 * that our message will try to take. */
1942 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
1943 if (GST_IS_ELEMENT (parent)) {
1944 gst_element_post_message (parent,
1945 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1946 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
1948 gst_object_unref (parent);
1953 GST_OBJECT_LOCK (srcpad);
1954 GST_OBJECT_LOCK (sinkpad);
1956 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1957 goto not_linked_together;
1959 if (GST_PAD_UNLINKFUNC (srcpad)) {
1960 GstObject *tmpparent;
1962 ACQUIRE_PARENT (srcpad, tmpparent, no_src_parent);
1964 GST_PAD_UNLINKFUNC (srcpad) (srcpad, tmpparent);
1965 RELEASE_PARENT (tmpparent);
1968 if (GST_PAD_UNLINKFUNC (sinkpad)) {
1969 GstObject *tmpparent;
1971 ACQUIRE_PARENT (sinkpad, tmpparent, no_sink_parent);
1973 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad, tmpparent);
1974 RELEASE_PARENT (tmpparent);
1978 /* first clear peers */
1979 GST_PAD_PEER (srcpad) = NULL;
1980 GST_PAD_PEER (sinkpad) = NULL;
1982 GST_OBJECT_UNLOCK (sinkpad);
1983 GST_OBJECT_UNLOCK (srcpad);
1985 /* fire off a signal to each of the pads telling them
1986 * that they've been unlinked */
1987 g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1988 g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1990 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1991 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1996 if (parent != NULL) {
1997 gst_element_post_message (parent,
1998 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1999 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
2000 gst_object_unref (parent);
2005 not_linked_together:
2007 /* we do not emit a warning in this case because unlinking cannot
2008 * be made MT safe.*/
2009 GST_OBJECT_UNLOCK (sinkpad);
2010 GST_OBJECT_UNLOCK (srcpad);
2016 * gst_pad_is_linked:
2017 * @pad: pad to check
2019 * Checks if a @pad is linked to another pad or not.
2021 * Returns: %TRUE if the pad is linked, %FALSE otherwise.
2026 gst_pad_is_linked (GstPad * pad)
2030 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2032 GST_OBJECT_LOCK (pad);
2033 result = (GST_PAD_PEER (pad) != NULL);
2034 GST_OBJECT_UNLOCK (pad);
2039 /* get the caps from both pads and see if the intersection
2042 * This function should be called with the pad LOCK on both
2046 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
2047 GstPadLinkCheck flags)
2049 GstCaps *srccaps = NULL;
2050 GstCaps *sinkcaps = NULL;
2051 gboolean compatible = FALSE;
2053 if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
2056 /* Doing the expensive caps checking takes priority over only checking the template caps */
2057 if (flags & GST_PAD_LINK_CHECK_CAPS) {
2058 GST_OBJECT_UNLOCK (sink);
2059 GST_OBJECT_UNLOCK (src);
2061 srccaps = gst_pad_query_caps (src, NULL);
2062 sinkcaps = gst_pad_query_caps (sink, NULL);
2064 GST_OBJECT_LOCK (src);
2065 GST_OBJECT_LOCK (sink);
2067 /* If one of the two pads doesn't have a template, consider the intersection
2069 if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
2070 || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
2074 srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
2076 gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
2079 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
2081 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
2084 /* if we have caps on both pads we can check the intersection. If one
2085 * of the caps is %NULL, we return %TRUE. */
2086 if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
2088 gst_caps_unref (srccaps);
2090 gst_caps_unref (sinkcaps);
2094 compatible = gst_caps_can_intersect (srccaps, sinkcaps);
2095 gst_caps_unref (srccaps);
2096 gst_caps_unref (sinkcaps);
2099 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
2100 (compatible ? "" : "not "));
2105 /* check if the grandparents of both pads are the same.
2106 * This check is required so that we don't try to link
2107 * pads from elements in different bins without ghostpads.
2109 * The LOCK should be held on both pads
2112 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
2114 GstObject *psrc, *psink;
2116 psrc = GST_OBJECT_PARENT (src);
2117 psink = GST_OBJECT_PARENT (sink);
2119 /* if one of the pads has no parent, we allow the link */
2120 if (G_UNLIKELY (psrc == NULL || psink == NULL))
2123 /* only care about parents that are elements */
2124 if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
2125 goto no_element_parent;
2127 /* if the parents are the same, we have a loop */
2128 if (G_UNLIKELY (psrc == psink))
2131 /* if they both have a parent, we check the grandparents. We can not lock
2132 * the parent because we hold on the child (pad) and the locking order is
2133 * parent >> child. */
2134 psrc = GST_OBJECT_PARENT (psrc);
2135 psink = GST_OBJECT_PARENT (psink);
2137 /* if they have grandparents but they are not the same */
2138 if (G_UNLIKELY (psrc != psink))
2139 goto wrong_grandparents;
2146 GST_CAT_DEBUG (GST_CAT_CAPS,
2147 "one of the pads has no parent %" GST_PTR_FORMAT " and %"
2148 GST_PTR_FORMAT, psrc, psink);
2153 GST_CAT_DEBUG (GST_CAT_CAPS,
2154 "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
2155 GST_PTR_FORMAT, psrc, psink);
2160 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
2166 GST_CAT_DEBUG (GST_CAT_CAPS,
2167 "pads have different grandparents %" GST_PTR_FORMAT " and %"
2168 GST_PTR_FORMAT, psrc, psink);
2173 /* FIXME leftover from an attempt at refactoring... */
2174 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
2175 * the two pads will be locked in the srcpad, sinkpad order. */
2176 static GstPadLinkReturn
2177 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2179 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2180 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2182 GST_OBJECT_LOCK (srcpad);
2184 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
2185 goto src_was_linked;
2187 GST_OBJECT_LOCK (sinkpad);
2189 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
2190 goto sink_was_linked;
2192 /* check hierarchy, pads can only be linked if the grandparents
2194 if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
2195 && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
2196 goto wrong_hierarchy;
2198 /* check pad caps for non-empty intersection */
2199 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
2202 /* FIXME check pad scheduling for non-empty intersection */
2204 return GST_PAD_LINK_OK;
2208 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
2209 GST_DEBUG_PAD_NAME (srcpad),
2210 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
2211 /* we do not emit a warning in this case because unlinking cannot
2212 * be made MT safe.*/
2213 GST_OBJECT_UNLOCK (srcpad);
2214 return GST_PAD_LINK_WAS_LINKED;
2218 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
2219 GST_DEBUG_PAD_NAME (sinkpad),
2220 GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
2221 /* we do not emit a warning in this case because unlinking cannot
2222 * be made MT safe.*/
2223 GST_OBJECT_UNLOCK (sinkpad);
2224 GST_OBJECT_UNLOCK (srcpad);
2225 return GST_PAD_LINK_WAS_LINKED;
2229 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
2230 GST_OBJECT_UNLOCK (sinkpad);
2231 GST_OBJECT_UNLOCK (srcpad);
2232 return GST_PAD_LINK_WRONG_HIERARCHY;
2236 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
2237 GST_OBJECT_UNLOCK (sinkpad);
2238 GST_OBJECT_UNLOCK (srcpad);
2239 return GST_PAD_LINK_NOFORMAT;
2245 * @srcpad: the source #GstPad.
2246 * @sinkpad: the sink #GstPad.
2248 * Checks if the source pad and the sink pad are compatible so they can be
2251 * Returns: %TRUE if the pads can be linked.
2254 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2256 GstPadLinkReturn result;
2258 /* generic checks */
2259 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2260 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2262 GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
2263 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2265 /* gst_pad_link_prepare does everything for us, we only release the locks
2266 * on the pads that it gets us. If this function returns !OK the locks are not
2268 result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2269 if (result != GST_PAD_LINK_OK)
2272 GST_OBJECT_UNLOCK (srcpad);
2273 GST_OBJECT_UNLOCK (sinkpad);
2276 return result == GST_PAD_LINK_OK;
2280 * gst_pad_link_full:
2281 * @srcpad: the source #GstPad to link.
2282 * @sinkpad: the sink #GstPad to link.
2283 * @flags: the checks to validate when linking
2285 * Links the source pad and the sink pad.
2287 * This variant of #gst_pad_link provides a more granular control on the
2288 * checks being done when linking. While providing some considerable speedups
2289 * the caller of this method must be aware that wrong usage of those flags
2290 * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
2291 * for more information.
2295 * Returns: A result code indicating if the connection worked or
2299 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2301 GstPadLinkReturn result;
2303 GstPadLinkFunction srcfunc, sinkfunc;
2305 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2306 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2307 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2308 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2309 GST_PAD_LINK_WRONG_DIRECTION);
2311 /* Notify the parent early. See gst_pad_unlink for details. */
2312 if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2313 if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2314 gst_element_post_message (parent,
2315 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2316 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2318 gst_object_unref (parent);
2323 /* prepare will also lock the two pads */
2324 result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2326 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2329 /* must set peers before calling the link function */
2330 GST_PAD_PEER (srcpad) = sinkpad;
2331 GST_PAD_PEER (sinkpad) = srcpad;
2333 /* check events, when something is different, mark pending */
2334 schedule_events (srcpad, sinkpad);
2336 /* get the link functions */
2337 srcfunc = GST_PAD_LINKFUNC (srcpad);
2338 sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2340 if (G_UNLIKELY (srcfunc || sinkfunc)) {
2341 /* custom link functions, execute them */
2342 GST_OBJECT_UNLOCK (sinkpad);
2343 GST_OBJECT_UNLOCK (srcpad);
2346 GstObject *tmpparent;
2348 ACQUIRE_PARENT (srcpad, tmpparent, no_parent);
2349 /* this one will call the peer link function */
2350 result = srcfunc (srcpad, tmpparent, sinkpad);
2351 RELEASE_PARENT (tmpparent);
2352 } else if (sinkfunc) {
2353 GstObject *tmpparent;
2355 ACQUIRE_PARENT (sinkpad, tmpparent, no_parent);
2356 /* if no source link function, we need to call the sink link
2357 * function ourselves. */
2358 result = sinkfunc (sinkpad, tmpparent, srcpad);
2359 RELEASE_PARENT (tmpparent);
2363 GST_OBJECT_LOCK (srcpad);
2364 GST_OBJECT_LOCK (sinkpad);
2366 /* we released the lock, check if the same pads are linked still */
2367 if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2368 goto concurrent_link;
2370 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2373 GST_OBJECT_UNLOCK (sinkpad);
2374 GST_OBJECT_UNLOCK (srcpad);
2376 /* fire off a signal to each of the pads telling them
2377 * that they've been linked */
2378 g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2379 g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2381 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2382 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2384 gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2387 if (G_LIKELY (parent)) {
2388 gst_element_post_message (parent,
2389 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2390 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2391 gst_object_unref (parent);
2399 GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2400 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2401 GST_OBJECT_UNLOCK (sinkpad);
2402 GST_OBJECT_UNLOCK (srcpad);
2404 /* The other link operation succeeded first */
2405 result = GST_PAD_LINK_WAS_LINKED;
2410 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2411 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2412 gst_pad_link_get_name (result));
2414 GST_PAD_PEER (srcpad) = NULL;
2415 GST_PAD_PEER (sinkpad) = NULL;
2417 GST_OBJECT_UNLOCK (sinkpad);
2418 GST_OBJECT_UNLOCK (srcpad);
2426 * @srcpad: the source #GstPad to link.
2427 * @sinkpad: the sink #GstPad to link.
2429 * Links the source pad and the sink pad.
2431 * Returns: A result code indicating if the connection worked or
2437 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2439 return gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2443 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2445 GstPadTemplate **template_p;
2447 /* this function would need checks if it weren't static */
2449 GST_OBJECT_LOCK (pad);
2450 template_p = &pad->padtemplate;
2451 gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2452 GST_OBJECT_UNLOCK (pad);
2455 gst_pad_template_pad_created (templ, pad);
2459 * gst_pad_get_pad_template:
2462 * Gets the template for @pad.
2464 * Returns: (transfer full) (nullable): the #GstPadTemplate from which
2465 * this pad was instantiated, or %NULL if this pad has no
2466 * template. Unref after usage.
2469 gst_pad_get_pad_template (GstPad * pad)
2471 GstPadTemplate *templ;
2473 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2475 templ = GST_PAD_PAD_TEMPLATE (pad);
2477 return (templ ? gst_object_ref (templ) : NULL);
2481 * gst_pad_has_current_caps:
2482 * @pad: a #GstPad to check
2484 * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2486 * Returns: %TRUE when @pad has caps associated with it.
2489 gst_pad_has_current_caps (GstPad * pad)
2494 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2496 GST_OBJECT_LOCK (pad);
2497 caps = get_pad_caps (pad);
2498 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2499 "check current pad caps %" GST_PTR_FORMAT, caps);
2500 result = (caps != NULL);
2501 GST_OBJECT_UNLOCK (pad);
2507 * gst_pad_get_current_caps:
2508 * @pad: a #GstPad to get the current capabilities of.
2510 * Gets the capabilities currently configured on @pad with the last
2511 * #GST_EVENT_CAPS event.
2513 * Returns: the current caps of the pad with incremented ref-count.
2516 gst_pad_get_current_caps (GstPad * pad)
2520 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2522 GST_OBJECT_LOCK (pad);
2523 if ((result = get_pad_caps (pad)))
2524 gst_caps_ref (result);
2525 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2526 "get current pad caps %" GST_PTR_FORMAT, result);
2527 GST_OBJECT_UNLOCK (pad);
2533 * gst_pad_get_pad_template_caps:
2534 * @pad: a #GstPad to get the template capabilities from.
2536 * Gets the capabilities for @pad's template.
2538 * Returns: (transfer full): the #GstCaps of this pad template.
2539 * Unref after usage.
2542 gst_pad_get_pad_template_caps (GstPad * pad)
2544 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2546 if (GST_PAD_PAD_TEMPLATE (pad))
2547 return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2549 return gst_caps_ref (GST_CAPS_ANY);
2554 * @pad: a #GstPad to get the peer of.
2556 * Gets the peer of @pad. This function refs the peer pad so
2557 * you need to unref it after use.
2559 * Returns: (transfer full): the peer #GstPad. Unref after usage.
2564 gst_pad_get_peer (GstPad * pad)
2568 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2570 GST_OBJECT_LOCK (pad);
2571 result = GST_PAD_PEER (pad);
2573 gst_object_ref (result);
2574 GST_OBJECT_UNLOCK (pad);
2580 * gst_pad_get_allowed_caps:
2583 * Gets the capabilities of the allowed media types that can flow through
2584 * @pad and its peer.
2586 * The allowed capabilities is calculated as the intersection of the results of
2587 * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2588 * on the resulting caps.
2590 * Returns: (transfer full) (nullable): the allowed #GstCaps of the
2591 * pad link. Unref the caps when you no longer need it. This
2592 * function returns %NULL when @pad has no peer.
2597 gst_pad_get_allowed_caps (GstPad * pad)
2603 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2605 GST_OBJECT_LOCK (pad);
2606 peer = GST_PAD_PEER (pad);
2607 if (G_UNLIKELY (peer == NULL))
2610 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2612 gst_object_ref (peer);
2613 GST_OBJECT_UNLOCK (pad);
2614 mycaps = gst_pad_query_caps (pad, NULL);
2616 caps = gst_pad_query_caps (peer, mycaps);
2617 gst_object_unref (peer);
2619 gst_caps_unref (mycaps);
2621 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2628 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2629 GST_OBJECT_UNLOCK (pad);
2636 * gst_pad_iterate_internal_links_default:
2637 * @pad: the #GstPad to get the internal links of.
2638 * @parent: (allow-none): the parent of @pad or %NULL
2640 * Iterate the list of pads to which the given pad is linked to inside of
2641 * the parent element.
2642 * This is the default handler, and thus returns an iterator of all of the
2643 * pads inside the parent element with opposite direction.
2645 * The caller must free this iterator after use with gst_iterator_free().
2647 * Returns: (nullable): a #GstIterator of #GstPad, or %NULL if @pad
2648 * has no parent. Unref each returned pad with gst_object_unref().
2651 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2658 GstElement *eparent;
2660 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2662 if (parent != NULL && GST_IS_ELEMENT (parent)) {
2663 eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2665 GST_OBJECT_LOCK (pad);
2666 eparent = GST_PAD_PARENT (pad);
2667 if (!eparent || !GST_IS_ELEMENT (eparent))
2670 gst_object_ref (eparent);
2671 GST_OBJECT_UNLOCK (pad);
2674 if (pad->direction == GST_PAD_SRC)
2675 padlist = &eparent->sinkpads;
2677 padlist = &eparent->srcpads;
2679 GST_DEBUG_OBJECT (pad, "Making iterator");
2681 cookie = &eparent->pads_cookie;
2683 lock = GST_OBJECT_GET_LOCK (eparent);
2685 res = gst_iterator_new_list (GST_TYPE_PAD,
2686 lock, cookie, padlist, (GObject *) owner, NULL);
2688 gst_object_unref (owner);
2695 GST_OBJECT_UNLOCK (pad);
2696 GST_DEBUG_OBJECT (pad, "no parent element");
2702 * gst_pad_iterate_internal_links:
2703 * @pad: the GstPad to get the internal links of.
2705 * Gets an iterator for the pads to which the given pad is linked to inside
2706 * of the parent element.
2708 * Each #GstPad element yielded by the iterator will have its refcount increased,
2709 * so unref after use.
2711 * Free-function: gst_iterator_free
2713 * Returns: (transfer full) (nullable): a new #GstIterator of #GstPad
2714 * or %NULL when the pad does not have an iterator function
2715 * configured. Use gst_iterator_free() after usage.
2718 gst_pad_iterate_internal_links (GstPad * pad)
2720 GstIterator *res = NULL;
2723 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2725 GST_OBJECT_LOCK (pad);
2726 ACQUIRE_PARENT (pad, parent, no_parent);
2727 GST_OBJECT_UNLOCK (pad);
2729 if (GST_PAD_ITERINTLINKFUNC (pad))
2730 res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2732 RELEASE_PARENT (parent);
2739 GST_DEBUG_OBJECT (pad, "no parent");
2740 GST_OBJECT_UNLOCK (pad);
2748 * @forward: (scope call): a #GstPadForwardFunction
2749 * @user_data: user data passed to @forward
2751 * Calls @forward for all internally linked pads of @pad. This function deals with
2752 * dynamically changing internal pads and will make sure that the @forward
2753 * function is only called once for each pad.
2755 * When @forward returns %TRUE, no further pads will be processed.
2757 * Returns: %TRUE if one of the dispatcher functions returned %TRUE.
2760 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2763 gboolean result = FALSE;
2765 gboolean done = FALSE;
2766 GValue item = { 0, };
2767 GList *pushed_pads = NULL;
2769 iter = gst_pad_iterate_internal_links (pad);
2775 switch (gst_iterator_next (iter, &item)) {
2776 case GST_ITERATOR_OK:
2780 intpad = g_value_get_object (&item);
2782 /* if already pushed, skip. FIXME, find something faster to tag pads */
2783 if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2784 g_value_reset (&item);
2788 GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2789 GST_DEBUG_PAD_NAME (intpad));
2790 done = result = forward (intpad, user_data);
2792 pushed_pads = g_list_prepend (pushed_pads, intpad);
2794 g_value_reset (&item);
2797 case GST_ITERATOR_RESYNC:
2798 /* We don't reset the result here because we don't push the event
2799 * again on pads that got the event already and because we need
2800 * to consider the result of the previous pushes */
2801 gst_iterator_resync (iter);
2803 case GST_ITERATOR_ERROR:
2804 GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2807 case GST_ITERATOR_DONE:
2812 g_value_unset (&item);
2813 gst_iterator_free (iter);
2815 g_list_free (pushed_pads);
2825 gboolean dispatched;
2829 event_forward_func (GstPad * pad, EventData * data)
2831 /* for each pad we send to, we should ref the event; it's up
2832 * to downstream to unref again when handled. */
2833 GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2834 data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2836 data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2838 data->dispatched = TRUE;
2845 * gst_pad_event_default:
2846 * @pad: a #GstPad to call the default event handler on.
2847 * @parent: (allow-none): the parent of @pad or %NULL
2848 * @event: (transfer full): the #GstEvent to handle.
2850 * Invokes the default event handler for the given pad.
2852 * The EOS event will pause the task associated with @pad before it is forwarded
2853 * to all internally linked pads,
2855 * The the event is sent to all pads internally linked to @pad. This function
2856 * takes ownership of @event.
2858 * Returns: %TRUE if the event was sent successfully.
2861 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2863 gboolean result, forward = TRUE;
2865 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2866 g_return_val_if_fail (event != NULL, FALSE);
2868 GST_LOG_OBJECT (pad, "default event handler for event %" GST_PTR_FORMAT,
2871 switch (GST_EVENT_TYPE (event)) {
2872 case GST_EVENT_CAPS:
2873 forward = GST_PAD_IS_PROXY_CAPS (pad);
2884 data.dispatched = FALSE;
2885 data.result = FALSE;
2887 gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
2889 /* for sinkpads without a parent element or without internal links, nothing
2890 * will be dispatched but we still want to return TRUE. */
2891 if (data.dispatched)
2892 result = data.result;
2897 gst_event_unref (event);
2902 /* Default accept caps implementation just checks against
2903 * the allowed caps for the pad */
2905 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
2907 /* get the caps and see if it intersects to something not empty */
2908 GstCaps *caps, *allowed;
2911 GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
2913 /* first forward the query to internally linked pads when we are dealing with
2915 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2916 if ((result = gst_pad_proxy_query_accept_caps (pad, query))) {
2921 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
2922 "fallback ACCEPT_CAPS query, consider implementing a specialized version");
2924 gst_query_parse_accept_caps (query, &caps);
2925 allowed = gst_pad_query_caps (pad, caps);
2928 if (GST_PAD_IS_ACCEPT_INTERSECT (pad)) {
2929 GST_DEBUG_OBJECT (pad,
2930 "allowed caps intersect %" GST_PTR_FORMAT ", caps %" GST_PTR_FORMAT,
2932 result = gst_caps_can_intersect (caps, allowed);
2934 GST_DEBUG_OBJECT (pad, "allowed caps subset %" GST_PTR_FORMAT ", caps %"
2935 GST_PTR_FORMAT, allowed, caps);
2936 result = gst_caps_is_subset (caps, allowed);
2938 gst_caps_unref (allowed);
2940 GST_DEBUG_OBJECT (pad, "no compatible caps allowed on the pad");
2943 gst_query_set_accept_caps_result (query, result);
2949 /* Default caps implementation */
2951 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
2953 GstCaps *result = NULL, *filter;
2954 GstPadTemplate *templ;
2955 gboolean fixed_caps;
2957 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "query caps %" GST_PTR_FORMAT,
2960 /* first try to proxy if we must */
2961 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2962 if ((gst_pad_proxy_query_caps (pad, query))) {
2967 gst_query_parse_caps (query, &filter);
2969 /* no proxy or it failed, do default handling */
2970 fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
2972 GST_OBJECT_LOCK (pad);
2974 /* fixed caps, try the negotiated caps first */
2975 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
2976 if ((result = get_pad_caps (pad)))
2977 goto filter_done_unlock;
2980 if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
2981 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
2982 if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
2983 goto filter_done_unlock;
2987 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2988 "non-fixed pad caps: trying pad caps");
2989 /* non fixed caps, try the negotiated caps */
2990 if ((result = get_pad_caps (pad)))
2991 goto filter_done_unlock;
2994 /* this almost never happens */
2995 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
2996 result = GST_CAPS_ANY;
2999 GST_OBJECT_UNLOCK (pad);
3001 /* run the filter on the result */
3003 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3004 "using caps %p %" GST_PTR_FORMAT " with filter %p %"
3005 GST_PTR_FORMAT, result, result, filter, filter);
3006 result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
3007 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
3010 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3011 "using caps %p %" GST_PTR_FORMAT, result, result);
3012 result = gst_caps_ref (result);
3014 gst_query_set_caps_result (query, result);
3015 gst_caps_unref (result);
3025 gboolean dispatched;
3029 query_forward_func (GstPad * pad, QueryData * data)
3031 GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
3032 data->query, GST_QUERY_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
3034 data->result |= gst_pad_peer_query (pad, data->query);
3036 data->dispatched = TRUE;
3038 /* stop on first successful reply */
3039 return data->result;
3043 * gst_pad_query_default:
3044 * @pad: a #GstPad to call the default query handler on.
3045 * @parent: (allow-none): the parent of @pad or %NULL
3046 * @query: (transfer none): the #GstQuery to handle.
3048 * Invokes the default query handler for the given pad.
3049 * The query is sent to all pads internally linked to @pad. Note that
3050 * if there are many possible sink pads that are internally linked to
3051 * @pad, only one will be sent the query.
3052 * Multi-sinkpad elements should implement custom query handlers.
3054 * Returns: %TRUE if the query was performed successfully.
3057 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
3059 gboolean forward, ret = FALSE;
3061 switch (GST_QUERY_TYPE (query)) {
3062 case GST_QUERY_SCHEDULING:
3063 forward = GST_PAD_IS_PROXY_SCHEDULING (pad);
3065 case GST_QUERY_ALLOCATION:
3066 forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
3068 case GST_QUERY_ACCEPT_CAPS:
3069 ret = gst_pad_query_accept_caps_default (pad, query);
3072 case GST_QUERY_CAPS:
3073 ret = gst_pad_query_caps_default (pad, query);
3076 case GST_QUERY_POSITION:
3077 case GST_QUERY_SEEKING:
3078 case GST_QUERY_FORMATS:
3079 case GST_QUERY_LATENCY:
3080 case GST_QUERY_JITTER:
3081 case GST_QUERY_RATE:
3082 case GST_QUERY_CONVERT:
3088 GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
3089 query, GST_QUERY_TYPE_NAME (query));
3095 data.dispatched = FALSE;
3096 data.result = FALSE;
3098 gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
3100 if (data.dispatched) {
3103 /* nothing dispatched, assume drained */
3104 if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
3114 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
3116 GstPad *pad = data->pad;
3117 GstPadProbeInfo *info = data->info;
3118 GstPadProbeType type, flags;
3119 GstPadProbeCallback callback;
3120 GstPadProbeReturn ret;
3122 /* if we have called this callback, do nothing */
3123 if (PROBE_COOKIE (hook) == data->cookie) {
3124 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3125 "hook %lu, cookie %u already called", hook->hook_id,
3126 PROBE_COOKIE (hook));
3130 PROBE_COOKIE (hook) = data->cookie;
3132 flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
3135 /* one of the data types for non-idle probes */
3136 if ((type & GST_PAD_PROBE_TYPE_IDLE) == 0
3137 && (flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
3139 /* one of the scheduling types */
3140 if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
3142 /* one of the blocking types must match */
3143 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
3144 (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
3146 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) == 0 &&
3147 (flags & GST_PAD_PROBE_TYPE_BLOCKING))
3149 /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
3150 if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
3151 (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
3154 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3155 "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
3156 PROBE_COOKIE (hook), flags);
3158 data->marshalled = TRUE;
3160 callback = (GstPadProbeCallback) hook->func;
3161 if (callback == NULL)
3164 info->id = hook->hook_id;
3166 GST_OBJECT_UNLOCK (pad);
3168 ret = callback (pad, info, hook->data);
3170 GST_OBJECT_LOCK (pad);
3173 case GST_PAD_PROBE_REMOVE:
3174 /* remove the probe */
3175 GST_DEBUG_OBJECT (pad, "asked to remove hook");
3176 cleanup_hook (pad, hook);
3178 case GST_PAD_PROBE_DROP:
3179 /* need to drop the data, make sure other probes don't get called
3181 GST_DEBUG_OBJECT (pad, "asked to drop item");
3182 info->type = GST_PAD_PROBE_TYPE_INVALID;
3183 data->dropped = TRUE;
3185 case GST_PAD_PROBE_PASS:
3186 /* inform the pad block to let things pass */
3187 GST_DEBUG_OBJECT (pad, "asked to pass item");
3190 case GST_PAD_PROBE_OK:
3191 GST_DEBUG_OBJECT (pad, "probe returned OK");
3194 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
3201 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3202 "hook %lu, cookie %u with flags 0x%08x does not match %08x",
3203 hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
3208 /* a probe that does not take or return any data */
3209 #define PROBE_NO_DATA(pad,mask,label,defaultval) \
3211 if (G_UNLIKELY (pad->num_probes)) { \
3212 /* pass NULL as the data item */ \
3213 GstPadProbeInfo info = { mask, 0, NULL, 0, 0 }; \
3214 ret = do_probe_callbacks (pad, &info, defaultval); \
3215 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
3220 #define PROBE_FULL(pad,mask,data,offs,size,label) \
3222 if (G_UNLIKELY (pad->num_probes)) { \
3223 /* pass the data item */ \
3224 GstPadProbeInfo info = { mask, 0, data, offs, size }; \
3225 ret = do_probe_callbacks (pad, &info, GST_FLOW_OK); \
3226 /* store the possibly updated data item */ \
3227 data = GST_PAD_PROBE_INFO_DATA (&info); \
3228 /* if something went wrong, exit */ \
3229 if (G_UNLIKELY (ret != GST_FLOW_OK)) \
3234 #define PROBE_PUSH(pad,mask,data,label) \
3235 PROBE_FULL(pad, mask, data, -1, -1, label);
3236 #define PROBE_PULL(pad,mask,data,offs,size,label) \
3237 PROBE_FULL(pad, mask, data, offs, size, label);
3239 static GstFlowReturn
3240 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3241 GstFlowReturn defaultval)
3250 data.marshalled = FALSE;
3251 data.dropped = FALSE;
3252 data.cookie = ++pad->priv->probe_cookie;
3255 (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3258 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3259 "do probes cookie %u", data.cookie);
3260 cookie = pad->priv->probe_list_cookie;
3262 g_hook_list_marshal (&pad->probes, TRUE,
3263 (GHookMarshaller) probe_hook_marshal, &data);
3265 /* if the list changed, call the new callbacks (they will not have their
3266 * cookie set to data.cookie */
3267 if (cookie != pad->priv->probe_list_cookie) {
3268 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3269 "probe list changed, restarting");
3273 /* the first item that dropped will stop the hooks and then we drop here */
3277 /* if no handler matched and we are blocking, let the item pass */
3278 if (!data.marshalled && is_block)
3281 /* At this point, all handlers returned either OK or PASS. If one handler
3282 * returned PASS, let the item pass */
3287 while (GST_PAD_IS_BLOCKED (pad)) {
3288 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3289 "we are blocked %d times", pad->num_blocked);
3291 /* we might have released the lock */
3292 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3295 /* now we block the streaming thread. It can be unlocked when we
3296 * deactivate the pad (which will also set the FLUSHING flag) or
3297 * when the pad is unblocked. A flushing event will also unblock
3298 * the pad after setting the FLUSHING flag. */
3299 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3300 "Waiting to be unblocked or set flushing");
3301 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3302 GST_PAD_BLOCK_WAIT (pad);
3303 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3304 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3306 /* if the list changed, call the new callbacks (they will not have their
3307 * cookie set to data.cookie */
3308 if (cookie != pad->priv->probe_list_cookie) {
3309 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3310 "probe list changed, restarting");
3314 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3324 GST_DEBUG_OBJECT (pad, "pad is flushing");
3325 return GST_FLOW_FLUSHING;
3329 GST_DEBUG_OBJECT (pad, "data is dropped");
3330 return GST_FLOW_CUSTOM_SUCCESS;
3334 /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3335 GST_DEBUG_OBJECT (pad, "data is passed");
3343 * gst_pad_get_offset:
3346 * Get the offset applied to the running time of @pad. @pad has to be a source
3349 * Returns: the offset.
3352 gst_pad_get_offset (GstPad * pad)
3356 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3358 GST_OBJECT_LOCK (pad);
3359 result = pad->offset;
3360 GST_OBJECT_UNLOCK (pad);
3366 mark_event_not_received (GstPad * pad, PadEvent * ev, gpointer user_data)
3368 ev->received = FALSE;
3373 * gst_pad_set_offset:
3375 * @offset: the offset
3377 * Set the offset that will be applied to the running time of @pad.
3380 gst_pad_set_offset (GstPad * pad, gint64 offset)
3382 g_return_if_fail (GST_IS_PAD (pad));
3384 GST_OBJECT_LOCK (pad);
3385 /* if nothing changed, do nothing */
3386 if (pad->offset == offset)
3389 pad->offset = offset;
3390 GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3392 /* resend all sticky events with updated offset on next buffer push */
3393 events_foreach (pad, mark_event_not_received, NULL);
3394 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3397 GST_OBJECT_UNLOCK (pad);
3404 /* If TRUE and ret is not OK this means
3405 * that pushing the EOS event failed
3409 /* If called for an event this is
3410 * the event that would be pushed
3411 * next. Don't forward sticky events
3412 * that would come after that */
3416 /* should be called with pad LOCK */
3418 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3420 PushStickyData *data = user_data;
3421 GstEvent *event = ev->event;
3424 GST_DEBUG_OBJECT (pad, "event %s was already received",
3425 GST_EVENT_TYPE_NAME (event));
3429 /* If we're called because of an sticky event, only forward
3430 * events that would come before this new event and the
3432 if (data->event && GST_EVENT_IS_STICKY (data->event) &&
3433 GST_EVENT_TYPE (data->event) <= GST_EVENT_SEGMENT &&
3434 GST_EVENT_TYPE (data->event) < GST_EVENT_TYPE (event)) {
3435 data->ret = GST_FLOW_CUSTOM_SUCCESS_1;
3437 data->ret = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3438 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3441 switch (data->ret) {
3443 ev->received = TRUE;
3444 GST_DEBUG_OBJECT (pad, "event %s marked received",
3445 GST_EVENT_TYPE_NAME (event));
3447 case GST_FLOW_CUSTOM_SUCCESS:
3448 /* we can't assume the event is received when it was dropped */
3449 GST_DEBUG_OBJECT (pad, "event %s was dropped, mark pending",
3450 GST_EVENT_TYPE_NAME (event));
3451 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3452 data->ret = GST_FLOW_OK;
3454 case GST_FLOW_CUSTOM_SUCCESS_1:
3455 /* event was ignored and should be sent later */
3456 GST_DEBUG_OBJECT (pad, "event %s was ignored, mark pending",
3457 GST_EVENT_TYPE_NAME (event));
3458 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3459 data->ret = GST_FLOW_OK;
3461 case GST_FLOW_NOT_LINKED:
3462 /* not linked is not a problem, we are sticky so the event will be
3463 * sent later but only for non-EOS events */
3464 GST_DEBUG_OBJECT (pad, "pad was not linked, mark pending");
3465 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
3466 data->ret = GST_FLOW_OK;
3467 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3470 GST_DEBUG_OBJECT (pad, "result %s, mark pending events",
3471 gst_flow_get_name (data->ret));
3472 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3476 if (data->ret != GST_FLOW_OK && GST_EVENT_TYPE (event) == GST_EVENT_EOS)
3477 data->was_eos = TRUE;
3479 return data->ret == GST_FLOW_OK;
3482 /* check sticky events and push them when needed. should be called
3484 static inline GstFlowReturn
3485 check_sticky (GstPad * pad, GstEvent * event)
3487 PushStickyData data = { GST_FLOW_OK, FALSE, event };
3489 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3490 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3492 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3493 events_foreach (pad, push_sticky, &data);
3495 /* If there's an EOS event we must push it downstream
3496 * even if sending a previous sticky event failed.
3497 * Otherwise the pipeline might wait forever for EOS.
3499 * Only do this if pushing another event than the EOS
3502 if (data.ret != GST_FLOW_OK && !data.was_eos) {
3503 PadEvent *ev = find_event_by_type (pad, GST_EVENT_EOS, 0);
3505 if (ev && !ev->received) {
3506 data.ret = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3507 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3508 /* the event could have been dropped. Because this can only
3509 * happen if the user asked for it, it's not an error */
3510 if (data.ret == GST_FLOW_CUSTOM_SUCCESS)
3511 data.ret = GST_FLOW_OK;
3521 * @pad: a #GstPad to invoke the default query on.
3522 * @query: (transfer none): the #GstQuery to perform.
3524 * Dispatches a query to a pad. The query should have been allocated by the
3525 * caller via one of the type-specific allocation functions. The element that
3526 * the pad belongs to is responsible for filling the query with an appropriate
3527 * response, which should then be parsed with a type-specific query parsing
3530 * Again, the caller is responsible for both the allocation and deallocation of
3531 * the query structure.
3533 * Please also note that some queries might need a running pipeline to work.
3535 * Returns: %TRUE if the query could be performed.
3538 gst_pad_query (GstPad * pad, GstQuery * query)
3541 gboolean res, serialized;
3542 GstPadQueryFunction func;
3543 GstPadProbeType type;
3546 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3547 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3549 if (GST_PAD_IS_SRC (pad)) {
3550 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3551 goto wrong_direction;
3552 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3553 } else if (GST_PAD_IS_SINK (pad)) {
3554 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3555 goto wrong_direction;
3556 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3558 goto unknown_direction;
3560 GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3561 GST_QUERY_TYPE_NAME (query));
3563 serialized = GST_QUERY_IS_SERIALIZED (query);
3564 if (G_UNLIKELY (serialized))
3565 GST_PAD_STREAM_LOCK (pad);
3567 GST_OBJECT_LOCK (pad);
3568 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3569 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3570 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3572 ACQUIRE_PARENT (pad, parent, no_parent);
3573 GST_OBJECT_UNLOCK (pad);
3575 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3578 res = func (pad, parent, query);
3580 RELEASE_PARENT (parent);
3582 GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3583 GST_QUERY_TYPE_NAME (query), res);
3588 GST_OBJECT_LOCK (pad);
3589 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3590 GST_OBJECT_UNLOCK (pad);
3592 if (G_UNLIKELY (serialized))
3593 GST_PAD_STREAM_UNLOCK (pad);
3600 g_warning ("pad %s:%s query %s in wrong direction",
3601 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3606 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3611 GST_DEBUG_OBJECT (pad, "had no parent");
3612 GST_OBJECT_UNLOCK (pad);
3613 if (G_UNLIKELY (serialized))
3614 GST_PAD_STREAM_UNLOCK (pad);
3619 GST_DEBUG_OBJECT (pad, "had no query function");
3620 RELEASE_PARENT (parent);
3621 if (G_UNLIKELY (serialized))
3622 GST_PAD_STREAM_UNLOCK (pad);
3627 GST_DEBUG_OBJECT (pad, "query failed");
3628 if (G_UNLIKELY (serialized))
3629 GST_PAD_STREAM_UNLOCK (pad);
3634 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3635 GST_OBJECT_UNLOCK (pad);
3636 if (G_UNLIKELY (serialized))
3637 GST_PAD_STREAM_UNLOCK (pad);
3639 /* if a probe dropped, we don't sent it further but assume that the probe
3640 * answered the query and return TRUE */
3641 if (ret == GST_FLOW_CUSTOM_SUCCESS)
3651 * gst_pad_peer_query:
3652 * @pad: a #GstPad to invoke the peer query on.
3653 * @query: (transfer none): the #GstQuery to perform.
3655 * Performs gst_pad_query() on the peer of @pad.
3657 * The caller is responsible for both the allocation and deallocation of
3658 * the query structure.
3660 * Returns: %TRUE if the query could be performed. This function returns %FALSE
3661 * if @pad has no peer.
3664 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3667 GstPadProbeType type;
3668 gboolean res, serialized;
3671 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3672 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3674 if (GST_PAD_IS_SRC (pad)) {
3675 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3676 goto wrong_direction;
3677 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3678 } else if (GST_PAD_IS_SINK (pad)) {
3679 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3680 goto wrong_direction;
3681 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3683 goto unknown_direction;
3685 GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
3686 GST_QUERY_TYPE_NAME (query));
3688 serialized = GST_QUERY_IS_SERIALIZED (query);
3690 GST_OBJECT_LOCK (pad);
3691 if (GST_PAD_IS_SRC (pad) && serialized) {
3692 /* all serialized queries on the srcpad trigger push of
3694 if (check_sticky (pad, NULL) != GST_FLOW_OK)
3698 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3699 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3700 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3702 peerpad = GST_PAD_PEER (pad);
3703 if (G_UNLIKELY (peerpad == NULL))
3706 gst_object_ref (peerpad);
3707 GST_OBJECT_UNLOCK (pad);
3709 res = gst_pad_query (peerpad, query);
3711 gst_object_unref (peerpad);
3716 GST_OBJECT_LOCK (pad);
3717 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3718 GST_OBJECT_UNLOCK (pad);
3725 g_warning ("pad %s:%s query %s in wrong direction",
3726 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3731 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3736 GST_WARNING_OBJECT (pad, "could not send sticky events");
3737 GST_OBJECT_UNLOCK (pad);
3742 GST_INFO_OBJECT (pad, "pad has no peer");
3743 GST_OBJECT_UNLOCK (pad);
3748 GST_DEBUG_OBJECT (pad, "query failed");
3753 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3754 GST_OBJECT_UNLOCK (pad);
3756 /* if a probe dropped, we don't sent it further but assume that the probe
3757 * answered the query and return TRUE */
3758 if (ret == GST_FLOW_CUSTOM_SUCCESS)
3767 /**********************************************************************
3768 * Data passing functions
3771 /* this is the chain function that does not perform the additional argument
3772 * checking for that little extra speed.
3774 static inline GstFlowReturn
3775 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
3780 GST_PAD_STREAM_LOCK (pad);
3782 GST_OBJECT_LOCK (pad);
3783 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3786 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
3789 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3792 #ifndef G_DISABLE_ASSERT
3793 if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
3794 if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
3796 ":%s:<%s:%s> Got data flow before stream-start event",
3797 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
3799 if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
3801 ":%s:<%s:%s> Got data flow before segment event",
3802 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
3804 pad->priv->last_cookie = pad->priv->events_cookie;
3808 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3810 PROBE_PUSH (pad, type, data, probe_stopped);
3812 parent = GST_OBJECT_PARENT (pad);
3813 GST_OBJECT_UNLOCK (pad);
3815 /* NOTE: we read the chainfunc unlocked.
3816 * we cannot hold the lock for the pad so we might send
3817 * the data to the wrong function. This is not really a
3818 * problem since functions are assigned at creation time
3819 * and don't change that often... */
3820 if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
3821 GstPadChainFunction chainfunc;
3823 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3826 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3827 "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
3828 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
3830 ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
3832 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3833 "called chainfunction &%s with buffer %p, returned %s",
3834 GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
3836 GstPadChainListFunction chainlistfunc;
3838 if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
3841 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3842 "calling chainlistfunction &%s",
3843 GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
3845 ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
3847 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3848 "called chainlistfunction &%s, returned %s",
3849 GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
3852 GST_PAD_STREAM_UNLOCK (pad);
3859 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3860 "chaining, but pad was flushing");
3861 GST_OBJECT_UNLOCK (pad);
3862 GST_PAD_STREAM_UNLOCK (pad);
3863 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3864 return GST_FLOW_FLUSHING;
3868 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "chaining, but pad was EOS");
3869 GST_OBJECT_UNLOCK (pad);
3870 GST_PAD_STREAM_UNLOCK (pad);
3871 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3872 return GST_FLOW_EOS;
3876 g_critical ("chain on pad %s:%s but it was not in push mode",
3877 GST_DEBUG_PAD_NAME (pad));
3878 GST_OBJECT_UNLOCK (pad);
3879 GST_PAD_STREAM_UNLOCK (pad);
3880 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3881 return GST_FLOW_ERROR;
3885 GST_OBJECT_UNLOCK (pad);
3886 GST_PAD_STREAM_UNLOCK (pad);
3887 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3890 case GST_FLOW_CUSTOM_SUCCESS:
3891 GST_DEBUG_OBJECT (pad, "dropped buffer");
3895 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
3902 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3903 g_critical ("chain on pad %s:%s but it has no chainfunction",
3904 GST_DEBUG_PAD_NAME (pad));
3905 GST_PAD_STREAM_UNLOCK (pad);
3906 return GST_FLOW_NOT_SUPPORTED;
3912 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3913 * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
3916 * Chain a buffer to @pad.
3918 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3920 * If the buffer type is not acceptable for @pad (as negotiated with a
3921 * preceding GST_EVENT_CAPS event), this function returns
3922 * #GST_FLOW_NOT_NEGOTIATED.
3924 * The function proceeds calling the chain function installed on @pad (see
3925 * gst_pad_set_chain_function()) and the return value of that function is
3926 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3929 * In all cases, success or failure, the caller loses its reference to @buffer
3930 * after calling this function.
3932 * Returns: a #GstFlowReturn from the pad.
3937 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
3939 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3940 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3941 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3943 return gst_pad_chain_data_unchecked (pad,
3944 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3947 static GstFlowReturn
3948 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
3949 GstBufferList * list)
3955 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3957 len = gst_buffer_list_length (list);
3960 for (i = 0; i < len; i++) {
3961 buffer = gst_buffer_list_get (list, i);
3963 gst_pad_chain_data_unchecked (pad,
3964 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
3965 gst_buffer_ref (buffer));
3966 if (ret != GST_FLOW_OK)
3969 gst_buffer_list_unref (list);
3975 * gst_pad_chain_list:
3976 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3977 * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
3980 * Chain a bufferlist to @pad.
3982 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3984 * If @pad was not negotiated properly with a CAPS event, this function
3985 * returns #GST_FLOW_NOT_NEGOTIATED.
3987 * The function proceeds calling the chainlist function installed on @pad (see
3988 * gst_pad_set_chain_list_function()) and the return value of that function is
3989 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3990 * chainlist function.
3992 * In all cases, success or failure, the caller loses its reference to @list
3993 * after calling this function.
3997 * Returns: a #GstFlowReturn from the pad.
4000 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
4002 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4003 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4004 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4006 return gst_pad_chain_data_unchecked (pad,
4007 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4010 static GstFlowReturn
4011 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
4016 GST_OBJECT_LOCK (pad);
4017 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4020 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4023 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4026 #ifndef G_DISABLE_ASSERT
4027 if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4028 if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4030 ":%s:<%s:%s> Got data flow before stream-start event",
4031 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4033 if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4035 ":%s:<%s:%s> Got data flow before segment event",
4036 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4038 pad->priv->last_cookie = pad->priv->events_cookie;
4042 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4045 /* do block probes */
4046 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
4048 /* recheck sticky events because the probe might have cause a relink */
4049 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4052 /* do post-blocking probes */
4053 PROBE_PUSH (pad, type, data, probe_stopped);
4055 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4058 /* take ref to peer pad before releasing the lock */
4059 gst_object_ref (peer);
4061 GST_OBJECT_UNLOCK (pad);
4063 ret = gst_pad_chain_data_unchecked (peer, type, data);
4065 gst_object_unref (peer);
4067 GST_OBJECT_LOCK (pad);
4068 pad->ABI.abi.last_flowret = ret;
4070 if (pad->priv->using == 0) {
4071 /* pad is not active anymore, trigger idle callbacks */
4072 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4073 probe_stopped, ret);
4075 GST_OBJECT_UNLOCK (pad);
4079 /* ERROR recovery here */
4083 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4084 "pushing, but pad was flushing");
4085 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4086 GST_OBJECT_UNLOCK (pad);
4087 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4088 return GST_FLOW_FLUSHING;
4092 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pushing, but pad was EOS");
4093 pad->ABI.abi.last_flowret = GST_FLOW_EOS;
4094 GST_OBJECT_UNLOCK (pad);
4095 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4096 return GST_FLOW_EOS;
4100 g_critical ("pushing on pad %s:%s but it was not activated in push mode",
4101 GST_DEBUG_PAD_NAME (pad));
4102 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4103 GST_OBJECT_UNLOCK (pad);
4104 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4105 return GST_FLOW_ERROR;
4109 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4110 "error pushing events, return %s", gst_flow_get_name (ret));
4111 pad->ABI.abi.last_flowret = ret;
4112 GST_OBJECT_UNLOCK (pad);
4113 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4118 GST_OBJECT_UNLOCK (pad);
4119 pad->ABI.abi.last_flowret =
4120 ret == GST_FLOW_CUSTOM_SUCCESS ? GST_FLOW_OK : ret;
4121 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4124 case GST_FLOW_CUSTOM_SUCCESS:
4125 GST_DEBUG_OBJECT (pad, "dropped buffer");
4129 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4136 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4137 "pushing, but it was not linked");
4138 pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4139 GST_OBJECT_UNLOCK (pad);
4140 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4141 return GST_FLOW_NOT_LINKED;
4147 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4148 * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
4151 * Pushes a buffer to the peer of @pad.
4153 * This function will call installed block probes before triggering any
4154 * installed data probes.
4156 * The function proceeds calling gst_pad_chain() on the peer pad and returns
4157 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4160 * In all cases, success or failure, the caller loses its reference to @buffer
4161 * after calling this function.
4163 * Returns: a #GstFlowReturn from the peer pad.
4168 gst_pad_push (GstPad * pad, GstBuffer * buffer)
4170 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4171 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4172 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4174 return gst_pad_push_data (pad,
4175 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4179 * gst_pad_push_list:
4180 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4181 * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
4184 * Pushes a buffer list to the peer of @pad.
4186 * This function will call installed block probes before triggering any
4187 * installed data probes.
4189 * The function proceeds calling the chain function on the peer pad and returns
4190 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4191 * be returned. If the peer pad does not have any installed chainlist function
4192 * every group buffer of the list will be merged into a normal #GstBuffer and
4193 * chained via gst_pad_chain().
4195 * In all cases, success or failure, the caller loses its reference to @list
4196 * after calling this function.
4198 * Returns: a #GstFlowReturn from the peer pad.
4203 gst_pad_push_list (GstPad * pad, GstBufferList * list)
4205 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4206 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4207 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4209 return gst_pad_push_data (pad,
4210 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4213 static GstFlowReturn
4214 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
4215 GstBuffer ** buffer)
4218 GstPadGetRangeFunction getrangefunc;
4222 GST_PAD_STREAM_LOCK (pad);
4224 GST_OBJECT_LOCK (pad);
4225 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4228 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4231 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4236 /* when one of the probes returns DROPPED, probe_stopped will be called
4237 * and we skip calling the getrange function, res_buf should then contain a
4238 * valid result buffer */
4239 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4240 res_buf, offset, size, probe_stopped);
4242 /* recheck sticky events because the probe might have cause a relink */
4243 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4246 ACQUIRE_PARENT (pad, parent, no_parent);
4247 GST_OBJECT_UNLOCK (pad);
4249 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
4252 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4253 "calling getrangefunc %s, offset %"
4254 G_GUINT64_FORMAT ", size %u",
4255 GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
4257 ret = getrangefunc (pad, parent, offset, size, &res_buf);
4259 RELEASE_PARENT (parent);
4261 GST_OBJECT_LOCK (pad);
4262 if (G_UNLIKELY (ret != GST_FLOW_OK))
4263 goto get_range_failed;
4265 /* can only fire the signal if we have a valid buffer */
4267 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4268 res_buf, offset, size, probe_stopped_unref);
4269 pad->ABI.abi.last_flowret = ret;
4270 GST_OBJECT_UNLOCK (pad);
4272 GST_PAD_STREAM_UNLOCK (pad);
4281 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4282 "getrange, but pad was flushing");
4283 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4284 GST_OBJECT_UNLOCK (pad);
4285 GST_PAD_STREAM_UNLOCK (pad);
4286 return GST_FLOW_FLUSHING;
4290 g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
4291 GST_DEBUG_PAD_NAME (pad));
4292 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4293 GST_OBJECT_UNLOCK (pad);
4294 GST_PAD_STREAM_UNLOCK (pad);
4295 return GST_FLOW_ERROR;
4299 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
4300 pad->ABI.abi.last_flowret = ret;
4301 GST_OBJECT_UNLOCK (pad);
4302 GST_PAD_STREAM_UNLOCK (pad);
4307 GST_DEBUG_OBJECT (pad, "no parent");
4308 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4309 GST_OBJECT_UNLOCK (pad);
4310 GST_PAD_STREAM_UNLOCK (pad);
4311 return GST_FLOW_FLUSHING;
4315 g_critical ("getrange on pad %s:%s but it has no getrangefunction",
4316 GST_DEBUG_PAD_NAME (pad));
4317 RELEASE_PARENT (parent);
4318 GST_PAD_STREAM_UNLOCK (pad);
4319 return GST_FLOW_NOT_SUPPORTED;
4323 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4324 "probe returned %s", gst_flow_get_name (ret));
4325 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4327 /* the probe filled the buffer and asks us to not call the getrange
4328 * anymore, we continue with the post probes then. */
4329 GST_DEBUG_OBJECT (pad, "handled buffer");
4333 /* no buffer, we are EOS */
4334 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4338 pad->ABI.abi.last_flowret = ret;
4339 GST_OBJECT_UNLOCK (pad);
4340 GST_PAD_STREAM_UNLOCK (pad);
4344 probe_stopped_unref:
4346 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4347 "probe returned %s", gst_flow_get_name (ret));
4348 /* if we drop here, it signals EOS */
4349 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4351 pad->ABI.abi.last_flowret = ret;
4352 GST_OBJECT_UNLOCK (pad);
4353 GST_PAD_STREAM_UNLOCK (pad);
4354 if (*buffer == NULL)
4355 gst_buffer_unref (res_buf);
4360 pad->ABI.abi.last_flowret = ret;
4361 GST_OBJECT_UNLOCK (pad);
4362 GST_PAD_STREAM_UNLOCK (pad);
4363 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4364 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4365 pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
4371 * gst_pad_get_range:
4372 * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4373 * @offset: The start offset of the buffer
4374 * @size: The length of the buffer
4375 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
4376 * returns #GST_FLOW_ERROR if %NULL.
4378 * When @pad is flushing this function returns #GST_FLOW_FLUSHING
4379 * immediately and @buffer is %NULL.
4381 * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4382 * description of a getrange function. If @pad has no getrange function
4383 * installed (see gst_pad_set_getrange_function()) this function returns
4384 * #GST_FLOW_NOT_SUPPORTED.
4386 * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4387 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4388 * must be freed with gst_buffer_unref() after usage.
4390 * When @buffer points to a variable that points to a valid #GstBuffer, the
4391 * buffer will be filled with the result data when this function returns
4392 * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4393 * @size bytes will be filled in the result buffer and its size will be updated
4396 * Note that less than @size bytes can be returned in @buffer when, for example,
4397 * an EOS condition is near or when @buffer is not large enough to hold @size
4398 * bytes. The caller should check the result buffer size to get the result size.
4400 * When this function returns any other result value than #GST_FLOW_OK, @buffer
4401 * will be unchanged.
4403 * This is a lowlevel function. Usually gst_pad_pull_range() is used.
4405 * Returns: a #GstFlowReturn from the pad.
4410 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4411 GstBuffer ** buffer)
4413 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4414 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4415 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4416 g_return_val_if_fail (*buffer == NULL
4417 || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4419 return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4423 * gst_pad_pull_range:
4424 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4425 * @offset: The start offset of the buffer
4426 * @size: The length of the buffer
4427 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4428 * GST_FLOW_ERROR if %NULL.
4430 * Pulls a @buffer from the peer pad or fills up a provided buffer.
4432 * This function will first trigger the pad block signal if it was
4435 * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4436 * function returns the result of gst_pad_get_range() on the peer pad.
4437 * See gst_pad_get_range() for a list of return values and for the
4438 * semantics of the arguments of this function.
4440 * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4441 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4442 * must be freed with gst_buffer_unref() after usage. When this function
4443 * returns any other result value, @buffer will still point to %NULL.
4445 * When @buffer points to a variable that points to a valid #GstBuffer, the
4446 * buffer will be filled with the result data when this function returns
4447 * #GST_FLOW_OK. When this function returns any other result value,
4448 * @buffer will be unchanged. If the provided buffer is larger than @size, only
4449 * @size bytes will be filled in the result buffer and its size will be updated
4452 * Note that less than @size bytes can be returned in @buffer when, for example,
4453 * an EOS condition is near or when @buffer is not large enough to hold @size
4454 * bytes. The caller should check the result buffer size to get the result size.
4456 * Returns: a #GstFlowReturn from the peer pad.
4461 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4462 GstBuffer ** buffer)
4468 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4469 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4470 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4471 g_return_val_if_fail (*buffer == NULL
4472 || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4474 GST_OBJECT_LOCK (pad);
4475 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4478 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4483 /* when one of the probes returns DROPPED, probe_stopped will be
4484 * called and we skip calling the peer getrange function. *buffer should then
4485 * contain a valid buffer */
4486 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4487 res_buf, offset, size, probe_stopped);
4489 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4492 gst_object_ref (peer);
4494 GST_OBJECT_UNLOCK (pad);
4496 ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4498 gst_object_unref (peer);
4500 GST_OBJECT_LOCK (pad);
4502 pad->ABI.abi.last_flowret = ret;
4503 if (pad->priv->using == 0) {
4504 /* pad is not active anymore, trigger idle callbacks */
4505 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4506 probe_stopped_unref, ret);
4509 if (G_UNLIKELY (ret != GST_FLOW_OK))
4510 goto pull_range_failed;
4513 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4514 res_buf, offset, size, probe_stopped_unref);
4516 GST_OBJECT_UNLOCK (pad);
4522 /* ERROR recovery here */
4525 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4526 "pullrange, but pad was flushing");
4527 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4528 GST_OBJECT_UNLOCK (pad);
4529 return GST_FLOW_FLUSHING;
4533 g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4534 GST_DEBUG_PAD_NAME (pad));
4535 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4536 GST_OBJECT_UNLOCK (pad);
4537 return GST_FLOW_ERROR;
4541 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4542 gst_flow_get_name (ret));
4543 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4545 /* the probe filled the buffer and asks us to not forward to the peer
4546 * anymore, we continue with the post probes then */
4547 GST_DEBUG_OBJECT (pad, "handled buffer");
4551 /* no buffer, we are EOS then */
4552 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4556 pad->ABI.abi.last_flowret = ret;
4557 GST_OBJECT_UNLOCK (pad);
4562 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4563 "pulling range, but it was not linked");
4564 pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4565 GST_OBJECT_UNLOCK (pad);
4566 return GST_FLOW_NOT_LINKED;
4570 pad->ABI.abi.last_flowret = ret;
4571 GST_OBJECT_UNLOCK (pad);
4572 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4573 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4574 pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4577 probe_stopped_unref:
4579 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4580 "post probe returned %s", gst_flow_get_name (ret));
4582 /* if we drop here, it signals EOS */
4583 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4586 pad->ABI.abi.last_flowret = ret;
4587 GST_OBJECT_UNLOCK (pad);
4589 if (*buffer == NULL)
4590 gst_buffer_unref (res_buf);
4595 /* must be called with pad object lock */
4596 static GstFlowReturn
4597 store_sticky_event (GstPad * pad, GstEvent * event)
4602 gboolean res = FALSE;
4603 const gchar *name = NULL;
4604 gboolean insert = TRUE;
4606 type = GST_EVENT_TYPE (event);
4608 /* Store all sticky events except SEGMENT/EOS when we're flushing,
4609 * otherwise they can be dropped and nothing would ever resend them.
4610 * Only do that for activated pads though, everything else is a bug!
4612 if (G_UNLIKELY (GST_PAD_MODE (pad) == GST_PAD_MODE_NONE
4613 || (GST_PAD_IS_FLUSHING (pad) && (type == GST_EVENT_SEGMENT
4614 || type == GST_EVENT_EOS))))
4617 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4620 if (type & GST_EVENT_TYPE_STICKY_MULTI)
4621 name = gst_structure_get_name (gst_event_get_structure (event));
4623 events = pad->priv->events;
4626 for (i = 0; i < len; i++) {
4627 PadEvent *ev = &g_array_index (events, PadEvent, i);
4629 if (ev->event == NULL)
4632 if (type == GST_EVENT_TYPE (ev->event)) {
4633 /* matching types, check matching name if needed */
4634 if (name && !gst_event_has_name (ev->event, name))
4638 if ((res = gst_event_replace (&ev->event, event)))
4639 ev->received = FALSE;
4645 if (type < GST_EVENT_TYPE (ev->event) || (type != GST_EVENT_TYPE (ev->event)
4646 && GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS)) {
4647 /* STREAM_START, CAPS and SEGMENT must be delivered in this order. By
4648 * storing the sticky ordered we can check that this is respected. */
4649 if (G_UNLIKELY (GST_EVENT_TYPE (ev->event) <= GST_EVENT_SEGMENT
4650 || GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS))
4652 ":%s:<%s:%s> Sticky event misordering, got '%s' before '%s'",
4653 G_STRFUNC, GST_DEBUG_PAD_NAME (pad),
4654 gst_event_type_get_name (GST_EVENT_TYPE (ev->event)),
4655 gst_event_type_get_name (type));
4661 ev.event = gst_event_ref (event);
4662 ev.received = FALSE;
4663 g_array_insert_val (events, i, ev);
4668 pad->priv->events_cookie++;
4669 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4671 GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
4673 switch (GST_EVENT_TYPE (event)) {
4674 case GST_EVENT_CAPS:
4675 GST_OBJECT_UNLOCK (pad);
4677 GST_DEBUG_OBJECT (pad, "notify caps");
4678 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
4680 GST_OBJECT_LOCK (pad);
4686 if (type == GST_EVENT_EOS) {
4687 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
4688 pad->ABI.abi.last_flowret = GST_FLOW_EOS;
4691 return GST_PAD_IS_FLUSHING (pad) ? GST_FLOW_FLUSHING : GST_FLOW_OK;
4696 GST_DEBUG_OBJECT (pad, "pad is flushing");
4697 return GST_FLOW_FLUSHING;
4701 GST_DEBUG_OBJECT (pad, "pad is EOS");
4702 return GST_FLOW_EOS;
4707 * gst_pad_store_sticky_event:
4709 * @event: a #GstEvent
4711 * Store the sticky @event on @pad
4713 * Returns: #GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad
4714 * was flushing or #GST_FLOW_EOS when the pad was EOS.
4719 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event)
4723 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4724 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4726 GST_OBJECT_LOCK (pad);
4727 ret = store_sticky_event (pad, event);
4728 GST_OBJECT_UNLOCK (pad);
4734 sticky_changed (GstPad * pad, PadEvent * ev, gpointer user_data)
4736 PushStickyData *data = user_data;
4738 /* Forward all sticky events before our current one that are pending */
4739 if (ev->event != data->event
4740 && GST_EVENT_TYPE (ev->event) < GST_EVENT_TYPE (data->event))
4741 return push_sticky (pad, ev, data);
4746 /* should be called with pad LOCK */
4747 static GstFlowReturn
4748 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
4749 GstPadProbeType type)
4753 GstEventType event_type;
4755 /* pass the adjusted event on. We need to do this even if
4756 * there is no peer pad because of the probes. */
4757 event = apply_pad_offset (pad, event, GST_PAD_IS_SINK (pad));
4759 /* Two checks to be made:
4760 * . (un)set the FLUSHING flag for flushing events,
4761 * . handle pad blocking */
4762 event_type = GST_EVENT_TYPE (event);
4763 switch (event_type) {
4764 case GST_EVENT_FLUSH_START:
4765 GST_PAD_SET_FLUSHING (pad);
4767 GST_PAD_BLOCK_BROADCAST (pad);
4768 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4770 case GST_EVENT_FLUSH_STOP:
4771 GST_PAD_UNSET_FLUSHING (pad);
4773 /* Remove sticky EOS events */
4774 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4775 remove_event_by_type (pad, GST_EVENT_EOS);
4776 remove_event_by_type (pad, GST_EVENT_SEGMENT);
4777 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
4778 pad->ABI.abi.last_flowret = GST_FLOW_OK;
4780 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4784 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4787 /* No need to check for EOS here as either the caller (gst_pad_push_event())
4788 * checked already or this is called as part of pushing sticky events,
4789 * in which case we still want to forward the EOS event downstream.
4792 switch (GST_EVENT_TYPE (event)) {
4793 case GST_EVENT_RECONFIGURE:
4794 if (GST_PAD_IS_SINK (pad))
4795 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4800 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4801 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4806 /* send probes after modifying the events above */
4807 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4809 /* recheck sticky events because the probe might have cause a relink */
4810 if (GST_PAD_HAS_PENDING_EVENTS (pad) && GST_PAD_IS_SRC (pad)
4811 && (GST_EVENT_IS_SERIALIZED (event)
4812 || GST_EVENT_IS_STICKY (event))) {
4813 PushStickyData data = { GST_FLOW_OK, FALSE, event };
4814 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4816 /* Push all sticky events before our current one
4817 * that have changed */
4818 events_foreach (pad, sticky_changed, &data);
4821 /* now check the peer pad */
4822 peerpad = GST_PAD_PEER (pad);
4823 if (peerpad == NULL)
4826 gst_object_ref (peerpad);
4828 GST_OBJECT_UNLOCK (pad);
4830 GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
4831 event, gst_event_type_get_name (event_type), peerpad);
4833 ret = gst_pad_send_event_unchecked (peerpad, event, type);
4835 /* Note: we gave away ownership of the event at this point but we can still
4836 * print the old pointer */
4837 GST_LOG_OBJECT (pad,
4838 "sent event %p to (%s) peerpad %" GST_PTR_FORMAT ", ret %s", event,
4839 gst_event_type_get_name (event_type), peerpad, gst_flow_get_name (ret));
4841 gst_object_unref (peerpad);
4843 GST_OBJECT_LOCK (pad);
4845 if (pad->priv->using == 0) {
4846 /* pad is not active anymore, trigger idle callbacks */
4847 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4848 idle_probe_stopped, ret);
4852 /* ERROR handling */
4855 GST_DEBUG_OBJECT (pad, "We're flushing");
4856 gst_event_unref (event);
4857 return GST_FLOW_FLUSHING;
4861 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4862 gst_event_unref (event);
4865 case GST_FLOW_CUSTOM_SUCCESS:
4866 GST_DEBUG_OBJECT (pad, "dropped event");
4869 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4876 GST_DEBUG_OBJECT (pad, "Dropping event %s because pad is not linked",
4877 gst_event_type_get_name (GST_EVENT_TYPE (event)));
4878 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4879 gst_event_unref (event);
4881 /* unlinked pads should not influence latency configuration */
4882 if (event_type == GST_EVENT_LATENCY)
4885 return GST_FLOW_NOT_LINKED;
4889 GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
4895 * gst_pad_push_event:
4896 * @pad: a #GstPad to push the event to.
4897 * @event: (transfer full): the #GstEvent to send to the pad.
4899 * Sends the event to the peer of the given pad. This function is
4900 * mainly used by elements to send events to their peer
4903 * This function takes ownership of the provided event so you should
4904 * gst_event_ref() it if you want to reuse the event after this call.
4906 * Returns: %TRUE if the event was handled.
4911 gst_pad_push_event (GstPad * pad, GstEvent * event)
4913 gboolean res = FALSE;
4914 GstPadProbeType type;
4915 gboolean sticky, serialized;
4917 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4918 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4920 if (GST_PAD_IS_SRC (pad)) {
4921 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4922 goto wrong_direction;
4923 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4924 } else if (GST_PAD_IS_SINK (pad)) {
4925 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4926 goto wrong_direction;
4927 /* events pushed on sinkpad never are sticky */
4928 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4930 goto unknown_direction;
4932 GST_OBJECT_LOCK (pad);
4933 sticky = GST_EVENT_IS_STICKY (event);
4934 serialized = GST_EVENT_IS_SERIALIZED (event);
4937 /* srcpad sticky events are stored immediately, the received flag is set
4938 * to FALSE and will be set to TRUE when we can successfully push the
4939 * event to the peer pad */
4940 switch (store_sticky_event (pad, event)) {
4941 case GST_FLOW_FLUSHING:
4949 if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
4950 /* all serialized or sticky events on the srcpad trigger push of
4952 res = (check_sticky (pad, event) == GST_FLOW_OK);
4957 /* other events are pushed right away */
4958 ret = gst_pad_push_event_unchecked (pad, event, type);
4959 /* dropped events by a probe are not an error */
4960 res = (ret == GST_FLOW_OK || ret == GST_FLOW_CUSTOM_SUCCESS);
4962 /* Errors in sticky event pushing are no problem and ignored here
4963 * as they will cause more meaningful errors during data flow.
4964 * For EOS events, that are not followed by data flow, we still
4965 * return FALSE here though.
4967 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
4969 gst_event_unref (event);
4971 GST_OBJECT_UNLOCK (pad);
4975 /* ERROR handling */
4978 g_warning ("pad %s:%s pushing %s event in wrong direction",
4979 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4980 gst_event_unref (event);
4985 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4986 gst_event_unref (event);
4991 GST_DEBUG_OBJECT (pad, "We're flushing");
4992 GST_OBJECT_UNLOCK (pad);
4993 gst_event_unref (event);
4998 GST_DEBUG_OBJECT (pad, "We're EOS");
4999 GST_OBJECT_UNLOCK (pad);
5000 gst_event_unref (event);
5005 /* Check if we can call the event function with the given event */
5006 static GstFlowReturn
5007 pre_eventfunc_check (GstPad * pad, GstEvent * event)
5011 switch (GST_EVENT_TYPE (event)) {
5012 case GST_EVENT_CAPS:
5014 /* backwards compatibility mode for caps */
5015 gst_event_parse_caps (event, &caps);
5017 if (!gst_pad_query_accept_caps (pad, caps))
5029 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
5030 "caps %" GST_PTR_FORMAT " not accepted", caps);
5031 return GST_FLOW_NOT_NEGOTIATED;
5035 static GstFlowReturn
5036 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
5037 GstPadProbeType type)
5040 GstEventType event_type;
5041 gboolean serialized, need_unlock = FALSE, sticky;
5042 GstPadEventFunction eventfunc;
5045 GST_OBJECT_LOCK (pad);
5047 event = apply_pad_offset (pad, event, GST_PAD_IS_SRC (pad));
5049 if (GST_PAD_IS_SINK (pad))
5050 serialized = GST_EVENT_IS_SERIALIZED (event);
5053 sticky = GST_EVENT_IS_STICKY (event);
5054 event_type = GST_EVENT_TYPE (event);
5055 switch (event_type) {
5056 case GST_EVENT_FLUSH_START:
5057 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5058 "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
5060 /* can't even accept a flush begin event when flushing */
5061 if (GST_PAD_IS_FLUSHING (pad))
5064 GST_PAD_SET_FLUSHING (pad);
5065 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
5067 case GST_EVENT_FLUSH_STOP:
5068 if (G_LIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_NONE)) {
5069 GST_PAD_UNSET_FLUSHING (pad);
5070 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
5072 /* Remove pending EOS events */
5073 GST_LOG_OBJECT (pad, "Removing pending EOS and SEGMENT events");
5074 remove_event_by_type (pad, GST_EVENT_EOS);
5075 remove_event_by_type (pad, GST_EVENT_SEGMENT);
5076 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5077 pad->ABI.abi.last_flowret = GST_FLOW_OK;
5079 GST_OBJECT_UNLOCK (pad);
5080 /* grab stream lock */
5081 GST_PAD_STREAM_LOCK (pad);
5083 GST_OBJECT_LOCK (pad);
5084 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5087 case GST_EVENT_RECONFIGURE:
5088 if (GST_PAD_IS_SRC (pad))
5089 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5091 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5092 "have event type %" GST_PTR_FORMAT, event);
5094 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5098 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5101 /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
5102 GST_OBJECT_UNLOCK (pad);
5103 GST_PAD_STREAM_LOCK (pad);
5105 GST_OBJECT_LOCK (pad);
5106 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5109 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5115 /* now do the probe */
5117 type | GST_PAD_PROBE_TYPE_PUSH |
5118 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5120 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5122 if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
5125 ACQUIRE_PARENT (pad, parent, no_parent);
5126 GST_OBJECT_UNLOCK (pad);
5128 ret = pre_eventfunc_check (pad, event);
5129 if (G_UNLIKELY (ret != GST_FLOW_OK))
5130 goto precheck_failed;
5133 gst_event_ref (event);
5135 if (eventfunc (pad, parent, event)) {
5138 /* something went wrong */
5139 switch (event_type) {
5140 case GST_EVENT_CAPS:
5141 ret = GST_FLOW_NOT_NEGOTIATED;
5144 ret = GST_FLOW_ERROR;
5148 RELEASE_PARENT (parent);
5150 GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
5153 if (ret == GST_FLOW_OK) {
5154 GST_OBJECT_LOCK (pad);
5155 /* after the event function accepted the event, we can store the sticky
5156 * event on the pad */
5157 switch (store_sticky_event (pad, event)) {
5158 case GST_FLOW_FLUSHING:
5165 GST_OBJECT_UNLOCK (pad);
5167 gst_event_unref (event);
5171 GST_PAD_STREAM_UNLOCK (pad);
5175 /* ERROR handling */
5178 GST_OBJECT_UNLOCK (pad);
5180 GST_PAD_STREAM_UNLOCK (pad);
5181 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5182 "Received event on flushing pad. Discarding");
5183 gst_event_unref (event);
5184 return GST_FLOW_FLUSHING;
5188 GST_OBJECT_UNLOCK (pad);
5190 GST_PAD_STREAM_UNLOCK (pad);
5191 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5192 "Received event on EOS pad. Discarding");
5193 gst_event_unref (event);
5194 return GST_FLOW_EOS;
5198 GST_OBJECT_UNLOCK (pad);
5200 GST_PAD_STREAM_UNLOCK (pad);
5201 gst_event_unref (event);
5204 case GST_FLOW_CUSTOM_SUCCESS:
5205 GST_DEBUG_OBJECT (pad, "dropped event");
5209 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5216 g_warning ("pad %s:%s has no event handler, file a bug.",
5217 GST_DEBUG_PAD_NAME (pad));
5218 GST_OBJECT_UNLOCK (pad);
5220 GST_PAD_STREAM_UNLOCK (pad);
5221 gst_event_unref (event);
5222 return GST_FLOW_NOT_SUPPORTED;
5226 GST_DEBUG_OBJECT (pad, "no parent");
5227 GST_OBJECT_UNLOCK (pad);
5229 GST_PAD_STREAM_UNLOCK (pad);
5230 gst_event_unref (event);
5231 return GST_FLOW_FLUSHING;
5235 GST_DEBUG_OBJECT (pad, "pre event check failed");
5236 RELEASE_PARENT (parent);
5238 GST_PAD_STREAM_UNLOCK (pad);
5239 gst_event_unref (event);
5245 * gst_pad_send_event:
5246 * @pad: a #GstPad to send the event to.
5247 * @event: (transfer full): the #GstEvent to send to the pad.
5249 * Sends the event to the pad. This function can be used
5250 * by applications to send events in the pipeline.
5252 * If @pad is a source pad, @event should be an upstream event. If @pad is a
5253 * sink pad, @event should be a downstream event. For example, you would not
5254 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
5255 * Furthermore, some downstream events have to be serialized with data flow,
5256 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
5257 * the event needs to be serialized with data flow, this function will take the
5258 * pad's stream lock while calling its event function.
5260 * To find out whether an event type is upstream, downstream, or downstream and
5261 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
5262 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
5263 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
5264 * plugin doesn't need to bother itself with this information; the core handles
5265 * all necessary locks and checks.
5267 * This function takes ownership of the provided event so you should
5268 * gst_event_ref() it if you want to reuse the event after this call.
5270 * Returns: %TRUE if the event was handled.
5273 gst_pad_send_event (GstPad * pad, GstEvent * event)
5276 GstPadProbeType type;
5278 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5279 g_return_val_if_fail (event != NULL, FALSE);
5281 if (GST_PAD_IS_SINK (pad)) {
5282 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5283 goto wrong_direction;
5284 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5285 } else if (GST_PAD_IS_SRC (pad)) {
5286 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5287 goto wrong_direction;
5288 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5290 goto unknown_direction;
5292 if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
5299 /* ERROR handling */
5302 g_warning ("pad %s:%s sending %s event in wrong direction",
5303 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5304 gst_event_unref (event);
5309 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5310 gst_event_unref (event);
5316 * gst_pad_set_element_private:
5317 * @pad: the #GstPad to set the private data of.
5318 * @priv: The private data to attach to the pad.
5320 * Set the given private data gpointer on the pad.
5321 * This function can only be used by the element that owns the pad.
5322 * No locking is performed in this function.
5325 gst_pad_set_element_private (GstPad * pad, gpointer priv)
5327 pad->element_private = priv;
5331 * gst_pad_get_element_private:
5332 * @pad: the #GstPad to get the private data of.
5334 * Gets the private data of a pad.
5335 * No locking is performed in this function.
5337 * Returns: (transfer none): a #gpointer to the private data.
5340 gst_pad_get_element_private (GstPad * pad)
5342 return pad->element_private;
5346 * gst_pad_get_sticky_event:
5347 * @pad: the #GstPad to get the event from.
5348 * @event_type: the #GstEventType that should be retrieved.
5349 * @idx: the index of the event
5351 * Returns a new reference of the sticky event of type @event_type
5354 * Returns: (transfer full) (nullable): a #GstEvent of type
5355 * @event_type or %NULL when no event of @event_type was on
5356 * @pad. Unref after usage.
5359 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
5361 GstEvent *event = NULL;
5364 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
5365 g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
5367 GST_OBJECT_LOCK (pad);
5368 ev = find_event_by_type (pad, event_type, idx);
5369 if (ev && (event = ev->event))
5370 gst_event_ref (event);
5371 GST_OBJECT_UNLOCK (pad);
5378 GstPadStickyEventsForeachFunction func;
5383 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
5385 ForeachDispatch *data = user_data;
5386 gboolean ret = TRUE;
5389 GST_OBJECT_UNLOCK (pad);
5391 ret = data->func (pad, &ev->event, data->user_data);
5393 GST_OBJECT_LOCK (pad);
5400 * gst_pad_sticky_events_foreach:
5401 * @pad: the #GstPad that should be used for iteration.
5402 * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
5403 * should be called for every event.
5404 * @user_data: (closure): the optional user data.
5406 * Iterates all sticky events on @pad and calls @foreach_func for every
5407 * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
5410 gst_pad_sticky_events_foreach (GstPad * pad,
5411 GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
5413 ForeachDispatch data;
5415 g_return_if_fail (GST_IS_PAD (pad));
5416 g_return_if_fail (foreach_func != NULL);
5418 data.func = foreach_func;
5419 data.user_data = user_data;
5421 GST_OBJECT_LOCK (pad);
5422 events_foreach (pad, foreach_dispatch_function, &data);
5423 GST_OBJECT_UNLOCK (pad);
5427 do_stream_status (GstPad * pad, GstStreamStatusType type,
5428 GThread * thread, GstTask * task)
5432 GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5434 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5435 if (GST_IS_ELEMENT (parent)) {
5436 GstMessage *message;
5437 GValue value = { 0 };
5439 if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5440 gchar *tname, *ename, *pname;
5442 /* create a good task name */
5443 ename = gst_element_get_name (parent);
5444 pname = gst_pad_get_name (pad);
5445 tname = g_strdup_printf ("%s:%s", ename, pname);
5449 gst_object_set_name (GST_OBJECT_CAST (task), tname);
5453 message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5456 g_value_init (&value, GST_TYPE_TASK);
5457 g_value_set_object (&value, task);
5458 gst_message_set_stream_status_object (message, &value);
5459 g_value_unset (&value);
5461 GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5462 gst_element_post_message (parent, message);
5464 gst_object_unref (parent);
5469 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5471 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5476 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5478 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5483 * gst_pad_start_task:
5484 * @pad: the #GstPad to start the task of
5485 * @func: the task function to call
5486 * @user_data: user data passed to the task function
5487 * @notify: called when @user_data is no longer referenced
5489 * Starts a task that repeatedly calls @func with @user_data. This function
5490 * is mostly used in pad activation functions to start the dataflow.
5491 * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5492 * before @func is called.
5494 * Returns: a %TRUE if the task could be started.
5497 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer user_data,
5498 GDestroyNotify notify)
5503 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5504 g_return_val_if_fail (func != NULL, FALSE);
5506 GST_DEBUG_OBJECT (pad, "start task");
5508 GST_OBJECT_LOCK (pad);
5509 task = GST_PAD_TASK (pad);
5511 task = gst_task_new (func, user_data, notify);
5512 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5513 gst_task_set_enter_callback (task, pad_enter_thread, pad, NULL);
5514 gst_task_set_leave_callback (task, pad_leave_thread, pad, NULL);
5515 GST_INFO_OBJECT (pad, "created task %p", task);
5516 GST_PAD_TASK (pad) = task;
5517 gst_object_ref (task);
5518 /* release lock to post the message */
5519 GST_OBJECT_UNLOCK (pad);
5521 do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
5523 gst_object_unref (task);
5525 GST_OBJECT_LOCK (pad);
5526 /* nobody else is supposed to have changed the pad now */
5527 if (GST_PAD_TASK (pad) != task)
5528 goto concurrent_stop;
5530 res = gst_task_set_state (task, GST_TASK_STARTED);
5531 GST_OBJECT_UNLOCK (pad);
5538 GST_OBJECT_UNLOCK (pad);
5544 * gst_pad_pause_task:
5545 * @pad: the #GstPad to pause the task of
5547 * Pause the task of @pad. This function will also wait until the
5548 * function executed by the task is finished if this function is not
5549 * called from the task function.
5551 * Returns: a %TRUE if the task could be paused or %FALSE when the pad
5555 gst_pad_pause_task (GstPad * pad)
5560 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5562 GST_DEBUG_OBJECT (pad, "pause task");
5564 GST_OBJECT_LOCK (pad);
5565 task = GST_PAD_TASK (pad);
5568 res = gst_task_set_state (task, GST_TASK_PAUSED);
5569 GST_OBJECT_UNLOCK (pad);
5571 /* wait for task function to finish, this lock is recursive so it does nothing
5572 * when the pause is called from the task itself */
5573 GST_PAD_STREAM_LOCK (pad);
5574 GST_PAD_STREAM_UNLOCK (pad);
5580 GST_DEBUG_OBJECT (pad, "pad has no task");
5581 GST_OBJECT_UNLOCK (pad);
5587 * gst_pad_stop_task:
5588 * @pad: the #GstPad to stop the task of
5590 * Stop the task of @pad. This function will also make sure that the
5591 * function executed by the task will effectively stop if not called
5592 * from the GstTaskFunction.
5594 * This function will deadlock if called from the GstTaskFunction of
5595 * the task. Use gst_task_pause() instead.
5597 * Regardless of whether the pad has a task, the stream lock is acquired and
5598 * released so as to ensure that streaming through this pad has finished.
5600 * Returns: a %TRUE if the task could be stopped or %FALSE on error.
5603 gst_pad_stop_task (GstPad * pad)
5608 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5610 GST_DEBUG_OBJECT (pad, "stop task");
5612 GST_OBJECT_LOCK (pad);
5613 task = GST_PAD_TASK (pad);
5616 GST_PAD_TASK (pad) = NULL;
5617 res = gst_task_set_state (task, GST_TASK_STOPPED);
5618 GST_OBJECT_UNLOCK (pad);
5620 GST_PAD_STREAM_LOCK (pad);
5621 GST_PAD_STREAM_UNLOCK (pad);
5623 if (!gst_task_join (task))
5626 gst_object_unref (task);
5632 GST_DEBUG_OBJECT (pad, "no task");
5633 GST_OBJECT_UNLOCK (pad);
5635 GST_PAD_STREAM_LOCK (pad);
5636 GST_PAD_STREAM_UNLOCK (pad);
5638 /* this is not an error */
5643 /* this is bad, possibly the application tried to join the task from
5644 * the task's thread. We install the task again so that it will be stopped
5645 * again from the right thread next time hopefully. */
5646 GST_OBJECT_LOCK (pad);
5647 GST_DEBUG_OBJECT (pad, "join failed");
5648 /* we can only install this task if there was no other task */
5649 if (GST_PAD_TASK (pad) == NULL)
5650 GST_PAD_TASK (pad) = task;
5651 GST_OBJECT_UNLOCK (pad);
5658 * gst_pad_probe_info_get_event:
5659 * @info: a #GstPadProbeInfo
5661 * Returns: (transfer none): The #GstEvent from the probe
5665 gst_pad_probe_info_get_event (GstPadProbeInfo * info)
5667 g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM |
5668 GST_PAD_PROBE_TYPE_EVENT_UPSTREAM), NULL);
5670 return GST_PAD_PROBE_INFO_EVENT (info);
5675 * gst_pad_probe_info_get_query:
5676 * @info: a #GstPadProbeInfo
5678 * Returns: (transfer none): The #GstQuery from the probe
5682 gst_pad_probe_info_get_query (GstPadProbeInfo * info)
5684 g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM |
5685 GST_PAD_PROBE_TYPE_QUERY_UPSTREAM), NULL);
5687 return GST_PAD_PROBE_INFO_QUERY (info);
5691 * gst_pad_probe_info_get_buffer:
5692 * @info: a #GstPadProbeInfo
5694 * Returns: (transfer none): The #GstBuffer from the probe
5698 gst_pad_probe_info_get_buffer (GstPadProbeInfo * info)
5700 g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER, NULL);
5702 return GST_PAD_PROBE_INFO_BUFFER (info);
5706 * gst_pad_probe_info_get_bufferlist:
5707 * @info: a #GstPadProbeInfo
5709 * Returns: (transfer none): The #GstBufferlist from the probe
5713 gst_pad_probe_info_get_buffer_list (GstPadProbeInfo * info)
5715 g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER_LIST, NULL);
5717 return GST_PAD_PROBE_INFO_BUFFER_LIST (info);
5721 * gst_pad_get_last_flow_return:
5724 * Gets the #GstFlowReturn return from the last data passed by this pad.
5729 gst_pad_get_last_flow_return (GstPad * pad)
5733 GST_OBJECT_LOCK (pad);
5734 ret = GST_PAD_LAST_FLOW_RETURN (pad);
5735 GST_OBJECT_UNLOCK (pad);