buffer sink More...

#include "libavutil/audio_fifo.h"
#include "libavutil/avassert.h"
#include "libavutil/channel_layout.h"
#include "libavutil/common.h"
#include "libavutil/mathematics.h"
#include "libavutil/opt.h"
#include "audio.h"
#include "avfilter.h"
#include "buffersink.h"
#include "internal.h"

Data Structures
struct	BufferSinkContext

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

#define	FIFO_INIT_SIZE 8

#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_VIDEO_PARAM

Functions
static av_cold void	uninit (AVFilterContext *ctx)

static int	add_buffer_ref (AVFilterContext ctx, AVFrame ref)

static int	filter_frame (AVFilterLink link, AVFrame frame)

int	av_buffersink_get_frame (AVFilterContext ctx, AVFrame frame)
	Get a frame with filtered data from sink and put it in frame.

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.

static int	read_from_fifo (AVFilterContext ctx, AVFrame frame, int nb_samples)

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.

AVBufferSinkParams *	av_buffersink_params_alloc (void)
	Create an AVBufferSinkParams structure.

AVABufferSinkParams *	av_abuffersink_params_alloc (void)
	Create an AVABufferSinkParams structure.

static av_cold int	common_init (AVFilterContext *ctx)

void	av_buffersink_set_frame_size (AVFilterContext *ctx, unsigned frame_size)
	Set the frame size for an audio buffer sink.

AVRational	av_buffersink_get_frame_rate (AVFilterContext *ctx)
	Get the frame rate of the input.

int attribute_align_arg	av_buffersink_poll_frame (AVFilterContext *ctx)

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	avfilter_vsink_buffer

static const AVFilterPad	avfilter_asink_abuffer_inputs []

AVFilter	avfilter_asink_abuffer

Detailed Description

buffer sink

Definition in file buffersink.c.

Macro Definition Documentation

#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 244 of file buffersink.c.

Referenced by common_init().

#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 389 of file buffersink.c.

Referenced by asink_query_formats(), and vsink_query_formats().

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

Definition at line 492 of file buffersink.c.

#define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM

Definition at line 499 of file buffersink.c.

#define FLAGS AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM

Definition at line 499 of file buffersink.c.

Function Documentation

static av_cold void uninit ( AVFilterContext * ctx )

static

Definition at line 65 of file buffersink.c.

static int add_buffer_ref	(	AVFilterContext *	ctx,
		AVFrame *	ref
	)

static

Definition at line 83 of file buffersink.c.

Referenced by filter_frame().

static int filter_frame	(	AVFilterLink *	link,
		AVFrame *	frame
	)

static

Definition at line 102 of file buffersink.c.

int av_buffersink_get_frame	(	AVFilterContext *	ctx,
		AVFrame *	frame
	)

Get a frame with filtered data from sink and put it in frame.

Parameters

ctx	pointer to a context of a buffersink or abuffersink AVFilter.
frame	pointer to an allocated frame that will be filled with data. The data must be freed using av_frame_unref() / av_frame_free()

Returns: >= 0 in case of success, a negative AVERROR code in case of failure.

Examples:: doc/examples/filtering_audio.c, and doc/examples/filtering_video.c.

Definition at line 121 of file buffersink.c.

Referenced by main().

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.

Parameters

ctx	pointer to a buffersink or abuffersink filter context.
frame	pointer to an allocated frame that will be filled with data. The data must be freed using av_frame_unref() / av_frame_free()
flags	a combination of AV_BUFFERSINK_FLAG_* flags

Returns: >= 0 in for success, a negative AVERROR code for failure.

Definition at line 126 of file buffersink.c.

Referenced by audio_decode_frame(), av_buffersink_get_frame(), av_buffersink_get_samples(), lavfi_read_packet(), reap_filters(), and video_thread().

static int read_from_fifo	(	AVFilterContext *	ctx,
		AVFrame *	frame,
		int	nb_samples
	)

static

Definition at line 157 of file buffersink.c.

Referenced by av_buffersink_get_samples().

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.

This function is less efficient than av_buffersink_get_frame(), because it copies the data around.

Parameters

ctx	pointer to a context of the abuffersink AVFilter.
frame	pointer to an allocated frame that will be filled with data. The data must be freed using av_frame_unref() / av_frame_free() frame will contain exactly nb_samples audio samples, except at the end of stream, when it can contain less than nb_samples.

Warning: do not mix this function with av_buffersink_get_frame(). Use only one or the other with a single sink, not both.

Definition at line 179 of file buffersink.c.

AVBufferSinkParams* av_buffersink_params_alloc ( void )

Create an AVBufferSinkParams structure.

Must be freed with av_free().

Examples:: doc/examples/filtering_video.c.

Definition at line 224 of file buffersink.c.

Referenced by init_filters().

AVABufferSinkParams* av_abuffersink_params_alloc ( void )

Create an AVABufferSinkParams structure.

Must be freed with av_free().

Definition at line 235 of file buffersink.c.

static av_cold int common_init ( AVFilterContext * ctx )

static

Definition at line 246 of file buffersink.c.

Referenced by asink_init(), and vsink_init().

void av_buffersink_set_frame_size	(	AVFilterContext *	ctx,
		unsigned	frame_size
	)

Set the frame size for an audio buffer sink.

All calls to av_buffersink_get_buffer_ref will return a buffer with exactly the specified number of samples, or AVERROR(EAGAIN) if there is not enough. The last buffer at EOF will be padded with 0.

Definition at line 259 of file buffersink.c.

Referenced by decode_audio().

AVRational av_buffersink_get_frame_rate ( AVFilterContext * ctx )

Get the frame rate of the input.

Definition at line 354 of file buffersink.c.

Referenced by transcode_init().

int attribute_align_arg av_buffersink_poll_frame ( AVFilterContext * ctx )

Definition at line 362 of file buffersink.c.

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

static

Definition at line 375 of file buffersink.c.

static int vsink_query_formats ( AVFilterContext * ctx )

static

Definition at line 396 of file buffersink.c.

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

static

Definition at line 418 of file buffersink.c.

static int asink_query_formats ( AVFilterContext * ctx )

static

Definition at line 435 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 },
}

Definition at line 494 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_INT, {.i64 = 0}, 0, 1, FLAGS },
    { NULL },
}

Definition at line 500 of file buffersink.c.

const AVFilterPad avfilter_vsink_buffer_inputs[]

static

Initial value:

= {
    {
        .name        = "default",
        .type        = AVMEDIA_TYPE_VIDEO,
        .filter_frame = filter_frame,
    },
    { NULL }
}

Definition at line 564 of file buffersink.c.

AVFilter avfilter_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,
    .uninit    = uninit,
    .query_formats = vsink_query_formats,
    .inputs    = avfilter_vsink_buffer_inputs,
    .outputs   = NULL,
}

Definition at line 573 of file buffersink.c.

const AVFilterPad avfilter_asink_abuffer_inputs[]

static

Initial value:

= {
    {
        .name           = "default",
        .type           = AVMEDIA_TYPE_AUDIO,
        .filter_frame   = filter_frame,
    },
    { NULL }
}

Definition at line 586 of file buffersink.c.

AVFilter avfilter_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,
    .uninit    = uninit,
    .query_formats = asink_query_formats,
    .inputs    = avfilter_asink_abuffer_inputs,
    .outputs   = NULL,
}

Definition at line 595 of file buffersink.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

Function Documentation

Variable Documentation