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