plugins/elements/gsttee.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *               2000,2001,2002,2003,2004,2005 Wim Taymans <wim@fluendo.com>
   4  *               2007 Wim Taymans <wim.taymans@gmail.com>
   5  *
   6  * gsttee.c: Tee element, one in N out
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /**
  25  * SECTION:element-tee
  26  * @see_also: #GstIdentity
  27  *
  28  * Split data to multiple pads. Branching the data flow is useful when e.g.
  29  * capturing a video where the video is shown on the screen and also encoded and
  30  * written to a file. Another example is playing music and hooking up a
  31  * visualisation module.
  32  *
  33  * One needs to use separate queue elements (or a multiqueue) in each branch to
  34  * provide separate threads for each branch. Otherwise a blocked dataflow in one
  35  * branch would stall the other branches.
  36  *
  37  * <refsect2>
  38  * <title>Example launch line</title>
  39  * |[
  40  * gst-launch filesrc location=song.ogg ! decodebin2 ! tee name=t ! queue ! autoaudiosink t. ! queue ! audioconvert ! goom ! ffmpegcolorspace ! autovideosink
  41  * ]| Play a song.ogg from local dir and render visualisations using the goom
  42  * element.
  43  * </refsect2>
  44  */
  45
  46 #ifdef HAVE_CONFIG_H
  47 #  include "config.h"
  48 #endif
  49
  50 #include "gsttee.h"
  51
  52 #include <string.h>
  53
  54 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
  55     GST_PAD_SINK,
  56     GST_PAD_ALWAYS,
  57     GST_STATIC_CAPS_ANY);
  58
  59 GST_DEBUG_CATEGORY_STATIC (gst_tee_debug);
  60 #define GST_CAT_DEFAULT gst_tee_debug
  61
  62 #define GST_TYPE_TEE_PULL_MODE (gst_tee_pull_mode_get_type())
  63 static GType
  64 gst_tee_pull_mode_get_type (void)
  65 {
  66   static GType type = 0;
  67   static const GEnumValue data[] = {
  68     {GST_TEE_PULL_MODE_NEVER, "Never activate in pull mode", "never"},
  69     {GST_TEE_PULL_MODE_SINGLE, "Only one src pad can be active in pull mode",
  70         "single"},
  71     {0, NULL, NULL},
  72   };
  73
  74   if (!type) {
  75     type = g_enum_register_static ("GstTeePullMode", data);
  76   }
  77   return type;
  78 }
  79
  80 /* lock to protect request pads from being removed while downstream */
  81 #define GST_TEE_DYN_LOCK(tee) g_mutex_lock ((tee)->dyn_lock)
  82 #define GST_TEE_DYN_UNLOCK(tee) g_mutex_unlock ((tee)->dyn_lock)
  83
  84 #define DEFAULT_PROP_NUM_SRC_PADS       0
  85 #define DEFAULT_PROP_HAS_SINK_LOOP      FALSE
  86 #define DEFAULT_PROP_HAS_CHAIN          TRUE
  87 #define DEFAULT_PROP_SILENT             TRUE
  88 #define DEFAULT_PROP_LAST_MESSAGE       NULL
  89 #define DEFAULT_PULL_MODE               GST_TEE_PULL_MODE_NEVER
  90
  91 enum
  92 {
  93   PROP_0,
  94   PROP_NUM_SRC_PADS,
  95   PROP_HAS_SINK_LOOP,
  96   PROP_HAS_CHAIN,
  97   PROP_SILENT,
  98   PROP_LAST_MESSAGE,
  99   PROP_PULL_MODE,
 100   PROP_ALLOC_PAD,
 101 };
 102
 103 static GstStaticPadTemplate tee_src_template = GST_STATIC_PAD_TEMPLATE ("src%d",
 104     GST_PAD_SRC,
 105     GST_PAD_REQUEST,
 106     GST_STATIC_CAPS_ANY);
 107
 108 /* structure and quark to keep track of which pads have been pushed */
 109 static GQuark push_data;
 110
 111 #define _do_init \
 112     GST_DEBUG_CATEGORY_INIT (gst_tee_debug, "tee", 0, "tee element"); \
 113     push_data = g_quark_from_static_string ("tee-push-data");
 114 #define gst_tee_parent_class parent_class
 115 G_DEFINE_TYPE_WITH_CODE (GstTee, gst_tee, GST_TYPE_ELEMENT, _do_init);
 116
 117 static GParamSpec *pspec_last_message = NULL;
 118 static GParamSpec *pspec_alloc_pad = NULL;
 119
 120 typedef struct
 121 {
 122   gboolean pushed;
 123   GstFlowReturn result;
 124   gboolean removed;
 125 } PushData;
 126
 127 static GstPad *gst_tee_request_new_pad (GstElement * element,
 128     GstPadTemplate * temp, const gchar * unused);
 129 static void gst_tee_release_pad (GstElement * element, GstPad * pad);
 130
 131 static void gst_tee_finalize (GObject * object);
 132 static void gst_tee_set_property (GObject * object, guint prop_id,
 133     const GValue * value, GParamSpec * pspec);
 134 static void gst_tee_get_property (GObject * object, guint prop_id,
 135     GValue * value, GParamSpec * pspec);
 136 static void gst_tee_dispose (GObject * object);
 137
 138 static GstFlowReturn gst_tee_chain (GstPad * pad, GstBuffer * buffer);
 139 static GstFlowReturn gst_tee_chain_list (GstPad * pad, GstBufferList * list);
 140 static gboolean gst_tee_sink_acceptcaps (GstPad * pad, GstCaps * caps);
 141 static gboolean gst_tee_sink_activate_push (GstPad * pad, gboolean active);
 142 static gboolean gst_tee_src_check_get_range (GstPad * pad);
 143 static gboolean gst_tee_src_activate_pull (GstPad * pad, gboolean active);
 144 static GstFlowReturn gst_tee_src_get_range (GstPad * pad, guint64 offset,
 145     guint length, GstBuffer ** buf);
 146
 147 static void
 148 gst_tee_dispose (GObject * object)
 149 {
 150   GList *item;
 151
 152 restart:
 153   for (item = GST_ELEMENT_PADS (object); item; item = g_list_next (item)) {
 154     GstPad *pad = GST_PAD (item->data);
 155     if (GST_PAD_IS_SRC (pad)) {
 156       gst_element_release_request_pad (GST_ELEMENT (object), pad);
 157       goto restart;
 158     }
 159   }
 160
 161   G_OBJECT_CLASS (parent_class)->dispose (object);
 162 }
 163
 164 static void
 165 gst_tee_finalize (GObject * object)
 166 {
 167   GstTee *tee;
 168
 169   tee = GST_TEE (object);
 170
 171   g_free (tee->last_message);
 172
 173   g_mutex_free (tee->dyn_lock);
 174
 175   G_OBJECT_CLASS (parent_class)->finalize (object);
 176 }
 177
 178 static void
 179 gst_tee_class_init (GstTeeClass * klass)
 180 {
 181   GObjectClass *gobject_class;
 182   GstElementClass *gstelement_class;
 183
 184   gobject_class = G_OBJECT_CLASS (klass);
 185   gstelement_class = GST_ELEMENT_CLASS (klass);
 186
 187   gobject_class->finalize = gst_tee_finalize;
 188   gobject_class->set_property = gst_tee_set_property;
 189   gobject_class->get_property = gst_tee_get_property;
 190   gobject_class->dispose = gst_tee_dispose;
 191
 192   g_object_class_install_property (gobject_class, PROP_NUM_SRC_PADS,
 193       g_param_spec_int ("num-src-pads", "Num Src Pads",
 194           "The number of source pads", 0, G_MAXINT, DEFAULT_PROP_NUM_SRC_PADS,
 195           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 196   g_object_class_install_property (gobject_class, PROP_HAS_SINK_LOOP,
 197       g_param_spec_boolean ("has-sink-loop", "Has Sink Loop",
 198           "If the element should spawn a thread (unimplemented and deprecated)",
 199           DEFAULT_PROP_HAS_SINK_LOOP,
 200           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 201   g_object_class_install_property (gobject_class, PROP_HAS_CHAIN,
 202       g_param_spec_boolean ("has-chain", "Has Chain",
 203           "If the element can operate in push mode", DEFAULT_PROP_HAS_CHAIN,
 204           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 205   g_object_class_install_property (gobject_class, PROP_SILENT,
 206       g_param_spec_boolean ("silent", "Silent",
 207           "Don't produce last_message events", DEFAULT_PROP_SILENT,
 208           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 209   pspec_last_message = g_param_spec_string ("last-message", "Last Message",
 210       "The message describing current status", DEFAULT_PROP_LAST_MESSAGE,
 211       G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 212   g_object_class_install_property (gobject_class, PROP_LAST_MESSAGE,
 213       pspec_last_message);
 214   g_object_class_install_property (gobject_class, PROP_PULL_MODE,
 215       g_param_spec_enum ("pull-mode", "Pull mode",
 216           "Behavior of tee in pull mode", GST_TYPE_TEE_PULL_MODE,
 217           DEFAULT_PULL_MODE,
 218           G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 219   pspec_alloc_pad = g_param_spec_object ("alloc-pad", "Allocation Src Pad",
 220       "The pad used for gst_pad_alloc_buffer", GST_TYPE_PAD,
 221       G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 222   g_object_class_install_property (gobject_class, PROP_ALLOC_PAD,
 223       pspec_alloc_pad);
 224
 225   gst_element_class_set_details_simple (gstelement_class,
 226       "Tee pipe fitting",
 227       "Generic",
 228       "1-to-N pipe fitting",
 229       "Erik Walthinsen <omega@cse.ogi.edu>, " "Wim Taymans <wim@fluendo.com>");
 230   gst_element_class_add_pad_template (gstelement_class,
 231       gst_static_pad_template_get (&sinktemplate));
 232   gst_element_class_add_pad_template (gstelement_class,
 233       gst_static_pad_template_get (&tee_src_template));
 234
 235   gstelement_class->request_new_pad =
 236       GST_DEBUG_FUNCPTR (gst_tee_request_new_pad);
 237   gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_tee_release_pad);
 238 }
 239
 240 static void
 241 gst_tee_init (GstTee * tee)
 242 {
 243   tee->dyn_lock = g_mutex_new ();
 244
 245   tee->sinkpad = gst_pad_new_from_static_template (&sinktemplate, "sink");
 246   tee->sink_mode = GST_ACTIVATE_NONE;
 247
 248   gst_pad_set_setcaps_function (tee->sinkpad,
 249       GST_DEBUG_FUNCPTR (gst_pad_proxy_setcaps));
 250   gst_pad_set_getcaps_function (tee->sinkpad,
 251       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 252   gst_pad_set_acceptcaps_function (tee->sinkpad,
 253       GST_DEBUG_FUNCPTR (gst_tee_sink_acceptcaps));
 254   gst_pad_set_activatepush_function (tee->sinkpad,
 255       GST_DEBUG_FUNCPTR (gst_tee_sink_activate_push));
 256   gst_pad_set_chain_function (tee->sinkpad, GST_DEBUG_FUNCPTR (gst_tee_chain));
 257   gst_pad_set_chain_list_function (tee->sinkpad,
 258       GST_DEBUG_FUNCPTR (gst_tee_chain_list));
 259   gst_element_add_pad (GST_ELEMENT (tee), tee->sinkpad);
 260
 261   tee->last_message = NULL;
 262 }
 263
 264 static void
 265 gst_tee_notify_alloc_pad (GstTee * tee)
 266 {
 267 #if !GLIB_CHECK_VERSION(2,26,0)
 268   g_object_notify ((GObject *) tee, "alloc-pad");
 269 #else
 270   g_object_notify_by_pspec ((GObject *) tee, pspec_alloc_pad);
 271 #endif
 272 }
 273
 274 static GstPad *
 275 gst_tee_request_new_pad (GstElement * element, GstPadTemplate * templ,
 276     const gchar * unused)
 277 {
 278   gchar *name;
 279   GstPad *srcpad;
 280   GstTee *tee;
 281   GstActivateMode mode;
 282   gboolean res;
 283   PushData *data;
 284
 285   tee = GST_TEE (element);
 286
 287   GST_DEBUG_OBJECT (tee, "requesting pad");
 288
 289   GST_OBJECT_LOCK (tee);
 290   name = g_strdup_printf ("src%d", tee->pad_counter++);
 291
 292   srcpad = gst_pad_new_from_template (templ, name);
 293   g_free (name);
 294
 295   mode = tee->sink_mode;
 296
 297   /* install the data, we automatically free it when the pad is disposed because
 298    * of _release_pad or when the element goes away. */
 299   data = g_new0 (PushData, 1);
 300   data->pushed = FALSE;
 301   data->result = GST_FLOW_NOT_LINKED;
 302   data->removed = FALSE;
 303   g_object_set_qdata_full (G_OBJECT (srcpad), push_data, data, g_free);
 304
 305   GST_OBJECT_UNLOCK (tee);
 306
 307   switch (mode) {
 308     case GST_ACTIVATE_PULL:
 309       /* we already have a src pad in pull mode, and our pull mode can only be
 310          SINGLE, so fall through to activate this new pad in push mode */
 311     case GST_ACTIVATE_PUSH:
 312       res = gst_pad_activate_push (srcpad, TRUE);
 313       break;
 314     default:
 315       res = TRUE;
 316       break;
 317   }
 318
 319   if (!res)
 320     goto activate_failed;
 321
 322   gst_pad_set_setcaps_function (srcpad,
 323       GST_DEBUG_FUNCPTR (gst_pad_proxy_setcaps));
 324   gst_pad_set_getcaps_function (srcpad,
 325       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
 326   gst_pad_set_activatepull_function (srcpad,
 327       GST_DEBUG_FUNCPTR (gst_tee_src_activate_pull));
 328   gst_pad_set_checkgetrange_function (srcpad,
 329       GST_DEBUG_FUNCPTR (gst_tee_src_check_get_range));
 330   gst_pad_set_getrange_function (srcpad,
 331       GST_DEBUG_FUNCPTR (gst_tee_src_get_range));
 332   gst_element_add_pad (GST_ELEMENT_CAST (tee), srcpad);
 333
 334   return srcpad;
 335
 336   /* ERRORS */
 337 activate_failed:
 338   {
 339     gboolean changed = FALSE;
 340
 341     GST_OBJECT_LOCK (tee);
 342     GST_DEBUG_OBJECT (tee, "warning failed to activate request pad");
 343     if (tee->allocpad == srcpad) {
 344       tee->allocpad = NULL;
 345       changed = TRUE;
 346     }
 347     GST_OBJECT_UNLOCK (tee);
 348     gst_object_unref (srcpad);
 349     if (changed) {
 350       gst_tee_notify_alloc_pad (tee);
 351     }
 352     return NULL;
 353   }
 354 }
 355
 356 static void
 357 gst_tee_release_pad (GstElement * element, GstPad * pad)
 358 {
 359   GstTee *tee;
 360   PushData *data;
 361   gboolean changed = FALSE;
 362
 363   tee = GST_TEE (element);
 364
 365   GST_DEBUG_OBJECT (tee, "releasing pad");
 366
 367   /* wait for pending pad_alloc to finish */
 368   GST_TEE_DYN_LOCK (tee);
 369   data = g_object_get_qdata (G_OBJECT (pad), push_data);
 370
 371   GST_OBJECT_LOCK (tee);
 372   /* mark the pad as removed so that future pad_alloc fails with NOT_LINKED. */
 373   data->removed = TRUE;
 374   if (tee->allocpad == pad) {
 375     tee->allocpad = NULL;
 376     changed = TRUE;
 377   }
 378   GST_OBJECT_UNLOCK (tee);
 379
 380   gst_pad_set_active (pad, FALSE);
 381
 382   gst_element_remove_pad (GST_ELEMENT_CAST (tee), pad);
 383   GST_TEE_DYN_UNLOCK (tee);
 384
 385   if (changed) {
 386     gst_tee_notify_alloc_pad (tee);
 387   }
 388 }
 389
 390 static void
 391 gst_tee_set_property (GObject * object, guint prop_id, const GValue * value,
 392     GParamSpec * pspec)
 393 {
 394   GstTee *tee = GST_TEE (object);
 395
 396   GST_OBJECT_LOCK (tee);
 397   switch (prop_id) {
 398     case PROP_HAS_SINK_LOOP:
 399       tee->has_sink_loop = g_value_get_boolean (value);
 400       if (tee->has_sink_loop) {
 401         g_warning ("tee will never implement has-sink-loop==TRUE");
 402       }
 403       break;
 404     case PROP_HAS_CHAIN:
 405       tee->has_chain = g_value_get_boolean (value);
 406       break;
 407     case PROP_SILENT:
 408       tee->silent = g_value_get_boolean (value);
 409       break;
 410     case PROP_PULL_MODE:
 411       tee->pull_mode = g_value_get_enum (value);
 412       break;
 413     case PROP_ALLOC_PAD:
 414     {
 415       GstPad *pad = g_value_get_object (value);
 416       GST_OBJECT_LOCK (pad);
 417       if (GST_OBJECT_PARENT (pad) == GST_OBJECT_CAST (object))
 418         tee->allocpad = pad;
 419       else
 420         GST_WARNING_OBJECT (object, "Tried to set alloc pad %s which"
 421             " is not my pad", GST_OBJECT_NAME (pad));
 422       GST_OBJECT_UNLOCK (pad);
 423       break;
 424     }
 425     default:
 426       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 427       break;
 428   }
 429   GST_OBJECT_UNLOCK (tee);
 430 }
 431
 432 static void
 433 gst_tee_get_property (GObject * object, guint prop_id, GValue * value,
 434     GParamSpec * pspec)
 435 {
 436   GstTee *tee = GST_TEE (object);
 437
 438   GST_OBJECT_LOCK (tee);
 439   switch (prop_id) {
 440     case PROP_NUM_SRC_PADS:
 441       g_value_set_int (value, GST_ELEMENT (tee)->numsrcpads);
 442       break;
 443     case PROP_HAS_SINK_LOOP:
 444       g_value_set_boolean (value, tee->has_sink_loop);
 445       break;
 446     case PROP_HAS_CHAIN:
 447       g_value_set_boolean (value, tee->has_chain);
 448       break;
 449     case PROP_SILENT:
 450       g_value_set_boolean (value, tee->silent);
 451       break;
 452     case PROP_LAST_MESSAGE:
 453       g_value_set_string (value, tee->last_message);
 454       break;
 455     case PROP_PULL_MODE:
 456       g_value_set_enum (value, tee->pull_mode);
 457       break;
 458     case PROP_ALLOC_PAD:
 459       g_value_set_object (value, tee->allocpad);
 460       break;
 461     default:
 462       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 463       break;
 464   }
 465   GST_OBJECT_UNLOCK (tee);
 466 }
 467
 468 /* on the sink we accept caps that are acceptable to all srcpads */
 469 static gboolean
 470 gst_tee_sink_acceptcaps (GstPad * pad, GstCaps * caps)
 471 {
 472   GstTee *tee;
 473   gboolean res, done;
 474   GstIterator *it;
 475
 476   tee = GST_TEE_CAST (GST_PAD_PARENT (pad));
 477
 478   it = gst_element_iterate_src_pads (GST_ELEMENT_CAST (tee));
 479
 480   res = TRUE;
 481   done = FALSE;
 482   while (!done && res) {
 483     gpointer item;
 484
 485     switch (gst_iterator_next (it, &item)) {
 486       case GST_ITERATOR_OK:
 487         res &= gst_pad_peer_accept_caps (GST_PAD_CAST (item), caps);
 488         gst_object_unref (item);
 489         break;
 490       case GST_ITERATOR_RESYNC:
 491         res = TRUE;
 492         gst_iterator_resync (it);
 493         break;
 494       case GST_ITERATOR_ERROR:
 495         res = FALSE;
 496         done = TRUE;
 497         break;
 498       case GST_ITERATOR_DONE:
 499         done = TRUE;
 500         break;
 501     }
 502   }
 503   gst_iterator_free (it);
 504
 505   return res;
 506 }
 507
 508 static void
 509 gst_tee_do_message (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 510 {
 511   GST_OBJECT_LOCK (tee);
 512   g_free (tee->last_message);
 513   if (is_list) {
 514     tee->last_message =
 515         g_strdup_printf ("chain-list   ******* (%s:%s)t %p",
 516         GST_DEBUG_PAD_NAME (pad), data);
 517   } else {
 518     tee->last_message =
 519         g_strdup_printf ("chain        ******* (%s:%s)t (%" G_GSIZE_FORMAT
 520         " bytes, %" G_GUINT64_FORMAT ") %p", GST_DEBUG_PAD_NAME (pad),
 521         gst_buffer_get_size (data), GST_BUFFER_TIMESTAMP (data), data);
 522   }
 523   GST_OBJECT_UNLOCK (tee);
 524
 525 #if !GLIB_CHECK_VERSION(2,26,0)
 526   g_object_notify ((GObject *) tee, "last-message");
 527 #else
 528   g_object_notify_by_pspec ((GObject *) tee, pspec_last_message);
 529 #endif
 530 }
 531
 532 static GstFlowReturn
 533 gst_tee_do_push (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
 534 {
 535   GstFlowReturn res;
 536
 537   /* Push */
 538   if (pad == tee->pull_pad) {
 539     /* don't push on the pad we're pulling from */
 540     res = GST_FLOW_OK;
 541   } else if (is_list) {
 542     res =
 543         gst_pad_push_list (pad,
 544         gst_buffer_list_ref (GST_BUFFER_LIST_CAST (data)));
 545   } else {
 546     res = gst_pad_push (pad, gst_buffer_ref (GST_BUFFER_CAST (data)));
 547   }
 548   return res;
 549 }
 550
 551 static void
 552 clear_pads (GstPad * pad, GstTee * tee)
 553 {
 554   PushData *data;
 555
 556   data = g_object_get_qdata ((GObject *) pad, push_data);
 557
 558   /* the data must be there or we have a screwed up internal state */
 559   g_assert (data != NULL);
 560
 561   data->pushed = FALSE;
 562   data->result = GST_FLOW_NOT_LINKED;
 563 }
 564
 565 static GstFlowReturn
 566 gst_tee_handle_data (GstTee * tee, gpointer data, gboolean is_list)
 567 {
 568   GList *pads;
 569   guint32 cookie;
 570   GstFlowReturn ret, cret;
 571
 572   if (G_UNLIKELY (!tee->silent))
 573     gst_tee_do_message (tee, tee->sinkpad, data, is_list);
 574
 575   GST_OBJECT_LOCK (tee);
 576   pads = GST_ELEMENT_CAST (tee)->srcpads;
 577
 578   /* special case for zero pads */
 579   if (G_UNLIKELY (!pads))
 580     goto no_pads;
 581
 582   /* special case for just one pad that avoids reffing the buffer */
 583   if (!pads->next) {
 584     GstPad *pad = GST_PAD_CAST (pads->data);
 585
 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     return ret;
 596   }
 597
 598   /* mark all pads as 'not pushed on yet' */
 599   g_list_foreach (pads, (GFunc) clear_pads, tee);
 600
 601 restart:
 602   cret = GST_FLOW_NOT_LINKED;
 603   pads = GST_ELEMENT_CAST (tee)->srcpads;
 604   cookie = GST_ELEMENT_CAST (tee)->pads_cookie;
 605
 606   while (pads) {
 607     GstPad *pad;
 608     PushData *pdata;
 609
 610     pad = GST_PAD_CAST (pads->data);
 611
 612     /* get the private data, something is really wrong with the internal state
 613      * when it is not there */
 614     pdata = g_object_get_qdata ((GObject *) pad, push_data);
 615     g_assert (pdata != NULL);
 616
 617     if (G_LIKELY (!pdata->pushed)) {
 618       /* not yet pushed, release lock and start pushing */
 619       gst_object_ref (pad);
 620       GST_OBJECT_UNLOCK (tee);
 621
 622       GST_LOG_OBJECT (tee, "Starting to push %s %p",
 623           is_list ? "list" : "buffer", data);
 624
 625       ret = gst_tee_do_push (tee, pad, data, is_list);
 626
 627       GST_LOG_OBJECT (tee, "Pushing item %p yielded result %s", data,
 628           gst_flow_get_name (ret));
 629
 630       GST_OBJECT_LOCK (tee);
 631       /* keep track of which pad we pushed and the result value. We need to do
 632        * this before we release the refcount on the pad, the PushData is
 633        * destroyed when the last ref of the pad goes away. */
 634       pdata->pushed = TRUE;
 635       pdata->result = ret;
 636       gst_object_unref (pad);
 637     } else {
 638       /* already pushed, use previous return value */
 639       ret = pdata->result;
 640       GST_LOG_OBJECT (tee, "pad already pushed with %s",
 641           gst_flow_get_name (ret));
 642     }
 643
 644     /* before we go combining the return value, check if the pad list is still
 645      * the same. It could be possible that the pad we just pushed was removed
 646      * and the return value it not valid anymore */
 647     if (G_UNLIKELY (GST_ELEMENT_CAST (tee)->pads_cookie != cookie)) {
 648       GST_LOG_OBJECT (tee, "pad list changed");
 649       /* the list of pads changed, restart iteration. Pads that we already
 650        * pushed on and are still in the new list, will not be pushed on
 651        * again. */
 652       goto restart;
 653     }
 654
 655     /* stop pushing more buffers when we have a fatal error */
 656     if (G_UNLIKELY (ret != GST_FLOW_OK && ret != GST_FLOW_NOT_LINKED))
 657       goto error;
 658
 659     /* keep all other return values, overwriting the previous one. */
 660     if (G_LIKELY (ret != GST_FLOW_NOT_LINKED)) {
 661       GST_LOG_OBJECT (tee, "Replacing ret val %d with %d", cret, ret);
 662       cret = ret;
 663     }
 664     pads = g_list_next (pads);
 665   }
 666   GST_OBJECT_UNLOCK (tee);
 667
 668   gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 669
 670   /* no need to unset gvalue */
 671   return cret;
 672
 673   /* ERRORS */
 674 no_pads:
 675   {
 676     GST_DEBUG_OBJECT (tee, "there are no pads, return not-linked");
 677     ret = GST_FLOW_NOT_LINKED;
 678     goto error;
 679   }
 680 error:
 681   {
 682     GST_DEBUG_OBJECT (tee, "received error %s", gst_flow_get_name (ret));
 683     GST_OBJECT_UNLOCK (tee);
 684     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
 685     return ret;
 686   }
 687 }
 688
 689 static GstFlowReturn
 690 gst_tee_chain (GstPad * pad, GstBuffer * buffer)
 691 {
 692   GstFlowReturn res;
 693   GstTee *tee;
 694
 695   tee = GST_TEE_CAST (GST_OBJECT_PARENT (pad));
 696
 697   GST_DEBUG_OBJECT (tee, "received buffer %p", buffer);
 698
 699   res = gst_tee_handle_data (tee, buffer, FALSE);
 700
 701   GST_DEBUG_OBJECT (tee, "handled buffer %s", gst_flow_get_name (res));
 702
 703   return res;
 704 }
 705
 706 static GstFlowReturn
 707 gst_tee_chain_list (GstPad * pad, GstBufferList * list)
 708 {
 709   GstFlowReturn res;
 710   GstTee *tee;
 711
 712   tee = GST_TEE_CAST (gst_pad_get_parent (pad));
 713
 714   GST_DEBUG_OBJECT (tee, "received list %p", list);
 715
 716   res = gst_tee_handle_data (tee, list, TRUE);
 717
 718   GST_DEBUG_OBJECT (tee, "handled list %s", gst_flow_get_name (res));
 719
 720   gst_object_unref (tee);
 721
 722   return res;
 723 }
 724
 725 static gboolean
 726 gst_tee_sink_activate_push (GstPad * pad, gboolean active)
 727 {
 728   GstTee *tee;
 729
 730   tee = GST_TEE (GST_OBJECT_PARENT (pad));
 731
 732   GST_OBJECT_LOCK (tee);
 733   tee->sink_mode = active && GST_ACTIVATE_PUSH;
 734
 735   if (active && !tee->has_chain)
 736     goto no_chain;
 737   GST_OBJECT_UNLOCK (tee);
 738
 739   return TRUE;
 740
 741   /* ERRORS */
 742 no_chain:
 743   {
 744     GST_OBJECT_UNLOCK (tee);
 745     GST_INFO_OBJECT (tee,
 746         "Tee cannot operate in push mode with has-chain==FALSE");
 747     return FALSE;
 748   }
 749 }
 750
 751 static gboolean
 752 gst_tee_src_activate_pull (GstPad * pad, gboolean active)
 753 {
 754   GstTee *tee;
 755   gboolean res;
 756   GstPad *sinkpad;
 757
 758   tee = GST_TEE (gst_pad_get_parent (pad));
 759
 760   GST_OBJECT_LOCK (tee);
 761
 762   if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
 763     goto cannot_pull;
 764
 765   if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && active && tee->pull_pad)
 766     goto cannot_pull_multiple_srcs;
 767
 768   sinkpad = gst_object_ref (tee->sinkpad);
 769
 770   GST_OBJECT_UNLOCK (tee);
 771
 772   res = gst_pad_activate_pull (sinkpad, active);
 773   gst_object_unref (sinkpad);
 774
 775   if (!res)
 776     goto sink_activate_failed;
 777
 778   GST_OBJECT_LOCK (tee);
 779   if (active) {
 780     if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE)
 781       tee->pull_pad = pad;
 782   } else {
 783     if (pad == tee->pull_pad)
 784       tee->pull_pad = NULL;
 785   }
 786   tee->sink_mode = active && GST_ACTIVATE_PULL;
 787   GST_OBJECT_UNLOCK (tee);
 788
 789   gst_object_unref (tee);
 790
 791   return res;
 792
 793   /* ERRORS */
 794 cannot_pull:
 795   {
 796     GST_OBJECT_UNLOCK (tee);
 797     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 798         "set to NEVER");
 799     gst_object_unref (tee);
 800     return FALSE;
 801   }
 802 cannot_pull_multiple_srcs:
 803   {
 804     GST_OBJECT_UNLOCK (tee);
 805     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 806         "pull-mode set to SINGLE");
 807     gst_object_unref (tee);
 808     return FALSE;
 809   }
 810 sink_activate_failed:
 811   {
 812     GST_INFO_OBJECT (tee, "Failed to %sactivate sink pad in pull mode",
 813         active ? "" : "de");
 814     gst_object_unref (tee);
 815     return FALSE;
 816   }
 817 }
 818
 819 static gboolean
 820 gst_tee_src_check_get_range (GstPad * pad)
 821 {
 822   GstTee *tee;
 823   gboolean res;
 824   GstPad *sinkpad;
 825
 826   tee = GST_TEE (gst_pad_get_parent (pad));
 827
 828   GST_OBJECT_LOCK (tee);
 829
 830   if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
 831     goto cannot_pull;
 832
 833   if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && tee->pull_pad)
 834     goto cannot_pull_multiple_srcs;
 835
 836   sinkpad = gst_object_ref (tee->sinkpad);
 837
 838   GST_OBJECT_UNLOCK (tee);
 839
 840   res = gst_pad_check_pull_range (sinkpad);
 841   gst_object_unref (sinkpad);
 842
 843   gst_object_unref (tee);
 844
 845   return res;
 846
 847   /* ERRORS */
 848 cannot_pull:
 849   {
 850     GST_OBJECT_UNLOCK (tee);
 851     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
 852         "set to NEVER");
 853     gst_object_unref (tee);
 854     return FALSE;
 855   }
 856 cannot_pull_multiple_srcs:
 857   {
 858     GST_OBJECT_UNLOCK (tee);
 859     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
 860         "pull-mode set to SINGLE");
 861     gst_object_unref (tee);
 862     return FALSE;
 863   }
 864 }
 865
 866 static void
 867 gst_tee_push_eos (GstPad * pad, GstTee * tee)
 868 {
 869   if (pad != tee->pull_pad)
 870     gst_pad_push_event (pad, gst_event_new_eos ());
 871   gst_object_unref (pad);
 872 }
 873
 874 static void
 875 gst_tee_pull_eos (GstTee * tee)
 876 {
 877   GstIterator *iter;
 878
 879   iter = gst_element_iterate_src_pads (GST_ELEMENT (tee));
 880   gst_iterator_foreach (iter, (GFunc) gst_tee_push_eos, tee);
 881   gst_iterator_free (iter);
 882 }
 883
 884 static GstFlowReturn
 885 gst_tee_src_get_range (GstPad * pad, guint64 offset, guint length,
 886     GstBuffer ** buf)
 887 {
 888   GstTee *tee;
 889   GstFlowReturn ret;
 890
 891   tee = GST_TEE (gst_pad_get_parent (pad));
 892
 893   ret = gst_pad_pull_range (tee->sinkpad, offset, length, buf);
 894
 895   if (ret == GST_FLOW_OK)
 896     ret = gst_tee_handle_data (tee, gst_buffer_ref (*buf), FALSE);
 897   else if (ret == GST_FLOW_UNEXPECTED)
 898     gst_tee_pull_eos (tee);
 899
 900   gst_object_unref (tee);
 901
 902   return ret;
 903 }