Vorbisfile - Base Data Structures

Vorbisfile documentation | vorbisfile version 1.3.2 - 20101101

# Base Data Structures

There are several data structures used to hold file and bitstream information during libvorbisfile decoding. These structures are declared in "vorbis/vorbisfile.h" and "vorbis/codec.h".

When using libvorbisfile, it's not necessary 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 the application-specified file manipulation routines set for use by ov_open_callbacks(). See also the provided document on using application-provided callbacks instead of stdio.

copyright © 2000-2010 Xiph.Org | Ogg Vorbis
Vorbisfile documentation | vorbisfile version 1.3.2 - 20101101