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