annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_pcm_seek_lap.html @ 56:af97cad61ff0

Add updated build of PortAudio for OSX
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 03 Jan 2017 15:10:52 +0000
parents 05aa0afa9217
children
rev   line source
Chris@1 1 <html>
Chris@1 2
Chris@1 3 <head>
Chris@1 4 <title>Vorbisfile - function - ov_pcm_seek_lap</title>
Chris@1 5 <link rel=stylesheet href="style.css" type="text/css">
Chris@1 6 </head>
Chris@1 7
Chris@1 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
Chris@1 9 <table border=0 width=100%>
Chris@1 10 <tr>
Chris@1 11 <td><p class=tiny>Vorbisfile documentation</p></td>
Chris@1 12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
Chris@1 13 </tr>
Chris@1 14 </table>
Chris@1 15
Chris@1 16 <h1>ov_pcm_seek_lap</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
Chris@1 19
Chris@1 20 <p>Seeks to the offset specified (in pcm samples) within the physical bitstream. This variant of <a
Chris@1 21 href="ov_pcm_seek.html">ov_pcm_seek</a> also automatically
Chris@1 22 crosslaps the transition from the previous playback position into the
Chris@1 23 new playback position in order to eliminate clicking and boundary
Chris@1 24 discontinuities. Otherwise, usage and behavior is identical to <a
Chris@1 25 href="ov_pcm_seek.html">ov_pcm_seek</a>.
Chris@1 26
Chris@1 27 <p>ov_pcm_seek_lap also updates everything needed within the decoder,
Chris@1 28 so you can immediately call <a href="ov_read.html">ov_read()</a> and
Chris@1 29 get data from the newly seeked to position.
Chris@1 30
Chris@1 31 <p>ov_pcm_seek_lap will lap between logical stream links of differing
Chris@1 32 numbers of channels. Any extra channels from the origin of the seek
Chris@1 33 are ignored; playback of these channels simply ends. Extra channels at
Chris@1 34 the destination are lapped from silence. ov_pcm_seek_lap will also
Chris@1 35 lap between logical stream links of differing sample rates. In this
Chris@1 36 case, the sample rates are ignored (no implicit resampling is done to
Chris@1 37 match playback). It is up to the application developer to decide if
Chris@1 38 this behavior makes any sense in a given context; in practical use,
Chris@1 39 these default behaviors perform sensibly.
Chris@1 40
Chris@1 41 <p>This function only works for seekable streams.
Chris@1 42
Chris@1 43 <br><br>
Chris@1 44 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 45 <tr bgcolor=#cccccc>
Chris@1 46 <td>
Chris@1 47 <pre><b>
Chris@1 48 int ov_pcm_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
Chris@1 49 </b></pre>
Chris@1 50 </td>
Chris@1 51 </tr>
Chris@1 52 </table>
Chris@1 53
Chris@1 54 <h3>Parameters</h3>
Chris@1 55 <dl>
Chris@1 56 <dt><i>vf</i></dt>
Chris@1 57 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
Chris@1 58 functions.</dd>
Chris@1 59 <dt><i>pos</i></dt>
Chris@1 60 <dd>Position in pcm samples to seek to in the bitstream.</dd>
Chris@1 61 </dl>
Chris@1 62
Chris@1 63
Chris@1 64 <h3>Return Values</h3>
Chris@1 65 <blockquote>
Chris@1 66 <ul>
Chris@1 67 <li>0 for success</li>
Chris@1 68
Chris@1 69 <li>
Chris@1 70 nonzero indicates failure, described by several error codes:
Chris@1 71 <ul>
Chris@1 72 <li>OV_ENOSEEK - Bitstream is not seekable.
Chris@1 73 </li>
Chris@1 74 <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
Chris@1 75 </li>
Chris@1 76 <li>OV_EREAD - A read from media returned an error.
Chris@1 77 </li>
Chris@1 78 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
Chris@1 79 corruption.
Chris@1 80 </li>
Chris@1 81 <li>OV_EOF - Indicates stream is at end of file immediately after a seek
Chris@1 82 (making crosslap impossible as there's no preceeding decode state to crosslap).
Chris@1 83 </li>
Chris@1 84 <li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt.
Chris@1 85 </li>
Chris@1 86 </ul></li>
Chris@1 87 </ul></blockquote>
Chris@1 88
Chris@1 89 <br><br>
Chris@1 90 <hr noshade>
Chris@1 91 <table border=0 width=100%>
Chris@1 92 <tr valign=top>
Chris@1 93 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
Chris@1 94 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
Chris@1 95 </tr><tr>
Chris@1 96 <td><p class=tiny>Vorbisfile documentation</p></td>
Chris@1 97 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
Chris@1 98 </tr>
Chris@1 99 </table>
Chris@1 100
Chris@1 101 </body>
Chris@1 102
Chris@1 103 </html>