|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libogg - function - ogg_stream_packetout</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_packetout</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 assembles a data packet for output to the codec
|
|
cannam@86
|
21 decoding engine. The data has already been submitted to the
|
|
cannam@86
|
22 <a href="ogg_stream_state.html">ogg_stream_state</a> and broken
|
|
cannam@86
|
23 into segments. Each successive call returns the next complete packet
|
|
cannam@86
|
24 built from those segments.</p>
|
|
cannam@86
|
25
|
|
cannam@86
|
26 <p>In a typical decoding situation, this should be used after calling
|
|
cannam@86
|
27 <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a> to submit a
|
|
cannam@86
|
28 page of data to the bitstream. If the function returns 0, more data is
|
|
cannam@86
|
29 needed and another page should be submitted. A non-zero return value
|
|
cannam@86
|
30 indicates successful return of a packet.</p>
|
|
cannam@86
|
31
|
|
cannam@86
|
32 <p>The <i>op</i> is filled in with pointers to memory managed by
|
|
cannam@86
|
33 the stream state and is only valid until the next call. The client
|
|
cannam@86
|
34 must copy the packet data if a longer lifetime is required.</p>
|
|
cannam@86
|
35
|
|
cannam@86
|
36 <br><br>
|
|
cannam@86
|
37 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
38 <tr bgcolor=#cccccc>
|
|
cannam@86
|
39 <td>
|
|
cannam@86
|
40 <pre><b>
|
|
cannam@86
|
41 int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
|
|
cannam@86
|
42 </b></pre>
|
|
cannam@86
|
43 </td>
|
|
cannam@86
|
44 </tr>
|
|
cannam@86
|
45 </table>
|
|
cannam@86
|
46
|
|
cannam@86
|
47 <h3>Parameters</h3>
|
|
cannam@86
|
48 <dl>
|
|
cannam@86
|
49 <dt><i>os</i></dt>
|
|
cannam@86
|
50 <dd>Pointer to a previously declared <a
|
|
cannam@86
|
51 href="ogg_stream_state.html">ogg_stream_state</a> struct. Before this function is called, an <a href="ogg_page.html">ogg_page</a> should be submitted to the stream using <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a>.</dd>
|
|
cannam@86
|
52 <dt><i>op</i></dt>
|
|
cannam@86
|
53 <dd>Pointer to the packet to be filled in with pointers to the new data.
|
|
cannam@86
|
54 This will typically be submitted to a codec for decode after this
|
|
cannam@86
|
55 function is called. The pointers are only valid until the next call
|
|
cannam@86
|
56 on this stream state.</dd>
|
|
cannam@86
|
57 </dl>
|
|
cannam@86
|
58
|
|
cannam@86
|
59
|
|
cannam@86
|
60 <h3>Return Values</h3>
|
|
cannam@86
|
61 <blockquote>
|
|
cannam@86
|
62 <ul>
|
|
cannam@86
|
63 <li>-1 if we are out of sync and there is a gap in the data. This is usually a recoverable error and subsequent calls to ogg_stream_packetout are likely to succeed. <i>op</i> has not been updated.</li>
|
|
cannam@86
|
64 <li>0 if there is insufficient data available to complete a packet, or on unrecoverable internal error occurred. <i>op</i> has not been updated.
|
|
cannam@86
|
65 <li>1 if a packet was assembled normally. <i>op</i> contains the next packet from the stream.</li>
|
|
cannam@86
|
66 </ul>
|
|
cannam@86
|
67 </blockquote>
|
|
cannam@86
|
68
|
|
cannam@86
|
69 <br><br>
|
|
cannam@86
|
70
|
|
cannam@86
|
71 <hr noshade>
|
|
cannam@86
|
72
|
|
cannam@86
|
73 <table border=0 width=100%>
|
|
cannam@86
|
74 <tr valign=top>
|
|
cannam@86
|
75 <td><p class=tiny>copyright © 2000-2010 xiph.org</p></td>
|
|
cannam@86
|
76 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
|
cannam@86
|
77 </tr><tr>
|
|
cannam@86
|
78 <td><p class=tiny>libogg documentation</p></td>
|
|
cannam@86
|
79 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
80 </tr>
|
|
cannam@86
|
81 </table>
|
|
cannam@86
|
82
|
|
cannam@86
|
83 </body>
|
|
cannam@86
|
84
|
|
cannam@86
|
85 </html>
|
