|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libvorbis - function - vorbis_bitrate_flushpacket</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_bitrate_flushpacket</h1>
|
|
cannam@86
|
17
|
|
cannam@86
|
18 <p><i>declared in "vorbis/codec.h";</i></p>
|
|
cannam@86
|
19
|
|
cannam@86
|
20 <p>This function returns the next available completed packet from the
|
|
cannam@86
|
21 bitrate management engine. It should be called in a loop after any call
|
|
cannam@86
|
22 to vorbis_bitrate_addblock() until it returns either 0 (more data needed)
|
|
cannam@86
|
23 or a negative value (error).
|
|
cannam@86
|
24 </p>
|
|
cannam@86
|
25
|
|
cannam@86
|
26 <p>
|
|
cannam@86
|
27 The data returned in the ogg_packet structure can be copied to the
|
|
cannam@86
|
28 final compressed output stream.
|
|
cannam@86
|
29 </p>
|
|
cannam@86
|
30
|
|
cannam@86
|
31 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
32 <tr bgcolor=#cccccc>
|
|
cannam@86
|
33 <td>
|
|
cannam@86
|
34 <pre><b>
|
|
cannam@86
|
35 extern int vorbis_bitrate_flushpacket(vorbis_dsp_state *vd,
|
|
cannam@86
|
36 ogg_packet *op);
|
|
cannam@86
|
37 </b></pre>
|
|
cannam@86
|
38 </td>
|
|
cannam@86
|
39 </tr>
|
|
cannam@86
|
40 </table>
|
|
cannam@86
|
41
|
|
cannam@86
|
42 <h3>Parameters</h3>
|
|
cannam@86
|
43 <dl>
|
|
cannam@86
|
44 <dt><i>vd</i></dt>
|
|
cannam@86
|
45 <dd>Pointer to the vorbis_dsp_state represending the encoder.</dd>
|
|
cannam@86
|
46 <dt><i>op</i></dt>
|
|
cannam@86
|
47 <dd>Pointer to an ogg_packet to be filled out with the compressed data.</dd>
|
|
cannam@86
|
48 </dl>
|
|
cannam@86
|
49
|
|
cannam@86
|
50
|
|
cannam@86
|
51 <h3>Return Values</h3>
|
|
cannam@86
|
52 <ul>
|
|
cannam@86
|
53 <li>1 for success when more packets are available.
|
|
cannam@86
|
54 <li>0 for success when this is the last packet available from the current input.</li>
|
|
cannam@86
|
55 <li>negative values for failure:
|
|
cannam@86
|
56 <ul>
|
|
cannam@86
|
57 <li>OV_EINVAL - Invalid parameters.</li>
|
|
cannam@86
|
58 <li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
|
|
cannam@86
|
59 <li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
|
|
cannam@86
|
60 </ul>
|
|
cannam@86
|
61 </li>
|
|
cannam@86
|
62
|
|
cannam@86
|
63 </ul>
|
|
cannam@86
|
64
|
|
cannam@86
|
65 <br><br>
|
|
cannam@86
|
66 <hr noshade>
|
|
cannam@86
|
67 <table border=0 width=100%>
|
|
cannam@86
|
68 <tr valign=top>
|
|
cannam@86
|
69 <td><p class=tiny>copyright © 2010 Xiph.Org</p></td>
|
|
cannam@86
|
70 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
|
|
cannam@86
|
71 </tr><tr>
|
|
cannam@86
|
72 <td><p class=tiny>libvorbis documentation</p></td>
|
|
cannam@86
|
73 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
|
|
cannam@86
|
74 </tr>
|
|
cannam@86
|
75 </table>
|
|
cannam@86
|
76
|
|
cannam@86
|
77
|
|
cannam@86
|
78 </body>
|
|
cannam@86
|
79
|
|
cannam@86
|
80 </html>
|
