diff options
Diffstat (limited to 'contrib/vorbis/doc/libvorbis')
46 files changed, 0 insertions, 3163 deletions
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 @@ -<html> - -<head> -<title>libvorbis - Documentation</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>Libvorbis Documentation</h1> - -<p> -Libvorbis contains the Vorbis reference encoder and decoder. -<p> -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 <a -href="../vorbisfile/index.html">vorbisfile</a> rather than using libogg -and libvorbis directly. -<p> -<a href="overview.html">Libvorbis API overview</a><br> -<a href="reference.html">Libvorbis API reference</a><br> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - API Overview</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>Libvorbis API Overview</h1> - -<p>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.</p> - -<p>All libvorbis routines and structures are declared in "vorbis/codec.h".</p> - -<h2>Encoding workflow</h2> - -<ol> -<li>Initialize a <a href="vorbis_info.html">vorbis_info</a> structure -by calling <a href="vorbis_info_init.html">vorbis_info_init</a> and -then functions from <a href="../vorbisenc/index.html">libvorbisenc</a> -on it.</li> -<li>Initialize a <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> -for encoding based on the parameters in the vorbis_info by using <a -href="vorbis_analysis_init.html">vorbis_analysis_init</a>.</li> -<li>Initialize a <a href="vorbis_comment.html">vorbis_comment</a> -structure using <a href="vorbis_comment_init.html">vorbis_comment_init</a>, -populate it with any comments you wish to store in the stream, and call -<a href="vorbis_analysis_headerout.html">vorbis_analysis_headerout</a> to -get the three Vorbis stream header packets. Output the packets.</li> -<li>Initialize a <a href="vorbis_block.html">vorbis_block</a> structure -using <a href="vorbis_block_init.html">vorbis_block_init</a>.</li> -<li>While there is more audio to encode:<ol> -<li>Submit a chunk of audio data using <a -href="vorbis_analysis_buffer.html">vorbis_analysis_buffer</a> and <a -href="vorbis_analysis_wrote.html">vorbis_analysis_wrote</a>.</li> -<li>Obtain all available blocks using <a -href="vorbis_analysis_blockout.html">vorbis_analysis_blockout</a> -in a loop. For each block obtained:<ol> -<li>Encode the block into a packet (or prepare it for bitrate management) -using <a href="vorbis_analysis.html">vorbis_analysis</a>. (It's a good -idea to always pass the blocks through the bitrate -management mechanism; more information is on the <a -href="vorbis_analysis.html">vorbis_analysis</a> page. It does not affect -the resulting packets unless you are actually using a bitrate-managed -mode.)</li> -<li>If you are using bitrate management, submit the block using <a -href="vorbis_bitrate_addblock.html">vorbis_bitrate_addblock</a> and obtain -packets using <a -href="vorbis_bitrate_flushpacket.html">vorbis_bitrate_flushpacket</a>.</li> -<li>Output any obtained packets.</li> -</ol></li> -</ol></li> -<li>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.</li> -<li>Destroy the structures using the appropriate vorbis_*_clear routines.</li> -</ol> - -<h2>Decoding workflow</h2> - -<em>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 -<a href="../vorbisfile/index.html">libvorbisfile</a> 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.</em> - -<ol> -<li>When reading the header packets of an Ogg stream, you can use <a -href="vorbis_synthesis_idheader.html">vorbis_synthesis_idheader</a> to -check whether a stream might be Vorbis.</li> -<li>Initialize a <a href="vorbis_info.html">vorbis_info</a> and a <a -href="vorbis_comment.html">vorbis_comment</a> structure using the -appropriate vorbis_*_init routines, then pass the first three packets -from the stream (the Vorbis stream header packets) to <a -href="vorbis_synthesis_headerin.html">vorbis_synthesis_headerin</a> in -order. At this point, you can see the comments and basic parameters of -the Vorbis stream.</li> -<li>Initialize a <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> -for decoding based on the parameters in the vorbis_info by using <a -href="vorbis_synthesis_init.html">vorbis_synthesis_init</a>.</li> -<li>Initialize a <a href="vorbis_block.html">vorbis_block</a> structure -using <a href="vorbis_block_init.html">vorbis_block_init</a>.</li> -<li>While there are more packets to decode:<ol> -<li>Decode the next packet into a block using <a -href="vorbis_synthesis.html">vorbis_synthesis</a>.</li> -<li>Submit the block to the reassembly layer using <a -href="vorbis_synthesis_blockin.html">vorbis_synthesis_blockin</a>.</li> -<li>Obtain some decoded audio using <a -href="vorbis_synthesis_pcmout.html">vorbis_synthesis_pcmout</a> and <a -href="vorbis_synthesis_read.html">vorbis_synthesis_read</a>. Any audio data -returned but not marked as consumed using vorbis_synthesis_read carries -over to the next call to vorbis_synthesis_pcmout.</li> -</ol></li> -<li>Destroy the structures using the appropriate vorbis_*_clear routines.</li> -</ol> - -<h2>Metadata workflow</h2> - -<em>Note: if you do not need to do anything more involved than just -reading the metadata from an Ogg Vorbis file, <a -href="../vorbisfile/index.html">libvorbisfile</a> can do this for you.</em> - -<ol> -<li>Follow the decoding workflow above until you have access to the comments -and basic parameters of the Vorbis stream.</li> -<li>If you want to alter the comments, copy the first packet to the output -file, then create a packet for the modified comments using <a -href="vorbis_commentheader_out.html">vorbis_commentheader_out</a> and output -it, then copy the third packet and all subsequent packets into the output -file.</li> -</ol> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -</body> - -</html> - 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 @@ -<html> - -<head> -<title>Libvorbis API Reference</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>Libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>Libvorbis API Reference</h1> - -<p> -<b>Data Structures</b><br> -<a href="vorbis_block.html">vorbis_block</a><br> -<a href="vorbis_comment.html">vorbis_comment</a><br> -<a href="vorbis_dsp_state.html">vorbis_dsp_state</a><br> -<a href="vorbis_info.html">vorbis_info</a><br> -<br> -<b>Functions used by both decode and encode</b><br> -<a href="vorbis_block_clear.html">vorbis_block_clear()</a><br> -<a href="vorbis_block_init.html">vorbis_block_init()</a><br> -<a href="vorbis_dsp_clear.html">vorbis_dsp_clear()</a><br> -<a href="vorbis_granule_time.html">vorbis_granule_time()</a><br> -<a href="vorbis_info_blocksize.html">vorbis_info_blocksize()</a><br> -<a href="vorbis_info_clear.html">vorbis_info_clear()</a><br> -<a href="vorbis_info_init.html">vorbis_info_init()</a><br> -<a href="vorbis_version_string.html">vorbis_version_string()</a><br> -<br> -<b>Decoding</b><br> -<a href="vorbis_packet_blocksize.html">vorbis_packet_blocksize()</a><br> -<a href="vorbis_synthesis.html">vorbis_synthesis()</a><br> -<a href="vorbis_synthesis_blockin.html">vorbis_synthesis_blockin()</a><br> -<a href="vorbis_synthesis_halfrate.html">vorbis_synthesis_halfrate()</a><br> -<a href="vorbis_synthesis_halfrate_p.html">vorbis_synthesis_halfrate_p()</a><br> -<a href="vorbis_synthesis_headerin.html">vorbis_synthesis_headerin()</a><br> -<a href="vorbis_synthesis_idheader.html">vorbis_synthesis_idheader()</a><br> -<a href="vorbis_synthesis_init.html">vorbis_synthesis_init()</a><br> -<a href="vorbis_synthesis_lapout.html">vorbis_synthesis_lapout()</a><br> -<a href="vorbis_synthesis_pcmout.html">vorbis_synthesis_pcmout()</a><br> -<a href="vorbis_synthesis_read.html">vorbis_synthesis_read()</a><br> -<a href="vorbis_synthesis_restart.html">vorbis_synthesis_restart()</a><br> -<a href="vorbis_synthesis_trackonly.html">vorbis_synthesis_trackonly()</a><br> -<br> -<b>Encoding</b><br> -<a href="vorbis_analysis.html">vorbis_analysis()</a><br> -<a href="vorbis_analysis_blockout.html">vorbis_analysis_blockout()</a><br> -<a href="vorbis_analysis_buffer.html">vorbis_analysis_buffer()</a><br> -<a href="vorbis_analysis_headerout.html">vorbis_analysis_headerout()</a><br> -<a href="vorbis_analysis_init.html">vorbis_analysis_init()</a><br> -<a href="vorbis_analysis_wrote.html">vorbis_analysis_wrote()</a><br> -<a href="vorbis_bitrate_addblock.html">vorbis_bitrate_addblock()</a><br> -<a href="vorbis_bitrate_flushpacket.html">vorbis_bitrate_flushpacket()</a><br> -<br> -<b>Metadata</b><br> -<a href="vorbis_comment_add.html">vorbis_comment_add()</a><br> -<a href="vorbis_comment_add_tag.html">vorbis_comment_add_tag()</a><br> -<a href="vorbis_comment_clear.html">vorbis_comment_clear()</a><br> -<a href="vorbis_comment_init.html">vorbis_comment_init()</a><br> -<a href="vorbis_comment_query.html">vorbis_comment_query()</a><br> -<a href="vorbis_comment_query_count.html">vorbis_comment_query_count()</a><br> -<a href="vorbis_commentheader_out.html">vorbis_commentheader_out()</a><br> -<br> -<b><a href="return.html">Return Codes</a></b><br> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - Return Codes</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>Return Codes</h1> - -<p> - -The following return codes are <tt>#define</tt>d in "vorbis/codec.h" and -may be returned by functions from libvorbis, <a -href="../vorbisfile/index.html">libvorbisfile</a>, and <a -href="../vorbisenc/index.html">libvorbisenc</a>. Descriptions of a code -relevant to a specific function are found in the reference description -of that function. - -<dl> - -<dt>OV_FALSE</dt> -<dd>Not true, or no data available</dd> - -<dt>OV_HOLE</dt> -<dd>Vorbisfile encoutered missing or corrupt data in the bitstream. Recovery -is normally automatic and this return code is for informational purposes only.</dd> - -<dt>OV_EREAD</dt> -<dd>Read error while fetching compressed data for decode</dd> - -<dt>OV_EFAULT</dt> -<dd>Internal inconsistency in encode or decode state. Continuing is likely not possible.</dd> - -<dt>OV_EIMPL</dt> -<dd>Feature not implemented</dd> - -<dt>OV_EINVAL</dt> -<dd>Either an invalid argument, or incompletely initialized argument passed to a call</dd> - -<dt>OV_ENOTVORBIS</dt> -<dd>The given file/data was not recognized as Ogg Vorbis data.</dd> - -<dt>OV_EBADHEADER</dt> -<dd>The file/data is apparently an Ogg Vorbis stream, but contains a corrupted or undecipherable header.</dd> - -<dt>OV_EVERSION</dt> -<dd>The bitstream format revision of the given stream is not supported.</dd> - -<dt>OV_EBADLINK</dt> -<dd>The given link exists in the Vorbis data stream, but is not decipherable due to garbacge or corruption.</dd> - -<dt>OV_ENOSEEK</dt> -<dd>The given stream is not seekable</dd> - -</dl> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_analysis</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_analysis</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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. -</p> -<p>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. -</p> -<p>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. -</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_analysis(vorbis_block *vb,ogg_packet *op); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vb</i></dt> -<dd>Pointer to the vorbis_block to be encoded.</dd> -<dt><i>op</i></dt> -<dd>Optional pointer to an ogg_packet. This is normally NULL, -and the final output is obtained by passing <i>vb</i> 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.</dd> -</dl> - - -<h3>Return Values</h3> -<ul> -<li>0 for success</li> -<li>negative values for failure: -<ul> -<li>OV_EINVAL - Invalid request; a non-NULL value was passed for <i>op</i> when the encoder is using a bitrate managed mode.</li> -<li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li> -<li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li> -</ul> -</li> -</ul> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_analysis_blockout</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_analysis_blockout</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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). -</p> -<p> -Each block returned should be passed to vorbis_analysis() for transform -and coding. -</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_analysis_blockout(vorbis_dsp_state *v,vorbis_block *vb); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>Pointer to the vorbis_dsp_state representing the encoder.</dd> -<dt><i>vb</i></dt> -<dd>Pointer to a previously initialized vorbis_block object to hold the -returned data. -</dl> - - -<h3>Return Values</h3> -<ul> -<li>1 for success when more blocks are available.</li> -<li>0 for success when this is the last block available from the current input.</li> -<li>negative values for failure: -<ul> -<li>OV_EINVAL - Invalid parameters.</li> -<li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li> -<li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li> -</ul> -</li> - -</ul> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_analysis_buffer</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_analysis_buffer</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This fuction requests a buffer array for delivering audio to the -encoder for compression.</p> - -<p>The Vorbis encoder expects the caller to write audio data as -non-interleaved floating point samples into its internal buffers. -</p> -<p> -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. -</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern float **vorbis_analysis_buffer(vorbis_dsp_state *v,int vals); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>Pointer to the vorbis_dsp_state representing the encoder.</dd> -<dt><i>vals</i></dt> -<dd>Number of samples to provide space for in the returned buffer. 1024 is a reasonable choice.</dd> -</dl> - - -<h3>Return Values</h3> -<p>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.<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_analysis_headerout</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_analysis_headerout</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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. -</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_analysis_headerout(vorbis_dsp_state *v, - vorbis_comment *vc, - ogg_packet *op, - ogg_packet *op_comm, - ogg_packet *op_code); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>Pointer to an initialized vorbis_dsp_state which holds the encoder configuration.</dd> -<dt><i>vc</i></dt> -<dd>Pointer to an initialized vorbis_comment structure which holds the metadata associated with the stream being encoded.</dd> -<dt><i>op</i></dt> -<dd>Pointer to an ogg_packet structure to be filled out with the stream identification header.</dd> -<dt><i>op_comm</i></dt> -<dd>Pointer to an ogg_packet structure to be filled out with the serialied vorbis_comment data.</dd> -<dt><i>op_code</i></dt> -<dd>Pointer to an ogg_packet structure to be filled out with the codebooks, mode descriptions, etc. which will be used encoding the stream.</dd> -</dl> - - -<h3>Return Values</h3> -<ul> -<li>0 for success</li> -<li>negative values for failure: -<ul> -<li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li> -<li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li> -</ul> -</li> -</ul> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_analysis_init</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_analysis_init</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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. -</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_analysis_init(vorbis_dsp_state *v,vorbis_info *vi); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i</dt> -<dd>Pointer to the vorbis_dsp_state structure to be initialized for encoding.</dd> -<dt><i>vi</i></dt> -<dd>Pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct describing the encoder configuration.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_analysis_wrote</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_analysis_wrote</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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(). -</p> - -<p> -Call with the <i>vals</i> parameter set to zero to signal the end -of the input data. -</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_analysis_wrote(vorbis_dsp_state *v,int vals); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>Pointer to the vorbis_dsp_state representing the encoder.</dd> -<dt><i>vals</i></dt> -<dd>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.</dd> -</dl> - - -<h3>Return Values</h3> -<ul> -<li>0 for success</li> -<li>negative values for failure: -<ul> -<li>OV_EINVAL - Invalid request; e.g. vals overflows the allocated space.</li> -<li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li> -<li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li> -</ul> -</li> -</ul> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_bitrate_addblock</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_bitrate_addblock</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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.</p> - -<p>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. -</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_bitrate_addblock(vorbis_block *vb); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vb</i></dt> -<dd>Pointer to the vorbis_block to be submitted.</dd> -</dl> - - -<h3>Return Values</h3> -<ul> -<li>0 for success.</li> -<li>negative values for failure: -<ul> -<li>OV_EINVAL - Invalid parameters.</li> -<li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li> -<li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li> -</ul> -</li> - -</ul> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_bitrate_flushpacket</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_bitrate_flushpacket</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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). -</p> - -<p> -The data returned in the ogg_packet structure can be copied to the -final compressed output stream. -</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_bitrate_flushpacket(vorbis_dsp_state *vd, - ogg_packet *op); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vd</i></dt> -<dd>Pointer to the vorbis_dsp_state represending the encoder.</dd> -<dt><i>op</i></dt> -<dd>Pointer to an ogg_packet to be filled out with the compressed data.</dd> -</dl> - - -<h3>Return Values</h3> -<ul> -<li>1 for success when more packets are available. -<li>0 for success when this is the last packet available from the current input.</li> -<li>negative values for failure: -<ul> -<li>OV_EINVAL - Invalid parameters.</li> -<li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li> -<li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li> -</ul> -</li> - -</ul> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - datatype - vorbis_block</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_block</h1> - -<p><i>declared in "vorbis/codec.h"</i></p> - -<p> -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. -<p> -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. -<p> - -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b>typedef struct vorbis_block{ - /* private */ -} vorbis_block;</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<ul><li>None public.</li></ul> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_block_clear</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_block_clear</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function frees the internal storage for a vorbis_block structure.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_block_clear(vorbis_block *vb); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vb</i></dt> -<dd>Pointer to a vorbis_block struct to be cleared.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_block_init</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_block_init</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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. -</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_block_init(vorbis_dsp_state *v, vorbis_block *vb); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i</dt> -<dd>Pointer to an initialized vorbis_dsp_state with which to associate the new block.</dd> -<dt><i>vb</i></dt> -<dd>Pointer to a vorbis_block struct to be initialized.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -0 for success</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - datatype - vorbis_comment</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_comment</h1> - -<p><i>declared in "vorbis/codec.h"</i></p> - -<p> -The vorbis_comment structure defines an Ogg Vorbis comment. -<p> -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). -<p> -<i>Note:</i> When encoding, while it <i>is</i> supported to modify a -vorbis_comment structure directly, be sure to read the notes on the -<a href="vorbis_comment_init.html">vorbis_comment_init</a> and -<a href="vorbis_comment_clear.html">vorbis_comment_clear</a> pages for -considerations on memory allocation and freeing before you do so. Rule of -thumb: call vorbis_comment_init, then <i>either</i> do all allocation, -freeing, and modification yourself and <i>do not</i> call -vorbis_comment_clear, <i>or</i> do all modification using libvorbis -functions and <i>do</i> call vorbis_comment_clear. -<p> - -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b>typedef struct vorbis_comment{ - /* unlimited user comment fields. */ - char **user_comments; - int *comment_lengths; - int comments; - char *vendor; - -} vorbis_comment;</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>user_comments</i></dt> -<dd>Unlimited user comment array. The individual strings in the array are 8 bit clean, by the Vorbis specification, and as such the <tt>comment_lengths</tt> 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).</dd> -<dt><i>comment_lengths</i></dt> -<dd>An int array that stores the length of each comment string</dd> -<dt><i>comments</i></dt> -<dd>Int signifying number of user comments in user_comments field.</dd> -<dt><i>vendor</i></dt> -<dd>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.</dd> -</dl> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_comment_add</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_comment_add</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function adds a raw comment string to a -<a href="vorbis_comment.html">vorbis_comment</a> structure.</p> - -<p>This function should be used if the string is already in the -form "KEY=value". If you have a separate key and value, use -<a href="vorbis_comment_add_tag.html">vorbis_comment_add_tag</a> -instead.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern void vorbis_comment_add(vorbis_comment *vc, const char *comment); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vc</i></dt> -<dd>Pointer to a vorbis_comment structure to add the comment to.</dd> -<dt><i>comment</i></dt> -<dd>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.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>None.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_comment_add_tag</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_comment_add_tag</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function adds a tag-comment pair to a -<a href="vorbis_comment.html">vorbis_comment</a> 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.</p> - -<p>If you already have a string in the form "KEY=value", see -<a href="vorbis_comment_add.html">vorbis_comment_add</a> instead.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern void vorbis_comment_add_tag(vorbis_comment *vc, - const char *tag, const char *contents); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vc</i></dt> -<dd>Pointer to a vorbis_comment structure to add the comment to.</dd> -<dt><i>tag</i></dt> -<dd>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.</dd> -<dt><i>contents</i></dt> -<dd>Pointer to the null-terminated comment contents string. This will -also be copied.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>None.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_comment_clear</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_comment_clear</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function frees the internal storage associated with a <a href="vorbis_comment.html">vorbis_comment</a> structure.</p> - -<p><i>Note:</i> 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.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern void vorbis_comment_clear(vorbis_comment *vc); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vc</i></dt> -<dd>The vorbis_comment structure to clear.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>None.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_comment_init</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_comment_init</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function initializes a <a href="vorbis_comment.html">vorbis_comment</a> -structure for use. After calling this function, the vorbis_comment -structure contains no comments.</p> - -<p><i>Note:</i> 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 <i>not</i> -call <a href="vorbis_comment_clear.html">vorbis_comment_clear</a> when -you are finished but instead clean up after it yourself. See the note -on the <a href="vorbis_comment_clear.html">vorbis_comment_clear</a> -page for more information.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern void vorbis_comment_init(vorbis_comment *vc); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vc</i></dt> -<dd>Pointer to the <a href="vorbis_comment.html">vorbis_comment</a> -structure to initialize.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>None.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_comment_query</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_comment_query</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function retrieves a comment string for a given tag in a -<a href="vorbis_comment.html">vorbis_comment</a> structure.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vc</i></dt> -<dd>Pointer to the vorbis_comment structure.</dd> -<dt><i>tag</i></dt> -<dd>Pointer to a null-terminated string of the comment tag to look -for. Tags are compared case-insensitively.</dd> -<dt><i>count</i></dt> -<dd>The index of the comment string to retrieve. A value of 0 indicates -the first comment whose tag matches <i>tag</i>. Use -<a href="vorbis_comment_query_count.html">vorbis_comment_query_count</a> -to determine the number of matching comments.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>A pointer to the comment string. The underlying buffer is owned by -the vorbis_comment structure.</li> -<li>NULL on a nonexistent tag or if <i>count</i> is greater than or -equal to the number of matching comments.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_comment_query_count</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_comment_query_count</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function determines the number of comments with a given tag -that are present in a <a href="vorbis_comment.html">vorbis_comment</a> -structure.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_comment_query_count(vorbis_comment *vc, const char *tag); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vc</i></dt> -<dd>Pointer to the vorbis_comment structure.</dd> -<dt><i>tag</i></dt> -<dd>Pointer to a null-terminated string of the comment tag to look -for. Tags are compared case-insensitively.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>The number of comments present with the given tag.</li> -<li>0 if no such comments are present.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_commentheader_out</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_commentheader_out</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function encodes the contents of a -<a href="vorbis_comment.html">vorbis_comment</a> structure into an -ogg_packet.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_commentheader_out(vorbis_comment *vc, ogg_packet *op); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vc</i></dt> -<dd>The vorbis_comment structure to encode.</dd> -<dt><i>op</i></dt> -<dd>The ogg_packet to place the encoded comment packet into.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 on success.</li> -<li>OV_EIMPL on error.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_dsp_clear</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_dsp_clear</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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).</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern void vorbis_dsp_clear(vorbis_dsp_state *v); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>Pointer to the vorbis_dsp_state to be cleared.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -None</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - datatype - vorbis_dsp_state</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_dsp_state</h1> - -<p><i>declared in "vorbis/codec.h"</i></p> - -<p> -The vorbis_dsp_state structure is the state for one instance of the -Vorbis encoder or decoder. -<p> -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. -<p> - -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b>typedef struct vorbis_dsp_state{ - /* private */ -} vorbis_dsp_state;</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<ul><li>None public.</li></ul> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_granule_time</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_granule_time</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function converts a granule position to a time for a given Vorbis stream.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern double vorbis_granule_time(vorbis_dsp_state *v, - ogg_int64_t granulepos); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>Pointer to the vorbis_dsp_state for the stream.</dd> -<dt><i>granulepos</i></dt> -<dd>The granule position.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -The time (in seconds) corresponding to the granulepos.</li> -<li>-1 if the given granulepos is negative</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - datatype - vorbis_info</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_info</h1> - -<p><i>declared in "vorbis/codec.h"</i></p> - -<p> -The vorbis_info structure contains basic information about the audio in a vorbis bitstream. -<p> - -<table border=0 width=100% color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b>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;</b></pre> - </td> -</tr> -</table> - -<h3>Relevant Struct Members</h3> -<dl> -<dt><i>version</i></dt> -<dd>Vorbis encoder version used to create this bitstream.</dd> -<dt><i>channels</i></dt> -<dd>Int signifying number of channels in bitstream.</dd> -<dt><i>rate</i></dt> -<dd>Sampling rate of the bitstream.</dd> -<dt><i>bitrate_upper</i></dt> -<dd>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.</dd> -<dt><i>bitrate_nominal</i></dt> -<dd>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.</dd> -<dt><i>bitrate_lower</i></dt> -<dd>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.</dd> -<dt><i>bitrate_window</i></dt> -<dd>Currently unset.</dd> - -<dt><i>codec_setup</i></dt> -<dd>Internal structure that contains the detailed/unpacked configuration for decoding the current Vorbis bitstream.</dd> -</dl> - - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_info_blocksize</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_info_blocksize</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_info_blocksize(vorbis_info *vi,int zo); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vi</i></dt> -<dd>Pointer to the vorbis_info struct.</dd> -<dt><i>zo</i></dt> -<dd>Integer for which block size to get: 0 for short and 1 for long</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>A positive integer for the block size.</li> -<li>-1 on error.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_info_clear</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_info_clear</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function frees the internal storage for a vorbis_info structure.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern void vorbis_info_clear(vorbis_info *vi); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vi</i></dt> -<dd>Pointer to a vorbis_info struct to be cleared.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -None.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_info_init</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_info_init</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function initializes a <a href="vorbis_info.html">vorbis_info</a> -structure and allocates its internal storage.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern void vorbis_info_init(vorbis_info *vi); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vi</i></dt> -<dd>Pointer to a vorbis_info struct to be initialized.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li> -None.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_packet_blocksize</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_packet_blocksize</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function gets the size of the block that would result from -decoding a Vorbis packet but does not actually decode the packet.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern long vorbis_packet_blocksize(vorbis_info *vi,ogg_packet *op); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vi</i></dt> -<dd>The <a href="vorbis_info.html">vorbis_info</a> structure for the -stream the packet is from.</dd> -<dt><i>op</i></dt> -<dd>The packet to get the block size of.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>The block size on success.</li> -<li>OV_ENOTAUDIO if the packet is not an audio packet.</li> -<li>OV_EBADPACKET if there was an error in the packet.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function decodes a Vorbis packet into a block of data. The -<a href="vorbis_block.html">vorbis_block</a> should then be submitted -to the <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> -for the decoder instance using -<a href="vorbis_synthesis_blockin.html">vorbis_synthesis_blockin</a> -to be assembled into the final decoded audio.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis(vorbis_block *vb,ogg_packet *op); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vb</i></dt> -<dd>The <a href="vorbis_block.html">vorbis_block</a> to decode the -packet into.</dd> -<dt><i>op</i></dt> -<dd>The ogg_packet to decode.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 on success.</li> -<li>OV_ENOTAUDIO if the packet is not an audio packet.</li> -<li>OV_EBADPACKET if there was an error in the packet.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_blockin</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_blockin</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function submits a <a href="vorbis_block.html">vorbis_block</a> -for assembly into the final decoded audio. After calling -this function, decoded audio can be obtained with -<a href="vorbis_synthesis_pcmout.html">vorbis_synthesis_pcmout</a>.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_blockin(vorbis_dsp_state *v,vorbis_block *vb); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> for the -decoder instance.</dd> -<dt><i>vb</i></dt> -<dd>The <a href="vorbis_block.html">vorbis_block</a> to submit. After -this function returns, it can be reused in another call to -<a href="vorbis_synthesis.html">vorbis_synthesis</a>.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 on success.</li> -<li>OV_EINVAL if the decoder is in an invalid state to accept blocks.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_halfrate</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_halfrate</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_halfrate(vorbis_info *v,int flag); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>The <a href="vorbis_info.html">vorbis_info</a> structure for the -decoder instance.</dd> -<dt><i>flag</i></dt> -<dd>Whether half-rate mode is to be turned on or off. Zero turns it off; -nonzero turns it on.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 on success.</li> -<li>-1 if half-rate mode could not be set.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_halfrate_p</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_halfrate_p</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function gets whether a decoder is in half-rate mode. See -<a href="vorbis_synthesis_halfrate.html">vorbis_synthesis_halfrate</a> -for more information on half-rate mode.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_halfrate_p(vorbis_info *v); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>The <a href="vorbis_info.html">vorbis_info</a> structure for the -decoder instance.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>1 if half-rate mode is on.</li> -<li>0 if half-rate mode is off.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_headerin</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_headerin</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function decodes a header packet from a Vorbis stream and applies -the contents to the given <a href="vorbis_info.html">vorbis_info</a> -structure (to provide codec parameters to the decoder) and -<a href="vorbis_comment.html">vorbis_comment</a> structure (to provide -access to the embedded Vorbis comments).</p> - -<p>Once the three Vorbis header packets (info, comments, -and codebooks, in that order) have been passed to this -function, the <a href="vorbis_info.html">vorbis_info</a> -structure is ready to be used in a call to -<a href="vorbis_synthesis_init.html">vorbis_synthesis_init</a>.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc, - ogg_packet *op); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vi</i></dt> -<dd>The <a href="vorbis_info.html">vorbis_info</a> structure to apply -the decoded information to.</dd> -<dt><i>vc</i></dt> -<dd>The <a href="vorbis_comment.html">vorbis_comment</a> structure to -apply the decoded comments to.</dd> -<dt><i>op</i></dt> -<dd>The ogg_packet to decode.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 on success.</li> -<li>OV_ENOTVORBIS if the packet is not a Vorbis header packet.</li> -<li>OV_EBADHEADER if there was an error interpreting the packet.</li> -<li>OV_EFAULT on internal error.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_idheader</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_idheader</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_idheader(ogg_packet *op); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>op</i></dt> -<dd>Pointer to the ogg_packet to check.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>1 if the packet is a valid first packet for a Vorbis bitstream.</li> -<li>0 if not.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_init</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_init</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function initializes a -<a href="vorbis_dsp_state.html">vorbis_dsp_state</a> structure for -decoding and allocates internal storage for it.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_init(vorbis_dsp_state *v,vorbis_info *vi); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> to initialize -for decoding.</dd> -<dt><i>vi</i></dt> -<dd>The <a href="vorbis_info.html">vorbis_info</a> structure -for the stream. The vorbis_info structure must have had <a -href="vorbis_synthesis_headerin.html">vorbis_synthesis_headerin</a> -called on it for each header packet in the stream.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 on success.</li> -<li>1 on error.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_lapout</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_lapout</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function retrieves buffers containing decoded audio samples, similarly -to <a href="vorbis_synthesis_pcmout.html">vorbis_synthesis_pcmout</a>. -However, it includes some extra samples extrapolated from the end of -the audio, suitable for crosslapping with other blocks. This exists mainly -for <a href="../vorbisfile/index.html">libvorbisfile</a> to use for -handling chained bitstreams and bitstreams with holes.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_lapout(vorbis_dsp_state *v,float ***pcm); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> for the -decoder instance.</dd> -<dt><i>pcm</i></dt> -<dd>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.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>The number of samples available in the output buffer.</li> -<li>0 if no more samples are currently available.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_pcmout</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_pcmout</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function retrieves buffers containing decoded audio samples.</p> -<p>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 <a href="vorbis_synthesis_read.html">vorbis_synthesis_read</a> -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.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_pcmout(vorbis_dsp_state *v,float ***pcm); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> for the -decoder instance.</dd> -<dt><i>pcm</i></dt> -<dd>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.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>The number of samples available in the output buffer.</li> -<li>0 if no more samples are currently available.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_read</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_read</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function informs the Vorbis decoder of how many -samples the application used from the last buffer output by -<a href="vorbis_synthesis_pcmout.html">vorbis_synthesis_pcmout</a>.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_read(vorbis_dsp_state *v,int samples); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> for the -decoder instance.</dd> -<dt><i>samples</i></dt> -<dd>The number of samples the application has used.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 on success.</li> -<li>OV_EINVAL if <i>samples</i> is greater than the number of remaining -samples in the buffer.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_restart</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_restart</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function restores a -<a href="vorbis_dsp_state.html">vorbis_dsp_state</a> structure -representing a decoder to its freshly-initialized state. This should be -called if the application seeks within a Vorbis bitstream.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_restart(vorbis_dsp_state *v); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>v</i></dt> -<dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> to reset.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 on success.</li> -<li>-1 on error.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_synthesis_trackonly</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_synthesis_trackonly</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>This function decodes a Vorbis packet similarly to -<a href="vorbis_synthesis.html">vorbis_synthesis</a>, except that the -<a href="vorbis_block.html">vorbis_block</a> produced does not contain -any audio data but merely updates the decoder's state as though the -block had been actually decoded when -<a href="vorbis_synthesis_blockin.html">vorbis_synthesis_blockin</a> -is called on it.</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_synthesis_trackonly(vorbis_block *vb,ogg_packet *op); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>vb</i></dt> -<dd>The <a href="vorbis_block.html">vorbis_block</a> to decode the -packet into.</dd> -<dt><i>op</i></dt> -<dd>The ogg_packet to decode.</dd> -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 on success.</li> -<li>OV_ENOTAUDIO if the packet is not an audio packet.</li> -<li>OV_EBADPACKET if there was an error in the packet.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> 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 @@ -<html> - -<head> -<title>libvorbis - function - vorbis_version_string</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - -<h1>vorbis_version_string</h1> - -<p><i>declared in "vorbis/codec.h";</i></p> - -<p>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.)</p> - -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern const char *vorbis_version_string(void); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<p>None.</p> - -<h3>Return Values</h3> -<blockquote> -<li>The libvorbis version string. The string is in static storage.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2010 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td> -</tr><tr> -<td><p class=tiny>libvorbis documentation</p></td> -<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td> -</tr> -</table> - - -</body> - -</html> |