tee: Forward sticky events to newly created srcpads
[platform/upstream/gstreamer.git] / 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, const GstCaps * caps);
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 GstFlowReturn
275 forward_sticky_events (GstPad * pad, GstEvent * event, gpointer user_data)
276 {
277   GstPad *srcpad = GST_PAD_CAST (user_data);
278
279   gst_pad_push_event (srcpad, gst_event_ref (event));
280
281   return GST_FLOW_OK;
282 }
283
284 static GstPad *
285 gst_tee_request_new_pad (GstElement * element, GstPadTemplate * templ,
286     const gchar * unused, const GstCaps * caps)
287 {
288   gchar *name;
289   GstPad *srcpad;
290   GstTee *tee;
291   GstActivateMode mode;
292   gboolean res;
293   PushData *data;
294
295   tee = GST_TEE (element);
296
297   GST_DEBUG_OBJECT (tee, "requesting pad");
298
299   GST_OBJECT_LOCK (tee);
300   name = g_strdup_printf ("src%d", tee->pad_counter++);
301
302   srcpad = gst_pad_new_from_template (templ, name);
303   g_free (name);
304
305   mode = tee->sink_mode;
306
307   /* install the data, we automatically free it when the pad is disposed because
308    * of _release_pad or when the element goes away. */
309   data = g_new0 (PushData, 1);
310   data->pushed = FALSE;
311   data->result = GST_FLOW_NOT_LINKED;
312   data->removed = FALSE;
313   g_object_set_qdata_full (G_OBJECT (srcpad), push_data, data, g_free);
314
315   GST_OBJECT_UNLOCK (tee);
316
317   switch (mode) {
318     case GST_ACTIVATE_PULL:
319       /* we already have a src pad in pull mode, and our pull mode can only be
320          SINGLE, so fall through to activate this new pad in push mode */
321     case GST_ACTIVATE_PUSH:
322       res = gst_pad_activate_push (srcpad, TRUE);
323       break;
324     default:
325       res = TRUE;
326       break;
327   }
328
329   if (!res)
330     goto activate_failed;
331
332   gst_pad_set_getcaps_function (srcpad,
333       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
334   gst_pad_set_activatepull_function (srcpad,
335       GST_DEBUG_FUNCPTR (gst_tee_src_activate_pull));
336   gst_pad_set_checkgetrange_function (srcpad,
337       GST_DEBUG_FUNCPTR (gst_tee_src_check_get_range));
338   gst_pad_set_getrange_function (srcpad,
339       GST_DEBUG_FUNCPTR (gst_tee_src_get_range));
340   /* Forward sticky events to the new srcpad */
341   gst_pad_sticky_events_foreach (tee->sinkpad, forward_sticky_events, srcpad);
342   gst_element_add_pad (GST_ELEMENT_CAST (tee), srcpad);
343
344   return srcpad;
345
346   /* ERRORS */
347 activate_failed:
348   {
349     gboolean changed = FALSE;
350
351     GST_OBJECT_LOCK (tee);
352     GST_DEBUG_OBJECT (tee, "warning failed to activate request pad");
353     if (tee->allocpad == srcpad) {
354       tee->allocpad = NULL;
355       changed = TRUE;
356     }
357     GST_OBJECT_UNLOCK (tee);
358     gst_object_unref (srcpad);
359     if (changed) {
360       gst_tee_notify_alloc_pad (tee);
361     }
362     return NULL;
363   }
364 }
365
366 static void
367 gst_tee_release_pad (GstElement * element, GstPad * pad)
368 {
369   GstTee *tee;
370   PushData *data;
371   gboolean changed = FALSE;
372
373   tee = GST_TEE (element);
374
375   GST_DEBUG_OBJECT (tee, "releasing pad");
376
377   /* wait for pending pad_alloc to finish */
378   GST_TEE_DYN_LOCK (tee);
379   data = g_object_get_qdata (G_OBJECT (pad), push_data);
380
381   GST_OBJECT_LOCK (tee);
382   /* mark the pad as removed so that future pad_alloc fails with NOT_LINKED. */
383   data->removed = TRUE;
384   if (tee->allocpad == pad) {
385     tee->allocpad = NULL;
386     changed = TRUE;
387   }
388   GST_OBJECT_UNLOCK (tee);
389
390   gst_pad_set_active (pad, FALSE);
391
392   gst_element_remove_pad (GST_ELEMENT_CAST (tee), pad);
393   GST_TEE_DYN_UNLOCK (tee);
394
395   if (changed) {
396     gst_tee_notify_alloc_pad (tee);
397   }
398 }
399
400 static void
401 gst_tee_set_property (GObject * object, guint prop_id, const GValue * value,
402     GParamSpec * pspec)
403 {
404   GstTee *tee = GST_TEE (object);
405
406   GST_OBJECT_LOCK (tee);
407   switch (prop_id) {
408     case PROP_HAS_SINK_LOOP:
409       tee->has_sink_loop = g_value_get_boolean (value);
410       if (tee->has_sink_loop) {
411         g_warning ("tee will never implement has-sink-loop==TRUE");
412       }
413       break;
414     case PROP_HAS_CHAIN:
415       tee->has_chain = g_value_get_boolean (value);
416       break;
417     case PROP_SILENT:
418       tee->silent = g_value_get_boolean (value);
419       break;
420     case PROP_PULL_MODE:
421       tee->pull_mode = g_value_get_enum (value);
422       break;
423     case PROP_ALLOC_PAD:
424     {
425       GstPad *pad = g_value_get_object (value);
426       GST_OBJECT_LOCK (pad);
427       if (GST_OBJECT_PARENT (pad) == GST_OBJECT_CAST (object))
428         tee->allocpad = pad;
429       else
430         GST_WARNING_OBJECT (object, "Tried to set alloc pad %s which"
431             " is not my pad", GST_OBJECT_NAME (pad));
432       GST_OBJECT_UNLOCK (pad);
433       break;
434     }
435     default:
436       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
437       break;
438   }
439   GST_OBJECT_UNLOCK (tee);
440 }
441
442 static void
443 gst_tee_get_property (GObject * object, guint prop_id, GValue * value,
444     GParamSpec * pspec)
445 {
446   GstTee *tee = GST_TEE (object);
447
448   GST_OBJECT_LOCK (tee);
449   switch (prop_id) {
450     case PROP_NUM_SRC_PADS:
451       g_value_set_int (value, GST_ELEMENT (tee)->numsrcpads);
452       break;
453     case PROP_HAS_SINK_LOOP:
454       g_value_set_boolean (value, tee->has_sink_loop);
455       break;
456     case PROP_HAS_CHAIN:
457       g_value_set_boolean (value, tee->has_chain);
458       break;
459     case PROP_SILENT:
460       g_value_set_boolean (value, tee->silent);
461       break;
462     case PROP_LAST_MESSAGE:
463       g_value_set_string (value, tee->last_message);
464       break;
465     case PROP_PULL_MODE:
466       g_value_set_enum (value, tee->pull_mode);
467       break;
468     case PROP_ALLOC_PAD:
469       g_value_set_object (value, tee->allocpad);
470       break;
471     default:
472       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
473       break;
474   }
475   GST_OBJECT_UNLOCK (tee);
476 }
477
478 /* on the sink we accept caps that are acceptable to all srcpads */
479 static gboolean
480 gst_tee_sink_acceptcaps (GstPad * pad, GstCaps * caps)
481 {
482   GstTee *tee;
483   gboolean res, done;
484   GstIterator *it;
485   GValue item = { 0, };
486
487   tee = GST_TEE_CAST (GST_PAD_PARENT (pad));
488
489   it = gst_element_iterate_src_pads (GST_ELEMENT_CAST (tee));
490
491   res = TRUE;
492   done = FALSE;
493   while (!done && res) {
494     switch (gst_iterator_next (it, &item)) {
495       case GST_ITERATOR_OK:
496         res &= gst_pad_peer_accept_caps (g_value_get_object (&item), caps);
497         g_value_reset (&item);
498         break;
499       case GST_ITERATOR_RESYNC:
500         res = TRUE;
501         gst_iterator_resync (it);
502         break;
503       case GST_ITERATOR_ERROR:
504         res = FALSE;
505         done = TRUE;
506         break;
507       case GST_ITERATOR_DONE:
508         done = TRUE;
509         break;
510     }
511   }
512   g_value_unset (&item);
513   gst_iterator_free (it);
514
515   return res;
516 }
517
518 static void
519 gst_tee_do_message (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
520 {
521   GST_OBJECT_LOCK (tee);
522   g_free (tee->last_message);
523   if (is_list) {
524     tee->last_message =
525         g_strdup_printf ("chain-list   ******* (%s:%s)t %p",
526         GST_DEBUG_PAD_NAME (pad), data);
527   } else {
528     tee->last_message =
529         g_strdup_printf ("chain        ******* (%s:%s)t (%" G_GSIZE_FORMAT
530         " bytes, %" G_GUINT64_FORMAT ") %p", GST_DEBUG_PAD_NAME (pad),
531         gst_buffer_get_size (data), GST_BUFFER_TIMESTAMP (data), data);
532   }
533   GST_OBJECT_UNLOCK (tee);
534
535 #if !GLIB_CHECK_VERSION(2,26,0)
536   g_object_notify ((GObject *) tee, "last-message");
537 #else
538   g_object_notify_by_pspec ((GObject *) tee, pspec_last_message);
539 #endif
540 }
541
542 static GstFlowReturn
543 gst_tee_do_push (GstTee * tee, GstPad * pad, gpointer data, gboolean is_list)
544 {
545   GstFlowReturn res;
546
547   /* Push */
548   if (pad == tee->pull_pad) {
549     /* don't push on the pad we're pulling from */
550     res = GST_FLOW_OK;
551   } else if (is_list) {
552     res =
553         gst_pad_push_list (pad,
554         gst_buffer_list_ref (GST_BUFFER_LIST_CAST (data)));
555   } else {
556     res = gst_pad_push (pad, gst_buffer_ref (GST_BUFFER_CAST (data)));
557   }
558   return res;
559 }
560
561 static void
562 clear_pads (GstPad * pad, GstTee * tee)
563 {
564   PushData *data;
565
566   data = g_object_get_qdata ((GObject *) pad, push_data);
567
568   /* the data must be there or we have a screwed up internal state */
569   g_assert (data != NULL);
570
571   data->pushed = FALSE;
572   data->result = GST_FLOW_NOT_LINKED;
573 }
574
575 static GstFlowReturn
576 gst_tee_handle_data (GstTee * tee, gpointer data, gboolean is_list)
577 {
578   GList *pads;
579   guint32 cookie;
580   GstFlowReturn ret, cret;
581
582   if (G_UNLIKELY (!tee->silent))
583     gst_tee_do_message (tee, tee->sinkpad, data, is_list);
584
585   GST_OBJECT_LOCK (tee);
586   pads = GST_ELEMENT_CAST (tee)->srcpads;
587
588   /* special case for zero pads */
589   if (G_UNLIKELY (!pads))
590     goto no_pads;
591
592   /* special case for just one pad that avoids reffing the buffer */
593   if (!pads->next) {
594     GstPad *pad = GST_PAD_CAST (pads->data);
595
596     GST_OBJECT_UNLOCK (tee);
597
598     if (pad == tee->pull_pad) {
599       ret = GST_FLOW_OK;
600     } else if (is_list) {
601       ret = gst_pad_push_list (pad, GST_BUFFER_LIST_CAST (data));
602     } else {
603       ret = gst_pad_push (pad, GST_BUFFER_CAST (data));
604     }
605     return ret;
606   }
607
608   /* mark all pads as 'not pushed on yet' */
609   g_list_foreach (pads, (GFunc) clear_pads, tee);
610
611 restart:
612   cret = GST_FLOW_NOT_LINKED;
613   pads = GST_ELEMENT_CAST (tee)->srcpads;
614   cookie = GST_ELEMENT_CAST (tee)->pads_cookie;
615
616   while (pads) {
617     GstPad *pad;
618     PushData *pdata;
619
620     pad = GST_PAD_CAST (pads->data);
621
622     /* get the private data, something is really wrong with the internal state
623      * when it is not there */
624     pdata = g_object_get_qdata ((GObject *) pad, push_data);
625     g_assert (pdata != NULL);
626
627     if (G_LIKELY (!pdata->pushed)) {
628       /* not yet pushed, release lock and start pushing */
629       gst_object_ref (pad);
630       GST_OBJECT_UNLOCK (tee);
631
632       GST_LOG_OBJECT (tee, "Starting to push %s %p",
633           is_list ? "list" : "buffer", data);
634
635       ret = gst_tee_do_push (tee, pad, data, is_list);
636
637       GST_LOG_OBJECT (tee, "Pushing item %p yielded result %s", data,
638           gst_flow_get_name (ret));
639
640       GST_OBJECT_LOCK (tee);
641       /* keep track of which pad we pushed and the result value. We need to do
642        * this before we release the refcount on the pad, the PushData is
643        * destroyed when the last ref of the pad goes away. */
644       pdata->pushed = TRUE;
645       pdata->result = ret;
646       gst_object_unref (pad);
647     } else {
648       /* already pushed, use previous return value */
649       ret = pdata->result;
650       GST_LOG_OBJECT (tee, "pad already pushed with %s",
651           gst_flow_get_name (ret));
652     }
653
654     /* before we go combining the return value, check if the pad list is still
655      * the same. It could be possible that the pad we just pushed was removed
656      * and the return value it not valid anymore */
657     if (G_UNLIKELY (GST_ELEMENT_CAST (tee)->pads_cookie != cookie)) {
658       GST_LOG_OBJECT (tee, "pad list changed");
659       /* the list of pads changed, restart iteration. Pads that we already
660        * pushed on and are still in the new list, will not be pushed on
661        * again. */
662       goto restart;
663     }
664
665     /* stop pushing more buffers when we have a fatal error */
666     if (G_UNLIKELY (ret != GST_FLOW_OK && ret != GST_FLOW_NOT_LINKED))
667       goto error;
668
669     /* keep all other return values, overwriting the previous one. */
670     if (G_LIKELY (ret != GST_FLOW_NOT_LINKED)) {
671       GST_LOG_OBJECT (tee, "Replacing ret val %d with %d", cret, ret);
672       cret = ret;
673     }
674     pads = g_list_next (pads);
675   }
676   GST_OBJECT_UNLOCK (tee);
677
678   gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
679
680   /* no need to unset gvalue */
681   return cret;
682
683   /* ERRORS */
684 no_pads:
685   {
686     GST_DEBUG_OBJECT (tee, "there are no pads, return not-linked");
687     ret = GST_FLOW_NOT_LINKED;
688     goto error;
689   }
690 error:
691   {
692     GST_DEBUG_OBJECT (tee, "received error %s", gst_flow_get_name (ret));
693     GST_OBJECT_UNLOCK (tee);
694     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
695     return ret;
696   }
697 }
698
699 static GstFlowReturn
700 gst_tee_chain (GstPad * pad, GstBuffer * buffer)
701 {
702   GstFlowReturn res;
703   GstTee *tee;
704
705   tee = GST_TEE_CAST (GST_OBJECT_PARENT (pad));
706
707   GST_DEBUG_OBJECT (tee, "received buffer %p", buffer);
708
709   res = gst_tee_handle_data (tee, buffer, FALSE);
710
711   GST_DEBUG_OBJECT (tee, "handled buffer %s", gst_flow_get_name (res));
712
713   return res;
714 }
715
716 static GstFlowReturn
717 gst_tee_chain_list (GstPad * pad, GstBufferList * list)
718 {
719   GstFlowReturn res;
720   GstTee *tee;
721
722   tee = GST_TEE_CAST (gst_pad_get_parent (pad));
723
724   GST_DEBUG_OBJECT (tee, "received list %p", list);
725
726   res = gst_tee_handle_data (tee, list, TRUE);
727
728   GST_DEBUG_OBJECT (tee, "handled list %s", gst_flow_get_name (res));
729
730   gst_object_unref (tee);
731
732   return res;
733 }
734
735 static gboolean
736 gst_tee_sink_activate_push (GstPad * pad, gboolean active)
737 {
738   GstTee *tee;
739
740   tee = GST_TEE (GST_OBJECT_PARENT (pad));
741
742   GST_OBJECT_LOCK (tee);
743   tee->sink_mode = active && GST_ACTIVATE_PUSH;
744
745   if (active && !tee->has_chain)
746     goto no_chain;
747   GST_OBJECT_UNLOCK (tee);
748
749   return TRUE;
750
751   /* ERRORS */
752 no_chain:
753   {
754     GST_OBJECT_UNLOCK (tee);
755     GST_INFO_OBJECT (tee,
756         "Tee cannot operate in push mode with has-chain==FALSE");
757     return FALSE;
758   }
759 }
760
761 static gboolean
762 gst_tee_src_activate_pull (GstPad * pad, gboolean active)
763 {
764   GstTee *tee;
765   gboolean res;
766   GstPad *sinkpad;
767
768   tee = GST_TEE (gst_pad_get_parent (pad));
769
770   GST_OBJECT_LOCK (tee);
771
772   if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
773     goto cannot_pull;
774
775   if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && active && tee->pull_pad)
776     goto cannot_pull_multiple_srcs;
777
778   sinkpad = gst_object_ref (tee->sinkpad);
779
780   GST_OBJECT_UNLOCK (tee);
781
782   res = gst_pad_activate_pull (sinkpad, active);
783   gst_object_unref (sinkpad);
784
785   if (!res)
786     goto sink_activate_failed;
787
788   GST_OBJECT_LOCK (tee);
789   if (active) {
790     if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE)
791       tee->pull_pad = pad;
792   } else {
793     if (pad == tee->pull_pad)
794       tee->pull_pad = NULL;
795   }
796   tee->sink_mode = active && GST_ACTIVATE_PULL;
797   GST_OBJECT_UNLOCK (tee);
798
799   gst_object_unref (tee);
800
801   return res;
802
803   /* ERRORS */
804 cannot_pull:
805   {
806     GST_OBJECT_UNLOCK (tee);
807     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
808         "set to NEVER");
809     gst_object_unref (tee);
810     return FALSE;
811   }
812 cannot_pull_multiple_srcs:
813   {
814     GST_OBJECT_UNLOCK (tee);
815     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
816         "pull-mode set to SINGLE");
817     gst_object_unref (tee);
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     gst_object_unref (tee);
825     return FALSE;
826   }
827 }
828
829 static gboolean
830 gst_tee_src_check_get_range (GstPad * pad)
831 {
832   GstTee *tee;
833   gboolean res;
834   GstPad *sinkpad;
835
836   tee = GST_TEE (gst_pad_get_parent (pad));
837
838   GST_OBJECT_LOCK (tee);
839
840   if (tee->pull_mode == GST_TEE_PULL_MODE_NEVER)
841     goto cannot_pull;
842
843   if (tee->pull_mode == GST_TEE_PULL_MODE_SINGLE && tee->pull_pad)
844     goto cannot_pull_multiple_srcs;
845
846   sinkpad = gst_object_ref (tee->sinkpad);
847
848   GST_OBJECT_UNLOCK (tee);
849
850   res = gst_pad_check_pull_range (sinkpad);
851   gst_object_unref (sinkpad);
852
853   gst_object_unref (tee);
854
855   return res;
856
857   /* ERRORS */
858 cannot_pull:
859   {
860     GST_OBJECT_UNLOCK (tee);
861     GST_INFO_OBJECT (tee, "Cannot activate in pull mode, pull-mode "
862         "set to NEVER");
863     gst_object_unref (tee);
864     return FALSE;
865   }
866 cannot_pull_multiple_srcs:
867   {
868     GST_OBJECT_UNLOCK (tee);
869     GST_INFO_OBJECT (tee, "Cannot activate multiple src pads in pull mode, "
870         "pull-mode set to SINGLE");
871     gst_object_unref (tee);
872     return FALSE;
873   }
874 }
875
876 static void
877 gst_tee_push_eos (const GValue * vpad, GstTee * tee)
878 {
879   GstPad *pad = g_value_get_object (vpad);
880
881   if (pad != tee->pull_pad)
882     gst_pad_push_event (pad, gst_event_new_eos ());
883 }
884
885 static void
886 gst_tee_pull_eos (GstTee * tee)
887 {
888   GstIterator *iter;
889
890   iter = gst_element_iterate_src_pads (GST_ELEMENT (tee));
891   gst_iterator_foreach (iter, (GstIteratorForeachFunction) gst_tee_push_eos,
892       tee);
893   gst_iterator_free (iter);
894 }
895
896 static GstFlowReturn
897 gst_tee_src_get_range (GstPad * pad, guint64 offset, guint length,
898     GstBuffer ** buf)
899 {
900   GstTee *tee;
901   GstFlowReturn ret;
902
903   tee = GST_TEE (gst_pad_get_parent (pad));
904
905   ret = gst_pad_pull_range (tee->sinkpad, offset, length, buf);
906
907   if (ret == GST_FLOW_OK)
908     ret = gst_tee_handle_data (tee, gst_buffer_ref (*buf), FALSE);
909   else if (ret == GST_FLOW_UNEXPECTED)
910     gst_tee_pull_eos (tee);
911
912   gst_object_unref (tee);
913
914   return ret;
915 }