Browse code

avfilter: add flanger filter

Signed-off-by: Paul B Mahol <onemda@gmail.com>

Paul B Mahol authored on 2014/06/27 17:42:35
Showing 6 changed files
... ...
@@ -30,6 +30,7 @@ version <next>:
30 30
 - zoompan filter
31 31
 - signalstats filter
32 32
 - hqx filter (hq2x, hq3x, hq4x)
33
+- flanger filter
33 34
 
34 35
 
35 36
 version 2.2:
... ...
@@ -1439,6 +1439,42 @@ equalizer=f=1000:width_type=q:width=1:g=2,equalizer=f=100:width_type=q:width=2:g
1439 1439
 @end example
1440 1440
 @end itemize
1441 1441
 
1442
+@section flanger
1443
+Apply a flanging effect to the audio.
1444
+
1445
+The filter accepts the following options:
1446
+
1447
+@table @option
1448
+@item delay
1449
+Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
1450
+
1451
+@item depth
1452
+Set added swep delay in milliseconds. Range from 0 to 10. Default value is 2.
1453
+
1454
+@item regen
1455
+Set percentage regeneneration (delayed signal feedback). Range from -95 to 95.
1456
+Default value is 0.
1457
+
1458
+@item width
1459
+Set percentage of delayed signal mixed with original. Range from 0 to 100.
1460
+Default valu is 71.
1461
+
1462
+@item speed
1463
+Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
1464
+
1465
+@item shape
1466
+Set swept wave shape, can be @var{triangular} or @var{sinusoidal}.
1467
+Default value is @var{sinusoidal}.
1468
+
1469
+@item phase
1470
+Set swept wave percentage-shift for multi channel. Range from 0 to 100.
1471
+Default value is 25.
1472
+
1473
+@item interp
1474
+Set delay-line interpolation, @var{linear} or @var{quadratic}.
1475
+Default is @var{linear}.
1476
+@end table
1477
+
1442 1478
 @section highpass
1443 1479
 
1444 1480
 Apply a high-pass filter with 3dB point frequency.
... ...
@@ -69,6 +69,7 @@ OBJS-$(CONFIG_COMPAND_FILTER)                += af_compand.o
69 69
 OBJS-$(CONFIG_EARWAX_FILTER)                 += af_earwax.o
70 70
 OBJS-$(CONFIG_EBUR128_FILTER)                += f_ebur128.o
71 71
 OBJS-$(CONFIG_EQUALIZER_FILTER)              += af_biquads.o
72
+OBJS-$(CONFIG_FLANGER_FILTER)                += af_flanger.o generate_wave_table.o
72 73
 OBJS-$(CONFIG_HIGHPASS_FILTER)               += af_biquads.o
73 74
 OBJS-$(CONFIG_JOIN_FILTER)                   += af_join.o
74 75
 OBJS-$(CONFIG_LADSPA_FILTER)                 += af_ladspa.o
75 76
new file mode 100644
... ...
@@ -0,0 +1,241 @@
0
+/*
1
+ * Copyright (c) 2006 Rob Sykes <robs@users.sourceforge.net>
2
+ *
3
+ * This file is part of FFmpeg.
4
+ *
5
+ * FFmpeg is free software; you can redistribute it and/or
6
+ * modify it under the terms of the GNU Lesser General Public
7
+ * License as published by the Free Software Foundation; either
8
+ * version 2.1 of the License, or (at your option) any later version.
9
+ *
10
+ * FFmpeg 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
+ * Lesser General Public License for more details.
14
+ *
15
+ * You should have received a copy of the GNU Lesser General Public
16
+ * License along with FFmpeg; if not, write to the Free Software
17
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
+ */
19
+
20
+#include "libavutil/avstring.h"
21
+#include "libavutil/opt.h"
22
+#include "libavutil/samplefmt.h"
23
+#include "avfilter.h"
24
+#include "audio.h"
25
+#include "internal.h"
26
+#include "generate_wave_table.h"
27
+
28
+#define INTERPOLATION_LINEAR    0
29
+#define INTERPOLATION_QUADRATIC 1
30
+
31
+typedef struct FlangerContext {
32
+    const AVClass *class;
33
+    double delay_min;
34
+    double delay_depth;
35
+    double feedback_gain;
36
+    double delay_gain;
37
+    double speed;
38
+    int wave_shape;
39
+    double channel_phase;
40
+    int interpolation;
41
+    double in_gain;
42
+    int max_samples;
43
+    uint8_t **delay_buffer;
44
+    int delay_buf_pos;
45
+    double *delay_last;
46
+    float *lfo;
47
+    int lfo_length;
48
+    int lfo_pos;
49
+} FlangerContext;
50
+
51
+#define OFFSET(x) offsetof(FlangerContext, x)
52
+#define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
53
+
54
+static const AVOption flanger_options[] = {
55
+    { "delay", "base delay in milliseconds",        OFFSET(delay_min),   AV_OPT_TYPE_DOUBLE, {.dbl=0}, 0, 30, A },
56
+    { "depth", "added swept delay in milliseconds", OFFSET(delay_depth), AV_OPT_TYPE_DOUBLE, {.dbl=2}, 0, 10, A },
57
+    { "regen", "percentage regeneration (delayed signal feedback)", OFFSET(feedback_gain), AV_OPT_TYPE_DOUBLE, {.dbl=0}, -95, 95, A },
58
+    { "width", "percentage of delayed signal mixed with original", OFFSET(delay_gain), AV_OPT_TYPE_DOUBLE, {.dbl=71}, 0, 100, A },
59
+    { "speed", "sweeps per second (Hz)", OFFSET(speed), AV_OPT_TYPE_DOUBLE, {.dbl=0.5}, 0.1, 10, A },
60
+    { "shape", "swept wave shape", OFFSET(wave_shape), AV_OPT_TYPE_INT, {.i64=WAVE_SIN}, WAVE_SIN, WAVE_NB-1, A, "type" },
61
+    { "triangular",  NULL, 0, AV_OPT_TYPE_CONST,  {.i64=WAVE_TRI}, 0, 0, A, "type" },
62
+    { "t",           NULL, 0, AV_OPT_TYPE_CONST,  {.i64=WAVE_TRI}, 0, 0, A, "type" },
63
+    { "sinusoidal",  NULL, 0, AV_OPT_TYPE_CONST,  {.i64=WAVE_SIN}, 0, 0, A, "type" },
64
+    { "s",           NULL, 0, AV_OPT_TYPE_CONST,  {.i64=WAVE_SIN}, 0, 0, A, "type" },
65
+    { "phase", "swept wave percentage phase-shift for multi-channel", OFFSET(channel_phase), AV_OPT_TYPE_DOUBLE, {.dbl=25}, 0, 100, A },
66
+    { "interp", "delay-line interpolation", OFFSET(interpolation), AV_OPT_TYPE_INT, {.i64=0}, 0, 1, A, "itype" },
67
+    { "linear",     NULL, 0, AV_OPT_TYPE_CONST,  {.i64=INTERPOLATION_LINEAR},    0, 0, A, "itype" },
68
+    { "quadratic",  NULL, 0, AV_OPT_TYPE_CONST,  {.i64=INTERPOLATION_QUADRATIC}, 0, 0, A, "itype" },
69
+    { NULL }
70
+};
71
+
72
+AVFILTER_DEFINE_CLASS(flanger);
73
+
74
+static int init(AVFilterContext *ctx)
75
+{
76
+    FlangerContext *s = ctx->priv;
77
+
78
+    s->feedback_gain /= 100;
79
+    s->delay_gain    /= 100;
80
+    s->channel_phase /= 100;
81
+    s->delay_min     /= 1000;
82
+    s->delay_depth   /= 1000;
83
+    s->in_gain        = 1 / (1 + s->delay_gain);
84
+    s->delay_gain    /= 1 + s->delay_gain;
85
+    s->delay_gain    *= 1 - fabs(s->feedback_gain);
86
+
87
+    return 0;
88
+}
89
+
90
+static int query_formats(AVFilterContext *ctx)
91
+{
92
+    AVFilterChannelLayouts *layouts;
93
+    AVFilterFormats *formats;
94
+    static const enum AVSampleFormat sample_fmts[] = {
95
+        AV_SAMPLE_FMT_DBLP, AV_SAMPLE_FMT_NONE
96
+    };
97
+
98
+    layouts = ff_all_channel_layouts();
99
+    if (!layouts)
100
+        return AVERROR(ENOMEM);
101
+    ff_set_common_channel_layouts(ctx, layouts);
102
+
103
+    formats = ff_make_format_list(sample_fmts);
104
+    if (!formats)
105
+        return AVERROR(ENOMEM);
106
+    ff_set_common_formats(ctx, formats);
107
+
108
+    formats = ff_all_samplerates();
109
+    if (!formats)
110
+        return AVERROR(ENOMEM);
111
+    ff_set_common_samplerates(ctx, formats);
112
+
113
+    return 0;
114
+}
115
+
116
+static int config_input(AVFilterLink *inlink)
117
+{
118
+    AVFilterContext *ctx = inlink->dst;
119
+    FlangerContext *s = ctx->priv;
120
+
121
+    s->max_samples = (s->delay_min + s->delay_depth) * inlink->sample_rate + 2.5;
122
+    s->lfo_length  = inlink->sample_rate / s->speed;
123
+    s->delay_last  = av_calloc(inlink->channels, sizeof(*s->delay_last));
124
+    s->lfo         = av_calloc(s->lfo_length, sizeof(*s->lfo));
125
+    if (!s->lfo || !s->delay_last)
126
+        return AVERROR(ENOMEM);
127
+
128
+    ff_generate_wave_table(s->wave_shape, AV_SAMPLE_FMT_FLT, s->lfo, s->lfo_length,
129
+                           floor(s->delay_min * inlink->sample_rate + 0.5),
130
+                           s->max_samples - 2., 3 * M_PI_2);
131
+
132
+    return av_samples_alloc_array_and_samples(&s->delay_buffer, NULL,
133
+                                              inlink->channels, s->max_samples,
134
+                                              inlink->format, 0);
135
+}
136
+
137
+static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
138
+{
139
+    AVFilterContext *ctx = inlink->dst;
140
+    FlangerContext *s = ctx->priv;
141
+    AVFrame *out_frame;
142
+    int chan, i;
143
+
144
+    if (av_frame_is_writable(frame)) {
145
+        out_frame = frame;
146
+    } else {
147
+        out_frame = ff_get_audio_buffer(inlink, frame->nb_samples);
148
+        if (!out_frame)
149
+            return AVERROR(ENOMEM);
150
+        av_frame_copy_props(out_frame, frame);
151
+    }
152
+
153
+    for (i = 0; i < frame->nb_samples; i++) {
154
+
155
+        s->delay_buf_pos = (s->delay_buf_pos + s->max_samples - 1) % s->max_samples;
156
+
157
+        for (chan = 0; chan < inlink->channels; chan++) {
158
+            double *src = (double *)frame->extended_data[chan];
159
+            double *dst = (double *)out_frame->extended_data[chan];
160
+            double delayed_0, delayed_1;
161
+            double delayed;
162
+            double in, out;
163
+            int channel_phase = chan * s->lfo_length * s->channel_phase + .5;
164
+            double delay = s->lfo[(s->lfo_pos + channel_phase) % s->lfo_length];
165
+            int int_delay = (int)delay;
166
+            double frac_delay = modf(delay, &delay);
167
+            double *delay_buffer = (double *)s->delay_buffer[chan];
168
+
169
+            in = src[i];
170
+            delay_buffer[s->delay_buf_pos] = in + s->delay_last[chan] *
171
+                                                           s->feedback_gain;
172
+            delayed_0 = delay_buffer[(s->delay_buf_pos + int_delay++) % s->max_samples];
173
+            delayed_1 = delay_buffer[(s->delay_buf_pos + int_delay++) % s->max_samples];
174
+
175
+            if (s->interpolation == INTERPOLATION_LINEAR) {
176
+                delayed = delayed_0 + (delayed_1 - delayed_0) * frac_delay;
177
+            } else {
178
+                double a, b;
179
+                double delayed_2 = delay_buffer[(s->delay_buf_pos + int_delay++) % s->max_samples];
180
+                delayed_2 -= delayed_0;
181
+                delayed_1 -= delayed_0;
182
+                a = delayed_2 * .5 - delayed_1;
183
+                b = delayed_1 *  2 - delayed_2 *.5;
184
+                delayed = delayed_0 + (a * frac_delay + b) * frac_delay;
185
+            }
186
+
187
+            s->delay_last[chan] = delayed;
188
+            out = in * s->in_gain + delayed * s->delay_gain;
189
+            dst[i] = out;
190
+        }
191
+        s->lfo_pos = (s->lfo_pos + 1) % s->lfo_length;
192
+    }
193
+
194
+    if (frame != out_frame)
195
+        av_frame_free(&frame);
196
+
197
+    return ff_filter_frame(ctx->outputs[0], out_frame);
198
+}
199
+
200
+static av_cold void uninit(AVFilterContext *ctx)
201
+{
202
+    FlangerContext *s = ctx->priv;
203
+
204
+    av_freep(&s->lfo);
205
+    av_freep(&s->delay_last);
206
+
207
+    if (s->delay_buffer)
208
+        av_freep(&s->delay_buffer[0]);
209
+    av_freep(&s->delay_buffer);
210
+}
211
+
212
+static const AVFilterPad flanger_inputs[] = {
213
+    {
214
+        .name         = "default",
215
+        .type         = AVMEDIA_TYPE_AUDIO,
216
+        .config_props = config_input,
217
+        .filter_frame = filter_frame,
218
+    },
219
+    { NULL }
220
+};
221
+
222
+static const AVFilterPad flanger_outputs[] = {
223
+    {
224
+        .name          = "default",
225
+        .type          = AVMEDIA_TYPE_AUDIO,
226
+    },
227
+    { NULL }
228
+};
229
+
230
+AVFilter ff_af_flanger = {
231
+    .name          = "flanger",
232
+    .description   = NULL_IF_CONFIG_SMALL("Apply a flanging effect to the audio."),
233
+    .query_formats = query_formats,
234
+    .priv_size     = sizeof(FlangerContext),
235
+    .priv_class    = &flanger_class,
236
+    .init          = init,
237
+    .uninit        = uninit,
238
+    .inputs        = flanger_inputs,
239
+    .outputs       = flanger_outputs,
240
+};
... ...
@@ -87,6 +87,7 @@ void avfilter_register_all(void)
87 87
     REGISTER_FILTER(EARWAX,         earwax,         af);
88 88
     REGISTER_FILTER(EBUR128,        ebur128,        af);
89 89
     REGISTER_FILTER(EQUALIZER,      equalizer,      af);
90
+    REGISTER_FILTER(FLANGER,        flanger,        af);
90 91
     REGISTER_FILTER(HIGHPASS,       highpass,       af);
91 92
     REGISTER_FILTER(JOIN,           join,           af);
92 93
     REGISTER_FILTER(LADSPA,         ladspa,         af);
... ...
@@ -30,7 +30,7 @@
30 30
 #include "libavutil/version.h"
31 31
 
32 32
 #define LIBAVFILTER_VERSION_MAJOR   4
33
-#define LIBAVFILTER_VERSION_MINOR   9
33
+#define LIBAVFILTER_VERSION_MINOR  10
34 34
 #define LIBAVFILTER_VERSION_MICRO 100
35 35
 
36 36
 #define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \