| 1 | <html>
|
|---|
| 2 |
|
|---|
| 3 | <head>
|
|---|
| 4 | <title>Vorbisfile - function - ov_test</title>
|
|---|
| 5 | <link rel=stylesheet href="style.css" type="text/css">
|
|---|
| 6 | </head>
|
|---|
| 7 |
|
|---|
| 8 | <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
|
|---|
| 9 | <table border=0 width=100%>
|
|---|
| 10 | <tr>
|
|---|
| 11 | <td><p class=tiny>Vorbisfile documentation</p></td>
|
|---|
| 12 | <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
|
|---|
| 13 | </tr>
|
|---|
| 14 | </table>
|
|---|
| 15 |
|
|---|
| 16 | <h1>ov_test</h1>
|
|---|
| 17 |
|
|---|
| 18 | <p><i>declared in "vorbis/vorbisfile.h";</i></p>
|
|---|
| 19 |
|
|---|
| 20 | <p>
|
|---|
| 21 | This partially opens a vorbis file to test for Vorbis-ness. It loads
|
|---|
| 22 | the headers for the first chain and tests for seekability (but does
|
|---|
| 23 | not seek). Use <a href="ov_test_open.html">ov_test_open()</a> to
|
|---|
| 24 | finish opening the file or <a href="ov_clear.html">ov_clear</a> to
|
|---|
| 25 | close/free it. Note that vorbisfile does <b>not</b> take ownership of
|
|---|
| 26 | the file if the call fails; the calling applicaiton is responsible for
|
|---|
| 27 | closing the file if this call returns an error.
|
|---|
| 28 | <p>
|
|---|
| 29 |
|
|---|
| 30 | <p><em><b> WARNING for Windows developers: </b> Do not use ov_test()
|
|---|
| 31 | in Windows applications; Windows linking places restrictions on
|
|---|
| 32 | passing <tt>FILE *</tt> handles successfully, and ov_test() runs afoul
|
|---|
| 33 | of these restrictions <a href="#winfoot">[a]</a> in exactly the same
|
|---|
| 34 | way as <a href="ov_open.html">ov_open()</a>. See the <a
|
|---|
| 35 | href="ov_test_callbacks.html">ov_test_callbacks() page </a> for
|
|---|
| 36 | details on using <a
|
|---|
| 37 | href="ov_test_callbacks.html">ov_test_callbacks()</a> instead. </em>
|
|---|
| 38 | <p>
|
|---|
| 39 |
|
|---|
| 40 | <table border=0 color=black cellspacing=0 cellpadding=7>
|
|---|
| 41 | <tr bgcolor=#cccccc>
|
|---|
| 42 | <td>
|
|---|
| 43 | <pre><b>
|
|---|
| 44 | int ov_test(FILE *f,<a href="OggVorbis_File.html">OggVorbis_File</a> *vf,char *initial,long ibytes);
|
|---|
| 45 | </b></pre>
|
|---|
| 46 | </td>
|
|---|
| 47 | </tr>
|
|---|
| 48 | </table>
|
|---|
| 49 |
|
|---|
| 50 | <h3>Parameters</h3>
|
|---|
| 51 | <dl>
|
|---|
| 52 | <dt><i>f</i></dt>
|
|---|
| 53 | <dd>File pointer to an already opened file
|
|---|
| 54 | or pipe (it need not be seekable--though this obviously restricts what
|
|---|
| 55 | can be done with the bitstream).</dd>
|
|---|
| 56 | <dt><i>vf</i></dt>
|
|---|
| 57 | <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
|
|---|
| 58 | functions. Once this has been called, the same <tt>OggVorbis_File</tt>
|
|---|
| 59 | struct should be passed to all the libvorbisfile functions.</dd>
|
|---|
| 60 | <dt><i>initial</i></dt>
|
|---|
| 61 | <dd>Typically set to NULL. This parameter is useful if some data has already been
|
|---|
| 62 | 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>
|
|---|
| 63 | should be a pointer to a buffer containing the data read.</dd>
|
|---|
| 64 | <dt><i>ibytes</i></dt>
|
|---|
| 65 | <dd>Typically set to 0. This parameter is useful if some data has already been
|
|---|
| 66 | read from the file and the stream is not seekable. In this case, <tt>ibytes</tt>
|
|---|
| 67 | should contain the length (in bytes) of the buffer. Used together with <tt>initial</tt></dd>
|
|---|
| 68 | </dl>
|
|---|
| 69 |
|
|---|
| 70 |
|
|---|
| 71 | <h3>Return Values</h3>
|
|---|
| 72 | <blockquote>
|
|---|
| 73 | <li>0 for success</li>
|
|---|
| 74 |
|
|---|
| 75 | <li>less than zero for failure:</li>
|
|---|
| 76 | <ul>
|
|---|
| 77 | <li>OV_EREAD - A read from media returned an error.</li>
|
|---|
| 78 | <li>OV_ENOTVORBIS - Bitstream contains no Vorbis data.</li>
|
|---|
| 79 | <li>OV_EVERSION - Vorbis version mismatch.</li>
|
|---|
| 80 | <li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
|
|---|
| 81 | <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
|
|---|
| 82 | </ul>
|
|---|
| 83 | </blockquote>
|
|---|
| 84 | <p>
|
|---|
| 85 |
|
|---|
| 86 | <h3>Notes</h3>
|
|---|
| 87 |
|
|---|
| 88 | All the <a href="ov_open.html#notes">notes from ov_open()</a> apply to ov_test().
|
|---|
| 89 |
|
|---|
| 90 | <br><br>
|
|---|
| 91 | <hr noshade>
|
|---|
| 92 | <table border=0 width=100%>
|
|---|
| 93 | <tr valign=top>
|
|---|
| 94 | <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td>
|
|---|
| 95 | <td align=right><p class=tiny><a href="https://xiph.org/vorbis/">Ogg Vorbis</a></p></td>
|
|---|
| 96 | </tr><tr>
|
|---|
| 97 | <td><p class=tiny>Vorbisfile documentation</p></td>
|
|---|
| 98 | <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
|
|---|
| 99 | </tr>
|
|---|
| 100 | </table>
|
|---|
| 101 |
|
|---|
| 102 | </body>
|
|---|
| 103 |
|
|---|
| 104 | </html>
|
|---|
