Imported Upstream version 1.3.3
[platform/upstream/libvorbis.git] / doc / libvorbis / vorbis_bitrate_addblock.html
1 <html>
2
3 <head>
4 <title>libvorbis - function - vorbis_bitrate_addblock</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_bitrate_addblock</h1>
17
18 <p><i>declared in "vorbis/codec.h";</i></p>
19
20 <p>This fuction submits a transformed block to the bitrate management
21 engine for final encoding. Packets are buffered and the packet boundaries
22 adjusted and padded to meet the target bitrate, if any.</p>
23
24 <p>After calling vorbis_bitrate_addblock(), the passed vorbis_block
25 structure can be reused in another call to vorbis_analysis_blockout().
26 Call vorbis_bitrate_flushpacket() to obtain the final compressed data.
27 </p>
28
29 <table border=0 color=black cellspacing=0 cellpadding=7>
30 <tr bgcolor=#cccccc>
31         <td>
32 <pre><b>
33 extern int      vorbis_bitrate_addblock(vorbis_block *vb);
34 </b></pre>
35         </td>
36 </tr>
37 </table>
38
39 <h3>Parameters</h3>
40 <dl>
41 <dt><i>vb</i></dt>
42 <dd>Pointer to the vorbis_block to be submitted.</dd>
43 </dl>
44
45
46 <h3>Return Values</h3>
47 <ul>
48 <li>0 for success.</li>
49 <li>negative values for failure:
50 <ul>
51 <li>OV_EINVAL - Invalid parameters.</li> 
52 <li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
53 <li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
54 </ul>
55 </li>
56
57 </ul>
58
59 <br><br>
60 <hr noshade>
61 <table border=0 width=100%>
62 <tr valign=top>
63 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
64 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
65 </tr><tr>
66 <td><p class=tiny>libvorbis documentation</p></td>
67 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
68 </tr>
69 </table>
70
71
72 </body>
73
74 </html>