2 * Copyright (c) 2015 Paul B Mahol
4 * This file is part of FFmpeg.
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.
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.
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
24 #include "libavcodec/avfft.h"
25 #include "libavutil/audio_fifo.h"
26 #include "libavutil/avassert.h"
27 #include "libavutil/avstring.h"
28 #include "libavutil/channel_layout.h"
29 #include "libavutil/intreadwrite.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/parseutils.h"
37 #include "window_func.h"
39 enum DisplayMode { LINE, BAR, DOT, NB_MODES };
40 enum ChannelMode { COMBINED, SEPARATE, NB_CMODES };
41 enum FrequencyScale { FS_LINEAR, FS_LOG, FS_RLOG, NB_FSCALES };
42 enum AmplitudeScale { AS_LINEAR, AS_SQRT, AS_CBRT, AS_LOG, NB_ASCALES };
44 typedef struct ShowFreqsContext {
54 FFTComplex **fft_data;
56 float *window_func_lut;
69 #define OFFSET(x) offsetof(ShowFreqsContext, x)
70 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
72 static const AVOption showfreqs_options[] = {
73 { "size", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "1024x512"}, 0, 0, FLAGS },
74 { "s", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "1024x512"}, 0, 0, FLAGS },
75 { "mode", "set display mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=BAR}, 0, NB_MODES-1, FLAGS, "mode" },
76 { "line", "show lines", 0, AV_OPT_TYPE_CONST, {.i64=LINE}, 0, 0, FLAGS, "mode" },
77 { "bar", "show bars", 0, AV_OPT_TYPE_CONST, {.i64=BAR}, 0, 0, FLAGS, "mode" },
78 { "dot", "show dots", 0, AV_OPT_TYPE_CONST, {.i64=DOT}, 0, 0, FLAGS, "mode" },
79 { "ascale", "set amplitude scale", OFFSET(ascale), AV_OPT_TYPE_INT, {.i64=AS_LOG}, 0, NB_ASCALES-1, FLAGS, "ascale" },
80 { "lin", "linear", 0, AV_OPT_TYPE_CONST, {.i64=AS_LINEAR}, 0, 0, FLAGS, "ascale" },
81 { "sqrt", "square root", 0, AV_OPT_TYPE_CONST, {.i64=AS_SQRT}, 0, 0, FLAGS, "ascale" },
82 { "cbrt", "cubic root", 0, AV_OPT_TYPE_CONST, {.i64=AS_CBRT}, 0, 0, FLAGS, "ascale" },
83 { "log", "logarithmic", 0, AV_OPT_TYPE_CONST, {.i64=AS_LOG}, 0, 0, FLAGS, "ascale" },
84 { "fscale", "set frequency scale", OFFSET(fscale), AV_OPT_TYPE_INT, {.i64=FS_LINEAR}, 0, NB_FSCALES-1, FLAGS, "fscale" },
85 { "lin", "linear", 0, AV_OPT_TYPE_CONST, {.i64=FS_LINEAR}, 0, 0, FLAGS, "fscale" },
86 { "log", "logarithmic", 0, AV_OPT_TYPE_CONST, {.i64=FS_LOG}, 0, 0, FLAGS, "fscale" },
87 { "rlog", "reverse logarithmic", 0, AV_OPT_TYPE_CONST, {.i64=FS_RLOG}, 0, 0, FLAGS, "fscale" },
88 { "win_size", "set window size", OFFSET(fft_bits), AV_OPT_TYPE_INT, {.i64=11}, 4, 16, FLAGS, "fft" },
89 { "w16", 0, 0, AV_OPT_TYPE_CONST, {.i64=4}, 0, 0, FLAGS, "fft" },
90 { "w32", 0, 0, AV_OPT_TYPE_CONST, {.i64=5}, 0, 0, FLAGS, "fft" },
91 { "w64", 0, 0, AV_OPT_TYPE_CONST, {.i64=6}, 0, 0, FLAGS, "fft" },
92 { "w128", 0, 0, AV_OPT_TYPE_CONST, {.i64=7}, 0, 0, FLAGS, "fft" },
93 { "w256", 0, 0, AV_OPT_TYPE_CONST, {.i64=8}, 0, 0, FLAGS, "fft" },
94 { "w512", 0, 0, AV_OPT_TYPE_CONST, {.i64=9}, 0, 0, FLAGS, "fft" },
95 { "w1024", 0, 0, AV_OPT_TYPE_CONST, {.i64=10}, 0, 0, FLAGS, "fft" },
96 { "w2048", 0, 0, AV_OPT_TYPE_CONST, {.i64=11}, 0, 0, FLAGS, "fft" },
97 { "w4096", 0, 0, AV_OPT_TYPE_CONST, {.i64=12}, 0, 0, FLAGS, "fft" },
98 { "w8192", 0, 0, AV_OPT_TYPE_CONST, {.i64=13}, 0, 0, FLAGS, "fft" },
99 { "w16384", 0, 0, AV_OPT_TYPE_CONST, {.i64=14}, 0, 0, FLAGS, "fft" },
100 { "w32768", 0, 0, AV_OPT_TYPE_CONST, {.i64=15}, 0, 0, FLAGS, "fft" },
101 { "w65536", 0, 0, AV_OPT_TYPE_CONST, {.i64=16}, 0, 0, FLAGS, "fft" },
102 { "win_func", "set window function", OFFSET(win_func), AV_OPT_TYPE_INT, {.i64=WFUNC_HANNING}, 0, NB_WFUNC-1, FLAGS, "win_func" },
103 { "rect", "Rectangular", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_RECT}, 0, 0, FLAGS, "win_func" },
104 { "bartlett", "Bartlett", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BARTLETT}, 0, 0, FLAGS, "win_func" },
105 { "hanning", "Hanning", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_HANNING}, 0, 0, FLAGS, "win_func" },
106 { "hamming", "Hamming", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_HAMMING}, 0, 0, FLAGS, "win_func" },
107 { "blackman", "Blackman", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BLACKMAN}, 0, 0, FLAGS, "win_func" },
108 { "welch", "Welch", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_WELCH}, 0, 0, FLAGS, "win_func" },
109 { "flattop", "Flat-top", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_FLATTOP}, 0, 0, FLAGS, "win_func" },
110 { "bharris", "Blackman-Harris", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BHARRIS}, 0, 0, FLAGS, "win_func" },
111 { "bnuttall", "Blackman-Nuttall", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BNUTTALL}, 0, 0, FLAGS, "win_func" },
112 { "bhann", "Bartlett-Hann", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BHANN}, 0, 0, FLAGS, "win_func" },
113 { "sine", "Sine", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_SINE}, 0, 0, FLAGS, "win_func" },
114 { "nuttall", "Nuttall", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_NUTTALL}, 0, 0, FLAGS, "win_func" },
115 { "lanczos", "Lanczos", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_LANCZOS}, 0, 0, FLAGS, "win_func" },
116 { "gauss", "Gauss", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_GAUSS}, 0, 0, FLAGS, "win_func" },
117 { "tukey", "Tukey", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_TUKEY}, 0, 0, FLAGS, "win_func" },
118 { "dolph", "Dolph-Chebyshev", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_DOLPH}, 0, 0, FLAGS, "win_func" },
119 { "cauchy", "Cauchy", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_CAUCHY}, 0, 0, FLAGS, "win_func" },
120 { "parzen", "Parzen", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_PARZEN}, 0, 0, FLAGS, "win_func" },
121 { "poisson", "Poisson", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_POISSON}, 0, 0, FLAGS, "win_func" },
122 { "bohman", "Bohman", 0, AV_OPT_TYPE_CONST, {.i64=WFUNC_BOHMAN} , 0, 0, FLAGS, "win_func" },
123 { "overlap", "set window overlap", OFFSET(overlap), AV_OPT_TYPE_FLOAT, {.dbl=1.}, 0., 1., FLAGS },
124 { "averaging", "set time averaging", OFFSET(avg), AV_OPT_TYPE_INT, {.i64=1}, 0, INT32_MAX, FLAGS },
125 { "colors", "set channels colors", OFFSET(colors), AV_OPT_TYPE_STRING, {.str = "red|green|blue|yellow|orange|lime|pink|magenta|brown" }, 0, 0, FLAGS },
126 { "cmode", "set channel mode", OFFSET(cmode), AV_OPT_TYPE_INT, {.i64=COMBINED}, 0, NB_CMODES-1, FLAGS, "cmode" },
127 { "combined", "show all channels in same window", 0, AV_OPT_TYPE_CONST, {.i64=COMBINED}, 0, 0, FLAGS, "cmode" },
128 { "separate", "show each channel in own window", 0, AV_OPT_TYPE_CONST, {.i64=SEPARATE}, 0, 0, FLAGS, "cmode" },
129 { "minamp", "set minimum amplitude", OFFSET(minamp), AV_OPT_TYPE_FLOAT, {.dbl=1e-6}, FLT_MIN, 1e-6, FLAGS },
133 AVFILTER_DEFINE_CLASS(showfreqs);
135 static int query_formats(AVFilterContext *ctx)
137 AVFilterFormats *formats = NULL;
138 AVFilterChannelLayouts *layouts = NULL;
139 AVFilterLink *inlink = ctx->inputs[0];
140 AVFilterLink *outlink = ctx->outputs[0];
141 static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_FLTP, AV_SAMPLE_FMT_NONE };
142 static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_RGBA, AV_PIX_FMT_NONE };
145 /* set input audio formats */
146 formats = ff_make_format_list(sample_fmts);
147 if ((ret = ff_formats_ref(formats, &inlink->out_formats)) < 0)
150 layouts = ff_all_channel_layouts();
151 if ((ret = ff_channel_layouts_ref(layouts, &inlink->out_channel_layouts)) < 0)
154 formats = ff_all_samplerates();
155 if ((ret = ff_formats_ref(formats, &inlink->out_samplerates)) < 0)
158 /* set output video format */
159 formats = ff_make_format_list(pix_fmts);
160 if ((ret = ff_formats_ref(formats, &outlink->in_formats)) < 0)
166 static av_cold int init(AVFilterContext *ctx)
168 ShowFreqsContext *s = ctx->priv;
170 s->pts = AV_NOPTS_VALUE;
175 static int config_output(AVFilterLink *outlink)
177 AVFilterContext *ctx = outlink->src;
178 AVFilterLink *inlink = ctx->inputs[0];
179 ShowFreqsContext *s = ctx->priv;
183 s->nb_freq = 1 << (s->fft_bits - 1);
184 s->win_size = s->nb_freq << 1;
185 av_audio_fifo_free(s->fifo);
187 s->fft = av_fft_init(s->fft_bits, 0);
189 av_log(ctx, AV_LOG_ERROR, "Unable to create FFT context. "
190 "The window size might be too high.\n");
191 return AVERROR(ENOMEM);
194 /* FFT buffers: x2 for each (display) channel buffer.
195 * Note: we use free and malloc instead of a realloc-like function to
196 * make sure the buffer is aligned in memory for the FFT functions. */
197 for (i = 0; i < s->nb_channels; i++) {
198 av_freep(&s->fft_data[i]);
199 av_freep(&s->avg_data[i]);
201 av_freep(&s->fft_data);
202 av_freep(&s->avg_data);
203 s->nb_channels = inlink->channels;
205 s->fft_data = av_calloc(s->nb_channels, sizeof(*s->fft_data));
207 return AVERROR(ENOMEM);
208 s->avg_data = av_calloc(s->nb_channels, sizeof(*s->avg_data));
210 return AVERROR(ENOMEM);
211 for (i = 0; i < s->nb_channels; i++) {
212 s->fft_data[i] = av_calloc(s->win_size, sizeof(**s->fft_data));
213 s->avg_data[i] = av_calloc(s->nb_freq, sizeof(**s->avg_data));
214 if (!s->fft_data[i] || !s->avg_data[i])
215 return AVERROR(ENOMEM);
218 /* pre-calc windowing function */
219 s->window_func_lut = av_realloc_f(s->window_func_lut, s->win_size,
220 sizeof(*s->window_func_lut));
221 if (!s->window_func_lut)
222 return AVERROR(ENOMEM);
223 generate_window_func(s->window_func_lut, s->win_size, s->win_func, &overlap);
224 if (s->overlap == 1.)
225 s->overlap = overlap;
226 s->hop_size = (1. - s->overlap) * s->win_size;
227 if (s->hop_size < 1) {
228 av_log(ctx, AV_LOG_ERROR, "overlap %f too big\n", s->overlap);
229 return AVERROR(EINVAL);
232 for (s->scale = 0, i = 0; i < s->win_size; i++) {
233 s->scale += s->window_func_lut[i] * s->window_func_lut[i];
236 outlink->frame_rate = av_make_q(inlink->sample_rate, s->win_size * (1.-s->overlap));
237 outlink->sample_aspect_ratio = (AVRational){1,1};
241 s->fifo = av_audio_fifo_alloc(inlink->format, inlink->channels, s->win_size);
243 return AVERROR(ENOMEM);
247 static inline void draw_dot(AVFrame *out, int x, int y, uint8_t fg[4])
250 uint32_t color = AV_RL32(out->data[0] + y * out->linesize[0] + x * 4);
252 if ((color & 0xffffff) != 0)
253 AV_WL32(out->data[0] + y * out->linesize[0] + x * 4, AV_RL32(fg) | color);
255 AV_WL32(out->data[0] + y * out->linesize[0] + x * 4, AV_RL32(fg));
258 static int get_sx(ShowFreqsContext *s, int f)
262 return (s->w/(float)s->nb_freq)*f;
264 return s->w-pow(s->w, (s->nb_freq-f-1)/(s->nb_freq-1.));
266 return pow(s->w, f/(s->nb_freq-1.));
272 static float get_bsize(ShowFreqsContext *s, int f)
276 return s->w/(float)s->nb_freq;
278 return pow(s->w, (s->nb_freq-f-1)/(s->nb_freq-1.))-
279 pow(s->w, (s->nb_freq-f-2)/(s->nb_freq-1.));
281 return pow(s->w, (f+1)/(s->nb_freq-1.))-
282 pow(s->w, f /(s->nb_freq-1.));
288 static inline void plot_freq(ShowFreqsContext *s, int ch,
289 double a, int f, uint8_t fg[4], int *prev_y,
290 AVFrame *out, AVFilterLink *outlink)
293 const float min = s->minamp;
294 const float avg = s->avg_data[ch][f];
295 const float bsize = get_bsize(s, f);
296 const int sx = get_sx(s, f);
297 int end = outlink->h;
308 a = log(av_clipd(a, min, 1)) / log(min);
317 y = a * outlink->h - 1;
320 end = (outlink->h / s->nb_channels) * (ch + 1);
321 y = (outlink->h / s->nb_channels) * ch + a * (outlink->h / s->nb_channels) - 1;
331 y = s->avg_data[ch][f] = !outlink->frame_count_in ? y : FFMIN(avg, y);
336 s->avg_data[ch][f] = avg + y * (y - avg) / (FFMIN(outlink->frame_count_in + 1, s->avg) * y);
337 y = s->avg_data[ch][f];
347 for (x = sx + 1; x < sx + bsize && x < w; x++)
348 draw_dot(out, x, y, fg);
349 for (i = y; i <= *prev_y; i++)
350 draw_dot(out, sx, i, fg);
352 for (i = *prev_y; i <= y; i++)
353 draw_dot(out, sx, i, fg);
354 for (x = sx + 1; x < sx + bsize && x < w; x++)
355 draw_dot(out, x, i - 1, fg);
360 for (x = sx; x < sx + bsize && x < w; x++)
361 for (i = y; i < end; i++)
362 draw_dot(out, x, i, fg);
365 for (x = sx; x < sx + bsize && x < w; x++)
366 draw_dot(out, x, y, fg);
371 static int plot_freqs(AVFilterLink *inlink, AVFrame *in)
373 AVFilterContext *ctx = inlink->dst;
374 AVFilterLink *outlink = ctx->outputs[0];
375 ShowFreqsContext *s = ctx->priv;
376 const int win_size = s->win_size;
377 char *colors, *color, *saveptr = NULL;
381 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
383 return AVERROR(ENOMEM);
385 for (n = 0; n < outlink->h; n++)
386 memset(out->data[0] + out->linesize[0] * n, 0, outlink->w * 4);
388 /* fill FFT input with the number of samples available */
389 for (ch = 0; ch < s->nb_channels; ch++) {
390 const float *p = (float *)in->extended_data[ch];
392 for (n = 0; n < in->nb_samples; n++) {
393 s->fft_data[ch][n].re = p[n] * s->window_func_lut[n];
394 s->fft_data[ch][n].im = 0;
396 for (; n < win_size; n++) {
397 s->fft_data[ch][n].re = 0;
398 s->fft_data[ch][n].im = 0;
402 /* run FFT on each samples set */
403 for (ch = 0; ch < s->nb_channels; ch++) {
404 av_fft_permute(s->fft, s->fft_data[ch]);
405 av_fft_calc(s->fft, s->fft_data[ch]);
408 #define RE(x, ch) s->fft_data[ch][x].re
409 #define IM(x, ch) s->fft_data[ch][x].im
410 #define M(a, b) (sqrt((a) * (a) + (b) * (b)))
412 colors = av_strdup(s->colors);
415 return AVERROR(ENOMEM);
418 for (ch = 0; ch < s->nb_channels; ch++) {
419 uint8_t fg[4] = { 0xff, 0xff, 0xff, 0xff };
423 color = av_strtok(ch == 0 ? colors : NULL, " |", &saveptr);
425 av_parse_color(fg, color, -1, ctx);
427 a = av_clipd(M(RE(0, ch), 0) / s->scale, 0, 1);
428 plot_freq(s, ch, a, 0, fg, &prev_y, out, outlink);
430 for (f = 1; f < s->nb_freq; f++) {
431 a = av_clipd(M(RE(f, ch), IM(f, ch)) / s->scale, 0, 1);
433 plot_freq(s, ch, a, f, fg, &prev_y, out, outlink);
439 out->sample_aspect_ratio = (AVRational){1,1};
440 return ff_filter_frame(outlink, out);
443 static int filter_frame(AVFilterLink *inlink)
445 AVFilterContext *ctx = inlink->dst;
446 ShowFreqsContext *s = ctx->priv;
450 fin = ff_get_audio_buffer(inlink, s->win_size);
452 ret = AVERROR(ENOMEM);
457 s->pts += s->hop_size;
458 ret = av_audio_fifo_peek(s->fifo, (void **)fin->extended_data, s->win_size);
462 ret = plot_freqs(inlink, fin);
464 av_audio_fifo_drain(s->fifo, s->hop_size);
471 static int activate(AVFilterContext *ctx)
473 AVFilterLink *inlink = ctx->inputs[0];
474 AVFilterLink *outlink = ctx->outputs[0];
475 ShowFreqsContext *s = ctx->priv;
479 FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink);
481 if (av_audio_fifo_size(s->fifo) < s->win_size)
482 ret = ff_inlink_consume_samples(inlink, s->win_size, s->win_size, &in);
486 av_audio_fifo_write(s->fifo, (void **)in->extended_data, in->nb_samples);
487 if (s->pts == AV_NOPTS_VALUE)
491 if (av_audio_fifo_size(s->fifo) >= s->win_size) {
492 ret = filter_frame(inlink);
497 FF_FILTER_FORWARD_STATUS(inlink, outlink);
498 FF_FILTER_FORWARD_WANTED(outlink, inlink);
500 return FFERROR_NOT_READY;
503 static av_cold void uninit(AVFilterContext *ctx)
505 ShowFreqsContext *s = ctx->priv;
509 for (i = 0; i < s->nb_channels; i++) {
511 av_freep(&s->fft_data[i]);
513 av_freep(&s->avg_data[i]);
515 av_freep(&s->fft_data);
516 av_freep(&s->avg_data);
517 av_freep(&s->window_func_lut);
518 av_audio_fifo_free(s->fifo);
521 static const AVFilterPad showfreqs_inputs[] = {
524 .type = AVMEDIA_TYPE_AUDIO,
529 static const AVFilterPad showfreqs_outputs[] = {
532 .type = AVMEDIA_TYPE_VIDEO,
533 .config_props = config_output,
538 AVFilter ff_avf_showfreqs = {
540 .description = NULL_IF_CONFIG_SMALL("Convert input audio to a frequencies video output."),
543 .query_formats = query_formats,
544 .priv_size = sizeof(ShowFreqsContext),
545 .activate = activate,
546 .inputs = showfreqs_inputs,
547 .outputs = showfreqs_outputs,
548 .priv_class = &showfreqs_class,