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_acceptcaps (GstPad * pad, GstCaps * caps);
 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_getcaps_function (tee->sinkpad,
 253       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 254   gst_pad_set_acceptcaps_function (tee->sinkpad,
 255       GST_DEBUG_FUNCPTR (gst_tee_sink_acceptcaps));
 256   gst_pad_set_activatepush_function (tee->sinkpad,
 257       GST_DEBUG_FUNCPTR (gst_tee_sink_activate_push));
 258   gst_pad_set_chain_function (tee->sinkpad, GST_DEBUG_FUNCPTR (gst_tee_chain));
 259   gst_pad_set_chain_list_function (tee->sinkpad,
 260       GST_DEBUG_FUNCPTR (gst_tee_chain_list));
 261   gst_element_add_pad (GST_ELEMENT (tee), tee->sinkpad);
 262
 263   tee->last_message = NULL;
 264 }
 265
 266 static void
 267 gst_tee_notify_alloc_pad (GstTee * tee)
 268 {
 269 #if !GLIB_CHECK_VERSION(2,26,0)
 270   g_object_notify ((GObject *) tee, "alloc-pad");
 271 #else
 272   g_object_notify_by_pspec ((GObject *) tee, pspec_alloc_pad);
 273 #endif
 274 }
 275
 276 static GstFlowReturn
 277 forward_sticky_events (GstPad * pad, GstEvent * event, gpointer user_data)
 278 {
 279   GstPad *srcpad = GST_PAD_CAST (user_data);
 280
 281   gst_pad_push_event (srcpad, gst_event_ref (event));
 282
 283   return GST_FLOW_OK;
 284 }
 285
 286 static GstPad *
 287 gst_tee_request_new_pad (GstElement * element, GstPadTemplate * templ,
 288     const gchar * unused, const GstCaps * caps)
 289 {
 290   gchar *name;
 291   GstPad *srcpad;
 292   GstTee *tee;
 293   GstPadActivateMode mode;
 294   gboolean res;
 295   PushData *data;
 296
 297   tee = GST_TEE (element);
 298
 299   GST_DEBUG_OBJECT (tee, "requesting pad");
 300
 301   GST_OBJECT_LOCK (tee);
 302   name = g_strdup_printf ("src_%u", tee->pad_counter++);
 303
 304   srcpad = gst_pad_new_from_template (templ, name);
 305   g_free (name);
 306
 307   mode = tee->sink_mode;
 308
 309   /* install the data, we automatically free it when the pad is disposed because
 310    * of _release_pad or when the element goes away. */
 311   data = g_new0 (PushData, 1);
 312   data->pushed = FALSE;
 313   data->result = GST_FLOW_NOT_LINKED;
 314   data->removed = FALSE;
 315   g_object_set_qdata_full (G_OBJECT (srcpad), push_data, data, g_free);
 316
 317   GST_OBJECT_UNLOCK (tee);
 318
 319   switch (mode) {
 320     case GST_PAD_ACTIVATE_PULL:
 321       /* we already have a src pad in pull mode, and our pull mode can only be
 322          SINGLE, so fall through to activate this new pad in push mode */
 323     case GST_PAD_ACTIVATE_PUSH:
 324       res = gst_pad_activate_push (srcpad, TRUE);
 325       break;
 326     default:
 327       res = TRUE;
 328       break;
 329   }
 330
 331   if (!res)
 332     goto activate_failed;
 333
 334   gst_pad_set_getcaps_function (srcpad,
 335       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 336   gst_pad_set_activatepull_function (srcpad,
 337       GST_DEBUG_FUNCPTR (gst_tee_src_activate_pull));
 338   gst_pad_set_query_function (srcpad, GST_DEBUG_FUNCPTR (gst_tee_src_query));
 339   gst_pad_set_getrange_function (srcpad,
 340       GST_DEBUG_FUNCPTR (gst_tee_src_get_range));
 341   /* Forward sticky events to the new srcpad */
 342   gst_pad_sticky_events_foreach (tee->sinkpad, forward_sticky_events, srcpad);
 343   gst_element_add_pad (GST_ELEMENT_CAST (tee), srcpad);
 344
 345   return srcpad;
 346
 347   /* ERRORS */
 348 activate_failed:
 349   {
 350     gboolean changed = FALSE;
 351
 352     GST_OBJECT_LOCK (tee);
 353     GST_DEBUG_OBJECT (tee, "warning failed to activate request pad");
 354     if (tee->allocpad == srcpad) {
 355       tee->allocpad = NULL;
 356       changed = TRUE;
 357     }
 358     GST_OBJECT_UNLOCK (tee);
 359     gst_object_unref (srcpad);
 360     if (changed) {
 361       gst_tee_notify_alloc_pad (tee);
 362     }
 363     return NULL;
 364   }
 365 }
 366
 367 static void
 368 gst_tee_release_pad (GstElement * element, GstPad * pad)
 369 {
 370   GstTee *tee;
 371   PushData *data;
 372   gboolean changed = FALSE;
 373
 374   tee = GST_TEE (element);
 375
 376   GST_DEBUG_OBJECT (tee, "releasing pad");
 377
 378   /* wait for pending pad_alloc to finish */
 379   GST_TEE_DYN_LOCK (tee);
 380   data = g_object_get_qdata (G_OBJECT (pad), push_data);
 381
 382   GST_OBJECT_LOCK (tee);
 383   /* mark the pad as removed so that future pad_alloc fails with NOT_LINKED. */
 384   data->removed = TRUE;
 385   if (tee->allocpad == pad) {
 386     tee->allocpad = NULL;
 387     changed = TRUE;
 388   }
 389   GST_OBJECT_UNLOCK (tee);
 390
 391   gst_object_ref (pad);
 392   gst_element_remove_pad (GST_ELEMENT_CAST (tee), pad);
 393
 394   gst_pad_set_active (pad, FALSE);
 395   GST_TEE_DYN_UNLOCK (tee);
 396
 397   gst_object_unref (pad);
 398
 399   if (changed) {
 400     gst_tee_notify_alloc_pad (tee);
 401   }
 402 }
 403
 404 static void
 405 gst_tee_set_property (GObject * object, guint prop_id, const GValue * value,
 406     GParamSpec * pspec)
 407 {
 408   GstTee *tee = GST_TEE (object);
 409
 410   GST_OBJECT_LOCK (tee);
 411   switch (prop_id) {
 412     case PROP_HAS_SINK_LOOP:
 413       tee->has_sink_loop = g_value_get_boolean (value);
 414       if (tee->has_sink_loop) {
 415         g_warning ("tee will never implement has-sink-loop==TRUE");
 416       }
 417       break;
 418     case PROP_HAS_CHAIN:
 419       tee->has_chain = g_value_get_boolean (value);
 420       break;
 421     case PROP_SILENT:
 422       tee->silent = g_value_get_boolean (value);
 423       break;
 424     case PROP_PULL_MODE:
 425       tee->pull_mode = g_value_get_enum (value);
 426       break;
 427     case PROP_ALLOC_PAD:
 428     {
 429       GstPad *pad = g_value_get_object (value);
 430       GST_OBJECT_LOCK (pad);
 431       if (GST_OBJECT_PARENT (pad) == GST_OBJECT_CAST (object))
 432         tee->allocpad = pad;
 433       else
 434         GST_WARNING_OBJECT (object, "Tried to set alloc pad %s which"
 435             " is not my pad", GST_OBJECT_NAME (pad));
 436       GST_OBJECT_UNLOCK (pad);
 437       break;
 438     }
 439     default:
 440       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 441       break;
 442   }
 443   GST_OBJECT_UNLOCK (tee);
 444 }
 445
 446 static void
 447 gst_tee_get_property (GObject * object, guint prop_id, GValue * value,
 448     GParamSpec * pspec)
 449 {
 450   GstTee *tee = GST_TEE (object);
 451
 452   GST_OBJECT_LOCK (tee);
 453   switch (prop_id) {
 454     case PROP_NUM_SRC_PADS:
 455       g_value_set_int (value, GST_ELEMENT (tee)->numsrcpads);
 456       break;
 457     case PROP_HAS_SINK_LOOP:
 458       g_value_set_boolean (value, tee->has_sink_loop);
 459       break;
 460     case PROP_HAS_CHAIN:
 461       g_value_set_boolean (value, tee->has_chain);
 462       break;
 463     case PROP_SILENT:
 464       g_value_set_boolean (value, tee->silent);
 465       break;
 466     case PROP_LAST_MESSAGE:
 467       g_value_set_string (value, tee->last_message);
 468       break;
 469     case PROP_PULL_MODE:
 470       g_value_set_enum (value, tee->pull_mode);
 471       break;
 472     case PROP_ALLOC_PAD:
 473       g_value_set_object (value, tee->allocpad);
 474       break;
 475     default:
 476       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 477       break;
 478   }
 479   GST_OBJECT_UNLOCK (tee);
 480 }
 481
 482 static gboolean
 483 gst_tee_sink_event (GstPad * pad, GstEvent * event)
 484 {
 485   gboolean res;
 486
 487   switch (GST_EVENT_TYPE (event)) {
 488     default:
 489       res = gst_pad_event_default (pad, event);
 490       break;
 491   }
 492
 493   return res;
 494 }
 495
 496 /* on the sink we accept caps that are acceptable to all srcpads */
 497 static gboolean
 498 gst_tee_sink_acceptcaps (GstPad * pad, GstCaps * caps)
 499 {
 500   GstTee *tee;
 501   gboolean res, done;
 502   GstIterator *it;
 503   GValue item = { 0, };
 504
 505   tee = GST_TEE_CAST (GST_PAD_PARENT (pad));
 506
 507   it = gst_element_iterate_src_pads (GST_ELEMENT_CAST (tee));
 508
 509   res = TRUE;
 510   done = FALSE;
 511   while (!done && res) {
 512     switch (gst_iterator_next (it, &item)) {
 513       case GST_ITERATOR_OK:
 514         res &= gst_pad_peer_accept_caps (g_value_get_object (&item), caps);
 515         g_value_reset (&item);
 516         break;
 517       case GST_ITERATOR_RESYNC:
 518         res = TRUE;
 519         gst_iterator_resync (it);
 520         break;
 521       case GST_ITERATOR_ERROR:
 522         res = FALSE;
 523         done = TRUE;
 524         break;
 525       case GST_ITERATOR_DONE:
 526         done = TRUE;
 527         break;
 528     }
 529   }
 530   g_value_unset (&item);
 531   gst_iterator_free (it);
 532
 533   return res;
 534 }
 535
 536 static void
 537 gst_tee_do_message (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 538 {
 539   GST_OBJECT_LOCK (tee);
 540   g_free (tee->last_message);
 541   if (is_list) {
 542     tee->last_message =
 543         g_strdup_printf ("chain-list   ******* (%s:%s)t %p",
 544         GST_DEBUG_PAD_NAME (pad), data);
 545   } else {
 546     tee->last_message =
 547         g_strdup_printf ("chain        ******* (%s:%s)t (%" G_GSIZE_FORMAT
 548         " bytes, %" G_GUINT64_FORMAT ") %p", GST_DEBUG_PAD_NAME (pad),
 549         gst_buffer_get_size (data), GST_BUFFER_TIMESTAMP (data), data);
 550   }
 551   GST_OBJECT_UNLOCK (tee);
 552
 553 #if !GLIB_CHECK_VERSION(2,26,0)
 554   g_object_notify ((GObject *) tee, "last-message");
 555 #else
 556   g_object_notify_by_pspec ((GObject *) tee, pspec_last_message);
 557 #endif
 558 }
 559
 560 static GstFlowReturn
 561 gst_tee_do_push (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 562 {
 563   GstFlowReturn res;
 564
 565   /* Push */
 566   if (pad == tee->pull_pad) {
 567     /* don't push on the pad we're pulling from */
 568     res = GST_FLOW_OK;
 569   } else if (is_list) {
 570     res =
 571         gst_pad_push_list (pad,
 572         gst_buffer_list_ref (GST_BUFFER_LIST_CAST (data)));
 573   } else {
 574     res = gst_pad_push (pad, gst_buffer_ref (GST_BUFFER_CAST (data)));
 575   }
 576   return res;
 577 }
 578
 579 static void
 580 clear_pads (GstPad * pad, GstTee * tee)
 581 {
 582   PushData *data;
 583
 584   data = g_object_get_qdata ((GObject *) pad, push_data);
 585
 586   /* the data must be there or we have a screwed up internal state */
 587   g_assert (data != NULL);
 588
 589   data->pushed = FALSE;
 590   data->result = GST_FLOW_NOT_LINKED;
 591 }
 592
 593 static GstFlowReturn
 594 gst_tee_handle_data (GstTee * tee, gpointer data, gboolean is_list)
 595 {
 596   GList *pads;
 597   guint32 cookie;
 598   GstFlowReturn ret, cret;
 599
 600   if (G_UNLIKELY (!tee->silent))
 601     gst_tee_do_message (tee, tee->sinkpad, data, is_list);
 602
 603   GST_OBJECT_LOCK (tee);
 604   pads = GST_ELEMENT_CAST (tee)->srcpads;
 605
 606   /* special case for zero pads */
 607   if (G_UNLIKELY (!pads))
 608     goto no_pads;
 609
 610   /* special case for just one pad that avoids reffing the buffer */
 611   if (!pads->next) {
 612     GstPad *pad = GST_PAD_CAST (pads->data);
 613
 614     GST_OBJECT_UNLOCK (tee);
 615
 616     if (pad == tee->pull_pad) {
 617       ret = GST_FLOW_OK;
 618     } else if (is_list) {
 619       ret = gst_pad_push_list (pad, GST_BUFFER_LIST_CAST (data));
 620     } else {
 621       ret = gst_pad_push (pad, GST_BUFFER_CAST (data));
 622     }
 623     return ret;
 624   }
 625
 626   /* mark all pads as 'not pushed on yet' */
 627   g_list_foreach (pads, (GFunc) clear_pads, tee);
 628
 629 restart:
 630   cret = GST_FLOW_NOT_LINKED;
 631   pads = GST_ELEMENT_CAST (tee)->srcpads;
 632   cookie = GST_ELEMENT_CAST (tee)->pads_cookie;
 633
 634   while (pads) {
 635     GstPad *pad;
 636     PushData *pdata;
 637
 638     pad = GST_PAD_CAST (pads->data);
 639
 640     /* get the private data, something is really wrong with the internal state
 641      * when it is not there */
 642     pdata = g_object_get_qdata ((GObject *) pad, push_data);
 643     g_assert (pdata != NULL);
 644
 645     if (G_LIKELY (!pdata->pushed)) {
 646       /* not yet pushed, release lock and start pushing */
 647       gst_object_ref (pad);
 648       GST_OBJECT_UNLOCK (tee);
 649
 650       GST_LOG_OBJECT (tee, "Starting to push %s %p",
 651           is_list ? "list" : "buffer", data);
 652
 653       ret = gst_tee_do_push (tee, pad, data, is_list);
 654
 655       GST_LOG_OBJECT (tee, "Pushing item %p yielded result %s", data,
 656           gst_flow_get_name (ret));
 657
 658       GST_OBJECT_LOCK (tee);
 659       /* keep track of which pad we pushed and the result value. We need to do
 660        * this before we release the refcount on the pad, the PushData is
 661        * destroyed when the last ref of the pad goes away. */
 662       pdata->pushed = TRUE;
 663       pdata->result = ret;
 664       gst_object_unref (pad);
 665     } else {
 666       /* already pushed, use previous return value */
 667       ret = pdata->result;
 668       GST_LOG_OBJECT (tee, "pad already pushed with %s",
 669           gst_flow_get_name (ret));
 670     }
 671
 672     /* before we go combining the return value, check if the pad list is still
 673      * the same. It could be possible that the pad we just pushed was removed
 674      * and the return value it not valid anymore */
 675     if (G_UNLIKELY (GST_ELEMENT_CAST (tee)->pads_cookie != cookie)) {
 676       GST_LOG_OBJECT (tee, "pad list changed");
 677       /* the list of pads changed, restart iteration. Pads that we already
 678        * pushed on and are still in the new list, will not be pushed on
 679        * again. */
 680       goto restart;
 681     }
 682
 683     /* stop pushing more buffers when we have a fatal error */
 684     if (G_UNLIKELY (ret != GST_FLOW_OK && ret != GST_FLOW_NOT_LINKED))
 685       goto error;
 686
 687     /* keep all other return values, overwriting the previous one. */
 688     if (G_LIKELY (ret != GST_FLOW_NOT_LINKED)) {
 689       GST_LOG_OBJECT (tee, "Replacing ret val %d with %d", cret, ret);
 690       cret = ret;
 691     }
 692     pads = g_list_next (pads);
 693   }
 694   GST_OBJECT_UNLOCK (tee);
 695
 696   gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 697
 698   /* no need to unset gvalue */
 699   return cret;
 700
 701   /* ERRORS */
 702 no_pads:
 703   {
 704     GST_DEBUG_OBJECT (tee, "there are no pads, return not-linked");
 705     ret = GST_FLOW_NOT_LINKED;
 706     goto error;
 707   }
 708 error:
 709   {
 710     GST_DEBUG_OBJECT (tee, "received error %s", gst_flow_get_name (ret));
 711     GST_OBJECT_UNLOCK (tee);
 712     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 713     return ret;
 714   }
 715 }
 716
 717 static GstFlowReturn
 718 gst_tee_chain (GstPad * pad, GstBuffer * buffer)
 719 {
 720   GstFlowReturn res;
 721   GstTee *tee;
 722
 723   tee = GST_TEE_CAST (GST_OBJECT_PARENT (pad));
 724
 725   GST_DEBUG_OBJECT (tee, "received buffer %p", buffer);
 726
 727   res = gst_tee_handle_data (tee, buffer, FALSE);
 728
 729   GST_DEBUG_OBJECT (tee, "handled buffer %s", gst_flow_get_name (res));
 730
 731   return res;
 732 }
 733
 734 static GstFlowReturn
 735 gst_tee_chain_list (GstPad * pad, GstBufferList * list)
 736 {
 737   GstFlowReturn res;
 738   GstTee *tee;
 739
 740   tee = GST_TEE_CAST (gst_pad_get_parent (pad));
 741
 742   GST_DEBUG_OBJECT (tee, "received list %p", list);
 743
 744   res = gst_tee_handle_data (tee, list, TRUE);
 745
 746   GST_DEBUG_OBJECT (tee, "handled list %s", gst_flow_get_name (res));
 747
 748   gst_object_unref (tee);
 749
 750   return res;
 751 }
 752
 753 static gboolean
 754 gst_tee_sink_activate_push (GstPad * pad, gboolean active)
 755 {
 756   GstTee *tee;
 757
 758   tee = GST_TEE (GST_OBJECT_PARENT (pad));
 759
 760   GST_OBJECT_LOCK (tee);
 761   tee->sink_mode = active && GST_PAD_ACTIVATE_PUSH;
 762
 763   if (active && !tee->has_chain)
 764     goto no_chain;
 765   GST_OBJECT_UNLOCK (tee);
 766
 767   return TRUE;
 768
 769   /* ERRORS */
 770 no_chain:
 771   {
 772     GST_OBJECT_UNLOCK (tee);
 773     GST_INFO_OBJECT (tee,
 774         "Tee cannot operate in push mode with has-chain==FALSE");
 775     return FALSE;
 776   }
 777 }
 778
 779 static gboolean
 780 gst_tee_src_activate_pull (GstPad * pad, gboolean active)
 781 {
 782   GstTee *tee;
 783   gboolean res;
 784   GstPad *sinkpad;
 785
 786   tee = GST_TEE (gst_pad_get_parent (pad));
 787
 788   GST_OBJECT_LOCK (tee);
 789
 790   if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
 791     goto cannot_pull;
 792
 793   if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && active && tee->pull_pad)
 794     goto cannot_pull_multiple_srcs;
 795
 796   sinkpad = gst_object_ref (tee->sinkpad);
 797
 798   GST_OBJECT_UNLOCK (tee);
 799
 800   res = gst_pad_activate_pull (sinkpad, active);
 801   gst_object_unref (sinkpad);
 802
 803   if (!res)
 804     goto sink_activate_failed;
 805
 806   GST_OBJECT_LOCK (tee);
 807   if (active) {
 808     if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE)
 809       tee->pull_pad = pad;
 810   } else {
 811     if (pad == tee->pull_pad)
 812       tee->pull_pad = NULL;
 813   }
 814   tee->sink_mode = active & GST_PAD_ACTIVATE_PULL;
 815   GST_OBJECT_UNLOCK (tee);
 816
 817   gst_object_unref (tee);
 818
 819   return res;
 820
 821   /* ERRORS */
 822 cannot_pull:
 823   {
 824     GST_OBJECT_UNLOCK (tee);
 825     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 826         "set to NEVER");
 827     gst_object_unref (tee);
 828     return FALSE;
 829   }
 830 cannot_pull_multiple_srcs:
 831   {
 832     GST_OBJECT_UNLOCK (tee);
 833     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 834         "pull-mode set to SINGLE");
 835     gst_object_unref (tee);
 836     return FALSE;
 837   }
 838 sink_activate_failed:
 839   {
 840     GST_INFO_OBJECT (tee, "Failed to %sactivate sink pad in pull mode",
 841         active ? "" : "de");
 842     gst_object_unref (tee);
 843     return FALSE;
 844   }
 845 }
 846
 847 static gboolean
 848 gst_tee_src_query (GstPad * pad, GstQuery * query)
 849 {
 850   GstTee *tee;
 851   gboolean res;
 852   GstPad *sinkpad;
 853
 854   tee = GST_TEE (gst_pad_get_parent (pad));
 855
 856   switch (GST_QUERY_TYPE (query)) {
 857     case GST_QUERY_SCHEDULING:
 858     {
 859       gboolean pull_mode;
 860
 861       GST_OBJECT_LOCK (tee);
 862       pull_mode = TRUE;
 863       if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER) {
 864         GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 865             "set to NEVER");
 866         pull_mode = FALSE;
 867       } else if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && tee->pull_pad) {
 868         GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 869             "pull-mode set to SINGLE");
 870         pull_mode = FALSE;
 871       }
 872
 873       sinkpad = gst_object_ref (tee->sinkpad);
 874       GST_OBJECT_UNLOCK (tee);
 875
 876       if (pull_mode) {
 877         /* ask peer if we can operate in pull mode */
 878         res = gst_pad_peer_query (sinkpad, query);
 879       } else {
 880         res = TRUE;
 881       }
 882       gst_object_unref (sinkpad);
 883       break;
 884     }
 885     default:
 886       res = gst_pad_query_default (pad, query);
 887       break;
 888   }
 889
 890   gst_object_unref (tee);
 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, guint64 offset, guint length,
 917     GstBuffer ** buf)
 918 {
 919   GstTee *tee;
 920   GstFlowReturn ret;
 921
 922   tee = GST_TEE (gst_pad_get_parent (pad));
 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   gst_object_unref (tee);
 932
 933   return ret;
 934 }