1 /*
2 * GStreamer
3 * Copyright (C) 2011 Stefan Sauer <ensonic@users.sf.net>
4 *
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.
9 *
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.
14 *
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., 51 Franklin St, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
19 */
20 /*
21 * Freeverb
22 *
23 * Written by Jezar at Dreampoint, June 2000
24 * http://www.dreampoint.co.uk
25 * This code is public domain
26 *
27 * Translated to C by Peter Hanappe, Mai 2001
28 * Transformed into a GStreamer plugin by Stefan Sauer, Nov 2011
29 */
30
31 /**
32 * SECTION:element-freeverb
33 * @title: freeverb
34 *
35 * Reverberation/room effect.
36 *
37 * ## Example launch line
38 * |[
39 * gst-launch-1.0 audiotestsrc wave=saw ! freeverb ! autoaudiosink
40 * gst-launch-1.0 filesrc location="melo1.ogg" ! decodebin ! audioconvert ! freeverb ! autoaudiosink
41 * ]|
42 *
43 */
44
45 /* FIXME:
46 * - add mono-to-mono, then we might also need stereo-to-mono ?
47 */
48
49 #ifdef HAVE_CONFIG_H
50 #include "config.h"
51 #endif
52
53 #include <math.h>
54 #include <stdlib.h>
55 #include <string.h>
56
57 #include <gst/gst.h>
58 #include <gst/base/gstbasetransform.h>
59
60 #include "gstfreeverb.h"
61
62 #define GST_CAT_DEFAULT gst_freeverb_debug
63 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
64
65 enum
66 {
67 PROP_0,
68 PROP_ROOM_SIZE,
69 PROP_DAMPING,
70 PROP_PAN_WIDTH,
71 PROP_LEVEL
72 };
73
74 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
75 GST_PAD_SINK,
76 GST_PAD_ALWAYS,
77 GST_STATIC_CAPS ("audio/x-raw, "
78 "format = (string) { " GST_AUDIO_NE (F32) ", " GST_AUDIO_NE (S16) "}, "
79 "rate = (int) [ 1, MAX ], " "channels = (int) [ 1, 2 ], "
80 "layout = (string) interleaved")
81 );
82
83 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
84 GST_PAD_SRC,
85 GST_PAD_ALWAYS,
86 GST_STATIC_CAPS ("audio/x-raw, "
87 "format = (string) { " GST_AUDIO_NE (F32) ", " GST_AUDIO_NE (S16) "}, "
88 "rate = (int) [ 1, MAX ], " "channels = (int) 2, "
89 "layout = (string) interleaved")
90 );
91
92 static void gst_freeverb_set_property (GObject * object, guint prop_id,
93 const GValue * value, GParamSpec * pspec);
94 static void gst_freeverb_get_property (GObject * object, guint prop_id,
95 GValue * value, GParamSpec * pspec);
96
97 static void gst_freeverb_finalize (GObject * object);
98
99 static gboolean gst_freeverb_get_unit_size (GstBaseTransform * base,
100 GstCaps * caps, gsize * size);
101 static GstCaps *gst_freeverb_transform_caps (GstBaseTransform * base,
102 GstPadDirection direction, GstCaps * caps, GstCaps * filter);
103 static gboolean gst_freeverb_set_caps (GstBaseTransform * base,
104 GstCaps * incaps, GstCaps * outcaps);
105
106 static GstFlowReturn gst_freeverb_transform (GstBaseTransform * base,
107 GstBuffer * inbuf, GstBuffer * outbuf);
108
109 static gboolean gst_freeverb_transform_m2s_int (GstFreeverb * filter,
110 gint16 * idata, gint16 * odata, guint num_samples);
111 static gboolean gst_freeverb_transform_s2s_int (GstFreeverb * filter,
112 gint16 * idata, gint16 * odata, guint num_samples);
113 static gboolean gst_freeverb_transform_m2s_float (GstFreeverb * filter,
114 gfloat * idata, gfloat * odata, guint num_samples);
115 static gboolean gst_freeverb_transform_s2s_float (GstFreeverb * filter,
116 gfloat * idata, gfloat * odata, guint num_samples);
117
118
119 /* Table with processing functions: [channels][format] */
120 static const GstFreeverbProcessFunc process_functions[2][2] = {
121 {
122 (GstFreeverbProcessFunc) gst_freeverb_transform_m2s_int,
123 (GstFreeverbProcessFunc) gst_freeverb_transform_m2s_float,
124 },
125 {
126 (GstFreeverbProcessFunc) gst_freeverb_transform_s2s_int,
127 (GstFreeverbProcessFunc) gst_freeverb_transform_s2s_float,
128 }
129 };
130
131 /***************************************************************
132 *
133 * REVERB
134 */
135
136 /* Denormalising:
137 *
138 * Another method fixes the problem cheaper: Use a small DC-offset in
139 * the filter calculations. Now the signals converge not against 0,
140 * but against the offset. The constant offset is invisible from the
141 * outside world (i.e. it does not appear at the output. There is a
142 * very small turn-on transient response, which should not cause
143 * problems.
144 */
145
146 //#define DC_OFFSET 0
147 #define DC_OFFSET 1e-8
148 //#define DC_OFFSET 0.001f
149
150 /* all pass filter */
151
152 typedef struct _freeverb_allpass
153 {
154 gfloat feedback;
155 gfloat *buffer;
156 gint bufsize;
157 gint bufidx;
158 } freeverb_allpass;
159
160 static void
freeverb_allpass_setbuffer(freeverb_allpass * allpass,gint size)161 freeverb_allpass_setbuffer (freeverb_allpass * allpass, gint size)
162 {
163 allpass->bufidx = 0;
164 allpass->buffer = g_new (gfloat, size);
165 allpass->bufsize = size;
166 }
167
168 static void
freeverb_allpass_release(freeverb_allpass * allpass)169 freeverb_allpass_release (freeverb_allpass * allpass)
170 {
171 g_free (allpass->buffer);
172 }
173
174 static void
freeverb_allpass_init(freeverb_allpass * allpass)175 freeverb_allpass_init (freeverb_allpass * allpass)
176 {
177 gint i, len = allpass->bufsize;
178 gfloat *buf = allpass->buffer;
179
180 for (i = 0; i < len; i++) {
181 buf[i] = (gfloat) DC_OFFSET; /* this is not 100 % correct. */
182 }
183 }
184
185 static void
freeverb_allpass_setfeedback(freeverb_allpass * allpass,gfloat val)186 freeverb_allpass_setfeedback (freeverb_allpass * allpass, gfloat val)
187 {
188 allpass->feedback = val;
189 }
190
191 /*
192 static gfloat
193 freeverb_allpass_getfeedback(freeverb_allpass* allpass)
194 {
195 return allpass->feedback;
196 }*/
197
198 #define freeverb_allpass_process(_allpass, _input_1) \
199 { \
200 gfloat output; \
201 gfloat bufout; \
202 bufout = _allpass.buffer[_allpass.bufidx]; \
203 output = bufout-_input_1; \
204 _allpass.buffer[_allpass.bufidx] = _input_1 + (bufout * _allpass.feedback); \
205 if (++_allpass.bufidx >= _allpass.bufsize) { \
206 _allpass.bufidx = 0; \
207 } \
208 _input_1 = output; \
209 }
210
211 /* comb filter */
212
213 typedef struct _freeverb_comb
214 {
215 gfloat feedback;
216 gfloat filterstore;
217 gfloat damp1;
218 gfloat damp2;
219 gfloat *buffer;
220 gint bufsize;
221 gint bufidx;
222 } freeverb_comb;
223
224 static void
freeverb_comb_setbuffer(freeverb_comb * comb,gint size)225 freeverb_comb_setbuffer (freeverb_comb * comb, gint size)
226 {
227 comb->filterstore = 0;
228 comb->bufidx = 0;
229 comb->buffer = g_new (gfloat, size);
230 comb->bufsize = size;
231 }
232
233 static void
freeverb_comb_release(freeverb_comb * comb)234 freeverb_comb_release (freeverb_comb * comb)
235 {
236 g_free (comb->buffer);
237 }
238
239 static void
freeverb_comb_init(freeverb_comb * comb)240 freeverb_comb_init (freeverb_comb * comb)
241 {
242 gint i, len = comb->bufsize;
243 gfloat *buf = comb->buffer;
244
245 for (i = 0; i < len; i++) {
246 buf[i] = (gfloat) DC_OFFSET; /* This is not 100 % correct. */
247 }
248 }
249
250 static void
freeverb_comb_setdamp(freeverb_comb * comb,gfloat val)251 freeverb_comb_setdamp (freeverb_comb * comb, gfloat val)
252 {
253 comb->damp1 = val;
254 comb->damp2 = 1 - val;
255 }
256
257 /*
258 static gfloat
259 freeverb_comb_getdamp(freeverb_comb* comb)
260 {
261 return comb->damp1;
262 }*/
263
264 static void
freeverb_comb_setfeedback(freeverb_comb * comb,gfloat val)265 freeverb_comb_setfeedback (freeverb_comb * comb, gfloat val)
266 {
267 comb->feedback = val;
268 }
269
270 /*
271 static gfloat
272 freeverb_comb_getfeedback(freeverb_comb* comb)
273 {
274 return comb->feedback;
275 }*/
276
277 #define freeverb_comb_process(_comb, _input_1, _output) \
278 { \
279 gfloat _tmp = _comb.buffer[_comb.bufidx]; \
280 _comb.filterstore = (_tmp * _comb.damp2) + (_comb.filterstore * _comb.damp1); \
281 _comb.buffer[_comb.bufidx] = _input_1 + (_comb.filterstore * _comb.feedback); \
282 if (++_comb.bufidx >= _comb.bufsize) { \
283 _comb.bufidx = 0; \
284 } \
285 _output += _tmp; \
286 }
287
288 #define numcombs 8
289 #define numallpasses 4
290 #define fixedgain 0.015f
291 #define scalewet 1.0f
292 #define scaledry 1.0f
293 #define scaledamp 1.0f
294 #define scaleroom 0.28f
295 #define offsetroom 0.7f
296 #define stereospread 23
297
298 /* These values assume 44.1KHz sample rate
299 * they will need scaling for 96KHz (or other) sample rates.
300 * The values were obtained by listening tests.
301 */
302 #define combtuningL1 1116
303 #define combtuningR1 (1116 + stereospread)
304 #define combtuningL2 1188
305 #define combtuningR2 (1188 + stereospread)
306 #define combtuningL3 1277
307 #define combtuningR3 (1277 + stereospread)
308 #define combtuningL4 1356
309 #define combtuningR4 (1356 + stereospread)
310 #define combtuningL5 1422
311 #define combtuningR5 (1422 + stereospread)
312 #define combtuningL6 1491
313 #define combtuningR6 (1491 + stereospread)
314 #define combtuningL7 1557
315 #define combtuningR7 (1557 + stereospread)
316 #define combtuningL8 1617
317 #define combtuningR8 (1617 + stereospread)
318 #define allpasstuningL1 556
319 #define allpasstuningR1 (556 + stereospread)
320 #define allpasstuningL2 441
321 #define allpasstuningR2 (441 + stereospread)
322 #define allpasstuningL3 341
323 #define allpasstuningR3 (341 + stereospread)
324 #define allpasstuningL4 225
325 #define allpasstuningR4 (225 + stereospread)
326
327 struct _GstFreeverbPrivate
328 {
329 gfloat roomsize;
330 gfloat damp;
331 gfloat wet, wet1, wet2, dry;
332 gfloat width;
333 gfloat gain;
334 /*
335 The following are all declared inline
336 to remove the need for dynamic allocation
337 with its subsequent error-checking messiness
338 */
339 /* Comb filters */
340 freeverb_comb combL[numcombs];
341 freeverb_comb combR[numcombs];
342 /* Allpass filters */
343 freeverb_allpass allpassL[numallpasses];
344 freeverb_allpass allpassR[numallpasses];
345 };
346
347 G_DEFINE_TYPE_WITH_CODE (GstFreeverb, gst_freeverb, GST_TYPE_BASE_TRANSFORM,
348 G_ADD_PRIVATE (GstFreeverb)
349 G_IMPLEMENT_INTERFACE (GST_TYPE_PRESET, NULL));
350
351 static void
freeverb_revmodel_init(GstFreeverb * filter)352 freeverb_revmodel_init (GstFreeverb * filter)
353 {
354 GstFreeverbPrivate *priv = filter->priv;
355 gint i;
356
357 for (i = 0; i < numcombs; i++) {
358 freeverb_comb_init (&priv->combL[i]);
359 freeverb_comb_init (&priv->combR[i]);
360 }
361 for (i = 0; i < numallpasses; i++) {
362 freeverb_allpass_init (&priv->allpassL[i]);
363 freeverb_allpass_init (&priv->allpassR[i]);
364 }
365 }
366
367 static void
freeverb_revmodel_free(GstFreeverb * filter)368 freeverb_revmodel_free (GstFreeverb * filter)
369 {
370 GstFreeverbPrivate *priv = filter->priv;
371 gint i;
372
373 for (i = 0; i < numcombs; i++) {
374 freeverb_comb_release (&priv->combL[i]);
375 freeverb_comb_release (&priv->combR[i]);
376 }
377 for (i = 0; i < numallpasses; i++) {
378 freeverb_allpass_release (&priv->allpassL[i]);
379 freeverb_allpass_release (&priv->allpassR[i]);
380 }
381 }
382
383 /* GObject vmethod implementations */
384
385 static void
gst_freeverb_class_init(GstFreeverbClass * klass)386 gst_freeverb_class_init (GstFreeverbClass * klass)
387 {
388 GObjectClass *gobject_class;
389 GstElementClass *element_class;
390
391 GST_DEBUG_CATEGORY_INIT (gst_freeverb_debug, "freeverb", 0,
392 "freeverb element");
393
394 gobject_class = (GObjectClass *) klass;
395 element_class = (GstElementClass *) klass;
396
397 gobject_class->set_property = gst_freeverb_set_property;
398 gobject_class->get_property = gst_freeverb_get_property;
399 gobject_class->finalize = gst_freeverb_finalize;
400
401 g_object_class_install_property (gobject_class, PROP_ROOM_SIZE,
402 g_param_spec_float ("room-size", "Room size",
403 "Size of the simulated room", 0.0, 1.0, 0.5,
404 G_PARAM_CONSTRUCT | G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE |
405 G_PARAM_STATIC_STRINGS));
406 g_object_class_install_property (gobject_class, PROP_DAMPING,
407 g_param_spec_float ("damping", "Damping", "Damping of high frequencies",
408 0.0, 1.0, 0.2f,
409 G_PARAM_CONSTRUCT | G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE |
410 G_PARAM_STATIC_STRINGS));
411 g_object_class_install_property (gobject_class, PROP_PAN_WIDTH,
412 g_param_spec_float ("width", "Width", "Stereo panorama width", 0.0, 1.0,
413 1.0,
414 G_PARAM_CONSTRUCT | G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE |
415 G_PARAM_STATIC_STRINGS));
416 g_object_class_install_property (gobject_class, PROP_LEVEL,
417 g_param_spec_float ("level", "Level", "dry/wet level", 0.0, 1.0, 0.5,
418 G_PARAM_CONSTRUCT | G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE |
419 G_PARAM_STATIC_STRINGS));
420
421 gst_element_class_set_static_metadata (element_class,
422 "Reverberation/room effect", "Filter/Effect/Audio",
423 "Add reverberation to audio streams",
424 "Stefan Sauer <ensonic@users.sf.net>");
425
426 gst_element_class_add_static_pad_template (element_class, &src_template);
427 gst_element_class_add_static_pad_template (element_class, &sink_template);
428
429 GST_BASE_TRANSFORM_CLASS (klass)->get_unit_size =
430 GST_DEBUG_FUNCPTR (gst_freeverb_get_unit_size);
431 GST_BASE_TRANSFORM_CLASS (klass)->transform_caps =
432 GST_DEBUG_FUNCPTR (gst_freeverb_transform_caps);
433 GST_BASE_TRANSFORM_CLASS (klass)->set_caps =
434 GST_DEBUG_FUNCPTR (gst_freeverb_set_caps);
435 GST_BASE_TRANSFORM_CLASS (klass)->transform =
436 GST_DEBUG_FUNCPTR (gst_freeverb_transform);
437 }
438
439 static void
gst_freeverb_init(GstFreeverb * filter)440 gst_freeverb_init (GstFreeverb * filter)
441 {
442 filter->priv = gst_freeverb_get_instance_private (filter);
443
444 gst_audio_info_init (&filter->info);
445 filter->process = NULL;
446
447 gst_base_transform_set_gap_aware (GST_BASE_TRANSFORM (filter), TRUE);
448
449 freeverb_revmodel_init (filter);
450 }
451
452 static void
gst_freeverb_finalize(GObject * object)453 gst_freeverb_finalize (GObject * object)
454 {
455 GstFreeverb *filter = GST_FREEVERB (object);
456
457 freeverb_revmodel_free (filter);
458
459 G_OBJECT_CLASS (gst_freeverb_parent_class)->finalize (object);
460 }
461
462 static gboolean
gst_freeverb_set_process_function(GstFreeverb * filter,GstAudioInfo * info)463 gst_freeverb_set_process_function (GstFreeverb * filter, GstAudioInfo * info)
464 {
465 gint channel_index, format_index;
466 const GstAudioFormatInfo *finfo = info->finfo;
467
468 /* set processing function */
469 channel_index = GST_AUDIO_INFO_CHANNELS (info) - 1;
470 if (channel_index > 1 || channel_index < 0) {
471 filter->process = NULL;
472 return FALSE;
473 }
474
475 format_index = GST_AUDIO_FORMAT_INFO_IS_FLOAT (finfo) ? 1 : 0;
476
477 filter->process = process_functions[channel_index][format_index];
478 return TRUE;
479 }
480
481 static void
gst_freeverb_init_rev_model(GstFreeverb * filter)482 gst_freeverb_init_rev_model (GstFreeverb * filter)
483 {
484 gfloat srfactor = GST_AUDIO_INFO_RATE (&filter->info) / 44100.0f;
485 GstFreeverbPrivate *priv = filter->priv;
486
487 freeverb_revmodel_free (filter);
488
489 priv->gain = fixedgain;
490
491 freeverb_comb_setbuffer (&priv->combL[0], combtuningL1 * srfactor);
492 freeverb_comb_setbuffer (&priv->combR[0], combtuningR1 * srfactor);
493 freeverb_comb_setbuffer (&priv->combL[1], combtuningL2 * srfactor);
494 freeverb_comb_setbuffer (&priv->combR[1], combtuningR2 * srfactor);
495 freeverb_comb_setbuffer (&priv->combL[2], combtuningL3 * srfactor);
496 freeverb_comb_setbuffer (&priv->combR[2], combtuningR3 * srfactor);
497 freeverb_comb_setbuffer (&priv->combL[3], combtuningL4 * srfactor);
498 freeverb_comb_setbuffer (&priv->combR[3], combtuningR4 * srfactor);
499 freeverb_comb_setbuffer (&priv->combL[4], combtuningL5 * srfactor);
500 freeverb_comb_setbuffer (&priv->combR[4], combtuningR5 * srfactor);
501 freeverb_comb_setbuffer (&priv->combL[5], combtuningL6 * srfactor);
502 freeverb_comb_setbuffer (&priv->combR[5], combtuningR6 * srfactor);
503 freeverb_comb_setbuffer (&priv->combL[6], combtuningL7 * srfactor);
504 freeverb_comb_setbuffer (&priv->combR[6], combtuningR7 * srfactor);
505 freeverb_comb_setbuffer (&priv->combL[7], combtuningL8 * srfactor);
506 freeverb_comb_setbuffer (&priv->combR[7], combtuningR8 * srfactor);
507 freeverb_allpass_setbuffer (&priv->allpassL[0], allpasstuningL1 * srfactor);
508 freeverb_allpass_setbuffer (&priv->allpassR[0], allpasstuningR1 * srfactor);
509 freeverb_allpass_setbuffer (&priv->allpassL[1], allpasstuningL2 * srfactor);
510 freeverb_allpass_setbuffer (&priv->allpassR[1], allpasstuningR2 * srfactor);
511 freeverb_allpass_setbuffer (&priv->allpassL[2], allpasstuningL3 * srfactor);
512 freeverb_allpass_setbuffer (&priv->allpassR[2], allpasstuningR3 * srfactor);
513 freeverb_allpass_setbuffer (&priv->allpassL[3], allpasstuningL4 * srfactor);
514 freeverb_allpass_setbuffer (&priv->allpassR[3], allpasstuningR4 * srfactor);
515
516 /* clear buffers */
517 freeverb_revmodel_init (filter);
518
519 /* set default values */
520 freeverb_allpass_setfeedback (&priv->allpassL[0], 0.5f);
521 freeverb_allpass_setfeedback (&priv->allpassR[0], 0.5f);
522 freeverb_allpass_setfeedback (&priv->allpassL[1], 0.5f);
523 freeverb_allpass_setfeedback (&priv->allpassR[1], 0.5f);
524 freeverb_allpass_setfeedback (&priv->allpassL[2], 0.5f);
525 freeverb_allpass_setfeedback (&priv->allpassR[2], 0.5f);
526 freeverb_allpass_setfeedback (&priv->allpassL[3], 0.5f);
527 freeverb_allpass_setfeedback (&priv->allpassR[3], 0.5f);
528 }
529
530 static void
gst_freeverb_set_property(GObject * object,guint prop_id,const GValue * value,GParamSpec * pspec)531 gst_freeverb_set_property (GObject * object, guint prop_id,
532 const GValue * value, GParamSpec * pspec)
533 {
534 GstFreeverb *filter = GST_FREEVERB (object);
535 GstFreeverbPrivate *priv = filter->priv;
536 gint i;
537
538 switch (prop_id) {
539 case PROP_ROOM_SIZE:
540 filter->room_size = g_value_get_float (value);
541 priv->roomsize = (filter->room_size * scaleroom) + offsetroom;
542 for (i = 0; i < numcombs; i++) {
543 freeverb_comb_setfeedback (&priv->combL[i], priv->roomsize);
544 freeverb_comb_setfeedback (&priv->combR[i], priv->roomsize);
545 }
546 break;
547 case PROP_DAMPING:
548 filter->damping = g_value_get_float (value);
549 priv->damp = filter->damping * scaledamp;
550 for (i = 0; i < numcombs; i++) {
551 freeverb_comb_setdamp (&priv->combL[i], priv->damp);
552 freeverb_comb_setdamp (&priv->combR[i], priv->damp);
553 }
554 break;
555 case PROP_PAN_WIDTH:
556 filter->pan_width = g_value_get_float (value);
557 priv->width = filter->pan_width;
558 priv->wet1 = priv->wet * (priv->width / 2.0f + 0.5f);
559 priv->wet2 = priv->wet * ((1.0f - priv->width) / 2.0f);
560 break;
561 case PROP_LEVEL:
562 filter->level = g_value_get_float (value);
563 priv->wet = filter->level * scalewet;
564 priv->dry = (1.0 - filter->level) * scaledry;
565 priv->wet1 = priv->wet * (priv->width / 2.0f + 0.5f);
566 priv->wet2 = priv->wet * ((1.0f - priv->width) / 2.0f);
567 break;
568 default:
569 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
570 break;
571 }
572 }
573
574 static void
gst_freeverb_get_property(GObject * object,guint prop_id,GValue * value,GParamSpec * pspec)575 gst_freeverb_get_property (GObject * object, guint prop_id,
576 GValue * value, GParamSpec * pspec)
577 {
578 GstFreeverb *filter = GST_FREEVERB (object);
579
580 switch (prop_id) {
581 case PROP_ROOM_SIZE:
582 g_value_set_float (value, filter->room_size);
583 break;
584 case PROP_DAMPING:
585 g_value_set_float (value, filter->damping);
586 break;
587 case PROP_PAN_WIDTH:
588 g_value_set_float (value, filter->pan_width);
589 break;
590 case PROP_LEVEL:
591 g_value_set_float (value, filter->level);
592 break;
593 default:
594 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
595 break;
596 }
597 }
598
599 /* GstBaseTransform vmethod implementations */
600
601 static gboolean
gst_freeverb_get_unit_size(GstBaseTransform * base,GstCaps * caps,gsize * size)602 gst_freeverb_get_unit_size (GstBaseTransform * base, GstCaps * caps,
603 gsize * size)
604 {
605 GstAudioInfo info;
606
607 g_assert (size);
608
609 if (!gst_audio_info_from_caps (&info, caps))
610 return FALSE;
611
612 *size = GST_AUDIO_INFO_BPF (&info);
613
614 GST_INFO_OBJECT (base, "unit size: %" G_GSIZE_FORMAT, *size);
615
616 return TRUE;
617 }
618
619 static GstCaps *
gst_freeverb_transform_caps(GstBaseTransform * base,GstPadDirection direction,GstCaps * caps,GstCaps * filter)620 gst_freeverb_transform_caps (GstBaseTransform * base,
621 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
622 {
623 GstCaps *res;
624 GstStructure *structure;
625 gint i;
626
627 /* replace the channel property with our range. */
628 res = gst_caps_copy (caps);
629 for (i = 0; i < gst_caps_get_size (res); i++) {
630 structure = gst_caps_get_structure (res, i);
631 if (direction == GST_PAD_SRC) {
632 GST_INFO_OBJECT (base, "[%d] allow 1-2 channels", i);
633 gst_structure_set (structure, "channels", GST_TYPE_INT_RANGE, 1, 2, NULL);
634 } else {
635 GST_INFO_OBJECT (base, "[%d] allow 2 channels", i);
636 gst_structure_set (structure, "channels", G_TYPE_INT, 2, NULL);
637 }
638 gst_structure_remove_field (structure, "channel-mask");
639 }
640 GST_DEBUG_OBJECT (base, "transformed %" GST_PTR_FORMAT, res);
641
642 if (filter) {
643 GstCaps *intersection;
644
645 GST_DEBUG_OBJECT (base, "Using filter caps %" GST_PTR_FORMAT, filter);
646 intersection =
647 gst_caps_intersect_full (filter, res, GST_CAPS_INTERSECT_FIRST);
648 gst_caps_unref (res);
649 res = intersection;
650 GST_DEBUG_OBJECT (base, "Intersection %" GST_PTR_FORMAT, res);
651 }
652
653 return res;
654 }
655
656 static gboolean
gst_freeverb_set_caps(GstBaseTransform * base,GstCaps * incaps,GstCaps * outcaps)657 gst_freeverb_set_caps (GstBaseTransform * base, GstCaps * incaps,
658 GstCaps * outcaps)
659 {
660 GstFreeverb *filter = GST_FREEVERB (base);
661 GstAudioInfo info;
662
663 /*GST_INFO ("incaps are %" GST_PTR_FORMAT, incaps); */
664 if (!gst_audio_info_from_caps (&info, incaps))
665 goto no_format;
666
667 GST_DEBUG ("try to process %d input with %d channels",
668 GST_AUDIO_INFO_FORMAT (&info), GST_AUDIO_INFO_CHANNELS (&info));
669
670 if (!gst_freeverb_set_process_function (filter, &info))
671 goto no_format;
672
673 filter->info = info;
674
675 gst_freeverb_init_rev_model (filter);
676 filter->drained = FALSE;
677 GST_INFO_OBJECT (base, "model configured");
678
679 return TRUE;
680
681 no_format:
682 {
683 GST_DEBUG ("invalid caps");
684 return FALSE;
685 }
686 }
687
688 static gboolean
gst_freeverb_transform_m2s_int(GstFreeverb * filter,gint16 * idata,gint16 * odata,guint num_samples)689 gst_freeverb_transform_m2s_int (GstFreeverb * filter,
690 gint16 * idata, gint16 * odata, guint num_samples)
691 {
692 GstFreeverbPrivate *priv = filter->priv;
693 gint i, k;
694 gfloat out_l1, out_r1, input_1;
695 gfloat out_l2, out_r2, input_2;
696 gboolean drained = TRUE;
697
698 for (k = 0; k < num_samples; k++) {
699 out_l1 = out_r1 = 0.0;
700
701 /* The original Freeverb code expects a stereo signal and 'input_1'
702 * is set to the sum of the left and right input_1 sample. Since
703 * this code works on a mono signal, 'input_1' is set to twice the
704 * input_1 sample. */
705 input_2 = (gfloat) * idata++;
706 input_1 = (2.0f * input_2 + DC_OFFSET) * priv->gain;
707
708 /* Accumulate comb filters in parallel */
709 for (i = 0; i < numcombs; i++) {
710 freeverb_comb_process (priv->combL[i], input_1, out_l1);
711 freeverb_comb_process (priv->combR[i], input_1, out_r1);
712 }
713 /* Feed through allpasses in series */
714 for (i = 0; i < numallpasses; i++) {
715 freeverb_allpass_process (priv->allpassL[i], out_l1);
716 freeverb_allpass_process (priv->allpassR[i], out_r1);
717 }
718
719 /* Remove the DC offset */
720 out_l1 -= (gfloat) DC_OFFSET;
721 out_r1 -= (gfloat) DC_OFFSET;
722
723 /* Calculate output */
724 out_l2 = out_l1 * priv->wet1 + out_r1 * priv->wet2 + input_2 * priv->dry;
725 out_r2 = out_r1 * priv->wet1 + out_l1 * priv->wet2 + input_2 * priv->dry;
726 out_l2 = CLAMP (out_l2, G_MININT16, G_MAXINT16);
727 out_r2 = CLAMP (out_r2, G_MININT16, G_MAXINT16);
728 *odata++ = (gint16) out_l2;
729 *odata++ = (gint16) out_r2;
730
731 if (abs ((gint16) out_l2) > 0 || abs ((gint16) out_r2) > 0)
732 drained = FALSE;
733 }
734 return drained;
735 }
736
737 static gboolean
gst_freeverb_transform_s2s_int(GstFreeverb * filter,gint16 * idata,gint16 * odata,guint num_samples)738 gst_freeverb_transform_s2s_int (GstFreeverb * filter,
739 gint16 * idata, gint16 * odata, guint num_samples)
740 {
741 GstFreeverbPrivate *priv = filter->priv;
742 gint i, k;
743 gfloat out_l1, out_r1, input_1l, input_1r;
744 gfloat out_l2, out_r2, input_2l, input_2r;
745 gboolean drained = TRUE;
746
747 for (k = 0; k < num_samples; k++) {
748 out_l1 = out_r1 = 0.0;
749
750 input_2l = (gfloat) * idata++;
751 input_2r = (gfloat) * idata++;
752 input_1l = (input_2l + DC_OFFSET) * priv->gain;
753 input_1r = (input_2r + DC_OFFSET) * priv->gain;
754
755 /* Accumulate comb filters in parallel */
756 for (i = 0; i < numcombs; i++) {
757 freeverb_comb_process (priv->combL[i], input_1l, out_l1);
758 freeverb_comb_process (priv->combR[i], input_1r, out_r1);
759 }
760 /* Feed through allpasses in series */
761 for (i = 0; i < numallpasses; i++) {
762 freeverb_allpass_process (priv->allpassL[i], out_l1);
763 freeverb_allpass_process (priv->allpassR[i], out_r1);
764 }
765
766 /* Remove the DC offset */
767 out_l1 -= (gfloat) DC_OFFSET;
768 out_r1 -= (gfloat) DC_OFFSET;
769
770 /* Calculate output */
771 out_l2 = out_l1 * priv->wet1 + out_r1 * priv->wet2 + input_2l * priv->dry;
772 out_r2 = out_r1 * priv->wet1 + out_l1 * priv->wet2 + input_2r * priv->dry;
773 out_l2 = CLAMP (out_l2, G_MININT16, G_MAXINT16);
774 out_r2 = CLAMP (out_r2, G_MININT16, G_MAXINT16);
775 *odata++ = (gint16) out_l2;
776 *odata++ = (gint16) out_r2;
777
778 if (abs ((gint16) out_l2) > 0 || abs ((gint16) out_r2) > 0)
779 drained = FALSE;
780 }
781 return drained;
782 }
783
784 static gboolean
gst_freeverb_transform_m2s_float(GstFreeverb * filter,gfloat * idata,gfloat * odata,guint num_samples)785 gst_freeverb_transform_m2s_float (GstFreeverb * filter,
786 gfloat * idata, gfloat * odata, guint num_samples)
787 {
788 GstFreeverbPrivate *priv = filter->priv;
789 gint i, k;
790 gfloat out_l1, out_r1, input_1;
791 gfloat out_l2, out_r2, input_2;
792 gboolean drained = TRUE;
793
794 for (k = 0; k < num_samples; k++) {
795 out_l1 = out_r1 = 0.0;
796
797 /* The original Freeverb code expects a stereo signal and 'input_1'
798 * is set to the sum of the left and right input_1 sample. Since
799 * this code works on a mono signal, 'input_1' is set to twice the
800 * input_1 sample. */
801 input_2 = *idata++;
802 input_1 = (2.0f * input_2 + DC_OFFSET) * priv->gain;
803
804 /* Accumulate comb filters in parallel */
805 for (i = 0; i < numcombs; i++) {
806 freeverb_comb_process (priv->combL[i], input_1, out_l1);
807 freeverb_comb_process (priv->combR[i], input_1, out_r1);
808 }
809 /* Feed through allpasses in series */
810 for (i = 0; i < numallpasses; i++) {
811 freeverb_allpass_process (priv->allpassL[i], out_l1);
812 freeverb_allpass_process (priv->allpassR[i], out_r1);
813 }
814
815 /* Remove the DC offset */
816 out_l1 -= (gfloat) DC_OFFSET;
817 out_r1 -= (gfloat) DC_OFFSET;
818
819 /* Calculate output */
820 out_l2 = out_l1 * priv->wet1 + out_r1 * priv->wet2 + input_2 * priv->dry;
821 out_r2 = out_r1 * priv->wet1 + out_l1 * priv->wet2 + input_2 * priv->dry;
822 *odata++ = out_l2;
823 *odata++ = out_r2;
824
825 if (fabs (out_l2) > 0 || fabs (out_r2) > 0)
826 drained = FALSE;
827 }
828 return drained;
829 }
830
831 static gboolean
gst_freeverb_transform_s2s_float(GstFreeverb * filter,gfloat * idata,gfloat * odata,guint num_samples)832 gst_freeverb_transform_s2s_float (GstFreeverb * filter,
833 gfloat * idata, gfloat * odata, guint num_samples)
834 {
835 GstFreeverbPrivate *priv = filter->priv;
836 gint i, k;
837 gfloat out_l1, out_r1, input_1l, input_1r;
838 gfloat out_l2, out_r2, input_2l, input_2r;
839 gboolean drained = TRUE;
840
841 for (k = 0; k < num_samples; k++) {
842 out_l1 = out_r1 = 0.0;
843
844 input_2l = *idata++;
845 input_2r = *idata++;
846 input_1l = (input_2l + DC_OFFSET) * priv->gain;
847 input_1r = (input_2r + DC_OFFSET) * priv->gain;
848
849 /* Accumulate comb filters in parallel */
850 for (i = 0; i < numcombs; i++) {
851 freeverb_comb_process (priv->combL[i], input_1l, out_l1);
852 freeverb_comb_process (priv->combR[i], input_1r, out_r1);
853 }
854 /* Feed through allpasses in series */
855 for (i = 0; i < numallpasses; i++) {
856 freeverb_allpass_process (priv->allpassL[i], out_l1);
857 freeverb_allpass_process (priv->allpassR[i], out_r1);
858 }
859
860 /* Remove the DC offset */
861 out_l1 -= (gfloat) DC_OFFSET;
862 out_r1 -= (gfloat) DC_OFFSET;
863
864 /* Calculate output */
865 out_l2 = out_l1 * priv->wet1 + out_r1 * priv->wet2 + input_2l * priv->dry;
866 out_r2 = out_r1 * priv->wet1 + out_l1 * priv->wet2 + input_2r * priv->dry;
867 *odata++ = out_l2;
868 *odata++ = out_r2;
869
870 if (fabs (out_l2) > 0 || fabs (out_r2) > 0)
871 drained = FALSE;
872 }
873 return drained;
874 }
875
876 /* this function does the actual processing
877 */
878 static GstFlowReturn
gst_freeverb_transform(GstBaseTransform * base,GstBuffer * inbuf,GstBuffer * outbuf)879 gst_freeverb_transform (GstBaseTransform * base, GstBuffer * inbuf,
880 GstBuffer * outbuf)
881 {
882 GstFreeverb *filter = GST_FREEVERB (base);
883 guint num_samples;
884 GstClockTime timestamp;
885 GstMapInfo inmap, outmap;
886
887 timestamp = GST_BUFFER_TIMESTAMP (inbuf);
888 timestamp =
889 gst_segment_to_stream_time (&base->segment, GST_FORMAT_TIME, timestamp);
890
891 gst_buffer_map (inbuf, &inmap, GST_MAP_READ);
892 gst_buffer_map (outbuf, &outmap, GST_MAP_WRITE);
893 num_samples = outmap.size / (2 * GST_AUDIO_INFO_BPS (&filter->info));
894
895 GST_DEBUG_OBJECT (filter, "processing %u samples at %" GST_TIME_FORMAT,
896 num_samples, GST_TIME_ARGS (timestamp));
897
898 if (GST_CLOCK_TIME_IS_VALID (timestamp))
899 gst_object_sync_values (GST_OBJECT (filter), timestamp);
900
901 if (G_UNLIKELY (GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_DISCONT))) {
902 filter->drained = FALSE;
903 }
904 if (G_UNLIKELY (GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP))) {
905 if (filter->drained) {
906 memset (outmap.data, 0, outmap.size);
907 }
908 } else {
909 filter->drained = FALSE;
910 }
911
912 if (!filter->drained) {
913 filter->drained =
914 filter->process (filter, inmap.data, outmap.data, num_samples);
915 }
916
917 if (filter->drained) {
918 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_GAP);
919 }
920
921 gst_buffer_unmap (inbuf, &inmap);
922 gst_buffer_unmap (outbuf, &outmap);
923
924 return GST_FLOW_OK;
925 }
926
927
928 static gboolean
plugin_init(GstPlugin * plugin)929 plugin_init (GstPlugin * plugin)
930 {
931 return gst_element_register (plugin, "freeverb",
932 GST_RANK_NONE, GST_TYPE_FREEVERB);
933 }
934
935 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
936 GST_VERSION_MINOR,
937 freeverb,
938 "Reverberation/room effect",
939 plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)
940