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