[xiph-cvs] cvs commit: ogg/src framing.c

[Ralph Giles]

giles       02/09/29 03:10:38

  Modified:    doc/ogg  ogg_stream_flush.html ogg_stream_pageout.html
               src      framing.c
  Log:
  fix documentation errors. thanks to David K. Gasaway for pointing out the problem.

Revision  Changes    Path
1.4       +1 -1      ogg/doc/ogg/ogg_stream_flush.html

Index: ogg_stream_flush.html
===================================================================
RCS file: /usr/local/cvsroot/ogg/doc/ogg/ogg_stream_flush.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ogg_stream_flush.html	19 Jul 2002 12:06:14 -0000	1.3
+++ ogg_stream_flush.html	29 Sep 2002 07:10:37 -0000	1.4
@@ -26,7 +26,7 @@
 <tr bgcolor=#cccccc>
         <td>
 <pre><b>
-int ogg_stream_pageout(ogg_stream_state *os, ogg_page *og);
+int ogg_stream_flush(ogg_stream_state *os, ogg_page *og);
 </b></pre>
         </td>
 </tr>

<p><p>1.4       +2 -3      ogg/doc/ogg/ogg_stream_pageout.html

Index: ogg_stream_pageout.html
===================================================================
RCS file: /usr/local/cvsroot/ogg/doc/ogg/ogg_stream_pageout.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ogg_stream_pageout.html	19 Jul 2002 12:06:14 -0000	1.3
+++ ogg_stream_pageout.html	29 Sep 2002 07:10:37 -0000	1.4
@@ -43,9 +43,8 @@
 
 <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>
 

<p><p>1.23      +6 -6      ogg/src/framing.c

Index: framing.c
===================================================================
RCS file: /usr/local/cvsroot/ogg/src/framing.c,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- framing.c	11 Jul 2002 09:09:08 -0000	1.22
+++ framing.c	29 Sep 2002 07:10:37 -0000	1.23
@@ -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 at guest.adelaide.edu.au).  See docs/framing.html
@@ -321,14 +321,14 @@
    (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;

<p><p>--- >8 ----
List archives:  http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body.  No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.