2 * Copyright (c) 2011 Stefano Sabatini
4 * This file is part of FFmpeg.
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.
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.
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
26 #include "libavutil/audio_fifo.h"
27 #include "libavutil/avassert.h"
28 #include "libavutil/channel_layout.h"
29 #include "libavutil/common.h"
30 #include "libavutil/internal.h"
31 #include "libavutil/mathematics.h"
32 #include "libavutil/opt.h"
36 #include "buffersink.h"
39 typedef struct BufferSinkContext {
41 AVFifoBuffer *fifo; ///< FIFO buffer of video frame references
42 unsigned warning_limit;
44 /* only used for video */
45 enum AVPixelFormat *pixel_fmts; ///< list of accepted pixel formats, must be terminated with -1
48 /* only used for audio */
49 enum AVSampleFormat *sample_fmts; ///< list of accepted sample formats, terminated by AV_SAMPLE_FMT_NONE
51 int64_t *channel_layouts; ///< list of accepted channel layouts, terminated by -1
52 int channel_layouts_size;
53 int *channel_counts; ///< list of accepted channel counts, terminated by -1
54 int channel_counts_size;
55 int all_channel_counts;
56 int *sample_rates; ///< list of accepted sample rates, terminated by -1
57 int sample_rates_size;
59 /* only used for compat API */
60 AVAudioFifo *audio_fifo; ///< FIFO for audio samples
61 int64_t next_pts; ///< interpolating audio pts
64 #define NB_ITEMS(list) (list ## _size / sizeof(*list))
66 static av_cold void uninit(AVFilterContext *ctx)
68 BufferSinkContext *sink = ctx->priv;
72 av_audio_fifo_free(sink->audio_fifo);
75 while (av_fifo_size(sink->fifo) >= sizeof(AVFilterBufferRef *)) {
76 av_fifo_generic_read(sink->fifo, &frame, sizeof(frame), NULL);
77 av_frame_free(&frame);
79 av_fifo_freep(&sink->fifo);
83 static int add_buffer_ref(AVFilterContext *ctx, AVFrame *ref)
85 BufferSinkContext *buf = ctx->priv;
87 if (av_fifo_space(buf->fifo) < sizeof(AVFilterBufferRef *)) {
88 /* realloc fifo size */
89 if (av_fifo_realloc2(buf->fifo, av_fifo_size(buf->fifo) * 2) < 0) {
90 av_log(ctx, AV_LOG_ERROR,
91 "Cannot buffer more frames. Consume some available frames "
92 "before adding new ones.\n");
93 return AVERROR(ENOMEM);
98 av_fifo_generic_write(buf->fifo, &ref, sizeof(AVFilterBufferRef *), NULL);
102 static int filter_frame(AVFilterLink *link, AVFrame *frame)
104 AVFilterContext *ctx = link->dst;
105 BufferSinkContext *buf = link->dst->priv;
108 if ((ret = add_buffer_ref(ctx, frame)) < 0)
110 if (buf->warning_limit &&
111 av_fifo_size(buf->fifo) / sizeof(AVFilterBufferRef *) >= buf->warning_limit) {
112 av_log(ctx, AV_LOG_WARNING,
113 "%d buffers queued in %s, something may be wrong.\n",
115 (char *)av_x_if_null(ctx->name, ctx->filter->name));
116 buf->warning_limit *= 10;
121 int attribute_align_arg av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame)
123 return av_buffersink_get_frame_flags(ctx, frame, 0);
126 int attribute_align_arg av_buffersink_get_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
128 BufferSinkContext *buf = ctx->priv;
129 AVFilterLink *inlink = ctx->inputs[0];
133 /* no picref available, fetch it from the filterchain */
134 if (!av_fifo_size(buf->fifo)) {
137 if (flags & AV_BUFFERSINK_FLAG_NO_REQUEST)
138 return AVERROR(EAGAIN);
139 if ((ret = ff_request_frame(inlink)) < 0)
143 if (!av_fifo_size(buf->fifo))
144 return AVERROR(EINVAL);
146 if (flags & AV_BUFFERSINK_FLAG_PEEK) {
147 cur_frame = *((AVFrame **)av_fifo_peek2(buf->fifo, 0));
148 if ((ret = av_frame_ref(frame, cur_frame)) < 0)
151 av_fifo_generic_read(buf->fifo, &cur_frame, sizeof(cur_frame), NULL);
152 av_frame_move_ref(frame, cur_frame);
153 av_frame_free(&cur_frame);
159 static int read_from_fifo(AVFilterContext *ctx, AVFrame *frame,
162 BufferSinkContext *s = ctx->priv;
163 AVFilterLink *link = ctx->inputs[0];
166 if (!(tmp = ff_get_audio_buffer(link, nb_samples)))
167 return AVERROR(ENOMEM);
168 av_audio_fifo_read(s->audio_fifo, (void**)tmp->extended_data, nb_samples);
170 tmp->pts = s->next_pts;
171 if (s->next_pts != AV_NOPTS_VALUE)
172 s->next_pts += av_rescale_q(nb_samples, (AVRational){1, link->sample_rate},
175 av_frame_move_ref(frame, tmp);
181 int attribute_align_arg av_buffersink_get_samples(AVFilterContext *ctx,
182 AVFrame *frame, int nb_samples)
184 BufferSinkContext *s = ctx->priv;
185 AVFilterLink *link = ctx->inputs[0];
189 if (!s->audio_fifo) {
190 int nb_channels = link->channels;
191 if (!(s->audio_fifo = av_audio_fifo_alloc(link->format, nb_channels, nb_samples)))
192 return AVERROR(ENOMEM);
196 if (av_audio_fifo_size(s->audio_fifo) >= nb_samples)
197 return read_from_fifo(ctx, frame, nb_samples);
199 if (!(cur_frame = av_frame_alloc()))
200 return AVERROR(ENOMEM);
201 ret = av_buffersink_get_frame_flags(ctx, cur_frame, 0);
202 if (ret == AVERROR_EOF && av_audio_fifo_size(s->audio_fifo)) {
203 av_frame_free(&cur_frame);
204 return read_from_fifo(ctx, frame, av_audio_fifo_size(s->audio_fifo));
205 } else if (ret < 0) {
206 av_frame_free(&cur_frame);
210 if (cur_frame->pts != AV_NOPTS_VALUE) {
211 s->next_pts = cur_frame->pts -
212 av_rescale_q(av_audio_fifo_size(s->audio_fifo),
213 (AVRational){ 1, link->sample_rate },
217 ret = av_audio_fifo_write(s->audio_fifo, (void**)cur_frame->extended_data,
218 cur_frame->nb_samples);
219 av_frame_free(&cur_frame);
225 AVBufferSinkParams *av_buffersink_params_alloc(void)
227 static const int pixel_fmts[] = { AV_PIX_FMT_NONE };
228 AVBufferSinkParams *params = av_malloc(sizeof(AVBufferSinkParams));
232 params->pixel_fmts = pixel_fmts;
236 AVABufferSinkParams *av_abuffersink_params_alloc(void)
238 AVABufferSinkParams *params = av_mallocz(sizeof(AVABufferSinkParams));
245 #define FIFO_INIT_SIZE 8
247 static av_cold int common_init(AVFilterContext *ctx)
249 BufferSinkContext *buf = ctx->priv;
251 buf->fifo = av_fifo_alloc_array(FIFO_INIT_SIZE, sizeof(AVFilterBufferRef *));
253 av_log(ctx, AV_LOG_ERROR, "Failed to allocate fifo\n");
254 return AVERROR(ENOMEM);
256 buf->warning_limit = 100;
257 buf->next_pts = AV_NOPTS_VALUE;
261 void av_buffersink_set_frame_size(AVFilterContext *ctx, unsigned frame_size)
263 AVFilterLink *inlink = ctx->inputs[0];
265 inlink->min_samples = inlink->max_samples =
266 inlink->partial_buf_size = frame_size;
269 #if FF_API_AVFILTERBUFFER
270 FF_DISABLE_DEPRECATION_WARNINGS
271 static void compat_free_buffer(AVFilterBuffer *buf)
273 AVFrame *frame = buf->priv;
274 av_frame_free(&frame);
278 static int compat_read(AVFilterContext *ctx,
279 AVFilterBufferRef **pbuf, int nb_samples, int flags)
281 AVFilterBufferRef *buf;
286 return ff_poll_frame(ctx->inputs[0]);
288 frame = av_frame_alloc();
290 return AVERROR(ENOMEM);
293 ret = av_buffersink_get_frame_flags(ctx, frame, flags);
295 ret = av_buffersink_get_samples(ctx, frame, nb_samples);
300 AV_NOWARN_DEPRECATED(
301 if (ctx->inputs[0]->type == AVMEDIA_TYPE_VIDEO) {
302 buf = avfilter_get_video_buffer_ref_from_arrays(frame->data, frame->linesize,
304 frame->width, frame->height,
307 buf = avfilter_get_audio_buffer_ref_from_arrays(frame->extended_data,
308 frame->linesize[0], AV_PERM_READ,
311 frame->channel_layout);
314 ret = AVERROR(ENOMEM);
318 avfilter_copy_frame_props(buf, frame);
321 buf->buf->priv = frame;
322 buf->buf->free = compat_free_buffer;
328 av_frame_free(&frame);
332 int attribute_align_arg av_buffersink_read(AVFilterContext *ctx, AVFilterBufferRef **buf)
334 return compat_read(ctx, buf, 0, 0);
337 int attribute_align_arg av_buffersink_read_samples(AVFilterContext *ctx, AVFilterBufferRef **buf,
340 return compat_read(ctx, buf, nb_samples, 0);
343 int attribute_align_arg av_buffersink_get_buffer_ref(AVFilterContext *ctx,
344 AVFilterBufferRef **bufref, int flags)
348 av_assert0( !strcmp(ctx->filter->name, "buffersink")
349 || !strcmp(ctx->filter->name, "abuffersink")
350 || !strcmp(ctx->filter->name, "ffbuffersink")
351 || !strcmp(ctx->filter->name, "ffabuffersink"));
353 return compat_read(ctx, bufref, 0, flags);
355 FF_ENABLE_DEPRECATION_WARNINGS
358 AVRational av_buffersink_get_frame_rate(AVFilterContext *ctx)
360 av_assert0( !strcmp(ctx->filter->name, "buffersink")
361 || !strcmp(ctx->filter->name, "ffbuffersink"));
363 return ctx->inputs[0]->frame_rate;
366 int attribute_align_arg av_buffersink_poll_frame(AVFilterContext *ctx)
368 BufferSinkContext *buf = ctx->priv;
369 AVFilterLink *inlink = ctx->inputs[0];
371 av_assert0( !strcmp(ctx->filter->name, "buffersink")
372 || !strcmp(ctx->filter->name, "abuffersink")
373 || !strcmp(ctx->filter->name, "ffbuffersink")
374 || !strcmp(ctx->filter->name, "ffabuffersink"));
376 return av_fifo_size(buf->fifo)/sizeof(AVFilterBufferRef *) + ff_poll_frame(inlink);
379 static av_cold int vsink_init(AVFilterContext *ctx, void *opaque)
381 BufferSinkContext *buf = ctx->priv;
382 AVBufferSinkParams *params = opaque;
386 if ((ret = av_opt_set_int_list(buf, "pix_fmts", params->pixel_fmts, AV_PIX_FMT_NONE, 0)) < 0)
390 return common_init(ctx);
393 #define CHECK_LIST_SIZE(field) \
394 if (buf->field ## _size % sizeof(*buf->field)) { \
395 av_log(ctx, AV_LOG_ERROR, "Invalid size for " #field ": %d, " \
396 "should be multiple of %d\n", \
397 buf->field ## _size, (int)sizeof(*buf->field)); \
398 return AVERROR(EINVAL); \
400 static int vsink_query_formats(AVFilterContext *ctx)
402 BufferSinkContext *buf = ctx->priv;
403 AVFilterFormats *formats = NULL;
407 CHECK_LIST_SIZE(pixel_fmts)
408 if (buf->pixel_fmts_size) {
409 for (i = 0; i < NB_ITEMS(buf->pixel_fmts); i++)
410 if ((ret = ff_add_format(&formats, buf->pixel_fmts[i])) < 0) {
411 ff_formats_unref(&formats);
414 ff_set_common_formats(ctx, formats);
416 ff_default_query_formats(ctx);
422 static av_cold int asink_init(AVFilterContext *ctx, void *opaque)
424 BufferSinkContext *buf = ctx->priv;
425 AVABufferSinkParams *params = opaque;
429 if ((ret = av_opt_set_int_list(buf, "sample_fmts", params->sample_fmts, AV_SAMPLE_FMT_NONE, 0)) < 0 ||
430 (ret = av_opt_set_int_list(buf, "sample_rates", params->sample_rates, -1, 0)) < 0 ||
431 (ret = av_opt_set_int_list(buf, "channel_layouts", params->channel_layouts, -1, 0)) < 0 ||
432 (ret = av_opt_set_int_list(buf, "channel_counts", params->channel_counts, -1, 0)) < 0 ||
433 (ret = av_opt_set_int(buf, "all_channel_counts", params->all_channel_counts, 0)) < 0)
436 return common_init(ctx);
439 static int asink_query_formats(AVFilterContext *ctx)
441 BufferSinkContext *buf = ctx->priv;
442 AVFilterFormats *formats = NULL;
443 AVFilterChannelLayouts *layouts = NULL;
447 CHECK_LIST_SIZE(sample_fmts)
448 CHECK_LIST_SIZE(sample_rates)
449 CHECK_LIST_SIZE(channel_layouts)
450 CHECK_LIST_SIZE(channel_counts)
452 if (buf->sample_fmts_size) {
453 for (i = 0; i < NB_ITEMS(buf->sample_fmts); i++)
454 if ((ret = ff_add_format(&formats, buf->sample_fmts[i])) < 0) {
455 ff_formats_unref(&formats);
458 ff_set_common_formats(ctx, formats);
461 if (buf->channel_layouts_size || buf->channel_counts_size ||
462 buf->all_channel_counts) {
463 for (i = 0; i < NB_ITEMS(buf->channel_layouts); i++)
464 if ((ret = ff_add_channel_layout(&layouts, buf->channel_layouts[i])) < 0) {
465 ff_channel_layouts_unref(&layouts);
468 for (i = 0; i < NB_ITEMS(buf->channel_counts); i++)
469 if ((ret = ff_add_channel_layout(&layouts, FF_COUNT2LAYOUT(buf->channel_counts[i]))) < 0) {
470 ff_channel_layouts_unref(&layouts);
473 if (buf->all_channel_counts) {
475 av_log(ctx, AV_LOG_WARNING,
476 "Conflicting all_channel_counts and list in options\n");
477 else if (!(layouts = ff_all_channel_counts()))
478 return AVERROR(ENOMEM);
480 ff_set_common_channel_layouts(ctx, layouts);
483 if (buf->sample_rates_size) {
485 for (i = 0; i < NB_ITEMS(buf->sample_rates); i++)
486 if ((ret = ff_add_format(&formats, buf->sample_rates[i])) < 0) {
487 ff_formats_unref(&formats);
490 ff_set_common_samplerates(ctx, formats);
496 #define OFFSET(x) offsetof(BufferSinkContext, x)
497 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
498 static const AVOption buffersink_options[] = {
499 { "pix_fmts", "set the supported pixel formats", OFFSET(pixel_fmts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
503 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
504 static const AVOption abuffersink_options[] = {
505 { "sample_fmts", "set the supported sample formats", OFFSET(sample_fmts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
506 { "sample_rates", "set the supported sample rates", OFFSET(sample_rates), AV_OPT_TYPE_BINARY, .flags = FLAGS },
507 { "channel_layouts", "set the supported channel layouts", OFFSET(channel_layouts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
508 { "channel_counts", "set the supported channel counts", OFFSET(channel_counts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
509 { "all_channel_counts", "accept all channel counts", OFFSET(all_channel_counts), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, FLAGS },
514 AVFILTER_DEFINE_CLASS(buffersink);
515 AVFILTER_DEFINE_CLASS(abuffersink);
517 #if FF_API_AVFILTERBUFFER
519 #define ffbuffersink_options buffersink_options
520 #define ffabuffersink_options abuffersink_options
521 AVFILTER_DEFINE_CLASS(ffbuffersink);
522 AVFILTER_DEFINE_CLASS(ffabuffersink);
524 static const AVFilterPad ffbuffersink_inputs[] = {
527 .type = AVMEDIA_TYPE_VIDEO,
528 .filter_frame = filter_frame,
533 AVFilter ff_vsink_ffbuffersink = {
534 .name = "ffbuffersink",
535 .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them available to the end of the filter graph."),
536 .priv_size = sizeof(BufferSinkContext),
537 .priv_class = &ffbuffersink_class,
538 .init_opaque = vsink_init,
541 .query_formats = vsink_query_formats,
542 .inputs = ffbuffersink_inputs,
546 static const AVFilterPad ffabuffersink_inputs[] = {
549 .type = AVMEDIA_TYPE_AUDIO,
550 .filter_frame = filter_frame,
555 AVFilter ff_asink_ffabuffersink = {
556 .name = "ffabuffersink",
557 .description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them available to the end of the filter graph."),
558 .init_opaque = asink_init,
560 .priv_size = sizeof(BufferSinkContext),
561 .priv_class = &ffabuffersink_class,
562 .query_formats = asink_query_formats,
563 .inputs = ffabuffersink_inputs,
566 #endif /* FF_API_AVFILTERBUFFER */
568 static const AVFilterPad avfilter_vsink_buffer_inputs[] = {
571 .type = AVMEDIA_TYPE_VIDEO,
572 .filter_frame = filter_frame,
577 AVFilter ff_vsink_buffer = {
578 .name = "buffersink",
579 .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them available to the end of the filter graph."),
580 .priv_size = sizeof(BufferSinkContext),
581 .priv_class = &buffersink_class,
582 .init_opaque = vsink_init,
585 .query_formats = vsink_query_formats,
586 .inputs = avfilter_vsink_buffer_inputs,
590 static const AVFilterPad avfilter_asink_abuffer_inputs[] = {
593 .type = AVMEDIA_TYPE_AUDIO,
594 .filter_frame = filter_frame,
599 AVFilter ff_asink_abuffer = {
600 .name = "abuffersink",
601 .description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them available to the end of the filter graph."),
602 .priv_class = &abuffersink_class,
603 .priv_size = sizeof(BufferSinkContext),
604 .init_opaque = asink_init,
607 .query_formats = asink_query_formats,
608 .inputs = avfilter_asink_abuffer_inputs,