| 1 |
<html> |
| 2 |
|
| 3 |
<head> |
| 4 |
<title>Tremor - 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>Tremor documentation</p></td> |
| 12 |
<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> |
| 13 |
</tr> |
| 14 |
</table> |
| 15 |
|
| 16 |
<h1>ov_open_callbacks</h1> |
| 17 |
|
| 18 |
<p><i>declared in "ivorbisfile.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 libvorbisidec 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.<p> |
| 34 |
|
| 35 |
See also <a href="callbacks.html">Callbacks and Non-stdio I/O</a> for information on designing and specifying the required callback functions.<p> |
| 36 |
|
| 37 |
<br><br> |
| 38 |
<table border=0 color=black cellspacing=0 cellpadding=7> |
| 39 |
<tr bgcolor=#cccccc> |
| 40 |
<td> |
| 41 |
<pre><b> |
| 42 |
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); |
| 43 |
</b></pre> |
| 44 |
</td> |
| 45 |
</tr> |
| 46 |
</table> |
| 47 |
|
| 48 |
<h3>Parameters</h3> |
| 49 |
<dl> |
| 50 |
<dt><i>f</i></dt> |
| 51 |
<dd>File pointer to an already opened file |
| 52 |
or pipe (it need not be seekable--though this obviously restricts what |
| 53 |
can be done with the bitstream).</dd> |
| 54 |
<dt><i>vf</i></dt> |
| 55 |
<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec |
| 56 |
functions. Once this has been called, the same <tt>OggVorbis_File</tt> |
| 57 |
struct should be passed to all the libvorbisidec functions.</dd> |
| 58 |
<dt><i>initial</i></dt> |
| 59 |
<dd>Typically set to NULL. This parameter is useful if some data has already been |
| 60 |
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> |
| 61 |
should be a pointer to a buffer containing the data read.</dd> |
| 62 |
<dt><i>ibytes</i></dt> |
| 63 |
<dd>Typically set to 0. This parameter is useful if some data has already been |
| 64 |
read from the file and the stream is not seekable. In this case, <tt>ibytes</tt> |
| 65 |
should contain the length (in bytes) of the buffer. Used together with <tt>initial</tt>.</dd> |
| 66 |
<dt><i>callbacks</i></dt> |
| 67 |
<dd>Pointer to a completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd> |
| 68 |
</dl> |
| 69 |
|
| 70 |
|
| 71 |
<h3>Return Values</h3> |
| 72 |
<blockquote> |
| 73 |
<li>0 for success</li> |
| 74 |
<li>less than zero for failure:</li> |
| 75 |
<ul> |
| 76 |
<li>OV_EREAD - A read from media returned an error.</li> |
| 77 |
<li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li> |
| 78 |
<li>OV_EVERSION - Vorbis version mismatch.</li> |
| 79 |
<li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li> |
| 80 |
<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li> |
| 81 |
</ul> |
| 82 |
</blockquote> |
| 83 |
<p> |
| 84 |
|
| 85 |
<h3>Notes</h3> |
| 86 |
<p>If your decoder is threaded, it is recommended that you NOT call |
| 87 |
<tt>ov_open_callbacks()</tt> |
| 88 |
in the main control thread--instead, call <tt>ov_open_callbacks()</tt> IN your decode/playback |
| 89 |
thread. This is important because <tt>ov_open_callbacks()</tt> may be a fairly time-consuming |
| 90 |
call, given that the full structure of the file is determined at this point, |
| 91 |
which may require reading large parts of the file under certain circumstances |
| 92 |
(determining all the logical bitstreams in one physical bitstream, for |
| 93 |
example). |
| 94 |
See <a href="threads.html">Thread Safety</a> for other information on using libvorbisidec with threads. |
| 95 |
|
| 96 |
<br><br> |
| 97 |
<hr noshade> |
| 98 |
<table border=0 width=100%> |
| 99 |
<tr valign=top> |
| 100 |
<td><p class=tiny>copyright © 2002 Xiph.org</p></td> |
| 101 |
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> |
| 102 |
</tr><tr> |
| 103 |
<td><p class=tiny>Tremor documentation</p></td> |
| 104 |
<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> |
| 105 |
</tr> |
| 106 |
</table> |
| 107 |
|
| 108 |
</body> |
| 109 |
|
| 110 |
</html> |