lavfi/amerge: fix input pad name behaviour.
[ffmpeg.git] / libavfilter / af_amerge.c
1 /*
2  * Copyright (c) 2011 Nicolas George <nicolas.george@normalesup.org>
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
19  */
20
21 /**
22  * @file
23  * Audio merging filter
24  */
25
26 #include "libavutil/audioconvert.h"
27 #include "libavutil/avstring.h"
28 #include "libavutil/bprint.h"
29 #include "libavutil/opt.h"
30 #include "libswresample/swresample.h" // only for SWR_CH_MAX
31 #include "avfilter.h"
32 #include "audio.h"
33 #include "bufferqueue.h"
34 #include "internal.h"
35
36 typedef struct {
37     const AVClass *class;
38     int nb_inputs;
39     int route[SWR_CH_MAX]; /**< channels routing, see copy_samples */
40     int bps;
41     struct amerge_input {
42         struct FFBufQueue queue;
43         int nb_ch;         /**< number of channels for the input */
44         int nb_samples;
45         int pos;
46     } *in;
47 } AMergeContext;
48
49 #define OFFSET(x) offsetof(AMergeContext, x)
50 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
51
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 },
55     {0}
56 };
57
58 AVFILTER_DEFINE_CLASS(amerge);
59
60 static av_cold void uninit(AVFilterContext *ctx)
61 {
62     AMergeContext *am = ctx->priv;
63     int i;
64
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);
68     }
69     av_freep(&am->in);
70 }
71
72 static int query_formats(AVFilterContext *ctx)
73 {
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;
79
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);
86         }
87         inlayout[i] = ctx->inputs[i]->in_channel_layouts->channel_layouts[0];
88         if (ctx->inputs[i]->in_channel_layouts->nb_channel_layouts > 1) {
89             char buf[256];
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);
92         }
93         am->in[i].nb_ch = av_get_channel_layout_nb_channels(inlayout[i]);
94         if (outlayout & inlayout[i])
95             overlap++;
96         outlayout |= inlayout[i];
97         nb_ch += am->in[i].nb_ch;
98     }
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);
102     }
103     if (overlap) {
104         av_log(ctx, AV_LOG_WARNING,
105                "Inputs overlap: output layout will be meaningless\n");
106         for (i = 0; i < nb_ch; i++)
107             am->route[i] = i;
108         outlayout = av_get_default_channel_layout(nb_ch);
109         if (!outlayout)
110             outlayout = ((int64_t)1 << nb_ch) - 1;
111     } else {
112         int *route[SWR_CH_MAX];
113         int c, out_ch_number = 0;
114
115         route[0] = am->route;
116         for (i = 1; i < am->nb_inputs; i++)
117             route[i] = route[i - 1] + am->in[i - 1].nb_ch;
118         for (c = 0; c < 64; c++)
119             for (i = 0; i < am->nb_inputs; i++)
120                 if ((inlayout[i] >> c) & 1)
121                     *(route[i]++) = out_ch_number++;
122     }
123     formats = ff_make_format_list(ff_packed_sample_fmts_array);
124     ff_set_common_formats(ctx, formats);
125     for (i = 0; i < am->nb_inputs; i++) {
126         layouts = NULL;
127         ff_add_channel_layout(&layouts, inlayout[i]);
128         ff_channel_layouts_ref(layouts, &ctx->inputs[i]->out_channel_layouts);
129     }
130     layouts = NULL;
131     ff_add_channel_layout(&layouts, outlayout);
132     ff_channel_layouts_ref(layouts, &ctx->outputs[0]->in_channel_layouts);
133     ff_set_common_samplerates(ctx, ff_all_samplerates());
134     return 0;
135 }
136
137 static int config_output(AVFilterLink *outlink)
138 {
139     AVFilterContext *ctx = outlink->src;
140     AMergeContext *am = ctx->priv;
141     AVBPrint bp;
142     int i;
143
144     for (i = 1; i < am->nb_inputs; i++) {
145         if (ctx->inputs[i]->sample_rate != ctx->inputs[0]->sample_rate) {
146             av_log(ctx, AV_LOG_ERROR,
147                    "Inputs must have the same sample rate "
148                    "%d for in%d vs %d\n",
149                    ctx->inputs[i]->sample_rate, i, ctx->inputs[0]->sample_rate);
150             return AVERROR(EINVAL);
151         }
152     }
153     am->bps = av_get_bytes_per_sample(ctx->outputs[0]->format);
154     outlink->sample_rate = ctx->inputs[0]->sample_rate;
155     outlink->time_base   = ctx->inputs[0]->time_base;
156
157     av_bprint_init(&bp, 0, 1);
158     for (i = 0; i < am->nb_inputs; i++) {
159         av_bprintf(&bp, "%sin%d:", i ? " + " : "", i);
160         av_bprint_channel_layout(&bp, -1, ctx->inputs[i]->channel_layout);
161     }
162     av_bprintf(&bp, " -> out:");
163     av_bprint_channel_layout(&bp, -1, ctx->outputs[0]->channel_layout);
164     av_log(ctx, AV_LOG_VERBOSE, "%s\n", bp.str);
165
166     return 0;
167 }
168
169 static int request_frame(AVFilterLink *outlink)
170 {
171     AVFilterContext *ctx = outlink->src;
172     AMergeContext *am = ctx->priv;
173     int i, ret;
174
175     for (i = 0; i < am->nb_inputs; i++)
176         if (!am->in[i].nb_samples)
177             if ((ret = ff_request_frame(ctx->inputs[i])) < 0)
178                 return ret;
179     return 0;
180 }
181
182 /**
183  * Copy samples from several input streams to one output stream.
184  * @param nb_inputs number of inputs
185  * @param in        inputs; used only for the nb_ch field;
186  * @param route     routing values;
187  *                  input channel i goes to output channel route[i];
188  *                  i <  in[0].nb_ch are the channels from the first output;
189  *                  i >= in[0].nb_ch are the channels from the second output
190  * @param ins       pointer to the samples of each inputs, in packed format;
191  *                  will be left at the end of the copied samples
192  * @param outs      pointer to the samples of the output, in packet format;
193  *                  must point to a buffer big enough;
194  *                  will be left at the end of the copied samples
195  * @param ns        number of samples to copy
196  * @param bps       bytes per sample
197  */
198 static inline void copy_samples(int nb_inputs, struct amerge_input in[],
199                                 int *route, uint8_t *ins[],
200                                 uint8_t **outs, int ns, int bps)
201 {
202     int *route_cur;
203     int i, c, nb_ch = 0;
204
205     for (i = 0; i < nb_inputs; i++)
206         nb_ch += in[i].nb_ch;
207     while (ns--) {
208         route_cur = route;
209         for (i = 0; i < nb_inputs; i++) {
210             for (c = 0; c < in[i].nb_ch; c++) {
211                 memcpy((*outs) + bps * *(route_cur++), ins[i], bps);
212                 ins[i] += bps;
213             }
214         }
215         *outs += nb_ch * bps;
216     }
217 }
218
219 static int filter_samples(AVFilterLink *inlink, AVFilterBufferRef *insamples)
220 {
221     AVFilterContext *ctx = inlink->dst;
222     AMergeContext *am = ctx->priv;
223     AVFilterLink *const outlink = ctx->outputs[0];
224     int input_number;
225     int nb_samples, ns, i;
226     AVFilterBufferRef *outbuf, *inbuf[SWR_CH_MAX];
227     uint8_t *ins[SWR_CH_MAX], *outs;
228
229     for (input_number = 0; input_number < am->nb_inputs; input_number++)
230         if (inlink == ctx->inputs[input_number])
231             break;
232     av_assert1(input_number < am->nb_inputs);
233     ff_bufqueue_add(ctx, &am->in[input_number].queue, insamples);
234     am->in[input_number].nb_samples += insamples->audio->nb_samples;
235     nb_samples = am->in[0].nb_samples;
236     for (i = 1; i < am->nb_inputs; i++)
237         nb_samples = FFMIN(nb_samples, am->in[i].nb_samples);
238     if (!nb_samples)
239         return 0;
240
241     outbuf = ff_get_audio_buffer(ctx->outputs[0], AV_PERM_WRITE, nb_samples);
242     outs = outbuf->data[0];
243     for (i = 0; i < am->nb_inputs; i++) {
244         inbuf[i] = ff_bufqueue_peek(&am->in[i].queue, 0);
245         ins[i] = inbuf[i]->data[0] +
246                  am->in[i].pos * am->in[i].nb_ch * am->bps;
247     }
248     avfilter_copy_buffer_ref_props(outbuf, inbuf[0]);
249     outbuf->pts = inbuf[0]->pts == AV_NOPTS_VALUE ? AV_NOPTS_VALUE :
250                   inbuf[0]->pts +
251                   av_rescale_q(am->in[0].pos,
252                                (AVRational){ 1, ctx->inputs[0]->sample_rate },
253                                ctx->outputs[0]->time_base);
254
255     outbuf->audio->nb_samples     = nb_samples;
256     outbuf->audio->channel_layout = outlink->channel_layout;
257
258     while (nb_samples) {
259         ns = nb_samples;
260         for (i = 0; i < am->nb_inputs; i++)
261             ns = FFMIN(ns, inbuf[i]->audio->nb_samples - am->in[i].pos);
262         /* Unroll the most common sample formats: speed +~350% for the loop,
263            +~13% overall (including two common decoders) */
264         switch (am->bps) {
265             case 1:
266                 copy_samples(am->nb_inputs, am->in, am->route, ins, &outs, ns, 1);
267                 break;
268             case 2:
269                 copy_samples(am->nb_inputs, am->in, am->route, ins, &outs, ns, 2);
270                 break;
271             case 4:
272                 copy_samples(am->nb_inputs, am->in, am->route, ins, &outs, ns, 4);
273                 break;
274             default:
275                 copy_samples(am->nb_inputs, am->in, am->route, ins, &outs, ns, am->bps);
276                 break;
277         }
278
279         nb_samples -= ns;
280         for (i = 0; i < am->nb_inputs; i++) {
281             am->in[i].nb_samples -= ns;
282             am->in[i].pos += ns;
283             if (am->in[i].pos == inbuf[i]->audio->nb_samples) {
284                 am->in[i].pos = 0;
285                 avfilter_unref_buffer(inbuf[i]);
286                 ff_bufqueue_get(&am->in[i].queue);
287                 inbuf[i] = ff_bufqueue_peek(&am->in[i].queue, 0);
288                 ins[i] = inbuf[i] ? inbuf[i]->data[0] : NULL;
289             }
290         }
291     }
292     return ff_filter_samples(ctx->outputs[0], outbuf);
293 }
294
295 static av_cold int init(AVFilterContext *ctx, const char *args)
296 {
297     AMergeContext *am = ctx->priv;
298     int ret, i;
299
300     am->class = &amerge_class;
301     av_opt_set_defaults(am);
302     ret = av_set_options_string(am, args, "=", ":");
303     if (ret < 0) {
304         av_log(ctx, AV_LOG_ERROR, "Error parsing options: '%s'\n", args);
305         return ret;
306     }
307     am->in = av_calloc(am->nb_inputs, sizeof(*am->in));
308     if (!am->in)
309         return AVERROR(ENOMEM);
310     for (i = 0; i < am->nb_inputs; i++) {
311         char *name = av_asprintf("in%d", i);
312         if (!name)
313             return AVERROR(ENOMEM);
314         AVFilterPad pad = {
315             .name             = name,
316             .type             = AVMEDIA_TYPE_AUDIO,
317             .filter_samples   = filter_samples,
318             .min_perms        = AV_PERM_READ | AV_PERM_PRESERVE,
319         };
320         ff_insert_inpad(ctx, i, &pad);
321     }
322     return 0;
323 }
324
325 AVFilter avfilter_af_amerge = {
326     .name          = "amerge",
327     .description   = NULL_IF_CONFIG_SMALL("Merge two audio streams into "
328                                           "a single multi-channel stream."),
329     .priv_size     = sizeof(AMergeContext),
330     .init          = init,
331     .uninit        = uninit,
332     .query_formats = query_formats,
333
334     .inputs    = (const AVFilterPad[]) { { .name = NULL } },
335     .outputs   = (const AVFilterPad[]) {
336         { .name             = "default",
337           .type             = AVMEDIA_TYPE_AUDIO,
338           .config_props     = config_output,
339           .request_frame    = request_frame, },
340         { .name = NULL }
341     },
342     .priv_class = &amerge_class,
343 };