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