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);
812 pre_activate (GstPad * pad, GstPadMode new_mode)
815 case GST_PAD_MODE_NONE:
816 GST_OBJECT_LOCK (pad);
817 GST_DEBUG_OBJECT (pad, "setting PAD_MODE NONE, set flushing");
818 GST_PAD_SET_FLUSHING (pad);
819 GST_PAD_MODE (pad) = new_mode;
820 /* unlock blocked pads so element can resume and stop */
821 GST_PAD_BLOCK_BROADCAST (pad);
822 GST_OBJECT_UNLOCK (pad);
824 case GST_PAD_MODE_PUSH:
825 case GST_PAD_MODE_PULL:
826 GST_OBJECT_LOCK (pad);
827 GST_DEBUG_OBJECT (pad, "setting PAD_MODE %d, unset flushing", new_mode);
828 GST_PAD_UNSET_FLUSHING (pad);
829 GST_PAD_MODE (pad) = new_mode;
830 if (GST_PAD_IS_SINK (pad)) {
832 /* make sure the peer src pad sends us all events */
833 if ((peer = GST_PAD_PEER (pad))) {
834 gst_object_ref (peer);
835 GST_OBJECT_UNLOCK (pad);
837 GST_DEBUG_OBJECT (pad, "reschedule events on peer %s:%s",
838 GST_DEBUG_PAD_NAME (peer));
840 GST_OBJECT_LOCK (peer);
841 schedule_events (peer, NULL);
842 GST_OBJECT_UNLOCK (peer);
844 gst_object_unref (peer);
846 GST_OBJECT_UNLOCK (pad);
849 GST_OBJECT_UNLOCK (pad);
856 post_activate (GstPad * pad, GstPadMode new_mode)
859 case GST_PAD_MODE_NONE:
860 /* ensures that streaming stops */
861 GST_PAD_STREAM_LOCK (pad);
862 GST_DEBUG_OBJECT (pad, "stopped streaming");
863 GST_OBJECT_LOCK (pad);
865 GST_OBJECT_UNLOCK (pad);
866 GST_PAD_STREAM_UNLOCK (pad);
868 case GST_PAD_MODE_PUSH:
869 case GST_PAD_MODE_PULL:
876 * gst_pad_set_active:
877 * @pad: the #GstPad to activate or deactivate.
878 * @active: whether or not the pad should be active.
880 * Activates or deactivates the given pad.
881 * Normally called from within core state change functions.
883 * If @active, makes sure the pad is active. If it is already active, either in
884 * push or pull mode, just return. Otherwise dispatches to the pad's activate
885 * function to perform the actual activation.
887 * If not @active, checks the pad's current mode and calls
888 * gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a
891 * Returns: #TRUE if the operation was successful.
896 gst_pad_set_active (GstPad * pad, gboolean active)
900 gboolean ret = FALSE;
902 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
904 GST_OBJECT_LOCK (pad);
905 old = GST_PAD_MODE (pad);
906 ACQUIRE_PARENT (pad, parent, no_parent);
907 GST_OBJECT_UNLOCK (pad);
910 if (old == GST_PAD_MODE_NONE) {
911 GST_DEBUG_OBJECT (pad, "activating pad from none");
912 ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad, parent);
914 GST_DEBUG_OBJECT (pad, "pad was active in mode %d", old);
918 if (old == GST_PAD_MODE_NONE) {
919 GST_DEBUG_OBJECT (pad, "pad was inactive");
922 GST_DEBUG_OBJECT (pad, "deactivating pad from mode %d", old);
923 ret = gst_pad_activate_mode (pad, old, FALSE);
927 RELEASE_PARENT (parent);
929 if (G_UNLIKELY (!ret))
933 GST_OBJECT_LOCK (pad);
934 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
935 GST_OBJECT_UNLOCK (pad);
942 GST_DEBUG_OBJECT (pad, "no parent");
943 GST_OBJECT_UNLOCK (pad);
948 GST_OBJECT_LOCK (pad);
950 g_critical ("Failed to deactivate pad %s:%s, very bad",
951 GST_DEBUG_PAD_NAME (pad));
953 GST_WARNING_OBJECT (pad, "Failed to activate pad");
955 GST_OBJECT_UNLOCK (pad);
961 * gst_pad_activate_mode:
962 * @pad: the #GstPad to activate or deactivate.
963 * @mode: the requested activation mode
964 * @active: whether or not the pad should be active.
966 * Activates or deactivates the given pad in @mode via dispatching to the
967 * pad's activatemodefunc. For use from within pad activation functions only.
969 * If you don't know what this is, you probably don't want to call it.
971 * Returns: TRUE if the operation was successful.
976 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
978 gboolean res = FALSE;
984 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
986 GST_OBJECT_LOCK (pad);
987 old = GST_PAD_MODE (pad);
988 dir = GST_PAD_DIRECTION (pad);
989 ACQUIRE_PARENT (pad, parent, no_parent);
990 GST_OBJECT_UNLOCK (pad);
992 new = active ? mode : GST_PAD_MODE_NONE;
997 if (active && old != mode) {
998 /* pad was activate in the wrong direction, deactivate it
999 * and reactivate it in the requested mode */
1000 GST_DEBUG_OBJECT (pad, "deactivating pad from mode %d", old);
1001 if (G_UNLIKELY (!gst_pad_activate_mode (pad, old, FALSE)))
1002 goto deactivate_failed;
1006 case GST_PAD_MODE_PULL:
1008 if (dir == GST_PAD_SINK) {
1009 if ((peer = gst_pad_get_peer (pad))) {
1010 GST_DEBUG_OBJECT (pad, "calling peer");
1011 if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
1013 gst_object_unref (peer);
1015 /* there is no peer, this is only fatal when we activate. When we
1016 * deactivate, we must assume the application has unlinked the peer and
1017 * will deactivate it eventually. */
1021 GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
1024 if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
1025 goto failure; /* Can't activate pull on a src without a
1026 getrange function */
1034 pre_activate (pad, new);
1036 if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1037 if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1041 /* can happen for sinks of passthrough elements */
1044 post_activate (pad, new);
1046 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in mode %d",
1047 active ? "activated" : "deactivated", mode);
1052 RELEASE_PARENT (parent);
1058 GST_DEBUG_OBJECT (pad, "no parent");
1059 GST_OBJECT_UNLOCK (pad);
1064 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in mode %d",
1065 active ? "activated" : "deactivated", mode);
1070 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1071 "failed to %s in switch to mode %d from mode %d",
1072 (active ? "activate" : "deactivate"), mode, old);
1077 GST_OBJECT_LOCK (peer);
1078 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1079 "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1080 GST_OBJECT_UNLOCK (peer);
1081 gst_object_unref (peer);
1086 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1087 "pad in pull mode");
1092 GST_OBJECT_LOCK (pad);
1093 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in mode %d",
1094 active ? "activate" : "deactivate", mode);
1095 GST_PAD_SET_FLUSHING (pad);
1096 GST_PAD_MODE (pad) = old;
1097 GST_OBJECT_UNLOCK (pad);
1103 * gst_pad_is_active:
1104 * @pad: the #GstPad to query
1106 * Query if a pad is active
1108 * Returns: TRUE if the pad is active.
1113 gst_pad_is_active (GstPad * pad)
1115 gboolean result = FALSE;
1117 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1119 GST_OBJECT_LOCK (pad);
1120 result = GST_PAD_IS_ACTIVE (pad);
1121 GST_OBJECT_UNLOCK (pad);
1127 * gst_pad_add_probe:
1128 * @pad: the #GstPad to add the probe to
1129 * @mask: the probe mask
1130 * @callback: #GstPadProbeCallback that will be called with notifications of
1132 * @user_data: (closure): user data passed to the callback
1133 * @destroy_data: #GDestroyNotify for user_data
1135 * Be notified of different states of pads. The provided callback is called for
1136 * every state that matches @mask.
1138 * Returns: an id or 0 on error. The id can be used to remove the probe with
1139 * gst_pad_remove_probe().
1144 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1145 GstPadProbeCallback callback, gpointer user_data,
1146 GDestroyNotify destroy_data)
1151 g_return_val_if_fail (GST_IS_PAD (pad), 0);
1152 g_return_val_if_fail (mask != 0, 0);
1154 GST_OBJECT_LOCK (pad);
1156 /* make a new probe */
1157 hook = g_hook_alloc (&pad->probes);
1159 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1162 /* when no contraints are given for the types, assume all types are
1164 if ((mask & GST_PAD_PROBE_TYPE_ALL_BOTH) == 0)
1165 mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1166 if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1167 mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1169 /* store our flags and other fields */
1170 hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1171 hook->func = callback;
1172 hook->data = user_data;
1173 hook->destroy = destroy_data;
1174 PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1177 g_hook_prepend (&pad->probes, hook);
1179 /* incremenent cookie so that the new hook get's called */
1180 pad->priv->probe_list_cookie++;
1182 /* get the id of the hook, we return this and it can be used to remove the
1184 res = hook->hook_id;
1186 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1188 if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1189 /* we have a block probe */
1191 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1192 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1193 "now %d blocking probes", pad->num_blocked);
1196 /* call the callback if we need to be called for idle callbacks */
1197 if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1198 if (pad->priv->using > 0) {
1199 /* the pad is in use, we can't signal the idle callback yet. Since we set the
1200 * flag above, the last thread to leave the push will do the callback. New
1201 * threads going into the push will block. */
1202 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1203 "pad is in use, delay idle callback");
1204 GST_OBJECT_UNLOCK (pad);
1206 GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1208 /* the pad is idle now, we can signal the idle callback now */
1209 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1210 "pad is idle, trigger idle callback");
1211 GST_OBJECT_UNLOCK (pad);
1213 callback (pad, &info, user_data);
1216 GST_OBJECT_UNLOCK (pad);
1222 cleanup_hook (GstPad * pad, GHook * hook)
1224 GstPadProbeType type;
1226 type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1228 if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1229 /* unblock when we remove the last blocking probe */
1231 GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1233 if (pad->num_blocked == 0) {
1234 GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1235 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1236 GST_PAD_BLOCK_BROADCAST (pad);
1239 g_hook_destroy_link (&pad->probes, hook);
1244 * gst_pad_remove_probe:
1245 * @pad: the #GstPad with the probe
1246 * @id: the probe id to remove
1248 * Remove the probe with @id from @pad.
1253 gst_pad_remove_probe (GstPad * pad, gulong id)
1257 g_return_if_fail (GST_IS_PAD (pad));
1259 GST_OBJECT_LOCK (pad);
1261 hook = g_hook_get (&pad->probes, id);
1265 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1267 cleanup_hook (pad, hook);
1268 GST_OBJECT_UNLOCK (pad);
1274 GST_OBJECT_UNLOCK (pad);
1275 g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1281 * gst_pad_is_blocked:
1282 * @pad: the #GstPad to query
1284 * Checks if the pad is blocked or not. This function returns the
1285 * last requested state of the pad. It is not certain that the pad
1286 * is actually blocking at this point (see gst_pad_is_blocking()).
1288 * Returns: TRUE if the pad is blocked.
1293 gst_pad_is_blocked (GstPad * pad)
1295 gboolean result = FALSE;
1297 g_return_val_if_fail (GST_IS_PAD (pad), result);
1299 GST_OBJECT_LOCK (pad);
1300 result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1301 GST_OBJECT_UNLOCK (pad);
1307 * gst_pad_is_blocking:
1308 * @pad: the #GstPad to query
1310 * Checks if the pad is blocking or not. This is a guaranteed state
1311 * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1313 * Returns: TRUE if the pad is blocking.
1320 gst_pad_is_blocking (GstPad * pad)
1322 gboolean result = FALSE;
1324 g_return_val_if_fail (GST_IS_PAD (pad), result);
1326 GST_OBJECT_LOCK (pad);
1327 /* the blocking flag is only valid if the pad is not flushing */
1328 result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1329 GST_OBJECT_UNLOCK (pad);
1335 * gst_pad_check_reconfigure:
1336 * @pad: the #GstPad to check
1338 * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1339 * if the flag was set.
1341 * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1344 gst_pad_check_reconfigure (GstPad * pad)
1346 gboolean reconfigure;
1348 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1350 GST_OBJECT_LOCK (pad);
1351 reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1353 GST_DEBUG_OBJECT (pad, "remove RECONFIGURE flag");
1354 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1355 GST_OBJECT_UNLOCK (pad);
1361 * gst_pad_mark_reconfigure:
1362 * @pad: the #GstPad to mark
1364 * Mark a pad for needing reconfiguration. The next call to
1365 * gst_pad_check_reconfigure() will return %TRUE after this call.
1368 gst_pad_mark_reconfigure (GstPad * pad)
1370 g_return_if_fail (GST_IS_PAD (pad));
1372 GST_OBJECT_LOCK (pad);
1373 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1374 GST_OBJECT_UNLOCK (pad);
1378 * gst_pad_set_activate_function_full:
1380 * @activate: the #GstPadActivateFunction to set.
1381 * @user_data: user_data passed to @notify
1382 * @notify: notify called when @activate will not be used anymore.
1384 * Sets the given activate function for @pad. The activate function will
1385 * dispatch to gst_pad_activate_push() or gst_pad_activate_pull() to perform
1386 * the actual activation. Only makes sense to set on sink pads.
1388 * Call this function if your sink pad can start a pull-based task.
1391 gst_pad_set_activate_function_full (GstPad * pad,
1392 GstPadActivateFunction activate, gpointer user_data, GDestroyNotify notify)
1394 g_return_if_fail (GST_IS_PAD (pad));
1396 if (pad->activatenotify)
1397 pad->activatenotify (pad->activatedata);
1398 GST_PAD_ACTIVATEFUNC (pad) = activate;
1399 pad->activatedata = user_data;
1400 pad->activatenotify = notify;
1402 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1403 GST_DEBUG_FUNCPTR_NAME (activate));
1407 * gst_pad_set_activatemode_function_full:
1409 * @activatemode: the #GstPadActivateModeFunction to set.
1410 * @user_data: user_data passed to @notify
1411 * @notify: notify called when @activatemode will not be used anymore.
1413 * Sets the given activate_mode function for the pad. An activate_mode function
1414 * prepares the element for data passing.
1417 gst_pad_set_activatemode_function_full (GstPad * pad,
1418 GstPadActivateModeFunction activatemode, gpointer user_data,
1419 GDestroyNotify notify)
1421 g_return_if_fail (GST_IS_PAD (pad));
1423 if (pad->activatemodenotify)
1424 pad->activatemodenotify (pad->activatemodedata);
1425 GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1426 pad->activatemodedata = user_data;
1427 pad->activatemodenotify = notify;
1429 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1430 GST_DEBUG_FUNCPTR_NAME (activatemode));
1434 * gst_pad_set_chain_function_full:
1435 * @pad: a sink #GstPad.
1436 * @chain: the #GstPadChainFunction to set.
1437 * @user_data: user_data passed to @notify
1438 * @notify: notify called when @chain will not be used anymore.
1440 * Sets the given chain function for the pad. The chain function is called to
1441 * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1444 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1445 gpointer user_data, GDestroyNotify notify)
1447 g_return_if_fail (GST_IS_PAD (pad));
1448 g_return_if_fail (GST_PAD_IS_SINK (pad));
1450 if (pad->chainnotify)
1451 pad->chainnotify (pad->chaindata);
1452 GST_PAD_CHAINFUNC (pad) = chain;
1453 pad->chaindata = user_data;
1454 pad->chainnotify = notify;
1456 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1457 GST_DEBUG_FUNCPTR_NAME (chain));
1461 * gst_pad_set_chain_list_function_full:
1462 * @pad: a sink #GstPad.
1463 * @chainlist: the #GstPadChainListFunction to set.
1464 * @user_data: user_data passed to @notify
1465 * @notify: notify called when @chainlist will not be used anymore.
1467 * Sets the given chain list function for the pad. The chainlist function is
1468 * called to process a #GstBufferList input buffer list. See
1469 * #GstPadChainListFunction for more details.
1474 gst_pad_set_chain_list_function_full (GstPad * pad,
1475 GstPadChainListFunction chainlist, gpointer user_data,
1476 GDestroyNotify notify)
1478 g_return_if_fail (GST_IS_PAD (pad));
1479 g_return_if_fail (GST_PAD_IS_SINK (pad));
1481 if (pad->chainlistnotify)
1482 pad->chainlistnotify (pad->chainlistdata);
1483 GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1484 pad->chainlistdata = user_data;
1485 pad->chainlistnotify = notify;
1487 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1488 GST_DEBUG_FUNCPTR_NAME (chainlist));
1492 * gst_pad_set_getrange_function_full:
1493 * @pad: a source #GstPad.
1494 * @get: the #GstPadGetRangeFunction to set.
1495 * @user_data: user_data passed to @notify
1496 * @notify: notify called when @get will not be used anymore.
1498 * Sets the given getrange function for the pad. The getrange function is
1499 * called to produce a new #GstBuffer to start the processing pipeline. see
1500 * #GstPadGetRangeFunction for a description of the getrange function.
1503 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1504 gpointer user_data, GDestroyNotify notify)
1506 g_return_if_fail (GST_IS_PAD (pad));
1507 g_return_if_fail (GST_PAD_IS_SRC (pad));
1509 if (pad->getrangenotify)
1510 pad->getrangenotify (pad->getrangedata);
1511 GST_PAD_GETRANGEFUNC (pad) = get;
1512 pad->getrangedata = user_data;
1513 pad->getrangenotify = notify;
1515 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1516 GST_DEBUG_FUNCPTR_NAME (get));
1520 * gst_pad_set_event_function_full:
1521 * @pad: a #GstPad of either direction.
1522 * @event: the #GstPadEventFunction to set.
1523 * @user_data: user_data passed to @notify
1524 * @notify: notify called when @event will not be used anymore.
1526 * Sets the given event handler for the pad.
1529 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1530 gpointer user_data, GDestroyNotify notify)
1532 g_return_if_fail (GST_IS_PAD (pad));
1534 if (pad->eventnotify)
1535 pad->eventnotify (pad->eventdata);
1536 GST_PAD_EVENTFUNC (pad) = event;
1537 pad->eventdata = user_data;
1538 pad->eventnotify = notify;
1540 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1541 GST_DEBUG_FUNCPTR_NAME (event));
1545 * gst_pad_set_query_function_full:
1546 * @pad: a #GstPad of either direction.
1547 * @query: the #GstPadQueryFunction to set.
1548 * @user_data: user_data passed to @notify
1549 * @notify: notify called when @query will not be used anymore.
1551 * Set the given query function for the pad.
1554 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1555 gpointer user_data, GDestroyNotify notify)
1557 g_return_if_fail (GST_IS_PAD (pad));
1559 if (pad->querynotify)
1560 pad->querynotify (pad->querydata);
1561 GST_PAD_QUERYFUNC (pad) = query;
1562 pad->querydata = user_data;
1563 pad->querynotify = notify;
1565 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1566 GST_DEBUG_FUNCPTR_NAME (query));
1570 * gst_pad_set_iterate_internal_links_function_full:
1571 * @pad: a #GstPad of either direction.
1572 * @iterintlink: the #GstPadIterIntLinkFunction to set.
1573 * @user_data: user_data passed to @notify
1574 * @notify: notify called when @iterintlink will not be used anymore.
1576 * Sets the given internal link iterator function for the pad.
1581 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1582 GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1583 GDestroyNotify notify)
1585 g_return_if_fail (GST_IS_PAD (pad));
1587 if (pad->iterintlinknotify)
1588 pad->iterintlinknotify (pad->iterintlinkdata);
1589 GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1590 pad->iterintlinkdata = user_data;
1591 pad->iterintlinknotify = notify;
1593 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1594 GST_DEBUG_FUNCPTR_NAME (iterintlink));
1598 * gst_pad_set_link_function_full:
1600 * @link: the #GstPadLinkFunction to set.
1601 * @user_data: user_data passed to @notify
1602 * @notify: notify called when @link will not be used anymore.
1604 * Sets the given link function for the pad. It will be called when
1605 * the pad is linked with another pad.
1607 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1610 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1611 * cannot be made for some reason.
1613 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1614 * of the peer sink pad, if present.
1617 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1618 gpointer user_data, GDestroyNotify notify)
1620 g_return_if_fail (GST_IS_PAD (pad));
1622 if (pad->linknotify)
1623 pad->linknotify (pad->linkdata);
1624 GST_PAD_LINKFUNC (pad) = link;
1625 pad->linkdata = user_data;
1626 pad->linknotify = notify;
1628 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1629 GST_DEBUG_FUNCPTR_NAME (link));
1633 * gst_pad_set_unlink_function_full:
1635 * @unlink: the #GstPadUnlinkFunction to set.
1636 * @user_data: user_data passed to @notify
1637 * @notify: notify called when @unlink will not be used anymore.
1639 * Sets the given unlink function for the pad. It will be called
1640 * when the pad is unlinked.
1643 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
1644 gpointer user_data, GDestroyNotify notify)
1646 g_return_if_fail (GST_IS_PAD (pad));
1648 if (pad->unlinknotify)
1649 pad->unlinknotify (pad->unlinkdata);
1650 GST_PAD_UNLINKFUNC (pad) = unlink;
1651 pad->unlinkdata = user_data;
1652 pad->unlinknotify = notify;
1654 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1655 GST_DEBUG_FUNCPTR_NAME (unlink));
1660 * @srcpad: the source #GstPad to unlink.
1661 * @sinkpad: the sink #GstPad to unlink.
1663 * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1664 * signal on both pads.
1666 * Returns: TRUE if the pads were unlinked. This function returns FALSE if
1667 * the pads were not linked together.
1672 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1674 gboolean result = FALSE;
1675 GstElement *parent = NULL;
1677 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1678 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1679 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1680 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1682 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1683 GST_DEBUG_PAD_NAME (srcpad), srcpad,
1684 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1686 /* We need to notify the parent before taking any pad locks as the bin in
1687 * question might be waiting for a lock on the pad while holding its lock
1688 * that our message will try to take. */
1689 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
1690 if (GST_IS_ELEMENT (parent)) {
1691 gst_element_post_message (parent,
1692 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1693 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
1695 gst_object_unref (parent);
1700 GST_OBJECT_LOCK (srcpad);
1701 GST_OBJECT_LOCK (sinkpad);
1703 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1704 goto not_linked_together;
1706 if (GST_PAD_UNLINKFUNC (srcpad)) {
1707 GST_PAD_UNLINKFUNC (srcpad) (srcpad);
1709 if (GST_PAD_UNLINKFUNC (sinkpad)) {
1710 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad);
1713 /* first clear peers */
1714 GST_PAD_PEER (srcpad) = NULL;
1715 GST_PAD_PEER (sinkpad) = NULL;
1717 GST_OBJECT_UNLOCK (sinkpad);
1718 GST_OBJECT_UNLOCK (srcpad);
1720 /* fire off a signal to each of the pads telling them
1721 * that they've been unlinked */
1722 g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1723 g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1725 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1726 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1731 if (parent != NULL) {
1732 gst_element_post_message (parent,
1733 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1734 GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
1735 gst_object_unref (parent);
1740 not_linked_together:
1742 /* we do not emit a warning in this case because unlinking cannot
1743 * be made MT safe.*/
1744 GST_OBJECT_UNLOCK (sinkpad);
1745 GST_OBJECT_UNLOCK (srcpad);
1751 * gst_pad_is_linked:
1752 * @pad: pad to check
1754 * Checks if a @pad is linked to another pad or not.
1756 * Returns: TRUE if the pad is linked, FALSE otherwise.
1761 gst_pad_is_linked (GstPad * pad)
1765 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1767 GST_OBJECT_LOCK (pad);
1768 result = (GST_PAD_PEER (pad) != NULL);
1769 GST_OBJECT_UNLOCK (pad);
1774 /* get the caps from both pads and see if the intersection
1777 * This function should be called with the pad LOCK on both
1781 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
1782 GstPadLinkCheck flags)
1784 GstCaps *srccaps = NULL;
1785 GstCaps *sinkcaps = NULL;
1786 gboolean compatible = FALSE;
1788 if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
1791 /* Doing the expensive caps checking takes priority over only checking the template caps */
1792 if (flags & GST_PAD_LINK_CHECK_CAPS) {
1793 GST_OBJECT_UNLOCK (sink);
1794 GST_OBJECT_UNLOCK (src);
1796 srccaps = gst_pad_query_caps (src, NULL);
1797 sinkcaps = gst_pad_query_caps (sink, NULL);
1799 GST_OBJECT_LOCK (src);
1800 GST_OBJECT_LOCK (sink);
1802 /* If one of the two pads doesn't have a template, consider the intersection
1804 if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
1805 || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
1809 srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
1811 gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
1814 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
1816 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
1819 /* if we have caps on both pads we can check the intersection. If one
1820 * of the caps is NULL, we return TRUE. */
1821 if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
1823 gst_caps_unref (srccaps);
1825 gst_caps_unref (sinkcaps);
1829 compatible = gst_caps_can_intersect (srccaps, sinkcaps);
1830 gst_caps_unref (srccaps);
1831 gst_caps_unref (sinkcaps);
1834 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
1835 (compatible ? "" : "not"));
1840 /* check if the grandparents of both pads are the same.
1841 * This check is required so that we don't try to link
1842 * pads from elements in different bins without ghostpads.
1844 * The LOCK should be held on both pads
1847 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
1849 GstObject *psrc, *psink;
1851 psrc = GST_OBJECT_PARENT (src);
1852 psink = GST_OBJECT_PARENT (sink);
1854 /* if one of the pads has no parent, we allow the link */
1855 if (G_UNLIKELY (psrc == NULL || psink == NULL))
1858 /* only care about parents that are elements */
1859 if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
1860 goto no_element_parent;
1862 /* if the parents are the same, we have a loop */
1863 if (G_UNLIKELY (psrc == psink))
1866 /* if they both have a parent, we check the grandparents. We can not lock
1867 * the parent because we hold on the child (pad) and the locking order is
1868 * parent >> child. */
1869 psrc = GST_OBJECT_PARENT (psrc);
1870 psink = GST_OBJECT_PARENT (psink);
1872 /* if they have grandparents but they are not the same */
1873 if (G_UNLIKELY (psrc != psink))
1874 goto wrong_grandparents;
1881 GST_CAT_DEBUG (GST_CAT_CAPS,
1882 "one of the pads has no parent %" GST_PTR_FORMAT " and %"
1883 GST_PTR_FORMAT, psrc, psink);
1888 GST_CAT_DEBUG (GST_CAT_CAPS,
1889 "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
1890 GST_PTR_FORMAT, psrc, psink);
1895 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
1901 GST_CAT_DEBUG (GST_CAT_CAPS,
1902 "pads have different grandparents %" GST_PTR_FORMAT " and %"
1903 GST_PTR_FORMAT, psrc, psink);
1908 /* FIXME leftover from an attempt at refactoring... */
1909 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
1910 * the two pads will be locked in the srcpad, sinkpad order. */
1911 static GstPadLinkReturn
1912 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
1914 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1915 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1917 GST_OBJECT_LOCK (srcpad);
1919 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
1920 goto src_was_linked;
1922 GST_OBJECT_LOCK (sinkpad);
1924 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
1925 goto sink_was_linked;
1927 /* check hierarchy, pads can only be linked if the grandparents
1929 if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
1930 && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
1931 goto wrong_hierarchy;
1933 /* check pad caps for non-empty intersection */
1934 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
1937 /* FIXME check pad scheduling for non-empty intersection */
1939 return GST_PAD_LINK_OK;
1943 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
1944 GST_DEBUG_PAD_NAME (srcpad),
1945 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1946 /* we do not emit a warning in this case because unlinking cannot
1947 * be made MT safe.*/
1948 GST_OBJECT_UNLOCK (srcpad);
1949 return GST_PAD_LINK_WAS_LINKED;
1953 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
1954 GST_DEBUG_PAD_NAME (sinkpad),
1955 GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
1956 /* we do not emit a warning in this case because unlinking cannot
1957 * be made MT safe.*/
1958 GST_OBJECT_UNLOCK (sinkpad);
1959 GST_OBJECT_UNLOCK (srcpad);
1960 return GST_PAD_LINK_WAS_LINKED;
1964 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
1965 GST_OBJECT_UNLOCK (sinkpad);
1966 GST_OBJECT_UNLOCK (srcpad);
1967 return GST_PAD_LINK_WRONG_HIERARCHY;
1971 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
1972 GST_OBJECT_UNLOCK (sinkpad);
1973 GST_OBJECT_UNLOCK (srcpad);
1974 return GST_PAD_LINK_NOFORMAT;
1980 * @srcpad: the source #GstPad.
1981 * @sinkpad: the sink #GstPad.
1983 * Checks if the source pad and the sink pad are compatible so they can be
1986 * Returns: TRUE if the pads can be linked.
1989 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
1991 GstPadLinkReturn result;
1993 /* generic checks */
1994 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1995 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1997 GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
1998 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2000 /* gst_pad_link_prepare does everything for us, we only release the locks
2001 * on the pads that it gets us. If this function returns !OK the locks are not
2003 result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2004 if (result != GST_PAD_LINK_OK)
2007 GST_OBJECT_UNLOCK (srcpad);
2008 GST_OBJECT_UNLOCK (sinkpad);
2011 return result == GST_PAD_LINK_OK;
2015 * gst_pad_link_full:
2016 * @srcpad: the source #GstPad to link.
2017 * @sinkpad: the sink #GstPad to link.
2018 * @flags: the checks to validate when linking
2020 * Links the source pad and the sink pad.
2022 * This variant of #gst_pad_link provides a more granular control on the
2023 * checks being done when linking. While providing some considerable speedups
2024 * the caller of this method must be aware that wrong usage of those flags
2025 * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
2026 * for more information.
2030 * Returns: A result code indicating if the connection worked or
2036 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2038 GstPadLinkReturn result;
2040 GstPadLinkFunction srcfunc, sinkfunc;
2042 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2043 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2044 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2045 g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2046 GST_PAD_LINK_WRONG_DIRECTION);
2048 /* Notify the parent early. See gst_pad_unlink for details. */
2049 if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2050 if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2051 gst_element_post_message (parent,
2052 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2053 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2055 gst_object_unref (parent);
2060 /* prepare will also lock the two pads */
2061 result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2063 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2066 /* must set peers before calling the link function */
2067 GST_PAD_PEER (srcpad) = sinkpad;
2068 GST_PAD_PEER (sinkpad) = srcpad;
2070 /* check events, when something is different, mark pending */
2071 schedule_events (srcpad, sinkpad);
2073 /* get the link functions */
2074 srcfunc = GST_PAD_LINKFUNC (srcpad);
2075 sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2077 if (G_UNLIKELY (srcfunc || sinkfunc)) {
2078 /* custom link functions, execute them */
2079 GST_OBJECT_UNLOCK (sinkpad);
2080 GST_OBJECT_UNLOCK (srcpad);
2083 /* this one will call the peer link function */
2084 result = srcfunc (srcpad, sinkpad);
2085 } else if (sinkfunc) {
2086 /* if no source link function, we need to call the sink link
2087 * function ourselves. */
2088 result = sinkfunc (sinkpad, srcpad);
2091 GST_OBJECT_LOCK (srcpad);
2092 GST_OBJECT_LOCK (sinkpad);
2094 /* we released the lock, check if the same pads are linked still */
2095 if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2096 goto concurrent_link;
2098 if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2101 GST_OBJECT_UNLOCK (sinkpad);
2102 GST_OBJECT_UNLOCK (srcpad);
2104 /* fire off a signal to each of the pads telling them
2105 * that they've been linked */
2106 g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2107 g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2109 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2110 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2112 gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2115 if (G_LIKELY (parent)) {
2116 gst_element_post_message (parent,
2117 gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2118 GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2119 gst_object_unref (parent);
2127 GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2128 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2129 GST_OBJECT_UNLOCK (sinkpad);
2130 GST_OBJECT_UNLOCK (srcpad);
2132 /* The other link operation succeeded first */
2133 result = GST_PAD_LINK_WAS_LINKED;
2138 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed",
2139 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2141 GST_PAD_PEER (srcpad) = NULL;
2142 GST_PAD_PEER (sinkpad) = NULL;
2144 GST_OBJECT_UNLOCK (sinkpad);
2145 GST_OBJECT_UNLOCK (srcpad);
2153 * @srcpad: the source #GstPad to link.
2154 * @sinkpad: the sink #GstPad to link.
2156 * Links the source pad and the sink pad.
2158 * Returns: A result code indicating if the connection worked or
2164 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2166 return gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2170 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2172 GstPadTemplate **template_p;
2174 /* this function would need checks if it weren't static */
2176 GST_OBJECT_LOCK (pad);
2177 template_p = &pad->padtemplate;
2178 gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2179 GST_OBJECT_UNLOCK (pad);
2182 gst_pad_template_pad_created (templ, pad);
2186 * gst_pad_get_pad_template:
2189 * Gets the template for @pad.
2191 * Returns: (transfer full): the #GstPadTemplate from which this pad was
2192 * instantiated, or %NULL if this pad has no template. Unref after
2196 gst_pad_get_pad_template (GstPad * pad)
2198 GstPadTemplate *templ;
2200 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2202 templ = GST_PAD_PAD_TEMPLATE (pad);
2204 return (templ ? gst_object_ref (templ) : NULL);
2208 * gst_pad_has_current_caps:
2209 * @pad: a #GstPad to check
2211 * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2213 * Returns: TRUE when @pad has caps associated with it.
2216 gst_pad_has_current_caps (GstPad * pad)
2221 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2223 GST_OBJECT_LOCK (pad);
2224 caps = get_pad_caps (pad);
2225 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2226 "check current pad caps %" GST_PTR_FORMAT, caps);
2227 result = (caps != NULL);
2228 GST_OBJECT_UNLOCK (pad);
2234 * gst_pad_get_current_caps:
2235 * @pad: a #GstPad to get the current capabilities of.
2237 * Gets the capabilities currently configured on @pad with the last
2238 * #GST_EVENT_CAPS event.
2240 * Returns: the current caps of the pad with incremented ref-count.
2243 gst_pad_get_current_caps (GstPad * pad)
2247 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2249 GST_OBJECT_LOCK (pad);
2250 if ((result = get_pad_caps (pad)))
2251 gst_caps_ref (result);
2252 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2253 "get current pad caps %" GST_PTR_FORMAT, result);
2254 GST_OBJECT_UNLOCK (pad);
2261 * @pad: a #GstPad to set the capabilities of.
2262 * @caps: (transfer none): a #GstCaps to set.
2264 * Sets the capabilities of this pad. The caps must be fixed. Any previous
2265 * caps on the pad will be unreffed. This function refs the caps so you should
2266 * unref if as soon as you don't need it anymore.
2267 * It is possible to set NULL caps, which will make the pad unnegotiated
2270 * Returns: TRUE if the caps could be set. FALSE if the caps were not fixed
2271 * or bad parameters were provided to this function.
2276 gst_pad_set_caps (GstPad * pad, GstCaps * caps)
2279 gboolean res = TRUE;
2281 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2282 g_return_val_if_fail (caps != NULL && gst_caps_is_fixed (caps), FALSE);
2284 event = gst_event_new_caps (caps);
2286 if (GST_PAD_IS_SRC (pad))
2287 res = gst_pad_push_event (pad, event);
2289 res = gst_pad_send_event (pad, event);
2295 * gst_pad_get_pad_template_caps:
2296 * @pad: a #GstPad to get the template capabilities from.
2298 * Gets the capabilities for @pad's template.
2300 * Returns: (transfer full): the #GstCaps of this pad template.
2301 * Unref after usage.
2304 gst_pad_get_pad_template_caps (GstPad * pad)
2306 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2308 if (GST_PAD_PAD_TEMPLATE (pad))
2309 return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2311 return gst_caps_ref (GST_CAPS_ANY);
2316 * @pad: a #GstPad to get the peer of.
2318 * Gets the peer of @pad. This function refs the peer pad so
2319 * you need to unref it after use.
2321 * Returns: (transfer full): the peer #GstPad. Unref after usage.
2326 gst_pad_get_peer (GstPad * pad)
2330 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2332 GST_OBJECT_LOCK (pad);
2333 result = GST_PAD_PEER (pad);
2335 gst_object_ref (result);
2336 GST_OBJECT_UNLOCK (pad);
2342 * gst_pad_get_allowed_caps:
2345 * Gets the capabilities of the allowed media types that can flow through
2346 * @pad and its peer.
2348 * The allowed capabilities is calculated as the intersection of the results of
2349 * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2350 * on the resulting caps.
2352 * Returns: (transfer full): the allowed #GstCaps of the pad link. Unref the
2353 * caps when you no longer need it. This function returns NULL when @pad
2359 gst_pad_get_allowed_caps (GstPad * pad)
2366 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2368 GST_OBJECT_LOCK (pad);
2369 peer = GST_PAD_PEER (pad);
2370 if (G_UNLIKELY (peer == NULL))
2373 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2375 gst_object_ref (peer);
2376 GST_OBJECT_UNLOCK (pad);
2377 mycaps = gst_pad_query_caps (pad, NULL);
2379 peercaps = gst_pad_query_caps (peer, NULL);
2380 gst_object_unref (peer);
2382 caps = gst_caps_intersect (mycaps, peercaps);
2383 gst_caps_unref (peercaps);
2384 gst_caps_unref (mycaps);
2386 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2393 GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2394 GST_OBJECT_UNLOCK (pad);
2401 * gst_pad_iterate_internal_links_default:
2402 * @pad: the #GstPad to get the internal links of.
2403 * @parent: the parent of @pad or NULL
2405 * Iterate the list of pads to which the given pad is linked to inside of
2406 * the parent element.
2407 * This is the default handler, and thus returns an iterator of all of the
2408 * pads inside the parent element with opposite direction.
2410 * The caller must free this iterator after use with gst_iterator_free().
2412 * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
2413 * returned pad with gst_object_unref().
2418 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2425 GstElement *eparent;
2427 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2429 if (parent != NULL && GST_IS_ELEMENT (parent)) {
2430 eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2432 GST_OBJECT_LOCK (pad);
2433 eparent = GST_PAD_PARENT (pad);
2434 if (!eparent || !GST_IS_ELEMENT (eparent))
2437 gst_object_ref (eparent);
2438 GST_OBJECT_UNLOCK (pad);
2441 if (pad->direction == GST_PAD_SRC)
2442 padlist = &eparent->sinkpads;
2444 padlist = &eparent->srcpads;
2446 GST_DEBUG_OBJECT (pad, "Making iterator");
2448 cookie = &eparent->pads_cookie;
2450 lock = GST_OBJECT_GET_LOCK (eparent);
2452 res = gst_iterator_new_list (GST_TYPE_PAD,
2453 lock, cookie, padlist, (GObject *) owner, NULL);
2455 gst_object_unref (owner);
2462 GST_OBJECT_UNLOCK (pad);
2463 GST_DEBUG_OBJECT (pad, "no parent element");
2469 * gst_pad_iterate_internal_links:
2470 * @pad: the GstPad to get the internal links of.
2472 * Gets an iterator for the pads to which the given pad is linked to inside
2473 * of the parent element.
2475 * Each #GstPad element yielded by the iterator will have its refcount increased,
2476 * so unref after use.
2478 * Free-function: gst_iterator_free
2480 * Returns: (transfer full): a new #GstIterator of #GstPad or %NULL when the
2481 * pad does not have an iterator function configured. Use
2482 * gst_iterator_free() after usage.
2487 gst_pad_iterate_internal_links (GstPad * pad)
2489 GstIterator *res = NULL;
2492 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2494 GST_OBJECT_LOCK (pad);
2495 ACQUIRE_PARENT (pad, parent, no_parent);
2496 GST_OBJECT_UNLOCK (pad);
2498 if (GST_PAD_ITERINTLINKFUNC (pad))
2499 res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2501 RELEASE_PARENT (parent);
2508 GST_DEBUG_OBJECT (pad, "no parent");
2509 GST_OBJECT_UNLOCK (pad);
2517 * @forward: a #GstPadForwardFunction
2518 * @user_data: user data passed to @forward
2520 * Calls @forward for all internally linked pads of @pad. This function deals with
2521 * dynamically changing internal pads and will make sure that the @forward
2522 * function is only called once for each pad.
2524 * When @forward returns TRUE, no further pads will be processed.
2526 * Returns: TRUE if one of the dispatcher functions returned TRUE.
2529 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2532 gboolean result = FALSE;
2534 gboolean done = FALSE;
2535 GValue item = { 0, };
2536 GList *pushed_pads = NULL;
2538 iter = gst_pad_iterate_internal_links (pad);
2544 switch (gst_iterator_next (iter, &item)) {
2545 case GST_ITERATOR_OK:
2549 intpad = g_value_get_object (&item);
2551 /* if already pushed, skip. FIXME, find something faster to tag pads */
2552 if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2553 g_value_reset (&item);
2557 GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2558 GST_DEBUG_PAD_NAME (intpad));
2559 done = result = forward (intpad, user_data);
2561 pushed_pads = g_list_prepend (pushed_pads, intpad);
2563 g_value_reset (&item);
2566 case GST_ITERATOR_RESYNC:
2567 /* We don't reset the result here because we don't push the event
2568 * again on pads that got the event already and because we need
2569 * to consider the result of the previous pushes */
2570 gst_iterator_resync (iter);
2572 case GST_ITERATOR_ERROR:
2573 GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2576 case GST_ITERATOR_DONE:
2581 g_value_unset (&item);
2582 gst_iterator_free (iter);
2584 g_list_free (pushed_pads);
2594 gboolean dispatched;
2598 event_forward_func (GstPad * pad, EventData * data)
2600 /* for each pad we send to, we should ref the event; it's up
2601 * to downstream to unref again when handled. */
2602 GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2603 data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2605 data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2607 data->dispatched = TRUE;
2614 * gst_pad_event_default:
2615 * @pad: a #GstPad to call the default event handler on.
2616 * @parent: the parent of @pad or NULL
2617 * @event: (transfer full): the #GstEvent to handle.
2619 * Invokes the default event handler for the given pad.
2621 * The EOS event will pause the task associated with @pad before it is forwarded
2622 * to all internally linked pads,
2624 * The the event is sent to all pads internally linked to @pad. This function
2625 * takes ownership of @event.
2627 * Returns: TRUE if the event was sent successfully.
2630 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2632 gboolean result, forward = TRUE;
2634 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2635 g_return_val_if_fail (event != NULL, FALSE);
2637 GST_LOG_OBJECT (pad, "default event handler");
2639 switch (GST_EVENT_TYPE (event)) {
2642 GST_DEBUG_OBJECT (pad, "pausing task because of eos");
2643 gst_pad_pause_task (pad);
2646 case GST_EVENT_CAPS:
2647 forward = GST_PAD_IS_PROXY_CAPS (pad);
2658 data.dispatched = FALSE;
2659 data.result = FALSE;
2661 gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
2663 /* for sinkpads without a parent element or without internal links, nothing
2664 * will be dispatched but we still want to return TRUE. */
2665 if (data.dispatched)
2666 result = data.result;
2671 gst_event_unref (event);
2676 /* Default accept caps implementation just checks against
2677 * the allowed caps for the pad */
2679 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
2681 /* get the caps and see if it intersects to something not empty */
2682 GstCaps *caps, *allowed;
2685 GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
2687 /* first forward the query to internally linked pads when we are dealing with
2689 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2690 if ((result = gst_pad_proxy_query_accept_caps (pad, query))) {
2695 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
2696 "fallback ACCEPT_CAPS query, consider implementing a specialized version");
2698 allowed = gst_pad_query_caps (pad, NULL);
2699 gst_query_parse_accept_caps (query, &caps);
2702 GST_DEBUG_OBJECT (pad, "allowed caps %" GST_PTR_FORMAT, allowed);
2703 result = gst_caps_is_subset (caps, allowed);
2704 gst_caps_unref (allowed);
2706 GST_DEBUG_OBJECT (pad, "no caps allowed on the pad");
2709 gst_query_set_accept_caps_result (query, result);
2715 /* Default caps implementation */
2717 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
2719 GstCaps *result = NULL, *filter;
2720 GstPadTemplate *templ;
2721 gboolean fixed_caps;
2723 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
2725 gst_query_parse_caps (query, &filter);
2727 /* first try to proxy if we must */
2728 if (GST_PAD_IS_PROXY_CAPS (pad)) {
2729 if ((gst_pad_proxy_query_caps (pad, query))) {
2730 gst_query_parse_caps_result (query, &result);
2735 /* no proxy or it failed, do default handling */
2736 fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
2738 GST_OBJECT_LOCK (pad);
2740 /* fixed caps, try the negotiated caps first */
2741 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
2742 if ((result = get_pad_caps (pad)))
2743 goto filter_done_unlock;
2746 if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
2747 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
2748 if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
2749 goto filter_done_unlock;
2753 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2754 "non-fixed pad caps: trying pad caps");
2755 /* non fixed caps, try the negotiated caps */
2756 if ((result = get_pad_caps (pad)))
2757 goto filter_done_unlock;
2760 /* this almost never happens */
2761 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
2762 result = GST_CAPS_ANY;
2765 GST_OBJECT_UNLOCK (pad);
2768 /* run the filter on the result */
2770 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2771 "using caps %p %" GST_PTR_FORMAT " with filter %p %"
2772 GST_PTR_FORMAT, result, result, filter, filter);
2773 result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
2774 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
2777 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2778 "using caps %p %" GST_PTR_FORMAT, result, result);
2779 result = gst_caps_ref (result);
2782 gst_query_set_caps_result (query, result);
2783 gst_caps_unref (result);
2792 gboolean dispatched;
2796 query_forward_func (GstPad * pad, QueryData * data)
2798 GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
2799 data->query, GST_EVENT_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
2801 data->result |= gst_pad_peer_query (pad, data->query);
2803 data->dispatched = TRUE;
2805 /* stop on first successful reply */
2806 return data->result;
2810 * gst_pad_query_default:
2811 * @pad: a #GstPad to call the default query handler on.
2812 * @parent: the parent of @pad or NULL
2813 * @query: (transfer none): the #GstQuery to handle.
2815 * Invokes the default query handler for the given pad.
2816 * The query is sent to all pads internally linked to @pad. Note that
2817 * if there are many possible sink pads that are internally linked to
2818 * @pad, only one will be sent the query.
2819 * Multi-sinkpad elements should implement custom query handlers.
2821 * Returns: TRUE if the query was performed successfully.
2824 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
2826 gboolean forward, ret = FALSE;
2828 switch (GST_QUERY_TYPE (query)) {
2829 case GST_QUERY_SCHEDULING:
2832 case GST_QUERY_ALLOCATION:
2833 forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
2835 case GST_QUERY_ACCEPT_CAPS:
2836 ret = gst_pad_query_accept_caps_default (pad, query);
2839 case GST_QUERY_CAPS:
2840 ret = gst_pad_query_caps_default (pad, query);
2843 case GST_QUERY_POSITION:
2844 case GST_QUERY_SEEKING:
2845 case GST_QUERY_FORMATS:
2846 case GST_QUERY_LATENCY:
2847 case GST_QUERY_JITTER:
2848 case GST_QUERY_RATE:
2849 case GST_QUERY_CONVERT:
2855 GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
2856 query, GST_QUERY_TYPE_NAME (query));
2862 data.dispatched = FALSE;
2863 data.result = FALSE;
2865 gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
2867 if (data.dispatched) {
2870 /* nothing dispatched, assume drained */
2871 if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
2881 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
2883 GstPad *pad = data->pad;
2884 GstPadProbeInfo *info = data->info;
2885 GstPadProbeType type, flags;
2886 GstPadProbeCallback callback;
2887 GstPadProbeReturn ret;
2889 /* if we have called this callback, do nothing */
2890 if (PROBE_COOKIE (hook) == data->cookie) {
2891 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2892 "hook %lu, cookie %u already called", hook->hook_id,
2893 PROBE_COOKIE (hook));
2897 PROBE_COOKIE (hook) = data->cookie;
2899 flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
2902 /* one of the data types */
2903 if ((flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
2905 /* one of the scheduling types */
2906 if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
2908 /* one of the blocking types must match */
2909 if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
2910 (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
2912 /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
2913 if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
2914 (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
2917 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2918 "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
2919 PROBE_COOKIE (hook), flags);
2921 data->marshalled = TRUE;
2923 callback = (GstPadProbeCallback) hook->func;
2924 if (callback == NULL)
2927 info->id = hook->hook_id;
2929 GST_OBJECT_UNLOCK (pad);
2931 ret = callback (pad, info, hook->data);
2933 GST_OBJECT_LOCK (pad);
2936 case GST_PAD_PROBE_REMOVE:
2937 /* remove the probe */
2938 GST_DEBUG_OBJECT (pad, "asked to remove hook");
2939 cleanup_hook (pad, hook);
2941 case GST_PAD_PROBE_DROP:
2942 /* need to drop the data, make sure other probes don't get called
2944 GST_DEBUG_OBJECT (pad, "asked to drop item");
2945 info->type = GST_PAD_PROBE_TYPE_INVALID;
2946 data->dropped = TRUE;
2948 case GST_PAD_PROBE_PASS:
2949 /* inform the pad block to let things pass */
2950 GST_DEBUG_OBJECT (pad, "asked to pass item");
2954 GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
2961 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2962 "hook %lu, cookie %u with flags 0x%08x does not match %08x",
2963 hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
2968 /* a probe that does not take or return any data */
2969 #define PROBE_NO_DATA(pad,mask,label,defaultval) \
2971 if (G_UNLIKELY (pad->num_probes)) { \
2972 /* pass NULL as the data item */ \
2973 GstPadProbeInfo info = { mask, 0, NULL, 0, 0 }; \
2974 ret = do_probe_callbacks (pad, &info, defaultval); \
2975 if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
2980 #define PROBE_FULL(pad,mask,data,offs,size,label) \
2982 if (G_UNLIKELY (pad->num_probes)) { \
2983 /* pass the data item */ \
2984 GstPadProbeInfo info = { mask, 0, data, offs, size }; \
2985 ret = do_probe_callbacks (pad, &info, GST_FLOW_OK); \
2986 /* store the possibly updated data item */ \
2987 data = GST_PAD_PROBE_INFO_DATA (&info); \
2988 /* if something went wrong, exit */ \
2989 if (G_UNLIKELY (ret != GST_FLOW_OK)) \
2994 #define PROBE_PUSH(pad,mask,data,label) \
2995 PROBE_FULL(pad, mask, data, -1, -1, label);
2996 #define PROBE_PULL(pad,mask,data,offs,size,label) \
2997 PROBE_FULL(pad, mask, data, offs, size, label);
2999 static GstFlowReturn
3000 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3001 GstFlowReturn defaultval)
3010 data.marshalled = FALSE;
3011 data.dropped = FALSE;
3012 data.cookie = ++pad->priv->probe_cookie;
3015 (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3018 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3019 "do probes cookie %u", data.cookie);
3020 cookie = pad->priv->probe_list_cookie;
3022 g_hook_list_marshal (&pad->probes, TRUE,
3023 (GHookMarshaller) probe_hook_marshal, &data);
3025 /* if the list changed, call the new callbacks (they will not have their
3026 * cookie set to data.cookie */
3027 if (cookie != pad->priv->probe_list_cookie) {
3028 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3029 "probe list changed, restarting");
3033 /* the first item that dropped will stop the hooks and then we drop here */
3037 /* if no handler matched and we are blocking, let the item pass */
3038 if (!data.marshalled && is_block)
3041 /* At this point, all handlers returned either OK or PASS. If one handler
3042 * returned PASS, let the item pass */
3047 while (GST_PAD_IS_BLOCKED (pad)) {
3048 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3049 "we are blocked %d times", pad->num_blocked);
3051 /* we might have released the lock */
3052 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3055 /* now we block the streaming thread. It can be unlocked when we
3056 * deactivate the pad (which will also set the FLUSHING flag) or
3057 * when the pad is unblocked. A flushing event will also unblock
3058 * the pad after setting the FLUSHING flag. */
3059 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3060 "Waiting to be unblocked or set flushing");
3061 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3062 GST_PAD_BLOCK_WAIT (pad);
3063 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3064 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3066 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3076 GST_DEBUG_OBJECT (pad, "pad is flushing");
3077 return GST_FLOW_FLUSHING;
3081 GST_DEBUG_OBJECT (pad, "data is dropped");
3082 return GST_FLOW_CUSTOM_SUCCESS;
3086 /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3087 GST_DEBUG_OBJECT (pad, "data is passed");
3095 * gst_pad_get_offset:
3098 * Get the offset applied to the running time of @pad. @pad has to be a source
3101 * Returns: the offset.
3104 gst_pad_get_offset (GstPad * pad)
3108 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3110 GST_OBJECT_LOCK (pad);
3111 result = pad->offset;
3112 GST_OBJECT_UNLOCK (pad);
3118 * gst_pad_set_offset:
3120 * @offset: the offset
3122 * Set the offset that will be applied to the running time of @pad.
3125 gst_pad_set_offset (GstPad * pad, gint64 offset)
3129 g_return_if_fail (GST_IS_PAD (pad));
3131 GST_OBJECT_LOCK (pad);
3132 /* if nothing changed, do nothing */
3133 if (pad->offset == offset)
3136 pad->offset = offset;
3137 GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3139 /* sinkpads will apply their offset the next time a segment
3140 * event is received. */
3141 if (GST_PAD_IS_SINK (pad))
3144 /* resend the last segment event on next buffer push */
3145 if ((ev = find_event_by_type (pad, GST_EVENT_SEGMENT, 0))) {
3146 ev->received = FALSE;
3147 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3151 GST_OBJECT_UNLOCK (pad);
3158 /* If TRUE and ret is not OK this means
3159 * that pushing the EOS event failed
3164 /* should be called with pad LOCK */
3166 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3168 PushStickyData *data = user_data;
3169 GstEvent *event = ev->event;
3172 GST_DEBUG_OBJECT (pad, "event %s was already received",
3173 GST_EVENT_TYPE_NAME (event));
3177 data->ret = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3178 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3180 switch (data->ret) {
3182 ev->received = TRUE;
3183 GST_DEBUG_OBJECT (pad, "event %s marked received",
3184 GST_EVENT_TYPE_NAME (event));
3186 case GST_FLOW_NOT_LINKED:
3187 /* not linked is not a problem, we are sticky so the event will be
3189 GST_DEBUG_OBJECT (pad, "pad was not linked");
3190 data->ret = GST_FLOW_OK;
3193 GST_DEBUG_OBJECT (pad, "mark pending events");
3194 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3198 if (data->ret != GST_FLOW_OK && GST_EVENT_TYPE (event) == GST_EVENT_EOS)
3199 data->was_eos = TRUE;
3201 return data->ret == GST_FLOW_OK;
3204 /* check sticky events and push them when needed. should be called
3206 static inline GstFlowReturn
3207 check_sticky (GstPad * pad)
3209 PushStickyData data = { GST_FLOW_OK, FALSE };
3211 if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3212 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3214 GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3215 events_foreach (pad, push_sticky, &data);
3217 /* If there's an EOS event we must push it downstream
3218 * even if sending a previous sticky event failed.
3219 * Otherwise the pipeline might wait forever for EOS.
3221 * Only do this if pushing another event than the EOS
3224 if (data.ret != GST_FLOW_OK && !data.was_eos) {
3225 GArray *events = pad->priv->events;
3229 for (i = 0; i < len; i++) {
3230 PadEvent *ev = &g_array_index (events, PadEvent, i);
3232 if (G_UNLIKELY (ev->event == NULL) || ev->received)
3235 if (GST_EVENT_TYPE (ev->event) == GST_EVENT_EOS) {
3236 gst_pad_push_event_unchecked (pad, gst_event_ref (ev->event),
3237 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3250 * @pad: a #GstPad to invoke the default query on.
3251 * @query: (transfer none): the #GstQuery to perform.
3253 * Dispatches a query to a pad. The query should have been allocated by the
3254 * caller via one of the type-specific allocation functions. The element that
3255 * the pad belongs to is responsible for filling the query with an appropriate
3256 * response, which should then be parsed with a type-specific query parsing
3259 * Again, the caller is responsible for both the allocation and deallocation of
3260 * the query structure.
3262 * Please also note that some queries might need a running pipeline to work.
3264 * Returns: TRUE if the query could be performed.
3267 gst_pad_query (GstPad * pad, GstQuery * query)
3270 gboolean res, serialized;
3271 GstPadQueryFunction func;
3272 GstPadProbeType type;
3275 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3276 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3278 if (GST_PAD_IS_SRC (pad)) {
3279 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3280 goto wrong_direction;
3281 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3282 } else if (GST_PAD_IS_SINK (pad)) {
3283 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3284 goto wrong_direction;
3285 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3287 goto unknown_direction;
3289 GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3290 GST_QUERY_TYPE_NAME (query));
3292 serialized = GST_QUERY_IS_SERIALIZED (query);
3293 if (G_UNLIKELY (serialized))
3294 GST_PAD_STREAM_LOCK (pad);
3296 GST_OBJECT_LOCK (pad);
3297 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3298 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3299 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3301 ACQUIRE_PARENT (pad, parent, no_parent);
3302 GST_OBJECT_UNLOCK (pad);
3304 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3307 res = func (pad, parent, query);
3309 RELEASE_PARENT (parent);
3311 GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3312 GST_QUERY_TYPE_NAME (query), res);
3317 GST_OBJECT_LOCK (pad);
3318 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3319 GST_OBJECT_UNLOCK (pad);
3321 if (G_UNLIKELY (serialized))
3322 GST_PAD_STREAM_UNLOCK (pad);
3329 g_warning ("pad %s:%s query %s in wrong direction",
3330 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3335 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3340 GST_DEBUG_OBJECT (pad, "had no parent");
3341 GST_OBJECT_UNLOCK (pad);
3342 if (G_UNLIKELY (serialized))
3343 GST_PAD_STREAM_UNLOCK (pad);
3348 GST_DEBUG_OBJECT (pad, "had no query function");
3349 RELEASE_PARENT (parent);
3350 if (G_UNLIKELY (serialized))
3351 GST_PAD_STREAM_UNLOCK (pad);
3356 GST_DEBUG_OBJECT (pad, "query failed");
3357 if (G_UNLIKELY (serialized))
3358 GST_PAD_STREAM_UNLOCK (pad);
3363 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3364 GST_OBJECT_UNLOCK (pad);
3365 if (G_UNLIKELY (serialized))
3366 GST_PAD_STREAM_UNLOCK (pad);
3368 /* if a probe dropped, we don't sent it further but assume that the probe
3369 * answered the query and return TRUE */
3370 if (ret == GST_FLOW_CUSTOM_SUCCESS)
3380 * gst_pad_peer_query:
3381 * @pad: a #GstPad to invoke the peer query on.
3382 * @query: (transfer none): the #GstQuery to perform.
3384 * Performs gst_pad_query() on the peer of @pad.
3386 * The caller is responsible for both the allocation and deallocation of
3387 * the query structure.
3389 * Returns: TRUE if the query could be performed. This function returns %FALSE
3390 * if @pad has no peer.
3395 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3398 GstPadProbeType type;
3399 gboolean res, serialized;
3402 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3403 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3405 if (GST_PAD_IS_SRC (pad)) {
3406 if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3407 goto wrong_direction;
3408 type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3409 } else if (GST_PAD_IS_SINK (pad)) {
3410 if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3411 goto wrong_direction;
3412 type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3414 goto unknown_direction;
3416 GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
3417 GST_QUERY_TYPE_NAME (query));
3419 serialized = GST_QUERY_IS_SERIALIZED (query);
3421 GST_OBJECT_LOCK (pad);
3422 if (GST_PAD_IS_SRC (pad) && serialized) {
3423 /* all serialized queries on the srcpad trigger push of
3425 if (!check_sticky (pad) == GST_FLOW_OK)
3429 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3430 GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3431 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3433 peerpad = GST_PAD_PEER (pad);
3434 if (G_UNLIKELY (peerpad == NULL))
3437 gst_object_ref (peerpad);
3438 GST_OBJECT_UNLOCK (pad);
3440 res = gst_pad_query (peerpad, query);
3442 gst_object_unref (peerpad);
3447 GST_OBJECT_LOCK (pad);
3448 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3449 GST_OBJECT_UNLOCK (pad);
3456 g_warning ("pad %s:%s query %s in wrong direction",
3457 GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3462 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3467 GST_WARNING_OBJECT (pad, "could not send sticky events");
3468 GST_OBJECT_UNLOCK (pad);
3473 GST_WARNING_OBJECT (pad, "pad has no peer");
3474 GST_OBJECT_UNLOCK (pad);
3479 GST_DEBUG_OBJECT (pad, "query failed");
3484 GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3485 GST_OBJECT_UNLOCK (pad);
3487 /* if a probe dropped, we don't sent it further but assume that the probe
3488 * answered the query and return TRUE */
3489 if (ret == GST_FLOW_CUSTOM_SUCCESS)
3498 /**********************************************************************
3499 * Data passing functions
3502 /* this is the chain function that does not perform the additional argument
3503 * checking for that little extra speed.
3505 static inline GstFlowReturn
3506 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
3511 GST_PAD_STREAM_LOCK (pad);
3513 GST_OBJECT_LOCK (pad);
3514 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3517 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3520 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3522 PROBE_PUSH (pad, type, data, probe_stopped);
3524 parent = GST_OBJECT_PARENT (pad);
3525 GST_OBJECT_UNLOCK (pad);
3527 /* NOTE: we read the chainfunc unlocked.
3528 * we cannot hold the lock for the pad so we might send
3529 * the data to the wrong function. This is not really a
3530 * problem since functions are assigned at creation time
3531 * and don't change that often... */
3532 if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
3533 GstPadChainFunction chainfunc;
3535 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3538 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3539 "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
3540 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
3542 ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
3544 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3545 "called chainfunction &%s with buffer %p, returned %s",
3546 GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
3548 GstPadChainListFunction chainlistfunc;
3550 if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
3553 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3554 "calling chainlistfunction &%s",
3555 GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
3557 ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
3559 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3560 "called chainlistfunction &%s, returned %s",
3561 GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
3564 GST_PAD_STREAM_UNLOCK (pad);
3571 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3572 "chaining, but pad was flushing");
3573 GST_OBJECT_UNLOCK (pad);
3574 GST_PAD_STREAM_UNLOCK (pad);
3575 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3576 return GST_FLOW_FLUSHING;
3580 g_critical ("chain on pad %s:%s but it was not in push mode",
3581 GST_DEBUG_PAD_NAME (pad));
3582 GST_OBJECT_UNLOCK (pad);
3583 GST_PAD_STREAM_UNLOCK (pad);
3584 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3585 return GST_FLOW_ERROR;
3589 GST_OBJECT_UNLOCK (pad);
3590 GST_PAD_STREAM_UNLOCK (pad);
3591 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3594 case GST_FLOW_CUSTOM_SUCCESS:
3595 GST_DEBUG_OBJECT (pad, "dropped buffer");
3599 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3606 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3607 g_critical ("chain on pad %s:%s but it has no chainfunction",
3608 GST_DEBUG_PAD_NAME (pad));
3609 GST_PAD_STREAM_UNLOCK (pad);
3610 return GST_FLOW_NOT_SUPPORTED;
3616 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3617 * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
3620 * Chain a buffer to @pad.
3622 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3624 * If the buffer type is not acceptable for @pad (as negotiated with a
3625 * preceeding GST_EVENT_CAPS event), this function returns
3626 * #GST_FLOW_NOT_NEGOTIATED.
3628 * The function proceeds calling the chain function installed on @pad (see
3629 * gst_pad_set_chain_function()) and the return value of that function is
3630 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3633 * In all cases, success or failure, the caller loses its reference to @buffer
3634 * after calling this function.
3636 * Returns: a #GstFlowReturn from the pad.
3641 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
3643 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3644 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3645 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3647 return gst_pad_chain_data_unchecked (pad,
3648 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3651 static GstFlowReturn
3652 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
3653 GstBufferList * list)
3659 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3661 len = gst_buffer_list_length (list);
3664 for (i = 0; i < len; i++) {
3665 buffer = gst_buffer_list_get (list, i);
3667 gst_pad_chain_data_unchecked (pad,
3668 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
3669 gst_buffer_ref (buffer));
3670 if (ret != GST_FLOW_OK)
3673 gst_buffer_list_unref (list);
3679 * gst_pad_chain_list:
3680 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3681 * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
3684 * Chain a bufferlist to @pad.
3686 * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3688 * If @pad was not negotiated properly with a CAPS event, this function
3689 * returns #GST_FLOW_NOT_NEGOTIATED.
3691 * The function proceeds calling the chainlist function installed on @pad (see
3692 * gst_pad_set_chain_list_function()) and the return value of that function is
3693 * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3694 * chainlist function.
3696 * In all cases, success or failure, the caller loses its reference to @list
3697 * after calling this function.
3701 * Returns: a #GstFlowReturn from the pad.
3706 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
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_LIST (list), GST_FLOW_ERROR);
3712 return gst_pad_chain_data_unchecked (pad,
3713 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3716 static GstFlowReturn
3717 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
3722 GST_OBJECT_LOCK (pad);
3723 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3726 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3729 if (G_UNLIKELY ((ret = check_sticky (pad))) != GST_FLOW_OK)
3732 /* do block probes */
3733 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3735 /* do post-blocking probes */
3736 PROBE_PUSH (pad, type, data, probe_stopped);
3738 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3741 /* take ref to peer pad before releasing the lock */
3742 gst_object_ref (peer);
3744 GST_OBJECT_UNLOCK (pad);
3746 ret = gst_pad_chain_data_unchecked (peer, type, data);
3748 gst_object_unref (peer);
3750 GST_OBJECT_LOCK (pad);
3752 if (pad->priv->using == 0) {
3753 /* pad is not active anymore, trigger idle callbacks */
3754 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
3755 probe_stopped, ret);
3757 GST_OBJECT_UNLOCK (pad);
3761 /* ERROR recovery here */
3765 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3766 "pushing, but pad was flushing");
3767 GST_OBJECT_UNLOCK (pad);
3768 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3769 return GST_FLOW_FLUSHING;
3773 g_critical ("pushing on pad %s:%s but it was not activated in push mode",
3774 GST_DEBUG_PAD_NAME (pad));
3775 GST_OBJECT_UNLOCK (pad);
3776 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3777 return GST_FLOW_ERROR;
3781 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3782 "error pushing events, return %s", gst_flow_get_name (ret));
3783 GST_OBJECT_UNLOCK (pad);
3784 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3789 GST_OBJECT_UNLOCK (pad);
3790 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3793 case GST_FLOW_CUSTOM_SUCCESS:
3794 GST_DEBUG_OBJECT (pad, "dropped buffer");
3798 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3805 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3806 "pushing, but it was not linked");
3807 GST_OBJECT_UNLOCK (pad);
3808 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3809 return GST_FLOW_NOT_LINKED;
3815 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3816 * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
3819 * Pushes a buffer to the peer of @pad.
3821 * This function will call installed block probes before triggering any
3822 * installed data probes.
3824 * The function proceeds calling gst_pad_chain() on the peer pad and returns
3825 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3828 * In all cases, success or failure, the caller loses its reference to @buffer
3829 * after calling this function.
3831 * Returns: a #GstFlowReturn from the peer pad.
3836 gst_pad_push (GstPad * pad, GstBuffer * buffer)
3838 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3839 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3840 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3842 return gst_pad_push_data (pad,
3843 GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3847 * gst_pad_push_list:
3848 * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3849 * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
3852 * Pushes a buffer list to the peer of @pad.
3854 * This function will call installed block probes before triggering any
3855 * installed data probes.
3857 * The function proceeds calling the chain function on the peer pad and returns
3858 * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3859 * be returned. If the peer pad does not have any installed chainlist function
3860 * every group buffer of the list will be merged into a normal #GstBuffer and
3861 * chained via gst_pad_chain().
3863 * In all cases, success or failure, the caller loses its reference to @list
3864 * after calling this function.
3866 * Returns: a #GstFlowReturn from the peer pad.
3873 gst_pad_push_list (GstPad * pad, GstBufferList * list)
3875 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3876 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3877 g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3879 return gst_pad_push_data (pad,
3880 GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3883 static GstFlowReturn
3884 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
3885 GstBuffer ** buffer)
3888 GstPadGetRangeFunction getrangefunc;
3892 GST_PAD_STREAM_LOCK (pad);
3894 GST_OBJECT_LOCK (pad);
3895 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3898 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
3901 if (G_UNLIKELY ((ret = check_sticky (pad))) != GST_FLOW_OK)
3906 /* when one of the probes returns DROPPED, probe_stopped will be called
3907 * and we skip calling the getrange function, res_buf should then contain a
3908 * valid result buffer */
3909 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
3910 res_buf, offset, size, probe_stopped);
3912 ACQUIRE_PARENT (pad, parent, no_parent);
3913 GST_OBJECT_UNLOCK (pad);
3915 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
3918 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3919 "calling getrangefunc %s, offset %"
3920 G_GUINT64_FORMAT ", size %u",
3921 GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
3923 ret = getrangefunc (pad, parent, offset, size, &res_buf);
3925 RELEASE_PARENT (parent);
3927 if (G_UNLIKELY (ret != GST_FLOW_OK))
3928 goto get_range_failed;
3930 /* can only fire the signal if we have a valid buffer */
3931 GST_OBJECT_LOCK (pad);
3933 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
3934 res_buf, offset, size, probe_stopped_unref);
3935 GST_OBJECT_UNLOCK (pad);
3937 GST_PAD_STREAM_UNLOCK (pad);
3946 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3947 "getrange, but pad was flushing");
3948 GST_OBJECT_UNLOCK (pad);
3949 GST_PAD_STREAM_UNLOCK (pad);
3950 return GST_FLOW_FLUSHING;
3954 g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
3955 GST_DEBUG_PAD_NAME (pad));
3956 GST_OBJECT_UNLOCK (pad);
3957 GST_PAD_STREAM_UNLOCK (pad);
3958 return GST_FLOW_ERROR;
3962 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
3963 GST_OBJECT_UNLOCK (pad);
3964 GST_PAD_STREAM_UNLOCK (pad);
3969 GST_DEBUG_OBJECT (pad, "no parent");
3970 GST_OBJECT_UNLOCK (pad);
3971 GST_PAD_STREAM_UNLOCK (pad);
3972 return GST_FLOW_FLUSHING;
3976 g_critical ("getrange on pad %s:%s but it has no getrangefunction",
3977 GST_DEBUG_PAD_NAME (pad));
3978 RELEASE_PARENT (parent);
3979 GST_PAD_STREAM_UNLOCK (pad);
3980 return GST_FLOW_NOT_SUPPORTED;
3984 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3985 "probe returned %s", gst_flow_get_name (ret));
3986 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
3988 /* the probe filled the buffer and asks us to not call the getrange
3989 * anymore, we continue with the post probes then. */
3990 GST_DEBUG_OBJECT (pad, "handled buffer");
3994 /* no buffer, we are EOS */
3995 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
3999 GST_OBJECT_UNLOCK (pad);
4000 GST_PAD_STREAM_UNLOCK (pad);
4004 probe_stopped_unref:
4006 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4007 "probe returned %s", gst_flow_get_name (ret));
4008 /* if we drop here, it signals EOS */
4009 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4011 GST_OBJECT_UNLOCK (pad);
4012 GST_PAD_STREAM_UNLOCK (pad);
4013 if (*buffer == NULL)
4014 gst_buffer_unref (res_buf);
4019 GST_PAD_STREAM_UNLOCK (pad);
4020 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4021 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4022 pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
4028 * gst_pad_get_range:
4029 * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
4030 * @offset: The start offset of the buffer
4031 * @size: The length of the buffer
4032 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
4033 * returns #GST_FLOW_ERROR if %NULL.
4035 * When @pad is flushing this function returns #GST_FLOW_FLUSHING
4036 * immediately and @buffer is %NULL.
4038 * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
4039 * description of a getrange function. If @pad has no getrange function
4040 * installed (see gst_pad_set_getrange_function()) this function returns
4041 * #GST_FLOW_NOT_SUPPORTED.
4043 * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be
4044 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4045 * must be freed with gst_buffer_unref() after usage.
4047 * When @buffer points to a variable that points to a valid #GstBuffer, the
4048 * buffer will be filled with the result data when this function returns
4049 * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4050 * @size bytes will be filled in the result buffer and its size will be updated
4053 * Note that less than @size bytes can be returned in @buffer when, for example,
4054 * an EOS condition is near or when @buffer is not large enough to hold @size
4055 * bytes. The caller should check the result buffer size to get the result size.
4057 * When this function returns any other result value than #GST_FLOW_OK, @buffer
4058 * will be unchanged.
4060 * This is a lowlevel function. Usualy gst_pad_pull_range() is used.
4062 * Returns: a #GstFlowReturn from the pad.
4067 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4068 GstBuffer ** buffer)
4070 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4071 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4072 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4073 g_return_val_if_fail (*buffer == NULL
4074 || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4076 return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4080 * gst_pad_pull_range:
4081 * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4082 * @offset: The start offset of the buffer
4083 * @size: The length of the buffer
4084 * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4085 * GST_FLOW_ERROR if %NULL.
4087 * Pulls a @buffer from the peer pad or fills up a provided buffer.
4089 * This function will first trigger the pad block signal if it was
4092 * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4093 * function returns the result of gst_pad_get_range() on the peer pad.
4094 * See gst_pad_get_range() for a list of return values and for the
4095 * semantics of the arguments of this function.
4097 * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be
4098 * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4099 * must be freed with gst_buffer_unref() after usage. When this function
4100 * returns any other result value, @buffer will still point to NULL.
4102 * When @buffer points to a variable that points to a valid #GstBuffer, the
4103 * buffer will be filled with the result data when this function returns
4104 * #GST_FLOW_OK. When this function returns any other result value,
4105 * @buffer will be unchanged. If the provided buffer is larger than @size, only
4106 * @size bytes will be filled in the result buffer and its size will be updated
4109 * Note that less than @size bytes can be returned in @buffer when, for example,
4110 * an EOS condition is near or when @buffer is not large enough to hold @size
4111 * bytes. The caller should check the result buffer size to get the result size.
4113 * Returns: a #GstFlowReturn from the peer pad.
4118 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4119 GstBuffer ** buffer)
4125 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4126 g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4127 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4128 g_return_val_if_fail (*buffer == NULL
4129 || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4131 GST_OBJECT_LOCK (pad);
4132 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4135 if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4140 /* when one of the probes returns DROPPED, probe_stopped will be
4141 * called and we skip calling the peer getrange function. *buffer should then
4142 * contain a valid buffer */
4143 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4144 res_buf, offset, size, probe_stopped);
4146 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4149 gst_object_ref (peer);
4151 GST_OBJECT_UNLOCK (pad);
4153 ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4155 gst_object_unref (peer);
4157 GST_OBJECT_LOCK (pad);
4159 if (pad->priv->using == 0) {
4160 /* pad is not active anymore, trigger idle callbacks */
4161 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4162 probe_stopped_unref, ret);
4165 if (G_UNLIKELY (ret != GST_FLOW_OK))
4166 goto pull_range_failed;
4169 PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4170 res_buf, offset, size, probe_stopped_unref);
4172 GST_OBJECT_UNLOCK (pad);
4178 /* ERROR recovery here */
4181 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4182 "pullrange, but pad was flushing");
4183 GST_OBJECT_UNLOCK (pad);
4184 return GST_FLOW_FLUSHING;
4188 g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4189 GST_DEBUG_PAD_NAME (pad));
4190 GST_OBJECT_UNLOCK (pad);
4191 return GST_FLOW_ERROR;
4195 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4196 gst_flow_get_name (ret));
4197 if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4199 /* the probe filled the buffer and asks us to not forward to the peer
4200 * anymore, we continue with the post probes then */
4201 GST_DEBUG_OBJECT (pad, "handled buffer");
4205 /* no buffer, we are EOS then */
4206 GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4210 GST_OBJECT_UNLOCK (pad);
4215 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4216 "pulling range, but it was not linked");
4217 GST_OBJECT_UNLOCK (pad);
4218 return GST_FLOW_NOT_LINKED;
4222 GST_OBJECT_UNLOCK (pad);
4223 GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4224 (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4225 pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4228 probe_stopped_unref:
4230 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4231 "post probe returned %s", gst_flow_get_name (ret));
4232 GST_OBJECT_UNLOCK (pad);
4233 /* if we drop here, it signals EOS */
4234 if (ret == GST_FLOW_CUSTOM_SUCCESS)
4236 if (*buffer == NULL)
4237 gst_buffer_unref (res_buf);
4243 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event, gboolean locked)
4248 gboolean res = FALSE;
4249 const gchar *name = NULL;
4251 type = GST_EVENT_TYPE (event);
4252 if (type & GST_EVENT_TYPE_STICKY_MULTI)
4253 name = gst_structure_get_name (gst_event_get_structure (event));
4255 events = pad->priv->events;
4258 for (i = 0; i < len; i++) {
4259 PadEvent *ev = &g_array_index (events, PadEvent, i);
4261 if (ev->event == NULL)
4264 if (type == GST_EVENT_TYPE (ev->event)) {
4265 /* matching types, check matching name if needed */
4266 if (name && !gst_event_has_name (ev->event, name))
4270 if ((res = gst_event_replace (&ev->event, event)))
4271 ev->received = FALSE;
4277 ev.event = gst_event_ref (event);
4278 ev.received = FALSE;
4279 g_array_append_val (events, ev);
4284 pad->priv->events_cookie++;
4285 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4287 GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
4289 switch (GST_EVENT_TYPE (event)) {
4290 case GST_EVENT_CAPS:
4292 GST_OBJECT_UNLOCK (pad);
4294 GST_DEBUG_OBJECT (pad, "notify caps");
4295 g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
4298 GST_OBJECT_LOCK (pad);
4307 /* should be called with pad LOCK */
4308 static GstFlowReturn
4309 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
4310 GstPadProbeType type)
4314 GstEventType event_type;
4316 /* Two checks to be made:
4317 * . (un)set the FLUSHING flag for flushing events,
4318 * . handle pad blocking */
4319 event_type = GST_EVENT_TYPE (event);
4320 switch (event_type) {
4321 case GST_EVENT_FLUSH_START:
4322 GST_PAD_SET_FLUSHING (pad);
4324 GST_PAD_BLOCK_BROADCAST (pad);
4325 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4327 case GST_EVENT_FLUSH_STOP:
4328 GST_PAD_UNSET_FLUSHING (pad);
4330 /* Remove sticky EOS events */
4331 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4332 remove_event_by_type (pad, GST_EVENT_EOS);
4334 type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4338 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4341 switch (GST_EVENT_TYPE (event)) {
4342 case GST_EVENT_SEGMENT:
4343 /* pass the adjusted segment event on. We need to do this even if
4344 * there is no peer pad because of the probes. */
4345 event = apply_pad_offset (pad, event);
4347 case GST_EVENT_RECONFIGURE:
4348 if (GST_PAD_IS_SINK (pad))
4349 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4354 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4355 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4360 /* send probes after modifying the events above */
4361 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4363 /* now check the peer pad */
4364 peerpad = GST_PAD_PEER (pad);
4365 if (peerpad == NULL)
4368 gst_object_ref (peerpad);
4370 GST_OBJECT_UNLOCK (pad);
4372 GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
4373 event, GST_EVENT_TYPE_NAME (event), peerpad);
4375 ret = gst_pad_send_event_unchecked (peerpad, event, type);
4377 /* Note: we gave away ownership of the event at this point but we can still
4378 * print the old pointer */
4379 GST_LOG_OBJECT (pad,
4380 "sent event %p to peerpad %" GST_PTR_FORMAT ", ret %s", event, peerpad,
4381 gst_flow_get_name (ret));
4383 gst_object_unref (peerpad);
4385 GST_OBJECT_LOCK (pad);
4387 if (pad->priv->using == 0) {
4388 /* pad is not active anymore, trigger idle callbacks */
4389 PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4390 idle_probe_stopped, ret);
4394 /* ERROR handling */
4397 GST_DEBUG_OBJECT (pad, "We're flushing");
4398 gst_event_unref (event);
4399 return GST_FLOW_FLUSHING;
4403 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4404 gst_event_unref (event);
4407 case GST_FLOW_CUSTOM_SUCCESS:
4408 GST_DEBUG_OBJECT (pad, "dropped event");
4412 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4419 GST_DEBUG_OBJECT (pad, "Dropping event because pad is not linked");
4420 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4421 gst_event_unref (event);
4422 return GST_FLOW_NOT_LINKED;
4426 GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
4432 * gst_pad_push_event:
4433 * @pad: a #GstPad to push the event to.
4434 * @event: (transfer full): the #GstEvent to send to the pad.
4436 * Sends the event to the peer of the given pad. This function is
4437 * mainly used by elements to send events to their peer
4440 * This function takes owership of the provided event so you should
4441 * gst_event_ref() it if you want to reuse the event after this call.
4443 * Returns: TRUE if the event was handled.
4448 gst_pad_push_event (GstPad * pad, GstEvent * event)
4451 GstPadProbeType type;
4452 gboolean sticky, serialized;
4454 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4455 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4457 if (GST_PAD_IS_SRC (pad)) {
4458 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4459 goto wrong_direction;
4460 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4461 } else if (GST_PAD_IS_SINK (pad)) {
4462 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4463 goto wrong_direction;
4464 /* events pushed on sinkpad never are sticky */
4465 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4467 goto unknown_direction;
4469 GST_OBJECT_LOCK (pad);
4470 sticky = GST_EVENT_IS_STICKY (event);
4471 serialized = GST_EVENT_IS_SERIALIZED (event);
4474 /* can't store on flushing pads */
4475 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4478 /* srcpad sticky events are store immediately, the received flag is set
4479 * to FALSE and will be set to TRUE when we can successfully push the
4480 * event to the peer pad */
4481 if (gst_pad_store_sticky_event (pad, event, TRUE)) {
4482 GST_DEBUG_OBJECT (pad, "event %s updated", GST_EVENT_TYPE_NAME (event));
4485 if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
4486 /* all serialized or sticky events on the srcpad trigger push of
4488 res = (check_sticky (pad) == GST_FLOW_OK);
4491 /* other events are pushed right away */
4492 res = (gst_pad_push_event_unchecked (pad, event, type) == GST_FLOW_OK);
4494 gst_event_unref (event);
4497 GST_OBJECT_UNLOCK (pad);
4501 /* ERROR handling */
4504 g_warning ("pad %s:%s pushing %s event in wrong direction",
4505 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4506 gst_event_unref (event);
4511 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4512 gst_event_unref (event);
4517 GST_DEBUG_OBJECT (pad, "We're flushing");
4518 GST_OBJECT_UNLOCK (pad);
4519 gst_event_unref (event);
4524 /* Check if we can call the event function with the given event */
4525 static GstFlowReturn
4526 pre_eventfunc_check (GstPad * pad, GstEvent * event)
4528 GstCaps *caps, *templ;
4530 switch (GST_EVENT_TYPE (event)) {
4531 case GST_EVENT_CAPS:
4533 /* backwards compatibility mode for caps */
4534 gst_event_parse_caps (event, &caps);
4536 /* See if pad accepts the caps */
4537 templ = gst_pad_get_pad_template_caps (pad);
4538 if (!gst_caps_is_subset (caps, templ))
4541 gst_caps_unref (templ);
4552 gst_caps_unref (templ);
4553 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
4554 "caps %" GST_PTR_FORMAT " not accepted", caps);
4555 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
4556 "no intersection with template %" GST_PTR_FORMAT, templ);
4557 return GST_FLOW_NOT_NEGOTIATED;
4561 static GstFlowReturn
4562 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
4563 GstPadProbeType type)
4566 GstEventType event_type;
4567 gboolean serialized, need_unlock = FALSE, sticky;
4568 GstPadEventFunction eventfunc;
4571 GST_OBJECT_LOCK (pad);
4572 if (GST_PAD_IS_SINK (pad))
4573 serialized = GST_EVENT_IS_SERIALIZED (event);
4576 sticky = GST_EVENT_IS_STICKY (event);
4577 event_type = GST_EVENT_TYPE (event);
4578 switch (event_type) {
4579 case GST_EVENT_FLUSH_START:
4580 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4581 "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
4583 /* can't even accept a flush begin event when flushing */
4584 if (GST_PAD_IS_FLUSHING (pad))
4587 GST_PAD_SET_FLUSHING (pad);
4588 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
4590 case GST_EVENT_FLUSH_STOP:
4591 if (G_LIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_NONE)) {
4592 GST_PAD_UNSET_FLUSHING (pad);
4593 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
4595 /* Remove pending EOS events */
4596 GST_LOG_OBJECT (pad, "Removing pending EOS events");
4597 remove_event_by_type (pad, GST_EVENT_EOS);
4599 GST_OBJECT_UNLOCK (pad);
4600 /* grab stream lock */
4601 GST_PAD_STREAM_LOCK (pad);
4603 GST_OBJECT_LOCK (pad);
4604 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4607 case GST_EVENT_RECONFIGURE:
4608 if (GST_PAD_IS_SRC (pad))
4609 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4611 GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4612 "have event type %" GST_PTR_FORMAT, event);
4614 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4618 /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
4619 GST_OBJECT_UNLOCK (pad);
4620 GST_PAD_STREAM_LOCK (pad);
4622 GST_OBJECT_LOCK (pad);
4623 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4627 switch (GST_EVENT_TYPE (event)) {
4628 case GST_EVENT_SEGMENT:
4629 event = apply_pad_offset (pad, event);
4635 /* now do the probe */
4637 type | GST_PAD_PROBE_TYPE_PUSH |
4638 GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4640 PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4644 if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
4647 ACQUIRE_PARENT (pad, parent, no_parent);
4648 GST_OBJECT_UNLOCK (pad);
4650 ret = pre_eventfunc_check (pad, event);
4651 if (G_UNLIKELY (ret != GST_FLOW_OK))
4652 goto precheck_failed;
4655 gst_event_ref (event);
4657 if (eventfunc (pad, parent, event)) {
4660 /* something went wrong */
4661 switch (event_type) {
4662 case GST_EVENT_CAPS:
4663 ret = GST_FLOW_NOT_NEGOTIATED;
4666 ret = GST_FLOW_ERROR;
4670 RELEASE_PARENT (parent);
4672 GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
4675 if (ret == GST_FLOW_OK) {
4676 /* after the event function accepted the event, we can store the sticky
4677 * event on the pad */
4678 gst_pad_store_sticky_event (pad, event, FALSE);
4680 gst_event_unref (event);
4684 GST_PAD_STREAM_UNLOCK (pad);
4688 /* ERROR handling */
4691 GST_OBJECT_UNLOCK (pad);
4693 GST_PAD_STREAM_UNLOCK (pad);
4694 GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
4695 "Received event on flushing pad. Discarding");
4696 gst_event_unref (event);
4697 return GST_FLOW_FLUSHING;
4701 GST_OBJECT_UNLOCK (pad);
4703 GST_PAD_STREAM_UNLOCK (pad);
4704 gst_event_unref (event);
4707 case GST_FLOW_CUSTOM_SUCCESS:
4708 GST_DEBUG_OBJECT (pad, "dropped event");
4712 GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4719 g_warning ("pad %s:%s has no event handler, file a bug.",
4720 GST_DEBUG_PAD_NAME (pad));
4721 GST_OBJECT_UNLOCK (pad);
4723 GST_PAD_STREAM_UNLOCK (pad);
4724 gst_event_unref (event);
4725 return GST_FLOW_NOT_SUPPORTED;
4729 GST_DEBUG_OBJECT (pad, "no parent");
4730 GST_OBJECT_UNLOCK (pad);
4732 GST_PAD_STREAM_UNLOCK (pad);
4733 gst_event_unref (event);
4734 return GST_FLOW_FLUSHING;
4738 GST_DEBUG_OBJECT (pad, "pre event check failed");
4739 RELEASE_PARENT (parent);
4741 GST_PAD_STREAM_UNLOCK (pad);
4742 gst_event_unref (event);
4748 * gst_pad_send_event:
4749 * @pad: a #GstPad to send the event to.
4750 * @event: (transfer full): the #GstEvent to send to the pad.
4752 * Sends the event to the pad. This function can be used
4753 * by applications to send events in the pipeline.
4755 * If @pad is a source pad, @event should be an upstream event. If @pad is a
4756 * sink pad, @event should be a downstream event. For example, you would not
4757 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
4758 * Furthermore, some downstream events have to be serialized with data flow,
4759 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
4760 * the event needs to be serialized with data flow, this function will take the
4761 * pad's stream lock while calling its event function.
4763 * To find out whether an event type is upstream, downstream, or downstream and
4764 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
4765 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
4766 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
4767 * plugin doesn't need to bother itself with this information; the core handles
4768 * all necessary locks and checks.
4770 * This function takes owership of the provided event so you should
4771 * gst_event_ref() it if you want to reuse the event after this call.
4773 * Returns: TRUE if the event was handled.
4776 gst_pad_send_event (GstPad * pad, GstEvent * event)
4779 GstPadProbeType type;
4781 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4782 g_return_val_if_fail (event != NULL, FALSE);
4784 if (GST_PAD_IS_SINK (pad)) {
4785 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4786 goto wrong_direction;
4787 type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4788 } else if (GST_PAD_IS_SRC (pad)) {
4789 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4790 goto wrong_direction;
4791 type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4793 goto unknown_direction;
4795 if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
4802 /* ERROR handling */
4805 g_warning ("pad %s:%s sending %s event in wrong direction",
4806 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4807 gst_event_unref (event);
4812 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4813 gst_event_unref (event);
4819 * gst_pad_set_element_private:
4820 * @pad: the #GstPad to set the private data of.
4821 * @priv: The private data to attach to the pad.
4823 * Set the given private data gpointer on the pad.
4824 * This function can only be used by the element that owns the pad.
4825 * No locking is performed in this function.
4828 gst_pad_set_element_private (GstPad * pad, gpointer priv)
4830 pad->element_private = priv;
4834 * gst_pad_get_element_private:
4835 * @pad: the #GstPad to get the private data of.
4837 * Gets the private data of a pad.
4838 * No locking is performed in this function.
4840 * Returns: (transfer none): a #gpointer to the private data.
4843 gst_pad_get_element_private (GstPad * pad)
4845 return pad->element_private;
4849 * gst_pad_get_sticky_event:
4850 * @pad: the #GstPad to get the event from.
4851 * @event_type: the #GstEventType that should be retrieved.
4852 * @idx: the index of the event
4854 * Returns a new reference of the sticky event of type @event_type
4857 * Returns: (transfer full): a #GstEvent of type @event_type or NULL when no
4858 * event of @event_type was on @pad. Unref after usage.
4861 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
4863 GstEvent *event = NULL;
4866 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
4867 g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
4869 GST_OBJECT_LOCK (pad);
4870 ev = find_event_by_type (pad, event_type, idx);
4871 if (ev && (event = ev->event))
4872 gst_event_ref (event);
4873 GST_OBJECT_UNLOCK (pad);
4880 GstPadStickyEventsForeachFunction func;
4885 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
4887 ForeachDispatch *data = user_data;
4890 GST_OBJECT_UNLOCK (pad);
4892 ret = data->func (pad, &ev->event, data->user_data);
4894 GST_OBJECT_LOCK (pad);
4900 * gst_pad_sticky_events_foreach:
4901 * @pad: the #GstPad that should be used for iteration.
4902 * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
4903 * should be called for every event.
4904 * @user_data: (closure): the optional user data.
4906 * Iterates all sticky events on @pad and calls @foreach_func for every
4907 * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
4910 gst_pad_sticky_events_foreach (GstPad * pad,
4911 GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
4913 ForeachDispatch data;
4915 g_return_if_fail (GST_IS_PAD (pad));
4916 g_return_if_fail (foreach_func != NULL);
4918 data.func = foreach_func;
4919 data.user_data = user_data;
4921 GST_OBJECT_LOCK (pad);
4922 events_foreach (pad, foreach_dispatch_function, &data);
4923 GST_OBJECT_UNLOCK (pad);
4927 do_stream_status (GstPad * pad, GstStreamStatusType type,
4928 GThread * thread, GstTask * task)
4932 GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
4934 if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
4935 if (GST_IS_ELEMENT (parent)) {
4936 GstMessage *message;
4937 GValue value = { 0 };
4939 if (type == GST_STREAM_STATUS_TYPE_ENTER) {
4940 gchar *tname, *ename, *pname;
4942 /* create a good task name */
4943 ename = gst_element_get_name (parent);
4944 pname = gst_pad_get_name (pad);
4945 tname = g_strdup_printf ("%s:%s", ename, pname);
4949 gst_object_set_name (GST_OBJECT_CAST (task), tname);
4953 message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
4956 g_value_init (&value, GST_TYPE_TASK);
4957 g_value_set_object (&value, task);
4958 gst_message_set_stream_status_object (message, &value);
4959 g_value_unset (&value);
4961 GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
4962 gst_element_post_message (parent, message);
4964 gst_object_unref (parent);
4969 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
4971 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
4976 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
4978 do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
4982 static GstTaskThreadCallbacks thr_callbacks = {
4988 * gst_pad_start_task:
4989 * @pad: the #GstPad to start the task of
4990 * @func: the task function to call
4991 * @data: data passed to the task function
4993 * Starts a task that repeatedly calls @func with @data. This function
4994 * is mostly used in pad activation functions to start the dataflow.
4995 * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
4996 * before @func is called.
4998 * Returns: a %TRUE if the task could be started.
5001 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer data)
5006 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5007 g_return_val_if_fail (func != NULL, FALSE);
5009 GST_DEBUG_OBJECT (pad, "start task");
5011 GST_OBJECT_LOCK (pad);
5012 task = GST_PAD_TASK (pad);
5014 task = gst_task_new (func, data);
5015 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
5016 gst_task_set_thread_callbacks (task, &thr_callbacks, pad, NULL);
5017 GST_INFO_OBJECT (pad, "created task %p", task);
5018 GST_PAD_TASK (pad) = task;
5019 gst_object_ref (task);
5020 /* release lock to post the message */
5021 GST_OBJECT_UNLOCK (pad);
5023 do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
5025 gst_object_unref (task);
5027 GST_OBJECT_LOCK (pad);
5028 /* nobody else is supposed to have changed the pad now */
5029 if (GST_PAD_TASK (pad) != task)
5030 goto concurrent_stop;
5032 res = gst_task_set_state (task, GST_TASK_STARTED);
5033 GST_OBJECT_UNLOCK (pad);
5040 GST_OBJECT_UNLOCK (pad);
5046 * gst_pad_pause_task:
5047 * @pad: the #GstPad to pause the task of
5049 * Pause the task of @pad. This function will also wait until the
5050 * function executed by the task is finished if this function is not
5051 * called from the task function.
5053 * Returns: a TRUE if the task could be paused or FALSE when the pad
5057 gst_pad_pause_task (GstPad * pad)
5062 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5064 GST_DEBUG_OBJECT (pad, "pause task");
5066 GST_OBJECT_LOCK (pad);
5067 task = GST_PAD_TASK (pad);
5070 res = gst_task_set_state (task, GST_TASK_PAUSED);
5071 GST_OBJECT_UNLOCK (pad);
5073 /* wait for task function to finish, this lock is recursive so it does nothing
5074 * when the pause is called from the task itself */
5075 GST_PAD_STREAM_LOCK (pad);
5076 GST_PAD_STREAM_UNLOCK (pad);
5082 GST_DEBUG_OBJECT (pad, "pad has no task");
5083 GST_OBJECT_UNLOCK (pad);
5089 * gst_pad_stop_task:
5090 * @pad: the #GstPad to stop the task of
5092 * Stop the task of @pad. This function will also make sure that the
5093 * function executed by the task will effectively stop if not called
5094 * from the GstTaskFunction.
5096 * This function will deadlock if called from the GstTaskFunction of
5097 * the task. Use gst_task_pause() instead.
5099 * Regardless of whether the pad has a task, the stream lock is acquired and
5100 * released so as to ensure that streaming through this pad has finished.
5102 * Returns: a TRUE if the task could be stopped or FALSE on error.
5105 gst_pad_stop_task (GstPad * pad)
5110 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5112 GST_DEBUG_OBJECT (pad, "stop task");
5114 GST_OBJECT_LOCK (pad);
5115 task = GST_PAD_TASK (pad);
5118 GST_PAD_TASK (pad) = NULL;
5119 res = gst_task_set_state (task, GST_TASK_STOPPED);
5120 GST_OBJECT_UNLOCK (pad);
5122 GST_PAD_STREAM_LOCK (pad);
5123 GST_PAD_STREAM_UNLOCK (pad);
5125 if (!gst_task_join (task))
5128 gst_object_unref (task);
5134 GST_DEBUG_OBJECT (pad, "no task");
5135 GST_OBJECT_UNLOCK (pad);
5137 GST_PAD_STREAM_LOCK (pad);
5138 GST_PAD_STREAM_UNLOCK (pad);
5140 /* this is not an error */
5145 /* this is bad, possibly the application tried to join the task from
5146 * the task's thread. We install the task again so that it will be stopped
5147 * again from the right thread next time hopefully. */
5148 GST_OBJECT_LOCK (pad);
5149 GST_DEBUG_OBJECT (pad, "join failed");
5150 /* we can only install this task if there was no other task */
5151 if (GST_PAD_TASK (pad) == NULL)
5152 GST_PAD_TASK (pad) = task;
5153 GST_OBJECT_UNLOCK (pad);