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
26 #include "libavutil/channel_layout.h"
27 #include "libavutil/common.h"
28 #include "libavutil/fifo.h"
29 #include "libavutil/frame.h"
30 #include "libavutil/imgutils.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/samplefmt.h"
35 #include "buffersrc.h"
44 AVRational time_base; ///< time_base to set in the output link
45 AVRational frame_rate; ///< frame_rate to set in the output link
46 unsigned nb_failed_requests;
47 unsigned warning_limit;
51 enum AVPixelFormat pix_fmt;
52 AVRational pixel_aspect;
57 enum AVSampleFormat sample_fmt;
60 uint64_t channel_layout;
61 char *channel_layout_str;
64 } BufferSourceContext;
66 #define CHECK_VIDEO_PARAM_CHANGE(s, c, width, height, format)\
67 if (c->w != width || c->h != height || c->pix_fmt != format) {\
68 av_log(s, AV_LOG_INFO, "Changing frame properties on the fly is not supported by all filters.\n");\
71 #define CHECK_AUDIO_PARAM_CHANGE(s, c, srate, ch_layout, ch_count, format)\
72 if (c->sample_fmt != format || c->sample_rate != srate ||\
73 c->channel_layout != ch_layout || c->channels != ch_count) {\
74 av_log(s, AV_LOG_ERROR, "Changing frame properties on the fly is not supported.\n");\
75 return AVERROR(EINVAL);\
78 int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame)
80 return av_buffersrc_add_frame_flags(ctx, (AVFrame *)frame,
81 AV_BUFFERSRC_FLAG_KEEP_REF);
84 int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame)
86 return av_buffersrc_add_frame_flags(ctx, frame, 0);
89 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
90 AVFrame *frame, int flags);
92 int av_buffersrc_add_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
97 if (frame && frame->channel_layout &&
98 av_get_channel_layout_nb_channels(frame->channel_layout) != av_frame_get_channels(frame)) {
99 av_log(0, AV_LOG_ERROR, "Layout indicates a different number of channels than actually present\n");
100 return AVERROR(EINVAL);
103 if (!(flags & AV_BUFFERSRC_FLAG_KEEP_REF) || !frame)
104 return av_buffersrc_add_frame_internal(ctx, frame, flags);
106 if (!(copy = av_frame_alloc()))
107 return AVERROR(ENOMEM);
108 ret = av_frame_ref(copy, frame);
110 ret = av_buffersrc_add_frame_internal(ctx, copy, flags);
112 av_frame_free(©);
116 static int attribute_align_arg av_buffersrc_add_frame_internal(AVFilterContext *ctx,
117 AVFrame *frame, int flags)
119 BufferSourceContext *s = ctx->priv;
127 return AVERROR(EINVAL);
129 if (!(flags & AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT)) {
131 switch (ctx->outputs[0]->type) {
132 case AVMEDIA_TYPE_VIDEO:
133 CHECK_VIDEO_PARAM_CHANGE(ctx, s, frame->width, frame->height,
136 case AVMEDIA_TYPE_AUDIO:
137 /* For layouts unknown on input but known on link after negotiation. */
138 if (!frame->channel_layout)
139 frame->channel_layout = s->channel_layout;
140 CHECK_AUDIO_PARAM_CHANGE(ctx, s, frame->sample_rate, frame->channel_layout,
141 av_frame_get_channels(frame), frame->format);
144 return AVERROR(EINVAL);
149 if (!av_fifo_space(s->fifo) &&
150 (ret = av_fifo_realloc2(s->fifo, av_fifo_size(s->fifo) +
154 if (!(copy = av_frame_alloc()))
155 return AVERROR(ENOMEM);
156 av_frame_move_ref(copy, frame);
158 if ((ret = av_fifo_generic_write(s->fifo, ©, sizeof(copy), NULL)) < 0) {
159 av_frame_move_ref(frame, copy);
160 av_frame_free(©);
164 if ((flags & AV_BUFFERSRC_FLAG_PUSH))
165 if ((ret = ctx->output_pads[0].request_frame(ctx->outputs[0])) < 0)
171 #if FF_API_AVFILTERBUFFER
172 static void compat_free_buffer(void *opaque, uint8_t *data)
174 AVFilterBufferRef *buf = opaque;
175 AV_NOWARN_DEPRECATED(
176 avfilter_unref_buffer(buf);
180 static void compat_unref_buffer(void *opaque, uint8_t *data)
182 AVBufferRef *buf = opaque;
183 AV_NOWARN_DEPRECATED(
184 av_buffer_unref(&buf);
188 int av_buffersrc_add_ref(AVFilterContext *ctx, AVFilterBufferRef *buf,
191 BufferSourceContext *s = ctx->priv;
192 AVFrame *frame = NULL;
193 AVBufferRef *dummy_buf = NULL;
194 int ret = 0, planes, i;
200 return AVERROR(EINVAL);
202 frame = av_frame_alloc();
204 return AVERROR(ENOMEM);
206 dummy_buf = av_buffer_create(NULL, 0, compat_free_buffer, buf,
207 (buf->perms & AV_PERM_WRITE) ? 0 : AV_BUFFER_FLAG_READONLY);
209 ret = AVERROR(ENOMEM);
213 AV_NOWARN_DEPRECATED(
214 if ((ret = avfilter_copy_buf_props(frame, buf)) < 0)
218 #define WRAP_PLANE(ref_out, data, data_size) \
220 AVBufferRef *dummy_ref = av_buffer_ref(dummy_buf); \
222 ret = AVERROR(ENOMEM); \
225 ref_out = av_buffer_create(data, data_size, compat_unref_buffer, \
226 dummy_ref, (buf->perms & AV_PERM_WRITE) ? 0 : AV_BUFFER_FLAG_READONLY); \
228 av_frame_unref(frame); \
229 ret = AVERROR(ENOMEM); \
234 if (ctx->outputs[0]->type == AVMEDIA_TYPE_VIDEO) {
235 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
237 planes = av_pix_fmt_count_planes(frame->format);
238 if (!desc || planes <= 0) {
239 ret = AVERROR(EINVAL);
243 for (i = 0; i < planes; i++) {
244 int v_shift = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
245 int plane_size = (frame->height >> v_shift) * frame->linesize[i];
247 WRAP_PLANE(frame->buf[i], frame->data[i], plane_size);
250 int planar = av_sample_fmt_is_planar(frame->format);
251 int channels = av_get_channel_layout_nb_channels(frame->channel_layout);
253 planes = planar ? channels : 1;
255 if (planes > FF_ARRAY_ELEMS(frame->buf)) {
256 frame->nb_extended_buf = planes - FF_ARRAY_ELEMS(frame->buf);
257 frame->extended_buf = av_mallocz(sizeof(*frame->extended_buf) *
258 frame->nb_extended_buf);
259 if (!frame->extended_buf) {
260 ret = AVERROR(ENOMEM);
265 for (i = 0; i < FFMIN(planes, FF_ARRAY_ELEMS(frame->buf)); i++)
266 WRAP_PLANE(frame->buf[i], frame->extended_data[i], frame->linesize[0]);
268 for (i = 0; i < planes - FF_ARRAY_ELEMS(frame->buf); i++)
269 WRAP_PLANE(frame->extended_buf[i],
270 frame->extended_data[i + FF_ARRAY_ELEMS(frame->buf)],
274 ret = av_buffersrc_add_frame_flags(ctx, frame, flags);
277 av_buffer_unref(&dummy_buf);
278 av_frame_free(&frame);
283 int av_buffersrc_buffer(AVFilterContext *ctx, AVFilterBufferRef *buf)
285 return av_buffersrc_add_ref(ctx, buf, 0);
289 #define OFFSET(x) offsetof(BufferSourceContext, x)
290 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
291 static const AVOption buffer_options[] = {
292 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, FLAGS },
293 { "frame_rate", NULL, OFFSET(frame_rate), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, FLAGS },
294 { "video_size", NULL, OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, .flags = FLAGS },
295 { "pix_fmt", NULL, OFFSET(pix_fmt), AV_OPT_TYPE_PIXEL_FMT, .flags = FLAGS },
296 { "pixel_aspect", NULL, OFFSET(pixel_aspect), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, FLAGS },
297 { "sws_param", NULL, OFFSET(sws_param), AV_OPT_TYPE_STRING, .flags = FLAGS },
302 AVFILTER_DEFINE_CLASS(buffer);
304 static av_cold int init_video(AVFilterContext *ctx, const char *args)
306 BufferSourceContext *c = ctx->priv;
307 char pix_fmt_str[128], *colon, *equal;
310 c->class = &buffer_class;
313 av_log(ctx, AV_LOG_ERROR, "Arguments required\n");
314 return AVERROR(EINVAL);
317 colon = strchr(args, ':');
318 equal = strchr(args, '=');
319 if (equal && (!colon || equal < colon)) {
320 av_opt_set_defaults(c);
321 ret = av_set_options_string(c, args, "=", ":");
326 (n = sscanf(args, "%d:%d:%127[^:]:%d:%d:%d:%d", &c->w, &c->h, pix_fmt_str,
327 &c->time_base.num, &c->time_base.den,
328 &c->pixel_aspect.num, &c->pixel_aspect.den)) != 7) {
329 av_log(ctx, AV_LOG_ERROR, "Expected 7 arguments, but %d found in '%s'\n", n, args);
330 return AVERROR(EINVAL);
332 if ((c->pix_fmt = av_get_pix_fmt(pix_fmt_str)) == AV_PIX_FMT_NONE) {
334 c->pix_fmt = strtol(pix_fmt_str, &tail, 10);
335 if (*tail || c->pix_fmt < 0 || c->pix_fmt >= AV_PIX_FMT_NB) {
336 av_log(ctx, AV_LOG_ERROR, "Invalid pixel format string '%s'\n", pix_fmt_str);
337 return AVERROR(EINVAL);
342 if (!(c->fifo = av_fifo_alloc(sizeof(AVFrame*))))
343 return AVERROR(ENOMEM);
345 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",
346 c->w, c->h, av_get_pix_fmt_name(c->pix_fmt),
347 c->time_base.num, c->time_base.den, c->frame_rate.num, c->frame_rate.den,
348 c->pixel_aspect.num, c->pixel_aspect.den, (char *)av_x_if_null(c->sws_param, ""));
349 c->warning_limit = 100;
357 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src)
359 return ((BufferSourceContext *)buffer_src->priv)->nb_failed_requests;
362 #define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
363 static const AVOption abuffer_options[] = {
364 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, FLAGS },
365 { "sample_rate", NULL, OFFSET(sample_rate), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
366 { "sample_fmt", NULL, OFFSET(sample_fmt_str), AV_OPT_TYPE_STRING, .flags = FLAGS },
367 { "channels", NULL, OFFSET(channels), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, FLAGS },
368 { "channel_layout", NULL, OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, .flags = FLAGS },
372 AVFILTER_DEFINE_CLASS(abuffer);
374 static av_cold int init_audio(AVFilterContext *ctx, const char *args)
376 BufferSourceContext *s = ctx->priv;
379 s->class = &abuffer_class;
380 av_opt_set_defaults(s);
382 if ((ret = av_set_options_string(s, args, "=", ":")) < 0)
385 s->sample_fmt = av_get_sample_fmt(s->sample_fmt_str);
386 if (s->sample_fmt == AV_SAMPLE_FMT_NONE) {
387 av_log(ctx, AV_LOG_ERROR, "Invalid sample format '%s'\n",
389 ret = AVERROR(EINVAL);
393 if (s->channel_layout_str) {
396 s->channel_layout = av_get_channel_layout(s->channel_layout_str);
397 if (!s->channel_layout) {
398 av_log(ctx, AV_LOG_ERROR, "Invalid channel layout '%s'\n",
399 s->channel_layout_str);
400 ret = AVERROR(EINVAL);
403 n = av_get_channel_layout_nb_channels(s->channel_layout);
405 if (n != s->channels) {
406 av_log(ctx, AV_LOG_ERROR,
407 "Mismatching channel count %d and layout '%s' "
409 s->channels, s->channel_layout_str, n);
410 ret = AVERROR(EINVAL);
415 } else if (!s->channels) {
416 av_log(ctx, AV_LOG_ERROR, "Neither number of channels nor "
417 "channel layout specified\n");
418 ret = AVERROR(EINVAL);
422 if (!(s->fifo = av_fifo_alloc(sizeof(AVFrame*)))) {
423 ret = AVERROR(ENOMEM);
427 if (!s->time_base.num)
428 s->time_base = (AVRational){1, s->sample_rate};
430 av_log(ctx, AV_LOG_VERBOSE,
431 "tb:%d/%d samplefmt:%s samplerate:%d chlayout:%s\n",
432 s->time_base.num, s->time_base.den, s->sample_fmt_str,
433 s->sample_rate, s->channel_layout_str);
434 s->warning_limit = 100;
441 static av_cold void uninit(AVFilterContext *ctx)
443 BufferSourceContext *s = ctx->priv;
444 while (s->fifo && av_fifo_size(s->fifo)) {
446 av_fifo_generic_read(s->fifo, &frame, sizeof(frame), NULL);
447 av_frame_free(&frame);
449 av_fifo_free(s->fifo);
451 av_freep(&s->sws_param);
454 static int query_formats(AVFilterContext *ctx)
456 BufferSourceContext *c = ctx->priv;
457 AVFilterChannelLayouts *channel_layouts = NULL;
458 AVFilterFormats *formats = NULL;
459 AVFilterFormats *samplerates = NULL;
461 switch (ctx->outputs[0]->type) {
462 case AVMEDIA_TYPE_VIDEO:
463 ff_add_format(&formats, c->pix_fmt);
464 ff_set_common_formats(ctx, formats);
466 case AVMEDIA_TYPE_AUDIO:
467 ff_add_format(&formats, c->sample_fmt);
468 ff_set_common_formats(ctx, formats);
470 ff_add_format(&samplerates, c->sample_rate);
471 ff_set_common_samplerates(ctx, samplerates);
473 ff_add_channel_layout(&channel_layouts,
474 c->channel_layout ? c->channel_layout :
475 FF_COUNT2LAYOUT(c->channels));
476 ff_set_common_channel_layouts(ctx, channel_layouts);
479 return AVERROR(EINVAL);
485 static int config_props(AVFilterLink *link)
487 BufferSourceContext *c = link->src->priv;
489 switch (link->type) {
490 case AVMEDIA_TYPE_VIDEO:
493 link->sample_aspect_ratio = c->pixel_aspect;
495 case AVMEDIA_TYPE_AUDIO:
496 if (!c->channel_layout)
497 c->channel_layout = link->channel_layout;
500 return AVERROR(EINVAL);
503 link->time_base = c->time_base;
504 link->frame_rate = c->frame_rate;
508 static int request_frame(AVFilterLink *link)
510 BufferSourceContext *c = link->src->priv;
513 if (!av_fifo_size(c->fifo)) {
516 c->nb_failed_requests++;
517 return AVERROR(EAGAIN);
519 av_fifo_generic_read(c->fifo, &frame, sizeof(frame), NULL);
521 return ff_filter_frame(link, frame);
524 static int poll_frame(AVFilterLink *link)
526 BufferSourceContext *c = link->src->priv;
527 int size = av_fifo_size(c->fifo);
530 return size/sizeof(AVFrame*);
533 static const AVFilterPad avfilter_vsrc_buffer_outputs[] = {
536 .type = AVMEDIA_TYPE_VIDEO,
537 .request_frame = request_frame,
538 .poll_frame = poll_frame,
539 .config_props = config_props,
544 AVFilter avfilter_vsrc_buffer = {
546 .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
547 .priv_size = sizeof(BufferSourceContext),
548 .query_formats = query_formats,
554 .outputs = avfilter_vsrc_buffer_outputs,
555 .priv_class = &buffer_class,
558 static const AVFilterPad avfilter_asrc_abuffer_outputs[] = {
561 .type = AVMEDIA_TYPE_AUDIO,
562 .request_frame = request_frame,
563 .poll_frame = poll_frame,
564 .config_props = config_props,
569 AVFilter avfilter_asrc_abuffer = {
571 .description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
572 .priv_size = sizeof(BufferSourceContext),
573 .query_formats = query_formats,
579 .outputs = avfilter_asrc_abuffer_outputs,
580 .priv_class = &abuffer_class,