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>
6 * adder.c: Adder element, N in, one out, samples are added
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.
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.
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.
24 * SECTION:element-adder
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.
29 * The adder currently mixes all data received on the sinkpads as soon as
30 * possible without trying to synchronize the streams.
33 * <title>Example launch line</title>
35 * gst-launch audiotestsrc freq=100 ! adder name=mix ! audioconvert ! alsasink audiotestsrc freq=500 ! mix.
36 * ]| This pipeline produces two sine waves mixed together.
39 * Last reviewed on 2006-05-09 (0.10.7)
41 /* Element-Checklist-Version: 5 */
47 #include <gst/audio/audio.h>
48 #include <string.h> /* strcmp */
49 /*#include <liboil/liboil.h>*/
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))
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))
72 #define GST_CAT_DEFAULT gst_adder_debug
73 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
75 /* elementfactory information */
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 } ;" \
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 } ;" \
93 "rate = (int) [ 1, MAX ], " \
94 "channels = (int) [ 1, MAX ], " \
95 "endianness = (int) BYTE_ORDER, " \
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 }"
105 static GstStaticPadTemplate gst_adder_src_template =
106 GST_STATIC_PAD_TEMPLATE ("src",
109 GST_STATIC_CAPS (CAPS)
112 static GstStaticPadTemplate gst_adder_sink_template =
113 GST_STATIC_PAD_TEMPLATE ("sink%d",
116 GST_STATIC_CAPS (CAPS)
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);
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);
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);
136 static GstStateChangeReturn gst_adder_change_state (GstElement * element,
137 GstStateChange transition);
139 static GstBuffer *gst_adder_do_clip (GstCollectPads * pads,
140 GstCollectData * data, GstBuffer * buffer, gpointer user_data);
141 static GstFlowReturn gst_adder_collected (GstCollectPads * pads,
144 static GstElementClass *parent_class = NULL;
147 gst_adder_get_type (void)
149 static GType adder_type = 0;
151 if (G_UNLIKELY (adder_type == 0)) {
152 static const GTypeInfo adder_info = {
153 sizeof (GstAdderClass), NULL, NULL,
154 (GClassInitFunc) gst_adder_class_init, NULL, NULL,
155 sizeof (GstAdder), 0,
156 (GInstanceInitFunc) gst_adder_init,
159 adder_type = g_type_register_static (GST_TYPE_ELEMENT, "GstAdder",
161 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "adder", 0,
162 "audio channel mixing element");
167 /* clipping versions (for int)
168 * FIXME: what about: oil_add_s16 (out, out, in, bytes / sizeof (type))
170 #define MAKE_FUNC(name,type,ttype,min,max) \
171 static void name (type *out, type *in, gint bytes) { \
174 for (i = 0; i < bytes / sizeof (type); i++) { \
175 add = (ttype)out[i] + (ttype)in[i]; \
176 out[i] = CLAMP (add, min, max); \
180 /* unsigned versions (for int) */
181 #define MAKE_FUNC_US(name,type,ttype,max) \
182 static void name (type *out, type *in, gint bytes) { \
185 for (i = 0; i < bytes / sizeof (type); i++) { \
186 add = (ttype)out[i] + (ttype)in[i]; \
187 out[i] = ((add <= max) ? add : max); \
191 /* non-clipping versions (for float) */
192 #define MAKE_FUNC_NC(name,type) \
193 static void name (type *out, type *in, gint bytes) { \
195 for (i = 0; i < bytes / sizeof (type); i++) \
200 /* right now, the liboil function don't seems to be faster on x86
201 * time gst-launch audiotestsrc num-buffers=50000 ! audio/x-raw-float ! adder name=m ! fakesink audiotestsrc num-buffers=50000 ! audio/x-raw-float ! m.
202 * 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.
205 add_float32 (gfloat * out, gfloat * in, gint bytes)
207 oil_add_f32 (out, out, in, bytes / sizeof (gfloat));
211 add_float64 (gdouble * out, gdouble * in, gint bytes)
213 oil_add_f64 (out, out, in, bytes / sizeof (gdouble));
218 MAKE_FUNC (add_int32, gint32, gint64, MIN_INT_32, MAX_INT_32)
219 MAKE_FUNC (add_int16, gint16, gint32, MIN_INT_16, MAX_INT_16)
220 MAKE_FUNC (add_int8, gint8, gint16, MIN_INT_8, MAX_INT_8)
221 MAKE_FUNC_US (add_uint32, guint32, guint64, MAX_UINT_32)
222 MAKE_FUNC_US (add_uint16, guint16, guint32, MAX_UINT_16)
223 MAKE_FUNC_US (add_uint8, guint8, guint16, MAX_UINT_8)
224 MAKE_FUNC_NC (add_float64, gdouble)
225 MAKE_FUNC_NC (add_float32, gfloat)
228 /* we can only accept caps that we and downstream can handle.
229 * if we have filtercaps set, use those to constrain the target caps.
232 gst_adder_sink_getcaps (GstPad * pad)
235 GstCaps *result, *peercaps, *sinkcaps;
237 adder = GST_ADDER (GST_PAD_PARENT (pad));
239 GST_OBJECT_LOCK (adder);
240 /* get the downstream possible caps */
241 peercaps = gst_pad_peer_get_caps (adder->srcpad);
243 /* get the allowed caps on this sinkpad, we use the fixed caps function so
244 * that it does not call recursively in this function. */
245 sinkcaps = gst_pad_get_fixed_caps_func (pad);
247 /* restrict with filter-caps if any */
248 if (adder->filter_caps) {
249 GST_DEBUG_OBJECT (adder, "filtering peer caps");
250 result = gst_caps_intersect (peercaps, adder->filter_caps);
251 gst_caps_unref (peercaps);
254 /* if the peer has caps, intersect */
255 GST_DEBUG_OBJECT (adder, "intersecting peer and template caps");
256 result = gst_caps_intersect (peercaps, sinkcaps);
257 gst_caps_unref (peercaps);
258 gst_caps_unref (sinkcaps);
260 /* the peer has no caps (or there is no peer), just use the allowed caps
261 * of this sinkpad. */
262 /* restrict with filter-caps if any */
263 if (adder->filter_caps) {
264 GST_DEBUG_OBJECT (adder, "no peer caps, using filtered sinkcaps");
265 result = gst_caps_intersect (sinkcaps, adder->filter_caps);
266 gst_caps_unref (sinkcaps);
268 GST_DEBUG_OBJECT (adder, "no peer caps, using sinkcaps");
272 GST_OBJECT_UNLOCK (adder);
274 GST_LOG_OBJECT (adder, "getting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
275 GST_PAD_NAME (pad), result);
280 /* the first caps we receive on any of the sinkpads will define the caps for all
281 * the other sinkpads because we can only mix streams with the same caps.
284 gst_adder_setcaps (GstPad * pad, GstCaps * caps)
288 GstStructure *structure;
289 const char *media_type;
291 adder = GST_ADDER (GST_PAD_PARENT (pad));
293 GST_LOG_OBJECT (adder, "setting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
294 GST_PAD_NAME (pad), caps);
296 /* FIXME, see if the other pads can accept the format. Also lock the
297 * format on the other pads to this new format. */
298 GST_OBJECT_LOCK (adder);
299 pads = GST_ELEMENT (adder)->pads;
301 GstPad *otherpad = GST_PAD (pads->data);
303 if (otherpad != pad) {
304 gst_caps_replace (&GST_PAD_CAPS (otherpad), caps);
306 pads = g_list_next (pads);
308 GST_OBJECT_UNLOCK (adder);
311 structure = gst_caps_get_structure (caps, 0);
312 media_type = gst_structure_get_name (structure);
313 if (strcmp (media_type, "audio/x-raw-int") == 0) {
314 adder->format = GST_ADDER_FORMAT_INT;
315 gst_structure_get_int (structure, "width", &adder->width);
316 gst_structure_get_int (structure, "depth", &adder->depth);
317 gst_structure_get_int (structure, "endianness", &adder->endianness);
318 gst_structure_get_boolean (structure, "signed", &adder->is_signed);
320 GST_INFO_OBJECT (pad, "parse_caps sets adder to format int, %d bit",
323 if (adder->endianness != G_BYTE_ORDER)
326 switch (adder->width) {
328 adder->func = (adder->is_signed ?
329 (GstAdderFunction) add_int8 : (GstAdderFunction) add_uint8);
332 adder->func = (adder->is_signed ?
333 (GstAdderFunction) add_int16 : (GstAdderFunction) add_uint16);
336 adder->func = (adder->is_signed ?
337 (GstAdderFunction) add_int32 : (GstAdderFunction) add_uint32);
342 } else if (strcmp (media_type, "audio/x-raw-float") == 0) {
343 adder->format = GST_ADDER_FORMAT_FLOAT;
344 gst_structure_get_int (structure, "width", &adder->width);
345 gst_structure_get_int (structure, "endianness", &adder->endianness);
347 GST_INFO_OBJECT (pad, "parse_caps sets adder to format float, %d bit",
350 if (adder->endianness != G_BYTE_ORDER)
353 switch (adder->width) {
355 adder->func = (GstAdderFunction) add_float32;
358 adder->func = (GstAdderFunction) add_float64;
367 gst_structure_get_int (structure, "channels", &adder->channels);
368 gst_structure_get_int (structure, "rate", &adder->rate);
370 adder->bps = (adder->width / 8) * adder->channels;
377 GST_DEBUG_OBJECT (adder, "unsupported format set as caps");
382 /* FIXME, the duration query should reflect how long you will produce
383 * data, that is the amount of stream time until you will emit EOS.
385 * For synchronized mixing this is always the max of all the durations
386 * of upstream since we emit EOS when all of them finished.
388 * We don't do synchronized mixing so this really depends on where the
389 * streams where punched in and what their relative offsets are against
390 * eachother which we can get from the first timestamps we see.
392 * When we add a new stream (or remove a stream) the duration might
393 * also become invalid again and we need to post a new DURATION
394 * message to notify this fact to the parent.
395 * For now we take the max of all the upstream elements so the simple
396 * cases work at least somewhat.
399 gst_adder_query_duration (GstAdder * adder, GstQuery * query)
408 gst_query_parse_duration (query, &format, NULL);
414 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
416 GstIteratorResult ires;
420 ires = gst_iterator_next (it, &item);
422 case GST_ITERATOR_DONE:
425 case GST_ITERATOR_OK:
427 GstPad *pad = GST_PAD_CAST (item);
431 /* ask sink peer for duration */
432 res &= gst_pad_query_peer_duration (pad, &format, &duration);
433 /* take max from all valid return values */
435 /* valid unknown length, stop searching */
436 if (duration == -1) {
440 /* else see if bigger than current max */
441 else if (duration > max)
444 gst_object_unref (pad);
447 case GST_ITERATOR_RESYNC:
450 gst_iterator_resync (it);
458 gst_iterator_free (it);
461 /* and store the max */
462 GST_DEBUG_OBJECT (adder, "Total duration in format %s: %"
463 GST_TIME_FORMAT, gst_format_get_name (format), GST_TIME_ARGS (max));
464 gst_query_set_duration (query, format, max);
471 gst_adder_query_latency (GstAdder * adder, GstQuery * query)
473 GstClockTime min, max;
484 max = GST_CLOCK_TIME_NONE;
486 /* Take maximum of all latency values */
487 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
489 GstIteratorResult ires;
493 ires = gst_iterator_next (it, &item);
495 case GST_ITERATOR_DONE:
498 case GST_ITERATOR_OK:
500 GstPad *pad = GST_PAD_CAST (item);
502 GstClockTime min_cur, max_cur;
505 peerquery = gst_query_new_latency ();
507 /* Ask peer for latency */
508 res &= gst_pad_peer_query (pad, peerquery);
510 /* take max from all valid return values */
512 gst_query_parse_latency (peerquery, &live_cur, &min_cur, &max_cur);
517 if (max_cur != GST_CLOCK_TIME_NONE &&
518 ((max != GST_CLOCK_TIME_NONE && max_cur > max) ||
519 (max == GST_CLOCK_TIME_NONE)))
522 live = live || live_cur;
525 gst_query_unref (peerquery);
526 gst_object_unref (pad);
529 case GST_ITERATOR_RESYNC:
532 max = GST_CLOCK_TIME_NONE;
534 gst_iterator_resync (it);
542 gst_iterator_free (it);
545 /* store the results */
546 GST_DEBUG_OBJECT (adder, "Calculated total latency: live %s, min %"
547 GST_TIME_FORMAT ", max %" GST_TIME_FORMAT,
548 (live ? "yes" : "no"), GST_TIME_ARGS (min), GST_TIME_ARGS (max));
549 gst_query_set_latency (query, live, min, max);
556 gst_adder_query (GstPad * pad, GstQuery * query)
558 GstAdder *adder = GST_ADDER (gst_pad_get_parent (pad));
559 gboolean res = FALSE;
561 switch (GST_QUERY_TYPE (query)) {
562 case GST_QUERY_POSITION:
566 gst_query_parse_position (query, &format, NULL);
569 case GST_FORMAT_TIME:
570 /* FIXME, bring to stream time, might be tricky */
571 gst_query_set_position (query, format, adder->timestamp);
574 case GST_FORMAT_DEFAULT:
575 gst_query_set_position (query, format, adder->offset);
583 case GST_QUERY_DURATION:
584 res = gst_adder_query_duration (adder, query);
586 case GST_QUERY_LATENCY:
587 res = gst_adder_query_latency (adder, query);
590 /* FIXME, needs a custom query handler because we have multiple
592 res = gst_pad_query_default (pad, query);
596 gst_object_unref (adder);
607 forward_event_func (GstPad * pad, GValue * ret, EventData * data)
609 GstEvent *event = data->event;
611 gst_event_ref (event);
612 GST_LOG_OBJECT (pad, "About to send event %s", GST_EVENT_TYPE_NAME (event));
613 if (!gst_pad_push_event (pad, event)) {
614 GST_WARNING_OBJECT (pad, "Sending event %p (%s) failed.",
615 event, GST_EVENT_TYPE_NAME (event));
616 /* quick hack to unflush the pads, ideally we need a way to just unflush
617 * this single collect pad */
619 gst_pad_send_event (pad, gst_event_new_flush_stop ());
621 g_value_set_boolean (ret, TRUE);
622 GST_LOG_OBJECT (pad, "Sent event %p (%s).",
623 event, GST_EVENT_TYPE_NAME (event));
625 gst_object_unref (pad);
627 /* continue on other pads, even if one failed */
631 /* forwards the event to all sinkpads, takes ownership of the
634 * Returns: TRUE if the event could be forwarded on all
638 forward_event (GstAdder * adder, GstEvent * event, gboolean flush)
642 GstIteratorResult ires;
646 GST_LOG_OBJECT (adder, "Forwarding event %p (%s)", event,
647 GST_EVENT_TYPE_NAME (event));
652 g_value_init (&vret, G_TYPE_BOOLEAN);
653 g_value_set_boolean (&vret, FALSE);
654 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
656 ires = gst_iterator_fold (it, (GstIteratorFoldFunction) forward_event_func,
659 case GST_ITERATOR_RESYNC:
660 GST_WARNING ("resync");
661 gst_iterator_resync (it);
662 g_value_set_boolean (&vret, TRUE);
664 case GST_ITERATOR_OK:
665 case GST_ITERATOR_DONE:
666 ret = g_value_get_boolean (&vret);
674 gst_iterator_free (it);
675 GST_LOG_OBJECT (adder, "Forwarded event %p (%s), ret=%d", event,
676 GST_EVENT_TYPE_NAME (event), ret);
677 gst_event_unref (event);
683 gst_adder_src_event (GstPad * pad, GstEvent * event)
688 adder = GST_ADDER (gst_pad_get_parent (pad));
690 switch (GST_EVENT_TYPE (event)) {
698 /* parse the seek parameters */
699 gst_event_parse_seek (event, &adder->segment_rate, NULL, &flags, &curtype,
702 flush = (flags & GST_SEEK_FLAG_FLUSH) == GST_SEEK_FLAG_FLUSH;
704 /* check if we are flushing */
706 /* make sure we accept nothing anymore and return WRONG_STATE */
707 gst_collect_pads_set_flushing (adder->collect, TRUE);
709 /* flushing seek, start flush downstream, the flush will be done
710 * when all pads received a FLUSH_STOP. */
711 gst_pad_push_event (adder->srcpad, gst_event_new_flush_start ());
713 GST_DEBUG_OBJECT (adder, "handling seek event: %" GST_PTR_FORMAT, event);
715 /* now wait for the collected to be finished and mark a new
716 * segment. After we have the lock, no collect function is running and no
717 * new collect function will be called for as long as we're flushing. */
718 GST_OBJECT_LOCK (adder->collect);
719 if (curtype == GST_SEEK_TYPE_SET)
720 adder->segment_position = cur;
722 adder->segment_position = 0;
723 /* make sure we push a new segment, to inform about new basetime
724 * see FIXME in gst_adder_collected() */
725 adder->segment_pending = TRUE;
727 /* Yes, we need to call _set_flushing again *WHEN* the streaming threads
728 * have stopped so that the cookie gets properly updated. */
729 gst_collect_pads_set_flushing (adder->collect, TRUE);
731 /* we might have a pending flush_stop event now. This event will either be
732 * sent by an upstream element when it completes the seek or we will push
733 * one in the collected callback ourself */
734 adder->flush_stop_pending = flush;
735 GST_OBJECT_UNLOCK (adder->collect);
736 GST_DEBUG_OBJECT (adder, "forwarding seek event: %" GST_PTR_FORMAT,
739 result = forward_event (adder, event, flush);
741 /* seek failed. maybe source is a live source. */
742 GST_DEBUG_OBJECT (adder, "seeking failed");
744 /* FIXME: ideally we would like to send a flush-stop event from here but
745 * collectpads does not have a method that allows us to do that. Instead
746 * we forward all flush-stop events we receive on the sinkpads. We might
747 * be sending too many flush-stop events. */
751 /* QoS might be tricky */
754 case GST_EVENT_NAVIGATION:
755 /* navigation is rather pointless. */
759 /* just forward the rest for now */
760 GST_DEBUG_OBJECT (adder, "forward unhandled event: %s",
761 GST_EVENT_TYPE_NAME (event));
762 result = forward_event (adder, event, FALSE);
765 gst_object_unref (adder);
771 gst_adder_sink_event (GstPad * pad, GstEvent * event)
776 adder = GST_ADDER (gst_pad_get_parent (pad));
778 GST_DEBUG ("Got %s event on pad %s:%s", GST_EVENT_TYPE_NAME (event),
779 GST_DEBUG_PAD_NAME (pad));
781 switch (GST_EVENT_TYPE (event)) {
782 case GST_EVENT_FLUSH_STOP:
783 /* we received a flush-stop. The collect_event function will push the
784 * event past our element. We simply forward all flush-stop events, even
785 * when no flush-stop was pending, this is required because collectpads
786 * does not provide an API to handle-but-not-forward the flush-stop.
787 * We unset the pending flush-stop flag so that we don't send anymore
788 * flush-stop from the collect function later.
790 GST_OBJECT_LOCK (adder->collect);
791 adder->segment_pending = TRUE;
792 adder->flush_stop_pending = FALSE;
793 /* Clear pending tags */
794 if (adder->pending_events) {
795 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
796 g_list_free (adder->pending_events);
797 adder->pending_events = NULL;
799 GST_OBJECT_UNLOCK (adder->collect);
802 GST_OBJECT_LOCK (adder->collect);
803 /* collect tags here so we can push them out when we collect data */
804 adder->pending_events = g_list_append (adder->pending_events, event);
805 GST_OBJECT_UNLOCK (adder->collect);
811 /* now GstCollectPads can take care of the rest, e.g. EOS */
812 ret = adder->collect_event (pad, event);
815 gst_object_unref (adder);
820 gst_adder_class_init (GstAdderClass * klass)
822 GObjectClass *gobject_class = (GObjectClass *) klass;
823 GstElementClass *gstelement_class = (GstElementClass *) klass;
825 gobject_class->set_property = gst_adder_set_property;
826 gobject_class->get_property = gst_adder_get_property;
827 gobject_class->dispose = gst_adder_dispose;
829 gst_element_class_add_pad_template (gstelement_class,
830 gst_static_pad_template_get (&gst_adder_src_template));
831 gst_element_class_add_pad_template (gstelement_class,
832 gst_static_pad_template_get (&gst_adder_sink_template));
833 gst_element_class_set_details_simple (gstelement_class, "Adder",
835 "Add N audio channels together",
836 "Thomas Vander Stichele <thomas at apestaart dot org>");
838 parent_class = g_type_class_peek_parent (klass);
845 g_object_class_install_property (gobject_class, PROP_FILTER_CAPS,
846 g_param_spec_boxed ("caps", "Target caps",
847 "Set target format for mixing (NULL means ANY). "
848 "Setting this property takes a reference to the supplied GstCaps "
849 "object.", GST_TYPE_CAPS,
850 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
852 gstelement_class->request_new_pad =
853 GST_DEBUG_FUNCPTR (gst_adder_request_new_pad);
854 gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_adder_release_pad);
855 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_adder_change_state);
859 gst_adder_init (GstAdder * adder)
861 GstPadTemplate *template;
863 template = gst_static_pad_template_get (&gst_adder_src_template);
864 adder->srcpad = gst_pad_new_from_template (template, "src");
865 gst_object_unref (template);
867 gst_pad_set_getcaps_function (adder->srcpad,
868 GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
869 gst_pad_set_setcaps_function (adder->srcpad,
870 GST_DEBUG_FUNCPTR (gst_adder_setcaps));
871 gst_pad_set_query_function (adder->srcpad,
872 GST_DEBUG_FUNCPTR (gst_adder_query));
873 gst_pad_set_event_function (adder->srcpad,
874 GST_DEBUG_FUNCPTR (gst_adder_src_event));
875 gst_element_add_pad (GST_ELEMENT (adder), adder->srcpad);
877 adder->format = GST_ADDER_FORMAT_UNSET;
881 adder->filter_caps = NULL;
883 /* keep track of the sinkpads requested */
884 adder->collect = gst_collect_pads_new ();
885 gst_collect_pads_set_function (adder->collect,
886 GST_DEBUG_FUNCPTR (gst_adder_collected), adder);
887 gst_collect_pads_set_clip_function (adder->collect,
888 GST_DEBUG_FUNCPTR (gst_adder_do_clip), adder);
892 gst_adder_dispose (GObject * object)
894 GstAdder *adder = GST_ADDER (object);
896 if (adder->collect) {
897 gst_object_unref (adder->collect);
898 adder->collect = NULL;
900 gst_caps_replace (&adder->filter_caps, NULL);
901 if (adder->pending_events) {
902 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
903 g_list_free (adder->pending_events);
904 adder->pending_events = NULL;
907 G_OBJECT_CLASS (parent_class)->dispose (object);
911 gst_adder_set_property (GObject * object, guint prop_id,
912 const GValue * value, GParamSpec * pspec)
914 GstAdder *adder = GST_ADDER (object);
917 case PROP_FILTER_CAPS:{
918 GstCaps *new_caps = NULL;
920 const GstCaps *new_caps_val = gst_value_get_caps (value);
922 if (new_caps_val != NULL) {
923 new_caps = (GstCaps *) new_caps_val;
924 gst_caps_ref (new_caps);
927 GST_OBJECT_LOCK (adder);
928 old_caps = adder->filter_caps;
929 adder->filter_caps = new_caps;
930 GST_OBJECT_UNLOCK (adder);
933 gst_caps_unref (old_caps);
935 GST_DEBUG_OBJECT (adder, "set new caps %" GST_PTR_FORMAT, new_caps);
939 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
945 gst_adder_get_property (GObject * object, guint prop_id, GValue * value,
948 GstAdder *adder = GST_ADDER (object);
951 case PROP_FILTER_CAPS:
952 GST_OBJECT_LOCK (adder);
953 gst_value_set_caps (value, adder->filter_caps);
954 GST_OBJECT_UNLOCK (adder);
957 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
964 gst_adder_request_new_pad (GstElement * element, GstPadTemplate * templ,
965 const gchar * unused)
972 if (templ->direction != GST_PAD_SINK)
975 adder = GST_ADDER (element);
977 /* increment pad counter */
978 padcount = g_atomic_int_exchange_and_add (&adder->padcount, 1);
980 name = g_strdup_printf ("sink%d", padcount);
981 newpad = gst_pad_new_from_template (templ, name);
982 GST_DEBUG_OBJECT (adder, "request new pad %s", name);
985 gst_pad_set_getcaps_function (newpad,
986 GST_DEBUG_FUNCPTR (gst_adder_sink_getcaps));
987 gst_pad_set_setcaps_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_setcaps));
988 gst_collect_pads_add_pad (adder->collect, newpad, sizeof (GstCollectData));
990 /* FIXME: hacked way to override/extend the event function of
991 * GstCollectPads; because it sets its own event function giving the
992 * element no access to events */
993 adder->collect_event = (GstPadEventFunction) GST_PAD_EVENTFUNC (newpad);
994 gst_pad_set_event_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_sink_event));
996 /* takes ownership of the pad */
997 if (!gst_element_add_pad (GST_ELEMENT (adder), newpad))
1005 g_warning ("gstadder: request new pad that is not a SINK pad\n");
1010 GST_DEBUG_OBJECT (adder, "could not add pad");
1011 gst_collect_pads_remove_pad (adder->collect, newpad);
1012 gst_object_unref (newpad);
1018 gst_adder_release_pad (GstElement * element, GstPad * pad)
1022 adder = GST_ADDER (element);
1024 GST_DEBUG_OBJECT (adder, "release pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1026 gst_collect_pads_remove_pad (adder->collect, pad);
1027 gst_element_remove_pad (element, pad);
1031 gst_adder_do_clip (GstCollectPads * pads, GstCollectData * data,
1032 GstBuffer * buffer, gpointer user_data)
1034 GstAdder *adder = GST_ADDER (user_data);
1036 buffer = gst_audio_buffer_clip (buffer, &data->segment, adder->rate,
1042 static GstFlowReturn
1043 gst_adder_collected (GstCollectPads * pads, gpointer user_data)
1046 * combine streams by adding data values
1048 * - this function is called when all pads have a buffer
1049 * - get available bytes on all pads.
1050 * - repeat for each input pad :
1051 * - read available bytes, copy or add to target buffer
1052 * - if there's an EOS event, remove the input channel
1053 * - push out the output buffer
1056 * - would be nice to have a mixing mode, where instead of adding we mix
1057 * - for float we could downscale after collect loop
1058 * - for int we need to downscale each input to avoid clipping or
1059 * mix into a temp (float) buffer and scale afterwards as well
1062 GSList *collected, *next = NULL;
1064 GstBuffer *outbuf = NULL, *gapbuf = NULL;
1065 gpointer outdata = NULL;
1068 adder = GST_ADDER (user_data);
1071 if (G_UNLIKELY (adder->func == NULL))
1072 goto not_negotiated;
1074 if (adder->flush_stop_pending) {
1075 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop ());
1076 adder->flush_stop_pending = FALSE;
1079 /* get available bytes for reading, this can be 0 which could mean empty
1080 * buffers or EOS, which we will catch when we loop over the pads. */
1081 outsize = gst_collect_pads_available (pads);
1082 /* can only happen when no pads to collect or all EOS */
1086 GST_LOG_OBJECT (adder,
1087 "starting to cycle through channels, %d bytes available (bps = %d)",
1088 outsize, adder->bps);
1090 for (collected = pads->data; collected; collected = next) {
1091 GstCollectData *collect_data;
1095 /* take next to see if this is the last collectdata */
1096 next = g_slist_next (collected);
1098 collect_data = (GstCollectData *) collected->data;
1100 /* get a buffer of size bytes, if we get a buffer, it is at least outsize
1102 inbuf = gst_collect_pads_take_buffer (pads, collect_data, outsize);
1103 /* NULL means EOS or an empty buffer so we still need to flush in
1104 * case of an empty buffer. */
1105 if (inbuf == NULL) {
1106 GST_LOG_OBJECT (adder, "channel %p: no bytes available", collect_data);
1110 is_gap = GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP);
1112 /* Try to make an output buffer */
1113 if (outbuf == NULL) {
1114 /* if this is a gap buffer but we have some more pads to check, skip it.
1115 * If we are at the last buffer, take it, regardless if it is a GAP
1117 if (is_gap && next) {
1118 GST_DEBUG_OBJECT (adder, "skipping, non-last GAP buffer");
1119 /* we keep the GAP buffer, if we don't have anymore buffers (all pads
1120 * EOS, we can use this one as the output buffer. */
1124 gst_buffer_unref (inbuf);
1128 GST_LOG_OBJECT (adder, "channel %p: preparing output buffer of %d bytes",
1129 collect_data, outsize);
1130 /* make data and metadata writable, can simply return the inbuf when we
1131 * are the only one referencing this buffer. If this is the last (and
1132 * only) GAP buffer, it will automatically copy the GAP flag. */
1133 outbuf = gst_buffer_make_writable (inbuf);
1134 outdata = GST_BUFFER_DATA (outbuf);
1135 gst_buffer_set_caps (outbuf, GST_PAD_CAPS (adder->srcpad));
1138 /* we had a previous output buffer, mix this non-GAP buffer */
1142 indata = GST_BUFFER_DATA (inbuf);
1143 insize = GST_BUFFER_SIZE (inbuf);
1145 /* all buffers should have outsize, there are no short buffers because we
1146 * asked for the max size above */
1147 g_assert (insize == outsize);
1149 GST_LOG_OBJECT (adder, "channel %p: mixing %d bytes from data %p",
1150 collect_data, insize, indata);
1152 /* further buffers, need to add them */
1153 adder->func ((gpointer) outdata, (gpointer) indata, insize);
1155 /* skip gap buffer */
1156 GST_LOG_OBJECT (adder, "channel %p: skipping GAP buffer", collect_data);
1158 gst_buffer_unref (inbuf);
1162 if (outbuf == NULL) {
1163 /* no output buffer, reuse one of the GAP buffers then if we have one */
1165 GST_LOG_OBJECT (adder, "reusing GAP buffer %p", gapbuf);
1168 /* assume EOS otherwise, this should not happen, really */
1171 /* we had an output buffer, unref the gapbuffer we kept */
1172 gst_buffer_unref (gapbuf);
1174 /* our timestamping is very simple, just an ever incrementing
1175 * counter, the new segment time will take care of their respective
1177 if (adder->segment_pending) {
1180 /* FIXME, use rate/applied_rate as set on all sinkpads.
1181 * - currently we just set rate as received from last seek-event
1182 * We could potentially figure out the duration as well using
1183 * the current segment positions and the stated stop positions.
1184 * Also we just start from stream time 0 which is rather
1185 * weird. For non-synchronized mixing, the time should be
1186 * the min of the stream times of all received segments,
1187 * rationale being that the duration is at least going to
1188 * be as long as the earliest stream we start mixing. This
1189 * would also be correct for synchronized mixing but then
1190 * the later streams would be delayed until the stream times
1193 event = gst_event_new_new_segment_full (FALSE, adder->segment_rate,
1194 1.0, GST_FORMAT_TIME, adder->timestamp, -1, adder->segment_position);
1197 if (!gst_pad_push_event (adder->srcpad, event)) {
1198 GST_WARNING_OBJECT (adder->srcpad, "Sending event %p (%s) failed.",
1199 event, GST_EVENT_TYPE_NAME (event));
1201 adder->segment_pending = FALSE;
1202 adder->segment_position = 0;
1204 GST_WARNING_OBJECT (adder->srcpad, "Creating new segment event for "
1205 "start:%" G_GINT64_FORMAT " pos:%" G_GINT64_FORMAT " failed",
1206 adder->timestamp, adder->segment_position);
1210 if (G_UNLIKELY (adder->pending_events)) {
1211 GList *tmp = adder->pending_events;
1214 GstEvent *ev = (GstEvent *) tmp->data;
1216 gst_pad_push_event (adder->srcpad, ev);
1217 tmp = g_list_next (tmp);
1219 g_list_free (adder->pending_events);
1220 adder->pending_events = NULL;
1223 /* set timestamps on the output buffer */
1224 GST_BUFFER_TIMESTAMP (outbuf) = adder->timestamp;
1225 GST_BUFFER_OFFSET (outbuf) = adder->offset;
1227 /* for the next timestamp, use the sample counter, which will
1228 * never accumulate rounding errors */
1229 adder->offset += outsize / adder->bps;
1230 adder->timestamp = gst_util_uint64_scale_int (adder->offset,
1231 GST_SECOND, adder->rate);
1233 /* now we can set the duration of the buffer */
1234 GST_BUFFER_DURATION (outbuf) = adder->timestamp -
1235 GST_BUFFER_TIMESTAMP (outbuf);
1238 GST_LOG_OBJECT (adder, "pushing outbuf %p, timestamp %" GST_TIME_FORMAT,
1239 outbuf, GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)));
1240 ret = gst_pad_push (adder->srcpad, outbuf);
1242 GST_LOG_OBJECT (adder, "pushed outbuf, result = %s", gst_flow_get_name (ret));
1249 GST_ELEMENT_ERROR (adder, STREAM, FORMAT, (NULL),
1250 ("Unknown data received, not negotiated"));
1251 return GST_FLOW_NOT_NEGOTIATED;
1255 GST_DEBUG_OBJECT (adder, "no data available, must be EOS");
1256 gst_pad_push_event (adder->srcpad, gst_event_new_eos ());
1257 return GST_FLOW_UNEXPECTED;
1261 static GstStateChangeReturn
1262 gst_adder_change_state (GstElement * element, GstStateChange transition)
1265 GstStateChangeReturn ret;
1267 adder = GST_ADDER (element);
1269 switch (transition) {
1270 case GST_STATE_CHANGE_NULL_TO_READY:
1272 case GST_STATE_CHANGE_READY_TO_PAUSED:
1273 adder->timestamp = 0;
1275 adder->flush_stop_pending = FALSE;
1276 adder->segment_pending = TRUE;
1277 adder->segment_position = 0;
1278 adder->segment_rate = 1.0;
1279 gst_segment_init (&adder->segment, GST_FORMAT_UNDEFINED);
1280 gst_collect_pads_start (adder->collect);
1282 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1284 case GST_STATE_CHANGE_PAUSED_TO_READY:
1285 /* need to unblock the collectpads before calling the
1286 * parent change_state so that streaming can finish */
1287 gst_collect_pads_stop (adder->collect);
1293 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1295 switch (transition) {
1305 plugin_init (GstPlugin * plugin)
1309 if (!gst_element_register (plugin, "adder", GST_RANK_NONE, GST_TYPE_ADDER)) {
1316 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1319 "Adds multiple streams",
1320 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)