[xiph-commits] r16049 - trunk/ogg/doc/libogg
xiphmont at svn.xiph.org
xiphmont at svn.xiph.org
Tue May 26 21:50:42 PDT 2009
Author: xiphmont
Date: 2009-05-26 21:50:41 -0700 (Tue, 26 May 2009)
New Revision: 16049
Added:
trunk/ogg/doc/libogg/ogg_stream_check.html
trunk/ogg/doc/libogg/ogg_sync_check.html
Removed:
trunk/ogg/doc/libogg/vorbis_comment.html
trunk/ogg/doc/libogg/vorbis_info.html
Modified:
trunk/ogg/doc/libogg/Makefile.am
trunk/ogg/doc/libogg/decoding.html
trunk/ogg/doc/libogg/general.html
trunk/ogg/doc/libogg/ogg_stream_clear.html
trunk/ogg/doc/libogg/ogg_stream_destroy.html
trunk/ogg/doc/libogg/ogg_stream_eos.html
trunk/ogg/doc/libogg/ogg_stream_flush.html
trunk/ogg/doc/libogg/ogg_stream_iovecin.html
trunk/ogg/doc/libogg/ogg_stream_packetin.html
trunk/ogg/doc/libogg/ogg_stream_packetout.html
trunk/ogg/doc/libogg/ogg_stream_packetpeek.html
trunk/ogg/doc/libogg/ogg_stream_pagein.html
trunk/ogg/doc/libogg/ogg_stream_pageout.html
trunk/ogg/doc/libogg/ogg_stream_reset.html
trunk/ogg/doc/libogg/ogg_stream_reset_serialno.html
trunk/ogg/doc/libogg/ogg_sync_pageout.html
trunk/ogg/doc/libogg/ogg_sync_pageseek.html
trunk/ogg/doc/libogg/ogg_sync_wrote.html
trunk/ogg/doc/libogg/reference.html
Log:
Commit doc updates relating to async error interface
Modified: trunk/ogg/doc/libogg/Makefile.am
===================================================================
--- trunk/ogg/doc/libogg/Makefile.am 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/Makefile.am 2009-05-27 04:50:41 UTC (rev 16049)
@@ -22,7 +22,6 @@
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)
Modified: trunk/ogg/doc/libogg/decoding.html
===================================================================
--- trunk/ogg/doc/libogg/decoding.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/decoding.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -53,6 +53,10 @@
<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>
Modified: trunk/ogg/doc/libogg/general.html
===================================================================
--- trunk/ogg/doc/libogg/general.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/general.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -43,6 +43,10 @@
<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>
Added: trunk/ogg/doc/libogg/ogg_stream_check.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_check.html (rev 0)
+++ trunk/ogg/doc/libogg/ogg_stream_check.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -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 © 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>
Modified: trunk/ogg/doc/libogg/ogg_stream_clear.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_clear.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_clear.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -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>
Modified: trunk/ogg/doc/libogg/ogg_stream_destroy.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_destroy.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_destroy.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -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>
Modified: trunk/ogg/doc/libogg/ogg_stream_eos.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_eos.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_eos.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -38,7 +38,7 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_stream_flush.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_flush.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_flush.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -43,7 +43,7 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_stream_iovecin.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_iovecin.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_iovecin.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -58,10 +58,7 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_stream_packetin.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_packetin.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_packetin.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -50,10 +50,7 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_stream_packetout.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_packetout.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_packetout.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -60,8 +60,8 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_stream_packetpeek.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_packetpeek.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_packetpeek.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -58,8 +58,8 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_stream_pagein.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_pagein.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_pagein.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -43,7 +43,7 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_stream_pageout.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_pageout.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_pageout.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -59,7 +59,7 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_stream_reset.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_reset.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_reset.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -39,7 +39,7 @@
<h3>Return Values</h3>
<blockquote>
<li>
-0 is always returned.</li>
+0 indicates success. nonzero is returned on internal error.</li>
</blockquote>
<p>
Modified: trunk/ogg/doc/libogg/ogg_stream_reset_serialno.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_stream_reset_serialno.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_stream_reset_serialno.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -45,7 +45,7 @@
<h3>Return Values</h3>
<blockquote>
<li>
-0 is always returned.</li>
+0 indicates success. nonzero is returned on internal error.</li>
</blockquote>
<p>
Added: trunk/ogg/doc/libogg/ogg_sync_check.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_sync_check.html (rev 0)
+++ trunk/ogg/doc/libogg/ogg_sync_check.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -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 © 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>
Modified: trunk/ogg/doc/libogg/ogg_sync_pageout.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_sync_pageout.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_sync_pageout.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -44,11 +44,9 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_sync_pageseek.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_sync_pageseek.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_sync_pageseek.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -44,7 +44,7 @@
<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>
Modified: trunk/ogg/doc/libogg/ogg_sync_wrote.html
===================================================================
--- trunk/ogg/doc/libogg/ogg_sync_wrote.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/ogg_sync_wrote.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -49,7 +49,7 @@
<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>
Modified: trunk/ogg/doc/libogg/reference.html
===================================================================
--- trunk/ogg/doc/libogg/reference.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/reference.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -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>
Deleted: trunk/ogg/doc/libogg/vorbis_comment.html
===================================================================
--- trunk/ogg/doc/libogg/vorbis_comment.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/vorbis_comment.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -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 © 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>
Deleted: trunk/ogg/doc/libogg/vorbis_info.html
===================================================================
--- trunk/ogg/doc/libogg/vorbis_info.html 2009-05-27 03:55:40 UTC (rev 16048)
+++ trunk/ogg/doc/libogg/vorbis_info.html 2009-05-27 04:50:41 UTC (rev 16049)
@@ -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 © 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>
More information about the commits
mailing list