plugins/elements/gsttee.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *               2000,2001,2002,2003,2004,2005 Wim Taymans <wim@fluendo.com>
   4  *               2007 Wim Taymans <wim.taymans@gmail.com>
   5  *
   6  * gsttee.c: Tee element, one in N out
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:element-tee
  26  * @see_also: #GstIdentity
  27  *
  28  * Split data to multiple pads. Branching the data flow is useful when e.g.
  29  * capturing a video where the video is shown on the screen and also encoded and
  30  * written to a file. Another example is playing music and hooking up a
  31  * visualisation module.
  32  *
  33  * One needs to use separate queue elements (or a multiqueue) in each branch to
  34  * provide separate threads for each branch. Otherwise a blocked dataflow in one
  35  * branch would stall the other branches.
  36  *
  37  * <refsect2>
  38  * <title>Example launch line</title>
  39  * |[
  40  * gst-launch filesrc location=song.ogg ! decodebin2 ! tee name=t ! queue ! autoaudiosink t. ! queue ! audioconvert ! goom ! ffmpegcolorspace ! autovideosink
  41  * ]| Play a song.ogg from local dir and render visualisations using the goom
  42  * element.
  43  * </refsect2>
  44  */
  45
  46 #ifdef HAVE_CONFIG_H
  47 #  include "config.h"
  48 #endif
  49
  50 #include "gsttee.h"
  51 #include "gst/glib-compat-private.h"
  52
  53 #include <string.h>
  54
  55 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  56     GST_PAD_SINK,
  57     GST_PAD_ALWAYS,
  58     GST_STATIC_CAPS_ANY);
  59
  60 GST_DEBUG_CATEGORY_STATIC (gst_tee_debug);
  61 #define GST_CAT_DEFAULT gst_tee_debug
  62
  63 #define GST_TYPE_TEE_PULL_MODE (gst_tee_pull_mode_get_type())
  64 static GType
  65 gst_tee_pull_mode_get_type (void)
  66 {
  67   static GType type = 0;
  68   static const GEnumValue data[] = {
  69     {GST_TEE_PULL_MODE_NEVER, "Never activate in pull mode", "never"},
  70     {GST_TEE_PULL_MODE_SINGLE, "Only one src pad can be active in pull mode",
  71         "single"},
  72     {0, NULL, NULL},
  73   };
  74
  75   if (!type) {
  76     type = g_enum_register_static ("GstTeePullMode", data);
  77   }
  78   return type;
  79 }
  80
  81 /* lock to protect request pads from being removed while downstream */
  82 #define GST_TEE_DYN_LOCK(tee) g_mutex_lock ((tee)->dyn_lock)
  83 #define GST_TEE_DYN_UNLOCK(tee) g_mutex_unlock ((tee)->dyn_lock)
  84
  85 #define DEFAULT_PROP_NUM_SRC_PADS       0
  86 #define DEFAULT_PROP_HAS_SINK_LOOP      FALSE
  87 #define DEFAULT_PROP_HAS_CHAIN          TRUE
  88 #define DEFAULT_PROP_SILENT             TRUE
  89 #define DEFAULT_PROP_LAST_MESSAGE       NULL
  90 #define DEFAULT_PULL_MODE               GST_TEE_PULL_MODE_NEVER
  91
  92 enum
  93 {
  94   PROP_0,
  95   PROP_NUM_SRC_PADS,
  96   PROP_HAS_SINK_LOOP,
  97   PROP_HAS_CHAIN,
  98   PROP_SILENT,
  99   PROP_LAST_MESSAGE,
 100   PROP_PULL_MODE,
 101   PROP_ALLOC_PAD,
 102 };
 103
 104 static GstStaticPadTemplate tee_src_template = GST_STATIC_PAD_TEMPLATE ("src%d",
 105     GST_PAD_SRC,
 106     GST_PAD_REQUEST,
 107     GST_STATIC_CAPS_ANY);
 108
 109 #define _do_init(bla) \
 110     GST_DEBUG_CATEGORY_INIT (gst_tee_debug, "tee", 0, "tee element");
 111
 112 GST_BOILERPLATE_FULL (GstTee, gst_tee, GstElement, GST_TYPE_ELEMENT, _do_init);
 113
 114 /* structure and quark to keep track of which pads have been pushed */
 115 static GQuark push_data;
 116
 117 static GParamSpec *pspec_last_message = NULL;
 118 static GParamSpec *pspec_alloc_pad = NULL;
 119
 120 typedef struct
 121 {
 122   gboolean pushed;
 123   GstFlowReturn result;
 124   gboolean removed;
 125 } PushData;
 126
 127 static GstPad *gst_tee_request_new_pad (GstElement * element,
 128     GstPadTemplate * temp, const gchar * unused);
 129 static void gst_tee_release_pad (GstElement * element, GstPad * pad);
 130
 131 static void gst_tee_finalize (GObject * object);
 132 static void gst_tee_set_property (GObject * object, guint prop_id,
 133     const GValue * value, GParamSpec * pspec);
 134 static void gst_tee_get_property (GObject * object, guint prop_id,
 135     GValue * value, GParamSpec * pspec);
 136 static void gst_tee_dispose (GObject * object);
 137
 138 static GstFlowReturn gst_tee_chain (GstPad * pad, GstBuffer * buffer);
 139 static GstFlowReturn gst_tee_chain_list (GstPad * pad, GstBufferList * list);
 140 static GstFlowReturn gst_tee_buffer_alloc (GstPad * pad, guint64 offset,
 141     guint size, GstCaps * caps, GstBuffer ** buf);
 142 static gboolean gst_tee_sink_acceptcaps (GstPad * pad, GstCaps * caps);
 143 static gboolean gst_tee_sink_activate_push (GstPad * pad, gboolean active);
 144 static gboolean gst_tee_src_check_get_range (GstPad * pad);
 145 static gboolean gst_tee_src_activate_pull (GstPad * pad, gboolean active);
 146 static GstFlowReturn gst_tee_src_get_range (GstPad * pad, guint64 offset,
 147     guint length, GstBuffer ** buf);
 148
 149
 150 static void
 151 gst_tee_base_init (gpointer g_class)
 152 {
 153   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 154
 155   gst_element_class_set_details_simple (gstelement_class,
 156       "Tee pipe fitting",
 157       "Generic",
 158       "1-to-N pipe fitting",
 159       "Erik Walthinsen <omega@cse.ogi.edu>, " "Wim Taymans <wim@fluendo.com>");
 160   gst_element_class_add_pad_template (gstelement_class,
 161       gst_static_pad_template_get (&sinktemplate));
 162   gst_element_class_add_pad_template (gstelement_class,
 163       gst_static_pad_template_get (&tee_src_template));
 164
 165   push_data = g_quark_from_static_string ("tee-push-data");
 166 }
 167
 168 static void
 169 gst_tee_dispose (GObject * object)
 170 {
 171   GList *item;
 172
 173 restart:
 174   for (item = GST_ELEMENT_PADS (object); item; item = g_list_next (item)) {
 175     GstPad *pad = GST_PAD (item->data);
 176     if (GST_PAD_IS_SRC (pad)) {
 177       gst_element_release_request_pad (GST_ELEMENT (object), pad);
 178       goto restart;
 179     }
 180   }
 181
 182   G_OBJECT_CLASS (parent_class)->dispose (object);
 183 }
 184
 185 static void
 186 gst_tee_finalize (GObject * object)
 187 {
 188   GstTee *tee;
 189
 190   tee = GST_TEE (object);
 191
 192   g_free (tee->last_message);
 193
 194   g_mutex_free (tee->dyn_lock);
 195
 196   G_OBJECT_CLASS (parent_class)->finalize (object);
 197 }
 198
 199 static void
 200 gst_tee_class_init (GstTeeClass * klass)
 201 {
 202   GObjectClass *gobject_class;
 203   GstElementClass *gstelement_class;
 204
 205   gobject_class = G_OBJECT_CLASS (klass);
 206   gstelement_class = GST_ELEMENT_CLASS (klass);
 207
 208   gobject_class->finalize = gst_tee_finalize;
 209   gobject_class->set_property = gst_tee_set_property;
 210   gobject_class->get_property = gst_tee_get_property;
 211   gobject_class->dispose = gst_tee_dispose;
 212
 213   g_object_class_install_property (gobject_class, PROP_NUM_SRC_PADS,
 214       g_param_spec_int ("num-src-pads", "Num Src Pads",
 215           "The number of source pads", 0, G_MAXINT, DEFAULT_PROP_NUM_SRC_PADS,
 216           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 217   g_object_class_install_property (gobject_class, PROP_HAS_SINK_LOOP,
 218       g_param_spec_boolean ("has-sink-loop", "Has Sink Loop",
 219           "If the element should spawn a thread (unimplemented and deprecated)",
 220           DEFAULT_PROP_HAS_SINK_LOOP,
 221           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 222   g_object_class_install_property (gobject_class, PROP_HAS_CHAIN,
 223       g_param_spec_boolean ("has-chain", "Has Chain",
 224           "If the element can operate in push mode", DEFAULT_PROP_HAS_CHAIN,
 225           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 226   g_object_class_install_property (gobject_class, PROP_SILENT,
 227       g_param_spec_boolean ("silent", "Silent",
 228           "Don't produce last_message events", DEFAULT_PROP_SILENT,
 229           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 230   pspec_last_message = g_param_spec_string ("last-message", "Last Message",
 231       "The message describing current status", DEFAULT_PROP_LAST_MESSAGE,
 232       G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 233   g_object_class_install_property (gobject_class, PROP_LAST_MESSAGE,
 234       pspec_last_message);
 235   g_object_class_install_property (gobject_class, PROP_PULL_MODE,
 236       g_param_spec_enum ("pull-mode", "Pull mode",
 237           "Behavior of tee in pull mode", GST_TYPE_TEE_PULL_MODE,
 238           DEFAULT_PULL_MODE,
 239           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 240   pspec_alloc_pad = g_param_spec_object ("alloc-pad", "Allocation Src Pad",
 241       "The pad used for gst_pad_alloc_buffer", GST_TYPE_PAD,
 242       G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 243   g_object_class_install_property (gobject_class, PROP_ALLOC_PAD,
 244       pspec_alloc_pad);
 245
 246   gstelement_class->request_new_pad =
 247       GST_DEBUG_FUNCPTR (gst_tee_request_new_pad);
 248   gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_tee_release_pad);
 249 }
 250
 251 static void
 252 gst_tee_init (GstTee * tee, GstTeeClass * g_class)
 253 {
 254   tee->dyn_lock = g_mutex_new ();
 255
 256   tee->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
 257   tee->sink_mode = GST_ACTIVATE_NONE;
 258
 259   gst_pad_set_setcaps_function (tee->sinkpad,
 260       GST_DEBUG_FUNCPTR (gst_pad_proxy_setcaps));
 261   gst_pad_set_getcaps_function (tee->sinkpad,
 262       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 263   gst_pad_set_acceptcaps_function (tee->sinkpad,
 264       GST_DEBUG_FUNCPTR (gst_tee_sink_acceptcaps));
 265   gst_pad_set_bufferalloc_function (tee->sinkpad,
 266       GST_DEBUG_FUNCPTR (gst_tee_buffer_alloc));
 267   gst_pad_set_activatepush_function (tee->sinkpad,
 268       GST_DEBUG_FUNCPTR (gst_tee_sink_activate_push));
 269   gst_pad_set_chain_function (tee->sinkpad, GST_DEBUG_FUNCPTR (gst_tee_chain));
 270   gst_pad_set_chain_list_function (tee->sinkpad,
 271       GST_DEBUG_FUNCPTR (gst_tee_chain_list));
 272   gst_element_add_pad (GST_ELEMENT (tee), tee->sinkpad);
 273
 274   tee->last_message = NULL;
 275 }
 276
 277 static void
 278 gst_tee_notify_alloc_pad (GstTee * tee)
 279 {
 280 #if !GLIB_CHECK_VERSION(2,26,0)
 281   g_object_notify ((GObject *) tee, "alloc-pad");
 282 #else
 283   g_object_notify_by_pspec ((GObject *) tee, pspec_alloc_pad);
 284 #endif
 285 }
 286
 287 static GstPad *
 288 gst_tee_request_new_pad (GstElement * element, GstPadTemplate * templ,
 289     const gchar * unused)
 290 {
 291   gchar *name;
 292   GstPad *srcpad;
 293   GstTee *tee;
 294   GstActivateMode mode;
 295   gboolean res;
 296   PushData *data;
 297
 298   tee = GST_TEE (element);
 299
 300   GST_DEBUG_OBJECT (tee, "requesting pad");
 301
 302   GST_OBJECT_LOCK (tee);
 303   name = g_strdup_printf ("src%d", tee->pad_counter++);
 304
 305   srcpad = gst_pad_new_from_template (templ, name);
 306   g_free (name);
 307
 308   mode = tee->sink_mode;
 309
 310   /* install the data, we automatically free it when the pad is disposed because
 311    * of _release_pad or when the element goes away. */
 312   data = g_new0 (PushData, 1);
 313   data->pushed = FALSE;
 314   data->result = GST_FLOW_NOT_LINKED;
 315   data->removed = FALSE;
 316   g_object_set_qdata_full (G_OBJECT (srcpad), push_data, data, g_free);
 317
 318   GST_OBJECT_UNLOCK (tee);
 319
 320   switch (mode) {
 321     case GST_ACTIVATE_PULL:
 322       /* we already have a src pad in pull mode, and our pull mode can only be
 323          SINGLE, so fall through to activate this new pad in push mode */
 324     case GST_ACTIVATE_PUSH:
 325       res = gst_pad_activate_push (srcpad, TRUE);
 326       break;
 327     default:
 328       res = TRUE;
 329       break;
 330   }
 331
 332   if (!res)
 333     goto activate_failed;
 334
 335   gst_pad_set_setcaps_function (srcpad,
 336       GST_DEBUG_FUNCPTR (gst_pad_proxy_setcaps));
 337   gst_pad_set_getcaps_function (srcpad,
 338       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 339   gst_pad_set_activatepull_function (srcpad,
 340       GST_DEBUG_FUNCPTR (gst_tee_src_activate_pull));
 341   gst_pad_set_checkgetrange_function (srcpad,
 342       GST_DEBUG_FUNCPTR (gst_tee_src_check_get_range));
 343   gst_pad_set_getrange_function (srcpad,
 344       GST_DEBUG_FUNCPTR (gst_tee_src_get_range));
 345   gst_element_add_pad (GST_ELEMENT_CAST (tee), srcpad);
 346
 347   return srcpad;
 348
 349   /* ERRORS */
 350 activate_failed:
 351   {
 352     gboolean changed = FALSE;
 353
 354     GST_OBJECT_LOCK (tee);
 355     GST_DEBUG_OBJECT (tee, "warning failed to activate request pad");
 356     if (tee->allocpad == srcpad) {
 357       tee->allocpad = NULL;
 358       changed = TRUE;
 359     }
 360     GST_OBJECT_UNLOCK (tee);
 361     gst_object_unref (srcpad);
 362     if (changed) {
 363       gst_tee_notify_alloc_pad (tee);
 364     }
 365     return NULL;
 366   }
 367 }
 368
 369 static void
 370 gst_tee_release_pad (GstElement * element, GstPad * pad)
 371 {
 372   GstTee *tee;
 373   PushData *data;
 374   gboolean changed = FALSE;
 375
 376   tee = GST_TEE (element);
 377
 378   GST_DEBUG_OBJECT (tee, "releasing pad");
 379
 380   /* wait for pending pad_alloc to finish */
 381   GST_TEE_DYN_LOCK (tee);
 382   data = g_object_get_qdata (G_OBJECT (pad), push_data);
 383
 384   GST_OBJECT_LOCK (tee);
 385   /* mark the pad as removed so that future pad_alloc fails with NOT_LINKED. */
 386   data->removed = TRUE;
 387   if (tee->allocpad == pad) {
 388     tee->allocpad = NULL;
 389     changed = TRUE;
 390   }
 391   GST_OBJECT_UNLOCK (tee);
 392
 393   gst_pad_set_active (pad, FALSE);
 394
 395   gst_element_remove_pad (GST_ELEMENT_CAST (tee), pad);
 396   GST_TEE_DYN_UNLOCK (tee);
 397
 398   if (changed) {
 399     gst_tee_notify_alloc_pad (tee);
 400   }
 401 }
 402
 403 static void
 404 gst_tee_set_property (GObject * object, guint prop_id, const GValue * value,
 405     GParamSpec * pspec)
 406 {
 407   GstTee *tee = GST_TEE (object);
 408
 409   GST_OBJECT_LOCK (tee);
 410   switch (prop_id) {
 411     case PROP_HAS_SINK_LOOP:
 412       tee->has_sink_loop = g_value_get_boolean (value);
 413       if (tee->has_sink_loop) {
 414         g_warning ("tee will never implement has-sink-loop==TRUE");
 415       }
 416       break;
 417     case PROP_HAS_CHAIN:
 418       tee->has_chain = g_value_get_boolean (value);
 419       break;
 420     case PROP_SILENT:
 421       tee->silent = g_value_get_boolean (value);
 422       break;
 423     case PROP_PULL_MODE:
 424       tee->pull_mode = g_value_get_enum (value);
 425       break;
 426     case PROP_ALLOC_PAD:
 427     {
 428       GstPad *pad = g_value_get_object (value);
 429       GST_OBJECT_LOCK (pad);
 430       if (GST_OBJECT_PARENT (pad) == GST_OBJECT_CAST (object))
 431         tee->allocpad = pad;
 432       else
 433         GST_WARNING_OBJECT (object, "Tried to set alloc pad %s which"
 434             " is not my pad", GST_OBJECT_NAME (pad));
 435       GST_OBJECT_UNLOCK (pad);
 436       break;
 437     }
 438     default:
 439       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 440       break;
 441   }
 442   GST_OBJECT_UNLOCK (tee);
 443 }
 444
 445 static void
 446 gst_tee_get_property (GObject * object, guint prop_id, GValue * value,
 447     GParamSpec * pspec)
 448 {
 449   GstTee *tee = GST_TEE (object);
 450
 451   GST_OBJECT_LOCK (tee);
 452   switch (prop_id) {
 453     case PROP_NUM_SRC_PADS:
 454       g_value_set_int (value, GST_ELEMENT (tee)->numsrcpads);
 455       break;
 456     case PROP_HAS_SINK_LOOP:
 457       g_value_set_boolean (value, tee->has_sink_loop);
 458       break;
 459     case PROP_HAS_CHAIN:
 460       g_value_set_boolean (value, tee->has_chain);
 461       break;
 462     case PROP_SILENT:
 463       g_value_set_boolean (value, tee->silent);
 464       break;
 465     case PROP_LAST_MESSAGE:
 466       g_value_set_string (value, tee->last_message);
 467       break;
 468     case PROP_PULL_MODE:
 469       g_value_set_enum (value, tee->pull_mode);
 470       break;
 471     case PROP_ALLOC_PAD:
 472       g_value_set_object (value, tee->allocpad);
 473       break;
 474     default:
 475       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 476       break;
 477   }
 478   GST_OBJECT_UNLOCK (tee);
 479 }
 480
 481 /* we have no previous source pad we can use to proxy the pad alloc. Loop over
 482  * the source pads, try to alloc a buffer on each one of them. Keep a reference
 483  * to the first pad that succeeds, we will be using it to alloc more buffers
 484  * later.  must be called with the OBJECT_LOCK on tee. */
 485 static GstFlowReturn
 486 gst_tee_find_buffer_alloc (GstTee * tee, guint64 offset, guint size,
 487     GstCaps * caps, GstBuffer ** buf)
 488 {
 489   GstFlowReturn res;
 490   GList *pads;
 491   guint32 cookie;
 492
 493   res = GST_FLOW_NOT_LINKED;
 494
 495 retry:
 496   pads = GST_ELEMENT_CAST (tee)->srcpads;
 497   cookie = GST_ELEMENT_CAST (tee)->pads_cookie;
 498
 499   while (pads) {
 500     GstPad *pad;
 501     PushData *data;
 502
 503     pad = GST_PAD_CAST (pads->data);
 504     gst_object_ref (pad);
 505     GST_DEBUG_OBJECT (tee, "try alloc on pad %s:%s", GST_DEBUG_PAD_NAME (pad));
 506     GST_OBJECT_UNLOCK (tee);
 507
 508     GST_TEE_DYN_LOCK (tee);
 509     data = g_object_get_qdata ((GObject *) pad, push_data);
 510     if (!data->removed)
 511       res = gst_pad_alloc_buffer (pad, offset, size, caps, buf);
 512     else
 513       res = GST_FLOW_NOT_LINKED;
 514     GST_TEE_DYN_UNLOCK (tee);
 515
 516     GST_DEBUG_OBJECT (tee, "got return value %d", res);
 517
 518     gst_object_unref (pad);
 519
 520     GST_OBJECT_LOCK (tee);
 521     if (GST_ELEMENT_CAST (tee)->pads_cookie != cookie) {
 522       GST_DEBUG_OBJECT (tee, "pad list changed, restart");
 523       /* pad list changed, restart. If the pad alloc function returned OK we
 524        * need to unref the buffer */
 525       if (res == GST_FLOW_OK)
 526         gst_buffer_unref (*buf);
 527       *buf = NULL;
 528       goto retry;
 529     }
 530     if (!data->removed && res == GST_FLOW_OK) {
 531       GST_DEBUG_OBJECT (tee, "we have a buffer on pad %s:%s",
 532           GST_DEBUG_PAD_NAME (pad));
 533       /* we have a buffer, keep the pad for later and exit the loop. */
 534       tee->allocpad = pad;
 535       GST_OBJECT_UNLOCK (tee);
 536       gst_tee_notify_alloc_pad (tee);
 537       GST_OBJECT_LOCK (tee);
 538       break;
 539     }
 540     /* no valid buffer, try another pad */
 541     pads = g_list_next (pads);
 542   }
 543
 544   return res;
 545 }
 546
 547 static GstFlowReturn
 548 gst_tee_buffer_alloc (GstPad * pad, guint64 offset, guint size,
 549     GstCaps * caps, GstBuffer ** buf)
 550 {
 551   GstTee *tee;
 552   GstFlowReturn res;
 553   GstPad *allocpad;
 554
 555   tee = GST_TEE_CAST (gst_pad_get_parent (pad));
 556   if (G_UNLIKELY (tee == NULL))
 557     return GST_FLOW_WRONG_STATE;
 558
 559   res = GST_FLOW_NOT_LINKED;
 560
 561   GST_OBJECT_LOCK (tee);
 562   if ((allocpad = tee->allocpad)) {
 563     PushData *data;
 564
 565     /* if we had a previous pad we used for allocating a buffer, continue using
 566      * it. */
 567     GST_DEBUG_OBJECT (tee, "using pad %s:%s for alloc",
 568         GST_DEBUG_PAD_NAME (allocpad));
 569     gst_object_ref (allocpad);
 570     GST_OBJECT_UNLOCK (tee);
 571
 572     GST_TEE_DYN_LOCK (tee);
 573     data = g_object_get_qdata ((GObject *) allocpad, push_data);
 574     if (!data->removed)
 575       res = gst_pad_alloc_buffer (allocpad, offset, size, caps, buf);
 576     else
 577       res = GST_FLOW_NOT_LINKED;
 578     GST_TEE_DYN_UNLOCK (tee);
 579
 580     gst_object_unref (allocpad);
 581
 582     GST_OBJECT_LOCK (tee);
 583   }
 584   /* either we failed to alloc on the previous pad or we did not have a
 585    * previous pad. */
 586   if (res == GST_FLOW_NOT_LINKED) {
 587     /* find a new pad to alloc a buffer on */
 588     GST_DEBUG_OBJECT (tee, "finding pad for alloc");
 589     res = gst_tee_find_buffer_alloc (tee, offset, size, caps, buf);
 590   }
 591   GST_OBJECT_UNLOCK (tee);
 592
 593   gst_object_unref (tee);
 594   return res;
 595 }
 596
 597 /* on the sink we accept caps that are acceptable to all srcpads */
 598 static gboolean
 599 gst_tee_sink_acceptcaps (GstPad * pad, GstCaps * caps)
 600 {
 601   GstTee *tee;
 602   gboolean res, done;
 603   GstIterator *it;
 604
 605   tee = GST_TEE_CAST (GST_PAD_PARENT (pad));
 606
 607   it = gst_element_iterate_src_pads (GST_ELEMENT_CAST (tee));
 608
 609   res = TRUE;
 610   done = FALSE;
 611   while (!done && res) {
 612     gpointer item;
 613
 614     switch (gst_iterator_next (it, &item)) {
 615       case GST_ITERATOR_OK:
 616         res &= gst_pad_peer_accept_caps (GST_PAD_CAST (item), caps);
 617         gst_object_unref (item);
 618         break;
 619       case GST_ITERATOR_RESYNC:
 620         res = TRUE;
 621         gst_iterator_resync (it);
 622         break;
 623       case GST_ITERATOR_ERROR:
 624         res = FALSE;
 625         done = TRUE;
 626         break;
 627       case GST_ITERATOR_DONE:
 628         done = TRUE;
 629         break;
 630     }
 631   }
 632   gst_iterator_free (it);
 633
 634   return res;
 635 }
 636
 637 static void
 638 gst_tee_do_message (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 639 {
 640   GST_OBJECT_LOCK (tee);
 641   g_free (tee->last_message);
 642   if (is_list) {
 643     tee->last_message =
 644         g_strdup_printf ("chain-list   ******* (%s:%s)t %p",
 645         GST_DEBUG_PAD_NAME (pad), data);
 646   } else {
 647     tee->last_message =
 648         g_strdup_printf ("chain        ******* (%s:%s)t (%d bytes, %"
 649         G_GUINT64_FORMAT ") %p", GST_DEBUG_PAD_NAME (pad),
 650         GST_BUFFER_SIZE (data), GST_BUFFER_TIMESTAMP (data), data);
 651   }
 652   GST_OBJECT_UNLOCK (tee);
 653
 654 #if !GLIB_CHECK_VERSION(2,26,0)
 655   g_object_notify ((GObject *) tee, "last-message");
 656 #else
 657   g_object_notify_by_pspec ((GObject *) tee, pspec_last_message);
 658 #endif
 659 }
 660
 661 static GstFlowReturn
 662 gst_tee_do_push (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 663 {
 664   GstFlowReturn res;
 665
 666   /* Push */
 667   if (pad == tee->pull_pad) {
 668     /* don't push on the pad we're pulling from */
 669     res = GST_FLOW_OK;
 670   } else if (is_list) {
 671     res =
 672         gst_pad_push_list (pad,
 673         gst_buffer_list_ref (GST_BUFFER_LIST_CAST (data)));
 674   } else {
 675     res = gst_pad_push (pad, gst_buffer_ref (GST_BUFFER_CAST (data)));
 676   }
 677   return res;
 678 }
 679
 680 static void
 681 clear_pads (GstPad * pad, GstTee * tee)
 682 {
 683   PushData *data;
 684
 685   data = g_object_get_qdata ((GObject *) pad, push_data);
 686
 687   /* the data must be there or we have a screwed up internal state */
 688   g_assert (data != NULL);
 689
 690   data->pushed = FALSE;
 691   data->result = GST_FLOW_NOT_LINKED;
 692 }
 693
 694 static GstFlowReturn
 695 gst_tee_handle_data (GstTee * tee, gpointer data, gboolean is_list)
 696 {
 697   GList *pads;
 698   guint32 cookie;
 699   GstFlowReturn ret, cret;
 700
 701   if (G_UNLIKELY (!tee->silent))
 702     gst_tee_do_message (tee, tee->sinkpad, data, is_list);
 703
 704   GST_OBJECT_LOCK (tee);
 705   pads = GST_ELEMENT_CAST (tee)->srcpads;
 706
 707   /* special case for zero pads */
 708   if (G_UNLIKELY (!pads))
 709     goto no_pads;
 710
 711   /* special case for just one pad that avoids reffing the buffer */
 712   if (!pads->next) {
 713     GstPad *pad = GST_PAD_CAST (pads->data);
 714
 715     GST_OBJECT_UNLOCK (tee);
 716
 717     if (pad == tee->pull_pad) {
 718       ret = GST_FLOW_OK;
 719     } else if (is_list) {
 720       ret = gst_pad_push_list (pad, GST_BUFFER_LIST_CAST (data));
 721     } else {
 722       ret = gst_pad_push (pad, GST_BUFFER_CAST (data));
 723     }
 724     return ret;
 725   }
 726
 727   /* mark all pads as 'not pushed on yet' */
 728   g_list_foreach (pads, (GFunc) clear_pads, tee);
 729
 730 restart:
 731   cret = GST_FLOW_NOT_LINKED;
 732   pads = GST_ELEMENT_CAST (tee)->srcpads;
 733   cookie = GST_ELEMENT_CAST (tee)->pads_cookie;
 734
 735   while (pads) {
 736     GstPad *pad;
 737     PushData *pdata;
 738
 739     pad = GST_PAD_CAST (pads->data);
 740
 741     /* get the private data, something is really wrong with the internal state
 742      * when it is not there */
 743     pdata = g_object_get_qdata ((GObject *) pad, push_data);
 744     g_assert (pdata != NULL);
 745
 746     if (G_LIKELY (!pdata->pushed)) {
 747       /* not yet pushed, release lock and start pushing */
 748       gst_object_ref (pad);
 749       GST_OBJECT_UNLOCK (tee);
 750
 751       GST_LOG_OBJECT (tee, "Starting to push %s %p",
 752           is_list ? "list" : "buffer", data);
 753
 754       ret = gst_tee_do_push (tee, pad, data, is_list);
 755
 756       GST_LOG_OBJECT (tee, "Pushing item %p yielded result %s", data,
 757           gst_flow_get_name (ret));
 758
 759       GST_OBJECT_LOCK (tee);
 760       /* keep track of which pad we pushed and the result value. We need to do
 761        * this before we release the refcount on the pad, the PushData is
 762        * destroyed when the last ref of the pad goes away. */
 763       pdata->pushed = TRUE;
 764       pdata->result = ret;
 765       gst_object_unref (pad);
 766     } else {
 767       /* already pushed, use previous return value */
 768       ret = pdata->result;
 769       GST_LOG_OBJECT (tee, "pad already pushed with %s",
 770           gst_flow_get_name (ret));
 771     }
 772
 773     /* before we go combining the return value, check if the pad list is still
 774      * the same. It could be possible that the pad we just pushed was removed
 775      * and the return value it not valid anymore */
 776     if (G_UNLIKELY (GST_ELEMENT_CAST (tee)->pads_cookie != cookie)) {
 777       GST_LOG_OBJECT (tee, "pad list changed");
 778       /* the list of pads changed, restart iteration. Pads that we already
 779        * pushed on and are still in the new list, will not be pushed on
 780        * again. */
 781       goto restart;
 782     }
 783
 784     /* stop pushing more buffers when we have a fatal error */
 785     if (G_UNLIKELY (ret != GST_FLOW_OK && ret != GST_FLOW_NOT_LINKED))
 786       goto error;
 787
 788     /* keep all other return values, overwriting the previous one. */
 789     if (G_LIKELY (ret != GST_FLOW_NOT_LINKED)) {
 790       GST_LOG_OBJECT (tee, "Replacing ret val %d with %d", cret, ret);
 791       cret = ret;
 792     }
 793     pads = g_list_next (pads);
 794   }
 795   GST_OBJECT_UNLOCK (tee);
 796
 797   gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 798
 799   /* no need to unset gvalue */
 800   return cret;
 801
 802   /* ERRORS */
 803 no_pads:
 804   {
 805     GST_DEBUG_OBJECT (tee, "there are no pads, return not-linked");
 806     ret = GST_FLOW_NOT_LINKED;
 807     goto error;
 808   }
 809 error:
 810   {
 811     GST_DEBUG_OBJECT (tee, "received error %s", gst_flow_get_name (ret));
 812     GST_OBJECT_UNLOCK (tee);
 813     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 814     return ret;
 815   }
 816 }
 817
 818 static GstFlowReturn
 819 gst_tee_chain (GstPad * pad, GstBuffer * buffer)
 820 {
 821   GstFlowReturn res;
 822   GstTee *tee;
 823
 824   tee = GST_TEE_CAST (GST_OBJECT_PARENT (pad));
 825
 826   GST_DEBUG_OBJECT (tee, "received buffer %p", buffer);
 827
 828   res = gst_tee_handle_data (tee, buffer, FALSE);
 829
 830   GST_DEBUG_OBJECT (tee, "handled buffer %s", gst_flow_get_name (res));
 831
 832   return res;
 833 }
 834
 835 static GstFlowReturn
 836 gst_tee_chain_list (GstPad * pad, GstBufferList * list)
 837 {
 838   GstFlowReturn res;
 839   GstTee *tee;
 840
 841   tee = GST_TEE_CAST (gst_pad_get_parent (pad));
 842
 843   GST_DEBUG_OBJECT (tee, "received list %p", list);
 844
 845   res = gst_tee_handle_data (tee, list, TRUE);
 846
 847   GST_DEBUG_OBJECT (tee, "handled list %s", gst_flow_get_name (res));
 848
 849   gst_object_unref (tee);
 850
 851   return res;
 852 }
 853
 854 static gboolean
 855 gst_tee_sink_activate_push (GstPad * pad, gboolean active)
 856 {
 857   GstTee *tee;
 858
 859   tee = GST_TEE (GST_OBJECT_PARENT (pad));
 860
 861   GST_OBJECT_LOCK (tee);
 862   tee->sink_mode = (active ? GST_ACTIVATE_PUSH : GST_ACTIVATE_NONE);
 863
 864   if (active && !tee->has_chain)
 865     goto no_chain;
 866   GST_OBJECT_UNLOCK (tee);
 867
 868   return TRUE;
 869
 870   /* ERRORS */
 871 no_chain:
 872   {
 873     GST_OBJECT_UNLOCK (tee);
 874     GST_INFO_OBJECT (tee,
 875         "Tee cannot operate in push mode with has-chain==FALSE");
 876     return FALSE;
 877   }
 878 }
 879
 880 static gboolean
 881 gst_tee_src_activate_pull (GstPad * pad, gboolean active)
 882 {
 883   GstTee *tee;
 884   gboolean res;
 885   GstPad *sinkpad;
 886
 887   tee = GST_TEE (gst_pad_get_parent (pad));
 888
 889   GST_OBJECT_LOCK (tee);
 890
 891   if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
 892     goto cannot_pull;
 893
 894   if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && active && tee->pull_pad)
 895     goto cannot_pull_multiple_srcs;
 896
 897   sinkpad = gst_object_ref (tee->sinkpad);
 898
 899   GST_OBJECT_UNLOCK (tee);
 900
 901   res = gst_pad_activate_pull (sinkpad, active);
 902   gst_object_unref (sinkpad);
 903
 904   if (!res)
 905     goto sink_activate_failed;
 906
 907   GST_OBJECT_LOCK (tee);
 908   if (active) {
 909     if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE)
 910       tee->pull_pad = pad;
 911   } else {
 912     if (pad == tee->pull_pad)
 913       tee->pull_pad = NULL;
 914   }
 915   tee->sink_mode = (active ? GST_ACTIVATE_PULL : GST_ACTIVATE_NONE);
 916   GST_OBJECT_UNLOCK (tee);
 917
 918   gst_object_unref (tee);
 919
 920   return res;
 921
 922   /* ERRORS */
 923 cannot_pull:
 924   {
 925     GST_OBJECT_UNLOCK (tee);
 926     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 927         "set to NEVER");
 928     gst_object_unref (tee);
 929     return FALSE;
 930   }
 931 cannot_pull_multiple_srcs:
 932   {
 933     GST_OBJECT_UNLOCK (tee);
 934     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 935         "pull-mode set to SINGLE");
 936     gst_object_unref (tee);
 937     return FALSE;
 938   }
 939 sink_activate_failed:
 940   {
 941     GST_INFO_OBJECT (tee, "Failed to %sactivate sink pad in pull mode",
 942         active ? "" : "de");
 943     gst_object_unref (tee);
 944     return FALSE;
 945   }
 946 }
 947
 948 static gboolean
 949 gst_tee_src_check_get_range (GstPad * pad)
 950 {
 951   GstTee *tee;
 952   gboolean res;
 953   GstPad *sinkpad;
 954
 955   tee = GST_TEE (gst_pad_get_parent (pad));
 956
 957   GST_OBJECT_LOCK (tee);
 958
 959   if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
 960     goto cannot_pull;
 961
 962   if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && tee->pull_pad)
 963     goto cannot_pull_multiple_srcs;
 964
 965   sinkpad = gst_object_ref (tee->sinkpad);
 966
 967   GST_OBJECT_UNLOCK (tee);
 968
 969   res = gst_pad_check_pull_range (sinkpad);
 970   gst_object_unref (sinkpad);
 971
 972   gst_object_unref (tee);
 973
 974   return res;
 975
 976   /* ERRORS */
 977 cannot_pull:
 978   {
 979     GST_OBJECT_UNLOCK (tee);
 980     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 981         "set to NEVER");
 982     gst_object_unref (tee);
 983     return FALSE;
 984   }
 985 cannot_pull_multiple_srcs:
 986   {
 987     GST_OBJECT_UNLOCK (tee);
 988     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 989         "pull-mode set to SINGLE");
 990     gst_object_unref (tee);
 991     return FALSE;
 992   }
 993 }
 994
 995 static void
 996 gst_tee_push_eos (GstPad * pad, GstTee * tee)
 997 {
 998   if (pad != tee->pull_pad)
 999     gst_pad_push_event (pad, gst_event_new_eos ());
1000   gst_object_unref (pad);
1001 }
1002
1003 static void
1004 gst_tee_pull_eos (GstTee * tee)
1005 {
1006   GstIterator *iter;
1007
1008   iter = gst_element_iterate_src_pads (GST_ELEMENT (tee));
1009   gst_iterator_foreach (iter, (GFunc) gst_tee_push_eos, tee);
1010   gst_iterator_free (iter);
1011 }
1012
1013 static GstFlowReturn
1014 gst_tee_src_get_range (GstPad * pad, guint64 offset, guint length,
1015     GstBuffer ** buf)
1016 {
1017   GstTee *tee;
1018   GstFlowReturn ret;
1019
1020   tee = GST_TEE (gst_pad_get_parent (pad));
1021
1022   ret = gst_pad_pull_range (tee->sinkpad, offset, length, buf);
1023
1024   if (ret == GST_FLOW_OK)
1025     ret = gst_tee_handle_data (tee, gst_buffer_ref (*buf), FALSE);
1026   else if (ret == GST_FLOW_UNEXPECTED)
1027     gst_tee_pull_eos (tee);
1028
1029   gst_object_unref (tee);
1030
1031   return ret;
1032 }