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