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"
72 #include "glib-compat-private.h"
74 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
75 #define GST_CAT_DEFAULT GST_CAT_PADS
77 /* Pad signals and args */
95 #define GST_PAD_GET_PRIVATE(obj) \
96 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PAD, GstPadPrivate))
98 /* we have a pending and an active event on the pad. On source pads only the
99 * active event is used. On sinkpads, events are copied to the pending entry and
100 * moved to the active event when the eventfunc returned TRUE. */
107 struct _GstPadPrivate
113 guint probe_list_cookie;
123 #define PROBE_COOKIE(h) (((GstProbe *)(h))->cookie)
128 GstPadProbeInfo *info;
135 static void gst_pad_dispose (GObject * object);
136 static void gst_pad_finalize (GObject * object);
137 static void gst_pad_set_property (GObject * object, guint prop_id,
138 const GValue * value, GParamSpec * pspec);
139 static void gst_pad_get_property (GObject * object, guint prop_id,
140 GValue * value, GParamSpec * pspec);
142 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
143 static gboolean gst_pad_activate_default (GstPad * pad, GstObject * parent);
144 static GstFlowReturn gst_pad_chain_list_default (GstPad * pad,
145 GstObject * parent, GstBufferList * list);
147 static GstFlowReturn gst_pad_send_event_unchecked (GstPad * pad,
148 GstEvent * event, GstPadProbeType type);
149 static GstFlowReturn gst_pad_push_event_unchecked (GstPad * pad,
150 GstEvent * event, GstPadProbeType type, gboolean * stored);
152 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
154 static GParamSpec *pspec_caps = NULL;
156 /* quarks for probe signals */
157 static GQuark buffer_quark;
158 static GQuark buffer_list_quark;
159 static GQuark event_quark;
168 static GstFlowQuarks flow_quarks[] = {
169 {GST_FLOW_CUSTOM_SUCCESS, "custom-success", 0},
170 {GST_FLOW_OK, "ok", 0},
171 {GST_FLOW_NOT_LINKED, "not-linked", 0},
172 {GST_FLOW_FLUSHING, "flushing", 0},
173 {GST_FLOW_EOS, "eos", 0},
174 {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
175 {GST_FLOW_ERROR, "error", 0},
176 {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
177 {GST_FLOW_CUSTOM_ERROR, "custom-error", 0}
182 * @ret: a #GstFlowReturn to get the name of.
184 * Gets a string representing the given flow return.
186 * Returns: a static string with the name of the flow return.
189 gst_flow_get_name (GstFlowReturn ret)
193 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
195 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
196 if (ret == flow_quarks[i].ret)
197 return flow_quarks[i].name;
204 * @ret: a #GstFlowReturn to get the quark of.
206 * Get the unique quark for the given GstFlowReturn.
208 * Returns: the quark associated with the flow return or 0 if an
209 * invalid return was specified.
212 gst_flow_to_quark (GstFlowReturn ret)
216 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
218 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
219 if (ret == flow_quarks[i].ret)
220 return flow_quarks[i].quark;
229 buffer_quark = g_quark_from_static_string ("buffer"); \
230 buffer_list_quark = g_quark_from_static_string ("bufferlist"); \
231 event_quark = g_quark_from_static_string ("event"); \
233 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) { \
234 flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name); \
237 GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW", \
238 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads"); \
241 #define gst_pad_parent_class parent_class
242 G_DEFINE_TYPE_WITH_CODE (GstPad, gst_pad, GST_TYPE_OBJECT, _do_init);
245 gst_pad_class_init (GstPadClass * klass)
247 GObjectClass *gobject_class;
248 GstObjectClass *gstobject_class;
250 gobject_class = G_OBJECT_CLASS (klass);
251 gstobject_class = GST_OBJECT_CLASS (klass);
253 g_type_class_add_private (klass, sizeof (GstPadPrivate));
255 gobject_class->dispose = gst_pad_dispose;
256 gobject_class->finalize = gst_pad_finalize;
257 gobject_class->set_property = gst_pad_set_property;
258 gobject_class->get_property = gst_pad_get_property;
262 * @pad: the pad that emitted the signal
263 * @peer: the peer pad that has been connected
265 * Signals that a pad has been linked to the peer pad.
267 gst_pad_signals[PAD_LINKED] =
268 g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
269 G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
270 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
273 * @pad: the pad that emitted the signal
274 * @peer: the peer pad that has been disconnected
276 * Signals that a pad has been unlinked from the peer pad.
278 gst_pad_signals[PAD_UNLINKED] =
279 g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
280 G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
281 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
283 pspec_caps = g_param_spec_boxed ("caps", "Caps",
284 "The capabilities of the pad", GST_TYPE_CAPS,
285 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
286 g_object_class_install_property (gobject_class, PAD_PROP_CAPS, pspec_caps);
288 g_object_class_install_property (gobject_class, PAD_PROP_DIRECTION,
289 g_param_spec_enum ("direction", "Direction", "The direction of the pad",
290 GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
291 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
293 /* FIXME, Make G_PARAM_CONSTRUCT_ONLY when we fix ghostpads. */
294 g_object_class_install_property (gobject_class, PAD_PROP_TEMPLATE,
295 g_param_spec_object ("template", "Template",
296 "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
297 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
299 gstobject_class->path_string_separator = ".";
301 /* Register common function pointer descriptions */
302 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_activate_default);
303 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_event_default);
304 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_query_default);
305 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_iterate_internal_links_default);
306 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_chain_list_default);
310 gst_pad_init (GstPad * pad)
312 pad->priv = GST_PAD_GET_PRIVATE (pad);
314 GST_PAD_DIRECTION (pad) = GST_PAD_UNKNOWN;
316 GST_PAD_ACTIVATEFUNC (pad) = gst_pad_activate_default;
317 GST_PAD_EVENTFUNC (pad) = gst_pad_event_default;
318 GST_PAD_QUERYFUNC (pad) = gst_pad_query_default;
319 GST_PAD_ITERINTLINKFUNC (pad) = gst_pad_iterate_internal_links_default;
320 GST_PAD_CHAINLISTFUNC (pad) = gst_pad_chain_list_default;
322 GST_PAD_SET_FLUSHING (pad);
324 g_rec_mutex_init (&pad->stream_rec_lock);
326 g_cond_init (&pad->block_cond);
328 g_hook_list_init (&pad->probes, sizeof (GstProbe));
330 pad->priv->events = g_array_sized_new (FALSE, TRUE, sizeof (PadEvent), 16);
333 /* called when setting the pad inactive. It removes all sticky events from
336 remove_events (GstPad * pad)
341 events = pad->priv->events;
344 for (i = 0; i < len; i++) {
345 PadEvent *ev = &g_array_index (events, PadEvent, i);
346 gst_event_unref (ev->event);
348 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
349 g_array_set_size (events, 0);
350 pad->priv->events_cookie++;
354 find_event_by_type (GstPad * pad, GstEventType type, guint idx)
360 events = pad->priv->events;
363 for (i = 0; i < len; i++) {
364 ev = &g_array_index (events, PadEvent, i);
365 if (ev->event == NULL)
368 if (GST_EVENT_TYPE (ev->event) == type) {
380 find_event (GstPad * pad, GstEvent * event)
386 events = pad->priv->events;
389 for (i = 0; i < len; i++) {
390 ev = &g_array_index (events, PadEvent, i);
391 if (event == ev->event)
400 remove_event_by_type (GstPad * pad, GstEventType type)
406 events = pad->priv->events;
411 ev = &g_array_index (events, PadEvent, i);
412 if (ev->event == NULL)
415 if (GST_EVENT_TYPE (ev->event) != type)
418 gst_event_unref (ev->event);
419 g_array_remove_index (events, i);
421 pad->priv->events_cookie++;
430 schedule_events (GstPad * srcpad, GstPad * sinkpad)
435 gboolean pending = FALSE;
437 events = srcpad->priv->events;
440 for (i = 0; i < len; i++) {
441 ev = &g_array_index (events, PadEvent, i);
442 if (ev->event == NULL)
445 if (sinkpad == NULL || !find_event (sinkpad, ev->event)) {
446 ev->received = FALSE;
451 GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PENDING_EVENTS);
454 typedef gboolean (*PadEventFunction) (GstPad * pad, PadEvent * ev,
458 events_foreach (GstPad * pad, PadEventFunction func, gpointer user_data)
465 events = pad->priv->events;
468 cookie = pad->priv->events_cookie;
472 PadEvent *ev, ev_ret;
474 ev = &g_array_index (events, PadEvent, i);
475 if (G_UNLIKELY (ev->event == NULL))
478 /* take aditional ref, func might release the lock */
479 ev_ret.event = gst_event_ref (ev->event);
480 ev_ret.received = ev->received;
482 ret = func (pad, &ev_ret, user_data);
484 /* recheck the cookie, lock might have been released and the list could have
486 if (G_UNLIKELY (cookie != pad->priv->events_cookie)) {
487 if (G_LIKELY (ev_ret.event))
488 gst_event_unref (ev_ret.event);
492 /* if the event changed, we need to do something */
493 if (G_UNLIKELY (ev->event != ev_ret.event)) {
494 if (G_UNLIKELY (ev_ret.event == NULL)) {
495 /* function unreffed and set the event to NULL, remove it */
496 g_array_remove_index (events, i);
498 cookie = ++pad->priv->events_cookie;
501 /* function gave a new event for us */
502 gst_event_take (&ev->event, ev_ret.event);
505 /* just unref, nothing changed */
506 gst_event_unref (ev_ret.event);
515 /* should be called with LOCK */
517 apply_pad_offset (GstPad * pad, GstEvent * event)
519 /* check if we need to adjust the segment */
520 if (pad->offset != 0) {
523 /* copy segment values */
524 gst_event_copy_segment (event, &segment);
525 gst_event_unref (event);
527 /* adjust and make a new event with the offset applied */
528 segment.base += pad->offset;
529 event = gst_event_new_segment (&segment);
534 /* should be called with the OBJECT_LOCK */
536 get_pad_caps (GstPad * pad)
538 GstCaps *caps = NULL;
541 ev = find_event_by_type (pad, GST_EVENT_CAPS, 0);
543 gst_event_parse_caps (ev->event, &caps);
549 gst_pad_dispose (GObject * object)
551 GstPad *pad = GST_PAD_CAST (object);
554 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pad, "dispose");
556 /* unlink the peer pad */
557 if ((peer = gst_pad_get_peer (pad))) {
558 /* window for MT unsafeness, someone else could unlink here
559 * and then we call unlink with wrong pads. The unlink
560 * function would catch this and safely return failed. */
561 if (GST_PAD_IS_SRC (pad))
562 gst_pad_unlink (pad, peer);
564 gst_pad_unlink (peer, pad);
566 gst_object_unref (peer);
569 gst_pad_set_pad_template (pad, NULL);
573 g_hook_list_clear (&pad->probes);
575 G_OBJECT_CLASS (parent_class)->dispose (object);
579 gst_pad_finalize (GObject * object)
581 GstPad *pad = GST_PAD_CAST (object);
584 /* in case the task is still around, clean it up */
585 if ((task = GST_PAD_TASK (pad))) {
586 gst_task_join (task);
587 GST_PAD_TASK (pad) = NULL;
588 gst_object_unref (task);
591 if (pad->activatenotify)
592 pad->activatenotify (pad->activatedata);
593 if (pad->activatemodenotify)
594 pad->activatemodenotify (pad->activatemodedata);
596 pad->linknotify (pad->linkdata);
597 if (pad->unlinknotify)
598 pad->unlinknotify (pad->unlinkdata);
599 if (pad->chainnotify)
600 pad->chainnotify (pad->chaindata);
601 if (pad->chainlistnotify)
602 pad->chainlistnotify (pad->chainlistdata);
603 if (pad->getrangenotify)
604 pad->getrangenotify (pad->getrangedata);
605 if (pad->eventnotify)
606 pad->eventnotify (pad->eventdata);
607 if (pad->querynotify)
608 pad->querynotify (pad->querydata);
609 if (pad->iterintlinknotify)
610 pad->iterintlinknotify (pad->iterintlinkdata);
612 g_rec_mutex_clear (&pad->stream_rec_lock);
613 g_cond_clear (&pad->block_cond);
614 g_array_free (pad->priv->events, TRUE);
616 G_OBJECT_CLASS (parent_class)->finalize (object);
620 gst_pad_set_property (GObject * object, guint prop_id,
621 const GValue * value, GParamSpec * pspec)
623 g_return_if_fail (GST_IS_PAD (object));
626 case PAD_PROP_DIRECTION:
627 GST_PAD_DIRECTION (object) = (GstPadDirection) g_value_get_enum (value);
629 case PAD_PROP_TEMPLATE:
630 gst_pad_set_pad_template (GST_PAD_CAST (object),
631 (GstPadTemplate *) g_value_get_object (value));
634 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
640 gst_pad_get_property (GObject * object, guint prop_id,
641 GValue * value, GParamSpec * pspec)
643 g_return_if_fail (GST_IS_PAD (object));
647 GST_OBJECT_LOCK (object);
648 g_value_set_boxed (value, get_pad_caps (GST_PAD_CAST (object)));
649 GST_OBJECT_UNLOCK (object);
651 case PAD_PROP_DIRECTION:
652 g_value_set_enum (value, GST_PAD_DIRECTION (object));
654 case PAD_PROP_TEMPLATE:
655 g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
658 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
665 * @name: the name of the new pad.
666 * @direction: the #GstPadDirection of the pad.
668 * Creates a new pad with the given name in the given direction.
669 * If name is NULL, a guaranteed unique name (across all pads)
671 * This function makes a copy of the name so you can safely free the name.
673 * Returns: (transfer floating): a new #GstPad, or NULL in case of an error.
678 gst_pad_new (const gchar * name, GstPadDirection direction)
680 return g_object_new (GST_TYPE_PAD,
681 "name", name, "direction", direction, NULL);
685 * gst_pad_new_from_template:
686 * @templ: the pad template to use
687 * @name: the name of the element
689 * Creates a new pad with the given name from the given template.
690 * If name is NULL, a guaranteed unique name (across all pads)
692 * This function makes a copy of the name so you can safely free the name.
694 * Returns: (transfer full): a new #GstPad, or NULL in case of an error.
697 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
699 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
701 return g_object_new (GST_TYPE_PAD,
702 "name", name, "direction", templ->direction, "template", templ, NULL);
706 * gst_pad_new_from_static_template:
707 * @templ: the #GstStaticPadTemplate to use
708 * @name: the name of the element
710 * Creates a new pad with the given name from the given static template.
711 * If name is NULL, a guaranteed unique name (across all pads)
713 * This function makes a copy of the name so you can safely free the name.
715 * Returns: (transfer full): a new #GstPad, or NULL in case of an error.
718 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
722 GstPadTemplate *template;
724 template = gst_static_pad_template_get (templ);
725 pad = gst_pad_new_from_template (template, name);
726 gst_object_unref (template);
730 #define ACQUIRE_PARENT(pad, parent, label) \
732 if (G_LIKELY ((parent = GST_OBJECT_PARENT (pad)))) \
733 gst_object_ref (parent); \
734 else if (G_LIKELY (GST_PAD_NEEDS_PARENT (pad))) \
738 #define RELEASE_PARENT(parent) \
740 if (G_LIKELY (parent)) \
741 gst_object_unref (parent); \
745 * gst_pad_get_direction:
746 * @pad: a #GstPad to get the direction of.
748 * Gets the direction of the pad. The direction of the pad is
749 * decided at construction time so this function does not take
752 * Returns: the #GstPadDirection of the pad.
757 gst_pad_get_direction (GstPad * pad)
759 GstPadDirection result;
761 /* PAD_UNKNOWN is a little silly but we need some sort of
762 * error return value */
763 g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
765 result = GST_PAD_DIRECTION (pad);
771 gst_pad_activate_default (GstPad * pad, GstObject * parent)
773 return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
777 pre_activate (GstPad * pad, GstPadMode new_mode)
780 case GST_PAD_MODE_NONE:
781 GST_OBJECT_LOCK (pad);
782 GST_DEBUG_OBJECT (pad, "setting PAD_MODE NONE, set flushing");
783 GST_PAD_SET_FLUSHING (pad);
784 GST_PAD_MODE (pad) = new_mode;
785 /* unlock blocked pads so element can resume and stop */
786 GST_PAD_BLOCK_BROADCAST (pad);
787 GST_OBJECT_UNLOCK (pad);
789 case GST_PAD_MODE_PUSH:
790 case GST_PAD_MODE_PULL:
791 GST_OBJECT_LOCK (pad);
792 GST_DEBUG_OBJECT (pad, "setting PAD_MODE %d, unset flushing", new_mode);
793 GST_PAD_UNSET_FLUSHING (pad);
794 GST_PAD_MODE (pad) = new_mode;
795 if (GST_PAD_IS_SINK (pad)) {
797 /* make sure the peer src pad sends us all events */
798 if ((peer = GST_PAD_PEER (pad))) {
799 gst_object_ref (peer);
800 GST_OBJECT_UNLOCK (pad);
802 GST_DEBUG_OBJECT (pad, "reschedule events on peer %s:%s",
803 GST_DEBUG_PAD_NAME (peer));
805 GST_OBJECT_LOCK (peer);
806 schedule_events (peer, NULL);
807 GST_OBJECT_UNLOCK (peer);
809 gst_object_unref (peer);
811 GST_OBJECT_UNLOCK (pad);
814 GST_OBJECT_UNLOCK (pad);
821 post_activate (GstPad * pad, GstPadMode new_mode)
824 case GST_PAD_MODE_NONE:
825 /* ensures that streaming stops */
826 GST_PAD_STREAM_LOCK (pad);
827 GST_DEBUG_OBJECT (pad, "stopped streaming");
828 GST_OBJECT_LOCK (pad);
830 GST_OBJECT_UNLOCK (pad);
831 GST_PAD_STREAM_UNLOCK (pad);
833 case GST_PAD_MODE_PUSH:
834 case GST_PAD_MODE_PULL:
841 * gst_pad_set_active:
842 * @pad: the #GstPad to activate or deactivate.
843 * @active: whether or not the pad should be active.
845 * Activates or deactivates the given pad.
846 * Normally called from within core state change functions.
848 * If @active, makes sure the pad is active. If it is already active, either in
849 * push or pull mode, just return. Otherwise dispatches to the pad's activate
850 * function to perform the actual activation.
852 * If not @active, checks the pad's current mode and calls
853 * gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a
856 * Returns: #TRUE if the operation was successful.
861 gst_pad_set_active (GstPad * pad, gboolean active)
865 gboolean ret = FALSE;
867 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
869 GST_OBJECT_LOCK (pad);
870 old = GST_PAD_MODE (pad);
871 ACQUIRE_PARENT (pad, parent, no_parent);
872 GST_OBJECT_UNLOCK (pad);
875 if (old == GST_PAD_MODE_NONE) {
876 GST_DEBUG_OBJECT (pad, "activating pad from none");
877 ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad, parent);
879 GST_DEBUG_OBJECT (pad, "pad was active in mode %d", old);
883 if (old == GST_PAD_MODE_NONE) {
884 GST_DEBUG_OBJECT (pad, "pad was inactive");
887 GST_DEBUG_OBJECT (pad, "deactivating pad from mode %d", old);
888 ret = gst_pad_activate_mode (pad, old, FALSE);
892 RELEASE_PARENT (parent);
894 if (G_UNLIKELY (!ret))
898 GST_OBJECT_LOCK (pad);
899 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
900 GST_OBJECT_UNLOCK (pad);
907 GST_DEBUG_OBJECT (pad, "no parent");
908 GST_OBJECT_UNLOCK (pad);
913 GST_OBJECT_LOCK (pad);
915 g_critical ("Failed to deactivate pad %s:%s, very bad",
916 GST_DEBUG_PAD_NAME (pad));
918 GST_WARNING_OBJECT (pad, "Failed to activate pad");
920 GST_OBJECT_UNLOCK (pad);
926 * gst_pad_activate_mode:
927 * @pad: the #GstPad to activate or deactivate.
928 * @mode: the requested activation mode
929 * @active: whether or not the pad should be active.
931 * Activates or deactivates the given pad in @mode via dispatching to the
932 * pad's activatemodefunc. For use from within pad activation functions only.
934 * If you don't know what this is, you probably don't want to call it.
936 * Returns: TRUE if the operation was successful.
941 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
943 gboolean res = FALSE;
949 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
951 GST_OBJECT_LOCK (pad);
952 old = GST_PAD_MODE (pad);
953 dir = GST_PAD_DIRECTION (pad);
954 ACQUIRE_PARENT (pad, parent, no_parent);
955 GST_OBJECT_UNLOCK (pad);
957 new = active ? mode : GST_PAD_MODE_NONE;
962 if (active && old != mode) {
963 /* pad was activate in the wrong direction, deactivate it
964 * and reactivate it in the requested mode */
965 GST_DEBUG_OBJECT (pad, "deactivating pad from mode %d", old);
966 if (G_UNLIKELY (!gst_pad_activate_mode (pad, old, FALSE)))
967 goto deactivate_failed;
971 case GST_PAD_MODE_PULL:
973 if (dir == GST_PAD_SINK) {
974 if ((peer = gst_pad_get_peer (pad))) {
975 GST_DEBUG_OBJECT (pad, "calling peer");
976 if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
978 gst_object_unref (peer);
980 /* there is no peer, this is only fatal when we activate. When we
981 * deactivate, we must assume the application has unlinked the peer and
982 * will deactivate it eventually. */
986 GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
989 if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
990 goto failure; /* Can't activate pull on a src without a
999 pre_activate (pad, new);
1001 if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1002 if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1006 /* can happen for sinks of passthrough elements */
1009 post_activate (pad, new);
1011 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in mode %d",
1012 active ? "activated" : "deactivated", mode);
1017 RELEASE_PARENT (parent);
1023 GST_DEBUG_OBJECT (pad, "no parent");
1024 GST_OBJECT_UNLOCK (pad);
1029 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in mode %d",
1030 active ? "activated" : "deactivated", mode);
1035 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1036 "failed to %s in switch to mode %d from mode %d",
1037 (active ? "activate" : "deactivate"), mode, old);
1042 GST_OBJECT_LOCK (peer);
1043 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1044 "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1045 GST_OBJECT_UNLOCK (peer);
1046 gst_object_unref (peer);
1051 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1052 "pad in pull mode");
1057 GST_OBJECT_LOCK (pad);
1058 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in mode %d",
1059 active ? "activate" : "deactivate", mode);
1060 GST_PAD_SET_FLUSHING (pad);
1061 GST_PAD_MODE (pad) = old;
1062 GST_OBJECT_UNLOCK (pad);
1068 * gst_pad_is_active:
1069 * @pad: the #GstPad to query
1071 * Query if a pad is active
1073 * Returns: TRUE if the pad is active.
1078 gst_pad_is_active (GstPad * pad)
1080 gboolean result = FALSE;
1082 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1084 GST_OBJECT_LOCK (pad);
1085 result = GST_PAD_IS_ACTIVE (pad);
1086 GST_OBJECT_UNLOCK (pad);
1092 * gst_pad_add_probe:
1093 * @pad: the #GstPad to add the probe to
1094 * @mask: the probe mask
1095 * @callback: #GstPadProbeCallback that will be called with notifications of
1097 * @user_data: (closure): user data passed to the callback
1098 * @destroy_data: #GDestroyNotify for user_data
1100 * Be notified of different states of pads. The provided callback is called for
1101 * every state that matches @mask.
1103 * Returns: an id or 0 on error. The id can be used to remove the probe with
1104 * gst_pad_remove_probe().
1109 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1110 GstPadProbeCallback callback, gpointer user_data,
1111 GDestroyNotify destroy_data)
1116 g_return_val_if_fail (GST_IS_PAD (pad), 0);
1117 g_return_val_if_fail (mask != 0, 0);
1119 GST_OBJECT_LOCK (pad);
1121 /* make a new probe */
1122 hook = g_hook_alloc (&pad->probes);
1124 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1127 /* when no contraints are given for the types, assume all types are
1129 if ((mask & GST_PAD_PROBE_TYPE_ALL_BOTH) == 0)
1130 mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1131 if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1132 mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1134 /* store our flags and other fields */
1135 hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1136 hook->func = callback;
1137 hook->data = user_data;
1138 hook->destroy = destroy_data;
1139 PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1142 g_hook_prepend (&pad->probes, hook);
1144 /* incremenent cookie so that the new hook get's called */
1145 pad->priv->probe_list_cookie++;
1147 /* get the id of the hook, we return this and it can be used to remove the
1149 res = hook->hook_id;
1151 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1153 if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1154 /* we have a block probe */
1156 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1157 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1158 "now %d blocking probes", pad->num_blocked);
1161 /* call the callback if we need to be called for idle callbacks */
1162 if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1163 if (pad->priv->using > 0) {
1164 /* the pad is in use, we can't signal the idle callback yet. Since we set the
1165 * flag above, the last thread to leave the push will do the callback. New
1166 * threads going into the push will block. */
1167 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1168 "pad is in use, delay idle callback");
1169 GST_OBJECT_UNLOCK (pad);
1171 GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1173 /* the pad is idle now, we can signal the idle callback now */
1174 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1175 "pad is idle, trigger idle callback");
1176 GST_OBJECT_UNLOCK (pad);
1178 callback (pad, &info, user_data);
1181 GST_OBJECT_UNLOCK (pad);
1187 cleanup_hook (GstPad * pad, GHook * hook)
1189 GstPadProbeType type;
1191 type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1193 if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1194 /* unblock when we remove the last blocking probe */
1196 GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1198 if (pad->num_blocked == 0) {
1199 GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1200 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1201 GST_PAD_BLOCK_BROADCAST (pad);
1204 g_hook_destroy_link (&pad->probes, hook);
1209 * gst_pad_remove_probe:
1210 * @pad: the #GstPad with the probe
1211 * @id: the probe id to remove
1213 * Remove the probe with @id from @pad.
1218 gst_pad_remove_probe (GstPad * pad, gulong id)
1222 g_return_if_fail (GST_IS_PAD (pad));
1224 GST_OBJECT_LOCK (pad);
1226 hook = g_hook_get (&pad->probes, id);
1230 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1232 cleanup_hook (pad, hook);
1233 GST_OBJECT_UNLOCK (pad);
1239 GST_OBJECT_UNLOCK (pad);
1240 g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1246 * gst_pad_is_blocked:
1247 * @pad: the #GstPad to query
1249 * Checks if the pad is blocked or not. This function returns the
1250 * last requested state of the pad. It is not certain that the pad
1251 * is actually blocking at this point (see gst_pad_is_blocking()).
1253 * Returns: TRUE if the pad is blocked.
1258 gst_pad_is_blocked (GstPad * pad)
1260 gboolean result = FALSE;
1262 g_return_val_if_fail (GST_IS_PAD (pad), result);
1264 GST_OBJECT_LOCK (pad);
1265 result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1266 GST_OBJECT_UNLOCK (pad);
1272 * gst_pad_is_blocking:
1273 * @pad: the #GstPad to query
1275 * Checks if the pad is blocking or not. This is a guaranteed state
1276 * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1278 * Returns: TRUE if the pad is blocking.
1285 gst_pad_is_blocking (GstPad * pad)
1287 gboolean result = FALSE;
1289 g_return_val_if_fail (GST_IS_PAD (pad), result);
1291 GST_OBJECT_LOCK (pad);
1292 /* the blocking flag is only valid if the pad is not flushing */
1293 result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1294 GST_OBJECT_UNLOCK (pad);
1300 * gst_pad_check_reconfigure:
1301 * @pad: the #GstPad to check
1303 * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1304 * if the flag was set.
1306 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1309 gst_pad_check_reconfigure (GstPad * pad)
1311 gboolean reconfigure;
1313 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1315 GST_OBJECT_LOCK (pad);
1316 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1318 GST_DEBUG_OBJECT (pad, "remove RECONFIGURE flag");
1319 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1320 GST_OBJECT_UNLOCK (pad);
1326 * gst_pad_mark_reconfigure:
1327 * @pad: the #GstPad to mark
1329 * Mark a pad for needing reconfiguration. The next call to
1330 * gst_pad_check_reconfigure() will return %TRUE after this call.
1333 gst_pad_mark_reconfigure (GstPad * pad)
1335 g_return_if_fail (GST_IS_PAD (pad));
1337 GST_OBJECT_LOCK (pad);
1338 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1339 GST_OBJECT_UNLOCK (pad);
1343 * gst_pad_set_activate_function_full:
1345 * @activate: the #GstPadActivateFunction to set.
1346 * @user_data: user_data passed to @notify
1347 * @notify: notify called when @activate will not be used anymore.
1349 * Sets the given activate function for @pad. The activate function will
1350 * dispatch to gst_pad_activate_push() or gst_pad_activate_pull() to perform
1351 * the actual activation. Only makes sense to set on sink pads.
1353 * Call this function if your sink pad can start a pull-based task.
1356 gst_pad_set_activate_function_full (GstPad * pad,
1357 GstPadActivateFunction activate, gpointer user_data, GDestroyNotify notify)
1359 g_return_if_fail (GST_IS_PAD (pad));
1361 if (pad->activatenotify)
1362 pad->activatenotify (pad->activatedata);
1363 GST_PAD_ACTIVATEFUNC (pad) = activate;
1364 pad->activatedata = user_data;
1365 pad->activatenotify = notify;
1367 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1368 GST_DEBUG_FUNCPTR_NAME (activate));
1372 * gst_pad_set_activatemode_function_full:
1374 * @activatemode: the #GstPadActivateModeFunction to set.
1375 * @user_data: user_data passed to @notify
1376 * @notify: notify called when @activatemode will not be used anymore.
1378 * Sets the given activate_mode function for the pad. An activate_mode function
1379 * prepares the element for data passing.
1382 gst_pad_set_activatemode_function_full (GstPad * pad,
1383 GstPadActivateModeFunction activatemode, gpointer user_data,
1384 GDestroyNotify notify)
1386 g_return_if_fail (GST_IS_PAD (pad));
1388 if (pad->activatemodenotify)
1389 pad->activatemodenotify (pad->activatemodedata);
1390 GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1391 pad->activatemodedata = user_data;
1392 pad->activatemodenotify = notify;
1394 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1395 GST_DEBUG_FUNCPTR_NAME (activatemode));
1399 * gst_pad_set_chain_function_full:
1400 * @pad: a sink #GstPad.
1401 * @chain: the #GstPadChainFunction to set.
1402 * @user_data: user_data passed to @notify
1403 * @notify: notify called when @chain will not be used anymore.
1405 * Sets the given chain function for the pad. The chain function is called to
1406 * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1409 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1410 gpointer user_data, GDestroyNotify notify)
1412 g_return_if_fail (GST_IS_PAD (pad));
1413 g_return_if_fail (GST_PAD_IS_SINK (pad));
1415 if (pad->chainnotify)
1416 pad->chainnotify (pad->chaindata);
1417 GST_PAD_CHAINFUNC (pad) = chain;
1418 pad->chaindata = user_data;
1419 pad->chainnotify = notify;
1421 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1422 GST_DEBUG_FUNCPTR_NAME (chain));
1426 * gst_pad_set_chain_list_function_full:
1427 * @pad: a sink #GstPad.
1428 * @chainlist: the #GstPadChainListFunction to set.
1429 * @user_data: user_data passed to @notify
1430 * @notify: notify called when @chainlist will not be used anymore.
1432 * Sets the given chain list function for the pad. The chainlist function is
1433 * called to process a #GstBufferList input buffer list. See
1434 * #GstPadChainListFunction for more details.
1439 gst_pad_set_chain_list_function_full (GstPad * pad,
1440 GstPadChainListFunction chainlist, gpointer user_data,
1441 GDestroyNotify notify)
1443 g_return_if_fail (GST_IS_PAD (pad));
1444 g_return_if_fail (GST_PAD_IS_SINK (pad));
1446 if (pad->chainlistnotify)
1447 pad->chainlistnotify (pad->chainlistdata);
1448 GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1449 pad->chainlistdata = user_data;
1450 pad->chainlistnotify = notify;
1452 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1453 GST_DEBUG_FUNCPTR_NAME (chainlist));
1457 * gst_pad_set_getrange_function_full:
1458 * @pad: a source #GstPad.
1459 * @get: the #GstPadGetRangeFunction to set.
1460 * @user_data: user_data passed to @notify
1461 * @notify: notify called when @get will not be used anymore.
1463 * Sets the given getrange function for the pad. The getrange function is
1464 * called to produce a new #GstBuffer to start the processing pipeline. see
1465 * #GstPadGetRangeFunction for a description of the getrange function.
1468 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1469 gpointer user_data, GDestroyNotify notify)
1471 g_return_if_fail (GST_IS_PAD (pad));
1472 g_return_if_fail (GST_PAD_IS_SRC (pad));
1474 if (pad->getrangenotify)
1475 pad->getrangenotify (pad->getrangedata);
1476 GST_PAD_GETRANGEFUNC (pad) = get;
1477 pad->getrangedata = user_data;
1478 pad->getrangenotify = notify;
1480 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1481 GST_DEBUG_FUNCPTR_NAME (get));
1485 * gst_pad_set_event_function_full:
1486 * @pad: a #GstPad of either direction.
1487 * @event: the #GstPadEventFunction to set.
1488 * @user_data: user_data passed to @notify
1489 * @notify: notify called when @event will not be used anymore.
1491 * Sets the given event handler for the pad.
1494 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1495 gpointer user_data, GDestroyNotify notify)
1497 g_return_if_fail (GST_IS_PAD (pad));
1499 if (pad->eventnotify)
1500 pad->eventnotify (pad->eventdata);
1501 GST_PAD_EVENTFUNC (pad) = event;
1502 pad->eventdata = user_data;
1503 pad->eventnotify = notify;
1505 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1506 GST_DEBUG_FUNCPTR_NAME (event));
1510 * gst_pad_set_query_function_full:
1511 * @pad: a #GstPad of either direction.
1512 * @query: the #GstPadQueryFunction to set.
1513 * @user_data: user_data passed to @notify
1514 * @notify: notify called when @query will not be used anymore.
1516 * Set the given query function for the pad.
1519 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1520 gpointer user_data, GDestroyNotify notify)
1522 g_return_if_fail (GST_IS_PAD (pad));
1524 if (pad->querynotify)
1525 pad->querynotify (pad->querydata);
1526 GST_PAD_QUERYFUNC (pad) = query;
1527 pad->querydata = user_data;
1528 pad->querynotify = notify;
1530 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1531 GST_DEBUG_FUNCPTR_NAME (query));
1535 * gst_pad_set_iterate_internal_links_function_full:
1536 * @pad: a #GstPad of either direction.
1537 * @iterintlink: the #GstPadIterIntLinkFunction to set.
1538 * @user_data: user_data passed to @notify
1539 * @notify: notify called when @iterintlink will not be used anymore.
1541 * Sets the given internal link iterator function for the pad.
1546 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1547 GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1548 GDestroyNotify notify)
1550 g_return_if_fail (GST_IS_PAD (pad));
1552 if (pad->iterintlinknotify)
1553 pad->iterintlinknotify (pad->iterintlinkdata);
1554 GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1555 pad->iterintlinkdata = user_data;
1556 pad->iterintlinknotify = notify;
1558 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1559 GST_DEBUG_FUNCPTR_NAME (iterintlink));
1563 * gst_pad_set_link_function_full:
1565 * @link: the #GstPadLinkFunction to set.
1566 * @user_data: user_data passed to @notify
1567 * @notify: notify called when @link will not be used anymore.
1569 * Sets the given link function for the pad. It will be called when
1570 * the pad is linked with another pad.
1572 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1575 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1576 * cannot be made for some reason.
1578 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1579 * of the peer sink pad, if present.
1582 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1583 gpointer user_data, GDestroyNotify notify)
1585 g_return_if_fail (GST_IS_PAD (pad));
1587 if (pad->linknotify)
1588 pad->linknotify (pad->linkdata);
1589 GST_PAD_LINKFUNC (pad) = link;
1590 pad->linkdata = user_data;
1591 pad->linknotify = notify;
1593 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1594 GST_DEBUG_FUNCPTR_NAME (link));
1598 * gst_pad_set_unlink_function_full:
1600 * @unlink: the #GstPadUnlinkFunction to set.
1601 * @user_data: user_data passed to @notify
1602 * @notify: notify called when @unlink will not be used anymore.
1604 * Sets the given unlink function for the pad. It will be called
1605 * when the pad is unlinked.
1608 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
1609 gpointer user_data, GDestroyNotify notify)
1611 g_return_if_fail (GST_IS_PAD (pad));
1613 if (pad->unlinknotify)
1614 pad->unlinknotify (pad->unlinkdata);
1615 GST_PAD_UNLINKFUNC (pad) = unlink;
1616 pad->unlinkdata = user_data;
1617 pad->unlinknotify = notify;
1619 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1620 GST_DEBUG_FUNCPTR_NAME (unlink));
1625 * @srcpad: the source #GstPad to unlink.
1626 * @sinkpad: the sink #GstPad to unlink.
1628 * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1629 * signal on both pads.
1631 * Returns: TRUE if the pads were unlinked. This function returns FALSE if
1632 * the pads were not linked together.
1637 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1639 gboolean result = FALSE;
1640 GstElement *parent = NULL;
1642 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1643 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1644 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1645 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1647 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1648 GST_DEBUG_PAD_NAME (srcpad), srcpad,
1649 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1651 /* We need to notify the parent before taking any pad locks as the bin in
1652 * question might be waiting for a lock on the pad while holding its lock
1653 * that our message will try to take. */
1654 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
1655 if (GST_IS_ELEMENT (parent)) {
1656 gst_element_post_message (parent,
1657 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1658 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
1660 gst_object_unref (parent);
1665 GST_OBJECT_LOCK (srcpad);
1666 GST_OBJECT_LOCK (sinkpad);
1668 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1669 goto not_linked_together;
1671 if (GST_PAD_UNLINKFUNC (srcpad)) {
1672 GST_PAD_UNLINKFUNC (srcpad) (srcpad);
1674 if (GST_PAD_UNLINKFUNC (sinkpad)) {
1675 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad);
1678 /* first clear peers */
1679 GST_PAD_PEER (srcpad) = NULL;
1680 GST_PAD_PEER (sinkpad) = NULL;
1682 GST_OBJECT_UNLOCK (sinkpad);
1683 GST_OBJECT_UNLOCK (srcpad);
1685 /* fire off a signal to each of the pads telling them
1686 * that they've been unlinked */
1687 g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1688 g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1690 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1691 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1696 if (parent != NULL) {
1697 gst_element_post_message (parent,
1698 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1699 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
1700 gst_object_unref (parent);
1705 not_linked_together:
1707 /* we do not emit a warning in this case because unlinking cannot
1708 * be made MT safe.*/
1709 GST_OBJECT_UNLOCK (sinkpad);
1710 GST_OBJECT_UNLOCK (srcpad);
1716 * gst_pad_is_linked:
1717 * @pad: pad to check
1719 * Checks if a @pad is linked to another pad or not.
1721 * Returns: TRUE if the pad is linked, FALSE otherwise.
1726 gst_pad_is_linked (GstPad * pad)
1730 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1732 GST_OBJECT_LOCK (pad);
1733 result = (GST_PAD_PEER (pad) != NULL);
1734 GST_OBJECT_UNLOCK (pad);
1739 /* get the caps from both pads and see if the intersection
1742 * This function should be called with the pad LOCK on both
1746 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
1747 GstPadLinkCheck flags)
1749 GstCaps *srccaps = NULL;
1750 GstCaps *sinkcaps = NULL;
1751 gboolean compatible = FALSE;
1753 if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
1756 /* Doing the expensive caps checking takes priority over only checking the template caps */
1757 if (flags & GST_PAD_LINK_CHECK_CAPS) {
1758 GST_OBJECT_UNLOCK (sink);
1759 GST_OBJECT_UNLOCK (src);
1761 srccaps = gst_pad_query_caps (src, NULL);
1762 sinkcaps = gst_pad_query_caps (sink, NULL);
1764 GST_OBJECT_LOCK (src);
1765 GST_OBJECT_LOCK (sink);
1767 /* If one of the two pads doesn't have a template, consider the intersection
1769 if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
1770 || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
1774 srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
1776 gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
1779 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
1781 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
1784 /* if we have caps on both pads we can check the intersection. If one
1785 * of the caps is NULL, we return TRUE. */
1786 if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
1788 gst_caps_unref (srccaps);
1790 gst_caps_unref (sinkcaps);
1794 compatible = gst_caps_can_intersect (srccaps, sinkcaps);
1795 gst_caps_unref (srccaps);
1796 gst_caps_unref (sinkcaps);
1799 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
1800 (compatible ? "" : "not"));
1805 /* check if the grandparents of both pads are the same.
1806 * This check is required so that we don't try to link
1807 * pads from elements in different bins without ghostpads.
1809 * The LOCK should be held on both pads
1812 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
1814 GstObject *psrc, *psink;
1816 psrc = GST_OBJECT_PARENT (src);
1817 psink = GST_OBJECT_PARENT (sink);
1819 /* if one of the pads has no parent, we allow the link */
1820 if (G_UNLIKELY (psrc == NULL || psink == NULL))
1823 /* only care about parents that are elements */
1824 if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
1825 goto no_element_parent;
1827 /* if the parents are the same, we have a loop */
1828 if (G_UNLIKELY (psrc == psink))
1831 /* if they both have a parent, we check the grandparents. We can not lock
1832 * the parent because we hold on the child (pad) and the locking order is
1833 * parent >> child. */
1834 psrc = GST_OBJECT_PARENT (psrc);
1835 psink = GST_OBJECT_PARENT (psink);
1837 /* if they have grandparents but they are not the same */
1838 if (G_UNLIKELY (psrc != psink))
1839 goto wrong_grandparents;
1846 GST_CAT_DEBUG (GST_CAT_CAPS,
1847 "one of the pads has no parent %" GST_PTR_FORMAT " and %"
1848 GST_PTR_FORMAT, psrc, psink);
1853 GST_CAT_DEBUG (GST_CAT_CAPS,
1854 "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
1855 GST_PTR_FORMAT, psrc, psink);
1860 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
1866 GST_CAT_DEBUG (GST_CAT_CAPS,
1867 "pads have different grandparents %" GST_PTR_FORMAT " and %"
1868 GST_PTR_FORMAT, psrc, psink);
1873 /* FIXME leftover from an attempt at refactoring... */
1874 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
1875 * the two pads will be locked in the srcpad, sinkpad order. */
1876 static GstPadLinkReturn
1877 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
1879 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1880 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1882 GST_OBJECT_LOCK (srcpad);
1884 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
1885 goto src_was_linked;
1887 GST_OBJECT_LOCK (sinkpad);
1889 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
1890 goto sink_was_linked;
1892 /* check hierarchy, pads can only be linked if the grandparents
1894 if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
1895 && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
1896 goto wrong_hierarchy;
1898 /* check pad caps for non-empty intersection */
1899 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
1902 /* FIXME check pad scheduling for non-empty intersection */
1904 return GST_PAD_LINK_OK;
1908 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
1909 GST_DEBUG_PAD_NAME (srcpad),
1910 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1911 /* we do not emit a warning in this case because unlinking cannot
1912 * be made MT safe.*/
1913 GST_OBJECT_UNLOCK (srcpad);
1914 return GST_PAD_LINK_WAS_LINKED;
1918 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
1919 GST_DEBUG_PAD_NAME (sinkpad),
1920 GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
1921 /* we do not emit a warning in this case because unlinking cannot
1922 * be made MT safe.*/
1923 GST_OBJECT_UNLOCK (sinkpad);
1924 GST_OBJECT_UNLOCK (srcpad);
1925 return GST_PAD_LINK_WAS_LINKED;
1929 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
1930 GST_OBJECT_UNLOCK (sinkpad);
1931 GST_OBJECT_UNLOCK (srcpad);
1932 return GST_PAD_LINK_WRONG_HIERARCHY;
1936 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
1937 GST_OBJECT_UNLOCK (sinkpad);
1938 GST_OBJECT_UNLOCK (srcpad);
1939 return GST_PAD_LINK_NOFORMAT;
1945 * @srcpad: the source #GstPad.
1946 * @sinkpad: the sink #GstPad.
1948 * Checks if the source pad and the sink pad are compatible so they can be
1951 * Returns: TRUE if the pads can be linked.
1954 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
1956 GstPadLinkReturn result;
1958 /* generic checks */
1959 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1960 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1962 GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
1963 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1965 /* gst_pad_link_prepare does everything for us, we only release the locks
1966 * on the pads that it gets us. If this function returns !OK the locks are not
1968 result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
1969 if (result != GST_PAD_LINK_OK)
1972 GST_OBJECT_UNLOCK (srcpad);
1973 GST_OBJECT_UNLOCK (sinkpad);
1976 return result == GST_PAD_LINK_OK;
1980 * gst_pad_link_full:
1981 * @srcpad: the source #GstPad to link.
1982 * @sinkpad: the sink #GstPad to link.
1983 * @flags: the checks to validate when linking
1985 * Links the source pad and the sink pad.
1987 * This variant of #gst_pad_link provides a more granular control on the
1988 * checks being done when linking. While providing some considerable speedups
1989 * the caller of this method must be aware that wrong usage of those flags
1990 * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
1991 * for more information.
1995 * Returns: A result code indicating if the connection worked or
2001 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2003 GstPadLinkReturn result;
2005 GstPadLinkFunction srcfunc, sinkfunc;
2007 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2008 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2009 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2010 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2011 GST_PAD_LINK_WRONG_DIRECTION);
2013 /* Notify the parent early. See gst_pad_unlink for details. */
2014 if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2015 if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2016 gst_element_post_message (parent,
2017 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2018 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2020 gst_object_unref (parent);
2025 /* prepare will also lock the two pads */
2026 result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2028 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2031 /* must set peers before calling the link function */
2032 GST_PAD_PEER (srcpad) = sinkpad;
2033 GST_PAD_PEER (sinkpad) = srcpad;
2035 /* check events, when something is different, mark pending */
2036 schedule_events (srcpad, sinkpad);
2038 /* get the link functions */
2039 srcfunc = GST_PAD_LINKFUNC (srcpad);
2040 sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2042 if (G_UNLIKELY (srcfunc || sinkfunc)) {
2043 /* custom link functions, execute them */
2044 GST_OBJECT_UNLOCK (sinkpad);
2045 GST_OBJECT_UNLOCK (srcpad);
2048 /* this one will call the peer link function */
2049 result = srcfunc (srcpad, sinkpad);
2050 } else if (sinkfunc) {
2051 /* if no source link function, we need to call the sink link
2052 * function ourselves. */
2053 result = sinkfunc (sinkpad, srcpad);
2056 GST_OBJECT_LOCK (srcpad);
2057 GST_OBJECT_LOCK (sinkpad);
2059 /* we released the lock, check if the same pads are linked still */
2060 if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2061 goto concurrent_link;
2063 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2066 GST_OBJECT_UNLOCK (sinkpad);
2067 GST_OBJECT_UNLOCK (srcpad);
2069 /* fire off a signal to each of the pads telling them
2070 * that they've been linked */
2071 g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2072 g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2074 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2075 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2077 gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2080 if (G_LIKELY (parent)) {
2081 gst_element_post_message (parent,
2082 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2083 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2084 gst_object_unref (parent);
2092 GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2093 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2094 GST_OBJECT_UNLOCK (sinkpad);
2095 GST_OBJECT_UNLOCK (srcpad);
2097 /* The other link operation succeeded first */
2098 result = GST_PAD_LINK_WAS_LINKED;
2103 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed",
2104 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2106 GST_PAD_PEER (srcpad) = NULL;
2107 GST_PAD_PEER (sinkpad) = NULL;
2109 GST_OBJECT_UNLOCK (sinkpad);
2110 GST_OBJECT_UNLOCK (srcpad);
2118 * @srcpad: the source #GstPad to link.
2119 * @sinkpad: the sink #GstPad to link.
2121 * Links the source pad and the sink pad.
2123 * Returns: A result code indicating if the connection worked or
2129 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2131 return gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2135 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2137 GstPadTemplate **template_p;
2139 /* this function would need checks if it weren't static */
2141 GST_OBJECT_LOCK (pad);
2142 template_p = &pad->padtemplate;
2143 gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2144 GST_OBJECT_UNLOCK (pad);
2147 gst_pad_template_pad_created (templ, pad);
2151 * gst_pad_get_pad_template:
2154 * Gets the template for @pad.
2156 * Returns: (transfer full): the #GstPadTemplate from which this pad was
2157 * instantiated, or %NULL if this pad has no template. Unref after
2161 gst_pad_get_pad_template (GstPad * pad)
2163 GstPadTemplate *templ;
2165 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2167 templ = GST_PAD_PAD_TEMPLATE (pad);
2169 return (templ ? gst_object_ref (templ) : NULL);
2173 * gst_pad_has_current_caps:
2174 * @pad: a #GstPad to check
2176 * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2178 * Returns: TRUE when @pad has caps associated with it.
2181 gst_pad_has_current_caps (GstPad * pad)
2186 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2188 GST_OBJECT_LOCK (pad);
2189 caps = get_pad_caps (pad);
2190 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2191 "check current pad caps %" GST_PTR_FORMAT, caps);
2192 result = (caps != NULL);
2193 GST_OBJECT_UNLOCK (pad);
2199 * gst_pad_get_current_caps:
2200 * @pad: a #GstPad to get the current capabilities of.
2202 * Gets the capabilities currently configured on @pad with the last
2203 * #GST_EVENT_CAPS event.
2205 * Returns: the current caps of the pad with incremented ref-count.
2208 gst_pad_get_current_caps (GstPad * pad)
2212 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2214 GST_OBJECT_LOCK (pad);
2215 if ((result = get_pad_caps (pad)))
2216 gst_caps_ref (result);
2217 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2218 "get current pad caps %" GST_PTR_FORMAT, result);
2219 GST_OBJECT_UNLOCK (pad);
2226 * @pad: a #GstPad to set the capabilities of.
2227 * @caps: (transfer none): a #GstCaps to set.
2229 * Sets the capabilities of this pad. The caps must be fixed. Any previous
2230 * caps on the pad will be unreffed. This function refs the caps so you should
2231 * unref if as soon as you don't need it anymore.
2232 * It is possible to set NULL caps, which will make the pad unnegotiated
2235 * Returns: TRUE if the caps could be set. FALSE if the caps were not fixed
2236 * or bad parameters were provided to this function.
2241 gst_pad_set_caps (GstPad * pad, GstCaps * caps)
2244 gboolean res = TRUE;
2246 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2247 g_return_val_if_fail (caps != NULL && gst_caps_is_fixed (caps), FALSE);
2249 event = gst_event_new_caps (caps);
2251 if (GST_PAD_IS_SRC (pad))
2252 res = gst_pad_push_event (pad, event);
2254 res = gst_pad_send_event (pad, event);
2260 * gst_pad_get_pad_template_caps:
2261 * @pad: a #GstPad to get the template capabilities from.
2263 * Gets the capabilities for @pad's template.
2265 * Returns: (transfer full): the #GstCaps of this pad template.
2266 * Unref after usage.
2269 gst_pad_get_pad_template_caps (GstPad * pad)
2271 static GstStaticCaps anycaps = GST_STATIC_CAPS ("ANY");
2273 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2275 if (GST_PAD_PAD_TEMPLATE (pad))
2276 return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2278 return gst_static_caps_get (&anycaps);
2283 * @pad: a #GstPad to get the peer of.
2285 * Gets the peer of @pad. This function refs the peer pad so
2286 * you need to unref it after use.
2288 * Returns: (transfer full): the peer #GstPad. Unref after usage.
2293 gst_pad_get_peer (GstPad * pad)
2297 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2299 GST_OBJECT_LOCK (pad);
2300 result = GST_PAD_PEER (pad);
2302 gst_object_ref (result);
2303 GST_OBJECT_UNLOCK (pad);
2309 * gst_pad_get_allowed_caps:
2312 * Gets the capabilities of the allowed media types that can flow through
2313 * @pad and its peer.
2315 * The allowed capabilities is calculated as the intersection of the results of
2316 * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2317 * on the resulting caps.
2319 * Returns: (transfer full): the allowed #GstCaps of the pad link. Unref the
2320 * caps when you no longer need it. This function returns NULL when @pad
2326 gst_pad_get_allowed_caps (GstPad * pad)
2333 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2335 GST_OBJECT_LOCK (pad);
2336 peer = GST_PAD_PEER (pad);
2337 if (G_UNLIKELY (peer == NULL))
2340 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2342 gst_object_ref (peer);
2343 GST_OBJECT_UNLOCK (pad);
2344 mycaps = gst_pad_query_caps (pad, NULL);
2346 peercaps = gst_pad_query_caps (peer, NULL);
2347 gst_object_unref (peer);
2349 caps = gst_caps_intersect (mycaps, peercaps);
2350 gst_caps_unref (peercaps);
2351 gst_caps_unref (mycaps);
2353 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2360 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2361 GST_OBJECT_UNLOCK (pad);
2368 * gst_pad_iterate_internal_links_default:
2369 * @pad: the #GstPad to get the internal links of.
2370 * @parent: the parent of @pad or NULL
2372 * Iterate the list of pads to which the given pad is linked to inside of
2373 * the parent element.
2374 * This is the default handler, and thus returns an iterator of all of the
2375 * pads inside the parent element with opposite direction.
2377 * The caller must free this iterator after use with gst_iterator_free().
2379 * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
2380 * returned pad with gst_object_unref().
2385 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2392 GstElement *eparent;
2394 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2396 if (parent != NULL && GST_IS_ELEMENT (parent)) {
2397 eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2399 GST_OBJECT_LOCK (pad);
2400 eparent = GST_PAD_PARENT (pad);
2401 if (!eparent || !GST_IS_ELEMENT (eparent))
2404 gst_object_ref (eparent);
2405 GST_OBJECT_UNLOCK (pad);
2408 if (pad->direction == GST_PAD_SRC)
2409 padlist = &eparent->sinkpads;
2411 padlist = &eparent->srcpads;
2413 GST_DEBUG_OBJECT (pad, "Making iterator");
2415 cookie = &eparent->pads_cookie;
2417 lock = GST_OBJECT_GET_LOCK (eparent);
2419 res = gst_iterator_new_list (GST_TYPE_PAD,
2420 lock, cookie, padlist, (GObject *) owner, NULL);
2422 gst_object_unref (owner);
2429 GST_OBJECT_UNLOCK (pad);
2430 GST_DEBUG_OBJECT (pad, "no parent element");
2436 * gst_pad_iterate_internal_links:
2437 * @pad: the GstPad to get the internal links of.
2439 * Gets an iterator for the pads to which the given pad is linked to inside
2440 * of the parent element.
2442 * Each #GstPad element yielded by the iterator will have its refcount increased,
2443 * so unref after use.
2445 * Free-function: gst_iterator_free
2447 * Returns: (transfer full): a new #GstIterator of #GstPad or %NULL when the
2448 * pad does not have an iterator function configured. Use
2449 * gst_iterator_free() after usage.
2454 gst_pad_iterate_internal_links (GstPad * pad)
2456 GstIterator *res = NULL;
2459 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2461 GST_OBJECT_LOCK (pad);
2462 ACQUIRE_PARENT (pad, parent, no_parent);
2463 GST_OBJECT_UNLOCK (pad);
2465 if (GST_PAD_ITERINTLINKFUNC (pad))
2466 res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2468 RELEASE_PARENT (parent);
2475 GST_DEBUG_OBJECT (pad, "no parent");
2476 GST_OBJECT_UNLOCK (pad);
2484 * @forward: a #GstPadForwardFunction
2485 * @user_data: user data passed to @forward
2487 * Calls @forward for all internally linked pads of @pad. This function deals with
2488 * dynamically changing internal pads and will make sure that the @forward
2489 * function is only called once for each pad.
2491 * When @forward returns TRUE, no further pads will be processed.
2493 * Returns: TRUE if one of the dispatcher functions returned TRUE.
2496 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2499 gboolean result = FALSE;
2501 gboolean done = FALSE;
2502 GValue item = { 0, };
2503 GList *pushed_pads = NULL;
2505 iter = gst_pad_iterate_internal_links (pad);
2511 switch (gst_iterator_next (iter, &item)) {
2512 case GST_ITERATOR_OK:
2516 intpad = g_value_get_object (&item);
2518 /* if already pushed, skip. FIXME, find something faster to tag pads */
2519 if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2520 g_value_reset (&item);
2524 GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2525 GST_DEBUG_PAD_NAME (intpad));
2526 done = result = forward (intpad, user_data);
2528 pushed_pads = g_list_prepend (pushed_pads, intpad);
2530 g_value_reset (&item);
2533 case GST_ITERATOR_RESYNC:
2534 /* We don't reset the result here because we don't push the event
2535 * again on pads that got the event already and because we need
2536 * to consider the result of the previous pushes */
2537 gst_iterator_resync (iter);
2539 case GST_ITERATOR_ERROR:
2540 GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2543 case GST_ITERATOR_DONE:
2548 g_value_unset (&item);
2549 gst_iterator_free (iter);
2551 g_list_free (pushed_pads);
2561 gboolean dispatched;
2565 event_forward_func (GstPad * pad, EventData * data)
2567 /* for each pad we send to, we should ref the event; it's up
2568 * to downstream to unref again when handled. */
2569 GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2570 data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2572 data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2574 data->dispatched = TRUE;
2581 * gst_pad_event_default:
2582 * @pad: a #GstPad to call the default event handler on.
2583 * @parent: the parent of @pad or NULL
2584 * @event: (transfer full): the #GstEvent to handle.
2586 * Invokes the default event handler for the given pad.
2588 * The EOS event will pause the task associated with @pad before it is forwarded
2589 * to all internally linked pads,
2591 * The the event is sent to all pads internally linked to @pad. This function
2592 * takes ownership of @event.
2594 * Returns: TRUE if the event was sent successfully.
2597 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2599 gboolean result, forward = TRUE;
2601 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2602 g_return_val_if_fail (event != NULL, FALSE);
2604 GST_LOG_OBJECT (pad, "default event handler");
2606 switch (GST_EVENT_TYPE (event)) {
2609 GST_DEBUG_OBJECT (pad, "pausing task because of eos");
2610 gst_pad_pause_task (pad);
2613 case GST_EVENT_CAPS:
2614 forward = GST_PAD_IS_PROXY_CAPS (pad);
2625 data.dispatched = FALSE;
2626 data.result = FALSE;
2628 gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
2630 /* for sinkpads without a parent element or without internal links, nothing
2631 * will be dispatched but we still want to return TRUE. */
2632 if (data.dispatched)
2633 result = data.result;
2638 gst_event_unref (event);
2643 /* Default accept caps implementation just checks against
2644 * the allowed caps for the pad */
2646 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
2648 /* get the caps and see if it intersects to something not empty */
2649 GstCaps *caps, *allowed;
2652 GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
2654 /* first forward the query to internally linked pads when we are dealing with
2656 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2657 if ((result = gst_pad_proxy_query_accept_caps (pad, query))) {
2662 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
2663 "fallback ACCEPT_CAPS query, consider implementing a specialized version");
2665 allowed = gst_pad_query_caps (pad, NULL);
2666 gst_query_parse_accept_caps (query, &caps);
2669 GST_DEBUG_OBJECT (pad, "allowed caps %" GST_PTR_FORMAT, allowed);
2670 result = gst_caps_is_subset (caps, allowed);
2671 gst_caps_unref (allowed);
2673 GST_DEBUG_OBJECT (pad, "no caps allowed on the pad");
2676 gst_query_set_accept_caps_result (query, result);
2682 /* Default caps implementation */
2684 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
2686 GstCaps *result = NULL, *filter;
2687 GstPadTemplate *templ;
2688 gboolean fixed_caps;
2690 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
2692 gst_query_parse_caps (query, &filter);
2694 /* first try to proxy if we must */
2695 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2696 if ((gst_pad_proxy_query_caps (pad, query))) {
2697 gst_query_parse_caps_result (query, &result);
2702 /* no proxy or it failed, do default handling */
2703 fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
2705 GST_OBJECT_LOCK (pad);
2707 /* fixed caps, try the negotiated caps first */
2708 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
2709 if ((result = get_pad_caps (pad)))
2710 goto filter_done_unlock;
2713 if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
2714 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
2715 if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
2716 goto filter_done_unlock;
2720 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2721 "non-fixed pad caps: trying pad caps");
2722 /* non fixed caps, try the negotiated caps */
2723 if ((result = get_pad_caps (pad)))
2724 goto filter_done_unlock;
2726 GST_OBJECT_UNLOCK (pad);
2728 /* this almost never happens */
2729 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
2730 result = gst_caps_new_empty ();
2735 GST_OBJECT_UNLOCK (pad);
2738 /* run the filter on the result */
2740 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2741 "using caps %p %" GST_PTR_FORMAT " with filter %p %"
2742 GST_PTR_FORMAT, result, result, filter, filter);
2743 result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
2744 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
2747 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2748 "using caps %p %" GST_PTR_FORMAT, result, result);
2749 result = gst_caps_ref (result);
2753 gst_query_set_caps_result (query, result);
2754 gst_caps_unref (result);
2760 * gst_pad_query_default:
2761 * @pad: a #GstPad to call the default query handler on.
2762 * @parent: the parent of @pad or NULL
2763 * @query: (transfer none): the #GstQuery to handle.
2765 * Invokes the default query handler for the given pad.
2766 * The query is sent to all pads internally linked to @pad. Note that
2767 * if there are many possible sink pads that are internally linked to
2768 * @pad, only one will be sent the query.
2769 * Multi-sinkpad elements should implement custom query handlers.
2771 * Returns: TRUE if the query was performed successfully.
2774 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
2776 gboolean forward, ret = FALSE;
2778 switch (GST_QUERY_TYPE (query)) {
2779 case GST_QUERY_SCHEDULING:
2782 case GST_QUERY_ALLOCATION:
2783 forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
2785 case GST_QUERY_ACCEPT_CAPS:
2786 ret = gst_pad_query_accept_caps_default (pad, query);
2789 case GST_QUERY_CAPS:
2790 ret = gst_pad_query_caps_default (pad, query);
2793 case GST_QUERY_POSITION:
2794 case GST_QUERY_SEEKING:
2795 case GST_QUERY_FORMATS:
2796 case GST_QUERY_LATENCY:
2797 case GST_QUERY_JITTER:
2798 case GST_QUERY_RATE:
2799 case GST_QUERY_CONVERT:
2806 ret = gst_pad_forward
2807 (pad, (GstPadForwardFunction) gst_pad_peer_query, query);
2813 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
2815 GstPad *pad = data->pad;
2816 GstPadProbeInfo *info = data->info;
2817 GstPadProbeType type, flags;
2818 GstPadProbeCallback callback;
2819 GstPadProbeReturn ret;
2821 /* if we have called this callback, do nothing */
2822 if (PROBE_COOKIE (hook) == data->cookie) {
2823 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2824 "hook %lu, cookie %u already called", hook->hook_id,
2825 PROBE_COOKIE (hook));
2829 PROBE_COOKIE (hook) = data->cookie;
2831 flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
2834 /* one of the data types */
2835 if ((flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
2837 /* one of the scheduling types */
2838 if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
2840 /* one of the blocking types must match */
2841 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
2842 (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
2844 /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
2845 if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
2846 (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
2849 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2850 "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
2851 PROBE_COOKIE (hook), flags);
2853 data->marshalled = TRUE;
2855 callback = (GstPadProbeCallback) hook->func;
2856 if (callback == NULL)
2859 info->id = hook->hook_id;
2861 GST_OBJECT_UNLOCK (pad);
2863 ret = callback (pad, info, hook->data);
2865 GST_OBJECT_LOCK (pad);
2868 case GST_PAD_PROBE_REMOVE:
2869 /* remove the probe */
2870 GST_DEBUG_OBJECT (pad, "asked to remove hook");
2871 cleanup_hook (pad, hook);
2873 case GST_PAD_PROBE_DROP:
2874 /* need to drop the data, make sure other probes don't get called
2876 GST_DEBUG_OBJECT (pad, "asked to drop item");
2877 info->type = GST_PAD_PROBE_TYPE_INVALID;
2878 data->dropped = TRUE;
2880 case GST_PAD_PROBE_PASS:
2881 /* inform the pad block to let things pass */
2882 GST_DEBUG_OBJECT (pad, "asked to pass item");
2886 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
2893 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2894 "hook %lu, cookie %u with flags 0x%08x does not match %08x",
2895 hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
2900 #define PROBE_PRE_PULL(pad,mask,data,offs,size,label,probed,defaultval) \
2902 if (G_UNLIKELY (pad->num_probes)) { \
2903 /* we start with passing NULL as the data item */ \
2904 GstPadProbeInfo info = { mask, 0, NULL, offs, size }; \
2905 ret = do_probe_callbacks (pad, &info, defaultval); \
2906 /* store the possibly updated data item */ \
2907 data = GST_PAD_PROBE_INFO_DATA (&info); \
2908 /* if something went wrong, exit */ \
2909 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
2911 /* otherwise check if the probe retured data */ \
2912 if (G_UNLIKELY (data != NULL)) \
2918 /* a probe that does not take or return any data */
2919 #define PROBE_NO_DATA(pad,mask,label,defaultval) \
2921 if (G_UNLIKELY (pad->num_probes)) { \
2922 /* pass NULL as the data item */ \
2923 GstPadProbeInfo info = { mask, 0, NULL, 0, 0 }; \
2924 ret = do_probe_callbacks (pad, &info, defaultval); \
2925 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
2930 #define PROBE_FULL(pad,mask,data,offs,size,label,defaultval) \
2932 if (G_UNLIKELY (pad->num_probes)) { \
2933 GstPadProbeInfo info = { mask, 0, data, offs, size }; \
2934 ret = do_probe_callbacks (pad, &info, defaultval); \
2935 data = GST_PAD_PROBE_INFO_DATA (&info); \
2936 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
2941 #define PROBE_PUSH(pad,mask,data,label) \
2942 PROBE_FULL(pad, mask, data, -1, -1, label, GST_FLOW_OK);
2943 #define PROBE_PULL(pad,mask,data,offs,size,label) \
2944 PROBE_FULL(pad, mask, data, offs, size, label, GST_FLOW_OK);
2946 static GstFlowReturn
2947 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
2948 GstFlowReturn defaultval)
2957 data.marshalled = FALSE;
2958 data.dropped = FALSE;
2959 data.cookie = ++pad->priv->probe_cookie;
2962 (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
2965 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2966 "do probes cookie %u", data.cookie);
2967 cookie = pad->priv->probe_list_cookie;
2969 g_hook_list_marshal (&pad->probes, TRUE,
2970 (GHookMarshaller) probe_hook_marshal, &data);
2972 /* if the list changed, call the new callbacks (they will not have their
2973 * cookie set to data.cookie */
2974 if (cookie != pad->priv->probe_list_cookie) {
2975 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2976 "probe list changed, restarting");
2980 /* the first item that dropped will stop the hooks and then we drop here */
2984 /* if no handler matched and we are blocking, let the item pass */
2985 if (!data.marshalled && is_block)
2988 /* At this point, all handlers returned either OK or PASS. If one handler
2989 * returned PASS, let the item pass */
2994 while (GST_PAD_IS_BLOCKED (pad)) {
2995 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2996 "we are blocked %d times", pad->num_blocked);
2998 /* we might have released the lock */
2999 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3002 /* now we block the streaming thread. It can be unlocked when we
3003 * deactivate the pad (which will also set the FLUSHING flag) or
3004 * when the pad is unblocked. A flushing event will also unblock
3005 * the pad after setting the FLUSHING flag. */
3006 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3007 "Waiting to be unblocked or set flushing");
3008 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3009 GST_PAD_BLOCK_WAIT (pad);
3010 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3011 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3013 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3023 GST_DEBUG_OBJECT (pad, "pad is flushing");
3024 return GST_FLOW_FLUSHING;
3028 GST_DEBUG_OBJECT (pad, "data is dropped");
3029 return GST_FLOW_CUSTOM_SUCCESS;
3033 /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3034 GST_DEBUG_OBJECT (pad, "data is passed");
3042 * gst_pad_get_offset:
3045 * Get the offset applied to the running time of @pad. @pad has to be a source
3048 * Returns: the offset.
3051 gst_pad_get_offset (GstPad * pad)
3055 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3057 GST_OBJECT_LOCK (pad);
3058 result = pad->offset;
3059 GST_OBJECT_UNLOCK (pad);
3065 * gst_pad_set_offset:
3067 * @offset: the offset
3069 * Set the offset that will be applied to the running time of @pad.
3072 gst_pad_set_offset (GstPad * pad, gint64 offset)
3076 g_return_if_fail (GST_IS_PAD (pad));
3078 GST_OBJECT_LOCK (pad);
3079 /* if nothing changed, do nothing */
3080 if (pad->offset == offset)
3083 pad->offset = offset;
3084 GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3086 /* sinkpads will apply their offset the next time a segment
3087 * event is received. */
3088 if (GST_PAD_IS_SINK (pad))
3091 /* resend the last segment event on next buffer push */
3092 if ((ev = find_event_by_type (pad, GST_EVENT_SEGMENT, 0))) {
3093 ev->received = FALSE;
3094 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3098 GST_OBJECT_UNLOCK (pad);
3104 * @pad: a #GstPad to invoke the default query on.
3105 * @query: (transfer none): the #GstQuery to perform.
3107 * Dispatches a query to a pad. The query should have been allocated by the
3108 * caller via one of the type-specific allocation functions. The element that
3109 * the pad belongs to is responsible for filling the query with an appropriate
3110 * response, which should then be parsed with a type-specific query parsing
3113 * Again, the caller is responsible for both the allocation and deallocation of
3114 * the query structure.
3116 * Please also note that some queries might need a running pipeline to work.
3118 * Returns: TRUE if the query could be performed.
3121 gst_pad_query (GstPad * pad, GstQuery * query)
3125 GstPadQueryFunction func;
3126 GstPadProbeType type;
3129 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3130 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3132 GST_DEBUG_OBJECT (pad, "sending query %p (%s)", query,
3133 GST_QUERY_TYPE_NAME (query));
3135 if (GST_PAD_IS_SRC (pad))
3136 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3138 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3140 GST_OBJECT_LOCK (pad);
3141 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3142 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3143 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3145 ACQUIRE_PARENT (pad, parent, no_parent);
3146 GST_OBJECT_UNLOCK (pad);
3148 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3151 res = func (pad, parent, query);
3153 RELEASE_PARENT (parent);
3155 GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3156 GST_QUERY_TYPE_NAME (query), res);
3161 GST_OBJECT_LOCK (pad);
3162 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3163 GST_OBJECT_UNLOCK (pad);
3170 GST_DEBUG_OBJECT (pad, "had no parent");
3171 GST_OBJECT_UNLOCK (pad);
3176 GST_DEBUG_OBJECT (pad, "had no query function");
3177 RELEASE_PARENT (parent);
3182 GST_DEBUG_OBJECT (pad, "query failed");
3187 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3188 GST_OBJECT_UNLOCK (pad);
3194 * gst_pad_peer_query:
3195 * @pad: a #GstPad to invoke the peer query on.
3196 * @query: (transfer none): the #GstQuery to perform.
3198 * Performs gst_pad_query() on the peer of @pad.
3200 * The caller is responsible for both the allocation and deallocation of
3201 * the query structure.
3203 * Returns: TRUE if the query could be performed. This function returns %FALSE
3204 * if @pad has no peer.
3209 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3212 GstPadProbeType type;
3216 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3217 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3219 if (GST_PAD_IS_SRC (pad))
3220 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3222 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3224 GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
3225 GST_QUERY_TYPE_NAME (query));
3227 GST_OBJECT_LOCK (pad);
3228 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3229 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3230 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3232 peerpad = GST_PAD_PEER (pad);
3233 if (G_UNLIKELY (peerpad == NULL))
3236 gst_object_ref (peerpad);
3237 GST_OBJECT_UNLOCK (pad);
3239 res = gst_pad_query (peerpad, query);
3241 gst_object_unref (peerpad);
3246 GST_OBJECT_LOCK (pad);
3247 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3248 GST_OBJECT_UNLOCK (pad);
3255 GST_WARNING_OBJECT (pad, "pad has no peer");
3256 GST_OBJECT_UNLOCK (pad);
3261 GST_DEBUG_OBJECT (pad, "query failed");
3266 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3267 GST_OBJECT_UNLOCK (pad);
3272 /**********************************************************************
3273 * Data passing functions
3277 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3279 GstFlowReturn *data = user_data;
3283 GST_DEBUG_OBJECT (pad, "event %s was already received",
3284 GST_EVENT_TYPE_NAME (ev->event));
3287 GST_OBJECT_UNLOCK (pad);
3289 *data = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3290 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM, &stored);
3292 GST_OBJECT_LOCK (pad);
3293 return *data == GST_FLOW_OK;
3296 /* this is the chain function that does not perform the additional argument
3297 * checking for that little extra speed.
3299 static inline GstFlowReturn
3300 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
3305 GST_PAD_STREAM_LOCK (pad);
3307 GST_OBJECT_LOCK (pad);
3308 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3311 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3314 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3316 PROBE_PUSH (pad, type, data, probe_stopped);
3318 parent = GST_OBJECT_PARENT (pad);
3319 GST_OBJECT_UNLOCK (pad);
3321 /* NOTE: we read the chainfunc unlocked.
3322 * we cannot hold the lock for the pad so we might send
3323 * the data to the wrong function. This is not really a
3324 * problem since functions are assigned at creation time
3325 * and don't change that often... */
3326 if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
3327 GstPadChainFunction chainfunc;
3329 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3332 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3333 "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
3334 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
3336 ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
3338 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3339 "called chainfunction &%s with buffer %p, returned %s",
3340 GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
3342 GstPadChainListFunction chainlistfunc;
3344 if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
3347 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3348 "calling chainlistfunction &%s",
3349 GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
3351 ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
3353 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3354 "called chainlistfunction &%s, returned %s",
3355 GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
3358 GST_PAD_STREAM_UNLOCK (pad);
3365 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3366 "chaining, but pad was flushing");
3367 GST_OBJECT_UNLOCK (pad);
3368 GST_PAD_STREAM_UNLOCK (pad);
3369 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3370 return GST_FLOW_FLUSHING;
3374 g_critical ("chain on pad %s:%s but it was not in push mode",
3375 GST_DEBUG_PAD_NAME (pad));
3376 GST_OBJECT_UNLOCK (pad);
3377 GST_PAD_STREAM_UNLOCK (pad);
3378 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3379 return GST_FLOW_ERROR;
3383 GST_OBJECT_UNLOCK (pad);
3384 GST_PAD_STREAM_UNLOCK (pad);
3385 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3388 case GST_FLOW_CUSTOM_SUCCESS:
3389 GST_DEBUG_OBJECT (pad, "dropped buffer");
3393 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3400 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3401 g_critical ("chain on pad %s:%s but it has no chainfunction",
3402 GST_DEBUG_PAD_NAME (pad));
3403 GST_PAD_STREAM_UNLOCK (pad);
3404 return GST_FLOW_NOT_SUPPORTED;
3410 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3411 * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
3414 * Chain a buffer to @pad.
3416 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3418 * If the buffer type is not acceptable for @pad (as negotiated with a
3419 * preceeding GST_EVENT_CAPS event), this function returns
3420 * #GST_FLOW_NOT_NEGOTIATED.
3422 * The function proceeds calling the chain function installed on @pad (see
3423 * gst_pad_set_chain_function()) and the return value of that function is
3424 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3427 * In all cases, success or failure, the caller loses its reference to @buffer
3428 * after calling this function.
3430 * Returns: a #GstFlowReturn from the pad.
3435 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
3437 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3438 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3439 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3441 return gst_pad_chain_data_unchecked (pad,
3442 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3445 static GstFlowReturn
3446 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
3447 GstBufferList * list)
3453 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3455 len = gst_buffer_list_length (list);
3458 for (i = 0; i < len; i++) {
3459 buffer = gst_buffer_list_get (list, i);
3461 gst_pad_chain_data_unchecked (pad,
3462 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
3463 gst_buffer_ref (buffer));
3464 if (ret != GST_FLOW_OK)
3467 gst_buffer_list_unref (list);
3473 * gst_pad_chain_list:
3474 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3475 * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
3478 * Chain a bufferlist to @pad.
3480 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3482 * If @pad was not negotiated properly with a CAPS event, this function
3483 * returns #GST_FLOW_NOT_NEGOTIATED.
3485 * The function proceeds calling the chainlist function installed on @pad (see
3486 * gst_pad_set_chain_list_function()) and the return value of that function is
3487 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3488 * chainlist function.
3490 * In all cases, success or failure, the caller loses its reference to @list
3491 * after calling this function.
3495 * Returns: a #GstFlowReturn from the pad.
3500 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
3502 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3503 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3504 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3506 return gst_pad_chain_data_unchecked (pad,
3507 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3510 static GstFlowReturn
3511 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
3516 GST_OBJECT_LOCK (pad);
3517 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3520 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3523 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3524 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3526 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3529 events_foreach (pad, push_sticky, &ret);
3530 if (ret != GST_FLOW_OK)
3534 /* do block probes */
3535 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3537 /* do post-blocking probes */
3538 PROBE_PUSH (pad, type, data, probe_stopped);
3540 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3543 /* take ref to peer pad before releasing the lock */
3544 gst_object_ref (peer);
3546 GST_OBJECT_UNLOCK (pad);
3548 ret = gst_pad_chain_data_unchecked (peer, type, data);
3550 gst_object_unref (peer);
3552 GST_OBJECT_LOCK (pad);
3554 if (pad->priv->using == 0) {
3555 /* pad is not active anymore, trigger idle callbacks */
3556 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
3557 probe_stopped, ret);
3559 GST_OBJECT_UNLOCK (pad);
3563 /* ERROR recovery here */
3567 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3568 "pushing, but pad was flushing");
3569 GST_OBJECT_UNLOCK (pad);
3570 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3571 return GST_FLOW_FLUSHING;
3575 g_critical ("pushing on pad %s:%s but it was not activated in push mode",
3576 GST_DEBUG_PAD_NAME (pad));
3577 GST_OBJECT_UNLOCK (pad);
3578 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3579 return GST_FLOW_ERROR;
3583 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3584 "error pushing events, return %s", gst_flow_get_name (ret));
3585 GST_OBJECT_UNLOCK (pad);
3586 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3591 GST_OBJECT_UNLOCK (pad);
3592 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3595 case GST_FLOW_CUSTOM_SUCCESS:
3596 GST_DEBUG_OBJECT (pad, "dropped buffer");
3600 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3607 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3608 "pushing, but it was not linked");
3609 GST_OBJECT_UNLOCK (pad);
3610 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3611 return GST_FLOW_NOT_LINKED;
3617 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3618 * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
3621 * Pushes a buffer to the peer of @pad.
3623 * This function will call installed block probes before triggering any
3624 * installed data probes.
3626 * The function proceeds calling gst_pad_chain() on the peer pad and returns
3627 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3630 * In all cases, success or failure, the caller loses its reference to @buffer
3631 * after calling this function.
3633 * Returns: a #GstFlowReturn from the peer pad.
3638 gst_pad_push (GstPad * pad, GstBuffer * buffer)
3640 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3641 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3642 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3644 return gst_pad_push_data (pad,
3645 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3649 * gst_pad_push_list:
3650 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3651 * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
3654 * Pushes a buffer list to the peer of @pad.
3656 * This function will call installed block probes before triggering any
3657 * installed data probes.
3659 * The function proceeds calling the chain function on the peer pad and returns
3660 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3661 * be returned. If the peer pad does not have any installed chainlist function
3662 * every group buffer of the list will be merged into a normal #GstBuffer and
3663 * chained via gst_pad_chain().
3665 * In all cases, success or failure, the caller loses its reference to @list
3666 * after calling this function.
3668 * Returns: a #GstFlowReturn from the peer pad.
3675 gst_pad_push_list (GstPad * pad, GstBufferList * list)
3677 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3678 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3679 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3681 return gst_pad_push_data (pad,
3682 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3685 static GstFlowReturn
3686 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
3687 GstBuffer ** buffer)
3690 GstPadGetRangeFunction getrangefunc;
3693 GST_PAD_STREAM_LOCK (pad);
3695 GST_OBJECT_LOCK (pad);
3696 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3699 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
3702 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3703 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3705 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3708 events_foreach (pad, push_sticky, &ret);
3709 if (ret != GST_FLOW_OK)
3713 /* when one of the probes returns a buffer, probed_data will be called and we
3714 * skip calling the getrange function */
3715 PROBE_PRE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
3716 *buffer, offset, size, probe_stopped, probed_data, GST_FLOW_OK);
3718 ACQUIRE_PARENT (pad, parent, no_parent);
3719 GST_OBJECT_UNLOCK (pad);
3721 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
3724 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3725 "calling getrangefunc %s, offset %"
3726 G_GUINT64_FORMAT ", size %u",
3727 GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
3729 ret = getrangefunc (pad, parent, offset, size, buffer);
3731 RELEASE_PARENT (parent);
3733 if (G_UNLIKELY (ret != GST_FLOW_OK))
3734 goto get_range_failed;
3736 /* can only fire the signal if we have a valid buffer */
3737 GST_OBJECT_LOCK (pad);
3739 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
3740 *buffer, offset, size, probe_stopped_unref);
3741 GST_OBJECT_UNLOCK (pad);
3743 GST_PAD_STREAM_UNLOCK (pad);
3750 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3751 "getrange, but pad was flushing");
3752 GST_OBJECT_UNLOCK (pad);
3753 GST_PAD_STREAM_UNLOCK (pad);
3754 return GST_FLOW_FLUSHING;
3758 g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
3759 GST_DEBUG_PAD_NAME (pad));
3760 GST_OBJECT_UNLOCK (pad);
3761 GST_PAD_STREAM_UNLOCK (pad);
3762 return GST_FLOW_ERROR;
3766 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
3767 GST_OBJECT_UNLOCK (pad);
3768 GST_PAD_STREAM_UNLOCK (pad);
3773 GST_DEBUG_OBJECT (pad, "no parent");
3774 GST_OBJECT_UNLOCK (pad);
3775 GST_PAD_STREAM_UNLOCK (pad);
3776 return GST_FLOW_FLUSHING;
3780 g_critical ("getrange on pad %s:%s but it has no getrangefunction",
3781 GST_DEBUG_PAD_NAME (pad));
3782 RELEASE_PARENT (parent);
3783 GST_PAD_STREAM_UNLOCK (pad);
3784 return GST_FLOW_NOT_SUPPORTED;
3788 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3789 "probe returned %s", gst_flow_get_name (ret));
3790 GST_OBJECT_UNLOCK (pad);
3791 GST_PAD_STREAM_UNLOCK (pad);
3794 probe_stopped_unref:
3796 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3797 "probe returned %s", gst_flow_get_name (ret));
3798 GST_OBJECT_UNLOCK (pad);
3799 GST_PAD_STREAM_UNLOCK (pad);
3800 gst_buffer_unref (*buffer);
3806 GST_PAD_STREAM_UNLOCK (pad);
3808 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
3809 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
3810 pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
3816 * gst_pad_get_range:
3817 * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
3818 * @offset: The start offset of the buffer
3819 * @size: The length of the buffer
3820 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
3821 * returns #GST_FLOW_ERROR if %NULL.
3823 * When @pad is flushing this function returns #GST_FLOW_FLUSHING
3824 * immediately and @buffer is %NULL.
3826 * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
3827 * description of a getrange function. If @pad has no getrange function
3828 * installed (see gst_pad_set_getrange_function()) this function returns
3829 * #GST_FLOW_NOT_SUPPORTED.
3831 * This is a lowlevel function. Usualy gst_pad_pull_range() is used.
3833 * Returns: a #GstFlowReturn from the pad.
3838 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
3839 GstBuffer ** buffer)
3841 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3842 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3843 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3845 return gst_pad_get_range_unchecked (pad, offset, size, buffer);
3849 * gst_pad_pull_range:
3850 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3851 * @offset: The start offset of the buffer
3852 * @size: The length of the buffer
3853 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
3854 * GST_FLOW_ERROR if %NULL.
3856 * Pulls a @buffer from the peer pad.
3858 * This function will first trigger the pad block signal if it was
3861 * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
3862 * function returns the result of gst_pad_get_range() on the peer pad.
3863 * See gst_pad_get_range() for a list of return values and for the
3864 * semantics of the arguments of this function.
3866 * Returns: a #GstFlowReturn from the peer pad.
3867 * When this function returns #GST_FLOW_OK, @buffer will contain a valid
3868 * #GstBuffer that should be freed with gst_buffer_unref() after usage.
3869 * @buffer may not be used or freed when any other return value than
3870 * #GST_FLOW_OK is returned.
3875 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
3876 GstBuffer ** buffer)
3881 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3882 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3883 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3885 GST_OBJECT_LOCK (pad);
3886 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3889 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
3892 /* when one of the probes returns a buffer, probed_data will be called and we
3893 * skip calling the peer getrange function */
3894 PROBE_PRE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
3895 *buffer, offset, size, pre_probe_stopped, probed_data, GST_FLOW_OK);
3897 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3900 gst_object_ref (peer);
3902 GST_OBJECT_UNLOCK (pad);
3904 ret = gst_pad_get_range_unchecked (peer, offset, size, buffer);
3906 gst_object_unref (peer);
3908 GST_OBJECT_LOCK (pad);
3910 if (pad->priv->using == 0) {
3911 /* pad is not active anymore, trigger idle callbacks */
3912 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
3913 post_probe_stopped, ret);
3916 if (G_UNLIKELY (ret != GST_FLOW_OK))
3917 goto pull_range_failed;
3920 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
3921 *buffer, offset, size, post_probe_stopped);
3923 GST_OBJECT_UNLOCK (pad);
3927 /* ERROR recovery here */
3930 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3931 "pullrange, but pad was flushing");
3932 GST_OBJECT_UNLOCK (pad);
3933 return GST_FLOW_FLUSHING;
3937 g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
3938 GST_DEBUG_PAD_NAME (pad));
3939 GST_OBJECT_UNLOCK (pad);
3940 return GST_FLOW_ERROR;
3944 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
3945 gst_flow_get_name (ret));
3946 GST_OBJECT_UNLOCK (pad);
3951 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3952 "pulling range, but it was not linked");
3953 GST_OBJECT_UNLOCK (pad);
3954 return GST_FLOW_NOT_LINKED;
3959 GST_OBJECT_UNLOCK (pad);
3960 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
3961 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
3962 pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
3967 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3968 "post probe returned %s", gst_flow_get_name (ret));
3969 GST_OBJECT_UNLOCK (pad);
3970 if (ret == GST_FLOW_OK)
3971 gst_buffer_unref (*buffer);
3978 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event, gboolean locked)
3983 gboolean res = FALSE;
3984 const gchar *name = NULL;
3986 type = GST_EVENT_TYPE (event);
3987 if (type & GST_EVENT_TYPE_STICKY_MULTI)
3988 name = gst_structure_get_name (gst_event_get_structure (event));
3990 events = pad->priv->events;
3993 for (i = 0; i < len; i++) {
3994 PadEvent *ev = &g_array_index (events, PadEvent, i);
3996 if (ev->event == NULL)
3999 if (type == GST_EVENT_TYPE (ev->event)) {
4000 /* matching types, check matching name if needed */
4001 if (name && !gst_event_has_name (ev->event, name))
4005 if ((res = gst_event_replace (&ev->event, event)))
4006 ev->received = FALSE;
4012 ev.event = gst_event_ref (event);
4013 ev.received = FALSE;
4014 g_array_append_val (events, ev);
4019 pad->priv->events_cookie++;
4020 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4022 GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
4024 switch (GST_EVENT_TYPE (event)) {
4025 case GST_EVENT_CAPS:
4027 GST_OBJECT_UNLOCK (pad);
4029 GST_DEBUG_OBJECT (pad, "notify caps");
4030 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
4033 GST_OBJECT_LOCK (pad);
4042 static GstFlowReturn
4043 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
4044 GstPadProbeType type, gboolean * stored)
4048 GstEventType event_type;
4051 sticky = GST_EVENT_IS_STICKY (event);
4053 GST_OBJECT_LOCK (pad);
4055 /* Two checks to be made:
4056 * . (un)set the FLUSHING flag for flushing events,
4057 * . handle pad blocking */
4058 event_type = GST_EVENT_TYPE (event);
4060 switch (event_type) {
4061 case GST_EVENT_FLUSH_START:
4062 GST_PAD_SET_FLUSHING (pad);
4064 GST_PAD_BLOCK_BROADCAST (pad);
4065 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4067 case GST_EVENT_FLUSH_STOP:
4068 GST_PAD_UNSET_FLUSHING (pad);
4070 /* Remove sticky EOS events */
4071 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4072 remove_event_by_type (pad, GST_EVENT_EOS);
4074 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4078 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4081 /* store the event on the pad, but only on srcpads. We always store the
4082 * event exactly how it was sent */
4084 /* srcpad sticky events are store immediately, the received flag is set
4085 * to FALSE and will be set to TRUE when we can successfully push the
4086 * event to the peer pad */
4087 if (gst_pad_store_sticky_event (pad, event, TRUE)) {
4088 GST_DEBUG_OBJECT (pad, "event %s updated",
4089 GST_EVENT_TYPE_NAME (event));
4094 switch (GST_EVENT_TYPE (event)) {
4095 case GST_EVENT_SEGMENT:
4096 /* pass the adjusted segment event on. We need to do this even if
4097 * there is no peer pad because of the probes. */
4098 event = apply_pad_offset (pad, event);
4100 case GST_EVENT_RECONFIGURE:
4101 if (GST_PAD_IS_SINK (pad))
4102 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4107 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4108 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4113 /* send probes after modifying the events above */
4114 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4116 /* now check the peer pad */
4117 peerpad = GST_PAD_PEER (pad);
4118 if (peerpad == NULL)
4121 gst_object_ref (peerpad);
4123 GST_OBJECT_UNLOCK (pad);
4125 GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
4126 event, GST_EVENT_TYPE_NAME (event), peerpad);
4128 ret = gst_pad_send_event_unchecked (peerpad, event, type);
4130 /* Note: we gave away ownership of the event at this point but we can still
4131 * print the old pointer */
4132 GST_LOG_OBJECT (pad,
4133 "sent event %p to peerpad %" GST_PTR_FORMAT ", ret %s", event, peerpad,
4134 gst_flow_get_name (ret));
4136 gst_object_unref (peerpad);
4138 GST_OBJECT_LOCK (pad);
4140 if (ret == GST_FLOW_OK) {
4143 if ((ev = find_event (pad, event)))
4144 ev->received = TRUE;
4146 GST_DEBUG_OBJECT (pad, "event marked received");
4148 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4149 GST_DEBUG_OBJECT (pad, "mark pending events");
4153 if (pad->priv->using == 0) {
4154 /* pad is not active anymore, trigger idle callbacks */
4155 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4156 idle_probe_stopped, ret);
4158 GST_OBJECT_UNLOCK (pad);
4162 /* ERROR handling */
4165 GST_DEBUG_OBJECT (pad, "We're flushing");
4166 GST_OBJECT_UNLOCK (pad);
4167 gst_event_unref (event);
4168 return GST_FLOW_FLUSHING;
4172 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4173 GST_OBJECT_UNLOCK (pad);
4174 gst_event_unref (event);
4177 case GST_FLOW_CUSTOM_SUCCESS:
4178 GST_DEBUG_OBJECT (pad, "dropped event");
4182 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4189 GST_DEBUG_OBJECT (pad, "Dropping event because pad is not linked");
4190 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4191 GST_OBJECT_UNLOCK (pad);
4192 gst_event_unref (event);
4193 return sticky ? GST_FLOW_OK : GST_FLOW_NOT_LINKED;
4197 GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
4198 GST_OBJECT_UNLOCK (pad);
4204 * gst_pad_push_event:
4205 * @pad: a #GstPad to push the event to.
4206 * @event: (transfer full): the #GstEvent to send to the pad.
4208 * Sends the event to the peer of the given pad. This function is
4209 * mainly used by elements to send events to their peer
4212 * This function takes owership of the provided event so you should
4213 * gst_event_ref() it if you want to reuse the event after this call.
4215 * Returns: TRUE if the event was handled.
4220 gst_pad_push_event (GstPad * pad, GstEvent * event)
4223 GstPadProbeType type;
4226 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4227 g_return_val_if_fail (event != NULL, FALSE);
4228 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4230 if (GST_PAD_IS_SRC (pad)) {
4231 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4232 goto wrong_direction;
4233 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4234 } else if (GST_PAD_IS_SINK (pad)) {
4235 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4236 goto wrong_direction;
4237 /* events pushed on sinkpad never are sticky */
4238 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4240 goto unknown_direction;
4242 if (gst_pad_push_event_unchecked (pad, event, type, &stored) != GST_FLOW_OK)
4243 res = stored ? TRUE : FALSE;
4249 /* ERROR handling */
4252 g_warning ("pad %s:%s pushing %s event in wrong direction",
4253 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4254 gst_event_unref (event);
4259 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4260 gst_event_unref (event);
4265 /* Check if we can call the event function with the given event */
4266 static GstFlowReturn
4267 pre_eventfunc_check (GstPad * pad, GstEvent * event)
4269 GstCaps *caps, *templ;
4271 switch (GST_EVENT_TYPE (event)) {
4272 case GST_EVENT_CAPS:
4274 /* backwards compatibility mode for caps */
4275 gst_event_parse_caps (event, &caps);
4277 /* See if pad accepts the caps */
4278 templ = gst_pad_get_pad_template_caps (pad);
4279 if (!gst_caps_is_subset (caps, templ))
4282 gst_caps_unref (templ);
4293 gst_caps_unref (templ);
4294 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
4295 "caps %" GST_PTR_FORMAT " not accepted", caps);
4296 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
4297 "no intersection with template %" GST_PTR_FORMAT, templ);
4298 return GST_FLOW_NOT_NEGOTIATED;
4302 static GstFlowReturn
4303 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
4304 GstPadProbeType type)
4307 GstEventType event_type;
4308 gboolean serialized, need_unlock = FALSE, sticky;
4309 GstPadEventFunction eventfunc;
4312 GST_OBJECT_LOCK (pad);
4313 if (GST_PAD_IS_SINK (pad))
4314 serialized = GST_EVENT_IS_SERIALIZED (event);
4317 sticky = GST_EVENT_IS_STICKY (event);
4318 event_type = GST_EVENT_TYPE (event);
4319 switch (event_type) {
4320 case GST_EVENT_FLUSH_START:
4321 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4322 "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
4324 /* can't even accept a flush begin event when flushing */
4325 if (GST_PAD_IS_FLUSHING (pad))
4328 GST_PAD_SET_FLUSHING (pad);
4329 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
4331 case GST_EVENT_FLUSH_STOP:
4332 if (G_LIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_NONE)) {
4333 GST_PAD_UNSET_FLUSHING (pad);
4334 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
4336 /* Remove pending EOS events */
4337 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4338 remove_event_by_type (pad, GST_EVENT_EOS);
4340 GST_OBJECT_UNLOCK (pad);
4341 /* grab stream lock */
4342 GST_PAD_STREAM_LOCK (pad);
4344 GST_OBJECT_LOCK (pad);
4345 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4348 case GST_EVENT_RECONFIGURE:
4349 if (GST_PAD_IS_SRC (pad))
4350 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4352 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4353 "have event type %" GST_PTR_FORMAT, event);
4355 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4359 /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
4360 GST_OBJECT_UNLOCK (pad);
4361 GST_PAD_STREAM_LOCK (pad);
4363 GST_OBJECT_LOCK (pad);
4364 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4368 switch (GST_EVENT_TYPE (event)) {
4369 case GST_EVENT_SEGMENT:
4370 event = apply_pad_offset (pad, event);
4376 /* now do the probe */
4378 type | GST_PAD_PROBE_TYPE_PUSH |
4379 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4381 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4385 if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
4388 ACQUIRE_PARENT (pad, parent, no_parent);
4389 GST_OBJECT_UNLOCK (pad);
4391 ret = pre_eventfunc_check (pad, event);
4392 if (G_UNLIKELY (ret != GST_FLOW_OK))
4393 goto precheck_failed;
4396 gst_event_ref (event);
4398 if (eventfunc (pad, parent, event)) {
4401 /* something went wrong */
4402 switch (event_type) {
4403 case GST_EVENT_CAPS:
4404 ret = GST_FLOW_NOT_NEGOTIATED;
4407 ret = GST_FLOW_ERROR;
4411 RELEASE_PARENT (parent);
4413 GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
4416 if (ret == GST_FLOW_OK) {
4417 /* after the event function accepted the event, we can store the sticky
4418 * event on the pad */
4419 gst_pad_store_sticky_event (pad, event, FALSE);
4421 gst_event_unref (event);
4425 GST_PAD_STREAM_UNLOCK (pad);
4429 /* ERROR handling */
4432 GST_OBJECT_UNLOCK (pad);
4434 GST_PAD_STREAM_UNLOCK (pad);
4435 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
4436 "Received event on flushing pad. Discarding");
4437 gst_event_unref (event);
4438 return GST_FLOW_FLUSHING;
4442 GST_OBJECT_UNLOCK (pad);
4444 GST_PAD_STREAM_UNLOCK (pad);
4445 gst_event_unref (event);
4448 case GST_FLOW_CUSTOM_SUCCESS:
4449 GST_DEBUG_OBJECT (pad, "dropped event");
4453 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4460 g_warning ("pad %s:%s has no event handler, file a bug.",
4461 GST_DEBUG_PAD_NAME (pad));
4462 GST_OBJECT_UNLOCK (pad);
4464 GST_PAD_STREAM_UNLOCK (pad);
4465 gst_event_unref (event);
4466 return GST_FLOW_NOT_SUPPORTED;
4470 GST_DEBUG_OBJECT (pad, "no parent");
4471 GST_OBJECT_UNLOCK (pad);
4473 GST_PAD_STREAM_UNLOCK (pad);
4474 gst_event_unref (event);
4475 return GST_FLOW_FLUSHING;
4479 GST_DEBUG_OBJECT (pad, "pre event check failed");
4480 RELEASE_PARENT (parent);
4482 GST_PAD_STREAM_UNLOCK (pad);
4483 gst_event_unref (event);
4489 * gst_pad_send_event:
4490 * @pad: a #GstPad to send the event to.
4491 * @event: (transfer full): the #GstEvent to send to the pad.
4493 * Sends the event to the pad. This function can be used
4494 * by applications to send events in the pipeline.
4496 * If @pad is a source pad, @event should be an upstream event. If @pad is a
4497 * sink pad, @event should be a downstream event. For example, you would not
4498 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
4499 * Furthermore, some downstream events have to be serialized with data flow,
4500 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
4501 * the event needs to be serialized with data flow, this function will take the
4502 * pad's stream lock while calling its event function.
4504 * To find out whether an event type is upstream, downstream, or downstream and
4505 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
4506 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
4507 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
4508 * plugin doesn't need to bother itself with this information; the core handles
4509 * all necessary locks and checks.
4511 * This function takes owership of the provided event so you should
4512 * gst_event_ref() it if you want to reuse the event after this call.
4514 * Returns: TRUE if the event was handled.
4517 gst_pad_send_event (GstPad * pad, GstEvent * event)
4520 GstPadProbeType type;
4522 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4523 g_return_val_if_fail (event != NULL, FALSE);
4525 if (GST_PAD_IS_SINK (pad)) {
4526 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4527 goto wrong_direction;
4528 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4529 } else if (GST_PAD_IS_SRC (pad)) {
4530 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4531 goto wrong_direction;
4532 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4534 goto unknown_direction;
4536 if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
4543 /* ERROR handling */
4546 g_warning ("pad %s:%s sending %s event in wrong direction",
4547 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4548 gst_event_unref (event);
4553 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4554 gst_event_unref (event);
4560 * gst_pad_set_element_private:
4561 * @pad: the #GstPad to set the private data of.
4562 * @priv: The private data to attach to the pad.
4564 * Set the given private data gpointer on the pad.
4565 * This function can only be used by the element that owns the pad.
4566 * No locking is performed in this function.
4569 gst_pad_set_element_private (GstPad * pad, gpointer priv)
4571 pad->element_private = priv;
4575 * gst_pad_get_element_private:
4576 * @pad: the #GstPad to get the private data of.
4578 * Gets the private data of a pad.
4579 * No locking is performed in this function.
4581 * Returns: (transfer none): a #gpointer to the private data.
4584 gst_pad_get_element_private (GstPad * pad)
4586 return pad->element_private;
4590 * gst_pad_get_sticky_event:
4591 * @pad: the #GstPad to get the event from.
4592 * @event_type: the #GstEventType that should be retrieved.
4593 * @idx: the index of the event
4595 * Returns a new reference of the sticky event of type @event_type
4598 * Returns: (transfer full): a #GstEvent of type @event_type or NULL when no
4599 * event of @event_type was on @pad. Unref after usage.
4602 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
4604 GstEvent *event = NULL;
4607 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
4608 g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
4610 GST_OBJECT_LOCK (pad);
4611 ev = find_event_by_type (pad, event_type, idx);
4612 if (ev && (event = ev->event))
4613 gst_event_ref (event);
4614 GST_OBJECT_UNLOCK (pad);
4621 GstPadStickyEventsForeachFunction func;
4626 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
4628 ForeachDispatch *data = user_data;
4631 GST_OBJECT_UNLOCK (pad);
4633 ret = data->func (pad, &ev->event, data->user_data);
4635 GST_OBJECT_LOCK (pad);
4641 * gst_pad_sticky_events_foreach:
4642 * @pad: the #GstPad that should be used for iteration.
4643 * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
4644 * should be called for every event.
4645 * @user_data: (closure): the optional user data.
4647 * Iterates all sticky events on @pad and calls @foreach_func for every
4648 * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
4651 gst_pad_sticky_events_foreach (GstPad * pad,
4652 GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
4654 ForeachDispatch data;
4656 g_return_if_fail (GST_IS_PAD (pad));
4657 g_return_if_fail (foreach_func != NULL);
4659 data.func = foreach_func;
4660 data.user_data = user_data;
4662 GST_OBJECT_LOCK (pad);
4663 events_foreach (pad, foreach_dispatch_function, &data);
4664 GST_OBJECT_UNLOCK (pad);
4668 do_stream_status (GstPad * pad, GstStreamStatusType type,
4669 GThread * thread, GstTask * task)
4673 GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
4675 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
4676 if (GST_IS_ELEMENT (parent)) {
4677 GstMessage *message;
4678 GValue value = { 0 };
4680 if (type == GST_STREAM_STATUS_TYPE_ENTER) {
4681 gchar *tname, *ename, *pname;
4683 /* create a good task name */
4684 ename = gst_element_get_name (parent);
4685 pname = gst_pad_get_name (pad);
4686 tname = g_strdup_printf ("%s:%s", ename, pname);
4690 gst_object_set_name (GST_OBJECT_CAST (task), tname);
4694 message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
4697 g_value_init (&value, GST_TYPE_TASK);
4698 g_value_set_object (&value, task);
4699 gst_message_set_stream_status_object (message, &value);
4700 g_value_unset (&value);
4702 GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
4703 gst_element_post_message (parent, message);
4705 gst_object_unref (parent);
4710 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
4712 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
4717 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
4719 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
4723 static GstTaskThreadCallbacks thr_callbacks = {
4729 * gst_pad_start_task:
4730 * @pad: the #GstPad to start the task of
4731 * @func: the task function to call
4732 * @data: data passed to the task function
4734 * Starts a task that repeatedly calls @func with @data. This function
4735 * is mostly used in pad activation functions to start the dataflow.
4736 * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
4737 * before @func is called.
4739 * Returns: a %TRUE if the task could be started.
4742 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer data)
4747 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4748 g_return_val_if_fail (func != NULL, FALSE);
4750 GST_DEBUG_OBJECT (pad, "start task");
4752 GST_OBJECT_LOCK (pad);
4753 task = GST_PAD_TASK (pad);
4755 task = gst_task_new (func, data);
4756 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
4757 gst_task_set_thread_callbacks (task, &thr_callbacks, pad, NULL);
4758 GST_DEBUG_OBJECT (pad, "created task");
4759 GST_PAD_TASK (pad) = task;
4760 gst_object_ref (task);
4761 /* release lock to post the message */
4762 GST_OBJECT_UNLOCK (pad);
4764 do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
4766 gst_object_unref (task);
4768 GST_OBJECT_LOCK (pad);
4769 /* nobody else is supposed to have changed the pad now */
4770 if (GST_PAD_TASK (pad) != task)
4771 goto concurrent_stop;
4773 res = gst_task_set_state (task, GST_TASK_STARTED);
4774 GST_OBJECT_UNLOCK (pad);
4781 GST_OBJECT_UNLOCK (pad);
4787 * gst_pad_pause_task:
4788 * @pad: the #GstPad to pause the task of
4790 * Pause the task of @pad. This function will also wait until the
4791 * function executed by the task is finished if this function is not
4792 * called from the task function.
4794 * Returns: a TRUE if the task could be paused or FALSE when the pad
4798 gst_pad_pause_task (GstPad * pad)
4803 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4805 GST_DEBUG_OBJECT (pad, "pause task");
4807 GST_OBJECT_LOCK (pad);
4808 task = GST_PAD_TASK (pad);
4811 res = gst_task_set_state (task, GST_TASK_PAUSED);
4812 GST_OBJECT_UNLOCK (pad);
4814 /* wait for task function to finish, this lock is recursive so it does nothing
4815 * when the pause is called from the task itself */
4816 GST_PAD_STREAM_LOCK (pad);
4817 GST_PAD_STREAM_UNLOCK (pad);
4823 GST_DEBUG_OBJECT (pad, "pad has no task");
4824 GST_OBJECT_UNLOCK (pad);
4830 * gst_pad_stop_task:
4831 * @pad: the #GstPad to stop the task of
4833 * Stop the task of @pad. This function will also make sure that the
4834 * function executed by the task will effectively stop if not called
4835 * from the GstTaskFunction.
4837 * This function will deadlock if called from the GstTaskFunction of
4838 * the task. Use gst_task_pause() instead.
4840 * Regardless of whether the pad has a task, the stream lock is acquired and
4841 * released so as to ensure that streaming through this pad has finished.
4843 * Returns: a TRUE if the task could be stopped or FALSE on error.
4846 gst_pad_stop_task (GstPad * pad)
4851 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4853 GST_DEBUG_OBJECT (pad, "stop task");
4855 GST_OBJECT_LOCK (pad);
4856 task = GST_PAD_TASK (pad);
4859 GST_PAD_TASK (pad) = NULL;
4860 res = gst_task_set_state (task, GST_TASK_STOPPED);
4861 GST_OBJECT_UNLOCK (pad);
4863 GST_PAD_STREAM_LOCK (pad);
4864 GST_PAD_STREAM_UNLOCK (pad);
4866 if (!gst_task_join (task))
4869 gst_object_unref (task);
4875 GST_DEBUG_OBJECT (pad, "no task");
4876 GST_OBJECT_UNLOCK (pad);
4878 GST_PAD_STREAM_LOCK (pad);
4879 GST_PAD_STREAM_UNLOCK (pad);
4881 /* this is not an error */
4886 /* this is bad, possibly the application tried to join the task from
4887 * the task's thread. We install the task again so that it will be stopped
4888 * again from the right thread next time hopefully. */
4889 GST_OBJECT_LOCK (pad);
4890 GST_DEBUG_OBJECT (pad, "join failed");
4891 /* we can only install this task if there was no other task */
4892 if (GST_PAD_TASK (pad) == NULL)
4893 GST_PAD_TASK (pad) = task;
4894 GST_OBJECT_UNLOCK (pad);