2c7d4d67ad2a8111561e92a825552f2aa25938c3
[ffmpeg.git] / libavfilter / af_amix.c
1 /*
2  * Audio Mix Filter
3  * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * Audio Mix Filter
25  *
26  * Mixes audio from multiple sources into a single output. The channel layout,
27  * sample rate, and sample format will be the same for all inputs and the
28  * output.
29  */
30
31 #include "libavutil/audioconvert.h"
32 #include "libavutil/audio_fifo.h"
33 #include "libavutil/avassert.h"
34 #include "libavutil/avstring.h"
35 #include "libavutil/common.h"
36 #include "libavutil/float_dsp.h"
37 #include "libavutil/mathematics.h"
38 #include "libavutil/opt.h"
39 #include "libavutil/samplefmt.h"
40
41 #include "audio.h"
42 #include "avfilter.h"
43 #include "formats.h"
44 #include "internal.h"
45
46 #define INPUT_OFF      0    /**< input has reached EOF */
47 #define INPUT_ON       1    /**< input is active */
48 #define INPUT_INACTIVE 2    /**< input is on, but is currently inactive */
49
50 #define DURATION_LONGEST  0
51 #define DURATION_SHORTEST 1
52 #define DURATION_FIRST    2
53
54
55 typedef struct FrameInfo {
56     int nb_samples;
57     int64_t pts;
58     struct FrameInfo *next;
59 } FrameInfo;
60
61 /**
62  * Linked list used to store timestamps and frame sizes of all frames in the
63  * FIFO for the first input.
64  *
65  * This is needed to keep timestamps synchronized for the case where multiple
66  * input frames are pushed to the filter for processing before a frame is
67  * requested by the output link.
68  */
69 typedef struct FrameList {
70     int nb_frames;
71     int nb_samples;
72     FrameInfo *list;
73     FrameInfo *end;
74 } FrameList;
75
76 static void frame_list_clear(FrameList *frame_list)
77 {
78     if (frame_list) {
79         while (frame_list->list) {
80             FrameInfo *info = frame_list->list;
81             frame_list->list = info->next;
82             av_free(info);
83         }
84         frame_list->nb_frames  = 0;
85         frame_list->nb_samples = 0;
86         frame_list->end        = NULL;
87     }
88 }
89
90 static int frame_list_next_frame_size(FrameList *frame_list)
91 {
92     if (!frame_list->list)
93         return 0;
94     return frame_list->list->nb_samples;
95 }
96
97 static int64_t frame_list_next_pts(FrameList *frame_list)
98 {
99     if (!frame_list->list)
100         return AV_NOPTS_VALUE;
101     return frame_list->list->pts;
102 }
103
104 static void frame_list_remove_samples(FrameList *frame_list, int nb_samples)
105 {
106     if (nb_samples >= frame_list->nb_samples) {
107         frame_list_clear(frame_list);
108     } else {
109         int samples = nb_samples;
110         while (samples > 0) {
111             FrameInfo *info = frame_list->list;
112             av_assert0(info != NULL);
113             if (info->nb_samples <= samples) {
114                 samples -= info->nb_samples;
115                 frame_list->list = info->next;
116                 if (!frame_list->list)
117                     frame_list->end = NULL;
118                 frame_list->nb_frames--;
119                 frame_list->nb_samples -= info->nb_samples;
120                 av_free(info);
121             } else {
122                 info->nb_samples       -= samples;
123                 info->pts              += samples;
124                 frame_list->nb_samples -= samples;
125                 samples = 0;
126             }
127         }
128     }
129 }
130
131 static int frame_list_add_frame(FrameList *frame_list, int nb_samples, int64_t pts)
132 {
133     FrameInfo *info = av_malloc(sizeof(*info));
134     if (!info)
135         return AVERROR(ENOMEM);
136     info->nb_samples = nb_samples;
137     info->pts        = pts;
138     info->next       = NULL;
139
140     if (!frame_list->list) {
141         frame_list->list = info;
142         frame_list->end  = info;
143     } else {
144         av_assert0(frame_list->end != NULL);
145         frame_list->end->next = info;
146         frame_list->end       = info;
147     }
148     frame_list->nb_frames++;
149     frame_list->nb_samples += nb_samples;
150
151     return 0;
152 }
153
154
155 typedef struct MixContext {
156     const AVClass *class;       /**< class for AVOptions */
157     AVFloatDSPContext fdsp;
158
159     int nb_inputs;              /**< number of inputs */
160     int active_inputs;          /**< number of input currently active */
161     int duration_mode;          /**< mode for determining duration */
162     float dropout_transition;   /**< transition time when an input drops out */
163
164     int nb_channels;            /**< number of channels */
165     int sample_rate;            /**< sample rate */
166     int planar;
167     AVAudioFifo **fifos;        /**< audio fifo for each input */
168     uint8_t *input_state;       /**< current state of each input */
169     float *input_scale;         /**< mixing scale factor for each input */
170     float scale_norm;           /**< normalization factor for all inputs */
171     int64_t next_pts;           /**< calculated pts for next output frame */
172     FrameList *frame_list;      /**< list of frame info for the first input */
173 } MixContext;
174
175 #define OFFSET(x) offsetof(MixContext, x)
176 #define A AV_OPT_FLAG_AUDIO_PARAM
177 #define F AV_OPT_FLAG_FILTERING_PARAM
178 static const AVOption amix_options[] = {
179     { "inputs", "Number of inputs.",
180             OFFSET(nb_inputs), AV_OPT_TYPE_INT, { 2 }, 1, 32, A|F },
181     { "duration", "How to determine the end-of-stream.",
182             OFFSET(duration_mode), AV_OPT_TYPE_INT, { DURATION_LONGEST }, 0,  2, A|F, "duration" },
183         { "longest",  "Duration of longest input.",  0, AV_OPT_TYPE_CONST, { .i64 = DURATION_LONGEST  }, INT_MIN, INT_MAX, A|F, "duration" },
184         { "shortest", "Duration of shortest input.", 0, AV_OPT_TYPE_CONST, { .i64 = DURATION_SHORTEST }, INT_MIN, INT_MAX, A|F, "duration" },
185         { "first",    "Duration of first input.",    0, AV_OPT_TYPE_CONST, { .i64 = DURATION_FIRST    }, INT_MIN, INT_MAX, A|F, "duration" },
186     { "dropout_transition", "Transition time, in seconds, for volume "
187                             "renormalization when an input stream ends.",
188             OFFSET(dropout_transition), AV_OPT_TYPE_FLOAT, { 2.0 }, 0, INT_MAX, A|F },
189     { NULL },
190 };
191
192 AVFILTER_DEFINE_CLASS(amix);
193
194 /**
195  * Update the scaling factors to apply to each input during mixing.
196  *
197  * This balances the full volume range between active inputs and handles
198  * volume transitions when EOF is encountered on an input but mixing continues
199  * with the remaining inputs.
200  */
201 static void calculate_scales(MixContext *s, int nb_samples)
202 {
203     int i;
204
205     if (s->scale_norm > s->active_inputs) {
206         s->scale_norm -= nb_samples / (s->dropout_transition * s->sample_rate);
207         s->scale_norm = FFMAX(s->scale_norm, s->active_inputs);
208     }
209
210     for (i = 0; i < s->nb_inputs; i++) {
211         if (s->input_state[i] == INPUT_ON)
212             s->input_scale[i] = 1.0f / s->scale_norm;
213         else
214             s->input_scale[i] = 0.0f;
215     }
216 }
217
218 static int config_output(AVFilterLink *outlink)
219 {
220     AVFilterContext *ctx = outlink->src;
221     MixContext *s      = ctx->priv;
222     int i;
223     char buf[64];
224
225     s->planar          = av_sample_fmt_is_planar(outlink->format);
226     s->sample_rate     = outlink->sample_rate;
227     outlink->time_base = (AVRational){ 1, outlink->sample_rate };
228     s->next_pts        = AV_NOPTS_VALUE;
229
230     s->frame_list = av_mallocz(sizeof(*s->frame_list));
231     if (!s->frame_list)
232         return AVERROR(ENOMEM);
233
234     s->fifos = av_mallocz(s->nb_inputs * sizeof(*s->fifos));
235     if (!s->fifos)
236         return AVERROR(ENOMEM);
237
238     s->nb_channels = av_get_channel_layout_nb_channels(outlink->channel_layout);
239     for (i = 0; i < s->nb_inputs; i++) {
240         s->fifos[i] = av_audio_fifo_alloc(outlink->format, s->nb_channels, 1024);
241         if (!s->fifos[i])
242             return AVERROR(ENOMEM);
243     }
244
245     s->input_state = av_malloc(s->nb_inputs);
246     if (!s->input_state)
247         return AVERROR(ENOMEM);
248     memset(s->input_state, INPUT_ON, s->nb_inputs);
249     s->active_inputs = s->nb_inputs;
250
251     s->input_scale = av_mallocz(s->nb_inputs * sizeof(*s->input_scale));
252     if (!s->input_scale)
253         return AVERROR(ENOMEM);
254     s->scale_norm = s->active_inputs;
255     calculate_scales(s, 0);
256
257     av_get_channel_layout_string(buf, sizeof(buf), -1, outlink->channel_layout);
258
259     av_log(ctx, AV_LOG_VERBOSE,
260            "inputs:%d fmt:%s srate:%d cl:%s\n", s->nb_inputs,
261            av_get_sample_fmt_name(outlink->format), outlink->sample_rate, buf);
262
263     return 0;
264 }
265
266 /**
267  * Read samples from the input FIFOs, mix, and write to the output link.
268  */
269 static int output_frame(AVFilterLink *outlink, int nb_samples)
270 {
271     AVFilterContext *ctx = outlink->src;
272     MixContext      *s = ctx->priv;
273     AVFilterBufferRef *out_buf, *in_buf;
274     int i;
275
276     calculate_scales(s, nb_samples);
277
278     out_buf = ff_get_audio_buffer(outlink, AV_PERM_WRITE, nb_samples);
279     if (!out_buf)
280         return AVERROR(ENOMEM);
281
282     in_buf = ff_get_audio_buffer(outlink, AV_PERM_WRITE, nb_samples);
283     if (!in_buf)
284         return AVERROR(ENOMEM);
285
286     for (i = 0; i < s->nb_inputs; i++) {
287         if (s->input_state[i] == INPUT_ON) {
288             int planes, plane_size, p;
289
290             av_audio_fifo_read(s->fifos[i], (void **)in_buf->extended_data,
291                                nb_samples);
292
293             planes     = s->planar ? s->nb_channels : 1;
294             plane_size = nb_samples * (s->planar ? 1 : s->nb_channels);
295             plane_size = FFALIGN(plane_size, 16);
296
297             for (p = 0; p < planes; p++) {
298                 s->fdsp.vector_fmac_scalar((float *)out_buf->extended_data[p],
299                                            (float *) in_buf->extended_data[p],
300                                            s->input_scale[i], plane_size);
301             }
302         }
303     }
304     avfilter_unref_buffer(in_buf);
305
306     out_buf->pts = s->next_pts;
307     if (s->next_pts != AV_NOPTS_VALUE)
308         s->next_pts += nb_samples;
309
310     return ff_filter_samples(outlink, out_buf);
311 }
312
313 /**
314  * Returns the smallest number of samples available in the input FIFOs other
315  * than that of the first input.
316  */
317 static int get_available_samples(MixContext *s)
318 {
319     int i;
320     int available_samples = INT_MAX;
321
322     av_assert0(s->nb_inputs > 1);
323
324     for (i = 1; i < s->nb_inputs; i++) {
325         int nb_samples;
326         if (s->input_state[i] == INPUT_OFF)
327             continue;
328         nb_samples = av_audio_fifo_size(s->fifos[i]);
329         available_samples = FFMIN(available_samples, nb_samples);
330     }
331     if (available_samples == INT_MAX)
332         return 0;
333     return available_samples;
334 }
335
336 /**
337  * Requests a frame, if needed, from each input link other than the first.
338  */
339 static int request_samples(AVFilterContext *ctx, int min_samples)
340 {
341     MixContext *s = ctx->priv;
342     int i, ret;
343
344     av_assert0(s->nb_inputs > 1);
345
346     for (i = 1; i < s->nb_inputs; i++) {
347         ret = 0;
348         if (s->input_state[i] == INPUT_OFF)
349             continue;
350         while (!ret && av_audio_fifo_size(s->fifos[i]) < min_samples)
351             ret = ff_request_frame(ctx->inputs[i]);
352         if (ret == AVERROR_EOF) {
353             if (av_audio_fifo_size(s->fifos[i]) == 0) {
354                 s->input_state[i] = INPUT_OFF;
355                 continue;
356             }
357         } else if (ret < 0)
358             return ret;
359     }
360     return 0;
361 }
362
363 /**
364  * Calculates the number of active inputs and determines EOF based on the
365  * duration option.
366  *
367  * @return 0 if mixing should continue, or AVERROR_EOF if mixing should stop.
368  */
369 static int calc_active_inputs(MixContext *s)
370 {
371     int i;
372     int active_inputs = 0;
373     for (i = 0; i < s->nb_inputs; i++)
374         active_inputs += !!(s->input_state[i] != INPUT_OFF);
375     s->active_inputs = active_inputs;
376
377     if (!active_inputs ||
378         (s->duration_mode == DURATION_FIRST && s->input_state[0] == INPUT_OFF) ||
379         (s->duration_mode == DURATION_SHORTEST && active_inputs != s->nb_inputs))
380         return AVERROR_EOF;
381     return 0;
382 }
383
384 static int request_frame(AVFilterLink *outlink)
385 {
386     AVFilterContext *ctx = outlink->src;
387     MixContext      *s = ctx->priv;
388     int ret;
389     int wanted_samples, available_samples;
390
391     ret = calc_active_inputs(s);
392     if (ret < 0)
393         return ret;
394
395     if (s->input_state[0] == INPUT_OFF) {
396         ret = request_samples(ctx, 1);
397         if (ret < 0)
398             return ret;
399
400         ret = calc_active_inputs(s);
401         if (ret < 0)
402             return ret;
403
404         available_samples = get_available_samples(s);
405         if (!available_samples)
406             return AVERROR(EAGAIN);
407
408         return output_frame(outlink, available_samples);
409     }
410
411     if (s->frame_list->nb_frames == 0) {
412         ret = ff_request_frame(ctx->inputs[0]);
413         if (ret == AVERROR_EOF) {
414             s->input_state[0] = INPUT_OFF;
415             if (s->nb_inputs == 1)
416                 return AVERROR_EOF;
417             else
418                 return AVERROR(EAGAIN);
419         } else if (ret < 0)
420             return ret;
421     }
422     av_assert0(s->frame_list->nb_frames > 0);
423
424     wanted_samples = frame_list_next_frame_size(s->frame_list);
425
426     if (s->active_inputs > 1) {
427         ret = request_samples(ctx, wanted_samples);
428         if (ret < 0)
429             return ret;
430
431         ret = calc_active_inputs(s);
432         if (ret < 0)
433             return ret;
434     }
435
436     if (s->active_inputs > 1) {
437         available_samples = get_available_samples(s);
438         if (!available_samples)
439             return AVERROR(EAGAIN);
440         available_samples = FFMIN(available_samples, wanted_samples);
441     } else {
442         available_samples = wanted_samples;
443     }
444
445     s->next_pts = frame_list_next_pts(s->frame_list);
446     frame_list_remove_samples(s->frame_list, available_samples);
447
448     return output_frame(outlink, available_samples);
449 }
450
451 static int filter_samples(AVFilterLink *inlink, AVFilterBufferRef *buf)
452 {
453     AVFilterContext  *ctx = inlink->dst;
454     MixContext       *s = ctx->priv;
455     AVFilterLink *outlink = ctx->outputs[0];
456     int i, ret = 0;
457
458     for (i = 0; i < ctx->nb_inputs; i++)
459         if (ctx->inputs[i] == inlink)
460             break;
461     if (i >= ctx->nb_inputs) {
462         av_log(ctx, AV_LOG_ERROR, "unknown input link\n");
463         ret = AVERROR(EINVAL);
464         goto fail;
465     }
466
467     if (i == 0) {
468         int64_t pts = av_rescale_q(buf->pts, inlink->time_base,
469                                    outlink->time_base);
470         ret = frame_list_add_frame(s->frame_list, buf->audio->nb_samples, pts);
471         if (ret < 0)
472             goto fail;
473     }
474
475     ret = av_audio_fifo_write(s->fifos[i], (void **)buf->extended_data,
476                               buf->audio->nb_samples);
477
478 fail:
479     avfilter_unref_buffer(buf);
480
481     return ret;
482 }
483
484 static int init(AVFilterContext *ctx, const char *args)
485 {
486     MixContext *s = ctx->priv;
487     int i, ret;
488
489     s->class = &amix_class;
490     av_opt_set_defaults(s);
491
492     if ((ret = av_set_options_string(s, args, "=", ":")) < 0)
493         return ret;
494     av_opt_free(s);
495
496     for (i = 0; i < s->nb_inputs; i++) {
497         char name[32];
498         AVFilterPad pad = { 0 };
499
500         snprintf(name, sizeof(name), "input%d", i);
501         pad.type           = AVMEDIA_TYPE_AUDIO;
502         pad.name           = av_strdup(name);
503         pad.filter_samples = filter_samples;
504
505         ff_insert_inpad(ctx, i, &pad);
506     }
507
508     avpriv_float_dsp_init(&s->fdsp, 0);
509
510     return 0;
511 }
512
513 static void uninit(AVFilterContext *ctx)
514 {
515     int i;
516     MixContext *s = ctx->priv;
517
518     if (s->fifos) {
519         for (i = 0; i < s->nb_inputs; i++)
520             av_audio_fifo_free(s->fifos[i]);
521         av_freep(&s->fifos);
522     }
523     frame_list_clear(s->frame_list);
524     av_freep(&s->frame_list);
525     av_freep(&s->input_state);
526     av_freep(&s->input_scale);
527
528     for (i = 0; i < ctx->nb_inputs; i++)
529         av_freep(&ctx->input_pads[i].name);
530 }
531
532 static int query_formats(AVFilterContext *ctx)
533 {
534     AVFilterFormats *formats = NULL;
535     ff_add_format(&formats, AV_SAMPLE_FMT_FLT);
536     ff_add_format(&formats, AV_SAMPLE_FMT_FLTP);
537     ff_set_common_formats(ctx, formats);
538     ff_set_common_channel_layouts(ctx, ff_all_channel_layouts());
539     ff_set_common_samplerates(ctx, ff_all_samplerates());
540     return 0;
541 }
542
543 AVFilter avfilter_af_amix = {
544     .name          = "amix",
545     .description   = NULL_IF_CONFIG_SMALL("Audio mixing."),
546     .priv_size     = sizeof(MixContext),
547
548     .init           = init,
549     .uninit         = uninit,
550     .query_formats  = query_formats,
551
552     .inputs    = (const AVFilterPad[]) {{ .name = NULL}},
553     .outputs   = (const AVFilterPad[]) {{ .name          = "default",
554                                           .type          = AVMEDIA_TYPE_AUDIO,
555                                           .config_props  = config_output,
556                                           .request_frame = request_frame },
557                                         { .name = NULL}},
558     .priv_class = &amix_class,
559 };