Bytestream IO Context. More...

#include <avio.h>

Public Attributes
const AVClass *	av_class
	A class for private options. More...

unsigned char *	buffer
	Start of the buffer. More...

int	buffer_size
	Maximum buffer size.

unsigned char *	buf_ptr
	Current position in the buffer.

unsigned char *	buf_end
	End of the data, may be less than buffer+buffer_size if the read function returned less data than requested, e.g. More...

void *	opaque
	A private pointer, passed to the read/write/seek/... More...

int(*	read_packet )(void opaque, uint8_t buf, int buf_size)

int(*	write_packet )(void opaque, uint8_t buf, int buf_size)

int64_t(*	seek )(void *opaque, int64_t offset, int whence)

int64_t	pos
	position in the file of the current buffer

int	eof_reached
	true if eof reached

int	write_flag
	true if open for writing

int	max_packet_size

unsigned long	checksum

unsigned char *	checksum_ptr

unsigned long(*	update_checksum )(unsigned long checksum, const uint8_t *buf, unsigned int size)

int	error
	contains the error code or 0 if no error happened

int(*	read_pause )(void *opaque, int pause)
	Pause or resume playback for network streaming protocols - e.g. More...

int64_t(*	read_seek )(void *opaque, int stream_index, int64_t timestamp, int flags)
	Seek to a given timestamp in stream with the specified stream_index. More...

int	seekable
	A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.

int64_t	maxsize
	max filesize, used to limit allocations This field is internal to libavformat and access from outside is not allowed.

int	direct
	avio_read and avio_write should if possible be satisfied directly instead of going through a buffer, and avio_seek will always call the underlying seek function directly.

int64_t	bytes_read
	Bytes read statistic This field is internal to libavformat and access from outside is not allowed.

int	seek_count
	seek statistic This field is internal to libavformat and access from outside is not allowed.

int	writeout_count
	writeout statistic This field is internal to libavformat and access from outside is not allowed.

int	orig_buffer_size
	Original buffer size used internally after probing and ensure seekback to reset the buffer size This field is internal to libavformat and access from outside is not allowed.

int	short_seek_threshold
	Threshold to favor readahead over seek. More...

const char *	protocol_whitelist
	',' separated list of allowed protocols.

const char *	protocol_blacklist
	',' separated list of disallowed protocols.

int(*	write_data_type )(void opaque, uint8_t buf, int buf_size, enum AVIODataMarkerType type, int64_t time)
	A callback that is used instead of write_packet.

int	ignore_boundary_point
	If set, don't call write_data_type separately for AVIO_DATA_MARKER_BOUNDARY_POINT, but ignore them and treat them as AVIO_DATA_MARKER_UNKNOWN (to avoid needlessly small chunks of data returned from the callback).

enum AVIODataMarkerType	current_type
	Internal, not meant to be used from outside of AVIOContext.

int64_t	last_time

int(*	short_seek_get )(void *opaque)
	A callback that is used instead of short_seek_threshold. More...

int64_t	written

unsigned char *	buf_ptr_max
	Maximum reached position before a backward seek in the write buffer, used keeping track of already written data for a later flush.

int	min_packet_size
	Try to buffer at least this amount of data before flushing it.

Detailed Description

Bytestream IO Context.

New fields can be added to the end with minor version bumps. Removal, reordering and changes to existing fields require a major version bump. sizeof(AVIOContext) must not be used outside libav*.

Note: None of the function pointers in AVIOContext should be called directly, they should only be set by the client application when implementing custom I/O. Normally these are set to the function pointers specified in avio_alloc_context()

Member Data Documentation

§ av_class

const AVClass* AVIOContext::av_class

A class for private options.

If this AVIOContext is created by avio_open2(), av_class is set and passes the options down to protocols.

If this AVIOContext is manually allocated, then av_class may be set by the caller.

warning – this field can be NULL, be sure to not pass this AVIOContext to any av_opt_* functions in that case.

§ buf_end

unsigned char* AVIOContext::buf_end

End of the data, may be less than buffer+buffer_size if the read function returned less data than requested, e.g.

for streams where no more data has been received yet.

§ buffer

unsigned char* AVIOContext::buffer

Start of the buffer.

§ opaque

void* AVIOContext::opaque

A private pointer, passed to the read/write/seek/...

functions.

§ read_pause

int(* AVIOContext::read_pause) (void *opaque, int pause)

Pause or resume playback for network streaming protocols - e.g.

MMS.

§ read_seek

int64_t(* AVIOContext::read_seek) (void *opaque, int stream_index, int64_t timestamp, int flags)

Seek to a given timestamp in stream with the specified stream_index.

Needed for some network streaming protocols which don't support seeking to byte position.

§ short_seek_get

int(* AVIOContext::short_seek_get) (void *opaque)

A callback that is used instead of short_seek_threshold.

This is current internal only, do not use from outside.

§ short_seek_threshold

int AVIOContext::short_seek_threshold

Threshold to favor readahead over seek.