vorbisfile - Base Data Structures

vorbisfile documentation | vorbisfile version 1.25 - 20000615

# Base Data Structures

There are several data structures used to hold file and bitstream information during vorbisfile decoding.

All the vorbisfile specific data structures are declared in "vorbis/vorbisfile.h" or "vorbis/codec.h".

When using vorbisfile, we usually won't need to know about most of the contents of these data structures, but it may be helpful to understand what they contain.

datatype | purpose
OggVorbis_File | This structure represents the basic file information. It contains a pointer to the physical file or bitstream and various information about that bitstream.
vorbis_comment | This structure contains the file comments. It contains a pointer to unlimited user comments, information about the number of comments, and a vendor description.
vorbis_info | This structure contains encoder-related information about the bitstream. It includes encoder info, channel info, and bitrate limits.
ov_callbacks | This structure contains pointers to file manipulation routines. Can be user-specified for use with ov_open_callbacks().

copyright © 2000 vorbis team | Ogg Vorbis team@vorbis.org
vorbisfile documentation | vorbisfile version 1.25 - 20000615