sox.1: fix example for mcompand
[sox.git] / README.osx
blob35789e30ccda92512e68fa76bcfcb3e62e56e1b7
1 SoX
2 ---
4 This file contains information specific to the MacOS X version of SoX.
5 Please refer to the README file for general information.
7 The sox executable can be installed anywhere you desire.  It is a
8 self-contained statically linked executable.
10 If the sox executable is invoked with an executable name of soxi, play,
11 or rec it will perform the functions of those applications as defined
12 in included documents.  Symlinks are included with this package
13 but you can also make your own.
15 Acknowledgements
16 ----------------
18 The sox exectables included in this package makes use of the following projects:
20   SoX - http://sox.sourceforge.net
22   FLAC - http://flac.sourceforge.net
24   LADSPA - http://www.ladspa.org
26   libid3tag - http://www.underbit.com/products/mad
28   libltdl - http://www.gnu.org/software/libtool
30   libsndfile - http://www.mega-nerd.com/libsndfile
32   Ogg Vorbis - http://www.vorbis.com
34   PNG - http://www.libpng.org/pub/png
36   WavPack - http://www.wavpack.com
38 Enjoy,
39 The SoX Development Team
41 Appendix - wget Support
42 -----------------------
44 SoX can make use of the wget command line utility to load files over
45 the internet or listen to shoutcast streams.  It only needs to be
46 somewhere in your path to be used by SoX.
48 Please consult wget's homepage for access to source code as well
49 as further instructions on configuring and installing.
51 http://www.gnu.org/software/wget
53 Appendix - MP3 Support
54 ----------------------
56 SoX contains support for reading and writing MP3 files but does not ship
57 with the dylib's that perform decoding and encoding of MP3 data because
58 of patent restrictions.  For further details, refer to:
60 http://en.wikipedia.org/wiki/MP3#Licensing_and_patent_issues
62 MP3 support can be enabled by placing Lame encoding library and/or
63 MAD decoding library into a standard library search location such
64 as /usr/lib or set LTDL_LIBRARY_PATH to location.
66 These can be compiled yourself, they may turn up on searches of the internet
67 or may be included with other MP3 applications already installed
68 on your system. Try searching for libmp3lame.dylib and libmad.dylib.
70 Obtain the latest Lame and MAD source code from approprate locations.
72 Lame MP3 encoder  http://lame.sourceforge.net
73 MAD MP3 decoder   http://www.underbit.com/products/mad
75 If your system is setup to compile software, then the following commands
76 can be used.  Note: since SoX is distributed as a 32-bit i386 binary,
77 the library must match that format as well:
79 cd lame-398-2
80 ./configure CFLAGS="-arch i386 -m32" LDFALGS="-arch i386"
81 make
82 sudo make install
84 cd libmad-0.15.1b
85 ./configure CFLAGS="-arch i386 -m32" LDFALGS="-arch i386"
86 make
87 sudo make install
89 Appendix - AMR-NB/AMR-WB Support
90 --------------------------------
92 SoX contains support for reading and writing AMR-NB and AMR-WB files but
93 does not ship with the DLL's that perform decoding and encoding of AMR
94 data because of patent restrictions.
96 AMR-NB/AMR-WB support can be enabled by placing required libraries
97 into a standard library search location such as /usr/lib
98 or set LTDL_LIBRARY_PATH to search path.
100 These can be compiled yourself, they may turn up on searches of the internet
101 or may be included with other AMR applications already installed
102 on your system. Try searching for libopencore-amrnb.dylib and
103 libopencore-amrwb.dylib.
105 Obtain the latest amrnb and amrwb source code from
106 http://sourceforge.net/projects/opencore-amr
108 cd opencore-amr-0.1.2
109 ./configure CFLAGS="-arch i386 -m32" LDFALGS="-arch i386"
110 make
111 sudo make install
113 If that does not work, then try this:
115 cd opencore-amr-0.1.2
116 ./build_osx.sh
118 Appendix - LADSPA Plugins
119 -------------------------
121 SoX has built in support for LADSPA Plugins.  These plugins are
122 mostly built for Linux but some are available for OS X.
123 The Audacity GUI application has a page that points to a collection
124 of OS X LADSPA plugins.
126 http://audacity.sourceforge.net/download/plugins
128 SoX will search for these plugins based on LADSPA_PATH
129 enviornment variable.  See sox.txt for further information.