buffersrc: warn when there are too many buffers.
[ffmpeg.git] / libavfilter / buffersrc.c
1 /*
2  * Copyright (c) 2008 Vitor Sessak
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 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 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  * memory buffer source filter
24  */
25
26 #include "audio.h"
27 #include "avfilter.h"
28 #include "buffersrc.h"
29 #include "formats.h"
30 #include "internal.h"
31 #include "video.h"
32 #include "avcodec.h"
33
34 #include "libavutil/audioconvert.h"
35 #include "libavutil/fifo.h"
36 #include "libavutil/imgutils.h"
37 #include "libavutil/opt.h"
38 #include "libavutil/samplefmt.h"
39
40 typedef struct {
41     const AVClass    *class;
42     AVFifoBuffer     *fifo;
43     AVRational        time_base;     ///< time_base to set in the output link
44     AVRational        frame_rate;    ///< frame_rate to set in the output link
45     unsigned          nb_failed_requests;
46     unsigned          warning_limit;
47
48     /* video only */
49     int               w, h;
50     enum PixelFormat  pix_fmt;
51     AVRational        pixel_aspect;
52     char              *sws_param;
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 static AVFilterBufferRef *copy_buffer_ref(AVFilterContext *ctx,
78                                           AVFilterBufferRef *ref)
79 {
80     AVFilterLink *outlink = ctx->outputs[0];
81     AVFilterBufferRef *buf;
82     int channels;
83
84     switch (outlink->type) {
85
86     case AVMEDIA_TYPE_VIDEO:
87         buf = ff_get_video_buffer(outlink, AV_PERM_WRITE,
88                                         ref->video->w, ref->video->h);
89         if(!buf)
90             return NULL;
91         av_image_copy(buf->data, buf->linesize,
92                       (void*)ref->data, ref->linesize,
93                       ref->format, ref->video->w, ref->video->h);
94         break;
95
96     case AVMEDIA_TYPE_AUDIO:
97         buf = ff_get_audio_buffer(outlink, AV_PERM_WRITE,
98                                         ref->audio->nb_samples);
99         if(!buf)
100             return NULL;
101         channels = av_get_channel_layout_nb_channels(ref->audio->channel_layout);
102         av_samples_copy(buf->extended_data, ref->buf->extended_data,
103                         0, 0, ref->audio->nb_samples,
104                         channels,
105                         ref->format);
106         break;
107
108     default:
109         return NULL;
110     }
111     avfilter_copy_buffer_ref_props(buf, ref);
112     return buf;
113 }
114
115 int av_buffersrc_add_frame(AVFilterContext *buffer_src,
116                            const AVFrame *frame, int flags)
117 {
118     AVFilterBufferRef *picref;
119     int ret;
120
121     if (!frame) /* NULL for EOF */
122         return av_buffersrc_add_ref(buffer_src, NULL, flags);
123
124     switch (buffer_src->outputs[0]->type) {
125     case AVMEDIA_TYPE_VIDEO:
126         picref = avfilter_get_video_buffer_ref_from_frame(frame, AV_PERM_WRITE);
127         break;
128     case AVMEDIA_TYPE_AUDIO:
129         picref = avfilter_get_audio_buffer_ref_from_frame(frame, AV_PERM_WRITE);
130         break;
131     default:
132         return AVERROR(ENOSYS);
133     }
134     if (!picref)
135         return AVERROR(ENOMEM);
136     ret = av_buffersrc_add_ref(buffer_src, picref, flags);
137     picref->buf->data[0] = NULL;
138     avfilter_unref_buffer(picref);
139     return ret;
140 }
141
142 int av_buffersrc_write_frame(AVFilterContext *buffer_filter, AVFrame *frame)
143 {
144     return av_buffersrc_add_frame(buffer_filter, frame, 0);
145 }
146
147 int av_buffersrc_add_ref(AVFilterContext *s, AVFilterBufferRef *buf, int flags)
148 {
149     BufferSourceContext *c = s->priv;
150     AVFilterBufferRef *to_free = NULL;
151     int ret;
152
153     if (!buf) {
154         c->eof = 1;
155         return 0;
156     } else if (c->eof)
157         return AVERROR(EINVAL);
158
159     if (!av_fifo_space(c->fifo) &&
160         (ret = av_fifo_realloc2(c->fifo, av_fifo_size(c->fifo) +
161                                          sizeof(buf))) < 0)
162         return ret;
163
164     if (!(flags & AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT)) {
165         switch (s->outputs[0]->type) {
166         case AVMEDIA_TYPE_VIDEO:
167             CHECK_VIDEO_PARAM_CHANGE(s, c, buf->video->w, buf->video->h, buf->format);
168             break;
169         case AVMEDIA_TYPE_AUDIO:
170             CHECK_AUDIO_PARAM_CHANGE(s, c, buf->audio->sample_rate, buf->audio->channel_layout,
171                                      buf->format);
172             break;
173         default:
174             return AVERROR(EINVAL);
175         }
176     }
177     if (!(flags & AV_BUFFERSRC_FLAG_NO_COPY))
178         to_free = buf = copy_buffer_ref(s, buf);
179     if(!buf)
180         return -1;
181
182     if ((ret = av_fifo_generic_write(c->fifo, &buf, sizeof(buf), NULL)) < 0) {
183         avfilter_unref_buffer(to_free);
184         return ret;
185     }
186     c->nb_failed_requests = 0;
187     if (c->warning_limit &&
188         av_fifo_size(c->fifo) / sizeof(buf) >= c->warning_limit) {
189         av_log(s, AV_LOG_WARNING,
190                "%d buffers queued in %s, something may be wrong.\n",
191                c->warning_limit,
192                (char *)av_x_if_null(s->name, s->filter->name));
193         c->warning_limit *= 10;
194     }
195
196     return 0;
197 }
198
199 int av_buffersrc_buffer(AVFilterContext *s, AVFilterBufferRef *buf)
200 {
201     return av_buffersrc_add_ref(s, buf, AV_BUFFERSRC_FLAG_NO_COPY);
202 }
203
204 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src)
205 {
206     return ((BufferSourceContext *)buffer_src->priv)->nb_failed_requests;
207 }
208
209 #define OFFSET(x) offsetof(BufferSourceContext, x)
210 #define V AV_OPT_FLAG_VIDEO_PARAM
211 static const AVOption buffer_options[] = {
212     { "time_base",      NULL, OFFSET(time_base),           AV_OPT_TYPE_RATIONAL,   { 0 }, 0, INT_MAX, V },
213     { "frame_rate",     NULL, OFFSET(frame_rate),          AV_OPT_TYPE_RATIONAL,   { 0 }, 0, INT_MAX, V },
214     { "video_size",     NULL, OFFSET(w),                   AV_OPT_TYPE_IMAGE_SIZE,           .flags = V },
215     { "pix_fmt",        NULL, OFFSET(pix_fmt),             AV_OPT_TYPE_PIXEL_FMT,            .flags = V },
216     { "pixel_aspect",   NULL, OFFSET(pixel_aspect),        AV_OPT_TYPE_RATIONAL,   { 0 }, 0, INT_MAX, V },
217     { "sws_param",      NULL, OFFSET(sws_param),           AV_OPT_TYPE_STRING,               .flags = V },
218     { NULL },
219 };
220 #undef V
221
222 AVFILTER_DEFINE_CLASS(buffer);
223
224 static av_cold int init_video(AVFilterContext *ctx, const char *args)
225 {
226     BufferSourceContext *c = ctx->priv;
227     char pix_fmt_str[128], sws_param[256] = "", *colon, *equal;
228     int ret, n = 0;
229
230     c->class = &buffer_class;
231
232     if (!args) {
233         av_log(ctx, AV_LOG_ERROR, "Arguments required\n");
234         return AVERROR(EINVAL);
235     }
236     colon = strchr(args, ':');
237     equal = strchr(args, '=');
238     if (equal && (!colon || equal < colon)) {
239         av_opt_set_defaults(c);
240         ret = av_set_options_string(c, args, "=", ":");
241         if (ret < 0) {
242             av_log(ctx, AV_LOG_ERROR, "Error parsing options string: %s\n", args);
243             goto fail;
244         }
245     } else {
246     if ((n = sscanf(args, "%d:%d:%127[^:]:%d:%d:%d:%d:%255c", &c->w, &c->h, pix_fmt_str,
247                     &c->time_base.num, &c->time_base.den,
248                     &c->pixel_aspect.num, &c->pixel_aspect.den, sws_param)) < 7) {
249         av_log(ctx, AV_LOG_ERROR, "Expected at least 7 arguments, but only %d found in '%s'\n", n, args);
250         ret = AVERROR(EINVAL);
251         goto fail;
252     }
253     av_log(ctx, AV_LOG_WARNING, "Flat options syntax is deprecated, use key=value pairs\n");
254
255     if ((ret = ff_parse_pixel_format(&c->pix_fmt, pix_fmt_str, ctx)) < 0)
256         goto fail;
257     c->sws_param = av_strdup(sws_param);
258     if (!c->sws_param) {
259         ret = AVERROR(ENOMEM);
260         goto fail;
261     }
262     }
263
264     if (!(c->fifo = av_fifo_alloc(sizeof(AVFilterBufferRef*)))) {
265         ret = AVERROR(ENOMEM);
266         goto fail;
267     }
268
269     av_log(ctx, AV_LOG_INFO, "w:%d h:%d pixfmt:%s tb:%d/%d fr:%d/%d sar:%d/%d sws_param:%s\n",
270            c->w, c->h, av_pix_fmt_descriptors[c->pix_fmt].name,
271            c->time_base.num, c->time_base.den, c->frame_rate.num, c->frame_rate.den,
272            c->pixel_aspect.num, c->pixel_aspect.den, (char *)av_x_if_null(c->sws_param, ""));
273     c->warning_limit = 100;
274     return 0;
275
276 fail:
277     av_opt_free(c);
278     return ret;
279 }
280
281 #define A AV_OPT_FLAG_AUDIO_PARAM
282 static const AVOption abuffer_options[] = {
283     { "time_base",      NULL, OFFSET(time_base),           AV_OPT_TYPE_RATIONAL, { 0 }, 0, INT_MAX, A },
284     { "sample_rate",    NULL, OFFSET(sample_rate),         AV_OPT_TYPE_INT,      { 0 }, 0, INT_MAX, A },
285     { "sample_fmt",     NULL, OFFSET(sample_fmt_str),      AV_OPT_TYPE_STRING,             .flags = A },
286     { "channel_layout", NULL, OFFSET(channel_layout_str),  AV_OPT_TYPE_STRING,             .flags = A },
287     { NULL },
288 };
289
290 AVFILTER_DEFINE_CLASS(abuffer);
291
292 static av_cold int init_audio(AVFilterContext *ctx, const char *args)
293 {
294     BufferSourceContext *s = ctx->priv;
295     int ret = 0;
296
297     s->class = &abuffer_class;
298     av_opt_set_defaults(s);
299
300     if ((ret = av_set_options_string(s, args, "=", ":")) < 0) {
301         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
302         goto fail;
303     }
304
305     s->sample_fmt = av_get_sample_fmt(s->sample_fmt_str);
306     if (s->sample_fmt == AV_SAMPLE_FMT_NONE) {
307         av_log(ctx, AV_LOG_ERROR, "Invalid sample format '%s'\n",
308                s->sample_fmt_str);
309         ret = AVERROR(EINVAL);
310         goto fail;
311     }
312
313     s->channel_layout = av_get_channel_layout(s->channel_layout_str);
314     if (!s->channel_layout) {
315         av_log(ctx, AV_LOG_ERROR, "Invalid channel layout '%s'\n",
316                s->channel_layout_str);
317         ret = AVERROR(EINVAL);
318         goto fail;
319     }
320
321     if (!(s->fifo = av_fifo_alloc(sizeof(AVFilterBufferRef*)))) {
322         ret = AVERROR(ENOMEM);
323         goto fail;
324     }
325
326     if (!s->time_base.num)
327         s->time_base = (AVRational){1, s->sample_rate};
328
329     av_log(ctx, AV_LOG_INFO,
330            "tb:%d/%d samplefmt:%s samplerate:%d chlayout:%s\n",
331            s->time_base.num, s->time_base.den, s->sample_fmt_str,
332            s->sample_rate, s->channel_layout_str);
333     s->warning_limit = 100;
334
335 fail:
336     av_opt_free(s);
337     return ret;
338 }
339
340 static av_cold void uninit(AVFilterContext *ctx)
341 {
342     BufferSourceContext *s = ctx->priv;
343     while (s->fifo && av_fifo_size(s->fifo)) {
344         AVFilterBufferRef *buf;
345         av_fifo_generic_read(s->fifo, &buf, sizeof(buf), NULL);
346         avfilter_unref_buffer(buf);
347     }
348     av_fifo_free(s->fifo);
349     s->fifo = NULL;
350     av_freep(&s->sws_param);
351 }
352
353 static int query_formats(AVFilterContext *ctx)
354 {
355     BufferSourceContext *c = ctx->priv;
356     AVFilterChannelLayouts *channel_layouts = NULL;
357     AVFilterFormats *formats = NULL;
358     AVFilterFormats *samplerates = NULL;
359
360     switch (ctx->outputs[0]->type) {
361     case AVMEDIA_TYPE_VIDEO:
362         ff_add_format(&formats, c->pix_fmt);
363         ff_set_common_formats(ctx, formats);
364         break;
365     case AVMEDIA_TYPE_AUDIO:
366         ff_add_format(&formats,           c->sample_fmt);
367         ff_set_common_formats(ctx, formats);
368
369         ff_add_format(&samplerates,       c->sample_rate);
370         ff_set_common_samplerates(ctx, samplerates);
371
372         ff_add_channel_layout(&channel_layouts, c->channel_layout);
373         ff_set_common_channel_layouts(ctx, channel_layouts);
374         break;
375     default:
376         return AVERROR(EINVAL);
377     }
378
379     return 0;
380 }
381
382 static int config_props(AVFilterLink *link)
383 {
384     BufferSourceContext *c = link->src->priv;
385
386     switch (link->type) {
387     case AVMEDIA_TYPE_VIDEO:
388         link->w = c->w;
389         link->h = c->h;
390         link->sample_aspect_ratio = c->pixel_aspect;
391         break;
392     case AVMEDIA_TYPE_AUDIO:
393         link->channel_layout = c->channel_layout;
394         link->sample_rate    = c->sample_rate;
395         break;
396     default:
397         return AVERROR(EINVAL);
398     }
399
400     link->time_base = c->time_base;
401     link->frame_rate = c->frame_rate;
402     return 0;
403 }
404
405 static int request_frame(AVFilterLink *link)
406 {
407     BufferSourceContext *c = link->src->priv;
408     AVFilterBufferRef *buf;
409
410     if (!av_fifo_size(c->fifo)) {
411         if (c->eof)
412             return AVERROR_EOF;
413         c->nb_failed_requests++;
414         return AVERROR(EAGAIN);
415     }
416     av_fifo_generic_read(c->fifo, &buf, sizeof(buf), NULL);
417
418     switch (link->type) {
419     case AVMEDIA_TYPE_VIDEO:
420         ff_start_frame(link, avfilter_ref_buffer(buf, ~0));
421         ff_draw_slice(link, 0, link->h, 1);
422         ff_end_frame(link);
423         break;
424     case AVMEDIA_TYPE_AUDIO:
425         ff_filter_samples(link, avfilter_ref_buffer(buf, ~0));
426         break;
427     default:
428         return AVERROR(EINVAL);
429     }
430
431     avfilter_unref_buffer(buf);
432
433     return 0;
434 }
435
436 static int poll_frame(AVFilterLink *link)
437 {
438     BufferSourceContext *c = link->src->priv;
439     int size = av_fifo_size(c->fifo);
440     if (!size && c->eof)
441         return AVERROR_EOF;
442     return size/sizeof(AVFilterBufferRef*);
443 }
444
445 AVFilter avfilter_vsrc_buffer = {
446     .name      = "buffer",
447     .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
448     .priv_size = sizeof(BufferSourceContext),
449     .query_formats = query_formats,
450
451     .init      = init_video,
452     .uninit    = uninit,
453
454     .inputs    = (AVFilterPad[]) {{ .name = NULL }},
455     .outputs   = (AVFilterPad[]) {{ .name            = "default",
456                                     .type            = AVMEDIA_TYPE_VIDEO,
457                                     .request_frame   = request_frame,
458                                     .poll_frame      = poll_frame,
459                                     .config_props    = config_props, },
460                                   { .name = NULL}},
461 };
462
463 AVFilter avfilter_asrc_abuffer = {
464     .name          = "abuffer",
465     .description   = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
466     .priv_size     = sizeof(BufferSourceContext),
467     .query_formats = query_formats,
468
469     .init      = init_audio,
470     .uninit    = uninit,
471
472     .inputs    = (AVFilterPad[]) {{ .name = NULL }},
473     .outputs   = (AVFilterPad[]) {{ .name            = "default",
474                                     .type            = AVMEDIA_TYPE_AUDIO,
475                                     .request_frame   = request_frame,
476                                     .poll_frame      = poll_frame,
477                                     .config_props    = config_props, },
478                                   { .name = NULL}},
479 };