gst: Remove dead assignments and resulting unused variables
[platform/upstream/gstreamer.git] / gst / adder / gstadder.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2001 Thomas <thomas@apestaart.org>
4  *               2005,2006 Wim Taymans <wim@fluendo.com>
5  *
6  * adder.c: Adder element, N in, one out, samples are added
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 /**
24  * SECTION:element-adder
25  *
26  * The adder allows to mix several streams into one by adding the data.
27  * Mixed data is clamped to the min/max values of the data format.
28  *
29  * The adder currently mixes all data received on the sinkpads as soon as
30  * possible without trying to synchronize the streams.
31  *
32  * <refsect2>
33  * <title>Example launch line</title>
34  * |[
35  * gst-launch audiotestsrc freq=100 ! adder name=mix ! audioconvert ! alsasink audiotestsrc freq=500 ! mix.
36  * ]| This pipeline produces two sine waves mixed together.
37  * </refsect2>
38  *
39  * Last reviewed on 2006-05-09 (0.10.7)
40  */
41 /* Element-Checklist-Version: 5 */
42
43 #ifdef HAVE_CONFIG_H
44 #include "config.h"
45 #endif
46 #include "gstadder.h"
47 #include <gst/audio/audio.h>
48 #include <string.h>             /* strcmp */
49 /*#include <liboil/liboil.h>*/
50
51 /* highest positive/lowest negative x-bit value we can use for clamping */
52 #define MAX_INT_32  ((gint32) (0x7fffffff))
53 #define MAX_INT_16  ((gint16) (0x7fff))
54 #define MAX_INT_8   ((gint8)  (0x7f))
55 #define MAX_UINT_32 ((guint32)(0xffffffff))
56 #define MAX_UINT_16 ((guint16)(0xffff))
57 #define MAX_UINT_8  ((guint8) (0xff))
58
59 #define MIN_INT_32  ((gint32) (0x80000000))
60 #define MIN_INT_16  ((gint16) (0x8000))
61 #define MIN_INT_8   ((gint8)  (0x80))
62 #define MIN_UINT_32 ((guint32)(0x00000000))
63 #define MIN_UINT_16 ((guint16)(0x0000))
64 #define MIN_UINT_8  ((guint8) (0x00))
65
66 enum
67 {
68   PROP_0,
69   PROP_FILTER_CAPS
70 };
71
72 #define GST_CAT_DEFAULT gst_adder_debug
73 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
74
75 /* elementfactory information */
76
77 #define CAPS \
78   "audio/x-raw-int, " \
79   "rate = (int) [ 1, MAX ], " \
80   "channels = (int) [ 1, MAX ], " \
81   "endianness = (int) BYTE_ORDER, " \
82   "width = (int) 32, " \
83   "depth = (int) 32, " \
84   "signed = (boolean) { true, false } ;" \
85   "audio/x-raw-int, " \
86   "rate = (int) [ 1, MAX ], " \
87   "channels = (int) [ 1, MAX ], " \
88   "endianness = (int) BYTE_ORDER, " \
89   "width = (int) 16, " \
90   "depth = (int) 16, " \
91   "signed = (boolean) { true, false } ;" \
92   "audio/x-raw-int, " \
93   "rate = (int) [ 1, MAX ], " \
94   "channels = (int) [ 1, MAX ], " \
95   "endianness = (int) BYTE_ORDER, " \
96   "width = (int) 8, " \
97   "depth = (int) 8, " \
98   "signed = (boolean) { true, false } ;" \
99   "audio/x-raw-float, " \
100   "rate = (int) [ 1, MAX ], " \
101   "channels = (int) [ 1, MAX ], " \
102   "endianness = (int) BYTE_ORDER, " \
103   "width = (int) { 32, 64 }"
104
105 static GstStaticPadTemplate gst_adder_src_template =
106 GST_STATIC_PAD_TEMPLATE ("src",
107     GST_PAD_SRC,
108     GST_PAD_ALWAYS,
109     GST_STATIC_CAPS (CAPS)
110     );
111
112 static GstStaticPadTemplate gst_adder_sink_template =
113 GST_STATIC_PAD_TEMPLATE ("sink%d",
114     GST_PAD_SINK,
115     GST_PAD_REQUEST,
116     GST_STATIC_CAPS (CAPS)
117     );
118
119 static void gst_adder_class_init (GstAdderClass * klass);
120 static void gst_adder_init (GstAdder * adder);
121 static void gst_adder_dispose (GObject * object);
122 static void gst_adder_set_property (GObject * object, guint prop_id,
123     const GValue * value, GParamSpec * pspec);
124 static void gst_adder_get_property (GObject * object, guint prop_id,
125     GValue * value, GParamSpec * pspec);
126
127 static gboolean gst_adder_setcaps (GstPad * pad, GstCaps * caps);
128 static gboolean gst_adder_query (GstPad * pad, GstQuery * query);
129 static gboolean gst_adder_src_event (GstPad * pad, GstEvent * event);
130 static gboolean gst_adder_sink_event (GstPad * pad, GstEvent * event);
131
132 static GstPad *gst_adder_request_new_pad (GstElement * element,
133     GstPadTemplate * temp, const gchar * unused);
134 static void gst_adder_release_pad (GstElement * element, GstPad * pad);
135
136 static GstStateChangeReturn gst_adder_change_state (GstElement * element,
137     GstStateChange transition);
138
139 static GstFlowReturn gst_adder_collected (GstCollectPads * pads,
140     gpointer user_data);
141
142 static GstElementClass *parent_class = NULL;
143
144 GType
145 gst_adder_get_type (void)
146 {
147   static GType adder_type = 0;
148
149   if (G_UNLIKELY (adder_type == 0)) {
150     static const GTypeInfo adder_info = {
151       sizeof (GstAdderClass), NULL, NULL,
152       (GClassInitFunc) gst_adder_class_init, NULL, NULL,
153       sizeof (GstAdder), 0,
154       (GInstanceInitFunc) gst_adder_init,
155     };
156
157     adder_type = g_type_register_static (GST_TYPE_ELEMENT, "GstAdder",
158         &adder_info, 0);
159     GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "adder", 0,
160         "audio channel mixing element");
161   }
162   return adder_type;
163 }
164
165 /* clipping versions (for int)
166  * FIXME: what about: oil_add_s16 (out, out, in, bytes / sizeof (type))
167  */
168 #define MAKE_FUNC(name,type,ttype,min,max)                      \
169 static void name (type *out, type *in, gint bytes) {            \
170   gint i;                                                       \
171   ttype add;                                                    \
172   for (i = 0; i < bytes / sizeof (type); i++) {                 \
173     add = (ttype)out[i] + (ttype)in[i];                         \
174     out[i] = CLAMP (add, min, max);                             \
175   }                                                             \
176 }
177
178 /* unsigned versions (for int) */
179 #define MAKE_FUNC_US(name,type,ttype,max)                       \
180 static void name (type *out, type *in, gint bytes) {            \
181   gint i;                                                       \
182   ttype add;                                                    \
183   for (i = 0; i < bytes / sizeof (type); i++) {                 \
184     add = (ttype)out[i] + (ttype)in[i];                         \
185     out[i] = ((add <= max) ? add : max);                        \
186   }                                                             \
187 }
188
189 /* non-clipping versions (for float) */
190 #define MAKE_FUNC_NC(name,type)                                 \
191 static void name (type *out, type *in, gint bytes) {            \
192   gint i;                                                       \
193   for (i = 0; i < bytes / sizeof (type); i++)                   \
194     out[i] += in[i];                                            \
195 }
196
197 #if 0
198 /* right now, the liboil function don't seems to be faster on x86
199  * time gst-launch audiotestsrc num-buffers=50000 ! audio/x-raw-float ! adder name=m ! fakesink audiotestsrc num-buffers=50000 ! audio/x-raw-float ! m.
200  * time gst-launch audiotestsrc num-buffers=50000 ! audio/x-raw-float,width=32 ! adder name=m ! fakesink audiotestsrc num-buffers=50000 ! audio/x-raw-float,width=32 ! m.
201  */
202 static void
203 add_float32 (gfloat * out, gfloat * in, gint bytes)
204 {
205   oil_add_f32 (out, out, in, bytes / sizeof (gfloat));
206 }
207
208 static void
209 add_float64 (gdouble * out, gdouble * in, gint bytes)
210 {
211   oil_add_f64 (out, out, in, bytes / sizeof (gdouble));
212 }
213 #endif
214
215 /* *INDENT-OFF* */
216 MAKE_FUNC (add_int32, gint32, gint64, MIN_INT_32, MAX_INT_32)
217 MAKE_FUNC (add_int16, gint16, gint32, MIN_INT_16, MAX_INT_16)
218 MAKE_FUNC (add_int8, gint8, gint16, MIN_INT_8, MAX_INT_8)
219 MAKE_FUNC_US (add_uint32, guint32, guint64, MAX_UINT_32)
220 MAKE_FUNC_US (add_uint16, guint16, guint32, MAX_UINT_16)
221 MAKE_FUNC_US (add_uint8, guint8, guint16, MAX_UINT_8)
222 MAKE_FUNC_NC (add_float64, gdouble)
223 MAKE_FUNC_NC (add_float32, gfloat)
224 /* *INDENT-ON* */
225
226 /* we can only accept caps that we and downstream can handle.
227  * if we have filtercaps set, use those to constrain the target caps.
228  */
229 static GstCaps *
230 gst_adder_sink_getcaps (GstPad * pad)
231 {
232   GstAdder *adder;
233   GstCaps *result, *peercaps, *sinkcaps;
234
235   adder = GST_ADDER (GST_PAD_PARENT (pad));
236
237   GST_OBJECT_LOCK (adder);
238   /* get the downstream possible caps */
239   peercaps = gst_pad_peer_get_caps (adder->srcpad);
240
241   /* get the allowed caps on this sinkpad, we use the fixed caps function so
242    * that it does not call recursively in this function. */
243   sinkcaps = gst_pad_get_fixed_caps_func (pad);
244   if (peercaps) {
245     /* restrict with filter-caps if any */
246     if (adder->filter_caps) {
247       result = gst_caps_intersect (peercaps, adder->filter_caps);
248       gst_caps_unref (peercaps);
249       peercaps = result;
250     }
251     /* if the peer has caps, intersect */
252     GST_DEBUG_OBJECT (adder, "intersecting peer and template caps");
253     result = gst_caps_intersect (peercaps, sinkcaps);
254     gst_caps_unref (peercaps);
255     gst_caps_unref (sinkcaps);
256   } else {
257     /* the peer has no caps (or there is no peer), just use the allowed caps
258      * of this sinkpad. */
259     GST_DEBUG_OBJECT (adder, "no peer caps, using sinkcaps");
260     result = sinkcaps;
261   }
262   GST_OBJECT_UNLOCK (adder);
263
264   GST_LOG_OBJECT (adder, "getting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
265       GST_PAD_NAME (pad), result);
266
267   return result;
268 }
269
270 /* the first caps we receive on any of the sinkpads will define the caps for all
271  * the other sinkpads because we can only mix streams with the same caps.
272  */
273 static gboolean
274 gst_adder_setcaps (GstPad * pad, GstCaps * caps)
275 {
276   GstAdder *adder;
277   GList *pads;
278   GstStructure *structure;
279   const char *media_type;
280
281   adder = GST_ADDER (GST_PAD_PARENT (pad));
282
283   GST_LOG_OBJECT (adder, "setting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
284       GST_PAD_NAME (pad), caps);
285
286   /* FIXME, see if the other pads can accept the format. Also lock the
287    * format on the other pads to this new format. */
288   GST_OBJECT_LOCK (adder);
289   pads = GST_ELEMENT (adder)->pads;
290   while (pads) {
291     GstPad *otherpad = GST_PAD (pads->data);
292
293     if (otherpad != pad) {
294       gst_caps_replace (&GST_PAD_CAPS (otherpad), caps);
295     }
296     pads = g_list_next (pads);
297   }
298   GST_OBJECT_UNLOCK (adder);
299
300   /* parse caps now */
301   structure = gst_caps_get_structure (caps, 0);
302   media_type = gst_structure_get_name (structure);
303   if (strcmp (media_type, "audio/x-raw-int") == 0) {
304     adder->format = GST_ADDER_FORMAT_INT;
305     gst_structure_get_int (structure, "width", &adder->width);
306     gst_structure_get_int (structure, "depth", &adder->depth);
307     gst_structure_get_int (structure, "endianness", &adder->endianness);
308     gst_structure_get_boolean (structure, "signed", &adder->is_signed);
309
310     GST_INFO_OBJECT (pad, "parse_caps sets adder to format int, %d bit",
311         adder->width);
312
313     if (adder->endianness != G_BYTE_ORDER)
314       goto not_supported;
315
316     switch (adder->width) {
317       case 8:
318         adder->func = (adder->is_signed ?
319             (GstAdderFunction) add_int8 : (GstAdderFunction) add_uint8);
320         break;
321       case 16:
322         adder->func = (adder->is_signed ?
323             (GstAdderFunction) add_int16 : (GstAdderFunction) add_uint16);
324         break;
325       case 32:
326         adder->func = (adder->is_signed ?
327             (GstAdderFunction) add_int32 : (GstAdderFunction) add_uint32);
328         break;
329       default:
330         goto not_supported;
331     }
332   } else if (strcmp (media_type, "audio/x-raw-float") == 0) {
333     adder->format = GST_ADDER_FORMAT_FLOAT;
334     gst_structure_get_int (structure, "width", &adder->width);
335     gst_structure_get_int (structure, "endianness", &adder->endianness);
336
337     GST_INFO_OBJECT (pad, "parse_caps sets adder to format float, %d bit",
338         adder->width);
339
340     if (adder->endianness != G_BYTE_ORDER)
341       goto not_supported;
342
343     switch (adder->width) {
344       case 32:
345         adder->func = (GstAdderFunction) add_float32;
346         break;
347       case 64:
348         adder->func = (GstAdderFunction) add_float64;
349         break;
350       default:
351         goto not_supported;
352     }
353   } else {
354     goto not_supported;
355   }
356
357   gst_structure_get_int (structure, "channels", &adder->channels);
358   gst_structure_get_int (structure, "rate", &adder->rate);
359   /* precalc bps */
360   adder->bps = (adder->width / 8) * adder->channels;
361
362   return TRUE;
363
364   /* ERRORS */
365 not_supported:
366   {
367     GST_DEBUG_OBJECT (adder, "unsupported format set as caps");
368     return FALSE;
369   }
370 }
371
372 /* FIXME, the duration query should reflect how long you will produce
373  * data, that is the amount of stream time until you will emit EOS.
374  *
375  * For synchronized mixing this is always the max of all the durations
376  * of upstream since we emit EOS when all of them finished.
377  *
378  * We don't do synchronized mixing so this really depends on where the
379  * streams where punched in and what their relative offsets are against
380  * eachother which we can get from the first timestamps we see.
381  *
382  * When we add a new stream (or remove a stream) the duration might
383  * also become invalid again and we need to post a new DURATION
384  * message to notify this fact to the parent.
385  * For now we take the max of all the upstream elements so the simple
386  * cases work at least somewhat.
387  */
388 static gboolean
389 gst_adder_query_duration (GstAdder * adder, GstQuery * query)
390 {
391   gint64 max;
392   gboolean res;
393   GstFormat format;
394   GstIterator *it;
395   gboolean done;
396
397   /* parse format */
398   gst_query_parse_duration (query, &format, NULL);
399
400   max = -1;
401   res = TRUE;
402   done = FALSE;
403
404   it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
405   while (!done) {
406     GstIteratorResult ires;
407
408     gpointer item;
409
410     ires = gst_iterator_next (it, &item);
411     switch (ires) {
412       case GST_ITERATOR_DONE:
413         done = TRUE;
414         break;
415       case GST_ITERATOR_OK:
416       {
417         GstPad *pad = GST_PAD_CAST (item);
418
419         gint64 duration;
420
421         /* ask sink peer for duration */
422         res &= gst_pad_query_peer_duration (pad, &format, &duration);
423         /* take max from all valid return values */
424         if (res) {
425           /* valid unknown length, stop searching */
426           if (duration == -1) {
427             max = duration;
428             done = TRUE;
429           }
430           /* else see if bigger than current max */
431           else if (duration > max)
432             max = duration;
433         }
434         gst_object_unref (pad);
435         break;
436       }
437       case GST_ITERATOR_RESYNC:
438         max = -1;
439         res = TRUE;
440         gst_iterator_resync (it);
441         break;
442       default:
443         res = FALSE;
444         done = TRUE;
445         break;
446     }
447   }
448   gst_iterator_free (it);
449
450   if (res) {
451     /* and store the max */
452     GST_DEBUG_OBJECT (adder, "Total duration in format %s: %"
453         GST_TIME_FORMAT, gst_format_get_name (format), GST_TIME_ARGS (max));
454     gst_query_set_duration (query, format, max);
455   }
456
457   return res;
458 }
459
460 static gboolean
461 gst_adder_query_latency (GstAdder * adder, GstQuery * query)
462 {
463   GstClockTime min, max;
464   gboolean live;
465   gboolean res;
466   GstIterator *it;
467   gboolean done;
468
469   res = TRUE;
470   done = FALSE;
471
472   live = FALSE;
473   min = 0;
474   max = GST_CLOCK_TIME_NONE;
475
476   /* Take maximum of all latency values */
477   it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
478   while (!done) {
479     GstIteratorResult ires;
480
481     gpointer item;
482
483     ires = gst_iterator_next (it, &item);
484     switch (ires) {
485       case GST_ITERATOR_DONE:
486         done = TRUE;
487         break;
488       case GST_ITERATOR_OK:
489       {
490         GstPad *pad = GST_PAD_CAST (item);
491         GstQuery *peerquery;
492         GstClockTime min_cur, max_cur;
493         gboolean live_cur;
494
495         peerquery = gst_query_new_latency ();
496
497         /* Ask peer for latency */
498         res &= gst_pad_peer_query (pad, peerquery);
499
500         /* take max from all valid return values */
501         if (res) {
502           gst_query_parse_latency (peerquery, &live_cur, &min_cur, &max_cur);
503
504           if (min_cur > min)
505             min = min_cur;
506
507           if (max_cur != GST_CLOCK_TIME_NONE &&
508               ((max != GST_CLOCK_TIME_NONE && max_cur > max) ||
509                   (max == GST_CLOCK_TIME_NONE)))
510             max = max_cur;
511
512           live = live || live_cur;
513         }
514
515         gst_query_unref (peerquery);
516         gst_object_unref (pad);
517         break;
518       }
519       case GST_ITERATOR_RESYNC:
520         live = FALSE;
521         min = 0;
522         max = GST_CLOCK_TIME_NONE;
523         res = TRUE;
524         gst_iterator_resync (it);
525         break;
526       default:
527         res = FALSE;
528         done = TRUE;
529         break;
530     }
531   }
532   gst_iterator_free (it);
533
534   if (res) {
535     /* store the results */
536     GST_DEBUG_OBJECT (adder, "Calculated total latency: live %s, min %"
537         GST_TIME_FORMAT ", max %" GST_TIME_FORMAT,
538         (live ? "yes" : "no"), GST_TIME_ARGS (min), GST_TIME_ARGS (max));
539     gst_query_set_latency (query, live, min, max);
540   }
541
542   return res;
543 }
544
545 static gboolean
546 gst_adder_query (GstPad * pad, GstQuery * query)
547 {
548   GstAdder *adder = GST_ADDER (gst_pad_get_parent (pad));
549   gboolean res = FALSE;
550
551   switch (GST_QUERY_TYPE (query)) {
552     case GST_QUERY_POSITION:
553     {
554       GstFormat format;
555
556       gst_query_parse_position (query, &format, NULL);
557
558       switch (format) {
559         case GST_FORMAT_TIME:
560           /* FIXME, bring to stream time, might be tricky */
561           gst_query_set_position (query, format, adder->timestamp);
562           res = TRUE;
563           break;
564         case GST_FORMAT_DEFAULT:
565           gst_query_set_position (query, format, adder->offset);
566           res = TRUE;
567           break;
568         default:
569           break;
570       }
571       break;
572     }
573     case GST_QUERY_DURATION:
574       res = gst_adder_query_duration (adder, query);
575       break;
576     case GST_QUERY_LATENCY:
577       res = gst_adder_query_latency (adder, query);
578       break;
579     default:
580       /* FIXME, needs a custom query handler because we have multiple
581        * sinkpads */
582       res = gst_pad_query_default (pad, query);
583       break;
584   }
585
586   gst_object_unref (adder);
587   return res;
588 }
589
590 typedef struct
591 {
592   GstEvent *event;
593   gboolean flush;
594 } EventData;
595
596 static gboolean
597 forward_event_func (GstPad * pad, GValue * ret, EventData * data)
598 {
599   GstEvent *event = data->event;
600
601   gst_event_ref (event);
602   GST_LOG_OBJECT (pad, "About to send event %s", GST_EVENT_TYPE_NAME (event));
603   if (!gst_pad_push_event (pad, event)) {
604     g_value_set_boolean (ret, FALSE);
605     GST_WARNING_OBJECT (pad, "Sending event  %p (%s) failed.",
606         event, GST_EVENT_TYPE_NAME (event));
607     /* quick hack to unflush the pads, ideally we need a way to just unflush
608      * this single collect pad */
609     if (data->flush)
610       gst_pad_send_event (pad, gst_event_new_flush_stop ());
611   } else {
612     GST_LOG_OBJECT (pad, "Sent event  %p (%s).",
613         event, GST_EVENT_TYPE_NAME (event));
614   }
615   gst_object_unref (pad);
616
617   /* continue on other pads, even if one failed */
618   return TRUE;
619 }
620
621 /* forwards the event to all sinkpads, takes ownership of the
622  * event
623  *
624  * Returns: TRUE if the event could be forwarded on all
625  * sinkpads.
626  */
627 static gboolean
628 forward_event (GstAdder * adder, GstEvent * event, gboolean flush)
629 {
630   gboolean ret;
631   GstIterator *it;
632   GstIteratorResult ires;
633   GValue vret = { 0 };
634   EventData data;
635
636   GST_LOG_OBJECT (adder, "Forwarding event %p (%s)", event,
637       GST_EVENT_TYPE_NAME (event));
638
639   data.event = event;
640   data.flush = flush;
641
642   g_value_init (&vret, G_TYPE_BOOLEAN);
643   g_value_set_boolean (&vret, TRUE);
644   it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
645   while (TRUE) {
646     ires = gst_iterator_fold (it, (GstIteratorFoldFunction) forward_event_func,
647         &vret, &data);
648     switch (ires) {
649       case GST_ITERATOR_RESYNC:
650         GST_WARNING ("resync");
651         gst_iterator_resync (it);
652         g_value_set_boolean (&vret, TRUE);
653         break;
654       case GST_ITERATOR_OK:
655       case GST_ITERATOR_DONE:
656         ret = g_value_get_boolean (&vret);
657         goto done;
658       default:
659         ret = FALSE;
660         goto done;
661     }
662   }
663 done:
664   gst_iterator_free (it);
665   GST_LOG_OBJECT (adder, "Forwarded event %p (%s), ret=%d", event,
666       GST_EVENT_TYPE_NAME (event), ret);
667   gst_event_unref (event);
668
669   return ret;
670 }
671
672 static gboolean
673 gst_adder_src_event (GstPad * pad, GstEvent * event)
674 {
675   GstAdder *adder;
676   gboolean result;
677
678   adder = GST_ADDER (gst_pad_get_parent (pad));
679
680   switch (GST_EVENT_TYPE (event)) {
681     case GST_EVENT_SEEK:
682     {
683       GstSeekFlags flags;
684       GstSeekType curtype;
685       gint64 cur;
686       gboolean flush;
687
688       /* parse the seek parameters */
689       gst_event_parse_seek (event, &adder->segment_rate, NULL, &flags, &curtype,
690           &cur, NULL, NULL);
691
692       flush = (flags & GST_SEEK_FLAG_FLUSH) == GST_SEEK_FLAG_FLUSH;
693
694       /* check if we are flushing */
695       if (flush) {
696         /* make sure we accept nothing anymore and return WRONG_STATE */
697         gst_collect_pads_set_flushing (adder->collect, TRUE);
698
699         /* flushing seek, start flush downstream, the flush will be done
700          * when all pads received a FLUSH_STOP. */
701         gst_pad_push_event (adder->srcpad, gst_event_new_flush_start ());
702       }
703       GST_DEBUG_OBJECT (adder, "handling seek event: %" GST_PTR_FORMAT, event);
704
705       /* now wait for the collected to be finished and mark a new
706        * segment. After we have the lock, no collect function is running and no
707        * new collect function will be called for as long as we're flushing. */
708       GST_OBJECT_LOCK (adder->collect);
709       if (curtype == GST_SEEK_TYPE_SET)
710         adder->segment_position = cur;
711       else
712         adder->segment_position = 0;
713       /* make sure we push a new segment, to inform about new basetime
714        * see FIXME in gst_adder_collected() */
715       adder->segment_pending = TRUE;
716       if (flush) {
717         /* Yes, we need to call _set_flushing again *WHEN* the streaming threads
718          * have stopped so that the cookie gets properly updated. */
719         gst_collect_pads_set_flushing (adder->collect, TRUE);
720       }
721       /* we might have a pending flush_stop event now. This event will either be
722        * sent by an upstream element when it completes the seek or we will push
723        * one in the collected callback ourself */
724       adder->flush_stop_pending = flush;
725       GST_OBJECT_UNLOCK (adder->collect);
726       GST_DEBUG_OBJECT (adder, "forwarding seek event: %" GST_PTR_FORMAT,
727           event);
728
729       result = forward_event (adder, event, flush);
730       if (!result) {
731         /* seek failed. maybe source is a live source. */
732         GST_DEBUG_OBJECT (adder, "seeking failed");
733       }
734       /* FIXME: ideally we would like to send a flush-stop event from here but
735        * collectpads does not have a method that allows us to do that. Instead
736        * we forward all flush-stop events we receive on the sinkpads. We might
737        * be sending too many flush-stop events. */
738       break;
739     }
740     case GST_EVENT_QOS:
741       /* QoS might be tricky */
742       result = FALSE;
743       break;
744     case GST_EVENT_NAVIGATION:
745       /* navigation is rather pointless. */
746       result = FALSE;
747       break;
748     default:
749       /* just forward the rest for now */
750       GST_DEBUG_OBJECT (adder, "forward unhandled event: %s",
751           GST_EVENT_TYPE_NAME (event));
752       result = forward_event (adder, event, FALSE);
753       break;
754   }
755   gst_object_unref (adder);
756
757   return result;
758 }
759
760 static gboolean
761 gst_adder_sink_event (GstPad * pad, GstEvent * event)
762 {
763   GstAdder *adder;
764   gboolean ret = TRUE;
765
766   adder = GST_ADDER (gst_pad_get_parent (pad));
767
768   GST_DEBUG ("Got %s event on pad %s:%s", GST_EVENT_TYPE_NAME (event),
769       GST_DEBUG_PAD_NAME (pad));
770
771   switch (GST_EVENT_TYPE (event)) {
772     case GST_EVENT_FLUSH_STOP:
773       /* we received a flush-stop. The collect_event function will push the
774        * event past our element. We simply forward all flush-stop events, even
775        * when no flush-stop was pendingk, this is required because collectpads
776        * does not provide an API to handle-but-not-forward the flush-stop.
777        * We unset the pending flush-stop flag so that we don't send anymore
778        * flush-stop from the collect function later.
779        */
780       GST_OBJECT_LOCK (adder->collect);
781       adder->segment_pending = TRUE;
782       adder->flush_stop_pending = FALSE;
783       /* Clear pending tags */
784       if (adder->pending_events) {
785         g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
786         g_list_free (adder->pending_events);
787         adder->pending_events = NULL;
788       }
789       GST_OBJECT_UNLOCK (adder->collect);
790       break;
791     case GST_EVENT_TAG:
792       GST_OBJECT_LOCK (adder->collect);
793       /* collectpads is a pile of horse manure. */
794       adder->pending_events = g_list_append (adder->pending_events, event);
795       GST_OBJECT_UNLOCK (adder->collect);
796       goto beach;
797     default:
798       break;
799   }
800
801   /* now GstCollectPads can take care of the rest, e.g. EOS */
802   ret = adder->collect_event (pad, event);
803
804 beach:
805   gst_object_unref (adder);
806   return ret;
807 }
808
809 static void
810 gst_adder_class_init (GstAdderClass * klass)
811 {
812   GObjectClass *gobject_class = (GObjectClass *) klass;
813   GstElementClass *gstelement_class = (GstElementClass *) klass;
814
815   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_adder_set_property);
816   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_adder_get_property);
817   gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_adder_dispose);
818
819   gst_element_class_add_pad_template (gstelement_class,
820       gst_static_pad_template_get (&gst_adder_src_template));
821   gst_element_class_add_pad_template (gstelement_class,
822       gst_static_pad_template_get (&gst_adder_sink_template));
823   gst_element_class_set_details_simple (gstelement_class, "Adder",
824       "Generic/Audio",
825       "Add N audio channels together",
826       "Thomas Vander Stichele <thomas at apestaart dot org>");
827
828   parent_class = g_type_class_peek_parent (klass);
829
830   /**
831    * GstAdder:caps:
832    *
833    * Since: 0.10.24
834    */
835   g_object_class_install_property (gobject_class, PROP_FILTER_CAPS,
836       g_param_spec_boxed ("caps", "Target caps",
837           "Set target format for mixing (NULL means ANY). "
838           "Setting this property takes a reference to the supplied GstCaps "
839           "object.", GST_TYPE_CAPS,
840           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
841
842   gstelement_class->request_new_pad =
843       GST_DEBUG_FUNCPTR (gst_adder_request_new_pad);
844   gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_adder_release_pad);
845   gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_adder_change_state);
846 }
847
848 static void
849 gst_adder_init (GstAdder * adder)
850 {
851   GstPadTemplate *template;
852
853   template = gst_static_pad_template_get (&gst_adder_src_template);
854   adder->srcpad = gst_pad_new_from_template (template, "src");
855   gst_object_unref (template);
856
857   gst_pad_set_getcaps_function (adder->srcpad,
858       GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
859   gst_pad_set_setcaps_function (adder->srcpad,
860       GST_DEBUG_FUNCPTR (gst_adder_setcaps));
861   gst_pad_set_query_function (adder->srcpad,
862       GST_DEBUG_FUNCPTR (gst_adder_query));
863   gst_pad_set_event_function (adder->srcpad,
864       GST_DEBUG_FUNCPTR (gst_adder_src_event));
865   gst_element_add_pad (GST_ELEMENT (adder), adder->srcpad);
866
867   adder->format = GST_ADDER_FORMAT_UNSET;
868   adder->padcount = 0;
869   adder->func = NULL;
870
871   adder->filter_caps = gst_caps_new_any ();
872
873   /* keep track of the sinkpads requested */
874   adder->collect = gst_collect_pads_new ();
875   gst_collect_pads_set_function (adder->collect,
876       GST_DEBUG_FUNCPTR (gst_adder_collected), adder);
877 }
878
879 static void
880 gst_adder_dispose (GObject * object)
881 {
882   GstAdder *adder = GST_ADDER (object);
883
884   if (adder->collect) {
885     gst_object_unref (adder->collect);
886     adder->collect = NULL;
887   }
888   gst_caps_replace (&adder->filter_caps, NULL);
889   if (adder->pending_events) {
890     g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
891     g_list_free (adder->pending_events);
892     adder->pending_events = NULL;
893   }
894
895   G_OBJECT_CLASS (parent_class)->dispose (object);
896 }
897
898 static void
899 gst_adder_set_property (GObject * object, guint prop_id,
900     const GValue * value, GParamSpec * pspec)
901 {
902   GstAdder *adder = GST_ADDER (object);
903
904   switch (prop_id) {
905     case PROP_FILTER_CAPS:{
906       GstCaps *new_caps;
907       GstCaps *old_caps;
908       const GstCaps *new_caps_val = gst_value_get_caps (value);
909
910       if (new_caps_val == NULL) {
911         new_caps = gst_caps_new_any ();
912       } else {
913         new_caps = (GstCaps *) new_caps_val;
914         gst_caps_ref (new_caps);
915       }
916
917       GST_OBJECT_LOCK (adder);
918       old_caps = adder->filter_caps;
919       adder->filter_caps = new_caps;
920       GST_OBJECT_UNLOCK (adder);
921
922       gst_caps_unref (old_caps);
923
924       GST_DEBUG_OBJECT (adder, "set new caps %" GST_PTR_FORMAT, new_caps);
925       break;
926     }
927     default:
928       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
929       break;
930   }
931 }
932
933 static void
934 gst_adder_get_property (GObject * object, guint prop_id, GValue * value,
935     GParamSpec * pspec)
936 {
937   GstAdder *adder = GST_ADDER (object);
938
939   switch (prop_id) {
940     case PROP_FILTER_CAPS:
941       GST_OBJECT_LOCK (adder);
942       gst_value_set_caps (value, adder->filter_caps);
943       GST_OBJECT_UNLOCK (adder);
944       break;
945     default:
946       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
947       break;
948   }
949 }
950
951
952 static GstPad *
953 gst_adder_request_new_pad (GstElement * element, GstPadTemplate * templ,
954     const gchar * unused)
955 {
956   gchar *name;
957   GstAdder *adder;
958   GstPad *newpad;
959   gint padcount;
960
961   if (templ->direction != GST_PAD_SINK)
962     goto not_sink;
963
964   adder = GST_ADDER (element);
965
966   /* increment pad counter */
967   padcount = g_atomic_int_exchange_and_add (&adder->padcount, 1);
968
969   name = g_strdup_printf ("sink%d", padcount);
970   newpad = gst_pad_new_from_template (templ, name);
971   GST_DEBUG_OBJECT (adder, "request new pad %s", name);
972   g_free (name);
973
974   gst_pad_set_getcaps_function (newpad,
975       GST_DEBUG_FUNCPTR (gst_adder_sink_getcaps));
976   gst_pad_set_setcaps_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_setcaps));
977   gst_collect_pads_add_pad (adder->collect, newpad, sizeof (GstCollectData));
978
979   /* FIXME: hacked way to override/extend the event function of
980    * GstCollectPads; because it sets its own event function giving the
981    * element no access to events */
982   adder->collect_event = (GstPadEventFunction) GST_PAD_EVENTFUNC (newpad);
983   gst_pad_set_event_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_sink_event));
984
985   /* takes ownership of the pad */
986   if (!gst_element_add_pad (GST_ELEMENT (adder), newpad))
987     goto could_not_add;
988
989   return newpad;
990
991   /* errors */
992 not_sink:
993   {
994     g_warning ("gstadder: request new pad that is not a SINK pad\n");
995     return NULL;
996   }
997 could_not_add:
998   {
999     GST_DEBUG_OBJECT (adder, "could not add pad");
1000     gst_collect_pads_remove_pad (adder->collect, newpad);
1001     gst_object_unref (newpad);
1002     return NULL;
1003   }
1004 }
1005
1006 static void
1007 gst_adder_release_pad (GstElement * element, GstPad * pad)
1008 {
1009   GstAdder *adder;
1010
1011   adder = GST_ADDER (element);
1012
1013   GST_DEBUG_OBJECT (adder, "release pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1014
1015   gst_collect_pads_remove_pad (adder->collect, pad);
1016   gst_element_remove_pad (element, pad);
1017 }
1018
1019 static GstFlowReturn
1020 gst_adder_collected (GstCollectPads * pads, gpointer user_data)
1021 {
1022   /*
1023    * combine streams by adding data values
1024    * basic algorithm :
1025    * - this function is called when all pads have a buffer
1026    * - get available bytes on all pads.
1027    * - repeat for each input pad :
1028    *   - read available bytes, copy or add to target buffer
1029    *   - if there's an EOS event, remove the input channel
1030    * - push out the output buffer
1031    *
1032    * todo:
1033    * - would be nice to have a mixing mode, where instead of adding we mix
1034    *   - for float we could downscale after collect loop
1035    *   - for int we need to downscale each input to avoid clipping or
1036    *     mix into a temp (float) buffer and scale afterwards as well
1037    */
1038   GstAdder *adder;
1039   GSList *collected;
1040   GstFlowReturn ret;
1041   GstBuffer *outbuf = NULL;
1042   gpointer outdata = NULL;
1043   guint outsize;
1044   gboolean empty = TRUE;
1045
1046   adder = GST_ADDER (user_data);
1047
1048   /* this is fatal */
1049   if (G_UNLIKELY (adder->func == NULL))
1050     goto not_negotiated;
1051
1052   if (adder->flush_stop_pending) {
1053     gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop ());
1054     adder->flush_stop_pending = FALSE;
1055   }
1056
1057   /* get available bytes for reading, this can be 0 which could mean empty
1058    * buffers or EOS, which we will catch when we loop over the pads. */
1059   outsize = gst_collect_pads_available (pads);
1060
1061   GST_LOG_OBJECT (adder,
1062       "starting to cycle through channels, %d bytes available (bps = %d)",
1063       outsize, adder->bps);
1064
1065   for (collected = pads->data; collected; collected = g_slist_next (collected)) {
1066     GstCollectData *collect_data;
1067     GstBuffer *inbuf;
1068     guint8 *indata;
1069     guint insize;
1070
1071     collect_data = (GstCollectData *) collected->data;
1072
1073     /* get a subbuffer of size bytes */
1074     inbuf = gst_collect_pads_take_buffer (pads, collect_data, outsize);
1075     /* NULL means EOS or an empty buffer so we still need to flush in
1076      * case of an empty buffer. */
1077     if (inbuf == NULL) {
1078       GST_LOG_OBJECT (adder, "channel %p: no bytes available", collect_data);
1079       continue;
1080     }
1081
1082     indata = GST_BUFFER_DATA (inbuf);
1083     insize = GST_BUFFER_SIZE (inbuf);
1084
1085     if (outbuf == NULL) {
1086       GST_LOG_OBJECT (adder, "channel %p: making output buffer of %d bytes",
1087           collect_data, outsize);
1088
1089       /* first buffer, alloc outsize.
1090        * FIXME: we can easily subbuffer and _make_writable.
1091        * FIXME: only create empty buffer for first non-gap buffer, so that we
1092        * only use adder function when really adding
1093        */
1094       outbuf = gst_buffer_new_and_alloc (outsize);
1095       outdata = GST_BUFFER_DATA (outbuf);
1096       gst_buffer_set_caps (outbuf, GST_PAD_CAPS (adder->srcpad));
1097
1098       if (!GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP)) {
1099         GST_LOG_OBJECT (adder, "channel %p: copying %d bytes from data %p",
1100             collect_data, insize, indata);
1101         /* clear if we are only going to fill a partial buffer */
1102         if (G_UNLIKELY (outsize > insize))
1103           memset ((guint8 *) outdata + insize, 0, outsize - insize);
1104         /* and copy the data into it */
1105         memcpy (outdata, indata, insize);
1106         empty = FALSE;
1107       } else {
1108         /* clear whole buffer */
1109         GST_LOG_OBJECT (adder, "channel %p: zeroing %d bytes from data %p",
1110             collect_data, insize, indata);
1111         memset (outdata, 0, outsize);
1112       }
1113     } else {
1114       if (!GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP)) {
1115         GST_LOG_OBJECT (adder, "channel %p: mixing %d bytes from data %p",
1116             collect_data, insize, indata);
1117         /* further buffers, need to add them */
1118         adder->func ((gpointer) outdata, (gpointer) indata, insize);
1119         empty = FALSE;
1120       } else {
1121         GST_LOG_OBJECT (adder, "channel %p: skipping %d bytes from data %p",
1122             collect_data, insize, indata);
1123       }
1124     }
1125     gst_buffer_unref (inbuf);
1126   }
1127
1128   /* can only happen when no pads to collect or all EOS */
1129   if (outbuf == NULL)
1130     goto eos;
1131
1132   /* our timestamping is very simple, just an ever incrementing
1133    * counter, the new segment time will take care of their respective
1134    * stream time. */
1135   if (adder->segment_pending) {
1136     GstEvent *event;
1137
1138     /* FIXME, use rate/applied_rate as set on all sinkpads.
1139      * - currently we just set rate as received from last seek-event
1140      * We could potentially figure out the duration as well using
1141      * the current segment positions and the stated stop positions.
1142      * Also we just start from stream time 0 which is rather
1143      * weird. For non-synchronized mixing, the time should be
1144      * the min of the stream times of all received segments,
1145      * rationale being that the duration is at least going to
1146      * be as long as the earliest stream we start mixing. This
1147      * would also be correct for synchronized mixing but then
1148      * the later streams would be delayed until the stream times
1149      * match.
1150      */
1151     event = gst_event_new_new_segment_full (FALSE, adder->segment_rate,
1152         1.0, GST_FORMAT_TIME, adder->timestamp, -1, adder->segment_position);
1153
1154     if (event) {
1155       if (!gst_pad_push_event (adder->srcpad, event)) {
1156         GST_WARNING_OBJECT (adder->srcpad, "Sending event  %p (%s) failed.",
1157             event, GST_EVENT_TYPE_NAME (event));
1158       }
1159       adder->segment_pending = FALSE;
1160       adder->segment_position = 0;
1161     } else {
1162       GST_WARNING_OBJECT (adder->srcpad, "Creating new segment event for "
1163           "start:%" G_GINT64_FORMAT "  pos:%" G_GINT64_FORMAT " failed",
1164           adder->timestamp, adder->segment_position);
1165     }
1166   }
1167
1168   if (G_UNLIKELY (adder->pending_events)) {
1169     GList *tmp = adder->pending_events;
1170
1171     while (tmp) {
1172       GstEvent *ev = (GstEvent *) tmp->data;
1173
1174       gst_pad_push_event (adder->srcpad, ev);
1175       tmp = g_list_next (tmp);
1176     }
1177     g_list_free (adder->pending_events);
1178     adder->pending_events = NULL;
1179   }
1180
1181   /* set timestamps on the output buffer */
1182   GST_BUFFER_TIMESTAMP (outbuf) = adder->timestamp;
1183   GST_BUFFER_OFFSET (outbuf) = adder->offset;
1184
1185   /* for the next timestamp, use the sample counter, which will
1186    * never accumulate rounding errors */
1187   adder->offset += outsize / adder->bps;
1188   adder->timestamp = gst_util_uint64_scale_int (adder->offset,
1189       GST_SECOND, adder->rate);
1190
1191   /* now we can set the duration of the buffer */
1192   GST_BUFFER_DURATION (outbuf) = adder->timestamp -
1193       GST_BUFFER_TIMESTAMP (outbuf);
1194
1195   /* if we only processed silence, mark output again as silence */
1196   if (empty)
1197     GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_GAP);
1198
1199   /* send it out */
1200   GST_LOG_OBJECT (adder, "pushing outbuf, timestamp %" GST_TIME_FORMAT,
1201       GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)));
1202   ret = gst_pad_push (adder->srcpad, outbuf);
1203
1204   GST_LOG_OBJECT (adder, "pushed outbuf, result = %s", gst_flow_get_name (ret));
1205
1206   return ret;
1207
1208   /* ERRORS */
1209 not_negotiated:
1210   {
1211     GST_ELEMENT_ERROR (adder, STREAM, FORMAT, (NULL),
1212         ("Unknown data received, not negotiated"));
1213     return GST_FLOW_NOT_NEGOTIATED;
1214   }
1215 eos:
1216   {
1217     GST_DEBUG_OBJECT (adder, "no data available, must be EOS");
1218     gst_pad_push_event (adder->srcpad, gst_event_new_eos ());
1219     return GST_FLOW_UNEXPECTED;
1220   }
1221 }
1222
1223 static GstStateChangeReturn
1224 gst_adder_change_state (GstElement * element, GstStateChange transition)
1225 {
1226   GstAdder *adder;
1227   GstStateChangeReturn ret;
1228
1229   adder = GST_ADDER (element);
1230
1231   switch (transition) {
1232     case GST_STATE_CHANGE_NULL_TO_READY:
1233       break;
1234     case GST_STATE_CHANGE_READY_TO_PAUSED:
1235       adder->timestamp = 0;
1236       adder->offset = 0;
1237       adder->flush_stop_pending = FALSE;
1238       adder->segment_pending = TRUE;
1239       adder->segment_position = 0;
1240       adder->segment_rate = 1.0;
1241       gst_segment_init (&adder->segment, GST_FORMAT_UNDEFINED);
1242       gst_collect_pads_start (adder->collect);
1243       break;
1244     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1245       break;
1246     case GST_STATE_CHANGE_PAUSED_TO_READY:
1247       /* need to unblock the collectpads before calling the
1248        * parent change_state so that streaming can finish */
1249       gst_collect_pads_stop (adder->collect);
1250       break;
1251     default:
1252       break;
1253   }
1254
1255   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1256
1257   switch (transition) {
1258     default:
1259       break;
1260   }
1261
1262   return ret;
1263 }
1264
1265
1266 static gboolean
1267 plugin_init (GstPlugin * plugin)
1268 {
1269   /*oil_init (); */
1270
1271   if (!gst_element_register (plugin, "adder", GST_RANK_NONE, GST_TYPE_ADDER)) {
1272     return FALSE;
1273   }
1274
1275   return TRUE;
1276 }
1277
1278 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1279     GST_VERSION_MINOR,
1280     "adder",
1281     "Adds multiple streams",
1282     plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)