Diff of /doc/vorbisfile/ov_open_callbacks.html [ed1f1f] .. [d865bb] Maximize Restore

  Switch to side-by-side view

--- a/doc/vorbisfile/ov_open_callbacks.html
+++ b/doc/vorbisfile/ov_open_callbacks.html
@@ -9,7 +9,7 @@
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
 </tr>
 </table>
 
@@ -17,22 +17,28 @@
 
 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
 
-<p>This is an alternative function used to open and initialize an OggVorbis_File
-structure when using a data source other than a file.   It allows you to specify custom file manipulation routines and sets up all the related decoding structure.
-<p>Once this has been called, the same <tt>OggVorbis_File</tt>
-struct should be passed to all the libvorbisfile functions.
-<p>
-It is often useful to call <tt>ov_open_callbacks()</tt>
-simply to determine whether a given stream is a vorbis bitstream. If the
-<tt>ov_open_callbacks()</tt>
-call fails, then the data is not recognizable as such. When you use <tt>ov_open_callbacks()
-</tt>for
-this, you should close or otherwise deallocate your <tt>datasource</tt> if, and only if, the
-<tt>ov_open_callbacks()</tt>
-call fails. If it succeeds, you must call <a href=ov_clear.html>ov_clear()</a> to clear
-the decoder's buffers and call your close callback.<p>
+<p>This is an alternative function used to open and initialize an
+OggVorbis_File structure when using a data source other than a file,
+when its necessary to modify default file access behavior, or to
+initialize a Vorbis decode from a <tt>FILE *</tt> pointer under
+Windows where <a href="ov_open.html">ov_open()</a> cannot be used.  It
+allows the application to specify custom file manipulation routines
+and sets up all the related decoding structures.
 
-See also <a href="callbacks.html">Callbacks and Non-stdio I/O</a> for information on designing and specifying the required callback functions.<p>
+<p>Once ov_open_callbacks() has been called, the same
+<tt>OggVorbis_File</tt> struct should be passed to all the
+libvorbisfile functions.  Unlike <a
+href="ov_fopen.html">ov_fopen()</a> and <a
+href="ov_open.html">ov_open()</a>, ov_open_callbacks() may be used to
+instruct vorbisfile to either automatically close or not to close the
+file/data access handle in <a href="ov_clear.html">ov_clear()</a>.
+Automatic closure is disabled by passing NULL as the close callback,
+or using one of the predefined callback sets that specify a NULL close
+callback.  The application is responsible for closing a file when a
+call to ov_open_callbacks() is unsuccessful.<p>
+
+See also <a href="callbacks.html">Callbacks and Non-stdio I/O</a> for
+information on designing and specifying custom callback functions.<p>
 
 <br><br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
@@ -62,7 +68,7 @@
 read from the stream and the stream is not seekable. In this case, <tt>ibytes</tt>
 should contain the length (in bytes) of the buffer.  Used together with <tt>initial</tt>.</dd>
 <dt><i>callbacks</i></dt>
-<dd>A completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd>
+<dd>A completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.  vorbisfile.h defines several preprovided callback sets; see <a href="ov_callbacks.html">ov_callbacks</a> for details.</dd>
 </dl>
 
 
@@ -72,7 +78,7 @@
 <li>less than zero for failure:</li>
 <ul>
 <li>OV_EREAD - A read from media returned an error.</li>
-<li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
+<li>OV_ENOTVORBIS - Bitstream does not contain any Vorbis data.</li>
 <li>OV_EVERSION - Vorbis version mismatch.</li>
 <li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
@@ -81,25 +87,58 @@
 <p>
 
 <h3>Notes</h3>
-<p>If your decoder is threaded, it is recommended that you NOT call
+<dl>
+
+<dt><b>[a] Windows and use as an ov_open() substitute</b><p> Windows
+applications should not use <a href="ov_open.html">ov_open()</a> due
+to the likelihood of <a href="ov_open.html#winfoot">CRT linking
+mismatches and runtime protection faults
+[ov_open:a]</a>. ov_open_callbacks() is a safe substitute; specifically:
+
+<pre><tt>ov_open_callbacks(f, vf, initial, ibytes, OV_CALLBACKS_DEFAULT);</tt>
+</pre>
+
+... provides exactly the same functionality as <a
+href="ov_open.html">ov_open()</a> but will always work correctly under
+Windows, regardless of linking setup details.<p>
+
+<dt><b>[b] Threaded decode</b><p>
+<dd>If your decoder is threaded, it is recommended that you NOT call
 <tt>ov_open_callbacks()</tt>
-in the main control thread--instead, call <tt>ov_open_callbacks()</tt> IN your decode/playback
+in the main control thread--instead, call <tt>ov_open_callbacks()</tt> in your decode/playback
 thread. This is important because <tt>ov_open_callbacks()</tt> may be a fairly time-consuming
 call, given that the full structure of the file is determined at this point,
 which may require reading large parts of the file under certain circumstances
 (determining all the logical bitstreams in one physical bitstream, for
-example).
-See <a href="threads.html">Thread Safety</a> for other information on using libvorbisfile with threads.
+example).  See <a href="threads.html">Thread Safety</a> for other information on using libvorbisfile with threads.
+<p>
+
+<dt><b>[c] Mixed media streams</b><p>
+<dd>
+As of Vorbisfile release 1.2.0, Vorbisfile is able to access the
+Vorbis content in mixed-media Ogg streams, not just Vorbis-only
+streams.  For example, Vorbisfile may be used to open and access the
+audio from an Ogg stream consisting of Theora video and Vorbis audio.
+Vorbisfile 1.2.0 decodes the first logical audio stream of each
+physical stream section.<p>
+
+<dt><b>[d] Faster testing for Vorbis files</b><p>
+<dd><a href="ov_test.html">ov_test()</a> and <a
+href="ov_test_callbacks.html">ov_test_callbacks()</a> provide less
+computationally expensive ways to test a file for Vorbisness, but
+require more setup code.<p>
+
+</dl>
 
 <br><br>
 <hr noshade>
 <table border=0 width=100%>
 <tr valign=top>
-<td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright &copy; 2007 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>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
 </tr>
 </table>