af_channelmap: properly set the supported output channel layouts
[ffmpeg.git] / libavfilter / af_channelmap.c
1 /*
2  * Copyright (c) 2012 Google, Inc.
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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 channel mapping filter
24  */
25
26 #include <ctype.h>
27
28 #include "libavutil/avstring.h"
29 #include "libavutil/channel_layout.h"
30 #include "libavutil/common.h"
31 #include "libavutil/mathematics.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/samplefmt.h"
34
35 #include "audio.h"
36 #include "avfilter.h"
37 #include "formats.h"
38 #include "internal.h"
39
40 struct ChannelMap {
41     uint64_t in_channel;
42     uint64_t out_channel;
43     int in_channel_idx;
44     int out_channel_idx;
45 };
46
47 enum MappingMode {
48     MAP_NONE,
49     MAP_ONE_INT,
50     MAP_ONE_STR,
51     MAP_PAIR_INT_INT,
52     MAP_PAIR_INT_STR,
53     MAP_PAIR_STR_INT,
54     MAP_PAIR_STR_STR
55 };
56
57 #define MAX_CH 64
58 typedef struct ChannelMapContext {
59     const AVClass *class;
60     char *mapping_str;
61     char *channel_layout_str;
62     uint64_t output_layout;
63     struct ChannelMap map[MAX_CH];
64     int nch;
65     enum MappingMode mode;
66 } ChannelMapContext;
67
68 #define OFFSET(x) offsetof(ChannelMapContext, x)
69 #define A AV_OPT_FLAG_AUDIO_PARAM
70 static const AVOption options[] = {
71     { "map", "A comma-separated list of input channel numbers in output order.",
72           OFFSET(mapping_str),        AV_OPT_TYPE_STRING, .flags = A },
73     { "channel_layout", "Output channel layout.",
74           OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, .flags = A },
75     { NULL },
76 };
77
78 static const AVClass channelmap_class = {
79     .class_name = "channel map filter",
80     .item_name  = av_default_item_name,
81     .option     = options,
82     .version    = LIBAVUTIL_VERSION_INT,
83 };
84
85 static char* split(char *message, char delim) {
86     char *next = strchr(message, delim);
87     if (next)
88       *next++ = '\0';
89     return next;
90 }
91
92 static int get_channel_idx(char **map, int *ch, char delim, int max_ch)
93 {
94     char *next = split(*map, delim);
95     int len;
96     int n = 0;
97     if (!next && delim == '-')
98         return AVERROR(EINVAL);
99     len = strlen(*map);
100     sscanf(*map, "%d%n", ch, &n);
101     if (n != len)
102         return AVERROR(EINVAL);
103     if (*ch < 0 || *ch > max_ch)
104         return AVERROR(EINVAL);
105     *map = next;
106     return 0;
107 }
108
109 static int get_channel(char **map, uint64_t *ch, char delim)
110 {
111     char *next = split(*map, delim);
112     if (!next && delim == '-')
113         return AVERROR(EINVAL);
114     *ch = av_get_channel_layout(*map);
115     if (av_get_channel_layout_nb_channels(*ch) != 1)
116         return AVERROR(EINVAL);
117     *map = next;
118     return 0;
119 }
120
121 static av_cold int channelmap_init(AVFilterContext *ctx)
122 {
123     ChannelMapContext *s = ctx->priv;
124     char *mapping, separator = '|';
125     int map_entries = 0;
126     char buf[256];
127     enum MappingMode mode;
128     uint64_t out_ch_mask = 0;
129     int i;
130
131     mapping = s->mapping_str;
132
133     if (!mapping) {
134         mode = MAP_NONE;
135     } else {
136         char *dash = strchr(mapping, '-');
137         if (!dash) {  // short mapping
138             if (av_isdigit(*mapping))
139                 mode = MAP_ONE_INT;
140             else
141                 mode = MAP_ONE_STR;
142         } else if (av_isdigit(*mapping)) {
143             if (av_isdigit(*(dash+1)))
144                 mode = MAP_PAIR_INT_INT;
145             else
146                 mode = MAP_PAIR_INT_STR;
147         } else {
148             if (av_isdigit(*(dash+1)))
149                 mode = MAP_PAIR_STR_INT;
150             else
151                 mode = MAP_PAIR_STR_STR;
152         }
153 #if FF_API_OLD_FILTER_OPTS
154         if (strchr(mapping, ',')) {
155             av_log(ctx, AV_LOG_WARNING, "This syntax is deprecated, use "
156                    "'|' to separate the mappings.\n");
157             separator = ',';
158         }
159 #endif
160     }
161
162     if (mode != MAP_NONE) {
163         char *sep = mapping;
164         map_entries = 1;
165         while ((sep = strchr(sep, separator))) {
166             if (*++sep)  // Allow trailing comma
167                 map_entries++;
168         }
169     }
170
171     if (map_entries > MAX_CH) {
172         av_log(ctx, AV_LOG_ERROR, "Too many channels mapped: '%d'.\n", map_entries);
173         return AVERROR(EINVAL);
174     }
175
176     for (i = 0; i < map_entries; i++) {
177         int in_ch_idx = -1, out_ch_idx = -1;
178         uint64_t in_ch = 0, out_ch = 0;
179         static const char err[] = "Failed to parse channel map\n";
180         switch (mode) {
181         case MAP_ONE_INT:
182             if (get_channel_idx(&mapping, &in_ch_idx, separator, MAX_CH) < 0) {
183                 av_log(ctx, AV_LOG_ERROR, err);
184                 return AVERROR(EINVAL);
185             }
186             s->map[i].in_channel_idx  = in_ch_idx;
187             s->map[i].out_channel_idx = i;
188             break;
189         case MAP_ONE_STR:
190             if (get_channel(&mapping, &in_ch, separator) < 0) {
191                 av_log(ctx, AV_LOG_ERROR, err);
192                 return AVERROR(EINVAL);
193             }
194             s->map[i].in_channel      = in_ch;
195             s->map[i].out_channel_idx = i;
196             break;
197         case MAP_PAIR_INT_INT:
198             if (get_channel_idx(&mapping, &in_ch_idx, '-', MAX_CH) < 0 ||
199                 get_channel_idx(&mapping, &out_ch_idx, separator, MAX_CH) < 0) {
200                 av_log(ctx, AV_LOG_ERROR, err);
201                 return AVERROR(EINVAL);
202             }
203             s->map[i].in_channel_idx  = in_ch_idx;
204             s->map[i].out_channel_idx = out_ch_idx;
205             break;
206         case MAP_PAIR_INT_STR:
207             if (get_channel_idx(&mapping, &in_ch_idx, '-', MAX_CH) < 0 ||
208                 get_channel(&mapping, &out_ch, separator) < 0 ||
209                 out_ch & out_ch_mask) {
210                 av_log(ctx, AV_LOG_ERROR, err);
211                 return AVERROR(EINVAL);
212             }
213             s->map[i].in_channel_idx  = in_ch_idx;
214             s->map[i].out_channel     = out_ch;
215             out_ch_mask |= out_ch;
216             break;
217         case MAP_PAIR_STR_INT:
218             if (get_channel(&mapping, &in_ch, '-') < 0 ||
219                 get_channel_idx(&mapping, &out_ch_idx, separator, MAX_CH) < 0) {
220                 av_log(ctx, AV_LOG_ERROR, err);
221                 return AVERROR(EINVAL);
222             }
223             s->map[i].in_channel      = in_ch;
224             s->map[i].out_channel_idx = out_ch_idx;
225             break;
226         case MAP_PAIR_STR_STR:
227             if (get_channel(&mapping, &in_ch, '-') < 0 ||
228                 get_channel(&mapping, &out_ch, separator) < 0 ||
229                 out_ch & out_ch_mask) {
230                 av_log(ctx, AV_LOG_ERROR, err);
231                 return AVERROR(EINVAL);
232             }
233             s->map[i].in_channel = in_ch;
234             s->map[i].out_channel = out_ch;
235             out_ch_mask |= out_ch;
236             break;
237         }
238     }
239     s->mode          = mode;
240     s->nch           = map_entries;
241     s->output_layout = out_ch_mask ? out_ch_mask :
242                        av_get_default_channel_layout(map_entries);
243
244     if (s->channel_layout_str) {
245         uint64_t fmt;
246         if ((fmt = av_get_channel_layout(s->channel_layout_str)) == 0) {
247             av_log(ctx, AV_LOG_ERROR, "Error parsing channel layout: '%s'.\n",
248                    s->channel_layout_str);
249             return AVERROR(EINVAL);
250         }
251         if (mode == MAP_NONE) {
252             int i;
253             s->nch = av_get_channel_layout_nb_channels(fmt);
254             for (i = 0; i < s->nch; i++) {
255                 s->map[i].in_channel_idx  = i;
256                 s->map[i].out_channel_idx = i;
257             }
258         } else if (out_ch_mask && out_ch_mask != fmt) {
259             av_get_channel_layout_string(buf, sizeof(buf), 0, out_ch_mask);
260             av_log(ctx, AV_LOG_ERROR,
261                    "Output channel layout '%s' does not match the list of channel mapped: '%s'.\n",
262                    s->channel_layout_str, buf);
263             return AVERROR(EINVAL);
264         } else if (s->nch != av_get_channel_layout_nb_channels(fmt)) {
265             av_log(ctx, AV_LOG_ERROR,
266                    "Output channel layout %s does not match the number of channels mapped %d.\n",
267                    s->channel_layout_str, s->nch);
268             return AVERROR(EINVAL);
269         }
270         s->output_layout = fmt;
271     }
272     if (!s->output_layout) {
273         av_log(ctx, AV_LOG_ERROR, "Output channel layout is not set and "
274                "cannot be guessed from the maps.\n");
275         return AVERROR(EINVAL);
276     }
277
278     if (mode == MAP_PAIR_INT_STR || mode == MAP_PAIR_STR_STR) {
279         for (i = 0; i < s->nch; i++) {
280             s->map[i].out_channel_idx = av_get_channel_layout_channel_index(
281                 s->output_layout, s->map[i].out_channel);
282         }
283     }
284
285     return 0;
286 }
287
288 static int channelmap_query_formats(AVFilterContext *ctx)
289 {
290     ChannelMapContext *s = ctx->priv;
291     AVFilterChannelLayouts *channel_layouts = NULL;
292
293     ff_add_channel_layout(&channel_layouts, s->output_layout);
294
295     ff_set_common_formats(ctx, ff_planar_sample_fmts());
296     ff_set_common_samplerates(ctx, ff_all_samplerates());
297     ff_channel_layouts_ref(ff_all_channel_layouts(), &ctx->inputs[0]->out_channel_layouts);
298     ff_channel_layouts_ref(channel_layouts,          &ctx->outputs[0]->in_channel_layouts);
299
300     return 0;
301 }
302
303 static int channelmap_filter_frame(AVFilterLink *inlink, AVFrame *buf)
304 {
305     AVFilterContext  *ctx = inlink->dst;
306     AVFilterLink *outlink = ctx->outputs[0];
307     const ChannelMapContext *s = ctx->priv;
308     const int nch_in = av_get_channel_layout_nb_channels(inlink->channel_layout);
309     const int nch_out = s->nch;
310     int ch;
311     uint8_t *source_planes[MAX_CH];
312
313     memcpy(source_planes, buf->extended_data,
314            nch_in * sizeof(source_planes[0]));
315
316     if (nch_out > nch_in) {
317         if (nch_out > FF_ARRAY_ELEMS(buf->data)) {
318             uint8_t **new_extended_data =
319                 av_mallocz(nch_out * sizeof(*buf->extended_data));
320             if (!new_extended_data) {
321                 av_frame_free(&buf);
322                 return AVERROR(ENOMEM);
323             }
324             if (buf->extended_data == buf->data) {
325                 buf->extended_data = new_extended_data;
326             } else {
327                 av_free(buf->extended_data);
328                 buf->extended_data = new_extended_data;
329             }
330         } else if (buf->extended_data != buf->data) {
331             av_free(buf->extended_data);
332             buf->extended_data = buf->data;
333         }
334     }
335
336     for (ch = 0; ch < nch_out; ch++) {
337         buf->extended_data[s->map[ch].out_channel_idx] =
338             source_planes[s->map[ch].in_channel_idx];
339     }
340
341     if (buf->data != buf->extended_data)
342         memcpy(buf->data, buf->extended_data,
343            FFMIN(FF_ARRAY_ELEMS(buf->data), nch_out) * sizeof(buf->data[0]));
344
345     buf->channel_layout = outlink->channel_layout;
346
347     return ff_filter_frame(outlink, buf);
348 }
349
350 static int channelmap_config_input(AVFilterLink *inlink)
351 {
352     AVFilterContext *ctx = inlink->dst;
353     ChannelMapContext *s = ctx->priv;
354     int nb_channels = av_get_channel_layout_nb_channels(inlink->channel_layout);
355     int i, err = 0;
356     const char *channel_name;
357     char layout_name[256];
358
359     for (i = 0; i < s->nch; i++) {
360         struct ChannelMap *m = &s->map[i];
361
362         if (s->mode == MAP_PAIR_STR_INT || s->mode == MAP_PAIR_STR_STR) {
363             m->in_channel_idx = av_get_channel_layout_channel_index(
364                 inlink->channel_layout, m->in_channel);
365         }
366
367         if (m->in_channel_idx < 0 || m->in_channel_idx >= nb_channels) {
368             av_get_channel_layout_string(layout_name, sizeof(layout_name),
369                                          0, inlink->channel_layout);
370             if (m->in_channel) {
371                 channel_name = av_get_channel_name(m->in_channel);
372                 av_log(ctx, AV_LOG_ERROR,
373                        "input channel '%s' not available from input layout '%s'\n",
374                        channel_name, layout_name);
375             } else {
376                 av_log(ctx, AV_LOG_ERROR,
377                        "input channel #%d not available from input layout '%s'\n",
378                        m->in_channel_idx, layout_name);
379             }
380             err = AVERROR(EINVAL);
381         }
382     }
383
384     return err;
385 }
386
387 static const AVFilterPad avfilter_af_channelmap_inputs[] = {
388     {
389         .name           = "default",
390         .type           = AVMEDIA_TYPE_AUDIO,
391         .filter_frame   = channelmap_filter_frame,
392         .config_props   = channelmap_config_input
393     },
394     { NULL }
395 };
396
397 static const AVFilterPad avfilter_af_channelmap_outputs[] = {
398     {
399         .name = "default",
400         .type = AVMEDIA_TYPE_AUDIO
401     },
402     { NULL }
403 };
404
405 AVFilter ff_af_channelmap = {
406     .name          = "channelmap",
407     .description   = NULL_IF_CONFIG_SMALL("Remap audio channels."),
408     .init          = channelmap_init,
409     .query_formats = channelmap_query_formats,
410     .priv_size     = sizeof(ChannelMapContext),
411     .priv_class    = &channelmap_class,
412
413     .inputs        = avfilter_af_channelmap_inputs,
414     .outputs       = avfilter_af_channelmap_outputs,
415 };