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