[xiph-commits] r15029 - in trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis: . debian doc doc/vorbisenc doc/vorbisfile doc/xml examples include/vorbis lib lib/books/coupled lib/books/floor lib/books/uncoupled lib/modes macosx/English.lproj vq win32 win32/VS2008 win32/VS2008/libvorbis win32/VS2008/libvorbisfile win32/VS2008/vorbisdec win32/VS2008/vorbisenc
cristianadam at svn.xiph.org
cristianadam at svn.xiph.org
Fri Jun 13 16:59:42 PDT 2008
Author: cristianadam
Date: 2008-06-13 16:59:37 -0700 (Fri, 13 Jun 2008)
New Revision: 15029
Added:
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbis/
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbis/libvorbis.vcproj
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbisfile/
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbisfile/libvorbisfile.def
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbisfile/libvorbisfile.vcproj
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbis.sln
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisdec/
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisdec/vorbisdec.vcproj
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisenc/
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisenc/vorbisenc.vcproj
Modified:
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/Makefile.am
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/README
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/autogen.sh
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/debian/changelog
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/debian/rules
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Makefile.am
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Vorbis_I_spec.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Vorbis_I_spec.pdf
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/floor1_inverse_dB_table.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/framing.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/helper.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/index.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/oggstream.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/programming.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/stereo.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/stream.png
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/v-comment.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbis-fidelity.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbis.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisenc/Makefile.am
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/Makefile.am
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/OggVorbis_File.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/callbacks.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/chaining_example_c.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/chainingexample.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/crosslap.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/datastructures.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/decoding.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/example.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/exampleindex.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/fileinfo.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/index.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/initialization.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_bitrate.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_bitrate_instant.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_callbacks.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_clear.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_comment.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_crosslap.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_info.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_open.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_open_callbacks.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_lap.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_page.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_tell.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_total.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_seek.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_seek_lap.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_tell.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_total.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_read.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_read_float.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_seekable.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_serialnumber.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_streams.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test_callbacks.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test_open.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_lap.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_page.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_page_lap.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_tell.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_total.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/overview.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/reference.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/return.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seekexample.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking_example_c.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking_test_c.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seekingexample.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/threads.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbis_comment.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbis_info.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbisfile_example_c.html
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/04-codec.xml
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/05-comment.xml
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/06-floor0.xml
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/07-floor1.xml
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/08-residue.xml
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/a1-encapsulation_ogg.xml
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/footer.xml
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/Makefile.am
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/chaining_example.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/decoder_example.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/encoder_example.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/seeking_example.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/vorbisfile_example.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/Makefile.am
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/codec.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/vorbisenc.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/vorbisfile.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/Makefile.am
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/analysis.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/backends.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/barkmel.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/bitrate.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/bitrate.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/block.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/coupled/res_books_stereo.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/floor/floor_books.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/uncoupled/res_books_uncoupled.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codebook.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codebook.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codec_internal.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/envelope.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/envelope.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/floor0.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/floor1.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/highlevel.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/info.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup_data.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookups.pl
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lpc.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lpc.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lsp.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lsp.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mapping0.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/masking.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mdct.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mdct.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/misc.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/floor_all.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_11.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_16.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_44.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_8.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_16.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_44.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_44u.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_8.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_11.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_16.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_22.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_32.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_44.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_44u.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_8.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_X.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/os.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psy.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psy.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psytune.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/registry.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/registry.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/res0.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/scales.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/sharedbook.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/smallft.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/smallft.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/synthesis.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/vorbisenc.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/vorbisfile.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/window.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/window.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/libvorbis.spec.in
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/macosx/English.lproj/InfoPlist.strings
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vorbis.m4
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/Makefile.am
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/bookutil.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/bookutil.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/distribution.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/huffbuild.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticebuild.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticehint.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticepare.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticetune.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqgen.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqgen.h
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqsplit.c
trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/vorbis.def
Log:
Updated to version: libvorbis 1.2.1 (unreleased) -- "Xiph.Org libVorbis I 20080501"
I would like to make it external, but I don't know how at the moment.
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/Makefile.am
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/Makefile.am 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/Makefile.am 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,8 +1,8 @@
## Process this file with automake to produce Makefile.in
-AUTOMAKE_OPTIONS = foreign dist-zip
+AUTOMAKE_OPTIONS = 1.6 foreign dist-zip dist-bzip2
-SUBDIRS = lib include doc examples win32 debian vq
+SUBDIRS = m4 include vq lib examples test doc
m4datadir = $(datadir)/aclocal
m4data_DATA = vorbis.m4
@@ -10,20 +10,29 @@
pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = vorbis.pc vorbisenc.pc vorbisfile.pc
-EXTRA_DIST = todo.txt macos macosx autogen.sh \
+EXTRA_DIST = \
+ CHANGES COPYING \
+ todo.txt autogen.sh \
libvorbis.spec libvorbis.spec.in \
- vorbis.m4 vorbis.pc.in vorbisenc.pc.in vorbisfile.pc.in \
- vorbis-uninstalled.pc.in \
- vorbisenc-uninstalled.pc.in \
- vorbisfile-uninstalled.pc.in
+ vorbis.m4 \
+ vorbis.pc.in vorbisenc.pc.in vorbisfile.pc.in \
+ vorbis-uninstalled.pc.in \
+ vorbisenc-uninstalled.pc.in \
+ vorbisfile-uninstalled.pc.in \
+ symbian \
+ macos macosx win32
+
DISTCHECK_CONFIGURE_FLAGS = --enable-docs
dist-hook:
- rm -rf `find $(distdir)/macos -name CVS`
- rm -rf `find $(distdir)/macos -name .svn`
- rm -rf `find $(distdir)/macosx -name CVS`
- rm -rf `find $(distdir)/macosx -name .svn`
+ for item in $(EXTRA_DIST); do \
+ if test -d $$item; then \
+ echo -n "cleaning $$item dir for distribution..."; \
+ rm -rf `find $(distdir)/$$item -name .svn`; \
+ echo "OK"; \
+ fi; \
+ done
debug:
$(MAKE) all CFLAGS="@DEBUG@"
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/README
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/README 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/README 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,7 +5,7 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
-* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2004 *
+* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
* by the Xiph.org Foundation, http://www.xiph.org/ *
* *
********************************************************************
@@ -70,10 +70,12 @@
CONTACT:
The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
-Vorbis's homepage is located at 'http://www.xiph.org/ogg/vorbis/'.
+Vorbis's homepage is located at 'http://www.xiph.org/vorbis/'.
Up to date technical documents, contact information, source code and
pre-built utilities may be found there.
+The user website for Ogg Vorbis software and audio is http://vorbis.com/
+
BUILDING FROM TRUNK:
Development source is under subversion revision control at
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/autogen.sh
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/autogen.sh 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/autogen.sh 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,75 +1,129 @@
-#!/bin/sh
-# Run this to set up the build system: configure, makefiles, etc.
-# (based on the version in enlightenment's cvs)
-
-package="vorbis"
-
-olddir=`pwd`
-srcdir=`dirname $0`
-test -z "$srcdir" && srcdir=.
-
-cd "$srcdir"
-DIE=0
-
-echo "checking for autoconf... "
-(autoconf --version) < /dev/null > /dev/null 2>&1 || {
- echo
- echo "You must have autoconf installed to compile $package."
- echo "Download the appropriate package for your distribution,"
- echo "or get the source tarball at ftp://ftp.gnu.org/pub/gnu/"
- DIE=1
-}
-
-echo "checking for automake... "
-(automake --version) < /dev/null > /dev/null 2>&1 || {
- echo
- echo "You must have automake installed to compile $package."
- echo "Download the appropriate package for your system,"
- echo "or get the source from one of the GNU ftp sites"
- echo "listed in http://www.gnu.org/order/ftp.html"
- DIE=1
-}
-
-echo -n "checking for libtool... "
-for LIBTOOLIZE in libtoolize glibtoolize nope; do
- (type $LIBTOOLIZE) > /dev/null 2>&1 && break
-done
-if test x$LIBTOOLIZE = xnope; then
- echo "nope."
- LIBTOOLIZE=libtoolize
-else
- echo $LIBTOOLIZE
-fi
-($LIBTOOLIZE --version) < /dev/null > /dev/null 2>&1 || {
- echo
- echo "You must have libtool installed to compile $package."
- echo "Download the appropriate package for your system,"
- echo "or get the source from one of the GNU ftp sites"
- echo "listed in http://www.gnu.org/order/ftp.html"
- DIE=1
-}
-
-if test "$DIE" -eq 1; then
- exit 1
-fi
-
-if test -z "$*"; then
- echo "I am going to run ./configure with no arguments - if you wish "
- echo "to pass any to it, please specify them on the $0 command line."
-fi
-
-echo "Generating configuration files for $package, please wait...."
-
-echo " aclocal $ACLOCAL_FLAGS"
-aclocal $ACLOCAL_FLAGS || exit 1
-echo " autoheader"
-autoheader || exit 1
-echo " $LIBTOOLIZE --automake"
-$LIBTOOLIZE --automake || exit 1
-echo " automake --add-missing $AUTOMAKE_FLAGS"
-automake --add-missing $AUTOMAKE_FLAGS || exit 1
-echo " autoconf"
-autoconf || exit 1
-
-cd $olddir
-$srcdir/configure --enable-maintainer-mode "$@" && echo
+#!/bin/sh
+# Run this to set up the build system: configure, makefiles, etc.
+# (based on the version in enlightenment's cvs)
+
+package="vorbis"
+
+ACLOCAL_FLAGS="-I m4"
+
+olddir=`pwd`
+srcdir=`dirname $0`
+test -z "$srcdir" && srcdir=.
+
+cd "$srcdir"
+DIE=0
+
+echo "checking for autoconf... "
+(autoconf --version) < /dev/null > /dev/null 2>&1 || {
+ echo
+ echo "You must have autoconf installed to compile $package."
+ echo "Download the appropriate package for your distribution,"
+ echo "or get the source tarball at ftp://ftp.gnu.org/pub/gnu/"
+ DIE=1
+}
+
+VERSIONGREP="sed -e s/.*[^0-9\.]\([0-9][0-9]*\.[0-9][0-9]*\).*/\1/"
+VERSIONMKMAJ="sed -e s/\([0-9][0-9]*\)[^0-9].*/\\1/"
+VERSIONMKMIN="sed -e s/.*[0-9][0-9]*\.//"
+
+# do we need automake?
+if test -r Makefile.am; then
+ AM_OPTIONS=`fgrep AUTOMAKE_OPTIONS Makefile.am`
+ AM_NEEDED=`echo $AM_OPTIONS | $VERSIONGREP`
+ if test x"$AM_NEEDED" = "x$AM_OPTIONS"; then
+ AM_NEEDED=""
+ fi
+ if test -z $AM_NEEDED; then
+ echo -n "checking for automake... "
+ AUTOMAKE=automake
+ ACLOCAL=aclocal
+ if ($AUTOMAKE --version < /dev/null > /dev/null 2>&1); then
+ echo "yes"
+ else
+ echo "no"
+ AUTOMAKE=
+ fi
+ else
+ echo -n "checking for automake $AM_NEEDED or later... "
+ majneeded=`echo $AM_NEEDED | $VERSIONMKMAJ`
+ minneeded=`echo $AM_NEEDED | $VERSIONMKMIN`
+ for am in automake-$AM_NEEDED automake$AM_NEEDED \
+ automake-1.10 automake-1.9 automake-1.8 automake-1.7 automake; do
+ ($am --version < /dev/null > /dev/null 2>&1) || continue
+ ver=`$am --version < /dev/null | head -n 1 | $VERSIONGREP`
+ maj=`echo $ver | $VERSIONMKMAJ`
+ min=`echo $ver | $VERSIONMKMIN`
+ if test $maj -eq $majneeded -a $min -ge $minneeded; then
+ AUTOMAKE=$am
+ echo $AUTOMAKE
+ break
+ fi
+ done
+ test -z $AUTOMAKE && echo "no"
+ echo -n "checking for aclocal $AM_NEEDED or later... "
+ for ac in aclocal-$AM_NEEDED aclocal$AM_NEEDED \
+ aclocal aclocal-1.7 aclocal-1.8 aclocal-1.9 aclocal-1.10; do
+ ($ac --version < /dev/null > /dev/null 2>&1) || continue
+ ver=`$ac --version < /dev/null | head -n 1 | $VERSIONGREP`
+ maj=`echo $ver | $VERSIONMKMAJ`
+ min=`echo $ver | $VERSIONMKMIN`
+ if test $maj -eq $majneeded -a $min -ge $minneeded; then
+ ACLOCAL=$ac
+ echo $ACLOCAL
+ break
+ fi
+ done
+ test -z $ACLOCAL && echo "no"
+ fi
+ test -z $AUTOMAKE || test -z $ACLOCAL && {
+ echo
+ echo "You must have automake installed to compile $package."
+ echo "Download the appropriate package for your distribution,"
+ echo "or get the source tarball at ftp://ftp.gnu.org/pub/gnu/"
+ exit 1
+ }
+fi
+
+echo -n "checking for libtool... "
+for LIBTOOLIZE in libtoolize glibtoolize nope; do
+ ($LIBTOOLIZE --version) < /dev/null > /dev/null 2>&1 && break
+done
+if test x$LIBTOOLIZE = xnope; then
+ echo "nope."
+ LIBTOOLIZE=libtoolize
+else
+ echo $LIBTOOLIZE
+fi
+($LIBTOOLIZE --version) < /dev/null > /dev/null 2>&1 || {
+ echo
+ echo "You must have libtool installed to compile $package."
+ echo "Download the appropriate package for your system,"
+ echo "or get the source from one of the GNU ftp sites"
+ echo "listed in http://www.gnu.org/order/ftp.html"
+ DIE=1
+}
+
+if test "$DIE" -eq 1; then
+ exit 1
+fi
+
+if test -z "$*"; then
+ echo "I am going to run ./configure with no arguments - if you wish "
+ echo "to pass any to it, please specify them on the $0 command line."
+fi
+
+echo "Generating configuration files for $package, please wait...."
+
+echo " $ACLOCAL $ACLOCAL_FLAGS"
+$ACLOCAL $ACLOCAL_FLAGS || exit 1
+echo " $LIBTOOLIZE --automake"
+$LIBTOOLIZE --automake || exit 1
+echo " autoheader"
+autoheader || exit 1
+echo " $AUTOMAKE --add-missing $AUTOMAKE_FLAGS"
+$AUTOMAKE --add-missing $AUTOMAKE_FLAGS || exit 1
+echo " autoconf"
+autoconf || exit 1
+
+cd $olddir
+$srcdir/configure --enable-maintainer-mode "$@" && echo
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/debian/changelog
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/debian/changelog 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/debian/changelog 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,3 +1,105 @@
+libvorbis (1.2.0.dfsg-3.1) unstable; urgency=high
+
+ * Non-maintainer upload by the security team
+ * Fix integer overflows (and possible DoS attacks) via crafted
+ OGG files (Closes: #482518)
+ Fixes: CVE-2008-1423, CVE-2008-1420, CVE-2008-1419
+
+ -- Steffen Joeris <white at debian.org> Mon, 26 May 2008 12:48:06 +0000
+
+libvorbis (1.2.0.dfsg-3) unstable; urgency=low
+
+ * Use dpkg-gensymbols, with symbol files obtained from Mole (stripping
+ debian revision and .dfsg suffix).
+
+ * Install upstream CHANGES file as changelog.gz. (Closes: #302037)
+
+ * Bump debian/compat to 5, and Standards-Version to 3.7.3 (no changes
+ needed).
+
+ * Use quilt.make in debian/rules.
+
+ -- Adeodato Simó <dato at net.com.org.es> Thu, 27 Dec 2007 14:33:45 +0100
+
+libvorbis (1.2.0.dfsg-2) unstable; urgency=high
+
+ * Bump shlibs for libvorbis0a due to new vorbis_synthesis_idheader header.
+ (Closes: #436083)
+
+ -- Adeodato Simó <dato at net.com.org.es> Tue, 14 Aug 2007 20:55:54 +0200
+
+libvorbis (1.2.0.dfsg-1) unstable; urgency=low
+
+ [ Adeodato Simó ]
+ * Use ${binary:Version} instead of ${Source-Version}.
+
+ [ Clint Adams ]
+ * New upstream release.
+ - Remove upstream_r13198-fix_segfault_in_ov_time_seek.diff .
+ * Bump shlibs for libvorbisfile3 to >= 1.2.0 due to new ov_fopen
+ function.
+
+ -- Clint Adams <schizo at debian.org> Fri, 27 Jul 2007 02:57:44 -0400
+
+libvorbis (1.1.2.dfsg-2) unstable; urgency=low
+
+ * Bump to Standards-Version 3.7.2.
+ * Add upstream_r13198-fix_segfault_in_ov_time_seek.diff. closes: #281995.
+
+ -- Clint Adams <schizo at debian.org> Fri, 29 Jun 2007 09:46:12 -0400
+
+libvorbis (1.1.2.dfsg-1.2) unstable; urgency=high
+
+ * Fix shlibs files for libvorbisenc and libvorbisfile, which were broken
+ by my first NMU to have dependencies for libvorbis0a. Closes: #395048
+
+ -- Joey Hess <joeyh at debian.org> Tue, 24 Oct 2006 19:55:19 -0400
+
+libvorbis (1.1.2.dfsg-1.1) unstable; urgency=low
+
+ * NMU
+ * Remove draft RFC files, as they are not under a free license.
+ Closes: #390660
+ * Repackage the source package without these files.
+ * Add README.Source documenting how the upstream source is repackaged.
+ * Modify dh_makeshlibs call to avoid generating a shlibs file that has
+ an unncessarily tight versioned dependency on this new pseudo-version
+ of libvorbis.
+
+ -- Joey Hess <joeyh at debian.org> Sun, 15 Oct 2006 17:21:37 -0400
+
+libvorbis (1.1.2-1) unstable; urgency=low
+
+ * Switch maintenance to the Debian Xiph.org Maintainers (alioth/pkg-xiph).
+
+ * New upstream release packaged. (Closes: #327586)
+
+ * Move HTML documentation from /usr/share/doc/libvorbis-dev itself to an
+ html/ subdirectory of it.
+
+ * Update debian/control:
+ + drop unnecessary build-dependency on devscripts.
+ + drop version restriction on debhelper and libogg-dev build-dependencies,
+ since they're already satisfied with stable.
+
+ * Overhaul debian/rules, and switch to quilt for patch management.
+
+ * Add debian/compat file, instead of exporting DH_COMPAT.
+
+ * Update download URL in debian/copyright.
+
+ * Add debian/watch file.
+
+ * Bumped Standards-Version to 3.6.2 (no changes required).
+
+ -- Adeodato Simó <dato at net.com.org.es> Thu, 26 Jan 2006 01:35:39 +0100
+
+libvorbis (1.1.0-1) unstable; urgency=low
+
+ * New upstream.
+
+ -- Christopher L Cheney <ccheney at debian.org> Thu, 17 Mar 2005 21:30:00 -0600
+
libvorbis (1.0.1-1) unstable; urgency=low
* New upstream.
@@ -2,4 +104,5 @@
* Improved descriptions. (Closes: #166649)
+ * Updated DEB_BUILD_OPTIONS support. (Closes: #188464)
- -- Christopher L Cheney <ccheney at debian.org> Wed, 3 Sep 2003 00:15:00 -0500
+ -- Christopher L Cheney <ccheney at debian.org> Tue, 9 Dec 2003 01:00:00 -0600
@@ -103,7 +206,3 @@
* Initial package, not placed in archive.
-- Michael Beattie <mickyb at es.co.nz> Mon, 26 Jun 2000 18:59:56 +1200
-
-Local variables:
-mode: debian-changelog
-End:
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/debian/rules
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/debian/rules 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/debian/rules 2008-06-13 23:59:37 UTC (rev 15029)
@@ -116,7 +116,7 @@
binary-common:
dh_testdir
dh_testroot
- dh_installchangelogs
+ dh_installchangelogs CHANGES
dh_installdocs
dh_installexamples
# dh_installmenu
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Makefile.am
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Makefile.am 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Makefile.am 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,9 +6,11 @@
### all of the static docs, commited to SVN and included as is
static_docs = \
- draft-kerr-avt-vorbis-rtp-03.txt \
+ draft-ietf-avt-rtp-vorbis-09.xml \
+ draft-ietf-avt-rtp-vorbis-09.txt \
eightphase.png \
evenlsp.png \
+ fish_xiph_org.png \
floor1_inverse_dB_table.html \
floorval.png \
fourphase.png \
@@ -74,6 +76,7 @@
xml/08-residue.xml \
xml/09-helper.xml \
xml/10-tables.xml \
+ xml/TODO \
xml/a1-encapsulation_ogg.xml \
xml/a2-encapsulation_rtp.xml \
xml/footer.xml \
@@ -100,7 +103,7 @@
@mkdir -p $(BUILDDIR)
@for file in $(doc_sources); do cp $(srcdir)/$$file $(BUILDDIR); done
# translate the draft rtp.txt to .xml in the BUILDDIR
-$(BUILDDIR)/draft-rtp.xml: draft-kerr-avt-vorbis-rtp-03.txt
+$(BUILDDIR)/draft-rtp.xml: draft-ietf-avt-rtp-vorbis-09.txt
cat $< | sed 's/ //g' > $@
# cat $< | sed 's/ //g' | sed 's/</\</g' | sed 's/>/\>/g' > $@
@@ -112,15 +115,13 @@
Vorbis_I_spec.fo: $(BUILDDIR)/Vorbis_I_spec.xml
cd build; xsltproc --xinclude --output $@ spec-fo.xsl Vorbis_I_spec.xml && mv $@ ..
-# we add the two newlines to pdfxmltex because on a number of Fedora systems
-# tex prompts for input complaining about something;
-# and surprisingly there's no way to tell tex to ignore that
-# also, --interaction doesn't seem to actually do anything different
-# if you change it
+# we add the two newlines to pdfxmltex because this entire XML
+# toolchain is built from wishful thinking and bonghits and the
+# default supplied passivetex config files are buggy.
Vorbis_I_spec.pdf: Vorbis_I_spec.fo $(SPEC_PNG_BUILD) $(SPEC_PDF_BUILD)
cp $< build/spec.fo # work around a passivetex bug
- cd build; echo -e -n "\n\n" | pdfxmltex --interaction nonstopmode spec.fo
- cd build; echo -e -n "\n\n" | pdfxmltex --interaction nonstopmode spec.fo
+ -cd build; echo -e -n "\n\n" | pdfxmltex spec.fo
+ -cd build; echo -e -n "\n\n" | pdfxmltex spec.fo
rm build/spec.fo
mv build/spec.pdf $@
else
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Vorbis_I_spec.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Vorbis_I_spec.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Vorbis_I_spec.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,2260 +1,2306 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Vorbis I specification</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id4681411"></a>Vorbis I specification</h1></div><div><h3 class="corpauthor">Xiph.org Foundation</h3></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#vorbis-spec-intro">1. Introduction and Description</a></span></dt><dd><dl><dt><span class="section"><a href="#id4775312">1.1. Overview</a></span></dt><dt><span class="section"><a href="#id4767185">1.2. Decoder Configuration</a></span></dt><dt><span class="section"><a href="#id4768455">1.3. High-level Decode Process</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-bitpacking">2. Bitpacki
ng Convention</a></span></dt><dd><dl><dt><span class="section"><a href="#id4770613">2.1. Overview</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-codebook">3. Probability Model and Codebooks</a></span></dt><dd><dl><dt><span class="section"><a href="#id4792843">3.1. Overview</a></span></dt><dt><span class="section"><a href="#id4772022">3.2. Packed codebook format</a></span></dt><dt><span class="section"><a href="#id4782705">3.3. Use of the codebook abstraction</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-codec">4. Codec Setup and Packet Decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id4780183">4.1. Overview</a></span></dt><dt><span class="section"><a href="#id4784922">4.2. Header decode and decode setup</a></span></dt><dt><span class="section"><a href="#id4774443">4.3. Audio packet decode and synthesis</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-comment">5. comment field and h
eader specification</a></span></dt><dd><dl><dt><span class="section"><a href="#id4793333">5.1. Overview</a></span></dt><dt><span class="section"><a href="#id4793366">5.2. Comment encoding</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-floor0">6. Floor type 0 setup and decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id4796889">6.1. Overview</a></span></dt><dt><span class="section"><a href="#id4789911">6.2. Floor 0 format</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-floor1">7. Floor type 1 setup and decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id4774521">7.1. Overview</a></span></dt><dt><span class="section"><a href="#id4801336">7.2. Floor 1 format</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-residue">8. Residue setup and decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id4792884">8.1. Overview</a></span></dt><dt><span class="section"><a hre
f="#id4744282">8.2. Residue format</a></span></dt><dt><span class="section"><a href="#id4775296">8.3. residue 0</a></span></dt><dt><span class="section"><a href="#id4747824">8.4. residue 1</a></span></dt><dt><span class="section"><a href="#id4795336">8.5. residue 2</a></span></dt><dt><span class="section"><a href="#id4778477">8.6. Residue decode</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-helper">9. Helper equations</a></span></dt><dd><dl><dt><span class="section"><a href="#id4772356">9.1. Overview</a></span></dt><dt><span class="section"><a href="#id4753492">9.2. Functions</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-tables">10. Tables</a></span></dt><dd><dl><dt><span class="section"><a href="#vorbis-spec-floor1_inverse_dB_table">10.1. floor1_inverse_dB_table</a></span></dt></dl></dd><dt><span class="appendix"><a href="#vorbis-over-ogg">A. Embedding Vorbis into an Ogg stream</a></span></dt><dd><dl><dt><span class="sec
tion"><a href="#id4782344">A.1. Overview</a></span></dt><dd><dl><dt><span class="section"><a href="#id4759705">A.1.1. Restrictions</a></span></dt><dt><span class="section"><a href="#id4785081">A.1.2. MIME type</a></span></dt></dl></dd><dt><span class="section"><a href="#id4780489">A.2. Encapsulation</a></span></dt></dl></dd><dt><span class="appendix"><a href="#vorbis-over-rtp">B. Vorbis encapsulation in RTP</a></span></dt><dt><span class="appendix"><a href="#footer">C. Colophon</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-intro"></a>1. Introduction and Description</h2></div><div><p class="releaseinfo">
- $Id: 01-introduction.xml 7186 2004-07-20 07:19:25Z xiphmont $
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4775312"></a>1.1. Overview</h3></div></div></div><p>
-This document provides a high level description of the Vorbis codec's
-construction. A bit-by-bit specification appears beginning in
-<a href="#vorbis-spec-codec" title="4. Codec Setup and Packet Decode">Section 4, “Codec Setup and Packet Decode”</a>.
-The later sections assume a high-level
-understanding of the Vorbis decode process, which is
-provided here.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4785952"></a>1.1.1. Application</h4></div></div></div><p>
-Vorbis is a general purpose perceptual audio CODEC intended to allow
-maximum encoder flexibility, thus allowing it to scale competitively
-over an exceptionally wide range of bitrates. At the high
-quality/bitrate end of the scale (CD or DAT rate stereo, 16/24 bits)
-it is in the same league as MPEG-2 and MPC. Similarly, the 1.0
-encoder can encode high-quality CD and DAT rate stereo at below 48kbps
-without resampling to a lower rate. Vorbis is also intended for
-lower and higher sample rates (from 8kHz telephony to 192kHz digital
-masters) and a range of channel representations (monaural,
-polyphonic, stereo, quadraphonic, 5.1, ambisonic, or up to 255
-discrete channels).
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4772766"></a>1.1.2. Classification</h4></div></div></div><p>
-Vorbis I is a forward-adaptive monolithic transform CODEC based on the
-Modified Discrete Cosine Transform. The codec is structured to allow
-addition of a hybrid wavelet filterbank in Vorbis II to offer better
-transient response and reproduction using a transform better suited to
-localized time events.
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4781123"></a>1.1.3. Assumptions</h4></div></div></div><p>
-The Vorbis CODEC design assumes a complex, psychoacoustically-aware
-encoder and simple, low-complexity decoder. Vorbis decode is
-computationally simpler than mp3, although it does require more
-working memory as Vorbis has no static probability model; the vector
-codebooks used in the first stage of decoding from the bitstream are
-packed in their entirety into the Vorbis bitstream headers. In
-packed form, these codebooks occupy only a few kilobytes; the extent
-to which they are pre-decoded into a cache is the dominant factor in
-decoder memory usage.
-</p><p>
-Vorbis provides none of its own framing, synchronization or protection
-against errors; it is solely a method of accepting input audio,
-dividing it into individual frames and compressing these frames into
-raw, unformatted 'packets'. The decoder then accepts these raw
-packets in sequence, decodes them, synthesizes audio frames from
-them, and reassembles the frames into a facsimile of the original
-audio stream. Vorbis is a free-form variable bit rate (VBR) codec and packets have no
-minimum size, maximum size, or fixed/expected size. Packets
-are designed that they may be truncated (or padded) and remain
-decodable; this is not to be considered an error condition and is used
-extensively in bitrate management in peeling. Both the transport
-mechanism and decoder must allow that a packet may be any size, or
-end before or after packet decode expects.</p><p>
-Vorbis packets are thus intended to be used with a transport mechanism
-that provides free-form framing, sync, positioning and error correction
-in accordance with these design assumptions, such as Ogg (for file
-transport) or RTP (for network multicast). For purposes of a few
-examples in this document, we will assume that Vorbis is to be
-embedded in an Ogg stream specifically, although this is by no means a
-requirement or fundamental assumption in the Vorbis design.</p><p>
-The specification for embedding Vorbis into
-an Ogg transport stream is in <a href="#vorbis-over-ogg" title="A. Embedding Vorbis into an Ogg stream">Appendix A, <i>Embedding Vorbis into an Ogg stream</i></a>.
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4759113"></a>1.1.4. Codec Setup and Probability Model</h4></div></div></div><p>
-Vorbis' heritage is as a research CODEC and its current design
-reflects a desire to allow multiple decades of continuous encoder
-improvement before running out of room within the codec specification.
-For these reasons, configurable aspects of codec setup intentionally
-lean toward the extreme of forward adaptive.</p><p>
-The single most controversial design decision in Vorbis (and the most
-unusual for a Vorbis developer to keep in mind) is that the entire
-probability model of the codec, the Huffman and VQ codebooks, is
-packed into the bitstream header along with extensive CODEC setup
-parameters (often several hundred fields). This makes it impossible,
-as it would be with MPEG audio layers, to embed a simple frame type
-flag in each audio packet, or begin decode at any frame in the stream
-without having previously fetched the codec setup header.
-</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
-Vorbis <span class="emphasis"><em>can</em></span> initiate decode at any arbitrary packet within a
-bitstream so long as the codec has been initialized/setup with the
-setup headers.</p></div><p>
-Thus, Vorbis headers are both required for decode to begin and
-relatively large as bitstream headers go. The header size is
-unbounded, although for streaming a rule-of-thumb of 4kB or less is
-recommended (and Xiph.Org's Vorbis encoder follows this suggestion).</p><p>
-Our own design work indicates the primary liability of the
-required header is in mindshare; it is an unusual design and thus
-causes some amount of complaint among engineers as this runs against
-current design trends (and also points out limitations in some
-existing software/interface designs, such as Windows' ACM codec
-framework). However, we find that it does not fundamentally limit
-Vorbis' suitable application space.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4795014"></a>1.1.5. Format Specification</h4></div></div></div><p>
-The Vorbis format is well-defined by its decode specification; any
-encoder that produces packets that are correctly decoded by the
-reference Vorbis decoder described below may be considered a proper
-Vorbis encoder. A decoder must faithfully and completely implement
-the specification defined below (except where noted) to be considered
-a proper Vorbis decoder.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4783549"></a>1.1.6. Hardware Profile</h4></div></div></div><p>
-Although Vorbis decode is computationally simple, it may still run
-into specific limitations of an embedded design. For this reason,
-embedded designs are allowed to deviate in limited ways from the
-'full' decode specification yet still be certified compliant. These
-optional omissions are labelled in the spec where relevant.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4767185"></a>1.2. Decoder Configuration</h3></div></div></div><p>
-Decoder setup consists of configuration of multiple, self-contained
-component abstractions that perform specific functions in the decode
-pipeline. Each different component instance of a specific type is
-semantically interchangeable; decoder configuration consists both of
-internal component configuration, as well as arrangement of specific
-instances into a decode pipeline. Componentry arrangement is roughly
-as follows:</p><div class="mediaobject"><img src="components.png" alt="decoder pipeline configuration"></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4768325"></a>1.2.1. Global Config</h4></div></div></div><p>
-Global codec configuration consists of a few audio related fields
-(sample rate, channels), Vorbis version (always '0' in Vorbis I),
-bitrate hints, and the lists of component instances. All other
-configuration is in the context of specific components.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4768338"></a>1.2.2. Mode</h4></div></div></div><p>
-Each Vorbis frame is coded according to a master 'mode'. A bitstream
-may use one or many modes.</p><p>
-The mode mechanism is used to encode a frame according to one of
-multiple possible methods with the intention of choosing a method best
-suited to that frame. Different modes are, e.g. how frame size
-is changed from frame to frame. The mode number of a frame serves as a
-top level configuration switch for all other specific aspects of frame
-decode.</p><p>
-A 'mode' configuration consists of a frame size setting, window type
-(always 0, the Vorbis window, in Vorbis I), transform type (always
-type 0, the MDCT, in Vorbis I) and a mapping number. The mapping
-number specifies which mapping configuration instance to use for
-low-level packet decode and synthesis.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4768364"></a>1.2.3. Mapping</h4></div></div></div><p>
-A mapping contains a channel coupling description and a list of
-'submaps' that bundle sets of channel vectors together for grouped
-encoding and decoding. These submaps are not references to external
-components; the submap list is internal and specific to a mapping.</p><p>
-A 'submap' is a configuration/grouping that applies to a subset of
-floor and residue vectors within a mapping. The submap functions as a
-last layer of indirection such that specific special floor or residue
-settings can be applied not only to all the vectors in a given mode,
-but also specific vectors in a specific mode. Each submap specifies
-the proper floor and residue instance number to use for decoding that
-submap's spectral floor and spectral residue vectors.</p><p>
-As an example:</p><p>
-Assume a Vorbis stream that contains six channels in the standard 5.1
-format. The sixth channel, as is normal in 5.1, is bass only.
-Therefore it would be wasteful to encode a full-spectrum version of it
-as with the other channels. The submapping mechanism can be used to
-apply a full range floor and residue encoding to channels 0 through 4,
-and a bass-only representation to the bass channel, thus saving space.
-In this example, channels 0-4 belong to submap 0 (which indicates use
-of a full-range floor) and channel 5 belongs to submap 1, which uses a
-bass-only representation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4763767"></a>1.2.4. Floor</h4></div></div></div><p>
-Vorbis encodes a spectral 'floor' vector for each PCM channel. This
-vector is a low-resolution representation of the audio spectrum for
-the given channel in the current frame, generally used akin to a
-whitening filter. It is named a 'floor' because the Xiph.Org
-reference encoder has historically used it as a unit-baseline for
-spectral resolution.</p><p>
-A floor encoding may be of two types. Floor 0 uses a packed LSP
-representation on a dB amplitude scale and Bark frequency scale.
-Floor 1 represents the curve as a piecewise linear interpolated
-representation on a dB amplitude scale and linear frequency scale.
-The two floors are semantically interchangeable in
-encoding/decoding. However, floor type 1 provides more stable
-inter-frame behavior, and so is the preferred choice in all
-coupled-stereo and high bitrate modes. Floor 1 is also considerably
-less expensive to decode than floor 0.</p><p>
-Floor 0 is not to be considered deprecated, but it is of limited
-modern use. No known Vorbis encoder past Xiph.org's own beta 4 makes
-use of floor 0.</p><p>
-The values coded/decoded by a floor are both compactly formatted and
-make use of entropy coding to save space. For this reason, a floor
-configuration generally refers to multiple codebooks in the codebook
-component list. Entropy coding is thus provided as an abstraction,
-and each floor instance may choose from any and all available
-codebooks when coding/decoding.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4768429"></a>1.2.5. Residue</h4></div></div></div><p>
-The spectral residue is the fine structure of the audio spectrum
-once the floor curve has been subtracted out. In simplest terms, it
-is coded in the bitstream using cascaded (multi-pass) vector
-quantization according to one of three specific packing/coding
-algorithms numbered 0 through 2. The packing algorithm details are
-configured by residue instance. As with the floor components, the
-final VQ/entropy encoding is provided by external codebook instances
-and each residue instance may choose from any and all available
-codebooks.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4782217"></a>1.2.6. Codebooks</h4></div></div></div><p>
-Codebooks are a self-contained abstraction that perform entropy
-decoding and, optionally, use the entropy-decoded integer value as an
-offset into an index of output value vectors, returning the indicated
-vector of values.</p><p>
-The entropy coding in a Vorbis I codebook is provided by a standard
-Huffman binary tree representation. This tree is tightly packed using
-one of several methods, depending on whether codeword lengths are
-ordered or unordered, or the tree is sparse.</p><p>
-The codebook vector index is similarly packed according to index
-characteristic. Most commonly, the vector index is encoded as a
-single list of values of possible values that are then permuted into
-a list of n-dimensional rows (lattice VQ).</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4768455"></a>1.3. High-level Decode Process</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4768461"></a>1.3.1. Decode Setup</h4></div></div></div><p>
-Before decoding can begin, a decoder must initialize using the
-bitstream headers matching the stream to be decoded. Vorbis uses
-three header packets; all are required, in-order, by this
-specification. Once set up, decode may begin at any audio packet
-belonging to the Vorbis stream. In Vorbis I, all packets after the
-three initial headers are audio packets. </p><p>
-The header packets are, in order, the identification
-header, the comments header, and the setup header.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4768479"></a>1.3.1.1. Identification Header</h5></div></div></div><p>
-The identification header identifies the bitstream as Vorbis, Vorbis
-version, and the simple audio characteristics of the stream such as
-sample rate and number of channels.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4768490"></a>1.3.1.2. Comment Header</h5></div></div></div><p>
-The comment header includes user text comments ("tags") and a vendor
-string for the application/library that produced the bitstream. The
-encoding and proper use of the comment header is described in
-<a href="#vorbis-spec-comment" title="5. comment field and header specification">Section 5, “comment field and header specification”</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4719865"></a>1.3.1.3. Setup Header</h5></div></div></div><p>
-The setup header includes extensive CODEC setup information as well as
-the complete VQ and Huffman codebooks needed for decode.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4770227"></a>1.3.2. Decode Procedure</h4></div></div></div><div class="highlights"><p>
-The decoding and synthesis procedure for all audio packets is
-fundamentally the same.
-</p><div class="orderedlist"><ol type="1"><li>decode packet type flag</li><li>decode mode number</li><li>decode window shape (long windows only)</li><li>decode floor</li><li>decode residue into residue vectors</li><li>inverse channel coupling of residue vectors</li><li>generate floor curve from decoded floor data</li><li>compute dot product of floor and residue, producing audio spectrum vector</li><li>inverse monolithic transform of audio spectrum vector, always an MDCT in Vorbis I</li><li>overlap/add left-hand output of transform with right-hand output of previous frame</li><li>store right hand-data from transform of current frame for future lapping</li><li>if not first frame, return results of overlap/add as audio result of current frame</li></ol></div><p>
-</p></div><p>
-Note that clever rearrangement of the synthesis arithmetic is
-possible; as an example, one can take advantage of symmetries in the
-MDCT to store the right-hand transform data of a partial MDCT for a
-50% inter-frame buffer space savings, and then complete the transform
-later before overlap/add with the next frame. This optimization
-produces entirely equivalent output and is naturally perfectly legal.
-The decoder must be <span class="emphasis"><em>entirely mathematically equivalent</em></span> to the
-specification, it need not be a literal semantic implementation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4680705"></a>1.3.2.1. Packet type decode</h5></div></div></div><p>
-Vorbis I uses four packet types. The first three packet types mark each
-of the three Vorbis headers described above. The fourth packet type
-marks an audio packet. All other packet types are reserved; packets
-marked with a reserved type should be ignored.</p><p>
-Following the three header packets, all packets in a Vorbis I stream
-are audio. The first step of audio packet decode is to read and
-verify the packet type; <span class="emphasis"><em>a non-audio packet when audio is expected
-indicates stream corruption or a non-compliant stream. The decoder
-must ignore the packet and not attempt decoding it to
-audio</em></span>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4680730"></a>1.3.2.2. Mode decode</h5></div></div></div><p>
-Vorbis allows an encoder to set up multiple, numbered packet 'modes',
-as described earlier, all of which may be used in a given Vorbis
-stream. The mode is encoded as an integer used as a direct offset into
-the mode instance index. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-window"></a>1.3.2.3. Window shape decode (long windows only)</h5></div></div></div><p>
-Vorbis frames may be one of two PCM sample sizes specified during
-codec setup. In Vorbis I, legal frame sizes are powers of two from 64
-to 8192 samples. Aside from coupling, Vorbis handles channels as
-independent vectors and these frame sizes are in samples per channel.</p><p>
-Vorbis uses an overlapping transform, namely the MDCT, to blend one
-frame into the next, avoiding most inter-frame block boundary
-artifacts. The MDCT output of one frame is windowed according to MDCT
-requirements, overlapped 50% with the output of the previous frame and
-added. The window shape assures seamless reconstruction. </p><p>
-This is easy to visualize in the case of equal sized-windows:</p><div class="mediaobject"><img src="window1.png" alt="overlap of two equal-sized windows"></div><p>
-And slightly more complex in the case of overlapping unequal sized
-windows:</p><div class="mediaobject"><img src="window2.png" alt="overlap of a long and a short window"></div><p>
-In the unequal-sized window case, the window shape of the long window
-must be modified for seamless lapping as above. It is possible to
-correctly infer window shape to be applied to the current window from
-knowing the sizes of the current, previous and next window. It is
-legal for a decoder to use this method. However, in the case of a long
-window (short windows require no modification), Vorbis also codes two
-flag bits to specify pre- and post- window shape. Although not
-strictly necessary for function, this minor redundancy allows a packet
-to be fully decoded to the point of lapping entirely independently of
-any other packet, allowing easier abstraction of decode layers as well
-as allowing a greater level of easy parallelism in encode and
-decode.</p><p>
-A description of valid window functions for use with an inverse MDCT
-can be found in the paper
-“<span class="citetitle">
-<a href="http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps" target="_top">
-The use of multirate filter banks for coding of high quality digital
-audio</a></span>”, by T. Sporer, K. Brandenburg and B. Edler. Vorbis windows
-all use the slope function
- <span class="inlinemediaobject"></span>.
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4680859"></a>1.3.2.4. floor decode</h5></div></div></div><p>
-Each floor is encoded/decoded in channel order, however each floor
-belongs to a 'submap' that specifies which floor configuration to
-use. All floors are decoded before residue decode begins.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4680871"></a>1.3.2.5. residue decode</h5></div></div></div><p>
-Although the number of residue vectors equals the number of channels,
-channel coupling may mean that the raw residue vectors extracted
-during decode do not map directly to specific channels. When channel
-coupling is in use, some vectors will correspond to coupled magnitude
-or angle. The coupling relationships are described in the codec setup
-and may differ from frame to frame, due to different mode numbers.</p><p>
-Vorbis codes residue vectors in groups by submap; the coding is done
-in submap order from submap 0 through n-1. This differs from floors
-which are coded using a configuration provided by submap number, but
-are coded individually in channel order.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4680894"></a>1.3.2.6. inverse channel coupling</h5></div></div></div><p>
-A detailed discussion of stereo in the Vorbis codec can be found in
-the document <a href="stereo.html" target="_top"><i class="citetitle">Stereo Channel Coupling in the
-Vorbis CODEC</i></a>. Vorbis is not limited to only stereo coupling, but
-the stereo document also gives a good overview of the generic coupling
-mechanism.</p><p>
-Vorbis coupling applies to pairs of residue vectors at a time;
-decoupling is done in-place a pair at a time in the order and using
-the vectors specified in the current mapping configuration. The
-decoupling operation is the same for all pairs, converting square
-polar representation (where one vector is magnitude and the second
-angle) back to Cartesian representation.</p><p>
-After decoupling, in order, each pair of vectors on the coupling list,
-the resulting residue vectors represent the fine spectral detail
-of each output channel.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4680927"></a>1.3.2.7. generate floor curve</h5></div></div></div><p>
-The decoder may choose to generate the floor curve at any appropriate
-time. It is reasonable to generate the output curve when the floor
-data is decoded from the raw packet, or it can be generated after
-inverse coupling and applied to the spectral residue directly,
-combining generation and the dot product into one step and eliminating
-some working space.</p><p>
-Both floor 0 and floor 1 generate a linear-range, linear-domain output
-vector to be multiplied (dot product) by the linear-range,
-linear-domain spectral residue.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4680948"></a>1.3.2.8. compute floor/residue dot product</h5></div></div></div><p>
-This step is straightforward; for each output channel, the decoder
-multiplies the floor curve and residue vectors element by element,
-producing the finished audio spectrum of each channel.</p><p>
-One point is worth mentioning about this dot product; a common mistake
-in a fixed point implementation might be to assume that a 32 bit
-fixed-point representation for floor and residue and direct
-multiplication of the vectors is sufficient for acceptable spectral
-depth in all cases because it happens to mostly work with the current
-Xiph.Org reference encoder.</p><p>
-However, floor vector values can span ~140dB (~24 bits unsigned), and
-the audio spectrum vector should represent a minimum of 120dB (~21
-bits with sign), even when output is to a 16 bit PCM device. For the
-residue vector to represent full scale if the floor is nailed to
--140dB, it must be able to span 0 to +140dB. For the residue vector
-to reach full scale if the floor is nailed at 0dB, it must be able to
-represent -140dB to +0dB. Thus, in order to handle full range
-dynamics, a residue vector may span -140dB to +140dB entirely within
-spec. A 280dB range is approximately 48 bits with sign; thus the
-residue vector must be able to represent a 48 bit range and the dot
-product must be able to handle an effective 48 bit times 24 bit
-multiplication. This range may be achieved using large (64 bit or
-larger) integers, or implementing a movable binary point
-representation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4681482"></a>1.3.2.9. inverse monolithic transform (MDCT)</h5></div></div></div><p>
-The audio spectrum is converted back into time domain PCM audio via an
-inverse Modified Discrete Cosine Transform (MDCT). A detailed
-description of the MDCT is available in the paper <a href="http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps" target="_top">“<span class="citetitle">The use of multirate filter banks for coding of high quality digital
-audio</span>”</a>, by T. Sporer, K. Brandenburg and B. Edler.</p><p>
-Note that the PCM produced directly from the MDCT is not yet finished
-audio; it must be lapped with surrounding frames using an appropriate
-window (such as the Vorbis window) before the MDCT can be considered
-orthogonal.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4681510"></a>1.3.2.10. overlap/add data</h5></div></div></div><p>
-Windowed MDCT output is overlapped and added with the right hand data
-of the previous window such that the 3/4 point of the previous window
-is aligned with the 1/4 point of the current window (as illustrated in
-the window overlap diagram). At this point, the audio data between the
-center of the previous frame and the center of the current frame is
-now finished and ready to be returned. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4681525"></a>1.3.2.11. cache right hand data</h5></div></div></div><p>
-The decoder must cache the right hand portion of the current frame to
-be lapped with the left hand portion of the next frame.
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4681536"></a>1.3.2.12. return finished audio data</h5></div></div></div><p>
-The overlapped portion produced from overlapping the previous and
-current frame data is finished data to be returned by the decoder.
-This data spans from the center of the previous window to the center
-of the current window. In the case of same-sized windows, the amount
-of data to return is one-half block consisting of and only of the
-overlapped portions. When overlapping a short and long window, much of
-the returned range is not actually overlap. This does not damage
-transform orthogonality. Pay attention however to returning the
-correct data range; the amount of data to be returned is:
-
-</p><pre class="programlisting">
-window_blocksize(previous_window)/4+window_blocksize(current_window)/4
-</pre><p>
-
-from the center of the previous window to the center of the current
-window.</p><p>
-Data is not returned from the first frame; it must be used to 'prime'
-the decode engine. The encoder accounts for this priming when
-calculating PCM offsets; after the first frame, the proper PCM output
-offset is '0' (as no data has been returned yet).</p></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-bitpacking"></a>2. Bitpacking Convention</h2></div><div><p class="releaseinfo">
- $Id: 02-bitpacking.xml 7186 2004-07-20 07:19:25Z xiphmont $
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4770613"></a>2.1. Overview</h3></div></div></div><p>
-The Vorbis codec uses relatively unstructured raw packets containing
-arbitrary-width binary integer fields. Logically, these packets are a
-bitstream in which bits are coded one-by-one by the encoder and then
-read one-by-one in the same monotonically increasing order by the
-decoder. Most current binary storage arrangements group bits into a
-native word size of eight bits (octets), sixteen bits, thirty-two bits
-or, less commonly other fixed word sizes. The Vorbis bitpacking
-convention specifies the correct mapping of the logical packet
-bitstream into an actual representation in fixed-width words.
-</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4794814"></a>2.1.1. octets, bytes and words</h4></div></div></div><p>
-In most contemporary architectures, a 'byte' is synonymous with an
-'octet', that is, eight bits. This has not always been the case;
-seven, ten, eleven and sixteen bit 'bytes' have been used. For
-purposes of the bitpacking convention, a byte implies the native,
-smallest integer storage representation offered by a platform. On
-modern platforms, this is generally assumed to be eight bits (not
-necessarily because of the processor but because of the
-filesystem/memory architecture. Modern filesystems invariably offer
-bytes as the fundamental atom of storage). A 'word' is an integer
-size that is a grouped multiple of this smallest size.</p><p>
-The most ubiquitous architectures today consider a 'byte' to be an
-octet (eight bits) and a word to be a group of two, four or eight
-bytes (16, 32 or 64 bits). Note however that the Vorbis bitpacking
-convention is still well defined for any native byte size; Vorbis uses
-the native bit-width of a given storage system. This document assumes
-that a byte is one octet for purposes of example.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4744761"></a>2.1.2. bit order</h4></div></div></div><p>
-A byte has a well-defined 'least significant' bit (LSb), which is the
-only bit set when the byte is storing the two's complement integer
-value +1. A byte's 'most significant' bit (MSb) is at the opposite
-end of the byte. Bits in a byte are numbered from zero at the LSb to
-<span class="emphasis"><em>n</em></span> (<span class="emphasis"><em>n</em></span>=7 in an octet) for the
-MSb.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4749539"></a>2.1.3. byte order</h4></div></div></div><p>
-Words are native groupings of multiple bytes. Several byte orderings
-are possible in a word; the common ones are 3-2-1-0 ('big endian' or
-'most significant byte first' in which the highest-valued byte comes
-first), 0-1-2-3 ('little endian' or 'least significant byte first' in
-which the lowest value byte comes first) and less commonly 3-1-2-0 and
-0-2-1-3 ('mixed endian').</p><p>
-The Vorbis bitpacking convention specifies storage and bitstream
-manipulation at the byte, not word, level, thus host word ordering is
-of a concern only during optimization when writing high performance
-code that operates on a word of storage at a time rather than by byte.
-Logically, bytes are always coded and decoded in order from byte zero
-through byte <span class="emphasis"><em>n</em></span>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4772197"></a>2.1.4. coding bits into byte sequences</h4></div></div></div><p>
-The Vorbis codec has need to code arbitrary bit-width integers, from
-zero to 32 bits wide, into packets. These integer fields are not
-aligned to the boundaries of the byte representation; the next field
-is written at the bit position at which the previous field ends.</p><p>
-The encoder logically packs integers by writing the LSb of a binary
-integer to the logical bitstream first, followed by next least
-significant bit, etc, until the requested number of bits have been
-coded. When packing the bits into bytes, the encoder begins by
-placing the LSb of the integer to be written into the least
-significant unused bit position of the destination byte, followed by
-the next-least significant bit of the source integer and so on up to
-the requested number of bits. When all bits of the destination byte
-have been filled, encoding continues by zeroing all bits of the next
-byte and writing the next bit into the bit position 0 of that byte.
-Decoding follows the same process as encoding, but by reading bits
-from the byte stream and reassembling them into integers.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4794292"></a>2.1.5. signedness</h4></div></div></div><p>
-The signedness of a specific number resulting from decode is to be
-interpreted by the decoder given decode context. That is, the three
-bit binary pattern 'b111' can be taken to represent either 'seven' as
-an unsigned integer, or '-1' as a signed, two's complement integer.
-The encoder and decoder are responsible for knowing if fields are to
-be treated as signed or unsigned.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4793785"></a>2.1.6. coding example</h4></div></div></div><p>
-Code the 4 bit integer value '12' [b1100] into an empty bytestream.
-Bytestream result:
-
-</p><pre class="screen">
- |
- V
-
- 7 6 5 4 3 2 1 0
-byte 0 [0 0 0 0 1 1 0 0] <-
-byte 1 [ ]
-byte 2 [ ]
-byte 3 [ ]
- ...
-byte n [ ] bytestream length == 1 byte
-
-</pre><p>
-</p><p>
-Continue by coding the 3 bit integer value '-1' [b111]:
-
-</p><pre class="screen">
- |
- V
-
- 7 6 5 4 3 2 1 0
-byte 0 [0 1 1 1 1 1 0 0] <-
-byte 1 [ ]
-byte 2 [ ]
-byte 3 [ ]
- ...
-byte n [ ] bytestream length == 1 byte
-</pre><p>
-</p><p>
-Continue by coding the 7 bit integer value '17' [b0010001]:
-
-</p><pre class="screen">
- |
- V
-
- 7 6 5 4 3 2 1 0
-byte 0 [1 1 1 1 1 1 0 0]
-byte 1 [0 0 0 0 1 0 0 0] <-
-byte 2 [ ]
-byte 3 [ ]
- ...
-byte n [ ] bytestream length == 2 bytes
- bit cursor == 6
-</pre><p>
-</p><p>
-Continue by coding the 13 bit integer value '6969' [b110 11001110 01]:
-
-</p><pre class="screen">
- |
- V
-
- 7 6 5 4 3 2 1 0
-byte 0 [1 1 1 1 1 1 0 0]
-byte 1 [0 1 0 0 1 0 0 0]
-byte 2 [1 1 0 0 1 1 1 0]
-byte 3 [0 0 0 0 0 1 1 0] <-
- ...
-byte n [ ] bytestream length == 4 bytes
-
-</pre><p>
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4761599"></a>2.1.7. decoding example</h4></div></div></div><p>
-Reading from the beginning of the bytestream encoded in the above example:
-
-</p><pre class="screen">
- |
- V
-
- 7 6 5 4 3 2 1 0
-byte 0 [1 1 1 1 1 1 0 0] <-
-byte 1 [0 1 0 0 1 0 0 0]
-byte 2 [1 1 0 0 1 1 1 0]
-byte 3 [0 0 0 0 0 1 1 0] bytestream length == 4 bytes
-
-</pre><p>
-</p><p>
-We read two, two-bit integer fields, resulting in the returned numbers
-'b00' and 'b11'. Two things are worth noting here:
-
-</p><div class="itemizedlist"><ul type="disc"><li><p>Although these four bits were originally written as a single
-four-bit integer, reading some other combination of bit-widths from the
-bitstream is well defined. There are no artificial alignment
-boundaries maintained in the bitstream.</p></li><li><p>The second value is the
-two-bit-wide integer 'b11'. This value may be interpreted either as
-the unsigned value '3', or the signed value '-1'. Signedness is
-dependent on decode context.</p></li></ul></div><p>
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4761642"></a>2.1.8. end-of-packet alignment</h4></div></div></div><p>
-The typical use of bitpacking is to produce many independent
-byte-aligned packets which are embedded into a larger byte-aligned
-container structure, such as an Ogg transport bitstream. Externally,
-each bytestream (encoded bitstream) must begin and end on a byte
-boundary. Often, the encoded bitstream is not an integer number of
-bytes, and so there is unused (uncoded) space in the last byte of a
-packet.</p><p>
-Unused space in the last byte of a bytestream is always zeroed during
-the coding process. Thus, should this unused space be read, it will
-return binary zeroes.</p><p>
-Attempting to read past the end of an encoded packet results in an
-'end-of-packet' condition. End-of-packet is not to be considered an
-error; it is merely a state indicating that there is insufficient
-remaining data to fulfill the desired read size. Vorbis uses truncated
-packets as a normal mode of operation, and as such, decoders must
-handle reading past the end of a packet as a typical mode of
-operation. Any further read operations after an 'end-of-packet'
-condition shall also return 'end-of-packet'.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4746995"></a>2.1.9. reading zero bits</h4></div></div></div><p>
-Reading a zero-bit-wide integer returns the value '0' and does not
-increment the stream cursor. Reading to the end of the packet (but
-not past, such that an 'end-of-packet' condition has not triggered)
-and then reading a zero bit integer shall succeed, returning 0, and
-not trigger an end-of-packet condition. Reading a zero-bit-wide
-integer after a previous read sets 'end-of-packet' shall also fail
-with 'end-of-packet'.</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-codebook"></a>3. Probability Model and Codebooks</h2></div><div><p class="releaseinfo">
- $Id: 03-codebook.xml 7186 2004-07-20 07:19:25Z xiphmont $
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4792843"></a>3.1. Overview</h3></div></div></div><p>
-Unlike practically every other mainstream audio codec, Vorbis has no
-statically configured probability model, instead packing all entropy
-decoding configuration, VQ and Huffman, into the bitstream itself in
-the third header, the codec setup header. This packed configuration
-consists of multiple 'codebooks', each containing a specific
-Huffman-equivalent representation for decoding compressed codewords as
-well as an optional lookup table of output vector values to which a
-decoded Huffman value is applied as an offset, generating the final
-decoded output corresponding to a given compressed codeword.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4799609"></a>3.1.1. Bitwise operation</h4></div></div></div><p>
-The codebook mechanism is built on top of the vorbis bitpacker. Both
-the codebooks themselves and the codewords they decode are unrolled
-from a packet as a series of arbitrary-width values read from the
-stream according to <a href="#vorbis-spec-bitpacking" title="2. Bitpacking Convention">Section 2, “Bitpacking Convention”</a>.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4772022"></a>3.2. Packed codebook format</h3></div></div></div><p>
-For purposes of the examples below, we assume that the storage
-system's native byte width is eight bits. This is not universally
-true; see <a href="#vorbis-spec-bitpacking" title="2. Bitpacking Convention">Section 2, “Bitpacking Convention”</a> for discussion
-relating to non-eight-bit bytes.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4760569"></a>3.2.1. codebook decode</h4></div></div></div><p>
-A codebook begins with a 24 bit sync pattern, 0x564342:
-
-</p><pre class="screen">
-byte 0: [ 0 1 0 0 0 0 1 0 ] (0x42)
-byte 1: [ 0 1 0 0 0 0 1 1 ] (0x43)
-byte 2: [ 0 1 0 1 0 1 1 0 ] (0x56)
-</pre><p>
-16 bit <tt class="varname">[codebook_dimensions]</tt> and 24 bit <tt class="varname">[codebook_entries]</tt> fields:
-
-</p><pre class="screen">
-
-byte 3: [ X X X X X X X X ]
-byte 4: [ X X X X X X X X ] [codebook_dimensions] (16 bit unsigned)
-
-byte 5: [ X X X X X X X X ]
-byte 6: [ X X X X X X X X ]
-byte 7: [ X X X X X X X X ] [codebook_entries] (24 bit unsigned)
-
-</pre><p>
-Next is the <tt class="varname">[ordered]</tt> bit flag:
-
-</p><pre class="screen">
-
-byte 8: [ X ] [ordered] (1 bit)
-
-</pre><p>
-Each entry, numbering a
-total of <tt class="varname">[codebook_entries]</tt>, is assigned a codeword length.
-We now read the list of codeword lengths and store these lengths in
-the array <tt class="varname">[codebook_codeword_lengths]</tt>. Decode of lengths is
-according to whether the <tt class="varname">[ordered]</tt> flag is set or unset.
-
-</p><div class="itemizedlist"><ul type="disc"><li><p>If the <tt class="varname">[ordered]</tt> flag is unset, the codeword list is not
- length ordered and the decoder needs to read each codeword length
- one-by-one.</p><p>The decoder first reads one additional bit flag, the
- <tt class="varname">[sparse]</tt> flag. This flag determines whether or not the
- codebook contains unused entries that are not to be included in the
- codeword decode tree:
-
-</p><pre class="screen">
-byte 8: [ X 1 ] [sparse] flag (1 bit)
-</pre><p>
- The decoder now performs for each of the <tt class="varname">[codebook_entries]</tt>
- codebook entries:
-
-</p><pre class="screen">
-
- 1) if([sparse] is set){
-
- 2) [flag] = read one bit;
- 3) if([flag] is set){
-
- 4) [length] = read a five bit unsigned integer;
- 5) codeword length for this entry is [length]+1;
-
- } else {
-
- 6) this entry is unused. mark it as such.
-
- }
-
- } else the sparse flag is not set {
-
- 7) [length] = read a five bit unsigned integer;
- 8) the codeword length for this entry is [length]+1;
-
- }
-
-</pre></li><li><p>If the <tt class="varname">[ordered]</tt> flag is set, the codeword list for this
- codebook is encoded in ascending length order. Rather than reading
- a length for every codeword, the encoder reads the number of
- codewords per length. That is, beginning at entry zero:
-
-</p><pre class="screen">
- 1) [current_entry] = 0;
- 2) [current_length] = read a five bit unsigned integer and add 1;
- 3) [number] = read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>([codebook_entries] - [current_entry]) bits as an unsigned integer
- 4) set the entries [current_entry] through [current_entry]+[number]-1, inclusive,
- of the [codebook_codeword_lengths] array to [current_length]
- 5) set [current_entry] to [number] + [current_entry]
- 6) increment [current_length] by 1
- 7) if [current_entry] is greater than [codebook_entries] ERROR CONDITION;
- the decoder will not be able to read this stream.
- 8) if [current_entry] is less than [codebook_entries], repeat process starting at 3)
- 9) done.
-</pre></li></ul></div><p>
-
-After all codeword lengths have been decoded, the decoder reads the
-vector lookup table. Vorbis I supports three lookup types:
-</p><div class="orderedlist"><ol type="1"><li>No lookup</li><li>Implicitly populated value mapping (lattice VQ)</li><li>Explicitly populated value mapping (tessellated or 'foam'
-VQ)</li></ol></div><p>
-</p><p>
-The lookup table type is read as a four bit unsigned integer:
-</p><pre class="screen">
- 1) [codebook_lookup_type] = read four bits as an unsigned integer
-</pre><p>
-Codebook decode precedes according to <tt class="varname">[codebook_lookup_type]</tt>:
-</p><div class="itemizedlist"><ul type="disc"><li><p>Lookup type zero indicates no lookup to be read. Proceed past
-lookup decode.</p></li><li><p>Lookup types one and two are similar, differing only in the
-number of lookup values to be read. Lookup type one reads a list of
-values that are permuted in a set pattern to build a list of vectors,
-each vector of order <tt class="varname">[codebook_dimensions]</tt> scalars. Lookup
-type two builds the same vector list, but reads each scalar for each
-vector explicitly, rather than building vectors from a smaller list of
-possible scalar values. Lookup decode proceeds as follows:
-
-</p><pre class="screen">
- 1) [codebook_minimum_value] = <a href="#vorbis-spec-float32_unpack" title="9.2.2. float32_unpack">float32_unpack</a>( read 32 bits as an unsigned integer)
- 2) [codebook_delta_value] = <a href="#vorbis-spec-float32_unpack" title="9.2.2. float32_unpack">float32_unpack</a>( read 32 bits as an unsigned integer)
- 3) [codebook_value_bits] = read 4 bits as an unsigned integer and add 1
- 4) [codebook_sequence_p] = read 1 bit as a boolean flag
-
- if ( [codebook_lookup_type] is 1 ) {
-
- 5) [codebook_lookup_values] = <a href="#vorbis-spec-lookup1_values" title="9.2.3. lookup1_values">lookup1_values</a>(<tt class="varname">[codebook_entries]</tt>, <tt class="varname">[codebook_dimensions]</tt> )
-
- } else {
-
- 6) [codebook_lookup_values] = <tt class="varname">[codebook_entries]</tt> * <tt class="varname">[codebook_dimensions]</tt>
-
- }
-
- 7) read a total of [codebook_lookup_values] unsigned integers of [codebook_value_bits] each;
- store these in order in the array [codebook_multiplicands]
-</pre></li><li><p>A <tt class="varname">[codebook_lookup_type]</tt> of greater than two is reserved
-and indicates a stream that is not decodable by the specification in this
-document.</p></li></ul></div><p>
-</p><p>
-An 'end of packet' during any read operation in the above steps is
-considered an error condition rendering the stream undecodable.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4770513"></a>3.2.1.1. Huffman decision tree representation</h5></div></div></div><p>
-The <tt class="varname">[codebook_codeword_lengths]</tt> array and
-<tt class="varname">[codebook_entries]</tt> value uniquely define the Huffman decision
-tree used for entropy decoding.</p><p>
-Briefly, each used codebook entry (recall that length-unordered
-codebooks support unused codeword entries) is assigned, in order, the
-lowest valued unused binary Huffman codeword possible. Assume the
-following codeword length list:
-
-</p><pre class="screen">
-entry 0: length 2
-entry 1: length 4
-entry 2: length 4
-entry 3: length 4
-entry 4: length 4
-entry 5: length 2
-entry 6: length 3
-entry 7: length 3
-</pre><p>
-Assigning codewords in order (lowest possible value of the appropriate
-length to highest) results in the following codeword list:
-
-</p><pre class="screen">
-entry 0: length 2 codeword 00
-entry 1: length 4 codeword 0100
-entry 2: length 4 codeword 0101
-entry 3: length 4 codeword 0110
-entry 4: length 4 codeword 0111
-entry 5: length 2 codeword 10
-entry 6: length 3 codeword 110
-entry 7: length 3 codeword 111
-</pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
-Unlike most binary numerical values in this document, we
-intend the above codewords to be read and used bit by bit from left to
-right, thus the codeword '001' is the bit string 'zero, zero, one'.
-When determining 'lowest possible value' in the assignment definition
-above, the leftmost bit is the MSb.</p></div><p>
-It is clear that the codeword length list represents a Huffman
-decision tree with the entry numbers equivalent to the leaves numbered
-left-to-right:
-
-</p><div class="mediaobject"><img src="hufftree.png" alt="[huffman tree illustration]"></div><p>
-</p><p>
-As we assign codewords in order, we see that each choice constructs a
-new leaf in the leftmost possible position.</p><p>
-Note that it's possible to underspecify or overspecify a Huffman tree
-via the length list. In the above example, if codeword seven were
-eliminated, it's clear that the tree is unfinished:
-
-</p><div class="mediaobject"><img src="hufftree-under.png" alt="[underspecified huffman tree illustration]"></div><p>
-</p><p>
-Similarly, in the original codebook, it's clear that the tree is fully
-populated and a ninth codeword is impossible. Both underspecified and
-overspecified trees are an error condition rendering the stream
-undecodable.</p><p>
-Codebook entries marked 'unused' are simply skipped in the assigning
-process. They have no codeword and do not appear in the decision
-tree, thus it's impossible for any bit pattern read from the stream to
-decode to that entry number.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4782601"></a>3.2.1.2. VQ lookup table vector representation</h5></div></div></div><p>
-Unpacking the VQ lookup table vectors relies on the following values:
-</p><pre class="programlisting">
-the [codebook_multiplicands] array
-[codebook_minimum_value]
-[codebook_delta_value]
-[codebook_sequence_p]
-[codebook_lookup_type]
-[codebook_entries]
-[codebook_dimensions]
-[codebook_lookup_values]
-</pre><p>
-</p><p>
-Decoding (unpacking) a specific vector in the vector lookup table
-proceeds according to <tt class="varname">[codebook_lookup_type]</tt>. The unpacked
-vector values are what a codebook would return during audio packet
-decode in a VQ context.</p><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id4782626"></a>3.2.1.2.1. Vector value decode: Lookup type 1</h6></div></div></div><p>
-Lookup type one specifies a lattice VQ lookup table built
-algorithmically from a list of scalar values. Calculate (unpack) the
-final values of a codebook entry vector from the entries in
-<tt class="varname">[codebook_multiplicands]</tt> as follows (<tt class="varname">[value_vector]</tt>
-is the output vector representing the vector of values for entry number
-<tt class="varname">[lookup_offset]</tt> in this codebook):
-
-</p><pre class="screen">
- 1) [last] = 0;
- 2) [index_divisor] = 1;
- 3) iterate [i] over the range 0 ... [codebook_dimensions]-1 (once for each scalar value in the value vector) {
-
- 4) [multiplicand_offset] = ( [lookup_offset] divided by [index_divisor] using integer
- division ) integer modulo [codebook_lookup_values]
-
- 5) vector [value_vector] element [i] =
- ( [codebook_multiplicands] array element number [multiplicand_offset] ) *
- [codebook_delta_value] + [codebook_minimum_value] + [last];
-
- 6) if ( [codebook_sequence_p] is set ) then set [last] = vector [value_vector] element [i]
-
- 7) [index_divisor] = [index_divisor] * [codebook_lookup_values]
-
- }
-
- 8) vector calculation completed.
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id4782663"></a>3.2.1.2.2. Vector value decode: Lookup type 2</h6></div></div></div><p>
-Lookup type two specifies a VQ lookup table in which each scalar in
-each vector is explicitly set by the <tt class="varname">[codebook_multiplicands]</tt>
-array in a one-to-one mapping. Calculate [unpack] the
-final values of a codebook entry vector from the entries in
-<tt class="varname">[codebook_multiplicands]</tt> as follows (<tt class="varname">[value_vector]</tt>
-is the output vector representing the vector of values for entry number
-<tt class="varname">[lookup_offset]</tt> in this codebook):
-
-</p><pre class="screen">
- 1) [last] = 0;
- 2) [multiplicand_offset] = [lookup_offset] * [codebook_dimensions]
- 3) iterate [i] over the range 0 ... [codebook_dimensions]-1 (once for each scalar value in the value vector) {
-
- 4) vector [value_vector] element [i] =
- ( [codebook_multiplicands] array element number [multiplicand_offset] ) *
- [codebook_delta_value] + [codebook_minimum_value] + [last];
-
- 5) if ( [codebook_sequence_p] is set ) then set [last] = vector [value_vector] element [i]
-
- 6) increment [multiplicand_offset]
-
- }
-
- 7) vector calculation completed.
-</pre></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4782705"></a>3.3. Use of the codebook abstraction</h3></div></div></div><p>
-The decoder uses the codebook abstraction much as it does the
-bit-unpacking convention; a specific codebook reads a
-codeword from the bitstream, decoding it into an entry number, and then
-returns that entry number to the decoder (when used in a scalar
-entropy coding context), or uses that entry number as an offset into
-the VQ lookup table, returning a vector of values (when used in a context
-desiring a VQ value). Scalar or VQ context is always explicit; any call
-to the codebook mechanism requests either a scalar entry number or a
-lookup vector.</p><p>
-Note that VQ lookup type zero indicates that there is no lookup table;
-requesting decode using a codebook of lookup type 0 in any context
-expecting a vector return value (even in a case where a vector of
-dimension one) is forbidden. If decoder setup or decode requests such
-an action, that is an error condition rendering the packet
-undecodable.</p><p>
-Using a codebook to read from the packet bitstream consists first of
-reading and decoding the next codeword in the bitstream. The decoder
-reads bits until the accumulated bits match a codeword in the
-codebook. This process can be though of as logically walking the
-Huffman decode tree by reading one bit at a time from the bitstream,
-and using the bit as a decision boolean to take the 0 branch (left in
-the above examples) or the 1 branch (right in the above examples).
-Walking the tree finishes when the decode process hits a leaf in the
-decision tree; the result is the entry number corresponding to that
-leaf. Reading past the end of a packet propagates the 'end-of-stream'
-condition to the decoder.</p><p>
-When used in a scalar context, the resulting codeword entry is the
-desired return value.</p><p>
-When used in a VQ context, the codeword entry number is used as an
-offset into the VQ lookup table. The value returned to the decoder is
-the vector of scalars corresponding to this offset.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-codec"></a>4. Codec Setup and Packet Decode</h2></div><div><p class="releaseinfo">
- $Id: 04-codec.xml 7186 2004-07-20 07:19:25Z xiphmont $
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4780183"></a>4.1. Overview</h3></div></div></div><p>
-This document serves as the top-level reference document for the
-bit-by-bit decode specification of Vorbis I. This document assumes a
-high-level understanding of the Vorbis decode process, which is
-provided in <a href="#vorbis-spec-intro" title="1. Introduction and Description">Section 1, “Introduction and Description”</a>. <a href="#vorbis-spec-bitpacking" title="2. Bitpacking Convention">Section 2, “Bitpacking Convention”</a> covers reading and writing bit fields from
-and to bitstream packets.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4784922"></a>4.2. Header decode and decode setup</h3></div></div></div><p>
-A Vorbis bitstream begins with three header packets. The header
-packets are, in order, the identification header, the comments header,
-and the setup header. All are required for decode compliance. An
-end-of-packet condition during decoding the first or third header
-packet renders the stream undecodable. End-of-packet decoding the
-comment header is a non-fatal error condition.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4799640"></a>4.2.1. Common header decode</h4></div></div></div><p>
-Each header packet begins with the same header fields.
-</p><pre class="screen">
- 1) [packet_type] : 8 bit value
- 2) 0x76, 0x6f, 0x72, 0x62, 0x69, 0x73: the characters 'v','o','r','b','i','s' as six octets
-</pre><p>
-Decode continues according to packet type; the identification header
-is type 1, the comment header type 3 and the setup header type 5
-(these types are all odd as a packet with a leading single bit of '0'
-is an audio packet). The packets must occur in the order of
-identification, comment, setup.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4766830"></a>4.2.2. Identification header</h4></div></div></div><p>
-The identification header is a short header of only a few fields used
-to declare the stream definitively as Vorbis, and provide a few externally
-relevant pieces of information about the audio stream. The
-identification header is coded as follows:</p><pre class="screen">
- 1) [vorbis_version] = read 32 bits as unsigned integer
- 2) [audio_channels] = read 8 bit integer as unsigned
- 3) [audio_sample_rate] = read 32 bits as unsigned integer
- 4) [bitrate_maximum] = read 32 bits as signed integer
- 5) [bitrate_nominal] = read 32 bits as signed integer
- 6) [bitrate_minimum] = read 32 bits as signed integer
- 7) [blocksize_0] = 2 exponent (read 4 bits as unsigned integer)
- 8) [blocksize_1] = 2 exponent (read 4 bits as unsigned integer)
- 9) [framing_flag] = read one bit
-</pre><p>
-<tt class="varname">[vorbis_version]</tt> is to read '0' in order to be compatible
-with this document. Both <tt class="varname">[audio_channels]</tt> and
-<tt class="varname">[audio_sample_rate]</tt> must read greater than zero. Allowed final
-blocksize values are 64, 128, 256, 512, 1024, 2048, 4096 and 8192 in
-Vorbis I. <tt class="varname">[blocksize_0]</tt> must be less than or equal to
-<tt class="varname">[blocksize_1]</tt>. The framing bit must be nonzero. Failure to
-meet any of these conditions renders a stream undecodable.</p><p>
-The bitrate fields above are used only as hints. The nominal bitrate
-field especially may be considerably off in purely VBR streams. The
-fields are meaningful only when greater than zero.</p><div class="itemizedlist"><ul type="disc"><li>All three fields set to the same value implies a fixed rate, or tightly bounded, nearly fixed-rate bitstream</li><li>Only nominal set implies a VBR or ABR stream that averages the nominal bitrate</li><li>Maximum and or minimum set implies a VBR bitstream that obeys the bitrate limits</li><li>None set indicates the encoder does not care to speculate.</li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4788477"></a>4.2.3. Comment header</h4></div></div></div><p>
-Comment header decode and data specification is covered in
-<a href="#vorbis-spec-comment" title="5. comment field and header specification">Section 5, “comment field and header specification”</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4788489"></a>4.2.4. Setup header</h4></div></div></div><p>
-Vorbis codec setup is configurable to an extreme degree:
-
-</p><div class="mediaobject"><img src="components.png" alt="[decoder pipeline configuration]"></div><p>
-</p><p>
-The setup header contains the bulk of the codec setup information
-needed for decode. The setup header contains, in order, the lists of
-codebook configurations, time-domain transform configurations
-(placeholders in Vorbis I), floor configurations, residue
-configurations, channel mapping configurations and mode
-configurations. It finishes with a framing bit of '1'. Header decode
-proceeds in the following order:</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4771893"></a>4.2.4.1. Codebooks</h5></div></div></div><div class="orderedlist"><ol type="1"><li><tt class="varname">[vorbis_codebook_count]</tt> = read eight bits as unsigned integer and add one</li><li>Decode <tt class="varname">[vorbis_codebook_count]</tt> codebooks in order as defined
-in <a href="#vorbis-spec-codebook" title="3. Probability Model and Codebooks">Section 3, “Probability Model and Codebooks”</a>. Save each configuration, in
-order, in an array of
-codebook configurations <tt class="varname">[vorbis_codebook_configurations]</tt>.</li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4771925"></a>4.2.4.2. Time domain transforms</h5></div></div></div><p>
-These hooks are placeholders in Vorbis I. Nevertheless, the
-configuration placeholder values must be read to maintain bitstream
-sync.</p><div class="orderedlist"><ol type="1"><li><tt class="varname">[vorbis_time_count]</tt> = read 6 bits as unsigned integer and add one</li><li>read <tt class="varname">[vorbis_time_count]</tt> 16 bit values; each value should be zero. If any value is nonzero, this is an error condition and the stream is undecodable.</li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4771954"></a>4.2.4.3. Floors</h5></div></div></div><p>
-Vorbis uses two floor types; header decode is handed to the decode
-abstraction of the appropriate type.</p><div class="orderedlist"><ol type="1"><li><tt class="varname">[vorbis_floor_count]</tt> = read 6 bits as unsigned integer and add one</li><li><p>For each <tt class="varname">[i]</tt> of <tt class="varname">[vorbis_floor_count]</tt> floor numbers:
- </p><div class="orderedlist"><ol type="a"><li>read the floor type: vector <tt class="varname">[vorbis_floor_types]</tt> element <tt class="varname">[i]</tt> =
-read 16 bits as unsigned integer</li><li>If the floor type is zero, decode the floor
-configuration as defined in <a href="#vorbis-spec-floor0" title="6. Floor type 0 setup and decode">Section 6, “Floor type 0 setup and decode”</a>; save
-this
-configuration in slot <tt class="varname">[i]</tt> of the floor configuration array <tt class="varname">[vorbis_floor_configurations]</tt>.</li><li>If the floor type is one,
-decode the floor configuration as defined in <a href="#vorbis-spec-floor1" title="7. Floor type 1 setup and decode">Section 7, “Floor type 1 setup and decode”</a>; save this configuration in slot <tt class="varname">[i]</tt> of the floor configuration array <tt class="varname">[vorbis_floor_configurations]</tt>.</li><li>If the the floor type is greater than one, this stream is undecodable; ERROR CONDITION</li></ol></div><p>
- </p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4710523"></a>4.2.4.4. Residues</h5></div></div></div><p>
-Vorbis uses three residue types; header decode of each type is identical.
-</p><div class="orderedlist"><ol type="1"><li><tt class="varname">[vorbis_residue_count]</tt> = read 6 bits as unsigned integer and add one
-</li><li><p>For each of <tt class="varname">[vorbis_residue_count]</tt> residue numbers:
- </p><div class="orderedlist"><ol type="a"><li>read the residue type; vector <tt class="varname">[vorbis_residue_types]</tt> element <tt class="varname">[i]</tt> = read 16 bits as unsigned integer</li><li>If the residue type is zero,
-one or two, decode the residue configuration as defined in <a href="#vorbis-spec-residue" title="8. Residue setup and decode">Section 8, “Residue setup and decode”</a>; save this configuration in slot <tt class="varname">[i]</tt> of the residue configuration array <tt class="varname">[vorbis_residue_configurations]</tt>.</li><li>If the the residue type is greater than two, this stream is undecodable; ERROR CONDITION</li></ol></div><p>
-</p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4710587"></a>4.2.4.5. Mappings</h5></div></div></div><p>
-Mappings are used to set up specific pipelines for encoding
-multichannel audio with varying channel mapping applications. Vorbis I
-uses a single mapping type (0), with implicit PCM channel mappings.</p><div class="orderedlist"><ol type="1"><li><tt class="varname">[vorbis_mapping_count]</tt> = read 6 bits as unsigned integer and add one</li><li><p>For each <tt class="varname">[i]</tt> of <tt class="varname">[vorbis_mapping_count]</tt> mapping numbers:
- </p><div class="orderedlist"><ol type="a"><li>read the mapping type: 16 bits as unsigned integer. There's no reason to save the mapping type in Vorbis I.</li><li>If the mapping type is nonzero, the stream is undecodable</li><li><p>If the mapping type is zero:
- </p><div class="orderedlist"><ol type="i"><li><p>read 1 bit as a boolean flag
- </p><div class="orderedlist"><ol type="A"><li>if set, <tt class="varname">[vorbis_mapping_submaps]</tt> = read 4 bits as unsigned integer and add one</li><li>if unset, <tt class="varname">[vorbis_mapping_submaps]</tt> = 1</li></ol></div><p>
- </p></li><li><p>read 1 bit as a boolean flag
- </p><div class="orderedlist"><ol type="A"><li><p>if set, square polar channel mapping is in use:
- </p><div class="orderedlist"><ol type="I"><li><tt class="varname">[vorbis_mapping_coupling_steps]</tt> = read 8 bits as unsigned integer and add one</li><li><p>for <tt class="varname">[j]</tt> each of <tt class="varname">[vorbis_mapping_coupling_steps]</tt> steps:
- </p><div class="orderedlist"><ol type="1"><li>vector <tt class="varname">[vorbis_mapping_magnitude]</tt> element <tt class="varname">[j]</tt>= read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>(<tt class="varname">[audio_channels]</tt> - 1) bits as unsigned integer</li><li>vector <tt class="varname">[vorbis_mapping_angle]</tt> element <tt class="varname">[j]</tt>= read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>(<tt class="varname">[audio_channels]</tt> - 1) bits as unsigned integer</li><li>the numbers read in the above two steps are channel numbers representing the channel to treat as magnitude and the channel to treat as angle, respectively. If for any coupling step the angle channel number equals the magnitude channel number, the magnitude channel number is greater than <tt class="varname">[audio_channels]</tt>-1, or the angle channel is greater than <tt class="varname">[audio_channels]</tt>-1, the stream is undecodable.</li></ol></
div><p>
- </p></li></ol></div><p>
- </p></li><li>if unset, <tt class="varname">[vorbis_mapping_coupling_steps]</tt> = 0</li></ol></div><p>
- </p></li><li>read 2 bits (reserved field); if the value is nonzero, the stream is undecodable</li><li><p>if <tt class="varname">[vorbis_mapping_submaps]</tt> is greater than one, we read channel multiplex settings. For each <tt class="varname">[j]</tt> of <tt class="varname">[audio_channels]</tt> channels:</p><div class="orderedlist"><ol type="A"><li>vector <tt class="varname">[vorbis_mapping_mux]</tt> element <tt class="varname">[j]</tt> = read 4 bits as unsigned integer</li><li>if the value is greater than the highest numbered submap (<tt class="varname">[vorbis_mapping_submaps]</tt> - 1), this in an error condition rendering the stream undecodable</li></ol></div></li><li><p>for each submap <tt class="varname">[j]</tt> of <tt class="varname">[vorbis_mapping_submaps]</tt> submaps, read the floor and residue numbers for use in decoding that submap:</p><div class="orderedlist"><ol type="A"><li>read and discard 8 bits (the unused time configuration placeholder)</li><li>
read 8 bits as unsigned integer for the floor number; save in vector <tt class="varname">[vorbis_mapping_submap_floor]</tt> element <tt class="varname">[j]</tt></li><li>verify the floor number is not greater than the highest number floor configured for the bitstream. If it is, the bitstream is undecodable</li><li>read 8 bits as unsigned integer for the residue number; save in vector <tt class="varname">[vorbis_mapping_submap_residue]</tt> element <tt class="varname">[j]</tt></li><li>verify the residue number is not greater than the highest number residue configured for the bitstream. If it is, the bitstream is undecodable</li></ol></div></li><li>save this mapping configuration in slot <tt class="varname">[i]</tt> of the mapping configuration array <tt class="varname">[vorbis_mapping_configurations]</tt>.</li></ol></div></li></ol></div><p>
- </p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4774345"></a>4.2.4.6. Modes</h5></div></div></div><div class="orderedlist"><ol type="1"><li><tt class="varname">[vorbis_mode_count]</tt> = read 6 bits as unsigned integer and add one</li><li><p>For each of <tt class="varname">[vorbis_mode_count]</tt> mode numbers:</p><div class="orderedlist"><ol type="a"><li><tt class="varname">[vorbis_mode_blockflag]</tt> = read 1 bit</li><li><tt class="varname">[vorbis_mode_windowtype]</tt> = read 16 bits as unsigned integer</li><li><tt class="varname">[vorbis_mode_transformtype]</tt> = read 16 bits as unsigned integer</li><li><tt class="varname">[vorbis_mode_mapping]</tt> = read 8 bits as unsigned integer</li><li>verify ranges; zero is the only legal value in Vorbis I for
-<tt class="varname">[vorbis_mode_windowtype]</tt>
-and <tt class="varname">[vorbis_mode_transformtype]</tt>. <tt class="varname">[vorbis_mode_mapping]</tt> must not be greater than the highest number mapping in use. Any illegal values render the stream undecodable.</li><li>save this mode configuration in slot <tt class="varname">[i]</tt> of the mode configuration array
-<tt class="varname">[vorbis_mode_configurations]</tt>.</li></ol></div></li><li>read 1 bit as a framing flag. If unset, a framing error occurred and the stream is not
-decodable.</li></ol></div><p>
-After reading mode descriptions, setup header decode is complete.
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4774443"></a>4.3. Audio packet decode and synthesis</h3></div></div></div><p>
-Following the three header packets, all packets in a Vorbis I stream
-are audio. The first step of audio packet decode is to read and
-verify the packet type. <span class="emphasis"><em>A non-audio packet when audio is expected
-indicates stream corruption or a non-compliant stream. The decoder
-must ignore the packet and not attempt decoding it to audio</em></span>.
-</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4774461"></a>4.3.1. packet type, mode and window decode</h4></div></div></div><div class="orderedlist"><ol type="1"><li>read 1 bit <tt class="varname">[packet_type]</tt>; check that packet type is 0 (audio)</li><li>read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>([vorbis_mode_count]-1) bits
-<tt class="varname">[mode_number]</tt></li><li>decode blocksize <tt class="varname">[n]</tt> is equal to <tt class="varname">[blocksize_0]</tt> if
-<tt class="varname">[vorbis_mode_blockflag]</tt> is 0, else <tt class="varname">[n]</tt> is equal to <tt class="varname">[blocksize_1]</tt>.</li><li><p>perform window selection and setup; this window is used later by the inverse MDCT:</p><div class="orderedlist"><ol type="a"><li><p>if this is a long window (the <tt class="varname">[vorbis_mode_blockflag]</tt> flag of this mode is
-set):</p><div class="orderedlist"><ol type="i"><li>read 1 bit for <tt class="varname">[previous_window_flag]</tt></li><li>read 1 bit for <tt class="varname">[next_window_flag]</tt></li><li>if <tt class="varname">[previous_window_flag]</tt> is not set, the left half
- of the window will be a hybrid window for lapping with a
- short block. See <a href="#vorbis-spec-window" title="1.3.2.3. Window shape decode (long windows only)">Section 1.3.2.3, “Window shape decode (long windows only)”</a> for an illustration of overlapping
-dissimilar
- windows. Else, the left half window will have normal long
- shape.</li><li>if <tt class="varname">[next_window_flag]</tt> is not set, the right half of
- the window will be a hybrid window for lapping with a short
- block. See <a href="#vorbis-spec-window" title="1.3.2.3. Window shape decode (long windows only)">Section 1.3.2.3, “Window shape decode (long windows only)”</a> for an
-illustration of overlapping dissimilar
- windows. Else, the left right window will have normal long
- shape.</li></ol></div></li><li> if this is a short window, the window is always the same
- short-window shape.</li></ol></div></li></ol></div><p>
-Vorbis windows all use the slope function y=sin(0.5 * π * sin^2((x+.5)/n * π)),
-where n is window size and x ranges 0...n-1, but dissimilar
-lapping requirements can affect overall shape. Window generation
-proceeds as follows:</p><div class="orderedlist"><ol type="1"><li> <tt class="varname">[window_center]</tt> = <tt class="varname">[n]</tt> / 2</li><li><p> if (<tt class="varname">[vorbis_mode_blockflag]</tt> is set and <tt class="varname">[previous_window_flag]</tt> is
-not set) then
- </p><div class="orderedlist"><ol type="a"><li><tt class="varname">[left_window_start]</tt> = <tt class="varname">[n]</tt>/4 -
-<tt class="varname">[blocksize_0]</tt>/4</li><li><tt class="varname">[left_window_end]</tt> = <tt class="varname">[n]</tt>/4 + <tt class="varname">[blocksize_0]</tt>/4</li><li><tt class="varname">[left_n]</tt> = <tt class="varname">[blocksize_0]</tt>/2</li></ol></div><p>
- else
- </p><div class="orderedlist"><ol type="a"><li><tt class="varname">[left_window_start]</tt> = 0</li><li><tt class="varname">[left_window_end]</tt> = <tt class="varname">[window_center]</tt></li><li><tt class="varname">[left_n]</tt> = <tt class="varname">[n]</tt>/2</li></ol></div></li><li><p> if (<tt class="varname">[vorbis_mode_blockflag]</tt> is set and <tt class="varname">[next_window_flag]</tt> is not
-set) then
- </p><div class="orderedlist"><ol type="a"><li><tt class="varname">[right_window_start]</tt> = <tt class="varname">[n]*3</tt>/4 -
-<tt class="varname">[blocksize_0]</tt>/4</li><li><tt class="varname">[right_window_end]</tt> = <tt class="varname">[n]*3</tt>/4 +
-<tt class="varname">[blocksize_0]</tt>/4</li><li><tt class="varname">[right_n]</tt> = <tt class="varname">[blocksize_0]</tt>/2</li></ol></div><p>
- else
- </p><div class="orderedlist"><ol type="a"><li><tt class="varname">[right_window_start]</tt> = <tt class="varname">[window_center]</tt></li><li><tt class="varname">[right_window_end]</tt> = <tt class="varname">[n]</tt></li><li><tt class="varname">[right_n]</tt> = <tt class="varname">[n]</tt>/2</li></ol></div></li><li> window from range 0 ... <tt class="varname">[left_window_start]</tt>-1 inclusive is zero</li><li> for <tt class="varname">[i]</tt> in range <tt class="varname">[left_window_start]</tt> ...
-<tt class="varname">[left_window_end]</tt>-1, window(<tt class="varname">[i]</tt>) = sin(.5 * π * sin^2( (<tt class="varname">[i]</tt>-<tt class="varname">[left_window_start]</tt>+.5) / <tt class="varname">[left_n]</tt> * .5 * π) )</li><li> window from range <tt class="varname">[left_window_end]</tt> ... <tt class="varname">[right_window_start]</tt>-1
-inclusive is one</li><li> for <tt class="varname">[i]</tt> in range <tt class="varname">[right_window_start]</tt> ... <tt class="varname">[right_window_end]</tt>-1, window(<tt class="varname">[i]</tt>) = sin(.5 * π * sin^2( (<tt class="varname">[i]</tt>-<tt class="varname">[right_window_start]</tt>+.5) / <tt class="varname">[right_n]</tt> * .5 * π + .5 * π) )</li><li> window from range <tt class="varname">[right_window_start]</tt> ... <tt class="varname">[n]</tt>-1 is
-zero</li></ol></div><p>
-An end-of-packet condition up to this point should be considered an
-error that discards this packet from the stream. An end of packet
-condition past this point is to be considered a possible nominal
-occurrence.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4804463"></a>4.3.2. floor curve decode</h4></div></div></div><p>
-From this point on, we assume out decode context is using mode number
-<tt class="varname">[mode_number]</tt> from configuration array
-<tt class="varname">[vorbis_mode_configurations]</tt> and the map number
-<tt class="varname">[vorbis_mode_mapping]</tt> (specified by the current mode) taken
-from the mapping configuration array
-<tt class="varname">[vorbis_mapping_configurations]</tt>.</p><p>
-Floor curves are decoded one-by-one in channel order.</p><p>
-For each floor <tt class="varname">[i]</tt> of <tt class="varname">[audio_channels]</tt>
- </p><div class="orderedlist"><ol type="1"><li><tt class="varname">[submap_number]</tt> = element <tt class="varname">[i]</tt> of vector [vorbis_mapping_mux]</li><li><tt class="varname">[floor_number]</tt> = element <tt class="varname">[submap_number]</tt> of vector
-[vorbis_submap_floor]</li><li>if the floor type of this
-floor (vector <tt class="varname">[vorbis_floor_types]</tt> element
-<tt class="varname">[floor_number]</tt>) is zero then decode the floor for
-channel <tt class="varname">[i]</tt> according to the
-<a href="#vorbis-spec-floor0-decode" title="6.2.2. packet decode">Section 6.2.2, “packet decode”</a></li><li>if the type of this floor
-is one then decode the floor for channel <tt class="varname">[i]</tt> according
-to the <a href="#vorbis-spec-floor1-decode" title="7.2.2.1. packet decode">Section 7.2.2.1, “packet decode”</a></li><li>save the needed decoded floor information for channel for later synthesis</li><li>if the decoded floor returned 'unused', set vector <tt class="varname">[no_residue]</tt> element
-<tt class="varname">[i]</tt> to true, else set vector <tt class="varname">[no_residue]</tt> element <tt class="varname">[i]</tt> to
-false</li></ol></div><p>
-</p><p>
-An end-of-packet condition during floor decode shall result in packet
-decode zeroing all channel output vectors and skipping to the
-add/overlap output stage.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4804586"></a>4.3.3. nonzero vector propagate</h4></div></div></div><p>
-A possible result of floor decode is that a specific vector is marked
-'unused' which indicates that that final output vector is all-zero
-values (and the floor is zero). The residue for that vector is not
-coded in the stream, save for one complication. If some vectors are
-used and some are not, channel coupling could result in mixing a
-zeroed and nonzeroed vector to produce two nonzeroed vectors.</p><p>
-for each <tt class="varname">[i]</tt> from 0 ... <tt class="varname">[vorbis_mapping_coupling_steps]</tt>-1
-
-</p><div class="orderedlist"><ol type="1"><li>if either <tt class="varname">[no_residue]</tt> entry for channel
-(<tt class="varname">[vorbis_mapping_magnitude]</tt> element <tt class="varname">[i]</tt>)
-or channel
-(<tt class="varname">[vorbis_mapping_angle]</tt> element <tt class="varname">[i]</tt>)
-are set to false, then both must be set to false. Note that an 'unused'
-floor has no decoded floor information; it is important that this is
-remembered at floor curve synthesis time.</li></ol></div><p>
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4804639"></a>4.3.4. residue decode</h4></div></div></div><p>
-Unlike floors, which are decoded in channel order, the residue vectors
-are decoded in submap order.</p><p>
-for each submap <tt class="varname">[i]</tt> in order from 0 ... <tt class="varname">[vorbis_mapping_submaps]</tt>-1</p><div class="orderedlist"><ol type="1"><li><tt class="varname">[ch]</tt> = 0</li><li><p>for each channel <tt class="varname">[j]</tt> in order from 0 ... <tt class="varname">[audio_channels]</tt> - 1</p><div class="orderedlist"><ol type="a"><li><p>if channel <tt class="varname">[j]</tt> in submap <tt class="varname">[i]</tt> (vector <tt class="varname">[vorbis_mapping_mux]</tt> element <tt class="varname">[j]</tt> is equal to <tt class="varname">[i]</tt>)</p><div class="orderedlist"><ol type="i"><li><p>if vector <tt class="varname">[no_residue]</tt> element <tt class="varname">[j]</tt> is true
- </p><div class="orderedlist"><ol type="A"><li>vector <tt class="varname">[do_not_decode_flag]</tt> element <tt class="varname">[ch]</tt> is set</li></ol></div><p>
- else
- </p><div class="orderedlist"><ol type="A"><li>vector <tt class="varname">[do_not_decode_flag]</tt> element <tt class="varname">[ch]</tt> is unset</li></ol></div></li><li>increment <tt class="varname">[ch]</tt></li></ol></div></li></ol></div></li><li><tt class="varname">[residue_number]</tt> = vector <tt class="varname">[vorbis_mapping_submap_residue]</tt> element <tt class="varname">[i]</tt></li><li><tt class="varname">[residue_type]</tt> = vector <tt class="varname">[vorbis_residue_types]</tt> element <tt class="varname">[residue_number]</tt></li><li>decode <tt class="varname">[ch]</tt> vectors using residue <tt class="varname">[residue_number]</tt>, according to type <tt class="varname">[residue_type]</tt>, also passing vector <tt class="varname">[do_not_decode_flag]</tt> to indicate which vectors in the bundle should not be decoded. Correct per-vector decode length is <tt class="varname">[n]</tt>/2.</li><li><tt class="varname">[ch]</tt> = 0</li><li><p>for each chann
el <tt class="varname">[j]</tt> in order from 0 ... <tt class="varname">[audio_channels]</tt></p><div class="orderedlist"><ol type="a"><li><p>if channel <tt class="varname">[j]</tt> is in submap <tt class="varname">[i]</tt> (vector <tt class="varname">[vorbis_mapping_mux]</tt> element <tt class="varname">[j]</tt> is equal to <tt class="varname">[i]</tt>)</p><div class="orderedlist"><ol type="i"><li>residue vector for channel <tt class="varname">[j]</tt> is set to decoded residue vector <tt class="varname">[ch]</tt></li><li>increment <tt class="varname">[ch]</tt></li></ol></div></li></ol></div></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4804859"></a>4.3.5. inverse coupling</h4></div></div></div><p>
-for each <tt class="varname">[i]</tt> from <tt class="varname">[vorbis_mapping_coupling_steps]</tt>-1 descending to 0
-
-</p><div class="orderedlist"><ol type="1"><li><tt class="varname">[magnitude_vector]</tt> = the residue vector for channel
-(vector <tt class="varname">[vorbis_mapping_magnitude]</tt> element <tt class="varname">[i]</tt>)</li><li><tt class="varname">[angle_vector]</tt> = the residue vector for channel (vector
-<tt class="varname">[vorbis_mapping_angle]</tt> element <tt class="varname">[i]</tt>)</li><li><p>for each scalar value <tt class="varname">[M]</tt> in vector <tt class="varname">[magnitude_vector]</tt> and the corresponding scalar value <tt class="varname">[A]</tt> in vector <tt class="varname">[angle_vector]</tt>:</p><div class="orderedlist"><ol type="a"><li><p>if (<tt class="varname">[M]</tt> is greater than zero)
- </p><div class="orderedlist"><ol type="i"><li><p>if (<tt class="varname">[A]</tt> is greater than zero)
- </p><div class="orderedlist"><ol type="A"><li><tt class="varname">[new_M]</tt> = <tt class="varname">[M]</tt></li><li><tt class="varname">[new_A]</tt> = <tt class="varname">[M]</tt>-<tt class="varname">[A]</tt></li></ol></div><p>
- else
- </p><div class="orderedlist"><ol type="A"><li><tt class="varname">[new_A]</tt> = <tt class="varname">[M]</tt></li><li><tt class="varname">[new_M]</tt> = <tt class="varname">[M]</tt>+<tt class="varname">[A]</tt></li></ol></div><p>
- </p></li></ol></div><p>
- else
- </p><div class="orderedlist"><ol type="i"><li><p>if (<tt class="varname">[A]</tt> is greater than zero)
- </p><div class="orderedlist"><ol type="A"><li><tt class="varname">[new_M]</tt> = <tt class="varname">[M]</tt></li><li><tt class="varname">[new_A]</tt> = <tt class="varname">[M]</tt>+<tt class="varname">[A]</tt></li></ol></div><p>
- else
- </p><div class="orderedlist"><ol type="A"><li><tt class="varname">[new_A]</tt> = <tt class="varname">[M]</tt></li><li><tt class="varname">[new_M]</tt> = <tt class="varname">[M]</tt>-<tt class="varname">[A]</tt></li></ol></div><p>
- </p></li></ol></div><p>
- </p></li><li>set scalar value <tt class="varname">[M]</tt> in vector <tt class="varname">[magnitude_vector]</tt> to <tt class="varname">[new_M]</tt></li><li>set scalar value <tt class="varname">[A]</tt> in vector <tt class="varname">[angle_vector]</tt> to <tt class="varname">[new_A]</tt></li></ol></div></li></ol></div><p>
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4805077"></a>4.3.6. dot product</h4></div></div></div><p>
-For each channel, synthesize the floor curve from the decoded floor
-information, according to packet type. Note that the vector synthesis
-length for floor computation is <tt class="varname">[n]</tt>/2.</p><p>
-For each channel, multiply each element of the floor curve by each
-element of that channel's residue vector. The result is the dot
-product of the floor and residue vectors for each channel; the produced
-vectors are the length <tt class="varname">[n]</tt>/2 audio spectrum for each
-channel.</p><p>
-One point is worth mentioning about this dot product; a common mistake
-in a fixed point implementation might be to assume that a 32 bit
-fixed-point representation for floor and residue and direct
-multiplication of the vectors is sufficient for acceptable spectral
-depth in all cases because it happens to mostly work with the current
-Xiph.Org reference encoder. </p><p>
-However, floor vector values can span ~140dB (~24 bits unsigned), and
-the audio spectrum vector should represent a minimum of 120dB (~21
-bits with sign), even when output is to a 16 bit PCM device. For the
-residue vector to represent full scale if the floor is nailed to
--140dB, it must be able to span 0 to +140dB. For the residue vector
-to reach full scale if the floor is nailed at 0dB, it must be able to
-represent -140dB to +0dB. Thus, in order to handle full range
-dynamics, a residue vector may span -140dB to +140dB entirely within
-spec. A 280dB range is approximately 48 bits with sign; thus the
-residue vector must be able to represent a 48 bit range and the dot
-product must be able to handle an effective 48 bit times 24 bit
-multiplication. This range may be achieved using large (64 bit or
-larger) integers, or implementing a movable binary point
-representation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4794695"></a>4.3.7. inverse MDCT</h4></div></div></div><p>
-Convert the audio spectrum vector of each channel back into time
-domain PCM audio via an inverse Modified Discrete Cosine Transform
-(MDCT). A detailed description of the MDCT is available in the paper
-<a href="http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps" target="_top">“<span class="citetitle">The
-use of multirate filter banks for coding of high quality digital
-audio</span>”</a>, by T. Sporer, K. Brandenburg and B. Edler. The window
-function used for the MDCT is the function described earlier.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4802188"></a>4.3.8. overlap_add</h4></div></div></div><p>
-Windowed MDCT output is overlapped and added with the right hand data
-of the previous window such that the 3/4 point of the previous window
-is aligned with the 1/4 point of the current window (as illustrated in
-<a href="#vorbis-spec-window" title="1.3.2.3. Window shape decode (long windows only)">Section 1.3.2.3, “Window shape decode (long windows only)”</a>). The overlapped portion
-produced from overlapping the previous and current frame data is
-finished data to be returned by the decoder. This data spans from the
-center of the previous window to the center of the current window. In
-the case of same-sized windows, the amount of data to return is
-one-half block consisting of and only of the overlapped portions. When
-overlapping a short and long window, much of the returned range does not
-actually overlap. This does not damage transform orthogonality. Pay
-attention however to returning the correct data range; the amount of
-data to be returned is:
-
-</p><pre class="programlisting">
-window_blocksize(previous_window)/4+window_blocksize(current_window)/4
-</pre><p>
-
-from the center (element windowsize/2) of the previous window to the
-center (element windowsize/2-1, inclusive) of the current window.</p><p>
-Data is not returned from the first frame; it must be used to 'prime'
-the decode engine. The encoder accounts for this priming when
-calculating PCM offsets; after the first frame, the proper PCM output
-offset is '0' (as no data has been returned yet).</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4751373"></a>4.3.9. output channel order</h4></div></div></div><p>
-Vorbis I specifies only a channel mapping type 0. In mapping type 0,
-channel mapping is implicitly defined as follows for standard audio
-applications:</p><div class="variablelist"><dl><dt><span class="term">one channel</span></dt><dd>the stream is monophonic</dd><dt><span class="term">two channels</span></dt><dd>the stream is stereo. channel order: left, right</dd><dt><span class="term">three channels</span></dt><dd>the stream is a 1d-surround encoding. channel order: left,
-center, right</dd><dt><span class="term">four channels</span></dt><dd>the stream is quadraphonic surround. channel order: front left,
-front right, rear left, rear right</dd><dt><span class="term">five channels</span></dt><dd>the stream is five-channel surround. channel order: front left,
-front center, front right, rear left, rear right</dd><dt><span class="term">six channels</span></dt><dd>the stream is 5.1 surround. channel order: front left, front
-center, front right, rear left, rear right, LFE</dd><dt><span class="term">greater than six channels</span></dt><dd>channel use and order is defined by the application</dd></dl></div><p>
-Applications using Vorbis for dedicated purposes may define channel
-mapping as seen fit. Future channel mappings (such as three and four
-channel <a href="http://www.ambisonic.net/" target="_top">Ambisonics</a>) will
-make use of channel mappings other than mapping 0.</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-comment"></a>5. comment field and header specification</h2></div><div><p class="releaseinfo">
- $Id: 05-comment.xml 7186 2004-07-20 07:19:25Z xiphmont $
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4793333"></a>5.1. Overview</h3></div></div></div><p>The Vorbis text comment header is the second (of three) header
-packets that begin a Vorbis bitstream. It is meant for short text
-comments, not arbitrary metadata; arbitrary metadata belongs in a
-separate logical bitstream (usually an XML stream type) that provides
-greater structure and machine parseability.</p><p>The comment field is meant to be used much like someone jotting a
-quick note on the bottom of a CDR. It should be a little information to
-remember the disc by and explain it to others; a short, to-the-point
-text note that need not only be a couple words, but isn't going to be
-more than a short paragraph. The essentials, in other words, whatever
-they turn out to be, eg:
-
-</p><div class="blockquote"><blockquote class="blockquote"><p>Honest Bob and the Factory-to-Dealer-Incentives, <i class="citetitle">I'm Still
-Around</i>, opening for Moxy Früvous, 1997.</p></blockquote></div><p>
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4793366"></a>5.2. Comment encoding</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4793370"></a>5.2.1. Structure</h4></div></div></div><p>
-The comment header is logically a list of eight-bit-clean vectors; the
-number of vectors is bounded to 2^32-1 and the length of each vector
-is limited to 2^32-1 bytes. The vector length is encoded; the vector
-contents themselves are not null terminated. In addition to the vector
-list, there is a single vector for vendor name (also 8 bit clean,
-length encoded in 32 bits). The 1.0 release of libvorbis sets the
-vendor string to "Xiph.Org libVorbis I 20020717".</p><p>The comment header is decoded as follows:
-
-</p><pre class="programlisting">
- 1) [vendor_length] = read an unsigned integer of 32 bits
- 2) [vendor_string] = read a UTF-8 vector as [vendor_length] octets
- 3) [user_comment_list_length] = read an unsigned integer of 32 bits
- 4) iterate [user_comment_list_length] times {
- 5) [length] = read an unsigned integer of 32 bits
- 6) this iteration's user comment = read a UTF-8 vector as [length] octets
- }
- 7) [framing_bit] = read a single bit as boolean
- 8) if ( [framing_bit] unset or end-of-packet ) then ERROR
- 9) done.
-</pre><p>
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4784291"></a>5.2.2. Content vector format</h4></div></div></div><p>
-The comment vectors are structured similarly to a UNIX environment variable.
-That is, comment fields consist of a field name and a corresponding value and
-look like:</p><div class="blockquote"><blockquote class="blockquote"><pre class="programlisting">
-comment[0]="ARTIST=me";
-comment[1]="TITLE=the sound of Vorbis";
-</pre></blockquote></div><p>
-The field name is case-insensitive and may consist of ASCII 0x20
-through 0x7D, 0x3D ('=') excluded. ASCII 0x41 through 0x5A inclusive
-(characters A-Z) is to be considered equivalent to ASCII 0x61 through
-0x7A inclusive (characters a-z).
-</p><p>
-The field name is immediately followed by ASCII 0x3D ('=');
-this equals sign is used to terminate the field name.
-</p><p>
-0x3D is followed by 8 bit clean UTF-8 encoded value of the
-field contents to the end of the field.
-</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4802194"></a>5.2.2.1. Field names</h5></div></div></div><p>Below is a proposed, minimal list of standard field names with a
-description of intended use. No single or group of field names is
-mandatory; a comment header may contain one, all or none of the names
-in this list.</p><div class="variablelist"><dl><dt><span class="term">TITLE</span></dt><dd>Track/Work name</dd><dt><span class="term">VERSION</span></dt><dd>The version field may be used to
-differentiate multiple
-versions of the same track title in a single collection. (e.g. remix
-info)
-</dd><dt><span class="term">ALBUM</span></dt><dd>The collection name to which this track belongs
-</dd><dt><span class="term">TRACKNUMBER</span></dt><dd>The track number of this piece if part of a specific larger collection or album
-</dd><dt><span class="term">ARTIST</span></dt><dd>The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text.
-</dd><dt><span class="term">PERFORMER</span></dt><dd>The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the ARTIST and is omitted.
-</dd><dt><span class="term">COPYRIGHT</span></dt><dd>Copyright attribution, e.g., '2001 Nobody's Band' or '1999 Jack Moffitt'
-</dd><dt><span class="term">LICENSE</span></dt><dd>License information, eg, 'All Rights Reserved', 'Any
-Use Permitted', a URL to a license such as a Creative Commons license
-("www.creativecommons.org/blahblah/license.html") or the EFF Open
-Audio License ('distributed under the terms of the Open Audio
-License. see http://www.eff.org/IP/Open_licenses/eff_oal.html for
-details'), etc.
-</dd><dt><span class="term">ORGANIZATION</span></dt><dd>Name of the organization producing the track (i.e.
-the 'record label')
-</dd><dt><span class="term">DESCRIPTION</span></dt><dd>A short text description of the contents
-</dd><dt><span class="term">GENRE</span></dt><dd>A short text indication of music genre
-</dd><dt><span class="term">DATE</span></dt><dd>Date the track was recorded
-</dd><dt><span class="term">LOCATION</span></dt><dd>Location where track was recorded
-</dd><dt><span class="term">CONTACT</span></dt><dd>Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label.
-</dd><dt><span class="term">ISRC</span></dt><dd>International Standard Recording Code for the
-track; see <a href="http://www.ifpi.org/site-content/online/isrc_intro.html" target="_top">the ISRC
-intro page</a> for more information on ISRC numbers.
-</dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id4802603"></a>5.2.2.2. Implications</h5></div></div></div><p>Field names should not be 'internationalized'; this is a
-concession to simplicity not an attempt to exclude the majority of
-the world that doesn't speak English. Field <span class="emphasis"><em>contents</em></span>
-however, use the UTF-8 character encoding to allow easy representation of any
-language.</p><p>We have the length of the entirety of the field and restrictions on
-the field name so that the field name is bounded in a known way. Thus
-we also have the length of the field contents.</p><p>Individual 'vendors' may use non-standard field names within
-reason. The proper use of comment fields should be clear through
-context at this point. Abuse will be discouraged.</p><p>There is no vendor-specific prefix to 'nonstandard' field names.
-Vendors should make some effort to avoid arbitrarily polluting the
-common namespace. We will generally collect the more useful tags
-here to help with standardization.</p><p>Field names are not required to be unique (occur once) within a
-comment header. As an example, assume a track was recorded by three
-well know artists; the following is permissible, and encouraged:
-
-</p><div class="blockquote"><blockquote class="blockquote"><pre class="programlisting">
-ARTIST=Dizzy Gillespie
-ARTIST=Sonny Rollins
-ARTIST=Sonny Stitt
-</pre></blockquote></div><p>
-
-</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4802653"></a>5.2.3. Encoding</h4></div></div></div><p>
-The comment header comprises the entirety of the second bitstream
-header packet. Unlike the first bitstream header packet, it is not
-generally the only packet on the second page and may not be restricted
-to within the second bitstream page. The length of the comment header
-packet is (practically) unbounded. The comment header packet is not
-optional; it must be present in the bitstream even if it is
-effectively empty.</p><p>
-The comment header is encoded as follows (as per Ogg's standard
-bitstream mapping which renders least-significant-bit of the word to be
-coded into the least significant available bit of the current
-bitstream octet first):
-
-</p><div class="orderedlist"><ol type="1"><li>
- Vendor string length (32 bit unsigned quantity specifying number of octets)
- </li><li>
- Vendor string ([vendor string length] octets coded from beginning of string to end of string, not null terminated)
- </li><li>
- Number of comment fields (32 bit unsigned quantity specifying number of fields)
- </li><li>
- Comment field 0 length (if [Number of comment fields]>0; 32 bit unsigned quantity specifying number of octets)
- </li><li>
- Comment field 0 ([Comment field 0 length] octets coded from beginning of string to end of string, not null terminated)
- </li><li>
- Comment field 1 length (if [Number of comment fields]>1...)...
- </li></ol></div><p>
-</p><p>
-This is actually somewhat easier to describe in code; implementation of the above can be found in <tt class="filename">vorbis/lib/info.c</tt>, <tt class="function">_vorbis_pack_comment()</tt> and <tt class="function">_vorbis_unpack_comment()</tt>.
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-floor0"></a>6. Floor type 0 setup and decode</h2></div><div><p class="releaseinfo">
- $Id: 06-floor0.xml 8547 2004-12-29 03:33:51Z giles $
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4796889"></a>6.1. Overview</h3></div></div></div><p>
-Vorbis floor type zero uses Line Spectral Pair (LSP, also alternately
-known as Line Spectral Frequency or LSF) representation to encode a
-smooth spectral envelope curve as the frequency response of the LSP
-filter. This representation is equivalent to a traditional all-pole
-infinite impulse response filter as would be used in linear predictive
-coding; LSP representation may be converted to LPC representation and
-vice-versa.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4789911"></a>6.2. Floor 0 format</h3></div></div></div><p>
-Floor zero configuration consists of six integer fields and a list of
-VQ codebooks for use in coding/decoding the LSP filter coefficient
-values used by each frame. </p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4763033"></a>6.2.1. header decode</h4></div></div></div><p>
-Configuration information for instances of floor zero decodes from the
-codec setup header (third packet). configuration decode proceeds as
-follows:</p><pre class="screen">
- 1) [floor0_order] = read an unsigned integer of 8 bits
- 2) [floor0_rate] = read an unsigned integer of 16 bits
- 3) [floor0_bark_map_size] = read an unsigned integer of 16 bits
- 4) [floor0_amplitude_bits] = read an unsigned integer of six bits
- 5) [floor0_amplitude_offset] = read an unsigned integer of eight bits
- 6) [floor0_number_of_books] = read an unsigned integer of four bits and add 1
- 7) if any of [floor0_order], [floor0_rate], [floor0_bark_map_size], [floor0_amplitude_bits],
- [floor0_amplitude_offset] or [floor0_number_of_books] are less than zero, the stream is not decodable
- 8) array [floor0_book_list] = read a list of [floor0_number_of_books] unsigned integers of eight bits each;
-</pre><p>
-An end-of-packet condition during any of these bitstream reads renders
-this stream undecodable. In addition, any element of the array
-<tt class="varname">[floor0_book_list]</tt> that is greater than the maximum codebook
-number for this bitstream is an error condition that also renders the
-stream undecodable.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-floor0-decode"></a>6.2.2. packet decode</h4></div></div></div><p>
-Extracting a floor0 curve from an audio packet consists of first
-decoding the curve amplitude and <tt class="varname">[floor0_order]</tt> LSP
-coefficient values from the bitstream, and then computing the floor
-curve, which is defined as the frequency response of the decoded LSP
-filter.</p><p>
-Packet decode proceeds as follows:</p><pre class="screen">
- 1) [amplitude] = read an unsigned integer of [floor0_amplitude_bits] bits
- 2) if ( [amplitude] is greater than zero ) {
- 3) [coefficients] is an empty, zero length vector
-
- 4) [booknumber] = read an unsigned integer of <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>( [floor0_number_of_books] ) bits
- 5) if ( [booknumber] is greater than the highest number decode codebook ) then packet is undecodable
- 6) [last] = zero;
- 7) vector [temp_vector] = read vector from bitstream using codebook number [booknumber] in VQ context.
- 8) add the scalar value [last] to each scalar in vector [temp_vector]
- 9) [last] = the value of the last scalar in vector [temp_vector]
- 10) concatenate [temp_vector] onto the end of the [coefficients] vector
- 11) if (length of vector [coefficients] is less than [floor0_order], continue at step 6
-
- }
-
- 12) done.
-
-</pre><p>
-Take note of the following properties of decode:
-</p><div class="itemizedlist"><ul type="disc"><li>An <tt class="varname">[amplitude]</tt> value of zero must result in a return code that indicates this channel is unused in this frame (the output of the channel will be all-zeroes in synthesis). Several later stages of decode don't occur for an unused channel.</li><li>An end-of-packet condition during decode should be considered a
-nominal occruence; if end-of-packet is reached during any read
-operation above, floor decode is to return 'unused' status as if the
-<tt class="varname">[amplitude]</tt> value had read zero at the beginning of decode.</li><li>The book number used for decode
-can, in fact, be stored in the bitstream in <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>( <tt class="varname">[floor0_number_of_books]</tt> -
-1 ) bits. Nevertheless, the above specification is correct and values
-greater than the maximum possible book value are reserved.</li><li>The number of scalars read into the vector <tt class="varname">[coefficients]</tt>
-may be greater than <tt class="varname">[floor0_order]</tt>, the number actually
-required for curve computation. For example, if the VQ codebook used
-for the floor currently being decoded has a
-<tt class="varname">[codebook_dimensions]</tt> value of three and
-<tt class="varname">[floor0_order]</tt> is ten, the only way to fill all the needed
-scalars in <tt class="varname">[coefficients]</tt> is to to read a total of twelve
-scalars as four vectors of three scalars each. This is not an error
-condition, and care must be taken not to allow a buffer overflow in
-decode. The extra values are not used and may be ignored or discarded.</li></ul></div><p>
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-floor0-synth"></a>6.2.3. curve computation</h4></div></div></div><p>
-Given an <tt class="varname">[amplitude]</tt> integer and <tt class="varname">[coefficients]</tt>
-vector from packet decode as well as the [floor0_order],
-[floor0_rate], [floor0_bark_map_size], [floor0_amplitude_bits] and
-[floor0_amplitude_offset] values from floor setup, and an output
-vector size <tt class="varname">[n]</tt> specified by the decode process, we compute a
-floor output vector.</p><p>
-If the value <tt class="varname">[amplitude]</tt> is zero, the return value is a
-length <tt class="varname">[n]</tt> vector with all-zero scalars. Otherwise, begin by
-assuming the following definitions for the given vector to be
-synthesized:</p><div class="informalequation"><div class="mediaobject"><img src="lspmap.png" alt="[lsp map equation]"></div></div><p>
-The above is used to synthesize the LSP curve on a Bark-scale frequency
-axis, then map the result to a linear-scale frequency axis.
-Similarly, the below calculation synthesizes the output LSP curve <tt class="varname">[output]</tt> on a log
-(dB) amplitude scale, mapping it to linear amplitude in the last step:</p><div class="orderedlist"><ol type="1"><li> <tt class="varname">[i]</tt> = 0 </li><li><p>if ( <tt class="varname">[floor0_order]</tt> is odd ) {
- </p><div class="orderedlist"><ol type="a"><li><p>calculate <tt class="varname">[p]</tt> and <tt class="varname">[q]</tt> according to:
- </p><div class="informalequation"><div class="mediaobject"><img src="oddlsp.png" alt="[equation for odd lsp]"></div></div><p>
- </p></li></ol></div><p>
- } else <tt class="varname">[floor0_order]</tt> is even {
- </p><div class="orderedlist"><ol type="a"><li><p>calculate <tt class="varname">[p]</tt> and <tt class="varname">[q]</tt> according to:
- </p><div class="informalequation"><div class="mediaobject"><img src="evenlsp.png" alt="[equation for even lsp]"></div></div><p>
- </p></li></ol></div><p>
- }
- </p></li><li><p>calculate <tt class="varname">[linear_floor_value]</tt> according to:
- </p><div class="informalequation"><div class="mediaobject"><img src="floorval.png" alt="[expression for floorval]"></div></div><p>
- </p></li><li><tt class="varname">[iteration_condition]</tt> = map element <tt class="varname">[i]</tt></li><li><tt class="varname">[output]</tt> element <tt class="varname">[i]</tt> = <tt class="varname">[linear_floor_value]</tt></li><li>increment <tt class="varname">[i]</tt></li><li>if ( map element <tt class="varname">[i]</tt> is equal to <tt class="varname">[iteration_condition]</tt> ) continue at step 5</li><li>if ( <tt class="varname">[i]</tt> is less than <tt class="varname">[n]</tt> ) continue at step 2</li><li>done</li></ol></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-floor1"></a>7. Floor type 1 setup and decode</h2></div><div><p class="releaseinfo">
- $Id: 07-floor1.xml 7186 2004-07-20 07:19:25Z xiphmont $
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4774521"></a>7.1. Overview</h3></div></div></div><p>
-Vorbis floor type one uses a piecewise straight-line representation to
-encode a spectral envelope curve. The representation plots this curve
-mechanically on a linear frequency axis and a logarithmic (dB)
-amplitude axis. The integer plotting algorithm used is similar to
-Bresenham's algorithm.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4801336"></a>7.2. Floor 1 format</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4788828"></a>7.2.1. model</h4></div></div></div><p>
-Floor type one represents a spectral curve as a series of
-line segments. Synthesis constructs a floor curve using iterative
-prediction in a process roughly equivalent to the following simplified
-description:</p><div class="itemizedlist"><ul type="disc"><li> the first line segment (base case) is a logical line spanning
-from x_0,y_0 to x_1,y_1 where in the base case x_0=0 and x_1=[n], the
-full range of the spectral floor to be computed.</li><li>the induction step chooses a point x_new within an existing
-logical line segment and produces a y_new value at that point computed
-from the existing line's y value at x_new (as plotted by the line) and
-a difference value decoded from the bitstream packet.</li><li>floor computation produces two new line segments, one running from
-x_0,y_0 to x_new,y_new and from x_new,y_new to x_1,y_1. This step is
-performed logically even if y_new represents no change to the
-amplitude value at x_new so that later refinement is additionally
-bounded at x_new.</li><li>the induction step repeats, using a list of x values specified in
-the codec setup header at floor 1 initialization time. Computation
-is completed at the end of the x value list.</li></ul></div><p>
-Consider the following example, with values chosen for ease of
-understanding rather than representing typical configuration:</p><p>
-For the below example, we assume a floor setup with an [n] of 128.
-The list of selected X values in increasing order is
-0,16,32,48,64,80,96,112 and 128. In list order, the values interleave
-as 0, 128, 64, 32, 96, 16, 48, 80 and 112. The corresponding
-list-order Y values as decoded from an example packet are 110, 20, -5,
--45, 0, -25, -10, 30 and -10. We compute the floor in the following
-way, beginning with the first line:</p><div class="mediaobject"><img src="floor1-1.png" alt="[graph of example floor]"></div><p>
-We now draw new logical lines to reflect the correction to new_Y, and
-iterate for X positions 32 and 96:</p><div class="mediaobject"><img src="floor1-2.png" alt="[graph of example floor]"></div><p>
-Although the new Y value at X position 96 is unchanged, it is still
-used later as an endpoint for further refinement. From here on, the
-pattern should be clear; we complete the floor computation as follows:</p><div class="mediaobject"><img src="floor1-3.png" alt="[graph of example floor]"></div><div class="mediaobject"><img src="floor1-4.png" alt="[graph of example floor]"></div><p>
-A more efficient algorithm with carefully defined integer rounding
-behavior is used for actual decode, as described later. The actual
-algorithm splits Y value computation and line plotting into two steps
-with modifications to the above algorithm to eliminate noise
-accumulation through integer roundoff/truncation. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4802957"></a>7.2.2. header decode</h4></div></div></div><p>
-A list of floor X values is stored in the packet header in interleaved
-format (used in list order during packet decode and synthesis). This
-list is split into partitions, and each partition is assigned to a
-partition class. X positions 0 and [n] are implicit and do not belong
-to an explicit partition or partition class.</p><p>
-A partition class consists of a representation vector width (the
-number of Y values which the partition class encodes at once), a
-'subclass' value representing the number of alternate entropy books
-the partition class may use in representing Y values, the list of
-[subclass] books and a master book used to encode which alternate
-books were chosen for representation in a given packet. The
-master/subclass mechanism is meant to be used as a flexible
-representation cascade while still using codebooks only in a scalar
-context.</p><pre class="screen">
-
- 1) [floor1_partitions] = read 5 bits as unsigned integer
- 2) [maximum_class] = -1
- 3) iterate [i] over the range 0 ... [floor1_partitions]-1 {
-
- 4) vector [floor1_partition_class_list] element [i] = read 4 bits as unsigned integer
-
- }
-
- 5) [maximum_class] = largest integer scalar value in vector [floor1_partition_class_list]
- 6) iterate [i] over the range 0 ... [maximum_class] {
-
- 7) vector [floor1_class_dimensions] element [i] = read 3 bits as unsigned integer and add 1
- 8) vector [floor1_class_subclasses] element [i] = read 2 bits as unsigned integer
- 9) if ( vector [floor1_class_subclasses] element [i] is nonzero ) {
-
- 10) vector [floor1_class_masterbooks] element [i] = read 8 bits as unsigned integer
-
- }
-
- 11) iterate [j] over the range 0 ... (2 exponent [floor1_class_subclasses] element [i]) - 1 {
-
- 12) array [floor1_subclass_books] element [i],[j] =
- read 8 bits as unsigned integer and subtract one
- }
- }
-
- 13) [floor1_multiplier] = read 2 bits as unsigned integer and add one
- 14) [rangebits] = read 4 bits as unsigned integer
- 15) vector [floor1_X_list] element [0] = 0
- 16) vector [floor1_X_list] element [1] = 2 exponent [rangebits];
- 17) [floor1_values] = 2
- 18) iterate [i] over the range 0 ... [floor1_partitions]-1 {
-
- 19) [current_class_number] = vector [floor1_partition_class_list] element [i]
- 20) iterate [j] over the range 0 ... ([floor1_class_dimensions] element [current_class_number])-1 {
- 21) vector [floor1_X_list] element ([j] + [floor1_values]) =
- read [rangebits] bits as unsigned integer
- 22) increment [floor1_values] by one
- }
- }
-
- 23) done
-</pre><p>
-An end-of-packet condition while reading any aspect of a floor 1
-configuration during setup renders a stream undecodable. In
-addition, a <tt class="varname">[floor1_class_masterbooks]</tt> or
-<tt class="varname">[floor1_subclass_books]</tt> scalar element greater than the
-highest numbered codebook configured in this stream is an error
-condition that renders the stream undecodable.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-floor1-decode"></a>7.2.2.1. packet decode</h5></div></div></div><p>
-Packet decode begins by checking the <tt class="varname">[nonzero]</tt> flag:</p><pre class="screen">
- 1) [nonzero] = read 1 bit as boolean
-</pre><p>
-If <tt class="varname">[nonzero]</tt> is unset, that indicates this channel contained
-no audio energy in this frame. Decode immediately returns a status
-indicating this floor curve (and thus this channel) is unused this
-frame. (A return status of 'unused' is different from decoding a
-floor that has all points set to minimum representation amplitude,
-which happens to be approximately -140dB).
-</p><p>
-Assuming <tt class="varname">[nonzero]</tt> is set, decode proceeds as follows:</p><pre class="screen">
- 1) [range] = vector { 256, 128, 86, 64 } element ([floor1_multiplier]-1)
- 2) vector [floor1_Y] element [0] = read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>([range]-1) bits as unsigned integer
- 3) vector [floor1_Y] element [1] = read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>([range]-1) bits as unsigned integer
- 4) [offset] = 2;
- 5) iterate [i] over the range 0 ... [floor1_partitions]-1 {
-
- 6) [class] = vector [floor1_partition_class] element [i]
- 7) [cdim] = vector [floor1_class_dimensions] element [class]
- 8) [cbits] = vector [floor1_class_subclasses] element [class]
- 9) [csub] = (2 exponent [cbits])-1
- 10) [cval] = 0
- 11) if ( [cbits] is greater than zero ) {
-
- 12) [cval] = read from packet using codebook number
- (vector [floor1_class_masterbooks] element [class]) in scalar context
- }
-
- 13) iterate [j] over the range 0 ... [cdim]-1 {
-
- 14) [book] = array [floor1_subclass_books] element [class],([cval] bitwise AND [csub])
- 15) [cval] = [cval] right shifted [cbits] bits
- 16) if ( [book] is not less than zero ) {
-
- 17) vector [floor1_Y] element ([j]+[offset]) = read from packet using codebook
- [book] in scalar context
-
- } else [book] is less than zero {
-
- 18) vector [floor1_Y] element ([j]+[offset]) = 0
-
- }
- }
-
- 19) [offset] = [offset] + [cdim]
-
- }
-
- 20) done
-</pre><p>
-An end-of-packet condition during curve decode should be considered a
-nominal occurrence; if end-of-packet is reached during any read
-operation above, floor decode is to return 'unused' status as if the
-<tt class="varname">[nonzero]</tt> flag had been unset at the beginning of decode.
-</p><p>
-Vector <tt class="varname">[floor1_Y]</tt> contains the values from packet decode
-needed for floor 1 synthesis.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-floor1-synth"></a>7.2.2.2. curve computation</h5></div></div></div><p>
-Curve computation is split into two logical steps; the first step
-derives final Y amplitude values from the encoded, wrapped difference
-values taken from the bitstream. The second step plots the curve
-lines. Also, although zero-difference values are used in the
-iterative prediction to find final Y values, these points are
-conditionally skipped during final line computation in step two.
-Skipping zero-difference values allows a smoother line fit. </p><p>
-Although some aspects of the below algorithm look like inconsequential
-optimizations, implementors are warned to follow the details closely.
-Deviation from implementing a strictly equivalent algorithm can result
-in serious decoding errors.</p><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id4750303"></a>7.2.2.2.1. step 1: amplitude value synthesis</h6></div></div></div><p>
-Unwrap the always-positive-or-zero values read from the packet into
-+/- difference values, then apply to line prediction.</p><pre class="screen">
- 1) [range] = vector { 256, 128, 86, 64 } element ([floor1_multiplier]-1)
- 2) vector [floor1_step2_flag] element [0] = set
- 3) vector [floor1_step2_flag] element [1] = set
- 4) vector [floor1_final_Y] element [0] = vector [floor1_Y] element [0]
- 5) vector [floor1_final_Y] element [1] = vector [floor1_Y] element [1]
- 6) iterate [i] over the range 2 ... [floor1_values]-1 {
-
- 7) [low_neighbor_offset] = <a href="#vorbis-spec-low_neighbor" title="9.2.4. low_neighbor">low_neighbor</a>([floor1_X_list],[i])
- 8) [high_neighbor_offset] = <a href="#vorbis-spec-high_neighbor" title="9.2.4.1. high_neighbor">high_neighbor</a>([floor1_X_list],[i])
-
- 9) [predicted] = <a href="#vorbis-spec-render_point" title="9.2.4.2. render_point">render_point</a>( vector [floor1_X_list] element [low_neighbor_offset],
- vector [floor1_final_Y] element [low_neighbor_offset],
- vector [floor1_X_list] element [high_neighbor_offset],
- vector [floor1_final_Y] element [high_neighbor_offset],
- vector [floor1_X_list] element [i] )
-
- 10) [val] = vector [floor1_Y] element [i]
- 11) [highroom] = [range] - [predicted]
- 12) [lowroom] = [predicted]
- 13) if ( [highroom] is less than [lowroom] ) {
-
- 14) [room] = [highroom] * 2
-
- } else [highroom] is not less than [lowroom] {
-
- 15) [root] = [lowroom] * 2
-
- }
-
- 16) if ( [val] is nonzero ) {
-
- 17) vector [floor1_step2_flag] element [low_neighbor_offset] = set
- 18) vector [floor1_step2_flag] element [high_neighbor_offset] = set
- 19) vector [floor1_step2_flag] element [i] = set
- 20) if ( [val] is greater than or equal to [room] ) {
-
- 21) if ( [highroom] is greater than [lowroom] ) {
-
- 22) vector [floor1_final_Y] element [i] = [val] - [lowroom] + [predicted]
-
- } else [highroom] is not greater than [lowroom] {
-
- 23) vector [floor1_final_Y] element [i] = [predicted] - [val] + [highroom] - 1
-
- }
-
- } else [val] is less than [room] {
-
- 24) if ([val] is odd) {
-
- 25) vector [floor1_final_Y] element [i] =
- [predicted] - (([val] + 1) divided by 2 using integer division)
-
- } else [val] is even {
-
- 26) vector [floor1_final_Y] element [i] =
- [predicted] + ([val] / 2 using integer division)
-
- }
-
- }
-
- } else [val] is zero {
-
- 27) vector [floor1_step2_flag] element [i] = unset
- 28) vector [floor1_final_Y] element [i] = [predicted]
-
- }
-
- }
-
- 29) done
-
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id4752640"></a>7.2.2.2.2. step 2: curve synthesis</h6></div></div></div><p>
-Curve synthesis generates a return vector <tt class="varname">[floor]</tt> of length
-<tt class="varname">[n]</tt> (where <tt class="varname">[n]</tt> is provided by the decode process
-calling to floor decode). Floor 1 curve synthesis makes use of the
-<tt class="varname">[floor1_X_list]</tt>, <tt class="varname">[floor1_final_Y]</tt> and
-<tt class="varname">[floor1_step2_flag]</tt> vectors, as well as [floor1_multiplier]
-and [floor1_values] values.</p><p>
-Decode begins by sorting the scalars from vectors
-<tt class="varname">[floor1_X_list]</tt>, <tt class="varname">[floor1_final_Y]</tt> and
-<tt class="varname">[floor1_step2_flag]</tt> together into new vectors
-<tt class="varname">[floor1_X_list]'</tt>, <tt class="varname">[floor1_final_Y]'</tt> and
-<tt class="varname">[floor1_step2_flag]'</tt> according to ascending sort order of the
-values in <tt class="varname">[floor1_X_list]</tt>. That is, sort the values of
-<tt class="varname">[floor1_X_list]</tt> and then apply the same permutation to
-elements of the other two vectors so that the X, Y and step2_flag
-values still match.</p><p>
-Then compute the final curve in one pass:</p><pre class="screen">
- 1) [hx] = 0
- 2) [lx] = 0
- 3) [ly] = vector [floor1_final_Y]' element [0] * [floor1_multiplier]
- 4) iterate [i] over the range 1 ... [floor1_values]-1 {
-
- 5) if ( [floor1_step2_flag]' is set ) {
-
- 6) [hy] = [floor1_final_Y]' element [i] * [floor1_multiplier]
- 7) [hx] = [floor1_X_list]' element [i]
- 8) <a href="#vorbis-spec-render_line" title="9.2.4.3. render_line">render_line</a>( [lx], [ly], [hx], [hy], [floor] )
- 9) [lx] = [hx]
- 10) [ly] = [hy]
- }
- }
-
- 11) if ( [hx] is less than [n] ) {
-
- 12) <a href="#vorbis-spec-render_line" title="9.2.4.3. render_line">render_line</a>( [hx], [hy], [n], [hy], [floor] )
-
- }
-
- 13) if ( [hx] is greater than [n] ) {
-
- 14) truncate vector [floor] to [n] elements
-
- }
-
- 15) for each scalar in vector [floor], perform a lookup substitution using
- the scalar value from [floor] as an offset into the vector <a href="#vorbis-spec-floor1_inverse_dB_table" title="10.1. floor1_inverse_dB_table">[floor1_inverse_dB_static_table]</a>
-
- 16) done
-
-</pre></div></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-residue"></a>8. Residue setup and decode</h2></div><div><p class="releaseinfo">
- $Id: 08-residue.xml 7186 2004-07-20 07:19:25Z xiphmont $
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4792884"></a>8.1. Overview</h3></div></div></div><p>
-A residue vector represents the fine detail of the audio spectrum of
-one channel in an audio frame after the encoder subtracts the floor
-curve and performs any channel coupling. A residue vector may
-represent spectral lines, spectral magnitude, spectral phase or
-hybrids as mixed by channel coupling. The exact semantic content of
-the vector does not matter to the residue abstraction.</p><p>
-Whatever the exact qualities, the Vorbis residue abstraction codes the
-residue vectors into the bitstream packet, and then reconstructs the
-vectors during decode. Vorbis makes use of three different encoding
-variants (numbered 0, 1 and 2) of the same basic vector encoding
-abstraction.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4744282"></a>8.2. Residue format</h3></div></div></div><p>
-Residue format partitions each vector in the vector bundle into chunks,
-classifies each chunk, encodes the chunk classifications and finally
-encodes the chunks themselves using the the specific VQ arrangement
-defined for each selected classification.
-The exact interleaving and partitioning vary by residue encoding number,
-however the high-level process used to classify and encode the residue
-vector is the same in all three variants.</p><p>
-A set of coded residue vectors are all of the same length. High level
-coding structure, ignoring for the moment exactly how a partition is
-encoded and simply trusting that it is, is as follows:</p><div class="itemizedlist"><ul type="disc"><li><p>Each vector is partitioned into multiple equal sized chunks
-according to configuration specified. If we have a vector size of
-<span class="emphasis"><em>n</em></span>, a partition size <span class="emphasis"><em>residue_partition_size</em></span>, and a total
-of <span class="emphasis"><em>ch</em></span> residue vectors, the total number of partitioned chunks
-coded is <span class="emphasis"><em>n</em></span>/<span class="emphasis"><em>residue_partition_size</em></span>*<span class="emphasis"><em>ch</em></span>. It is
-important to note that the integer division truncates. In the below
-example, we assume an example <span class="emphasis"><em>residue_partition_size</em></span> of 8.</p></li><li><p>Each partition in each vector has a classification number that
-specifies which of multiple configured VQ codebook setups are used to
-decode that partition. The classification numbers of each partition
-can be thought of as forming a vector in their own right, as in the
-illustration below. Just as the residue vectors are coded in grouped
-partitions to increase encoding efficiency, the classification vector
-is also partitioned into chunks. The integer elements of each scalar
-in a classification chunk are built into a single scalar that
-represents the classification numbers in that chunk. In the below
-example, the classification codeword encodes two classification
-numbers.</p></li><li><p>The values in a residue vector may be encoded monolithically in a
-single pass through the residue vector, but more often efficient
-codebook design dictates that each vector is encoded as the additive
-sum of several passes through the residue vector using more than one
-VQ codebook. Thus, each residue value potentially accumulates values
-from multiple decode passes. The classification value associated with
-a partition is the same in each pass, thus the classification codeword
-is coded only in the first pass.</p></li></ul></div><div class="mediaobject"><img src="residue-pack.png" alt="[illustration of residue vector format]"></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4775296"></a>8.3. residue 0</h3></div></div></div><p>
-Residue 0 and 1 differ only in the way the values within a residue
-partition are interleaved during partition encoding (visually treated
-as a black box--or cyan box or brown box--in the above figure).</p><p>
-Residue encoding 0 interleaves VQ encoding according to the
-dimension of the codebook used to encode a partition in a specific
-pass. The dimension of the codebook need not be the same in multiple
-passes, however the partition size must be an even multiple of the
-codebook dimension.</p><p>
-As an example, assume a partition vector of size eight, to be encoded
-by residue 0 using codebook sizes of 8, 4, 2 and 1:</p><pre class="programlisting">
-
- original residue vector: [ 0 1 2 3 4 5 6 7 ]
-
-codebook dimensions = 8 encoded as: [ 0 1 2 3 4 5 6 7 ]
-
-codebook dimensions = 4 encoded as: [ 0 2 4 6 ], [ 1 3 5 7 ]
-
-codebook dimensions = 2 encoded as: [ 0 4 ], [ 1 5 ], [ 2 6 ], [ 3 7 ]
-
-codebook dimensions = 1 encoded as: [ 0 ], [ 1 ], [ 2 ], [ 3 ], [ 4 ], [ 5 ], [ 6 ], [ 7 ]
-
-</pre><p>
-It is worth mentioning at this point that no configurable value in the
-residue coding setup is restricted to a power of two.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4747824"></a>8.4. residue 1</h3></div></div></div><p>
-Residue 1 does not interleave VQ encoding. It represents partition
-vector scalars in order. As with residue 0, however, partition length
-must be an integer multiple of the codebook dimension, although
-dimension may vary from pass to pass.</p><p>
-As an example, assume a partition vector of size eight, to be encoded
-by residue 0 using codebook sizes of 8, 4, 2 and 1:</p><pre class="programlisting">
-
- original residue vector: [ 0 1 2 3 4 5 6 7 ]
-
-codebook dimensions = 8 encoded as: [ 0 1 2 3 4 5 6 7 ]
-
-codebook dimensions = 4 encoded as: [ 0 1 2 3 ], [ 4 5 6 7 ]
-
-codebook dimensions = 2 encoded as: [ 0 1 ], [ 2 3 ], [ 4 5 ], [ 6 7 ]
-
-codebook dimensions = 1 encoded as: [ 0 ], [ 1 ], [ 2 ], [ 3 ], [ 4 ], [ 5 ], [ 6 ], [ 7 ]
-
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4795336"></a>8.5. residue 2</h3></div></div></div><p>
-Residue type two can be thought of as a variant of residue type 1.
-Rather than encoding multiple passed-in vectors as in residue type 1,
-the <span class="emphasis"><em>ch</em></span> passed in vectors of length <span class="emphasis"><em>n</em></span> are first
-interleaved and flattened into a single vector of length
-<span class="emphasis"><em>ch</em></span>*<span class="emphasis"><em>n</em></span>. Encoding then proceeds as in type 1. Decoding is
-as in type 1 with decode interleave reversed. If operating on a single
-vector to begin with, residue type 1 and type 2 are equivalent.</p><div class="mediaobject"><img src="residue2.png" alt="[illustration of residue type 2]"></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4778477"></a>8.6. Residue decode</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4773092"></a>8.6.1. header decode</h4></div></div></div><p>
-Header decode for all three residue types is identical.</p><pre class="programlisting">
- 1) [residue_begin] = read 24 bits as unsigned integer
- 2) [residue_end] = read 24 bits as unsigned integer
- 3) [residue_partition_size] = read 24 bits as unsigned integer and add one
- 4) [residue_classifications] = read 6 bits as unsigned integer and add one
- 5) [residue_classbook] = read 8 bits as unsigned integer
-</pre><p>
-<tt class="varname">[residue_begin]</tt> and <tt class="varname">[residue_end]</tt> select the specific
-sub-portion of each vector that is actually coded; it implements akin
-to a bandpass where, for coding purposes, the vector effectively
-begins at element <tt class="varname">[residue_begin]</tt> and ends at
-<tt class="varname">[residue_end]</tt>. Preceding and following values in the unpacked
-vectors are zeroed. Note that for residue type 2, these values as
-well as <tt class="varname">[residue_partition_size]</tt>apply to the interleaved
-vector, not the individual vectors before interleave.
-<tt class="varname">[residue_partition_size]</tt> is as explained above,
-<tt class="varname">[residue_classifications]</tt> is the number of possible
-classification to which a partition can belong and
-<tt class="varname">[residue_classbook]</tt> is the codebook number used to code
-classification codewords. The number of dimensions in book
-<tt class="varname">[residue_classbook]</tt> determines how many classification values
-are grouped into a single classification codeword.</p><p>
-Next we read a bitmap pattern that specifies which partition classes
-code values in which passes.</p><pre class="programlisting">
- 1) iterate [i] over the range 0 ... [residue_classifications]-1 {
-
- 2) [high_bits] = 0
- 3) [low_bits] = read 3 bits as unsigned integer
- 4) [bitflag] = read one bit as boolean
- 5) if ( [bitflag] is set ) then [high_bits] = read five bits as unsigned integer
- 6) vector [residue_cascade] element [i] = [high_bits] * 8 + [low_bits]
- }
- 7) done
-</pre><p>
-Finally, we read in a list of book numbers, each corresponding to
-specific bit set in the cascade bitmap. We loop over the possible
-codebook classifications and the maximum possible number of encoding
-stages (8 in Vorbis I, as constrained by the elements of the cascade
-bitmap being eight bits):</p><pre class="programlisting">
- 1) iterate [i] over the range 0 ... [residue_classifications]-1 {
-
- 2) iterate [j] over the range 0 ... 7 {
-
- 3) if ( vector [residue_cascade] element [i] bit [j] is set ) {
-
- 4) array [residue_books] element [i][j] = read 8 bits as unsigned integer
-
- } else {
-
- 5) array [residue_books] element [i][j] = unused
-
- }
- }
- }
-
- 6) done
-</pre><p>
-An end-of-packet condition at any point in header decode renders the
-stream undecodable. In addition, any codebook number greater than the
-maximum numbered codebook set up in this stream also renders the
-stream undecodable.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4803599"></a>8.6.2. packet decode</h4></div></div></div><p>
-Format 0 and 1 packet decode is identical except for specific
-partition interleave. Format 2 packet decode can be built out of the
-format 1 decode process. Thus we describe first the decode
-infrastructure identical to all three formats.</p><p>
-In addition to configuration information, the residue decode process
-is passed the number of vectors in the submap bundle and a vector of
-flags indicating if any of the vectors are not to be decoded. If the
-passed in number of vectors is 3 and vector number 1 is marked 'do not
-decode', decode skips vector 1 during the decode loop. However, even
-'do not decode' vectors are allocated and zeroed.</p><p>
-The following convenience values are conceptually useful to clarifying
-the decode process:</p><pre class="programlisting">
- 1) [classwords_per_codeword] = [codebook_dimensions] value of codebook [residue_classbook]
- 2) [n_to_read] = [residue_end] - [residue_begin]
- 3) [partitions_to_read] = [n_to_read] / [residue_partition_size]
-</pre><p>
-Packet decode proceeds as follows, matching the description offered earlier in the document. We assume that the number of vectors being encoded, <tt class="varname">[ch]</tt> is provided by the higher level decoding process.</p><pre class="programlisting">
- 1) allocate and zero all vectors that will be returned.
- 2) iterate [pass] over the range 0 ... 7 {
-
- 3) [partition_count] = 0
-
- 4) if ([pass] is zero) {
-
- 5) iterate [j] over the range 0 .. [ch]-1 {
-
- 6) if vector [j] is not marked 'do not decode' {
-
- 7) [temp] = read from packet using codebook [residue_classbook] in scalar context
- 8) iterate [i] descending over the range [classwords_per_codeword]-1 ... 0 {
-
- 9) array [classifications] element [j],([i]+[partition_count]) =
- [temp] integer modulo [residue_classifications]
- 10) [temp] = [temp] / [residue_classifications] using integer division
-
- }
-
- }
-
- }
-
- }
-
- 11) iterate [i] over the range 0 .. ([classwords_per_codeword] - 1) while [partition_count]
- is also less than [partitions_to_read] {
-
- 12) iterate [j] over the range 0 .. [ch]-1 {
-
- 13) if vector [j] is not marked 'do not decode' {
-
- 14) [vqclass] = array [classifications] element [j],[partition_count]
- 15) [vqbook] = array [residue_books] element [vqclass],[pass]
- 16) if ([vqbook] is not 'unused') {
-
- 17) decode partition into output vector number [j], starting at scalar
- offset [residue_begin]+[partition_count]*[residue_partition_size] using
- codebook number [vqbook] in VQ context
- }
- }
-
- 18) increment [partition_count] by one
-
- }
- }
-
- 19) done
-
-</pre><p>
-An end-of-packet condition during packet decode is to be considered a
-nominal occurrence. Decode returns the result of vector decode up to
-that point.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4806454"></a>8.6.3. format 0 specifics</h4></div></div></div><p>
-Format zero decodes partitions exactly as described earlier in the
-'Residue Format: residue 0' section. The following pseudocode
-presents the same algorithm. Assume:</p><div class="itemizedlist"><ul type="disc"><li> <tt class="varname">[n]</tt> is the value in <tt class="varname">[residue_partition_size]</tt></li><li><tt class="varname">[v]</tt> is the residue vector</li><li><tt class="varname">[offset]</tt> is the beginning read offset in [v]</li></ul></div><pre class="programlisting">
- 1) [step] = [n] / [codebook_dimensions]
- 2) iterate [i] over the range 0 ... [step]-1 {
-
- 3) vector [entry_temp] = read vector from packet using current codebook in VQ context
- 4) iterate [j] over the range 0 ... [codebook_dimensions]-1 {
-
- 5) vector [v] element ([offset]+[i]+[j]*[step]) =
- vector [v] element ([offset]+[i]+[j]*[step]) +
- vector [entry_temp] element [j]
-
- }
-
- }
-
- 6) done
-
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4806502"></a>8.6.4. format 1 specifics</h4></div></div></div><p>
-Format 1 decodes partitions exactly as described earlier in the
-'Residue Format: residue 1' section. The following pseudocode
-presents the same algorithm. Assume:</p><div class="itemizedlist"><ul type="disc"><li> <tt class="varname">[n]</tt> is the value in
-<tt class="varname">[residue_partition_size]</tt></li><li><tt class="varname">[v]</tt> is the residue vector</li><li><tt class="varname">[offset]</tt> is the beginning read offset in [v]</li></ul></div><pre class="programlisting">
- 1) [i] = 0
- 2) vector [entry_temp] = read vector from packet using current codebook in VQ context
- 3) iterate [j] over the range 0 ... [codebook_dimensions]-1 {
-
- 4) vector [v] element ([offset]+[i]) =
- vector [v] element ([offset]+[i]) +
- vector [entry_temp] element [j]
- 5) increment [i]
-
- }
-
- 6) if ( [i] is less than [n] ) continue at step 2
- 7) done
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4806549"></a>8.6.5. format 2 specifics</h4></div></div></div><p>
-Format 2 is reducible to format 1. It may be implemented as an additional step prior to and an additional post-decode step after a normal format 1 decode.
-</p><p>
-Format 2 handles 'do not decode' vectors differently than residue 0 or
-1; if all vectors are marked 'do not decode', no decode occurrs.
-However, if at least one vector is to be decoded, all the vectors are
-decoded. We then request normal format 1 to decode a single vector
-representing all output channels, rather than a vector for each
-channel. After decode, deinterleave the vector into independent vectors, one for each output channel. That is:</p><div class="orderedlist"><ol type="1"><li>If all vectors 0 through <span class="emphasis"><em>ch</em></span>-1 are marked 'do not decode', allocate and clear a single vector <tt class="varname">[v]</tt>of length <span class="emphasis"><em>ch*n</em></span> and skip step 2 below; proceed directly to the post-decode step.</li><li>Rather than performing format 1 decode to produce <span class="emphasis"><em>ch</em></span> vectors of length <span class="emphasis"><em>n</em></span> each, call format 1 decode to produce a single vector <tt class="varname">[v]</tt> of length <span class="emphasis"><em>ch*n</em></span>. </li><li><p>Post decode: Deinterleave the single vector <tt class="varname">[v]</tt> returned by format 1 decode as described above into <span class="emphasis"><em>ch</em></span> independent vectors, one for each outputchannel, according to:
- </p><pre class="programlisting">
- 1) iterate [i] over the range 0 ... [n]-1 {
-
- 2) iterate [j] over the range 0 ... [ch]-1 {
-
- 3) output vector number [j] element [i] = vector [v] element ([i] * [ch] + [j])
-
- }
- }
-
- 4) done
- </pre><p>
- </p></li></ol></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-helper"></a>9. Helper equations</h2></div><div><p class="releaseinfo">
- $Id: 09-helper.xml 7186 2004-07-20 07:19:25Z xiphmont $
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4772356"></a>9.1. Overview</h3></div></div></div><p>
-The equations below are used in multiple places by the Vorbis codec
-specification. Rather than cluttering up the main specification
-documents, they are defined here and referenced where appropriate.
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4753492"></a>9.2. Functions</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-ilog"></a>9.2.1. ilog</h4></div></div></div><p>
-The "ilog(x)" function returns the position number (1 through n) of the highest set bit in the two's complement integer value
-<tt class="varname">[x]</tt>. Values of <tt class="varname">[x]</tt> less than zero are defined to return zero.</p><pre class="programlisting">
- 1) [return_value] = 0;
- 2) if ( [x] is greater than zero ){
-
- 3) increment [return_value];
- 4) logical shift [x] one bit to the right, padding the MSb with zero
- 5) repeat at step 2)
-
- }
-
- 6) done
-</pre><p>
-Examples:
-
-</p><div class="itemizedlist"><ul type="disc"><li>ilog(0) = 0;</li><li>ilog(1) = 1;</li><li>ilog(2) = 2;</li><li>ilog(3) = 2;</li><li>ilog(4) = 3;</li><li>ilog(7) = 3;</li><li>ilog(negative number) = 0;</li></ul></div><p>
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-float32_unpack"></a>9.2.2. float32_unpack</h4></div></div></div><p>
-"float32_unpack(x)" is intended to translate the packed binary
-representation of a Vorbis codebook float value into the
-representation used by the decoder for floating point numbers. For
-purposes of this example, we will unpack a Vorbis float32 into a
-host-native floating point number.</p><pre class="programlisting">
- 1) [mantissa] = [x] bitwise AND 0x1fffff (unsigned result)
- 2) [sign] = [x] bitwise AND 0x80000000 (unsigned result)
- 3) [exponent] = ( [x] bitwise AND 0x7fe00000) shifted right 21 bits (unsigned result)
- 4) if ( [sign] is nonzero ) then negate [mantissa]
- 5) return [mantissa] * ( 2 ^ ( [exponent] - 788 ) )
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-lookup1_values"></a>9.2.3. lookup1_values</h4></div></div></div><p>
-"lookup1_values(codebook_entries,codebook_dimensions)" is used to
-compute the correct length of the value index for a codebook VQ lookup
-table of lookup type 1. The values on this list are permuted to
-construct the VQ vector lookup table of size
-<tt class="varname">[codebook_entries]</tt>.</p><p>
-The return value for this function is defined to be 'the greatest
-integer value for which <tt class="varname">[return_value] to the power of
-[codebook_dimensions] is less than or equal to
-[codebook_entries]</tt>'.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-low_neighbor"></a>9.2.4. low_neighbor</h4></div></div></div><p>
-"low_neighbor(v,x)" finds the position <tt class="varname">n</tt> in vector <tt class="varname">[v]</tt> of
-the greatest value scalar element for which <tt class="varname">n</tt> is less than
-<tt class="varname">[x]</tt> and vector <tt class="varname">[v]</tt> element <tt class="varname">n</tt> is less
-than vector <tt class="varname">[v]</tt> element <tt class="varname">[x]</tt>.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-high_neighbor"></a>9.2.4.1. high_neighbor</h5></div></div></div><p>
-"high_neighbor(v,x)" finds the position <tt class="varname">n</tt> in vector [v] of
-the lowest value scalar element for which <tt class="varname">n</tt> is less than
-<tt class="varname">[x]</tt> and vector <tt class="varname">[v]</tt> element <tt class="varname">n</tt> is greater
-than vector <tt class="varname">[v]</tt> element <tt class="varname">[x]</tt>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-render_point"></a>9.2.4.2. render_point</h5></div></div></div><p>
-"render_point(x0,y0,x1,y1,X)" is used to find the Y value at point X
-along the line specified by x0, x1, y0 and y1. This function uses an
-integer algorithm to solve for the point directly without calculating
-intervening values along the line.</p><pre class="programlisting">
- 1) [dy] = [y1] - [y0]
- 2) [adx] = [x1] - [x0]
- 3) [ady] = absolute value of [dy]
- 4) [err] = [ady] * ([X] - [x0])
- 5) [off] = [err] / [adx] using integer division
- 6) if ( [dy] is less than zero ) {
-
- 7) [Y] = [y0] - [off]
-
- } else {
-
- 8) [Y] = [y0] + [off]
-
- }
-
- 9) done
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-render_line"></a>9.2.4.3. render_line</h5></div></div></div><p>
-Floor decode type one uses the integer line drawing algorithm of
-"render_line(x0, y0, x1, y1, v)" to construct an integer floor
-curve for contiguous piecewise line segments. Note that it has not
-been relevant elsewhere, but here we must define integer division as
-rounding division of both positive and negative numbers toward zero.
-</p><pre class="programlisting">
- 1) [dy] = [y1] - [y0]
- 2) [adx] = [x1] - [x0]
- 3) [ady] = absolute value of [dy]
- 4) [base] = [dy] / [adx] using integer division
- 5) [x] = [x0]
- 6) [y] = [y0]
- 7) [err] = 0
-
- 8) if ( [dy] is less than 0 ) {
-
- 9) [sy] = [base] - 1
-
- } else {
-
- 10) [sy] = [base] + 1
-
- }
-
- 11) [ady] = [ady] - (absolute value of [base]) * [adx]
- 12) vector [v] element [x] = [y]
-
- 13) iterate [x] over the range [x0]+1 ... [x1]-1 {
-
- 14) [err] = [err] + [ady];
- 15) if ( [err] >= [adx] ) {
-
- 16) [err] = [err] - [adx]
- 17) [y] = [y] + [sy]
-
- } else {
-
- 18) [y] = [y] + [base]
-
- }
-
- 19) vector [v] element [x] = [y]
-
- }
-</pre></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-tables"></a>10. Tables</h2></div><div><p class="releaseinfo">
- $Id: 10-tables.xml 7186 2004-07-20 07:19:25Z xiphmont $
- </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="vorbis-spec-floor1_inverse_dB_table"></a>10.1. floor1_inverse_dB_table</h3></div></div></div><p>
-The vector <tt class="varname">[floor1_inverse_dB_table]</tt> is a 256 element static
-lookup table consiting of the following values (read left to right
-then top to bottom):</p><pre class="screen">
- 1.0649863e-07, 1.1341951e-07, 1.2079015e-07, 1.2863978e-07,
- 1.3699951e-07, 1.4590251e-07, 1.5538408e-07, 1.6548181e-07,
- 1.7623575e-07, 1.8768855e-07, 1.9988561e-07, 2.1287530e-07,
- 2.2670913e-07, 2.4144197e-07, 2.5713223e-07, 2.7384213e-07,
- 2.9163793e-07, 3.1059021e-07, 3.3077411e-07, 3.5226968e-07,
- 3.7516214e-07, 3.9954229e-07, 4.2550680e-07, 4.5315863e-07,
- 4.8260743e-07, 5.1396998e-07, 5.4737065e-07, 5.8294187e-07,
- 6.2082472e-07, 6.6116941e-07, 7.0413592e-07, 7.4989464e-07,
- 7.9862701e-07, 8.5052630e-07, 9.0579828e-07, 9.6466216e-07,
- 1.0273513e-06, 1.0941144e-06, 1.1652161e-06, 1.2409384e-06,
- 1.3215816e-06, 1.4074654e-06, 1.4989305e-06, 1.5963394e-06,
- 1.7000785e-06, 1.8105592e-06, 1.9282195e-06, 2.0535261e-06,
- 2.1869758e-06, 2.3290978e-06, 2.4804557e-06, 2.6416497e-06,
- 2.8133190e-06, 2.9961443e-06, 3.1908506e-06, 3.3982101e-06,
- 3.6190449e-06, 3.8542308e-06, 4.1047004e-06, 4.3714470e-06,
- 4.6555282e-06, 4.9580707e-06, 5.2802740e-06, 5.6234160e-06,
- 5.9888572e-06, 6.3780469e-06, 6.7925283e-06, 7.2339451e-06,
- 7.7040476e-06, 8.2047000e-06, 8.7378876e-06, 9.3057248e-06,
- 9.9104632e-06, 1.0554501e-05, 1.1240392e-05, 1.1970856e-05,
- 1.2748789e-05, 1.3577278e-05, 1.4459606e-05, 1.5399272e-05,
- 1.6400004e-05, 1.7465768e-05, 1.8600792e-05, 1.9809576e-05,
- 2.1096914e-05, 2.2467911e-05, 2.3928002e-05, 2.5482978e-05,
- 2.7139006e-05, 2.8902651e-05, 3.0780908e-05, 3.2781225e-05,
- 3.4911534e-05, 3.7180282e-05, 3.9596466e-05, 4.2169667e-05,
- 4.4910090e-05, 4.7828601e-05, 5.0936773e-05, 5.4246931e-05,
- 5.7772202e-05, 6.1526565e-05, 6.5524908e-05, 6.9783085e-05,
- 7.4317983e-05, 7.9147585e-05, 8.4291040e-05, 8.9768747e-05,
- 9.5602426e-05, 0.00010181521, 0.00010843174, 0.00011547824,
- 0.00012298267, 0.00013097477, 0.00013948625, 0.00014855085,
- 0.00015820453, 0.00016848555, 0.00017943469, 0.00019109536,
- 0.00020351382, 0.00021673929, 0.00023082423, 0.00024582449,
- 0.00026179955, 0.00027881276, 0.00029693158, 0.00031622787,
- 0.00033677814, 0.00035866388, 0.00038197188, 0.00040679456,
- 0.00043323036, 0.00046138411, 0.00049136745, 0.00052329927,
- 0.00055730621, 0.00059352311, 0.00063209358, 0.00067317058,
- 0.00071691700, 0.00076350630, 0.00081312324, 0.00086596457,
- 0.00092223983, 0.00098217216, 0.0010459992, 0.0011139742,
- 0.0011863665, 0.0012634633, 0.0013455702, 0.0014330129,
- 0.0015261382, 0.0016253153, 0.0017309374, 0.0018434235,
- 0.0019632195, 0.0020908006, 0.0022266726, 0.0023713743,
- 0.0025254795, 0.0026895994, 0.0028643847, 0.0030505286,
- 0.0032487691, 0.0034598925, 0.0036847358, 0.0039241906,
- 0.0041792066, 0.0044507950, 0.0047400328, 0.0050480668,
- 0.0053761186, 0.0057254891, 0.0060975636, 0.0064938176,
- 0.0069158225, 0.0073652516, 0.0078438871, 0.0083536271,
- 0.0088964928, 0.009474637, 0.010090352, 0.010746080,
- 0.011444421, 0.012188144, 0.012980198, 0.013823725,
- 0.014722068, 0.015678791, 0.016697687, 0.017782797,
- 0.018938423, 0.020169149, 0.021479854, 0.022875735,
- 0.024362330, 0.025945531, 0.027631618, 0.029427276,
- 0.031339626, 0.033376252, 0.035545228, 0.037855157,
- 0.040315199, 0.042935108, 0.045725273, 0.048696758,
- 0.051861348, 0.055231591, 0.058820850, 0.062643361,
- 0.066714279, 0.071049749, 0.075666962, 0.080584227,
- 0.085821044, 0.091398179, 0.097337747, 0.10366330,
- 0.11039993, 0.11757434, 0.12521498, 0.13335215,
- 0.14201813, 0.15124727, 0.16107617, 0.17154380,
- 0.18269168, 0.19456402, 0.20720788, 0.22067342,
- 0.23501402, 0.25028656, 0.26655159, 0.28387361,
- 0.30232132, 0.32196786, 0.34289114, 0.36517414,
- 0.38890521, 0.41417847, 0.44109412, 0.46975890,
- 0.50028648, 0.53279791, 0.56742212, 0.60429640,
- 0.64356699, 0.68538959, 0.72993007, 0.77736504,
- 0.82788260, 0.88168307, 0.9389798, 1.
-</pre></div></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="vorbis-over-ogg"></a>A. Embedding Vorbis into an Ogg stream</h2><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4782344"></a>A.1. Overview</h3></div></div></div><p>
-This document describes using Ogg logical and physical transport
-streams to encapsulate Vorbis compressed audio packet data into file
-form.</p><p>
-The <a href="#vorbis-spec-intro" title="1. Introduction and Description">Section 1, “Introduction and Description”</a> provides an overview of the construction
-of Vorbis audio packets.</p><p>
-The <a href="oggstream.html" target="_top">Ogg
-bitstream overview</a> and <a href="framing.html" target="_top">Ogg logical
-bitstream and framing spec</a> provide detailed descriptions of Ogg
-transport streams. This specification document assumes a working
-knowledge of the concepts covered in these named backround
-documents. Please read them first.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4759705"></a>A.1.1. Restrictions</h4></div></div></div><p>
-The Ogg/Vorbis I specification currently dictates that Ogg/Vorbis
-streams use Ogg transport streams in degenerate, unmultiplexed
-form only. That is:
-
-</p><div class="itemizedlist"><ul type="disc"><li>
- A meta-headerless Ogg file encapsulates the Vorbis I packets
- </li><li>
- The Ogg stream may be chained, i.e. contain multiple, contigous logical streams (links).
- </li><li>
- The Ogg stream must be unmultiplexed (only one stream, a Vorbis audio stream, per link)
- </li></ul></div><p>
-</p><p>
-This is not to say that it is not currently possible to multiplex
-Vorbis with other media types into a multi-stream Ogg file. At the
-time this document was written, Ogg was becoming a popular container
-for low-bitrate movies consisting of DiVX video and Vorbis audio.
-However, a 'Vorbis I audio file' is taken to imply Vorbis audio
-existing alone within a degenerate Ogg stream. A compliant 'Vorbis
-audio player' is not required to implement Ogg support beyond the
-specific support of Vorbis within a degenrate ogg stream (naturally,
-application authors are encouraged to support full multiplexed Ogg
-handling).
-</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id4785081"></a>A.1.2. MIME type</h4></div></div></div><p>
-The correct MIME type of any Ogg file is <tt class="literal">application/ogg</tt>.
-However, if a file is a Vorbis I audio file (which implies a
-degenerate Ogg stream including only unmultiplexed Vorbis audio), the
-mime type <tt class="literal">audio/x-vorbis</tt> is also allowed.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id4780489"></a>A.2. Encapsulation</h3></div></div></div><p>
-Ogg encapsulation of a Vorbis packet stream is straightforward.</p><div class="itemizedlist"><ul type="disc"><li>
- The first Vorbis packet (the identification header), which
- uniquely identifies a stream as Vorbis audio, is placed alone in the
- first page of the logical Ogg stream. This results in a first Ogg
- page of exactly 58 bytes at the very beginning of the logical stream.
-</li><li>
- This first page is marked 'beginning of stream' in the page flags.
-</li><li>
- The second and third vorbis packets (comment and setup
- headers) may span one or more pages beginning on the second page of
- the logical stream. However many pages they span, the third header
- packet finishes the page on which it ends. The next (first audio) packet
- must begin on a fresh page.
-</li><li>
- The granule position of these first pages containing only headers is zero.
-</li><li>
- The first audio packet of the logical stream begins a fresh Ogg page.
-</li><li>
- Packets are placed into ogg pages in order until the end of stream.
-</li><li>
- The last page is marked 'end of stream' in the page flags.
-</li><li>
- Vorbis packets may span page boundaries.
-</li><li>
- The granule position of pages containing Vorbis audio is in units
- of PCM audio samples (per channel; a stereo stream's granule position
- does not increment at twice the speed of a mono stream).
-</li><li>
- The granule position of a page represents the end PCM sample
- position of the last packet <span class="emphasis"><em>completed</em></span> on that page.
- A page that is entirely spanned by a single packet (that completes on a
- subsequent page) has no granule position, and the granule position is
- set to '-1'.
-</li><li><p>
- The granule (PCM) position of the first page need not indicate
- that the stream started at position zero. Although the granule
- position belongs to the last completed packet on the page and a
- valid granule position must be positive, by
- inference it may indicate that the PCM position of the beginning
- of audio is positive or negative.
- </p><div class="itemizedlist"><ul type="circle"><li>
- A positive starting value simply indicates that this stream begins at
- some positive time offset, potentially within a larger
- program. This is a common case when connecting to the middle
- of broadcast stream.
- </li><li>
- A negative value indicates that
- output samples preceeding time zero should be discarded during
- decoding; this technique is used to allow sample-granularity
- editing of the stream start time of already-encoded Vorbis
- streams. The number of samples to be discarded must not exceed
- the overlap-add span of the first two audio packets.
- </li></ul></div><p>
- In both of these cases in which the initial audio PCM starting
- offset is nonzero, the second finished audio packet must flush the
- page on which it appears and the third packet begin a fresh page.
- This allows the decoder to always be able to perform PCM position
- adjustments before needing to return any PCM data from synthesis,
- resulting in correct positioning information without any aditional
- seeking logic.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- Failure to do so should, at worst, cause a
- decoder implementation to return incorrect positioning information
- for seeking operations at the very beginning of the stream.
- </p></div></li><li>
- A granule position on the final page in a stream that indicates
- less audio data than the final packet would normally return is used to
- end the stream on other than even frame boundaries. The difference
- between the actual available data returned and the declared amount
- indicates how many trailing samples to discard from the decoding
- process.
- </li></ul></div></div></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="vorbis-over-rtp"></a>B. Vorbis encapsulation in RTP</h2><pre class="literallayout">
-
-
-
- <p>Please consult the internet draft <i class="citetitle">RTP Payload Format for Vorbis Encoded
- Audio</i> for description of how to embed Vorbis audio in an RTP stream.</p>
-
-</pre></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="footer"></a>C. Colophon</h2><div class="mediaobject"><img src="white-xifish.png" alt="[Xiph.org logo]"></div><p>
-Ogg is a <a href="http://www.xiph.org/" target="_top">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html" target="_top">About
-the Xiph.org Foundation</a> for details.
-</p><p>
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.</p><p>
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.</p><p>
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/" target="_top">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2004 Xiph.org Foundation. All rights
-reserved.</p><p>
-This document is set in DocBook XML.
-</p></div></div></body></html>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Vorbis I specification</title><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id209753"></a>Vorbis I specification</h1></div><div><h3 class="corpauthor">Xiph.org Foundation</h3></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#vorbis-spec-intro">1. Introduction and Description</a></span></dt><dd><dl><dt><span class="section"><a href="#id322780">1.1. Overview</a></span></dt><dt><span class="section"><a href="#id256749">1.2. Decoder Configuration</a></span></dt><dt><span class="section"><a href="#id257049">1.3. High-level Decode Process</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-bitpacking">2. Bitpacking C
onvention</a></span></dt><dd><dl><dt><span class="section"><a href="#id316853">2.1. Overview</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-codebook">3. Probability Model and Codebooks</a></span></dt><dd><dl><dt><span class="section"><a href="#id326636">3.1. Overview</a></span></dt><dt><span class="section"><a href="#id329366">3.2. Packed codebook format</a></span></dt><dt><span class="section"><a href="#id320654">3.3. Use of the codebook abstraction</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-codec">4. Codec Setup and Packet Decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id332455">4.1. Overview</a></span></dt><dt><span class="section"><a href="#id332825">4.2. Header decode and decode setup</a></span></dt><dt><span class="section"><a href="#id341314">4.3. Audio packet decode and synthesis</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-comment">5. comment field and header speci
fication</a></span></dt><dd><dl><dt><span class="section"><a href="#id333629">5.1. Overview</a></span></dt><dt><span class="section"><a href="#id333657">5.2. Comment encoding</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-floor0">6. Floor type 0 setup and decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id320318">6.1. Overview</a></span></dt><dt><span class="section"><a href="#id324407">6.2. Floor 0 format</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-floor1">7. Floor type 1 setup and decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id321969">7.1. Overview</a></span></dt><dt><span class="section"><a href="#id315653">7.2. Floor 1 format</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-residue">8. Residue setup and decode</a></span></dt><dd><dl><dt><span class="section"><a href="#id333002">8.1. Overview</a></span></dt><dt><span class="section"><a href="#id327769">8.2.
Residue format</a></span></dt><dt><span class="section"><a href="#id318469">8.3. residue 0</a></span></dt><dt><span class="section"><a href="#id343071">8.4. residue 1</a></span></dt><dt><span class="section"><a href="#id343096">8.5. residue 2</a></span></dt><dt><span class="section"><a href="#id343145">8.6. Residue decode</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-helper">9. Helper equations</a></span></dt><dd><dl><dt><span class="section"><a href="#id325073">9.1. Overview</a></span></dt><dt><span class="section"><a href="#id306980">9.2. Functions</a></span></dt></dl></dd><dt><span class="section"><a href="#vorbis-spec-tables">10. Tables</a></span></dt><dd><dl><dt><span class="section"><a href="#vorbis-spec-floor1_inverse_dB_table">10.1. floor1_inverse_dB_table</a></span></dt></dl></dd><dt><span class="appendix"><a href="#vorbis-over-ogg">1. Embedding Vorbis into an Ogg stream</a></span></dt><dd><dl><dt><span class="section"><a href="#id312362"
>1.1. Overview</a></span></dt><dd><dl><dt><span class="section"><a href="#id336032">1.1.1. Restrictions</a></span></dt><dt><span class="section"><a href="#id319459">1.1.2. MIME type</a></span></dt></dl></dd><dt><span class="section"><a href="#id317588">1.2. Encapsulation</a></span></dt></dl></dd><dt><span class="appendix"><a href="#vorbis-over-rtp">2. Vorbis encapsulation in RTP</a></span></dt><dt><span class="appendix"><a href="#footer">3. Colophon</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-intro"></a>1. Introduction and Description</h2></div><div><p class="releaseinfo">
+ $Id: 01-introduction.xml 7186 2004-07-20 07:19:25Z xiphmont $
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id322780"></a>1.1. Overview</h3></div></div></div><p>
+This document provides a high level description of the Vorbis codec's
+construction. A bit-by-bit specification appears beginning in
+<a href="#vorbis-spec-codec" title="4. Codec Setup and Packet Decode">Section 4, “Codec Setup and Packet Decode”</a>.
+The later sections assume a high-level
+understanding of the Vorbis decode process, which is
+provided here.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id315215"></a>1.1.1. Application</h4></div></div></div><p>
+Vorbis is a general purpose perceptual audio CODEC intended to allow
+maximum encoder flexibility, thus allowing it to scale competitively
+over an exceptionally wide range of bitrates. At the high
+quality/bitrate end of the scale (CD or DAT rate stereo, 16/24 bits)
+it is in the same league as MPEG-2 and MPC. Similarly, the 1.0
+encoder can encode high-quality CD and DAT rate stereo at below 48kbps
+without resampling to a lower rate. Vorbis is also intended for
+lower and higher sample rates (from 8kHz telephony to 192kHz digital
+masters) and a range of channel representations (monaural,
+polyphonic, stereo, quadraphonic, 5.1, ambisonic, or up to 255
+discrete channels).
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id323065"></a>1.1.2. Classification</h4></div></div></div><p>
+Vorbis I is a forward-adaptive monolithic transform CODEC based on the
+Modified Discrete Cosine Transform. The codec is structured to allow
+addition of a hybrid wavelet filterbank in Vorbis II to offer better
+transient response and reproduction using a transform better suited to
+localized time events.
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id322056"></a>1.1.3. Assumptions</h4></div></div></div><p>
+The Vorbis CODEC design assumes a complex, psychoacoustically-aware
+encoder and simple, low-complexity decoder. Vorbis decode is
+computationally simpler than mp3, although it does require more
+working memory as Vorbis has no static probability model; the vector
+codebooks used in the first stage of decoding from the bitstream are
+packed in their entirety into the Vorbis bitstream headers. In
+packed form, these codebooks occupy only a few kilobytes; the extent
+to which they are pre-decoded into a cache is the dominant factor in
+decoder memory usage.
+</p><p>
+Vorbis provides none of its own framing, synchronization or protection
+against errors; it is solely a method of accepting input audio,
+dividing it into individual frames and compressing these frames into
+raw, unformatted 'packets'. The decoder then accepts these raw
+packets in sequence, decodes them, synthesizes audio frames from
+them, and reassembles the frames into a facsimile of the original
+audio stream. Vorbis is a free-form variable bit rate (VBR) codec and packets have no
+minimum size, maximum size, or fixed/expected size. Packets
+are designed that they may be truncated (or padded) and remain
+decodable; this is not to be considered an error condition and is used
+extensively in bitrate management in peeling. Both the transport
+mechanism and decoder must allow that a packet may be any size, or
+end before or after packet decode expects.</p><p>
+Vorbis packets are thus intended to be used with a transport mechanism
+that provides free-form framing, sync, positioning and error correction
+in accordance with these design assumptions, such as Ogg (for file
+transport) or RTP (for network multicast). For purposes of a few
+examples in this document, we will assume that Vorbis is to be
+embedded in an Ogg stream specifically, although this is by no means a
+requirement or fundamental assumption in the Vorbis design.</p><p>
+The specification for embedding Vorbis into
+an Ogg transport stream is in <a href="#vorbis-over-ogg" title="1. Embedding Vorbis into an Ogg stream">Appendix 1, <i>Embedding Vorbis into an Ogg stream</i></a>.
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id337302"></a>1.1.4. Codec Setup and Probability Model</h4></div></div></div><p>
+Vorbis' heritage is as a research CODEC and its current design
+reflects a desire to allow multiple decades of continuous encoder
+improvement before running out of room within the codec specification.
+For these reasons, configurable aspects of codec setup intentionally
+lean toward the extreme of forward adaptive.</p><p>
+The single most controversial design decision in Vorbis (and the most
+unusual for a Vorbis developer to keep in mind) is that the entire
+probability model of the codec, the Huffman and VQ codebooks, is
+packed into the bitstream header along with extensive CODEC setup
+parameters (often several hundred fields). This makes it impossible,
+as it would be with MPEG audio layers, to embed a simple frame type
+flag in each audio packet, or begin decode at any frame in the stream
+without having previously fetched the codec setup header.
+</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+Vorbis <span class="emphasis"><em>can</em></span> initiate decode at any arbitrary packet within a
+bitstream so long as the codec has been initialized/setup with the
+setup headers.</p></div><p>
+Thus, Vorbis headers are both required for decode to begin and
+relatively large as bitstream headers go. The header size is
+unbounded, although for streaming a rule-of-thumb of 4kB or less is
+recommended (and Xiph.Org's Vorbis encoder follows this suggestion).</p><p>
+Our own design work indicates the primary liability of the
+required header is in mindshare; it is an unusual design and thus
+causes some amount of complaint among engineers as this runs against
+current design trends (and also points out limitations in some
+existing software/interface designs, such as Windows' ACM codec
+framework). However, we find that it does not fundamentally limit
+Vorbis' suitable application space.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id256723"></a>1.1.5. Format Specification</h4></div></div></div><p>
+The Vorbis format is well-defined by its decode specification; any
+encoder that produces packets that are correctly decoded by the
+reference Vorbis decoder described below may be considered a proper
+Vorbis encoder. A decoder must faithfully and completely implement
+the specification defined below (except where noted) to be considered
+a proper Vorbis decoder.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id256735"></a>1.1.6. Hardware Profile</h4></div></div></div><p>
+Although Vorbis decode is computationally simple, it may still run
+into specific limitations of an embedded design. For this reason,
+embedded designs are allowed to deviate in limited ways from the
+'full' decode specification yet still be certified compliant. These
+optional omissions are labelled in the spec where relevant.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id256749"></a>1.2. Decoder Configuration</h3></div></div></div><p>
+Decoder setup consists of configuration of multiple, self-contained
+component abstractions that perform specific functions in the decode
+pipeline. Each different component instance of a specific type is
+semantically interchangeable; decoder configuration consists both of
+internal component configuration, as well as arrangement of specific
+instances into a decode pipeline. Componentry arrangement is roughly
+as follows:</p><div class="mediaobject"><img src="components.png" alt="decoder pipeline configuration"></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id322835"></a>1.2.1. Global Config</h4></div></div></div><p>
+Global codec configuration consists of a few audio related fields
+(sample rate, channels), Vorbis version (always '0' in Vorbis I),
+bitrate hints, and the lists of component instances. All other
+configuration is in the context of specific components.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id323931"></a>1.2.2. Mode</h4></div></div></div><p>
+Each Vorbis frame is coded according to a master 'mode'. A bitstream
+may use one or many modes.</p><p>
+The mode mechanism is used to encode a frame according to one of
+multiple possible methods with the intention of choosing a method best
+suited to that frame. Different modes are, e.g. how frame size
+is changed from frame to frame. The mode number of a frame serves as a
+top level configuration switch for all other specific aspects of frame
+decode.</p><p>
+A 'mode' configuration consists of a frame size setting, window type
+(always 0, the Vorbis window, in Vorbis I), transform type (always
+type 0, the MDCT, in Vorbis I) and a mapping number. The mapping
+number specifies which mapping configuration instance to use for
+low-level packet decode and synthesis.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id256947"></a>1.2.3. Mapping</h4></div></div></div><p>
+A mapping contains a channel coupling description and a list of
+'submaps' that bundle sets of channel vectors together for grouped
+encoding and decoding. These submaps are not references to external
+components; the submap list is internal and specific to a mapping.</p><p>
+A 'submap' is a configuration/grouping that applies to a subset of
+floor and residue vectors within a mapping. The submap functions as a
+last layer of indirection such that specific special floor or residue
+settings can be applied not only to all the vectors in a given mode,
+but also specific vectors in a specific mode. Each submap specifies
+the proper floor and residue instance number to use for decoding that
+submap's spectral floor and spectral residue vectors.</p><p>
+As an example:</p><p>
+Assume a Vorbis stream that contains six channels in the standard 5.1
+format. The sixth channel, as is normal in 5.1, is bass only.
+Therefore it would be wasteful to encode a full-spectrum version of it
+as with the other channels. The submapping mechanism can be used to
+apply a full range floor and residue encoding to channels 0 through 4,
+and a bass-only representation to the bass channel, thus saving space.
+In this example, channels 0-4 belong to submap 0 (which indicates use
+of a full-range floor) and channel 5 belongs to submap 1, which uses a
+bass-only representation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id256978"></a>1.2.4. Floor</h4></div></div></div><p>
+Vorbis encodes a spectral 'floor' vector for each PCM channel. This
+vector is a low-resolution representation of the audio spectrum for
+the given channel in the current frame, generally used akin to a
+whitening filter. It is named a 'floor' because the Xiph.Org
+reference encoder has historically used it as a unit-baseline for
+spectral resolution.</p><p>
+A floor encoding may be of two types. Floor 0 uses a packed LSP
+representation on a dB amplitude scale and Bark frequency scale.
+Floor 1 represents the curve as a piecewise linear interpolated
+representation on a dB amplitude scale and linear frequency scale.
+The two floors are semantically interchangeable in
+encoding/decoding. However, floor type 1 provides more stable
+inter-frame behavior, and so is the preferred choice in all
+coupled-stereo and high bitrate modes. Floor 1 is also considerably
+less expensive to decode than floor 0.</p><p>
+Floor 0 is not to be considered deprecated, but it is of limited
+modern use. No known Vorbis encoder past Xiph.org's own beta 4 makes
+use of floor 0.</p><p>
+The values coded/decoded by a floor are both compactly formatted and
+make use of entropy coding to save space. For this reason, a floor
+configuration generally refers to multiple codebooks in the codebook
+component list. Entropy coding is thus provided as an abstraction,
+and each floor instance may choose from any and all available
+codebooks when coding/decoding.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id257011"></a>1.2.5. Residue</h4></div></div></div><p>
+The spectral residue is the fine structure of the audio spectrum
+once the floor curve has been subtracted out. In simplest terms, it
+is coded in the bitstream using cascaded (multi-pass) vector
+quantization according to one of three specific packing/coding
+algorithms numbered 0 through 2. The packing algorithm details are
+configured by residue instance. As with the floor components, the
+final VQ/entropy encoding is provided by external codebook instances
+and each residue instance may choose from any and all available
+codebooks.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id257025"></a>1.2.6. Codebooks</h4></div></div></div><p>
+Codebooks are a self-contained abstraction that perform entropy
+decoding and, optionally, use the entropy-decoded integer value as an
+offset into an index of output value vectors, returning the indicated
+vector of values.</p><p>
+The entropy coding in a Vorbis I codebook is provided by a standard
+Huffman binary tree representation. This tree is tightly packed using
+one of several methods, depending on whether codeword lengths are
+ordered or unordered, or the tree is sparse.</p><p>
+The codebook vector index is similarly packed according to index
+characteristic. Most commonly, the vector index is encoded as a
+single list of values of possible values that are then permuted into
+a list of n-dimensional rows (lattice VQ).</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id257049"></a>1.3. High-level Decode Process</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id257055"></a>1.3.1. Decode Setup</h4></div></div></div><p>
+Before decoding can begin, a decoder must initialize using the
+bitstream headers matching the stream to be decoded. Vorbis uses
+three header packets; all are required, in-order, by this
+specification. Once set up, decode may begin at any audio packet
+belonging to the Vorbis stream. In Vorbis I, all packets after the
+three initial headers are audio packets. </p><p>
+The header packets are, in order, the identification
+header, the comments header, and the setup header.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id312627"></a>1.3.1.1. Identification Header</h5></div></div></div><p>
+The identification header identifies the bitstream as Vorbis, Vorbis
+version, and the simple audio characteristics of the stream such as
+sample rate and number of channels.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id312638"></a>1.3.1.2. Comment Header</h5></div></div></div><p>
+The comment header includes user text comments ("tags") and a vendor
+string for the application/library that produced the bitstream. The
+encoding and proper use of the comment header is described in
+<a href="#vorbis-spec-comment" title="5. comment field and header specification">Section 5, “comment field and header specification”</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id312653"></a>1.3.1.3. Setup Header</h5></div></div></div><p>
+The setup header includes extensive CODEC setup information as well as
+the complete VQ and Huffman codebooks needed for decode.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id312666"></a>1.3.2. Decode Procedure</h4></div></div></div><div class="highlights"><p>
+The decoding and synthesis procedure for all audio packets is
+fundamentally the same.
+</p><div class="orderedlist"><ol type="1"><li>decode packet type flag</li><li>decode mode number</li><li>decode window shape (long windows only)</li><li>decode floor</li><li>decode residue into residue vectors</li><li>inverse channel coupling of residue vectors</li><li>generate floor curve from decoded floor data</li><li>compute dot product of floor and residue, producing audio spectrum vector</li><li>inverse monolithic transform of audio spectrum vector, always an MDCT in Vorbis I</li><li>overlap/add left-hand output of transform with right-hand output of previous frame</li><li>store right hand-data from transform of current frame for future lapping</li><li>if not first frame, return results of overlap/add as audio result of current frame</li></ol></div><p>
+</p></div><p>
+Note that clever rearrangement of the synthesis arithmetic is
+possible; as an example, one can take advantage of symmetries in the
+MDCT to store the right-hand transform data of a partial MDCT for a
+50% inter-frame buffer space savings, and then complete the transform
+later before overlap/add with the next frame. This optimization
+produces entirely equivalent output and is naturally perfectly legal.
+The decoder must be <span class="emphasis"><em>entirely mathematically equivalent</em></span> to the
+specification, it need not be a literal semantic implementation.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id312754"></a>1.3.2.1. Packet type decode</h5></div></div></div><p>
+Vorbis I uses four packet types. The first three packet types mark each
+of the three Vorbis headers described above. The fourth packet type
+marks an audio packet. All other packet types are reserved; packets
+marked with a reserved type should be ignored.</p><p>
+Following the three header packets, all packets in a Vorbis I stream
+are audio. The first step of audio packet decode is to read and
+verify the packet type; <span class="emphasis"><em>a non-audio packet when audio is expected
+indicates stream corruption or a non-compliant stream. The decoder
+must ignore the packet and not attempt decoding it to
+audio</em></span>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id312776"></a>1.3.2.2. Mode decode</h5></div></div></div><p>
+Vorbis allows an encoder to set up multiple, numbered packet 'modes',
+as described earlier, all of which may be used in a given Vorbis
+stream. The mode is encoded as an integer used as a direct offset into
+the mode instance index. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-window"></a>1.3.2.3. Window shape decode (long windows only)</h5></div></div></div><p>
+Vorbis frames may be one of two PCM sample sizes specified during
+codec setup. In Vorbis I, legal frame sizes are powers of two from 64
+to 8192 samples. Aside from coupling, Vorbis handles channels as
+independent vectors and these frame sizes are in samples per channel.</p><p>
+Vorbis uses an overlapping transform, namely the MDCT, to blend one
+frame into the next, avoiding most inter-frame block boundary
+artifacts. The MDCT output of one frame is windowed according to MDCT
+requirements, overlapped 50% with the output of the previous frame and
+added. The window shape assures seamless reconstruction. </p><p>
+This is easy to visualize in the case of equal sized-windows:</p><div class="mediaobject"><img src="window1.png" alt="overlap of two equal-sized windows"></div><p>
+And slightly more complex in the case of overlapping unequal sized
+windows:</p><div class="mediaobject"><img src="window2.png" alt="overlap of a long and a short window"></div><p>
+In the unequal-sized window case, the window shape of the long window
+must be modified for seamless lapping as above. It is possible to
+correctly infer window shape to be applied to the current window from
+knowing the sizes of the current, previous and next window. It is
+legal for a decoder to use this method. However, in the case of a long
+window (short windows require no modification), Vorbis also codes two
+flag bits to specify pre- and post- window shape. Although not
+strictly necessary for function, this minor redundancy allows a packet
+to be fully decoded to the point of lapping entirely independently of
+any other packet, allowing easier abstraction of decode layers as well
+as allowing a greater level of easy parallelism in encode and
+decode.</p><p>
+A description of valid window functions for use with an inverse MDCT
+can be found in the paper
+“<span class="citetitle">
+<a href="http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps" target="_top">
+The use of multirate filter banks for coding of high quality digital
+audio</a></span>”, by T. Sporer, K. Brandenburg and B. Edler. Vorbis windows
+all use the slope function
+ <span class="inlinemediaobject"><span>$y = \sin(.5*\pi \, \sin^2((x+.5)/n*\pi))$</span></span>.
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id337723"></a>1.3.2.4. floor decode</h5></div></div></div><p>
+Each floor is encoded/decoded in channel order, however each floor
+belongs to a 'submap' that specifies which floor configuration to
+use. All floors are decoded before residue decode begins.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id337733"></a>1.3.2.5. residue decode</h5></div></div></div><p>
+Although the number of residue vectors equals the number of channels,
+channel coupling may mean that the raw residue vectors extracted
+during decode do not map directly to specific channels. When channel
+coupling is in use, some vectors will correspond to coupled magnitude
+or angle. The coupling relationships are described in the codec setup
+and may differ from frame to frame, due to different mode numbers.</p><p>
+Vorbis codes residue vectors in groups by submap; the coding is done
+in submap order from submap 0 through n-1. This differs from floors
+which are coded using a configuration provided by submap number, but
+are coded individually in channel order.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id337751"></a>1.3.2.6. inverse channel coupling</h5></div></div></div><p>
+A detailed discussion of stereo in the Vorbis codec can be found in
+the document <a href="stereo.html" target="_top"><em class="citetitle">Stereo Channel Coupling in the
+Vorbis CODEC</em></a>. Vorbis is not limited to only stereo coupling, but
+the stereo document also gives a good overview of the generic coupling
+mechanism.</p><p>
+Vorbis coupling applies to pairs of residue vectors at a time;
+decoupling is done in-place a pair at a time in the order and using
+the vectors specified in the current mapping configuration. The
+decoupling operation is the same for all pairs, converting square
+polar representation (where one vector is magnitude and the second
+angle) back to Cartesian representation.</p><p>
+After decoupling, in order, each pair of vectors on the coupling list,
+the resulting residue vectors represent the fine spectral detail
+of each output channel.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id337779"></a>1.3.2.7. generate floor curve</h5></div></div></div><p>
+The decoder may choose to generate the floor curve at any appropriate
+time. It is reasonable to generate the output curve when the floor
+data is decoded from the raw packet, or it can be generated after
+inverse coupling and applied to the spectral residue directly,
+combining generation and the dot product into one step and eliminating
+some working space.</p><p>
+Both floor 0 and floor 1 generate a linear-range, linear-domain output
+vector to be multiplied (dot product) by the linear-range,
+linear-domain spectral residue.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id337795"></a>1.3.2.8. compute floor/residue dot product</h5></div></div></div><p>
+This step is straightforward; for each output channel, the decoder
+multiplies the floor curve and residue vectors element by element,
+producing the finished audio spectrum of each channel.</p><p>
+One point is worth mentioning about this dot product; a common mistake
+in a fixed point implementation might be to assume that a 32 bit
+fixed-point representation for floor and residue and direct
+multiplication of the vectors is sufficient for acceptable spectral
+depth in all cases because it happens to mostly work with the current
+Xiph.Org reference encoder.</p><p>
+However, floor vector values can span ~140dB (~24 bits unsigned), and
+the audio spectrum vector should represent a minimum of 120dB (~21
+bits with sign), even when output is to a 16 bit PCM device. For the
+residue vector to represent full scale if the floor is nailed to
+-140dB, it must be able to span 0 to +140dB. For the residue vector
+to reach full scale if the floor is nailed at 0dB, it must be able to
+represent -140dB to +0dB. Thus, in order to handle full range
+dynamics, a residue vector may span -140dB to +140dB entirely within
+spec. A 280dB range is approximately 48 bits with sign; thus the
+residue vector must be able to represent a 48 bit range and the dot
+product must be able to handle an effective 48 bit times 24 bit
+multiplication. This range may be achieved using large (64 bit or
+larger) integers, or implementing a movable binary point
+representation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id337822"></a>1.3.2.9. inverse monolithic transform (MDCT)</h5></div></div></div><p>
+The audio spectrum is converted back into time domain PCM audio via an
+inverse Modified Discrete Cosine Transform (MDCT). A detailed
+description of the MDCT is available in the paper <a href="http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps" target="_top">“<span class="citetitle">The use of multirate filter banks for coding of high quality digital
+audio</span>”</a>, by T. Sporer, K. Brandenburg and B. Edler.</p><p>
+Note that the PCM produced directly from the MDCT is not yet finished
+audio; it must be lapped with surrounding frames using an appropriate
+window (such as the Vorbis window) before the MDCT can be considered
+orthogonal.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id337847"></a>1.3.2.10. overlap/add data</h5></div></div></div><p>
+Windowed MDCT output is overlapped and added with the right hand data
+of the previous window such that the 3/4 point of the previous window
+is aligned with the 1/4 point of the current window (as illustrated in
+the window overlap diagram). At this point, the audio data between the
+center of the previous frame and the center of the current frame is
+now finished and ready to be returned. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id337859"></a>1.3.2.11. cache right hand data</h5></div></div></div><p>
+The decoder must cache the right hand portion of the current frame to
+be lapped with the left hand portion of the next frame.
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id337869"></a>1.3.2.12. return finished audio data</h5></div></div></div><p>
+The overlapped portion produced from overlapping the previous and
+current frame data is finished data to be returned by the decoder.
+This data spans from the center of the previous window to the center
+of the current window. In the case of same-sized windows, the amount
+of data to return is one-half block consisting of and only of the
+overlapped portions. When overlapping a short and long window, much of
+the returned range is not actually overlap. This does not damage
+transform orthogonality. Pay attention however to returning the
+correct data range; the amount of data to be returned is:
+
+</p><pre class="programlisting">
+window_blocksize(previous_window)/4+window_blocksize(current_window)/4
+</pre><p>
+
+from the center of the previous window to the center of the current
+window.</p><p>
+Data is not returned from the first frame; it must be used to 'prime'
+the decode engine. The encoder accounts for this priming when
+calculating PCM offsets; after the first frame, the proper PCM output
+offset is '0' (as no data has been returned yet).</p></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-bitpacking"></a>2. Bitpacking Convention</h2></div><div><p class="releaseinfo">
+ $Id: 02-bitpacking.xml 7186 2004-07-20 07:19:25Z xiphmont $
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id316853"></a>2.1. Overview</h3></div></div></div><p>
+The Vorbis codec uses relatively unstructured raw packets containing
+arbitrary-width binary integer fields. Logically, these packets are a
+bitstream in which bits are coded one-by-one by the encoder and then
+read one-by-one in the same monotonically increasing order by the
+decoder. Most current binary storage arrangements group bits into a
+native word size of eight bits (octets), sixteen bits, thirty-two bits
+or, less commonly other fixed word sizes. The Vorbis bitpacking
+convention specifies the correct mapping of the logical packet
+bitstream into an actual representation in fixed-width words.
+</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id318012"></a>2.1.1. octets, bytes and words</h4></div></div></div><p>
+In most contemporary architectures, a 'byte' is synonymous with an
+'octet', that is, eight bits. This has not always been the case;
+seven, ten, eleven and sixteen bit 'bytes' have been used. For
+purposes of the bitpacking convention, a byte implies the native,
+smallest integer storage representation offered by a platform. On
+modern platforms, this is generally assumed to be eight bits (not
+necessarily because of the processor but because of the
+filesystem/memory architecture. Modern filesystems invariably offer
+bytes as the fundamental atom of storage). A 'word' is an integer
+size that is a grouped multiple of this smallest size.</p><p>
+The most ubiquitous architectures today consider a 'byte' to be an
+octet (eight bits) and a word to be a group of two, four or eight
+bytes (16, 32 or 64 bits). Note however that the Vorbis bitpacking
+convention is still well defined for any native byte size; Vorbis uses
+the native bit-width of a given storage system. This document assumes
+that a byte is one octet for purposes of example.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id326209"></a>2.1.2. bit order</h4></div></div></div><p>
+A byte has a well-defined 'least significant' bit (LSb), which is the
+only bit set when the byte is storing the two's complement integer
+value +1. A byte's 'most significant' bit (MSb) is at the opposite
+end of the byte. Bits in a byte are numbered from zero at the LSb to
+<span class="emphasis"><em>n</em></span> (<span class="emphasis"><em>n</em></span>=7 in an octet) for the
+MSb.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id323175"></a>2.1.3. byte order</h4></div></div></div><p>
+Words are native groupings of multiple bytes. Several byte orderings
+are possible in a word; the common ones are 3-2-1-0 ('big endian' or
+'most significant byte first' in which the highest-valued byte comes
+first), 0-1-2-3 ('little endian' or 'least significant byte first' in
+which the lowest value byte comes first) and less commonly 3-1-2-0 and
+0-2-1-3 ('mixed endian').</p><p>
+The Vorbis bitpacking convention specifies storage and bitstream
+manipulation at the byte, not word, level, thus host word ordering is
+of a concern only during optimization when writing high performance
+code that operates on a word of storage at a time rather than by byte.
+Logically, bytes are always coded and decoded in order from byte zero
+through byte <span class="emphasis"><em>n</em></span>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id323198"></a>2.1.4. coding bits into byte sequences</h4></div></div></div><p>
+The Vorbis codec has need to code arbitrary bit-width integers, from
+zero to 32 bits wide, into packets. These integer fields are not
+aligned to the boundaries of the byte representation; the next field
+is written at the bit position at which the previous field ends.</p><p>
+The encoder logically packs integers by writing the LSb of a binary
+integer to the logical bitstream first, followed by next least
+significant bit, etc, until the requested number of bits have been
+coded. When packing the bits into bytes, the encoder begins by
+placing the LSb of the integer to be written into the least
+significant unused bit position of the destination byte, followed by
+the next-least significant bit of the source integer and so on up to
+the requested number of bits. When all bits of the destination byte
+have been filled, encoding continues by zeroing all bits of the next
+byte and writing the next bit into the bit position 0 of that byte.
+Decoding follows the same process as encoding, but by reading bits
+from the byte stream and reassembling them into integers.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id312415"></a>2.1.5. signedness</h4></div></div></div><p>
+The signedness of a specific number resulting from decode is to be
+interpreted by the decoder given decode context. That is, the three
+bit binary pattern 'b111' can be taken to represent either 'seven' as
+an unsigned integer, or '-1' as a signed, two's complement integer.
+The encoder and decoder are responsible for knowing if fields are to
+be treated as signed or unsigned.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id312428"></a>2.1.6. coding example</h4></div></div></div><p>
+Code the 4 bit integer value '12' [b1100] into an empty bytestream.
+Bytestream result:
+
+</p><pre class="screen">
+ |
+ V
+
+ 7 6 5 4 3 2 1 0
+byte 0 [0 0 0 0 1 1 0 0] <-
+byte 1 [ ]
+byte 2 [ ]
+byte 3 [ ]
+ ...
+byte n [ ] bytestream length == 1 byte
+
+</pre><p>
+</p><p>
+Continue by coding the 3 bit integer value '-1' [b111]:
+
+</p><pre class="screen">
+ |
+ V
+
+ 7 6 5 4 3 2 1 0
+byte 0 [0 1 1 1 1 1 0 0] <-
+byte 1 [ ]
+byte 2 [ ]
+byte 3 [ ]
+ ...
+byte n [ ] bytestream length == 1 byte
+</pre><p>
+</p><p>
+Continue by coding the 7 bit integer value '17' [b0010001]:
+
+</p><pre class="screen">
+ |
+ V
+
+ 7 6 5 4 3 2 1 0
+byte 0 [1 1 1 1 1 1 0 0]
+byte 1 [0 0 0 0 1 0 0 0] <-
+byte 2 [ ]
+byte 3 [ ]
+ ...
+byte n [ ] bytestream length == 2 bytes
+ bit cursor == 6
+</pre><p>
+</p><p>
+Continue by coding the 13 bit integer value '6969' [b110 11001110 01]:
+
+</p><pre class="screen">
+ |
+ V
+
+ 7 6 5 4 3 2 1 0
+byte 0 [1 1 1 1 1 1 0 0]
+byte 1 [0 1 0 0 1 0 0 0]
+byte 2 [1 1 0 0 1 1 1 0]
+byte 3 [0 0 0 0 0 1 1 0] <-
+ ...
+byte n [ ] bytestream length == 4 bytes
+
+</pre><p>
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id317084"></a>2.1.7. decoding example</h4></div></div></div><p>
+Reading from the beginning of the bytestream encoded in the above example:
+
+</p><pre class="screen">
+ |
+ V
+
+ 7 6 5 4 3 2 1 0
+byte 0 [1 1 1 1 1 1 0 0] <-
+byte 1 [0 1 0 0 1 0 0 0]
+byte 2 [1 1 0 0 1 1 1 0]
+byte 3 [0 0 0 0 0 1 1 0] bytestream length == 4 bytes
+
+</pre><p>
+</p><p>
+We read two, two-bit integer fields, resulting in the returned numbers
+'b00' and 'b11'. Two things are worth noting here:
+
+</p><div class="itemizedlist"><ul type="disc"><li><p>Although these four bits were originally written as a single
+four-bit integer, reading some other combination of bit-widths from the
+bitstream is well defined. There are no artificial alignment
+boundaries maintained in the bitstream.</p></li><li><p>The second value is the
+two-bit-wide integer 'b11'. This value may be interpreted either as
+the unsigned value '3', or the signed value '-1'. Signedness is
+dependent on decode context.</p></li></ul></div><p>
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id322995"></a>2.1.8. end-of-packet alignment</h4></div></div></div><p>
+The typical use of bitpacking is to produce many independent
+byte-aligned packets which are embedded into a larger byte-aligned
+container structure, such as an Ogg transport bitstream. Externally,
+each bytestream (encoded bitstream) must begin and end on a byte
+boundary. Often, the encoded bitstream is not an integer number of
+bytes, and so there is unused (uncoded) space in the last byte of a
+packet.</p><p>
+Unused space in the last byte of a bytestream is always zeroed during
+the coding process. Thus, should this unused space be read, it will
+return binary zeroes.</p><p>
+Attempting to read past the end of an encoded packet results in an
+'end-of-packet' condition. End-of-packet is not to be considered an
+error; it is merely a state indicating that there is insufficient
+remaining data to fulfill the desired read size. Vorbis uses truncated
+packets as a normal mode of operation, and as such, decoders must
+handle reading past the end of a packet as a typical mode of
+operation. Any further read operations after an 'end-of-packet'
+condition shall also return 'end-of-packet'.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id323021"></a>2.1.9. reading zero bits</h4></div></div></div><p>
+Reading a zero-bit-wide integer returns the value '0' and does not
+increment the stream cursor. Reading to the end of the packet (but
+not past, such that an 'end-of-packet' condition has not triggered)
+and then reading a zero bit integer shall succeed, returning 0, and
+not trigger an end-of-packet condition. Reading a zero-bit-wide
+integer after a previous read sets 'end-of-packet' shall also fail
+with 'end-of-packet'.</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-codebook"></a>3. Probability Model and Codebooks</h2></div><div><p class="releaseinfo">
+ $Id: 03-codebook.xml 7186 2004-07-20 07:19:25Z xiphmont $
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id326636"></a>3.1. Overview</h3></div></div></div><p>
+Unlike practically every other mainstream audio codec, Vorbis has no
+statically configured probability model, instead packing all entropy
+decoding configuration, VQ and Huffman, into the bitstream itself in
+the third header, the codec setup header. This packed configuration
+consists of multiple 'codebooks', each containing a specific
+Huffman-equivalent representation for decoding compressed codewords as
+well as an optional lookup table of output vector values to which a
+decoded Huffman value is applied as an offset, generating the final
+decoded output corresponding to a given compressed codeword.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id331970"></a>3.1.1. Bitwise operation</h4></div></div></div><p>
+The codebook mechanism is built on top of the vorbis bitpacker. Both
+the codebooks themselves and the codewords they decode are unrolled
+from a packet as a series of arbitrary-width values read from the
+stream according to <a href="#vorbis-spec-bitpacking" title="2. Bitpacking Convention">Section 2, “Bitpacking Convention”</a>.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id329366"></a>3.2. Packed codebook format</h3></div></div></div><p>
+For purposes of the examples below, we assume that the storage
+system's native byte width is eight bits. This is not universally
+true; see <a href="#vorbis-spec-bitpacking" title="2. Bitpacking Convention">Section 2, “Bitpacking Convention”</a> for discussion
+relating to non-eight-bit bytes.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id310869"></a>3.2.1. codebook decode</h4></div></div></div><p>
+A codebook begins with a 24 bit sync pattern, 0x564342:
+
+</p><pre class="screen">
+byte 0: [ 0 1 0 0 0 0 1 0 ] (0x42)
+byte 1: [ 0 1 0 0 0 0 1 1 ] (0x43)
+byte 2: [ 0 1 0 1 0 1 1 0 ] (0x56)
+</pre><p>
+16 bit <code class="varname">[codebook_dimensions]</code> and 24 bit <code class="varname">[codebook_entries]</code> fields:
+
+</p><pre class="screen">
+
+byte 3: [ X X X X X X X X ]
+byte 4: [ X X X X X X X X ] [codebook_dimensions] (16 bit unsigned)
+
+byte 5: [ X X X X X X X X ]
+byte 6: [ X X X X X X X X ]
+byte 7: [ X X X X X X X X ] [codebook_entries] (24 bit unsigned)
+
+</pre><p>
+Next is the <code class="varname">[ordered]</code> bit flag:
+
+</p><pre class="screen">
+
+byte 8: [ X ] [ordered] (1 bit)
+
+</pre><p>
+Each entry, numbering a
+total of <code class="varname">[codebook_entries]</code>, is assigned a codeword length.
+We now read the list of codeword lengths and store these lengths in
+the array <code class="varname">[codebook_codeword_lengths]</code>. Decode of lengths is
+according to whether the <code class="varname">[ordered]</code> flag is set or unset.
+
+</p><div class="itemizedlist"><ul type="disc"><li><p>If the <code class="varname">[ordered]</code> flag is unset, the codeword list is not
+ length ordered and the decoder needs to read each codeword length
+ one-by-one.</p><p>The decoder first reads one additional bit flag, the
+ <code class="varname">[sparse]</code> flag. This flag determines whether or not the
+ codebook contains unused entries that are not to be included in the
+ codeword decode tree:
+
+</p><pre class="screen">
+byte 8: [ X 1 ] [sparse] flag (1 bit)
+</pre><p>
+ The decoder now performs for each of the <code class="varname">[codebook_entries]</code>
+ codebook entries:
+
+</p><pre class="screen">
+
+ 1) if([sparse] is set){
+
+ 2) [flag] = read one bit;
+ 3) if([flag] is set){
+
+ 4) [length] = read a five bit unsigned integer;
+ 5) codeword length for this entry is [length]+1;
+
+ } else {
+
+ 6) this entry is unused. mark it as such.
+
+ }
+
+ } else the sparse flag is not set {
+
+ 7) [length] = read a five bit unsigned integer;
+ 8) the codeword length for this entry is [length]+1;
+
+ }
+
+</pre></li><li><p>If the <code class="varname">[ordered]</code> flag is set, the codeword list for this
+ codebook is encoded in ascending length order. Rather than reading
+ a length for every codeword, the encoder reads the number of
+ codewords per length. That is, beginning at entry zero:
+
+</p><pre class="screen">
+ 1) [current_entry] = 0;
+ 2) [current_length] = read a five bit unsigned integer and add 1;
+ 3) [number] = read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>([codebook_entries] - [current_entry]) bits as an unsigned integer
+ 4) set the entries [current_entry] through [current_entry]+[number]-1, inclusive,
+ of the [codebook_codeword_lengths] array to [current_length]
+ 5) set [current_entry] to [number] + [current_entry]
+ 6) increment [current_length] by 1
+ 7) if [current_entry] is greater than [codebook_entries] ERROR CONDITION;
+ the decoder will not be able to read this stream.
+ 8) if [current_entry] is less than [codebook_entries], repeat process starting at 3)
+ 9) done.
+</pre></li></ul></div><p>
+
+After all codeword lengths have been decoded, the decoder reads the
+vector lookup table. Vorbis I supports three lookup types:
+</p><div class="orderedlist"><ol type="1"><li>No lookup</li><li>Implicitly populated value mapping (lattice VQ)</li><li>Explicitly populated value mapping (tessellated or 'foam'
+VQ)</li></ol></div><p>
+</p><p>
+The lookup table type is read as a four bit unsigned integer:
+</p><pre class="screen">
+ 1) [codebook_lookup_type] = read four bits as an unsigned integer
+</pre><p>
+Codebook decode precedes according to <code class="varname">[codebook_lookup_type]</code>:
+</p><div class="itemizedlist"><ul type="disc"><li><p>Lookup type zero indicates no lookup to be read. Proceed past
+lookup decode.</p></li><li><p>Lookup types one and two are similar, differing only in the
+number of lookup values to be read. Lookup type one reads a list of
+values that are permuted in a set pattern to build a list of vectors,
+each vector of order <code class="varname">[codebook_dimensions]</code> scalars. Lookup
+type two builds the same vector list, but reads each scalar for each
+vector explicitly, rather than building vectors from a smaller list of
+possible scalar values. Lookup decode proceeds as follows:
+
+</p><pre class="screen">
+ 1) [codebook_minimum_value] = <a href="#vorbis-spec-float32_unpack" title="9.2.2. float32_unpack">float32_unpack</a>( read 32 bits as an unsigned integer)
+ 2) [codebook_delta_value] = <a href="#vorbis-spec-float32_unpack" title="9.2.2. float32_unpack">float32_unpack</a>( read 32 bits as an unsigned integer)
+ 3) [codebook_value_bits] = read 4 bits as an unsigned integer and add 1
+ 4) [codebook_sequence_p] = read 1 bit as a boolean flag
+
+ if ( [codebook_lookup_type] is 1 ) {
+
+ 5) [codebook_lookup_values] = <a href="#vorbis-spec-lookup1_values" title="9.2.3. lookup1_values">lookup1_values</a>(<code class="varname">[codebook_entries]</code>, <code class="varname">[codebook_dimensions]</code> )
+
+ } else {
+
+ 6) [codebook_lookup_values] = <code class="varname">[codebook_entries]</code> * <code class="varname">[codebook_dimensions]</code>
+
+ }
+
+ 7) read a total of [codebook_lookup_values] unsigned integers of [codebook_value_bits] each;
+ store these in order in the array [codebook_multiplicands]
+</pre></li><li><p>A <code class="varname">[codebook_lookup_type]</code> of greater than two is reserved
+and indicates a stream that is not decodable by the specification in this
+document.</p></li></ul></div><p>
+</p><p>
+An 'end of packet' during any read operation in the above steps is
+considered an error condition rendering the stream undecodable.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id257433"></a>3.2.1.1. Huffman decision tree representation</h5></div></div></div><p>
+The <code class="varname">[codebook_codeword_lengths]</code> array and
+<code class="varname">[codebook_entries]</code> value uniquely define the Huffman decision
+tree used for entropy decoding.</p><p>
+Briefly, each used codebook entry (recall that length-unordered
+codebooks support unused codeword entries) is assigned, in order, the
+lowest valued unused binary Huffman codeword possible. Assume the
+following codeword length list:
+
+</p><pre class="screen">
+entry 0: length 2
+entry 1: length 4
+entry 2: length 4
+entry 3: length 4
+entry 4: length 4
+entry 5: length 2
+entry 6: length 3
+entry 7: length 3
+</pre><p>
+Assigning codewords in order (lowest possible value of the appropriate
+length to highest) results in the following codeword list:
+
+</p><pre class="screen">
+entry 0: length 2 codeword 00
+entry 1: length 4 codeword 0100
+entry 2: length 4 codeword 0101
+entry 3: length 4 codeword 0110
+entry 4: length 4 codeword 0111
+entry 5: length 2 codeword 10
+entry 6: length 3 codeword 110
+entry 7: length 3 codeword 111
+</pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+Unlike most binary numerical values in this document, we
+intend the above codewords to be read and used bit by bit from left to
+right, thus the codeword '001' is the bit string 'zero, zero, one'.
+When determining 'lowest possible value' in the assignment definition
+above, the leftmost bit is the MSb.</p></div><p>
+It is clear that the codeword length list represents a Huffman
+decision tree with the entry numbers equivalent to the leaves numbered
+left-to-right:
+
+</p><div class="mediaobject"><img src="hufftree.png" alt="[huffman tree illustration]"></div><p>
+</p><p>
+As we assign codewords in order, we see that each choice constructs a
+new leaf in the leftmost possible position.</p><p>
+Note that it's possible to underspecify or overspecify a Huffman tree
+via the length list. In the above example, if codeword seven were
+eliminated, it's clear that the tree is unfinished:
+
+</p><div class="mediaobject"><img src="hufftree-under.png" alt="[underspecified huffman tree illustration]"></div><p>
+</p><p>
+Similarly, in the original codebook, it's clear that the tree is fully
+populated and a ninth codeword is impossible. Both underspecified and
+overspecified trees are an error condition rendering the stream
+undecodable.</p><p>
+Codebook entries marked 'unused' are simply skipped in the assigning
+process. They have no codeword and do not appear in the decision
+tree, thus it's impossible for any bit pattern read from the stream to
+decode to that entry number.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id320556"></a>3.2.1.2. VQ lookup table vector representation</h5></div></div></div><p>
+Unpacking the VQ lookup table vectors relies on the following values:
+</p><pre class="programlisting">
+the [codebook_multiplicands] array
+[codebook_minimum_value]
+[codebook_delta_value]
+[codebook_sequence_p]
+[codebook_lookup_type]
+[codebook_entries]
+[codebook_dimensions]
+[codebook_lookup_values]
+</pre><p>
+</p><p>
+Decoding (unpacking) a specific vector in the vector lookup table
+proceeds according to <code class="varname">[codebook_lookup_type]</code>. The unpacked
+vector values are what a codebook would return during audio packet
+decode in a VQ context.</p><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id320581"></a>3.2.1.2.1. Vector value decode: Lookup type 1</h6></div></div></div><p>
+Lookup type one specifies a lattice VQ lookup table built
+algorithmically from a list of scalar values. Calculate (unpack) the
+final values of a codebook entry vector from the entries in
+<code class="varname">[codebook_multiplicands]</code> as follows (<code class="varname">[value_vector]</code>
+is the output vector representing the vector of values for entry number
+<code class="varname">[lookup_offset]</code> in this codebook):
+
+</p><pre class="screen">
+ 1) [last] = 0;
+ 2) [index_divisor] = 1;
+ 3) iterate [i] over the range 0 ... [codebook_dimensions]-1 (once for each scalar value in the value vector) {
+
+ 4) [multiplicand_offset] = ( [lookup_offset] divided by [index_divisor] using integer
+ division ) integer modulo [codebook_lookup_values]
+
+ 5) vector [value_vector] element [i] =
+ ( [codebook_multiplicands] array element number [multiplicand_offset] ) *
+ [codebook_delta_value] + [codebook_minimum_value] + [last];
+
+ 6) if ( [codebook_sequence_p] is set ) then set [last] = vector [value_vector] element [i]
+
+ 7) [index_divisor] = [index_divisor] * [codebook_lookup_values]
+
+ }
+
+ 8) vector calculation completed.
+</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id320614"></a>3.2.1.2.2. Vector value decode: Lookup type 2</h6></div></div></div><p>
+Lookup type two specifies a VQ lookup table in which each scalar in
+each vector is explicitly set by the <code class="varname">[codebook_multiplicands]</code>
+array in a one-to-one mapping. Calculate [unpack] the
+final values of a codebook entry vector from the entries in
+<code class="varname">[codebook_multiplicands]</code> as follows (<code class="varname">[value_vector]</code>
+is the output vector representing the vector of values for entry number
+<code class="varname">[lookup_offset]</code> in this codebook):
+
+</p><pre class="screen">
+ 1) [last] = 0;
+ 2) [multiplicand_offset] = [lookup_offset] * [codebook_dimensions]
+ 3) iterate [i] over the range 0 ... [codebook_dimensions]-1 (once for each scalar value in the value vector) {
+
+ 4) vector [value_vector] element [i] =
+ ( [codebook_multiplicands] array element number [multiplicand_offset] ) *
+ [codebook_delta_value] + [codebook_minimum_value] + [last];
+
+ 5) if ( [codebook_sequence_p] is set ) then set [last] = vector [value_vector] element [i]
+
+ 6) increment [multiplicand_offset]
+
+ }
+
+ 7) vector calculation completed.
+</pre></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id320654"></a>3.3. Use of the codebook abstraction</h3></div></div></div><p>
+The decoder uses the codebook abstraction much as it does the
+bit-unpacking convention; a specific codebook reads a
+codeword from the bitstream, decoding it into an entry number, and then
+returns that entry number to the decoder (when used in a scalar
+entropy coding context), or uses that entry number as an offset into
+the VQ lookup table, returning a vector of values (when used in a context
+desiring a VQ value). Scalar or VQ context is always explicit; any call
+to the codebook mechanism requests either a scalar entry number or a
+lookup vector.</p><p>
+Note that VQ lookup type zero indicates that there is no lookup table;
+requesting decode using a codebook of lookup type 0 in any context
+expecting a vector return value (even in a case where a vector of
+dimension one) is forbidden. If decoder setup or decode requests such
+an action, that is an error condition rendering the packet
+undecodable.</p><p>
+Using a codebook to read from the packet bitstream consists first of
+reading and decoding the next codeword in the bitstream. The decoder
+reads bits until the accumulated bits match a codeword in the
+codebook. This process can be though of as logically walking the
+Huffman decode tree by reading one bit at a time from the bitstream,
+and using the bit as a decision boolean to take the 0 branch (left in
+the above examples) or the 1 branch (right in the above examples).
+Walking the tree finishes when the decode process hits a leaf in the
+decision tree; the result is the entry number corresponding to that
+leaf. Reading past the end of a packet propagates the 'end-of-stream'
+condition to the decoder.</p><p>
+When used in a scalar context, the resulting codeword entry is the
+desired return value.</p><p>
+When used in a VQ context, the codeword entry number is used as an
+offset into the VQ lookup table. The value returned to the decoder is
+the vector of scalars corresponding to this offset.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-codec"></a>4. Codec Setup and Packet Decode</h2></div><div><p class="releaseinfo">
+ $Id: 04-codec.xml 10466 2005-11-28 00:34:44Z giles $
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id332455"></a>4.1. Overview</h3></div></div></div><p>
+This document serves as the top-level reference document for the
+bit-by-bit decode specification of Vorbis I. This document assumes a
+high-level understanding of the Vorbis decode process, which is
+provided in <a href="#vorbis-spec-intro" title="1. Introduction and Description">Section 1, “Introduction and Description”</a>. <a href="#vorbis-spec-bitpacking" title="2. Bitpacking Convention">Section 2, “Bitpacking Convention”</a> covers reading and writing bit fields from
+and to bitstream packets.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id332825"></a>4.2. Header decode and decode setup</h3></div></div></div><p>
+A Vorbis bitstream begins with three header packets. The header
+packets are, in order, the identification header, the comments header,
+and the setup header. All are required for decode compliance. An
+end-of-packet condition during decoding the first or third header
+packet renders the stream undecodable. End-of-packet decoding the
+comment header is a non-fatal error condition.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id313589"></a>4.2.1. Common header decode</h4></div></div></div><p>
+Each header packet begins with the same header fields.
+</p><pre class="screen">
+ 1) [packet_type] : 8 bit value
+ 2) 0x76, 0x6f, 0x72, 0x62, 0x69, 0x73: the characters 'v','o','r','b','i','s' as six octets
+</pre><p>
+Decode continues according to packet type; the identification header
+is type 1, the comment header type 3 and the setup header type 5
+(these types are all odd as a packet with a leading single bit of '0'
+is an audio packet). The packets must occur in the order of
+identification, comment, setup.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id339332"></a>4.2.2. Identification header</h4></div></div></div><p>
+The identification header is a short header of only a few fields used
+to declare the stream definitively as Vorbis, and provide a few externally
+relevant pieces of information about the audio stream. The
+identification header is coded as follows:</p><pre class="screen">
+ 1) [vorbis_version] = read 32 bits as unsigned integer
+ 2) [audio_channels] = read 8 bit integer as unsigned
+ 3) [audio_sample_rate] = read 32 bits as unsigned integer
+ 4) [bitrate_maximum] = read 32 bits as signed integer
+ 5) [bitrate_nominal] = read 32 bits as signed integer
+ 6) [bitrate_minimum] = read 32 bits as signed integer
+ 7) [blocksize_0] = 2 exponent (read 4 bits as unsigned integer)
+ 8) [blocksize_1] = 2 exponent (read 4 bits as unsigned integer)
+ 9) [framing_flag] = read one bit
+</pre><p>
+<code class="varname">[vorbis_version]</code> is to read '0' in order to be compatible
+with this document. Both <code class="varname">[audio_channels]</code> and
+<code class="varname">[audio_sample_rate]</code> must read greater than zero. Allowed final
+blocksize values are 64, 128, 256, 512, 1024, 2048, 4096 and 8192 in
+Vorbis I. <code class="varname">[blocksize_0]</code> must be less than or equal to
+<code class="varname">[blocksize_1]</code>. The framing bit must be nonzero. Failure to
+meet any of these conditions renders a stream undecodable.</p><p>
+The bitrate fields above are used only as hints. The nominal bitrate
+field especially may be considerably off in purely VBR streams. The
+fields are meaningful only when greater than zero.</p><p>
+</p><div class="itemizedlist"><ul type="disc"><li>All three fields set to the same value implies a fixed rate, or tightly bounded, nearly fixed-rate bitstream</li><li>Only nominal set implies a VBR or ABR stream that averages the nominal bitrate</li><li>Maximum and or minimum set implies a VBR bitstream that obeys the bitrate limits</li><li>None set indicates the encoder does not care to speculate.</li></ul></div><p>
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id320761"></a>4.2.3. Comment header</h4></div></div></div><p>
+Comment header decode and data specification is covered in
+<a href="#vorbis-spec-comment" title="5. comment field and header specification">Section 5, “comment field and header specification”</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id317509"></a>4.2.4. Setup header</h4></div></div></div><p>
+Vorbis codec setup is configurable to an extreme degree:
+
+</p><div class="mediaobject"><img src="components.png" alt="[decoder pipeline configuration]"></div><p>
+</p><p>
+The setup header contains the bulk of the codec setup information
+needed for decode. The setup header contains, in order, the lists of
+codebook configurations, time-domain transform configurations
+(placeholders in Vorbis I), floor configurations, residue
+configurations, channel mapping configurations and mode
+configurations. It finishes with a framing bit of '1'. Header decode
+proceeds in the following order:</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id317547"></a>4.2.4.1. Codebooks</h5></div></div></div><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_codebook_count]</code> = read eight bits as unsigned integer and add one</li><li>Decode <code class="varname">[vorbis_codebook_count]</code> codebooks in order as defined
+in <a href="#vorbis-spec-codebook" title="3. Probability Model and Codebooks">Section 3, “Probability Model and Codebooks”</a>. Save each configuration, in
+order, in an array of
+codebook configurations <code class="varname">[vorbis_codebook_configurations]</code>.</li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id309581"></a>4.2.4.2. Time domain transforms</h5></div></div></div><p>
+These hooks are placeholders in Vorbis I. Nevertheless, the
+configuration placeholder values must be read to maintain bitstream
+sync.</p><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_time_count]</code> = read 6 bits as unsigned integer and add one</li><li>read <code class="varname">[vorbis_time_count]</code> 16 bit values; each value should be zero. If any value is nonzero, this is an error condition and the stream is undecodable.</li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id309616"></a>4.2.4.3. Floors</h5></div></div></div><p>
+Vorbis uses two floor types; header decode is handed to the decode
+abstraction of the appropriate type.</p><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_floor_count]</code> = read 6 bits as unsigned integer and add one</li><li><p>For each <code class="varname">[i]</code> of <code class="varname">[vorbis_floor_count]</code> floor numbers:
+ </p><div class="orderedlist"><ol type="a"><li>read the floor type: vector <code class="varname">[vorbis_floor_types]</code> element <code class="varname">[i]</code> =
+read 16 bits as unsigned integer</li><li>If the floor type is zero, decode the floor
+configuration as defined in <a href="#vorbis-spec-floor0" title="6. Floor type 0 setup and decode">Section 6, “Floor type 0 setup and decode”</a>; save
+this
+configuration in slot <code class="varname">[i]</code> of the floor configuration array <code class="varname">[vorbis_floor_configurations]</code>.</li><li>If the floor type is one,
+decode the floor configuration as defined in <a href="#vorbis-spec-floor1" title="7. Floor type 1 setup and decode">Section 7, “Floor type 1 setup and decode”</a>; save this configuration in slot <code class="varname">[i]</code> of the floor configuration array <code class="varname">[vorbis_floor_configurations]</code>.</li><li>If the the floor type is greater than one, this stream is undecodable; ERROR CONDITION</li></ol></div><p>
+ </p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id273566"></a>4.2.4.4. Residues</h5></div></div></div><p>
+Vorbis uses three residue types; header decode of each type is identical.
+</p><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_residue_count]</code> = read 6 bits as unsigned integer and add one
+</li><li><p>For each of <code class="varname">[vorbis_residue_count]</code> residue numbers:
+ </p><div class="orderedlist"><ol type="a"><li>read the residue type; vector <code class="varname">[vorbis_residue_types]</code> element <code class="varname">[i]</code> = read 16 bits as unsigned integer</li><li>If the residue type is zero,
+one or two, decode the residue configuration as defined in <a href="#vorbis-spec-residue" title="8. Residue setup and decode">Section 8, “Residue setup and decode”</a>; save this configuration in slot <code class="varname">[i]</code> of the residue configuration array <code class="varname">[vorbis_residue_configurations]</code>.</li><li>If the the residue type is greater than two, this stream is undecodable; ERROR CONDITION</li></ol></div><p>
+</p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id273643"></a>4.2.4.5. Mappings</h5></div></div></div><p>
+Mappings are used to set up specific pipelines for encoding
+multichannel audio with varying channel mapping applications. Vorbis I
+uses a single mapping type (0), with implicit PCM channel mappings.</p><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_mapping_count]</code> = read 6 bits as unsigned integer and add one</li><li><p>For each <code class="varname">[i]</code> of <code class="varname">[vorbis_mapping_count]</code> mapping numbers:
+ </p><div class="orderedlist"><ol type="a"><li>read the mapping type: 16 bits as unsigned integer. There's no reason to save the mapping type in Vorbis I.</li><li>If the mapping type is nonzero, the stream is undecodable</li><li><p>If the mapping type is zero:
+ </p><div class="orderedlist"><ol type="i"><li><p>read 1 bit as a boolean flag
+ </p><div class="orderedlist"><ol type="A"><li>if set, <code class="varname">[vorbis_mapping_submaps]</code> = read 4 bits as unsigned integer and add one</li><li>if unset, <code class="varname">[vorbis_mapping_submaps]</code> = 1</li></ol></div><p>
+ </p></li><li><p>read 1 bit as a boolean flag
+ </p><div class="orderedlist"><ol type="A"><li><p>if set, square polar channel mapping is in use:
+ </p><div class="orderedlist"><ol type="I"><li><code class="varname">[vorbis_mapping_coupling_steps]</code> = read 8 bits as unsigned integer and add one</li><li><p>for <code class="varname">[j]</code> each of <code class="varname">[vorbis_mapping_coupling_steps]</code> steps:
+ </p><div class="orderedlist"><ol type="1"><li>vector <code class="varname">[vorbis_mapping_magnitude]</code> element <code class="varname">[j]</code>= read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>(<code class="varname">[audio_channels]</code> - 1) bits as unsigned integer</li><li>vector <code class="varname">[vorbis_mapping_angle]</code> element <code class="varname">[j]</code>= read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>(<code class="varname">[audio_channels]</code> - 1) bits as unsigned integer</li><li>the numbers read in the above two steps are channel numbers representing the channel to treat as magnitude and the channel to treat as angle, respectively. If for any coupling step the angle channel number equals the magnitude channel number, the magnitude channel number is greater than <code class="varname">[audio_channels]</code>-1, or the angle channel is greater than <code class="varname">[audio_channels]</code>-1, the st
ream is undecodable.</li></ol></div><p>
+ </p></li></ol></div><p>
+ </p></li><li>if unset, <code class="varname">[vorbis_mapping_coupling_steps]</code> = 0</li></ol></div><p>
+ </p></li><li>read 2 bits (reserved field); if the value is nonzero, the stream is undecodable</li><li><p>if <code class="varname">[vorbis_mapping_submaps]</code> is greater than one, we read channel multiplex settings. For each <code class="varname">[j]</code> of <code class="varname">[audio_channels]</code> channels:</p><div class="orderedlist"><ol type="A"><li>vector <code class="varname">[vorbis_mapping_mux]</code> element <code class="varname">[j]</code> = read 4 bits as unsigned integer</li><li>if the value is greater than the highest numbered submap (<code class="varname">[vorbis_mapping_submaps]</code> - 1), this in an error condition rendering the stream undecodable</li></ol></div></li><li><p>for each submap <code class="varname">[j]</code> of <code class="varname">[vorbis_mapping_submaps]</code> submaps, read the floor and residue numbers for use in decoding that submap:</p><div class="orderedlist"><ol type="A"><li>read and discard 8 bits (the unused time con
figuration placeholder)</li><li>read 8 bits as unsigned integer for the floor number; save in vector <code class="varname">[vorbis_mapping_submap_floor]</code> element <code class="varname">[j]</code></li><li>verify the floor number is not greater than the highest number floor configured for the bitstream. If it is, the bitstream is undecodable</li><li>read 8 bits as unsigned integer for the residue number; save in vector <code class="varname">[vorbis_mapping_submap_residue]</code> element <code class="varname">[j]</code></li><li>verify the residue number is not greater than the highest number residue configured for the bitstream. If it is, the bitstream is undecodable</li></ol></div></li><li>save this mapping configuration in slot <code class="varname">[i]</code> of the mapping configuration array <code class="varname">[vorbis_mapping_configurations]</code>.</li></ol></div></li></ol></div><p>
+ </p></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id341202"></a>4.2.4.6. Modes</h5></div></div></div><div class="orderedlist"><ol type="1"><li><code class="varname">[vorbis_mode_count]</code> = read 6 bits as unsigned integer and add one</li><li><p>For each of <code class="varname">[vorbis_mode_count]</code> mode numbers:</p><div class="orderedlist"><ol type="a"><li><code class="varname">[vorbis_mode_blockflag]</code> = read 1 bit</li><li><code class="varname">[vorbis_mode_windowtype]</code> = read 16 bits as unsigned integer</li><li><code class="varname">[vorbis_mode_transformtype]</code> = read 16 bits as unsigned integer</li><li><code class="varname">[vorbis_mode_mapping]</code> = read 8 bits as unsigned integer</li><li>verify ranges; zero is the only legal value in Vorbis I for
+<code class="varname">[vorbis_mode_windowtype]</code>
+and <code class="varname">[vorbis_mode_transformtype]</code>. <code class="varname">[vorbis_mode_mapping]</code> must not be greater than the highest number mapping in use. Any illegal values render the stream undecodable.</li><li>save this mode configuration in slot <code class="varname">[i]</code> of the mode configuration array
+<code class="varname">[vorbis_mode_configurations]</code>.</li></ol></div></li><li>read 1 bit as a framing flag. If unset, a framing error occurred and the stream is not
+decodable.</li></ol></div><p>
+After reading mode descriptions, setup header decode is complete.
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id341314"></a>4.3. Audio packet decode and synthesis</h3></div></div></div><p>
+Following the three header packets, all packets in a Vorbis I stream
+are audio. The first step of audio packet decode is to read and
+verify the packet type. <span class="emphasis"><em>A non-audio packet when audio is expected
+indicates stream corruption or a non-compliant stream. The decoder
+must ignore the packet and not attempt decoding it to audio</em></span>.
+</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id341330"></a>4.3.1. packet type, mode and window decode</h4></div></div></div><div class="orderedlist"><ol type="1"><li>read 1 bit <code class="varname">[packet_type]</code>; check that packet type is 0 (audio)</li><li>read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>([vorbis_mode_count]-1) bits
+<code class="varname">[mode_number]</code></li><li>decode blocksize <code class="varname">[n]</code> is equal to <code class="varname">[blocksize_0]</code> if
+<code class="varname">[vorbis_mode_blockflag]</code> is 0, else <code class="varname">[n]</code> is equal to <code class="varname">[blocksize_1]</code>.</li><li><p>perform window selection and setup; this window is used later by the inverse MDCT:</p><div class="orderedlist"><ol type="a"><li><p>if this is a long window (the <code class="varname">[vorbis_mode_blockflag]</code> flag of this mode is
+set):</p><div class="orderedlist"><ol type="i"><li>read 1 bit for <code class="varname">[previous_window_flag]</code></li><li>read 1 bit for <code class="varname">[next_window_flag]</code></li><li>if <code class="varname">[previous_window_flag]</code> is not set, the left half
+ of the window will be a hybrid window for lapping with a
+ short block. See <a href="#vorbis-spec-window" title="1.3.2.3. Window shape decode (long windows only)">Section 1.3.2.3, “Window shape decode (long windows only)”</a> for an illustration of overlapping
+dissimilar
+ windows. Else, the left half window will have normal long
+ shape.</li><li>if <code class="varname">[next_window_flag]</code> is not set, the right half of
+ the window will be a hybrid window for lapping with a short
+ block. See <a href="#vorbis-spec-window" title="1.3.2.3. Window shape decode (long windows only)">Section 1.3.2.3, “Window shape decode (long windows only)”</a> for an
+illustration of overlapping dissimilar
+ windows. Else, the left right window will have normal long
+ shape.</li></ol></div></li><li> if this is a short window, the window is always the same
+ short-window shape.</li></ol></div></li></ol></div><p>
+Vorbis windows all use the slope function y=sin(0.5 * π * sin^2((x+.5)/n * π)),
+where n is window size and x ranges 0...n-1, but dissimilar
+lapping requirements can affect overall shape. Window generation
+proceeds as follows:</p><div class="orderedlist"><ol type="1"><li> <code class="varname">[window_center]</code> = <code class="varname">[n]</code> / 2</li><li><p> if (<code class="varname">[vorbis_mode_blockflag]</code> is set and <code class="varname">[previous_window_flag]</code> is
+not set) then
+ </p><div class="orderedlist"><ol type="a"><li><code class="varname">[left_window_start]</code> = <code class="varname">[n]</code>/4 -
+<code class="varname">[blocksize_0]</code>/4</li><li><code class="varname">[left_window_end]</code> = <code class="varname">[n]</code>/4 + <code class="varname">[blocksize_0]</code>/4</li><li><code class="varname">[left_n]</code> = <code class="varname">[blocksize_0]</code>/2</li></ol></div><p>
+ else
+ </p><div class="orderedlist"><ol type="a"><li><code class="varname">[left_window_start]</code> = 0</li><li><code class="varname">[left_window_end]</code> = <code class="varname">[window_center]</code></li><li><code class="varname">[left_n]</code> = <code class="varname">[n]</code>/2</li></ol></div></li><li><p> if (<code class="varname">[vorbis_mode_blockflag]</code> is set and <code class="varname">[next_window_flag]</code> is not
+set) then
+ </p><div class="orderedlist"><ol type="a"><li><code class="varname">[right_window_start]</code> = <code class="varname">[n]*3</code>/4 -
+<code class="varname">[blocksize_0]</code>/4</li><li><code class="varname">[right_window_end]</code> = <code class="varname">[n]*3</code>/4 +
+<code class="varname">[blocksize_0]</code>/4</li><li><code class="varname">[right_n]</code> = <code class="varname">[blocksize_0]</code>/2</li></ol></div><p>
+ else
+ </p><div class="orderedlist"><ol type="a"><li><code class="varname">[right_window_start]</code> = <code class="varname">[window_center]</code></li><li><code class="varname">[right_window_end]</code> = <code class="varname">[n]</code></li><li><code class="varname">[right_n]</code> = <code class="varname">[n]</code>/2</li></ol></div></li><li> window from range 0 ... <code class="varname">[left_window_start]</code>-1 inclusive is zero</li><li> for <code class="varname">[i]</code> in range <code class="varname">[left_window_start]</code> ...
+<code class="varname">[left_window_end]</code>-1, window(<code class="varname">[i]</code>) = sin(.5 * π * sin^2( (<code class="varname">[i]</code>-<code class="varname">[left_window_start]</code>+.5) / <code class="varname">[left_n]</code> * .5 * π) )</li><li> window from range <code class="varname">[left_window_end]</code> ... <code class="varname">[right_window_start]</code>-1
+inclusive is one</li><li> for <code class="varname">[i]</code> in range <code class="varname">[right_window_start]</code> ... <code class="varname">[right_window_end]</code>-1, window(<code class="varname">[i]</code>) = sin(.5 * π * sin^2( (<code class="varname">[i]</code>-<code class="varname">[right_window_start]</code>+.5) / <code class="varname">[right_n]</code> * .5 * π + .5 * π) )</li><li> window from range <code class="varname">[right_window_start]</code> ... <code class="varname">[n]</code>-1 is
+zero</li></ol></div><p>
+An end-of-packet condition up to this point should be considered an
+error that discards this packet from the stream. An end of packet
+condition past this point is to be considered a possible nominal
+occurrence.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id341794"></a>4.3.2. floor curve decode</h4></div></div></div><p>
+From this point on, we assume out decode context is using mode number
+<code class="varname">[mode_number]</code> from configuration array
+<code class="varname">[vorbis_mode_configurations]</code> and the map number
+<code class="varname">[vorbis_mode_mapping]</code> (specified by the current mode) taken
+from the mapping configuration array
+<code class="varname">[vorbis_mapping_configurations]</code>.</p><p>
+Floor curves are decoded one-by-one in channel order.</p><p>
+For each floor <code class="varname">[i]</code> of <code class="varname">[audio_channels]</code>
+ </p><div class="orderedlist"><ol type="1"><li><code class="varname">[submap_number]</code> = element <code class="varname">[i]</code> of vector [vorbis_mapping_mux]</li><li><code class="varname">[floor_number]</code> = element <code class="varname">[submap_number]</code> of vector
+[vorbis_submap_floor]</li><li>if the floor type of this
+floor (vector <code class="varname">[vorbis_floor_types]</code> element
+<code class="varname">[floor_number]</code>) is zero then decode the floor for
+channel <code class="varname">[i]</code> according to the
+<a href="#vorbis-spec-floor0-decode" title="6.2.2. packet decode">Section 6.2.2, “packet decode”</a></li><li>if the type of this floor
+is one then decode the floor for channel <code class="varname">[i]</code> according
+to the <a href="#vorbis-spec-floor1-decode" title="7.2.2.1. packet decode">Section 7.2.2.1, “packet decode”</a></li><li>save the needed decoded floor information for channel for later synthesis</li><li>if the decoded floor returned 'unused', set vector <code class="varname">[no_residue]</code> element
+<code class="varname">[i]</code> to true, else set vector <code class="varname">[no_residue]</code> element <code class="varname">[i]</code> to
+false</li></ol></div><p>
+</p><p>
+An end-of-packet condition during floor decode shall result in packet
+decode zeroing all channel output vectors and skipping to the
+add/overlap output stage.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id341927"></a>4.3.3. nonzero vector propagate</h4></div></div></div><p>
+A possible result of floor decode is that a specific vector is marked
+'unused' which indicates that that final output vector is all-zero
+values (and the floor is zero). The residue for that vector is not
+coded in the stream, save for one complication. If some vectors are
+used and some are not, channel coupling could result in mixing a
+zeroed and nonzeroed vector to produce two nonzeroed vectors.</p><p>
+for each <code class="varname">[i]</code> from 0 ... <code class="varname">[vorbis_mapping_coupling_steps]</code>-1
+
+</p><div class="orderedlist"><ol type="1"><li>if either <code class="varname">[no_residue]</code> entry for channel
+(<code class="varname">[vorbis_mapping_magnitude]</code> element <code class="varname">[i]</code>)
+or channel
+(<code class="varname">[vorbis_mapping_angle]</code> element <code class="varname">[i]</code>)
+are set to false, then both must be set to false. Note that an 'unused'
+floor has no decoded floor information; it is important that this is
+remembered at floor curve synthesis time.</li></ol></div><p>
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id341985"></a>4.3.4. residue decode</h4></div></div></div><p>
+Unlike floors, which are decoded in channel order, the residue vectors
+are decoded in submap order.</p><p>
+for each submap <code class="varname">[i]</code> in order from 0 ... <code class="varname">[vorbis_mapping_submaps]</code>-1</p><div class="orderedlist"><ol type="1"><li><code class="varname">[ch]</code> = 0</li><li><p>for each channel <code class="varname">[j]</code> in order from 0 ... <code class="varname">[audio_channels]</code> - 1</p><div class="orderedlist"><ol type="a"><li><p>if channel <code class="varname">[j]</code> in submap <code class="varname">[i]</code> (vector <code class="varname">[vorbis_mapping_mux]</code> element <code class="varname">[j]</code> is equal to <code class="varname">[i]</code>)</p><div class="orderedlist"><ol type="i"><li><p>if vector <code class="varname">[no_residue]</code> element <code class="varname">[j]</code> is true
+ </p><div class="orderedlist"><ol type="A"><li>vector <code class="varname">[do_not_decode_flag]</code> element <code class="varname">[ch]</code> is set</li></ol></div><p>
+ else
+ </p><div class="orderedlist"><ol type="A"><li>vector <code class="varname">[do_not_decode_flag]</code> element <code class="varname">[ch]</code> is unset</li></ol></div></li><li>increment <code class="varname">[ch]</code></li></ol></div></li></ol></div></li><li><code class="varname">[residue_number]</code> = vector <code class="varname">[vorbis_mapping_submap_residue]</code> element <code class="varname">[i]</code></li><li><code class="varname">[residue_type]</code> = vector <code class="varname">[vorbis_residue_types]</code> element <code class="varname">[residue_number]</code></li><li>decode <code class="varname">[ch]</code> vectors using residue <code class="varname">[residue_number]</code>, according to type <code class="varname">[residue_type]</code>, also passing vector <code class="varname">[do_not_decode_flag]</code> to indicate which vectors in the bundle should not be decoded. Correct per-vector decode length is <code class="varname">[n]</code>/2.</li><li><co
de class="varname">[ch]</code> = 0</li><li><p>for each channel <code class="varname">[j]</code> in order from 0 ... <code class="varname">[audio_channels]</code></p><div class="orderedlist"><ol type="a"><li><p>if channel <code class="varname">[j]</code> is in submap <code class="varname">[i]</code> (vector <code class="varname">[vorbis_mapping_mux]</code> element <code class="varname">[j]</code> is equal to <code class="varname">[i]</code>)</p><div class="orderedlist"><ol type="i"><li>residue vector for channel <code class="varname">[j]</code> is set to decoded residue vector <code class="varname">[ch]</code></li><li>increment <code class="varname">[ch]</code></li></ol></div></li></ol></div></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id342218"></a>4.3.5. inverse coupling</h4></div></div></div><p>
+for each <code class="varname">[i]</code> from <code class="varname">[vorbis_mapping_coupling_steps]</code>-1 descending to 0
+
+</p><div class="orderedlist"><ol type="1"><li><code class="varname">[magnitude_vector]</code> = the residue vector for channel
+(vector <code class="varname">[vorbis_mapping_magnitude]</code> element <code class="varname">[i]</code>)</li><li><code class="varname">[angle_vector]</code> = the residue vector for channel (vector
+<code class="varname">[vorbis_mapping_angle]</code> element <code class="varname">[i]</code>)</li><li><p>for each scalar value <code class="varname">[M]</code> in vector <code class="varname">[magnitude_vector]</code> and the corresponding scalar value <code class="varname">[A]</code> in vector <code class="varname">[angle_vector]</code>:</p><div class="orderedlist"><ol type="a"><li><p>if (<code class="varname">[M]</code> is greater than zero)
+ </p><div class="orderedlist"><ol type="i"><li><p>if (<code class="varname">[A]</code> is greater than zero)
+ </p><div class="orderedlist"><ol type="A"><li><code class="varname">[new_M]</code> = <code class="varname">[M]</code></li><li><code class="varname">[new_A]</code> = <code class="varname">[M]</code>-<code class="varname">[A]</code></li></ol></div><p>
+ else
+ </p><div class="orderedlist"><ol type="A"><li><code class="varname">[new_A]</code> = <code class="varname">[M]</code></li><li><code class="varname">[new_M]</code> = <code class="varname">[M]</code>+<code class="varname">[A]</code></li></ol></div><p>
+ </p></li></ol></div><p>
+ else
+ </p><div class="orderedlist"><ol type="i"><li><p>if (<code class="varname">[A]</code> is greater than zero)
+ </p><div class="orderedlist"><ol type="A"><li><code class="varname">[new_M]</code> = <code class="varname">[M]</code></li><li><code class="varname">[new_A]</code> = <code class="varname">[M]</code>+<code class="varname">[A]</code></li></ol></div><p>
+ else
+ </p><div class="orderedlist"><ol type="A"><li><code class="varname">[new_A]</code> = <code class="varname">[M]</code></li><li><code class="varname">[new_M]</code> = <code class="varname">[M]</code>-<code class="varname">[A]</code></li></ol></div><p>
+ </p></li></ol></div><p>
+ </p></li><li>set scalar value <code class="varname">[M]</code> in vector <code class="varname">[magnitude_vector]</code> to <code class="varname">[new_M]</code></li><li>set scalar value <code class="varname">[A]</code> in vector <code class="varname">[angle_vector]</code> to <code class="varname">[new_A]</code></li></ol></div></li></ol></div><p>
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id342463"></a>4.3.6. dot product</h4></div></div></div><p>
+For each channel, synthesize the floor curve from the decoded floor
+information, according to packet type. Note that the vector synthesis
+length for floor computation is <code class="varname">[n]</code>/2.</p><p>
+For each channel, multiply each element of the floor curve by each
+element of that channel's residue vector. The result is the dot
+product of the floor and residue vectors for each channel; the produced
+vectors are the length <code class="varname">[n]</code>/2 audio spectrum for each
+channel.</p><p>
+One point is worth mentioning about this dot product; a common mistake
+in a fixed point implementation might be to assume that a 32 bit
+fixed-point representation for floor and residue and direct
+multiplication of the vectors is sufficient for acceptable spectral
+depth in all cases because it happens to mostly work with the current
+Xiph.Org reference encoder. </p><p>
+However, floor vector values can span ~140dB (~24 bits unsigned), and
+the audio spectrum vector should represent a minimum of 120dB (~21
+bits with sign), even when output is to a 16 bit PCM device. For the
+residue vector to represent full scale if the floor is nailed to
+-140dB, it must be able to span 0 to +140dB. For the residue vector
+to reach full scale if the floor is nailed at 0dB, it must be able to
+represent -140dB to +0dB. Thus, in order to handle full range
+dynamics, a residue vector may span -140dB to +140dB entirely within
+spec. A 280dB range is approximately 48 bits with sign; thus the
+residue vector must be able to represent a 48 bit range and the dot
+product must be able to handle an effective 48 bit times 24 bit
+multiplication. This range may be achieved using large (64 bit or
+larger) integers, or implementing a movable binary point
+representation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id342502"></a>4.3.7. inverse MDCT</h4></div></div></div><p>
+Convert the audio spectrum vector of each channel back into time
+domain PCM audio via an inverse Modified Discrete Cosine Transform
+(MDCT). A detailed description of the MDCT is available in the paper
+<a href="http://www.iocon.com/resource/docs/ps/eusipco_corrected.ps" target="_top">“<span class="citetitle">The
+use of multirate filter banks for coding of high quality digital
+audio</span>”</a>, by T. Sporer, K. Brandenburg and B. Edler. The window
+function used for the MDCT is the function described earlier.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id342523"></a>4.3.8. overlap_add</h4></div></div></div><p>
+Windowed MDCT output is overlapped and added with the right hand data
+of the previous window such that the 3/4 point of the previous window
+is aligned with the 1/4 point of the current window (as illustrated in
+<a href="#vorbis-spec-window" title="1.3.2.3. Window shape decode (long windows only)">Section 1.3.2.3, “Window shape decode (long windows only)”</a>). The overlapped portion
+produced from overlapping the previous and current frame data is
+finished data to be returned by the decoder. This data spans from the
+center of the previous window to the center of the current window. In
+the case of same-sized windows, the amount of data to return is
+one-half block consisting of and only of the overlapped portions. When
+overlapping a short and long window, much of the returned range does not
+actually overlap. This does not damage transform orthogonality. Pay
+attention however to returning the correct data range; the amount of
+data to be returned is:
+
+</p><pre class="programlisting">
+window_blocksize(previous_window)/4+window_blocksize(current_window)/4
+</pre><p>
+
+from the center (element windowsize/2) of the previous window to the
+center (element windowsize/2-1, inclusive) of the current window.</p><p>
+Data is not returned from the first frame; it must be used to 'prime'
+the decode engine. The encoder accounts for this priming when
+calculating PCM offsets; after the first frame, the proper PCM output
+offset is '0' (as no data has been returned yet).</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id342556"></a>4.3.9. output channel order</h4></div></div></div><p>
+Vorbis I specifies only a channel mapping type 0. In mapping type 0,
+channel mapping is implicitly defined as follows for standard audio
+applications:</p><div class="variablelist"><dl><dt><span class="term">one channel</span></dt><dd>the stream is monophonic</dd><dt><span class="term">two channels</span></dt><dd>the stream is stereo. channel order: left, right</dd><dt><span class="term">three channels</span></dt><dd>the stream is a 1d-surround encoding. channel order: left,
+center, right</dd><dt><span class="term">four channels</span></dt><dd>the stream is quadraphonic surround. channel order: front left,
+front right, rear left, rear right</dd><dt><span class="term">five channels</span></dt><dd>the stream is five-channel surround. channel order: front left,
+front center, front right, rear left, rear right</dd><dt><span class="term">six channels</span></dt><dd>the stream is 5.1 surround. channel order: front left, front
+center, front right, rear left, rear right, LFE</dd><dt><span class="term">greater than six channels</span></dt><dd>channel use and order is defined by the application</dd></dl></div><p>
+Applications using Vorbis for dedicated purposes may define channel
+mapping as seen fit. Future channel mappings (such as three and four
+channel <a href="http://www.ambisonic.net/" target="_top">Ambisonics</a>) will
+make use of channel mappings other than mapping 0.</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-comment"></a>5. comment field and header specification</h2></div><div><p class="releaseinfo">
+ $Id: 05-comment.xml 11703 2006-07-17 16:33:17Z giles $
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id333629"></a>5.1. Overview</h3></div></div></div><p>The Vorbis text comment header is the second (of three) header
+packets that begin a Vorbis bitstream. It is meant for short text
+comments, not arbitrary metadata; arbitrary metadata belongs in a
+separate logical bitstream (usually an XML stream type) that provides
+greater structure and machine parseability.</p><p>The comment field is meant to be used much like someone jotting a
+quick note on the bottom of a CDR. It should be a little information to
+remember the disc by and explain it to others; a short, to-the-point
+text note that need not only be a couple words, but isn't going to be
+more than a short paragraph. The essentials, in other words, whatever
+they turn out to be, eg:
+
+</p><div class="blockquote"><blockquote class="blockquote"><p>Honest Bob and the Factory-to-Dealer-Incentives, <em class="citetitle">I'm Still
+Around</em>, opening for Moxy Früvous, 1997.</p></blockquote></div><p>
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id333657"></a>5.2. Comment encoding</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id334902"></a>5.2.1. Structure</h4></div></div></div><p>
+The comment header is logically a list of eight-bit-clean vectors; the
+number of vectors is bounded to 2^32-1 and the length of each vector
+is limited to 2^32-1 bytes. The vector length is encoded; the vector
+contents themselves are not null terminated. In addition to the vector
+list, there is a single vector for vendor name (also 8 bit clean,
+length encoded in 32 bits). For example, the 1.0 release of libvorbis
+set the vendor string to "Xiph.Org libVorbis I 20020717".</p><p>The comment header is decoded as follows:
+
+</p><pre class="programlisting">
+ 1) [vendor_length] = read an unsigned integer of 32 bits
+ 2) [vendor_string] = read a UTF-8 vector as [vendor_length] octets
+ 3) [user_comment_list_length] = read an unsigned integer of 32 bits
+ 4) iterate [user_comment_list_length] times {
+ 5) [length] = read an unsigned integer of 32 bits
+ 6) this iteration's user comment = read a UTF-8 vector as [length] octets
+ }
+ 7) [framing_bit] = read a single bit as boolean
+ 8) if ( [framing_bit] unset or end-of-packet ) then ERROR
+ 9) done.
+</pre><p>
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id334926"></a>5.2.2. Content vector format</h4></div></div></div><p>
+The comment vectors are structured similarly to a UNIX environment variable.
+That is, comment fields consist of a field name and a corresponding value and
+look like:</p><div class="blockquote"><blockquote class="blockquote"><pre class="programlisting">
+comment[0]="ARTIST=me";
+comment[1]="TITLE=the sound of Vorbis";
+</pre></blockquote></div><p>
+The field name is case-insensitive and may consist of ASCII 0x20
+through 0x7D, 0x3D ('=') excluded. ASCII 0x41 through 0x5A inclusive
+(characters A-Z) is to be considered equivalent to ASCII 0x61 through
+0x7A inclusive (characters a-z).
+</p><p>
+The field name is immediately followed by ASCII 0x3D ('=');
+this equals sign is used to terminate the field name.
+</p><p>
+0x3D is followed by 8 bit clean UTF-8 encoded value of the
+field contents to the end of the field.
+</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id334955"></a>5.2.2.1. Field names</h5></div></div></div><p>Below is a proposed, minimal list of standard field names with a
+description of intended use. No single or group of field names is
+mandatory; a comment header may contain one, all or none of the names
+in this list.</p><div class="variablelist"><dl><dt><span class="term">TITLE</span></dt><dd>Track/Work name</dd><dt><span class="term">VERSION</span></dt><dd>The version field may be used to
+differentiate multiple
+versions of the same track title in a single collection. (e.g. remix
+info)
+</dd><dt><span class="term">ALBUM</span></dt><dd>The collection name to which this track belongs
+</dd><dt><span class="term">TRACKNUMBER</span></dt><dd>The track number of this piece if part of a specific larger collection or album
+</dd><dt><span class="term">ARTIST</span></dt><dd>The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text.
+</dd><dt><span class="term">PERFORMER</span></dt><dd>The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the ARTIST and is omitted.
+</dd><dt><span class="term">COPYRIGHT</span></dt><dd>Copyright attribution, e.g., '2001 Nobody's Band' or '1999 Jack Moffitt'
+</dd><dt><span class="term">LICENSE</span></dt><dd>License information, eg, 'All Rights Reserved', 'Any
+Use Permitted', a URL to a license such as a Creative Commons license
+("www.creativecommons.org/blahblah/license.html") or the EFF Open
+Audio License ('distributed under the terms of the Open Audio
+License. see http://www.eff.org/IP/Open_licenses/eff_oal.html for
+details'), etc.
+</dd><dt><span class="term">ORGANIZATION</span></dt><dd>Name of the organization producing the track (i.e.
+the 'record label')
+</dd><dt><span class="term">DESCRIPTION</span></dt><dd>A short text description of the contents
+</dd><dt><span class="term">GENRE</span></dt><dd>A short text indication of music genre
+</dd><dt><span class="term">DATE</span></dt><dd>Date the track was recorded
+</dd><dt><span class="term">LOCATION</span></dt><dd>Location where track was recorded
+</dd><dt><span class="term">CONTACT</span></dt><dd>Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label.
+</dd><dt><span class="term">ISRC</span></dt><dd>International Standard Recording Code for the
+track; see <a href="http://www.ifpi.org/isrc/" target="_top">the ISRC
+intro page</a> for more information on ISRC numbers.
+</dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="id311698"></a>5.2.2.2. Implications</h5></div></div></div><p>Field names should not be 'internationalized'; this is a
+concession to simplicity not an attempt to exclude the majority of
+the world that doesn't speak English. Field <span class="emphasis"><em>contents</em></span>,
+however, use the UTF-8 character encoding to allow easy representation
+of any language.</p><p>We have the length of the entirety of the field and restrictions on
+the field name so that the field name is bounded in a known way. Thus
+we also have the length of the field contents.</p><p>Individual 'vendors' may use non-standard field names within
+reason. The proper use of comment fields should be clear through
+context at this point. Abuse will be discouraged.</p><p>There is no vendor-specific prefix to 'nonstandard' field names.
+Vendors should make some effort to avoid arbitrarily polluting the
+common namespace. We will generally collect the more useful tags
+here to help with standardization.</p><p>Field names are not required to be unique (occur once) within a
+comment header. As an example, assume a track was recorded by three
+well know artists; the following is permissible, and encouraged:
+
+</p><div class="blockquote"><blockquote class="blockquote"><pre class="programlisting">
+ARTIST=Dizzy Gillespie
+ARTIST=Sonny Rollins
+ARTIST=Sonny Stitt
+</pre></blockquote></div><p>
+
+</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id301005"></a>5.2.3. Encoding</h4></div></div></div><p>
+The comment header comprises the entirety of the second bitstream
+header packet. Unlike the first bitstream header packet, it is not
+generally the only packet on the second page and may not be restricted
+to within the second bitstream page. The length of the comment header
+packet is (practically) unbounded. The comment header packet is not
+optional; it must be present in the bitstream even if it is
+effectively empty.</p><p>
+The comment header is encoded as follows (as per Ogg's standard
+bitstream mapping which renders least-significant-bit of the word to be
+coded into the least significant available bit of the current
+bitstream octet first):
+
+</p><div class="orderedlist"><ol type="1"><li>
+ Vendor string length (32 bit unsigned quantity specifying number of octets)
+ </li><li>
+ Vendor string ([vendor string length] octets coded from beginning of string to end of string, not null terminated)
+ </li><li>
+ Number of comment fields (32 bit unsigned quantity specifying number of fields)
+ </li><li>
+ Comment field 0 length (if [Number of comment fields]>0; 32 bit unsigned quantity specifying number of octets)
+ </li><li>
+ Comment field 0 ([Comment field 0 length] octets coded from beginning of string to end of string, not null terminated)
+ </li><li>
+ Comment field 1 length (if [Number of comment fields]>1...)...
+ </li></ol></div><p>
+</p><p>
+This is actually somewhat easier to describe in code; implementation of the above can be found in <code class="filename">vorbis/lib/info.c</code>, <code class="function">_vorbis_pack_comment()</code> and <code class="function">_vorbis_unpack_comment()</code>.
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-floor0"></a>6. Floor type 0 setup and decode</h2></div><div><p class="releaseinfo">
+ $Id: 06-floor0.xml 14529 2008-02-19 10:15:13Z xiphmont $
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id320318"></a>6.1. Overview</h3></div></div></div><p>
+Vorbis floor type zero uses Line Spectral Pair (LSP, also alternately
+known as Line Spectral Frequency or LSF) representation to encode a
+smooth spectral envelope curve as the frequency response of the LSP
+filter. This representation is equivalent to a traditional all-pole
+infinite impulse response filter as would be used in linear predictive
+coding; LSP representation may be converted to LPC representation and
+vice-versa.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id324407"></a>6.2. Floor 0 format</h3></div></div></div><p>
+Floor zero configuration consists of six integer fields and a list of
+VQ codebooks for use in coding/decoding the LSP filter coefficient
+values used by each frame. </p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id322051"></a>6.2.1. header decode</h4></div></div></div><p>
+Configuration information for instances of floor zero decodes from the
+codec setup header (third packet). configuration decode proceeds as
+follows:</p><pre class="screen">
+ 1) [floor0_order] = read an unsigned integer of 8 bits
+ 2) [floor0_rate] = read an unsigned integer of 16 bits
+ 3) [floor0_bark_map_size] = read an unsigned integer of 16 bits
+ 4) [floor0_amplitude_bits] = read an unsigned integer of six bits
+ 5) [floor0_amplitude_offset] = read an unsigned integer of eight bits
+ 6) [floor0_number_of_books] = read an unsigned integer of four bits and add 1
+ 7) array [floor0_book_list] = read a list of [floor0_number_of_books] unsigned integers of eight bits each;
+</pre><p>
+An end-of-packet condition during any of these bitstream reads renders
+this stream undecodable. In addition, any element of the array
+<code class="varname">[floor0_book_list]</code> that is greater than the maximum codebook
+number for this bitstream is an error condition that also renders the
+stream undecodable.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-floor0-decode"></a>6.2.2. packet decode</h4></div></div></div><p>
+Extracting a floor0 curve from an audio packet consists of first
+decoding the curve amplitude and <code class="varname">[floor0_order]</code> LSP
+coefficient values from the bitstream, and then computing the floor
+curve, which is defined as the frequency response of the decoded LSP
+filter.</p><p>
+Packet decode proceeds as follows:</p><pre class="screen">
+ 1) [amplitude] = read an unsigned integer of [floor0_amplitude_bits] bits
+ 2) if ( [amplitude] is greater than zero ) {
+ 3) [coefficients] is an empty, zero length vector
+ 4) [booknumber] = read an unsigned integer of <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>( [floor0_number_of_books] ) bits
+ 5) if ( [booknumber] is greater than the highest number decode codebook ) then packet is undecodable
+ 6) [last] = zero;
+ 7) vector [temp_vector] = read vector from bitstream using codebook number [floor0_book_list] element [booknumber] in VQ context.
+ 8) add the scalar value [last] to each scalar in vector [temp_vector]
+ 9) [last] = the value of the last scalar in vector [temp_vector]
+ 10) concatenate [temp_vector] onto the end of the [coefficients] vector
+ 11) if (length of vector [coefficients] is less than [floor0_order], continue at step 6
+
+ }
+
+ 12) done.
+
+</pre><p>
+Take note of the following properties of decode:
+</p><div class="itemizedlist"><ul type="disc"><li>An <code class="varname">[amplitude]</code> value of zero must result in a return code that indicates this channel is unused in this frame (the output of the channel will be all-zeroes in synthesis). Several later stages of decode don't occur for an unused channel.</li><li>An end-of-packet condition during decode should be considered a
+nominal occruence; if end-of-packet is reached during any read
+operation above, floor decode is to return 'unused' status as if the
+<code class="varname">[amplitude]</code> value had read zero at the beginning of decode.</li><li>The book number used for decode
+can, in fact, be stored in the bitstream in <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>( <code class="varname">[floor0_number_of_books]</code> -
+1 ) bits. Nevertheless, the above specification is correct and values
+greater than the maximum possible book value are reserved.</li><li>The number of scalars read into the vector <code class="varname">[coefficients]</code>
+may be greater than <code class="varname">[floor0_order]</code>, the number actually
+required for curve computation. For example, if the VQ codebook used
+for the floor currently being decoded has a
+<code class="varname">[codebook_dimensions]</code> value of three and
+<code class="varname">[floor0_order]</code> is ten, the only way to fill all the needed
+scalars in <code class="varname">[coefficients]</code> is to to read a total of twelve
+scalars as four vectors of three scalars each. This is not an error
+condition, and care must be taken not to allow a buffer overflow in
+decode. The extra values are not used and may be ignored or discarded.</li></ul></div><p>
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-floor0-synth"></a>6.2.3. curve computation</h4></div></div></div><p>
+Given an <code class="varname">[amplitude]</code> integer and <code class="varname">[coefficients]</code>
+vector from packet decode as well as the [floor0_order],
+[floor0_rate], [floor0_bark_map_size], [floor0_amplitude_bits] and
+[floor0_amplitude_offset] values from floor setup, and an output
+vector size <code class="varname">[n]</code> specified by the decode process, we compute a
+floor output vector.</p><p>
+If the value <code class="varname">[amplitude]</code> is zero, the return value is a
+length <code class="varname">[n]</code> vector with all-zero scalars. Otherwise, begin by
+assuming the following definitions for the given vector to be
+synthesized:</p><div class="informalequation"><div class="mediaobject"><img src="lspmap.png" alt="[lsp map equation]"></div></div><p>
+The above is used to synthesize the LSP curve on a Bark-scale frequency
+axis, then map the result to a linear-scale frequency axis.
+Similarly, the below calculation synthesizes the output LSP curve <code class="varname">[output]</code> on a log
+(dB) amplitude scale, mapping it to linear amplitude in the last step:</p><div class="orderedlist"><ol type="1"><li> <code class="varname">[i]</code> = 0 </li><li> <code class="varname">[ω]</code> = π * map element <code class="varname">[i]</code> / <code class="varname">[floor0_bark_map_size]</code></li><li><p>if ( <code class="varname">[floor0_order]</code> is odd ) {
+ </p><div class="orderedlist"><ol type="a"><li><p>calculate <code class="varname">[p]</code> and <code class="varname">[q]</code> according to:
+ </p><div class="informalequation"><div class="mediaobject"><img src="oddlsp.png" alt="[equation for odd lsp]"></div></div><p>
+ </p></li></ol></div><p>
+ } else <code class="varname">[floor0_order]</code> is even {
+ </p><div class="orderedlist"><ol type="a"><li><p>calculate <code class="varname">[p]</code> and <code class="varname">[q]</code> according to:
+ </p><div class="informalequation"><div class="mediaobject"><img src="evenlsp.png" alt="[equation for even lsp]"></div></div><p>
+ </p></li></ol></div><p>
+ }
+ </p></li><li><p>calculate <code class="varname">[linear_floor_value]</code> according to:
+ </p><div class="informalequation"><div class="mediaobject"><img src="floorval.png" alt="[expression for floorval]"></div></div><p>
+ </p></li><li><code class="varname">[iteration_condition]</code> = map element <code class="varname">[i]</code></li><li><code class="varname">[output]</code> element <code class="varname">[i]</code> = <code class="varname">[linear_floor_value]</code></li><li>increment <code class="varname">[i]</code></li><li>if ( map element <code class="varname">[i]</code> is equal to <code class="varname">[iteration_condition]</code> ) continue at step 5</li><li>if ( <code class="varname">[i]</code> is less than <code class="varname">[n]</code> ) continue at step 2</li><li>done</li></ol></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-floor1"></a>7. Floor type 1 setup and decode</h2></div><div><p class="releaseinfo">
+ $Id: 07-floor1.xml 10466 2005-11-28 00:34:44Z giles $
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id321969"></a>7.1. Overview</h3></div></div></div><p>
+Vorbis floor type one uses a piecewise straight-line representation to
+encode a spectral envelope curve. The representation plots this curve
+mechanically on a linear frequency axis and a logarithmic (dB)
+amplitude axis. The integer plotting algorithm used is similar to
+Bresenham's algorithm.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id315653"></a>7.2. Floor 1 format</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id317058"></a>7.2.1. model</h4></div></div></div><p>
+Floor type one represents a spectral curve as a series of
+line segments. Synthesis constructs a floor curve using iterative
+prediction in a process roughly equivalent to the following simplified
+description:</p><p>
+</p><div class="itemizedlist"><ul type="disc"><li> the first line segment (base case) is a logical line spanning
+from x_0,y_0 to x_1,y_1 where in the base case x_0=0 and x_1=[n], the
+full range of the spectral floor to be computed.</li><li>the induction step chooses a point x_new within an existing
+logical line segment and produces a y_new value at that point computed
+from the existing line's y value at x_new (as plotted by the line) and
+a difference value decoded from the bitstream packet.</li><li>floor computation produces two new line segments, one running from
+x_0,y_0 to x_new,y_new and from x_new,y_new to x_1,y_1. This step is
+performed logically even if y_new represents no change to the
+amplitude value at x_new so that later refinement is additionally
+bounded at x_new.</li><li>the induction step repeats, using a list of x values specified in
+the codec setup header at floor 1 initialization time. Computation
+is completed at the end of the x value list.</li></ul></div><p>
+</p><p>
+Consider the following example, with values chosen for ease of
+understanding rather than representing typical configuration:</p><p>
+For the below example, we assume a floor setup with an [n] of 128.
+The list of selected X values in increasing order is
+0,16,32,48,64,80,96,112 and 128. In list order, the values interleave
+as 0, 128, 64, 32, 96, 16, 48, 80 and 112. The corresponding
+list-order Y values as decoded from an example packet are 110, 20, -5,
+-45, 0, -25, -10, 30 and -10. We compute the floor in the following
+way, beginning with the first line:</p><div class="mediaobject"><img src="floor1-1.png" alt="[graph of example floor]"></div><p>
+We now draw new logical lines to reflect the correction to new_Y, and
+iterate for X positions 32 and 96:</p><div class="mediaobject"><img src="floor1-2.png" alt="[graph of example floor]"></div><p>
+Although the new Y value at X position 96 is unchanged, it is still
+used later as an endpoint for further refinement. From here on, the
+pattern should be clear; we complete the floor computation as follows:</p><div class="mediaobject"><img src="floor1-3.png" alt="[graph of example floor]"></div><div class="mediaobject"><img src="floor1-4.png" alt="[graph of example floor]"></div><p>
+A more efficient algorithm with carefully defined integer rounding
+behavior is used for actual decode, as described later. The actual
+algorithm splits Y value computation and line plotting into two steps
+with modifications to the above algorithm to eliminate noise
+accumulation through integer roundoff/truncation. </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id334215"></a>7.2.2. header decode</h4></div></div></div><p>
+A list of floor X values is stored in the packet header in interleaved
+format (used in list order during packet decode and synthesis). This
+list is split into partitions, and each partition is assigned to a
+partition class. X positions 0 and [n] are implicit and do not belong
+to an explicit partition or partition class.</p><p>
+A partition class consists of a representation vector width (the
+number of Y values which the partition class encodes at once), a
+'subclass' value representing the number of alternate entropy books
+the partition class may use in representing Y values, the list of
+[subclass] books and a master book used to encode which alternate
+books were chosen for representation in a given packet. The
+master/subclass mechanism is meant to be used as a flexible
+representation cascade while still using codebooks only in a scalar
+context.</p><pre class="screen">
+
+ 1) [floor1_partitions] = read 5 bits as unsigned integer
+ 2) [maximum_class] = -1
+ 3) iterate [i] over the range 0 ... [floor1_partitions]-1 {
+
+ 4) vector [floor1_partition_class_list] element [i] = read 4 bits as unsigned integer
+
+ }
+
+ 5) [maximum_class] = largest integer scalar value in vector [floor1_partition_class_list]
+ 6) iterate [i] over the range 0 ... [maximum_class] {
+
+ 7) vector [floor1_class_dimensions] element [i] = read 3 bits as unsigned integer and add 1
+ 8) vector [floor1_class_subclasses] element [i] = read 2 bits as unsigned integer
+ 9) if ( vector [floor1_class_subclasses] element [i] is nonzero ) {
+
+ 10) vector [floor1_class_masterbooks] element [i] = read 8 bits as unsigned integer
+
+ }
+
+ 11) iterate [j] over the range 0 ... (2 exponent [floor1_class_subclasses] element [i]) - 1 {
+
+ 12) array [floor1_subclass_books] element [i],[j] =
+ read 8 bits as unsigned integer and subtract one
+ }
+ }
+
+ 13) [floor1_multiplier] = read 2 bits as unsigned integer and add one
+ 14) [rangebits] = read 4 bits as unsigned integer
+ 15) vector [floor1_X_list] element [0] = 0
+ 16) vector [floor1_X_list] element [1] = 2 exponent [rangebits];
+ 17) [floor1_values] = 2
+ 18) iterate [i] over the range 0 ... [floor1_partitions]-1 {
+
+ 19) [current_class_number] = vector [floor1_partition_class_list] element [i]
+ 20) iterate [j] over the range 0 ... ([floor1_class_dimensions] element [current_class_number])-1 {
+ 21) vector [floor1_X_list] element ([floor1_values]) =
+ read [rangebits] bits as unsigned integer
+ 22) increment [floor1_values] by one
+ }
+ }
+
+ 23) done
+</pre><p>
+An end-of-packet condition while reading any aspect of a floor 1
+configuration during setup renders a stream undecodable. In
+addition, a <code class="varname">[floor1_class_masterbooks]</code> or
+<code class="varname">[floor1_subclass_books]</code> scalar element greater than the
+highest numbered codebook configured in this stream is an error
+condition that renders the stream undecodable.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-floor1-decode"></a>7.2.2.1. packet decode</h5></div></div></div><p>
+Packet decode begins by checking the <code class="varname">[nonzero]</code> flag:</p><pre class="screen">
+ 1) [nonzero] = read 1 bit as boolean
+</pre><p>
+If <code class="varname">[nonzero]</code> is unset, that indicates this channel contained
+no audio energy in this frame. Decode immediately returns a status
+indicating this floor curve (and thus this channel) is unused this
+frame. (A return status of 'unused' is different from decoding a
+floor that has all points set to minimum representation amplitude,
+which happens to be approximately -140dB).
+</p><p>
+Assuming <code class="varname">[nonzero]</code> is set, decode proceeds as follows:</p><pre class="screen">
+ 1) [range] = vector { 256, 128, 86, 64 } element ([floor1_multiplier]-1)
+ 2) vector [floor1_Y] element [0] = read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>([range]-1) bits as unsigned integer
+ 3) vector [floor1_Y] element [1] = read <a href="#vorbis-spec-ilog" title="9.2.1. ilog">ilog</a>([range]-1) bits as unsigned integer
+ 4) [offset] = 2;
+ 5) iterate [i] over the range 0 ... [floor1_partitions]-1 {
+
+ 6) [class] = vector [floor1_partition_class] element [i]
+ 7) [cdim] = vector [floor1_class_dimensions] element [class]
+ 8) [cbits] = vector [floor1_class_subclasses] element [class]
+ 9) [csub] = (2 exponent [cbits])-1
+ 10) [cval] = 0
+ 11) if ( [cbits] is greater than zero ) {
+
+ 12) [cval] = read from packet using codebook number
+ (vector [floor1_class_masterbooks] element [class]) in scalar context
+ }
+
+ 13) iterate [j] over the range 0 ... [cdim]-1 {
+
+ 14) [book] = array [floor1_subclass_books] element [class],([cval] bitwise AND [csub])
+ 15) [cval] = [cval] right shifted [cbits] bits
+ 16) if ( [book] is not less than zero ) {
+
+ 17) vector [floor1_Y] element ([j]+[offset]) = read from packet using codebook
+ [book] in scalar context
+
+ } else [book] is less than zero {
+
+ 18) vector [floor1_Y] element ([j]+[offset]) = 0
+
+ }
+ }
+
+ 19) [offset] = [offset] + [cdim]
+
+ }
+
+ 20) done
+</pre><p>
+An end-of-packet condition during curve decode should be considered a
+nominal occurrence; if end-of-packet is reached during any read
+operation above, floor decode is to return 'unused' status as if the
+<code class="varname">[nonzero]</code> flag had been unset at the beginning of decode.
+</p><p>
+Vector <code class="varname">[floor1_Y]</code> contains the values from packet decode
+needed for floor 1 synthesis.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-floor1-synth"></a>7.2.2.2. curve computation</h5></div></div></div><p>
+Curve computation is split into two logical steps; the first step
+derives final Y amplitude values from the encoded, wrapped difference
+values taken from the bitstream. The second step plots the curve
+lines. Also, although zero-difference values are used in the
+iterative prediction to find final Y values, these points are
+conditionally skipped during final line computation in step two.
+Skipping zero-difference values allows a smoother line fit. </p><p>
+Although some aspects of the below algorithm look like inconsequential
+optimizations, implementors are warned to follow the details closely.
+Deviation from implementing a strictly equivalent algorithm can result
+in serious decoding errors.</p><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id309087"></a>7.2.2.2.1. step 1: amplitude value synthesis</h6></div></div></div><p>
+Unwrap the always-positive-or-zero values read from the packet into
++/- difference values, then apply to line prediction.</p><pre class="screen">
+ 1) [range] = vector { 256, 128, 86, 64 } element ([floor1_multiplier]-1)
+ 2) vector [floor1_step2_flag] element [0] = set
+ 3) vector [floor1_step2_flag] element [1] = set
+ 4) vector [floor1_final_Y] element [0] = vector [floor1_Y] element [0]
+ 5) vector [floor1_final_Y] element [1] = vector [floor1_Y] element [1]
+ 6) iterate [i] over the range 2 ... [floor1_values]-1 {
+
+ 7) [low_neighbor_offset] = <a href="#vorbis-spec-low_neighbor" title="9.2.4. low_neighbor">low_neighbor</a>([floor1_X_list],[i])
+ 8) [high_neighbor_offset] = <a href="#vorbis-spec-high_neighbor" title="9.2.4.1. high_neighbor">high_neighbor</a>([floor1_X_list],[i])
+
+ 9) [predicted] = <a href="#vorbis-spec-render_point" title="9.2.4.2. render_point">render_point</a>( vector [floor1_X_list] element [low_neighbor_offset],
+ vector [floor1_final_Y] element [low_neighbor_offset],
+ vector [floor1_X_list] element [high_neighbor_offset],
+ vector [floor1_final_Y] element [high_neighbor_offset],
+ vector [floor1_X_list] element [i] )
+
+ 10) [val] = vector [floor1_Y] element [i]
+ 11) [highroom] = [range] - [predicted]
+ 12) [lowroom] = [predicted]
+ 13) if ( [highroom] is less than [lowroom] ) {
+
+ 14) [room] = [highroom] * 2
+
+ } else [highroom] is not less than [lowroom] {
+
+ 15) [room] = [lowroom] * 2
+
+ }
+
+ 16) if ( [val] is nonzero ) {
+
+ 17) vector [floor1_step2_flag] element [low_neighbor_offset] = set
+ 18) vector [floor1_step2_flag] element [high_neighbor_offset] = set
+ 19) vector [floor1_step2_flag] element [i] = set
+ 20) if ( [val] is greater than or equal to [room] ) {
+
+ 21) if ( [highroom] is greater than [lowroom] ) {
+
+ 22) vector [floor1_final_Y] element [i] = [val] - [lowroom] + [predicted]
+
+ } else [highroom] is not greater than [lowroom] {
+
+ 23) vector [floor1_final_Y] element [i] = [predicted] - [val] + [highroom] - 1
+
+ }
+
+ } else [val] is less than [room] {
+
+ 24) if ([val] is odd) {
+
+ 25) vector [floor1_final_Y] element [i] =
+ [predicted] - (([val] + 1) divided by 2 using integer division)
+
+ } else [val] is even {
+
+ 26) vector [floor1_final_Y] element [i] =
+ [predicted] + ([val] / 2 using integer division)
+
+ }
+
+ }
+
+ } else [val] is zero {
+
+ 27) vector [floor1_step2_flag] element [i] = unset
+ 28) vector [floor1_final_Y] element [i] = [predicted]
+
+ }
+
+ }
+
+ 29) done
+
+</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h6 class="title"><a name="id309123"></a>7.2.2.2.2. step 2: curve synthesis</h6></div></div></div><p>
+Curve synthesis generates a return vector <code class="varname">[floor]</code> of length
+<code class="varname">[n]</code> (where <code class="varname">[n]</code> is provided by the decode process
+calling to floor decode). Floor 1 curve synthesis makes use of the
+<code class="varname">[floor1_X_list]</code>, <code class="varname">[floor1_final_Y]</code> and
+<code class="varname">[floor1_step2_flag]</code> vectors, as well as [floor1_multiplier]
+and [floor1_values] values.</p><p>
+Decode begins by sorting the scalars from vectors
+<code class="varname">[floor1_X_list]</code>, <code class="varname">[floor1_final_Y]</code> and
+<code class="varname">[floor1_step2_flag]</code> together into new vectors
+<code class="varname">[floor1_X_list]'</code>, <code class="varname">[floor1_final_Y]'</code> and
+<code class="varname">[floor1_step2_flag]'</code> according to ascending sort order of the
+values in <code class="varname">[floor1_X_list]</code>. That is, sort the values of
+<code class="varname">[floor1_X_list]</code> and then apply the same permutation to
+elements of the other two vectors so that the X, Y and step2_flag
+values still match.</p><p>
+Then compute the final curve in one pass:</p><pre class="screen">
+ 1) [hx] = 0
+ 2) [lx] = 0
+ 3) [ly] = vector [floor1_final_Y]' element [0] * [floor1_multiplier]
+ 4) iterate [i] over the range 1 ... [floor1_values]-1 {
+
+ 5) if ( [floor1_step2_flag]' element [i] is set ) {
+
+ 6) [hy] = [floor1_final_Y]' element [i] * [floor1_multiplier]
+ 7) [hx] = [floor1_X_list]' element [i]
+ 8) <a href="#vorbis-spec-render_line" title="9.2.4.3. render_line">render_line</a>( [lx], [ly], [hx], [hy], [floor] )
+ 9) [lx] = [hx]
+ 10) [ly] = [hy]
+ }
+ }
+
+ 11) if ( [hx] is less than [n] ) {
+
+ 12) <a href="#vorbis-spec-render_line" title="9.2.4.3. render_line">render_line</a>( [hx], [hy], [n], [hy], [floor] )
+
+ }
+
+ 13) if ( [hx] is greater than [n] ) {
+
+ 14) truncate vector [floor] to [n] elements
+
+ }
+
+ 15) for each scalar in vector [floor], perform a lookup substitution using
+ the scalar value from [floor] as an offset into the vector <a href="#vorbis-spec-floor1_inverse_dB_table" title="10.1. floor1_inverse_dB_table">[floor1_inverse_dB_static_table]</a>
+
+ 16) done
+
+</pre></div></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-residue"></a>8. Residue setup and decode</h2></div><div><p class="releaseinfo">
+ $Id: 08-residue.xml 14598 2008-03-18 15:39:43Z xiphmont $
+ </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id333002"></a>8.1. Overview</h3></div></div></div><p>
+A residue vector represents the fine detail of the audio spectrum of
+one channel in an audio frame after the encoder subtracts the floor
+curve and performs any channel coupling. A residue vector may
+represent spectral lines, spectral magnitude, spectral phase or
+hybrids as mixed by channel coupling. The exact semantic content of
+the vector does not matter to the residue abstraction.</p><p>
+Whatever the exact qualities, the Vorbis residue abstraction codes the
+residue vectors into the bitstream packet, and then reconstructs the
+vectors during decode. Vorbis makes use of three different encoding
+variants (numbered 0, 1 and 2) of the same basic vector encoding
+abstraction.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id327769"></a>8.2. Residue format</h3></div></div></div><p>
+Residue format partitions each vector in the vector bundle into chunks,
+classifies each chunk, encodes the chunk classifications and finally
+encodes the chunks themselves using the the specific VQ arrangement
+defined for each selected classification.
+The exact interleaving and partitioning vary by residue encoding number,
+however the high-level process used to classify and encode the residue
+vector is the same in all three variants.</p><p>
+A set of coded residue vectors are all of the same length. High level
+coding structure, ignoring for the moment exactly how a partition is
+encoded and simply trusting that it is, is as follows:</p><p>
+</p><div class="itemizedlist"><ul type="disc"><li><p>Each vector is partitioned into multiple equal sized chunks
+according to configuration specified. If we have a vector size of
+<span class="emphasis"><em>n</em></span>, a partition size <span class="emphasis"><em>residue_partition_size</em></span>, and a total
+of <span class="emphasis"><em>ch</em></span> residue vectors, the total number of partitioned chunks
+coded is <span class="emphasis"><em>n</em></span>/<span class="emphasis"><em>residue_partition_size</em></span>*<span class="emphasis"><em>ch</em></span>. It is
+important to note that the integer division truncates. In the below
+example, we assume an example <span class="emphasis"><em>residue_partition_size</em></span> of 8.</p></li><li><p>Each partition in each vector has a classification number that
+specifies which of multiple configured VQ codebook setups are used to
+decode that partition. The classification numbers of each partition
+can be thought of as forming a vector in their own right, as in the
+illustration below. Just as the residue vectors are coded in grouped
+partitions to increase encoding efficiency, the classification vector
+is also partitioned into chunks. The integer elements of each scalar
+in a classification chunk are built into a single scalar that
+represents the classification numbers in that chunk. In the below
+example, the classification codeword encodes two classification
+numbers.</p></li><li><p>The values in a residue vector may be encoded monolithically in a
+single pass through the residue vector, but more often efficient
+codebook design dictates that each vector is encoded as the additive
+sum of several passes through the residue vector using more than one
+VQ codebook. Thus, each residue value potentially accumulates values
+from multiple decode passes. The classification value associated with
+a partition is the same in each pass, thus the classification codeword
+is coded only in the first pass.</p></li></ul></div><p>
+</p><div class="mediaobject"><img src="residue-pack.png" alt="[illustration of residue vector format]"></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id318469"></a>8.3. residue 0</h3></div></div></div><p>
+Residue 0 and 1 differ only in the way the values within a residue
+partition are interleaved during partition encoding (visually treated
+as a black box--or cyan box or brown box--in the above figure).</p><p>
+Residue encoding 0 interleaves VQ encoding according to the
+dimension of the codebook used to encode a partition in a specific
+pass. The dimension of the codebook need not be the same in multiple
+passes, however the partition size must be an even multiple of the
+codebook dimension.</p><p>
+As an example, assume a partition vector of size eight, to be encoded
+by residue 0 using codebook sizes of 8, 4, 2 and 1:</p><pre class="programlisting">
+
+ original residue vector: [ 0 1 2 3 4 5 6 7 ]
+
+codebook dimensions = 8 encoded as: [ 0 1 2 3 4 5 6 7 ]
+
+codebook dimensions = 4 encoded as: [ 0 2 4 6 ], [ 1 3 5 7 ]
+
+codebook dimensions = 2 encoded as: [ 0 4 ], [ 1 5 ], [ 2 6 ], [ 3 7 ]
+
+codebook dimensions = 1 encoded as: [ 0 ], [ 1 ], [ 2 ], [ 3 ], [ 4 ], [ 5 ], [ 6 ], [ 7 ]
+
+</pre><p>
+It is worth mentioning at this point that no configurable value in the
+residue coding setup is restricted to a power of two.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id343071"></a>8.4. residue 1</h3></div></div></div><p>
+Residue 1 does not interleave VQ encoding. It represents partition
+vector scalars in order. As with residue 0, however, partition length
+must be an integer multiple of the codebook dimension, although
+dimension may vary from pass to pass.</p><p>
+As an example, assume a partition vector of size eight, to be encoded
+by residue 0 using codebook sizes of 8, 4, 2 and 1:</p><pre class="programlisting">
+
+ original residue vector: [ 0 1 2 3 4 5 6 7 ]
+
+codebook dimensions = 8 encoded as: [ 0 1 2 3 4 5 6 7 ]
+
+codebook dimensions = 4 encoded as: [ 0 1 2 3 ], [ 4 5 6 7 ]
+
+codebook dimensions = 2 encoded as: [ 0 1 ], [ 2 3 ], [ 4 5 ], [ 6 7 ]
+
+codebook dimensions = 1 encoded as: [ 0 ], [ 1 ], [ 2 ], [ 3 ], [ 4 ], [ 5 ], [ 6 ], [ 7 ]
+
+</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id343096"></a>8.5. residue 2</h3></div></div></div><p>
+Residue type two can be thought of as a variant of residue type 1.
+Rather than encoding multiple passed-in vectors as in residue type 1,
+the <span class="emphasis"><em>ch</em></span> passed in vectors of length <span class="emphasis"><em>n</em></span> are first
+interleaved and flattened into a single vector of length
+<span class="emphasis"><em>ch</em></span>*<span class="emphasis"><em>n</em></span>. Encoding then proceeds as in type 1. Decoding is
+as in type 1 with decode interleave reversed. If operating on a single
+vector to begin with, residue type 1 and type 2 are equivalent.</p><div class="mediaobject"><img src="residue2.png" alt="[illustration of residue type 2]"></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id343145"></a>8.6. Residue decode</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id343151"></a>8.6.1. header decode</h4></div></div></div><p>
+Header decode for all three residue types is identical.</p><pre class="programlisting">
+ 1) [residue_begin] = read 24 bits as unsigned integer
+ 2) [residue_end] = read 24 bits as unsigned integer
+ 3) [residue_partition_size] = read 24 bits as unsigned integer and add one
+ 4) [residue_classifications] = read 6 bits as unsigned integer and add one
+ 5) [residue_classbook] = read 8 bits as unsigned integer
+</pre><p>
+<code class="varname">[residue_begin]</code> and
+<code class="varname">[residue_end]</code> select the specific sub-portion of
+each vector that is actually coded; it implements akin to a bandpass
+where, for coding purposes, the vector effectively begins at element
+<code class="varname">[residue_begin]</code> and ends at
+<code class="varname">[residue_end]</code>. Preceding and following values in
+the unpacked vectors are zeroed. Note that for residue type 2, these
+values as well as <code class="varname">[residue_partition_size]</code>apply to
+the interleaved vector, not the individual vectors before interleave.
+<code class="varname">[residue_partition_size]</code> is as explained above,
+<code class="varname">[residue_classifications]</code> is the number of possible
+classification to which a partition can belong and
+<code class="varname">[residue_classbook]</code> is the codebook number used to
+code classification codewords. The number of dimensions in book
+<code class="varname">[residue_classbook]</code> determines how many
+classification values are grouped into a single classification
+codeword. Note that the number of entries and dimensions in book
+<code class="varname">[residue_classbook]</code>, along with
+<code class="varname">[residue_classifications]</code>, overdetermines to
+possible number of classification codewords. If
+<code class="varname">[residue_classifications]</code>^<code class="varname">[residue_classbook]</code>.dimensions
+does not equal <code class="varname">[residue_classbook]</code>.entries, the
+bitstream should be regarded to be undecodable. </p><p>
+Next we read a bitmap pattern that specifies which partition classes
+code values in which passes.</p><pre class="programlisting">
+ 1) iterate [i] over the range 0 ... [residue_classifications]-1 {
+
+ 2) [high_bits] = 0
+ 3) [low_bits] = read 3 bits as unsigned integer
+ 4) [bitflag] = read one bit as boolean
+ 5) if ( [bitflag] is set ) then [high_bits] = read five bits as unsigned integer
+ 6) vector [residue_cascade] element [i] = [high_bits] * 8 + [low_bits]
+ }
+ 7) done
+</pre><p>
+Finally, we read in a list of book numbers, each corresponding to
+specific bit set in the cascade bitmap. We loop over the possible
+codebook classifications and the maximum possible number of encoding
+stages (8 in Vorbis I, as constrained by the elements of the cascade
+bitmap being eight bits):</p><pre class="programlisting">
+ 1) iterate [i] over the range 0 ... [residue_classifications]-1 {
+
+ 2) iterate [j] over the range 0 ... 7 {
+
+ 3) if ( vector [residue_cascade] element [i] bit [j] is set ) {
+
+ 4) array [residue_books] element [i][j] = read 8 bits as unsigned integer
+
+ } else {
+
+ 5) array [residue_books] element [i][j] = unused
+
+ }
+ }
+ }
+
+ 6) done
+</pre><p>
+An end-of-packet condition at any point in header decode renders the
+stream undecodable. In addition, any codebook number greater than the
+maximum numbered codebook set up in this stream also renders the
+stream undecodable.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id304464"></a>8.6.2. packet decode</h4></div></div></div><p>
+Format 0 and 1 packet decode is identical except for specific
+partition interleave. Format 2 packet decode can be built out of the
+format 1 decode process. Thus we describe first the decode
+infrastructure identical to all three formats.</p><p>
+In addition to configuration information, the residue decode process
+is passed the number of vectors in the submap bundle and a vector of
+flags indicating if any of the vectors are not to be decoded. If the
+passed in number of vectors is 3 and vector number 1 is marked 'do not
+decode', decode skips vector 1 during the decode loop. However, even
+'do not decode' vectors are allocated and zeroed.</p><p>
+Depending on the values of <code class="varname">[residue_begin]</code> and
+<code class="varname">[residue_end]</code>, it is obvious that the encoded
+portion of a residue vector may be the entire possible residue vector
+or some other strict subset of the actual residue vector size with
+zero padding at either uncoded end. However, it is also possible to
+set <code class="varname">[residue_begin]</code> and
+<code class="varname">[residue_end]</code> to specify a range partially or
+wholly beyond the maximum vector size. Before beginning residue
+decode, limit <code class="varname">[residue_begin]</code> and
+<code class="varname">[residue_end]</code> to the maximum possible vector size
+as follows. We assume that the number of vectors being encoded,
+<code class="varname">[ch]</code> is provided by the higher level decoding
+process.</p><pre class="programlisting">
+ 1) [actual_size] = current blocksize/2;
+ 2) if residue encoding is format 2
+ 3) [actual_size] = [actual_size] * [ch];
+ 4) [limit_residue_begin] = maximum of ([residue_begin],[actual_size]);
+ 5) [limit_residue_end] = maximum of ([residue_end],[actual_size]);
+</pre><p>
+The following convenience values are conceptually useful to clarifying
+the decode process:</p><pre class="programlisting">
+ 1) [classwords_per_codeword] = [codebook_dimensions] value of codebook [residue_classbook]
+ 2) [n_to_read] = [limit_residue_end] - [limit_residue_begin]
+ 3) [partitions_to_read] = [n_to_read] / [residue_partition_size]
+</pre><p>
+Packet decode proceeds as follows, matching the description offered earlier in the document. </p><pre class="programlisting">
+ 1) allocate and zero all vectors that will be returned.
+ 2) if ([n_to_read] is zero), stop; there is no residue to decode.
+ 3) iterate [pass] over the range 0 ... 7 {
+
+ 4) [partition_count] = 0
+
+ 5) while [partition_count] is less than [partitions_to_read]
+
+ 6) if ([pass] is zero) {
+
+ 7) iterate [j] over the range 0 .. [ch]-1 {
+
+ 8) if vector [j] is not marked 'do not decode' {
+
+ 9) [temp] = read from packet using codebook [residue_classbook] in scalar context
+ 10) iterate [i] descending over the range [classwords_per_codeword]-1 ... 0 {
+
+ 11) array [classifications] element [j],([i]+[partition_count]) =
+ [temp] integer modulo [residue_classifications]
+ 12) [temp] = [temp] / [residue_classifications] using integer division
+
+ }
+
+ }
+
+ }
+
+ }
+
+ 13) iterate [i] over the range 0 .. ([classwords_per_codeword] - 1) while [partition_count]
+ is also less than [partitions_to_read] {
+
+ 14) iterate [j] over the range 0 .. [ch]-1 {
+
+ 15) if vector [j] is not marked 'do not decode' {
+
+ 16) [vqclass] = array [classifications] element [j],[partition_count]
+ 17) [vqbook] = array [residue_books] element [vqclass],[pass]
+ 18) if ([vqbook] is not 'unused') {
+
+ 19) decode partition into output vector number [j], starting at scalar
+ offset [limit_residue_begin]+[partition_count]*[residue_partition_size] using
+ codebook number [vqbook] in VQ context
+ }
+ }
+
+ 20) increment [partition_count] by one
+
+ }
+ }
+ }
+
+ 21) done
+
+</pre><p>
+An end-of-packet condition during packet decode is to be considered a
+nominal occurrence. Decode returns the result of vector decode up to
+that point.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id326098"></a>8.6.3. format 0 specifics</h4></div></div></div><p>
+Format zero decodes partitions exactly as described earlier in the
+'Residue Format: residue 0' section. The following pseudocode
+presents the same algorithm. Assume:</p><p>
+</p><div class="itemizedlist"><ul type="disc"><li> <code class="varname">[n]</code> is the value in <code class="varname">[residue_partition_size]</code></li><li><code class="varname">[v]</code> is the residue vector</li><li><code class="varname">[offset]</code> is the beginning read offset in [v]</li></ul></div><p>
+</p><pre class="programlisting">
+ 1) [step] = [n] / [codebook_dimensions]
+ 2) iterate [i] over the range 0 ... [step]-1 {
+
+ 3) vector [entry_temp] = read vector from packet using current codebook in VQ context
+ 4) iterate [j] over the range 0 ... [codebook_dimensions]-1 {
+
+ 5) vector [v] element ([offset]+[i]+[j]*[step]) =
+ vector [v] element ([offset]+[i]+[j]*[step]) +
+ vector [entry_temp] element [j]
+
+ }
+
+ }
+
+ 6) done
+
+</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id307089"></a>8.6.4. format 1 specifics</h4></div></div></div><p>
+Format 1 decodes partitions exactly as described earlier in the
+'Residue Format: residue 1' section. The following pseudocode
+presents the same algorithm. Assume:</p><p>
+</p><div class="itemizedlist"><ul type="disc"><li> <code class="varname">[n]</code> is the value in
+<code class="varname">[residue_partition_size]</code></li><li><code class="varname">[v]</code> is the residue vector</li><li><code class="varname">[offset]</code> is the beginning read offset in [v]</li></ul></div><p>
+</p><pre class="programlisting">
+ 1) [i] = 0
+ 2) vector [entry_temp] = read vector from packet using current codebook in VQ context
+ 3) iterate [j] over the range 0 ... [codebook_dimensions]-1 {
+
+ 4) vector [v] element ([offset]+[i]) =
+ vector [v] element ([offset]+[i]) +
+ vector [entry_temp] element [j]
+ 5) increment [i]
+
+ }
+
+ 6) if ( [i] is less than [n] ) continue at step 2
+ 7) done
+</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id307141"></a>8.6.5. format 2 specifics</h4></div></div></div><p>
+Format 2 is reducible to format 1. It may be implemented as an additional step prior to and an additional post-decode step after a normal format 1 decode.
+</p><p>
+Format 2 handles 'do not decode' vectors differently than residue 0 or
+1; if all vectors are marked 'do not decode', no decode occurrs.
+However, if at least one vector is to be decoded, all the vectors are
+decoded. We then request normal format 1 to decode a single vector
+representing all output channels, rather than a vector for each
+channel. After decode, deinterleave the vector into independent vectors, one for each output channel. That is:</p><div class="orderedlist"><ol type="1"><li>If all vectors 0 through <span class="emphasis"><em>ch</em></span>-1 are marked 'do not decode', allocate and clear a single vector <code class="varname">[v]</code>of length <span class="emphasis"><em>ch*n</em></span> and skip step 2 below; proceed directly to the post-decode step.</li><li>Rather than performing format 1 decode to produce <span class="emphasis"><em>ch</em></span> vectors of length <span class="emphasis"><em>n</em></span> each, call format 1 decode to produce a single vector <code class="varname">[v]</code> of length <span class="emphasis"><em>ch*n</em></span>. </li><li><p>Post decode: Deinterleave the single vector <code class="varname">[v]</code> returned by format 1 decode as described above into <span class="emphasis"><em>ch</em></span> independent vectors, one for each outputchannel, according to:
+ </p><pre class="programlisting">
+ 1) iterate [i] over the range 0 ... [n]-1 {
+
+ 2) iterate [j] over the range 0 ... [ch]-1 {
+
+ 3) output vector number [j] element [i] = vector [v] element ([i] * [ch] + [j])
+
+ }
+ }
+
+ 4) done
+ </pre><p>
+ </p></li></ol></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-helper"></a>9. Helper equations</h2></div><div><p class="releaseinfo">
+ $Id: 09-helper.xml 7186 2004-07-20 07:19:25Z xiphmont $
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id325073"></a>9.1. Overview</h3></div></div></div><p>
+The equations below are used in multiple places by the Vorbis codec
+specification. Rather than cluttering up the main specification
+documents, they are defined here and referenced where appropriate.
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id306980"></a>9.2. Functions</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-ilog"></a>9.2.1. ilog</h4></div></div></div><p>
+The "ilog(x)" function returns the position number (1 through n) of the highest set bit in the two's complement integer value
+<code class="varname">[x]</code>. Values of <code class="varname">[x]</code> less than zero are defined to return zero.</p><pre class="programlisting">
+ 1) [return_value] = 0;
+ 2) if ( [x] is greater than zero ){
+
+ 3) increment [return_value];
+ 4) logical shift [x] one bit to the right, padding the MSb with zero
+ 5) repeat at step 2)
+
+ }
+
+ 6) done
+</pre><p>
+Examples:
+
+</p><div class="itemizedlist"><ul type="disc"><li>ilog(0) = 0;</li><li>ilog(1) = 1;</li><li>ilog(2) = 2;</li><li>ilog(3) = 2;</li><li>ilog(4) = 3;</li><li>ilog(7) = 3;</li><li>ilog(negative number) = 0;</li></ul></div><p>
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-float32_unpack"></a>9.2.2. float32_unpack</h4></div></div></div><p>
+"float32_unpack(x)" is intended to translate the packed binary
+representation of a Vorbis codebook float value into the
+representation used by the decoder for floating point numbers. For
+purposes of this example, we will unpack a Vorbis float32 into a
+host-native floating point number.</p><pre class="programlisting">
+ 1) [mantissa] = [x] bitwise AND 0x1fffff (unsigned result)
+ 2) [sign] = [x] bitwise AND 0x80000000 (unsigned result)
+ 3) [exponent] = ( [x] bitwise AND 0x7fe00000) shifted right 21 bits (unsigned result)
+ 4) if ( [sign] is nonzero ) then negate [mantissa]
+ 5) return [mantissa] * ( 2 ^ ( [exponent] - 788 ) )
+</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-lookup1_values"></a>9.2.3. lookup1_values</h4></div></div></div><p>
+"lookup1_values(codebook_entries,codebook_dimensions)" is used to
+compute the correct length of the value index for a codebook VQ lookup
+table of lookup type 1. The values on this list are permuted to
+construct the VQ vector lookup table of size
+<code class="varname">[codebook_entries]</code>.</p><p>
+The return value for this function is defined to be 'the greatest
+integer value for which <code class="varname">[return_value] to the power of
+[codebook_dimensions] is less than or equal to
+[codebook_entries]</code>'.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="vorbis-spec-low_neighbor"></a>9.2.4. low_neighbor</h4></div></div></div><p>
+"low_neighbor(v,x)" finds the position <code class="varname">n</code> in vector <code class="varname">[v]</code> of
+the greatest value scalar element for which <code class="varname">n</code> is less than
+<code class="varname">[x]</code> and vector <code class="varname">[v]</code> element <code class="varname">n</code> is less
+than vector <code class="varname">[v]</code> element <code class="varname">[x]</code>.</p><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-high_neighbor"></a>9.2.4.1. high_neighbor</h5></div></div></div><p>
+"high_neighbor(v,x)" finds the position <code class="varname">n</code> in vector [v] of
+the lowest value scalar element for which <code class="varname">n</code> is less than
+<code class="varname">[x]</code> and vector <code class="varname">[v]</code> element <code class="varname">n</code> is greater
+than vector <code class="varname">[v]</code> element <code class="varname">[x]</code>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-render_point"></a>9.2.4.2. render_point</h5></div></div></div><p>
+"render_point(x0,y0,x1,y1,X)" is used to find the Y value at point X
+along the line specified by x0, x1, y0 and y1. This function uses an
+integer algorithm to solve for the point directly without calculating
+intervening values along the line.</p><pre class="programlisting">
+ 1) [dy] = [y1] - [y0]
+ 2) [adx] = [x1] - [x0]
+ 3) [ady] = absolute value of [dy]
+ 4) [err] = [ady] * ([X] - [x0])
+ 5) [off] = [err] / [adx] using integer division
+ 6) if ( [dy] is less than zero ) {
+
+ 7) [Y] = [y0] - [off]
+
+ } else {
+
+ 8) [Y] = [y0] + [off]
+
+ }
+
+ 9) done
+</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h5 class="title"><a name="vorbis-spec-render_line"></a>9.2.4.3. render_line</h5></div></div></div><p>
+Floor decode type one uses the integer line drawing algorithm of
+"render_line(x0, y0, x1, y1, v)" to construct an integer floor
+curve for contiguous piecewise line segments. Note that it has not
+been relevant elsewhere, but here we must define integer division as
+rounding division of both positive and negative numbers toward zero.
+</p><pre class="programlisting">
+ 1) [dy] = [y1] - [y0]
+ 2) [adx] = [x1] - [x0]
+ 3) [ady] = absolute value of [dy]
+ 4) [base] = [dy] / [adx] using integer division
+ 5) [x] = [x0]
+ 6) [y] = [y0]
+ 7) [err] = 0
+
+ 8) if ( [dy] is less than 0 ) {
+
+ 9) [sy] = [base] - 1
+
+ } else {
+
+ 10) [sy] = [base] + 1
+
+ }
+
+ 11) [ady] = [ady] - (absolute value of [base]) * [adx]
+ 12) vector [v] element [x] = [y]
+
+ 13) iterate [x] over the range [x0]+1 ... [x1]-1 {
+
+ 14) [err] = [err] + [ady];
+ 15) if ( [err] >= [adx] ) {
+
+ 16) [err] = [err] - [adx]
+ 17) [y] = [y] + [sy]
+
+ } else {
+
+ 18) [y] = [y] + [base]
+
+ }
+
+ 19) vector [v] element [x] = [y]
+
+ }
+</pre></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="vorbis-spec-tables"></a>10. Tables</h2></div><div><p class="releaseinfo">
+ $Id: 10-tables.xml 7186 2004-07-20 07:19:25Z xiphmont $
+ </p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="vorbis-spec-floor1_inverse_dB_table"></a>10.1. floor1_inverse_dB_table</h3></div></div></div><p>
+The vector <code class="varname">[floor1_inverse_dB_table]</code> is a 256 element static
+lookup table consiting of the following values (read left to right
+then top to bottom):</p><pre class="screen">
+ 1.0649863e-07, 1.1341951e-07, 1.2079015e-07, 1.2863978e-07,
+ 1.3699951e-07, 1.4590251e-07, 1.5538408e-07, 1.6548181e-07,
+ 1.7623575e-07, 1.8768855e-07, 1.9988561e-07, 2.1287530e-07,
+ 2.2670913e-07, 2.4144197e-07, 2.5713223e-07, 2.7384213e-07,
+ 2.9163793e-07, 3.1059021e-07, 3.3077411e-07, 3.5226968e-07,
+ 3.7516214e-07, 3.9954229e-07, 4.2550680e-07, 4.5315863e-07,
+ 4.8260743e-07, 5.1396998e-07, 5.4737065e-07, 5.8294187e-07,
+ 6.2082472e-07, 6.6116941e-07, 7.0413592e-07, 7.4989464e-07,
+ 7.9862701e-07, 8.5052630e-07, 9.0579828e-07, 9.6466216e-07,
+ 1.0273513e-06, 1.0941144e-06, 1.1652161e-06, 1.2409384e-06,
+ 1.3215816e-06, 1.4074654e-06, 1.4989305e-06, 1.5963394e-06,
+ 1.7000785e-06, 1.8105592e-06, 1.9282195e-06, 2.0535261e-06,
+ 2.1869758e-06, 2.3290978e-06, 2.4804557e-06, 2.6416497e-06,
+ 2.8133190e-06, 2.9961443e-06, 3.1908506e-06, 3.3982101e-06,
+ 3.6190449e-06, 3.8542308e-06, 4.1047004e-06, 4.3714470e-06,
+ 4.6555282e-06, 4.9580707e-06, 5.2802740e-06, 5.6234160e-06,
+ 5.9888572e-06, 6.3780469e-06, 6.7925283e-06, 7.2339451e-06,
+ 7.7040476e-06, 8.2047000e-06, 8.7378876e-06, 9.3057248e-06,
+ 9.9104632e-06, 1.0554501e-05, 1.1240392e-05, 1.1970856e-05,
+ 1.2748789e-05, 1.3577278e-05, 1.4459606e-05, 1.5399272e-05,
+ 1.6400004e-05, 1.7465768e-05, 1.8600792e-05, 1.9809576e-05,
+ 2.1096914e-05, 2.2467911e-05, 2.3928002e-05, 2.5482978e-05,
+ 2.7139006e-05, 2.8902651e-05, 3.0780908e-05, 3.2781225e-05,
+ 3.4911534e-05, 3.7180282e-05, 3.9596466e-05, 4.2169667e-05,
+ 4.4910090e-05, 4.7828601e-05, 5.0936773e-05, 5.4246931e-05,
+ 5.7772202e-05, 6.1526565e-05, 6.5524908e-05, 6.9783085e-05,
+ 7.4317983e-05, 7.9147585e-05, 8.4291040e-05, 8.9768747e-05,
+ 9.5602426e-05, 0.00010181521, 0.00010843174, 0.00011547824,
+ 0.00012298267, 0.00013097477, 0.00013948625, 0.00014855085,
+ 0.00015820453, 0.00016848555, 0.00017943469, 0.00019109536,
+ 0.00020351382, 0.00021673929, 0.00023082423, 0.00024582449,
+ 0.00026179955, 0.00027881276, 0.00029693158, 0.00031622787,
+ 0.00033677814, 0.00035866388, 0.00038197188, 0.00040679456,
+ 0.00043323036, 0.00046138411, 0.00049136745, 0.00052329927,
+ 0.00055730621, 0.00059352311, 0.00063209358, 0.00067317058,
+ 0.00071691700, 0.00076350630, 0.00081312324, 0.00086596457,
+ 0.00092223983, 0.00098217216, 0.0010459992, 0.0011139742,
+ 0.0011863665, 0.0012634633, 0.0013455702, 0.0014330129,
+ 0.0015261382, 0.0016253153, 0.0017309374, 0.0018434235,
+ 0.0019632195, 0.0020908006, 0.0022266726, 0.0023713743,
+ 0.0025254795, 0.0026895994, 0.0028643847, 0.0030505286,
+ 0.0032487691, 0.0034598925, 0.0036847358, 0.0039241906,
+ 0.0041792066, 0.0044507950, 0.0047400328, 0.0050480668,
+ 0.0053761186, 0.0057254891, 0.0060975636, 0.0064938176,
+ 0.0069158225, 0.0073652516, 0.0078438871, 0.0083536271,
+ 0.0088964928, 0.009474637, 0.010090352, 0.010746080,
+ 0.011444421, 0.012188144, 0.012980198, 0.013823725,
+ 0.014722068, 0.015678791, 0.016697687, 0.017782797,
+ 0.018938423, 0.020169149, 0.021479854, 0.022875735,
+ 0.024362330, 0.025945531, 0.027631618, 0.029427276,
+ 0.031339626, 0.033376252, 0.035545228, 0.037855157,
+ 0.040315199, 0.042935108, 0.045725273, 0.048696758,
+ 0.051861348, 0.055231591, 0.058820850, 0.062643361,
+ 0.066714279, 0.071049749, 0.075666962, 0.080584227,
+ 0.085821044, 0.091398179, 0.097337747, 0.10366330,
+ 0.11039993, 0.11757434, 0.12521498, 0.13335215,
+ 0.14201813, 0.15124727, 0.16107617, 0.17154380,
+ 0.18269168, 0.19456402, 0.20720788, 0.22067342,
+ 0.23501402, 0.25028656, 0.26655159, 0.28387361,
+ 0.30232132, 0.32196786, 0.34289114, 0.36517414,
+ 0.38890521, 0.41417847, 0.44109412, 0.46975890,
+ 0.50028648, 0.53279791, 0.56742212, 0.60429640,
+ 0.64356699, 0.68538959, 0.72993007, 0.77736504,
+ 0.82788260, 0.88168307, 0.9389798, 1.
+</pre></div></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="vorbis-over-ogg"></a>1. Embedding Vorbis into an Ogg stream</h2><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id312362"></a>1.1. Overview</h3></div></div></div><p>
+This document describes using Ogg logical and physical transport
+streams to encapsulate Vorbis compressed audio packet data into file
+form.</p><p>
+The <a href="#vorbis-spec-intro" title="1. Introduction and Description">Section 1, “Introduction and Description”</a> provides an overview of the construction
+of Vorbis audio packets.</p><p>
+The <a href="oggstream.html" target="_top">Ogg
+bitstream overview</a> and <a href="framing.html" target="_top">Ogg logical
+bitstream and framing spec</a> provide detailed descriptions of Ogg
+transport streams. This specification document assumes a working
+knowledge of the concepts covered in these named backround
+documents. Please read them first.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id336032"></a>1.1.1. Restrictions</h4></div></div></div><p>
+The Ogg/Vorbis I specification currently dictates that Ogg/Vorbis
+streams use Ogg transport streams in degenerate, unmultiplexed
+form only. That is:
+
+</p><div class="itemizedlist"><ul type="disc"><li>
+ A meta-headerless Ogg file encapsulates the Vorbis I packets
+ </li><li>
+ The Ogg stream may be chained, i.e. contain multiple, contigous logical streams (links).
+ </li><li>
+ The Ogg stream must be unmultiplexed (only one stream, a Vorbis audio stream, per link)
+ </li></ul></div><p>
+</p><p>
+This is not to say that it is not currently possible to multiplex
+Vorbis with other media types into a multi-stream Ogg file. At the
+time this document was written, Ogg was becoming a popular container
+for low-bitrate movies consisting of DiVX video and Vorbis audio.
+However, a 'Vorbis I audio file' is taken to imply Vorbis audio
+existing alone within a degenerate Ogg stream. A compliant 'Vorbis
+audio player' is not required to implement Ogg support beyond the
+specific support of Vorbis within a degenrate ogg stream (naturally,
+application authors are encouraged to support full multiplexed Ogg
+handling).
+</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id319459"></a>1.1.2. MIME type</h4></div></div></div><p>
+The correct MIME type of any Ogg file is <code class="literal">application/ogg</code>.
+However, if a file is a Vorbis I audio file (which implies a
+degenerate Ogg stream including only unmultiplexed Vorbis audio), the
+mime type <code class="literal">audio/x-vorbis</code> is also allowed.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id317588"></a>1.2. Encapsulation</h3></div></div></div><p>
+Ogg encapsulation of a Vorbis packet stream is straightforward.</p><div class="itemizedlist"><ul type="disc"><li>
+ The first Vorbis packet (the identification header), which
+ uniquely identifies a stream as Vorbis audio, is placed alone in the
+ first page of the logical Ogg stream. This results in a first Ogg
+ page of exactly 58 bytes at the very beginning of the logical stream.
+</li><li>
+ This first page is marked 'beginning of stream' in the page flags.
+</li><li>
+ The second and third vorbis packets (comment and setup
+ headers) may span one or more pages beginning on the second page of
+ the logical stream. However many pages they span, the third header
+ packet finishes the page on which it ends. The next (first audio) packet
+ must begin on a fresh page.
+</li><li>
+ The granule position of these first pages containing only headers is zero.
+</li><li>
+ The first audio packet of the logical stream begins a fresh Ogg page.
+</li><li>
+ Packets are placed into ogg pages in order until the end of stream.
+</li><li>
+ The last page is marked 'end of stream' in the page flags.
+</li><li>
+ Vorbis packets may span page boundaries.
+</li><li>
+ The granule position of pages containing Vorbis audio is in units
+ of PCM audio samples (per channel; a stereo stream's granule position
+ does not increment at twice the speed of a mono stream).
+</li><li><p>
+ The granule position of a page represents the end PCM sample
+ position of the last packet <span class="emphasis"><em>completed</em></span> on that
+ page. The 'last PCM sample' is the last complete sample returned by
+ decode, not an internal sample awaiting lapping with a
+ subsequent block. A page that is entirely spanned by a single
+ packet (that completes on a subsequent page) has no granule
+ position, and the granule position is set to '-1'. </p><p>
+ Note that the last decoded (fully lapped) PCM sample from a packet
+ is not necessarily the middle sample from that block. If, eg, the
+ current Vorbis packet encodes a "long block" and the next Vorbis
+ packet encodes a "short block", the last decodable sample from the
+ current packet be at position (3*long_block_length/4) -
+ (short_block_length/4).
+</p></li><li><p>
+ The granule (PCM) position of the first page need not indicate
+ that the stream started at position zero. Although the granule
+ position belongs to the last completed packet on the page and a
+ valid granule position must be positive, by
+ inference it may indicate that the PCM position of the beginning
+ of audio is positive or negative.
+ </p><div class="itemizedlist"><ul type="circle"><li>
+ A positive starting value simply indicates that this stream begins at
+ some positive time offset, potentially within a larger
+ program. This is a common case when connecting to the middle
+ of broadcast stream.
+ </li><li>
+ A negative value indicates that
+ output samples preceeding time zero should be discarded during
+ decoding; this technique is used to allow sample-granularity
+ editing of the stream start time of already-encoded Vorbis
+ streams. The number of samples to be discarded must not exceed
+ the overlap-add span of the first two audio packets.
+ </li></ul></div><p>
+ In both of these cases in which the initial audio PCM starting
+ offset is nonzero, the second finished audio packet must flush the
+ page on which it appears and the third packet begin a fresh page.
+ This allows the decoder to always be able to perform PCM position
+ adjustments before needing to return any PCM data from synthesis,
+ resulting in correct positioning information without any aditional
+ seeking logic.
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+ Failure to do so should, at worst, cause a
+ decoder implementation to return incorrect positioning information
+ for seeking operations at the very beginning of the stream.
+ </p></div></li><li>
+ A granule position on the final page in a stream that indicates
+ less audio data than the final packet would normally return is used to
+ end the stream on other than even frame boundaries. The difference
+ between the actual available data returned and the declared amount
+ indicates how many trailing samples to discard from the decoding
+ process.
+ </li></ul></div></div></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="vorbis-over-rtp"></a>2. Vorbis encapsulation in RTP</h2><pre class="literallayout">
+
+
+
+ <p>Please consult the internet draft <em class="citetitle">RTP Payload Format for Vorbis Encoded
+ Audio</em> for description of how to embed Vorbis audio in an RTP stream.</p>
+
+</pre></div><div class="appendix" lang="en"><h2 class="title" style="clear: both"><a name="footer"></a>3. Colophon</h2><div class="mediaobject"><img src="white-xifish.png" alt="[Xiph.org logo]"></div><p>
+Ogg is a <a href="http://www.xiph.org/" target="_top">Xiph.org Foundation</a> effort
+to protect essential tenets of Internet multimedia from corporate
+hostage-taking; Open Source is the net's greatest tool to keep
+everyone honest. See <a href="http://www.xiph.org/about.html" target="_top">About
+the Xiph.org Foundation</a> for details.
+</p><p>
+Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
+distribute the Ogg and Vorbis specification, whether in a private,
+public or corporate capacity. However, the Xiph.org Foundation and
+the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
+specification and certify specification compliance.</p><p>
+Xiph.org's Vorbis software CODEC implementation is distributed under a
+BSD-like license. This does not restrict third parties from
+distributing independent implementations of Vorbis software under
+other licenses.</p><p>
+Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
+of the <a href="http://www.xiph.org/" target="_top">Xiph.org Foundation</a>. These
+pages are copyright (C) 1994-2007 Xiph.org Foundation. All rights
+reserved.</p><p>
+This document is set in DocBook XML.
+</p></div></div></body></html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/Vorbis_I_spec.pdf
===================================================================
(Binary files differ)
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/floor1_inverse_dB_table.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/floor1_inverse_dB_table.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/floor1_inverse_dB_table.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,112 +1,154 @@
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p>
-
-<h1><font color=#000070>
-Ogg Vorbis I format specification: floor1_inverse_dB_table
-</font></h1>
-
-<em>Last update to this document: July 18, 2002</em><p>
-
-The vector <tt>[floor1_inverse_dB_table]</tt> is a 256 element static
-lookup table consiting of the following values (read left to right
-then top to bottom):
-
-<pre>
- 1.0649863e-07, 1.1341951e-07, 1.2079015e-07, 1.2863978e-07,
- 1.3699951e-07, 1.4590251e-07, 1.5538408e-07, 1.6548181e-07,
- 1.7623575e-07, 1.8768855e-07, 1.9988561e-07, 2.1287530e-07,
- 2.2670913e-07, 2.4144197e-07, 2.5713223e-07, 2.7384213e-07,
- 2.9163793e-07, 3.1059021e-07, 3.3077411e-07, 3.5226968e-07,
- 3.7516214e-07, 3.9954229e-07, 4.2550680e-07, 4.5315863e-07,
- 4.8260743e-07, 5.1396998e-07, 5.4737065e-07, 5.8294187e-07,
- 6.2082472e-07, 6.6116941e-07, 7.0413592e-07, 7.4989464e-07,
- 7.9862701e-07, 8.5052630e-07, 9.0579828e-07, 9.6466216e-07,
- 1.0273513e-06, 1.0941144e-06, 1.1652161e-06, 1.2409384e-06,
- 1.3215816e-06, 1.4074654e-06, 1.4989305e-06, 1.5963394e-06,
- 1.7000785e-06, 1.8105592e-06, 1.9282195e-06, 2.0535261e-06,
- 2.1869758e-06, 2.3290978e-06, 2.4804557e-06, 2.6416497e-06,
- 2.8133190e-06, 2.9961443e-06, 3.1908506e-06, 3.3982101e-06,
- 3.6190449e-06, 3.8542308e-06, 4.1047004e-06, 4.3714470e-06,
- 4.6555282e-06, 4.9580707e-06, 5.2802740e-06, 5.6234160e-06,
- 5.9888572e-06, 6.3780469e-06, 6.7925283e-06, 7.2339451e-06,
- 7.7040476e-06, 8.2047000e-06, 8.7378876e-06, 9.3057248e-06,
- 9.9104632e-06, 1.0554501e-05, 1.1240392e-05, 1.1970856e-05,
- 1.2748789e-05, 1.3577278e-05, 1.4459606e-05, 1.5399272e-05,
- 1.6400004e-05, 1.7465768e-05, 1.8600792e-05, 1.9809576e-05,
- 2.1096914e-05, 2.2467911e-05, 2.3928002e-05, 2.5482978e-05,
- 2.7139006e-05, 2.8902651e-05, 3.0780908e-05, 3.2781225e-05,
- 3.4911534e-05, 3.7180282e-05, 3.9596466e-05, 4.2169667e-05,
- 4.4910090e-05, 4.7828601e-05, 5.0936773e-05, 5.4246931e-05,
- 5.7772202e-05, 6.1526565e-05, 6.5524908e-05, 6.9783085e-05,
- 7.4317983e-05, 7.9147585e-05, 8.4291040e-05, 8.9768747e-05,
- 9.5602426e-05, 0.00010181521, 0.00010843174, 0.00011547824,
- 0.00012298267, 0.00013097477, 0.00013948625, 0.00014855085,
- 0.00015820453, 0.00016848555, 0.00017943469, 0.00019109536,
- 0.00020351382, 0.00021673929, 0.00023082423, 0.00024582449,
- 0.00026179955, 0.00027881276, 0.00029693158, 0.00031622787,
- 0.00033677814, 0.00035866388, 0.00038197188, 0.00040679456,
- 0.00043323036, 0.00046138411, 0.00049136745, 0.00052329927,
- 0.00055730621, 0.00059352311, 0.00063209358, 0.00067317058,
- 0.00071691700, 0.00076350630, 0.00081312324, 0.00086596457,
- 0.00092223983, 0.00098217216, 0.0010459992, 0.0011139742,
- 0.0011863665, 0.0012634633, 0.0013455702, 0.0014330129,
- 0.0015261382, 0.0016253153, 0.0017309374, 0.0018434235,
- 0.0019632195, 0.0020908006, 0.0022266726, 0.0023713743,
- 0.0025254795, 0.0026895994, 0.0028643847, 0.0030505286,
- 0.0032487691, 0.0034598925, 0.0036847358, 0.0039241906,
- 0.0041792066, 0.0044507950, 0.0047400328, 0.0050480668,
- 0.0053761186, 0.0057254891, 0.0060975636, 0.0064938176,
- 0.0069158225, 0.0073652516, 0.0078438871, 0.0083536271,
- 0.0088964928, 0.009474637, 0.010090352, 0.010746080,
- 0.011444421, 0.012188144, 0.012980198, 0.013823725,
- 0.014722068, 0.015678791, 0.016697687, 0.017782797,
- 0.018938423, 0.020169149, 0.021479854, 0.022875735,
- 0.024362330, 0.025945531, 0.027631618, 0.029427276,
- 0.031339626, 0.033376252, 0.035545228, 0.037855157,
- 0.040315199, 0.042935108, 0.045725273, 0.048696758,
- 0.051861348, 0.055231591, 0.058820850, 0.062643361,
- 0.066714279, 0.071049749, 0.075666962, 0.080584227,
- 0.085821044, 0.091398179, 0.097337747, 0.10366330,
- 0.11039993, 0.11757434, 0.12521498, 0.13335215,
- 0.14201813, 0.15124727, 0.16107617, 0.17154380,
- 0.18269168, 0.19456402, 0.20720788, 0.22067342,
- 0.23501402, 0.25028656, 0.26655159, 0.28387361,
- 0.30232132, 0.32196786, 0.34289114, 0.36517414,
- 0.38890521, 0.41417847, 0.44109412, 0.46975890,
- 0.50028648, 0.53279791, 0.56742212, 0.60429640,
- 0.64356699, 0.68538959, 0.72993007, 0.77736504,
- 0.82788260, 0.88168307, 0.9389798, 1.
-<pre>
-
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-the Xiph.org Foundation</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-
-</body>
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Ogg Vorbis I format specification: floor1_inverse_dB_table</h1>
+
+<p>The vector <tt>[floor1_inverse_dB_table]</tt> is a 256 element static
+lookup table consiting of the following values (read left to right
+then top to bottom):</p>
+
+<pre>
+ 1.0649863e-07, 1.1341951e-07, 1.2079015e-07, 1.2863978e-07,
+ 1.3699951e-07, 1.4590251e-07, 1.5538408e-07, 1.6548181e-07,
+ 1.7623575e-07, 1.8768855e-07, 1.9988561e-07, 2.1287530e-07,
+ 2.2670913e-07, 2.4144197e-07, 2.5713223e-07, 2.7384213e-07,
+ 2.9163793e-07, 3.1059021e-07, 3.3077411e-07, 3.5226968e-07,
+ 3.7516214e-07, 3.9954229e-07, 4.2550680e-07, 4.5315863e-07,
+ 4.8260743e-07, 5.1396998e-07, 5.4737065e-07, 5.8294187e-07,
+ 6.2082472e-07, 6.6116941e-07, 7.0413592e-07, 7.4989464e-07,
+ 7.9862701e-07, 8.5052630e-07, 9.0579828e-07, 9.6466216e-07,
+ 1.0273513e-06, 1.0941144e-06, 1.1652161e-06, 1.2409384e-06,
+ 1.3215816e-06, 1.4074654e-06, 1.4989305e-06, 1.5963394e-06,
+ 1.7000785e-06, 1.8105592e-06, 1.9282195e-06, 2.0535261e-06,
+ 2.1869758e-06, 2.3290978e-06, 2.4804557e-06, 2.6416497e-06,
+ 2.8133190e-06, 2.9961443e-06, 3.1908506e-06, 3.3982101e-06,
+ 3.6190449e-06, 3.8542308e-06, 4.1047004e-06, 4.3714470e-06,
+ 4.6555282e-06, 4.9580707e-06, 5.2802740e-06, 5.6234160e-06,
+ 5.9888572e-06, 6.3780469e-06, 6.7925283e-06, 7.2339451e-06,
+ 7.7040476e-06, 8.2047000e-06, 8.7378876e-06, 9.3057248e-06,
+ 9.9104632e-06, 1.0554501e-05, 1.1240392e-05, 1.1970856e-05,
+ 1.2748789e-05, 1.3577278e-05, 1.4459606e-05, 1.5399272e-05,
+ 1.6400004e-05, 1.7465768e-05, 1.8600792e-05, 1.9809576e-05,
+ 2.1096914e-05, 2.2467911e-05, 2.3928002e-05, 2.5482978e-05,
+ 2.7139006e-05, 2.8902651e-05, 3.0780908e-05, 3.2781225e-05,
+ 3.4911534e-05, 3.7180282e-05, 3.9596466e-05, 4.2169667e-05,
+ 4.4910090e-05, 4.7828601e-05, 5.0936773e-05, 5.4246931e-05,
+ 5.7772202e-05, 6.1526565e-05, 6.5524908e-05, 6.9783085e-05,
+ 7.4317983e-05, 7.9147585e-05, 8.4291040e-05, 8.9768747e-05,
+ 9.5602426e-05, 0.00010181521, 0.00010843174, 0.00011547824,
+ 0.00012298267, 0.00013097477, 0.00013948625, 0.00014855085,
+ 0.00015820453, 0.00016848555, 0.00017943469, 0.00019109536,
+ 0.00020351382, 0.00021673929, 0.00023082423, 0.00024582449,
+ 0.00026179955, 0.00027881276, 0.00029693158, 0.00031622787,
+ 0.00033677814, 0.00035866388, 0.00038197188, 0.00040679456,
+ 0.00043323036, 0.00046138411, 0.00049136745, 0.00052329927,
+ 0.00055730621, 0.00059352311, 0.00063209358, 0.00067317058,
+ 0.00071691700, 0.00076350630, 0.00081312324, 0.00086596457,
+ 0.00092223983, 0.00098217216, 0.0010459992, 0.0011139742,
+ 0.0011863665, 0.0012634633, 0.0013455702, 0.0014330129,
+ 0.0015261382, 0.0016253153, 0.0017309374, 0.0018434235,
+ 0.0019632195, 0.0020908006, 0.0022266726, 0.0023713743,
+ 0.0025254795, 0.0026895994, 0.0028643847, 0.0030505286,
+ 0.0032487691, 0.0034598925, 0.0036847358, 0.0039241906,
+ 0.0041792066, 0.0044507950, 0.0047400328, 0.0050480668,
+ 0.0053761186, 0.0057254891, 0.0060975636, 0.0064938176,
+ 0.0069158225, 0.0073652516, 0.0078438871, 0.0083536271,
+ 0.0088964928, 0.009474637, 0.010090352, 0.010746080,
+ 0.011444421, 0.012188144, 0.012980198, 0.013823725,
+ 0.014722068, 0.015678791, 0.016697687, 0.017782797,
+ 0.018938423, 0.020169149, 0.021479854, 0.022875735,
+ 0.024362330, 0.025945531, 0.027631618, 0.029427276,
+ 0.031339626, 0.033376252, 0.035545228, 0.037855157,
+ 0.040315199, 0.042935108, 0.045725273, 0.048696758,
+ 0.051861348, 0.055231591, 0.058820850, 0.062643361,
+ 0.066714279, 0.071049749, 0.075666962, 0.080584227,
+ 0.085821044, 0.091398179, 0.097337747, 0.10366330,
+ 0.11039993, 0.11757434, 0.12521498, 0.13335215,
+ 0.14201813, 0.15124727, 0.16107617, 0.17154380,
+ 0.18269168, 0.19456402, 0.20720788, 0.22067342,
+ 0.23501402, 0.25028656, 0.26655159, 0.28387361,
+ 0.30232132, 0.32196786, 0.34289114, 0.36517414,
+ 0.38890521, 0.41417847, 0.44109412, 0.46975890,
+ 0.50028648, 0.53279791, 0.56742212, 0.60429640,
+ 0.64356699, 0.68538959, 0.72993007, 0.77736504,
+ 0.82788260, 0.88168307, 0.9389798, 1.
+</pre>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2005 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/framing.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/framing.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/framing.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,395 +1,431 @@
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><a href="http://www.xiph.org/ogg/index.html"><img src="white-ogg.png" border=0><img
-src="vorbisword2.png" border=0></a></nobr><p>
-
-<h1><font color=#000070>
-Ogg logical bitstream framing
-</font></h1>
-
-<em>Last update to this document: July 14, 2002</em><br>
-
-<h2>Ogg bitstreams</h2>
-
-The Ogg transport bitstream is designed to provide framing, error
-protection and seeking structure for higher-level codec streams that
-consist of raw, unencapsulated data packets, such as the Vorbis audio
-codec or Tarkin video codec.
-
-<h2>Application example: Vorbis</h2>
-Vorbis encodes short-time blocks of PCM data into raw packets of
-bit-packed data. These raw packets may be used directly by transport
-mechanisms that provide their own framing and packet-separation
-mechanisms (such as UDP datagrams). For stream based storage (such as
-files) and transport (such as TCP streams or pipes), Vorbis uses the
-Ogg bitstream format to provide framing/sync, sync recapture
-after error, landmarks during seeking, and enough information to
-properly separate data back into packets at the original packet
-boundaries without relying on decoding to find packet boundaries.<p>
-
-<h2>Design constraints for Ogg bitstreams</h2>
-
-<ol><li>True streaming; we must not need to seek to build a 100%
- complete bitstream.
-
-<li> Use no more than approximately 1-2% of bitstream bandwidth for
- packet boundary marking, high-level framing, sync and seeking.
-
-<li> Specification of absolute position within the original sample
- stream.
-
-<li> Simple mechanism to ease limited editing, such as a simplified
- concatenation mechanism.
-
-<li> Detection of corruption, recapture after error and direct, random
- access to data at arbitrary positions in the bitstream.
-</ol>
-
-<h2>Logical and Physical Bitstreams</h2>
-
-A <em>logical</em> Ogg bitstream is a contiguous stream of
-sequential pages belonging only to the logical bitstream. A
-<em>physical</em> Ogg bitstream is constructed from one or more
-than one logical Ogg bitstream (the simplest physical bitstream
-is simply a single logical bitstream). We describe below the exact
-formatting of an Ogg logical bitstream. Combining logical
-bitstreams into more complex physical bitstreams is described in the
-<a href="oggstream.html">Ogg bitstream overview</a>. The exact
-mapping of raw Vorbis packets into a valid Ogg Vorbis physical
-bitstream is described in <a href="vorbis-stream.html">Vorbis
-bitstream mapping</a>.
-
-<h2>Bitstream structure</h2>
-
-An Ogg stream is structured by dividing incoming packets into
-segments of up to 255 bytes and then wrapping a group of contiguous
-packet segments into a variable length page preceded by a page
-header. Both the header size and page size are variable; the page
-header contains sizing information and checksum data to determine
-header/page size and data integrity.<p>
-
-The bitstream is captured (or recaptured) by looking for the beginning
-of a page, specifically the capture pattern. Once the capture pattern
-is found, the decoder verifies page sync and integrity by computing
-and comparing the checksum. At that point, the decoder can extract the
-packets themselves.<p>
-
-<h3>Packet segmentation</h3>
-
-Packets are logically divided into multiple segments before encoding
-into a page. Note that the segmentation and fragmentation process is a
-logical one; it's used to compute page header values and the original
-page data need not be disturbed, even when a packet spans page
-boundaries.<p>
-
-The raw packet is logically divided into [n] 255 byte segments and a
-last fractional segment of < 255 bytes. A packet size may well
-consist only of the trailing fractional segment, and a fractional
-segment may be zero length. These values, called "lacing values" are
-then saved and placed into the header segment table.<p>
-
-An example should make the basic concept clear:<p>
-
-<pre>
-<tt>
-raw packet:
- ___________________________________________
- |______________packet data__________________| 753 bytes
-
-lacing values for page header segment table: 255,255,243
-</tt>
-</pre>
-
-We simply add the lacing values for the total size; the last lacing
-value for a packet is always the value that is less than 255. Note
-that this encoding both avoids imposing a maximum packet size as well
-as imposing minimum overhead on small packets (as opposed to, eg,
-simply using two bytes at the head of every packet and having a max
-packet size of 32k. Small packets (<255, the typical case) are
-penalized with twice the segmentation overhead). Using the lacing
-values as suggested, small packets see the minimum possible
-byte-aligned overheade (1 byte) and large packets, over 512 bytes or
-so, see a fairly constant ~.5% overhead on encoding space.<p>
-
-Note that a lacing value of 255 implies that a second lacing value
-follows in the packet, and a value of < 255 marks the end of the
-packet after that many additional bytes. A packet of 255 bytes (or a
-multiple of 255 bytes) is terminated by a lacing value of 0:<p>
-
-<pre><tt>
-raw packet:
- _______________________________
- |________packet data____________| 255 bytes
-
-lacing values: 255, 0
-</tt></pre>
-
-Note also that a 'nil' (zero length) packet is not an error; it
-consists of nothing more than a lacing value of zero in the header.<p>
-
-<h3>Packets spanning pages</h3>
-
-Packets are not restricted to beginning and ending within a page,
-although individual segments are, by definition, required to do so.
-Packets are not restricted to a maximum size, although excessively
-large packets in the data stream are discouraged; the Ogg
-bitstream specification strongly recommends nominal page size of
-approximately 4-8kB (large packets are foreseen as being useful for
-initialization data at the beginning of a logical bitstream).<p>
-
-After segmenting a packet, the encoder may decide not to place all the
-resulting segments into the current page; to do so, the encoder places
-the lacing values of the segments it wishes to belong to the current
-page into the current segment table, then finishes the page. The next
-page is begun with the first value in the segment table belonging to
-the next packet segment, thus continuing the packet (data in the
-packet body must also correspond properly to the lacing values in the
-spanned pages. The segment data in the first packet corresponding to
-the lacing values of the first page belong in that page; packet
-segments listed in the segment table of the following page must begin
-the page body of the subsequent page).<p>
-
-The last mechanic to spanning a page boundary is to set the header
-flag in the new page to indicate that the first lacing value in the
-segment table continues rather than begins a packet; a header flag of
-0x01 is set to indicate a continued packet. Although mandatory, it
-is not actually algorithmically necessary; one could inspect the
-preceding segment table to determine if the packet is new or
-continued. Adding the information to the packet_header flag allows a
-simpler design (with no overhead) that needs only inspect the current
-page header after frame capture. This also allows faster error
-recovery in the event that the packet originates in a corrupt
-preceding page, implying that the previous page's segment table
-cannot be trusted.<p>
-
-Note that a packet can span an arbitrary number of pages; the above
-spanning process is repeated for each spanned page boundary. Also a
-'zero termination' on a packet size that is an even multiple of 255
-must appear even if the lacing value appears in the next page as a
-zero-length continuation of the current packet. The header flag
-should be set to 0x01 to indicate that the packet spanned, even though
-the span is a nil case as far as data is concerned.<p>
-
-The encoding looks odd, but is properly optimized for speed and the
-expected case of the majority of packets being between 50 and 200
-bytes (note that it is designed such that packets of wildly different
-sizes can be handled within the model; placing packet size
-restrictions on the encoder would have only slightly simplified design
-in page generation and increased overall encoder complexity).<p>
-
-The main point behind tracking individual packets (and packet
-segments) is to allow more flexible encoding tricks that requiring
-explicit knowledge of packet size. An example is simple bandwidth
-limiting, implemented by simply truncating packets in the nominal case
-if the packet is arranged so that the least sensitive portion of the
-data comes last.<p>
-
-<h3>Page header</h3>
-
-The headering mechanism is designed to avoid copying and re-assembly
-of the packet data (ie, making the packet segmentation process a
-logical one); the header can be generated directly from incoming
-packet data. The encoder buffers packet data until it finishes a
-complete page at which point it writes the header followed by the
-buffered packet segments.<p>
-
-<h4>capture_pattern</h4>
-
- A header begins with a capture pattern that simplifies identifying
- pages; once the decoder has found the capture pattern it can do a more
- intensive job of verifying that it has in fact found a page boundary
- (as opposed to an inadvertent coincidence in the byte stream).<p>
-
-<pre><tt>
- byte value
-
- 0 0x4f 'O'
- 1 0x67 'g'
- 2 0x67 'g'
- 3 0x53 'S'
-</tt></pre>
-
-<h4>stream_structure_version</h4>
-
- The capture pattern is followed by the stream structure revision:
-
-<pre><tt>
- byte value
-
- 4 0x00
-</tt></pre>
-
-<h4>header_type_flag</h4>
-
- The header type flag identifies this page's context in the bitstream:
-
-<pre><tt>
- byte value
-
- 5 bitflags: 0x01: unset = fresh packet
- set = continued packet
- 0x02: unset = not first page of logical bitstream
- set = first page of logical bitstream (bos)
- 0x04: unset = not last page of logical bitstream
- set = last page of logical bitstream (eos)
-</tt></pre>
-
-<h4>absolute granule position</h4>
-
- (This is packed in the same way the rest of Ogg data is packed; LSb
- of LSB first. Note that the 'position' data specifies a 'sample'
- number (eg, in a CD quality sample is four octets, 16 bits for left
- and 16 bits for right; in video it would likely be the frame number.
- It is up to the specific codec in use to define the semantic meaning
- of the granule position value). The position specified is the total
- samples encoded after including all packets finished on this page
- (packets begun on this page but continuing on to the next page do not
- count). The rationale here is that the position specified in the
- frame header of the last page tells how long the data coded by the
- bitstream is. A truncated stream will still return the proper number
- of samples that can be decoded fully.
-<p>
- A special value of '-1' (in two's complement) indicates that no packets
- finish on this page.
-
-<pre><tt>
- byte value
-
- 6 0xXX LSB
- 7 0xXX
- 8 0xXX
- 9 0xXX
- 10 0xXX
- 11 0xXX
- 12 0xXX
- 13 0xXX MSB
-</tt></pre>
-
-<h4>stream serial number</h4>
-
- Ogg allows for separate logical bitstreams to be mixed at page
- granularity in a physical bitstream. The most common case would be
- sequential arrangement, but it is possible to interleave pages for
- two separate bitstreams to be decoded concurrently. The serial
- number is the means by which pages physical pages are associated with
- a particular logical stream. Each logical stream must have a unique
- serial number within a physical stream:
-
-<pre><tt>
- byte value
-
- 14 0xXX LSB
- 15 0xXX
- 16 0xXX
- 17 0xXX MSB
-</tt></pre>
-
-<h4>page sequence no</h4>
-
- Page counter; lets us know if a page is lost (useful where packets
- span page boundaries).
-
-<pre><tt>
- byte value
-
- 18 0xXX LSB
- 19 0xXX
- 20 0xXX
- 21 0xXX MSB
-</tt></pre>
-
-<h4>page checksum</h4>
-
- 32 bit CRC value (direct algorithm, initial val and final XOR = 0,
- generator polynomial=0x04c11db7). The value is computed over the
- entire header (with the CRC field in the header set to zero) and then
- continued over the page. The CRC field is then filled with the
- computed value.<p>
-
- (A thorough discussion of CRC algorithms can be found in <a
- href="ftp://ftp.rocksoft.com/papers/crc_v3.txt">"A
- Painless Guide to CRC Error Detection Algorithms"</a> by Ross
- Williams <a
- href="mailto:ross at guest.adelaide.edu.au">ross at guest.adelaide.edu.au</a>.)
-
-<pre><tt>
- byte value
-
- 22 0xXX LSB
- 23 0xXX
- 24 0xXX
- 25 0xXX MSB
-</tt></pre>
-
-<h4>page_segments</h4>
-
- The number of segment entries to appear in the segment table. The
- maximum number of 255 segments (255 bytes each) sets the maximum
- possible physical page size at 65307 bytes or just under 64kB (thus
- we know that a header corrupted so as destroy sizing/alignment
- information will not cause a runaway bitstream. We'll read in the
- page according to the corrupted size information that's guaranteed to
- be a reasonable size regardless, notice the checksum mismatch, drop
- sync and then look for recapture).<p>
-
-<pre><tt>
- byte value
-
- 26 0x00-0xff (0-255)
-</tt></pre>
-
-<h4>segment_table (containing packet lacing values)</h4>
-
- The lacing values for each packet segment physically appearing in
- this page are listed in contiguous order.
-
-<pre><tt>
- byte value
-
- 27 0x00-0xff (0-255)
- [...]
- n 0x00-0xff (0-255, n=page_segments+26)
-</tt></pre>
-
-Total page size is calculated directly from the known header size and
-lacing values in the segment table. Packet data segments follow
-immediately after the header.<p>
-
-Page headers typically impose a flat .25-.5% space overhead assuming
-nominal ~8k page sizes. The segmentation table needed for exact
-packet recovery in the streaming layer adds approximately .5-1%
-nominal assuming expected encoder behavior in the 44.1kHz, 128kbps
-stereo encodings.<p>
-
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-the Xiph.org Foundation</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-
-</body>
-
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Ogg logical bitstream framing</h1>
+
+<h2>Ogg bitstreams</h2>
+
+<p>The Ogg transport bitstream is designed to provide framing, error
+protection and seeking structure for higher-level codec streams that
+consist of raw, unencapsulated data packets, such as the Vorbis audio
+codec or Theora video codec.</p>
+
+<h2>Application example: Vorbis</h2>
+
+<p>Vorbis encodes short-time blocks of PCM data into raw packets of
+bit-packed data. These raw packets may be used directly by transport
+mechanisms that provide their own framing and packet-separation
+mechanisms (such as UDP datagrams). For stream based storage (such as
+files) and transport (such as TCP streams or pipes), Vorbis uses the
+Ogg bitstream format to provide framing/sync, sync recapture
+after error, landmarks during seeking, and enough information to
+properly separate data back into packets at the original packet
+boundaries without relying on decoding to find packet boundaries.</p>
+
+<h2>Design constraints for Ogg bitstreams</h2>
+
+<ol>
+<li>True streaming; we must not need to seek to build a 100%
+ complete bitstream.</li>
+<li>Use no more than approximately 1-2% of bitstream bandwidth for
+ packet boundary marking, high-level framing, sync and seeking.</li>
+<li>Specification of absolute position within the original sample
+ stream.</li>
+<li>Simple mechanism to ease limited editing, such as a simplified
+ concatenation mechanism.</li>
+<li>Detection of corruption, recapture after error and direct, random
+ access to data at arbitrary positions in the bitstream.</li>
+</ol>
+
+<h2>Logical and Physical Bitstreams</h2>
+
+<p>A <em>logical</em> Ogg bitstream is a contiguous stream of
+sequential pages belonging only to the logical bitstream. A
+<em>physical</em> Ogg bitstream is constructed from one or more
+than one logical Ogg bitstream (the simplest physical bitstream
+is simply a single logical bitstream). We describe below the exact
+formatting of an Ogg logical bitstream. Combining logical
+bitstreams into more complex physical bitstreams is described in the
+<a href="oggstream.html">Ogg bitstream overview</a>. The exact
+mapping of raw Vorbis packets into a valid Ogg Vorbis physical
+bitstream is described in the Vorbis I Specification.</p>
+
+<h2>Bitstream structure</h2>
+
+<p>An Ogg stream is structured by dividing incoming packets into
+segments of up to 255 bytes and then wrapping a group of contiguous
+packet segments into a variable length page preceded by a page
+header. Both the header size and page size are variable; the page
+header contains sizing information and checksum data to determine
+header/page size and data integrity.</p>
+
+<p>The bitstream is captured (or recaptured) by looking for the beginning
+of a page, specifically the capture pattern. Once the capture pattern
+is found, the decoder verifies page sync and integrity by computing
+and comparing the checksum. At that point, the decoder can extract the
+packets themselves.</p>
+
+<h3>Packet segmentation</h3>
+
+<p>Packets are logically divided into multiple segments before encoding
+into a page. Note that the segmentation and fragmentation process is a
+logical one; it's used to compute page header values and the original
+page data need not be disturbed, even when a packet spans page
+boundaries.</p>
+
+<p>The raw packet is logically divided into [n] 255 byte segments and a
+last fractional segment of < 255 bytes. A packet size may well
+consist only of the trailing fractional segment, and a fractional
+segment may be zero length. These values, called "lacing values" are
+then saved and placed into the header segment table.</p>
+
+<p>An example should make the basic concept clear:</p>
+
+<pre>
+<tt>
+raw packet:
+ ___________________________________________
+ |______________packet data__________________| 753 bytes
+
+lacing values for page header segment table: 255,255,243
+</tt>
+</pre>
+
+<p>We simply add the lacing values for the total size; the last lacing
+value for a packet is always the value that is less than 255. Note
+that this encoding both avoids imposing a maximum packet size as well
+as imposing minimum overhead on small packets (as opposed to, eg,
+simply using two bytes at the head of every packet and having a max
+packet size of 32k. Small packets (<255, the typical case) are
+penalized with twice the segmentation overhead). Using the lacing
+values as suggested, small packets see the minimum possible
+byte-aligned overheade (1 byte) and large packets, over 512 bytes or
+so, see a fairly constant ~.5% overhead on encoding space.</p>
+
+<p>Note that a lacing value of 255 implies that a second lacing value
+follows in the packet, and a value of < 255 marks the end of the
+packet after that many additional bytes. A packet of 255 bytes (or a
+multiple of 255 bytes) is terminated by a lacing value of 0:</p>
+
+<pre><tt>
+raw packet:
+ _______________________________
+ |________packet data____________| 255 bytes
+
+lacing values: 255, 0
+</tt></pre>
+
+<p>Note also that a 'nil' (zero length) packet is not an error; it
+consists of nothing more than a lacing value of zero in the header.</p>
+
+<h3>Packets spanning pages</h3>
+
+<p>Packets are not restricted to beginning and ending within a page,
+although individual segments are, by definition, required to do so.
+Packets are not restricted to a maximum size, although excessively
+large packets in the data stream are discouraged; the Ogg
+bitstream specification strongly recommends nominal page size of
+approximately 4-8kB (large packets are foreseen as being useful for
+initialization data at the beginning of a logical bitstream).</p>
+
+<p>After segmenting a packet, the encoder may decide not to place all the
+resulting segments into the current page; to do so, the encoder places
+the lacing values of the segments it wishes to belong to the current
+page into the current segment table, then finishes the page. The next
+page is begun with the first value in the segment table belonging to
+the next packet segment, thus continuing the packet (data in the
+packet body must also correspond properly to the lacing values in the
+spanned pages. The segment data in the first packet corresponding to
+the lacing values of the first page belong in that page; packet
+segments listed in the segment table of the following page must begin
+the page body of the subsequent page).</p>
+
+<p>The last mechanic to spanning a page boundary is to set the header
+flag in the new page to indicate that the first lacing value in the
+segment table continues rather than begins a packet; a header flag of
+0x01 is set to indicate a continued packet. Although mandatory, it
+is not actually algorithmically necessary; one could inspect the
+preceding segment table to determine if the packet is new or
+continued. Adding the information to the packet_header flag allows a
+simpler design (with no overhead) that needs only inspect the current
+page header after frame capture. This also allows faster error
+recovery in the event that the packet originates in a corrupt
+preceding page, implying that the previous page's segment table
+cannot be trusted.</p>
+
+<p>Note that a packet can span an arbitrary number of pages; the above
+spanning process is repeated for each spanned page boundary. Also a
+'zero termination' on a packet size that is an even multiple of 255
+must appear even if the lacing value appears in the next page as a
+zero-length continuation of the current packet. The header flag
+should be set to 0x01 to indicate that the packet spanned, even though
+the span is a nil case as far as data is concerned.</p>
+
+<p>The encoding looks odd, but is properly optimized for speed and the
+expected case of the majority of packets being between 50 and 200
+bytes (note that it is designed such that packets of wildly different
+sizes can be handled within the model; placing packet size
+restrictions on the encoder would have only slightly simplified design
+in page generation and increased overall encoder complexity).</p>
+
+<p>The main point behind tracking individual packets (and packet
+segments) is to allow more flexible encoding tricks that requiring
+explicit knowledge of packet size. An example is simple bandwidth
+limiting, implemented by simply truncating packets in the nominal case
+if the packet is arranged so that the least sensitive portion of the
+data comes last.</p>
+
+<h3>Page header</h3>
+
+<p>The headering mechanism is designed to avoid copying and re-assembly
+of the packet data (ie, making the packet segmentation process a
+logical one); the header can be generated directly from incoming
+packet data. The encoder buffers packet data until it finishes a
+complete page at which point it writes the header followed by the
+buffered packet segments.</p>
+
+<h4>capture_pattern</h4>
+
+<p>A header begins with a capture pattern that simplifies identifying
+pages; once the decoder has found the capture pattern it can do a more
+intensive job of verifying that it has in fact found a page boundary
+(as opposed to an inadvertent coincidence in the byte stream).</p>
+
+<pre><tt>
+ byte value
+
+ 0 0x4f 'O'
+ 1 0x67 'g'
+ 2 0x67 'g'
+ 3 0x53 'S'
+</tt></pre>
+
+<h4>stream_structure_version</h4>
+
+<p>The capture pattern is followed by the stream structure revision:</p>
+
+<pre><tt>
+ byte value
+
+ 4 0x00
+</tt></pre>
+
+<h4>header_type_flag</h4>
+
+<p>The header type flag identifies this page's context in the bitstream:</p>
+
+<pre><tt>
+ byte value
+
+ 5 bitflags: 0x01: unset = fresh packet
+ set = continued packet
+ 0x02: unset = not first page of logical bitstream
+ set = first page of logical bitstream (bos)
+ 0x04: unset = not last page of logical bitstream
+ set = last page of logical bitstream (eos)
+</tt></pre>
+
+<h4>absolute granule position</h4>
+
+<p>(This is packed in the same way the rest of Ogg data is packed; LSb
+of LSB first. Note that the 'position' data specifies a 'sample'
+number (eg, in a CD quality sample is four octets, 16 bits for left
+and 16 bits for right; in video it would likely be the frame number.
+It is up to the specific codec in use to define the semantic meaning
+of the granule position value). The position specified is the total
+samples encoded after including all packets finished on this page
+(packets begun on this page but continuing on to the next page do not
+count). The rationale here is that the position specified in the
+frame header of the last page tells how long the data coded by the
+bitstream is. A truncated stream will still return the proper number
+of samples that can be decoded fully.</p>
+
+<p>A special value of '-1' (in two's complement) indicates that no packets
+finish on this page.</p>
+
+<pre><tt>
+ byte value
+
+ 6 0xXX LSB
+ 7 0xXX
+ 8 0xXX
+ 9 0xXX
+ 10 0xXX
+ 11 0xXX
+ 12 0xXX
+ 13 0xXX MSB
+</tt></pre>
+
+<h4>stream serial number</h4>
+
+<p>Ogg allows for separate logical bitstreams to be mixed at page
+granularity in a physical bitstream. The most common case would be
+sequential arrangement, but it is possible to interleave pages for
+two separate bitstreams to be decoded concurrently. The serial
+number is the means by which pages physical pages are associated with
+a particular logical stream. Each logical stream must have a unique
+serial number within a physical stream:</p>
+
+<pre><tt>
+ byte value
+
+ 14 0xXX LSB
+ 15 0xXX
+ 16 0xXX
+ 17 0xXX MSB
+</tt></pre>
+
+<h4>page sequence no</h4>
+
+<p>Page counter; lets us know if a page is lost (useful where packets
+span page boundaries).</p>
+
+<pre><tt>
+ byte value
+
+ 18 0xXX LSB
+ 19 0xXX
+ 20 0xXX
+ 21 0xXX MSB
+</tt></pre>
+
+<h4>page checksum</h4>
+
+<p>32 bit CRC value (direct algorithm, initial val and final XOR = 0,
+generator polynomial=0x04c11db7). The value is computed over the
+entire header (with the CRC field in the header set to zero) and then
+continued over the page. The CRC field is then filled with the
+computed value.</p>
+
+<p>(A thorough discussion of CRC algorithms can be found in <a
+href="http://www.ross.net/crc/download/crc_v3.txt">"A
+Painless Guide to CRC Error Detection Algorithms"</a> by Ross
+Williams <a href="mailto:ross at ross.net">ross at ross.net</a>.)</p>
+
+<pre><tt>
+ byte value
+
+ 22 0xXX LSB
+ 23 0xXX
+ 24 0xXX
+ 25 0xXX MSB
+</tt></pre>
+
+<h4>page_segments</h4>
+
+<p>The number of segment entries to appear in the segment table. The
+maximum number of 255 segments (255 bytes each) sets the maximum
+possible physical page size at 65307 bytes or just under 64kB (thus
+we know that a header corrupted so as destroy sizing/alignment
+information will not cause a runaway bitstream. We'll read in the
+page according to the corrupted size information that's guaranteed to
+be a reasonable size regardless, notice the checksum mismatch, drop
+sync and then look for recapture).</p>
+
+<pre><tt>
+ byte value
+
+ 26 0x00-0xff (0-255)
+</tt></pre>
+
+<h4>segment_table (containing packet lacing values)</h4>
+
+<p>The lacing values for each packet segment physically appearing in
+this page are listed in contiguous order.</p>
+
+<pre><tt>
+ byte value
+
+ 27 0x00-0xff (0-255)
+ [...]
+ n 0x00-0xff (0-255, n=page_segments+26)
+</tt></pre>
+
+<p>Total page size is calculated directly from the known header size and
+lacing values in the segment table. Packet data segments follow
+immediately after the header.</p>
+
+<p>Page headers typically impose a flat .25-.5% space overhead assuming
+nominal ~8k page sizes. The segmentation table needed for exact
+packet recovery in the streaming layer adds approximately .5-1%
+nominal assuming expected encoder behavior in the 44.1kHz, 128kbps
+stereo encodings.</p>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2005 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/helper.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/helper.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/helper.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,196 +1,239 @@
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p>
-
-<h1><font color=#000070>
-Ogg Vorbis I format specification: helper equations
-</font></h1>
-
-<em>Last update to this document: October 15, 2002</em><p>
-
-<h1>Overview</h1>
-
-The equations below are used in multiple places by the Vorbis codec
-specification. Rather than cluttering up the main specification
-documents, they are defined here and linked in the main documents
-where appropriate.<p>
-
-<a name=log><h2>ilog</h2></a>
-
-
-The "ilog(x)" function returns the position number (1 through n) of the highest set bit in the two's complement integer value
-<tt>[x]</tt>. Values of <tt>[x]</tt> less than zero are defined to return zero.
-
-<pre>
- 1) [return_value] = 0;
- 2) if ( [x] is greater than zero ){
-
- 3) increment [return_value];
- 4) logical shift [x] one bit to the right, padding the MSb with zero
- 5) repeat at step 2)
-
- }
-
- 6) done
-</pre>
-
-Examples:
-
-<ul><li> ilog(0) = 0;
- <li> ilog(1) = 1;
- <li> ilog(2) = 2;
- <li> ilog(3) = 2;
- <li> ilog(4) = 3;
- <li> ilog(7) = 3;
- <li> ilog(negative number) = 0;
-</uL>
-
-<a name=float32_unpack><h2>float32_unpack</h2></a>
-
-"float32_unpack(x)" is intended to translate the packed binary
-representation of a Vorbis codebook float value into the
-representation used by the decoder for floating point numbers. For
-purposes of this example, we will unpack a Vorbis float32 into a
-host-native floating point number.<p>
-
-<pre>
- 1) [mantissa] = [x] bitwise AND 0x1fffff (unsigned result)
- 2) [sign] = [x] bitwise AND 0x80000000 (unsigned result)
- 3) [exponent] = ( [x] bitwise AND 0x7fe00000) shifted right 21 bits (unsigned result)
- 4) if ( [sign] is nonzero ) then negate [mantissa]
- 5) return [mantissa] * ( 2 ^ ( [exponent] - 788 ) )
-</pre>
-
-<a name=lookup1_values><h2>lookup1_values</h2></a>
-
-"lookup1_values(codebook_entries,codebook_dimensions)" is used to
-compute the correct length of the value index for a codebook VQ lookup
-table of lookup type 1. The values on this list are permuted to
-construct the VQ vector lookup table of size
-<tt>[codebook_entries]</tt>.<p>
-
-The return value for this function is defined to be 'the greatest
-integer value for which <tt>[return_value] to the power of
-[codebook_dimensions] is less than or equal to
-[codebook_entries]</tt>'.
-
-<a name=low_neighbor><h2>low_neighbor</h2></a>
-
-"low_neighbor(v,x)" finds the position <i>n</i> in vector [v] of
-the greatest value scalar element for which <i>n</i> is less than
-<tt>[x]</tt> and <tt>vector [v] element <i>n</i> is less
-than vector [v] element [x]</tt>.
-
-<a name=high_neighbor><h2>high_neighbor</h2></a>
-
-"high_neighbor(v,x)" finds the position <i>n</i> in vector [v] of
-the lowest value scalar element for which <i>n</i> is less than
-<tt>[x]</tt> and <tt>vector [v] element <i>n</i> is greater
-than vector [v] element [x]</tt>.
-
-<a name=render_point><h2>render_point</h2></a>
-
-"render_point(x0,y0,x1,y1,X)" is used to find the Y value at point X
-along the line specified by x0, x1, y0 and y1. This function uses an
-integer algorithm to solve for the point directly without calculating
-intervening values along the line.<p>
-
-<pre>
- 1) [dy] = [y1] - [y0]
- 2) [adx] = [x1] - [x0]
- 3) [ady] = absolute value of [dy]
- 4) [err] = [ady] * ([X] - [x0])
- 5) [off] = [err] / [adx] using integer division
- 6) if ( [dy] is less than zero ) {
-
- 7) [Y] = [y0] - [off]
-
- } else {
-
- 8) [Y] = [y0] + [off]
-
- }
-
- 9) done
-</pre>
-
-<a name=render_line><h2>render_line</h2></a>
-
-Floor decode type one uses the integer line drawing algorithm of
-"render_line(x0, y0, x1, y1, v)" to construct an integer floor
-curve for contiguous piecewise line segments. Note that it has not
-been relevant elsewhere, but here we must define integer division as
-rounding division of both positive and negative numbers toward zero.
-
-<pre>
- 1) [dy] = [y1] - [y0]
- 2) [adx] = [x1] - [x0]
- 3) [ady] = absolute value of [dy]
- 4) [base] = [dy] / [adx] using integer division
- 5) [x] = [x0]
- 6) [y] = [y0]
- 7) [err] = 0
-
- 8) if ( [dy] is less than 0 ) {
-
- 9) [sy] = [base] - 1
-
- } else {
-
- 10) [sy] = [base] + 1
-
- }
-
- 11) [ady] = [ady] - (absolute value of [base]) * [adx]
- 12) vector [v] element [x] = [y]
-
- 13) iterate [x] over the range [x0]+1 ... [x1]-1 {
-
- 14) [err] = [err] + [ady];
- 15) if ( [err] >= [adx] ) {
-
- 15) [err] = [err] - [adx]
- 16) [y] = [y] + [sy]
-
- } else {
-
- 17) [y] = [y] + [base]
-
- }
-
- 18) vector [v] element [x] = [y]
-
- }
-</pre>
-
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-the Xiph.org Foundation</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-
-</body>
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Ogg Vorbis I format specification: helper equations</h1>
+
+<h1>Overview</h1>
+
+<p>The equations below are used in multiple places by the Vorbis codec
+specification. Rather than cluttering up the main specification
+documents, they are defined here and linked in the main documents
+where appropriate.</p>
+
+<h2><a name="log">ilog</a></h2>
+
+<p>The "ilog(x)" function returns the position number (1 through n) of the
+highest set bit in the two's complement integer value
+<tt>[x]</tt>. Values of <tt>[x]</tt> less than zero are defined to return zero.</p>
+
+<pre>
+ 1) [return_value] = 0;
+ 2) if ( [x] is greater than zero ){
+
+ 3) increment [return_value];
+ 4) logical shift [x] one bit to the right, padding the MSb with zero
+ 5) repeat at step 2)
+
+ }
+
+ 6) done
+</pre>
+
+<p>Examples:</p>
+
+<ul>
+<li>ilog(0) = 0;</li>
+<li>ilog(1) = 1;</li>
+<li>ilog(2) = 2;</li>
+<li>ilog(3) = 2;</li>
+<li>ilog(4) = 3;</li>
+<li>ilog(7) = 3;</li>
+<li>ilog(negative number) = 0;</li>
+</ul>
+
+<h2><a name="float32_unpack">float32_unpack</a></h2>
+
+<p>"float32_unpack(x)" is intended to translate the packed binary
+representation of a Vorbis codebook float value into the
+representation used by the decoder for floating point numbers. For
+purposes of this example, we will unpack a Vorbis float32 into a
+host-native floating point number.</p>
+
+<pre>
+ 1) [mantissa] = [x] bitwise AND 0x1fffff (unsigned result)
+ 2) [sign] = [x] bitwise AND 0x80000000 (unsigned result)
+ 3) [exponent] = ( [x] bitwise AND 0x7fe00000) shifted right 21 bits (unsigned result)
+ 4) if ( [sign] is nonzero ) then negate [mantissa]
+ 5) return [mantissa] * ( 2 ^ ( [exponent] - 788 ) )
+</pre>
+
+<h2><a name="lookup1_values">lookup1_values</a></h2>
+
+<p>"lookup1_values(codebook_entries,codebook_dimensions)" is used to
+compute the correct length of the value index for a codebook VQ lookup
+table of lookup type 1. The values on this list are permuted to
+construct the VQ vector lookup table of size
+<tt>[codebook_entries]</tt>.</p>
+
+<p>The return value for this function is defined to be 'the greatest
+integer value for which <tt>[return_value] to the power of
+[codebook_dimensions] is less than or equal to
+[codebook_entries]</tt>'.</p>
+
+<h2><a name="low_neighbor">low_neighbor</a></h2>
+
+<p>"low_neighbor(v,x)" finds the position <i>n</i> in vector [v] of
+the greatest value scalar element for which <i>n</i> is less than
+<tt>[x]</tt> and <tt>vector [v] element <i>n</i> is less
+than vector [v] element [x]</tt>.</p>
+
+<h2><a name="high_neighbor">high_neighbor</a></h2>
+
+<p>"high_neighbor(v,x)" finds the position <i>n</i> in vector [v] of
+the lowest value scalar element for which <i>n</i> is less than
+<tt>[x]</tt> and <tt>vector [v] element <i>n</i> is greater
+than vector [v] element [x]</tt>.</p>
+
+<h2><a name="render_point">render_point</a></h2>
+
+<p>"render_point(x0,y0,x1,y1,X)" is used to find the Y value at point X
+along the line specified by x0, x1, y0 and y1. This function uses an
+integer algorithm to solve for the point directly without calculating
+intervening values along the line.</p>
+
+<pre>
+ 1) [dy] = [y1] - [y0]
+ 2) [adx] = [x1] - [x0]
+ 3) [ady] = absolute value of [dy]
+ 4) [err] = [ady] * ([X] - [x0])
+ 5) [off] = [err] / [adx] using integer division
+ 6) if ( [dy] is less than zero ) {
+
+ 7) [Y] = [y0] - [off]
+
+ } else {
+
+ 8) [Y] = [y0] + [off]
+
+ }
+
+ 9) done
+</pre>
+
+<h2><a name="render_line">render_line</a></h2>
+
+<p>Floor decode type one uses the integer line drawing algorithm of
+"render_line(x0, y0, x1, y1, v)" to construct an integer floor
+curve for contiguous piecewise line segments. Note that it has not
+been relevant elsewhere, but here we must define integer division as
+rounding division of both positive and negative numbers toward zero.</p>
+
+<pre>
+ 1) [dy] = [y1] - [y0]
+ 2) [adx] = [x1] - [x0]
+ 3) [ady] = absolute value of [dy]
+ 4) [base] = [dy] / [adx] using integer division
+ 5) [x] = [x0]
+ 6) [y] = [y0]
+ 7) [err] = 0
+
+ 8) if ( [dy] is less than 0 ) {
+
+ 9) [sy] = [base] - 1
+
+ } else {
+
+ 10) [sy] = [base] + 1
+
+ }
+
+ 11) [ady] = [ady] - (absolute value of [base]) * [adx]
+ 12) vector [v] element [x] = [y]
+
+ 13) iterate [x] over the range [x0]+1 ... [x1]-1 {
+
+ 14) [err] = [err] + [ady];
+ 15) if ( [err] >= [adx] ) {
+
+ 15) [err] = [err] - [adx]
+ 16) [y] = [y] + [sy]
+
+ } else {
+
+ 17) [y] = [y] + [base]
+
+ }
+
+ 18) vector [v] element [x] = [y]
+
+ }
+</pre>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2005 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/index.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/index.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/index.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,76 +1,114 @@
-<title> xiph.org: Ogg Vorbis documentation </title>
-
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p>
-
-<h1><font color=#000070>
-Ogg Vorbis Documentation
-</font></h1>
-
-<em>Last documentation revision: October 15, 2002</em><p>
-
-<h2>Vorbis technical discussion documents</h2>
-<ul>
-<li><a href="vorbis-fidelity.html">Fidelity measurement terminology</a>
-<li><a href="stereo.html">Vorbis channel coupling and stereo-specific application</a>
-</ul>
-
-<h2>Ogg Vorbis I specification</h2>
-
-<ul>
-<li>Vorbis I specification
- [<a href="Vorbis_I_spec.html">html</a>]
- [<a href="Vorbis_I_spec.pdf">pdf</a>]
-<li><a href="v-comment.html">Vorbis comment header specification</a>
-<li><a href="draft-kerr-avt-vorbis-rtp-03.txt">Embedding Vorbis encoded
-audio in an RTP payload format</a>
-</ul>
-
-
-<h2>Ogg Vorbis programming documents</h2>
-<ul>
-<li>Programming with libvorbis
-<li><a href="vorbisfile/index.html">Programming with vorbisfile</a>
-<li><a href="vorbisenc/index.html">Programming with vorbisenc</a><P>
-
-
-</ul>
-
-<h2>Ogg bitstream documentation</h2>
-<ul>
-<li><a href="oggstream.html">Ogg bitstream overview</a>
-<li><a href="framing.html">Ogg logical bitstream and framing spec</a>
-</ul>
-
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-the Xiph.org Foundation</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-
-</body>
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Ogg Vorbis Documentation</h1>
+
+<h2>Vorbis technical discussion documents</h2>
+<ul>
+<li><a href="vorbis-fidelity.html">Fidelity measurement terminology</a></li>
+<li><a href="stereo.html">Vorbis channel coupling and stereo-specific application</a></li>
+</ul>
+
+<h2>Ogg Vorbis I specification</h2>
+
+<ul>
+<li>Vorbis I specification [<a href="Vorbis_I_spec.html">html</a>]
+ [<a href="Vorbis_I_spec.pdf">pdf</a>]</li>
+<li><a href="v-comment.html">Vorbis comment header specification</a></li>
+<li><a href="draft-ietf-avt-rtp-vorbis-09.txt">Embedding Vorbis encoded
+audio in an RTP payload format</a></li>
+</ul>
+
+<h2>Ogg Vorbis programming documents</h2>
+
+<ul>
+<li>Programming with libvorbis</li>
+<li><a href="vorbisfile/index.html">Programming with vorbisfile</a></li>
+<li><a href="vorbisenc/index.html">Programming with vorbisenc</a></li>
+</ul>
+
+<h2>Ogg bitstream documentation</h2>
+
+<ul>
+<li><a href="oggstream.html">Ogg bitstream overview</a></li>
+<li><a href="framing.html">Ogg logical bitstream and framing spec</a></li>
+</ul>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2006 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/oggstream.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/oggstream.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/oggstream.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,196 +1,234 @@
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><a href="http://www.xiph.org/ogg/index.html"><img src="white-ogg.png" border=0><img
-src="vorbisword2.png" border=0></a></nobr><p>
-
-
-<h1><font color=#000070>
-Ogg logical and physical bitstream overview
-</font></h1>
-
-<em>Last update to this document: July 14, 2002</em><br>
-
-<h2>Ogg bitstreams</h2>
-
-Ogg codecs use octet vectors of raw, compressed data
-(<em>packets</em>). These compressed packets do not have any
-high-level structure or boundary information; strung together, they
-appear to be streams of random bytes with no landmarks.<p>
-
-Raw packets may be used directly by transport mechanisms that provide
-their own framing and packet-separation mechanisms (such as UDP
-datagrams). For stream based storage (such as files) and transport
-(such as TCP streams or pipes), Vorbis and other future Ogg codecs use
-the Ogg bitstream format to provide framing/sync, sync recapture
-after error, landmarks during seeking, and enough information to
-properly separate data back into packets at the original packet
-boundaries without relying on decoding to find packet boundaries.<p>
-
-<h2>Logical and physical bitstreams</h2>
-
-Raw packets are grouped and encoded into contiguous pages of
-structured bitstream data called <em>logical bitstreams</em>. A
-logical bitstream consists of pages, in order, belonging to a single
-codec instance. Each page is a self contained entity (although it is
-possible that a packet may be split and encoded across one or more
-pages); that is, the page decode mechanism is designed to recognize,
-verify and handle single pages at a time from the overall bitstream.<p>
-
-Multiple logical bitstreams can be combined (with restrictions) into a
-single <em>physical bitstream</em>. A physical bitstream consists of
-multiple logical bitstreams multiplexed at the page level and may
-include a 'meta-header' at the beginning of the multiplexed logical
-stream that serves as identification magic. Whole pages are taken in
-order from multiple logical bitstreams and combined into a single
-physical stream of pages. The decoder reconstructs the original
-logical bitstreams from the physical bitstream by taking the pages in
-order from the physical bitstream and redirecting them into the
-appropriate logical decoding entity. The simplest physical bitstream
-is a single, unmultiplexed logical bitstream with no meta-header; this
-is referred to as a 'degenerate stream'. <p>
-
-<a href=framing.html>Ogg Logical Bitstream Framing</a> discusses
-the page format of an Ogg bitstream, the packet coding process
-and logical bitstreams in detail. The remainder of this document
-specifies requirements for constructing finished, physical Ogg
-bitstreams.<p>
-
-<h2>Mapping Restrictions</h2>
-
-Logical bitstreams may not be mapped/multiplexed into physical
-bitstreams without restriction. Here we discuss design restrictions
-on Ogg physical bitstreams in general, mostly to introduce
-design rationale. Each 'media' format defines its own (generally more
-restrictive) mapping. An '<a href="vorbis-ogg.html">Ogg Vorbis
-Audio Bitstream</a>', for example, has a <a
-href="vorbis-ogg.html">specific physical bitstream structure</a>.
-An 'Ogg A/V' bitstream (not currently specified) will also mandate a
-specific, restricted physical bitstream format.<p>
-
-<h3>additional end-to-end structure</h3>
-
-The <a href="framing.html">framing specification</a> defines
-'beginning of stream' and 'end of stream' page markers via a header
-flag (it is possible for a stream to consist of a single page). A
-stream always consists of an integer number of pages, an easy
-requirement given the variable size nature of pages.<p>
-
-In addition to the header flag marking the first and last pages of a
-logical bitstream, the first page of an Ogg bitstream obeys
-additional restrictions. Each individual media mapping specifies its
-own implementation details regarding these restrictions.<p>
-
-The first page of a logical Ogg bitstream consists of a single,
-small 'initial header' packet that includes sufficient information to
-identify the exact CODEC type and media requirements of the logical
-bitstream. The intent of this restriction is to simplify identifying
-the bitstream type and content; for a given media type (or across all
-Ogg media types) we can know that we only need a small, fixed
-amount of data to uniquely identify the bitstream type.<p>
-
-As an example, Ogg Vorbis places the name and revision of the Vorbis
-CODEC, the audio rate and the audio quality into this initial header,
-thus simplifying vastly the certain identification of an Ogg Vorbis
-audio bitstream.<p>
-
-<h3>sequential multiplexing (chaining)</h3>
-
-The simplest form of logical bitstream multiplexing is concatenation
-(<em>chaining</em>). Complete logical bitstreams are strung
-one-after-another in order. The bitstreams do not overlap; the final
-page of a given logical bitstream is immediately followed by the
-initial page of the next. Chaining is the only logical->physical
-mapping allowed by Ogg Vorbis.<p>
-
-Each chained logical bitstream must have a unique serial number within
-the scope of the physical bitstream.<p>
-
-<h3>concurrent multiplexing (grouping)</h3>
-
-Logical bitstreams may also be multiplexed 'in parallel'
-(<em>grouped</em>). An example of grouping would be to allow
-streaming of separate audio and video streams, using different codecs
-and different logical bitstreams, in the same physical bitstream.
-Whole pages from multiple logical bitstreams are mixed together.<p>
-
-The initial pages of each logical bitstream must appear first; the
-media mapping specifies the order of the initial pages. For example,
-Ogg A/V will eventually specify an Ogg video bitstream with
-audio. The mapping may specify that the physical bitstream must begin
-with the initial page of a logical video bitstream, followed by the
-initial page of an audio stream. Unlike initial pages, terminal pages
-for the logical bitstreams need not all occur contiguously (although a
-specific media mapping may require this; it is not mandated by the
-generic Ogg stream spec). Terminal pages may be 'nil' pages,
-that is, pages containing no content but simply a page header with
-position information and the 'last page of bitstream' flag set in the
-page header.<p>
-
-Each grouped bitstream must have a unique serial number within the
-scope of the physical bitstream.<p>
-
-<h3>sequential and concurrent multiplexing</h3>
-
-Groups of concurrently multiplexed bitstreams may be chained
-consecutively. Such a physical bitstream obeys all the rules of both
-grouped and chained multiplexed streams; the groups, when unchained ,
-must stand on their own as a valid concurrently multiplexed
-bitstream.<p>
-
-<h3>multiplexing example</h3>
-
-Below, we present an example of a grouped and chained bitstream:<p>
-
-<img src=stream.png><p>
-
-In this example, we see pages from five total logical bitstreams
-multiplexed into a physical bitstream. Note the following
-characteristics:
-
-<ol><li>Grouped bitstreams begin together; all of the initial pages
-must appear before any data pages. When concurrently multiplexed
-groups are chained, the new group does not begin until all the
-bitstreams in the previous group have terminated.<p>
-
-<li>The pages of concurrently multiplexed bitstreams need not conform
-to a regular order; the only requirement is that page <tt>n</tt> of a
-logical bitstream follow page <tt>n-1</tt> in the physical bitstream.
-There are no restrictions on intervening pages belonging to other
-logical bitstreams. (Tying page appearance to bitrate demands is one
-logical strategy, ie, the page appears at the chronological point
-where decode requires more information).
-
-</ol>
-
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-the Xiph.org Foundation</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-
-</body>
-
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Ogg logical and physical bitstream overview</h1>
+
+<h2>Ogg bitstreams</h2>
+
+<p>Ogg codecs use octet vectors of raw, compressed data
+(<em>packets</em>). These compressed packets do not have any
+high-level structure or boundary information; strung together, they
+appear to be streams of random bytes with no landmarks.</p>
+
+<p>Raw packets may be used directly by transport mechanisms that provide
+their own framing and packet-separation mechanisms (such as UDP
+datagrams). For stream based storage (such as files) and transport
+(such as TCP streams or pipes), Vorbis and other future Ogg codecs use
+the Ogg bitstream format to provide framing/sync, sync recapture
+after error, landmarks during seeking, and enough information to
+properly separate data back into packets at the original packet
+boundaries without relying on decoding to find packet boundaries.</p>
+
+<h2>Logical and physical bitstreams</h2>
+
+<p>Raw packets are grouped and encoded into contiguous pages of
+structured bitstream data called <em>logical bitstreams</em>. A
+logical bitstream consists of pages, in order, belonging to a single
+codec instance. Each page is a self contained entity (although it is
+possible that a packet may be split and encoded across one or more
+pages); that is, the page decode mechanism is designed to recognize,
+verify and handle single pages at a time from the overall bitstream.</p>
+
+<p>Multiple logical bitstreams can be combined (with restrictions) into a
+single <em>physical bitstream</em>. A physical bitstream consists of
+multiple logical bitstreams multiplexed at the page level and may
+include a 'meta-header' at the beginning of the multiplexed logical
+stream that serves as identification magic. Whole pages are taken in
+order from multiple logical bitstreams and combined into a single
+physical stream of pages. The decoder reconstructs the original
+logical bitstreams from the physical bitstream by taking the pages in
+order from the physical bitstream and redirecting them into the
+appropriate logical decoding entity. The simplest physical bitstream
+is a single, unmultiplexed logical bitstream with no meta-header; this
+is referred to as a 'degenerate stream'.</p>
+
+<p><a href="framing.html">Ogg Logical Bitstream Framing</a> discusses
+the page format of an Ogg bitstream, the packet coding process
+and logical bitstreams in detail. The remainder of this document
+specifies requirements for constructing finished, physical Ogg
+bitstreams.</p>
+
+<h2>Mapping Restrictions</h2>
+
+<p>Logical bitstreams may not be mapped/multiplexed into physical
+bitstreams without restriction. Here we discuss design restrictions
+on Ogg physical bitstreams in general, mostly to introduce
+design rationale. Each 'media' format defines its own (generally more
+restrictive) mapping. An 'Ogg Vorbis Audio Bitstream', for example, has a
+specific physical bitstream structure.
+An 'Ogg A/V' bitstream (not currently specified) will also mandate a
+specific, restricted physical bitstream format.</p>
+
+<h3>additional end-to-end structure</h3>
+
+<p>The <a href="framing.html">framing specification</a> defines
+'beginning of stream' and 'end of stream' page markers via a header
+flag (it is possible for a stream to consist of a single page). A
+stream always consists of an integer number of pages, an easy
+requirement given the variable size nature of pages.</p>
+
+<p>In addition to the header flag marking the first and last pages of a
+logical bitstream, the first page of an Ogg bitstream obeys
+additional restrictions. Each individual media mapping specifies its
+own implementation details regarding these restrictions.</p>
+
+<p>The first page of a logical Ogg bitstream consists of a single,
+small 'initial header' packet that includes sufficient information to
+identify the exact CODEC type and media requirements of the logical
+bitstream. The intent of this restriction is to simplify identifying
+the bitstream type and content; for a given media type (or across all
+Ogg media types) we can know that we only need a small, fixed
+amount of data to uniquely identify the bitstream type.</p>
+
+<p>As an example, Ogg Vorbis places the name and revision of the Vorbis
+CODEC, the audio rate and the audio quality into this initial header,
+thus simplifying vastly the certain identification of an Ogg Vorbis
+audio bitstream.</p>
+
+<h3>sequential multiplexing (chaining)</h3>
+
+<p>The simplest form of logical bitstream multiplexing is concatenation
+(<em>chaining</em>). Complete logical bitstreams are strung
+one-after-another in order. The bitstreams do not overlap; the final
+page of a given logical bitstream is immediately followed by the
+initial page of the next. Chaining is the only logical->physical
+mapping allowed by Ogg Vorbis.</p>
+
+<p>Each chained logical bitstream must have a unique serial number within
+the scope of the physical bitstream.</p>
+
+<h3>concurrent multiplexing (grouping)</h3>
+
+<p>Logical bitstreams may also be multiplexed 'in parallel'
+(<em>grouped</em>). An example of grouping would be to allow
+streaming of separate audio and video streams, using different codecs
+and different logical bitstreams, in the same physical bitstream.
+Whole pages from multiple logical bitstreams are mixed together.</p>
+
+<p>The initial pages of each logical bitstream must appear first; the
+media mapping specifies the order of the initial pages. For example,
+Ogg A/V will eventually specify an Ogg video bitstream with
+audio. The mapping may specify that the physical bitstream must begin
+with the initial page of a logical video bitstream, followed by the
+initial page of an audio stream. Unlike initial pages, terminal pages
+for the logical bitstreams need not all occur contiguously (although a
+specific media mapping may require this; it is not mandated by the
+generic Ogg stream spec). Terminal pages may be 'nil' pages,
+that is, pages containing no content but simply a page header with
+position information and the 'last page of bitstream' flag set in the
+page header.</p>
+
+<p>Each grouped bitstream must have a unique serial number within the
+scope of the physical bitstream.</p>
+
+<h3>sequential and concurrent multiplexing</h3>
+
+<p>Groups of concurrently multiplexed bitstreams may be chained
+consecutively. Such a physical bitstream obeys all the rules of both
+grouped and chained multiplexed streams; the groups, when unchained ,
+must stand on their own as a valid concurrently multiplexed
+bitstream.</p>
+
+<h3>multiplexing example</h3>
+
+<p>Below, we present an example of a grouped and chained bitstream:</p>
+
+<p><img src="stream.png" alt="stream"/></p>
+
+<p>In this example, we see pages from five total logical bitstreams
+multiplexed into a physical bitstream. Note the following
+characteristics:</p>
+
+<ol>
+<li>Grouped bitstreams begin together; all of the initial pages
+must appear before any data pages. When concurrently multiplexed
+groups are chained, the new group does not begin until all the
+bitstreams in the previous group have terminated.</li>
+
+<li>The pages of concurrently multiplexed bitstreams need not conform
+to a regular order; the only requirement is that page <tt>n</tt> of a
+logical bitstream follow page <tt>n-1</tt> in the physical bitstream.
+There are no restrictions on intervening pages belonging to other
+logical bitstreams. (Tying page appearance to bitrate demands is one
+logical strategy, ie, the page appears at the chronological point
+where decode requires more information).</li>
+</ol>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2005 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/programming.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/programming.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/programming.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,502 +1,554 @@
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p>
-
-
-<h1><font color=#000070>
-Programming with Xiph.org <tt>libvorbis</tt>
-</font></h1>
-
-<em>Last update to this document: July 22, 1999</em><br>
-
-<h2>Description</h2>
-
-Libvorbis is the Xiph.org Foundation's portable Ogg Vorbis CODEC
-implemented as a programmatic library. Libvorbis provides primitives
-to handle framing and manipulation of Ogg bitstreams (used by the
-Vorbis for streaming), a full analysis (encoding) interface as well as
-packet decoding and synthesis for playback. <p>
-
-The libvorbis library does not provide any system interface; a
-full-featured demonstration player included with the library
-distribtion provides example code for a variety of system interfaces
-as well as a working example of using libvorbis in production code.
-
-<h2>Encoding Overview</h2>
-
-
-
-<h2>Decoding Overview</h2>
-
-Decoding a bitstream with libvorbis follows roughly the following
-steps:
-
-<ol>
-<li>Frame the incoming bitstream into pages
-<li>Sort the pages by logical bitstream and buffer then into logical streams
-<li>Decompose the logical streams into raw packets
-<li>Reconstruct segments of the original data from each packet
-<li>Glue the reconstructed segments back into a decoded stream
-</ol>
-
-<h3>Framing</h3>
-
-An Ogg bitstream is logically arranged into pages, but to decode
-the pages, we have to find them first. The raw bitstream is first fed
-into an <tt>ogg_sync_state</tt> buffer using <tt>ogg_sync_buffer()</tt>
-and <tt>ogg_sync_wrote()</tt>. After each block we submit to the sync
-buffer, we should check to see if we can frame and extract a complete
-page or pages using <tt>ogg_sync_pageout()</tt>. Extra pages are
-buffered; allowing them to build up in the <tt>ogg_sync_state</tt>
-buffer will eventually exhaust memory.<p>
-
-The Ogg pages returned from <tt>ogg_sync_pageout</tt> need not be
-decoded further to be used as landmarks in seeking; seeking can be
-either a rough process of simply jumping to approximately intuited
-portions of the bitstream, or it can be a precise bisection process
-that captures pages and inspects data position. When seeking,
-however, sequential multiplexing (chaining) must be accounted for;
-beginning play in a new logical bitstream requires initializing a
-synthesis engine with the headers from that bitstream. Vorbis
-bitstreams do not make use of concurent multiplexing (grouping).<p>
-
-<h3>Sorting</h3>
-
-The pages produced by <tt>ogg_sync_pageout</tt> are then sorted by
-serial number to seperate logical bitstreams. Initialize logical
-bitstream buffers (<tt>og_stream_state</tt>) using
-<tt>ogg_stream_init()</tt>. Pages are submitted to the matching
-logical bitstream buffer using <tt>ogg_stream_pagein</tt>; the serial
-number of the page and the stream buffer must match, or the page will
-be rejected. A page submitted out of sequence will simply be noted,
-and in the course of outputting packets, the hole will be flagged
-(<tt>ogg_sync_pageout</tt> and <tt>ogg_stream_packetout</tt> will
-return a negative value at positions where they had to recapture the
-stream).
-
-<h3>Extracting packets</h3>
-
-After submitting page[s] to a logical stream, read available packets
-using <tt>ogg_stream_packetout</tt>.
-
-<h3>Decoding packets</h3>
-
-<h3>Reassembling data segments</h3>
-
-
-<h2>Ogg Bitstream Manipulation Structures</h3>
-
-Two of the Ogg bitstream data structures are intended to be
-transparent to the developer; the fields should be used directly.<p>
-
-<h3>ogg_packet</h3>
-
-<pre>
-typedef struct {
- unsigned char *packet;
- long bytes;
- long b_o_s;
- long e_o_s;
-
- size64 granulepos;
-
-} ogg_packet;
-</pre>
-
-<dl>
-<dt>packet: <dd>a pointer to the byte data of the raw packet
-<dt>bytes: <dd>the size of the packet' raw data
-<dt>b_o_s: <dd>beginning of stream; nonzero if this is the first packet of
- the logical bitstream
-<dt>e_o_s: <dd>end of stream; nonzero if this is the last packet of the
- logical bitstream
-<dt>granulepos: <dd>the absolute position of this packet in the original
- uncompressed data stream.
-</dl>
-
-<h4>encoding notes</h4> The encoder is responsible for setting all of
-the fields of the packet to appropriate values before submission to
-<tt>ogg_stream_packetin()</tt>; however, it is noted that the value in
-<tt>b_o_s</tt> is ignored; the first page produced from a given
-<tt>ogg_stream_state</tt> structure will be stamped as the initial
-page. <tt>e_o_s</tt>, however, must be set; this is the means by
-which the stream encoding primitives handle end of stream and cleanup.
-
-<h4>decoding notes</h4><tt>ogg_stream_packetout()</tt> sets the fields
-to appropriate values. Note that granulepos will be >= 0 only in the
-case that the given packet actually represents that position (ie, only
-the last packet completed on any page will have a meaningful
-<tt>granulepos</tt>). Intervening frames will see <tt>granulepos</tt> set
-to -1.
-
-<h3>ogg_page</h3>
-
-<pre>
-typedef struct {
- unsigned char *header;
- long header_len;
- unsigned char *body;
- long body_len;
-} ogg_page;
-</pre>
-
-<dl>
-<dt>header: <dd>pointer to the page header data
-<dt>header_len: <dd>length of the page header in bytes
-<dt>body: <dd>pointer to the page body
-<dt>body_len: <dd>length of the page body
-</dl>
-
-Note that although the <tt>header</tt> and <tt>body</tt> pointers do
-not necessarily point into a single contiguous page vector, the page
-body must immediately follow the header in the bitstream.<p>
-
-<h2>Ogg Bitstream Manipulation Functions</h3>
-
-<h3>
-int ogg_page_bos(ogg_page *og);
-</h3>
-
-Returns the 'beginning of stream' flag for the given Ogg page. The
-beginning of stream flag is set on the initial page of a logical
-bitstream.<P>
-
-Zero indicates the flag is cleared (this is not the initial page of a
-logical bitstream). Nonzero indicates the flag is set (this is the
-initial page of a logical bitstream).<p>
-
-<h3>
-int ogg_page_continued(ogg_page *og);
-</h3>
-
-Returns the 'packet continued' flag for the given Ogg page. The packet
-continued flag indicates whether or not the body data of this page
-begins with packet continued from a preceeding page.<p>
-Zero (unset) indicates that the body data begins with a new packet.
-Nonzero (set) indicates that the first packet data on the page is a
-continuation from the preceeding page.
-
-<h3>
-int ogg_page_eos(ogg_page *og);
-</h3>
-
-Returns the 'end of stream' flag for a give Ogg page. The end of page
-flag is set on the last (terminal) page of a logical bitstream.<p>
-
-Zero (unset) indicates that this is not the last page of a logical
-bitstream. Nonzero (set) indicates that this is the last page of a
-logical bitstream and that no addiitonal pages belonging to this
-bitstream may follow.<p>
-
-<h3>
-size64 ogg_page_granulepos(ogg_page *og);
-</h3>
-
-Returns the position of this page as an absolute position within the
-original uncompressed data. The position, as returned, is 'frames
-encoded to date up to and including the last whole packet on this
-page'. Partial packets begun on this page but continued to the
-following page are not included. If no packet ends on this page, the
-frame position value will be equal to the frame position value of the
-preceeding page. If none of the original uncompressed data is yet
-represented in the logical bitstream (for example, the first page of a
-bitstream consists only of a header packet; this packet encodes only
-metadata), the value shall be zero.<p>
-
-The units of the framenumber are determined by media mapping. A
-vorbis audio bitstream, for example, defines one frame to be the
-channel values from a single sampling period (eg, a 16 bit stereo
-bitstream consists of two samples of two bytes for a total of four
-bytes, thus a frame would be four bytes). A video stream defines one
-frame to be a single frame of video.<p>
-
-<h3>
-int ogg_page_pageno(ogg_page *og);
-</h3>
-
-Returns the sequential page number of the given Ogg page. The first
-page in a logical bitstream is numbered zero; following pages are
-numbered in increasing monotonic order.<p>
-
-<h3>
-int ogg_page_serialno(ogg_page *og);
-</h3>
-
-Returns the serial number of the given Ogg page. The serial number is
-used as a handle to distinguish various logical bitstreams in a
-physical Ogg bitstresm. Every logical bitstream within a
-physical bitstream must use a unique (within the scope of the physical
-bitstream) serial number, which is stamped on all bitstream pages.<p>
-
-<h3>
-int ogg_page_version(ogg_page *og);
-</h3>
-
-Returns the revision of the Ogg bitstream structure of the given page.
-Currently, the only permitted number is zero. Later revisions of the
-bitstream spec will increment this version should any changes be
-incompatable.</p>
-
-<h3>
-int ogg_stream_clear(ogg_stream_state *os);
-</h3>
-
-Clears and deallocates the internal storage of the given Ogg stream.
-After clearing, the stream structure is not initialized for use;
-<tt>ogg_stream_init</tt> must be called to reinitialize for use.
-Use <tt>ogg_stream_reset</tt> to reset the stream state
-to a fresh, intiialized state.<p>
-
-<tt>ogg_stream_clear</tt> does not call <tt>free()</tt> on the pointer
-<tt>os</tt>, allowing use of this call on stream structures in static
-or automatic storage. <tt>ogg_stream_destroy</tt>is a complimentary
-function that frees the pointer as well.<p>
-
-Returns zero on success and non-zero on failure. This function always
-succeeds.<p>
-
-<h3>
-int ogg_stream_destroy(ogg_stream_state *os);
-</h3>
-
-Clears and deallocates the internal storage of the given Ogg stream,
-then frees the storage associated with the pointer <tt>os</tt>.<p>
-
-<tt>ogg_stream_clear</tt> does not call <tt>free()</tt> on the pointer
-<tt>os</tt>, allowing use of that call on stream structures in static
-or automatic storage.<p>
-
-Returns zero on success and non-zero on failure. This function always
-succeeds.<p>
-
-<h3>
-int ogg_stream_init(ogg_stream_state *os,int serialno);
-</h3>
-
-Initialize the storage associated with <tt>os</tt> for use as an Ogg
-stream. This call is used to initialize a stream for both encode and
-decode. The given serial number is the serial number that will be
-stamped on pages of the produced bitstream (during encode), or used as
-a check that pages match (during decode).<p>
-
-Returns zero on success, nonzero on failure.<p>
-
-<h3>
-int ogg_stream_packetin(ogg_stream_state *os, ogg_packet *op);
-</h3>
-
-Used during encoding to add the given raw packet to the given Ogg
-bitstream. The contents of <tt>op</tt> are copied;
-<tt>ogg_stream_packetin</tt> does not retain any pointers into
-<tt>op</tt>'s storage. The encoding proccess buffers incoming packets
-until enough packets have been assembled to form an entire page;
-<tt>ogg_stream_pageout</tt> is used to read complete pages.<p>
-
-Returns zero on success, nonzero on failure.<p>
-
-<h3>
-int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
-</h3>
-
-Used during decoding to read raw packets from the given logical
-bitstream. <tt>ogg_stream_packetout</tt> will only return complete
-packets for which checksumming indicates no corruption. The size and
-contents of the packet exactly match those given in the encoding
-process. <p>
-
-Returns zero if the next packet is not ready to be read (not buffered
-or incomplete), positive if it returned a complete packet in
-<tt>op</tt> and negative if there is a gap, extra bytes or corruption
-at this position in the bitstream (essentially that the bitstream had
-to be recaptured). A negative value is not necessarily an error. It
-would be a common occurence when seeking, for example, which requires
-recapture of the bitstream at the position decoding continued.<p>
-
-Iff the return value is positive, <tt>ogg_stream_packetout</tt> placed
-a packet in <tt>op</tt>. The data in <t>op</tt> points to static
-storage that is valid until the next call to
-<tt>ogg_stream_pagein</tt>, <tt>ogg_stream_clear</tt>,
-<tt>ogg_stream_reset</tt>, or <tt>ogg_stream_destroy</tt>. The
-pointers are not invalidated by more calls to
-<tt>ogg_stream_packetout</tt>.<p>
-
-<h3>
-int ogg_stream_pagein(ogg_stream_state *os, ogg_page *og);
-</h3>
-
-Used during decoding to buffer the given complete, pre-verified page
-for decoding into raw Ogg packets. The given page must be framed,
-normally produced by <tt>ogg_sync_pageout</tt>, and from the logical
-bitstream associated with <tt>os</tt> (the serial numbers must match).
-The contents of the given page are copied; <tt>ogg_stream_pagein</tt>
-retains no pointers into <tt>og</tt> storage.<p>
-
-Returns zero on success and non-zero on failure.<p>
-
-<h3>
-int ogg_stream_pageout(ogg_stream_state *os, ogg_page *og);
-</h3>
-
-Used during encode to read complete pages from the stream buffer. The
-returned page is ready for sending out to the real world.<p>
-
-Returns zero if there is no complete page ready for reading. Returns
-nonzero when it has placed data for a complete page into
-<tt>og</tt>. Note that the storage returned in og points into internal
-storage; the pointers in <tt>og</tt> are valid until the next call to
-<tt>ogg_stream_pageout</tt>, <tt>ogg_stream_packetin</tt>,
-<tt>ogg_stream_reset</tt>, <tt>ogg_stream_clear</tt> or
-<tt>ogg_stream_destroy</tt>.
-
-<h3>
-int ogg_stream_reset(ogg_stream_state *os);
-</h3>
-
-Resets the given stream's state to that of a blank, unused stream;
-this may be used during encode or decode. <p>
-
-Note that if used during encode, it does not alter the stream's serial
-number. In addition, the next page produced during encoding will be
-marked as the 'initial' page of the logical bitstream.<p>
-
-When used during decode, this simply clears the data buffer of any
-pending pages. Beginning and end of stream cues are read from the
-bitstream and are unaffected by reset.<p>
-
-Returns zero on success and non-zero on failure. This function always
-succeeds.<p>
-
-<h3>
-char *ogg_sync_buffer(ogg_sync_state *oy, long size);
-</h3>
-
-This call is used to buffer a raw bitstream for framing and
-verification. <tt>ogg_sync_buffer</tt> handles stream capture and
-recapture, checksumming, and division into Ogg pages (as required by
-<tt>ogg_stream_pagein</tt>).<p>
-
-<tt>ogg_sync_buffer</tt> exposes a buffer area into which the decoder
-copies the next (up to) <tt>size</tt> bytes. We expose the buffer
-(rather than taking a buffer) in order to avoid an extra copy many
-uses; this way, for example, <tt>read()</tt> can transfer data
-directly into the stream buffer without first needing to place it in
-temporary storage.<p>
-
-Returns a pointer into <tt>oy</tt>'s internal bitstream sync buffer;
-the remaining space in the sync buffer is at least <tt>size</tt>
-bytes. The decoder need not write all of <tt>size</tt> bytes;
-<tt>ogg_sync_wrote</tt> is used to inform the engine how many bytes
-were actually written. Use of <tt>ogg_sync_wrote</tt> after writing
-into the exposed buffer is mandantory.<p>
-
-<h3>
-int ogg_sync_clear(ogg_sync_state *oy);
-</h3>
-
-<tt>ogg_sync_clear</tt>
-
-Clears and deallocates the internal storage of the given Ogg sync
-buffer. After clearing, the sync structure is not initialized for
-use; <tt>ogg_sync_init</tt> must be called to reinitialize for use.
-Use <tt>ogg_sync_reset</tt> to reset the sync state and buffer to a
-fresh, intiialized state.<p>
-
-<tt>ogg_sync_clear</tt> does not call <tt>free()</tt> on the pointer
-<tt>oy</tt>, allowing use of this call on sync structures in static
-or automatic storage. <tt>ogg_sync_destroy</tt>is a complimentary
-function that frees the pointer as well.<p>
-
-Returns zero on success and non-zero on failure. This function always
-succeeds.<p>
-
-<h3>
-int ogg_sync_destroy(ogg_sync_state *oy);
-</h3>
-
-Clears and deallocates the internal storage of the given Ogg sync
-buffer, then frees the storage associated with the pointer
-<tt>oy</tt>.<p>
-
-<tt>ogg_sync_clear</tt> does not call <tt>free()</tt> on the pointer
-<tt>oy</tt>, allowing use of that call on stream structures in static
-or automatic storage.<p>
-
-Returns zero on success and non-zero on failure. This function always
-succeeds.<p>
-
-<h3>
-int ogg_sync_init(ogg_sync_state *oy);
-</h3>
-
-Initializes the sync buffer <tt>oy</tt> for use.<p>
-Returns zero on success and non-zero on failure. This function always
-succeeds.<p>
-
-<h3>
-int ogg_sync_pageout(ogg_sync_state *oy, ogg_page *og);
-</h3>
-
-Reads complete, framed, verified Ogg pages from the sync buffer,
-placing the page data in <tt>og</tt>.<p>
-
-Returns zero when there's no complete pages buffered for
-retrieval. Returns negative when a loss of sync or recapture occurred
-(this is not necessarily an error; recapture would be required after
-seeking, for example). Returns positive when a page is returned in
-<tt>og</tt>. Note that the data in <tt>og</tt> points into the sync
-buffer storage; the pointers are valid until the next call to
-<tt>ogg_sync_buffer</tt>, <tt>ogg_sync_clear</tt>,
-<tt>ogg_sync_destroy</tt> or <tt>ogg_sync_reset</tt>.
-
-
-<h3>
-int ogg_sync_reset(ogg_sync_state *oy);
-</h3>
-
-<tt>ogg_sync_reset</tt> resets the sync state in <tt>oy</tt> to a
-clean, empty state. This is useful, for example, when seeking to a
-new location in a bitstream.<p>
-
-Returns zero on success, nonzero on failure.<p>
-
-<h3>
-int ogg_sync_wrote(ogg_sync_state *oy, long bytes);
-</h3>
-
-Used to inform the sync state as to how many bytes were actually
-written into the exposed sync buffer. It must be equal to or less
-than the size of the buffer requested.<p>
-
-Returns zero on success and non-zero on failure; failure occurs only
-when the number of bytes written were larger than the buffer.<p>
-
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org"></a> effort to
-protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-
-</body>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Programming with Xiph.org <tt>libvorbis</tt></h1>
+
+<h2>Description</h2>
+
+<p>Libvorbis is the Xiph.org Foundation's portable Ogg Vorbis CODEC
+implemented as a programmatic library. Libvorbis provides primitives
+to handle framing and manipulation of Ogg bitstreams (used by the
+Vorbis for streaming), a full analysis (encoding) interface as well as
+packet decoding and synthesis for playback.</p>
+
+<p>The libvorbis library does not provide any system interface; a
+full-featured demonstration player included with the library
+distribtion provides example code for a variety of system interfaces
+as well as a working example of using libvorbis in production code.</p>
+
+<h2>Encoding Overview</h2>
+
+<h2>Decoding Overview</h2>
+
+<p>Decoding a bitstream with libvorbis follows roughly the following
+steps:</p>
+
+<ol>
+<li>Frame the incoming bitstream into pages</li>
+<li>Sort the pages by logical bitstream and buffer then into logical streams</li>
+<li>Decompose the logical streams into raw packets</li>
+<li>Reconstruct segments of the original data from each packet</li>
+<li>Glue the reconstructed segments back into a decoded stream</li>
+</ol>
+
+<h3>Framing</h3>
+
+<p>An Ogg bitstream is logically arranged into pages, but to decode
+the pages, we have to find them first. The raw bitstream is first fed
+into an <tt>ogg_sync_state</tt> buffer using <tt>ogg_sync_buffer()</tt>
+and <tt>ogg_sync_wrote()</tt>. After each block we submit to the sync
+buffer, we should check to see if we can frame and extract a complete
+page or pages using <tt>ogg_sync_pageout()</tt>. Extra pages are
+buffered; allowing them to build up in the <tt>ogg_sync_state</tt>
+buffer will eventually exhaust memory.</p>
+
+<p>The Ogg pages returned from <tt>ogg_sync_pageout</tt> need not be
+decoded further to be used as landmarks in seeking; seeking can be
+either a rough process of simply jumping to approximately intuited
+portions of the bitstream, or it can be a precise bisection process
+that captures pages and inspects data position. When seeking,
+however, sequential multiplexing (chaining) must be accounted for;
+beginning play in a new logical bitstream requires initializing a
+synthesis engine with the headers from that bitstream. Vorbis
+bitstreams do not make use of concurent multiplexing (grouping).</p>
+
+<h3>Sorting</h3>
+
+<p>The pages produced by <tt>ogg_sync_pageout</tt> are then sorted by
+serial number to seperate logical bitstreams. Initialize logical
+bitstream buffers (<tt>og_stream_state</tt>) using
+<tt>ogg_stream_init()</tt>. Pages are submitted to the matching
+logical bitstream buffer using <tt>ogg_stream_pagein</tt>; the serial
+number of the page and the stream buffer must match, or the page will
+be rejected. A page submitted out of sequence will simply be noted,
+and in the course of outputting packets, the hole will be flagged
+(<tt>ogg_sync_pageout</tt> and <tt>ogg_stream_packetout</tt> will
+return a negative value at positions where they had to recapture the
+stream).</p>
+
+<h3>Extracting packets</h3>
+
+<p>After submitting page[s] to a logical stream, read available packets
+using <tt>ogg_stream_packetout</tt>.</p>
+
+<h3>Decoding packets</h3>
+
+<h3>Reassembling data segments</h3>
+
+<h2>Ogg Bitstream Manipulation Structures</h2>
+
+<p>Two of the Ogg bitstream data structures are intended to be
+transparent to the developer; the fields should be used directly.</p>
+
+<h3>ogg_packet</h3>
+
+<pre>
+typedef struct {
+ unsigned char *packet;
+ long bytes;
+ long b_o_s;
+ long e_o_s;
+
+ size64 granulepos;
+
+} ogg_packet;
+</pre>
+
+<dl>
+<dt>packet:</dt>
+<dd>a pointer to the byte data of the raw packet</dd>
+<dt>bytes:</dt>
+<dd>the size of the packet' raw data</dd>
+<dt>b_o_s:</dt>
+<dd>beginning of stream; nonzero if this is the first packet of
+ the logical bitstream</dd>
+<dt>e_o_s:</dt>
+<dd>end of stream; nonzero if this is the last packet of the
+ logical bitstream</dd>
+<dt>granulepos:</dt>
+<dd>the absolute position of this packet in the original
+ uncompressed data stream.</dd>
+</dl>
+
+<h4>encoding notes</h4>
+
+<p>The encoder is responsible for setting all of
+the fields of the packet to appropriate values before submission to
+<tt>ogg_stream_packetin()</tt>; however, it is noted that the value in
+<tt>b_o_s</tt> is ignored; the first page produced from a given
+<tt>ogg_stream_state</tt> structure will be stamped as the initial
+page. <tt>e_o_s</tt>, however, must be set; this is the means by
+which the stream encoding primitives handle end of stream and cleanup.</p>
+
+<h4>decoding notes</h4>
+
+<p><tt>ogg_stream_packetout()</tt> sets the fields
+to appropriate values. Note that granulepos will be >= 0 only in the
+case that the given packet actually represents that position (ie, only
+the last packet completed on any page will have a meaningful
+<tt>granulepos</tt>). Intervening frames will see <tt>granulepos</tt> set
+to -1.</p>
+
+<h3>ogg_page</h3>
+
+<pre>
+typedef struct {
+ unsigned char *header;
+ long header_len;
+ unsigned char *body;
+ long body_len;
+} ogg_page;
+</pre>
+
+<dl>
+<dt>header:</dt>
+<dd>pointer to the page header data</dd>
+<dt>header_len:</dt>
+<dd>length of the page header in bytes</dd>
+<dt>body:</dt>
+<dd>pointer to the page body</dd>
+<dt>body_len:</dt>
+<dd>length of the page body</dd>
+</dl>
+
+<p>Note that although the <tt>header</tt> and <tt>body</tt> pointers do
+not necessarily point into a single contiguous page vector, the page
+body must immediately follow the header in the bitstream.</p>
+
+<h2>Ogg Bitstream Manipulation Functions</h2>
+
+<h3>
+int ogg_page_bos(ogg_page *og);
+</h3>
+
+<p>Returns the 'beginning of stream' flag for the given Ogg page. The
+beginning of stream flag is set on the initial page of a logical
+bitstream.</p>
+
+<p>Zero indicates the flag is cleared (this is not the initial page of a
+logical bitstream). Nonzero indicates the flag is set (this is the
+initial page of a logical bitstream).</p>
+
+<h3>
+int ogg_page_continued(ogg_page *og);
+</h3>
+
+<p>Returns the 'packet continued' flag for the given Ogg page. The packet
+continued flag indicates whether or not the body data of this page
+begins with packet continued from a preceeding page.</p>
+
+<p>Zero (unset) indicates that the body data begins with a new packet.
+Nonzero (set) indicates that the first packet data on the page is a
+continuation from the preceeding page.</p>
+
+<h3>
+int ogg_page_eos(ogg_page *og);
+</h3>
+
+<p>Returns the 'end of stream' flag for a give Ogg page. The end of page
+flag is set on the last (terminal) page of a logical bitstream.</p>
+
+<p>Zero (unset) indicates that this is not the last page of a logical
+bitstream. Nonzero (set) indicates that this is the last page of a
+logical bitstream and that no addiitonal pages belonging to this
+bitstream may follow.</p>
+
+<h3>
+size64 ogg_page_granulepos(ogg_page *og);
+</h3>
+
+<p>Returns the position of this page as an absolute position within the
+original uncompressed data. The position, as returned, is 'frames
+encoded to date up to and including the last whole packet on this
+page'. Partial packets begun on this page but continued to the
+following page are not included. If no packet ends on this page, the
+frame position value will be equal to the frame position value of the
+preceeding page. If none of the original uncompressed data is yet
+represented in the logical bitstream (for example, the first page of a
+bitstream consists only of a header packet; this packet encodes only
+metadata), the value shall be zero.</p>
+
+<p>The units of the framenumber are determined by media mapping. A
+vorbis audio bitstream, for example, defines one frame to be the
+channel values from a single sampling period (eg, a 16 bit stereo
+bitstream consists of two samples of two bytes for a total of four
+bytes, thus a frame would be four bytes). A video stream defines one
+frame to be a single frame of video.</p>
+
+<h3>
+int ogg_page_pageno(ogg_page *og);
+</h3>
+
+<p>Returns the sequential page number of the given Ogg page. The first
+page in a logical bitstream is numbered zero; following pages are
+numbered in increasing monotonic order.</p>
+
+<h3>
+int ogg_page_serialno(ogg_page *og);
+</h3>
+
+<p>Returns the serial number of the given Ogg page. The serial number is
+used as a handle to distinguish various logical bitstreams in a
+physical Ogg bitstresm. Every logical bitstream within a
+physical bitstream must use a unique (within the scope of the physical
+bitstream) serial number, which is stamped on all bitstream pages.</p>
+
+<h3>
+int ogg_page_version(ogg_page *og);
+</h3>
+
+<p>Returns the revision of the Ogg bitstream structure of the given page.
+Currently, the only permitted number is zero. Later revisions of the
+bitstream spec will increment this version should any changes be
+incompatable.</p>
+
+<h3>
+int ogg_stream_clear(ogg_stream_state *os);
+</h3>
+
+<p>Clears and deallocates the internal storage of the given Ogg stream.
+After clearing, the stream structure is not initialized for use;
+<tt>ogg_stream_init</tt> must be called to reinitialize for use.
+Use <tt>ogg_stream_reset</tt> to reset the stream state
+to a fresh, intiialized state.</p>
+
+<p><tt>ogg_stream_clear</tt> does not call <tt>free()</tt> on the pointer
+<tt>os</tt>, allowing use of this call on stream structures in static
+or automatic storage. <tt>ogg_stream_destroy</tt>is a complimentary
+function that frees the pointer as well.</p>
+
+<p>Returns zero on success and non-zero on failure. This function always
+succeeds.</p>
+
+<h3>
+int ogg_stream_destroy(ogg_stream_state *os);
+</h3>
+
+<p>Clears and deallocates the internal storage of the given Ogg stream,
+then frees the storage associated with the pointer <tt>os</tt>.</p>
+
+<p><tt>ogg_stream_clear</tt> does not call <tt>free()</tt> on the pointer
+<tt>os</tt>, allowing use of that call on stream structures in static
+or automatic storage.</p>
+
+<p>Returns zero on success and non-zero on failure. This function always
+succeeds.</p>
+
+<h3>
+int ogg_stream_init(ogg_stream_state *os,int serialno);
+</h3>
+
+<p>Initialize the storage associated with <tt>os</tt> for use as an Ogg
+stream. This call is used to initialize a stream for both encode and
+decode. The given serial number is the serial number that will be
+stamped on pages of the produced bitstream (during encode), or used as
+a check that pages match (during decode).</p>
+
+<p>Returns zero on success, nonzero on failure.</p>
+
+<h3>
+int ogg_stream_packetin(ogg_stream_state *os, ogg_packet *op);
+</h3>
+
+<p>Used during encoding to add the given raw packet to the given Ogg
+bitstream. The contents of <tt>op</tt> are copied;
+<tt>ogg_stream_packetin</tt> does not retain any pointers into
+<tt>op</tt>'s storage. The encoding proccess buffers incoming packets
+until enough packets have been assembled to form an entire page;
+<tt>ogg_stream_pageout</tt> is used to read complete pages.</p>
+
+<p>Returns zero on success, nonzero on failure.</p>
+
+<h3>
+int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
+</h3>
+
+<p>Used during decoding to read raw packets from the given logical
+bitstream. <tt>ogg_stream_packetout</tt> will only return complete
+packets for which checksumming indicates no corruption. The size and
+contents of the packet exactly match those given in the encoding
+process. </p>
+
+<p>Returns zero if the next packet is not ready to be read (not buffered
+or incomplete), positive if it returned a complete packet in
+<tt>op</tt> and negative if there is a gap, extra bytes or corruption
+at this position in the bitstream (essentially that the bitstream had
+to be recaptured). A negative value is not necessarily an error. It
+would be a common occurence when seeking, for example, which requires
+recapture of the bitstream at the position decoding continued.</p>
+
+<p>If the return value is positive, <tt>ogg_stream_packetout</tt> placed
+a packet in <tt>op</tt>. The data in <tt>op</tt> points to static
+storage that is valid until the next call to
+<tt>ogg_stream_pagein</tt>, <tt>ogg_stream_clear</tt>,
+<tt>ogg_stream_reset</tt>, or <tt>ogg_stream_destroy</tt>. The
+pointers are not invalidated by more calls to
+<tt>ogg_stream_packetout</tt>.</p>
+
+<h3>
+int ogg_stream_pagein(ogg_stream_state *os, ogg_page *og);
+</h3>
+
+<p>Used during decoding to buffer the given complete, pre-verified page
+for decoding into raw Ogg packets. The given page must be framed,
+normally produced by <tt>ogg_sync_pageout</tt>, and from the logical
+bitstream associated with <tt>os</tt> (the serial numbers must match).
+The contents of the given page are copied; <tt>ogg_stream_pagein</tt>
+retains no pointers into <tt>og</tt> storage.</p>
+
+<p>Returns zero on success and non-zero on failure.</p>
+
+<h3>
+int ogg_stream_pageout(ogg_stream_state *os, ogg_page *og);
+</h3>
+
+<p>Used during encode to read complete pages from the stream buffer. The
+returned page is ready for sending out to the real world.</p>
+
+<p>Returns zero if there is no complete page ready for reading. Returns
+nonzero when it has placed data for a complete page into
+<tt>og</tt>. Note that the storage returned in og points into internal
+storage; the pointers in <tt>og</tt> are valid until the next call to
+<tt>ogg_stream_pageout</tt>, <tt>ogg_stream_packetin</tt>,
+<tt>ogg_stream_reset</tt>, <tt>ogg_stream_clear</tt> or
+<tt>ogg_stream_destroy</tt>.</p>
+
+<h3>
+int ogg_stream_reset(ogg_stream_state *os);
+</h3>
+
+<p>Resets the given stream's state to that of a blank, unused stream;
+this may be used during encode or decode.</p>
+
+<p>Note that if used during encode, it does not alter the stream's serial
+number. In addition, the next page produced during encoding will be
+marked as the 'initial' page of the logical bitstream.</p>
+
+<p>When used during decode, this simply clears the data buffer of any
+pending pages. Beginning and end of stream cues are read from the
+bitstream and are unaffected by reset.</p>
+
+<p>Returns zero on success and non-zero on failure. This function always
+succeeds.</p>
+
+<h3>
+char *ogg_sync_buffer(ogg_sync_state *oy, long size);
+</h3>
+
+<p>This call is used to buffer a raw bitstream for framing and
+verification. <tt>ogg_sync_buffer</tt> handles stream capture and
+recapture, checksumming, and division into Ogg pages (as required by
+<tt>ogg_stream_pagein</tt>).</p>
+
+<p><tt>ogg_sync_buffer</tt> exposes a buffer area into which the decoder
+copies the next (up to) <tt>size</tt> bytes. We expose the buffer
+(rather than taking a buffer) in order to avoid an extra copy many
+uses; this way, for example, <tt>read()</tt> can transfer data
+directly into the stream buffer without first needing to place it in
+temporary storage.</p>
+
+<p>Returns a pointer into <tt>oy</tt>'s internal bitstream sync buffer;
+the remaining space in the sync buffer is at least <tt>size</tt>
+bytes. The decoder need not write all of <tt>size</tt> bytes;
+<tt>ogg_sync_wrote</tt> is used to inform the engine how many bytes
+were actually written. Use of <tt>ogg_sync_wrote</tt> after writing
+into the exposed buffer is mandantory.</p>
+
+<h3>
+int ogg_sync_clear(ogg_sync_state *oy);
+</h3>
+
+<p><tt>ogg_sync_clear</tt>
+clears and deallocates the internal storage of the given Ogg sync
+buffer. After clearing, the sync structure is not initialized for
+use; <tt>ogg_sync_init</tt> must be called to reinitialize for use.
+Use <tt>ogg_sync_reset</tt> to reset the sync state and buffer to a
+fresh, intiialized state.</p>
+
+<p><tt>ogg_sync_clear</tt> does not call <tt>free()</tt> on the pointer
+<tt>oy</tt>, allowing use of this call on sync structures in static
+or automatic storage. <tt>ogg_sync_destroy</tt>is a complimentary
+function that frees the pointer as well.</p>
+
+<p>Returns zero on success and non-zero on failure. This function always
+succeeds.</p>
+
+<h3>
+int ogg_sync_destroy(ogg_sync_state *oy);
+</h3>
+
+<p>Clears and deallocates the internal storage of the given Ogg sync
+buffer, then frees the storage associated with the pointer
+<tt>oy</tt>.</p>
+
+<p><tt>ogg_sync_clear</tt> does not call <tt>free()</tt> on the pointer
+<tt>oy</tt>, allowing use of that call on stream structures in static
+or automatic storage.</p>
+
+<p>Returns zero on success and non-zero on failure. This function always
+succeeds.</p>
+
+<h3>
+int ogg_sync_init(ogg_sync_state *oy);
+</h3>
+
+<p>Initializes the sync buffer <tt>oy</tt> for use.</p>
+
+<p>Returns zero on success and non-zero on failure. This function always
+succeeds.</p>
+
+<h3>
+int ogg_sync_pageout(ogg_sync_state *oy, ogg_page *og);
+</h3>
+
+<p>Reads complete, framed, verified Ogg pages from the sync buffer,
+placing the page data in <tt>og</tt>.</p>
+
+<p>Returns zero when there's no complete pages buffered for
+retrieval. Returns negative when a loss of sync or recapture occurred
+(this is not necessarily an error; recapture would be required after
+seeking, for example). Returns positive when a page is returned in
+<tt>og</tt>. Note that the data in <tt>og</tt> points into the sync
+buffer storage; the pointers are valid until the next call to
+<tt>ogg_sync_buffer</tt>, <tt>ogg_sync_clear</tt>,
+<tt>ogg_sync_destroy</tt> or <tt>ogg_sync_reset</tt>.</p>
+
+<h3>
+int ogg_sync_reset(ogg_sync_state *oy);
+</h3>
+
+<p><tt>ogg_sync_reset</tt> resets the sync state in <tt>oy</tt> to a
+clean, empty state. This is useful, for example, when seeking to a
+new location in a bitstream.</p>
+
+<p>Returns zero on success, nonzero on failure.</p>
+
+<h3>
+int ogg_sync_wrote(ogg_sync_state *oy, long bytes);
+</h3>
+
+<p>Used to inform the sync state as to how many bytes were actually
+written into the exposed sync buffer. It must be equal to or less
+than the size of the buffer requested.</p>
+
+<p>Returns zero on success and non-zero on failure; failure occurs only
+when the number of bytes written were larger than the buffer.</p>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2005 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/stereo.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/stereo.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/stereo.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,371 +1,418 @@
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p>
-
-
-<h1><font color=#000070>
-Ogg Vorbis stereo-specific channel coupling discussion
-</font></h1>
-
-<em>Last update to this document: July 16, 2002</em><br>
-
-<h2>Abstract</h2> The Vorbis audio CODEC provides a channel coupling
-mechanisms designed to reduce effective bitrate by both eliminating
-interchannel redundancy and eliminating stereo image information
-labeled inaudible or undesirable according to spatial psychoacoustic
-models. This document describes both the mechanical coupling
-mechanisms available within the Vorbis specification, as well as the
-specific stereo coupling models used by the reference
-<tt>libvorbis</tt> codec provided by xiph.org.
-
-<h2>Mechanisms</h2>
-
-In encoder release beta 4 and earlier, Vorbis supported multiple
-channel encoding, but the channels were encoded entirely separately
-with no cross-analysis or redundancy elimination between channels.
-This multichannel strategy is very similar to the mp3's <em>dual
-stereo</em> mode and Vorbis uses the same name for its analogous
-uncoupled multichannel modes.<p>
-
-However, the Vorbis spec provides for, and Vorbis release 1.0 rc1 and
-later implement a coupled channel strategy. Vorbis has two specific
-mechanisms that may be used alone or in conjunction to implement
-channel coupling. The first is <em>channel interleaving</em> via
-residue backend type 2, and the second is <em>square polar
-mapping</em>. These two general mechanisms are particularly well
-suited to coupling due to the structure of Vorbis encoding, as we'll
-explore below, and using both we can implement both totally
-<em>lossless stereo image coupling</em> [bit-for-bit decode-identical
-to uncoupled modes], as well as various lossy models that seek to
-eliminate inaudible or unimportant aspects of the stereo image in
-order to enhance bitrate. The exact coupling implementation is
-generalized to allow the encoder a great deal of flexibility in
-implementation of a stereo or surround model without requiring any
-significant complexity increase over the combinatorially simpler
-mid/side joint stereo of mp3 and other current audio codecs.<p>
-
-A particular Vorbis bitstream may apply channel coupling directly to
-more than a pair of channels; polar mapping is hierarchical such that
-polar coupling may be extrapolated to an arbitrary number of channels
-and is not restricted to only stereo, quadraphonics, ambisonics or 5.1
-surround. However, the scope of this document restricts itself to the
-stereo coupling case.<p>
-
-<h3>Square Polar Mapping</h3>
-
-<h4>maximal correlation</h4>
-
-Recall that the basic structure of a a Vorbis I stream first generates
-from input audio a spectral 'floor' function that serves as an
-MDCT-domain whitening filter. This floor is meant to represent the
-rough envelope of the frequency spectrum, using whatever metric the
-encoder cares to define. This floor is subtracted from the log
-frequency spectrum, effectively normalizing the spectrum by frequency.
-Each input channel is associated with a unique floor function.<p>
-
-The basic idea behind any stereo coupling is that the left and right
-channels usually correlate. This correlation is even stronger if one
-first accounts for energy differences in any given frequency band
-across left and right; think for example of individual instruments
-mixed into different portions of the stereo image, or a stereo
-recording with a dominant feature not perfectly in the center. The
-floor functions, each specific to a channel, provide the perfect means
-of normalizing left and right energies across the spectrum to maximize
-correlation before coupling. This feature of the Vorbis format is not
-a convenient accident.<p>
-
-Because we strive to maximally correlate the left and right channels
-and generally succeed in doing so, left and right residue is typically
-nearly identical. We could use channel interleaving (discussed below)
-alone to efficiently remove the redundancy between the left and right
-channels as a side effect of entropy encoding, but a polar
-representation gives benefits when left/right correlation is
-strong. <p>
-
-<h4>point and diffuse imaging</h4>
-
-The first advantage of a polar representation is that it effectively
-separates the spatial audio information into a 'point image'
-(magnitude) at a given frequency and located somewhere in the sound
-field, and a 'diffuse image' (angle) that fills a large amount of
-space simultaneously. Even if we preserve only the magnitude (point)
-data, a detailed and carefully chosen floor function in each channel
-provides us with a free, fine-grained, frequency relative intensity
-stereo*. Angle information represents diffuse sound fields, such as
-reverberation that fills the entire space simultaneously.<p>
-
-*<em>Because the Vorbis model supports a number of different possible
-stereo models and these models may be mixed, we do not use the term
-'intensity stereo' talking about Vorbis; instead we use the terms
-'point stereo', 'phase stereo' and subcategories of each.</em><p>
-
-The majority of a stereo image is representable by polar magnitude
-alone, as strong sounds tend to be produced at near-point sources;
-even non-diffuse, fast, sharp echoes track very accurately using
-magnitude representation almost alone (for those experimenting with
-Vorbis tuning, this strategy works much better with the precise,
-piecewise control of floor 1; the continuous approximation of floor 0
-results in unstable imaging). Reverberation and diffuse sounds tend
-to contain less energy and be psychoacoustically dominated by the
-point sources embedded in them. Thus, we again tend to concentrate
-more represented energy into a predictably smaller number of numbers.
-Separating representation of point and diffuse imaging also allows us
-to model and manipulate point and diffuse qualities separately.<p>
-
-<h4>controlling bit leakage and symbol crosstalk</h4> Because polar
-representation concentrates represented energy into fewer large
-values, we reduce bit 'leakage' during cascading (multistage VQ
-encoding) as a secondary benefit. A single large, monolithic VQ
-codebook is more efficient than a cascaded book due to entropy
-'crosstalk' among symbols between different stages of a multistage cascade.
-Polar representation is a way of further concentrating entropy into
-predictable locations so that codebook design can take steps to
-improve multistage codebook efficiency. It also allows us to cascade
-various elements of the stereo image independently.<p>
-
-<h4>eliminating trigonometry and rounding</h4>
-
-Rounding and computational complexity are potential problems with a
-polar representation. As our encoding process involves quantization,
-mixing a polar representation and quantization makes it potentially
-impossible, depending on implementation, to construct a coupled stereo
-mechanism that results in bit-identical decompressed output compared
-to an uncoupled encoding should the encoder desire it.<p>
-
-Vorbis uses a mapping that preserves the most useful qualities of
-polar representation, relies only on addition/subtraction (during
-decode; high quality encoding still requires some trig), and makes it
-trivial before or after quantization to represent an angle/magnitude
-through a one-to-one mapping from possible left/right value
-permutations. We do this by basing our polar representation on the
-unit square rather than the unit-circle.<p>
-
-Given a magnitude and angle, we recover left and right using the
-following function (note that A/B may be left/right or right/left
-depending on the coupling definition used by the encoder):<p>
-
-<pre>
- if(magnitude>0)
- if(angle>0){
- A=magnitude;
- B=magnitude-angle;
- }else{
- B=magnitude;
- A=magnitude+angle;
- }
- else
- if(angle>0){
- A=magnitude;
- B=magnitude+angle;
- }else{
- B=magnitude;
- A=magnitude-angle;
- }
- }
-</pre>
-
-The function is antisymmetric for positive and negative magnitudes in
-order to eliminate a redundant value when quantizing. For example, if
-we're quantizing to integer values, we can visualize a magnitude of 5
-and an angle of -2 as follows:<p>
-
-<img src="squarepolar.png">
-
-<p>
-This representation loses or replicates no values; if the range of A
-and B are integral -5 through 5, the number of possible Cartesian
-permutations is 121. Represented in square polar notation, the
-possible values are:
-
-<pre>
- 0, 0
-
--1,-2 -1,-1 -1, 0 -1, 1
-
- 1,-2 1,-1 1, 0 1, 1
-
--2,-4 -2,-3 -2,-2 -2,-1 -2, 0 -2, 1 -2, 2 -2, 3
-
- 2,-4 2,-3 ... following the pattern ...
-
- ... 5, 1 5, 2 5, 3 5, 4 5, 5 5, 6 5, 7 5, 8 5, 9
-
-</pre>
-
-...for a grand total of 121 possible values, the same number as in
-Cartesian representation (note that, for example, <tt>5,-10</tt> is
-the same as <tt>-5,10</tt>, so there's no reason to represent
-both. 2,10 cannot happen, and there's no reason to account for it.)
-It's also obvious that this mapping is exactly reversible.<p>
-
-<h3>Channel interleaving</h3>
-
-We can remap and A/B vector using polar mapping into a magnitude/angle
-vector, and it's clear that, in general, this concentrates energy in
-the magnitude vector and reduces the amount of information to encode
-in the angle vector. Encoding these vectors independently with
-residue backend #0 or residue backend #1 will result in bitrate
-savings. However, there are still implicit correlations between the
-magnitude and angle vectors. The most obvious is that the amplitude
-of the angle is bounded by its corresponding magnitude value.<p>
-
-Entropy coding the results, then, further benefits from the entropy
-model being able to compress magnitude and angle simultaneously. For
-this reason, Vorbis implements residue backend #2 which pre-interleaves
-a number of input vectors (in the stereo case, two, A and B) into a
-single output vector (with the elements in the order of
-A_0, B_0, A_1, B_1, A_2 ... A_n-1, B_n-1) before entropy encoding. Thus
-each vector to be coded by the vector quantization backend consists of
-matching magnitude and angle values.<p>
-
-The astute reader, at this point, will notice that in the theoretical
-case in which we can use monolithic codebooks of arbitrarily large
-size, we can directly interleave and encode left and right without
-polar mapping; in fact, the polar mapping does not appear to lend any
-benefit whatsoever to the efficiency of the entropy coding. In fact,
-it is perfectly possible and reasonable to build a Vorbis encoder that
-dispenses with polar mapping entirely and merely interleaves the
-channel. Libvorbis based encoders may configure such an encoding and
-it will work as intended.<p>
-
-However, when we leave the ideal/theoretical domain, we notice that
-polar mapping does give additional practical benefits, as discussed in
-the above section on polar mapping and summarized again here:<p>
-<ul>
-<li>Polar mapping aids in controlling entropy 'leakage' between stages
-of a cascaded codebook. <li>Polar mapping separates the stereo image
-into point and diffuse components which may be analyzed and handled
-differently.
-</ul>
-
-<h2>Stereo Models</h2>
-
-<h3>Dual Stereo</h3>
-
-Dual stereo refers to stereo encoding where the channels are entirely
-separate; they are analyzed and encoded as entirely distinct entities.
-This terminology is familiar from mp3.<p>
-
-<h3>Lossless Stereo</h3>
-
-Using polar mapping and/or channel interleaving, it's possible to
-couple Vorbis channels losslessly, that is, construct a stereo
-coupling encoding that both saves space but also decodes
-bit-identically to dual stereo. OggEnc 1.0 and later uses this
-mode in all high-bitrate encoding.<p>
-
-Overall, this stereo mode is overkill; however, it offers a safe
-alternative to users concerned about the slightest possible
-degradation to the stereo image or archival quality audio.<p>
-
-<h3>Phase Stereo</h3>
-
-Phase stereo is the least aggressive means of gracefully dropping
-resolution from the stereo image; it affects only diffuse imaging.<p>
-
-It's often quoted that the human ear is deaf to signal phase above
-about 4kHz; this is nearly true and a passable rule of thumb, but it
-can be demonstrated that even an average user can tell the difference
-between high frequency in-phase and out-of-phase noise. Obviously
-then, the statement is not entirely true. However, it's also the case
-that one must resort to nearly such an extreme demonstration before
-finding the counterexample.<p>
-
-'Phase stereo' is simply a more aggressive quantization of the polar
-angle vector; above 4kHz it's generally quite safe to quantize noise
-and noisy elements to only a handful of allowed phases, or to thin the
-phase with respect to the magnitude. The phases of high amplitude
-pure tones may or may not be preserved more carefully (they are
-relatively rare and L/R tend to be in phase, so there is generally
-little reason not to spend a few more bits on them) <p>
-
-<h4>example: eight phase stereo</h4>
-
-Vorbis may implement phase stereo coupling by preserving the entirety
-of the magnitude vector (essential to fine amplitude and energy
-resolution overall) and quantizing the angle vector to one of only
-four possible values. Given that the magnitude vector may be positive
-or negative, this results in left and right phase having eight
-possible permutation, thus 'eight phase stereo':<p>
-
-<img src="eightphase.png"><p>
-
-Left and right may be in phase (positive or negative), the most common
-case by far, or out of phase by 90 or 180 degrees.<p>
-
-<h4>example: four phase stereo</h4>
-
-Similarly, four phase stereo takes the quantization one step further;
-it allows only in-phase and 180 degree out-out-phase signals:<p>
-
-<img src="fourphase.png"><p>
-
-<h3>example: point stereo</h3>
-
-Point stereo eliminates the possibility of out-of-phase signal
-entirely. Any diffuse quality to a sound source tends to collapse
-inward to a point somewhere within the stereo image. A practical
-example would be balanced reverberations within a large, live space;
-normally the sound is diffuse and soft, giving a sonic impression of
-volume. In point-stereo, the reverberations would still exist, but
-sound fairly firmly centered within the image (assuming the
-reverberation was centered overall; if the reverberation is stronger
-to the left, then the point of localization in point stereo would be
-to the left). This effect is most noticeable at low and mid
-frequencies and using headphones (which grant perfect stereo
-separation). Point stereo is is a graceful but generally easy to
-detect degradation to the sound quality and is thus used in frequency
-ranges where it is least noticeable.<p>
-
-<h3>Mixed Stereo</h3>
-
-Mixed stereo is the simultaneous use of more than one of the above
-stereo encoding models, generally using more aggressive modes in
-higher frequencies, lower amplitudes or 'nearly' in-phase sound.<p>
-
-It is also the case that near-DC frequencies should be encoded using
-lossless coupling to avoid frame blocking artifacts.<p>
-
-<h3>Vorbis Stereo Modes</h3>
-
-Vorbis, as of 1.0, uses lossless stereo and a number of mixed modes
-constructed out of lossless and point stereo. Phase stereo was used
-in the rc2 encoder, but is not currently used for simplicity's sake. It
-will likely be re-added to the stereo model in the future.
-
-<p>
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-the Xiph.org Foundation</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-</body>
-
-
-
-
-
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a, h4, h4 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Ogg Vorbis stereo-specific channel coupling discussion</h1>
+
+<h2>Abstract</h2>
+
+<p>The Vorbis audio CODEC provides a channel coupling
+mechanisms designed to reduce effective bitrate by both eliminating
+interchannel redundancy and eliminating stereo image information
+labeled inaudible or undesirable according to spatial psychoacoustic
+models. This document describes both the mechanical coupling
+mechanisms available within the Vorbis specification, as well as the
+specific stereo coupling models used by the reference
+<tt>libvorbis</tt> codec provided by xiph.org.</p>
+
+<h2>Mechanisms</h2>
+
+<p>In encoder release beta 4 and earlier, Vorbis supported multiple
+channel encoding, but the channels were encoded entirely separately
+with no cross-analysis or redundancy elimination between channels.
+This multichannel strategy is very similar to the mp3's <em>dual
+stereo</em> mode and Vorbis uses the same name for its analogous
+uncoupled multichannel modes.</p>
+
+<p>However, the Vorbis spec provides for, and Vorbis release 1.0 rc1 and
+later implement a coupled channel strategy. Vorbis has two specific
+mechanisms that may be used alone or in conjunction to implement
+channel coupling. The first is <em>channel interleaving</em> via
+residue backend type 2, and the second is <em>square polar
+mapping</em>. These two general mechanisms are particularly well
+suited to coupling due to the structure of Vorbis encoding, as we'll
+explore below, and using both we can implement both totally
+<em>lossless stereo image coupling</em> [bit-for-bit decode-identical
+to uncoupled modes], as well as various lossy models that seek to
+eliminate inaudible or unimportant aspects of the stereo image in
+order to enhance bitrate. The exact coupling implementation is
+generalized to allow the encoder a great deal of flexibility in
+implementation of a stereo or surround model without requiring any
+significant complexity increase over the combinatorially simpler
+mid/side joint stereo of mp3 and other current audio codecs.</p>
+
+<p>A particular Vorbis bitstream may apply channel coupling directly to
+more than a pair of channels; polar mapping is hierarchical such that
+polar coupling may be extrapolated to an arbitrary number of channels
+and is not restricted to only stereo, quadraphonics, ambisonics or 5.1
+surround. However, the scope of this document restricts itself to the
+stereo coupling case.</p>
+
+<h3>Square Polar Mapping</h3>
+
+<h4>maximal correlation</h4>
+
+<p>Recall that the basic structure of a a Vorbis I stream first generates
+from input audio a spectral 'floor' function that serves as an
+MDCT-domain whitening filter. This floor is meant to represent the
+rough envelope of the frequency spectrum, using whatever metric the
+encoder cares to define. This floor is subtracted from the log
+frequency spectrum, effectively normalizing the spectrum by frequency.
+Each input channel is associated with a unique floor function.</p>
+
+<p>The basic idea behind any stereo coupling is that the left and right
+channels usually correlate. This correlation is even stronger if one
+first accounts for energy differences in any given frequency band
+across left and right; think for example of individual instruments
+mixed into different portions of the stereo image, or a stereo
+recording with a dominant feature not perfectly in the center. The
+floor functions, each specific to a channel, provide the perfect means
+of normalizing left and right energies across the spectrum to maximize
+correlation before coupling. This feature of the Vorbis format is not
+a convenient accident.</p>
+
+<p>Because we strive to maximally correlate the left and right channels
+and generally succeed in doing so, left and right residue is typically
+nearly identical. We could use channel interleaving (discussed below)
+alone to efficiently remove the redundancy between the left and right
+channels as a side effect of entropy encoding, but a polar
+representation gives benefits when left/right correlation is
+strong.</p>
+
+<h4>point and diffuse imaging</h4>
+
+<p>The first advantage of a polar representation is that it effectively
+separates the spatial audio information into a 'point image'
+(magnitude) at a given frequency and located somewhere in the sound
+field, and a 'diffuse image' (angle) that fills a large amount of
+space simultaneously. Even if we preserve only the magnitude (point)
+data, a detailed and carefully chosen floor function in each channel
+provides us with a free, fine-grained, frequency relative intensity
+stereo*. Angle information represents diffuse sound fields, such as
+reverberation that fills the entire space simultaneously.</p>
+
+<p>*<em>Because the Vorbis model supports a number of different possible
+stereo models and these models may be mixed, we do not use the term
+'intensity stereo' talking about Vorbis; instead we use the terms
+'point stereo', 'phase stereo' and subcategories of each.</em></p>
+
+<p>The majority of a stereo image is representable by polar magnitude
+alone, as strong sounds tend to be produced at near-point sources;
+even non-diffuse, fast, sharp echoes track very accurately using
+magnitude representation almost alone (for those experimenting with
+Vorbis tuning, this strategy works much better with the precise,
+piecewise control of floor 1; the continuous approximation of floor 0
+results in unstable imaging). Reverberation and diffuse sounds tend
+to contain less energy and be psychoacoustically dominated by the
+point sources embedded in them. Thus, we again tend to concentrate
+more represented energy into a predictably smaller number of numbers.
+Separating representation of point and diffuse imaging also allows us
+to model and manipulate point and diffuse qualities separately.</p>
+
+<h4>controlling bit leakage and symbol crosstalk</h4>
+
+<p>Because polar
+representation concentrates represented energy into fewer large
+values, we reduce bit 'leakage' during cascading (multistage VQ
+encoding) as a secondary benefit. A single large, monolithic VQ
+codebook is more efficient than a cascaded book due to entropy
+'crosstalk' among symbols between different stages of a multistage cascade.
+Polar representation is a way of further concentrating entropy into
+predictable locations so that codebook design can take steps to
+improve multistage codebook efficiency. It also allows us to cascade
+various elements of the stereo image independently.</p>
+
+<h4>eliminating trigonometry and rounding</h4>
+
+<p>Rounding and computational complexity are potential problems with a
+polar representation. As our encoding process involves quantization,
+mixing a polar representation and quantization makes it potentially
+impossible, depending on implementation, to construct a coupled stereo
+mechanism that results in bit-identical decompressed output compared
+to an uncoupled encoding should the encoder desire it.</p>
+
+<p>Vorbis uses a mapping that preserves the most useful qualities of
+polar representation, relies only on addition/subtraction (during
+decode; high quality encoding still requires some trig), and makes it
+trivial before or after quantization to represent an angle/magnitude
+through a one-to-one mapping from possible left/right value
+permutations. We do this by basing our polar representation on the
+unit square rather than the unit-circle.</p>
+
+<p>Given a magnitude and angle, we recover left and right using the
+following function (note that A/B may be left/right or right/left
+depending on the coupling definition used by the encoder):</p>
+
+<pre>
+ if(magnitude>0)
+ if(angle>0){
+ A=magnitude;
+ B=magnitude-angle;
+ }else{
+ B=magnitude;
+ A=magnitude+angle;
+ }
+ else
+ if(angle>0){
+ A=magnitude;
+ B=magnitude+angle;
+ }else{
+ B=magnitude;
+ A=magnitude-angle;
+ }
+ }
+</pre>
+
+<p>The function is antisymmetric for positive and negative magnitudes in
+order to eliminate a redundant value when quantizing. For example, if
+we're quantizing to integer values, we can visualize a magnitude of 5
+and an angle of -2 as follows:</p>
+
+<p><img src="squarepolar.png" alt="square polar"/></p>
+
+<p>This representation loses or replicates no values; if the range of A
+and B are integral -5 through 5, the number of possible Cartesian
+permutations is 121. Represented in square polar notation, the
+possible values are:</p>
+
+<pre>
+ 0, 0
+
+-1,-2 -1,-1 -1, 0 -1, 1
+
+ 1,-2 1,-1 1, 0 1, 1
+
+-2,-4 -2,-3 -2,-2 -2,-1 -2, 0 -2, 1 -2, 2 -2, 3
+
+ 2,-4 2,-3 ... following the pattern ...
+
+ ... 5, 1 5, 2 5, 3 5, 4 5, 5 5, 6 5, 7 5, 8 5, 9
+
+</pre>
+
+<p>...for a grand total of 121 possible values, the same number as in
+Cartesian representation (note that, for example, <tt>5,-10</tt> is
+the same as <tt>-5,10</tt>, so there's no reason to represent
+both. 2,10 cannot happen, and there's no reason to account for it.)
+It's also obvious that this mapping is exactly reversible.</p>
+
+<h3>Channel interleaving</h3>
+
+<p>We can remap and A/B vector using polar mapping into a magnitude/angle
+vector, and it's clear that, in general, this concentrates energy in
+the magnitude vector and reduces the amount of information to encode
+in the angle vector. Encoding these vectors independently with
+residue backend #0 or residue backend #1 will result in bitrate
+savings. However, there are still implicit correlations between the
+magnitude and angle vectors. The most obvious is that the amplitude
+of the angle is bounded by its corresponding magnitude value.</p>
+
+<p>Entropy coding the results, then, further benefits from the entropy
+model being able to compress magnitude and angle simultaneously. For
+this reason, Vorbis implements residue backend #2 which pre-interleaves
+a number of input vectors (in the stereo case, two, A and B) into a
+single output vector (with the elements in the order of
+A_0, B_0, A_1, B_1, A_2 ... A_n-1, B_n-1) before entropy encoding. Thus
+each vector to be coded by the vector quantization backend consists of
+matching magnitude and angle values.</p>
+
+<p>The astute reader, at this point, will notice that in the theoretical
+case in which we can use monolithic codebooks of arbitrarily large
+size, we can directly interleave and encode left and right without
+polar mapping; in fact, the polar mapping does not appear to lend any
+benefit whatsoever to the efficiency of the entropy coding. In fact,
+it is perfectly possible and reasonable to build a Vorbis encoder that
+dispenses with polar mapping entirely and merely interleaves the
+channel. Libvorbis based encoders may configure such an encoding and
+it will work as intended.</p>
+
+<p>However, when we leave the ideal/theoretical domain, we notice that
+polar mapping does give additional practical benefits, as discussed in
+the above section on polar mapping and summarized again here:</p>
+
+<ul>
+<li>Polar mapping aids in controlling entropy 'leakage' between stages
+of a cascaded codebook.</li>
+<li>Polar mapping separates the stereo image
+into point and diffuse components which may be analyzed and handled
+differently.</li>
+</ul>
+
+<h2>Stereo Models</h2>
+
+<h3>Dual Stereo</h3>
+
+<p>Dual stereo refers to stereo encoding where the channels are entirely
+separate; they are analyzed and encoded as entirely distinct entities.
+This terminology is familiar from mp3.</p>
+
+<h3>Lossless Stereo</h3>
+
+<p>Using polar mapping and/or channel interleaving, it's possible to
+couple Vorbis channels losslessly, that is, construct a stereo
+coupling encoding that both saves space but also decodes
+bit-identically to dual stereo. OggEnc 1.0 and later uses this
+mode in all high-bitrate encoding.</p>
+
+<p>Overall, this stereo mode is overkill; however, it offers a safe
+alternative to users concerned about the slightest possible
+degradation to the stereo image or archival quality audio.</p>
+
+<h3>Phase Stereo</h3>
+
+<p>Phase stereo is the least aggressive means of gracefully dropping
+resolution from the stereo image; it affects only diffuse imaging.</p>
+
+<p>It's often quoted that the human ear is deaf to signal phase above
+about 4kHz; this is nearly true and a passable rule of thumb, but it
+can be demonstrated that even an average user can tell the difference
+between high frequency in-phase and out-of-phase noise. Obviously
+then, the statement is not entirely true. However, it's also the case
+that one must resort to nearly such an extreme demonstration before
+finding the counterexample.</p>
+
+<p>'Phase stereo' is simply a more aggressive quantization of the polar
+angle vector; above 4kHz it's generally quite safe to quantize noise
+and noisy elements to only a handful of allowed phases, or to thin the
+phase with respect to the magnitude. The phases of high amplitude
+pure tones may or may not be preserved more carefully (they are
+relatively rare and L/R tend to be in phase, so there is generally
+little reason not to spend a few more bits on them)</p>
+
+<h4>example: eight phase stereo</h4>
+
+<p>Vorbis may implement phase stereo coupling by preserving the entirety
+of the magnitude vector (essential to fine amplitude and energy
+resolution overall) and quantizing the angle vector to one of only
+four possible values. Given that the magnitude vector may be positive
+or negative, this results in left and right phase having eight
+possible permutation, thus 'eight phase stereo':</p>
+
+<p><img src="eightphase.png" alt="eight phase"/></p>
+
+<p>Left and right may be in phase (positive or negative), the most common
+case by far, or out of phase by 90 or 180 degrees.</p>
+
+<h4>example: four phase stereo</h4>
+
+<p>Similarly, four phase stereo takes the quantization one step further;
+it allows only in-phase and 180 degree out-out-phase signals:</p>
+
+<p><img src="fourphase.png" alt="four phase"/></p>
+
+<h3>example: point stereo</h3>
+
+<p>Point stereo eliminates the possibility of out-of-phase signal
+entirely. Any diffuse quality to a sound source tends to collapse
+inward to a point somewhere within the stereo image. A practical
+example would be balanced reverberations within a large, live space;
+normally the sound is diffuse and soft, giving a sonic impression of
+volume. In point-stereo, the reverberations would still exist, but
+sound fairly firmly centered within the image (assuming the
+reverberation was centered overall; if the reverberation is stronger
+to the left, then the point of localization in point stereo would be
+to the left). This effect is most noticeable at low and mid
+frequencies and using headphones (which grant perfect stereo
+separation). Point stereo is is a graceful but generally easy to
+detect degradation to the sound quality and is thus used in frequency
+ranges where it is least noticeable.</p>
+
+<h3>Mixed Stereo</h3>
+
+<p>Mixed stereo is the simultaneous use of more than one of the above
+stereo encoding models, generally using more aggressive modes in
+higher frequencies, lower amplitudes or 'nearly' in-phase sound.</p>
+
+<p>It is also the case that near-DC frequencies should be encoded using
+lossless coupling to avoid frame blocking artifacts.</p>
+
+<h3>Vorbis Stereo Modes</h3>
+
+<p>Vorbis, as of 1.0, uses lossless stereo and a number of mixed modes
+constructed out of lossless and point stereo. Phase stereo was used
+in the rc2 encoder, but is not currently used for simplicity's sake. It
+will likely be re-added to the stereo model in the future.</p>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2005 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
+
+
+
+
+
+
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/stream.png
===================================================================
(Binary files differ)
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/v-comment.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/v-comment.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/v-comment.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,231 +1,285 @@
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p>
-
-
-<h1><font color=#000070>
-Ogg Vorbis I format specification: comment field and header specification
-</font></h1>
-
-<em>Last update to this document: July 16, 2002</em><p>
-
-<h1>Overview</h1>
-
-<p>The Vorbis text comment header is the second (of three) header
-packets that begin a Vorbis bitstream. It is meant for short, text
-comments, not arbitrary metadata; arbitrary metadata belongs in a
-separate logical bitstream (usually an XML stream type) that provides
-greater structure and machine parseability.
-
-<p>The comment field is meant to be used much like someone jotting a
-quick note on the bottom of a CDR. It should be a little information to
-remember the disc by and explain it to others; a short, to-the-point
-text note that need not only be a couple words, but isn't going to be
-more than a short paragraph. The essentials, in other words, whatever
-they turn out to be, eg:
-
-<blockquote>
-"Honest Bob and the Factory-to-Dealer-Incentives, _I'm Still Around_,
-opening for Moxy Fruvous, 1997"
-</blockquote>
-
-<h1>Comment encoding</h1>
-
-
-<h2>Structure</h2>
-
-The comment header logically is a list of eight-bit-clean vectors; the
-number of vectors is bounded to 2^32-1 and the length of each vector
-is limited to 2^32-1 bytes. The vector length is encoded; the vector
-contents themselves are not null terminated. In addition to the vector
-list, there is a single vector for vendor name (also 8 bit clean,
-length encoded in 32 bits). Libvorbis currently sets the vendor string
-to "Xiph.Org libVorbis I 20020717".<p>
-
-The comment header is decoded as follows:<p>
-
-<pre>
- 1) [vendor_length] = read an unsigned integer of 32 bits
- 2) [vendor_string] = read a UTF-8 vector as [vendor_length] octets
- 3) [user_comment_list_length] = read an unsigned integer of 32 bits
- 4) iterate [user_comment_list_length] times {
-
- 5) [length] = read an unsigned integer of 32 bits
- 6) this iteration's user comment = read a UTF-8 vector as [length] octets
-
- }
-
- 7) [framing_bit] = read a single bit as boolean
- 8) if ( [framing_bit] unset or end of packet ) then ERROR
- 9) done.
-</pre>
-
-
-<h2>Content vector format</h2>
-
-The comment vectors are structured similarly to a UNIX environment variable.
-That is, comment fields consist of a field name and a field value and
-look like:
-
-<pre>
-comment[0]="ARTIST=me";
-comment[1]="TITLE=the sound of Vorbis";
-</pre>
-
-<ul>
-<li>A case-insensitive field name that may consist of ASCII 0x20 through
-0x7D, 0x3D ('=') excluded. ASCII 0x41 through 0x5A inclusive (A-Z) is
-to be considered equivalent to ASCII 0x61 through 0x7A inclusive
-(a-z).
-
-<li>The field name is immediately followed by ASCII 0x3D ('='); this
-equals sign is used to terminate the field name.
-
-<li>0x3D is followed by 8 bit clean UTF-8 encoded field contents
-to the end of the field.
-</ul>
-
-<h3>Field names</h3>
-
-Below is a proposed, minimal list of standard field names with a
-description of intended use. No single or group of field names is
-mandatory; a comment header may contain one, all or none of the names
-in this list.<p>
-
-<dl>
-<dt>TITLE<dd>Track/Work name
-
-<dt>VERSION<dd>The version field may be used to differentiate multiple
-versions of the same track title in a single collection. (e.g. remix info)
-
-<dt>ALBUM<dd>The collection name to which this track belongs
-
-<dt>TRACKNUMBER<dd>The track number of this piece if part of a specific larger collection or album
-
-<dt>ARTIST<dd>The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text.
-
-<dt>PERFORMER<dd>The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the ARTIST and is omitted.
-
-<dt>COPYRIGHT<dd>Copyright attribution, e.g., '2001 Nobody's Band' or '1999 Jack Moffitt'
-
-<dt>LICENSE<dd>License information, eg, 'All Rights Reserved', 'Any
-Use Permitted', a URL to a license such as a Creative Commons license
-("www.creativecommons.org/blahblah/license.html") or the EFF Open
-Audio License ('distributed under the terms of the Open Audio
-License. see http://www.eff.org/IP/Open_licenses/eff_oal.html for
-details'), etc.
-
-<dt>ORGANIZATION<dd>Name of the organization producing the track (i.e.
-the 'record label')
-
-<dt>DESCRIPTION<dd>A short text description of the contents
-
-<dt>GENRE<dd>A short text indication of music genre
-
-<dt>DATE<dd>Date the track was recorded
-
-<dt>LOCATION<dd>Location where track was recorded
-
-<dt>CONTACT<dd>Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label.
-
-<dt>ISRC<dd>ISRC number for the track; see <a href="http://www.ifpi.org/site-content/online/isrc_intro.html">the ISRC intro page</a> for more information on ISRC numbers.
-
-</dl>
-
-<h3>Implications</h3>
-<ul>
-<li>
-Field names should not be 'internationalized'; this is a
-concession to simplicity not an attempt to exclude the majority of
-the world that doesn't speak English. Field *contents*, however,
-are represented in UTF-8 to allow easy representation of any language.
-<li>
-We have the length of the entirety of the field and restrictions on
-the field name so that the field name is bounded in a known way. Thus
-we also have the length of the field contents.
-<li>
-Individual 'vendors' may use non-standard field names within
-reason. The proper use of comment fields should be clear through
-context at this point. Abuse will be discouraged.
-<li>
-There is no vendor-specific prefix to 'nonstandard' field names.
-Vendors should make some effort to avoid arbitrarily polluting the
-common namespace. We will generally collect the more useful tags
-here to help with standardization.
-<li>
-Field names are not required to be unique (occur once) within a
-comment header. As an example, assume a track was recorded by three
-well know artists; the following is permissible, and encouraged:
-<pre>
- ARTIST=Dizzy Gillespie
- ARTIST=Sonny Rollins
- ARTIST=Sonny Stitt
-</pre>
-
-</ul>
-
-<h2>Encoding</h2>
-
-The comment header comprises the entirety of the second bitstream
-header packet. Unlike the first bitstream header packet, it is not
-generally the only packet on the second page and may not be restricted
-to within the second bitstream page. The length of the comment header
-packet is [practically] unbounded. The comment header packet is not
-optional; it must be present in the bitstream even if it is
-effectively empty.<p>
-
-The comment header is encoded as follows (as per Ogg's standard
-bitstream mapping which renders least-significant-bit of the word to be
-coded into the least significant available bit of the current
-bitstream octet first):
-
-<ol>
-<li>
-Vendor string length (32 bit unsigned quantity specifying number of octets)
-
-<li>
-Vendor string ([vendor string length] octets coded from beginning of string to end of string, not null terminated)
-
-<li>Number of comment fields (32 bit unsigned quantity specifying number of fields)
-
-<li>Comment field 0 length (if [Number of comment fields]>0; 32 bit unsigned quantity specifying number of octets)
-
-<li>
-Comment field 0 ([Comment field 0 length] octets coded from beginning of string to end of string, not null terminated)
-
-<li>Comment field 1 length (if [Number of comment fields]>1...)...
-</ol>
-
-This is actually somewhat easier to describe in code; implementation of the above can be found in vorbis/lib/info.c:_vorbis_pack_comment(),_vorbis_unpack_comment()
-
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-the Xiph.org Foundation</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-
-</body>
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Ogg Vorbis I format specification: comment field and header specification</h1>
+
+<h1>Overview</h1>
+
+<p>The Vorbis text comment header is the second (of three) header
+packets that begin a Vorbis bitstream. It is meant for short, text
+comments, not arbitrary metadata; arbitrary metadata belongs in a
+separate logical bitstream (usually an XML stream type) that provides
+greater structure and machine parseability.</p>
+
+<p>The comment field is meant to be used much like someone jotting a
+quick note on the bottom of a CDR. It should be a little information to
+remember the disc by and explain it to others; a short, to-the-point
+text note that need not only be a couple words, but isn't going to be
+more than a short paragraph. The essentials, in other words, whatever
+they turn out to be, eg:</p>
+
+<blockquote><p>
+"Honest Bob and the Factory-to-Dealer-Incentives, _I'm Still Around_,
+opening for Moxy Früvous, 1997"
+</p></blockquote>
+
+<h1>Comment encoding</h1>
+
+<h2>Structure</h2>
+
+<p>The comment header logically is a list of eight-bit-clean vectors; the
+number of vectors is bounded to 2^32-1 and the length of each vector
+is limited to 2^32-1 bytes. The vector length is encoded; the vector
+contents themselves are not null terminated. In addition to the vector
+list, there is a single vector for vendor name (also 8 bit clean,
+length encoded in 32 bits). For example, the 1.0 release of libvorbis
+set the vendor string to "Xiph.Org libVorbis I 20020717".</p>
+
+<p>The comment header is decoded as follows:</p>
+
+<pre>
+ 1) [vendor_length] = read an unsigned integer of 32 bits
+ 2) [vendor_string] = read a UTF-8 vector as [vendor_length] octets
+ 3) [user_comment_list_length] = read an unsigned integer of 32 bits
+ 4) iterate [user_comment_list_length] times {
+
+ 5) [length] = read an unsigned integer of 32 bits
+ 6) this iteration's user comment = read a UTF-8 vector as [length] octets
+
+ }
+
+ 7) [framing_bit] = read a single bit as boolean
+ 8) if ( [framing_bit] unset or end of packet ) then ERROR
+ 9) done.
+</pre>
+
+<h2>Content vector format</h2>
+
+<p>The comment vectors are structured similarly to a UNIX environment variable.
+That is, comment fields consist of a field name and a corresponding value and
+look like:</p>
+
+<pre>
+comment[0]="ARTIST=me";
+comment[1]="TITLE=the sound of Vorbis";
+</pre>
+
+<ul>
+<li>A case-insensitive field name that may consist of ASCII 0x20 through
+0x7D, 0x3D ('=') excluded. ASCII 0x41 through 0x5A inclusive (A-Z) is
+to be considered equivalent to ASCII 0x61 through 0x7A inclusive
+(a-z).</li>
+<li>The field name is immediately followed by ASCII 0x3D ('=');
+this equals sign is used to terminate the field name.</li>
+<li>0x3D is followed by the 8 bit clean UTF-8 encoded value of the
+field contents to the end of the field.</li>
+</ul>
+
+<h3>Field names</h3>
+
+<p>Below is a proposed, minimal list of standard field names with a
+description of intended use. No single or group of field names is
+mandatory; a comment header may contain one, all or none of the names
+in this list.</p>
+
+<dl>
+
+<dt>TITLE</dt>
+<dd>Track/Work name</dd>
+
+<dt>VERSION</dt>
+<dd>The version field may be used to differentiate multiple
+versions of the same track title in a single collection.
+(e.g. remix info)</dd>
+
+<dt>ALBUM</dt>
+<dd>The collection name to which this track belongs</dd>
+
+<dt>TRACKNUMBER</dt>
+<dd>The track number of this piece if part of a specific larger collection or album</dd>
+
+<dt>ARTIST</dt>
+<dd>The artist generally considered responsible for the work. In popular music
+this is usually the performing band or singer. For classical music it would be
+the composer. For an audio book it would be the author of the original text.</dd>
+
+<dt>PERFORMER</dt>
+<dd>The artist(s) who performed the work. In classical music this would be the
+conductor, orchestra, soloists. In an audio book it would be the actor who did
+the reading. In popular music this is typically the same as the ARTIST and
+is omitted.</dd>
+
+<dt>COPYRIGHT</dt>
+<dd>Copyright attribution, e.g., '2001 Nobody's Band' or '1999 Jack Moffitt'</dd>
+
+<dt>LICENSE</dt>
+<dd>License information, eg, 'All Rights Reserved', 'Any
+Use Permitted', a URL to a license such as a Creative Commons license
+("www.creativecommons.org/blahblah/license.html") or the EFF Open
+Audio License ('distributed under the terms of the Open Audio
+License. see http://www.eff.org/IP/Open_licenses/eff_oal.html for
+details'), etc.</dd>
+
+<dt>ORGANIZATION</dt>
+<dd>Name of the organization producing the track (i.e.
+the 'record label')</dd>
+
+<dt>DESCRIPTION</dt>
+<dd>A short text description of the contents</dd>
+
+<dt>GENRE</dt>
+<dd>A short text indication of music genre</dd>
+
+<dt>DATE</dt>
+<dd>Date the track was recorded</dd>
+
+<dt>LOCATION</dt>
+<dd>Location where track was recorded</dd>
+
+<dt>CONTACT</dt>
+<dd>Contact information for the creators or distributors of the track.
+This could be a URL, an email address, the physical address of
+the producing label.</dd>
+
+<dt>ISRC</dt>
+<dd>ISRC number for the track; see <a href="http://www.ifpi.org/isrc/">the
+ISRC intro page</a> for more information on ISRC numbers.</dd>
+
+</dl>
+
+<h3>Implications</h3>
+
+<ul>
+<li>Field names should not be 'internationalized'; this is a
+concession to simplicity not an attempt to exclude the majority of
+the world that doesn't speak English. Field <emph>contents</emph>,
+however, use the UTF-8 character encoding to allow easy representation
+of any language.</li>
+<li>We have the length of the entirety of the field and restrictions on
+the field name so that the field name is bounded in a known way. Thus
+we also have the length of the field contents.</li>
+<li>Individual 'vendors' may use non-standard field names within
+reason. The proper use of comment fields should be clear through
+context at this point. Abuse will be discouraged.</li>
+<li>There is no vendor-specific prefix to 'nonstandard' field names.
+Vendors should make some effort to avoid arbitrarily polluting the
+common namespace. We will generally collect the more useful tags
+here to help with standardization.</li>
+<li>Field names are not required to be unique (occur once) within a
+comment header. As an example, assume a track was recorded by three
+well know artists; the following is permissible, and encouraged:
+<pre>
+ ARTIST=Dizzy Gillespie
+ ARTIST=Sonny Rollins
+ ARTIST=Sonny Stitt
+</pre></li>
+</ul>
+
+<h2>Encoding</h2>
+
+<p>The comment header comprises the entirety of the second bitstream
+header packet. Unlike the first bitstream header packet, it is not
+generally the only packet on the second page and may not be restricted
+to within the second bitstream page. The length of the comment header
+packet is (practically) unbounded. The comment header packet is not
+optional; it must be present in the bitstream even if it is
+effectively empty.</p>
+
+<p>The comment header is encoded as follows (as per Ogg's standard
+bitstream mapping which renders least-significant-bit of the word to be
+coded into the least significant available bit of the current
+bitstream octet first):</p>
+
+<ol>
+<li>Vendor string length (32 bit unsigned quantity specifying number of octets)</li>
+<li>Vendor string ([vendor string length] octets coded from beginning of string
+to end of string, not null terminated)</li>
+<li>Number of comment fields (32 bit unsigned quantity specifying number of fields)</li>
+<li>Comment field 0 length (if [Number of comment fields]>0; 32 bit unsigned
+quantity specifying number of octets)</li>
+<li>Comment field 0 ([Comment field 0 length] octets coded from beginning of
+string to end of string, not null terminated)</li>
+<li>Comment field 1 length (if [Number of comment fields]>1...)...</li>
+</ol>
+
+<p>This is actually somewhat easier to describe in code; implementation of the above
+can be found in vorbis/lib/info.c:_vorbis_pack_comment(),_vorbis_unpack_comment()</p>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2005 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbis-fidelity.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbis-fidelity.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbis-fidelity.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,142 +1,180 @@
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p>
-
-
-<h1><font color=#000070>
-Ogg Vorbis: Fidelity measurement and terminology discussion
-</font></h1>
-
-<em>Last update to this document: July 16, 2002</em><p>
-
-Terminology discussed in this document is based on common terminology
-associated with contemporary codecs such as MPEG I audio layer 3
-(mp3). However, some differences in terminology are useful in the
-context of Vorbis as Vorbis functions somewhat differently than most
-current formats. For clarity, then, we describe a common terminology
-for discussion of Vorbis's and other formats' audio quality.<p>
-
-<h2>Subjective and Objective</h2>
-
-<em>Objective</em> fidelity is a measure, based on a computable,
-mechanical metric, of how carefully an output matches an input. For
-example, a stereo amplifier may claim to introduce less that .01%
-total harmonic distortion when amplifying an input signal; this claim
-is easy to verify given proper equipment, and any number of testers are
-likely to arrive at the same, exact results. One need not listen to
-the equipment to make this measurement.<p>
-
-However, given two amplifiers with identical, verifiable objective
-specifications, listeners may strongly prefer the sound quality of one
-over the other. This is actually the case in the decades old debate
-[some would say jihad] among audiophiles involving vacuum tube versus
-solid state amplifiers. There are people who can tell the difference,
-and strongly prefer one over the other despite seemingly identical,
-measurable quality. This preference is <em>subjective</em> and
-difficult to measure but nonetheless real.
-
-Individual elements of subjective differences often can be qualified,
-but overall subjective quality generally is not measurable. Different
-observers are likely to disagree on the exact results of a subjective
-test as each observer's perspective differs. When measuring
-subjective qualities, the best one can hope for is average, empirical
-results that show statistical significance across a group.<p>
-
-Perceptual codecs are most concerned with subjective, not objective,
-quality. This is why evaluating a perceptual codec via distortion
-measures and sonograms alone is useless; these objective measures may
-provide insight into the quality or functioning of a codec, but cannot
-answer the much squishier subjective question, "Does it sound
-good?". The tube amplifier example is perhaps not the best as very few
-people can hear, or care to hear, the minute differences between tubes
-and transistors, whereas the subjective differences in perceptual
-codecs tend to be quite large even when objective differences are
-not.<p>
-
-<h2>Fidelity, Artifacts and Differences</h2> Audio <em>artifacts</em>
-and loss of fidelity or more simply put, audio <em>differences</em>
-are not the same thing.<p>
-
-A loss of fidelity implies differences between the perceived input and
-output signal; it does not necessarily imply that the differences in
-output are displeasing or that the output sounds poor (although this
-is often the case). Tube amplifiers are <em>not</em> higher fidelity
-than modern solid state and digital systems. They simply produce a
-form of distortion and coloring that is either unnoticeable or actually
-pleasing to many ears.<p>
-
-As compared to an original signal using hard metrics, all perceptual
-codecs [ASPEC, ATRAC, MP3, WMA, AAC, TwinVQ, AC3 and Vorbis included]
-lose objective fidelity in order to reduce bitrate. This is fact. The
-idea is to lose fidelity in ways that cannot be perceived. However,
-most current streaming applications demand bitrates lower than what
-can be achieved by sacrificing only objective fidelity; this is also
-fact, despite whatever various company press releases might claim.
-Subjective fidelity eventually must suffer in one way or another.<p>
-
-The goal is to choose the best possible tradeoff such that the
-fidelity loss is graceful and not obviously noticeable. Most listeners
-of FM radio do not realize how much lower fidelity that medium is as
-compared to compact discs or DAT. However, when compared directly to
-source material, the difference is obvious. A cassette tape is lower
-fidelity still, and yet the degradation, relatively speaking, is
-graceful and generally easy not to notice. Compare this graceful loss
-of quality to an average 44.1kHz stereo mp3 encoded at 80 or 96kbps.
-The mp3 might actually be higher objective fidelity but subjectively
-sounds much worse.<p>
-
-Thus, when a CODEC <em>must</em> sacrifice subjective quality in order
-to satisfy a user's requirements, the result should be a
-<em>difference</em> that is generally either difficult to notice
-without comparison, or easy to ignore. An <em>artifact</em>, on the
-other hand, is an element introduced into the output that is
-immediately noticeable, obviously foreign, and undesired. The famous
-'underwater' or 'twinkling' effect synonymous with low bitrate (or
-poorly encoded) mp3 is an example of an <em>artifact</em>. This
-working definition differs slightly from common usage, but the coined
-distinction between differences and artifacts is useful for our
-discussion.<p>
-
-The goal, when it is absolutely necessary to sacrifice subjective
-fidelity, is obviously to strive for differences and not artifacts.
-The vast majority of codecs today fail at this task miserably,
-predictably, and regularly in one way or another. Avoiding such
-failures when it is necessary to sacrifice subjective quality is a
-fundamental design objective of Vorbis and that objective is reflected
-in Vorbis's design and tuning.<p>
-
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-the Xiph.org Foundation</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-</body>
-
-
-
-
-
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Ogg Vorbis: Fidelity measurement and terminology discussion</h1>
+
+<p>Terminology discussed in this document is based on common terminology
+associated with contemporary codecs such as MPEG I audio layer 3
+(mp3). However, some differences in terminology are useful in the
+context of Vorbis as Vorbis functions somewhat differently than most
+current formats. For clarity, then, we describe a common terminology
+for discussion of Vorbis's and other formats' audio quality.</p>
+
+<h2>Subjective and Objective</h2>
+
+<p><em>Objective</em> fidelity is a measure, based on a computable,
+mechanical metric, of how carefully an output matches an input. For
+example, a stereo amplifier may claim to introduce less that .01%
+total harmonic distortion when amplifying an input signal; this claim
+is easy to verify given proper equipment, and any number of testers are
+likely to arrive at the same, exact results. One need not listen to
+the equipment to make this measurement.</p>
+
+<p>However, given two amplifiers with identical, verifiable objective
+specifications, listeners may strongly prefer the sound quality of one
+over the other. This is actually the case in the decades old debate
+[some would say jihad] among audiophiles involving vacuum tube versus
+solid state amplifiers. There are people who can tell the difference,
+and strongly prefer one over the other despite seemingly identical,
+measurable quality. This preference is <em>subjective</em> and
+difficult to measure but nonetheless real.</p>
+
+<p>Individual elements of subjective differences often can be qualified,
+but overall subjective quality generally is not measurable. Different
+observers are likely to disagree on the exact results of a subjective
+test as each observer's perspective differs. When measuring
+subjective qualities, the best one can hope for is average, empirical
+results that show statistical significance across a group.</p>
+
+<p>Perceptual codecs are most concerned with subjective, not objective,
+quality. This is why evaluating a perceptual codec via distortion
+measures and sonograms alone is useless; these objective measures may
+provide insight into the quality or functioning of a codec, but cannot
+answer the much squishier subjective question, "Does it sound
+good?". The tube amplifier example is perhaps not the best as very few
+people can hear, or care to hear, the minute differences between tubes
+and transistors, whereas the subjective differences in perceptual
+codecs tend to be quite large even when objective differences are
+not.</p>
+
+<h2>Fidelity, Artifacts and Differences</h2>
+
+<p>Audio <em>artifacts</em> and loss of fidelity or more simply
+put, audio <em>differences</em> are not the same thing.</p>
+
+<p>A loss of fidelity implies differences between the perceived input and
+output signal; it does not necessarily imply that the differences in
+output are displeasing or that the output sounds poor (although this
+is often the case). Tube amplifiers are <em>not</em> higher fidelity
+than modern solid state and digital systems. They simply produce a
+form of distortion and coloring that is either unnoticeable or actually
+pleasing to many ears.</p>
+
+<p>As compared to an original signal using hard metrics, all perceptual
+codecs [ASPEC, ATRAC, MP3, WMA, AAC, TwinVQ, AC3 and Vorbis included]
+lose objective fidelity in order to reduce bitrate. This is fact. The
+idea is to lose fidelity in ways that cannot be perceived. However,
+most current streaming applications demand bitrates lower than what
+can be achieved by sacrificing only objective fidelity; this is also
+fact, despite whatever various company press releases might claim.
+Subjective fidelity eventually must suffer in one way or another.</p>
+
+<p>The goal is to choose the best possible tradeoff such that the
+fidelity loss is graceful and not obviously noticeable. Most listeners
+of FM radio do not realize how much lower fidelity that medium is as
+compared to compact discs or DAT. However, when compared directly to
+source material, the difference is obvious. A cassette tape is lower
+fidelity still, and yet the degradation, relatively speaking, is
+graceful and generally easy not to notice. Compare this graceful loss
+of quality to an average 44.1kHz stereo mp3 encoded at 80 or 96kbps.
+The mp3 might actually be higher objective fidelity but subjectively
+sounds much worse.</p>
+
+<p>Thus, when a CODEC <em>must</em> sacrifice subjective quality in order
+to satisfy a user's requirements, the result should be a
+<em>difference</em> that is generally either difficult to notice
+without comparison, or easy to ignore. An <em>artifact</em>, on the
+other hand, is an element introduced into the output that is
+immediately noticeable, obviously foreign, and undesired. The famous
+'underwater' or 'twinkling' effect synonymous with low bitrate (or
+poorly encoded) mp3 is an example of an <em>artifact</em>. This
+working definition differs slightly from common usage, but the coined
+distinction between differences and artifacts is useful for our
+discussion.</p>
+
+<p>The goal, when it is absolutely necessary to sacrifice subjective
+fidelity, is obviously to strive for differences and not artifacts.
+The vast majority of codecs today fail at this task miserably,
+predictably, and regularly in one way or another. Avoiding such
+failures when it is necessary to sacrifice subjective quality is a
+fundamental design objective of Vorbis and that objective is reflected
+in Vorbis's design and tuning.</p>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2005 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbis.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbis.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbis.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,197 +1,234 @@
-<HTML><HEAD><TITLE>xiph.org: Ogg Vorbis documentation</TITLE>
-<BODY bgcolor="#ffffff" text="#202020" link="#006666" vlink="#000000">
-<nobr><img src="white-ogg.png"><img src="vorbisword2.png"></nobr><p>
-
-
-<h1><font color=#000070>
-Ogg Vorbis encoding format documentation
-</font></h1>
-
-<em>Last update to this document: July 2, 2002</em><br>
-<em>Last update to Vorbis documentation: July 2, 2002</em><p>
-
-<table><tr><td>
-<img src=wait.png>
-</td><td valign=center>
-As of writing, not all the below document
-links are live. They will be populated as we complete the
-documents.
-</td></tr></table>
-
-<p>
-<h2>Documents</h2>
-<ul>
-<li><a href="packet.html">Vorbis packet structure</a>
-<li><a href="envelope.html">Temporal envelope shaping and blocksize</a>
-<li><a href="mdct.html">Time domain segmentation and MDCT transform</a>
-<li><a href="resolution.html">The resolution floor</a>
-<li><a href="residuals.html">MDCT-domain fine structure</a><p>
-
-<li><a href="probmodel.html">The Vorbis probability model</a>
-
-<li><a href="bitpack.html">The Vorbis bitpacker</a><p>
-
-<li><a href="oggstream.html">Ogg bitstream overview</a>
-<li><a href="framing.html">Ogg logical bitstream and framing spec</a>
-<li><a href="vorbis-stream.html">Vorbis packet->Ogg bitstream
- mapping</a><p>
-
-<li><a href="programming.html">Programming with libvorbis</a><p>
-</ul>
-
-<h2>Description</h2>
-Ogg Vorbis is a general purpose compressed audio format
-for high quality (44.1-48.0kHz, 16+ bit, polyphonic) audio and music
-at moderate fixed and variable bitrates (40-80 kb/s/channel). This
-places Vorbis in the same class as audio representations including
-MPEG-1 audio layer 3, MPEG-4 audio (AAC and TwinVQ), and PAC.<p>
-
-Vorbis is the first of a planned family of Ogg multimedia coding
-formats being developed as part of the Xiph.org Foundation's Ogg multimedia
-project. See <a href="http://www.xiph.org/">http://www.xiph.org/</a>
-for more information.
-
-<h2>Vorbis technical documents</h2>
-
-A Vorbis encoder takes in overlapping (but contiguous) short-time
-segments of audio data. The encoder analyzes the content of the audio
-to determine an optimal compact representation; this phase of encoding
-is known as <em>analysis</em>. For each short-time block of sound,
-the encoder then packs an efficient representation of the signal, as
-determined by analysis, into a raw packet much smaller than the size
-required by the original signal; this phase is <em>coding</em>.
-Lastly, in a streaming environment, the raw packets are then
-structured into a continuous stream of octets; this last phase is
-<em>streaming</em>. Note that the stream of octets is referred to both
-as a 'byte-' and 'bit-'stream; the latter usage is acceptible as the
-stream of octets is a physical representation of a true logical
-bit-by-bit stream.<p>
-
-A Vorbis decoder performs a mirror image process of extracting the
-original sequence of raw packets from an Ogg stream (<em>stream
-decomposition</em>), reconstructing the signal representation from the
-raw data in the packet (<em>decoding</em>) and them reconstituting an
-audio signal from the decoded representation (<em>synthesis</em>).<p>
-
-The <a href="programming.html">Programming with libvorbis</a>
-documents discuss use of the reference Vorbis codec library
-(libvorbis) produced by the Xiph.org Foundation.<p>
-
-The data representations and algorithms necessary at each step to
-encode and decode Ogg Vorbis bitstreams are described by the below
-documents in sufficient detail to construct a complete Vorbis codec.
-Note that at the time of writing, Vorbis is still in a 'Request For
-Comments' stage of development; despite being in advanced stages of
-development, input from the multimedia community is welcome.<p>
-
-<h3>Vorbis analysis and synthesis</h3>
-
-Analysis begins by seperating an input audio stream into individual,
-overlapping short-time segments of audio data. These segments are
-then transformed into an alternate representation, seeking to
-represent the original signal in a more efficient form that codes into
-a smaller number of bytes. The analysis and transformation stage is
-the most complex element of producing a Vorbis bitstream.<p>
-
-The corresponding synthesis step in the decoder is simpler; there is
-no analysis to perform, merely a mechanical, deterministic
-reconstruction of the original audio data from the transform-domain
-representation.<p>
-
-<ul>
-<li><a href="packet.html">Vorbis packet structure</a>: Describes the basic analysis components necessary to produce Vorbis packets and the structure of the packet itself.
-<li><a href="envelope.html">Temporal envelope shaping and blocksize</a>: Use of temporal envelope shaping and variable blocksize to minimize time-domain energy leakage during wide dynamic range and spectral energy swings. Also discusses time-related principles of psychoacoustics.
-<li><a href="mdct.html">Time domain segmentation and MDCT transform</a>: Division of time domain data into individual overlapped, windowed short-time vectors and transformation using the MDCT
-<li><a href="resolution.html">The resolution floor</a>: Use of frequency doamin psychoacoustics, and the MDCT-domain noise, masking and resolution floors
-<li><a href="residuals.html">MDCT-domain fine structure</a>: Production, quantization and massaging of MDCT-spectrum fine structure
-</ul>
-
-<h3>Vorbis coding and decoding</h3>
-
-Coding and decoding converts the transform-domain representation of
-the original audio produced by analysis to and from a bitwise packed
-raw data packet. Coding and decoding consist of two logically
-orthogonal concepts, <em>back-end coding</em> and <em>bitpacking</em>.<p>
-
-<em>Back-end coding</em> uses a probability model to represent the raw numbers
-of the audio representation in as few physical bits as possible;
-familiar examples of back-end coding include Huffman coding and Vector
-Quantization.<p>
-
-<em>Bitpacking</em> arranges the variable sized words of the back-end
-coding into a vector of octets without wasting space. The octets
-produced by coding a single short-time audio segment is one raw Vorbis
-packet.<p>
-
-<ul>
-
-<li><a href="probmodel.html">The Vorbis probability model</a>
-
-<li><a href="bitpack.html">The Vorbis bitpacker</a>: Arrangement of
-variable bit-length words into an octet-aligned packet.
-
-</ul>
-
-<h3>Vorbis streaming and stream decomposition</h3>
-
-Vorbis packets contain the raw, bitwise-compressed representation of a
-snippet of audio. These packets contain no structure and cannot be
-strung together directly into a stream; for streamed transmission and
-storage, Vorbis packets are encoded into an Ogg bitstream.<p>
-
-<ul>
-
-<li><a href="oggstream.html">Ogg bitstream overview</a>: High-level
-description of Ogg logical bitstreams, how logical bitstreams
-(of mixed media types) can be combined into physical bitstreams, and
-restrictions on logical-to-physical mapping. Note that this document is
-not specific only to Ogg Vorbis.
-
-<li><a href="framing.html">Ogg logical bitstream and framing
-spec</a>: Low level, complete specification of Ogg logical
-bitstream pages. Note that this document is not specific only to Ogg
-Vorbis.
-
-<li><a href="vorbis-stream.html">Vorbis bitstream mapping</a>:
-Specifically describes mapping Vorbis data into an
-Ogg physical bitstream.
-
-</ul>
-
-
-<hr>
-<a href="http://www.xiph.org/">
-<img src="white-xifish.png" align=left border=0>
-</a>
-<font size=-2 color=#505050>
-
-Ogg is a <a href="http://www.xiph.org">Xiph.org Foundation</a> effort
-to protect essential tenets of Internet multimedia from corporate
-hostage-taking; Open Source is the net's greatest tool to keep
-everyone honest. See <a href="http://www.xiph.org/about.html">About
-the Xiph.org Foundation</a> for details.
-<p>
-
-Ogg Vorbis is the first Ogg audio CODEC. Anyone may freely use and
-distribute the Ogg and Vorbis specification, whether in a private,
-public or corporate capacity. However, the Xiph.org Foundation and
-the Ogg project (xiph.org) reserve the right to set the Ogg Vorbis
-specification and certify specification compliance.<p>
-
-Xiph.org's Vorbis software CODEC implementation is distributed under a
-BSD-like license. This does not restrict third parties from
-distributing independent implementations of Vorbis software under
-other licenses.<p>
-
-Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
-of the <a href="http://www.xiph.org/">Xiph.org Foundation</a>. These
-pages are copyright (C) 1994-2002 Xiph.org Foundation. All rights
-reserved.<p>
-
-</body>
-
-
-
-
-
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15"/>
+<title>Ogg Vorbis Documentation</title>
+
+<style type="text/css">
+body {
+ margin: 0 18px 0 18px;
+ padding-bottom: 30px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ color: #333333;
+ font-size: .8em;
+}
+
+a {
+ color: #3366cc;
+}
+
+img {
+ border: 0;
+}
+
+#xiphlogo {
+ margin: 30px 0 16px 0;
+}
+
+#content p {
+ line-height: 1.4;
+}
+
+h1, h1 a, h2, h2 a, h3, h3 a {
+ font-weight: bold;
+ color: #ff9900;
+ margin: 1.3em 0 8px 0;
+}
+
+h1 {
+ font-size: 1.3em;
+}
+
+h2 {
+ font-size: 1.2em;
+}
+
+h3 {
+ font-size: 1.1em;
+}
+
+li {
+ line-height: 1.4;
+}
+
+#copyright {
+ margin-top: 30px;
+ line-height: 1.5em;
+ text-align: center;
+ font-size: .8em;
+ color: #888888;
+ clear: both;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="xiphlogo">
+ <a href="http://www.xiph.org/"><img src="fish_xiph_org.png" alt="Fish Logo and Xiph.org"/></a>
+</div>
+
+<h1>Ogg Vorbis encoding format documentation</h1>
+
+<p><img src="wait.png" alt="wait"/>As of writing, not all the below document
+links are live. They will be populated as we complete the documents.</p>
+
+<h2>Documents</h2>
+
+<ul>
+<li><a href="packet.html">Vorbis packet structure</a></li>
+<li><a href="envelope.html">Temporal envelope shaping and blocksize</a></li>
+<li><a href="mdct.html">Time domain segmentation and MDCT transform</a></li>
+<li><a href="resolution.html">The resolution floor</a></li>
+<li><a href="residuals.html">MDCT-domain fine structure</a></li>
+</ul>
+
+<ul>
+<li><a href="probmodel.html">The Vorbis probability model</a></li>
+<li><a href="bitpack.html">The Vorbis bitpacker</a></li>
+</ul>
+
+<ul>
+<li><a href="oggstream.html">Ogg bitstream overview</a></li>
+<li><a href="framing.html">Ogg logical bitstream and framing spec</a></li>
+<li><a href="vorbis-stream.html">Vorbis packet->Ogg bitstream mapping</a></li>
+</ul>
+
+<ul>
+<li><a href="programming.html">Programming with libvorbis</a></li>
+</ul>
+
+<h2>Description</h2>
+
+<p>Ogg Vorbis is a general purpose compressed audio format
+for high quality (44.1-48.0kHz, 16+ bit, polyphonic) audio and music
+at moderate fixed and variable bitrates (40-80 kb/s/channel). This
+places Vorbis in the same class as audio representations including
+MPEG-1 audio layer 3, MPEG-4 audio (AAC and TwinVQ), and PAC.</p>
+
+<p>Vorbis is the first of a planned family of Ogg multimedia coding
+formats being developed as part of the Xiph.org Foundation's Ogg multimedia
+project. See <a href="http://www.xiph.org/">http://www.xiph.org/</a>
+for more information.</p>
+
+<h2>Vorbis technical documents</h2>
+
+<p>A Vorbis encoder takes in overlapping (but contiguous) short-time
+segments of audio data. The encoder analyzes the content of the audio
+to determine an optimal compact representation; this phase of encoding
+is known as <em>analysis</em>. For each short-time block of sound,
+the encoder then packs an efficient representation of the signal, as
+determined by analysis, into a raw packet much smaller than the size
+required by the original signal; this phase is <em>coding</em>.
+Lastly, in a streaming environment, the raw packets are then
+structured into a continuous stream of octets; this last phase is
+<em>streaming</em>. Note that the stream of octets is referred to both
+as a 'byte-' and 'bit-'stream; the latter usage is acceptible as the
+stream of octets is a physical representation of a true logical
+bit-by-bit stream.</p>
+
+<p>A Vorbis decoder performs a mirror image process of extracting the
+original sequence of raw packets from an Ogg stream (<em>stream
+decomposition</em>), reconstructing the signal representation from the
+raw data in the packet (<em>decoding</em>) and them reconstituting an
+audio signal from the decoded representation (<em>synthesis</em>).</p>
+
+<p>The <a href="programming.html">Programming with libvorbis</a>
+documents discuss use of the reference Vorbis codec library
+(libvorbis) produced by the Xiph.org Foundation.</p>
+
+<p>The data representations and algorithms necessary at each step to
+encode and decode Ogg Vorbis bitstreams are described by the below
+documents in sufficient detail to construct a complete Vorbis codec.
+Note that at the time of writing, Vorbis is still in a 'Request For
+Comments' stage of development; despite being in advanced stages of
+development, input from the multimedia community is welcome.</p>
+
+<h3>Vorbis analysis and synthesis</h3>
+
+<p>Analysis begins by seperating an input audio stream into individual,
+overlapping short-time segments of audio data. These segments are
+then transformed into an alternate representation, seeking to
+represent the original signal in a more efficient form that codes into
+a smaller number of bytes. The analysis and transformation stage is
+the most complex element of producing a Vorbis bitstream.</p>
+
+<p>The corresponding synthesis step in the decoder is simpler; there is
+no analysis to perform, merely a mechanical, deterministic
+reconstruction of the original audio data from the transform-domain
+representation.</p>
+
+<ul>
+<li><a href="packet.html">Vorbis packet structure</a>:
+Describes the basic analysis components necessary to produce Vorbis
+packets and the structure of the packet itself.</li>
+<li><a href="envelope.html">Temporal envelope shaping and blocksize</a>:
+Use of temporal envelope shaping and variable blocksize to minimize
+time-domain energy leakage during wide dynamic range and spectral energy
+swings. Also discusses time-related principles of psychoacoustics.</li>
+<li><a href="mdct.html">Time domain segmentation and MDCT transform</a>:
+Division of time domain data into individual overlapped, windowed
+short-time vectors and transformation using the MDCT</li>
+<li><a href="resolution.html">The resolution floor</a>: Use of frequency
+doamin psychoacoustics, and the MDCT-domain noise, masking and resolution
+floors</li>
+<li><a href="residuals.html">MDCT-domain fine structure</a>: Production,
+quantization and massaging of MDCT-spectrum fine structure</li>
+</ul>
+
+<h3>Vorbis coding and decoding</h3>
+
+<p>Coding and decoding converts the transform-domain representation of
+the original audio produced by analysis to and from a bitwise packed
+raw data packet. Coding and decoding consist of two logically
+orthogonal concepts, <em>back-end coding</em> and <em>bitpacking</em>.</p>
+
+<p><em>Back-end coding</em> uses a probability model to represent the raw numbers
+of the audio representation in as few physical bits as possible;
+familiar examples of back-end coding include Huffman coding and Vector
+Quantization.</p>
+
+<p><em>Bitpacking</em> arranges the variable sized words of the back-end
+coding into a vector of octets without wasting space. The octets
+produced by coding a single short-time audio segment is one raw Vorbis
+packet.</p>
+
+<ul>
+<li><a href="probmodel.html">The Vorbis probability model</a></li>
+<li><a href="bitpack.html">The Vorbis bitpacker</a>: Arrangement of
+variable bit-length words into an octet-aligned packet.</li>
+</ul>
+
+<h3>Vorbis streaming and stream decomposition</h3>
+
+<p>Vorbis packets contain the raw, bitwise-compressed representation of a
+snippet of audio. These packets contain no structure and cannot be
+strung together directly into a stream; for streamed transmission and
+storage, Vorbis packets are encoded into an Ogg bitstream.</p>
+
+<ul>
+<li><a href="oggstream.html">Ogg bitstream overview</a>: High-level
+description of Ogg logical bitstreams, how logical bitstreams
+(of mixed media types) can be combined into physical bitstreams, and
+restrictions on logical-to-physical mapping. Note that this document is
+not specific only to Ogg Vorbis.</li>
+<li><a href="framing.html">Ogg logical bitstream and framing
+spec</a>: Low level, complete specification of Ogg logical
+bitstream pages. Note that this document is not specific only to Ogg
+Vorbis.</li>
+<li><a href="vorbis-stream.html">Vorbis bitstream mapping</a>:
+Specifically describes mapping Vorbis data into an
+Ogg physical bitstream.</li>
+</ul>
+
+<div id="copyright">
+ The Xiph Fish Logo is a
+ trademark (™) of Xiph.Org.<br/>
+
+ These pages © 1994 - 2005 Xiph.Org. All rights reserved.
+</div>
+
+</body>
+</html>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisenc/Makefile.am
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisenc/Makefile.am 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisenc/Makefile.am 2008-06-13 23:59:37 UTC (rev 15029)
@@ -2,8 +2,10 @@
docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)/vorbisenc
-doc_DATA = index.html overview.html reference.html style.css\
- vorbis_encode_ctl.html vorbis_encode_init.html vorbis_info.html\
+doc_DATA = changes.html examples.html index.html ov_ectl_ratemanage2_arg.html \
+ ov_ectl_ratemanage_arg.html overview.html reference.html style.css\
+ vorbis_encode_ctl.html vorbis_encode_init.html vorbis_encode_setup_init.html \
+ vorbis_encode_setup_managed.html vorbis_encode_setup_vbr.html vorbis_info.html \
vorbis_encode_init_vbr.html
EXTRA_DIST = $(doc_DATA)
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/Makefile.am
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/Makefile.am 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/Makefile.am 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,6 +7,7 @@
example.html exampleindex.html fileinfo.html index.html\
initialization.html ov_bitrate.html ov_bitrate_instant.html\
ov_callbacks.html ov_clear.html ov_comment.html ov_crosslap.html\
+ ov_fopen.html\
ov_info.html ov_open.html ov_open_callbacks.html ov_pcm_seek.html\
ov_pcm_seek_lap.html ov_pcm_seek_page.html ov_pcm_seek_page_lap.html\
ov_pcm_tell.html ov_pcm_total.html ov_raw_seek.html\
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/OggVorbis_File.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/OggVorbis_File.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/OggVorbis_File.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -21,28 +21,44 @@
The OggVorbis_File structure defines an Ogg Vorbis file.
<p>
-This structure is used in all libvorbisfile routines. Before it can be used,
-it must be initialized by <a href="ov_open.html">ov_open()</a> or <a
-href="ov_open_callbacks.html">ov_open_callbacks()</a>.
+This structure is used in all libvorbisfile routines. Before it can
+be used, it must be initialized by <a
+href="ov_open.html">ov_open()</a>, <a
+href="ov_fopen.html">ov_fopen()</a>, or <a
+href="ov_open_callbacks.html">ov_open_callbacks()</a>. <em>Important
+Note:</em> The use of <a href="ov_open.html">ov_open()</a> is
+discouraged under Windows due to a peculiarity of Windows linking
+convention; use <a href="ov_fopen.html">ov_fopen()</a> or <a
+href="ov_open_callbacks.html">ov_open_callbacks()</a> instead. This
+caution only applies to Windows; use of <a
+href="ov_open.html">ov_open()</a> is appropriate for all other
+platforms. See the <a href="ov_open.html">ov_open()</a> page for more
+information.
<p>
After use, the OggVorbis_File structure must be deallocated with a
call to <a href="ov_clear.html">ov_clear()</a>.
<p>
-Once a file or data source is opened successfully by libvorbisfile
-(using <a href="ov_open.html">ov_open()</a> or <a
-href="ov_open_callbacks.html">ov_open_callbacks()</a>), it is owned by
-libvorbisfile. The file should not be used by any other applications or
-functions outside of the libvorbisfile API. The file must not be closed
-directly by the application at any time after a successful open;
-libvorbisfile expects to close the file within <a
-href="ov_clear.html">ov_clear()</a>.
-<p>
-If the call to <a href="ov_open.html">ov_open()</a> or <a
+Note that once a file handle is passed to a successful <a
+href="ov_open.html">ov_open()</a> call, the handle is owned by
+libvorbisfile and will be closed by libvorbisfile later during the
+call to <a href="ov_clear.html">ov_clear()</a>. The handle should not
+be used or closed outside of the libvorbisfile API. Similarly, files
+opened by <a href="ov_fopen.html">ov_fopen()</a> will also be closed
+internally by vorbisfile in <a href="ov_clear.html">ov_clear()</a>.<p>
+
+<a href="ov_open_callbacks.html">ov_open_callbacks()</a> allows the
+application to choose whether libvorbisfile will or will not close the
+handle in <a href="ov_clear.html">ov_clear()</a>; see the <a
+href="ov_open_callbacks.html">ov_open_callbacks()</a> page for more information.<p>
+
+If a call to <a href="ov_open.html">ov_open()</a> or <a
href="ov_open_callbacks.html">ov_open_callbacks()</a> <b>fails</b>,
-libvorbisfile does <b>not</b> assume ownership of the file and the
-application is expected to close it if necessary.
+libvorbisfile does <b>not</b> assume ownership of the handle and the
+application is expected to close it if necessary. A failed <a
+href="ov_fopen.html">ov_fopen()</a> call will internally close the
+file handle if the open process fails.<p>
<br><br>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
@@ -108,11 +124,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/callbacks.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/callbacks.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/callbacks.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -50,9 +50,13 @@
The seek-like function provided in the <tt>seek_func</tt> field is
used to request non-sequential data access by libvorbisfile, moving
-the access cursor to the requested position.<p>
+the access cursor to the requested position. The seek function is
+optional; if callbacks are only to handle non-seeking (streaming) data
+or the application wishes to force streaming behavior,
+<tt>seek_func</tt> and <tt>tell_func</tt> should be set to NULL. If
+the seek function is non-NULL, libvorbisfile mandates the following
+behavior:
-libvorbisfile expects the following behavior:
<ul>
<li>The seek function must always return -1 (failure) if the given
data abstraction is not seekable. It may choose to always return -1
@@ -73,15 +77,17 @@
The close function should deallocate any access state used by the
passed in instance of the data access abstraction and invalidate the
-instance handle. The close function is assumed to succeed.<p>
+instance handle. The close function is assumed to succeed; its return
+code is not checked.<p>
-One common use of callbacks and the close function is to change the
-behavior of libvorbisfile with respect to file closure for applications
-that <em>must</em> <tt>fclose</tt> data files themselves. By passing
-the normal stdio calls as callback functions, but passing a
-<tt>close_func</tt> that does nothing, an application may call <a
-href="ov_clear.html">ov_clear()</a> and then <tt>fclose()</tt> the
-file originally passed to libvorbisfile.
+The <tt>close_func</tt> may be set to NULL to indicate that libvorbis
+should not attempt to close the file/data handle in <a
+href="ov_clear.html">ov_clear</a> but allow the application to handle
+file/data access cleanup itself. For example, by passing the normal
+stdio calls as callback functions, but passing a <tt>close_func</tt>
+that is NULL or does nothing (as in the case of OV_CALLBACKS_NOCLOSE), an
+application may call <a href="ov_clear.html">ov_clear()</a> and then
+later <tt>fclose()</tt> the file originally passed to libvorbisfile.
<h2>Tell function</h2>
@@ -94,17 +100,19 @@
not an error.<p>
The tell function need not be provided if the data IO abstraction is
-not seekable.<p>
+not seekable, or the application wishes to force streaming
+behavior. In this case, the <tt>tell_func</tt> and <tt>seek_func</tt>
+fields should be set to NULL.<p>
<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/chaining_example_c.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/chaining_example_c.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/chaining_example_c.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -31,8 +31,12 @@
OggVorbis_File ov;
int i;
+<font color="#A020F0">#ifdef _WIN32</font> <font color="#B22222">/* We need to set stdin to binary mode on windows. */</font>
+ _setmode( _fileno( stdin ), _O_BINARY );
+<font color="#A020F0">#endif</font>
+
<font color="#B22222">/* open the file/pipe on stdin */</font>
- <font color="#4169E1">if</font>(ov_open(stdin,&ov,NULL,-1)<0){
+ <font color="#4169E1">if</font>(ov_open_callbacks(stdin,&ov,NULL,-1,OV_CALLBACKS_NOCLOSE)<0){
printf(<font color="#666666">"Could not open input as an OggVorbis file.\n\n"</font>);
exit(1);
}
@@ -73,11 +77,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2004 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/chainingexample.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/chainingexample.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/chainingexample.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -50,16 +50,33 @@
</tr>
</table>
-<p><a href="ov_open.html">ov_open()</a> must be
-called to initialize the <a href="OggVorbis_File.html">OggVorbis_File</a> structure with default values.
-<a href="ov_open.html">ov_open()</a> also checks to ensure that we're reading Vorbis format and not something else.
+<p>This example takes its input on stdin which is in 'text' mode by default under Windows; this will corrupt the input data unless set to binary mode. This applies only to Windows.
+<br><br>
+<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>
+#ifdef _WIN32 /* We need to set stdin to binary mode under Windows */
+ _setmode( _fileno( stdin ), _O_BINARY );
+#endif
+</b></pre>
+ </td>
+</tr>
+</table>
+<p>We call <a href="ov_open_callbacks.html">ov_open_callbacks()</a> to
+initialize the <a href="OggVorbis_File.html">OggVorbis_File</a>
+structure. <a href="ov_open_callbacks.html">ov_open_callbacks()</a>
+also checks to ensure that we're reading Vorbis format and not
+something else. The OV_CALLBACKS_NOCLOSE callbacks instruct
+libvorbisfile not to close stdin later during cleanup.<p>
+
<br><br>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
<pre><b>
- if(ov_open(stdin,&ov,NULL,-1)>0){
+ if(ov_open_callbacks(stdin,&ov,NULL,-1,OV_CALLBACKS_NOCLOSE)<0){
printf("Could not open input as an OggVorbis file.\n\n");
exit(1);
}
@@ -145,11 +162,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2004 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/crosslap.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/crosslap.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/crosslap.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -54,7 +54,7 @@
reasons described above.
<p>Frame lapping, like Vorbis performs internally during continuous
-playback, is necessary to eliminate that last epislon of trouble.
+playback, is necessary to eliminate that last epsilon of trouble.
<h1>Easiest Crosslap</h1>
@@ -108,11 +108,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/datastructures.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/datastructures.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/datastructures.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -48,11 +48,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/decoding.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/decoding.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/decoding.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -20,9 +20,10 @@
<p>
After <a href="initialization.html">initialization</a>, decoding audio
-is as simple as calling <a href="ov_read.html">ov_read()</a>. This
-function works similarly to reading from a normal file using
-<tt>read()</tt>.<p>
+is as simple as calling <a href="ov_read.html">ov_read()</a> (or the
+similar functions <a href="ov_read_float.html">ov_read_float()</a> and
+<a href="ov_read_filter.html">ov_read_filter</a>). This function works
+similarly to reading from a normal file using <tt>read()</tt>.<p>
However, a few differences are worth noting:
@@ -61,23 +62,28 @@
<td><a href="ov_read.html">ov_read</a></td>
<td>This function makes up the main chunk of a decode loop. It takes an
OggVorbis_File structure, which must have been initialized by a previous
-call to <a href="ov_open.html"><tt>ov_open()</tt></a>.</td>
+call to <a href="ov_open.html"><tt>ov_open()</tt></a>, <a href="ov_fopen.html"><tt>ov_fopen()</tt></a>,
+or <a href="ov_open_callbacks.html"><tt>ov_open_callbacks()</tt></a>.</td>
</tr>
<tr valign=top>
<td><a href="ov_read_float.html">ov_read_float</a></td>
<td>This function decodes to floats instead of integer samples.</td>
</tr>
+<tr valign=top>
+ <td><a href="ov_read_filter.html">ov_read_filter</a></td>
+ <td>This function works like <a href="ov_read.html">ov_read</a>, but passes the PCM data through the provided filter before converting to integer sample data.</td>
+</tr>
</table>
<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/example.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/example.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/example.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -87,16 +87,19 @@
</tr>
</table>
-<p><a href="ov_open.html">ov_open()</a> must be
-called to initialize the <b>OggVorbis_File</b> structure with default values.
-<a href="ov_open.html">ov_open()</a> also checks to ensure that we're reading Vorbis format and not something else.
+<p>We call <a href="ov_open_callbacks.html">ov_open_callbacks()</a> to
+initialize the <b>OggVorbis_File</b> structure with default values.
+<a href="ov_open_callbacks.html">ov_open_callbacks()</a> also checks
+to ensure that we're reading Vorbis format and not something else. The
+OV_CALLBACKS_NOCLOSE callbacks instruct libvorbisfile not to close
+stdin later during cleanup.
<br><br>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
<pre><b>
- if(ov_open(stdin, &vf, NULL, 0) < 0) {
+ if(ov_open_callbacks(stdin, &vf, NULL, 0, OV_CALLBACKS_NOCLOSE) < 0) {
fprintf(stderr,"Input does not appear to be an Ogg bitstream.\n");
exit(1);
}
@@ -192,11 +195,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/exampleindex.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/exampleindex.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/exampleindex.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -26,11 +26,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/fileinfo.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/fileinfo.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/fileinfo.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -82,11 +82,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/index.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/index.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/index.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -36,11 +36,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/initialization.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/initialization.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/initialization.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,24 +9,35 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
<H1>Setup/Teardown</h1> <p>In order to decode audio using
libvorbisfile, a bitstream containing Vorbis audio must be properly
initialized before decoding and cleared when decoding is finished.
-The simplest possible case is to use <tt>fopen()</tt> to open a Vorbis
-file and then pass the <tt>FILE *</tt> to an <a
-href="ov_open.html">ov_open()</a> call. A successful <a
+The simplest possible case is to use <a
+href="ov_fopen.html">ov_fopen()</a> to open the file for access, check
+it for Vorbis content, and prepare it for playback. A successful <a
href="return.html">return code</a> from <a
-href="ov_open.html">ov_open()</a> indicates the file is ready for use.
+href="ov_fopen.html">ov_fopen()</a> indicates the file is ready for use.
Once the file is no longer needed, <a
href="ov_clear.html">ov_clear()</a> is used to close the file and
-deallocate decoding resources. </b>Do not</b> call <tt>fclose()</tt> on the
-file; libvorbisfile does this in the <a
-href="ov_clear.html">ov_clear()</a> call.
+deallocate decoding resources.<p>
+On systems other than Windows<a href="ov_open.html#winfoot">[a]</a>, an
+application may also open a file itself using <tt>fopen()</tt>, then pass the
+<tt>FILE *</tt> to libvorbisfile using <a
+href="ov_open.html">ov_open()</a>. </b>Do not</b> call
+<tt>fclose()</tt> on a file handle successfully submitted to <a
+href="ov_open.html">ov_open()</a>; libvorbisfile does this in the <a
+href="ov_clear.html">ov_clear()</a> call.<p>
+
+An application that requires more setup flexibility may open a data
+stream using <a href="ov_open_callbacks.html">ov_open_callbacks()</a>
+to change default libvorbis behavior or specify non-stdio data access
+mechanisms.<p>
+
<p>
All libvorbisfile initialization and deallocation routines are declared in "vorbis/vorbisfile.h".
<p>
@@ -37,13 +48,18 @@
<td><b>purpose</b></td>
</tr>
<tr valign=top>
- <td><a href="ov_open.html">ov_open</a></td>
- <td>Initializes the Ogg Vorbis bitstream with a pointer to a bitstream and default values. This must be called before other functions in the library may be
+ <td><a href="ov_fopen.html">ov_fopen</a></td>
+ <td>Opens a file and initializes the Ogg Vorbis bitstream with default values. This must be called before other functions in the library may be
used.</td>
</tr>
<tr valign=top>
+ <td><a href="ov_open.html">ov_open</a></td>
+ <td>Initializes the Ogg Vorbis bitstream with default values from a passed in file handle. This must be called before other functions in the library may be
+ used. <a href="#winfoot"><em>Do not use this call under Windows [a];</em></a> Use <a href="ov_fopen.html">ov_fopen()</a> or <a href="ov_open_callbacks.html">ov_open_callbacks()</a> instead.</td>
+</tr>
+<tr valign=top>
<td><a href="ov_open_callbacks.html">ov_open_callbacks</a></td>
- <td>Initializes the Ogg Vorbis bitstream with a pointer to a bitstream, default values, and custom file/bitstream manipulation routines. Used instead of <a href="ov_open.html">ov_open()</a> when working with other than stdio based I/O.</td>
+ <td>Initializes the Ogg Vorbis bitstream from a file handle and custom file/bitstream manipulation routines. Used instead of <a href="ov_open.html">ov_open()</a> or <a href="ov_fopen.html">ov_fopen()</a> when altering or replacing libvorbis's default stdio I/O behavior, or when a bitstream must be initialized from a <tt>FILE *</tt> under Windows.</td>
</tr>
<tr valign=top>
@@ -86,13 +102,14 @@
<br><br>
<hr noshade>
+
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_bitrate.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_bitrate.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_bitrate.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -59,11 +59,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_bitrate_instant.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_bitrate_instant.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_bitrate_instant.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -52,11 +52,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_callbacks.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_callbacks.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_callbacks.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -23,11 +23,13 @@
<p>
The ov_callbacks structure does not need to be user-defined if you are
working with stdio-based file manipulation; the <a
-href="ov_open.html">ov_open()</a> call provides default callbacks for
+href="ov_fopen.html">ov_fopen()</a> and <a
+href="ov_open.html">ov_open()</a> calls internally provide default callbacks for
stdio. ov_callbacks are defined and passed to <a
href="ov_open_callbacks.html">ov_open_callbacks()</a> when
implementing non-stdio based stream manipulation (such as playback
-from a memory buffer).
+from a memory buffer) or when <a
+href="ov_open.html#winfoot">ov_open()-style initialization from a <tt>FILE *</tt> is required under Windows [a]</a>.
<p>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
@@ -48,15 +50,52 @@
<dt><i>read_func</i></dt>
<dd>Pointer to custom data reading function.</dd>
<dt><i>seek_func</i></dt>
-<dd>Pointer to custom data seeking function. If the data source is not seekable (or the application wants the data source to be treated as unseekable at all times), the provided seek callback should always return -1 (failure).</dd>
+<dd>Pointer to custom data seeking function. If the data source is not seekable (or the application wants the data source to be treated as unseekable at all times), the provided seek callback should always return -1 (failure) or the <tt>seek_func</tt> and <tt>tell_func</tt> fields should be set to NULL.</dd>
<dt><i>close_func</i></dt>
-<dd>Pointer to custom data source closure function.</dd>
+<dd>Pointer to custom data source closure function. Set to NULL if libvorbisfile should not attempt to automatically close the file/data handle.</dd>
<dt><i>tell_func</i></dt>
-<dd>Pointer to custom data location function.</dd>
+<dd>Pointer to custom data location function. If the data source is not seekable (or the application wants the data source to be treated as unseekable at all times), the provided tell callback should always return -1 (failure) or the <tt>seek_func</tt> and <tt>tell_func</tt> fields should be set to NULL.</dd>
</dl>
<p>
+<h3>Predefined callbacks</h3>
+The header vorbis/vorbisfile.h provides several predefined static ov_callbacks structures that may be passed to <a
+href="ov_open_callbacks.html">ov_open_callbacks()</a>:
+<dl>
+<dt><tt>OV_CALLBACKS_DEFAULT</tt><dd>
+
+These callbacks provide the same behavior as used internally by <a
+href="ov_fopen.html">ov_fopen()</a> and <a
+href="ov_open.html">ov_open()</a>.
+
+<dt><tt>OV_CALLBACKS_NOCLOSE</tt><dd>
+
+The same as <tt>OV_CALLBACKS_DEFAULT</tt>, but with the
+<tt>close_func</tt> field set to NULL. The most typical use would be
+to use <a href="ov_open_callbacks.html">ov_open_callbacks()</a> to
+provide the same behavior as <a href="ov_open.html">ov_open()</a>, but
+not close the file/data handle in <a
+href="ov_clear.html">ov_clear()</a>.
+
+<dt><tt>OV_CALLBACKS_STREAMONLY</tt><dd>
+
+A set of callbacks that set <tt>seek_func</tt> and <tt>tell_func</tt>
+to NULL, thus forcing strict streaming-only behavior regardless of
+whether or not the input is actually seekable.
+
+<dt><tt>OV_CALLBACKS_STREAMONLY_NOCLOSE</tt><dd>
+
+The same as <tt>OV_CALLBACKS_STREAMONLY</tt>, but with
+<tt>close_func</tt> also set to null, preventing libvorbisfile from
+attempting to close the file/data handle in <a
+href="ov_clear.html">ov_clear()</a>.
+
+</dl>
+<p>
+
+<h3>Examples and usage</h3>
+
See <a href="callbacks.html">the callbacks and non-stdio I/O document</a> for more
detailed information on required behavior of the various callback
functions.<p>
@@ -65,11 +104,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_clear.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_clear.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_clear.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -17,8 +17,8 @@
<p><i>declared in "vorbis/vorbisfile.h";</i></p>
-<p> After a bitstream has been opened using <a href="ov_open.html">ov_open()</a>/<a href="ov_open_callbacks.html">ov_open_callbacks()</a> and decoding is complete, the application must call <tt>ov_clear()</tt> to clear
-the decoder's buffers. <tt>ov_clear()</tt> will also close the file.<p>
+<p> After a bitstream has been opened using <a href="ov_fopen.html">ov_fopen()</a>/<a href="ov_open.html">ov_open()</a>/<a href="ov_open_callbacks.html">ov_open_callbacks()</a> and decoding is complete, the application must call <tt>ov_clear()</tt> to clear
+the decoder's buffers. <tt>ov_clear()</tt> will also close the file unless it was opened using <a href="ov_open_callbacks.html">ov_open_callbacks()</a> with the <tt>close_func</tt> callback set to NULL.<p>
<tt>ov_clear()</tt> must also be called after a successful call to <a href="ov_test.html">ov_test()</a> or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>.<p>
@@ -37,7 +37,7 @@
<dl>
<dt><i>vf</i></dt>
<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
-functions. After <tt>ov_clear</tt> has been called, the structure is deallocated and can no longer be used.</dd>
+functions. After <tt>ov_clear</tt> has been called, the contents of this structure are deallocated, and it can no longer be used without being reinitialized by a call to <a href="ov_fopen.html">ov_fopen()</a>, <a href="ov_open.html">ov_open()</a> or <a href="ov_open_callbacks.html">ov_open_callbacks()</a>.</dd>
</dl>
@@ -51,11 +51,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_comment.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_comment.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_comment.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -10,7 +10,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -53,11 +53,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_crosslap.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_crosslap.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_crosslap.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -87,11 +87,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_info.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_info.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_info.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -51,11 +51,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_open.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_open.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_open.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -17,29 +17,46 @@
<p><i>declared in "vorbis/vorbisfile.h";</i></p>
-<p>This is the main function used to open and initialize an OggVorbis_File
-structure. It sets up all the related decoding structure.
+<p>ov_open is one of three initialization functions used to initialize
+an OggVorbis_File structure and prepare a bitstream for playback.
+
+<p><em><b> WARNING for Windows developers: </b> Do not use ov_open() in
+Windows applications; Windows linking places restrictions on
+passing <tt>FILE *</tt> handles successfully, and ov_open() runs
+afoul of these restrictions <a href="#winfoot">[a]</a>. See the <a
+href="ov_open_callbacks.html">ov_open_callbacks() page </a> for
+details on using <a
+href="ov_open_callbacks.html">ov_open_callbacks()</a> instead. </em>
+
<p>The first argument must be a file pointer to an already opened file
or pipe (it need not be seekable--though this obviously restricts what
can be done with the bitstream). <tt>vf</tt> should be a pointer to the
-OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
+OggVorbis_File structure -- this is used for ALL the externally visible libvorbisfile
functions. Once this has been called, the same <a href="OggVorbis_File.html">OggVorbis_File</a>
-struct should be passed to all the libvorbisfile functions.
-<p>Also, you should be aware that ov_open(), once successful, takes complete possession of the file resource. After you have opened a file using ov_open(), you MUST close it using <a href="ov_clear.html">ov_clear()</a>, not fclose() or any other function.
-<p>
-It is often useful to call <tt>ov_open()</tt>
-simply to determine whether a given file is a vorbis bitstream. If the
-<tt>ov_open()</tt>
-call fails, then the file is not recognizable as such.
-When you use <tt>ov_open()
-</tt>for
-this, you should <tt>fclose()</tt> the file pointer if, and only if, the
-<tt>ov_open()</tt>
-call fails. If it succeeds, you must call <a href="ov_clear.html">ov_clear()</a> to clear
-the decoder's buffers and close the file for you.<p>
+struct should be passed to all the libvorbisfile functions.<p>
-(Note that <a href="ov_test.html">ov_test()</a> provides a less expensive way to test a file for Vorbisness.)<p>
+The <tt>vf</tt> structure initialized using ov_fopen() must eventually
+be cleaned using <a href="ov_clear.html">ov_clear()</a>. Once a
+<tt>FILE *</tt> handle is passed to ov_open() successfully, the
+application MUST NOT <tt>fclose()</tt> or in any other way manipulate
+that file handle. Vorbisfile will close the file in <a
+href="ov_clear.html">ov_clear()</a>. If the application must be able
+to close the <tt>FILE *</tt> handle itself, see <a
+href="ov_open_callbacks.html">ov_open_callbacks()</a> with the use of
+<tt>OV_CALLBACKS_NOCLOSE</tt>.
+<p>It is often useful to call <tt>ov_open()</tt> simply to determine
+whether a given file is a Vorbis bitstream. If the <tt>ov_open()</tt>
+call fails, then the file is not recognizable as Vorbis. If the call
+succeeds but the initialized <tt>vf</tt> structure will not be used,
+the application is responsible for calling <a
+href="ov_clear.html">ov_clear()</a> to clear the decoder's buffers and
+close the file.<p>
+
+If [and only if] an <tt>ov_open()</tt> call fails, the application
+must explicitly <tt>fclose()</tt> the <tt>FILE *</tt> pointer itself.
+
+
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
@@ -87,26 +104,77 @@
</blockquote>
<p>
+<a name="notes"></a>
<h3>Notes</h3>
-<p>If your decoder is threaded, it is recommended that you NOT call
+<dl>
+
+<a name="winfoot"></a>
+<dt><b>[a] Windows and ov_open()</b><p>
+
+<dd>Under Windows, stdio file access is implemented in each of many
+variants of crt.o, several of which are typically installed on any one
+Windows machine. If libvorbisfile and the application using
+libvorbisfile are not linked against the exact same
+version/variant/build of crt.o (and they usually won't be, especially
+using a prebuilt libvorbis DLL), <tt>FILE *</tt> handles cannot be
+opened in the application and then passed to vorbisfile to be used
+by stdio calls from vorbisfile's different version of CRT. For this
+reason, using <a href="ov_open.html">ov_open()</a> under Windows
+without careful, expert linking will typically cause a protection
+fault. Windows programmers should use <a
+href="ov_fopen.html">ov_fopen()</a> (which will only use libvorbis's
+crt.o) or <a href="ov_open_callbacks.html">ov_open_callbacks()</a>
+(which will only use the application's crt.o) instead.<p>
+
+This warning only applies to Windows and only applies to <a
+href="ov_open.html">ov_open()</a>. It is perfectly safe to use <a
+href="ov_open.html">ov_open()</a> on all other platforms.<p>
+
+For more information, see the following microsoft pages on <a
+href="http://msdn2.microsoft.com/en-us/library/abx4dbyh(VS.80).aspx">C
+runtime library linking</a> and a specific description of <a
+href="http://msdn2.microsoft.com/en-us/library/ms235460(VS.80).aspx">restrictions
+on passing CRT objects across DLL boundaries</a>.
+
+<p>
+
+<dt><b>[b] Threaded decode</b><p>
+<dd>If your decoder is threaded, it is recommended that you NOT call
<tt>ov_open()</tt>
-in the main control thread--instead, call <tt>ov_open()</tt> IN your decode/playback
+in the main control thread--instead, call <tt>ov_open()</tt> in your decode/playback
thread. This is important because <tt>ov_open()</tt> may be a fairly time-consuming
call, given that the full structure of the file is determined at this point,
which may require reading large parts of the file under certain circumstances
(determining all the logical bitstreams in one physical bitstream, for
example). See <a href="threads.html">Thread Safety</a> for other information on using libvorbisfile with threads.
+<p>
+<dt><b>[c] Mixed media streams</b><p>
+<dd>
+As of Vorbisfile release 1.2.0, Vorbisfile is able to access the
+Vorbis content in mixed-media Ogg streams, not just Vorbis-only
+streams. For example, Vorbisfile may be used to open and access the
+audio from an Ogg stream consisting of Theora video and Vorbis audio.
+Vorbisfile 1.2.0 decodes the first logical audio stream of each
+physical stream section.<p>
+<dt><b>[d] Faster testing for Vorbis files</b><p>
+<dd><a href="ov_test.html">ov_test()</a> and <a
+href="ov_test_callbacks.html">ov_test_callbacks()</a> provide less
+computationally expensive ways to test a file for Vorbisness, but
+require more setup code.<p>
+
+</dl>
+
<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_open_callbacks.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_open_callbacks.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_open_callbacks.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -17,23 +17,29 @@
<p><i>declared in "vorbis/vorbisfile.h";</i></p>
-<p>This is an alternative function used to open and initialize an OggVorbis_File
-structure when using a data source other than a file. It allows you to specify custom file manipulation routines and sets up all the related decoding structure.
-<p>Once this has been called, the same <tt>OggVorbis_File</tt>
-struct should be passed to all the libvorbisfile functions.
-<p>
-It is often useful to call <tt>ov_open_callbacks()</tt>
-simply to determine whether a given stream is a vorbis bitstream. If the
-<tt>ov_open_callbacks()</tt>
-call fails, then the data is not recognizable as such. When you use <tt>ov_open_callbacks()
-</tt>for
-this, you should close or otherwise deallocate your <tt>datasource</tt> if, and only if, the
-<tt>ov_open_callbacks()</tt>
-call fails. If it succeeds, you must call <a href=ov_clear.html>ov_clear()</a> to clear
-the decoder's buffers and call your close callback.<p>
+<p>This is an alternative function used to open and initialize an
+OggVorbis_File structure when using a data source other than a file,
+when its necessary to modify default file access behavior, or to
+initialize a Vorbis decode from a <tt>FILE *</tt> pointer under
+Windows where <a href="ov_open.html">ov_open()</a> cannot be used. It
+allows the application to specify custom file manipulation routines
+and sets up all the related decoding structures.
-See also <a href="callbacks.html">Callbacks and Non-stdio I/O</a> for information on designing and specifying the required callback functions.<p>
+<p>Once ov_open_callbacks() has been called, the same
+<tt>OggVorbis_File</tt> struct should be passed to all the
+libvorbisfile functions. Unlike <a
+href="ov_fopen.html">ov_fopen()</a> and <a
+href="ov_open.html">ov_open()</a>, ov_open_callbacks() may be used to
+instruct vorbisfile to either automatically close or not to close the
+file/data access handle in <a href="ov_clear.html">ov_clear()</a>.
+Automatic closure is disabled by passing NULL as the close callback,
+or using one of the predefined callback sets that specify a NULL close
+callback. The application is responsible for closing a file when a
+call to ov_open_callbacks() is unsuccessful.<p>
+See also <a href="callbacks.html">Callbacks and Non-stdio I/O</a> for
+information on designing and specifying custom callback functions.<p>
+
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
@@ -62,7 +68,7 @@
read from the stream and the stream is not seekable. In this case, <tt>ibytes</tt>
should contain the length (in bytes) of the buffer. Used together with <tt>initial</tt>.</dd>
<dt><i>callbacks</i></dt>
-<dd>A completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd>
+<dd>A completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines. vorbisfile.h defines several preprovided callback sets; see <a href="ov_callbacks.html">ov_callbacks</a> for details.</dd>
</dl>
@@ -72,7 +78,7 @@
<li>less than zero for failure:</li>
<ul>
<li>OV_EREAD - A read from media returned an error.</li>
-<li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
+<li>OV_ENOTVORBIS - Bitstream does not contain any Vorbis data.</li>
<li>OV_EVERSION - Vorbis version mismatch.</li>
<li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
@@ -81,25 +87,58 @@
<p>
<h3>Notes</h3>
-<p>If your decoder is threaded, it is recommended that you NOT call
+<dl>
+
+<dt><b>[a] Windows and use as an ov_open() substitute</b><p> Windows
+applications should not use <a href="ov_open.html">ov_open()</a> due
+to the likelihood of <a href="ov_open.html#winfoot">CRT linking
+mismatches and runtime protection faults
+[ov_open:a]</a>. ov_open_callbacks() is a safe substitute; specifically:
+
+<pre><tt>ov_open_callbacks(f, vf, initial, ibytes, OV_CALLBACKS_DEFAULT);</tt>
+</pre>
+
+... provides exactly the same functionality as <a
+href="ov_open.html">ov_open()</a> but will always work correctly under
+Windows, regardless of linking setup details.<p>
+
+<dt><b>[b] Threaded decode</b><p>
+<dd>If your decoder is threaded, it is recommended that you NOT call
<tt>ov_open_callbacks()</tt>
-in the main control thread--instead, call <tt>ov_open_callbacks()</tt> IN your decode/playback
+in the main control thread--instead, call <tt>ov_open_callbacks()</tt> in your decode/playback
thread. This is important because <tt>ov_open_callbacks()</tt> may be a fairly time-consuming
call, given that the full structure of the file is determined at this point,
which may require reading large parts of the file under certain circumstances
(determining all the logical bitstreams in one physical bitstream, for
-example).
-See <a href="threads.html">Thread Safety</a> for other information on using libvorbisfile with threads.
+example). See <a href="threads.html">Thread Safety</a> for other information on using libvorbisfile with threads.
+<p>
+<dt><b>[c] Mixed media streams</b><p>
+<dd>
+As of Vorbisfile release 1.2.0, Vorbisfile is able to access the
+Vorbis content in mixed-media Ogg streams, not just Vorbis-only
+streams. For example, Vorbisfile may be used to open and access the
+audio from an Ogg stream consisting of Theora video and Vorbis audio.
+Vorbisfile 1.2.0 decodes the first logical audio stream of each
+physical stream section.<p>
+
+<dt><b>[d] Faster testing for Vorbis files</b><p>
+<dd><a href="ov_test.html">ov_test()</a> and <a
+href="ov_test_callbacks.html">ov_test_callbacks()</a> provide less
+computationally expensive ways to test a file for Vorbisness, but
+require more setup code.<p>
+
+</dl>
+
<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -70,11 +70,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_lap.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_lap.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_lap.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -90,11 +90,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_page.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_page.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_page.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -71,11 +71,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -99,11 +99,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_tell.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_tell.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_tell.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -50,11 +50,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_total.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_total.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_pcm_total.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -54,11 +54,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_seek.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_seek.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_seek.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -70,11 +70,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_seek_lap.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_seek_lap.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_seek_lap.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -97,11 +97,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_tell.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_tell.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_tell.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -17,8 +17,10 @@
<p><i>declared in "vorbis/vorbisfile.h";</i></p>
-<p>Returns the current offset in raw compressed bytes.
+<p>Returns the current offset in raw compressed bytes.</p>
+<p>Note that if you later use ov_raw_seek() to return to this point, you won't generally get back to exactly the same place, due to internal buffering. Also note that a read operation may not cause a change to the current raw offset - only a read that requires reading more data from the underlying data source will do that.</p>
+
<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
@@ -50,11 +52,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_total.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_total.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_raw_total.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -55,11 +55,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_read.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_read.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_read.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -84,6 +84,10 @@
<dt>OV_EBADLINK</dt>
<dd>indicates that an invalid stream section was supplied to
libvorbisfile, or the requested link is corrupt.</dd>
+<dt>OV_EINVAL</dt>
+ <dd>indicates the initial file headers couldn't be read or
+ are corrupt, or that the initial open call for <i>vf</i>
+ failed.</dd>
<dt>0</dt>
<dd>indicates EOF</dd>
<dt><i>n</i></dt>
@@ -110,11 +114,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_read_float.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_read_float.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_read_float.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -60,6 +60,10 @@
<dt>OV_EBADLINK</dt>
<dd>indicates that an invalid stream section was supplied to
libvorbisfile, or the requested link is corrupt.</dd>
+<dt>OV_EINVAL</dt>
+ <dd>indicates the initial file headers couldn't be read or
+ are corrupt, or that the initial open call for <i>vf</i>
+ failed.</dd>
<dt>0</dt>
<dd>indicates EOF</dd>
<dt><i>n</i></dt>
@@ -88,7 +92,7 @@
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_seekable.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_seekable.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_seekable.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -50,11 +50,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_serialnumber.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_serialnumber.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_serialnumber.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -54,11 +54,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_streams.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_streams.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_streams.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -51,11 +51,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -19,11 +19,21 @@
<p>
This partially opens a vorbis file to test for Vorbis-ness. It loads
-the headers for the first chain, and tests for seekability (but does not seek).
+the headers for the first chain and tests for seekability (but does not seek).
Use <a href="ov_test_open.html">ov_test_open()</a> to finish opening the file
or <a href="ov_clear.html">ov_clear</a> to close/free it.
<p>
+<p><em><b> WARNING for Windows developers: </b> Do not use ov_test()
+in Windows applications; Windows linking places restrictions on
+passing <tt>FILE *</tt> handles successfully, and ov_test() runs afoul
+of these restrictions <a href="#winfoot">[a]</a> in exactly the same
+way as <a href="ov_open.html">ov_open()</a>. See the <a
+href="ov_test_callbacks.html">ov_test_callbacks() page </a> for
+details on using <a
+href="ov_test_callbacks.html">ov_test_callbacks()</a> instead. </em>
+<p>
+
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
@@ -62,7 +72,7 @@
<li>less than zero for failure:</li>
<ul>
<li>OV_EREAD - A read from media returned an error.</li>
-<li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
+<li>OV_ENOTVORBIS - Bitstream contains no Vorbis data.</li>
<li>OV_EVERSION - Vorbis version mismatch.</li>
<li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
@@ -70,17 +80,19 @@
</blockquote>
<p>
+<h3>Notes</h3>
+All the <a href="ov_open.html#notes">notes from ov_open()</a> apply to ov_test().
<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test_callbacks.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test_callbacks.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test_callbacks.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -18,7 +18,13 @@
<p><i>declared in "vorbis/vorbisfile.h";</i></p>
<p>This is an alternative function used to open and test an OggVorbis_File
-structure when using a data source other than a file. It allows you to specify custom file manipulation routines and sets up all the related decoding structures.
+structure when using a data source other than a file,
+when its necessary to modify default file access behavior, or to
+test for Vorbis content from a <tt>FILE *</tt> pointer under
+Windows where <a href="ov_open.html">ov_test()</a> cannot be used. It
+allows the application to specify custom file manipulation routines
+and sets up all the related decoding structures.
+
<p>Once this has been called, the same <tt>OggVorbis_File</tt>
struct should be passed to all the libvorbisfile functions.
<p>
@@ -52,7 +58,7 @@
read from the file and the stream is not seekable. In this case, <tt>ibytes</tt>
should contain the length (in bytes) of the buffer. Used together with <tt>initial</tt>.</dd>
<dt><i>callbacks</i></dt>
-<dd>A completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines.</dd>
+<dd>A completed <a href="ov_callbacks.html">ov_callbacks</a> struct which indicates desired custom file manipulation routines. vorbisfile.h defines several preprovided callback sets; see <a href="ov_callbacks.html">ov_callbacks</a> for details.</dd>
</dl>
@@ -62,7 +68,7 @@
<li>less than zero for failure:</li>
<ul>
<li>OV_EREAD - A read from media returned an error.</li>
-<li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
+<li>OV_ENOTVORBIS - Bitstream contains no Vorbis data.</li>
<li>OV_EVERSION - Vorbis version mismatch.</li>
<li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
@@ -70,18 +76,33 @@
</blockquote>
<p>
+<h3>Notes</h3>
+<dl>
+<dt><b>[a] Windows and use as an ov_test() substitute</b><p> Windows
+applications should not use <a href="ov_test.html">ov_test()</a> due
+to the likelihood of <a href="ov_open.html#winfoot">CRT linking
+mismatches and runtime protection faults
+[ov_open:a]</a>. ov_test_callbacks() is a safe substitute; specifically:
+<pre><tt>ov_test_callbacks(f, vf, initial, ibytes, OV_CALLBACKS_DEFAULT);</tt>
+</pre>
+... provides exactly the same functionality as <a
+href="ov_test.html">ov_test()</a> but will always work correctly under
+Windows, regardless of linking setup details.<p>
+
+</dl>
+
<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test_open.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test_open.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_test_open.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -62,11 +62,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -69,11 +69,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_lap.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_lap.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_lap.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -92,11 +92,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_page.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_page.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_page.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -70,11 +70,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_page_lap.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_page_lap.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_seek_page_lap.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -99,11 +99,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_tell.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_tell.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_tell.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -50,11 +50,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_total.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_total.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/ov_time_total.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -54,11 +54,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/overview.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/overview.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/overview.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -47,11 +47,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/reference.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/reference.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/reference.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -23,6 +23,7 @@
<a href="ov_callbacks.html">ov_callbacks</a><br>
<br>
<b>Setup/Teardown</b><br>
+<a href="ov_fopen.html">ov_fopen()</a><br>
<a href="ov_open.html">ov_open()</a><br>
<a href="ov_open_callbacks.html">ov_open_callbacks()</a><br>
<a href="ov_clear.html">ov_clear()</a><br>
@@ -33,6 +34,7 @@
<b>Decoding</b><br>
<a href="ov_read.html">ov_read()</a><br>
<a href="ov_read_float.html">ov_read_float()</a><br>
+<a href="ov_read_filter.html">ov_read_filter()</a><br>
<a href="ov_crosslap.html">ov_crosslap()</a><br>
<br>
<b>Seeking</b><br>
@@ -69,11 +71,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/return.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/return.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/return.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -64,11 +64,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seekexample.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seekexample.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seekexample.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -32,7 +32,6 @@
#include <stdio.h>
#include "vorbis/codec.h"
#include "vorbis/vorbisfile.h"
-#include "../lib/misc.h"
</b></pre>
</td>
</tr>
@@ -52,16 +51,30 @@
</tr>
</table>
-<p><a href="ov_open.html">ov_open()</a> must be
+<p>This example takes its input on stdin which is in 'text' mode by default under Windows; this will corrupt the input data unless set to binary mode. This applies only to Windows.
+<br><br>
+<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>
+#ifdef _WIN32 /* We need to set stdin to binary mode under Windows */
+ _setmode( _fileno( stdin ), _O_BINARY );
+#endif
+</b></pre>
+ </td>
+</tr>
+</table>
+
+<p><a href="ov_open_callbacks.html">ov_open()</a> must be
called to initialize the <a href="OggVorbis_File.html">OggVorbis_File</a> structure with default values.
-<a href="ov_open.html">ov_open()</a> also checks to ensure that we're reading Vorbis format and not something else.
+<a href="ov_open_callbacks.html">ov_open_callbacks()</a> also checks to ensure that we're reading Vorbis format and not something else.
<br><br>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
<pre><b>
- if(ov_open(stdin,&ov,NULL,-1)<0){
+ if(ov_open_callbacks(stdin,&ov,NULL,-1, OV_CALLBACKS_NOCLOSE)<0){
printf("Could not open input as an OggVorbis file.\n\n");
exit(1);
}
@@ -126,11 +139,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -94,11 +94,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking_example_c.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking_example_c.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking_example_c.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -28,14 +28,17 @@
#include <stdio.h>
#include "vorbis/codec.h"
#include "vorbis/vorbisfile.h"
-#include "../lib/misc.h"
int main(){
OggVorbis_File ov;
int i;
+#ifdef _WIN32 /* We need to set stdin to binary mode under Windows */
+ _setmode( _fileno( stdin ), _O_BINARY );
+#endif
+
/* open the file/pipe on stdin */
- if(ov_open(stdin,&ov,NULL,-1)==-1){
+ if(ov_open_callbacks(stdin,&ov,NULL,-1,OV_CALLBACKS_NOCLOSE)==-1){
printf("Could not open input as an OggVorbis file.\n\n");
exit(1);
}
@@ -70,11 +73,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking_test_c.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking_test_c.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seeking_test_c.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -28,14 +28,17 @@
#include <stdio.h>
#include "vorbis/codec.h"
#include "vorbis/vorbisfile.h"
-#include "../lib/misc.h"
int main(){
OggVorbis_File ov;
int i;
+#ifdef _WIN32 /* We need to set stdin to binary mode under Windows */
+ _setmode( _fileno( stdin ), _O_BINARY );
+#endif
+
/* open the file/pipe on stdin */
- if(ov_open(stdin,&ov,NULL,-1)==-1){
+ if(ov_open_callbacks(stdin,&ov,NULL,-1,OV_CALLBACKS_NOCLOSE)==-1){
printf("Could not open input as an OggVorbis file.\n\n");
exit(1);
}
@@ -70,11 +73,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seekingexample.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seekingexample.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/seekingexample.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -80,23 +80,22 @@
#ifdef _WIN32
_setmode( _fileno( stdin ), _O_BINARY );
- _setmode( _fileno( stdout ), _O_BINARY );
#endif
</b></pre>
</td>
</tr>
</table>
-<p><a href="ov_open.html">ov_open()</a> must be
+<p><a href="ov_open_callbacks.html">ov_open_callbacks()</a> must be
called to initialize the <b>OggVorbis_File</b> structure with default values.
-<a href="ov_open.html">ov_open()</a> also checks to ensure that we're reading Vorbis format and not something else.
+<a href="ov_open_callbacks.html">ov_open_callbacks()</a> also checks to ensure that we're reading Vorbis format and not something else.
<br><br>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
<pre><b>
- if(ov_open(stdin, &vf, NULL, 0) < 0) {
+ if(ov_open_callbacks(stdin, &vf, NULL, 0, OV_CALLBACKS_NOCLOSE) < 0) {
fprintf(stderr,"Input does not appear to be an Ogg bitstream.\n");
exit(1);
}
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/threads.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/threads.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/threads.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -37,11 +37,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbis_comment.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbis_comment.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbis_comment.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -57,11 +57,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbis_info.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbis_info.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbis_info.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -67,11 +67,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbisfile_example_c.html
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbisfile_example_c.html 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/vorbisfile/vorbisfile_example_c.html 2008-06-13 23:59:37 UTC (rev 15029)
@@ -9,7 +9,7 @@
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
@@ -46,7 +46,7 @@
_setmode( _fileno( stdout ), _O_BINARY );
#endif
- if(ov_open(stdin, &vf, NULL, 0) < 0) {
+ if(ov_open_callbacks(stdin, &vf, NULL, 0, OV_CALLBACKS_NOCLOSE) < 0) {
fprintf(stderr,"Input does not appear to be an Ogg bitstream.\n");
exit(1);
}
@@ -93,11 +93,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2003 Xiph.org</p></td>
+<td><p class=tiny>copyright © 2007 Xiph.org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
</tr>
</table>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/04-codec.xml
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/04-codec.xml 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/04-codec.xml 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,7 +7,7 @@
<section id="vorbis-spec-codec">
<sectioninfo>
<releaseinfo>
- $Id: 04-codec.xml 7186 2004-07-20 07:19:25Z xiphmont $
+ $Id: 04-codec.xml 10466 2005-11-28 00:34:44Z giles $
</releaseinfo>
</sectioninfo>
<title>Codec Setup and Packet Decode</title>
@@ -90,12 +90,14 @@
field especially may be considerably off in purely VBR streams. The
fields are meaningful only when greater than zero.</para>
+<para>
<itemizedlist>
<listitem><simpara>All three fields set to the same value implies a fixed rate, or tightly bounded, nearly fixed-rate bitstream</simpara></listitem>
<listitem><simpara>Only nominal set implies a VBR or ABR stream that averages the nominal bitrate</simpara></listitem>
<listitem><simpara>Maximum and or minimum set implies a VBR bitstream that obeys the bitrate limits</simpara></listitem>
<listitem><simpara>None set indicates the encoder does not care to speculate.</simpara></listitem>
</itemizedlist>
+</para>
</section>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/05-comment.xml
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/05-comment.xml 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/05-comment.xml 2008-06-13 23:59:37 UTC (rev 15029)
@@ -8,7 +8,7 @@
<section id="vorbis-spec-comment">
<sectioninfo>
<releaseinfo>
- $Id: 05-comment.xml 7186 2004-07-20 07:19:25Z xiphmont $
+ $Id: 05-comment.xml 11703 2006-07-17 16:33:17Z giles $
</releaseinfo>
</sectioninfo>
<title>comment field and header specification</title>
@@ -47,8 +47,8 @@
is limited to 2^32-1 bytes. The vector length is encoded; the vector
contents themselves are not null terminated. In addition to the vector
list, there is a single vector for vendor name (also 8 bit clean,
-length encoded in 32 bits). The 1.0 release of libvorbis sets the
-vendor string to "Xiph.Org libVorbis I 20020717".</para>
+length encoded in 32 bits). For example, the 1.0 release of libvorbis
+set the vendor string to "Xiph.Org libVorbis I 20020717".</para>
<para>The comment header is decoded as follows:
@@ -189,7 +189,7 @@
<varlistentry><term>ISRC</term>
<listitem><simpara>International Standard Recording Code for the
track; see <ulink
-url="http://www.ifpi.org/site-content/online/isrc_intro.html">the ISRC
+url="http://www.ifpi.org/isrc/">the ISRC
intro page</ulink> for more information on ISRC numbers.
</simpara></listitem>
</varlistentry>
@@ -202,9 +202,9 @@
<para>Field names should not be 'internationalized'; this is a
concession to simplicity not an attempt to exclude the majority of
-the world that doesn't speak English. Field <emphasis>contents</emphasis>
-however, use the UTF-8 character encoding to allow easy representation of any
-language.</para>
+the world that doesn't speak English. Field <emphasis>contents</emphasis>,
+however, use the UTF-8 character encoding to allow easy representation
+of any language.</para>
<para>We have the length of the entirety of the field and restrictions on
the field name so that the field name is bounded in a known way. Thus
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/06-floor0.xml
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/06-floor0.xml 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/06-floor0.xml 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,7 +7,7 @@
<section id="vorbis-spec-floor0">
<sectioninfo>
<releaseinfo>
- $Id: 06-floor0.xml 8547 2004-12-29 03:33:51Z giles $
+ $Id: 06-floor0.xml 14529 2008-02-19 10:15:13Z xiphmont $
</releaseinfo>
</sectioninfo>
<title>Floor type 0 setup and decode</title>
@@ -49,9 +49,7 @@
4) [floor0_amplitude_bits] = read an unsigned integer of six bits
5) [floor0_amplitude_offset] = read an unsigned integer of eight bits
6) [floor0_number_of_books] = read an unsigned integer of four bits and add 1
- 7) if any of [floor0_order], [floor0_rate], [floor0_bark_map_size], [floor0_amplitude_bits],
- [floor0_amplitude_offset] or [floor0_number_of_books] are less than zero, the stream is not decodable
- 8) array [floor0_book_list] = read a list of [floor0_number_of_books] unsigned integers of eight bits each;
+ 7) array [floor0_book_list] = read a list of [floor0_number_of_books] unsigned integers of eight bits each;
</screen>
<para>
@@ -79,11 +77,10 @@
1) [amplitude] = read an unsigned integer of [floor0_amplitude_bits] bits
2) if ( [amplitude] is greater than zero ) {
3) [coefficients] is an empty, zero length vector
-
4) [booknumber] = read an unsigned integer of <link linkend="vorbis-spec-ilog">ilog</link>( [floor0_number_of_books] ) bits
5) if ( [booknumber] is greater than the highest number decode codebook ) then packet is undecodable
6) [last] = zero;
- 7) vector [temp_vector] = read vector from bitstream using codebook number [booknumber] in VQ context.
+ 7) vector [temp_vector] = read vector from bitstream using codebook number [floor0_book_list] element [booknumber] in VQ context.
8) add the scalar value [last] to each scalar in vector [temp_vector]
9) [last] = the value of the last scalar in vector [temp_vector]
10) concatenate [temp_vector] onto the end of the [coefficients] vector
@@ -186,6 +183,7 @@
<orderedlist>
<listitem><simpara> <varname>[i]</varname> = 0 </simpara></listitem>
+ <listitem><simpara> <varname>[ω]</varname> = π * map element <varname>[i]</varname> / <varname>[floor0_bark_map_size]</varname></simpara></listitem>
<listitem><para>if ( <varname>[floor0_order]</varname> is odd ) {
<orderedlist>
<listitem><para>calculate <varname>[p]</varname> and <varname>[q]</varname> according to:
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/07-floor1.xml
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/07-floor1.xml 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/07-floor1.xml 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,7 +7,7 @@
<section id="vorbis-spec-floor1">
<sectioninfo>
<releaseinfo>
- $Id: 07-floor1.xml 7186 2004-07-20 07:19:25Z xiphmont $
+ $Id: 07-floor1.xml 10466 2005-11-28 00:34:44Z giles $
</releaseinfo>
</sectioninfo>
<title>Floor type 1 setup and decode</title>
@@ -35,6 +35,7 @@
prediction in a process roughly equivalent to the following simplified
description:</para>
+<para>
<itemizedlist>
<listitem><simpara> the first line segment (base case) is a logical line spanning
from x_0,y_0 to x_1,y_1 where in the base case x_0=0 and x_1=[n], the
@@ -56,6 +57,7 @@
is completed at the end of the x value list.</simpara></listitem>
</itemizedlist>
+</para>
<para>
Consider the following example, with values chosen for ease of
@@ -182,7 +184,7 @@
19) [current_class_number] = vector [floor1_partition_class_list] element [i]
20) iterate [j] over the range 0 ... ([floor1_class_dimensions] element [current_class_number])-1 {
- 21) vector [floor1_X_list] element ([j] + [floor1_values]) =
+ 21) vector [floor1_X_list] element ([floor1_values]) =
read [rangebits] bits as unsigned integer
22) increment [floor1_values] by one
}
@@ -326,7 +328,7 @@
} else [highroom] is not less than [lowroom] {
- 15) [root] = [lowroom] * 2
+ 15) [room] = [lowroom] * 2
}
@@ -409,7 +411,7 @@
3) [ly] = vector [floor1_final_Y]' element [0] * [floor1_multiplier]
4) iterate [i] over the range 1 ... [floor1_values]-1 {
- 5) if ( [floor1_step2_flag]' is set ) {
+ 5) if ( [floor1_step2_flag]' element [i] is set ) {
6) [hy] = [floor1_final_Y]' element [i] * [floor1_multiplier]
7) [hx] = [floor1_X_list]' element [i]
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/08-residue.xml
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/08-residue.xml 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/08-residue.xml 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,7 +7,7 @@
<section id="vorbis-spec-residue">
<sectioninfo>
<releaseinfo>
- $Id: 08-residue.xml 7186 2004-07-20 07:19:25Z xiphmont $
+ $Id: 08-residue.xml 14598 2008-03-18 15:39:43Z xiphmont $
</releaseinfo>
</sectioninfo>
<title>Residue setup and decode</title>
@@ -50,6 +50,7 @@
coding structure, ignoring for the moment exactly how a partition is
encoded and simply trusting that it is, is as follows:</para>
+<para>
<itemizedlist>
<listitem><para>Each vector is partitioned into multiple equal sized chunks
according to configuration specified. If we have a vector size of
@@ -81,6 +82,7 @@
is coded only in the first pass.</para></listitem>
</itemizedlist>
+</para>
<mediaobject>
<imageobject>
@@ -197,21 +199,29 @@
</programlisting>
<para>
-<varname>[residue_begin]</varname> and <varname>[residue_end]</varname> select the specific
-sub-portion of each vector that is actually coded; it implements akin
-to a bandpass where, for coding purposes, the vector effectively
-begins at element <varname>[residue_begin]</varname> and ends at
-<varname>[residue_end]</varname>. Preceding and following values in the unpacked
-vectors are zeroed. Note that for residue type 2, these values as
-well as <varname>[residue_partition_size]</varname>apply to the interleaved
-vector, not the individual vectors before interleave.
+<varname>[residue_begin]</varname> and
+<varname>[residue_end]</varname> select the specific sub-portion of
+each vector that is actually coded; it implements akin to a bandpass
+where, for coding purposes, the vector effectively begins at element
+<varname>[residue_begin]</varname> and ends at
+<varname>[residue_end]</varname>. Preceding and following values in
+the unpacked vectors are zeroed. Note that for residue type 2, these
+values as well as <varname>[residue_partition_size]</varname>apply to
+the interleaved vector, not the individual vectors before interleave.
<varname>[residue_partition_size]</varname> is as explained above,
<varname>[residue_classifications]</varname> is the number of possible
classification to which a partition can belong and
-<varname>[residue_classbook]</varname> is the codebook number used to code
-classification codewords. The number of dimensions in book
-<varname>[residue_classbook]</varname> determines how many classification values
-are grouped into a single classification codeword.</para>
+<varname>[residue_classbook]</varname> is the codebook number used to
+code classification codewords. The number of dimensions in book
+<varname>[residue_classbook]</varname> determines how many
+classification values are grouped into a single classification
+codeword. Note that the number of entries and dimensions in book
+<varname>[residue_classbook]</varname>, along with
+<varname>[residue_classifications]</varname>, overdetermines to
+possible number of classification codewords. If
+<varname>[residue_classifications]</varname>^<varname>[residue_classbook]</varname>.dimensions
+does not equal <varname>[residue_classbook]</varname>.entries, the
+bitstream should be regarded to be undecodable. </para>
<para>
Next we read a bitmap pattern that specifies which partition classes
@@ -281,67 +291,94 @@
'do not decode' vectors are allocated and zeroed.</para>
<para>
+Depending on the values of <varname>[residue_begin]</varname> and
+<varname>[residue_end]</varname>, it is obvious that the encoded
+portion of a residue vector may be the entire possible residue vector
+or some other strict subset of the actual residue vector size with
+zero padding at either uncoded end. However, it is also possible to
+set <varname>[residue_begin]</varname> and
+<varname>[residue_end]</varname> to specify a range partially or
+wholly beyond the maximum vector size. Before beginning residue
+decode, limit <varname>[residue_begin]</varname> and
+<varname>[residue_end]</varname> to the maximum possible vector size
+as follows. We assume that the number of vectors being encoded,
+<varname>[ch]</varname> is provided by the higher level decoding
+process.</para>
+
+<programlisting>
+ 1) [actual_size] = current blocksize/2;
+ 2) if residue encoding is format 2
+ 3) [actual_size] = [actual_size] * [ch];
+ 4) [limit_residue_begin] = maximum of ([residue_begin],[actual_size]);
+ 5) [limit_residue_end] = maximum of ([residue_end],[actual_size]);
+</programlisting>
+
+<para>
The following convenience values are conceptually useful to clarifying
the decode process:</para>
<programlisting>
1) [classwords_per_codeword] = [codebook_dimensions] value of codebook [residue_classbook]
- 2) [n_to_read] = [residue_end] - [residue_begin]
+ 2) [n_to_read] = [limit_residue_end] - [limit_residue_begin]
3) [partitions_to_read] = [n_to_read] / [residue_partition_size]
</programlisting>
<para>
-Packet decode proceeds as follows, matching the description offered earlier in the document. We assume that the number of vectors being encoded, <varname>[ch]</varname> is provided by the higher level decoding process.</para>
+Packet decode proceeds as follows, matching the description offered earlier in the document. </para>
<programlisting>
1) allocate and zero all vectors that will be returned.
- 2) iterate [pass] over the range 0 ... 7 {
+ 2) if ([n_to_read] is zero), stop; there is no residue to decode.
+ 3) iterate [pass] over the range 0 ... 7 {
- 3) [partition_count] = 0
+ 4) [partition_count] = 0
- 4) if ([pass] is zero) {
+ 5) while [partition_count] is less than [partitions_to_read]
+
+ 6) if ([pass] is zero) {
- 5) iterate [j] over the range 0 .. [ch]-1 {
+ 7) iterate [j] over the range 0 .. [ch]-1 {
- 6) if vector [j] is not marked 'do not decode' {
+ 8) if vector [j] is not marked 'do not decode' {
- 7) [temp] = read from packet using codebook [residue_classbook] in scalar context
- 8) iterate [i] descending over the range [classwords_per_codeword]-1 ... 0 {
+ 9) [temp] = read from packet using codebook [residue_classbook] in scalar context
+ 10) iterate [i] descending over the range [classwords_per_codeword]-1 ... 0 {
- 9) array [classifications] element [j],([i]+[partition_count]) =
- [temp] integer modulo [residue_classifications]
- 10) [temp] = [temp] / [residue_classifications] using integer division
+ 11) array [classifications] element [j],([i]+[partition_count]) =
+ [temp] integer modulo [residue_classifications]
+ 12) [temp] = [temp] / [residue_classifications] using integer division
+ }
+
}
-
+
}
-
+
}
-
- }
- 11) iterate [i] over the range 0 .. ([classwords_per_codeword] - 1) while [partition_count]
- is also less than [partitions_to_read] {
+ 13) iterate [i] over the range 0 .. ([classwords_per_codeword] - 1) while [partition_count]
+ is also less than [partitions_to_read] {
- 12) iterate [j] over the range 0 .. [ch]-1 {
+ 14) iterate [j] over the range 0 .. [ch]-1 {
- 13) if vector [j] is not marked 'do not decode' {
+ 15) if vector [j] is not marked 'do not decode' {
- 14) [vqclass] = array [classifications] element [j],[partition_count]
- 15) [vqbook] = array [residue_books] element [vqclass],[pass]
- 16) if ([vqbook] is not 'unused') {
+ 16) [vqclass] = array [classifications] element [j],[partition_count]
+ 17) [vqbook] = array [residue_books] element [vqclass],[pass]
+ 18) if ([vqbook] is not 'unused') {
- 17) decode partition into output vector number [j], starting at scalar
- offset [residue_begin]+[partition_count]*[residue_partition_size] using
- codebook number [vqbook] in VQ context
+ 19) decode partition into output vector number [j], starting at scalar
+ offset [limit_residue_begin]+[partition_count]*[residue_partition_size] using
+ codebook number [vqbook] in VQ context
+ }
}
- }
- 18) increment [partition_count] by one
+ 20) increment [partition_count] by one
+ }
}
}
- 19) done
+ 21) done
</programlisting>
@@ -359,11 +396,13 @@
'Residue Format: residue 0' section. The following pseudocode
presents the same algorithm. Assume:</para>
+<para>
<itemizedlist>
<listitem><simpara> <varname>[n]</varname> is the value in <varname>[residue_partition_size]</varname></simpara></listitem>
<listitem><simpara><varname>[v]</varname> is the residue vector</simpara></listitem>
<listitem><simpara><varname>[offset]</varname> is the beginning read offset in [v]</simpara></listitem>
</itemizedlist>
+</para>
<programlisting>
1) [step] = [n] / [codebook_dimensions]
@@ -393,12 +432,14 @@
'Residue Format: residue 1' section. The following pseudocode
presents the same algorithm. Assume:</para>
+<para>
<itemizedlist>
<listitem><simpara> <varname>[n]</varname> is the value in
<varname>[residue_partition_size]</varname></simpara></listitem>
<listitem><simpara><varname>[v]</varname> is the residue vector</simpara></listitem>
<listitem><simpara><varname>[offset]</varname> is the beginning read offset in [v]</simpara></listitem>
</itemizedlist>
+</para>
<programlisting>
1) [i] = 0
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/a1-encapsulation_ogg.xml
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/a1-encapsulation_ogg.xml 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/a1-encapsulation_ogg.xml 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,7 +7,7 @@
<appendix id="vorbis-over-ogg">
<appendixinfo>
<releaseinfo>
- $Id: a1-encapsulation_ogg.xml 7186 2004-07-20 07:19:25Z xiphmont $
+ $Id: a1-encapsulation_ogg.xml 14530 2008-02-19 10:37:19Z xiphmont $
</releaseinfo>
</appendixinfo>
<title>Embedding Vorbis into an Ogg stream</title>
@@ -134,12 +134,24 @@
<listitem><simpara>
The granule position of a page represents the end PCM sample
- position of the last packet <emphasis>completed</emphasis> on that page.
- A page that is entirely spanned by a single packet (that completes on a
- subsequent page) has no granule position, and the granule position is
- set to '-1'.
-</simpara></listitem>
+ position of the last packet <emphasis>completed</emphasis> on that
+ page. The 'last PCM sample' is the last complete sample returned by
+ decode, not an internal sample awaiting lapping with a
+ subsequent block. A page that is entirely spanned by a single
+ packet (that completes on a subsequent page) has no granule
+ position, and the granule position is set to '-1'. </simpara>
+<simpara>
+ Note that the last decoded (fully lapped) PCM sample from a packet
+ is not necessarily the middle sample from that block. If, eg, the
+ current Vorbis packet encodes a "long block" and the next Vorbis
+ packet encodes a "short block", the last decodable sample from the
+ current packet be at position (3*long_block_length/4) -
+ (short_block_length/4).
+</simpara>
+
+</listitem>
+
<listitem>
<simpara>
The granule (PCM) position of the first page need not indicate
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/footer.xml
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/footer.xml 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/doc/xml/footer.xml 2008-06-13 23:59:37 UTC (rev 15029)
@@ -49,7 +49,7 @@
<para>
Ogg, Vorbis, Xiph.org Foundation and their logos are trademarks (tm)
of the <ulink url="http://www.xiph.org/">Xiph.org Foundation</ulink>. These
-pages are copyright (C) 1994-2004 Xiph.org Foundation. All rights
+pages are copyright (C) 1994-2007 Xiph.org Foundation. All rights
reserved.</para>
<para>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/Makefile.am
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/Makefile.am 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/Makefile.am 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,19 +7,25 @@
noinst_PROGRAMS = decoder_example encoder_example chaining_example\
vorbisfile_example seeking_example
+EXTRA_DIST = frameview.pl
+
# uncomment to build static executables from the example code
#LDFLAGS = -all-static
-LDADD = ../lib/libvorbis.la
decoder_example_SOURCES = decoder_example.c
+decoder_example_LDADD = $(top_builddir)/lib/libvorbis.la
+
encoder_example_SOURCES = encoder_example.c
-encoder_example_LDADD = ../lib/libvorbisenc.la ../lib/libvorbis.la
+encoder_example_LDADD = $(top_builddir)/lib/libvorbisenc.la $(top_builddir)/lib/libvorbis.la
+
chaining_example_SOURCES = chaining_example.c
-chaining_example_LDADD = ../lib/libvorbisfile.la ../lib/libvorbis.la
+chaining_example_LDADD = $(top_builddir)/lib/libvorbisfile.la $(top_builddir)/lib/libvorbis.la
+
vorbisfile_example_SOURCES = vorbisfile_example.c
-vorbisfile_example_LDADD = ../lib/libvorbisfile.la ../lib/libvorbis.la
+vorbisfile_example_LDADD = $(top_builddir)/lib/libvorbisfile.la $(top_builddir)/lib/libvorbis.la
+
seeking_example_SOURCES = seeking_example.c
-seeking_example_LDADD = ../lib/libvorbisfile.la ../lib/libvorbis.la
+seeking_example_LDADD = $(top_builddir)/lib/libvorbisfile.la $(top_builddir)/lib/libvorbis.la
debug:
$(MAKE) all CFLAGS="@DEBUG@"
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/chaining_example.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/chaining_example.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/chaining_example.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: illustrate simple use of chained bitstream and vorbisfile.a
- last mod: $Id: chaining_example.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: chaining_example.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
@@ -28,15 +28,14 @@
OggVorbis_File ov;
int i;
-#ifdef _WIN32 /* We need to set stdin/stdout to binary mode. Damn windows. */
+#ifdef _WIN32 /* We need to set stdin to binary mode. Damn windows. */
/* Beware the evil ifdef. We avoid these where we can, but this one we
cannot. Don't add any more, you'll probably go to hell if you do. */
_setmode( _fileno( stdin ), _O_BINARY );
- _setmode( _fileno( stdout ), _O_BINARY );
#endif
/* open the file/pipe on stdin */
- if(ov_open(stdin,&ov,NULL,-1)<0){
+ if(ov_open_callbacks(stdin,&ov,NULL,-1,OV_CALLBACKS_NOCLOSE)<0){
printf("Could not open input as an OggVorbis file.\n\n");
exit(1);
}
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/decoder_example.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/decoder_example.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/decoder_example.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: simple example decoder
- last mod: $Id: decoder_example.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: decoder_example.c 14811 2008-04-28 21:42:52Z xiphmont $
********************************************************************/
@@ -163,7 +163,11 @@
fprintf(stderr,"Corrupt secondary header. Exiting.\n");
exit(1);
}
- vorbis_synthesis_headerin(&vi,&vc,&op);
+ result=vorbis_synthesis_headerin(&vi,&vc,&op);
+ if(result<0){
+ fprintf(stderr,"Corrupt secondary header. Exiting.\n");
+ exit(1);
+ }
i++;
}
}
@@ -194,108 +198,111 @@
/* OK, got and parsed all three headers. Initialize the Vorbis
packet->PCM decoder. */
- vorbis_synthesis_init(&vd,&vi); /* central decode state */
- vorbis_block_init(&vd,&vb); /* local state for most of the decode
- so multiple block decodes can
- proceed in parallel. We could init
- multiple vorbis_block structures
- for vd here */
-
- /* The rest is just a straight decode loop until end of stream */
- while(!eos){
+ if(vorbis_synthesis_init(&vd,&vi)==0){ /* central decode state */
+ vorbis_block_init(&vd,&vb); /* local state for most of the decode
+ so multiple block decodes can
+ proceed in parallel. We could init
+ multiple vorbis_block structures
+ for vd here */
+
+ /* The rest is just a straight decode loop until end of stream */
while(!eos){
- int result=ogg_sync_pageout(&oy,&og);
- if(result==0)break; /* need more data */
- if(result<0){ /* missing or corrupt data at this page position */
- fprintf(stderr,"Corrupt or missing data in bitstream; "
- "continuing...\n");
- }else{
- ogg_stream_pagein(&os,&og); /* can safely ignore errors at
- this point */
- while(1){
- result=ogg_stream_packetout(&os,&op);
-
- if(result==0)break; /* need more data */
- if(result<0){ /* missing or corrupt data at this page position */
- /* no reason to complain; already complained above */
- }else{
- /* we have a packet. Decode it */
- float **pcm;
- int samples;
+ while(!eos){
+ int result=ogg_sync_pageout(&oy,&og);
+ if(result==0)break; /* need more data */
+ if(result<0){ /* missing or corrupt data at this page position */
+ fprintf(stderr,"Corrupt or missing data in bitstream; "
+ "continuing...\n");
+ }else{
+ ogg_stream_pagein(&os,&og); /* can safely ignore errors at
+ this point */
+ while(1){
+ result=ogg_stream_packetout(&os,&op);
- if(vorbis_synthesis(&vb,&op)==0) /* test for success! */
- vorbis_synthesis_blockin(&vd,&vb);
- /*
-
- **pcm is a multichannel float vector. In stereo, for
- example, pcm[0] is left, and pcm[1] is right. samples is
- the size of each channel. Convert the float values
- (-1.<=range<=1.) to whatever PCM format and write it out */
-
- while((samples=vorbis_synthesis_pcmout(&vd,&pcm))>0){
- int j;
- int clipflag=0;
- int bout=(samples<convsize?samples:convsize);
+ if(result==0)break; /* need more data */
+ if(result<0){ /* missing or corrupt data at this page position */
+ /* no reason to complain; already complained above */
+ }else{
+ /* we have a packet. Decode it */
+ float **pcm;
+ int samples;
- /* convert floats to 16 bit signed ints (host order) and
- interleave */
- for(i=0;i<vi.channels;i++){
- ogg_int16_t *ptr=convbuffer+i;
- float *mono=pcm[i];
- for(j=0;j<bout;j++){
+ if(vorbis_synthesis(&vb,&op)==0) /* test for success! */
+ vorbis_synthesis_blockin(&vd,&vb);
+ /*
+
+ **pcm is a multichannel float vector. In stereo, for
+ example, pcm[0] is left, and pcm[1] is right. samples is
+ the size of each channel. Convert the float values
+ (-1.<=range<=1.) to whatever PCM format and write it out */
+
+ while((samples=vorbis_synthesis_pcmout(&vd,&pcm))>0){
+ int j;
+ int clipflag=0;
+ int bout=(samples<convsize?samples:convsize);
+
+ /* convert floats to 16 bit signed ints (host order) and
+ interleave */
+ for(i=0;i<vi.channels;i++){
+ ogg_int16_t *ptr=convbuffer+i;
+ float *mono=pcm[i];
+ for(j=0;j<bout;j++){
#if 1
- int val=mono[j]*32767.f;
+ int val=mono[j]*32767.f;
#else /* optional dither */
- int val=mono[j]*32767.f+drand48()-0.5f;
+ int val=mono[j]*32767.f+drand48()-0.5f;
#endif
- /* might as well guard against clipping */
- if(val>32767){
- val=32767;
- clipflag=1;
+ /* might as well guard against clipping */
+ if(val>32767){
+ val=32767;
+ clipflag=1;
+ }
+ if(val<-32768){
+ val=-32768;
+ clipflag=1;
+ }
+ *ptr=val;
+ ptr+=vi.channels;
}
- if(val<-32768){
- val=-32768;
- clipflag=1;
- }
- *ptr=val;
- ptr+=vi.channels;
}
- }
-
- if(clipflag)
- fprintf(stderr,"Clipping in frame %ld\n",(long)(vd.sequence));
-
-
- fwrite(convbuffer,2*vi.channels,bout,stdout);
-
- vorbis_synthesis_read(&vd,bout); /* tell libvorbis how
- many samples we
- actually consumed */
- }
+
+ if(clipflag)
+ fprintf(stderr,"Clipping in frame %ld\n",(long)(vd.sequence));
+
+
+ fwrite(convbuffer,2*vi.channels,bout,stdout);
+
+ vorbis_synthesis_read(&vd,bout); /* tell libvorbis how
+ many samples we
+ actually consumed */
+ }
+ }
}
+ if(ogg_page_eos(&og))eos=1;
}
- if(ogg_page_eos(&og))eos=1;
}
+ if(!eos){
+ buffer=ogg_sync_buffer(&oy,4096);
+ bytes=fread(buffer,1,4096,stdin);
+ ogg_sync_wrote(&oy,bytes);
+ if(bytes==0)eos=1;
+ }
}
- if(!eos){
- buffer=ogg_sync_buffer(&oy,4096);
- bytes=fread(buffer,1,4096,stdin);
- ogg_sync_wrote(&oy,bytes);
- if(bytes==0)eos=1;
- }
+
+ /* ogg_page and ogg_packet structs always point to storage in
+ libvorbis. They're never freed or manipulated directly */
+
+ vorbis_block_clear(&vb);
+ vorbis_dsp_clear(&vd);
+ }else{
+ fprintf(stderr,"Error: Corrupt header during playback initialization.\n");
}
-
+
/* clean up this logical bitstream; before exit we see if we're
followed by another [chained] */
-
+
ogg_stream_clear(&os);
-
- /* ogg_page and ogg_packet structs always point to storage in
- libvorbis. They're never freed or manipulated directly */
-
- vorbis_block_clear(&vb);
- vorbis_dsp_clear(&vd);
- vorbis_comment_clear(&vc);
+ vorbis_comment_clear(&vc);
vorbis_info_clear(&vi); /* must be called last */
}
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/encoder_example.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/encoder_example.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/encoder_example.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: simple example encoder
- last mod: $Id: encoder_example.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: encoder_example.c 14558 2008-03-08 02:23:34Z erikd $
********************************************************************/
@@ -62,9 +62,9 @@
/* this also lets the user set stdin and stdout */
#endif
- /* we cheat on the WAV header; we just bypass 44 bytes and never
- verify that it matches 16bit/stereo/44.1kHz. This is just an
- example, after all. */
+ /* we cheat on the WAV header; we just bypass 44 bytes (simplest WAV
+ header is 44 bytes) and assume that the data is 44.1khz, stereo, 16 bit
+ little endian pcm samples. This is just an example, after all. */
#ifdef _WIN32 /* We need to set stdin/stdout to binary mode. Damn windows. */
/* if we were reading/writing a file, it would also need to in
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/seeking_example.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/seeking_example.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/seeking_example.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: illustrate seeking, and test it too
- last mod: $Id: seeking_example.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: seeking_example.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
@@ -25,35 +25,41 @@
# include <fcntl.h>
#endif
-void _verify(OggVorbis_File *ov,ogg_int64_t pos,
- ogg_int64_t val,ogg_int64_t pcmval,
+void _verify(OggVorbis_File *ov,
+ ogg_int64_t val,ogg_int64_t pcmval,double timeval,
ogg_int64_t pcmlength,
char *bigassbuffer){
int j;
long bread;
char buffer[4096];
int dummy;
+ ogg_int64_t pos;
/* verify the raw position, the pcm position and position decode */
if(val!=-1 && ov_raw_tell(ov)<val){
- printf("raw position out of tolerance: requested %ld, got %ld\n",
+ fprintf(stderr,"raw position out of tolerance: requested %ld, got %ld\n",
(long)val,(long)ov_raw_tell(ov));
exit(1);
}
if(pcmval!=-1 && ov_pcm_tell(ov)>pcmval){
- printf("pcm position out of tolerance: requested %ld, got %ld\n",
+ fprintf(stderr,"pcm position out of tolerance: requested %ld, got %ld\n",
(long)pcmval,(long)ov_pcm_tell(ov));
exit(1);
}
+ if(timeval!=-1 && ov_time_tell(ov)>timeval){
+ fprintf(stderr,"time position out of tolerance: requested %f, got %f\n",
+ timeval,ov_time_tell(ov));
+ exit(1);
+ }
pos=ov_pcm_tell(ov);
if(pos<0 || pos>pcmlength){
- printf("pcm position out of bounds: got %ld\n",(long)pos);
+ fprintf(stderr,"pcm position out of bounds: got %ld\n",(long)pos);
exit(1);
}
bread=ov_read(ov,buffer,4096,1,1,1,&dummy);
for(j=0;j<bread;j++){
if(buffer[j]!=bigassbuffer[j+pos*2]){
- printf("data position after seek doesn't match pcm position\n");
+ fprintf(stderr,"data position after seek doesn't match pcm position\n");
{
FILE *f=fopen("a.m","w");
@@ -73,18 +79,18 @@
OggVorbis_File ov;
int i,ret;
ogg_int64_t pcmlength;
+ double timelength;
char *bigassbuffer;
int dummy;
#ifdef _WIN32 /* We need to set stdin/stdout to binary mode. Damn windows. */
_setmode( _fileno( stdin ), _O_BINARY );
- _setmode( _fileno( stdout ), _O_BINARY );
#endif
/* open the file/pipe on stdin */
- if(ov_open(stdin,&ov,NULL,-1)<0){
- printf("Could not open input as an OggVorbis file.\n\n");
+ if(ov_open_callbacks(stdin,&ov,NULL,-1,OV_CALLBACKS_NOCLOSE)<0){
+ fprintf(stderr,"Could not open input as an OggVorbis file.\n\n");
exit(1);
}
@@ -96,7 +102,7 @@
for(i=0;i<ov.links;i++){
vorbis_info *vi=ov_info(&ov,i);
if(vi->channels!=2){
- printf("Sorry; right now seeking_test can only use Vorbis files\n"
+ fprintf(stderr,"Sorry; right now seeking_test can only use Vorbis files\n"
"that are entirely stereo.\n\n");
exit(1);
}
@@ -104,8 +110,8 @@
/* because we want to do sample-level verification that the seek
does what it claimed, decode the entire file into memory */
- fflush(stdout);
pcmlength=ov_pcm_total(&ov,-1);
+ timelength=ov_time_total(&ov,-1);
bigassbuffer=malloc(pcmlength*2); /* w00t */
i=0;
while(i<pcmlength*2){
@@ -120,83 +126,116 @@
(long)(pcmlength*2-i));
}
- /* Exercise all the real seeking cases; ov_raw_seek,
- ov_pcm_seek_page and ov_pcm_seek. time seek is just a wrapper
- on pcm_seek */
{
ogg_int64_t length=ov.end;
- printf("\rtesting raw seeking to random places in %ld bytes....\n",
+ fprintf(stderr,"\rtesting raw seeking to random places in %ld bytes....\n",
(long)length);
for(i=0;i<1000;i++){
ogg_int64_t val=(double)rand()/RAND_MAX*length;
- ogg_int64_t pos;
- printf("\r\t%d [raw position %ld]... ",i,(long)val);
- fflush(stdout);
+ fprintf(stderr,"\r\t%d [raw position %ld]... ",i,(long)val);
ret=ov_raw_seek(&ov,val);
if(ret<0){
- printf("seek failed: %d\n",ret);
+ fprintf(stderr,"seek failed: %d\n",ret);
exit(1);
}
- _verify(&ov,pos,val,-1,pcmlength,bigassbuffer);
+ _verify(&ov,val,-1,-1.,pcmlength,bigassbuffer);
}
}
- printf("\r");
+ fprintf(stderr,"\r");
{
- printf("testing pcm page seeking to random places in %ld samples....\n",
+ fprintf(stderr,"testing pcm page seeking to random places in %ld samples....\n",
(long)pcmlength);
for(i=0;i<1000;i++){
ogg_int64_t val=(double)rand()/RAND_MAX*pcmlength;
- ogg_int64_t pos;
- printf("\r\t%d [pcm position %ld]... ",i,(long)val);
- fflush(stdout);
+ fprintf(stderr,"\r\t%d [pcm position %ld]... ",i,(long)val);
ret=ov_pcm_seek_page(&ov,val);
if(ret<0){
- printf("seek failed: %d\n",ret);
+ fprintf(stderr,"seek failed: %d\n",ret);
exit(1);
}
- _verify(&ov,pos,-1,val,pcmlength,bigassbuffer);
+ _verify(&ov,-1,val,-1.,pcmlength,bigassbuffer);
}
}
- printf("\r");
+ fprintf(stderr,"\r");
{
- ogg_int64_t length=ov.end;
- printf("testing pcm exact seeking to random places in %ld samples....\n",
+ fprintf(stderr,"testing pcm exact seeking to random places in %ld samples....\n",
(long)pcmlength);
for(i=0;i<1000;i++){
ogg_int64_t val=(double)rand()/RAND_MAX*pcmlength;
- ogg_int64_t pos;
- printf("\r\t%d [pcm position %ld]... ",i,(long)val);
- fflush(stdout);
+ fprintf(stderr,"\r\t%d [pcm position %ld]... ",i,(long)val);
ret=ov_pcm_seek(&ov,val);
if(ret<0){
- printf("seek failed: %d\n",ret);
+ fprintf(stderr,"seek failed: %d\n",ret);
exit(1);
}
if(ov_pcm_tell(&ov)!=val){
- printf("Declared position didn't perfectly match request: %ld != %ld\n",
+ fprintf(stderr,"Declared position didn't perfectly match request: %ld != %ld\n",
(long)val,(long)ov_pcm_tell(&ov));
exit(1);
}
- _verify(&ov,pos,-1,val,pcmlength,bigassbuffer);
+ _verify(&ov,-1,val,-1.,pcmlength,bigassbuffer);
}
}
+
+ fprintf(stderr,"\r");
+ {
+ fprintf(stderr,"testing time page seeking to random places in %f seconds....\n",
+ timelength);
- printf("\r \nOK.\n\n");
+ for(i=0;i<1000;i++){
+ double val=(double)rand()/RAND_MAX*timelength;
+ fprintf(stderr,"\r\t%d [time position %f]... ",i,val);
+ ret=ov_time_seek_page(&ov,val);
+ if(ret<0){
+ fprintf(stderr,"seek failed: %d\n",ret);
+ exit(1);
+ }
+ _verify(&ov,-1,-1,val,pcmlength,bigassbuffer);
+ }
+ }
+
+ fprintf(stderr,"\r");
+ {
+ fprintf(stderr,"testing time exact seeking to random places in %f seconds....\n",
+ timelength);
+
+ for(i=0;i<1000;i++){
+ double val=(double)rand()/RAND_MAX*timelength;
+ fprintf(stderr,"\r\t%d [time position %f]... ",i,val);
+ ret=ov_time_seek(&ov,val);
+ if(ret<0){
+ fprintf(stderr,"seek failed: %d\n",ret);
+ exit(1);
+ }
+ if(ov_time_tell(&ov)<val-1 || ov_time_tell(&ov)>val+1){
+ fprintf(stderr,"Declared position didn't perfectly match request: %f != %f\n",
+ val,ov_time_tell(&ov));
+ exit(1);
+ }
+
+ _verify(&ov,-1,-1,val,pcmlength,bigassbuffer);
+
+ }
+ }
+
+ fprintf(stderr,"\r \nOK.\n\n");
+
+
}else{
- printf("Standard input was not seekable.\n");
+ fprintf(stderr,"Standard input was not seekable.\n");
}
ov_clear(&ov);
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/vorbisfile_example.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/vorbisfile_example.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/examples/vorbisfile_example.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: simple example decoder using vorbisfile
- last mod: $Id: vorbisfile_example.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: vorbisfile_example.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
@@ -44,7 +44,7 @@
_setmode( _fileno( stdout ), _O_BINARY );
#endif
- if(ov_open(stdin, &vf, NULL, 0) < 0) {
+ if(ov_open_callbacks(stdin, &vf, NULL, 0, OV_CALLBACKS_NOCLOSE) < 0) {
fprintf(stderr,"Input does not appear to be an Ogg bitstream.\n");
exit(1);
}
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/Makefile.am
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/Makefile.am 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/Makefile.am 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,7 +1,7 @@
## Process this file with automake to produce Makefile.in
-includedir = $(prefix)/include/vorbis
+vorbisincludedir = $(includedir)/vorbis
-include_HEADERS = codec.h vorbisfile.h vorbisenc.h
+vorbisinclude_HEADERS = codec.h vorbisfile.h vorbisenc.h
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/codec.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/codec.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/codec.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
********************************************************************
function: libvorbis codec headers
- last mod: $Id: codec.h 7485 2004-08-05 14:54:23Z thomasvs $
+ last mod: $Id: codec.h 13571 2007-08-19 09:36:24Z erikd $
********************************************************************/
@@ -166,11 +166,11 @@
extern void vorbis_info_clear(vorbis_info *vi);
extern int vorbis_info_blocksize(vorbis_info *vi,int zo);
extern void vorbis_comment_init(vorbis_comment *vc);
-extern void vorbis_comment_add(vorbis_comment *vc, char *comment);
+extern void vorbis_comment_add(vorbis_comment *vc, const char *comment);
extern void vorbis_comment_add_tag(vorbis_comment *vc,
- char *tag, char *contents);
-extern char *vorbis_comment_query(vorbis_comment *vc, char *tag, int count);
-extern int vorbis_comment_query_count(vorbis_comment *vc, char *tag);
+ const char *tag, const char *contents);
+extern char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count);
+extern int vorbis_comment_query_count(vorbis_comment *vc, const char *tag);
extern void vorbis_comment_clear(vorbis_comment *vc);
extern int vorbis_block_init(vorbis_dsp_state *v, vorbis_block *vb);
@@ -198,6 +198,7 @@
ogg_packet *op);
/* Vorbis PRIMITIVES: synthesis layer *******************************/
+extern int vorbis_synthesis_idheader(ogg_packet *op);
extern int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,
ogg_packet *op);
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/vorbisenc.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/vorbisenc.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/vorbisenc.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: vorbis encode-engine setup
- last mod: $Id: vorbisenc.h 7485 2004-08-05 14:54:23Z thomasvs $
+ last mod: $Id: vorbisenc.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/vorbisfile.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/vorbisfile.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/include/vorbis/vorbisfile.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: stdio-based convenience library for opening/seeking/decoding
- last mod: $Id: vorbisfile.h 7485 2004-08-05 14:54:23Z thomasvs $
+ last mod: $Id: vorbisfile.h 14771 2008-04-17 18:21:55Z xiphmont $
********************************************************************/
@@ -43,6 +43,53 @@
long (*tell_func) (void *datasource);
} ov_callbacks;
+/* a few sets of convenient callbacks, especially for use under
+ * Windows where ov_open_callbacks() should always be used instead of
+ * ov_open() to avoid problems with incompatable crt.o version linking
+ * issues. */
+
+static int _ov_header_fseek_wrap(FILE *f,ogg_int64_t off,int whence){
+ if(f==NULL)return(-1);
+ return fseek(f,off,whence);
+}
+
+/* These structs below (OV_CALLBACKS_DEFAULT etc) are defined here as
+ * static data. That means that every file which includes this header
+ * will get its own copy of these structs whether it uses them or
+ * not. This is essential on platforms such as Windows on which
+ * several different versions of stdio support may be linked to by
+ * different DLLs, and we need to be certain we know which one we're
+ * using (the same one as the main application).
+ */
+
+static ov_callbacks OV_CALLBACKS_DEFAULT = {
+ (size_t (*)(void *, size_t, size_t, void *)) fread,
+ (int (*)(void *, ogg_int64_t, int)) _ov_header_fseek_wrap,
+ (int (*)(void *)) fclose,
+ (long (*)(void *)) ftell
+};
+
+static ov_callbacks OV_CALLBACKS_NOCLOSE = {
+ (size_t (*)(void *, size_t, size_t, void *)) fread,
+ (int (*)(void *, ogg_int64_t, int)) _ov_header_fseek_wrap,
+ (int (*)(void *)) NULL,
+ (long (*)(void *)) ftell
+};
+
+static ov_callbacks OV_CALLBACKS_STREAMONLY = {
+ (size_t (*)(void *, size_t, size_t, void *)) fread,
+ (int (*)(void *, ogg_int64_t, int)) NULL,
+ (int (*)(void *)) fclose,
+ (long (*)(void *)) NULL
+};
+
+static ov_callbacks OV_CALLBACKS_STREAMONLY_NOCLOSE = {
+ (size_t (*)(void *, size_t, size_t, void *)) fread,
+ (int (*)(void *, ogg_int64_t, int)) NULL,
+ (int (*)(void *)) NULL,
+ (long (*)(void *)) NULL
+};
+
#define NOTOPEN 0
#define PARTOPEN 1
#define OPENED 2
@@ -86,7 +133,9 @@
} OggVorbis_File;
+
extern int ov_clear(OggVorbis_File *vf);
+extern int ov_fopen(char *path,OggVorbis_File *vf);
extern int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
extern int ov_open_callbacks(void *datasource, OggVorbis_File *vf,
char *initial, long ibytes, ov_callbacks callbacks);
@@ -127,6 +176,9 @@
extern long ov_read_float(OggVorbis_File *vf,float ***pcm_channels,int samples,
int *bitstream);
+extern long ov_read_filter(OggVorbis_File *vf,char *buffer,int length,
+ int bigendianp,int word,int sgned,int *bitstream,
+ void (*filter)(float **pcm,long channels,long samples,void *filter_param),void *filter_param);
extern long ov_read(OggVorbis_File *vf,char *buffer,int length,
int bigendianp,int word,int sgned,int *bitstream);
extern int ov_crosslap(OggVorbis_File *vf1,OggVorbis_File *vf2);
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/Makefile.am
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/Makefile.am 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/Makefile.am 2008-06-13 23:59:37 UTC (rev 15029)
@@ -16,15 +16,15 @@
registry.h scales.h window.h lookup.h lookup_data.h\
codec_internal.h backends.h bitrate.h
libvorbis_la_LDFLAGS = -no-undefined -version-info @V_LIB_CURRENT@:@V_LIB_REVISION@:@V_LIB_AGE@
-libvorbis_la_LIBADD = @OGG_LIBS@ @VORBIS_LIBS@
+libvorbis_la_LIBADD = @VORBIS_LIBS@ @OGG_LIBS@
libvorbisfile_la_SOURCES = vorbisfile.c
libvorbisfile_la_LDFLAGS = -no-undefined -version-info @VF_LIB_CURRENT@:@VF_LIB_REVISION@:@VF_LIB_AGE@
-libvorbisfile_la_LIBADD = libvorbis.la
+libvorbisfile_la_LIBADD = libvorbis.la @OGG_LIBS@
libvorbisenc_la_SOURCES = vorbisenc.c
libvorbisenc_la_LDFLAGS = -no-undefined -version-info @VE_LIB_CURRENT@:@VE_LIB_REVISION@:@VE_LIB_AGE@
-libvorbisenc_la_LIBADD = libvorbis.la
+libvorbisenc_la_LIBADD = libvorbis.la @OGG_LIBS@
EXTRA_PROGRAMS = barkmel tone psytune
CLEANFILES = $(EXTRA_PROGRAMS)
@@ -37,6 +37,25 @@
EXTRA_DIST = lookups.pl
+# build and run the self tests on 'make check'
+
+#vorbis_selftests = test_codebook test_sharedbook
+vorbis_selftests = test_sharedbook
+
+noinst_PROGRAMS = $(vorbis_selftests)
+
+check: $(noinst_PROGRAMS)
+ ./test_sharedbook$(EXEEXT)
+
+#test_codebook_SOURCES = codebook.c
+#test_codebook_CFLAGS = -D_V_SELFTEST
+
+test_sharedbook_SOURCES = sharedbook.c
+test_sharedbook_CFLAGS = -D_V_SELFTEST
+test_sharedbook_LDADD = @VORBIS_LIBS@
+
+# recurse for alternate targets
+
debug:
$(MAKE) all CFLAGS="@DEBUG@"
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/analysis.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/analysis.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/analysis.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: single-block PCM analysis mode dispatch
- last mod: $Id: analysis.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: analysis.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
@@ -74,11 +74,8 @@
/* if(i==5870){*/
sprintf(buffer,"%s_%d.m",base,i);
of=fopen(buffer,"w");
-
-//ZEN::: perror does seem to be part of WinCE SDK for now, just gaurd against WINCE. Not great, but will do for now.
-#ifndef WINCE
+
if(!of)perror("failed to open data dump file");
-#endif
for(j=0;j<n;j++){
if(bark){
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/backends.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/backends.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/backends.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,14 +5,14 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: libvorbis backend and mapping structures; needed for
static mode headers
- last mod: $Id: backends.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: backends.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/barkmel.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/barkmel.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/barkmel.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: bark scale utility
- last mod: $Id: barkmel.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: barkmel.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/bitrate.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/bitrate.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/bitrate.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: bitrate tracking and management
- last mod: $Id: bitrate.c 7497 2004-08-08 04:31:40Z xiphmont $
+ last mod: $Id: bitrate.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/bitrate.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/bitrate.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/bitrate.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: bitrate tracking and management
- last mod: $Id: bitrate.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: bitrate.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/block.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/block.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/block.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2003 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: PCM data vector blocking, windowing and dis/reassembly
- last mod: $Id: block.c 9513 2005-06-26 18:36:49Z giles $
+ last mod: $Id: block.c 14811 2008-04-28 21:42:52Z xiphmont $
Handle windowing, overlap-add, etc of the PCM vectors. This is made
more amusing by Vorbis' current two allowed block sizes.
@@ -235,7 +235,8 @@
if(!ci->fullbooks){
ci->fullbooks=_ogg_calloc(ci->books,sizeof(*ci->fullbooks));
for(i=0;i<ci->books;i++){
- vorbis_book_init_decode(ci->fullbooks+i,ci->book_param[i]);
+ if(vorbis_book_init_decode(ci->fullbooks+i,ci->book_param[i]))
+ return -1;
/* decode codebooks are now standalone after init */
vorbis_staticbook_destroy(ci->book_param[i]);
ci->book_param[i]=NULL;
@@ -326,20 +327,23 @@
}
if(b->flr){
- for(i=0;i<ci->floors;i++)
- _floor_P[ci->floor_type[i]]->
- free_look(b->flr[i]);
+ if(ci)
+ for(i=0;i<ci->floors;i++)
+ _floor_P[ci->floor_type[i]]->
+ free_look(b->flr[i]);
_ogg_free(b->flr);
}
if(b->residue){
- for(i=0;i<ci->residues;i++)
- _residue_P[ci->residue_type[i]]->
- free_look(b->residue[i]);
+ if(ci)
+ for(i=0;i<ci->residues;i++)
+ _residue_P[ci->residue_type[i]]->
+ free_look(b->residue[i]);
_ogg_free(b->residue);
}
if(b->psy){
- for(i=0;i<ci->psys;i++)
- _vp_psy_clear(b->psy+i);
+ if(ci)
+ for(i=0;i<ci->psys;i++)
+ _vp_psy_clear(b->psy+i);
_ogg_free(b->psy);
}
@@ -352,8 +356,9 @@
}
if(v->pcm){
- for(i=0;i<vi->channels;i++)
- if(v->pcm[i])_ogg_free(v->pcm[i]);
+ if(vi)
+ for(i=0;i<vi->channels;i++)
+ if(v->pcm[i])_ogg_free(v->pcm[i]);
_ogg_free(v->pcm);
if(v->pcmret)_ogg_free(v->pcmret);
}
@@ -399,7 +404,7 @@
static void _preextrapolate_helper(vorbis_dsp_state *v){
int i;
- int order=32;
+ int order=16;
float *lpc=alloca(order*sizeof(*lpc));
float *work=alloca(v->pcm_current*sizeof(*work));
long j;
@@ -413,7 +418,18 @@
/* prime as above */
vorbis_lpc_from_data(work,lpc,v->pcm_current-v->centerW,order);
-
+
+#if 0
+ if(v->vi->channels==2){
+ if(i==0)
+ _analysis_output("predataL",0,work,v->pcm_current-v->centerW,0,0,0);
+ else
+ _analysis_output("predataR",0,work,v->pcm_current-v->centerW,0,0,0);
+ }else{
+ _analysis_output("predata",0,work,v->pcm_current-v->centerW,0,0,0);
+ }
+#endif
+
/* run the predictor filter */
vorbis_lpc_predict(lpc,work+v->pcm_current-v->centerW-order,
order,
@@ -679,9 +695,11 @@
}
int vorbis_synthesis_init(vorbis_dsp_state *v,vorbis_info *vi){
- if(_vds_shared_init(v,vi,0)) return 1;
+ if(_vds_shared_init(v,vi,0)){
+ vorbis_dsp_clear(v);
+ return 1;
+ }
vorbis_synthesis_restart(v);
-
return 0;
}
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/coupled/res_books_stereo.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/coupled/res_books_stereo.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/coupled/res_books_stereo.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
* by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: static codebooks autogenerated by huff/huffbuld
- last modified: $Id: res_books_stereo.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last modified: $Id: res_books_stereo.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
@@ -462,83 +462,6 @@
0
};
-static long _vq_quantlist__16c0_s_p2_0[] = {
- 2,
- 1,
- 3,
- 0,
- 4,
-};
-
-static long _vq_lengthlist__16c0_s_p2_0[] = {
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0,
-};
-
-static float _vq_quantthresh__16c0_s_p2_0[] = {
- -1.5, -0.5, 0.5, 1.5,
-};
-
-static long _vq_quantmap__16c0_s_p2_0[] = {
- 3, 1, 0, 2, 4,
-};
-
-static encode_aux_threshmatch _vq_auxt__16c0_s_p2_0 = {
- _vq_quantthresh__16c0_s_p2_0,
- _vq_quantmap__16c0_s_p2_0,
- 5,
- 5
-};
-
-static static_codebook _16c0_s_p2_0 = {
- 4, 625,
- _vq_lengthlist__16c0_s_p2_0,
- 1, -533725184, 1611661312, 3, 0,
- _vq_quantlist__16c0_s_p2_0,
- NULL,
- &_vq_auxt__16c0_s_p2_0,
- NULL,
- 0
-};
-
static long _vq_quantlist__16c0_s_p3_0[] = {
2,
1,
@@ -1652,83 +1575,6 @@
0
};
-static long _vq_quantlist__16c1_s_p2_0[] = {
- 2,
- 1,
- 3,
- 0,
- 4,
-};
-
-static long _vq_lengthlist__16c1_s_p2_0[] = {
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0,
-};
-
-static float _vq_quantthresh__16c1_s_p2_0[] = {
- -1.5, -0.5, 0.5, 1.5,
-};
-
-static long _vq_quantmap__16c1_s_p2_0[] = {
- 3, 1, 0, 2, 4,
-};
-
-static encode_aux_threshmatch _vq_auxt__16c1_s_p2_0 = {
- _vq_quantthresh__16c1_s_p2_0,
- _vq_quantmap__16c1_s_p2_0,
- 5,
- 5
-};
-
-static static_codebook _16c1_s_p2_0 = {
- 4, 625,
- _vq_lengthlist__16c1_s_p2_0,
- 1, -533725184, 1611661312, 3, 0,
- _vq_quantlist__16c1_s_p2_0,
- NULL,
- &_vq_auxt__16c1_s_p2_0,
- NULL,
- 0
-};
-
static long _vq_quantlist__16c1_s_p3_0[] = {
2,
1,
@@ -3764,83 +3610,6 @@
0
};
-static long _vq_quantlist__8c0_s_p2_0[] = {
- 2,
- 1,
- 3,
- 0,
- 4,
-};
-
-static long _vq_lengthlist__8c0_s_p2_0[] = {
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0,
-};
-
-static float _vq_quantthresh__8c0_s_p2_0[] = {
- -1.5, -0.5, 0.5, 1.5,
-};
-
-static long _vq_quantmap__8c0_s_p2_0[] = {
- 3, 1, 0, 2, 4,
-};
-
-static encode_aux_threshmatch _vq_auxt__8c0_s_p2_0 = {
- _vq_quantthresh__8c0_s_p2_0,
- _vq_quantmap__8c0_s_p2_0,
- 5,
- 5
-};
-
-static static_codebook _8c0_s_p2_0 = {
- 4, 625,
- _vq_lengthlist__8c0_s_p2_0,
- 1, -533725184, 1611661312, 3, 0,
- _vq_quantlist__8c0_s_p2_0,
- NULL,
- &_vq_auxt__8c0_s_p2_0,
- NULL,
- 0
-};
-
static long _vq_quantlist__8c0_s_p3_0[] = {
2,
1,
@@ -4933,83 +4702,6 @@
0
};
-static long _vq_quantlist__8c1_s_p2_0[] = {
- 2,
- 1,
- 3,
- 0,
- 4,
-};
-
-static long _vq_lengthlist__8c1_s_p2_0[] = {
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
- 0,
-};
-
-static float _vq_quantthresh__8c1_s_p2_0[] = {
- -1.5, -0.5, 0.5, 1.5,
-};
-
-static long _vq_quantmap__8c1_s_p2_0[] = {
- 3, 1, 0, 2, 4,
-};
-
-static encode_aux_threshmatch _vq_auxt__8c1_s_p2_0 = {
- _vq_quantthresh__8c1_s_p2_0,
- _vq_quantmap__8c1_s_p2_0,
- 5,
- 5
-};
-
-static static_codebook _8c1_s_p2_0 = {
- 4, 625,
- _vq_lengthlist__8c1_s_p2_0,
- 1, -533725184, 1611661312, 3, 0,
- _vq_quantlist__8c1_s_p2_0,
- NULL,
- &_vq_auxt__8c1_s_p2_0,
- NULL,
- 0
-};
-
static long _vq_quantlist__8c1_s_p3_0[] = {
2,
1,
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/floor/floor_books.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/floor/floor_books.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/floor/floor_books.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
* by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: static codebooks autogenerated by huff/huffbuld
- last modified: $Id: floor_books.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last modified: $Id: floor_books.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/uncoupled/res_books_uncoupled.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/uncoupled/res_books_uncoupled.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/books/uncoupled/res_books_uncoupled.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
* by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: static codebooks autogenerated by huff/huffbuld
- last modified: $Id: res_books_uncoupled.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last modified: $Id: res_books_uncoupled.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codebook.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codebook.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codebook.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: basic codebook pack/unpack/code/decode operations
- last mod: $Id: codebook.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: codebook.c 14604 2008-03-19 08:03:29Z xiphmont $
********************************************************************/
@@ -159,6 +159,8 @@
s->entries=oggpack_read(opb,24);
if(s->entries==-1)goto _eofout;
+ if(_ilog(s->dim)+_ilog(s->entries)>24)goto _eofout;
+
/* codeword ordering.... length ordered or unordered? */
switch((int)oggpack_read(opb,1)){
case 0:
@@ -225,7 +227,7 @@
int quantvals=0;
switch(s->maptype){
case 1:
- quantvals=_book_maptype1_quantvals(s);
+ quantvals=(s->dim==0?0:_book_maptype1_quantvals(s));
break;
case 2:
quantvals=s->entries*s->dim;
@@ -255,6 +257,7 @@
/* returns the number of bits ************************************************/
int vorbis_book_encode(codebook *book, int a, oggpack_buffer *b){
+ if(a<0 || a>=book->c->entries)return(0);
oggpack_write(b,book->codelist[a],book->c->lengthlist[a]);
return(book->c->lengthlist[a]);
}
@@ -310,7 +313,7 @@
int read=book->dec_maxlength;
long lo,hi;
long lok = oggpack_look(b,book->dec_firsttablen);
-
+
if (lok >= 0) {
long entry = book->dec_firsttable[lok];
if(entry&0x80000000UL){
@@ -324,24 +327,24 @@
lo=0;
hi=book->used_entries;
}
-
+
lok = oggpack_look(b, read);
-
+
while(lok<0 && read>1)
lok = oggpack_look(b, --read);
if(lok<0)return -1;
-
+
/* bisect search for the codeword in the ordered list */
{
ogg_uint32_t testword=bitreverse((ogg_uint32_t)lok);
-
+
while(hi-lo>1){
long p=(hi-lo)>>1;
long test=book->codelist[lo+p]>testword;
lo+=p&(test-1);
hi-=p&(-test);
- }
-
+ }
+
if(book->dec_codelengths[lo]<=read){
oggpack_adv(b, book->dec_codelengths[lo]);
return(lo);
@@ -349,6 +352,7 @@
}
oggpack_adv(b, read);
+
return(-1);
}
@@ -368,104 +372,121 @@
/* returns the [original, not compacted] entry number or -1 on eof *********/
long vorbis_book_decode(codebook *book, oggpack_buffer *b){
- long packed_entry=decode_packed_entry_number(book,b);
- if(packed_entry>=0)
- return(book->dec_index[packed_entry]);
-
+ if(book->used_entries>0){
+ long packed_entry=decode_packed_entry_number(book,b);
+ if(packed_entry>=0)
+ return(book->dec_index[packed_entry]);
+ }
+
/* if there's no dec_index, the codebook unpacking isn't collapsed */
- return(packed_entry);
+ return(-1);
}
/* returns 0 on OK or -1 on eof *************************************/
long vorbis_book_decodevs_add(codebook *book,float *a,oggpack_buffer *b,int n){
- int step=n/book->dim;
- long *entry = alloca(sizeof(*entry)*step);
- float **t = alloca(sizeof(*t)*step);
- int i,j,o;
-
- for (i = 0; i < step; i++) {
- entry[i]=decode_packed_entry_number(book,b);
- if(entry[i]==-1)return(-1);
- t[i] = book->valuelist+entry[i]*book->dim;
+ if(book->used_entries>0){
+ int step=n/book->dim;
+ long *entry = alloca(sizeof(*entry)*step);
+ float **t = alloca(sizeof(*t)*step);
+ int i,j,o;
+
+ for (i = 0; i < step; i++) {
+ entry[i]=decode_packed_entry_number(book,b);
+ if(entry[i]==-1)return(-1);
+ t[i] = book->valuelist+entry[i]*book->dim;
+ }
+ for(i=0,o=0;i<book->dim;i++,o+=step)
+ for (j=0;j<step;j++)
+ a[o+j]+=t[j][i];
}
- for(i=0,o=0;i<book->dim;i++,o+=step)
- for (j=0;j<step;j++)
- a[o+j]+=t[j][i];
return(0);
}
long vorbis_book_decodev_add(codebook *book,float *a,oggpack_buffer *b,int n){
- int i,j,entry;
- float *t;
+ if(book->used_entries>0){
+ int i,j,entry;
+ float *t;
+
+ if(book->dim>8){
+ for(i=0;i<n;){
+ entry = decode_packed_entry_number(book,b);
+ if(entry==-1)return(-1);
+ t = book->valuelist+entry*book->dim;
+ for (j=0;j<book->dim;)
+ a[i++]+=t[j++];
+ }
+ }else{
+ for(i=0;i<n;){
+ entry = decode_packed_entry_number(book,b);
+ if(entry==-1)return(-1);
+ t = book->valuelist+entry*book->dim;
+ j=0;
+ switch((int)book->dim){
+ case 8:
+ a[i++]+=t[j++];
+ case 7:
+ a[i++]+=t[j++];
+ case 6:
+ a[i++]+=t[j++];
+ case 5:
+ a[i++]+=t[j++];
+ case 4:
+ a[i++]+=t[j++];
+ case 3:
+ a[i++]+=t[j++];
+ case 2:
+ a[i++]+=t[j++];
+ case 1:
+ a[i++]+=t[j++];
+ case 0:
+ break;
+ }
+ }
+ }
+ }
+ return(0);
+}
- if(book->dim>8){
+long vorbis_book_decodev_set(codebook *book,float *a,oggpack_buffer *b,int n){
+ if(book->used_entries>0){
+ int i,j,entry;
+ float *t;
+
for(i=0;i<n;){
entry = decode_packed_entry_number(book,b);
if(entry==-1)return(-1);
t = book->valuelist+entry*book->dim;
for (j=0;j<book->dim;)
- a[i++]+=t[j++];
+ a[i++]=t[j++];
}
}else{
+ int i,j;
+
for(i=0;i<n;){
- entry = decode_packed_entry_number(book,b);
- if(entry==-1)return(-1);
- t = book->valuelist+entry*book->dim;
- j=0;
- switch((int)book->dim){
- case 8:
- a[i++]+=t[j++];
- case 7:
- a[i++]+=t[j++];
- case 6:
- a[i++]+=t[j++];
- case 5:
- a[i++]+=t[j++];
- case 4:
- a[i++]+=t[j++];
- case 3:
- a[i++]+=t[j++];
- case 2:
- a[i++]+=t[j++];
- case 1:
- a[i++]+=t[j++];
- case 0:
- break;
- }
+ for (j=0;j<book->dim;)
+ a[i++]=0.f;
}
- }
- return(0);
-}
-
-long vorbis_book_decodev_set(codebook *book,float *a,oggpack_buffer *b,int n){
- int i,j,entry;
- float *t;
-
- for(i=0;i<n;){
- entry = decode_packed_entry_number(book,b);
- if(entry==-1)return(-1);
- t = book->valuelist+entry*book->dim;
- for (j=0;j<book->dim;)
- a[i++]=t[j++];
}
return(0);
}
long vorbis_book_decodevv_add(codebook *book,float **a,long offset,int ch,
oggpack_buffer *b,int n){
+
long i,j,entry;
int chptr=0;
-
- for(i=offset/ch;i<(offset+n)/ch;){
- entry = decode_packed_entry_number(book,b);
- if(entry==-1)return(-1);
- {
- const float *t = book->valuelist+entry*book->dim;
- for (j=0;j<book->dim;j++){
- a[chptr++][i]+=t[j];
- if(chptr==ch){
- chptr=0;
- i++;
+ if(book->used_entries>0){
+ for(i=offset/ch;i<(offset+n)/ch;){
+ entry = decode_packed_entry_number(book,b);
+ if(entry==-1)return(-1);
+ {
+ const float *t = book->valuelist+entry*book->dim;
+ for (j=0;j<book->dim;j++){
+ a[chptr++][i]+=t[j];
+ if(chptr==ch){
+ chptr=0;
+ i++;
+ }
}
}
}
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codebook.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codebook.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codebook.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: basic shared codebook operations
- last mod: $Id: codebook.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: codebook.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codec_internal.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codec_internal.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/codec_internal.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: libvorbis codec headers
- last mod: $Id: codec_internal.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: codec_internal.h 13575 2007-08-20 09:56:50Z erikd $
********************************************************************/
@@ -133,5 +133,36 @@
extern vorbis_look_psy_global *_vp_global_look(vorbis_info *vi);
extern void _vp_global_free(vorbis_look_psy_global *look);
+
+
+typedef struct {
+ int sorted_index[VIF_POSIT+2];
+ int forward_index[VIF_POSIT+2];
+ int reverse_index[VIF_POSIT+2];
+
+ int hineighbor[VIF_POSIT];
+ int loneighbor[VIF_POSIT];
+ int posts;
+
+ int n;
+ int quant_q;
+ vorbis_info_floor1 *vi;
+
+ long phrasebits;
+ long postbits;
+ long frames;
+} vorbis_look_floor1;
+
+
+
+extern int *floor1_fit(vorbis_block *vb,vorbis_look_floor1 *look,
+ const float *logmdct, /* in */
+ const float *logmask);
+extern int *floor1_interpolate_fit(vorbis_block *vb,vorbis_look_floor1 *look,
+ int *A,int *B,
+ int del);
+extern int floor1_encode(oggpack_buffer *opb,vorbis_block *vb,
+ vorbis_look_floor1 *look,
+ int *post,int *ilogmask);
#endif
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/envelope.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/envelope.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/envelope.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: PCM data envelope analysis
- last mod: $Id: envelope.c 8921 2005-02-14 23:03:43Z msmith $
+ last mod: $Id: envelope.c 13577 2007-08-20 10:04:37Z erikd $
********************************************************************/
@@ -91,8 +91,7 @@
vorbis_info_psy_global *gi,
float *data,
envelope_band *bands,
- envelope_filter_state *filters,
- long pos){
+ envelope_filter_state *filters){
long n=ve->winlength;
int ret=0;
long i,j;
@@ -240,7 +239,7 @@
for(i=0;i<ve->ch;i++){
float *pcm=v->pcm[i]+ve->searchstep*(j);
- ret|=_ve_amp(ve,gi,pcm,ve->band,ve->filter+i*VE_BANDS,j);
+ ret|=_ve_amp(ve,gi,pcm,ve->band,ve->filter+i*VE_BANDS);
}
ve->mark[j+VE_POST]=0;
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/envelope.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/envelope.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/envelope.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: PCM data envelope analysis and manipulation
- last mod: $Id: envelope.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: envelope.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/floor0.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/floor0.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/floor0.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: floor backend 0 implementation
- last mod: $Id: floor0.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: floor0.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/floor1.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/floor1.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/floor1.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: floor backend 1 implementation
- last mod: $Id: floor1.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: floor1.c 13578 2007-08-20 10:44:04Z erikd $
********************************************************************/
@@ -30,24 +30,6 @@
#define floor1_rangedB 140 /* floor 1 fixed at -140dB to 0dB range */
-typedef struct {
- int sorted_index[VIF_POSIT+2];
- int forward_index[VIF_POSIT+2];
- int reverse_index[VIF_POSIT+2];
-
- int hineighbor[VIF_POSIT];
- int loneighbor[VIF_POSIT];
- int posts;
-
- int n;
- int quant_q;
- vorbis_info_floor1 *vi;
-
- long phrasebits;
- long postbits;
- long frames;
-} vorbis_look_floor1;
-
typedef struct lsfit_acc{
long x0;
long x1;
@@ -358,7 +340,7 @@
0.82788260F, 0.88168307F, 0.9389798F, 1.F,
};
-static void render_line(int x0,int x1,int y0,int y1,float *d){
+static void render_line(int n, int x0,int x1,int y0,int y1,float *d){
int dy=y1-y0;
int adx=x1-x0;
int ady=abs(dy);
@@ -370,8 +352,12 @@
ady-=abs(base*adx);
- d[x]*=FLOOR1_fromdB_LOOKUP[y];
- while(++x<x1){
+ if(n>x1)n=x1;
+
+ if(x<n)
+ d[x]*=FLOOR1_fromdB_LOOKUP[y];
+
+ while(++x<n){
err=err+ady;
if(err>=adx){
err-=adx;
@@ -413,7 +399,6 @@
int x0, int x1,lsfit_acc *a,
int n,vorbis_info_floor1 *info){
long i;
- int quantized=vorbis_dBquant(flr+x0);
long xa=0,ya=0,x2a=0,y2a=0,xya=0,na=0, xb=0,yb=0,x2b=0,y2b=0,xyb=0,nb=0;
@@ -591,8 +576,6 @@
return (A[pos]+B[pos])>>1;
}
-static int seq=0;
-
int *floor1_fit(vorbis_block *vb,vorbis_look_floor1 *look,
const float *logmdct, /* in */
const float *logmask){
@@ -763,7 +746,6 @@
long i,j;
vorbis_info_floor1 *info=look->vi;
- long n=look->n;
long posts=look->posts;
codec_setup_info *ci=vb->vd->vi->codec_setup;
int out[VIF_POSIT+2];
@@ -1068,7 +1050,7 @@
hy*=info->mult;
hx=info->postlist[current];
- render_line(lx,hx,ly,hy,out);
+ render_line(n,lx,hx,ly,hy,out);
lx=hx;
ly=hy;
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/highlevel.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/highlevel.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/highlevel.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: highlevel encoder setup struct seperated out for vorbisenc clarity
- last mod: $Id: highlevel.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: highlevel.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/info.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/info.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/info.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2003 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: maintain the info structure, info <-> header packets
- last mod: $Id: info.c 9513 2005-06-26 18:36:49Z giles $
+ last mod: $Id: info.c 14984 2008-05-31 21:13:48Z xiphmont $
********************************************************************/
@@ -42,7 +42,7 @@
return(ret);
}
-static void _v_writestring(oggpack_buffer *o,char *s, int bytes){
+static void _v_writestring(oggpack_buffer *o,const char *s, int bytes){
while(bytes--){
oggpack_write(o,*s++,8);
@@ -59,7 +59,7 @@
memset(vc,0,sizeof(*vc));
}
-void vorbis_comment_add(vorbis_comment *vc,char *comment){
+void vorbis_comment_add(vorbis_comment *vc,const char *comment){
vc->user_comments=_ogg_realloc(vc->user_comments,
(vc->comments+2)*sizeof(*vc->user_comments));
vc->comment_lengths=_ogg_realloc(vc->comment_lengths,
@@ -71,7 +71,7 @@
vc->user_comments[vc->comments]=NULL;
}
-void vorbis_comment_add_tag(vorbis_comment *vc, char *tag, char *contents){
+void vorbis_comment_add_tag(vorbis_comment *vc, const char *tag, const char *contents){
char *comment=alloca(strlen(tag)+strlen(contents)+2); /* +2 for = and \0 */
strcpy(comment, tag);
strcat(comment, "=");
@@ -91,7 +91,7 @@
return 0;
}
-char *vorbis_comment_query(vorbis_comment *vc, char *tag, int count){
+char *vorbis_comment_query(vorbis_comment *vc, const char *tag, int count){
long i;
int found = 0;
int taglen = strlen(tag)+1; /* +1 for the = we append */
@@ -112,7 +112,7 @@
return NULL; /* didn't find anything */
}
-int vorbis_comment_query_count(vorbis_comment *vc, char *tag){
+int vorbis_comment_query_count(vorbis_comment *vc, const char *tag){
int i,count=0;
int taglen = strlen(tag)+1; /* +1 for the = we append */
char *fulltag = alloca(taglen+1);
@@ -130,16 +130,18 @@
void vorbis_comment_clear(vorbis_comment *vc){
if(vc){
long i;
- for(i=0;i<vc->comments;i++)
- if(vc->user_comments[i])_ogg_free(vc->user_comments[i]);
- if(vc->user_comments)_ogg_free(vc->user_comments);
- if(vc->comment_lengths)_ogg_free(vc->comment_lengths);
+ if(vc->user_comments){
+ for(i=0;i<vc->comments;i++)
+ if(vc->user_comments[i])_ogg_free(vc->user_comments[i]);
+ _ogg_free(vc->user_comments);
+ }
+ if(vc->comment_lengths)_ogg_free(vc->comment_lengths);
if(vc->vendor)_ogg_free(vc->vendor);
+ memset(vc,0,sizeof(*vc));
}
- memset(vc,0,sizeof(*vc));
}
-/* blocksize 0 is guaranteed to be short, 1 is guarantted to be long.
+/* blocksize 0 is guaranteed to be short, 1 is guaranteed to be long.
They may be equal, but short will never ge greater than long */
int vorbis_info_blocksize(vorbis_info *vi,int zo){
codec_setup_info *ci = vi->codec_setup;
@@ -162,14 +164,23 @@
if(ci->mode_param[i])_ogg_free(ci->mode_param[i]);
for(i=0;i<ci->maps;i++) /* unpack does the range checking */
- _mapping_P[ci->map_type[i]]->free_info(ci->map_param[i]);
+ if(ci->map_param[i]) /* this may be cleaning up an aborted
+ unpack, in which case the below type
+ cannot be trusted */
+ _mapping_P[ci->map_type[i]]->free_info(ci->map_param[i]);
for(i=0;i<ci->floors;i++) /* unpack does the range checking */
- _floor_P[ci->floor_type[i]]->free_info(ci->floor_param[i]);
+ if(ci->floor_param[i]) /* this may be cleaning up an aborted
+ unpack, in which case the below type
+ cannot be trusted */
+ _floor_P[ci->floor_type[i]]->free_info(ci->floor_param[i]);
for(i=0;i<ci->residues;i++) /* unpack does the range checking */
- _residue_P[ci->residue_type[i]]->free_info(ci->residue_param[i]);
-
+ if(ci->residue_param[i]) /* this may be cleaning up an aborted
+ unpack, in which case the below type
+ cannot be trusted */
+ _residue_P[ci->residue_type[i]]->free_info(ci->residue_param[i]);
+
for(i=0;i<ci->books;i++){
if(ci->book_param[i]){
/* knows if the book was not alloced */
@@ -211,9 +222,10 @@
if(vi->rate<1)goto err_out;
if(vi->channels<1)goto err_out;
- if(ci->blocksizes[0]<8)goto err_out;
+ if(ci->blocksizes[0]<64)goto err_out;
if(ci->blocksizes[1]<ci->blocksizes[0])goto err_out;
-
+ if(ci->blocksizes[1]>8192)goto err_out;
+
if(oggpack_read(opb,1)!=1)goto err_out; /* EOP check */
return(0);
@@ -226,17 +238,21 @@
int i;
int vendorlen=oggpack_read(opb,32);
if(vendorlen<0)goto err_out;
+ if(vendorlen+8>opb->storage)goto err_out;
vc->vendor=_ogg_calloc(vendorlen+1,1);
_v_readstring(opb,vc->vendor,vendorlen);
- vc->comments=oggpack_read(opb,32);
- if(vc->comments<0)goto err_out;
+ i=oggpack_read(opb,32);
+ if(i<0)goto err_out;
+ if(4*i+oggpack_bytes(opb)>opb->storage)goto err_out;
+ vc->comments=i;
vc->user_comments=_ogg_calloc(vc->comments+1,sizeof(*vc->user_comments));
vc->comment_lengths=_ogg_calloc(vc->comments+1, sizeof(*vc->comment_lengths));
for(i=0;i<vc->comments;i++){
int len=oggpack_read(opb,32);
if(len<0)goto err_out;
- vc->comment_lengths[i]=len;
+ if(len+oggpack_bytes(opb)>opb->storage)goto err_out;
+ vc->comment_lengths[i]=len;
vc->user_comments[i]=_ogg_calloc(len+1,1);
_v_readstring(opb,vc->user_comments[i],len);
}
@@ -328,6 +344,31 @@
return(OV_EBADHEADER);
}
+/* Is this packet a vorbis ID header? */
+int vorbis_synthesis_idheader(ogg_packet *op){
+ oggpack_buffer opb;
+ char buffer[6];
+
+ if(op){
+ oggpack_readinit(&opb,op->packet,op->bytes);
+
+ if(!op->b_o_s)
+ return(0); /* Not the initial packet */
+
+ if(oggpack_read(&opb,8) != 1)
+ return 0; /* not an ID header */
+
+ memset(buffer,0,6);
+ _v_readstring(&opb,buffer,6);
+ if(memcmp(buffer,"vorbis",6))
+ return 0; /* not vorbis */
+
+ return 1;
+ }
+
+ return 0;
+}
+
/* The Vorbis header is in three packets; the initial small packet in
the first page that identifies basic parameters, a second packet
with bitstream comments and a third packet that holds the
@@ -416,7 +457,7 @@
}
static int _vorbis_pack_comment(oggpack_buffer *opb,vorbis_comment *vc){
- char temp[]="Xiph.Org libVorbis I 20050304";
+ char temp[]="Xiph.Org libVorbis I 20080501";
int bytes = strlen(temp);
/* preamble */
@@ -591,12 +632,14 @@
memset(op_comm,0,sizeof(*op_comm));
memset(op_code,0,sizeof(*op_code));
- if(b->header)_ogg_free(b->header);
- if(b->header1)_ogg_free(b->header1);
- if(b->header2)_ogg_free(b->header2);
- b->header=NULL;
- b->header1=NULL;
- b->header2=NULL;
+ if(b){
+ if(b->header)_ogg_free(b->header);
+ if(b->header1)_ogg_free(b->header1);
+ if(b->header2)_ogg_free(b->header2);
+ b->header=NULL;
+ b->header1=NULL;
+ b->header2=NULL;
+ }
return(ret);
}
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: lookup based functions
- last mod: $Id: lookup.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: lookup.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: lookup based functions
- last mod: $Id: lookup.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: lookup.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup_data.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup_data.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookup_data.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: lookup data; generated by lookups.pl; edit there
- last mod: $Id: lookup_data.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: lookup_data.h 13631 2007-08-26 01:17:24Z erikd $
********************************************************************/
@@ -98,6 +98,8 @@
#define FROMdB_SHIFT 5
#define FROMdB2_SHIFT 3
#define FROMdB2_MASK 31
+
+#ifdef FLOAT_LOOKUP
static float FROMdB_LOOKUP[FROMdB_LOOKUP_SZ]={
1.f, 0.6309573445f, 0.3981071706f, 0.2511886432f,
0.1584893192f, 0.1f, 0.06309573445f, 0.03981071706f,
@@ -120,6 +122,7 @@
0.7028699885f, 0.6928273125f, 0.6829281272f, 0.6731703824f,
0.6635520573f, 0.6540711597f, 0.6447257262f, 0.6355138211f,
};
+#endif
#ifdef INT_LOOKUP
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookups.pl
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookups.pl 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lookups.pl 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,13 +7,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: lookup data; generated by lookups.pl; edit there
- last mod: $Id: lookups.pl 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: lookups.pl 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lpc.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lpc.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lpc.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: LPC low level routines
- last mod: $Id: lpc.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: lpc.c 13657 2007-08-30 02:40:29Z xiphmont $
********************************************************************/
@@ -62,6 +62,7 @@
double *aut=alloca(sizeof(*aut)*(m+1));
double *lpc=alloca(sizeof(*lpc)*(m));
double error;
+ double epsilon;
int i,j;
/* autocorrelation, p+1 lag coefficients */
@@ -74,14 +75,16 @@
/* Generate lpc coefficients from autocorr values */
- error=aut[0];
-
+ /* set our noise floor to about -100dB */
+ error=aut[0] * (1. + 1e-10);
+ epsilon=1e-9*aut[0]+1e-10;
+
for(i=0;i<m;i++){
double r= -aut[i+1];
- if(error==0){
- memset(lpci,0,m*sizeof(*lpci));
- return 0;
+ if(error<epsilon){
+ memset(lpc+i,0,(m-i)*sizeof(*lpc));
+ goto done;
}
/* Sum up this iteration's reflection coefficient; note that in
@@ -101,11 +104,24 @@
lpc[j]+=r*lpc[i-1-j];
lpc[i-1-j]+=r*tmp;
}
- if(i%2)lpc[j]+=lpc[j]*r;
+ if(i&1)lpc[j]+=lpc[j]*r;
- error*=1.f-r*r;
+ error*=1.-r*r;
+
}
+ done:
+
+ /* slightly damp the filter */
+ {
+ double g = .99;
+ double damp = g;
+ for(j=0;j<m;j++){
+ lpc[j]*=damp;
+ damp*=g;
+ }
+ }
+
for(j=0;j<m;j++)lpci[j]=(float)lpc[j];
/* we need the error value to know how big an impulse to hit the
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lpc.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lpc.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lpc.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: LPC low level routines
- last mod: $Id: lpc.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: lpc.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lsp.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lsp.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lsp.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: LSP (also called LSF) conversion routines
- last mod: $Id: lsp.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: lsp.c 13293 2007-07-24 00:09:47Z xiphmont $
The LSP generation code is taken (with minimal modification and a
few bugfixes) from "On the Computation of the LSP Frequencies" by
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lsp.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lsp.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/lsp.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: LSP (also called LSF) conversion routines
- last mod: $Id: lsp.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: lsp.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mapping0.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mapping0.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mapping0.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: channel mapping 0 implementation
- last mod: $Id: mapping0.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: mapping0.c 13657 2007-08-30 02:40:29Z xiphmont $
********************************************************************/
@@ -229,17 +229,7 @@
#endif
-extern int *floor1_fit(vorbis_block *vb,vorbis_look_floor *look,
- const float *logmdct, /* in */
- const float *logmask);
-extern int *floor1_interpolate_fit(vorbis_block *vb,vorbis_look_floor *look,
- int *A,int *B,
- int del);
-extern int floor1_encode(oggpack_buffer *opb,vorbis_block *vb,
- vorbis_look_floor *look,
- int *post,int *ilogmask);
-
static int mapping0_forward(vorbis_block *vb){
vorbis_dsp_state *vd=vb->vd;
vorbis_info *vi=vd->vi;
@@ -290,22 +280,28 @@
next major model upgrade. */
#if 0
- if(vi->channels==2)
+ if(vi->channels==2){
if(i==0)
_analysis_output("pcmL",seq,pcm,n,0,0,total-n/2);
else
_analysis_output("pcmR",seq,pcm,n,0,0,total-n/2);
+ }else{
+ _analysis_output("pcm",seq,pcm,n,0,0,total-n/2);
+ }
#endif
/* window the PCM data */
_vorbis_apply_window(pcm,b->window,ci->blocksizes,vb->lW,vb->W,vb->nW);
#if 0
- if(vi->channels==2)
+ if(vi->channels==2){
if(i==0)
_analysis_output("windowedL",seq,pcm,n,0,0,total-n/2);
else
_analysis_output("windowedR",seq,pcm,n,0,0,total-n/2);
+ }else{
+ _analysis_output("windowed",seq,pcm,n,0,0,total-n/2);
+ }
#endif
/* transform the PCM data */
@@ -359,6 +355,8 @@
}else{
_analysis_output("fftR",seq,logfft,n/2,1,0,0);
}
+ }else{
+ _analysis_output("fft",seq,logfft,n/2,1,0,0);
}
#endif
@@ -429,6 +427,8 @@
_analysis_output("noiseL",seq,noise,n/2,1,0,0);
else
_analysis_output("noiseR",seq,noise,n/2,1,0,0);
+ }else{
+ _analysis_output("noise",seq,noise,n/2,1,0,0);
}
#endif
@@ -448,6 +448,8 @@
_analysis_output("toneL",seq,tone,n/2,1,0,0);
else
_analysis_output("toneR",seq,tone,n/2,1,0,0);
+ }else{
+ _analysis_output("tone",seq,tone,n/2,1,0,0);
}
#endif
@@ -475,6 +477,8 @@
_analysis_output("aotuvM1_L",seq,aotuv,psy_look->n,1,1,0);
else
_analysis_output("aotuvM1_R",seq,aotuv,psy_look->n,1,1,0);
+ }else{
+ _analysis_output("aotuvM1",seq,aotuv,psy_look->n,1,1,0);
}
}
#endif
@@ -486,6 +490,8 @@
_analysis_output("mask1L",seq,logmask,n/2,1,0,0);
else
_analysis_output("mask1R",seq,logmask,n/2,1,0,0);
+ }else{
+ _analysis_output("mask1",seq,logmask,n/2,1,0,0);
}
#endif
@@ -518,6 +524,8 @@
_analysis_output("mask2L",seq,logmask,n/2,1,0,0);
else
_analysis_output("mask2R",seq,logmask,n/2,1,0,0);
+ }else{
+ _analysis_output("mask2",seq,logmask,n/2,1,0,0);
}
#endif
@@ -536,11 +544,14 @@
logmdct);
#if 0
- if(vi->channels==2)
+ if(vi->channels==2){
if(i==0)
_analysis_output("mask0L",seq,logmask,n/2,1,0,0);
else
_analysis_output("mask0R",seq,logmask,n/2,1,0,0);
+ }else{
+ _analysis_output("mask0",seq,logmask,n/2,1,0,0);
+ }
#endif
floor_posts[i][0]=
@@ -586,8 +597,8 @@
float **couple_bundle=alloca(sizeof(*couple_bundle)*vi->channels);
int *zerobundle=alloca(sizeof(*zerobundle)*vi->channels);
int **sortindex=alloca(sizeof(*sortindex)*vi->channels);
- float **mag_memo;
- int **mag_sort;
+ float **mag_memo=NULL;
+ int **mag_sort=NULL;
if(info->coupling_steps){
mag_memo=_vp_quantize_couple_memo(vb,
@@ -735,7 +746,6 @@
codec_setup_info *ci=vi->codec_setup;
private_state *b=vd->backend_state;
vorbis_info_mapping0 *info=(vorbis_info_mapping0 *)l;
- int hs=ci->halfrate_flag;
int i,j;
long n=vb->pcmend=ci->blocksizes[vb->W];
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/masking.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/masking.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/masking.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: masking curve data for psychoacoustics
- last mod: $Id: masking.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: masking.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mdct.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mdct.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mdct.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,14 +5,14 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: normalized modified discrete cosine transform
power of two length transform only [64 <= n ]
- last mod: $Id: mdct.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: mdct.c 13293 2007-07-24 00:09:47Z xiphmont $
Original algorithm adapted long ago from _The use of multirate filter
banks for coding of high quality digital audio_, by T. Sporer,
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mdct.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mdct.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/mdct.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: modified discrete cosine transform prototypes
- last mod: $Id: mdct.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: mdct.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/misc.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/misc.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/misc.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: miscellaneous prototypes
- last mod: $Id: misc.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: misc.h 14600 2008-03-18 17:41:06Z xiphmont $
********************************************************************/
@@ -29,6 +29,7 @@
#ifdef DEBUG_MALLOC
#define _VDBG_GRAPHFILE "malloc.m"
+#undef _VDBG_GRAPHFILE
extern void *_VDBG_malloc(void *ptr,long bytes,char *file,long line);
extern void _VDBG_free(void *ptr,char *file,long line);
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/floor_all.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/floor_all.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/floor_all.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: key floor settings
- last mod: $Id: floor_all.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: floor_all.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_11.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_11.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_11.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: 11kHz settings
- last mod: $Id: psych_11.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: psych_11.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_16.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_16.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_16.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: 16kHz settings
- last mod: $Id: psych_16.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: psych_16.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
@@ -112,6 +112,13 @@
{-30,-30,-30,-30,-26,-26,-26,-26,-26,-26,-26,-26,-26,-24,-20,-20,-20}}},
};
+static noiseguard _psy_noiseguards_16[4]={
+ {10,10,-1},
+ {10,10,-1},
+ {20,20,-1},
+ {20,20,-1},
+};
+
static double _noise_thresh_16[4]={ .3,.5,.5,.5 };
static int _noise_start_16[3]={ 256,256,9999 };
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_44.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_44.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_44.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: key psychoacoustic settings for 44.1/48kHz
- last mod: $Id: psych_44.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: psych_44.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_8.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_8.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/psych_8.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: 8kHz psychoacoustic settings
- last mod: $Id: psych_8.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: psych_8.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_16.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_16.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_16.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: toplevel residue templates 16/22kHz
- last mod: $Id: residue_16.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: residue_16.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
@@ -21,7 +21,7 @@
{
{0},
{0,0,&_16c0_s_p1_0},
- {0,0,&_16c0_s_p2_0},
+ {0},
{0,0,&_16c0_s_p3_0},
{0,0,&_16c0_s_p4_0},
{0,0,&_16c0_s_p5_0},
@@ -35,7 +35,7 @@
{
{0},
{0,0,&_16c1_s_p1_0},
- {0,0,&_16c1_s_p2_0},
+ {0},
{0,0,&_16c1_s_p3_0},
{0,0,&_16c1_s_p4_0},
{0,0,&_16c1_s_p5_0},
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_44.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_44.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_44.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: toplevel residue templates for 32/44.1/48kHz
- last mod: $Id: residue_44.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: residue_44.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_44u.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_44u.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_44u.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: toplevel residue templates for 32/44.1/48kHz uncoupled
- last mod: $Id: residue_44u.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: residue_44u.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_8.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_8.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/residue_8.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: toplevel residue templates 8/11kHz
- last mod: $Id: residue_8.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: residue_8.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
@@ -22,17 +22,29 @@
static static_bookblock _resbook_8s_0={
{
- {0},{0,0,&_8c0_s_p1_0},{0,0,&_8c0_s_p2_0},{0,0,&_8c0_s_p3_0},
- {0,0,&_8c0_s_p4_0},{0,0,&_8c0_s_p5_0},{0,0,&_8c0_s_p6_0},
- {&_8c0_s_p7_0,&_8c0_s_p7_1},{&_8c0_s_p8_0,&_8c0_s_p8_1},
+ {0},
+ {0,0,&_8c0_s_p1_0},
+ {0},
+ {0,0,&_8c0_s_p3_0},
+ {0,0,&_8c0_s_p4_0},
+ {0,0,&_8c0_s_p5_0},
+ {0,0,&_8c0_s_p6_0},
+ {&_8c0_s_p7_0,&_8c0_s_p7_1},
+ {&_8c0_s_p8_0,&_8c0_s_p8_1},
{&_8c0_s_p9_0,&_8c0_s_p9_1,&_8c0_s_p9_2}
}
};
static static_bookblock _resbook_8s_1={
{
- {0},{0,0,&_8c1_s_p1_0},{0,0,&_8c1_s_p2_0},{0,0,&_8c1_s_p3_0},
- {0,0,&_8c1_s_p4_0},{0,0,&_8c1_s_p5_0},{0,0,&_8c1_s_p6_0},
- {&_8c1_s_p7_0,&_8c1_s_p7_1},{&_8c1_s_p8_0,&_8c1_s_p8_1},
+ {0},
+ {0,0,&_8c1_s_p1_0},
+ {0},
+ {0,0,&_8c1_s_p3_0},
+ {0,0,&_8c1_s_p4_0},
+ {0,0,&_8c1_s_p5_0},
+ {0,0,&_8c1_s_p6_0},
+ {&_8c1_s_p7_0,&_8c1_s_p7_1},
+ {&_8c1_s_p8_0,&_8c1_s_p8_1},
{&_8c1_s_p9_0,&_8c1_s_p9_1,&_8c1_s_p9_2}
}
};
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_11.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_11.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_11.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: 11kHz settings
- last mod: $Id: setup_11.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: setup_11.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_16.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_16.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_16.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: 16kHz settings
- last mod: $Id: setup_16.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: setup_16.h 13651 2007-08-29 11:25:58Z xiphmont $
********************************************************************/
@@ -65,7 +65,7 @@
_vp_tonemask_adj_16,
_vp_tonemask_adj_16,
- _psy_noiseguards_8,
+ _psy_noiseguards_16,
_psy_noisebias_16_impulse,
_psy_noisebias_16_short,
_psy_noisebias_16_short,
@@ -116,7 +116,7 @@
_vp_tonemask_adj_16,
_vp_tonemask_adj_16,
- _psy_noiseguards_8,
+ _psy_noiseguards_16,
_psy_noisebias_16_impulse,
_psy_noisebias_16_short,
_psy_noisebias_16_short,
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_22.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_22.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_22.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: 22kHz settings
- last mod: $Id: setup_22.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: setup_22.h 13644 2007-08-28 18:25:49Z xiphmont $
********************************************************************/
@@ -44,7 +44,7 @@
_vp_tonemask_adj_16,
_vp_tonemask_adj_16,
- _psy_noiseguards_8,
+ _psy_noiseguards_16,
_psy_noisebias_16_impulse,
_psy_noisebias_16_short,
_psy_noisebias_16_short,
@@ -95,7 +95,7 @@
_vp_tonemask_adj_16,
_vp_tonemask_adj_16,
- _psy_noiseguards_8,
+ _psy_noiseguards_16,
_psy_noisebias_16_impulse,
_psy_noisebias_16_short,
_psy_noisebias_16_short,
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_32.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_32.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_32.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: toplevel settings for 32kHz
- last mod: $Id: setup_32.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: setup_32.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_44.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_44.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_44.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: toplevel settings for 44.1/48kHz
- last mod: $Id: setup_44.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: setup_44.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_44u.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_44u.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_44u.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: toplevel settings for 44.1/48kHz uncoupled modes
- last mod: $Id: setup_44u.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: setup_44u.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_8.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_8.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_8.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: 8kHz settings
- last mod: $Id: setup_8.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: setup_8.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_X.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_X.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/modes/setup_X.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: catch-all toplevel settings for q modes only
- last mod: $Id: setup_X.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: setup_X.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/os.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/os.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/os.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,13 +7,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: #ifdef jail to whip a few platforms into the UNIX ideal.
- last mod: $Id: os.h 7543 2004-08-13 01:48:19Z conrad $
+ last mod: $Id: os.h 14939 2008-05-22 18:24:17Z msmith $
********************************************************************/
@@ -115,9 +115,10 @@
}
#endif
-//ZEN::: I added !defined(WINCE) here, since WIN32 isn't necessarily x86
-// though some WINCE is x86, so it's not really a perfect solution
-#if defined(_WIN32) && !defined(__GNUC__) && !defined(__BORLANDC__) && !defined(WINCE)
+
+/* MSVC inline assembly. 32 bit only; inline ASM isn't implemented in the 64 bit
+ * compiler */
+#if defined(_MSC_VER) && !defined(_WIN64)
# define VORBIS_FPU_CONTROL
typedef ogg_int16_t vorbis_fpu_control;
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psy.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psy.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psy.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: psychoacoustics not including preecho
- last mod: $Id: psy.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: psy.c 13578 2007-08-20 10:44:04Z erikd $
********************************************************************/
@@ -553,7 +553,10 @@
int i;
int lo, hi;
- float R, A, B, D;
+ float R=0.f;
+ float A=0.f;
+ float B=0.f;
+ float D=1.f;
float w, x, y;
tN = tX = tXX = tY = tXY = 0.f;
@@ -1214,7 +1217,6 @@
int i,j,n=p->n, de=0.3*p->m_val;
int limit=g->coupling_pointlimit[p->vi->blockflag][PACKETBLOBS/2];
- int start=p->vi->normal_start;
for(i=0; i<vi->coupling_steps; i++){
/* for(j=start; j<limit; j++){} // ???*/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psy.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psy.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psy.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: random psychoacoustics (not including preecho)
- last mod: $Id: psy.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: psy.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psytune.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psytune.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/psytune.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,17 +5,20 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: simple utility that runs audio through the psychoacoustics
without encoding
- last mod: $Id: psytune.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: psytune.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
+/* NB: this is dead code, retained purely for doc and reference value
+ don't try to compile it */
+
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/registry.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/registry.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/registry.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: registry for time, floor, res backends and channel mappings
- last mod: $Id: registry.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: registry.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/registry.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/registry.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/registry.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: registry for time, floor, res backends and channel mappings
- last mod: $Id: registry.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: registry.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/res0.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/res0.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/res0.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: residue backend 0, 1 and 2 implementation
- last mod: $Id: res0.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: res0.c 14598 2008-03-18 15:39:43Z xiphmont $
********************************************************************/
@@ -223,6 +223,20 @@
for(j=0;j<acc;j++)
if(info->booklist[j]>=ci->books)goto errout;
+ /* verify the phrasebook is not specifying an impossible or
+ inconsistent partitioning scheme. */
+ {
+ int entries = ci->book_param[info->groupbook]->entries;
+ int dim = ci->book_param[info->groupbook]->dim;
+ int partvals = 1;
+ while(dim>0){
+ partvals *= info->partitions;
+ if(partvals > entries) goto errout;
+ dim--;
+ }
+ if(partvals != entries) goto errout;
+ }
+
return(info);
errout:
res0_free_info(info);
@@ -263,7 +277,7 @@
}
}
- look->partvals=rint(pow((float)look->parts,(float)dim));
+ look->partvals=look->phrasebook->entries;
look->stages=maxstage;
look->decodemap=_ogg_malloc(look->partvals*sizeof(*look->decodemap));
for(j=0;j<look->partvals;j++){
@@ -336,7 +350,7 @@
}
}
- {
+ if(best>-1){
float *ptr=book->valuelist+best*dim;
for(i=0;i<dim;i++)
*a++ -= *ptr++;
@@ -355,10 +369,12 @@
int entry=local_book_besterror(book,vec+i*dim);
#ifdef TRAIN_RES
- acc[entry]++;
+ if(entry>0)
+ acc[entry]++;
#endif
-
+
bits+=vorbis_book_encode(book,entry,opb);
+
}
return(bits);
@@ -370,7 +386,6 @@
vorbis_look_residue0 *look=(vorbis_look_residue0 *)vl;
vorbis_info_residue0 *info=look->info;
vorbis_info *vi=vb->vd->vi;
- codec_setup_info *ci=vi->codec_setup;
/* move all this setup out later */
int samples_per_partition=info->grouping;
@@ -380,11 +395,11 @@
int partvals=n/samples_per_partition;
long **partword=_vorbis_block_alloc(vb,ch*sizeof(*partword));
float scale=100./samples_per_partition;
-
+
/* we find the partition type for each partition of each
channel. We'll go back and do the interleaved encoding in a
bit. For now, clarity */
-
+
for(i=0;i<ch;i++){
partword[i]=_vorbis_block_alloc(vb,n/samples_per_partition*sizeof(*partword[i]));
memset(partword[i],0,n/samples_per_partition*sizeof(*partword[i]));
@@ -409,12 +424,12 @@
partword[j][i]=k;
}
}
-
+
#ifdef TRAIN_RESAUX
{
FILE *of;
char buffer[80];
-
+
for(i=0;i<ch;i++){
sprintf(buffer,"resaux_%d.vqd",look->train_seq);
of=fopen(buffer,"a");
@@ -426,7 +441,7 @@
}
#endif
look->frames++;
-
+
return(partword);
}
@@ -446,7 +461,7 @@
int partvals=n/samples_per_partition;
long **partword=_vorbis_block_alloc(vb,sizeof(*partword));
-
+
#if defined(TRAIN_RES) || defined (TRAIN_RESAUX)
FILE *of;
char buffer[80];
@@ -454,7 +469,7 @@
partword[0]=_vorbis_block_alloc(vb,n*ch/samples_per_partition*sizeof(*partword[0]));
memset(partword[0],0,n*ch/samples_per_partition*sizeof(*partword[0]));
-
+
for(i=0,l=info->begin/ch;i<partvals;i++){
float magmax=0.f;
float angmax=0.f;
@@ -462,16 +477,16 @@
if(fabs(in[0][l])>magmax)magmax=fabs(in[0][l]);
for(k=1;k<ch;k++)
if(fabs(in[k][l])>angmax)angmax=fabs(in[k][l]);
- l++;
+ l++;
}
-
+
for(j=0;j<possible_partitions-1;j++)
if(magmax<=info->classmetric1[j] &&
angmax<=info->classmetric2[j])
break;
-
+
partword[0][i]=j;
-
+
}
#ifdef TRAIN_RESAUX
@@ -482,9 +497,9 @@
fprintf(of,"\n");
fclose(of);
#endif
-
+
look->frames++;
-
+
return(partword);
}
@@ -509,15 +524,15 @@
int partvals=n/samples_per_partition;
long resbits[128];
long resvals[128];
-
+
#ifdef TRAIN_RES
for(i=0;i<ch;i++)
- for(j=info->begin;j<info->end;j++){
+ for(j=info->begin;j<end;j++){
if(in[i][j]>look->tmax)look->tmax=in[i][j];
if(in[i][j]<look->tmin)look->tmin=in[i][j];
}
#endif
-
+
memset(resbits,0,sizeof(resbits));
memset(resvals,0,sizeof(resvals));
@@ -525,11 +540,11 @@
words for a partition per channel until we've written all the
residual words for that partition word. Then write the next
partition channel words... */
-
+
for(s=0;s<look->stages;s++){
-
+
for(i=0;i<partvals;){
-
+
/* first we encode a partition codeword for each channel */
if(s==0){
for(j=0;j<ch;j++){
@@ -539,7 +554,7 @@
if(i+k<partvals)
val+=partword[j][i+k];
}
-
+
/* training hack */
if(val<look->phrasebook->entries)
look->phrasebits+=vorbis_book_encode(look->phrasebook,val,opb);
@@ -547,14 +562,14 @@
else
fprintf(stderr,"!");
#endif
-
+
}
}
/* now we encode interleaved residual values for the partitions */
for(k=0;k<partitions_per_word && i<partvals;k++,i++){
long offset=i*samples_per_partition+info->begin;
-
+
for(j=0;j<ch;j++){
if(s==0)resvals[partword[j][i]]+=samples_per_partition;
if(info->secondstages[partword[j][i]]&(1<<s)){
@@ -562,7 +577,7 @@
if(statebook){
int ret;
long *accumulator=NULL;
-
+
#ifdef TRAIN_RES
accumulator=look->training_data[s][partword[j][i]];
{
@@ -579,7 +594,7 @@
ret=encode(opb,in[j]+offset,samples_per_partition,
statebook,accumulator);
-
+
look->postbits+=ret;
resbits[partword[j][i]]+=ret;
}
@@ -588,19 +603,20 @@
}
}
}
-
+
/*{
long total=0;
long totalbits=0;
fprintf(stderr,"%d :: ",vb->mode);
for(k=0;k<possible_partitions;k++){
- fprintf(stderr,"%ld/%1.2g, ",resvals[k],(float)resbits[k]/resvals[k]);
- total+=resvals[k];
- totalbits+=resbits[k];
- }
+ fprintf(stderr,"%ld/%1.2g, ",resvals[k],(float)resbits[k]/resvals[k]);
+ total+=resvals[k];
+ totalbits+=resbits[k];
+ }
fprintf(stderr,":: %ld:%1.2g\n",total,(double)totalbits/total);
}*/
+
return(0);
}
@@ -617,45 +633,49 @@
/* move all this setup out later */
int samples_per_partition=info->grouping;
int partitions_per_word=look->phrasebook->dim;
- int n=info->end-info->begin;
+ int max=vb->pcmend>>1;
+ int end=(info->end<max?info->end:max);
+ int n=end-info->begin;
- int partvals=n/samples_per_partition;
- int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
- int ***partword=alloca(ch*sizeof(*partword));
-
- for(j=0;j<ch;j++)
- partword[j]=_vorbis_block_alloc(vb,partwords*sizeof(*partword[j]));
-
- for(s=0;s<look->stages;s++){
-
- /* each loop decodes on partition codeword containing
- partitions_pre_word partitions */
- for(i=0,l=0;i<partvals;l++){
- if(s==0){
- /* fetch the partition word for each channel */
- for(j=0;j<ch;j++){
- int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
- if(temp==-1)goto eopbreak;
- partword[j][l]=look->decodemap[temp];
- if(partword[j][l]==NULL)goto errout;
+ if(n>0){
+ int partvals=n/samples_per_partition;
+ int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
+ int ***partword=alloca(ch*sizeof(*partword));
+
+ for(j=0;j<ch;j++)
+ partword[j]=_vorbis_block_alloc(vb,partwords*sizeof(*partword[j]));
+
+ for(s=0;s<look->stages;s++){
+
+ /* each loop decodes on partition codeword containing
+ partitions_per_word partitions */
+ for(i=0,l=0;i<partvals;l++){
+ if(s==0){
+ /* fetch the partition word for each channel */
+ for(j=0;j<ch;j++){
+ int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
+
+ if(temp==-1)goto eopbreak;
+ partword[j][l]=look->decodemap[temp];
+ if(partword[j][l]==NULL)goto errout;
+ }
}
- }
-
- /* now we decode residual values for the partitions */
- for(k=0;k<partitions_per_word && i<partvals;k++,i++)
- for(j=0;j<ch;j++){
- long offset=info->begin+i*samples_per_partition;
- if(info->secondstages[partword[j][l][k]]&(1<<s)){
- codebook *stagebook=look->partbooks[partword[j][l][k]][s];
- if(stagebook){
- if(decodepart(stagebook,in[j]+offset,&vb->opb,
- samples_per_partition)==-1)goto eopbreak;
+
+ /* now we decode residual values for the partitions */
+ for(k=0;k<partitions_per_word && i<partvals;k++,i++)
+ for(j=0;j<ch;j++){
+ long offset=info->begin+i*samples_per_partition;
+ if(info->secondstages[partword[j][l][k]]&(1<<s)){
+ codebook *stagebook=look->partbooks[partword[j][l][k]][s];
+ if(stagebook){
+ if(decodepart(stagebook,in[j]+offset,&vb->opb,
+ samples_per_partition)==-1)goto eopbreak;
+ }
}
}
- }
- }
+ }
+ }
}
-
errout:
eopbreak:
return(0);
@@ -833,41 +853,44 @@
/* move all this setup out later */
int samples_per_partition=info->grouping;
int partitions_per_word=look->phrasebook->dim;
- int n=info->end-info->begin;
+ int max=(vb->pcmend*ch)>>1;
+ int end=(info->end<max?info->end:max);
+ int n=end-info->begin;
- int partvals=n/samples_per_partition;
- int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
- int **partword=_vorbis_block_alloc(vb,partwords*sizeof(*partword));
-
- for(i=0;i<ch;i++)if(nonzero[i])break;
- if(i==ch)return(0); /* no nonzero vectors */
-
- for(s=0;s<look->stages;s++){
- for(i=0,l=0;i<partvals;l++){
-
- if(s==0){
- /* fetch the partition word */
- int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
- if(temp==-1)goto eopbreak;
- partword[l]=look->decodemap[temp];
- if(partword[l]==NULL)goto errout;
- }
-
- /* now we decode residual values for the partitions */
- for(k=0;k<partitions_per_word && i<partvals;k++,i++)
- if(info->secondstages[partword[l][k]]&(1<<s)){
- codebook *stagebook=look->partbooks[partword[l][k]][s];
-
- if(stagebook){
- if(vorbis_book_decodevv_add(stagebook,in,
- i*samples_per_partition+info->begin,ch,
- &vb->opb,samples_per_partition)==-1)
- goto eopbreak;
+ if(n>0){
+ int partvals=n/samples_per_partition;
+ int partwords=(partvals+partitions_per_word-1)/partitions_per_word;
+ int **partword=_vorbis_block_alloc(vb,partwords*sizeof(*partword));
+
+ for(i=0;i<ch;i++)if(nonzero[i])break;
+ if(i==ch)return(0); /* no nonzero vectors */
+
+ for(s=0;s<look->stages;s++){
+ for(i=0,l=0;i<partvals;l++){
+
+ if(s==0){
+ /* fetch the partition word */
+ int temp=vorbis_book_decode(look->phrasebook,&vb->opb);
+ if(temp==-1)goto eopbreak;
+ partword[l]=look->decodemap[temp];
+ if(partword[l]==NULL)goto errout;
+ }
+
+ /* now we decode residual values for the partitions */
+ for(k=0;k<partitions_per_word && i<partvals;k++,i++)
+ if(info->secondstages[partword[l][k]]&(1<<s)){
+ codebook *stagebook=look->partbooks[partword[l][k]][s];
+
+ if(stagebook){
+ if(vorbis_book_decodevv_add(stagebook,in,
+ i*samples_per_partition+info->begin,ch,
+ &vb->opb,samples_per_partition)==-1)
+ goto eopbreak;
+ }
}
- }
- }
+ }
+ }
}
-
errout:
eopbreak:
return(0);
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/scales.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/scales.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/scales.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: linear scale -> dB, Bark and Mel scales
- last mod: $Id: scales.h 7263 2004-07-23 01:23:40Z msmith $
+ last mod: $Id: scales.h 13629 2007-08-26 00:24:57Z erikd $
********************************************************************/
@@ -21,25 +21,34 @@
#include <math.h>
#include "os.h"
+#ifdef _MSC_VER
+/* MS Visual Studio doesn't have C99 inline keyword. */
+#define inline __inline
+#endif
+
/* 20log10(x) */
#define VORBIS_IEEE_FLOAT32 1
#ifdef VORBIS_IEEE_FLOAT32
-static float unitnorm(float x){
- ogg_uint32_t *ix=(ogg_uint32_t *)&x;
- *ix=(*ix&0x80000000UL)|(0x3f800000UL);
- return(x);
+static inline float unitnorm(float x){
+ union {
+ ogg_uint32_t i;
+ float f;
+ } ix;
+ ix.f = x;
+ ix.i = (ix.i & 0x80000000U) | (0x3f800000U);
+ return ix.f;
}
-static float FABS(float *x){
- ogg_uint32_t *ix=(ogg_uint32_t *)x;
- *ix&=0x7fffffffUL;
- return(*x);
-}
-
/* Segher was off (too high) by ~ .3 decibel. Center the conversion correctly. */
-static float todB(const float *x){
- return (float)((*(ogg_int32_t *)x)&0x7fffffff) * 7.17711438e-7f -764.6161886f;
+static inline float todB(const float *x){
+ union {
+ ogg_uint32_t i;
+ float f;
+ } ix;
+ ix.f = *x;
+ ix.i = ix.i&0x7fffffff;
+ return (float)(ix.i * 7.17711438e-7f -764.6161886f);
}
#define todB_nn(x) todB(x)
@@ -51,8 +60,6 @@
return(1.f);
}
-#define FABS(x) fabs(*(x))
-
#define todB(x) (*(x)==0?-400.f:log(*(x)**(x))*4.34294480f)
#define todB_nn(x) (*(x)==0.f?-400.f:log(*(x))*8.6858896f)
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/sharedbook.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/sharedbook.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/sharedbook.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: basic shared codebook operations
- last mod: $Id: sharedbook.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: sharedbook.c 14811 2008-04-28 21:42:52Z xiphmont $
********************************************************************/
@@ -124,7 +124,14 @@
}else
if(sparsecount==0)count++;
}
-
+
+ /* sanity check the huffman tree; an underpopulated tree must be rejected. */
+ for(i=1;i<33;i++)
+ if(marker[i] & (0xffffffffUL>>(32-i))){
+ _ogg_free(r);
+ return(NULL);
+ }
+
/* bitreverse the words because our bitwise packer/unpacker is LSb
endian */
for(i=0,count=0;i<n;i++){
@@ -329,30 +336,31 @@
c->used_entries=n;
c->dim=s->dim;
- /* two different remappings go on here.
+ if(n>0){
+
+ /* two different remappings go on here.
+
+ First, we collapse the likely sparse codebook down only to
+ actually represented values/words. This collapsing needs to be
+ indexed as map-valueless books are used to encode original entry
+ positions as integers.
+
+ Second, we reorder all vectors, including the entry index above,
+ by sorted bitreversed codeword to allow treeless decode. */
- First, we collapse the likely sparse codebook down only to
- actually represented values/words. This collapsing needs to be
- indexed as map-valueless books are used to encode original entry
- positions as integers.
-
- Second, we reorder all vectors, including the entry index above,
- by sorted bitreversed codeword to allow treeless decode. */
-
- {
/* perform sort */
ogg_uint32_t *codes=_make_words(s->lengthlist,s->entries,c->used_entries);
ogg_uint32_t **codep=alloca(sizeof(*codep)*n);
if(codes==NULL)goto err_out;
-
+
for(i=0;i<n;i++){
codes[i]=bitreverse(codes[i]);
codep[i]=codes+i;
}
-
+
qsort(codep,n,sizeof(*codep),sort32a);
-
+
sortindex=alloca(n*sizeof(*sortindex));
c->codelist=_ogg_malloc(n*sizeof(*c->codelist));
/* the index is a reverse index */
@@ -364,66 +372,66 @@
for(i=0;i<n;i++)
c->codelist[sortindex[i]]=codes[i];
_ogg_free(codes);
- }
-
- c->valuelist=_book_unquantize(s,n,sortindex);
- c->dec_index=_ogg_malloc(n*sizeof(*c->dec_index));
-
- for(n=0,i=0;i<s->entries;i++)
- if(s->lengthlist[i]>0)
- c->dec_index[sortindex[n++]]=i;
- c->dec_codelengths=_ogg_malloc(n*sizeof(*c->dec_codelengths));
- for(n=0,i=0;i<s->entries;i++)
- if(s->lengthlist[i]>0)
- c->dec_codelengths[sortindex[n++]]=s->lengthlist[i];
- c->dec_firsttablen=_ilog(c->used_entries)-4; /* this is magic */
- if(c->dec_firsttablen<5)c->dec_firsttablen=5;
- if(c->dec_firsttablen>8)c->dec_firsttablen=8;
-
- tabn=1<<c->dec_firsttablen;
- c->dec_firsttable=_ogg_calloc(tabn,sizeof(*c->dec_firsttable));
- c->dec_maxlength=0;
-
- for(i=0;i<n;i++){
- if(c->dec_maxlength<c->dec_codelengths[i])
- c->dec_maxlength=c->dec_codelengths[i];
- if(c->dec_codelengths[i]<=c->dec_firsttablen){
- ogg_uint32_t orig=bitreverse(c->codelist[i]);
- for(j=0;j<(1<<(c->dec_firsttablen-c->dec_codelengths[i]));j++)
- c->dec_firsttable[orig|(j<<c->dec_codelengths[i])]=i+1;
+ c->valuelist=_book_unquantize(s,n,sortindex);
+ c->dec_index=_ogg_malloc(n*sizeof(*c->dec_index));
+
+ for(n=0,i=0;i<s->entries;i++)
+ if(s->lengthlist[i]>0)
+ c->dec_index[sortindex[n++]]=i;
+
+ c->dec_codelengths=_ogg_malloc(n*sizeof(*c->dec_codelengths));
+ for(n=0,i=0;i<s->entries;i++)
+ if(s->lengthlist[i]>0)
+ c->dec_codelengths[sortindex[n++]]=s->lengthlist[i];
+
+ c->dec_firsttablen=_ilog(c->used_entries)-4; /* this is magic */
+ if(c->dec_firsttablen<5)c->dec_firsttablen=5;
+ if(c->dec_firsttablen>8)c->dec_firsttablen=8;
+
+ tabn=1<<c->dec_firsttablen;
+ c->dec_firsttable=_ogg_calloc(tabn,sizeof(*c->dec_firsttable));
+ c->dec_maxlength=0;
+
+ for(i=0;i<n;i++){
+ if(c->dec_maxlength<c->dec_codelengths[i])
+ c->dec_maxlength=c->dec_codelengths[i];
+ if(c->dec_codelengths[i]<=c->dec_firsttablen){
+ ogg_uint32_t orig=bitreverse(c->codelist[i]);
+ for(j=0;j<(1<<(c->dec_firsttablen-c->dec_codelengths[i]));j++)
+ c->dec_firsttable[orig|(j<<c->dec_codelengths[i])]=i+1;
+ }
}
- }
-
- /* now fill in 'unused' entries in the firsttable with hi/lo search
- hints for the non-direct-hits */
- {
- ogg_uint32_t mask=0xfffffffeUL<<(31-c->dec_firsttablen);
- long lo=0,hi=0;
-
- for(i=0;i<tabn;i++){
- ogg_uint32_t word=i<<(32-c->dec_firsttablen);
- if(c->dec_firsttable[bitreverse(word)]==0){
- while((lo+1)<n && c->codelist[lo+1]<=word)lo++;
- while( hi<n && word>=(c->codelist[hi]&mask))hi++;
-
- /* we only actually have 15 bits per hint to play with here.
- In order to overflow gracefully (nothing breaks, efficiency
- just drops), encode as the difference from the extremes. */
- {
- unsigned long loval=lo;
- unsigned long hival=n-hi;
-
- if(loval>0x7fff)loval=0x7fff;
- if(hival>0x7fff)hival=0x7fff;
- c->dec_firsttable[bitreverse(word)]=
- 0x80000000UL | (loval<<15) | hival;
+
+ /* now fill in 'unused' entries in the firsttable with hi/lo search
+ hints for the non-direct-hits */
+ {
+ ogg_uint32_t mask=0xfffffffeUL<<(31-c->dec_firsttablen);
+ long lo=0,hi=0;
+
+ for(i=0;i<tabn;i++){
+ ogg_uint32_t word=i<<(32-c->dec_firsttablen);
+ if(c->dec_firsttable[bitreverse(word)]==0){
+ while((lo+1)<n && c->codelist[lo+1]<=word)lo++;
+ while( hi<n && word>=(c->codelist[hi]&mask))hi++;
+
+ /* we only actually have 15 bits per hint to play with here.
+ In order to overflow gracefully (nothing breaks, efficiency
+ just drops), encode as the difference from the extremes. */
+ {
+ unsigned long loval=lo;
+ unsigned long hival=n-hi;
+
+ if(loval>0x7fff)loval=0x7fff;
+ if(hival>0x7fff)hival=0x7fff;
+ c->dec_firsttable[bitreverse(word)]=
+ 0x80000000UL | (loval<<15) | hival;
+ }
}
}
}
}
-
return(0);
err_out:
@@ -624,7 +632,8 @@
0,
0,0,0,0,
NULL,
- NULL,NULL
+ NULL,NULL,NULL,
+ 0
};
static float *test1_result=NULL;
@@ -635,7 +644,8 @@
2,
-533200896,1611661312,4,0,
full_quantlist1,
- NULL,NULL
+ NULL,NULL,NULL,
+ 0
};
static float test2_result[]={-3,-2,-1,0, 1,2,3,4, 5,0,3,-2};
@@ -646,7 +656,8 @@
2,
-533200896,1611661312,4,1,
full_quantlist1,
- NULL,NULL
+ NULL,NULL,NULL,
+ 0
};
static float test3_result[]={-3,-5,-6,-6, 1,3,6,10, 5,5,8,6};
@@ -657,7 +668,8 @@
1,
-533200896,1611661312,4,0,
partial_quantlist1,
- NULL,NULL
+ NULL,NULL,NULL,
+ 0
};
static float test4_result[]={-3,-3,-3, 4,-3,-3, -1,-3,-3,
-3, 4,-3, 4, 4,-3, -1, 4,-3,
@@ -676,7 +688,8 @@
1,
-533200896,1611661312,4,1,
partial_quantlist1,
- NULL,NULL
+ NULL,NULL,NULL,
+ 0
};
static float test5_result[]={-3,-6,-9, 4, 1,-2, -1,-4,-7,
-3, 1,-2, 4, 8, 5, -1, 3, 0,
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/smallft.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/smallft.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/smallft.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: *unnormalized* fft transform
- last mod: $Id: smallft.c 7573 2004-08-16 01:26:52Z conrad $
+ last mod: $Id: smallft.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/smallft.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/smallft.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/smallft.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: fft transform
- last mod: $Id: smallft.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: smallft.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/synthesis.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/synthesis.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/synthesis.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: single-block PCM synthesis
- last mod: $Id: synthesis.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: synthesis.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/vorbisenc.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/vorbisenc.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/vorbisenc.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: simple programmatic interface for encoder mode setup
- last mod: $Id: vorbisenc.c 9033 2005-03-04 04:33:03Z msmith $
+ last mod: $Id: vorbisenc.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/vorbisfile.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/vorbisfile.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/vorbisfile.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: stdio-based convenience library for opening/seeking/decoding
- last mod: $Id: vorbisfile.c 7198 2004-07-21 01:35:06Z msmith $
+ last mod: $Id: vorbisfile.c 14771 2008-04-17 18:21:55Z xiphmont $
********************************************************************/
@@ -58,10 +58,11 @@
/* read a little more data from the file/pipe into the ogg_sync framer
*/
-#define CHUNKSIZE 8500 /* a shade over 8k; anyone using pages well
- over 8k gets what they deserve */
+#define CHUNKSIZE 65536
+
static long _get_data(OggVorbis_File *vf){
errno=0;
+ if(!(vf->callbacks.read_func))return(-1);
if(vf->datasource){
char *buffer=ogg_sync_buffer(&vf->oy,CHUNKSIZE);
long bytes=(vf->callbacks.read_func)(buffer,1,CHUNKSIZE,vf->datasource);
@@ -73,15 +74,18 @@
}
/* save a tiny smidge of verbosity to make the code more readable */
-static void _seek_helper(OggVorbis_File *vf,ogg_int64_t offset){
+static int _seek_helper(OggVorbis_File *vf,ogg_int64_t offset){
if(vf->datasource){
- (vf->callbacks.seek_func)(vf->datasource, offset, SEEK_SET);
+ if(!(vf->callbacks.seek_func)||
+ (vf->callbacks.seek_func)(vf->datasource, offset, SEEK_SET) == -1)
+ return OV_EREAD;
vf->offset=offset;
ogg_sync_reset(&vf->oy);
}else{
/* shouldn't happen unless someone writes a broken callback */
- return;
+ return OV_EFAULT;
}
+ return 0;
}
/* The read/seek functions track absolute position within the stream */
@@ -145,7 +149,10 @@
begin-=CHUNKSIZE;
if(begin<0)
begin=0;
- _seek_helper(vf,begin);
+
+ ret=_seek_helper(vf,begin);
+ if(ret)return(ret);
+
while(vf->offset<end){
ret=_get_next_page(vf,og,end-vf->offset);
if(ret==OV_EREAD)return(OV_EREAD);
@@ -158,7 +165,9 @@
}
/* we have the offset. Actually snork and hold the page now */
- _seek_helper(vf,offset);
+ ret=_seek_helper(vf,offset);
+ if(ret)return(ret);
+
ret=_get_next_page(vf,og,CHUNKSIZE);
if(ret<0)
/* this shouldn't be possible */
@@ -167,6 +176,58 @@
return(offset);
}
+static void _add_serialno(ogg_page *og,long **serialno_list, int *n){
+ long s = ogg_page_serialno(og);
+ (*n)++;
+
+ if(serialno_list){
+ *serialno_list = _ogg_realloc(*serialno_list, sizeof(*serialno_list)*(*n));
+ }else{
+ *serialno_list = _ogg_malloc(sizeof(**serialno_list));
+ }
+
+ (*serialno_list)[(*n)-1] = s;
+}
+
+/* returns nonzero if found */
+static int _lookup_serialno(ogg_page *og, long *serialno_list, int n){
+ long s = ogg_page_serialno(og);
+
+ if(serialno_list){
+ while(n--){
+ if(*serialno_list == s) return 1;
+ serialno_list++;
+ }
+ }
+ return 0;
+}
+
+/* start parsing pages at current offset, remembering all serial
+ numbers. Stop logging at first non-bos page */
+static int _get_serialnos(OggVorbis_File *vf, long **s, int *n){
+ ogg_page og;
+
+ *s=NULL;
+ *n=0;
+
+ while(1){
+ ogg_int64_t llret=_get_next_page(vf,&og,CHUNKSIZE);
+ if(llret==OV_EOF)return(0);
+ if(llret<0)return(llret);
+ if(!ogg_page_bos(&og)) return 0;
+
+ /* look for duplicate serialnos; add this one if unique */
+ if(_lookup_serialno(&og,*s,*n)){
+ if(*s)_ogg_free(*s);
+ *s=0;
+ *n=0;
+ return(OV_EBADHEADER);
+ }
+
+ _add_serialno(&og,s,n);
+ }
+}
+
/* finds each bitstream link one at a time using a bisection search
(has to begin by knowing the offset of the lb's initial page).
Recurses for each link so it can alloc the link storage after
@@ -175,7 +236,8 @@
ogg_int64_t begin,
ogg_int64_t searched,
ogg_int64_t end,
- long currentno,
+ long *currentno_list,
+ int currentnos,
long m){
ogg_int64_t endsearched=end;
ogg_int64_t next=end;
@@ -193,10 +255,12 @@
bisect=(searched+endsearched)/2;
}
- _seek_helper(vf,bisect);
+ ret=_seek_helper(vf,bisect);
+ if(ret)return(ret);
+
ret=_get_next_page(vf,&og,-1);
if(ret==OV_EREAD)return(OV_EREAD);
- if(ret<0 || ogg_page_serialno(&og)!=currentno){
+ if(ret<0 || !_lookup_serialno(&og,currentno_list,currentnos)){
endsearched=bisect;
if(ret>=0)next=ret;
}else{
@@ -204,23 +268,28 @@
}
}
- _seek_helper(vf,next);
- ret=_get_next_page(vf,&og,-1);
- if(ret==OV_EREAD)return(OV_EREAD);
-
- if(searched>=end || ret<0){
- vf->links=m+1;
- vf->offsets=_ogg_malloc((vf->links+1)*sizeof(*vf->offsets));
- vf->serialnos=_ogg_malloc(vf->links*sizeof(*vf->serialnos));
- vf->offsets[m+1]=searched;
- }else{
- ret=_bisect_forward_serialno(vf,next,vf->offset,
- end,ogg_page_serialno(&og),m+1);
- if(ret==OV_EREAD)return(OV_EREAD);
+ {
+ long *next_serialno_list=NULL;
+ int next_serialnos=0;
+
+ ret=_seek_helper(vf,next);
+ if(ret)return(ret);
+ ret=_get_serialnos(vf,&next_serialno_list,&next_serialnos);
+ if(ret)return(ret);
+
+ if(searched>=end || next_serialnos==0){
+ vf->links=m+1;
+ vf->offsets=_ogg_malloc((vf->links+1)*sizeof(*vf->offsets));
+ vf->offsets[m+1]=searched;
+ }else{
+ ret=_bisect_forward_serialno(vf,next,vf->offset,
+ end,next_serialno_list,next_serialnos,m+1);
+ if(ret)return(ret);
+ }
+
+ if(next_serialno_list)_ogg_free(next_serialno_list);
}
-
vf->offsets[m]=begin;
- vf->serialnos[m]=currentno;
return(0);
}
@@ -231,46 +300,98 @@
ogg_page og;
ogg_packet op;
int i,ret;
-
+ int allbos=0;
+
if(!og_ptr){
ogg_int64_t llret=_get_next_page(vf,&og,CHUNKSIZE);
if(llret==OV_EREAD)return(OV_EREAD);
- if(llret<0)return OV_ENOTVORBIS;
+ if(llret<0)return(OV_ENOTVORBIS);
og_ptr=&og;
}
- ogg_stream_reset_serialno(&vf->os,ogg_page_serialno(og_ptr));
- if(serialno)*serialno=vf->os.serialno;
- vf->ready_state=STREAMSET;
-
- /* extract the initial header from the first page and verify that the
- Ogg bitstream is in fact Vorbis data */
-
vorbis_info_init(vi);
vorbis_comment_init(vc);
+
+ /* extract the first set of vorbis headers we see in the headerset */
+
+ while(1){
- i=0;
- while(i<3){
+ /* if we're past the ID headers, we won't be finding a Vorbis
+ stream in this link */
+ if(!ogg_page_bos(og_ptr)){
+ ret = OV_ENOTVORBIS;
+ goto bail_header;
+ }
+
+ /* prospective stream setup; we need a stream to get packets */
+ ogg_stream_reset_serialno(&vf->os,ogg_page_serialno(og_ptr));
ogg_stream_pagein(&vf->os,og_ptr);
- while(i<3){
- int result=ogg_stream_packetout(&vf->os,&op);
- if(result==0)break;
- if(result==-1){
- ret=OV_EBADHEADER;
+
+ if(ogg_stream_packetout(&vf->os,&op) > 0 &&
+ vorbis_synthesis_idheader(&op)){
+
+ /* continue Vorbis header load; past this point, any error will
+ render this link useless (we won't continue looking for more
+ Vorbis streams */
+ if(serialno)*serialno=vf->os.serialno;
+ vf->ready_state=STREAMSET;
+ if((ret=vorbis_synthesis_headerin(vi,vc,&op)))
goto bail_header;
+
+ i=0;
+ while(i<2){ /* get a page loop */
+
+ while(i<2){ /* get a packet loop */
+
+ int result=ogg_stream_packetout(&vf->os,&op);
+ if(result==0)break;
+ if(result==-1){
+ ret=OV_EBADHEADER;
+ goto bail_header;
+ }
+
+ if((ret=vorbis_synthesis_headerin(vi,vc,&op)))
+ goto bail_header;
+
+ i++;
+ }
+
+ while(i<2){
+ if(_get_next_page(vf,og_ptr,CHUNKSIZE)<0){
+ ret=OV_EBADHEADER;
+ goto bail_header;
+ }
+
+ /* if this page belongs to the correct stream, go parse it */
+ if(vf->os.serialno == ogg_page_serialno(og_ptr)){
+ ogg_stream_pagein(&vf->os,og_ptr);
+ break;
+ }
+
+ /* if we never see the final vorbis headers before the link
+ ends, abort */
+ if(ogg_page_bos(og_ptr)){
+ if(allbos){
+ ret = OV_EBADHEADER;
+ goto bail_header;
+ }else
+ allbos=1;
+ }
+
+ /* otherwise, keep looking */
+ }
}
- if((ret=vorbis_synthesis_headerin(vi,vc,&op))){
- goto bail_header;
- }
- i++;
+
+ return 0;
}
- if(i<3)
- if(_get_next_page(vf,og_ptr,CHUNKSIZE)<0){
- ret=OV_EBADHEADER;
- goto bail_header;
- }
+
+ /* this wasn't vorbis, get next page, try again */
+ {
+ ogg_int64_t llret=_get_next_page(vf,og_ptr,CHUNKSIZE);
+ if(llret==OV_EREAD)return(OV_EREAD);
+ if(llret<0)return(OV_ENOTVORBIS);
+ }
}
- return 0;
bail_header:
vorbis_info_clear(vi);
@@ -293,27 +414,35 @@
ogg_page og;
int i;
ogg_int64_t ret;
-
+
vf->vi=_ogg_realloc(vf->vi,vf->links*sizeof(*vf->vi));
vf->vc=_ogg_realloc(vf->vc,vf->links*sizeof(*vf->vc));
+ vf->serialnos=_ogg_malloc(vf->links*sizeof(*vf->serialnos));
vf->dataoffsets=_ogg_malloc(vf->links*sizeof(*vf->dataoffsets));
vf->pcmlengths=_ogg_malloc(vf->links*2*sizeof(*vf->pcmlengths));
for(i=0;i<vf->links;i++){
if(i==0){
/* we already grabbed the initial header earlier. Just set the offset */
+ vf->serialnos[i]=vf->current_serialno;
vf->dataoffsets[i]=dataoffset;
- _seek_helper(vf,dataoffset);
+ ret=_seek_helper(vf,dataoffset);
+ if(ret)
+ vf->dataoffsets[i]=-1;
}else{
/* seek to the location of the initial header */
- _seek_helper(vf,vf->offsets[i]);
- if(_fetch_headers(vf,vf->vi+i,vf->vc+i,NULL,NULL)<0){
- vf->dataoffsets[i]=-1;
+ ret=_seek_helper(vf,vf->offsets[i]);
+ if(ret){
+ vf->dataoffsets[i]=-1;
}else{
- vf->dataoffsets[i]=vf->offset;
+ if(_fetch_headers(vf,vf->vi+i,vf->vc+i,vf->serialnos+i,NULL)<0){
+ vf->dataoffsets[i]=-1;
+ }else{
+ vf->dataoffsets[i]=vf->offset;
+ }
}
}
@@ -335,8 +464,10 @@
truncated/mangled */
break;
+ if(ogg_page_bos(&og)) break;
+
if(ogg_page_serialno(&og)!=vf->serialnos[i])
- break;
+ continue;
/* count blocksizes of all frames in the page */
ogg_stream_pagein(&vf->os,&og);
@@ -367,21 +498,29 @@
get the last page of the stream */
{
ogg_int64_t end=vf->offsets[i+1];
- _seek_helper(vf,end);
-
- while(1){
- ret=_get_prev_page(vf,&og);
- if(ret<0){
- /* this should not be possible */
- vorbis_info_clear(vf->vi+i);
- vorbis_comment_clear(vf->vc+i);
- break;
+ ret=_seek_helper(vf,end);
+ if(ret){
+ /* this should not be possible */
+ vorbis_info_clear(vf->vi+i);
+ vorbis_comment_clear(vf->vc+i);
+ }else{
+
+ while(1){
+ ret=_get_prev_page(vf,&og);
+ if(ret<0){
+ /* this should not be possible */
+ vorbis_info_clear(vf->vi+i);
+ vorbis_comment_clear(vf->vc+i);
+ break;
+ }
+ if(ogg_page_serialno(&og)==vf->serialnos[i]){
+ if(ogg_page_granulepos(&og)!=-1){
+ vf->pcmlengths[i*2+1]=ogg_page_granulepos(&og)-vf->pcmlengths[i*2];
+ break;
+ }
+ }
+ vf->offset=ret;
}
- if(ogg_page_granulepos(&og)!=-1){
- vf->pcmlengths[i*2+1]=ogg_page_granulepos(&og)-vf->pcmlengths[i*2];
- break;
- }
- vf->offset=ret;
}
}
}
@@ -405,35 +544,40 @@
}
static int _open_seekable2(OggVorbis_File *vf){
- long serialno=vf->current_serialno;
- ogg_int64_t dataoffset=vf->offset, end;
+ ogg_int64_t dataoffset=vf->offset,end;
+ long *serialno_list=NULL;
+ int serialnos=0;
+ int ret;
ogg_page og;
/* we're partially open and have a first link header state in
storage in vf */
/* we can seek, so set out learning all about this file */
- (vf->callbacks.seek_func)(vf->datasource,0,SEEK_END);
- vf->offset=vf->end=(vf->callbacks.tell_func)(vf->datasource);
-
+ if(vf->callbacks.seek_func && vf->callbacks.tell_func){
+ (vf->callbacks.seek_func)(vf->datasource,0,SEEK_END);
+ vf->offset=vf->end=(vf->callbacks.tell_func)(vf->datasource);
+ }else{
+ vf->offset=vf->end=-1;
+ }
+
+ /* If seek_func is implemented, tell_func must also be implemented */
+ if(vf->end==-1) return(OV_EINVAL);
+
/* We get the offset for the last page of the physical bitstream.
Most OggVorbis files will contain a single logical bitstream */
end=_get_prev_page(vf,&og);
if(end<0)return(end);
- /* more than one logical bitstream? */
- if(ogg_page_serialno(&og)!=serialno){
+ /* back to beginning, learn all serialnos of first link */
+ ret=_seek_helper(vf,0);
+ if(ret)return(ret);
+ ret=_get_serialnos(vf,&serialno_list,&serialnos);
+ if(ret)return(ret);
- /* Chained bitstream. Bisect-search each logical bitstream
- section. Do so based on serial number only */
- if(_bisect_forward_serialno(vf,0,0,end+1,serialno,0)<0)return(OV_EREAD);
+ /* now determine bitstream structure recursively */
+ if(_bisect_forward_serialno(vf,0,0,end+1,serialno_list,serialnos,0)<0)return(OV_EREAD);
+ if(serialno_list)_ogg_free(serialno_list);
- }else{
-
- /* Only one logical bitstream */
- if(_bisect_forward_serialno(vf,0,end,end+1,serialno,0))return(OV_EREAD);
-
- }
-
/* the initial header memory is referenced by vf after; don't free it */
_prefetch_all_headers(vf,dataoffset);
return(ov_raw_seek(vf,0));
@@ -543,29 +687,49 @@
if(vf->ready_state>=OPENED){
ogg_int64_t ret;
- if(!readp)return(0);
- if((ret=_get_next_page(vf,&og,-1))<0){
- return(OV_EOF); /* eof.
- leave unitialized */
- }
+
+ while(1){
+ /* the loop is not strictly necessary, but there's no sense in
+ doing the extra checks of the larger loop for the common
+ case in a multiplexed bistream where the page is simply
+ part of a different logical bitstream; keep reading until
+ we get one with the correct serialno */
+
+ if(!readp)return(0);
+ if((ret=_get_next_page(vf,&og,-1))<0){
+ return(OV_EOF); /* eof. leave unitialized */
+ }
/* bitrate tracking; add the header's bytes here, the body bytes
are done by packet above */
- vf->bittrack+=og.header_len*8;
-
- /* has our decoding just traversed a bitstream boundary? */
- if(vf->ready_state==INITSET){
- if(vf->current_serialno!=ogg_page_serialno(&og)){
- if(!spanp)
- return(OV_EOF);
+ vf->bittrack+=og.header_len*8;
+
+ if(vf->ready_state==INITSET){
+ if(vf->current_serialno!=ogg_page_serialno(&og)){
+
+ /* two possibilities:
+ 1) our decoding just traversed a bitstream boundary
+ 2) another stream is multiplexed into this logical section? */
+
+ if(ogg_page_bos(&og)){
+ /* boundary case */
+ if(!spanp)
+ return(OV_EOF);
+
+ _decode_clear(vf);
+
+ if(!vf->seekable){
+ vorbis_info_clear(vf->vi);
+ vorbis_comment_clear(vf->vc);
+ }
+ break;
- _decode_clear(vf);
-
- if(!vf->seekable){
- vorbis_info_clear(vf->vi);
- vorbis_comment_clear(vf->vc);
+ }else
+ continue; /* possibility #2 */
}
}
+
+ break;
}
}
@@ -586,18 +750,20 @@
if(vf->ready_state<STREAMSET){
if(vf->seekable){
- vf->current_serialno=ogg_page_serialno(&og);
-
+ long serialno = ogg_page_serialno(&og);
+
/* match the serialno to bitstream section. We use this rather than
offset positions to avoid problems near logical bitstream
boundaries */
+
for(link=0;link<vf->links;link++)
- if(vf->serialnos[link]==vf->current_serialno)break;
- if(link==vf->links)return(OV_EBADLINK); /* sign of a bogus
- stream. error out,
- leave machine
- uninitialized */
-
+ if(vf->serialnos[link]==serialno)break;
+
+ if(link==vf->links) continue; /* not the desired Vorbis
+ bitstream section; keep
+ trying */
+
+ vf->current_serialno=serialno;
vf->current_link=link;
ogg_stream_reset_serialno(&vf->os,vf->current_serialno);
@@ -619,7 +785,11 @@
if(ret<0)return ret;
}
}
+
+ /* the buffered page is the data we want, and we're ready for it;
+ add it to the stream state */
ogg_stream_pagein(&vf->os,&og);
+
}
}
@@ -632,9 +802,9 @@
static int _ov_open1(void *f,OggVorbis_File *vf,char *initial,
long ibytes, ov_callbacks callbacks){
- int offsettest=(f?callbacks.seek_func(f,0,SEEK_CUR):-1);
+ int offsettest=((f && callbacks.seek_func)?callbacks.seek_func(f,0,SEEK_CUR):-1);
int ret;
-
+
memset(vf,0,sizeof(*vf));
vf->datasource=f;
vf->callbacks = callbacks;
@@ -709,7 +879,8 @@
if(vf->serialnos)_ogg_free(vf->serialnos);
if(vf->offsets)_ogg_free(vf->offsets);
ogg_sync_clear(&vf->oy);
- if(vf->datasource)(vf->callbacks.close_func)(vf->datasource);
+ if(vf->datasource && vf->callbacks.close_func)
+ (vf->callbacks.close_func)(vf->datasource);
memset(vf,0,sizeof(*vf));
}
#ifdef DEBUG_LEAKS
@@ -743,6 +914,17 @@
return ov_open_callbacks((void *)f, vf, initial, ibytes, callbacks);
}
+
+int ov_fopen(char *path,OggVorbis_File *vf){
+ int ret;
+ FILE *f = fopen(path,"rb");
+ if(!f) return -1;
+
+ ret = ov_open(f,vf,NULL,0);
+ if(ret) fclose(f);
+ return ret;
+}
+
/* cheap hack for game usage where downsampling is desirable; there's
no need for SRC as we can just do it cheaply in libvorbis. */
@@ -948,6 +1130,7 @@
int ov_raw_seek(OggVorbis_File *vf,ogg_int64_t pos){
ogg_stream_state work_os;
+ int ret;
if(vf->ready_state<OPENED)return(OV_EINVAL);
if(!vf->seekable)
@@ -964,7 +1147,8 @@
vf->current_serialno); /* must set serialno */
vorbis_synthesis_restart(&vf->vd);
- _seek_helper(vf,pos);
+ ret=_seek_helper(vf,pos);
+ if(ret)goto seek_error;
/* we need to make sure the pcm_offset is set, but we don't want to
advance the raw cursor past good packets just to get to the first
@@ -986,8 +1170,8 @@
ogg_packet op;
int lastblock=0;
int accblock=0;
- int thisblock;
- int eosflag;
+ int thisblock=0;
+ int eosflag=0;
ogg_stream_init(&work_os,vf->current_serialno); /* get the memory ready */
ogg_stream_reset(&work_os); /* eliminate the spurious OV_HOLE
@@ -1009,7 +1193,7 @@
}else{
if(eosflag)
- ogg_stream_packetout(&vf->os,NULL);
+ ogg_stream_packetout(&vf->os,NULL);
else
if(lastblock)accblock+=(lastblock+thisblock)>>2;
}
@@ -1043,25 +1227,35 @@
}
/* has our decoding just traversed a bitstream boundary? */
- if(vf->ready_state>=STREAMSET)
+ if(vf->ready_state>=STREAMSET){
if(vf->current_serialno!=ogg_page_serialno(&og)){
- _decode_clear(vf); /* clear out stream state */
- ogg_stream_clear(&work_os);
+
+ /* two possibilities:
+ 1) our decoding just traversed a bitstream boundary
+ 2) another stream is multiplexed into this logical section? */
+
+ if(ogg_page_bos(&og)){
+ /* we traversed */
+ _decode_clear(vf); /* clear out stream state */
+ ogg_stream_clear(&work_os);
+ } /* else, do nothing; next loop will scoop another page */
}
+ }
if(vf->ready_state<STREAMSET){
int link;
-
- vf->current_serialno=ogg_page_serialno(&og);
+ long serialno = ogg_page_serialno(&og);
+
for(link=0;link<vf->links;link++)
- if(vf->serialnos[link]==vf->current_serialno)break;
- if(link==vf->links)goto seek_error; /* sign of a bogus stream.
- error out, leave
- machine uninitialized */
+ if(vf->serialnos[link]==serialno)break;
+
+ if(link==vf->links) continue; /* not the desired Vorbis
+ bitstream section; keep
+ trying */
vf->current_link=link;
-
- ogg_stream_reset_serialno(&vf->os,vf->current_serialno);
- ogg_stream_reset_serialno(&work_os,vf->current_serialno);
+ vf->current_serialno=serialno;
+ ogg_stream_reset_serialno(&vf->os,serialno);
+ ogg_stream_reset_serialno(&work_os,serialno);
vf->ready_state=STREAMSET;
}
@@ -1095,7 +1289,7 @@
int link=-1;
ogg_int64_t result=0;
ogg_int64_t total=ov_pcm_total(vf,-1);
-
+
if(vf->ready_state<OPENED)return(OV_EINVAL);
if(!vf->seekable)return(OV_ENOSEEK);
@@ -1136,8 +1330,9 @@
bisect=begin+1;
}
- _seek_helper(vf,bisect);
-
+ result=_seek_helper(vf,bisect);
+ if(result) goto seek_error;
+
while(begin<end){
result=_get_next_page(vf,&og,end-vf->offset);
if(result==OV_EREAD) goto seek_error;
@@ -1148,11 +1343,18 @@
if(bisect==0) goto seek_error;
bisect-=CHUNKSIZE;
if(bisect<=begin)bisect=begin+1;
- _seek_helper(vf,bisect);
+ result=_seek_helper(vf,bisect);
+ if(result) goto seek_error;
}
}else{
- ogg_int64_t granulepos=ogg_page_granulepos(&og);
+ ogg_int64_t granulepos;
+
+ if(ogg_page_serialno(&og)!=vf->serialnos[link])
+ continue;
+
+ granulepos=ogg_page_granulepos(&og);
if(granulepos==-1)continue;
+
if(granulepos<target){
best=result; /* raw offset of packet with granulepos */
begin=vf->offset; /* raw offset of next page */
@@ -1168,9 +1370,10 @@
end=result;
bisect-=CHUNKSIZE; /* an endless loop otherwise. */
if(bisect<=begin)bisect=begin+1;
- _seek_helper(vf,bisect);
+ result=_seek_helper(vf,bisect);
+ if(result) goto seek_error;
}else{
- end=result;
+ end=bisect;
endtime=granulepos;
break;
}
@@ -1187,17 +1390,18 @@
ogg_packet op;
/* seek */
- _seek_helper(vf,best);
+ result=_seek_helper(vf,best);
vf->pcm_offset=-1;
+ if(result) goto seek_error;
+ result=_get_next_page(vf,&og,-1);
+ if(result<0) goto seek_error;
- if(_get_next_page(vf,&og,-1)<0)return(OV_EOF); /* shouldn't happen */
-
if(link!=vf->current_link){
/* Different link; dump entire decode machine */
_decode_clear(vf);
vf->current_link=link;
- vf->current_serialno=ogg_page_serialno(&og);
+ vf->current_serialno=vf->serialnos[link];
vf->ready_state=STREAMSET;
}else{
@@ -1216,13 +1420,15 @@
get one with a granulepos or without the 'continued' flag
set. Then just use raw_seek for simplicity. */
- _seek_helper(vf,best);
+ result=_seek_helper(vf,best);
+ if(result<0) goto seek_error;
while(1){
result=_get_prev_page(vf,&og);
if(result<0) goto seek_error;
- if(ogg_page_granulepos(&og)>-1 ||
- !ogg_page_continued(&og)){
+ if(ogg_page_serialno(&og)==vf->current_serialno &&
+ (ogg_page_granulepos(&og)>-1 ||
+ !ogg_page_continued(&og))){
return ov_raw_seek(vf,result);
}
vf->offset=result;
@@ -1313,19 +1519,20 @@
/* suck in a new page */
if(_get_next_page(vf,&og,-1)<0)break;
- if(vf->current_serialno!=ogg_page_serialno(&og))_decode_clear(vf);
+ if(ogg_page_bos(&og))_decode_clear(vf);
if(vf->ready_state<STREAMSET){
+ long serialno=ogg_page_serialno(&og);
int link;
- vf->current_serialno=ogg_page_serialno(&og);
for(link=0;link<vf->links;link++)
- if(vf->serialnos[link]==vf->current_serialno)break;
- if(link==vf->links)return(OV_EBADLINK);
+ if(vf->serialnos[link]==serialno)break;
+ if(link==vf->links) continue;
vf->current_link=link;
- ogg_stream_reset_serialno(&vf->os,vf->current_serialno);
vf->ready_state=STREAMSET;
+ vf->current_serialno=ogg_page_serialno(&og);
+ ogg_stream_reset_serialno(&vf->os,serialno);
ret=_make_decode_ready(vf);
if(ret)return ret;
lastblock=0;
@@ -1360,20 +1567,23 @@
/* translate time to PCM position and call ov_pcm_seek */
int link=-1;
- ogg_int64_t pcm_total=ov_pcm_total(vf,-1);
- double time_total=ov_time_total(vf,-1);
+ ogg_int64_t pcm_total=0;
+ double time_total=0.;
if(vf->ready_state<OPENED)return(OV_EINVAL);
if(!vf->seekable)return(OV_ENOSEEK);
- if(seconds<0 || seconds>time_total)return(OV_EINVAL);
+ if(seconds<0)return(OV_EINVAL);
/* which bitstream section does this time offset occur in? */
- for(link=vf->links-1;link>=0;link--){
- pcm_total-=vf->pcmlengths[link*2+1];
- time_total-=ov_time_total(vf,link);
- if(seconds>=time_total)break;
+ for(link=0;link<vf->links;link++){
+ double addsec = ov_time_total(vf,link);
+ if(seconds<time_total+addsec)break;
+ time_total+=addsec;
+ pcm_total+=vf->pcmlengths[link*2+1];
}
+ if(link==vf->links)return(OV_EINVAL);
+
/* enough information to convert time offset to pcm offset */
{
ogg_int64_t target=pcm_total+(seconds-time_total)*vf->vi[link].rate;
@@ -1387,20 +1597,23 @@
/* translate time to PCM position and call ov_pcm_seek */
int link=-1;
- ogg_int64_t pcm_total=ov_pcm_total(vf,-1);
- double time_total=ov_time_total(vf,-1);
+ ogg_int64_t pcm_total=0;
+ double time_total=0.;
if(vf->ready_state<OPENED)return(OV_EINVAL);
if(!vf->seekable)return(OV_ENOSEEK);
- if(seconds<0 || seconds>time_total)return(OV_EINVAL);
+ if(seconds<0)return(OV_EINVAL);
/* which bitstream section does this time offset occur in? */
- for(link=vf->links-1;link>=0;link--){
- pcm_total-=vf->pcmlengths[link*2+1];
- time_total-=ov_time_total(vf,link);
- if(seconds>=time_total)break;
+ for(link=0;link<vf->links;link++){
+ double addsec = ov_time_total(vf,link);
+ if(seconds<time_total+addsec)break;
+ time_total+=addsec;
+ pcm_total+=vf->pcmlengths[link*2+1];
}
+ if(link==vf->links)return(OV_EINVAL);
+
/* enough information to convert time offset to pcm offset */
{
ogg_int64_t target=pcm_total+(seconds-time_total)*vf->vi[link].rate;
@@ -1508,6 +1721,11 @@
index within the physical bitstream. Note that the accessor
functions above are aware of this dichotomy).
+ ov_read_filter is exactly the same as ov_read except that it processes
+ the decoded audio data through a filter before packing it into the
+ requested format. This gives greater accuracy than applying a filter
+ after the audio has been converted into integral PCM.
+
input values: buffer) a buffer to hold packed PCM data for return
length) the byte length requested to be placed into buffer
bigendianp) should the data be packed LSB first (0) or
@@ -1524,8 +1742,9 @@
*section) set to the logical bitstream number */
-long ov_read(OggVorbis_File *vf,char *buffer,int length,
- int bigendianp,int word,int sgned,int *bitstream){
+long ov_read_filter(OggVorbis_File *vf,char *buffer,int length,
+ int bigendianp,int word,int sgned,int *bitstream,
+ void (*filter)(float **pcm,long channels,long samples,void *filter_param),void *filter_param){
int i,j;
int host_endian = host_is_big_endian();
@@ -1563,6 +1782,10 @@
if(samples <= 0)
return OV_EINVAL;
+ /* Here. */
+ if(filter)
+ filter(pcm,channels,samples,filter_param);
+
/* a tight loop to pack each size */
{
int val;
@@ -1655,6 +1878,11 @@
}
}
+long ov_read(OggVorbis_File *vf,char *buffer,int length,
+ int bigendianp,int word,int sgned,int *bitstream){
+ return ov_read_filter(vf, buffer, length, bigendianp, word, sgned, bitstream, NULL, NULL);
+}
+
/* input values: pcm_channels) a float vector per channel of output
length) the sample length being read by the app
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/window.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/window.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/window.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: window functions
- last mod: $Id: window.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: window.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/window.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/window.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/lib/window.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -5,13 +5,13 @@
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
- * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: window functions
- last mod: $Id: window.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: window.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/libvorbis.spec.in
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/libvorbis.spec.in 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/libvorbis.spec.in 2008-06-13 23:59:37 UTC (rev 15029)
@@ -7,7 +7,7 @@
License: BSD
URL: http://www.xiph.org/
Vendor: Xiph.org Foundation <team at xiph.org>
-Source: http://www.vorbis.com/files/1.0.1/unix/%{name}-%{version}.tar.gz
+Source: http://downloads.xiph.org/releases/vorbis/%{name}-%{version}.tar.gz
BuildRoot: %{_tmppath}/%{name}-%{version}-root
# We're forced to use an epoch since both Red Hat and Ximian use it in their
@@ -91,6 +91,9 @@
%{_libdir}/pkgconfig/vorbisenc.pc
%changelog
+* Sat May 3 2008 Ralph Giles <giles at xiph.org>
+- updated source location
+
* Thu Jun 10 2004 Thomas Vander Stichele <thomas at apestaart dot org>
- autogenerate from configure
- fix download location
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/macosx/English.lproj/InfoPlist.strings
===================================================================
(Binary files differ)
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vorbis.m4
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vorbis.m4 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vorbis.m4 2008-06-13 23:59:37 UTC (rev 15029)
@@ -10,25 +10,31 @@
[dnl
dnl Get the cflags and libraries
dnl
-AC_ARG_WITH(vorbis,[ --with-vorbis=PFX Prefix where libvorbis is installed (optional)], vorbis_prefix="$withval", vorbis_prefix="")
-AC_ARG_WITH(vorbis-libraries,[ --with-vorbis-libraries=DIR Directory where libvorbis library is installed (optional)], vorbis_libraries="$withval", vorbis_libraries="")
-AC_ARG_WITH(vorbis-includes,[ --with-vorbis-includes=DIR Directory where libvorbis header files are installed (optional)], vorbis_includes="$withval", vorbis_includes="")
-AC_ARG_ENABLE(vorbistest, [ --disable-vorbistest Do not try to compile and run a test Vorbis program],, enable_vorbistest=yes)
+AC_ARG_WITH(vorbis,AC_HELP_STRING([--with-vorbis=PFX],[Prefix where libvorbis is installed (optional)]), vorbis_prefix="$withval", vorbis_prefix="")
+AC_ARG_WITH(vorbis-libraries,AC_HELP_STRING([--with-vorbis-libraries=DIR],[Directory where libvorbis library is installed (optional)]), vorbis_libraries="$withval", vorbis_libraries="")
+AC_ARG_WITH(vorbis-includes,AC_HELP_STRING([--with-vorbis-includes=DIR],[Directory where libvorbis header files are installed (optional)]), vorbis_includes="$withval", vorbis_includes="")
+AC_ARG_ENABLE(vorbistest,AC_HELP_STRING([--disable-vorbistest],[Do not try to compile and run a test Vorbis program]),, enable_vorbistest=yes)
if test "x$vorbis_libraries" != "x" ; then
VORBIS_LIBS="-L$vorbis_libraries"
+ elif test "x$vorbis_prefix" = "xno" || test "x$vorbis_prefix" = "xyes" ; then
+ VORBIS_LIBS=""
elif test "x$vorbis_prefix" != "x" ; then
VORBIS_LIBS="-L$vorbis_prefix/lib"
elif test "x$prefix" != "xNONE"; then
VORBIS_LIBS="-L$prefix/lib"
fi
- VORBIS_LIBS="$VORBIS_LIBS -lvorbis -lm"
+ if test "x$vorbis_prefix" != "xno" ; then
+ VORBIS_LIBS="$VORBIS_LIBS -lvorbis -lm"
+ fi
VORBISFILE_LIBS="-lvorbisfile"
VORBISENC_LIBS="-lvorbisenc"
if test "x$vorbis_includes" != "x" ; then
VORBIS_CFLAGS="-I$vorbis_includes"
+ elif test "x$vorbis_prefix" = "xno" || test "x$vorbis_prefix" = "xyes" ; then
+ VORBIS_CFLAGS=""
elif test "x$vorbis_prefix" != "x" ; then
VORBIS_CFLAGS="-I$vorbis_prefix/include"
elif test "x$prefix" != "xNONE"; then
@@ -37,7 +43,12 @@
AC_MSG_CHECKING(for Vorbis)
- no_vorbis=""
+ if test "x$vorbis_prefix" = "xno" ; then
+ no_vorbis="disabled"
+ enable_vorbistest="no"
+ else
+ no_vorbis=""
+ fi
if test "x$enable_vorbistest" = "xyes" ; then
@@ -78,9 +89,12 @@
LIBS="$ac_save_LIBS"
fi
- if test "x$no_vorbis" = "x" ; then
+ if test "x$no_vorbis" = "xdisabled" ; then
+ AC_MSG_RESULT(no)
+ ifelse([$2], , :, [$2])
+ elif test "x$no_vorbis" = "x" ; then
AC_MSG_RESULT(yes)
- ifelse([$1], , :, [$1])
+ ifelse([$1], , :, [$1])
else
AC_MSG_RESULT(no)
if test -f conf.vorbistest ; then
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/Makefile.am
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/Makefile.am 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/Makefile.am 2008-06-13 23:59:37 UTC (rev 15029)
@@ -10,20 +10,28 @@
LDADD = ../lib/libvorbis.la
latticebuild_SOURCES = latticebuild.c vqgen.c bookutil.c\
- vqgen.h bookutil.h
+ vqgen.h bookutil.h localcodebook.h
latticepare_SOURCES = latticepare.c vqgen.c bookutil.c vqsplit.c\
- vqgen.h bookutil.h
+ vqgen.h vqsplit.h bookutil.h localcodebook.h
latticehint_SOURCES = latticehint.c bookutil.c\
- bookutil.h
+ vqsplit.h bookutil.h localcodebook.h
latticetune_SOURCES = latticetune.c vqgen.c bookutil.c\
- vqgen.h bookutil.h
+ vqgen.h bookutil.h localcodebook.h
huffbuild_SOURCES = huffbuild.c vqgen.c bookutil.c\
- vqgen.h bookutil.h
+ vqgen.h bookutil.h localcodebook.h
distribution_SOURCES = distribution.c bookutil.c\
- bookutil.h
+ bookutil.h localcodebook.h
-EXTRA_DIST = residue_entropy auxpartition.pl
+vqs_files = 16.vqs 16u.vqs 44c-1.vqs 44c0.vqs 44c1.vqs 44c2.vqs \
+ 44c3.vqs 44c4.vqs 44c5.vqs 44c6.vqs 44c7.vqs 44c8.vqs 44c9.vqs \
+ 44u0.vqs 44u1.vqs 44u2.vqs 44u3.vqs 44u4.vqs 44u5.vqs 44u6.vqs \
+ 44u7.vqs 44u8.vqs 44u9.vqs 8.vqs 8u.vqs floor_11.vqs floor_22.vqs \
+ floor_44.vqs
+EXTRA_DIST = $(vqs_files) build.c cascade.c genericdata.c lspdata.c \
+ make_floor_books.pl make_residue_books.pl metrics.c residue_entropy \
+ residuedata.c residuesplit.c run.c train.c vqext.h auxpartition.pl
+
debugvq:
$(MAKE) vq CFLAGS="@DEBUG@"
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/bookutil.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/bookutil.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/bookutil.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: utility functions for loading .vqh and .vqd files
- last mod: $Id: bookutil.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: bookutil.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/bookutil.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/bookutil.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/bookutil.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: utility functions for loading .vqh and .vqd files
- last mod: $Id: bookutil.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: bookutil.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/distribution.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/distribution.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/distribution.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: utility for finding the distribution in a data set
- last mod: $Id: distribution.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: distribution.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/huffbuild.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/huffbuild.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/huffbuild.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: hufftree builder
- last mod: $Id: huffbuild.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: huffbuild.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticebuild.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticebuild.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticebuild.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: utility main for building codebooks from lattice descriptions
- last mod: $Id: latticebuild.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: latticebuild.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticehint.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticehint.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticehint.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: utility main for building thresh/pigeonhole encode hints
- last mod: $Id: latticehint.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: latticehint.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticepare.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticepare.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticepare.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: utility for paring low hit count cells from lattice codebook
- last mod: $Id: latticepare.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: latticepare.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticetune.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticetune.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/latticetune.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,13 +6,13 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: utility main for setting entropy encoding parameters
for lattice codebooks
- last mod: $Id: latticetune.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: latticetune.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqgen.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqgen.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqgen.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: train a VQ codebook
- last mod: $Id: vqgen.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: vqgen.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqgen.h
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqgen.h 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqgen.h 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: build a VQ codebook
- last mod: $Id: vqgen.h 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: vqgen.h 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqsplit.c
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqsplit.c 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/vq/vqsplit.c 2008-06-13 23:59:37 UTC (rev 15029)
@@ -6,12 +6,12 @@
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
- * by the XIPHOPHORUS Company http://www.xiph.org/ *
+ * by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function: build a VQ codebook and the encoding decision 'tree'
- last mod: $Id: vqsplit.c 7187 2004-07-20 07:24:27Z xiphmont $
+ last mod: $Id: vqsplit.c 13293 2007-07-24 00:09:47Z xiphmont $
********************************************************************/
Added: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbis/libvorbis.vcproj
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbis/libvorbis.vcproj (rev 0)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbis/libvorbis.vcproj 2008-06-13 23:59:37 UTC (rev 15029)
@@ -0,0 +1,654 @@
+<?xml version="1.0" encoding="Windows-1252"?>
+<VisualStudioProject
+ ProjectType="Visual C++"
+ Version="9,00"
+ Name="libvorbis"
+ ProjectGUID="{3A214E06-B95E-4D61-A291-1F8DF2EC10FD}"
+ RootNamespace="libvorbis"
+ Keyword="Win32Proj"
+ TargetFrameworkVersion="131072"
+ >
+ <Platforms>
+ <Platform
+ Name="Win32"
+ />
+ </Platforms>
+ <ToolFiles>
+ </ToolFiles>
+ <Configurations>
+ <Configuration
+ Name="Debug|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="2"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="0"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include;..\..\..\..\..\..\..\core\ogg\libogg\include"
+ PreprocessorDefinitions="WIN32;_DEBUG;_WINDOWS;_USRDLL;LIBVORBIS_EXPORTS"
+ MinimalRebuild="true"
+ BasicRuntimeChecks="3"
+ RuntimeLibrary="1"
+ UsePrecompiledHeader="0"
+ WarningLevel="4"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="4"
+ CompileAs="1"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ OutputFile="$(OutDir)/vorbis.dll"
+ LinkIncremental="2"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)""
+ ModuleDefinitionFile="..\..\vorbis.def"
+ GenerateDebugInformation="true"
+ ProgramDatabaseFile="$(OutDir)/libvorbis.pdb"
+ SubSystem="2"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ ImportLibrary="$(OutDir)/libvorbis.lib"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="2"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ WholeProgramOptimization="1"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="3"
+ InlineFunctionExpansion="2"
+ EnableIntrinsicFunctions="true"
+ FavorSizeOrSpeed="1"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include;..\..\..\..\..\..\..\core\ogg\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;_USRDLL;LIBVORBIS_EXPORTS"
+ StringPooling="true"
+ ExceptionHandling="0"
+ RuntimeLibrary="0"
+ BufferSecurityCheck="false"
+ UsePrecompiledHeader="0"
+ WarningLevel="4"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ CompileAs="1"
+ DisableSpecificWarnings="4244;4100;4267;4189;4305;4127;4706"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ OutputFile="$(OutDir)/vorbis.dll"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)""
+ ModuleDefinitionFile="..\..\vorbis.def"
+ GenerateDebugInformation="false"
+ SubSystem="2"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ OptimizeForWindows98="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ ImportLibrary="$(OutDir)/libvorbis.lib"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release_SSE|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="2"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ WholeProgramOptimization="1"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="3"
+ InlineFunctionExpansion="2"
+ EnableIntrinsicFunctions="true"
+ FavorSizeOrSpeed="1"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include;..\..\..\..\..\..\..\core\ogg\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;_USRDLL;LIBVORBIS_EXPORTS"
+ StringPooling="true"
+ ExceptionHandling="0"
+ RuntimeLibrary="0"
+ BufferSecurityCheck="false"
+ EnableEnhancedInstructionSet="1"
+ UsePrecompiledHeader="0"
+ WarningLevel="4"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ CompileAs="1"
+ DisableSpecificWarnings="4244;4100;4267;4189;4305;4127;4706"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ OutputFile="$(OutDir)/vorbis.dll"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)""
+ ModuleDefinitionFile="..\..\vorbis.def"
+ GenerateDebugInformation="false"
+ SubSystem="2"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ OptimizeForWindows98="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ ImportLibrary="$(OutDir)/libvorbis.lib"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release_SSE2|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="2"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ WholeProgramOptimization="1"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="3"
+ InlineFunctionExpansion="2"
+ EnableIntrinsicFunctions="true"
+ FavorSizeOrSpeed="1"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include;..\..\..\..\..\..\..\core\ogg\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;_USRDLL;LIBVORBIS_EXPORTS"
+ StringPooling="true"
+ ExceptionHandling="0"
+ RuntimeLibrary="0"
+ BufferSecurityCheck="false"
+ EnableEnhancedInstructionSet="2"
+ UsePrecompiledHeader="0"
+ WarningLevel="4"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ CompileAs="1"
+ DisableSpecificWarnings="4244;4100;4267;4189;4305;4127;4706"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ OutputFile="$(OutDir)/vorbis.dll"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)""
+ ModuleDefinitionFile="..\..\vorbis.def"
+ GenerateDebugInformation="false"
+ SubSystem="2"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ OptimizeForWindows98="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ ImportLibrary="$(OutDir)/libvorbis.lib"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ </Configurations>
+ <References>
+ </References>
+ <Files>
+ <Filter
+ Name="Source Files"
+ Filter="cpp;c;cxx;def;odl;idl;hpj;bat;asm;asmx"
+ UniqueIdentifier="{4FC737F1-C7A5-4376-A066-2A32D752A2FF}"
+ >
+ <File
+ RelativePath="..\..\..\lib\analysis.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\bitrate.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\block.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\codebook.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\envelope.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\floor0.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\floor1.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\info.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\lookup.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\lpc.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\lsp.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\mapping0.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\mdct.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\psy.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\registry.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\res0.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\sharedbook.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\smallft.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\synthesis.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\vorbis.def"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\vorbisenc.c"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\window.c"
+ >
+ </File>
+ </Filter>
+ <Filter
+ Name="Header Files"
+ Filter="h;hpp;hxx;hm;inl;inc;xsd"
+ UniqueIdentifier="{93995380-89BD-4b04-88EB-625FBE52EBFB}"
+ >
+ <File
+ RelativePath="..\..\..\lib\backends.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\bitrate.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\codebook.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\include\vorbis\codec.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\codec_internal.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\envelope.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\floor_all.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\books\floor\floor_books.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\highlevel.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\lookup.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\lookup_data.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\lpc.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\lsp.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\masking.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\mdct.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\misc.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\os.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\psy.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\psych_11.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\psych_16.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\psych_44.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\psych_8.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\registry.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\books\coupled\res_books_stereo.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\books\uncoupled\res_books_uncoupled.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\residue_16.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\residue_44.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\residue_44u.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\residue_8.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\scales.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\setup_11.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\setup_16.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\setup_22.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\setup_32.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\setup_44.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\setup_44u.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\setup_8.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\modes\setup_X.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\smallft.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\include\vorbis\vorbisenc.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\include\vorbis\vorbisfile.h"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\window.h"
+ >
+ </File>
+ </Filter>
+ <Filter
+ Name="Resource Files"
+ Filter="rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx"
+ UniqueIdentifier="{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}"
+ >
+ </Filter>
+ </Files>
+ <Globals>
+ </Globals>
+</VisualStudioProject>
Added: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbisfile/libvorbisfile.def
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbisfile/libvorbisfile.def (rev 0)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbisfile/libvorbisfile.def 2008-06-13 23:59:37 UTC (rev 15029)
@@ -0,0 +1,47 @@
+LIBRARY libvorbisfile
+EXPORTS
+ov_clear
+ov_open
+ov_open_callbacks
+;
+ov_test
+ov_test_callbacks
+ov_test_open
+;
+ov_bitrate
+ov_bitrate_instant
+;
+ov_streams
+ov_seekable
+ov_serialnumber
+;
+ov_raw_total
+ov_pcm_total
+ov_time_total
+;
+ov_raw_seek
+ov_pcm_seek
+ov_pcm_seek_page
+ov_time_seek
+ov_time_seek_page
+;
+ov_raw_seek_lap
+ov_pcm_seek_lap
+ov_pcm_seek_page_lap
+ov_time_seek_lap
+ov_time_seek_page_lap
+;
+ov_raw_tell
+ov_pcm_tell
+ov_time_tell
+;
+ov_info
+ov_comment
+;
+ov_read_float
+ov_read
+ov_crosslap
+;
+ov_halfrate
+ov_halfrate_p
+;
\ No newline at end of file
Added: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbisfile/libvorbisfile.vcproj
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbisfile/libvorbisfile.vcproj (rev 0)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/libvorbisfile/libvorbisfile.vcproj 2008-06-13 23:59:37 UTC (rev 15029)
@@ -0,0 +1,225 @@
+<?xml version="1.0" encoding="Windows-1252"?>
+<VisualStudioProject
+ ProjectType="Visual C++"
+ Version="9,00"
+ Name="libvorbisfile"
+ ProjectGUID="{CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}"
+ RootNamespace="libvorbisfile"
+ Keyword="Win32Proj"
+ TargetFrameworkVersion="131072"
+ >
+ <Platforms>
+ <Platform
+ Name="Win32"
+ />
+ </Platforms>
+ <ToolFiles>
+ </ToolFiles>
+ <Configurations>
+ <Configuration
+ Name="Debug|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="2"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="0"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;_DEBUG;_WINDOWS;_USRDLL;LIBVORBISFILE_EXPORTS"
+ MinimalRebuild="true"
+ BasicRuntimeChecks="3"
+ RuntimeLibrary="1"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="4"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/libvorbisfile.dll"
+ LinkIncremental="2"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ ModuleDefinitionFile="libvorbisfile.def"
+ GenerateDebugInformation="true"
+ ProgramDatabaseFile="$(OutDir)/libvorbisfile.pdb"
+ SubSystem="2"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ ImportLibrary="$(OutDir)/libvorbisfile.lib"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="2"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_WINDOWS;_USRDLL;LIBVORBISFILE_EXPORTS"
+ RuntimeLibrary="0"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/libvorbisfile.dll"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ ModuleDefinitionFile="libvorbisfile.def"
+ GenerateDebugInformation="false"
+ SubSystem="2"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ ImportLibrary="$(OutDir)/libvorbisfile.lib"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ </Configurations>
+ <References>
+ <ProjectReference
+ ReferencedProjectIdentifier="{3A214E06-B95E-4D61-A291-1F8DF2EC10FD}"
+ />
+ </References>
+ <Files>
+ <Filter
+ Name="Source Files"
+ Filter="cpp;c;cxx;def;odl;idl;hpj;bat;asm;asmx"
+ UniqueIdentifier="{4FC737F1-C7A5-4376-A066-2A32D752A2FF}"
+ >
+ <File
+ RelativePath=".\libvorbisfile.def"
+ >
+ </File>
+ <File
+ RelativePath="..\..\..\lib\vorbisfile.c"
+ >
+ </File>
+ </Filter>
+ <Filter
+ Name="Header Files"
+ Filter="h;hpp;hxx;hm;inl;inc;xsd"
+ UniqueIdentifier="{93995380-89BD-4b04-88EB-625FBE52EBFB}"
+ >
+ <File
+ RelativePath="..\..\..\include\vorbis\vorbisfile.h"
+ >
+ </File>
+ </Filter>
+ <Filter
+ Name="Resource Files"
+ Filter="rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx"
+ UniqueIdentifier="{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}"
+ >
+ </Filter>
+ <File
+ RelativePath=".\ReadMe.txt"
+ >
+ </File>
+ </Files>
+ <Globals>
+ </Globals>
+</VisualStudioProject>
Added: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbis.sln
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbis.sln (rev 0)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbis.sln 2008-06-13 23:59:37 UTC (rev 15029)
@@ -0,0 +1,55 @@
+Microsoft Visual Studio Solution File, Format Version 10.00
+# Visual C++ Express 2008
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "libvorbis", "libvorbis\libvorbis.vcproj", "{3A214E06-B95E-4D61-A291-1F8DF2EC10FD}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "libvorbisfile", "libvorbisfile\libvorbisfile.vcproj", "{CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "vorbisdec", "vorbisdec\vorbisdec.vcproj", "{5833EEA1-1068-431F-A6E5-316E7DC5D90A}"
+EndProject
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "vorbisenc", "vorbisenc\vorbisenc.vcproj", "{E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}"
+EndProject
+Global
+ GlobalSection(SolutionConfigurationPlatforms) = preSolution
+ Debug|Win32 = Debug|Win32
+ Release_SSE|Win32 = Release_SSE|Win32
+ Release_SSE2|Win32 = Release_SSE2|Win32
+ Release|Win32 = Release|Win32
+ EndGlobalSection
+ GlobalSection(ProjectConfigurationPlatforms) = postSolution
+ {3A214E06-B95E-4D61-A291-1F8DF2EC10FD}.Debug|Win32.ActiveCfg = Debug|Win32
+ {3A214E06-B95E-4D61-A291-1F8DF2EC10FD}.Debug|Win32.Build.0 = Debug|Win32
+ {3A214E06-B95E-4D61-A291-1F8DF2EC10FD}.Release_SSE|Win32.ActiveCfg = Release_SSE|Win32
+ {3A214E06-B95E-4D61-A291-1F8DF2EC10FD}.Release_SSE|Win32.Build.0 = Release_SSE|Win32
+ {3A214E06-B95E-4D61-A291-1F8DF2EC10FD}.Release_SSE2|Win32.ActiveCfg = Release_SSE2|Win32
+ {3A214E06-B95E-4D61-A291-1F8DF2EC10FD}.Release_SSE2|Win32.Build.0 = Release_SSE2|Win32
+ {3A214E06-B95E-4D61-A291-1F8DF2EC10FD}.Release|Win32.ActiveCfg = Release|Win32
+ {3A214E06-B95E-4D61-A291-1F8DF2EC10FD}.Release|Win32.Build.0 = Release|Win32
+ {CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}.Debug|Win32.ActiveCfg = Debug|Win32
+ {CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}.Debug|Win32.Build.0 = Debug|Win32
+ {CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}.Release_SSE|Win32.ActiveCfg = Release|Win32
+ {CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}.Release_SSE|Win32.Build.0 = Release|Win32
+ {CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}.Release_SSE2|Win32.ActiveCfg = Release|Win32
+ {CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}.Release_SSE2|Win32.Build.0 = Release|Win32
+ {CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}.Release|Win32.ActiveCfg = Release|Win32
+ {CEBDE98B-A6AA-46E6-BC79-FAAF823DB9EC}.Release|Win32.Build.0 = Release|Win32
+ {5833EEA1-1068-431F-A6E5-316E7DC5D90A}.Debug|Win32.ActiveCfg = Debug|Win32
+ {5833EEA1-1068-431F-A6E5-316E7DC5D90A}.Debug|Win32.Build.0 = Debug|Win32
+ {5833EEA1-1068-431F-A6E5-316E7DC5D90A}.Release_SSE|Win32.ActiveCfg = Release_SSE|Win32
+ {5833EEA1-1068-431F-A6E5-316E7DC5D90A}.Release_SSE|Win32.Build.0 = Release_SSE|Win32
+ {5833EEA1-1068-431F-A6E5-316E7DC5D90A}.Release_SSE2|Win32.ActiveCfg = Release_SSE2|Win32
+ {5833EEA1-1068-431F-A6E5-316E7DC5D90A}.Release_SSE2|Win32.Build.0 = Release_SSE2|Win32
+ {5833EEA1-1068-431F-A6E5-316E7DC5D90A}.Release|Win32.ActiveCfg = Release|Win32
+ {5833EEA1-1068-431F-A6E5-316E7DC5D90A}.Release|Win32.Build.0 = Release|Win32
+ {E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}.Debug|Win32.ActiveCfg = Debug|Win32
+ {E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}.Debug|Win32.Build.0 = Debug|Win32
+ {E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}.Release_SSE|Win32.ActiveCfg = Release_SSE|Win32
+ {E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}.Release_SSE|Win32.Build.0 = Release_SSE|Win32
+ {E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}.Release_SSE2|Win32.ActiveCfg = Release_SSE2|Win32
+ {E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}.Release_SSE2|Win32.Build.0 = Release_SSE2|Win32
+ {E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}.Release|Win32.ActiveCfg = Release|Win32
+ {E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}.Release|Win32.Build.0 = Release|Win32
+ EndGlobalSection
+ GlobalSection(SolutionProperties) = preSolution
+ HideSolutionNode = FALSE
+ EndGlobalSection
+EndGlobal
Added: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisdec/vorbisdec.vcproj
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisdec/vorbisdec.vcproj (rev 0)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisdec/vorbisdec.vcproj 2008-06-13 23:59:37 UTC (rev 15029)
@@ -0,0 +1,397 @@
+<?xml version="1.0" encoding="Windows-1252"?>
+<VisualStudioProject
+ ProjectType="Visual C++"
+ Version="9,00"
+ Name="vorbisdec"
+ ProjectGUID="{5833EEA1-1068-431F-A6E5-316E7DC5D90A}"
+ Keyword="Win32Proj"
+ TargetFrameworkVersion="131072"
+ >
+ <Platforms>
+ <Platform
+ Name="Win32"
+ />
+ </Platforms>
+ <ToolFiles>
+ </ToolFiles>
+ <Configurations>
+ <Configuration
+ Name="Debug|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="1"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="0"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;_DEBUG;_CONSOLE"
+ MinimalRebuild="true"
+ BasicRuntimeChecks="3"
+ RuntimeLibrary="1"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="4"
+ CompileAs="1"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/vorbisdec.exe"
+ LinkIncremental="2"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ GenerateDebugInformation="true"
+ ProgramDatabaseFile="$(OutDir)/vorbisdec.pdb"
+ SubSystem="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="1"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ WholeProgramOptimization="1"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="3"
+ InlineFunctionExpansion="2"
+ EnableIntrinsicFunctions="true"
+ FavorSizeOrSpeed="1"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_CONSOLE"
+ StringPooling="true"
+ ExceptionHandling="0"
+ RuntimeLibrary="0"
+ BufferSecurityCheck="false"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ CompileAs="1"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/vorbisdec.exe"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ GenerateDebugInformation="false"
+ SubSystem="1"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ OptimizeForWindows98="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release_SSE|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="1"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ WholeProgramOptimization="1"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="3"
+ InlineFunctionExpansion="2"
+ EnableIntrinsicFunctions="true"
+ FavorSizeOrSpeed="1"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_CONSOLE"
+ StringPooling="true"
+ ExceptionHandling="0"
+ RuntimeLibrary="0"
+ BufferSecurityCheck="false"
+ EnableEnhancedInstructionSet="1"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ CompileAs="1"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/vorbisdec.exe"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ GenerateDebugInformation="false"
+ SubSystem="1"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ OptimizeForWindows98="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release_SSE2|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="1"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ WholeProgramOptimization="1"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="3"
+ InlineFunctionExpansion="2"
+ EnableIntrinsicFunctions="true"
+ FavorSizeOrSpeed="1"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_CONSOLE"
+ StringPooling="true"
+ ExceptionHandling="0"
+ RuntimeLibrary="0"
+ BufferSecurityCheck="false"
+ EnableEnhancedInstructionSet="2"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ CompileAs="1"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/vorbisdec.exe"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ GenerateDebugInformation="false"
+ SubSystem="1"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ OptimizeForWindows98="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ </Configurations>
+ <References>
+ <ProjectReference
+ ReferencedProjectIdentifier="{3A214E06-B95E-4D61-A291-1F8DF2EC10FD}"
+ />
+ </References>
+ <Files>
+ <Filter
+ Name="Source Files"
+ Filter="cpp;c;cxx;def;odl;idl;hpj;bat;asm;asmx"
+ UniqueIdentifier="{4FC737F1-C7A5-4376-A066-2A32D752A2FF}"
+ >
+ <File
+ RelativePath="..\..\..\examples\decoder_example.c"
+ >
+ </File>
+ </Filter>
+ <Filter
+ Name="Header Files"
+ Filter="h;hpp;hxx;hm;inl;inc;xsd"
+ UniqueIdentifier="{93995380-89BD-4b04-88EB-625FBE52EBFB}"
+ >
+ </Filter>
+ <Filter
+ Name="Resource Files"
+ Filter="rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx"
+ UniqueIdentifier="{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}"
+ >
+ </Filter>
+ </Files>
+ <Globals>
+ </Globals>
+</VisualStudioProject>
Added: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisenc/vorbisenc.vcproj
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisenc/vorbisenc.vcproj (rev 0)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/VS2008/vorbisenc/vorbisenc.vcproj 2008-06-13 23:59:37 UTC (rev 15029)
@@ -0,0 +1,398 @@
+<?xml version="1.0" encoding="Windows-1252"?>
+<VisualStudioProject
+ ProjectType="Visual C++"
+ Version="9,00"
+ Name="vorbisenc"
+ ProjectGUID="{E48B6A8B-F7FE-4DA8-8248-E64DBAC4F56C}"
+ Keyword="Win32Proj"
+ TargetFrameworkVersion="131072"
+ >
+ <Platforms>
+ <Platform
+ Name="Win32"
+ />
+ </Platforms>
+ <ToolFiles>
+ </ToolFiles>
+ <Configurations>
+ <Configuration
+ Name="Debug|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="1"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="0"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;_DEBUG;_CONSOLE"
+ MinimalRebuild="true"
+ ExceptionHandling="0"
+ BasicRuntimeChecks="3"
+ RuntimeLibrary="1"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="4"
+ CompileAs="1"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/vorbisenc.exe"
+ LinkIncremental="2"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ GenerateDebugInformation="true"
+ ProgramDatabaseFile="$(OutDir)/vorbisenc.pdb"
+ SubSystem="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="1"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ WholeProgramOptimization="1"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="3"
+ InlineFunctionExpansion="2"
+ EnableIntrinsicFunctions="true"
+ FavorSizeOrSpeed="1"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_CONSOLE"
+ StringPooling="true"
+ ExceptionHandling="0"
+ RuntimeLibrary="0"
+ BufferSecurityCheck="false"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ CompileAs="1"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/vorbisenc.exe"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ GenerateDebugInformation="false"
+ SubSystem="1"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ OptimizeForWindows98="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release_SSE|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="1"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ WholeProgramOptimization="1"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="3"
+ InlineFunctionExpansion="2"
+ EnableIntrinsicFunctions="true"
+ FavorSizeOrSpeed="1"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_CONSOLE"
+ StringPooling="true"
+ ExceptionHandling="0"
+ RuntimeLibrary="0"
+ BufferSecurityCheck="false"
+ EnableEnhancedInstructionSet="1"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ CompileAs="1"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/vorbisenc.exe"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ GenerateDebugInformation="false"
+ SubSystem="1"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ OptimizeForWindows98="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ <Configuration
+ Name="Release_SSE2|Win32"
+ OutputDirectory="$(SolutionDir)$(ConfigurationName)"
+ IntermediateDirectory="$(ConfigurationName)"
+ ConfigurationType="1"
+ InheritedPropertySheets="$(VCInstallDir)VCProjectDefaults\UpgradeFromVC71.vsprops"
+ CharacterSet="2"
+ WholeProgramOptimization="1"
+ >
+ <Tool
+ Name="VCPreBuildEventTool"
+ />
+ <Tool
+ Name="VCCustomBuildTool"
+ />
+ <Tool
+ Name="VCXMLDataGeneratorTool"
+ />
+ <Tool
+ Name="VCWebServiceProxyGeneratorTool"
+ />
+ <Tool
+ Name="VCMIDLTool"
+ />
+ <Tool
+ Name="VCCLCompilerTool"
+ Optimization="3"
+ InlineFunctionExpansion="2"
+ EnableIntrinsicFunctions="true"
+ FavorSizeOrSpeed="1"
+ AdditionalIncludeDirectories="..\..\..\include;..\..\..\..\libogg\include"
+ PreprocessorDefinitions="WIN32;NDEBUG;_CONSOLE"
+ StringPooling="true"
+ ExceptionHandling="0"
+ RuntimeLibrary="0"
+ BufferSecurityCheck="false"
+ EnableEnhancedInstructionSet="2"
+ UsePrecompiledHeader="0"
+ WarningLevel="3"
+ Detect64BitPortabilityProblems="true"
+ DebugInformationFormat="3"
+ CompileAs="1"
+ />
+ <Tool
+ Name="VCManagedResourceCompilerTool"
+ />
+ <Tool
+ Name="VCResourceCompilerTool"
+ />
+ <Tool
+ Name="VCPreLinkEventTool"
+ />
+ <Tool
+ Name="VCLinkerTool"
+ AdditionalDependencies="libogg.lib libvorbis.lib"
+ OutputFile="$(OutDir)/vorbisenc.exe"
+ LinkIncremental="1"
+ AdditionalLibraryDirectories=""..\..\..\..\libogg\win32\VS2005\$(ConfigurationName)";"..\$(ConfigurationName)""
+ GenerateDebugInformation="false"
+ SubSystem="1"
+ OptimizeReferences="2"
+ EnableCOMDATFolding="2"
+ OptimizeForWindows98="1"
+ RandomizedBaseAddress="1"
+ DataExecutionPrevention="0"
+ TargetMachine="1"
+ />
+ <Tool
+ Name="VCALinkTool"
+ />
+ <Tool
+ Name="VCManifestTool"
+ />
+ <Tool
+ Name="VCXDCMakeTool"
+ />
+ <Tool
+ Name="VCBscMakeTool"
+ />
+ <Tool
+ Name="VCFxCopTool"
+ />
+ <Tool
+ Name="VCAppVerifierTool"
+ />
+ <Tool
+ Name="VCPostBuildEventTool"
+ />
+ </Configuration>
+ </Configurations>
+ <References>
+ <ProjectReference
+ ReferencedProjectIdentifier="{3A214E06-B95E-4D61-A291-1F8DF2EC10FD}"
+ />
+ </References>
+ <Files>
+ <Filter
+ Name="Source Files"
+ Filter="cpp;c;cxx;def;odl;idl;hpj;bat;asm;asmx"
+ UniqueIdentifier="{4FC737F1-C7A5-4376-A066-2A32D752A2FF}"
+ >
+ <File
+ RelativePath="..\..\..\examples\encoder_example.c"
+ >
+ </File>
+ </Filter>
+ <Filter
+ Name="Header Files"
+ Filter="h;hpp;hxx;hm;inl;inc;xsd"
+ UniqueIdentifier="{93995380-89BD-4b04-88EB-625FBE52EBFB}"
+ >
+ </Filter>
+ <Filter
+ Name="Resource Files"
+ Filter="rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx"
+ UniqueIdentifier="{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}"
+ >
+ </Filter>
+ </Files>
+ <Globals>
+ </Globals>
+</VisualStudioProject>
Modified: trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/vorbis.def
===================================================================
--- trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/vorbis.def 2008-06-13 23:05:29 UTC (rev 15028)
+++ trunk/oggdsf/src/lib/codecs/vorbis/libs/libvorbis/win32/vorbis.def 2008-06-13 23:59:37 UTC (rev 15029)
@@ -1,5 +1,5 @@
;
-; $Id: vorbis.def 7187 2004-07-20 07:24:27Z xiphmont $
+; $Id: vorbis.def 13284 2007-07-20 03:47:48Z tterribe $
;
LIBRARY
EXPORTS
@@ -45,6 +45,7 @@
vorbis_packet_blocksize
vorbis_synthesis_halfrate
vorbis_synthesis_halfrate_p
+vorbis_synthesis_idheader
;
vorbis_window
_analysis_output_always
@@ -53,4 +54,4 @@
vorbis_encode_setup_vbr
vorbis_encode_init_vbr
vorbis_encode_setup_init
-vorbis_encode_ctl
\ No newline at end of file
+vorbis_encode_ctl
More information about the commits
mailing list