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