git.sesse.net Git - ffmpeg/blob - libavfilter/af_join.c

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * FFmpeg is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with FFmpeg; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 /**
  20  * @file
  21  * Audio join filter
  22  *
  23  * Join multiple audio inputs as different channels in
  24  * a single output
  25  */
  26
  27 #include "libavutil/avassert.h"
  28 #include "libavutil/avstring.h"
  29 #include "libavutil/channel_layout.h"
  30 #include "libavutil/common.h"
  31 #include "libavutil/opt.h"
  32
  33 #include "audio.h"
  34 #include "avfilter.h"
  35 #include "formats.h"
  36 #include "filters.h"
  37 #include "internal.h"
  38
  39 typedef struct ChannelMap {
  40     int input;                ///< input stream index
  41     int       in_channel_idx; ///< index of in_channel in the input stream data
  42     uint64_t  in_channel;     ///< layout describing the input channel
  43     uint64_t out_channel;     ///< layout describing the output channel
  44 } ChannelMap;
  45
  46 typedef struct JoinContext {
  47     const AVClass *class;
  48
  49     int inputs;
  50     char *map;
  51     char    *channel_layout_str;
  52     uint64_t channel_layout;
  53
  54     int      nb_channels;
  55     ChannelMap *channels;
  56
  57     /**
  58      * Temporary storage for input frames, until we get one on each input.
  59      */
  60     AVFrame **input_frames;
  61
  62     /**
  63      *  Temporary storage for buffer references, for assembling the output frame.
  64      */
  65     AVBufferRef **buffers;
  66 } JoinContext;
  67
  68 #define OFFSET(x) offsetof(JoinContext, x)
  69 #define A AV_OPT_FLAG_AUDIO_PARAM
  70 #define F AV_OPT_FLAG_FILTERING_PARAM
  71 static const AVOption join_options[] = {
  72     { "inputs",         "Number of input streams.", OFFSET(inputs),             AV_OPT_TYPE_INT,    { .i64 = 2 }, 1, INT_MAX,       A|F },
  73     { "channel_layout", "Channel layout of the "
  74                         "output stream.",           OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, {.str = "stereo"}, 0, 0, A|F },
  75     { "map",            "A comma-separated list of channels maps in the format "
  76                         "'input_stream.input_channel-output_channel.",
  77                                                     OFFSET(map),                AV_OPT_TYPE_STRING,                 .flags = A|F },
  78     { NULL }
  79 };
  80
  81 AVFILTER_DEFINE_CLASS(join);
  82
  83 static int parse_maps(AVFilterContext *ctx)
  84 {
  85     JoinContext *s = ctx->priv;
  86     char separator = '|';
  87     char *cur      = s->map;
  88
  89     while (cur && *cur) {
  90         char *sep, *next, *p;
  91         uint64_t in_channel = 0, out_channel = 0;
  92         int input_idx, out_ch_idx, in_ch_idx;
  93
  94         next = strchr(cur, separator);
  95         if (next)
  96             *next++ = 0;
  97
  98         /* split the map into input and output parts */
  99         if (!(sep = strchr(cur, '-'))) {
 100             av_log(ctx, AV_LOG_ERROR, "Missing separator '-' in channel "
 101                    "map '%s'\n", cur);
 102             return AVERROR(EINVAL);
 103         }
 104         *sep++ = 0;
 105
 106 #define PARSE_CHANNEL(str, var, inout)                                         \
 107         if (!(var = av_get_channel_layout(str))) {                             \
 108             av_log(ctx, AV_LOG_ERROR, "Invalid " inout " channel: %s.\n", str);\
 109             return AVERROR(EINVAL);                                            \
 110         }                                                                      \
 111         if (av_get_channel_layout_nb_channels(var) != 1) {                     \
 112             av_log(ctx, AV_LOG_ERROR, "Channel map describes more than one "   \
 113                    inout " channel.\n");                                       \
 114             return AVERROR(EINVAL);                                            \
 115         }
 116
 117         /* parse output channel */
 118         PARSE_CHANNEL(sep, out_channel, "output");
 119         if (!(out_channel & s->channel_layout)) {
 120             av_log(ctx, AV_LOG_ERROR, "Output channel '%s' is not present in "
 121                    "requested channel layout.\n", sep);
 122             return AVERROR(EINVAL);
 123         }
 124
 125         out_ch_idx = av_get_channel_layout_channel_index(s->channel_layout,
 126                                                          out_channel);
 127         if (s->channels[out_ch_idx].input >= 0) {
 128             av_log(ctx, AV_LOG_ERROR, "Multiple maps for output channel "
 129                    "'%s'.\n", sep);
 130             return AVERROR(EINVAL);
 131         }
 132
 133         /* parse input channel */
 134         input_idx = strtol(cur, &cur, 0);
 135         if (input_idx < 0 || input_idx >= s->inputs) {
 136             av_log(ctx, AV_LOG_ERROR, "Invalid input stream index: %d.\n",
 137                    input_idx);
 138             return AVERROR(EINVAL);
 139         }
 140
 141         if (*cur)
 142             cur++;
 143
 144         in_ch_idx = strtol(cur, &p, 0);
 145         if (p == cur) {
 146             /* channel specifier is not a number,
 147              * try to parse as channel name */
 148             PARSE_CHANNEL(cur, in_channel, "input");
 149         }
 150
 151         s->channels[out_ch_idx].input      = input_idx;
 152         if (in_channel)
 153             s->channels[out_ch_idx].in_channel = in_channel;
 154         else
 155             s->channels[out_ch_idx].in_channel_idx = in_ch_idx;
 156
 157         cur = next;
 158     }
 159     return 0;
 160 }
 161
 162 static av_cold int join_init(AVFilterContext *ctx)
 163 {
 164     JoinContext *s = ctx->priv;
 165     int ret, i;
 166
 167     if (!(s->channel_layout = av_get_channel_layout(s->channel_layout_str))) {
 168         av_log(ctx, AV_LOG_ERROR, "Error parsing channel layout '%s'.\n",
 169                s->channel_layout_str);
 170         return AVERROR(EINVAL);
 171     }
 172
 173     s->nb_channels  = av_get_channel_layout_nb_channels(s->channel_layout);
 174     s->channels     = av_mallocz_array(s->nb_channels, sizeof(*s->channels));
 175     s->buffers      = av_mallocz_array(s->nb_channels, sizeof(*s->buffers));
 176     s->input_frames = av_mallocz_array(s->inputs, sizeof(*s->input_frames));
 177     if (!s->channels || !s->buffers|| !s->input_frames)
 178         return AVERROR(ENOMEM);
 179
 180     for (i = 0; i < s->nb_channels; i++) {
 181         s->channels[i].out_channel = av_channel_layout_extract_channel(s->channel_layout, i);
 182         s->channels[i].input       = -1;
 183     }
 184
 185     if ((ret = parse_maps(ctx)) < 0)
 186         return ret;
 187
 188     for (i = 0; i < s->inputs; i++) {
 189         AVFilterPad pad = { 0 };
 190
 191         pad.type = AVMEDIA_TYPE_AUDIO;
 192         pad.name = av_asprintf("input%d", i);
 193         if (!pad.name)
 194             return AVERROR(ENOMEM);
 195
 196         if ((ret = ff_insert_inpad(ctx, i, &pad)) < 0) {
 197             av_freep(&pad.name);
 198             return ret;
 199         }
 200     }
 201
 202     return 0;
 203 }
 204
 205 static av_cold void join_uninit(AVFilterContext *ctx)
 206 {
 207     JoinContext *s = ctx->priv;
 208     int i;
 209
 210     for (i = 0; i < ctx->nb_inputs; i++) {
 211         av_freep(&ctx->input_pads[i].name);
 212         av_frame_free(&s->input_frames[i]);
 213     }
 214
 215     av_freep(&s->channels);
 216     av_freep(&s->buffers);
 217     av_freep(&s->input_frames);
 218 }
 219
 220 static int join_query_formats(AVFilterContext *ctx)
 221 {
 222     JoinContext *s = ctx->priv;
 223     AVFilterChannelLayouts *layouts = NULL;
 224     int i, ret;
 225
 226     if ((ret = ff_add_channel_layout(&layouts, s->channel_layout)) < 0 ||
 227         (ret = ff_channel_layouts_ref(layouts, &ctx->outputs[0]->in_channel_layouts)) < 0)
 228         return ret;
 229
 230     for (i = 0; i < ctx->nb_inputs; i++) {
 231         layouts = ff_all_channel_layouts();
 232         if ((ret = ff_channel_layouts_ref(layouts, &ctx->inputs[i]->out_channel_layouts)) < 0)
 233             return ret;
 234     }
 235
 236     if ((ret = ff_set_common_formats(ctx, ff_planar_sample_fmts())) < 0 ||
 237         (ret = ff_set_common_samplerates(ctx, ff_all_samplerates())) < 0)
 238         return ret;
 239
 240     return 0;
 241 }
 242
 243 static void guess_map_matching(AVFilterContext *ctx, ChannelMap *ch,
 244                                uint64_t *inputs)
 245 {
 246     int i;
 247
 248     for (i = 0; i < ctx->nb_inputs; i++) {
 249         AVFilterLink *link = ctx->inputs[i];
 250
 251         if (ch->out_channel & link->channel_layout &&
 252             !(ch->out_channel & inputs[i])) {
 253             ch->input      = i;
 254             ch->in_channel = ch->out_channel;
 255             inputs[i]     |= ch->out_channel;
 256             return;
 257         }
 258     }
 259 }
 260
 261 static void guess_map_any(AVFilterContext *ctx, ChannelMap *ch,
 262                           uint64_t *inputs)
 263 {
 264     int i;
 265
 266     for (i = 0; i < ctx->nb_inputs; i++) {
 267         AVFilterLink *link = ctx->inputs[i];
 268
 269         if ((inputs[i] & link->channel_layout) != link->channel_layout) {
 270             uint64_t unused = link->channel_layout & ~inputs[i];
 271
 272             ch->input      = i;
 273             ch->in_channel = av_channel_layout_extract_channel(unused, 0);
 274             inputs[i]     |= ch->in_channel;
 275             return;
 276         }
 277     }
 278 }
 279
 280 static int join_config_output(AVFilterLink *outlink)
 281 {
 282     AVFilterContext *ctx = outlink->src;
 283     JoinContext       *s = ctx->priv;
 284     uint64_t *inputs;   // nth element tracks which channels are used from nth input
 285     int i, ret = 0;
 286
 287     /* initialize inputs to user-specified mappings */
 288     if (!(inputs = av_mallocz_array(ctx->nb_inputs, sizeof(*inputs))))
 289         return AVERROR(ENOMEM);
 290     for (i = 0; i < s->nb_channels; i++) {
 291         ChannelMap *ch = &s->channels[i];
 292         AVFilterLink *inlink;
 293
 294         if (ch->input < 0)
 295             continue;
 296
 297         inlink = ctx->inputs[ch->input];
 298
 299         if (!ch->in_channel)
 300             ch->in_channel = av_channel_layout_extract_channel(inlink->channel_layout,
 301                                                                ch->in_channel_idx);
 302
 303         if (!(ch->in_channel & inlink->channel_layout)) {
 304             av_log(ctx, AV_LOG_ERROR, "Requested channel %s is not present in "
 305                    "input stream #%d.\n", av_get_channel_name(ch->in_channel),
 306                    ch->input);
 307             ret = AVERROR(EINVAL);
 308             goto fail;
 309         }
 310
 311         inputs[ch->input] |= ch->in_channel;
 312     }
 313
 314     /* guess channel maps when not explicitly defined */
 315     /* first try unused matching channels */
 316     for (i = 0; i < s->nb_channels; i++) {
 317         ChannelMap *ch = &s->channels[i];
 318
 319         if (ch->input < 0)
 320             guess_map_matching(ctx, ch, inputs);
 321     }
 322
 323     /* if the above failed, try to find _any_ unused input channel */
 324     for (i = 0; i < s->nb_channels; i++) {
 325         ChannelMap *ch = &s->channels[i];
 326
 327         if (ch->input < 0)
 328             guess_map_any(ctx, ch, inputs);
 329
 330         if (ch->input < 0) {
 331             av_log(ctx, AV_LOG_ERROR, "Could not find input channel for "
 332                    "output channel '%s'.\n",
 333                    av_get_channel_name(ch->out_channel));
 334             goto fail;
 335         }
 336
 337         ch->in_channel_idx = av_get_channel_layout_channel_index(ctx->inputs[ch->input]->channel_layout,
 338                                                                  ch->in_channel);
 339     }
 340
 341     /* print mappings */
 342     av_log(ctx, AV_LOG_VERBOSE, "mappings: ");
 343     for (i = 0; i < s->nb_channels; i++) {
 344         ChannelMap *ch = &s->channels[i];
 345         av_log(ctx, AV_LOG_VERBOSE, "%d.%s => %s ", ch->input,
 346                av_get_channel_name(ch->in_channel),
 347                av_get_channel_name(ch->out_channel));
 348     }
 349     av_log(ctx, AV_LOG_VERBOSE, "\n");
 350
 351     for (i = 0; i < ctx->nb_inputs; i++) {
 352         if (!inputs[i])
 353             av_log(ctx, AV_LOG_WARNING, "No channels are used from input "
 354                    "stream %d.\n", i);
 355     }
 356
 357 fail:
 358     av_freep(&inputs);
 359     return ret;
 360 }
 361
 362 static int try_push_frame(AVFilterContext *ctx)
 363 {
 364     AVFilterLink *outlink = ctx->outputs[0];
 365     JoinContext *s       = ctx->priv;
 366     AVFrame *frame;
 367     int linesize   = INT_MAX;
 368     int nb_samples = INT_MAX;
 369     int nb_buffers = 0;
 370     int i, j, ret;
 371
 372     for (i = 0; i < ctx->nb_inputs; i++) {
 373         if (!s->input_frames[i])
 374             return 0;
 375         nb_samples = FFMIN(nb_samples, s->input_frames[i]->nb_samples);
 376     }
 377     if (!nb_samples)
 378         return 0;
 379
 380     /* setup the output frame */
 381     frame = av_frame_alloc();
 382     if (!frame)
 383         return AVERROR(ENOMEM);
 384     if (s->nb_channels > FF_ARRAY_ELEMS(frame->data)) {
 385         frame->extended_data = av_mallocz_array(s->nb_channels,
 386                                           sizeof(*frame->extended_data));
 387         if (!frame->extended_data) {
 388             ret = AVERROR(ENOMEM);
 389             goto fail;
 390         }
 391     }
 392
 393     /* copy the data pointers */
 394     for (i = 0; i < s->nb_channels; i++) {
 395         ChannelMap *ch = &s->channels[i];
 396         AVFrame *cur   = s->input_frames[ch->input];
 397         AVBufferRef *buf;
 398
 399         frame->extended_data[i] = cur->extended_data[ch->in_channel_idx];
 400         linesize = FFMIN(linesize, cur->linesize[0]);
 401
 402         /* add the buffer where this plan is stored to the list if it's
 403          * not already there */
 404         buf = av_frame_get_plane_buffer(cur, ch->in_channel_idx);
 405         if (!buf) {
 406             ret = AVERROR(EINVAL);
 407             goto fail;
 408         }
 409         for (j = 0; j < nb_buffers; j++)
 410             if (s->buffers[j]->buffer == buf->buffer)
 411                 break;
 412         if (j == i)
 413             s->buffers[nb_buffers++] = buf;
 414     }
 415
 416     /* create references to the buffers we copied to output */
 417     if (nb_buffers > FF_ARRAY_ELEMS(frame->buf)) {
 418         frame->nb_extended_buf = nb_buffers - FF_ARRAY_ELEMS(frame->buf);
 419         frame->extended_buf = av_mallocz_array(frame->nb_extended_buf,
 420                                                sizeof(*frame->extended_buf));
 421         if (!frame->extended_buf) {
 422             frame->nb_extended_buf = 0;
 423             ret = AVERROR(ENOMEM);
 424             goto fail;
 425         }
 426     }
 427     for (i = 0; i < FFMIN(FF_ARRAY_ELEMS(frame->buf), nb_buffers); i++) {
 428         frame->buf[i] = av_buffer_ref(s->buffers[i]);
 429         if (!frame->buf[i]) {
 430             ret = AVERROR(ENOMEM);
 431             goto fail;
 432         }
 433     }
 434     for (i = 0; i < frame->nb_extended_buf; i++) {
 435         frame->extended_buf[i] = av_buffer_ref(s->buffers[i +
 436                                                FF_ARRAY_ELEMS(frame->buf)]);
 437         if (!frame->extended_buf[i]) {
 438             ret = AVERROR(ENOMEM);
 439             goto fail;
 440         }
 441     }
 442
 443     frame->nb_samples     = nb_samples;
 444     frame->channel_layout = outlink->channel_layout;
 445     frame->channels       = outlink->channels;
 446     frame->sample_rate    = outlink->sample_rate;
 447     frame->format         = outlink->format;
 448     frame->pts            = s->input_frames[0]->pts;
 449     frame->linesize[0]    = linesize;
 450     if (frame->data != frame->extended_data) {
 451         memcpy(frame->data, frame->extended_data, sizeof(*frame->data) *
 452                FFMIN(FF_ARRAY_ELEMS(frame->data), s->nb_channels));
 453     }
 454
 455     ret = ff_filter_frame(outlink, frame);
 456
 457     for (i = 0; i < ctx->nb_inputs; i++)
 458         av_frame_free(&s->input_frames[i]);
 459
 460     return ret;
 461
 462 fail:
 463     av_frame_free(&frame);
 464     return ret;
 465 }
 466
 467 static int activate(AVFilterContext *ctx)
 468 {
 469     JoinContext *s = ctx->priv;
 470     int i, ret, status;
 471     int nb_samples = 0;
 472     int64_t pts;
 473
 474     FF_FILTER_FORWARD_STATUS_BACK_ALL(ctx->outputs[0], ctx);
 475
 476     if (!s->input_frames[0]) {
 477         ret = ff_inlink_consume_frame(ctx->inputs[0], &s->input_frames[0]);
 478         if (ret < 0) {
 479             return ret;
 480         } else if (ff_inlink_acknowledge_status(ctx->inputs[0], &status, &pts)) {
 481             ff_outlink_set_status(ctx->outputs[0], status, pts);
 482             return 0;
 483         } else {
 484             if (ff_outlink_frame_wanted(ctx->outputs[0]) && !s->input_frames[0]) {
 485                 ff_inlink_request_frame(ctx->inputs[0]);
 486                 return 0;
 487             }
 488         }
 489         if (!s->input_frames[0]) {
 490             return 0;
 491         }
 492     }
 493
 494     nb_samples = s->input_frames[0]->nb_samples;
 495
 496     for (i = 1; i < ctx->nb_inputs && nb_samples > 0; i++) {
 497         if (s->input_frames[i])
 498             continue;
 499
 500         if (ff_inlink_check_available_samples(ctx->inputs[i], nb_samples) > 0) {
 501             ret = ff_inlink_consume_samples(ctx->inputs[i], nb_samples, nb_samples, &s->input_frames[i]);
 502             if (ret < 0) {
 503                 return ret;
 504             } else if (ff_inlink_acknowledge_status(ctx->inputs[i], &status, &pts)) {
 505                 ff_outlink_set_status(ctx->outputs[0], status, pts);
 506                 return 0;
 507             }
 508         } else {
 509             if (ff_outlink_frame_wanted(ctx->outputs[0])) {
 510                 ff_inlink_request_frame(ctx->inputs[i]);
 511                 return 0;
 512             }
 513         }
 514     }
 515
 516     return try_push_frame(ctx);
 517 }
 518
 519 static const AVFilterPad avfilter_af_join_outputs[] = {
 520     {
 521         .name          = "default",
 522         .type          = AVMEDIA_TYPE_AUDIO,
 523         .config_props  = join_config_output,
 524     },
 525     { NULL }
 526 };
 527
 528 AVFilter ff_af_join = {
 529     .name           = "join",
 530     .description    = NULL_IF_CONFIG_SMALL("Join multiple audio streams into "
 531                                            "multi-channel output."),
 532     .priv_size      = sizeof(JoinContext),
 533     .priv_class     = &join_class,
 534     .init           = join_init,
 535     .uninit         = join_uninit,
 536     .activate       = activate,
 537     .query_formats  = join_query_formats,
 538     .inputs         = NULL,
 539     .outputs        = avfilter_af_join_outputs,
 540     .flags          = AVFILTER_FLAG_DYNAMIC_INPUTS,
 541 };