Numerous corrections and updates to libVorbisfile docs
[platform/upstream/libvorbis.git] / doc / vorbisfile / seeking.html
index 6b5ac18..391667c 100644 (file)
@@ -1,24 +1,32 @@
 <html>\r
 \r
 <head>\r
-<title>vorbisfile - Seeking</title>\r
+<title>Vorbisfile - Seeking</title>\r
 <link rel=stylesheet href="style.css" type="text/css">\r
 </head>\r
 \r
 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">\r
 <table border=0 width=100%>\r
 <tr>\r
-<td><p class=tiny>vorbisfile documentation</p></td>\r
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>\r
+<td><p class=tiny>Vorbisfile documentation</p></td>\r
+<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>\r
 </tr>\r
 </table>\r
 \r
 <h1>Seeking</h1>\r
 <p>Seeking functions allow you to specify a specific point in the stream to begin or continue decoding.\r
 <p>\r
-All the <b>vorbisfile</b> seeking routines are declared in "vorbis/vorbisfile.h".\r
-<p>\r
-<p>Certain seeking functions are best suited to different situations.  When speed is important, page-level seeking should be used.\r
+All libvorbisfile seeking routines are declared in "vorbis/vorbisfile.h".\r
+\r
+<p>Certain seeking functions are best suited to different situations.\r
+When speed is important and exact positioning isn't required,\r
+page-level seeking should be used.  Note also that Vorbis files do not\r
+necessarily start at a sample number or time offset of zero.  Do not\r
+be surprised if a file begins at a positive offset of several minutes\r
+or hours, such as would happen if a large stream (such as a concert\r
+recording) is chopped into multiple separate files.  Requesting to\r
+seek to a position before the beginning of such a file will seek to\r
+the position where audio begins.<p>\r
 \r
 </ul>\r
 \r
@@ -29,23 +37,23 @@ All the <b>vorbisfile</b> seeking routines are declared in "vorbis/vorbisfile.h"
 </tr>\r
 <tr valign=top>\r
        <td><a href="ov_raw_seek.html">ov_raw_seek</a></td>\r
-       <td>This function seeks to a specific byte in the bitstream, specified in bytes.</td>\r
+       <td>This function seeks to a position specified in the compressed bitstream, specified in bytes.</td>\r
 </tr>\r
 <tr valign=top>\r
        <td><a href="ov_pcm_seek.html">ov_pcm_seek</a></td>\r
-       <td>This function seeks to a specific point in the bitstream, specified in pcm samples.</td>\r
+       <td>This function seeks to a specific audio sample number, specified in pcm samples.</td>\r
 </tr>\r
 <tr valign=top>\r
-       <td><a href="ov_pcm_seek.html">ov_pcm_seek_page</a></td>\r
-       <td>This function seeks to the closest page preceding a point in the bitstream, specified in pcm samples.</td>\r
+       <td><a href="ov_pcm_seek_page.html">ov_pcm_seek_page</a></td>\r
+       <td>This function seeks to the closest page preceding the specified audio sample number, specified in pcm samples.</td>\r
 </tr>\r
 <tr valign=top>\r
        <td><a href="ov_time_seek.html">ov_time_seek</a></td>\r
-       <td>This function seeks to a time in the bitstream, specified in seconds.  The easiest and simplest seeking method.</td>\r
+       <td>This function seeks to the specific time location in the bitstream, specified in integer milliseconds.  Note that this differs from the reference vorbisfile implementation, which takes seconds as a float. </td>\r
 </tr>\r
 <tr valign=top>\r
        <td><a href="ov_time_seek_page.html">ov_time_seek_page</a></td>\r
-       <td>This function seeks to the closest page preceding a time in the bitstream, specified in seconds.</td>\r
+       <td>This function seeks to the closest page preceding the specified time position in the bitstream, specified in integer milliseconds.</td>\r
 </tr>\r
 </table>\r
 \r
@@ -53,15 +61,14 @@ All the <b>vorbisfile</b> seeking routines are declared in "vorbis/vorbisfile.h"
 <hr noshade>\r
 <table border=0 width=100%>\r
 <tr valign=top>\r
-<td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>\r
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>\r
+<td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>\r
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>\r
 </tr><tr>\r
-<td><p class=tiny>vorbisfile documentation</p></td>\r
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>\r
+<td><p class=tiny>Vorbisfile documentation</p></td>\r
+<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>\r
 </tr>\r
 </table>\r
 \r
-\r
 </body>\r
 \r
 </html>\r