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 "gstadderorc.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 #define gst_adder_parent_class parent_class
120 G_DEFINE_TYPE (GstAdder, gst_adder, GST_TYPE_ELEMENT);
122 static void gst_adder_dispose (GObject * object);
123 static void gst_adder_set_property (GObject * object, guint prop_id,
124 const GValue * value, GParamSpec * pspec);
125 static void gst_adder_get_property (GObject * object, guint prop_id,
126 GValue * value, GParamSpec * pspec);
128 static gboolean gst_adder_setcaps (GstPad * pad, GstCaps * caps);
129 static gboolean gst_adder_query (GstPad * pad, GstQuery ** query);
130 static gboolean gst_adder_src_event (GstPad * pad, GstEvent * event);
131 static gboolean gst_adder_sink_event (GstPad * pad, GstEvent * event);
133 static GstPad *gst_adder_request_new_pad (GstElement * element,
134 GstPadTemplate * temp, const gchar * unused, const GstCaps * caps);
135 static void gst_adder_release_pad (GstElement * element, GstPad * pad);
137 static GstStateChangeReturn gst_adder_change_state (GstElement * element,
138 GstStateChange transition);
140 static GstBuffer *gst_adder_do_clip (GstCollectPads * pads,
141 GstCollectData * data, GstBuffer * buffer, gpointer user_data);
142 static GstFlowReturn gst_adder_collected (GstCollectPads * pads,
145 /* non-clipping versions (for float) */
146 #define MAKE_FUNC_NC(name,type) \
147 static void name (type *out, type *in, gint samples) { \
149 for (i = 0; i < samples; i++) \
154 MAKE_FUNC_NC (add_float64, gdouble)
157 /* we can only accept caps that we and downstream can handle.
158 * if we have filtercaps set, use those to constrain the target caps.
161 gst_adder_sink_getcaps (GstPad * pad)
164 GstCaps *result, *peercaps, *sinkcaps, *filter_caps;
166 adder = GST_ADDER (GST_PAD_PARENT (pad));
168 GST_OBJECT_LOCK (adder);
170 if ((filter_caps = adder->filter_caps))
171 gst_caps_ref (filter_caps);
172 GST_OBJECT_UNLOCK (adder);
174 /* get the downstream possible caps */
175 peercaps = gst_pad_peer_get_caps (adder->srcpad);
177 /* get the allowed caps on this sinkpad */
178 sinkcaps = gst_pad_get_current_caps (pad);
179 if (sinkcaps == NULL) {
180 sinkcaps = (GstCaps *) gst_pad_get_pad_template_caps (pad);
182 gst_caps_ref (sinkcaps);
184 sinkcaps = gst_caps_new_any ();
188 /* restrict with filter-caps if any */
190 GST_DEBUG_OBJECT (adder, "filtering peer caps");
191 result = gst_caps_intersect (peercaps, filter_caps);
192 gst_caps_unref (peercaps);
195 /* if the peer has caps, intersect */
196 GST_DEBUG_OBJECT (adder, "intersecting peer and template caps");
197 result = gst_caps_intersect (peercaps, sinkcaps);
198 gst_caps_unref (peercaps);
199 gst_caps_unref (sinkcaps);
201 /* the peer has no caps (or there is no peer), just use the allowed caps
202 * of this sinkpad. */
203 /* restrict with filter-caps if any */
205 GST_DEBUG_OBJECT (adder, "no peer caps, using filtered sinkcaps");
206 result = gst_caps_intersect (sinkcaps, filter_caps);
207 gst_caps_unref (sinkcaps);
209 GST_DEBUG_OBJECT (adder, "no peer caps, using sinkcaps");
215 gst_caps_unref (filter_caps);
217 GST_LOG_OBJECT (adder, "getting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
218 GST_PAD_NAME (pad), result);
230 setcapsfunc (const GValue * item, IterData * data)
232 GstPad *otherpad = g_value_get_object (item);
234 if (otherpad != data->pad)
235 gst_pad_set_caps (data->pad, data->caps);
238 /* the first caps we receive on any of the sinkpads will define the caps for all
239 * the other sinkpads because we can only mix streams with the same caps.
242 gst_adder_setcaps (GstPad * pad, GstCaps * caps)
245 GstStructure *structure;
246 const char *media_type;
248 GstIteratorResult ires;
252 adder = GST_ADDER (GST_PAD_PARENT (pad));
254 GST_LOG_OBJECT (adder, "setting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
255 GST_PAD_NAME (pad), caps);
257 it = gst_element_iterate_pads (GST_ELEMENT_CAST (adder));
259 /* FIXME, see if the other pads can accept the format. Also lock the
260 * format on the other pads to this new format. */
266 ires = gst_iterator_foreach (it, (GstIteratorForeachFunction) setcapsfunc,
270 case GST_ITERATOR_RESYNC:
271 gst_iterator_resync (it);
280 structure = gst_caps_get_structure (caps, 0);
281 media_type = gst_structure_get_name (structure);
282 if (strcmp (media_type, "audio/x-raw-int") == 0) {
283 adder->format = GST_ADDER_FORMAT_INT;
284 gst_structure_get_int (structure, "width", &adder->width);
285 gst_structure_get_int (structure, "depth", &adder->depth);
286 gst_structure_get_int (structure, "endianness", &adder->endianness);
287 gst_structure_get_boolean (structure, "signed", &adder->is_signed);
289 GST_INFO_OBJECT (pad, "parse_caps sets adder to format int, %d bit",
292 if (adder->endianness != G_BYTE_ORDER)
295 switch (adder->width) {
297 adder->func = (adder->is_signed ?
298 (GstAdderFunction) add_int8 : (GstAdderFunction) add_uint8);
299 adder->sample_size = 1;
302 adder->func = (adder->is_signed ?
303 (GstAdderFunction) add_int16 : (GstAdderFunction) add_uint16);
304 adder->sample_size = 2;
307 adder->func = (adder->is_signed ?
308 (GstAdderFunction) add_int32 : (GstAdderFunction) add_uint32);
309 adder->sample_size = 4;
314 } else if (strcmp (media_type, "audio/x-raw-float") == 0) {
315 adder->format = GST_ADDER_FORMAT_FLOAT;
316 gst_structure_get_int (structure, "width", &adder->width);
317 gst_structure_get_int (structure, "endianness", &adder->endianness);
319 GST_INFO_OBJECT (pad, "parse_caps sets adder to format float, %d bit",
322 if (adder->endianness != G_BYTE_ORDER)
325 switch (adder->width) {
327 adder->func = (GstAdderFunction) add_float32;
328 adder->sample_size = 4;
331 adder->func = (GstAdderFunction) add_float64;
332 adder->sample_size = 8;
341 gst_structure_get_int (structure, "channels", &adder->channels);
342 gst_structure_get_int (structure, "rate", &adder->rate);
344 adder->bps = (adder->width / 8) * adder->channels;
351 GST_DEBUG_OBJECT (adder, "unsupported format set as caps");
356 /* FIXME, the duration query should reflect how long you will produce
357 * data, that is the amount of stream time until you will emit EOS.
359 * For synchronized mixing this is always the max of all the durations
360 * of upstream since we emit EOS when all of them finished.
362 * We don't do synchronized mixing so this really depends on where the
363 * streams where punched in and what their relative offsets are against
364 * eachother which we can get from the first timestamps we see.
366 * When we add a new stream (or remove a stream) the duration might
367 * also become invalid again and we need to post a new DURATION
368 * message to notify this fact to the parent.
369 * For now we take the max of all the upstream elements so the simple
370 * cases work at least somewhat.
373 gst_adder_query_duration (GstAdder * adder, GstQuery ** query)
380 GValue item = { 0, };
383 gst_query_parse_duration (*query, &format, NULL);
389 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
391 GstIteratorResult ires;
393 ires = gst_iterator_next (it, &item);
395 case GST_ITERATOR_DONE:
398 case GST_ITERATOR_OK:
400 GstPad *pad = g_value_get_object (&item);
403 /* ask sink peer for duration */
404 res &= gst_pad_query_peer_duration (pad, &format, &duration);
405 /* take max from all valid return values */
407 /* valid unknown length, stop searching */
408 if (duration == -1) {
412 /* else see if bigger than current max */
413 else if (duration > max)
416 g_value_reset (&item);
419 case GST_ITERATOR_RESYNC:
422 gst_iterator_resync (it);
430 g_value_unset (&item);
431 gst_iterator_free (it);
434 /* and store the max */
435 GST_DEBUG_OBJECT (adder, "Total duration in format %s: %"
436 GST_TIME_FORMAT, gst_format_get_name (format), GST_TIME_ARGS (max));
437 gst_query_set_duration (*query, format, max);
444 gst_adder_query_latency (GstAdder * adder, GstQuery ** query)
446 GstClockTime min, max;
451 GValue item = { 0, };
458 max = GST_CLOCK_TIME_NONE;
460 /* Take maximum of all latency values */
461 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
463 GstIteratorResult ires;
465 ires = gst_iterator_next (it, &item);
467 case GST_ITERATOR_DONE:
470 case GST_ITERATOR_OK:
472 GstPad *pad = g_value_get_object (&item);
474 GstClockTime min_cur, max_cur;
477 peerquery = gst_query_new_latency ();
479 /* Ask peer for latency */
480 res &= gst_pad_peer_query (pad, &peerquery);
482 /* take max from all valid return values */
484 gst_query_parse_latency (peerquery, &live_cur, &min_cur, &max_cur);
489 if (max_cur != GST_CLOCK_TIME_NONE &&
490 ((max != GST_CLOCK_TIME_NONE && max_cur > max) ||
491 (max == GST_CLOCK_TIME_NONE)))
494 live = live || live_cur;
497 gst_query_unref (peerquery);
498 g_value_reset (&item);
501 case GST_ITERATOR_RESYNC:
504 max = GST_CLOCK_TIME_NONE;
506 gst_iterator_resync (it);
514 g_value_unset (&item);
515 gst_iterator_free (it);
518 /* store the results */
519 GST_DEBUG_OBJECT (adder, "Calculated total latency: live %s, min %"
520 GST_TIME_FORMAT ", max %" GST_TIME_FORMAT,
521 (live ? "yes" : "no"), GST_TIME_ARGS (min), GST_TIME_ARGS (max));
522 gst_query_set_latency (*query, live, min, max);
529 gst_adder_query (GstPad * pad, GstQuery ** query)
531 GstAdder *adder = GST_ADDER (gst_pad_get_parent (pad));
532 gboolean res = FALSE;
534 switch (GST_QUERY_TYPE (*query)) {
535 case GST_QUERY_POSITION:
539 gst_query_parse_position (*query, &format, NULL);
542 case GST_FORMAT_TIME:
543 /* FIXME, bring to stream time, might be tricky */
544 gst_query_set_position (*query, format, adder->segment.position);
547 case GST_FORMAT_DEFAULT:
548 gst_query_set_position (*query, format, adder->offset);
556 case GST_QUERY_DURATION:
557 res = gst_adder_query_duration (adder, query);
559 case GST_QUERY_LATENCY:
560 res = gst_adder_query_latency (adder, query);
563 /* FIXME, needs a custom query handler because we have multiple
565 res = gst_pad_query_default (pad, query);
569 gst_object_unref (adder);
580 forward_event_func (const GValue * val, GValue * ret, EventData * data)
582 GstPad *pad = g_value_get_object (val);
583 GstEvent *event = data->event;
585 gst_event_ref (event);
586 GST_LOG_OBJECT (pad, "About to send event %s", GST_EVENT_TYPE_NAME (event));
587 if (!gst_pad_push_event (pad, event)) {
588 GST_WARNING_OBJECT (pad, "Sending event %p (%s) failed.",
589 event, GST_EVENT_TYPE_NAME (event));
590 /* quick hack to unflush the pads, ideally we need a way to just unflush
591 * this single collect pad */
593 gst_pad_send_event (pad, gst_event_new_flush_stop ());
595 g_value_set_boolean (ret, TRUE);
596 GST_LOG_OBJECT (pad, "Sent event %p (%s).",
597 event, GST_EVENT_TYPE_NAME (event));
600 /* continue on other pads, even if one failed */
604 /* forwards the event to all sinkpads, takes ownership of the
607 * Returns: TRUE if the event could be forwarded on all
611 forward_event (GstAdder * adder, GstEvent * event, gboolean flush)
615 GstIteratorResult ires;
619 GST_LOG_OBJECT (adder, "Forwarding event %p (%s)", event,
620 GST_EVENT_TYPE_NAME (event));
625 g_value_init (&vret, G_TYPE_BOOLEAN);
626 g_value_set_boolean (&vret, FALSE);
627 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
630 gst_iterator_fold (it, (GstIteratorFoldFunction) forward_event_func,
633 case GST_ITERATOR_RESYNC:
634 GST_WARNING ("resync");
635 gst_iterator_resync (it);
636 g_value_set_boolean (&vret, TRUE);
638 case GST_ITERATOR_OK:
639 case GST_ITERATOR_DONE:
640 ret = g_value_get_boolean (&vret);
648 gst_iterator_free (it);
649 GST_LOG_OBJECT (adder, "Forwarded event %p (%s), ret=%d", event,
650 GST_EVENT_TYPE_NAME (event), ret);
651 gst_event_unref (event);
657 gst_adder_src_event (GstPad * pad, GstEvent * event)
662 adder = GST_ADDER (gst_pad_get_parent (pad));
664 switch (GST_EVENT_TYPE (event)) {
669 GstSeekType curtype, endtype;
673 /* parse the seek parameters */
674 gst_event_parse_seek (event, &rate, NULL, &flags, &curtype,
675 &cur, &endtype, &end);
677 if ((curtype != GST_SEEK_TYPE_NONE) && (curtype != GST_SEEK_TYPE_SET)) {
679 GST_DEBUG_OBJECT (adder,
680 "seeking failed, unhandled seek type for start: %d", curtype);
683 if ((endtype != GST_SEEK_TYPE_NONE) && (endtype != GST_SEEK_TYPE_SET)) {
685 GST_DEBUG_OBJECT (adder,
686 "seeking failed, unhandled seek type for end: %d", endtype);
690 flush = (flags & GST_SEEK_FLAG_FLUSH) == GST_SEEK_FLAG_FLUSH;
692 /* check if we are flushing */
694 /* make sure we accept nothing anymore and return WRONG_STATE */
695 gst_collect_pads_set_flushing (adder->collect, TRUE);
697 /* flushing seek, start flush downstream, the flush will be done
698 * when all pads received a FLUSH_STOP. */
699 gst_pad_push_event (adder->srcpad, gst_event_new_flush_start ());
701 /* We can't send FLUSH_STOP here since upstream could start pushing data
702 * after we unlock adder->collect.
703 * We set flush_stop_pending to TRUE instead and send FLUSH_STOP after
704 * forwarding the seek upstream or from gst_adder_collected,
705 * whichever happens first.
707 adder->flush_stop_pending = TRUE;
709 GST_DEBUG_OBJECT (adder, "handling seek event: %" GST_PTR_FORMAT, event);
711 /* now wait for the collected to be finished and mark a new
712 * segment. After we have the lock, no collect function is running and no
713 * new collect function will be called for as long as we're flushing. */
714 GST_OBJECT_LOCK (adder->collect);
715 adder->segment.rate = rate;
716 if (curtype == GST_SEEK_TYPE_SET)
717 adder->segment.start = cur;
719 adder->segment.start = 0;
720 if (endtype == GST_SEEK_TYPE_SET)
721 adder->segment.stop = end;
723 adder->segment.stop = GST_CLOCK_TIME_NONE;
724 /* make sure we push a new segment, to inform about new basetime
725 * see FIXME in gst_adder_collected() */
726 adder->segment_pending = TRUE;
728 /* Yes, we need to call _set_flushing again *WHEN* the streaming threads
729 * have stopped so that the cookie gets properly updated. */
730 gst_collect_pads_set_flushing (adder->collect, TRUE);
732 GST_OBJECT_UNLOCK (adder->collect);
733 GST_DEBUG_OBJECT (adder, "forwarding seek event: %" GST_PTR_FORMAT,
736 result = forward_event (adder, event, flush);
738 /* seek failed. maybe source is a live source. */
739 GST_DEBUG_OBJECT (adder, "seeking failed");
741 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
743 GST_DEBUG_OBJECT (adder, "pending flush stop");
744 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop ());
749 /* QoS might be tricky */
752 case GST_EVENT_NAVIGATION:
753 /* navigation is rather pointless. */
757 /* just forward the rest for now */
758 GST_DEBUG_OBJECT (adder, "forward unhandled event: %s",
759 GST_EVENT_TYPE_NAME (event));
760 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;
834 g_object_class_install_property (gobject_class, PROP_FILTER_CAPS,
835 g_param_spec_boxed ("caps", "Target caps",
836 "Set target format for mixing (NULL means ANY). "
837 "Setting this property takes a reference to the supplied GstCaps "
838 "object.", GST_TYPE_CAPS,
839 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
841 gst_element_class_add_pad_template (gstelement_class,
842 gst_static_pad_template_get (&gst_adder_src_template));
843 gst_element_class_add_pad_template (gstelement_class,
844 gst_static_pad_template_get (&gst_adder_sink_template));
845 gst_element_class_set_details_simple (gstelement_class, "Adder",
847 "Add N audio channels together",
848 "Thomas Vander Stichele <thomas at apestaart dot org>");
850 gstelement_class->request_new_pad =
851 GST_DEBUG_FUNCPTR (gst_adder_request_new_pad);
852 gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_adder_release_pad);
853 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_adder_change_state);
857 gst_adder_init (GstAdder * adder)
859 GstPadTemplate *template;
861 template = gst_static_pad_template_get (&gst_adder_src_template);
862 adder->srcpad = gst_pad_new_from_template (template, "src");
863 gst_object_unref (template);
865 gst_pad_set_getcaps_function (adder->srcpad,
866 GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
867 gst_pad_set_setcaps_function (adder->srcpad,
868 GST_DEBUG_FUNCPTR (gst_adder_setcaps));
869 gst_pad_set_query_function (adder->srcpad,
870 GST_DEBUG_FUNCPTR (gst_adder_query));
871 gst_pad_set_event_function (adder->srcpad,
872 GST_DEBUG_FUNCPTR (gst_adder_src_event));
873 gst_element_add_pad (GST_ELEMENT (adder), adder->srcpad);
875 adder->format = GST_ADDER_FORMAT_UNSET;
879 adder->filter_caps = NULL;
881 /* keep track of the sinkpads requested */
882 adder->collect = gst_collect_pads_new ();
883 gst_collect_pads_set_function (adder->collect,
884 GST_DEBUG_FUNCPTR (gst_adder_collected), adder);
885 gst_collect_pads_set_clip_function (adder->collect,
886 GST_DEBUG_FUNCPTR (gst_adder_do_clip), adder);
890 gst_adder_dispose (GObject * object)
892 GstAdder *adder = GST_ADDER (object);
894 if (adder->collect) {
895 gst_object_unref (adder->collect);
896 adder->collect = NULL;
898 gst_caps_replace (&adder->filter_caps, NULL);
899 if (adder->pending_events) {
900 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
901 g_list_free (adder->pending_events);
902 adder->pending_events = NULL;
905 G_OBJECT_CLASS (parent_class)->dispose (object);
909 gst_adder_set_property (GObject * object, guint prop_id,
910 const GValue * value, GParamSpec * pspec)
912 GstAdder *adder = GST_ADDER (object);
915 case PROP_FILTER_CAPS:{
916 GstCaps *new_caps = NULL;
918 const GstCaps *new_caps_val = gst_value_get_caps (value);
920 if (new_caps_val != NULL) {
921 new_caps = (GstCaps *) new_caps_val;
922 gst_caps_ref (new_caps);
925 GST_OBJECT_LOCK (adder);
926 old_caps = adder->filter_caps;
927 adder->filter_caps = new_caps;
928 GST_OBJECT_UNLOCK (adder);
931 gst_caps_unref (old_caps);
933 GST_DEBUG_OBJECT (adder, "set new caps %" GST_PTR_FORMAT, new_caps);
937 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
943 gst_adder_get_property (GObject * object, guint prop_id, GValue * value,
946 GstAdder *adder = GST_ADDER (object);
949 case PROP_FILTER_CAPS:
950 GST_OBJECT_LOCK (adder);
951 gst_value_set_caps (value, adder->filter_caps);
952 GST_OBJECT_UNLOCK (adder);
955 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
962 gst_adder_request_new_pad (GstElement * element, GstPadTemplate * templ,
963 const gchar * unused, const GstCaps * caps)
970 if (templ->direction != GST_PAD_SINK)
973 adder = GST_ADDER (element);
975 /* increment pad counter */
976 padcount = g_atomic_int_exchange_and_add (&adder->padcount, 1);
978 name = g_strdup_printf ("sink%d", padcount);
979 newpad = gst_pad_new_from_template (templ, name);
980 GST_DEBUG_OBJECT (adder, "request new pad %s", name);
983 gst_pad_set_getcaps_function (newpad,
984 GST_DEBUG_FUNCPTR (gst_adder_sink_getcaps));
985 gst_pad_set_setcaps_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_setcaps));
986 gst_collect_pads_add_pad (adder->collect, newpad, sizeof (GstCollectData));
988 /* FIXME: hacked way to override/extend the event function of
989 * GstCollectPads; because it sets its own event function giving the
990 * element no access to events */
991 adder->collect_event = (GstPadEventFunction) GST_PAD_EVENTFUNC (newpad);
992 gst_pad_set_event_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_sink_event));
994 /* takes ownership of the pad */
995 if (!gst_element_add_pad (GST_ELEMENT (adder), newpad))
1003 g_warning ("gstadder: request new pad that is not a SINK pad\n");
1008 GST_DEBUG_OBJECT (adder, "could not add pad");
1009 gst_collect_pads_remove_pad (adder->collect, newpad);
1010 gst_object_unref (newpad);
1016 gst_adder_release_pad (GstElement * element, GstPad * pad)
1020 adder = GST_ADDER (element);
1022 GST_DEBUG_OBJECT (adder, "release pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1024 gst_collect_pads_remove_pad (adder->collect, pad);
1025 gst_element_remove_pad (element, pad);
1029 gst_adder_do_clip (GstCollectPads * pads, GstCollectData * data,
1030 GstBuffer * buffer, gpointer user_data)
1032 GstAdder *adder = GST_ADDER (user_data);
1034 buffer = gst_audio_buffer_clip (buffer, &data->segment, adder->rate,
1040 static GstFlowReturn
1041 gst_adder_collected (GstCollectPads * pads, gpointer user_data)
1044 * combine streams by adding data values
1046 * - this function is called when all pads have a buffer
1047 * - get available bytes on all pads.
1048 * - repeat for each input pad :
1049 * - read available bytes, copy or add to target buffer
1050 * - if there's an EOS event, remove the input channel
1051 * - push out the output buffer
1054 * - would be nice to have a mixing mode, where instead of adding we mix
1055 * - for float we could downscale after collect loop
1056 * - for int we need to downscale each input to avoid clipping or
1057 * mix into a temp (float) buffer and scale afterwards as well
1060 GSList *collected, *next = NULL;
1062 GstBuffer *outbuf = NULL, *gapbuf = NULL;
1063 gpointer outdata = NULL;
1066 gint64 next_timestamp;
1068 adder = GST_ADDER (user_data);
1071 if (G_UNLIKELY (adder->func == NULL))
1072 goto not_negotiated;
1074 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
1076 GST_DEBUG_OBJECT (adder, "pending flush stop");
1077 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop ());
1080 /* get available bytes for reading, this can be 0 which could mean empty
1081 * buffers or EOS, which we will catch when we loop over the pads. */
1082 outsize = gst_collect_pads_available (pads);
1083 /* can only happen when no pads to collect or all EOS */
1087 GST_LOG_OBJECT (adder,
1088 "starting to cycle through channels, %d bytes available (bps = %d)",
1089 outsize, adder->bps);
1091 for (collected = pads->data; collected; collected = next) {
1092 GstCollectData *collect_data;
1096 /* take next to see if this is the last collectdata */
1097 next = g_slist_next (collected);
1099 collect_data = (GstCollectData *) collected->data;
1101 /* get a buffer of size bytes, if we get a buffer, it is at least outsize
1103 inbuf = gst_collect_pads_take_buffer (pads, collect_data, outsize);
1104 /* NULL means EOS or an empty buffer so we still need to flush in
1105 * case of an empty buffer. */
1106 if (inbuf == NULL) {
1107 GST_LOG_OBJECT (adder, "channel %p: no bytes available", collect_data);
1111 is_gap = GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP);
1113 /* Try to make an output buffer */
1114 if (outbuf == NULL) {
1115 /* if this is a gap buffer but we have some more pads to check, skip it.
1116 * If we are at the last buffer, take it, regardless if it is a GAP
1118 if (is_gap && next) {
1119 GST_DEBUG_OBJECT (adder, "skipping, non-last GAP buffer");
1120 /* we keep the GAP buffer, if we don't have anymore buffers (all pads
1121 * EOS, we can use this one as the output buffer. */
1125 gst_buffer_unref (inbuf);
1129 GST_LOG_OBJECT (adder, "channel %p: preparing output buffer of %d bytes",
1130 collect_data, outsize);
1132 outdata = gst_buffer_map (outbuf, NULL, NULL, GST_MAP_WRITE);
1135 /* we had a previous output buffer, mix this non-GAP buffer */
1139 indata = gst_buffer_map (inbuf, &insize, NULL, GST_MAP_READ);
1141 /* all buffers should have outsize, there are no short buffers because we
1142 * asked for the max size above */
1143 g_assert (insize == outsize);
1145 GST_LOG_OBJECT (adder, "channel %p: mixing %d bytes from data %p",
1146 collect_data, insize, indata);
1148 /* further buffers, need to add them */
1149 adder->func ((gpointer) outdata, (gpointer) indata,
1150 insize / adder->sample_size);
1151 gst_buffer_unmap (inbuf, indata, insize);
1153 /* skip gap buffer */
1154 GST_LOG_OBJECT (adder, "channel %p: skipping GAP buffer", collect_data);
1156 gst_buffer_unref (inbuf);
1160 gst_buffer_unmap (outbuf, outdata, outsize);
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 if (adder->segment_pending) {
1177 /* FIXME, use rate/applied_rate as set on all sinkpads.
1178 * - currently we just set rate as received from last seek-event
1180 * When seeking we set the start and stop positions as given in the seek
1181 * event. We also adjust offset & timestamp acordingly.
1182 * This basically ignores all newsegments sent by upstream.
1184 event = gst_event_new_segment (&adder->segment);
1186 if (adder->segment.rate > 0.0) {
1187 adder->segment.position = adder->segment.start;
1189 adder->segment.position = adder->segment.stop;
1191 adder->offset = gst_util_uint64_scale (adder->segment.position,
1192 adder->rate, GST_SECOND);
1193 GST_INFO_OBJECT (adder, "seg_start %" G_GUINT64_FORMAT ", seg_end %"
1194 G_GUINT64_FORMAT, adder->segment.start, adder->segment.stop);
1195 GST_INFO_OBJECT (adder, "timestamp %" G_GINT64_FORMAT ",new offset %"
1196 G_GINT64_FORMAT, adder->segment.position, adder->offset);
1199 if (!gst_pad_push_event (adder->srcpad, event)) {
1200 GST_WARNING_OBJECT (adder->srcpad, "Sending event %p (%s) failed.",
1201 event, GST_EVENT_TYPE_NAME (event));
1203 adder->segment_pending = FALSE;
1205 GST_WARNING_OBJECT (adder->srcpad, "Creating new segment event for "
1206 "start:%" G_GINT64_FORMAT " end:%" G_GINT64_FORMAT " failed",
1207 adder->segment.start, adder->segment.stop);
1211 if (G_UNLIKELY (adder->pending_events)) {
1212 GList *tmp = adder->pending_events;
1215 GstEvent *ev = (GstEvent *) tmp->data;
1217 gst_pad_push_event (adder->srcpad, ev);
1218 tmp = g_list_next (tmp);
1220 g_list_free (adder->pending_events);
1221 adder->pending_events = NULL;
1224 /* for the next timestamp, use the sample counter, which will
1225 * never accumulate rounding errors */
1226 if (adder->segment.rate > 0.0) {
1227 next_offset = adder->offset + outsize / adder->bps;
1229 next_offset = adder->offset - outsize / adder->bps;
1231 next_timestamp = gst_util_uint64_scale (next_offset, GST_SECOND, adder->rate);
1234 /* set timestamps on the output buffer */
1235 if (adder->segment.rate > 0.0) {
1236 GST_BUFFER_TIMESTAMP (outbuf) = adder->segment.position;
1237 GST_BUFFER_OFFSET (outbuf) = adder->offset;
1238 GST_BUFFER_OFFSET_END (outbuf) = next_offset;
1239 GST_BUFFER_DURATION (outbuf) = next_timestamp - adder->segment.position;
1241 GST_BUFFER_TIMESTAMP (outbuf) = next_timestamp;
1242 GST_BUFFER_OFFSET (outbuf) = next_offset;
1243 GST_BUFFER_OFFSET_END (outbuf) = adder->offset;
1244 GST_BUFFER_DURATION (outbuf) = adder->segment.position - next_timestamp;
1247 adder->offset = next_offset;
1248 adder->segment.position = next_timestamp;
1251 GST_LOG_OBJECT (adder, "pushing outbuf %p, timestamp %" GST_TIME_FORMAT
1252 " offset %" G_GINT64_FORMAT, outbuf,
1253 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)),
1254 GST_BUFFER_OFFSET (outbuf));
1255 ret = gst_pad_push (adder->srcpad, outbuf);
1257 GST_LOG_OBJECT (adder, "pushed outbuf, result = %s", gst_flow_get_name (ret));
1264 GST_ELEMENT_ERROR (adder, STREAM, FORMAT, (NULL),
1265 ("Unknown data received, not negotiated"));
1266 return GST_FLOW_NOT_NEGOTIATED;
1270 GST_DEBUG_OBJECT (adder, "no data available, must be EOS");
1271 gst_pad_push_event (adder->srcpad, gst_event_new_eos ());
1272 return GST_FLOW_UNEXPECTED;
1276 static GstStateChangeReturn
1277 gst_adder_change_state (GstElement * element, GstStateChange transition)
1280 GstStateChangeReturn ret;
1282 adder = GST_ADDER (element);
1284 switch (transition) {
1285 case GST_STATE_CHANGE_NULL_TO_READY:
1287 case GST_STATE_CHANGE_READY_TO_PAUSED:
1288 adder->segment.position = 0;
1290 adder->flush_stop_pending = FALSE;
1291 adder->segment_pending = TRUE;
1292 gst_segment_init (&adder->segment, GST_FORMAT_TIME);
1293 gst_collect_pads_start (adder->collect);
1295 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1297 case GST_STATE_CHANGE_PAUSED_TO_READY:
1298 /* need to unblock the collectpads before calling the
1299 * parent change_state so that streaming can finish */
1300 gst_collect_pads_stop (adder->collect);
1306 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1308 switch (transition) {
1318 plugin_init (GstPlugin * plugin)
1320 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "adder", 0,
1321 "audio channel mixing element");
1323 gst_adder_orc_init ();
1325 if (!gst_element_register (plugin, "adder", GST_RANK_NONE, GST_TYPE_ADDER)) {
1332 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1335 "Adds multiple streams",
1336 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)