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))
954 GST_OBJECT_LOCK (pad);
955 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
956 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
957 GST_OBJECT_UNLOCK (pad);
964 GST_DEBUG_OBJECT (pad, "no parent");
965 GST_OBJECT_UNLOCK (pad);
970 GST_OBJECT_LOCK (pad);
972 g_critical ("Failed to deactivate pad %s:%s, very bad",
973 GST_DEBUG_PAD_NAME (pad));
975 GST_WARNING_OBJECT (pad, "Failed to activate pad");
977 GST_OBJECT_UNLOCK (pad);
983 * gst_pad_activate_mode:
984 * @pad: the #GstPad to activate or deactivate.
985 * @mode: the requested activation mode
986 * @active: whether or not the pad should be active.
988 * Activates or deactivates the given pad in @mode via dispatching to the
989 * pad's activatemodefunc. For use from within pad activation functions only.
991 * If you don't know what this is, you probably don't want to call it.
993 * Returns: TRUE if the operation was successful.
998 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
1000 gboolean res = FALSE;
1002 GstPadMode old, new;
1003 GstPadDirection dir;
1006 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1008 GST_OBJECT_LOCK (pad);
1009 old = GST_PAD_MODE (pad);
1010 dir = GST_PAD_DIRECTION (pad);
1011 ACQUIRE_PARENT (pad, parent, no_parent);
1012 GST_OBJECT_UNLOCK (pad);
1014 new = active ? mode : GST_PAD_MODE_NONE;
1019 if (active && old != mode) {
1020 /* pad was activate in the wrong direction, deactivate it
1021 * and reactivate it in the requested mode */
1022 GST_DEBUG_OBJECT (pad, "deactivating pad from %s mode",
1023 gst_pad_mode_get_name (old));
1025 if (G_UNLIKELY (!gst_pad_activate_mode (pad, old, FALSE)))
1026 goto deactivate_failed;
1030 case GST_PAD_MODE_PULL:
1032 if (dir == GST_PAD_SINK) {
1033 if ((peer = gst_pad_get_peer (pad))) {
1034 GST_DEBUG_OBJECT (pad, "calling peer");
1035 if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
1037 gst_object_unref (peer);
1039 /* there is no peer, this is only fatal when we activate. When we
1040 * deactivate, we must assume the application has unlinked the peer and
1041 * will deactivate it eventually. */
1045 GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
1048 if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
1049 goto failure; /* Can't activate pull on a src without a
1050 getrange function */
1058 pre_activate (pad, new);
1060 if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1061 if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1065 /* can happen for sinks of passthrough elements */
1068 post_activate (pad, new);
1070 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in %s mode",
1071 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1076 RELEASE_PARENT (parent);
1082 GST_DEBUG_OBJECT (pad, "no parent");
1083 GST_OBJECT_UNLOCK (pad);
1088 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in %s mode",
1089 active ? "activated" : "deactivated", gst_pad_mode_get_name (mode));
1094 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1095 "failed to %s in switch to %s mode from %s mode",
1096 (active ? "activate" : "deactivate"), gst_pad_mode_get_name (mode),
1097 gst_pad_mode_get_name (old));
1102 GST_OBJECT_LOCK (peer);
1103 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1104 "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1105 GST_OBJECT_UNLOCK (peer);
1106 gst_object_unref (peer);
1111 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1112 "pad in pull mode");
1117 GST_OBJECT_LOCK (pad);
1118 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in %s mode",
1119 active ? "activate" : "deactivate", gst_pad_mode_get_name (mode));
1120 GST_PAD_SET_FLUSHING (pad);
1121 GST_PAD_MODE (pad) = old;
1122 GST_OBJECT_UNLOCK (pad);
1128 * gst_pad_is_active:
1129 * @pad: the #GstPad to query
1131 * Query if a pad is active
1133 * Returns: TRUE if the pad is active.
1138 gst_pad_is_active (GstPad * pad)
1140 gboolean result = FALSE;
1142 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1144 GST_OBJECT_LOCK (pad);
1145 result = GST_PAD_IS_ACTIVE (pad);
1146 GST_OBJECT_UNLOCK (pad);
1152 * gst_pad_add_probe:
1153 * @pad: the #GstPad to add the probe to
1154 * @mask: the probe mask
1155 * @callback: #GstPadProbeCallback that will be called with notifications of
1157 * @user_data: (closure): user data passed to the callback
1158 * @destroy_data: #GDestroyNotify for user_data
1160 * Be notified of different states of pads. The provided callback is called for
1161 * every state that matches @mask.
1163 * Returns: an id or 0 on error. The id can be used to remove the probe with
1164 * gst_pad_remove_probe().
1169 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1170 GstPadProbeCallback callback, gpointer user_data,
1171 GDestroyNotify destroy_data)
1176 g_return_val_if_fail (GST_IS_PAD (pad), 0);
1177 g_return_val_if_fail (mask != 0, 0);
1179 GST_OBJECT_LOCK (pad);
1181 /* make a new probe */
1182 hook = g_hook_alloc (&pad->probes);
1184 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1187 /* when no contraints are given for the types, assume all types are
1189 if ((mask & GST_PAD_PROBE_TYPE_ALL_BOTH) == 0)
1190 mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1191 if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1192 mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1194 /* store our flags and other fields */
1195 hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1196 hook->func = callback;
1197 hook->data = user_data;
1198 hook->destroy = destroy_data;
1199 PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1202 g_hook_prepend (&pad->probes, hook);
1204 /* incremenent cookie so that the new hook get's called */
1205 pad->priv->probe_list_cookie++;
1207 /* get the id of the hook, we return this and it can be used to remove the
1209 res = hook->hook_id;
1211 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1213 if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1214 /* we have a block probe */
1216 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1217 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1218 "now %d blocking probes", pad->num_blocked);
1221 /* call the callback if we need to be called for idle callbacks */
1222 if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1223 if (pad->priv->using > 0) {
1224 /* the pad is in use, we can't signal the idle callback yet. Since we set the
1225 * flag above, the last thread to leave the push will do the callback. New
1226 * threads going into the push will block. */
1227 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1228 "pad is in use, delay idle callback");
1229 GST_OBJECT_UNLOCK (pad);
1231 GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1233 /* the pad is idle now, we can signal the idle callback now */
1234 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1235 "pad is idle, trigger idle callback");
1236 GST_OBJECT_UNLOCK (pad);
1238 callback (pad, &info, user_data);
1241 GST_OBJECT_UNLOCK (pad);
1247 cleanup_hook (GstPad * pad, GHook * hook)
1249 GstPadProbeType type;
1251 type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1253 if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1254 /* unblock when we remove the last blocking probe */
1256 GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1258 if (pad->num_blocked == 0) {
1259 GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1260 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1261 GST_PAD_BLOCK_BROADCAST (pad);
1264 g_hook_destroy_link (&pad->probes, hook);
1269 * gst_pad_remove_probe:
1270 * @pad: the #GstPad with the probe
1271 * @id: the probe id to remove
1273 * Remove the probe with @id from @pad.
1278 gst_pad_remove_probe (GstPad * pad, gulong id)
1282 g_return_if_fail (GST_IS_PAD (pad));
1284 GST_OBJECT_LOCK (pad);
1286 hook = g_hook_get (&pad->probes, id);
1290 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1292 cleanup_hook (pad, hook);
1293 GST_OBJECT_UNLOCK (pad);
1299 GST_OBJECT_UNLOCK (pad);
1300 g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1306 * gst_pad_is_blocked:
1307 * @pad: the #GstPad to query
1309 * Checks if the pad is blocked or not. This function returns the
1310 * last requested state of the pad. It is not certain that the pad
1311 * is actually blocking at this point (see gst_pad_is_blocking()).
1313 * Returns: TRUE if the pad is blocked.
1318 gst_pad_is_blocked (GstPad * pad)
1320 gboolean result = FALSE;
1322 g_return_val_if_fail (GST_IS_PAD (pad), result);
1324 GST_OBJECT_LOCK (pad);
1325 result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1326 GST_OBJECT_UNLOCK (pad);
1332 * gst_pad_is_blocking:
1333 * @pad: the #GstPad to query
1335 * Checks if the pad is blocking or not. This is a guaranteed state
1336 * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1338 * Returns: TRUE if the pad is blocking.
1345 gst_pad_is_blocking (GstPad * pad)
1347 gboolean result = FALSE;
1349 g_return_val_if_fail (GST_IS_PAD (pad), result);
1351 GST_OBJECT_LOCK (pad);
1352 /* the blocking flag is only valid if the pad is not flushing */
1353 result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1354 GST_OBJECT_UNLOCK (pad);
1360 * gst_pad_check_reconfigure:
1361 * @pad: the #GstPad to check
1363 * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1364 * if the flag was set.
1366 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1369 gst_pad_check_reconfigure (GstPad * pad)
1371 gboolean reconfigure;
1373 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1375 GST_OBJECT_LOCK (pad);
1376 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1378 GST_DEBUG_OBJECT (pad, "remove RECONFIGURE flag");
1379 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1380 GST_OBJECT_UNLOCK (pad);
1386 * gst_pad_mark_reconfigure:
1387 * @pad: the #GstPad to mark
1389 * Mark a pad for needing reconfiguration. The next call to
1390 * gst_pad_check_reconfigure() will return %TRUE after this call.
1393 gst_pad_mark_reconfigure (GstPad * pad)
1395 g_return_if_fail (GST_IS_PAD (pad));
1397 GST_OBJECT_LOCK (pad);
1398 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1399 GST_OBJECT_UNLOCK (pad);
1403 * gst_pad_set_activate_function:
1405 * @f: the #GstPadActivateFunction to set.
1407 * Calls gst_pad_set_activate_function_full() with NULL for the user_data and
1411 * gst_pad_set_activate_function_full:
1413 * @activate: the #GstPadActivateFunction to set.
1414 * @user_data: user_data passed to @notify
1415 * @notify: notify called when @activate will not be used anymore.
1417 * Sets the given activate function for @pad. The activate function will
1418 * dispatch to gst_pad_activate_push() or gst_pad_activate_pull() to perform
1419 * the actual activation. Only makes sense to set on sink pads.
1421 * Call this function if your sink pad can start a pull-based task.
1424 gst_pad_set_activate_function_full (GstPad * pad,
1425 GstPadActivateFunction activate, gpointer user_data, GDestroyNotify notify)
1427 g_return_if_fail (GST_IS_PAD (pad));
1429 if (pad->activatenotify)
1430 pad->activatenotify (pad->activatedata);
1431 GST_PAD_ACTIVATEFUNC (pad) = activate;
1432 pad->activatedata = user_data;
1433 pad->activatenotify = notify;
1435 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1436 GST_DEBUG_FUNCPTR_NAME (activate));
1440 * gst_pad_set_activatemode_function:
1442 * @f: the #GstPadActivateModeFunction to set.
1444 * Calls gst_pad_set_activatemode_function_full() with NULL for the user_data and
1448 * gst_pad_set_activatemode_function_full:
1450 * @activatemode: the #GstPadActivateModeFunction to set.
1451 * @user_data: user_data passed to @notify
1452 * @notify: notify called when @activatemode will not be used anymore.
1454 * Sets the given activate_mode function for the pad. An activate_mode function
1455 * prepares the element for data passing.
1458 gst_pad_set_activatemode_function_full (GstPad * pad,
1459 GstPadActivateModeFunction activatemode, gpointer user_data,
1460 GDestroyNotify notify)
1462 g_return_if_fail (GST_IS_PAD (pad));
1464 if (pad->activatemodenotify)
1465 pad->activatemodenotify (pad->activatemodedata);
1466 GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1467 pad->activatemodedata = user_data;
1468 pad->activatemodenotify = notify;
1470 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1471 GST_DEBUG_FUNCPTR_NAME (activatemode));
1475 * gst_pad_set_chain_function:
1476 * @p: a sink #GstPad.
1477 * @f: the #GstPadChainFunction to set.
1479 * Calls gst_pad_set_chain_function_full() with NULL for the user_data and
1483 * gst_pad_set_chain_function_full:
1484 * @pad: a sink #GstPad.
1485 * @chain: the #GstPadChainFunction to set.
1486 * @user_data: user_data passed to @notify
1487 * @notify: notify called when @chain will not be used anymore.
1489 * Sets the given chain function for the pad. The chain function is called to
1490 * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1493 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1494 gpointer user_data, GDestroyNotify notify)
1496 g_return_if_fail (GST_IS_PAD (pad));
1497 g_return_if_fail (GST_PAD_IS_SINK (pad));
1499 if (pad->chainnotify)
1500 pad->chainnotify (pad->chaindata);
1501 GST_PAD_CHAINFUNC (pad) = chain;
1502 pad->chaindata = user_data;
1503 pad->chainnotify = notify;
1505 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1506 GST_DEBUG_FUNCPTR_NAME (chain));
1510 * gst_pad_set_chain_list_function:
1511 * @p: a sink #GstPad.
1512 * @f: the #GstPadChainListFunction to set.
1514 * Calls gst_pad_set_chain_list_function_full() with NULL for the user_data and
1518 * gst_pad_set_chain_list_function_full:
1519 * @pad: a sink #GstPad.
1520 * @chainlist: the #GstPadChainListFunction to set.
1521 * @user_data: user_data passed to @notify
1522 * @notify: notify called when @chainlist will not be used anymore.
1524 * Sets the given chain list function for the pad. The chainlist function is
1525 * called to process a #GstBufferList input buffer list. See
1526 * #GstPadChainListFunction for more details.
1531 gst_pad_set_chain_list_function_full (GstPad * pad,
1532 GstPadChainListFunction chainlist, gpointer user_data,
1533 GDestroyNotify notify)
1535 g_return_if_fail (GST_IS_PAD (pad));
1536 g_return_if_fail (GST_PAD_IS_SINK (pad));
1538 if (pad->chainlistnotify)
1539 pad->chainlistnotify (pad->chainlistdata);
1540 GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1541 pad->chainlistdata = user_data;
1542 pad->chainlistnotify = notify;
1544 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1545 GST_DEBUG_FUNCPTR_NAME (chainlist));
1549 * gst_pad_set_getrange_function:
1550 * @p: a source #GstPad.
1551 * @f: the #GstPadGetRangeFunction to set.
1553 * Calls gst_pad_set_getrange_function_full() with NULL for the user_data and
1557 * gst_pad_set_getrange_function_full:
1558 * @pad: a source #GstPad.
1559 * @get: the #GstPadGetRangeFunction to set.
1560 * @user_data: user_data passed to @notify
1561 * @notify: notify called when @get will not be used anymore.
1563 * Sets the given getrange function for the pad. The getrange function is
1564 * called to produce a new #GstBuffer to start the processing pipeline. see
1565 * #GstPadGetRangeFunction for a description of the getrange function.
1568 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1569 gpointer user_data, GDestroyNotify notify)
1571 g_return_if_fail (GST_IS_PAD (pad));
1572 g_return_if_fail (GST_PAD_IS_SRC (pad));
1574 if (pad->getrangenotify)
1575 pad->getrangenotify (pad->getrangedata);
1576 GST_PAD_GETRANGEFUNC (pad) = get;
1577 pad->getrangedata = user_data;
1578 pad->getrangenotify = notify;
1580 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1581 GST_DEBUG_FUNCPTR_NAME (get));
1585 * gst_pad_set_event_function:
1586 * @p: a #GstPad of either direction.
1587 * @f: the #GstPadEventFunction to set.
1589 * Calls gst_pad_set_event_function_full() with NULL for the user_data and
1593 * gst_pad_set_event_function_full:
1594 * @pad: a #GstPad of either direction.
1595 * @event: the #GstPadEventFunction to set.
1596 * @user_data: user_data passed to @notify
1597 * @notify: notify called when @event will not be used anymore.
1599 * Sets the given event handler for the pad.
1602 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1603 gpointer user_data, GDestroyNotify notify)
1605 g_return_if_fail (GST_IS_PAD (pad));
1607 if (pad->eventnotify)
1608 pad->eventnotify (pad->eventdata);
1609 GST_PAD_EVENTFUNC (pad) = event;
1610 pad->eventdata = user_data;
1611 pad->eventnotify = notify;
1613 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1614 GST_DEBUG_FUNCPTR_NAME (event));
1618 * gst_pad_set_query_function:
1619 * @p: a #GstPad of either direction.
1620 * @f: the #GstPadQueryFunction to set.
1622 * Calls gst_pad_set_query_function_full() with NULL for the user_data and
1626 * gst_pad_set_query_function_full:
1627 * @pad: a #GstPad of either direction.
1628 * @query: the #GstPadQueryFunction to set.
1629 * @user_data: user_data passed to @notify
1630 * @notify: notify called when @query will not be used anymore.
1632 * Set the given query function for the pad.
1635 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1636 gpointer user_data, GDestroyNotify notify)
1638 g_return_if_fail (GST_IS_PAD (pad));
1640 if (pad->querynotify)
1641 pad->querynotify (pad->querydata);
1642 GST_PAD_QUERYFUNC (pad) = query;
1643 pad->querydata = user_data;
1644 pad->querynotify = notify;
1646 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1647 GST_DEBUG_FUNCPTR_NAME (query));
1651 * gst_pad_set_iterate_internal_links_function:
1652 * @p: a #GstPad of either direction.
1653 * @f: the #GstPadIterIntLinkFunction to set.
1655 * Calls gst_pad_set_iterate_internal_links_function_full() with NULL
1656 * for the user_data and notify.
1659 * gst_pad_set_iterate_internal_links_function_full:
1660 * @pad: a #GstPad of either direction.
1661 * @iterintlink: the #GstPadIterIntLinkFunction to set.
1662 * @user_data: user_data passed to @notify
1663 * @notify: notify called when @iterintlink will not be used anymore.
1665 * Sets the given internal link iterator function for the pad.
1670 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1671 GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1672 GDestroyNotify notify)
1674 g_return_if_fail (GST_IS_PAD (pad));
1676 if (pad->iterintlinknotify)
1677 pad->iterintlinknotify (pad->iterintlinkdata);
1678 GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1679 pad->iterintlinkdata = user_data;
1680 pad->iterintlinknotify = notify;
1682 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1683 GST_DEBUG_FUNCPTR_NAME (iterintlink));
1687 * gst_pad_set_link_function:
1689 * @f: the #GstPadLinkFunction to set.
1691 * Calls gst_pad_set_link_function_full() with NULL
1692 * for the user_data and notify.
1695 * gst_pad_set_link_function_full:
1697 * @link: the #GstPadLinkFunction to set.
1698 * @user_data: user_data passed to @notify
1699 * @notify: notify called when @link will not be used anymore.
1701 * Sets the given link function for the pad. It will be called when
1702 * the pad is linked with another pad.
1704 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1707 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1708 * cannot be made for some reason.
1710 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1711 * of the peer sink pad, if present.
1714 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1715 gpointer user_data, GDestroyNotify notify)
1717 g_return_if_fail (GST_IS_PAD (pad));
1719 if (pad->linknotify)
1720 pad->linknotify (pad->linkdata);
1721 GST_PAD_LINKFUNC (pad) = link;
1722 pad->linkdata = user_data;
1723 pad->linknotify = notify;
1725 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1726 GST_DEBUG_FUNCPTR_NAME (link));
1730 * gst_pad_set_unlink_function:
1732 * @f: the #GstPadUnlinkFunction to set.
1734 * Calls gst_pad_set_unlink_function_full() with NULL
1735 * for the user_data and notify.
1738 * gst_pad_set_unlink_function_full:
1740 * @unlink: the #GstPadUnlinkFunction to set.
1741 * @user_data: user_data passed to @notify
1742 * @notify: notify called when @unlink will not be used anymore.
1744 * Sets the given unlink function for the pad. It will be called
1745 * when the pad is unlinked.
1748 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
1749 gpointer user_data, GDestroyNotify notify)
1751 g_return_if_fail (GST_IS_PAD (pad));
1753 if (pad->unlinknotify)
1754 pad->unlinknotify (pad->unlinkdata);
1755 GST_PAD_UNLINKFUNC (pad) = unlink;
1756 pad->unlinkdata = user_data;
1757 pad->unlinknotify = notify;
1759 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1760 GST_DEBUG_FUNCPTR_NAME (unlink));
1765 * @srcpad: the source #GstPad to unlink.
1766 * @sinkpad: the sink #GstPad to unlink.
1768 * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1769 * signal on both pads.
1771 * Returns: TRUE if the pads were unlinked. This function returns FALSE if
1772 * the pads were not linked together.
1777 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1779 gboolean result = FALSE;
1780 GstElement *parent = NULL;
1782 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1783 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1784 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1785 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1787 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1788 GST_DEBUG_PAD_NAME (srcpad), srcpad,
1789 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1791 /* We need to notify the parent before taking any pad locks as the bin in
1792 * question might be waiting for a lock on the pad while holding its lock
1793 * that our message will try to take. */
1794 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
1795 if (GST_IS_ELEMENT (parent)) {
1796 gst_element_post_message (parent,
1797 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1798 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
1800 gst_object_unref (parent);
1805 GST_OBJECT_LOCK (srcpad);
1806 GST_OBJECT_LOCK (sinkpad);
1808 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1809 goto not_linked_together;
1811 if (GST_PAD_UNLINKFUNC (srcpad)) {
1812 GST_PAD_UNLINKFUNC (srcpad) (srcpad);
1814 if (GST_PAD_UNLINKFUNC (sinkpad)) {
1815 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad);
1818 /* first clear peers */
1819 GST_PAD_PEER (srcpad) = NULL;
1820 GST_PAD_PEER (sinkpad) = NULL;
1822 GST_OBJECT_UNLOCK (sinkpad);
1823 GST_OBJECT_UNLOCK (srcpad);
1825 /* fire off a signal to each of the pads telling them
1826 * that they've been unlinked */
1827 g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1828 g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1830 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1831 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1836 if (parent != NULL) {
1837 gst_element_post_message (parent,
1838 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1839 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
1840 gst_object_unref (parent);
1845 not_linked_together:
1847 /* we do not emit a warning in this case because unlinking cannot
1848 * be made MT safe.*/
1849 GST_OBJECT_UNLOCK (sinkpad);
1850 GST_OBJECT_UNLOCK (srcpad);
1856 * gst_pad_is_linked:
1857 * @pad: pad to check
1859 * Checks if a @pad is linked to another pad or not.
1861 * Returns: TRUE if the pad is linked, FALSE otherwise.
1866 gst_pad_is_linked (GstPad * pad)
1870 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1872 GST_OBJECT_LOCK (pad);
1873 result = (GST_PAD_PEER (pad) != NULL);
1874 GST_OBJECT_UNLOCK (pad);
1879 /* get the caps from both pads and see if the intersection
1882 * This function should be called with the pad LOCK on both
1886 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
1887 GstPadLinkCheck flags)
1889 GstCaps *srccaps = NULL;
1890 GstCaps *sinkcaps = NULL;
1891 gboolean compatible = FALSE;
1893 if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
1896 /* Doing the expensive caps checking takes priority over only checking the template caps */
1897 if (flags & GST_PAD_LINK_CHECK_CAPS) {
1898 GST_OBJECT_UNLOCK (sink);
1899 GST_OBJECT_UNLOCK (src);
1901 srccaps = gst_pad_query_caps (src, NULL);
1902 sinkcaps = gst_pad_query_caps (sink, NULL);
1904 GST_OBJECT_LOCK (src);
1905 GST_OBJECT_LOCK (sink);
1907 /* If one of the two pads doesn't have a template, consider the intersection
1909 if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
1910 || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
1914 srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
1916 gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
1919 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
1921 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
1924 /* if we have caps on both pads we can check the intersection. If one
1925 * of the caps is NULL, we return TRUE. */
1926 if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
1928 gst_caps_unref (srccaps);
1930 gst_caps_unref (sinkcaps);
1934 compatible = gst_caps_can_intersect (srccaps, sinkcaps);
1935 gst_caps_unref (srccaps);
1936 gst_caps_unref (sinkcaps);
1939 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
1940 (compatible ? "" : "not"));
1945 /* check if the grandparents of both pads are the same.
1946 * This check is required so that we don't try to link
1947 * pads from elements in different bins without ghostpads.
1949 * The LOCK should be held on both pads
1952 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
1954 GstObject *psrc, *psink;
1956 psrc = GST_OBJECT_PARENT (src);
1957 psink = GST_OBJECT_PARENT (sink);
1959 /* if one of the pads has no parent, we allow the link */
1960 if (G_UNLIKELY (psrc == NULL || psink == NULL))
1963 /* only care about parents that are elements */
1964 if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
1965 goto no_element_parent;
1967 /* if the parents are the same, we have a loop */
1968 if (G_UNLIKELY (psrc == psink))
1971 /* if they both have a parent, we check the grandparents. We can not lock
1972 * the parent because we hold on the child (pad) and the locking order is
1973 * parent >> child. */
1974 psrc = GST_OBJECT_PARENT (psrc);
1975 psink = GST_OBJECT_PARENT (psink);
1977 /* if they have grandparents but they are not the same */
1978 if (G_UNLIKELY (psrc != psink))
1979 goto wrong_grandparents;
1986 GST_CAT_DEBUG (GST_CAT_CAPS,
1987 "one of the pads has no parent %" GST_PTR_FORMAT " and %"
1988 GST_PTR_FORMAT, psrc, psink);
1993 GST_CAT_DEBUG (GST_CAT_CAPS,
1994 "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
1995 GST_PTR_FORMAT, psrc, psink);
2000 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
2006 GST_CAT_DEBUG (GST_CAT_CAPS,
2007 "pads have different grandparents %" GST_PTR_FORMAT " and %"
2008 GST_PTR_FORMAT, psrc, psink);
2013 /* FIXME leftover from an attempt at refactoring... */
2014 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
2015 * the two pads will be locked in the srcpad, sinkpad order. */
2016 static GstPadLinkReturn
2017 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2019 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2020 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2022 GST_OBJECT_LOCK (srcpad);
2024 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
2025 goto src_was_linked;
2027 GST_OBJECT_LOCK (sinkpad);
2029 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
2030 goto sink_was_linked;
2032 /* check hierarchy, pads can only be linked if the grandparents
2034 if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
2035 && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
2036 goto wrong_hierarchy;
2038 /* check pad caps for non-empty intersection */
2039 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
2042 /* FIXME check pad scheduling for non-empty intersection */
2044 return GST_PAD_LINK_OK;
2048 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
2049 GST_DEBUG_PAD_NAME (srcpad),
2050 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
2051 /* we do not emit a warning in this case because unlinking cannot
2052 * be made MT safe.*/
2053 GST_OBJECT_UNLOCK (srcpad);
2054 return GST_PAD_LINK_WAS_LINKED;
2058 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
2059 GST_DEBUG_PAD_NAME (sinkpad),
2060 GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
2061 /* we do not emit a warning in this case because unlinking cannot
2062 * be made MT safe.*/
2063 GST_OBJECT_UNLOCK (sinkpad);
2064 GST_OBJECT_UNLOCK (srcpad);
2065 return GST_PAD_LINK_WAS_LINKED;
2069 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
2070 GST_OBJECT_UNLOCK (sinkpad);
2071 GST_OBJECT_UNLOCK (srcpad);
2072 return GST_PAD_LINK_WRONG_HIERARCHY;
2076 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
2077 GST_OBJECT_UNLOCK (sinkpad);
2078 GST_OBJECT_UNLOCK (srcpad);
2079 return GST_PAD_LINK_NOFORMAT;
2085 * @srcpad: the source #GstPad.
2086 * @sinkpad: the sink #GstPad.
2088 * Checks if the source pad and the sink pad are compatible so they can be
2091 * Returns: TRUE if the pads can be linked.
2094 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2096 GstPadLinkReturn result;
2098 /* generic checks */
2099 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2100 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2102 GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
2103 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2105 /* gst_pad_link_prepare does everything for us, we only release the locks
2106 * on the pads that it gets us. If this function returns !OK the locks are not
2108 result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2109 if (result != GST_PAD_LINK_OK)
2112 GST_OBJECT_UNLOCK (srcpad);
2113 GST_OBJECT_UNLOCK (sinkpad);
2116 return result == GST_PAD_LINK_OK;
2120 * gst_pad_link_full:
2121 * @srcpad: the source #GstPad to link.
2122 * @sinkpad: the sink #GstPad to link.
2123 * @flags: the checks to validate when linking
2125 * Links the source pad and the sink pad.
2127 * This variant of #gst_pad_link provides a more granular control on the
2128 * checks being done when linking. While providing some considerable speedups
2129 * the caller of this method must be aware that wrong usage of those flags
2130 * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
2131 * for more information.
2135 * Returns: A result code indicating if the connection worked or
2141 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2143 GstPadLinkReturn result;
2145 GstPadLinkFunction srcfunc, sinkfunc;
2147 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2148 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2149 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2150 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2151 GST_PAD_LINK_WRONG_DIRECTION);
2153 /* Notify the parent early. See gst_pad_unlink for details. */
2154 if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2155 if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2156 gst_element_post_message (parent,
2157 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2158 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2160 gst_object_unref (parent);
2165 /* prepare will also lock the two pads */
2166 result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2168 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2171 /* must set peers before calling the link function */
2172 GST_PAD_PEER (srcpad) = sinkpad;
2173 GST_PAD_PEER (sinkpad) = srcpad;
2175 /* check events, when something is different, mark pending */
2176 schedule_events (srcpad, sinkpad);
2178 /* get the link functions */
2179 srcfunc = GST_PAD_LINKFUNC (srcpad);
2180 sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2182 if (G_UNLIKELY (srcfunc || sinkfunc)) {
2183 /* custom link functions, execute them */
2184 GST_OBJECT_UNLOCK (sinkpad);
2185 GST_OBJECT_UNLOCK (srcpad);
2188 /* this one will call the peer link function */
2189 result = srcfunc (srcpad, sinkpad);
2190 } else if (sinkfunc) {
2191 /* if no source link function, we need to call the sink link
2192 * function ourselves. */
2193 result = sinkfunc (sinkpad, srcpad);
2196 GST_OBJECT_LOCK (srcpad);
2197 GST_OBJECT_LOCK (sinkpad);
2199 /* we released the lock, check if the same pads are linked still */
2200 if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2201 goto concurrent_link;
2203 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2206 GST_OBJECT_UNLOCK (sinkpad);
2207 GST_OBJECT_UNLOCK (srcpad);
2209 /* fire off a signal to each of the pads telling them
2210 * that they've been linked */
2211 g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2212 g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2214 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2215 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2217 gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2220 if (G_LIKELY (parent)) {
2221 gst_element_post_message (parent,
2222 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2223 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2224 gst_object_unref (parent);
2232 GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2233 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2234 GST_OBJECT_UNLOCK (sinkpad);
2235 GST_OBJECT_UNLOCK (srcpad);
2237 /* The other link operation succeeded first */
2238 result = GST_PAD_LINK_WAS_LINKED;
2243 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed",
2244 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2246 GST_PAD_PEER (srcpad) = NULL;
2247 GST_PAD_PEER (sinkpad) = NULL;
2249 GST_OBJECT_UNLOCK (sinkpad);
2250 GST_OBJECT_UNLOCK (srcpad);
2258 * @srcpad: the source #GstPad to link.
2259 * @sinkpad: the sink #GstPad to link.
2261 * Links the source pad and the sink pad.
2263 * Returns: A result code indicating if the connection worked or
2269 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2271 return gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2275 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2277 GstPadTemplate **template_p;
2279 /* this function would need checks if it weren't static */
2281 GST_OBJECT_LOCK (pad);
2282 template_p = &pad->padtemplate;
2283 gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2284 GST_OBJECT_UNLOCK (pad);
2287 gst_pad_template_pad_created (templ, pad);
2291 * gst_pad_get_pad_template:
2294 * Gets the template for @pad.
2296 * Returns: (transfer full): the #GstPadTemplate from which this pad was
2297 * instantiated, or %NULL if this pad has no template. Unref after
2301 gst_pad_get_pad_template (GstPad * pad)
2303 GstPadTemplate *templ;
2305 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2307 templ = GST_PAD_PAD_TEMPLATE (pad);
2309 return (templ ? gst_object_ref (templ) : NULL);
2313 * gst_pad_has_current_caps:
2314 * @pad: a #GstPad to check
2316 * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2318 * Returns: TRUE when @pad has caps associated with it.
2321 gst_pad_has_current_caps (GstPad * pad)
2326 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2328 GST_OBJECT_LOCK (pad);
2329 caps = get_pad_caps (pad);
2330 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2331 "check current pad caps %" GST_PTR_FORMAT, caps);
2332 result = (caps != NULL);
2333 GST_OBJECT_UNLOCK (pad);
2339 * gst_pad_get_current_caps:
2340 * @pad: a #GstPad to get the current capabilities of.
2342 * Gets the capabilities currently configured on @pad with the last
2343 * #GST_EVENT_CAPS event.
2345 * Returns: the current caps of the pad with incremented ref-count.
2348 gst_pad_get_current_caps (GstPad * pad)
2352 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2354 GST_OBJECT_LOCK (pad);
2355 if ((result = get_pad_caps (pad)))
2356 gst_caps_ref (result);
2357 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2358 "get current pad caps %" GST_PTR_FORMAT, result);
2359 GST_OBJECT_UNLOCK (pad);
2365 * gst_pad_get_pad_template_caps:
2366 * @pad: a #GstPad to get the template capabilities from.
2368 * Gets the capabilities for @pad's template.
2370 * Returns: (transfer full): the #GstCaps of this pad template.
2371 * Unref after usage.
2374 gst_pad_get_pad_template_caps (GstPad * pad)
2376 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2378 if (GST_PAD_PAD_TEMPLATE (pad))
2379 return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2381 return gst_caps_ref (GST_CAPS_ANY);
2386 * @pad: a #GstPad to get the peer of.
2388 * Gets the peer of @pad. This function refs the peer pad so
2389 * you need to unref it after use.
2391 * Returns: (transfer full): the peer #GstPad. Unref after usage.
2396 gst_pad_get_peer (GstPad * pad)
2400 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2402 GST_OBJECT_LOCK (pad);
2403 result = GST_PAD_PEER (pad);
2405 gst_object_ref (result);
2406 GST_OBJECT_UNLOCK (pad);
2412 * gst_pad_get_allowed_caps:
2415 * Gets the capabilities of the allowed media types that can flow through
2416 * @pad and its peer.
2418 * The allowed capabilities is calculated as the intersection of the results of
2419 * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2420 * on the resulting caps.
2422 * Returns: (transfer full): the allowed #GstCaps of the pad link. Unref the
2423 * caps when you no longer need it. This function returns NULL when @pad
2429 gst_pad_get_allowed_caps (GstPad * pad)
2436 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2438 GST_OBJECT_LOCK (pad);
2439 peer = GST_PAD_PEER (pad);
2440 if (G_UNLIKELY (peer == NULL))
2443 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2445 gst_object_ref (peer);
2446 GST_OBJECT_UNLOCK (pad);
2447 mycaps = gst_pad_query_caps (pad, NULL);
2449 peercaps = gst_pad_query_caps (peer, NULL);
2450 gst_object_unref (peer);
2452 caps = gst_caps_intersect (mycaps, peercaps);
2453 gst_caps_unref (peercaps);
2454 gst_caps_unref (mycaps);
2456 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2463 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2464 GST_OBJECT_UNLOCK (pad);
2471 * gst_pad_iterate_internal_links_default:
2472 * @pad: the #GstPad to get the internal links of.
2473 * @parent: the parent of @pad or NULL
2475 * Iterate the list of pads to which the given pad is linked to inside of
2476 * the parent element.
2477 * This is the default handler, and thus returns an iterator of all of the
2478 * pads inside the parent element with opposite direction.
2480 * The caller must free this iterator after use with gst_iterator_free().
2482 * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
2483 * returned pad with gst_object_unref().
2488 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2495 GstElement *eparent;
2497 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2499 if (parent != NULL && GST_IS_ELEMENT (parent)) {
2500 eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2502 GST_OBJECT_LOCK (pad);
2503 eparent = GST_PAD_PARENT (pad);
2504 if (!eparent || !GST_IS_ELEMENT (eparent))
2507 gst_object_ref (eparent);
2508 GST_OBJECT_UNLOCK (pad);
2511 if (pad->direction == GST_PAD_SRC)
2512 padlist = &eparent->sinkpads;
2514 padlist = &eparent->srcpads;
2516 GST_DEBUG_OBJECT (pad, "Making iterator");
2518 cookie = &eparent->pads_cookie;
2520 lock = GST_OBJECT_GET_LOCK (eparent);
2522 res = gst_iterator_new_list (GST_TYPE_PAD,
2523 lock, cookie, padlist, (GObject *) owner, NULL);
2525 gst_object_unref (owner);
2532 GST_OBJECT_UNLOCK (pad);
2533 GST_DEBUG_OBJECT (pad, "no parent element");
2539 * gst_pad_iterate_internal_links:
2540 * @pad: the GstPad to get the internal links of.
2542 * Gets an iterator for the pads to which the given pad is linked to inside
2543 * of the parent element.
2545 * Each #GstPad element yielded by the iterator will have its refcount increased,
2546 * so unref after use.
2548 * Free-function: gst_iterator_free
2550 * Returns: (transfer full): a new #GstIterator of #GstPad or %NULL when the
2551 * pad does not have an iterator function configured. Use
2552 * gst_iterator_free() after usage.
2557 gst_pad_iterate_internal_links (GstPad * pad)
2559 GstIterator *res = NULL;
2562 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2564 GST_OBJECT_LOCK (pad);
2565 ACQUIRE_PARENT (pad, parent, no_parent);
2566 GST_OBJECT_UNLOCK (pad);
2568 if (GST_PAD_ITERINTLINKFUNC (pad))
2569 res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2571 RELEASE_PARENT (parent);
2578 GST_DEBUG_OBJECT (pad, "no parent");
2579 GST_OBJECT_UNLOCK (pad);
2587 * @forward: (scope call): a #GstPadForwardFunction
2588 * @user_data: user data passed to @forward
2590 * Calls @forward for all internally linked pads of @pad. This function deals with
2591 * dynamically changing internal pads and will make sure that the @forward
2592 * function is only called once for each pad.
2594 * When @forward returns TRUE, no further pads will be processed.
2596 * Returns: TRUE if one of the dispatcher functions returned TRUE.
2599 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2602 gboolean result = FALSE;
2604 gboolean done = FALSE;
2605 GValue item = { 0, };
2606 GList *pushed_pads = NULL;
2608 iter = gst_pad_iterate_internal_links (pad);
2614 switch (gst_iterator_next (iter, &item)) {
2615 case GST_ITERATOR_OK:
2619 intpad = g_value_get_object (&item);
2621 /* if already pushed, skip. FIXME, find something faster to tag pads */
2622 if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2623 g_value_reset (&item);
2627 GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2628 GST_DEBUG_PAD_NAME (intpad));
2629 done = result = forward (intpad, user_data);
2631 pushed_pads = g_list_prepend (pushed_pads, intpad);
2633 g_value_reset (&item);
2636 case GST_ITERATOR_RESYNC:
2637 /* We don't reset the result here because we don't push the event
2638 * again on pads that got the event already and because we need
2639 * to consider the result of the previous pushes */
2640 gst_iterator_resync (iter);
2642 case GST_ITERATOR_ERROR:
2643 GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2646 case GST_ITERATOR_DONE:
2651 g_value_unset (&item);
2652 gst_iterator_free (iter);
2654 g_list_free (pushed_pads);
2664 gboolean dispatched;
2668 event_forward_func (GstPad * pad, EventData * data)
2670 /* for each pad we send to, we should ref the event; it's up
2671 * to downstream to unref again when handled. */
2672 GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2673 data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2675 data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2677 data->dispatched = TRUE;
2684 * gst_pad_event_default:
2685 * @pad: a #GstPad to call the default event handler on.
2686 * @parent: the parent of @pad or NULL
2687 * @event: (transfer full): the #GstEvent to handle.
2689 * Invokes the default event handler for the given pad.
2691 * The EOS event will pause the task associated with @pad before it is forwarded
2692 * to all internally linked pads,
2694 * The the event is sent to all pads internally linked to @pad. This function
2695 * takes ownership of @event.
2697 * Returns: TRUE if the event was sent successfully.
2700 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2702 gboolean result, forward = TRUE;
2704 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2705 g_return_val_if_fail (event != NULL, FALSE);
2707 GST_LOG_OBJECT (pad, "default event handler");
2709 switch (GST_EVENT_TYPE (event)) {
2710 case GST_EVENT_CAPS:
2711 forward = GST_PAD_IS_PROXY_CAPS (pad);
2722 data.dispatched = FALSE;
2723 data.result = FALSE;
2725 gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
2727 /* for sinkpads without a parent element or without internal links, nothing
2728 * will be dispatched but we still want to return TRUE. */
2729 if (data.dispatched)
2730 result = data.result;
2735 gst_event_unref (event);
2740 /* Default accept caps implementation just checks against
2741 * the allowed caps for the pad */
2743 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
2745 /* get the caps and see if it intersects to something not empty */
2746 GstCaps *caps, *allowed;
2749 GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
2751 /* first forward the query to internally linked pads when we are dealing with
2753 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2754 if ((result = gst_pad_proxy_query_accept_caps (pad, query))) {
2759 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
2760 "fallback ACCEPT_CAPS query, consider implementing a specialized version");
2762 allowed = gst_pad_query_caps (pad, NULL);
2763 gst_query_parse_accept_caps (query, &caps);
2766 GST_DEBUG_OBJECT (pad, "allowed caps %" GST_PTR_FORMAT, allowed);
2767 result = gst_caps_is_subset (caps, allowed);
2768 gst_caps_unref (allowed);
2770 GST_DEBUG_OBJECT (pad, "no caps allowed on the pad");
2773 gst_query_set_accept_caps_result (query, result);
2779 /* Default caps implementation */
2781 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
2783 GstCaps *result = NULL, *filter;
2784 GstPadTemplate *templ;
2785 gboolean fixed_caps;
2787 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
2789 gst_query_parse_caps (query, &filter);
2791 /* first try to proxy if we must */
2792 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2793 if ((gst_pad_proxy_query_caps (pad, query))) {
2794 gst_query_parse_caps_result (query, &result);
2799 /* no proxy or it failed, do default handling */
2800 fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
2802 GST_OBJECT_LOCK (pad);
2804 /* fixed caps, try the negotiated caps first */
2805 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
2806 if ((result = get_pad_caps (pad)))
2807 goto filter_done_unlock;
2810 if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
2811 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
2812 if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
2813 goto filter_done_unlock;
2817 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2818 "non-fixed pad caps: trying pad caps");
2819 /* non fixed caps, try the negotiated caps */
2820 if ((result = get_pad_caps (pad)))
2821 goto filter_done_unlock;
2824 /* this almost never happens */
2825 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
2826 result = GST_CAPS_ANY;
2829 GST_OBJECT_UNLOCK (pad);
2832 /* run the filter on the result */
2834 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2835 "using caps %p %" GST_PTR_FORMAT " with filter %p %"
2836 GST_PTR_FORMAT, result, result, filter, filter);
2837 result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
2838 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
2841 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2842 "using caps %p %" GST_PTR_FORMAT, result, result);
2843 result = gst_caps_ref (result);
2846 gst_query_set_caps_result (query, result);
2847 gst_caps_unref (result);
2856 gboolean dispatched;
2860 query_forward_func (GstPad * pad, QueryData * data)
2862 GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
2863 data->query, GST_EVENT_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
2865 data->result |= gst_pad_peer_query (pad, data->query);
2867 data->dispatched = TRUE;
2869 /* stop on first successful reply */
2870 return data->result;
2874 * gst_pad_query_default:
2875 * @pad: a #GstPad to call the default query handler on.
2876 * @parent: the parent of @pad or NULL
2877 * @query: (transfer none): the #GstQuery to handle.
2879 * Invokes the default query handler for the given pad.
2880 * The query is sent to all pads internally linked to @pad. Note that
2881 * if there are many possible sink pads that are internally linked to
2882 * @pad, only one will be sent the query.
2883 * Multi-sinkpad elements should implement custom query handlers.
2885 * Returns: TRUE if the query was performed successfully.
2888 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
2890 gboolean forward, ret = FALSE;
2892 switch (GST_QUERY_TYPE (query)) {
2893 case GST_QUERY_SCHEDULING:
2896 case GST_QUERY_ALLOCATION:
2897 forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
2899 case GST_QUERY_ACCEPT_CAPS:
2900 ret = gst_pad_query_accept_caps_default (pad, query);
2903 case GST_QUERY_CAPS:
2904 ret = gst_pad_query_caps_default (pad, query);
2907 case GST_QUERY_POSITION:
2908 case GST_QUERY_SEEKING:
2909 case GST_QUERY_FORMATS:
2910 case GST_QUERY_LATENCY:
2911 case GST_QUERY_JITTER:
2912 case GST_QUERY_RATE:
2913 case GST_QUERY_CONVERT:
2919 GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
2920 query, GST_QUERY_TYPE_NAME (query));
2926 data.dispatched = FALSE;
2927 data.result = FALSE;
2929 gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
2931 if (data.dispatched) {
2934 /* nothing dispatched, assume drained */
2935 if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
2945 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
2947 GstPad *pad = data->pad;
2948 GstPadProbeInfo *info = data->info;
2949 GstPadProbeType type, flags;
2950 GstPadProbeCallback callback;
2951 GstPadProbeReturn ret;
2953 /* if we have called this callback, do nothing */
2954 if (PROBE_COOKIE (hook) == data->cookie) {
2955 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2956 "hook %lu, cookie %u already called", hook->hook_id,
2957 PROBE_COOKIE (hook));
2961 PROBE_COOKIE (hook) = data->cookie;
2963 flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
2966 /* one of the data types */
2967 if ((flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
2969 /* one of the scheduling types */
2970 if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
2972 /* one of the blocking types must match */
2973 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
2974 (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
2976 /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
2977 if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
2978 (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
2981 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2982 "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
2983 PROBE_COOKIE (hook), flags);
2985 data->marshalled = TRUE;
2987 callback = (GstPadProbeCallback) hook->func;
2988 if (callback == NULL)
2991 info->id = hook->hook_id;
2993 GST_OBJECT_UNLOCK (pad);
2995 ret = callback (pad, info, hook->data);
2997 GST_OBJECT_LOCK (pad);
3000 case GST_PAD_PROBE_REMOVE:
3001 /* remove the probe */
3002 GST_DEBUG_OBJECT (pad, "asked to remove hook");
3003 cleanup_hook (pad, hook);
3005 case GST_PAD_PROBE_DROP:
3006 /* need to drop the data, make sure other probes don't get called
3008 GST_DEBUG_OBJECT (pad, "asked to drop item");
3009 info->type = GST_PAD_PROBE_TYPE_INVALID;
3010 data->dropped = TRUE;
3012 case GST_PAD_PROBE_PASS:
3013 /* inform the pad block to let things pass */
3014 GST_DEBUG_OBJECT (pad, "asked to pass item");
3018 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
3025 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3026 "hook %lu, cookie %u with flags 0x%08x does not match %08x",
3027 hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
3032 /* a probe that does not take or return any data */
3033 #define PROBE_NO_DATA(pad,mask,label,defaultval) \
3035 if (G_UNLIKELY (pad->num_probes)) { \
3036 /* pass NULL as the data item */ \
3037 GstPadProbeInfo info = { mask, 0, NULL, 0, 0 }; \
3038 ret = do_probe_callbacks (pad, &info, defaultval); \
3039 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
3044 #define PROBE_FULL(pad,mask,data,offs,size,label) \
3046 if (G_UNLIKELY (pad->num_probes)) { \
3047 /* pass the data item */ \
3048 GstPadProbeInfo info = { mask, 0, data, offs, size }; \
3049 ret = do_probe_callbacks (pad, &info, GST_FLOW_OK); \
3050 /* store the possibly updated data item */ \
3051 data = GST_PAD_PROBE_INFO_DATA (&info); \
3052 /* if something went wrong, exit */ \
3053 if (G_UNLIKELY (ret != GST_FLOW_OK)) \
3058 #define PROBE_PUSH(pad,mask,data,label) \
3059 PROBE_FULL(pad, mask, data, -1, -1, label);
3060 #define PROBE_PULL(pad,mask,data,offs,size,label) \
3061 PROBE_FULL(pad, mask, data, offs, size, label);
3063 static GstFlowReturn
3064 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3065 GstFlowReturn defaultval)
3074 data.marshalled = FALSE;
3075 data.dropped = FALSE;
3076 data.cookie = ++pad->priv->probe_cookie;
3079 (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3082 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3083 "do probes cookie %u", data.cookie);
3084 cookie = pad->priv->probe_list_cookie;
3086 g_hook_list_marshal (&pad->probes, TRUE,
3087 (GHookMarshaller) probe_hook_marshal, &data);
3089 /* if the list changed, call the new callbacks (they will not have their
3090 * cookie set to data.cookie */
3091 if (cookie != pad->priv->probe_list_cookie) {
3092 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3093 "probe list changed, restarting");
3097 /* the first item that dropped will stop the hooks and then we drop here */
3101 /* if no handler matched and we are blocking, let the item pass */
3102 if (!data.marshalled && is_block)
3105 /* At this point, all handlers returned either OK or PASS. If one handler
3106 * returned PASS, let the item pass */
3111 while (GST_PAD_IS_BLOCKED (pad)) {
3112 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3113 "we are blocked %d times", pad->num_blocked);
3115 /* we might have released the lock */
3116 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3119 /* now we block the streaming thread. It can be unlocked when we
3120 * deactivate the pad (which will also set the FLUSHING flag) or
3121 * when the pad is unblocked. A flushing event will also unblock
3122 * the pad after setting the FLUSHING flag. */
3123 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3124 "Waiting to be unblocked or set flushing");
3125 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3126 GST_PAD_BLOCK_WAIT (pad);
3127 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3128 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3130 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3140 GST_DEBUG_OBJECT (pad, "pad is flushing");
3141 return GST_FLOW_FLUSHING;
3145 GST_DEBUG_OBJECT (pad, "data is dropped");
3146 return GST_FLOW_CUSTOM_SUCCESS;
3150 /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3151 GST_DEBUG_OBJECT (pad, "data is passed");
3159 * gst_pad_get_offset:
3162 * Get the offset applied to the running time of @pad. @pad has to be a source
3165 * Returns: the offset.
3168 gst_pad_get_offset (GstPad * pad)
3172 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3174 GST_OBJECT_LOCK (pad);
3175 result = pad->offset;
3176 GST_OBJECT_UNLOCK (pad);
3182 * gst_pad_set_offset:
3184 * @offset: the offset
3186 * Set the offset that will be applied to the running time of @pad.
3189 gst_pad_set_offset (GstPad * pad, gint64 offset)
3193 g_return_if_fail (GST_IS_PAD (pad));
3195 GST_OBJECT_LOCK (pad);
3196 /* if nothing changed, do nothing */
3197 if (pad->offset == offset)
3200 pad->offset = offset;
3201 GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3203 /* sinkpads will apply their offset the next time a segment
3204 * event is received. */
3205 if (GST_PAD_IS_SINK (pad))
3208 /* resend the last segment event on next buffer push */
3209 if ((ev = find_event_by_type (pad, GST_EVENT_SEGMENT, 0))) {
3210 ev->received = FALSE;
3211 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3215 GST_OBJECT_UNLOCK (pad);
3222 /* If TRUE and ret is not OK this means
3223 * that pushing the EOS event failed
3228 /* should be called with pad LOCK */
3230 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3232 PushStickyData *data = user_data;
3233 GstEvent *event = ev->event;
3236 GST_DEBUG_OBJECT (pad, "event %s was already received",
3237 GST_EVENT_TYPE_NAME (event));
3241 data->ret = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3242 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3244 switch (data->ret) {
3246 ev->received = TRUE;
3247 GST_DEBUG_OBJECT (pad, "event %s marked received",
3248 GST_EVENT_TYPE_NAME (event));
3250 case GST_FLOW_NOT_LINKED:
3251 /* not linked is not a problem, we are sticky so the event will be
3252 * sent later but only for non-EOS events */
3253 GST_DEBUG_OBJECT (pad, "pad was not linked");
3254 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
3255 data->ret = GST_FLOW_OK;
3258 GST_DEBUG_OBJECT (pad, "mark pending events");
3259 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3263 if (data->ret != GST_FLOW_OK && GST_EVENT_TYPE (event) == GST_EVENT_EOS)
3264 data->was_eos = TRUE;
3266 return data->ret == GST_FLOW_OK;
3269 /* check sticky events and push them when needed. should be called
3271 static inline GstFlowReturn
3272 check_sticky (GstPad * pad)
3274 PushStickyData data = { GST_FLOW_OK, FALSE };
3276 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3277 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3279 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3280 events_foreach (pad, push_sticky, &data);
3282 /* If there's an EOS event we must push it downstream
3283 * even if sending a previous sticky event failed.
3284 * Otherwise the pipeline might wait forever for EOS.
3286 * Only do this if pushing another event than the EOS
3289 if (data.ret != GST_FLOW_OK && !data.was_eos) {
3290 PadEvent *ev = find_event_by_type (pad, GST_EVENT_EOS, 0);
3292 if (ev && !ev->received) {
3293 data.ret = gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3294 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3304 * @pad: a #GstPad to invoke the default query on.
3305 * @query: (transfer none): the #GstQuery to perform.
3307 * Dispatches a query to a pad. The query should have been allocated by the
3308 * caller via one of the type-specific allocation functions. The element that
3309 * the pad belongs to is responsible for filling the query with an appropriate
3310 * response, which should then be parsed with a type-specific query parsing
3313 * Again, the caller is responsible for both the allocation and deallocation of
3314 * the query structure.
3316 * Please also note that some queries might need a running pipeline to work.
3318 * Returns: TRUE if the query could be performed.
3321 gst_pad_query (GstPad * pad, GstQuery * query)
3324 gboolean res, serialized;
3325 GstPadQueryFunction func;
3326 GstPadProbeType type;
3329 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3330 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3332 if (GST_PAD_IS_SRC (pad)) {
3333 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3334 goto wrong_direction;
3335 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3336 } else if (GST_PAD_IS_SINK (pad)) {
3337 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3338 goto wrong_direction;
3339 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3341 goto unknown_direction;
3343 GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3344 GST_QUERY_TYPE_NAME (query));
3346 serialized = GST_QUERY_IS_SERIALIZED (query);
3347 if (G_UNLIKELY (serialized))
3348 GST_PAD_STREAM_LOCK (pad);
3350 GST_OBJECT_LOCK (pad);
3351 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3352 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3353 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3355 ACQUIRE_PARENT (pad, parent, no_parent);
3356 GST_OBJECT_UNLOCK (pad);
3358 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3361 res = func (pad, parent, query);
3363 RELEASE_PARENT (parent);
3365 GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3366 GST_QUERY_TYPE_NAME (query), res);
3371 GST_OBJECT_LOCK (pad);
3372 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3373 GST_OBJECT_UNLOCK (pad);
3375 if (G_UNLIKELY (serialized))
3376 GST_PAD_STREAM_UNLOCK (pad);
3383 g_warning ("pad %s:%s query %s in wrong direction",
3384 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3389 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3394 GST_DEBUG_OBJECT (pad, "had no parent");
3395 GST_OBJECT_UNLOCK (pad);
3396 if (G_UNLIKELY (serialized))
3397 GST_PAD_STREAM_UNLOCK (pad);
3402 GST_DEBUG_OBJECT (pad, "had no query function");
3403 RELEASE_PARENT (parent);
3404 if (G_UNLIKELY (serialized))
3405 GST_PAD_STREAM_UNLOCK (pad);
3410 GST_DEBUG_OBJECT (pad, "query failed");
3411 if (G_UNLIKELY (serialized))
3412 GST_PAD_STREAM_UNLOCK (pad);
3417 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3418 GST_OBJECT_UNLOCK (pad);
3419 if (G_UNLIKELY (serialized))
3420 GST_PAD_STREAM_UNLOCK (pad);
3422 /* if a probe dropped, we don't sent it further but assume that the probe
3423 * answered the query and return TRUE */
3424 if (ret == GST_FLOW_CUSTOM_SUCCESS)
3434 * gst_pad_peer_query:
3435 * @pad: a #GstPad to invoke the peer query on.
3436 * @query: (transfer none): the #GstQuery to perform.
3438 * Performs gst_pad_query() on the peer of @pad.
3440 * The caller is responsible for both the allocation and deallocation of
3441 * the query structure.
3443 * Returns: TRUE if the query could be performed. This function returns %FALSE
3444 * if @pad has no peer.
3449 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3452 GstPadProbeType type;
3453 gboolean res, serialized;
3456 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3457 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3459 if (GST_PAD_IS_SRC (pad)) {
3460 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3461 goto wrong_direction;
3462 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3463 } else if (GST_PAD_IS_SINK (pad)) {
3464 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3465 goto wrong_direction;
3466 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3468 goto unknown_direction;
3470 GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
3471 GST_QUERY_TYPE_NAME (query));
3473 serialized = GST_QUERY_IS_SERIALIZED (query);
3475 GST_OBJECT_LOCK (pad);
3476 if (GST_PAD_IS_SRC (pad) && serialized) {
3477 /* all serialized queries on the srcpad trigger push of
3479 if (!check_sticky (pad) == GST_FLOW_OK)
3483 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3484 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3485 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3487 peerpad = GST_PAD_PEER (pad);
3488 if (G_UNLIKELY (peerpad == NULL))
3491 gst_object_ref (peerpad);
3492 GST_OBJECT_UNLOCK (pad);
3494 res = gst_pad_query (peerpad, query);
3496 gst_object_unref (peerpad);
3501 GST_OBJECT_LOCK (pad);
3502 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3503 GST_OBJECT_UNLOCK (pad);
3510 g_warning ("pad %s:%s query %s in wrong direction",
3511 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3516 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3521 GST_WARNING_OBJECT (pad, "could not send sticky events");
3522 GST_OBJECT_UNLOCK (pad);
3527 GST_WARNING_OBJECT (pad, "pad has no peer");
3528 GST_OBJECT_UNLOCK (pad);
3533 GST_DEBUG_OBJECT (pad, "query failed");
3538 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3539 GST_OBJECT_UNLOCK (pad);
3541 /* if a probe dropped, we don't sent it further but assume that the probe
3542 * answered the query and return TRUE */
3543 if (ret == GST_FLOW_CUSTOM_SUCCESS)
3552 /**********************************************************************
3553 * Data passing functions
3556 /* this is the chain function that does not perform the additional argument
3557 * checking for that little extra speed.
3559 static inline GstFlowReturn
3560 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
3565 GST_PAD_STREAM_LOCK (pad);
3567 GST_OBJECT_LOCK (pad);
3568 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3571 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
3574 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3577 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3579 PROBE_PUSH (pad, type, data, probe_stopped);
3581 parent = GST_OBJECT_PARENT (pad);
3582 GST_OBJECT_UNLOCK (pad);
3584 /* NOTE: we read the chainfunc unlocked.
3585 * we cannot hold the lock for the pad so we might send
3586 * the data to the wrong function. This is not really a
3587 * problem since functions are assigned at creation time
3588 * and don't change that often... */
3589 if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
3590 GstPadChainFunction chainfunc;
3592 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3595 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3596 "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
3597 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
3599 ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
3601 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3602 "called chainfunction &%s with buffer %p, returned %s",
3603 GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
3605 GstPadChainListFunction chainlistfunc;
3607 if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
3610 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3611 "calling chainlistfunction &%s",
3612 GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
3614 ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
3616 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3617 "called chainlistfunction &%s, returned %s",
3618 GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
3621 GST_PAD_STREAM_UNLOCK (pad);
3628 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3629 "chaining, but pad was flushing");
3630 GST_OBJECT_UNLOCK (pad);
3631 GST_PAD_STREAM_UNLOCK (pad);
3632 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3633 return GST_FLOW_FLUSHING;
3637 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "chaining, but pad was EOS");
3638 GST_OBJECT_UNLOCK (pad);
3639 GST_PAD_STREAM_UNLOCK (pad);
3640 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3641 return GST_FLOW_EOS;
3645 g_critical ("chain on pad %s:%s but it was not in push mode",
3646 GST_DEBUG_PAD_NAME (pad));
3647 GST_OBJECT_UNLOCK (pad);
3648 GST_PAD_STREAM_UNLOCK (pad);
3649 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3650 return GST_FLOW_ERROR;
3654 GST_OBJECT_UNLOCK (pad);
3655 GST_PAD_STREAM_UNLOCK (pad);
3656 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3659 case GST_FLOW_CUSTOM_SUCCESS:
3660 GST_DEBUG_OBJECT (pad, "dropped buffer");
3664 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3671 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3672 g_critical ("chain on pad %s:%s but it has no chainfunction",
3673 GST_DEBUG_PAD_NAME (pad));
3674 GST_PAD_STREAM_UNLOCK (pad);
3675 return GST_FLOW_NOT_SUPPORTED;
3681 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3682 * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
3685 * Chain a buffer to @pad.
3687 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3689 * If the buffer type is not acceptable for @pad (as negotiated with a
3690 * preceeding GST_EVENT_CAPS event), this function returns
3691 * #GST_FLOW_NOT_NEGOTIATED.
3693 * The function proceeds calling the chain function installed on @pad (see
3694 * gst_pad_set_chain_function()) and the return value of that function is
3695 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3698 * In all cases, success or failure, the caller loses its reference to @buffer
3699 * after calling this function.
3701 * Returns: a #GstFlowReturn from the pad.
3706 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
3708 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3709 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3710 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3712 return gst_pad_chain_data_unchecked (pad,
3713 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3716 static GstFlowReturn
3717 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
3718 GstBufferList * list)
3724 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3726 len = gst_buffer_list_length (list);
3729 for (i = 0; i < len; i++) {
3730 buffer = gst_buffer_list_get (list, i);
3732 gst_pad_chain_data_unchecked (pad,
3733 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
3734 gst_buffer_ref (buffer));
3735 if (ret != GST_FLOW_OK)
3738 gst_buffer_list_unref (list);
3744 * gst_pad_chain_list:
3745 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3746 * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
3749 * Chain a bufferlist to @pad.
3751 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3753 * If @pad was not negotiated properly with a CAPS event, this function
3754 * returns #GST_FLOW_NOT_NEGOTIATED.
3756 * The function proceeds calling the chainlist function installed on @pad (see
3757 * gst_pad_set_chain_list_function()) and the return value of that function is
3758 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3759 * chainlist function.
3761 * In all cases, success or failure, the caller loses its reference to @list
3762 * after calling this function.
3766 * Returns: a #GstFlowReturn from the pad.
3771 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
3773 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3774 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3775 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3777 return gst_pad_chain_data_unchecked (pad,
3778 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3781 static GstFlowReturn
3782 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
3787 GST_OBJECT_LOCK (pad);
3788 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3791 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
3794 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3797 if (G_UNLIKELY ((ret = check_sticky (pad))) != GST_FLOW_OK)
3800 /* do block probes */
3801 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3803 /* do post-blocking probes */
3804 PROBE_PUSH (pad, type, data, probe_stopped);
3806 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3809 /* take ref to peer pad before releasing the lock */
3810 gst_object_ref (peer);
3812 GST_OBJECT_UNLOCK (pad);
3814 ret = gst_pad_chain_data_unchecked (peer, type, data);
3816 gst_object_unref (peer);
3818 GST_OBJECT_LOCK (pad);
3820 if (pad->priv->using == 0) {
3821 /* pad is not active anymore, trigger idle callbacks */
3822 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
3823 probe_stopped, ret);
3825 GST_OBJECT_UNLOCK (pad);
3829 /* ERROR recovery here */
3833 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3834 "pushing, but pad was flushing");
3835 GST_OBJECT_UNLOCK (pad);
3836 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3837 return GST_FLOW_FLUSHING;
3841 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pushing, but pad was EOS");
3842 GST_OBJECT_UNLOCK (pad);
3843 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3844 return GST_FLOW_EOS;
3848 g_critical ("pushing on pad %s:%s but it was not activated in push mode",
3849 GST_DEBUG_PAD_NAME (pad));
3850 GST_OBJECT_UNLOCK (pad);
3851 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3852 return GST_FLOW_ERROR;
3856 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3857 "error pushing events, return %s", gst_flow_get_name (ret));
3858 GST_OBJECT_UNLOCK (pad);
3859 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3864 GST_OBJECT_UNLOCK (pad);
3865 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3868 case GST_FLOW_CUSTOM_SUCCESS:
3869 GST_DEBUG_OBJECT (pad, "dropped buffer");
3873 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3880 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3881 "pushing, but it was not linked");
3882 GST_OBJECT_UNLOCK (pad);
3883 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3884 return GST_FLOW_NOT_LINKED;
3890 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3891 * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
3894 * Pushes a buffer to the peer of @pad.
3896 * This function will call installed block probes before triggering any
3897 * installed data probes.
3899 * The function proceeds calling gst_pad_chain() on the peer pad and returns
3900 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3903 * In all cases, success or failure, the caller loses its reference to @buffer
3904 * after calling this function.
3906 * Returns: a #GstFlowReturn from the peer pad.
3911 gst_pad_push (GstPad * pad, GstBuffer * buffer)
3913 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3914 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3915 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3917 return gst_pad_push_data (pad,
3918 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3922 * gst_pad_push_list:
3923 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3924 * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
3927 * Pushes a buffer list to the peer of @pad.
3929 * This function will call installed block probes before triggering any
3930 * installed data probes.
3932 * The function proceeds calling the chain function on the peer pad and returns
3933 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3934 * be returned. If the peer pad does not have any installed chainlist function
3935 * every group buffer of the list will be merged into a normal #GstBuffer and
3936 * chained via gst_pad_chain().
3938 * In all cases, success or failure, the caller loses its reference to @list
3939 * after calling this function.
3941 * Returns: a #GstFlowReturn from the peer pad.
3948 gst_pad_push_list (GstPad * pad, GstBufferList * list)
3950 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3951 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3952 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3954 return gst_pad_push_data (pad,
3955 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3958 static GstFlowReturn
3959 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
3960 GstBuffer ** buffer)
3963 GstPadGetRangeFunction getrangefunc;
3967 GST_PAD_STREAM_LOCK (pad);
3969 GST_OBJECT_LOCK (pad);
3970 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3973 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
3976 if (G_UNLIKELY ((ret = check_sticky (pad))) != GST_FLOW_OK)
3981 /* when one of the probes returns DROPPED, probe_stopped will be called
3982 * and we skip calling the getrange function, res_buf should then contain a
3983 * valid result buffer */
3984 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
3985 res_buf, offset, size, probe_stopped);
3987 ACQUIRE_PARENT (pad, parent, no_parent);
3988 GST_OBJECT_UNLOCK (pad);
3990 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
3993 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3994 "calling getrangefunc %s, offset %"
3995 G_GUINT64_FORMAT ", size %u",
3996 GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
3998 ret = getrangefunc (pad, parent, offset, size, &res_buf);
4000 RELEASE_PARENT (parent);
4002 if (G_UNLIKELY (ret != GST_FLOW_OK))
4003 goto get_range_failed;
4005 /* can only fire the signal if we have a valid buffer */
4006 GST_OBJECT_LOCK (pad);
4008 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4009 res_buf, offset, size, probe_stopped_unref);
4010 GST_OBJECT_UNLOCK (pad);
4012 GST_PAD_STREAM_UNLOCK (pad);
4021 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4022 "getrange, but pad was flushing");
4023 GST_OBJECT_UNLOCK (pad);
4024 GST_PAD_STREAM_UNLOCK (pad);
4025 return GST_FLOW_FLUSHING;
4029 g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
4030 GST_DEBUG_PAD_NAME (pad));
4031 GST_OBJECT_UNLOCK (pad);
4032 GST_PAD_STREAM_UNLOCK (pad);
4033 return GST_FLOW_ERROR;
4037 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
4038 GST_OBJECT_UNLOCK (pad);
4039 GST_PAD_STREAM_UNLOCK (pad);
4044 GST_DEBUG_OBJECT (pad, "no parent");
4045 GST_OBJECT_UNLOCK (pad);
4046 GST_PAD_STREAM_UNLOCK (pad);
4047 return GST_FLOW_FLUSHING;
4051 g_critical ("getrange on pad %s:%s but it has no getrangefunction",
4052 GST_DEBUG_PAD_NAME (pad));
4053 RELEASE_PARENT (parent);
4054 GST_PAD_STREAM_UNLOCK (pad);
4055 return GST_FLOW_NOT_SUPPORTED;
4059 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4060 "probe returned %s", gst_flow_get_name (ret));
4061 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4063 /* the probe filled the buffer and asks us to not call the getrange
4064 * anymore, we continue with the post probes then. */
4065 GST_DEBUG_OBJECT (pad, "handled buffer");
4069 /* no buffer, we are EOS */
4070 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4074 GST_OBJECT_UNLOCK (pad);
4075 GST_PAD_STREAM_UNLOCK (pad);
4079 probe_stopped_unref:
4081 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4082 "probe returned %s", gst_flow_get_name (ret));
4083 /* if we drop here, it signals EOS */
4084 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4086 GST_OBJECT_UNLOCK (pad);
4087 GST_PAD_STREAM_UNLOCK (pad);
4088 if (*buffer == NULL)
4089 gst_buffer_unref (res_buf);
4094 GST_PAD_STREAM_UNLOCK (pad);
4095 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4096 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4097 pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
4103 * gst_pad_get_range:
4104 * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4105 * @offset: The start offset of the buffer
4106 * @size: The length of the buffer
4107 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
4108 * returns #GST_FLOW_ERROR if %NULL.
4110 * When @pad is flushing this function returns #GST_FLOW_FLUSHING
4111 * immediately and @buffer is %NULL.
4113 * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4114 * description of a getrange function. If @pad has no getrange function
4115 * installed (see gst_pad_set_getrange_function()) this function returns
4116 * #GST_FLOW_NOT_SUPPORTED.
4118 * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be
4119 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4120 * must be freed with gst_buffer_unref() after usage.
4122 * When @buffer points to a variable that points to a valid #GstBuffer, the
4123 * buffer will be filled with the result data when this function returns
4124 * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4125 * @size bytes will be filled in the result buffer and its size will be updated
4128 * Note that less than @size bytes can be returned in @buffer when, for example,
4129 * an EOS condition is near or when @buffer is not large enough to hold @size
4130 * bytes. The caller should check the result buffer size to get the result size.
4132 * When this function returns any other result value than #GST_FLOW_OK, @buffer
4133 * will be unchanged.
4135 * This is a lowlevel function. Usualy gst_pad_pull_range() is used.
4137 * Returns: a #GstFlowReturn from the pad.
4142 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4143 GstBuffer ** buffer)
4145 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4146 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4147 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4148 g_return_val_if_fail (*buffer == NULL
4149 || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4151 return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4155 * gst_pad_pull_range:
4156 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4157 * @offset: The start offset of the buffer
4158 * @size: The length of the buffer
4159 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4160 * GST_FLOW_ERROR if %NULL.
4162 * Pulls a @buffer from the peer pad or fills up a provided buffer.
4164 * This function will first trigger the pad block signal if it was
4167 * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4168 * function returns the result of gst_pad_get_range() on the peer pad.
4169 * See gst_pad_get_range() for a list of return values and for the
4170 * semantics of the arguments of this function.
4172 * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be
4173 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4174 * must be freed with gst_buffer_unref() after usage. When this function
4175 * returns any other result value, @buffer will still point to NULL.
4177 * When @buffer points to a variable that points to a valid #GstBuffer, the
4178 * buffer will be filled with the result data when this function returns
4179 * #GST_FLOW_OK. When this function returns any other result value,
4180 * @buffer will be unchanged. If the provided buffer is larger than @size, only
4181 * @size bytes will be filled in the result buffer and its size will be updated
4184 * Note that less than @size bytes can be returned in @buffer when, for example,
4185 * an EOS condition is near or when @buffer is not large enough to hold @size
4186 * bytes. The caller should check the result buffer size to get the result size.
4188 * Returns: a #GstFlowReturn from the peer pad.
4193 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4194 GstBuffer ** buffer)
4200 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4201 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4202 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4203 g_return_val_if_fail (*buffer == NULL
4204 || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4206 GST_OBJECT_LOCK (pad);
4207 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4210 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4215 /* when one of the probes returns DROPPED, probe_stopped will be
4216 * called and we skip calling the peer getrange function. *buffer should then
4217 * contain a valid buffer */
4218 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4219 res_buf, offset, size, probe_stopped);
4221 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4224 gst_object_ref (peer);
4226 GST_OBJECT_UNLOCK (pad);
4228 ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4230 gst_object_unref (peer);
4232 GST_OBJECT_LOCK (pad);
4234 if (pad->priv->using == 0) {
4235 /* pad is not active anymore, trigger idle callbacks */
4236 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4237 probe_stopped_unref, ret);
4240 if (G_UNLIKELY (ret != GST_FLOW_OK))
4241 goto pull_range_failed;
4244 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4245 res_buf, offset, size, probe_stopped_unref);
4247 GST_OBJECT_UNLOCK (pad);
4253 /* ERROR recovery here */
4256 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4257 "pullrange, but pad was flushing");
4258 GST_OBJECT_UNLOCK (pad);
4259 return GST_FLOW_FLUSHING;
4263 g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4264 GST_DEBUG_PAD_NAME (pad));
4265 GST_OBJECT_UNLOCK (pad);
4266 return GST_FLOW_ERROR;
4270 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4271 gst_flow_get_name (ret));
4272 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4274 /* the probe filled the buffer and asks us to not forward to the peer
4275 * anymore, we continue with the post probes then */
4276 GST_DEBUG_OBJECT (pad, "handled buffer");
4280 /* no buffer, we are EOS then */
4281 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4285 GST_OBJECT_UNLOCK (pad);
4290 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4291 "pulling range, but it was not linked");
4292 GST_OBJECT_UNLOCK (pad);
4293 return GST_FLOW_NOT_LINKED;
4297 GST_OBJECT_UNLOCK (pad);
4298 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4299 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4300 pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4303 probe_stopped_unref:
4305 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4306 "post probe returned %s", gst_flow_get_name (ret));
4307 GST_OBJECT_UNLOCK (pad);
4308 /* if we drop here, it signals EOS */
4309 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4311 if (*buffer == NULL)
4312 gst_buffer_unref (res_buf);
4318 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event, gboolean locked)
4323 gboolean res = FALSE;
4324 const gchar *name = NULL;
4326 type = GST_EVENT_TYPE (event);
4327 if (type & GST_EVENT_TYPE_STICKY_MULTI)
4328 name = gst_structure_get_name (gst_event_get_structure (event));
4330 events = pad->priv->events;
4333 for (i = 0; i < len; i++) {
4334 PadEvent *ev = &g_array_index (events, PadEvent, i);
4336 if (ev->event == NULL)
4339 if (type == GST_EVENT_TYPE (ev->event)) {
4340 /* matching types, check matching name if needed */
4341 if (name && !gst_event_has_name (ev->event, name))
4345 if ((res = gst_event_replace (&ev->event, event)))
4346 ev->received = FALSE;
4352 ev.event = gst_event_ref (event);
4353 ev.received = FALSE;
4354 g_array_append_val (events, ev);
4359 pad->priv->events_cookie++;
4360 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4362 GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
4364 switch (GST_EVENT_TYPE (event)) {
4365 case GST_EVENT_CAPS:
4367 GST_OBJECT_UNLOCK (pad);
4369 GST_DEBUG_OBJECT (pad, "notify caps");
4370 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
4373 GST_OBJECT_LOCK (pad);
4382 /* should be called with pad LOCK */
4383 static GstFlowReturn
4384 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
4385 GstPadProbeType type)
4389 GstEventType event_type;
4391 /* Two checks to be made:
4392 * . (un)set the FLUSHING flag for flushing events,
4393 * . handle pad blocking */
4394 event_type = GST_EVENT_TYPE (event);
4395 switch (event_type) {
4396 case GST_EVENT_FLUSH_START:
4397 GST_PAD_SET_FLUSHING (pad);
4399 GST_PAD_BLOCK_BROADCAST (pad);
4400 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4402 case GST_EVENT_FLUSH_STOP:
4403 GST_PAD_UNSET_FLUSHING (pad);
4405 /* Remove sticky EOS events */
4406 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4407 remove_event_by_type (pad, GST_EVENT_EOS);
4408 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
4410 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4414 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4417 /* No need to check for EOS here as either the caller (gst_pad_push_event())
4418 * checked already or this is called as part of pushing sticky events,
4419 * in which case we still want to forward the EOS event downstream.
4422 switch (GST_EVENT_TYPE (event)) {
4423 case GST_EVENT_SEGMENT:
4424 /* pass the adjusted segment event on. We need to do this even if
4425 * there is no peer pad because of the probes. */
4426 event = apply_pad_offset (pad, event);
4428 case GST_EVENT_RECONFIGURE:
4429 if (GST_PAD_IS_SINK (pad))
4430 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4435 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4436 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4441 /* send probes after modifying the events above */
4442 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4444 /* now check the peer pad */
4445 peerpad = GST_PAD_PEER (pad);
4446 if (peerpad == NULL)
4449 gst_object_ref (peerpad);
4451 GST_OBJECT_UNLOCK (pad);
4453 GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
4454 event, GST_EVENT_TYPE_NAME (event), peerpad);
4456 ret = gst_pad_send_event_unchecked (peerpad, event, type);
4458 /* Note: we gave away ownership of the event at this point but we can still
4459 * print the old pointer */
4460 GST_LOG_OBJECT (pad,
4461 "sent event %p to peerpad %" GST_PTR_FORMAT ", ret %s", event, peerpad,
4462 gst_flow_get_name (ret));
4464 gst_object_unref (peerpad);
4466 GST_OBJECT_LOCK (pad);
4468 if (pad->priv->using == 0) {
4469 /* pad is not active anymore, trigger idle callbacks */
4470 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4471 idle_probe_stopped, ret);
4475 /* ERROR handling */
4478 GST_DEBUG_OBJECT (pad, "We're flushing");
4479 gst_event_unref (event);
4480 return GST_FLOW_FLUSHING;
4484 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4485 gst_event_unref (event);
4488 case GST_FLOW_CUSTOM_SUCCESS:
4489 GST_DEBUG_OBJECT (pad, "dropped event");
4493 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4500 GST_DEBUG_OBJECT (pad, "Dropping event because pad is not linked");
4501 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4502 gst_event_unref (event);
4504 /* unlinked pads should not influence latency configuration */
4505 if (event_type == GST_EVENT_LATENCY)
4508 return GST_FLOW_NOT_LINKED;
4512 GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
4518 * gst_pad_push_event:
4519 * @pad: a #GstPad to push the event to.
4520 * @event: (transfer full): the #GstEvent to send to the pad.
4522 * Sends the event to the peer of the given pad. This function is
4523 * mainly used by elements to send events to their peer
4526 * This function takes owership of the provided event so you should
4527 * gst_event_ref() it if you want to reuse the event after this call.
4529 * Returns: TRUE if the event was handled.
4534 gst_pad_push_event (GstPad * pad, GstEvent * event)
4536 gboolean res = FALSE;
4537 GstPadProbeType type;
4538 gboolean sticky, serialized;
4540 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4541 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4543 if (GST_PAD_IS_SRC (pad)) {
4544 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4545 goto wrong_direction;
4546 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4547 } else if (GST_PAD_IS_SINK (pad)) {
4548 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4549 goto wrong_direction;
4550 /* events pushed on sinkpad never are sticky */
4551 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4553 goto unknown_direction;
4555 GST_OBJECT_LOCK (pad);
4556 sticky = GST_EVENT_IS_STICKY (event);
4557 serialized = GST_EVENT_IS_SERIALIZED (event);
4560 /* can't store on flushing pads */
4561 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4564 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4567 /* srcpad sticky events are store immediately, the received flag is set
4568 * to FALSE and will be set to TRUE when we can successfully push the
4569 * event to the peer pad */
4570 if (gst_pad_store_sticky_event (pad, event, TRUE)) {
4571 GST_DEBUG_OBJECT (pad, "event %s updated", GST_EVENT_TYPE_NAME (event));
4573 if (GST_EVENT_TYPE (event) == GST_EVENT_EOS)
4574 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
4576 if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
4577 /* all serialized or sticky events on the srcpad trigger push of
4579 res = (check_sticky (pad) == GST_FLOW_OK);
4582 /* other events are pushed right away */
4583 res = (gst_pad_push_event_unchecked (pad, event, type) == GST_FLOW_OK);
4585 /* Errors in sticky event pushing are no problem and ignored here
4586 * as they will cause more meaningful errors during data flow.
4587 * For EOS events, that are not followed by data flow, we still
4588 * return FALSE here though.
4590 if (GST_EVENT_TYPE (event) != GST_EVENT_EOS)
4592 gst_event_unref (event);
4594 GST_OBJECT_UNLOCK (pad);
4598 /* ERROR handling */
4601 g_warning ("pad %s:%s pushing %s event in wrong direction",
4602 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4603 gst_event_unref (event);
4608 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4609 gst_event_unref (event);
4614 GST_DEBUG_OBJECT (pad, "We're flushing");
4615 GST_OBJECT_UNLOCK (pad);
4616 gst_event_unref (event);
4621 GST_DEBUG_OBJECT (pad, "We're EOS");
4622 GST_OBJECT_UNLOCK (pad);
4623 gst_event_unref (event);
4628 /* Check if we can call the event function with the given event */
4629 static GstFlowReturn
4630 pre_eventfunc_check (GstPad * pad, GstEvent * event)
4634 switch (GST_EVENT_TYPE (event)) {
4635 case GST_EVENT_CAPS:
4637 /* backwards compatibility mode for caps */
4638 gst_event_parse_caps (event, &caps);
4640 if (!gst_pad_query_accept_caps (pad, caps))
4652 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
4653 "caps %" GST_PTR_FORMAT " not accepted", caps);
4654 return GST_FLOW_NOT_NEGOTIATED;
4658 static GstFlowReturn
4659 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
4660 GstPadProbeType type)
4663 GstEventType event_type;
4664 gboolean serialized, need_unlock = FALSE, sticky;
4665 GstPadEventFunction eventfunc;
4668 GST_OBJECT_LOCK (pad);
4669 if (GST_PAD_IS_SINK (pad))
4670 serialized = GST_EVENT_IS_SERIALIZED (event);
4673 sticky = GST_EVENT_IS_STICKY (event);
4674 event_type = GST_EVENT_TYPE (event);
4675 switch (event_type) {
4676 case GST_EVENT_FLUSH_START:
4677 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4678 "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
4680 /* can't even accept a flush begin event when flushing */
4681 if (GST_PAD_IS_FLUSHING (pad))
4684 GST_PAD_SET_FLUSHING (pad);
4685 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
4687 case GST_EVENT_FLUSH_STOP:
4688 if (G_LIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_NONE)) {
4689 GST_PAD_UNSET_FLUSHING (pad);
4690 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
4692 /* Remove pending EOS events */
4693 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4694 remove_event_by_type (pad, GST_EVENT_EOS);
4695 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_EOS);
4697 GST_OBJECT_UNLOCK (pad);
4698 /* grab stream lock */
4699 GST_PAD_STREAM_LOCK (pad);
4701 GST_OBJECT_LOCK (pad);
4702 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4705 case GST_EVENT_RECONFIGURE:
4706 if (GST_PAD_IS_SRC (pad))
4707 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4709 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4710 "have event type %" GST_PTR_FORMAT, event);
4712 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4716 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4719 /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
4720 GST_OBJECT_UNLOCK (pad);
4721 GST_PAD_STREAM_LOCK (pad);
4723 GST_OBJECT_LOCK (pad);
4724 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4727 if (G_UNLIKELY (GST_PAD_IS_EOS (pad)))
4731 switch (GST_EVENT_TYPE (event)) {
4732 case GST_EVENT_SEGMENT:
4733 event = apply_pad_offset (pad, event);
4739 /* now do the probe */
4741 type | GST_PAD_PROBE_TYPE_PUSH |
4742 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4744 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4748 if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
4751 ACQUIRE_PARENT (pad, parent, no_parent);
4752 GST_OBJECT_UNLOCK (pad);
4754 ret = pre_eventfunc_check (pad, event);
4755 if (G_UNLIKELY (ret != GST_FLOW_OK))
4756 goto precheck_failed;
4759 gst_event_ref (event);
4761 if (eventfunc (pad, parent, event)) {
4764 /* something went wrong */
4765 switch (event_type) {
4766 case GST_EVENT_CAPS:
4767 ret = GST_FLOW_NOT_NEGOTIATED;
4770 ret = GST_FLOW_ERROR;
4774 RELEASE_PARENT (parent);
4776 GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
4779 if (ret == GST_FLOW_OK) {
4780 /* after the event function accepted the event, we can store the sticky
4781 * event on the pad */
4782 gst_pad_store_sticky_event (pad, event, FALSE);
4783 if (event_type == GST_EVENT_EOS)
4784 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_EOS);
4786 gst_event_unref (event);
4790 GST_PAD_STREAM_UNLOCK (pad);
4794 /* ERROR handling */
4797 GST_OBJECT_UNLOCK (pad);
4799 GST_PAD_STREAM_UNLOCK (pad);
4800 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
4801 "Received event on flushing pad. Discarding");
4802 gst_event_unref (event);
4803 return GST_FLOW_FLUSHING;
4807 GST_OBJECT_UNLOCK (pad);
4809 GST_PAD_STREAM_UNLOCK (pad);
4810 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
4811 "Received event on EOS pad. Discarding");
4812 gst_event_unref (event);
4813 return GST_FLOW_EOS;
4817 GST_OBJECT_UNLOCK (pad);
4819 GST_PAD_STREAM_UNLOCK (pad);
4820 gst_event_unref (event);
4823 case GST_FLOW_CUSTOM_SUCCESS:
4824 GST_DEBUG_OBJECT (pad, "dropped event");
4828 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4835 g_warning ("pad %s:%s has no event handler, file a bug.",
4836 GST_DEBUG_PAD_NAME (pad));
4837 GST_OBJECT_UNLOCK (pad);
4839 GST_PAD_STREAM_UNLOCK (pad);
4840 gst_event_unref (event);
4841 return GST_FLOW_NOT_SUPPORTED;
4845 GST_DEBUG_OBJECT (pad, "no parent");
4846 GST_OBJECT_UNLOCK (pad);
4848 GST_PAD_STREAM_UNLOCK (pad);
4849 gst_event_unref (event);
4850 return GST_FLOW_FLUSHING;
4854 GST_DEBUG_OBJECT (pad, "pre event check failed");
4855 RELEASE_PARENT (parent);
4857 GST_PAD_STREAM_UNLOCK (pad);
4858 gst_event_unref (event);
4864 * gst_pad_send_event:
4865 * @pad: a #GstPad to send the event to.
4866 * @event: (transfer full): the #GstEvent to send to the pad.
4868 * Sends the event to the pad. This function can be used
4869 * by applications to send events in the pipeline.
4871 * If @pad is a source pad, @event should be an upstream event. If @pad is a
4872 * sink pad, @event should be a downstream event. For example, you would not
4873 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
4874 * Furthermore, some downstream events have to be serialized with data flow,
4875 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
4876 * the event needs to be serialized with data flow, this function will take the
4877 * pad's stream lock while calling its event function.
4879 * To find out whether an event type is upstream, downstream, or downstream and
4880 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
4881 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
4882 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
4883 * plugin doesn't need to bother itself with this information; the core handles
4884 * all necessary locks and checks.
4886 * This function takes owership of the provided event so you should
4887 * gst_event_ref() it if you want to reuse the event after this call.
4889 * Returns: TRUE if the event was handled.
4892 gst_pad_send_event (GstPad * pad, GstEvent * event)
4895 GstPadProbeType type;
4897 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4898 g_return_val_if_fail (event != NULL, FALSE);
4900 if (GST_PAD_IS_SINK (pad)) {
4901 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4902 goto wrong_direction;
4903 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4904 } else if (GST_PAD_IS_SRC (pad)) {
4905 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4906 goto wrong_direction;
4907 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4909 goto unknown_direction;
4911 if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
4918 /* ERROR handling */
4921 g_warning ("pad %s:%s sending %s event in wrong direction",
4922 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4923 gst_event_unref (event);
4928 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4929 gst_event_unref (event);
4935 * gst_pad_set_element_private:
4936 * @pad: the #GstPad to set the private data of.
4937 * @priv: The private data to attach to the pad.
4939 * Set the given private data gpointer on the pad.
4940 * This function can only be used by the element that owns the pad.
4941 * No locking is performed in this function.
4944 gst_pad_set_element_private (GstPad * pad, gpointer priv)
4946 pad->element_private = priv;
4950 * gst_pad_get_element_private:
4951 * @pad: the #GstPad to get the private data of.
4953 * Gets the private data of a pad.
4954 * No locking is performed in this function.
4956 * Returns: (transfer none): a #gpointer to the private data.
4959 gst_pad_get_element_private (GstPad * pad)
4961 return pad->element_private;
4965 * gst_pad_get_sticky_event:
4966 * @pad: the #GstPad to get the event from.
4967 * @event_type: the #GstEventType that should be retrieved.
4968 * @idx: the index of the event
4970 * Returns a new reference of the sticky event of type @event_type
4973 * Returns: (transfer full): a #GstEvent of type @event_type or NULL when no
4974 * event of @event_type was on @pad. Unref after usage.
4977 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
4979 GstEvent *event = NULL;
4982 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
4983 g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
4985 GST_OBJECT_LOCK (pad);
4986 ev = find_event_by_type (pad, event_type, idx);
4987 if (ev && (event = ev->event))
4988 gst_event_ref (event);
4989 GST_OBJECT_UNLOCK (pad);
4996 GstPadStickyEventsForeachFunction func;
5001 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
5003 ForeachDispatch *data = user_data;
5006 GST_OBJECT_UNLOCK (pad);
5008 ret = data->func (pad, &ev->event, data->user_data);
5010 GST_OBJECT_LOCK (pad);
5016 * gst_pad_sticky_events_foreach:
5017 * @pad: the #GstPad that should be used for iteration.
5018 * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
5019 * should be called for every event.
5020 * @user_data: (closure): the optional user data.
5022 * Iterates all sticky events on @pad and calls @foreach_func for every
5023 * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
5026 gst_pad_sticky_events_foreach (GstPad * pad,
5027 GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
5029 ForeachDispatch data;
5031 g_return_if_fail (GST_IS_PAD (pad));
5032 g_return_if_fail (foreach_func != NULL);
5034 data.func = foreach_func;
5035 data.user_data = user_data;
5037 GST_OBJECT_LOCK (pad);
5038 events_foreach (pad, foreach_dispatch_function, &data);
5039 GST_OBJECT_UNLOCK (pad);
5043 do_stream_status (GstPad * pad, GstStreamStatusType type,
5044 GThread * thread, GstTask * task)
5048 GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
5050 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
5051 if (GST_IS_ELEMENT (parent)) {
5052 GstMessage *message;
5053 GValue value = { 0 };
5055 if (type == GST_STREAM_STATUS_TYPE_ENTER) {
5056 gchar *tname, *ename, *pname;
5058 /* create a good task name */
5059 ename = gst_element_get_name (parent);
5060 pname = gst_pad_get_name (pad);
5061 tname = g_strdup_printf ("%s:%s", ename, pname);
5065 gst_object_set_name (GST_OBJECT_CAST (task), tname);
5069 message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
5072 g_value_init (&value, GST_TYPE_TASK);
5073 g_value_set_object (&value, task);
5074 gst_message_set_stream_status_object (message, &value);
5075 g_value_unset (&value);
5077 GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
5078 gst_element_post_message (parent, message);
5080 gst_object_unref (parent);
5085 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
5087 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
5092 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
5094 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
5099 * gst_pad_start_task:
5100 * @pad: the #GstPad to start the task of
5101 * @func: the task function to call
5102 * @user_data: user data passed to the task function
5103 * @notify: called when @user_data is no longer referenced
5105 * Starts a task that repeatedly calls @func with @user_data. This function
5106 * is mostly used in pad activation functions to start the dataflow.
5107 * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
5108 * before @func is called.
5110 * Returns: a %TRUE if the task could be started.
5113 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer user_data,
5114 GDestroyNotify notify)
5119 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5120 g_return_val_if_fail (func != NULL, FALSE);
5122 GST_DEBUG_OBJECT (pad, "start task");
5124 GST_OBJECT_LOCK (pad);
5125 task = GST_PAD_TASK (pad);
5127 task = gst_task_new (func, user_data, notify);
5128 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5129 gst_task_set_enter_callback (task, pad_enter_thread, pad, NULL);
5130 gst_task_set_leave_callback (task, pad_leave_thread, pad, NULL);
5131 GST_INFO_OBJECT (pad, "created task %p", task);
5132 GST_PAD_TASK (pad) = task;
5133 gst_object_ref (task);
5134 /* release lock to post the message */
5135 GST_OBJECT_UNLOCK (pad);
5137 do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
5139 gst_object_unref (task);
5141 GST_OBJECT_LOCK (pad);
5142 /* nobody else is supposed to have changed the pad now */
5143 if (GST_PAD_TASK (pad) != task)
5144 goto concurrent_stop;
5146 res = gst_task_set_state (task, GST_TASK_STARTED);
5147 GST_OBJECT_UNLOCK (pad);
5154 GST_OBJECT_UNLOCK (pad);
5160 * gst_pad_pause_task:
5161 * @pad: the #GstPad to pause the task of
5163 * Pause the task of @pad. This function will also wait until the
5164 * function executed by the task is finished if this function is not
5165 * called from the task function.
5167 * Returns: a TRUE if the task could be paused or FALSE when the pad
5171 gst_pad_pause_task (GstPad * pad)
5176 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5178 GST_DEBUG_OBJECT (pad, "pause task");
5180 GST_OBJECT_LOCK (pad);
5181 task = GST_PAD_TASK (pad);
5184 res = gst_task_set_state (task, GST_TASK_PAUSED);
5185 GST_OBJECT_UNLOCK (pad);
5187 /* wait for task function to finish, this lock is recursive so it does nothing
5188 * when the pause is called from the task itself */
5189 GST_PAD_STREAM_LOCK (pad);
5190 GST_PAD_STREAM_UNLOCK (pad);
5196 GST_DEBUG_OBJECT (pad, "pad has no task");
5197 GST_OBJECT_UNLOCK (pad);
5203 * gst_pad_stop_task:
5204 * @pad: the #GstPad to stop the task of
5206 * Stop the task of @pad. This function will also make sure that the
5207 * function executed by the task will effectively stop if not called
5208 * from the GstTaskFunction.
5210 * This function will deadlock if called from the GstTaskFunction of
5211 * the task. Use gst_task_pause() instead.
5213 * Regardless of whether the pad has a task, the stream lock is acquired and
5214 * released so as to ensure that streaming through this pad has finished.
5216 * Returns: a TRUE if the task could be stopped or FALSE on error.
5219 gst_pad_stop_task (GstPad * pad)
5224 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5226 GST_DEBUG_OBJECT (pad, "stop task");
5228 GST_OBJECT_LOCK (pad);
5229 task = GST_PAD_TASK (pad);
5232 GST_PAD_TASK (pad) = NULL;
5233 res = gst_task_set_state (task, GST_TASK_STOPPED);
5234 GST_OBJECT_UNLOCK (pad);
5236 GST_PAD_STREAM_LOCK (pad);
5237 GST_PAD_STREAM_UNLOCK (pad);
5239 if (!gst_task_join (task))
5242 gst_object_unref (task);
5248 GST_DEBUG_OBJECT (pad, "no task");
5249 GST_OBJECT_UNLOCK (pad);
5251 GST_PAD_STREAM_LOCK (pad);
5252 GST_PAD_STREAM_UNLOCK (pad);
5254 /* this is not an error */
5259 /* this is bad, possibly the application tried to join the task from
5260 * the task's thread. We install the task again so that it will be stopped
5261 * again from the right thread next time hopefully. */
5262 GST_OBJECT_LOCK (pad);
5263 GST_DEBUG_OBJECT (pad, "join failed");
5264 /* we can only install this task if there was no other task */
5265 if (GST_PAD_TASK (pad) == NULL)
5266 GST_PAD_TASK (pad) = task;
5267 GST_OBJECT_UNLOCK (pad);