Mercurial > hg > audiostuff
comparison spandsp-0.0.6pre17/INSTALL @ 4:26cd8f1ef0b1
import spandsp-0.0.6pre17
| author | Peter Meerwald <pmeerw@cosy.sbg.ac.at> |
|---|---|
| date | Fri, 25 Jun 2010 15:50:58 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 3:c6c5a16ce2f2 | 4:26cd8f1ef0b1 |
|---|---|
| 1 Building and installing spandsp | |
| 2 =============================== | |
| 3 | |
| 4 A number of distributions include spandsp, but they usually use older versions | |
| 5 of the library, which lack a lot of the features of the current version. Before | |
| 6 installing spandsp, make sure there are no older versions already on your | |
| 7 machine. Make sure libtiff is installed on your machine. Versions 3.5.7, | |
| 8 3.6.0, 3.7.1 and 3.8.2 seem to work OK. There have been several bugs related | |
| 9 to FAX document handling in some versions of libtiff. Also, some people have | |
| 10 had trouble using spandsp because they had more than one version of libtiff | |
| 11 on their machine. Take care with this. If you are using an RPM based system, | |
| 12 such as RedHat or Fedora, you will need the libtiff and libtiff-devel RPMs | |
| 13 installed to be able to build spandsp. | |
| 14 | |
| 15 You can use the usual: | |
| 16 | |
| 17 ./configure | |
| 18 make | |
| 19 make install | |
| 20 | |
| 21 process to build the spandsp library. Note that if you use configure in this | |
| 22 way, the software will be installed in /usr/local. In this case make sure your | |
| 23 /etc/ld.so.conf file has an entry for /usr/local/lib. If you wish the software | |
| 24 to be installed in /usr, you should build it with the commands. | |
| 25 | |
| 26 ./configure --prefix=/usr | |
| 27 make | |
| 28 make install | |
| 29 | |
| 30 | |
| 31 Building the programming documentation | |
| 32 ====================================== | |
| 33 | |
| 34 If you wish to build the programming documentation for spandsp, configure | |
| 35 spandsp with: | |
| 36 | |
| 37 ./configure --enable-doc | |
| 38 | |
| 39 You need doxygen installed on your machine. | |
| 40 | |
| 41 | |
| 42 Building the test suite | |
| 43 ======================= | |
| 44 | |
| 45 Most sections of the spandsp library have an accompanying test program in the | |
| 46 test directory. If you wish to build these test programs, configure spandsp | |
| 47 with: | |
| 48 | |
| 49 ./configure --enable-tests | |
| 50 | |
| 51 To build these tests you will need libaudiofile installed on your machine. To | |
| 52 build the modem tests, with the GUI monitoring feature you will need Fltk 1.1.4 | |
| 53 or later, an audio meter module and a cartesian plotting module. Fltk may be | |
| 54 obtained from http://www.fltk.org. The audio meter module may be obtained from | |
| 55 http://www.soft-switch.org/downloads/Fl_Audio_Meter.tgz . The cartesian plotting | |
| 56 module may be obtained from http://134.226.68.29/fltk. However, there is no | |
| 57 suitable makefile supplied with that. You can find a version at | |
| 58 http://www.soft-switch.org/downloads/Fl_Cartesian.tgz which will build as a | |
| 59 Linux library. The actual code in both these versions is identical. | |
| 60 You need to have Fltk 1.1.4 or later installed before building the plotting | |
| 61 library. | |
| 62 | |
| 63 | |
| 64 Applications | |
| 65 ============ | |
| 66 | |
| 67 Applications support for spandsp is built into packages such as Callweaver, | |
| 68 FreeSwitch and iaxmodem. Code to add spandsp based FAX support to Asterisk may | |
| 69 be found at http://sourceforge.net/projects/agx-ast-addons. | |
| 70 | |
| 71 | |
| 72 | |
| 73 | |
| 74 Basic Installation | |
| 75 ================== | |
| 76 | |
| 77 These are generic installation instructions. | |
| 78 | |
| 79 The `configure' shell script attempts to guess correct values for | |
| 80 various system-dependent variables used during compilation. It uses | |
| 81 those values to create a `Makefile' in each directory of the package. | |
| 82 It may also create one or more `.h' files containing system-dependent | |
| 83 definitions. Finally, it creates a shell script `config.status' that | |
| 84 you can run in the future to recreate the current configuration, a file | |
| 85 `config.cache' that saves the results of its tests to speed up | |
| 86 reconfiguring, and a file `config.log' containing compiler output | |
| 87 (useful mainly for debugging `configure'). | |
| 88 | |
| 89 If you need to do unusual things to compile the package, please try | |
| 90 to figure out how `configure' could check whether to do them, and mail | |
| 91 diffs or instructions to the address given in the `README' so they can | |
| 92 be considered for the next release. If at some point `config.cache' | |
| 93 contains results you don't want to keep, you may remove or edit it. | |
| 94 | |
| 95 The file `configure.ac' is used to create `configure' by a program | |
| 96 called `autoconf'. You only need `configure.ac' if you want to change | |
| 97 it or regenerate `configure' using a newer version of `autoconf'. | |
| 98 | |
| 99 The simplest way to compile this package is: | |
| 100 | |
| 101 1. `cd' to the directory containing the package's source code and type | |
| 102 `./configure' to configure the package for your system. If you're | |
| 103 using `csh' on an old version of System V, you might need to type | |
| 104 `sh ./configure' instead to prevent `csh' from trying to execute | |
| 105 `configure' itself. | |
| 106 | |
| 107 Running `configure' takes awhile. While running, it prints some | |
| 108 messages telling which features it is checking for. | |
| 109 | |
| 110 2. Type `make' to compile the package. | |
| 111 | |
| 112 3. Optionally, type `make check' to run any self-tests that come with | |
| 113 the package. | |
| 114 | |
| 115 4. Type `make install' to install the programs and any data files and | |
| 116 documentation. | |
| 117 | |
| 118 5. You can remove the program binaries and object files from the | |
| 119 source code directory by typing `make clean'. To also remove the | |
| 120 files that `configure' created (so you can compile the package for | |
| 121 a different kind of computer), type `make distclean'. There is | |
| 122 also a `make maintainer-clean' target, but that is intended mainly | |
| 123 for the package's developers. If you use it, you may have to get | |
| 124 all sorts of other programs in order to regenerate files that came | |
| 125 with the distribution. | |
| 126 | |
| 127 Compilers and Options | |
| 128 ===================== | |
| 129 | |
| 130 Some systems require unusual options for compilation or linking that | |
| 131 the `configure' script does not know about. You can give `configure' | |
| 132 initial values for variables by setting them in the environment. Using | |
| 133 a Bourne-compatible shell, you can do that on the command line like | |
| 134 this: | |
| 135 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure | |
| 136 | |
| 137 Or on systems that have the `env' program, you can do it like this: | |
| 138 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure | |
| 139 | |
| 140 Compiling For Multiple Architectures | |
| 141 ==================================== | |
| 142 | |
| 143 You can compile the package for more than one kind of computer at the | |
| 144 same time, by placing the object files for each architecture in their | |
| 145 own directory. To do this, you must use a version of `make' that | |
| 146 supports the `VPATH' variable, such as GNU `make'. `cd' to the | |
| 147 directory where you want the object files and executables to go and run | |
| 148 the `configure' script. `configure' automatically checks for the | |
| 149 source code in the directory that `configure' is in and in `..'. | |
| 150 | |
| 151 If you have to use a `make' that does not supports the `VPATH' | |
| 152 variable, you have to compile the package for one architecture at a time | |
| 153 in the source code directory. After you have installed the package for | |
| 154 one architecture, use `make distclean' before reconfiguring for another | |
| 155 architecture. | |
| 156 | |
| 157 Installation Names | |
| 158 ================== | |
| 159 | |
| 160 By default, `make install' will install the package's files in | |
| 161 `/usr/local/bin', `/usr/local/man', etc. You can specify an | |
| 162 installation prefix other than `/usr/local' by giving `configure' the | |
| 163 option `--prefix=PATH'. | |
| 164 | |
| 165 You can specify separate installation prefixes for | |
| 166 architecture-specific files and architecture-independent files. If you | |
| 167 give `configure' the option `--exec-prefix=PATH', the package will use | |
| 168 PATH as the prefix for installing programs and libraries. | |
| 169 Documentation and other data files will still use the regular prefix. | |
| 170 | |
| 171 In addition, if you use an unusual directory layout you can give | |
| 172 options like `--bindir=PATH' to specify different values for particular | |
| 173 kinds of files. Run `configure --help' for a list of the directories | |
| 174 you can set and what kinds of files go in them. | |
| 175 | |
| 176 If the package supports it, you can cause programs to be installed | |
| 177 with an extra prefix or suffix on their names by giving `configure' the | |
| 178 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. | |
| 179 | |
| 180 Optional Features | |
| 181 ================= | |
| 182 | |
| 183 Some packages pay attention to `--enable-FEATURE' options to | |
| 184 `configure', where FEATURE indicates an optional part of the package. | |
| 185 They may also pay attention to `--with-PACKAGE' options, where PACKAGE | |
| 186 is something like `gnu-as' or `x' (for the X Window System). The | |
| 187 `README' should mention any `--enable-' and `--with-' options that the | |
| 188 package recognizes. | |
| 189 | |
| 190 For packages that use the X Window System, `configure' can usually | |
| 191 find the X include and library files automatically, but if it doesn't, | |
| 192 you can use the `configure' options `--x-includes=DIR' and | |
| 193 `--x-libraries=DIR' to specify their locations. | |
| 194 | |
| 195 Specifying the System Type | |
| 196 ========================== | |
| 197 | |
| 198 There may be some features `configure' can not figure out | |
| 199 automatically, but needs to determine by the type of host the package | |
| 200 will run on. Usually `configure' can figure that out, but if it prints | |
| 201 a message saying it can not guess the host type, give it the | |
| 202 `--host=TYPE' option. TYPE can either be a short name for the system | |
| 203 type, such as `sun4', or a canonical name with three fields: | |
| 204 CPU-COMPANY-SYSTEM | |
| 205 | |
| 206 See the file `config.sub' for the possible values of each field. If | |
| 207 `config.sub' isn't included in this package, then this package doesn't | |
| 208 need to know the host type. | |
| 209 | |
| 210 If you are building compiler tools for cross-compiling, you can also | |
| 211 use the `--target=TYPE' option to select the type of system they will | |
| 212 produce code for and the `--build=TYPE' option to select the type of | |
| 213 system on which you are compiling the package. | |
| 214 | |
| 215 Sharing Defaults | |
| 216 ================ | |
| 217 | |
| 218 If you want to set default values for `configure' scripts to share, | |
| 219 you can create a site shell script called `config.site' that gives | |
| 220 default values for variables like `CC', `cache_file', and `prefix'. | |
| 221 `configure' looks for `PREFIX/share/config.site' if it exists, then | |
| 222 `PREFIX/etc/config.site' if it exists. Or, you can set the | |
| 223 `CONFIG_SITE' environment variable to the location of the site script. | |
| 224 A warning: not all `configure' scripts look for a site script. | |
| 225 | |
| 226 Operation Controls | |
| 227 ================== | |
| 228 | |
| 229 `configure' recognizes the following options to control how it | |
| 230 operates. | |
| 231 | |
| 232 `--cache-file=FILE' | |
| 233 Use and save the results of the tests in FILE instead of | |
| 234 `./config.cache'. Set FILE to `/dev/null' to disable caching, for | |
| 235 debugging `configure'. | |
| 236 | |
| 237 `--help' | |
| 238 Print a summary of the options to `configure', and exit. | |
| 239 | |
| 240 `--quiet' | |
| 241 `--silent' | |
| 242 `-q' | |
| 243 Do not print messages saying which checks are being made. To | |
| 244 suppress all normal output, redirect it to `/dev/null' (any error | |
| 245 messages will still be shown). | |
| 246 | |
| 247 `--srcdir=DIR' | |
| 248 Look for the package's source code in directory DIR. Usually | |
| 249 `configure' can determine that directory automatically. | |
| 250 | |
| 251 `--version' | |
| 252 Print the version of Autoconf used to generate the `configure' | |
| 253 script, and exit. | |
| 254 | |
| 255 `configure' also accepts some other, not widely useful, options. |