avfilter/af_asoftclip: add erf soft clip type
[ffmpeg.git] / libavfilter / af_asoftclip.c
1 /*
2  * Copyright (c) 2019 The FFmpeg Project
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include "libavutil/channel_layout.h"
22 #include "libavutil/opt.h"
23 #include "avfilter.h"
24 #include "audio.h"
25 #include "formats.h"
26
27 enum ASoftClipTypes {
28     ASC_TANH,
29     ASC_ATAN,
30     ASC_CUBIC,
31     ASC_EXP,
32     ASC_ALG,
33     ASC_QUINTIC,
34     ASC_SIN,
35     ASC_ERF,
36     NB_TYPES,
37 };
38
39 typedef struct ASoftClipContext {
40     const AVClass *class;
41
42     int type;
43     double param;
44
45     void (*filter)(struct ASoftClipContext *s, void **dst, const void **src,
46                    int nb_samples, int channels, int start, int end);
47 } ASoftClipContext;
48
49 #define OFFSET(x) offsetof(ASoftClipContext, x)
50 #define A AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_RUNTIME_PARAM
51
52 static const AVOption asoftclip_options[] = {
53     { "type", "set softclip type", OFFSET(type), AV_OPT_TYPE_INT,    {.i64=0},          0, NB_TYPES-1, A, "types" },
54     { "tanh",                NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_TANH},   0,          0, A, "types" },
55     { "atan",                NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_ATAN},   0,          0, A, "types" },
56     { "cubic",               NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_CUBIC},  0,          0, A, "types" },
57     { "exp",                 NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_EXP},    0,          0, A, "types" },
58     { "alg",                 NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_ALG},    0,          0, A, "types" },
59     { "quintic",             NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_QUINTIC},0,          0, A, "types" },
60     { "sin",                 NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_SIN},    0,          0, A, "types" },
61     { "erf",                 NULL,            0, AV_OPT_TYPE_CONST,  {.i64=ASC_ERF},    0,          0, A, "types" },
62     { "param", "set softclip parameter", OFFSET(param), AV_OPT_TYPE_DOUBLE, {.dbl=1}, 0.01,        3, A },
63     { NULL }
64 };
65
66 AVFILTER_DEFINE_CLASS(asoftclip);
67
68 static int query_formats(AVFilterContext *ctx)
69 {
70     AVFilterFormats *formats = NULL;
71     AVFilterChannelLayouts *layouts = NULL;
72     static const enum AVSampleFormat sample_fmts[] = {
73         AV_SAMPLE_FMT_FLT, AV_SAMPLE_FMT_FLTP,
74         AV_SAMPLE_FMT_DBL, AV_SAMPLE_FMT_DBLP,
75         AV_SAMPLE_FMT_NONE
76     };
77     int ret;
78
79     formats = ff_make_format_list(sample_fmts);
80     if (!formats)
81         return AVERROR(ENOMEM);
82     ret = ff_set_common_formats(ctx, formats);
83     if (ret < 0)
84         return ret;
85
86     layouts = ff_all_channel_counts();
87     if (!layouts)
88         return AVERROR(ENOMEM);
89
90     ret = ff_set_common_channel_layouts(ctx, layouts);
91     if (ret < 0)
92         return ret;
93
94     formats = ff_all_samplerates();
95     return ff_set_common_samplerates(ctx, formats);
96 }
97
98 #define SQR(x) ((x) * (x))
99
100 static void filter_flt(ASoftClipContext *s,
101                        void **dptr, const void **sptr,
102                        int nb_samples, int channels,
103                        int start, int end)
104 {
105     float param = s->param;
106
107     for (int c = start; c < end; c++) {
108         const float *src = sptr[c];
109         float *dst = dptr[c];
110
111         switch (s->type) {
112         case ASC_TANH:
113             for (int n = 0; n < nb_samples; n++) {
114                 dst[n] = tanhf(src[n] * param);
115             }
116             break;
117         case ASC_ATAN:
118             for (int n = 0; n < nb_samples; n++)
119                 dst[n] = 2.f / M_PI * atanf(src[n] * param);
120             break;
121         case ASC_CUBIC:
122             for (int n = 0; n < nb_samples; n++) {
123                 if (FFABS(src[n]) >= 1.5f)
124                     dst[n] = FFSIGN(src[n]);
125                 else
126                     dst[n] = src[n] - 0.1481f * powf(src[n], 3.f);
127             }
128             break;
129         case ASC_EXP:
130             for (int n = 0; n < nb_samples; n++)
131                 dst[n] = 2.f / (1.f + expf(-2.f * src[n])) - 1.;
132             break;
133         case ASC_ALG:
134             for (int n = 0; n < nb_samples; n++)
135                 dst[n] = src[n] / (sqrtf(param + src[n] * src[n]));
136             break;
137         case ASC_QUINTIC:
138             for (int n = 0; n < nb_samples; n++) {
139                 if (FFABS(src[n]) >= 1.25)
140                     dst[n] = FFSIGN(src[n]);
141                 else
142                     dst[n] = src[n] - 0.08192f * powf(src[n], 5.f);
143             }
144             break;
145         case ASC_SIN:
146             for (int n = 0; n < nb_samples; n++) {
147                 if (FFABS(src[n]) >= M_PI_2)
148                     dst[n] = FFSIGN(src[n]);
149                 else
150                     dst[n] = sinf(src[n]);
151             }
152             break;
153         case ASC_ERF:
154             for (int n = 0; n < nb_samples; n++) {
155                 dst[n] = erff(src[n]);
156             }
157             break;
158         }
159     }
160 }
161
162 static void filter_dbl(ASoftClipContext *s,
163                        void **dptr, const void **sptr,
164                        int nb_samples, int channels,
165                        int start, int end)
166 {
167     double param = s->param;
168
169     for (int c = start; c < end; c++) {
170         const double *src = sptr[c];
171         double *dst = dptr[c];
172
173         switch (s->type) {
174         case ASC_TANH:
175             for (int n = 0; n < nb_samples; n++) {
176                 dst[n] = tanh(src[n] * param);
177             }
178             break;
179         case ASC_ATAN:
180             for (int n = 0; n < nb_samples; n++)
181                 dst[n] = 2. / M_PI * atan(src[n] * param);
182             break;
183         case ASC_CUBIC:
184             for (int n = 0; n < nb_samples; n++) {
185                 if (FFABS(src[n]) >= 1.5)
186                     dst[n] = FFSIGN(src[n]);
187                 else
188                     dst[n] = src[n] - 0.1481 * pow(src[n], 3.);
189             }
190             break;
191         case ASC_EXP:
192             for (int n = 0; n < nb_samples; n++)
193                 dst[n] = 2. / (1. + exp(-2. * src[n])) - 1.;
194             break;
195         case ASC_ALG:
196             for (int n = 0; n < nb_samples; n++)
197                 dst[n] = src[n] / (sqrt(param + src[n] * src[n]));
198             break;
199         case ASC_QUINTIC:
200             for (int n = 0; n < nb_samples; n++) {
201                 if (FFABS(src[n]) >= 1.25)
202                     dst[n] = FFSIGN(src[n]);
203                 else
204                     dst[n] = src[n] - 0.08192 * pow(src[n], 5.);
205             }
206             break;
207         case ASC_SIN:
208             for (int n = 0; n < nb_samples; n++) {
209                 if (FFABS(src[n]) >= M_PI_2)
210                     dst[n] = FFSIGN(src[n]);
211                 else
212                     dst[n] = sin(src[n]);
213             }
214             break;
215         case ASC_ERF:
216             for (int n = 0; n < nb_samples; n++) {
217                 dst[n] = erf(src[n]);
218             }
219             break;
220         }
221     }
222 }
223
224 static int config_input(AVFilterLink *inlink)
225 {
226     AVFilterContext *ctx = inlink->dst;
227     ASoftClipContext *s = ctx->priv;
228
229     switch (inlink->format) {
230     case AV_SAMPLE_FMT_FLT:
231     case AV_SAMPLE_FMT_FLTP: s->filter = filter_flt; break;
232     case AV_SAMPLE_FMT_DBL:
233     case AV_SAMPLE_FMT_DBLP: s->filter = filter_dbl; break;
234     }
235
236     return 0;
237 }
238
239 typedef struct ThreadData {
240     AVFrame *in, *out;
241     int nb_samples;
242     int channels;
243 } ThreadData;
244
245 static int filter_channels(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs)
246 {
247     ASoftClipContext *s = ctx->priv;
248     ThreadData *td = arg;
249     AVFrame *out = td->out;
250     AVFrame *in = td->in;
251     const int channels = td->channels;
252     const int nb_samples = td->nb_samples;
253     const int start = (channels * jobnr) / nb_jobs;
254     const int end = (channels * (jobnr+1)) / nb_jobs;
255
256     s->filter(s, (void **)out->extended_data, (const void **)in->extended_data,
257               nb_samples, channels, start, end);
258
259     return 0;
260 }
261
262 static int filter_frame(AVFilterLink *inlink, AVFrame *in)
263 {
264     AVFilterContext *ctx = inlink->dst;
265     AVFilterLink *outlink = ctx->outputs[0];
266     int nb_samples, channels;
267     ThreadData td;
268     AVFrame *out;
269
270     if (av_frame_is_writable(in)) {
271         out = in;
272     } else {
273         out = ff_get_audio_buffer(outlink, in->nb_samples);
274         if (!out) {
275             av_frame_free(&in);
276             return AVERROR(ENOMEM);
277         }
278         av_frame_copy_props(out, in);
279     }
280
281     if (av_sample_fmt_is_planar(in->format)) {
282         nb_samples = in->nb_samples;
283         channels = in->channels;
284     } else {
285         nb_samples = in->channels * in->nb_samples;
286         channels = 1;
287     }
288
289     td.in = in;
290     td.out = out;
291     td.nb_samples = nb_samples;
292     td.channels = channels;
293     ctx->internal->execute(ctx, filter_channels, &td, NULL, FFMIN(channels,
294                                                             ff_filter_get_nb_threads(ctx)));
295
296     if (out != in)
297         av_frame_free(&in);
298
299     return ff_filter_frame(outlink, out);
300 }
301
302 static const AVFilterPad inputs[] = {
303     {
304         .name         = "default",
305         .type         = AVMEDIA_TYPE_AUDIO,
306         .filter_frame = filter_frame,
307         .config_props = config_input,
308     },
309     { NULL }
310 };
311
312 static const AVFilterPad outputs[] = {
313     {
314         .name = "default",
315         .type = AVMEDIA_TYPE_AUDIO,
316     },
317     { NULL }
318 };
319
320 AVFilter ff_af_asoftclip = {
321     .name           = "asoftclip",
322     .description    = NULL_IF_CONFIG_SMALL("Audio Soft Clipper."),
323     .query_formats  = query_formats,
324     .priv_size      = sizeof(ASoftClipContext),
325     .priv_class     = &asoftclip_class,
326     .inputs         = inputs,
327     .outputs        = outputs,
328     .process_command = ff_filter_process_command,
329     .flags          = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC |
330                       AVFILTER_FLAG_SLICE_THREADS,
331 };