gst/gstghostpad.c

   1 /* GStreamer
   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>
   6  *
   7  * gstghostpad.c: Proxy pads
   8  *
   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.
  13  *
  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.
  18  *
  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., 51 Franklin St, Fifth Floor,
  22  * Boston, MA 02110-1301, USA.
  23  */
  24
  25 /**
  26  * SECTION:gstghostpad
  27  * @short_description: Pseudo link pads
  28  * @see_also: #GstPad
  29  *
  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 any
  33  * other #GstElement. This is where GhostPads come into play. A GhostPad acts as
  34  * a proxy for another pad. Thus the bin can have sink and source ghost-pads
  35  * that are associated with sink and source pads of the child elements.
  36  *
  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.
  41  *
  42  * Note that GhostPads add overhead to the data processing of a pipeline.
  43  */
  44
  45 #include "gst_private.h"
  46 #include "gstinfo.h"
  47
  48 #include "gstghostpad.h"
  49 #include "gst.h"
  50
  51 #define GST_CAT_DEFAULT GST_CAT_PADS
  52
  53 #define GST_PROXY_PAD_CAST(obj)         ((GstProxyPad *)obj)
  54 #define GST_PROXY_PAD_PRIVATE(obj)      (GST_PROXY_PAD_CAST (obj)->priv)
  55 #define GST_PROXY_PAD_TARGET(pad)       (GST_PAD_PEER (GST_PROXY_PAD_INTERNAL (pad)))
  56 #define GST_PROXY_PAD_INTERNAL(pad)     (GST_PROXY_PAD_PRIVATE (pad)->internal)
  57
  58 #define GST_PROXY_PAD_ACQUIRE_INTERNAL(pad, internal, retval)           \
  59   internal =                                                            \
  60       GST_PAD_CAST (gst_proxy_pad_get_internal (GST_PROXY_PAD_CAST (pad))); \
  61   if (internal == NULL)                                                 \
  62     return retval;
  63
  64 #define GST_PROXY_PAD_RELEASE_INTERNAL(internal) gst_object_unref (internal);
  65
  66 struct _GstProxyPadPrivate
  67 {
  68   GstPad *internal;
  69 };
  70
  71 G_DEFINE_TYPE (GstProxyPad, gst_proxy_pad, GST_TYPE_PAD);
  72
  73 static GstPad *gst_proxy_pad_get_target (GstPad * pad);
  74
  75 /**
  76  * gst_proxy_pad_iterate_internal_links_default:
  77  * @pad: the #GstPad to get the internal links of.
  78  * @parent: (allow-none): the parent of @pad or %NULL
  79  *
  80  * Invoke the default iterate internal links function of the proxy pad.
  81  *
  82  * Returns: (nullable): a #GstIterator of #GstPad, or %NULL if @pad
  83  * has no parent. Unref each returned pad with gst_object_unref().
  84  */
  85 GstIterator *
  86 gst_proxy_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
  87 {
  88   GstIterator *res = NULL;
  89   GstPad *internal;
  90   GValue v = { 0, };
  91
  92   g_return_val_if_fail (GST_IS_PROXY_PAD (pad), NULL);
  93
  94   GST_PROXY_PAD_ACQUIRE_INTERNAL (pad, internal, NULL);
  95
  96   g_value_init (&v, GST_TYPE_PAD);
  97   g_value_take_object (&v, internal);
  98   res = gst_iterator_new_single (GST_TYPE_PAD, &v);
  99   g_value_unset (&v);
 100
 101   return res;
 102 }
 103
 104 /**
 105  * gst_proxy_pad_chain_default:
 106  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
 107  * @parent: (allow-none): the parent of @pad or %NULL
 108  * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
 109  *     if not.
 110  *
 111  * Invoke the default chain function of the proxy pad.
 112  *
 113  * Returns: a #GstFlowReturn from the pad.
 114  */
 115 GstFlowReturn
 116 gst_proxy_pad_chain_default (GstPad * pad, GstObject * parent,
 117     GstBuffer * buffer)
 118 {
 119   GstFlowReturn res;
 120   GstPad *internal;
 121
 122   g_return_val_if_fail (GST_IS_PROXY_PAD (pad), GST_FLOW_ERROR);
 123   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
 124
 125   GST_PROXY_PAD_ACQUIRE_INTERNAL (pad, internal, GST_FLOW_NOT_LINKED);
 126   res = gst_pad_push (internal, buffer);
 127   GST_PROXY_PAD_RELEASE_INTERNAL (internal);
 128
 129   return res;
 130 }
 131
 132 /**
 133  * gst_proxy_pad_chain_list_default:
 134  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
 135  * @parent: (allow-none): the parent of @pad or %NULL
 136  * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
 137  *     if not.
 138  *
 139  * Invoke the default chain list function of the proxy pad.
 140  *
 141  * Returns: a #GstFlowReturn from the pad.
 142  */
 143 GstFlowReturn
 144 gst_proxy_pad_chain_list_default (GstPad * pad, GstObject * parent,
 145     GstBufferList * list)
 146 {
 147   GstFlowReturn res;
 148   GstPad *internal;
 149
 150   g_return_val_if_fail (GST_IS_PROXY_PAD (pad), GST_FLOW_ERROR);
 151   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
 152
 153   GST_PROXY_PAD_ACQUIRE_INTERNAL (pad, internal, GST_FLOW_NOT_LINKED);
 154   res = gst_pad_push_list (internal, list);
 155   GST_PROXY_PAD_RELEASE_INTERNAL (internal);
 156
 157   return res;
 158 }
 159
 160 /**
 161  * gst_proxy_pad_getrange_default:
 162  * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
 163  * @parent: the parent of @pad
 164  * @offset: The start offset of the buffer
 165  * @size: The length of the buffer
 166  * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
 167  *     returns #GST_FLOW_ERROR if %NULL.
 168  *
 169  * Invoke the default getrange function of the proxy pad.
 170  *
 171  * Returns: a #GstFlowReturn from the pad.
 172  */
 173 GstFlowReturn
 174 gst_proxy_pad_getrange_default (GstPad * pad, GstObject * parent,
 175     guint64 offset, guint size, GstBuffer ** buffer)
 176 {
 177   GstFlowReturn res;
 178   GstPad *internal;
 179
 180   g_return_val_if_fail (GST_IS_PROXY_PAD (pad), GST_FLOW_ERROR);
 181   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
 182
 183   GST_PROXY_PAD_ACQUIRE_INTERNAL (pad, internal, GST_FLOW_NOT_LINKED);
 184   res = gst_pad_pull_range (internal, offset, size, buffer);
 185   GST_PROXY_PAD_RELEASE_INTERNAL (internal);
 186
 187   return res;
 188 }
 189
 190 static GstPad *
 191 gst_proxy_pad_get_target (GstPad * pad)
 192 {
 193   GstPad *target;
 194
 195   GST_OBJECT_LOCK (pad);
 196   target = gst_pad_get_peer (GST_PROXY_PAD_INTERNAL (pad));
 197   GST_OBJECT_UNLOCK (pad);
 198
 199   return target;
 200 }
 201
 202 /**
 203  * gst_proxy_pad_get_internal:
 204  * @pad: the #GstProxyPad
 205  *
 206  * Get the internal pad of @pad. Unref target pad after usage.
 207  *
 208  * The internal pad of a #GstGhostPad is the internally used
 209  * pad of opposite direction, which is used to link to the target.
 210  *
 211  * Returns: (transfer full) (nullable): the target #GstProxyPad, can
 212  * be %NULL.  Unref target pad after usage.
 213  */
 214 GstProxyPad *
 215 gst_proxy_pad_get_internal (GstProxyPad * pad)
 216 {
 217   GstPad *internal;
 218
 219   g_return_val_if_fail (GST_IS_PROXY_PAD (pad), NULL);
 220
 221   GST_OBJECT_LOCK (pad);
 222   internal = GST_PROXY_PAD_INTERNAL (pad);
 223   if (internal)
 224     gst_object_ref (internal);
 225   GST_OBJECT_UNLOCK (pad);
 226
 227   return GST_PROXY_PAD_CAST (internal);
 228 }
 229
 230 static void
 231 gst_proxy_pad_class_init (GstProxyPadClass * klass)
 232 {
 233   g_type_class_add_private (klass, sizeof (GstProxyPadPrivate));
 234
 235   /* Register common function pointer descriptions */
 236   GST_DEBUG_REGISTER_FUNCPTR (gst_proxy_pad_iterate_internal_links_default);
 237   GST_DEBUG_REGISTER_FUNCPTR (gst_proxy_pad_chain_default);
 238   GST_DEBUG_REGISTER_FUNCPTR (gst_proxy_pad_chain_list_default);
 239   GST_DEBUG_REGISTER_FUNCPTR (gst_proxy_pad_getrange_default);
 240 }
 241
 242 static void
 243 gst_proxy_pad_init (GstProxyPad * ppad)
 244 {
 245   GstPad *pad = (GstPad *) ppad;
 246
 247   GST_PROXY_PAD_PRIVATE (ppad) = G_TYPE_INSTANCE_GET_PRIVATE (ppad,
 248       GST_TYPE_PROXY_PAD, GstProxyPadPrivate);
 249
 250   gst_pad_set_iterate_internal_links_function (pad,
 251       gst_proxy_pad_iterate_internal_links_default);
 252
 253   GST_PAD_SET_PROXY_CAPS (pad);
 254   GST_PAD_SET_PROXY_SCHEDULING (pad);
 255   GST_PAD_SET_PROXY_ALLOCATION (pad);
 256 }
 257
 258
 259 /***********************************************************************
 260  * Ghost pads, implemented as a pair of proxy pads (sort of)
 261  */
 262
 263
 264 #define GST_GHOST_PAD_PRIVATE(obj)      (GST_GHOST_PAD_CAST (obj)->priv)
 265
 266 struct _GstGhostPadPrivate
 267 {
 268   /* with PROXY_LOCK */
 269   gboolean constructed;
 270 };
 271
 272 G_DEFINE_TYPE (GstGhostPad, gst_ghost_pad, GST_TYPE_PROXY_PAD);
 273
 274 static void gst_ghost_pad_dispose (GObject * object);
 275
 276 static gboolean
 277 gst_ghost_pad_internal_activate_push_default (GstPad * pad, GstObject * parent,
 278     gboolean active)
 279 {
 280   gboolean ret;
 281   GstPad *other;
 282
 283   GST_LOG_OBJECT (pad, "%sactivate push on %s:%s, we're ok",
 284       (active ? "" : "de"), GST_DEBUG_PAD_NAME (pad));
 285
 286   /* in both cases (SRC and SINK) we activate just the internal pad. The targets
 287    * will be activated later (or already in case of a ghost sinkpad). */
 288   GST_PROXY_PAD_ACQUIRE_INTERNAL (pad, other, FALSE);
 289   ret = gst_pad_activate_mode (other, GST_PAD_MODE_PUSH, active);
 290   GST_PROXY_PAD_RELEASE_INTERNAL (other);
 291
 292   return ret;
 293 }
 294
 295 static gboolean
 296 gst_ghost_pad_internal_activate_pull_default (GstPad * pad, GstObject * parent,
 297     gboolean active)
 298 {
 299   gboolean ret;
 300   GstPad *other;
 301
 302   GST_LOG_OBJECT (pad, "%sactivate pull on %s:%s", (active ? "" : "de"),
 303       GST_DEBUG_PAD_NAME (pad));
 304
 305   if (GST_PAD_DIRECTION (pad) == GST_PAD_SRC) {
 306     /* we are activated in pull mode by our peer element, which is a sinkpad
 307      * that wants to operate in pull mode. This activation has to propagate
 308      * upstream through the pipeline. We call the internal activation function,
 309      * which will trigger gst_ghost_pad_activate_pull_default, which propagates even
 310      * further upstream */
 311     GST_LOG_OBJECT (pad, "pad is src, activate internal");
 312     GST_PROXY_PAD_ACQUIRE_INTERNAL (pad, other, FALSE);
 313     ret = gst_pad_activate_mode (other, GST_PAD_MODE_PULL, active);
 314     GST_PROXY_PAD_RELEASE_INTERNAL (other);
 315   } else if (G_LIKELY ((other = gst_pad_get_peer (pad)))) {
 316     /* We are SINK, the ghostpad is SRC, we propagate the activation upstream
 317      * since we hold a pointer to the upstream peer. */
 318     GST_LOG_OBJECT (pad, "activating peer");
 319     ret = gst_pad_activate_mode (other, GST_PAD_MODE_PULL, active);
 320     gst_object_unref (other);
 321   } else {
 322     /* this is failure, we can't activate pull if there is no peer */
 323     GST_LOG_OBJECT (pad, "not src and no peer, failing");
 324     ret = FALSE;
 325   }
 326
 327   return ret;
 328 }
 329
 330 /**
 331  * gst_ghost_pad_internal_activate_mode_default:
 332  * @pad: the #GstPad to activate or deactivate.
 333  * @parent: (allow-none): the parent of @pad or %NULL
 334  * @mode: the requested activation mode
 335  * @active: whether the pad should be active or not.
 336  *
 337  * Invoke the default activate mode function of a proxy pad that is
 338  * owned by a ghost pad.
 339  *
 340  * Returns: %TRUE if the operation was successful.
 341  */
 342 gboolean
 343 gst_ghost_pad_internal_activate_mode_default (GstPad * pad, GstObject * parent,
 344     GstPadMode mode, gboolean active)
 345 {
 346   gboolean res;
 347
 348   g_return_val_if_fail (GST_IS_PROXY_PAD (pad), FALSE);
 349
 350   switch (mode) {
 351     case GST_PAD_MODE_PULL:
 352       res = gst_ghost_pad_internal_activate_pull_default (pad, parent, active);
 353       break;
 354     case GST_PAD_MODE_PUSH:
 355       res = gst_ghost_pad_internal_activate_push_default (pad, parent, active);
 356       break;
 357     default:
 358       GST_LOG_OBJECT (pad, "unknown activation mode %d", mode);
 359       res = FALSE;
 360       break;
 361   }
 362   return res;
 363 }
 364
 365 static gboolean
 366 gst_ghost_pad_activate_push_default (GstPad * pad, GstObject * parent,
 367     gboolean active)
 368 {
 369   gboolean ret;
 370   GstPad *other;
 371
 372   g_return_val_if_fail (GST_IS_GHOST_PAD (pad), FALSE);
 373
 374   GST_LOG_OBJECT (pad, "%sactivate push on %s:%s, proxy internal",
 375       (active ? "" : "de"), GST_DEBUG_PAD_NAME (pad));
 376
 377   /* just activate the internal pad */
 378   GST_PROXY_PAD_ACQUIRE_INTERNAL (pad, other, FALSE);
 379   ret = gst_pad_activate_mode (other, GST_PAD_MODE_PUSH, active);
 380   GST_PROXY_PAD_RELEASE_INTERNAL (other);
 381
 382   return ret;
 383 }
 384
 385 static gboolean
 386 gst_ghost_pad_activate_pull_default (GstPad * pad, GstObject * parent,
 387     gboolean active)
 388 {
 389   gboolean ret;
 390   GstPad *other;
 391
 392   GST_LOG_OBJECT (pad, "%sactivate pull on %s:%s", (active ? "" : "de"),
 393       GST_DEBUG_PAD_NAME (pad));
 394
 395   if (GST_PAD_DIRECTION (pad) == GST_PAD_SRC) {
 396     /* the ghostpad is SRC and activated in pull mode by its peer, call the
 397      * activation function of the internal pad to propagate the activation
 398      * upstream */
 399     GST_LOG_OBJECT (pad, "pad is src, activate internal");
 400     GST_PROXY_PAD_ACQUIRE_INTERNAL (pad, other, FALSE);
 401     ret = gst_pad_activate_mode (other, GST_PAD_MODE_PULL, active);
 402     GST_PROXY_PAD_RELEASE_INTERNAL (other);
 403   } else if (G_LIKELY ((other = gst_pad_get_peer (pad)))) {
 404     /* We are SINK and activated by the internal pad, propagate activation
 405      * upstream because we hold a ref to the upstream peer */
 406     GST_LOG_OBJECT (pad, "activating peer");
 407     ret = gst_pad_activate_mode (other, GST_PAD_MODE_PULL, active);
 408     gst_object_unref (other);
 409   } else {
 410     /* no peer, we fail */
 411     GST_LOG_OBJECT (pad, "pad not src and no peer, failing");
 412     ret = FALSE;
 413   }
 414
 415   return ret;
 416 }
 417
 418 /**
 419  * gst_ghost_pad_activate_mode_default:
 420  * @pad: the #GstPad to activate or deactivate.
 421  * @parent: (allow-none): the parent of @pad or %NULL
 422  * @mode: the requested activation mode
 423  * @active: whether the pad should be active or not.
 424  *
 425  * Invoke the default activate mode function of a ghost pad.
 426  *
 427  * Returns: %TRUE if the operation was successful.
 428  */
 429 gboolean
 430 gst_ghost_pad_activate_mode_default (GstPad * pad, GstObject * parent,
 431     GstPadMode mode, gboolean active)
 432 {
 433   gboolean res;
 434
 435   g_return_val_if_fail (GST_IS_GHOST_PAD (pad), FALSE);
 436
 437   switch (mode) {
 438     case GST_PAD_MODE_PULL:
 439       res = gst_ghost_pad_activate_pull_default (pad, parent, active);
 440       break;
 441     case GST_PAD_MODE_PUSH:
 442       res = gst_ghost_pad_activate_push_default (pad, parent, active);
 443       break;
 444     default:
 445       GST_LOG_OBJECT (pad, "unknown activation mode %d", mode);
 446       res = FALSE;
 447       break;
 448   }
 449   return res;
 450 }
 451
 452 static void
 453 gst_ghost_pad_class_init (GstGhostPadClass * klass)
 454 {
 455   GObjectClass *gobject_class = (GObjectClass *) klass;
 456
 457   g_type_class_add_private (klass, sizeof (GstGhostPadPrivate));
 458
 459   gobject_class->dispose = gst_ghost_pad_dispose;
 460
 461   GST_DEBUG_REGISTER_FUNCPTR (gst_ghost_pad_activate_pull_default);
 462   GST_DEBUG_REGISTER_FUNCPTR (gst_ghost_pad_activate_push_default);
 463 }
 464
 465 static void
 466 gst_ghost_pad_init (GstGhostPad * pad)
 467 {
 468   GST_GHOST_PAD_PRIVATE (pad) = G_TYPE_INSTANCE_GET_PRIVATE (pad,
 469       GST_TYPE_GHOST_PAD, GstGhostPadPrivate);
 470
 471   gst_pad_set_activatemode_function (GST_PAD_CAST (pad),
 472       gst_ghost_pad_activate_mode_default);
 473 }
 474
 475 static void
 476 gst_ghost_pad_dispose (GObject * object)
 477 {
 478   GstPad *pad;
 479   GstPad *internal;
 480   GstPad *peer;
 481
 482   pad = GST_PAD (object);
 483
 484   GST_DEBUG_OBJECT (pad, "dispose");
 485
 486   gst_ghost_pad_set_target (GST_GHOST_PAD (pad), NULL);
 487
 488   /* Unlink here so that gst_pad_dispose doesn't. That would lead to a call to
 489    * gst_ghost_pad_unlink_default when the ghost pad is in an inconsistent state */
 490   peer = gst_pad_get_peer (pad);
 491   if (peer) {
 492     if (GST_PAD_IS_SRC (pad))
 493       gst_pad_unlink (pad, peer);
 494     else
 495       gst_pad_unlink (peer, pad);
 496
 497     gst_object_unref (peer);
 498   }
 499
 500   GST_OBJECT_LOCK (pad);
 501   internal = GST_PROXY_PAD_INTERNAL (pad);
 502
 503   gst_pad_set_activatemode_function (internal, NULL);
 504
 505   /* disposes of the internal pad, since the ghostpad is the only possible object
 506    * that has a refcount on the internal pad. */
 507   gst_object_unparent (GST_OBJECT_CAST (internal));
 508   GST_PROXY_PAD_INTERNAL (pad) = NULL;
 509
 510   GST_OBJECT_UNLOCK (pad);
 511
 512   G_OBJECT_CLASS (gst_ghost_pad_parent_class)->dispose (object);
 513 }
 514
 515 /**
 516  * gst_ghost_pad_construct:
 517  * @gpad: the newly allocated ghost pad
 518  *
 519  * Finish initialization of a newly allocated ghost pad.
 520  *
 521  * This function is most useful in language bindings and when subclassing
 522  * #GstGhostPad; plugin and application developers normally will not call this
 523  * function. Call this function directly after a call to g_object_new
 524  * (GST_TYPE_GHOST_PAD, "direction", @dir, ..., NULL).
 525  *
 526  * Returns: %TRUE if the construction succeeds, %FALSE otherwise.
 527  */
 528 gboolean
 529 gst_ghost_pad_construct (GstGhostPad * gpad)
 530 {
 531   GstPadDirection dir, otherdir;
 532   GstPadTemplate *templ;
 533   GstPad *pad, *internal;
 534
 535   g_return_val_if_fail (GST_IS_GHOST_PAD (gpad), FALSE);
 536   g_return_val_if_fail (!GST_GHOST_PAD_PRIVATE (gpad)->constructed, FALSE);
 537
 538   g_object_get (gpad, "direction", &dir, "template", &templ, NULL);
 539
 540   g_return_val_if_fail (dir != GST_PAD_UNKNOWN, FALSE);
 541
 542   pad = GST_PAD (gpad);
 543
 544   /* Set directional padfunctions for ghostpad */
 545   if (dir == GST_PAD_SINK) {
 546     gst_pad_set_chain_function (pad, gst_proxy_pad_chain_default);
 547     gst_pad_set_chain_list_function (pad, gst_proxy_pad_chain_list_default);
 548   } else {
 549     gst_pad_set_getrange_function (pad, gst_proxy_pad_getrange_default);
 550   }
 551
 552   /* INTERNAL PAD, it always exists and is child of the ghostpad */
 553   otherdir = (dir == GST_PAD_SRC) ? GST_PAD_SINK : GST_PAD_SRC;
 554   if (templ) {
 555     internal =
 556         g_object_new (GST_TYPE_PROXY_PAD, "name", NULL,
 557         "direction", otherdir, "template", templ, NULL);
 558     /* release ref obtained via g_object_get */
 559     gst_object_unref (templ);
 560   } else {
 561     internal =
 562         g_object_new (GST_TYPE_PROXY_PAD, "name", NULL,
 563         "direction", otherdir, NULL);
 564   }
 565   GST_PAD_UNSET_FLUSHING (internal);
 566
 567   /* Set directional padfunctions for internal pad */
 568   if (dir == GST_PAD_SRC) {
 569     gst_pad_set_chain_function (internal, gst_proxy_pad_chain_default);
 570     gst_pad_set_chain_list_function (internal,
 571         gst_proxy_pad_chain_list_default);
 572   } else {
 573     gst_pad_set_getrange_function (internal, gst_proxy_pad_getrange_default);
 574   }
 575
 576   GST_OBJECT_LOCK (pad);
 577
 578   /* now make the ghostpad a parent of the internal pad */
 579   if (!gst_object_set_parent (GST_OBJECT_CAST (internal),
 580           GST_OBJECT_CAST (pad)))
 581     goto parent_failed;
 582
 583   /* The ghostpad is the parent of the internal pad and is the only object that
 584    * can have a refcount on the internal pad.
 585    * At this point, the GstGhostPad has a refcount of 1, and the internal pad has
 586    * a refcount of 1.
 587    * When the refcount of the GstGhostPad drops to 0, the ghostpad will dispose
 588    * its refcount on the internal pad in the dispose method by un-parenting it.
 589    * This is why we don't take extra refcounts in the assignments below
 590    */
 591   GST_PROXY_PAD_INTERNAL (pad) = internal;
 592   GST_PROXY_PAD_INTERNAL (internal) = pad;
 593
 594   /* special activation functions for the internal pad */
 595   gst_pad_set_activatemode_function (internal,
 596       gst_ghost_pad_internal_activate_mode_default);
 597
 598   GST_OBJECT_UNLOCK (pad);
 599
 600   GST_GHOST_PAD_PRIVATE (gpad)->constructed = TRUE;
 601   return TRUE;
 602
 603   /* ERRORS */
 604 parent_failed:
 605   {
 606     GST_WARNING_OBJECT (gpad, "Could not set internal pad %s:%s",
 607         GST_DEBUG_PAD_NAME (internal));
 608     g_critical ("Could not set internal pad %s:%s",
 609         GST_DEBUG_PAD_NAME (internal));
 610     GST_OBJECT_UNLOCK (pad);
 611     gst_object_unref (internal);
 612     return FALSE;
 613   }
 614 }
 615
 616 static GstPad *
 617 gst_ghost_pad_new_full (const gchar * name, GstPadDirection dir,
 618     GstPadTemplate * templ)
 619 {
 620   GstGhostPad *ret;
 621
 622   g_return_val_if_fail (dir != GST_PAD_UNKNOWN, NULL);
 623
 624   /* OBJECT CREATION */
 625   if (templ) {
 626     ret = g_object_new (GST_TYPE_GHOST_PAD, "name", name,
 627         "direction", dir, "template", templ, NULL);
 628   } else {
 629     ret = g_object_new (GST_TYPE_GHOST_PAD, "name", name,
 630         "direction", dir, NULL);
 631   }
 632
 633   if (!gst_ghost_pad_construct (ret))
 634     goto construct_failed;
 635
 636   return GST_PAD_CAST (ret);
 637
 638 construct_failed:
 639   /* already logged */
 640   gst_object_unref (ret);
 641   return NULL;
 642 }
 643
 644 /**
 645  * gst_ghost_pad_new_no_target:
 646  * @name: (allow-none): the name of the new pad, or %NULL to assign a default name.
 647  * @dir: the direction of the ghostpad
 648  *
 649  * Create a new ghostpad without a target with the given direction.
 650  * A target can be set on the ghostpad later with the
 651  * gst_ghost_pad_set_target() function.
 652  *
 653  * The created ghostpad will not have a padtemplate.
 654  *
 655  * Returns: (transfer full) (nullable): a new #GstPad, or %NULL in
 656  * case of an error.
 657  */
 658 GstPad *
 659 gst_ghost_pad_new_no_target (const gchar * name, GstPadDirection dir)
 660 {
 661   GstPad *ret;
 662
 663   g_return_val_if_fail (dir != GST_PAD_UNKNOWN, NULL);
 664
 665   GST_LOG ("name:%s, direction:%d", GST_STR_NULL (name), dir);
 666
 667   ret = gst_ghost_pad_new_full (name, dir, NULL);
 668
 669   return ret;
 670 }
 671
 672 /**
 673  * gst_ghost_pad_new:
 674  * @name: (allow-none): the name of the new pad, or %NULL to assign a default name
 675  * @target: (transfer none): the pad to ghost.
 676  *
 677  * Create a new ghostpad with @target as the target. The direction will be taken
 678  * from the target pad. @target must be unlinked.
 679  *
 680  * Will ref the target.
 681  *
 682  * Returns: (transfer floating) (nullable): a new #GstPad, or %NULL in
 683  * case of an error.
 684  */
 685 GstPad *
 686 gst_ghost_pad_new (const gchar * name, GstPad * target)
 687 {
 688   GstPad *ret;
 689
 690   g_return_val_if_fail (GST_IS_PAD (target), NULL);
 691   g_return_val_if_fail (!gst_pad_is_linked (target), NULL);
 692
 693   GST_LOG ("name:%s, target:%s:%s", GST_STR_NULL (name),
 694       GST_DEBUG_PAD_NAME (target));
 695
 696   if ((ret = gst_ghost_pad_new_no_target (name, GST_PAD_DIRECTION (target))))
 697     if (!gst_ghost_pad_set_target (GST_GHOST_PAD_CAST (ret), target))
 698       goto set_target_failed;
 699
 700   return ret;
 701
 702   /* ERRORS */
 703 set_target_failed:
 704   {
 705     GST_WARNING_OBJECT (ret, "failed to set target %s:%s",
 706         GST_DEBUG_PAD_NAME (target));
 707     gst_object_unref (ret);
 708     return NULL;
 709   }
 710 }
 711
 712 /**
 713  * gst_ghost_pad_new_from_template:
 714  * @name: (allow-none): the name of the new pad, or %NULL to assign a default name.
 715  * @target: (transfer none): the pad to ghost.
 716  * @templ: (transfer none): the #GstPadTemplate to use on the ghostpad.
 717  *
 718  * Create a new ghostpad with @target as the target. The direction will be taken
 719  * from the target pad. The template used on the ghostpad will be @template.
 720  *
 721  * Will ref the target.
 722  *
 723  * Returns: (transfer full) (nullable): a new #GstPad, or %NULL in
 724  * case of an error.
 725  */
 726
 727 GstPad *
 728 gst_ghost_pad_new_from_template (const gchar * name, GstPad * target,
 729     GstPadTemplate * templ)
 730 {
 731   GstPad *ret;
 732
 733   g_return_val_if_fail (GST_IS_PAD (target), NULL);
 734   g_return_val_if_fail (!gst_pad_is_linked (target), NULL);
 735   g_return_val_if_fail (templ != NULL, NULL);
 736   g_return_val_if_fail (GST_PAD_TEMPLATE_DIRECTION (templ) ==
 737       GST_PAD_DIRECTION (target), NULL);
 738
 739   GST_LOG ("name:%s, target:%s:%s, templ:%p", GST_STR_NULL (name),
 740       GST_DEBUG_PAD_NAME (target), templ);
 741
 742   if ((ret = gst_ghost_pad_new_full (name, GST_PAD_DIRECTION (target), templ)))
 743     if (!gst_ghost_pad_set_target (GST_GHOST_PAD_CAST (ret), target))
 744       goto set_target_failed;
 745
 746   return ret;
 747
 748   /* ERRORS */
 749 set_target_failed:
 750   {
 751     GST_WARNING_OBJECT (ret, "failed to set target %s:%s",
 752         GST_DEBUG_PAD_NAME (target));
 753     gst_object_unref (ret);
 754     return NULL;
 755   }
 756 }
 757
 758 /**
 759  * gst_ghost_pad_new_no_target_from_template:
 760  * @name: (allow-none): the name of the new pad, or %NULL to assign a default name
 761  * @templ: (transfer none): the #GstPadTemplate to create the ghostpad from.
 762  *
 763  * Create a new ghostpad based on @templ, without setting a target. The
 764  * direction will be taken from the @templ.
 765  *
 766  * Returns: (transfer full) (nullable): a new #GstPad, or %NULL in
 767  * case of an error.
 768  */
 769 GstPad *
 770 gst_ghost_pad_new_no_target_from_template (const gchar * name,
 771     GstPadTemplate * templ)
 772 {
 773   GstPad *ret;
 774
 775   g_return_val_if_fail (templ != NULL, NULL);
 776
 777   ret =
 778       gst_ghost_pad_new_full (name, GST_PAD_TEMPLATE_DIRECTION (templ), templ);
 779
 780   return ret;
 781 }
 782
 783 /**
 784  * gst_ghost_pad_get_target:
 785  * @gpad: the #GstGhostPad
 786  *
 787  * Get the target pad of @gpad. Unref target pad after usage.
 788  *
 789  * Returns: (transfer full) (nullable): the target #GstPad, can be
 790  * %NULL if the ghostpad has no target set. Unref target pad after
 791  * usage.
 792  */
 793 GstPad *
 794 gst_ghost_pad_get_target (GstGhostPad * gpad)
 795 {
 796   GstPad *ret;
 797
 798   g_return_val_if_fail (GST_IS_GHOST_PAD (gpad), NULL);
 799
 800   ret = gst_proxy_pad_get_target (GST_PAD_CAST (gpad));
 801
 802   GST_DEBUG_OBJECT (gpad, "get target %s:%s", GST_DEBUG_PAD_NAME (ret));
 803
 804   return ret;
 805 }
 806
 807 /**
 808  * gst_ghost_pad_set_target:
 809  * @gpad: the #GstGhostPad
 810  * @newtarget: (transfer none) (allow-none): the new pad target
 811  *
 812  * Set the new target of the ghostpad @gpad. Any existing target
 813  * is unlinked and links to the new target are established. if @newtarget is
 814  * %NULL the target will be cleared.
 815  *
 816  * Returns: (transfer full): %TRUE if the new target could be set. This function
 817  *     can return %FALSE when the internal pads could not be linked.
 818  */
 819 gboolean
 820 gst_ghost_pad_set_target (GstGhostPad * gpad, GstPad * newtarget)
 821 {
 822   GstPad *internal;
 823   GstPad *oldtarget;
 824   GstPadLinkReturn lret;
 825
 826   g_return_val_if_fail (GST_IS_GHOST_PAD (gpad), FALSE);
 827   g_return_val_if_fail (GST_PAD_CAST (gpad) != newtarget, FALSE);
 828   g_return_val_if_fail (newtarget != GST_PROXY_PAD_INTERNAL (gpad), FALSE);
 829
 830   GST_OBJECT_LOCK (gpad);
 831   internal = GST_PROXY_PAD_INTERNAL (gpad);
 832
 833   if (newtarget)
 834     GST_DEBUG_OBJECT (gpad, "set target %s:%s", GST_DEBUG_PAD_NAME (newtarget));
 835   else
 836     GST_DEBUG_OBJECT (gpad, "clearing target");
 837
 838   /* clear old target */
 839   if ((oldtarget = gst_pad_get_peer (internal))) {
 840     GST_OBJECT_UNLOCK (gpad);
 841
 842     /* unlink internal pad */
 843     if (GST_PAD_IS_SRC (internal))
 844       gst_pad_unlink (internal, oldtarget);
 845     else
 846       gst_pad_unlink (oldtarget, internal);
 847
 848     gst_object_unref (oldtarget);
 849   } else {
 850     GST_OBJECT_UNLOCK (gpad);
 851   }
 852
 853   if (newtarget) {
 854     /* and link to internal pad without any checks */
 855     GST_DEBUG_OBJECT (gpad, "connecting internal pad to target %"
 856         GST_PTR_FORMAT, newtarget);
 857
 858     if (GST_PAD_IS_SRC (internal))
 859       lret =
 860           gst_pad_link_full (internal, newtarget, GST_PAD_LINK_CHECK_NOTHING);
 861     else
 862       lret =
 863           gst_pad_link_full (newtarget, internal, GST_PAD_LINK_CHECK_NOTHING);
 864
 865     if (lret != GST_PAD_LINK_OK)
 866       goto link_failed;
 867   }
 868
 869   return TRUE;
 870
 871   /* ERRORS */
 872 link_failed:
 873   {
 874     GST_WARNING_OBJECT (gpad, "could not link internal and target, reason:%s",
 875         gst_pad_link_get_name (lret));
 876     return FALSE;
 877   }
 878 }