1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/media/libtremor/README Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,46 @@
1.4 +This README covers the Ogg Vorbis 'Tremor' integer playback codec
1.5 +source as of date 2002 09 02, version 1.0.0.
1.6 +
1.7 + ******
1.8 +
1.9 +The C source in this package will build on any ANSI C compiler and
1.10 +function completely and properly on any platform. The included build
1.11 +system assumes GNU build system and make tools (m4, automake,
1.12 +autoconf, libtool and gmake). GCC is not required, although GCC is
1.13 +the most tested compiler. To build using GNU tools, type in the
1.14 +source directory:
1.15 +
1.16 +./autogen.sh
1.17 +make
1.18 +
1.19 +Currently, the source implements playback in pure C on all platforms
1.20 +except ARM, where a [currently] small amount of assembly (see
1.21 +asm_arm.h) is used to implement 64 bit math operations and fast LSP
1.22 +computation. If building on ARM without the benefit of GNU build
1.23 +system tools, be sure that '_ARM_ASSEM_' is #defined by the build
1.24 +system if this assembly is desired, else the resulting library will
1.25 +use whatever 64 bit math builtins the compiler implements.
1.26 +
1.27 +No math library is required by this source. No floating point
1.28 +operations are used at any point in either setup or decode. This
1.29 +decoder library will properly decode any past, current or future
1.30 +Vorbis I file or stream.
1.31 +
1.32 + ********
1.33 +
1.34 +The build system produces a static and [when supported by the OS]
1.35 +dynamic library named 'libvorbisidec'. This library exposes an API
1.36 +nearly identical to the BSD reference library's 'libvorbisfile',
1.37 +including all the features familiar to users of vorbisfile. This API
1.38 +is similar enough that the proper header file to include is named
1.39 +'ivorbisfile.h' [included in the source build directory]. Lower level
1.40 +libvorbis-style headers and structures are in 'ivorbiscodec.h'
1.41 +[included in the source build directory]. A simple example program,
1.42 +ivorbisfile_example.c, can be built with 'make example'.
1.43 +
1.44 + ********
1.45 +
1.46 +Detailed Tremor API Documentation begins at doc/index.html
1.47 +
1.48 +Monty
1.49 +xiph.org
