FFmpeg
Data Structures | Macros | Functions | Variables
buffersink.c File Reference

buffer sink More...

#include "libavutil/avassert.h"
#include "libavutil/channel_layout.h"
#include "libavutil/common.h"
#include "libavutil/internal.h"
#include "libavutil/opt.h"
#include "framequeue.h"
#include "audio.h"
#include "avfilter.h"
#include "buffersink.h"
#include "filters.h"
#include "internal.h"

Go to the source code of this file.

Data Structures

struct  BufferSinkContext
 

Macros

#define FF_INTERNAL_FIELDS   1
 
#define NB_ITEMS(list)   (list ## _size / sizeof(*list))
 
#define FIFO_INIT_SIZE   8
 
#define FIFO_INIT_ELEMENT_SIZE   sizeof(void *)
 
#define MAKE_AVFILTERLINK_ACCESSOR(type, field)
 
#define CHECK_LIST_SIZE(field)
 
#define OFFSET(x)   offsetof(BufferSinkContext, x)
 
#define FLAGS   AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM
 
#define FLAGS   AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM
 

Functions

int attribute_align_arg av_buffersink_get_frame (AVFilterContext *ctx, AVFrame *frame)
 Get a frame with filtered data from sink and put it in frame. More...
 
static int return_or_keep_frame (BufferSinkContext *buf, AVFrame *out, AVFrame *in, int flags)
 
static int get_frame_internal (AVFilterContext *ctx, AVFrame *frame, int flags, int samples)
 
int attribute_align_arg av_buffersink_get_frame_flags (AVFilterContext *ctx, AVFrame *frame, int flags)
 Get a frame with filtered data from sink and put it in frame. More...
 
int attribute_align_arg av_buffersink_get_samples (AVFilterContext *ctx, AVFrame *frame, int nb_samples)
 Same as av_buffersink_get_frame(), but with the ability to specify the number of samples read. More...
 
AVBufferSinkParamsav_buffersink_params_alloc (void)
 Create an AVBufferSinkParams structure. More...
 
AVABufferSinkParamsav_abuffersink_params_alloc (void)
 Create an AVABufferSinkParams structure. More...
 
static av_cold int common_init (AVFilterContext *ctx)
 
static int activate (AVFilterContext *ctx)
 
void av_buffersink_set_frame_size (AVFilterContext *ctx, unsigned frame_size)
 Set the frame size for an audio buffer sink. More...
 
static av_cold int vsink_init (AVFilterContext *ctx, void *opaque)
 
static int vsink_query_formats (AVFilterContext *ctx)
 
static av_cold int asink_init (AVFilterContext *ctx, void *opaque)
 
static int asink_query_formats (AVFilterContext *ctx)
 
 AVFILTER_DEFINE_CLASS (buffersink)
 
 AVFILTER_DEFINE_CLASS (abuffersink)
 

Variables

static const AVOption buffersink_options []
 
static const AVOption abuffersink_options []
 
static const AVFilterPad avfilter_vsink_buffer_inputs []
 
AVFilter ff_vsink_buffer
 
static const AVFilterPad avfilter_asink_abuffer_inputs []
 
AVFilter ff_asink_abuffer
 

Detailed Description

buffer sink

Definition in file buffersink.c.

Macro Definition Documentation

#define FF_INTERNAL_FIELDS   1

Definition at line 32 of file buffersink.c.

#define NB_ITEMS (   list)    (list ## _size / sizeof(*list))

Definition at line 63 of file buffersink.c.

Referenced by asink_query_formats(), and vsink_query_formats().

#define FIFO_INIT_SIZE   8

Definition at line 64 of file buffersink.c.

#define FIFO_INIT_ELEMENT_SIZE   sizeof(void *)

Definition at line 65 of file buffersink.c.

#define MAKE_AVFILTERLINK_ACCESSOR (   type,
  field 
)
Value:
type av_buffersink_get_##field(const AVFilterContext *ctx) { \
return ctx->inputs[0]->field; \
}
GLint GLenum type
Definition: opengl_enc.c:104
int(* activate)(AVFilterContext *ctx)
Filter activation function.
Definition: avfilter.h:327
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:346
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this field
static int activate(AVFilterContext *ctx)
Definition: buffersink.c:158
AVFormatContext * ctx
Definition: movenc.c:48
An instance of a filter.
Definition: avfilter.h:338
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a it should return
const AVFilter * filter
the AVFilter of which this is an instance
Definition: avfilter.h:341

Definition at line 183 of file buffersink.c.

#define CHECK_LIST_SIZE (   field)
Value:
if (buf->field ## _size % sizeof(*buf->field)) { \
av_log(ctx, AV_LOG_ERROR, "Invalid size for " #field ": %d, " \
"should be multiple of %d\n", \
buf->field ## _size, (int)sizeof(*buf->field)); \
return AVERROR(EINVAL); \
}
#define av_log(a,...)
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this field
AVFormatContext * ctx
Definition: movenc.c:48
void * buf
Definition: avisynth_c.h:766
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a it should return
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later.That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another.Frame references ownership and permissions

Definition at line 218 of file buffersink.c.

Referenced by asink_query_formats(), and vsink_query_formats().

#define OFFSET (   x)    offsetof(BufferSinkContext, x)

Definition at line 316 of file buffersink.c.

Definition at line 323 of file buffersink.c.

Definition at line 323 of file buffersink.c.

Function Documentation

static int return_or_keep_frame ( BufferSinkContext buf,
AVFrame out,
AVFrame in,
int  flags 
)
static

Definition at line 72 of file buffersink.c.

Referenced by get_frame_internal().

static int get_frame_internal ( AVFilterContext ctx,
AVFrame frame,
int  flags,
int  samples 
)
static

Definition at line 86 of file buffersink.c.

Referenced by av_buffersink_get_frame_flags(), and av_buffersink_get_samples().

static av_cold int common_init ( AVFilterContext ctx)
static

Definition at line 150 of file buffersink.c.

Referenced by asink_init(), and vsink_init().

static int activate ( AVFilterContext ctx)
static

Definition at line 158 of file buffersink.c.

static av_cold int vsink_init ( AVFilterContext ctx,
void opaque 
)
static

Definition at line 204 of file buffersink.c.

static int vsink_query_formats ( AVFilterContext ctx)
static

Definition at line 225 of file buffersink.c.

static av_cold int asink_init ( AVFilterContext ctx,
void opaque 
)
static

Definition at line 247 of file buffersink.c.

static int asink_query_formats ( AVFilterContext ctx)
static

Definition at line 264 of file buffersink.c.

AVFILTER_DEFINE_CLASS ( buffersink  )
AVFILTER_DEFINE_CLASS ( abuffersink  )

Variable Documentation

const AVOption buffersink_options[]
static
Initial value:
= {
{ "pix_fmts", "set the supported pixel formats", OFFSET(pixel_fmts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
{ NULL },
}
#define NULL
Definition: coverity.c:32
#define FLAGS
Definition: buffersink.c:323
offset must point to a pointer immediately followed by an int for the length
Definition: opt.h:229
#define OFFSET(x)
Definition: buffersink.c:316

Definition at line 318 of file buffersink.c.

const AVOption abuffersink_options[]
static
Initial value:
= {
{ "sample_fmts", "set the supported sample formats", OFFSET(sample_fmts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
{ "sample_rates", "set the supported sample rates", OFFSET(sample_rates), AV_OPT_TYPE_BINARY, .flags = FLAGS },
{ "channel_layouts", "set the supported channel layouts", OFFSET(channel_layouts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
{ "channel_counts", "set the supported channel counts", OFFSET(channel_counts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
{ "all_channel_counts", "accept all channel counts", OFFSET(all_channel_counts), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, FLAGS },
{ NULL },
}
#define NULL
Definition: coverity.c:32
#define FLAGS
Definition: buffersink.c:323
static const uint8_t channel_counts[7]
Definition: dca_lbr.c:109
offset must point to a pointer immediately followed by an int for the length
Definition: opt.h:229
#define OFFSET(x)
Definition: buffersink.c:316
static const uint16_t channel_layouts[7]
Definition: dca_lbr.c:113
sample_rates
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:701

Definition at line 324 of file buffersink.c.

const AVFilterPad avfilter_vsink_buffer_inputs[]
static
Initial value:
= {
{
.name = "default",
},
{ NULL }
}
#define NULL
Definition: coverity.c:32

Definition at line 337 of file buffersink.c.

AVFilter ff_vsink_buffer
Initial value:
= {
.name = "buffersink",
.description = NULL_IF_CONFIG_SMALL("Buffer video frames, and make them available to the end of the filter graph."),
.priv_size = sizeof(BufferSinkContext),
.priv_class = &buffersink_class,
.init_opaque = vsink_init,
}
#define NULL
Definition: coverity.c:32
static av_cold int vsink_init(AVFilterContext *ctx, void *opaque)
Definition: buffersink.c:204
static int vsink_query_formats(AVFilterContext *ctx)
Definition: buffersink.c:225
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
static int activate(AVFilterContext *ctx)
Definition: buffersink.c:158
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
static int query_formats(AVFilterContext *ctx)
Definition: aeval.c:244
static const AVFilterPad avfilter_vsink_buffer_inputs[]
Definition: buffersink.c:337

Definition at line 345 of file buffersink.c.

const AVFilterPad avfilter_asink_abuffer_inputs[]
static
Initial value:
= {
{
.name = "default",
},
{ NULL }
}
#define NULL
Definition: coverity.c:32

Definition at line 358 of file buffersink.c.

AVFilter ff_asink_abuffer
Initial value:
= {
.name = "abuffersink",
.description = NULL_IF_CONFIG_SMALL("Buffer audio frames, and make them available to the end of the filter graph."),
.priv_class = &abuffersink_class,
.priv_size = sizeof(BufferSinkContext),
.init_opaque = asink_init,
}
#define NULL
Definition: coverity.c:32
static av_cold int asink_init(AVFilterContext *ctx, void *opaque)
Definition: buffersink.c:247
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
static int activate(AVFilterContext *ctx)
Definition: buffersink.c:158
static const AVFilterPad avfilter_asink_abuffer_inputs[]
Definition: buffersink.c:358
static const AVFilterPad outputs[]
Definition: af_acontrast.c:203
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several inputs
static int query_formats(AVFilterContext *ctx)
Definition: aeval.c:244
static int asink_query_formats(AVFilterContext *ctx)
Definition: buffersink.c:264

Definition at line 366 of file buffersink.c.