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
  52 #include <string.h>
  53
  54 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  55     GST_PAD_SINK,
  56     GST_PAD_ALWAYS,
  57     GST_STATIC_CAPS_ANY);
  58
  59 GST_DEBUG_CATEGORY_STATIC (gst_tee_debug);
  60 #define GST_CAT_DEFAULT gst_tee_debug
  61
  62 #define GST_TYPE_TEE_PULL_MODE (gst_tee_pull_mode_get_type())
  63 static GType
  64 gst_tee_pull_mode_get_type (void)
  65 {
  66   static GType type = 0;
  67   static const GEnumValue data[] = {
  68     {GST_TEE_PULL_MODE_NEVER, "Never activate in pull mode", "never"},
  69     {GST_TEE_PULL_MODE_SINGLE, "Only one src pad can be active in pull mode",
  70         "single"},
  71     {0, NULL, NULL},
  72   };
  73
  74   if (!type) {
  75     type = g_enum_register_static ("GstTeePullMode", data);
  76   }
  77   return type;
  78 }
  79
  80 /* lock to protect request pads from being removed while downstream */
  81 #define GST_TEE_DYN_LOCK(tee) g_mutex_lock ((tee)->dyn_lock)
  82 #define GST_TEE_DYN_UNLOCK(tee) g_mutex_unlock ((tee)->dyn_lock)
  83
  84 #define DEFAULT_PROP_NUM_SRC_PADS       0
  85 #define DEFAULT_PROP_HAS_SINK_LOOP      FALSE
  86 #define DEFAULT_PROP_HAS_CHAIN          TRUE
  87 #define DEFAULT_PROP_SILENT             TRUE
  88 #define DEFAULT_PROP_LAST_MESSAGE       NULL
  89 #define DEFAULT_PULL_MODE               GST_TEE_PULL_MODE_NEVER
  90
  91 enum
  92 {
  93   PROP_0,
  94   PROP_NUM_SRC_PADS,
  95   PROP_HAS_SINK_LOOP,
  96   PROP_HAS_CHAIN,
  97   PROP_SILENT,
  98   PROP_LAST_MESSAGE,
  99   PROP_PULL_MODE,
 100   PROP_ALLOC_PAD,
 101 };
 102
 103 static GstStaticPadTemplate tee_src_template =
 104 GST_STATIC_PAD_TEMPLATE ("src_%u",
 105     GST_PAD_SRC,
 106     GST_PAD_REQUEST,
 107     GST_STATIC_CAPS_ANY);
 108
 109 /* structure and quark to keep track of which pads have been pushed */
 110 static GQuark push_data;
 111
 112 #define _do_init \
 113     GST_DEBUG_CATEGORY_INIT (gst_tee_debug, "tee", 0, "tee element"); \
 114     push_data = g_quark_from_static_string ("tee-push-data");
 115 #define gst_tee_parent_class parent_class
 116 G_DEFINE_TYPE_WITH_CODE (GstTee, gst_tee, GST_TYPE_ELEMENT, _do_init);
 117
 118 static GParamSpec *pspec_last_message = NULL;
 119 static GParamSpec *pspec_alloc_pad = NULL;
 120
 121 typedef struct
 122 {
 123   gboolean pushed;
 124   GstFlowReturn result;
 125   gboolean removed;
 126 } PushData;
 127
 128 static GstPad *gst_tee_request_new_pad (GstElement * element,
 129     GstPadTemplate * temp, const gchar * unused, const GstCaps * caps);
 130 static void gst_tee_release_pad (GstElement * element, GstPad * pad);
 131
 132 static void gst_tee_finalize (GObject * object);
 133 static void gst_tee_set_property (GObject * object, guint prop_id,
 134     const GValue * value, GParamSpec * pspec);
 135 static void gst_tee_get_property (GObject * object, guint prop_id,
 136     GValue * value, GParamSpec * pspec);
 137 static void gst_tee_dispose (GObject * object);
 138
 139 static GstFlowReturn gst_tee_chain (GstPad * pad, GstObject * parent,
 140     GstBuffer * buffer);
 141 static GstFlowReturn gst_tee_chain_list (GstPad * pad, GstObject * parent,
 142     GstBufferList * list);
 143 static gboolean gst_tee_sink_event (GstPad * pad, GstObject * parent,
 144     GstEvent * event);
 145 static gboolean gst_tee_sink_query (GstPad * pad, GstObject * parent,
 146     GstQuery * query);
 147 static gboolean gst_tee_sink_activate_push (GstPad * pad, gboolean active);
 148 static gboolean gst_tee_src_query (GstPad * pad, GstObject * parent,
 149     GstQuery * query);
 150 static gboolean gst_tee_src_activate_pull (GstPad * pad, gboolean active);
 151 static GstFlowReturn gst_tee_src_get_range (GstPad * pad, GstObject * parent,
 152     guint64 offset, guint length, GstBuffer ** buf);
 153
 154 static void
 155 gst_tee_dispose (GObject * object)
 156 {
 157   GList *item;
 158
 159 restart:
 160   for (item = GST_ELEMENT_PADS (object); item; item = g_list_next (item)) {
 161     GstPad *pad = GST_PAD (item->data);
 162     if (GST_PAD_IS_SRC (pad)) {
 163       gst_element_release_request_pad (GST_ELEMENT (object), pad);
 164       goto restart;
 165     }
 166   }
 167
 168   G_OBJECT_CLASS (parent_class)->dispose (object);
 169 }
 170
 171 static void
 172 gst_tee_finalize (GObject * object)
 173 {
 174   GstTee *tee;
 175
 176   tee = GST_TEE (object);
 177
 178   g_free (tee->last_message);
 179
 180   g_mutex_free (tee->dyn_lock);
 181
 182   G_OBJECT_CLASS (parent_class)->finalize (object);
 183 }
 184
 185 static void
 186 gst_tee_class_init (GstTeeClass * klass)
 187 {
 188   GObjectClass *gobject_class;
 189   GstElementClass *gstelement_class;
 190
 191   gobject_class = G_OBJECT_CLASS (klass);
 192   gstelement_class = GST_ELEMENT_CLASS (klass);
 193
 194   gobject_class->finalize = gst_tee_finalize;
 195   gobject_class->set_property = gst_tee_set_property;
 196   gobject_class->get_property = gst_tee_get_property;
 197   gobject_class->dispose = gst_tee_dispose;
 198
 199   g_object_class_install_property (gobject_class, PROP_NUM_SRC_PADS,
 200       g_param_spec_int ("num-src-pads", "Num Src Pads",
 201           "The number of source pads", 0, G_MAXINT, DEFAULT_PROP_NUM_SRC_PADS,
 202           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 203   g_object_class_install_property (gobject_class, PROP_HAS_SINK_LOOP,
 204       g_param_spec_boolean ("has-sink-loop", "Has Sink Loop",
 205           "If the element should spawn a thread (unimplemented and deprecated)",
 206           DEFAULT_PROP_HAS_SINK_LOOP,
 207           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 208   g_object_class_install_property (gobject_class, PROP_HAS_CHAIN,
 209       g_param_spec_boolean ("has-chain", "Has Chain",
 210           "If the element can operate in push mode", DEFAULT_PROP_HAS_CHAIN,
 211           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 212   g_object_class_install_property (gobject_class, PROP_SILENT,
 213       g_param_spec_boolean ("silent", "Silent",
 214           "Don't produce last_message events", DEFAULT_PROP_SILENT,
 215           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 216   pspec_last_message = g_param_spec_string ("last-message", "Last Message",
 217       "The message describing current status", DEFAULT_PROP_LAST_MESSAGE,
 218       G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 219   g_object_class_install_property (gobject_class, PROP_LAST_MESSAGE,
 220       pspec_last_message);
 221   g_object_class_install_property (gobject_class, PROP_PULL_MODE,
 222       g_param_spec_enum ("pull-mode", "Pull mode",
 223           "Behavior of tee in pull mode", GST_TYPE_TEE_PULL_MODE,
 224           DEFAULT_PULL_MODE,
 225           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 226   pspec_alloc_pad = g_param_spec_object ("alloc-pad", "Allocation Src Pad",
 227       "The pad used for gst_pad_alloc_buffer", GST_TYPE_PAD,
 228       G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 229   g_object_class_install_property (gobject_class, PROP_ALLOC_PAD,
 230       pspec_alloc_pad);
 231
 232   gst_element_class_set_details_simple (gstelement_class,
 233       "Tee pipe fitting",
 234       "Generic",
 235       "1-to-N pipe fitting",
 236       "Erik Walthinsen <omega@cse.ogi.edu>, " "Wim Taymans <wim@fluendo.com>");
 237   gst_element_class_add_pad_template (gstelement_class,
 238       gst_static_pad_template_get (&sinktemplate));
 239   gst_element_class_add_pad_template (gstelement_class,
 240       gst_static_pad_template_get (&tee_src_template));
 241
 242   gstelement_class->request_new_pad =
 243       GST_DEBUG_FUNCPTR (gst_tee_request_new_pad);
 244   gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_tee_release_pad);
 245 }
 246
 247 static void
 248 gst_tee_init (GstTee * tee)
 249 {
 250   tee->dyn_lock = g_mutex_new ();
 251
 252   tee->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
 253   tee->sink_mode = GST_PAD_ACTIVATE_NONE;
 254
 255   gst_pad_set_event_function (tee->sinkpad,
 256       GST_DEBUG_FUNCPTR (gst_tee_sink_event));
 257   gst_pad_set_query_function (tee->sinkpad,
 258       GST_DEBUG_FUNCPTR (gst_tee_sink_query));
 259   gst_pad_set_activatepush_function (tee->sinkpad,
 260       GST_DEBUG_FUNCPTR (gst_tee_sink_activate_push));
 261   gst_pad_set_chain_function (tee->sinkpad, GST_DEBUG_FUNCPTR (gst_tee_chain));
 262   gst_pad_set_chain_list_function (tee->sinkpad,
 263       GST_DEBUG_FUNCPTR (gst_tee_chain_list));
 264   GST_OBJECT_FLAG_SET (tee->sinkpad, GST_PAD_FLAG_PROXY_CAPS);
 265   gst_element_add_pad (GST_ELEMENT (tee), tee->sinkpad);
 266
 267   tee->last_message = NULL;
 268 }
 269
 270 static void
 271 gst_tee_notify_alloc_pad (GstTee * tee)
 272 {
 273 #if !GLIB_CHECK_VERSION(2,26,0)
 274   g_object_notify ((GObject *) tee, "alloc-pad");
 275 #else
 276   g_object_notify_by_pspec ((GObject *) tee, pspec_alloc_pad);
 277 #endif
 278 }
 279
 280 static GstFlowReturn
 281 forward_sticky_events (GstPad * pad, GstEvent * event, gpointer user_data)
 282 {
 283   GstPad *srcpad = GST_PAD_CAST (user_data);
 284
 285   gst_pad_push_event (srcpad, gst_event_ref (event));
 286
 287   return GST_FLOW_OK;
 288 }
 289
 290 static GstPad *
 291 gst_tee_request_new_pad (GstElement * element, GstPadTemplate * templ,
 292     const gchar * unused, const GstCaps * caps)
 293 {
 294   gchar *name;
 295   GstPad *srcpad;
 296   GstTee *tee;
 297   GstPadActivateMode mode;
 298   gboolean res;
 299   PushData *data;
 300
 301   tee = GST_TEE (element);
 302
 303   GST_DEBUG_OBJECT (tee, "requesting pad");
 304
 305   GST_OBJECT_LOCK (tee);
 306   name = g_strdup_printf ("src_%u", tee->pad_counter++);
 307
 308   srcpad = gst_pad_new_from_template (templ, name);
 309   g_free (name);
 310
 311   mode = tee->sink_mode;
 312
 313   /* install the data, we automatically free it when the pad is disposed because
 314    * of _release_pad or when the element goes away. */
 315   data = g_new0 (PushData, 1);
 316   data->pushed = FALSE;
 317   data->result = GST_FLOW_NOT_LINKED;
 318   data->removed = FALSE;
 319   g_object_set_qdata_full (G_OBJECT (srcpad), push_data, data, g_free);
 320
 321   GST_OBJECT_UNLOCK (tee);
 322
 323   switch (mode) {
 324     case GST_PAD_ACTIVATE_PULL:
 325       /* we already have a src pad in pull mode, and our pull mode can only be
 326          SINGLE, so fall through to activate this new pad in push mode */
 327     case GST_PAD_ACTIVATE_PUSH:
 328       res = gst_pad_activate_push (srcpad, TRUE);
 329       break;
 330     default:
 331       res = TRUE;
 332       break;
 333   }
 334
 335   if (!res)
 336     goto activate_failed;
 337
 338   gst_pad_set_activatepull_function (srcpad,
 339       GST_DEBUG_FUNCPTR (gst_tee_src_activate_pull));
 340   gst_pad_set_query_function (srcpad, GST_DEBUG_FUNCPTR (gst_tee_src_query));
 341   gst_pad_set_getrange_function (srcpad,
 342       GST_DEBUG_FUNCPTR (gst_tee_src_get_range));
 343   /* Forward sticky events to the new srcpad */
 344   gst_pad_sticky_events_foreach (tee->sinkpad, forward_sticky_events, srcpad);
 345   GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PROXY_CAPS);
 346   gst_element_add_pad (GST_ELEMENT_CAST (tee), srcpad);
 347
 348   return srcpad;
 349
 350   /* ERRORS */
 351 activate_failed:
 352   {
 353     gboolean changed = FALSE;
 354
 355     GST_OBJECT_LOCK (tee);
 356     GST_DEBUG_OBJECT (tee, "warning failed to activate request pad");
 357     if (tee->allocpad == srcpad) {
 358       tee->allocpad = NULL;
 359       changed = TRUE;
 360     }
 361     GST_OBJECT_UNLOCK (tee);
 362     gst_object_unref (srcpad);
 363     if (changed) {
 364       gst_tee_notify_alloc_pad (tee);
 365     }
 366     return NULL;
 367   }
 368 }
 369
 370 static void
 371 gst_tee_release_pad (GstElement * element, GstPad * pad)
 372 {
 373   GstTee *tee;
 374   PushData *data;
 375   gboolean changed = FALSE;
 376
 377   tee = GST_TEE (element);
 378
 379   GST_DEBUG_OBJECT (tee, "releasing pad");
 380
 381   /* wait for pending pad_alloc to finish */
 382   GST_TEE_DYN_LOCK (tee);
 383   data = g_object_get_qdata (G_OBJECT (pad), push_data);
 384
 385   GST_OBJECT_LOCK (tee);
 386   /* mark the pad as removed so that future pad_alloc fails with NOT_LINKED. */
 387   data->removed = TRUE;
 388   if (tee->allocpad == pad) {
 389     tee->allocpad = NULL;
 390     changed = TRUE;
 391   }
 392   GST_OBJECT_UNLOCK (tee);
 393
 394   gst_object_ref (pad);
 395   gst_element_remove_pad (GST_ELEMENT_CAST (tee), pad);
 396
 397   gst_pad_set_active (pad, FALSE);
 398   GST_TEE_DYN_UNLOCK (tee);
 399
 400   gst_object_unref (pad);
 401
 402   if (changed) {
 403     gst_tee_notify_alloc_pad (tee);
 404   }
 405 }
 406
 407 static void
 408 gst_tee_set_property (GObject * object, guint prop_id, const GValue * value,
 409     GParamSpec * pspec)
 410 {
 411   GstTee *tee = GST_TEE (object);
 412
 413   GST_OBJECT_LOCK (tee);
 414   switch (prop_id) {
 415     case PROP_HAS_SINK_LOOP:
 416       tee->has_sink_loop = g_value_get_boolean (value);
 417       if (tee->has_sink_loop) {
 418         g_warning ("tee will never implement has-sink-loop==TRUE");
 419       }
 420       break;
 421     case PROP_HAS_CHAIN:
 422       tee->has_chain = g_value_get_boolean (value);
 423       break;
 424     case PROP_SILENT:
 425       tee->silent = g_value_get_boolean (value);
 426       break;
 427     case PROP_PULL_MODE:
 428       tee->pull_mode = g_value_get_enum (value);
 429       break;
 430     case PROP_ALLOC_PAD:
 431     {
 432       GstPad *pad = g_value_get_object (value);
 433       GST_OBJECT_LOCK (pad);
 434       if (GST_OBJECT_PARENT (pad) == GST_OBJECT_CAST (object))
 435         tee->allocpad = pad;
 436       else
 437         GST_WARNING_OBJECT (object, "Tried to set alloc pad %s which"
 438             " is not my pad", GST_OBJECT_NAME (pad));
 439       GST_OBJECT_UNLOCK (pad);
 440       break;
 441     }
 442     default:
 443       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 444       break;
 445   }
 446   GST_OBJECT_UNLOCK (tee);
 447 }
 448
 449 static void
 450 gst_tee_get_property (GObject * object, guint prop_id, GValue * value,
 451     GParamSpec * pspec)
 452 {
 453   GstTee *tee = GST_TEE (object);
 454
 455   GST_OBJECT_LOCK (tee);
 456   switch (prop_id) {
 457     case PROP_NUM_SRC_PADS:
 458       g_value_set_int (value, GST_ELEMENT (tee)->numsrcpads);
 459       break;
 460     case PROP_HAS_SINK_LOOP:
 461       g_value_set_boolean (value, tee->has_sink_loop);
 462       break;
 463     case PROP_HAS_CHAIN:
 464       g_value_set_boolean (value, tee->has_chain);
 465       break;
 466     case PROP_SILENT:
 467       g_value_set_boolean (value, tee->silent);
 468       break;
 469     case PROP_LAST_MESSAGE:
 470       g_value_set_string (value, tee->last_message);
 471       break;
 472     case PROP_PULL_MODE:
 473       g_value_set_enum (value, tee->pull_mode);
 474       break;
 475     case PROP_ALLOC_PAD:
 476       g_value_set_object (value, tee->allocpad);
 477       break;
 478     default:
 479       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 480       break;
 481   }
 482   GST_OBJECT_UNLOCK (tee);
 483 }
 484
 485 static gboolean
 486 gst_tee_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 487 {
 488   gboolean res;
 489
 490   switch (GST_EVENT_TYPE (event)) {
 491     default:
 492       res = gst_pad_event_default (pad, parent, event);
 493       break;
 494   }
 495
 496   return res;
 497 }
 498
 499 static gboolean
 500 gst_tee_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
 501 {
 502   gboolean res;
 503
 504   switch (GST_QUERY_TYPE (query)) {
 505     default:
 506       res = gst_pad_query_default (pad, parent, query);
 507       break;
 508   }
 509   return res;
 510 }
 511
 512 static void
 513 gst_tee_do_message (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 514 {
 515   GST_OBJECT_LOCK (tee);
 516   g_free (tee->last_message);
 517   if (is_list) {
 518     tee->last_message =
 519         g_strdup_printf ("chain-list   ******* (%s:%s)t %p",
 520         GST_DEBUG_PAD_NAME (pad), data);
 521   } else {
 522     tee->last_message =
 523         g_strdup_printf ("chain        ******* (%s:%s)t (%" G_GSIZE_FORMAT
 524         " bytes, %" G_GUINT64_FORMAT ") %p", GST_DEBUG_PAD_NAME (pad),
 525         gst_buffer_get_size (data), GST_BUFFER_TIMESTAMP (data), data);
 526   }
 527   GST_OBJECT_UNLOCK (tee);
 528
 529 #if !GLIB_CHECK_VERSION(2,26,0)
 530   g_object_notify ((GObject *) tee, "last-message");
 531 #else
 532   g_object_notify_by_pspec ((GObject *) tee, pspec_last_message);
 533 #endif
 534 }
 535
 536 static GstFlowReturn
 537 gst_tee_do_push (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 538 {
 539   GstFlowReturn res;
 540
 541   /* Push */
 542   if (pad == tee->pull_pad) {
 543     /* don't push on the pad we're pulling from */
 544     res = GST_FLOW_OK;
 545   } else if (is_list) {
 546     res =
 547         gst_pad_push_list (pad,
 548         gst_buffer_list_ref (GST_BUFFER_LIST_CAST (data)));
 549   } else {
 550     res = gst_pad_push (pad, gst_buffer_ref (GST_BUFFER_CAST (data)));
 551   }
 552   return res;
 553 }
 554
 555 static void
 556 clear_pads (GstPad * pad, GstTee * tee)
 557 {
 558   PushData *data;
 559
 560   data = g_object_get_qdata ((GObject *) pad, push_data);
 561
 562   /* the data must be there or we have a screwed up internal state */
 563   g_assert (data != NULL);
 564
 565   data->pushed = FALSE;
 566   data->result = GST_FLOW_NOT_LINKED;
 567 }
 568
 569 static GstFlowReturn
 570 gst_tee_handle_data (GstTee * tee, gpointer data, gboolean is_list)
 571 {
 572   GList *pads;
 573   guint32 cookie;
 574   GstFlowReturn ret, cret;
 575
 576   if (G_UNLIKELY (!tee->silent))
 577     gst_tee_do_message (tee, tee->sinkpad, data, is_list);
 578
 579   GST_OBJECT_LOCK (tee);
 580   pads = GST_ELEMENT_CAST (tee)->srcpads;
 581
 582   /* special case for zero pads */
 583   if (G_UNLIKELY (!pads))
 584     goto no_pads;
 585
 586   /* special case for just one pad that avoids reffing the buffer */
 587   if (!pads->next) {
 588     GstPad *pad = GST_PAD_CAST (pads->data);
 589
 590     GST_OBJECT_UNLOCK (tee);
 591
 592     if (pad == tee->pull_pad) {
 593       ret = GST_FLOW_OK;
 594     } else if (is_list) {
 595       ret = gst_pad_push_list (pad, GST_BUFFER_LIST_CAST (data));
 596     } else {
 597       ret = gst_pad_push (pad, GST_BUFFER_CAST (data));
 598     }
 599     return ret;
 600   }
 601
 602   /* mark all pads as 'not pushed on yet' */
 603   g_list_foreach (pads, (GFunc) clear_pads, tee);
 604
 605 restart:
 606   cret = GST_FLOW_NOT_LINKED;
 607   pads = GST_ELEMENT_CAST (tee)->srcpads;
 608   cookie = GST_ELEMENT_CAST (tee)->pads_cookie;
 609
 610   while (pads) {
 611     GstPad *pad;
 612     PushData *pdata;
 613
 614     pad = GST_PAD_CAST (pads->data);
 615
 616     /* get the private data, something is really wrong with the internal state
 617      * when it is not there */
 618     pdata = g_object_get_qdata ((GObject *) pad, push_data);
 619     g_assert (pdata != NULL);
 620
 621     if (G_LIKELY (!pdata->pushed)) {
 622       /* not yet pushed, release lock and start pushing */
 623       gst_object_ref (pad);
 624       GST_OBJECT_UNLOCK (tee);
 625
 626       GST_LOG_OBJECT (tee, "Starting to push %s %p",
 627           is_list ? "list" : "buffer", data);
 628
 629       ret = gst_tee_do_push (tee, pad, data, is_list);
 630
 631       GST_LOG_OBJECT (tee, "Pushing item %p yielded result %s", data,
 632           gst_flow_get_name (ret));
 633
 634       GST_OBJECT_LOCK (tee);
 635       /* keep track of which pad we pushed and the result value. We need to do
 636        * this before we release the refcount on the pad, the PushData is
 637        * destroyed when the last ref of the pad goes away. */
 638       pdata->pushed = TRUE;
 639       pdata->result = ret;
 640       gst_object_unref (pad);
 641     } else {
 642       /* already pushed, use previous return value */
 643       ret = pdata->result;
 644       GST_LOG_OBJECT (tee, "pad already pushed with %s",
 645           gst_flow_get_name (ret));
 646     }
 647
 648     /* before we go combining the return value, check if the pad list is still
 649      * the same. It could be possible that the pad we just pushed was removed
 650      * and the return value it not valid anymore */
 651     if (G_UNLIKELY (GST_ELEMENT_CAST (tee)->pads_cookie != cookie)) {
 652       GST_LOG_OBJECT (tee, "pad list changed");
 653       /* the list of pads changed, restart iteration. Pads that we already
 654        * pushed on and are still in the new list, will not be pushed on
 655        * again. */
 656       goto restart;
 657     }
 658
 659     /* stop pushing more buffers when we have a fatal error */
 660     if (G_UNLIKELY (ret != GST_FLOW_OK && ret != GST_FLOW_NOT_LINKED))
 661       goto error;
 662
 663     /* keep all other return values, overwriting the previous one. */
 664     if (G_LIKELY (ret != GST_FLOW_NOT_LINKED)) {
 665       GST_LOG_OBJECT (tee, "Replacing ret val %d with %d", cret, ret);
 666       cret = ret;
 667     }
 668     pads = g_list_next (pads);
 669   }
 670   GST_OBJECT_UNLOCK (tee);
 671
 672   gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 673
 674   /* no need to unset gvalue */
 675   return cret;
 676
 677   /* ERRORS */
 678 no_pads:
 679   {
 680     GST_DEBUG_OBJECT (tee, "there are no pads, return not-linked");
 681     ret = GST_FLOW_NOT_LINKED;
 682     goto error;
 683   }
 684 error:
 685   {
 686     GST_DEBUG_OBJECT (tee, "received error %s", gst_flow_get_name (ret));
 687     GST_OBJECT_UNLOCK (tee);
 688     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 689     return ret;
 690   }
 691 }
 692
 693 static GstFlowReturn
 694 gst_tee_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 695 {
 696   GstFlowReturn res;
 697   GstTee *tee;
 698
 699   tee = GST_TEE_CAST (parent);
 700
 701   GST_DEBUG_OBJECT (tee, "received buffer %p", buffer);
 702
 703   res = gst_tee_handle_data (tee, buffer, FALSE);
 704
 705   GST_DEBUG_OBJECT (tee, "handled buffer %s", gst_flow_get_name (res));
 706
 707   return res;
 708 }
 709
 710 static GstFlowReturn
 711 gst_tee_chain_list (GstPad * pad, GstObject * parent, GstBufferList * list)
 712 {
 713   GstFlowReturn res;
 714   GstTee *tee;
 715
 716   tee = GST_TEE_CAST (parent);
 717
 718   GST_DEBUG_OBJECT (tee, "received list %p", list);
 719
 720   res = gst_tee_handle_data (tee, list, TRUE);
 721
 722   GST_DEBUG_OBJECT (tee, "handled list %s", gst_flow_get_name (res));
 723
 724   return res;
 725 }
 726
 727 static gboolean
 728 gst_tee_sink_activate_push (GstPad * pad, gboolean active)
 729 {
 730   GstTee *tee;
 731
 732   tee = GST_TEE (GST_OBJECT_PARENT (pad));
 733
 734   GST_OBJECT_LOCK (tee);
 735   tee->sink_mode = active && GST_PAD_ACTIVATE_PUSH;
 736
 737   if (active && !tee->has_chain)
 738     goto no_chain;
 739   GST_OBJECT_UNLOCK (tee);
 740
 741   return TRUE;
 742
 743   /* ERRORS */
 744 no_chain:
 745   {
 746     GST_OBJECT_UNLOCK (tee);
 747     GST_INFO_OBJECT (tee,
 748         "Tee cannot operate in push mode with has-chain==FALSE");
 749     return FALSE;
 750   }
 751 }
 752
 753 static gboolean
 754 gst_tee_src_activate_pull (GstPad * pad, gboolean active)
 755 {
 756   GstTee *tee;
 757   gboolean res;
 758   GstPad *sinkpad;
 759
 760   tee = GST_TEE (GST_PAD_PARENT (pad));
 761
 762   GST_OBJECT_LOCK (tee);
 763
 764   if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
 765     goto cannot_pull;
 766
 767   if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && active && tee->pull_pad)
 768     goto cannot_pull_multiple_srcs;
 769
 770   sinkpad = gst_object_ref (tee->sinkpad);
 771
 772   GST_OBJECT_UNLOCK (tee);
 773
 774   res = gst_pad_activate_pull (sinkpad, active);
 775   gst_object_unref (sinkpad);
 776
 777   if (!res)
 778     goto sink_activate_failed;
 779
 780   GST_OBJECT_LOCK (tee);
 781   if (active) {
 782     if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE)
 783       tee->pull_pad = pad;
 784   } else {
 785     if (pad == tee->pull_pad)
 786       tee->pull_pad = NULL;
 787   }
 788   tee->sink_mode = active & GST_PAD_ACTIVATE_PULL;
 789   GST_OBJECT_UNLOCK (tee);
 790
 791   return res;
 792
 793   /* ERRORS */
 794 cannot_pull:
 795   {
 796     GST_OBJECT_UNLOCK (tee);
 797     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 798         "set to NEVER");
 799     return FALSE;
 800   }
 801 cannot_pull_multiple_srcs:
 802   {
 803     GST_OBJECT_UNLOCK (tee);
 804     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 805         "pull-mode set to SINGLE");
 806     return FALSE;
 807   }
 808 sink_activate_failed:
 809   {
 810     GST_INFO_OBJECT (tee, "Failed to %sactivate sink pad in pull mode",
 811         active ? "" : "de");
 812     return FALSE;
 813   }
 814 }
 815
 816 static gboolean
 817 gst_tee_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
 818 {
 819   GstTee *tee;
 820   gboolean res;
 821   GstPad *sinkpad;
 822
 823   tee = GST_TEE (parent);
 824
 825   switch (GST_QUERY_TYPE (query)) {
 826     case GST_QUERY_SCHEDULING:
 827     {
 828       gboolean pull_mode;
 829
 830       GST_OBJECT_LOCK (tee);
 831       pull_mode = TRUE;
 832       if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER) {
 833         GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 834             "set to NEVER");
 835         pull_mode = FALSE;
 836       } else if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && tee->pull_pad) {
 837         GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 838             "pull-mode set to SINGLE");
 839         pull_mode = FALSE;
 840       }
 841
 842       sinkpad = gst_object_ref (tee->sinkpad);
 843       GST_OBJECT_UNLOCK (tee);
 844
 845       if (pull_mode) {
 846         /* ask peer if we can operate in pull mode */
 847         res = gst_pad_peer_query (sinkpad, query);
 848       } else {
 849         res = TRUE;
 850       }
 851       gst_object_unref (sinkpad);
 852       break;
 853     }
 854     default:
 855       res = gst_pad_query_default (pad, parent, query);
 856       break;
 857   }
 858
 859   return res;
 860 }
 861
 862 static void
 863 gst_tee_push_eos (const GValue * vpad, GstTee * tee)
 864 {
 865   GstPad *pad = g_value_get_object (vpad);
 866
 867   if (pad != tee->pull_pad)
 868     gst_pad_push_event (pad, gst_event_new_eos ());
 869 }
 870
 871 static void
 872 gst_tee_pull_eos (GstTee * tee)
 873 {
 874   GstIterator *iter;
 875
 876   iter = gst_element_iterate_src_pads (GST_ELEMENT (tee));
 877   gst_iterator_foreach (iter, (GstIteratorForeachFunction) gst_tee_push_eos,
 878       tee);
 879   gst_iterator_free (iter);
 880 }
 881
 882 static GstFlowReturn
 883 gst_tee_src_get_range (GstPad * pad, GstObject * parent, guint64 offset,
 884     guint length, GstBuffer ** buf)
 885 {
 886   GstTee *tee;
 887   GstFlowReturn ret;
 888
 889   tee = GST_TEE (parent);
 890
 891   ret = gst_pad_pull_range (tee->sinkpad, offset, length, buf);
 892
 893   if (ret == GST_FLOW_OK)
 894     ret = gst_tee_handle_data (tee, gst_buffer_ref (*buf), FALSE);
 895   else if (ret == GST_FLOW_EOS)
 896     gst_tee_pull_eos (tee);
 897
 898   return ret;
 899 }