|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libogg - Encoding</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>libogg documentation</p></td>
|
|
cannam@86
|
12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
13 </tr>
|
|
cannam@86
|
14 </table>
|
|
cannam@86
|
15
|
|
cannam@86
|
16 <h1>Encoding</h1>
|
|
cannam@86
|
17 <p>Libogg contains a set of functions used in the encoding process.
|
|
cannam@86
|
18 <p>
|
|
cannam@86
|
19 All the <b>libogg</b> specific functions are declared in "ogg/ogg.h".
|
|
cannam@86
|
20 <p>
|
|
cannam@86
|
21 <p>When encoding, the encoding engine will output raw packets which must be placed into an Ogg bitstream.
|
|
cannam@86
|
22 <p>Raw packets are inserted into the stream, and an <a href="ogg_page.html">ogg_page</a> is output when enough packets have been written to create a full page. The pages output are pointers to buffered packet segments, and can then be written out and saved as an ogg stream.
|
|
cannam@86
|
23 <p>There are a couple of basic steps:
|
|
cannam@86
|
24 <ul>
|
|
cannam@86
|
25 <li>Use the encoding engine to produce a raw packet of data.
|
|
cannam@86
|
26 <li>Call <a href="ogg_stream_packetin.html">ogg_stream_packetin</a> to submit a raw packet to the stream.
|
|
cannam@86
|
27 <li>Use <a href="ogg_stream_pageout.html">ogg_stream_pageout</a> to output a page, if enough data has been submitted. Otherwise, continue submitting data.
|
|
cannam@86
|
28 </ul>
|
|
cannam@86
|
29 <br><br>
|
|
cannam@86
|
30
|
|
cannam@86
|
31 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
|
|
cannam@86
|
32 <tr bgcolor=#cccccc>
|
|
cannam@86
|
33 <td><b>function</b></td>
|
|
cannam@86
|
34 <td><b>purpose</b></td>
|
|
cannam@86
|
35 </tr>
|
|
cannam@86
|
36 <tr valign=top>
|
|
cannam@86
|
37 <td><a href="ogg_stream_packetin.html">ogg_stream_packetin</a></td>
|
|
cannam@86
|
38 <td>Submits a raw packet to the streaming layer, so that it can be formed into a page.</td>
|
|
cannam@86
|
39 </tr>
|
|
cannam@86
|
40 <tr valign=top>
|
|
cannam@86
|
41 <td><a href="ogg_stream_iovecin.html">ogg_stream_iovecin</a></td>
|
|
cannam@86
|
42 <td>iovec version of ogg_stream_packetin() above.</td>
|
|
cannam@86
|
43 </tr>
|
|
cannam@86
|
44 <tr valign=top>
|
|
cannam@86
|
45 <td><a href="ogg_stream_pageout.html">ogg_stream_pageout</a></td>
|
|
cannam@86
|
46 <td>Outputs a completed page if the stream contains enough packets to form a full page.<td>
|
|
cannam@86
|
47 </tr>
|
|
cannam@86
|
48 <tr valign=top>
|
|
cannam@86
|
49 <td><a href="ogg_stream_pageout_fill.html">ogg_stream_pageout_fill</a></td>
|
|
cannam@86
|
50 <td>Similar to ogg_stream_pageout(), but specifies a page spill threshold in bytes.
|
|
cannam@86
|
51 </tr>
|
|
cannam@86
|
52 <tr valign=top>
|
|
cannam@86
|
53 <td><a href="ogg_stream_flush.html">ogg_stream_flush</a></td>
|
|
cannam@86
|
54 <td>Forces any remaining packets in the stream to be returned as a page of any size.<td>
|
|
cannam@86
|
55 </tr>
|
|
cannam@86
|
56 <tr valign=top>
|
|
cannam@86
|
57 <td><a href="ogg_stream_flush_fill.html">ogg_stream_flush_fill</a></td>
|
|
cannam@86
|
58 <td>Similar to ogg_stream_flush(), but specifies a page spill threshold in bytes.<td>
|
|
cannam@86
|
59 </tr>
|
|
cannam@86
|
60 </table>
|
|
cannam@86
|
61
|
|
cannam@86
|
62 <br><br>
|
|
cannam@86
|
63 <hr noshade>
|
|
cannam@86
|
64 <table border=0 width=100%>
|
|
cannam@86
|
65 <tr valign=top>
|
|
cannam@86
|
66 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td>
|
|
cannam@86
|
67 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
|
cannam@86
|
68 </tr><tr>
|
|
cannam@86
|
69 <td><p class=tiny>libogg documentation</p></td>
|
|
cannam@86
|
70 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
71 </tr>
|
|
cannam@86
|
72 </table>
|
|
cannam@86
|
73
|
|
cannam@86
|
74 </body>
|
|
cannam@86
|
75
|
|
cannam@86
|
76 </html>
|
