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, GstCaps * filter)
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)) {
173 gst_caps_intersect_full (filter, filter_caps,
174 GST_CAPS_INTERSECT_FIRST);
176 gst_caps_ref (filter_caps);
178 filter_caps = gst_caps_ref (filter);
180 GST_OBJECT_UNLOCK (adder);
182 if (filter_caps && gst_caps_is_empty (filter_caps)) {
183 GST_WARNING_OBJECT (pad, "Empty filter caps");
187 /* get the downstream possible caps */
188 peercaps = gst_pad_peer_get_caps (adder->srcpad, filter_caps);
190 /* get the allowed caps on this sinkpad */
191 sinkcaps = gst_pad_get_current_caps (pad);
192 if (sinkcaps == NULL) {
193 sinkcaps = (GstCaps *) gst_pad_get_pad_template_caps (pad);
195 gst_caps_ref (sinkcaps);
197 sinkcaps = gst_caps_new_any ();
201 /* if the peer has caps, intersect */
202 GST_DEBUG_OBJECT (adder, "intersecting peer and template caps");
204 gst_caps_intersect_full (peercaps, sinkcaps, GST_CAPS_INTERSECT_FIRST);
205 gst_caps_unref (peercaps);
206 gst_caps_unref (sinkcaps);
208 /* the peer has no caps (or there is no peer), just use the allowed caps
209 * of this sinkpad. */
210 /* restrict with filter-caps if any */
212 GST_DEBUG_OBJECT (adder, "no peer caps, using filtered sinkcaps");
214 gst_caps_intersect_full (filter_caps, sinkcaps,
215 GST_CAPS_INTERSECT_FIRST);
216 gst_caps_unref (sinkcaps);
218 GST_DEBUG_OBJECT (adder, "no peer caps, using sinkcaps");
224 gst_caps_unref (filter_caps);
226 GST_LOG_OBJECT (adder, "getting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
227 GST_PAD_NAME (pad), result);
239 setcapsfunc (const GValue * item, IterData * data)
241 GstPad *otherpad = g_value_get_object (item);
243 if (otherpad != data->pad)
244 gst_pad_set_caps (data->pad, data->caps);
247 /* the first caps we receive on any of the sinkpads will define the caps for all
248 * the other sinkpads because we can only mix streams with the same caps.
251 gst_adder_setcaps (GstPad * pad, GstCaps * caps)
254 GstStructure *structure;
255 const char *media_type;
257 GstIteratorResult ires;
261 adder = GST_ADDER (GST_PAD_PARENT (pad));
263 GST_LOG_OBJECT (adder, "setting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
264 GST_PAD_NAME (pad), caps);
266 it = gst_element_iterate_pads (GST_ELEMENT_CAST (adder));
268 /* FIXME, see if the other pads can accept the format. Also lock the
269 * format on the other pads to this new format. */
275 ires = gst_iterator_foreach (it, (GstIteratorForeachFunction) setcapsfunc,
279 case GST_ITERATOR_RESYNC:
280 gst_iterator_resync (it);
289 structure = gst_caps_get_structure (caps, 0);
290 media_type = gst_structure_get_name (structure);
291 if (strcmp (media_type, "audio/x-raw-int") == 0) {
292 adder->format = GST_ADDER_FORMAT_INT;
293 gst_structure_get_int (structure, "width", &adder->width);
294 gst_structure_get_int (structure, "depth", &adder->depth);
295 gst_structure_get_int (structure, "endianness", &adder->endianness);
296 gst_structure_get_boolean (structure, "signed", &adder->is_signed);
298 GST_INFO_OBJECT (pad, "parse_caps sets adder to format int, %d bit",
301 if (adder->endianness != G_BYTE_ORDER)
304 switch (adder->width) {
306 adder->func = (adder->is_signed ?
307 (GstAdderFunction) add_int8 : (GstAdderFunction) add_uint8);
308 adder->sample_size = 1;
311 adder->func = (adder->is_signed ?
312 (GstAdderFunction) add_int16 : (GstAdderFunction) add_uint16);
313 adder->sample_size = 2;
316 adder->func = (adder->is_signed ?
317 (GstAdderFunction) add_int32 : (GstAdderFunction) add_uint32);
318 adder->sample_size = 4;
323 } else if (strcmp (media_type, "audio/x-raw-float") == 0) {
324 adder->format = GST_ADDER_FORMAT_FLOAT;
325 gst_structure_get_int (structure, "width", &adder->width);
326 gst_structure_get_int (structure, "endianness", &adder->endianness);
328 GST_INFO_OBJECT (pad, "parse_caps sets adder to format float, %d bit",
331 if (adder->endianness != G_BYTE_ORDER)
334 switch (adder->width) {
336 adder->func = (GstAdderFunction) add_float32;
337 adder->sample_size = 4;
340 adder->func = (GstAdderFunction) add_float64;
341 adder->sample_size = 8;
350 gst_structure_get_int (structure, "channels", &adder->channels);
351 gst_structure_get_int (structure, "rate", &adder->rate);
353 adder->bps = (adder->width / 8) * adder->channels;
360 GST_DEBUG_OBJECT (adder, "unsupported format set as caps");
365 /* FIXME, the duration query should reflect how long you will produce
366 * data, that is the amount of stream time until you will emit EOS.
368 * For synchronized mixing this is always the max of all the durations
369 * of upstream since we emit EOS when all of them finished.
371 * We don't do synchronized mixing so this really depends on where the
372 * streams where punched in and what their relative offsets are against
373 * eachother which we can get from the first timestamps we see.
375 * When we add a new stream (or remove a stream) the duration might
376 * also become invalid again and we need to post a new DURATION
377 * message to notify this fact to the parent.
378 * For now we take the max of all the upstream elements so the simple
379 * cases work at least somewhat.
382 gst_adder_query_duration (GstAdder * adder, GstQuery * query)
389 GValue item = { 0, };
392 gst_query_parse_duration (query, &format, NULL);
398 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
400 GstIteratorResult ires;
402 ires = gst_iterator_next (it, &item);
404 case GST_ITERATOR_DONE:
407 case GST_ITERATOR_OK:
409 GstPad *pad = g_value_get_object (&item);
412 /* ask sink peer for duration */
413 res &= gst_pad_query_peer_duration (pad, &format, &duration);
414 /* take max from all valid return values */
416 /* valid unknown length, stop searching */
417 if (duration == -1) {
421 /* else see if bigger than current max */
422 else if (duration > max)
425 g_value_reset (&item);
428 case GST_ITERATOR_RESYNC:
431 gst_iterator_resync (it);
439 g_value_unset (&item);
440 gst_iterator_free (it);
443 /* and store the max */
444 GST_DEBUG_OBJECT (adder, "Total duration in format %s: %"
445 GST_TIME_FORMAT, gst_format_get_name (format), GST_TIME_ARGS (max));
446 gst_query_set_duration (query, format, max);
453 gst_adder_query_latency (GstAdder * adder, GstQuery * query)
455 GstClockTime min, max;
460 GValue item = { 0, };
467 max = GST_CLOCK_TIME_NONE;
469 /* Take maximum of all latency values */
470 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
472 GstIteratorResult ires;
474 ires = gst_iterator_next (it, &item);
476 case GST_ITERATOR_DONE:
479 case GST_ITERATOR_OK:
481 GstPad *pad = g_value_get_object (&item);
483 GstClockTime min_cur, max_cur;
486 peerquery = gst_query_new_latency ();
488 /* Ask peer for latency */
489 res &= gst_pad_peer_query (pad, peerquery);
491 /* take max from all valid return values */
493 gst_query_parse_latency (peerquery, &live_cur, &min_cur, &max_cur);
498 if (max_cur != GST_CLOCK_TIME_NONE &&
499 ((max != GST_CLOCK_TIME_NONE && max_cur > max) ||
500 (max == GST_CLOCK_TIME_NONE)))
503 live = live || live_cur;
506 gst_query_unref (peerquery);
507 g_value_reset (&item);
510 case GST_ITERATOR_RESYNC:
513 max = GST_CLOCK_TIME_NONE;
515 gst_iterator_resync (it);
523 g_value_unset (&item);
524 gst_iterator_free (it);
527 /* store the results */
528 GST_DEBUG_OBJECT (adder, "Calculated total latency: live %s, min %"
529 GST_TIME_FORMAT ", max %" GST_TIME_FORMAT,
530 (live ? "yes" : "no"), GST_TIME_ARGS (min), GST_TIME_ARGS (max));
531 gst_query_set_latency (query, live, min, max);
538 gst_adder_query (GstPad * pad, GstQuery * query)
540 GstAdder *adder = GST_ADDER (gst_pad_get_parent (pad));
541 gboolean res = FALSE;
543 switch (GST_QUERY_TYPE (query)) {
544 case GST_QUERY_POSITION:
548 gst_query_parse_position (query, &format, NULL);
551 case GST_FORMAT_TIME:
552 /* FIXME, bring to stream time, might be tricky */
553 gst_query_set_position (query, format, adder->segment.position);
556 case GST_FORMAT_DEFAULT:
557 gst_query_set_position (query, format, adder->offset);
565 case GST_QUERY_DURATION:
566 res = gst_adder_query_duration (adder, query);
568 case GST_QUERY_LATENCY:
569 res = gst_adder_query_latency (adder, query);
572 /* FIXME, needs a custom query handler because we have multiple
574 res = gst_pad_query_default (pad, query);
578 gst_object_unref (adder);
589 forward_event_func (const GValue * val, GValue * ret, EventData * data)
591 GstPad *pad = g_value_get_object (val);
592 GstEvent *event = data->event;
594 gst_event_ref (event);
595 GST_LOG_OBJECT (pad, "About to send event %s", GST_EVENT_TYPE_NAME (event));
596 if (!gst_pad_push_event (pad, event)) {
597 GST_WARNING_OBJECT (pad, "Sending event %p (%s) failed.",
598 event, GST_EVENT_TYPE_NAME (event));
599 /* quick hack to unflush the pads, ideally we need a way to just unflush
600 * this single collect pad */
602 gst_pad_send_event (pad, gst_event_new_flush_stop ());
604 g_value_set_boolean (ret, TRUE);
605 GST_LOG_OBJECT (pad, "Sent event %p (%s).",
606 event, GST_EVENT_TYPE_NAME (event));
609 /* continue on other pads, even if one failed */
613 /* forwards the event to all sinkpads, takes ownership of the
616 * Returns: TRUE if the event could be forwarded on all
620 forward_event (GstAdder * adder, GstEvent * event, gboolean flush)
624 GstIteratorResult ires;
628 GST_LOG_OBJECT (adder, "Forwarding event %p (%s)", event,
629 GST_EVENT_TYPE_NAME (event));
634 g_value_init (&vret, G_TYPE_BOOLEAN);
635 g_value_set_boolean (&vret, FALSE);
636 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
639 gst_iterator_fold (it, (GstIteratorFoldFunction) forward_event_func,
642 case GST_ITERATOR_RESYNC:
643 GST_WARNING ("resync");
644 gst_iterator_resync (it);
645 g_value_set_boolean (&vret, TRUE);
647 case GST_ITERATOR_OK:
648 case GST_ITERATOR_DONE:
649 ret = g_value_get_boolean (&vret);
657 gst_iterator_free (it);
658 GST_LOG_OBJECT (adder, "Forwarded event %p (%s), ret=%d", event,
659 GST_EVENT_TYPE_NAME (event), ret);
660 gst_event_unref (event);
666 gst_adder_src_event (GstPad * pad, GstEvent * event)
671 adder = GST_ADDER (gst_pad_get_parent (pad));
673 switch (GST_EVENT_TYPE (event)) {
678 GstSeekType curtype, endtype;
682 /* parse the seek parameters */
683 gst_event_parse_seek (event, &rate, NULL, &flags, &curtype,
684 &cur, &endtype, &end);
686 if ((curtype != GST_SEEK_TYPE_NONE) && (curtype != GST_SEEK_TYPE_SET)) {
688 GST_DEBUG_OBJECT (adder,
689 "seeking failed, unhandled seek type for start: %d", curtype);
692 if ((endtype != GST_SEEK_TYPE_NONE) && (endtype != GST_SEEK_TYPE_SET)) {
694 GST_DEBUG_OBJECT (adder,
695 "seeking failed, unhandled seek type for end: %d", endtype);
699 flush = (flags & GST_SEEK_FLAG_FLUSH) == GST_SEEK_FLAG_FLUSH;
701 /* check if we are flushing */
703 /* make sure we accept nothing anymore and return WRONG_STATE */
704 gst_collect_pads_set_flushing (adder->collect, TRUE);
706 /* flushing seek, start flush downstream, the flush will be done
707 * when all pads received a FLUSH_STOP. */
708 gst_pad_push_event (adder->srcpad, gst_event_new_flush_start ());
710 /* We can't send FLUSH_STOP here since upstream could start pushing data
711 * after we unlock adder->collect.
712 * We set flush_stop_pending to TRUE instead and send FLUSH_STOP after
713 * forwarding the seek upstream or from gst_adder_collected,
714 * whichever happens first.
716 adder->flush_stop_pending = TRUE;
718 GST_DEBUG_OBJECT (adder, "handling seek event: %" GST_PTR_FORMAT, event);
720 /* now wait for the collected to be finished and mark a new
721 * segment. After we have the lock, no collect function is running and no
722 * new collect function will be called for as long as we're flushing. */
723 GST_OBJECT_LOCK (adder->collect);
724 adder->segment.rate = rate;
725 if (curtype == GST_SEEK_TYPE_SET)
726 adder->segment.start = cur;
728 adder->segment.start = 0;
729 if (endtype == GST_SEEK_TYPE_SET)
730 adder->segment.stop = end;
732 adder->segment.stop = GST_CLOCK_TIME_NONE;
733 /* make sure we push a new segment, to inform about new basetime
734 * see FIXME in gst_adder_collected() */
735 adder->segment_pending = TRUE;
737 /* Yes, we need to call _set_flushing again *WHEN* the streaming threads
738 * have stopped so that the cookie gets properly updated. */
739 gst_collect_pads_set_flushing (adder->collect, TRUE);
741 GST_OBJECT_UNLOCK (adder->collect);
742 GST_DEBUG_OBJECT (adder, "forwarding seek event: %" GST_PTR_FORMAT,
745 result = forward_event (adder, event, flush);
747 /* seek failed. maybe source is a live source. */
748 GST_DEBUG_OBJECT (adder, "seeking failed");
750 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
752 GST_DEBUG_OBJECT (adder, "pending flush stop");
753 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop ());
758 /* QoS might be tricky */
761 case GST_EVENT_NAVIGATION:
762 /* navigation is rather pointless. */
766 /* just forward the rest for now */
767 GST_DEBUG_OBJECT (adder, "forward unhandled event: %s",
768 GST_EVENT_TYPE_NAME (event));
769 result = forward_event (adder, event, FALSE);
774 gst_object_unref (adder);
780 gst_adder_sink_event (GstPad * pad, GstEvent * event)
785 adder = GST_ADDER (gst_pad_get_parent (pad));
787 GST_DEBUG ("Got %s event on pad %s:%s", GST_EVENT_TYPE_NAME (event),
788 GST_DEBUG_PAD_NAME (pad));
790 switch (GST_EVENT_TYPE (event)) {
791 case GST_EVENT_FLUSH_STOP:
792 /* we received a flush-stop. The collect_event function will push the
793 * event past our element. We simply forward all flush-stop events, even
794 * when no flush-stop was pending, this is required because collectpads
795 * does not provide an API to handle-but-not-forward the flush-stop.
796 * We unset the pending flush-stop flag so that we don't send anymore
797 * flush-stop from the collect function later.
799 GST_OBJECT_LOCK (adder->collect);
800 adder->segment_pending = TRUE;
801 adder->flush_stop_pending = FALSE;
802 /* Clear pending tags */
803 if (adder->pending_events) {
804 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
805 g_list_free (adder->pending_events);
806 adder->pending_events = NULL;
808 GST_OBJECT_UNLOCK (adder->collect);
811 GST_OBJECT_LOCK (adder->collect);
812 /* collect tags here so we can push them out when we collect data */
813 adder->pending_events = g_list_append (adder->pending_events, event);
814 GST_OBJECT_UNLOCK (adder->collect);
820 /* now GstCollectPads can take care of the rest, e.g. EOS */
821 ret = adder->collect_event (pad, event);
824 gst_object_unref (adder);
829 gst_adder_class_init (GstAdderClass * klass)
831 GObjectClass *gobject_class = (GObjectClass *) klass;
832 GstElementClass *gstelement_class = (GstElementClass *) klass;
834 gobject_class->set_property = gst_adder_set_property;
835 gobject_class->get_property = gst_adder_get_property;
836 gobject_class->dispose = gst_adder_dispose;
843 g_object_class_install_property (gobject_class, PROP_FILTER_CAPS,
844 g_param_spec_boxed ("caps", "Target caps",
845 "Set target format for mixing (NULL means ANY). "
846 "Setting this property takes a reference to the supplied GstCaps "
847 "object.", GST_TYPE_CAPS,
848 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
850 gst_element_class_add_pad_template (gstelement_class,
851 gst_static_pad_template_get (&gst_adder_src_template));
852 gst_element_class_add_pad_template (gstelement_class,
853 gst_static_pad_template_get (&gst_adder_sink_template));
854 gst_element_class_set_details_simple (gstelement_class, "Adder",
856 "Add N audio channels together",
857 "Thomas Vander Stichele <thomas at apestaart dot org>");
859 gstelement_class->request_new_pad =
860 GST_DEBUG_FUNCPTR (gst_adder_request_new_pad);
861 gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_adder_release_pad);
862 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_adder_change_state);
866 gst_adder_init (GstAdder * adder)
868 GstPadTemplate *template;
870 template = gst_static_pad_template_get (&gst_adder_src_template);
871 adder->srcpad = gst_pad_new_from_template (template, "src");
872 gst_object_unref (template);
874 gst_pad_set_getcaps_function (adder->srcpad,
875 GST_DEBUG_FUNCPTR (gst_pad_proxy_getcaps));
876 gst_pad_set_setcaps_function (adder->srcpad,
877 GST_DEBUG_FUNCPTR (gst_adder_setcaps));
878 gst_pad_set_query_function (adder->srcpad,
879 GST_DEBUG_FUNCPTR (gst_adder_query));
880 gst_pad_set_event_function (adder->srcpad,
881 GST_DEBUG_FUNCPTR (gst_adder_src_event));
882 gst_element_add_pad (GST_ELEMENT (adder), adder->srcpad);
884 adder->format = GST_ADDER_FORMAT_UNSET;
888 adder->filter_caps = NULL;
890 /* keep track of the sinkpads requested */
891 adder->collect = gst_collect_pads_new ();
892 gst_collect_pads_set_function (adder->collect,
893 GST_DEBUG_FUNCPTR (gst_adder_collected), adder);
894 gst_collect_pads_set_clip_function (adder->collect,
895 GST_DEBUG_FUNCPTR (gst_adder_do_clip), adder);
899 gst_adder_dispose (GObject * object)
901 GstAdder *adder = GST_ADDER (object);
903 if (adder->collect) {
904 gst_object_unref (adder->collect);
905 adder->collect = NULL;
907 gst_caps_replace (&adder->filter_caps, NULL);
908 if (adder->pending_events) {
909 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
910 g_list_free (adder->pending_events);
911 adder->pending_events = NULL;
914 G_OBJECT_CLASS (parent_class)->dispose (object);
918 gst_adder_set_property (GObject * object, guint prop_id,
919 const GValue * value, GParamSpec * pspec)
921 GstAdder *adder = GST_ADDER (object);
924 case PROP_FILTER_CAPS:{
925 GstCaps *new_caps = NULL;
927 const GstCaps *new_caps_val = gst_value_get_caps (value);
929 if (new_caps_val != NULL) {
930 new_caps = (GstCaps *) new_caps_val;
931 gst_caps_ref (new_caps);
934 GST_OBJECT_LOCK (adder);
935 old_caps = adder->filter_caps;
936 adder->filter_caps = new_caps;
937 GST_OBJECT_UNLOCK (adder);
940 gst_caps_unref (old_caps);
942 GST_DEBUG_OBJECT (adder, "set new caps %" GST_PTR_FORMAT, new_caps);
946 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
952 gst_adder_get_property (GObject * object, guint prop_id, GValue * value,
955 GstAdder *adder = GST_ADDER (object);
958 case PROP_FILTER_CAPS:
959 GST_OBJECT_LOCK (adder);
960 gst_value_set_caps (value, adder->filter_caps);
961 GST_OBJECT_UNLOCK (adder);
964 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
971 gst_adder_request_new_pad (GstElement * element, GstPadTemplate * templ,
972 const gchar * unused, const GstCaps * caps)
979 if (templ->direction != GST_PAD_SINK)
982 adder = GST_ADDER (element);
984 /* increment pad counter */
985 padcount = g_atomic_int_exchange_and_add (&adder->padcount, 1);
987 name = g_strdup_printf ("sink%d", padcount);
988 newpad = gst_pad_new_from_template (templ, name);
989 GST_DEBUG_OBJECT (adder, "request new pad %s", name);
992 gst_pad_set_getcaps_function (newpad,
993 GST_DEBUG_FUNCPTR (gst_adder_sink_getcaps));
994 gst_pad_set_setcaps_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_setcaps));
995 gst_collect_pads_add_pad (adder->collect, newpad, sizeof (GstCollectData));
997 /* FIXME: hacked way to override/extend the event function of
998 * GstCollectPads; because it sets its own event function giving the
999 * element no access to events */
1000 adder->collect_event = (GstPadEventFunction) GST_PAD_EVENTFUNC (newpad);
1001 gst_pad_set_event_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_sink_event));
1003 /* takes ownership of the pad */
1004 if (!gst_element_add_pad (GST_ELEMENT (adder), newpad))
1012 g_warning ("gstadder: request new pad that is not a SINK pad\n");
1017 GST_DEBUG_OBJECT (adder, "could not add pad");
1018 gst_collect_pads_remove_pad (adder->collect, newpad);
1019 gst_object_unref (newpad);
1025 gst_adder_release_pad (GstElement * element, GstPad * pad)
1029 adder = GST_ADDER (element);
1031 GST_DEBUG_OBJECT (adder, "release pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1033 gst_collect_pads_remove_pad (adder->collect, pad);
1034 gst_element_remove_pad (element, pad);
1038 gst_adder_do_clip (GstCollectPads * pads, GstCollectData * data,
1039 GstBuffer * buffer, gpointer user_data)
1041 GstAdder *adder = GST_ADDER (user_data);
1043 buffer = gst_audio_buffer_clip (buffer, &data->segment, adder->rate,
1049 static GstFlowReturn
1050 gst_adder_collected (GstCollectPads * pads, gpointer user_data)
1053 * combine streams by adding data values
1055 * - this function is called when all pads have a buffer
1056 * - get available bytes on all pads.
1057 * - repeat for each input pad :
1058 * - read available bytes, copy or add to target buffer
1059 * - if there's an EOS event, remove the input channel
1060 * - push out the output buffer
1063 * - would be nice to have a mixing mode, where instead of adding we mix
1064 * - for float we could downscale after collect loop
1065 * - for int we need to downscale each input to avoid clipping or
1066 * mix into a temp (float) buffer and scale afterwards as well
1069 GSList *collected, *next = NULL;
1071 GstBuffer *outbuf = NULL, *gapbuf = NULL;
1072 gpointer outdata = NULL;
1075 gint64 next_timestamp;
1077 adder = GST_ADDER (user_data);
1080 if (G_UNLIKELY (adder->func == NULL))
1081 goto not_negotiated;
1083 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
1085 GST_DEBUG_OBJECT (adder, "pending flush stop");
1086 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop ());
1089 /* get available bytes for reading, this can be 0 which could mean empty
1090 * buffers or EOS, which we will catch when we loop over the pads. */
1091 outsize = gst_collect_pads_available (pads);
1092 /* can only happen when no pads to collect or all EOS */
1096 GST_LOG_OBJECT (adder,
1097 "starting to cycle through channels, %d bytes available (bps = %d)",
1098 outsize, adder->bps);
1100 for (collected = pads->data; collected; collected = next) {
1101 GstCollectData *collect_data;
1105 /* take next to see if this is the last collectdata */
1106 next = g_slist_next (collected);
1108 collect_data = (GstCollectData *) collected->data;
1110 /* get a buffer of size bytes, if we get a buffer, it is at least outsize
1112 inbuf = gst_collect_pads_take_buffer (pads, collect_data, outsize);
1113 /* NULL means EOS or an empty buffer so we still need to flush in
1114 * case of an empty buffer. */
1115 if (inbuf == NULL) {
1116 GST_LOG_OBJECT (adder, "channel %p: no bytes available", collect_data);
1120 is_gap = GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP);
1122 /* Try to make an output buffer */
1123 if (outbuf == NULL) {
1124 /* if this is a gap buffer but we have some more pads to check, skip it.
1125 * If we are at the last buffer, take it, regardless if it is a GAP
1127 if (is_gap && next) {
1128 GST_DEBUG_OBJECT (adder, "skipping, non-last GAP buffer");
1129 /* we keep the GAP buffer, if we don't have anymore buffers (all pads
1130 * EOS, we can use this one as the output buffer. */
1134 gst_buffer_unref (inbuf);
1138 GST_LOG_OBJECT (adder, "channel %p: preparing output buffer of %d bytes",
1139 collect_data, outsize);
1141 outdata = gst_buffer_map (outbuf, NULL, NULL, GST_MAP_WRITE);
1144 /* we had a previous output buffer, mix this non-GAP buffer */
1148 indata = gst_buffer_map (inbuf, &insize, NULL, GST_MAP_READ);
1150 /* all buffers should have outsize, there are no short buffers because we
1151 * asked for the max size above */
1152 g_assert (insize == outsize);
1154 GST_LOG_OBJECT (adder, "channel %p: mixing %d bytes from data %p",
1155 collect_data, insize, indata);
1157 /* further buffers, need to add them */
1158 adder->func ((gpointer) outdata, (gpointer) indata,
1159 insize / adder->sample_size);
1160 gst_buffer_unmap (inbuf, indata, insize);
1162 /* skip gap buffer */
1163 GST_LOG_OBJECT (adder, "channel %p: skipping GAP buffer", collect_data);
1165 gst_buffer_unref (inbuf);
1169 gst_buffer_unmap (outbuf, outdata, outsize);
1171 if (outbuf == NULL) {
1172 /* no output buffer, reuse one of the GAP buffers then if we have one */
1174 GST_LOG_OBJECT (adder, "reusing GAP buffer %p", gapbuf);
1177 /* assume EOS otherwise, this should not happen, really */
1180 /* we had an output buffer, unref the gapbuffer we kept */
1181 gst_buffer_unref (gapbuf);
1183 if (adder->segment_pending) {
1186 /* FIXME, use rate/applied_rate as set on all sinkpads.
1187 * - currently we just set rate as received from last seek-event
1189 * When seeking we set the start and stop positions as given in the seek
1190 * event. We also adjust offset & timestamp acordingly.
1191 * This basically ignores all newsegments sent by upstream.
1193 event = gst_event_new_segment (&adder->segment);
1195 if (adder->segment.rate > 0.0) {
1196 adder->segment.position = adder->segment.start;
1198 adder->segment.position = adder->segment.stop;
1200 adder->offset = gst_util_uint64_scale (adder->segment.position,
1201 adder->rate, GST_SECOND);
1202 GST_INFO_OBJECT (adder, "seg_start %" G_GUINT64_FORMAT ", seg_end %"
1203 G_GUINT64_FORMAT, adder->segment.start, adder->segment.stop);
1204 GST_INFO_OBJECT (adder, "timestamp %" G_GINT64_FORMAT ",new offset %"
1205 G_GINT64_FORMAT, adder->segment.position, adder->offset);
1208 if (!gst_pad_push_event (adder->srcpad, event)) {
1209 GST_WARNING_OBJECT (adder->srcpad, "Sending event %p (%s) failed.",
1210 event, GST_EVENT_TYPE_NAME (event));
1212 adder->segment_pending = FALSE;
1214 GST_WARNING_OBJECT (adder->srcpad, "Creating new segment event for "
1215 "start:%" G_GINT64_FORMAT " end:%" G_GINT64_FORMAT " failed",
1216 adder->segment.start, adder->segment.stop);
1220 if (G_UNLIKELY (adder->pending_events)) {
1221 GList *tmp = adder->pending_events;
1224 GstEvent *ev = (GstEvent *) tmp->data;
1226 gst_pad_push_event (adder->srcpad, ev);
1227 tmp = g_list_next (tmp);
1229 g_list_free (adder->pending_events);
1230 adder->pending_events = NULL;
1233 /* for the next timestamp, use the sample counter, which will
1234 * never accumulate rounding errors */
1235 if (adder->segment.rate > 0.0) {
1236 next_offset = adder->offset + outsize / adder->bps;
1238 next_offset = adder->offset - outsize / adder->bps;
1240 next_timestamp = gst_util_uint64_scale (next_offset, GST_SECOND, adder->rate);
1243 /* set timestamps on the output buffer */
1244 if (adder->segment.rate > 0.0) {
1245 GST_BUFFER_TIMESTAMP (outbuf) = adder->segment.position;
1246 GST_BUFFER_OFFSET (outbuf) = adder->offset;
1247 GST_BUFFER_OFFSET_END (outbuf) = next_offset;
1248 GST_BUFFER_DURATION (outbuf) = next_timestamp - adder->segment.position;
1250 GST_BUFFER_TIMESTAMP (outbuf) = next_timestamp;
1251 GST_BUFFER_OFFSET (outbuf) = next_offset;
1252 GST_BUFFER_OFFSET_END (outbuf) = adder->offset;
1253 GST_BUFFER_DURATION (outbuf) = adder->segment.position - next_timestamp;
1256 adder->offset = next_offset;
1257 adder->segment.position = next_timestamp;
1260 GST_LOG_OBJECT (adder, "pushing outbuf %p, timestamp %" GST_TIME_FORMAT
1261 " offset %" G_GINT64_FORMAT, outbuf,
1262 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)),
1263 GST_BUFFER_OFFSET (outbuf));
1264 ret = gst_pad_push (adder->srcpad, outbuf);
1266 GST_LOG_OBJECT (adder, "pushed outbuf, result = %s", gst_flow_get_name (ret));
1273 GST_ELEMENT_ERROR (adder, STREAM, FORMAT, (NULL),
1274 ("Unknown data received, not negotiated"));
1275 return GST_FLOW_NOT_NEGOTIATED;
1279 GST_DEBUG_OBJECT (adder, "no data available, must be EOS");
1280 gst_pad_push_event (adder->srcpad, gst_event_new_eos ());
1281 return GST_FLOW_UNEXPECTED;
1285 static GstStateChangeReturn
1286 gst_adder_change_state (GstElement * element, GstStateChange transition)
1289 GstStateChangeReturn ret;
1291 adder = GST_ADDER (element);
1293 switch (transition) {
1294 case GST_STATE_CHANGE_NULL_TO_READY:
1296 case GST_STATE_CHANGE_READY_TO_PAUSED:
1297 adder->segment.position = 0;
1299 adder->flush_stop_pending = FALSE;
1300 adder->segment_pending = TRUE;
1301 gst_segment_init (&adder->segment, GST_FORMAT_TIME);
1302 gst_collect_pads_start (adder->collect);
1304 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1306 case GST_STATE_CHANGE_PAUSED_TO_READY:
1307 /* need to unblock the collectpads before calling the
1308 * parent change_state so that streaming can finish */
1309 gst_collect_pads_stop (adder->collect);
1315 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1317 switch (transition) {
1327 plugin_init (GstPlugin * plugin)
1329 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "adder", 0,
1330 "audio channel mixing element");
1332 gst_adder_orc_init ();
1334 if (!gst_element_register (plugin, "adder", GST_RANK_NONE, GST_TYPE_ADDER)) {
1341 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1344 "Adds multiple streams",
1345 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)