buffersrc: Fix resource leak on error
[ffmpeg.git] / libavfilter / buffersrc.c
1 /*
2  * Copyright (c) 2008 Vitor Sessak
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 GNU
14  * 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 Libav; 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  * memory buffer source filter
24  */
25
26 #include <float.h>
27
28 #include "libavutil/channel_layout.h"
29 #include "libavutil/common.h"
30 #include "libavutil/fifo.h"
31 #include "libavutil/frame.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/internal.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/samplefmt.h"
36 #include "audio.h"
37 #include "avfilter.h"
38 #include "buffersrc.h"
39 #include "formats.h"
40 #include "internal.h"
41 #include "video.h"
42
43 typedef struct BufferSourceContext {
44     const AVClass    *class;
45     AVFifoBuffer     *fifo;
46     AVRational        time_base;     ///< time_base to set in the output link
47
48     /* video only */
49     int               h, w;
50     enum AVPixelFormat  pix_fmt;
51     char               *pix_fmt_str;
52     AVRational        pixel_aspect;
53
54     /* audio only */
55     int sample_rate;
56     enum AVSampleFormat sample_fmt;
57     char               *sample_fmt_str;
58     uint64_t channel_layout;
59     char    *channel_layout_str;
60
61     int eof;
62 } BufferSourceContext;
63
64 #define CHECK_VIDEO_PARAM_CHANGE(s, c, width, height, format)\
65     if (c->w != width || c->h != height || c->pix_fmt != format) {\
66         av_log(s, AV_LOG_ERROR, "Changing frame properties on the fly is not supported.\n");\
67         return AVERROR(EINVAL);\
68     }
69
70 #define CHECK_AUDIO_PARAM_CHANGE(s, c, srate, ch_layout, format)\
71     if (c->sample_fmt != format || c->sample_rate != srate ||\
72         c->channel_layout != ch_layout) {\
73         av_log(s, AV_LOG_ERROR, "Changing frame properties on the fly is not supported.\n");\
74         return AVERROR(EINVAL);\
75     }
76
77 int attribute_align_arg av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame)
78 {
79     AVFrame *copy;
80     int ret = 0;
81
82     if (!(copy = av_frame_alloc()))
83         return AVERROR(ENOMEM);
84     ret = av_frame_ref(copy, frame);
85     if (ret >= 0)
86         ret = av_buffersrc_add_frame(ctx, copy);
87
88     av_frame_free(&copy);
89     return ret;
90 }
91
92 int attribute_align_arg av_buffersrc_add_frame(AVFilterContext *ctx,
93                                                AVFrame *frame)
94 {
95     BufferSourceContext *s = ctx->priv;
96     AVFrame *copy;
97     int refcounted, ret;
98
99     if (!frame) {
100         s->eof = 1;
101         return 0;
102     } else if (s->eof)
103         return AVERROR(EINVAL);
104
105     refcounted = !!frame->buf[0];
106
107     switch (ctx->outputs[0]->type) {
108     case AVMEDIA_TYPE_VIDEO:
109         CHECK_VIDEO_PARAM_CHANGE(ctx, s, frame->width, frame->height,
110                                  frame->format);
111         break;
112     case AVMEDIA_TYPE_AUDIO:
113         CHECK_AUDIO_PARAM_CHANGE(ctx, s, frame->sample_rate, frame->channel_layout,
114                                  frame->format);
115         break;
116     default:
117         return AVERROR(EINVAL);
118     }
119
120     if (!av_fifo_space(s->fifo) &&
121         (ret = av_fifo_realloc2(s->fifo, av_fifo_size(s->fifo) +
122                                          sizeof(copy))) < 0)
123         return ret;
124
125     if (!(copy = av_frame_alloc()))
126         return AVERROR(ENOMEM);
127
128     if (refcounted) {
129         av_frame_move_ref(copy, frame);
130     } else {
131         ret = av_frame_ref(copy, frame);
132         if (ret < 0) {
133             av_frame_free(&copy);
134             return ret;
135         }
136     }
137
138     if ((ret = av_fifo_generic_write(s->fifo, &copy, sizeof(copy), NULL)) < 0) {
139         if (refcounted)
140             av_frame_move_ref(frame, copy);
141         av_frame_free(&copy);
142         return ret;
143     }
144
145     return 0;
146 }
147
148 #if FF_API_AVFILTERBUFFER
149 FF_DISABLE_DEPRECATION_WARNINGS
150 static void compat_free_buffer(void *opaque, uint8_t *data)
151 {
152     AVFilterBufferRef *buf = opaque;
153     avfilter_unref_buffer(buf);
154 }
155
156 static void compat_unref_buffer(void *opaque, uint8_t *data)
157 {
158     AVBufferRef *buf = opaque;
159     av_buffer_unref(&buf);
160 }
161
162 int av_buffersrc_buffer(AVFilterContext *ctx, AVFilterBufferRef *buf)
163 {
164     BufferSourceContext *s = ctx->priv;
165     AVFrame *frame = NULL;
166     AVBufferRef *dummy_buf = NULL;
167     int ret = 0, planes, i;
168
169     if (!buf) {
170         s->eof = 1;
171         return 0;
172     } else if (s->eof)
173         return AVERROR(EINVAL);
174
175     frame = av_frame_alloc();
176     if (!frame)
177         return AVERROR(ENOMEM);
178
179     dummy_buf = av_buffer_create(NULL, 0, compat_free_buffer, buf, 0);
180     if (!dummy_buf) {
181         ret = AVERROR(ENOMEM);
182         goto fail;
183     }
184
185     if ((ret = avfilter_copy_buf_props(frame, buf)) < 0)
186         goto fail;
187
188 #define WRAP_PLANE(ref_out, data, data_size)                            \
189 do {                                                                    \
190     AVBufferRef *dummy_ref = av_buffer_ref(dummy_buf);                  \
191     if (!dummy_ref) {                                                   \
192         ret = AVERROR(ENOMEM);                                          \
193         goto fail;                                                      \
194     }                                                                   \
195     ref_out = av_buffer_create(data, data_size, compat_unref_buffer,    \
196                                dummy_ref, 0);                           \
197     if (!ref_out) {                                                     \
198         av_freep(&dummy_ref);                                           \
199         av_frame_unref(frame);                                          \
200         ret = AVERROR(ENOMEM);                                          \
201         goto fail;                                                      \
202     }                                                                   \
203 } while (0)
204
205     if (ctx->outputs[0]->type  == AVMEDIA_TYPE_VIDEO) {
206         const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
207
208         planes = av_pix_fmt_count_planes(frame->format);
209         if (!desc || planes <= 0) {
210             ret = AVERROR(EINVAL);
211             goto fail;
212         }
213
214         for (i = 0; i < planes; i++) {
215             int v_shift    = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
216             int plane_size = (frame->height >> v_shift) * frame->linesize[i];
217
218             WRAP_PLANE(frame->buf[i], frame->data[i], plane_size);
219         }
220     } else {
221         int planar = av_sample_fmt_is_planar(frame->format);
222         int channels = av_get_channel_layout_nb_channels(frame->channel_layout);
223
224         planes = planar ? channels : 1;
225
226         if (planes > FF_ARRAY_ELEMS(frame->buf)) {
227             frame->nb_extended_buf = planes - FF_ARRAY_ELEMS(frame->buf);
228             frame->extended_buf = av_mallocz(sizeof(*frame->extended_buf) *
229                                              frame->nb_extended_buf);
230             if (!frame->extended_buf) {
231                 ret = AVERROR(ENOMEM);
232                 goto fail;
233             }
234         }
235
236         for (i = 0; i < FFMIN(planes, FF_ARRAY_ELEMS(frame->buf)); i++)
237             WRAP_PLANE(frame->buf[i], frame->extended_data[i], frame->linesize[0]);
238
239         for (i = 0; i < planes - FF_ARRAY_ELEMS(frame->buf); i++)
240             WRAP_PLANE(frame->extended_buf[i],
241                        frame->extended_data[i + FF_ARRAY_ELEMS(frame->buf)],
242                        frame->linesize[0]);
243     }
244
245     ret = av_buffersrc_add_frame(ctx, frame);
246
247 fail:
248     av_buffer_unref(&dummy_buf);
249     av_frame_free(&frame);
250
251     return ret;
252 }
253 FF_ENABLE_DEPRECATION_WARNINGS
254 #endif
255
256 static av_cold int init_video(AVFilterContext *ctx)
257 {
258     BufferSourceContext *c = ctx->priv;
259
260     if (!c->pix_fmt_str || !c->w || !c->h || av_q2d(c->time_base) <= 0) {
261         av_log(ctx, AV_LOG_ERROR, "Invalid parameters provided.\n");
262         return AVERROR(EINVAL);
263     }
264
265     if ((c->pix_fmt = av_get_pix_fmt(c->pix_fmt_str)) == AV_PIX_FMT_NONE) {
266         char *tail;
267         c->pix_fmt = strtol(c->pix_fmt_str, &tail, 10);
268         if (*tail || c->pix_fmt < 0 || !av_pix_fmt_desc_get(c->pix_fmt)) {
269             av_log(ctx, AV_LOG_ERROR, "Invalid pixel format string '%s'\n", c->pix_fmt_str);
270             return AVERROR(EINVAL);
271         }
272     }
273
274     if (!(c->fifo = av_fifo_alloc(sizeof(AVFrame*))))
275         return AVERROR(ENOMEM);
276
277     av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d pixfmt:%s\n", c->w, c->h, av_get_pix_fmt_name(c->pix_fmt));
278     return 0;
279 }
280
281 #define OFFSET(x) offsetof(BufferSourceContext, x)
282 #define A AV_OPT_FLAG_AUDIO_PARAM
283 #define V AV_OPT_FLAG_VIDEO_PARAM
284
285 static const AVOption video_options[] = {
286     { "width",         NULL,                     OFFSET(w),                AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
287     { "height",        NULL,                     OFFSET(h),                AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
288     { "pix_fmt",       NULL,                     OFFSET(pix_fmt_str),      AV_OPT_TYPE_STRING,                    .flags = V },
289 #if FF_API_OLD_FILTER_OPTS
290     /* those 4 are for compatibility with the old option passing system where each filter
291      * did its own parsing */
292     { "time_base_num", "deprecated, do not use", OFFSET(time_base.num),    AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
293     { "time_base_den", "deprecated, do not use", OFFSET(time_base.den),    AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
294     { "sar_num",       "deprecated, do not use", OFFSET(pixel_aspect.num), AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
295     { "sar_den",       "deprecated, do not use", OFFSET(pixel_aspect.den), AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, V },
296 #endif
297     { "sar",           "sample aspect ratio",    OFFSET(pixel_aspect),     AV_OPT_TYPE_RATIONAL, { .dbl = 1 }, 0, DBL_MAX, V },
298     { "time_base",     NULL,                     OFFSET(time_base),        AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
299     { NULL },
300 };
301
302 static const AVClass buffer_class = {
303     .class_name = "buffer source",
304     .item_name  = av_default_item_name,
305     .option     = video_options,
306     .version    = LIBAVUTIL_VERSION_INT,
307 };
308
309 static const AVOption audio_options[] = {
310     { "time_base",      NULL, OFFSET(time_base),           AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, A },
311     { "sample_rate",    NULL, OFFSET(sample_rate),         AV_OPT_TYPE_INT,      { .i64 = 0 }, 0, INT_MAX, A },
312     { "sample_fmt",     NULL, OFFSET(sample_fmt_str),      AV_OPT_TYPE_STRING,             .flags = A },
313     { "channel_layout", NULL, OFFSET(channel_layout_str),  AV_OPT_TYPE_STRING,             .flags = A },
314     { NULL },
315 };
316
317 static const AVClass abuffer_class = {
318     .class_name = "abuffer source",
319     .item_name  = av_default_item_name,
320     .option     = audio_options,
321     .version    = LIBAVUTIL_VERSION_INT,
322 };
323
324 static av_cold int init_audio(AVFilterContext *ctx)
325 {
326     BufferSourceContext *s = ctx->priv;
327     int ret = 0;
328
329     s->sample_fmt = av_get_sample_fmt(s->sample_fmt_str);
330     if (s->sample_fmt == AV_SAMPLE_FMT_NONE) {
331         av_log(ctx, AV_LOG_ERROR, "Invalid sample format %s.\n",
332                s->sample_fmt_str);
333         return AVERROR(EINVAL);
334     }
335
336     s->channel_layout = av_get_channel_layout(s->channel_layout_str);
337     if (!s->channel_layout) {
338         av_log(ctx, AV_LOG_ERROR, "Invalid channel layout %s.\n",
339                s->channel_layout_str);
340         return AVERROR(EINVAL);
341     }
342
343     if (!(s->fifo = av_fifo_alloc(sizeof(AVFrame*))))
344         return AVERROR(ENOMEM);
345
346     if (!s->time_base.num)
347         s->time_base = (AVRational){1, s->sample_rate};
348
349     av_log(ctx, AV_LOG_VERBOSE, "tb:%d/%d samplefmt:%s samplerate: %d "
350            "ch layout:%s\n", s->time_base.num, s->time_base.den, s->sample_fmt_str,
351            s->sample_rate, s->channel_layout_str);
352
353     return ret;
354 }
355
356 static av_cold void uninit(AVFilterContext *ctx)
357 {
358     BufferSourceContext *s = ctx->priv;
359     while (s->fifo && av_fifo_size(s->fifo)) {
360         AVFrame *frame;
361         av_fifo_generic_read(s->fifo, &frame, sizeof(frame), NULL);
362         av_frame_free(&frame);
363     }
364     av_fifo_free(s->fifo);
365     s->fifo = NULL;
366 }
367
368 static int query_formats(AVFilterContext *ctx)
369 {
370     BufferSourceContext *c = ctx->priv;
371     AVFilterChannelLayouts *channel_layouts = NULL;
372     AVFilterFormats *formats = NULL;
373     AVFilterFormats *samplerates = NULL;
374
375     switch (ctx->outputs[0]->type) {
376     case AVMEDIA_TYPE_VIDEO:
377         ff_add_format(&formats, c->pix_fmt);
378         ff_set_common_formats(ctx, formats);
379         break;
380     case AVMEDIA_TYPE_AUDIO:
381         ff_add_format(&formats,           c->sample_fmt);
382         ff_set_common_formats(ctx, formats);
383
384         ff_add_format(&samplerates,       c->sample_rate);
385         ff_set_common_samplerates(ctx, samplerates);
386
387         ff_add_channel_layout(&channel_layouts, c->channel_layout);
388         ff_set_common_channel_layouts(ctx, channel_layouts);
389         break;
390     default:
391         return AVERROR(EINVAL);
392     }
393
394     return 0;
395 }
396
397 static int config_props(AVFilterLink *link)
398 {
399     BufferSourceContext *c = link->src->priv;
400
401     switch (link->type) {
402     case AVMEDIA_TYPE_VIDEO:
403         link->w = c->w;
404         link->h = c->h;
405         link->sample_aspect_ratio = c->pixel_aspect;
406         break;
407     case AVMEDIA_TYPE_AUDIO:
408         link->channel_layout = c->channel_layout;
409         link->sample_rate    = c->sample_rate;
410         break;
411     default:
412         return AVERROR(EINVAL);
413     }
414
415     link->time_base = c->time_base;
416     return 0;
417 }
418
419 static int request_frame(AVFilterLink *link)
420 {
421     BufferSourceContext *c = link->src->priv;
422     AVFrame *frame;
423     int ret = 0;
424
425     if (!av_fifo_size(c->fifo)) {
426         if (c->eof)
427             return AVERROR_EOF;
428         return AVERROR(EAGAIN);
429     }
430     av_fifo_generic_read(c->fifo, &frame, sizeof(frame), NULL);
431
432     ff_filter_frame(link, frame);
433
434     return ret;
435 }
436
437 static int poll_frame(AVFilterLink *link)
438 {
439     BufferSourceContext *c = link->src->priv;
440     int size = av_fifo_size(c->fifo);
441     if (!size && c->eof)
442         return AVERROR_EOF;
443     return size/sizeof(AVFrame*);
444 }
445
446 static const AVFilterPad avfilter_vsrc_buffer_outputs[] = {
447     {
448         .name          = "default",
449         .type          = AVMEDIA_TYPE_VIDEO,
450         .request_frame = request_frame,
451         .poll_frame    = poll_frame,
452         .config_props  = config_props,
453     },
454     { NULL }
455 };
456
457 AVFilter ff_vsrc_buffer = {
458     .name      = "buffer",
459     .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
460     .priv_size = sizeof(BufferSourceContext),
461     .priv_class = &buffer_class,
462     .query_formats = query_formats,
463
464     .init      = init_video,
465     .uninit    = uninit,
466
467     .inputs    = NULL,
468     .outputs   = avfilter_vsrc_buffer_outputs,
469 };
470
471 static const AVFilterPad avfilter_asrc_abuffer_outputs[] = {
472     {
473         .name          = "default",
474         .type          = AVMEDIA_TYPE_AUDIO,
475         .request_frame = request_frame,
476         .poll_frame    = poll_frame,
477         .config_props  = config_props,
478     },
479     { NULL }
480 };
481
482 AVFilter ff_asrc_abuffer = {
483     .name          = "abuffer",
484     .description   = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
485     .priv_size     = sizeof(BufferSourceContext),
486     .priv_class    = &abuffer_class,
487     .query_formats = query_formats,
488
489     .init      = init_audio,
490     .uninit    = uninit,
491
492     .inputs    = NULL,
493     .outputs   = avfilter_asrc_abuffer_outputs,
494 };