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