apps/codecs/libwavpack/README

   1 ////////////////////////////////////////////////////////////////////////////
   2 //                           **** WAVPACK ****                            //
   3 //                  Hybrid Lossless Wavefile Compressor                   //
   4 //              Copyright (c) 1998 - 2004 Conifer Software.               //
   5 //                          All Rights Reserved.                          //
   6 //      Distributed under the BSD Software License (see license.txt)      //
   7 ////////////////////////////////////////////////////////////////////////////
   8
   9 This package contains a tiny version of the WavPack 4.0 decoder that might
  10 be used in a "resource limited" CPU environment or form the basis for a
  11 hardware decoding implementation. It is packaged with a demo command-line
  12 program that accepts a WavPack audio file on stdin and outputs a RIFF wav
  13 file to stdout. The program is standard C, and a win32 executable is
  14 included which was compiled under MS Visual C++ 6.0 using this command:
  15
  16 cl /O1 /DWIN32 wvfilter.c wputils.c unpack.c float.c metadata.c words.c bits.c
  17
  18 WavPack data is read with a stream reading callback. No direct seeking is
  19 provided for, but it is possible to start decoding anywhere in a WavPack
  20 stream. In this case, WavPack will be able to provide the sample-accurate
  21 position when it synchs with the data and begins decoding.
  22
  23 For demonstration purposes this uses a single static copy of the
  24 WavpackContext structure, so obviously it cannot be used for more than one
  25 file at a time. Also, this decoder will not handle "correction" files, plays
  26 only the first two channels of multi-channel files, and is limited in
  27 resolution in some large integer or floating point files (but always
  28 provides at least 24 bits of resolution). It also will not accept WavPack
  29 files from before version 4.0.
  30
  31 To make this code viable on the greatest number of hardware platforms, the
  32 following are true:
  33
  34    speed is about 4x realtime on an AMD K6 300 MHz
  35       ("high" mode 16/44 stereo; normal mode is about twice that fast)
  36
  37    no floating-point math required; just 32b * 32b = 32b int multiply
  38
  39    large data areas are static and less than 4K total
  40    executable code and tables are less than 32K
  41    no malloc / free usage
  42
  43 To maintain compatibility on various platforms, the following conventions
  44 are used:
  45
  46    a "short" must be 16-bits
  47    a "long" must be 32-bits
  48    an "int" must be at least 16-bits, but may be larger
  49    a "char" must default to signed
  50
  51
  52 Questions or comments should be directed to david@wavpack.com