From 8e94244f86e657e4113e35438e59cf5771882b25 Mon Sep 17 00:00:00 2001 From: Aki Date: Sun, 3 Mar 2024 12:51:03 +0100 Subject: libogg and libvorbis are no longer part of this source tree --- contrib/vorbis/doc/vorbisfile/ov_read.html | 148 ----------------------------- 1 file changed, 148 deletions(-) delete mode 100644 contrib/vorbis/doc/vorbisfile/ov_read.html (limited to 'contrib/vorbis/doc/vorbisfile/ov_read.html') diff --git a/contrib/vorbis/doc/vorbisfile/ov_read.html b/contrib/vorbis/doc/vorbisfile/ov_read.html deleted file mode 100644 index 5461a84..0000000 --- a/contrib/vorbis/doc/vorbisfile/ov_read.html +++ /dev/null @@ -1,148 +0,0 @@ - - - -Vorbisfile - function - ov_read - - - - - - - - - -

Vorbisfile documentation

vorbisfile version 1.3.2 - 20101101

- -

ov_read()

- -

declared in "vorbis/vorbisfile.h";

- -

- This is the main function used to decode a Vorbis file within a - loop. It returns up to the specified number of bytes of decoded PCM audio - in the requested endianness, signedness, and word size. If the audio is - multichannel, the channels are interleaved in the output buffer. - If the passed in buffer is large, ov_read() will not fill - it; the passed in buffer size is treated as a limit and - not a request. - -

The output channels are in stream order and not remapped. Vorbis I -defines channel order as follows: - -

- -

Note that up to this point, the Vorbisfile API could more or less hide the - multiple logical bitstream nature of chaining from the toplevel - application if the toplevel application didn't particularly care. - However, when reading audio back, the application must be aware - that multiple bitstream sections do not necessarily use the same - number of channels or sampling rate.

ov_read() passes - back the index of the sequential logical bitstream currently being - decoded (in *bitstream) along with the PCM data in order - that the toplevel application can handle channel and/or sample - rate changes. This number will be incremented at chaining - boundaries even for non-seekable streams. For seekable streams, it - represents the actual chaining index within the physical bitstream. -

- -

- - - - -
-

-long ov_read(OggVorbis_File *vf, char *buffer, int length, int bigendianp, int word, int sgned, int *bitstream);
-
-
- -

Parameters

-
-
vf
-
A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile -functions.
-
buffer
-
A pointer to an output buffer. The decoded output is inserted into this buffer.
-
length
-
Number of bytes to be read into the buffer. Should be the same size as the buffer. A typical value is 4096.
-
bigendianp
-
Specifies big or little endian byte packing. 0 for little endian, 1 for b -ig endian. Typical value is 0.
-
word
-
Specifies word size. Possible arguments are 1 for 8-bit samples, or 2 or -16-bit samples. Typical value is 2.
-
sgned
-
Signed or unsigned data. 0 for unsigned, 1 for signed. Typically 1.
-
bitstream
-
A pointer to the number of the current logical bitstream.
-
- - -

Return Values

-
-
-
OV_HOLE
-
indicates there was an interruption in the data. -
(one of: garbage between pages, loss of sync followed by - recapture, or a corrupt page)
-
OV_EBADLINK
-
indicates that an invalid stream section was supplied to - libvorbisfile, or the requested link is corrupt.
-
OV_EINVAL
-
indicates the initial file headers couldn't be read or - are corrupt, or that the initial open call for vf - failed.
-
0
-
indicates EOF
-
n
-
indicates actual number of bytes read. ov_read() will - decode at most one vorbis packet per invocation, so the value - returned will generally be less than length. -
-
- -

Notes

-

Typical usage: -

-bytes_read = ov_read(&vf, -buffer, 4096,0,2,1,&current_section) -
- -This reads up to 4096 bytes into a buffer, with signed 16-bit -little-endian samples. -

- - - -

-
- - - - - - - - -

copyright © 2000-2010 Xiph.Org

Ogg Vorbis

Vorbisfile documentation

vorbisfile version 1.3.2 - 20101101

- - - - -- cgit v1.1