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