lavfi: add showspectrum filter.
[ffmpeg.git] / libavfilter / avf_showspectrum.c
1 /*
2  * Copyright (c) 2012 Clément Bœsch
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 /**
22  * @file
23  * audio to spectrum (video) transmedia filter, based on ffplay rdft showmode
24  * (by Michael Niedermayer) and lavfi/avf_showwaves (by Stefano Sabatini).
25  */
26
27 #include <math.h>
28
29 #include "libavcodec/avfft.h"
30 #include "libavutil/audioconvert.h"
31 #include "libavutil/opt.h"
32 #include "avfilter.h"
33 #include "internal.h"
34
35 typedef struct {
36     const AVClass *class;
37     int w, h;
38     AVFilterBufferRef *outpicref;
39     int req_fullfilled;
40     int xpos;                   ///< x position (current column)
41     RDFTContext *rdft;          ///< Real Discrete Fourier Transform context
42     int rdft_bits;              ///< number of bits (RDFT window size = 1<<rdft_bits)
43     FFTSample *rdft_data;       ///< bins holder for each (displayed) channels
44     int filled;                 ///< number of samples (per channel) filled in current rdft_buffer
45     int consumed;               ///< number of samples (per channel) consumed from the input frame
46     float *window_func_lut;     ///< Window function LUT
47 } ShowSpectrumContext;
48
49 #define OFFSET(x) offsetof(ShowSpectrumContext, x)
50
51 static const AVOption showspectrum_options[] = {
52     { "size", "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "640x480"}, 0, 0 },
53     { "s",    "set video size", OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, {.str = "640x480"}, 0, 0 },
54     { NULL },
55 };
56
57 AVFILTER_DEFINE_CLASS(showspectrum);
58
59 static av_cold int init(AVFilterContext *ctx, const char *args)
60 {
61     ShowSpectrumContext *showspectrum = ctx->priv;
62     int err;
63
64     showspectrum->class = &showspectrum_class;
65     av_opt_set_defaults(showspectrum);
66
67     if ((err = av_set_options_string(showspectrum, args, "=", ":")) < 0)
68         return err;
69
70     return 0;
71 }
72
73 static av_cold void uninit(AVFilterContext *ctx)
74 {
75     ShowSpectrumContext *showspectrum = ctx->priv;
76
77     av_rdft_end(showspectrum->rdft);
78     av_freep(&showspectrum->rdft_data);
79     av_freep(&showspectrum->window_func_lut);
80     avfilter_unref_bufferp(&showspectrum->outpicref);
81 }
82
83 static int query_formats(AVFilterContext *ctx)
84 {
85     AVFilterFormats *formats = NULL;
86     AVFilterChannelLayouts *layouts = NULL;
87     AVFilterLink *inlink = ctx->inputs[0];
88     AVFilterLink *outlink = ctx->outputs[0];
89     static const enum AVSampleFormat sample_fmts[] = { AV_SAMPLE_FMT_S16P, -1 };
90     static const enum PixelFormat pix_fmts[] = { PIX_FMT_RGB24, -1 };
91
92     /* set input audio formats */
93     formats = ff_make_format_list(sample_fmts);
94     if (!formats)
95         return AVERROR(ENOMEM);
96     ff_formats_ref(formats, &inlink->out_formats);
97
98     layouts = ff_all_channel_layouts();
99     if (!layouts)
100         return AVERROR(ENOMEM);
101     ff_channel_layouts_ref(layouts, &inlink->out_channel_layouts);
102
103     formats = ff_all_samplerates();
104     if (!formats)
105         return AVERROR(ENOMEM);
106     ff_formats_ref(formats, &inlink->out_samplerates);
107
108     /* set output video format */
109     formats = ff_make_format_list(pix_fmts);
110     if (!formats)
111         return AVERROR(ENOMEM);
112     ff_formats_ref(formats, &outlink->in_formats);
113
114     return 0;
115 }
116
117 static int config_output(AVFilterLink *outlink)
118 {
119     AVFilterContext *ctx = outlink->src;
120     ShowSpectrumContext *showspectrum = ctx->priv;
121     int i, rdft_bits, win_size;
122
123     outlink->w = showspectrum->w;
124     outlink->h = showspectrum->h;
125
126     /* RDFT window size (precision) according to the requested output frame height */
127     for (rdft_bits = 1; 1<<rdft_bits < 2*outlink->h; rdft_bits++);
128     win_size = 1 << rdft_bits;
129
130     /* (re-)configuration if the video output changed (or first init) */
131     if (rdft_bits != showspectrum->rdft_bits) {
132         AVFilterBufferRef *outpicref;
133
134         av_rdft_end(showspectrum->rdft);
135         showspectrum->rdft = av_rdft_init(rdft_bits, DFT_R2C);
136         showspectrum->rdft_bits = rdft_bits;
137
138         /* RDFT buffers: x2 for each (display) channel buffer */
139         showspectrum->rdft_data =
140             av_realloc_f(showspectrum->rdft_data, 2 * win_size,
141                          sizeof(*showspectrum->rdft_data));
142         if (!showspectrum->rdft_data)
143             return AVERROR(ENOMEM);
144         showspectrum->filled = 0;
145
146         /* pre-calc windowing function (hann here) */
147         showspectrum->window_func_lut =
148             av_realloc_f(showspectrum->window_func_lut, win_size,
149                          sizeof(*showspectrum->window_func_lut));
150         if (!showspectrum->window_func_lut)
151             return AVERROR(ENOMEM);
152         for (i = 0; i < win_size; i++)
153             showspectrum->window_func_lut[i] = .5f * (1 - cos(2*M_PI*i / (win_size-1)));
154
155         /* prepare the initial picref buffer (black frame) */
156         avfilter_unref_bufferp(&showspectrum->outpicref);
157         showspectrum->outpicref = outpicref =
158             ff_get_video_buffer(outlink, AV_PERM_WRITE|AV_PERM_PRESERVE|AV_PERM_REUSE2,
159                                 outlink->w, outlink->h);
160         if (!outpicref)
161             return AVERROR(ENOMEM);
162         outlink->sample_aspect_ratio = (AVRational){1,1};
163         memset(outpicref->data[0], 0, outlink->h * outpicref->linesize[0]);
164     }
165
166     if (showspectrum->xpos >= outlink->w)
167         showspectrum->xpos = 0;
168
169     av_log(ctx, AV_LOG_VERBOSE, "s:%dx%d RDFT window size:%d\n",
170            showspectrum->w, showspectrum->h, win_size);
171     return 0;
172 }
173
174 inline static void push_frame(AVFilterLink *outlink)
175 {
176     ShowSpectrumContext *showspectrum = outlink->src->priv;
177
178     showspectrum->xpos++;
179     if (showspectrum->xpos >= outlink->w)
180         showspectrum->xpos = 0;
181     showspectrum->filled = 0;
182     showspectrum->req_fullfilled = 1;
183
184     ff_start_frame(outlink, avfilter_ref_buffer(showspectrum->outpicref, ~AV_PERM_WRITE));
185     ff_draw_slice(outlink, 0, outlink->h, 1);
186     ff_end_frame(outlink);
187 }
188
189 static int request_frame(AVFilterLink *outlink)
190 {
191     ShowSpectrumContext *showspectrum = outlink->src->priv;
192     AVFilterLink *inlink = outlink->src->inputs[0];
193     int ret;
194
195     showspectrum->req_fullfilled = 0;
196     do {
197         ret = ff_request_frame(inlink);
198     } while (!showspectrum->req_fullfilled && ret >= 0);
199
200     if (ret == AVERROR_EOF && showspectrum->outpicref)
201         push_frame(outlink);
202     return ret;
203 }
204
205 static int plot_spectrum_column(AVFilterLink *inlink, AVFilterBufferRef *insamples, int nb_samples)
206 {
207     AVFilterContext *ctx = inlink->dst;
208     AVFilterLink *outlink = ctx->outputs[0];
209     ShowSpectrumContext *showspectrum = ctx->priv;
210     AVFilterBufferRef *outpicref = showspectrum->outpicref;
211     const int nb_channels = av_get_channel_layout_nb_channels(insamples->audio->channel_layout);
212
213     /* nb_freq contains the power of two superior or equal to the output image
214      * height (or half the RDFT window size) */
215     const int nb_freq = 1 << (showspectrum->rdft_bits - 1);
216     const int win_size = nb_freq << 1;
217
218     int ch, n, y;
219     FFTSample *data[2];
220     const int nb_display_channels = FFMIN(nb_channels, 2);
221     const int start = showspectrum->filled;
222     const int add_samples = FFMIN(win_size - start, nb_samples);
223
224     /* fill RDFT input with the number of samples available */
225     for (ch = 0; ch < nb_display_channels; ch++) {
226         const int16_t *p = (int16_t *)insamples->extended_data[ch];
227
228         p += showspectrum->consumed;
229         data[ch] = showspectrum->rdft_data + win_size * ch; // select channel buffer
230         for (n = 0; n < add_samples; n++)
231             data[ch][start + n] = p[n] * showspectrum->window_func_lut[start + n];
232     }
233     showspectrum->filled += add_samples;
234
235     /* complete RDFT window size? */
236     if (showspectrum->filled == win_size) {
237
238         /* run RDFT on each samples set */
239         for (ch = 0; ch < nb_display_channels; ch++)
240             av_rdft_calc(showspectrum->rdft, data[ch]);
241
242         /* fill a new spectrum column */
243 #define RE(ch) data[ch][2*y + 0]
244 #define IM(ch) data[ch][2*y + 1]
245 #define MAGNITUDE(re, im) sqrt((re)*(re) + (im)*(im))
246
247         for (y = 0; y < outlink->h; y++) {
248             // FIXME: bin[0] contains first and last bins
249             const int pos = showspectrum->xpos * 3 + (outlink->h - y - 1) * outpicref->linesize[0];
250             const double w = 1. / sqrt(nb_freq);
251             int a =                           sqrt(w * MAGNITUDE(RE(0), IM(0)));
252             int b = nb_display_channels > 1 ? sqrt(w * MAGNITUDE(RE(1), IM(1))) : a;
253
254             a = FFMIN(a, 255);
255             b = FFMIN(b, 255);
256             outpicref->data[0][pos]   = a;
257             outpicref->data[0][pos+1] = b;
258             outpicref->data[0][pos+2] = (a + b) / 2;
259         }
260         outpicref->pts = insamples->pts +
261             av_rescale_q(showspectrum->consumed,
262                          (AVRational){ 1, inlink->sample_rate },
263                          outlink->time_base);
264         push_frame(outlink);
265     }
266
267     return add_samples;
268 }
269
270 static int filter_samples(AVFilterLink *inlink, AVFilterBufferRef *insamples)
271 {
272     AVFilterContext *ctx = inlink->dst;
273     ShowSpectrumContext *showspectrum = ctx->priv;
274     int left_samples = insamples->audio->nb_samples;
275
276     showspectrum->consumed = 0;
277     while (left_samples) {
278         const int added_samples = plot_spectrum_column(inlink, insamples, left_samples);
279         showspectrum->consumed += added_samples;
280         left_samples -= added_samples;
281     }
282
283     avfilter_unref_buffer(insamples);
284     return 0;
285 }
286
287 AVFilter avfilter_avf_showspectrum = {
288     .name           = "showspectrum",
289     .description    = NULL_IF_CONFIG_SMALL("Convert input audio to a spectrum video output."),
290     .init           = init,
291     .uninit         = uninit,
292     .query_formats  = query_formats,
293     .priv_size      = sizeof(ShowSpectrumContext),
294
295     .inputs  = (const AVFilterPad[]) {
296         {
297             .name           = "default",
298             .type           = AVMEDIA_TYPE_AUDIO,
299             .filter_samples = filter_samples,
300             .min_perms      = AV_PERM_READ,
301         },
302         { .name = NULL }
303     },
304
305     .outputs = (const AVFilterPad[]) {
306         {
307             .name           = "default",
308             .type           = AVMEDIA_TYPE_VIDEO,
309             .config_props   = config_output,
310             .request_frame  = request_frame,
311         },
312         { .name = NULL }
313     },
314 };