vorbis_encode_init.html 2.66 KB
Newer Older
Jack Moffitt's avatar
Jack Moffitt committed
1
2
3
4
5
6
7
8
9
10
11
<html>

<head>
<title>libvorbisenc - function - vorbis_encode_init</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>

<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
<td><p class=tiny>libvorbisenc documentation</p></td>
12
<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
Jack Moffitt's avatar
Jack Moffitt committed
13
14
15
16
17
</tr>
</table>

<h1>vorbis_encode_init</h1>

18
<p><i>declared in "vorbis/vorbisenc.h";</i></p>
Jack Moffitt's avatar
Jack Moffitt committed
19

20
<p>This is the primary function within libvorbisenc for setting up managed bitrate modes.
Jack Moffitt's avatar
Jack Moffitt committed
21
22
23
24
25
26
27
28
<p>Before this function is called, the <a href="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.
<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.
<p>
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
	<td>
<pre><b>
29
30
31
32
33
34
35
extern int vorbis_encode_init(<a href="vorbis_info.html">vorbis_info</a> *vi,
			      long channels,
			      long rate,
			      
			      long max_bitrate,
			      long nominal_bitrate,
			      long min_bitrate);
Jack Moffitt's avatar
Jack Moffitt committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

</b></pre>
	</td>
</tr>
</table>

<h3>Parameters</h3>
<dl>
<dt><i>vi</i></dt>
<dd>File pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
<dt><i>channels</i></dt>
<dd>The number of channels to be encoded.</dd>
<dt><i>rate</i></dt>
<dd>The sampling rate of the source audio.</dd>
<dt><i>max_bitrate</i></dt>
51
<dd>Desired maximum bitrate (limit). -1 indicates unset.</dd>
Jack Moffitt's avatar
Jack Moffitt committed
52
<dt><i>nominal_bitrate</i></dt>
53
<dd>Desired average, or central, bitrate. -1 indicates unset.</dd>
Jack Moffitt's avatar
Jack Moffitt committed
54
<dt><i>min_bitrate</i></dt>
55
<dd>Desired minimum bitrate. -1 indicates unset.</dd>
Jack Moffitt's avatar
Jack Moffitt committed
56
57
58
59
60
61
62
63
</dl>


<h3>Return Values</h3>
<blockquote>
<li>
0 for success</li>

64
65
<li>less than zero for failure:</li>
<ul>
Jack Moffitt's avatar
Jack Moffitt committed
66
<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
67
68
<li>OV_EINVAL - Invalid setup request, eg, out of range argument. </li>
<li>OV_EIMPL  - Unimplemented mode; unable to comply with bitrate request.</li>
69
</ul>
Jack Moffitt's avatar
Jack Moffitt committed
70
71
72
73
74
75
76
</blockquote>
<p>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
77
<td><p class=tiny>copyright &copy; 2004 xiph.org</p></td>
Jack Moffitt's avatar
Jack Moffitt committed
78
79
80
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>libvorbisenc documentation</p></td>
81
<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
Jack Moffitt's avatar
Jack Moffitt committed
82
83
84
85
86
87
88
</tr>
</table>


</body>

</html>