|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libvorbisenc - function - vorbis_encode_init</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>libvorbisenc documentation</p></td>
|
|
cannam@86
|
12 <td align=right><p class=tiny>libvorbisenc version 1.3.2 - 20101101</p></td>
|
|
cannam@86
|
13 </tr>
|
|
cannam@86
|
14 </table>
|
|
cannam@86
|
15
|
|
cannam@86
|
16 <h1>vorbis_encode_init</h1>
|
|
cannam@86
|
17
|
|
cannam@86
|
18 <p><i>declared in "vorbis/vorbisenc.h";</i></p>
|
|
cannam@86
|
19
|
|
cannam@86
|
20 <p>This is the primary function within libvorbisenc for setting up managed bitrate modes.
|
|
cannam@86
|
21 <p>Before this function is called, the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct should be initialized by using vorbis_info_init() from the libvorbis API. After encoding, vorbis_info_clear should be called.
|
|
cannam@86
|
22 <p>The max_bitrate, nominal_bitrate, and min_bitrate settings are used to set constraints for the encoded file. This function uses these settings to select the appropriate encoding mode and set it up.
|
|
cannam@86
|
23 <p>
|
|
cannam@86
|
24 <br><br>
|
|
cannam@86
|
25 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
26 <tr bgcolor=#cccccc>
|
|
cannam@86
|
27 <td>
|
|
cannam@86
|
28 <pre><b>
|
|
cannam@86
|
29 extern int vorbis_encode_init(<a href="../libvorbis/vorbis_info.html">vorbis_info</a> *vi,
|
|
cannam@86
|
30 long channels,
|
|
cannam@86
|
31 long rate,
|
|
cannam@86
|
32
|
|
cannam@86
|
33 long max_bitrate,
|
|
cannam@86
|
34 long nominal_bitrate,
|
|
cannam@86
|
35 long min_bitrate);
|
|
cannam@86
|
36
|
|
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>vi</i></dt>
|
|
cannam@86
|
45 <dd>Pointer to an initialized <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct.</dd>
|
|
cannam@86
|
46 <dt><i>channels</i></dt>
|
|
cannam@86
|
47 <dd>The number of channels to be encoded.</dd>
|
|
cannam@86
|
48 <dt><i>rate</i></dt>
|
|
cannam@86
|
49 <dd>The sampling rate of the source audio.</dd>
|
|
cannam@86
|
50 <dt><i>max_bitrate</i></dt>
|
|
cannam@86
|
51 <dd>Desired maximum bitrate (limit). -1 indicates unset.</dd>
|
|
cannam@86
|
52 <dt><i>nominal_bitrate</i></dt>
|
|
cannam@86
|
53 <dd>Desired average, or central, bitrate. -1 indicates unset.</dd>
|
|
cannam@86
|
54 <dt><i>min_bitrate</i></dt>
|
|
cannam@86
|
55 <dd>Desired minimum bitrate. -1 indicates unset.</dd>
|
|
cannam@86
|
56 </dl>
|
|
cannam@86
|
57
|
|
cannam@86
|
58
|
|
cannam@86
|
59 <h3>Return Values</h3>
|
|
cannam@86
|
60 <blockquote>
|
|
cannam@86
|
61 <li>
|
|
cannam@86
|
62 0 for success</li>
|
|
cannam@86
|
63
|
|
cannam@86
|
64 <li>less than zero for failure:</li>
|
|
cannam@86
|
65 <ul>
|
|
cannam@86
|
66 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
|
|
cannam@86
|
67 <li>OV_EINVAL - Invalid setup request, eg, out of range argument. </li>
|
|
cannam@86
|
68 <li>OV_EIMPL - Unimplemented mode; unable to comply with bitrate request.</li>
|
|
cannam@86
|
69 </ul>
|
|
cannam@86
|
70 </blockquote>
|
|
cannam@86
|
71 <p>
|
|
cannam@86
|
72
|
|
cannam@86
|
73 <br><br>
|
|
cannam@86
|
74 <hr noshade>
|
|
cannam@86
|
75 <table border=0 width=100%>
|
|
cannam@86
|
76 <tr valign=top>
|
|
cannam@86
|
77 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td>
|
|
cannam@86
|
78 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
|
|
cannam@86
|
79 </tr><tr>
|
|
cannam@86
|
80 <td><p class=tiny>libvorbisenc documentation</p></td>
|
|
cannam@86
|
81 <td align=right><p class=tiny>libvorbisenc version 1.3.2 - 20101101</p></td>
|
|
cannam@86
|
82 </tr>
|
|
cannam@86
|
83 </table>
|
|
cannam@86
|
84
|
|
cannam@86
|
85
|
|
cannam@86
|
86 </body>
|
|
cannam@86
|
87
|
|
cannam@86
|
88 </html>
|
