libavutil/fifo.h File Reference

A very simple circular buffer FIFO implementation. More...

#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	AVFifoBuffer
Functions
int	av_fifo_init (AVFifoBuffer *f, int size)
	Initializes an AVFifoBuffer.
void	av_fifo_free (AVFifoBuffer *f)
	Frees an AVFifoBuffer.
int	av_fifo_size (AVFifoBuffer *f)
	Returns the amount of data in bytes in the AVFifoBuffer, that is the amount of data you can read from it.
int	av_fifo_read (AVFifoBuffer *f, uint8_t *buf, int buf_size)
	Reads data from an AVFifoBuffer.
int	av_fifo_generic_read (AVFifoBuffer *f, int buf_size, void(*func)(void *, void *, int), void *dest)
	Feeds data from an AVFifoBuffer to a user supplied callback.
void	av_fifo_write (AVFifoBuffer *f, const uint8_t *buf, int size)
	Writes data into an AVFifoBuffer.
void	av_fifo_realloc (AVFifoBuffer *f, unsigned int size)
	Resizes an AVFifoBuffer.
void	av_fifo_drain (AVFifoBuffer *f, int size)
	Reads and discards the specified amount of data from an AVFifoBuffer.
static uint8_t	av_fifo_peek (AVFifoBuffer *f, int offs)

---

Detailed Description

A very simple circular buffer FIFO implementation.

Definition in file fifo.h.

---

Function Documentation

void av_fifo_drain	(	AVFifoBuffer *	f,
		int	size
	)

Reads and discards the specified amount of data from an AVFifoBuffer.

Parameters:

	*f	AVFifoBuffer to read from
	size	amount of data to read in bytes

Definition at line 109 of file fifo.c.

Referenced by av_fifo_generic_read(), and dv_assemble_frame().

void av_fifo_free

(

AVFifoBuffer *

f

)

Frees an AVFifoBuffer.

Parameters:

*f

AVFifoBuffer to free

Definition at line 35 of file fifo.c.

Referenced by av_encode(), dv_delete_mux(), dv_init_mux(), gxf_write_trailer(), and mpeg_mux_end().

int av_fifo_generic_read	(	AVFifoBuffer *	f,
		int	buf_size,
		void(*)(void *, void *, int)	func,
		void *	dest
	)

Feeds data from an AVFifoBuffer to a user supplied callback.

Parameters:

	*f	AVFifoBuffer to read from
	buf_size	number of bytes to read
	*func	generic read function
	*dest	data destination

Definition at line 89 of file fifo.c.

Referenced by av_fifo_read(), and flush_packet().

int av_fifo_init	(	AVFifoBuffer *	f,
		int	size
	)

Initializes an AVFifoBuffer.

Parameters:

	*f	AVFifoBuffer to initialize
	size	of FIFO

Returns:

<0 for failure >=0 otherwise

Definition at line 25 of file fifo.c.

Referenced by av_encode(), av_fifo_realloc(), dv_init_mux(), gxf_write_header(), and mpeg_mux_init().

static uint8_t av_fifo_peek	(	AVFifoBuffer *	f,
		int	offs
	)			[inline, static]

Definition at line 95 of file fifo.h.

Referenced by dv_inject_audio().

int av_fifo_read	(	AVFifoBuffer *	f,
		uint8_t *	buf,
		int	buf_size
	)

Reads data from an AVFifoBuffer.

Parameters:

	*f	AVFifoBuffer to read from
	*buf	data destination
	buf_size	number of bytes to read

Definition at line 51 of file fifo.c.

Referenced by av_fifo_realloc(), do_audio_out(), gxf_new_audio_packet(), and output_packet().

void av_fifo_realloc	(	AVFifoBuffer *	f,
		unsigned int	new_size
	)

Resizes an AVFifoBuffer.

Parameters:

	*f	AVFifoBuffer to resize
	size	new AVFifoBuffer size in bytes

Definition at line 59 of file fifo.c.

Referenced by mpeg_mux_write_packet().

int av_fifo_size

(

AVFifoBuffer *

f

)

Returns the amount of data in bytes in the AVFifoBuffer, that is the amount of data you can read from it.

Parameters:

*f

AVFifoBuffer to read from

Returns:

size

Definition at line 40 of file fifo.c.

Referenced by av_fifo_generic_read(), av_fifo_realloc(), do_audio_out(), dv_assemble_frame(), flush_packet(), gxf_interleave_packet(), gxf_new_audio_packet(), mpeg_mux_end(), mpeg_mux_write_packet(), and output_packet().

void av_fifo_write	(	AVFifoBuffer *	f,
		const uint8_t *	buf,
		int	size
	)

Writes data into an AVFifoBuffer.

Parameters:

	*f	AVFifoBuffer to write to
	*buf	data source
	size	data size

Definition at line 74 of file fifo.c.

Referenced by do_audio_out(), dv_assemble_frame(), gxf_interleave_packet(), and mpeg_mux_write_packet().