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