00001 <html>
00002
00003 <head>
00004 <title>Vorbisfile - function - ov_read_float</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>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ov_read_float()</h1>
00017
00018 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
00019
00020 <p>
00021 This is the function used to decode a Vorbis file within a loop, but
00022 returns samples in native float format instead of in integer formats.
00023 </p><p>
00024 For more information on how ov_read_float() deals with the complex issues
00025 of chaining, etc, refer to the documentation for <a href="ov_read.html">ov_read()</a>.
00026 </p>
00027
00028 <br><br>
00029 <table border=0 color=black cellspacing=0 cellpadding=7>
00030 <tr bgcolor=#cccccc>
00031 <td>
00032 <pre><b>
00033 long ov_read_float(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, float ***pcm_channels, int samples, int *bitstream);
00034 </b></pre>
00035 </td>
00036 </tr>
00037 </table>
00038
00039 <h3>Parameters</h3>
00040 <dl>
00041 <dt><i>vf</i></dt>
00042 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
00043 functions.</dd>
00044 <dt><i>pcm_channels</i></dt>
00045 <dd>A pointer to an output buffer. The pointer will be set to the decoded output buffer.</dd>
00046 <dt><i>samples</i></dt>
00047 <dd>Maximum number of decoded samples to produce.</dd>
00048 <dt><i>bitstream</i></dt>
00049 <dd>A pointer to the number of the current logical bitstream.</dd>
00050 </dl>
00051
00052
00053 <h3>Return Values</h3>
00054 <blockquote>
00055 <dl>
00056 <dt>OV_HOLE</dt>
00057 <dd>indicates there was an interruption in the data.
00058 <br>(one of: garbage between pages, loss of sync followed by
00059 recapture, or a corrupt page)</dd>
00060 <dt>OV_EBADLINK</dt>
00061 <dd>indicates that an invalid stream section was supplied to
00062 libvorbisfile, or the requested link is corrupt.</dd>
00063 <dt>0</dt>
00064 <dd>indicates EOF</dd>
00065 <dt><i>n</i></dt>
00066 <dd>indicates actual number of samples read. <tt>ov_read_float()</tt> will
00067 decode at most one vorbis packet per invocation, so the value
00068 returned will generally be less than <tt>length</tt>.
00069 </dl>
00070 </blockquote>
00071
00072 <h3>Notes</h3>
00073 <p><b>Typical usage:</b>
00074 <blockquote>
00075 <tt>float **pcm;
00076 samples_read = ov_read_float(&vf,pcm, 1024, &current_section)</tt>
00077 </blockquote>
00078
00079 This decodes up to 1024 float samples.
00080 </p>
00081
00082 <br>
00083 <br><br>
00084 <hr noshade>
00085 <table border=0 width=100%>
00086 <tr valign=top>
00087 <td><p class=tiny>copyright © 2002 vorbis team</p></td>
00088 <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>
00089 </tr><tr>
00090 <td><p class=tiny>Vorbisfile documentation</p></td>
00091 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00092 </tr>
00093 </table>
00094
00095
00096 </body>
00097
00098 </html>
00099
00100
00101
