2 * Copyright (c) 2011 Nicolas George <nicolas.george@normalesup.org>
4 * This file is part of FFmpeg.
6 * FFmpeg 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.
11 * FFmpeg 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
14 * GNU Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * Audio merging filter
26 #include "libavutil/avstring.h"
27 #include "libavutil/bprint.h"
28 #include "libavutil/channel_layout.h"
29 #include "libavutil/opt.h"
30 #include "libswresample/swresample.h" // only for SWR_CH_MAX
33 #include "bufferqueue.h"
39 int route[SWR_CH_MAX]; /**< channels routing, see copy_samples */
42 struct FFBufQueue queue;
43 int nb_ch; /**< number of channels for the input */
49 #define OFFSET(x) offsetof(AMergeContext, x)
50 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
52 static const AVOption amerge_options[] = {
53 { "inputs", "specify the number of inputs", OFFSET(nb_inputs),
54 AV_OPT_TYPE_INT, { .i64 = 2 }, 2, SWR_CH_MAX, FLAGS },
58 AVFILTER_DEFINE_CLASS(amerge);
60 static av_cold void uninit(AVFilterContext *ctx)
62 AMergeContext *am = ctx->priv;
65 for (i = 0; i < am->nb_inputs; i++) {
66 ff_bufqueue_discard_all(&am->in[i].queue);
67 av_freep(&ctx->input_pads[i].name);
72 static int query_formats(AVFilterContext *ctx)
74 AMergeContext *am = ctx->priv;
75 int64_t inlayout[SWR_CH_MAX], outlayout = 0;
76 AVFilterFormats *formats;
77 AVFilterChannelLayouts *layouts;
78 int i, overlap = 0, nb_ch = 0;
80 for (i = 0; i < am->nb_inputs; i++) {
81 if (!ctx->inputs[i]->in_channel_layouts ||
82 !ctx->inputs[i]->in_channel_layouts->nb_channel_layouts) {
83 av_log(ctx, AV_LOG_ERROR,
84 "No channel layout for input %d\n", i + 1);
85 return AVERROR(EINVAL);
87 inlayout[i] = ctx->inputs[i]->in_channel_layouts->channel_layouts[0];
88 if (ctx->inputs[i]->in_channel_layouts->nb_channel_layouts > 1) {
90 av_get_channel_layout_string(buf, sizeof(buf), 0, inlayout[i]);
91 av_log(ctx, AV_LOG_INFO, "Using \"%s\" for input %d\n", buf, i + 1);
93 am->in[i].nb_ch = av_get_channel_layout_nb_channels(inlayout[i]);
94 if (outlayout & inlayout[i])
96 outlayout |= inlayout[i];
97 nb_ch += am->in[i].nb_ch;
99 if (nb_ch > SWR_CH_MAX) {
100 av_log(ctx, AV_LOG_ERROR, "Too many channels (max %d)\n", SWR_CH_MAX);
101 return AVERROR(EINVAL);
104 av_log(ctx, AV_LOG_WARNING,
105 "Input channel layouts overlap: "
106 "output layout will be determined by the number of distinct input channels\n");
107 for (i = 0; i < nb_ch; i++)
109 outlayout = av_get_default_channel_layout(nb_ch);
111 outlayout = ((int64_t)1 << nb_ch) - 1;
113 int *route[SWR_CH_MAX];
114 int c, out_ch_number = 0;
116 route[0] = am->route;
117 for (i = 1; i < am->nb_inputs; i++)
118 route[i] = route[i - 1] + am->in[i - 1].nb_ch;
119 for (c = 0; c < 64; c++)
120 for (i = 0; i < am->nb_inputs; i++)
121 if ((inlayout[i] >> c) & 1)
122 *(route[i]++) = out_ch_number++;
124 formats = ff_make_format_list(ff_packed_sample_fmts_array);
125 ff_set_common_formats(ctx, formats);
126 for (i = 0; i < am->nb_inputs; i++) {
128 ff_add_channel_layout(&layouts, inlayout[i]);
129 ff_channel_layouts_ref(layouts, &ctx->inputs[i]->out_channel_layouts);
132 ff_add_channel_layout(&layouts, outlayout);
133 ff_channel_layouts_ref(layouts, &ctx->outputs[0]->in_channel_layouts);
134 ff_set_common_samplerates(ctx, ff_all_samplerates());
138 static int config_output(AVFilterLink *outlink)
140 AVFilterContext *ctx = outlink->src;
141 AMergeContext *am = ctx->priv;
145 for (i = 1; i < am->nb_inputs; i++) {
146 if (ctx->inputs[i]->sample_rate != ctx->inputs[0]->sample_rate) {
147 av_log(ctx, AV_LOG_ERROR,
148 "Inputs must have the same sample rate "
149 "%d for in%d vs %d\n",
150 ctx->inputs[i]->sample_rate, i, ctx->inputs[0]->sample_rate);
151 return AVERROR(EINVAL);
154 am->bps = av_get_bytes_per_sample(ctx->outputs[0]->format);
155 outlink->sample_rate = ctx->inputs[0]->sample_rate;
156 outlink->time_base = ctx->inputs[0]->time_base;
158 av_bprint_init(&bp, 0, 1);
159 for (i = 0; i < am->nb_inputs; i++) {
160 av_bprintf(&bp, "%sin%d:", i ? " + " : "", i);
161 av_bprint_channel_layout(&bp, -1, ctx->inputs[i]->channel_layout);
163 av_bprintf(&bp, " -> out:");
164 av_bprint_channel_layout(&bp, -1, ctx->outputs[0]->channel_layout);
165 av_log(ctx, AV_LOG_VERBOSE, "%s\n", bp.str);
170 static int request_frame(AVFilterLink *outlink)
172 AVFilterContext *ctx = outlink->src;
173 AMergeContext *am = ctx->priv;
176 for (i = 0; i < am->nb_inputs; i++)
177 if (!am->in[i].nb_samples)
178 if ((ret = ff_request_frame(ctx->inputs[i])) < 0)
184 * Copy samples from several input streams to one output stream.
185 * @param nb_inputs number of inputs
186 * @param in inputs; used only for the nb_ch field;
187 * @param route routing values;
188 * input channel i goes to output channel route[i];
189 * i < in[0].nb_ch are the channels from the first output;
190 * i >= in[0].nb_ch are the channels from the second output
191 * @param ins pointer to the samples of each inputs, in packed format;
192 * will be left at the end of the copied samples
193 * @param outs pointer to the samples of the output, in packet format;
194 * must point to a buffer big enough;
195 * will be left at the end of the copied samples
196 * @param ns number of samples to copy
197 * @param bps bytes per sample
199 static inline void copy_samples(int nb_inputs, struct amerge_input in[],
200 int *route, uint8_t *ins[],
201 uint8_t **outs, int ns, int bps)
206 for (i = 0; i < nb_inputs; i++)
207 nb_ch += in[i].nb_ch;
210 for (i = 0; i < nb_inputs; i++) {
211 for (c = 0; c < in[i].nb_ch; c++) {
212 memcpy((*outs) + bps * *(route_cur++), ins[i], bps);
216 *outs += nb_ch * bps;
220 static int filter_frame(AVFilterLink *inlink, AVFilterBufferRef *insamples)
222 AVFilterContext *ctx = inlink->dst;
223 AMergeContext *am = ctx->priv;
224 AVFilterLink *const outlink = ctx->outputs[0];
226 int nb_samples, ns, i;
227 AVFilterBufferRef *outbuf, *inbuf[SWR_CH_MAX];
228 uint8_t *ins[SWR_CH_MAX], *outs;
230 for (input_number = 0; input_number < am->nb_inputs; input_number++)
231 if (inlink == ctx->inputs[input_number])
233 av_assert1(input_number < am->nb_inputs);
234 if (ff_bufqueue_is_full(&am->in[input_number].queue)) {
235 av_log(ctx, AV_LOG_ERROR, "Buffer queue overflow\n");
236 avfilter_unref_buffer(insamples);
237 return AVERROR(ENOMEM);
239 ff_bufqueue_add(ctx, &am->in[input_number].queue, insamples);
240 am->in[input_number].nb_samples += insamples->audio->nb_samples;
241 nb_samples = am->in[0].nb_samples;
242 for (i = 1; i < am->nb_inputs; i++)
243 nb_samples = FFMIN(nb_samples, am->in[i].nb_samples);
247 outbuf = ff_get_audio_buffer(ctx->outputs[0], AV_PERM_WRITE, nb_samples);
248 outs = outbuf->data[0];
249 for (i = 0; i < am->nb_inputs; i++) {
250 inbuf[i] = ff_bufqueue_peek(&am->in[i].queue, 0);
251 ins[i] = inbuf[i]->data[0] +
252 am->in[i].pos * am->in[i].nb_ch * am->bps;
254 avfilter_copy_buffer_ref_props(outbuf, inbuf[0]);
255 outbuf->pts = inbuf[0]->pts == AV_NOPTS_VALUE ? AV_NOPTS_VALUE :
257 av_rescale_q(am->in[0].pos,
258 (AVRational){ 1, ctx->inputs[0]->sample_rate },
259 ctx->outputs[0]->time_base);
261 outbuf->audio->nb_samples = nb_samples;
262 outbuf->audio->channel_layout = outlink->channel_layout;
263 outbuf->audio->channels = outlink->channels;
267 for (i = 0; i < am->nb_inputs; i++)
268 ns = FFMIN(ns, inbuf[i]->audio->nb_samples - am->in[i].pos);
269 /* Unroll the most common sample formats: speed +~350% for the loop,
270 +~13% overall (including two common decoders) */
273 copy_samples(am->nb_inputs, am->in, am->route, ins, &outs, ns, 1);
276 copy_samples(am->nb_inputs, am->in, am->route, ins, &outs, ns, 2);
279 copy_samples(am->nb_inputs, am->in, am->route, ins, &outs, ns, 4);
282 copy_samples(am->nb_inputs, am->in, am->route, ins, &outs, ns, am->bps);
287 for (i = 0; i < am->nb_inputs; i++) {
288 am->in[i].nb_samples -= ns;
290 if (am->in[i].pos == inbuf[i]->audio->nb_samples) {
292 avfilter_unref_buffer(inbuf[i]);
293 ff_bufqueue_get(&am->in[i].queue);
294 inbuf[i] = ff_bufqueue_peek(&am->in[i].queue, 0);
295 ins[i] = inbuf[i] ? inbuf[i]->data[0] : NULL;
299 return ff_filter_frame(ctx->outputs[0], outbuf);
302 static av_cold int init(AVFilterContext *ctx, const char *args)
304 AMergeContext *am = ctx->priv;
307 am->class = &amerge_class;
308 av_opt_set_defaults(am);
309 ret = av_set_options_string(am, args, "=", ":");
311 av_log(ctx, AV_LOG_ERROR, "Error parsing options: '%s'\n", args);
314 am->in = av_calloc(am->nb_inputs, sizeof(*am->in));
316 return AVERROR(ENOMEM);
317 for (i = 0; i < am->nb_inputs; i++) {
318 char *name = av_asprintf("in%d", i);
321 .type = AVMEDIA_TYPE_AUDIO,
322 .filter_frame = filter_frame,
323 .min_perms = AV_PERM_READ | AV_PERM_PRESERVE,
326 return AVERROR(ENOMEM);
327 ff_insert_inpad(ctx, i, &pad);
332 static const AVFilterPad amerge_outputs[] = {
335 .type = AVMEDIA_TYPE_AUDIO,
336 .config_props = config_output,
337 .request_frame = request_frame,
342 AVFilter avfilter_af_amerge = {
344 .description = NULL_IF_CONFIG_SMALL("Merge two or more audio streams into "
345 "a single multi-channel stream."),
346 .priv_size = sizeof(AMergeContext),
349 .query_formats = query_formats,
351 .outputs = amerge_outputs,
352 .priv_class = &amerge_class,