r663: This commit was generated by cvs2svn to compensate for changes in r662,
[cinelerra_cv.git] / libsndfile / README
blobcdffb543d29158f7526a7bba43f4d4ab13fa2762
1 This is libsndfile, 1.0.5
3 libsndfile is a library of C routines for reading and writing 
4 files containing sampled audio data. 
6 The src/ directory contains the source code for library itself.
8 The doc/ directory contains the libsndfile documentation.
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.
19 The tests/ directory contains programs which link against libsndfile
20 and test its functionality.
22 The Win32/ directory contains files and documentation to allow libsndfile
23 to compile under Win32 with the Microsoft Visual C++ compiler.
25 The MacOS/ directory contains files and documentation to allow libsndfile
26 to compile under MacOS with the Metrowerks compiler.
28 The src/GSM610 directory contains code written by Jutta Degener and Carsten 
29 Bormann. Their original code can be found at :
30     http://kbs.cs.tu-berlin.de/~jutta/toast.html
32 The src/G72x directory contains code written and released by Sun Microsystems
33 under a suitably free license.
36 Win32
37 -----
38 There are detailed instructions for building libsndfile on Win32 in the file
40         doc/win32.html
41         
43 MacOSX
44 ------
45 Building on MacOSX should be the same as building it on any other Unix.
48 OTHER PLATFORMS
49 ---------------
50 To compile libsndfile on platforms which have a Bourne Shell compatible
51 shell, an ANSI C compiler and a make utility should require no more that
52 the following three commands :
53                 ./configure
54                 make
55                 make install
56                 
57 For platforms without the required shell, it is usually sufficient to 
58 create an approriate config.h file in the src/ directory with correct
59 values for the following #defines  (this would work for AmigaOS) :
61 #define HAVE_ENDIAN_H 0
62 #define GUESS_BIG_ENDIAN 1
63 #define GUESS_LITTLE_ENDIAN 0
64 #define FORCE_BROKEN_FLOAT 0
67 CONTACTS
68 --------
70 libsndfile was written by Erik de Castro Lopo (erikd AT zipworld DOT com DOT au).  
71 The libsndfile home page is at :
73         http://www.zip.com.au/~erikd/libsndfile/