|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libvorbis - function - vorbis_analysis_headerout</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_analysis_headerout</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 creates and returns the three header packets needed
|
|
cannam@86
|
21 to configure a decoder to accept compressed data. I should be called
|
|
cannam@86
|
22 after all encoder initialization and configuration is complete. The
|
|
cannam@86
|
23 output packets should be placed in order at the start of the compressed
|
|
cannam@86
|
24 vorbis stream, prior to the first data packet.
|
|
cannam@86
|
25 </p>
|
|
cannam@86
|
26
|
|
cannam@86
|
27 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
28 <tr bgcolor=#cccccc>
|
|
cannam@86
|
29 <td>
|
|
cannam@86
|
30 <pre><b>
|
|
cannam@86
|
31 extern int vorbis_analysis_headerout(vorbis_dsp_state *v,
|
|
cannam@86
|
32 vorbis_comment *vc,
|
|
cannam@86
|
33 ogg_packet *op,
|
|
cannam@86
|
34 ogg_packet *op_comm,
|
|
cannam@86
|
35 ogg_packet *op_code);
|
|
cannam@86
|
36 </b></pre>
|
|
cannam@86
|
37 </td>
|
|
cannam@86
|
38 </tr>
|
|
cannam@86
|
39 </table>
|
|
cannam@86
|
40
|
|
cannam@86
|
41 <h3>Parameters</h3>
|
|
cannam@86
|
42 <dl>
|
|
cannam@86
|
43 <dt><i>v</i></dt>
|
|
cannam@86
|
44 <dd>Pointer to an initialized vorbis_dsp_state which holds the encoder configuration.</dd>
|
|
cannam@86
|
45 <dt><i>vc</i></dt>
|
|
cannam@86
|
46 <dd>Pointer to an initialized vorbis_comment structure which holds the metadata associated with the stream being encoded.</dd>
|
|
cannam@86
|
47 <dt><i>op</i></dt>
|
|
cannam@86
|
48 <dd>Pointer to an ogg_packet structure to be filled out with the stream identification header.</dd>
|
|
cannam@86
|
49 <dt><i>op_comm</i></dt>
|
|
cannam@86
|
50 <dd>Pointer to an ogg_packet structure to be filled out with the serialied vorbis_comment data.</dd>
|
|
cannam@86
|
51 <dt><i>op_code</i></dt>
|
|
cannam@86
|
52 <dd>Pointer to an ogg_packet structure to be filled out with the codebooks, mode descriptions, etc. which will be used encoding the stream.</dd>
|
|
cannam@86
|
53 </dl>
|
|
cannam@86
|
54
|
|
cannam@86
|
55
|
|
cannam@86
|
56 <h3>Return Values</h3>
|
|
cannam@86
|
57 <ul>
|
|
cannam@86
|
58 <li>0 for success</li>
|
|
cannam@86
|
59 <li>negative values for failure:
|
|
cannam@86
|
60 <ul>
|
|
cannam@86
|
61 <li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
|
|
cannam@86
|
62 <li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
|
|
cannam@86
|
63 </ul>
|
|
cannam@86
|
64 </li>
|
|
cannam@86
|
65 </ul>
|
|
cannam@86
|
66 <p>
|
|
cannam@86
|
67
|
|
cannam@86
|
68 <br><br>
|
|
cannam@86
|
69 <hr noshade>
|
|
cannam@86
|
70 <table border=0 width=100%>
|
|
cannam@86
|
71 <tr valign=top>
|
|
cannam@86
|
72 <td><p class=tiny>copyright © 2010 Xiph.Org</p></td>
|
|
cannam@86
|
73 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
|
|
cannam@86
|
74 </tr><tr>
|
|
cannam@86
|
75 <td><p class=tiny>libvorbis documentation</p></td>
|
|
cannam@86
|
76 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
|
|
cannam@86
|
77 </tr>
|
|
cannam@86
|
78 </table>
|
|
cannam@86
|
79
|
|
cannam@86
|
80
|
|
cannam@86
|
81 </body>
|
|
cannam@86
|
82
|
|
cannam@86
|
83 </html>
|
