plugins/elements/gsttee.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *               2000,2001,2002,2003,2004,2005 Wim Taymans <wim@fluendo.com>
   4  *               2007 Wim Taymans <wim.taymans@gmail.com>
   5  *
   6  * gsttee.c: Tee element, one in N out
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 /**
  25  * SECTION:element-tee
  26  * @see_also: #GstIdentity
  27  *
  28  * Split data to multiple pads. Branching the data flow is useful when e.g.
  29  * capturing a video where the video is shown on the screen and also encoded and
  30  * written to a file. Another example is playing music and hooking up a
  31  * visualisation module.
  32  *
  33  * One needs to use separate queue elements (or a multiqueue) in each branch to
  34  * provide separate threads for each branch. Otherwise a blocked dataflow in one
  35  * branch would stall the other branches.
  36  *
  37  * <refsect2>
  38  * <title>Example launch line</title>
  39  * |[
  40  * gst-launch-1.0 filesrc location=song.ogg ! decodebin ! tee name=t ! queue ! audioconvert ! audioresample ! autoaudiosink t. ! queue ! audioconvert ! goom ! videoconvert ! autovideosink
  41  * ]| Play song.ogg audio file which must be in the current working directory
  42  * and render visualisations using the goom element (this can be easier done
  43  * using the playbin element, this is just an example pipeline).
  44  * </refsect2>
  45  */
  46
  47 #ifdef HAVE_CONFIG_H
  48 #  include "config.h"
  49 #endif
  50
  51 #include "gsttee.h"
  52 #include "gst/glib-compat-private.h"
  53
  54 #include <string.h>
  55 #include <stdio.h>
  56
  57 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  58     GST_PAD_SINK,
  59     GST_PAD_ALWAYS,
  60     GST_STATIC_CAPS_ANY);
  61
  62 GST_DEBUG_CATEGORY_STATIC (gst_tee_debug);
  63 #define GST_CAT_DEFAULT gst_tee_debug
  64
  65 #define GST_TYPE_TEE_PULL_MODE (gst_tee_pull_mode_get_type())
  66 static GType
  67 gst_tee_pull_mode_get_type (void)
  68 {
  69   static GType type = 0;
  70   static const GEnumValue data[] = {
  71     {GST_TEE_PULL_MODE_NEVER, "Never activate in pull mode", "never"},
  72     {GST_TEE_PULL_MODE_SINGLE, "Only one src pad can be active in pull mode",
  73         "single"},
  74     {0, NULL, NULL},
  75   };
  76
  77   if (!type) {
  78     type = g_enum_register_static ("GstTeePullMode", data);
  79   }
  80   return type;
  81 }
  82
  83 #define DEFAULT_PROP_NUM_SRC_PADS       0
  84 #define DEFAULT_PROP_HAS_CHAIN          TRUE
  85 #define DEFAULT_PROP_SILENT             TRUE
  86 #define DEFAULT_PROP_LAST_MESSAGE       NULL
  87 #define DEFAULT_PULL_MODE               GST_TEE_PULL_MODE_NEVER
  88 #define DEFAULT_PROP_ALLOW_NOT_LINKED   FALSE
  89
  90 enum
  91 {
  92   PROP_0,
  93   PROP_NUM_SRC_PADS,
  94   PROP_HAS_CHAIN,
  95   PROP_SILENT,
  96   PROP_LAST_MESSAGE,
  97   PROP_PULL_MODE,
  98   PROP_ALLOC_PAD,
  99   PROP_ALLOW_NOT_LINKED,
 100 };
 101
 102 static GstStaticPadTemplate tee_src_template =
 103 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 (unused)", GST_TYPE_PAD,
 267       G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 268   g_object_class_install_property (gobject_class, PROP_ALLOC_PAD,
 269       pspec_alloc_pad);
 270
 271   /**
 272    * GstTee:allow-not-linked
 273    *
 274    * This property makes sink pad return GST_FLOW_OK even if there are no
 275    * source pads or any of them is linked.
 276    *
 277    * This is useful to avoid errors when you have a dynamic pipeline and during
 278    * a reconnection you can have all the pads unlinked or removed.
 279    *
 280    * Since: 1.6
 281    */
 282   g_object_class_install_property (gobject_class, PROP_ALLOW_NOT_LINKED,
 283       g_param_spec_boolean ("allow-not-linked", "Allow not linked",
 284           "Return GST_FLOW_OK even if there are no source pads or they are "
 285           "all unlinked", DEFAULT_PROP_ALLOW_NOT_LINKED,
 286           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 287
 288   gst_element_class_set_static_metadata (gstelement_class,
 289       "Tee pipe fitting",
 290       "Generic",
 291       "1-to-N pipe fitting",
 292       "Erik Walthinsen <omega@cse.ogi.edu>, " "Wim Taymans <wim@fluendo.com>");
 293   gst_element_class_add_pad_template (gstelement_class,
 294       gst_static_pad_template_get (&sinktemplate));
 295   gst_element_class_add_pad_template (gstelement_class,
 296       gst_static_pad_template_get (&tee_src_template));
 297
 298   gstelement_class->request_new_pad =
 299       GST_DEBUG_FUNCPTR (gst_tee_request_new_pad);
 300   gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_tee_release_pad);
 301 }
 302
 303 static void
 304 gst_tee_init (GstTee * tee)
 305 {
 306   tee->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
 307   tee->sink_mode = GST_PAD_MODE_NONE;
 308
 309   gst_pad_set_event_function (tee->sinkpad,
 310       GST_DEBUG_FUNCPTR (gst_tee_sink_event));
 311   gst_pad_set_query_function (tee->sinkpad,
 312       GST_DEBUG_FUNCPTR (gst_tee_sink_query));
 313   gst_pad_set_activatemode_function (tee->sinkpad,
 314       GST_DEBUG_FUNCPTR (gst_tee_sink_activate_mode));
 315   gst_pad_set_chain_function (tee->sinkpad, GST_DEBUG_FUNCPTR (gst_tee_chain));
 316   gst_pad_set_chain_list_function (tee->sinkpad,
 317       GST_DEBUG_FUNCPTR (gst_tee_chain_list));
 318   GST_OBJECT_FLAG_SET (tee->sinkpad, GST_PAD_FLAG_PROXY_CAPS);
 319   gst_element_add_pad (GST_ELEMENT (tee), tee->sinkpad);
 320
 321   tee->pad_indexes = g_hash_table_new (NULL, NULL);
 322
 323   tee->last_message = NULL;
 324 }
 325
 326 static void
 327 gst_tee_notify_alloc_pad (GstTee * tee)
 328 {
 329   g_object_notify_by_pspec ((GObject *) tee, pspec_alloc_pad);
 330 }
 331
 332 static gboolean
 333 forward_sticky_events (GstPad * pad, GstEvent ** event, gpointer user_data)
 334 {
 335   GstPad *srcpad = GST_PAD_CAST (user_data);
 336   GstFlowReturn ret;
 337
 338   ret = gst_pad_store_sticky_event (srcpad, *event);
 339   if (ret != GST_FLOW_OK) {
 340     GST_DEBUG_OBJECT (srcpad, "storing sticky event %p (%s) failed: %s", *event,
 341         GST_EVENT_TYPE_NAME (*event), gst_flow_get_name (ret));
 342   }
 343
 344   return TRUE;
 345 }
 346
 347 static GstPad *
 348 gst_tee_request_new_pad (GstElement * element, GstPadTemplate * templ,
 349     const gchar * name_templ, const GstCaps * caps)
 350 {
 351   gchar *name;
 352   GstPad *srcpad;
 353   GstTee *tee;
 354   GstPadMode mode;
 355   gboolean res;
 356   guint index = 0;
 357
 358   tee = GST_TEE (element);
 359
 360   GST_DEBUG_OBJECT (tee, "requesting pad");
 361
 362   GST_OBJECT_LOCK (tee);
 363
 364   if (name_templ) {
 365     sscanf (name_templ, "src_%u", &index);
 366     GST_LOG_OBJECT (element, "name: %s (index %d)", name_templ, index);
 367     if (g_hash_table_contains (tee->pad_indexes, GUINT_TO_POINTER (index))) {
 368       GST_ERROR_OBJECT (element, "pad name %s is not unique", name_templ);
 369       GST_OBJECT_UNLOCK (tee);
 370       return NULL;
 371     }
 372     if (index >= tee->next_pad_index)
 373       tee->next_pad_index = index + 1;
 374   } else {
 375     index = tee->next_pad_index;
 376
 377     while (g_hash_table_contains (tee->pad_indexes, GUINT_TO_POINTER (index)))
 378       index++;
 379
 380     tee->next_pad_index = index + 1;
 381   }
 382
 383   g_hash_table_insert (tee->pad_indexes, GUINT_TO_POINTER (index), NULL);
 384
 385   name = g_strdup_printf ("src_%u", index);
 386
 387   srcpad = GST_PAD_CAST (g_object_new (GST_TYPE_TEE_PAD,
 388           "name", name, "direction", templ->direction, "template", templ,
 389           NULL));
 390   GST_TEE_PAD_CAST (srcpad)->index = index;
 391   g_free (name);
 392
 393   mode = tee->sink_mode;
 394
 395   GST_OBJECT_UNLOCK (tee);
 396
 397   switch (mode) {
 398     case GST_PAD_MODE_PULL:
 399       /* we already have a src pad in pull mode, and our pull mode can only be
 400          SINGLE, so fall through to activate this new pad in push mode */
 401     case GST_PAD_MODE_PUSH:
 402       res = gst_pad_activate_mode (srcpad, GST_PAD_MODE_PUSH, TRUE);
 403       break;
 404     default:
 405       res = TRUE;
 406       break;
 407   }
 408
 409   if (!res)
 410     goto activate_failed;
 411
 412   gst_pad_set_activatemode_function (srcpad,
 413       GST_DEBUG_FUNCPTR (gst_tee_src_activate_mode));
 414   gst_pad_set_query_function (srcpad, GST_DEBUG_FUNCPTR (gst_tee_src_query));
 415   gst_pad_set_getrange_function (srcpad,
 416       GST_DEBUG_FUNCPTR (gst_tee_src_get_range));
 417   /* Forward sticky events to the new srcpad */
 418   gst_pad_sticky_events_foreach (tee->sinkpad, forward_sticky_events, srcpad);
 419   GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PROXY_CAPS);
 420   gst_element_add_pad (GST_ELEMENT_CAST (tee), srcpad);
 421
 422   return srcpad;
 423
 424   /* ERRORS */
 425 activate_failed:
 426   {
 427     gboolean changed = FALSE;
 428
 429     GST_OBJECT_LOCK (tee);
 430     GST_DEBUG_OBJECT (tee, "warning failed to activate request pad");
 431     if (tee->allocpad == srcpad) {
 432       tee->allocpad = NULL;
 433       changed = TRUE;
 434     }
 435     GST_OBJECT_UNLOCK (tee);
 436     gst_object_unref (srcpad);
 437     if (changed) {
 438       gst_tee_notify_alloc_pad (tee);
 439     }
 440     return NULL;
 441   }
 442 }
 443
 444 static void
 445 gst_tee_release_pad (GstElement * element, GstPad * pad)
 446 {
 447   GstTee *tee;
 448   gboolean changed = FALSE;
 449   guint index;
 450
 451   tee = GST_TEE (element);
 452
 453   GST_DEBUG_OBJECT (tee, "releasing pad");
 454
 455   GST_OBJECT_LOCK (tee);
 456   index = GST_TEE_PAD_CAST (pad)->index;
 457   /* mark the pad as removed so that future pad_alloc fails with NOT_LINKED. */
 458   GST_TEE_PAD_CAST (pad)->removed = TRUE;
 459   if (tee->allocpad == pad) {
 460     tee->allocpad = NULL;
 461     changed = TRUE;
 462   }
 463   GST_OBJECT_UNLOCK (tee);
 464
 465   gst_object_ref (pad);
 466   gst_element_remove_pad (GST_ELEMENT_CAST (tee), pad);
 467
 468   gst_pad_set_active (pad, FALSE);
 469
 470   gst_object_unref (pad);
 471
 472   if (changed) {
 473     gst_tee_notify_alloc_pad (tee);
 474   }
 475
 476   GST_OBJECT_LOCK (tee);
 477   g_hash_table_remove (tee->pad_indexes, GUINT_TO_POINTER (index));
 478   GST_OBJECT_UNLOCK (tee);
 479 }
 480
 481 static void
 482 gst_tee_set_property (GObject * object, guint prop_id, const GValue * value,
 483     GParamSpec * pspec)
 484 {
 485   GstTee *tee = GST_TEE (object);
 486
 487   GST_OBJECT_LOCK (tee);
 488   switch (prop_id) {
 489     case PROP_HAS_CHAIN:
 490       tee->has_chain = g_value_get_boolean (value);
 491       break;
 492     case PROP_SILENT:
 493       tee->silent = g_value_get_boolean (value);
 494       break;
 495     case PROP_PULL_MODE:
 496       tee->pull_mode = (GstTeePullMode) g_value_get_enum (value);
 497       break;
 498     case PROP_ALLOC_PAD:
 499     {
 500       GstPad *pad = g_value_get_object (value);
 501       GST_OBJECT_LOCK (pad);
 502       if (GST_OBJECT_PARENT (pad) == GST_OBJECT_CAST (object))
 503         tee->allocpad = pad;
 504       else
 505         GST_WARNING_OBJECT (object, "Tried to set alloc pad %s which"
 506             " is not my pad", GST_OBJECT_NAME (pad));
 507       GST_OBJECT_UNLOCK (pad);
 508       break;
 509     }
 510     case PROP_ALLOW_NOT_LINKED:
 511       tee->allow_not_linked = g_value_get_boolean (value);
 512       break;
 513     default:
 514       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 515       break;
 516   }
 517   GST_OBJECT_UNLOCK (tee);
 518 }
 519
 520 static void
 521 gst_tee_get_property (GObject * object, guint prop_id, GValue * value,
 522     GParamSpec * pspec)
 523 {
 524   GstTee *tee = GST_TEE (object);
 525
 526   GST_OBJECT_LOCK (tee);
 527   switch (prop_id) {
 528     case PROP_NUM_SRC_PADS:
 529       g_value_set_int (value, GST_ELEMENT (tee)->numsrcpads);
 530       break;
 531     case PROP_HAS_CHAIN:
 532       g_value_set_boolean (value, tee->has_chain);
 533       break;
 534     case PROP_SILENT:
 535       g_value_set_boolean (value, tee->silent);
 536       break;
 537     case PROP_LAST_MESSAGE:
 538       g_value_set_string (value, tee->last_message);
 539       break;
 540     case PROP_PULL_MODE:
 541       g_value_set_enum (value, tee->pull_mode);
 542       break;
 543     case PROP_ALLOC_PAD:
 544       g_value_set_object (value, tee->allocpad);
 545       break;
 546     case PROP_ALLOW_NOT_LINKED:
 547       g_value_set_boolean (value, tee->allow_not_linked);
 548       break;
 549     default:
 550       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 551       break;
 552   }
 553   GST_OBJECT_UNLOCK (tee);
 554 }
 555
 556 static gboolean
 557 gst_tee_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 558 {
 559   gboolean res;
 560
 561   switch (GST_EVENT_TYPE (event)) {
 562     default:
 563       res = gst_pad_event_default (pad, parent, event);
 564       break;
 565   }
 566
 567   return res;
 568 }
 569
 570 static gboolean
 571 gst_tee_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
 572 {
 573   gboolean res;
 574
 575   switch (GST_QUERY_TYPE (query)) {
 576     default:
 577       res = gst_pad_query_default (pad, parent, query);
 578       break;
 579   }
 580   return res;
 581 }
 582
 583 static void
 584 gst_tee_do_message (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 585 {
 586   GST_OBJECT_LOCK (tee);
 587   g_free (tee->last_message);
 588   if (is_list) {
 589     tee->last_message =
 590         g_strdup_printf ("chain-list   ******* (%s:%s)t %p",
 591         GST_DEBUG_PAD_NAME (pad), data);
 592   } else {
 593     tee->last_message =
 594         g_strdup_printf ("chain        ******* (%s:%s)t (%" G_GSIZE_FORMAT
 595         " bytes, %" G_GUINT64_FORMAT ") %p", GST_DEBUG_PAD_NAME (pad),
 596         gst_buffer_get_size (data), GST_BUFFER_TIMESTAMP (data), data);
 597   }
 598   GST_OBJECT_UNLOCK (tee);
 599
 600   g_object_notify_by_pspec ((GObject *) tee, pspec_last_message);
 601 }
 602
 603 static GstFlowReturn
 604 gst_tee_do_push (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 605 {
 606   GstFlowReturn res;
 607
 608   /* Push */
 609   if (pad == tee->pull_pad) {
 610     /* don't push on the pad we're pulling from */
 611     res = GST_FLOW_OK;
 612   } else if (is_list) {
 613     res =
 614         gst_pad_push_list (pad,
 615         gst_buffer_list_ref (GST_BUFFER_LIST_CAST (data)));
 616   } else {
 617     res = gst_pad_push (pad, gst_buffer_ref (GST_BUFFER_CAST (data)));
 618   }
 619   return res;
 620 }
 621
 622 static void
 623 clear_pads (GstPad * pad, GstTee * tee)
 624 {
 625   GST_TEE_PAD_CAST (pad)->pushed = FALSE;
 626   GST_TEE_PAD_CAST (pad)->result = GST_FLOW_NOT_LINKED;
 627 }
 628
 629 static GstFlowReturn
 630 gst_tee_handle_data (GstTee * tee, gpointer data, gboolean is_list)
 631 {
 632   GList *pads;
 633   guint32 cookie;
 634   GstFlowReturn ret, cret;
 635
 636   if (G_UNLIKELY (!tee->silent))
 637     gst_tee_do_message (tee, tee->sinkpad, data, is_list);
 638
 639   GST_OBJECT_LOCK (tee);
 640   pads = GST_ELEMENT_CAST (tee)->srcpads;
 641
 642   /* special case for zero pads */
 643   if (G_UNLIKELY (!pads))
 644     goto no_pads;
 645
 646   /* special case for just one pad that avoids reffing the buffer */
 647   if (!pads->next) {
 648     GstPad *pad = GST_PAD_CAST (pads->data);
 649
 650     /* Keep another ref around, a pad probe
 651      * might release and destroy the pad */
 652     gst_object_ref (pad);
 653     GST_OBJECT_UNLOCK (tee);
 654
 655     if (pad == tee->pull_pad) {
 656       ret = GST_FLOW_OK;
 657     } else if (is_list) {
 658       ret = gst_pad_push_list (pad, GST_BUFFER_LIST_CAST (data));
 659     } else {
 660       ret = gst_pad_push (pad, GST_BUFFER_CAST (data));
 661     }
 662
 663     gst_object_unref (pad);
 664
 665     if (ret == GST_FLOW_NOT_LINKED && tee->allow_not_linked) {
 666       ret = GST_FLOW_OK;
 667     }
 668
 669     return ret;
 670   }
 671
 672   /* mark all pads as 'not pushed on yet' */
 673   g_list_foreach (pads, (GFunc) clear_pads, tee);
 674
 675 restart:
 676   if (tee->allow_not_linked) {
 677     cret = GST_FLOW_OK;
 678   } else {
 679     cret = GST_FLOW_NOT_LINKED;
 680   }
 681   pads = GST_ELEMENT_CAST (tee)->srcpads;
 682   cookie = GST_ELEMENT_CAST (tee)->pads_cookie;
 683
 684   while (pads) {
 685     GstPad *pad;
 686
 687     pad = GST_PAD_CAST (pads->data);
 688
 689     if (G_LIKELY (!GST_TEE_PAD_CAST (pad)->pushed)) {
 690       /* not yet pushed, release lock and start pushing */
 691       gst_object_ref (pad);
 692       GST_OBJECT_UNLOCK (tee);
 693
 694       GST_LOG_OBJECT (pad, "Starting to push %s %p",
 695           is_list ? "list" : "buffer", data);
 696
 697       ret = gst_tee_do_push (tee, pad, data, is_list);
 698
 699       GST_LOG_OBJECT (pad, "Pushing item %p yielded result %s", data,
 700           gst_flow_get_name (ret));
 701
 702       GST_OBJECT_LOCK (tee);
 703       /* keep track of which pad we pushed and the result value */
 704       GST_TEE_PAD_CAST (pad)->pushed = TRUE;
 705       GST_TEE_PAD_CAST (pad)->result = ret;
 706       gst_object_unref (pad);
 707       pad = NULL;
 708     } else {
 709       /* already pushed, use previous return value */
 710       ret = GST_TEE_PAD_CAST (pad)->result;
 711       GST_LOG_OBJECT (pad, "pad already pushed with %s",
 712           gst_flow_get_name (ret));
 713     }
 714
 715     /* before we go combining the return value, check if the pad list is still
 716      * the same. It could be possible that the pad we just pushed was removed
 717      * and the return value it not valid anymore */
 718     if (G_UNLIKELY (GST_ELEMENT_CAST (tee)->pads_cookie != cookie)) {
 719       GST_LOG_OBJECT (tee, "pad list changed");
 720       /* the list of pads changed, restart iteration. Pads that we already
 721        * pushed on and are still in the new list, will not be pushed on
 722        * again. */
 723       goto restart;
 724     }
 725
 726     /* stop pushing more buffers when we have a fatal error */
 727     if (G_UNLIKELY (ret != GST_FLOW_OK && ret != GST_FLOW_NOT_LINKED))
 728       goto error;
 729
 730     /* keep all other return values, overwriting the previous one. */
 731     if (G_LIKELY (ret != GST_FLOW_NOT_LINKED)) {
 732       GST_LOG_OBJECT (tee, "Replacing ret val %d with %d", cret, ret);
 733       cret = ret;
 734     }
 735     pads = g_list_next (pads);
 736   }
 737   GST_OBJECT_UNLOCK (tee);
 738
 739   gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 740
 741   /* no need to unset gvalue */
 742   return cret;
 743
 744   /* ERRORS */
 745 no_pads:
 746   {
 747     if (tee->allow_not_linked) {
 748       GST_DEBUG_OBJECT (tee, "there are no pads, dropping %s",
 749           is_list ? "buffer-list" : "buffer");
 750       ret = GST_FLOW_OK;
 751     } else {
 752       GST_DEBUG_OBJECT (tee, "there are no pads, return not-linked");
 753       ret = GST_FLOW_NOT_LINKED;
 754     }
 755     goto end;
 756   }
 757 error:
 758   {
 759     GST_DEBUG_OBJECT (tee, "received error %s", gst_flow_get_name (ret));
 760     goto end;
 761   }
 762 end:
 763   {
 764     GST_OBJECT_UNLOCK (tee);
 765     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 766     return ret;
 767   }
 768 }
 769
 770 static GstFlowReturn
 771 gst_tee_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 772 {
 773   GstFlowReturn res;
 774   GstTee *tee;
 775
 776   tee = GST_TEE_CAST (parent);
 777
 778   GST_DEBUG_OBJECT (tee, "received buffer %p", buffer);
 779
 780   res = gst_tee_handle_data (tee, buffer, FALSE);
 781
 782   GST_DEBUG_OBJECT (tee, "handled buffer %s", gst_flow_get_name (res));
 783
 784   return res;
 785 }
 786
 787 static GstFlowReturn
 788 gst_tee_chain_list (GstPad * pad, GstObject * parent, GstBufferList * list)
 789 {
 790   GstFlowReturn res;
 791   GstTee *tee;
 792
 793   tee = GST_TEE_CAST (parent);
 794
 795   GST_DEBUG_OBJECT (tee, "received list %p", list);
 796
 797   res = gst_tee_handle_data (tee, list, TRUE);
 798
 799   GST_DEBUG_OBJECT (tee, "handled list %s", gst_flow_get_name (res));
 800
 801   return res;
 802 }
 803
 804 static gboolean
 805 gst_tee_sink_activate_mode (GstPad * pad, GstObject * parent, GstPadMode mode,
 806     gboolean active)
 807 {
 808   gboolean res;
 809   GstTee *tee;
 810
 811   tee = GST_TEE (parent);
 812
 813   switch (mode) {
 814     case GST_PAD_MODE_PUSH:
 815     {
 816       GST_OBJECT_LOCK (tee);
 817       tee->sink_mode = active ? mode : GST_PAD_MODE_NONE;
 818
 819       if (active && !tee->has_chain)
 820         goto no_chain;
 821       GST_OBJECT_UNLOCK (tee);
 822       res = TRUE;
 823       break;
 824     }
 825     default:
 826       res = FALSE;
 827       break;
 828   }
 829   return res;
 830
 831   /* ERRORS */
 832 no_chain:
 833   {
 834     GST_OBJECT_UNLOCK (tee);
 835     GST_INFO_OBJECT (tee,
 836         "Tee cannot operate in push mode with has-chain==FALSE");
 837     return FALSE;
 838   }
 839 }
 840
 841 static gboolean
 842 gst_tee_src_activate_mode (GstPad * pad, GstObject * parent, GstPadMode mode,
 843     gboolean active)
 844 {
 845   GstTee *tee;
 846   gboolean res;
 847   GstPad *sinkpad;
 848
 849   tee = GST_TEE (parent);
 850
 851   switch (mode) {
 852     case GST_PAD_MODE_PULL:
 853     {
 854       GST_OBJECT_LOCK (tee);
 855
 856       if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
 857         goto cannot_pull;
 858
 859       if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && active && tee->pull_pad)
 860         goto cannot_pull_multiple_srcs;
 861
 862       sinkpad = gst_object_ref (tee->sinkpad);
 863
 864       GST_OBJECT_UNLOCK (tee);
 865
 866       res = gst_pad_activate_mode (sinkpad, GST_PAD_MODE_PULL, active);
 867       gst_object_unref (sinkpad);
 868
 869       if (!res)
 870         goto sink_activate_failed;
 871
 872       GST_OBJECT_LOCK (tee);
 873       if (active) {
 874         if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE)
 875           tee->pull_pad = pad;
 876       } else {
 877         if (pad == tee->pull_pad)
 878           tee->pull_pad = NULL;
 879       }
 880       tee->sink_mode = (active ? GST_PAD_MODE_PULL : GST_PAD_MODE_NONE);
 881       GST_OBJECT_UNLOCK (tee);
 882       break;
 883     }
 884     default:
 885       res = TRUE;
 886       break;
 887   }
 888
 889   return res;
 890
 891   /* ERRORS */
 892 cannot_pull:
 893   {
 894     GST_OBJECT_UNLOCK (tee);
 895     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 896         "set to NEVER");
 897     return FALSE;
 898   }
 899 cannot_pull_multiple_srcs:
 900   {
 901     GST_OBJECT_UNLOCK (tee);
 902     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 903         "pull-mode set to SINGLE");
 904     return FALSE;
 905   }
 906 sink_activate_failed:
 907   {
 908     GST_INFO_OBJECT (tee, "Failed to %sactivate sink pad in pull mode",
 909         active ? "" : "de");
 910     return FALSE;
 911   }
 912 }
 913
 914 static gboolean
 915 gst_tee_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
 916 {
 917   GstTee *tee;
 918   gboolean res;
 919   GstPad *sinkpad;
 920
 921   tee = GST_TEE (parent);
 922
 923   switch (GST_QUERY_TYPE (query)) {
 924     case GST_QUERY_SCHEDULING:
 925     {
 926       gboolean pull_mode;
 927
 928       GST_OBJECT_LOCK (tee);
 929       pull_mode = TRUE;
 930       if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER) {
 931         GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 932             "set to NEVER");
 933         pull_mode = FALSE;
 934       } else if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && tee->pull_pad) {
 935         GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 936             "pull-mode set to SINGLE");
 937         pull_mode = FALSE;
 938       }
 939
 940       sinkpad = gst_object_ref (tee->sinkpad);
 941       GST_OBJECT_UNLOCK (tee);
 942
 943       if (pull_mode) {
 944         /* ask peer if we can operate in pull mode */
 945         res = gst_pad_peer_query (sinkpad, query);
 946       } else {
 947         res = TRUE;
 948       }
 949       gst_object_unref (sinkpad);
 950       break;
 951     }
 952     default:
 953       res = gst_pad_query_default (pad, parent, query);
 954       break;
 955   }
 956
 957   return res;
 958 }
 959
 960 static void
 961 gst_tee_push_eos (const GValue * vpad, GstTee * tee)
 962 {
 963   GstPad *pad = g_value_get_object (vpad);
 964
 965   if (pad != tee->pull_pad)
 966     gst_pad_push_event (pad, gst_event_new_eos ());
 967 }
 968
 969 static void
 970 gst_tee_pull_eos (GstTee * tee)
 971 {
 972   GstIterator *iter;
 973
 974   iter = gst_element_iterate_src_pads (GST_ELEMENT (tee));
 975   gst_iterator_foreach (iter, (GstIteratorForeachFunction) gst_tee_push_eos,
 976       tee);
 977   gst_iterator_free (iter);
 978 }
 979
 980 static GstFlowReturn
 981 gst_tee_src_get_range (GstPad * pad, GstObject * parent, guint64 offset,
 982     guint length, GstBuffer ** buf)
 983 {
 984   GstTee *tee;
 985   GstFlowReturn ret;
 986
 987   tee = GST_TEE (parent);
 988
 989   ret = gst_pad_pull_range (tee->sinkpad, offset, length, buf);
 990
 991   if (ret == GST_FLOW_OK)
 992     ret = gst_tee_handle_data (tee, gst_buffer_ref (*buf), FALSE);
 993   else if (ret == GST_FLOW_EOS)
 994     gst_tee_pull_eos (tee);
 995
 996   return ret;
 997 }