123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106 |
- <html>
- <head>
- <title>vorbisfile - datatype - OggVorbis_File</title>
- <link rel=stylesheet href="style.css" type="text/css">
- </head>
- <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
- <table border=0 width=100%>
- <tr>
- <td><p class=tiny>vorbisfile documentation</p></td>
- <td align=right><p class=tiny>vorbisfile - 20011218</p></td>
- </tr>
- </table>
- <h1>OggVorbis_File</h1>
- <p><i>declared in "vorbis/vorbisfile.h"</i></p>
- <p>
- The OggVorbis_File structure defines an Ogg Vorbis file.
- <p>
- This structure is used in all vorbisfile routines. Before it can be used, it must be initialized by <a href="ov_open.html">ov_open</a> or <a href="ov_open_callbacks.html">ov_open_callbacks</a>.
- <p>
- After use, the OggVorbis_File structure must be deallocated with a call to <a href="ov_clear.html">ov_clear()</a>.
- <p>Once a file or data source is passed to libvorbisfile, it is owned by vorbisfile. The file should not be used by any other applications or functions outside the Vorbisfile API.
- <br><br>
- <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
- <tr bgcolor=#cccccc>
- <td>
- <pre><b>typedef struct {
- void *datasource; /* Pointer to a FILE *, etc. */
- int seekable;
- int64_t offset;
- int64_t end;
- ogg_sync_state oy;
- /* If the FILE handle isn't seekable (eg, a pipe), only the current
- stream appears */
- int links;
- int64_t *offsets;
- int64_t *dataoffsets;
- long *serialnos;
- int64_t *pcmlengths;
- vorbis_info *vi;
- vorbis_comment *vc;
- /* Decoding working state local storage */
- int64_t pcm_offset;
- int ready_state;
- long current_serialno;
- int current_link;
- double bittrack;
- double samptrack;
- ogg_stream_state os; /* take physical pages, weld into a logical
- stream of packets */
- vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
- vorbis_block vb; /* local working space for packet->PCM decode */
- <a href="ov_callbacks.html">ov_callbacks</a> callbacks;
- } OggVorbis_File;</b></pre>
- </td>
- </tr>
- </table>
- <h3>Relevant Struct Members</h3>
- <dl>
- <dt><i>datasource</i></dt>
- <dd>Pointer to file or other ogg source.</dd>
- <dt><i>seekable</i></dt>
- <dd>Read-only int indicating whether file is seekable, i.e., physical file is seekable, a pipe isn't.</dd>
- <dt><i>links</i></dt>
- <dd>Read-only int indicating the number of logical bitstreams within the physical bitstream.</dd>
- <dt><i>ov_callbacks</i></dt>
- <dd>Collection of file manipulation routines to be used on this data source.</dd>
- </dl>
- <h3>Notes</h3>
- <p>If your system's <tt><sys/types.h></tt> does not
- define <tt>int64_t,</tt> you will need to define this as a 64-bit type
- inside your system's project file/Makefile, etc. On win32, for example,
- this should be defined as <tt>__int64</tt>. On the Unix platform, these
- are usually defined properly in the system header files.
- <p>
- <br><br>
- <hr noshade>
- <table border=0 width=100%>
- <tr valign=top>
- <td><p class=tiny>copyright © 2001 vorbis team</p></td>
- <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>
- </tr><tr>
- <td><p class=tiny>vorbisfile documentation</p></td>
- <td align=right><p class=tiny>vorbisfile - 20011218</p></td>
- </tr>
- </table>
- </body>
- </html>
|