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, #GstQuery, #GstBuffer
28 * A #GstElement is linked to other elements via "pads", which are extremely
29 * light-weight generic link points.
31 * Pads have a #GstPadDirection, source pads produce data, sink pads consume
34 * Pads are typically created from a #GstPadTemplate with
35 * gst_pad_new_from_template() and are then added to a #GstElement. This usually
36 * happens when the element is created but it can also happen dynamically based
37 * on the data that the element is processing or based on the pads that the
38 * application requests.
40 * Pads without pad templates can be created with gst_pad_new(),
41 * which takes a direction and a name as an argument. If the name is NULL,
42 * then a guaranteed unique name will be assigned to it.
44 * A #GstElement creating a pad will typically use the various
45 * gst_pad_set_*_function() calls to register callbacks for events, queries or
46 * dataflow on the pads.
48 * gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
50 * After two pads are retrieved from an element with gst_element_get_pad(),
51 * the pads can be linked with gst_pad_link(). (For quick links,
52 * you can also use gst_element_link(), which will make the obvious
53 * link for you if it's straightforward.). Pads can be unlinked again with
54 * gst_pad_unlink(). gst_pad_get_peer() can be used to check what the pad is
57 * Before dataflow is possible on the pads, they need to be activated with
58 * gst_pad_set_active().
60 * gst_pad_query() and gst_pad_peer_query() can be used to query various
61 * properties of the pad and the stream.
63 * To send a #GstEvent on a pad, use gst_pad_send_event() and
64 * gst_pad_push_event(). Some events will be sticky on the pad, meaning that
65 * after they pass on the pad they can be queried later with
66 * gst_pad_get_sticky_event() and gst_pad_sticky_events_foreach().
67 * gst_pad_get_current_caps() and gst_pad_has_current_caps() are convenience
68 * functions to query the current sticky CAPS event on a pad.
70 * GstElements will use gst_pad_push() and gst_pad_pull_range() to push out
71 * or pull in a buffer.
73 * The dataflow, events and queries that happen on a pad can be monitored with
74 * probes that can be installed with gst_pad_add_probe(). gst_pad_is_blocked()
75 * can be used to check if a block probe is installed on the pad.
76 * gst_pad_is_blocking() checks if the blocking probe is currently blocking the
77 * pad. gst_pad_remove_probe() is used to remove a previously installed probe
78 * and unblock blocking probes if any.
80 * Pad have an offset that can be retrieved with gst_pad_get_offset(). This
81 * offset will be applied to the running_time of all data passing over the pad.
82 * gst_pad_set_offset() can be used to change the offset.
84 * Convenience functions exist to start, pause and stop the task on a pad with
85 * gst_pad_start_task(), gst_pad_pause_task() and gst_pad_stop_task()
88 * Last reviewed on 2012-03-29 (0.11.3)
91 #include "gst_private.h"
94 #include "gstpadtemplate.h"
95 #include "gstenumtypes.h"
100 #include "glib-compat-private.h"
102 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
103 #define GST_CAT_DEFAULT GST_CAT_PADS
105 /* Pad signals and args */
123 #define GST_PAD_GET_PRIVATE(obj) \
124 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PAD, GstPadPrivate))
126 /* we have a pending and an active event on the pad. On source pads only the
127 * active event is used. On sinkpads, events are copied to the pending entry and
128 * moved to the active event when the eventfunc returned TRUE. */
135 struct _GstPadPrivate
141 guint probe_list_cookie;
151 #define PROBE_COOKIE(h) (((GstProbe *)(h))->cookie)
156 GstPadProbeInfo *info;
163 static void gst_pad_dispose (GObject * object);
164 static void gst_pad_finalize (GObject * object);
165 static void gst_pad_set_property (GObject * object, guint prop_id,
166 const GValue * value, GParamSpec * pspec);
167 static void gst_pad_get_property (GObject * object, guint prop_id,
168 GValue * value, GParamSpec * pspec);
170 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
171 static gboolean gst_pad_activate_default (GstPad * pad, GstObject * parent);
172 static GstFlowReturn gst_pad_chain_list_default (GstPad * pad,
173 GstObject * parent, GstBufferList * list);
175 static GstFlowReturn gst_pad_send_event_unchecked (GstPad * pad,
176 GstEvent * event, GstPadProbeType type);
177 static GstFlowReturn gst_pad_push_event_unchecked (GstPad * pad,
178 GstEvent * event, GstPadProbeType type);
180 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
182 static GParamSpec *pspec_caps = NULL;
184 /* quarks for probe signals */
185 static GQuark buffer_quark;
186 static GQuark buffer_list_quark;
187 static GQuark event_quark;
196 static GstFlowQuarks flow_quarks[] = {
197 {GST_FLOW_CUSTOM_SUCCESS, "custom-success", 0},
198 {GST_FLOW_OK, "ok", 0},
199 {GST_FLOW_NOT_LINKED, "not-linked", 0},
200 {GST_FLOW_FLUSHING, "flushing", 0},
201 {GST_FLOW_EOS, "eos", 0},
202 {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
203 {GST_FLOW_ERROR, "error", 0},
204 {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
205 {GST_FLOW_CUSTOM_ERROR, "custom-error", 0}
210 * @ret: a #GstFlowReturn to get the name of.
212 * Gets a string representing the given flow return.
214 * Returns: a static string with the name of the flow return.
217 gst_flow_get_name (GstFlowReturn ret)
221 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
223 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
224 if (ret == flow_quarks[i].ret)
225 return flow_quarks[i].name;
232 * @ret: a #GstFlowReturn to get the quark of.
234 * Get the unique quark for the given GstFlowReturn.
236 * Returns: the quark associated with the flow return or 0 if an
237 * invalid return was specified.
240 gst_flow_to_quark (GstFlowReturn ret)
244 ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
246 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
247 if (ret == flow_quarks[i].ret)
248 return flow_quarks[i].quark;
257 buffer_quark = g_quark_from_static_string ("buffer"); \
258 buffer_list_quark = g_quark_from_static_string ("bufferlist"); \
259 event_quark = g_quark_from_static_string ("event"); \
261 for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) { \
262 flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name); \
265 GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW", \
266 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads"); \
269 #define gst_pad_parent_class parent_class
270 G_DEFINE_TYPE_WITH_CODE (GstPad, gst_pad, GST_TYPE_OBJECT, _do_init);
273 gst_pad_class_init (GstPadClass * klass)
275 GObjectClass *gobject_class;
276 GstObjectClass *gstobject_class;
278 gobject_class = G_OBJECT_CLASS (klass);
279 gstobject_class = GST_OBJECT_CLASS (klass);
281 g_type_class_add_private (klass, sizeof (GstPadPrivate));
283 gobject_class->dispose = gst_pad_dispose;
284 gobject_class->finalize = gst_pad_finalize;
285 gobject_class->set_property = gst_pad_set_property;
286 gobject_class->get_property = gst_pad_get_property;
290 * @pad: the pad that emitted the signal
291 * @peer: the peer pad that has been connected
293 * Signals that a pad has been linked to the peer pad.
295 gst_pad_signals[PAD_LINKED] =
296 g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
297 G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
298 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
301 * @pad: the pad that emitted the signal
302 * @peer: the peer pad that has been disconnected
304 * Signals that a pad has been unlinked from the peer pad.
306 gst_pad_signals[PAD_UNLINKED] =
307 g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
308 G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
309 g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
311 pspec_caps = g_param_spec_boxed ("caps", "Caps",
312 "The capabilities of the pad", GST_TYPE_CAPS,
313 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
314 g_object_class_install_property (gobject_class, PAD_PROP_CAPS, pspec_caps);
316 g_object_class_install_property (gobject_class, PAD_PROP_DIRECTION,
317 g_param_spec_enum ("direction", "Direction", "The direction of the pad",
318 GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
319 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
321 /* FIXME, Make G_PARAM_CONSTRUCT_ONLY when we fix ghostpads. */
322 g_object_class_install_property (gobject_class, PAD_PROP_TEMPLATE,
323 g_param_spec_object ("template", "Template",
324 "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
325 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
327 gstobject_class->path_string_separator = ".";
329 /* Register common function pointer descriptions */
330 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_activate_default);
331 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_event_default);
332 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_query_default);
333 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_iterate_internal_links_default);
334 GST_DEBUG_REGISTER_FUNCPTR (gst_pad_chain_list_default);
338 gst_pad_init (GstPad * pad)
340 pad->priv = GST_PAD_GET_PRIVATE (pad);
342 GST_PAD_DIRECTION (pad) = GST_PAD_UNKNOWN;
344 GST_PAD_ACTIVATEFUNC (pad) = gst_pad_activate_default;
345 GST_PAD_EVENTFUNC (pad) = gst_pad_event_default;
346 GST_PAD_QUERYFUNC (pad) = gst_pad_query_default;
347 GST_PAD_ITERINTLINKFUNC (pad) = gst_pad_iterate_internal_links_default;
348 GST_PAD_CHAINLISTFUNC (pad) = gst_pad_chain_list_default;
350 GST_PAD_SET_FLUSHING (pad);
352 g_rec_mutex_init (&pad->stream_rec_lock);
354 g_cond_init (&pad->block_cond);
356 g_hook_list_init (&pad->probes, sizeof (GstProbe));
358 pad->priv->events = g_array_sized_new (FALSE, TRUE, sizeof (PadEvent), 16);
361 /* called when setting the pad inactive. It removes all sticky events from
364 remove_events (GstPad * pad)
369 events = pad->priv->events;
372 for (i = 0; i < len; i++) {
373 PadEvent *ev = &g_array_index (events, PadEvent, i);
374 gst_event_unref (ev->event);
376 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
377 g_array_set_size (events, 0);
378 pad->priv->events_cookie++;
382 find_event_by_type (GstPad * pad, GstEventType type, guint idx)
388 events = pad->priv->events;
391 for (i = 0; i < len; i++) {
392 ev = &g_array_index (events, PadEvent, i);
393 if (ev->event == NULL)
396 if (GST_EVENT_TYPE (ev->event) == type) {
408 find_event (GstPad * pad, GstEvent * event)
414 events = pad->priv->events;
417 for (i = 0; i < len; i++) {
418 ev = &g_array_index (events, PadEvent, i);
419 if (event == ev->event)
428 remove_event_by_type (GstPad * pad, GstEventType type)
434 events = pad->priv->events;
439 ev = &g_array_index (events, PadEvent, i);
440 if (ev->event == NULL)
443 if (GST_EVENT_TYPE (ev->event) != type)
446 gst_event_unref (ev->event);
447 g_array_remove_index (events, i);
449 pad->priv->events_cookie++;
457 /* check all events on srcpad against those on sinkpad. All events that are not
458 * on sinkpad are marked as received=FALSE and the PENDING_EVENTS is set on the
459 * srcpad so that the events will be sent next time */
461 schedule_events (GstPad * srcpad, GstPad * sinkpad)
466 gboolean pending = FALSE;
468 events = srcpad->priv->events;
471 for (i = 0; i < len; i++) {
472 ev = &g_array_index (events, PadEvent, i);
473 if (ev->event == NULL)
476 if (sinkpad == NULL || !find_event (sinkpad, ev->event)) {
477 ev->received = FALSE;
482 GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PENDING_EVENTS);
485 typedef gboolean (*PadEventFunction) (GstPad * pad, PadEvent * ev,
488 /* should be called with pad LOCK */
490 events_foreach (GstPad * pad, PadEventFunction func, gpointer user_data)
497 events = pad->priv->events;
500 cookie = pad->priv->events_cookie;
504 PadEvent *ev, ev_ret;
506 ev = &g_array_index (events, PadEvent, i);
507 if (G_UNLIKELY (ev->event == NULL))
510 /* take aditional ref, func might release the lock */
511 ev_ret.event = gst_event_ref (ev->event);
512 ev_ret.received = ev->received;
514 ret = func (pad, &ev_ret, user_data);
516 /* recheck the cookie, lock might have been released and the list could have
518 if (G_UNLIKELY (cookie != pad->priv->events_cookie)) {
519 if (G_LIKELY (ev_ret.event))
520 gst_event_unref (ev_ret.event);
524 /* store the received state */
525 ev->received = ev_ret.received;
527 /* if the event changed, we need to do something */
528 if (G_UNLIKELY (ev->event != ev_ret.event)) {
529 if (G_UNLIKELY (ev_ret.event == NULL)) {
530 /* function unreffed and set the event to NULL, remove it */
531 g_array_remove_index (events, i);
533 cookie = ++pad->priv->events_cookie;
536 /* function gave a new event for us */
537 gst_event_take (&ev->event, ev_ret.event);
540 /* just unref, nothing changed */
541 gst_event_unref (ev_ret.event);
550 /* should be called with LOCK */
552 apply_pad_offset (GstPad * pad, GstEvent * event)
554 /* check if we need to adjust the segment */
555 if (pad->offset != 0) {
558 /* copy segment values */
559 gst_event_copy_segment (event, &segment);
560 gst_event_unref (event);
562 /* adjust and make a new event with the offset applied */
563 segment.base += pad->offset;
564 event = gst_event_new_segment (&segment);
569 /* should be called with the OBJECT_LOCK */
571 get_pad_caps (GstPad * pad)
573 GstCaps *caps = NULL;
576 ev = find_event_by_type (pad, GST_EVENT_CAPS, 0);
578 gst_event_parse_caps (ev->event, &caps);
584 gst_pad_dispose (GObject * object)
586 GstPad *pad = GST_PAD_CAST (object);
589 GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pad, "dispose");
591 /* unlink the peer pad */
592 if ((peer = gst_pad_get_peer (pad))) {
593 /* window for MT unsafeness, someone else could unlink here
594 * and then we call unlink with wrong pads. The unlink
595 * function would catch this and safely return failed. */
596 if (GST_PAD_IS_SRC (pad))
597 gst_pad_unlink (pad, peer);
599 gst_pad_unlink (peer, pad);
601 gst_object_unref (peer);
604 gst_pad_set_pad_template (pad, NULL);
608 g_hook_list_clear (&pad->probes);
610 G_OBJECT_CLASS (parent_class)->dispose (object);
614 gst_pad_finalize (GObject * object)
616 GstPad *pad = GST_PAD_CAST (object);
619 /* in case the task is still around, clean it up */
620 if ((task = GST_PAD_TASK (pad))) {
621 gst_task_join (task);
622 GST_PAD_TASK (pad) = NULL;
623 gst_object_unref (task);
626 if (pad->activatenotify)
627 pad->activatenotify (pad->activatedata);
628 if (pad->activatemodenotify)
629 pad->activatemodenotify (pad->activatemodedata);
631 pad->linknotify (pad->linkdata);
632 if (pad->unlinknotify)
633 pad->unlinknotify (pad->unlinkdata);
634 if (pad->chainnotify)
635 pad->chainnotify (pad->chaindata);
636 if (pad->chainlistnotify)
637 pad->chainlistnotify (pad->chainlistdata);
638 if (pad->getrangenotify)
639 pad->getrangenotify (pad->getrangedata);
640 if (pad->eventnotify)
641 pad->eventnotify (pad->eventdata);
642 if (pad->querynotify)
643 pad->querynotify (pad->querydata);
644 if (pad->iterintlinknotify)
645 pad->iterintlinknotify (pad->iterintlinkdata);
647 g_rec_mutex_clear (&pad->stream_rec_lock);
648 g_cond_clear (&pad->block_cond);
649 g_array_free (pad->priv->events, TRUE);
651 G_OBJECT_CLASS (parent_class)->finalize (object);
655 gst_pad_set_property (GObject * object, guint prop_id,
656 const GValue * value, GParamSpec * pspec)
658 g_return_if_fail (GST_IS_PAD (object));
661 case PAD_PROP_DIRECTION:
662 GST_PAD_DIRECTION (object) = (GstPadDirection) g_value_get_enum (value);
664 case PAD_PROP_TEMPLATE:
665 gst_pad_set_pad_template (GST_PAD_CAST (object),
666 (GstPadTemplate *) g_value_get_object (value));
669 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
675 gst_pad_get_property (GObject * object, guint prop_id,
676 GValue * value, GParamSpec * pspec)
678 g_return_if_fail (GST_IS_PAD (object));
682 GST_OBJECT_LOCK (object);
683 g_value_set_boxed (value, get_pad_caps (GST_PAD_CAST (object)));
684 GST_OBJECT_UNLOCK (object);
686 case PAD_PROP_DIRECTION:
687 g_value_set_enum (value, GST_PAD_DIRECTION (object));
689 case PAD_PROP_TEMPLATE:
690 g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
693 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
700 * @name: the name of the new pad.
701 * @direction: the #GstPadDirection of the pad.
703 * Creates a new pad with the given name in the given direction.
704 * If name is NULL, a guaranteed unique name (across all pads)
706 * This function makes a copy of the name so you can safely free the name.
708 * Returns: (transfer floating): a new #GstPad, or NULL in case of an error.
713 gst_pad_new (const gchar * name, GstPadDirection direction)
715 return g_object_new (GST_TYPE_PAD,
716 "name", name, "direction", direction, NULL);
720 * gst_pad_new_from_template:
721 * @templ: the pad template to use
722 * @name: the name of the element
724 * Creates a new pad with the given name from the given template.
725 * If name is NULL, a guaranteed unique name (across all pads)
727 * This function makes a copy of the name so you can safely free the name.
729 * Returns: (transfer full): a new #GstPad, or NULL in case of an error.
732 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
734 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
736 return g_object_new (GST_TYPE_PAD,
737 "name", name, "direction", templ->direction, "template", templ, NULL);
741 * gst_pad_new_from_static_template:
742 * @templ: the #GstStaticPadTemplate to use
743 * @name: the name of the element
745 * Creates a new pad with the given name from the given static template.
746 * If name is NULL, a guaranteed unique name (across all pads)
748 * This function makes a copy of the name so you can safely free the name.
750 * Returns: (transfer full): a new #GstPad, or NULL in case of an error.
753 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
757 GstPadTemplate *template;
759 template = gst_static_pad_template_get (templ);
760 pad = gst_pad_new_from_template (template, name);
761 gst_object_unref (template);
765 #define ACQUIRE_PARENT(pad, parent, label) \
767 if (G_LIKELY ((parent = GST_OBJECT_PARENT (pad)))) \
768 gst_object_ref (parent); \
769 else if (G_LIKELY (GST_PAD_NEEDS_PARENT (pad))) \
773 #define RELEASE_PARENT(parent) \
775 if (G_LIKELY (parent)) \
776 gst_object_unref (parent); \
780 * gst_pad_get_direction:
781 * @pad: a #GstPad to get the direction of.
783 * Gets the direction of the pad. The direction of the pad is
784 * decided at construction time so this function does not take
787 * Returns: the #GstPadDirection of the pad.
792 gst_pad_get_direction (GstPad * pad)
794 GstPadDirection result;
796 /* PAD_UNKNOWN is a little silly but we need some sort of
797 * error return value */
798 g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
800 result = GST_PAD_DIRECTION (pad);
806 gst_pad_activate_default (GstPad * pad, GstObject * parent)
808 return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
811 #ifndef GST_DISABLE_GST_DEBUG
813 gst_pad_mode_get_name (GstPadMode mode)
816 case GST_PAD_MODE_NONE:
818 case GST_PAD_MODE_PUSH:
820 case GST_PAD_MODE_PULL:
830 pre_activate (GstPad * pad, GstPadMode new_mode)
833 case GST_PAD_MODE_NONE:
834 GST_OBJECT_LOCK (pad);
835 GST_DEBUG_OBJECT (pad, "setting PAD_MODE NONE, set flushing");
836 GST_PAD_SET_FLUSHING (pad);
837 GST_PAD_MODE (pad) = new_mode;
838 /* unlock blocked pads so element can resume and stop */
839 GST_PAD_BLOCK_BROADCAST (pad);
840 GST_OBJECT_UNLOCK (pad);
842 case GST_PAD_MODE_PUSH:
843 case GST_PAD_MODE_PULL:
844 GST_OBJECT_LOCK (pad);
845 GST_DEBUG_OBJECT (pad, "setting pad into %s mode, unset flushing",
846 gst_pad_mode_get_name (new_mode));
847 GST_PAD_UNSET_FLUSHING (pad);
848 GST_PAD_MODE (pad) = new_mode;
849 if (GST_PAD_IS_SINK (pad)) {
851 /* make sure the peer src pad sends us all events */
852 if ((peer = GST_PAD_PEER (pad))) {
853 gst_object_ref (peer);
854 GST_OBJECT_UNLOCK (pad);
856 GST_DEBUG_OBJECT (pad, "reschedule events on peer %s:%s",
857 GST_DEBUG_PAD_NAME (peer));
859 GST_OBJECT_LOCK (peer);
860 schedule_events (peer, NULL);
861 GST_OBJECT_UNLOCK (peer);
863 gst_object_unref (peer);
865 GST_OBJECT_UNLOCK (pad);
868 GST_OBJECT_UNLOCK (pad);
875 post_activate (GstPad * pad, GstPadMode new_mode)
878 case GST_PAD_MODE_NONE:
879 /* ensures that streaming stops */
880 GST_PAD_STREAM_LOCK (pad);
881 GST_DEBUG_OBJECT (pad, "stopped streaming");
882 GST_OBJECT_LOCK (pad);
884 GST_OBJECT_UNLOCK (pad);
885 GST_PAD_STREAM_UNLOCK (pad);
887 case GST_PAD_MODE_PUSH:
888 case GST_PAD_MODE_PULL:
895 * gst_pad_set_active:
896 * @pad: the #GstPad to activate or deactivate.
897 * @active: whether or not the pad should be active.
899 * Activates or deactivates the given pad.
900 * Normally called from within core state change functions.
902 * If @active, makes sure the pad is active. If it is already active, either in
903 * push or pull mode, just return. Otherwise dispatches to the pad's activate
904 * function to perform the actual activation.
906 * If not @active, checks the pad's current mode and calls
907 * gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a
910 * Returns: #TRUE if the operation was successful.
915 gst_pad_set_active (GstPad * pad, gboolean active)
919 gboolean ret = FALSE;
921 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
923 GST_OBJECT_LOCK (pad);
924 old = GST_PAD_MODE (pad);
925 ACQUIRE_PARENT (pad, parent, no_parent);
926 GST_OBJECT_UNLOCK (pad);
929 if (old == GST_PAD_MODE_NONE) {
930 GST_DEBUG_OBJECT (pad, "activating pad from none");
931 ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad, parent);
933 GST_DEBUG_OBJECT (pad, "pad was active in %s mode",
934 gst_pad_mode_get_name (old));
938 if (old == GST_PAD_MODE_NONE) {
939 GST_DEBUG_OBJECT (pad, "pad was inactive");
942 GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
943 gst_pad_mode_get_name (old));
944 ret = gst_pad_activate_mode (pad, old, FALSE);
948 RELEASE_PARENT (parent);
950 if (G_UNLIKELY (!ret))
958 GST_DEBUG_OBJECT (pad, "no parent");
959 GST_OBJECT_UNLOCK (pad);
964 GST_OBJECT_LOCK (pad);
966 g_critical ("Failed to deactivate pad %s:%s, very bad",
967 GST_DEBUG_PAD_NAME (pad));
969 GST_WARNING_OBJECT (pad, "Failed to activate pad");
971 GST_OBJECT_UNLOCK (pad);
977 * gst_pad_activate_mode:
978 * @pad: the #GstPad to activate or deactivate.
979 * @mode: the requested activation mode
980 * @active: whether or not the pad should be active.
982 * Activates or deactivates the given pad in @mode via dispatching to the
983 * pad's activatemodefunc. For use from within pad activation functions only.
985 * If you don't know what this is, you probably don't want to call it.
987 * Returns: TRUE if the operation was successful.
992 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
994 gboolean res = FALSE;
1000 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1002 GST_OBJECT_LOCK (pad);
1003 old = GST_PAD_MODE (pad);
1004 dir = GST_PAD_DIRECTION (pad);
1005 ACQUIRE_PARENT (pad, parent, no_parent);
1006 GST_OBJECT_UNLOCK (pad);
1008 new = active ? mode : GST_PAD_MODE_NONE;
1013 if (active && old != mode && old != GST_PAD_MODE_NONE) {
1014 /* pad was activate in the wrong direction, deactivate it
1015 * and reactivate it in the requested mode */
1016 GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1017 gst_pad_mode_get_name (old));
1019 if (G_UNLIKELY (!gst_pad_activate_mode (pad, old, FALSE)))
1020 goto deactivate_failed;
1024 case GST_PAD_MODE_PULL:
1026 if (dir == GST_PAD_SINK) {
1027 if ((peer = gst_pad_get_peer (pad))) {
1028 GST_DEBUG_OBJECT (pad, "calling peer");
1029 if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
1031 gst_object_unref (peer);
1033 /* there is no peer, this is only fatal when we activate. When we
1034 * deactivate, we must assume the application has unlinked the peer and
1035 * will deactivate it eventually. */
1039 GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
1042 if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
1043 goto failure; /* Can't activate pull on a src without a
1044 getrange function */
1052 pre_activate (pad, new);
1054 if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1055 if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1059 /* can happen for sinks of passthrough elements */
1062 post_activate (pad, new);
1064 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in %s mode",
1065 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1070 /* Clear sticky flags on deactivation */
1072 GST_OBJECT_LOCK (pad);
1073 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1074 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
1075 GST_OBJECT_UNLOCK (pad);
1079 RELEASE_PARENT (parent);
1085 GST_DEBUG_OBJECT (pad, "no parent");
1086 GST_OBJECT_UNLOCK (pad);
1091 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in %s mode",
1092 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1097 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1098 "failed to %s in switch to %s mode from %s mode",
1099 (active ? "activate" : "deactivate"), gst_pad_mode_get_name (mode),
1100 gst_pad_mode_get_name (old));
1105 GST_OBJECT_LOCK (peer);
1106 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1107 "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1108 GST_OBJECT_UNLOCK (peer);
1109 gst_object_unref (peer);
1114 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1115 "pad in pull mode");
1120 GST_OBJECT_LOCK (pad);
1121 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in %s mode",
1122 active ? "activate" : "deactivate", gst_pad_mode_get_name (mode));
1123 GST_PAD_SET_FLUSHING (pad);
1124 GST_PAD_MODE (pad) = old;
1125 GST_OBJECT_UNLOCK (pad);
1131 * gst_pad_is_active:
1132 * @pad: the #GstPad to query
1134 * Query if a pad is active
1136 * Returns: TRUE if the pad is active.
1141 gst_pad_is_active (GstPad * pad)
1143 gboolean result = FALSE;
1145 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1147 GST_OBJECT_LOCK (pad);
1148 result = GST_PAD_IS_ACTIVE (pad);
1149 GST_OBJECT_UNLOCK (pad);
1155 * gst_pad_add_probe:
1156 * @pad: the #GstPad to add the probe to
1157 * @mask: the probe mask
1158 * @callback: #GstPadProbeCallback that will be called with notifications of
1160 * @user_data: (closure): user data passed to the callback
1161 * @destroy_data: #GDestroyNotify for user_data
1163 * Be notified of different states of pads. The provided callback is called for
1164 * every state that matches @mask.
1166 * Returns: an id or 0 on error. The id can be used to remove the probe with
1167 * gst_pad_remove_probe().
1172 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1173 GstPadProbeCallback callback, gpointer user_data,
1174 GDestroyNotify destroy_data)
1179 g_return_val_if_fail (GST_IS_PAD (pad), 0);
1180 g_return_val_if_fail (mask != 0, 0);
1182 GST_OBJECT_LOCK (pad);
1184 /* make a new probe */
1185 hook = g_hook_alloc (&pad->probes);
1187 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1190 /* when no contraints are given for the types, assume all types are
1192 if ((mask & GST_PAD_PROBE_TYPE_ALL_BOTH) == 0)
1193 mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1194 if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1195 mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1197 /* store our flags and other fields */
1198 hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1199 hook->func = callback;
1200 hook->data = user_data;
1201 hook->destroy = destroy_data;
1202 PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1205 g_hook_prepend (&pad->probes, hook);
1207 /* incremenent cookie so that the new hook get's called */
1208 pad->priv->probe_list_cookie++;
1210 /* get the id of the hook, we return this and it can be used to remove the
1212 res = hook->hook_id;
1214 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1216 if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1217 /* we have a block probe */
1219 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1220 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1221 "now %d blocking probes", pad->num_blocked);
1224 /* call the callback if we need to be called for idle callbacks */
1225 if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1226 if (pad->priv->using > 0) {
1227 /* the pad is in use, we can't signal the idle callback yet. Since we set the
1228 * flag above, the last thread to leave the push will do the callback. New
1229 * threads going into the push will block. */
1230 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1231 "pad is in use, delay idle callback");
1232 GST_OBJECT_UNLOCK (pad);
1234 GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1236 /* the pad is idle now, we can signal the idle callback now */
1237 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1238 "pad is idle, trigger idle callback");
1239 GST_OBJECT_UNLOCK (pad);
1241 callback (pad, &info, user_data);
1244 GST_OBJECT_UNLOCK (pad);
1250 cleanup_hook (GstPad * pad, GHook * hook)
1252 GstPadProbeType type;
1254 type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1256 if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1257 /* unblock when we remove the last blocking probe */
1259 GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1261 if (pad->num_blocked == 0) {
1262 GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1263 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1264 GST_PAD_BLOCK_BROADCAST (pad);
1267 g_hook_destroy_link (&pad->probes, hook);
1272 * gst_pad_remove_probe:
1273 * @pad: the #GstPad with the probe
1274 * @id: the probe id to remove
1276 * Remove the probe with @id from @pad.
1281 gst_pad_remove_probe (GstPad * pad, gulong id)
1285 g_return_if_fail (GST_IS_PAD (pad));
1287 GST_OBJECT_LOCK (pad);
1289 hook = g_hook_get (&pad->probes, id);
1293 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1295 cleanup_hook (pad, hook);
1296 GST_OBJECT_UNLOCK (pad);
1302 GST_OBJECT_UNLOCK (pad);
1303 g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1309 * gst_pad_is_blocked:
1310 * @pad: the #GstPad to query
1312 * Checks if the pad is blocked or not. This function returns the
1313 * last requested state of the pad. It is not certain that the pad
1314 * is actually blocking at this point (see gst_pad_is_blocking()).
1316 * Returns: TRUE if the pad is blocked.
1321 gst_pad_is_blocked (GstPad * pad)
1323 gboolean result = FALSE;
1325 g_return_val_if_fail (GST_IS_PAD (pad), result);
1327 GST_OBJECT_LOCK (pad);
1328 result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1329 GST_OBJECT_UNLOCK (pad);
1335 * gst_pad_is_blocking:
1336 * @pad: the #GstPad to query
1338 * Checks if the pad is blocking or not. This is a guaranteed state
1339 * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1341 * Returns: TRUE if the pad is blocking.
1346 gst_pad_is_blocking (GstPad * pad)
1348 gboolean result = FALSE;
1350 g_return_val_if_fail (GST_IS_PAD (pad), result);
1352 GST_OBJECT_LOCK (pad);
1353 /* the blocking flag is only valid if the pad is not flushing */
1354 result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1355 GST_OBJECT_UNLOCK (pad);
1361 * gst_pad_check_reconfigure:
1362 * @pad: the #GstPad to check
1364 * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1365 * if the flag was set.
1367 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1370 gst_pad_check_reconfigure (GstPad * pad)
1372 gboolean reconfigure;
1374 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1376 GST_OBJECT_LOCK (pad);
1377 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1379 GST_DEBUG_OBJECT (pad, "remove RECONFIGURE flag");
1380 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1381 GST_OBJECT_UNLOCK (pad);
1387 * gst_pad_mark_reconfigure:
1388 * @pad: the #GstPad to mark
1390 * Mark a pad for needing reconfiguration. The next call to
1391 * gst_pad_check_reconfigure() will return %TRUE after this call.
1394 gst_pad_mark_reconfigure (GstPad * pad)
1396 g_return_if_fail (GST_IS_PAD (pad));
1398 GST_OBJECT_LOCK (pad);
1399 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1400 GST_OBJECT_UNLOCK (pad);
1404 * gst_pad_set_activate_function:
1406 * @f: the #GstPadActivateFunction to set.
1408 * Calls gst_pad_set_activate_function_full() with NULL for the user_data and
1412 * gst_pad_set_activate_function_full:
1414 * @activate: the #GstPadActivateFunction to set.
1415 * @user_data: user_data passed to @notify
1416 * @notify: notify called when @activate will not be used anymore.
1418 * Sets the given activate function for @pad. The activate function will
1419 * dispatch to gst_pad_activate_push() or gst_pad_activate_pull() to perform
1420 * the actual activation. Only makes sense to set on sink pads.
1422 * Call this function if your sink pad can start a pull-based task.
1425 gst_pad_set_activate_function_full (GstPad * pad,
1426 GstPadActivateFunction activate, gpointer user_data, GDestroyNotify notify)
1428 g_return_if_fail (GST_IS_PAD (pad));
1430 if (pad->activatenotify)
1431 pad->activatenotify (pad->activatedata);
1432 GST_PAD_ACTIVATEFUNC (pad) = activate;
1433 pad->activatedata = user_data;
1434 pad->activatenotify = notify;
1436 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1437 GST_DEBUG_FUNCPTR_NAME (activate));
1441 * gst_pad_set_activatemode_function:
1443 * @f: the #GstPadActivateModeFunction to set.
1445 * Calls gst_pad_set_activatemode_function_full() with NULL for the user_data and
1449 * gst_pad_set_activatemode_function_full:
1451 * @activatemode: the #GstPadActivateModeFunction to set.
1452 * @user_data: user_data passed to @notify
1453 * @notify: notify called when @activatemode will not be used anymore.
1455 * Sets the given activate_mode function for the pad. An activate_mode function
1456 * prepares the element for data passing.
1459 gst_pad_set_activatemode_function_full (GstPad * pad,
1460 GstPadActivateModeFunction activatemode, gpointer user_data,
1461 GDestroyNotify notify)
1463 g_return_if_fail (GST_IS_PAD (pad));
1465 if (pad->activatemodenotify)
1466 pad->activatemodenotify (pad->activatemodedata);
1467 GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1468 pad->activatemodedata = user_data;
1469 pad->activatemodenotify = notify;
1471 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1472 GST_DEBUG_FUNCPTR_NAME (activatemode));
1476 * gst_pad_set_chain_function:
1477 * @p: a sink #GstPad.
1478 * @f: the #GstPadChainFunction to set.
1480 * Calls gst_pad_set_chain_function_full() with NULL for the user_data and
1484 * gst_pad_set_chain_function_full:
1485 * @pad: a sink #GstPad.
1486 * @chain: the #GstPadChainFunction to set.
1487 * @user_data: user_data passed to @notify
1488 * @notify: notify called when @chain will not be used anymore.
1490 * Sets the given chain function for the pad. The chain function is called to
1491 * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1494 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1495 gpointer user_data, GDestroyNotify notify)
1497 g_return_if_fail (GST_IS_PAD (pad));
1498 g_return_if_fail (GST_PAD_IS_SINK (pad));
1500 if (pad->chainnotify)
1501 pad->chainnotify (pad->chaindata);
1502 GST_PAD_CHAINFUNC (pad) = chain;
1503 pad->chaindata = user_data;
1504 pad->chainnotify = notify;
1506 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1507 GST_DEBUG_FUNCPTR_NAME (chain));
1511 * gst_pad_set_chain_list_function:
1512 * @p: a sink #GstPad.
1513 * @f: the #GstPadChainListFunction to set.
1515 * Calls gst_pad_set_chain_list_function_full() with NULL for the user_data and
1519 * gst_pad_set_chain_list_function_full:
1520 * @pad: a sink #GstPad.
1521 * @chainlist: the #GstPadChainListFunction to set.
1522 * @user_data: user_data passed to @notify
1523 * @notify: notify called when @chainlist will not be used anymore.
1525 * Sets the given chain list function for the pad. The chainlist function is
1526 * called to process a #GstBufferList input buffer list. See
1527 * #GstPadChainListFunction for more details.
1530 gst_pad_set_chain_list_function_full (GstPad * pad,
1531 GstPadChainListFunction chainlist, gpointer user_data,
1532 GDestroyNotify notify)
1534 g_return_if_fail (GST_IS_PAD (pad));
1535 g_return_if_fail (GST_PAD_IS_SINK (pad));
1537 if (pad->chainlistnotify)
1538 pad->chainlistnotify (pad->chainlistdata);
1539 GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1540 pad->chainlistdata = user_data;
1541 pad->chainlistnotify = notify;
1543 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1544 GST_DEBUG_FUNCPTR_NAME (chainlist));
1548 * gst_pad_set_getrange_function:
1549 * @p: a source #GstPad.
1550 * @f: the #GstPadGetRangeFunction to set.
1552 * Calls gst_pad_set_getrange_function_full() with NULL for the user_data and
1556 * gst_pad_set_getrange_function_full:
1557 * @pad: a source #GstPad.
1558 * @get: the #GstPadGetRangeFunction to set.
1559 * @user_data: user_data passed to @notify
1560 * @notify: notify called when @get will not be used anymore.
1562 * Sets the given getrange function for the pad. The getrange function is
1563 * called to produce a new #GstBuffer to start the processing pipeline. see
1564 * #GstPadGetRangeFunction for a description of the getrange function.
1567 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1568 gpointer user_data, GDestroyNotify notify)
1570 g_return_if_fail (GST_IS_PAD (pad));
1571 g_return_if_fail (GST_PAD_IS_SRC (pad));
1573 if (pad->getrangenotify)
1574 pad->getrangenotify (pad->getrangedata);
1575 GST_PAD_GETRANGEFUNC (pad) = get;
1576 pad->getrangedata = user_data;
1577 pad->getrangenotify = notify;
1579 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1580 GST_DEBUG_FUNCPTR_NAME (get));
1584 * gst_pad_set_event_function:
1585 * @p: a #GstPad of either direction.
1586 * @f: the #GstPadEventFunction to set.
1588 * Calls gst_pad_set_event_function_full() with NULL for the user_data and
1592 * gst_pad_set_event_function_full:
1593 * @pad: a #GstPad of either direction.
1594 * @event: the #GstPadEventFunction to set.
1595 * @user_data: user_data passed to @notify
1596 * @notify: notify called when @event will not be used anymore.
1598 * Sets the given event handler for the pad.
1601 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1602 gpointer user_data, GDestroyNotify notify)
1604 g_return_if_fail (GST_IS_PAD (pad));
1606 if (pad->eventnotify)
1607 pad->eventnotify (pad->eventdata);
1608 GST_PAD_EVENTFUNC (pad) = event;
1609 pad->eventdata = user_data;
1610 pad->eventnotify = notify;
1612 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1613 GST_DEBUG_FUNCPTR_NAME (event));
1617 * gst_pad_set_query_function:
1618 * @p: a #GstPad of either direction.
1619 * @f: the #GstPadQueryFunction to set.
1621 * Calls gst_pad_set_query_function_full() with NULL for the user_data and
1625 * gst_pad_set_query_function_full:
1626 * @pad: a #GstPad of either direction.
1627 * @query: the #GstPadQueryFunction to set.
1628 * @user_data: user_data passed to @notify
1629 * @notify: notify called when @query will not be used anymore.
1631 * Set the given query function for the pad.
1634 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1635 gpointer user_data, GDestroyNotify notify)
1637 g_return_if_fail (GST_IS_PAD (pad));
1639 if (pad->querynotify)
1640 pad->querynotify (pad->querydata);
1641 GST_PAD_QUERYFUNC (pad) = query;
1642 pad->querydata = user_data;
1643 pad->querynotify = notify;
1645 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1646 GST_DEBUG_FUNCPTR_NAME (query));
1650 * gst_pad_set_iterate_internal_links_function:
1651 * @p: a #GstPad of either direction.
1652 * @f: the #GstPadIterIntLinkFunction to set.
1654 * Calls gst_pad_set_iterate_internal_links_function_full() with NULL
1655 * for the user_data and notify.
1658 * gst_pad_set_iterate_internal_links_function_full:
1659 * @pad: a #GstPad of either direction.
1660 * @iterintlink: the #GstPadIterIntLinkFunction to set.
1661 * @user_data: user_data passed to @notify
1662 * @notify: notify called when @iterintlink will not be used anymore.
1664 * Sets the given internal link iterator function for the pad.
1667 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1668 GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1669 GDestroyNotify notify)
1671 g_return_if_fail (GST_IS_PAD (pad));
1673 if (pad->iterintlinknotify)
1674 pad->iterintlinknotify (pad->iterintlinkdata);
1675 GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1676 pad->iterintlinkdata = user_data;
1677 pad->iterintlinknotify = notify;
1679 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1680 GST_DEBUG_FUNCPTR_NAME (iterintlink));
1684 * gst_pad_set_link_function:
1686 * @f: the #GstPadLinkFunction to set.
1688 * Calls gst_pad_set_link_function_full() with NULL
1689 * for the user_data and notify.
1692 * gst_pad_set_link_function_full:
1694 * @link: the #GstPadLinkFunction to set.
1695 * @user_data: user_data passed to @notify
1696 * @notify: notify called when @link will not be used anymore.
1698 * Sets the given link function for the pad. It will be called when
1699 * the pad is linked with another pad.
1701 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1704 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1705 * cannot be made for some reason.
1707 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1708 * of the peer sink pad, if present.
1711 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1712 gpointer user_data, GDestroyNotify notify)
1714 g_return_if_fail (GST_IS_PAD (pad));
1716 if (pad->linknotify)
1717 pad->linknotify (pad->linkdata);
1718 GST_PAD_LINKFUNC (pad) = link;
1719 pad->linkdata = user_data;
1720 pad->linknotify = notify;
1722 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1723 GST_DEBUG_FUNCPTR_NAME (link));
1727 * gst_pad_set_unlink_function:
1729 * @f: the #GstPadUnlinkFunction to set.
1731 * Calls gst_pad_set_unlink_function_full() with NULL
1732 * for the user_data and notify.
1735 * gst_pad_set_unlink_function_full:
1737 * @unlink: the #GstPadUnlinkFunction to set.
1738 * @user_data: user_data passed to @notify
1739 * @notify: notify called when @unlink will not be used anymore.
1741 * Sets the given unlink function for the pad. It will be called
1742 * when the pad is unlinked.
1745 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
1746 gpointer user_data, GDestroyNotify notify)
1748 g_return_if_fail (GST_IS_PAD (pad));
1750 if (pad->unlinknotify)
1751 pad->unlinknotify (pad->unlinkdata);
1752 GST_PAD_UNLINKFUNC (pad) = unlink;
1753 pad->unlinkdata = user_data;
1754 pad->unlinknotify = notify;
1756 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1757 GST_DEBUG_FUNCPTR_NAME (unlink));
1762 * @srcpad: the source #GstPad to unlink.
1763 * @sinkpad: the sink #GstPad to unlink.
1765 * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1766 * signal on both pads.
1768 * Returns: TRUE if the pads were unlinked. This function returns FALSE if
1769 * the pads were not linked together.
1774 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1776 gboolean result = FALSE;
1777 GstElement *parent = NULL;
1779 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1780 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1781 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1782 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1784 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1785 GST_DEBUG_PAD_NAME (srcpad), srcpad,
1786 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1788 /* We need to notify the parent before taking any pad locks as the bin in
1789 * question might be waiting for a lock on the pad while holding its lock
1790 * that our message will try to take. */
1791 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
1792 if (GST_IS_ELEMENT (parent)) {
1793 gst_element_post_message (parent,
1794 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1795 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
1797 gst_object_unref (parent);
1802 GST_OBJECT_LOCK (srcpad);
1803 GST_OBJECT_LOCK (sinkpad);
1805 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1806 goto not_linked_together;
1808 if (GST_PAD_UNLINKFUNC (srcpad)) {
1809 GST_PAD_UNLINKFUNC (srcpad) (srcpad);
1811 if (GST_PAD_UNLINKFUNC (sinkpad)) {
1812 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad);
1815 /* first clear peers */
1816 GST_PAD_PEER (srcpad) = NULL;
1817 GST_PAD_PEER (sinkpad) = NULL;
1819 GST_OBJECT_UNLOCK (sinkpad);
1820 GST_OBJECT_UNLOCK (srcpad);
1822 /* fire off a signal to each of the pads telling them
1823 * that they've been unlinked */
1824 g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1825 g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1827 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1828 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1833 if (parent != NULL) {
1834 gst_element_post_message (parent,
1835 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1836 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
1837 gst_object_unref (parent);
1842 not_linked_together:
1844 /* we do not emit a warning in this case because unlinking cannot
1845 * be made MT safe.*/
1846 GST_OBJECT_UNLOCK (sinkpad);
1847 GST_OBJECT_UNLOCK (srcpad);
1853 * gst_pad_is_linked:
1854 * @pad: pad to check
1856 * Checks if a @pad is linked to another pad or not.
1858 * Returns: TRUE if the pad is linked, FALSE otherwise.
1863 gst_pad_is_linked (GstPad * pad)
1867 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1869 GST_OBJECT_LOCK (pad);
1870 result = (GST_PAD_PEER (pad) != NULL);
1871 GST_OBJECT_UNLOCK (pad);
1876 /* get the caps from both pads and see if the intersection
1879 * This function should be called with the pad LOCK on both
1883 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
1884 GstPadLinkCheck flags)
1886 GstCaps *srccaps = NULL;
1887 GstCaps *sinkcaps = NULL;
1888 gboolean compatible = FALSE;
1890 if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
1893 /* Doing the expensive caps checking takes priority over only checking the template caps */
1894 if (flags & GST_PAD_LINK_CHECK_CAPS) {
1895 GST_OBJECT_UNLOCK (sink);
1896 GST_OBJECT_UNLOCK (src);
1898 srccaps = gst_pad_query_caps (src, NULL);
1899 sinkcaps = gst_pad_query_caps (sink, NULL);
1901 GST_OBJECT_LOCK (src);
1902 GST_OBJECT_LOCK (sink);
1904 /* If one of the two pads doesn't have a template, consider the intersection
1906 if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
1907 || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
1911 srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
1913 gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
1916 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
1918 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
1921 /* if we have caps on both pads we can check the intersection. If one
1922 * of the caps is NULL, we return TRUE. */
1923 if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
1925 gst_caps_unref (srccaps);
1927 gst_caps_unref (sinkcaps);
1931 compatible = gst_caps_can_intersect (srccaps, sinkcaps);
1932 gst_caps_unref (srccaps);
1933 gst_caps_unref (sinkcaps);
1936 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
1937 (compatible ? "" : "not"));
1942 /* check if the grandparents of both pads are the same.
1943 * This check is required so that we don't try to link
1944 * pads from elements in different bins without ghostpads.
1946 * The LOCK should be held on both pads
1949 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
1951 GstObject *psrc, *psink;
1953 psrc = GST_OBJECT_PARENT (src);
1954 psink = GST_OBJECT_PARENT (sink);
1956 /* if one of the pads has no parent, we allow the link */
1957 if (G_UNLIKELY (psrc == NULL || psink == NULL))
1960 /* only care about parents that are elements */
1961 if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
1962 goto no_element_parent;
1964 /* if the parents are the same, we have a loop */
1965 if (G_UNLIKELY (psrc == psink))
1968 /* if they both have a parent, we check the grandparents. We can not lock
1969 * the parent because we hold on the child (pad) and the locking order is
1970 * parent >> child. */
1971 psrc = GST_OBJECT_PARENT (psrc);
1972 psink = GST_OBJECT_PARENT (psink);
1974 /* if they have grandparents but they are not the same */
1975 if (G_UNLIKELY (psrc != psink))
1976 goto wrong_grandparents;
1983 GST_CAT_DEBUG (GST_CAT_CAPS,
1984 "one of the pads has no parent %" GST_PTR_FORMAT " and %"
1985 GST_PTR_FORMAT, psrc, psink);
1990 GST_CAT_DEBUG (GST_CAT_CAPS,
1991 "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
1992 GST_PTR_FORMAT, psrc, psink);
1997 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
2003 GST_CAT_DEBUG (GST_CAT_CAPS,
2004 "pads have different grandparents %" GST_PTR_FORMAT " and %"
2005 GST_PTR_FORMAT, psrc, psink);
2010 /* FIXME leftover from an attempt at refactoring... */
2011 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
2012 * the two pads will be locked in the srcpad, sinkpad order. */
2013 static GstPadLinkReturn
2014 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2016 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2017 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2019 GST_OBJECT_LOCK (srcpad);
2021 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
2022 goto src_was_linked;
2024 GST_OBJECT_LOCK (sinkpad);
2026 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
2027 goto sink_was_linked;
2029 /* check hierarchy, pads can only be linked if the grandparents
2031 if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
2032 && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
2033 goto wrong_hierarchy;
2035 /* check pad caps for non-empty intersection */
2036 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
2039 /* FIXME check pad scheduling for non-empty intersection */
2041 return GST_PAD_LINK_OK;
2045 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
2046 GST_DEBUG_PAD_NAME (srcpad),
2047 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
2048 /* we do not emit a warning in this case because unlinking cannot
2049 * be made MT safe.*/
2050 GST_OBJECT_UNLOCK (srcpad);
2051 return GST_PAD_LINK_WAS_LINKED;
2055 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
2056 GST_DEBUG_PAD_NAME (sinkpad),
2057 GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
2058 /* we do not emit a warning in this case because unlinking cannot
2059 * be made MT safe.*/
2060 GST_OBJECT_UNLOCK (sinkpad);
2061 GST_OBJECT_UNLOCK (srcpad);
2062 return GST_PAD_LINK_WAS_LINKED;
2066 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
2067 GST_OBJECT_UNLOCK (sinkpad);
2068 GST_OBJECT_UNLOCK (srcpad);
2069 return GST_PAD_LINK_WRONG_HIERARCHY;
2073 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
2074 GST_OBJECT_UNLOCK (sinkpad);
2075 GST_OBJECT_UNLOCK (srcpad);
2076 return GST_PAD_LINK_NOFORMAT;
2082 * @srcpad: the source #GstPad.
2083 * @sinkpad: the sink #GstPad.
2085 * Checks if the source pad and the sink pad are compatible so they can be
2088 * Returns: TRUE if the pads can be linked.
2091 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2093 GstPadLinkReturn result;
2095 /* generic checks */
2096 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2097 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2099 GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
2100 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2102 /* gst_pad_link_prepare does everything for us, we only release the locks
2103 * on the pads that it gets us. If this function returns !OK the locks are not
2105 result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2106 if (result != GST_PAD_LINK_OK)
2109 GST_OBJECT_UNLOCK (srcpad);
2110 GST_OBJECT_UNLOCK (sinkpad);
2113 return result == GST_PAD_LINK_OK;
2117 * gst_pad_link_full:
2118 * @srcpad: the source #GstPad to link.
2119 * @sinkpad: the sink #GstPad to link.
2120 * @flags: the checks to validate when linking
2122 * Links the source pad and the sink pad.
2124 * This variant of #gst_pad_link provides a more granular control on the
2125 * checks being done when linking. While providing some considerable speedups
2126 * the caller of this method must be aware that wrong usage of those flags
2127 * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
2128 * for more information.
2132 * Returns: A result code indicating if the connection worked or
2136 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2138 GstPadLinkReturn result;
2140 GstPadLinkFunction srcfunc, sinkfunc;
2142 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2143 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2144 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2145 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2146 GST_PAD_LINK_WRONG_DIRECTION);
2148 /* Notify the parent early. See gst_pad_unlink for details. */
2149 if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2150 if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2151 gst_element_post_message (parent,
2152 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2153 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2155 gst_object_unref (parent);
2160 /* prepare will also lock the two pads */
2161 result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2163 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2166 /* must set peers before calling the link function */
2167 GST_PAD_PEER (srcpad) = sinkpad;
2168 GST_PAD_PEER (sinkpad) = srcpad;
2170 /* check events, when something is different, mark pending */
2171 schedule_events (srcpad, sinkpad);
2173 /* get the link functions */
2174 srcfunc = GST_PAD_LINKFUNC (srcpad);
2175 sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2177 if (G_UNLIKELY (srcfunc || sinkfunc)) {
2178 /* custom link functions, execute them */
2179 GST_OBJECT_UNLOCK (sinkpad);
2180 GST_OBJECT_UNLOCK (srcpad);
2183 /* this one will call the peer link function */
2184 result = srcfunc (srcpad, sinkpad);
2185 } else if (sinkfunc) {
2186 /* if no source link function, we need to call the sink link
2187 * function ourselves. */
2188 result = sinkfunc (sinkpad, srcpad);
2191 GST_OBJECT_LOCK (srcpad);
2192 GST_OBJECT_LOCK (sinkpad);
2194 /* we released the lock, check if the same pads are linked still */
2195 if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2196 goto concurrent_link;
2198 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2201 GST_OBJECT_UNLOCK (sinkpad);
2202 GST_OBJECT_UNLOCK (srcpad);
2204 /* fire off a signal to each of the pads telling them
2205 * that they've been linked */
2206 g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2207 g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2209 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2210 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2212 gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2215 if (G_LIKELY (parent)) {
2216 gst_element_post_message (parent,
2217 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2218 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2219 gst_object_unref (parent);
2227 GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2228 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2229 GST_OBJECT_UNLOCK (sinkpad);
2230 GST_OBJECT_UNLOCK (srcpad);
2232 /* The other link operation succeeded first */
2233 result = GST_PAD_LINK_WAS_LINKED;
2238 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed",
2239 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2241 GST_PAD_PEER (srcpad) = NULL;
2242 GST_PAD_PEER (sinkpad) = NULL;
2244 GST_OBJECT_UNLOCK (sinkpad);
2245 GST_OBJECT_UNLOCK (srcpad);
2253 * @srcpad: the source #GstPad to link.
2254 * @sinkpad: the sink #GstPad to link.
2256 * Links the source pad and the sink pad.
2258 * Returns: A result code indicating if the connection worked or
2264 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2266 return gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2270 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2272 GstPadTemplate **template_p;
2274 /* this function would need checks if it weren't static */
2276 GST_OBJECT_LOCK (pad);
2277 template_p = &pad->padtemplate;
2278 gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2279 GST_OBJECT_UNLOCK (pad);
2282 gst_pad_template_pad_created (templ, pad);
2286 * gst_pad_get_pad_template:
2289 * Gets the template for @pad.
2291 * Returns: (transfer full): the #GstPadTemplate from which this pad was
2292 * instantiated, or %NULL if this pad has no template. Unref after
2296 gst_pad_get_pad_template (GstPad * pad)
2298 GstPadTemplate *templ;
2300 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2302 templ = GST_PAD_PAD_TEMPLATE (pad);
2304 return (templ ? gst_object_ref (templ) : NULL);
2308 * gst_pad_has_current_caps:
2309 * @pad: a #GstPad to check
2311 * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2313 * Returns: TRUE when @pad has caps associated with it.
2316 gst_pad_has_current_caps (GstPad * pad)
2321 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2323 GST_OBJECT_LOCK (pad);
2324 caps = get_pad_caps (pad);
2325 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2326 "check current pad caps %" GST_PTR_FORMAT, caps);
2327 result = (caps != NULL);
2328 GST_OBJECT_UNLOCK (pad);
2334 * gst_pad_get_current_caps:
2335 * @pad: a #GstPad to get the current capabilities of.
2337 * Gets the capabilities currently configured on @pad with the last
2338 * #GST_EVENT_CAPS event.
2340 * Returns: the current caps of the pad with incremented ref-count.
2343 gst_pad_get_current_caps (GstPad * pad)
2347 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2349 GST_OBJECT_LOCK (pad);
2350 if ((result = get_pad_caps (pad)))
2351 gst_caps_ref (result);
2352 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2353 "get current pad caps %" GST_PTR_FORMAT, result);
2354 GST_OBJECT_UNLOCK (pad);
2360 * gst_pad_get_pad_template_caps:
2361 * @pad: a #GstPad to get the template capabilities from.
2363 * Gets the capabilities for @pad's template.
2365 * Returns: (transfer full): the #GstCaps of this pad template.
2366 * Unref after usage.
2369 gst_pad_get_pad_template_caps (GstPad * pad)
2371 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2373 if (GST_PAD_PAD_TEMPLATE (pad))
2374 return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2376 return gst_caps_ref (GST_CAPS_ANY);
2381 * @pad: a #GstPad to get the peer of.
2383 * Gets the peer of @pad. This function refs the peer pad so
2384 * you need to unref it after use.
2386 * Returns: (transfer full): the peer #GstPad. Unref after usage.
2391 gst_pad_get_peer (GstPad * pad)
2395 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2397 GST_OBJECT_LOCK (pad);
2398 result = GST_PAD_PEER (pad);
2400 gst_object_ref (result);
2401 GST_OBJECT_UNLOCK (pad);
2407 * gst_pad_get_allowed_caps:
2410 * Gets the capabilities of the allowed media types that can flow through
2411 * @pad and its peer.
2413 * The allowed capabilities is calculated as the intersection of the results of
2414 * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2415 * on the resulting caps.
2417 * Returns: (transfer full): the allowed #GstCaps of the pad link. Unref the
2418 * caps when you no longer need it. This function returns NULL when @pad
2424 gst_pad_get_allowed_caps (GstPad * pad)
2431 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2433 GST_OBJECT_LOCK (pad);
2434 peer = GST_PAD_PEER (pad);
2435 if (G_UNLIKELY (peer == NULL))
2438 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2440 gst_object_ref (peer);
2441 GST_OBJECT_UNLOCK (pad);
2442 mycaps = gst_pad_query_caps (pad, NULL);
2444 peercaps = gst_pad_query_caps (peer, NULL);
2445 gst_object_unref (peer);
2447 caps = gst_caps_intersect (mycaps, peercaps);
2448 gst_caps_unref (peercaps);
2449 gst_caps_unref (mycaps);
2451 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2458 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2459 GST_OBJECT_UNLOCK (pad);
2466 * gst_pad_iterate_internal_links_default:
2467 * @pad: the #GstPad to get the internal links of.
2468 * @parent: the parent of @pad or NULL
2470 * Iterate the list of pads to which the given pad is linked to inside of
2471 * the parent element.
2472 * This is the default handler, and thus returns an iterator of all of the
2473 * pads inside the parent element with opposite direction.
2475 * The caller must free this iterator after use with gst_iterator_free().
2477 * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
2478 * returned pad with gst_object_unref().
2481 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2488 GstElement *eparent;
2490 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2492 if (parent != NULL && GST_IS_ELEMENT (parent)) {
2493 eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2495 GST_OBJECT_LOCK (pad);
2496 eparent = GST_PAD_PARENT (pad);
2497 if (!eparent || !GST_IS_ELEMENT (eparent))
2500 gst_object_ref (eparent);
2501 GST_OBJECT_UNLOCK (pad);
2504 if (pad->direction == GST_PAD_SRC)
2505 padlist = &eparent->sinkpads;
2507 padlist = &eparent->srcpads;
2509 GST_DEBUG_OBJECT (pad, "Making iterator");
2511 cookie = &eparent->pads_cookie;
2513 lock = GST_OBJECT_GET_LOCK (eparent);
2515 res = gst_iterator_new_list (GST_TYPE_PAD,
2516 lock, cookie, padlist, (GObject *) owner, NULL);
2518 gst_object_unref (owner);
2525 GST_OBJECT_UNLOCK (pad);
2526 GST_DEBUG_OBJECT (pad, "no parent element");
2532 * gst_pad_iterate_internal_links:
2533 * @pad: the GstPad to get the internal links of.
2535 * Gets an iterator for the pads to which the given pad is linked to inside
2536 * of the parent element.
2538 * Each #GstPad element yielded by the iterator will have its refcount increased,
2539 * so unref after use.
2541 * Free-function: gst_iterator_free
2543 * Returns: (transfer full): a new #GstIterator of #GstPad or %NULL when the
2544 * pad does not have an iterator function configured. Use
2545 * gst_iterator_free() after usage.
2548 gst_pad_iterate_internal_links (GstPad * pad)
2550 GstIterator *res = NULL;
2553 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2555 GST_OBJECT_LOCK (pad);
2556 ACQUIRE_PARENT (pad, parent, no_parent);
2557 GST_OBJECT_UNLOCK (pad);
2559 if (GST_PAD_ITERINTLINKFUNC (pad))
2560 res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2562 RELEASE_PARENT (parent);
2569 GST_DEBUG_OBJECT (pad, "no parent");
2570 GST_OBJECT_UNLOCK (pad);
2578 * @forward: (scope call): a #GstPadForwardFunction
2579 * @user_data: user data passed to @forward
2581 * Calls @forward for all internally linked pads of @pad. This function deals with
2582 * dynamically changing internal pads and will make sure that the @forward
2583 * function is only called once for each pad.
2585 * When @forward returns TRUE, no further pads will be processed.
2587 * Returns: TRUE if one of the dispatcher functions returned TRUE.
2590 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2593 gboolean result = FALSE;
2595 gboolean done = FALSE;
2596 GValue item = { 0, };
2597 GList *pushed_pads = NULL;
2599 iter = gst_pad_iterate_internal_links (pad);
2605 switch (gst_iterator_next (iter, &item)) {
2606 case GST_ITERATOR_OK:
2610 intpad = g_value_get_object (&item);
2612 /* if already pushed, skip. FIXME, find something faster to tag pads */
2613 if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2614 g_value_reset (&item);
2618 GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2619 GST_DEBUG_PAD_NAME (intpad));
2620 done = result = forward (intpad, user_data);
2622 pushed_pads = g_list_prepend (pushed_pads, intpad);
2624 g_value_reset (&item);
2627 case GST_ITERATOR_RESYNC:
2628 /* We don't reset the result here because we don't push the event
2629 * again on pads that got the event already and because we need
2630 * to consider the result of the previous pushes */
2631 gst_iterator_resync (iter);
2633 case GST_ITERATOR_ERROR:
2634 GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2637 case GST_ITERATOR_DONE:
2642 g_value_unset (&item);
2643 gst_iterator_free (iter);
2645 g_list_free (pushed_pads);
2655 gboolean dispatched;
2659 event_forward_func (GstPad * pad, EventData * data)
2661 /* for each pad we send to, we should ref the event; it's up
2662 * to downstream to unref again when handled. */
2663 GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2664 data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2666 data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2668 data->dispatched = TRUE;
2675 * gst_pad_event_default:
2676 * @pad: a #GstPad to call the default event handler on.
2677 * @parent: the parent of @pad or NULL
2678 * @event: (transfer full): the #GstEvent to handle.
2680 * Invokes the default event handler for the given pad.
2682 * The EOS event will pause the task associated with @pad before it is forwarded
2683 * to all internally linked pads,
2685 * The the event is sent to all pads internally linked to @pad. This function
2686 * takes ownership of @event.
2688 * Returns: TRUE if the event was sent successfully.
2691 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2693 gboolean result, forward = TRUE;
2695 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2696 g_return_val_if_fail (event != NULL, FALSE);
2698 GST_LOG_OBJECT (pad, "default event handler");
2700 switch (GST_EVENT_TYPE (event)) {
2701 case GST_EVENT_CAPS:
2702 forward = GST_PAD_IS_PROXY_CAPS (pad);
2713 data.dispatched = FALSE;
2714 data.result = FALSE;
2716 gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
2718 /* for sinkpads without a parent element or without internal links, nothing
2719 * will be dispatched but we still want to return TRUE. */
2720 if (data.dispatched)
2721 result = data.result;
2726 gst_event_unref (event);
2731 /* Default accept caps implementation just checks against
2732 * the allowed caps for the pad */
2734 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
2736 /* get the caps and see if it intersects to something not empty */
2737 GstCaps *caps, *allowed;
2740 GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
2742 /* first forward the query to internally linked pads when we are dealing with
2744 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2745 if ((result = gst_pad_proxy_query_accept_caps (pad, query))) {
2750 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
2751 "fallback ACCEPT_CAPS query, consider implementing a specialized version");
2753 allowed = gst_pad_query_caps (pad, NULL);
2754 gst_query_parse_accept_caps (query, &caps);
2757 GST_DEBUG_OBJECT (pad, "allowed caps %" GST_PTR_FORMAT, allowed);
2758 result = gst_caps_is_subset (caps, allowed);
2759 gst_caps_unref (allowed);
2761 GST_DEBUG_OBJECT (pad, "no caps allowed on the pad");
2764 gst_query_set_accept_caps_result (query, result);
2770 /* Default caps implementation */
2772 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
2774 GstCaps *result = NULL, *filter;
2775 GstPadTemplate *templ;
2776 gboolean fixed_caps;
2778 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
2780 gst_query_parse_caps (query, &filter);
2782 /* first try to proxy if we must */
2783 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2784 if ((gst_pad_proxy_query_caps (pad, query))) {
2785 gst_query_parse_caps_result (query, &result);
2790 /* no proxy or it failed, do default handling */
2791 fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
2793 GST_OBJECT_LOCK (pad);
2795 /* fixed caps, try the negotiated caps first */
2796 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
2797 if ((result = get_pad_caps (pad)))
2798 goto filter_done_unlock;
2801 if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
2802 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
2803 if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
2804 goto filter_done_unlock;
2808 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2809 "non-fixed pad caps: trying pad caps");
2810 /* non fixed caps, try the negotiated caps */
2811 if ((result = get_pad_caps (pad)))
2812 goto filter_done_unlock;
2815 /* this almost never happens */
2816 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
2817 result = GST_CAPS_ANY;
2820 GST_OBJECT_UNLOCK (pad);
2823 /* run the filter on the result */
2825 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2826 "using caps %p %" GST_PTR_FORMAT " with filter %p %"
2827 GST_PTR_FORMAT, result, result, filter, filter);
2828 result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
2829 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
2832 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2833 "using caps %p %" GST_PTR_FORMAT, result, result);
2834 result = gst_caps_ref (result);
2837 gst_query_set_caps_result (query, result);
2838 gst_caps_unref (result);
2847 gboolean dispatched;
2851 query_forward_func (GstPad * pad, QueryData * data)
2853 GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
2854 data->query, GST_EVENT_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
2856 data->result |= gst_pad_peer_query (pad, data->query);
2858 data->dispatched = TRUE;
2860 /* stop on first successful reply */
2861 return data->result;
2865 * gst_pad_query_default:
2866 * @pad: a #GstPad to call the default query handler on.
2867 * @parent: the parent of @pad or NULL
2868 * @query: (transfer none): the #GstQuery to handle.
2870 * Invokes the default query handler for the given pad.
2871 * The query is sent to all pads internally linked to @pad. Note that
2872 * if there are many possible sink pads that are internally linked to
2873 * @pad, only one will be sent the query.
2874 * Multi-sinkpad elements should implement custom query handlers.
2876 * Returns: TRUE if the query was performed successfully.
2879 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
2881 gboolean forward, ret = FALSE;
2883 switch (GST_QUERY_TYPE (query)) {
2884 case GST_QUERY_SCHEDULING:
2887 case GST_QUERY_ALLOCATION:
2888 forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
2890 case GST_QUERY_ACCEPT_CAPS:
2891 ret = gst_pad_query_accept_caps_default (pad, query);
2894 case GST_QUERY_CAPS:
2895 ret = gst_pad_query_caps_default (pad, query);
2898 case GST_QUERY_POSITION:
2899 case GST_QUERY_SEEKING:
2900 case GST_QUERY_FORMATS:
2901 case GST_QUERY_LATENCY:
2902 case GST_QUERY_JITTER:
2903 case GST_QUERY_RATE:
2904 case GST_QUERY_CONVERT:
2910 GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
2911 query, GST_QUERY_TYPE_NAME (query));
2917 data.dispatched = FALSE;
2918 data.result = FALSE;
2920 gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
2922 if (data.dispatched) {
2925 /* nothing dispatched, assume drained */
2926 if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
2936 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
2938 GstPad *pad = data->pad;
2939 GstPadProbeInfo *info = data->info;
2940 GstPadProbeType type, flags;
2941 GstPadProbeCallback callback;
2942 GstPadProbeReturn ret;
2944 /* if we have called this callback, do nothing */
2945 if (PROBE_COOKIE (hook) == data->cookie) {
2946 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2947 "hook %lu, cookie %u already called", hook->hook_id,
2948 PROBE_COOKIE (hook));
2952 PROBE_COOKIE (hook) = data->cookie;
2954 flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
2957 /* one of the data types */
2958 if ((flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
2960 /* one of the scheduling types */
2961 if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
2963 /* one of the blocking types must match */
2964 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
2965 (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
2967 /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
2968 if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
2969 (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
2972 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2973 "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
2974 PROBE_COOKIE (hook), flags);
2976 data->marshalled = TRUE;
2978 callback = (GstPadProbeCallback) hook->func;
2979 if (callback == NULL)
2982 info->id = hook->hook_id;
2984 GST_OBJECT_UNLOCK (pad);
2986 ret = callback (pad, info, hook->data);
2988 GST_OBJECT_LOCK (pad);
2991 case GST_PAD_PROBE_REMOVE:
2992 /* remove the probe */
2993 GST_DEBUG_OBJECT (pad, "asked to remove hook");
2994 cleanup_hook (pad, hook);
2996 case GST_PAD_PROBE_DROP:
2997 /* need to drop the data, make sure other probes don't get called
2999 GST_DEBUG_OBJECT (pad, "asked to drop item");
3000 info->type = GST_PAD_PROBE_TYPE_INVALID;
3001 data->dropped = TRUE;
3003 case GST_PAD_PROBE_PASS:
3004 /* inform the pad block to let things pass */
3005 GST_DEBUG_OBJECT (pad, "asked to pass item");
3009 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
3016 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3017 "hook %lu, cookie %u with flags 0x%08x does not match %08x",
3018 hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
3023 /* a probe that does not take or return any data */
3024 #define PROBE_NO_DATA(pad,mask,label,defaultval) \
3026 if (G_UNLIKELY (pad->num_probes)) { \
3027 /* pass NULL as the data item */ \
3028 GstPadProbeInfo info = { mask, 0, NULL, 0, 0 }; \
3029 ret = do_probe_callbacks (pad, &info, defaultval); \
3030 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
3035 #define PROBE_FULL(pad,mask,data,offs,size,label) \
3037 if (G_UNLIKELY (pad->num_probes)) { \
3038 /* pass the data item */ \
3039 GstPadProbeInfo info = { mask, 0, data, offs, size }; \
3040 ret = do_probe_callbacks (pad, &info, GST_FLOW_OK); \
3041 /* store the possibly updated data item */ \
3042 data = GST_PAD_PROBE_INFO_DATA (&info); \
3043 /* if something went wrong, exit */ \
3044 if (G_UNLIKELY (ret != GST_FLOW_OK)) \
3049 #define PROBE_PUSH(pad,mask,data,label) \
3050 PROBE_FULL(pad, mask, data, -1, -1, label);
3051 #define PROBE_PULL(pad,mask,data,offs,size,label) \
3052 PROBE_FULL(pad, mask, data, offs, size, label);
3054 static GstFlowReturn
3055 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3056 GstFlowReturn defaultval)
3065 data.marshalled = FALSE;
3066 data.dropped = FALSE;
3067 data.cookie = ++pad->priv->probe_cookie;
3070 (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3073 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3074 "do probes cookie %u", data.cookie);
3075 cookie = pad->priv->probe_list_cookie;
3077 g_hook_list_marshal (&pad->probes, TRUE,
3078 (GHookMarshaller) probe_hook_marshal, &data);
3080 /* if the list changed, call the new callbacks (they will not have their
3081 * cookie set to data.cookie */
3082 if (cookie != pad->priv->probe_list_cookie) {
3083 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3084 "probe list changed, restarting");
3088 /* the first item that dropped will stop the hooks and then we drop here */
3092 /* if no handler matched and we are blocking, let the item pass */
3093 if (!data.marshalled && is_block)
3096 /* At this point, all handlers returned either OK or PASS. If one handler
3097 * returned PASS, let the item pass */
3102 while (GST_PAD_IS_BLOCKED (pad)) {
3103 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3104 "we are blocked %d times", pad->num_blocked);
3106 /* we might have released the lock */
3107 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3110 /* now we block the streaming thread. It can be unlocked when we
3111 * deactivate the pad (which will also set the FLUSHING flag) or
3112 * when the pad is unblocked. A flushing event will also unblock
3113 * the pad after setting the FLUSHING flag. */
3114 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3115 "Waiting to be unblocked or set flushing");
3116 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3117 GST_PAD_BLOCK_WAIT (pad);
3118 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3119 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3121 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3131 GST_DEBUG_OBJECT (pad, "pad is flushing");
3132 return GST_FLOW_FLUSHING;
3136 GST_DEBUG_OBJECT (pad, "data is dropped");
3137 return GST_FLOW_CUSTOM_SUCCESS;
3141 /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3142 GST_DEBUG_OBJECT (pad, "data is passed");
3150 * gst_pad_get_offset:
3153 * Get the offset applied to the running time of @pad. @pad has to be a source
3156 * Returns: the offset.
3159 gst_pad_get_offset (GstPad * pad)
3163 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3165 GST_OBJECT_LOCK (pad);
3166 result = pad->offset;
3167 GST_OBJECT_UNLOCK (pad);
3173 * gst_pad_set_offset:
3175 * @offset: the offset
3177 * Set the offset that will be applied to the running time of @pad.
3180 gst_pad_set_offset (GstPad * pad, gint64 offset)
3184 g_return_if_fail (GST_IS_PAD (pad));
3186 GST_OBJECT_LOCK (pad);
3187 /* if nothing changed, do nothing */
3188 if (pad->offset == offset)
3191 pad->offset = offset;
3192 GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3194 /* sinkpads will apply their offset the next time a segment
3195 * event is received. */
3196 if (GST_PAD_IS_SINK (pad))
3199 /* resend the last segment event on next buffer push */
3200 if ((ev = find_event_by_type (pad, GST_EVENT_SEGMENT, 0))) {
3201 ev->received = FALSE;
3202 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3206 GST_OBJECT_UNLOCK (pad);
3213 /* If TRUE and ret is not OK this means
3214 * that pushing the EOS event failed
3219 /* should be called with pad LOCK */
3221 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3223 PushStickyData *data = user_data;
3224 GstEvent *event = ev->event;
3227 GST_DEBUG_OBJECT (pad, "event %s was already received",
3228 GST_EVENT_TYPE_NAME (event));
3232 data->ret = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3233 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3235 switch (data->ret) {
3237 ev->received = TRUE;
3238 GST_DEBUG_OBJECT (pad, "event %s marked received",
3239 GST_EVENT_TYPE_NAME (event));
3241 case GST_FLOW_NOT_LINKED:
3242 /* not linked is not a problem, we are sticky so the event will be
3243 * sent later but only for non-EOS events */
3244 GST_DEBUG_OBJECT (pad, "pad was not linked");
3245 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
3246 data->ret = GST_FLOW_OK;
3249 GST_DEBUG_OBJECT (pad, "mark pending events");
3250 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3254 if (data->ret != GST_FLOW_OK && GST_EVENT_TYPE (event) == GST_EVENT_EOS)
3255 data->was_eos = TRUE;
3257 return data->ret == GST_FLOW_OK;
3260 /* check sticky events and push them when needed. should be called
3262 static inline GstFlowReturn
3263 check_sticky (GstPad * pad)
3265 PushStickyData data = { GST_FLOW_OK, FALSE };
3267 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3268 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3270 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3271 events_foreach (pad, push_sticky, &data);
3273 /* If there's an EOS event we must push it downstream
3274 * even if sending a previous sticky event failed.
3275 * Otherwise the pipeline might wait forever for EOS.
3277 * Only do this if pushing another event than the EOS
3280 if (data.ret != GST_FLOW_OK && !data.was_eos) {
3281 PadEvent *ev = find_event_by_type (pad, GST_EVENT_EOS, 0);
3283 if (ev && !ev->received) {
3284 data.ret = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3285 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3295 * @pad: a #GstPad to invoke the default query on.
3296 * @query: (transfer none): the #GstQuery to perform.
3298 * Dispatches a query to a pad. The query should have been allocated by the
3299 * caller via one of the type-specific allocation functions. The element that
3300 * the pad belongs to is responsible for filling the query with an appropriate
3301 * response, which should then be parsed with a type-specific query parsing
3304 * Again, the caller is responsible for both the allocation and deallocation of
3305 * the query structure.
3307 * Please also note that some queries might need a running pipeline to work.
3309 * Returns: TRUE if the query could be performed.
3312 gst_pad_query (GstPad * pad, GstQuery * query)
3315 gboolean res, serialized;
3316 GstPadQueryFunction func;
3317 GstPadProbeType type;
3320 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3321 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3323 if (GST_PAD_IS_SRC (pad)) {
3324 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3325 goto wrong_direction;
3326 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3327 } else if (GST_PAD_IS_SINK (pad)) {
3328 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3329 goto wrong_direction;
3330 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3332 goto unknown_direction;
3334 GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3335 GST_QUERY_TYPE_NAME (query));
3337 serialized = GST_QUERY_IS_SERIALIZED (query);
3338 if (G_UNLIKELY (serialized))
3339 GST_PAD_STREAM_LOCK (pad);
3341 GST_OBJECT_LOCK (pad);
3342 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3343 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3344 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3346 ACQUIRE_PARENT (pad, parent, no_parent);
3347 GST_OBJECT_UNLOCK (pad);
3349 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3352 res = func (pad, parent, query);
3354 RELEASE_PARENT (parent);
3356 GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3357 GST_QUERY_TYPE_NAME (query), res);
3362 GST_OBJECT_LOCK (pad);
3363 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3364 GST_OBJECT_UNLOCK (pad);
3366 if (G_UNLIKELY (serialized))
3367 GST_PAD_STREAM_UNLOCK (pad);
3374 g_warning ("pad %s:%s query %s in wrong direction",
3375 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3380 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3385 GST_DEBUG_OBJECT (pad, "had no parent");
3386 GST_OBJECT_UNLOCK (pad);
3387 if (G_UNLIKELY (serialized))
3388 GST_PAD_STREAM_UNLOCK (pad);
3393 GST_DEBUG_OBJECT (pad, "had no query function");
3394 RELEASE_PARENT (parent);
3395 if (G_UNLIKELY (serialized))
3396 GST_PAD_STREAM_UNLOCK (pad);
3401 GST_DEBUG_OBJECT (pad, "query failed");
3402 if (G_UNLIKELY (serialized))
3403 GST_PAD_STREAM_UNLOCK (pad);
3408 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3409 GST_OBJECT_UNLOCK (pad);
3410 if (G_UNLIKELY (serialized))
3411 GST_PAD_STREAM_UNLOCK (pad);
3413 /* if a probe dropped, we don't sent it further but assume that the probe
3414 * answered the query and return TRUE */
3415 if (ret == GST_FLOW_CUSTOM_SUCCESS)
3425 * gst_pad_peer_query:
3426 * @pad: a #GstPad to invoke the peer query on.
3427 * @query: (transfer none): the #GstQuery to perform.
3429 * Performs gst_pad_query() on the peer of @pad.
3431 * The caller is responsible for both the allocation and deallocation of
3432 * the query structure.
3434 * Returns: TRUE if the query could be performed. This function returns %FALSE
3435 * if @pad has no peer.
3438 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3441 GstPadProbeType type;
3442 gboolean res, serialized;
3445 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3446 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3448 if (GST_PAD_IS_SRC (pad)) {
3449 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3450 goto wrong_direction;
3451 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3452 } else if (GST_PAD_IS_SINK (pad)) {
3453 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3454 goto wrong_direction;
3455 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3457 goto unknown_direction;
3459 GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
3460 GST_QUERY_TYPE_NAME (query));
3462 serialized = GST_QUERY_IS_SERIALIZED (query);
3464 GST_OBJECT_LOCK (pad);
3465 if (GST_PAD_IS_SRC (pad) && serialized) {
3466 /* all serialized queries on the srcpad trigger push of
3468 if (!check_sticky (pad) == GST_FLOW_OK)
3472 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3473 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3474 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3476 peerpad = GST_PAD_PEER (pad);
3477 if (G_UNLIKELY (peerpad == NULL))
3480 gst_object_ref (peerpad);
3481 GST_OBJECT_UNLOCK (pad);
3483 res = gst_pad_query (peerpad, query);
3485 gst_object_unref (peerpad);
3490 GST_OBJECT_LOCK (pad);
3491 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3492 GST_OBJECT_UNLOCK (pad);
3499 g_warning ("pad %s:%s query %s in wrong direction",
3500 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3505 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3510 GST_WARNING_OBJECT (pad, "could not send sticky events");
3511 GST_OBJECT_UNLOCK (pad);
3516 GST_WARNING_OBJECT (pad, "pad has no peer");
3517 GST_OBJECT_UNLOCK (pad);
3522 GST_DEBUG_OBJECT (pad, "query failed");
3527 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3528 GST_OBJECT_UNLOCK (pad);
3530 /* if a probe dropped, we don't sent it further but assume that the probe
3531 * answered the query and return TRUE */
3532 if (ret == GST_FLOW_CUSTOM_SUCCESS)
3541 /**********************************************************************
3542 * Data passing functions
3545 /* this is the chain function that does not perform the additional argument
3546 * checking for that little extra speed.
3548 static inline GstFlowReturn
3549 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
3554 GST_PAD_STREAM_LOCK (pad);
3556 GST_OBJECT_LOCK (pad);
3557 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3560 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
3563 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3566 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3568 PROBE_PUSH (pad, type, data, probe_stopped);
3570 parent = GST_OBJECT_PARENT (pad);
3571 GST_OBJECT_UNLOCK (pad);
3573 /* NOTE: we read the chainfunc unlocked.
3574 * we cannot hold the lock for the pad so we might send
3575 * the data to the wrong function. This is not really a
3576 * problem since functions are assigned at creation time
3577 * and don't change that often... */
3578 if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
3579 GstPadChainFunction chainfunc;
3581 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3584 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3585 "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
3586 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
3588 ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
3590 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3591 "called chainfunction &%s with buffer %p, returned %s",
3592 GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
3594 GstPadChainListFunction chainlistfunc;
3596 if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
3599 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3600 "calling chainlistfunction &%s",
3601 GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
3603 ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
3605 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3606 "called chainlistfunction &%s, returned %s",
3607 GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
3610 GST_PAD_STREAM_UNLOCK (pad);
3617 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3618 "chaining, but pad was flushing");
3619 GST_OBJECT_UNLOCK (pad);
3620 GST_PAD_STREAM_UNLOCK (pad);
3621 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3622 return GST_FLOW_FLUSHING;
3626 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "chaining, but pad was EOS");
3627 GST_OBJECT_UNLOCK (pad);
3628 GST_PAD_STREAM_UNLOCK (pad);
3629 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3630 return GST_FLOW_EOS;
3634 g_critical ("chain on pad %s:%s but it was not in push mode",
3635 GST_DEBUG_PAD_NAME (pad));
3636 GST_OBJECT_UNLOCK (pad);
3637 GST_PAD_STREAM_UNLOCK (pad);
3638 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3639 return GST_FLOW_ERROR;
3643 GST_OBJECT_UNLOCK (pad);
3644 GST_PAD_STREAM_UNLOCK (pad);
3645 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3648 case GST_FLOW_CUSTOM_SUCCESS:
3649 GST_DEBUG_OBJECT (pad, "dropped buffer");
3653 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3660 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3661 g_critical ("chain on pad %s:%s but it has no chainfunction",
3662 GST_DEBUG_PAD_NAME (pad));
3663 GST_PAD_STREAM_UNLOCK (pad);
3664 return GST_FLOW_NOT_SUPPORTED;
3670 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3671 * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
3674 * Chain a buffer to @pad.
3676 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3678 * If the buffer type is not acceptable for @pad (as negotiated with a
3679 * preceeding GST_EVENT_CAPS event), this function returns
3680 * #GST_FLOW_NOT_NEGOTIATED.
3682 * The function proceeds calling the chain function installed on @pad (see
3683 * gst_pad_set_chain_function()) and the return value of that function is
3684 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3687 * In all cases, success or failure, the caller loses its reference to @buffer
3688 * after calling this function.
3690 * Returns: a #GstFlowReturn from the pad.
3695 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
3697 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3698 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3699 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3701 return gst_pad_chain_data_unchecked (pad,
3702 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3705 static GstFlowReturn
3706 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
3707 GstBufferList * list)
3713 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3715 len = gst_buffer_list_length (list);
3718 for (i = 0; i < len; i++) {
3719 buffer = gst_buffer_list_get (list, i);
3721 gst_pad_chain_data_unchecked (pad,
3722 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
3723 gst_buffer_ref (buffer));
3724 if (ret != GST_FLOW_OK)
3727 gst_buffer_list_unref (list);
3733 * gst_pad_chain_list:
3734 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3735 * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
3738 * Chain a bufferlist to @pad.
3740 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3742 * If @pad was not negotiated properly with a CAPS event, this function
3743 * returns #GST_FLOW_NOT_NEGOTIATED.
3745 * The function proceeds calling the chainlist function installed on @pad (see
3746 * gst_pad_set_chain_list_function()) and the return value of that function is
3747 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3748 * chainlist function.
3750 * In all cases, success or failure, the caller loses its reference to @list
3751 * after calling this function.
3755 * Returns: a #GstFlowReturn from the pad.
3758 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
3760 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3761 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3762 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3764 return gst_pad_chain_data_unchecked (pad,
3765 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3768 static GstFlowReturn
3769 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
3774 GST_OBJECT_LOCK (pad);
3775 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3778 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
3781 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3784 if (G_UNLIKELY ((ret = check_sticky (pad))) != GST_FLOW_OK)
3787 /* do block probes */
3788 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3790 /* do post-blocking probes */
3791 PROBE_PUSH (pad, type, data, probe_stopped);
3793 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3796 /* take ref to peer pad before releasing the lock */
3797 gst_object_ref (peer);
3799 GST_OBJECT_UNLOCK (pad);
3801 ret = gst_pad_chain_data_unchecked (peer, type, data);
3803 gst_object_unref (peer);
3805 GST_OBJECT_LOCK (pad);
3807 if (pad->priv->using == 0) {
3808 /* pad is not active anymore, trigger idle callbacks */
3809 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
3810 probe_stopped, ret);
3812 GST_OBJECT_UNLOCK (pad);
3816 /* ERROR recovery here */
3820 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3821 "pushing, but pad was flushing");
3822 GST_OBJECT_UNLOCK (pad);
3823 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3824 return GST_FLOW_FLUSHING;
3828 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pushing, but pad was EOS");
3829 GST_OBJECT_UNLOCK (pad);
3830 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3831 return GST_FLOW_EOS;
3835 g_critical ("pushing on pad %s:%s but it was not activated in push mode",
3836 GST_DEBUG_PAD_NAME (pad));
3837 GST_OBJECT_UNLOCK (pad);
3838 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3839 return GST_FLOW_ERROR;
3843 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3844 "error pushing events, return %s", gst_flow_get_name (ret));
3845 GST_OBJECT_UNLOCK (pad);
3846 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3851 GST_OBJECT_UNLOCK (pad);
3852 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3855 case GST_FLOW_CUSTOM_SUCCESS:
3856 GST_DEBUG_OBJECT (pad, "dropped buffer");
3860 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3867 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3868 "pushing, but it was not linked");
3869 GST_OBJECT_UNLOCK (pad);
3870 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3871 return GST_FLOW_NOT_LINKED;
3877 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3878 * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
3881 * Pushes a buffer to the peer of @pad.
3883 * This function will call installed block probes before triggering any
3884 * installed data probes.
3886 * The function proceeds calling gst_pad_chain() on the peer pad and returns
3887 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3890 * In all cases, success or failure, the caller loses its reference to @buffer
3891 * after calling this function.
3893 * Returns: a #GstFlowReturn from the peer pad.
3898 gst_pad_push (GstPad * pad, GstBuffer * buffer)
3900 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3901 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3902 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3904 return gst_pad_push_data (pad,
3905 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3909 * gst_pad_push_list:
3910 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3911 * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
3914 * Pushes a buffer list to the peer of @pad.
3916 * This function will call installed block probes before triggering any
3917 * installed data probes.
3919 * The function proceeds calling the chain function on the peer pad and returns
3920 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3921 * be returned. If the peer pad does not have any installed chainlist function
3922 * every group buffer of the list will be merged into a normal #GstBuffer and
3923 * chained via gst_pad_chain().
3925 * In all cases, success or failure, the caller loses its reference to @list
3926 * after calling this function.
3928 * Returns: a #GstFlowReturn from the peer pad.
3933 gst_pad_push_list (GstPad * pad, GstBufferList * list)
3935 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3936 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3937 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3939 return gst_pad_push_data (pad,
3940 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3943 static GstFlowReturn
3944 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
3945 GstBuffer ** buffer)
3948 GstPadGetRangeFunction getrangefunc;
3952 GST_PAD_STREAM_LOCK (pad);
3954 GST_OBJECT_LOCK (pad);
3955 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3958 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
3961 if (G_UNLIKELY ((ret = check_sticky (pad))) != GST_FLOW_OK)
3966 /* when one of the probes returns DROPPED, probe_stopped will be called
3967 * and we skip calling the getrange function, res_buf should then contain a
3968 * valid result buffer */
3969 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
3970 res_buf, offset, size, probe_stopped);
3972 ACQUIRE_PARENT (pad, parent, no_parent);
3973 GST_OBJECT_UNLOCK (pad);
3975 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
3978 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3979 "calling getrangefunc %s, offset %"
3980 G_GUINT64_FORMAT ", size %u",
3981 GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
3983 ret = getrangefunc (pad, parent, offset, size, &res_buf);
3985 RELEASE_PARENT (parent);
3987 if (G_UNLIKELY (ret != GST_FLOW_OK))
3988 goto get_range_failed;
3990 /* can only fire the signal if we have a valid buffer */
3991 GST_OBJECT_LOCK (pad);
3993 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
3994 res_buf, offset, size, probe_stopped_unref);
3995 GST_OBJECT_UNLOCK (pad);
3997 GST_PAD_STREAM_UNLOCK (pad);
4006 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4007 "getrange, but pad was flushing");
4008 GST_OBJECT_UNLOCK (pad);
4009 GST_PAD_STREAM_UNLOCK (pad);
4010 return GST_FLOW_FLUSHING;
4014 g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
4015 GST_DEBUG_PAD_NAME (pad));
4016 GST_OBJECT_UNLOCK (pad);
4017 GST_PAD_STREAM_UNLOCK (pad);
4018 return GST_FLOW_ERROR;
4022 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
4023 GST_OBJECT_UNLOCK (pad);
4024 GST_PAD_STREAM_UNLOCK (pad);
4029 GST_DEBUG_OBJECT (pad, "no parent");
4030 GST_OBJECT_UNLOCK (pad);
4031 GST_PAD_STREAM_UNLOCK (pad);
4032 return GST_FLOW_FLUSHING;
4036 g_critical ("getrange on pad %s:%s but it has no getrangefunction",
4037 GST_DEBUG_PAD_NAME (pad));
4038 RELEASE_PARENT (parent);
4039 GST_PAD_STREAM_UNLOCK (pad);
4040 return GST_FLOW_NOT_SUPPORTED;
4044 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4045 "probe returned %s", gst_flow_get_name (ret));
4046 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4048 /* the probe filled the buffer and asks us to not call the getrange
4049 * anymore, we continue with the post probes then. */
4050 GST_DEBUG_OBJECT (pad, "handled buffer");
4054 /* no buffer, we are EOS */
4055 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4059 GST_OBJECT_UNLOCK (pad);
4060 GST_PAD_STREAM_UNLOCK (pad);
4064 probe_stopped_unref:
4066 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4067 "probe returned %s", gst_flow_get_name (ret));
4068 /* if we drop here, it signals EOS */
4069 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4071 GST_OBJECT_UNLOCK (pad);
4072 GST_PAD_STREAM_UNLOCK (pad);
4073 if (*buffer == NULL)
4074 gst_buffer_unref (res_buf);
4079 GST_PAD_STREAM_UNLOCK (pad);
4080 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4081 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4082 pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
4088 * gst_pad_get_range:
4089 * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4090 * @offset: The start offset of the buffer
4091 * @size: The length of the buffer
4092 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
4093 * returns #GST_FLOW_ERROR if %NULL.
4095 * When @pad is flushing this function returns #GST_FLOW_FLUSHING
4096 * immediately and @buffer is %NULL.
4098 * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4099 * description of a getrange function. If @pad has no getrange function
4100 * installed (see gst_pad_set_getrange_function()) this function returns
4101 * #GST_FLOW_NOT_SUPPORTED.
4103 * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be
4104 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4105 * must be freed with gst_buffer_unref() after usage.
4107 * When @buffer points to a variable that points to a valid #GstBuffer, the
4108 * buffer will be filled with the result data when this function returns
4109 * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4110 * @size bytes will be filled in the result buffer and its size will be updated
4113 * Note that less than @size bytes can be returned in @buffer when, for example,
4114 * an EOS condition is near or when @buffer is not large enough to hold @size
4115 * bytes. The caller should check the result buffer size to get the result size.
4117 * When this function returns any other result value than #GST_FLOW_OK, @buffer
4118 * will be unchanged.
4120 * This is a lowlevel function. Usualy gst_pad_pull_range() is used.
4122 * Returns: a #GstFlowReturn from the pad.
4127 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4128 GstBuffer ** buffer)
4130 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4131 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4132 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4133 g_return_val_if_fail (*buffer == NULL
4134 || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4136 return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4140 * gst_pad_pull_range:
4141 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4142 * @offset: The start offset of the buffer
4143 * @size: The length of the buffer
4144 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4145 * GST_FLOW_ERROR if %NULL.
4147 * Pulls a @buffer from the peer pad or fills up a provided buffer.
4149 * This function will first trigger the pad block signal if it was
4152 * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4153 * function returns the result of gst_pad_get_range() on the peer pad.
4154 * See gst_pad_get_range() for a list of return values and for the
4155 * semantics of the arguments of this function.
4157 * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be
4158 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4159 * must be freed with gst_buffer_unref() after usage. When this function
4160 * returns any other result value, @buffer will still point to NULL.
4162 * When @buffer points to a variable that points to a valid #GstBuffer, the
4163 * buffer will be filled with the result data when this function returns
4164 * #GST_FLOW_OK. When this function returns any other result value,
4165 * @buffer will be unchanged. If the provided buffer is larger than @size, only
4166 * @size bytes will be filled in the result buffer and its size will be updated
4169 * Note that less than @size bytes can be returned in @buffer when, for example,
4170 * an EOS condition is near or when @buffer is not large enough to hold @size
4171 * bytes. The caller should check the result buffer size to get the result size.
4173 * Returns: a #GstFlowReturn from the peer pad.
4178 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4179 GstBuffer ** buffer)
4185 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4186 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4187 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4188 g_return_val_if_fail (*buffer == NULL
4189 || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4191 GST_OBJECT_LOCK (pad);
4192 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4195 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4200 /* when one of the probes returns DROPPED, probe_stopped will be
4201 * called and we skip calling the peer getrange function. *buffer should then
4202 * contain a valid buffer */
4203 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4204 res_buf, offset, size, probe_stopped);
4206 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4209 gst_object_ref (peer);
4211 GST_OBJECT_UNLOCK (pad);
4213 ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4215 gst_object_unref (peer);
4217 GST_OBJECT_LOCK (pad);
4219 if (pad->priv->using == 0) {
4220 /* pad is not active anymore, trigger idle callbacks */
4221 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4222 probe_stopped_unref, ret);
4225 if (G_UNLIKELY (ret != GST_FLOW_OK))
4226 goto pull_range_failed;
4229 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4230 res_buf, offset, size, probe_stopped_unref);
4232 GST_OBJECT_UNLOCK (pad);
4238 /* ERROR recovery here */
4241 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4242 "pullrange, but pad was flushing");
4243 GST_OBJECT_UNLOCK (pad);
4244 return GST_FLOW_FLUSHING;
4248 g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4249 GST_DEBUG_PAD_NAME (pad));
4250 GST_OBJECT_UNLOCK (pad);
4251 return GST_FLOW_ERROR;
4255 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4256 gst_flow_get_name (ret));
4257 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4259 /* the probe filled the buffer and asks us to not forward to the peer
4260 * anymore, we continue with the post probes then */
4261 GST_DEBUG_OBJECT (pad, "handled buffer");
4265 /* no buffer, we are EOS then */
4266 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4270 GST_OBJECT_UNLOCK (pad);
4275 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4276 "pulling range, but it was not linked");
4277 GST_OBJECT_UNLOCK (pad);
4278 return GST_FLOW_NOT_LINKED;
4282 GST_OBJECT_UNLOCK (pad);
4283 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4284 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4285 pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4288 probe_stopped_unref:
4290 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4291 "post probe returned %s", gst_flow_get_name (ret));
4292 GST_OBJECT_UNLOCK (pad);
4293 /* if we drop here, it signals EOS */
4294 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4296 if (*buffer == NULL)
4297 gst_buffer_unref (res_buf);
4303 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event, gboolean locked)
4308 gboolean res = FALSE;
4309 const gchar *name = NULL;
4311 type = GST_EVENT_TYPE (event);
4312 if (type & GST_EVENT_TYPE_STICKY_MULTI)
4313 name = gst_structure_get_name (gst_event_get_structure (event));
4315 events = pad->priv->events;
4318 for (i = 0; i < len; i++) {
4319 PadEvent *ev = &g_array_index (events, PadEvent, i);
4321 if (ev->event == NULL)
4324 if (type == GST_EVENT_TYPE (ev->event)) {
4325 /* matching types, check matching name if needed */
4326 if (name && !gst_event_has_name (ev->event, name))
4330 if ((res = gst_event_replace (&ev->event, event)))
4331 ev->received = FALSE;
4337 ev.event = gst_event_ref (event);
4338 ev.received = FALSE;
4339 g_array_append_val (events, ev);
4344 pad->priv->events_cookie++;
4345 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4347 GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
4349 switch (GST_EVENT_TYPE (event)) {
4350 case GST_EVENT_CAPS:
4352 GST_OBJECT_UNLOCK (pad);
4354 GST_DEBUG_OBJECT (pad, "notify caps");
4355 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
4358 GST_OBJECT_LOCK (pad);
4367 /* should be called with pad LOCK */
4368 static GstFlowReturn
4369 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
4370 GstPadProbeType type)
4374 GstEventType event_type;
4376 /* Two checks to be made:
4377 * . (un)set the FLUSHING flag for flushing events,
4378 * . handle pad blocking */
4379 event_type = GST_EVENT_TYPE (event);
4380 switch (event_type) {
4381 case GST_EVENT_FLUSH_START:
4382 GST_PAD_SET_FLUSHING (pad);
4384 GST_PAD_BLOCK_BROADCAST (pad);
4385 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4387 case GST_EVENT_FLUSH_STOP:
4388 GST_PAD_UNSET_FLUSHING (pad);
4390 /* Remove sticky EOS events */
4391 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4392 remove_event_by_type (pad, GST_EVENT_EOS);
4393 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
4395 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4399 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4402 /* No need to check for EOS here as either the caller (gst_pad_push_event())
4403 * checked already or this is called as part of pushing sticky events,
4404 * in which case we still want to forward the EOS event downstream.
4407 switch (GST_EVENT_TYPE (event)) {
4408 case GST_EVENT_SEGMENT:
4409 /* pass the adjusted segment event on. We need to do this even if
4410 * there is no peer pad because of the probes. */
4411 event = apply_pad_offset (pad, event);
4413 case GST_EVENT_RECONFIGURE:
4414 if (GST_PAD_IS_SINK (pad))
4415 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4420 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4421 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4426 /* send probes after modifying the events above */
4427 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4429 /* now check the peer pad */
4430 peerpad = GST_PAD_PEER (pad);
4431 if (peerpad == NULL)
4434 gst_object_ref (peerpad);
4436 GST_OBJECT_UNLOCK (pad);
4438 GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
4439 event, GST_EVENT_TYPE_NAME (event), peerpad);
4441 ret = gst_pad_send_event_unchecked (peerpad, event, type);
4443 /* Note: we gave away ownership of the event at this point but we can still
4444 * print the old pointer */
4445 GST_LOG_OBJECT (pad,
4446 "sent event %p to peerpad %" GST_PTR_FORMAT ", ret %s", event, peerpad,
4447 gst_flow_get_name (ret));
4449 gst_object_unref (peerpad);
4451 GST_OBJECT_LOCK (pad);
4453 if (pad->priv->using == 0) {
4454 /* pad is not active anymore, trigger idle callbacks */
4455 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4456 idle_probe_stopped, ret);
4460 /* ERROR handling */
4463 GST_DEBUG_OBJECT (pad, "We're flushing");
4464 gst_event_unref (event);
4465 return GST_FLOW_FLUSHING;
4469 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4470 gst_event_unref (event);
4473 case GST_FLOW_CUSTOM_SUCCESS:
4474 GST_DEBUG_OBJECT (pad, "dropped event");
4478 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4485 GST_DEBUG_OBJECT (pad, "Dropping event because pad is not linked");
4486 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4487 gst_event_unref (event);
4489 /* unlinked pads should not influence latency configuration */
4490 if (event_type == GST_EVENT_LATENCY)
4493 return GST_FLOW_NOT_LINKED;
4497 GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
4503 * gst_pad_push_event:
4504 * @pad: a #GstPad to push the event to.
4505 * @event: (transfer full): the #GstEvent to send to the pad.
4507 * Sends the event to the peer of the given pad. This function is
4508 * mainly used by elements to send events to their peer
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.
4519 gst_pad_push_event (GstPad * pad, GstEvent * event)
4521 gboolean res = FALSE;
4522 GstPadProbeType type;
4523 gboolean sticky, serialized;
4525 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4526 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4528 if (GST_PAD_IS_SRC (pad)) {
4529 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4530 goto wrong_direction;
4531 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4532 } else if (GST_PAD_IS_SINK (pad)) {
4533 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4534 goto wrong_direction;
4535 /* events pushed on sinkpad never are sticky */
4536 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4538 goto unknown_direction;
4540 GST_OBJECT_LOCK (pad);
4541 sticky = GST_EVENT_IS_STICKY (event);
4542 serialized = GST_EVENT_IS_SERIALIZED (event);
4545 /* can't store on flushing pads */
4546 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4549 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4552 /* srcpad sticky events are store immediately, the received flag is set
4553 * to FALSE and will be set to TRUE when we can successfully push the
4554 * event to the peer pad */
4555 if (gst_pad_store_sticky_event (pad, event, TRUE)) {
4556 GST_DEBUG_OBJECT (pad, "event %s updated", GST_EVENT_TYPE_NAME (event));
4558 if (GST_EVENT_TYPE (event) == GST_EVENT_EOS)
4559 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
4561 if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
4562 /* all serialized or sticky events on the srcpad trigger push of
4564 res = (check_sticky (pad) == GST_FLOW_OK);
4567 /* other events are pushed right away */
4568 res = (gst_pad_push_event_unchecked (pad, event, type) == GST_FLOW_OK);
4570 /* Errors in sticky event pushing are no problem and ignored here
4571 * as they will cause more meaningful errors during data flow.
4572 * For EOS events, that are not followed by data flow, we still
4573 * return FALSE here though.
4575 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
4577 gst_event_unref (event);
4579 GST_OBJECT_UNLOCK (pad);
4583 /* ERROR handling */
4586 g_warning ("pad %s:%s pushing %s event in wrong direction",
4587 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4588 gst_event_unref (event);
4593 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4594 gst_event_unref (event);
4599 GST_DEBUG_OBJECT (pad, "We're flushing");
4600 GST_OBJECT_UNLOCK (pad);
4601 gst_event_unref (event);
4606 GST_DEBUG_OBJECT (pad, "We're EOS");
4607 GST_OBJECT_UNLOCK (pad);
4608 gst_event_unref (event);
4613 /* Check if we can call the event function with the given event */
4614 static GstFlowReturn
4615 pre_eventfunc_check (GstPad * pad, GstEvent * event)
4619 switch (GST_EVENT_TYPE (event)) {
4620 case GST_EVENT_CAPS:
4622 /* backwards compatibility mode for caps */
4623 gst_event_parse_caps (event, &caps);
4625 if (!gst_pad_query_accept_caps (pad, caps))
4637 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
4638 "caps %" GST_PTR_FORMAT " not accepted", caps);
4639 return GST_FLOW_NOT_NEGOTIATED;
4643 static GstFlowReturn
4644 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
4645 GstPadProbeType type)
4648 GstEventType event_type;
4649 gboolean serialized, need_unlock = FALSE, sticky;
4650 GstPadEventFunction eventfunc;
4653 GST_OBJECT_LOCK (pad);
4654 if (GST_PAD_IS_SINK (pad))
4655 serialized = GST_EVENT_IS_SERIALIZED (event);
4658 sticky = GST_EVENT_IS_STICKY (event);
4659 event_type = GST_EVENT_TYPE (event);
4660 switch (event_type) {
4661 case GST_EVENT_FLUSH_START:
4662 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4663 "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
4665 /* can't even accept a flush begin event when flushing */
4666 if (GST_PAD_IS_FLUSHING (pad))
4669 GST_PAD_SET_FLUSHING (pad);
4670 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
4672 case GST_EVENT_FLUSH_STOP:
4673 if (G_LIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_NONE)) {
4674 GST_PAD_UNSET_FLUSHING (pad);
4675 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
4677 /* Remove pending EOS events */
4678 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4679 remove_event_by_type (pad, GST_EVENT_EOS);
4680 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
4682 GST_OBJECT_UNLOCK (pad);
4683 /* grab stream lock */
4684 GST_PAD_STREAM_LOCK (pad);
4686 GST_OBJECT_LOCK (pad);
4687 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4690 case GST_EVENT_RECONFIGURE:
4691 if (GST_PAD_IS_SRC (pad))
4692 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4694 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4695 "have event type %" GST_PTR_FORMAT, event);
4697 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4701 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4704 /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
4705 GST_OBJECT_UNLOCK (pad);
4706 GST_PAD_STREAM_LOCK (pad);
4708 GST_OBJECT_LOCK (pad);
4709 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4712 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4716 switch (GST_EVENT_TYPE (event)) {
4717 case GST_EVENT_SEGMENT:
4718 event = apply_pad_offset (pad, event);
4724 /* now do the probe */
4726 type | GST_PAD_PROBE_TYPE_PUSH |
4727 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4729 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4733 if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
4736 ACQUIRE_PARENT (pad, parent, no_parent);
4737 GST_OBJECT_UNLOCK (pad);
4739 ret = pre_eventfunc_check (pad, event);
4740 if (G_UNLIKELY (ret != GST_FLOW_OK))
4741 goto precheck_failed;
4744 gst_event_ref (event);
4746 if (eventfunc (pad, parent, event)) {
4749 /* something went wrong */
4750 switch (event_type) {
4751 case GST_EVENT_CAPS:
4752 ret = GST_FLOW_NOT_NEGOTIATED;
4755 ret = GST_FLOW_ERROR;
4759 RELEASE_PARENT (parent);
4761 GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
4764 if (ret == GST_FLOW_OK) {
4765 /* after the event function accepted the event, we can store the sticky
4766 * event on the pad */
4767 gst_pad_store_sticky_event (pad, event, FALSE);
4768 if (event_type == GST_EVENT_EOS)
4769 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
4771 gst_event_unref (event);
4775 GST_PAD_STREAM_UNLOCK (pad);
4779 /* ERROR handling */
4782 GST_OBJECT_UNLOCK (pad);
4784 GST_PAD_STREAM_UNLOCK (pad);
4785 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
4786 "Received event on flushing pad. Discarding");
4787 gst_event_unref (event);
4788 return GST_FLOW_FLUSHING;
4792 GST_OBJECT_UNLOCK (pad);
4794 GST_PAD_STREAM_UNLOCK (pad);
4795 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
4796 "Received event on EOS pad. Discarding");
4797 gst_event_unref (event);
4798 return GST_FLOW_EOS;
4802 GST_OBJECT_UNLOCK (pad);
4804 GST_PAD_STREAM_UNLOCK (pad);
4805 gst_event_unref (event);
4808 case GST_FLOW_CUSTOM_SUCCESS:
4809 GST_DEBUG_OBJECT (pad, "dropped event");
4813 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4820 g_warning ("pad %s:%s has no event handler, file a bug.",
4821 GST_DEBUG_PAD_NAME (pad));
4822 GST_OBJECT_UNLOCK (pad);
4824 GST_PAD_STREAM_UNLOCK (pad);
4825 gst_event_unref (event);
4826 return GST_FLOW_NOT_SUPPORTED;
4830 GST_DEBUG_OBJECT (pad, "no parent");
4831 GST_OBJECT_UNLOCK (pad);
4833 GST_PAD_STREAM_UNLOCK (pad);
4834 gst_event_unref (event);
4835 return GST_FLOW_FLUSHING;
4839 GST_DEBUG_OBJECT (pad, "pre event check failed");
4840 RELEASE_PARENT (parent);
4842 GST_PAD_STREAM_UNLOCK (pad);
4843 gst_event_unref (event);
4849 * gst_pad_send_event:
4850 * @pad: a #GstPad to send the event to.
4851 * @event: (transfer full): the #GstEvent to send to the pad.
4853 * Sends the event to the pad. This function can be used
4854 * by applications to send events in the pipeline.
4856 * If @pad is a source pad, @event should be an upstream event. If @pad is a
4857 * sink pad, @event should be a downstream event. For example, you would not
4858 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
4859 * Furthermore, some downstream events have to be serialized with data flow,
4860 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
4861 * the event needs to be serialized with data flow, this function will take the
4862 * pad's stream lock while calling its event function.
4864 * To find out whether an event type is upstream, downstream, or downstream and
4865 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
4866 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
4867 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
4868 * plugin doesn't need to bother itself with this information; the core handles
4869 * all necessary locks and checks.
4871 * This function takes owership of the provided event so you should
4872 * gst_event_ref() it if you want to reuse the event after this call.
4874 * Returns: TRUE if the event was handled.
4877 gst_pad_send_event (GstPad * pad, GstEvent * event)
4880 GstPadProbeType type;
4882 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4883 g_return_val_if_fail (event != NULL, FALSE);
4885 if (GST_PAD_IS_SINK (pad)) {
4886 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4887 goto wrong_direction;
4888 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4889 } else if (GST_PAD_IS_SRC (pad)) {
4890 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4891 goto wrong_direction;
4892 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4894 goto unknown_direction;
4896 if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
4903 /* ERROR handling */
4906 g_warning ("pad %s:%s sending %s event in wrong direction",
4907 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4908 gst_event_unref (event);
4913 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4914 gst_event_unref (event);
4920 * gst_pad_set_element_private:
4921 * @pad: the #GstPad to set the private data of.
4922 * @priv: The private data to attach to the pad.
4924 * Set the given private data gpointer on the pad.
4925 * This function can only be used by the element that owns the pad.
4926 * No locking is performed in this function.
4929 gst_pad_set_element_private (GstPad * pad, gpointer priv)
4931 pad->element_private = priv;
4935 * gst_pad_get_element_private:
4936 * @pad: the #GstPad to get the private data of.
4938 * Gets the private data of a pad.
4939 * No locking is performed in this function.
4941 * Returns: (transfer none): a #gpointer to the private data.
4944 gst_pad_get_element_private (GstPad * pad)
4946 return pad->element_private;
4950 * gst_pad_get_sticky_event:
4951 * @pad: the #GstPad to get the event from.
4952 * @event_type: the #GstEventType that should be retrieved.
4953 * @idx: the index of the event
4955 * Returns a new reference of the sticky event of type @event_type
4958 * Returns: (transfer full): a #GstEvent of type @event_type or NULL when no
4959 * event of @event_type was on @pad. Unref after usage.
4962 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
4964 GstEvent *event = NULL;
4967 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
4968 g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
4970 GST_OBJECT_LOCK (pad);
4971 ev = find_event_by_type (pad, event_type, idx);
4972 if (ev && (event = ev->event))
4973 gst_event_ref (event);
4974 GST_OBJECT_UNLOCK (pad);
4981 GstPadStickyEventsForeachFunction func;
4986 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
4988 ForeachDispatch *data = user_data;
4991 GST_OBJECT_UNLOCK (pad);
4993 ret = data->func (pad, &ev->event, data->user_data);
4995 GST_OBJECT_LOCK (pad);
5001 * gst_pad_sticky_events_foreach:
5002 * @pad: the #GstPad that should be used for iteration.
5003 * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
5004 * should be called for every event.
5005 * @user_data: (closure): the optional user data.
5007 * Iterates all sticky events on @pad and calls @foreach_func for every
5008 * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
5011 gst_pad_sticky_events_foreach (GstPad * pad,
5012 GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
5014 ForeachDispatch data;
5016 g_return_if_fail (GST_IS_PAD (pad));
5017 g_return_if_fail (foreach_func != NULL);
5019 data.func = foreach_func;
5020 data.user_data = user_data;
5022 GST_OBJECT_LOCK (pad);
5023 events_foreach (pad, foreach_dispatch_function, &data);
5024 GST_OBJECT_UNLOCK (pad);
5028 do_stream_status (GstPad * pad, GstStreamStatusType type,
5029 GThread * thread, GstTask * task)
5033 GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5035 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5036 if (GST_IS_ELEMENT (parent)) {
5037 GstMessage *message;
5038 GValue value = { 0 };
5040 if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5041 gchar *tname, *ename, *pname;
5043 /* create a good task name */
5044 ename = gst_element_get_name (parent);
5045 pname = gst_pad_get_name (pad);
5046 tname = g_strdup_printf ("%s:%s", ename, pname);
5050 gst_object_set_name (GST_OBJECT_CAST (task), tname);
5054 message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5057 g_value_init (&value, GST_TYPE_TASK);
5058 g_value_set_object (&value, task);
5059 gst_message_set_stream_status_object (message, &value);
5060 g_value_unset (&value);
5062 GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5063 gst_element_post_message (parent, message);
5065 gst_object_unref (parent);
5070 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5072 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5077 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5079 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5084 * gst_pad_start_task:
5085 * @pad: the #GstPad to start the task of
5086 * @func: the task function to call
5087 * @user_data: user data passed to the task function
5088 * @notify: called when @user_data is no longer referenced
5090 * Starts a task that repeatedly calls @func with @user_data. This function
5091 * is mostly used in pad activation functions to start the dataflow.
5092 * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5093 * before @func is called.
5095 * Returns: a %TRUE if the task could be started.
5098 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer user_data,
5099 GDestroyNotify notify)
5104 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5105 g_return_val_if_fail (func != NULL, FALSE);
5107 GST_DEBUG_OBJECT (pad, "start task");
5109 GST_OBJECT_LOCK (pad);
5110 task = GST_PAD_TASK (pad);
5112 task = gst_task_new (func, user_data, notify);
5113 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5114 gst_task_set_enter_callback (task, pad_enter_thread, pad, NULL);
5115 gst_task_set_leave_callback (task, pad_leave_thread, pad, NULL);
5116 GST_INFO_OBJECT (pad, "created task %p", task);
5117 GST_PAD_TASK (pad) = task;
5118 gst_object_ref (task);
5119 /* release lock to post the message */
5120 GST_OBJECT_UNLOCK (pad);
5122 do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
5124 gst_object_unref (task);
5126 GST_OBJECT_LOCK (pad);
5127 /* nobody else is supposed to have changed the pad now */
5128 if (GST_PAD_TASK (pad) != task)
5129 goto concurrent_stop;
5131 res = gst_task_set_state (task, GST_TASK_STARTED);
5132 GST_OBJECT_UNLOCK (pad);
5139 GST_OBJECT_UNLOCK (pad);
5145 * gst_pad_pause_task:
5146 * @pad: the #GstPad to pause the task of
5148 * Pause the task of @pad. This function will also wait until the
5149 * function executed by the task is finished if this function is not
5150 * called from the task function.
5152 * Returns: a TRUE if the task could be paused or FALSE when the pad
5156 gst_pad_pause_task (GstPad * pad)
5161 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5163 GST_DEBUG_OBJECT (pad, "pause task");
5165 GST_OBJECT_LOCK (pad);
5166 task = GST_PAD_TASK (pad);
5169 res = gst_task_set_state (task, GST_TASK_PAUSED);
5170 GST_OBJECT_UNLOCK (pad);
5172 /* wait for task function to finish, this lock is recursive so it does nothing
5173 * when the pause is called from the task itself */
5174 GST_PAD_STREAM_LOCK (pad);
5175 GST_PAD_STREAM_UNLOCK (pad);
5181 GST_DEBUG_OBJECT (pad, "pad has no task");
5182 GST_OBJECT_UNLOCK (pad);
5188 * gst_pad_stop_task:
5189 * @pad: the #GstPad to stop the task of
5191 * Stop the task of @pad. This function will also make sure that the
5192 * function executed by the task will effectively stop if not called
5193 * from the GstTaskFunction.
5195 * This function will deadlock if called from the GstTaskFunction of
5196 * the task. Use gst_task_pause() instead.
5198 * Regardless of whether the pad has a task, the stream lock is acquired and
5199 * released so as to ensure that streaming through this pad has finished.
5201 * Returns: a TRUE if the task could be stopped or FALSE on error.
5204 gst_pad_stop_task (GstPad * pad)
5209 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5211 GST_DEBUG_OBJECT (pad, "stop task");
5213 GST_OBJECT_LOCK (pad);
5214 task = GST_PAD_TASK (pad);
5217 GST_PAD_TASK (pad) = NULL;
5218 res = gst_task_set_state (task, GST_TASK_STOPPED);
5219 GST_OBJECT_UNLOCK (pad);
5221 GST_PAD_STREAM_LOCK (pad);
5222 GST_PAD_STREAM_UNLOCK (pad);
5224 if (!gst_task_join (task))
5227 gst_object_unref (task);
5233 GST_DEBUG_OBJECT (pad, "no task");
5234 GST_OBJECT_UNLOCK (pad);
5236 GST_PAD_STREAM_LOCK (pad);
5237 GST_PAD_STREAM_UNLOCK (pad);
5239 /* this is not an error */
5244 /* this is bad, possibly the application tried to join the task from
5245 * the task's thread. We install the task again so that it will be stopped
5246 * again from the right thread next time hopefully. */
5247 GST_OBJECT_LOCK (pad);
5248 GST_DEBUG_OBJECT (pad, "join failed");
5249 /* we can only install this task if there was no other task */
5250 if (GST_PAD_TASK (pad) == NULL)
5251 GST_PAD_TASK (pad) = task;
5252 GST_OBJECT_UNLOCK (pad);