annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_crosslap.html @ 1:05aa0afa9217

Bring in flac, ogg, vorbis
author Chris Cannam
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
Chris@1 1 <html>
Chris@1 2
Chris@1 3 <head>
Chris@1 4 <title>Vorbisfile - function - ov_crosslap</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_crosslap()</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
Chris@1 19
Chris@1 20 <p>ov_crosslap overlaps and blends the boundary at a transition
Chris@1 21 between two separate streams represented by separate <a
Chris@1 22 href="OggVorbis_File.html">OggVorbis_File</a> structures. For lapping
Chris@1 23 transitions due to seeking within a single stream represented by a
Chris@1 24 single <a href="OggVorbis_File.html">OggVorbis_File</a> structure,
Chris@1 25 consider using the lapping versions of the <a
Chris@1 26 href="seeking.html">vorbisfile seeking functions</a> instead.
Chris@1 27
Chris@1 28 <p>ov_crosslap is used between the last (usually ov_read) call on
Chris@1 29 the old stream and the first ov_read from the new stream. Any
Chris@1 30 desired positioning of the new stream must occur before the call to
Chris@1 31 ov_crosslap() as a seek dumps all prior lapping information from a
Chris@1 32 stream's decode state. Crosslapping does not introduce or remove any
Chris@1 33 extraneous samples; positioning works exactly as if ov_crosslap was not
Chris@1 34 called.
Chris@1 35
Chris@1 36 <p>ov_crosslap will lap between streams of differing numbers of
Chris@1 37 channels. Any extra channels from the old stream are ignored; playback
Chris@1 38 of these channels simply ends. Extra channels in the new stream are
Chris@1 39 lapped from silence. ov_crosslap will also lap between streams links
Chris@1 40 of differing sample rates. In this case, the sample rates are ignored
Chris@1 41 (no implicit resampling is done to match playback). It is up to the
Chris@1 42 application developer to decide if this behavior makes any sense in a
Chris@1 43 given context; in practical use, these default behaviors perform
Chris@1 44 sensibly.
Chris@1 45
Chris@1 46 <br><br>
Chris@1 47 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 48 <tr bgcolor=#cccccc>
Chris@1 49 <td>
Chris@1 50 <pre><b>
Chris@1 51 long ov_crosslap(<a href="OggVorbis_File.html">OggVorbis_File</a> *old, <a href="OggVorbis_File.html">OggVorbis_File</a> *new);
Chris@1 52
Chris@1 53 </b></pre>
Chris@1 54 </td>
Chris@1 55 </tr>
Chris@1 56 </table>
Chris@1 57
Chris@1 58 <h3>Parameters</h3>
Chris@1 59 <dl>
Chris@1 60 <dt><i>old</i></dt>
Chris@1 61 <dd>A pointer to the OggVorbis_File structure representing the origin stream from which to transition playback.</dd>
Chris@1 62
Chris@1 63 <dt><i>new</i></dt>
Chris@1 64 <dd>A pointer to the OggVorbis_File structure representing the stream with which playback continues.</dd>
Chris@1 65 </dl>
Chris@1 66
Chris@1 67
Chris@1 68 <h3>Return Values</h3>
Chris@1 69 <blockquote>
Chris@1 70 <dl>
Chris@1 71 <dt>OV_EINVAL</dt>
Chris@1 72 <dd>crosslap called with an OggVorbis_File structure that isn't open.</dd>
Chris@1 73 <dt>OV_EFAULT</dt>
Chris@1 74 <dd>internal error; implies a library bug or external heap corruption.</dd>
Chris@1 75 <dt>OV_EREAD</dt>
Chris@1 76 <dd> A read from media returned an error.</dd>
Chris@1 77 <dt>OV_EOF</dt>
Chris@1 78 <dd>indicates stream <tt>vf2</tt> is at end of file, or that <tt>vf1</tt> is at end of file immediately after a seek (making crosslap impossible as there's no preceding decode state to crosslap).</dd>
Chris@1 79 <dt><i>0</i></dt>
Chris@1 80 <dd>success.</dd>
Chris@1 81 </dl>
Chris@1 82 </blockquote>
Chris@1 83
Chris@1 84
Chris@1 85
Chris@1 86 <br><br>
Chris@1 87 <hr noshade>
Chris@1 88 <table border=0 width=100%>
Chris@1 89 <tr valign=top>
Chris@1 90 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
Chris@1 91 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
Chris@1 92 </tr><tr>
Chris@1 93 <td><p class=tiny>Vorbisfile documentation</p></td>
Chris@1 94 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
Chris@1 95 </tr>
Chris@1 96 </table>
Chris@1 97
Chris@1 98 </body>
Chris@1 99
Chris@1 100 </html>