|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libogg - function - ogg_stream_pageout_fill</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>ogg_stream_pageout_fill</h1>
|
|
cannam@86
|
17
|
|
cannam@86
|
18 <p><i>declared in "ogg/ogg.h";</i></p>
|
|
cannam@86
|
19
|
|
cannam@86
|
20 <p>This function forms packets into pages, similar
|
|
cannam@86
|
21 to <a href="ogg_stream_pageout.html">ogg_stream_pageout()</a>, but
|
|
cannam@86
|
22 allows applications to explicitly request a specific page spill
|
|
cannam@86
|
23 size.</p>
|
|
cannam@86
|
24
|
|
cannam@86
|
25 <p>In a typical encoding situation, this would be called after using <a
|
|
cannam@86
|
26 href="ogg_stream_packetin.html">ogg_stream_packetin()</a> to submit
|
|
cannam@86
|
27 data packets to the bitstream. Internally, this function assembles
|
|
cannam@86
|
28 the accumulated packet bodies into an Ogg page suitable for writing
|
|
cannam@86
|
29 to a stream. The function is typically called in a loop until there
|
|
cannam@86
|
30 are no more pages ready for output.</p>
|
|
cannam@86
|
31
|
|
cannam@86
|
32 <p>This function will return a page when at least four packets have
|
|
cannam@86
|
33 been accumulated and accumulated packet data meets or exceeds the
|
|
cannam@86
|
34 specified number of bytes, <b>and/or</b> when the accumulated packet
|
|
cannam@86
|
35 data meets/exceeds the maximum page size regardless of accumulated
|
|
cannam@86
|
36 packet count.
|
|
cannam@86
|
37 Call <a href="ogg_stream_flush.html">ogg_stream_flush()</a> or
|
|
cannam@86
|
38 <a href="ogg_stream_flush_fill.html">ogg_stream_flush_fill()</a> if
|
|
cannam@86
|
39 immediate page generation is desired regardless of accumulated data.</p>
|
|
cannam@86
|
40
|
|
cannam@86
|
41 <br><br>
|
|
cannam@86
|
42 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
43 <tr bgcolor=#cccccc>
|
|
cannam@86
|
44 <td>
|
|
cannam@86
|
45 <pre><b>
|
|
cannam@86
|
46 int ogg_stream_pageout_fill(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og, int fillbytes);
|
|
cannam@86
|
47 </b></pre>
|
|
cannam@86
|
48 </td>
|
|
cannam@86
|
49 </tr>
|
|
cannam@86
|
50 </table>
|
|
cannam@86
|
51
|
|
cannam@86
|
52 <h3>Parameters</h3>
|
|
cannam@86
|
53 <dl>
|
|
cannam@86
|
54 <dt><i>os</i></dt>
|
|
cannam@86
|
55 <dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
|
|
cannam@86
|
56 <dt><i>og</i></dt>
|
|
cannam@86
|
57 <dd>Pointer to an <a href="ogg_page.html">ogg_page</a> structure to fill
|
|
cannam@86
|
58 in. Data pointed to is owned by libogg. The structure is valid until the
|
|
cannam@86
|
59 next call to ogg_stream_pageout(), ogg_stream_packetin(), or
|
|
cannam@86
|
60 ogg_stream_flush().</dd>
|
|
cannam@86
|
61 <dt><i>fillbytes</i></dt>
|
|
cannam@86
|
62 <dd>Packet data watermark in bytes.</dd>
|
|
cannam@86
|
63 </dl>
|
|
cannam@86
|
64
|
|
cannam@86
|
65
|
|
cannam@86
|
66 <h3>Return Values</h3>
|
|
cannam@86
|
67 <blockquote>
|
|
cannam@86
|
68 <li>Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In
|
|
cannam@86
|
69 this case <i>og</i> is not modified.</li>
|
|
cannam@86
|
70 <li>Non-zero means that a page has been completed and returned.</li>
|
|
cannam@86
|
71 </blockquote>
|
|
cannam@86
|
72 <p>
|
|
cannam@86
|
73
|
|
cannam@86
|
74 <br><br>
|
|
cannam@86
|
75 <hr noshade>
|
|
cannam@86
|
76 <table border=0 width=100%>
|
|
cannam@86
|
77 <tr valign=top>
|
|
cannam@86
|
78 <td><p class=tiny>copyright © 2000-2010 xiph.org</p></td>
|
|
cannam@86
|
79 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
|
cannam@86
|
80 </tr><tr>
|
|
cannam@86
|
81 <td><p class=tiny>libogg documentation</p></td>
|
|
cannam@86
|
82 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
83 </tr>
|
|
cannam@86
|
84 </table>
|
|
cannam@86
|
85
|
|
cannam@86
|
86
|
|
cannam@86
|
87 </body>
|
|
cannam@86
|
88
|
|
cannam@86
|
89 </html>
|
