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