From: Monty Date: Mon, 1 Nov 2010 19:34:51 +0000 (+0000) Subject: Doc patch removed superfluous files, now need to remove them in SVN X-Git-Tag: v1.3.3~29 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=db16f332f79c8392896f11d56628a877aa3ca320;p=platform%2Fupstream%2Flibvorbis.git Doc patch removed superfluous files, now need to remove them in SVN svn path=/trunk/vorbis/; revision=17586 --- diff --git a/doc/vorbisenc/ov_ectl_ratemanage2_arg.html b/doc/vorbisenc/ov_ectl_ratemanage2_arg.html deleted file mode 100644 index a9f7207..0000000 --- a/doc/vorbisenc/ov_ectl_ratemanage2_arg.html +++ /dev/null @@ -1,92 +0,0 @@ - - - -vorbis - datatype - ov_ectl_ratemanage2_arg - - - - - - - - - -

libvorbisenc documentation

libvorbisenc release 1.1 - 20040709

- -

ov_ectl_ratemanage2_arg

- -

declared in "vorbis/vorbisenc.h"

- -

- -The ov_ectl_ratemanage2_arg structure is used with vorbis_encode_ctl() and the OV_ECTL_RATEMANAGE2_GET and -OV_ECTL_RATEMANAGE2_SET calls in order to query and modify specifics -of the encoder's bitrate management configuration. - -

- - - - - -
-
struct ovectl_ratemanage2_arg {
-  int    management_active;
-
-  long   bitrate_limit_min_kbps;
-  long   bitrate_limit_max_kbps;
-  long   bitrate_limit_reservoir_bits;
-  double bitrate_limit_reservoir_bias;
-
-  long   bitrate_average_kbps;
-  double bitrate_average_damping;
-};
-
- -

Relevant Struct Members

-
-
management_active
-
nonzero if bitrate management is active
- -
bitrate_limit_min_kbps
-
Lower allowed bitrate limit in kilobits per second
-
bitrate_limit_max_kbps
-
Upper allowed bitrate limit in kilobits per second
-
bitrate_limit_reservoir_bits
-
Size of the bitrate reservoir in bits
-
bitrate_limit_reservoir_bias
- -
Regulates the bitrate reservoir's preferred fill level in a range -from 0.0 to 1.0; 0.0 tries to bank bits to buffer against future -bitrate spikes, 1.0 buffers against future sudden drops in -instantaneous bitrate. Default is 0.1
- -
bitrate_average_kbps
-
Average bitrate setting in kilobits per second
- -
bitrate_average_damping
Slew rate limit setting -for average bitrate adjustment; sets the minimum time in seconds the -bitrate tracker may swing from one extreme to the other when boosting -or damping average bitrate.
- - - -
- - -

-
- - - - - - - - -

copyright © 2004 vorbis team

Ogg Vorbis
team@vorbis.org

vorbisfile documentation

libvorbisenc release 1.1 - 20040709

- - - - diff --git a/doc/vorbisenc/ov_ectl_ratemanage_arg.html b/doc/vorbisenc/ov_ectl_ratemanage_arg.html deleted file mode 100644 index 332f0b7..0000000 --- a/doc/vorbisenc/ov_ectl_ratemanage_arg.html +++ /dev/null @@ -1,92 +0,0 @@ - - - -vorbis - datatype - ov_ectl_ratemanage_arg - - - - - - - - - -

libvorbisenc documentation

libvorbisenc release 1.1 - 20040709

- -

ov_ectl_ratemanage_arg

- -

declared in "vorbis/vorbisenc.h"

- -

- -The ov_ectl_ratemanage_arg structure is used with vorbis_encode_ctl() and the OV_ECTL_RATEMANAGE_GET, -OV_ECTL_RATEMANAGE_SET, OV_ECTL_RATEMANAGE_AVG, -OV_ECTL_RATEMANAGE_HARD calls in order to query and modify specifics -of the encoder's bitrate management configuration. Note that this is -a deprecated interface; please use vorbis_encode_ctl() with the ov_ectl_ratemanage2_arg struct -and OV_ECTL_RATEMANAGE2_GET and OV_ECTL_RATEMANAGE2_SET calls in new -code. - -

- - - - - -
-
struct ovectl_ratemanage_arg {
-  int    management_active;
-
-  long   bitrate_hard_min;
-  long   bitrate_hard_max;
-  double bitrate_hard_window;
-
-  long   bitrate_av_lo;
-  long   bitrate_av_hi;
-  double bitrate_av_window;
-  double bitrate_av_window_center;
-};
-
- -

Relevant Struct Members

-
- -
management_active
-
nonzero if bitrate management is active
- -
bitrate_hard_min
-
hard lower limit (in kilobits per second) below which the stream bitrate will never be allowed for any given bitrate_hard_window seconds of time.
-
bitrate_hard_max
-
hard upper limit (in kilobits per second) above which the stream bitrate will never be allowed for any given bitrate_hard_window seconds of time.
-
bitrate_hard_window
-
the window period (in seconds) used to regulate the hard bitrate minimum and maximum
- -
bitrate_av_lo
-
soft lower limit (in kilobits per second) below which the average bitrate tracker will start nudging the bitrate higher.
-
bitrate_av_hi
-
soft upper limit (in kilobits per second) above which the average bitrate tracker will start nudging the bitrate lower.
-
bitrate_av_window
-
the window period (in seconds) used to regulate the average bitrate minimum and maximum.
-
bitrate_av_window_center
-
Regulates the relative centering of the average and hard windows; in libvorbis 1.0 and 1.0.1, the hard window regulation overlapped but followed the average window regulation. In libvorbis 1.1 a bit-reservoir interface replaces the old windowing interface; the older windowing interface is simulated and this field has no effect.
- -
- - -

-
- - - - - - - - -

copyright © 2004 vorbis team

Ogg Vorbis
team@vorbis.org

vorbisfile documentation

libvorbisenc release 1.1 - 20040709

- - - - diff --git a/doc/vorbisenc/vorbis_analysis.html b/doc/vorbisenc/vorbis_analysis.html deleted file mode 100644 index e5974cb..0000000 --- a/doc/vorbisenc/vorbis_analysis.html +++ /dev/null @@ -1,86 +0,0 @@ - - - -libvorbisenc - function - vorbis_analysis - - - - - - - - - -

libvorbisenc documentation

libvorbisenc release 1.1 - 20091219

- -

vorbis_analysis

- -

declared in "vorbis/codec.h";

- -

Once the uncompressed audio data has been divided into blocks, this -function is called on each block. It looks up the encoding mode and -dispatches the block to the forward transform provided by that mode. -

-

When using a basic encoding mode, with no bitrate management, -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 -that case, after the transform has been applied, the block must passed -to vorbis_bitrate_addblock() for further coding. This method works with -both basic and managed encoding modes, so it's recommended for new code. -

- - - - - -
-

-extern int      vorbis_analysis(vorbis_block *vb,ogg_packet *op);
-
-
- -

Parameters

-
-
vb
-
Pointer to the vorbis_block to be encoded.
-
op
-
Optional pointer to an ogg_packet. This is normally NULL, -and the final output is obtained by passing vb though the -vorbis_bitrate_*() interface to perform further refinement. -However, when not using a bitrate managed encoding mode, it -is possible to skip that step by providing an ogg_packet pointer -here, obtaining the compressed data directly.
-
- - -

Return Values

- -

- -

-

- - - - - - - - -

copyright © 2009 Xiph.Org

Ogg Vorbis
team@vorbis.org

libvorbisenc documentation

libvorbisenc release 1.1 - 20091219

- - - - - diff --git a/doc/vorbisenc/vorbis_analysis_blockout.html b/doc/vorbisenc/vorbis_analysis_blockout.html deleted file mode 100644 index 169df08..0000000 --- a/doc/vorbisenc/vorbis_analysis_blockout.html +++ /dev/null @@ -1,79 +0,0 @@ - - - -libvorbisenc - function - vorbis_analysis_blockout - - - - - - - - - -

libvorbisenc documentation

libvorbisenc release 1.1 - 20091219

- -

vorbis_analysis_blockout

- -

declared in "vorbis/codec.h";

- -

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). -

-

-Each block returned should be passed to vorbis_analysis() for transform -and coding. -

- - - - - -
-

-extern int      vorbis_analysis_blockout(vorbis_dsp_state *v,vorbis_block *vb);
-
-
- -

Parameters

-
-
v
-
Pointer to the vorbis_dsp_state representing the encoder.
-
vb
-
Pointer to a previously initialized vorbis_block object to hold the -returned data. -
- - -

Return Values

- - -

-
- - - - - - - - -

copyright © 2009 Xiph.Org

Ogg Vorbis
team@vorbis.org

libvorbisenc documentation

libvorbisenc release 1.1 - 20091219

- - - - - diff --git a/doc/vorbisenc/vorbis_analysis_buffer.html b/doc/vorbisenc/vorbis_analysis_buffer.html deleted file mode 100644 index 5e79068..0000000 --- a/doc/vorbisenc/vorbis_analysis_buffer.html +++ /dev/null @@ -1,74 +0,0 @@ - - - -libvorbisenc - function - vorbis_analysis_buffer - - - - - - - - - -

libvorbisenc documentation

libvorbisenc release 1.1 - 20091219

- -

vorbis_analysis_buffer

- -

declared in "vorbis/codec.h";

- -

This fuction requests a buffer array for delivering audio to the -encoder for compression.

- -

The Vorbis encoder expects the caller to write audio data as -non-interleaved floating point samples into its internal buffers. -

-

-The general procedure is to call this function with the number of samples -you have available. The encoder will arrange for that much internal storage -and return an array of buffer pointers, one for each channel of audio. -The caller must then write the audio samples into those buffers, as -float values, and finally call vorbis_analysis_wrote() to tell the -encoder the data is available for analysis. -

- - - - - -
-

-extern float  **vorbis_analysis_buffer(vorbis_dsp_state *v,int vals);
-
-
- -

Parameters

-
-
v
-
Pointer to the vorbis_dsp_state representing the encoder.
-
vals
-
Number of samples to provide space for in the returned buffer. 1024 is a reasonable choice.
-
- - -

Return Values

-

Returns an array of floating point buffers which can accept data. -A (**float) where the first index is the channel, and the second is -the sample index.

- -

-

- - - - - - - - -

copyright © 2009 Xiph.Org

Ogg Vorbis
team@vorbis.org

libvorbisenc documentation

libvorbisenc release 1.1 - 20091219

- - - - - diff --git a/doc/vorbisenc/vorbis_analysis_headerout.html b/doc/vorbisenc/vorbis_analysis_headerout.html deleted file mode 100644 index 5c08656..0000000 --- a/doc/vorbisenc/vorbis_analysis_headerout.html +++ /dev/null @@ -1,83 +0,0 @@ - - - -libvorbisenc - function - vorbis_analysis_headerout - - - - - - - - - -

libvorbisenc documentation

libvorbisenc release 1.1 - 20091219

- -

vorbis_analysis_headerout

- -

declared in "vorbis/codec.h";

- -

This function creates and returns the three header packets needed -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. -

- - - - - -
-

-extern int      vorbis_analysis_headerout(vorbis_dsp_state *v,
-                                          vorbis_comment *vc,
-                                          ogg_packet *op,
-                                          ogg_packet *op_comm,
-                                          ogg_packet *op_code);
-
-
- -

Parameters

-
-
v
-
Pointer to an initialized vorbis_dsp_state which holds the encoder configuration.
-
vc
-
Pointer to an initialized vorbis_comment structure which holds the metadata associated with the stream being encoded.
-
op
-
Pointer to an ogg_packet structure to be filled out with the stream identification header.
-
op_comm
-
Pointer to an ogg_packet structure to be filled out with the serialied vorbis_comment data.
-
op_code
-
Pointer to an ogg_packet structure to be filled out with the codebooks, mode descriptions, etc. which will be used encoding the stream.
-
- - -

Return Values

- -

- -

-

- - - - - - - - -

copyright © 2009 Xiph.Org

Ogg Vorbis
team@vorbis.org

libvorbisenc documentation

libvorbisenc release 1.1 - 20091219

- - - - - diff --git a/doc/vorbisenc/vorbis_analysis_init.html b/doc/vorbisenc/vorbis_analysis_init.html deleted file mode 100644 index 967d13f..0000000 --- a/doc/vorbisenc/vorbis_analysis_init.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libvorbisenc - function - vorbis_analysis_init - - - - - - - - - -

libvorbisenc documentation

libvorbisenc release 1.1 - 20091219

- -

vorbis_analysis_init

- -

declared in "vorbis/codec.h";

- -

This function allocates and initializes the encoder's analysis state -inside a is vorbis_dsp_state, based on the configuration in a vorbis_info -struct. -

- - - - - -
-

-extern int      vorbis_analysis_init(vorbis_dsp_state *v,vorbis_info *vi);
-
-
- -

Parameters

-
-
v -
Pointer to the vorbis_dsp_state structure to be initialized for encoding.
-
vi
-
Pointer to an initialized vorbis_info struct describing the encoder configuration.
-
- - -

Return Values

-
-
  • -0 for success
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2009 Xiph.Org

    Ogg Vorbis
    team@vorbis.org

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20091219

    - - - - - diff --git a/doc/vorbisenc/vorbis_analysis_wrote.html b/doc/vorbisenc/vorbis_analysis_wrote.html deleted file mode 100644 index f907eb4..0000000 --- a/doc/vorbisenc/vorbis_analysis_wrote.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -libvorbisenc - function - vorbis_analysis_wrote - - - - - - - - - -

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20091219

    - -

    vorbis_analysis_wrote

    - -

    declared in "vorbis/codec.h";

    - -

    This function tells the encoder new data is available for compression. -Call this after writing new audio into the buffer array returned by -vorbis_analysis_buffer(). -

    - -

    -Call with the vals parameter set to zero to signal the end -of the input data. -

    - - - - - -
    -
    
-extern int      vorbis_analysis_wrote(vorbis_dsp_state *v,int vals);
-
    -
    - -

    Parameters

    -
    -
    v
    -
    Pointer to the vorbis_dsp_state representing the encoder.
    -
    vals
    -
    Number of samples successfully written. This must be less than -or equal to the value passed to vorbis_analysis_buffer(). A value -of zero means all input data has been provided and the compressed -stream should be finalized.
    -
    - - -

    Return Values

    - -

    - -

    -

    - - - - - - - - -

    copyright © 2009 Xiph.Org

    Ogg Vorbis
    team@vorbis.org

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20091219

    - - - - - diff --git a/doc/vorbisenc/vorbis_bitrate_addblock.html b/doc/vorbisenc/vorbis_bitrate_addblock.html deleted file mode 100644 index bd360d8..0000000 --- a/doc/vorbisenc/vorbis_bitrate_addblock.html +++ /dev/null @@ -1,74 +0,0 @@ - - - -libvorbisenc - function - vorbis_bitrate_addblock - - - - - - - - - -

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20091219

    - -

    vorbis_bitrate_addblock

    - -

    declared in "vorbis/codec.h";

    - -

    This fuction submits a transformed block to the bitrate management -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. -

    - - - - - -
    -
    
-extern int      vorbis_bitrate_addblock(vorbis_block *vb);
-
    -
    - -

    Parameters

    -
    -
    vb
    -
    Pointer to the vorbis_block to be submitted.
    -
    - - -

    Return Values

    - - -

    -
    - - - - - - - - -

    copyright © 2009 Xiph.Org

    Ogg Vorbis
    team@vorbis.org

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20091219

    - - - - - diff --git a/doc/vorbisenc/vorbis_bitrate_flushpacket.html b/doc/vorbisenc/vorbis_bitrate_flushpacket.html deleted file mode 100644 index d5467eb..0000000 --- a/doc/vorbisenc/vorbis_bitrate_flushpacket.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -libvorbisenc - function - vorbis_bitrate_flushpacket - - - - - - - - - -

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20091219

    - -

    vorbis_bitrate_flushpacket

    - -

    declared in "vorbis/codec.h";

    - -

    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). -

    - -

    -The data returned in the ogg_packet structure can be copied to the -final compressed output stream. -

    - - - - - -
    -
    
-extern int      vorbis_bitrate_flushpacket(vorbis_dsp_state *vd,
-                                           ogg_packet *op);
-
    -
    - -

    Parameters

    -
    -
    vd
    -
    Pointer to the vorbis_dsp_state represending the encoder.
    -
    op
    -
    Pointer to an ogg_packet to be filled out with the compressed data.
    -
    - - -

    Return Values

    - - -

    -
    - - - - - - - - -

    copyright © 2009 Xiph.Org

    Ogg Vorbis
    team@vorbis.org

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20091219

    - - - - - diff --git a/doc/vorbisenc/vorbis_block_init.html b/doc/vorbisenc/vorbis_block_init.html deleted file mode 100644 index 4053e01..0000000 --- a/doc/vorbisenc/vorbis_block_init.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libvorbisenc - function - vorbis_block_init - - - - - - - - - -

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20091219

    - -

    vorbis_block_init

    - -

    declared in "vorbis/codec.h";

    - -

    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. -

    - - - - - -
    -
    
-extern int      vorbis_block_init(vorbis_dsp_state *v, vorbis_block *vb);
-
    -
    - -

    Parameters

    -
    -
    v -
    Pointer to an initialized vorbis_dsp_state with which to associate the new block.
    -
    vb
    -
    Pointer to a vorbis_block struct to be initialized.
    -
    - - -

    Return Values

    -
    -
  • -0 for success
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2009 Xiph.Org

    Ogg Vorbis
    team@vorbis.org

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20091219

    - - - - - diff --git a/doc/vorbisenc/vorbis_info.html b/doc/vorbisenc/vorbis_info.html deleted file mode 100644 index 99d2bbe..0000000 --- a/doc/vorbisenc/vorbis_info.html +++ /dev/null @@ -1,81 +0,0 @@ - - - -vorbis - datatype - vorbis_info - - - - - - - - - -

    libvorbisenc documentation

    libvorbisenc release 1.1 - 20040709

    - -

    vorbis_info

    - -

    declared in "vorbis/codec.h"

    - -

    -The vorbis_info structure contains information about a vorbis bitstream. - -

    - - - - - -
    -
    typedef struct vorbis_info{
-  int version;
-  int channels;
-  long rate;
-  
-  long bitrate_upper;
-  long bitrate_nominal;
-  long bitrate_lower;
-  long bitrate_window;
-
-  void *codec_setup;
-
-} vorbis_info;
    -
    - -

    Relevant Struct Members

    -
    -
    version
    -
    Vorbis encoder version used to create this bitstream.
    -
    channels
    -
    Int signifying number of channels in bitstream.
    -
    rate
    -
    Sampling rate of the bitstream.
    -
    bitrate_upper
    -
    Specifies the upper limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_lower parameters, the stream is fixed bitrate. May be unset if no limit exists.
    -
    bitrate_nominal
    -
    Specifies the average bitrate for a VBR bitstream. May be unset. If the bitrate_upper and bitrate_lower parameters match, the stream is fixed bitrate.
    -
    bitrate_lower
    -
    Specifies the lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.
    -
    bitrate_window
    -
    Specifies the size of the bit reservoir in seconds relative to the nominal bitrate. May be unset.
    -
    codec_setup
    -
    Pointer to private encoder setup state.
    - -
    - - -

    -
    - - - - - - - - -

    copyright © 2004 vorbis team

    Ogg Vorbis
    team@vorbis.org

    vorbisfile documentation

    libvorbisenc release 1.1 - 20040709

    - - - - diff --git a/doc/vorbisfile/return.html b/doc/vorbisfile/return.html deleted file mode 100644 index 5349a2f..0000000 --- a/doc/vorbisfile/return.html +++ /dev/null @@ -1,77 +0,0 @@ - - - -Vorbisfile - Return Codes - - - - - - - - - -

    Vorbisfile documentation

    vorbisfile version 1.2.0 - 20070723

    - -

    Return Codes

    - -

    - -The following return codes are #defined in "vorbis/codec.h" -may be returned by libvorbisfile. Descriptions of a code relevant to -a specific function are found in the reference description of that -function. - -

    - -
    OV_FALSE
    -
    Not true, or no data available
    - -
    OV_HOLE
    -
    Vorbisfile encoutered missing or corrupt data in the bitstream. Recovery -is normally automatic and this return code is for informational purposes only.
    - -
    OV_EREAD
    -
    Read error while fetching compressed data for decode
    - -
    OV_EFAULT
    -
    Internal inconsistency in decode state. Continuing is likely not possible.
    - -
    OV_EIMPL
    -
    Feature not implemented
    - -
    OV_EINVAL
    -
    Either an invalid argument, or incompletely initialized argument passed to libvorbisfile call
    - -
    OV_ENOTVORBIS
    -
    The given file/data was not recognized as Ogg Vorbis data.
    - -
    OV_EBADHEADER
    -
    The file/data is apparently an Ogg Vorbis stream, but contains a corrupted or undecipherable header.
    - -
    OV_EVERSION
    -
    The bitstream format revision of the given stream is not supported.
    - -
    OV_EBADLINK
    -
    The given link exists in the Vorbis data stream, but is not decipherable due to garbacge or corruption.
    - -
    OV_ENOSEEK
    -
    The given stream is not seekable
    - -
    - -

    -
    - - - - - - - - -

    copyright © 2007 Xiph.org

    Ogg Vorbis

    Vorbisfile documentation

    vorbisfile version 1.2.0 - 20070723

    - - - - diff --git a/doc/vorbisfile/vorbis_comment.html b/doc/vorbisfile/vorbis_comment.html deleted file mode 100644 index ba81ad7..0000000 --- a/doc/vorbisfile/vorbis_comment.html +++ /dev/null @@ -1,70 +0,0 @@ - - - -Vorbisfile - datatype - vorbis_comment - - - - - - - - - -

    Vorbisfile documentation

    vorbisfile version 1.2.0 - 20070723

    - -

    vorbis_comment

    - -

    declared in "vorbis/codec.h"

    - -

    -The vorbis_comment structure defines an Ogg Vorbis comment. -

    -Only the fields the program needs must be defined. If a field isn't -defined by the application, it will either be blank (if it's a string value) -or set to some reasonable default (usually 0). -

    - - - - - -
    -
    typedef struct vorbis_comment{
-  /* unlimited user comment fields. */
-  char **user_comments;
-  int  *comment_lengths;
-  int  comments;
-  char *vendor;
-
-} vorbis_comment;
    -
    - -

    Parameters

    -
    -
    user_comments
    -
    Unlimited user comment array. The individual strings in the array are 8 bit clean, by the Vorbis specification, and as such the comment_lengths array should be consulted to determine string length. For convenience, each string is also NULL-terminated by the decode library (although Vorbis comments are not NULL terminated within the bitstream itself).
    -
    comment_lengths
    -
    An int array that stores the length of each comment string
    -
    comments
    -
    Int signifying number of user comments in user_comments field.
    -
    vendor
    -
    Information about the creator of the file. Stored in a standard C 0-terminated string.
    -
    - - -

    -
    - - - - - - - - -

    copyright © 2007 Xiph.org

    Ogg Vorbis

    Vorbisfile documentation

    vorbisfile version 1.2.0 - 20070723

    - - - - diff --git a/doc/vorbisfile/vorbis_info.html b/doc/vorbisfile/vorbis_info.html deleted file mode 100644 index 54bd621..0000000 --- a/doc/vorbisfile/vorbis_info.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -Vorbisfile - datatype - vorbis_info - - - - - - - - - -

    Vorbisfile documentation

    vorbisfile version 1.2.0 - 20070723

    - -

    vorbis_info

    - -

    declared in "vorbis/codec.h"

    - -

    -The vorbis_info structure contains basic information about the audio in a vorbis bitstream. -

    - - - - - -
    -
    typedef struct vorbis_info{
-  int version;
-  int channels;
-  long rate;
-  
-  long bitrate_upper;
-  long bitrate_nominal;
-  long bitrate_lower;
-  long bitrate_window;
-
-  void *codec_setup;
-
-} vorbis_info;
    -
    - -

    Relevant Struct Members

    -
    -
    version
    -
    Vorbis encoder version used to create this bitstream.
    -
    channels
    -
    Int signifying number of channels in bitstream.
    -
    rate
    -
    Sampling rate of the bitstream.
    -
    bitrate_upper
    -
    Specifies the upper limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_lower parameters, the stream is fixed bitrate. May be unset if no limit exists.
    -
    bitrate_nominal
    -
    Specifies the average bitrate for a VBR bitstream. May be unset. If the bitrate_upper and bitrate_lower parameters match, the stream is fixed bitrate.
    -
    bitrate_lower
    -
    Specifies the lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.
    -
    bitrate_window
    -
    Currently unset.
    - -
    codec_setup
    -
    Internal structure that contains the detailed/unpacked configuration for decoding the current Vorbis bitstream.
    -
    - - -

    -
    - - - - - - - - -

    copyright © 2007 Xiph.org

    Ogg Vorbis

    Vorbisfile documentation

    vorbisfile version 1.2.0 - 20070723

    - - - -