From 776fd4b9f604be440170b6d60887f624a08a49c4 Mon Sep 17 00:00:00 2001
From: Ralph Giles
When using a basic encoding mode, with no bitrate management, -an ogg_packet pointer can be given, and an the coded block is returned +an ogg_packet pointer can be given, and the coded block is returned directly through that structure and can be placed in the output stream.
Otherwise, NULL should be passed for the ogg_packet pointer. In @@ -46,9 +46,9 @@ extern int vorbis_analysis(vorbis_block *vb,ogg_packet *op);
declared in "vorbis/codec.h";
-This fuction examines the available encoder and tries to break it -into appropriate sized blocks. It should be called in a loop after -adding new data with vorbis_analysis_buffer()/vorbis_analysis_wrote() +
This fuction examines the available uncompressed data and tries to +break it into appropriate sized blocks. It should be called in a loop +after adding new data with vorbis_analysis_buffer()/vorbis_analysis_wrote() until it returns zero (need more data) or an negative value (error).
@@ -42,7 +42,7 @@ extern int vorbis_analysis_blockout(vorbis_dsp_state *v,vorbis_block *vb);
declared in "vorbis/codec.h";
This function creates and returns the three header packets needed -to configure a decoder to accept subsequent data. I should be called +to configure a decoder to accept compressed data. I should be called after all encoder initialization and configuration is complete. The output packets should be placed in order at the start of the compressed vorbis stream, prior to the first data packet. diff --git a/doc/vorbisenc/vorbis_analysis_init.html b/doc/vorbisenc/vorbis_analysis_init.html index d652cf4..967d13f 100644 --- a/doc/vorbisenc/vorbis_analysis_init.html +++ b/doc/vorbisenc/vorbis_analysis_init.html @@ -37,7 +37,7 @@ extern int vorbis_analysis_init(vorbis_dsp_state *v,vorbis_info *vi);
+Call with the vals parameter set to zero to signal the end +of the input data. +
+
@@ -38,7 +43,9 @@ extern int vorbis_analysis_wrote(vorbis_dsp_state *v,int vals);
declared in "vorbis/codec.h"; This fuction submits a transformed block to the bitrate management -engine for final encoding. Packets are submitted and, depending on the -encoding mode, buffered and the packet boundaries adjusted and padded -to meet the target bitrate. +engine for final encoding. Packets are buffered and the packet boundaries +adjusted and padded to meet the target bitrate, if any. +After calling vorbis_bitrate_addblock(), the passed vorbis_block structure can be reused in another call to vorbis_analysis_blockout(). Call vorbis_bitrate_flushpacket() to obtain the final compressed data. @@ -38,7 +38,7 @@ extern int vorbis_bitrate_addblock(vorbis_block *vb); Parameters
declared in "vorbis/codec.h"; -This function returns the next available packet from the bitrate -management engine. It should be called in a loop after any calls to -vorbis_bitrate_addblock() until it returns either 0 (more data needed) + This function returns the next available completed packet from the +bitrate management engine. It should be called in a loop after any call +to vorbis_bitrate_addblock() until it returns either 0 (more data needed) or a negative value (error). diff --git a/doc/vorbisenc/vorbis_block_init.html b/doc/vorbisenc/vorbis_block_init.html index 167d325..4053e01 100644 --- a/doc/vorbisenc/vorbis_block_init.html +++ b/doc/vorbisenc/vorbis_block_init.html @@ -17,9 +17,9 @@declared in "vorbis/codec.h"; -This function allocates and initializes internal state associated -with dividing the input into blocks for further analysis, stored inside -a vorbis_block structure. + This function initializes a vorbis_block structure and allocates its +internal storage. A vorbis_block is used to represent a particular block +of input audio which can be analyzed and coded as a unit. |