media/libtremor/README@b8a032363ba2 (annotated)
media/libtremor/README
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | This README covers the Ogg Vorbis 'Tremor' integer playback codec |
| michael@0 | 2 | source as of date 2002 09 02, version 1.0.0. |
| michael@0 | 3 | |
| michael@0 | 4 | ****** |
| michael@0 | 5 | |
| michael@0 | 6 | The C source in this package will build on any ANSI C compiler and |
| michael@0 | 7 | function completely and properly on any platform. The included build |
| michael@0 | 8 | system assumes GNU build system and make tools (m4, automake, |
| michael@0 | 9 | autoconf, libtool and gmake). GCC is not required, although GCC is |
| michael@0 | 10 | the most tested compiler. To build using GNU tools, type in the |
| michael@0 | 11 | source directory: |
| michael@0 | 12 | |
| michael@0 | 13 | ./autogen.sh |
| michael@0 | 14 | make |
| michael@0 | 15 | |
| michael@0 | 16 | Currently, the source implements playback in pure C on all platforms |
| michael@0 | 17 | except ARM, where a [currently] small amount of assembly (see |
| michael@0 | 18 | asm_arm.h) is used to implement 64 bit math operations and fast LSP |
| michael@0 | 19 | computation. If building on ARM without the benefit of GNU build |
| michael@0 | 20 | system tools, be sure that '_ARM_ASSEM_' is #defined by the build |
| michael@0 | 21 | system if this assembly is desired, else the resulting library will |
| michael@0 | 22 | use whatever 64 bit math builtins the compiler implements. |
| michael@0 | 23 | |
| michael@0 | 24 | No math library is required by this source. No floating point |
| michael@0 | 25 | operations are used at any point in either setup or decode. This |
| michael@0 | 26 | decoder library will properly decode any past, current or future |
| michael@0 | 27 | Vorbis I file or stream. |
| michael@0 | 28 | |
| michael@0 | 29 | ******** |
| michael@0 | 30 | |
| michael@0 | 31 | The build system produces a static and [when supported by the OS] |
| michael@0 | 32 | dynamic library named 'libvorbisidec'. This library exposes an API |
| michael@0 | 33 | nearly identical to the BSD reference library's 'libvorbisfile', |
| michael@0 | 34 | including all the features familiar to users of vorbisfile. This API |
| michael@0 | 35 | is similar enough that the proper header file to include is named |
| michael@0 | 36 | 'ivorbisfile.h' [included in the source build directory]. Lower level |
| michael@0 | 37 | libvorbis-style headers and structures are in 'ivorbiscodec.h' |
| michael@0 | 38 | [included in the source build directory]. A simple example program, |
| michael@0 | 39 | ivorbisfile_example.c, can be built with 'make example'. |
| michael@0 | 40 | |
| michael@0 | 41 | ******** |
| michael@0 | 42 | |
| michael@0 | 43 | Detailed Tremor API Documentation begins at doc/index.html |
| michael@0 | 44 | |
| michael@0 | 45 | Monty |
| michael@0 | 46 | xiph.org |
