FFmpeg
Data Fields
AVIOContext Struct Reference

Bytestream IO Context. More...

#include <avio.h>

Data Fields

const AVClassav_class
 A class for private options. More...
 
unsigned char * buffer
 Start of the buffer. More...
 
int buffer_size
 Maximum buffer size. More...
 
unsigned char * buf_ptr
 Current position in the buffer. More...
 
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 More...
 
int eof_reached
 true if was unable to read due to error or eof More...
 
int write_flag
 true if open for writing More...
 
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 More...
 
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. More...
 
int64_t maxsize
 max filesize, used to limit allocations This field is internal to libavformat and access from outside is not allowed. More...
 
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. More...
 
int64_t bytes_read
 Bytes read statistic This field is internal to libavformat and access from outside is not allowed. More...
 
int seek_count
 seek statistic This field is internal to libavformat and access from outside is not allowed. More...
 
int writeout_count
 writeout statistic This field is internal to libavformat and access from outside is not allowed. More...
 
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. More...
 
int short_seek_threshold
 Threshold to favor readahead over seek. More...
 
const char * protocol_whitelist
 ',' separated list of allowed protocols. More...
 
const char * protocol_blacklist
 ',' separated list of disallowed protocols. More...
 
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. More...
 
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). More...
 
enum AVIODataMarkerType current_type
 Internal, not meant to be used from outside of AVIOContext. More...
 
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. More...
 
int min_packet_size
 Try to buffer at least this amount of data before flushing it. More...
 

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()
Examples
avio_reading.c, http_multiclient.c, qsvdec.c, and transcode_aac.c.

Definition at line 161 of file avio.h.

Field 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.

Definition at line 174 of file avio.h.

Referenced by av_probe_input_buffer2().

◆ buffer

unsigned char* AVIOContext::buffer

◆ buffer_size

int AVIOContext::buffer_size

Maximum buffer size.

Definition at line 227 of file avio.h.

◆ buf_ptr

unsigned char* AVIOContext::buf_ptr

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

Definition at line 229 of file avio.h.

Referenced by hls_read_seek(), init_packetizer(), and read_gab2_sub().

◆ opaque

void* AVIOContext::opaque

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

functions.

Definition at line 233 of file avio.h.

Referenced by wtvfile_close().

◆ read_packet

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

Definition at line 235 of file avio.h.

◆ write_packet

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

Definition at line 236 of file avio.h.

Referenced by ffio_open_null_buf().

◆ seek

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

Definition at line 237 of file avio.h.

◆ pos

int64_t AVIOContext::pos

position in the file of the current buffer

Definition at line 238 of file avio.h.

Referenced by asfrtp_parse_packet(), hls_read_seek(), init_packetizer(), and read_header().

◆ eof_reached

int AVIOContext::eof_reached

◆ write_flag

int AVIOContext::write_flag

true if open for writing

Definition at line 240 of file avio.h.

◆ max_packet_size

int AVIOContext::max_packet_size

Definition at line 241 of file avio.h.

◆ checksum

unsigned long AVIOContext::checksum

Definition at line 242 of file avio.h.

◆ checksum_ptr

unsigned char* AVIOContext::checksum_ptr

Definition at line 243 of file avio.h.

◆ update_checksum

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

Definition at line 244 of file avio.h.

◆ error

int AVIOContext::error

◆ read_pause

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

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

MMS.

Definition at line 249 of file avio.h.

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

Definition at line 255 of file avio.h.

◆ seekable

int AVIOContext::seekable

◆ maxsize

int64_t AVIOContext::maxsize

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

Definition at line 266 of file avio.h.

Referenced by thp_read_header().

◆ direct

int AVIOContext::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.

Definition at line 273 of file avio.h.

◆ bytes_read

int64_t AVIOContext::bytes_read

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

Definition at line 279 of file avio.h.

Referenced by avformat_find_stream_info().

◆ seek_count

int AVIOContext::seek_count

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

Definition at line 285 of file avio.h.

Referenced by avformat_find_stream_info().

◆ writeout_count

int AVIOContext::writeout_count

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

Definition at line 291 of file avio.h.

◆ orig_buffer_size

int AVIOContext::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.

Definition at line 298 of file avio.h.

◆ short_seek_threshold

int AVIOContext::short_seek_threshold

Threshold to favor readahead over seek.

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

Definition at line 304 of file avio.h.

◆ protocol_whitelist

const char* AVIOContext::protocol_whitelist

',' separated list of allowed protocols.

Definition at line 309 of file avio.h.

◆ protocol_blacklist

const char* AVIOContext::protocol_blacklist

',' separated list of disallowed protocols.

Definition at line 314 of file avio.h.

◆ write_data_type

int(* AVIOContext::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.

Definition at line 319 of file avio.h.

Referenced by init_fps().

◆ ignore_boundary_point

int AVIOContext::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).

Definition at line 326 of file avio.h.

◆ current_type

enum AVIODataMarkerType AVIOContext::current_type

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

Definition at line 331 of file avio.h.

◆ last_time

int64_t AVIOContext::last_time

Definition at line 332 of file avio.h.

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

Definition at line 338 of file avio.h.

◆ written

int64_t AVIOContext::written

Definition at line 340 of file avio.h.

◆ buf_ptr_max

unsigned char* AVIOContext::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.

Definition at line 346 of file avio.h.

◆ min_packet_size

int AVIOContext::min_packet_size

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

Definition at line 351 of file avio.h.


The documentation for this struct was generated from the following file: