inputselector: No need to broadcast the signal in flush-stop
[platform/upstream/gstreamer.git] / plugins / elements / gstinputselector.c
1 /* GStreamer input selector
2  * Copyright (C) 2003 Julien Moutte <julien@moutte.net>
3  * Copyright (C) 2005 Ronald S. Bultje <rbultje@ronald.bitfreak.net>
4  * Copyright (C) 2005 Jan Schmidt <thaytan@mad.scientist.com>
5  * Copyright (C) 2007 Wim Taymans <wim.taymans@gmail.com>
6  * Copyright (C) 2007 Andy Wingo <wingo@pobox.com>
7  * Copyright (C) 2008 Nokia Corporation. (contact <stefan.kost@nokia.com>)
8  * Copyright (C) 2011 Sebastian Dröge <sebastian.droege@collabora.co.uk>
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public
21  * License along with this library; if not, write to the
22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23  * Boston, MA 02111-1307, USA.
24  */
25
26 /**
27  * SECTION:element-input-selector
28  * @see_also: #GstOutputSelector
29  *
30  * Direct one out of N input streams to the output pad.
31  *
32  * The input pads are from a GstPad subclass and have additional
33  * properties, which users may find useful, namely:
34  *
35  * <itemizedlist>
36  * <listitem>
37  * "running-time": Running time of stream on pad (#gint64)
38  * </listitem>
39  * <listitem>
40  * "tags": The currently active tags on the pad (#GstTagList, boxed type)
41  * </listitem>
42  * <listitem>
43  * "active": If the pad is currently active (#gboolean)
44  * </listitem>
45  * <listitem>
46  * "always-ok" : Make an inactive pads return #GST_FLOW_OK instead of
47  * #GST_FLOW_NOT_LINKED
48  * </listitem>
49  * </itemizedlist>
50  *
51  * Since: 0.10.32
52  */
53
54 #ifdef HAVE_CONFIG_H
55 #include "config.h"
56 #endif
57
58 #include <string.h>
59
60 #include "gstinputselector.h"
61
62 #include "gst/glib-compat-private.h"
63
64 #define DEBUG_CACHED_BUFFERS 0
65
66 GST_DEBUG_CATEGORY_STATIC (input_selector_debug);
67 #define GST_CAT_DEFAULT input_selector_debug
68
69 #define GST_TYPE_INPUT_SELECTOR_SYNC_MODE (gst_input_selector_sync_mode_get_type())
70 static GType
71 gst_input_selector_sync_mode_get_type (void)
72 {
73   static GType type = 0;
74   static const GEnumValue data[] = {
75     {GST_INPUT_SELECTOR_SYNC_MODE_ACTIVE_SEGMENT,
76           "Sync using the current active segment",
77         "active-segment"},
78     {GST_INPUT_SELECTOR_SYNC_MODE_CLOCK, "Sync using the clock", "clock"},
79     {0, NULL, NULL},
80   };
81
82   if (!type) {
83     type = g_enum_register_static ("GstInputSelectorSyncMode", data);
84   }
85   return type;
86 }
87
88 #if GLIB_CHECK_VERSION(2, 26, 0)
89 #define NOTIFY_MUTEX_LOCK()
90 #define NOTIFY_MUTEX_UNLOCK()
91 #else
92 static GStaticRecMutex notify_mutex = G_STATIC_REC_MUTEX_INIT;
93 #define NOTIFY_MUTEX_LOCK() g_static_rec_mutex_lock (&notify_mutex)
94 #define NOTIFY_MUTEX_UNLOCK() g_static_rec_mutex_unlock (&notify_mutex)
95 #endif
96
97 #define GST_INPUT_SELECTOR_GET_LOCK(sel) (&((GstInputSelector*)(sel))->lock)
98 #define GST_INPUT_SELECTOR_GET_COND(sel) (&((GstInputSelector*)(sel))->cond)
99 #define GST_INPUT_SELECTOR_LOCK(sel) (g_mutex_lock (GST_INPUT_SELECTOR_GET_LOCK(sel)))
100 #define GST_INPUT_SELECTOR_UNLOCK(sel) (g_mutex_unlock (GST_INPUT_SELECTOR_GET_LOCK(sel)))
101 #define GST_INPUT_SELECTOR_WAIT(sel) (g_cond_wait (GST_INPUT_SELECTOR_GET_COND(sel), \
102                         GST_INPUT_SELECTOR_GET_LOCK(sel)))
103 #define GST_INPUT_SELECTOR_BROADCAST(sel) (g_cond_broadcast (GST_INPUT_SELECTOR_GET_COND(sel)))
104
105 static GstStaticPadTemplate gst_input_selector_sink_factory =
106 GST_STATIC_PAD_TEMPLATE ("sink_%u",
107     GST_PAD_SINK,
108     GST_PAD_REQUEST,
109     GST_STATIC_CAPS_ANY);
110
111 static GstStaticPadTemplate gst_input_selector_src_factory =
112 GST_STATIC_PAD_TEMPLATE ("src",
113     GST_PAD_SRC,
114     GST_PAD_ALWAYS,
115     GST_STATIC_CAPS_ANY);
116
117 enum
118 {
119   PROP_0,
120   PROP_N_PADS,
121   PROP_ACTIVE_PAD,
122   PROP_SYNC_STREAMS,
123   PROP_SYNC_MODE,
124   PROP_CACHE_BUFFERS
125 };
126
127 #define DEFAULT_SYNC_STREAMS TRUE
128 #define DEFAULT_SYNC_MODE GST_INPUT_SELECTOR_SYNC_MODE_ACTIVE_SEGMENT
129 #define DEFAULT_CACHE_BUFFERS FALSE
130 #define DEFAULT_PAD_ALWAYS_OK TRUE
131
132 enum
133 {
134   PROP_PAD_0,
135   PROP_PAD_RUNNING_TIME,
136   PROP_PAD_TAGS,
137   PROP_PAD_ACTIVE,
138   PROP_PAD_ALWAYS_OK
139 };
140
141 enum
142 {
143   /* methods */
144   SIGNAL_BLOCK,
145   SIGNAL_SWITCH,
146   LAST_SIGNAL
147 };
148 static guint gst_input_selector_signals[LAST_SIGNAL] = { 0 };
149
150 static void gst_input_selector_active_pad_changed (GstInputSelector * sel,
151     GParamSpec * pspec, gpointer user_data);
152 static inline gboolean gst_input_selector_is_active_sinkpad (GstInputSelector *
153     sel, GstPad * pad);
154 static GstPad *gst_input_selector_activate_sinkpad (GstInputSelector * sel,
155     GstPad * pad);
156 static GstPad *gst_input_selector_get_linked_pad (GstInputSelector * sel,
157     GstPad * pad, gboolean strict);
158
159 #define GST_TYPE_SELECTOR_PAD \
160   (gst_selector_pad_get_type())
161 #define GST_SELECTOR_PAD(obj) \
162   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_SELECTOR_PAD, GstSelectorPad))
163 #define GST_SELECTOR_PAD_CLASS(klass) \
164   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_SELECTOR_PAD, GstSelectorPadClass))
165 #define GST_IS_SELECTOR_PAD(obj) \
166   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_SELECTOR_PAD))
167 #define GST_IS_SELECTOR_PAD_CLASS(klass) \
168   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_SELECTOR_PAD))
169 #define GST_SELECTOR_PAD_CAST(obj) \
170   ((GstSelectorPad *)(obj))
171
172 typedef struct _GstSelectorPad GstSelectorPad;
173 typedef struct _GstSelectorPadClass GstSelectorPadClass;
174 typedef struct _GstSelectorPadCachedBuffer GstSelectorPadCachedBuffer;
175
176 struct _GstSelectorPad
177 {
178   GstPad parent;
179
180   gboolean active;              /* when buffer have passed the pad */
181   gboolean pushed;              /* when buffer was pushed downstream since activation */
182   gboolean eos;                 /* when EOS has been received */
183   gboolean eos_sent;            /* when EOS was sent downstream */
184   gboolean discont;             /* after switching we create a discont */
185   gboolean flushing;            /* set after flush-start and before flush-stop */
186   gboolean always_ok;
187   GstTagList *tags;             /* last tags received on the pad */
188
189   GstClockTime position;        /* the current position in the segment */
190   GstSegment segment;           /* the current segment on the pad */
191   guint32 segment_seqnum;       /* sequence number of the current segment */
192
193   gboolean events_pending;      /* TRUE if sticky events need to be updated */
194
195   gboolean sending_cached_buffers;
196   GQueue *cached_buffers;
197 };
198
199 struct _GstSelectorPadCachedBuffer
200 {
201   GstBuffer *buffer;
202   GstSegment segment;
203 };
204
205 struct _GstSelectorPadClass
206 {
207   GstPadClass parent;
208 };
209
210 GType gst_selector_pad_get_type (void);
211 static void gst_selector_pad_finalize (GObject * object);
212 static void gst_selector_pad_get_property (GObject * object,
213     guint prop_id, GValue * value, GParamSpec * pspec);
214 static void gst_selector_pad_set_property (GObject * object,
215     guint prop_id, const GValue * value, GParamSpec * pspec);
216
217 static gint64 gst_selector_pad_get_running_time (GstSelectorPad * pad);
218 static void gst_selector_pad_reset (GstSelectorPad * pad);
219 static gboolean gst_selector_pad_event (GstPad * pad, GstObject * parent,
220     GstEvent * event);
221 static gboolean gst_selector_pad_query (GstPad * pad, GstObject * parent,
222     GstQuery * query);
223 static GstIterator *gst_selector_pad_iterate_linked_pads (GstPad * pad,
224     GstObject * parent);
225 static GstFlowReturn gst_selector_pad_chain (GstPad * pad, GstObject * parent,
226     GstBuffer * buf);
227 static void gst_selector_pad_cache_buffer (GstSelectorPad * selpad,
228     GstBuffer * buffer);
229 static void gst_selector_pad_free_cached_buffers (GstSelectorPad * selpad);
230
231 G_DEFINE_TYPE (GstSelectorPad, gst_selector_pad, GST_TYPE_PAD);
232
233 static void
234 gst_selector_pad_class_init (GstSelectorPadClass * klass)
235 {
236   GObjectClass *gobject_class;
237
238   gobject_class = (GObjectClass *) klass;
239
240   gobject_class->finalize = gst_selector_pad_finalize;
241
242   gobject_class->get_property = gst_selector_pad_get_property;
243   gobject_class->set_property = gst_selector_pad_set_property;
244
245   g_object_class_install_property (gobject_class, PROP_PAD_RUNNING_TIME,
246       g_param_spec_int64 ("running-time", "Running time",
247           "Running time of stream on pad", 0, G_MAXINT64, 0,
248           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
249   g_object_class_install_property (gobject_class, PROP_PAD_TAGS,
250       g_param_spec_boxed ("tags", "Tags",
251           "The currently active tags on the pad", GST_TYPE_TAG_LIST,
252           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
253   g_object_class_install_property (gobject_class, PROP_PAD_ACTIVE,
254       g_param_spec_boolean ("active", "Active",
255           "If the pad is currently active", FALSE,
256           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
257   /* FIXME: better property name? */
258   g_object_class_install_property (gobject_class, PROP_PAD_ALWAYS_OK,
259       g_param_spec_boolean ("always-ok", "Always OK",
260           "Make an inactive pad return OK instead of NOT_LINKED",
261           DEFAULT_PAD_ALWAYS_OK, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
262 }
263
264 static void
265 gst_selector_pad_init (GstSelectorPad * pad)
266 {
267   pad->always_ok = DEFAULT_PAD_ALWAYS_OK;
268   gst_selector_pad_reset (pad);
269 }
270
271 static void
272 gst_selector_pad_finalize (GObject * object)
273 {
274   GstSelectorPad *pad;
275
276   pad = GST_SELECTOR_PAD_CAST (object);
277
278   if (pad->tags)
279     gst_tag_list_unref (pad->tags);
280   gst_selector_pad_free_cached_buffers (pad);
281
282   G_OBJECT_CLASS (gst_selector_pad_parent_class)->finalize (object);
283 }
284
285 static void
286 gst_selector_pad_set_property (GObject * object, guint prop_id,
287     const GValue * value, GParamSpec * pspec)
288 {
289   GstSelectorPad *spad = GST_SELECTOR_PAD_CAST (object);
290
291   switch (prop_id) {
292     case PROP_PAD_ALWAYS_OK:
293       GST_OBJECT_LOCK (object);
294       spad->always_ok = g_value_get_boolean (value);
295       GST_OBJECT_UNLOCK (object);
296       break;
297     default:
298       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
299       break;
300   }
301 }
302
303 static void
304 gst_selector_pad_get_property (GObject * object, guint prop_id,
305     GValue * value, GParamSpec * pspec)
306 {
307   GstSelectorPad *spad = GST_SELECTOR_PAD_CAST (object);
308
309   switch (prop_id) {
310     case PROP_PAD_RUNNING_TIME:
311       g_value_set_int64 (value, gst_selector_pad_get_running_time (spad));
312       break;
313     case PROP_PAD_TAGS:
314       GST_OBJECT_LOCK (object);
315       g_value_set_boxed (value, spad->tags);
316       GST_OBJECT_UNLOCK (object);
317       break;
318     case PROP_PAD_ACTIVE:
319     {
320       GstInputSelector *sel;
321
322       sel = GST_INPUT_SELECTOR (gst_pad_get_parent (spad));
323       g_value_set_boolean (value, gst_input_selector_is_active_sinkpad (sel,
324               GST_PAD_CAST (spad)));
325       gst_object_unref (sel);
326       break;
327     }
328     case PROP_PAD_ALWAYS_OK:
329       GST_OBJECT_LOCK (object);
330       g_value_set_boolean (value, spad->always_ok);
331       GST_OBJECT_UNLOCK (object);
332       break;
333     default:
334       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
335       break;
336   }
337 }
338
339 static gint64
340 gst_selector_pad_get_running_time (GstSelectorPad * pad)
341 {
342   gint64 ret = 0;
343
344   GST_OBJECT_LOCK (pad);
345   if (pad->active) {
346     guint64 position = pad->position;
347     GstFormat format = pad->segment.format;
348
349     ret = gst_segment_to_running_time (&pad->segment, format, position);
350   }
351   GST_OBJECT_UNLOCK (pad);
352
353   GST_DEBUG_OBJECT (pad, "running time: %" GST_TIME_FORMAT
354       " segment: %" GST_SEGMENT_FORMAT, GST_TIME_ARGS (ret), &pad->segment);
355
356   return ret;
357 }
358
359 /* must be called with the SELECTOR_LOCK */
360 static void
361 gst_selector_pad_reset (GstSelectorPad * pad)
362 {
363   GST_OBJECT_LOCK (pad);
364   pad->active = FALSE;
365   pad->pushed = FALSE;
366   pad->eos = FALSE;
367   pad->eos_sent = FALSE;
368   pad->events_pending = FALSE;
369   pad->discont = FALSE;
370   pad->flushing = FALSE;
371   pad->position = GST_CLOCK_TIME_NONE;
372   gst_segment_init (&pad->segment, GST_FORMAT_UNDEFINED);
373   pad->sending_cached_buffers = FALSE;
374   gst_selector_pad_free_cached_buffers (pad);
375   GST_OBJECT_UNLOCK (pad);
376 }
377
378 static GstSelectorPadCachedBuffer *
379 gst_selector_pad_new_cached_buffer (GstSelectorPad * selpad, GstBuffer * buffer)
380 {
381   GstSelectorPadCachedBuffer *cached_buffer =
382       g_slice_new (GstSelectorPadCachedBuffer);
383   cached_buffer->buffer = buffer;
384   cached_buffer->segment = selpad->segment;
385   return cached_buffer;
386 }
387
388 static void
389 gst_selector_pad_free_cached_buffer (GstSelectorPadCachedBuffer * cached_buffer)
390 {
391   gst_buffer_unref (cached_buffer->buffer);
392   g_slice_free (GstSelectorPadCachedBuffer, cached_buffer);
393 }
394
395 /* must be called with the SELECTOR_LOCK */
396 static void
397 gst_selector_pad_cache_buffer (GstSelectorPad * selpad, GstBuffer * buffer)
398 {
399   GST_DEBUG_OBJECT (selpad, "Caching buffer %p", buffer);
400   if (!selpad->cached_buffers)
401     selpad->cached_buffers = g_queue_new ();
402   g_queue_push_tail (selpad->cached_buffers,
403       gst_selector_pad_new_cached_buffer (selpad, buffer));
404 }
405
406 /* must be called with the SELECTOR_LOCK */
407 static void
408 gst_selector_pad_free_cached_buffers (GstSelectorPad * selpad)
409 {
410   GstSelectorPadCachedBuffer *cached_buffer;
411
412   if (!selpad->cached_buffers)
413     return;
414
415   GST_DEBUG_OBJECT (selpad, "Freeing cached buffers");
416   while ((cached_buffer = g_queue_pop_head (selpad->cached_buffers)))
417     gst_selector_pad_free_cached_buffer (cached_buffer);
418   g_queue_free (selpad->cached_buffers);
419   selpad->cached_buffers = NULL;
420 }
421
422 /* strictly get the linked pad from the sinkpad. If the pad is active we return
423  * the srcpad else we return NULL */
424 static GstIterator *
425 gst_selector_pad_iterate_linked_pads (GstPad * pad, GstObject * parent)
426 {
427   GstInputSelector *sel;
428   GstPad *otherpad;
429   GstIterator *it = NULL;
430   GValue val = { 0, };
431
432   sel = GST_INPUT_SELECTOR (parent);
433
434   otherpad = gst_input_selector_get_linked_pad (sel, pad, TRUE);
435   if (otherpad) {
436     g_value_init (&val, GST_TYPE_PAD);
437     g_value_set_object (&val, otherpad);
438     it = gst_iterator_new_single (GST_TYPE_PAD, &val);
439     g_value_unset (&val);
440     gst_object_unref (otherpad);
441   }
442
443   return it;
444 }
445
446 static gboolean
447 gst_selector_pad_event (GstPad * pad, GstObject * parent, GstEvent * event)
448 {
449   gboolean res = TRUE;
450   gboolean forward;
451   GstInputSelector *sel;
452   GstSelectorPad *selpad;
453   GstPad *prev_active_sinkpad;
454   GstPad *active_sinkpad;
455
456   sel = GST_INPUT_SELECTOR (parent);
457   selpad = GST_SELECTOR_PAD_CAST (pad);
458   GST_DEBUG_OBJECT (selpad, "received event %" GST_PTR_FORMAT, event);
459
460   GST_INPUT_SELECTOR_LOCK (sel);
461   prev_active_sinkpad = sel->active_sinkpad;
462   active_sinkpad = gst_input_selector_activate_sinkpad (sel, pad);
463   GST_INPUT_SELECTOR_UNLOCK (sel);
464
465   if (prev_active_sinkpad != active_sinkpad && pad == active_sinkpad) {
466     g_object_notify (G_OBJECT (sel), "active-pad");
467   }
468
469   GST_INPUT_SELECTOR_LOCK (sel);
470   active_sinkpad = gst_input_selector_activate_sinkpad (sel, pad);
471
472   /* only forward if we are dealing with the active sinkpad */
473   forward = (pad == active_sinkpad);
474
475   switch (GST_EVENT_TYPE (event)) {
476     case GST_EVENT_FLUSH_START:
477       /* Unblock the pad if it's waiting */
478       selpad->flushing = TRUE;
479       GST_INPUT_SELECTOR_BROADCAST (sel);
480       break;
481     case GST_EVENT_FLUSH_STOP:
482       gst_selector_pad_reset (selpad);
483       break;
484     case GST_EVENT_SEGMENT:
485     {
486       gst_event_copy_segment (event, &selpad->segment);
487       selpad->segment_seqnum = gst_event_get_seqnum (event);
488
489       /* Update the position */
490       if (selpad->position == GST_CLOCK_TIME_NONE
491           || selpad->segment.position > selpad->position) {
492         selpad->position = selpad->segment.position;
493       } else if (selpad->position != GST_CLOCK_TIME_NONE
494           && selpad->position > selpad->segment.position) {
495         selpad->segment.position = selpad->position;
496
497         if (forward) {
498           gst_event_unref (event);
499           event = gst_event_new_segment (&selpad->segment);
500           gst_event_set_seqnum (event, selpad->segment_seqnum);
501         }
502       }
503       GST_DEBUG_OBJECT (pad, "configured SEGMENT %" GST_SEGMENT_FORMAT,
504           &selpad->segment);
505       break;
506     }
507     case GST_EVENT_TAG:
508     {
509       GstTagList *tags, *oldtags, *newtags;
510
511       gst_event_parse_tag (event, &tags);
512
513       oldtags = selpad->tags;
514
515       newtags = gst_tag_list_merge (oldtags, tags, GST_TAG_MERGE_REPLACE);
516       selpad->tags = newtags;
517       if (oldtags)
518         gst_tag_list_unref (oldtags);
519       GST_DEBUG_OBJECT (pad, "received tags %" GST_PTR_FORMAT, newtags);
520
521       g_object_notify (G_OBJECT (selpad), "tags");
522       break;
523     }
524     case GST_EVENT_EOS:
525       selpad->eos = TRUE;
526
527       if (forward) {
528         selpad->eos_sent = TRUE;
529       } else {
530         GstSelectorPad *active_selpad;
531
532         /* If the active sinkpad is in EOS state but EOS
533          * was not sent downstream this means that the pad
534          * got EOS before it was set as active pad and that
535          * the previously active pad got EOS after it was
536          * active
537          */
538         active_selpad = GST_SELECTOR_PAD (active_sinkpad);
539         forward = (active_selpad->eos && !active_selpad->eos_sent);
540         active_selpad->eos_sent = TRUE;
541       }
542       GST_DEBUG_OBJECT (pad, "received EOS");
543       break;
544     default:
545       break;
546   }
547   GST_INPUT_SELECTOR_UNLOCK (sel);
548   if (forward) {
549     GST_DEBUG_OBJECT (pad, "forwarding event");
550     res = gst_pad_push_event (sel->srcpad, event);
551   } else {
552     /* If we aren't forwarding the event because the pad is not the
553      * active_sinkpad, then set the flag on the pad
554      * that says a segment needs sending if/when that pad is activated.
555      * For all other cases, we send the event immediately, which makes
556      * sparse streams and other segment updates work correctly downstream.
557      */
558     if (GST_EVENT_IS_STICKY (event))
559       selpad->events_pending = TRUE;
560     gst_event_unref (event);
561   }
562
563   return res;
564 }
565
566 static gboolean
567 gst_selector_pad_query (GstPad * pad, GstObject * parent, GstQuery * query)
568 {
569   gboolean res = FALSE;
570
571   switch (GST_QUERY_TYPE (query)) {
572     default:
573       res = gst_pad_query_default (pad, parent, query);
574       break;
575   }
576
577   return res;
578 }
579
580 /* must be called with the SELECTOR_LOCK, will block while the pad is blocked 
581  * or return TRUE when flushing */
582 static gboolean
583 gst_input_selector_wait (GstInputSelector * self, GstSelectorPad * pad)
584 {
585   while (self->blocked && !self->flushing && !pad->flushing) {
586     /* we can be unlocked here when we are shutting down (flushing) or when we
587      * get unblocked */
588     GST_INPUT_SELECTOR_WAIT (self);
589   }
590   return self->flushing;
591 }
592
593 /* must be called without the SELECTOR_LOCK, will wait until the running time
594  * of the active pad is after this pad or return TRUE when flushing */
595 static gboolean
596 gst_input_selector_wait_running_time (GstInputSelector * sel,
597     GstSelectorPad * selpad, GstBuffer * buf)
598 {
599   GstSegment *seg;
600
601   GST_DEBUG_OBJECT (selpad, "entering wait for buffer %p", buf);
602
603   /* If we have no valid timestamp we can't sync this buffer */
604   if (!GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
605     GST_DEBUG_OBJECT (selpad, "leaving wait for buffer with "
606         "invalid timestamp");
607     return FALSE;
608   }
609
610   seg = &selpad->segment;
611
612   /* Wait until
613    *   a) this is the active pad
614    *   b) the pad or the selector is flushing
615    *   c) the selector is not blocked
616    *   d) the buffer running time is before the current running time
617    *      (either active-seg or clock, depending on sync-mode)
618    */
619
620   GST_INPUT_SELECTOR_LOCK (sel);
621   while (TRUE) {
622     GstPad *active_sinkpad;
623     GstSelectorPad *active_selpad;
624     GstClock *clock;
625     gint64 cur_running_time;
626     GstClockTime running_time;
627
628     active_sinkpad =
629         gst_input_selector_activate_sinkpad (sel, GST_PAD_CAST (selpad));
630     active_selpad = GST_SELECTOR_PAD_CAST (active_sinkpad);
631
632     running_time = GST_BUFFER_TIMESTAMP (buf);
633     /* If possible try to get the running time at the end of the buffer */
634     if (GST_BUFFER_DURATION_IS_VALID (buf))
635       running_time += GST_BUFFER_DURATION (buf);
636     /* Only use the segment to convert to running time if the segment is
637      * in TIME format, otherwise do our best to try to sync */
638     if (seg->format == GST_FORMAT_TIME && GST_CLOCK_TIME_IS_VALID (seg->stop)) {
639       if (running_time > seg->stop) {
640         running_time = seg->stop;
641       }
642       running_time =
643           gst_segment_to_running_time (seg, GST_FORMAT_TIME, running_time);
644       /* If this is outside the segment don't sync */
645       if (running_time == -1) {
646         GST_INPUT_SELECTOR_UNLOCK (sel);
647         return FALSE;
648       }
649     }
650
651     cur_running_time = GST_CLOCK_TIME_NONE;
652     if (sel->sync_mode == GST_INPUT_SELECTOR_SYNC_MODE_CLOCK) {
653       clock = gst_element_get_clock (GST_ELEMENT_CAST (sel));
654       if (clock) {
655         GstClockTime base_time;
656
657         cur_running_time = gst_clock_get_time (clock);
658         base_time = gst_element_get_base_time (GST_ELEMENT_CAST (sel));
659         if (base_time <= cur_running_time)
660           cur_running_time -= base_time;
661         else
662           cur_running_time = 0;
663       }
664     } else {
665       GstSegment *active_seg;
666
667       active_seg = &active_selpad->segment;
668
669       /* Get active pad's running time, if no configured segment yet keep at -1 */
670       if (active_seg->format == GST_FORMAT_TIME)
671         cur_running_time = gst_segment_to_running_time (active_seg,
672             GST_FORMAT_TIME, active_seg->position);
673     }
674
675     if (selpad != active_selpad && !sel->flushing && !selpad->flushing &&
676         (sel->cache_buffers || active_selpad->pushed) &&
677         (sel->blocked || cur_running_time == -1
678             || running_time >= cur_running_time)) {
679       if (!sel->blocked)
680         GST_DEBUG_OBJECT (selpad,
681             "Waiting for active streams to advance. %" GST_TIME_FORMAT " >= %"
682             GST_TIME_FORMAT, GST_TIME_ARGS (running_time),
683             GST_TIME_ARGS (cur_running_time));
684
685       GST_INPUT_SELECTOR_WAIT (sel);
686     } else {
687       GST_INPUT_SELECTOR_UNLOCK (sel);
688       break;
689     }
690   }
691
692   /* Return TRUE if the selector or the pad is flushing */
693   return (sel->flushing || selpad->flushing);
694 }
695
696 static gboolean
697 forward_sticky_events (GstPad * sinkpad, GstEvent ** event, gpointer user_data)
698 {
699   GstInputSelector *sel = GST_INPUT_SELECTOR (user_data);
700
701   if (GST_EVENT_TYPE (*event) == GST_EVENT_SEGMENT) {
702     GstSegment *seg = &GST_SELECTOR_PAD (sinkpad)->segment;
703     GstEvent *e;
704
705     e = gst_event_new_segment (seg);
706     gst_event_set_seqnum (e, GST_SELECTOR_PAD_CAST (sinkpad)->segment_seqnum);
707
708     gst_pad_push_event (sel->srcpad, e);
709   } else {
710     gst_pad_push_event (sel->srcpad, gst_event_ref (*event));
711   }
712
713   return TRUE;
714 }
715
716 #if DEBUG_CACHED_BUFFERS
717 static void
718 gst_input_selector_debug_cached_buffers (GstInputSelector * sel)
719 {
720   GList *walk;
721
722   for (walk = GST_ELEMENT_CAST (sel)->sinkpads; walk; walk = g_list_next (walk)) {
723     GstSelectorPad *selpad;
724     GString *timestamps;
725     gchar *str;
726     int i;
727
728     selpad = GST_SELECTOR_PAD_CAST (walk->data);
729     if (!selpad->cached_buffers) {
730       GST_DEBUG_OBJECT (selpad, "Cached buffers timestamps: <none>");
731       continue;
732     }
733
734     timestamps = g_string_new ("Cached buffers timestamps:");
735     for (i = 0; i < selpad->cached_buffers->length; ++i) {
736       GstSelectorPadCachedBuffer *cached_buffer;
737
738       cached_buffer = g_queue_peek_nth (selpad->cached_buffers, i);
739       g_string_append_printf (timestamps, " %" GST_TIME_FORMAT,
740           GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (cached_buffer->buffer)));
741     }
742     str = g_string_free (timestamps, FALSE);
743     GST_DEBUG_OBJECT (selpad, str);
744     g_free (str);
745   }
746 }
747 #endif
748
749 /* must be called with the SELECTOR_LOCK */
750 static void
751 gst_input_selector_cleanup_old_cached_buffers (GstInputSelector * sel,
752     GstPad * pad)
753 {
754   GstSelectorPad *selpad;
755   GstSegment *seg;
756   GstClock *clock;
757   gint64 cur_running_time;
758   GList *walk;
759
760   selpad = GST_SELECTOR_PAD_CAST (pad);
761   seg = &selpad->segment;
762
763   cur_running_time = GST_CLOCK_TIME_NONE;
764   if (sel->sync_mode == GST_INPUT_SELECTOR_SYNC_MODE_CLOCK) {
765     clock = gst_element_get_clock (GST_ELEMENT_CAST (sel));
766     if (clock) {
767       GstClockTime base_time;
768
769       cur_running_time = gst_clock_get_time (clock);
770       base_time = gst_element_get_base_time (GST_ELEMENT_CAST (sel));
771       if (base_time <= cur_running_time)
772         cur_running_time -= base_time;
773       else
774         cur_running_time = 0;
775     }
776   } else {
777     GstPad *active_sinkpad;
778     GstSelectorPad *active_selpad;
779     GstSegment *active_seg;
780
781     active_sinkpad = gst_input_selector_activate_sinkpad (sel, pad);
782     active_selpad = GST_SELECTOR_PAD_CAST (active_sinkpad);
783     active_seg = &active_selpad->segment;
784
785     /* Get active pad's running time, if no configured segment yet keep at -1 */
786     if (active_seg->format == GST_FORMAT_TIME)
787       cur_running_time = gst_segment_to_running_time (active_seg,
788           GST_FORMAT_TIME, active_seg->position);
789   }
790
791   if (!GST_CLOCK_TIME_IS_VALID (cur_running_time))
792     return;
793
794   GST_DEBUG_OBJECT (sel, "Cleaning up old cached buffers");
795   for (walk = GST_ELEMENT_CAST (sel)->sinkpads; walk; walk = g_list_next (walk)) {
796     GstSelectorPad *selpad = GST_SELECTOR_PAD_CAST (walk->data);
797     GstSelectorPadCachedBuffer *cached_buffer;
798     GSList *maybe_remove;
799     guint queue_position;
800
801     if (!selpad->cached_buffers)
802       continue;
803
804     maybe_remove = NULL;
805     queue_position = 0;
806     while ((cached_buffer = g_queue_peek_nth (selpad->cached_buffers,
807                 queue_position))) {
808       GstBuffer *buffer = cached_buffer->buffer;
809       GstClockTime running_time;
810       GSList *l;
811
812       /* If we have no valid timestamp we can't sync this buffer */
813       if (!GST_BUFFER_TIMESTAMP_IS_VALID (buffer)) {
814         maybe_remove = g_slist_append (maybe_remove, cached_buffer);
815         queue_position = g_slist_length (maybe_remove);
816         continue;
817       }
818
819       /* the buffer is still valid if its duration is valid and the
820        * timestamp + duration is >= time, or if its duration is invalid
821        * and the timestamp is >= time */
822       running_time = GST_BUFFER_TIMESTAMP (buffer);
823       /* If possible try to get the running time at the end of the buffer */
824       if (GST_BUFFER_DURATION_IS_VALID (buffer))
825         running_time += GST_BUFFER_DURATION (buffer);
826       /* Only use the segment to convert to running time if the segment is
827        * in TIME format, otherwise do our best to try to sync */
828       if (seg->format == GST_FORMAT_TIME && GST_CLOCK_TIME_IS_VALID (seg->stop)) {
829         if (running_time > seg->stop) {
830           running_time = seg->stop;
831         }
832         running_time =
833             gst_segment_to_running_time (seg, GST_FORMAT_TIME, running_time);
834       }
835
836       GST_DEBUG_OBJECT (selpad,
837           "checking if buffer %p running time=%" GST_TIME_FORMAT
838           " >= stream time=%" GST_TIME_FORMAT, buffer,
839           GST_TIME_ARGS (running_time), GST_TIME_ARGS (cur_running_time));
840       if (running_time >= cur_running_time) {
841         break;
842       }
843
844       GST_DEBUG_OBJECT (selpad, "Removing old cached buffer %p", buffer);
845       g_queue_pop_nth (selpad->cached_buffers, queue_position);
846       gst_selector_pad_free_cached_buffer (cached_buffer);
847
848       for (l = maybe_remove; l != NULL; l = g_slist_next (l)) {
849         /* A buffer after some invalid buffers was removed, it means the invalid buffers
850          * are old, lets also remove them */
851         cached_buffer = l->data;
852         g_queue_remove (selpad->cached_buffers, cached_buffer);
853         gst_selector_pad_free_cached_buffer (cached_buffer);
854       }
855
856       g_slist_free (maybe_remove);
857       maybe_remove = NULL;
858       queue_position = 0;
859     }
860
861     g_slist_free (maybe_remove);
862     maybe_remove = NULL;
863
864     if (g_queue_is_empty (selpad->cached_buffers)) {
865       g_queue_free (selpad->cached_buffers);
866       selpad->cached_buffers = NULL;
867     }
868   }
869
870 #if DEBUG_CACHED_BUFFERS
871   gst_input_selector_debug_cached_buffers (sel);
872 #endif
873 }
874
875 static GstFlowReturn
876 gst_selector_pad_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
877 {
878   GstInputSelector *sel;
879   GstFlowReturn res;
880   GstPad *active_sinkpad;
881   GstPad *prev_active_sinkpad;
882   GstSelectorPad *selpad;
883   GstClockTime start_time;
884
885   sel = GST_INPUT_SELECTOR (parent);
886   selpad = GST_SELECTOR_PAD_CAST (pad);
887
888   GST_DEBUG_OBJECT (selpad,
889       "entering chain for buf %p with timestamp %" GST_TIME_FORMAT, buf,
890       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
891
892   GST_INPUT_SELECTOR_LOCK (sel);
893   /* wait or check for flushing */
894   if (gst_input_selector_wait (sel, selpad)) {
895     GST_INPUT_SELECTOR_UNLOCK (sel);
896     goto flushing;
897   }
898
899   GST_LOG_OBJECT (pad, "getting active pad");
900
901   prev_active_sinkpad = sel->active_sinkpad;
902   active_sinkpad = gst_input_selector_activate_sinkpad (sel, pad);
903
904   /* In sync mode wait until the active pad has advanced
905    * after the running time of the current buffer */
906   if (sel->sync_streams) {
907     /* call chain for each cached buffer if we are not the active pad
908      * or if we are the active pad but didn't push anything yet. */
909     if (active_sinkpad != pad || !selpad->pushed) {
910       /* no need to check for sel->cache_buffers as selpad->cached_buffers
911        * will only be valid if cache_buffers is TRUE */
912       if (selpad->cached_buffers && !selpad->sending_cached_buffers) {
913         GstSelectorPadCachedBuffer *cached_buffer;
914         GstSegment saved_segment;
915
916         saved_segment = selpad->segment;
917
918         selpad->sending_cached_buffers = TRUE;
919         while (!sel->flushing && !selpad->flushing &&
920             (cached_buffer = g_queue_pop_head (selpad->cached_buffers))) {
921           GST_DEBUG_OBJECT (pad, "Cached buffers found, "
922               "invoking chain for cached buffer %p", cached_buffer->buffer);
923
924           selpad->segment = cached_buffer->segment;
925           selpad->events_pending = TRUE;
926           GST_INPUT_SELECTOR_UNLOCK (sel);
927           gst_selector_pad_chain (pad, parent, cached_buffer->buffer);
928           GST_INPUT_SELECTOR_LOCK (sel);
929
930           /* we may have cleaned up the queue in the meantime because of
931            * old buffers */
932           if (!selpad->cached_buffers) {
933             break;
934           }
935         }
936         selpad->sending_cached_buffers = FALSE;
937
938         /* all cached buffers sent, restore segment for current buffer */
939         selpad->segment = saved_segment;
940         selpad->events_pending = TRUE;
941
942         /* Might have changed while calling chain for cached buffers */
943         active_sinkpad = gst_input_selector_activate_sinkpad (sel, pad);
944       }
945     }
946
947     if (active_sinkpad != pad) {
948       GST_INPUT_SELECTOR_UNLOCK (sel);
949       if (gst_input_selector_wait_running_time (sel, selpad, buf))
950         goto flushing;
951       GST_INPUT_SELECTOR_LOCK (sel);
952     }
953
954     /* Might have changed while waiting */
955     active_sinkpad = gst_input_selector_activate_sinkpad (sel, pad);
956   }
957
958   /* update the segment on the srcpad */
959   start_time = GST_BUFFER_TIMESTAMP (buf);
960   if (GST_CLOCK_TIME_IS_VALID (start_time)) {
961     GST_LOG_OBJECT (pad, "received start time %" GST_TIME_FORMAT,
962         GST_TIME_ARGS (start_time));
963     if (GST_BUFFER_DURATION_IS_VALID (buf))
964       GST_LOG_OBJECT (pad, "received end time %" GST_TIME_FORMAT,
965           GST_TIME_ARGS (start_time + GST_BUFFER_DURATION (buf)));
966
967     GST_OBJECT_LOCK (pad);
968     selpad->position = start_time;
969     selpad->segment.position = start_time;
970     GST_OBJECT_UNLOCK (pad);
971   }
972
973   /* Ignore buffers from pads except the selected one */
974   if (pad != active_sinkpad)
975     goto ignore;
976
977   /* Tell all non-active pads that we advanced the running time */
978   if (sel->sync_streams)
979     GST_INPUT_SELECTOR_BROADCAST (sel);
980
981   GST_INPUT_SELECTOR_UNLOCK (sel);
982
983   if (prev_active_sinkpad != active_sinkpad && pad == active_sinkpad) {
984     g_object_notify (G_OBJECT (sel), "active-pad");
985   }
986
987   /* if we have a pending events, push them now */
988   if (G_UNLIKELY (prev_active_sinkpad != active_sinkpad
989           || selpad->events_pending)) {
990     gst_pad_sticky_events_foreach (GST_PAD_CAST (selpad), forward_sticky_events,
991         sel);
992     selpad->events_pending = FALSE;
993   }
994
995   if (selpad->discont) {
996     buf = gst_buffer_make_writable (buf);
997
998     GST_DEBUG_OBJECT (pad, "Marking discont buffer %p", buf);
999     GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_DISCONT);
1000     selpad->discont = FALSE;
1001   }
1002
1003   /* forward */
1004   GST_LOG_OBJECT (pad, "Forwarding buffer %p with timestamp %" GST_TIME_FORMAT,
1005       buf, GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
1006
1007   res = gst_pad_push (sel->srcpad, gst_buffer_ref (buf));
1008   GST_LOG_OBJECT (pad, "Buffer %p forwarded result=%d", buf, res);
1009
1010   GST_INPUT_SELECTOR_LOCK (sel);
1011
1012   if (sel->sync_streams && sel->cache_buffers) {
1013     /* Might have changed while pushing */
1014     active_sinkpad = gst_input_selector_activate_sinkpad (sel, pad);
1015     /* only set pad to pushed if we are still the active pad */
1016     if (active_sinkpad == pad)
1017       selpad->pushed = TRUE;
1018
1019     /* cache buffer as we may need it again if we change pads */
1020     gst_selector_pad_cache_buffer (selpad, buf);
1021     gst_input_selector_cleanup_old_cached_buffers (sel, pad);
1022   } else {
1023     selpad->pushed = TRUE;
1024     gst_buffer_unref (buf);
1025   }
1026   GST_INPUT_SELECTOR_UNLOCK (sel);
1027
1028 done:
1029   return res;
1030
1031   /* dropped buffers */
1032 ignore:
1033   {
1034     gboolean active_pad_pushed = GST_SELECTOR_PAD_CAST (active_sinkpad)->pushed;
1035
1036     GST_DEBUG_OBJECT (pad, "Pad not active or buffer timestamp is invalid, "
1037         "discard buffer %p", buf);
1038     /* when we drop a buffer, we're creating a discont on this pad */
1039     selpad->discont = TRUE;
1040     GST_INPUT_SELECTOR_UNLOCK (sel);
1041     gst_buffer_unref (buf);
1042
1043     /* figure out what to return upstream */
1044     GST_OBJECT_LOCK (selpad);
1045     if (selpad->always_ok || !active_pad_pushed)
1046       res = GST_FLOW_OK;
1047     else
1048       res = GST_FLOW_NOT_LINKED;
1049     GST_OBJECT_UNLOCK (selpad);
1050
1051     goto done;
1052   }
1053 flushing:
1054   {
1055     GST_DEBUG_OBJECT (pad, "We are flushing, discard buffer %p", buf);
1056     gst_buffer_unref (buf);
1057     res = GST_FLOW_FLUSHING;
1058     goto done;
1059   }
1060 }
1061
1062 static void gst_input_selector_dispose (GObject * object);
1063 static void gst_input_selector_finalize (GObject * object);
1064
1065 static void gst_input_selector_set_property (GObject * object,
1066     guint prop_id, const GValue * value, GParamSpec * pspec);
1067 static void gst_input_selector_get_property (GObject * object,
1068     guint prop_id, GValue * value, GParamSpec * pspec);
1069
1070 static GstPad *gst_input_selector_request_new_pad (GstElement * element,
1071     GstPadTemplate * templ, const gchar * unused, const GstCaps * caps);
1072 static void gst_input_selector_release_pad (GstElement * element, GstPad * pad);
1073
1074 static GstStateChangeReturn gst_input_selector_change_state (GstElement *
1075     element, GstStateChange transition);
1076
1077 static gboolean gst_input_selector_event (GstPad * pad, GstObject * parent,
1078     GstEvent * event);
1079 static gboolean gst_input_selector_query (GstPad * pad, GstObject * parent,
1080     GstQuery * query);
1081 static gint64 gst_input_selector_block (GstInputSelector * self);
1082
1083 /* FIXME: create these marshallers using glib-genmarshal */
1084 static void
1085 gst_input_selector_marshal_INT64__VOID (GClosure * closure,
1086     GValue * return_value G_GNUC_UNUSED,
1087     guint n_param_values,
1088     const GValue * param_values,
1089     gpointer invocation_hint G_GNUC_UNUSED, gpointer marshal_data)
1090 {
1091   typedef gint64 (*GMarshalFunc_INT64__VOID) (gpointer data1, gpointer data2);
1092   register GMarshalFunc_INT64__VOID callback;
1093   register GCClosure *cc = (GCClosure *) closure;
1094   register gpointer data1, data2;
1095   gint64 v_return;
1096
1097   g_return_if_fail (return_value != NULL);
1098   g_return_if_fail (n_param_values == 1);
1099
1100   if (G_CCLOSURE_SWAP_DATA (closure)) {
1101     data1 = closure->data;
1102     data2 = g_value_peek_pointer (param_values + 0);
1103   } else {
1104     data1 = g_value_peek_pointer (param_values + 0);
1105     data2 = closure->data;
1106   }
1107   callback =
1108       (GMarshalFunc_INT64__VOID) (marshal_data ? marshal_data : cc->callback);
1109
1110   v_return = callback (data1, data2);
1111
1112   g_value_set_int64 (return_value, v_return);
1113 }
1114
1115 #define _do_init \
1116     GST_DEBUG_CATEGORY_INIT (input_selector_debug, \
1117         "input-selector", 0, "An input stream selector element");
1118 #define gst_input_selector_parent_class parent_class
1119 G_DEFINE_TYPE_WITH_CODE (GstInputSelector, gst_input_selector, GST_TYPE_ELEMENT,
1120     _do_init);
1121
1122 static void
1123 gst_input_selector_class_init (GstInputSelectorClass * klass)
1124 {
1125   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
1126   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
1127
1128   gobject_class->dispose = gst_input_selector_dispose;
1129   gobject_class->finalize = gst_input_selector_finalize;
1130
1131   gobject_class->set_property = gst_input_selector_set_property;
1132   gobject_class->get_property = gst_input_selector_get_property;
1133
1134   g_object_class_install_property (gobject_class, PROP_N_PADS,
1135       g_param_spec_uint ("n-pads", "Number of Pads",
1136           "The number of sink pads", 0, G_MAXUINT, 0,
1137           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1138
1139   g_object_class_install_property (gobject_class, PROP_ACTIVE_PAD,
1140       g_param_spec_object ("active-pad", "Active pad",
1141           "The currently active sink pad", GST_TYPE_PAD,
1142           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1143
1144   /**
1145    * GstInputSelector:sync-streams
1146    *
1147    * If set to %TRUE all inactive streams will be synced to the
1148    * running time of the active stream or to the current clock.
1149    *
1150    * To make sure no buffers are dropped by input-selector
1151    * that might be needed when switching the active pad,
1152    * sync-mode should be set to "clock" and cache-buffers to TRUE.
1153    *
1154    * Since: 0.10.36
1155    */
1156   g_object_class_install_property (gobject_class, PROP_SYNC_STREAMS,
1157       g_param_spec_boolean ("sync-streams", "Sync Streams",
1158           "Synchronize inactive streams to the running time of the active "
1159           "stream or to the current clock",
1160           DEFAULT_SYNC_STREAMS,
1161           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
1162           GST_PARAM_MUTABLE_READY));
1163
1164   /**
1165    * GstInputSelector:sync-mode
1166    *
1167    * Select how input-selector will sync buffers when in sync-streams mode.
1168    *
1169    * Note that when using the "active-segment" mode, the "active-segment" may
1170    * be ahead of current clock time when switching the active pad, as the current
1171    * active pad may have pushed more buffers than what was displayed/consumed,
1172    * which may cause delays and some missing buffers.
1173    *
1174    * Since: 0.10.36
1175    */
1176   g_object_class_install_property (gobject_class, PROP_SYNC_MODE,
1177       g_param_spec_enum ("sync-mode", "Sync mode",
1178           "Behavior in sync-streams mode", GST_TYPE_INPUT_SELECTOR_SYNC_MODE,
1179           DEFAULT_SYNC_MODE,
1180           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
1181           GST_PARAM_MUTABLE_READY));
1182
1183   /**
1184    * GstInputSelector:cache-buffers
1185    *
1186    * If set to %TRUE and GstInputSelector:sync-streams is also set to %TRUE,
1187    * the active pad will cache the buffers still considered valid (after current
1188    * running time, see sync-mode) to avoid missing frames if/when the pad is
1189    * reactivated.
1190    *
1191    * The active pad may push more buffers than what is currently displayed/consumed
1192    * and when changing pads those buffers will be discarded and the only way to
1193    * reactivate that pad without loosing the already consumed buffers is to enable cache.
1194    */
1195   g_object_class_install_property (gobject_class, PROP_CACHE_BUFFERS,
1196       g_param_spec_boolean ("cache-buffers", "Cache Buffers",
1197           "Cache buffers for active-pad",
1198           DEFAULT_CACHE_BUFFERS,
1199           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
1200           GST_PARAM_MUTABLE_READY));
1201
1202   /**
1203    * GstInputSelector::block:
1204    * @inputselector: the #GstInputSelector
1205    *
1206    * Block all sink pads in preparation for a switch. Returns the stop time of
1207    * the current switch segment, as a running time, or 0 if there is no current
1208    * active pad or the current active pad never received data.
1209    */
1210   gst_input_selector_signals[SIGNAL_BLOCK] =
1211       g_signal_new ("block", G_TYPE_FROM_CLASS (klass),
1212       G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
1213       G_STRUCT_OFFSET (GstInputSelectorClass, block), NULL, NULL,
1214       gst_input_selector_marshal_INT64__VOID, G_TYPE_INT64, 0);
1215
1216   gst_element_class_set_static_metadata (gstelement_class, "Input selector",
1217       "Generic", "N-to-1 input stream selector",
1218       "Julien Moutte <julien@moutte.net>, "
1219       "Jan Schmidt <thaytan@mad.scientist.com>, "
1220       "Wim Taymans <wim.taymans@gmail.com>");
1221   gst_element_class_add_pad_template (gstelement_class,
1222       gst_static_pad_template_get (&gst_input_selector_sink_factory));
1223   gst_element_class_add_pad_template (gstelement_class,
1224       gst_static_pad_template_get (&gst_input_selector_src_factory));
1225
1226   gstelement_class->request_new_pad = gst_input_selector_request_new_pad;
1227   gstelement_class->release_pad = gst_input_selector_release_pad;
1228   gstelement_class->change_state = gst_input_selector_change_state;
1229
1230   klass->block = GST_DEBUG_FUNCPTR (gst_input_selector_block);
1231 }
1232
1233 static void
1234 gst_input_selector_init (GstInputSelector * sel)
1235 {
1236   sel->srcpad = gst_pad_new ("src", GST_PAD_SRC);
1237   gst_pad_set_iterate_internal_links_function (sel->srcpad,
1238       GST_DEBUG_FUNCPTR (gst_selector_pad_iterate_linked_pads));
1239   gst_pad_set_query_function (sel->srcpad,
1240       GST_DEBUG_FUNCPTR (gst_input_selector_query));
1241   gst_pad_set_event_function (sel->srcpad,
1242       GST_DEBUG_FUNCPTR (gst_input_selector_event));
1243   GST_OBJECT_FLAG_SET (sel->srcpad, GST_PAD_FLAG_PROXY_CAPS);
1244   gst_element_add_pad (GST_ELEMENT (sel), sel->srcpad);
1245   /* sinkpad management */
1246   sel->active_sinkpad = NULL;
1247   sel->padcount = 0;
1248   sel->sync_streams = DEFAULT_SYNC_STREAMS;
1249
1250   g_mutex_init (&sel->lock);
1251   g_cond_init (&sel->cond);
1252   sel->blocked = FALSE;
1253
1254   /* lets give a change for downstream to do something on
1255    * active-pad change before we start pushing new buffers */
1256   g_signal_connect_data (sel, "notify::active-pad",
1257       (GCallback) gst_input_selector_active_pad_changed, NULL,
1258       NULL, G_CONNECT_AFTER);
1259 }
1260
1261 static void
1262 gst_input_selector_dispose (GObject * object)
1263 {
1264   GstInputSelector *sel = GST_INPUT_SELECTOR (object);
1265
1266   if (sel->active_sinkpad) {
1267     gst_object_unref (sel->active_sinkpad);
1268     sel->active_sinkpad = NULL;
1269   }
1270   G_OBJECT_CLASS (parent_class)->dispose (object);
1271 }
1272
1273 static void
1274 gst_input_selector_finalize (GObject * object)
1275 {
1276   GstInputSelector *sel = GST_INPUT_SELECTOR (object);
1277
1278   g_mutex_clear (&sel->lock);
1279   g_cond_clear (&sel->cond);
1280
1281   G_OBJECT_CLASS (parent_class)->finalize (object);
1282 }
1283
1284 /* this function must be called with the SELECTOR_LOCK. It returns TRUE when the
1285  * active pad changed. */
1286 static gboolean
1287 gst_input_selector_set_active_pad (GstInputSelector * self, GstPad * pad)
1288 {
1289   GstSelectorPad *old, *new;
1290   GstPad **active_pad_p;
1291
1292   if (pad == self->active_sinkpad)
1293     return FALSE;
1294
1295   old = GST_SELECTOR_PAD_CAST (self->active_sinkpad);
1296   new = GST_SELECTOR_PAD_CAST (pad);
1297
1298   GST_DEBUG_OBJECT (self, "setting active pad to %s:%s",
1299       GST_DEBUG_PAD_NAME (new));
1300
1301   if (old)
1302     old->pushed = FALSE;
1303   if (new)
1304     new->pushed = FALSE;
1305
1306   /* Send a new SEGMENT event on the new pad next */
1307   if (old != new && new)
1308     new->events_pending = TRUE;
1309
1310   active_pad_p = &self->active_sinkpad;
1311   gst_object_replace ((GstObject **) active_pad_p, GST_OBJECT_CAST (pad));
1312
1313   GST_DEBUG_OBJECT (self, "New active pad is %" GST_PTR_FORMAT,
1314       self->active_sinkpad);
1315
1316   return TRUE;
1317 }
1318
1319 static void
1320 gst_input_selector_set_property (GObject * object, guint prop_id,
1321     const GValue * value, GParamSpec * pspec)
1322 {
1323   GstInputSelector *sel = GST_INPUT_SELECTOR (object);
1324
1325   switch (prop_id) {
1326     case PROP_ACTIVE_PAD:
1327     {
1328       GstPad *pad;
1329
1330       pad = g_value_get_object (value);
1331
1332       GST_INPUT_SELECTOR_LOCK (sel);
1333
1334 #if DEBUG_CACHED_BUFFERS
1335       gst_input_selector_debug_cached_buffers (sel);
1336 #endif
1337
1338       gst_input_selector_set_active_pad (sel, pad);
1339
1340 #if DEBUG_CACHED_BUFFERS
1341       gst_input_selector_debug_cached_buffers (sel);
1342 #endif
1343
1344       GST_INPUT_SELECTOR_UNLOCK (sel);
1345       break;
1346     }
1347     case PROP_SYNC_STREAMS:
1348       GST_INPUT_SELECTOR_LOCK (sel);
1349       sel->sync_streams = g_value_get_boolean (value);
1350       GST_INPUT_SELECTOR_UNLOCK (sel);
1351       break;
1352     case PROP_SYNC_MODE:
1353       GST_INPUT_SELECTOR_LOCK (sel);
1354       sel->sync_mode = g_value_get_enum (value);
1355       GST_INPUT_SELECTOR_UNLOCK (sel);
1356       break;
1357     case PROP_CACHE_BUFFERS:
1358       GST_INPUT_SELECTOR_LOCK (object);
1359       sel->cache_buffers = g_value_get_boolean (value);
1360       GST_INPUT_SELECTOR_UNLOCK (object);
1361       break;
1362     default:
1363       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1364       break;
1365   }
1366 }
1367
1368 static void
1369 gst_input_selector_active_pad_changed (GstInputSelector * sel,
1370     GParamSpec * pspec, gpointer user_data)
1371 {
1372   /* Wake up all non-active pads in sync mode, they might be
1373    * the active pad now */
1374   if (sel->sync_streams)
1375     GST_INPUT_SELECTOR_BROADCAST (sel);
1376 }
1377
1378 static void
1379 gst_input_selector_get_property (GObject * object, guint prop_id,
1380     GValue * value, GParamSpec * pspec)
1381 {
1382   GstInputSelector *sel = GST_INPUT_SELECTOR (object);
1383
1384   switch (prop_id) {
1385     case PROP_N_PADS:
1386       GST_INPUT_SELECTOR_LOCK (object);
1387       g_value_set_uint (value, sel->n_pads);
1388       GST_INPUT_SELECTOR_UNLOCK (object);
1389       break;
1390     case PROP_ACTIVE_PAD:
1391       GST_INPUT_SELECTOR_LOCK (object);
1392       g_value_set_object (value, sel->active_sinkpad);
1393       GST_INPUT_SELECTOR_UNLOCK (object);
1394       break;
1395     case PROP_SYNC_STREAMS:
1396       GST_INPUT_SELECTOR_LOCK (object);
1397       g_value_set_boolean (value, sel->sync_streams);
1398       GST_INPUT_SELECTOR_UNLOCK (object);
1399       break;
1400     case PROP_SYNC_MODE:
1401       GST_INPUT_SELECTOR_LOCK (object);
1402       g_value_set_enum (value, sel->sync_mode);
1403       GST_INPUT_SELECTOR_UNLOCK (object);
1404       break;
1405     case PROP_CACHE_BUFFERS:
1406       GST_INPUT_SELECTOR_LOCK (object);
1407       g_value_set_boolean (value, sel->cache_buffers);
1408       GST_INPUT_SELECTOR_UNLOCK (object);
1409       break;
1410     default:
1411       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1412       break;
1413   }
1414 }
1415
1416 static GstPad *
1417 gst_input_selector_get_linked_pad (GstInputSelector * sel, GstPad * pad,
1418     gboolean strict)
1419 {
1420   GstPad *otherpad = NULL;
1421
1422   GST_INPUT_SELECTOR_LOCK (sel);
1423   if (pad == sel->srcpad)
1424     otherpad = sel->active_sinkpad;
1425   else if (pad == sel->active_sinkpad || !strict)
1426     otherpad = sel->srcpad;
1427   if (otherpad)
1428     gst_object_ref (otherpad);
1429   GST_INPUT_SELECTOR_UNLOCK (sel);
1430
1431   return otherpad;
1432 }
1433
1434 static gboolean
1435 gst_input_selector_event (GstPad * pad, GstObject * parent, GstEvent * event)
1436 {
1437   GstInputSelector *sel;
1438   gboolean result = FALSE;
1439   GstIterator *iter;
1440   gboolean done = FALSE;
1441   GValue item = { 0, };
1442   GstPad *eventpad;
1443   GList *pushed_pads = NULL;
1444
1445   sel = GST_INPUT_SELECTOR (parent);
1446   /* Send upstream events to all sinkpads */
1447   iter = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (sel));
1448
1449   /* This is now essentially a copy of gst_pad_event_default_dispatch
1450    * with a different iterator */
1451   while (!done) {
1452     switch (gst_iterator_next (iter, &item)) {
1453       case GST_ITERATOR_OK:
1454         eventpad = g_value_get_object (&item);
1455
1456         /* if already pushed,  skip */
1457         if (g_list_find (pushed_pads, eventpad)) {
1458           g_value_reset (&item);
1459           break;
1460         }
1461
1462         gst_event_ref (event);
1463         result |= gst_pad_push_event (eventpad, event);
1464
1465         g_value_reset (&item);
1466         break;
1467       case GST_ITERATOR_RESYNC:
1468         /* We don't reset the result here because we don't push the event
1469          * again on pads that got the event already and because we need
1470          * to consider the result of the previous pushes */
1471         gst_iterator_resync (iter);
1472         break;
1473       case GST_ITERATOR_ERROR:
1474         GST_ERROR_OBJECT (pad, "Could not iterate over sinkpads");
1475         done = TRUE;
1476         break;
1477       case GST_ITERATOR_DONE:
1478         done = TRUE;
1479         break;
1480     }
1481   }
1482   g_value_unset (&item);
1483   gst_iterator_free (iter);
1484
1485   g_list_free (pushed_pads);
1486
1487   gst_event_unref (event);
1488
1489   return result;
1490 }
1491
1492 /* query on the srcpad. We override this function because by default it will
1493  * only forward the query to one random sinkpad */
1494 static gboolean
1495 gst_input_selector_query (GstPad * pad, GstObject * parent, GstQuery * query)
1496 {
1497   gboolean res = FALSE;
1498   GstInputSelector *sel;
1499
1500   sel = GST_INPUT_SELECTOR (parent);
1501
1502   switch (GST_QUERY_TYPE (query)) {
1503     case GST_QUERY_LATENCY:
1504     {
1505       GList *walk;
1506       GstClockTime resmin, resmax;
1507       gboolean reslive;
1508
1509       resmin = 0;
1510       resmax = -1;
1511       reslive = FALSE;
1512
1513       /* perform the query on all sinkpads and combine the results. We take the
1514        * max of min and the min of max for the result latency. */
1515       GST_INPUT_SELECTOR_LOCK (sel);
1516       for (walk = GST_ELEMENT_CAST (sel)->sinkpads; walk;
1517           walk = g_list_next (walk)) {
1518         GstPad *sinkpad = GST_PAD_CAST (walk->data);
1519
1520         if (gst_pad_peer_query (sinkpad, query)) {
1521           GstClockTime min, max;
1522           gboolean live;
1523
1524           /* one query succeeded, we succeed too */
1525           res = TRUE;
1526
1527           gst_query_parse_latency (query, &live, &min, &max);
1528
1529           GST_DEBUG_OBJECT (sinkpad,
1530               "peer latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
1531               ", live %d", GST_TIME_ARGS (min), GST_TIME_ARGS (max), live);
1532
1533           if (live) {
1534             if (min > resmin)
1535               resmin = min;
1536             if (resmax == -1)
1537               resmax = max;
1538             else if (max < resmax)
1539               resmax = max;
1540             if (reslive == FALSE)
1541               reslive = live;
1542           }
1543         }
1544       }
1545       GST_INPUT_SELECTOR_UNLOCK (sel);
1546       if (res) {
1547         gst_query_set_latency (query, reslive, resmin, resmax);
1548
1549         GST_DEBUG_OBJECT (sel,
1550             "total latency min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT
1551             ", live %d", GST_TIME_ARGS (resmin), GST_TIME_ARGS (resmax),
1552             reslive);
1553       }
1554
1555       break;
1556     }
1557     default:
1558       res = gst_pad_query_default (pad, parent, query);
1559       break;
1560   }
1561
1562   return res;
1563 }
1564
1565 /* check if the pad is the active sinkpad */
1566 static inline gboolean
1567 gst_input_selector_is_active_sinkpad (GstInputSelector * sel, GstPad * pad)
1568 {
1569   gboolean res;
1570
1571   GST_INPUT_SELECTOR_LOCK (sel);
1572   res = (pad == sel->active_sinkpad);
1573   GST_INPUT_SELECTOR_UNLOCK (sel);
1574
1575   return res;
1576 }
1577
1578 /* Get or create the active sinkpad, must be called with SELECTOR_LOCK */
1579 static GstPad *
1580 gst_input_selector_activate_sinkpad (GstInputSelector * sel, GstPad * pad)
1581 {
1582   GstPad *active_sinkpad;
1583   GstSelectorPad *selpad;
1584
1585   selpad = GST_SELECTOR_PAD_CAST (pad);
1586
1587   selpad->active = TRUE;
1588   active_sinkpad = sel->active_sinkpad;
1589   if (active_sinkpad == NULL) {
1590     /* first pad we get activity on becomes the activated pad by default */
1591     if (sel->active_sinkpad)
1592       gst_object_unref (sel->active_sinkpad);
1593     active_sinkpad = sel->active_sinkpad = gst_object_ref (pad);
1594     GST_DEBUG_OBJECT (sel, "Activating pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1595   }
1596
1597   return active_sinkpad;
1598 }
1599
1600 static GstPad *
1601 gst_input_selector_request_new_pad (GstElement * element,
1602     GstPadTemplate * templ, const gchar * unused, const GstCaps * caps)
1603 {
1604   GstInputSelector *sel;
1605   gchar *name = NULL;
1606   GstPad *sinkpad = NULL;
1607
1608   g_return_val_if_fail (templ->direction == GST_PAD_SINK, NULL);
1609
1610   sel = GST_INPUT_SELECTOR (element);
1611
1612   GST_INPUT_SELECTOR_LOCK (sel);
1613
1614   GST_LOG_OBJECT (sel, "Creating new pad %d", sel->padcount);
1615   name = g_strdup_printf ("sink_%u", sel->padcount++);
1616   sinkpad = g_object_new (GST_TYPE_SELECTOR_PAD,
1617       "name", name, "direction", templ->direction, "template", templ, NULL);
1618   g_free (name);
1619
1620   sel->n_pads++;
1621
1622   gst_pad_set_event_function (sinkpad,
1623       GST_DEBUG_FUNCPTR (gst_selector_pad_event));
1624   gst_pad_set_query_function (sinkpad,
1625       GST_DEBUG_FUNCPTR (gst_selector_pad_query));
1626   gst_pad_set_chain_function (sinkpad,
1627       GST_DEBUG_FUNCPTR (gst_selector_pad_chain));
1628   gst_pad_set_iterate_internal_links_function (sinkpad,
1629       GST_DEBUG_FUNCPTR (gst_selector_pad_iterate_linked_pads));
1630
1631   GST_OBJECT_FLAG_SET (sinkpad, GST_PAD_FLAG_PROXY_CAPS);
1632   GST_OBJECT_FLAG_SET (sinkpad, GST_PAD_FLAG_PROXY_ALLOCATION);
1633   gst_pad_set_active (sinkpad, TRUE);
1634   gst_element_add_pad (GST_ELEMENT (sel), sinkpad);
1635   GST_INPUT_SELECTOR_UNLOCK (sel);
1636
1637   return sinkpad;
1638 }
1639
1640 static void
1641 gst_input_selector_release_pad (GstElement * element, GstPad * pad)
1642 {
1643   GstInputSelector *sel;
1644
1645   sel = GST_INPUT_SELECTOR (element);
1646   GST_LOG_OBJECT (sel, "Releasing pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1647
1648   GST_INPUT_SELECTOR_LOCK (sel);
1649   /* if the pad was the active pad, makes us select a new one */
1650   if (sel->active_sinkpad == pad) {
1651     GST_DEBUG_OBJECT (sel, "Deactivating pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1652     gst_object_unref (sel->active_sinkpad);
1653     sel->active_sinkpad = NULL;
1654   }
1655   sel->n_pads--;
1656
1657   gst_pad_set_active (pad, FALSE);
1658   gst_element_remove_pad (GST_ELEMENT (sel), pad);
1659   GST_INPUT_SELECTOR_UNLOCK (sel);
1660 }
1661
1662 static void
1663 gst_input_selector_reset (GstInputSelector * sel)
1664 {
1665   GList *walk;
1666
1667   GST_INPUT_SELECTOR_LOCK (sel);
1668   /* clear active pad */
1669   if (sel->active_sinkpad) {
1670     gst_object_unref (sel->active_sinkpad);
1671     sel->active_sinkpad = NULL;
1672   }
1673   /* reset each of our sinkpads state */
1674   for (walk = GST_ELEMENT_CAST (sel)->sinkpads; walk; walk = g_list_next (walk)) {
1675     GstSelectorPad *selpad = GST_SELECTOR_PAD_CAST (walk->data);
1676
1677     gst_selector_pad_reset (selpad);
1678
1679     if (selpad->tags) {
1680       gst_tag_list_unref (selpad->tags);
1681       selpad->tags = NULL;
1682     }
1683   }
1684   GST_INPUT_SELECTOR_UNLOCK (sel);
1685 }
1686
1687 static GstStateChangeReturn
1688 gst_input_selector_change_state (GstElement * element,
1689     GstStateChange transition)
1690 {
1691   GstInputSelector *self = GST_INPUT_SELECTOR (element);
1692   GstStateChangeReturn result;
1693
1694   switch (transition) {
1695     case GST_STATE_CHANGE_READY_TO_PAUSED:
1696       GST_INPUT_SELECTOR_LOCK (self);
1697       self->blocked = FALSE;
1698       self->flushing = FALSE;
1699       GST_INPUT_SELECTOR_UNLOCK (self);
1700       break;
1701     case GST_STATE_CHANGE_PAUSED_TO_READY:
1702       /* first unlock before we call the parent state change function, which
1703        * tries to acquire the stream lock when going to ready. */
1704       GST_INPUT_SELECTOR_LOCK (self);
1705       self->blocked = FALSE;
1706       self->flushing = TRUE;
1707       GST_INPUT_SELECTOR_BROADCAST (self);
1708       GST_INPUT_SELECTOR_UNLOCK (self);
1709       break;
1710     default:
1711       break;
1712   }
1713
1714   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1715
1716   switch (transition) {
1717     case GST_STATE_CHANGE_PAUSED_TO_READY:
1718       gst_input_selector_reset (self);
1719       break;
1720     default:
1721       break;
1722   }
1723
1724   return result;
1725 }
1726
1727 static gint64
1728 gst_input_selector_block (GstInputSelector * self)
1729 {
1730   gint64 ret = 0;
1731   GstSelectorPad *spad;
1732
1733   GST_INPUT_SELECTOR_LOCK (self);
1734
1735   if (self->blocked)
1736     GST_WARNING_OBJECT (self, "switch already blocked");
1737
1738   self->blocked = TRUE;
1739   spad = GST_SELECTOR_PAD_CAST (self->active_sinkpad);
1740
1741   if (spad)
1742     ret = gst_selector_pad_get_running_time (spad);
1743   else
1744     GST_DEBUG_OBJECT (self, "no active pad while blocking");
1745
1746   GST_INPUT_SELECTOR_UNLOCK (self);
1747
1748   return ret;
1749 }