README 1.9 KB

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