2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2005 Andy Wingo <wingo@pobox.com>
5 * 2006 Edward Hervey <bilboed@bilboed.com>
7 * gstghostpad.c: Proxy pads
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
27 * @short_description: Pseudo link pads
30 * GhostPads are useful when organizing pipelines with #GstBin like elements.
31 * The idea here is to create hierarchical element graphs. The bin element
32 * contains a sub-graph. Now one would like to treat the bin-element like other
33 * #GstElements. This is where GhostPads come into play. A GhostPad acts as a
34 * proxy for another pad. Thus the bin can have sink and source ghost-pads that
35 * are associated with sink and source pads of the child elements.
37 * If the target pad is known at creation time, gst_ghost_pad_new() is the
38 * function to use to get a ghost-pad. Otherwise one can use gst_ghost_pad_new_no_target()
39 * to create the ghost-pad and use gst_ghost_pad_set_target() to establish the
40 * association later on.
42 * Note that GhostPads add overhead to the data processing of a pipeline.
44 * Last reviewed on 2005-11-18 (0.9.5)
47 #include "gst_private.h"
50 #include "gstghostpad.h"
53 #define GST_CAT_DEFAULT GST_CAT_PADS
55 #define GST_PROXY_PAD_CAST(obj) ((GstProxyPad *)obj)
56 #define GST_PROXY_PAD_PRIVATE(obj) (GST_PROXY_PAD_CAST (obj)->priv)
57 #define GST_PROXY_PAD_TARGET(pad) (GST_PROXY_PAD_PRIVATE (pad)->target)
58 #define GST_PROXY_PAD_INTERNAL(pad) (GST_PROXY_PAD_PRIVATE (pad)->internal)
59 #define GST_PROXY_PAD_RETARGET(pad) (GST_PROXY_PAD_PRIVATE (pad)->retarget)
60 #define GST_PROXY_GET_LOCK(pad) (GST_PROXY_PAD_PRIVATE (pad)->proxy_lock)
61 #define GST_PROXY_LOCK(pad) (g_mutex_lock (GST_PROXY_GET_LOCK (pad)))
62 #define GST_PROXY_UNLOCK(pad) (g_mutex_unlock (GST_PROXY_GET_LOCK (pad)))
64 struct _GstProxyPadPrivate
73 G_DEFINE_TYPE (GstProxyPad, gst_proxy_pad, GST_TYPE_PAD);
75 static GstPad *gst_proxy_pad_get_target (GstPad * pad);
77 static void gst_proxy_pad_dispose (GObject * object);
78 static void gst_proxy_pad_finalize (GObject * object);
80 #ifndef GST_DISABLE_LOADSAVE
81 static xmlNodePtr gst_proxy_pad_save_thyself (GstObject * object,
85 static void on_src_target_notify (GstPad * target,
86 GParamSpec * unused, gpointer user_data);
90 gst_proxy_pad_class_init (GstProxyPadClass * klass)
92 GObjectClass *gobject_class = (GObjectClass *) klass;
94 g_type_class_add_private (klass, sizeof (GstProxyPadPrivate));
96 gobject_class->dispose = gst_proxy_pad_dispose;
97 gobject_class->finalize = gst_proxy_pad_finalize;
99 #ifndef GST_DISABLE_LOADSAVE
101 GstObjectClass *gstobject_class = (GstObjectClass *) klass;
103 gstobject_class->save_thyself =
104 GST_DEBUG_FUNCPTR (gst_proxy_pad_save_thyself);
109 static const GstQueryType *
110 gst_proxy_pad_do_query_type (GstPad * pad)
112 GstPad *target = gst_proxy_pad_get_target (pad);
113 const GstQueryType *res = NULL;
116 res = gst_pad_get_query_types (target);
117 gst_object_unref (target);
123 gst_proxy_pad_do_event (GstPad * pad, GstEvent * event)
125 gboolean res = FALSE;
126 GstPad *internal = GST_PROXY_PAD_INTERNAL (pad);
128 res = gst_pad_push_event (internal, event);
134 gst_proxy_pad_do_query (GstPad * pad, GstQuery * query)
136 gboolean res = FALSE;
137 GstPad *target = gst_proxy_pad_get_target (pad);
140 res = gst_pad_query (target, query);
141 gst_object_unref (target);
148 gst_proxy_pad_do_iterate_internal_links (GstPad * pad)
150 GstIterator *res = NULL;
151 GstPad *target = gst_proxy_pad_get_target (pad);
154 res = gst_pad_iterate_internal_links (target);
155 gst_object_unref (target);
162 gst_proxy_pad_do_bufferalloc (GstPad * pad, guint64 offset, guint size,
163 GstCaps * caps, GstBuffer ** buf)
165 GstFlowReturn result;
166 GstPad *internal = GST_PROXY_PAD_INTERNAL (pad);
168 result = gst_pad_alloc_buffer (internal, offset, size, caps, buf);
174 gst_proxy_pad_do_chain (GstPad * pad, GstBuffer * buffer)
177 GstPad *internal = GST_PROXY_PAD_INTERNAL (pad);
179 res = gst_pad_push (internal, buffer);
185 gst_proxy_pad_do_chain_list (GstPad * pad, GstBufferList * list)
188 GstPad *internal = GST_PROXY_PAD_INTERNAL (pad);
190 res = gst_pad_push_list (internal, list);
196 gst_proxy_pad_do_getrange (GstPad * pad, guint64 offset, guint size,
200 GstPad *internal = GST_PROXY_PAD_INTERNAL (pad);
202 res = gst_pad_pull_range (internal, offset, size, buffer);
208 gst_proxy_pad_do_checkgetrange (GstPad * pad)
211 GstPad *internal = GST_PROXY_PAD_INTERNAL (pad);
213 result = gst_pad_check_pull_range (internal);
219 gst_proxy_pad_do_getcaps (GstPad * pad)
221 GstPad *target = gst_proxy_pad_get_target (pad);
223 GstPadTemplate *templ = GST_PAD_PAD_TEMPLATE (pad);
226 /* if we have a real target, proxy the call */
227 res = gst_pad_get_caps_refed (target);
229 GST_DEBUG_OBJECT (pad, "get caps of target %s:%s : %" GST_PTR_FORMAT,
230 GST_DEBUG_PAD_NAME (target), res);
232 gst_object_unref (target);
234 /* filter against the template */
238 filt = GST_PAD_TEMPLATE_CAPS (templ);
240 tmp = gst_caps_intersect (filt, res);
241 gst_caps_unref (res);
243 GST_DEBUG_OBJECT (pad,
244 "filtered against template gives %" GST_PTR_FORMAT, res);
248 /* else, if we have a template, use its caps. */
250 res = GST_PAD_TEMPLATE_CAPS (templ);
251 GST_DEBUG_OBJECT (pad,
252 "using pad template %p with caps %p %" GST_PTR_FORMAT, templ, res,
254 res = gst_caps_ref (res);
258 /* last resort, any caps */
259 GST_DEBUG_OBJECT (pad, "pad has no template, returning ANY");
260 res = gst_caps_new_any ();
268 gst_proxy_pad_do_acceptcaps (GstPad * pad, GstCaps * caps)
270 GstPad *target = gst_proxy_pad_get_target (pad);
274 res = gst_pad_accept_caps (target, caps);
275 gst_object_unref (target);
277 /* We don't have a target, we return TRUE and we assume that any future
278 * target will be able to deal with any configured caps. */
286 gst_proxy_pad_do_fixatecaps (GstPad * pad, GstCaps * caps)
288 GstPad *target = gst_proxy_pad_get_target (pad);
291 gst_pad_fixate_caps (target, caps);
292 gst_object_unref (target);
297 gst_proxy_pad_do_setcaps (GstPad * pad, GstCaps * caps)
299 GstPad *target = gst_proxy_pad_get_target (pad);
303 res = gst_pad_set_caps (target, caps);
304 gst_object_unref (target);
306 /* We don't have any target, but we shouldn't return FALSE since this
307 * would stop the actual push of a buffer (which might trigger a pad block
308 * or probe, or properly return GST_FLOW_NOT_LINKED.
316 gst_proxy_pad_set_target_unlocked (GstPad * pad, GstPad * target)
321 GST_LOG_OBJECT (pad, "setting target %s:%s", GST_DEBUG_PAD_NAME (target));
323 if (G_UNLIKELY (GST_PAD_DIRECTION (pad) != GST_PAD_DIRECTION (target)))
324 goto wrong_direction;
326 GST_LOG_OBJECT (pad, "clearing target");
328 /* clear old target */
329 if ((oldtarget = GST_PROXY_PAD_TARGET (pad)))
330 gst_object_unref (oldtarget);
332 /* set and ref new target if any */
334 GST_PROXY_PAD_TARGET (pad) = gst_object_ref (target);
336 GST_PROXY_PAD_TARGET (pad) = NULL;
343 GST_ERROR_OBJECT (pad,
344 "target pad doesn't have the same direction as ourself");
350 gst_proxy_pad_set_target (GstPad * pad, GstPad * target)
354 GST_PROXY_LOCK (pad);
355 result = gst_proxy_pad_set_target_unlocked (pad, target);
356 GST_PROXY_UNLOCK (pad);
362 gst_proxy_pad_get_target (GstPad * pad)
366 GST_PROXY_LOCK (pad);
367 target = GST_PROXY_PAD_TARGET (pad);
369 gst_object_ref (target);
370 GST_PROXY_UNLOCK (pad);
376 gst_proxy_pad_do_unlink (GstPad * pad)
380 /* don't do anything if this unlink resulted from retargeting the pad
381 * controlled by the ghostpad. We only want to invalidate the target pad when
382 * the element suddently unlinked with our internal pad. */
383 if (GST_PROXY_PAD_RETARGET (pad))
386 internal = GST_PROXY_PAD_INTERNAL (pad);
388 GST_DEBUG_OBJECT (pad, "pad is unlinked");
390 gst_proxy_pad_set_target (internal, NULL);
394 gst_proxy_pad_dispose (GObject * object)
396 GstPad *pad = GST_PAD (object);
399 GST_PROXY_LOCK (pad);
400 /* remove and unref the target */
401 target_p = &GST_PROXY_PAD_TARGET (pad);
402 gst_object_replace ((GstObject **) target_p, NULL);
403 /* The internal is only cleared by GstGhostPad::dispose, since it is the
404 * parent of non-ghost GstProxyPad and owns the refcount on the internal.
406 GST_PROXY_UNLOCK (pad);
408 G_OBJECT_CLASS (gst_proxy_pad_parent_class)->dispose (object);
412 gst_proxy_pad_finalize (GObject * object)
414 GstProxyPad *pad = GST_PROXY_PAD (object);
416 g_mutex_free (GST_PROXY_GET_LOCK (pad));
417 GST_PROXY_GET_LOCK (pad) = NULL;
419 G_OBJECT_CLASS (gst_proxy_pad_parent_class)->finalize (object);
423 gst_proxy_pad_init (GstProxyPad * ppad)
425 GstPad *pad = (GstPad *) ppad;
427 GST_PROXY_PAD_PRIVATE (ppad) = G_TYPE_INSTANCE_GET_PRIVATE (ppad,
428 GST_TYPE_PROXY_PAD, GstProxyPadPrivate);
429 GST_PROXY_GET_LOCK (pad) = g_mutex_new ();
431 gst_pad_set_query_type_function (pad,
432 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_query_type));
433 gst_pad_set_event_function (pad, GST_DEBUG_FUNCPTR (gst_proxy_pad_do_event));
434 gst_pad_set_query_function (pad, GST_DEBUG_FUNCPTR (gst_proxy_pad_do_query));
435 gst_pad_set_iterate_internal_links_function (pad,
436 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_iterate_internal_links));
438 gst_pad_set_getcaps_function (pad,
439 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_getcaps));
440 gst_pad_set_acceptcaps_function (pad,
441 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_acceptcaps));
442 gst_pad_set_fixatecaps_function (pad,
443 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_fixatecaps));
444 gst_pad_set_setcaps_function (pad,
445 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_setcaps));
446 gst_pad_set_unlink_function (pad,
447 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_unlink));
450 #ifndef GST_DISABLE_LOADSAVE
452 * gst_proxy_pad_save_thyself:
453 * @pad: a ghost #GstPad to save.
454 * @parent: the parent #xmlNodePtr to save the description in.
456 * Saves the ghost pad into an xml representation.
458 * Returns: the #xmlNodePtr representation of the pad.
461 gst_proxy_pad_save_thyself (GstObject * object, xmlNodePtr parent)
464 GstProxyPad *proxypad;
468 g_return_val_if_fail (GST_IS_PROXY_PAD (object), NULL);
470 self = xmlNewChild (parent, NULL, (xmlChar *) "ghostpad", NULL);
471 xmlNewChild (self, NULL, (xmlChar *) "name",
472 (xmlChar *) GST_OBJECT_NAME (object));
473 xmlNewChild (self, NULL, (xmlChar *) "parent",
474 (xmlChar *) GST_OBJECT_NAME (GST_OBJECT_PARENT (object)));
476 proxypad = GST_PROXY_PAD_CAST (object);
477 pad = GST_PAD_CAST (proxypad);
478 peer = GST_PAD_CAST (pad->peer);
480 if (GST_IS_PAD (pad)) {
481 if (GST_PAD_IS_SRC (pad))
482 xmlNewChild (self, NULL, (xmlChar *) "direction", (xmlChar *) "source");
483 else if (GST_PAD_IS_SINK (pad))
484 xmlNewChild (self, NULL, (xmlChar *) "direction", (xmlChar *) "sink");
486 xmlNewChild (self, NULL, (xmlChar *) "direction", (xmlChar *) "unknown");
488 xmlNewChild (self, NULL, (xmlChar *) "direction", (xmlChar *) "unknown");
490 if (GST_IS_PAD (peer)) {
491 gchar *content = g_strdup_printf ("%s.%s",
492 GST_OBJECT_NAME (GST_PAD_PARENT (peer)), GST_PAD_NAME (peer));
494 xmlNewChild (self, NULL, (xmlChar *) "peer", (xmlChar *) content);
497 xmlNewChild (self, NULL, (xmlChar *) "peer", NULL);
502 #endif /* GST_DISABLE_LOADSAVE */
505 /***********************************************************************
506 * Ghost pads, implemented as a pair of proxy pads (sort of)
510 #define GST_GHOST_PAD_PRIVATE(obj) (GST_GHOST_PAD_CAST (obj)->priv)
512 struct _GstGhostPadPrivate
514 /* with PROXY_LOCK */
517 gboolean constructed;
520 G_DEFINE_TYPE (GstGhostPad, gst_ghost_pad, GST_TYPE_PROXY_PAD);
522 static void gst_ghost_pad_dispose (GObject * object);
525 gst_ghost_pad_class_init (GstGhostPadClass * klass)
527 GObjectClass *gobject_class = (GObjectClass *) klass;
529 g_type_class_add_private (klass, sizeof (GstGhostPadPrivate));
531 gobject_class->dispose = gst_ghost_pad_dispose;
534 /* see gstghostpad design docs */
536 gst_ghost_pad_internal_do_activate_push (GstPad * pad, gboolean active)
541 GST_LOG_OBJECT (pad, "%sactivate push on %s:%s, we're ok",
542 (active ? "" : "de"), GST_DEBUG_PAD_NAME (pad));
544 /* in both cases (SRC and SINK) we activate just the internal pad. The targets
545 * will be activated later (or already in case of a ghost sinkpad). */
546 other = GST_PROXY_PAD_INTERNAL (pad);
547 ret = gst_pad_activate_push (other, active);
553 gst_ghost_pad_internal_do_activate_pull (GstPad * pad, gboolean active)
558 GST_LOG_OBJECT (pad, "%sactivate pull on %s:%s", (active ? "" : "de"),
559 GST_DEBUG_PAD_NAME (pad));
561 if (GST_PAD_DIRECTION (pad) == GST_PAD_SRC) {
562 /* we are activated in pull mode by our peer element, which is a sinkpad
563 * that wants to operate in pull mode. This activation has to propagate
564 * upstream throught the pipeline. We call the internal activation function,
565 * which will trigger gst_ghost_pad_do_activate_pull, which propagates even
566 * further upstream */
567 GST_LOG_OBJECT (pad, "pad is src, activate internal");
568 other = GST_PROXY_PAD_INTERNAL (pad);
569 ret = gst_pad_activate_pull (other, active);
570 } else if (G_LIKELY ((other = gst_pad_get_peer (pad)))) {
571 /* We are SINK, the ghostpad is SRC, we propagate the activation upstream
572 * since we hold a pointer to the upstream peer. */
573 GST_LOG_OBJECT (pad, "activating peer");
574 ret = gst_pad_activate_pull (other, active);
575 gst_object_unref (other);
577 /* this is failure, we can't activate pull if there is no peer */
578 GST_LOG_OBJECT (pad, "not src and no peer, failing");
586 gst_ghost_pad_do_activate_push (GstPad * pad, gboolean active)
591 GST_LOG_OBJECT (pad, "%sactivate push on %s:%s, proxy internal",
592 (active ? "" : "de"), GST_DEBUG_PAD_NAME (pad));
594 /* just activate the internal pad */
595 other = GST_PROXY_PAD_INTERNAL (pad);
596 ret = gst_pad_activate_push (other, active);
602 gst_ghost_pad_do_activate_pull (GstPad * pad, gboolean active)
607 GST_LOG_OBJECT (pad, "%sactivate pull on %s:%s", (active ? "" : "de"),
608 GST_DEBUG_PAD_NAME (pad));
610 if (GST_PAD_DIRECTION (pad) == GST_PAD_SRC) {
611 /* the ghostpad is SRC and activated in pull mode by its peer, call the
612 * activation function of the internal pad to propagate the activation
614 GST_LOG_OBJECT (pad, "pad is src, activate internal");
615 other = GST_PROXY_PAD_INTERNAL (pad);
616 ret = gst_pad_activate_pull (other, active);
617 } else if (G_LIKELY ((other = gst_pad_get_peer (pad)))) {
618 /* We are SINK and activated by the internal pad, propagate activation
619 * upstream because we hold a ref to the upstream peer */
620 GST_LOG_OBJECT (pad, "activating peer");
621 ret = gst_pad_activate_pull (other, active);
622 gst_object_unref (other);
624 /* no peer, we fail */
625 GST_LOG_OBJECT (pad, "pad not src and no peer, failing");
632 static GstPadLinkReturn
633 gst_ghost_pad_do_link (GstPad * pad, GstPad * peer)
635 GstPadLinkReturn ret;
638 GST_DEBUG_OBJECT (pad, "linking ghostpad");
640 internal = GST_PROXY_PAD_INTERNAL (pad);
641 if (!gst_proxy_pad_set_target (internal, peer))
644 ret = GST_PAD_LINK_OK;
645 /* if we are a source pad, we should call the peer link function
646 * if the peer has one, see design docs. */
647 if (GST_PAD_IS_SRC (pad)) {
648 if (GST_PAD_LINKFUNC (peer)) {
649 ret = GST_PAD_LINKFUNC (peer) (peer, pad);
650 if (ret != GST_PAD_LINK_OK)
659 GST_DEBUG_OBJECT (pad, "setting target failed");
660 return GST_PAD_LINK_REFUSED;
664 GST_DEBUG_OBJECT (pad, "linking failed");
665 /* clear target again */
666 gst_proxy_pad_set_target (internal, NULL);
672 gst_ghost_pad_do_unlink (GstPad * pad)
676 internal = GST_PROXY_PAD_INTERNAL (pad);
678 GST_DEBUG_OBJECT (pad, "unlinking ghostpad");
680 /* The target of the internal pad is no longer valid */
681 gst_proxy_pad_set_target (internal, NULL);
685 on_int_notify (GstPad * internal, GParamSpec * unused, GstGhostPad * pad)
690 g_object_get (internal, "caps", &caps, NULL);
692 GST_DEBUG_OBJECT (pad, "notified %p %" GST_PTR_FORMAT, caps, caps);
694 GST_OBJECT_LOCK (pad);
695 changed = (GST_PAD_CAPS (pad) != caps);
697 gst_caps_replace (&(GST_PAD_CAPS (pad)), caps);
698 GST_OBJECT_UNLOCK (pad);
701 g_object_notify (G_OBJECT (pad), "caps");
704 gst_caps_unref (caps);
708 on_src_target_notify (GstPad * target, GParamSpec * unused, gpointer user_data)
710 GstProxyPad *proxypad;
715 g_object_get (target, "caps", &caps, NULL);
717 GST_OBJECT_LOCK (target);
718 /* First check if the peer is still available and our proxy pad */
719 if (!GST_PAD_PEER (target) || !GST_IS_PROXY_PAD (GST_PAD_PEER (target))) {
720 GST_OBJECT_UNLOCK (target);
724 proxypad = GST_PROXY_PAD (GST_PAD_PEER (target));
725 GST_PROXY_LOCK (proxypad);
726 /* Now check if the proxypad's internal pad is still there and
728 if (!GST_PROXY_PAD_INTERNAL (proxypad) ||
729 !GST_IS_GHOST_PAD (GST_PROXY_PAD_INTERNAL (proxypad))) {
730 GST_OBJECT_UNLOCK (target);
731 GST_PROXY_UNLOCK (proxypad);
734 gpad = GST_GHOST_PAD (GST_PROXY_PAD_INTERNAL (proxypad));
736 GST_PROXY_UNLOCK (proxypad);
737 GST_OBJECT_UNLOCK (target);
739 GST_OBJECT_LOCK (gpad);
741 GST_DEBUG_OBJECT (gpad, "notified %p %" GST_PTR_FORMAT, caps, caps);
743 changed = (GST_PAD_CAPS (gpad) != caps);
745 gst_caps_replace (&(GST_PAD_CAPS (gpad)), caps);
746 GST_OBJECT_UNLOCK (gpad);
748 g_object_notify (G_OBJECT (gpad), "caps");
750 g_object_unref (gpad);
754 gst_caps_unref (caps);
758 gst_ghost_pad_do_setcaps (GstPad * pad, GstCaps * caps)
760 if (GST_PAD_DIRECTION (pad) == GST_PAD_SRC)
763 return gst_proxy_pad_do_setcaps (pad, caps);
767 gst_ghost_pad_init (GstGhostPad * pad)
769 GST_GHOST_PAD_PRIVATE (pad) = G_TYPE_INSTANCE_GET_PRIVATE (pad,
770 GST_TYPE_GHOST_PAD, GstGhostPadPrivate);
772 gst_pad_set_setcaps_function (GST_PAD_CAST (pad),
773 GST_DEBUG_FUNCPTR (gst_ghost_pad_do_setcaps));
774 gst_pad_set_activatepull_function (GST_PAD_CAST (pad),
775 GST_DEBUG_FUNCPTR (gst_ghost_pad_do_activate_pull));
776 gst_pad_set_activatepush_function (GST_PAD_CAST (pad),
777 GST_DEBUG_FUNCPTR (gst_ghost_pad_do_activate_push));
781 gst_ghost_pad_dispose (GObject * object)
787 pad = GST_PAD (object);
789 GST_DEBUG_OBJECT (pad, "dispose");
791 gst_ghost_pad_set_target (GST_GHOST_PAD (pad), NULL);
793 /* Unlink here so that gst_pad_dispose doesn't. That would lead to a call to
794 * gst_ghost_pad_do_unlink when the ghost pad is in an inconsistent state */
795 peer = gst_pad_get_peer (pad);
797 if (GST_PAD_IS_SRC (pad))
798 gst_pad_unlink (pad, peer);
800 gst_pad_unlink (peer, pad);
802 gst_object_unref (peer);
805 GST_PROXY_LOCK (pad);
806 internal = GST_PROXY_PAD_INTERNAL (pad);
808 gst_pad_set_activatepull_function (internal, NULL);
809 gst_pad_set_activatepush_function (internal, NULL);
811 g_signal_handler_disconnect (internal,
812 GST_GHOST_PAD_PRIVATE (pad)->notify_id);
814 /* disposes of the internal pad, since the ghostpad is the only possible object
815 * that has a refcount on the internal pad. */
816 gst_object_unparent (GST_OBJECT_CAST (internal));
817 GST_PROXY_PAD_INTERNAL (pad) = NULL;
819 GST_PROXY_UNLOCK (pad);
821 G_OBJECT_CLASS (gst_ghost_pad_parent_class)->dispose (object);
825 * gst_ghost_pad_construct:
826 * @gpad: the newly allocated ghost pad
828 * Finish initialization of a newly allocated ghost pad.
830 * This function is most useful in language bindings and when subclassing
831 * #GstGhostPad; plugin and application developers normally will not call this
832 * function. Call this function directly after a call to g_object_new
833 * (GST_TYPE_GHOST_PAD, "direction", @dir, ..., NULL).
835 * Returns: %TRUE if the construction succeeds, %FALSE otherwise.
840 gst_ghost_pad_construct (GstGhostPad * gpad)
842 GstPadDirection dir, otherdir;
843 GstPadTemplate *templ;
844 GstPad *pad, *internal;
846 g_return_val_if_fail (GST_IS_GHOST_PAD (gpad), FALSE);
847 g_return_val_if_fail (GST_GHOST_PAD_PRIVATE (gpad)->constructed == FALSE,
850 g_object_get (gpad, "direction", &dir, "template", &templ, NULL);
852 g_return_val_if_fail (dir != GST_PAD_UNKNOWN, FALSE);
854 pad = GST_PAD (gpad);
856 /* Set directional padfunctions for ghostpad */
857 if (dir == GST_PAD_SINK) {
858 gst_pad_set_bufferalloc_function (pad,
859 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_bufferalloc));
860 gst_pad_set_chain_function (pad,
861 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_chain));
862 gst_pad_set_chain_list_function (pad,
863 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_chain_list));
865 gst_pad_set_getrange_function (pad,
866 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_getrange));
867 gst_pad_set_checkgetrange_function (pad,
868 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_checkgetrange));
871 /* link/unlink functions */
872 gst_pad_set_link_function (pad, GST_DEBUG_FUNCPTR (gst_ghost_pad_do_link));
873 gst_pad_set_unlink_function (pad,
874 GST_DEBUG_FUNCPTR (gst_ghost_pad_do_unlink));
876 /* INTERNAL PAD, it always exists and is child of the ghostpad */
877 otherdir = (dir == GST_PAD_SRC) ? GST_PAD_SINK : GST_PAD_SRC;
880 g_object_new (GST_TYPE_PROXY_PAD, "name", NULL,
881 "direction", otherdir, "template", templ, NULL);
882 /* release ref obtained via g_object_get */
883 gst_object_unref (templ);
886 g_object_new (GST_TYPE_PROXY_PAD, "name", NULL,
887 "direction", otherdir, NULL);
889 GST_PAD_UNSET_FLUSHING (internal);
891 /* Set directional padfunctions for internal pad */
892 if (dir == GST_PAD_SRC) {
893 gst_pad_set_bufferalloc_function (internal,
894 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_bufferalloc));
895 gst_pad_set_chain_function (internal,
896 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_chain));
897 gst_pad_set_chain_list_function (internal,
898 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_chain_list));
900 gst_pad_set_getrange_function (internal,
901 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_getrange));
902 gst_pad_set_checkgetrange_function (internal,
903 GST_DEBUG_FUNCPTR (gst_proxy_pad_do_checkgetrange));
906 GST_PROXY_LOCK (pad);
908 /* now make the ghostpad a parent of the internal pad */
909 if (!gst_object_set_parent (GST_OBJECT_CAST (internal),
910 GST_OBJECT_CAST (pad)))
913 /* The ghostpad is the parent of the internal pad and is the only object that
914 * can have a refcount on the internal pad.
915 * At this point, the GstGhostPad has a refcount of 1, and the internal pad has
917 * When the refcount of the GstGhostPad drops to 0, the ghostpad will dispose
918 * its refcount on the internal pad in the dispose method by un-parenting it.
919 * This is why we don't take extra refcounts in the assignments below
921 GST_PROXY_PAD_INTERNAL (pad) = internal;
922 GST_PROXY_PAD_INTERNAL (internal) = pad;
924 /* could be more general here, iterating over all writable properties...
925 * taking the short road for now tho */
926 GST_GHOST_PAD_PRIVATE (pad)->notify_id =
927 g_signal_connect (internal, "notify::caps", G_CALLBACK (on_int_notify),
930 /* call function to init values of the pad caps */
931 on_int_notify (internal, NULL, GST_GHOST_PAD_CAST (pad));
933 /* special activation functions for the internal pad */
934 gst_pad_set_activatepull_function (internal,
935 GST_DEBUG_FUNCPTR (gst_ghost_pad_internal_do_activate_pull));
936 gst_pad_set_activatepush_function (internal,
937 GST_DEBUG_FUNCPTR (gst_ghost_pad_internal_do_activate_push));
939 GST_PROXY_UNLOCK (pad);
941 GST_GHOST_PAD_PRIVATE (gpad)->constructed = TRUE;
947 GST_WARNING_OBJECT (gpad, "Could not set internal pad %s:%s",
948 GST_DEBUG_PAD_NAME (internal));
949 g_critical ("Could not set internal pad %s:%s",
950 GST_DEBUG_PAD_NAME (internal));
951 GST_PROXY_UNLOCK (pad);
952 gst_object_unref (internal);
958 gst_ghost_pad_new_full (const gchar * name, GstPadDirection dir,
959 GstPadTemplate * templ)
963 g_return_val_if_fail (dir != GST_PAD_UNKNOWN, NULL);
965 /* OBJECT CREATION */
967 ret = g_object_new (GST_TYPE_GHOST_PAD, "name", name,
968 "direction", dir, "template", templ, NULL);
970 ret = g_object_new (GST_TYPE_GHOST_PAD, "name", name,
971 "direction", dir, NULL);
974 if (!gst_ghost_pad_construct (ret))
975 goto construct_failed;
977 return GST_PAD (ret);
981 gst_object_unref (ret);
986 * gst_ghost_pad_new_no_target:
987 * @name: the name of the new pad, or NULL to assign a default name.
988 * @dir: the direction of the ghostpad
990 * Create a new ghostpad without a target with the given direction.
991 * A target can be set on the ghostpad later with the
992 * gst_ghost_pad_set_target() function.
994 * The created ghostpad will not have a padtemplate.
996 * Returns: a new #GstPad, or NULL in case of an error.
999 gst_ghost_pad_new_no_target (const gchar * name, GstPadDirection dir)
1003 g_return_val_if_fail (dir != GST_PAD_UNKNOWN, NULL);
1005 GST_LOG ("name:%s, direction:%d", GST_STR_NULL (name), dir);
1007 ret = gst_ghost_pad_new_full (name, dir, NULL);
1013 * gst_ghost_pad_new:
1014 * @name: the name of the new pad, or NULL to assign a default name.
1015 * @target: the pad to ghost.
1017 * Create a new ghostpad with @target as the target. The direction will be taken
1018 * from the target pad. @target must be unlinked.
1020 * Will ref the target.
1022 * Returns: a new #GstPad, or NULL in case of an error.
1025 gst_ghost_pad_new (const gchar * name, GstPad * target)
1029 g_return_val_if_fail (GST_IS_PAD (target), NULL);
1030 g_return_val_if_fail (!gst_pad_is_linked (target), NULL);
1032 GST_LOG ("name:%s, target:%s:%s", GST_STR_NULL (name),
1033 GST_DEBUG_PAD_NAME (target));
1035 if ((ret = gst_ghost_pad_new_no_target (name, GST_PAD_DIRECTION (target))))
1036 if (!gst_ghost_pad_set_target (GST_GHOST_PAD_CAST (ret), target))
1037 goto set_target_failed;
1044 GST_WARNING_OBJECT (ret, "failed to set target %s:%s",
1045 GST_DEBUG_PAD_NAME (target));
1046 gst_object_unref (ret);
1052 * gst_ghost_pad_new_from_template:
1053 * @name: the name of the new pad, or NULL to assign a default name.
1054 * @target: the pad to ghost.
1055 * @templ: the #GstPadTemplate to use on the ghostpad.
1057 * Create a new ghostpad with @target as the target. The direction will be taken
1058 * from the target pad. The template used on the ghostpad will be @template.
1060 * Will ref the target.
1062 * Returns: a new #GstPad, or NULL in case of an error.
1068 gst_ghost_pad_new_from_template (const gchar * name, GstPad * target,
1069 GstPadTemplate * templ)
1073 g_return_val_if_fail (GST_IS_PAD (target), NULL);
1074 g_return_val_if_fail (!gst_pad_is_linked (target), NULL);
1075 g_return_val_if_fail (templ != NULL, NULL);
1076 g_return_val_if_fail (GST_PAD_TEMPLATE_DIRECTION (templ) ==
1077 GST_PAD_DIRECTION (target), NULL);
1079 GST_LOG ("name:%s, target:%s:%s, templ:%p", GST_STR_NULL (name),
1080 GST_DEBUG_PAD_NAME (target), templ);
1082 if ((ret = gst_ghost_pad_new_full (name, GST_PAD_DIRECTION (target), templ)))
1083 if (!gst_ghost_pad_set_target (GST_GHOST_PAD_CAST (ret), target))
1084 goto set_target_failed;
1091 GST_WARNING_OBJECT (ret, "failed to set target %s:%s",
1092 GST_DEBUG_PAD_NAME (target));
1093 gst_object_unref (ret);
1099 * gst_ghost_pad_new_no_target_from_template:
1100 * @name: the name of the new pad, or NULL to assign a default name.
1101 * @templ: the #GstPadTemplate to create the ghostpad from.
1103 * Create a new ghostpad based on @templ, without setting a target. The
1104 * direction will be taken from the @templ.
1106 * Returns: a new #GstPad, or NULL in case of an error.
1111 gst_ghost_pad_new_no_target_from_template (const gchar * name,
1112 GstPadTemplate * templ)
1116 g_return_val_if_fail (templ != NULL, NULL);
1119 gst_ghost_pad_new_full (name, GST_PAD_TEMPLATE_DIRECTION (templ), templ);
1125 * gst_ghost_pad_get_target:
1126 * @gpad: the #GstGhostpad
1128 * Get the target pad of #gpad. Unref target pad after usage.
1130 * Returns: the target #GstPad, can be NULL if the ghostpad
1131 * has no target set. Unref target pad after usage.
1134 gst_ghost_pad_get_target (GstGhostPad * gpad)
1138 g_return_val_if_fail (GST_IS_GHOST_PAD (gpad), NULL);
1140 ret = gst_proxy_pad_get_target (GST_PAD_CAST (gpad));
1142 GST_DEBUG_OBJECT (gpad, "get target %s:%s", GST_DEBUG_PAD_NAME (ret));
1148 * gst_ghost_pad_set_target:
1149 * @gpad: the #GstGhostpad
1150 * @newtarget: the new pad target
1152 * Set the new target of the ghostpad @gpad. Any existing target
1153 * is unlinked and links to the new target are established. if @newtarget is
1154 * NULL the target will be cleared.
1156 * Returns: TRUE if the new target could be set. This function can return FALSE
1157 * when the internal pads could not be linked.
1160 gst_ghost_pad_set_target (GstGhostPad * gpad, GstPad * newtarget)
1165 GstPadLinkReturn lret;
1167 g_return_val_if_fail (GST_IS_GHOST_PAD (gpad), FALSE);
1169 /* no need for locking, the internal pad's lifecycle is directly linked to the
1171 internal = GST_PROXY_PAD_INTERNAL (gpad);
1174 GST_DEBUG_OBJECT (gpad, "set target %s:%s", GST_DEBUG_PAD_NAME (newtarget));
1176 GST_DEBUG_OBJECT (gpad, "clearing target");
1178 /* clear old target */
1179 GST_PROXY_LOCK (gpad);
1180 if ((oldtarget = GST_PROXY_PAD_TARGET (gpad))) {
1181 if (GST_PAD_IS_SRC (oldtarget)) {
1182 g_signal_handlers_disconnect_by_func (oldtarget,
1183 (gpointer) on_src_target_notify, NULL);
1186 GST_PROXY_PAD_RETARGET (internal) = TRUE;
1188 /* unlink internal pad */
1189 if (GST_PAD_IS_SRC (internal))
1190 gst_pad_unlink (internal, oldtarget);
1192 gst_pad_unlink (oldtarget, internal);
1194 GST_PROXY_PAD_RETARGET (internal) = FALSE;
1197 result = gst_proxy_pad_set_target_unlocked (GST_PAD_CAST (gpad), newtarget);
1198 GST_PROXY_UNLOCK (gpad);
1200 if (result && newtarget) {
1201 if (GST_PAD_IS_SRC (newtarget)) {
1202 g_signal_connect (newtarget, "notify::caps",
1203 G_CALLBACK (on_src_target_notify), NULL);
1206 /* and link to internal pad */
1207 GST_DEBUG_OBJECT (gpad, "connecting internal pad to target");
1209 if (GST_PAD_IS_SRC (internal))
1210 lret = gst_pad_link (internal, newtarget);
1212 lret = gst_pad_link (newtarget, internal);
1214 if (lret != GST_PAD_LINK_OK)
1223 GST_WARNING_OBJECT (gpad, "could not link internal and target, reason:%d",
1225 /* and unset target again */
1226 gst_proxy_pad_set_target_unlocked (GST_PAD_CAST (gpad), NULL);
1227 GST_PROXY_UNLOCK (gpad);