FFmpeg
Data Structures | Macros | Functions | Variables
buffersink.c File Reference
#include "libavutil/avassert.h"
#include "libavutil/avstring.h"
#include "libavutil/channel_layout.h"
#include "libavutil/common.h"
#include "libavutil/internal.h"
#include "libavutil/opt.h"
#include "audio.h"
#include "avfilter.h"
#include "avfilter_internal.h"
#include "buffersink.h"
#include "filters.h"
#include "formats.h"
#include "framequeue.h"
#include "video.h"

Go to the source code of this file.

Data Structures

struct  BufferSinkContext
 

Macros

#define NB_ITEMS(list)   (list ## _size / sizeof(*list))
 
#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...
 
static av_cold int common_init (AVFilterContext *ctx)
 
static void uninit (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...
 
AVRational av_buffersink_get_frame_rate (const AVFilterContext *ctx)
 
AVBufferRef * av_buffersink_get_hw_frames_ctx (const AVFilterContext *ctx)
 
int av_buffersink_get_channels (const AVFilterContext *ctx)
 
int av_buffersink_get_ch_layout (const AVFilterContext *ctx, AVChannelLayout *out)
 
static int vsink_query_formats (AVFilterContext *ctx)
 
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 []
 
const AVFilter ff_vsink_buffer
 
const AVFilter ff_asink_abuffer
 

Detailed Description

buffer sink

Definition in file buffersink.c.

Macro Definition Documentation

◆ NB_ITEMS

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

Definition at line 65 of file buffersink.c.

◆ MAKE_AVFILTERLINK_ACCESSOR

#define MAKE_AVFILTERLINK_ACCESSOR (   type,
  field 
)
Value:
type av_buffersink_get_##field(const AVFilterContext *ctx) { \
av_assert0(ctx->filter->activate == activate); \
return ctx->inputs[0]->field; \
}

Definition at line 172 of file buffersink.c.

◆ CHECK_LIST_SIZE

#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); \
}

Definition at line 223 of file buffersink.c.

◆ OFFSET

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

Definition at line 335 of file buffersink.c.

◆ FLAGS [1/2]

#define FLAGS   AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM

Definition at line 344 of file buffersink.c.

◆ FLAGS [2/2]

#define FLAGS   AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_AUDIO_PARAM

Definition at line 344 of file buffersink.c.

Function Documentation

◆ return_or_keep_frame()

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().

◆ 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().

◆ common_init()

static av_cold int common_init ( AVFilterContext *  ctx)
static

Definition at line 132 of file buffersink.c.

◆ uninit()

static void uninit ( AVFilterContext *  ctx)
static

Definition at line 140 of file buffersink.c.

◆ activate()

static int activate ( AVFilterContext *  ctx)
static

Definition at line 147 of file buffersink.c.

Referenced by av_buffersink_get_ch_layout(), av_buffersink_get_channels(), av_buffersink_get_frame_rate(), and av_buffersink_get_hw_frames_ctx().

◆ vsink_query_formats()

static int vsink_query_formats ( AVFilterContext *  ctx)
static

Definition at line 230 of file buffersink.c.

◆ asink_query_formats()

static int asink_query_formats ( AVFilterContext *  ctx)
static

Definition at line 269 of file buffersink.c.

◆ AVFILTER_DEFINE_CLASS() [1/2]

AVFILTER_DEFINE_CLASS ( buffersink  )

◆ AVFILTER_DEFINE_CLASS() [2/2]

AVFILTER_DEFINE_CLASS ( abuffersink  )

Variable Documentation

◆ buffersink_options

const AVOption buffersink_options[]
static
Initial value:
= {
{ "pix_fmts", "set the supported pixel formats", OFFSET(pixel_fmts), AV_OPT_TYPE_BINARY, .flags = FLAGS },
{ "color_spaces", "set the supported color spaces", OFFSET(color_spaces), AV_OPT_TYPE_BINARY, .flags = FLAGS },
{ "color_ranges", "set the supported color ranges", OFFSET(color_ranges), AV_OPT_TYPE_BINARY, .flags = FLAGS },
{ NULL },
}

Definition at line 337 of file buffersink.c.

◆ abuffersink_options

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 },
{ "ch_layouts", "set a '|'-separated list of supported channel layouts",
OFFSET(channel_layouts_str), AV_OPT_TYPE_STRING, .flags = FLAGS },
{ "all_channel_counts", "accept all channel counts", OFFSET(all_channel_counts), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, FLAGS },
{ NULL },
}

Definition at line 345 of file buffersink.c.

◆ ff_vsink_buffer

const 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 = common_init,
.uninit = uninit,
.activate = activate,
FILTER_INPUTS(ff_video_default_filterpad),
.outputs = NULL,
FILTER_QUERY_FUNC(vsink_query_formats),
}

Definition at line 358 of file buffersink.c.

◆ ff_asink_abuffer

const 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 = common_init,
.uninit = uninit,
.activate = activate,
FILTER_INPUTS(ff_audio_default_filterpad),
.outputs = NULL,
FILTER_QUERY_FUNC(asink_query_formats),
}

Definition at line 371 of file buffersink.c.

AVERROR
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
sample_fmts
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:948
uninit
static void uninit(AVFilterContext *ctx)
Definition: buffersink.c:140
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: filters.h:262
sample_rates
static const int sample_rates[]
Definition: dcaenc.h:34
pixel_fmts
static enum AVPixelFormat pixel_fmts[]
Definition: vf_amplify.c:52
AV_OPT_TYPE_BINARY
@ AV_OPT_TYPE_BINARY
Underlying C type is a uint8_t* that is either NULL or points to an array allocated with the av_mallo...
Definition: opt.h:286
type
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 just let it vf type
Definition: writing_filters.txt:86
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
ff_video_default_filterpad
const AVFilterPad ff_video_default_filterpad[1]
An AVFilterPad array whose only entry has name "default" and is of type AVMEDIA_TYPE_VIDEO.
Definition: video.c:37
ctx
AVFormatContext * ctx
Definition: movenc.c:49
field
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
Definition: writing_filters.txt:78
FLAGS
#define FLAGS
Definition: buffersink.c:344
activate
static int activate(AVFilterContext *ctx)
Definition: buffersink.c:147
NULL
#define NULL
Definition: coverity.c:32
vsink_query_formats
static int vsink_query_formats(AVFilterContext *ctx)
Definition: buffersink.c:230
ff_audio_default_filterpad
const AVFilterPad ff_audio_default_filterpad[1]
An AVFilterPad array whose only entry has name "default" and is of type AVMEDIA_TYPE_AUDIO.
Definition: audio.c:34
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:368
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
common_init
static av_cold int common_init(AVFilterContext *ctx)
Definition: buffersink.c:132
BufferSinkContext
Definition: buffersink.c:42
OFFSET
#define OFFSET(x)
Definition: buffersink.c:335
AVFilterContext
An instance of a filter.
Definition: avfilter.h:457
asink_query_formats
static int asink_query_formats(AVFilterContext *ctx)
Definition: buffersink.c:269
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Underlying C type is int.
Definition: opt.h:327
AV_OPT_TYPE_STRING
@ AV_OPT_TYPE_STRING
Underlying C type is a uint8_t* that is either NULL or points to a C string allocated with the av_mal...
Definition: opt.h:276
FILTER_QUERY_FUNC
#define FILTER_QUERY_FUNC(func)
Definition: filters.h:236
Generated on Fri Aug 22 2025 14:00:04 for FFmpeg by   doxygen 1.8.17