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