00001 <html>
00002
00003 <head>
00004 <title>Tremor - function - ov_test_callbacks</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_callbacks</h1>
00017
00018 <p><i>declared in "ivorbisfile.h";</i></p>
00019
00020 <p>This is an alternative function used to open and test an OggVorbis_File
00021 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 structures.
00022 <p>Once this has been called, the same <tt>OggVorbis_File</tt>
00023 struct should be passed to all the libvorbisidec functions.
00024 <p>
00025 <br><br>
00026 <table border=0 color=black cellspacing=0 cellpadding=7>
00027 <tr bgcolor=#cccccc>
00028 <td>
00029 <pre><b>
00030 int ov_test_callbacks(void *datasource, <a href="OggVorbis_File.html">OggVorbis_File</a> *vf, char *initial, long ibytes, <a href="ov_callbacks.html">ov_callbacks</a> callbacks);
00031 </b></pre>
00032 </td>
00033 </tr>
00034 </table>
00035
00036 <h3>Parameters</h3>
00037 <dl>
00038 <dt><i>f</i></dt>
00039 <dd>File pointer to an already opened file
00040 or pipe (it need not be seekable--though this obviously restricts what
00041 can be done with the bitstream).</dd>
00042 <dt><i>vf</i></dt>
00043 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
00044 functions. Once this has been called, the same <tt>OggVorbis_File</tt>
00045 struct should be passed to all the libvorbisidec functions.</dd>
00046 <dt><i>initial</i></dt>
00047 <dd>Typically set to NULL. This parameter is useful if some data has already been
00048 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>
00049 should be a pointer to a buffer containing the data read.</dd>
00050 <dt><i>ibytes</i></dt>
00051 <dd>Typically set to 0. This parameter is useful if some data has already been
00052 read from the file and the stream is not seekable. In this case, <tt>ibytes</tt>
00053 should contain the length (in bytes) of the buffer. Used together with <tt>initial</tt>.</dd>
00054 <dt><i>callbacks</i></dt>
00055 <dd>Pointer to a completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd>
00056 </dl>
00057
00058
00059 <h3>Return Values</h3>
00060 <blockquote>
00061 <li>0 for success</li>
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
00076 <br><br>
00077 <hr noshade>
00078 <table border=0 width=100%>
00079 <tr valign=top>
00080 <td><p class=tiny>copyright © 2002 Xiph.org</p></td>
00081 <td align=right><p class=tiny><a href="http:
00082 </tr><tr>
00083 <td><p class=tiny>Tremor documentation</p></td>
00084 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00085 </tr>
00086 </table>
00087
00088 </body>
00089
00090 </html>
