2 * Copyright (c) 2008 Vitor Sessak
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
23 * memory buffer source filter
28 #include "libavutil/channel_layout.h"
29 #include "libavutil/common.h"
30 #include "libavutil/fifo.h"
31 #include "libavutil/frame.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/internal.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/samplefmt.h"
36 #include "libavutil/timestamp.h"
39 #include "buffersrc.h"
44 typedef struct BufferSourceContext {
47 AVRational time_base; ///< time_base to set in the output link
48 AVRational frame_rate; ///< frame_rate to set in the output link
49 unsigned nb_failed_requests;
53 enum AVPixelFormat pix_fmt;
54 AVRational pixel_aspect;
57 AVBufferRef *hw_frames_ctx;
61 enum AVSampleFormat sample_fmt;
63 uint64_t channel_layout;
64 char *channel_layout_str;
66 int got_format_from_params;
68 } BufferSourceContext;
70 #define CHECK_VIDEO_PARAM_CHANGE(s, c, width, height, format, pts)\
71 if (c->w != width || c->h != height || c->pix_fmt != format) {\
72 av_log(s, AV_LOG_INFO, "filter context - w: %d h: %d fmt: %d, incoming frame - w: %d h: %d fmt: %d pts_time: %s\n",\
73 c->w, c->h, c->pix_fmt, width, height, format, av_ts2timestr(pts, &s->outputs[0]->time_base));\
74 av_log(s, AV_LOG_WARNING, "Changing video frame properties on the fly is not supported by all filters.\n");\
77 #define CHECK_AUDIO_PARAM_CHANGE(s, c, srate, ch_layout, ch_count, format, pts)\
78 if (c->sample_fmt != format || c->sample_rate != srate ||\
79 c->channel_layout != ch_layout || c->channels != ch_count) {\
80 av_log(s, AV_LOG_INFO, "filter context - fmt: %s r: %d layout: %"PRIX64" ch: %d, incoming frame - fmt: %s r: %d layout: %"PRIX64" ch: %d pts_time: %s\n",\
81 av_get_sample_fmt_name(c->sample_fmt), c->sample_rate, c->channel_layout, c->channels,\
82 av_get_sample_fmt_name(format), srate, ch_layout, ch_count, av_ts2timestr(pts, &s->outputs[0]->time_base));\
83 av_log(s, AV_LOG_ERROR, "Changing audio frame properties on the fly is not supported.\n");\
84 return AVERROR(EINVAL);\
87 AVBufferSrcParameters *av_buffersrc_parameters_alloc(void)
89 AVBufferSrcParameters *par = av_mallocz(sizeof(*par));
98 int av_buffersrc_parameters_set(AVFilterContext *ctx, AVBufferSrcParameters *param)
100 BufferSourceContext *s = ctx->priv;
102 if (param->time_base.num > 0 && param->time_base.den > 0)
103 s->time_base = param->time_base;
105 switch (ctx->filter->outputs[0].type) {
106 case AVMEDIA_TYPE_VIDEO:
107 if (param->format != AV_PIX_FMT_NONE) {
108 s->got_format_from_params = 1;
109 s->pix_fmt = param->format;
111 if (param->width > 0)
113 if (param->height > 0)
114 s->h = param->height;
115 if (param->sample_aspect_ratio.num > 0 && param->sample_aspect_ratio.den > 0)
116 s->pixel_aspect = param->sample_aspect_ratio;
117 if (param->frame_rate.num > 0 && param->frame_rate.den > 0)
118 s->frame_rate = param->frame_rate;
119 if (param->hw_frames_ctx) {
120 av_buffer_unref(&s->hw_frames_ctx);
121 s->hw_frames_ctx = av_buffer_ref(param->hw_frames_ctx);
122 if (!s->hw_frames_ctx)
123 return AVERROR(ENOMEM);
126 case AVMEDIA_TYPE_AUDIO:
127 if (param->format != AV_SAMPLE_FMT_NONE) {
128 s->got_format_from_params = 1;
129 s->sample_fmt = param->format;
131 if (param->sample_rate > 0)
132 s->sample_rate = param->sample_rate;
133 if (param->channel_layout)
134 s->channel_layout = param->channel_layout;
143 int attribute_align_arg av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame)
145 return av_buffersrc_add_frame_flags(ctx, (AVFrame *)frame,
146 AV_BUFFERSRC_FLAG_KEEP_REF);
149 int attribute_align_arg av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame)
151 return av_buffersrc_add_frame_flags(ctx, frame, 0);
154 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
155 AVFrame *frame, int flags);
157 int attribute_align_arg av_buffersrc_add_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
159 AVFrame *copy = NULL;
162 if (frame && frame->channel_layout &&
163 av_get_channel_layout_nb_channels(frame->channel_layout) != frame->channels) {
164 av_log(ctx, AV_LOG_ERROR, "Layout indicates a different number of channels than actually present\n");
165 return AVERROR(EINVAL);
168 if (!(flags & AV_BUFFERSRC_FLAG_KEEP_REF) || !frame)
169 return av_buffersrc_add_frame_internal(ctx, frame, flags);
171 if (!(copy = av_frame_alloc()))
172 return AVERROR(ENOMEM);
173 ret = av_frame_ref(copy, frame);
175 ret = av_buffersrc_add_frame_internal(ctx, copy, flags);
177 av_frame_free(©);
181 static int push_frame(AVFilterGraph *graph)
186 ret = ff_filter_graph_run_once(graph);
187 if (ret == AVERROR(EAGAIN))
195 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
196 AVFrame *frame, int flags)
198 BufferSourceContext *s = ctx->priv;
202 s->nb_failed_requests = 0;
205 return av_buffersrc_close(ctx, AV_NOPTS_VALUE, flags);
207 return AVERROR(EINVAL);
209 refcounted = !!frame->buf[0];
211 if (!(flags & AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT)) {
213 switch (ctx->outputs[0]->type) {
214 case AVMEDIA_TYPE_VIDEO:
215 CHECK_VIDEO_PARAM_CHANGE(ctx, s, frame->width, frame->height,
216 frame->format, frame->pts);
218 case AVMEDIA_TYPE_AUDIO:
219 /* For layouts unknown on input but known on link after negotiation. */
220 if (!frame->channel_layout)
221 frame->channel_layout = s->channel_layout;
222 CHECK_AUDIO_PARAM_CHANGE(ctx, s, frame->sample_rate, frame->channel_layout,
223 frame->channels, frame->format, frame->pts);
226 return AVERROR(EINVAL);
231 if (!av_fifo_space(s->fifo) &&
232 (ret = av_fifo_realloc2(s->fifo, av_fifo_size(s->fifo) +
236 if (!(copy = av_frame_alloc()))
237 return AVERROR(ENOMEM);
240 av_frame_move_ref(copy, frame);
242 ret = av_frame_ref(copy, frame);
244 av_frame_free(©);
249 if ((ret = av_fifo_generic_write(s->fifo, ©, sizeof(copy), NULL)) < 0) {
251 av_frame_move_ref(frame, copy);
252 av_frame_free(©);
256 if ((ret = ctx->output_pads[0].request_frame(ctx->outputs[0])) < 0)
259 if ((flags & AV_BUFFERSRC_FLAG_PUSH)) {
260 ret = push_frame(ctx->graph);
268 int av_buffersrc_close(AVFilterContext *ctx, int64_t pts, unsigned flags)
270 BufferSourceContext *s = ctx->priv;
273 ff_avfilter_link_set_in_status(ctx->outputs[0], AVERROR_EOF, pts);
274 return (flags & AV_BUFFERSRC_FLAG_PUSH) ? push_frame(ctx->graph) : 0;
277 static av_cold int init_video(AVFilterContext *ctx)
279 BufferSourceContext *c = ctx->priv;
281 if (!(c->pix_fmt != AV_PIX_FMT_NONE || c->got_format_from_params) || !c->w || !c->h ||
282 av_q2d(c->time_base) <= 0) {
283 av_log(ctx, AV_LOG_ERROR, "Invalid parameters provided.\n");
284 return AVERROR(EINVAL);
287 if (!(c->fifo = av_fifo_alloc(sizeof(AVFrame*))))
288 return AVERROR(ENOMEM);
290 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",
291 c->w, c->h, av_get_pix_fmt_name(c->pix_fmt),
292 c->time_base.num, c->time_base.den, c->frame_rate.num, c->frame_rate.den,
293 c->pixel_aspect.num, c->pixel_aspect.den, (char *)av_x_if_null(c->sws_param, ""));
297 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src)
299 return ((BufferSourceContext *)buffer_src->priv)->nb_failed_requests;
302 #define OFFSET(x) offsetof(BufferSourceContext, x)
303 #define A AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
304 #define V AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
306 static const AVOption buffer_options[] = {
307 { "width", NULL, OFFSET(w), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
308 { "video_size", NULL, OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, .flags = V },
309 { "height", NULL, OFFSET(h), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
310 { "pix_fmt", NULL, OFFSET(pix_fmt), AV_OPT_TYPE_PIXEL_FMT, { .i64 = AV_PIX_FMT_NONE }, .min = AV_PIX_FMT_NONE, .max = INT_MAX, .flags = V },
311 { "sar", "sample aspect ratio", OFFSET(pixel_aspect), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
312 { "pixel_aspect", "sample aspect ratio", OFFSET(pixel_aspect), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
313 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
314 { "frame_rate", NULL, OFFSET(frame_rate), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
315 { "sws_param", NULL, OFFSET(sws_param), AV_OPT_TYPE_STRING, .flags = V },
319 AVFILTER_DEFINE_CLASS(buffer);
321 static const AVOption abuffer_options[] = {
322 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, A },
323 { "sample_rate", NULL, OFFSET(sample_rate), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, A },
324 { "sample_fmt", NULL, OFFSET(sample_fmt), AV_OPT_TYPE_SAMPLE_FMT, { .i64 = AV_SAMPLE_FMT_NONE }, .min = AV_SAMPLE_FMT_NONE, .max = INT_MAX, .flags = A },
325 { "channel_layout", NULL, OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, .flags = A },
326 { "channels", NULL, OFFSET(channels), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, A },
330 AVFILTER_DEFINE_CLASS(abuffer);
332 static av_cold int init_audio(AVFilterContext *ctx)
334 BufferSourceContext *s = ctx->priv;
337 if (!(s->sample_fmt != AV_SAMPLE_FMT_NONE || s->got_format_from_params)) {
338 av_log(ctx, AV_LOG_ERROR, "Sample format was not set or was invalid\n");
339 return AVERROR(EINVAL);
342 if (s->channel_layout_str || s->channel_layout) {
345 if (!s->channel_layout) {
346 s->channel_layout = av_get_channel_layout(s->channel_layout_str);
347 if (!s->channel_layout) {
348 av_log(ctx, AV_LOG_ERROR, "Invalid channel layout %s.\n",
349 s->channel_layout_str);
350 return AVERROR(EINVAL);
353 n = av_get_channel_layout_nb_channels(s->channel_layout);
355 if (n != s->channels) {
356 av_log(ctx, AV_LOG_ERROR,
357 "Mismatching channel count %d and layout '%s' "
359 s->channels, s->channel_layout_str, n);
360 return AVERROR(EINVAL);
364 } else if (!s->channels) {
365 av_log(ctx, AV_LOG_ERROR, "Neither number of channels nor "
366 "channel layout specified\n");
367 return AVERROR(EINVAL);
370 if (!(s->fifo = av_fifo_alloc(sizeof(AVFrame*))))
371 return AVERROR(ENOMEM);
373 if (!s->time_base.num)
374 s->time_base = (AVRational){1, s->sample_rate};
376 av_log(ctx, AV_LOG_VERBOSE,
377 "tb:%d/%d samplefmt:%s samplerate:%d chlayout:%s\n",
378 s->time_base.num, s->time_base.den, av_get_sample_fmt_name(s->sample_fmt),
379 s->sample_rate, s->channel_layout_str);
384 static av_cold void uninit(AVFilterContext *ctx)
386 BufferSourceContext *s = ctx->priv;
387 while (s->fifo && av_fifo_size(s->fifo)) {
389 av_fifo_generic_read(s->fifo, &frame, sizeof(frame), NULL);
390 av_frame_free(&frame);
392 av_buffer_unref(&s->hw_frames_ctx);
393 av_fifo_freep(&s->fifo);
396 static int query_formats(AVFilterContext *ctx)
398 BufferSourceContext *c = ctx->priv;
399 AVFilterChannelLayouts *channel_layouts = NULL;
400 AVFilterFormats *formats = NULL;
401 AVFilterFormats *samplerates = NULL;
404 switch (ctx->outputs[0]->type) {
405 case AVMEDIA_TYPE_VIDEO:
406 if ((ret = ff_add_format (&formats, c->pix_fmt)) < 0 ||
407 (ret = ff_set_common_formats (ctx , formats )) < 0)
410 case AVMEDIA_TYPE_AUDIO:
411 if ((ret = ff_add_format (&formats , c->sample_fmt )) < 0 ||
412 (ret = ff_set_common_formats (ctx , formats )) < 0 ||
413 (ret = ff_add_format (&samplerates, c->sample_rate)) < 0 ||
414 (ret = ff_set_common_samplerates (ctx , samplerates )) < 0)
417 if ((ret = ff_add_channel_layout(&channel_layouts,
418 c->channel_layout ? c->channel_layout :
419 FF_COUNT2LAYOUT(c->channels))) < 0)
421 if ((ret = ff_set_common_channel_layouts(ctx, channel_layouts)) < 0)
425 return AVERROR(EINVAL);
431 static int config_props(AVFilterLink *link)
433 BufferSourceContext *c = link->src->priv;
435 switch (link->type) {
436 case AVMEDIA_TYPE_VIDEO:
439 link->sample_aspect_ratio = c->pixel_aspect;
441 if (c->hw_frames_ctx) {
442 link->hw_frames_ctx = av_buffer_ref(c->hw_frames_ctx);
443 if (!link->hw_frames_ctx)
444 return AVERROR(ENOMEM);
447 case AVMEDIA_TYPE_AUDIO:
448 if (!c->channel_layout)
449 c->channel_layout = link->channel_layout;
452 return AVERROR(EINVAL);
455 link->time_base = c->time_base;
456 link->frame_rate = c->frame_rate;
460 static int request_frame(AVFilterLink *link)
462 BufferSourceContext *c = link->src->priv;
466 if (!av_fifo_size(c->fifo)) {
469 c->nb_failed_requests++;
470 return AVERROR(EAGAIN);
472 av_fifo_generic_read(c->fifo, &frame, sizeof(frame), NULL);
474 ret = ff_filter_frame(link, frame);
479 static int poll_frame(AVFilterLink *link)
481 BufferSourceContext *c = link->src->priv;
482 int size = av_fifo_size(c->fifo);
485 return size/sizeof(AVFrame*);
488 static const AVFilterPad avfilter_vsrc_buffer_outputs[] = {
491 .type = AVMEDIA_TYPE_VIDEO,
492 .request_frame = request_frame,
493 .poll_frame = poll_frame,
494 .config_props = config_props,
499 AVFilter ff_vsrc_buffer = {
501 .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
502 .priv_size = sizeof(BufferSourceContext),
503 .query_formats = query_formats,
509 .outputs = avfilter_vsrc_buffer_outputs,
510 .priv_class = &buffer_class,
513 static const AVFilterPad avfilter_asrc_abuffer_outputs[] = {
516 .type = AVMEDIA_TYPE_AUDIO,
517 .request_frame = request_frame,
518 .poll_frame = poll_frame,
519 .config_props = config_props,
524 AVFilter ff_asrc_abuffer = {
526 .description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
527 .priv_size = sizeof(BufferSourceContext),
528 .query_formats = query_formats,
534 .outputs = avfilter_asrc_abuffer_outputs,
535 .priv_class = &abuffer_class,