diff options
author | Anton Khirnov <anton@khirnov.net> | 2011-04-09 12:20:04 +0200 |
---|---|---|
committer | Anton Khirnov <anton@khirnov.net> | 2011-04-10 07:41:56 +0200 |
commit | c1a9012d62b76106d02f080adec28e13b039a53d (patch) | |
tree | f989691f43e0bb9ada7fa9fa6f7e610db8259c49 /libavformat | |
parent | e782a0c6da0daa7b65e0355e50e68b13441b5faa (diff) | |
download | ffmpeg-streaming-c1a9012d62b76106d02f080adec28e13b039a53d.zip ffmpeg-streaming-c1a9012d62b76106d02f080adec28e13b039a53d.tar.gz |
avio: document some members of AVIOContext.
Diffstat (limited to 'libavformat')
-rw-r--r-- | libavformat/avio.h | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/libavformat/avio.h b/libavformat/avio.h index 134df12..95cad17 100644 --- a/libavformat/avio.h +++ b/libavformat/avio.h @@ -43,10 +43,15 @@ * sizeof(AVIOContext) must not be used outside libav*. */ typedef struct { - unsigned char *buffer; - int buffer_size; - unsigned char *buf_ptr, *buf_end; - void *opaque; + unsigned char *buffer; /**< Start of the buffer. */ + 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. for streams where + no more data has been received yet. */ + void *opaque; /**< A private pointer, passed to the read/write/seek/... + functions. */ 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); |