1 <html> 2 3 <head> 4 <title>Vorbisfile - function - ov_read_float</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.2.0 - 20070723</p></td> 13 </tr> 14 </table> 15 16 <h1>ov_read_float()</h1> 17 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p> 19 20 <p> 21 This is the function used to decode a Vorbis file within a loop, but 22 returns samples in native float format instead of in integer formats. 23 </p><p> 24 For information on channel ordering and how ov_read_float() deals with the complex issues 25 of chaining, etc, refer to the documentation for <a href="ov_read.html">ov_read()</a>. 26 </p> 27 28 <br><br> 29 <table border=0 color=black cellspacing=0 cellpadding=7> 30 <tr bgcolor=#cccccc> 31 <td> 32 <pre><b> 33 long ov_read_float(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, float ***pcm_channels, int samples, int *bitstream); 34 </b></pre> 35 </td> 36 </tr> 37 </table> 38 39 <h3>Parameters</h3> 40 <dl> 41 <dt><i>vf</i></dt> 42 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile 43 functions.</dd> 44 <dt><i>pcm_channels</i></dt> 45 <dd>A pointer to an output buffer. The pointer will be set to the decoded output buffer.</dd> 46 <dt><i>samples</i></dt> 47 <dd>Maximum number of decoded samples to produce.</dd> 48 <dt><i>bitstream</i></dt> 49 <dd>A pointer to the number of the current logical bitstream.</dd> 50 </dl> 51 52 53 <h3>Return Values</h3> 54 <blockquote> 55 <dl> 56 <dt>OV_HOLE</dt> 57 <dd>indicates there was an interruption in the data. 58 <br>(one of: garbage between pages, loss of sync followed by 59 recapture, or a corrupt page)</dd> 60 <dt>OV_EBADLINK</dt> 61 <dd>indicates that an invalid stream section was supplied to 62 libvorbisfile, or the requested link is corrupt.</dd> 63 <dt>OV_EINVAL</dt> 64 <dd>indicates the initial file headers couldn't be read or 65 are corrupt, or that the initial open call for <i>vf</i> 66 failed.</dd> 67 <dt>0</dt> 68 <dd>indicates EOF</dd> 69 <dt><i>n</i></dt> 70 <dd>indicates actual number of samples read. <tt>ov_read_float()</tt> will 71 decode at most one vorbis packet per invocation, so the value 72 returned will generally be less than <tt>length</tt>. 73 </dl> 74 </blockquote> 75 76 <h3>Notes</h3> 77 <p><b>Typical usage:</b> 78 <blockquote> 79 <tt>float **pcm; 80 samples_read = ov_read_float(&vf,pcm, 1024, &current_section)</tt> 81 </blockquote> 82 83 This decodes up to 1024 float samples. 84 </p> 85 86 <br> 87 <br><br> 88 <hr noshade> 89 <table border=0 width=100%> 90 <tr valign=top> 91 <td><p class=tiny>copyright © 2002 vorbis team</p></td> 92 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team (a] vorbis.org">team (a] vorbis.org</a></p></td> 93 </tr><tr> 94 <td><p class=tiny>Vorbisfile documentation</p></td> 95 <td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td> 96 </tr> 97 </table> 98 99 100 </body> 101 102 </html> 103 104 105 106
