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 <string.h> /* strcmp */
48 #include "gstadderorc.h"
50 /* highest positive/lowest negative x-bit value we can use for clamping */
51 #define MAX_INT_32 ((gint32) (0x7fffffff))
52 #define MAX_INT_16 ((gint16) (0x7fff))
53 #define MAX_INT_8 ((gint8) (0x7f))
54 #define MAX_UINT_32 ((guint32)(0xffffffff))
55 #define MAX_UINT_16 ((guint16)(0xffff))
56 #define MAX_UINT_8 ((guint8) (0xff))
58 #define MIN_INT_32 ((gint32) (0x80000000))
59 #define MIN_INT_16 ((gint16) (0x8000))
60 #define MIN_INT_8 ((gint8) (0x80))
61 #define MIN_UINT_32 ((guint32)(0x00000000))
62 #define MIN_UINT_16 ((guint16)(0x0000))
63 #define MIN_UINT_8 ((guint8) (0x00))
71 #define GST_CAT_DEFAULT gst_adder_debug
72 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
74 /* elementfactory information */
76 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
78 GST_AUDIO_CAPS_MAKE ("{ S32LE, U32LE, S16LE, U16LE, S8, U8, F32LE, F64LE }")
81 GST_AUDIO_CAPS_MAKE ("{ S32BE, U32BE, S16BE, U16BE, S8, U8, F32BE, F64BE }")
84 static GstStaticPadTemplate gst_adder_src_template =
85 GST_STATIC_PAD_TEMPLATE ("src",
88 GST_STATIC_CAPS (CAPS)
91 static GstStaticPadTemplate gst_adder_sink_template =
92 GST_STATIC_PAD_TEMPLATE ("sink_%u",
95 GST_STATIC_CAPS (CAPS)
98 #define gst_adder_parent_class parent_class
99 G_DEFINE_TYPE (GstAdder, gst_adder, GST_TYPE_ELEMENT);
101 static void gst_adder_dispose (GObject * object);
102 static void gst_adder_set_property (GObject * object, guint prop_id,
103 const GValue * value, GParamSpec * pspec);
104 static void gst_adder_get_property (GObject * object, guint prop_id,
105 GValue * value, GParamSpec * pspec);
107 static gboolean gst_adder_setcaps (GstAdder * adder, GstPad * pad,
109 static gboolean gst_adder_src_query (GstPad * pad, GstObject * parent,
111 static gboolean gst_adder_sink_query (GstPad * pad, GstObject * parent,
113 static gboolean gst_adder_src_event (GstPad * pad, GstObject * parent,
115 static gboolean gst_adder_sink_event (GstPad * pad, GstObject * parent,
118 static GstPad *gst_adder_request_new_pad (GstElement * element,
119 GstPadTemplate * temp, const gchar * unused, const GstCaps * caps);
120 static void gst_adder_release_pad (GstElement * element, GstPad * pad);
122 static GstStateChangeReturn gst_adder_change_state (GstElement * element,
123 GstStateChange transition);
125 static GstBuffer *gst_adder_do_clip (GstCollectPads * pads,
126 GstCollectData * data, GstBuffer * buffer, gpointer user_data);
127 static GstFlowReturn gst_adder_collected (GstCollectPads * pads,
130 /* non-clipping versions (for float) */
131 #define MAKE_FUNC_NC(name,type) \
132 static void name (type *out, type *in, gint samples) { \
134 for (i = 0; i < samples; i++) \
139 MAKE_FUNC_NC (add_float64, gdouble)
142 /* we can only accept caps that we and downstream can handle.
143 * if we have filtercaps set, use those to constrain the target caps.
146 gst_adder_sink_getcaps (GstPad * pad, GstCaps * filter)
149 GstCaps *result, *peercaps, *sinkcaps, *filter_caps;
151 adder = GST_ADDER (GST_PAD_PARENT (pad));
153 GST_OBJECT_LOCK (adder);
155 if ((filter_caps = adder->filter_caps)) {
158 gst_caps_intersect_full (filter, filter_caps,
159 GST_CAPS_INTERSECT_FIRST);
161 gst_caps_ref (filter_caps);
163 filter_caps = filter ? gst_caps_ref (filter) : NULL;
165 GST_OBJECT_UNLOCK (adder);
167 if (filter_caps && gst_caps_is_empty (filter_caps)) {
168 GST_WARNING_OBJECT (pad, "Empty filter caps");
172 /* get the downstream possible caps */
173 peercaps = gst_pad_peer_query_caps (adder->srcpad, filter_caps);
175 /* get the allowed caps on this sinkpad */
176 sinkcaps = gst_pad_get_current_caps (pad);
177 if (sinkcaps == NULL) {
178 sinkcaps = gst_pad_get_pad_template_caps (pad);
180 sinkcaps = gst_caps_new_any ();
184 /* if the peer has caps, intersect */
185 GST_DEBUG_OBJECT (adder, "intersecting peer and template caps");
187 gst_caps_intersect_full (peercaps, sinkcaps, GST_CAPS_INTERSECT_FIRST);
188 gst_caps_unref (peercaps);
189 gst_caps_unref (sinkcaps);
191 /* the peer has no caps (or there is no peer), just use the allowed caps
192 * of this sinkpad. */
193 /* restrict with filter-caps if any */
195 GST_DEBUG_OBJECT (adder, "no peer caps, using filtered sinkcaps");
197 gst_caps_intersect_full (filter_caps, sinkcaps,
198 GST_CAPS_INTERSECT_FIRST);
199 gst_caps_unref (sinkcaps);
201 GST_DEBUG_OBJECT (adder, "no peer caps, using sinkcaps");
207 gst_caps_unref (filter_caps);
209 GST_LOG_OBJECT (adder, "getting caps on pad %p,%s to %" GST_PTR_FORMAT, pad,
210 GST_PAD_NAME (pad), result);
216 gst_adder_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
218 gboolean res = FALSE;
220 switch (GST_QUERY_TYPE (query)) {
223 GstCaps *filter, *caps;
225 gst_query_parse_caps (query, &filter);
226 caps = gst_adder_sink_getcaps (pad, filter);
227 gst_query_set_caps_result (query, caps);
228 gst_caps_unref (caps);
233 res = gst_pad_query_default (pad, parent, query);
246 setcapsfunc (const GValue * item, IterData * data)
248 GstPad *otherpad = g_value_get_object (item);
250 if (otherpad != data->pad)
251 gst_pad_set_caps (data->pad, data->caps);
254 /* the first caps we receive on any of the sinkpads will define the caps for all
255 * the other sinkpads because we can only mix streams with the same caps.
258 gst_adder_setcaps (GstAdder * adder, GstPad * pad, GstCaps * caps)
262 GstIteratorResult ires;
266 GST_LOG_OBJECT (adder, "setting caps pad %p,%s to %" GST_PTR_FORMAT, pad,
267 GST_PAD_NAME (pad), caps);
269 it = gst_element_iterate_pads (GST_ELEMENT_CAST (adder));
271 /* FIXME, see if the other pads can accept the format. Also lock the
272 * format on the other pads to this new format. */
278 ires = gst_iterator_foreach (it, (GstIteratorForeachFunction) setcapsfunc,
282 case GST_ITERATOR_RESYNC:
283 gst_iterator_resync (it);
291 if (!gst_audio_info_from_caps (&info, caps))
294 switch (GST_AUDIO_INFO_FORMAT (&info)) {
295 case GST_AUDIO_FORMAT_S8:
296 adder->func = (GstAdderFunction) add_int8;
298 case GST_AUDIO_FORMAT_U8:
299 adder->func = (GstAdderFunction) add_uint8;
301 case GST_AUDIO_FORMAT_S16:
302 adder->func = (GstAdderFunction) add_int16;
304 case GST_AUDIO_FORMAT_U16:
305 adder->func = (GstAdderFunction) add_uint16;
307 case GST_AUDIO_FORMAT_S32:
308 adder->func = (GstAdderFunction) add_int32;
310 case GST_AUDIO_FORMAT_U32:
311 adder->func = (GstAdderFunction) add_uint32;
313 case GST_AUDIO_FORMAT_F32:
314 adder->func = (GstAdderFunction) add_float32;
316 case GST_AUDIO_FORMAT_F64:
317 adder->func = (GstAdderFunction) add_float64;
327 GST_DEBUG_OBJECT (adder, "invalid format set as caps");
332 /* FIXME, the duration query should reflect how long you will produce
333 * data, that is the amount of stream time until you will emit EOS.
335 * For synchronized mixing this is always the max of all the durations
336 * of upstream since we emit EOS when all of them finished.
338 * We don't do synchronized mixing so this really depends on where the
339 * streams where punched in and what their relative offsets are against
340 * eachother which we can get from the first timestamps we see.
342 * When we add a new stream (or remove a stream) the duration might
343 * also become invalid again and we need to post a new DURATION
344 * message to notify this fact to the parent.
345 * For now we take the max of all the upstream elements so the simple
346 * cases work at least somewhat.
349 gst_adder_query_duration (GstAdder * adder, GstQuery * query)
356 GValue item = { 0, };
359 gst_query_parse_duration (query, &format, NULL);
365 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
367 GstIteratorResult ires;
369 ires = gst_iterator_next (it, &item);
371 case GST_ITERATOR_DONE:
374 case GST_ITERATOR_OK:
376 GstPad *pad = g_value_get_object (&item);
379 /* ask sink peer for duration */
380 res &= gst_pad_peer_query_duration (pad, format, &duration);
381 /* take max from all valid return values */
383 /* valid unknown length, stop searching */
384 if (duration == -1) {
388 /* else see if bigger than current max */
389 else if (duration > max)
392 g_value_reset (&item);
395 case GST_ITERATOR_RESYNC:
398 gst_iterator_resync (it);
406 g_value_unset (&item);
407 gst_iterator_free (it);
410 /* and store the max */
411 GST_DEBUG_OBJECT (adder, "Total duration in format %s: %"
412 GST_TIME_FORMAT, gst_format_get_name (format), GST_TIME_ARGS (max));
413 gst_query_set_duration (query, format, max);
420 gst_adder_query_latency (GstAdder * adder, GstQuery * query)
422 GstClockTime min, max;
427 GValue item = { 0, };
434 max = GST_CLOCK_TIME_NONE;
436 /* Take maximum of all latency values */
437 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
439 GstIteratorResult ires;
441 ires = gst_iterator_next (it, &item);
443 case GST_ITERATOR_DONE:
446 case GST_ITERATOR_OK:
448 GstPad *pad = g_value_get_object (&item);
450 GstClockTime min_cur, max_cur;
453 peerquery = gst_query_new_latency ();
455 /* Ask peer for latency */
456 res &= gst_pad_peer_query (pad, peerquery);
458 /* take max from all valid return values */
460 gst_query_parse_latency (peerquery, &live_cur, &min_cur, &max_cur);
465 if (max_cur != GST_CLOCK_TIME_NONE &&
466 ((max != GST_CLOCK_TIME_NONE && max_cur > max) ||
467 (max == GST_CLOCK_TIME_NONE)))
470 live = live || live_cur;
473 gst_query_unref (peerquery);
474 g_value_reset (&item);
477 case GST_ITERATOR_RESYNC:
480 max = GST_CLOCK_TIME_NONE;
482 gst_iterator_resync (it);
490 g_value_unset (&item);
491 gst_iterator_free (it);
494 /* store the results */
495 GST_DEBUG_OBJECT (adder, "Calculated total latency: live %s, min %"
496 GST_TIME_FORMAT ", max %" GST_TIME_FORMAT,
497 (live ? "yes" : "no"), GST_TIME_ARGS (min), GST_TIME_ARGS (max));
498 gst_query_set_latency (query, live, min, max);
505 gst_adder_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
507 GstAdder *adder = GST_ADDER (parent);
508 gboolean res = FALSE;
510 switch (GST_QUERY_TYPE (query)) {
511 case GST_QUERY_POSITION:
515 gst_query_parse_position (query, &format, NULL);
518 case GST_FORMAT_TIME:
519 /* FIXME, bring to stream time, might be tricky */
520 gst_query_set_position (query, format, adder->segment.position);
523 case GST_FORMAT_DEFAULT:
524 gst_query_set_position (query, format, adder->offset);
532 case GST_QUERY_DURATION:
533 res = gst_adder_query_duration (adder, query);
535 case GST_QUERY_LATENCY:
536 res = gst_adder_query_latency (adder, query);
539 /* FIXME, needs a custom query handler because we have multiple
541 res = gst_pad_query_default (pad, parent, query);
555 forward_event_func (const GValue * val, GValue * ret, EventData * data)
557 GstPad *pad = g_value_get_object (val);
558 GstEvent *event = data->event;
560 gst_event_ref (event);
561 GST_LOG_OBJECT (pad, "About to send event %s", GST_EVENT_TYPE_NAME (event));
562 if (!gst_pad_push_event (pad, event)) {
563 GST_WARNING_OBJECT (pad, "Sending event %p (%s) failed.",
564 event, GST_EVENT_TYPE_NAME (event));
565 /* quick hack to unflush the pads, ideally we need a way to just unflush
566 * this single collect pad */
568 gst_pad_send_event (pad, gst_event_new_flush_stop (TRUE));
570 g_value_set_boolean (ret, TRUE);
571 GST_LOG_OBJECT (pad, "Sent event %p (%s).",
572 event, GST_EVENT_TYPE_NAME (event));
575 /* continue on other pads, even if one failed */
579 /* forwards the event to all sinkpads, takes ownership of the
582 * Returns: TRUE if the event could be forwarded on all
586 forward_event (GstAdder * adder, GstEvent * event, gboolean flush)
590 GstIteratorResult ires;
594 GST_LOG_OBJECT (adder, "Forwarding event %p (%s)", event,
595 GST_EVENT_TYPE_NAME (event));
600 g_value_init (&vret, G_TYPE_BOOLEAN);
601 g_value_set_boolean (&vret, FALSE);
602 it = gst_element_iterate_sink_pads (GST_ELEMENT_CAST (adder));
605 gst_iterator_fold (it, (GstIteratorFoldFunction) forward_event_func,
608 case GST_ITERATOR_RESYNC:
609 GST_WARNING ("resync");
610 gst_iterator_resync (it);
611 g_value_set_boolean (&vret, TRUE);
613 case GST_ITERATOR_OK:
614 case GST_ITERATOR_DONE:
615 ret = g_value_get_boolean (&vret);
623 gst_iterator_free (it);
624 GST_LOG_OBJECT (adder, "Forwarded event %p (%s), ret=%d", event,
625 GST_EVENT_TYPE_NAME (event), ret);
626 gst_event_unref (event);
632 gst_adder_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
637 adder = GST_ADDER (parent);
639 GST_DEBUG_OBJECT (pad, "Got %s event on src pad",
640 GST_EVENT_TYPE_NAME (event));
642 switch (GST_EVENT_TYPE (event)) {
647 GstSeekType curtype, endtype;
651 /* parse the seek parameters */
652 gst_event_parse_seek (event, &rate, NULL, &flags, &curtype,
653 &cur, &endtype, &end);
655 if ((curtype != GST_SEEK_TYPE_NONE) && (curtype != GST_SEEK_TYPE_SET)) {
657 GST_DEBUG_OBJECT (adder,
658 "seeking failed, unhandled seek type for start: %d", curtype);
661 if ((endtype != GST_SEEK_TYPE_NONE) && (endtype != GST_SEEK_TYPE_SET)) {
663 GST_DEBUG_OBJECT (adder,
664 "seeking failed, unhandled seek type for end: %d", endtype);
668 flush = (flags & GST_SEEK_FLAG_FLUSH) == GST_SEEK_FLAG_FLUSH;
670 /* check if we are flushing */
672 /* make sure we accept nothing anymore and return WRONG_STATE */
673 gst_collect_pads_set_flushing (adder->collect, TRUE);
675 /* flushing seek, start flush downstream, the flush will be done
676 * when all pads received a FLUSH_STOP. */
677 gst_pad_push_event (adder->srcpad, gst_event_new_flush_start ());
679 /* We can't send FLUSH_STOP here since upstream could start pushing data
680 * after we unlock adder->collect.
681 * We set flush_stop_pending to TRUE instead and send FLUSH_STOP after
682 * forwarding the seek upstream or from gst_adder_collected,
683 * whichever happens first.
685 g_atomic_int_set (&adder->flush_stop_pending, TRUE);
687 GST_DEBUG_OBJECT (adder, "handling seek event: %" GST_PTR_FORMAT, event);
689 /* now wait for the collected to be finished and mark a new
690 * segment. After we have the lock, no collect function is running and no
691 * new collect function will be called for as long as we're flushing. */
692 GST_OBJECT_LOCK (adder->collect);
693 adder->segment.rate = rate;
694 if (curtype == GST_SEEK_TYPE_SET)
695 adder->segment.start = cur;
697 adder->segment.start = 0;
698 if (endtype == GST_SEEK_TYPE_SET)
699 adder->segment.stop = end;
701 adder->segment.stop = GST_CLOCK_TIME_NONE;
703 /* Yes, we need to call _set_flushing again *WHEN* the streaming threads
704 * have stopped so that the cookie gets properly updated. */
705 gst_collect_pads_set_flushing (adder->collect, TRUE);
707 GST_OBJECT_UNLOCK (adder->collect);
708 GST_DEBUG_OBJECT (adder, "forwarding seek event: %" GST_PTR_FORMAT,
711 /* we're forwarding seek to all upstream peers and wait for one to reply
712 * with a newsegment-event before we send a newsegment-event downstream */
713 g_atomic_int_set (&adder->wait_for_new_segment, TRUE);
714 result = forward_event (adder, event, flush);
716 /* seek failed. maybe source is a live source. */
717 GST_DEBUG_OBJECT (adder, "seeking failed");
719 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
721 GST_DEBUG_OBJECT (adder, "pending flush stop");
722 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop (TRUE));
727 /* QoS might be tricky */
730 case GST_EVENT_NAVIGATION:
731 /* navigation is rather pointless. */
735 /* just forward the rest for now */
736 GST_DEBUG_OBJECT (adder, "forward unhandled event: %s",
737 GST_EVENT_TYPE_NAME (event));
738 result = forward_event (adder, event, FALSE);
748 gst_adder_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
753 adder = GST_ADDER (parent);
755 GST_DEBUG_OBJECT (pad, "Got %s event on sink pad",
756 GST_EVENT_TYPE_NAME (event));
758 switch (GST_EVENT_TYPE (event)) {
763 gst_event_parse_caps (event, &caps);
764 ret = gst_adder_setcaps (adder, pad, caps);
765 gst_event_unref (event);
769 case GST_EVENT_FLUSH_STOP:
770 /* we received a flush-stop. The collect_event function will push the
771 * event past our element. We simply forward all flush-stop events, even
772 * when no flush-stop was pending, this is required because collectpads
773 * does not provide an API to handle-but-not-forward the flush-stop.
774 * We unset the pending flush-stop flag so that we don't send anymore
775 * flush-stop from the collect function later.
777 GST_OBJECT_LOCK (adder->collect);
778 g_atomic_int_set (&adder->new_segment_pending, TRUE);
779 g_atomic_int_set (&adder->flush_stop_pending, FALSE);
780 /* Clear pending tags */
781 if (adder->pending_events) {
782 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
783 g_list_free (adder->pending_events);
784 adder->pending_events = NULL;
786 GST_OBJECT_UNLOCK (adder->collect);
789 GST_OBJECT_LOCK (adder->collect);
790 /* collect tags here so we can push them out when we collect data */
791 adder->pending_events = g_list_append (adder->pending_events, event);
792 GST_OBJECT_UNLOCK (adder->collect);
794 case GST_EVENT_SEGMENT:
795 if (g_atomic_int_compare_and_exchange (&adder->wait_for_new_segment,
797 /* make sure we push a new segment, to inform about new basetime
798 * see FIXME in gst_adder_collected() */
799 g_atomic_int_set (&adder->new_segment_pending, TRUE);
806 /* now GstCollectPads can take care of the rest, e.g. EOS */
807 ret = adder->collect_event (pad, parent, event);
814 gst_adder_class_init (GstAdderClass * klass)
816 GObjectClass *gobject_class = (GObjectClass *) klass;
817 GstElementClass *gstelement_class = (GstElementClass *) klass;
819 gobject_class->set_property = gst_adder_set_property;
820 gobject_class->get_property = gst_adder_get_property;
821 gobject_class->dispose = gst_adder_dispose;
828 g_object_class_install_property (gobject_class, PROP_FILTER_CAPS,
829 g_param_spec_boxed ("caps", "Target caps",
830 "Set target format for mixing (NULL means ANY). "
831 "Setting this property takes a reference to the supplied GstCaps "
832 "object.", GST_TYPE_CAPS,
833 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
835 gst_element_class_add_pad_template (gstelement_class,
836 gst_static_pad_template_get (&gst_adder_src_template));
837 gst_element_class_add_pad_template (gstelement_class,
838 gst_static_pad_template_get (&gst_adder_sink_template));
839 gst_element_class_set_details_simple (gstelement_class, "Adder",
841 "Add N audio channels together",
842 "Thomas Vander Stichele <thomas at apestaart dot org>");
844 gstelement_class->request_new_pad =
845 GST_DEBUG_FUNCPTR (gst_adder_request_new_pad);
846 gstelement_class->release_pad = GST_DEBUG_FUNCPTR (gst_adder_release_pad);
847 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_adder_change_state);
851 gst_adder_init (GstAdder * adder)
853 GstPadTemplate *template;
855 template = gst_static_pad_template_get (&gst_adder_src_template);
856 adder->srcpad = gst_pad_new_from_template (template, "src");
857 gst_object_unref (template);
859 gst_pad_set_query_function (adder->srcpad,
860 GST_DEBUG_FUNCPTR (gst_adder_src_query));
861 gst_pad_set_event_function (adder->srcpad,
862 GST_DEBUG_FUNCPTR (gst_adder_src_event));
863 GST_PAD_SET_PROXY_CAPS (adder->srcpad);
864 gst_element_add_pad (GST_ELEMENT (adder), adder->srcpad);
866 gst_audio_info_init (&adder->info);
870 adder->filter_caps = NULL;
872 /* keep track of the sinkpads requested */
873 adder->collect = gst_collect_pads_new ();
874 gst_collect_pads_set_function (adder->collect,
875 GST_DEBUG_FUNCPTR (gst_adder_collected), adder);
876 gst_collect_pads_set_clip_function (adder->collect,
877 GST_DEBUG_FUNCPTR (gst_adder_do_clip), adder);
881 gst_adder_dispose (GObject * object)
883 GstAdder *adder = GST_ADDER (object);
885 if (adder->collect) {
886 gst_object_unref (adder->collect);
887 adder->collect = NULL;
889 gst_caps_replace (&adder->filter_caps, NULL);
890 if (adder->pending_events) {
891 g_list_foreach (adder->pending_events, (GFunc) gst_event_unref, NULL);
892 g_list_free (adder->pending_events);
893 adder->pending_events = NULL;
896 G_OBJECT_CLASS (parent_class)->dispose (object);
900 gst_adder_set_property (GObject * object, guint prop_id,
901 const GValue * value, GParamSpec * pspec)
903 GstAdder *adder = GST_ADDER (object);
906 case PROP_FILTER_CAPS:{
907 GstCaps *new_caps = NULL;
909 const GstCaps *new_caps_val = gst_value_get_caps (value);
911 if (new_caps_val != NULL) {
912 new_caps = (GstCaps *) new_caps_val;
913 gst_caps_ref (new_caps);
916 GST_OBJECT_LOCK (adder);
917 old_caps = adder->filter_caps;
918 adder->filter_caps = new_caps;
919 GST_OBJECT_UNLOCK (adder);
922 gst_caps_unref (old_caps);
924 GST_DEBUG_OBJECT (adder, "set new caps %" GST_PTR_FORMAT, new_caps);
928 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
934 gst_adder_get_property (GObject * object, guint prop_id, GValue * value,
937 GstAdder *adder = GST_ADDER (object);
940 case PROP_FILTER_CAPS:
941 GST_OBJECT_LOCK (adder);
942 gst_value_set_caps (value, adder->filter_caps);
943 GST_OBJECT_UNLOCK (adder);
946 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
953 gst_adder_request_new_pad (GstElement * element, GstPadTemplate * templ,
954 const gchar * unused, const GstCaps * caps)
961 if (templ->direction != GST_PAD_SINK)
964 adder = GST_ADDER (element);
966 /* increment pad counter */
967 #if GLIB_CHECK_VERSION(2,29,5)
968 padcount = g_atomic_int_add (&adder->padcount, 1);
970 padcount = g_atomic_int_exchange_and_add (&adder->padcount, 1);
973 name = g_strdup_printf ("sink_%u", padcount);
974 newpad = gst_pad_new_from_template (templ, name);
975 GST_DEBUG_OBJECT (adder, "request new pad %s", name);
978 gst_pad_set_query_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_sink_query));
979 gst_collect_pads_add_pad (adder->collect, newpad, sizeof (GstCollectData),
982 /* FIXME: hacked way to override/extend the event function of
983 * GstCollectPads; because it sets its own event function giving the
984 * element no access to events */
985 adder->collect_event = (GstPadEventFunction) GST_PAD_EVENTFUNC (newpad);
986 gst_pad_set_event_function (newpad, GST_DEBUG_FUNCPTR (gst_adder_sink_event));
988 /* takes ownership of the pad */
989 if (!gst_element_add_pad (GST_ELEMENT (adder), newpad))
997 g_warning ("gstadder: request new pad that is not a SINK pad\n");
1002 GST_DEBUG_OBJECT (adder, "could not add pad");
1003 gst_collect_pads_remove_pad (adder->collect, newpad);
1004 gst_object_unref (newpad);
1010 gst_adder_release_pad (GstElement * element, GstPad * pad)
1014 adder = GST_ADDER (element);
1016 GST_DEBUG_OBJECT (adder, "release pad %s:%s", GST_DEBUG_PAD_NAME (pad));
1018 gst_collect_pads_remove_pad (adder->collect, pad);
1019 gst_element_remove_pad (element, pad);
1023 gst_adder_do_clip (GstCollectPads * pads, GstCollectData * data,
1024 GstBuffer * buffer, gpointer user_data)
1026 GstAdder *adder = GST_ADDER (user_data);
1029 rate = GST_AUDIO_INFO_RATE (&adder->info);
1030 bpf = GST_AUDIO_INFO_BPF (&adder->info);
1032 buffer = gst_audio_buffer_clip (buffer, &data->segment, rate, bpf);
1037 static GstFlowReturn
1038 gst_adder_collected (GstCollectPads * pads, gpointer user_data)
1041 * combine streams by adding data values
1043 * - this function is called when all pads have a buffer
1044 * - get available bytes on all pads.
1045 * - repeat for each input pad :
1046 * - read available bytes, copy or add to target buffer
1047 * - if there's an EOS event, remove the input channel
1048 * - push out the output buffer
1051 * - would be nice to have a mixing mode, where instead of adding we mix
1052 * - for float we could downscale after collect loop
1053 * - for int we need to downscale each input to avoid clipping or
1054 * mix into a temp (float) buffer and scale afterwards as well
1057 GSList *collected, *next = NULL;
1059 GstBuffer *outbuf = NULL, *gapbuf = NULL;
1060 gpointer outdata = NULL;
1063 gint64 next_timestamp;
1064 gint rate, bps, bpf;
1066 adder = GST_ADDER (user_data);
1069 if (G_UNLIKELY (adder->func == NULL))
1070 goto not_negotiated;
1072 if (g_atomic_int_compare_and_exchange (&adder->flush_stop_pending,
1074 GST_DEBUG_OBJECT (adder, "pending flush stop");
1075 gst_pad_push_event (adder->srcpad, gst_event_new_flush_stop (TRUE));
1078 /* get available bytes for reading, this can be 0 which could mean empty
1079 * buffers or EOS, which we will catch when we loop over the pads. */
1080 outsize = gst_collect_pads_available (pads);
1081 /* can only happen when no pads to collect or all EOS */
1085 rate = GST_AUDIO_INFO_RATE (&adder->info);
1086 bps = GST_AUDIO_INFO_BPS (&adder->info);
1087 bpf = GST_AUDIO_INFO_BPF (&adder->info);
1089 GST_LOG_OBJECT (adder,
1090 "starting to cycle through channels, %d bytes available (bps = %d)",
1093 for (collected = pads->data; collected; collected = next) {
1094 GstCollectData *collect_data;
1098 /* take next to see if this is the last collectdata */
1099 next = g_slist_next (collected);
1101 collect_data = (GstCollectData *) collected->data;
1103 /* get a buffer of size bytes, if we get a buffer, it is at least outsize
1105 inbuf = gst_collect_pads_take_buffer (pads, collect_data, outsize);
1106 /* NULL means EOS or an empty buffer so we still need to flush in
1107 * case of an empty buffer. */
1108 if (inbuf == NULL) {
1109 GST_LOG_OBJECT (adder, "channel %p: no bytes available", collect_data);
1113 is_gap = GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP);
1115 /* Try to make an output buffer */
1116 if (outbuf == NULL) {
1117 /* if this is a gap buffer but we have some more pads to check, skip it.
1118 * If we are at the last buffer, take it, regardless if it is a GAP
1120 if (is_gap && next) {
1121 GST_DEBUG_OBJECT (adder, "skipping, non-last GAP buffer");
1122 /* we keep the GAP buffer, if we don't have anymore buffers (all pads
1123 * EOS, we can use this one as the output buffer. */
1127 gst_buffer_unref (inbuf);
1131 GST_LOG_OBJECT (adder, "channel %p: preparing output buffer of %d bytes",
1132 collect_data, outsize);
1134 outdata = gst_buffer_map (outbuf, NULL, NULL, GST_MAP_WRITE);
1137 /* we had a previous output buffer, mix this non-GAP buffer */
1141 indata = gst_buffer_map (inbuf, &insize, NULL, GST_MAP_READ);
1143 /* all buffers should have outsize, there are no short buffers because we
1144 * asked for the max size above */
1145 g_assert (insize == outsize);
1147 GST_LOG_OBJECT (adder, "channel %p: mixing %" G_GSIZE_FORMAT " bytes"
1148 " from data %p", collect_data, insize, indata);
1150 /* further buffers, need to add them */
1151 adder->func ((gpointer) outdata, (gpointer) indata, insize / bps);
1152 gst_buffer_unmap (inbuf, indata, insize);
1154 /* skip gap buffer */
1155 GST_LOG_OBJECT (adder, "channel %p: skipping GAP buffer", collect_data);
1157 gst_buffer_unref (inbuf);
1161 gst_buffer_unmap (outbuf, outdata, outsize);
1163 if (outbuf == NULL) {
1164 /* no output buffer, reuse one of the GAP buffers then if we have one */
1166 GST_LOG_OBJECT (adder, "reusing GAP buffer %p", gapbuf);
1169 /* assume EOS otherwise, this should not happen, really */
1172 /* we had an output buffer, unref the gapbuffer we kept */
1173 gst_buffer_unref (gapbuf);
1175 if (g_atomic_int_compare_and_exchange (&adder->new_segment_pending, TRUE,
1179 /* FIXME, use rate/applied_rate as set on all sinkpads.
1180 * - currently we just set rate as received from last seek-event
1182 * When seeking we set the start and stop positions as given in the seek
1183 * event. We also adjust offset & timestamp acordingly.
1184 * This basically ignores all newsegments sent by upstream.
1186 event = gst_event_new_segment (&adder->segment);
1188 if (adder->segment.rate > 0.0) {
1189 adder->segment.position = adder->segment.start;
1191 adder->segment.position = adder->segment.stop;
1193 adder->offset = gst_util_uint64_scale (adder->segment.position,
1195 GST_INFO_OBJECT (adder, "seg_start %" G_GUINT64_FORMAT ", seg_end %"
1196 G_GUINT64_FORMAT, adder->segment.start, adder->segment.stop);
1197 GST_INFO_OBJECT (adder, "timestamp %" G_GINT64_FORMAT ",new offset %"
1198 G_GINT64_FORMAT, adder->segment.position, adder->offset);
1201 if (!gst_pad_push_event (adder->srcpad, event)) {
1202 GST_WARNING_OBJECT (adder->srcpad, "Sending event failed");
1205 GST_WARNING_OBJECT (adder->srcpad, "Creating new segment event for "
1206 "start:%" G_GINT64_FORMAT " end:%" G_GINT64_FORMAT " failed",
1207 adder->segment.start, adder->segment.stop);
1211 if (G_UNLIKELY (adder->pending_events)) {
1212 GList *tmp = adder->pending_events;
1215 GstEvent *ev = (GstEvent *) tmp->data;
1217 gst_pad_push_event (adder->srcpad, ev);
1218 tmp = g_list_next (tmp);
1220 g_list_free (adder->pending_events);
1221 adder->pending_events = NULL;
1224 /* for the next timestamp, use the sample counter, which will
1225 * never accumulate rounding errors */
1226 if (adder->segment.rate > 0.0) {
1227 next_offset = adder->offset + outsize / bpf;
1229 next_offset = adder->offset - outsize / bpf;
1231 next_timestamp = gst_util_uint64_scale (next_offset, GST_SECOND, rate);
1234 /* set timestamps on the output buffer */
1235 if (adder->segment.rate > 0.0) {
1236 GST_BUFFER_TIMESTAMP (outbuf) = adder->segment.position;
1237 GST_BUFFER_OFFSET (outbuf) = adder->offset;
1238 GST_BUFFER_OFFSET_END (outbuf) = next_offset;
1239 GST_BUFFER_DURATION (outbuf) = next_timestamp - adder->segment.position;
1241 GST_BUFFER_TIMESTAMP (outbuf) = next_timestamp;
1242 GST_BUFFER_OFFSET (outbuf) = next_offset;
1243 GST_BUFFER_OFFSET_END (outbuf) = adder->offset;
1244 GST_BUFFER_DURATION (outbuf) = adder->segment.position - next_timestamp;
1247 adder->offset = next_offset;
1248 adder->segment.position = next_timestamp;
1251 GST_LOG_OBJECT (adder, "pushing outbuf %p, timestamp %" GST_TIME_FORMAT
1252 " offset %" G_GINT64_FORMAT, outbuf,
1253 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (outbuf)),
1254 GST_BUFFER_OFFSET (outbuf));
1255 ret = gst_pad_push (adder->srcpad, outbuf);
1257 GST_LOG_OBJECT (adder, "pushed outbuf, result = %s", gst_flow_get_name (ret));
1264 GST_ELEMENT_ERROR (adder, STREAM, FORMAT, (NULL),
1265 ("Unknown data received, not negotiated"));
1266 return GST_FLOW_NOT_NEGOTIATED;
1270 GST_DEBUG_OBJECT (adder, "no data available, must be EOS");
1271 gst_pad_push_event (adder->srcpad, gst_event_new_eos ());
1272 return GST_FLOW_EOS;
1276 static GstStateChangeReturn
1277 gst_adder_change_state (GstElement * element, GstStateChange transition)
1280 GstStateChangeReturn ret;
1282 adder = GST_ADDER (element);
1284 switch (transition) {
1285 case GST_STATE_CHANGE_NULL_TO_READY:
1287 case GST_STATE_CHANGE_READY_TO_PAUSED:
1288 adder->segment.position = 0;
1290 adder->flush_stop_pending = FALSE;
1291 adder->new_segment_pending = TRUE;
1292 adder->wait_for_new_segment = FALSE;
1293 gst_segment_init (&adder->segment, GST_FORMAT_TIME);
1294 gst_collect_pads_start (adder->collect);
1296 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1298 case GST_STATE_CHANGE_PAUSED_TO_READY:
1299 /* need to unblock the collectpads before calling the
1300 * parent change_state so that streaming can finish */
1301 gst_collect_pads_stop (adder->collect);
1307 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1309 switch (transition) {
1319 plugin_init (GstPlugin * plugin)
1321 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "adder", 0,
1322 "audio channel mixing element");
1324 gst_adder_orc_init ();
1326 if (!gst_element_register (plugin, "adder", GST_RANK_NONE, GST_TYPE_ADDER)) {
1333 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1336 "Adds multiple streams",
1337 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)