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