1SoX 2--- 3 4This file contains information specific to the Win32 version of SoX. 5Please refer to the README file for general information. 6 7The binary SOX.EXE can be installed anywhere you desire. The only 8restriction is that the included ZLIB1..DLL and LIBGOMP-1.DLL must be 9located in the same directory as SOX.EXE or somewhere within your PATH. 10 11SoX Helper Applications 12----------------------- 13 14SoX also includes support for SOXI.EXE, PLAY.EXE and REC.EXE and their 15behaviors are documented in included PDF's. They have the same 16install restrictions as SOX.EXE. 17 18SOXI.EXE, PLAY.EXE, and REC.EXE are not distributed with this package to 19reduce size requirements. They are, in fact, only copies of the original 20SOX.EXE binary which changes SOX.EXE's behavior based on the 21executable's filename. 22 23If you wish to make use of these utils then you can create them 24yourself. 25 26copy sox.exe soxi.exe 27copy sox.exe play.exe 28copy sox.exe rec.exe 29 30If you are concerned with disk space, the play and record 31functionality can be equated using the "-d" option with SOX.EXE. soxi 32functionality can be equated using the "--info" option with SOX.EXE. The 33rough syntax is: 34 35play: sox [input files and options] -d [effects] 36rec: sox -d [output file and options] [effects] 37soxi: sox --info [input files and options] 38 39Acknowledgements 40---------------- 41 42SOX.EXE included in this package makes use of the following projects. 43See the cygbuild script included with the source code package for 44further information on how it was compiled and packaged. 45 46 SoX - http://sox.sourceforge.net 47 48 FLAC - http://flac.sourceforge.net 49 50 LADSPA - http://www.ladspa.org 51 52 libid3tag - http://www.underbit.com/products/mad 53 54 libsndfile - http://www.mega-nerd.com/libsndfile 55 56 Ogg Vorbis - http://www.vorbis.com 57 58 PNG - http://www.libpng.org/pub/png 59 60 WavPack - http://www.wavpack.com 61 62 wget - http://www.gnu.org/software/wget 63 64Enjoy, 65The SoX Development Team 66 67Appendix - wget Support 68----------------------- 69 70SoX can make use of the wget command line utility to load files over 71the internet. A binary copy of wget has been included with this 72package of SoX for your convience. 73 74For SoX to make use of wget, it must be located either in your PATH or 75within the same directory that SoX is ran from. 76 77Custom configuration of wget can be made by editing the file wget.ini 78contained in the same directory as wget.exe. 79 80Please consult wget's homepage for access to source code as well as 81further instructions on configuring. 82 83http://www.gnu.org/software/wget 84 85Appendix - MP3 Support 86---------------------- 87 88SoX contains support for reading and writing MP3 files but does not ship 89with the DLL's that perform decoding and encoding of MP3 data because 90of patent restrictions. For further details, refer to: 91 92http://en.wikipedia.org/wiki/MP3#Licensing_and_patent_issues 93 94MP3 support can be enabled by placing Lame encoding DLL and/or 95MAD decoding DLL into the same directory as SOX.EXE. These 96can be compiled yourself, they may turn up on searches of the internet 97or may be included with other MP3 applications already installed 98on your system. For encoding/writing, try searching for lame-enc.dll, 99libmp3lame-0.dll, libmp3lame.dll, or cygmp3lame-0.dll. For 100decoding/reading, try searching for libmad-0.dll, libmad.dll or cygmad-0.dll. 101 102Instructions are included here for using MSYS to create the DLL's. 103It is assumed you already have MSYS installed on your system 104with a working gcc compiler. The commands are ran from MSYS 105bash shell. 106 107Obtain the latest Lame and MAD source code from approprate locations. 108 109Lame MP3 encoder http://lame.sourceforge.net 110MAD MP3 decoder http://www.underbit.com/products/mad 111 112cd lame-398-2 113./configure --disabled-static --enable-shared 114make 115cp libmp3lame/.libs/libmp3lame-0.dll /path/to/sox 116 117MAD libraries up to 0.15.1b have a bug in configure that will not allow 118building DLL under mingw. This can be resolved by adding LDFLAGS 119to configure and editing the generated Makefile to remove an invalid 120option. 121 122cd libmad-0.15.1b 123./configure --enable-shared --disable-static LDFLAGS="-no-undefined" 124[edit Makefile, search for "-fforce-mem" and delete it.] 125make 126cp libmad-0.dll /path/to/sox/ 127 128Appendix - AMR-NB/AMR-WB Support 129-------------------------------- 130 131SoX contains support for reading and writing AMR-NB and AMR-WB files but 132does not ship with the DLL's that perform decoding and encoding of AMR 133data because of patent restrictions. 134 135AMR-NB/AMR-WB support can be enabled by placing required DLL's 136into the same directory as SOX.EXE. These can be compiled yourself, 137they may turn up on searches of the internet or may be included with other 138MP3 applications already installed on your system. For AMR-NB support, 139try searching for libamrnb-3.dll, libopencore-amrnb-0.dll, or 140libopencore-amrnb.dll. For AMR-WB support, try searching for libamrwb-3.dll, 141libopencore-amrwb-0.dll, or libopencore-amrwb.dll. 142 143Instructions are included here for using MSYS to create the DLL's. 144It is assumed you already have MSYS installed on your system with 145working gcc compiler. These commands are ran from MSYS bash shell. 146 147Obtain the latest amrnb and amrwb source code from 148http://sourceforge.net/projects/opencore-amr . 149 150cd opencore-amr-0.1.2 151./configure --enable-shared --disable-static LDFLAGS="-no-undefined" 152make 153cp amrnb/.libs/libopencore-amrnb-0.dll /path/to/sox 154cp amrwb/.libs/libopencore-amrwb-0.dll /path/to/sox 155 156Appendix - LADSPA Plugins 157------------------------- 158 159SoX has built in support for LADSPA Plugins. These plugins are 160mostly built for Linux but some are available for Windows. 161The Audacity GUI application has a page that points to a collection 162of Windows LADSPA plugins. 163 164http://audacity.sourceforge.net/download/plugins 165 166SoX will search for these plugins based on LADSPA_PATH 167enviornment variable. See sox.txt for further information. 168