annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_analysis_wrote.html @ 1:05aa0afa9217

Bring in flac, ogg, vorbis
author Chris Cannam
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
Chris@1 1 <html>
Chris@1 2
Chris@1 3 <head>
Chris@1 4 <title>libvorbis - function - vorbis_analysis_wrote</title>
Chris@1 5 <link rel=stylesheet href="style.css" type="text/css">
Chris@1 6 </head>
Chris@1 7
Chris@1 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
Chris@1 9 <table border=0 width=100%>
Chris@1 10 <tr>
Chris@1 11 <td><p class=tiny>libvorbis documentation</p></td>
Chris@1 12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
Chris@1 13 </tr>
Chris@1 14 </table>
Chris@1 15
Chris@1 16 <h1>vorbis_analysis_wrote</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "vorbis/codec.h";</i></p>
Chris@1 19
Chris@1 20 <p>This function tells the encoder new data is available for compression.
Chris@1 21 Call this after writing new audio into the buffer array returned by
Chris@1 22 vorbis_analysis_buffer().
Chris@1 23 </p>
Chris@1 24
Chris@1 25 <p>
Chris@1 26 Call with the <i>vals</i> parameter set to zero to signal the end
Chris@1 27 of the input data.
Chris@1 28 </p>
Chris@1 29
Chris@1 30 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 31 <tr bgcolor=#cccccc>
Chris@1 32 <td>
Chris@1 33 <pre><b>
Chris@1 34 extern int vorbis_analysis_wrote(vorbis_dsp_state *v,int vals);
Chris@1 35 </b></pre>
Chris@1 36 </td>
Chris@1 37 </tr>
Chris@1 38 </table>
Chris@1 39
Chris@1 40 <h3>Parameters</h3>
Chris@1 41 <dl>
Chris@1 42 <dt><i>v</i></dt>
Chris@1 43 <dd>Pointer to the vorbis_dsp_state representing the encoder.</dd>
Chris@1 44 <dt><i>vals</i></dt>
Chris@1 45 <dd>Number of samples successfully written. This must be less than
Chris@1 46 or equal to the value passed to vorbis_analysis_buffer(). A value
Chris@1 47 of zero means all input data has been provided and the compressed
Chris@1 48 stream should be finalized.</dd>
Chris@1 49 </dl>
Chris@1 50
Chris@1 51
Chris@1 52 <h3>Return Values</h3>
Chris@1 53 <ul>
Chris@1 54 <li>0 for success</li>
Chris@1 55 <li>negative values for failure:
Chris@1 56 <ul>
Chris@1 57 <li>OV_EINVAL - Invalid request; e.g. vals overflows the allocated space.</li>
Chris@1 58 <li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
Chris@1 59 <li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
Chris@1 60 </ul>
Chris@1 61 </li>
Chris@1 62 </ul>
Chris@1 63 <p>
Chris@1 64
Chris@1 65 <br><br>
Chris@1 66 <hr noshade>
Chris@1 67 <table border=0 width=100%>
Chris@1 68 <tr valign=top>
Chris@1 69 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
Chris@1 70 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
Chris@1 71 </tr><tr>
Chris@1 72 <td><p class=tiny>libvorbis documentation</p></td>
Chris@1 73 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
Chris@1 74 </tr>
Chris@1 75 </table>
Chris@1 76
Chris@1 77
Chris@1 78 </body>
Chris@1 79
Chris@1 80 </html>