avio: document some members of AVIOContext.
authorAnton Khirnov <anton@khirnov.net>
Sat, 9 Apr 2011 10:20:04 +0000 (12:20 +0200)
committerAnton Khirnov <anton@khirnov.net>
Sun, 10 Apr 2011 05:41:56 +0000 (07:41 +0200)
libavformat/avio.h

index 134df12..95cad17 100644 (file)
  * sizeof(AVIOContext) must not be used outside libav*.
  */
 typedef struct {
  * 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);
     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);