avfilter/af_amerge: detect EOF immediately
[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 #define FF_INTERNAL_FIELDS 1
27 #include "framequeue.h"
28
29 #include "libavutil/avstring.h"
30 #include "libavutil/bprint.h"
31 #include "libavutil/channel_layout.h"
32 #include "libavutil/opt.h"
33 #include "avfilter.h"
34 #include "audio.h"
35 #include "bufferqueue.h"
36 #include "internal.h"
37
38 #define SWR_CH_MAX 64
39
40 typedef struct {
41     const AVClass *class;
42     int nb_inputs;
43     int route[SWR_CH_MAX]; /**< channels routing, see copy_samples */
44     int bps;
45     struct amerge_input {
46         struct FFBufQueue queue;
47         int nb_ch;         /**< number of channels for the input */
48         int nb_samples;
49         int pos;
50     } *in;
51 } AMergeContext;
52
53 #define OFFSET(x) offsetof(AMergeContext, x)
54 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
55
56 static const AVOption amerge_options[] = {
57     { "inputs", "specify the number of inputs", OFFSET(nb_inputs),
58       AV_OPT_TYPE_INT, { .i64 = 2 }, 1, SWR_CH_MAX, FLAGS },
59     { NULL }
60 };
61
62 AVFILTER_DEFINE_CLASS(amerge);
63
64 static av_cold void uninit(AVFilterContext *ctx)
65 {
66     AMergeContext *s = ctx->priv;
67     int i;
68
69     for (i = 0; i < s->nb_inputs; i++) {
70         if (s->in)
71             ff_bufqueue_discard_all(&s->in[i].queue);
72         if (ctx->input_pads)
73             av_freep(&ctx->input_pads[i].name);
74     }
75     av_freep(&s->in);
76 }
77
78 static int query_formats(AVFilterContext *ctx)
79 {
80     AMergeContext *s = ctx->priv;
81     int64_t inlayout[SWR_CH_MAX], outlayout = 0;
82     AVFilterFormats *formats;
83     AVFilterChannelLayouts *layouts;
84     int i, ret, overlap = 0, nb_ch = 0;
85
86     for (i = 0; i < s->nb_inputs; i++) {
87         if (!ctx->inputs[i]->in_channel_layouts ||
88             !ctx->inputs[i]->in_channel_layouts->nb_channel_layouts) {
89             av_log(ctx, AV_LOG_WARNING,
90                    "No channel layout for input %d\n", i + 1);
91             return AVERROR(EAGAIN);
92         }
93         inlayout[i] = ctx->inputs[i]->in_channel_layouts->channel_layouts[0];
94         if (ctx->inputs[i]->in_channel_layouts->nb_channel_layouts > 1) {
95             char buf[256];
96             av_get_channel_layout_string(buf, sizeof(buf), 0, inlayout[i]);
97             av_log(ctx, AV_LOG_INFO, "Using \"%s\" for input %d\n", buf, i + 1);
98         }
99         s->in[i].nb_ch = av_get_channel_layout_nb_channels(inlayout[i]);
100         if (outlayout & inlayout[i])
101             overlap++;
102         outlayout |= inlayout[i];
103         nb_ch += s->in[i].nb_ch;
104     }
105     if (nb_ch > SWR_CH_MAX) {
106         av_log(ctx, AV_LOG_ERROR, "Too many channels (max %d)\n", SWR_CH_MAX);
107         return AVERROR(EINVAL);
108     }
109     if (overlap) {
110         av_log(ctx, AV_LOG_WARNING,
111                "Input channel layouts overlap: "
112                "output layout will be determined by the number of distinct input channels\n");
113         for (i = 0; i < nb_ch; i++)
114             s->route[i] = i;
115         outlayout = av_get_default_channel_layout(nb_ch);
116         if (!outlayout && nb_ch)
117             outlayout = 0xFFFFFFFFFFFFFFFFULL >> (64 - nb_ch);
118     } else {
119         int *route[SWR_CH_MAX];
120         int c, out_ch_number = 0;
121
122         route[0] = s->route;
123         for (i = 1; i < s->nb_inputs; i++)
124             route[i] = route[i - 1] + s->in[i - 1].nb_ch;
125         for (c = 0; c < 64; c++)
126             for (i = 0; i < s->nb_inputs; i++)
127                 if ((inlayout[i] >> c) & 1)
128                     *(route[i]++) = out_ch_number++;
129     }
130     formats = ff_make_format_list(ff_packed_sample_fmts_array);
131     if ((ret = ff_set_common_formats(ctx, formats)) < 0)
132         return ret;
133     for (i = 0; i < s->nb_inputs; i++) {
134         layouts = NULL;
135         if ((ret = ff_add_channel_layout(&layouts, inlayout[i])) < 0)
136             return ret;
137         if ((ret = ff_channel_layouts_ref(layouts, &ctx->inputs[i]->out_channel_layouts)) < 0)
138             return ret;
139     }
140     layouts = NULL;
141     if ((ret = ff_add_channel_layout(&layouts, outlayout)) < 0)
142         return ret;
143     if ((ret = ff_channel_layouts_ref(layouts, &ctx->outputs[0]->in_channel_layouts)) < 0)
144         return ret;
145
146     return ff_set_common_samplerates(ctx, ff_all_samplerates());
147 }
148
149 static int config_output(AVFilterLink *outlink)
150 {
151     AVFilterContext *ctx = outlink->src;
152     AMergeContext *s = ctx->priv;
153     AVBPrint bp;
154     int i;
155
156     for (i = 1; i < s->nb_inputs; i++) {
157         if (ctx->inputs[i]->sample_rate != ctx->inputs[0]->sample_rate) {
158             av_log(ctx, AV_LOG_ERROR,
159                    "Inputs must have the same sample rate "
160                    "%d for in%d vs %d\n",
161                    ctx->inputs[i]->sample_rate, i, ctx->inputs[0]->sample_rate);
162             return AVERROR(EINVAL);
163         }
164     }
165     s->bps = av_get_bytes_per_sample(ctx->outputs[0]->format);
166     outlink->sample_rate = ctx->inputs[0]->sample_rate;
167     outlink->time_base   = ctx->inputs[0]->time_base;
168
169     av_bprint_init(&bp, 0, 1);
170     for (i = 0; i < s->nb_inputs; i++) {
171         av_bprintf(&bp, "%sin%d:", i ? " + " : "", i);
172         av_bprint_channel_layout(&bp, -1, ctx->inputs[i]->channel_layout);
173     }
174     av_bprintf(&bp, " -> out:");
175     av_bprint_channel_layout(&bp, -1, ctx->outputs[0]->channel_layout);
176     av_log(ctx, AV_LOG_VERBOSE, "%s\n", bp.str);
177
178     return 0;
179 }
180
181 static int request_frame(AVFilterLink *outlink)
182 {
183     AVFilterContext *ctx = outlink->src;
184     AMergeContext *s = ctx->priv;
185     int i, ret;
186
187     for (i = 0; i < s->nb_inputs; i++)
188         if (!s->in[i].nb_samples ||
189             /* detect EOF immediately */
190             (ctx->inputs[i]->status_in && !ctx->inputs[i]->status_out))
191             if ((ret = ff_request_frame(ctx->inputs[i])) < 0)
192                 return ret;
193     return 0;
194 }
195
196 /**
197  * Copy samples from several input streams to one output stream.
198  * @param nb_inputs number of inputs
199  * @param in        inputs; used only for the nb_ch field;
200  * @param route     routing values;
201  *                  input channel i goes to output channel route[i];
202  *                  i <  in[0].nb_ch are the channels from the first output;
203  *                  i >= in[0].nb_ch are the channels from the second output
204  * @param ins       pointer to the samples of each inputs, in packed format;
205  *                  will be left at the end of the copied samples
206  * @param outs      pointer to the samples of the output, in packet format;
207  *                  must point to a buffer big enough;
208  *                  will be left at the end of the copied samples
209  * @param ns        number of samples to copy
210  * @param bps       bytes per sample
211  */
212 static inline void copy_samples(int nb_inputs, struct amerge_input in[],
213                                 int *route, uint8_t *ins[],
214                                 uint8_t **outs, int ns, int bps)
215 {
216     int *route_cur;
217     int i, c, nb_ch = 0;
218
219     for (i = 0; i < nb_inputs; i++)
220         nb_ch += in[i].nb_ch;
221     while (ns--) {
222         route_cur = route;
223         for (i = 0; i < nb_inputs; i++) {
224             for (c = 0; c < in[i].nb_ch; c++) {
225                 memcpy((*outs) + bps * *(route_cur++), ins[i], bps);
226                 ins[i] += bps;
227             }
228         }
229         *outs += nb_ch * bps;
230     }
231 }
232
233 static int filter_frame(AVFilterLink *inlink, AVFrame *insamples)
234 {
235     AVFilterContext *ctx = inlink->dst;
236     AMergeContext *s = ctx->priv;
237     AVFilterLink *const outlink = ctx->outputs[0];
238     int input_number;
239     int nb_samples, ns, i;
240     AVFrame *outbuf, *inbuf[SWR_CH_MAX];
241     uint8_t *ins[SWR_CH_MAX], *outs;
242
243     for (input_number = 0; input_number < s->nb_inputs; input_number++)
244         if (inlink == ctx->inputs[input_number])
245             break;
246     av_assert1(input_number < s->nb_inputs);
247     if (ff_bufqueue_is_full(&s->in[input_number].queue)) {
248         av_frame_free(&insamples);
249         return AVERROR(ENOMEM);
250     }
251     ff_bufqueue_add(ctx, &s->in[input_number].queue, av_frame_clone(insamples));
252     s->in[input_number].nb_samples += insamples->nb_samples;
253     av_frame_free(&insamples);
254     nb_samples = s->in[0].nb_samples;
255     for (i = 1; i < s->nb_inputs; i++)
256         nb_samples = FFMIN(nb_samples, s->in[i].nb_samples);
257     if (!nb_samples)
258         return 0;
259
260     outbuf = ff_get_audio_buffer(ctx->outputs[0], nb_samples);
261     if (!outbuf)
262         return AVERROR(ENOMEM);
263     outs = outbuf->data[0];
264     for (i = 0; i < s->nb_inputs; i++) {
265         inbuf[i] = ff_bufqueue_peek(&s->in[i].queue, 0);
266         ins[i] = inbuf[i]->data[0] +
267                  s->in[i].pos * s->in[i].nb_ch * s->bps;
268     }
269     av_frame_copy_props(outbuf, inbuf[0]);
270     outbuf->pts = inbuf[0]->pts == AV_NOPTS_VALUE ? AV_NOPTS_VALUE :
271                   inbuf[0]->pts +
272                   av_rescale_q(s->in[0].pos,
273                                av_make_q(1, ctx->inputs[0]->sample_rate),
274                                ctx->outputs[0]->time_base);
275
276     outbuf->nb_samples     = nb_samples;
277     outbuf->channel_layout = outlink->channel_layout;
278     av_frame_set_channels(outbuf, outlink->channels);
279
280     while (nb_samples) {
281         ns = nb_samples;
282         for (i = 0; i < s->nb_inputs; i++)
283             ns = FFMIN(ns, inbuf[i]->nb_samples - s->in[i].pos);
284         /* Unroll the most common sample formats: speed +~350% for the loop,
285            +~13% overall (including two common decoders) */
286         switch (s->bps) {
287             case 1:
288                 copy_samples(s->nb_inputs, s->in, s->route, ins, &outs, ns, 1);
289                 break;
290             case 2:
291                 copy_samples(s->nb_inputs, s->in, s->route, ins, &outs, ns, 2);
292                 break;
293             case 4:
294                 copy_samples(s->nb_inputs, s->in, s->route, ins, &outs, ns, 4);
295                 break;
296             default:
297                 copy_samples(s->nb_inputs, s->in, s->route, ins, &outs, ns, s->bps);
298                 break;
299         }
300
301         nb_samples -= ns;
302         for (i = 0; i < s->nb_inputs; i++) {
303             s->in[i].nb_samples -= ns;
304             s->in[i].pos += ns;
305             if (s->in[i].pos == inbuf[i]->nb_samples) {
306                 s->in[i].pos = 0;
307                 av_frame_free(&inbuf[i]);
308                 ff_bufqueue_get(&s->in[i].queue);
309                 inbuf[i] = ff_bufqueue_peek(&s->in[i].queue, 0);
310                 ins[i] = inbuf[i] ? inbuf[i]->data[0] : NULL;
311             }
312         }
313     }
314     return ff_filter_frame(ctx->outputs[0], outbuf);
315 }
316
317 static av_cold int init(AVFilterContext *ctx)
318 {
319     AMergeContext *s = ctx->priv;
320     int i;
321
322     s->in = av_calloc(s->nb_inputs, sizeof(*s->in));
323     if (!s->in)
324         return AVERROR(ENOMEM);
325     for (i = 0; i < s->nb_inputs; i++) {
326         char *name = av_asprintf("in%d", i);
327         AVFilterPad pad = {
328             .name             = name,
329             .type             = AVMEDIA_TYPE_AUDIO,
330             .filter_frame     = filter_frame,
331         };
332         if (!name)
333             return AVERROR(ENOMEM);
334         ff_insert_inpad(ctx, i, &pad);
335     }
336     return 0;
337 }
338
339 static const AVFilterPad amerge_outputs[] = {
340     {
341         .name          = "default",
342         .type          = AVMEDIA_TYPE_AUDIO,
343         .config_props  = config_output,
344         .request_frame = request_frame,
345     },
346     { NULL }
347 };
348
349 AVFilter ff_af_amerge = {
350     .name          = "amerge",
351     .description   = NULL_IF_CONFIG_SMALL("Merge two or more audio streams into "
352                                           "a single multi-channel stream."),
353     .priv_size     = sizeof(AMergeContext),
354     .init          = init,
355     .uninit        = uninit,
356     .query_formats = query_formats,
357     .inputs        = NULL,
358     .outputs       = amerge_outputs,
359     .priv_class    = &amerge_class,
360     .flags         = AVFILTER_FLAG_DYNAMIC_INPUTS,
361 };