michael@0: This README covers the Ogg Vorbis 'Tremor' integer playback codec
michael@0: source as of date 2002 09 02, version 1.0.0.
michael@0: 
michael@0:                             ******
michael@0: 
michael@0: The C source in this package will build on any ANSI C compiler and
michael@0: function completely and properly on any platform.  The included build
michael@0: system assumes GNU build system and make tools (m4, automake,
michael@0: autoconf, libtool and gmake).  GCC is not required, although GCC is
michael@0: the most tested compiler.  To build using GNU tools, type in the
michael@0: source directory:
michael@0: 
michael@0: ./autogen.sh
michael@0: make
michael@0: 
michael@0: Currently, the source implements playback in pure C on all platforms
michael@0: except ARM, where a [currently] small amount of assembly (see
michael@0: asm_arm.h) is used to implement 64 bit math operations and fast LSP
michael@0: computation.  If building on ARM without the benefit of GNU build
michael@0: system tools, be sure that '_ARM_ASSEM_' is #defined by the build
michael@0: system if this assembly is desired, else the resulting library will
michael@0: use whatever 64 bit math builtins the compiler implements.
michael@0: 
michael@0: No math library is required by this source.  No floating point
michael@0: operations are used at any point in either setup or decode.  This
michael@0: decoder library will properly decode any past, current or future
michael@0: Vorbis I file or stream.
michael@0: 
michael@0:                            ********
michael@0: 
michael@0: The build system produces a static and [when supported by the OS]
michael@0: dynamic library named 'libvorbisidec'.  This library exposes an API
michael@0: nearly identical to the BSD reference library's 'libvorbisfile',
michael@0: including all the features familiar to users of vorbisfile.  This API
michael@0: is similar enough that the proper header file to include is named
michael@0: 'ivorbisfile.h' [included in the source build directory].  Lower level
michael@0: libvorbis-style headers and structures are in 'ivorbiscodec.h'
michael@0: [included in the source build directory]. A simple example program,
michael@0: ivorbisfile_example.c, can be built with 'make example'.
michael@0: 
michael@0:                            ********
michael@0: 
michael@0: Detailed Tremor API Documentation begins at doc/index.html
michael@0: 
michael@0: Monty
michael@0: xiph.org