libavfilter/buffersink.h File Reference

memory buffer sink API for audio and video More...

#include "avfilter.h"

Go to the source code of this file.

Data Structures
struct	AVBufferSinkParams
	Struct to use for initializing a buffersink context. More...
struct	AVABufferSinkParams
	Struct to use for initializing an abuffersink context. More...
Defines
#define	AV_BUFFERSINK_FLAG_PEEK   1
	Tell av_buffersink_get_buffer_ref() to read video/samples buffer reference, but not remove it from the buffer.
#define	AV_BUFFERSINK_FLAG_NO_REQUEST   2
	Tell av_buffersink_get_buffer_ref() not to request a frame from its input.
Functions
AVBufferSinkParams *	av_buffersink_params_alloc (void)
	Create an AVBufferSinkParams structure.
AVABufferSinkParams *	av_abuffersink_params_alloc (void)
	Create an AVABufferSinkParams structure.
int	av_buffersink_get_buffer_ref (AVFilterContext *buffer_sink, AVFilterBufferRef **bufref, int flags)
	Get an audio/video buffer data from buffer_sink and put it in bufref.
int	av_buffersink_poll_frame (AVFilterContext *ctx)
	Get the number of immediately available frames.
attribute_deprecated int	av_vsink_buffer_get_video_buffer_ref (AVFilterContext *buffer_sink, AVFilterBufferRef **picref, int flags)
int	av_buffersink_read (AVFilterContext *sink, AVFilterBufferRef **buf)
	Get a buffer with filtered data from sink and put it in buf.
int	av_buffersink_read_samples (AVFilterContext *ctx, AVFilterBufferRef **buf, int nb_samples)
	Same as av_buffersink_read, but with the ability to specify the number of samples read.

---

Detailed Description

memory buffer sink API for audio and video

Definition in file buffersink.h.

---

Define Documentation

#define AV_BUFFERSINK_FLAG_NO_REQUEST   2

Tell av_buffersink_get_buffer_ref() not to request a frame from its input.

If a frame is already buffered, it is read (and removed from the buffer), but if no frame is present, return AVERROR(EAGAIN).

Definition at line 73 of file buffersink.h.

Referenced by av_buffersink_get_buffer_ref(), and poll_filters().

#define AV_BUFFERSINK_FLAG_PEEK   1

Tell av_buffersink_get_buffer_ref() to read video/samples buffer reference, but not remove it from the buffer.

This is useful if you need only to read a video/samples buffer, without to fetch it.

Definition at line 66 of file buffersink.h.

Referenced by av_buffersink_get_buffer_ref(), and lavfi_read_packet().

---

Function Documentation

AVABufferSinkParams* av_abuffersink_params_alloc

(

void

)

Create an AVABufferSinkParams structure.

Must be freed with av_free().

Definition at line 42 of file sink_buffer.c.

Referenced by init_filters(), and lavfi_read_header().

int av_buffersink_get_buffer_ref	(	AVFilterContext *	buffer_sink,
		AVFilterBufferRef **	bufref,
		int	flags
	)

Get an audio/video buffer data from buffer_sink and put it in bufref.

This function works with both audio and video buffer sinks.

Parameters:

	buffer_sink	pointer to a buffersink or abuffersink context
	flags	a combination of AV_BUFFERSINK_FLAG_* flags

Returns:

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

Definition at line 116 of file sink_buffer.c.

Referenced by av_vsink_buffer_get_video_buffer_ref(), lavfi_read_packet(), main(), poll_filters(), and video_thread().

AVBufferSinkParams* av_buffersink_params_alloc

(

void

)

Create an AVBufferSinkParams structure.

Must be freed with av_free().

Definition at line 31 of file sink_buffer.c.

Referenced by configure_output_video_filter(), configure_video_filters(), and lavfi_read_header().

int av_buffersink_poll_frame

(

AVFilterContext *

ctx

)

Get the number of immediately available frames.

Definition at line 143 of file sink_buffer.c.

int av_buffersink_read	(	AVFilterContext *	sink,
		AVFilterBufferRef **	buf
	)

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

Parameters:

	sink	pointer to a context of a buffersink or abuffersink AVFilter.
	buf	pointer to the buffer will be written here if buf is non-NULL. buf must be freed by the caller using avfilter_unref_buffer(). Buf may also be NULL to query whether a buffer is ready to be output.

Returns:

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

Definition at line 95 of file buffersink.c.

Referenced by av_buffersink_read_samples(), and poll_filters().

int av_buffersink_read_samples	(	AVFilterContext *	ctx,
		AVFilterBufferRef **	buf,
		int	nb_samples
	)

Same as av_buffersink_read, but with the ability to specify the number of samples read.

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

Parameters:

	sink	pointer to a context of the abuffersink AVFilter.
	buf	pointer to the buffer will be written here if buf is non-NULL. buf must be freed by the caller using avfilter_unref_buffer(). buf will contain exactly nb_samples audio samples, except at the end of stream, when it can contain less than nb_samples. Buf may also be NULL to query whether a buffer is ready to be output.

Warning:

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

Definition at line 140 of file buffersink.c.

Referenced by poll_filters().

attribute_deprecated int av_vsink_buffer_get_video_buffer_ref	(	AVFilterContext *	buffer_sink,
		AVFilterBufferRef **	picref,
		int	flags
	)

Deprecated:

Use av_buffersink_get_buffer_ref() instead.

Definition at line 152 of file sink_buffer.c.