doc/vorbisfile/ov_open_callbacks.html

   1 <html>
   2
   3 <head>
   4 <title>vorbisfile - function - ov_open_callbacks</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.25 - 20000615</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ov_open_callbacks</h1>
  17
  18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  19
  20 <p>This is an alternative function used to open and initialize an OggVorbis_File
  21 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.
  22 <p>Once this has been called, the same <tt>OggVorbis_File</tt>
  23 struct should be passed to all the vorbisfile functions.
  24 <p>
  25 It is often useful to call <tt>ov_open_callbacks()</tt>
  26 simply to determine whether a given file is a vorbis bitstream. If the
  27 <tt>ov_open_callbacks()</tt>
  28 call fails, then the file is not recognizable as such. When you use <tt>ov_open_callbacks()
  29 </tt>for
  30 this, you should <tt>fclose()</tt> the file pointer if, and only if, the
  31 <tt>ov_open_callbacks()</tt>
  32 call fails. If it succeeds, you must call <a href=ov_clear.html>ov_clear()</a> to clear
  33 the decoder's buffers and close the file for you.
  34 <br><br>
  35 <table border=0 color=black cellspacing=0 cellpadding=7>
  36 <tr bgcolor=#cccccc>
  37         <td>
  38 <pre><b>
  39 int ov_open_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);
  40 </b></pre>
  41         </td>
  42 </tr>
  43 </table>
  44
  45 <h3>Parameters</h3>
  46 <dl>
  47 <dt><i>f</i></dt>
  48 <dd>File pointer to an already opened file
  49 or pipe (it need not be seekable--though this obviously restricts what
  50 can be done with the bitstream).</dd>
  51 <dt><i>vf</i></dt>
  52 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
  53 functions. Once this has been called, the same <tt>OggVorbis_File</tt>
  54 struct should be passed to all the vorbisfile functions.</dd>
  55 <dt><i>initial</i></dt>
  56 <dd>Typically set to NULL.  This parameter is useful if some data has already been
  57 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>
  58 should be a pointer to a buffer containing the data read.</dd>
  59 <dt><i>ibytes</i></dt>
  60 <dd>Typically set to 0.  This parameter is useful if some data has already been
  61 read from the file and the stream is not seekable. In this case, <tt>ibytes</tt>
  62 should contain the length (in bytes) of the buffer.  Used together with <tt>initial</tt>.</dd>
  63 <dt><i>callbacks</i></dt>
  64 <dd>Pointer to a completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd>
  65 </dl>
  66
  67
  68 <h3>Return Values</h3>
  69 <blockquote>
  70 <li>
  71 0 for success</li>
  72 <li>less than zero for failure:</li>\r
  73 <ul>
  74 <li>OV_EREAD - A read from media returned an error.</li>\r
  75 <li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>\r
  76 <li>OV_EVERSION - Vorbis version mismatch.</li>\r
  77 <li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>\r
  78 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>\r
  79 </ul>
  80 </blockquote>
  81 <p>
  82
  83 <h3>Notes</h3>
  84 <p>If your decoder is threaded, it is recommended that you NOT call
  85 <tt>ov_open_callbacks()</tt>
  86 in the main control thread--instead, call <tt>ov_open_callbacks()</tt> IN your decode/playback
  87 thread. This is important because <tt>ov_open_callbacks()</tt> may be a fairly time-consuming
  88 call, given that the full structure of the file is determined at this point,
  89 which may require reading large parts of the file under certain circumstances
  90 (determining all the logical bitstreams in one physical bitstream, for
  91 example).
  92
  93 <br><br>
  94 <hr noshade>
  95 <table border=0 width=100%>
  96 <tr valign=top>
  97 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  98 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
  99 </tr><tr>
 100 <td><p class=tiny>vorbisfile documentation</p></td>
 101 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
 102 </tr>
 103 </table>
 104
 105
 106 </body>
 107
 108 </html>