Hi,

On Sat, Apr 9, 2011 at 8:57 AM, Anton Khirnov <[email protected]> wrote:
> ---
>  libavformat/avio.h |   12 ++++++++----
>  1 files changed, 8 insertions(+), 4 deletions(-)
>
> diff --git a/libavformat/avio.h b/libavformat/avio.h
> index b30866c..e1c4876 100644
> --- a/libavformat/avio.h
> +++ b/libavformat/avio.h
> @@ -43,10 +43,14 @@
>  * 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 that 
> buffer+buffer_size
> +                                 e.g. for packetized formats which read one 
> packet
> +                                 when filling the buffer. */
> +    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);

Which makes me wonder, maybe we should more explicitely document that
applications should be no business touching any of these members at
the bottom here (opaque, function pointers).

Ronald
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel

Reply via email to