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"
38 #include "buffersrc.h"
43 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;
49 unsigned warning_limit;
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)\
71 if (c->w != width || c->h != height || c->pix_fmt != format) {\
72 av_log(s, AV_LOG_INFO, "Changing frame properties on the fly is not supported by all filters.\n");\
75 #define CHECK_AUDIO_PARAM_CHANGE(s, c, srate, ch_layout, ch_count, format)\
76 if (c->sample_fmt != format || c->sample_rate != srate ||\
77 c->channel_layout != ch_layout || c->channels != ch_count) {\
78 av_log(s, AV_LOG_ERROR, "Changing frame properties on the fly is not supported.\n");\
79 return AVERROR(EINVAL);\
82 AVBufferSrcParameters *av_buffersrc_parameters_alloc(void)
84 AVBufferSrcParameters *par = av_mallocz(sizeof(*par));
93 int av_buffersrc_parameters_set(AVFilterContext *ctx, AVBufferSrcParameters *param)
95 BufferSourceContext *s = ctx->priv;
97 if (param->time_base.num > 0 && param->time_base.den > 0)
98 s->time_base = param->time_base;
100 switch (ctx->filter->outputs[0].type) {
101 case AVMEDIA_TYPE_VIDEO:
102 if (param->format != AV_PIX_FMT_NONE) {
103 s->got_format_from_params = 1;
104 s->pix_fmt = param->format;
106 if (param->width > 0)
108 if (param->height > 0)
109 s->h = param->height;
110 if (param->sample_aspect_ratio.num > 0 && param->sample_aspect_ratio.den > 0)
111 s->pixel_aspect = param->sample_aspect_ratio;
112 if (param->frame_rate.num > 0 && param->frame_rate.den > 0)
113 s->frame_rate = param->frame_rate;
114 if (param->hw_frames_ctx) {
115 av_buffer_unref(&s->hw_frames_ctx);
116 s->hw_frames_ctx = av_buffer_ref(param->hw_frames_ctx);
117 if (!s->hw_frames_ctx)
118 return AVERROR(ENOMEM);
121 case AVMEDIA_TYPE_AUDIO:
122 if (param->format != AV_SAMPLE_FMT_NONE) {
123 s->got_format_from_params = 1;
124 s->sample_fmt = param->format;
126 if (param->sample_rate > 0)
127 s->sample_rate = param->sample_rate;
128 if (param->channel_layout)
129 s->channel_layout = param->channel_layout;
138 int attribute_align_arg av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame)
140 return av_buffersrc_add_frame_flags(ctx, (AVFrame *)frame,
141 AV_BUFFERSRC_FLAG_KEEP_REF);
144 int attribute_align_arg av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame)
146 return av_buffersrc_add_frame_flags(ctx, frame, 0);
149 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
150 AVFrame *frame, int flags);
152 int attribute_align_arg av_buffersrc_add_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
154 AVFrame *copy = NULL;
157 if (frame && frame->channel_layout &&
158 av_get_channel_layout_nb_channels(frame->channel_layout) != av_frame_get_channels(frame)) {
159 av_log(ctx, AV_LOG_ERROR, "Layout indicates a different number of channels than actually present\n");
160 return AVERROR(EINVAL);
163 if (!(flags & AV_BUFFERSRC_FLAG_KEEP_REF) || !frame)
164 return av_buffersrc_add_frame_internal(ctx, frame, flags);
166 if (!(copy = av_frame_alloc()))
167 return AVERROR(ENOMEM);
168 ret = av_frame_ref(copy, frame);
170 ret = av_buffersrc_add_frame_internal(ctx, copy, flags);
172 av_frame_free(©);
176 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
177 AVFrame *frame, int flags)
179 BufferSourceContext *s = ctx->priv;
183 s->nb_failed_requests = 0;
189 return AVERROR(EINVAL);
191 refcounted = !!frame->buf[0];
193 if (!(flags & AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT)) {
195 switch (ctx->outputs[0]->type) {
196 case AVMEDIA_TYPE_VIDEO:
197 CHECK_VIDEO_PARAM_CHANGE(ctx, s, frame->width, frame->height,
200 case AVMEDIA_TYPE_AUDIO:
201 /* For layouts unknown on input but known on link after negotiation. */
202 if (!frame->channel_layout)
203 frame->channel_layout = s->channel_layout;
204 CHECK_AUDIO_PARAM_CHANGE(ctx, s, frame->sample_rate, frame->channel_layout,
205 av_frame_get_channels(frame), frame->format);
208 return AVERROR(EINVAL);
213 if (!av_fifo_space(s->fifo) &&
214 (ret = av_fifo_realloc2(s->fifo, av_fifo_size(s->fifo) +
218 if (!(copy = av_frame_alloc()))
219 return AVERROR(ENOMEM);
222 av_frame_move_ref(copy, frame);
224 ret = av_frame_ref(copy, frame);
226 av_frame_free(©);
231 if ((ret = av_fifo_generic_write(s->fifo, ©, sizeof(copy), NULL)) < 0) {
233 av_frame_move_ref(frame, copy);
234 av_frame_free(©);
238 if ((flags & AV_BUFFERSRC_FLAG_PUSH))
239 if ((ret = ctx->output_pads[0].request_frame(ctx->outputs[0])) < 0)
245 static av_cold int init_video(AVFilterContext *ctx)
247 BufferSourceContext *c = ctx->priv;
249 if (!(c->pix_fmt != AV_PIX_FMT_NONE || c->got_format_from_params) || !c->w || !c->h ||
250 av_q2d(c->time_base) <= 0) {
251 av_log(ctx, AV_LOG_ERROR, "Invalid parameters provided.\n");
252 return AVERROR(EINVAL);
255 if (!(c->fifo = av_fifo_alloc(sizeof(AVFrame*))))
256 return AVERROR(ENOMEM);
258 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",
259 c->w, c->h, av_get_pix_fmt_name(c->pix_fmt),
260 c->time_base.num, c->time_base.den, c->frame_rate.num, c->frame_rate.den,
261 c->pixel_aspect.num, c->pixel_aspect.den, (char *)av_x_if_null(c->sws_param, ""));
262 c->warning_limit = 100;
266 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src)
268 return ((BufferSourceContext *)buffer_src->priv)->nb_failed_requests;
271 #define OFFSET(x) offsetof(BufferSourceContext, x)
272 #define A AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
273 #define V AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
275 static const AVOption buffer_options[] = {
276 { "width", NULL, OFFSET(w), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
277 { "video_size", NULL, OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, .flags = V },
278 { "height", NULL, OFFSET(h), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
279 { "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 },
280 #if FF_API_OLD_FILTER_OPTS
281 /* those 4 are for compatibility with the old option passing system where each filter
282 * did its own parsing */
283 { "time_base_num", "deprecated, do not use", OFFSET(time_base.num), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
284 { "time_base_den", "deprecated, do not use", OFFSET(time_base.den), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
285 { "sar_num", "deprecated, do not use", OFFSET(pixel_aspect.num), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
286 { "sar_den", "deprecated, do not use", OFFSET(pixel_aspect.den), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
288 { "sar", "sample aspect ratio", OFFSET(pixel_aspect), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
289 { "pixel_aspect", "sample aspect ratio", OFFSET(pixel_aspect), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
290 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
291 { "frame_rate", NULL, OFFSET(frame_rate), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
292 { "sws_param", NULL, OFFSET(sws_param), AV_OPT_TYPE_STRING, .flags = V },
296 AVFILTER_DEFINE_CLASS(buffer);
298 static const AVOption abuffer_options[] = {
299 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, A },
300 { "sample_rate", NULL, OFFSET(sample_rate), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, A },
301 { "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 },
302 { "channel_layout", NULL, OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, .flags = A },
303 { "channels", NULL, OFFSET(channels), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, A },
307 AVFILTER_DEFINE_CLASS(abuffer);
309 static av_cold int init_audio(AVFilterContext *ctx)
311 BufferSourceContext *s = ctx->priv;
314 if (!(s->sample_fmt != AV_SAMPLE_FMT_NONE || s->got_format_from_params)) {
315 av_log(ctx, AV_LOG_ERROR, "Sample format was not set or was invalid\n");
316 return AVERROR(EINVAL);
319 if (s->channel_layout_str) {
322 s->channel_layout = av_get_channel_layout(s->channel_layout_str);
323 if (!s->channel_layout) {
324 av_log(ctx, AV_LOG_ERROR, "Invalid channel layout %s.\n",
325 s->channel_layout_str);
326 return AVERROR(EINVAL);
328 n = av_get_channel_layout_nb_channels(s->channel_layout);
330 if (n != s->channels) {
331 av_log(ctx, AV_LOG_ERROR,
332 "Mismatching channel count %d and layout '%s' "
334 s->channels, s->channel_layout_str, n);
335 return AVERROR(EINVAL);
339 } else if (!s->channels) {
340 av_log(ctx, AV_LOG_ERROR, "Neither number of channels nor "
341 "channel layout specified\n");
342 return AVERROR(EINVAL);
345 if (!(s->fifo = av_fifo_alloc(sizeof(AVFrame*))))
346 return AVERROR(ENOMEM);
348 if (!s->time_base.num)
349 s->time_base = (AVRational){1, s->sample_rate};
351 av_log(ctx, AV_LOG_VERBOSE,
352 "tb:%d/%d samplefmt:%s samplerate:%d chlayout:%s\n",
353 s->time_base.num, s->time_base.den, av_get_sample_fmt_name(s->sample_fmt),
354 s->sample_rate, s->channel_layout_str);
355 s->warning_limit = 100;
360 static av_cold void uninit(AVFilterContext *ctx)
362 BufferSourceContext *s = ctx->priv;
363 while (s->fifo && av_fifo_size(s->fifo)) {
365 av_fifo_generic_read(s->fifo, &frame, sizeof(frame), NULL);
366 av_frame_free(&frame);
368 av_buffer_unref(&s->hw_frames_ctx);
369 av_fifo_freep(&s->fifo);
372 static int query_formats(AVFilterContext *ctx)
374 BufferSourceContext *c = ctx->priv;
375 AVFilterChannelLayouts *channel_layouts = NULL;
376 AVFilterFormats *formats = NULL;
377 AVFilterFormats *samplerates = NULL;
380 switch (ctx->outputs[0]->type) {
381 case AVMEDIA_TYPE_VIDEO:
382 if ((ret = ff_add_format (&formats, c->pix_fmt)) < 0 ||
383 (ret = ff_set_common_formats (ctx , formats )) < 0)
386 case AVMEDIA_TYPE_AUDIO:
387 if ((ret = ff_add_format (&formats , c->sample_fmt )) < 0 ||
388 (ret = ff_set_common_formats (ctx , formats )) < 0 ||
389 (ret = ff_add_format (&samplerates, c->sample_rate)) < 0 ||
390 (ret = ff_set_common_samplerates (ctx , samplerates )) < 0)
393 if ((ret = ff_add_channel_layout(&channel_layouts,
394 c->channel_layout ? c->channel_layout :
395 FF_COUNT2LAYOUT(c->channels))) < 0)
397 if ((ret = ff_set_common_channel_layouts(ctx, channel_layouts)) < 0)
401 return AVERROR(EINVAL);
407 static int config_props(AVFilterLink *link)
409 BufferSourceContext *c = link->src->priv;
411 switch (link->type) {
412 case AVMEDIA_TYPE_VIDEO:
415 link->sample_aspect_ratio = c->pixel_aspect;
417 if (c->hw_frames_ctx) {
418 link->hw_frames_ctx = av_buffer_ref(c->hw_frames_ctx);
419 if (!link->hw_frames_ctx)
420 return AVERROR(ENOMEM);
423 case AVMEDIA_TYPE_AUDIO:
424 if (!c->channel_layout)
425 c->channel_layout = link->channel_layout;
428 return AVERROR(EINVAL);
431 link->time_base = c->time_base;
432 link->frame_rate = c->frame_rate;
436 static int request_frame(AVFilterLink *link)
438 BufferSourceContext *c = link->src->priv;
442 if (!av_fifo_size(c->fifo)) {
445 c->nb_failed_requests++;
446 return AVERROR(EAGAIN);
448 av_fifo_generic_read(c->fifo, &frame, sizeof(frame), NULL);
450 ret = ff_filter_frame(link, frame);
455 static int poll_frame(AVFilterLink *link)
457 BufferSourceContext *c = link->src->priv;
458 int size = av_fifo_size(c->fifo);
461 return size/sizeof(AVFrame*);
464 static const AVFilterPad avfilter_vsrc_buffer_outputs[] = {
467 .type = AVMEDIA_TYPE_VIDEO,
468 .request_frame = request_frame,
469 .poll_frame = poll_frame,
470 .config_props = config_props,
475 AVFilter ff_vsrc_buffer = {
477 .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
478 .priv_size = sizeof(BufferSourceContext),
479 .query_formats = query_formats,
485 .outputs = avfilter_vsrc_buffer_outputs,
486 .priv_class = &buffer_class,
489 static const AVFilterPad avfilter_asrc_abuffer_outputs[] = {
492 .type = AVMEDIA_TYPE_AUDIO,
493 .request_frame = request_frame,
494 .poll_frame = poll_frame,
495 .config_props = config_props,
500 AVFilter ff_asrc_abuffer = {
502 .description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
503 .priv_size = sizeof(BufferSourceContext),
504 .query_formats = query_formats,
510 .outputs = avfilter_asrc_abuffer_outputs,
511 .priv_class = &abuffer_class,