Fix misc swapped dot and carriage returns in av_log calls.
[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 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, 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     return 0;
151 }
152
153 #ifdef FF_API_BUFFERSRC_BUFFER
154 int av_buffersrc_buffer(AVFilterContext *s, AVFilterBufferRef *buf)
155 {
156     return av_buffersrc_add_ref(s, buf, AV_BUFFERSRC_FLAG_NO_COPY);
157 }
158 #endif
159
160 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src)
161 {
162     return ((BufferSourceContext *)buffer_src->priv)->nb_failed_requests;
163 }
164
165 #define OFFSET(x) offsetof(BufferSourceContext, x)
166 #define V AV_OPT_FLAG_VIDEO_PARAM
167 static const AVOption buffer_options[] = {
168     { "time_base",      NULL, OFFSET(time_base),           AV_OPT_TYPE_RATIONAL,   { 0 }, 0, INT_MAX, V },
169     { "frame_rate",     NULL, OFFSET(frame_rate),          AV_OPT_TYPE_RATIONAL,   { 0 }, 0, INT_MAX, V },
170     { "video_size",     NULL, OFFSET(w),                   AV_OPT_TYPE_IMAGE_SIZE,           .flags = V },
171     { "pix_fmt",        NULL, OFFSET(pix_fmt),             AV_OPT_TYPE_PIXEL_FMT,            .flags = V },
172     { "pixel_aspect",   NULL, OFFSET(pixel_aspect),        AV_OPT_TYPE_RATIONAL,   { 0 }, 0, INT_MAX, V },
173     { "sws_param",      NULL, OFFSET(sws_param),           AV_OPT_TYPE_STRING,               .flags = V },
174     { NULL },
175 };
176 #undef V
177
178 AVFILTER_DEFINE_CLASS(buffer);
179
180 static av_cold int init_video(AVFilterContext *ctx, const char *args)
181 {
182     BufferSourceContext *c = ctx->priv;
183     char pix_fmt_str[128], sws_param[256] = "", *colon, *equal;
184     int ret, n = 0;
185
186     c->class = &buffer_class;
187
188     if (!args) {
189         av_log(ctx, AV_LOG_ERROR, "Arguments required\n");
190         return AVERROR(EINVAL);
191     }
192     colon = strchr(args, ':');
193     equal = strchr(args, '=');
194     if (equal && (!colon || equal < colon)) {
195         av_opt_set_defaults(c);
196         ret = av_set_options_string(c, args, "=", ":");
197         if (ret < 0) {
198             av_log(ctx, AV_LOG_ERROR, "Error parsing options string: %s\n", args);
199             goto fail;
200         }
201     } else {
202     if ((n = sscanf(args, "%d:%d:%127[^:]:%d:%d:%d:%d:%255c", &c->w, &c->h, pix_fmt_str,
203                     &c->time_base.num, &c->time_base.den,
204                     &c->pixel_aspect.num, &c->pixel_aspect.den, sws_param)) < 7) {
205         av_log(ctx, AV_LOG_ERROR, "Expected at least 7 arguments, but only %d found in '%s'\n", n, args);
206         ret = AVERROR(EINVAL);
207         goto fail;
208     }
209     av_log(ctx, AV_LOG_WARNING, "Flat options syntax is deprecated, use key=value pairs\n");
210
211     if ((ret = ff_parse_pixel_format(&c->pix_fmt, pix_fmt_str, ctx)) < 0)
212         goto fail;
213     c->sws_param = av_strdup(sws_param);
214     if (!c->sws_param) {
215         ret = AVERROR(ENOMEM);
216         goto fail;
217     }
218     }
219
220     if (!(c->fifo = av_fifo_alloc(sizeof(AVFilterBufferRef*)))) {
221         ret = AVERROR(ENOMEM);
222         goto fail;
223     }
224
225     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",
226            c->w, c->h, av_pix_fmt_descriptors[c->pix_fmt].name,
227            c->time_base.num, c->time_base.den, c->frame_rate.num, c->frame_rate.den,
228            c->pixel_aspect.num, c->pixel_aspect.den, (char *)av_x_if_null(c->sws_param, ""));
229     c->warning_limit = 100;
230     return 0;
231
232 fail:
233     av_opt_free(c);
234     return ret;
235 }
236
237 #define A AV_OPT_FLAG_AUDIO_PARAM
238 static const AVOption abuffer_options[] = {
239     { "time_base",      NULL, OFFSET(time_base),           AV_OPT_TYPE_RATIONAL, { 0 }, 0, INT_MAX, A },
240     { "sample_rate",    NULL, OFFSET(sample_rate),         AV_OPT_TYPE_INT,      { 0 }, 0, INT_MAX, A },
241     { "sample_fmt",     NULL, OFFSET(sample_fmt_str),      AV_OPT_TYPE_STRING,             .flags = A },
242     { "channel_layout", NULL, OFFSET(channel_layout_str),  AV_OPT_TYPE_STRING,             .flags = A },
243     { NULL },
244 };
245
246 AVFILTER_DEFINE_CLASS(abuffer);
247
248 static av_cold int init_audio(AVFilterContext *ctx, const char *args)
249 {
250     BufferSourceContext *s = ctx->priv;
251     int ret = 0;
252
253     s->class = &abuffer_class;
254     av_opt_set_defaults(s);
255
256     if ((ret = av_set_options_string(s, args, "=", ":")) < 0) {
257         av_log(ctx, AV_LOG_ERROR, "Error parsing options string: '%s'\n", args);
258         goto fail;
259     }
260
261     s->sample_fmt = av_get_sample_fmt(s->sample_fmt_str);
262     if (s->sample_fmt == AV_SAMPLE_FMT_NONE) {
263         av_log(ctx, AV_LOG_ERROR, "Invalid sample format '%s'\n",
264                s->sample_fmt_str);
265         ret = AVERROR(EINVAL);
266         goto fail;
267     }
268
269     s->channel_layout = av_get_channel_layout(s->channel_layout_str);
270     if (!s->channel_layout) {
271         av_log(ctx, AV_LOG_ERROR, "Invalid channel layout '%s'\n",
272                s->channel_layout_str);
273         ret = AVERROR(EINVAL);
274         goto fail;
275     }
276
277     if (!(s->fifo = av_fifo_alloc(sizeof(AVFilterBufferRef*)))) {
278         ret = AVERROR(ENOMEM);
279         goto fail;
280     }
281
282     if (!s->time_base.num)
283         s->time_base = (AVRational){1, s->sample_rate};
284
285     av_log(ctx, AV_LOG_VERBOSE,
286            "tb:%d/%d samplefmt:%s samplerate:%d chlayout:%s\n",
287            s->time_base.num, s->time_base.den, s->sample_fmt_str,
288            s->sample_rate, s->channel_layout_str);
289     s->warning_limit = 100;
290
291 fail:
292     av_opt_free(s);
293     return ret;
294 }
295
296 static av_cold void uninit(AVFilterContext *ctx)
297 {
298     BufferSourceContext *s = ctx->priv;
299     while (s->fifo && av_fifo_size(s->fifo)) {
300         AVFilterBufferRef *buf;
301         av_fifo_generic_read(s->fifo, &buf, sizeof(buf), NULL);
302         avfilter_unref_buffer(buf);
303     }
304     av_fifo_free(s->fifo);
305     s->fifo = NULL;
306     av_freep(&s->sws_param);
307 }
308
309 static int query_formats(AVFilterContext *ctx)
310 {
311     BufferSourceContext *c = ctx->priv;
312     AVFilterChannelLayouts *channel_layouts = NULL;
313     AVFilterFormats *formats = NULL;
314     AVFilterFormats *samplerates = NULL;
315
316     switch (ctx->outputs[0]->type) {
317     case AVMEDIA_TYPE_VIDEO:
318         ff_add_format(&formats, c->pix_fmt);
319         ff_set_common_formats(ctx, formats);
320         break;
321     case AVMEDIA_TYPE_AUDIO:
322         ff_add_format(&formats,           c->sample_fmt);
323         ff_set_common_formats(ctx, formats);
324
325         ff_add_format(&samplerates,       c->sample_rate);
326         ff_set_common_samplerates(ctx, samplerates);
327
328         ff_add_channel_layout(&channel_layouts, c->channel_layout);
329         ff_set_common_channel_layouts(ctx, channel_layouts);
330         break;
331     default:
332         return AVERROR(EINVAL);
333     }
334
335     return 0;
336 }
337
338 static int config_props(AVFilterLink *link)
339 {
340     BufferSourceContext *c = link->src->priv;
341
342     switch (link->type) {
343     case AVMEDIA_TYPE_VIDEO:
344         link->w = c->w;
345         link->h = c->h;
346         link->sample_aspect_ratio = c->pixel_aspect;
347         break;
348     case AVMEDIA_TYPE_AUDIO:
349         link->channel_layout = c->channel_layout;
350         link->sample_rate    = c->sample_rate;
351         break;
352     default:
353         return AVERROR(EINVAL);
354     }
355
356     link->time_base = c->time_base;
357     link->frame_rate = c->frame_rate;
358     return 0;
359 }
360
361 static int request_frame(AVFilterLink *link)
362 {
363     BufferSourceContext *c = link->src->priv;
364     AVFilterBufferRef *buf;
365     int ret = 0;
366
367     if (!av_fifo_size(c->fifo)) {
368         if (c->eof)
369             return AVERROR_EOF;
370         c->nb_failed_requests++;
371         return AVERROR(EAGAIN);
372     }
373     av_fifo_generic_read(c->fifo, &buf, sizeof(buf), NULL);
374
375     switch (link->type) {
376     case AVMEDIA_TYPE_VIDEO:
377         if ((ret = ff_start_frame(link, buf)) < 0 ||
378             (ret = ff_draw_slice(link, 0, link->h, 1)) < 0 ||
379             (ret = ff_end_frame(link)) < 0)
380             return ret;
381         break;
382     case AVMEDIA_TYPE_AUDIO:
383         ret = ff_filter_samples(link, buf);
384         break;
385     default:
386         avfilter_unref_bufferp(&buf);
387         return AVERROR(EINVAL);
388     }
389
390     return ret;
391 }
392
393 static int poll_frame(AVFilterLink *link)
394 {
395     BufferSourceContext *c = link->src->priv;
396     int size = av_fifo_size(c->fifo);
397     if (!size && c->eof)
398         return AVERROR_EOF;
399     return size/sizeof(AVFilterBufferRef*);
400 }
401
402 AVFilter avfilter_vsrc_buffer = {
403     .name      = "buffer",
404     .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
405     .priv_size = sizeof(BufferSourceContext),
406     .query_formats = query_formats,
407
408     .init      = init_video,
409     .uninit    = uninit,
410
411     .inputs    = (const AVFilterPad[]) {{ .name = NULL }},
412     .outputs   = (const AVFilterPad[]) {{ .name            = "default",
413                                           .type            = AVMEDIA_TYPE_VIDEO,
414                                           .request_frame   = request_frame,
415                                           .poll_frame      = poll_frame,
416                                           .config_props    = config_props, },
417                                         { .name = NULL}},
418 };
419
420 AVFilter avfilter_asrc_abuffer = {
421     .name          = "abuffer",
422     .description   = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
423     .priv_size     = sizeof(BufferSourceContext),
424     .query_formats = query_formats,
425
426     .init      = init_audio,
427     .uninit    = uninit,
428
429     .inputs    = (const AVFilterPad[]) {{ .name = NULL }},
430     .outputs   = (const AVFilterPad[]) {{ .name            = "default",
431                                           .type            = AVMEDIA_TYPE_AUDIO,
432                                           .request_frame   = request_frame,
433                                           .poll_frame      = poll_frame,
434                                           .config_props    = config_props, },
435                                         { .name = NULL}},
436 };