SoX Installation                           ---------------- SoX should compile and run on any POSIX compatible system (Linux, BSD,Solaris, Xcode on Mac OS X, Cygwin on MS-Windows, etc.).  For othercompilers/systems, it is often possible to manually construct a custom`soxconfig.h' and `Makefile' for that system (the minimum requirementsare 32-bit CPU, 64-bit FPU, C89 compiler). Note that the `play', `rec', and `soxi' programs are in fact justcopies-of or links-to (depending on OS) `sox'. SoX optionally makes use of some external libraries to obtain supportfor additional file formats and/or effects.  Optional libraries shouldbe installed before compiling SoX.  The current list of supportedlibraries, where to get them (if not from your OS distribution), andtheir licence types, is as follows: OpencoreAMR-NB/WB http://sourceforge.net/projects/opencore-amr  ApacheVisualOn AMR-WB   http://sourceforge.net/projects/opencore-amr  ApacheAO                http://xiph.org/ao                    GPLFLAC              http://flac.sourceforge.net           BSDLADSPA            http://www.ladspa.org                 LGPL + plugins' licenceLame MP3 encoder  http://lame.sourceforge.net           LGPLTwolame MP2 enc.  http://www.twolame.org                LGPLlibltdl           http://www.gnu.org/software/libtool   LGPLMAD MP3 decoder   http://www.underbit.com/products/mad  GPLMP3 ID3 tags      http://www.underbit.com/products/mad  GPLMagic             http://www.darwinsys.com/file         BSDOgg Vorbis        http://www.vorbis.com                 BSDOpus              http://www.opus-codec.org/            BSDPNG               http://www.libpng.org/pub/png         zlib (BSD-like)Sndfile           http://www.mega-nerd.com/libsndfile   LGPLWavPack           http://www.wavpack.com                BSD   Compiling and installing on a POSIX system------------------------------------------ First install any optional libraries that you need for SoX.  Somelibraries may require pkg-config to be installed to be properlydetected by SoX. [Only if you're compiling the git sources, first make sure you havethe GNU autotools (automake >= 1.9, autoconf >= 2.62, autoconf-archive)installed, then run 	autoreconf -i] To compile and install SoX (executables, libraries, manual pages) witha default configuration for your platform, run the following commands: 	./configure	make	make install There should be no errors and few, if any, warnings during the `make'stage.  Any warnings about pointer mismatch or conversion shouldbe treated with deep suspicion. The `make install' command may require `root' priviliges. To run a selection of tests on the installed sox executable: 	make installcheck Optionally, HTML & PDF versions of the manual pages can be built andinstalled as follows: 	make html	make install-html	make pdf	make install-pdf Again, `root' priviliges may be needed at the install stages.   Custom build options-------------------- Selection of optional libraries and of other build options can be madeby adding parameters to the `./configure' command line (above).  Run 	./configure --help for a complete list of options. Each optional file-format may be configured to be loaded statically(the default) or dynamically.  The dynamic option may be useful fordistribution packaging reasons -- for example, to keep separate `free'and `non-free' software. If you are building SoX for a `distribution' (i.e. the build will beused by others), please use --with-distro to identify the distributionas this information is useful in helping to diagnose SoX bug reports.For example, 	./configure --with-distro='Super Linux OS 6.1' If any libraries are installed in a non-standard locations in yoursystem, the compiler and linker must be informed of this.  Often,environment variables can be used for this purpose.  For example, ifusing the GNU or Clang/LLVM toolchains, the following might be used ina Bourne-compatible shell: export CPATH=/usr/local/includeexport LIBRARY_PATH=/usr/local/lib For other compilers and shells, consult their respective manuals. Optional features----------------- Support for some file formats is optional and controlled by --enable-*flags to configure.  If the value "dyn" is passed to these flags,e.g. --enable-flac=dyn, the corresponding code is built as a moduleand loaded at runtime. Use of external libraries is controlled by --with-* flags.  Some ofthese accept the value "dyn" to enable runtime loading of the library. The runtime loading feature is mainly useful for distributing the"sox" executable to systems that may not have all the externallibraries installed. For a complete list of optional formats and libraries, including whichsupport runtime loading, refer to the "configure --help" output. Testing------- N.B.: If SoX is configured and compiled to load some file-formatsdynamically, then it will not be able to load them when running SoXexecutables from within the source file directory until after SoX hasbeen installed (temporarily configuring with --without-libltdl removesthis restriction). After successfully compiling SoX, try translating a sound file.  Youshould also playback the new file to make sure it sounds like theoriginal.  You can either use an external program or SoX itselfif compiled with playback support. To work with widest range of playback programs, you should chose aformat that is native to your OS; such as .wav for Windows or .aiff forMacOS.  In the following example, we'll use .xxx as the extension ofyour preferred format.         cd src	./sox monkey.wav monkey.xxx You may have to give the sample format and rate for the file. For example,this command will make a sound file with a data rate of 12,500 samplesper second and the data formatted as 16-bit signed integers: 	./sox monkey.wav -r 12500 -b 16 -e signed-integer monkey.xxx If playback support was compiled in then it can be played like this:         ./play monkey.xxx or, equivalently:         ./sox monkey.xxx -d If monkey.xxx plays properly (it's a very short monkey screech),congratulations! SoX works. If you're adding new features to SoX or want to perform advance testson a new platform then you can use the scripts "tests.sh" and"testall.sh" to stress SoX.