From 74f4b1bc3b627ba4c7e03498234d88cacdfbe97b Mon Sep 17 00:00:00 2001 From: Aki Date: Wed, 29 Sep 2021 22:52:49 +0200 Subject: Squashed 'vorbis/' content from commit d22c3ab5f git-subtree-dir: vorbis git-subtree-split: d22c3ab5f633460abc2532feee60ca0892134cbf --- doc/vorbisfile/ov_pcm_seek_page_lap.html | 112 +++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100644 doc/vorbisfile/ov_pcm_seek_page_lap.html (limited to 'doc/vorbisfile/ov_pcm_seek_page_lap.html') diff --git a/doc/vorbisfile/ov_pcm_seek_page_lap.html b/doc/vorbisfile/ov_pcm_seek_page_lap.html new file mode 100644 index 0000000..d9694e8 --- /dev/null +++ b/doc/vorbisfile/ov_pcm_seek_page_lap.html @@ -0,0 +1,112 @@ + + + +Vorbisfile - function - ov_pcm_seek_page_lap + + + + + + + + + +

Vorbisfile documentation

vorbisfile version 1.3.2 - 20101101

+ +

ov_pcm_seek_page_lap

+ +

declared in "vorbis/vorbisfile.h";

+ +

Seeks to the closest page preceding the specified location (in pcm +samples) within the physical bitstream. This variant of ov_pcm_seek_page also automatically +crosslaps the transition from the previous playback position into the +new playback position in order to eliminate clicking and boundary +discontinuities. Otherwise, usage and behavior is identical to ov_pcm_seek_page. + +

This function is faster than ov_pcm_seek_lap because the function +can begin decoding at a page boundary rather than seeking through any +remaining samples before the specified location. However, it is less +accurate. + +

ov_pcm_seek_page_lap also updates everything needed within the +decoder, so you can immediately call ov_read() and get data from the newly seeked +to position. + +

ov_pcm_seek_page_lap will lap between logical stream links of +differing numbers of channels. Any extra channels from the origin of +the seek are ignored; playback of these channels simply ends. Extra +channels at the destination are lapped from silence. +ov_pcm_seek_page_lap will also lap between logical stream links of +differing sample rates. In this case, the sample rates are ignored +(no implicit resampling is done to match playback). It is up to the +application developer to decide if this behavior makes any sense in a +given context; in practical use, these default behaviors perform +sensibly. + +

This function only works for seekable streams. + +

+ + + + +
+
+int ov_pcm_seek_page_lap(OggVorbis_File *vf,ogg_int64_t pos); +
+
+ +

Parameters

vf: A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile +functions.
pos: Position in pcm samples to seek to in the bitstream.

+ + +

Return Values

+
+
0 for success
+ +
+nonzero indicates failure, described by several error codes: +
+
OV_ENOSEEK - Bitstream is not seekable. +
+
OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open. +
+
OV_EREAD - A read from media returned an error. +
+
OV_EFAULT - Internal logic fault; indicates a bug or heap/stack + corruption. +
+
OV_EOF - Indicates stream is at end of file immediately after a seek + (making crosslap impossible as there's no preceeding decode state to crosslap). +
+
OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt. +
+
+

+ +

+

+ + + + + + + + +

copyright © 2000-2010 Xiph.Org	Ogg Vorbis
Vorbisfile documentation	vorbisfile version 1.3.2 - 20101101

+ + + + -- cgit v1.1