diff options
-rw-r--r-- | doc/ogg/ogg_stream_flush.html | 2 | ||||
-rw-r--r-- | doc/ogg/ogg_stream_pageout.html | 5 | ||||
-rw-r--r-- | src/framing.c | 12 |
3 files changed, 9 insertions, 10 deletions
diff --git a/doc/ogg/ogg_stream_flush.html b/doc/ogg/ogg_stream_flush.html index ab62190..05d75fb 100644 --- a/doc/ogg/ogg_stream_flush.html +++ b/doc/ogg/ogg_stream_flush.html @@ -26,7 +26,7 @@ <tr bgcolor=#cccccc> <td> <pre><b> -int ogg_stream_pageout(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og); +int ogg_stream_flush(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og); </b></pre> </td> </tr> diff --git a/doc/ogg/ogg_stream_pageout.html b/doc/ogg/ogg_stream_pageout.html index f552ad3..c703382 100644 --- a/doc/ogg/ogg_stream_pageout.html +++ b/doc/ogg/ogg_stream_pageout.html @@ -43,9 +43,8 @@ int ogg_stream_pageout(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <h3>Return Values</h3> <blockquote> -<li>0 means that there is not enough data yet to form a page.</li> -<li> -0 means that the page was successfully submitted to the bitstream.</li> +<li>Zero means that insufficient data has accumulated to fill a page.</li> +<li>Non-zero means that a page has been completed and flushed.</li> </blockquote> <p> diff --git a/src/framing.c b/src/framing.c index f08d295..655d99e 100644 --- a/src/framing.c +++ b/src/framing.c @@ -12,7 +12,7 @@ function: code raw [Vorbis] packets into framed OggSquish stream and decode Ogg streams back into raw packets - last mod: $Id: framing.c,v 1.22 2002/07/11 09:09:08 xiphmont Exp $ + last mod: $Id: framing.c,v 1.23 2002/09/29 07:10:37 giles Exp $ note: The CRC code is directly derived from public domain code by Ross Williams (ross@guest.adelaide.edu.au). See docs/framing.html @@ -321,14 +321,14 @@ int ogg_stream_packetin(ogg_stream_state *os,ogg_packet *op){ (undersized page). If there are no packets or partial packets to flush, ogg_stream_flush returns 0. Note that ogg_stream_flush will try to flush a normal sized page like ogg_stream_pageout; a call to - ogg_stream_flush does not gurantee that all packets have flushed. + ogg_stream_flush does not guarantee that all packets have flushed. Only a return value of 0 from ogg_stream_flush indicates all packet data is flushed into pages. - ogg_stream_page will flush the last page in a stream even if it's - undersized; you almost certainly want to use ogg_stream_pageout - (and *not* ogg_stream_flush) unless you need to flush an undersized - page in the middle of a stream for some reason. */ + since ogg_stream_flush will flush the last page in a stream even if + it's undersized, you almost certainly want to use ogg_stream_pageout + (and *not* ogg_stream_flush) unless you specifically need to flush + an page regardless of size in the middle of a stream. */ int ogg_stream_flush(ogg_stream_state *os,ogg_page *og){ int i; |