doc/libvorbis/vorbis_analysis_blockout.html

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