af_join: do not leak input frames.
[ffmpeg.git] / libavfilter / af_join.c
1 /*
2  *
3  * This file is part of Libav.
4  *
5  * Libav is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * Libav is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with Libav; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19
20 /**
21  * @file
22  * Audio join filter
23  *
24  * Join multiple audio inputs as different channels in
25  * a single output
26  */
27
28 #include "libavutil/avassert.h"
29 #include "libavutil/channel_layout.h"
30 #include "libavutil/common.h"
31 #include "libavutil/opt.h"
32
33 #include "audio.h"
34 #include "avfilter.h"
35 #include "formats.h"
36 #include "internal.h"
37
38 typedef struct ChannelMap {
39     int input;                ///< input stream index
40     int       in_channel_idx; ///< index of in_channel in the input stream data
41     uint64_t  in_channel;     ///< layout describing the input channel
42     uint64_t out_channel;     ///< layout describing the output channel
43 } ChannelMap;
44
45 typedef struct JoinContext {
46     const AVClass *class;
47
48     int inputs;
49     char *map;
50     char    *channel_layout_str;
51     uint64_t channel_layout;
52
53     int      nb_channels;
54     ChannelMap *channels;
55
56     /**
57      * Temporary storage for input frames, until we get one on each input.
58      */
59     AVFrame **input_frames;
60
61     /**
62      *  Temporary storage for buffer references, for assembling the output frame.
63      */
64     AVBufferRef **buffers;
65 } JoinContext;
66
67 #define OFFSET(x) offsetof(JoinContext, x)
68 #define A AV_OPT_FLAG_AUDIO_PARAM
69 static const AVOption join_options[] = {
70     { "inputs",         "Number of input streams.", OFFSET(inputs),             AV_OPT_TYPE_INT,    { .i64 = 2 }, 1, INT_MAX,       A },
71     { "channel_layout", "Channel layout of the "
72                         "output stream.",           OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, {.str = "stereo"}, 0, 0, A },
73     { "map",            "A comma-separated list of channels maps in the format "
74                         "'input_stream.input_channel-output_channel.",
75                                                     OFFSET(map),                AV_OPT_TYPE_STRING,                 .flags = A },
76     { NULL },
77 };
78
79 static const AVClass join_class = {
80     .class_name = "join filter",
81     .item_name  = av_default_item_name,
82     .option     = join_options,
83     .version    = LIBAVUTIL_VERSION_INT,
84 };
85
86 static int filter_frame(AVFilterLink *link, AVFrame *frame)
87 {
88     AVFilterContext *ctx = link->dst;
89     JoinContext       *s = ctx->priv;
90     int i;
91
92     for (i = 0; i < ctx->nb_inputs; i++)
93         if (link == ctx->inputs[i])
94             break;
95     av_assert0(i < ctx->nb_inputs);
96     av_assert0(!s->input_frames[i]);
97     s->input_frames[i] = frame;
98
99     return 0;
100 }
101
102 static int parse_maps(AVFilterContext *ctx)
103 {
104     JoinContext *s = ctx->priv;
105     char *cur      = s->map;
106
107     while (cur && *cur) {
108         char *sep, *next, *p;
109         uint64_t in_channel = 0, out_channel = 0;
110         int input_idx, out_ch_idx, in_ch_idx;
111
112         next = strchr(cur, ',');
113         if (next)
114             *next++ = 0;
115
116         /* split the map into input and output parts */
117         if (!(sep = strchr(cur, '-'))) {
118             av_log(ctx, AV_LOG_ERROR, "Missing separator '-' in channel "
119                    "map '%s'\n", cur);
120             return AVERROR(EINVAL);
121         }
122         *sep++ = 0;
123
124 #define PARSE_CHANNEL(str, var, inout)                                         \
125         if (!(var = av_get_channel_layout(str))) {                             \
126             av_log(ctx, AV_LOG_ERROR, "Invalid " inout " channel: %s.\n", str);\
127             return AVERROR(EINVAL);                                            \
128         }                                                                      \
129         if (av_get_channel_layout_nb_channels(var) != 1) {                     \
130             av_log(ctx, AV_LOG_ERROR, "Channel map describes more than one "   \
131                    inout " channel.\n");                                       \
132             return AVERROR(EINVAL);                                            \
133         }
134
135         /* parse output channel */
136         PARSE_CHANNEL(sep, out_channel, "output");
137         if (!(out_channel & s->channel_layout)) {
138             av_log(ctx, AV_LOG_ERROR, "Output channel '%s' is not present in "
139                    "requested channel layout.\n", sep);
140             return AVERROR(EINVAL);
141         }
142
143         out_ch_idx = av_get_channel_layout_channel_index(s->channel_layout,
144                                                          out_channel);
145         if (s->channels[out_ch_idx].input >= 0) {
146             av_log(ctx, AV_LOG_ERROR, "Multiple maps for output channel "
147                    "'%s'.\n", sep);
148             return AVERROR(EINVAL);
149         }
150
151         /* parse input channel */
152         input_idx = strtol(cur, &cur, 0);
153         if (input_idx < 0 || input_idx >= s->inputs) {
154             av_log(ctx, AV_LOG_ERROR, "Invalid input stream index: %d.\n",
155                    input_idx);
156             return AVERROR(EINVAL);
157         }
158
159         if (*cur)
160             cur++;
161
162         in_ch_idx = strtol(cur, &p, 0);
163         if (p == cur) {
164             /* channel specifier is not a number,
165              * try to parse as channel name */
166             PARSE_CHANNEL(cur, in_channel, "input");
167         }
168
169         s->channels[out_ch_idx].input      = input_idx;
170         if (in_channel)
171             s->channels[out_ch_idx].in_channel = in_channel;
172         else
173             s->channels[out_ch_idx].in_channel_idx = in_ch_idx;
174
175         cur = next;
176     }
177     return 0;
178 }
179
180 static int join_init(AVFilterContext *ctx, const char *args)
181 {
182     JoinContext *s = ctx->priv;
183     int ret, i;
184
185     s->class = &join_class;
186     av_opt_set_defaults(s);
187     if ((ret = av_set_options_string(s, args, "=", ":")) < 0) {
188         av_log(ctx, AV_LOG_ERROR, "Error parsing options string '%s'.\n", args);
189         return ret;
190     }
191
192     if (!(s->channel_layout = av_get_channel_layout(s->channel_layout_str))) {
193         av_log(ctx, AV_LOG_ERROR, "Error parsing channel layout '%s'.\n",
194                s->channel_layout_str);
195         ret = AVERROR(EINVAL);
196         goto fail;
197     }
198
199     s->nb_channels  = av_get_channel_layout_nb_channels(s->channel_layout);
200     s->channels     = av_mallocz(sizeof(*s->channels) * s->nb_channels);
201     s->buffers      = av_mallocz(sizeof(*s->buffers)  * s->nb_channels);
202     s->input_frames = av_mallocz(sizeof(*s->input_frames) * s->inputs);
203     if (!s->channels || !s->buffers|| !s->input_frames) {
204         ret = AVERROR(ENOMEM);
205         goto fail;
206     }
207
208     for (i = 0; i < s->nb_channels; i++) {
209         s->channels[i].out_channel = av_channel_layout_extract_channel(s->channel_layout, i);
210         s->channels[i].input       = -1;
211     }
212
213     if ((ret = parse_maps(ctx)) < 0)
214         goto fail;
215
216     for (i = 0; i < s->inputs; i++) {
217         char name[32];
218         AVFilterPad pad = { 0 };
219
220         snprintf(name, sizeof(name), "input%d", i);
221         pad.type           = AVMEDIA_TYPE_AUDIO;
222         pad.name           = av_strdup(name);
223         pad.filter_frame   = filter_frame;
224
225         pad.needs_fifo = 1;
226
227         ff_insert_inpad(ctx, i, &pad);
228     }
229
230 fail:
231     av_opt_free(s);
232     return ret;
233 }
234
235 static void join_uninit(AVFilterContext *ctx)
236 {
237     JoinContext *s = ctx->priv;
238     int i;
239
240     for (i = 0; i < ctx->nb_inputs; i++) {
241         av_freep(&ctx->input_pads[i].name);
242         av_frame_free(&s->input_frames[i]);
243     }
244
245     av_freep(&s->channels);
246     av_freep(&s->buffers);
247     av_freep(&s->input_frames);
248 }
249
250 static int join_query_formats(AVFilterContext *ctx)
251 {
252     JoinContext *s = ctx->priv;
253     AVFilterChannelLayouts *layouts = NULL;
254     int i;
255
256     ff_add_channel_layout(&layouts, s->channel_layout);
257     ff_channel_layouts_ref(layouts, &ctx->outputs[0]->in_channel_layouts);
258
259     for (i = 0; i < ctx->nb_inputs; i++)
260         ff_channel_layouts_ref(ff_all_channel_layouts(),
261                                &ctx->inputs[i]->out_channel_layouts);
262
263     ff_set_common_formats    (ctx, ff_planar_sample_fmts());
264     ff_set_common_samplerates(ctx, ff_all_samplerates());
265
266     return 0;
267 }
268
269 static void guess_map_matching(AVFilterContext *ctx, ChannelMap *ch,
270                                uint64_t *inputs)
271 {
272     int i;
273
274     for (i = 0; i < ctx->nb_inputs; i++) {
275         AVFilterLink *link = ctx->inputs[i];
276
277         if (ch->out_channel & link->channel_layout &&
278             !(ch->out_channel & inputs[i])) {
279             ch->input      = i;
280             ch->in_channel = ch->out_channel;
281             inputs[i]     |= ch->out_channel;
282             return;
283         }
284     }
285 }
286
287 static void guess_map_any(AVFilterContext *ctx, ChannelMap *ch,
288                           uint64_t *inputs)
289 {
290     int i;
291
292     for (i = 0; i < ctx->nb_inputs; i++) {
293         AVFilterLink *link = ctx->inputs[i];
294
295         if ((inputs[i] & link->channel_layout) != link->channel_layout) {
296             uint64_t unused = link->channel_layout & ~inputs[i];
297
298             ch->input      = i;
299             ch->in_channel = av_channel_layout_extract_channel(unused, 0);
300             inputs[i]     |= ch->in_channel;
301             return;
302         }
303     }
304 }
305
306 static int join_config_output(AVFilterLink *outlink)
307 {
308     AVFilterContext *ctx = outlink->src;
309     JoinContext       *s = ctx->priv;
310     uint64_t *inputs;   // nth element tracks which channels are used from nth input
311     int i, ret = 0;
312
313     /* initialize inputs to user-specified mappings */
314     if (!(inputs = av_mallocz(sizeof(*inputs) * ctx->nb_inputs)))
315         return AVERROR(ENOMEM);
316     for (i = 0; i < s->nb_channels; i++) {
317         ChannelMap *ch = &s->channels[i];
318         AVFilterLink *inlink;
319
320         if (ch->input < 0)
321             continue;
322
323         inlink = ctx->inputs[ch->input];
324
325         if (!ch->in_channel)
326             ch->in_channel = av_channel_layout_extract_channel(inlink->channel_layout,
327                                                                ch->in_channel_idx);
328
329         if (!(ch->in_channel & inlink->channel_layout)) {
330             av_log(ctx, AV_LOG_ERROR, "Requested channel %s is not present in "
331                    "input stream #%d.\n", av_get_channel_name(ch->in_channel),
332                    ch->input);
333             ret = AVERROR(EINVAL);
334             goto fail;
335         }
336
337         inputs[ch->input] |= ch->in_channel;
338     }
339
340     /* guess channel maps when not explicitly defined */
341     /* first try unused matching channels */
342     for (i = 0; i < s->nb_channels; i++) {
343         ChannelMap *ch = &s->channels[i];
344
345         if (ch->input < 0)
346             guess_map_matching(ctx, ch, inputs);
347     }
348
349     /* if the above failed, try to find _any_ unused input channel */
350     for (i = 0; i < s->nb_channels; i++) {
351         ChannelMap *ch = &s->channels[i];
352
353         if (ch->input < 0)
354             guess_map_any(ctx, ch, inputs);
355
356         if (ch->input < 0) {
357             av_log(ctx, AV_LOG_ERROR, "Could not find input channel for "
358                    "output channel '%s'.\n",
359                    av_get_channel_name(ch->out_channel));
360             goto fail;
361         }
362
363         ch->in_channel_idx = av_get_channel_layout_channel_index(ctx->inputs[ch->input]->channel_layout,
364                                                                  ch->in_channel);
365     }
366
367     /* print mappings */
368     av_log(ctx, AV_LOG_VERBOSE, "mappings: ");
369     for (i = 0; i < s->nb_channels; i++) {
370         ChannelMap *ch = &s->channels[i];
371         av_log(ctx, AV_LOG_VERBOSE, "%d.%s => %s ", ch->input,
372                av_get_channel_name(ch->in_channel),
373                av_get_channel_name(ch->out_channel));
374     }
375     av_log(ctx, AV_LOG_VERBOSE, "\n");
376
377     for (i = 0; i < ctx->nb_inputs; i++) {
378         if (!inputs[i])
379             av_log(ctx, AV_LOG_WARNING, "No channels are used from input "
380                    "stream %d.\n", i);
381     }
382
383 fail:
384     av_freep(&inputs);
385     return ret;
386 }
387
388 static int join_request_frame(AVFilterLink *outlink)
389 {
390     AVFilterContext *ctx = outlink->src;
391     JoinContext *s       = ctx->priv;
392     AVFrame *frame;
393     int linesize   = INT_MAX;
394     int nb_samples = 0;
395     int nb_buffers = 0;
396     int i, j, ret;
397
398     /* get a frame on each input */
399     for (i = 0; i < ctx->nb_inputs; i++) {
400         AVFilterLink *inlink = ctx->inputs[i];
401
402         if (!s->input_frames[i] &&
403             (ret = ff_request_frame(inlink)) < 0)
404             return ret;
405
406         /* request the same number of samples on all inputs */
407         if (i == 0) {
408             nb_samples = s->input_frames[0]->nb_samples;
409
410             for (j = 1; !i && j < ctx->nb_inputs; j++)
411                 ctx->inputs[j]->request_samples = nb_samples;
412         }
413     }
414
415     /* setup the output frame */
416     frame = av_frame_alloc();
417     if (!frame)
418         return AVERROR(ENOMEM);
419     if (s->nb_channels > FF_ARRAY_ELEMS(frame->data)) {
420         frame->extended_data = av_mallocz(s->nb_channels *
421                                           sizeof(*frame->extended_data));
422         if (!frame->extended_data) {
423             ret = AVERROR(ENOMEM);
424             goto fail;
425         }
426     }
427
428     /* copy the data pointers */
429     for (i = 0; i < s->nb_channels; i++) {
430         ChannelMap *ch = &s->channels[i];
431         AVFrame *cur   = s->input_frames[ch->input];
432         AVBufferRef *buf;
433
434         frame->extended_data[i] = cur->extended_data[ch->in_channel_idx];
435         linesize = FFMIN(linesize, cur->linesize[0]);
436
437         /* add the buffer where this plan is stored to the list if it's
438          * not already there */
439         buf = av_frame_get_plane_buffer(cur, ch->in_channel_idx);
440         if (!buf) {
441             ret = AVERROR(EINVAL);
442             goto fail;
443         }
444         for (j = 0; j < nb_buffers; j++)
445             if (s->buffers[j]->buffer == buf->buffer)
446                 break;
447         if (j == i)
448             s->buffers[nb_buffers++] = buf;
449     }
450
451     /* create references to the buffers we copied to output */
452     if (nb_buffers > FF_ARRAY_ELEMS(frame->buf)) {
453         frame->nb_extended_buf = nb_buffers - FF_ARRAY_ELEMS(frame->buf);
454         frame->extended_buf = av_mallocz(sizeof(*frame->extended_buf) *
455                                          frame->nb_extended_buf);
456         if (!frame->extended_buf) {
457             frame->nb_extended_buf = 0;
458             ret = AVERROR(ENOMEM);
459             goto fail;
460         }
461     }
462     for (i = 0; i < FFMIN(FF_ARRAY_ELEMS(frame->buf), nb_buffers); i++) {
463         frame->buf[i] = av_buffer_ref(s->buffers[i]);
464         if (!frame->buf[i]) {
465             ret = AVERROR(ENOMEM);
466             goto fail;
467         }
468     }
469     for (i = 0; i < frame->nb_extended_buf; i++) {
470         frame->extended_buf[i] = av_buffer_ref(s->buffers[i +
471                                                FF_ARRAY_ELEMS(frame->buf)]);
472         if (!frame->extended_buf[i]) {
473             ret = AVERROR(ENOMEM);
474             goto fail;
475         }
476     }
477
478     frame->nb_samples     = nb_samples;
479     frame->channel_layout = outlink->channel_layout;
480     frame->sample_rate    = outlink->sample_rate;
481     frame->pts            = s->input_frames[0]->pts;
482     frame->linesize[0]    = linesize;
483     if (frame->data != frame->extended_data) {
484         memcpy(frame->data, frame->extended_data, sizeof(*frame->data) *
485                FFMIN(FF_ARRAY_ELEMS(frame->data), s->nb_channels));
486     }
487
488     ret = ff_filter_frame(outlink, frame);
489
490     for (i = 0; i < ctx->nb_inputs; i++)
491         av_frame_free(&s->input_frames[i]);
492
493     return ret;
494
495 fail:
496     av_frame_free(&frame);
497     return ret;
498 }
499
500 static const AVFilterPad avfilter_af_join_outputs[] = {
501     {
502         .name          = "default",
503         .type          = AVMEDIA_TYPE_AUDIO,
504         .config_props  = join_config_output,
505         .request_frame = join_request_frame,
506     },
507     { NULL }
508 };
509
510 AVFilter avfilter_af_join = {
511     .name           = "join",
512     .description    = NULL_IF_CONFIG_SMALL("Join multiple audio streams into "
513                                            "multi-channel output"),
514     .priv_size      = sizeof(JoinContext),
515
516     .init           = join_init,
517     .uninit         = join_uninit,
518     .query_formats  = join_query_formats,
519
520     .inputs  = NULL,
521     .outputs = avfilter_af_join_outputs,
522 };