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 */
77 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
79 GST_AUDIO_CAPS_MAKE ("{ S32LE, U32LE, S16LE, U16LE, S8, U8, F32LE, F64LE }") \
80 ", layout = (string) { interleaved, non-interleaved }"
83 GST_AUDIO_CAPS_MAKE ("{ S32BE, U32BE, S16BE, U16BE, S8, U8, F32BE, F64BE }") \
84 ", layout = (string) { interleaved, non-interleaved }"
87 static GstStaticPadTemplate gst_adder_src_template =
88 GST_STATIC_PAD_TEMPLATE ("src",
91 GST_STATIC_CAPS (CAPS)
94 static GstStaticPadTemplate gst_adder_sink_template =
95 GST_STATIC_PAD_TEMPLATE ("sink_%u",
98 GST_STATIC_CAPS (CAPS)
101 #define gst_adder_parent_class parent_class
102 G_DEFINE_TYPE (GstAdder, gst_adder, GST_TYPE_ELEMENT);
104 static void gst_adder_dispose (GObject * object);
105 static void gst_adder_set_property (GObject * object, guint prop_id,
106 const GValue * value, GParamSpec * pspec);
107 static void gst_adder_get_property (GObject * object, guint prop_id,
108 GValue * value, GParamSpec * pspec);
110 static gboolean gst_adder_setcaps (GstAdder * adder, GstPad * pad,
112 static gboolean gst_adder_src_query (GstPad * pad, GstObject * parent,
114 static gboolean gst_adder_sink_query (GstPad * pad, GstObject * parent,
116 static gboolean gst_adder_src_event (GstPad * pad, GstObject * parent,
118 static gboolean gst_adder_sink_event (GstPad * pad, GstObject * parent,
121 static GstPad *gst_adder_request_new_pad (GstElement * element,
122 GstPadTemplate * temp, const gchar * unused, const GstCaps * caps);
123 static void gst_adder_release_pad (GstElement * element, GstPad * pad);
125 static GstStateChangeReturn gst_adder_change_state (GstElement * element,
126 GstStateChange transition);
128 static GstFlowReturn gst_adder_do_clip (GstCollectPads2 * pads,
129 GstCollectData2 * data, GstBuffer * buffer, GstBuffer ** out,
131 static GstFlowReturn gst_adder_collected (GstCollectPads2 * pads,
133 static gboolean gst_adder_event (GstCollectPads2 * pads, GstCollectData2 * pad,
134 GstEvent * event, gpointer user_data);
136 /* non-clipping versions (for float) */
137 #define MAKE_FUNC_NC(name,type) \
138 static void name (type *out, type *in, gint samples) { \
140 for (i = 0; i < samples; i++) \
145 MAKE_FUNC_NC (add_float64, gdouble)
148 /* we can only accept caps that we and downstream can handle.
149 * if we have filtercaps set, use those to constrain the target caps.
152 gst_adder_sink_getcaps (GstPad * pad, GstCaps * filter)
155 GstCaps *result, *peercaps, *sinkcaps, *filter_caps;
157 adder = GST_ADDER (GST_PAD_PARENT (pad));
159 GST_OBJECT_LOCK (adder);
161 if ((filter_caps = adder->filter_caps)) {
164 gst_caps_intersect_full (filter, filter_caps,
165 GST_CAPS_INTERSECT_FIRST);
167 gst_caps_ref (filter_caps);
169 filter_caps = filter ? gst_caps_ref (filter) : NULL;
171 GST_OBJECT_UNLOCK (adder);
173 if (filter_caps && gst_caps_is_empty (filter_caps)) {
174 GST_WARNING_OBJECT (pad, "Empty filter caps");
178 /* get the downstream possible caps */
179 peercaps = gst_pad_peer_query_caps (adder->srcpad, filter_caps);
181 /* get the allowed caps on this sinkpad */
182 sinkcaps = gst_pad_get_current_caps (pad);
183 if (sinkcaps == NULL) {
184 sinkcaps = gst_pad_get_pad_template_caps (pad);
186 sinkcaps = gst_caps_new_any ();
190 /* if the peer has caps, intersect */
191 GST_DEBUG_OBJECT (adder, "intersecting peer and template caps");
193 gst_caps_intersect_full (peercaps, sinkcaps, GST_CAPS_INTERSECT_FIRST);
194 gst_caps_unref (peercaps);
195 gst_caps_unref (sinkcaps);
197 /* the peer has no caps (or there is no peer), just use the allowed caps
198 * of this sinkpad. */
199 /* restrict with filter-caps if any */
201 GST_DEBUG_OBJECT (adder, "no peer caps, using filtered sinkcaps");
203 gst_caps_intersect_full (filter_caps, sinkcaps,
204 GST_CAPS_INTERSECT_FIRST);
205 gst_caps_unref (sinkcaps);
207 GST_DEBUG_OBJECT (adder, "no peer caps, using sinkcaps");
213 gst_caps_unref (filter_caps);
215 GST_LOG_OBJECT (adder, "getting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
216 GST_PAD_NAME (pad), result);
222 gst_adder_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
224 gboolean res = FALSE;
226 switch (GST_QUERY_TYPE (query)) {
229 GstCaps *filter, *caps;
231 gst_query_parse_caps (query, &filter);
232 caps = gst_adder_sink_getcaps (pad, filter);
233 gst_query_set_caps_result (query, caps);
234 gst_caps_unref (caps);
239 res = gst_pad_query_default (pad, parent, query);
252 setcapsfunc (const GValue * item, IterData * data)
254 GstPad *otherpad = g_value_get_object (item);
256 if (otherpad != data->pad)
257 gst_pad_set_caps (data->pad, data->caps);
260 /* the first caps we receive on any of the sinkpads will define the caps for all
261 * the other sinkpads because we can only mix streams with the same caps.
264 gst_adder_setcaps (GstAdder * adder, GstPad * pad, GstCaps * caps)
267 GstIteratorResult ires;
271 /* this get called recursively due to gst_iterator_foreach calling
272 * gst_pad_set_caps() */
273 if (adder->in_setcaps)
276 GST_LOG_OBJECT (adder, "setting caps pad %p,%s to %" GST_PTR_FORMAT, pad,
277 GST_PAD_NAME (pad), caps);
279 it = gst_element_iterate_pads (GST_ELEMENT_CAST (adder));
281 /* FIXME, see if the other pads can accept the format. Also lock the
282 * format on the other pads to this new format. */
286 adder->in_setcaps = TRUE;
289 ires = gst_iterator_foreach (it, (GstIteratorForeachFunction) setcapsfunc,
293 case GST_ITERATOR_RESYNC:
294 gst_iterator_resync (it);
301 adder->in_setcaps = FALSE;
303 GST_LOG_OBJECT (adder, "handle caps changes on pad %p,%s to %" GST_PTR_FORMAT,
304 pad, GST_PAD_NAME (pad), caps);
306 if (!gst_audio_info_from_caps (&adder->info, caps))
309 switch (GST_AUDIO_INFO_FORMAT (&adder->info)) {
310 case GST_AUDIO_FORMAT_S8:
311 adder->func = (GstAdderFunction) add_int8;
313 case GST_AUDIO_FORMAT_U8:
314 adder->func = (GstAdderFunction) add_uint8;
316 case GST_AUDIO_FORMAT_S16:
317 adder->func = (GstAdderFunction) add_int16;
319 case GST_AUDIO_FORMAT_U16:
320 adder->func = (GstAdderFunction) add_uint16;
322 case GST_AUDIO_FORMAT_S32:
323 adder->func = (GstAdderFunction) add_int32;
325 case GST_AUDIO_FORMAT_U32:
326 adder->func = (GstAdderFunction) add_uint32;
328 case GST_AUDIO_FORMAT_F32:
329 adder->func = (GstAdderFunction) add_float32;
331 case GST_AUDIO_FORMAT_F64:
332 adder->func = (GstAdderFunction) add_float64;
342 GST_DEBUG_OBJECT (adder, "invalid format set as caps");
347 /* FIXME, the duration query should reflect how long you will produce
348 * data, that is the amount of stream time until you will emit EOS.
350 * For synchronized mixing this is always the max of all the durations
351 * of upstream since we emit EOS when all of them finished.
353 * We don't do synchronized mixing so this really depends on where the
354 * streams where punched in and what their relative offsets are against
355 * eachother which we can get from the first timestamps we see.
357 * When we add a new stream (or remove a stream) the duration might
358 * also become invalid again and we need to post a new DURATION
359 * message to notify this fact to the parent.
360 * For now we take the max of all the upstream elements so the simple
361 * cases work at least somewhat.
364 gst_adder_query_duration (GstAdder * adder, GstQuery * query)
371 GValue item = { 0, };
374 gst_query_parse_duration (query, &format, NULL);
380 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
382 GstIteratorResult ires;
384 ires = gst_iterator_next (it, &item);
386 case GST_ITERATOR_DONE:
389 case GST_ITERATOR_OK:
391 GstPad *pad = g_value_get_object (&item);
394 /* ask sink peer for duration */
395 res &= gst_pad_peer_query_duration (pad, format, &duration);
396 /* take max from all valid return values */
398 /* valid unknown length, stop searching */
399 if (duration == -1) {
403 /* else see if bigger than current max */
404 else if (duration > max)
407 g_value_reset (&item);
410 case GST_ITERATOR_RESYNC:
413 gst_iterator_resync (it);
421 g_value_unset (&item);
422 gst_iterator_free (it);
425 /* and store the max */
426 GST_DEBUG_OBJECT (adder, "Total duration in format %s: %"
427 GST_TIME_FORMAT, gst_format_get_name (format), GST_TIME_ARGS (max));
428 gst_query_set_duration (query, format, max);
435 gst_adder_query_latency (GstAdder * adder, GstQuery * query)
437 GstClockTime min, max;
442 GValue item = { 0, };
449 max = GST_CLOCK_TIME_NONE;
451 /* Take maximum of all latency values */
452 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
454 GstIteratorResult ires;
456 ires = gst_iterator_next (it, &item);
458 case GST_ITERATOR_DONE:
461 case GST_ITERATOR_OK:
463 GstPad *pad = g_value_get_object (&item);
465 GstClockTime min_cur, max_cur;
468 peerquery = gst_query_new_latency ();
470 /* Ask peer for latency */
471 res &= gst_pad_peer_query (pad, peerquery);
473 /* take max from all valid return values */
475 gst_query_parse_latency (peerquery, &live_cur, &min_cur, &max_cur);
480 if (max_cur != GST_CLOCK_TIME_NONE &&
481 ((max != GST_CLOCK_TIME_NONE && max_cur > max) ||
482 (max == GST_CLOCK_TIME_NONE)))
485 live = live || live_cur;
488 gst_query_unref (peerquery);
489 g_value_reset (&item);
492 case GST_ITERATOR_RESYNC:
495 max = GST_CLOCK_TIME_NONE;
497 gst_iterator_resync (it);
505 g_value_unset (&item);
506 gst_iterator_free (it);
509 /* store the results */
510 GST_DEBUG_OBJECT (adder, "Calculated total latency: live %s, min %"
511 GST_TIME_FORMAT ", max %" GST_TIME_FORMAT,
512 (live ? "yes" : "no"), GST_TIME_ARGS (min), GST_TIME_ARGS (max));
513 gst_query_set_latency (query, live, min, max);
520 gst_adder_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
522 GstAdder *adder = GST_ADDER (parent);
523 gboolean res = FALSE;
525 switch (GST_QUERY_TYPE (query)) {
526 case GST_QUERY_POSITION:
530 gst_query_parse_position (query, &format, NULL);
533 case GST_FORMAT_TIME:
534 /* FIXME, bring to stream time, might be tricky */
535 gst_query_set_position (query, format, adder->segment.position);
538 case GST_FORMAT_DEFAULT:
539 gst_query_set_position (query, format, adder->offset);
547 case GST_QUERY_DURATION:
548 res = gst_adder_query_duration (adder, query);
550 case GST_QUERY_LATENCY:
551 res = gst_adder_query_latency (adder, query);
554 /* FIXME, needs a custom query handler because we have multiple
556 res = gst_pad_query_default (pad, parent, query);
570 forward_event_func (const GValue * val, GValue * ret, EventData * data)
572 GstPad *pad = g_value_get_object (val);
573 GstEvent *event = data->event;
575 gst_event_ref (event);
576 GST_LOG_OBJECT (pad, "About to send event %s", GST_EVENT_TYPE_NAME (event));
577 if (!gst_pad_push_event (pad, event)) {
578 GST_WARNING_OBJECT (pad, "Sending event %p (%s) failed.",
579 event, GST_EVENT_TYPE_NAME (event));
580 /* quick hack to unflush the pads, ideally we need a way to just unflush
581 * this single collect pad */
583 gst_pad_send_event (pad, gst_event_new_flush_stop (TRUE));
585 g_value_set_boolean (ret, TRUE);
586 GST_LOG_OBJECT (pad, "Sent event %p (%s).",
587 event, GST_EVENT_TYPE_NAME (event));
590 /* continue on other pads, even if one failed */
594 /* forwards the event to all sinkpads, takes ownership of the
597 * Returns: TRUE if the event could be forwarded on all
601 forward_event (GstAdder * adder, GstEvent * event, gboolean flush)
605 GstIteratorResult ires;
609 GST_LOG_OBJECT (adder, "Forwarding event %p (%s)", event,
610 GST_EVENT_TYPE_NAME (event));
615 g_value_init (&vret, G_TYPE_BOOLEAN);
616 g_value_set_boolean (&vret, FALSE);
617 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
620 gst_iterator_fold (it, (GstIteratorFoldFunction) forward_event_func,
623 case GST_ITERATOR_RESYNC:
624 GST_WARNING ("resync");
625 gst_iterator_resync (it);
626 g_value_set_boolean (&vret, TRUE);
628 case GST_ITERATOR_OK:
629 case GST_ITERATOR_DONE:
630 ret = g_value_get_boolean (&vret);
638 gst_iterator_free (it);
639 GST_LOG_OBJECT (adder, "Forwarded event %p (%s), ret=%d", event,
640 GST_EVENT_TYPE_NAME (event), ret);
641 gst_event_unref (event);
647 gst_adder_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
652 adder = GST_ADDER (parent);
654 GST_DEBUG_OBJECT (pad, "Got %s event on src pad",
655 GST_EVENT_TYPE_NAME (event));
657 switch (GST_EVENT_TYPE (event)) {
662 GstSeekType curtype, endtype;
666 /* parse the seek parameters */
667 gst_event_parse_seek (event, &rate, NULL, &flags, &curtype,
668 &cur, &endtype, &end);
670 if ((curtype != GST_SEEK_TYPE_NONE) && (curtype != GST_SEEK_TYPE_SET)) {
672 GST_DEBUG_OBJECT (adder,
673 "seeking failed, unhandled seek type for start: %d", curtype);
676 if ((endtype != GST_SEEK_TYPE_NONE) && (endtype != GST_SEEK_TYPE_SET)) {
678 GST_DEBUG_OBJECT (adder,
679 "seeking failed, unhandled seek type for end: %d", endtype);
683 flush = (flags & GST_SEEK_FLAG_FLUSH) == GST_SEEK_FLAG_FLUSH;
685 /* check if we are flushing */
687 /* flushing seek, start flush downstream, the flush will be done
688 * when all pads received a FLUSH_STOP.
689 * Make sure we accept nothing anymore and return WRONG_STATE.
690 * We send a flush-start before, to ensure no streaming is done
691 * as we need to take the stream lock.
693 gst_pad_push_event (adder->srcpad, gst_event_new_flush_start ());
694 gst_collect_pads2_set_flushing (adder->collect, TRUE);
696 /* We can't send FLUSH_STOP here since upstream could start pushing data
697 * after we unlock adder->collect.
698 * We set flush_stop_pending to TRUE instead and send FLUSH_STOP after
699 * forwarding the seek upstream or from gst_adder_collected,
700 * whichever happens first.
702 g_atomic_int_set (&adder->flush_stop_pending, TRUE);
704 GST_DEBUG_OBJECT (adder, "handling seek event: %" GST_PTR_FORMAT, event);
706 /* now wait for the collected to be finished and mark a new
707 * segment. After we have the lock, no collect function is running and no
708 * new collect function will be called for as long as we're flushing. */
709 GST_COLLECT_PADS2_STREAM_LOCK (adder->collect);
710 adder->segment.rate = rate;
711 if (curtype == GST_SEEK_TYPE_SET)
712 adder->segment.start = cur;
714 adder->segment.start = 0;
715 if (endtype == GST_SEEK_TYPE_SET)
716 adder->segment.stop = end;
718 adder->segment.stop = GST_CLOCK_TIME_NONE;
720 /* Yes, we need to call _set_flushing again *WHEN* the streaming threads
721 * have stopped so that the cookie gets properly updated. */
722 gst_collect_pads2_set_flushing (adder->collect, TRUE);
724 GST_COLLECT_PADS2_STREAM_UNLOCK (adder->collect);
725 GST_DEBUG_OBJECT (adder, "forwarding seek event: %" GST_PTR_FORMAT,
728 /* we're forwarding seek to all upstream peers and wait for one to reply
729 * with a newsegment-event before we send a newsegment-event downstream */
730 g_atomic_int_set (&adder->wait_for_new_segment, TRUE);
731 result = forward_event (adder, event, flush);
733 /* seek failed. maybe source is a live source. */
734 GST_DEBUG_OBJECT (adder, "seeking failed");
736 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
738 GST_DEBUG_OBJECT (adder, "pending flush stop");
739 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop (TRUE));
744 /* QoS might be tricky */
747 case GST_EVENT_NAVIGATION:
748 /* navigation is rather pointless. */
752 /* just forward the rest for now */
753 GST_DEBUG_OBJECT (adder, "forward unhandled event: %s",
754 GST_EVENT_TYPE_NAME (event));
755 result = forward_event (adder, event, FALSE);
765 gst_adder_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
770 adder = GST_ADDER (parent);
772 GST_DEBUG_OBJECT (pad, "Got %s event on sink pad",
773 GST_EVENT_TYPE_NAME (event));
775 switch (GST_EVENT_TYPE (event)) {
780 gst_event_parse_caps (event, &caps);
781 ret = gst_adder_setcaps (adder, pad, caps);
782 gst_event_unref (event);
786 case GST_EVENT_FLUSH_STOP:
787 /* we received a flush-stop. The collect_event function will call the
788 * gst_adder_event function we have set on the GstCollectPads2, so we
789 * have control over whether the event is sent past our element.
790 * We will only forward it when flush_stop_pending is set, and we will
793 GST_COLLECT_PADS2_STREAM_LOCK (adder->collect);
794 g_atomic_int_set (&adder->new_segment_pending, TRUE);
795 /* Clear pending tags */
796 if (adder->pending_events) {
797 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
798 g_list_free (adder->pending_events);
799 adder->pending_events = NULL;
801 GST_COLLECT_PADS2_STREAM_UNLOCK (adder->collect);
804 GST_COLLECT_PADS2_STREAM_LOCK (adder->collect);
805 /* collect tags here so we can push them out when we collect data */
806 adder->pending_events = g_list_append (adder->pending_events, event);
807 GST_COLLECT_PADS2_STREAM_UNLOCK (adder->collect);
809 case GST_EVENT_SEGMENT:
810 if (g_atomic_int_compare_and_exchange (&adder->wait_for_new_segment,
812 /* make sure we push a new segment, to inform about new basetime
813 * see FIXME in gst_adder_collected() */
814 g_atomic_int_set (&adder->new_segment_pending, TRUE);
821 /* now GstCollectPads2 can take care of the rest, e.g. EOS */
822 ret = adder->collect_event (pad, parent, event);
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_query_function (adder->srcpad,
875 GST_DEBUG_FUNCPTR (gst_adder_src_query));
876 gst_pad_set_event_function (adder->srcpad,
877 GST_DEBUG_FUNCPTR (gst_adder_src_event));
878 GST_PAD_SET_PROXY_CAPS (adder->srcpad);
879 gst_element_add_pad (GST_ELEMENT (adder), adder->srcpad);
881 gst_audio_info_init (&adder->info);
885 adder->filter_caps = NULL;
887 /* keep track of the sinkpads requested */
888 adder->collect = gst_collect_pads2_new ();
889 gst_collect_pads2_set_function (adder->collect,
890 GST_DEBUG_FUNCPTR (gst_adder_collected), adder);
891 gst_collect_pads2_set_clip_function (adder->collect,
892 GST_DEBUG_FUNCPTR (gst_adder_do_clip), adder);
893 gst_collect_pads2_set_event_function (adder->collect,
894 GST_DEBUG_FUNCPTR (gst_adder_event), adder);
898 gst_adder_dispose (GObject * object)
900 GstAdder *adder = GST_ADDER (object);
902 if (adder->collect) {
903 gst_object_unref (adder->collect);
904 adder->collect = NULL;
906 gst_caps_replace (&adder->filter_caps, NULL);
907 if (adder->pending_events) {
908 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
909 g_list_free (adder->pending_events);
910 adder->pending_events = NULL;
913 G_OBJECT_CLASS (parent_class)->dispose (object);
917 gst_adder_set_property (GObject * object, guint prop_id,
918 const GValue * value, GParamSpec * pspec)
920 GstAdder *adder = GST_ADDER (object);
923 case PROP_FILTER_CAPS:{
924 GstCaps *new_caps = NULL;
926 const GstCaps *new_caps_val = gst_value_get_caps (value);
928 if (new_caps_val != NULL) {
929 new_caps = (GstCaps *) new_caps_val;
930 gst_caps_ref (new_caps);
933 GST_OBJECT_LOCK (adder);
934 old_caps = adder->filter_caps;
935 adder->filter_caps = new_caps;
936 GST_OBJECT_UNLOCK (adder);
939 gst_caps_unref (old_caps);
941 GST_DEBUG_OBJECT (adder, "set new caps %" GST_PTR_FORMAT, new_caps);
945 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
951 gst_adder_get_property (GObject * object, guint prop_id, GValue * value,
954 GstAdder *adder = GST_ADDER (object);
957 case PROP_FILTER_CAPS:
958 GST_OBJECT_LOCK (adder);
959 gst_value_set_caps (value, adder->filter_caps);
960 GST_OBJECT_UNLOCK (adder);
963 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
970 gst_adder_request_new_pad (GstElement * element, GstPadTemplate * templ,
971 const gchar * unused, const GstCaps * caps)
978 if (templ->direction != GST_PAD_SINK)
981 adder = GST_ADDER (element);
983 /* increment pad counter */
984 #if GLIB_CHECK_VERSION(2,29,5)
985 padcount = g_atomic_int_add (&adder->padcount, 1);
987 padcount = g_atomic_int_exchange_and_add (&adder->padcount, 1);
990 name = g_strdup_printf ("sink_%u", padcount);
991 newpad = gst_pad_new_from_template (templ, name);
992 GST_DEBUG_OBJECT (adder, "request new pad %s", name);
995 gst_pad_set_query_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_sink_query));
996 gst_collect_pads2_add_pad (adder->collect, newpad, sizeof (GstCollectData2));
998 /* FIXME: hacked way to override/extend the event function of
999 * GstCollectPads2; because it sets its own event function giving the
1000 * element no access to events */
1001 adder->collect_event = (GstPadEventFunction) GST_PAD_EVENTFUNC (newpad);
1002 gst_pad_set_event_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_sink_event));
1004 /* takes ownership of the pad */
1005 if (!gst_element_add_pad (GST_ELEMENT (adder), newpad))
1013 g_warning ("gstadder: request new pad that is not a SINK pad\n");
1018 GST_DEBUG_OBJECT (adder, "could not add pad");
1019 gst_collect_pads2_remove_pad (adder->collect, newpad);
1020 gst_object_unref (newpad);
1026 gst_adder_release_pad (GstElement * element, GstPad * pad)
1030 adder = GST_ADDER (element);
1032 GST_DEBUG_OBJECT (adder, "release pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1034 gst_collect_pads2_remove_pad (adder->collect, pad);
1035 gst_element_remove_pad (element, pad);
1038 static GstFlowReturn
1039 gst_adder_do_clip (GstCollectPads2 * pads, GstCollectData2 * data,
1040 GstBuffer * buffer, GstBuffer ** out, gpointer user_data)
1042 GstAdder *adder = GST_ADDER (user_data);
1045 rate = GST_AUDIO_INFO_RATE (&adder->info);
1046 bpf = GST_AUDIO_INFO_BPF (&adder->info);
1048 buffer = gst_audio_buffer_clip (buffer, &data->segment, rate, bpf);
1054 static GstFlowReturn
1055 gst_adder_collected (GstCollectPads2 * pads, gpointer user_data)
1058 * combine streams by adding data values
1060 * - this function is called when all pads have a buffer
1061 * - get available bytes on all pads.
1062 * - repeat for each input pad :
1063 * - read available bytes, copy or add to target buffer
1064 * - if there's an EOS event, remove the input channel
1065 * - push out the output buffer
1068 * - would be nice to have a mixing mode, where instead of adding we mix
1069 * - for float we could downscale after collect loop
1070 * - for int we need to downscale each input to avoid clipping or
1071 * mix into a temp (float) buffer and scale afterwards as well
1074 GSList *collected, *next = NULL;
1076 GstBuffer *outbuf = NULL, *gapbuf = NULL;
1077 gpointer outdata = NULL;
1080 gint64 next_timestamp;
1081 gint rate, bps, bpf;
1083 adder = GST_ADDER (user_data);
1086 if (G_UNLIKELY (adder->func == NULL))
1087 goto not_negotiated;
1089 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
1091 GST_DEBUG_OBJECT (adder, "pending flush stop");
1092 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop (TRUE));
1095 /* get available bytes for reading, this can be 0 which could mean empty
1096 * buffers or EOS, which we will catch when we loop over the pads. */
1097 outsize = gst_collect_pads2_available (pads);
1098 /* can only happen when no pads to collect or all EOS */
1102 rate = GST_AUDIO_INFO_RATE (&adder->info);
1103 bps = GST_AUDIO_INFO_BPS (&adder->info);
1104 bpf = GST_AUDIO_INFO_BPF (&adder->info);
1106 GST_LOG_OBJECT (adder,
1107 "starting to cycle through channels, %d bytes available (bps = %d, bpf = %d)",
1110 for (collected = pads->data; collected; collected = next) {
1111 GstCollectData2 *collect_data;
1115 /* take next to see if this is the last collectdata */
1116 next = g_slist_next (collected);
1118 collect_data = (GstCollectData2 *) collected->data;
1120 /* get a buffer of size bytes, if we get a buffer, it is at least outsize
1122 inbuf = gst_collect_pads2_take_buffer (pads, collect_data, outsize);
1123 /* NULL means EOS or an empty buffer so we still need to flush in
1124 * case of an empty buffer. */
1125 if (inbuf == NULL) {
1126 GST_LOG_OBJECT (adder, "channel %p: no bytes available", collect_data);
1130 is_gap = GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP);
1132 /* Try to make an output buffer */
1133 if (outbuf == NULL) {
1134 /* if this is a gap buffer but we have some more pads to check, skip it.
1135 * If we are at the last buffer, take it, regardless if it is a GAP
1137 if (is_gap && next) {
1138 GST_DEBUG_OBJECT (adder, "skipping, non-last GAP buffer");
1139 /* we keep the GAP buffer, if we don't have anymore buffers (all pads
1140 * EOS, we can use this one as the output buffer. */
1144 gst_buffer_unref (inbuf);
1148 GST_LOG_OBJECT (adder, "channel %p: preparing output buffer of %d bytes",
1149 collect_data, outsize);
1151 /* make data and metadata writable, can simply return the inbuf when we
1152 * are the only one referencing this buffer. If this is the last (and
1153 * only) GAP buffer, it will automatically copy the GAP flag. */
1154 outbuf = gst_buffer_make_writable (inbuf);
1155 outdata = gst_buffer_map (outbuf, NULL, NULL, GST_MAP_WRITE);
1158 /* we had a previous output buffer, mix this non-GAP buffer */
1162 indata = gst_buffer_map (inbuf, &insize, NULL, GST_MAP_READ);
1164 /* all buffers should have outsize, there are no short buffers because we
1165 * asked for the max size above */
1166 g_assert (insize == outsize);
1168 GST_LOG_OBJECT (adder, "channel %p: mixing %" G_GSIZE_FORMAT " bytes"
1169 " from data %p", collect_data, insize, indata);
1171 /* further buffers, need to add them */
1172 adder->func ((gpointer) outdata, (gpointer) indata, insize / bps);
1173 gst_buffer_unmap (inbuf, indata, insize);
1175 /* skip gap buffer */
1176 GST_LOG_OBJECT (adder, "channel %p: skipping GAP buffer", collect_data);
1178 gst_buffer_unref (inbuf);
1182 gst_buffer_unmap (outbuf, outdata, outsize);
1184 if (outbuf == NULL) {
1185 /* no output buffer, reuse one of the GAP buffers then if we have one */
1187 GST_LOG_OBJECT (adder, "reusing GAP buffer %p", gapbuf);
1190 /* assume EOS otherwise, this should not happen, really */
1193 /* we had an output buffer, unref the gapbuffer we kept */
1194 gst_buffer_unref (gapbuf);
1196 if (g_atomic_int_compare_and_exchange (&adder->new_segment_pending, TRUE,
1200 /* FIXME, use rate/applied_rate as set on all sinkpads.
1201 * - currently we just set rate as received from last seek-event
1203 * When seeking we set the start and stop positions as given in the seek
1204 * event. We also adjust offset & timestamp accordingly.
1205 * This basically ignores all newsegments sent by upstream.
1207 event = gst_event_new_segment (&adder->segment);
1209 if (adder->segment.rate > 0.0) {
1210 adder->segment.position = adder->segment.start;
1212 adder->segment.position = adder->segment.stop;
1214 adder->offset = gst_util_uint64_scale (adder->segment.position,
1216 GST_INFO_OBJECT (adder, "seg_start %" G_GUINT64_FORMAT ", seg_end %"
1217 G_GUINT64_FORMAT, adder->segment.start, adder->segment.stop);
1218 GST_INFO_OBJECT (adder, "timestamp %" G_GINT64_FORMAT ",new offset %"
1219 G_GINT64_FORMAT, adder->segment.position, adder->offset);
1222 if (!gst_pad_push_event (adder->srcpad, event)) {
1223 GST_WARNING_OBJECT (adder->srcpad, "Sending event failed");
1226 GST_WARNING_OBJECT (adder->srcpad, "Creating new segment event for "
1227 "start:%" G_GINT64_FORMAT " end:%" G_GINT64_FORMAT " failed",
1228 adder->segment.start, adder->segment.stop);
1232 if (G_UNLIKELY (adder->pending_events)) {
1233 GList *tmp = adder->pending_events;
1236 GstEvent *ev = (GstEvent *) tmp->data;
1238 gst_pad_push_event (adder->srcpad, ev);
1239 tmp = g_list_next (tmp);
1241 g_list_free (adder->pending_events);
1242 adder->pending_events = NULL;
1245 /* for the next timestamp, use the sample counter, which will
1246 * never accumulate rounding errors */
1247 if (adder->segment.rate > 0.0) {
1248 next_offset = adder->offset + outsize / bpf;
1250 next_offset = adder->offset - outsize / bpf;
1252 next_timestamp = gst_util_uint64_scale (next_offset, GST_SECOND, rate);
1255 /* set timestamps on the output buffer */
1256 if (adder->segment.rate > 0.0) {
1257 GST_BUFFER_TIMESTAMP (outbuf) = adder->segment.position;
1258 GST_BUFFER_OFFSET (outbuf) = adder->offset;
1259 GST_BUFFER_OFFSET_END (outbuf) = next_offset;
1260 GST_BUFFER_DURATION (outbuf) = next_timestamp - adder->segment.position;
1262 GST_BUFFER_TIMESTAMP (outbuf) = next_timestamp;
1263 GST_BUFFER_OFFSET (outbuf) = next_offset;
1264 GST_BUFFER_OFFSET_END (outbuf) = adder->offset;
1265 GST_BUFFER_DURATION (outbuf) = adder->segment.position - next_timestamp;
1268 adder->offset = next_offset;
1269 adder->segment.position = next_timestamp;
1272 GST_LOG_OBJECT (adder, "pushing outbuf %p, timestamp %" GST_TIME_FORMAT
1273 " offset %" G_GINT64_FORMAT, outbuf,
1274 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)),
1275 GST_BUFFER_OFFSET (outbuf));
1276 ret = gst_pad_push (adder->srcpad, outbuf);
1278 GST_LOG_OBJECT (adder, "pushed outbuf, result = %s", gst_flow_get_name (ret));
1285 GST_ELEMENT_ERROR (adder, STREAM, FORMAT, (NULL),
1286 ("Unknown data received, not negotiated"));
1287 return GST_FLOW_NOT_NEGOTIATED;
1291 GST_DEBUG_OBJECT (adder, "no data available, must be EOS");
1292 gst_pad_push_event (adder->srcpad, gst_event_new_eos ());
1293 return GST_FLOW_EOS;
1298 gst_adder_event (GstCollectPads2 * pads, GstCollectData2 * pad,
1299 GstEvent * event, gpointer user_data)
1301 GstAdder *adder = GST_ADDER (user_data);
1302 if (GST_EVENT_TYPE (event) == GST_EVENT_FLUSH_STOP) {
1303 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
1307 gst_event_unref (event);
1315 static GstStateChangeReturn
1316 gst_adder_change_state (GstElement * element, GstStateChange transition)
1319 GstStateChangeReturn ret;
1321 adder = GST_ADDER (element);
1323 switch (transition) {
1324 case GST_STATE_CHANGE_NULL_TO_READY:
1326 case GST_STATE_CHANGE_READY_TO_PAUSED:
1327 adder->segment.position = 0;
1329 adder->flush_stop_pending = FALSE;
1330 adder->new_segment_pending = TRUE;
1331 adder->wait_for_new_segment = FALSE;
1332 gst_segment_init (&adder->segment, GST_FORMAT_TIME);
1333 gst_collect_pads2_start (adder->collect);
1335 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1337 case GST_STATE_CHANGE_PAUSED_TO_READY:
1338 /* need to unblock the collectpads2 before calling the
1339 * parent change_state so that streaming can finish */
1340 gst_collect_pads2_stop (adder->collect);
1346 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1348 switch (transition) {
1358 plugin_init (GstPlugin * plugin)
1360 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "adder", 0,
1361 "audio channel mixing element");
1363 gst_adder_orc_init ();
1365 if (!gst_element_register (plugin, "adder", GST_RANK_NONE, GST_TYPE_ADDER)) {
1372 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1375 "Adds multiple streams",
1376 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)