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 && sscanf (name_templ, "src_%u", &index) == 1) {
 365     GST_LOG_OBJECT (element, "name: %s (index %d)", name_templ, index);
 366     if (g_hash_table_contains (tee->pad_indexes, GUINT_TO_POINTER (index))) {
 367       GST_ERROR_OBJECT (element, "pad name %s is not unique", name_templ);
 368       GST_OBJECT_UNLOCK (tee);
 369       return NULL;
 370     }
 371     if (index >= tee->next_pad_index)
 372       tee->next_pad_index = index + 1;
 373   } else {
 374     index = tee->next_pad_index;
 375
 376     while (g_hash_table_contains (tee->pad_indexes, GUINT_TO_POINTER (index)))
 377       index++;
 378
 379     tee->next_pad_index = index + 1;
 380   }
 381
 382   g_hash_table_insert (tee->pad_indexes, GUINT_TO_POINTER (index), NULL);
 383
 384   name = g_strdup_printf ("src_%u", index);
 385
 386   srcpad = GST_PAD_CAST (g_object_new (GST_TYPE_TEE_PAD,
 387           "name", name, "direction", templ->direction, "template", templ,
 388           NULL));
 389   GST_TEE_PAD_CAST (srcpad)->index = index;
 390   g_free (name);
 391
 392   mode = tee->sink_mode;
 393
 394   GST_OBJECT_UNLOCK (tee);
 395
 396   switch (mode) {
 397     case GST_PAD_MODE_PULL:
 398       /* we already have a src pad in pull mode, and our pull mode can only be
 399          SINGLE, so fall through to activate this new pad in push mode */
 400     case GST_PAD_MODE_PUSH:
 401       res = gst_pad_activate_mode (srcpad, GST_PAD_MODE_PUSH, TRUE);
 402       break;
 403     default:
 404       res = TRUE;
 405       break;
 406   }
 407
 408   if (!res)
 409     goto activate_failed;
 410
 411   gst_pad_set_activatemode_function (srcpad,
 412       GST_DEBUG_FUNCPTR (gst_tee_src_activate_mode));
 413   gst_pad_set_query_function (srcpad, GST_DEBUG_FUNCPTR (gst_tee_src_query));
 414   gst_pad_set_getrange_function (srcpad,
 415       GST_DEBUG_FUNCPTR (gst_tee_src_get_range));
 416   /* Forward sticky events to the new srcpad */
 417   gst_pad_sticky_events_foreach (tee->sinkpad, forward_sticky_events, srcpad);
 418   GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PROXY_CAPS);
 419   gst_element_add_pad (GST_ELEMENT_CAST (tee), srcpad);
 420
 421   return srcpad;
 422
 423   /* ERRORS */
 424 activate_failed:
 425   {
 426     gboolean changed = FALSE;
 427
 428     GST_OBJECT_LOCK (tee);
 429     GST_DEBUG_OBJECT (tee, "warning failed to activate request pad");
 430     if (tee->allocpad == srcpad) {
 431       tee->allocpad = NULL;
 432       changed = TRUE;
 433     }
 434     GST_OBJECT_UNLOCK (tee);
 435     gst_object_unref (srcpad);
 436     if (changed) {
 437       gst_tee_notify_alloc_pad (tee);
 438     }
 439     return NULL;
 440   }
 441 }
 442
 443 static void
 444 gst_tee_release_pad (GstElement * element, GstPad * pad)
 445 {
 446   GstTee *tee;
 447   gboolean changed = FALSE;
 448   guint index;
 449
 450   tee = GST_TEE (element);
 451
 452   GST_DEBUG_OBJECT (tee, "releasing pad");
 453
 454   GST_OBJECT_LOCK (tee);
 455   index = GST_TEE_PAD_CAST (pad)->index;
 456   /* mark the pad as removed so that future pad_alloc fails with NOT_LINKED. */
 457   GST_TEE_PAD_CAST (pad)->removed = TRUE;
 458   if (tee->allocpad == pad) {
 459     tee->allocpad = NULL;
 460     changed = TRUE;
 461   }
 462   GST_OBJECT_UNLOCK (tee);
 463
 464   gst_object_ref (pad);
 465   gst_element_remove_pad (GST_ELEMENT_CAST (tee), pad);
 466
 467   gst_pad_set_active (pad, FALSE);
 468
 469   gst_object_unref (pad);
 470
 471   if (changed) {
 472     gst_tee_notify_alloc_pad (tee);
 473   }
 474
 475   GST_OBJECT_LOCK (tee);
 476   g_hash_table_remove (tee->pad_indexes, GUINT_TO_POINTER (index));
 477   GST_OBJECT_UNLOCK (tee);
 478 }
 479
 480 static void
 481 gst_tee_set_property (GObject * object, guint prop_id, const GValue * value,
 482     GParamSpec * pspec)
 483 {
 484   GstTee *tee = GST_TEE (object);
 485
 486   GST_OBJECT_LOCK (tee);
 487   switch (prop_id) {
 488     case PROP_HAS_CHAIN:
 489       tee->has_chain = g_value_get_boolean (value);
 490       break;
 491     case PROP_SILENT:
 492       tee->silent = g_value_get_boolean (value);
 493       break;
 494     case PROP_PULL_MODE:
 495       tee->pull_mode = (GstTeePullMode) g_value_get_enum (value);
 496       break;
 497     case PROP_ALLOC_PAD:
 498     {
 499       GstPad *pad = g_value_get_object (value);
 500       GST_OBJECT_LOCK (pad);
 501       if (GST_OBJECT_PARENT (pad) == GST_OBJECT_CAST (object))
 502         tee->allocpad = pad;
 503       else
 504         GST_WARNING_OBJECT (object, "Tried to set alloc pad %s which"
 505             " is not my pad", GST_OBJECT_NAME (pad));
 506       GST_OBJECT_UNLOCK (pad);
 507       break;
 508     }
 509     case PROP_ALLOW_NOT_LINKED:
 510       tee->allow_not_linked = g_value_get_boolean (value);
 511       break;
 512     default:
 513       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 514       break;
 515   }
 516   GST_OBJECT_UNLOCK (tee);
 517 }
 518
 519 static void
 520 gst_tee_get_property (GObject * object, guint prop_id, GValue * value,
 521     GParamSpec * pspec)
 522 {
 523   GstTee *tee = GST_TEE (object);
 524
 525   GST_OBJECT_LOCK (tee);
 526   switch (prop_id) {
 527     case PROP_NUM_SRC_PADS:
 528       g_value_set_int (value, GST_ELEMENT (tee)->numsrcpads);
 529       break;
 530     case PROP_HAS_CHAIN:
 531       g_value_set_boolean (value, tee->has_chain);
 532       break;
 533     case PROP_SILENT:
 534       g_value_set_boolean (value, tee->silent);
 535       break;
 536     case PROP_LAST_MESSAGE:
 537       g_value_set_string (value, tee->last_message);
 538       break;
 539     case PROP_PULL_MODE:
 540       g_value_set_enum (value, tee->pull_mode);
 541       break;
 542     case PROP_ALLOC_PAD:
 543       g_value_set_object (value, tee->allocpad);
 544       break;
 545     case PROP_ALLOW_NOT_LINKED:
 546       g_value_set_boolean (value, tee->allow_not_linked);
 547       break;
 548     default:
 549       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 550       break;
 551   }
 552   GST_OBJECT_UNLOCK (tee);
 553 }
 554
 555 static gboolean
 556 gst_tee_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
 557 {
 558   gboolean res;
 559
 560   switch (GST_EVENT_TYPE (event)) {
 561     default:
 562       res = gst_pad_event_default (pad, parent, event);
 563       break;
 564   }
 565
 566   return res;
 567 }
 568
 569 static gboolean
 570 gst_tee_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
 571 {
 572   gboolean res;
 573
 574   switch (GST_QUERY_TYPE (query)) {
 575     default:
 576       res = gst_pad_query_default (pad, parent, query);
 577       break;
 578   }
 579   return res;
 580 }
 581
 582 static void
 583 gst_tee_do_message (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 584 {
 585   GST_OBJECT_LOCK (tee);
 586   g_free (tee->last_message);
 587   if (is_list) {
 588     tee->last_message =
 589         g_strdup_printf ("chain-list   ******* (%s:%s)t %p",
 590         GST_DEBUG_PAD_NAME (pad), data);
 591   } else {
 592     tee->last_message =
 593         g_strdup_printf ("chain        ******* (%s:%s)t (%" G_GSIZE_FORMAT
 594         " bytes, %" G_GUINT64_FORMAT ") %p", GST_DEBUG_PAD_NAME (pad),
 595         gst_buffer_get_size (data), GST_BUFFER_TIMESTAMP (data), data);
 596   }
 597   GST_OBJECT_UNLOCK (tee);
 598
 599   g_object_notify_by_pspec ((GObject *) tee, pspec_last_message);
 600 }
 601
 602 static GstFlowReturn
 603 gst_tee_do_push (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 604 {
 605   GstFlowReturn res;
 606
 607   /* Push */
 608   if (pad == tee->pull_pad) {
 609     /* don't push on the pad we're pulling from */
 610     res = GST_FLOW_OK;
 611   } else if (is_list) {
 612     res =
 613         gst_pad_push_list (pad,
 614         gst_buffer_list_ref (GST_BUFFER_LIST_CAST (data)));
 615   } else {
 616     res = gst_pad_push (pad, gst_buffer_ref (GST_BUFFER_CAST (data)));
 617   }
 618   return res;
 619 }
 620
 621 static void
 622 clear_pads (GstPad * pad, GstTee * tee)
 623 {
 624   GST_TEE_PAD_CAST (pad)->pushed = FALSE;
 625   GST_TEE_PAD_CAST (pad)->result = GST_FLOW_NOT_LINKED;
 626 }
 627
 628 static GstFlowReturn
 629 gst_tee_handle_data (GstTee * tee, gpointer data, gboolean is_list)
 630 {
 631   GList *pads;
 632   guint32 cookie;
 633   GstFlowReturn ret, cret;
 634
 635   if (G_UNLIKELY (!tee->silent))
 636     gst_tee_do_message (tee, tee->sinkpad, data, is_list);
 637
 638   GST_OBJECT_LOCK (tee);
 639   pads = GST_ELEMENT_CAST (tee)->srcpads;
 640
 641   /* special case for zero pads */
 642   if (G_UNLIKELY (!pads))
 643     goto no_pads;
 644
 645   /* special case for just one pad that avoids reffing the buffer */
 646   if (!pads->next) {
 647     GstPad *pad = GST_PAD_CAST (pads->data);
 648
 649     /* Keep another ref around, a pad probe
 650      * might release and destroy the pad */
 651     gst_object_ref (pad);
 652     GST_OBJECT_UNLOCK (tee);
 653
 654     if (pad == tee->pull_pad) {
 655       ret = GST_FLOW_OK;
 656     } else if (is_list) {
 657       ret = gst_pad_push_list (pad, GST_BUFFER_LIST_CAST (data));
 658     } else {
 659       ret = gst_pad_push (pad, GST_BUFFER_CAST (data));
 660     }
 661
 662     gst_object_unref (pad);
 663
 664     if (ret == GST_FLOW_NOT_LINKED && tee->allow_not_linked) {
 665       ret = GST_FLOW_OK;
 666     }
 667
 668     return ret;
 669   }
 670
 671   /* mark all pads as 'not pushed on yet' */
 672   g_list_foreach (pads, (GFunc) clear_pads, tee);
 673
 674 restart:
 675   if (tee->allow_not_linked) {
 676     cret = GST_FLOW_OK;
 677   } else {
 678     cret = GST_FLOW_NOT_LINKED;
 679   }
 680   pads = GST_ELEMENT_CAST (tee)->srcpads;
 681   cookie = GST_ELEMENT_CAST (tee)->pads_cookie;
 682
 683   while (pads) {
 684     GstPad *pad;
 685
 686     pad = GST_PAD_CAST (pads->data);
 687
 688     if (G_LIKELY (!GST_TEE_PAD_CAST (pad)->pushed)) {
 689       /* not yet pushed, release lock and start pushing */
 690       gst_object_ref (pad);
 691       GST_OBJECT_UNLOCK (tee);
 692
 693       GST_LOG_OBJECT (pad, "Starting to push %s %p",
 694           is_list ? "list" : "buffer", data);
 695
 696       ret = gst_tee_do_push (tee, pad, data, is_list);
 697
 698       GST_LOG_OBJECT (pad, "Pushing item %p yielded result %s", data,
 699           gst_flow_get_name (ret));
 700
 701       GST_OBJECT_LOCK (tee);
 702       /* keep track of which pad we pushed and the result value */
 703       GST_TEE_PAD_CAST (pad)->pushed = TRUE;
 704       GST_TEE_PAD_CAST (pad)->result = ret;
 705       gst_object_unref (pad);
 706       pad = NULL;
 707     } else {
 708       /* already pushed, use previous return value */
 709       ret = GST_TEE_PAD_CAST (pad)->result;
 710       GST_LOG_OBJECT (pad, "pad already pushed with %s",
 711           gst_flow_get_name (ret));
 712     }
 713
 714     /* before we go combining the return value, check if the pad list is still
 715      * the same. It could be possible that the pad we just pushed was removed
 716      * and the return value it not valid anymore */
 717     if (G_UNLIKELY (GST_ELEMENT_CAST (tee)->pads_cookie != cookie)) {
 718       GST_LOG_OBJECT (tee, "pad list changed");
 719       /* the list of pads changed, restart iteration. Pads that we already
 720        * pushed on and are still in the new list, will not be pushed on
 721        * again. */
 722       goto restart;
 723     }
 724
 725     /* stop pushing more buffers when we have a fatal error */
 726     if (G_UNLIKELY (ret != GST_FLOW_OK && ret != GST_FLOW_NOT_LINKED))
 727       goto error;
 728
 729     /* keep all other return values, overwriting the previous one. */
 730     if (G_LIKELY (ret != GST_FLOW_NOT_LINKED)) {
 731       GST_LOG_OBJECT (tee, "Replacing ret val %d with %d", cret, ret);
 732       cret = ret;
 733     }
 734     pads = g_list_next (pads);
 735   }
 736   GST_OBJECT_UNLOCK (tee);
 737
 738   gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 739
 740   /* no need to unset gvalue */
 741   return cret;
 742
 743   /* ERRORS */
 744 no_pads:
 745   {
 746     if (tee->allow_not_linked) {
 747       GST_DEBUG_OBJECT (tee, "there are no pads, dropping %s",
 748           is_list ? "buffer-list" : "buffer");
 749       ret = GST_FLOW_OK;
 750     } else {
 751       GST_DEBUG_OBJECT (tee, "there are no pads, return not-linked");
 752       ret = GST_FLOW_NOT_LINKED;
 753     }
 754     goto end;
 755   }
 756 error:
 757   {
 758     GST_DEBUG_OBJECT (tee, "received error %s", gst_flow_get_name (ret));
 759     goto end;
 760   }
 761 end:
 762   {
 763     GST_OBJECT_UNLOCK (tee);
 764     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 765     return ret;
 766   }
 767 }
 768
 769 static GstFlowReturn
 770 gst_tee_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
 771 {
 772   GstFlowReturn res;
 773   GstTee *tee;
 774
 775   tee = GST_TEE_CAST (parent);
 776
 777   GST_DEBUG_OBJECT (tee, "received buffer %p", buffer);
 778
 779   res = gst_tee_handle_data (tee, buffer, FALSE);
 780
 781   GST_DEBUG_OBJECT (tee, "handled buffer %s", gst_flow_get_name (res));
 782
 783   return res;
 784 }
 785
 786 static GstFlowReturn
 787 gst_tee_chain_list (GstPad * pad, GstObject * parent, GstBufferList * list)
 788 {
 789   GstFlowReturn res;
 790   GstTee *tee;
 791
 792   tee = GST_TEE_CAST (parent);
 793
 794   GST_DEBUG_OBJECT (tee, "received list %p", list);
 795
 796   res = gst_tee_handle_data (tee, list, TRUE);
 797
 798   GST_DEBUG_OBJECT (tee, "handled list %s", gst_flow_get_name (res));
 799
 800   return res;
 801 }
 802
 803 static gboolean
 804 gst_tee_sink_activate_mode (GstPad * pad, GstObject * parent, GstPadMode mode,
 805     gboolean active)
 806 {
 807   gboolean res;
 808   GstTee *tee;
 809
 810   tee = GST_TEE (parent);
 811
 812   switch (mode) {
 813     case GST_PAD_MODE_PUSH:
 814     {
 815       GST_OBJECT_LOCK (tee);
 816       tee->sink_mode = active ? mode : GST_PAD_MODE_NONE;
 817
 818       if (active && !tee->has_chain)
 819         goto no_chain;
 820       GST_OBJECT_UNLOCK (tee);
 821       res = TRUE;
 822       break;
 823     }
 824     default:
 825       res = FALSE;
 826       break;
 827   }
 828   return res;
 829
 830   /* ERRORS */
 831 no_chain:
 832   {
 833     GST_OBJECT_UNLOCK (tee);
 834     GST_INFO_OBJECT (tee,
 835         "Tee cannot operate in push mode with has-chain==FALSE");
 836     return FALSE;
 837   }
 838 }
 839
 840 static gboolean
 841 gst_tee_src_activate_mode (GstPad * pad, GstObject * parent, GstPadMode mode,
 842     gboolean active)
 843 {
 844   GstTee *tee;
 845   gboolean res;
 846   GstPad *sinkpad;
 847
 848   tee = GST_TEE (parent);
 849
 850   switch (mode) {
 851     case GST_PAD_MODE_PULL:
 852     {
 853       GST_OBJECT_LOCK (tee);
 854
 855       if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
 856         goto cannot_pull;
 857
 858       if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && active && tee->pull_pad)
 859         goto cannot_pull_multiple_srcs;
 860
 861       sinkpad = gst_object_ref (tee->sinkpad);
 862
 863       GST_OBJECT_UNLOCK (tee);
 864
 865       res = gst_pad_activate_mode (sinkpad, GST_PAD_MODE_PULL, active);
 866       gst_object_unref (sinkpad);
 867
 868       if (!res)
 869         goto sink_activate_failed;
 870
 871       GST_OBJECT_LOCK (tee);
 872       if (active) {
 873         if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE)
 874           tee->pull_pad = pad;
 875       } else {
 876         if (pad == tee->pull_pad)
 877           tee->pull_pad = NULL;
 878       }
 879       tee->sink_mode = (active ? GST_PAD_MODE_PULL : GST_PAD_MODE_NONE);
 880       GST_OBJECT_UNLOCK (tee);
 881       break;
 882     }
 883     default:
 884       res = TRUE;
 885       break;
 886   }
 887
 888   return res;
 889
 890   /* ERRORS */
 891 cannot_pull:
 892   {
 893     GST_OBJECT_UNLOCK (tee);
 894     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 895         "set to NEVER");
 896     return FALSE;
 897   }
 898 cannot_pull_multiple_srcs:
 899   {
 900     GST_OBJECT_UNLOCK (tee);
 901     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 902         "pull-mode set to SINGLE");
 903     return FALSE;
 904   }
 905 sink_activate_failed:
 906   {
 907     GST_INFO_OBJECT (tee, "Failed to %sactivate sink pad in pull mode",
 908         active ? "" : "de");
 909     return FALSE;
 910   }
 911 }
 912
 913 static gboolean
 914 gst_tee_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
 915 {
 916   GstTee *tee;
 917   gboolean res;
 918   GstPad *sinkpad;
 919
 920   tee = GST_TEE (parent);
 921
 922   switch (GST_QUERY_TYPE (query)) {
 923     case GST_QUERY_SCHEDULING:
 924     {
 925       gboolean pull_mode;
 926
 927       GST_OBJECT_LOCK (tee);
 928       pull_mode = TRUE;
 929       if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER) {
 930         GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 931             "set to NEVER");
 932         pull_mode = FALSE;
 933       } else if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && tee->pull_pad) {
 934         GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 935             "pull-mode set to SINGLE");
 936         pull_mode = FALSE;
 937       }
 938
 939       sinkpad = gst_object_ref (tee->sinkpad);
 940       GST_OBJECT_UNLOCK (tee);
 941
 942       if (pull_mode) {
 943         /* ask peer if we can operate in pull mode */
 944         res = gst_pad_peer_query (sinkpad, query);
 945       } else {
 946         res = TRUE;
 947       }
 948       gst_object_unref (sinkpad);
 949       break;
 950     }
 951     default:
 952       res = gst_pad_query_default (pad, parent, query);
 953       break;
 954   }
 955
 956   return res;
 957 }
 958
 959 static void
 960 gst_tee_push_eos (const GValue * vpad, GstTee * tee)
 961 {
 962   GstPad *pad = g_value_get_object (vpad);
 963
 964   if (pad != tee->pull_pad)
 965     gst_pad_push_event (pad, gst_event_new_eos ());
 966 }
 967
 968 static void
 969 gst_tee_pull_eos (GstTee * tee)
 970 {
 971   GstIterator *iter;
 972
 973   iter = gst_element_iterate_src_pads (GST_ELEMENT (tee));
 974   gst_iterator_foreach (iter, (GstIteratorForeachFunction) gst_tee_push_eos,
 975       tee);
 976   gst_iterator_free (iter);
 977 }
 978
 979 static GstFlowReturn
 980 gst_tee_src_get_range (GstPad * pad, GstObject * parent, guint64 offset,
 981     guint length, GstBuffer ** buf)
 982 {
 983   GstTee *tee;
 984   GstFlowReturn ret;
 985
 986   tee = GST_TEE (parent);
 987
 988   ret = gst_pad_pull_range (tee->sinkpad, offset, length, buf);
 989
 990   if (ret == GST_FLOW_OK)
 991     ret = gst_tee_handle_data (tee, gst_buffer_ref (*buf), FALSE);
 992   else if (ret == GST_FLOW_EOS)
 993     gst_tee_pull_eos (tee);
 994
 995   return ret;
 996 }