From f277bd5d0c6fdb9e2c125a2a6cc32675f87056cf Mon Sep 17 00:00:00 2001 From: jacqueline Date: Tue, 8 Aug 2023 23:34:02 +1000 Subject: Add tremor, add new ogg rules to make tremor deps happy --- lib/tremor/doc/decoding.html | 82 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 lib/tremor/doc/decoding.html (limited to 'lib/tremor/doc/decoding.html') diff --git a/lib/tremor/doc/decoding.html b/lib/tremor/doc/decoding.html new file mode 100644 index 00000000..1f61b47f --- /dev/null +++ b/lib/tremor/doc/decoding.html @@ -0,0 +1,82 @@ + + + +Tremor - Decoding + + + + + + + + + +

Tremor documentation

Tremor version 1.0 - 20020403

+ +

Decoding

+ +

+All libivorbisdec decoding routines are declared in "ivorbisfile.h". +

+ +After initialization, decoding audio +is as simple as calling ov_read(). This +function works similarly to reading from a normal file using +read().

+ +However, a few differences are worth noting: + +

multiple stream links

+ +A Vorbis stream may consist of multiple sections (called links) that +encode differing numbers of channels or sample rates. It is vitally +important to pay attention to the link numbers returned by ov_read and handle audio changes that may +occur at link boundaries. Such multi-section files do exist in the +wild and are not merely a specification curiosity. + +

returned data amount

+ +ov_read does not attempt to completely fill +a large, passed in data buffer; it merely guarantees that the passed +back data does not overflow the passed in buffer size. Large buffers +may be filled by iteratively looping over calls to ov_read (incrementing the buffer pointer) +until the original buffer is filled. + +

file cursor position

+ +Vorbis files do not necessarily start at a sample number or time offset +of zero. Do not be surprised if a file begins at a positive offset of +several minutes or hours, such as would happen if a large stream (such +as a concert recording) is chopped into multiple seperate files. + +

+ + + + + + + + + +
function purpose
ov_read This function makes up the main chunk of a decode loop. It takes an +OggVorbis_File structure, which must have been initialized by a previous +call to ov_open().
+ +

+

+ + + + + + + + +

copyright © 2002 Xiph.org	Ogg Vorbis
Tremor documentation	Tremor version 1.0 - 20020403

+ + + + -- cgit v1.2.3

function	purpose
ov_read	This function makes up the main chunk of a decode loop. It takes an +OggVorbis_File structure, which must have been initialized by a previous +call to `ov_open()`.