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))
65 #define FIFO_INIT_SIZE 8
66 #define FIFO_INIT_ELEMENT_SIZE sizeof(void *)
68 static av_cold void uninit(AVFilterContext *ctx)
70 BufferSinkContext *sink = ctx->priv;
74 av_audio_fifo_free(sink->audio_fifo);
77 while (av_fifo_size(sink->fifo) >= FIFO_INIT_ELEMENT_SIZE) {
78 av_fifo_generic_read(sink->fifo, &frame, sizeof(frame), NULL);
79 av_frame_free(&frame);
81 av_fifo_freep(&sink->fifo);
85 static int add_buffer_ref(AVFilterContext *ctx, AVFrame *ref)
87 BufferSinkContext *buf = ctx->priv;
89 if (av_fifo_space(buf->fifo) < FIFO_INIT_ELEMENT_SIZE) {
90 /* realloc fifo size */
91 if (av_fifo_realloc2(buf->fifo, av_fifo_size(buf->fifo) * 2) < 0) {
92 av_log(ctx, AV_LOG_ERROR,
93 "Cannot buffer more frames. Consume some available frames "
94 "before adding new ones.\n");
95 return AVERROR(ENOMEM);
100 av_fifo_generic_write(buf->fifo, &ref, FIFO_INIT_ELEMENT_SIZE, NULL);
104 static int filter_frame(AVFilterLink *link, AVFrame *frame)
106 AVFilterContext *ctx = link->dst;
107 BufferSinkContext *buf = link->dst->priv;
110 if ((ret = add_buffer_ref(ctx, frame)) < 0)
112 if (buf->warning_limit &&
113 av_fifo_size(buf->fifo) / FIFO_INIT_ELEMENT_SIZE >= buf->warning_limit) {
114 av_log(ctx, AV_LOG_WARNING,
115 "%d buffers queued in %s, something may be wrong.\n",
117 (char *)av_x_if_null(ctx->name, ctx->filter->name));
118 buf->warning_limit *= 10;
123 int attribute_align_arg av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame)
125 return av_buffersink_get_frame_flags(ctx, frame, 0);
128 int attribute_align_arg av_buffersink_get_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
130 BufferSinkContext *buf = ctx->priv;
131 AVFilterLink *inlink = ctx->inputs[0];
135 /* no picref available, fetch it from the filterchain */
136 while (!av_fifo_size(buf->fifo)) {
138 return inlink->status;
139 if (flags & AV_BUFFERSINK_FLAG_NO_REQUEST)
140 return AVERROR(EAGAIN);
141 if ((ret = ff_request_frame(inlink)) < 0)
143 while (inlink->frame_wanted_out) {
144 ret = ff_filter_graph_run_once(ctx->graph);
150 if (flags & AV_BUFFERSINK_FLAG_PEEK) {
151 cur_frame = *((AVFrame **)av_fifo_peek2(buf->fifo, 0));
152 if ((ret = av_frame_ref(frame, cur_frame)) < 0)
155 av_fifo_generic_read(buf->fifo, &cur_frame, sizeof(cur_frame), NULL);
156 av_frame_move_ref(frame, cur_frame);
157 av_frame_free(&cur_frame);
163 static int read_from_fifo(AVFilterContext *ctx, AVFrame *frame,
166 BufferSinkContext *s = ctx->priv;
167 AVFilterLink *link = ctx->inputs[0];
170 if (!(tmp = ff_get_audio_buffer(link, nb_samples)))
171 return AVERROR(ENOMEM);
172 av_audio_fifo_read(s->audio_fifo, (void**)tmp->extended_data, nb_samples);
174 tmp->pts = s->next_pts;
175 if (s->next_pts != AV_NOPTS_VALUE)
176 s->next_pts += av_rescale_q(nb_samples, (AVRational){1, link->sample_rate},
179 av_frame_move_ref(frame, tmp);
185 int attribute_align_arg av_buffersink_get_samples(AVFilterContext *ctx,
186 AVFrame *frame, int nb_samples)
188 BufferSinkContext *s = ctx->priv;
189 AVFilterLink *link = ctx->inputs[0];
193 if (!s->audio_fifo) {
194 int nb_channels = link->channels;
195 if (!(s->audio_fifo = av_audio_fifo_alloc(link->format, nb_channels, nb_samples)))
196 return AVERROR(ENOMEM);
200 if (av_audio_fifo_size(s->audio_fifo) >= nb_samples)
201 return read_from_fifo(ctx, frame, nb_samples);
203 if (!(cur_frame = av_frame_alloc()))
204 return AVERROR(ENOMEM);
205 ret = av_buffersink_get_frame_flags(ctx, cur_frame, 0);
206 if (ret == AVERROR_EOF && av_audio_fifo_size(s->audio_fifo)) {
207 av_frame_free(&cur_frame);
208 return read_from_fifo(ctx, frame, av_audio_fifo_size(s->audio_fifo));
209 } else if (ret < 0) {
210 av_frame_free(&cur_frame);
214 if (cur_frame->pts != AV_NOPTS_VALUE) {
215 s->next_pts = cur_frame->pts -
216 av_rescale_q(av_audio_fifo_size(s->audio_fifo),
217 (AVRational){ 1, link->sample_rate },
221 ret = av_audio_fifo_write(s->audio_fifo, (void**)cur_frame->extended_data,
222 cur_frame->nb_samples);
223 av_frame_free(&cur_frame);
229 AVBufferSinkParams *av_buffersink_params_alloc(void)
231 static const int pixel_fmts[] = { AV_PIX_FMT_NONE };
232 AVBufferSinkParams *params = av_malloc(sizeof(AVBufferSinkParams));
236 params->pixel_fmts = pixel_fmts;
240 AVABufferSinkParams *av_abuffersink_params_alloc(void)
242 AVABufferSinkParams *params = av_mallocz(sizeof(AVABufferSinkParams));
249 static av_cold int common_init(AVFilterContext *ctx)
251 BufferSinkContext *buf = ctx->priv;
253 buf->fifo = av_fifo_alloc_array(FIFO_INIT_SIZE, FIFO_INIT_ELEMENT_SIZE);
255 av_log(ctx, AV_LOG_ERROR, "Failed to allocate fifo\n");
256 return AVERROR(ENOMEM);
258 buf->warning_limit = 100;
259 buf->next_pts = AV_NOPTS_VALUE;
263 void av_buffersink_set_frame_size(AVFilterContext *ctx, unsigned frame_size)
265 AVFilterLink *inlink = ctx->inputs[0];
267 inlink->min_samples = inlink->max_samples =
268 inlink->partial_buf_size = frame_size;
271 AVRational av_buffersink_get_frame_rate(AVFilterContext *ctx)
273 av_assert0( !strcmp(ctx->filter->name, "buffersink")
274 || !strcmp(ctx->filter->name, "ffbuffersink"));
276 return ctx->inputs[0]->frame_rate;
279 static av_cold int vsink_init(AVFilterContext *ctx, void *opaque)
281 BufferSinkContext *buf = ctx->priv;
282 AVBufferSinkParams *params = opaque;
286 if ((ret = av_opt_set_int_list(buf, "pix_fmts", params->pixel_fmts, AV_PIX_FMT_NONE, 0)) < 0)
290 return common_init(ctx);
293 #define CHECK_LIST_SIZE(field) \
294 if (buf->field ## _size % sizeof(*buf->field)) { \
295 av_log(ctx, AV_LOG_ERROR, "Invalid size for " #field ": %d, " \
296 "should be multiple of %d\n", \
297 buf->field ## _size, (int)sizeof(*buf->field)); \
298 return AVERROR(EINVAL); \
300 static int vsink_query_formats(AVFilterContext *ctx)
302 BufferSinkContext *buf = ctx->priv;
303 AVFilterFormats *formats = NULL;
307 CHECK_LIST_SIZE(pixel_fmts)
308 if (buf->pixel_fmts_size) {
309 for (i = 0; i < NB_ITEMS(buf->pixel_fmts); i++)
310 if ((ret = ff_add_format(&formats, buf->pixel_fmts[i])) < 0)
312 if ((ret = ff_set_common_formats(ctx, formats)) < 0)
315 if ((ret = ff_default_query_formats(ctx)) < 0)
322 static av_cold int asink_init(AVFilterContext *ctx, void *opaque)
324 BufferSinkContext *buf = ctx->priv;
325 AVABufferSinkParams *params = opaque;
329 if ((ret = av_opt_set_int_list(buf, "sample_fmts", params->sample_fmts, AV_SAMPLE_FMT_NONE, 0)) < 0 ||
330 (ret = av_opt_set_int_list(buf, "sample_rates", params->sample_rates, -1, 0)) < 0 ||
331 (ret = av_opt_set_int_list(buf, "channel_layouts", params->channel_layouts, -1, 0)) < 0 ||
332 (ret = av_opt_set_int_list(buf, "channel_counts", params->channel_counts, -1, 0)) < 0 ||
333 (ret = av_opt_set_int(buf, "all_channel_counts", params->all_channel_counts, 0)) < 0)
336 return common_init(ctx);
339 static int asink_query_formats(AVFilterContext *ctx)
341 BufferSinkContext *buf = ctx->priv;
342 AVFilterFormats *formats = NULL;
343 AVFilterChannelLayouts *layouts = NULL;
347 CHECK_LIST_SIZE(sample_fmts)
348 CHECK_LIST_SIZE(sample_rates)
349 CHECK_LIST_SIZE(channel_layouts)
350 CHECK_LIST_SIZE(channel_counts)
352 if (buf->sample_fmts_size) {
353 for (i = 0; i < NB_ITEMS(buf->sample_fmts); i++)
354 if ((ret = ff_add_format(&formats, buf->sample_fmts[i])) < 0)
356 if ((ret = ff_set_common_formats(ctx, formats)) < 0)
360 if (buf->channel_layouts_size || buf->channel_counts_size ||
361 buf->all_channel_counts) {
362 for (i = 0; i < NB_ITEMS(buf->channel_layouts); i++)
363 if ((ret = ff_add_channel_layout(&layouts, buf->channel_layouts[i])) < 0)
365 for (i = 0; i < NB_ITEMS(buf->channel_counts); i++)
366 if ((ret = ff_add_channel_layout(&layouts, FF_COUNT2LAYOUT(buf->channel_counts[i]))) < 0)
368 if (buf->all_channel_counts) {
370 av_log(ctx, AV_LOG_WARNING,
371 "Conflicting all_channel_counts and list in options\n");
372 else if (!(layouts = ff_all_channel_counts()))
373 return AVERROR(ENOMEM);
375 if ((ret = ff_set_common_channel_layouts(ctx, layouts)) < 0)
379 if (buf->sample_rates_size) {
381 for (i = 0; i < NB_ITEMS(buf->sample_rates); i++)
382 if ((ret = ff_add_format(&formats, buf->sample_rates[i])) < 0)
384 if ((ret = ff_set_common_samplerates(ctx, formats)) < 0)
391 #define OFFSET(x) offsetof(BufferSinkContext, x)
392 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
393 static const AVOption buffersink_options[] = {
394 { "pix_fmts", "set the supported pixel formats", OFFSET(pixel_fmts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
398 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
399 static const AVOption abuffersink_options[] = {
400 { "sample_fmts", "set the supported sample formats", OFFSET(sample_fmts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
401 { "sample_rates", "set the supported sample rates", OFFSET(sample_rates), AV_OPT_TYPE_BINARY, .flags = FLAGS },
402 { "channel_layouts", "set the supported channel layouts", OFFSET(channel_layouts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
403 { "channel_counts", "set the supported channel counts", OFFSET(channel_counts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
404 { "all_channel_counts", "accept all channel counts", OFFSET(all_channel_counts), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, FLAGS },
409 AVFILTER_DEFINE_CLASS(buffersink);
410 AVFILTER_DEFINE_CLASS(abuffersink);
412 static const AVFilterPad avfilter_vsink_buffer_inputs[] = {
415 .type = AVMEDIA_TYPE_VIDEO,
416 .filter_frame = filter_frame,
421 AVFilter ff_vsink_buffer = {
422 .name = "buffersink",
423 .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them available to the end of the filter graph."),
424 .priv_size = sizeof(BufferSinkContext),
425 .priv_class = &buffersink_class,
426 .init_opaque = vsink_init,
429 .query_formats = vsink_query_formats,
430 .inputs = avfilter_vsink_buffer_inputs,
434 static const AVFilterPad avfilter_asink_abuffer_inputs[] = {
437 .type = AVMEDIA_TYPE_AUDIO,
438 .filter_frame = filter_frame,
443 AVFilter ff_asink_abuffer = {
444 .name = "abuffersink",
445 .description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them available to the end of the filter graph."),
446 .priv_class = &abuffersink_class,
447 .priv_size = sizeof(BufferSinkContext),
448 .init_opaque = asink_init,
451 .query_formats = asink_query_formats,
452 .inputs = avfilter_asink_abuffer_inputs,