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., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * @short_description: Object contained by elements that allows links to
26 * @see_also: #GstPadTemplate, #GstElement, #GstEvent
28 * A #GstElement is linked to other elements via "pads", which are extremely
29 * light-weight generic link points.
30 * After two pads are retrieved from an element with gst_element_get_pad(),
31 * the pads can be link with gst_pad_link(). (For quick links,
32 * you can also use gst_element_link(), which will make the obvious
33 * link for you if it's straightforward.)
35 * Pads are typically created from a #GstPadTemplate with
36 * gst_pad_new_from_template().
38 * Pads have #GstCaps attached to it to describe the media type they are
39 * capable of dealing with. gst_pad_query_caps() and gst_pad_set_caps() are
40 * used to manipulate the caps of the pads.
41 * Pads created from a pad template cannot set capabilities that are
42 * incompatible with the pad template capabilities.
44 * Pads without pad templates can be created with gst_pad_new(),
45 * which takes a direction and a name as an argument. If the name is NULL,
46 * then a guaranteed unique name will be assigned to it.
48 * gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
50 * A #GstElement creating a pad will typically use the various
51 * gst_pad_set_*_function() calls to register callbacks for various events
54 * GstElements will use gst_pad_push() and gst_pad_pull_range() to push out
55 * or pull in a buffer.
57 * To send a #GstEvent on a pad, use gst_pad_send_event() and
58 * gst_pad_push_event().
60 * Last reviewed on 2006-07-06 (0.10.9)
63 #include "gst_private.h"
66 #include "gstpadtemplate.h"
67 #include "gstenumtypes.h"
68 #include "gstmarshal.h"
73 #include "glib-compat-private.h"
75 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
76 #define GST_CAT_DEFAULT GST_CAT_PADS
78 /* Pad signals and args */
96 #define GST_PAD_GET_PRIVATE(obj) \
97 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PAD, GstPadPrivate))
99 /* we have a pending and an active event on the pad. On source pads only the
100 * active event is used. On sinkpads, events are copied to the pending entry and
101 * moved to the active event when the eventfunc returned TRUE. */
108 struct _GstPadPrivate
114 guint probe_list_cookie;
124 #define PROBE_COOKIE(h) (((GstProbe *)(h))->cookie)
129 GstPadProbeInfo *info;
136 static void gst_pad_dispose (GObject * object);
137 static void gst_pad_finalize (GObject * object);
138 static void gst_pad_set_property (GObject * object, guint prop_id,
139 const GValue * value, GParamSpec * pspec);
140 static void gst_pad_get_property (GObject * object, guint prop_id,
141 GValue * value, GParamSpec * pspec);
143 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
144 static gboolean gst_pad_activate_default (GstPad * pad, GstObject * parent);
145 static GstFlowReturn gst_pad_chain_list_default (GstPad * pad,
146 GstObject * parent, GstBufferList * list);
148 static GstFlowReturn gst_pad_send_event_unchecked (GstPad * pad,
149 GstEvent * event, GstPadProbeType type);
150 static GstFlowReturn gst_pad_push_event_unchecked (GstPad * pad,
151 GstEvent * event, GstPadProbeType type, gboolean * stored);
153 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
155 static GParamSpec *pspec_caps = NULL;
157 /* quarks for probe signals */
158 static GQuark buffer_quark;
159 static GQuark buffer_list_quark;
160 static GQuark event_quark;
169 static GstFlowQuarks flow_quarks[] = {
170 {GST_FLOW_CUSTOM_SUCCESS, "custom-success", 0},
171 {GST_FLOW_OK, "ok", 0},
172 {GST_FLOW_NOT_LINKED, "not-linked", 0},
173 {GST_FLOW_WRONG_STATE, "wrong-state", 0},
174 {GST_FLOW_EOS, "eos", 0},
175 {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
176 {GST_FLOW_ERROR, "error", 0},
177 {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
178 {GST_FLOW_CUSTOM_ERROR, "custom-error", 0}
183 * @ret: a #GstFlowReturn to get the name of.
185 * Gets a string representing the given flow return.
187 * Returns: a static string with the name of the flow return.
190 gst_flow_get_name (GstFlowReturn ret)
194 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
196 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
197 if (ret == flow_quarks[i].ret)
198 return flow_quarks[i].name;
205 * @ret: a #GstFlowReturn to get the quark of.
207 * Get the unique quark for the given GstFlowReturn.
209 * Returns: the quark associated with the flow return or 0 if an
210 * invalid return was specified.
213 gst_flow_to_quark (GstFlowReturn ret)
217 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
219 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
220 if (ret == flow_quarks[i].ret)
221 return flow_quarks[i].quark;
230 buffer_quark = g_quark_from_static_string ("buffer"); \
231 buffer_list_quark = g_quark_from_static_string ("bufferlist"); \
232 event_quark = g_quark_from_static_string ("event"); \
234 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) { \
235 flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name); \
238 GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW", \
239 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads"); \
242 #define gst_pad_parent_class parent_class
243 G_DEFINE_TYPE_WITH_CODE (GstPad, gst_pad, GST_TYPE_OBJECT, _do_init);
246 gst_pad_class_init (GstPadClass * klass)
248 GObjectClass *gobject_class;
249 GstObjectClass *gstobject_class;
251 gobject_class = G_OBJECT_CLASS (klass);
252 gstobject_class = GST_OBJECT_CLASS (klass);
254 g_type_class_add_private (klass, sizeof (GstPadPrivate));
256 gobject_class->dispose = gst_pad_dispose;
257 gobject_class->finalize = gst_pad_finalize;
258 gobject_class->set_property = gst_pad_set_property;
259 gobject_class->get_property = gst_pad_get_property;
263 * @pad: the pad that emitted the signal
264 * @peer: the peer pad that has been connected
266 * Signals that a pad has been linked to the peer pad.
268 gst_pad_signals[PAD_LINKED] =
269 g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
270 G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
271 gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
274 * @pad: the pad that emitted the signal
275 * @peer: the peer pad that has been disconnected
277 * Signals that a pad has been unlinked from the peer pad.
279 gst_pad_signals[PAD_UNLINKED] =
280 g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
281 G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
282 gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
284 pspec_caps = g_param_spec_boxed ("caps", "Caps",
285 "The capabilities of the pad", GST_TYPE_CAPS,
286 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
287 g_object_class_install_property (gobject_class, PAD_PROP_CAPS, pspec_caps);
289 g_object_class_install_property (gobject_class, PAD_PROP_DIRECTION,
290 g_param_spec_enum ("direction", "Direction", "The direction of the pad",
291 GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
292 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
294 /* FIXME, Make G_PARAM_CONSTRUCT_ONLY when we fix ghostpads. */
295 g_object_class_install_property (gobject_class, PAD_PROP_TEMPLATE,
296 g_param_spec_object ("template", "Template",
297 "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
298 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
300 gstobject_class->path_string_separator = ".";
302 /* Register common function pointer descriptions */
303 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_activate_default);
304 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_event_default);
305 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_query_default);
306 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_iterate_internal_links_default);
307 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_chain_list_default);
311 gst_pad_init (GstPad * pad)
313 pad->priv = GST_PAD_GET_PRIVATE (pad);
315 GST_PAD_DIRECTION (pad) = GST_PAD_UNKNOWN;
317 GST_PAD_ACTIVATEFUNC (pad) = gst_pad_activate_default;
318 GST_PAD_EVENTFUNC (pad) = gst_pad_event_default;
319 GST_PAD_QUERYFUNC (pad) = gst_pad_query_default;
320 GST_PAD_ITERINTLINKFUNC (pad) = gst_pad_iterate_internal_links_default;
321 GST_PAD_CHAINLISTFUNC (pad) = gst_pad_chain_list_default;
323 GST_PAD_SET_FLUSHING (pad);
325 g_rec_mutex_init (&pad->stream_rec_lock);
327 g_cond_init (&pad->block_cond);
329 g_hook_list_init (&pad->probes, sizeof (GstProbe));
331 pad->priv->events = g_array_sized_new (FALSE, TRUE, sizeof (PadEvent), 16);
334 /* called when setting the pad inactive. It removes all sticky events from
337 remove_events (GstPad * pad)
342 events = pad->priv->events;
345 for (i = 0; i < len; i++) {
346 PadEvent *ev = &g_array_index (events, PadEvent, i);
347 gst_event_unref (ev->event);
349 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
350 g_array_set_size (events, 0);
351 pad->priv->events_cookie++;
355 find_event_by_type (GstPad * pad, GstEventType type, guint idx)
361 events = pad->priv->events;
364 for (i = 0; i < len; i++) {
365 ev = &g_array_index (events, PadEvent, i);
366 if (ev->event == NULL)
369 if (GST_EVENT_TYPE (ev->event) == type) {
381 find_event (GstPad * pad, GstEvent * event)
387 events = pad->priv->events;
390 for (i = 0; i < len; i++) {
391 ev = &g_array_index (events, PadEvent, i);
392 if (event == ev->event)
401 remove_event_by_type (GstPad * pad, GstEventType type)
407 events = pad->priv->events;
412 ev = &g_array_index (events, PadEvent, i);
413 if (ev->event == NULL)
416 if (GST_EVENT_TYPE (ev->event) != type)
419 gst_event_unref (ev->event);
420 g_array_remove_index (events, i);
422 pad->priv->events_cookie++;
431 schedule_events (GstPad * srcpad, GstPad * sinkpad)
436 gboolean pending = FALSE;
438 events = srcpad->priv->events;
441 for (i = 0; i < len; i++) {
442 ev = &g_array_index (events, PadEvent, i);
443 if (ev->event == NULL)
446 if (sinkpad == NULL || !find_event (sinkpad, ev->event)) {
447 ev->received = FALSE;
452 GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PENDING_EVENTS);
455 typedef gboolean (*PadEventFunction) (GstPad * pad, PadEvent * ev,
459 events_foreach (GstPad * pad, PadEventFunction func, gpointer user_data)
466 events = pad->priv->events;
469 cookie = pad->priv->events_cookie;
473 PadEvent *ev, ev_ret;
475 ev = &g_array_index (events, PadEvent, i);
476 if (G_UNLIKELY (ev->event == NULL))
479 /* take aditional ref, func might release the lock */
480 ev_ret.event = gst_event_ref (ev->event);
481 ev_ret.received = ev->received;
483 ret = func (pad, &ev_ret, user_data);
485 /* recheck the cookie, lock might have been released and the list could have
487 if (G_UNLIKELY (cookie != pad->priv->events_cookie)) {
488 if (G_LIKELY (ev_ret.event))
489 gst_event_unref (ev_ret.event);
493 /* if the event changed, we need to do something */
494 if (G_UNLIKELY (ev->event != ev_ret.event)) {
495 if (G_UNLIKELY (ev_ret.event == NULL)) {
496 /* function unreffed and set the event to NULL, remove it */
497 g_array_remove_index (events, i);
499 cookie = ++pad->priv->events_cookie;
502 /* function gave a new event for us */
503 gst_event_take (&ev->event, ev_ret.event);
506 /* just unref, nothing changed */
507 gst_event_unref (ev_ret.event);
516 /* should be called with LOCK */
518 apply_pad_offset (GstPad * pad, GstEvent * event)
520 /* check if we need to adjust the segment */
521 if (pad->offset != 0) {
524 /* copy segment values */
525 gst_event_copy_segment (event, &segment);
526 gst_event_unref (event);
528 /* adjust and make a new event with the offset applied */
529 segment.base += pad->offset;
530 event = gst_event_new_segment (&segment);
535 /* should be called with the OBJECT_LOCK */
537 get_pad_caps (GstPad * pad)
539 GstCaps *caps = NULL;
542 ev = find_event_by_type (pad, GST_EVENT_CAPS, 0);
544 gst_event_parse_caps (ev->event, &caps);
550 gst_pad_dispose (GObject * object)
552 GstPad *pad = GST_PAD_CAST (object);
555 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pad, "dispose");
557 /* unlink the peer pad */
558 if ((peer = gst_pad_get_peer (pad))) {
559 /* window for MT unsafeness, someone else could unlink here
560 * and then we call unlink with wrong pads. The unlink
561 * function would catch this and safely return failed. */
562 if (GST_PAD_IS_SRC (pad))
563 gst_pad_unlink (pad, peer);
565 gst_pad_unlink (peer, pad);
567 gst_object_unref (peer);
570 gst_pad_set_pad_template (pad, NULL);
574 g_hook_list_clear (&pad->probes);
576 G_OBJECT_CLASS (parent_class)->dispose (object);
580 gst_pad_finalize (GObject * object)
582 GstPad *pad = GST_PAD_CAST (object);
585 /* in case the task is still around, clean it up */
586 if ((task = GST_PAD_TASK (pad))) {
587 gst_task_join (task);
588 GST_PAD_TASK (pad) = NULL;
589 gst_object_unref (task);
592 if (pad->activatenotify)
593 pad->activatenotify (pad);
594 if (pad->activatemodenotify)
595 pad->activatemodenotify (pad);
597 pad->linknotify (pad);
598 if (pad->unlinknotify)
599 pad->unlinknotify (pad);
600 if (pad->chainnotify)
601 pad->chainnotify (pad);
602 if (pad->chainlistnotify)
603 pad->chainlistnotify (pad);
604 if (pad->getrangenotify)
605 pad->getrangenotify (pad);
606 if (pad->eventnotify)
607 pad->eventnotify (pad);
608 if (pad->querynotify)
609 pad->querynotify (pad);
610 if (pad->iterintlinknotify)
611 pad->iterintlinknotify (pad);
613 g_rec_mutex_clear (&pad->stream_rec_lock);
614 g_cond_clear (&pad->block_cond);
615 g_array_free (pad->priv->events, TRUE);
617 G_OBJECT_CLASS (parent_class)->finalize (object);
621 gst_pad_set_property (GObject * object, guint prop_id,
622 const GValue * value, GParamSpec * pspec)
624 g_return_if_fail (GST_IS_PAD (object));
627 case PAD_PROP_DIRECTION:
628 GST_PAD_DIRECTION (object) = (GstPadDirection) g_value_get_enum (value);
630 case PAD_PROP_TEMPLATE:
631 gst_pad_set_pad_template (GST_PAD_CAST (object),
632 (GstPadTemplate *) g_value_get_object (value));
635 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
641 gst_pad_get_property (GObject * object, guint prop_id,
642 GValue * value, GParamSpec * pspec)
644 g_return_if_fail (GST_IS_PAD (object));
648 GST_OBJECT_LOCK (object);
649 g_value_set_boxed (value, get_pad_caps (GST_PAD_CAST (object)));
650 GST_OBJECT_UNLOCK (object);
652 case PAD_PROP_DIRECTION:
653 g_value_set_enum (value, GST_PAD_DIRECTION (object));
655 case PAD_PROP_TEMPLATE:
656 g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
659 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
666 * @name: the name of the new pad.
667 * @direction: the #GstPadDirection of the pad.
669 * Creates a new pad with the given name in the given direction.
670 * If name is NULL, a guaranteed unique name (across all pads)
672 * This function makes a copy of the name so you can safely free the name.
674 * Returns: (transfer floating): a new #GstPad, or NULL in case of an error.
679 gst_pad_new (const gchar * name, GstPadDirection direction)
681 return g_object_new (GST_TYPE_PAD,
682 "name", name, "direction", direction, NULL);
686 * gst_pad_new_from_template:
687 * @templ: the pad template to use
688 * @name: the name of the element
690 * Creates a new pad with the given name from the given template.
691 * If name is NULL, a guaranteed unique name (across all pads)
693 * This function makes a copy of the name so you can safely free the name.
695 * Returns: (transfer full): a new #GstPad, or NULL in case of an error.
698 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
700 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
702 return g_object_new (GST_TYPE_PAD,
703 "name", name, "direction", templ->direction, "template", templ, NULL);
707 * gst_pad_new_from_static_template:
708 * @templ: the #GstStaticPadTemplate to use
709 * @name: the name of the element
711 * Creates a new pad with the given name from the given static template.
712 * If name is NULL, a guaranteed unique name (across all pads)
714 * This function makes a copy of the name so you can safely free the name.
716 * Returns: (transfer full): a new #GstPad, or NULL in case of an error.
719 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
723 GstPadTemplate *template;
725 template = gst_static_pad_template_get (templ);
726 pad = gst_pad_new_from_template (template, name);
727 gst_object_unref (template);
731 #define ACQUIRE_PARENT(pad, parent, label) \
733 if (G_LIKELY ((parent = GST_OBJECT_PARENT (pad)))) \
734 gst_object_ref (parent); \
735 else if (G_LIKELY (GST_PAD_NEEDS_PARENT (pad))) \
739 #define RELEASE_PARENT(parent) \
741 if (G_LIKELY (parent)) \
742 gst_object_unref (parent); \
746 * gst_pad_get_direction:
747 * @pad: a #GstPad to get the direction of.
749 * Gets the direction of the pad. The direction of the pad is
750 * decided at construction time so this function does not take
753 * Returns: the #GstPadDirection of the pad.
758 gst_pad_get_direction (GstPad * pad)
760 GstPadDirection result;
762 /* PAD_UNKNOWN is a little silly but we need some sort of
763 * error return value */
764 g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
766 result = GST_PAD_DIRECTION (pad);
772 gst_pad_activate_default (GstPad * pad, GstObject * parent)
774 return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
778 pre_activate (GstPad * pad, GstPadMode new_mode)
781 case GST_PAD_MODE_NONE:
782 GST_OBJECT_LOCK (pad);
783 GST_DEBUG_OBJECT (pad, "setting PAD_MODE NONE, set flushing");
784 GST_PAD_SET_FLUSHING (pad);
785 GST_PAD_MODE (pad) = new_mode;
786 /* unlock blocked pads so element can resume and stop */
787 GST_PAD_BLOCK_BROADCAST (pad);
788 GST_OBJECT_UNLOCK (pad);
790 case GST_PAD_MODE_PUSH:
791 case GST_PAD_MODE_PULL:
792 GST_OBJECT_LOCK (pad);
793 GST_DEBUG_OBJECT (pad, "setting PAD_MODE %d, unset flushing", new_mode);
794 GST_PAD_UNSET_FLUSHING (pad);
795 GST_PAD_MODE (pad) = new_mode;
796 if (GST_PAD_IS_SINK (pad)) {
798 /* make sure the peer src pad sends us all events */
799 if ((peer = GST_PAD_PEER (pad))) {
800 gst_object_ref (peer);
801 GST_OBJECT_UNLOCK (pad);
803 GST_DEBUG_OBJECT (pad, "reschedule events on peer %s:%s",
804 GST_DEBUG_PAD_NAME (peer));
806 GST_OBJECT_LOCK (peer);
807 schedule_events (peer, NULL);
808 GST_OBJECT_UNLOCK (peer);
810 gst_object_unref (peer);
812 GST_OBJECT_UNLOCK (pad);
815 GST_OBJECT_UNLOCK (pad);
822 post_activate (GstPad * pad, GstPadMode new_mode)
825 case GST_PAD_MODE_NONE:
826 /* ensures that streaming stops */
827 GST_PAD_STREAM_LOCK (pad);
828 GST_DEBUG_OBJECT (pad, "stopped streaming");
829 GST_OBJECT_LOCK (pad);
831 GST_OBJECT_UNLOCK (pad);
832 GST_PAD_STREAM_UNLOCK (pad);
834 case GST_PAD_MODE_PUSH:
835 case GST_PAD_MODE_PULL:
842 * gst_pad_set_active:
843 * @pad: the #GstPad to activate or deactivate.
844 * @active: whether or not the pad should be active.
846 * Activates or deactivates the given pad.
847 * Normally called from within core state change functions.
849 * If @active, makes sure the pad is active. If it is already active, either in
850 * push or pull mode, just return. Otherwise dispatches to the pad's activate
851 * function to perform the actual activation.
853 * If not @active, checks the pad's current mode and calls
854 * gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a
857 * Returns: #TRUE if the operation was successful.
862 gst_pad_set_active (GstPad * pad, gboolean active)
866 gboolean ret = FALSE;
868 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
870 GST_OBJECT_LOCK (pad);
871 old = GST_PAD_MODE (pad);
872 ACQUIRE_PARENT (pad, parent, no_parent);
873 GST_OBJECT_UNLOCK (pad);
876 if (old == GST_PAD_MODE_NONE) {
877 GST_DEBUG_OBJECT (pad, "activating pad from none");
878 ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad, parent);
880 GST_DEBUG_OBJECT (pad, "pad was active in mode %d", old);
884 if (old == GST_PAD_MODE_NONE) {
885 GST_DEBUG_OBJECT (pad, "pad was inactive");
888 GST_DEBUG_OBJECT (pad, "deactivating pad from mode %d", old);
889 ret = gst_pad_activate_mode (pad, old, FALSE);
893 RELEASE_PARENT (parent);
895 if (G_UNLIKELY (!ret))
899 GST_OBJECT_LOCK (pad);
900 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
901 GST_OBJECT_UNLOCK (pad);
908 GST_DEBUG_OBJECT (pad, "no parent");
909 GST_OBJECT_UNLOCK (pad);
914 GST_OBJECT_LOCK (pad);
916 g_critical ("Failed to deactivate pad %s:%s, very bad",
917 GST_DEBUG_PAD_NAME (pad));
919 GST_WARNING_OBJECT (pad, "Failed to activate pad");
921 GST_OBJECT_UNLOCK (pad);
927 * gst_pad_activate_mode:
928 * @pad: the #GstPad to activate or deactivate.
929 * @mode: the requested activation mode
930 * @active: whether or not the pad should be active.
932 * Activates or deactivates the given pad in @mode via dispatching to the
933 * pad's activatemodefunc. For use from within pad activation functions only.
935 * If you don't know what this is, you probably don't want to call it.
937 * Returns: TRUE if the operation was successful.
942 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
944 gboolean res = FALSE;
950 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
952 GST_OBJECT_LOCK (pad);
953 old = GST_PAD_MODE (pad);
954 dir = GST_PAD_DIRECTION (pad);
955 ACQUIRE_PARENT (pad, parent, no_parent);
956 GST_OBJECT_UNLOCK (pad);
958 new = active ? mode : GST_PAD_MODE_NONE;
963 if (active && old != mode) {
964 /* pad was activate in the wrong direction, deactivate it
965 * and reactivate it in the requested mode */
966 GST_DEBUG_OBJECT (pad, "deactivating pad from mode %d", old);
967 if (G_UNLIKELY (!gst_pad_activate_mode (pad, old, FALSE)))
968 goto deactivate_failed;
972 case GST_PAD_MODE_PULL:
974 if (dir == GST_PAD_SINK) {
975 if ((peer = gst_pad_get_peer (pad))) {
976 GST_DEBUG_OBJECT (pad, "calling peer");
977 if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
979 gst_object_unref (peer);
981 /* there is no peer, this is only fatal when we activate. When we
982 * deactivate, we must assume the application has unlinked the peer and
983 * will deactivate it eventually. */
987 GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
990 if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
991 goto failure; /* Can't activate pull on a src without a
1000 pre_activate (pad, new);
1002 if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1003 if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1007 /* can happen for sinks of passthrough elements */
1010 post_activate (pad, new);
1012 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in mode %d",
1013 active ? "activated" : "deactivated", mode);
1018 RELEASE_PARENT (parent);
1024 GST_DEBUG_OBJECT (pad, "no parent");
1025 GST_OBJECT_UNLOCK (pad);
1030 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in mode %d",
1031 active ? "activated" : "deactivated", mode);
1036 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1037 "failed to %s in switch to mode %d from mode %d",
1038 (active ? "activate" : "deactivate"), mode, old);
1043 GST_OBJECT_LOCK (peer);
1044 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1045 "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1046 GST_OBJECT_UNLOCK (peer);
1047 gst_object_unref (peer);
1052 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1053 "pad in pull mode");
1058 GST_OBJECT_LOCK (pad);
1059 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in mode %d",
1060 active ? "activate" : "deactivate", mode);
1061 GST_PAD_SET_FLUSHING (pad);
1062 GST_PAD_MODE (pad) = old;
1063 GST_OBJECT_UNLOCK (pad);
1069 * gst_pad_is_active:
1070 * @pad: the #GstPad to query
1072 * Query if a pad is active
1074 * Returns: TRUE if the pad is active.
1079 gst_pad_is_active (GstPad * pad)
1081 gboolean result = FALSE;
1083 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1085 GST_OBJECT_LOCK (pad);
1086 result = GST_PAD_IS_ACTIVE (pad);
1087 GST_OBJECT_UNLOCK (pad);
1093 * gst_pad_add_probe:
1094 * @pad: the #GstPad to add the probe to
1095 * @mask: the probe mask
1096 * @callback: #GstPadProbeCallback that will be called with notifications of
1098 * @user_data: (closure): user data passed to the callback
1099 * @destroy_data: #GDestroyNotify for user_data
1101 * Be notified of different states of pads. The provided callback is called for
1102 * every state that matches @mask.
1104 * Returns: an id or 0 on error. The id can be used to remove the probe with
1105 * gst_pad_remove_probe().
1110 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1111 GstPadProbeCallback callback, gpointer user_data,
1112 GDestroyNotify destroy_data)
1117 g_return_val_if_fail (GST_IS_PAD (pad), 0);
1118 g_return_val_if_fail (mask != 0, 0);
1120 GST_OBJECT_LOCK (pad);
1122 /* make a new probe */
1123 hook = g_hook_alloc (&pad->probes);
1125 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1128 /* when no contraints are given for the types, assume all types are
1130 if ((mask & GST_PAD_PROBE_TYPE_ALL_BOTH) == 0)
1131 mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1132 if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1133 mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1135 /* store our flags and other fields */
1136 hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1137 hook->func = callback;
1138 hook->data = user_data;
1139 hook->destroy = destroy_data;
1140 PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1143 g_hook_prepend (&pad->probes, hook);
1145 /* incremenent cookie so that the new hook get's called */
1146 pad->priv->probe_list_cookie++;
1148 /* get the id of the hook, we return this and it can be used to remove the
1150 res = hook->hook_id;
1152 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1154 if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1155 /* we have a block probe */
1157 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1158 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1159 "now %d blocking probes", pad->num_blocked);
1162 /* call the callback if we need to be called for idle callbacks */
1163 if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1164 if (pad->priv->using > 0) {
1165 /* the pad is in use, we can't signal the idle callback yet. Since we set the
1166 * flag above, the last thread to leave the push will do the callback. New
1167 * threads going into the push will block. */
1168 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1169 "pad is in use, delay idle callback");
1170 GST_OBJECT_UNLOCK (pad);
1172 GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1174 /* the pad is idle now, we can signal the idle callback now */
1175 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1176 "pad is idle, trigger idle callback");
1177 GST_OBJECT_UNLOCK (pad);
1179 callback (pad, &info, user_data);
1182 GST_OBJECT_UNLOCK (pad);
1188 cleanup_hook (GstPad * pad, GHook * hook)
1190 GstPadProbeType type;
1192 type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1194 if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1195 /* unblock when we remove the last blocking probe */
1197 GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1199 if (pad->num_blocked == 0) {
1200 GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1201 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1202 GST_PAD_BLOCK_BROADCAST (pad);
1205 g_hook_destroy_link (&pad->probes, hook);
1210 * gst_pad_remove_probe:
1211 * @pad: the #GstPad with the probe
1212 * @id: the probe id to remove
1214 * Remove the probe with @id from @pad.
1219 gst_pad_remove_probe (GstPad * pad, gulong id)
1223 g_return_if_fail (GST_IS_PAD (pad));
1225 GST_OBJECT_LOCK (pad);
1227 hook = g_hook_get (&pad->probes, id);
1231 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1233 cleanup_hook (pad, hook);
1234 GST_OBJECT_UNLOCK (pad);
1240 GST_OBJECT_UNLOCK (pad);
1241 g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1247 * gst_pad_is_blocked:
1248 * @pad: the #GstPad to query
1250 * Checks if the pad is blocked or not. This function returns the
1251 * last requested state of the pad. It is not certain that the pad
1252 * is actually blocking at this point (see gst_pad_is_blocking()).
1254 * Returns: TRUE if the pad is blocked.
1259 gst_pad_is_blocked (GstPad * pad)
1261 gboolean result = FALSE;
1263 g_return_val_if_fail (GST_IS_PAD (pad), result);
1265 GST_OBJECT_LOCK (pad);
1266 result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1267 GST_OBJECT_UNLOCK (pad);
1273 * gst_pad_is_blocking:
1274 * @pad: the #GstPad to query
1276 * Checks if the pad is blocking or not. This is a guaranteed state
1277 * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1279 * Returns: TRUE if the pad is blocking.
1286 gst_pad_is_blocking (GstPad * pad)
1288 gboolean result = FALSE;
1290 g_return_val_if_fail (GST_IS_PAD (pad), result);
1292 GST_OBJECT_LOCK (pad);
1293 /* the blocking flag is only valid if the pad is not flushing */
1294 result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1295 GST_OBJECT_UNLOCK (pad);
1301 * gst_pad_check_reconfigure:
1302 * @pad: the #GstPad to check
1304 * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1305 * if the flag was set.
1307 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1310 gst_pad_check_reconfigure (GstPad * pad)
1312 gboolean reconfigure;
1314 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1316 GST_OBJECT_LOCK (pad);
1317 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1318 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1319 GST_OBJECT_UNLOCK (pad);
1325 * gst_pad_mark_reconfigure:
1326 * @pad: the #GstPad to mark
1328 * Mark a pad for needing reconfiguration. The next call to
1329 * gst_pad_check_reconfigure() will return %TRUE after this call.
1332 gst_pad_mark_reconfigure (GstPad * pad)
1334 g_return_if_fail (GST_IS_PAD (pad));
1336 GST_OBJECT_LOCK (pad);
1337 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1338 GST_OBJECT_UNLOCK (pad);
1342 * gst_pad_set_activate_function_full:
1344 * @activate: the #GstPadActivateFunction to set.
1345 * @notify: notify called when @activate will not be used anymore.
1347 * Sets the given activate function for @pad. The activate function will
1348 * dispatch to gst_pad_activate_push() or gst_pad_activate_pull() to perform
1349 * the actual activation. Only makes sense to set on sink pads.
1351 * Call this function if your sink pad can start a pull-based task.
1354 gst_pad_set_activate_function_full (GstPad * pad,
1355 GstPadActivateFunction activate, GDestroyNotify notify)
1357 g_return_if_fail (GST_IS_PAD (pad));
1359 if (pad->activatenotify)
1360 pad->activatenotify (pad);
1361 GST_PAD_ACTIVATEFUNC (pad) = activate;
1362 pad->activatenotify = notify;
1364 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1365 GST_DEBUG_FUNCPTR_NAME (activate));
1369 * gst_pad_set_activatemode_function_full:
1371 * @activatemode: the #GstPadActivateModeFunction to set.
1372 * @notify: notify called when @activatemode will not be used anymore.
1374 * Sets the given activate_mode function for the pad. An activate_mode function
1375 * prepares the element for data passing.
1378 gst_pad_set_activatemode_function_full (GstPad * pad,
1379 GstPadActivateModeFunction activatemode, GDestroyNotify notify)
1381 g_return_if_fail (GST_IS_PAD (pad));
1383 if (pad->activatemodenotify)
1384 pad->activatemodenotify (pad);
1385 GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1386 pad->activatemodenotify = notify;
1388 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1389 GST_DEBUG_FUNCPTR_NAME (activatemode));
1393 * gst_pad_set_chain_function_full:
1394 * @pad: a sink #GstPad.
1395 * @chain: the #GstPadChainFunction to set.
1396 * @notify: notify called when @chain will not be used anymore.
1398 * Sets the given chain function for the pad. The chain function is called to
1399 * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1402 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1403 GDestroyNotify notify)
1405 g_return_if_fail (GST_IS_PAD (pad));
1406 g_return_if_fail (GST_PAD_IS_SINK (pad));
1408 if (pad->chainnotify)
1409 pad->chainnotify (pad);
1410 GST_PAD_CHAINFUNC (pad) = chain;
1411 pad->chainnotify = notify;
1413 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1414 GST_DEBUG_FUNCPTR_NAME (chain));
1418 * gst_pad_set_chain_list_function_full:
1419 * @pad: a sink #GstPad.
1420 * @chainlist: the #GstPadChainListFunction to set.
1421 * @notify: notify called when @chainlist will not be used anymore.
1423 * Sets the given chain list function for the pad. The chainlist function is
1424 * called to process a #GstBufferList input buffer list. See
1425 * #GstPadChainListFunction for more details.
1430 gst_pad_set_chain_list_function_full (GstPad * pad,
1431 GstPadChainListFunction chainlist, GDestroyNotify notify)
1433 g_return_if_fail (GST_IS_PAD (pad));
1434 g_return_if_fail (GST_PAD_IS_SINK (pad));
1436 if (pad->chainlistnotify)
1437 pad->chainlistnotify (pad);
1438 GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1439 pad->chainlistnotify = notify;
1441 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1442 GST_DEBUG_FUNCPTR_NAME (chainlist));
1446 * gst_pad_set_getrange_function_full:
1447 * @pad: a source #GstPad.
1448 * @get: the #GstPadGetRangeFunction to set.
1449 * @notify: notify called when @get will not be used anymore.
1451 * Sets the given getrange function for the pad. The getrange function is
1452 * called to produce a new #GstBuffer to start the processing pipeline. see
1453 * #GstPadGetRangeFunction for a description of the getrange function.
1456 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1457 GDestroyNotify notify)
1459 g_return_if_fail (GST_IS_PAD (pad));
1460 g_return_if_fail (GST_PAD_IS_SRC (pad));
1462 if (pad->getrangenotify)
1463 pad->getrangenotify (pad);
1464 GST_PAD_GETRANGEFUNC (pad) = get;
1465 pad->getrangenotify = notify;
1467 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1468 GST_DEBUG_FUNCPTR_NAME (get));
1472 * gst_pad_set_event_function_full:
1473 * @pad: a #GstPad of either direction.
1474 * @event: the #GstPadEventFunction to set.
1475 * @notify: notify called when @event will not be used anymore.
1477 * Sets the given event handler for the pad.
1480 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1481 GDestroyNotify notify)
1483 g_return_if_fail (GST_IS_PAD (pad));
1485 if (pad->eventnotify)
1486 pad->eventnotify (pad);
1487 GST_PAD_EVENTFUNC (pad) = event;
1488 pad->eventnotify = notify;
1490 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1491 GST_DEBUG_FUNCPTR_NAME (event));
1495 * gst_pad_set_query_function_full:
1496 * @pad: a #GstPad of either direction.
1497 * @query: the #GstPadQueryFunction to set.
1498 * @notify: notify called when @query will not be used anymore.
1500 * Set the given query function for the pad.
1503 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1504 GDestroyNotify notify)
1506 g_return_if_fail (GST_IS_PAD (pad));
1508 if (pad->querynotify)
1509 pad->querynotify (pad);
1510 GST_PAD_QUERYFUNC (pad) = query;
1511 pad->querynotify = notify;
1513 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1514 GST_DEBUG_FUNCPTR_NAME (query));
1518 * gst_pad_set_iterate_internal_links_function_full:
1519 * @pad: a #GstPad of either direction.
1520 * @iterintlink: the #GstPadIterIntLinkFunction to set.
1521 * @notify: notify called when @iterintlink will not be used anymore.
1523 * Sets the given internal link iterator function for the pad.
1528 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1529 GstPadIterIntLinkFunction iterintlink, GDestroyNotify notify)
1531 g_return_if_fail (GST_IS_PAD (pad));
1533 if (pad->iterintlinknotify)
1534 pad->iterintlinknotify (pad);
1535 GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1536 pad->iterintlinknotify = notify;
1538 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1539 GST_DEBUG_FUNCPTR_NAME (iterintlink));
1543 * gst_pad_set_link_function_full:
1545 * @link: the #GstPadLinkFunction to set.
1546 * @notify: notify called when @link will not be used anymore.
1548 * Sets the given link function for the pad. It will be called when
1549 * the pad is linked with another pad.
1551 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1554 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1555 * cannot be made for some reason.
1557 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1558 * of the peer sink pad, if present.
1561 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1562 GDestroyNotify notify)
1564 g_return_if_fail (GST_IS_PAD (pad));
1566 if (pad->linknotify)
1567 pad->linknotify (pad);
1568 GST_PAD_LINKFUNC (pad) = link;
1569 pad->linknotify = notify;
1571 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1572 GST_DEBUG_FUNCPTR_NAME (link));
1576 * gst_pad_set_unlink_function_full:
1578 * @unlink: the #GstPadUnlinkFunction to set.
1579 * @notify: notify called when @unlink will not be used anymore.
1581 * Sets the given unlink function for the pad. It will be called
1582 * when the pad is unlinked.
1585 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
1586 GDestroyNotify notify)
1588 g_return_if_fail (GST_IS_PAD (pad));
1590 if (pad->unlinknotify)
1591 pad->unlinknotify (pad);
1592 GST_PAD_UNLINKFUNC (pad) = unlink;
1593 pad->unlinknotify = notify;
1595 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1596 GST_DEBUG_FUNCPTR_NAME (unlink));
1601 * @srcpad: the source #GstPad to unlink.
1602 * @sinkpad: the sink #GstPad to unlink.
1604 * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1605 * signal on both pads.
1607 * Returns: TRUE if the pads were unlinked. This function returns FALSE if
1608 * the pads were not linked together.
1613 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1615 gboolean result = FALSE;
1616 GstElement *parent = NULL;
1618 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1619 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1620 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1621 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1623 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1624 GST_DEBUG_PAD_NAME (srcpad), srcpad,
1625 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1627 /* We need to notify the parent before taking any pad locks as the bin in
1628 * question might be waiting for a lock on the pad while holding its lock
1629 * that our message will try to take. */
1630 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
1631 if (GST_IS_ELEMENT (parent)) {
1632 gst_element_post_message (parent,
1633 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1634 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
1636 gst_object_unref (parent);
1641 GST_OBJECT_LOCK (srcpad);
1642 GST_OBJECT_LOCK (sinkpad);
1644 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1645 goto not_linked_together;
1647 if (GST_PAD_UNLINKFUNC (srcpad)) {
1648 GST_PAD_UNLINKFUNC (srcpad) (srcpad);
1650 if (GST_PAD_UNLINKFUNC (sinkpad)) {
1651 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad);
1654 /* first clear peers */
1655 GST_PAD_PEER (srcpad) = NULL;
1656 GST_PAD_PEER (sinkpad) = NULL;
1658 GST_OBJECT_UNLOCK (sinkpad);
1659 GST_OBJECT_UNLOCK (srcpad);
1661 /* fire off a signal to each of the pads telling them
1662 * that they've been unlinked */
1663 g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1664 g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1666 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1667 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1672 if (parent != NULL) {
1673 gst_element_post_message (parent,
1674 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1675 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
1676 gst_object_unref (parent);
1681 not_linked_together:
1683 /* we do not emit a warning in this case because unlinking cannot
1684 * be made MT safe.*/
1685 GST_OBJECT_UNLOCK (sinkpad);
1686 GST_OBJECT_UNLOCK (srcpad);
1692 * gst_pad_is_linked:
1693 * @pad: pad to check
1695 * Checks if a @pad is linked to another pad or not.
1697 * Returns: TRUE if the pad is linked, FALSE otherwise.
1702 gst_pad_is_linked (GstPad * pad)
1706 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1708 GST_OBJECT_LOCK (pad);
1709 result = (GST_PAD_PEER (pad) != NULL);
1710 GST_OBJECT_UNLOCK (pad);
1715 /* get the caps from both pads and see if the intersection
1718 * This function should be called with the pad LOCK on both
1722 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
1723 GstPadLinkCheck flags)
1725 GstCaps *srccaps = NULL;
1726 GstCaps *sinkcaps = NULL;
1727 gboolean compatible = FALSE;
1729 if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
1732 /* Doing the expensive caps checking takes priority over only checking the template caps */
1733 if (flags & GST_PAD_LINK_CHECK_CAPS) {
1734 GST_OBJECT_UNLOCK (sink);
1735 GST_OBJECT_UNLOCK (src);
1737 srccaps = gst_pad_query_caps (src, NULL);
1738 sinkcaps = gst_pad_query_caps (sink, NULL);
1740 GST_OBJECT_LOCK (src);
1741 GST_OBJECT_LOCK (sink);
1743 /* If one of the two pads doesn't have a template, consider the intersection
1745 if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
1746 || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
1750 srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
1752 gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
1755 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
1757 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
1760 /* if we have caps on both pads we can check the intersection. If one
1761 * of the caps is NULL, we return TRUE. */
1762 if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
1764 gst_caps_unref (srccaps);
1766 gst_caps_unref (sinkcaps);
1770 compatible = gst_caps_can_intersect (srccaps, sinkcaps);
1771 gst_caps_unref (srccaps);
1772 gst_caps_unref (sinkcaps);
1775 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
1776 (compatible ? "" : "not"));
1781 /* check if the grandparents of both pads are the same.
1782 * This check is required so that we don't try to link
1783 * pads from elements in different bins without ghostpads.
1785 * The LOCK should be held on both pads
1788 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
1790 GstObject *psrc, *psink;
1792 psrc = GST_OBJECT_PARENT (src);
1793 psink = GST_OBJECT_PARENT (sink);
1795 /* if one of the pads has no parent, we allow the link */
1796 if (G_UNLIKELY (psrc == NULL || psink == NULL))
1799 /* only care about parents that are elements */
1800 if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
1801 goto no_element_parent;
1803 /* if the parents are the same, we have a loop */
1804 if (G_UNLIKELY (psrc == psink))
1807 /* if they both have a parent, we check the grandparents. We can not lock
1808 * the parent because we hold on the child (pad) and the locking order is
1809 * parent >> child. */
1810 psrc = GST_OBJECT_PARENT (psrc);
1811 psink = GST_OBJECT_PARENT (psink);
1813 /* if they have grandparents but they are not the same */
1814 if (G_UNLIKELY (psrc != psink))
1815 goto wrong_grandparents;
1822 GST_CAT_DEBUG (GST_CAT_CAPS,
1823 "one of the pads has no parent %" GST_PTR_FORMAT " and %"
1824 GST_PTR_FORMAT, psrc, psink);
1829 GST_CAT_DEBUG (GST_CAT_CAPS,
1830 "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
1831 GST_PTR_FORMAT, psrc, psink);
1836 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
1842 GST_CAT_DEBUG (GST_CAT_CAPS,
1843 "pads have different grandparents %" GST_PTR_FORMAT " and %"
1844 GST_PTR_FORMAT, psrc, psink);
1849 /* FIXME leftover from an attempt at refactoring... */
1850 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
1851 * the two pads will be locked in the srcpad, sinkpad order. */
1852 static GstPadLinkReturn
1853 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
1855 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1856 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1858 GST_OBJECT_LOCK (srcpad);
1860 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
1861 goto src_was_linked;
1863 GST_OBJECT_LOCK (sinkpad);
1865 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
1866 goto sink_was_linked;
1868 /* check hierarchy, pads can only be linked if the grandparents
1870 if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
1871 && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
1872 goto wrong_hierarchy;
1874 /* check pad caps for non-empty intersection */
1875 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
1878 /* FIXME check pad scheduling for non-empty intersection */
1880 return GST_PAD_LINK_OK;
1884 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
1885 GST_DEBUG_PAD_NAME (srcpad),
1886 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1887 /* we do not emit a warning in this case because unlinking cannot
1888 * be made MT safe.*/
1889 GST_OBJECT_UNLOCK (srcpad);
1890 return GST_PAD_LINK_WAS_LINKED;
1894 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
1895 GST_DEBUG_PAD_NAME (sinkpad),
1896 GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
1897 /* we do not emit a warning in this case because unlinking cannot
1898 * be made MT safe.*/
1899 GST_OBJECT_UNLOCK (sinkpad);
1900 GST_OBJECT_UNLOCK (srcpad);
1901 return GST_PAD_LINK_WAS_LINKED;
1905 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
1906 GST_OBJECT_UNLOCK (sinkpad);
1907 GST_OBJECT_UNLOCK (srcpad);
1908 return GST_PAD_LINK_WRONG_HIERARCHY;
1912 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
1913 GST_OBJECT_UNLOCK (sinkpad);
1914 GST_OBJECT_UNLOCK (srcpad);
1915 return GST_PAD_LINK_NOFORMAT;
1921 * @srcpad: the source #GstPad.
1922 * @sinkpad: the sink #GstPad.
1924 * Checks if the source pad and the sink pad are compatible so they can be
1927 * Returns: TRUE if the pads can be linked.
1930 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
1932 GstPadLinkReturn result;
1934 /* generic checks */
1935 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1936 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1938 GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
1939 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1941 /* gst_pad_link_prepare does everything for us, we only release the locks
1942 * on the pads that it gets us. If this function returns !OK the locks are not
1944 result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
1945 if (result != GST_PAD_LINK_OK)
1948 GST_OBJECT_UNLOCK (srcpad);
1949 GST_OBJECT_UNLOCK (sinkpad);
1952 return result == GST_PAD_LINK_OK;
1956 * gst_pad_link_full:
1957 * @srcpad: the source #GstPad to link.
1958 * @sinkpad: the sink #GstPad to link.
1959 * @flags: the checks to validate when linking
1961 * Links the source pad and the sink pad.
1963 * This variant of #gst_pad_link provides a more granular control on the
1964 * checks being done when linking. While providing some considerable speedups
1965 * the caller of this method must be aware that wrong usage of those flags
1966 * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
1967 * for more information.
1971 * Returns: A result code indicating if the connection worked or
1977 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
1979 GstPadLinkReturn result;
1981 GstPadLinkFunction srcfunc, sinkfunc;
1983 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
1984 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
1985 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
1986 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
1987 GST_PAD_LINK_WRONG_DIRECTION);
1989 /* Notify the parent early. See gst_pad_unlink for details. */
1990 if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
1991 if (G_LIKELY (GST_IS_ELEMENT (parent))) {
1992 gst_element_post_message (parent,
1993 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1994 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
1996 gst_object_unref (parent);
2001 /* prepare will also lock the two pads */
2002 result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2004 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2007 /* must set peers before calling the link function */
2008 GST_PAD_PEER (srcpad) = sinkpad;
2009 GST_PAD_PEER (sinkpad) = srcpad;
2011 /* check events, when something is different, mark pending */
2012 schedule_events (srcpad, sinkpad);
2014 /* get the link functions */
2015 srcfunc = GST_PAD_LINKFUNC (srcpad);
2016 sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2018 if (G_UNLIKELY (srcfunc || sinkfunc)) {
2019 /* custom link functions, execute them */
2020 GST_OBJECT_UNLOCK (sinkpad);
2021 GST_OBJECT_UNLOCK (srcpad);
2024 /* this one will call the peer link function */
2025 result = srcfunc (srcpad, sinkpad);
2026 } else if (sinkfunc) {
2027 /* if no source link function, we need to call the sink link
2028 * function ourselves. */
2029 result = sinkfunc (sinkpad, srcpad);
2032 GST_OBJECT_LOCK (srcpad);
2033 GST_OBJECT_LOCK (sinkpad);
2035 /* we released the lock, check if the same pads are linked still */
2036 if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2037 goto concurrent_link;
2039 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2042 GST_OBJECT_UNLOCK (sinkpad);
2043 GST_OBJECT_UNLOCK (srcpad);
2045 /* fire off a signal to each of the pads telling them
2046 * that they've been linked */
2047 g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2048 g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2050 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2051 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2053 gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2056 if (G_LIKELY (parent)) {
2057 gst_element_post_message (parent,
2058 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2059 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2060 gst_object_unref (parent);
2068 GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2069 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2070 GST_OBJECT_UNLOCK (sinkpad);
2071 GST_OBJECT_UNLOCK (srcpad);
2073 /* The other link operation succeeded first */
2074 result = GST_PAD_LINK_WAS_LINKED;
2079 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed",
2080 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2082 GST_PAD_PEER (srcpad) = NULL;
2083 GST_PAD_PEER (sinkpad) = NULL;
2085 GST_OBJECT_UNLOCK (sinkpad);
2086 GST_OBJECT_UNLOCK (srcpad);
2094 * @srcpad: the source #GstPad to link.
2095 * @sinkpad: the sink #GstPad to link.
2097 * Links the source pad and the sink pad.
2099 * Returns: A result code indicating if the connection worked or
2105 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2107 return gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2111 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2113 GstPadTemplate **template_p;
2115 /* this function would need checks if it weren't static */
2117 GST_OBJECT_LOCK (pad);
2118 template_p = &pad->padtemplate;
2119 gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2120 GST_OBJECT_UNLOCK (pad);
2123 gst_pad_template_pad_created (templ, pad);
2127 * gst_pad_get_pad_template:
2130 * Gets the template for @pad.
2132 * Returns: (transfer full): the #GstPadTemplate from which this pad was
2133 * instantiated, or %NULL if this pad has no template. Unref after
2137 gst_pad_get_pad_template (GstPad * pad)
2139 GstPadTemplate *templ;
2141 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2143 templ = GST_PAD_PAD_TEMPLATE (pad);
2145 return (templ ? gst_object_ref (templ) : NULL);
2149 * gst_pad_has_current_caps:
2150 * @pad: a #GstPad to check
2152 * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2154 * Returns: TRUE when @pad has caps associated with it.
2157 gst_pad_has_current_caps (GstPad * pad)
2162 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2164 GST_OBJECT_LOCK (pad);
2165 caps = get_pad_caps (pad);
2166 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2167 "check current pad caps %" GST_PTR_FORMAT, caps);
2168 result = (caps != NULL);
2169 GST_OBJECT_UNLOCK (pad);
2175 * gst_pad_get_current_caps:
2176 * @pad: a #GstPad to get the current capabilities of.
2178 * Gets the capabilities currently configured on @pad with the last
2179 * #GST_EVENT_CAPS event.
2181 * Returns: the current caps of the pad with incremented ref-count.
2184 gst_pad_get_current_caps (GstPad * pad)
2188 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2190 GST_OBJECT_LOCK (pad);
2191 if ((result = get_pad_caps (pad)))
2192 gst_caps_ref (result);
2193 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2194 "get current pad caps %" GST_PTR_FORMAT, result);
2195 GST_OBJECT_UNLOCK (pad);
2202 * @pad: a #GstPad to set the capabilities of.
2203 * @caps: (transfer none): a #GstCaps to set.
2205 * Sets the capabilities of this pad. The caps must be fixed. Any previous
2206 * caps on the pad will be unreffed. This function refs the caps so you should
2207 * unref if as soon as you don't need it anymore.
2208 * It is possible to set NULL caps, which will make the pad unnegotiated
2211 * Returns: TRUE if the caps could be set. FALSE if the caps were not fixed
2212 * or bad parameters were provided to this function.
2217 gst_pad_set_caps (GstPad * pad, GstCaps * caps)
2220 gboolean res = TRUE;
2222 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2223 g_return_val_if_fail (caps != NULL && gst_caps_is_fixed (caps), FALSE);
2225 event = gst_event_new_caps (caps);
2227 if (GST_PAD_IS_SRC (pad))
2228 res = gst_pad_push_event (pad, event);
2230 res = gst_pad_send_event (pad, event);
2236 * gst_pad_get_pad_template_caps:
2237 * @pad: a #GstPad to get the template capabilities from.
2239 * Gets the capabilities for @pad's template.
2241 * Returns: (transfer full): the #GstCaps of this pad template.
2242 * Unref after usage.
2245 gst_pad_get_pad_template_caps (GstPad * pad)
2247 static GstStaticCaps anycaps = GST_STATIC_CAPS ("ANY");
2249 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2251 if (GST_PAD_PAD_TEMPLATE (pad))
2252 return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2254 return gst_static_caps_get (&anycaps);
2259 * @pad: a #GstPad to get the peer of.
2261 * Gets the peer of @pad. This function refs the peer pad so
2262 * you need to unref it after use.
2264 * Returns: (transfer full): the peer #GstPad. Unref after usage.
2269 gst_pad_get_peer (GstPad * pad)
2273 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2275 GST_OBJECT_LOCK (pad);
2276 result = GST_PAD_PEER (pad);
2278 gst_object_ref (result);
2279 GST_OBJECT_UNLOCK (pad);
2285 * gst_pad_get_allowed_caps:
2288 * Gets the capabilities of the allowed media types that can flow through
2289 * @pad and its peer.
2291 * The allowed capabilities is calculated as the intersection of the results of
2292 * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2293 * on the resulting caps.
2295 * Returns: (transfer full): the allowed #GstCaps of the pad link. Unref the
2296 * caps when you no longer need it. This function returns NULL when @pad
2302 gst_pad_get_allowed_caps (GstPad * pad)
2309 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2311 GST_OBJECT_LOCK (pad);
2312 peer = GST_PAD_PEER (pad);
2313 if (G_UNLIKELY (peer == NULL))
2316 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2318 gst_object_ref (peer);
2319 GST_OBJECT_UNLOCK (pad);
2320 mycaps = gst_pad_query_caps (pad, NULL);
2322 peercaps = gst_pad_query_caps (peer, NULL);
2323 gst_object_unref (peer);
2325 caps = gst_caps_intersect (mycaps, peercaps);
2326 gst_caps_unref (peercaps);
2327 gst_caps_unref (mycaps);
2329 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2336 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2337 GST_OBJECT_UNLOCK (pad);
2344 * gst_pad_iterate_internal_links_default:
2345 * @pad: the #GstPad to get the internal links of.
2346 * @parent: the parent of @pad or NULL
2348 * Iterate the list of pads to which the given pad is linked to inside of
2349 * the parent element.
2350 * This is the default handler, and thus returns an iterator of all of the
2351 * pads inside the parent element with opposite direction.
2353 * The caller must free this iterator after use with gst_iterator_free().
2355 * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
2356 * returned pad with gst_object_unref().
2361 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2368 GstElement *eparent;
2370 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2372 if (parent != NULL && GST_IS_ELEMENT (parent)) {
2373 eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2375 GST_OBJECT_LOCK (pad);
2376 eparent = GST_PAD_PARENT (pad);
2377 if (!eparent || !GST_IS_ELEMENT (eparent))
2380 gst_object_ref (eparent);
2381 GST_OBJECT_UNLOCK (pad);
2384 if (pad->direction == GST_PAD_SRC)
2385 padlist = &eparent->sinkpads;
2387 padlist = &eparent->srcpads;
2389 GST_DEBUG_OBJECT (pad, "Making iterator");
2391 cookie = &eparent->pads_cookie;
2393 lock = GST_OBJECT_GET_LOCK (eparent);
2395 res = gst_iterator_new_list (GST_TYPE_PAD,
2396 lock, cookie, padlist, (GObject *) owner, NULL);
2398 gst_object_unref (owner);
2405 GST_OBJECT_UNLOCK (pad);
2406 GST_DEBUG_OBJECT (pad, "no parent element");
2412 * gst_pad_iterate_internal_links:
2413 * @pad: the GstPad to get the internal links of.
2415 * Gets an iterator for the pads to which the given pad is linked to inside
2416 * of the parent element.
2418 * Each #GstPad element yielded by the iterator will have its refcount increased,
2419 * so unref after use.
2421 * Free-function: gst_iterator_free
2423 * Returns: (transfer full): a new #GstIterator of #GstPad or %NULL when the
2424 * pad does not have an iterator function configured. Use
2425 * gst_iterator_free() after usage.
2430 gst_pad_iterate_internal_links (GstPad * pad)
2432 GstIterator *res = NULL;
2435 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2437 GST_OBJECT_LOCK (pad);
2438 ACQUIRE_PARENT (pad, parent, no_parent);
2439 GST_OBJECT_UNLOCK (pad);
2441 if (GST_PAD_ITERINTLINKFUNC (pad))
2442 res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2444 RELEASE_PARENT (parent);
2451 GST_DEBUG_OBJECT (pad, "no parent");
2452 GST_OBJECT_UNLOCK (pad);
2460 * @forward: a #GstPadForwardFunction
2461 * @user_data: user data passed to @forward
2463 * Calls @forward for all internally linked pads of @pad. This function deals with
2464 * dynamically changing internal pads and will make sure that the @forward
2465 * function is only called once for each pad.
2467 * When @forward returns TRUE, no further pads will be processed.
2469 * Returns: TRUE if one of the dispatcher functions returned TRUE.
2472 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2475 gboolean result = FALSE;
2477 gboolean done = FALSE;
2478 GValue item = { 0, };
2479 GList *pushed_pads = NULL;
2481 iter = gst_pad_iterate_internal_links (pad);
2487 switch (gst_iterator_next (iter, &item)) {
2488 case GST_ITERATOR_OK:
2492 intpad = g_value_get_object (&item);
2494 /* if already pushed, skip. FIXME, find something faster to tag pads */
2495 if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2496 g_value_reset (&item);
2500 GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2501 GST_DEBUG_PAD_NAME (intpad));
2502 done = result = forward (intpad, user_data);
2504 pushed_pads = g_list_prepend (pushed_pads, intpad);
2506 g_value_reset (&item);
2509 case GST_ITERATOR_RESYNC:
2510 /* We don't reset the result here because we don't push the event
2511 * again on pads that got the event already and because we need
2512 * to consider the result of the previous pushes */
2513 gst_iterator_resync (iter);
2515 case GST_ITERATOR_ERROR:
2516 GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2519 case GST_ITERATOR_DONE:
2524 g_value_unset (&item);
2525 gst_iterator_free (iter);
2527 g_list_free (pushed_pads);
2537 gboolean dispatched;
2541 event_forward_func (GstPad * pad, EventData * data)
2543 /* for each pad we send to, we should ref the event; it's up
2544 * to downstream to unref again when handled. */
2545 GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2546 data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2548 data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2550 data->dispatched = TRUE;
2557 * gst_pad_event_default:
2558 * @pad: a #GstPad to call the default event handler on.
2559 * @parent: the parent of @pad or NULL
2560 * @event: (transfer full): the #GstEvent to handle.
2562 * Invokes the default event handler for the given pad.
2564 * The EOS event will pause the task associated with @pad before it is forwarded
2565 * to all internally linked pads,
2567 * The the event is sent to all pads internally linked to @pad. This function
2568 * takes ownership of @event.
2570 * Returns: TRUE if the event was sent successfully.
2573 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2575 gboolean result, forward = TRUE;
2577 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2578 g_return_val_if_fail (event != NULL, FALSE);
2580 GST_LOG_OBJECT (pad, "default event handler");
2582 switch (GST_EVENT_TYPE (event)) {
2585 GST_DEBUG_OBJECT (pad, "pausing task because of eos");
2586 gst_pad_pause_task (pad);
2589 case GST_EVENT_CAPS:
2590 forward = GST_PAD_IS_PROXY_CAPS (pad);
2601 data.dispatched = FALSE;
2602 data.result = FALSE;
2604 gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
2606 /* for sinkpads without a parent element or without internal links, nothing
2607 * will be dispatched but we still want to return TRUE. */
2608 if (data.dispatched)
2609 result = data.result;
2614 gst_event_unref (event);
2619 /* Default accept caps implementation just checks against
2620 * the allowed caps for the pad */
2622 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
2624 /* get the caps and see if it intersects to something not empty */
2625 GstCaps *caps, *allowed;
2628 GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
2630 /* first forward the query to internally linked pads when we are dealing with
2632 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2633 if ((result = gst_pad_proxy_query_accept_caps (pad, query))) {
2638 allowed = gst_pad_query_caps (pad, NULL);
2639 gst_query_parse_accept_caps (query, &caps);
2642 GST_DEBUG_OBJECT (pad, "allowed caps %" GST_PTR_FORMAT, allowed);
2643 result = gst_caps_is_subset (caps, allowed);
2644 gst_caps_unref (allowed);
2646 GST_DEBUG_OBJECT (pad, "no caps allowed on the pad");
2649 gst_query_set_accept_caps_result (query, result);
2655 /* Default caps implementation */
2657 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
2659 GstCaps *result = NULL, *filter;
2660 GstPadTemplate *templ;
2661 gboolean fixed_caps;
2663 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
2665 gst_query_parse_caps (query, &filter);
2667 /* first try to proxy if we must */
2668 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2669 if ((gst_pad_proxy_query_caps (pad, query))) {
2670 gst_query_parse_caps_result (query, &result);
2675 /* no proxy or it failed, do default handling */
2676 fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
2678 GST_OBJECT_LOCK (pad);
2680 /* fixed caps, try the negotiated caps first */
2681 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
2682 if ((result = get_pad_caps (pad)))
2683 goto filter_done_unlock;
2686 if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
2687 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
2688 if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
2689 goto filter_done_unlock;
2693 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2694 "non-fixed pad caps: trying pad caps");
2695 /* non fixed caps, try the negotiated caps */
2696 if ((result = get_pad_caps (pad)))
2697 goto filter_done_unlock;
2699 GST_OBJECT_UNLOCK (pad);
2701 /* this almost never happens */
2702 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
2703 result = gst_caps_new_empty ();
2708 GST_OBJECT_UNLOCK (pad);
2711 /* run the filter on the result */
2713 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2714 "using caps %p %" GST_PTR_FORMAT " with filter %p %"
2715 GST_PTR_FORMAT, result, result, filter, filter);
2716 result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
2717 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
2720 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2721 "using caps %p %" GST_PTR_FORMAT, result, result);
2722 result = gst_caps_ref (result);
2726 gst_query_set_caps_result (query, result);
2727 gst_caps_unref (result);
2733 * gst_pad_query_default:
2734 * @pad: a #GstPad to call the default query handler on.
2735 * @parent: the parent of @pad or NULL
2736 * @query: (transfer none): the #GstQuery to handle.
2738 * Invokes the default query handler for the given pad.
2739 * The query is sent to all pads internally linked to @pad. Note that
2740 * if there are many possible sink pads that are internally linked to
2741 * @pad, only one will be sent the query.
2742 * Multi-sinkpad elements should implement custom query handlers.
2744 * Returns: TRUE if the query was performed successfully.
2747 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
2749 gboolean forward = TRUE, ret = FALSE;
2751 switch (GST_QUERY_TYPE (query)) {
2752 case GST_QUERY_SCHEDULING:
2753 case GST_QUERY_ALLOCATION:
2756 case GST_QUERY_ACCEPT_CAPS:
2757 ret = gst_pad_query_accept_caps_default (pad, query);
2760 case GST_QUERY_CAPS:
2761 ret = gst_pad_query_caps_default (pad, query);
2764 case GST_QUERY_POSITION:
2765 case GST_QUERY_SEEKING:
2766 case GST_QUERY_FORMATS:
2767 case GST_QUERY_LATENCY:
2768 case GST_QUERY_JITTER:
2769 case GST_QUERY_RATE:
2770 case GST_QUERY_CONVERT:
2776 ret = gst_pad_forward
2777 (pad, (GstPadForwardFunction) gst_pad_peer_query, query);
2783 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
2785 GstPad *pad = data->pad;
2786 GstPadProbeInfo *info = data->info;
2787 GstPadProbeType type, flags;
2788 GstPadProbeCallback callback;
2789 GstPadProbeReturn ret;
2791 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2792 "hook %lu, cookie %u checking", hook->hook_id, PROBE_COOKIE (hook));
2794 /* if we have called this callback, do nothing */
2795 if (PROBE_COOKIE (hook) == data->cookie) {
2796 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2797 "hook %lu, cookie %u already called", hook->hook_id,
2798 PROBE_COOKIE (hook));
2802 PROBE_COOKIE (hook) = data->cookie;
2804 flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
2807 /* one of the data types */
2808 if ((flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
2810 /* one of the scheduling types */
2811 if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
2813 /* one of the blocking types must match */
2814 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
2815 (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
2817 /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
2818 if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
2819 (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
2822 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2823 "hook %lu with flags 0x%08x matches", hook->hook_id, flags);
2825 callback = (GstPadProbeCallback) hook->func;
2826 if (callback == NULL)
2829 info->id = hook->hook_id;
2831 GST_OBJECT_UNLOCK (pad);
2833 ret = callback (pad, info, hook->data);
2835 GST_OBJECT_LOCK (pad);
2836 data->marshalled = TRUE;
2839 case GST_PAD_PROBE_REMOVE:
2840 /* remove the probe */
2841 GST_DEBUG_OBJECT (pad, "asked to remove hook");
2842 cleanup_hook (pad, hook);
2844 case GST_PAD_PROBE_DROP:
2845 /* need to drop the data, make sure other probes don't get called
2847 GST_DEBUG_OBJECT (pad, "asked to drop item");
2848 info->type = GST_PAD_PROBE_TYPE_INVALID;
2849 data->dropped = TRUE;
2851 case GST_PAD_PROBE_PASS:
2852 /* inform the pad block to let things pass */
2853 GST_DEBUG_OBJECT (pad, "asked to pass item");
2857 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
2864 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2865 "hook %lu with flags 0x%08x does not match %08x", hook->hook_id,
2871 #define PROBE_PRE_PULL(pad,mask,data,offs,size,label,probed,defaultval) \
2873 if (G_UNLIKELY (pad->num_probes)) { \
2874 /* we start with passing NULL as the data item */ \
2875 GstPadProbeInfo info = { mask, 0, NULL, offs, size }; \
2876 ret = do_probe_callbacks (pad, &info, defaultval); \
2877 /* store the possibly updated data item */ \
2878 data = GST_PAD_PROBE_INFO_DATA (&info); \
2879 /* if something went wrong, exit */ \
2880 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
2882 /* otherwise check if the probe retured data */ \
2883 if (G_UNLIKELY (data != NULL)) \
2889 /* a probe that does not take or return any data */
2890 #define PROBE_NO_DATA(pad,mask,label,defaultval) \
2892 if (G_UNLIKELY (pad->num_probes)) { \
2893 /* pass NULL as the data item */ \
2894 GstPadProbeInfo info = { mask, 0, NULL, 0, 0 }; \
2895 ret = do_probe_callbacks (pad, &info, defaultval); \
2896 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
2901 #define PROBE_FULL(pad,mask,data,offs,size,label,defaultval) \
2903 if (G_UNLIKELY (pad->num_probes)) { \
2904 GstPadProbeInfo info = { mask, 0, data, offs, size }; \
2905 ret = do_probe_callbacks (pad, &info, defaultval); \
2906 data = GST_PAD_PROBE_INFO_DATA (&info); \
2907 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
2912 #define PROBE_PUSH(pad,mask,data,label) \
2913 PROBE_FULL(pad, mask, data, -1, -1, label, GST_FLOW_OK);
2914 #define PROBE_PULL(pad,mask,data,offs,size,label) \
2915 PROBE_FULL(pad, mask, data, offs, size, label, GST_FLOW_OK);
2917 static GstFlowReturn
2918 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
2919 GstFlowReturn defaultval)
2928 data.marshalled = FALSE;
2929 data.dropped = FALSE;
2930 data.cookie = ++pad->priv->probe_cookie;
2933 (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
2936 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2937 "do probes cookie %u", data.cookie);
2938 cookie = pad->priv->probe_list_cookie;
2940 g_hook_list_marshal (&pad->probes, TRUE,
2941 (GHookMarshaller) probe_hook_marshal, &data);
2943 /* if the list changed, call the new callbacks (they will not have their
2944 * cookie set to data.cookie */
2945 if (cookie != pad->priv->probe_list_cookie) {
2946 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2947 "probe list changed, restarting");
2951 /* the first item that dropped will stop the hooks and then we drop here */
2955 /* if no handler matched and we are blocking, let the item pass */
2956 if (!data.marshalled && is_block)
2959 /* At this point, all handlers returned either OK or PASS. If one handler
2960 * returned PASS, let the item pass */
2965 while (GST_PAD_IS_BLOCKED (pad)) {
2966 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2967 "we are blocked %d times", pad->num_blocked);
2969 /* we might have released the lock */
2970 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
2973 /* now we block the streaming thread. It can be unlocked when we
2974 * deactivate the pad (which will also set the FLUSHING flag) or
2975 * when the pad is unblocked. A flushing event will also unblock
2976 * the pad after setting the FLUSHING flag. */
2977 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2978 "Waiting to be unblocked or set flushing");
2979 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
2980 GST_PAD_BLOCK_WAIT (pad);
2981 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
2982 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
2984 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
2994 GST_DEBUG_OBJECT (pad, "pad is flushing");
2995 return GST_FLOW_WRONG_STATE;
2999 GST_DEBUG_OBJECT (pad, "data is dropped");
3000 return GST_FLOW_CUSTOM_SUCCESS;
3004 /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3005 GST_DEBUG_OBJECT (pad, "data is passed");
3013 * gst_pad_get_offset:
3016 * Get the offset applied to the running time of @pad. @pad has to be a source
3019 * Returns: the offset.
3022 gst_pad_get_offset (GstPad * pad)
3026 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3028 GST_OBJECT_LOCK (pad);
3029 result = pad->offset;
3030 GST_OBJECT_UNLOCK (pad);
3036 * gst_pad_set_offset:
3038 * @offset: the offset
3040 * Set the offset that will be applied to the running time of @pad.
3043 gst_pad_set_offset (GstPad * pad, gint64 offset)
3047 g_return_if_fail (GST_IS_PAD (pad));
3049 GST_OBJECT_LOCK (pad);
3050 /* if nothing changed, do nothing */
3051 if (pad->offset == offset)
3054 pad->offset = offset;
3055 GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3057 /* sinkpads will apply their offset the next time a segment
3058 * event is received. */
3059 if (GST_PAD_IS_SINK (pad))
3062 /* resend the last segment event on next buffer push */
3063 if ((ev = find_event_by_type (pad, GST_EVENT_SEGMENT, 0))) {
3064 ev->received = FALSE;
3065 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3069 GST_OBJECT_UNLOCK (pad);
3075 * @pad: a #GstPad to invoke the default query on.
3076 * @query: (transfer none): the #GstQuery to perform.
3078 * Dispatches a query to a pad. The query should have been allocated by the
3079 * caller via one of the type-specific allocation functions. The element that
3080 * the pad belongs to is responsible for filling the query with an appropriate
3081 * response, which should then be parsed with a type-specific query parsing
3084 * Again, the caller is responsible for both the allocation and deallocation of
3085 * the query structure.
3087 * Please also note that some queries might need a running pipeline to work.
3089 * Returns: TRUE if the query could be performed.
3092 gst_pad_query (GstPad * pad, GstQuery * query)
3096 GstPadQueryFunction func;
3097 GstPadProbeType type;
3100 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3101 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3103 GST_DEBUG_OBJECT (pad, "sending query %p (%s)", query,
3104 GST_QUERY_TYPE_NAME (query));
3106 if (GST_PAD_IS_SRC (pad))
3107 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3109 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3111 GST_OBJECT_LOCK (pad);
3112 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3113 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3114 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3116 ACQUIRE_PARENT (pad, parent, no_parent);
3117 GST_OBJECT_UNLOCK (pad);
3119 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3122 res = func (pad, parent, query);
3124 RELEASE_PARENT (parent);
3126 GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3127 GST_QUERY_TYPE_NAME (query), res);
3132 GST_OBJECT_LOCK (pad);
3133 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3134 GST_OBJECT_UNLOCK (pad);
3141 GST_DEBUG_OBJECT (pad, "had no parent");
3142 GST_OBJECT_UNLOCK (pad);
3147 GST_DEBUG_OBJECT (pad, "had no query function");
3148 RELEASE_PARENT (parent);
3153 GST_DEBUG_OBJECT (pad, "query failed");
3158 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3159 GST_OBJECT_UNLOCK (pad);
3165 * gst_pad_peer_query:
3166 * @pad: a #GstPad to invoke the peer query on.
3167 * @query: (transfer none): the #GstQuery to perform.
3169 * Performs gst_pad_query() on the peer of @pad.
3171 * The caller is responsible for both the allocation and deallocation of
3172 * the query structure.
3174 * Returns: TRUE if the query could be performed. This function returns %FALSE
3175 * if @pad has no peer.
3180 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3183 GstPadProbeType type;
3187 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3188 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3190 if (GST_PAD_IS_SRC (pad))
3191 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3193 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3195 GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
3196 GST_QUERY_TYPE_NAME (query));
3198 GST_OBJECT_LOCK (pad);
3199 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3200 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3201 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3203 peerpad = GST_PAD_PEER (pad);
3204 if (G_UNLIKELY (peerpad == NULL))
3207 gst_object_ref (peerpad);
3208 GST_OBJECT_UNLOCK (pad);
3210 res = gst_pad_query (peerpad, query);
3212 gst_object_unref (peerpad);
3217 GST_OBJECT_LOCK (pad);
3218 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3219 GST_OBJECT_UNLOCK (pad);
3226 GST_WARNING_OBJECT (pad, "pad has no peer");
3227 GST_OBJECT_UNLOCK (pad);
3232 GST_DEBUG_OBJECT (pad, "query failed");
3237 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3238 GST_OBJECT_UNLOCK (pad);
3243 /**********************************************************************
3244 * Data passing functions
3248 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3250 GstFlowReturn *data = user_data;
3254 GST_DEBUG_OBJECT (pad, "event %s was already received",
3255 GST_EVENT_TYPE_NAME (ev->event));
3258 GST_OBJECT_UNLOCK (pad);
3260 *data = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3261 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM, &stored);
3263 GST_OBJECT_LOCK (pad);
3264 return *data == GST_FLOW_OK;
3267 /* this is the chain function that does not perform the additional argument
3268 * checking for that little extra speed.
3270 static inline GstFlowReturn
3271 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
3276 GST_PAD_STREAM_LOCK (pad);
3278 GST_OBJECT_LOCK (pad);
3279 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3282 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3284 PROBE_PUSH (pad, type, data, probe_stopped);
3286 parent = GST_OBJECT_PARENT (pad);
3287 GST_OBJECT_UNLOCK (pad);
3289 /* NOTE: we read the chainfunc unlocked.
3290 * we cannot hold the lock for the pad so we might send
3291 * the data to the wrong function. This is not really a
3292 * problem since functions are assigned at creation time
3293 * and don't change that often... */
3294 if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
3295 GstPadChainFunction chainfunc;
3297 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3300 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3301 "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
3302 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
3304 ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
3306 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3307 "called chainfunction &%s with buffer %p, returned %s",
3308 GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
3310 GstPadChainListFunction chainlistfunc;
3312 if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
3315 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3316 "calling chainlistfunction &%s",
3317 GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
3319 ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
3321 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3322 "called chainlistfunction &%s, returned %s",
3323 GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
3326 GST_PAD_STREAM_UNLOCK (pad);
3333 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3334 "chaining, but pad was flushing");
3335 GST_OBJECT_UNLOCK (pad);
3336 GST_PAD_STREAM_UNLOCK (pad);
3337 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3338 return GST_FLOW_WRONG_STATE;
3342 GST_OBJECT_UNLOCK (pad);
3343 GST_PAD_STREAM_UNLOCK (pad);
3344 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3347 case GST_FLOW_CUSTOM_SUCCESS:
3348 GST_DEBUG_OBJECT (pad, "dropped buffer");
3352 GST_DEBUG_OBJECT (pad, "en error occured %s", gst_flow_get_name (ret));
3359 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3360 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3361 "pushing, but not chainhandler");
3362 GST_ELEMENT_ERROR (parent, CORE, PAD, (NULL),
3363 ("push on pad %s:%s but it has no chainfunction",
3364 GST_DEBUG_PAD_NAME (pad)));
3365 GST_PAD_STREAM_UNLOCK (pad);
3366 return GST_FLOW_NOT_SUPPORTED;
3372 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3373 * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
3376 * Chain a buffer to @pad.
3378 * The function returns #GST_FLOW_WRONG_STATE if the pad was flushing.
3380 * If the buffer type is not acceptable for @pad (as negotiated with a
3381 * preceeding GST_EVENT_CAPS event), this function returns
3382 * #GST_FLOW_NOT_NEGOTIATED.
3384 * The function proceeds calling the chain function installed on @pad (see
3385 * gst_pad_set_chain_function()) and the return value of that function is
3386 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3389 * In all cases, success or failure, the caller loses its reference to @buffer
3390 * after calling this function.
3392 * Returns: a #GstFlowReturn from the pad.
3397 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
3399 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3400 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3401 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3403 return gst_pad_chain_data_unchecked (pad,
3404 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3407 static GstFlowReturn
3408 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
3409 GstBufferList * list)
3415 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3417 len = gst_buffer_list_length (list);
3420 for (i = 0; i < len; i++) {
3421 buffer = gst_buffer_list_get (list, i);
3423 gst_pad_chain_data_unchecked (pad,
3424 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
3425 gst_buffer_ref (buffer));
3426 if (ret != GST_FLOW_OK)
3429 gst_buffer_list_unref (list);
3435 * gst_pad_chain_list:
3436 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3437 * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
3440 * Chain a bufferlist to @pad.
3442 * The function returns #GST_FLOW_WRONG_STATE if the pad was flushing.
3444 * If @pad was not negotiated properly with a CAPS event, this function
3445 * returns #GST_FLOW_NOT_NEGOTIATED.
3447 * The function proceeds calling the chainlist function installed on @pad (see
3448 * gst_pad_set_chain_list_function()) and the return value of that function is
3449 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3450 * chainlist function.
3452 * In all cases, success or failure, the caller loses its reference to @list
3453 * after calling this function.
3457 * Returns: a #GstFlowReturn from the pad.
3462 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
3464 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3465 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3466 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3468 return gst_pad_chain_data_unchecked (pad,
3469 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3472 static GstFlowReturn
3473 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
3478 GST_OBJECT_LOCK (pad);
3479 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3482 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3483 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3485 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3488 events_foreach (pad, push_sticky, &ret);
3489 if (ret != GST_FLOW_OK)
3493 /* do block probes */
3494 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3496 /* do post-blocking probes */
3497 PROBE_PUSH (pad, type, data, probe_stopped);
3499 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3502 /* take ref to peer pad before releasing the lock */
3503 gst_object_ref (peer);
3505 GST_OBJECT_UNLOCK (pad);
3507 ret = gst_pad_chain_data_unchecked (peer, type, data);
3509 gst_object_unref (peer);
3511 GST_OBJECT_LOCK (pad);
3513 if (pad->priv->using == 0) {
3514 /* pad is not active anymore, trigger idle callbacks */
3515 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
3516 probe_stopped, ret);
3518 GST_OBJECT_UNLOCK (pad);
3522 /* ERROR recovery here */
3526 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3527 "pushing, but pad was flushing");
3528 GST_OBJECT_UNLOCK (pad);
3529 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3530 return GST_FLOW_WRONG_STATE;
3534 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3535 "error pushing events, return %s", gst_flow_get_name (ret));
3536 GST_OBJECT_UNLOCK (pad);
3537 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3542 GST_OBJECT_UNLOCK (pad);
3543 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3546 case GST_FLOW_CUSTOM_SUCCESS:
3547 GST_DEBUG_OBJECT (pad, "dropped buffer");
3551 GST_DEBUG_OBJECT (pad, "en error occured %s", gst_flow_get_name (ret));
3558 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3559 "pushing, but it was not linked");
3560 GST_OBJECT_UNLOCK (pad);
3561 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3562 return GST_FLOW_NOT_LINKED;
3568 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3569 * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
3572 * Pushes a buffer to the peer of @pad.
3574 * This function will call installed block probes before triggering any
3575 * installed data probes.
3577 * The function proceeds calling gst_pad_chain() on the peer pad and returns
3578 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3581 * In all cases, success or failure, the caller loses its reference to @buffer
3582 * after calling this function.
3584 * Returns: a #GstFlowReturn from the peer pad.
3589 gst_pad_push (GstPad * pad, GstBuffer * buffer)
3591 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3592 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3593 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3595 return gst_pad_push_data (pad,
3596 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3600 * gst_pad_push_list:
3601 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3602 * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
3605 * Pushes a buffer list to the peer of @pad.
3607 * This function will call installed block probes before triggering any
3608 * installed data probes.
3610 * The function proceeds calling the chain function on the peer pad and returns
3611 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3612 * be returned. If the peer pad does not have any installed chainlist function
3613 * every group buffer of the list will be merged into a normal #GstBuffer and
3614 * chained via gst_pad_chain().
3616 * In all cases, success or failure, the caller loses its reference to @list
3617 * after calling this function.
3619 * Returns: a #GstFlowReturn from the peer pad.
3626 gst_pad_push_list (GstPad * pad, GstBufferList * list)
3628 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3629 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3630 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3632 return gst_pad_push_data (pad,
3633 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3636 static GstFlowReturn
3637 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
3638 GstBuffer ** buffer)
3641 GstPadGetRangeFunction getrangefunc;
3644 GST_PAD_STREAM_LOCK (pad);
3646 GST_OBJECT_LOCK (pad);
3647 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3650 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3651 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3653 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3656 events_foreach (pad, push_sticky, &ret);
3657 if (ret != GST_FLOW_OK)
3661 /* when one of the probes returns a buffer, probed_data will be called and we
3662 * skip calling the getrange function */
3663 PROBE_PRE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
3664 *buffer, offset, size, probe_stopped, probed_data, GST_FLOW_OK);
3666 ACQUIRE_PARENT (pad, parent, no_parent);
3667 GST_OBJECT_UNLOCK (pad);
3669 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
3672 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3673 "calling getrangefunc %s, offset %"
3674 G_GUINT64_FORMAT ", size %u",
3675 GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
3677 ret = getrangefunc (pad, parent, offset, size, buffer);
3679 RELEASE_PARENT (parent);
3681 if (G_UNLIKELY (ret != GST_FLOW_OK))
3682 goto get_range_failed;
3684 /* can only fire the signal if we have a valid buffer */
3685 GST_OBJECT_LOCK (pad);
3687 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
3688 *buffer, offset, size, probe_stopped_unref);
3689 GST_OBJECT_UNLOCK (pad);
3691 GST_PAD_STREAM_UNLOCK (pad);
3698 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3699 "getrange, but pad was flushing");
3700 GST_OBJECT_UNLOCK (pad);
3701 GST_PAD_STREAM_UNLOCK (pad);
3702 return GST_FLOW_WRONG_STATE;
3706 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
3707 GST_OBJECT_UNLOCK (pad);
3708 GST_PAD_STREAM_UNLOCK (pad);
3713 GST_DEBUG_OBJECT (pad, "no parent");
3714 GST_OBJECT_UNLOCK (pad);
3715 GST_PAD_STREAM_UNLOCK (pad);
3716 return GST_FLOW_WRONG_STATE;
3720 GST_ELEMENT_ERROR (parent, CORE, PAD, (NULL),
3721 ("getrange on pad %s:%s but it has no getrangefunction",
3722 GST_DEBUG_PAD_NAME (pad)));
3723 RELEASE_PARENT (parent);
3724 GST_PAD_STREAM_UNLOCK (pad);
3725 return GST_FLOW_NOT_SUPPORTED;
3729 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3730 "probe returned %s", gst_flow_get_name (ret));
3731 GST_OBJECT_UNLOCK (pad);
3732 GST_PAD_STREAM_UNLOCK (pad);
3735 probe_stopped_unref:
3737 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3738 "probe returned %s", gst_flow_get_name (ret));
3739 GST_OBJECT_UNLOCK (pad);
3740 GST_PAD_STREAM_UNLOCK (pad);
3741 gst_buffer_unref (*buffer);
3747 GST_PAD_STREAM_UNLOCK (pad);
3749 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
3750 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
3751 pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
3757 * gst_pad_get_range:
3758 * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
3759 * @offset: The start offset of the buffer
3760 * @size: The length of the buffer
3761 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
3762 * returns #GST_FLOW_ERROR if %NULL.
3764 * When @pad is flushing this function returns #GST_FLOW_WRONG_STATE
3765 * immediately and @buffer is %NULL.
3767 * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
3768 * description of a getrange function. If @pad has no getrange function
3769 * installed (see gst_pad_set_getrange_function()) this function returns
3770 * #GST_FLOW_NOT_SUPPORTED.
3772 * This is a lowlevel function. Usualy gst_pad_pull_range() is used.
3774 * Returns: a #GstFlowReturn from the pad.
3779 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
3780 GstBuffer ** buffer)
3782 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3783 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3784 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3786 return gst_pad_get_range_unchecked (pad, offset, size, buffer);
3790 * gst_pad_pull_range:
3791 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3792 * @offset: The start offset of the buffer
3793 * @size: The length of the buffer
3794 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
3795 * GST_FLOW_ERROR if %NULL.
3797 * Pulls a @buffer from the peer pad.
3799 * This function will first trigger the pad block signal if it was
3802 * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
3803 * function returns the result of gst_pad_get_range() on the peer pad.
3804 * See gst_pad_get_range() for a list of return values and for the
3805 * semantics of the arguments of this function.
3807 * Returns: a #GstFlowReturn from the peer pad.
3808 * When this function returns #GST_FLOW_OK, @buffer will contain a valid
3809 * #GstBuffer that should be freed with gst_buffer_unref() after usage.
3810 * @buffer may not be used or freed when any other return value than
3811 * #GST_FLOW_OK is returned.
3816 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
3817 GstBuffer ** buffer)
3822 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3823 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3824 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3826 GST_OBJECT_LOCK (pad);
3827 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3830 /* when one of the probes returns a buffer, probed_data will be called and we
3831 * skip calling the peer getrange function */
3832 PROBE_PRE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
3833 *buffer, offset, size, pre_probe_stopped, probed_data, GST_FLOW_OK);
3835 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3838 gst_object_ref (peer);
3840 GST_OBJECT_UNLOCK (pad);
3842 ret = gst_pad_get_range_unchecked (peer, offset, size, buffer);
3844 gst_object_unref (peer);
3846 GST_OBJECT_LOCK (pad);
3848 if (pad->priv->using == 0) {
3849 /* pad is not active anymore, trigger idle callbacks */
3850 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
3851 post_probe_stopped, ret);
3854 if (G_UNLIKELY (ret != GST_FLOW_OK))
3855 goto pull_range_failed;
3858 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
3859 *buffer, offset, size, post_probe_stopped);
3861 GST_OBJECT_UNLOCK (pad);
3865 /* ERROR recovery here */
3868 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3869 "pullrange, but pad was flushing");
3870 GST_OBJECT_UNLOCK (pad);
3871 return GST_FLOW_WRONG_STATE;
3875 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
3876 gst_flow_get_name (ret));
3877 GST_OBJECT_UNLOCK (pad);
3882 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3883 "pulling range, but it was not linked");
3884 GST_OBJECT_UNLOCK (pad);
3885 return GST_FLOW_NOT_LINKED;
3890 GST_OBJECT_UNLOCK (pad);
3891 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
3892 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
3893 pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
3898 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3899 "post probe returned %s", gst_flow_get_name (ret));
3900 GST_OBJECT_UNLOCK (pad);
3901 if (ret == GST_FLOW_OK)
3902 gst_buffer_unref (*buffer);
3909 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event, gboolean locked)
3914 gboolean res = FALSE;
3915 const gchar *name = NULL;
3917 type = GST_EVENT_TYPE (event);
3918 if (type & GST_EVENT_TYPE_STICKY_MULTI)
3919 name = gst_structure_get_name (gst_event_get_structure (event));
3921 events = pad->priv->events;
3924 for (i = 0; i < len; i++) {
3925 PadEvent *ev = &g_array_index (events, PadEvent, i);
3927 if (ev->event == NULL)
3930 if (type == GST_EVENT_TYPE (ev->event)) {
3931 /* matching types, check matching name if needed */
3932 if (name && !gst_event_has_name (ev->event, name))
3936 if ((res = gst_event_replace (&ev->event, event)))
3937 ev->received = FALSE;
3943 ev.event = gst_event_ref (event);
3944 ev.received = FALSE;
3945 g_array_append_val (events, ev);
3950 pad->priv->events_cookie++;
3951 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3953 GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
3955 switch (GST_EVENT_TYPE (event)) {
3956 case GST_EVENT_CAPS:
3958 GST_OBJECT_UNLOCK (pad);
3960 GST_DEBUG_OBJECT (pad, "notify caps");
3961 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
3964 GST_OBJECT_LOCK (pad);
3973 static GstFlowReturn
3974 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
3975 GstPadProbeType type, gboolean * stored)
3979 GstEventType event_type;
3982 sticky = GST_EVENT_IS_STICKY (event);
3984 GST_OBJECT_LOCK (pad);
3986 /* Two checks to be made:
3987 * . (un)set the FLUSHING flag for flushing events,
3988 * . handle pad blocking */
3989 event_type = GST_EVENT_TYPE (event);
3991 switch (event_type) {
3992 case GST_EVENT_FLUSH_START:
3993 GST_PAD_SET_FLUSHING (pad);
3995 GST_PAD_BLOCK_BROADCAST (pad);
3996 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
3998 case GST_EVENT_FLUSH_STOP:
3999 GST_PAD_UNSET_FLUSHING (pad);
4001 /* Remove sticky EOS events */
4002 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4003 remove_event_by_type (pad, GST_EVENT_EOS);
4005 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4009 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4012 /* store the event on the pad, but only on srcpads. We always store the
4013 * event exactly how it was sent */
4015 /* srcpad sticky events are store immediately, the received flag is set
4016 * to FALSE and will be set to TRUE when we can successfully push the
4017 * event to the peer pad */
4018 if (gst_pad_store_sticky_event (pad, event, TRUE)) {
4019 GST_DEBUG_OBJECT (pad, "event %s updated",
4020 GST_EVENT_TYPE_NAME (event));
4025 switch (GST_EVENT_TYPE (event)) {
4026 case GST_EVENT_SEGMENT:
4027 /* pass the adjusted segment event on. We need to do this even if
4028 * there is no peer pad because of the probes. */
4029 event = apply_pad_offset (pad, event);
4031 case GST_EVENT_RECONFIGURE:
4032 if (GST_PAD_IS_SINK (pad))
4033 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4038 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4039 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4044 /* send probes after modifying the events above */
4045 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4047 /* now check the peer pad */
4048 peerpad = GST_PAD_PEER (pad);
4049 if (peerpad == NULL)
4052 gst_object_ref (peerpad);
4054 GST_OBJECT_UNLOCK (pad);
4056 GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
4057 event, GST_EVENT_TYPE_NAME (event), peerpad);
4059 ret = gst_pad_send_event_unchecked (peerpad, event, type);
4061 /* Note: we gave away ownership of the event at this point but we can still
4062 * print the old pointer */
4063 GST_LOG_OBJECT (pad,
4064 "sent event %p to peerpad %" GST_PTR_FORMAT ", ret %s", event, peerpad,
4065 gst_flow_get_name (ret));
4067 gst_object_unref (peerpad);
4069 GST_OBJECT_LOCK (pad);
4071 if (ret == GST_FLOW_OK) {
4074 if ((ev = find_event (pad, event)))
4075 ev->received = TRUE;
4077 GST_DEBUG_OBJECT (pad, "event marked received");
4079 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4080 GST_DEBUG_OBJECT (pad, "mark pending events");
4084 if (pad->priv->using == 0) {
4085 /* pad is not active anymore, trigger idle callbacks */
4086 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4087 idle_probe_stopped, ret);
4089 GST_OBJECT_UNLOCK (pad);
4093 /* ERROR handling */
4096 GST_DEBUG_OBJECT (pad, "We're flushing");
4097 GST_OBJECT_UNLOCK (pad);
4098 gst_event_unref (event);
4099 return GST_FLOW_WRONG_STATE;
4103 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4104 GST_OBJECT_UNLOCK (pad);
4105 gst_event_unref (event);
4108 case GST_FLOW_CUSTOM_SUCCESS:
4109 GST_DEBUG_OBJECT (pad, "dropped event");
4113 GST_DEBUG_OBJECT (pad, "en error occured %s", gst_flow_get_name (ret));
4120 GST_DEBUG_OBJECT (pad, "Dropping event because pad is not linked");
4121 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4122 GST_OBJECT_UNLOCK (pad);
4123 gst_event_unref (event);
4124 return sticky ? GST_FLOW_OK : GST_FLOW_NOT_LINKED;
4128 GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
4129 GST_OBJECT_UNLOCK (pad);
4135 * gst_pad_push_event:
4136 * @pad: a #GstPad to push the event to.
4137 * @event: (transfer full): the #GstEvent to send to the pad.
4139 * Sends the event to the peer of the given pad. This function is
4140 * mainly used by elements to send events to their peer
4143 * This function takes owership of the provided event so you should
4144 * gst_event_ref() it if you want to reuse the event after this call.
4146 * Returns: TRUE if the event was handled.
4151 gst_pad_push_event (GstPad * pad, GstEvent * event)
4154 GstPadProbeType type;
4157 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4158 g_return_val_if_fail (event != NULL, FALSE);
4159 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4161 if (GST_PAD_IS_SRC (pad)) {
4162 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4163 goto wrong_direction;
4164 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4165 } else if (GST_PAD_IS_SINK (pad)) {
4166 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4167 goto wrong_direction;
4168 /* events pushed on sinkpad never are sticky */
4169 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4171 goto unknown_direction;
4173 if (gst_pad_push_event_unchecked (pad, event, type, &stored) != GST_FLOW_OK)
4174 res = stored ? TRUE : FALSE;
4180 /* ERROR handling */
4183 g_warning ("pad %s:%s pushing %s event in wrong direction",
4184 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4185 gst_event_unref (event);
4190 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4191 gst_event_unref (event);
4196 /* Check if we can call the event function with the given event */
4197 static GstFlowReturn
4198 pre_eventfunc_check (GstPad * pad, GstEvent * event)
4200 GstCaps *caps, *templ;
4202 switch (GST_EVENT_TYPE (event)) {
4203 case GST_EVENT_CAPS:
4205 /* backwards compatibility mode for caps */
4206 gst_event_parse_caps (event, &caps);
4208 /* See if pad accepts the caps */
4209 templ = gst_pad_get_pad_template_caps (pad);
4210 if (!gst_caps_is_subset (caps, templ))
4213 gst_caps_unref (templ);
4224 gst_caps_unref (templ);
4225 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
4226 "caps %" GST_PTR_FORMAT " not accepted", caps);
4227 return GST_FLOW_NOT_NEGOTIATED;
4231 static GstFlowReturn
4232 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
4233 GstPadProbeType type)
4236 GstEventType event_type;
4237 gboolean serialized, need_unlock = FALSE, sticky;
4238 GstPadEventFunction eventfunc;
4241 GST_OBJECT_LOCK (pad);
4242 if (GST_PAD_IS_SINK (pad))
4243 serialized = GST_EVENT_IS_SERIALIZED (event);
4246 sticky = GST_EVENT_IS_STICKY (event);
4247 event_type = GST_EVENT_TYPE (event);
4248 switch (event_type) {
4249 case GST_EVENT_FLUSH_START:
4250 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4251 "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
4253 /* can't even accept a flush begin event when flushing */
4254 if (GST_PAD_IS_FLUSHING (pad))
4257 GST_PAD_SET_FLUSHING (pad);
4258 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
4260 case GST_EVENT_FLUSH_STOP:
4261 if (G_LIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_NONE)) {
4262 GST_PAD_UNSET_FLUSHING (pad);
4263 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
4265 /* Remove pending EOS events */
4266 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4267 remove_event_by_type (pad, GST_EVENT_EOS);
4269 GST_OBJECT_UNLOCK (pad);
4270 /* grab stream lock */
4271 GST_PAD_STREAM_LOCK (pad);
4273 GST_OBJECT_LOCK (pad);
4274 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4277 case GST_EVENT_RECONFIGURE:
4278 if (GST_PAD_IS_SRC (pad))
4279 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4281 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "have event type %s",
4282 GST_EVENT_TYPE_NAME (event));
4284 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4288 /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
4289 GST_OBJECT_UNLOCK (pad);
4290 GST_PAD_STREAM_LOCK (pad);
4292 GST_OBJECT_LOCK (pad);
4293 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4297 switch (GST_EVENT_TYPE (event)) {
4298 case GST_EVENT_SEGMENT:
4299 event = apply_pad_offset (pad, event);
4305 /* now do the probe */
4307 type | GST_PAD_PROBE_TYPE_PUSH |
4308 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4310 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4314 if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
4317 ACQUIRE_PARENT (pad, parent, no_parent);
4318 GST_OBJECT_UNLOCK (pad);
4320 ret = pre_eventfunc_check (pad, event);
4321 if (G_UNLIKELY (ret != GST_FLOW_OK))
4322 goto precheck_failed;
4325 gst_event_ref (event);
4327 if (eventfunc (pad, parent, event)) {
4330 /* something went wrong */
4331 switch (event_type) {
4332 case GST_EVENT_CAPS:
4333 ret = GST_FLOW_NOT_NEGOTIATED;
4336 ret = GST_FLOW_ERROR;
4340 RELEASE_PARENT (parent);
4342 GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
4345 if (ret == GST_FLOW_OK) {
4346 /* after the event function accepted the event, we can store the sticky
4347 * event on the pad */
4348 gst_pad_store_sticky_event (pad, event, FALSE);
4350 gst_event_unref (event);
4354 GST_PAD_STREAM_UNLOCK (pad);
4358 /* ERROR handling */
4361 GST_OBJECT_UNLOCK (pad);
4363 GST_PAD_STREAM_UNLOCK (pad);
4364 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
4365 "Received event on flushing pad. Discarding");
4366 gst_event_unref (event);
4367 return GST_FLOW_WRONG_STATE;
4371 GST_OBJECT_UNLOCK (pad);
4373 GST_PAD_STREAM_UNLOCK (pad);
4374 gst_event_unref (event);
4377 case GST_FLOW_CUSTOM_SUCCESS:
4378 GST_DEBUG_OBJECT (pad, "dropped event");
4382 GST_DEBUG_OBJECT (pad, "en error occured %s", gst_flow_get_name (ret));
4389 g_warning ("pad %s:%s has no event handler, file a bug.",
4390 GST_DEBUG_PAD_NAME (pad));
4391 GST_OBJECT_UNLOCK (pad);
4393 GST_PAD_STREAM_UNLOCK (pad);
4394 gst_event_unref (event);
4395 return GST_FLOW_NOT_SUPPORTED;
4399 GST_DEBUG_OBJECT (pad, "no parent");
4400 GST_OBJECT_UNLOCK (pad);
4402 GST_PAD_STREAM_UNLOCK (pad);
4403 gst_event_unref (event);
4404 return GST_FLOW_WRONG_STATE;
4408 GST_DEBUG_OBJECT (pad, "pre event check failed");
4409 RELEASE_PARENT (parent);
4411 GST_PAD_STREAM_UNLOCK (pad);
4412 gst_event_unref (event);
4418 * gst_pad_send_event:
4419 * @pad: a #GstPad to send the event to.
4420 * @event: (transfer full): the #GstEvent to send to the pad.
4422 * Sends the event to the pad. This function can be used
4423 * by applications to send events in the pipeline.
4425 * If @pad is a source pad, @event should be an upstream event. If @pad is a
4426 * sink pad, @event should be a downstream event. For example, you would not
4427 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
4428 * Furthermore, some downstream events have to be serialized with data flow,
4429 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
4430 * the event needs to be serialized with data flow, this function will take the
4431 * pad's stream lock while calling its event function.
4433 * To find out whether an event type is upstream, downstream, or downstream and
4434 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
4435 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
4436 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
4437 * plugin doesn't need to bother itself with this information; the core handles
4438 * all necessary locks and checks.
4440 * This function takes owership of the provided event so you should
4441 * gst_event_ref() it if you want to reuse the event after this call.
4443 * Returns: TRUE if the event was handled.
4446 gst_pad_send_event (GstPad * pad, GstEvent * event)
4449 GstPadProbeType type;
4451 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4452 g_return_val_if_fail (event != NULL, FALSE);
4454 if (GST_PAD_IS_SINK (pad)) {
4455 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4456 goto wrong_direction;
4457 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4458 } else if (GST_PAD_IS_SRC (pad)) {
4459 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4460 goto wrong_direction;
4461 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4463 goto unknown_direction;
4465 if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
4472 /* ERROR handling */
4475 g_warning ("pad %s:%s sending %s event in wrong direction",
4476 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4477 gst_event_unref (event);
4482 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4483 gst_event_unref (event);
4489 * gst_pad_set_element_private:
4490 * @pad: the #GstPad to set the private data of.
4491 * @priv: The private data to attach to the pad.
4493 * Set the given private data gpointer on the pad.
4494 * This function can only be used by the element that owns the pad.
4495 * No locking is performed in this function.
4498 gst_pad_set_element_private (GstPad * pad, gpointer priv)
4500 pad->element_private = priv;
4504 * gst_pad_get_element_private:
4505 * @pad: the #GstPad to get the private data of.
4507 * Gets the private data of a pad.
4508 * No locking is performed in this function.
4510 * Returns: (transfer none): a #gpointer to the private data.
4513 gst_pad_get_element_private (GstPad * pad)
4515 return pad->element_private;
4519 * gst_pad_get_sticky_event:
4520 * @pad: the #GstPad to get the event from.
4521 * @event_type: the #GstEventType that should be retrieved.
4522 * @idx: the index of the event
4524 * Returns a new reference of the sticky event of type @event_type
4527 * Returns: (transfer full): a #GstEvent of type @event_type or NULL when no
4528 * event of @event_type was on @pad. Unref after usage.
4531 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
4533 GstEvent *event = NULL;
4536 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
4537 g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
4539 GST_OBJECT_LOCK (pad);
4540 ev = find_event_by_type (pad, event_type, idx);
4541 if (ev && (event = ev->event))
4542 gst_event_ref (event);
4543 GST_OBJECT_UNLOCK (pad);
4550 GstPadStickyEventsForeachFunction func;
4555 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
4557 ForeachDispatch *data = user_data;
4560 GST_OBJECT_UNLOCK (pad);
4562 ret = data->func (pad, &ev->event, data->user_data);
4564 GST_OBJECT_LOCK (pad);
4570 * gst_pad_sticky_events_foreach:
4571 * @pad: the #GstPad that should be used for iteration.
4572 * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
4573 * should be called for every event.
4574 * @user_data: (closure): the optional user data.
4576 * Iterates all sticky events on @pad and calls @foreach_func for every
4577 * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
4580 gst_pad_sticky_events_foreach (GstPad * pad,
4581 GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
4583 ForeachDispatch data;
4585 g_return_if_fail (GST_IS_PAD (pad));
4586 g_return_if_fail (foreach_func != NULL);
4588 data.func = foreach_func;
4589 data.user_data = user_data;
4591 GST_OBJECT_LOCK (pad);
4592 events_foreach (pad, foreach_dispatch_function, &data);
4593 GST_OBJECT_UNLOCK (pad);
4597 do_stream_status (GstPad * pad, GstStreamStatusType type,
4598 GThread * thread, GstTask * task)
4602 GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
4604 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
4605 if (GST_IS_ELEMENT (parent)) {
4606 GstMessage *message;
4607 GValue value = { 0 };
4609 if (type == GST_STREAM_STATUS_TYPE_ENTER) {
4610 gchar *tname, *ename, *pname;
4612 /* create a good task name */
4613 ename = gst_element_get_name (parent);
4614 pname = gst_pad_get_name (pad);
4615 tname = g_strdup_printf ("%s:%s", ename, pname);
4619 gst_object_set_name (GST_OBJECT_CAST (task), tname);
4623 message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
4626 g_value_init (&value, GST_TYPE_TASK);
4627 g_value_set_object (&value, task);
4628 gst_message_set_stream_status_object (message, &value);
4629 g_value_unset (&value);
4631 GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
4632 gst_element_post_message (parent, message);
4634 gst_object_unref (parent);
4639 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
4641 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
4646 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
4648 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
4652 static GstTaskThreadCallbacks thr_callbacks = {
4658 * gst_pad_start_task:
4659 * @pad: the #GstPad to start the task of
4660 * @func: the task function to call
4661 * @data: data passed to the task function
4663 * Starts a task that repeatedly calls @func with @data. This function
4664 * is mostly used in pad activation functions to start the dataflow.
4665 * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
4666 * before @func is called.
4668 * Returns: a %TRUE if the task could be started.
4671 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer data)
4676 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4677 g_return_val_if_fail (func != NULL, FALSE);
4679 GST_DEBUG_OBJECT (pad, "start task");
4681 GST_OBJECT_LOCK (pad);
4682 task = GST_PAD_TASK (pad);
4684 task = gst_task_new (func, data);
4685 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
4686 gst_task_set_thread_callbacks (task, &thr_callbacks, pad, NULL);
4687 GST_DEBUG_OBJECT (pad, "created task");
4688 GST_PAD_TASK (pad) = task;
4689 gst_object_ref (task);
4690 /* release lock to post the message */
4691 GST_OBJECT_UNLOCK (pad);
4693 do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
4695 gst_object_unref (task);
4697 GST_OBJECT_LOCK (pad);
4698 /* nobody else is supposed to have changed the pad now */
4699 if (GST_PAD_TASK (pad) != task)
4700 goto concurrent_stop;
4702 res = gst_task_set_state (task, GST_TASK_STARTED);
4703 GST_OBJECT_UNLOCK (pad);
4710 GST_OBJECT_UNLOCK (pad);
4716 * gst_pad_pause_task:
4717 * @pad: the #GstPad to pause the task of
4719 * Pause the task of @pad. This function will also wait until the
4720 * function executed by the task is finished if this function is not
4721 * called from the task function.
4723 * Returns: a TRUE if the task could be paused or FALSE when the pad
4727 gst_pad_pause_task (GstPad * pad)
4732 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4734 GST_DEBUG_OBJECT (pad, "pause task");
4736 GST_OBJECT_LOCK (pad);
4737 task = GST_PAD_TASK (pad);
4740 res = gst_task_set_state (task, GST_TASK_PAUSED);
4741 GST_OBJECT_UNLOCK (pad);
4743 /* wait for task function to finish, this lock is recursive so it does nothing
4744 * when the pause is called from the task itself */
4745 GST_PAD_STREAM_LOCK (pad);
4746 GST_PAD_STREAM_UNLOCK (pad);
4752 GST_DEBUG_OBJECT (pad, "pad has no task");
4753 GST_OBJECT_UNLOCK (pad);
4759 * gst_pad_stop_task:
4760 * @pad: the #GstPad to stop the task of
4762 * Stop the task of @pad. This function will also make sure that the
4763 * function executed by the task will effectively stop if not called
4764 * from the GstTaskFunction.
4766 * This function will deadlock if called from the GstTaskFunction of
4767 * the task. Use gst_task_pause() instead.
4769 * Regardless of whether the pad has a task, the stream lock is acquired and
4770 * released so as to ensure that streaming through this pad has finished.
4772 * Returns: a TRUE if the task could be stopped or FALSE on error.
4775 gst_pad_stop_task (GstPad * pad)
4780 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4782 GST_DEBUG_OBJECT (pad, "stop task");
4784 GST_OBJECT_LOCK (pad);
4785 task = GST_PAD_TASK (pad);
4788 GST_PAD_TASK (pad) = NULL;
4789 res = gst_task_set_state (task, GST_TASK_STOPPED);
4790 GST_OBJECT_UNLOCK (pad);
4792 GST_PAD_STREAM_LOCK (pad);
4793 GST_PAD_STREAM_UNLOCK (pad);
4795 if (!gst_task_join (task))
4798 gst_object_unref (task);
4804 GST_DEBUG_OBJECT (pad, "no task");
4805 GST_OBJECT_UNLOCK (pad);
4807 GST_PAD_STREAM_LOCK (pad);
4808 GST_PAD_STREAM_UNLOCK (pad);
4810 /* this is not an error */
4815 /* this is bad, possibly the application tried to join the task from
4816 * the task's thread. We install the task again so that it will be stopped
4817 * again from the right thread next time hopefully. */
4818 GST_OBJECT_LOCK (pad);
4819 GST_DEBUG_OBJECT (pad, "join failed");
4820 /* we can only install this task if there was no other task */
4821 if (GST_PAD_TASK (pad) == NULL)
4822 GST_PAD_TASK (pad) = task;
4823 GST_OBJECT_UNLOCK (pad);