Commit doc updates relating to async error interface

git-svn-id: http://svn.xiph.org/trunk/ogg@16049 0101bb08-14d6-0310-b084-bc0e0c8e3800
author: Monty <xiphmont@xiph.org> 2009-05-27 04:50:41 +0000
committer: Monty <xiphmont@xiph.org> 2009-05-27 04:50:41 +0000
commit: aa729da057002630b75791f5fd0e2641d9e51b87 (patch)
tree: c068d2afeed290d4960389617b476e7e1de9d028 /doc
parent: af61d78995f531579ffdd24fd8a5360484ab66a2 (diff)
download: ogg-aa729da057002630b75791f5fd0e2641d9e51b87.tar.gz
23 files changed, 175 insertions, 179 deletions
diff --git a/doc/libogg/Makefile.am b/doc/libogg/Makefile.am
index 8a51188..c83f4e7 100644
--- a/doc/libogg/Makefile.am
+++ b/doc/libogg/Makefile.am
@@ -22,7 +22,6 @@ doc_DATA = bitpacking.html datastructures.html decoding.html encoding.html\
 	oggpack_read1.html oggpack_readinit.html oggpack_reset.html\
 	oggpack_write.html oggpack_writealign.html oggpack_writeclear.html\
 	oggpack_writecopy.html oggpack_writeinit.html oggpack_writetrunc.html\
-	overview.html reference.html style.css vorbis_comment.html\
-	vorbis_info.html
+	overview.html reference.html style.css
 
 EXTRA_DIST = $(doc_DATA)
diff --git a/doc/libogg/decoding.html b/doc/libogg/decoding.html
index 7ea3240..90f5ac3 100644
--- a/doc/libogg/decoding.html
+++ b/doc/libogg/decoding.html
@@ -53,6 +53,10 @@ All the <b>libogg</b> specific functions are declared in "ogg/ogg.h".
 	<td>Frees the synchronization struct.</td>
 </tr>
 <tr valign=top>
+<td><a href="ogg_sync_check.html">ogg_sync_check</a></td>
+	<td>Check for asynchronous errors.</td>
+</tr>
+<tr valign=top>
 <td><a href="ogg_sync_buffer.html">ogg_sync_buffer</a></td>
 	<td>Exposes a buffer from the synchronization layer in order to read data.</td>
 </tr>
diff --git a/doc/libogg/general.html b/doc/libogg/general.html
index 1fa5136..526b635 100644
--- a/doc/libogg/general.html
+++ b/doc/libogg/general.html
@@ -43,6 +43,10 @@ All the <b>libogg</b> specific functions are declared in "ogg/ogg.h".
 	<td>Frees the entire Ogg stream.</td>
 </tr>
 <tr valign=top>
+<td><a href="ogg_stream_check.html">ogg_stream_check</a></td>
+	<td>Check for asyncronous errors.</td>
+</tr>
+<tr valign=top>
 <td><a href="ogg_stream_eos.html">ogg_stream_eos</a></td>
 	<td>Indicates whether we are at the end of the stream.</td>
 </tr>
diff --git a/doc/libogg/ogg_stream_check.html b/doc/libogg/ogg_stream_check.html
new file mode 100644
index 0000000..8f44925
--- /dev/null
+++ b/doc/libogg/ogg_stream_check.html
@@ -0,0 +1,71 @@
+<html>
+
+<head>
+<title>libogg - function - ogg_stream_check</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>libogg documentation</p></td>
+<td align=right><p class=tiny>libogg release 1.1.4 - 20090520</p></td>
+</tr>
+</table>
+
+<h1>ogg_stream_check</h1>
+
+<p><i>declared in "ogg/ogg.h";</i></p>
+
+<p>This function is used to check the error or readiness condition of an <a href="ogg_stream_state.html">ogg_stream_state</a> structure.  
+<p>It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an
+internal error occur, the <a href="ogg_stream_state.html">ogg_stream_state</a>structure will be cleared (equivalent to a
+call to
+<a href="ogg_stream_clear.html">ogg_stream_clear</a>) and subsequent calls
+using this <a href="ogg_stream_state.html">ogg_stream_state</a> will be
+noops. Error detection is then handled via a single call to
+ogg_stream_check at the end of the operational block. </p>
+
+<br><br>
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+	<td>
+<pre><b>
+int ogg_stream_check(<a href="ogg_stream_state.html">ogg_stream_state</a> *os);
+</b></pre>
+	</td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>os</i></dt>
+<dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct.</dd>
+</dl>
+
+
+<h3>Return Values</h3>
+<blockquote>
+<li>
+0 is returned if the <a href="ogg_stream_state.html">ogg_stream_state</a> structure is initialized and ready.</li>
+<li>
+nonzero is returned if the structure was never initialized, or if an unrecoverable internal error occurred in a previous call using the passed in <a href="ogg_stream_state.html">ogg_stream_state</a> struct.</li>
+</blockquote>
+<p>
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright &copy; 2000-2009 Xiph.Org</p></td>
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
+</tr><tr>
+<td><p class=tiny>libogg documentation</p></td>
+<td align=right><p class=tiny>libogg release 1.1.4 - 20090527</p></td>
+</tr>
+</table>
+
+
+</body>
+
+</html>
diff --git a/doc/libogg/ogg_stream_clear.html b/doc/libogg/ogg_stream_clear.html
index 0f899a0..337c1a0 100644
--- a/doc/libogg/ogg_stream_clear.html
+++ b/doc/libogg/ogg_stream_clear.html
@@ -17,7 +17,7 @@
 
 <p><i>declared in "ogg/ogg.h";</i></p>
 
-<p>This function clears the memory used by the <a href="ogg_sync_state.html">ogg_stream_state</a> struct, but does not free it.
+<p>This function clears and frees the internal memory used by the <a href="ogg_sync_state.html">ogg_stream_state</a> struct, but does not free the structure itself. It is safe to call ogg_stream_clear on the same structure more than once.
 <br><br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
 <tr bgcolor=#cccccc>
diff --git a/doc/libogg/ogg_stream_destroy.html b/doc/libogg/ogg_stream_destroy.html
index 5af7586..f7cbbfa 100644
--- a/doc/libogg/ogg_stream_destroy.html
+++ b/doc/libogg/ogg_stream_destroy.html
@@ -17,7 +17,9 @@
 
 <p><i>declared in "ogg/ogg.h";</i></p>
 
-<p>This function frees the memory used by the <a href="ogg_stream_state.html">ogg_stream_state</a> struct.
+<p>This function frees the internal memory used by
+the <a href="ogg_stream_state.html">ogg_stream_state</a> struct as
+well as the structure itself.
 
 <p>This should be called when you are done working with an ogg stream.
 It can also be called to make sure that the struct does not exist.</p>
diff --git a/doc/libogg/ogg_stream_eos.html b/doc/libogg/ogg_stream_eos.html
index ba35e7c..22c5b91 100644
--- a/doc/libogg/ogg_stream_eos.html
+++ b/doc/libogg/ogg_stream_eos.html
@@ -38,7 +38,7 @@ int ogg_stream_eos(ogg_stream_state *os);
 
 <h3>Return Values</h3>
 <blockquote>
-<li>1 if we are at the end of the stream.</li>
+<li>1 if we are at the end of the stream or an internal error occurred.</li>
 <li>
 0 if we have not yet reached the end of the stream.</li>
 </blockquote>
diff --git a/doc/libogg/ogg_stream_flush.html b/doc/libogg/ogg_stream_flush.html
index 73e4e40..db5380a 100644
--- a/doc/libogg/ogg_stream_flush.html
+++ b/doc/libogg/ogg_stream_flush.html
@@ -43,7 +43,7 @@ int ogg_stream_flush(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <
 
 <h3>Return Values</h3>
 <blockquote>
-<li>0 means that all packet data has already been flushed into pages, and there are no packets to put into the page.</li>
+<li>0 means that all packet data has already been flushed into pages, and there are no packets to put into the page.  0 is also returned in the case of an <a href="ogg_stream_state.html">ogg_stream_state</a> that has been cleared explicitly or implicitly due to an internal error.</li>
 <li>
 Nonzero means that remaining packets have successfully been flushed into the page.</li>
 </blockquote>
diff --git a/doc/libogg/ogg_stream_iovecin.html b/doc/libogg/ogg_stream_iovecin.html
index 9409ace..f3dde39 100644
--- a/doc/libogg/ogg_stream_iovecin.html
+++ b/doc/libogg/ogg_stream_iovecin.html
@@ -58,10 +58,7 @@ int ogg_stream_iovecin(ogg_stream_state *os, ogg_iovec_t *iov, int count, long e
 <h3>Return Values</h3>
 <blockquote>
 <li>
-0 returned on success.  -1 returned in the event of internal error
-(currently only caused by a failed memory allocation, a case that can
-only occur on embedded systems.  It is reasonable to ignore the return
-value innormal desktop applications).</li>
+0 returned on success.  -1 returned in the event of internal error.</li>
 </blockquote>
 <p>
 
diff --git a/doc/libogg/ogg_stream_packetin.html b/doc/libogg/ogg_stream_packetin.html
index 57fe9f6..ddf8353 100644
--- a/doc/libogg/ogg_stream_packetin.html
+++ b/doc/libogg/ogg_stream_packetin.html
@@ -50,10 +50,7 @@ int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op);
 <h3>Return Values</h3>
 <blockquote>
 <li>
-0 returned on success.  -1 returned in the event of internal error
-(currently only caused by a failed memory allocation, a case that can
-only occur on embedded systems.  It is reasonable to ignore the return
-value innormal desktop applications).</li>
+0 returned on success.  -1 returned in the event of internal error.</li>
 </blockquote>
 <p>
 
diff --git a/doc/libogg/ogg_stream_packetout.html b/doc/libogg/ogg_stream_packetout.html
index 8563849..279f9cc 100644
--- a/doc/libogg/ogg_stream_packetout.html
+++ b/doc/libogg/ogg_stream_packetout.html
@@ -60,8 +60,8 @@ on this stream state.</dd>
 <h3>Return Values</h3>
 <blockquote>
 <ul>
-<li>-1 if we are out of sync and there is a gap in the data. Usually this will not be a fatal error and subsequent calls to ogg_stream_packetout are likely to succeed. <i>op</i> has not been updated.</li>
-<li>0 if there is insufficient data available to complete a packet. <i>op</i> has not been updated.
+<li>-1 if we are out of sync and there is a gap in the data. This is usually a recoverable error and subsequent calls to ogg_stream_packetout are likely to succeed. <i>op</i> has not been updated.</li>
+<li>0 if there is insufficient data available to complete a packet, or on unrecoverable internal error occurred. <i>op</i> has not been updated.
 <li>1 if a packet was assembled normally. <i>op</i> contains the next packet from the stream.</li>
 </ul>
 </blockquote>
diff --git a/doc/libogg/ogg_stream_packetpeek.html b/doc/libogg/ogg_stream_packetpeek.html
index 1bd44af..5c81393 100644
--- a/doc/libogg/ogg_stream_packetpeek.html
+++ b/doc/libogg/ogg_stream_packetpeek.html
@@ -58,8 +58,8 @@ packet?" check.</dd>
 <h3>Return Values</h3>
 <blockquote>
 <ul>
-<li>-1 if there's no packet available due to lost sync or a hole
-in the data.</li>
+<li>-1 if there's no packet available due to lost sync or a hole in the data.</li>
+<li>0 if there is insufficient data available to complete a packet, or on unrecoverable internal error occurred.</li>
 <li>1 if a packet is available.</li>
 </ul>
 </blockquote>
diff --git a/doc/libogg/ogg_stream_pagein.html b/doc/libogg/ogg_stream_pagein.html
index 5c021c6..9542c20 100644
--- a/doc/libogg/ogg_stream_pagein.html
+++ b/doc/libogg/ogg_stream_pagein.html
@@ -43,7 +43,7 @@ int ogg_stream_pagein(<a href="ogg_stream_state.html">ogg_stream_state</a> *os,
 
 <h3>Return Values</h3>
 <blockquote>
-<li>-1 indicates failure.  This means that the serial number of the page did not match the serial number of the bitstream, the page version was incorrect, or a memory allocation failed.</li>
+<li>-1 indicates failure.  This means that the serial number of the page did not match the serial number of the bitstream, the page version was incorrect, or an internal error accurred.</li>
 <li>
 0 means that the page was successfully submitted to the bitstream.</li>
 </blockquote>
diff --git a/doc/libogg/ogg_stream_pageout.html b/doc/libogg/ogg_stream_pageout.html
index bf0d484..d916467 100644
--- a/doc/libogg/ogg_stream_pageout.html
+++ b/doc/libogg/ogg_stream_pageout.html
@@ -59,7 +59,7 @@ ogg_stream_flush().</dd>
 
 <h3>Return Values</h3>
 <blockquote>
-<li>Zero means that insufficient data has accumulated to fill a page. In 
+<li>Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In 
 this case <i>og</i> is not modified.</li>
 <li>Non-zero means that a page has been completed and returned.</li>
 </blockquote>
diff --git a/doc/libogg/ogg_stream_reset.html b/doc/libogg/ogg_stream_reset.html
index 1b4fb36..663c05b 100644
--- a/doc/libogg/ogg_stream_reset.html
+++ b/doc/libogg/ogg_stream_reset.html
@@ -39,7 +39,7 @@ int ogg_stream_reset(ogg_stream_state *os);
 <h3>Return Values</h3>
 <blockquote>
 <li>
-0 is always returned.</li>
+0 indicates success. nonzero is returned on internal error.</li>
 </blockquote>
 <p>
 
diff --git a/doc/libogg/ogg_stream_reset_serialno.html b/doc/libogg/ogg_stream_reset_serialno.html
index 7314220..be606e9 100644
--- a/doc/libogg/ogg_stream_reset_serialno.html
+++ b/doc/libogg/ogg_stream_reset_serialno.html
@@ -45,7 +45,7 @@ int ogg_stream_reset_serialno(ogg_stream_state *os, int serialno);
 <h3>Return Values</h3>
 <blockquote>
 <li>
-0 is always returned.</li>
+0 indicates success. nonzero is returned on internal error.</li>
 </blockquote>
 <p>
 
diff --git a/doc/libogg/ogg_sync_check.html b/doc/libogg/ogg_sync_check.html
new file mode 100644
index 0000000..b1ed8ce
--- /dev/null
+++ b/doc/libogg/ogg_sync_check.html
@@ -0,0 +1,71 @@
+<html>
+
+<head>
+<title>libogg - function - ogg_sync_check</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>libogg documentation</p></td>
+<td align=right><p class=tiny>libogg release 1.1.4 - 20090520</p></td>
+</tr>
+</table>
+
+<h1>ogg_sync_check</h1>
+
+<p><i>declared in "ogg/ogg.h";</i></p>
+
+<p>This function is used to check the error or readiness condition of an <a href="ogg_sync_state.html">ogg_sync_state</a> structure.  
+<p>It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an
+internal error occur, the <a href="ogg_sync_state.html">ogg_sync_state</a>structure will be cleared (equivalent to a
+call to
+<a href="ogg_sync_clear.html">ogg_sync_clear</a>) and subsequent calls
+using this <a href="ogg_sync_state.html">ogg_sync_state</a> will be
+noops. Error detection is then handled via a single call to
+ogg_sync_check at the end of the operational block. </p>
+
+<br><br>
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+	<td>
+<pre><b>
+int ogg_sync_check(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
+</b></pre>
+	</td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>oy</i></dt>
+<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
+</dl>
+
+
+<h3>Return Values</h3>
+<blockquote>
+<li>
+0 is returned if the <a href="ogg_sync_state.html">ogg_sync_state</a> structure is initialized and ready.</li>
+<li>
+nonzero is returned if the structure was never initialized, or if an unrecoverable internal error occurred in a previous call using the passed in <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</li>
+</blockquote>
+<p>
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright &copy; 2000-2009 Xiph.Org</p></td>
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
+</tr><tr>
+<td><p class=tiny>libogg documentation</p></td>
+<td align=right><p class=tiny>libogg release 1.1.4 - 20090527</p></td>
+</tr>
+</table>
+
+
+</body>
+
+</html>
diff --git a/doc/libogg/ogg_sync_pageout.html b/doc/libogg/ogg_sync_pageout.html
index 26a1ab1..c42fe30 100644
--- a/doc/libogg/ogg_sync_pageout.html
+++ b/doc/libogg/ogg_sync_pageout.html
@@ -44,11 +44,9 @@ int ogg_sync_pageout(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a hr
 
 <h3>Return Values</h3>
 <blockquote>
-<li>-1 if we were not properly synced and had to skip some bytes.</li>
-<li>
-0 if we need more data to verify a page.</li>
-<li>
-1 if we have a page.</li>
+<li>-1 returned if stream has not yet captured sync (bytes were skipped).</li>
+<li>0 returned if more data needed or an internal error occurred.</li>
+<li>1 indicated a page was synced and returned.</li>
 </blockquote>
 <p>
 
diff --git a/doc/libogg/ogg_sync_pageseek.html b/doc/libogg/ogg_sync_pageseek.html
index 4c09b33..6414c22 100644
--- a/doc/libogg/ogg_sync_pageseek.html
+++ b/doc/libogg/ogg_sync_pageseek.html
@@ -44,7 +44,7 @@ int ogg_sync_pageseek(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a h
 <blockquote>
 <li>-n means that we skipped n bytes within the bitstream.</li>
 <li>
-0 means that the page isn't ready and we need more data.  No bytes have been skipped.</li>
+0 means that the page isn't ready and we need more data, or than an internal error occurred.  No bytes have been skipped.</li>
 <li>
 n means that the page was synced at the current location, with a page length of n bytes.
 </blockquote>
diff --git a/doc/libogg/ogg_sync_wrote.html b/doc/libogg/ogg_sync_wrote.html
index 3a2a812..9aa328a 100644
--- a/doc/libogg/ogg_sync_wrote.html
+++ b/doc/libogg/ogg_sync_wrote.html
@@ -49,7 +49,7 @@ int ogg_sync_wrote(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, long by
 
 <h3>Return Values</h3>
 <blockquote>
-<li>-1 if the number of bytes written overflows the internal storage of the <a href="ogg_sync_state.html">ogg_sync_state</a> struct.
+<li>-1 if the number of bytes written overflows the internal storage of the <a href="ogg_sync_state.html">ogg_sync_state</a> struct or an internal error occurred.
 <li>
 0 in all other cases.</li>
 </blockquote>
diff --git a/doc/libogg/reference.html b/doc/libogg/reference.html
index c5e8002..a459ed4 100644
--- a/doc/libogg/reference.html
+++ b/doc/libogg/reference.html
@@ -25,6 +25,7 @@
 <br>
 <b>Bitpacking</b><br>
 <a href="oggpack_writeinit.html">oggpack_writeinit()</a><br>
+<a href="oggpack_writecheck.html">oggpack_writecheck()</a><br>
 <a href="oggpack_reset.html">oggpack_reset()</a><br>
 <a href="oggpack_writetrunc.html">oggpack_writetrunc()</a><br>
 <a href="oggpack_writealign.html">oggpack_writealign()</a><br>
@@ -44,6 +45,7 @@
 <br>
 <b>Decoding-Related</b><br>
 <a href="ogg_sync_init.html">ogg_sync_init()</a><br>
+<a href="ogg_sync_check.html">ogg_sync_check()</a><br>
 <a href="ogg_sync_clear.html">ogg_sync_clear()</a><br>
 <a href="ogg_sync_destroy.html">ogg_sync_destroy()</a><br>
 <a href="ogg_sync_reset.html">ogg_sync_reset()</a><br>
@@ -62,6 +64,7 @@
 <br>
 <b>General</b><br>
 <a href="ogg_stream_init.html">ogg_stream_init()</a><br>
+<a href="ogg_stream_check.html">ogg_stream_check()</a><br>
 <a href="ogg_stream_clear.html">ogg_stream_clear()</a><br>
 <a href="ogg_stream_reset.html">ogg_stream_reset()</a><br>
 <a href="ogg_stream_reset_serialno.html">ogg_stream_reset_serialno()</a><br>
diff --git a/doc/libogg/vorbis_comment.html b/doc/libogg/vorbis_comment.html
deleted file mode 100644
index 09d81f8..0000000
--- a/doc/libogg/vorbis_comment.html
+++ /dev/null
@@ -1,70 +0,0 @@
-<html>
-
-<head>
-<title>Vorbisfile - 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>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</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>
-
-<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 array that stores the length of each comment string</dd>
-<dt><i>comments</i></dt>
-<dd>number of user comments in user_comments field.</dd>
-<dt><i>vendor</i></dt>
-<dd>Information about the creator of the file.  Stored in a standard C 0-terminated string.</dd>
-</dl>
-
-
-<br><br>
-<hr noshade>
-<table border=0 width=100%>
-<tr valign=top>
-<td><p class=tiny>copyright &copy; 2002 Xiph.org Foundation</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
-</tr><tr>
-<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020719</p></td>
-</tr>
-</table>
-
-</body>
-
-</html>
diff --git a/doc/libogg/vorbis_info.html b/doc/libogg/vorbis_info.html
deleted file mode 100644
index ec16a8b..0000000
--- a/doc/libogg/vorbis_info.html
+++ /dev/null
@@ -1,80 +0,0 @@
-<html>
-
-<head>
-<title>Vorbisfile - 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>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</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 &copy; 2002 Xiph.org</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
-</tr><tr>
-<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>
-</tr>
-</table>
-
-</body>
-
-</html>
author	Monty <xiphmont@xiph.org>	2009-05-27 04:50:41 +0000
committer	Monty <xiphmont@xiph.org>	2009-05-27 04:50:41 +0000
commit	aa729da057002630b75791f5fd0e2641d9e51b87 (patch)
tree	c068d2afeed290d4960389617b476e7e1de9d028 /doc
parent	af61d78995f531579ffdd24fd8a5360484ab66a2 (diff)
download	ogg-aa729da057002630b75791f5fd0e2641d9e51b87.tar.gz