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., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, 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 */
48 #include <gst/audio/audio.h>
49 #include <string.h> /* strcmp */
50 #include "gstadderorc.h"
52 /* highest positive/lowest negative x-bit value we can use for clamping */
53 #define MAX_INT_32 ((gint32) (0x7fffffff))
54 #define MAX_INT_16 ((gint16) (0x7fff))
55 #define MAX_INT_8 ((gint8) (0x7f))
56 #define MAX_UINT_32 ((guint32)(0xffffffff))
57 #define MAX_UINT_16 ((guint16)(0xffff))
58 #define MAX_UINT_8 ((guint8) (0xff))
60 #define MIN_INT_32 ((gint32) (0x80000000))
61 #define MIN_INT_16 ((gint16) (0x8000))
62 #define MIN_INT_8 ((gint8) (0x80))
63 #define MIN_UINT_32 ((guint32)(0x00000000))
64 #define MIN_UINT_16 ((guint16)(0x0000))
65 #define MIN_UINT_8 ((guint8) (0x00))
73 #define GST_CAT_DEFAULT gst_adder_debug
74 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
76 /* elementfactory information */
78 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
80 GST_AUDIO_CAPS_MAKE ("{ S32LE, U32LE, S16LE, U16LE, S8, U8, F32LE, F64LE }") \
81 ", layout = (string) { interleaved, non-interleaved }"
84 GST_AUDIO_CAPS_MAKE ("{ S32BE, U32BE, S16BE, U16BE, S8, U8, F32BE, F64BE }") \
85 ", layout = (string) { interleaved, non-interleaved }"
88 static GstStaticPadTemplate gst_adder_src_template =
89 GST_STATIC_PAD_TEMPLATE ("src",
92 GST_STATIC_CAPS (CAPS)
95 static GstStaticPadTemplate gst_adder_sink_template =
96 GST_STATIC_PAD_TEMPLATE ("sink_%u",
99 GST_STATIC_CAPS (CAPS)
102 #define gst_adder_parent_class parent_class
103 G_DEFINE_TYPE (GstAdder, gst_adder, GST_TYPE_ELEMENT);
105 static void gst_adder_dispose (GObject * object);
106 static void gst_adder_set_property (GObject * object, guint prop_id,
107 const GValue * value, GParamSpec * pspec);
108 static void gst_adder_get_property (GObject * object, guint prop_id,
109 GValue * value, GParamSpec * pspec);
111 static gboolean gst_adder_setcaps (GstAdder * adder, GstPad * pad,
113 static gboolean gst_adder_src_query (GstPad * pad, GstObject * parent,
115 static gboolean gst_adder_sink_query (GstCollectPads * pads,
116 GstCollectData * pad, GstQuery * query, gpointer user_data);
117 static gboolean gst_adder_src_event (GstPad * pad, GstObject * parent,
119 static gboolean gst_adder_sink_event (GstCollectPads * pads,
120 GstCollectData * pad, GstEvent * event, gpointer user_data);
122 static GstPad *gst_adder_request_new_pad (GstElement * element,
123 GstPadTemplate * temp, const gchar * unused, const GstCaps * caps);
124 static void gst_adder_release_pad (GstElement * element, GstPad * pad);
126 static GstStateChangeReturn gst_adder_change_state (GstElement * element,
127 GstStateChange transition);
129 static GstFlowReturn gst_adder_do_clip (GstCollectPads * pads,
130 GstCollectData * data, GstBuffer * buffer, GstBuffer ** out,
132 static GstFlowReturn gst_adder_collected (GstCollectPads * pads,
135 /* non-clipping versions (for float) */
136 #define MAKE_FUNC_NC(name,type) \
137 static void name (type *out, type *in, gint samples) { \
139 for (i = 0; i < samples; i++) \
144 MAKE_FUNC_NC (adder_orc_add_float64, gdouble)
147 /* we can only accept caps that we and downstream can handle.
148 * if we have filtercaps set, use those to constrain the target caps.
151 gst_adder_sink_getcaps (GstPad * pad, GstCaps * filter)
154 GstCaps *result, *peercaps, *sinkcaps, *filter_caps;
156 adder = GST_ADDER (GST_PAD_PARENT (pad));
158 GST_OBJECT_LOCK (adder);
160 if ((filter_caps = adder->filter_caps)) {
163 gst_caps_intersect_full (filter, filter_caps,
164 GST_CAPS_INTERSECT_FIRST);
166 gst_caps_ref (filter_caps);
168 filter_caps = filter ? gst_caps_ref (filter) : NULL;
170 GST_OBJECT_UNLOCK (adder);
172 if (filter_caps && gst_caps_is_empty (filter_caps)) {
173 GST_WARNING_OBJECT (pad, "Empty filter caps");
177 /* get the downstream possible caps */
178 peercaps = gst_pad_peer_query_caps (adder->srcpad, filter_caps);
180 /* get the allowed caps on this sinkpad */
181 sinkcaps = gst_pad_get_current_caps (pad);
182 if (sinkcaps == NULL) {
183 sinkcaps = gst_pad_get_pad_template_caps (pad);
185 sinkcaps = gst_caps_new_any ();
189 /* if the peer has caps, intersect */
190 GST_DEBUG_OBJECT (adder, "intersecting peer and template caps");
192 gst_caps_intersect_full (peercaps, sinkcaps, GST_CAPS_INTERSECT_FIRST);
193 gst_caps_unref (peercaps);
194 gst_caps_unref (sinkcaps);
196 /* the peer has no caps (or there is no peer), just use the allowed caps
197 * of this sinkpad. */
198 /* restrict with filter-caps if any */
200 GST_DEBUG_OBJECT (adder, "no peer caps, using filtered sinkcaps");
202 gst_caps_intersect_full (filter_caps, sinkcaps,
203 GST_CAPS_INTERSECT_FIRST);
204 gst_caps_unref (sinkcaps);
206 GST_DEBUG_OBJECT (adder, "no peer caps, using sinkcaps");
212 gst_caps_unref (filter_caps);
214 GST_LOG_OBJECT (adder, "getting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
215 GST_PAD_NAME (pad), result);
221 gst_adder_sink_query (GstCollectPads * pads, GstCollectData * pad,
222 GstQuery * query, gpointer user_data)
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->pad, filter);
233 gst_query_set_caps_result (query, caps);
234 gst_caps_unref (caps);
239 res = gst_collect_pads_query_default (pads, pad, query, FALSE);
253 setcapsfunc (const GValue * item, IterData * data)
255 GstPad *otherpad = g_value_get_object (item);
257 if (otherpad != data->pad) {
258 GST_LOG_OBJECT (data->pad, "calling set_caps with %" GST_PTR_FORMAT,
260 gst_pad_set_caps (data->pad, data->caps);
261 gst_pad_use_fixed_caps (data->pad);
265 /* the first caps we receive on any of the sinkpads will define the caps for all
266 * the other sinkpads because we can only mix streams with the same caps.
269 gst_adder_setcaps (GstAdder * adder, GstPad * pad, GstCaps * caps)
272 GstIteratorResult ires;
276 /* this gets called recursively due to gst_iterator_foreach calling
277 * gst_pad_set_caps() */
278 if (adder->in_setcaps)
281 /* don't allow reconfiguration for now; there's still a race between the
282 * different upstream threads doing query_caps + accept_caps + sending
283 * (possibly different) CAPS events, but there's not much we can do about
284 * that, upstream needs to deal with it. */
285 if (adder->current_caps != NULL) {
286 /* FIXME: not quite right for optional fields such as channel-mask, which
287 * may or may not be present for mono/stereo */
288 if (gst_caps_is_equal (caps, adder->current_caps)) {
291 GST_DEBUG_OBJECT (pad, "got input caps %" GST_PTR_FORMAT ", but "
292 "current caps are %" GST_PTR_FORMAT, caps, adder->current_caps);
293 gst_pad_push_event (pad, gst_event_new_reconfigure ());
298 GST_INFO_OBJECT (pad, "setting caps to %" GST_PTR_FORMAT, caps);
300 adder->current_caps = gst_caps_ref (caps);
301 /* send caps event later, after stream-start event */
303 it = gst_element_iterate_pads (GST_ELEMENT_CAST (adder));
305 /* FIXME, see if the other pads can accept the format. Also lock the
306 * format on the other pads to this new format. */
310 adder->in_setcaps = TRUE;
313 ires = gst_iterator_foreach (it, (GstIteratorForeachFunction) setcapsfunc,
317 case GST_ITERATOR_RESYNC:
318 gst_iterator_resync (it);
325 adder->in_setcaps = FALSE;
326 gst_iterator_free (it);
328 GST_INFO_OBJECT (pad, "handle caps change to %" GST_PTR_FORMAT, caps);
330 if (!gst_audio_info_from_caps (&adder->info, caps))
333 switch (GST_AUDIO_INFO_FORMAT (&adder->info)) {
334 case GST_AUDIO_FORMAT_S8:
335 adder->func = (GstAdderFunction) adder_orc_add_int8;
337 case GST_AUDIO_FORMAT_U8:
338 adder->func = (GstAdderFunction) adder_orc_add_uint8;
340 case GST_AUDIO_FORMAT_S16:
341 adder->func = (GstAdderFunction) adder_orc_add_int16;
343 case GST_AUDIO_FORMAT_U16:
344 adder->func = (GstAdderFunction) adder_orc_add_uint16;
346 case GST_AUDIO_FORMAT_S32:
347 adder->func = (GstAdderFunction) adder_orc_add_int32;
349 case GST_AUDIO_FORMAT_U32:
350 adder->func = (GstAdderFunction) adder_orc_add_uint32;
352 case GST_AUDIO_FORMAT_F32:
353 adder->func = (GstAdderFunction) adder_orc_add_float32;
355 case GST_AUDIO_FORMAT_F64:
356 adder->func = (GstAdderFunction) adder_orc_add_float64;
366 GST_WARNING_OBJECT (adder, "invalid format set as caps");
371 /* FIXME, the duration query should reflect how long you will produce
372 * data, that is the amount of stream time until you will emit EOS.
374 * For synchronized mixing this is always the max of all the durations
375 * of upstream since we emit EOS when all of them finished.
377 * We don't do synchronized mixing so this really depends on where the
378 * streams where punched in and what their relative offsets are against
379 * eachother which we can get from the first timestamps we see.
381 * When we add a new stream (or remove a stream) the duration might
382 * also become invalid again and we need to post a new DURATION
383 * message to notify this fact to the parent.
384 * For now we take the max of all the upstream elements so the simple
385 * cases work at least somewhat.
388 gst_adder_query_duration (GstAdder * adder, GstQuery * query)
395 GValue item = { 0, };
398 gst_query_parse_duration (query, &format, NULL);
404 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
406 GstIteratorResult ires;
408 ires = gst_iterator_next (it, &item);
410 case GST_ITERATOR_DONE:
413 case GST_ITERATOR_OK:
415 GstPad *pad = g_value_get_object (&item);
418 /* ask sink peer for duration */
419 res &= gst_pad_peer_query_duration (pad, format, &duration);
420 /* take max from all valid return values */
422 /* valid unknown length, stop searching */
423 if (duration == -1) {
427 /* else see if bigger than current max */
428 else if (duration > max)
431 g_value_reset (&item);
434 case GST_ITERATOR_RESYNC:
437 gst_iterator_resync (it);
445 g_value_unset (&item);
446 gst_iterator_free (it);
449 /* and store the max */
450 GST_DEBUG_OBJECT (adder, "Total duration in format %s: %"
451 GST_TIME_FORMAT, gst_format_get_name (format), GST_TIME_ARGS (max));
452 gst_query_set_duration (query, format, max);
459 gst_adder_query_latency (GstAdder * adder, GstQuery * query)
461 GstClockTime min, max;
466 GValue item = { 0, };
473 max = GST_CLOCK_TIME_NONE;
475 /* Take maximum of all latency values */
476 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
478 GstIteratorResult ires;
480 ires = gst_iterator_next (it, &item);
482 case GST_ITERATOR_DONE:
485 case GST_ITERATOR_OK:
487 GstPad *pad = g_value_get_object (&item);
489 GstClockTime min_cur, max_cur;
492 peerquery = gst_query_new_latency ();
494 /* Ask peer for latency */
495 res &= gst_pad_peer_query (pad, peerquery);
497 /* take max from all valid return values */
499 gst_query_parse_latency (peerquery, &live_cur, &min_cur, &max_cur);
504 if (max_cur != GST_CLOCK_TIME_NONE &&
505 ((max != GST_CLOCK_TIME_NONE && max_cur > max) ||
506 (max == GST_CLOCK_TIME_NONE)))
509 live = live || live_cur;
512 gst_query_unref (peerquery);
513 g_value_reset (&item);
516 case GST_ITERATOR_RESYNC:
519 max = GST_CLOCK_TIME_NONE;
521 gst_iterator_resync (it);
529 g_value_unset (&item);
530 gst_iterator_free (it);
533 /* store the results */
534 GST_DEBUG_OBJECT (adder, "Calculated total latency: live %s, min %"
535 GST_TIME_FORMAT ", max %" GST_TIME_FORMAT,
536 (live ? "yes" : "no"), GST_TIME_ARGS (min), GST_TIME_ARGS (max));
537 gst_query_set_latency (query, live, min, max);
544 gst_adder_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
546 GstAdder *adder = GST_ADDER (parent);
547 gboolean res = FALSE;
549 switch (GST_QUERY_TYPE (query)) {
550 case GST_QUERY_POSITION:
554 gst_query_parse_position (query, &format, NULL);
557 case GST_FORMAT_TIME:
558 /* FIXME, bring to stream time, might be tricky */
559 gst_query_set_position (query, format, adder->segment.position);
562 case GST_FORMAT_DEFAULT:
563 gst_query_set_position (query, format, adder->offset);
571 case GST_QUERY_DURATION:
572 res = gst_adder_query_duration (adder, query);
574 case GST_QUERY_LATENCY:
575 res = gst_adder_query_latency (adder, query);
578 /* FIXME, needs a custom query handler because we have multiple
580 res = gst_pad_query_default (pad, parent, query);
596 forward_event_func (const GValue * val, GValue * ret, EventData * data)
598 GstPad *pad = g_value_get_object (val);
599 GstEvent *event = data->event;
602 gst_event_ref (event);
603 GST_LOG_OBJECT (pad, "About to send event %s", GST_EVENT_TYPE_NAME (event));
604 peer = gst_pad_get_peer (pad);
605 /* collect pad might have been set flushing,
606 * so bypass core checking that and send directly to peer */
607 if (!peer || !gst_pad_send_event (peer, event)) {
609 gst_event_unref (event);
610 GST_WARNING_OBJECT (pad, "Sending event %p (%s) failed.",
611 event, GST_EVENT_TYPE_NAME (event));
612 /* quick hack to unflush the pads, ideally we need a way to just unflush
613 * this single collect pad */
615 gst_pad_send_event (pad, gst_event_new_flush_stop (TRUE));
617 g_value_set_boolean (ret, TRUE);
618 GST_LOG_OBJECT (pad, "Sent event %p (%s).",
619 event, GST_EVENT_TYPE_NAME (event));
622 gst_object_unref (peer);
624 /* continue on other pads, even if one failed */
628 /* forwards the event to all sinkpads, takes ownership of the
631 * Returns: TRUE if the event could be forwarded on all
635 forward_event (GstAdder * adder, GstEvent * event, gboolean flush)
639 GstIteratorResult ires;
643 GST_LOG_OBJECT (adder, "Forwarding event %p (%s)", event,
644 GST_EVENT_TYPE_NAME (event));
649 g_value_init (&vret, G_TYPE_BOOLEAN);
650 g_value_set_boolean (&vret, FALSE);
651 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
654 gst_iterator_fold (it, (GstIteratorFoldFunction) forward_event_func,
657 case GST_ITERATOR_RESYNC:
658 GST_WARNING ("resync");
659 gst_iterator_resync (it);
660 g_value_set_boolean (&vret, TRUE);
662 case GST_ITERATOR_OK:
663 case GST_ITERATOR_DONE:
664 ret = g_value_get_boolean (&vret);
672 gst_iterator_free (it);
673 GST_LOG_OBJECT (adder, "Forwarded event %p (%s), ret=%d", event,
674 GST_EVENT_TYPE_NAME (event), ret);
675 gst_event_unref (event);
681 gst_adder_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
686 adder = GST_ADDER (parent);
688 GST_DEBUG_OBJECT (pad, "Got %s event on src pad",
689 GST_EVENT_TYPE_NAME (event));
691 switch (GST_EVENT_TYPE (event)) {
696 GstSeekType curtype, endtype;
700 /* parse the seek parameters */
701 gst_event_parse_seek (event, &rate, NULL, &flags, &curtype,
702 &cur, &endtype, &end);
704 if ((curtype != GST_SEEK_TYPE_NONE) && (curtype != GST_SEEK_TYPE_SET)) {
706 GST_DEBUG_OBJECT (adder,
707 "seeking failed, unhandled seek type for start: %d", curtype);
710 if ((endtype != GST_SEEK_TYPE_NONE) && (endtype != GST_SEEK_TYPE_SET)) {
712 GST_DEBUG_OBJECT (adder,
713 "seeking failed, unhandled seek type for end: %d", endtype);
717 flush = (flags & GST_SEEK_FLAG_FLUSH) == GST_SEEK_FLAG_FLUSH;
719 /* check if we are flushing */
721 /* flushing seek, start flush downstream, the flush will be done
722 * when all pads received a FLUSH_STOP.
723 * Make sure we accept nothing anymore and return WRONG_STATE.
724 * We send a flush-start before, to ensure no streaming is done
725 * as we need to take the stream lock.
727 gst_pad_push_event (adder->srcpad, gst_event_new_flush_start ());
728 gst_collect_pads_set_flushing (adder->collect, TRUE);
730 /* We can't send FLUSH_STOP here since upstream could start pushing data
731 * after we unlock adder->collect.
732 * We set flush_stop_pending to TRUE instead and send FLUSH_STOP after
733 * forwarding the seek upstream or from gst_adder_collected,
734 * whichever happens first.
736 g_atomic_int_set (&adder->flush_stop_pending, TRUE);
738 GST_DEBUG_OBJECT (adder, "handling seek event: %" GST_PTR_FORMAT, event);
740 /* now wait for the collected to be finished and mark a new
741 * segment. After we have the lock, no collect function is running and no
742 * new collect function will be called for as long as we're flushing. */
743 GST_COLLECT_PADS_STREAM_LOCK (adder->collect);
744 adder->segment.rate = rate;
745 if (curtype == GST_SEEK_TYPE_SET)
746 adder->segment.start = cur;
748 adder->segment.start = 0;
749 if (endtype == GST_SEEK_TYPE_SET)
750 adder->segment.stop = end;
752 adder->segment.stop = GST_CLOCK_TIME_NONE;
754 /* Yes, we need to call _set_flushing again *WHEN* the streaming threads
755 * have stopped so that the cookie gets properly updated. */
756 gst_collect_pads_set_flushing (adder->collect, TRUE);
758 GST_COLLECT_PADS_STREAM_UNLOCK (adder->collect);
759 GST_DEBUG_OBJECT (adder, "forwarding seek event: %" GST_PTR_FORMAT,
762 /* we're forwarding seek to all upstream peers and wait for one to reply
763 * with a newsegment-event before we send a newsegment-event downstream */
764 g_atomic_int_set (&adder->wait_for_new_segment, TRUE);
765 result = forward_event (adder, event, flush);
767 /* seek failed. maybe source is a live source. */
768 GST_DEBUG_OBJECT (adder, "seeking failed");
770 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
772 GST_DEBUG_OBJECT (adder, "pending flush stop");
773 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop (TRUE));
778 /* QoS might be tricky */
780 gst_event_unref (event);
782 case GST_EVENT_NAVIGATION:
783 /* navigation is rather pointless. */
785 gst_event_unref (event);
788 /* just forward the rest for now */
789 GST_DEBUG_OBJECT (adder, "forward unhandled event: %s",
790 GST_EVENT_TYPE_NAME (event));
791 result = forward_event (adder, event, FALSE);
801 gst_adder_sink_event (GstCollectPads * pads, GstCollectData * pad,
802 GstEvent * event, gpointer user_data)
804 GstAdder *adder = GST_ADDER (user_data);
805 gboolean res = TRUE, discard = FALSE;
807 GST_DEBUG_OBJECT (pad->pad, "Got %s event on sink pad",
808 GST_EVENT_TYPE_NAME (event));
810 switch (GST_EVENT_TYPE (event)) {
815 gst_event_parse_caps (event, &caps);
816 res = gst_adder_setcaps (adder, pad->pad, caps);
817 gst_event_unref (event);
820 case GST_EVENT_FLUSH_STOP:
821 /* we received a flush-stop. We will only forward it when
822 * flush_stop_pending is set, and we will unset it then.
824 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
826 g_atomic_int_set (&adder->new_segment_pending, TRUE);
827 GST_DEBUG_OBJECT (pad->pad, "forwarding flush stop");
830 GST_DEBUG_OBJECT (pad->pad, "eating flush stop");
832 /* Clear pending tags */
833 if (adder->pending_events) {
834 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
835 g_list_free (adder->pending_events);
836 adder->pending_events = NULL;
840 /* collect tags here so we can push them out when we collect data */
841 adder->pending_events = g_list_append (adder->pending_events, event);
844 case GST_EVENT_SEGMENT:
845 if (g_atomic_int_compare_and_exchange (&adder->wait_for_new_segment,
847 /* make sure we push a new segment, to inform about new basetime
848 * see FIXME in gst_adder_collected() */
849 g_atomic_int_set (&adder->new_segment_pending, TRUE);
857 if (G_LIKELY (event))
858 return gst_collect_pads_event_default (pads, pad, event, discard);
864 gst_adder_class_init (GstAdderClass * klass)
866 GObjectClass *gobject_class = (GObjectClass *) klass;
867 GstElementClass *gstelement_class = (GstElementClass *) klass;
869 gobject_class->set_property = gst_adder_set_property;
870 gobject_class->get_property = gst_adder_get_property;
871 gobject_class->dispose = gst_adder_dispose;
873 g_object_class_install_property (gobject_class, PROP_FILTER_CAPS,
874 g_param_spec_boxed ("caps", "Target caps",
875 "Set target format for mixing (NULL means ANY). "
876 "Setting this property takes a reference to the supplied GstCaps "
877 "object.", GST_TYPE_CAPS,
878 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
880 gst_element_class_add_pad_template (gstelement_class,
881 gst_static_pad_template_get (&gst_adder_src_template));
882 gst_element_class_add_pad_template (gstelement_class,
883 gst_static_pad_template_get (&gst_adder_sink_template));
884 gst_element_class_set_static_metadata (gstelement_class, "Adder",
886 "Add N audio channels together",
887 "Thomas Vander Stichele <thomas at apestaart dot org>");
889 gstelement_class->request_new_pad =
890 GST_DEBUG_FUNCPTR (gst_adder_request_new_pad);
891 gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_adder_release_pad);
892 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_adder_change_state);
896 gst_adder_init (GstAdder * adder)
898 GstPadTemplate *template;
900 template = gst_static_pad_template_get (&gst_adder_src_template);
901 adder->srcpad = gst_pad_new_from_template (template, "src");
902 gst_object_unref (template);
904 gst_pad_set_query_function (adder->srcpad,
905 GST_DEBUG_FUNCPTR (gst_adder_src_query));
906 gst_pad_set_event_function (adder->srcpad,
907 GST_DEBUG_FUNCPTR (gst_adder_src_event));
908 GST_PAD_SET_PROXY_CAPS (adder->srcpad);
909 gst_element_add_pad (GST_ELEMENT (adder), adder->srcpad);
911 adder->current_caps = NULL;
912 gst_audio_info_init (&adder->info);
916 adder->filter_caps = NULL;
918 /* keep track of the sinkpads requested */
919 adder->collect = gst_collect_pads_new ();
920 gst_collect_pads_set_function (adder->collect,
921 GST_DEBUG_FUNCPTR (gst_adder_collected), adder);
922 gst_collect_pads_set_clip_function (adder->collect,
923 GST_DEBUG_FUNCPTR (gst_adder_do_clip), adder);
924 gst_collect_pads_set_event_function (adder->collect,
925 GST_DEBUG_FUNCPTR (gst_adder_sink_event), adder);
926 gst_collect_pads_set_query_function (adder->collect,
927 GST_DEBUG_FUNCPTR (gst_adder_sink_query), adder);
931 gst_adder_dispose (GObject * object)
933 GstAdder *adder = GST_ADDER (object);
935 if (adder->collect) {
936 gst_object_unref (adder->collect);
937 adder->collect = NULL;
939 gst_caps_replace (&adder->filter_caps, NULL);
940 gst_caps_replace (&adder->current_caps, NULL);
942 if (adder->pending_events) {
943 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
944 g_list_free (adder->pending_events);
945 adder->pending_events = NULL;
948 G_OBJECT_CLASS (parent_class)->dispose (object);
952 gst_adder_set_property (GObject * object, guint prop_id,
953 const GValue * value, GParamSpec * pspec)
955 GstAdder *adder = GST_ADDER (object);
958 case PROP_FILTER_CAPS:{
959 GstCaps *new_caps = NULL;
961 const GstCaps *new_caps_val = gst_value_get_caps (value);
963 if (new_caps_val != NULL) {
964 new_caps = (GstCaps *) new_caps_val;
965 gst_caps_ref (new_caps);
968 GST_OBJECT_LOCK (adder);
969 old_caps = adder->filter_caps;
970 adder->filter_caps = new_caps;
971 GST_OBJECT_UNLOCK (adder);
974 gst_caps_unref (old_caps);
976 GST_DEBUG_OBJECT (adder, "set new caps %" GST_PTR_FORMAT, new_caps);
980 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
986 gst_adder_get_property (GObject * object, guint prop_id, GValue * value,
989 GstAdder *adder = GST_ADDER (object);
992 case PROP_FILTER_CAPS:
993 GST_OBJECT_LOCK (adder);
994 gst_value_set_caps (value, adder->filter_caps);
995 GST_OBJECT_UNLOCK (adder);
998 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1005 gst_adder_request_new_pad (GstElement * element, GstPadTemplate * templ,
1006 const gchar * unused, const GstCaps * caps)
1013 if (templ->direction != GST_PAD_SINK)
1016 adder = GST_ADDER (element);
1018 /* increment pad counter */
1019 padcount = g_atomic_int_add (&adder->padcount, 1);
1021 name = g_strdup_printf ("sink_%u", padcount);
1022 newpad = gst_pad_new_from_template (templ, name);
1023 GST_DEBUG_OBJECT (adder, "request new pad %s", name);
1026 gst_collect_pads_add_pad (adder->collect, newpad, sizeof (GstCollectData),
1029 /* takes ownership of the pad */
1030 if (!gst_element_add_pad (GST_ELEMENT (adder), newpad))
1038 g_warning ("gstadder: request new pad that is not a SINK pad\n");
1043 GST_DEBUG_OBJECT (adder, "could not add pad");
1044 gst_collect_pads_remove_pad (adder->collect, newpad);
1045 gst_object_unref (newpad);
1051 gst_adder_release_pad (GstElement * element, GstPad * pad)
1055 adder = GST_ADDER (element);
1057 GST_DEBUG_OBJECT (adder, "release pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1060 gst_collect_pads_remove_pad (adder->collect, pad);
1061 gst_element_remove_pad (element, pad);
1064 static GstFlowReturn
1065 gst_adder_do_clip (GstCollectPads * pads, GstCollectData * data,
1066 GstBuffer * buffer, GstBuffer ** out, gpointer user_data)
1068 GstAdder *adder = GST_ADDER (user_data);
1071 rate = GST_AUDIO_INFO_RATE (&adder->info);
1072 bpf = GST_AUDIO_INFO_BPF (&adder->info);
1074 buffer = gst_audio_buffer_clip (buffer, &data->segment, rate, bpf);
1080 static GstFlowReturn
1081 gst_adder_collected (GstCollectPads * pads, gpointer user_data)
1084 * combine streams by adding data values
1086 * - this function is called when all pads have a buffer
1087 * - get available bytes on all pads.
1088 * - repeat for each input pad :
1089 * - read available bytes, copy or add to target buffer
1090 * - if there's an EOS event, remove the input channel
1091 * - push out the output buffer
1094 * - would be nice to have a mixing mode, where instead of adding we mix
1095 * - for float we could downscale after collect loop
1096 * - for int we need to downscale each input to avoid clipping or
1097 * mix into a temp (float) buffer and scale afterwards as well
1100 GSList *collected, *next = NULL;
1102 GstBuffer *outbuf = NULL, *gapbuf = NULL;
1103 GstMapInfo outmap = { NULL };
1106 gint64 next_timestamp;
1107 gint rate, bps, bpf;
1109 adder = GST_ADDER (user_data);
1112 if (G_UNLIKELY (adder->func == NULL))
1113 goto not_negotiated;
1115 if (adder->send_stream_start) {
1118 /* stream-start (FIXME: create id based on input ids) */
1119 g_snprintf (s_id, sizeof (s_id), "adder-%08x", g_random_int ());
1120 gst_pad_push_event (adder->srcpad, gst_event_new_stream_start (s_id));
1121 adder->send_stream_start = FALSE;
1124 if (adder->send_caps) {
1125 GstEvent *caps_event;
1127 caps_event = gst_event_new_caps (adder->current_caps);
1128 GST_INFO_OBJECT (adder, "caps event %" GST_PTR_FORMAT, caps_event);
1129 gst_pad_push_event (adder->srcpad, caps_event);
1130 adder->send_caps = FALSE;
1133 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
1135 GST_DEBUG_OBJECT (adder, "pending flush stop");
1136 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop (TRUE));
1139 /* get available bytes for reading, this can be 0 which could mean empty
1140 * buffers or EOS, which we will catch when we loop over the pads. */
1141 outsize = gst_collect_pads_available (pads);
1142 /* can only happen when no pads to collect or all EOS */
1146 rate = GST_AUDIO_INFO_RATE (&adder->info);
1147 bps = GST_AUDIO_INFO_BPS (&adder->info);
1148 bpf = GST_AUDIO_INFO_BPF (&adder->info);
1150 GST_LOG_OBJECT (adder,
1151 "starting to cycle through channels, %d bytes available (bps = %d, bpf = %d)",
1154 for (collected = pads->data; collected; collected = next) {
1155 GstCollectData *collect_data;
1159 /* take next to see if this is the last collectdata */
1160 next = g_slist_next (collected);
1162 collect_data = (GstCollectData *) collected->data;
1164 /* get a buffer of size bytes, if we get a buffer, it is at least outsize
1166 inbuf = gst_collect_pads_take_buffer (pads, collect_data, outsize);
1167 /* NULL means EOS or an empty buffer so we still need to flush in
1168 * case of an empty buffer. */
1169 if (inbuf == NULL) {
1170 GST_LOG_OBJECT (adder, "channel %p: no bytes available", collect_data);
1174 is_gap = GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP);
1176 /* Try to make an output buffer */
1177 if (outbuf == NULL) {
1178 /* if this is a gap buffer but we have some more pads to check, skip it.
1179 * If we are at the last buffer, take it, regardless if it is a GAP
1181 if (is_gap && next) {
1182 GST_DEBUG_OBJECT (adder, "skipping, non-last GAP buffer");
1183 /* we keep the GAP buffer, if we don't have anymore buffers (all pads
1184 * EOS, we can use this one as the output buffer. */
1188 gst_buffer_unref (inbuf);
1192 GST_LOG_OBJECT (adder, "channel %p: preparing output buffer of %d bytes",
1193 collect_data, outsize);
1195 /* make data and metadata writable, can simply return the inbuf when we
1196 * are the only one referencing this buffer. If this is the last (and
1197 * only) GAP buffer, it will automatically copy the GAP flag. */
1198 outbuf = gst_buffer_make_writable (inbuf);
1199 gst_buffer_map (outbuf, &outmap, GST_MAP_WRITE);
1202 /* we had a previous output buffer, mix this non-GAP buffer */
1205 gst_buffer_map (inbuf, &inmap, GST_MAP_READ);
1207 /* all buffers should have outsize, there are no short buffers because we
1208 * asked for the max size above */
1209 g_assert (inmap.size == outmap.size);
1211 GST_LOG_OBJECT (adder, "channel %p: mixing %" G_GSIZE_FORMAT " bytes"
1212 " from data %p", collect_data, inmap.size, inmap.data);
1214 /* further buffers, need to add them */
1215 adder->func ((gpointer) outmap.data, (gpointer) inmap.data,
1217 gst_buffer_unmap (inbuf, &inmap);
1219 /* skip gap buffer */
1220 GST_LOG_OBJECT (adder, "channel %p: skipping GAP buffer", collect_data);
1222 gst_buffer_unref (inbuf);
1226 gst_buffer_unmap (outbuf, &outmap);
1228 if (outbuf == NULL) {
1229 /* no output buffer, reuse one of the GAP buffers then if we have one */
1231 GST_LOG_OBJECT (adder, "reusing GAP buffer %p", gapbuf);
1234 /* assume EOS otherwise, this should not happen, really */
1237 /* we had an output buffer, unref the gapbuffer we kept */
1238 gst_buffer_unref (gapbuf);
1240 if (g_atomic_int_compare_and_exchange (&adder->new_segment_pending, TRUE,
1244 /* FIXME, use rate/applied_rate as set on all sinkpads.
1245 * - currently we just set rate as received from last seek-event
1247 * When seeking we set the start and stop positions as given in the seek
1248 * event. We also adjust offset & timestamp accordingly.
1249 * This basically ignores all newsegments sent by upstream.
1251 event = gst_event_new_segment (&adder->segment);
1253 if (adder->segment.rate > 0.0) {
1254 adder->segment.position = adder->segment.start;
1256 adder->segment.position = adder->segment.stop;
1258 adder->offset = gst_util_uint64_scale (adder->segment.position,
1260 GST_INFO_OBJECT (adder, "seg_start %" G_GUINT64_FORMAT ", seg_end %"
1261 G_GUINT64_FORMAT, adder->segment.start, adder->segment.stop);
1262 GST_INFO_OBJECT (adder, "timestamp %" G_GINT64_FORMAT ",new offset %"
1263 G_GINT64_FORMAT, adder->segment.position, adder->offset);
1266 if (!gst_pad_push_event (adder->srcpad, event)) {
1267 GST_WARNING_OBJECT (adder->srcpad, "Sending new segment event failed");
1270 GST_WARNING_OBJECT (adder->srcpad, "Creating new segment event for "
1271 "start:%" G_GINT64_FORMAT " end:%" G_GINT64_FORMAT " failed",
1272 adder->segment.start, adder->segment.stop);
1276 if (G_UNLIKELY (adder->pending_events)) {
1277 GList *tmp = adder->pending_events;
1280 GstEvent *ev = (GstEvent *) tmp->data;
1282 gst_pad_push_event (adder->srcpad, ev);
1283 tmp = g_list_next (tmp);
1285 g_list_free (adder->pending_events);
1286 adder->pending_events = NULL;
1289 /* for the next timestamp, use the sample counter, which will
1290 * never accumulate rounding errors */
1291 if (adder->segment.rate > 0.0) {
1292 next_offset = adder->offset + outsize / bpf;
1294 next_offset = adder->offset - outsize / bpf;
1296 next_timestamp = gst_util_uint64_scale (next_offset, GST_SECOND, rate);
1299 /* set timestamps on the output buffer */
1300 if (adder->segment.rate > 0.0) {
1301 GST_BUFFER_TIMESTAMP (outbuf) = adder->segment.position;
1302 GST_BUFFER_OFFSET (outbuf) = adder->offset;
1303 GST_BUFFER_OFFSET_END (outbuf) = next_offset;
1304 GST_BUFFER_DURATION (outbuf) = next_timestamp - adder->segment.position;
1306 GST_BUFFER_TIMESTAMP (outbuf) = next_timestamp;
1307 GST_BUFFER_OFFSET (outbuf) = next_offset;
1308 GST_BUFFER_OFFSET_END (outbuf) = adder->offset;
1309 GST_BUFFER_DURATION (outbuf) = adder->segment.position - next_timestamp;
1312 adder->offset = next_offset;
1313 adder->segment.position = next_timestamp;
1316 GST_LOG_OBJECT (adder, "pushing outbuf %p, timestamp %" GST_TIME_FORMAT
1317 " offset %" G_GINT64_FORMAT, outbuf,
1318 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)),
1319 GST_BUFFER_OFFSET (outbuf));
1320 ret = gst_pad_push (adder->srcpad, outbuf);
1322 GST_LOG_OBJECT (adder, "pushed outbuf, result = %s", gst_flow_get_name (ret));
1329 GST_ELEMENT_ERROR (adder, STREAM, FORMAT, (NULL),
1330 ("Unknown data received, not negotiated"));
1331 return GST_FLOW_NOT_NEGOTIATED;
1335 GST_DEBUG_OBJECT (adder, "no data available, must be EOS");
1336 gst_pad_push_event (adder->srcpad, gst_event_new_eos ());
1337 return GST_FLOW_EOS;
1341 static GstStateChangeReturn
1342 gst_adder_change_state (GstElement * element, GstStateChange transition)
1345 GstStateChangeReturn ret;
1347 adder = GST_ADDER (element);
1349 switch (transition) {
1350 case GST_STATE_CHANGE_NULL_TO_READY:
1352 case GST_STATE_CHANGE_READY_TO_PAUSED:
1353 adder->segment.position = 0;
1355 adder->flush_stop_pending = FALSE;
1356 adder->new_segment_pending = TRUE;
1357 adder->wait_for_new_segment = FALSE;
1358 adder->send_stream_start = TRUE;
1359 adder->send_caps = TRUE;
1360 gst_caps_replace (&adder->current_caps, NULL);
1361 gst_segment_init (&adder->segment, GST_FORMAT_TIME);
1362 gst_collect_pads_start (adder->collect);
1364 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1366 case GST_STATE_CHANGE_PAUSED_TO_READY:
1367 /* need to unblock the collectpads before calling the
1368 * parent change_state so that streaming can finish */
1369 gst_collect_pads_stop (adder->collect);
1375 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1377 switch (transition) {
1386 plugin_init (GstPlugin * plugin)
1388 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "adder", 0,
1389 "audio channel mixing element");
1391 if (!gst_element_register (plugin, "adder", GST_RANK_NONE, GST_TYPE_ADDER)) {
1398 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1401 "Adds multiple streams",
1402 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)