pan: move query_formats() to avoid forward declarations.
[ffmpeg.git] / libavfilter / af_pan.c
1 /*
2  * Copyright (c) 2002 Anders Johansson <ajh@atri.curtin.edu.au>
3  * Copyright (c) 2011 Clément Bœsch <ubitux@gmail.com>
4  * Copyright (c) 2011 Nicolas George <nicolas.george@normalesup.org>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * Audio panning filter (channels mixing)
26  * Original code written by Anders Johansson for MPlayer,
27  * reimplemented for FFmpeg.
28  */
29
30 #include <stdio.h>
31 #include "libavutil/audioconvert.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/opt.h"
34 #include "libswresample/swresample.h"
35 #include "avfilter.h"
36 #include "internal.h"
37
38 #define MAX_CHANNELS 63
39
40 typedef struct PanContext {
41     int64_t out_channel_layout;
42     union {
43         double d[MAX_CHANNELS][MAX_CHANNELS];
44         // i is 1:7:8 fixed-point, i.e. in [-128*256; +128*256[
45         int    i[MAX_CHANNELS][MAX_CHANNELS];
46     } gain;
47     int64_t need_renorm;
48     int need_renumber;
49     int nb_input_channels;
50     int nb_output_channels;
51
52     int pure_gains;
53     void (*filter_samples)(struct PanContext*,
54                            AVFilterBufferRef*,
55                            AVFilterBufferRef*,
56                            int);
57
58     /* channel mapping specific */
59     int channel_map[SWR_CH_MAX];
60     struct SwrContext *swr;
61 } PanContext;
62
63 static int parse_channel_name(char **arg, int *rchannel, int *rnamed)
64 {
65     char buf[8];
66     int len, i, channel_id;
67     int64_t layout, layout0;
68
69     if (sscanf(*arg, " %7[A-Z] %n", buf, &len)) {
70         layout0 = layout = av_get_channel_layout(buf);
71         for (i = 32; i > 0; i >>= 1) {
72             if (layout >= (int64_t)1 << i) {
73                 channel_id += i;
74                 layout >>= i;
75             }
76         }
77         if (channel_id >= MAX_CHANNELS || layout0 != (int64_t)1 << channel_id)
78             return AVERROR(EINVAL);
79         *rchannel = channel_id;
80         *rnamed = 1;
81         *arg += len;
82         return 0;
83     }
84     if (sscanf(*arg, " c%d %n", &channel_id, &len) &&
85         channel_id >= 0 && channel_id < MAX_CHANNELS) {
86         *rchannel = channel_id;
87         *rnamed = 0;
88         *arg += len;
89         return 0;
90     }
91     return AVERROR(EINVAL);
92 }
93
94 static void skip_spaces(char **arg)
95 {
96     int len = 0;
97
98     sscanf(*arg, " %n", &len);
99     *arg += len;
100 }
101
102 static av_cold int init(AVFilterContext *ctx, const char *args0, void *opaque)
103 {
104     PanContext *const pan = ctx->priv;
105     char *arg, *arg0, *tokenizer, *args = av_strdup(args0);
106     int out_ch_id, in_ch_id, len, named;
107     int nb_in_channels[2] = { 0, 0 }; // number of unnamed and named input channels
108     double gain;
109
110     if (!args0) {
111         av_log(ctx, AV_LOG_ERROR,
112                "pan filter needs a channel layout and a set "
113                "of channels definitions as parameter\n");
114         return AVERROR(EINVAL);
115     }
116     if (!args)
117         return AVERROR(ENOMEM);
118     arg = av_strtok(args, ":", &tokenizer);
119     pan->out_channel_layout = av_get_channel_layout(arg);
120     if (!pan->out_channel_layout) {
121         av_log(ctx, AV_LOG_ERROR, "Unknown channel layout \"%s\"\n", arg);
122         return AVERROR(EINVAL);
123     }
124     pan->nb_output_channels = av_get_channel_layout_nb_channels(pan->out_channel_layout);
125
126     /* parse channel specifications */
127     while ((arg = arg0 = av_strtok(NULL, ":", &tokenizer))) {
128         /* channel name */
129         if (parse_channel_name(&arg, &out_ch_id, &named)) {
130             av_log(ctx, AV_LOG_ERROR,
131                    "Expected out channel name, got \"%.8s\"\n", arg);
132             return AVERROR(EINVAL);
133         }
134         if (named) {
135             if (!((pan->out_channel_layout >> out_ch_id) & 1)) {
136                 av_log(ctx, AV_LOG_ERROR,
137                        "Channel \"%.8s\" does not exist in the chosen layout\n", arg0);
138                 return AVERROR(EINVAL);
139             }
140             /* get the channel number in the output channel layout:
141              * out_channel_layout & ((1 << out_ch_id) - 1) are all the
142              * channels that come before out_ch_id,
143              * so their count is the index of out_ch_id */
144             out_ch_id = av_get_channel_layout_nb_channels(pan->out_channel_layout & (((int64_t)1 << out_ch_id) - 1));
145         }
146         if (out_ch_id < 0 || out_ch_id >= pan->nb_output_channels) {
147             av_log(ctx, AV_LOG_ERROR,
148                    "Invalid out channel name \"%.8s\"\n", arg0);
149             return AVERROR(EINVAL);
150         }
151         if (*arg == '=') {
152             arg++;
153         } else if (*arg == '<') {
154             pan->need_renorm |= (int64_t)1 << out_ch_id;
155             arg++;
156         } else {
157             av_log(ctx, AV_LOG_ERROR,
158                    "Syntax error after channel name in \"%.8s\"\n", arg0);
159             return AVERROR(EINVAL);
160         }
161         /* gains */
162         while (1) {
163             gain = 1;
164             if (sscanf(arg, " %lf %n* %n", &gain, &len, &len))
165                 arg += len;
166             if (parse_channel_name(&arg, &in_ch_id, &named)){
167                 av_log(ctx, AV_LOG_ERROR,
168                        "Expected in channel name, got \"%.8s\"\n", arg);
169                 return AVERROR(EINVAL);
170             }
171             nb_in_channels[named]++;
172             if (nb_in_channels[!named]) {
173                 av_log(ctx, AV_LOG_ERROR,
174                        "Can not mix named and numbered channels\n");
175                 return AVERROR(EINVAL);
176             }
177             pan->gain.d[out_ch_id][in_ch_id] = gain;
178             if (!*arg)
179                 break;
180             if (*arg != '+') {
181                 av_log(ctx, AV_LOG_ERROR, "Syntax error near \"%.8s\"\n", arg);
182                 return AVERROR(EINVAL);
183             }
184             arg++;
185             skip_spaces(&arg);
186         }
187     }
188     pan->need_renumber = !!nb_in_channels[1];
189
190     av_free(args);
191     return 0;
192 }
193
194 static int are_gains_pure(const PanContext *pan)
195 {
196     int i, j;
197
198     for (i = 0; i < MAX_CHANNELS; i++) {
199         int nb_gain = 0;
200
201         for (j = 0; j < MAX_CHANNELS; j++) {
202             double gain = pan->gain.d[i][j];
203
204             /* channel mapping is effective only if 0% or 100% of a channel is
205              * selected... */
206             if (gain != 0. && gain != 1.)
207                 return 0;
208             /* ...and if the output channel is only composed of one input */
209             if (gain && nb_gain++)
210                 return 0;
211         }
212     }
213     return 1;
214 }
215
216 static int config_props(AVFilterLink *link)
217 {
218     AVFilterContext *ctx = link->dst;
219     PanContext *pan = ctx->priv;
220     char buf[1024], *cur;
221     int i, j, k, r;
222     double t;
223
224     pan->nb_input_channels = av_get_channel_layout_nb_channels(link->channel_layout);
225     if (pan->need_renumber) {
226         // input channels were given by their name: renumber them
227         for (i = j = 0; i < MAX_CHANNELS; i++) {
228             if ((link->channel_layout >> i) & 1) {
229                 for (k = 0; k < pan->nb_output_channels; k++)
230                     pan->gain.d[k][j] = pan->gain.d[k][i];
231                 j++;
232             }
233         }
234     }
235     // gains are pure, init the channel mapping
236     if (pan->pure_gains) {
237
238         // sanity check; can't be done in query_formats since the inlink
239         // channel layout is unknown at that time
240         if (pan->nb_input_channels > SWR_CH_MAX) {
241             av_log(ctx, AV_LOG_ERROR,
242                    "libswresample support a maximum of %d channels. "
243                    "Feel free to ask for a higher limit.\n", SWR_CH_MAX);
244             return AVERROR_PATCHWELCOME;
245         }
246
247         // get channel map from the pure gains
248         for (i = 0; i < pan->nb_output_channels; i++) {
249             int ch_id = -1;
250             for (j = 0; j < pan->nb_input_channels; j++) {
251                 if (pan->gain.d[i][j]) {
252                     ch_id = j;
253                     break;
254                 }
255             }
256             pan->channel_map[i] = ch_id;
257         }
258
259         // init libswresample context
260         pan->swr = swr_alloc_set_opts(pan->swr,
261                                       pan->out_channel_layout, link->format, link->sample_rate,
262                                       link->channel_layout,    link->format, link->sample_rate,
263                                       0, ctx);
264         if (!pan->swr)
265             return AVERROR(ENOMEM);
266         av_opt_set_int(pan->swr, "icl", pan->out_channel_layout, 0);
267         av_opt_set_int(pan->swr, "uch", pan->nb_output_channels, 0);
268         swr_set_channel_mapping(pan->swr, pan->channel_map);
269         r = swr_init(pan->swr);
270         if (r < 0)
271             return r;
272     } else {
273         // renormalize
274         for (i = 0; i < pan->nb_output_channels; i++) {
275             if (!((pan->need_renorm >> i) & 1))
276                 continue;
277             t = 0;
278             for (j = 0; j < pan->nb_input_channels; j++)
279                 t += pan->gain.d[i][j];
280             if (t > -1E-5 && t < 1E-5) {
281                 // t is almost 0 but not exactly, this is probably a mistake
282                 if (t)
283                     av_log(ctx, AV_LOG_WARNING,
284                            "Degenerate coefficients while renormalizing\n");
285                 continue;
286             }
287             for (j = 0; j < pan->nb_input_channels; j++)
288                 pan->gain.d[i][j] /= t;
289         }
290     }
291     // summary
292     for (i = 0; i < pan->nb_output_channels; i++) {
293         cur = buf;
294         for (j = 0; j < pan->nb_input_channels; j++) {
295             r = snprintf(cur, buf + sizeof(buf) - cur, "%s%.3g i%d",
296                          j ? " + " : "", pan->gain.d[i][j], j);
297             cur += FFMIN(buf + sizeof(buf) - cur, r);
298         }
299         av_log(ctx, AV_LOG_INFO, "o%d = %s\n", i, buf);
300     }
301     // add channel mapping summary if possible
302     if (pan->pure_gains) {
303         av_log(ctx, AV_LOG_INFO, "Pure channel mapping detected:");
304         for (i = 0; i < pan->nb_output_channels; i++)
305             if (pan->channel_map[i] < 0)
306                 av_log(ctx, AV_LOG_INFO, " M");
307             else
308                 av_log(ctx, AV_LOG_INFO, " %d", pan->channel_map[i]);
309         av_log(ctx, AV_LOG_INFO, "\n");
310         return 0;
311     }
312     // convert to integer
313     for (i = 0; i < pan->nb_output_channels; i++) {
314         for (j = 0; j < pan->nb_input_channels; j++) {
315             if (pan->gain.d[i][j] < -128 || pan->gain.d[i][j] > 128)
316                 av_log(ctx, AV_LOG_WARNING,
317                     "Gain #%d->#%d too large, clamped\n", j, i);
318             pan->gain.i[i][j] = av_clipf(pan->gain.d[i][j], -128, 128) * 256.0;
319         }
320     }
321     return 0;
322 }
323
324 static void filter_samples_channel_mapping(PanContext *pan,
325                                            AVFilterBufferRef *outsamples,
326                                            AVFilterBufferRef *insamples,
327                                            int n)
328 {
329     swr_convert(pan->swr, outsamples->data, n, (void *)insamples->data, n);
330 }
331
332 static void filter_samples_panning(PanContext *pan,
333                                    AVFilterBufferRef *outsamples,
334                                    AVFilterBufferRef *insamples,
335                                    int n)
336 {
337     int i, o;
338
339     /* input */
340     const int16_t *in     = (int16_t *)insamples->data[0];
341     const int16_t *in_end = in + n * pan->nb_input_channels;
342
343     /* output */
344     int16_t *out = (int16_t *)outsamples->data[0];
345
346     for (; in < in_end; in += pan->nb_input_channels) {
347         for (o = 0; o < pan->nb_output_channels; o++) {
348             int v = 0;
349             for (i = 0; i < pan->nb_input_channels; i++)
350                 v += pan->gain.i[o][i] * in[i];
351             *(out++) = v >> 8;
352         }
353     }
354 }
355
356 static void filter_samples(AVFilterLink *inlink, AVFilterBufferRef *insamples)
357 {
358     int n = insamples->audio->nb_samples;
359     AVFilterLink *const outlink = inlink->dst->outputs[0];
360     AVFilterBufferRef *outsamples = avfilter_get_audio_buffer(outlink, AV_PERM_WRITE, n);
361     PanContext *pan = inlink->dst->priv;
362
363     pan->filter_samples(pan, outsamples, insamples, n);
364
365     avfilter_filter_samples(outlink, outsamples);
366     avfilter_unref_buffer(insamples);
367 }
368
369 static int query_formats(AVFilterContext *ctx)
370 {
371     PanContext *pan = ctx->priv;
372     AVFilterLink *inlink  = ctx->inputs[0];
373     AVFilterLink *outlink = ctx->outputs[0];
374     AVFilterFormats *formats;
375
376     if (pan->nb_output_channels <= SWR_CH_MAX)
377         pan->pure_gains = are_gains_pure(pan);
378     if (pan->pure_gains) {
379         /* libswr supports any sample and packing formats */
380         avfilter_set_common_sample_formats(ctx, avfilter_make_all_formats(AVMEDIA_TYPE_AUDIO));
381         avfilter_set_common_packing_formats(ctx, avfilter_make_all_packing_formats());
382         pan->filter_samples = filter_samples_channel_mapping;
383     } else {
384         const enum AVSampleFormat sample_fmts[] = {AV_SAMPLE_FMT_S16, -1};
385         const int                packing_fmts[] = {AVFILTER_PACKED,   -1};
386
387         avfilter_set_common_sample_formats (ctx, avfilter_make_format_list(sample_fmts));
388         avfilter_set_common_packing_formats(ctx, avfilter_make_format_list(packing_fmts));
389         pan->filter_samples = filter_samples_panning;
390     }
391
392     // inlink supports any channel layout
393     formats = avfilter_make_all_channel_layouts();
394     avfilter_formats_ref(formats, &inlink->out_chlayouts);
395
396     // outlink supports only requested output channel layout
397     formats = NULL;
398     avfilter_add_format(&formats, pan->out_channel_layout);
399     avfilter_formats_ref(formats, &outlink->in_chlayouts);
400     return 0;
401 }
402
403 static av_cold void uninit(AVFilterContext *ctx)
404 {
405     PanContext *pan = ctx->priv;
406     swr_free(&pan->swr);
407 }
408
409 AVFilter avfilter_af_pan = {
410     .name          = "pan",
411     .description   = NULL_IF_CONFIG_SMALL("Remix channels with coefficients (panning)."),
412     .priv_size     = sizeof(PanContext),
413     .init          = init,
414     .uninit        = uninit,
415     .query_formats = query_formats,
416
417     .inputs    = (const AVFilterPad[]) {
418         { .name             = "default",
419           .type             = AVMEDIA_TYPE_AUDIO,
420           .config_props     = config_props,
421           .filter_samples   = filter_samples,
422           .min_perms        = AV_PERM_READ, },
423         { .name = NULL}
424     },
425     .outputs   = (const AVFilterPad[]) {
426         { .name             = "default",
427           .type             = AVMEDIA_TYPE_AUDIO, },
428         { .name = NULL}
429     },
430 };