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