3 * Copyright (C) 2009 Sebastian Dröge <sebastian.droege@collabora.co.uk>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * SECTION:element-audioecho
25 * audioecho adds an echo or (simple) reverb effect to an audio stream. The echo
26 * delay, intensity and the percentage of feedback can be configured.
28 * For getting an echo effect you have to set the delay to a larger value,
29 * for example 200ms and more. Everything below will result in a simple
30 * reverb effect, which results in a slightly metallic sound.
32 * Use the max-delay property to set the maximum amount of delay that
33 * will be used. This can only be set before going to the PAUSED or PLAYING
34 * state and will be set to the current delay by default.
37 * <title>Example launch line</title>
39 * gst-launch filesrc location="melo1.ogg" ! audioconvert ! audioecho delay=500000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink
40 * gst-launch filesrc location="melo1.ogg" ! decodebin ! audioconvert ! audioecho delay=50000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink
50 #include <gst/base/gstbasetransform.h>
51 #include <gst/audio/audio.h>
52 #include <gst/audio/gstaudiofilter.h>
54 #include "audioecho.h"
56 #define GST_CAT_DEFAULT gst_audio_echo_debug
57 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
68 #define ALLOWED_CAPS \
70 " format=(string) {"GST_AUDIO_NE(F32)","GST_AUDIO_NE(F64)"}, " \
71 " rate=(int)[1,MAX]," \
72 " channels=(int)[1,MAX]"
74 #define gst_audio_echo_parent_class parent_class
75 G_DEFINE_TYPE (GstAudioEcho, gst_audio_echo, GST_TYPE_AUDIO_FILTER);
77 static void gst_audio_echo_set_property (GObject * object, guint prop_id,
78 const GValue * value, GParamSpec * pspec);
79 static void gst_audio_echo_get_property (GObject * object, guint prop_id,
80 GValue * value, GParamSpec * pspec);
81 static void gst_audio_echo_finalize (GObject * object);
83 static gboolean gst_audio_echo_setup (GstAudioFilter * self,
84 const GstAudioInfo * info);
85 static gboolean gst_audio_echo_stop (GstBaseTransform * base);
86 static GstFlowReturn gst_audio_echo_transform_ip (GstBaseTransform * base,
89 static void gst_audio_echo_transform_float (GstAudioEcho * self,
90 gfloat * data, guint num_samples);
91 static void gst_audio_echo_transform_double (GstAudioEcho * self,
92 gdouble * data, guint num_samples);
94 /* GObject vmethod implementations */
97 gst_audio_echo_class_init (GstAudioEchoClass * klass)
99 GObjectClass *gobject_class = (GObjectClass *) klass;
100 GstElementClass *gstelement_class = (GstElementClass *) klass;
101 GstBaseTransformClass *basetransform_class = (GstBaseTransformClass *) klass;
102 GstAudioFilterClass *audioself_class = (GstAudioFilterClass *) klass;
105 GST_DEBUG_CATEGORY_INIT (gst_audio_echo_debug, "audioecho", 0,
106 "audioecho element");
108 gobject_class->set_property = gst_audio_echo_set_property;
109 gobject_class->get_property = gst_audio_echo_get_property;
110 gobject_class->finalize = gst_audio_echo_finalize;
112 g_object_class_install_property (gobject_class, PROP_DELAY,
113 g_param_spec_uint64 ("delay", "Delay",
114 "Delay of the echo in nanoseconds", 1, G_MAXUINT64,
115 1, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS
116 | GST_PARAM_CONTROLLABLE));
118 g_object_class_install_property (gobject_class, PROP_MAX_DELAY,
119 g_param_spec_uint64 ("max-delay", "Maximum Delay",
120 "Maximum delay of the echo in nanoseconds"
121 " (can't be changed in PLAYING or PAUSED state)",
123 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
124 GST_PARAM_MUTABLE_READY));
126 g_object_class_install_property (gobject_class, PROP_INTENSITY,
127 g_param_spec_float ("intensity", "Intensity",
128 "Intensity of the echo", 0.0, 1.0,
129 0.0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS
130 | GST_PARAM_CONTROLLABLE));
132 g_object_class_install_property (gobject_class, PROP_FEEDBACK,
133 g_param_spec_float ("feedback", "Feedback",
134 "Amount of feedback", 0.0, 1.0,
135 0.0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS
136 | GST_PARAM_CONTROLLABLE));
138 gst_element_class_set_details_simple (gstelement_class, "Audio echo",
139 "Filter/Effect/Audio",
140 "Adds an echo or reverb effect to an audio stream",
141 "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
143 caps = gst_caps_from_string (ALLOWED_CAPS);
144 gst_audio_filter_class_add_pad_templates (GST_AUDIO_FILTER_CLASS (klass),
146 gst_caps_unref (caps);
148 audioself_class->setup = GST_DEBUG_FUNCPTR (gst_audio_echo_setup);
149 basetransform_class->transform_ip =
150 GST_DEBUG_FUNCPTR (gst_audio_echo_transform_ip);
151 basetransform_class->stop = GST_DEBUG_FUNCPTR (gst_audio_echo_stop);
155 gst_audio_echo_init (GstAudioEcho * self)
159 self->intensity = 0.0;
160 self->feedback = 0.0;
162 gst_base_transform_set_in_place (GST_BASE_TRANSFORM (self), TRUE);
166 gst_audio_echo_finalize (GObject * object)
168 GstAudioEcho *self = GST_AUDIO_ECHO (object);
170 g_free (self->buffer);
173 G_OBJECT_CLASS (parent_class)->finalize (object);
177 gst_audio_echo_set_property (GObject * object, guint prop_id,
178 const GValue * value, GParamSpec * pspec)
180 GstAudioEcho *self = GST_AUDIO_ECHO (object);
184 guint64 max_delay, delay;
186 GST_BASE_TRANSFORM_LOCK (self);
187 delay = g_value_get_uint64 (value);
188 max_delay = self->max_delay;
190 if (delay > max_delay && GST_STATE (self) > GST_STATE_READY) {
191 GST_WARNING_OBJECT (self, "New delay (%" GST_TIME_FORMAT ") "
192 "is larger than maximum delay (%" GST_TIME_FORMAT ")",
193 GST_TIME_ARGS (delay), GST_TIME_ARGS (max_delay));
194 self->delay = max_delay;
197 self->max_delay = MAX (delay, max_delay);
199 GST_BASE_TRANSFORM_UNLOCK (self);
202 case PROP_MAX_DELAY:{
203 guint64 max_delay, delay;
205 GST_BASE_TRANSFORM_LOCK (self);
206 max_delay = g_value_get_uint64 (value);
209 if (GST_STATE (self) > GST_STATE_READY) {
210 GST_ERROR_OBJECT (self, "Can't change maximum delay in"
211 " PLAYING or PAUSED state");
214 self->max_delay = max_delay;
216 GST_BASE_TRANSFORM_UNLOCK (self);
219 case PROP_INTENSITY:{
220 GST_BASE_TRANSFORM_LOCK (self);
221 self->intensity = g_value_get_float (value);
222 GST_BASE_TRANSFORM_UNLOCK (self);
226 GST_BASE_TRANSFORM_LOCK (self);
227 self->feedback = g_value_get_float (value);
228 GST_BASE_TRANSFORM_UNLOCK (self);
232 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
238 gst_audio_echo_get_property (GObject * object, guint prop_id,
239 GValue * value, GParamSpec * pspec)
241 GstAudioEcho *self = GST_AUDIO_ECHO (object);
245 GST_BASE_TRANSFORM_LOCK (self);
246 g_value_set_uint64 (value, self->delay);
247 GST_BASE_TRANSFORM_UNLOCK (self);
250 GST_BASE_TRANSFORM_LOCK (self);
251 g_value_set_uint64 (value, self->max_delay);
252 GST_BASE_TRANSFORM_UNLOCK (self);
255 GST_BASE_TRANSFORM_LOCK (self);
256 g_value_set_float (value, self->intensity);
257 GST_BASE_TRANSFORM_UNLOCK (self);
260 GST_BASE_TRANSFORM_LOCK (self);
261 g_value_set_float (value, self->feedback);
262 GST_BASE_TRANSFORM_UNLOCK (self);
265 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
270 /* GstAudioFilter vmethod implementations */
273 gst_audio_echo_setup (GstAudioFilter * base, const GstAudioInfo * info)
275 GstAudioEcho *self = GST_AUDIO_ECHO (base);
278 switch (GST_AUDIO_INFO_FORMAT (info)) {
279 case GST_AUDIO_FORMAT_F32:
280 self->process = (GstAudioEchoProcessFunc)
281 gst_audio_echo_transform_float;
283 case GST_AUDIO_FORMAT_F64:
284 self->process = (GstAudioEchoProcessFunc)
285 gst_audio_echo_transform_double;
292 g_free (self->buffer);
294 self->buffer_pos = 0;
295 self->buffer_size = 0;
296 self->buffer_size_frames = 0;
302 gst_audio_echo_stop (GstBaseTransform * base)
304 GstAudioEcho *self = GST_AUDIO_ECHO (base);
306 g_free (self->buffer);
308 self->buffer_pos = 0;
309 self->buffer_size = 0;
310 self->buffer_size_frames = 0;
315 #define TRANSFORM_FUNC(name, type) \
317 gst_audio_echo_transform_##name (GstAudioEcho * self, \
318 type * data, guint num_samples) \
320 type *buffer = (type *) self->buffer; \
321 guint channels = GST_AUDIO_FILTER_CHANNELS (self); \
322 guint rate = GST_AUDIO_FILTER_RATE (self); \
324 guint echo_index = self->buffer_size_frames - self->delay_frames; \
325 gdouble echo_off = ((((gdouble) self->delay) * rate) / GST_SECOND) - self->delay_frames; \
327 if (echo_off < 0.0) \
330 num_samples /= channels; \
332 for (i = 0; i < num_samples; i++) { \
333 guint echo0_index = ((echo_index + self->buffer_pos) % self->buffer_size_frames) * channels; \
334 guint echo1_index = ((echo_index + self->buffer_pos +1) % self->buffer_size_frames) * channels; \
335 guint rbout_index = (self->buffer_pos % self->buffer_size_frames) * channels; \
336 for (j = 0; j < channels; j++) { \
337 gdouble in = data[i*channels + j]; \
338 gdouble echo0 = buffer[echo0_index + j]; \
339 gdouble echo1 = buffer[echo1_index + j]; \
340 gdouble echo = echo0 + (echo1-echo0)*echo_off; \
341 type out = in + self->intensity * echo; \
343 data[i*channels + j] = out; \
345 buffer[rbout_index + j] = in + self->feedback * echo; \
347 self->buffer_pos = (self->buffer_pos + 1) % self->buffer_size_frames; \
351 TRANSFORM_FUNC (float, gfloat);
352 TRANSFORM_FUNC (double, gdouble);
354 /* GstBaseTransform vmethod implementations */
356 gst_audio_echo_transform_ip (GstBaseTransform * base, GstBuffer * buf)
358 GstAudioEcho *self = GST_AUDIO_ECHO (base);
360 GstClockTime timestamp, stream_time;
364 timestamp = GST_BUFFER_TIMESTAMP (buf);
366 gst_segment_to_stream_time (&base->segment, GST_FORMAT_TIME, timestamp);
368 GST_DEBUG_OBJECT (self, "sync to %" GST_TIME_FORMAT,
369 GST_TIME_ARGS (timestamp));
371 if (GST_CLOCK_TIME_IS_VALID (stream_time))
372 gst_object_sync_values (GST_OBJECT (self), stream_time);
374 if (self->buffer == NULL) {
377 bpf = GST_AUDIO_FILTER_BPF (self);
378 rate = GST_AUDIO_FILTER_RATE (self);
381 MAX (gst_util_uint64_scale (self->delay, rate, GST_SECOND), 1);
382 self->buffer_size_frames =
383 MAX (gst_util_uint64_scale (self->max_delay, rate, GST_SECOND), 1);
385 self->buffer_size = self->buffer_size_frames * bpf;
386 self->buffer = g_try_malloc0 (self->buffer_size);
387 self->buffer_pos = 0;
389 if (self->buffer == NULL) {
390 GST_ERROR_OBJECT (self, "Failed to allocate %u bytes", self->buffer_size);
391 return GST_FLOW_ERROR;
395 data = gst_buffer_map (buf, &size, NULL, GST_MAP_READWRITE);
396 num_samples = size / GST_AUDIO_FILTER_BPS (self);
398 self->process (self, data, num_samples);
400 gst_buffer_unmap (buf, data, size);