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;
59 enum AVSampleFormat sample_fmt;
61 uint64_t channel_layout;
62 char *channel_layout_str;
65 } BufferSourceContext;
67 #define CHECK_VIDEO_PARAM_CHANGE(s, c, width, height, format)\
68 if (c->w != width || c->h != height || c->pix_fmt != format) {\
69 av_log(s, AV_LOG_INFO, "Changing frame properties on the fly is not supported by all filters.\n");\
72 #define CHECK_AUDIO_PARAM_CHANGE(s, c, srate, ch_layout, ch_count, format)\
73 if (c->sample_fmt != format || c->sample_rate != srate ||\
74 c->channel_layout != ch_layout || c->channels != ch_count) {\
75 av_log(s, AV_LOG_ERROR, "Changing frame properties on the fly is not supported.\n");\
76 return AVERROR(EINVAL);\
79 int attribute_align_arg av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame)
81 return av_buffersrc_add_frame_flags(ctx, (AVFrame *)frame,
82 AV_BUFFERSRC_FLAG_KEEP_REF);
85 int attribute_align_arg av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame)
87 return av_buffersrc_add_frame_flags(ctx, frame, 0);
90 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
91 AVFrame *frame, int flags);
93 int attribute_align_arg av_buffersrc_add_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags)
98 if (frame && frame->channel_layout &&
99 av_get_channel_layout_nb_channels(frame->channel_layout) != av_frame_get_channels(frame)) {
100 av_log(ctx, AV_LOG_ERROR, "Layout indicates a different number of channels than actually present\n");
101 return AVERROR(EINVAL);
104 if (!(flags & AV_BUFFERSRC_FLAG_KEEP_REF) || !frame)
105 return av_buffersrc_add_frame_internal(ctx, frame, flags);
107 if (!(copy = av_frame_alloc()))
108 return AVERROR(ENOMEM);
109 ret = av_frame_ref(copy, frame);
111 ret = av_buffersrc_add_frame_internal(ctx, copy, flags);
113 av_frame_free(©);
117 static int av_buffersrc_add_frame_internal(AVFilterContext *ctx,
118 AVFrame *frame, int flags)
120 BufferSourceContext *s = ctx->priv;
124 s->nb_failed_requests = 0;
130 return AVERROR(EINVAL);
132 refcounted = !!frame->buf[0];
134 if (!(flags & AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT)) {
136 switch (ctx->outputs[0]->type) {
137 case AVMEDIA_TYPE_VIDEO:
138 CHECK_VIDEO_PARAM_CHANGE(ctx, s, frame->width, frame->height,
141 case AVMEDIA_TYPE_AUDIO:
142 /* For layouts unknown on input but known on link after negotiation. */
143 if (!frame->channel_layout)
144 frame->channel_layout = s->channel_layout;
145 CHECK_AUDIO_PARAM_CHANGE(ctx, s, frame->sample_rate, frame->channel_layout,
146 av_frame_get_channels(frame), frame->format);
149 return AVERROR(EINVAL);
154 if (!av_fifo_space(s->fifo) &&
155 (ret = av_fifo_realloc2(s->fifo, av_fifo_size(s->fifo) +
159 if (!(copy = av_frame_alloc()))
160 return AVERROR(ENOMEM);
163 av_frame_move_ref(copy, frame);
165 ret = av_frame_ref(copy, frame);
167 av_frame_free(©);
172 if ((ret = av_fifo_generic_write(s->fifo, ©, sizeof(copy), NULL)) < 0) {
174 av_frame_move_ref(frame, copy);
175 av_frame_free(©);
179 if ((flags & AV_BUFFERSRC_FLAG_PUSH))
180 if ((ret = ctx->output_pads[0].request_frame(ctx->outputs[0])) < 0)
186 static av_cold int init_video(AVFilterContext *ctx)
188 BufferSourceContext *c = ctx->priv;
190 if (c->pix_fmt == AV_PIX_FMT_NONE || !c->w || !c->h || av_q2d(c->time_base) <= 0) {
191 av_log(ctx, AV_LOG_ERROR, "Invalid parameters provided.\n");
192 return AVERROR(EINVAL);
195 if (!(c->fifo = av_fifo_alloc(sizeof(AVFrame*))))
196 return AVERROR(ENOMEM);
198 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",
199 c->w, c->h, av_get_pix_fmt_name(c->pix_fmt),
200 c->time_base.num, c->time_base.den, c->frame_rate.num, c->frame_rate.den,
201 c->pixel_aspect.num, c->pixel_aspect.den, (char *)av_x_if_null(c->sws_param, ""));
202 c->warning_limit = 100;
206 unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src)
208 return ((BufferSourceContext *)buffer_src->priv)->nb_failed_requests;
211 #define OFFSET(x) offsetof(BufferSourceContext, x)
212 #define A AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
213 #define V AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
215 static const AVOption buffer_options[] = {
216 { "width", NULL, OFFSET(w), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
217 { "video_size", NULL, OFFSET(w), AV_OPT_TYPE_IMAGE_SIZE, .flags = V },
218 { "height", NULL, OFFSET(h), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
219 { "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 },
220 #if FF_API_OLD_FILTER_OPTS
221 /* those 4 are for compatibility with the old option passing system where each filter
222 * did its own parsing */
223 { "time_base_num", "deprecated, do not use", OFFSET(time_base.num), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
224 { "time_base_den", "deprecated, do not use", OFFSET(time_base.den), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
225 { "sar_num", "deprecated, do not use", OFFSET(pixel_aspect.num), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
226 { "sar_den", "deprecated, do not use", OFFSET(pixel_aspect.den), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, V },
228 { "sar", "sample aspect ratio", OFFSET(pixel_aspect), AV_OPT_TYPE_RATIONAL, { .dbl = 1 }, 0, DBL_MAX, V },
229 { "pixel_aspect", "sample aspect ratio", OFFSET(pixel_aspect), AV_OPT_TYPE_RATIONAL, { .dbl = 1 }, 0, DBL_MAX, V },
230 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
231 { "frame_rate", NULL, OFFSET(frame_rate), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, DBL_MAX, V },
232 { "sws_param", NULL, OFFSET(sws_param), AV_OPT_TYPE_STRING, .flags = V },
236 AVFILTER_DEFINE_CLASS(buffer);
238 static const AVOption abuffer_options[] = {
239 { "time_base", NULL, OFFSET(time_base), AV_OPT_TYPE_RATIONAL, { .dbl = 0 }, 0, INT_MAX, A },
240 { "sample_rate", NULL, OFFSET(sample_rate), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, A },
241 { "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 },
242 { "channel_layout", NULL, OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, .flags = A },
243 { "channels", NULL, OFFSET(channels), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, A },
247 AVFILTER_DEFINE_CLASS(abuffer);
249 static av_cold int init_audio(AVFilterContext *ctx)
251 BufferSourceContext *s = ctx->priv;
254 if (s->sample_fmt == AV_SAMPLE_FMT_NONE) {
255 av_log(ctx, AV_LOG_ERROR, "Sample format was not set or was invalid\n");
256 return AVERROR(EINVAL);
259 if (s->channel_layout_str) {
262 s->channel_layout = av_get_channel_layout(s->channel_layout_str);
263 if (!s->channel_layout) {
264 av_log(ctx, AV_LOG_ERROR, "Invalid channel layout %s.\n",
265 s->channel_layout_str);
266 return AVERROR(EINVAL);
268 n = av_get_channel_layout_nb_channels(s->channel_layout);
270 if (n != s->channels) {
271 av_log(ctx, AV_LOG_ERROR,
272 "Mismatching channel count %d and layout '%s' "
274 s->channels, s->channel_layout_str, n);
275 return AVERROR(EINVAL);
279 } else if (!s->channels) {
280 av_log(ctx, AV_LOG_ERROR, "Neither number of channels nor "
281 "channel layout specified\n");
282 return AVERROR(EINVAL);
285 if (!(s->fifo = av_fifo_alloc(sizeof(AVFrame*))))
286 return AVERROR(ENOMEM);
288 if (!s->time_base.num)
289 s->time_base = (AVRational){1, s->sample_rate};
291 av_log(ctx, AV_LOG_VERBOSE,
292 "tb:%d/%d samplefmt:%s samplerate:%d chlayout:%s\n",
293 s->time_base.num, s->time_base.den, av_get_sample_fmt_name(s->sample_fmt),
294 s->sample_rate, s->channel_layout_str);
295 s->warning_limit = 100;
300 static av_cold void uninit(AVFilterContext *ctx)
302 BufferSourceContext *s = ctx->priv;
303 while (s->fifo && av_fifo_size(s->fifo)) {
305 av_fifo_generic_read(s->fifo, &frame, sizeof(frame), NULL);
306 av_frame_free(&frame);
308 av_fifo_freep(&s->fifo);
311 static int query_formats(AVFilterContext *ctx)
313 BufferSourceContext *c = ctx->priv;
314 AVFilterChannelLayouts *channel_layouts = NULL;
315 AVFilterFormats *formats = NULL;
316 AVFilterFormats *samplerates = NULL;
319 switch (ctx->outputs[0]->type) {
320 case AVMEDIA_TYPE_VIDEO:
321 if ((ret = ff_add_format (&formats, c->pix_fmt)) < 0 ||
322 (ret = ff_set_common_formats (ctx , formats )) < 0)
325 case AVMEDIA_TYPE_AUDIO:
326 if ((ret = ff_add_format (&formats , c->sample_fmt )) < 0 ||
327 (ret = ff_set_common_formats (ctx , formats )) < 0 ||
328 (ret = ff_add_format (&samplerates, c->sample_rate)) < 0 ||
329 (ret = ff_set_common_samplerates (ctx , samplerates )) < 0)
332 if ((ret = ff_add_channel_layout(&channel_layouts,
333 c->channel_layout ? c->channel_layout :
334 FF_COUNT2LAYOUT(c->channels))) < 0)
336 if ((ret = ff_set_common_channel_layouts(ctx, channel_layouts)) < 0)
340 return AVERROR(EINVAL);
346 static int config_props(AVFilterLink *link)
348 BufferSourceContext *c = link->src->priv;
350 switch (link->type) {
351 case AVMEDIA_TYPE_VIDEO:
354 link->sample_aspect_ratio = c->pixel_aspect;
356 case AVMEDIA_TYPE_AUDIO:
357 if (!c->channel_layout)
358 c->channel_layout = link->channel_layout;
361 return AVERROR(EINVAL);
364 link->time_base = c->time_base;
365 link->frame_rate = c->frame_rate;
369 static int request_frame(AVFilterLink *link)
371 BufferSourceContext *c = link->src->priv;
374 if (!av_fifo_size(c->fifo)) {
377 c->nb_failed_requests++;
378 return AVERROR(EAGAIN);
380 av_fifo_generic_read(c->fifo, &frame, sizeof(frame), NULL);
382 return ff_filter_frame(link, frame);
385 static int poll_frame(AVFilterLink *link)
387 BufferSourceContext *c = link->src->priv;
388 int size = av_fifo_size(c->fifo);
391 return size/sizeof(AVFrame*);
394 static const AVFilterPad avfilter_vsrc_buffer_outputs[] = {
397 .type = AVMEDIA_TYPE_VIDEO,
398 .request_frame = request_frame,
399 .poll_frame = poll_frame,
400 .config_props = config_props,
405 AVFilter ff_vsrc_buffer = {
407 .description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them accessible to the filterchain."),
408 .priv_size = sizeof(BufferSourceContext),
409 .query_formats = query_formats,
415 .outputs = avfilter_vsrc_buffer_outputs,
416 .priv_class = &buffer_class,
419 static const AVFilterPad avfilter_asrc_abuffer_outputs[] = {
422 .type = AVMEDIA_TYPE_AUDIO,
423 .request_frame = request_frame,
424 .poll_frame = poll_frame,
425 .config_props = config_props,
430 AVFilter ff_asrc_abuffer = {
432 .description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them accessible to the filterchain."),
433 .priv_size = sizeof(BufferSourceContext),
434 .query_formats = query_formats,
440 .outputs = avfilter_asrc_abuffer_outputs,
441 .priv_class = &abuffer_class,