00001 <html>
00002
00003 <head>
00004 <title>Tremor - function - ov_test</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>Tremor documentation</p></td>
00012 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ov_test</h1>
00017
00018 <p><i>declared in "ivorbisfile.h";</i></p>
00019
00020 <p>
00021 This partially opens a vorbis file to test for Vorbis-ness. It loads
00022 the headers for the first chain, and tests for seekability (but does not seek).
00023 Use <a href="ov_test_open.html">ov_test_open()</a> to finish opening the file
00024 or <a href="ov_clear.html">ov_clear</a> to close/free it.
00025 <p>
00026
00027 <table border=0 color=black cellspacing=0 cellpadding=7>
00028 <tr bgcolor=#cccccc>
00029 <td>
00030 <pre><b>
00031 int ov_test(FILE *f,<a href="OggVorbis_File.html">OggVorbis_File</a> *vf,char *initial,long ibytes);
00032 </b></pre>
00033 </td>
00034 </tr>
00035 </table>
00036
00037 <h3>Parameters</h3>
00038 <dl>
00039 <dt><i>f</i></dt>
00040 <dd>File pointer to an already opened file
00041 or pipe (it need not be seekable--though this obviously restricts what
00042 can be done with the bitstream).</dd>
00043 <dt><i>vf</i></dt>
00044 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
00045 functions. Once this has been called, the same <tt>OggVorbis_File</tt>
00046 struct should be passed to all the libvorbisidec functions.</dd>
00047 <dt><i>initial</i></dt>
00048 <dd>Typically set to NULL. This parameter is useful if some data has already been
00049 read from the file and the stream is not seekable. It is used in conjunction with <tt>ibytes</tt>. In this case, <tt>initial</tt>
00050 should be a pointer to a buffer containing the data read.</dd>
00051 <dt><i>ibytes</i></dt>
00052 <dd>Typically set to 0. This parameter is useful if some data has already been
00053 read from the file and the stream is not seekable. In this case, <tt>ibytes</tt>
00054 should contain the length (in bytes) of the buffer. Used together with <tt>initial</tt></dd>
00055 </dl>
00056
00057
00058 <h3>Return Values</h3>
00059 <blockquote>
00060 <li>0 for success</li>
00061
00062 <li>less than zero for failure:</li>
00063 <ul>
00064 <li>OV_EREAD - A read from media returned an error.</li>
00065 <li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
00066 <li>OV_EVERSION - Vorbis version mismatch.</li>
00067 <li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
00068 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
00069 </ul>
00070 </blockquote>
00071 <p>
00072
00073
00074
00075 <br><br>
00076 <hr noshade>
00077 <table border=0 width=100%>
00078 <tr valign=top>
00079 <td><p class=tiny>copyright © 2002 Xiph.org</p></td>
00080 <td align=right><p class=tiny><a href="http:
00081 </tr><tr>
00082 <td><p class=tiny>Tremor documentation</p></td>
00083 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00084 </tr>
00085 </table>
00086
00087 </body>
00088
00089 </html>
