pan: raise correct error when there is no param specified.
[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 "avfilter.h"
34 #include "internal.h"
35
36 #define MAX_CHANNELS 63
37
38 typedef struct {
39     int64_t out_channel_layout;
40     union {
41         double d[MAX_CHANNELS][MAX_CHANNELS];
42         // i is 1:7:8 fixed-point, i.e. in [-128*256; +128*256[
43         int    i[MAX_CHANNELS][MAX_CHANNELS];
44     } gain;
45     int64_t need_renorm;
46     int need_renumber;
47     int nb_input_channels;
48     int nb_output_channels;
49 } PanContext;
50
51 static int parse_channel_name(char **arg, int *rchannel, int *rnamed)
52 {
53     char buf[8];
54     int len, i, channel_id;
55     int64_t layout, layout0;
56
57     if (sscanf(*arg, " %7[A-Z] %n", buf, &len)) {
58         layout0 = layout = av_get_channel_layout(buf);
59         for (i = 32; i > 0; i >>= 1) {
60             if (layout >= (int64_t)1 << i) {
61                 channel_id += i;
62                 layout >>= i;
63             }
64         }
65         if (channel_id >= MAX_CHANNELS || layout0 != (int64_t)1 << channel_id)
66             return AVERROR(EINVAL);
67         *rchannel = channel_id;
68         *rnamed = 1;
69         *arg += len;
70         return 0;
71     }
72     if (sscanf(*arg, " c%d %n", &channel_id, &len) &&
73         channel_id >= 0 && channel_id < MAX_CHANNELS) {
74         *rchannel = channel_id;
75         *rnamed = 0;
76         *arg += len;
77         return 0;
78     }
79     return AVERROR(EINVAL);
80 }
81
82 static void skip_spaces(char **arg)
83 {
84     int len = 0;
85
86     sscanf(*arg, " %n", &len);
87     *arg += len;
88 }
89
90 static av_cold int init(AVFilterContext *ctx, const char *args0, void *opaque)
91 {
92     PanContext *const pan = ctx->priv;
93     char *arg, *arg0, *tokenizer, *args = av_strdup(args0);
94     int out_ch_id, in_ch_id, len, named;
95     int nb_in_channels[2] = { 0, 0 }; // number of unnamed and named input channels
96     double gain;
97
98     if (!args0) {
99         av_log(ctx, AV_LOG_ERROR,
100                "pan filter needs a channel layout and a set "
101                "of channels definitions as parameter\n");
102         return AVERROR(EINVAL);
103     }
104     if (!args)
105         return AVERROR(ENOMEM);
106     arg = av_strtok(args, ":", &tokenizer);
107     pan->out_channel_layout = av_get_channel_layout(arg);
108     if (!pan->out_channel_layout) {
109         av_log(ctx, AV_LOG_ERROR, "Unknown channel layout \"%s\"\n", arg);
110         return AVERROR(EINVAL);
111     }
112     pan->nb_output_channels = av_get_channel_layout_nb_channels(pan->out_channel_layout);
113
114     /* parse channel specifications */
115     while ((arg = arg0 = av_strtok(NULL, ":", &tokenizer))) {
116         /* channel name */
117         if (parse_channel_name(&arg, &out_ch_id, &named)) {
118             av_log(ctx, AV_LOG_ERROR,
119                    "Expected out channel name, got \"%.8s\"\n", arg);
120             return AVERROR(EINVAL);
121         }
122         if (named) {
123             if (!((pan->out_channel_layout >> out_ch_id) & 1)) {
124                 av_log(ctx, AV_LOG_ERROR,
125                        "Channel \"%.8s\" does not exist in the chosen layout\n", arg0);
126                 return AVERROR(EINVAL);
127             }
128             /* get the channel number in the output channel layout:
129              * out_channel_layout & ((1 << out_ch_id) - 1) are all the
130              * channels that come before out_ch_id,
131              * so their count is the index of out_ch_id */
132             out_ch_id = av_get_channel_layout_nb_channels(pan->out_channel_layout & (((int64_t)1 << out_ch_id) - 1));
133         }
134         if (out_ch_id < 0 || out_ch_id >= pan->nb_output_channels) {
135             av_log(ctx, AV_LOG_ERROR,
136                    "Invalid out channel name \"%.8s\"\n", arg0);
137             return AVERROR(EINVAL);
138         }
139         if (*arg == '=') {
140             arg++;
141         } else if (*arg == '<') {
142             pan->need_renorm |= (int64_t)1 << out_ch_id;
143             arg++;
144         } else {
145             av_log(ctx, AV_LOG_ERROR,
146                    "Syntax error after channel name in \"%.8s\"\n", arg0);
147             return AVERROR(EINVAL);
148         }
149         /* gains */
150         while (1) {
151             gain = 1;
152             if (sscanf(arg, " %lf %n* %n", &gain, &len, &len))
153                 arg += len;
154             if (parse_channel_name(&arg, &in_ch_id, &named)){
155                 av_log(ctx, AV_LOG_ERROR,
156                        "Expected in channel name, got \"%.8s\"\n", arg);
157                 return AVERROR(EINVAL);
158             }
159             nb_in_channels[named]++;
160             if (nb_in_channels[!named]) {
161                 av_log(ctx, AV_LOG_ERROR,
162                        "Can not mix named and numbered channels\n");
163                 return AVERROR(EINVAL);
164             }
165             pan->gain.d[out_ch_id][in_ch_id] = gain;
166             if (!*arg)
167                 break;
168             if (*arg != '+') {
169                 av_log(ctx, AV_LOG_ERROR, "Syntax error near \"%.8s\"\n", arg);
170                 return AVERROR(EINVAL);
171             }
172             arg++;
173             skip_spaces(&arg);
174         }
175     }
176     pan->need_renumber = !!nb_in_channels[1];
177
178     av_free(args);
179     return 0;
180 }
181
182 static int query_formats(AVFilterContext *ctx)
183 {
184     PanContext *pan = ctx->priv;
185     AVFilterLink *inlink  = ctx->inputs[0];
186     AVFilterLink *outlink = ctx->outputs[0];
187     AVFilterFormats *formats;
188
189     const enum AVSampleFormat sample_fmts[] = {AV_SAMPLE_FMT_S16, -1};
190     const int                packing_fmts[] = {AVFILTER_PACKED,   -1};
191
192     avfilter_set_common_sample_formats (ctx, avfilter_make_format_list(sample_fmts));
193     avfilter_set_common_packing_formats(ctx, avfilter_make_format_list(packing_fmts));
194
195     // inlink supports any channel layout
196     formats = avfilter_make_all_channel_layouts();
197     avfilter_formats_ref(formats, &inlink->out_chlayouts);
198
199     // outlink supports only requested output channel layout
200     formats = NULL;
201     avfilter_add_format(&formats, pan->out_channel_layout);
202     avfilter_formats_ref(formats, &outlink->in_chlayouts);
203     return 0;
204 }
205
206 static int config_props(AVFilterLink *link)
207 {
208     AVFilterContext *ctx = link->dst;
209     PanContext *pan = ctx->priv;
210     char buf[1024], *cur;
211     int i, j, k, r;
212     double t;
213
214     pan->nb_input_channels = av_get_channel_layout_nb_channels(link->channel_layout);
215     if (pan->need_renumber) {
216         // input channels were given by their name: renumber them
217         for (i = j = 0; i < MAX_CHANNELS; i++) {
218             if ((link->channel_layout >> i) & 1) {
219                 for (k = 0; k < pan->nb_output_channels; k++)
220                     pan->gain.d[k][j] = pan->gain.d[k][i];
221                 j++;
222             }
223         }
224     }
225     // renormalize
226     for (i = 0; i < pan->nb_output_channels; i++) {
227         if (!((pan->need_renorm >> i) & 1))
228             continue;
229         t = 0;
230         for (j = 0; j < pan->nb_input_channels; j++)
231             t += pan->gain.d[i][j];
232         if (t > -1E-5 && t < 1E-5) {
233             // t is almost 0 but not exactly, this is probably a mistake
234             if (t)
235                 av_log(ctx, AV_LOG_WARNING,
236                        "Degenerate coefficients while renormalizing\n");
237             continue;
238         }
239         for (j = 0; j < pan->nb_input_channels; j++)
240             pan->gain.d[i][j] /= t;
241     }
242     // summary
243     for (i = 0; i < pan->nb_output_channels; i++) {
244         cur = buf;
245         for (j = 0; j < pan->nb_input_channels; j++) {
246             r = snprintf(cur, buf + sizeof(buf) - cur, "%s%.3g i%d",
247                          j ? " + " : "", pan->gain.d[i][j], j);
248             cur += FFMIN(buf + sizeof(buf) - cur, r);
249         }
250         av_log(ctx, AV_LOG_INFO, "o%d = %s\n", i, buf);
251     }
252     // convert to integer
253     for (i = 0; i < pan->nb_output_channels; i++) {
254         for (j = 0; j < pan->nb_input_channels; j++) {
255             if (pan->gain.d[i][j] < -128 || pan->gain.d[i][j] > 128)
256                 av_log(ctx, AV_LOG_WARNING,
257                     "Gain #%d->#%d too large, clamped\n", j, i);
258             pan->gain.i[i][j] = av_clipf(pan->gain.d[i][j], -128, 128) * 256.0;
259         }
260     }
261     return 0;
262 }
263
264
265 static void filter_samples(AVFilterLink *inlink, AVFilterBufferRef *insamples)
266 {
267     PanContext *const pan = inlink->dst->priv;
268     int i, o, n = insamples->audio->nb_samples;
269
270     /* input */
271     const int16_t *in     = (int16_t *)insamples->data[0];
272     const int16_t *in_end = in + n * pan->nb_input_channels;
273
274     /* output */
275     AVFilterLink *const outlink = inlink->dst->outputs[0];
276     AVFilterBufferRef *outsamples = avfilter_get_audio_buffer(outlink, AV_PERM_WRITE, n);
277     int16_t *out = (int16_t *)outsamples->data[0];
278
279     for (; in < in_end; in += pan->nb_input_channels) {
280         for (o = 0; o < pan->nb_output_channels; o++) {
281             int v = 0;
282             for (i = 0; i < pan->nb_input_channels; i++)
283                 v += pan->gain.i[o][i] * in[i];
284             *(out++) = v >> 8;
285         }
286     }
287
288     avfilter_filter_samples(outlink, outsamples);
289     avfilter_unref_buffer(insamples);
290 }
291
292 AVFilter avfilter_af_pan = {
293     .name          = "pan",
294     .description   = NULL_IF_CONFIG_SMALL("Remix channels with coefficients (panning)."),
295     .priv_size     = sizeof(PanContext),
296     .init          = init,
297     .query_formats = query_formats,
298
299     .inputs    = (const AVFilterPad[]) {
300         { .name             = "default",
301           .type             = AVMEDIA_TYPE_AUDIO,
302           .config_props     = config_props,
303           .filter_samples   = filter_samples,
304           .min_perms        = AV_PERM_READ, },
305         { .name = NULL}
306     },
307     .outputs   = (const AVFilterPad[]) {
308         { .name             = "default",
309           .type             = AVMEDIA_TYPE_AUDIO, },
310         { .name = NULL}
311     },
312 };