yading@10: /*
yading@10:  * Copyright (c) 2012 Google, Inc.
yading@10:  *
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or
yading@10:  * modify it under the terms of the GNU Lesser General Public
yading@10:  * License as published by the Free Software Foundation; either
yading@10:  * version 2.1 of the License, or (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@10:  * Lesser General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU Lesser General Public
yading@10:  * License along with FFmpeg; if not, write to the Free Software
yading@10:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@10:  */
yading@10: 
yading@10: /**
yading@10:  * @file
yading@10:  * audio channel mapping filter
yading@10:  */
yading@10: 
yading@10: #include <ctype.h>
yading@10: 
yading@10: #include "libavutil/avstring.h"
yading@10: #include "libavutil/channel_layout.h"
yading@10: #include "libavutil/common.h"
yading@10: #include "libavutil/mathematics.h"
yading@10: #include "libavutil/opt.h"
yading@10: #include "libavutil/samplefmt.h"
yading@10: 
yading@10: #include "audio.h"
yading@10: #include "avfilter.h"
yading@10: #include "formats.h"
yading@10: #include "internal.h"
yading@10: 
yading@10: struct ChannelMap {
yading@10:     uint64_t in_channel;
yading@10:     uint64_t out_channel;
yading@10:     int in_channel_idx;
yading@10:     int out_channel_idx;
yading@10: };
yading@10: 
yading@10: enum MappingMode {
yading@10:     MAP_NONE,
yading@10:     MAP_ONE_INT,
yading@10:     MAP_ONE_STR,
yading@10:     MAP_PAIR_INT_INT,
yading@10:     MAP_PAIR_INT_STR,
yading@10:     MAP_PAIR_STR_INT,
yading@10:     MAP_PAIR_STR_STR
yading@10: };
yading@10: 
yading@10: #define MAX_CH 64
yading@10: typedef struct ChannelMapContext {
yading@10:     const AVClass *class;
yading@10:     AVFilterChannelLayouts *channel_layouts;
yading@10:     char *mapping_str;
yading@10:     char *channel_layout_str;
yading@10:     uint64_t output_layout;
yading@10:     struct ChannelMap map[MAX_CH];
yading@10:     int nch;
yading@10:     enum MappingMode mode;
yading@10: } ChannelMapContext;
yading@10: 
yading@10: #define OFFSET(x) offsetof(ChannelMapContext, x)
yading@10: #define A AV_OPT_FLAG_AUDIO_PARAM
yading@10: #define F AV_OPT_FLAG_FILTERING_PARAM
yading@10: static const AVOption options[] = {
yading@10:     { "map", "A comma-separated list of input channel numbers in output order.",
yading@10:           OFFSET(mapping_str),        AV_OPT_TYPE_STRING, .flags = A|F },
yading@10:     { "channel_layout", "Output channel layout.",
yading@10:           OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, .flags = A|F },
yading@10:     { NULL },
yading@10: };
yading@10: 
yading@10: static const AVClass channelmap_class = {
yading@10:     .class_name = "channel map filter",
yading@10:     .item_name  = av_default_item_name,
yading@10:     .option     = options,
yading@10:     .version    = LIBAVUTIL_VERSION_INT,
yading@10: };
yading@10: 
yading@10: static char* split(char *message, char delim) {
yading@10:     char *next = strchr(message, delim);
yading@10:     if (next)
yading@10:       *next++ = '\0';
yading@10:     return next;
yading@10: }
yading@10: 
yading@10: static int get_channel_idx(char **map, int *ch, char delim, int max_ch)
yading@10: {
yading@10:     char *next = split(*map, delim);
yading@10:     int len;
yading@10:     int n = 0;
yading@10:     if (!next && delim == '-')
yading@10:         return AVERROR(EINVAL);
yading@10:     len = strlen(*map);
yading@10:     sscanf(*map, "%d%n", ch, &n);
yading@10:     if (n != len)
yading@10:         return AVERROR(EINVAL);
yading@10:     if (*ch < 0 || *ch > max_ch)
yading@10:         return AVERROR(EINVAL);
yading@10:     *map = next;
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static int get_channel(char **map, uint64_t *ch, char delim)
yading@10: {
yading@10:     char *next = split(*map, delim);
yading@10:     if (!next && delim == '-')
yading@10:         return AVERROR(EINVAL);
yading@10:     *ch = av_get_channel_layout(*map);
yading@10:     if (av_get_channel_layout_nb_channels(*ch) != 1)
yading@10:         return AVERROR(EINVAL);
yading@10:     *map = next;
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static av_cold int channelmap_init(AVFilterContext *ctx)
yading@10: {
yading@10:     ChannelMapContext *s = ctx->priv;
yading@10:     int ret = 0;
yading@10:     char *mapping, separator = '|';
yading@10:     int map_entries = 0;
yading@10:     char buf[256];
yading@10:     enum MappingMode mode;
yading@10:     uint64_t out_ch_mask = 0;
yading@10:     int i;
yading@10: 
yading@10:     mapping = s->mapping_str;
yading@10: 
yading@10:     if (!mapping) {
yading@10:         mode = MAP_NONE;
yading@10:     } else {
yading@10:         char *dash = strchr(mapping, '-');
yading@10:         if (!dash) {  // short mapping
yading@10:             if (av_isdigit(*mapping))
yading@10:                 mode = MAP_ONE_INT;
yading@10:             else
yading@10:                 mode = MAP_ONE_STR;
yading@10:         } else if (av_isdigit(*mapping)) {
yading@10:             if (av_isdigit(*(dash+1)))
yading@10:                 mode = MAP_PAIR_INT_INT;
yading@10:             else
yading@10:                 mode = MAP_PAIR_INT_STR;
yading@10:         } else {
yading@10:             if (av_isdigit(*(dash+1)))
yading@10:                 mode = MAP_PAIR_STR_INT;
yading@10:             else
yading@10:                 mode = MAP_PAIR_STR_STR;
yading@10:         }
yading@10: #if FF_API_OLD_FILTER_OPTS
yading@10:         if (strchr(mapping, ',')) {
yading@10:             av_log(ctx, AV_LOG_WARNING, "This syntax is deprecated, use "
yading@10:                    "'|' to separate the mappings.\n");
yading@10:             separator = ',';
yading@10:         }
yading@10: #endif
yading@10:     }
yading@10: 
yading@10:     if (mode != MAP_NONE) {
yading@10:         char *sep = mapping;
yading@10:         map_entries = 1;
yading@10:         while ((sep = strchr(sep, separator))) {
yading@10:             if (*++sep)  // Allow trailing comma
yading@10:                 map_entries++;
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     if (map_entries > MAX_CH) {
yading@10:         av_log(ctx, AV_LOG_ERROR, "Too many channels mapped: '%d'.\n", map_entries);
yading@10:         ret = AVERROR(EINVAL);
yading@10:         goto fail;
yading@10:     }
yading@10: 
yading@10:     for (i = 0; i < map_entries; i++) {
yading@10:         int in_ch_idx = -1, out_ch_idx = -1;
yading@10:         uint64_t in_ch = 0, out_ch = 0;
yading@10:         static const char err[] = "Failed to parse channel map\n";
yading@10:         switch (mode) {
yading@10:         case MAP_ONE_INT:
yading@10:             if (get_channel_idx(&mapping, &in_ch_idx, separator, MAX_CH) < 0) {
yading@10:                 ret = AVERROR(EINVAL);
yading@10:                 av_log(ctx, AV_LOG_ERROR, err);
yading@10:                 goto fail;
yading@10:             }
yading@10:             s->map[i].in_channel_idx  = in_ch_idx;
yading@10:             s->map[i].out_channel_idx = i;
yading@10:             break;
yading@10:         case MAP_ONE_STR:
yading@10:             if (!get_channel(&mapping, &in_ch, separator)) {
yading@10:                 av_log(ctx, AV_LOG_ERROR, err);
yading@10:                 ret = AVERROR(EINVAL);
yading@10:                 goto fail;
yading@10:             }
yading@10:             s->map[i].in_channel      = in_ch;
yading@10:             s->map[i].out_channel_idx = i;
yading@10:             break;
yading@10:         case MAP_PAIR_INT_INT:
yading@10:             if (get_channel_idx(&mapping, &in_ch_idx, '-', MAX_CH) < 0 ||
yading@10:                 get_channel_idx(&mapping, &out_ch_idx, separator, MAX_CH) < 0) {
yading@10:                 av_log(ctx, AV_LOG_ERROR, err);
yading@10:                 ret = AVERROR(EINVAL);
yading@10:                 goto fail;
yading@10:             }
yading@10:             s->map[i].in_channel_idx  = in_ch_idx;
yading@10:             s->map[i].out_channel_idx = out_ch_idx;
yading@10:             break;
yading@10:         case MAP_PAIR_INT_STR:
yading@10:             if (get_channel_idx(&mapping, &in_ch_idx, '-', MAX_CH) < 0 ||
yading@10:                 get_channel(&mapping, &out_ch, separator) < 0 ||
yading@10:                 out_ch & out_ch_mask) {
yading@10:                 av_log(ctx, AV_LOG_ERROR, err);
yading@10:                 ret = AVERROR(EINVAL);
yading@10:                 goto fail;
yading@10:             }
yading@10:             s->map[i].in_channel_idx  = in_ch_idx;
yading@10:             s->map[i].out_channel     = out_ch;
yading@10:             out_ch_mask |= out_ch;
yading@10:             break;
yading@10:         case MAP_PAIR_STR_INT:
yading@10:             if (get_channel(&mapping, &in_ch, '-') < 0 ||
yading@10:                 get_channel_idx(&mapping, &out_ch_idx, separator, MAX_CH) < 0) {
yading@10:                 av_log(ctx, AV_LOG_ERROR, err);
yading@10:                 ret = AVERROR(EINVAL);
yading@10:                 goto fail;
yading@10:             }
yading@10:             s->map[i].in_channel      = in_ch;
yading@10:             s->map[i].out_channel_idx = out_ch_idx;
yading@10:             break;
yading@10:         case MAP_PAIR_STR_STR:
yading@10:             if (get_channel(&mapping, &in_ch, '-') < 0 ||
yading@10:                 get_channel(&mapping, &out_ch, separator) < 0 ||
yading@10:                 out_ch & out_ch_mask) {
yading@10:                 av_log(ctx, AV_LOG_ERROR, err);
yading@10:                 ret = AVERROR(EINVAL);
yading@10:                 goto fail;
yading@10:             }
yading@10:             s->map[i].in_channel = in_ch;
yading@10:             s->map[i].out_channel = out_ch;
yading@10:             out_ch_mask |= out_ch;
yading@10:             break;
yading@10:         }
yading@10:     }
yading@10:     s->mode          = mode;
yading@10:     s->nch           = map_entries;
yading@10:     s->output_layout = out_ch_mask ? out_ch_mask :
yading@10:                        av_get_default_channel_layout(map_entries);
yading@10: 
yading@10:     if (s->channel_layout_str) {
yading@10:         uint64_t fmt;
yading@10:         if ((fmt = av_get_channel_layout(s->channel_layout_str)) == 0) {
yading@10:             av_log(ctx, AV_LOG_ERROR, "Error parsing channel layout: '%s'.\n",
yading@10:                    s->channel_layout_str);
yading@10:             ret = AVERROR(EINVAL);
yading@10:             goto fail;
yading@10:         }
yading@10:         if (mode == MAP_NONE) {
yading@10:             int i;
yading@10:             s->nch = av_get_channel_layout_nb_channels(fmt);
yading@10:             for (i = 0; i < s->nch; i++) {
yading@10:                 s->map[i].in_channel_idx  = i;
yading@10:                 s->map[i].out_channel_idx = i;
yading@10:             }
yading@10:         } else if (out_ch_mask && out_ch_mask != fmt) {
yading@10:             av_get_channel_layout_string(buf, sizeof(buf), 0, out_ch_mask);
yading@10:             av_log(ctx, AV_LOG_ERROR,
yading@10:                    "Output channel layout '%s' does not match the list of channel mapped: '%s'.\n",
yading@10:                    s->channel_layout_str, buf);
yading@10:             ret = AVERROR(EINVAL);
yading@10:             goto fail;
yading@10:         } else if (s->nch != av_get_channel_layout_nb_channels(fmt)) {
yading@10:             av_log(ctx, AV_LOG_ERROR,
yading@10:                    "Output channel layout %s does not match the number of channels mapped %d.\n",
yading@10:                    s->channel_layout_str, s->nch);
yading@10:             ret = AVERROR(EINVAL);
yading@10:             goto fail;
yading@10:         }
yading@10:         s->output_layout = fmt;
yading@10:     }
yading@10:     ff_add_channel_layout(&s->channel_layouts, s->output_layout);
yading@10: 
yading@10:     if (mode == MAP_PAIR_INT_STR || mode == MAP_PAIR_STR_STR) {
yading@10:         for (i = 0; i < s->nch; i++) {
yading@10:             s->map[i].out_channel_idx = av_get_channel_layout_channel_index(
yading@10:                 s->output_layout, s->map[i].out_channel);
yading@10:         }
yading@10:     }
yading@10: 
yading@10: fail:
yading@10:     av_opt_free(s);
yading@10:     return ret;
yading@10: }
yading@10: 
yading@10: static int channelmap_query_formats(AVFilterContext *ctx)
yading@10: {
yading@10:     ChannelMapContext *s = ctx->priv;
yading@10: 
yading@10:     ff_set_common_formats(ctx, ff_planar_sample_fmts());
yading@10:     ff_set_common_samplerates(ctx, ff_all_samplerates());
yading@10:     ff_channel_layouts_ref(ff_all_channel_layouts(), &ctx->inputs[0]->out_channel_layouts);
yading@10:     ff_channel_layouts_ref(s->channel_layouts,       &ctx->outputs[0]->in_channel_layouts);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static int channelmap_filter_frame(AVFilterLink *inlink, AVFrame *buf)
yading@10: {
yading@10:     AVFilterContext  *ctx = inlink->dst;
yading@10:     AVFilterLink *outlink = ctx->outputs[0];
yading@10:     const ChannelMapContext *s = ctx->priv;
yading@10:     const int nch_in = av_get_channel_layout_nb_channels(inlink->channel_layout);
yading@10:     const int nch_out = s->nch;
yading@10:     int ch;
yading@10:     uint8_t *source_planes[MAX_CH];
yading@10: 
yading@10:     memcpy(source_planes, buf->extended_data,
yading@10:            nch_in * sizeof(source_planes[0]));
yading@10: 
yading@10:     if (nch_out > nch_in) {
yading@10:         if (nch_out > FF_ARRAY_ELEMS(buf->data)) {
yading@10:             uint8_t **new_extended_data =
yading@10:                 av_mallocz(nch_out * sizeof(*buf->extended_data));
yading@10:             if (!new_extended_data) {
yading@10:                 av_frame_free(&buf);
yading@10:                 return AVERROR(ENOMEM);
yading@10:             }
yading@10:             if (buf->extended_data == buf->data) {
yading@10:                 buf->extended_data = new_extended_data;
yading@10:             } else {
yading@10:                 av_free(buf->extended_data);
yading@10:                 buf->extended_data = new_extended_data;
yading@10:             }
yading@10:         } else if (buf->extended_data != buf->data) {
yading@10:             av_free(buf->extended_data);
yading@10:             buf->extended_data = buf->data;
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     for (ch = 0; ch < nch_out; ch++) {
yading@10:         buf->extended_data[s->map[ch].out_channel_idx] =
yading@10:             source_planes[s->map[ch].in_channel_idx];
yading@10:     }
yading@10: 
yading@10:     if (buf->data != buf->extended_data)
yading@10:         memcpy(buf->data, buf->extended_data,
yading@10:            FFMIN(FF_ARRAY_ELEMS(buf->data), nch_out) * sizeof(buf->data[0]));
yading@10: 
yading@10:     return ff_filter_frame(outlink, buf);
yading@10: }
yading@10: 
yading@10: static int channelmap_config_input(AVFilterLink *inlink)
yading@10: {
yading@10:     AVFilterContext *ctx = inlink->dst;
yading@10:     ChannelMapContext *s = ctx->priv;
yading@10:     int nb_channels = av_get_channel_layout_nb_channels(inlink->channel_layout);
yading@10:     int i, err = 0;
yading@10:     const char *channel_name;
yading@10:     char layout_name[256];
yading@10: 
yading@10:     for (i = 0; i < s->nch; i++) {
yading@10:         struct ChannelMap *m = &s->map[i];
yading@10: 
yading@10:         if (s->mode == MAP_PAIR_STR_INT || s->mode == MAP_PAIR_STR_STR) {
yading@10:             m->in_channel_idx = av_get_channel_layout_channel_index(
yading@10:                 inlink->channel_layout, m->in_channel);
yading@10:         }
yading@10: 
yading@10:         if (m->in_channel_idx < 0 || m->in_channel_idx >= nb_channels) {
yading@10:             av_get_channel_layout_string(layout_name, sizeof(layout_name),
yading@10:                                          0, inlink->channel_layout);
yading@10:             if (m->in_channel) {
yading@10:                 channel_name = av_get_channel_name(m->in_channel);
yading@10:                 av_log(ctx, AV_LOG_ERROR,
yading@10:                        "input channel '%s' not available from input layout '%s'\n",
yading@10:                        channel_name, layout_name);
yading@10:             } else {
yading@10:                 av_log(ctx, AV_LOG_ERROR,
yading@10:                        "input channel #%d not available from input layout '%s'\n",
yading@10:                        m->in_channel_idx, layout_name);
yading@10:             }
yading@10:             err = AVERROR(EINVAL);
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     return err;
yading@10: }
yading@10: 
yading@10: static const AVFilterPad avfilter_af_channelmap_inputs[] = {
yading@10:     {
yading@10:         .name           = "default",
yading@10:         .type           = AVMEDIA_TYPE_AUDIO,
yading@10:         .filter_frame   = channelmap_filter_frame,
yading@10:         .config_props   = channelmap_config_input,
yading@10:         .needs_writable = 1,
yading@10:     },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: static const AVFilterPad avfilter_af_channelmap_outputs[] = {
yading@10:     {
yading@10:         .name = "default",
yading@10:         .type = AVMEDIA_TYPE_AUDIO
yading@10:     },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: AVFilter avfilter_af_channelmap = {
yading@10:     .name          = "channelmap",
yading@10:     .description   = NULL_IF_CONFIG_SMALL("Remap audio channels."),
yading@10:     .init          = channelmap_init,
yading@10:     .query_formats = channelmap_query_formats,
yading@10:     .priv_size     = sizeof(ChannelMapContext),
yading@10:     .priv_class    = &channelmap_class,
yading@10: 
yading@10:     .inputs        = avfilter_af_channelmap_inputs,
yading@10:     .outputs       = avfilter_af_channelmap_outputs,
yading@10: };