avfilter/showspectrum: add win_func option.
[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, 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     int filled;                 ///< number of samples (per channel) filled in current rdft_buffer
59     int consumed;               ///< number of samples (per channel) consumed from the input frame
60     float *window_func_lut;     ///< Window function LUT
61     enum WindowFunc win_func;
62     float *combine_buffer;      ///< color combining buffer (3 * h items)
63 } ShowSpectrumContext;
64
65 #define OFFSET(x) offsetof(ShowSpectrumContext, x)
66 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
67
68 static const AVOption showspectrum_options[] = {
69     { "size", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "640x512"}, 0, 0, FLAGS },
70     { "s",    "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "640x512"}, 0, 0, FLAGS },
71     { "slide", "set sliding mode", OFFSET(sliding), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, FLAGS },
72     { "mode", "set channel display mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64=COMBINED}, COMBINED, NB_MODES-1, FLAGS, "mode" },
73     { "combined", "combined mode", 0, AV_OPT_TYPE_CONST, {.i64=COMBINED}, 0, 0, FLAGS, "mode" },
74     { "separate", "separate mode", 0, AV_OPT_TYPE_CONST, {.i64=SEPARATE}, 0, 0, FLAGS, "mode" },
75     { "color", "set channel coloring", OFFSET(color_mode), AV_OPT_TYPE_INT, {.i64=CHANNEL}, CHANNEL, NB_CLMODES-1, FLAGS, "color" },
76     { "channel",   "separate color for each channel", 0, AV_OPT_TYPE_CONST, {.i64=CHANNEL},   0, 0, FLAGS, "color" },
77     { "intensity", "intensity based coloring",        0, AV_OPT_TYPE_CONST, {.i64=INTENSITY}, 0, 0, FLAGS, "color" },
78     { "scale", "set display scale", OFFSET(scale), AV_OPT_TYPE_INT, {.i64=SQRT}, LINEAR, NB_SCALES-1, FLAGS, "scale" },
79     { "sqrt", "square root", 0, AV_OPT_TYPE_CONST, {.i64=SQRT},   0, 0, FLAGS, "scale" },
80     { "cbrt", "cubic root",  0, AV_OPT_TYPE_CONST, {.i64=CBRT},   0, 0, FLAGS, "scale" },
81     { "log",  "logarithmic", 0, AV_OPT_TYPE_CONST, {.i64=LOG},    0, 0, FLAGS, "scale" },
82     { "lin",  "linear",      0, AV_OPT_TYPE_CONST, {.i64=LINEAR}, 0, 0, FLAGS, "scale" },
83     { "saturation", "color saturation multiplier", OFFSET(saturation), AV_OPT_TYPE_FLOAT, {.dbl = 1}, -10, 10, FLAGS },
84     { "win_func", "set window function", OFFSET(win_func), AV_OPT_TYPE_INT, {.i64 = WFUNC_HANN}, 0, NB_WFUNC-1, FLAGS, "win_func" },
85         { "hann",    "Hann window",    0, AV_OPT_TYPE_CONST, {.i64 = WFUNC_HANN},    INT_MIN, INT_MAX, FLAGS, "win_func" },
86         { "hamming", "Hamming window", 0, AV_OPT_TYPE_CONST, {.i64 = WFUNC_HAMMING}, INT_MIN, INT_MAX, FLAGS, "win_func" },
87     { NULL }
88 };
89
90 AVFILTER_DEFINE_CLASS(showspectrum);
91
92 static const struct {
93     float a, y, u, v;
94 } intensity_color_table[] = {
95     {    0,                  0,                  0,                   0 },
96     { 0.13, .03587126228984074,  .1573300977624594, -.02548747583751842 },
97     { 0.30, .18572281794568020,  .1772436246393981,  .17475554840414750 },
98     { 0.60, .28184980583656130, -.1593064119945782,  .47132074554608920 },
99     { 0.73, .65830621175547810, -.3716070802232764,  .24352759331252930 },
100     { 0.78, .76318535758242900, -.4307467689263783,  .16866496622310430 },
101     { 0.91, .95336363636363640, -.2045454545454546,  .03313636363636363 },
102     {    1,                  1,                  0,                   0 }
103 };
104
105 static av_cold void uninit(AVFilterContext *ctx)
106 {
107     ShowSpectrumContext *s = ctx->priv;
108     int i;
109
110     av_freep(&s->combine_buffer);
111     av_rdft_end(s->rdft);
112     for (i = 0; i < s->nb_display_channels; i++)
113         av_freep(&s->rdft_data[i]);
114     av_freep(&s->rdft_data);
115     av_freep(&s->window_func_lut);
116     av_frame_free(&s->outpicref);
117 }
118
119 static int query_formats(AVFilterContext *ctx)
120 {
121     AVFilterFormats *formats = NULL;
122     AVFilterChannelLayouts *layouts = NULL;
123     AVFilterLink *inlink = ctx->inputs[0];
124     AVFilterLink *outlink = ctx->outputs[0];
125     static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_S16P, AV_SAMPLE_FMT_NONE };
126     static const enum AVPixelFormat pix_fmts[] = { AV_PIX_FMT_YUVJ444P, AV_PIX_FMT_NONE };
127
128     /* set input audio formats */
129     formats = ff_make_format_list(sample_fmts);
130     if (!formats)
131         return AVERROR(ENOMEM);
132     ff_formats_ref(formats, &inlink->out_formats);
133
134     layouts = ff_all_channel_layouts();
135     if (!layouts)
136         return AVERROR(ENOMEM);
137     ff_channel_layouts_ref(layouts, &inlink->out_channel_layouts);
138
139     formats = ff_all_samplerates();
140     if (!formats)
141         return AVERROR(ENOMEM);
142     ff_formats_ref(formats, &inlink->out_samplerates);
143
144     /* set output video format */
145     formats = ff_make_format_list(pix_fmts);
146     if (!formats)
147         return AVERROR(ENOMEM);
148     ff_formats_ref(formats, &outlink->in_formats);
149
150     return 0;
151 }
152
153 static int config_output(AVFilterLink *outlink)
154 {
155     AVFilterContext *ctx = outlink->src;
156     AVFilterLink *inlink = ctx->inputs[0];
157     ShowSpectrumContext *s = ctx->priv;
158     int i, rdft_bits, win_size, h;
159
160     outlink->w = s->w;
161     outlink->h = s->h;
162
163     h = (s->mode == COMBINED) ? outlink->h : outlink->h / inlink->channels;
164     s->channel_height = h;
165
166     /* RDFT window size (precision) according to the requested output frame height */
167     for (rdft_bits = 1; 1 << rdft_bits < 2 * h; rdft_bits++);
168     win_size = 1 << rdft_bits;
169
170     /* (re-)configuration if the video output changed (or first init) */
171     if (rdft_bits != s->rdft_bits) {
172         size_t rdft_size, rdft_listsize;
173         AVFrame *outpicref;
174
175         av_rdft_end(s->rdft);
176         s->rdft = av_rdft_init(rdft_bits, DFT_R2C);
177         s->rdft_bits = rdft_bits;
178
179         /* RDFT buffers: x2 for each (display) channel buffer.
180          * Note: we use free and malloc instead of a realloc-like function to
181          * make sure the buffer is aligned in memory for the FFT functions. */
182         for (i = 0; i < s->nb_display_channels; i++)
183             av_freep(&s->rdft_data[i]);
184         av_freep(&s->rdft_data);
185         s->nb_display_channels = inlink->channels;
186
187         if (av_size_mult(sizeof(*s->rdft_data),
188                          s->nb_display_channels, &rdft_listsize) < 0)
189             return AVERROR(EINVAL);
190         if (av_size_mult(sizeof(**s->rdft_data),
191                          win_size, &rdft_size) < 0)
192             return AVERROR(EINVAL);
193         s->rdft_data = av_malloc(rdft_listsize);
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_malloc(rdft_size);
198             if (!s->rdft_data[i])
199                 return AVERROR(ENOMEM);
200         }
201         s->filled = 0;
202
203         /* pre-calc windowing function */
204         s->window_func_lut =
205             av_realloc_f(s->window_func_lut, win_size,
206                          sizeof(*s->window_func_lut));
207         if (!s->window_func_lut)
208             return AVERROR(ENOMEM);
209         switch (s->win_func) {
210         case WFUNC_NONE:
211             for (i = 0; i < win_size; i++)
212                 s->window_func_lut[i] = 1.;
213             break;
214         case WFUNC_HANN:
215             for (i = 0; i < win_size; i++)
216                 s->window_func_lut[i] = .5f * (1 - cos(2*M_PI*i / (win_size-1)));
217             break;
218         case WFUNC_HAMMING:
219             for (i = 0; i < win_size; i++)
220                 s->window_func_lut[i] = .54f - .46f * cos(2*M_PI*i / (win_size-1));
221             break;
222         default:
223             av_assert0(0);
224         }
225
226         /* prepare the initial picref buffer (black frame) */
227         av_frame_free(&s->outpicref);
228         s->outpicref = outpicref =
229             ff_get_video_buffer(outlink, outlink->w, outlink->h);
230         if (!outpicref)
231             return AVERROR(ENOMEM);
232         outlink->sample_aspect_ratio = (AVRational){1,1};
233         for (i = 0; i < outlink->h; i++) {
234             memset(outpicref->data[0] + i * outpicref->linesize[0],   0, outlink->w);
235             memset(outpicref->data[1] + i * outpicref->linesize[1], 128, outlink->w);
236             memset(outpicref->data[2] + i * outpicref->linesize[2], 128, outlink->w);
237         }
238     }
239
240     if (s->xpos >= outlink->w)
241         s->xpos = 0;
242
243     s->combine_buffer =
244         av_realloc_f(s->combine_buffer, outlink->h * 3,
245                      sizeof(*s->combine_buffer));
246
247     av_log(ctx, AV_LOG_VERBOSE, "s:%dx%d RDFT window size:%d\n",
248            s->w, s->h, win_size);
249     return 0;
250 }
251
252 inline static int push_frame(AVFilterLink *outlink)
253 {
254     ShowSpectrumContext *s = outlink->src->priv;
255
256     s->xpos++;
257     if (s->xpos >= outlink->w)
258         s->xpos = 0;
259     s->filled = 0;
260     s->req_fullfilled = 1;
261
262     return ff_filter_frame(outlink, av_frame_clone(s->outpicref));
263 }
264
265 static int request_frame(AVFilterLink *outlink)
266 {
267     ShowSpectrumContext *s = outlink->src->priv;
268     AVFilterLink *inlink = outlink->src->inputs[0];
269     int ret;
270
271     s->req_fullfilled = 0;
272     do {
273         ret = ff_request_frame(inlink);
274     } while (!s->req_fullfilled && ret >= 0);
275
276     if (ret == AVERROR_EOF && s->outpicref)
277         push_frame(outlink);
278     return ret;
279 }
280
281 static int plot_spectrum_column(AVFilterLink *inlink, AVFrame *insamples, int nb_samples)
282 {
283     int ret;
284     AVFilterContext *ctx = inlink->dst;
285     AVFilterLink *outlink = ctx->outputs[0];
286     ShowSpectrumContext *s = ctx->priv;
287     AVFrame *outpicref = s->outpicref;
288
289     /* nb_freq contains the power of two superior or equal to the output image
290      * height (or half the RDFT window size) */
291     const int nb_freq = 1 << (s->rdft_bits - 1);
292     const int win_size = nb_freq << 1;
293     const double w = 1. / (sqrt(nb_freq) * 32768.);
294
295     int ch, plane, n, y;
296     const int start = s->filled;
297     const int add_samples = FFMIN(win_size - start, nb_samples);
298
299     /* fill RDFT input with the number of samples available */
300     for (ch = 0; ch < s->nb_display_channels; ch++) {
301         const int16_t *p = (int16_t *)insamples->extended_data[ch];
302
303         p += s->consumed;
304         for (n = 0; n < add_samples; n++)
305             s->rdft_data[ch][start + n] = p[n] * s->window_func_lut[start + n];
306     }
307     s->filled += add_samples;
308
309     /* complete RDFT window size? */
310     if (s->filled == win_size) {
311
312         /* channel height */
313         int h = s->channel_height;
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             av_rescale_q(s->consumed,
464                          (AVRational){ 1, inlink->sample_rate },
465                          outlink->time_base);
466         ret = push_frame(outlink);
467         if (ret < 0)
468             return ret;
469     }
470
471     return add_samples;
472 }
473
474 static int filter_frame(AVFilterLink *inlink, AVFrame *insamples)
475 {
476     AVFilterContext *ctx = inlink->dst;
477     ShowSpectrumContext *s = ctx->priv;
478     int ret = 0, left_samples = insamples->nb_samples;
479
480     s->consumed = 0;
481     while (left_samples) {
482         int ret = plot_spectrum_column(inlink, insamples, left_samples);
483         if (ret < 0)
484             break;
485         s->consumed += ret;
486         left_samples -= ret;
487     }
488
489     av_frame_free(&insamples);
490     return ret;
491 }
492
493 static const AVFilterPad showspectrum_inputs[] = {
494     {
495         .name         = "default",
496         .type         = AVMEDIA_TYPE_AUDIO,
497         .filter_frame = filter_frame,
498     },
499     { NULL }
500 };
501
502 static const AVFilterPad showspectrum_outputs[] = {
503     {
504         .name          = "default",
505         .type          = AVMEDIA_TYPE_VIDEO,
506         .config_props  = config_output,
507         .request_frame = request_frame,
508     },
509     { NULL }
510 };
511
512 AVFilter ff_avf_showspectrum = {
513     .name          = "showspectrum",
514     .description   = NULL_IF_CONFIG_SMALL("Convert input audio to a spectrum video output."),
515     .uninit        = uninit,
516     .query_formats = query_formats,
517     .priv_size     = sizeof(ShowSpectrumContext),
518     .inputs        = showspectrum_inputs,
519     .outputs       = showspectrum_outputs,
520     .priv_class    = &showspectrum_class,
521 };