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/avassert.h"
29 #include "libavutil/channel_layout.h"
30 #include "libavutil/common.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 {
46 AVRational time_base; ///< time_base to set in the output link
47 AVRational frame_rate; ///< frame_rate to set in the output link
48 unsigned nb_failed_requests;
52 enum AVPixelFormat pix_fmt;
53 AVRational pixel_aspect;
56 AVBufferRef *hw_frames_ctx;
60 enum AVSampleFormat sample_fmt;
62 uint64_t channel_layout;
63 char *channel_layout_str;
65 int got_format_from_params;
67 } BufferSourceContext;
69 #define CHECK_VIDEO_PARAM_CHANGE(s, c, width, height, format, pts)\
70 if (c->w != width || c->h != height || c->pix_fmt != format) {\
71 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",\
72 c->w, c->h, c->pix_fmt, width, height, format, av_ts2timestr(pts, &s->outputs[0]->time_base));\
73 av_log(s, AV_LOG_WARNING, "Changing video frame properties on the fly is not supported by all filters.\n");\
76 #define CHECK_AUDIO_PARAM_CHANGE(s, c, srate, ch_layout, ch_count, format, pts)\
77 if (c->sample_fmt != format || c->sample_rate != srate ||\
78 c->channel_layout != ch_layout || c->channels != ch_count) {\
79 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",\
80 av_get_sample_fmt_name(c->sample_fmt), c->sample_rate, c->channel_layout, c->channels,\
81 av_get_sample_fmt_name(format), srate, ch_layout, ch_count, av_ts2timestr(pts, &s->outputs[0]->time_base));\
82 av_log(s, AV_LOG_ERROR, "Changing audio frame properties on the fly is not supported.\n");\
83 return AVERROR(EINVAL);\
86 AVBufferSrcParameters *av_buffersrc_parameters_alloc(void)
88 AVBufferSrcParameters *par = av_mallocz(sizeof(*par));
97 int av_buffersrc_parameters_set(AVFilterContext *ctx, AVBufferSrcParameters *param)
99 BufferSourceContext *s = ctx->priv;
101 if (param->time_base.num > 0 && param->time_base.den > 0)
102 s->time_base = param->time_base;
104 switch (ctx->filter->outputs[0].type) {
105 case AVMEDIA_TYPE_VIDEO:
106 if (param->format != AV_PIX_FMT_NONE) {
107 s->got_format_from_params = 1;
108 s->pix_fmt = param->format;
110 if (param->width > 0)
112 if (param->height > 0)
113 s->h = param->height;
114 if (param->sample_aspect_ratio.num > 0 && param->sample_aspect_ratio.den > 0)
115 s->pixel_aspect = param->sample_aspect_ratio;
116 if (param->frame_rate.num > 0 && param->frame_rate.den > 0)
117 s->frame_rate = param->frame_rate;
118 if (param->hw_frames_ctx) {
119 av_buffer_unref(&s->hw_frames_ctx);
120 s->hw_frames_ctx = av_buffer_ref(param->hw_frames_ctx);
121 if (!s->hw_frames_ctx)
122 return AVERROR(ENOMEM);
125 case AVMEDIA_TYPE_AUDIO:
126 if (param->format != AV_SAMPLE_FMT_NONE) {
127 s->got_format_from_params = 1;
128 s->sample_fmt = param->format;
130 if (param->sample_rate > 0)
131 s->sample_rate = param->sample_rate;
132 if (param->channel_layout)
133 s->channel_layout = param->channel_layout;
142 int attribute_align_arg av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame)
144 return av_buffersrc_add_frame_flags(ctx, (AVFrame *)frame,
145 AV_BUFFERSRC_FLAG_KEEP_REF);
148 int attribute_align_arg av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame)
150 return av_buffersrc_add_frame_flags(ctx, frame, 0);
153 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
154 AVFrame *frame, int flags);
156 int attribute_align_arg av_buffersrc_add_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
158 AVFrame *copy = NULL;
161 if (frame && frame->channel_layout &&
162 av_get_channel_layout_nb_channels(frame->channel_layout) != frame->channels) {
163 av_log(ctx, AV_LOG_ERROR, "Layout indicates a different number of channels than actually present\n");
164 return AVERROR(EINVAL);
167 if (!(flags & AV_BUFFERSRC_FLAG_KEEP_REF) || !frame)
168 return av_buffersrc_add_frame_internal(ctx, frame, flags);
170 if (!(copy = av_frame_alloc()))
171 return AVERROR(ENOMEM);
172 ret = av_frame_ref(copy, frame);
174 ret = av_buffersrc_add_frame_internal(ctx, copy, flags);
176 av_frame_free(©);
180 static int push_frame(AVFilterGraph *graph)
185 ret = ff_filter_graph_run_once(graph);
186 if (ret == AVERROR(EAGAIN))
194 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
195 AVFrame *frame, int flags)
197 BufferSourceContext *s = ctx->priv;
201 s->nb_failed_requests = 0;
204 return av_buffersrc_close(ctx, AV_NOPTS_VALUE, flags);
206 return AVERROR(EINVAL);
208 refcounted = !!frame->buf[0];
210 if (!(flags & AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT)) {
212 switch (ctx->outputs[0]->type) {
213 case AVMEDIA_TYPE_VIDEO:
214 CHECK_VIDEO_PARAM_CHANGE(ctx, s, frame->width, frame->height,
215 frame->format, frame->pts);
217 case AVMEDIA_TYPE_AUDIO:
218 /* For layouts unknown on input but known on link after negotiation. */
219 if (!frame->channel_layout)
220 frame->channel_layout = s->channel_layout;
221 CHECK_AUDIO_PARAM_CHANGE(ctx, s, frame->sample_rate, frame->channel_layout,
222 frame->channels, frame->format, frame->pts);
225 return AVERROR(EINVAL);
230 if (!(copy = av_frame_alloc()))
231 return AVERROR(ENOMEM);
234 av_frame_move_ref(copy, frame);
236 ret = av_frame_ref(copy, frame);
238 av_frame_free(©);
243 ret = ff_filter_frame(ctx->outputs[0], copy);
245 av_frame_free(©);
249 if ((flags & AV_BUFFERSRC_FLAG_PUSH)) {
250 ret = push_frame(ctx->graph);
258 int av_buffersrc_close(AVFilterContext *ctx, int64_t pts, unsigned flags)
260 BufferSourceContext *s = ctx->priv;
263 ff_avfilter_link_set_in_status(ctx->outputs[0], AVERROR_EOF, pts);
264 return (flags & AV_BUFFERSRC_FLAG_PUSH) ? push_frame(ctx->graph) : 0;
267 static av_cold int init_video(AVFilterContext *ctx)
269 BufferSourceContext *c = ctx->priv;
271 if (!(c->pix_fmt != AV_PIX_FMT_NONE || c->got_format_from_params) || !c->w || !c->h ||
272 av_q2d(c->time_base) <= 0) {
273 av_log(ctx, AV_LOG_ERROR, "Invalid parameters provided.\n");
274 return AVERROR(EINVAL);
277 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",
278 c->w, c->h, av_get_pix_fmt_name(c->pix_fmt),
279 c->time_base.num, c->time_base.den, c->frame_rate.num, c->frame_rate.den,
280 c->pixel_aspect.num, c->pixel_aspect.den, (char *)av_x_if_null(c->sws_param, ""));
284 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src)
286 return ((BufferSourceContext *)buffer_src->priv)->nb_failed_requests;
289 #define OFFSET(x) offsetof(BufferSourceContext, x)
290 #define A AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
291 #define V AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
293 static const AVOption buffer_options[] = {
294 { "width", NULL, OFFSET(w), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
295 { "video_size", NULL, OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, .flags = V },
296 { "height", NULL, OFFSET(h), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
297 { "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 },
298 { "sar", "sample aspect ratio", OFFSET(pixel_aspect), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
299 { "pixel_aspect", "sample aspect ratio", OFFSET(pixel_aspect), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
300 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
301 { "frame_rate", NULL, OFFSET(frame_rate), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
302 { "sws_param", NULL, OFFSET(sws_param), AV_OPT_TYPE_STRING, .flags = V },
306 AVFILTER_DEFINE_CLASS(buffer);
308 static const AVOption abuffer_options[] = {
309 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, A },
310 { "sample_rate", NULL, OFFSET(sample_rate), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, A },
311 { "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 },
312 { "channel_layout", NULL, OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, .flags = A },
313 { "channels", NULL, OFFSET(channels), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, A },
317 AVFILTER_DEFINE_CLASS(abuffer);
319 static av_cold int init_audio(AVFilterContext *ctx)
321 BufferSourceContext *s = ctx->priv;
324 if (!(s->sample_fmt != AV_SAMPLE_FMT_NONE || s->got_format_from_params)) {
325 av_log(ctx, AV_LOG_ERROR, "Sample format was not set or was invalid\n");
326 return AVERROR(EINVAL);
329 if (s->channel_layout_str || s->channel_layout) {
332 if (!s->channel_layout) {
333 s->channel_layout = av_get_channel_layout(s->channel_layout_str);
334 if (!s->channel_layout) {
335 av_log(ctx, AV_LOG_ERROR, "Invalid channel layout %s.\n",
336 s->channel_layout_str);
337 return AVERROR(EINVAL);
340 n = av_get_channel_layout_nb_channels(s->channel_layout);
342 if (n != s->channels) {
343 av_log(ctx, AV_LOG_ERROR,
344 "Mismatching channel count %d and layout '%s' "
346 s->channels, s->channel_layout_str, n);
347 return AVERROR(EINVAL);
351 } else if (!s->channels) {
352 av_log(ctx, AV_LOG_ERROR, "Neither number of channels nor "
353 "channel layout specified\n");
354 return AVERROR(EINVAL);
357 if (!s->time_base.num)
358 s->time_base = (AVRational){1, s->sample_rate};
360 av_log(ctx, AV_LOG_VERBOSE,
361 "tb:%d/%d samplefmt:%s samplerate:%d chlayout:%s\n",
362 s->time_base.num, s->time_base.den, av_get_sample_fmt_name(s->sample_fmt),
363 s->sample_rate, s->channel_layout_str);
368 static av_cold void uninit(AVFilterContext *ctx)
370 BufferSourceContext *s = ctx->priv;
371 av_buffer_unref(&s->hw_frames_ctx);
374 static int query_formats(AVFilterContext *ctx)
376 BufferSourceContext *c = ctx->priv;
377 AVFilterChannelLayouts *channel_layouts = NULL;
378 AVFilterFormats *formats = NULL;
379 AVFilterFormats *samplerates = NULL;
382 switch (ctx->outputs[0]->type) {
383 case AVMEDIA_TYPE_VIDEO:
384 if ((ret = ff_add_format (&formats, c->pix_fmt)) < 0 ||
385 (ret = ff_set_common_formats (ctx , formats )) < 0)
388 case AVMEDIA_TYPE_AUDIO:
389 if ((ret = ff_add_format (&formats , c->sample_fmt )) < 0 ||
390 (ret = ff_set_common_formats (ctx , formats )) < 0 ||
391 (ret = ff_add_format (&samplerates, c->sample_rate)) < 0 ||
392 (ret = ff_set_common_samplerates (ctx , samplerates )) < 0)
395 if ((ret = ff_add_channel_layout(&channel_layouts,
396 c->channel_layout ? c->channel_layout :
397 FF_COUNT2LAYOUT(c->channels))) < 0)
399 if ((ret = ff_set_common_channel_layouts(ctx, channel_layouts)) < 0)
403 return AVERROR(EINVAL);
409 static int config_props(AVFilterLink *link)
411 BufferSourceContext *c = link->src->priv;
413 switch (link->type) {
414 case AVMEDIA_TYPE_VIDEO:
417 link->sample_aspect_ratio = c->pixel_aspect;
419 if (c->hw_frames_ctx) {
420 link->hw_frames_ctx = av_buffer_ref(c->hw_frames_ctx);
421 if (!link->hw_frames_ctx)
422 return AVERROR(ENOMEM);
425 case AVMEDIA_TYPE_AUDIO:
426 if (!c->channel_layout)
427 c->channel_layout = link->channel_layout;
430 return AVERROR(EINVAL);
433 link->time_base = c->time_base;
434 link->frame_rate = c->frame_rate;
438 static int request_frame(AVFilterLink *link)
440 BufferSourceContext *c = link->src->priv;
446 c->nb_failed_requests++;
447 return AVERROR(EAGAIN);
450 static const AVFilterPad avfilter_vsrc_buffer_outputs[] = {
453 .type = AVMEDIA_TYPE_VIDEO,
454 .request_frame = request_frame,
455 .config_props = config_props,
460 AVFilter ff_vsrc_buffer = {
462 .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
463 .priv_size = sizeof(BufferSourceContext),
464 .query_formats = query_formats,
470 .outputs = avfilter_vsrc_buffer_outputs,
471 .priv_class = &buffer_class,
474 static const AVFilterPad avfilter_asrc_abuffer_outputs[] = {
477 .type = AVMEDIA_TYPE_AUDIO,
478 .request_frame = request_frame,
479 .config_props = config_props,
484 AVFilter ff_asrc_abuffer = {
486 .description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
487 .priv_size = sizeof(BufferSourceContext),
488 .query_formats = query_formats,
494 .outputs = avfilter_asrc_abuffer_outputs,
495 .priv_class = &abuffer_class,