2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstpad.c: Pads for linking elements together
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * @short_description: Object contained by elements that allows links to
26 * @see_also: #GstPadTemplate, #GstElement, #GstEvent
28 * A #GstElement is linked to other elements via "pads", which are extremely
29 * light-weight generic link points.
30 * After two pads are retrieved from an element with gst_element_get_pad(),
31 * the pads can be link with gst_pad_link(). (For quick links,
32 * you can also use gst_element_link(), which will make the obvious
33 * link for you if it's straightforward.)
35 * Pads are typically created from a #GstPadTemplate with
36 * gst_pad_new_from_template().
38 * Pads have #GstCaps attached to it to describe the media type they are
39 * capable of dealing with. gst_pad_get_caps() and gst_pad_set_caps() are
40 * used to manipulate the caps of the pads.
41 * Pads created from a pad template cannot set capabilities that are
42 * incompatible with the pad template capabilities.
44 * Pads without pad templates can be created with gst_pad_new(),
45 * which takes a direction and a name as an argument. If the name is NULL,
46 * then a guaranteed unique name will be assigned to it.
48 * gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
50 * A #GstElement creating a pad will typically use the various
51 * gst_pad_set_*_function() calls to register callbacks for various events
54 * GstElements will use gst_pad_push() and gst_pad_pull_range() to push out
55 * or pull in a buffer.
57 * To send a #GstEvent on a pad, use gst_pad_send_event().
59 * Last reviewed on 2005-11-23 (0.9.5)
63 #include "gst_private.h"
66 #include "gstghostpad.h"
67 #include "gstpadtemplate.h"
68 #include "gstenumtypes.h"
69 #include "gstmarshal.h"
74 #include "glib-compat-private.h"
76 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
77 #define GST_CAT_DEFAULT GST_CAT_PADS
79 /* Pad signals and args */
99 static void gst_pad_class_init (GstPadClass * klass);
100 static void gst_pad_init (GstPad * pad);
101 static void gst_pad_dispose (GObject * object);
102 static void gst_pad_finalize (GObject * object);
103 static void gst_pad_set_property (GObject * object, guint prop_id,
104 const GValue * value, GParamSpec * pspec);
105 static void gst_pad_get_property (GObject * object, guint prop_id,
106 GValue * value, GParamSpec * pspec);
108 static GstFlowReturn handle_pad_block (GstPad * pad);
109 static GstCaps *gst_pad_get_caps_unlocked (GstPad * pad);
110 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
111 static gboolean gst_pad_activate_default (GstPad * pad);
112 static gboolean gst_pad_acceptcaps_default (GstPad * pad, GstCaps * caps);
114 #ifndef GST_DISABLE_LOADSAVE
115 static xmlNodePtr gst_pad_save_thyself (GstObject * object, xmlNodePtr parent);
118 static GstObjectClass *parent_class = NULL;
119 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
121 /* quarks for probe signals */
122 static GQuark buffer_quark;
123 static GQuark event_quark;
132 static GstFlowQuarks flow_quarks[] = {
133 {GST_FLOW_RESEND, "resend", 0},
134 {GST_FLOW_OK, "ok", 0},
135 {GST_FLOW_NOT_LINKED, "not-linked", 0},
136 {GST_FLOW_WRONG_STATE, "wrong-state", 0},
137 {GST_FLOW_UNEXPECTED, "unexpected", 0},
138 {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
139 {GST_FLOW_ERROR, "error", 0},
140 {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
147 * @ret: a #GstFlowReturn to get the name of.
149 * Gets a string representing the given flow return.
151 * Returns: a string with the name of the flow return.
153 G_CONST_RETURN gchar *
154 gst_flow_get_name (GstFlowReturn ret)
158 for (i = 0; flow_quarks[i].name; i++) {
159 if (ret == flow_quarks[i].ret)
160 return flow_quarks[i].name;
167 * @ret: a #GstFlowReturn to get the quark of.
169 * Get the unique quark for the given GstFlowReturn.
171 * Returns: the quark associated with the flow return or 0 if an
172 * invalid return was specified.
175 gst_flow_to_quark (GstFlowReturn ret)
179 for (i = 0; flow_quarks[i].name; i++) {
180 if (ret == flow_quarks[i].ret)
181 return flow_quarks[i].quark;
187 gst_pad_get_type (void)
189 static GType gst_pad_type = 0;
191 if (G_UNLIKELY (gst_pad_type == 0)) {
192 static const GTypeInfo pad_info = {
193 sizeof (GstPadClass), NULL, NULL,
194 (GClassInitFunc) gst_pad_class_init, NULL, NULL,
197 (GInstanceInitFunc) gst_pad_init, NULL
201 gst_pad_type = g_type_register_static (GST_TYPE_OBJECT, "GstPad",
204 buffer_quark = g_quark_from_static_string ("buffer");
205 event_quark = g_quark_from_static_string ("event");
207 for (i = 0; flow_quarks[i].name; i++) {
208 flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name);
211 GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW",
212 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads");
218 _gst_do_pass_data_accumulator (GSignalInvocationHint * ihint,
219 GValue * return_accu, const GValue * handler_return, gpointer dummy)
221 gboolean ret = g_value_get_boolean (handler_return);
223 GST_DEBUG ("accumulated %d", ret);
224 g_value_set_boolean (return_accu, ret);
230 default_have_data (GstPad * pad, GstMiniObject * o)
236 gst_pad_class_init (GstPadClass * klass)
238 GObjectClass *gobject_class;
241 GstObjectClass *gstobject_class;
243 gobject_class = (GObjectClass *) klass;
244 gstobject_class = (GstObjectClass *) klass;
246 parent_class = g_type_class_ref (GST_TYPE_OBJECT);
248 gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_pad_dispose);
249 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_pad_finalize);
250 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_pad_set_property);
251 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_pad_get_property);
255 * @pad: the pad that emitted the signal
256 * @peer: the peer pad that has been connected
258 * Signals that a pad has been linked to the peer pad.
260 gst_pad_signals[PAD_LINKED] =
261 g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
262 G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
263 gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
266 * @pad: the pad that emitted the signal
267 * @peer: the peer pad that has been disconnected
269 * Signals that a pad has been unlinked from the peer pad.
271 gst_pad_signals[PAD_UNLINKED] =
272 g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
273 G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
274 gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
276 * GstPad::request-link:
277 * @pad: the pad that emitted the signal
278 * @peer: the peer pad for which a connection is requested
280 * Signals that a pad connection has been requested.
282 gst_pad_signals[PAD_REQUEST_LINK] =
283 g_signal_new ("request-link", G_TYPE_FROM_CLASS (klass),
284 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstPadClass, request_link), NULL,
285 NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 0);
289 * @pad: the pad that emitted the signal
290 * @mini_obj: new data
292 * Signals that new data is available on the pad. This signal is used
293 * internally for implementing pad probes.
294 * See gst_pad_add_*_probe functions.
296 * Returns: %TRUE to keep the data, %FALSE to drop it
298 gst_pad_signals[PAD_HAVE_DATA] =
299 g_signal_new ("have-data", G_TYPE_FROM_CLASS (klass),
300 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
301 G_STRUCT_OFFSET (GstPadClass, have_data),
302 _gst_do_pass_data_accumulator,
303 NULL, gst_marshal_BOOLEAN__POINTER, G_TYPE_BOOLEAN, 1,
304 GST_TYPE_MINI_OBJECT);
306 g_object_class_install_property (G_OBJECT_CLASS (klass), PAD_PROP_CAPS,
307 g_param_spec_boxed ("caps", "Caps", "The capabilities of the pad",
308 GST_TYPE_CAPS, G_PARAM_READABLE));
309 g_object_class_install_property (G_OBJECT_CLASS (klass), PAD_PROP_DIRECTION,
310 g_param_spec_enum ("direction", "Direction", "The direction of the pad",
311 GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
312 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
313 g_object_class_install_property (G_OBJECT_CLASS (klass), PAD_PROP_TEMPLATE,
314 g_param_spec_object ("template", "Template",
315 "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
318 #ifndef GST_DISABLE_LOADSAVE
319 gstobject_class->save_thyself = GST_DEBUG_FUNCPTR (gst_pad_save_thyself);
321 gstobject_class->path_string_separator = ".";
323 klass->have_data = default_have_data;
327 gst_pad_init (GstPad * pad)
329 pad->direction = GST_PAD_UNKNOWN;
332 pad->chainfunc = NULL;
336 pad->linkfunc = NULL;
337 pad->getcapsfunc = NULL;
339 pad->activatefunc = GST_DEBUG_FUNCPTR (gst_pad_activate_default);
340 pad->eventfunc = GST_DEBUG_FUNCPTR (gst_pad_event_default);
341 pad->querytypefunc = GST_DEBUG_FUNCPTR (gst_pad_get_query_types_default);
342 pad->queryfunc = GST_DEBUG_FUNCPTR (gst_pad_query_default);
343 pad->intlinkfunc = GST_DEBUG_FUNCPTR (gst_pad_get_internal_links_default);
344 GST_PAD_ACCEPTCAPSFUNC (pad) = GST_DEBUG_FUNCPTR (gst_pad_acceptcaps_default);
346 pad->do_buffer_signals = 0;
347 pad->do_event_signals = 0;
349 GST_PAD_UNSET_FLUSHING (pad);
351 pad->preroll_lock = g_mutex_new ();
352 pad->preroll_cond = g_cond_new ();
354 pad->stream_rec_lock = g_new (GStaticRecMutex, 1);
355 g_static_rec_mutex_init (pad->stream_rec_lock);
357 pad->block_cond = g_cond_new ();
361 gst_pad_dispose (GObject * object)
363 GstPad *pad = GST_PAD (object);
365 GST_CAT_DEBUG (GST_CAT_REFCOUNTING, "dispose %s:%s",
366 GST_DEBUG_PAD_NAME (pad));
368 /* we don't hold a ref to the peer so we can just set the
370 GST_PAD_PEER (pad) = NULL;
373 gst_caps_replace (&GST_PAD_CAPS (pad), NULL);
375 gst_pad_set_pad_template (pad, NULL);
377 G_OBJECT_CLASS (parent_class)->dispose (object);
381 gst_pad_finalize (GObject * object)
383 GstPad *pad = GST_PAD (object);
386 /* in case the task is still around, clean it up */
387 if ((task = GST_PAD_TASK (pad))) {
388 gst_task_join (task);
389 GST_PAD_TASK (pad) = NULL;
390 gst_object_unref (task);
393 if (pad->stream_rec_lock) {
394 g_static_rec_mutex_free (pad->stream_rec_lock);
395 g_free (pad->stream_rec_lock);
396 pad->stream_rec_lock = NULL;
398 if (pad->preroll_lock) {
399 g_mutex_free (pad->preroll_lock);
400 g_cond_free (pad->preroll_cond);
401 pad->preroll_lock = NULL;
402 pad->preroll_cond = NULL;
404 if (pad->block_cond) {
405 g_cond_free (pad->block_cond);
406 pad->block_cond = NULL;
409 G_OBJECT_CLASS (parent_class)->finalize (object);
413 gst_pad_set_property (GObject * object, guint prop_id,
414 const GValue * value, GParamSpec * pspec)
416 g_return_if_fail (GST_IS_PAD (object));
419 case PAD_PROP_DIRECTION:
420 GST_PAD_DIRECTION (object) = g_value_get_enum (value);
422 case PAD_PROP_TEMPLATE:
423 gst_pad_set_pad_template (GST_PAD_CAST (object),
424 (GstPadTemplate *) g_value_dup_gst_object (value));
427 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
433 gst_pad_get_property (GObject * object, guint prop_id,
434 GValue * value, GParamSpec * pspec)
436 g_return_if_fail (GST_IS_PAD (object));
440 g_value_set_boxed (value, GST_PAD_CAPS (object));
442 case PAD_PROP_DIRECTION:
443 g_value_set_enum (value, GST_PAD_DIRECTION (object));
445 case PAD_PROP_TEMPLATE:
446 g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
449 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
456 * @name: the name of the new pad.
457 * @direction: the #GstPadDirection of the pad.
459 * Creates a new pad with the given name in the given direction.
460 * If name is NULL, a guaranteed unique name (across all pads)
462 * This function makes a copy of the name so you can safely free the name.
464 * Returns: a new #GstPad, or NULL in case of an error.
469 gst_pad_new (const gchar * name, GstPadDirection direction)
471 return g_object_new (GST_TYPE_PAD,
472 "name", name, "direction", direction, NULL);
476 * gst_pad_new_from_template:
477 * @templ: the pad template to use
478 * @name: the name of the element
480 * Creates a new pad with the given name from the given template.
481 * If name is NULL, a guaranteed unique name (across all pads)
483 * This function makes a copy of the name so you can safely free the name.
485 * Returns: a new #GstPad, or NULL in case of an error.
488 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
490 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
492 return g_object_new (GST_TYPE_PAD,
493 "name", name, "direction", templ->direction, "template", templ, NULL);
497 * gst_pad_new_from_static_template:
498 * @templ: the #GstStaticPadTemplate to use
499 * @name: the name of the element
501 * Creates a new pad with the given name from the given static template.
502 * If name is NULL, a guaranteed unique name (across all pads)
504 * This function makes a copy of the name so you can safely free the name.
506 * Returns: a new #GstPad, or NULL in case of an error.
509 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
513 GstPadTemplate *template;
515 template = gst_static_pad_template_get (templ);
516 pad = gst_pad_new_from_template (template, name);
517 gst_object_unref (template);
522 * gst_pad_get_direction:
523 * @pad: a #GstPad to get the direction of.
525 * Gets the direction of the pad. The direction of the pad is
526 * decided at construction time so this function does not take
529 * Returns: the #GstPadDirection of the pad.
534 gst_pad_get_direction (GstPad * pad)
536 GstPadDirection result;
538 /* PAD_UNKNOWN is a little silly but we need some sort of
539 * error return value */
540 g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
542 GST_OBJECT_LOCK (pad);
543 result = GST_PAD_DIRECTION (pad);
544 GST_OBJECT_UNLOCK (pad);
550 gst_pad_activate_default (GstPad * pad)
552 return gst_pad_activate_push (pad, TRUE);
556 pre_activate (GstPad * pad, GstActivateMode new_mode)
559 case GST_ACTIVATE_PUSH:
560 case GST_ACTIVATE_PULL:
561 GST_OBJECT_LOCK (pad);
562 GST_DEBUG_OBJECT (pad, "setting ACTIVATE_MODE %d, unset flushing",
564 GST_PAD_UNSET_FLUSHING (pad);
565 GST_PAD_ACTIVATE_MODE (pad) = new_mode;
566 GST_OBJECT_UNLOCK (pad);
568 case GST_ACTIVATE_NONE:
569 GST_OBJECT_LOCK (pad);
570 GST_DEBUG_OBJECT (pad, "setting ACTIVATE_MODE NONE, set flushing",
572 GST_PAD_SET_FLUSHING (pad);
573 /* unlock blocked pads so element can resume and stop */
574 GST_PAD_BLOCK_SIGNAL (pad);
575 GST_OBJECT_UNLOCK (pad);
581 post_activate (GstPad * pad, GstActivateMode new_mode)
584 case GST_ACTIVATE_PUSH:
585 case GST_ACTIVATE_PULL:
588 case GST_ACTIVATE_NONE:
589 /* ensures that streaming stops */
590 GST_PAD_STREAM_LOCK (pad);
591 /* while we're at it set activation mode */
592 GST_OBJECT_LOCK (pad);
593 GST_DEBUG_OBJECT (pad, "setting ACTIVATE_MODE %d", new_mode);
594 GST_PAD_ACTIVATE_MODE (pad) = new_mode;
595 GST_OBJECT_UNLOCK (pad);
596 GST_PAD_STREAM_UNLOCK (pad);
602 * gst_pad_set_active:
603 * @pad: the #GstPad to activate or deactivate.
604 * @active: whether or not the pad should be active.
606 * Activates or deactivates the given pad.
607 * Normally called from within core state change functions.
609 * If @active, makes sure the pad is active. If it is already active, either in
610 * push or pull mode, just return. Otherwise dispatches to the pad's activate
611 * function to perform the actual activation.
613 * If not @active, checks the pad's current mode and calls
614 * gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a
617 * Returns: #TRUE if the operation was successful.
622 gst_pad_set_active (GstPad * pad, gboolean active)
625 gboolean ret = FALSE;
627 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
629 GST_OBJECT_LOCK (pad);
630 old = GST_PAD_ACTIVATE_MODE (pad);
631 GST_OBJECT_UNLOCK (pad);
635 case GST_ACTIVATE_PUSH:
636 case GST_ACTIVATE_PULL:
639 case GST_ACTIVATE_NONE:
640 ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad);
645 case GST_ACTIVATE_PUSH:
646 ret = gst_pad_activate_push (pad, FALSE);
648 case GST_ACTIVATE_PULL:
649 ret = gst_pad_activate_pull (pad, FALSE);
651 case GST_ACTIVATE_NONE:
657 if (!active && !ret) {
658 GST_OBJECT_LOCK (pad);
659 g_critical ("Failed to deactivate pad %s:%s, very bad",
660 GST_DEBUG_PAD_NAME (pad));
661 GST_OBJECT_UNLOCK (pad);
668 * gst_pad_activate_pull:
669 * @pad: the #GstPad to activate or deactivate.
670 * @active: whether or not the pad should be active.
672 * Activates or deactivates the given pad in pull mode via dispatching to the
673 * pad's activatepullfunc. For use from within pad activation functions only.
674 * When called on sink pads, will first proxy the call to the peer pad, which is
675 * expected to activate its internally linked pads from within its activate_pull
678 * If you don't know what this is, you probably don't want to call it.
680 * Returns: TRUE if the operation was successful.
685 gst_pad_activate_pull (GstPad * pad, gboolean active)
687 GstActivateMode old, new;
690 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
692 GST_OBJECT_LOCK (pad);
693 old = GST_PAD_ACTIVATE_MODE (pad);
694 GST_OBJECT_UNLOCK (pad);
696 if ((active && old == GST_ACTIVATE_PULL)
697 || (!active && old == GST_ACTIVATE_NONE))
701 g_return_val_if_fail (old == GST_ACTIVATE_NONE, FALSE);
703 g_return_val_if_fail (old == GST_ACTIVATE_PULL, FALSE);
706 if (gst_pad_get_direction (pad) == GST_PAD_SINK) {
707 if ((peer = gst_pad_get_peer (pad))) {
708 if (!gst_pad_activate_pull (peer, active))
710 gst_object_unref (peer);
713 if (GST_PAD_GETRANGEFUNC (pad) == NULL)
714 goto failure; /* Can't activate pull on a src without a
718 new = active ? GST_ACTIVATE_PULL : GST_ACTIVATE_NONE;
719 pre_activate (pad, new);
721 if (GST_PAD_ACTIVATEPULLFUNC (pad)) {
722 if (!GST_PAD_ACTIVATEPULLFUNC (pad) (pad, active))
725 /* can happen for sinks of passthrough elements */
728 post_activate (pad, new);
730 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in pull mode",
731 active ? "activated" : "deactivated");
736 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in pull mode",
737 active ? "activated" : "deactivated");
742 GST_OBJECT_LOCK (peer);
743 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
744 "activate_pull on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
745 GST_OBJECT_UNLOCK (peer);
746 gst_object_unref (peer);
751 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in pull mode",
752 active ? "activate" : "deactivate");
753 pre_activate (pad, GST_ACTIVATE_NONE);
754 post_activate (pad, GST_ACTIVATE_NONE);
760 * gst_pad_activate_push:
761 * @pad: the #GstPad to activate or deactivate.
762 * @active: whether or not the pad should be active.
764 * Activates or deactivates the given pad in push mode via dispatching to the
765 * pad's activatepushfunc. For use from within pad activation functions only.
767 * If you don't know what this is, you probably don't want to call it.
769 * Returns: TRUE if the operation was successfull.
774 gst_pad_activate_push (GstPad * pad, gboolean active)
776 GstActivateMode old, new;
778 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
779 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "trying to set %s in push mode",
780 active ? "activated" : "deactivated");
782 GST_OBJECT_LOCK (pad);
783 old = GST_PAD_ACTIVATE_MODE (pad);
784 GST_OBJECT_UNLOCK (pad);
786 if ((active && old == GST_ACTIVATE_PUSH)
787 || (!active && old == GST_ACTIVATE_NONE))
791 g_return_val_if_fail (old == GST_ACTIVATE_NONE, FALSE);
793 g_return_val_if_fail (old == GST_ACTIVATE_PUSH, FALSE);
796 new = active ? GST_ACTIVATE_PUSH : GST_ACTIVATE_NONE;
797 pre_activate (pad, new);
799 if (GST_PAD_ACTIVATEPUSHFUNC (pad)) {
800 if (!GST_PAD_ACTIVATEPUSHFUNC (pad) (pad, active)) {
804 /* quite ok, element relies on state change func to prepare itself */
807 post_activate (pad, new);
809 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in push mode",
810 active ? "activated" : "deactivated");
815 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in push mode",
816 active ? "activated" : "deactivated");
821 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in push mode",
822 active ? "activate" : "deactivate");
823 pre_activate (pad, GST_ACTIVATE_NONE);
824 post_activate (pad, GST_ACTIVATE_NONE);
831 * @pad: the #GstPad to query
833 * Query if a pad is active
835 * Returns: TRUE if the pad is active.
840 gst_pad_is_active (GstPad * pad)
842 gboolean result = FALSE;
844 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
846 GST_OBJECT_LOCK (pad);
847 result = GST_PAD_MODE_ACTIVATE (GST_PAD_ACTIVATE_MODE (pad));
848 GST_OBJECT_UNLOCK (pad);
854 * gst_pad_set_blocked_async:
855 * @pad: the #GstPad to block or unblock
856 * @blocked: boolean indicating whether the pad should be blocked or unblocked
857 * @callback: #GstPadBlockCallback that will be called when the
859 * @user_data: user data passed to the callback
861 * Blocks or unblocks the dataflow on a pad. The provided callback
862 * is called when the operation succeeds; this happens right before the next
863 * attempt at pushing a buffer on the pad.
865 * This can take a while as the pad can only become blocked when real dataflow
867 * When the pipeline is stalled, for example in PAUSED, this can
868 * take an indeterminate amount of time.
869 * You can pass NULL as the callback to make this call block. Be careful with
870 * this blocking call as it might not return for reasons stated above.
872 * Returns: TRUE if the pad could be blocked. This function can fail
873 * if wrong parameters were passed or the pad was already in the
879 gst_pad_set_blocked_async (GstPad * pad, gboolean blocked,
880 GstPadBlockCallback callback, gpointer user_data)
882 gboolean was_blocked, was_ghost = FALSE;
884 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
886 if (GST_IS_GHOST_PAD (pad)) {
887 pad = gst_ghost_pad_get_target (GST_GHOST_PAD (pad));
894 GST_OBJECT_LOCK (pad);
896 was_blocked = GST_PAD_IS_BLOCKED (pad);
898 if (G_UNLIKELY (was_blocked == blocked))
899 goto had_right_state;
902 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "blocking pad %s:%s",
903 GST_DEBUG_PAD_NAME (pad));
905 GST_OBJECT_FLAG_SET (pad, GST_PAD_BLOCKED);
906 pad->block_callback = callback;
907 pad->block_data = user_data;
909 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "waiting for block");
910 GST_PAD_BLOCK_WAIT (pad);
911 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "blocked");
914 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "unblocking pad %s:%s",
915 GST_DEBUG_PAD_NAME (pad));
917 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_BLOCKED);
919 pad->block_callback = callback;
920 pad->block_data = user_data;
923 GST_PAD_BLOCK_SIGNAL (pad);
925 GST_PAD_BLOCK_SIGNAL (pad);
926 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "waiting for unblock");
927 GST_PAD_BLOCK_WAIT (pad);
928 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "unblocked");
931 GST_OBJECT_UNLOCK (pad);
934 gst_object_unref (pad);
941 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
942 "pad %s:%s was in right state", GST_DEBUG_PAD_NAME (pad));
943 GST_OBJECT_UNLOCK (pad);
946 gst_object_unref (pad);
953 * gst_pad_set_blocked:
954 * @pad: the #GstPad to block or unblock
955 * @blocked: boolean indicating we should block or unblock
957 * Blocks or unblocks the dataflow on a pad. This function is
958 * a shortcut for gst_pad_set_blocked_async() with a NULL
961 * Returns: TRUE if the pad could be blocked. This function can fail
962 * wrong parameters were passed or the pad was already in the
968 gst_pad_set_blocked (GstPad * pad, gboolean blocked)
970 return gst_pad_set_blocked_async (pad, blocked, NULL, NULL);
974 * gst_pad_is_blocked:
975 * @pad: the #GstPad to query
977 * Checks if the pad is blocked or not. This function returns the
978 * last requested state of the pad. It is not certain that the pad
979 * is actually blocked at this point.
981 * Returns: TRUE if the pad is blocked.
986 gst_pad_is_blocked (GstPad * pad)
988 gboolean result = FALSE;
990 g_return_val_if_fail (GST_IS_PAD (pad), result);
992 GST_OBJECT_LOCK (pad);
993 result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKED);
994 GST_OBJECT_UNLOCK (pad);
1000 * gst_pad_set_activate_function:
1001 * @pad: a sink #GstPad.
1002 * @activate: the #GstPadActivateFunction to set.
1004 * Sets the given activate function for the pad. The activate function will
1005 * dispatch to activate_push or activate_pull to perform the actual activation.
1006 * Only makes sense to set on sink pads.
1008 * Call this function if your sink pad can start a pull-based task.
1011 gst_pad_set_activate_function (GstPad * pad, GstPadActivateFunction activate)
1013 g_return_if_fail (GST_IS_PAD (pad));
1015 GST_PAD_ACTIVATEFUNC (pad) = activate;
1016 GST_CAT_DEBUG (GST_CAT_PADS, "activatefunc for %s:%s set to %s",
1017 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (activate));
1021 * gst_pad_set_activatepull_function:
1022 * @pad: a sink #GstPad.
1023 * @activatepull: the #GstPadActivateModeFunction to set.
1025 * Sets the given activate_pull function for the pad. An activate_pull function
1026 * prepares the element and any upstream connections for pulling. See XXX
1027 * part-activation.txt for details.
1030 gst_pad_set_activatepull_function (GstPad * pad,
1031 GstPadActivateModeFunction activatepull)
1033 g_return_if_fail (GST_IS_PAD (pad));
1035 GST_PAD_ACTIVATEPULLFUNC (pad) = activatepull;
1036 GST_CAT_DEBUG (GST_CAT_PADS, "activatepullfunc for %s:%s set to %s",
1037 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (activatepull));
1041 * gst_pad_set_activatepush_function:
1042 * @pad: a sink #GstPad.
1043 * @activatepush: the #GstPadActivateModeFunction to set.
1045 * Sets the given activate_push function for the pad. An activate_push function
1046 * prepares the element for pushing. See XXX part-activation.txt for details.
1049 gst_pad_set_activatepush_function (GstPad * pad,
1050 GstPadActivateModeFunction activatepush)
1052 g_return_if_fail (GST_IS_PAD (pad));
1054 GST_PAD_ACTIVATEPUSHFUNC (pad) = activatepush;
1055 GST_CAT_DEBUG (GST_CAT_PADS, "activatepushfunc for %s:%s set to %s",
1056 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (activatepush));
1060 * gst_pad_set_chain_function:
1061 * @pad: a sink #GstPad.
1062 * @chain: the #GstPadChainFunction to set.
1064 * Sets the given chain function for the pad. The chain function is called to
1065 * process a #GstBuffer input buffer.
1068 gst_pad_set_chain_function (GstPad * pad, GstPadChainFunction chain)
1070 g_return_if_fail (GST_IS_PAD (pad));
1071 g_return_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK);
1073 GST_PAD_CHAINFUNC (pad) = chain;
1074 GST_CAT_DEBUG (GST_CAT_PADS, "chainfunc for %s:%s set to %s",
1075 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (chain));
1079 * gst_pad_set_getrange_function:
1080 * @pad: a source #GstPad.
1081 * @get: the #GstPadGetRangeFunction to set.
1083 * Sets the given getrange function for the pad. The getrange function is called to
1084 * produce a new #GstBuffer to start the processing pipeline. Getrange functions cannot
1088 gst_pad_set_getrange_function (GstPad * pad, GstPadGetRangeFunction get)
1090 g_return_if_fail (GST_IS_PAD (pad));
1091 g_return_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC);
1093 GST_PAD_GETRANGEFUNC (pad) = get;
1095 GST_CAT_DEBUG (GST_CAT_PADS, "getrangefunc for %s:%s set to %s",
1096 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (get));
1100 * gst_pad_set_checkgetrange_function:
1101 * @pad: a source #GstPad.
1102 * @check: the #GstPadCheckGetRangeFunction to set.
1104 * Sets the given checkgetrange function for the pad. Implement this function on
1105 * a pad if you dynamically support getrange based scheduling on the pad.
1108 gst_pad_set_checkgetrange_function (GstPad * pad,
1109 GstPadCheckGetRangeFunction check)
1111 g_return_if_fail (GST_IS_PAD (pad));
1112 g_return_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC);
1114 GST_PAD_CHECKGETRANGEFUNC (pad) = check;
1116 GST_CAT_DEBUG (GST_CAT_PADS, "checkgetrangefunc for %s:%s set to %s",
1117 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (check));
1121 * gst_pad_set_event_function:
1122 * @pad: a source #GstPad.
1123 * @event: the #GstPadEventFunction to set.
1125 * Sets the given event handler for the pad.
1128 gst_pad_set_event_function (GstPad * pad, GstPadEventFunction event)
1130 g_return_if_fail (GST_IS_PAD (pad));
1132 GST_PAD_EVENTFUNC (pad) = event;
1134 GST_CAT_DEBUG (GST_CAT_PADS, "eventfunc for %s:%s set to %s",
1135 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (event));
1139 * gst_pad_set_query_function:
1140 * @pad: a #GstPad of either direction.
1141 * @query: the #GstPadQueryFunction to set.
1143 * Set the given query function for the pad.
1146 gst_pad_set_query_function (GstPad * pad, GstPadQueryFunction query)
1148 g_return_if_fail (GST_IS_PAD (pad));
1150 GST_PAD_QUERYFUNC (pad) = query;
1152 GST_CAT_DEBUG (GST_CAT_PADS, "queryfunc for %s:%s set to %s",
1153 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (query));
1157 * gst_pad_set_query_type_function:
1158 * @pad: a #GstPad of either direction.
1159 * @type_func: the #GstPadQueryTypeFunction to set.
1161 * Set the given query type function for the pad.
1164 gst_pad_set_query_type_function (GstPad * pad,
1165 GstPadQueryTypeFunction type_func)
1167 g_return_if_fail (GST_IS_PAD (pad));
1169 GST_PAD_QUERYTYPEFUNC (pad) = type_func;
1171 GST_CAT_DEBUG (GST_CAT_PADS, "querytypefunc for %s:%s set to %s",
1172 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (type_func));
1176 * gst_pad_get_query_types:
1179 * Get an array of supported queries that can be performed
1182 * Returns: a zero-terminated array of #GstQueryType.
1184 const GstQueryType *
1185 gst_pad_get_query_types (GstPad * pad)
1187 GstPadQueryTypeFunction func;
1189 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1191 if (G_UNLIKELY ((func = GST_PAD_QUERYTYPEFUNC (pad)) == NULL))
1203 gst_pad_get_query_types_dispatcher (GstPad * pad, const GstQueryType ** data)
1205 *data = gst_pad_get_query_types (pad);
1211 * gst_pad_get_query_types_default:
1214 * Invoke the default dispatcher for the query types on
1217 * Returns: an zero-terminated array of #GstQueryType, or NULL if none of the
1218 * internally-linked pads has a query types function.
1220 const GstQueryType *
1221 gst_pad_get_query_types_default (GstPad * pad)
1223 GstQueryType *result = NULL;
1225 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1227 gst_pad_dispatcher (pad, (GstPadDispatcherFunction)
1228 gst_pad_get_query_types_dispatcher, &result);
1234 * gst_pad_set_internal_link_function:
1235 * @pad: a #GstPad of either direction.
1236 * @intlink: the #GstPadIntLinkFunction to set.
1238 * Sets the given internal link function for the pad.
1241 gst_pad_set_internal_link_function (GstPad * pad, GstPadIntLinkFunction intlink)
1243 g_return_if_fail (GST_IS_PAD (pad));
1245 GST_PAD_INTLINKFUNC (pad) = intlink;
1246 GST_CAT_DEBUG (GST_CAT_PADS, "internal link for %s:%s set to %s",
1247 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (intlink));
1251 * gst_pad_set_link_function:
1253 * @link: the #GstPadLinkFunction to set.
1255 * Sets the given link function for the pad. It will be called when
1256 * the pad is linked with another pad.
1258 * The return value #GST_PAD_LINK_OK should be used when the connection can be
1261 * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1262 * cannot be made for some reason.
1264 * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1265 * of the peer sink pad, if present.
1268 gst_pad_set_link_function (GstPad * pad, GstPadLinkFunction link)
1270 g_return_if_fail (GST_IS_PAD (pad));
1272 GST_PAD_LINKFUNC (pad) = link;
1273 GST_CAT_DEBUG (GST_CAT_PADS, "linkfunc for %s:%s set to %s",
1274 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (link));
1278 * gst_pad_set_unlink_function:
1280 * @unlink: the #GstPadUnlinkFunction to set.
1282 * Sets the given unlink function for the pad. It will be called
1283 * when the pad is unlinked.
1286 gst_pad_set_unlink_function (GstPad * pad, GstPadUnlinkFunction unlink)
1288 g_return_if_fail (GST_IS_PAD (pad));
1290 GST_PAD_UNLINKFUNC (pad) = unlink;
1291 GST_CAT_DEBUG (GST_CAT_PADS, "unlinkfunc for %s:%s set to %s",
1292 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (unlink));
1296 * gst_pad_set_getcaps_function:
1298 * @getcaps: the #GstPadGetCapsFunction to set.
1300 * Sets the given getcaps function for the pad. @getcaps should return the
1301 * allowable caps for a pad in the context of the element's state, its link to
1302 * other elements, and the devices or files it has opened. These caps must be a
1303 * subset of the pad template caps. In the NULL state with no links, @getcaps
1304 * should ideally return the same caps as the pad template. In rare
1305 * circumstances, an object property can affect the caps returned by @getcaps,
1306 * but this is discouraged.
1308 * You do not need to call this function if @pad's allowed caps are always the
1309 * same as the pad template caps. This can only be true if the padtemplate
1310 * has fixed simple caps.
1312 * For most filters, the caps returned by @getcaps is directly affected by the
1313 * allowed caps on other pads. For demuxers and decoders, the caps returned by
1314 * the srcpad's getcaps function is directly related to the stream data. Again,
1315 * @getcaps should return the most specific caps it reasonably can, since this
1316 * helps with autoplugging.
1318 * Note that the return value from @getcaps is owned by the caller, so the caller
1319 * should unref the caps after usage.
1322 gst_pad_set_getcaps_function (GstPad * pad, GstPadGetCapsFunction getcaps)
1324 g_return_if_fail (GST_IS_PAD (pad));
1326 GST_PAD_GETCAPSFUNC (pad) = getcaps;
1327 GST_CAT_DEBUG (GST_CAT_PADS, "getcapsfunc for %s:%s set to %s",
1328 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (getcaps));
1332 * gst_pad_set_acceptcaps_function:
1334 * @acceptcaps: the #GstPadAcceptCapsFunction to set.
1336 * Sets the given acceptcaps function for the pad. The acceptcaps function
1337 * will be called to check if the pad can accept the given caps. Setting the
1338 * acceptcaps function to NULL restores the default behaviour of allowing
1339 * any caps that matches the caps from gst_pad_get_caps.
1342 gst_pad_set_acceptcaps_function (GstPad * pad,
1343 GstPadAcceptCapsFunction acceptcaps)
1345 g_return_if_fail (GST_IS_PAD (pad));
1347 GST_PAD_ACCEPTCAPSFUNC (pad) = acceptcaps;
1348 GST_CAT_DEBUG (GST_CAT_PADS, "acceptcapsfunc for %s:%s set to %s",
1349 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (acceptcaps));
1353 * gst_pad_set_fixatecaps_function:
1355 * @fixatecaps: the #GstPadFixateCapsFunction to set.
1357 * Sets the given fixatecaps function for the pad. The fixatecaps function
1358 * will be called whenever the default values for a GstCaps needs to be
1362 gst_pad_set_fixatecaps_function (GstPad * pad,
1363 GstPadFixateCapsFunction fixatecaps)
1365 g_return_if_fail (GST_IS_PAD (pad));
1367 GST_PAD_FIXATECAPSFUNC (pad) = fixatecaps;
1368 GST_CAT_DEBUG (GST_CAT_PADS, "fixatecapsfunc for %s:%s set to %s",
1369 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (fixatecaps));
1373 * gst_pad_set_setcaps_function:
1375 * @setcaps: the #GstPadSetCapsFunction to set.
1377 * Sets the given setcaps function for the pad. The setcaps function
1378 * will be called whenever a buffer with a new media type is pushed or
1379 * pulled from the pad. The pad/element needs to update it's internal
1380 * structures to process the new media type. If this new type is not
1381 * acceptable, the setcaps function should return FALSE.
1384 gst_pad_set_setcaps_function (GstPad * pad, GstPadSetCapsFunction setcaps)
1386 g_return_if_fail (GST_IS_PAD (pad));
1388 GST_PAD_SETCAPSFUNC (pad) = setcaps;
1389 GST_CAT_DEBUG (GST_CAT_PADS, "setcapsfunc for %s:%s set to %s",
1390 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (setcaps));
1394 * gst_pad_set_bufferalloc_function:
1395 * @pad: a sink #GstPad.
1396 * @bufalloc: the #GstPadBufferAllocFunction to set.
1398 * Sets the given bufferalloc function for the pad. Note that the
1399 * bufferalloc function can only be set on sinkpads.
1402 gst_pad_set_bufferalloc_function (GstPad * pad,
1403 GstPadBufferAllocFunction bufalloc)
1405 g_return_if_fail (GST_IS_PAD (pad));
1406 g_return_if_fail (GST_PAD_IS_SINK (pad));
1408 GST_PAD_BUFFERALLOCFUNC (pad) = bufalloc;
1409 GST_CAT_DEBUG (GST_CAT_PADS, "bufferallocfunc for %s:%s set to %s",
1410 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (bufalloc));
1415 * @srcpad: the source #GstPad to unlink.
1416 * @sinkpad: the sink #GstPad to unlink.
1418 * Unlinks the source pad from the sink pad. Will emit the "unlinked" signal on
1421 * Returns: TRUE if the pads were unlinked. This function returns FALSE if
1422 * the pads were not linked together.
1427 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1429 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1430 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1432 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1433 GST_DEBUG_PAD_NAME (srcpad), srcpad,
1434 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1436 GST_OBJECT_LOCK (srcpad);
1438 if (G_UNLIKELY (GST_PAD_DIRECTION (srcpad) != GST_PAD_SRC))
1441 GST_OBJECT_LOCK (sinkpad);
1443 if (G_UNLIKELY (GST_PAD_DIRECTION (sinkpad) != GST_PAD_SINK))
1446 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1447 goto not_linked_together;
1449 if (GST_PAD_UNLINKFUNC (srcpad)) {
1450 GST_PAD_UNLINKFUNC (srcpad) (srcpad);
1452 if (GST_PAD_UNLINKFUNC (sinkpad)) {
1453 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad);
1456 /* first clear peers */
1457 GST_PAD_PEER (srcpad) = NULL;
1458 GST_PAD_PEER (sinkpad) = NULL;
1460 GST_OBJECT_UNLOCK (sinkpad);
1461 GST_OBJECT_UNLOCK (srcpad);
1463 /* fire off a signal to each of the pads telling them
1464 * that they've been unlinked */
1465 g_signal_emit (G_OBJECT (srcpad), gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1466 g_signal_emit (G_OBJECT (sinkpad), gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1468 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1469 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1475 g_critical ("pad %s is not a source pad", GST_PAD_NAME (srcpad));
1476 GST_OBJECT_UNLOCK (srcpad);
1481 g_critical ("pad %s is not a sink pad", GST_PAD_NAME (sinkpad));
1482 GST_OBJECT_UNLOCK (sinkpad);
1483 GST_OBJECT_UNLOCK (srcpad);
1486 not_linked_together:
1488 /* we do not emit a warning in this case because unlinking cannot
1489 * be made MT safe.*/
1490 GST_OBJECT_UNLOCK (sinkpad);
1491 GST_OBJECT_UNLOCK (srcpad);
1497 * gst_pad_is_linked:
1498 * @pad: pad to check
1500 * Checks if a @pad is linked to another pad or not.
1502 * Returns: TRUE if the pad is linked, FALSE otherwise.
1507 gst_pad_is_linked (GstPad * pad)
1511 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1513 GST_OBJECT_LOCK (pad);
1514 result = (GST_PAD_PEER (pad) != NULL);
1515 GST_OBJECT_UNLOCK (pad);
1520 /* get the caps from both pads and see if the intersection
1523 * This function should be called with the pad LOCK on both
1527 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink)
1533 srccaps = gst_pad_get_caps_unlocked (src);
1534 sinkcaps = gst_pad_get_caps_unlocked (sink);
1536 GST_CAT_DEBUG (GST_CAT_CAPS, "src caps %" GST_PTR_FORMAT, srccaps);
1537 GST_CAT_DEBUG (GST_CAT_CAPS, "sink caps %" GST_PTR_FORMAT, sinkcaps);
1539 /* if we have caps on both pads we can check the intersection. If one
1540 * of the caps is NULL, we return TRUE. */
1541 if (srccaps == NULL || sinkcaps == NULL)
1544 icaps = gst_caps_intersect (srccaps, sinkcaps);
1545 gst_caps_unref (srccaps);
1546 gst_caps_unref (sinkcaps);
1551 GST_CAT_DEBUG (GST_CAT_CAPS,
1552 "intersection caps %p %" GST_PTR_FORMAT, icaps, icaps);
1554 if (gst_caps_is_empty (icaps))
1557 gst_caps_unref (icaps);
1562 /* incompatible cases */
1565 GST_CAT_DEBUG (GST_CAT_CAPS, "intersection gave NULL");
1570 GST_CAT_DEBUG (GST_CAT_CAPS, "intersection is EMPTY");
1571 gst_caps_unref (icaps);
1576 /* check if the grandparents of both pads are the same.
1577 * This check is required so that we don't try to link
1578 * pads from elements in different bins without ghostpads.
1580 * The LOCK should be helt on both pads
1583 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
1585 GstObject *psrc, *psink;
1586 gboolean res = TRUE;
1588 psrc = GST_OBJECT_PARENT (src);
1589 psink = GST_OBJECT_PARENT (sink);
1591 /* if one of the pads has no parent, we allow the link */
1592 if (psrc && psink) {
1593 /* if the parents are the same, we have a loop */
1594 if (psrc == psink) {
1595 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
1600 /* if they both have a parent, we check the grandparents */
1601 psrc = gst_object_get_parent (psrc);
1602 psink = gst_object_get_parent (psink);
1604 if (psrc != psink) {
1605 /* if they have grandparents but they are not the same */
1606 GST_CAT_DEBUG (GST_CAT_CAPS,
1607 "pads have different grandparents %" GST_PTR_FORMAT " and %"
1608 GST_PTR_FORMAT, psrc, psink);
1612 gst_object_unref (psrc);
1614 gst_object_unref (psink);
1620 /* FIXME leftover from an attempt at refactoring... */
1621 /* call with the two pads unlocked */
1622 static GstPadLinkReturn
1623 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad)
1625 /* generic checks */
1626 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
1627 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
1629 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1630 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1632 GST_OBJECT_LOCK (srcpad);
1634 if (G_UNLIKELY (GST_PAD_DIRECTION (srcpad) != GST_PAD_SRC))
1637 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
1638 goto src_was_linked;
1640 GST_OBJECT_LOCK (sinkpad);
1642 if (G_UNLIKELY (GST_PAD_DIRECTION (sinkpad) != GST_PAD_SINK))
1645 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
1646 goto sink_was_linked;
1648 /* check hierarchy, pads can only be linked if the grandparents
1650 if (!gst_pad_link_check_hierarchy (srcpad, sinkpad))
1651 goto wrong_hierarchy;
1653 /* check pad caps for non-empty intersection */
1654 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad))
1657 /* FIXME check pad scheduling for non-empty intersection */
1659 return GST_PAD_LINK_OK;
1663 g_critical ("pad %s is not a source pad", GST_PAD_NAME (srcpad));
1664 GST_OBJECT_UNLOCK (srcpad);
1665 return GST_PAD_LINK_WRONG_DIRECTION;
1669 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked",
1670 GST_DEBUG_PAD_NAME (srcpad));
1671 /* we do not emit a warning in this case because unlinking cannot
1672 * be made MT safe.*/
1673 GST_OBJECT_UNLOCK (srcpad);
1674 return GST_PAD_LINK_WAS_LINKED;
1678 g_critical ("pad %s is not a sink pad", GST_PAD_NAME (sinkpad));
1679 GST_OBJECT_UNLOCK (sinkpad);
1680 GST_OBJECT_UNLOCK (srcpad);
1681 return GST_PAD_LINK_WRONG_DIRECTION;
1685 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked",
1686 GST_DEBUG_PAD_NAME (sinkpad));
1687 /* we do not emit a warning in this case because unlinking cannot
1688 * be made MT safe.*/
1689 GST_OBJECT_UNLOCK (sinkpad);
1690 GST_OBJECT_UNLOCK (srcpad);
1691 return GST_PAD_LINK_WAS_LINKED;
1695 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
1696 GST_OBJECT_UNLOCK (sinkpad);
1697 GST_OBJECT_UNLOCK (srcpad);
1698 return GST_PAD_LINK_WRONG_HIERARCHY;
1702 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
1703 GST_OBJECT_UNLOCK (sinkpad);
1704 GST_OBJECT_UNLOCK (srcpad);
1705 return GST_PAD_LINK_NOFORMAT;
1711 * @srcpad: the source #GstPad to link.
1712 * @sinkpad: the sink #GstPad to link.
1714 * Links the source pad and the sink pad.
1716 * Returns: A result code indicating if the connection worked or
1722 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
1724 GstPadLinkReturn result;
1726 /* prepare will also lock the two pads */
1727 result = gst_pad_link_prepare (srcpad, sinkpad);
1729 if (result != GST_PAD_LINK_OK)
1730 goto prepare_failed;
1732 GST_OBJECT_UNLOCK (sinkpad);
1733 GST_OBJECT_UNLOCK (srcpad);
1735 /* FIXME released the locks here, concurrent thread might link
1736 * something else. */
1737 if (GST_PAD_LINKFUNC (srcpad)) {
1738 /* this one will call the peer link function */
1739 result = GST_PAD_LINKFUNC (srcpad) (srcpad, sinkpad);
1740 } else if (GST_PAD_LINKFUNC (sinkpad)) {
1741 /* if no source link function, we need to call the sink link
1742 * function ourselves. */
1743 result = GST_PAD_LINKFUNC (sinkpad) (sinkpad, srcpad);
1745 result = GST_PAD_LINK_OK;
1748 GST_OBJECT_LOCK (srcpad);
1749 GST_OBJECT_LOCK (sinkpad);
1751 if (result == GST_PAD_LINK_OK) {
1752 GST_PAD_PEER (srcpad) = sinkpad;
1753 GST_PAD_PEER (sinkpad) = srcpad;
1755 GST_OBJECT_UNLOCK (sinkpad);
1756 GST_OBJECT_UNLOCK (srcpad);
1758 /* fire off a signal to each of the pads telling them
1759 * that they've been linked */
1760 g_signal_emit (G_OBJECT (srcpad), gst_pad_signals[PAD_LINKED], 0, sinkpad);
1761 g_signal_emit (G_OBJECT (sinkpad), gst_pad_signals[PAD_LINKED], 0, srcpad);
1763 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
1764 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1766 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed",
1767 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1769 GST_OBJECT_UNLOCK (sinkpad);
1770 GST_OBJECT_UNLOCK (srcpad);
1781 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
1783 /* this function would need checks if it weren't static */
1785 GST_OBJECT_LOCK (pad);
1786 gst_object_replace ((GstObject **) & pad->padtemplate, (GstObject *) templ);
1787 GST_OBJECT_UNLOCK (pad);
1790 gst_pad_template_pad_created (templ, pad);
1794 * gst_pad_get_pad_template:
1797 * Gets the template for @pad.
1799 * Returns: the #GstPadTemplate from which this pad was instantiated, or %NULL
1800 * if this pad has no template.
1802 * FIXME: currently returns an unrefcounted padtemplate.
1805 gst_pad_get_pad_template (GstPad * pad)
1807 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1809 return GST_PAD_PAD_TEMPLATE (pad);
1813 /* should be called with the pad LOCK held */
1814 /* refs the caps, so caller is responsible for getting it unreffed */
1816 gst_pad_get_caps_unlocked (GstPad * pad)
1818 GstCaps *result = NULL;
1820 GST_CAT_DEBUG (GST_CAT_CAPS, "get pad caps of %s:%s (%p)",
1821 GST_DEBUG_PAD_NAME (pad), pad);
1823 if (GST_PAD_GETCAPSFUNC (pad)) {
1824 GST_CAT_DEBUG (GST_CAT_CAPS, "dispatching to pad getcaps function");
1826 GST_OBJECT_FLAG_SET (pad, GST_PAD_IN_GETCAPS);
1827 GST_OBJECT_UNLOCK (pad);
1828 result = GST_PAD_GETCAPSFUNC (pad) (pad);
1829 GST_OBJECT_LOCK (pad);
1830 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_IN_GETCAPS);
1832 if (result == NULL) {
1833 g_critical ("pad %s:%s returned NULL caps from getcaps function",
1834 GST_DEBUG_PAD_NAME (pad));
1836 GST_CAT_DEBUG (GST_CAT_CAPS,
1837 "pad getcaps %s:%s returned %" GST_PTR_FORMAT,
1838 GST_DEBUG_PAD_NAME (pad), result);
1839 #ifndef G_DISABLE_ASSERT
1840 /* check that the returned caps are a real subset of the template caps */
1841 if (GST_PAD_PAD_TEMPLATE (pad)) {
1842 const GstCaps *templ_caps =
1843 GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
1844 if (!gst_caps_is_subset (result, templ_caps)) {
1847 GST_CAT_ERROR_OBJECT (GST_CAT_CAPS, pad,
1848 "pad returned caps %" GST_PTR_FORMAT
1849 " which are not a real subset of its template caps %"
1850 GST_PTR_FORMAT, result, templ_caps);
1852 ("pad %s:%s returned caps that are not a real subset of its template caps",
1853 GST_DEBUG_PAD_NAME (pad));
1854 temp = gst_caps_intersect (templ_caps, result);
1855 gst_caps_unref (result);
1863 if (GST_PAD_PAD_TEMPLATE (pad)) {
1864 GstPadTemplate *templ = GST_PAD_PAD_TEMPLATE (pad);
1866 result = GST_PAD_TEMPLATE_CAPS (templ);
1867 GST_CAT_DEBUG (GST_CAT_CAPS,
1868 "using pad template %p with caps %p %" GST_PTR_FORMAT, templ, result,
1871 result = gst_caps_ref (result);
1874 if (GST_PAD_CAPS (pad)) {
1875 result = GST_PAD_CAPS (pad);
1877 GST_CAT_DEBUG (GST_CAT_CAPS,
1878 "using pad caps %p %" GST_PTR_FORMAT, result, result);
1880 result = gst_caps_ref (result);
1884 GST_CAT_DEBUG (GST_CAT_CAPS, "pad has no caps");
1885 result = gst_caps_new_empty ();
1893 * @pad: a #GstPad to get the capabilities of.
1895 * Gets the capabilities this pad can produce or consume.
1896 * Note that this method doesn't necessarily returns the caps set by
1897 * gst_pad_set_caps() - use #GST_PAD_CAPS for that instead.
1898 * gst_pad_get_caps returns all possible caps a pad can operate with, using
1899 * the pad's get_caps function;
1900 * this returns the pad template caps if not explicitly set.
1902 * Returns: a newly allocated copy of the #GstCaps of this pad.
1907 gst_pad_get_caps (GstPad * pad)
1909 GstCaps *result = NULL;
1911 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1913 GST_OBJECT_LOCK (pad);
1915 GST_CAT_DEBUG (GST_CAT_CAPS, "get pad caps of %s:%s (%p)",
1916 GST_DEBUG_PAD_NAME (pad), pad);
1918 result = gst_pad_get_caps_unlocked (pad);
1919 GST_OBJECT_UNLOCK (pad);
1925 * gst_pad_peer_get_caps:
1926 * @pad: a #GstPad to get the peer capabilities of.
1928 * Gets the capabilities of the peer connected to this pad.
1930 * Returns: the #GstCaps of the peer pad. This function returns a new caps, so use
1931 * gst_caps_unref to get rid of it. this function returns NULL if there is no
1935 gst_pad_peer_get_caps (GstPad * pad)
1938 GstCaps *result = NULL;
1940 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1942 GST_OBJECT_LOCK (pad);
1944 GST_CAT_DEBUG (GST_CAT_CAPS, "get peer caps of %s:%s (%p)",
1945 GST_DEBUG_PAD_NAME (pad), pad);
1947 peerpad = GST_PAD_PEER (pad);
1948 if (G_UNLIKELY (peerpad == NULL))
1951 gst_object_ref (peerpad);
1952 GST_OBJECT_UNLOCK (pad);
1954 result = gst_pad_get_caps (peerpad);
1956 gst_object_unref (peerpad);
1962 GST_OBJECT_UNLOCK (pad);
1968 fixate_value (GValue * dest, const GValue * src)
1970 if (G_VALUE_TYPE (src) == GST_TYPE_INT_RANGE) {
1971 g_value_init (dest, G_TYPE_INT);
1972 g_value_set_int (dest, gst_value_get_int_range_min (src));
1973 } else if (G_VALUE_TYPE (src) == GST_TYPE_DOUBLE_RANGE) {
1974 g_value_init (dest, G_TYPE_DOUBLE);
1975 g_value_set_double (dest, gst_value_get_double_range_min (src));
1976 } else if (G_VALUE_TYPE (src) == GST_TYPE_FRACTION_RANGE) {
1977 gst_value_init_and_copy (dest, gst_value_get_fraction_range_min (src));
1978 } else if (G_VALUE_TYPE (src) == GST_TYPE_LIST) {
1979 GValue temp = { 0 };
1981 gst_value_init_and_copy (&temp, gst_value_list_get_value (src, 0));
1982 if (!fixate_value (dest, &temp))
1983 gst_value_init_and_copy (dest, &temp);
1984 g_value_unset (&temp);
1985 } else if (G_VALUE_TYPE (src) == GST_TYPE_ARRAY) {
1986 gboolean res = FALSE;
1989 g_value_init (dest, GST_TYPE_ARRAY);
1990 for (n = 0; n < gst_value_array_get_size (src); n++) {
1992 const GValue *orig_kid = gst_value_array_get_value (src, n);
1994 if (!fixate_value (&kid, orig_kid))
1995 gst_value_init_and_copy (&kid, orig_kid);
1998 gst_value_array_append_value (dest, &kid);
1999 g_value_unset (&kid);
2003 g_value_unset (dest);
2014 gst_pad_default_fixate (GQuark field_id, const GValue * value, gpointer data)
2016 GstStructure *s = data;
2019 if (fixate_value (&v, value)) {
2020 gst_structure_id_set_value (s, field_id, &v);
2028 * gst_pad_fixate_caps:
2029 * @pad: a #GstPad to fixate
2030 * @caps: the #GstCaps to fixate
2032 * Fixate a caps on the given pad. Modifies the caps in place, so you should
2033 * make sure that the caps are actually writable (see gst_caps_make_writable()).
2036 gst_pad_fixate_caps (GstPad * pad, GstCaps * caps)
2038 GstPadFixateCapsFunction fixatefunc;
2041 g_return_if_fail (GST_IS_PAD (pad));
2042 g_return_if_fail (caps != NULL);
2044 if (gst_caps_is_fixed (caps))
2047 fixatefunc = GST_PAD_FIXATECAPSFUNC (pad);
2049 fixatefunc (pad, caps);
2052 /* default fixation */
2053 for (n = 0; n < gst_caps_get_size (caps); n++) {
2054 GstStructure *s = gst_caps_get_structure (caps, n);
2056 gst_structure_foreach (s, gst_pad_default_fixate, s);
2060 /* Default accept caps implementation just checks against
2061 * against the allowed caps for the pad */
2063 gst_pad_acceptcaps_default (GstPad * pad, GstCaps * caps)
2065 /* get the caps and see if it intersects to something
2069 gboolean result = FALSE;
2071 allowed = gst_pad_get_caps (pad);
2073 intersect = gst_caps_intersect (allowed, caps);
2075 result = !gst_caps_is_empty (intersect);
2077 gst_caps_unref (allowed);
2078 gst_caps_unref (intersect);
2085 * gst_pad_accept_caps:
2086 * @pad: a #GstPad to check
2087 * @caps: a #GstCaps to check on the pad
2089 * Check if the given pad accepts the caps.
2091 * Returns: TRUE if the pad can accept the caps.
2094 gst_pad_accept_caps (GstPad * pad, GstCaps * caps)
2097 GstPadAcceptCapsFunction acceptfunc;
2098 GstCaps *existing = NULL;
2100 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2102 /* any pad can be unnegotiated */
2106 GST_OBJECT_LOCK (pad);
2107 acceptfunc = GST_PAD_ACCEPTCAPSFUNC (pad);
2108 if (GST_PAD_CAPS (pad) != NULL)
2109 existing = gst_caps_ref (GST_PAD_CAPS (pad));
2111 GST_CAT_DEBUG (GST_CAT_CAPS, "pad accept caps of %s:%s (%p)",
2112 GST_DEBUG_PAD_NAME (pad), pad);
2113 GST_OBJECT_UNLOCK (pad);
2115 /* The current caps on a pad are trivially acceptable */
2116 if (existing && (caps == existing || gst_caps_is_equal (caps, existing)))
2119 if (G_LIKELY (acceptfunc)) {
2120 /* we can call the function */
2121 result = acceptfunc (pad, caps);
2123 /* Only null if the element explicitly unset it */
2124 result = gst_pad_acceptcaps_default (pad, caps);
2129 gst_caps_unref (existing);
2134 * gst_pad_peer_accept_caps:
2135 * @pad: a #GstPad to check
2136 * @caps: a #GstCaps to check on the pad
2138 * Check if the given pad accepts the caps.
2140 * Returns: TRUE if the pad can accept the caps.
2143 gst_pad_peer_accept_caps (GstPad * pad, GstCaps * caps)
2148 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2150 GST_OBJECT_LOCK (pad);
2152 GST_CAT_DEBUG (GST_CAT_CAPS, "peer accept caps of %s:%s (%p)",
2153 GST_DEBUG_PAD_NAME (pad), pad);
2155 peerpad = GST_PAD_PEER (pad);
2156 if (G_UNLIKELY (peerpad == NULL))
2159 result = gst_pad_accept_caps (peerpad, caps);
2160 GST_OBJECT_UNLOCK (pad);
2166 GST_OBJECT_UNLOCK (pad);
2173 * @pad: a #GstPad to set the capabilities of.
2174 * @caps: a #GstCaps to set.
2176 * Sets the capabilities of this pad. The caps must be fixed. Any previous
2177 * caps on the pad will be unreffed. This function refs the caps so you should
2178 * unref if as soon as you don't need it anymore.
2179 * It is possible to set NULL caps, which will make the pad unnegotiated
2182 * Returns: TRUE if the caps could be set. FALSE if the caps were not fixed
2183 * or bad parameters were provided to this function.
2188 gst_pad_set_caps (GstPad * pad, GstCaps * caps)
2190 GstPadSetCapsFunction setcaps;
2193 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2194 g_return_val_if_fail (caps == NULL || gst_caps_is_fixed (caps), FALSE);
2196 GST_OBJECT_LOCK (pad);
2197 setcaps = GST_PAD_SETCAPSFUNC (pad);
2199 existing = GST_PAD_CAPS (pad);
2200 if (gst_caps_is_equal (caps, existing))
2201 goto setting_same_caps;
2203 /* call setcaps function to configure the pad only if the
2204 * caps is not NULL */
2205 if (setcaps != NULL && caps) {
2206 if (!GST_PAD_IS_IN_SETCAPS (pad)) {
2207 GST_OBJECT_FLAG_SET (pad, GST_PAD_IN_SETCAPS);
2208 GST_OBJECT_UNLOCK (pad);
2209 if (!setcaps (pad, caps))
2211 GST_OBJECT_LOCK (pad);
2212 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_IN_SETCAPS);
2214 GST_CAT_DEBUG (GST_CAT_CAPS, "pad %s:%s was dispatching",
2215 GST_DEBUG_PAD_NAME (pad));
2219 gst_caps_replace (&GST_PAD_CAPS (pad), caps);
2220 GST_CAT_DEBUG (GST_CAT_CAPS, "%s:%s caps %" GST_PTR_FORMAT,
2221 GST_DEBUG_PAD_NAME (pad), caps);
2222 GST_OBJECT_UNLOCK (pad);
2224 g_object_notify (G_OBJECT (pad), "caps");
2230 gst_caps_replace (&GST_PAD_CAPS (pad), caps);
2231 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2232 "caps %" GST_PTR_FORMAT " same as existing, updating ptr only", caps);
2233 GST_OBJECT_UNLOCK (pad);
2240 GST_OBJECT_LOCK (pad);
2241 GST_OBJECT_FLAG_UNSET (pad, GST_PAD_IN_SETCAPS);
2242 GST_CAT_DEBUG (GST_CAT_CAPS,
2243 "pad %s:%s, caps %" GST_PTR_FORMAT " could not be set",
2244 GST_DEBUG_PAD_NAME (pad), caps);
2245 GST_OBJECT_UNLOCK (pad);
2252 gst_pad_configure_sink (GstPad * pad, GstCaps * caps)
2254 GstPadSetCapsFunction setcaps;
2257 setcaps = GST_PAD_SETCAPSFUNC (pad);
2259 /* See if pad accepts the caps - only needed if
2260 * no setcaps function */
2261 if (setcaps == NULL)
2262 if (!gst_pad_accept_caps (pad, caps))
2265 /* set caps on pad if call succeeds */
2266 res = gst_pad_set_caps (pad, caps);
2267 /* no need to unref the caps here, set_caps takes a ref and
2268 * our ref goes away when we leave this function. */
2274 GST_CAT_DEBUG (GST_CAT_CAPS, "caps %" GST_PTR_FORMAT " not accepted", caps);
2279 /* returns TRUE if the src pad could be configured to accept the given caps */
2281 gst_pad_configure_src (GstPad * pad, GstCaps * caps, gboolean dosetcaps)
2283 GstPadSetCapsFunction setcaps;
2286 setcaps = GST_PAD_SETCAPSFUNC (pad);
2288 /* See if pad accepts the caps - only needed if
2289 * no setcaps function */
2290 if (setcaps == NULL)
2291 if (!gst_pad_accept_caps (pad, caps))
2295 res = gst_pad_set_caps (pad, caps);
2303 GST_CAT_DEBUG (GST_CAT_CAPS, "caps %" GST_PTR_FORMAT " not accepted", caps);
2309 * gst_pad_get_pad_template_caps:
2310 * @pad: a #GstPad to get the template capabilities from.
2312 * Gets the capabilities for @pad's template.
2314 * Returns: the #GstCaps of this pad template. If you intend to keep a reference
2315 * on the caps, make a copy (see gst_caps_copy ()).
2318 gst_pad_get_pad_template_caps (GstPad * pad)
2320 static GstStaticCaps anycaps = GST_STATIC_CAPS ("ANY");
2322 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2324 if (GST_PAD_PAD_TEMPLATE (pad))
2325 return GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
2327 return gst_static_caps_get (&anycaps);
2333 * @pad: a #GstPad to get the peer of.
2335 * Gets the peer of @pad. This function refs the peer pad so
2336 * you need to unref it after use.
2338 * Returns: the peer #GstPad. Unref after usage.
2343 gst_pad_get_peer (GstPad * pad)
2347 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2349 GST_OBJECT_LOCK (pad);
2350 result = GST_PAD_PEER (pad);
2352 gst_object_ref (result);
2353 GST_OBJECT_UNLOCK (pad);
2359 * gst_pad_get_allowed_caps:
2360 * @srcpad: a #GstPad, it must a a source pad.
2362 * Gets the capabilities of the allowed media types that can flow through
2363 * @srcpad and its peer. The pad must be a source pad.
2364 * The caller must free the resulting caps.
2366 * Returns: the allowed #GstCaps of the pad link. Free the caps when
2367 * you no longer need it. This function returns NULL when the @srcpad has no
2373 gst_pad_get_allowed_caps (GstPad * srcpad)
2380 g_return_val_if_fail (GST_IS_PAD (srcpad), NULL);
2381 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), NULL);
2383 GST_OBJECT_LOCK (srcpad);
2385 peer = GST_PAD_PEER (srcpad);
2386 if (G_UNLIKELY (peer == NULL))
2389 GST_CAT_DEBUG (GST_CAT_PROPERTIES, "%s:%s: getting allowed caps",
2390 GST_DEBUG_PAD_NAME (srcpad));
2392 gst_object_ref (peer);
2393 GST_OBJECT_UNLOCK (srcpad);
2394 mycaps = gst_pad_get_caps (srcpad);
2396 peercaps = gst_pad_get_caps (peer);
2397 gst_object_unref (peer);
2399 caps = gst_caps_intersect (mycaps, peercaps);
2400 gst_caps_unref (peercaps);
2401 gst_caps_unref (mycaps);
2403 GST_CAT_DEBUG (GST_CAT_CAPS, "allowed caps %" GST_PTR_FORMAT, caps);
2409 GST_CAT_DEBUG (GST_CAT_PROPERTIES, "%s:%s: no peer",
2410 GST_DEBUG_PAD_NAME (srcpad));
2411 GST_OBJECT_UNLOCK (srcpad);
2418 * gst_pad_get_negotiated_caps:
2421 * Gets the capabilities of the media type that currently flows through @pad
2424 * This function can be used on both src and sinkpads. Note that srcpads are
2425 * always negotiated before sinkpads so it is possible that the negotiated caps
2426 * on the srcpad do not match the negotiated caps of the peer.
2428 * Returns: the negotiated #GstCaps of the pad link. Free the caps when
2429 * you no longer need it. This function returns NULL when the @pad has no
2430 * peer or is not negotiated yet.
2435 gst_pad_get_negotiated_caps (GstPad * pad)
2440 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2442 GST_OBJECT_LOCK (pad);
2444 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
2447 GST_CAT_DEBUG (GST_CAT_PROPERTIES, "%s:%s: getting negotiated caps",
2448 GST_DEBUG_PAD_NAME (pad));
2450 caps = GST_PAD_CAPS (pad);
2452 gst_caps_ref (caps);
2453 GST_OBJECT_UNLOCK (pad);
2455 GST_CAT_DEBUG (GST_CAT_CAPS, "negotiated caps %" GST_PTR_FORMAT, caps);
2461 GST_CAT_DEBUG (GST_CAT_PROPERTIES, "%s:%s: no peer",
2462 GST_DEBUG_PAD_NAME (pad));
2463 GST_OBJECT_UNLOCK (pad);
2469 static GstFlowReturn
2470 gst_pad_alloc_buffer_full (GstPad * pad, guint64 offset, gint size,
2471 GstCaps * caps, GstBuffer ** buf, gboolean setcaps)
2475 GstPadBufferAllocFunction bufferallocfunc;
2476 gboolean caps_changed;
2478 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
2479 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
2480 g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
2482 GST_OBJECT_LOCK (pad);
2483 while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
2484 if ((ret = handle_pad_block (pad)) != GST_FLOW_OK)
2487 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
2490 gst_object_ref (peer);
2491 GST_OBJECT_UNLOCK (pad);
2493 if (G_LIKELY ((bufferallocfunc = peer->bufferallocfunc) == NULL))
2496 GST_OBJECT_LOCK (peer);
2497 /* when the peer is flushing we cannot give a buffer */
2498 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (peer)))
2501 if (offset == GST_BUFFER_OFFSET_NONE) {
2502 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2503 "calling bufferallocfunc &%s (@%p) of peer pad %s:%s for size %d offset NONE",
2504 GST_DEBUG_FUNCPTR_NAME (bufferallocfunc),
2505 &bufferallocfunc, GST_DEBUG_PAD_NAME (peer), size);
2507 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2508 "calling bufferallocfunc &%s (@%p) of peer pad %s:%s for size %d offset %"
2509 G_GUINT64_FORMAT, GST_DEBUG_FUNCPTR_NAME (bufferallocfunc),
2510 &bufferallocfunc, GST_DEBUG_PAD_NAME (peer), size, offset);
2512 GST_OBJECT_UNLOCK (peer);
2514 ret = bufferallocfunc (peer, offset, size, caps, buf);
2516 if (G_UNLIKELY (ret != GST_FLOW_OK))
2518 if (G_UNLIKELY (*buf == NULL))
2521 /* If the buffer alloc function didn't set up the caps like it should,
2523 if (caps && (GST_BUFFER_CAPS (*buf) == NULL)) {
2524 GST_WARNING ("Buffer allocation function for pad % " GST_PTR_FORMAT
2525 " did not set up caps. Setting", peer);
2527 gst_buffer_set_caps (*buf, caps);
2531 gst_object_unref (peer);
2533 /* FIXME, move capnego this into a base class? */
2534 caps = GST_BUFFER_CAPS (*buf);
2535 caps_changed = caps && caps != GST_PAD_CAPS (pad);
2536 /* we got a new datatype on the pad, see if it can handle it */
2537 if (G_UNLIKELY (caps_changed)) {
2538 GST_DEBUG_OBJECT (pad, "caps changed to %" GST_PTR_FORMAT, caps);
2539 if (G_UNLIKELY (!gst_pad_configure_src (pad, caps, setcaps)))
2540 goto not_negotiated;
2546 GST_CAT_DEBUG (GST_CAT_PADS, "%s:%s pad block stopped by flush",
2547 GST_DEBUG_PAD_NAME (pad));
2548 GST_OBJECT_UNLOCK (pad);
2553 /* pad has no peer */
2554 GST_CAT_DEBUG (GST_CAT_PADS,
2555 "%s:%s called bufferallocfunc but had no peer",
2556 GST_DEBUG_PAD_NAME (pad));
2557 GST_OBJECT_UNLOCK (pad);
2558 return GST_FLOW_NOT_LINKED;
2562 /* peer was flushing */
2563 GST_OBJECT_UNLOCK (peer);
2564 gst_object_unref (peer);
2565 GST_CAT_DEBUG (GST_CAT_PADS,
2566 "%s:%s called bufferallocfunc but peer was flushing",
2567 GST_DEBUG_PAD_NAME (pad));
2568 return GST_FLOW_WRONG_STATE;
2570 /* fallback case, allocate a buffer of our own, add pad caps. */
2573 GST_CAT_DEBUG (GST_CAT_PADS,
2574 "%s:%s fallback buffer alloc", GST_DEBUG_PAD_NAME (pad));
2575 *buf = gst_buffer_new_and_alloc (size);
2576 GST_BUFFER_OFFSET (*buf) = offset;
2577 gst_buffer_set_caps (*buf, caps);
2585 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2586 "alloc function returned unacceptable buffer");
2587 return GST_FLOW_NOT_NEGOTIATED;
2591 gst_object_unref (peer);
2592 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2593 "alloc function returned error %s", gst_flow_get_name (ret));
2599 * gst_pad_alloc_buffer:
2600 * @pad: a source #GstPad
2601 * @offset: the offset of the new buffer in the stream
2602 * @size: the size of the new buffer
2603 * @caps: the caps of the new buffer
2604 * @buf: a newly allocated buffer
2606 * Allocates a new, empty buffer optimized to push to pad @pad. This
2607 * function only works if @pad is a source pad and has a peer.
2609 * You need to check the caps of the buffer after performing this
2610 * function and renegotiate to the format if needed.
2612 * A new, empty #GstBuffer will be put in the @buf argument.
2614 * Returns: a result code indicating success of the operation. Any
2615 * result code other than GST_FLOW_OK is an error and @buf should
2617 * An error can occur if the pad is not connected or when the downstream
2618 * peer elements cannot provide an acceptable buffer.
2623 gst_pad_alloc_buffer (GstPad * pad, guint64 offset, gint size, GstCaps * caps,
2626 return gst_pad_alloc_buffer_full (pad, offset, size, caps, buf, FALSE);
2630 * gst_pad_alloc_buffer_and_set_caps:
2631 * @pad: a source #GstPad
2632 * @offset: the offset of the new buffer in the stream
2633 * @size: the size of the new buffer
2634 * @caps: the caps of the new buffer
2635 * @buf: a newly allocated buffer
2637 * In addition to the function gst_pad_alloc_buffer(), this function
2638 * automatically calls gst_pad_set_caps() when the caps of the
2639 * newly allocated buffer are different from the @pad caps.
2641 * Returns: a result code indicating success of the operation. Any
2642 * result code other than GST_FLOW_OK is an error and @buf should
2644 * An error can occur if the pad is not connected or when the downstream
2645 * peer elements cannot provide an acceptable buffer.
2650 gst_pad_alloc_buffer_and_set_caps (GstPad * pad, guint64 offset, gint size,
2651 GstCaps * caps, GstBuffer ** buf)
2653 return gst_pad_alloc_buffer_full (pad, offset, size, caps, buf, TRUE);
2657 * gst_pad_get_internal_links_default:
2658 * @pad: the #GstPad to get the internal links of.
2660 * Gets a list of pads to which the given pad is linked to
2661 * inside of the parent element.
2662 * This is the default handler, and thus returns a list of all of the
2663 * pads inside the parent element with opposite direction.
2664 * The caller must free this list after use.
2666 * Returns: a newly allocated #GList of pads, or NULL if the pad has no parent.
2671 gst_pad_get_internal_links_default (GstPad * pad)
2676 GstPadDirection direction;
2678 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2680 direction = pad->direction;
2682 parent = GST_PAD_PARENT (pad);
2686 parent_pads = parent->pads;
2688 while (parent_pads) {
2689 GstPad *parent_pad = GST_PAD_CAST (parent_pads->data);
2691 if (parent_pad->direction != direction) {
2692 res = g_list_prepend (res, parent_pad);
2695 parent_pads = g_list_next (parent_pads);
2702 * gst_pad_get_internal_links:
2703 * @pad: the #GstPad to get the internal links of.
2705 * Gets a list of pads to which the given pad is linked to
2706 * inside of the parent element.
2707 * The caller must free this list after use.
2709 * Returns: a newly allocated #GList of pads.
2714 gst_pad_get_internal_links (GstPad * pad)
2718 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2720 if (GST_PAD_INTLINKFUNC (pad))
2721 res = GST_PAD_INTLINKFUNC (pad) (pad);
2728 gst_pad_event_default_dispatch (GstPad * pad, GstEvent * event)
2733 GST_INFO_OBJECT (pad, "Sending event %p to all internally linked pads",
2736 result = (GST_PAD_DIRECTION (pad) == GST_PAD_SINK);
2738 orig = pads = gst_pad_get_internal_links (pad);
2741 GstPad *eventpad = GST_PAD_CAST (pads->data);
2743 pads = g_list_next (pads);
2745 if (GST_PAD_DIRECTION (eventpad) == GST_PAD_SRC) {
2746 /* for each pad we send to, we should ref the event; it's up
2747 * to downstream to unref again when handled. */
2748 GST_LOG_OBJECT (pad, "Reffing and sending event %p (%s) to %s:%s",
2749 event, GST_EVENT_TYPE_NAME (event), GST_DEBUG_PAD_NAME (eventpad));
2750 gst_event_ref (event);
2751 gst_pad_push_event (eventpad, event);
2753 /* we only send the event on one pad, multi-sinkpad elements
2754 * should implement a handler */
2755 GST_LOG_OBJECT (pad, "sending event %p (%s) to one sink pad %s:%s",
2756 event, GST_EVENT_TYPE_NAME (event), GST_DEBUG_PAD_NAME (eventpad));
2757 result = gst_pad_push_event (eventpad, event);
2761 /* we handled the incoming event so we unref once */
2762 GST_LOG_OBJECT (pad, "handled event %p, unreffing", event);
2763 gst_event_unref (event);
2772 * gst_pad_event_default:
2773 * @pad: a #GstPad to call the default event handler on.
2774 * @event: the #GstEvent to handle.
2776 * Invokes the default event handler for the given pad. End-of-stream and
2777 * discontinuity events are handled specially, and then the event is sent to all
2778 * pads internally linked to @pad. Note that if there are many possible sink
2779 * pads that are internally linked to @pad, only one will be sent an event.
2780 * Multi-sinkpad elements should implement custom event handlers.
2782 * Returns: TRUE if the event was sent succesfully.
2785 gst_pad_event_default (GstPad * pad, GstEvent * event)
2787 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2788 g_return_val_if_fail (event != NULL, FALSE);
2790 switch (GST_EVENT_TYPE (event)) {
2793 GST_DEBUG_OBJECT (pad, "pausing task because of eos");
2794 gst_pad_pause_task (pad);
2800 return gst_pad_event_default_dispatch (pad, event);
2804 * gst_pad_dispatcher:
2805 * @pad: a #GstPad to dispatch.
2806 * @dispatch: the #GstDispatcherFunction to call.
2807 * @data: gpointer user data passed to the dispatcher function.
2809 * Invokes the given dispatcher function on all pads that are
2810 * internally linked to the given pad.
2811 * The GstPadDispatcherFunction should return TRUE when no further pads
2812 * need to be processed.
2814 * Returns: TRUE if one of the dispatcher functions returned TRUE.
2817 gst_pad_dispatcher (GstPad * pad, GstPadDispatcherFunction dispatch,
2820 gboolean res = FALSE;
2821 GList *int_pads, *orig;
2823 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2824 g_return_val_if_fail (dispatch != NULL, FALSE);
2826 orig = int_pads = gst_pad_get_internal_links (pad);
2829 GstPad *int_pad = GST_PAD_CAST (int_pads->data);
2830 GstPad *int_peer = GST_PAD_PEER (int_pad);
2833 res = dispatch (int_peer, data);
2837 int_pads = g_list_next (int_pads);
2847 * @pad: a #GstPad to invoke the default query on.
2848 * @query: the #GstQuery to perform.
2850 * Dispatches a query to a pad. The query should have been allocated by the
2851 * caller via one of the type-specific allocation functions in gstquery.h. The
2852 * element is responsible for filling the query with an appropriate response,
2853 * which should then be parsed with a type-specific query parsing function.
2855 * Again, the caller is responsible for both the allocation and deallocation of
2856 * the query structure.
2858 * Returns: TRUE if the query could be performed.
2861 gst_pad_query (GstPad * pad, GstQuery * query)
2863 GstPadQueryFunction func;
2865 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2866 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2868 GST_DEBUG ("sending query %p to pad %s:%s", query, GST_DEBUG_PAD_NAME (pad));
2870 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
2873 return func (pad, query);
2877 GST_DEBUG ("pad had no query function");
2883 * gst_pad_query_default:
2884 * @pad: a #GstPad to call the default query handler on.
2885 * @query: the #GstQuery to handle.
2887 * Invokes the default query handler for the given pad.
2888 * The query is sent to all pads internally linked to @pad. Note that
2889 * if there are many possible sink pads that are internally linked to
2890 * @pad, only one will be sent the query.
2891 * Multi-sinkpad elements should implement custom query handlers.
2893 * Returns: TRUE if the query was performed succesfully.
2896 gst_pad_query_default (GstPad * pad, GstQuery * query)
2898 switch (GST_QUERY_TYPE (query)) {
2899 case GST_QUERY_POSITION:
2900 case GST_QUERY_SEEKING:
2901 case GST_QUERY_FORMATS:
2902 case GST_QUERY_LATENCY:
2903 case GST_QUERY_JITTER:
2904 case GST_QUERY_RATE:
2905 case GST_QUERY_CONVERT:
2907 return gst_pad_dispatcher
2908 (pad, (GstPadDispatcherFunction) gst_pad_query, query);
2912 #ifndef GST_DISABLE_LOADSAVE
2913 /* FIXME: why isn't this on a GstElement ? */
2915 * gst_pad_load_and_link:
2916 * @self: an #xmlNodePtr to read the description from.
2917 * @parent: the #GstObject element that owns the pad.
2919 * Reads the pad definition from the XML node and links the given pad
2920 * in the element to a pad of an element up in the hierarchy.
2923 gst_pad_load_and_link (xmlNodePtr self, GstObject * parent)
2925 xmlNodePtr field = self->xmlChildrenNode;
2926 GstPad *pad = NULL, *targetpad;
2930 GstObject *grandparent;
2934 if (!strcmp ((char *) field->name, "name")) {
2935 name = (gchar *) xmlNodeGetContent (field);
2936 pad = gst_element_get_pad (GST_ELEMENT (parent), name);
2938 } else if (!strcmp ((char *) field->name, "peer")) {
2939 peer = (gchar *) xmlNodeGetContent (field);
2941 field = field->next;
2943 g_return_if_fail (pad != NULL);
2948 split = g_strsplit (peer, ".", 2);
2950 if (split[0] == NULL || split[1] == NULL) {
2951 GST_CAT_DEBUG (GST_CAT_XML,
2952 "Could not parse peer '%s' for pad %s:%s, leaving unlinked",
2953 peer, GST_DEBUG_PAD_NAME (pad));
2960 g_return_if_fail (split[0] != NULL);
2961 g_return_if_fail (split[1] != NULL);
2963 grandparent = gst_object_get_parent (parent);
2965 if (grandparent && GST_IS_BIN (grandparent)) {
2966 target = gst_bin_get_by_name_recurse_up (GST_BIN (grandparent), split[0]);
2973 targetpad = gst_element_get_pad (target, split[1]);
2975 if (targetpad == NULL)
2978 gst_pad_link (pad, targetpad);
2985 * gst_pad_save_thyself:
2986 * @pad: a #GstPad to save.
2987 * @parent: the parent #xmlNodePtr to save the description in.
2989 * Saves the pad into an xml representation.
2991 * Returns: the #xmlNodePtr representation of the pad.
2994 gst_pad_save_thyself (GstObject * object, xmlNodePtr parent)
2999 g_return_val_if_fail (GST_IS_PAD (object), NULL);
3001 pad = GST_PAD (object);
3003 xmlNewChild (parent, NULL, (xmlChar *) "name",
3004 (xmlChar *) GST_PAD_NAME (pad));
3005 if (GST_PAD_PEER (pad) != NULL) {
3008 peer = GST_PAD_PEER (pad);
3009 /* first check to see if the peer's parent's parent is the same */
3010 /* we just save it off */
3011 content = g_strdup_printf ("%s.%s",
3012 GST_OBJECT_NAME (GST_PAD_PARENT (peer)), GST_PAD_NAME (peer));
3013 xmlNewChild (parent, NULL, (xmlChar *) "peer", (xmlChar *) content);
3016 xmlNewChild (parent, NULL, (xmlChar *) "peer", NULL);
3023 * gst_ghost_pad_save_thyself:
3024 * @pad: a ghost #GstPad to save.
3025 * @parent: the parent #xmlNodePtr to save the description in.
3027 * Saves the ghost pad into an xml representation.
3029 * Returns: the #xmlNodePtr representation of the pad.
3032 gst_ghost_pad_save_thyself (GstPad * pad, xmlNodePtr parent)
3036 g_return_val_if_fail (GST_IS_GHOST_PAD (pad), NULL);
3038 self = xmlNewChild (parent, NULL, (xmlChar *) "ghostpad", NULL);
3039 xmlNewChild (self, NULL, (xmlChar *) "name", (xmlChar *) GST_PAD_NAME (pad));
3040 xmlNewChild (self, NULL, (xmlChar *) "parent",
3041 (xmlChar *) GST_OBJECT_NAME (GST_PAD_PARENT (pad)));
3043 /* FIXME FIXME FIXME! */
3048 #endif /* GST_DISABLE_LOADSAVE */
3051 * should be called with pad lock held
3055 static GstFlowReturn
3056 handle_pad_block (GstPad * pad)
3058 GstPadBlockCallback callback;
3060 GstFlowReturn ret = GST_FLOW_OK;
3062 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3063 "signal block taken on pad %s:%s", GST_DEBUG_PAD_NAME (pad));
3065 /* need to grab extra ref for the callbacks */
3066 gst_object_ref (pad);
3068 callback = pad->block_callback;
3070 user_data = pad->block_data;
3071 GST_OBJECT_UNLOCK (pad);
3072 callback (pad, TRUE, user_data);
3073 GST_OBJECT_LOCK (pad);
3075 GST_PAD_BLOCK_SIGNAL (pad);
3078 while (GST_PAD_IS_BLOCKED (pad)) {
3079 if (GST_PAD_IS_FLUSHING (pad))
3081 GST_PAD_BLOCK_WAIT (pad);
3082 if (GST_PAD_IS_FLUSHING (pad))
3086 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got unblocked");
3088 callback = pad->block_callback;
3090 user_data = pad->block_data;
3091 GST_OBJECT_UNLOCK (pad);
3092 callback (pad, FALSE, user_data);
3093 GST_OBJECT_LOCK (pad);
3095 GST_PAD_BLOCK_SIGNAL (pad);
3098 gst_object_unref (pad);
3104 gst_object_unref (pad);
3105 return GST_FLOW_WRONG_STATE;
3109 /**********************************************************************
3110 * Data passing functions
3114 gst_pad_emit_have_data_signal (GstPad * pad, GstMiniObject * obj)
3117 GValue args[2] = { {0}, {0} };
3122 g_value_init (&ret, G_TYPE_BOOLEAN);
3123 g_value_set_boolean (&ret, TRUE);
3124 g_value_init (&args[0], GST_TYPE_PAD);
3125 g_value_set_object (&args[0], pad);
3126 g_value_init (&args[1], GST_TYPE_MINI_OBJECT); // G_TYPE_POINTER);
3127 gst_value_set_mini_object (&args[1], obj);
3129 if (GST_IS_EVENT (obj))
3130 detail = event_quark;
3132 detail = buffer_quark;
3135 g_signal_emitv (args, gst_pad_signals[PAD_HAVE_DATA], detail, &ret);
3136 res = g_value_get_boolean (&ret);
3139 g_value_unset (&ret);
3140 g_value_unset (&args[0]);
3141 g_value_unset (&args[1]);
3148 * @pad: a sink #GstPad.
3149 * @buffer: the #GstBuffer to send.
3151 * Chain a buffer to @pad.
3153 * Returns: a #GstFlowReturn from the pad.
3158 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
3161 gboolean caps_changed;
3162 GstPadChainFunction chainfunc;
3164 gboolean emit_signal;
3166 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3167 g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK,
3169 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3170 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3172 GST_PAD_STREAM_LOCK (pad);
3174 GST_OBJECT_LOCK (pad);
3175 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3178 caps = GST_BUFFER_CAPS (buffer);
3179 caps_changed = caps && caps != GST_PAD_CAPS (pad);
3181 emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
3182 GST_OBJECT_UNLOCK (pad);
3184 /* see if the signal should be emited, we emit before caps nego as
3185 * we might drop the buffer and do capsnego for nothing. */
3186 if (G_UNLIKELY (emit_signal)) {
3187 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (buffer)))
3191 /* we got a new datatype on the pad, see if it can handle it */
3192 if (G_UNLIKELY (caps_changed)) {
3193 GST_DEBUG_OBJECT (pad, "caps changed to %" GST_PTR_FORMAT, caps);
3194 if (G_UNLIKELY (!gst_pad_configure_sink (pad, caps)))
3195 goto not_negotiated;
3198 /* NOTE: we read the chainfunc unlocked.
3199 * we cannot hold the lock for the pad so we might send
3200 * the data to the wrong function. This is not really a
3201 * problem since functions are assigned at creation time
3202 * and don't change that often... */
3203 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3206 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3207 "calling chainfunction &%s of pad %s:%s",
3208 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_DEBUG_PAD_NAME (pad));
3210 ret = chainfunc (pad, buffer);
3212 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3213 "called chainfunction &%s of pad %s:%s, returned %s",
3214 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_DEBUG_PAD_NAME (pad),
3215 gst_flow_get_name (ret));
3217 GST_PAD_STREAM_UNLOCK (pad);
3224 gst_buffer_unref (buffer);
3225 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3226 "pushing, but pad was flushing");
3227 GST_OBJECT_UNLOCK (pad);
3228 GST_PAD_STREAM_UNLOCK (pad);
3229 return GST_FLOW_WRONG_STATE;
3233 gst_buffer_unref (buffer);
3234 GST_DEBUG_OBJECT (pad, "Dropping buffer due to FALSE probe return");
3235 GST_PAD_STREAM_UNLOCK (pad);
3240 gst_buffer_unref (buffer);
3241 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3242 "pushing buffer but pad did not accept");
3243 GST_PAD_STREAM_UNLOCK (pad);
3244 return GST_FLOW_NOT_NEGOTIATED;
3248 gst_buffer_unref (buffer);
3249 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3250 "pushing, but not chainhandler");
3251 GST_ELEMENT_ERROR (GST_PAD_PARENT (pad), CORE, PAD, (NULL),
3252 ("push on pad %s:%s but it has no chainfunction",
3253 GST_DEBUG_PAD_NAME (pad)));
3254 GST_PAD_STREAM_UNLOCK (pad);
3255 return GST_FLOW_ERROR;
3261 * @pad: a source #GstPad.
3262 * @buffer: the #GstBuffer to push.
3264 * Pushes a buffer to the peer of @pad.
3265 * buffer probes will be triggered before the buffer gets pushed.
3267 * Returns: a #GstFlowReturn from the peer pad.
3272 gst_pad_push (GstPad * pad, GstBuffer * buffer)
3277 gboolean caps_changed;
3279 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3280 g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC, GST_FLOW_ERROR);
3281 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3282 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3284 GST_OBJECT_LOCK (pad);
3286 /* FIXME: this check can go away; pad_set_blocked could be implemented with
3287 * probes completely */
3288 while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
3289 if ((ret = handle_pad_block (pad)) != GST_FLOW_OK)
3292 /* we emit signals on the pad arg, the peer will have a chance to
3293 * emit in the _chain() function */
3294 if (G_UNLIKELY (GST_PAD_DO_BUFFER_SIGNALS (pad) > 0)) {
3295 /* unlock before emitting */
3296 GST_OBJECT_UNLOCK (pad);
3298 /* if the signal handler returned FALSE, it means we should just drop the
3300 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (buffer)))
3303 GST_OBJECT_LOCK (pad);
3306 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3308 gst_object_ref (peer);
3310 /* Before pushing the buffer to the peer pad, ensure that caps
3311 * are set on this pad */
3312 caps = GST_BUFFER_CAPS (buffer);
3313 caps_changed = caps && caps != GST_PAD_CAPS (pad);
3315 GST_OBJECT_UNLOCK (pad);
3317 /* we got a new datatype from the pad, it had better handle it */
3318 if (G_UNLIKELY (caps_changed)) {
3319 GST_DEBUG_OBJECT (pad, "caps changed to %" GST_PTR_FORMAT, caps);
3320 if (G_UNLIKELY (!gst_pad_configure_src (pad, caps, TRUE)))
3321 goto not_negotiated;
3324 ret = gst_pad_chain (peer, buffer);
3326 gst_object_unref (peer);
3330 /* ERROR recovery here */
3333 gst_buffer_unref (buffer);
3334 GST_DEBUG_OBJECT (pad, "pad block stopped by flush");
3335 GST_OBJECT_UNLOCK (pad);
3340 gst_buffer_unref (buffer);
3341 GST_DEBUG_OBJECT (pad, "Dropping buffer due to FALSE probe return");
3346 gst_buffer_unref (buffer);
3347 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3348 "pushing, but it was not linked");
3349 GST_OBJECT_UNLOCK (pad);
3350 return GST_FLOW_NOT_LINKED;
3354 GST_CAT_DEBUG_OBJECT (GST_CAT_SCHEDULING, pad,
3355 "element pushed buffer then refused to accept the caps");
3356 return GST_FLOW_NOT_NEGOTIATED;
3361 * gst_pad_check_pull_range:
3362 * @pad: a sink #GstPad.
3364 * Checks if a gst_pad_pull_range() can be performed on the peer
3365 * source pad. This function is used by plugins that want to check
3366 * if they can use random access on the peer source pad.
3368 * The peer sourcepad can implement a custom #GstPadCheckGetRangeFunction
3369 * if it needs to perform some logic to determine if pull_range is
3372 * Returns: a gboolean with the result.
3377 gst_pad_check_pull_range (GstPad * pad)
3381 GstPadCheckGetRangeFunction checkgetrangefunc;
3383 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3385 GST_OBJECT_LOCK (pad);
3386 if (GST_PAD_DIRECTION (pad) != GST_PAD_SINK)
3387 goto wrong_direction;
3389 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3392 gst_object_ref (peer);
3393 GST_OBJECT_UNLOCK (pad);
3395 /* see note in above function */
3396 if (G_LIKELY ((checkgetrangefunc = peer->checkgetrangefunc) == NULL)) {
3397 /* FIXME, kindoff ghetto */
3398 ret = GST_PAD_GETRANGEFUNC (peer) != NULL;
3400 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3401 "calling checkgetrangefunc %s of peer pad %s:%s",
3402 GST_DEBUG_FUNCPTR_NAME (checkgetrangefunc), GST_DEBUG_PAD_NAME (peer));
3404 ret = checkgetrangefunc (peer);
3407 gst_object_unref (peer);
3411 /* ERROR recovery here */
3414 GST_OBJECT_UNLOCK (pad);
3419 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3420 "checking pull range, but it was not linked");
3421 GST_OBJECT_UNLOCK (pad);
3427 * gst_pad_get_range:
3428 * @pad: a src #GstPad.
3429 * @offset: The start offset of the buffer
3430 * @size: The length of the buffer
3431 * @buffer: a pointer to hold the #GstBuffer.
3433 * Calls the getrange function of @pad.
3435 * Returns: a #GstFlowReturn from the pad.
3440 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
3441 GstBuffer ** buffer)
3444 GstPadGetRangeFunction getrangefunc;
3445 gboolean emit_signal;
3447 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3448 g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC, GST_FLOW_ERROR);
3449 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3451 GST_PAD_STREAM_LOCK (pad);
3453 GST_OBJECT_LOCK (pad);
3454 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3457 emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
3458 GST_OBJECT_UNLOCK (pad);
3460 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
3463 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3464 "calling getrangefunc %s of peer pad %s:%s, offset %"
3465 G_GUINT64_FORMAT ", size %u",
3466 GST_DEBUG_FUNCPTR_NAME (getrangefunc), GST_DEBUG_PAD_NAME (pad),
3469 ret = getrangefunc (pad, offset, size, buffer);
3471 /* can only fire the signal if we have a valid buffer */
3472 if (G_UNLIKELY (emit_signal) && (ret == GST_FLOW_OK)) {
3473 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (*buffer)))
3477 GST_PAD_STREAM_UNLOCK (pad);
3484 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3485 "pulling range, but pad was flushing");
3486 GST_OBJECT_UNLOCK (pad);
3487 GST_PAD_STREAM_UNLOCK (pad);
3488 return GST_FLOW_WRONG_STATE;
3492 GST_ELEMENT_ERROR (GST_PAD_PARENT (pad), CORE, PAD, (NULL),
3493 ("pullrange on pad %s:%s but it has no getrangefunction",
3494 GST_DEBUG_PAD_NAME (pad)));
3495 GST_PAD_STREAM_UNLOCK (pad);
3496 return GST_FLOW_ERROR;
3500 GST_DEBUG ("Dropping data after FALSE probe return");
3501 GST_PAD_STREAM_UNLOCK (pad);
3502 gst_buffer_unref (*buffer);
3504 return GST_FLOW_UNEXPECTED;
3510 * gst_pad_pull_range:
3511 * @pad: a sink #GstPad.
3512 * @offset: The start offset of the buffer
3513 * @size: The length of the buffer
3514 * @buffer: a pointer to hold the #GstBuffer.
3516 * Pulls a buffer from the peer pad. @pad must be a linked
3519 * Returns: a #GstFlowReturn from the peer pad.
3524 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
3525 GstBuffer ** buffer)
3529 gboolean emit_signal;
3531 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3532 g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK,
3534 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3536 GST_OBJECT_LOCK (pad);
3538 while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
3539 handle_pad_block (pad);
3541 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3544 /* signal emision for the pad, peer has chance to emit when
3545 * we call _get_range() */
3546 emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
3548 gst_object_ref (peer);
3549 GST_OBJECT_UNLOCK (pad);
3551 ret = gst_pad_get_range (peer, offset, size, buffer);
3553 gst_object_unref (peer);
3555 /* can only fire the signal if we have a valid buffer */
3556 if (G_UNLIKELY (emit_signal) && (ret == GST_FLOW_OK)) {
3557 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (*buffer)))
3562 /* ERROR recovery here */
3565 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3566 "pulling range, but it was not linked");
3567 GST_OBJECT_UNLOCK (pad);
3568 return GST_FLOW_NOT_LINKED;
3572 GST_DEBUG ("Dropping data after FALSE probe return");
3573 gst_buffer_unref (*buffer);
3575 return GST_FLOW_UNEXPECTED;
3580 * gst_pad_push_event:
3581 * @pad: a #GstPad to push the event to.
3582 * @event: the #GstEvent to send to the pad.
3584 * Sends the event to the peer of the given pad. This function is
3585 * mainly used by elements to send events to their peer
3588 * This function takes owership of the provided event so you should
3589 * gst_event_ref() it if you want to reuse the event after this call.
3591 * Returns: TRUE if the event was handled.
3596 gst_pad_push_event (GstPad * pad, GstEvent * event)
3601 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3602 g_return_val_if_fail (event != NULL, FALSE);
3603 g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
3605 GST_OBJECT_LOCK (pad);
3606 switch (GST_EVENT_TYPE (event)) {
3607 case GST_EVENT_FLUSH_START:
3608 GST_PAD_SET_FLUSHING (pad);
3610 case GST_EVENT_FLUSH_STOP:
3611 GST_PAD_UNSET_FLUSHING (pad);
3617 if (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad))) {
3618 if (GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_START) {
3619 GST_PAD_BLOCK_SIGNAL (pad);
3623 if (G_UNLIKELY (GST_PAD_DO_EVENT_SIGNALS (pad) > 0)) {
3624 GST_OBJECT_UNLOCK (pad);
3626 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (event)))
3629 GST_OBJECT_LOCK (pad);
3631 peerpad = GST_PAD_PEER (pad);
3632 if (peerpad == NULL)
3635 GST_LOG_OBJECT (peerpad, "sending event on peerpad");
3636 gst_object_ref (peerpad);
3637 GST_OBJECT_UNLOCK (pad);
3639 result = gst_pad_send_event (peerpad, event);
3641 gst_object_unref (peerpad);
3642 GST_LOG_OBJECT (peerpad, "sent event on peerpad");
3646 /* ERROR handling */
3649 GST_DEBUG_OBJECT (pad, "Dropping event after FALSE probe return");
3650 gst_event_unref (event);
3655 gst_event_unref (event);
3656 GST_OBJECT_UNLOCK (pad);
3662 * gst_pad_send_event:
3663 * @pad: a #GstPad to send the event to.
3664 * @event: the #GstEvent to send to the pad.
3666 * Sends the event to the pad. This function can be used
3667 * by applications to send events in the pipeline.
3669 * If @pad is a source pad, @event should be an upstream event. If @pad is a
3670 * sink pad, @event should be a downstream event. For example, you would not
3671 * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
3672 * Furthermore, some downstream events have to be serialized with data flow,
3673 * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
3674 * the event needs to be serialized with data flow, this function will take the
3675 * pad's stream lock while calling its event function.
3677 * To find out whether an event type is upstream, downstream, or downstream and
3678 * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
3679 * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
3680 * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or plugin
3681 * doesn't need to bother itself with this information; the core handles all
3682 * necessary locks and checks.
3684 * This function takes owership of the provided event so you should
3685 * gst_event_ref() it if you want to reuse the event after this call.
3687 * Returns: TRUE if the event was handled.
3690 gst_pad_send_event (GstPad * pad, GstEvent * event)
3692 gboolean result = FALSE;
3693 GstPadEventFunction eventfunc;
3694 gboolean serialized, need_unlock = FALSE;
3696 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3697 g_return_val_if_fail (event != NULL, FALSE);
3699 GST_OBJECT_LOCK (pad);
3700 if (GST_PAD_IS_SINK (pad)) {
3701 if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
3702 goto wrong_direction;
3703 serialized = GST_EVENT_IS_SERIALIZED (event);
3704 } else if (GST_PAD_IS_SRC (pad)) {
3705 if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
3706 goto wrong_direction;
3707 /* events on srcpad never are serialized */
3710 goto unknown_direction;
3712 if (G_UNLIKELY (GST_EVENT_SRC (event) == NULL)) {
3713 GST_LOG_OBJECT (pad, "event had no source, setting pad as event source");
3714 GST_EVENT_SRC (event) = gst_object_ref (pad);
3718 if (G_UNLIKELY (GST_PAD_DO_EVENT_SIGNALS (pad) > 0)) {
3719 GST_OBJECT_UNLOCK (pad);
3721 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT_CAST (event)))
3724 GST_OBJECT_LOCK (pad);
3727 switch (GST_EVENT_TYPE (event)) {
3728 case GST_EVENT_FLUSH_START:
3729 GST_CAT_DEBUG (GST_CAT_EVENT,
3730 "have event type %d (FLUSH_START) on pad %s:%s",
3731 GST_EVENT_TYPE (event), GST_DEBUG_PAD_NAME (pad));
3733 /* can't even accept a flush begin event when flushing */
3734 if (GST_PAD_IS_FLUSHING (pad))
3736 GST_PAD_SET_FLUSHING (pad);
3737 GST_CAT_DEBUG (GST_CAT_EVENT, "set flush flag");
3739 case GST_EVENT_FLUSH_STOP:
3740 GST_PAD_UNSET_FLUSHING (pad);
3741 GST_CAT_DEBUG (GST_CAT_EVENT, "cleared flush flag");
3742 GST_OBJECT_UNLOCK (pad);
3743 /* grab stream lock */
3744 GST_PAD_STREAM_LOCK (pad);
3746 GST_OBJECT_LOCK (pad);
3749 GST_CAT_DEBUG (GST_CAT_EVENT, "have event type %s on pad %s:%s",
3750 GST_EVENT_TYPE_NAME (event), GST_DEBUG_PAD_NAME (pad));
3752 /* make this a little faster, no point in grabbing the lock
3753 * if the pad is allready flushing. */
3754 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3758 /* lock order: STREAM_LOCK, LOCK */
3759 GST_OBJECT_UNLOCK (pad);
3760 GST_PAD_STREAM_LOCK (pad);
3762 GST_OBJECT_LOCK (pad);
3763 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3768 if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
3771 GST_OBJECT_UNLOCK (pad);
3773 result = eventfunc (pad, event);
3776 GST_PAD_STREAM_UNLOCK (pad);
3780 /* ERROR handling */
3783 g_warning ("pad %s:%s sending %s event in wrong direction",
3784 GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
3785 GST_OBJECT_UNLOCK (pad);
3786 gst_event_unref (event);
3791 g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3792 GST_OBJECT_UNLOCK (pad);
3793 gst_event_unref (event);
3798 g_warning ("pad %s:%s has no event handler, file a bug.",
3799 GST_DEBUG_PAD_NAME (pad));
3800 GST_OBJECT_UNLOCK (pad);
3801 gst_event_unref (event);
3806 GST_OBJECT_UNLOCK (pad);
3808 GST_PAD_STREAM_UNLOCK (pad);
3809 GST_CAT_INFO (GST_CAT_EVENT, "Received event on flushing pad. Discarding");
3810 gst_event_unref (event);
3815 GST_DEBUG ("Dropping event after FALSE probe return");
3816 gst_event_unref (event);
3822 * gst_pad_set_element_private:
3823 * @pad: the #GstPad to set the private data of.
3824 * @priv: The private data to attach to the pad.
3826 * Set the given private data gpointer on the pad.
3827 * This function can only be used by the element that owns the pad.
3828 * No locking is performed in this function.
3831 gst_pad_set_element_private (GstPad * pad, gpointer priv)
3833 pad->element_private = priv;
3837 * gst_pad_get_element_private:
3838 * @pad: the #GstPad to get the private data of.
3840 * Gets the private data of a pad.
3841 * No locking is performed in this function.
3843 * Returns: a #gpointer to the private data.
3846 gst_pad_get_element_private (GstPad * pad)
3848 return pad->element_private;
3852 * gst_pad_start_task:
3853 * @pad: the #GstPad to start the task of
3854 * @func: the task function to call
3855 * @data: data passed to the task function
3857 * Starts a task that repeadedly calls @func with @data. This function
3858 * is nostly used in the pad activation function to start the
3859 * dataflow. This function will automatically acauire the STREAM_LOCK of
3860 * the pad before calling @func.
3862 * Returns: a TRUE if the task could be started.
3865 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer data)
3869 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3870 g_return_val_if_fail (func != NULL, FALSE);
3872 GST_OBJECT_LOCK (pad);
3873 task = GST_PAD_TASK (pad);
3875 task = gst_task_create (func, data);
3876 gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
3877 GST_PAD_TASK (pad) = task;
3879 gst_task_start (task);
3880 GST_OBJECT_UNLOCK (pad);
3886 * gst_pad_pause_task:
3887 * @pad: the #GstPad to pause the task of
3889 * Pause the task of @pad. This function will also make sure that the
3890 * function executed by the task will effectively stop.
3892 * Returns: a TRUE if the task could be paused or FALSE when the pad
3896 gst_pad_pause_task (GstPad * pad)
3900 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3902 GST_OBJECT_LOCK (pad);
3903 task = GST_PAD_TASK (pad);
3906 gst_task_pause (task);
3907 GST_OBJECT_UNLOCK (pad);
3909 GST_PAD_STREAM_LOCK (pad);
3910 GST_PAD_STREAM_UNLOCK (pad);
3916 GST_DEBUG_OBJECT (pad, "pad has no task");
3917 GST_OBJECT_UNLOCK (pad);
3923 * gst_pad_stop_task:
3924 * @pad: the #GstPad to stop the task of
3926 * Stop the task of @pad. This function will also make sure that the
3927 * function executed by the task will effectively stop if not called
3928 * from the GstTaskFunction.
3930 * This function will deadlock if called from the GstTaskFunction of
3931 * the task. Use gst_task_pause() instead.
3933 * Regardless of whether the pad has a task, the stream lock is acquired and
3934 * released so as to ensure that streaming through this pad has finished.
3936 * Returns: a TRUE if the task could be stopped or FALSE on error.
3939 gst_pad_stop_task (GstPad * pad)
3943 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3945 GST_OBJECT_LOCK (pad);
3946 task = GST_PAD_TASK (pad);
3949 GST_PAD_TASK (pad) = NULL;
3950 gst_task_stop (task);
3951 GST_OBJECT_UNLOCK (pad);
3953 GST_PAD_STREAM_LOCK (pad);
3954 GST_PAD_STREAM_UNLOCK (pad);
3956 gst_task_join (task);
3958 gst_object_unref (task);
3964 GST_OBJECT_UNLOCK (pad);
3966 GST_PAD_STREAM_LOCK (pad);
3967 GST_PAD_STREAM_UNLOCK (pad);