lavfi/avf_showspectrum: remove looping on request_frame().
[ffmpeg.git] / libavfilter / avf_showspectrum.c
1 /*
2  * Copyright (c) 2012-2013 Clément Bœsch
3  * Copyright (c) 2013 Rudolf Polzer <divverent@xonotic.org>
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * audio to spectrum (video) transmedia filter, based on ffplay rdft showmode
25  * (by Michael Niedermayer) and lavfi/avf_showwaves (by Stefano Sabatini).
26  */
27
28 #include <math.h>
29
30 #include "libavcodec/avfft.h"
31 #include "libavutil/avassert.h"
32 #include "libavutil/channel_layout.h"
33 #include "libavutil/opt.h"
34 #include "avfilter.h"
35 #include "internal.h"
36
37 enum DisplayMode  { COMBINED, SEPARATE, NB_MODES };
38 enum DisplayScale { LINEAR, SQRT, CBRT, LOG, NB_SCALES };
39 enum ColorMode    { CHANNEL, INTENSITY, NB_CLMODES };
40 enum WindowFunc   { WFUNC_NONE, WFUNC_HANN, WFUNC_HAMMING, WFUNC_BLACKMAN, NB_WFUNC };
41 enum SlideMode    { REPLACE, SCROLL, FULLFRAME, NB_SLIDES };
42
43 typedef struct {
44     const AVClass *class;
45     int w, h;
46     AVFrame *outpicref;
47     int nb_display_channels;
48     int channel_height;
49     int sliding;                ///< 1 if sliding mode, 0 otherwise
50     int mode;                   ///< channel display mode
51     int color_mode;             ///< display color scheme
52     int scale;
53     float saturation;           ///< color saturation multiplier
54     int xpos;                   ///< x position (current column)
55     RDFTContext *rdft;          ///< Real Discrete Fourier Transform context
56     int rdft_bits;              ///< number of bits (RDFT window size = 1<<rdft_bits)
57     FFTSample **rdft_data;      ///< bins holder for each (displayed) channels
58     float *window_func_lut;     ///< Window function LUT
59     int win_func;
60     float *combine_buffer;      ///< color combining buffer (3 * h items)
61 } ShowSpectrumContext;
62
63 #define OFFSET(x) offsetof(ShowSpectrumContext, x)
64 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
65
66 static const AVOption showspectrum_options[] = {
67     { "size", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "640x512"}, 0, 0, FLAGS },
68     { "s",    "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "640x512"}, 0, 0, FLAGS },
69     { "slide", "set sliding mode", OFFSET(sliding), AV_OPT_TYPE_INT, {.i64 = 0}, 0, NB_SLIDES, FLAGS, "slide" },
70         { "replace", "replace old columns with new", 0, AV_OPT_TYPE_CONST, {.i64=REPLACE}, 0, 0, FLAGS, "slide" },
71         { "scroll", "scroll from right to left", 0, AV_OPT_TYPE_CONST, {.i64=SCROLL}, 0, 0, FLAGS, "slide" },
72         { "fullframe", "return full frames", 0, AV_OPT_TYPE_CONST, {.i64=FULLFRAME}, 0, 0, FLAGS, "slide" },
73     { "mode", "set channel display mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=COMBINED}, COMBINED, NB_MODES-1, FLAGS, "mode" },
74         { "combined", "combined mode", 0, AV_OPT_TYPE_CONST, {.i64=COMBINED}, 0, 0, FLAGS, "mode" },
75         { "separate", "separate mode", 0, AV_OPT_TYPE_CONST, {.i64=SEPARATE}, 0, 0, FLAGS, "mode" },
76     { "color", "set channel coloring", OFFSET(color_mode), AV_OPT_TYPE_INT, {.i64=CHANNEL}, CHANNEL, NB_CLMODES-1, FLAGS, "color" },
77         { "channel",   "separate color for each channel", 0, AV_OPT_TYPE_CONST, {.i64=CHANNEL},   0, 0, FLAGS, "color" },
78         { "intensity", "intensity based coloring",        0, AV_OPT_TYPE_CONST, {.i64=INTENSITY}, 0, 0, FLAGS, "color" },
79     { "scale", "set display scale", OFFSET(scale), AV_OPT_TYPE_INT, {.i64=SQRT}, LINEAR, NB_SCALES-1, FLAGS, "scale" },
80         { "sqrt", "square root", 0, AV_OPT_TYPE_CONST, {.i64=SQRT},   0, 0, FLAGS, "scale" },
81         { "cbrt", "cubic root",  0, AV_OPT_TYPE_CONST, {.i64=CBRT},   0, 0, FLAGS, "scale" },
82         { "log",  "logarithmic", 0, AV_OPT_TYPE_CONST, {.i64=LOG},    0, 0, FLAGS, "scale" },
83         { "lin",  "linear",      0, AV_OPT_TYPE_CONST, {.i64=LINEAR}, 0, 0, FLAGS, "scale" },
84     { "saturation", "color saturation multiplier", OFFSET(saturation), AV_OPT_TYPE_FLOAT, {.dbl = 1}, -10, 10, FLAGS },
85     { "win_func", "set window function", OFFSET(win_func), AV_OPT_TYPE_INT, {.i64 = WFUNC_HANN}, 0, NB_WFUNC-1, FLAGS, "win_func" },
86         { "hann",     "Hann window",     0, AV_OPT_TYPE_CONST, {.i64 = WFUNC_HANN},     0, 0, FLAGS, "win_func" },
87         { "hamming",  "Hamming window",  0, AV_OPT_TYPE_CONST, {.i64 = WFUNC_HAMMING},  0, 0, FLAGS, "win_func" },
88         { "blackman", "Blackman window", 0, AV_OPT_TYPE_CONST, {.i64 = WFUNC_BLACKMAN}, 0, 0, FLAGS, "win_func" },
89     { NULL }
90 };
91
92 AVFILTER_DEFINE_CLASS(showspectrum);
93
94 static const struct {
95     float a, y, u, v;
96 } intensity_color_table[] = {
97     {    0,                  0,                  0,                   0 },
98     { 0.13, .03587126228984074,  .1573300977624594, -.02548747583751842 },
99     { 0.30, .18572281794568020,  .1772436246393981,  .17475554840414750 },
100     { 0.60, .28184980583656130, -.1593064119945782,  .47132074554608920 },
101     { 0.73, .65830621175547810, -.3716070802232764,  .24352759331252930 },
102     { 0.78, .76318535758242900, -.4307467689263783,  .16866496622310430 },
103     { 0.91, .95336363636363640, -.2045454545454546,  .03313636363636363 },
104     {    1,                  1,                  0,                   0 }
105 };
106
107 static av_cold void uninit(AVFilterContext *ctx)
108 {
109     ShowSpectrumContext *s = ctx->priv;
110     int i;
111
112     av_freep(&s->combine_buffer);
113     av_rdft_end(s->rdft);
114     for (i = 0; i < s->nb_display_channels; i++)
115         av_freep(&s->rdft_data[i]);
116     av_freep(&s->rdft_data);
117     av_freep(&s->window_func_lut);
118     av_frame_free(&s->outpicref);
119 }
120
121 static int query_formats(AVFilterContext *ctx)
122 {
123     AVFilterFormats *formats = NULL;
124     AVFilterChannelLayouts *layouts = NULL;
125     AVFilterLink *inlink = ctx->inputs[0];
126     AVFilterLink *outlink = ctx->outputs[0];
127     static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_S16P, AV_SAMPLE_FMT_NONE };
128     static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_NONE };
129
130     /* set input audio formats */
131     formats = ff_make_format_list(sample_fmts);
132     if (!formats)
133         return AVERROR(ENOMEM);
134     ff_formats_ref(formats, &inlink->out_formats);
135
136     layouts = ff_all_channel_layouts();
137     if (!layouts)
138         return AVERROR(ENOMEM);
139     ff_channel_layouts_ref(layouts, &inlink->out_channel_layouts);
140
141     formats = ff_all_samplerates();
142     if (!formats)
143         return AVERROR(ENOMEM);
144     ff_formats_ref(formats, &inlink->out_samplerates);
145
146     /* set output video format */
147     formats = ff_make_format_list(pix_fmts);
148     if (!formats)
149         return AVERROR(ENOMEM);
150     ff_formats_ref(formats, &outlink->in_formats);
151
152     return 0;
153 }
154
155 static int config_output(AVFilterLink *outlink)
156 {
157     AVFilterContext *ctx = outlink->src;
158     AVFilterLink *inlink = ctx->inputs[0];
159     ShowSpectrumContext *s = ctx->priv;
160     int i, rdft_bits, win_size, h;
161
162     outlink->w = s->w;
163     outlink->h = s->h;
164
165     h = (s->mode == COMBINED) ? outlink->h : outlink->h / inlink->channels;
166     s->channel_height = h;
167
168     /* RDFT window size (precision) according to the requested output frame height */
169     for (rdft_bits = 1; 1 << rdft_bits < 2 * h; rdft_bits++);
170     win_size = 1 << rdft_bits;
171
172     /* (re-)configuration if the video output changed (or first init) */
173     if (rdft_bits != s->rdft_bits) {
174         AVFrame *outpicref;
175
176         av_rdft_end(s->rdft);
177         s->rdft = av_rdft_init(rdft_bits, DFT_R2C);
178         if (!s->rdft) {
179             av_log(ctx, AV_LOG_ERROR, "Unable to create RDFT context. "
180                    "The window size might be too high.\n");
181             return AVERROR(EINVAL);
182         }
183         s->rdft_bits = rdft_bits;
184
185         /* RDFT buffers: x2 for each (display) channel buffer.
186          * Note: we use free and malloc instead of a realloc-like function to
187          * make sure the buffer is aligned in memory for the FFT functions. */
188         for (i = 0; i < s->nb_display_channels; i++)
189             av_freep(&s->rdft_data[i]);
190         av_freep(&s->rdft_data);
191         s->nb_display_channels = inlink->channels;
192
193         s->rdft_data = av_calloc(s->nb_display_channels, sizeof(*s->rdft_data));
194         if (!s->rdft_data)
195             return AVERROR(ENOMEM);
196         for (i = 0; i < s->nb_display_channels; i++) {
197             s->rdft_data[i] = av_calloc(win_size, sizeof(**s->rdft_data));
198             if (!s->rdft_data[i])
199                 return AVERROR(ENOMEM);
200         }
201
202         /* pre-calc windowing function */
203         s->window_func_lut =
204             av_realloc_f(s->window_func_lut, win_size,
205                          sizeof(*s->window_func_lut));
206         if (!s->window_func_lut)
207             return AVERROR(ENOMEM);
208         switch (s->win_func) {
209         case WFUNC_NONE:
210             for (i = 0; i < win_size; i++)
211                 s->window_func_lut[i] = 1.;
212             break;
213         case WFUNC_HANN:
214             for (i = 0; i < win_size; i++)
215                 s->window_func_lut[i] = .5f * (1 - cos(2*M_PI*i / (win_size-1)));
216             break;
217         case WFUNC_HAMMING:
218             for (i = 0; i < win_size; i++)
219                 s->window_func_lut[i] = .54f - .46f * cos(2*M_PI*i / (win_size-1));
220             break;
221         case WFUNC_BLACKMAN: {
222             for (i = 0; i < win_size; i++)
223                 s->window_func_lut[i] = .42f - .5f*cos(2*M_PI*i / (win_size-1)) + .08f*cos(4*M_PI*i / (win_size-1));
224             break;
225         }
226         default:
227             av_assert0(0);
228         }
229
230         /* prepare the initial picref buffer (black frame) */
231         av_frame_free(&s->outpicref);
232         s->outpicref = outpicref =
233             ff_get_video_buffer(outlink, outlink->w, outlink->h);
234         if (!outpicref)
235             return AVERROR(ENOMEM);
236         outlink->sample_aspect_ratio = (AVRational){1,1};
237         for (i = 0; i < outlink->h; i++) {
238             memset(outpicref->data[0] + i * outpicref->linesize[0],   0, outlink->w);
239             memset(outpicref->data[1] + i * outpicref->linesize[1], 128, outlink->w);
240             memset(outpicref->data[2] + i * outpicref->linesize[2], 128, outlink->w);
241         }
242     }
243
244     if (s->xpos >= outlink->w)
245         s->xpos = 0;
246
247     outlink->frame_rate = av_make_q(inlink->sample_rate, win_size);
248     if (s->sliding == FULLFRAME)
249         outlink->frame_rate.den *= outlink->w;
250
251     inlink->min_samples = inlink->max_samples = inlink->partial_buf_size =
252         win_size;
253
254     s->combine_buffer =
255         av_realloc_f(s->combine_buffer, outlink->h * 3,
256                      sizeof(*s->combine_buffer));
257
258     av_log(ctx, AV_LOG_VERBOSE, "s:%dx%d RDFT window size:%d\n",
259            s->w, s->h, win_size);
260     return 0;
261 }
262
263 static int request_frame(AVFilterLink *outlink)
264 {
265     ShowSpectrumContext *s = outlink->src->priv;
266     AVFilterLink *inlink = outlink->src->inputs[0];
267     unsigned i;
268     int ret;
269
270     /* TODO reindent */
271         ret = ff_request_frame(inlink);
272         if (ret == AVERROR_EOF && s->sliding == FULLFRAME && s->xpos > 0 &&
273             s->outpicref) {
274             for (i = 0; i < outlink->h; i++) {
275                 memset(s->outpicref->data[0] + i * s->outpicref->linesize[0] + s->xpos,   0, outlink->w - s->xpos);
276                 memset(s->outpicref->data[1] + i * s->outpicref->linesize[1] + s->xpos, 128, outlink->w - s->xpos);
277                 memset(s->outpicref->data[2] + i * s->outpicref->linesize[2] + s->xpos, 128, outlink->w - s->xpos);
278             }
279             ret = ff_filter_frame(outlink, s->outpicref);
280             s->outpicref = NULL;
281         }
282
283     return ret;
284 }
285
286 static int plot_spectrum_column(AVFilterLink *inlink, AVFrame *insamples)
287 {
288     int ret;
289     AVFilterContext *ctx = inlink->dst;
290     AVFilterLink *outlink = ctx->outputs[0];
291     ShowSpectrumContext *s = ctx->priv;
292     AVFrame *outpicref = s->outpicref;
293
294     /* nb_freq contains the power of two superior or equal to the output image
295      * height (or half the RDFT window size) */
296     const int nb_freq = 1 << (s->rdft_bits - 1);
297     const int win_size = nb_freq << 1;
298     const double w = 1. / (sqrt(nb_freq) * 32768.);
299     int h = s->channel_height;
300
301     int ch, plane, n, y;
302
303     av_assert0(insamples->nb_samples == win_size);
304
305     /* fill RDFT input with the number of samples available */
306     for (ch = 0; ch < s->nb_display_channels; ch++) {
307         const int16_t *p = (int16_t *)insamples->extended_data[ch];
308
309         for (n = 0; n < win_size; n++)
310             s->rdft_data[ch][n] = p[n] * s->window_func_lut[n];
311     }
312
313     /* run RDFT on each samples set */
314     for (ch = 0; ch < s->nb_display_channels; ch++)
315         av_rdft_calc(s->rdft, s->rdft_data[ch]);
316
317     /* fill a new spectrum column */
318 #define RE(y, ch) s->rdft_data[ch][2 * (y) + 0]
319 #define IM(y, ch) s->rdft_data[ch][2 * (y) + 1]
320 #define MAGNITUDE(y, ch) hypot(RE(y, ch), IM(y, ch))
321
322     /* initialize buffer for combining to black */
323     for (y = 0; y < outlink->h; y++) {
324         s->combine_buffer[3 * y    ] = 0;
325         s->combine_buffer[3 * y + 1] = 127.5;
326         s->combine_buffer[3 * y + 2] = 127.5;
327     }
328
329     for (ch = 0; ch < s->nb_display_channels; ch++) {
330         float yf, uf, vf;
331
332         /* decide color range */
333         switch (s->mode) {
334         case COMBINED:
335             // reduce range by channel count
336             yf = 256.0f / s->nb_display_channels;
337             switch (s->color_mode) {
338             case INTENSITY:
339                 uf = yf;
340                 vf = yf;
341                 break;
342             case CHANNEL:
343                 /* adjust saturation for mixed UV coloring */
344                 /* this factor is correct for infinite channels, an approximation otherwise */
345                 uf = yf * M_PI;
346                 vf = yf * M_PI;
347                 break;
348             default:
349                 av_assert0(0);
350             }
351             break;
352         case SEPARATE:
353             // full range
354             yf = 256.0f;
355             uf = 256.0f;
356             vf = 256.0f;
357             break;
358         default:
359             av_assert0(0);
360         }
361
362         if (s->color_mode == CHANNEL) {
363             if (s->nb_display_channels > 1) {
364                 uf *= 0.5 * sin((2 * M_PI * ch) / s->nb_display_channels);
365                 vf *= 0.5 * cos((2 * M_PI * ch) / s->nb_display_channels);
366             } else {
367                 uf = 0.0f;
368                 vf = 0.0f;
369             }
370         }
371         uf *= s->saturation;
372         vf *= s->saturation;
373
374         /* draw the channel */
375         for (y = 0; y < h; y++) {
376             int row = (s->mode == COMBINED) ? y : ch * h + y;
377             float *out = &s->combine_buffer[3 * row];
378
379             /* get magnitude */
380             float a = w * MAGNITUDE(y, ch);
381
382             /* apply scale */
383             switch (s->scale) {
384             case LINEAR:
385                 break;
386             case SQRT:
387                 a = sqrt(a);
388                 break;
389             case CBRT:
390                 a = cbrt(a);
391                 break;
392             case LOG:
393                 a = 1 - log(FFMAX(FFMIN(1, a), 1e-6)) / log(1e-6); // zero = -120dBFS
394                 break;
395             default:
396                 av_assert0(0);
397             }
398
399             if (s->color_mode == INTENSITY) {
400                 float y, u, v;
401                 int i;
402
403                 for (i = 1; i < sizeof(intensity_color_table) / sizeof(*intensity_color_table) - 1; i++)
404                     if (intensity_color_table[i].a >= a)
405                         break;
406                 // i now is the first item >= the color
407                 // now we know to interpolate between item i - 1 and i
408                 if (a <= intensity_color_table[i - 1].a) {
409                     y = intensity_color_table[i - 1].y;
410                     u = intensity_color_table[i - 1].u;
411                     v = intensity_color_table[i - 1].v;
412                 } else if (a >= intensity_color_table[i].a) {
413                     y = intensity_color_table[i].y;
414                     u = intensity_color_table[i].u;
415                     v = intensity_color_table[i].v;
416                 } else {
417                     float start = intensity_color_table[i - 1].a;
418                     float end = intensity_color_table[i].a;
419                     float lerpfrac = (a - start) / (end - start);
420                     y = intensity_color_table[i - 1].y * (1.0f - lerpfrac)
421                       + intensity_color_table[i].y * lerpfrac;
422                     u = intensity_color_table[i - 1].u * (1.0f - lerpfrac)
423                       + intensity_color_table[i].u * lerpfrac;
424                     v = intensity_color_table[i - 1].v * (1.0f - lerpfrac)
425                       + intensity_color_table[i].v * lerpfrac;
426                 }
427
428                 out[0] += y * yf;
429                 out[1] += u * uf;
430                 out[2] += v * vf;
431             } else {
432                 out[0] += a * yf;
433                 out[1] += a * uf;
434                 out[2] += a * vf;
435             }
436         }
437     }
438
439     /* copy to output */
440     if (s->sliding == SCROLL) {
441         for (plane = 0; plane < 3; plane++) {
442             for (y = 0; y < outlink->h; y++) {
443                 uint8_t *p = outpicref->data[plane] +
444                              y * outpicref->linesize[plane];
445                 memmove(p, p + 1, outlink->w - 1);
446             }
447         }
448         s->xpos = outlink->w - 1;
449     }
450     for (plane = 0; plane < 3; plane++) {
451         uint8_t *p = outpicref->data[plane] +
452                      (outlink->h - 1) * outpicref->linesize[plane] +
453                      s->xpos;
454         for (y = 0; y < outlink->h; y++) {
455             *p = rint(FFMAX(0, FFMIN(s->combine_buffer[3 * y + plane], 255)));
456             p -= outpicref->linesize[plane];
457         }
458     }
459
460     if (s->sliding != FULLFRAME || s->xpos == 0)
461         outpicref->pts = insamples->pts;
462
463     s->xpos++;
464     if (s->xpos >= outlink->w)
465         s->xpos = 0;
466     if (s->sliding != FULLFRAME || s->xpos == 0) {
467         ret = ff_filter_frame(outlink, av_frame_clone(s->outpicref));
468         if (ret < 0)
469             return ret;
470     }
471
472     return win_size;
473 }
474
475 static int filter_frame(AVFilterLink *inlink, AVFrame *insamples)
476 {
477     AVFilterContext *ctx = inlink->dst;
478     ShowSpectrumContext *s = ctx->priv;
479     unsigned win_size = 1 << s->rdft_bits;
480     int ret = 0;
481
482     av_assert0(insamples->nb_samples <= win_size);
483     if (insamples->nb_samples == win_size)
484         ret = plot_spectrum_column(inlink, insamples);
485
486     av_frame_free(&insamples);
487     return ret;
488 }
489
490 static const AVFilterPad showspectrum_inputs[] = {
491     {
492         .name         = "default",
493         .type         = AVMEDIA_TYPE_AUDIO,
494         .filter_frame = filter_frame,
495     },
496     { NULL }
497 };
498
499 static const AVFilterPad showspectrum_outputs[] = {
500     {
501         .name          = "default",
502         .type          = AVMEDIA_TYPE_VIDEO,
503         .config_props  = config_output,
504         .request_frame = request_frame,
505     },
506     { NULL }
507 };
508
509 AVFilter ff_avf_showspectrum = {
510     .name          = "showspectrum",
511     .description   = NULL_IF_CONFIG_SMALL("Convert input audio to a spectrum video output."),
512     .uninit        = uninit,
513     .query_formats = query_formats,
514     .priv_size     = sizeof(ShowSpectrumContext),
515     .inputs        = showspectrum_inputs,
516     .outputs       = showspectrum_outputs,
517     .priv_class    = &showspectrum_class,
518 };