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 */
122 #define GST_PAD_GET_PRIVATE(obj) \
123 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PAD, GstPadPrivate))
125 /* we have a pending and an active event on the pad. On source pads only the
126 * active event is used. On sinkpads, events are copied to the pending entry and
127 * moved to the active event when the eventfunc returned %TRUE. */
134 struct _GstPadPrivate
141 guint probe_list_cookie;
151 #define PROBE_COOKIE(h) (((GstProbe *)(h))->cookie)
156 GstPadProbeInfo *info;
163 static void gst_pad_dispose (GObject * object);
164 static void gst_pad_finalize (GObject * object);
165 static void gst_pad_set_property (GObject * object, guint prop_id,
166 const GValue * value, GParamSpec * pspec);
167 static void gst_pad_get_property (GObject * object, guint prop_id,
168 GValue * value, GParamSpec * pspec);
170 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
171 static gboolean gst_pad_activate_default (GstPad * pad, GstObject * parent);
172 static GstFlowReturn gst_pad_chain_list_default (GstPad * pad,
173 GstObject * parent, GstBufferList * list);
175 static GstFlowReturn gst_pad_send_event_unchecked (GstPad * pad,
176 GstEvent * event, GstPadProbeType type);
177 static GstFlowReturn gst_pad_push_event_unchecked (GstPad * pad,
178 GstEvent * event, GstPadProbeType type);
180 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
182 static GParamSpec *pspec_caps = NULL;
184 /* quarks for probe signals */
185 static GQuark buffer_quark;
186 static GQuark buffer_list_quark;
187 static GQuark event_quark;
196 static GstFlowQuarks flow_quarks[] = {
197 {GST_FLOW_CUSTOM_SUCCESS, "custom-success", 0},
198 {GST_FLOW_OK, "ok", 0},
199 {GST_FLOW_NOT_LINKED, "not-linked", 0},
200 {GST_FLOW_FLUSHING, "flushing", 0},
201 {GST_FLOW_EOS, "eos", 0},
202 {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
203 {GST_FLOW_ERROR, "error", 0},
204 {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
205 {GST_FLOW_CUSTOM_ERROR, "custom-error", 0}
210 * @ret: a #GstFlowReturn to get the name of.
212 * Gets a string representing the given flow return.
214 * Returns: a static string with the name of the flow return.
217 gst_flow_get_name (GstFlowReturn ret)
221 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
223 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
224 if (ret == flow_quarks[i].ret)
225 return flow_quarks[i].name;
232 * @ret: a #GstFlowReturn to get the quark of.
234 * Get the unique quark for the given GstFlowReturn.
236 * Returns: the quark associated with the flow return or 0 if an
237 * invalid return was specified.
240 gst_flow_to_quark (GstFlowReturn ret)
244 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
246 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
247 if (ret == flow_quarks[i].ret)
248 return flow_quarks[i].quark;
254 * gst_pad_link_get_name:
255 * @ret: a #GstPadLinkReturn to get the name of.
257 * Gets a string representing the given pad-link return.
259 * Returns: a static string with the name of the pad-link return.
264 gst_pad_link_get_name (GstPadLinkReturn ret)
267 case GST_PAD_LINK_OK:
269 case GST_PAD_LINK_WRONG_HIERARCHY:
270 return "wrong hierarchy";
271 case GST_PAD_LINK_WAS_LINKED:
273 case GST_PAD_LINK_WRONG_DIRECTION:
274 return "wrong direction";
275 case GST_PAD_LINK_NOFORMAT:
276 return "no common format";
277 case GST_PAD_LINK_NOSCHED:
278 return "incompatible scheduling";
279 case GST_PAD_LINK_REFUSED:
282 g_return_val_if_reached ("unknown");
289 buffer_quark = g_quark_from_static_string ("buffer"); \
290 buffer_list_quark = g_quark_from_static_string ("bufferlist"); \
291 event_quark = g_quark_from_static_string ("event"); \
293 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) { \
294 flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name); \
297 GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW", \
298 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads"); \
301 #define gst_pad_parent_class parent_class
302 G_DEFINE_TYPE_WITH_CODE (GstPad, gst_pad, GST_TYPE_OBJECT, _do_init);
305 gst_pad_class_init (GstPadClass * klass)
307 GObjectClass *gobject_class;
308 GstObjectClass *gstobject_class;
310 gobject_class = G_OBJECT_CLASS (klass);
311 gstobject_class = GST_OBJECT_CLASS (klass);
313 g_type_class_add_private (klass, sizeof (GstPadPrivate));
315 gobject_class->dispose = gst_pad_dispose;
316 gobject_class->finalize = gst_pad_finalize;
317 gobject_class->set_property = gst_pad_set_property;
318 gobject_class->get_property = gst_pad_get_property;
322 * @pad: the pad that emitted the signal
323 * @peer: the peer pad that has been connected
325 * Signals that a pad has been linked to the peer pad.
327 gst_pad_signals[PAD_LINKED] =
328 g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
329 G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
330 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
333 * @pad: the pad that emitted the signal
334 * @peer: the peer pad that has been disconnected
336 * Signals that a pad has been unlinked from the peer pad.
338 gst_pad_signals[PAD_UNLINKED] =
339 g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
340 G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
341 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
343 pspec_caps = g_param_spec_boxed ("caps", "Caps",
344 "The capabilities of the pad", GST_TYPE_CAPS,
345 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
346 g_object_class_install_property (gobject_class, PAD_PROP_CAPS, pspec_caps);
348 g_object_class_install_property (gobject_class, PAD_PROP_DIRECTION,
349 g_param_spec_enum ("direction", "Direction", "The direction of the pad",
350 GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
351 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
353 /* FIXME, Make G_PARAM_CONSTRUCT_ONLY when we fix ghostpads. */
354 g_object_class_install_property (gobject_class, PAD_PROP_TEMPLATE,
355 g_param_spec_object ("template", "Template",
356 "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
357 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
362 * The offset that will be applied to the running time of the pad.
366 g_object_class_install_property (gobject_class, PAD_PROP_OFFSET,
367 g_param_spec_int64 ("offset", "Offset",
368 "The running time offset of the pad", 0, G_MAXINT64, 0,
369 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
371 gstobject_class->path_string_separator = ".";
373 /* Register common function pointer descriptions */
374 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_activate_default);
375 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_event_default);
376 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_query_default);
377 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_iterate_internal_links_default);
378 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_chain_list_default);
382 gst_pad_init (GstPad * pad)
384 pad->priv = GST_PAD_GET_PRIVATE (pad);
386 GST_PAD_DIRECTION (pad) = GST_PAD_UNKNOWN;
388 GST_PAD_ACTIVATEFUNC (pad) = gst_pad_activate_default;
389 GST_PAD_EVENTFUNC (pad) = gst_pad_event_default;
390 GST_PAD_QUERYFUNC (pad) = gst_pad_query_default;
391 GST_PAD_ITERINTLINKFUNC (pad) = gst_pad_iterate_internal_links_default;
392 GST_PAD_CHAINLISTFUNC (pad) = gst_pad_chain_list_default;
394 GST_PAD_SET_FLUSHING (pad);
396 g_rec_mutex_init (&pad->stream_rec_lock);
398 g_cond_init (&pad->block_cond);
400 g_hook_list_init (&pad->probes, sizeof (GstProbe));
402 pad->priv->events = g_array_sized_new (FALSE, TRUE, sizeof (PadEvent), 16);
403 pad->priv->events_cookie = 0;
404 pad->priv->last_cookie = -1;
405 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
408 /* called when setting the pad inactive. It removes all sticky events from
409 * the pad. must be called with object lock */
411 remove_events (GstPad * pad)
415 gboolean notify = FALSE;
417 events = pad->priv->events;
420 for (i = 0; i < len; i++) {
421 PadEvent *ev = &g_array_index (events, PadEvent, i);
422 GstEvent *event = ev->event;
426 if (event && GST_EVENT_TYPE (event) == GST_EVENT_CAPS)
429 gst_event_unref (event);
432 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
433 g_array_set_size (events, 0);
434 pad->priv->events_cookie++;
437 GST_OBJECT_UNLOCK (pad);
439 GST_DEBUG_OBJECT (pad, "notify caps");
440 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
442 GST_OBJECT_LOCK (pad);
446 /* should be called with object lock */
448 find_event_by_type (GstPad * pad, GstEventType type, guint idx)
454 events = pad->priv->events;
457 for (i = 0; i < len; i++) {
458 ev = &g_array_index (events, PadEvent, i);
459 if (ev->event == NULL)
462 if (GST_EVENT_TYPE (ev->event) == type) {
473 /* should be called with OBJECT lock */
475 find_event (GstPad * pad, GstEvent * event)
481 events = pad->priv->events;
484 for (i = 0; i < len; i++) {
485 ev = &g_array_index (events, PadEvent, i);
486 if (event == ev->event)
494 /* should be called with OBJECT lock */
496 remove_event_by_type (GstPad * pad, GstEventType type)
502 events = pad->priv->events;
507 ev = &g_array_index (events, PadEvent, i);
508 if (ev->event == NULL)
511 if (GST_EVENT_TYPE (ev->event) != type)
514 gst_event_unref (ev->event);
515 g_array_remove_index (events, i);
517 pad->priv->events_cookie++;
525 /* check all events on srcpad against those on sinkpad. All events that are not
526 * on sinkpad are marked as received=%FALSE and the PENDING_EVENTS is set on the
527 * srcpad so that the events will be sent next time */
528 /* should be called with srcpad and sinkpad LOCKS */
530 schedule_events (GstPad * srcpad, GstPad * sinkpad)
535 gboolean pending = FALSE;
537 events = srcpad->priv->events;
540 for (i = 0; i < len; i++) {
541 ev = &g_array_index (events, PadEvent, i);
542 if (ev->event == NULL)
545 if (sinkpad == NULL || !find_event (sinkpad, ev->event)) {
546 ev->received = FALSE;
551 GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PENDING_EVENTS);
554 typedef gboolean (*PadEventFunction) (GstPad * pad, PadEvent * ev,
557 /* should be called with pad LOCK */
559 events_foreach (GstPad * pad, PadEventFunction func, gpointer user_data)
566 events = pad->priv->events;
569 cookie = pad->priv->events_cookie;
573 PadEvent *ev, ev_ret;
575 ev = &g_array_index (events, PadEvent, i);
576 if (G_UNLIKELY (ev->event == NULL))
579 /* take aditional ref, func might release the lock */
580 ev_ret.event = gst_event_ref (ev->event);
581 ev_ret.received = ev->received;
583 ret = func (pad, &ev_ret, user_data);
585 /* recheck the cookie, lock might have been released and the list could have
587 if (G_UNLIKELY (cookie != pad->priv->events_cookie)) {
588 if (G_LIKELY (ev_ret.event))
589 gst_event_unref (ev_ret.event);
593 /* store the received state */
594 ev->received = ev_ret.received;
596 /* if the event changed, we need to do something */
597 if (G_UNLIKELY (ev->event != ev_ret.event)) {
598 if (G_UNLIKELY (ev_ret.event == NULL)) {
599 /* function unreffed and set the event to NULL, remove it */
600 gst_event_unref (ev->event);
601 g_array_remove_index (events, i);
603 cookie = ++pad->priv->events_cookie;
606 /* function gave a new event for us */
607 gst_event_take (&ev->event, ev_ret.event);
610 /* just unref, nothing changed */
611 gst_event_unref (ev_ret.event);
620 /* should be called with LOCK */
622 _apply_pad_offset (GstPad * pad, GstEvent * event, gboolean upstream)
626 GST_DEBUG_OBJECT (pad, "apply pad offset %" GST_TIME_FORMAT,
627 GST_TIME_ARGS (pad->offset));
629 if (GST_EVENT_TYPE (event) == GST_EVENT_SEGMENT) {
632 g_assert (!upstream);
634 /* copy segment values */
635 gst_event_copy_segment (event, &segment);
636 gst_event_unref (event);
638 gst_segment_offset_running_time (&segment, segment.format, pad->offset);
639 event = gst_event_new_segment (&segment);
642 event = gst_event_make_writable (event);
643 offset = gst_event_get_running_time_offset (event);
645 offset -= pad->offset;
647 offset += pad->offset;
648 gst_event_set_running_time_offset (event, offset);
653 static inline GstEvent *
654 apply_pad_offset (GstPad * pad, GstEvent * event, gboolean upstream)
656 if (G_UNLIKELY (pad->offset != 0))
657 return _apply_pad_offset (pad, event, upstream);
662 /* should be called with the OBJECT_LOCK */
664 get_pad_caps (GstPad * pad)
666 GstCaps *caps = NULL;
669 ev = find_event_by_type (pad, GST_EVENT_CAPS, 0);
671 gst_event_parse_caps (ev->event, &caps);
677 gst_pad_dispose (GObject * object)
679 GstPad *pad = GST_PAD_CAST (object);
682 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pad, "dispose");
684 /* unlink the peer pad */
685 if ((peer = gst_pad_get_peer (pad))) {
686 /* window for MT unsafeness, someone else could unlink here
687 * and then we call unlink with wrong pads. The unlink
688 * function would catch this and safely return failed. */
689 if (GST_PAD_IS_SRC (pad))
690 gst_pad_unlink (pad, peer);
692 gst_pad_unlink (peer, pad);
694 gst_object_unref (peer);
697 gst_pad_set_pad_template (pad, NULL);
699 GST_OBJECT_LOCK (pad);
701 GST_OBJECT_UNLOCK (pad);
703 g_hook_list_clear (&pad->probes);
705 G_OBJECT_CLASS (parent_class)->dispose (object);
709 gst_pad_finalize (GObject * object)
711 GstPad *pad = GST_PAD_CAST (object);
714 /* in case the task is still around, clean it up */
715 if ((task = GST_PAD_TASK (pad))) {
716 gst_task_join (task);
717 GST_PAD_TASK (pad) = NULL;
718 gst_object_unref (task);
721 if (pad->activatenotify)
722 pad->activatenotify (pad->activatedata);
723 if (pad->activatemodenotify)
724 pad->activatemodenotify (pad->activatemodedata);
726 pad->linknotify (pad->linkdata);
727 if (pad->unlinknotify)
728 pad->unlinknotify (pad->unlinkdata);
729 if (pad->chainnotify)
730 pad->chainnotify (pad->chaindata);
731 if (pad->chainlistnotify)
732 pad->chainlistnotify (pad->chainlistdata);
733 if (pad->getrangenotify)
734 pad->getrangenotify (pad->getrangedata);
735 if (pad->eventnotify)
736 pad->eventnotify (pad->eventdata);
737 if (pad->querynotify)
738 pad->querynotify (pad->querydata);
739 if (pad->iterintlinknotify)
740 pad->iterintlinknotify (pad->iterintlinkdata);
742 g_rec_mutex_clear (&pad->stream_rec_lock);
743 g_cond_clear (&pad->block_cond);
744 g_array_free (pad->priv->events, TRUE);
746 G_OBJECT_CLASS (parent_class)->finalize (object);
750 gst_pad_set_property (GObject * object, guint prop_id,
751 const GValue * value, GParamSpec * pspec)
753 g_return_if_fail (GST_IS_PAD (object));
756 case PAD_PROP_DIRECTION:
757 GST_PAD_DIRECTION (object) = (GstPadDirection) g_value_get_enum (value);
759 case PAD_PROP_TEMPLATE:
760 gst_pad_set_pad_template (GST_PAD_CAST (object),
761 (GstPadTemplate *) g_value_get_object (value));
763 case PAD_PROP_OFFSET:
764 gst_pad_set_offset (GST_PAD_CAST (object), g_value_get_int64 (value));
767 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
773 gst_pad_get_property (GObject * object, guint prop_id,
774 GValue * value, GParamSpec * pspec)
776 g_return_if_fail (GST_IS_PAD (object));
780 GST_OBJECT_LOCK (object);
781 g_value_set_boxed (value, get_pad_caps (GST_PAD_CAST (object)));
782 GST_OBJECT_UNLOCK (object);
784 case PAD_PROP_DIRECTION:
785 g_value_set_enum (value, GST_PAD_DIRECTION (object));
787 case PAD_PROP_TEMPLATE:
788 g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
790 case PAD_PROP_OFFSET:
791 g_value_set_int64 (value, gst_pad_get_offset (GST_PAD_CAST (object)));
794 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
801 * @name: (allow-none): the name of the new pad.
802 * @direction: the #GstPadDirection of the pad.
804 * Creates a new pad with the given name in the given direction.
805 * If name is %NULL, a guaranteed unique name (across all pads)
807 * This function makes a copy of the name so you can safely free the name.
809 * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
815 gst_pad_new (const gchar * name, GstPadDirection direction)
817 return g_object_new (GST_TYPE_PAD,
818 "name", name, "direction", direction, NULL);
822 * gst_pad_new_from_template:
823 * @templ: the pad template to use
824 * @name: (allow-none): the name of the pad
826 * Creates a new pad with the given name from the given template.
827 * If name is %NULL, a guaranteed unique name (across all pads)
829 * This function makes a copy of the name so you can safely free the name.
831 * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
835 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
837 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
839 return g_object_new (GST_TYPE_PAD,
840 "name", name, "direction", templ->direction, "template", templ, NULL);
844 * gst_pad_new_from_static_template:
845 * @templ: the #GstStaticPadTemplate to use
846 * @name: the name of the pad
848 * Creates a new pad with the given name from the given static template.
849 * If name is %NULL, a guaranteed unique name (across all pads)
851 * This function makes a copy of the name so you can safely free the name.
853 * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
857 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
861 GstPadTemplate *template;
863 template = gst_static_pad_template_get (templ);
864 pad = gst_pad_new_from_template (template, name);
865 gst_object_unref (template);
869 #define ACQUIRE_PARENT(pad, parent, label) \
871 if (G_LIKELY ((parent = GST_OBJECT_PARENT (pad)))) \
872 gst_object_ref (parent); \
873 else if (G_LIKELY (GST_PAD_NEEDS_PARENT (pad))) \
877 #define RELEASE_PARENT(parent) \
879 if (G_LIKELY (parent)) \
880 gst_object_unref (parent); \
884 * gst_pad_get_direction:
885 * @pad: a #GstPad to get the direction of.
887 * Gets the direction of the pad. The direction of the pad is
888 * decided at construction time so this function does not take
891 * Returns: the #GstPadDirection of the pad.
896 gst_pad_get_direction (GstPad * pad)
898 GstPadDirection result;
900 /* PAD_UNKNOWN is a little silly but we need some sort of
901 * error return value */
902 g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
904 result = GST_PAD_DIRECTION (pad);
910 gst_pad_activate_default (GstPad * pad, GstObject * parent)
912 return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
916 * gst_pad_mode_get_name:
917 * @mode: the pad mode
919 * Return the name of a pad mode, for use in debug messages mostly.
921 * Returns: short mnemonic for pad mode @mode
924 gst_pad_mode_get_name (GstPadMode mode)
927 case GST_PAD_MODE_NONE:
929 case GST_PAD_MODE_PUSH:
931 case GST_PAD_MODE_PULL:
940 pre_activate (GstPad * pad, GstPadMode new_mode)
943 case GST_PAD_MODE_NONE:
944 GST_OBJECT_LOCK (pad);
945 GST_DEBUG_OBJECT (pad, "setting PAD_MODE NONE, set flushing");
946 GST_PAD_SET_FLUSHING (pad);
947 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
948 GST_PAD_MODE (pad) = new_mode;
949 /* unlock blocked pads so element can resume and stop */
950 GST_PAD_BLOCK_BROADCAST (pad);
951 GST_OBJECT_UNLOCK (pad);
953 case GST_PAD_MODE_PUSH:
954 case GST_PAD_MODE_PULL:
955 GST_OBJECT_LOCK (pad);
956 GST_DEBUG_OBJECT (pad, "setting pad into %s mode, unset flushing",
957 gst_pad_mode_get_name (new_mode));
958 GST_PAD_UNSET_FLUSHING (pad);
959 pad->ABI.abi.last_flowret = GST_FLOW_OK;
960 GST_PAD_MODE (pad) = new_mode;
961 if (GST_PAD_IS_SINK (pad)) {
963 /* make sure the peer src pad sends us all events */
964 if ((peer = GST_PAD_PEER (pad))) {
965 gst_object_ref (peer);
966 GST_OBJECT_UNLOCK (pad);
968 GST_DEBUG_OBJECT (pad, "reschedule events on peer %s:%s",
969 GST_DEBUG_PAD_NAME (peer));
971 GST_OBJECT_LOCK (peer);
972 schedule_events (peer, NULL);
973 GST_OBJECT_UNLOCK (peer);
975 gst_object_unref (peer);
977 GST_OBJECT_UNLOCK (pad);
980 GST_OBJECT_UNLOCK (pad);
987 post_activate (GstPad * pad, GstPadMode new_mode)
990 case GST_PAD_MODE_NONE:
991 /* ensures that streaming stops */
992 GST_PAD_STREAM_LOCK (pad);
993 GST_DEBUG_OBJECT (pad, "stopped streaming");
994 GST_OBJECT_LOCK (pad);
996 GST_OBJECT_UNLOCK (pad);
997 GST_PAD_STREAM_UNLOCK (pad);
999 case GST_PAD_MODE_PUSH:
1000 case GST_PAD_MODE_PULL:
1007 * gst_pad_set_active:
1008 * @pad: the #GstPad to activate or deactivate.
1009 * @active: whether or not the pad should be active.
1011 * Activates or deactivates the given pad.
1012 * Normally called from within core state change functions.
1014 * If @active, makes sure the pad is active. If it is already active, either in
1015 * push or pull mode, just return. Otherwise dispatches to the pad's activate
1016 * function to perform the actual activation.
1018 * If not @active, calls gst_pad_activate_mode() with the pad's current mode
1019 * and a %FALSE argument.
1021 * Returns: %TRUE if the operation was successful.
1026 gst_pad_set_active (GstPad * pad, gboolean active)
1030 gboolean ret = FALSE;
1032 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1034 GST_OBJECT_LOCK (pad);
1035 old = GST_PAD_MODE (pad);
1036 ACQUIRE_PARENT (pad, parent, no_parent);
1037 GST_OBJECT_UNLOCK (pad);
1040 if (old == GST_PAD_MODE_NONE) {
1041 GST_DEBUG_OBJECT (pad, "activating pad from none");
1042 ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad, parent);
1044 pad->ABI.abi.last_flowret = GST_FLOW_OK;
1046 GST_DEBUG_OBJECT (pad, "pad was active in %s mode",
1047 gst_pad_mode_get_name (old));
1051 if (old == GST_PAD_MODE_NONE) {
1052 GST_DEBUG_OBJECT (pad, "pad was inactive");
1055 GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1056 gst_pad_mode_get_name (old));
1057 ret = gst_pad_activate_mode (pad, old, FALSE);
1059 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
1063 RELEASE_PARENT (parent);
1065 if (G_UNLIKELY (!ret))
1073 GST_DEBUG_OBJECT (pad, "no parent");
1074 GST_OBJECT_UNLOCK (pad);
1079 GST_OBJECT_LOCK (pad);
1081 g_critical ("Failed to deactivate pad %s:%s, very bad",
1082 GST_DEBUG_PAD_NAME (pad));
1084 GST_WARNING_OBJECT (pad, "Failed to activate pad");
1086 GST_OBJECT_UNLOCK (pad);
1092 * gst_pad_activate_mode:
1093 * @pad: the #GstPad to activate or deactivate.
1094 * @mode: the requested activation mode
1095 * @active: whether or not the pad should be active.
1097 * Activates or deactivates the given pad in @mode via dispatching to the
1098 * pad's activatemodefunc. For use from within pad activation functions only.
1100 * If you don't know what this is, you probably don't want to call it.
1102 * Returns: %TRUE if the operation was successful.
1107 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
1109 gboolean res = FALSE;
1111 GstPadMode old, new;
1112 GstPadDirection dir;
1115 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1117 GST_OBJECT_LOCK (pad);
1118 old = GST_PAD_MODE (pad);
1119 dir = GST_PAD_DIRECTION (pad);
1120 ACQUIRE_PARENT (pad, parent, no_parent);
1121 GST_OBJECT_UNLOCK (pad);
1123 new = active ? mode : GST_PAD_MODE_NONE;
1128 if (active && old != mode && old != GST_PAD_MODE_NONE) {
1129 /* pad was activate in the wrong direction, deactivate it
1130 * and reactivate it in the requested mode */
1131 GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1132 gst_pad_mode_get_name (old));
1134 if (G_UNLIKELY (!gst_pad_activate_mode (pad, old, FALSE)))
1135 goto deactivate_failed;
1139 case GST_PAD_MODE_PULL:
1141 if (dir == GST_PAD_SINK) {
1142 if ((peer = gst_pad_get_peer (pad))) {
1143 GST_DEBUG_OBJECT (pad, "calling peer");
1144 if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
1146 gst_object_unref (peer);
1148 /* there is no peer, this is only fatal when we activate. When we
1149 * deactivate, we must assume the application has unlinked the peer and
1150 * will deactivate it eventually. */
1154 GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
1157 if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
1158 goto failure; /* Can't activate pull on a src without a
1159 getrange function */
1167 /* Mark pad as needing reconfiguration */
1169 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1170 pre_activate (pad, new);
1172 if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1173 if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1177 /* can happen for sinks of passthrough elements */
1180 post_activate (pad, new);
1182 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in %s mode",
1183 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1188 /* Clear sticky flags on deactivation */
1190 GST_OBJECT_LOCK (pad);
1191 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1192 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
1193 GST_OBJECT_UNLOCK (pad);
1197 RELEASE_PARENT (parent);
1203 GST_DEBUG_OBJECT (pad, "no parent");
1204 GST_OBJECT_UNLOCK (pad);
1209 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in %s mode",
1210 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1215 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1216 "failed to %s in switch to %s mode from %s mode",
1217 (active ? "activate" : "deactivate"), gst_pad_mode_get_name (mode),
1218 gst_pad_mode_get_name (old));
1223 GST_OBJECT_LOCK (peer);
1224 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1225 "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1226 GST_OBJECT_UNLOCK (peer);
1227 gst_object_unref (peer);
1232 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1233 "pad in pull mode");
1238 GST_OBJECT_LOCK (pad);
1239 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in %s mode",
1240 active ? "activate" : "deactivate", gst_pad_mode_get_name (mode));
1241 GST_PAD_SET_FLUSHING (pad);
1242 GST_PAD_MODE (pad) = old;
1243 GST_OBJECT_UNLOCK (pad);
1249 * gst_pad_is_active:
1250 * @pad: the #GstPad to query
1252 * Query if a pad is active
1254 * Returns: %TRUE if the pad is active.
1259 gst_pad_is_active (GstPad * pad)
1261 gboolean result = FALSE;
1263 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1265 GST_OBJECT_LOCK (pad);
1266 result = GST_PAD_IS_ACTIVE (pad);
1267 GST_OBJECT_UNLOCK (pad);
1273 cleanup_hook (GstPad * pad, GHook * hook)
1275 GstPadProbeType type;
1277 if (!G_HOOK_IS_VALID (hook))
1280 type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1282 if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1283 /* unblock when we remove the last blocking probe */
1285 GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1288 /* Might have new probes now that want to be called */
1289 GST_PAD_BLOCK_BROADCAST (pad);
1291 if (pad->num_blocked == 0) {
1292 GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1293 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1296 g_hook_destroy_link (&pad->probes, hook);
1301 * gst_pad_add_probe:
1302 * @pad: the #GstPad to add the probe to
1303 * @mask: the probe mask
1304 * @callback: #GstPadProbeCallback that will be called with notifications of
1306 * @user_data: (closure): user data passed to the callback
1307 * @destroy_data: #GDestroyNotify for user_data
1309 * Be notified of different states of pads. The provided callback is called for
1310 * every state that matches @mask.
1312 * Returns: an id or 0 if no probe is pending. The id can be used to remove the
1313 * probe with gst_pad_remove_probe(). When using GST_PAD_PROBE_TYPE_IDLE it can
1314 * happen that the probe can be run immediately and if the probe returns
1315 * GST_PAD_PROBE_REMOVE this functions returns 0.
1320 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1321 GstPadProbeCallback callback, gpointer user_data,
1322 GDestroyNotify destroy_data)
1327 g_return_val_if_fail (GST_IS_PAD (pad), 0);
1328 g_return_val_if_fail (mask != 0, 0);
1330 GST_OBJECT_LOCK (pad);
1332 /* make a new probe */
1333 hook = g_hook_alloc (&pad->probes);
1335 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1338 /* when no contraints are given for the types, assume all types are
1340 if ((mask & GST_PAD_PROBE_TYPE_ALL_BOTH) == 0)
1341 mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1342 if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1343 mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1345 /* store our flags and other fields */
1346 hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1347 hook->func = callback;
1348 hook->data = user_data;
1349 hook->destroy = destroy_data;
1350 PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1353 g_hook_prepend (&pad->probes, hook);
1355 /* incremenent cookie so that the new hook get's called */
1356 pad->priv->probe_list_cookie++;
1358 /* get the id of the hook, we return this and it can be used to remove the
1360 res = hook->hook_id;
1362 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1364 if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1365 /* we have a block probe */
1367 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1368 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1369 "now %d blocking probes", pad->num_blocked);
1371 /* Might have new probes now that want to be called */
1372 GST_PAD_BLOCK_BROADCAST (pad);
1375 /* call the callback if we need to be called for idle callbacks */
1376 if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1377 if (pad->priv->using > 0) {
1378 /* the pad is in use, we can't signal the idle callback yet. Since we set the
1379 * flag above, the last thread to leave the push will do the callback. New
1380 * threads going into the push will block. */
1381 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1382 "pad is in use, delay idle callback");
1383 GST_OBJECT_UNLOCK (pad);
1385 GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1386 GstPadProbeReturn ret;
1388 /* Keep another ref, the callback could destroy the pad */
1389 gst_object_ref (pad);
1391 /* the pad is idle now, we can signal the idle callback now */
1392 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1393 "pad is idle, trigger idle callback");
1394 GST_OBJECT_UNLOCK (pad);
1396 ret = callback (pad, &info, user_data);
1398 GST_OBJECT_LOCK (pad);
1400 case GST_PAD_PROBE_REMOVE:
1401 /* remove the probe */
1402 GST_DEBUG_OBJECT (pad, "asked to remove hook");
1403 cleanup_hook (pad, hook);
1406 case GST_PAD_PROBE_DROP:
1407 GST_DEBUG_OBJECT (pad, "asked to drop item");
1409 case GST_PAD_PROBE_PASS:
1410 GST_DEBUG_OBJECT (pad, "asked to pass item");
1412 case GST_PAD_PROBE_OK:
1413 GST_DEBUG_OBJECT (pad, "probe returned OK");
1416 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
1419 GST_OBJECT_UNLOCK (pad);
1421 gst_object_unref (pad);
1424 GST_OBJECT_UNLOCK (pad);
1430 * gst_pad_remove_probe:
1431 * @pad: the #GstPad with the probe
1432 * @id: the probe id to remove
1434 * Remove the probe with @id from @pad.
1439 gst_pad_remove_probe (GstPad * pad, gulong id)
1443 g_return_if_fail (GST_IS_PAD (pad));
1445 GST_OBJECT_LOCK (pad);
1447 hook = g_hook_get (&pad->probes, id);
1451 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1453 cleanup_hook (pad, hook);
1454 GST_OBJECT_UNLOCK (pad);
1460 GST_OBJECT_UNLOCK (pad);
1461 g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1467 * gst_pad_is_blocked:
1468 * @pad: the #GstPad to query
1470 * Checks if the pad is blocked or not. This function returns the
1471 * last requested state of the pad. It is not certain that the pad
1472 * is actually blocking at this point (see gst_pad_is_blocking()).
1474 * Returns: %TRUE if the pad is blocked.
1479 gst_pad_is_blocked (GstPad * pad)
1481 gboolean result = FALSE;
1483 g_return_val_if_fail (GST_IS_PAD (pad), result);
1485 GST_OBJECT_LOCK (pad);
1486 result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1487 GST_OBJECT_UNLOCK (pad);
1493 * gst_pad_is_blocking:
1494 * @pad: the #GstPad to query
1496 * Checks if the pad is blocking or not. This is a guaranteed state
1497 * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1499 * Returns: %TRUE if the pad is blocking.
1504 gst_pad_is_blocking (GstPad * pad)
1506 gboolean result = FALSE;
1508 g_return_val_if_fail (GST_IS_PAD (pad), result);
1510 GST_OBJECT_LOCK (pad);
1511 /* the blocking flag is only valid if the pad is not flushing */
1512 result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1513 GST_OBJECT_UNLOCK (pad);
1519 * gst_pad_needs_reconfigure:
1520 * @pad: the #GstPad to check
1522 * Check the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1523 * if the flag was set.
1525 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag is set on @pad.
1528 gst_pad_needs_reconfigure (GstPad * pad)
1530 gboolean reconfigure;
1532 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1534 GST_OBJECT_LOCK (pad);
1535 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1536 GST_DEBUG_OBJECT (pad, "peeking RECONFIGURE flag %d", reconfigure);
1537 GST_OBJECT_UNLOCK (pad);
1543 * gst_pad_check_reconfigure:
1544 * @pad: the #GstPad to check
1546 * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1547 * if the flag was set.
1549 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1552 gst_pad_check_reconfigure (GstPad * pad)
1554 gboolean reconfigure;
1556 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1558 GST_OBJECT_LOCK (pad);
1559 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1561 GST_DEBUG_OBJECT (pad, "remove RECONFIGURE flag");
1562 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1564 GST_OBJECT_UNLOCK (pad);
1570 * gst_pad_mark_reconfigure:
1571 * @pad: the #GstPad to mark
1573 * Mark a pad for needing reconfiguration. The next call to
1574 * gst_pad_check_reconfigure() will return %TRUE after this call.
1577 gst_pad_mark_reconfigure (GstPad * pad)
1579 g_return_if_fail (GST_IS_PAD (pad));
1581 GST_OBJECT_LOCK (pad);
1582 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1583 GST_OBJECT_UNLOCK (pad);
1587 * gst_pad_set_activate_function:
1589 * @f: the #GstPadActivateFunction to set.
1591 * Calls gst_pad_set_activate_function_full() with %NULL for the user_data and
1595 * gst_pad_set_activate_function_full:
1597 * @activate: the #GstPadActivateFunction to set.
1598 * @user_data: user_data passed to @notify
1599 * @notify: notify called when @activate will not be used anymore.
1601 * Sets the given activate function for @pad. The activate function will
1602 * dispatch to gst_pad_activate_mode() to perform the actual activation.
1603 * Only makes sense to set on sink pads.
1605 * Call this function if your sink pad can start a pull-based task.
1608 gst_pad_set_activate_function_full (GstPad * pad,
1609 GstPadActivateFunction activate, gpointer user_data, GDestroyNotify notify)
1611 g_return_if_fail (GST_IS_PAD (pad));
1613 if (pad->activatenotify)
1614 pad->activatenotify (pad->activatedata);
1615 GST_PAD_ACTIVATEFUNC (pad) = activate;
1616 pad->activatedata = user_data;
1617 pad->activatenotify = notify;
1619 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1620 GST_DEBUG_FUNCPTR_NAME (activate));
1624 * gst_pad_set_activatemode_function:
1626 * @f: the #GstPadActivateModeFunction to set.
1628 * Calls gst_pad_set_activatemode_function_full() with %NULL for the user_data and
1632 * gst_pad_set_activatemode_function_full:
1634 * @activatemode: the #GstPadActivateModeFunction to set.
1635 * @user_data: user_data passed to @notify
1636 * @notify: notify called when @activatemode will not be used anymore.
1638 * Sets the given activate_mode function for the pad. An activate_mode function
1639 * prepares the element for data passing.
1642 gst_pad_set_activatemode_function_full (GstPad * pad,
1643 GstPadActivateModeFunction activatemode, gpointer user_data,
1644 GDestroyNotify notify)
1646 g_return_if_fail (GST_IS_PAD (pad));
1648 if (pad->activatemodenotify)
1649 pad->activatemodenotify (pad->activatemodedata);
1650 GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1651 pad->activatemodedata = user_data;
1652 pad->activatemodenotify = notify;
1654 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1655 GST_DEBUG_FUNCPTR_NAME (activatemode));
1659 * gst_pad_set_chain_function:
1660 * @p: a sink #GstPad.
1661 * @f: the #GstPadChainFunction to set.
1663 * Calls gst_pad_set_chain_function_full() with %NULL for the user_data and
1667 * gst_pad_set_chain_function_full:
1668 * @pad: a sink #GstPad.
1669 * @chain: the #GstPadChainFunction to set.
1670 * @user_data: user_data passed to @notify
1671 * @notify: notify called when @chain will not be used anymore.
1673 * Sets the given chain function for the pad. The chain function is called to
1674 * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1677 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1678 gpointer user_data, GDestroyNotify notify)
1680 g_return_if_fail (GST_IS_PAD (pad));
1681 g_return_if_fail (GST_PAD_IS_SINK (pad));
1683 if (pad->chainnotify)
1684 pad->chainnotify (pad->chaindata);
1685 GST_PAD_CHAINFUNC (pad) = chain;
1686 pad->chaindata = user_data;
1687 pad->chainnotify = notify;
1689 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1690 GST_DEBUG_FUNCPTR_NAME (chain));
1694 * gst_pad_set_chain_list_function:
1695 * @p: a sink #GstPad.
1696 * @f: the #GstPadChainListFunction to set.
1698 * Calls gst_pad_set_chain_list_function_full() with %NULL for the user_data and
1702 * gst_pad_set_chain_list_function_full:
1703 * @pad: a sink #GstPad.
1704 * @chainlist: the #GstPadChainListFunction to set.
1705 * @user_data: user_data passed to @notify
1706 * @notify: notify called when @chainlist will not be used anymore.
1708 * Sets the given chain list function for the pad. The chainlist function is
1709 * called to process a #GstBufferList input buffer list. See
1710 * #GstPadChainListFunction for more details.
1713 gst_pad_set_chain_list_function_full (GstPad * pad,
1714 GstPadChainListFunction chainlist, gpointer user_data,
1715 GDestroyNotify notify)
1717 g_return_if_fail (GST_IS_PAD (pad));
1718 g_return_if_fail (GST_PAD_IS_SINK (pad));
1720 if (pad->chainlistnotify)
1721 pad->chainlistnotify (pad->chainlistdata);
1722 GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1723 pad->chainlistdata = user_data;
1724 pad->chainlistnotify = notify;
1726 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1727 GST_DEBUG_FUNCPTR_NAME (chainlist));
1731 * gst_pad_set_getrange_function:
1732 * @p: a source #GstPad.
1733 * @f: the #GstPadGetRangeFunction to set.
1735 * Calls gst_pad_set_getrange_function_full() with %NULL for the user_data and
1739 * gst_pad_set_getrange_function_full:
1740 * @pad: a source #GstPad.
1741 * @get: the #GstPadGetRangeFunction to set.
1742 * @user_data: user_data passed to @notify
1743 * @notify: notify called when @get will not be used anymore.
1745 * Sets the given getrange function for the pad. The getrange function is
1746 * called to produce a new #GstBuffer to start the processing pipeline. see
1747 * #GstPadGetRangeFunction for a description of the getrange function.
1750 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1751 gpointer user_data, GDestroyNotify notify)
1753 g_return_if_fail (GST_IS_PAD (pad));
1754 g_return_if_fail (GST_PAD_IS_SRC (pad));
1756 if (pad->getrangenotify)
1757 pad->getrangenotify (pad->getrangedata);
1758 GST_PAD_GETRANGEFUNC (pad) = get;
1759 pad->getrangedata = user_data;
1760 pad->getrangenotify = notify;
1762 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1763 GST_DEBUG_FUNCPTR_NAME (get));
1767 * gst_pad_set_event_function:
1768 * @p: a #GstPad of either direction.
1769 * @f: the #GstPadEventFunction to set.
1771 * Calls gst_pad_set_event_function_full() with %NULL for the user_data and
1775 * gst_pad_set_event_function_full:
1776 * @pad: a #GstPad of either direction.
1777 * @event: the #GstPadEventFunction to set.
1778 * @user_data: user_data passed to @notify
1779 * @notify: notify called when @event will not be used anymore.
1781 * Sets the given event handler for the pad.
1784 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1785 gpointer user_data, GDestroyNotify notify)
1787 g_return_if_fail (GST_IS_PAD (pad));
1789 if (pad->eventnotify)
1790 pad->eventnotify (pad->eventdata);
1791 GST_PAD_EVENTFUNC (pad) = event;
1792 pad->eventdata = user_data;
1793 pad->eventnotify = notify;
1795 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1796 GST_DEBUG_FUNCPTR_NAME (event));
1800 * gst_pad_set_query_function:
1801 * @p: a #GstPad of either direction.
1802 * @f: the #GstPadQueryFunction to set.
1804 * Calls gst_pad_set_query_function_full() with %NULL for the user_data and
1808 * gst_pad_set_query_function_full:
1809 * @pad: a #GstPad of either direction.
1810 * @query: the #GstPadQueryFunction to set.
1811 * @user_data: user_data passed to @notify
1812 * @notify: notify called when @query will not be used anymore.
1814 * Set the given query function for the pad.
1817 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1818 gpointer user_data, GDestroyNotify notify)
1820 g_return_if_fail (GST_IS_PAD (pad));
1822 if (pad->querynotify)
1823 pad->querynotify (pad->querydata);
1824 GST_PAD_QUERYFUNC (pad) = query;
1825 pad->querydata = user_data;
1826 pad->querynotify = notify;
1828 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1829 GST_DEBUG_FUNCPTR_NAME (query));
1833 * gst_pad_set_iterate_internal_links_function:
1834 * @p: a #GstPad of either direction.
1835 * @f: the #GstPadIterIntLinkFunction to set.
1837 * Calls gst_pad_set_iterate_internal_links_function_full() with %NULL
1838 * for the user_data and notify.
1841 * gst_pad_set_iterate_internal_links_function_full:
1842 * @pad: a #GstPad of either direction.
1843 * @iterintlink: the #GstPadIterIntLinkFunction to set.
1844 * @user_data: user_data passed to @notify
1845 * @notify: notify called when @iterintlink will not be used anymore.
1847 * Sets the given internal link iterator function for the pad.
1850 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1851 GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1852 GDestroyNotify notify)
1854 g_return_if_fail (GST_IS_PAD (pad));
1856 if (pad->iterintlinknotify)
1857 pad->iterintlinknotify (pad->iterintlinkdata);
1858 GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1859 pad->iterintlinkdata = user_data;
1860 pad->iterintlinknotify = notify;
1862 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1863 GST_DEBUG_FUNCPTR_NAME (iterintlink));
1867 * gst_pad_set_link_function:
1869 * @f: the #GstPadLinkFunction to set.
1871 * Calls gst_pad_set_link_function_full() with %NULL
1872 * for the user_data and notify.
1875 * gst_pad_set_link_function_full:
1877 * @link: the #GstPadLinkFunction to set.
1878 * @user_data: user_data passed to @notify
1879 * @notify: notify called when @link will not be used anymore.
1881 * Sets the given link function for the pad. It will be called when
1882 * the pad is linked with another pad.
1884 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1887 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1888 * cannot be made for some reason.
1890 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1891 * of the peer sink pad, if present.
1894 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1895 gpointer user_data, GDestroyNotify notify)
1897 g_return_if_fail (GST_IS_PAD (pad));
1899 if (pad->linknotify)
1900 pad->linknotify (pad->linkdata);
1901 GST_PAD_LINKFUNC (pad) = link;
1902 pad->linkdata = user_data;
1903 pad->linknotify = notify;
1905 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1906 GST_DEBUG_FUNCPTR_NAME (link));
1910 * gst_pad_set_unlink_function:
1912 * @f: the #GstPadUnlinkFunction to set.
1914 * Calls gst_pad_set_unlink_function_full() with %NULL
1915 * for the user_data and notify.
1918 * gst_pad_set_unlink_function_full:
1920 * @unlink: the #GstPadUnlinkFunction to set.
1921 * @user_data: user_data passed to @notify
1922 * @notify: notify called when @unlink will not be used anymore.
1924 * Sets the given unlink function for the pad. It will be called
1925 * when the pad is unlinked.
1928 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
1929 gpointer user_data, GDestroyNotify notify)
1931 g_return_if_fail (GST_IS_PAD (pad));
1933 if (pad->unlinknotify)
1934 pad->unlinknotify (pad->unlinkdata);
1935 GST_PAD_UNLINKFUNC (pad) = unlink;
1936 pad->unlinkdata = user_data;
1937 pad->unlinknotify = notify;
1939 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1940 GST_DEBUG_FUNCPTR_NAME (unlink));
1945 * @srcpad: the source #GstPad to unlink.
1946 * @sinkpad: the sink #GstPad to unlink.
1948 * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1949 * signal on both pads.
1951 * Returns: %TRUE if the pads were unlinked. This function returns %FALSE if
1952 * the pads were not linked together.
1957 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1959 gboolean result = FALSE;
1960 GstElement *parent = NULL;
1962 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1963 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1964 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1965 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1967 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1968 GST_DEBUG_PAD_NAME (srcpad), srcpad,
1969 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1971 /* We need to notify the parent before taking any pad locks as the bin in
1972 * question might be waiting for a lock on the pad while holding its lock
1973 * that our message will try to take. */
1974 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
1975 if (GST_IS_ELEMENT (parent)) {
1976 gst_element_post_message (parent,
1977 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1978 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
1980 gst_object_unref (parent);
1985 GST_OBJECT_LOCK (srcpad);
1986 GST_OBJECT_LOCK (sinkpad);
1988 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1989 goto not_linked_together;
1991 if (GST_PAD_UNLINKFUNC (srcpad)) {
1992 GstObject *tmpparent;
1994 ACQUIRE_PARENT (srcpad, tmpparent, no_src_parent);
1996 GST_PAD_UNLINKFUNC (srcpad) (srcpad, tmpparent);
1997 RELEASE_PARENT (tmpparent);
2000 if (GST_PAD_UNLINKFUNC (sinkpad)) {
2001 GstObject *tmpparent;
2003 ACQUIRE_PARENT (sinkpad, tmpparent, no_sink_parent);
2005 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad, tmpparent);
2006 RELEASE_PARENT (tmpparent);
2010 /* first clear peers */
2011 GST_PAD_PEER (srcpad) = NULL;
2012 GST_PAD_PEER (sinkpad) = NULL;
2014 GST_OBJECT_UNLOCK (sinkpad);
2015 GST_OBJECT_UNLOCK (srcpad);
2017 /* fire off a signal to each of the pads telling them
2018 * that they've been unlinked */
2019 g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
2020 g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
2022 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
2023 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2028 if (parent != NULL) {
2029 gst_element_post_message (parent,
2030 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2031 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
2032 gst_object_unref (parent);
2037 not_linked_together:
2039 /* we do not emit a warning in this case because unlinking cannot
2040 * be made MT safe.*/
2041 GST_OBJECT_UNLOCK (sinkpad);
2042 GST_OBJECT_UNLOCK (srcpad);
2048 * gst_pad_is_linked:
2049 * @pad: pad to check
2051 * Checks if a @pad is linked to another pad or not.
2053 * Returns: %TRUE if the pad is linked, %FALSE otherwise.
2058 gst_pad_is_linked (GstPad * pad)
2062 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2064 GST_OBJECT_LOCK (pad);
2065 result = (GST_PAD_PEER (pad) != NULL);
2066 GST_OBJECT_UNLOCK (pad);
2071 /* get the caps from both pads and see if the intersection
2074 * This function should be called with the pad LOCK on both
2078 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
2079 GstPadLinkCheck flags)
2081 GstCaps *srccaps = NULL;
2082 GstCaps *sinkcaps = NULL;
2083 gboolean compatible = FALSE;
2085 if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
2088 /* Doing the expensive caps checking takes priority over only checking the template caps */
2089 if (flags & GST_PAD_LINK_CHECK_CAPS) {
2090 GST_OBJECT_UNLOCK (sink);
2091 GST_OBJECT_UNLOCK (src);
2093 srccaps = gst_pad_query_caps (src, NULL);
2094 sinkcaps = gst_pad_query_caps (sink, NULL);
2096 GST_OBJECT_LOCK (src);
2097 GST_OBJECT_LOCK (sink);
2099 /* If one of the two pads doesn't have a template, consider the intersection
2101 if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
2102 || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
2106 srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
2108 gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
2111 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
2113 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
2116 /* if we have caps on both pads we can check the intersection. If one
2117 * of the caps is %NULL, we return %TRUE. */
2118 if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
2120 gst_caps_unref (srccaps);
2122 gst_caps_unref (sinkcaps);
2126 compatible = gst_caps_can_intersect (srccaps, sinkcaps);
2127 gst_caps_unref (srccaps);
2128 gst_caps_unref (sinkcaps);
2131 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
2132 (compatible ? "" : "not "));
2137 /* check if the grandparents of both pads are the same.
2138 * This check is required so that we don't try to link
2139 * pads from elements in different bins without ghostpads.
2141 * The LOCK should be held on both pads
2144 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
2146 GstObject *psrc, *psink;
2148 psrc = GST_OBJECT_PARENT (src);
2149 psink = GST_OBJECT_PARENT (sink);
2151 /* if one of the pads has no parent, we allow the link */
2152 if (G_UNLIKELY (psrc == NULL || psink == NULL))
2155 /* only care about parents that are elements */
2156 if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
2157 goto no_element_parent;
2159 /* if the parents are the same, we have a loop */
2160 if (G_UNLIKELY (psrc == psink))
2163 /* if they both have a parent, we check the grandparents. We can not lock
2164 * the parent because we hold on the child (pad) and the locking order is
2165 * parent >> child. */
2166 psrc = GST_OBJECT_PARENT (psrc);
2167 psink = GST_OBJECT_PARENT (psink);
2169 /* if they have grandparents but they are not the same */
2170 if (G_UNLIKELY (psrc != psink))
2171 goto wrong_grandparents;
2178 GST_CAT_DEBUG (GST_CAT_CAPS,
2179 "one of the pads has no parent %" GST_PTR_FORMAT " and %"
2180 GST_PTR_FORMAT, psrc, psink);
2185 GST_CAT_DEBUG (GST_CAT_CAPS,
2186 "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
2187 GST_PTR_FORMAT, psrc, psink);
2192 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
2198 GST_CAT_DEBUG (GST_CAT_CAPS,
2199 "pads have different grandparents %" GST_PTR_FORMAT " and %"
2200 GST_PTR_FORMAT, psrc, psink);
2205 /* FIXME leftover from an attempt at refactoring... */
2206 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
2207 * the two pads will be locked in the srcpad, sinkpad order. */
2208 static GstPadLinkReturn
2209 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2211 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2212 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2214 GST_OBJECT_LOCK (srcpad);
2216 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
2217 goto src_was_linked;
2219 GST_OBJECT_LOCK (sinkpad);
2221 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
2222 goto sink_was_linked;
2224 /* check hierarchy, pads can only be linked if the grandparents
2226 if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
2227 && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
2228 goto wrong_hierarchy;
2230 /* check pad caps for non-empty intersection */
2231 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
2234 /* FIXME check pad scheduling for non-empty intersection */
2236 return GST_PAD_LINK_OK;
2240 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
2241 GST_DEBUG_PAD_NAME (srcpad),
2242 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
2243 /* we do not emit a warning in this case because unlinking cannot
2244 * be made MT safe.*/
2245 GST_OBJECT_UNLOCK (srcpad);
2246 return GST_PAD_LINK_WAS_LINKED;
2250 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
2251 GST_DEBUG_PAD_NAME (sinkpad),
2252 GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
2253 /* we do not emit a warning in this case because unlinking cannot
2254 * be made MT safe.*/
2255 GST_OBJECT_UNLOCK (sinkpad);
2256 GST_OBJECT_UNLOCK (srcpad);
2257 return GST_PAD_LINK_WAS_LINKED;
2261 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
2262 GST_OBJECT_UNLOCK (sinkpad);
2263 GST_OBJECT_UNLOCK (srcpad);
2264 return GST_PAD_LINK_WRONG_HIERARCHY;
2268 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
2269 GST_OBJECT_UNLOCK (sinkpad);
2270 GST_OBJECT_UNLOCK (srcpad);
2271 return GST_PAD_LINK_NOFORMAT;
2277 * @srcpad: the source #GstPad.
2278 * @sinkpad: the sink #GstPad.
2280 * Checks if the source pad and the sink pad are compatible so they can be
2283 * Returns: %TRUE if the pads can be linked.
2286 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2288 GstPadLinkReturn result;
2290 /* generic checks */
2291 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2292 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2294 GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
2295 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2297 /* gst_pad_link_prepare does everything for us, we only release the locks
2298 * on the pads that it gets us. If this function returns !OK the locks are not
2300 result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2301 if (result != GST_PAD_LINK_OK)
2304 GST_OBJECT_UNLOCK (srcpad);
2305 GST_OBJECT_UNLOCK (sinkpad);
2308 return result == GST_PAD_LINK_OK;
2312 * gst_pad_link_full:
2313 * @srcpad: the source #GstPad to link.
2314 * @sinkpad: the sink #GstPad to link.
2315 * @flags: the checks to validate when linking
2317 * Links the source pad and the sink pad.
2319 * This variant of #gst_pad_link provides a more granular control on the
2320 * checks being done when linking. While providing some considerable speedups
2321 * the caller of this method must be aware that wrong usage of those flags
2322 * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
2323 * for more information.
2327 * Returns: A result code indicating if the connection worked or
2331 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2333 GstPadLinkReturn result;
2335 GstPadLinkFunction srcfunc, sinkfunc;
2337 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2338 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2339 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2340 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2341 GST_PAD_LINK_WRONG_DIRECTION);
2343 /* Notify the parent early. See gst_pad_unlink for details. */
2344 if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2345 if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2346 gst_element_post_message (parent,
2347 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2348 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2350 gst_object_unref (parent);
2355 /* prepare will also lock the two pads */
2356 result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2358 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2361 /* must set peers before calling the link function */
2362 GST_PAD_PEER (srcpad) = sinkpad;
2363 GST_PAD_PEER (sinkpad) = srcpad;
2365 /* check events, when something is different, mark pending */
2366 schedule_events (srcpad, sinkpad);
2368 /* get the link functions */
2369 srcfunc = GST_PAD_LINKFUNC (srcpad);
2370 sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2372 if (G_UNLIKELY (srcfunc || sinkfunc)) {
2373 /* custom link functions, execute them */
2374 GST_OBJECT_UNLOCK (sinkpad);
2375 GST_OBJECT_UNLOCK (srcpad);
2378 GstObject *tmpparent;
2380 ACQUIRE_PARENT (srcpad, tmpparent, no_parent);
2381 /* this one will call the peer link function */
2382 result = srcfunc (srcpad, tmpparent, sinkpad);
2383 RELEASE_PARENT (tmpparent);
2384 } else if (sinkfunc) {
2385 GstObject *tmpparent;
2387 ACQUIRE_PARENT (sinkpad, tmpparent, no_parent);
2388 /* if no source link function, we need to call the sink link
2389 * function ourselves. */
2390 result = sinkfunc (sinkpad, tmpparent, srcpad);
2391 RELEASE_PARENT (tmpparent);
2395 GST_OBJECT_LOCK (srcpad);
2396 GST_OBJECT_LOCK (sinkpad);
2398 /* we released the lock, check if the same pads are linked still */
2399 if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2400 goto concurrent_link;
2402 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2405 GST_OBJECT_UNLOCK (sinkpad);
2406 GST_OBJECT_UNLOCK (srcpad);
2408 /* fire off a signal to each of the pads telling them
2409 * that they've been linked */
2410 g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2411 g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2413 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2414 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2416 gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2419 if (G_LIKELY (parent)) {
2420 gst_element_post_message (parent,
2421 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2422 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2423 gst_object_unref (parent);
2431 GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2432 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2433 GST_OBJECT_UNLOCK (sinkpad);
2434 GST_OBJECT_UNLOCK (srcpad);
2436 /* The other link operation succeeded first */
2437 result = GST_PAD_LINK_WAS_LINKED;
2442 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed: %s",
2443 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad),
2444 gst_pad_link_get_name (result));
2446 GST_PAD_PEER (srcpad) = NULL;
2447 GST_PAD_PEER (sinkpad) = NULL;
2449 GST_OBJECT_UNLOCK (sinkpad);
2450 GST_OBJECT_UNLOCK (srcpad);
2458 * @srcpad: the source #GstPad to link.
2459 * @sinkpad: the sink #GstPad to link.
2461 * Links the source pad and the sink pad.
2463 * Returns: A result code indicating if the connection worked or
2469 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2471 return gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2475 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2477 GstPadTemplate **template_p;
2479 /* this function would need checks if it weren't static */
2481 GST_OBJECT_LOCK (pad);
2482 template_p = &pad->padtemplate;
2483 gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2484 GST_OBJECT_UNLOCK (pad);
2487 gst_pad_template_pad_created (templ, pad);
2491 * gst_pad_get_pad_template:
2494 * Gets the template for @pad.
2496 * Returns: (transfer full) (nullable): the #GstPadTemplate from which
2497 * this pad was instantiated, or %NULL if this pad has no
2498 * template. Unref after usage.
2501 gst_pad_get_pad_template (GstPad * pad)
2503 GstPadTemplate *templ;
2505 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2507 templ = GST_PAD_PAD_TEMPLATE (pad);
2509 return (templ ? gst_object_ref (templ) : NULL);
2513 * gst_pad_has_current_caps:
2514 * @pad: a #GstPad to check
2516 * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2518 * Returns: %TRUE when @pad has caps associated with it.
2521 gst_pad_has_current_caps (GstPad * pad)
2526 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2528 GST_OBJECT_LOCK (pad);
2529 caps = get_pad_caps (pad);
2530 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2531 "check current pad caps %" GST_PTR_FORMAT, caps);
2532 result = (caps != NULL);
2533 GST_OBJECT_UNLOCK (pad);
2539 * gst_pad_get_current_caps:
2540 * @pad: a #GstPad to get the current capabilities of.
2542 * Gets the capabilities currently configured on @pad with the last
2543 * #GST_EVENT_CAPS event.
2545 * Returns: the current caps of the pad with incremented ref-count.
2548 gst_pad_get_current_caps (GstPad * pad)
2552 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2554 GST_OBJECT_LOCK (pad);
2555 if ((result = get_pad_caps (pad)))
2556 gst_caps_ref (result);
2557 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2558 "get current pad caps %" GST_PTR_FORMAT, result);
2559 GST_OBJECT_UNLOCK (pad);
2565 * gst_pad_get_pad_template_caps:
2566 * @pad: a #GstPad to get the template capabilities from.
2568 * Gets the capabilities for @pad's template.
2570 * Returns: (transfer full): the #GstCaps of this pad template.
2571 * Unref after usage.
2574 gst_pad_get_pad_template_caps (GstPad * pad)
2576 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2578 if (GST_PAD_PAD_TEMPLATE (pad))
2579 return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2581 return gst_caps_ref (GST_CAPS_ANY);
2586 * @pad: a #GstPad to get the peer of.
2588 * Gets the peer of @pad. This function refs the peer pad so
2589 * you need to unref it after use.
2591 * Returns: (transfer full): the peer #GstPad. Unref after usage.
2596 gst_pad_get_peer (GstPad * pad)
2600 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2602 GST_OBJECT_LOCK (pad);
2603 result = GST_PAD_PEER (pad);
2605 gst_object_ref (result);
2606 GST_OBJECT_UNLOCK (pad);
2612 * gst_pad_get_allowed_caps:
2615 * Gets the capabilities of the allowed media types that can flow through
2616 * @pad and its peer.
2618 * The allowed capabilities is calculated as the intersection of the results of
2619 * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2620 * on the resulting caps.
2622 * Returns: (transfer full) (nullable): the allowed #GstCaps of the
2623 * pad link. Unref the caps when you no longer need it. This
2624 * function returns %NULL when @pad has no peer.
2629 gst_pad_get_allowed_caps (GstPad * pad)
2635 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2637 GST_OBJECT_LOCK (pad);
2638 peer = GST_PAD_PEER (pad);
2639 if (G_UNLIKELY (peer == NULL))
2642 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2644 gst_object_ref (peer);
2645 GST_OBJECT_UNLOCK (pad);
2646 mycaps = gst_pad_query_caps (pad, NULL);
2648 caps = gst_pad_query_caps (peer, mycaps);
2649 gst_object_unref (peer);
2651 gst_caps_unref (mycaps);
2653 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2660 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2661 GST_OBJECT_UNLOCK (pad);
2668 * gst_pad_iterate_internal_links_default:
2669 * @pad: the #GstPad to get the internal links of.
2670 * @parent: (allow-none): the parent of @pad or %NULL
2672 * Iterate the list of pads to which the given pad is linked to inside of
2673 * the parent element.
2674 * This is the default handler, and thus returns an iterator of all of the
2675 * pads inside the parent element with opposite direction.
2677 * The caller must free this iterator after use with gst_iterator_free().
2679 * Returns: (nullable): a #GstIterator of #GstPad, or %NULL if @pad
2680 * has no parent. Unref each returned pad with gst_object_unref().
2683 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2690 GstElement *eparent;
2692 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2694 if (parent != NULL && GST_IS_ELEMENT (parent)) {
2695 eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2697 GST_OBJECT_LOCK (pad);
2698 eparent = GST_PAD_PARENT (pad);
2699 if (!eparent || !GST_IS_ELEMENT (eparent))
2702 gst_object_ref (eparent);
2703 GST_OBJECT_UNLOCK (pad);
2706 if (pad->direction == GST_PAD_SRC)
2707 padlist = &eparent->sinkpads;
2709 padlist = &eparent->srcpads;
2711 GST_DEBUG_OBJECT (pad, "Making iterator");
2713 cookie = &eparent->pads_cookie;
2715 lock = GST_OBJECT_GET_LOCK (eparent);
2717 res = gst_iterator_new_list (GST_TYPE_PAD,
2718 lock, cookie, padlist, (GObject *) owner, NULL);
2720 gst_object_unref (owner);
2727 GST_OBJECT_UNLOCK (pad);
2728 GST_DEBUG_OBJECT (pad, "no parent element");
2734 * gst_pad_iterate_internal_links:
2735 * @pad: the GstPad to get the internal links of.
2737 * Gets an iterator for the pads to which the given pad is linked to inside
2738 * of the parent element.
2740 * Each #GstPad element yielded by the iterator will have its refcount increased,
2741 * so unref after use.
2743 * Free-function: gst_iterator_free
2745 * Returns: (transfer full) (nullable): a new #GstIterator of #GstPad
2746 * or %NULL when the pad does not have an iterator function
2747 * configured. Use gst_iterator_free() after usage.
2750 gst_pad_iterate_internal_links (GstPad * pad)
2752 GstIterator *res = NULL;
2755 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2757 GST_OBJECT_LOCK (pad);
2758 ACQUIRE_PARENT (pad, parent, no_parent);
2759 GST_OBJECT_UNLOCK (pad);
2761 if (GST_PAD_ITERINTLINKFUNC (pad))
2762 res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2764 RELEASE_PARENT (parent);
2771 GST_DEBUG_OBJECT (pad, "no parent");
2772 GST_OBJECT_UNLOCK (pad);
2780 * @forward: (scope call): a #GstPadForwardFunction
2781 * @user_data: user data passed to @forward
2783 * Calls @forward for all internally linked pads of @pad. This function deals with
2784 * dynamically changing internal pads and will make sure that the @forward
2785 * function is only called once for each pad.
2787 * When @forward returns %TRUE, no further pads will be processed.
2789 * Returns: %TRUE if one of the dispatcher functions returned %TRUE.
2792 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2795 gboolean result = FALSE;
2797 gboolean done = FALSE;
2798 GValue item = { 0, };
2799 GList *pushed_pads = NULL;
2801 iter = gst_pad_iterate_internal_links (pad);
2807 switch (gst_iterator_next (iter, &item)) {
2808 case GST_ITERATOR_OK:
2812 intpad = g_value_get_object (&item);
2814 /* if already pushed, skip. FIXME, find something faster to tag pads */
2815 if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2816 g_value_reset (&item);
2820 GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2821 GST_DEBUG_PAD_NAME (intpad));
2822 done = result = forward (intpad, user_data);
2824 pushed_pads = g_list_prepend (pushed_pads, intpad);
2826 g_value_reset (&item);
2829 case GST_ITERATOR_RESYNC:
2830 /* We don't reset the result here because we don't push the event
2831 * again on pads that got the event already and because we need
2832 * to consider the result of the previous pushes */
2833 gst_iterator_resync (iter);
2835 case GST_ITERATOR_ERROR:
2836 GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2839 case GST_ITERATOR_DONE:
2844 g_value_unset (&item);
2845 gst_iterator_free (iter);
2847 g_list_free (pushed_pads);
2857 gboolean dispatched;
2861 event_forward_func (GstPad * pad, EventData * data)
2863 /* for each pad we send to, we should ref the event; it's up
2864 * to downstream to unref again when handled. */
2865 GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2866 data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2868 data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2870 data->dispatched = TRUE;
2877 * gst_pad_event_default:
2878 * @pad: a #GstPad to call the default event handler on.
2879 * @parent: (allow-none): the parent of @pad or %NULL
2880 * @event: (transfer full): the #GstEvent to handle.
2882 * Invokes the default event handler for the given pad.
2884 * The EOS event will pause the task associated with @pad before it is forwarded
2885 * to all internally linked pads,
2887 * The the event is sent to all pads internally linked to @pad. This function
2888 * takes ownership of @event.
2890 * Returns: %TRUE if the event was sent successfully.
2893 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2895 gboolean result, forward = TRUE;
2897 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2898 g_return_val_if_fail (event != NULL, FALSE);
2900 GST_LOG_OBJECT (pad, "default event handler for event %" GST_PTR_FORMAT,
2903 switch (GST_EVENT_TYPE (event)) {
2904 case GST_EVENT_CAPS:
2905 forward = GST_PAD_IS_PROXY_CAPS (pad);
2916 data.dispatched = FALSE;
2917 data.result = FALSE;
2919 gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
2921 /* for sinkpads without a parent element or without internal links, nothing
2922 * will be dispatched but we still want to return TRUE. */
2923 if (data.dispatched)
2924 result = data.result;
2929 gst_event_unref (event);
2934 /* Default accept caps implementation just checks against
2935 * the allowed caps for the pad */
2937 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
2939 /* get the caps and see if it intersects to something not empty */
2940 GstCaps *caps, *allowed;
2943 GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
2945 /* first forward the query to internally linked pads when we are dealing with
2947 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2948 if ((result = gst_pad_proxy_query_accept_caps (pad, query))) {
2953 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
2954 "fallback ACCEPT_CAPS query, consider implementing a specialized version");
2956 gst_query_parse_accept_caps (query, &caps);
2957 allowed = gst_pad_query_caps (pad, caps);
2960 if (GST_PAD_IS_ACCEPT_INTERSECT (pad)) {
2961 GST_DEBUG_OBJECT (pad,
2962 "allowed caps intersect %" GST_PTR_FORMAT ", caps %" GST_PTR_FORMAT,
2964 result = gst_caps_can_intersect (caps, allowed);
2966 GST_DEBUG_OBJECT (pad, "allowed caps subset %" GST_PTR_FORMAT ", caps %"
2967 GST_PTR_FORMAT, allowed, caps);
2968 result = gst_caps_is_subset (caps, allowed);
2970 gst_caps_unref (allowed);
2972 GST_DEBUG_OBJECT (pad, "no compatible caps allowed on the pad");
2975 gst_query_set_accept_caps_result (query, result);
2981 /* Default caps implementation */
2983 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
2985 GstCaps *result = NULL, *filter;
2986 GstPadTemplate *templ;
2987 gboolean fixed_caps;
2989 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "query caps %" GST_PTR_FORMAT,
2992 /* first try to proxy if we must */
2993 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2994 if ((gst_pad_proxy_query_caps (pad, query))) {
2999 gst_query_parse_caps (query, &filter);
3001 /* no proxy or it failed, do default handling */
3002 fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
3004 GST_OBJECT_LOCK (pad);
3006 /* fixed caps, try the negotiated caps first */
3007 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
3008 if ((result = get_pad_caps (pad)))
3009 goto filter_done_unlock;
3012 if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
3013 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
3014 if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
3015 goto filter_done_unlock;
3019 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3020 "non-fixed pad caps: trying pad caps");
3021 /* non fixed caps, try the negotiated caps */
3022 if ((result = get_pad_caps (pad)))
3023 goto filter_done_unlock;
3026 /* this almost never happens */
3027 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
3028 result = GST_CAPS_ANY;
3031 GST_OBJECT_UNLOCK (pad);
3033 /* run the filter on the result */
3035 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3036 "using caps %p %" GST_PTR_FORMAT " with filter %p %"
3037 GST_PTR_FORMAT, result, result, filter, filter);
3038 result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
3039 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
3042 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
3043 "using caps %p %" GST_PTR_FORMAT, result, result);
3044 result = gst_caps_ref (result);
3046 gst_query_set_caps_result (query, result);
3047 gst_caps_unref (result);
3053 /* Default latency implementation */
3057 GstClockTime min, max;
3061 query_latency_default_fold (const GValue * item, GValue * ret,
3064 GstPad *pad = g_value_get_object (item);
3065 LatencyFoldData *fold_data = user_data;
3069 query = gst_query_new_latency ();
3070 res = gst_pad_peer_query (pad, query);
3074 GstClockTime min, max;
3076 gst_query_parse_latency (query, &live, &min, &max);
3078 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3079 " max:%" G_GINT64_FORMAT, live ? "true" : "false", min, max);
3082 if (min > fold_data->min)
3083 fold_data->min = min;
3085 if (fold_data->max == GST_CLOCK_TIME_NONE)
3086 fold_data->max = max;
3087 else if (max < fold_data->max)
3088 fold_data->max = max;
3090 fold_data->live = TRUE;
3093 GST_DEBUG_OBJECT (pad, "latency query failed");
3094 g_value_set_boolean (ret, FALSE);
3096 gst_query_unref (query);
3102 gst_pad_query_latency_default (GstPad * pad, GstQuery * query)
3105 GstIteratorResult res;
3106 GValue ret = G_VALUE_INIT;
3108 LatencyFoldData fold_data;
3110 it = gst_pad_iterate_internal_links (pad);
3112 GST_DEBUG_OBJECT (pad, "Can't iterate internal links");
3116 g_value_init (&ret, G_TYPE_BOOLEAN);
3119 fold_data.live = FALSE;
3121 fold_data.max = GST_CLOCK_TIME_NONE;
3123 g_value_set_boolean (&ret, TRUE);
3124 res = gst_iterator_fold (it, query_latency_default_fold, &ret, &fold_data);
3126 case GST_ITERATOR_OK:
3127 g_assert_not_reached ();
3129 case GST_ITERATOR_DONE:
3131 case GST_ITERATOR_ERROR:
3132 g_value_set_boolean (&ret, FALSE);
3134 case GST_ITERATOR_RESYNC:
3135 gst_iterator_resync (it);
3138 g_assert_not_reached ();
3141 gst_iterator_free (it);
3143 query_ret = g_value_get_boolean (&ret);
3145 GST_LOG_OBJECT (pad, "got latency live:%s min:%" G_GINT64_FORMAT
3146 " max:%" G_GINT64_FORMAT, fold_data.live ? "true" : "false",
3147 fold_data.min, fold_data.max);
3149 if (fold_data.min > fold_data.max) {
3150 GST_ERROR_OBJECT (pad, "minimum latency bigger than maximum latency");
3153 gst_query_set_latency (query, fold_data.live, fold_data.min, fold_data.max);
3155 GST_LOG_OBJECT (pad, "latency query failed");
3165 gboolean dispatched;
3169 query_forward_func (GstPad * pad, QueryData * data)
3171 GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
3172 data->query, GST_QUERY_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
3174 data->result |= gst_pad_peer_query (pad, data->query);
3176 data->dispatched = TRUE;
3178 /* stop on first successful reply */
3179 return data->result;
3183 * gst_pad_query_default:
3184 * @pad: a #GstPad to call the default query handler on.
3185 * @parent: (allow-none): the parent of @pad or %NULL
3186 * @query: (transfer none): the #GstQuery to handle.
3188 * Invokes the default query handler for the given pad.
3189 * The query is sent to all pads internally linked to @pad. Note that
3190 * if there are many possible sink pads that are internally linked to
3191 * @pad, only one will be sent the query.
3192 * Multi-sinkpad elements should implement custom query handlers.
3194 * Returns: %TRUE if the query was performed successfully.
3197 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
3199 gboolean forward, ret = FALSE;
3201 switch (GST_QUERY_TYPE (query)) {
3202 case GST_QUERY_SCHEDULING:
3203 forward = GST_PAD_IS_PROXY_SCHEDULING (pad);
3205 case GST_QUERY_ALLOCATION:
3206 forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
3208 case GST_QUERY_ACCEPT_CAPS:
3209 ret = gst_pad_query_accept_caps_default (pad, query);
3212 case GST_QUERY_CAPS:
3213 ret = gst_pad_query_caps_default (pad, query);
3216 case GST_QUERY_LATENCY:
3217 ret = gst_pad_query_latency_default (pad, query);
3220 case GST_QUERY_POSITION:
3221 case GST_QUERY_SEEKING:
3222 case GST_QUERY_FORMATS:
3223 case GST_QUERY_JITTER:
3224 case GST_QUERY_RATE:
3225 case GST_QUERY_CONVERT:
3231 GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
3232 query, GST_QUERY_TYPE_NAME (query));
3238 data.dispatched = FALSE;
3239 data.result = FALSE;
3241 gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
3243 if (data.dispatched) {
3246 /* nothing dispatched, assume drained */
3247 if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
3257 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
3259 GstPad *pad = data->pad;
3260 GstPadProbeInfo *info = data->info;
3261 GstPadProbeType type, flags;
3262 GstPadProbeCallback callback;
3263 GstPadProbeReturn ret;
3265 /* if we have called this callback, do nothing */
3266 if (PROBE_COOKIE (hook) == data->cookie) {
3267 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3268 "hook %lu, cookie %u already called", hook->hook_id,
3269 PROBE_COOKIE (hook));
3273 PROBE_COOKIE (hook) = data->cookie;
3275 flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
3278 /* one of the data types for non-idle probes */
3279 if ((type & GST_PAD_PROBE_TYPE_IDLE) == 0
3280 && (flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
3282 /* one of the scheduling types */
3283 if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
3285 /* one of the blocking types must match */
3286 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
3287 (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
3289 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) == 0 &&
3290 (flags & GST_PAD_PROBE_TYPE_BLOCKING))
3292 /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
3293 if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
3294 (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
3297 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3298 "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
3299 PROBE_COOKIE (hook), flags);
3301 data->marshalled = TRUE;
3303 callback = (GstPadProbeCallback) hook->func;
3304 if (callback == NULL)
3307 info->id = hook->hook_id;
3309 GST_OBJECT_UNLOCK (pad);
3311 ret = callback (pad, info, hook->data);
3313 GST_OBJECT_LOCK (pad);
3316 case GST_PAD_PROBE_REMOVE:
3317 /* remove the probe */
3318 GST_DEBUG_OBJECT (pad, "asked to remove hook");
3319 cleanup_hook (pad, hook);
3321 case GST_PAD_PROBE_DROP:
3322 /* need to drop the data, make sure other probes don't get called
3324 GST_DEBUG_OBJECT (pad, "asked to drop item");
3325 info->type = GST_PAD_PROBE_TYPE_INVALID;
3326 data->dropped = TRUE;
3328 case GST_PAD_PROBE_PASS:
3329 /* inform the pad block to let things pass */
3330 GST_DEBUG_OBJECT (pad, "asked to pass item");
3333 case GST_PAD_PROBE_OK:
3334 GST_DEBUG_OBJECT (pad, "probe returned OK");
3337 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
3344 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3345 "hook %lu, cookie %u with flags 0x%08x does not match %08x",
3346 hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
3351 /* a probe that does not take or return any data */
3352 #define PROBE_NO_DATA(pad,mask,label,defaultval) \
3354 if (G_UNLIKELY (pad->num_probes)) { \
3355 GstFlowReturn pval = defaultval; \
3356 /* pass NULL as the data item */ \
3357 GstPadProbeInfo info = { mask, 0, NULL, 0, 0 }; \
3358 ret = do_probe_callbacks (pad, &info, defaultval); \
3359 if (G_UNLIKELY (ret != pval && ret != GST_FLOW_OK)) \
3364 #define PROBE_FULL(pad,mask,data,offs,size,label) \
3366 if (G_UNLIKELY (pad->num_probes)) { \
3367 /* pass the data item */ \
3368 GstPadProbeInfo info = { mask, 0, data, offs, size }; \
3369 ret = do_probe_callbacks (pad, &info, GST_FLOW_OK); \
3370 /* store the possibly updated data item */ \
3371 data = GST_PAD_PROBE_INFO_DATA (&info); \
3372 /* if something went wrong, exit */ \
3373 if (G_UNLIKELY (ret != GST_FLOW_OK)) \
3378 #define PROBE_PUSH(pad,mask,data,label) \
3379 PROBE_FULL(pad, mask, data, -1, -1, label);
3380 #define PROBE_PULL(pad,mask,data,offs,size,label) \
3381 PROBE_FULL(pad, mask, data, offs, size, label);
3383 static GstFlowReturn
3384 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3385 GstFlowReturn defaultval)
3394 data.marshalled = FALSE;
3395 data.dropped = FALSE;
3396 data.cookie = ++pad->priv->probe_cookie;
3399 (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3402 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3403 "do probes cookie %u", data.cookie);
3404 cookie = pad->priv->probe_list_cookie;
3406 g_hook_list_marshal (&pad->probes, TRUE,
3407 (GHookMarshaller) probe_hook_marshal, &data);
3409 /* if the list changed, call the new callbacks (they will not have their
3410 * cookie set to data.cookie */
3411 if (cookie != pad->priv->probe_list_cookie) {
3412 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3413 "probe list changed, restarting");
3417 /* the first item that dropped will stop the hooks and then we drop here */
3421 /* if no handler matched and we are blocking, let the item pass */
3422 if (!data.marshalled && is_block)
3425 /* At this point, all handlers returned either OK or PASS. If one handler
3426 * returned PASS, let the item pass */
3431 while (GST_PAD_IS_BLOCKED (pad)) {
3432 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3433 "we are blocked %d times", pad->num_blocked);
3435 /* we might have released the lock */
3436 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3439 /* now we block the streaming thread. It can be unlocked when we
3440 * deactivate the pad (which will also set the FLUSHING flag) or
3441 * when the pad is unblocked. A flushing event will also unblock
3442 * the pad after setting the FLUSHING flag. */
3443 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3444 "Waiting to be unblocked or set flushing");
3445 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3446 GST_PAD_BLOCK_WAIT (pad);
3447 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3448 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3450 /* if the list changed, call the new callbacks (they will not have their
3451 * cookie set to data.cookie */
3452 if (cookie != pad->priv->probe_list_cookie) {
3453 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3454 "probe list changed, restarting");
3458 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3468 GST_DEBUG_OBJECT (pad, "pad is flushing");
3469 return GST_FLOW_FLUSHING;
3473 GST_DEBUG_OBJECT (pad, "data is dropped");
3474 return GST_FLOW_CUSTOM_SUCCESS;
3478 /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3479 GST_DEBUG_OBJECT (pad, "data is passed");
3487 * gst_pad_get_offset:
3490 * Get the offset applied to the running time of @pad. @pad has to be a source
3493 * Returns: the offset.
3496 gst_pad_get_offset (GstPad * pad)
3500 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3502 GST_OBJECT_LOCK (pad);
3503 result = pad->offset;
3504 GST_OBJECT_UNLOCK (pad);
3510 mark_event_not_received (GstPad * pad, PadEvent * ev, gpointer user_data)
3512 ev->received = FALSE;
3517 * gst_pad_set_offset:
3519 * @offset: the offset
3521 * Set the offset that will be applied to the running time of @pad.
3524 gst_pad_set_offset (GstPad * pad, gint64 offset)
3526 g_return_if_fail (GST_IS_PAD (pad));
3528 GST_OBJECT_LOCK (pad);
3529 /* if nothing changed, do nothing */
3530 if (pad->offset == offset)
3533 pad->offset = offset;
3534 GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3536 /* resend all sticky events with updated offset on next buffer push */
3537 events_foreach (pad, mark_event_not_received, NULL);
3538 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3541 GST_OBJECT_UNLOCK (pad);
3548 /* If TRUE and ret is not OK this means
3549 * that pushing the EOS event failed
3553 /* If called for an event this is
3554 * the event that would be pushed
3555 * next. Don't forward sticky events
3556 * that would come after that */
3560 /* should be called with pad LOCK */
3562 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3564 PushStickyData *data = user_data;
3565 GstEvent *event = ev->event;
3568 GST_DEBUG_OBJECT (pad, "event %s was already received",
3569 GST_EVENT_TYPE_NAME (event));
3573 /* If we're called because of an sticky event, only forward
3574 * events that would come before this new event and the
3576 if (data->event && GST_EVENT_IS_STICKY (data->event) &&
3577 GST_EVENT_TYPE (data->event) <= GST_EVENT_SEGMENT &&
3578 GST_EVENT_TYPE (data->event) < GST_EVENT_TYPE (event)) {
3579 data->ret = GST_FLOW_CUSTOM_SUCCESS_1;
3581 data->ret = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3582 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3585 switch (data->ret) {
3587 ev->received = TRUE;
3588 GST_DEBUG_OBJECT (pad, "event %s marked received",
3589 GST_EVENT_TYPE_NAME (event));
3591 case GST_FLOW_CUSTOM_SUCCESS:
3592 /* we can't assume the event is received when it was dropped */
3593 GST_DEBUG_OBJECT (pad, "event %s was dropped, mark pending",
3594 GST_EVENT_TYPE_NAME (event));
3595 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3596 data->ret = GST_FLOW_OK;
3598 case GST_FLOW_CUSTOM_SUCCESS_1:
3599 /* event was ignored and should be sent later */
3600 GST_DEBUG_OBJECT (pad, "event %s was ignored, mark pending",
3601 GST_EVENT_TYPE_NAME (event));
3602 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3603 data->ret = GST_FLOW_OK;
3605 case GST_FLOW_NOT_LINKED:
3606 /* not linked is not a problem, we are sticky so the event will be
3607 * sent later but only for non-EOS events */
3608 GST_DEBUG_OBJECT (pad, "pad was not linked, mark pending");
3609 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
3610 data->ret = GST_FLOW_OK;
3611 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3614 GST_DEBUG_OBJECT (pad, "result %s, mark pending events",
3615 gst_flow_get_name (data->ret));
3616 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3620 if (data->ret != GST_FLOW_OK && GST_EVENT_TYPE (event) == GST_EVENT_EOS)
3621 data->was_eos = TRUE;
3623 return data->ret == GST_FLOW_OK;
3626 /* check sticky events and push them when needed. should be called
3628 static inline GstFlowReturn
3629 check_sticky (GstPad * pad, GstEvent * event)
3631 PushStickyData data = { GST_FLOW_OK, FALSE, event };
3633 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3634 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3636 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3637 events_foreach (pad, push_sticky, &data);
3639 /* If there's an EOS event we must push it downstream
3640 * even if sending a previous sticky event failed.
3641 * Otherwise the pipeline might wait forever for EOS.
3643 * Only do this if pushing another event than the EOS
3646 if (data.ret != GST_FLOW_OK && !data.was_eos) {
3647 PadEvent *ev = find_event_by_type (pad, GST_EVENT_EOS, 0);
3649 if (ev && !ev->received) {
3650 data.ret = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3651 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3652 /* the event could have been dropped. Because this can only
3653 * happen if the user asked for it, it's not an error */
3654 if (data.ret == GST_FLOW_CUSTOM_SUCCESS)
3655 data.ret = GST_FLOW_OK;
3665 * @pad: a #GstPad to invoke the default query on.
3666 * @query: (transfer none): the #GstQuery to perform.
3668 * Dispatches a query to a pad. The query should have been allocated by the
3669 * caller via one of the type-specific allocation functions. The element that
3670 * the pad belongs to is responsible for filling the query with an appropriate
3671 * response, which should then be parsed with a type-specific query parsing
3674 * Again, the caller is responsible for both the allocation and deallocation of
3675 * the query structure.
3677 * Please also note that some queries might need a running pipeline to work.
3679 * Returns: %TRUE if the query could be performed.
3682 gst_pad_query (GstPad * pad, GstQuery * query)
3685 gboolean res, serialized;
3686 GstPadQueryFunction func;
3687 GstPadProbeType type;
3690 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3691 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3693 if (GST_PAD_IS_SRC (pad)) {
3694 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3695 goto wrong_direction;
3696 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3697 } else if (GST_PAD_IS_SINK (pad)) {
3698 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3699 goto wrong_direction;
3700 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3702 goto unknown_direction;
3704 GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3705 GST_QUERY_TYPE_NAME (query));
3707 serialized = GST_QUERY_IS_SERIALIZED (query);
3708 if (G_UNLIKELY (serialized))
3709 GST_PAD_STREAM_LOCK (pad);
3711 GST_OBJECT_LOCK (pad);
3712 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3713 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3714 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3716 ACQUIRE_PARENT (pad, parent, no_parent);
3717 GST_OBJECT_UNLOCK (pad);
3719 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3722 res = func (pad, parent, query);
3724 RELEASE_PARENT (parent);
3726 GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3727 GST_QUERY_TYPE_NAME (query), res);
3732 GST_OBJECT_LOCK (pad);
3733 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3734 GST_OBJECT_UNLOCK (pad);
3736 if (G_UNLIKELY (serialized))
3737 GST_PAD_STREAM_UNLOCK (pad);
3744 g_warning ("pad %s:%s query %s in wrong direction",
3745 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3750 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3755 GST_DEBUG_OBJECT (pad, "had no parent");
3756 GST_OBJECT_UNLOCK (pad);
3757 if (G_UNLIKELY (serialized))
3758 GST_PAD_STREAM_UNLOCK (pad);
3763 GST_DEBUG_OBJECT (pad, "had no query function");
3764 RELEASE_PARENT (parent);
3765 if (G_UNLIKELY (serialized))
3766 GST_PAD_STREAM_UNLOCK (pad);
3771 GST_DEBUG_OBJECT (pad, "query failed");
3772 if (G_UNLIKELY (serialized))
3773 GST_PAD_STREAM_UNLOCK (pad);
3778 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3779 GST_OBJECT_UNLOCK (pad);
3780 if (G_UNLIKELY (serialized))
3781 GST_PAD_STREAM_UNLOCK (pad);
3783 /* if a probe dropped, we don't sent it further but assume that the probe
3784 * did not answer the query and return FALSE */
3792 * gst_pad_peer_query:
3793 * @pad: a #GstPad to invoke the peer query on.
3794 * @query: (transfer none): the #GstQuery to perform.
3796 * Performs gst_pad_query() on the peer of @pad.
3798 * The caller is responsible for both the allocation and deallocation of
3799 * the query structure.
3801 * Returns: %TRUE if the query could be performed. This function returns %FALSE
3802 * if @pad has no peer.
3805 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3808 GstPadProbeType type;
3809 gboolean res, serialized;
3812 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3813 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3815 if (GST_PAD_IS_SRC (pad)) {
3816 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3817 goto wrong_direction;
3818 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3819 } else if (GST_PAD_IS_SINK (pad)) {
3820 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3821 goto wrong_direction;
3822 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3824 goto unknown_direction;
3826 GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
3827 GST_QUERY_TYPE_NAME (query));
3829 serialized = GST_QUERY_IS_SERIALIZED (query);
3831 GST_OBJECT_LOCK (pad);
3832 if (GST_PAD_IS_SRC (pad) && serialized) {
3833 /* all serialized queries on the srcpad trigger push of
3835 if (check_sticky (pad, NULL) != GST_FLOW_OK)
3839 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3840 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3841 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3843 peerpad = GST_PAD_PEER (pad);
3844 if (G_UNLIKELY (peerpad == NULL))
3847 gst_object_ref (peerpad);
3848 GST_OBJECT_UNLOCK (pad);
3850 res = gst_pad_query (peerpad, query);
3852 gst_object_unref (peerpad);
3857 GST_OBJECT_LOCK (pad);
3858 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3859 GST_OBJECT_UNLOCK (pad);
3866 g_warning ("pad %s:%s query %s in wrong direction",
3867 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3872 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3877 GST_WARNING_OBJECT (pad, "could not send sticky events");
3878 GST_OBJECT_UNLOCK (pad);
3883 GST_INFO_OBJECT (pad, "pad has no peer");
3884 GST_OBJECT_UNLOCK (pad);
3889 GST_DEBUG_OBJECT (pad, "query failed");
3894 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3895 GST_OBJECT_UNLOCK (pad);
3897 /* if a probe dropped, we don't sent it further but assume that the probe
3898 * did not answer the query and return FALSE */
3905 /**********************************************************************
3906 * Data passing functions
3909 /* this is the chain function that does not perform the additional argument
3910 * checking for that little extra speed.
3912 static inline GstFlowReturn
3913 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
3918 GST_PAD_STREAM_LOCK (pad);
3920 GST_OBJECT_LOCK (pad);
3921 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3924 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
3927 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3930 #ifndef G_DISABLE_ASSERT
3931 if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
3932 if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
3934 ":%s:<%s:%s> Got data flow before stream-start event",
3935 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
3937 if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
3939 ":%s:<%s:%s> Got data flow before segment event",
3940 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
3942 pad->priv->last_cookie = pad->priv->events_cookie;
3946 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3948 PROBE_PUSH (pad, type, data, probe_stopped);
3950 parent = GST_OBJECT_PARENT (pad);
3951 GST_OBJECT_UNLOCK (pad);
3953 /* NOTE: we read the chainfunc unlocked.
3954 * we cannot hold the lock for the pad so we might send
3955 * the data to the wrong function. This is not really a
3956 * problem since functions are assigned at creation time
3957 * and don't change that often... */
3958 if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
3959 GstPadChainFunction chainfunc;
3961 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3964 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3965 "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
3966 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
3968 ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
3970 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3971 "called chainfunction &%s with buffer %p, returned %s",
3972 GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
3974 GstPadChainListFunction chainlistfunc;
3976 if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
3979 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3980 "calling chainlistfunction &%s",
3981 GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
3983 ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
3985 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3986 "called chainlistfunction &%s, returned %s",
3987 GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
3990 GST_PAD_STREAM_UNLOCK (pad);
3997 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3998 "chaining, but pad was flushing");
3999 GST_OBJECT_UNLOCK (pad);
4000 GST_PAD_STREAM_UNLOCK (pad);
4001 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4002 return GST_FLOW_FLUSHING;
4006 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "chaining, but pad was EOS");
4007 GST_OBJECT_UNLOCK (pad);
4008 GST_PAD_STREAM_UNLOCK (pad);
4009 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4010 return GST_FLOW_EOS;
4014 g_critical ("chain on pad %s:%s but it was not in push mode",
4015 GST_DEBUG_PAD_NAME (pad));
4016 GST_OBJECT_UNLOCK (pad);
4017 GST_PAD_STREAM_UNLOCK (pad);
4018 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4019 return GST_FLOW_ERROR;
4023 GST_OBJECT_UNLOCK (pad);
4024 GST_PAD_STREAM_UNLOCK (pad);
4025 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4028 case GST_FLOW_CUSTOM_SUCCESS:
4029 GST_DEBUG_OBJECT (pad, "dropped buffer");
4033 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4040 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4041 g_critical ("chain on pad %s:%s but it has no chainfunction",
4042 GST_DEBUG_PAD_NAME (pad));
4043 GST_PAD_STREAM_UNLOCK (pad);
4044 return GST_FLOW_NOT_SUPPORTED;
4050 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4051 * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
4054 * Chain a buffer to @pad.
4056 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4058 * If the buffer type is not acceptable for @pad (as negotiated with a
4059 * preceding GST_EVENT_CAPS event), this function returns
4060 * #GST_FLOW_NOT_NEGOTIATED.
4062 * The function proceeds calling the chain function installed on @pad (see
4063 * gst_pad_set_chain_function()) and the return value of that function is
4064 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4067 * In all cases, success or failure, the caller loses its reference to @buffer
4068 * after calling this function.
4070 * Returns: a #GstFlowReturn from the pad.
4075 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
4077 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4078 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4079 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4081 return gst_pad_chain_data_unchecked (pad,
4082 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4085 static GstFlowReturn
4086 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
4087 GstBufferList * list)
4093 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
4095 len = gst_buffer_list_length (list);
4098 for (i = 0; i < len; i++) {
4099 buffer = gst_buffer_list_get (list, i);
4101 gst_pad_chain_data_unchecked (pad,
4102 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
4103 gst_buffer_ref (buffer));
4104 if (ret != GST_FLOW_OK)
4107 gst_buffer_list_unref (list);
4113 * gst_pad_chain_list:
4114 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4115 * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
4118 * Chain a bufferlist to @pad.
4120 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
4122 * If @pad was not negotiated properly with a CAPS event, this function
4123 * returns #GST_FLOW_NOT_NEGOTIATED.
4125 * The function proceeds calling the chainlist function installed on @pad (see
4126 * gst_pad_set_chain_list_function()) and the return value of that function is
4127 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
4128 * chainlist function.
4130 * In all cases, success or failure, the caller loses its reference to @list
4131 * after calling this function.
4135 * Returns: a #GstFlowReturn from the pad.
4138 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
4140 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4141 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4142 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4144 return gst_pad_chain_data_unchecked (pad,
4145 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4148 static GstFlowReturn
4149 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
4154 GST_OBJECT_LOCK (pad);
4155 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4158 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4161 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
4164 #ifndef G_DISABLE_ASSERT
4165 if (G_UNLIKELY (pad->priv->last_cookie != pad->priv->events_cookie)) {
4166 if (!find_event_by_type (pad, GST_EVENT_STREAM_START, 0)) {
4168 ":%s:<%s:%s> Got data flow before stream-start event",
4169 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4171 if (!find_event_by_type (pad, GST_EVENT_SEGMENT, 0)) {
4173 ":%s:<%s:%s> Got data flow before segment event",
4174 G_STRFUNC, GST_DEBUG_PAD_NAME (pad));
4176 pad->priv->last_cookie = pad->priv->events_cookie;
4180 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4183 /* do block probes */
4184 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
4186 /* recheck sticky events because the probe might have cause a relink */
4187 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4190 /* do post-blocking probes */
4191 PROBE_PUSH (pad, type, data, probe_stopped);
4193 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4196 /* take ref to peer pad before releasing the lock */
4197 gst_object_ref (peer);
4199 GST_OBJECT_UNLOCK (pad);
4201 ret = gst_pad_chain_data_unchecked (peer, type, data);
4203 gst_object_unref (peer);
4205 GST_OBJECT_LOCK (pad);
4206 pad->ABI.abi.last_flowret = ret;
4208 if (pad->priv->using == 0) {
4209 /* pad is not active anymore, trigger idle callbacks */
4210 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4211 probe_stopped, ret);
4213 GST_OBJECT_UNLOCK (pad);
4217 /* ERROR recovery here */
4221 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4222 "pushing, but pad was flushing");
4223 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4224 GST_OBJECT_UNLOCK (pad);
4225 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4226 return GST_FLOW_FLUSHING;
4230 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pushing, but pad was EOS");
4231 pad->ABI.abi.last_flowret = GST_FLOW_EOS;
4232 GST_OBJECT_UNLOCK (pad);
4233 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4234 return GST_FLOW_EOS;
4238 g_critical ("pushing on pad %s:%s but it was not activated in push mode",
4239 GST_DEBUG_PAD_NAME (pad));
4240 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4241 GST_OBJECT_UNLOCK (pad);
4242 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4243 return GST_FLOW_ERROR;
4247 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4248 "error pushing events, return %s", gst_flow_get_name (ret));
4249 pad->ABI.abi.last_flowret = ret;
4250 GST_OBJECT_UNLOCK (pad);
4251 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4256 GST_OBJECT_UNLOCK (pad);
4257 pad->ABI.abi.last_flowret =
4258 ret == GST_FLOW_CUSTOM_SUCCESS ? GST_FLOW_OK : ret;
4259 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4262 case GST_FLOW_CUSTOM_SUCCESS:
4263 GST_DEBUG_OBJECT (pad, "dropped buffer");
4267 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
4274 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4275 "pushing, but it was not linked");
4276 pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4277 GST_OBJECT_UNLOCK (pad);
4278 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
4279 return GST_FLOW_NOT_LINKED;
4285 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4286 * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
4289 * Pushes a buffer to the peer of @pad.
4291 * This function will call installed block probes before triggering any
4292 * installed data probes.
4294 * The function proceeds calling gst_pad_chain() on the peer pad and returns
4295 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4298 * In all cases, success or failure, the caller loses its reference to @buffer
4299 * after calling this function.
4301 * Returns: a #GstFlowReturn from the peer pad.
4306 gst_pad_push (GstPad * pad, GstBuffer * buffer)
4308 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4309 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4310 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
4312 return gst_pad_push_data (pad,
4313 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
4317 * gst_pad_push_list:
4318 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
4319 * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
4322 * Pushes a buffer list to the peer of @pad.
4324 * This function will call installed block probes before triggering any
4325 * installed data probes.
4327 * The function proceeds calling the chain function on the peer pad and returns
4328 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
4329 * be returned. If the peer pad does not have any installed chainlist function
4330 * every group buffer of the list will be merged into a normal #GstBuffer and
4331 * chained via gst_pad_chain().
4333 * In all cases, success or failure, the caller loses its reference to @list
4334 * after calling this function.
4336 * Returns: a #GstFlowReturn from the peer pad.
4341 gst_pad_push_list (GstPad * pad, GstBufferList * list)
4343 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4344 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4345 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
4347 return gst_pad_push_data (pad,
4348 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
4351 static GstFlowReturn
4352 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
4353 GstBuffer ** buffer)
4356 GstPadGetRangeFunction getrangefunc;
4360 GST_PAD_STREAM_LOCK (pad);
4362 GST_OBJECT_LOCK (pad);
4363 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4366 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4369 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4374 /* when one of the probes returns DROPPED, probe_stopped will be called
4375 * and we skip calling the getrange function, res_buf should then contain a
4376 * valid result buffer */
4377 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4378 res_buf, offset, size, probe_stopped);
4380 /* recheck sticky events because the probe might have cause a relink */
4381 if (G_UNLIKELY ((ret = check_sticky (pad, NULL))) != GST_FLOW_OK)
4384 ACQUIRE_PARENT (pad, parent, no_parent);
4385 GST_OBJECT_UNLOCK (pad);
4387 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
4390 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4391 "calling getrangefunc %s, offset %"
4392 G_GUINT64_FORMAT ", size %u",
4393 GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
4395 ret = getrangefunc (pad, parent, offset, size, &res_buf);
4397 RELEASE_PARENT (parent);
4399 GST_OBJECT_LOCK (pad);
4400 if (G_UNLIKELY (ret != GST_FLOW_OK))
4401 goto get_range_failed;
4403 /* can only fire the signal if we have a valid buffer */
4405 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4406 res_buf, offset, size, probe_stopped_unref);
4407 pad->ABI.abi.last_flowret = ret;
4408 GST_OBJECT_UNLOCK (pad);
4410 GST_PAD_STREAM_UNLOCK (pad);
4419 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4420 "getrange, but pad was flushing");
4421 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4422 GST_OBJECT_UNLOCK (pad);
4423 GST_PAD_STREAM_UNLOCK (pad);
4424 return GST_FLOW_FLUSHING;
4428 g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
4429 GST_DEBUG_PAD_NAME (pad));
4430 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4431 GST_OBJECT_UNLOCK (pad);
4432 GST_PAD_STREAM_UNLOCK (pad);
4433 return GST_FLOW_ERROR;
4437 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
4438 pad->ABI.abi.last_flowret = ret;
4439 GST_OBJECT_UNLOCK (pad);
4440 GST_PAD_STREAM_UNLOCK (pad);
4445 GST_DEBUG_OBJECT (pad, "no parent");
4446 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4447 GST_OBJECT_UNLOCK (pad);
4448 GST_PAD_STREAM_UNLOCK (pad);
4449 return GST_FLOW_FLUSHING;
4453 g_critical ("getrange on pad %s:%s but it has no getrangefunction",
4454 GST_DEBUG_PAD_NAME (pad));
4455 RELEASE_PARENT (parent);
4456 GST_PAD_STREAM_UNLOCK (pad);
4457 return GST_FLOW_NOT_SUPPORTED;
4461 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4462 "probe returned %s", gst_flow_get_name (ret));
4463 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4465 /* the probe filled the buffer and asks us to not call the getrange
4466 * anymore, we continue with the post probes then. */
4467 GST_DEBUG_OBJECT (pad, "handled buffer");
4471 /* no buffer, we are EOS */
4472 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4476 pad->ABI.abi.last_flowret = ret;
4477 GST_OBJECT_UNLOCK (pad);
4478 GST_PAD_STREAM_UNLOCK (pad);
4482 probe_stopped_unref:
4484 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4485 "probe returned %s", gst_flow_get_name (ret));
4486 /* if we drop here, it signals EOS */
4487 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4489 pad->ABI.abi.last_flowret = ret;
4490 GST_OBJECT_UNLOCK (pad);
4491 GST_PAD_STREAM_UNLOCK (pad);
4492 if (*buffer == NULL)
4493 gst_buffer_unref (res_buf);
4498 pad->ABI.abi.last_flowret = ret;
4499 GST_OBJECT_UNLOCK (pad);
4500 GST_PAD_STREAM_UNLOCK (pad);
4501 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4502 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4503 pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
4509 * gst_pad_get_range:
4510 * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4511 * @offset: The start offset of the buffer
4512 * @size: The length of the buffer
4513 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
4514 * returns #GST_FLOW_ERROR if %NULL.
4516 * When @pad is flushing this function returns #GST_FLOW_FLUSHING
4517 * immediately and @buffer is %NULL.
4519 * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4520 * description of a getrange function. If @pad has no getrange function
4521 * installed (see gst_pad_set_getrange_function()) this function returns
4522 * #GST_FLOW_NOT_SUPPORTED.
4524 * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4525 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4526 * must be freed with gst_buffer_unref() after usage.
4528 * When @buffer points to a variable that points to a valid #GstBuffer, the
4529 * buffer will be filled with the result data when this function returns
4530 * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4531 * @size bytes will be filled in the result buffer and its size will be updated
4534 * Note that less than @size bytes can be returned in @buffer when, for example,
4535 * an EOS condition is near or when @buffer is not large enough to hold @size
4536 * bytes. The caller should check the result buffer size to get the result size.
4538 * When this function returns any other result value than #GST_FLOW_OK, @buffer
4539 * will be unchanged.
4541 * This is a lowlevel function. Usually gst_pad_pull_range() is used.
4543 * Returns: a #GstFlowReturn from the pad.
4548 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4549 GstBuffer ** buffer)
4551 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4552 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4553 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4554 g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4555 && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4557 return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4561 * gst_pad_pull_range:
4562 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4563 * @offset: The start offset of the buffer
4564 * @size: The length of the buffer
4565 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4566 * GST_FLOW_ERROR if %NULL.
4568 * Pulls a @buffer from the peer pad or fills up a provided buffer.
4570 * This function will first trigger the pad block signal if it was
4573 * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4574 * function returns the result of gst_pad_get_range() on the peer pad.
4575 * See gst_pad_get_range() for a list of return values and for the
4576 * semantics of the arguments of this function.
4578 * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be
4579 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4580 * must be freed with gst_buffer_unref() after usage. When this function
4581 * returns any other result value, @buffer will still point to %NULL.
4583 * When @buffer points to a variable that points to a valid #GstBuffer, the
4584 * buffer will be filled with the result data when this function returns
4585 * #GST_FLOW_OK. When this function returns any other result value,
4586 * @buffer will be unchanged. If the provided buffer is larger than @size, only
4587 * @size bytes will be filled in the result buffer and its size will be updated
4590 * Note that less than @size bytes can be returned in @buffer when, for example,
4591 * an EOS condition is near or when @buffer is not large enough to hold @size
4592 * bytes. The caller should check the result buffer size to get the result size.
4594 * Returns: a #GstFlowReturn from the peer pad.
4599 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4600 GstBuffer ** buffer)
4606 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4607 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4608 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4609 g_return_val_if_fail (*buffer == NULL || (GST_IS_BUFFER (*buffer)
4610 && gst_buffer_get_size (*buffer) >= size), GST_FLOW_ERROR);
4612 GST_OBJECT_LOCK (pad);
4613 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4616 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4621 /* when one of the probes returns DROPPED, probe_stopped will be
4622 * called and we skip calling the peer getrange function. *buffer should then
4623 * contain a valid buffer */
4624 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4625 res_buf, offset, size, probe_stopped);
4627 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4630 gst_object_ref (peer);
4632 GST_OBJECT_UNLOCK (pad);
4634 ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4636 gst_object_unref (peer);
4638 GST_OBJECT_LOCK (pad);
4640 pad->ABI.abi.last_flowret = ret;
4641 if (pad->priv->using == 0) {
4642 /* pad is not active anymore, trigger idle callbacks */
4643 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4644 probe_stopped_unref, ret);
4647 if (G_UNLIKELY (ret != GST_FLOW_OK))
4648 goto pull_range_failed;
4651 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4652 res_buf, offset, size, probe_stopped_unref);
4654 GST_OBJECT_UNLOCK (pad);
4660 /* ERROR recovery here */
4663 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4664 "pullrange, but pad was flushing");
4665 pad->ABI.abi.last_flowret = GST_FLOW_FLUSHING;
4666 GST_OBJECT_UNLOCK (pad);
4667 return GST_FLOW_FLUSHING;
4671 g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4672 GST_DEBUG_PAD_NAME (pad));
4673 pad->ABI.abi.last_flowret = GST_FLOW_ERROR;
4674 GST_OBJECT_UNLOCK (pad);
4675 return GST_FLOW_ERROR;
4679 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4680 gst_flow_get_name (ret));
4681 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4683 /* the probe filled the buffer and asks us to not forward to the peer
4684 * anymore, we continue with the post probes then */
4685 GST_DEBUG_OBJECT (pad, "handled buffer");
4689 /* no buffer, we are EOS then */
4690 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4694 pad->ABI.abi.last_flowret = ret;
4695 GST_OBJECT_UNLOCK (pad);
4700 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4701 "pulling range, but it was not linked");
4702 pad->ABI.abi.last_flowret = GST_FLOW_NOT_LINKED;
4703 GST_OBJECT_UNLOCK (pad);
4704 return GST_FLOW_NOT_LINKED;
4708 pad->ABI.abi.last_flowret = ret;
4709 GST_OBJECT_UNLOCK (pad);
4710 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4711 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4712 pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4715 probe_stopped_unref:
4717 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4718 "post probe returned %s", gst_flow_get_name (ret));
4720 /* if we drop here, it signals EOS */
4721 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4724 pad->ABI.abi.last_flowret = ret;
4725 GST_OBJECT_UNLOCK (pad);
4727 if (*buffer == NULL)
4728 gst_buffer_unref (res_buf);
4733 /* must be called with pad object lock */
4734 static GstFlowReturn
4735 store_sticky_event (GstPad * pad, GstEvent * event)
4740 gboolean res = FALSE;
4741 const gchar *name = NULL;
4742 gboolean insert = TRUE;
4744 type = GST_EVENT_TYPE (event);
4746 /* Store all sticky events except SEGMENT/EOS when we're flushing,
4747 * otherwise they can be dropped and nothing would ever resend them.
4748 * Only do that for activated pads though, everything else is a bug!
4750 if (G_UNLIKELY (GST_PAD_MODE (pad) == GST_PAD_MODE_NONE
4751 || (GST_PAD_IS_FLUSHING (pad) && (type == GST_EVENT_SEGMENT
4752 || type == GST_EVENT_EOS))))
4755 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4758 if (type & GST_EVENT_TYPE_STICKY_MULTI)
4759 name = gst_structure_get_name (gst_event_get_structure (event));
4761 events = pad->priv->events;
4764 for (i = 0; i < len; i++) {
4765 PadEvent *ev = &g_array_index (events, PadEvent, i);
4767 if (ev->event == NULL)
4770 if (type == GST_EVENT_TYPE (ev->event)) {
4771 /* matching types, check matching name if needed */
4772 if (name && !gst_event_has_name (ev->event, name))
4776 if ((res = gst_event_replace (&ev->event, event)))
4777 ev->received = FALSE;
4783 if (type < GST_EVENT_TYPE (ev->event) || (type != GST_EVENT_TYPE (ev->event)
4784 && GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS)) {
4785 /* STREAM_START, CAPS and SEGMENT must be delivered in this order. By
4786 * storing the sticky ordered we can check that this is respected. */
4787 if (G_UNLIKELY (GST_EVENT_TYPE (ev->event) <= GST_EVENT_SEGMENT
4788 || GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS))
4790 ":%s:<%s:%s> Sticky event misordering, got '%s' before '%s'",
4791 G_STRFUNC, GST_DEBUG_PAD_NAME (pad),
4792 gst_event_type_get_name (GST_EVENT_TYPE (ev->event)),
4793 gst_event_type_get_name (type));
4799 ev.event = gst_event_ref (event);
4800 ev.received = FALSE;
4801 g_array_insert_val (events, i, ev);
4806 pad->priv->events_cookie++;
4807 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4809 GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
4811 switch (GST_EVENT_TYPE (event)) {
4812 case GST_EVENT_CAPS:
4813 GST_OBJECT_UNLOCK (pad);
4815 GST_DEBUG_OBJECT (pad, "notify caps");
4816 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
4818 GST_OBJECT_LOCK (pad);
4824 if (type == GST_EVENT_EOS) {
4825 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
4826 pad->ABI.abi.last_flowret = GST_FLOW_EOS;
4829 return GST_PAD_IS_FLUSHING (pad) ? GST_FLOW_FLUSHING : GST_FLOW_OK;
4834 GST_DEBUG_OBJECT (pad, "pad is flushing");
4835 return GST_FLOW_FLUSHING;
4839 GST_DEBUG_OBJECT (pad, "pad is EOS");
4840 return GST_FLOW_EOS;
4845 * gst_pad_store_sticky_event:
4847 * @event: a #GstEvent
4849 * Store the sticky @event on @pad
4851 * Returns: #GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad
4852 * was flushing or #GST_FLOW_EOS when the pad was EOS.
4857 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event)
4861 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4862 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4864 GST_OBJECT_LOCK (pad);
4865 ret = store_sticky_event (pad, event);
4866 GST_OBJECT_UNLOCK (pad);
4872 sticky_changed (GstPad * pad, PadEvent * ev, gpointer user_data)
4874 PushStickyData *data = user_data;
4876 /* Forward all sticky events before our current one that are pending */
4877 if (ev->event != data->event
4878 && GST_EVENT_TYPE (ev->event) < GST_EVENT_TYPE (data->event))
4879 return push_sticky (pad, ev, data);
4884 /* should be called with pad LOCK */
4885 static GstFlowReturn
4886 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
4887 GstPadProbeType type)
4891 GstEventType event_type;
4893 /* pass the adjusted event on. We need to do this even if
4894 * there is no peer pad because of the probes. */
4895 event = apply_pad_offset (pad, event, GST_PAD_IS_SINK (pad));
4897 /* Two checks to be made:
4898 * . (un)set the FLUSHING flag for flushing events,
4899 * . handle pad blocking */
4900 event_type = GST_EVENT_TYPE (event);
4901 switch (event_type) {
4902 case GST_EVENT_FLUSH_START:
4903 GST_PAD_SET_FLUSHING (pad);
4905 GST_PAD_BLOCK_BROADCAST (pad);
4906 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4908 case GST_EVENT_FLUSH_STOP:
4909 if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
4912 GST_PAD_UNSET_FLUSHING (pad);
4914 /* Remove sticky EOS events */
4915 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4916 remove_event_by_type (pad, GST_EVENT_EOS);
4917 remove_event_by_type (pad, GST_EVENT_SEGMENT);
4918 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
4919 pad->ABI.abi.last_flowret = GST_FLOW_OK;
4921 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4925 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4928 /* No need to check for EOS here as either the caller (gst_pad_push_event())
4929 * checked already or this is called as part of pushing sticky events,
4930 * in which case we still want to forward the EOS event downstream.
4933 switch (GST_EVENT_TYPE (event)) {
4934 case GST_EVENT_RECONFIGURE:
4935 if (GST_PAD_IS_SINK (pad))
4936 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4941 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4942 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4947 /* send probes after modifying the events above */
4948 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4950 /* recheck sticky events because the probe might have cause a relink */
4951 if (GST_PAD_HAS_PENDING_EVENTS (pad) && GST_PAD_IS_SRC (pad)
4952 && (GST_EVENT_IS_SERIALIZED (event)
4953 || GST_EVENT_IS_STICKY (event))) {
4954 PushStickyData data = { GST_FLOW_OK, FALSE, event };
4955 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4957 /* Push all sticky events before our current one
4958 * that have changed */
4959 events_foreach (pad, sticky_changed, &data);
4962 /* now check the peer pad */
4963 peerpad = GST_PAD_PEER (pad);
4964 if (peerpad == NULL)
4967 gst_object_ref (peerpad);
4969 GST_OBJECT_UNLOCK (pad);
4971 GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
4972 event, gst_event_type_get_name (event_type), peerpad);
4974 ret = gst_pad_send_event_unchecked (peerpad, event, type);
4976 /* Note: we gave away ownership of the event at this point but we can still
4977 * print the old pointer */
4978 GST_LOG_OBJECT (pad,
4979 "sent event %p (%s) to peerpad %" GST_PTR_FORMAT ", ret %s", event,
4980 gst_event_type_get_name (event_type), peerpad, gst_flow_get_name (ret));
4982 gst_object_unref (peerpad);
4984 GST_OBJECT_LOCK (pad);
4986 if (pad->priv->using == 0) {
4987 /* pad is not active anymore, trigger idle callbacks */
4988 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4989 idle_probe_stopped, ret);
4993 /* ERROR handling */
4996 GST_DEBUG_OBJECT (pad, "We're flushing");
4997 gst_event_unref (event);
4998 return GST_FLOW_FLUSHING;
5002 GST_DEBUG_OBJECT (pad, "flush-stop on inactive pad");
5003 gst_event_unref (event);
5004 return GST_FLOW_FLUSHING;
5008 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5009 gst_event_unref (event);
5012 case GST_FLOW_CUSTOM_SUCCESS:
5013 GST_DEBUG_OBJECT (pad, "dropped event");
5016 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5023 GST_DEBUG_OBJECT (pad, "Dropping event %s because pad is not linked",
5024 gst_event_type_get_name (GST_EVENT_TYPE (event)));
5025 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
5026 gst_event_unref (event);
5028 /* unlinked pads should not influence latency configuration */
5029 if (event_type == GST_EVENT_LATENCY)
5032 return GST_FLOW_NOT_LINKED;
5036 GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
5042 * gst_pad_push_event:
5043 * @pad: a #GstPad to push the event to.
5044 * @event: (transfer full): the #GstEvent to send to the pad.
5046 * Sends the event to the peer of the given pad. This function is
5047 * mainly used by elements to send events to their peer
5050 * This function takes ownership of the provided event so you should
5051 * gst_event_ref() it if you want to reuse the event after this call.
5053 * Returns: %TRUE if the event was handled.
5058 gst_pad_push_event (GstPad * pad, GstEvent * event)
5060 gboolean res = FALSE;
5061 GstPadProbeType type;
5062 gboolean sticky, serialized;
5064 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5065 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
5067 if (GST_PAD_IS_SRC (pad)) {
5068 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5069 goto wrong_direction;
5070 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5071 } else if (GST_PAD_IS_SINK (pad)) {
5072 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5073 goto wrong_direction;
5074 /* events pushed on sinkpad never are sticky */
5075 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5077 goto unknown_direction;
5079 GST_OBJECT_LOCK (pad);
5080 sticky = GST_EVENT_IS_STICKY (event);
5081 serialized = GST_EVENT_IS_SERIALIZED (event);
5084 /* srcpad sticky events are stored immediately, the received flag is set
5085 * to FALSE and will be set to TRUE when we can successfully push the
5086 * event to the peer pad */
5087 switch (store_sticky_event (pad, event)) {
5088 case GST_FLOW_FLUSHING:
5096 if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
5097 /* all serialized or sticky events on the srcpad trigger push of
5099 res = (check_sticky (pad, event) == GST_FLOW_OK);
5104 /* other events are pushed right away */
5105 ret = gst_pad_push_event_unchecked (pad, event, type);
5106 /* dropped events by a probe are not an error */
5107 res = (ret == GST_FLOW_OK || ret == GST_FLOW_CUSTOM_SUCCESS);
5109 /* Errors in sticky event pushing are no problem and ignored here
5110 * as they will cause more meaningful errors during data flow.
5111 * For EOS events, that are not followed by data flow, we still
5112 * return FALSE here though.
5114 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
5116 gst_event_unref (event);
5118 GST_OBJECT_UNLOCK (pad);
5122 /* ERROR handling */
5125 g_warning ("pad %s:%s pushing %s event in wrong direction",
5126 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5127 gst_event_unref (event);
5132 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5133 gst_event_unref (event);
5138 GST_DEBUG_OBJECT (pad, "We're flushing");
5139 GST_OBJECT_UNLOCK (pad);
5140 gst_event_unref (event);
5145 GST_DEBUG_OBJECT (pad, "We're EOS");
5146 GST_OBJECT_UNLOCK (pad);
5147 gst_event_unref (event);
5152 /* Check if we can call the event function with the given event */
5153 static GstFlowReturn
5154 pre_eventfunc_check (GstPad * pad, GstEvent * event)
5158 switch (GST_EVENT_TYPE (event)) {
5159 case GST_EVENT_CAPS:
5161 /* backwards compatibility mode for caps */
5162 gst_event_parse_caps (event, &caps);
5164 if (!gst_pad_query_accept_caps (pad, caps))
5176 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
5177 "caps %" GST_PTR_FORMAT " not accepted", caps);
5178 return GST_FLOW_NOT_NEGOTIATED;
5182 static GstFlowReturn
5183 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
5184 GstPadProbeType type)
5187 GstEventType event_type;
5188 gboolean serialized, need_unlock = FALSE, sticky;
5189 GstPadEventFunction eventfunc;
5192 GST_OBJECT_LOCK (pad);
5194 event = apply_pad_offset (pad, event, GST_PAD_IS_SRC (pad));
5196 if (GST_PAD_IS_SINK (pad))
5197 serialized = GST_EVENT_IS_SERIALIZED (event);
5200 sticky = GST_EVENT_IS_STICKY (event);
5201 event_type = GST_EVENT_TYPE (event);
5202 switch (event_type) {
5203 case GST_EVENT_FLUSH_START:
5204 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5205 "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
5207 /* can't even accept a flush begin event when flushing */
5208 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5211 GST_PAD_SET_FLUSHING (pad);
5212 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
5214 case GST_EVENT_FLUSH_STOP:
5215 /* we can't accept flush-stop on inactive pads else the flushing flag
5216 * would be cleared and it would look like the pad can accept data.
5217 * Also, some elements restart a streaming thread in flush-stop which we
5218 * can't allow on inactive pads */
5219 if (G_UNLIKELY (!GST_PAD_IS_ACTIVE (pad)))
5222 GST_PAD_UNSET_FLUSHING (pad);
5223 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
5224 /* Remove pending EOS events */
5225 GST_LOG_OBJECT (pad, "Removing pending EOS and SEGMENT events");
5226 remove_event_by_type (pad, GST_EVENT_EOS);
5227 remove_event_by_type (pad, GST_EVENT_SEGMENT);
5228 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
5229 pad->ABI.abi.last_flowret = GST_FLOW_OK;
5231 GST_OBJECT_UNLOCK (pad);
5232 /* grab stream lock */
5233 GST_PAD_STREAM_LOCK (pad);
5235 GST_OBJECT_LOCK (pad);
5236 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5239 case GST_EVENT_RECONFIGURE:
5240 if (GST_PAD_IS_SRC (pad))
5241 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
5243 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
5244 "have event type %" GST_PTR_FORMAT, event);
5246 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5250 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5253 /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
5254 GST_OBJECT_UNLOCK (pad);
5255 GST_PAD_STREAM_LOCK (pad);
5257 GST_OBJECT_LOCK (pad);
5258 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
5261 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
5267 /* now do the probe */
5269 type | GST_PAD_PROBE_TYPE_PUSH |
5270 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
5272 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
5274 if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
5277 ACQUIRE_PARENT (pad, parent, no_parent);
5278 GST_OBJECT_UNLOCK (pad);
5280 ret = pre_eventfunc_check (pad, event);
5281 if (G_UNLIKELY (ret != GST_FLOW_OK))
5282 goto precheck_failed;
5285 gst_event_ref (event);
5287 if (eventfunc (pad, parent, event)) {
5290 /* something went wrong */
5291 switch (event_type) {
5292 case GST_EVENT_CAPS:
5293 ret = GST_FLOW_NOT_NEGOTIATED;
5296 ret = GST_FLOW_ERROR;
5300 RELEASE_PARENT (parent);
5302 GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
5305 if (ret == GST_FLOW_OK) {
5306 GST_OBJECT_LOCK (pad);
5307 /* after the event function accepted the event, we can store the sticky
5308 * event on the pad */
5309 switch (store_sticky_event (pad, event)) {
5310 case GST_FLOW_FLUSHING:
5317 GST_OBJECT_UNLOCK (pad);
5319 gst_event_unref (event);
5323 GST_PAD_STREAM_UNLOCK (pad);
5327 /* ERROR handling */
5330 GST_OBJECT_UNLOCK (pad);
5332 GST_PAD_STREAM_UNLOCK (pad);
5333 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5334 "Received event on flushing pad. Discarding");
5335 gst_event_unref (event);
5336 return GST_FLOW_FLUSHING;
5340 GST_OBJECT_UNLOCK (pad);
5342 GST_PAD_STREAM_UNLOCK (pad);
5343 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5344 "Received flush-stop on inactive pad. Discarding");
5345 gst_event_unref (event);
5346 return GST_FLOW_FLUSHING;
5350 GST_OBJECT_UNLOCK (pad);
5352 GST_PAD_STREAM_UNLOCK (pad);
5353 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
5354 "Received event on EOS pad. Discarding");
5355 gst_event_unref (event);
5356 return GST_FLOW_EOS;
5360 GST_OBJECT_UNLOCK (pad);
5362 GST_PAD_STREAM_UNLOCK (pad);
5363 gst_event_unref (event);
5366 case GST_FLOW_CUSTOM_SUCCESS:
5367 GST_DEBUG_OBJECT (pad, "dropped event");
5371 GST_DEBUG_OBJECT (pad, "an error occurred %s", gst_flow_get_name (ret));
5378 g_warning ("pad %s:%s has no event handler, file a bug.",
5379 GST_DEBUG_PAD_NAME (pad));
5380 GST_OBJECT_UNLOCK (pad);
5382 GST_PAD_STREAM_UNLOCK (pad);
5383 gst_event_unref (event);
5384 return GST_FLOW_NOT_SUPPORTED;
5388 GST_DEBUG_OBJECT (pad, "no parent");
5389 GST_OBJECT_UNLOCK (pad);
5391 GST_PAD_STREAM_UNLOCK (pad);
5392 gst_event_unref (event);
5393 return GST_FLOW_FLUSHING;
5397 GST_DEBUG_OBJECT (pad, "pre event check failed");
5398 RELEASE_PARENT (parent);
5400 GST_PAD_STREAM_UNLOCK (pad);
5401 gst_event_unref (event);
5407 * gst_pad_send_event:
5408 * @pad: a #GstPad to send the event to.
5409 * @event: (transfer full): the #GstEvent to send to the pad.
5411 * Sends the event to the pad. This function can be used
5412 * by applications to send events in the pipeline.
5414 * If @pad is a source pad, @event should be an upstream event. If @pad is a
5415 * sink pad, @event should be a downstream event. For example, you would not
5416 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
5417 * Furthermore, some downstream events have to be serialized with data flow,
5418 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
5419 * the event needs to be serialized with data flow, this function will take the
5420 * pad's stream lock while calling its event function.
5422 * To find out whether an event type is upstream, downstream, or downstream and
5423 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
5424 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
5425 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
5426 * plugin doesn't need to bother itself with this information; the core handles
5427 * all necessary locks and checks.
5429 * This function takes ownership of the provided event so you should
5430 * gst_event_ref() it if you want to reuse the event after this call.
5432 * Returns: %TRUE if the event was handled.
5435 gst_pad_send_event (GstPad * pad, GstEvent * event)
5438 GstPadProbeType type;
5440 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5441 g_return_val_if_fail (event != NULL, FALSE);
5443 if (GST_PAD_IS_SINK (pad)) {
5444 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
5445 goto wrong_direction;
5446 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
5447 } else if (GST_PAD_IS_SRC (pad)) {
5448 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
5449 goto wrong_direction;
5450 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
5452 goto unknown_direction;
5454 if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
5461 /* ERROR handling */
5464 g_warning ("pad %s:%s sending %s event in wrong direction",
5465 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
5466 gst_event_unref (event);
5471 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
5472 gst_event_unref (event);
5478 * gst_pad_set_element_private:
5479 * @pad: the #GstPad to set the private data of.
5480 * @priv: The private data to attach to the pad.
5482 * Set the given private data gpointer on the pad.
5483 * This function can only be used by the element that owns the pad.
5484 * No locking is performed in this function.
5487 gst_pad_set_element_private (GstPad * pad, gpointer priv)
5489 pad->element_private = priv;
5493 * gst_pad_get_element_private:
5494 * @pad: the #GstPad to get the private data of.
5496 * Gets the private data of a pad.
5497 * No locking is performed in this function.
5499 * Returns: (transfer none): a #gpointer to the private data.
5502 gst_pad_get_element_private (GstPad * pad)
5504 return pad->element_private;
5508 * gst_pad_get_sticky_event:
5509 * @pad: the #GstPad to get the event from.
5510 * @event_type: the #GstEventType that should be retrieved.
5511 * @idx: the index of the event
5513 * Returns a new reference of the sticky event of type @event_type
5516 * Returns: (transfer full) (nullable): a #GstEvent of type
5517 * @event_type or %NULL when no event of @event_type was on
5518 * @pad. Unref after usage.
5521 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
5523 GstEvent *event = NULL;
5526 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
5527 g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
5529 GST_OBJECT_LOCK (pad);
5530 ev = find_event_by_type (pad, event_type, idx);
5531 if (ev && (event = ev->event))
5532 gst_event_ref (event);
5533 GST_OBJECT_UNLOCK (pad);
5540 GstPadStickyEventsForeachFunction func;
5545 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
5547 ForeachDispatch *data = user_data;
5548 gboolean ret = TRUE;
5551 GST_OBJECT_UNLOCK (pad);
5553 ret = data->func (pad, &ev->event, data->user_data);
5555 GST_OBJECT_LOCK (pad);
5562 * gst_pad_sticky_events_foreach:
5563 * @pad: the #GstPad that should be used for iteration.
5564 * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
5565 * should be called for every event.
5566 * @user_data: (closure): the optional user data.
5568 * Iterates all sticky events on @pad and calls @foreach_func for every
5569 * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
5572 gst_pad_sticky_events_foreach (GstPad * pad,
5573 GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
5575 ForeachDispatch data;
5577 g_return_if_fail (GST_IS_PAD (pad));
5578 g_return_if_fail (foreach_func != NULL);
5580 data.func = foreach_func;
5581 data.user_data = user_data;
5583 GST_OBJECT_LOCK (pad);
5584 events_foreach (pad, foreach_dispatch_function, &data);
5585 GST_OBJECT_UNLOCK (pad);
5589 do_stream_status (GstPad * pad, GstStreamStatusType type,
5590 GThread * thread, GstTask * task)
5594 GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5596 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5597 if (GST_IS_ELEMENT (parent)) {
5598 GstMessage *message;
5599 GValue value = { 0 };
5601 if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5602 gchar *tname, *ename, *pname;
5604 /* create a good task name */
5605 ename = gst_element_get_name (parent);
5606 pname = gst_pad_get_name (pad);
5607 tname = g_strdup_printf ("%s:%s", ename, pname);
5611 gst_object_set_name (GST_OBJECT_CAST (task), tname);
5615 message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5618 g_value_init (&value, GST_TYPE_TASK);
5619 g_value_set_object (&value, task);
5620 gst_message_set_stream_status_object (message, &value);
5621 g_value_unset (&value);
5623 GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5624 gst_element_post_message (parent, message);
5626 gst_object_unref (parent);
5631 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5633 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5638 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5640 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5645 * gst_pad_start_task:
5646 * @pad: the #GstPad to start the task of
5647 * @func: the task function to call
5648 * @user_data: user data passed to the task function
5649 * @notify: called when @user_data is no longer referenced
5651 * Starts a task that repeatedly calls @func with @user_data. This function
5652 * is mostly used in pad activation functions to start the dataflow.
5653 * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5654 * before @func is called.
5656 * Returns: a %TRUE if the task could be started.
5659 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer user_data,
5660 GDestroyNotify notify)
5665 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5666 g_return_val_if_fail (func != NULL, FALSE);
5668 GST_DEBUG_OBJECT (pad, "start task");
5670 GST_OBJECT_LOCK (pad);
5671 task = GST_PAD_TASK (pad);
5673 task = gst_task_new (func, user_data, notify);
5674 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5675 gst_task_set_enter_callback (task, pad_enter_thread, pad, NULL);
5676 gst_task_set_leave_callback (task, pad_leave_thread, pad, NULL);
5677 GST_INFO_OBJECT (pad, "created task %p", task);
5678 GST_PAD_TASK (pad) = task;
5679 gst_object_ref (task);
5680 /* release lock to post the message */
5681 GST_OBJECT_UNLOCK (pad);
5683 do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
5685 gst_object_unref (task);
5687 GST_OBJECT_LOCK (pad);
5688 /* nobody else is supposed to have changed the pad now */
5689 if (GST_PAD_TASK (pad) != task)
5690 goto concurrent_stop;
5692 res = gst_task_set_state (task, GST_TASK_STARTED);
5693 GST_OBJECT_UNLOCK (pad);
5700 GST_OBJECT_UNLOCK (pad);
5706 * gst_pad_pause_task:
5707 * @pad: the #GstPad to pause the task of
5709 * Pause the task of @pad. This function will also wait until the
5710 * function executed by the task is finished if this function is not
5711 * called from the task function.
5713 * Returns: a %TRUE if the task could be paused or %FALSE when the pad
5717 gst_pad_pause_task (GstPad * pad)
5722 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5724 GST_DEBUG_OBJECT (pad, "pause task");
5726 GST_OBJECT_LOCK (pad);
5727 task = GST_PAD_TASK (pad);
5730 res = gst_task_set_state (task, GST_TASK_PAUSED);
5731 GST_OBJECT_UNLOCK (pad);
5733 /* wait for task function to finish, this lock is recursive so it does nothing
5734 * when the pause is called from the task itself */
5735 GST_PAD_STREAM_LOCK (pad);
5736 GST_PAD_STREAM_UNLOCK (pad);
5742 GST_DEBUG_OBJECT (pad, "pad has no task");
5743 GST_OBJECT_UNLOCK (pad);
5749 * gst_pad_stop_task:
5750 * @pad: the #GstPad to stop the task of
5752 * Stop the task of @pad. This function will also make sure that the
5753 * function executed by the task will effectively stop if not called
5754 * from the GstTaskFunction.
5756 * This function will deadlock if called from the GstTaskFunction of
5757 * the task. Use gst_task_pause() instead.
5759 * Regardless of whether the pad has a task, the stream lock is acquired and
5760 * released so as to ensure that streaming through this pad has finished.
5762 * Returns: a %TRUE if the task could be stopped or %FALSE on error.
5765 gst_pad_stop_task (GstPad * pad)
5770 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5772 GST_DEBUG_OBJECT (pad, "stop task");
5774 GST_OBJECT_LOCK (pad);
5775 task = GST_PAD_TASK (pad);
5778 GST_PAD_TASK (pad) = NULL;
5779 res = gst_task_set_state (task, GST_TASK_STOPPED);
5780 GST_OBJECT_UNLOCK (pad);
5782 GST_PAD_STREAM_LOCK (pad);
5783 GST_PAD_STREAM_UNLOCK (pad);
5785 if (!gst_task_join (task))
5788 gst_object_unref (task);
5794 GST_DEBUG_OBJECT (pad, "no task");
5795 GST_OBJECT_UNLOCK (pad);
5797 GST_PAD_STREAM_LOCK (pad);
5798 GST_PAD_STREAM_UNLOCK (pad);
5800 /* this is not an error */
5805 /* this is bad, possibly the application tried to join the task from
5806 * the task's thread. We install the task again so that it will be stopped
5807 * again from the right thread next time hopefully. */
5808 GST_OBJECT_LOCK (pad);
5809 GST_DEBUG_OBJECT (pad, "join failed");
5810 /* we can only install this task if there was no other task */
5811 if (GST_PAD_TASK (pad) == NULL)
5812 GST_PAD_TASK (pad) = task;
5813 GST_OBJECT_UNLOCK (pad);
5820 * gst_pad_probe_info_get_event:
5821 * @info: a #GstPadProbeInfo
5823 * Returns: (transfer none): The #GstEvent from the probe
5827 gst_pad_probe_info_get_event (GstPadProbeInfo * info)
5829 g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM |
5830 GST_PAD_PROBE_TYPE_EVENT_UPSTREAM), NULL);
5832 return GST_PAD_PROBE_INFO_EVENT (info);
5837 * gst_pad_probe_info_get_query:
5838 * @info: a #GstPadProbeInfo
5840 * Returns: (transfer none): The #GstQuery from the probe
5844 gst_pad_probe_info_get_query (GstPadProbeInfo * info)
5846 g_return_val_if_fail (info->type & (GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM |
5847 GST_PAD_PROBE_TYPE_QUERY_UPSTREAM), NULL);
5849 return GST_PAD_PROBE_INFO_QUERY (info);
5853 * gst_pad_probe_info_get_buffer:
5854 * @info: a #GstPadProbeInfo
5856 * Returns: (transfer none): The #GstBuffer from the probe
5860 gst_pad_probe_info_get_buffer (GstPadProbeInfo * info)
5862 g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER, NULL);
5864 return GST_PAD_PROBE_INFO_BUFFER (info);
5868 * gst_pad_probe_info_get_bufferlist:
5869 * @info: a #GstPadProbeInfo
5871 * Returns: (transfer none): The #GstBufferlist from the probe
5875 gst_pad_probe_info_get_buffer_list (GstPadProbeInfo * info)
5877 g_return_val_if_fail (info->type & GST_PAD_PROBE_TYPE_BUFFER_LIST, NULL);
5879 return GST_PAD_PROBE_INFO_BUFFER_LIST (info);
5883 * gst_pad_get_last_flow_return:
5886 * Gets the #GstFlowReturn return from the last data passed by this pad.
5891 gst_pad_get_last_flow_return (GstPad * pad)
5895 GST_OBJECT_LOCK (pad);
5896 ret = GST_PAD_LAST_FLOW_RETURN (pad);
5897 GST_OBJECT_UNLOCK (pad);