[xiph-cvs] cvs commit: vorbis/lib vorbisfile.c

[Ralph Giles]

giles       01/03/20 00:04:05

  Modified:    doc/vorbisfile ov_read.html
               lib      vorbisfile.c
  Log:
  put back the bit about the bitstream index. Didn't realize it was
  talking about the chaining index, rather than the logical bitstream
  serialno.

Revision  Changes    Path
1.4       +7 -1      vorbis/doc/vorbisfile/ov_read.html

Index: ov_read.html
===================================================================
RCS file: /usr/local/cvsroot/vorbis/doc/vorbisfile/ov_read.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ov_read.html	2001/03/20 07:39:07	1.3
+++ ov_read.html	2001/03/20 08:04:04	1.4
@@ -26,7 +26,13 @@
    if the toplevel application didn't particularly care.  However, when we actually read audio back, we must be aware that multiple bitstream sections do not necessarily
    have to have the same number of channels or sampling rate.
 </p><p>
-   <tt>ov_read()</tt> passes back the logical bitstream number currently
+    <tt>ov_read()</tt> passes back the index of the sequential logical
+    bitstream currently being decoded along with the PCM data in order
+    that the toplevel application can take action on channel/sample rate
+    changes. This number will be incremented at chaining boundaries even
+    for non-seekable streams. For seekable streams, it represents the
+    actual chaining index within the physical bitstream.
+<tt>ov_read()</tt> passes back the logical bitstream number currently
    being decoded along with the PCM data in order that the toplevel
    application can take action on channel/sample rate changes.
 </p>

1.43      +5 -1      vorbis/lib/vorbisfile.c

Index: vorbisfile.c
===================================================================
RCS file: /usr/local/cvsroot/vorbis/lib/vorbisfile.c,v
retrieving revision 1.42
retrieving revision 1.43
diff -u -r1.42 -r1.43
--- vorbisfile.c	2001/03/20 07:39:07	1.42
+++ vorbisfile.c	2001/03/20 08:04:05	1.43
@@ -11,7 +11,7 @@
  ********************************************************************
 
  function: stdio-based convenience library for opening/seeking/decoding
- last mod: $Id: vorbisfile.c,v 1.42 2001/03/20 07:39:07 giles Exp $
+ last mod: $Id: vorbisfile.c,v 1.43 2001/03/20 08:04:05 giles Exp $
 
  ********************************************************************/
 
@@ -1104,7 +1104,11 @@
 
    ov_read returns the sequential logical bitstream number currently
    being decoded along with the PCM data in order that the toplevel
-   application can take action on channel/sample rate changes.
+   application can take action on channel/sample rate changes.  This
+   number will be incremented even for streamed (non-seekable) streams
+   (for seekable streams, it represents the actual logical bitstream
+   index within the physical bitstream.  Note that the accessor
+   functions above are aware of this dichotomy).
 
    input values: buffer) a buffer to hold packed PCM data for return
                  length) the byte length requested to be placed into buffer

--- >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.