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