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/libvorbis/Makefile.am | 24 ---- contrib/vorbis/doc/libvorbis/index.html | 44 ------- contrib/vorbis/doc/libvorbis/overview.html | 136 --------------------- contrib/vorbis/doc/libvorbis/reference.html | 86 ------------- contrib/vorbis/doc/libvorbis/return.html | 79 ------------ contrib/vorbis/doc/libvorbis/style.css | 7 -- contrib/vorbis/doc/libvorbis/vorbis_analysis.html | 86 ------------- .../doc/libvorbis/vorbis_analysis_blockout.html | 79 ------------ .../doc/libvorbis/vorbis_analysis_buffer.html | 74 ----------- .../doc/libvorbis/vorbis_analysis_headerout.html | 83 ------------- .../vorbis/doc/libvorbis/vorbis_analysis_init.html | 66 ---------- .../doc/libvorbis/vorbis_analysis_wrote.html | 80 ------------ .../doc/libvorbis/vorbis_bitrate_addblock.html | 74 ----------- .../doc/libvorbis/vorbis_bitrate_flushpacket.html | 80 ------------ contrib/vorbis/doc/libvorbis/vorbis_block.html | 60 --------- .../vorbis/doc/libvorbis/vorbis_block_clear.html | 61 --------- .../vorbis/doc/libvorbis/vorbis_block_init.html | 66 ---------- contrib/vorbis/doc/libvorbis/vorbis_comment.html | 80 ------------ .../vorbis/doc/libvorbis/vorbis_comment_add.html | 70 ----------- .../doc/libvorbis/vorbis_comment_add_tag.html | 74 ----------- .../vorbis/doc/libvorbis/vorbis_comment_clear.html | 69 ----------- .../vorbis/doc/libvorbis/vorbis_comment_init.html | 72 ----------- .../vorbis/doc/libvorbis/vorbis_comment_query.html | 72 ----------- .../doc/libvorbis/vorbis_comment_query_count.html | 66 ---------- .../doc/libvorbis/vorbis_commentheader_out.html | 65 ---------- contrib/vorbis/doc/libvorbis/vorbis_dsp_clear.html | 63 ---------- contrib/vorbis/doc/libvorbis/vorbis_dsp_state.html | 57 --------- .../vorbis/doc/libvorbis/vorbis_granule_time.html | 65 ---------- contrib/vorbis/doc/libvorbis/vorbis_info.html | 80 ------------ .../doc/libvorbis/vorbis_info_blocksize.html | 66 ---------- .../vorbis/doc/libvorbis/vorbis_info_clear.html | 61 --------- contrib/vorbis/doc/libvorbis/vorbis_info_init.html | 62 ---------- .../doc/libvorbis/vorbis_packet_blocksize.html | 66 ---------- contrib/vorbis/doc/libvorbis/vorbis_synthesis.html | 70 ----------- .../doc/libvorbis/vorbis_synthesis_blockin.html | 69 ----------- .../doc/libvorbis/vorbis_synthesis_halfrate.html | 68 ----------- .../doc/libvorbis/vorbis_synthesis_halfrate_p.html | 64 ---------- .../doc/libvorbis/vorbis_synthesis_headerin.html | 80 ------------ .../doc/libvorbis/vorbis_synthesis_idheader.html | 63 ---------- .../doc/libvorbis/vorbis_synthesis_init.html | 69 ----------- .../doc/libvorbis/vorbis_synthesis_lapout.html | 74 ----------- .../doc/libvorbis/vorbis_synthesis_pcmout.html | 75 ------------ .../doc/libvorbis/vorbis_synthesis_read.html | 67 ---------- .../doc/libvorbis/vorbis_synthesis_restart.html | 64 ---------- .../doc/libvorbis/vorbis_synthesis_trackonly.html | 71 ----------- .../doc/libvorbis/vorbis_version_string.html | 56 --------- 46 files changed, 3163 deletions(-) delete mode 100644 contrib/vorbis/doc/libvorbis/Makefile.am delete mode 100644 contrib/vorbis/doc/libvorbis/index.html delete mode 100644 contrib/vorbis/doc/libvorbis/overview.html delete mode 100644 contrib/vorbis/doc/libvorbis/reference.html delete mode 100644 contrib/vorbis/doc/libvorbis/return.html delete mode 100644 contrib/vorbis/doc/libvorbis/style.css delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_analysis.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_analysis_buffer.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_analysis_headerout.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_analysis_init.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_analysis_wrote.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_bitrate_addblock.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_bitrate_flushpacket.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_block.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_block_clear.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_block_init.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_comment.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_comment_add.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_comment_add_tag.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_comment_clear.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_comment_init.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_comment_query.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_comment_query_count.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_commentheader_out.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_dsp_clear.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_dsp_state.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_granule_time.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_info.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_info_blocksize.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_info_clear.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_info_init.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_packet_blocksize.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_blockin.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_halfrate.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_halfrate_p.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_headerin.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_idheader.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_init.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_lapout.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_pcmout.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_read.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_restart.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_synthesis_trackonly.html delete mode 100644 contrib/vorbis/doc/libvorbis/vorbis_version_string.html (limited to 'contrib/vorbis/doc/libvorbis') diff --git a/contrib/vorbis/doc/libvorbis/Makefile.am b/contrib/vorbis/doc/libvorbis/Makefile.am deleted file mode 100644 index 0bcc135..0000000 --- a/contrib/vorbis/doc/libvorbis/Makefile.am +++ /dev/null @@ -1,24 +0,0 @@ -## Process this file with automake to produce Makefile.in - -docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)/libvorbis - -doc_DATA = index.html reference.html style.css vorbis_comment.html\ - vorbis_info.html vorbis_analysis_blockout.html vorbis_analysis_buffer.html\ - vorbis_analysis_headerout.html vorbis_analysis_init.html \ - vorbis_analysis_wrote.html vorbis_analysis.html vorbis_bitrate_addblock.html\ - vorbis_bitrate_flushpacket.html vorbis_block_init.html \ - vorbis_block_clear.html vorbis_dsp_clear.html vorbis_granule_time.html \ - vorbis_version_string.html vorbis_info_blocksize.html vorbis_info_clear.html\ - vorbis_info_init.html vorbis_comment_add.html vorbis_comment_add_tag.html\ - vorbis_comment_clear.html vorbis_comment_init.html vorbis_comment_query.html\ - vorbis_comment_query_count.html vorbis_commentheader_out.html\ - vorbis_packet_blocksize.html vorbis_synthesis.html \ - vorbis_synthesis_blockin.html vorbis_synthesis_halfrate.html \ - vorbis_synthesis_halfrate_p.html vorbis_synthesis_headerin.html \ - vorbis_synthesis_idheader.html vorbis_synthesis_init.html \ - vorbis_synthesis_lapout.html vorbis_synthesis_pcmout.html \ - vorbis_synthesis_read.html vorbis_synthesis_restart.html \ - vorbis_synthesis_trackonly.html vorbis_block.html vorbis_dsp_state.html \ - return.html overview.html - -EXTRA_DIST = $(doc_DATA) diff --git a/contrib/vorbis/doc/libvorbis/index.html b/contrib/vorbis/doc/libvorbis/index.html deleted file mode 100644 index e2199a2..0000000 --- a/contrib/vorbis/doc/libvorbis/index.html +++ /dev/null @@ -1,44 +0,0 @@ - - - -libvorbis - Documentation - - - - - - - - - -

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- -

Libvorbis Documentation

- -

-Libvorbis contains the Vorbis reference encoder and decoder. -

-This is the lowest-level interface to the Vorbis encoder and decoder. If -you're just looking for a simple way to extract the -audio from an Ogg Vorbis file, you probably want to use vorbisfile rather than using libogg -and libvorbis directly. -

-Libvorbis API overview
-Libvorbis API reference
- -

-

- - - - - - - - -

copyright © 2000-2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- - - - diff --git a/contrib/vorbis/doc/libvorbis/overview.html b/contrib/vorbis/doc/libvorbis/overview.html deleted file mode 100644 index 22cd186..0000000 --- a/contrib/vorbis/doc/libvorbis/overview.html +++ /dev/null @@ -1,136 +0,0 @@ - - - -libvorbis - API Overview - - - - - - - - - -

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- -

Libvorbis API Overview

- -

Libvorbis is the reference implementation of the Vorbis codec. It is -the lowest-level interface to the Vorbis encoder and decoder, working -with packets directly.

- -

All libvorbis routines and structures are declared in "vorbis/codec.h".

- -

Encoding workflow

- -
    -
  1. Initialize a vorbis_info structure -by calling vorbis_info_init and -then functions from libvorbisenc -on it.
    2. -
  2. Initialize a vorbis_dsp_state -for encoding based on the parameters in the vorbis_info by using vorbis_analysis_init.
    3. -
  3. Initialize a vorbis_comment -structure using vorbis_comment_init, -populate it with any comments you wish to store in the stream, and call -vorbis_analysis_headerout to -get the three Vorbis stream header packets. Output the packets.
    4. -
  4. Initialize a vorbis_block structure -using vorbis_block_init.
    5. -
  5. While there is more audio to encode:
      -
    1. Submit a chunk of audio data using vorbis_analysis_buffer and vorbis_analysis_wrote.
      2. -
    2. Obtain all available blocks using vorbis_analysis_blockout -in a loop. For each block obtained:
        -
      1. Encode the block into a packet (or prepare it for bitrate management) -using vorbis_analysis. (It's a good -idea to always pass the blocks through the bitrate -management mechanism; more information is on the vorbis_analysis page. It does not affect -the resulting packets unless you are actually using a bitrate-managed -mode.)
        2. -
      2. If you are using bitrate management, submit the block using vorbis_bitrate_addblock and obtain -packets using vorbis_bitrate_flushpacket.
        3. -
      3. Output any obtained packets.
        4. -
      3. -
    6. -
  6. Submit an empty buffer to indicate the end of input; this will result -in an end-of-stream packet after all encoding steps are done to it.
    7. -
  7. Destroy the structures using the appropriate vorbis_*_clear routines.
    8. -
- -

Decoding workflow

- -Note: if you do not need to do anything more involved than just -decoding the audio from an Ogg Vorbis file, you can use the far simpler -libvorbisfile interface, which -will take care of all of the demuxing and low-level decoding operations -(and even the I/O, if you want) for you. - -
    -
  1. When reading the header packets of an Ogg stream, you can use vorbis_synthesis_idheader to -check whether a stream might be Vorbis.
    2. -
  2. Initialize a vorbis_info and a vorbis_comment structure using the -appropriate vorbis_*_init routines, then pass the first three packets -from the stream (the Vorbis stream header packets) to vorbis_synthesis_headerin in -order. At this point, you can see the comments and basic parameters of -the Vorbis stream.
    3. -
  3. Initialize a vorbis_dsp_state -for decoding based on the parameters in the vorbis_info by using vorbis_synthesis_init.
    4. -
  4. Initialize a vorbis_block structure -using vorbis_block_init.
    5. -
  5. While there are more packets to decode:
      -
    1. Decode the next packet into a block using vorbis_synthesis.
      2. -
    2. Submit the block to the reassembly layer using vorbis_synthesis_blockin.
      3. -
    3. Obtain some decoded audio using vorbis_synthesis_pcmout and vorbis_synthesis_read. Any audio data -returned but not marked as consumed using vorbis_synthesis_read carries -over to the next call to vorbis_synthesis_pcmout.
      4. -
    6. -
  6. Destroy the structures using the appropriate vorbis_*_clear routines.
    7. -
- -

Metadata workflow

- -Note: if you do not need to do anything more involved than just -reading the metadata from an Ogg Vorbis file, libvorbisfile can do this for you. - -
    -
  1. Follow the decoding workflow above until you have access to the comments -and basic parameters of the Vorbis stream.
    2. -
  2. If you want to alter the comments, copy the first packet to the output -file, then create a packet for the modified comments using vorbis_commentheader_out and output -it, then copy the third packet and all subsequent packets into the output -file.
    3. -
- -

-
- - - - - - - - -

copyright © 2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- - - - - diff --git a/contrib/vorbis/doc/libvorbis/reference.html b/contrib/vorbis/doc/libvorbis/reference.html deleted file mode 100644 index 642b1f9..0000000 --- a/contrib/vorbis/doc/libvorbis/reference.html +++ /dev/null @@ -1,86 +0,0 @@ - - - -Libvorbis API Reference - - - - - - - - - -

Libvorbis documentation

libvorbis version 1.3.2 - 20101101

- -

Libvorbis API Reference

- -

-Data Structures
-vorbis_block
-vorbis_comment
-vorbis_dsp_state
-vorbis_info
-
-Functions used by both decode and encode
-vorbis_block_clear()
-vorbis_block_init()
-vorbis_dsp_clear()
-vorbis_granule_time()
-vorbis_info_blocksize()
-vorbis_info_clear()
-vorbis_info_init()
-vorbis_version_string()
-
-Decoding
-vorbis_packet_blocksize()
-vorbis_synthesis()
-vorbis_synthesis_blockin()
-vorbis_synthesis_halfrate()
-vorbis_synthesis_halfrate_p()
-vorbis_synthesis_headerin()
-vorbis_synthesis_idheader()
-vorbis_synthesis_init()
-vorbis_synthesis_lapout()
-vorbis_synthesis_pcmout()
-vorbis_synthesis_read()
-vorbis_synthesis_restart()
-vorbis_synthesis_trackonly()
-
-Encoding
-vorbis_analysis()
-vorbis_analysis_blockout()
-vorbis_analysis_buffer()
-vorbis_analysis_headerout()
-vorbis_analysis_init()
-vorbis_analysis_wrote()
-vorbis_bitrate_addblock()
-vorbis_bitrate_flushpacket()
-
-Metadata
-vorbis_comment_add()
-vorbis_comment_add_tag()
-vorbis_comment_clear()
-vorbis_comment_init()
-vorbis_comment_query()
-vorbis_comment_query_count()
-vorbis_commentheader_out()
-
-Return Codes
- - -

-

- - - - - - - - -

copyright © 2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- - - - diff --git a/contrib/vorbis/doc/libvorbis/return.html b/contrib/vorbis/doc/libvorbis/return.html deleted file mode 100644 index 7a008d5..0000000 --- a/contrib/vorbis/doc/libvorbis/return.html +++ /dev/null @@ -1,79 +0,0 @@ - - - -libvorbis - Return Codes - - - - - - - - - -

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- -

Return Codes

- -

- -The following return codes are #defined in "vorbis/codec.h" and -may be returned by functions from libvorbis, libvorbisfile, and libvorbisenc. 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 encode or decode state. Continuing is likely not possible.
- -
OV_EIMPL
-
Feature not implemented
- -
OV_EINVAL
-
Either an invalid argument, or incompletely initialized argument passed to a 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 © 2000-2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- - - - diff --git a/contrib/vorbis/doc/libvorbis/style.css b/contrib/vorbis/doc/libvorbis/style.css deleted file mode 100644 index 81cf417..0000000 --- a/contrib/vorbis/doc/libvorbis/style.css +++ /dev/null @@ -1,7 +0,0 @@ -BODY { font-family: Helvetica, sans-serif } -TD { font-family: Helvetica, sans-serif } -P { font-family: Helvetica, sans-serif } -H1 { font-family: Helvetica, sans-serif } -H2 { font-family: Helvetica, sans-serif } -H4 { font-family: Helvetica, sans-serif } -P.tiny { font-size: 8pt } diff --git a/contrib/vorbis/doc/libvorbis/vorbis_analysis.html b/contrib/vorbis/doc/libvorbis/vorbis_analysis.html deleted file mode 100644 index b126f20..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_analysis.html +++ /dev/null @@ -1,86 +0,0 @@ - - - -libvorbis - function - vorbis_analysis - - - - - - - - - -

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- -

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 © 2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html b/contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html deleted file mode 100644 index 94948b6..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_analysis_blockout.html +++ /dev/null @@ -1,79 +0,0 @@ - - - -libvorbis - function - vorbis_analysis_blockout - - - - - - - - - -

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- -

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 © 2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_analysis_buffer.html b/contrib/vorbis/doc/libvorbis/vorbis_analysis_buffer.html deleted file mode 100644 index cf6ae80..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_analysis_buffer.html +++ /dev/null @@ -1,74 +0,0 @@ - - - -libvorbis - function - vorbis_analysis_buffer - - - - - - - - - -

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- -

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 © 2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_analysis_headerout.html b/contrib/vorbis/doc/libvorbis/vorbis_analysis_headerout.html deleted file mode 100644 index 58c37c3..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_analysis_headerout.html +++ /dev/null @@ -1,83 +0,0 @@ - - - -libvorbis - function - vorbis_analysis_headerout - - - - - - - - - -

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- -

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 © 2010 Xiph.Org

Ogg Vorbis

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_analysis_init.html b/contrib/vorbis/doc/libvorbis/vorbis_analysis_init.html deleted file mode 100644 index 8799338..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_analysis_init.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libvorbis - function - vorbis_analysis_init - - - - - - - - - -

libvorbis documentation

libvorbis version 1.3.2 - 20101101

- -

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 © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_analysis_wrote.html b/contrib/vorbis/doc/libvorbis/vorbis_analysis_wrote.html deleted file mode 100644 index 2326f60..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_analysis_wrote.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -libvorbis - function - vorbis_analysis_wrote - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    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 © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_bitrate_addblock.html b/contrib/vorbis/doc/libvorbis/vorbis_bitrate_addblock.html deleted file mode 100644 index 9de5de4..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_bitrate_addblock.html +++ /dev/null @@ -1,74 +0,0 @@ - - - -libvorbis - function - vorbis_bitrate_addblock - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    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 © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_bitrate_flushpacket.html b/contrib/vorbis/doc/libvorbis/vorbis_bitrate_flushpacket.html deleted file mode 100644 index 297abb0..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_bitrate_flushpacket.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -libvorbis - function - vorbis_bitrate_flushpacket - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    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 © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_block.html b/contrib/vorbis/doc/libvorbis/vorbis_block.html deleted file mode 100644 index 9cd24c2..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_block.html +++ /dev/null @@ -1,60 +0,0 @@ - - - -libvorbis - datatype - vorbis_block - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_block

    - -

    declared in "vorbis/codec.h"

    - -

    -The vorbis_block structure holds the data for a single block of audio. One -vorbis_block translates to one codec packet. The encoding process consists -of splitting the audio into blocks and encoding the blocks into packets; -decoding consists of decoding the packets into blocks and reassembling -the audio from the blocks. -

    -This structure is intended to be private. Although the fields are given -in the header file, they should not be directly modified or relied upon -in any way. -

    - - - - - -
    -
    typedef struct vorbis_block{
-  /* private */
-} vorbis_block;
    -
    - -

    Parameters

    - - - -

    -
    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_block_clear.html b/contrib/vorbis/doc/libvorbis/vorbis_block_clear.html deleted file mode 100644 index 13be5b6..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_block_clear.html +++ /dev/null @@ -1,61 +0,0 @@ - - - -libvorbis - function - vorbis_block_clear - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_block_clear

    - -

    declared in "vorbis/codec.h";

    - -

    This function frees the internal storage for a vorbis_block structure.

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

    Parameters

    -
    -
    vb
    -
    Pointer to a vorbis_block struct to be cleared.
    -
    - - -

    Return Values

    -
    -
  • -0 for success
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_block_init.html b/contrib/vorbis/doc/libvorbis/vorbis_block_init.html deleted file mode 100644 index 82f6ae8..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_block_init.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libvorbis - function - vorbis_block_init - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    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 © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_comment.html b/contrib/vorbis/doc/libvorbis/vorbis_comment.html deleted file mode 100644 index 7afb7f3..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_comment.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -libvorbis - datatype - vorbis_comment - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

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

    -Note: When encoding, while it is supported to modify a -vorbis_comment structure directly, be sure to read the notes on the -vorbis_comment_init and -vorbis_comment_clear pages for -considerations on memory allocation and freeing before you do so. Rule of -thumb: call vorbis_comment_init, then either do all allocation, -freeing, and modification yourself and do not call -vorbis_comment_clear, or do all modification using libvorbis -functions and do call vorbis_comment_clear. -

    - - - - - -
    -
    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 Vorbis implementation that encoded the file. Stored in a standard C 0-terminated string. Libvorbis will fill this in itself when encoding a comment packet from this structure; when decoding, this contains the vendor string that was in the comment packet.
    -
    - - -

    -
    - - - - - - - - -

    copyright © 2000-2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_comment_add.html b/contrib/vorbis/doc/libvorbis/vorbis_comment_add.html deleted file mode 100644 index b7125b0..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_comment_add.html +++ /dev/null @@ -1,70 +0,0 @@ - - - -libvorbis - function - vorbis_comment_add - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_comment_add

    - -

    declared in "vorbis/codec.h";

    - -

    This function adds a raw comment string to a -vorbis_comment structure.

    - -

    This function should be used if the string is already in the -form "KEY=value". If you have a separate key and value, use -vorbis_comment_add_tag -instead.

    - - - - - -
    -
    
-extern void     vorbis_comment_add(vorbis_comment *vc, const char *comment);
-
    -
    - -

    Parameters

    -
    -
    vc
    -
    Pointer to a vorbis_comment structure to add the comment to.
    -
    comment
    -
    Pointer to the null-terminated raw comment string. The string will -be copied, so it can be freed or modified after this function returns -without affecting the vorbis_comment structure's contents.
    -
    - - -

    Return Values

    -
    -
  • None.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_comment_add_tag.html b/contrib/vorbis/doc/libvorbis/vorbis_comment_add_tag.html deleted file mode 100644 index 97565d3..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_comment_add_tag.html +++ /dev/null @@ -1,74 +0,0 @@ - - - -libvorbis - function - vorbis_comment_add_tag - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_comment_add_tag

    - -

    declared in "vorbis/codec.h";

    - -

    This function adds a tag-comment pair to a -vorbis_comment structure. There can -be more than one comment value for the same tag; if a comment with the -same tag already exists, another comment with the same tag is added.

    - -

    If you already have a string in the form "KEY=value", see -vorbis_comment_add instead.

    - - - - - -
    -
    
-extern void     vorbis_comment_add_tag(vorbis_comment *vc,
-                                       const char *tag, const char *contents);
-
    -
    - -

    Parameters

    -
    -
    vc
    -
    Pointer to a vorbis_comment structure to add the comment to.
    -
    tag
    -
    Pointer to the null-terminated tag string. The string will -be copied, so it can be freed or modified after this function returns -without affecting the vorbis_comment structure's contents.
    -
    contents
    -
    Pointer to the null-terminated comment contents string. This will -also be copied.
    -
    - - -

    Return Values

    -
    -
  • None.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_comment_clear.html b/contrib/vorbis/doc/libvorbis/vorbis_comment_clear.html deleted file mode 100644 index 0771d6e..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_comment_clear.html +++ /dev/null @@ -1,69 +0,0 @@ - - - -libvorbis - function - vorbis_comment_clear - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_comment_clear

    - -

    declared in "vorbis/codec.h";

    - -

    This function frees the internal storage associated with a vorbis_comment structure.

    - -

    Note: Be careful if you have modified the vorbis_comment -structure yourself, as libvorbis will try to use its own wrappers of -memory allocation functions to free the contents of the vorbis_comment -structure. This will not work correctly unless all arrays and comment -strings contained in the vorbis_comment structure were allocated by -libvorbis itself. This function is only guaranteed to be safe if all -modification to the vorbis_comment structure was done using libvorbis -functions.

    - - - - - -
    -
    
-extern void     vorbis_comment_clear(vorbis_comment *vc);
-
    -
    - -

    Parameters

    -
    -
    vc
    -
    The vorbis_comment structure to clear.
    -
    - - -

    Return Values

    -
    -
  • None.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_comment_init.html b/contrib/vorbis/doc/libvorbis/vorbis_comment_init.html deleted file mode 100644 index abce0a6..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_comment_init.html +++ /dev/null @@ -1,72 +0,0 @@ - - - -libvorbis - function - vorbis_comment_init - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_comment_init

    - -

    declared in "vorbis/codec.h";

    - -

    This function initializes a vorbis_comment -structure for use. After calling this function, the vorbis_comment -structure contains no comments.

    - -

    Note: No internal storage is allocated by this function; -internal storage is allocated as needed by other libvorbis functions that -modify the vorbis_comment structure. If you modify the vorbis_comment -structure directly, without using libvorbis, you should not -call vorbis_comment_clear when -you are finished but instead clean up after it yourself. See the note -on the vorbis_comment_clear -page for more information.

    - - - - - -
    -
    
-extern void     vorbis_comment_init(vorbis_comment *vc);
-
    -
    - -

    Parameters

    -
    -
    vc
    -
    Pointer to the vorbis_comment -structure to initialize.
    -
    - - -

    Return Values

    -
    -
  • None.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_comment_query.html b/contrib/vorbis/doc/libvorbis/vorbis_comment_query.html deleted file mode 100644 index f958ebb..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_comment_query.html +++ /dev/null @@ -1,72 +0,0 @@ - - - -libvorbis - function - vorbis_comment_query - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_comment_query

    - -

    declared in "vorbis/codec.h";

    - -

    This function retrieves a comment string for a given tag in a -vorbis_comment structure.

    - - - - - -
    -
    
-extern char    *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count);
-
    -
    - -

    Parameters

    -
    -
    vc
    -
    Pointer to the vorbis_comment structure.
    -
    tag
    -
    Pointer to a null-terminated string of the comment tag to look -for. Tags are compared case-insensitively.
    -
    count
    -
    The index of the comment string to retrieve. A value of 0 indicates -the first comment whose tag matches tag. Use -vorbis_comment_query_count -to determine the number of matching comments.
    -
    - - -

    Return Values

    -
    -
  • A pointer to the comment string. The underlying buffer is owned by -the vorbis_comment structure.
    • -
  • NULL on a nonexistent tag or if count is greater than or -equal to the number of matching comments.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_comment_query_count.html b/contrib/vorbis/doc/libvorbis/vorbis_comment_query_count.html deleted file mode 100644 index e8a04f4..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_comment_query_count.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libvorbis - function - vorbis_comment_query_count - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_comment_query_count

    - -

    declared in "vorbis/codec.h";

    - -

    This function determines the number of comments with a given tag -that are present in a vorbis_comment -structure.

    - - - - - -
    -
    
-extern int      vorbis_comment_query_count(vorbis_comment *vc, const char *tag);
-
    -
    - -

    Parameters

    -
    -
    vc
    -
    Pointer to the vorbis_comment structure.
    -
    tag
    -
    Pointer to a null-terminated string of the comment tag to look -for. Tags are compared case-insensitively.
    -
    - - -

    Return Values

    -
    -
  • The number of comments present with the given tag.
    • -
  • 0 if no such comments are present.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_commentheader_out.html b/contrib/vorbis/doc/libvorbis/vorbis_commentheader_out.html deleted file mode 100644 index 0dd63d6..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_commentheader_out.html +++ /dev/null @@ -1,65 +0,0 @@ - - - -libvorbis - function - vorbis_commentheader_out - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_commentheader_out

    - -

    declared in "vorbis/codec.h";

    - -

    This function encodes the contents of a -vorbis_comment structure into an -ogg_packet.

    - - - - - -
    -
    
-extern int      vorbis_commentheader_out(vorbis_comment *vc, ogg_packet *op);
-
    -
    - -

    Parameters

    -
    -
    vc
    -
    The vorbis_comment structure to encode.
    -
    op
    -
    The ogg_packet to place the encoded comment packet into.
    -
    - - -

    Return Values

    -
    -
  • 0 on success.
    • -
  • OV_EIMPL on error.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_dsp_clear.html b/contrib/vorbis/doc/libvorbis/vorbis_dsp_clear.html deleted file mode 100644 index 0a9b959..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_dsp_clear.html +++ /dev/null @@ -1,63 +0,0 @@ - - - -libvorbis - function - vorbis_dsp_clear - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_dsp_clear

    - -

    declared in "vorbis/codec.h";

    - -

    This function frees the internal storage for a vorbis_dsp_state -structure. This can be used independent of whether the vorbis_dsp_state -is set up for analysis (encoding) or synthesis (decoding).

    - - - - - -
    -
    
-extern void     vorbis_dsp_clear(vorbis_dsp_state *v);
-
    -
    - -

    Parameters

    -
    -
    v
    -
    Pointer to the vorbis_dsp_state to be cleared.
    -
    - - -

    Return Values

    -
    -
  • -None
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_dsp_state.html b/contrib/vorbis/doc/libvorbis/vorbis_dsp_state.html deleted file mode 100644 index b8baf9c..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_dsp_state.html +++ /dev/null @@ -1,57 +0,0 @@ - - - -libvorbis - datatype - vorbis_dsp_state - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_dsp_state

    - -

    declared in "vorbis/codec.h"

    - -

    -The vorbis_dsp_state structure is the state for one instance of the -Vorbis encoder or decoder. -

    -This structure is intended to be private. Although the fields are given -in the header file, they should not be directly modified or relied upon -in any way. -

    - - - - - -
    -
    typedef struct vorbis_dsp_state{
-  /* private */
-} vorbis_dsp_state;
    -
    - -

    Parameters

    -
    • None public.
    - - -

    -
    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_granule_time.html b/contrib/vorbis/doc/libvorbis/vorbis_granule_time.html deleted file mode 100644 index f5c8b7f..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_granule_time.html +++ /dev/null @@ -1,65 +0,0 @@ - - - -libvorbis - function - vorbis_granule_time - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_granule_time

    - -

    declared in "vorbis/codec.h";

    - -

    This function converts a granule position to a time for a given Vorbis stream.

    - - - - - -
    -
    
-extern double   vorbis_granule_time(vorbis_dsp_state *v,
-                                    ogg_int64_t granulepos);
-
    -
    - -

    Parameters

    -
    -
    v
    -
    Pointer to the vorbis_dsp_state for the stream.
    -
    granulepos
    -
    The granule position.
    -
    - - -

    Return Values

    -
    -
  • -The time (in seconds) corresponding to the granulepos.
    • -
  • -1 if the given granulepos is negative
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_info.html b/contrib/vorbis/doc/libvorbis/vorbis_info.html deleted file mode 100644 index 2a06c06..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_info.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -libvorbis - datatype - vorbis_info - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    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 © 2000-2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_info_blocksize.html b/contrib/vorbis/doc/libvorbis/vorbis_info_blocksize.html deleted file mode 100644 index f256d24..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_info_blocksize.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libvorbis - function - vorbis_info_blocksize - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_info_blocksize

    - -

    declared in "vorbis/codec.h";

    - -

    This function gets the possible sizes for encoded blocks. There -are short blocks (zo = 0) and long blocks (zo = 1). The size of a long -block is guaranteed to be greater than or equal to the size of a short -block.

    - - - - - -
    -
    
-extern int      vorbis_info_blocksize(vorbis_info *vi,int zo);
-
    -
    - -

    Parameters

    -
    -
    vi
    -
    Pointer to the vorbis_info struct.
    -
    zo
    -
    Integer for which block size to get: 0 for short and 1 for long
    -
    - - -

    Return Values

    -
    -
  • A positive integer for the block size.
    • -
  • -1 on error.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_info_clear.html b/contrib/vorbis/doc/libvorbis/vorbis_info_clear.html deleted file mode 100644 index 907be6f..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_info_clear.html +++ /dev/null @@ -1,61 +0,0 @@ - - - -libvorbis - function - vorbis_info_clear - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_info_clear

    - -

    declared in "vorbis/codec.h";

    - -

    This function frees the internal storage for a vorbis_info structure.

    - - - - - -
    -
    
-extern void     vorbis_info_clear(vorbis_info *vi);
-
    -
    - -

    Parameters

    -
    -
    vi
    -
    Pointer to a vorbis_info struct to be cleared.
    -
    - - -

    Return Values

    -
    -
  • -None.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_info_init.html b/contrib/vorbis/doc/libvorbis/vorbis_info_init.html deleted file mode 100644 index a0e58fb..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_info_init.html +++ /dev/null @@ -1,62 +0,0 @@ - - - -libvorbis - function - vorbis_info_init - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_info_init

    - -

    declared in "vorbis/codec.h";

    - -

    This function initializes a vorbis_info -structure and allocates its internal storage.

    - - - - - -
    -
    
-extern void     vorbis_info_init(vorbis_info *vi);
-
    -
    - -

    Parameters

    -
    -
    vi
    -
    Pointer to a vorbis_info struct to be initialized.
    -
    - - -

    Return Values

    -
    -
  • -None.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_packet_blocksize.html b/contrib/vorbis/doc/libvorbis/vorbis_packet_blocksize.html deleted file mode 100644 index 827e03f..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_packet_blocksize.html +++ /dev/null @@ -1,66 +0,0 @@ - - - -libvorbis - function - vorbis_packet_blocksize - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_packet_blocksize

    - -

    declared in "vorbis/codec.h";

    - -

    This function gets the size of the block that would result from -decoding a Vorbis packet but does not actually decode the packet.

    - - - - - -
    -
    
-extern long     vorbis_packet_blocksize(vorbis_info *vi,ogg_packet *op);
-
    -
    - -

    Parameters

    -
    -
    vi
    -
    The vorbis_info structure for the -stream the packet is from.
    -
    op
    -
    The packet to get the block size of.
    -
    - - -

    Return Values

    -
    -
  • The block size on success.
    • -
  • OV_ENOTAUDIO if the packet is not an audio packet.
    • -
  • OV_EBADPACKET if there was an error in the packet.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis.html deleted file mode 100644 index 38ac4ed..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis.html +++ /dev/null @@ -1,70 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis

    - -

    declared in "vorbis/codec.h";

    - -

    This function decodes a Vorbis packet into a block of data. The -vorbis_block should then be submitted -to the vorbis_dsp_state -for the decoder instance using -vorbis_synthesis_blockin -to be assembled into the final decoded audio.

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

    Parameters

    -
    -
    vb
    -
    The vorbis_block to decode the -packet into.
    -
    op
    -
    The ogg_packet to decode.
    -
    - - -

    Return Values

    -
    -
  • 0 on success.
    • -
  • OV_ENOTAUDIO if the packet is not an audio packet.
    • -
  • OV_EBADPACKET if there was an error in the packet.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_blockin.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_blockin.html deleted file mode 100644 index d12fd2a..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_blockin.html +++ /dev/null @@ -1,69 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_blockin - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_blockin

    - -

    declared in "vorbis/codec.h";

    - -

    This function submits a vorbis_block -for assembly into the final decoded audio. After calling -this function, decoded audio can be obtained with -vorbis_synthesis_pcmout.

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

    Parameters

    -
    -
    v
    -
    The vorbis_dsp_state for the -decoder instance.
    -
    vb
    -
    The vorbis_block to submit. After -this function returns, it can be reused in another call to -vorbis_synthesis.
    -
    - - -

    Return Values

    -
    -
  • 0 on success.
    • -
  • OV_EINVAL if the decoder is in an invalid state to accept blocks.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_halfrate.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_halfrate.html deleted file mode 100644 index fefe8d3..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_halfrate.html +++ /dev/null @@ -1,68 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_halfrate - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_halfrate

    - -

    declared in "vorbis/codec.h";

    - -

    This function puts the Vorbis decoder into or out of half-rate -mode. In half-rate mode, the audio is decoded to only half its original -sampling rate. Half-rate mode speeds up decoding at the expense of -decoded audio quality.

    - - - - - -
    -
    
-extern int      vorbis_synthesis_halfrate(vorbis_info *v,int flag);
-
    -
    - -

    Parameters

    -
    -
    v
    -
    The vorbis_info structure for the -decoder instance.
    -
    flag
    -
    Whether half-rate mode is to be turned on or off. Zero turns it off; -nonzero turns it on.
    -
    - - -

    Return Values

    -
    -
  • 0 on success.
    • -
  • -1 if half-rate mode could not be set.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_halfrate_p.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_halfrate_p.html deleted file mode 100644 index d82880e..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_halfrate_p.html +++ /dev/null @@ -1,64 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_halfrate_p - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_halfrate_p

    - -

    declared in "vorbis/codec.h";

    - -

    This function gets whether a decoder is in half-rate mode. See -vorbis_synthesis_halfrate -for more information on half-rate mode.

    - - - - - -
    -
    
-extern int      vorbis_synthesis_halfrate_p(vorbis_info *v);
-
    -
    - -

    Parameters

    -
    -
    v
    -
    The vorbis_info structure for the -decoder instance.
    -
    - - -

    Return Values

    -
    -
  • 1 if half-rate mode is on.
    • -
  • 0 if half-rate mode is off.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_headerin.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_headerin.html deleted file mode 100644 index 835d8ce..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_headerin.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_headerin - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_headerin

    - -

    declared in "vorbis/codec.h";

    - -

    This function decodes a header packet from a Vorbis stream and applies -the contents to the given vorbis_info -structure (to provide codec parameters to the decoder) and -vorbis_comment structure (to provide -access to the embedded Vorbis comments).

    - -

    Once the three Vorbis header packets (info, comments, -and codebooks, in that order) have been passed to this -function, the vorbis_info -structure is ready to be used in a call to -vorbis_synthesis_init.

    - - - - - -
    -
    
-extern int      vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,
-                                          ogg_packet *op);
-
    -
    - -

    Parameters

    -
    -
    vi
    -
    The vorbis_info structure to apply -the decoded information to.
    -
    vc
    -
    The vorbis_comment structure to -apply the decoded comments to.
    -
    op
    -
    The ogg_packet to decode.
    -
    - - -

    Return Values

    -
    -
  • 0 on success.
    • -
  • OV_ENOTVORBIS if the packet is not a Vorbis header packet.
    • -
  • OV_EBADHEADER if there was an error interpreting the packet.
    • -
  • OV_EFAULT on internal error.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_idheader.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_idheader.html deleted file mode 100644 index 7fe99e9..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_idheader.html +++ /dev/null @@ -1,63 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_idheader - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_idheader

    - -

    declared in "vorbis/codec.h";

    - -

    This function checks whether a packet is a valid Vorbis identification -header packet. This function can be used to detect whether a logical -Ogg stream could be a Vorbis stream, given its very first packet.

    - - - - - -
    -
    
-extern int      vorbis_synthesis_idheader(ogg_packet *op);
-
    -
    - -

    Parameters

    -
    -
    op
    -
    Pointer to the ogg_packet to check.
    -
    - - -

    Return Values

    -
    -
  • 1 if the packet is a valid first packet for a Vorbis bitstream.
    • -
  • 0 if not.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_init.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_init.html deleted file mode 100644 index 64f06b9..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_init.html +++ /dev/null @@ -1,69 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_init - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_init

    - -

    declared in "vorbis/codec.h";

    - -

    This function initializes a -vorbis_dsp_state structure for -decoding and allocates internal storage for it.

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

    Parameters

    -
    -
    v
    -
    The vorbis_dsp_state to initialize -for decoding.
    -
    vi
    -
    The vorbis_info structure -for the stream. The vorbis_info structure must have had vorbis_synthesis_headerin -called on it for each header packet in the stream.
    -
    - - -

    Return Values

    -
    -
  • 0 on success.
    • -
  • 1 on error.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_lapout.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_lapout.html deleted file mode 100644 index 7fcdf06..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_lapout.html +++ /dev/null @@ -1,74 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_lapout - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_lapout

    - -

    declared in "vorbis/codec.h";

    - -

    This function retrieves buffers containing decoded audio samples, similarly -to vorbis_synthesis_pcmout. -However, it includes some extra samples extrapolated from the end of -the audio, suitable for crosslapping with other blocks. This exists mainly -for libvorbisfile to use for -handling chained bitstreams and bitstreams with holes.

    - - - - - -
    -
    
-extern int      vorbis_synthesis_lapout(vorbis_dsp_state *v,float ***pcm);
-
    -
    - -

    Parameters

    -
    -
    v
    -
    The vorbis_dsp_state for the -decoder instance.
    -
    pcm
    -
    A pointer to a float** which will be made to point to an array of -pointers to the decoded samples for each channel. The memory is owned -by the decoder instance and will be freed when the application continues -decoding or destroys the decoder instance. This can be NULL, in which -case the return value gives the number of samples that would be returned -if this function were called with a non-NULL pointer here.
    -
    - - -

    Return Values

    -
    -
  • The number of samples available in the output buffer.
    • -
  • 0 if no more samples are currently available.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_pcmout.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_pcmout.html deleted file mode 100644 index 0283d88..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_pcmout.html +++ /dev/null @@ -1,75 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_pcmout - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_pcmout

    - -

    declared in "vorbis/codec.h";

    - -

    This function retrieves buffers containing decoded audio samples.

    -

    The application is not required to make use of all of the samples -made available to it by one call to this function before it continues to -decode. Use vorbis_synthesis_read -to inform the decoder of how many samples were actually used. Any -unused samples will be included in the buffers output by the next call -to this function.

    - - - - - -
    -
    
-extern int      vorbis_synthesis_pcmout(vorbis_dsp_state *v,float ***pcm);
-
    -
    - -

    Parameters

    -
    -
    v
    -
    The vorbis_dsp_state for the -decoder instance.
    -
    pcm
    -
    A pointer to a float** which will be made to point to an array of -pointers to the decoded samples for each channel. The memory is owned -by the decoder instance and will be freed when the application continues -decoding or destroys the decoder instance. This can be NULL, in which -case the return value gives the number of samples that would be returned -if this function were called with a non-NULL pointer here.
    -
    - - -

    Return Values

    -
    -
  • The number of samples available in the output buffer.
    • -
  • 0 if no more samples are currently available.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_read.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_read.html deleted file mode 100644 index 4972a85..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_read.html +++ /dev/null @@ -1,67 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_read - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_read

    - -

    declared in "vorbis/codec.h";

    - -

    This function informs the Vorbis decoder of how many -samples the application used from the last buffer output by -vorbis_synthesis_pcmout.

    - - - - - -
    -
    
-extern int      vorbis_synthesis_read(vorbis_dsp_state *v,int samples);
-
    -
    - -

    Parameters

    -
    -
    v
    -
    The vorbis_dsp_state for the -decoder instance.
    -
    samples
    -
    The number of samples the application has used.
    -
    - - -

    Return Values

    -
    -
  • 0 on success.
    • -
  • OV_EINVAL if samples is greater than the number of remaining -samples in the buffer.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_restart.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_restart.html deleted file mode 100644 index c02385e..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_restart.html +++ /dev/null @@ -1,64 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_restart - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_restart

    - -

    declared in "vorbis/codec.h";

    - -

    This function restores a -vorbis_dsp_state structure -representing a decoder to its freshly-initialized state. This should be -called if the application seeks within a Vorbis bitstream.

    - - - - - -
    -
    
-extern int      vorbis_synthesis_restart(vorbis_dsp_state *v);
-
    -
    - -

    Parameters

    -
    -
    v
    -
    The vorbis_dsp_state to reset.
    -
    - - -

    Return Values

    -
    -
  • 0 on success.
    • -
  • -1 on error.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_trackonly.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis_trackonly.html deleted file mode 100644 index dd3e685..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_synthesis_trackonly.html +++ /dev/null @@ -1,71 +0,0 @@ - - - -libvorbis - function - vorbis_synthesis_trackonly - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_synthesis_trackonly

    - -

    declared in "vorbis/codec.h";

    - -

    This function decodes a Vorbis packet similarly to -vorbis_synthesis, except that the -vorbis_block produced does not contain -any audio data but merely updates the decoder's state as though the -block had been actually decoded when -vorbis_synthesis_blockin -is called on it.

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

    Parameters

    -
    -
    vb
    -
    The vorbis_block to decode the -packet into.
    -
    op
    -
    The ogg_packet to decode.
    -
    - - -

    Return Values

    -
    -
  • 0 on success.
    • -
  • OV_ENOTAUDIO if the packet is not an audio packet.
    • -
  • OV_EBADPACKET if there was an error in the packet.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - diff --git a/contrib/vorbis/doc/libvorbis/vorbis_version_string.html b/contrib/vorbis/doc/libvorbis/vorbis_version_string.html deleted file mode 100644 index e85f23e..0000000 --- a/contrib/vorbis/doc/libvorbis/vorbis_version_string.html +++ /dev/null @@ -1,56 +0,0 @@ - - - -libvorbis - function - vorbis_version_string - - - - - - - - - -

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - -

    vorbis_version_string

    - -

    declared in "vorbis/codec.h";

    - -

    This function returns a string giving version information for libvorbis. (This is not the same string that libvorbis encodes into the vendor field of comment headers.)

    - - - - - -
    -
    
-extern const char *vorbis_version_string(void);
-
    -
    - -

    Parameters

    -

    None.

    - -

    Return Values

    -
    -
  • The libvorbis version string. The string is in static storage.
    • -
    -

    - -

    -

    - - - - - - - - -

    copyright © 2010 Xiph.Org

    Ogg Vorbis

    libvorbis documentation

    libvorbis version 1.3.2 - 20101101

    - - - - - -- cgit v1.1