rollback to 3428, before the mysterious removal of libs/* at 3431/3432
[ardour.git] / libs / libsndfile / README
1 This is libsndfile, 1.0.16
2
3 libsndfile is a library of C routines for reading and writing 
4 files containing sampled audio data. 
5
6 The src/ directory contains the source code for library itself.
7
8 The doc/ directory contains the libsndfile documentation.
9
10 The examples/ directory contains examples of how to write code using
11 libsndfile. 'wav32_aiff24' converts a WAV file containing 32 bit floating 
12 point data into a 24 bit PCM AIFF file. 'sndfile2oct' dumps the audio
13 data of a file in a human readable format. 'sfconvert' is the beginnings
14 of a audio file format conversion utility. 'make_sine' generates a WAV
15 file containing one cycle of a sine wave with 4096 sample points in
16 32 bit floating point format. 'sfinfo' opens a sound file and prints
17 out information about that file.
18
19 The tests/ directory contains programs which link against libsndfile
20 and test its functionality.
21
22 The Win32/ directory contains files and documentation to allow libsndfile
23 to compile under Win32 with the Microsoft Visual C++ compiler.
24
25 The src/GSM610 directory contains code written by Jutta Degener and Carsten 
26 Bormann. Their original code can be found at :
27     http://kbs.cs.tu-berlin.de/~jutta/toast.html
28
29 The src/G72x directory contains code written and released by Sun Microsystems
30 under a suitably free license.
31
32
33 Win32
34 -----
35 There are detailed instructions for building libsndfile on Win32 in the file
36
37         doc/win32.html
38         
39
40 MacOSX
41 ------
42 Building on MacOSX should be the same as building it on any other Unix.
43
44
45 OTHER PLATFORMS
46 ---------------
47 To compile libsndfile on platforms which have a Bourne Shell compatible
48 shell, an ANSI C compiler and a make utility should require no more that
49 the following three commands :
50                 ./configure
51                 make
52                 make install
53                 
54 For platforms without the required shell, it is usually sufficient to 
55 create an approriate config.h file in the src/ directory with correct
56 values for the following #defines  (this would work for AmigaOS) :
57
58 #define HAVE_ENDIAN_H 0
59 #define GUESS_BIG_ENDIAN 1
60 #define GUESS_LITTLE_ENDIAN 0
61 #define FORCE_BROKEN_FLOAT 0
62
63
64 CONTACTS
65 --------
66
67 libsndfile was written by Erik de Castro Lopo (erikd AT mega-nerd DOT com).  
68 The libsndfile home page is at :
69
70         http://www.mega-nerd.com/libsndfile/
71