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