annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_analysis_blockout.html @ 86:98c1576536ae

Bring in flac, ogg, vorbis
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
cannam@86 1 <html>
cannam@86 2
cannam@86 3 <head>
cannam@86 4 <title>libvorbis - function - vorbis_analysis_blockout</title>
cannam@86 5 <link rel=stylesheet href="style.css" type="text/css">
cannam@86 6 </head>
cannam@86 7
cannam@86 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
cannam@86 9 <table border=0 width=100%>
cannam@86 10 <tr>
cannam@86 11 <td><p class=tiny>libvorbis documentation</p></td>
cannam@86 12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
cannam@86 13 </tr>
cannam@86 14 </table>
cannam@86 15
cannam@86 16 <h1>vorbis_analysis_blockout</h1>
cannam@86 17
cannam@86 18 <p><i>declared in "vorbis/codec.h";</i></p>
cannam@86 19
cannam@86 20 <p>This fuction examines the available uncompressed data and tries to
cannam@86 21 break it into appropriate sized blocks. It should be called in a loop
cannam@86 22 after adding new data with vorbis_analysis_buffer()/vorbis_analysis_wrote()
cannam@86 23 until it returns zero (need more data) or an negative value (error).
cannam@86 24 </p>
cannam@86 25 <p>
cannam@86 26 Each block returned should be passed to vorbis_analysis() for transform
cannam@86 27 and coding.
cannam@86 28 </p>
cannam@86 29
cannam@86 30 <table border=0 color=black cellspacing=0 cellpadding=7>
cannam@86 31 <tr bgcolor=#cccccc>
cannam@86 32 <td>
cannam@86 33 <pre><b>
cannam@86 34 extern int vorbis_analysis_blockout(vorbis_dsp_state *v,vorbis_block *vb);
cannam@86 35 </b></pre>
cannam@86 36 </td>
cannam@86 37 </tr>
cannam@86 38 </table>
cannam@86 39
cannam@86 40 <h3>Parameters</h3>
cannam@86 41 <dl>
cannam@86 42 <dt><i>v</i></dt>
cannam@86 43 <dd>Pointer to the vorbis_dsp_state representing the encoder.</dd>
cannam@86 44 <dt><i>vb</i></dt>
cannam@86 45 <dd>Pointer to a previously initialized vorbis_block object to hold the
cannam@86 46 returned data.
cannam@86 47 </dl>
cannam@86 48
cannam@86 49
cannam@86 50 <h3>Return Values</h3>
cannam@86 51 <ul>
cannam@86 52 <li>1 for success when more blocks are available.</li>
cannam@86 53 <li>0 for success when this is the last block available from the current input.</li>
cannam@86 54 <li>negative values for failure:
cannam@86 55 <ul>
cannam@86 56 <li>OV_EINVAL - Invalid parameters.</li>
cannam@86 57 <li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
cannam@86 58 <li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
cannam@86 59 </ul>
cannam@86 60 </li>
cannam@86 61
cannam@86 62 </ul>
cannam@86 63
cannam@86 64 <br><br>
cannam@86 65 <hr noshade>
cannam@86 66 <table border=0 width=100%>
cannam@86 67 <tr valign=top>
cannam@86 68 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
cannam@86 69 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
cannam@86 70 </tr><tr>
cannam@86 71 <td><p class=tiny>libvorbis documentation</p></td>
cannam@86 72 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
cannam@86 73 </tr>
cannam@86 74 </table>
cannam@86 75
cannam@86 76
cannam@86 77 </body>
cannam@86 78
cannam@86 79 </html>