<p>This function is used to check the error or readiness condition of an <ahref="ogg_stream_state.html">ogg_stream_state</a> structure.
<p>This function is used to check the error or readiness condition of an <ahref="ogg_stream_state.html">ogg_stream_state</a> structure.
<p>It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an
internal error occur, the <ahref="ogg_stream_state.html">ogg_stream_state</a> structure will be cleared (equivalent to a
@@ -23,7 +23,7 @@ allows applications to explicitly request a specific page spill
size.</p>
<p>This function checks for remaining packets inside the stream and forces remaining packets into pages of approximately the requested size.
This should be used when you want to flush all remaining data from a stream. <ahref="ogg_stream_flush.html">ogg_stream_flush</a> may be used instead if a particular page size isn't important.
This should be used when you want to flush all remaining data from a stream. <ahref="ogg_stream_flush.html">ogg_stream_flush</a> may be used instead if a particular page size isn't important.
<p>This function can be used to verify that all packets have been flushed. If the return value is 0, all packets have been placed into a page. Generally speaking, it should be called in a loop until all packets are flushed, since even a single packet may span multiple pages.
<p>This function assembles a data packet for output to the codec
<p>This function assembles a data packet for output to the codec
decoding engine. The data has already been submitted to the
<ahref="ogg_stream_state.html">ogg_stream_state</a> and broken
into segments. Each successive call returns the next complete packet
into segments. Each successive call returns the next complete packet
built from those segments.</p>
<p>In a typical decoding situation, this should be used after calling
<ahref="ogg_stream_pagein.html">ogg_stream_pagein()</a> to submit a
page of data to the bitstream. If the function returns 0, more data is
needed and another page should be submitted. A non-zero return value
<p>In a typical decoding situation, this should be used after calling
<ahref="ogg_stream_pagein.html">ogg_stream_pagein()</a> to submit a
page of data to the bitstream. If the function returns 0, more data is
needed and another page should be submitted. A non-zero return value
indicates successful return of a packet.</p>
<p>The <i>op</i> is filled in with pointers to memory managed by
...
...
@@ -50,8 +50,8 @@ int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
<dd>Pointer to a previously declared <a
href="ogg_stream_state.html">ogg_stream_state</a> struct. Before this function is called, an <ahref="ogg_page.html">ogg_page</a> should be submitted to the stream using <ahref="ogg_stream_pagein.html">ogg_stream_pagein()</a>.</dd>
<dt><i>op</i></dt>
<dd>Pointer to the packet to be filled in with pointers to the new data.
This will typically be submitted to a codec for decode after this
<dd>Pointer to the packet to be filled in with pointers to the new data.
This will typically be submitted to a codec for decode after this
function is called. The pointers are only valid until the next call
<p>This function adds a complete page to the bitstream.
<p>This function adds a complete page to the bitstream.
<p>In a typical decoding situation, this function would be called after using <ahref="ogg_sync_pageout.html">ogg_sync_pageout</a> to create a valid <ahref="ogg_page.html">ogg_page</a> struct.
<p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer.
<p>This function is used to check the error or readiness condition of an <ahref="ogg_sync_state.html">ogg_sync_state</a> structure.
<p>This function is used to check the error or readiness condition of an <ahref="ogg_sync_state.html">ogg_sync_state</a> structure.
<p>It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an
internal error occur, the <ahref="ogg_sync_state.html">ogg_sync_state</a> structure will be cleared (equivalent to a
<p>This function synchronizes the ogg_sync_state struct to the next ogg_page.
<p>This function synchronizes the ogg_sync_state struct to the next ogg_page.
<p>This is useful when seeking within a bitstream. ogg_sync_pageseek will synchronize to the next page in the bitstream and return information about how many bytes we advanced or skipped in order to do so.
The ogg_sync_state struct tracks the synchronization of the current page.
<p>It is used during decoding to track the status of data as it is read in, synchronized, verified, and parsed into pages belonging to the various logical bistreams in the current physical bitstream link.
<p>It is used during decoding to track the status of data as it is read in, synchronized, verified, and parsed into pages belonging to the various logical bistreams in the current physical bitstream link.
