2 * Copyright (c) 2001-2010 Krzysztof Foltman, Markus Schmidt, Thor Harald Johansen and others
3 * Copyright (c) 2015 Paul B Mahol
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "libavutil/intreadwrite.h"
23 #include "libavutil/avstring.h"
24 #include "libavutil/ffmath.h"
25 #include "libavutil/opt.h"
26 #include "libavutil/parseutils.h"
31 #define FILTER_ORDER 4
40 typedef struct FoSection {
41 double a0, a1, a2, a3, a4;
42 double b0, b1, b2, b3, b4;
48 typedef struct EqualizatorFilter {
60 typedef struct AudioNEqualizerContext {
71 EqualizatorFilter *filters;
73 } AudioNEqualizerContext;
75 #define OFFSET(x) offsetof(AudioNEqualizerContext, x)
76 #define A AV_OPT_FLAG_AUDIO_PARAM
77 #define V AV_OPT_FLAG_VIDEO_PARAM
78 #define F AV_OPT_FLAG_FILTERING_PARAM
80 static const AVOption anequalizer_options[] = {
81 { "params", NULL, OFFSET(args), AV_OPT_TYPE_STRING, {.str=""}, 0, 0, A|F },
82 { "curves", "draw frequency response curves", OFFSET(draw_curves), AV_OPT_TYPE_BOOL, {.i64=0}, 0, 1, V|F },
83 { "size", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "hd720"}, 0, 0, V|F },
84 { "mgain", "set max gain", OFFSET(mag), AV_OPT_TYPE_DOUBLE, {.dbl=60}, -900, 900, V|F },
85 { "fscale", "set frequency scale", OFFSET(fscale), AV_OPT_TYPE_INT, {.i64=1}, 0, 1, V|F, "fscale" },
86 { "lin", "linear", 0, AV_OPT_TYPE_CONST, {.i64=0}, 0, 0, V|F, "fscale" },
87 { "log", "logarithmic", 0, AV_OPT_TYPE_CONST, {.i64=1}, 0, 0, V|F, "fscale" },
88 { "colors", "set channels curves colors", OFFSET(colors), AV_OPT_TYPE_STRING, {.str = "red|green|blue|yellow|orange|lime|pink|magenta|brown" }, 0, 0, V|F },
92 AVFILTER_DEFINE_CLASS(anequalizer);
94 static void draw_curves(AVFilterContext *ctx, AVFilterLink *inlink, AVFrame *out)
96 AudioNEqualizerContext *s = ctx->priv;
97 char *colors, *color, *saveptr = NULL;
100 colors = av_strdup(s->colors);
104 memset(out->data[0], 0, s->h * out->linesize[0]);
106 for (ch = 0; ch < inlink->channels; ch++) {
107 uint8_t fg[4] = { 0xff, 0xff, 0xff, 0xff };
111 color = av_strtok(ch == 0 ? colors : NULL, " |", &saveptr);
113 av_parse_color(fg, color, -1, ctx);
115 for (f = 0; f < s->w; f++) {
116 double zr, zi, zr2, zi2;
122 w = M_PI * (s->fscale ? pow(s->w - 1, f / s->w) : f) / (s->w - 1);
128 for (n = 0; n < s->nb_filters; n++) {
129 if (s->filters[n].channel != ch ||
130 s->filters[n].ignore)
133 for (i = 0; i < FILTER_ORDER / 2; i++) {
134 FoSection *S = &s->filters[n].section[i];
136 /* H *= (((((S->b4 * z + S->b3) * z + S->b2) * z + S->b1) * z + S->b0) /
137 ((((S->a4 * z + S->a3) * z + S->a2) * z + S->a1) * z + S->a0)); */
139 Hr = S->b4*(1-8*zr2*zi2) + S->b2*(zr2-zi2) + zr*(S->b1+S->b3*(zr2-3*zi2))+ S->b0;
140 Hi = zi*(S->b3*(3*zr2-zi2) + S->b1 + 2*zr*(2*S->b4*(zr2-zi2) + S->b2));
141 Hmag *= hypot(Hr, Hi);
142 Hr = S->a4*(1-8*zr2*zi2) + S->a2*(zr2-zi2) + zr*(S->a1+S->a3*(zr2-3*zi2))+ S->a0;
143 Hi = zi*(S->a3*(3*zr2-zi2) + S->a1 + 2*zr*(2*S->a4*(zr2-zi2) + S->a2));
144 Hmag /= hypot(Hr, Hi);
148 v = av_clip((1. + -20 * log10(Hmag) / s->mag) * s->h / 2, 0, s->h - 1);
153 for (y = v; y <= prev_v; y++)
154 AV_WL32(out->data[0] + y * out->linesize[0] + x * 4, AV_RL32(fg));
156 for (y = prev_v; y <= v; y++)
157 AV_WL32(out->data[0] + y * out->linesize[0] + x * 4, AV_RL32(fg));
167 static int config_video(AVFilterLink *outlink)
169 AVFilterContext *ctx = outlink->src;
170 AudioNEqualizerContext *s = ctx->priv;
171 AVFilterLink *inlink = ctx->inputs[0];
177 av_frame_free(&s->video);
178 s->video = out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
180 return AVERROR(ENOMEM);
181 outlink->sample_aspect_ratio = (AVRational){1,1};
183 draw_curves(ctx, inlink, out);
188 static av_cold int init(AVFilterContext *ctx)
190 AudioNEqualizerContext *s = ctx->priv;
191 AVFilterPad pad, vpad;
195 .name = av_strdup("out0"),
196 .type = AVMEDIA_TYPE_AUDIO,
200 return AVERROR(ENOMEM);
202 if (s->draw_curves) {
203 vpad = (AVFilterPad){
204 .name = av_strdup("out1"),
205 .type = AVMEDIA_TYPE_VIDEO,
206 .config_props = config_video,
209 return AVERROR(ENOMEM);
212 ret = ff_insert_outpad(ctx, 0, &pad);
218 if (s->draw_curves) {
219 ret = ff_insert_outpad(ctx, 1, &vpad);
221 av_freep(&vpad.name);
229 static int query_formats(AVFilterContext *ctx)
231 AVFilterLink *inlink = ctx->inputs[0];
232 AVFilterLink *outlink = ctx->outputs[0];
233 AudioNEqualizerContext *s = ctx->priv;
234 AVFilterFormats *formats;
235 AVFilterChannelLayouts *layouts;
236 static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_RGBA, AV_PIX_FMT_NONE };
237 static const enum AVSampleFormat sample_fmts[] = {
243 if (s->draw_curves) {
244 AVFilterLink *videolink = ctx->outputs[1];
245 formats = ff_make_format_list(pix_fmts);
246 if ((ret = ff_formats_ref(formats, &videolink->in_formats)) < 0)
250 formats = ff_make_format_list(sample_fmts);
251 if ((ret = ff_formats_ref(formats, &inlink->out_formats)) < 0 ||
252 (ret = ff_formats_ref(formats, &outlink->in_formats)) < 0)
255 layouts = ff_all_channel_counts();
256 if ((ret = ff_channel_layouts_ref(layouts, &inlink->out_channel_layouts)) < 0 ||
257 (ret = ff_channel_layouts_ref(layouts, &outlink->in_channel_layouts)) < 0)
260 formats = ff_all_samplerates();
261 if ((ret = ff_formats_ref(formats, &inlink->out_samplerates)) < 0 ||
262 (ret = ff_formats_ref(formats, &outlink->in_samplerates)) < 0)
268 static av_cold void uninit(AVFilterContext *ctx)
270 AudioNEqualizerContext *s = ctx->priv;
272 for (int i = 0; i < ctx->nb_outputs; i++)
273 av_freep(&ctx->output_pads[i].name);
274 av_frame_free(&s->video);
275 av_freep(&s->filters);
280 static void butterworth_fo_section(FoSection *S, double beta,
281 double si, double g, double g0,
284 if (c0 == 1 || c0 == -1) {
285 S->b0 = (g*g*beta*beta + 2*g*g0*si*beta + g0*g0)/D;
286 S->b1 = 2*c0*(g*g*beta*beta - g0*g0)/D;
287 S->b2 = (g*g*beta*beta - 2*g0*g*beta*si + g0*g0)/D;
292 S->a1 = 2*c0*(beta*beta - 1)/D;
293 S->a2 = (beta*beta - 2*beta*si + 1)/D;
297 S->b0 = (g*g*beta*beta + 2*g*g0*si*beta + g0*g0)/D;
298 S->b1 = -4*c0*(g0*g0 + g*g0*si*beta)/D;
299 S->b2 = 2*(g0*g0*(1 + 2*c0*c0) - g*g*beta*beta)/D;
300 S->b3 = -4*c0*(g0*g0 - g*g0*si*beta)/D;
301 S->b4 = (g*g*beta*beta - 2*g*g0*si*beta + g0*g0)/D;
304 S->a1 = -4*c0*(1 + si*beta)/D;
305 S->a2 = 2*(1 + 2*c0*c0 - beta*beta)/D;
306 S->a3 = -4*c0*(1 - si*beta)/D;
307 S->a4 = (beta*beta - 2*si*beta + 1)/D;
311 static void butterworth_bp_filter(EqualizatorFilter *f,
312 int N, double w0, double wb,
313 double G, double Gb, double G0)
315 double g, c0, g0, beta;
321 if (G == 0 && G0 == 0) {
322 f->section[0].a0 = 1;
323 f->section[0].b0 = 1;
324 f->section[1].a0 = 1;
325 f->section[1].b0 = 1;
330 Gb = ff_exp10(Gb/20);
331 G0 = ff_exp10(G0/20);
333 epsilon = sqrt((G * G - Gb * Gb) / (Gb * Gb - G0 * G0));
335 g0 = pow(G0, 1.0 / N);
336 beta = pow(epsilon, -1.0 / N) * tan(wb/2);
339 for (i = 1; i <= L; i++) {
340 double ui = (2.0 * i - 1) / N;
341 double si = sin(M_PI * ui / 2.0);
342 double Di = beta * beta + 2 * si * beta + 1;
344 butterworth_fo_section(&f->section[i - 1], beta, si, g, g0, Di, c0);
348 static void chebyshev1_fo_section(FoSection *S, double a,
349 double c, double tetta_b,
350 double g0, double si, double b,
353 if (c0 == 1 || c0 == -1) {
354 S->b0 = (tetta_b*tetta_b*(b*b+g0*g0*c*c) + 2*g0*b*si*tetta_b*tetta_b + g0*g0)/D;
355 S->b1 = 2*c0*(tetta_b*tetta_b*(b*b+g0*g0*c*c) - g0*g0)/D;
356 S->b2 = (tetta_b*tetta_b*(b*b+g0*g0*c*c) - 2*g0*b*si*tetta_b + g0*g0)/D;
361 S->a1 = 2*c0*(tetta_b*tetta_b*(a*a+c*c) - 1)/D;
362 S->a2 = (tetta_b*tetta_b*(a*a+c*c) - 2*a*si*tetta_b + 1)/D;
366 S->b0 = ((b*b + g0*g0*c*c)*tetta_b*tetta_b + 2*g0*b*si*tetta_b + g0*g0)/D;
367 S->b1 = -4*c0*(g0*g0 + g0*b*si*tetta_b)/D;
368 S->b2 = 2*(g0*g0*(1 + 2*c0*c0) - (b*b + g0*g0*c*c)*tetta_b*tetta_b)/D;
369 S->b3 = -4*c0*(g0*g0 - g0*b*si*tetta_b)/D;
370 S->b4 = ((b*b + g0*g0*c*c)*tetta_b*tetta_b - 2*g0*b*si*tetta_b + g0*g0)/D;
373 S->a1 = -4*c0*(1 + a*si*tetta_b)/D;
374 S->a2 = 2*(1 + 2*c0*c0 - (a*a + c*c)*tetta_b*tetta_b)/D;
375 S->a3 = -4*c0*(1 - a*si*tetta_b)/D;
376 S->a4 = ((a*a + c*c)*tetta_b*tetta_b - 2*a*si*tetta_b + 1)/D;
380 static void chebyshev1_bp_filter(EqualizatorFilter *f,
381 int N, double w0, double wb,
382 double G, double Gb, double G0)
384 double a, b, c0, g0, alfa, beta, tetta_b;
390 if (G == 0 && G0 == 0) {
391 f->section[0].a0 = 1;
392 f->section[0].b0 = 1;
393 f->section[1].a0 = 1;
394 f->section[1].b0 = 1;
399 Gb = ff_exp10(Gb/20);
400 G0 = ff_exp10(G0/20);
402 epsilon = sqrt((G*G - Gb*Gb) / (Gb*Gb - G0*G0));
404 alfa = pow(1.0/epsilon + sqrt(1 + 1/(epsilon*epsilon)), 1.0/N);
405 beta = pow(G/epsilon + Gb * sqrt(1 + 1/(epsilon*epsilon)), 1.0/N);
406 a = 0.5 * (alfa - 1.0/alfa);
407 b = 0.5 * (beta - g0*g0*(1/beta));
411 for (i = 1; i <= L; i++) {
412 double ui = (2.0*i-1.0)/N;
413 double ci = cos(M_PI*ui/2.0);
414 double si = sin(M_PI*ui/2.0);
415 double Di = (a*a + ci*ci)*tetta_b*tetta_b + 2.0*a*si*tetta_b + 1;
417 chebyshev1_fo_section(&f->section[i - 1], a, ci, tetta_b, g0, si, b, Di, c0);
421 static void chebyshev2_fo_section(FoSection *S, double a,
422 double c, double tetta_b,
423 double g, double si, double b,
426 if (c0 == 1 || c0 == -1) {
427 S->b0 = (g*g*tetta_b*tetta_b + 2*tetta_b*g*b*si + b*b + g*g*c*c)/D;
428 S->b1 = 2*c0*(g*g*tetta_b*tetta_b - b*b - g*g*c*c)/D;
429 S->b2 = (g*g*tetta_b*tetta_b - 2*tetta_b*g*b*si + b*b + g*g*c*c)/D;
434 S->a1 = 2*c0*(tetta_b*tetta_b - a*a - c*c)/D;
435 S->a2 = (tetta_b*tetta_b - 2*tetta_b*a*si + a*a + c*c)/D;
439 S->b0 = (g*g*tetta_b*tetta_b + 2*g*b*si*tetta_b + b*b + g*g*c*c)/D;
440 S->b1 = -4*c0*(b*b + g*g*c*c + g*b*si*tetta_b)/D;
441 S->b2 = 2*((b*b + g*g*c*c)*(1 + 2*c0*c0) - g*g*tetta_b*tetta_b)/D;
442 S->b3 = -4*c0*(b*b + g*g*c*c - g*b*si*tetta_b)/D;
443 S->b4 = (g*g*tetta_b*tetta_b - 2*g*b*si*tetta_b + b*b + g*g*c*c)/D;
446 S->a1 = -4*c0*(a*a + c*c + a*si*tetta_b)/D;
447 S->a2 = 2*((a*a + c*c)*(1 + 2*c0*c0) - tetta_b*tetta_b)/D;
448 S->a3 = -4*c0*(a*a + c*c - a*si*tetta_b)/D;
449 S->a4 = (tetta_b*tetta_b - 2*a*si*tetta_b + a*a + c*c)/D;
453 static void chebyshev2_bp_filter(EqualizatorFilter *f,
454 int N, double w0, double wb,
455 double G, double Gb, double G0)
457 double a, b, c0, tetta_b;
458 double epsilon, g, eu, ew;
463 if (G == 0 && G0 == 0) {
464 f->section[0].a0 = 1;
465 f->section[0].b0 = 1;
466 f->section[1].a0 = 1;
467 f->section[1].b0 = 1;
472 Gb = ff_exp10(Gb/20);
473 G0 = ff_exp10(G0/20);
475 epsilon = sqrt((G*G - Gb*Gb) / (Gb*Gb - G0*G0));
477 eu = pow(epsilon + sqrt(1 + epsilon*epsilon), 1.0/N);
478 ew = pow(G0*epsilon + Gb*sqrt(1 + epsilon*epsilon), 1.0/N);
479 a = (eu - 1.0/eu)/2.0;
480 b = (ew - g*g/ew)/2.0;
484 for (i = 1; i <= L; i++) {
485 double ui = (2.0 * i - 1.0)/N;
486 double ci = cos(M_PI * ui / 2.0);
487 double si = sin(M_PI * ui / 2.0);
488 double Di = tetta_b*tetta_b + 2*a*si*tetta_b + a*a + ci*ci;
490 chebyshev2_fo_section(&f->section[i - 1], a, ci, tetta_b, g, si, b, Di, c0);
494 static double butterworth_compute_bw_gain_db(double gain)
500 else if(gain > -6 && gain < 6)
501 bw_gain = gain * 0.5;
508 static double chebyshev1_compute_bw_gain_db(double gain)
514 else if(gain > -6 && gain < 6)
515 bw_gain = gain * 0.9;
522 static double chebyshev2_compute_bw_gain_db(double gain)
528 else if(gain > -6 && gain < 6)
529 bw_gain = gain * 0.3;
536 static inline double hz_2_rad(double x, double fs)
538 return 2 * M_PI * x / fs;
541 static void equalizer(EqualizatorFilter *f, double sample_rate)
543 double w0 = hz_2_rad(f->freq, sample_rate);
544 double wb = hz_2_rad(f->width, sample_rate);
549 bw_gain = butterworth_compute_bw_gain_db(f->gain);
550 butterworth_bp_filter(f, FILTER_ORDER, w0, wb, f->gain, bw_gain, 0);
553 bw_gain = chebyshev1_compute_bw_gain_db(f->gain);
554 chebyshev1_bp_filter(f, FILTER_ORDER, w0, wb, f->gain, bw_gain, 0);
557 bw_gain = chebyshev2_compute_bw_gain_db(f->gain);
558 chebyshev2_bp_filter(f, FILTER_ORDER, w0, wb, f->gain, bw_gain, 0);
564 static int add_filter(AudioNEqualizerContext *s, AVFilterLink *inlink)
566 equalizer(&s->filters[s->nb_filters], inlink->sample_rate);
567 if (s->nb_filters >= s->nb_allocated) {
568 EqualizatorFilter *filters;
570 filters = av_calloc(s->nb_allocated, 2 * sizeof(*s->filters));
572 return AVERROR(ENOMEM);
573 memcpy(filters, s->filters, sizeof(*s->filters) * s->nb_allocated);
575 s->filters = filters;
576 s->nb_allocated *= 2;
583 static int config_input(AVFilterLink *inlink)
585 AVFilterContext *ctx = inlink->dst;
586 AudioNEqualizerContext *s = ctx->priv;
587 char *args = av_strdup(s->args);
588 char *saveptr = NULL;
592 return AVERROR(ENOMEM);
594 s->nb_allocated = 32 * inlink->channels;
595 s->filters = av_calloc(inlink->channels, 32 * sizeof(*s->filters));
599 return AVERROR(ENOMEM);
603 char *arg = av_strtok(s->nb_filters == 0 ? args : NULL, "|", &saveptr);
608 s->filters[s->nb_filters].type = 0;
609 if (sscanf(arg, "c%d f=%lf w=%lf g=%lf t=%d", &s->filters[s->nb_filters].channel,
610 &s->filters[s->nb_filters].freq,
611 &s->filters[s->nb_filters].width,
612 &s->filters[s->nb_filters].gain,
613 &s->filters[s->nb_filters].type) != 5 &&
614 sscanf(arg, "c%d f=%lf w=%lf g=%lf", &s->filters[s->nb_filters].channel,
615 &s->filters[s->nb_filters].freq,
616 &s->filters[s->nb_filters].width,
617 &s->filters[s->nb_filters].gain) != 4 ) {
619 return AVERROR(EINVAL);
622 if (s->filters[s->nb_filters].freq < 0 ||
623 s->filters[s->nb_filters].freq > inlink->sample_rate / 2.0)
624 s->filters[s->nb_filters].ignore = 1;
626 if (s->filters[s->nb_filters].channel < 0 ||
627 s->filters[s->nb_filters].channel >= inlink->channels)
628 s->filters[s->nb_filters].ignore = 1;
630 s->filters[s->nb_filters].type = av_clip(s->filters[s->nb_filters].type, 0, NB_TYPES - 1);
631 ret = add_filter(s, inlink);
641 static int process_command(AVFilterContext *ctx, const char *cmd, const char *args,
642 char *res, int res_len, int flags)
644 AudioNEqualizerContext *s = ctx->priv;
645 AVFilterLink *inlink = ctx->inputs[0];
646 int ret = AVERROR(ENOSYS);
648 if (!strcmp(cmd, "change")) {
649 double freq, width, gain;
652 if (sscanf(args, "%d|f=%lf|w=%lf|g=%lf", &filter, &freq, &width, &gain) != 4)
653 return AVERROR(EINVAL);
655 if (filter < 0 || filter >= s->nb_filters)
656 return AVERROR(EINVAL);
658 if (freq < 0 || freq > inlink->sample_rate / 2.0)
659 return AVERROR(EINVAL);
661 s->filters[filter].freq = freq;
662 s->filters[filter].width = width;
663 s->filters[filter].gain = gain;
664 equalizer(&s->filters[filter], inlink->sample_rate);
666 draw_curves(ctx, inlink, s->video);
674 static inline double section_process(FoSection *S, double in)
679 out+= S->b1 * S->num[0] - S->denum[0] * S->a1;
680 out+= S->b2 * S->num[1] - S->denum[1] * S->a2;
681 out+= S->b3 * S->num[2] - S->denum[2] * S->a3;
682 out+= S->b4 * S->num[3] - S->denum[3] * S->a4;
684 S->num[3] = S->num[2];
685 S->num[2] = S->num[1];
686 S->num[1] = S->num[0];
689 S->denum[3] = S->denum[2];
690 S->denum[2] = S->denum[1];
691 S->denum[1] = S->denum[0];
697 static double process_sample(FoSection *s1, double in)
702 for (i = 0; i < FILTER_ORDER / 2; i++) {
703 p1 = section_process(&s1[i], p0);
710 static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
712 AVFilterContext *ctx = inlink->dst;
713 AudioNEqualizerContext *s = ctx->priv;
714 AVFilterLink *outlink = ctx->outputs[0];
718 for (i = 0; i < s->nb_filters; i++) {
719 EqualizatorFilter *f = &s->filters[i];
721 if (f->gain == 0. || f->ignore)
724 bptr = (double *)buf->extended_data[f->channel];
725 for (n = 0; n < buf->nb_samples; n++) {
726 double sample = bptr[n];
728 sample = process_sample(f->section, sample);
733 if (s->draw_curves) {
734 const int64_t pts = buf->pts +
735 av_rescale_q(buf->nb_samples, (AVRational){ 1, inlink->sample_rate },
740 ret = ff_filter_frame(ctx->outputs[1], av_frame_clone(s->video));
745 return ff_filter_frame(outlink, buf);
748 static const AVFilterPad inputs[] = {
751 .type = AVMEDIA_TYPE_AUDIO,
752 .config_props = config_input,
753 .filter_frame = filter_frame,
759 AVFilter ff_af_anequalizer = {
760 .name = "anequalizer",
761 .description = NULL_IF_CONFIG_SMALL("Apply high-order audio parametric multi band equalizer."),
762 .priv_size = sizeof(AudioNEqualizerContext),
763 .priv_class = &anequalizer_class,
766 .query_formats = query_formats,
769 .flags = AVFILTER_FLAG_DYNAMIC_OUTPUTS,
770 .process_command = process_command,