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