Merge tag 'upstream/1.2.2' into tizen_base
[platform/upstream/libsndfile.git] / README
1 libsndfile is a library of C routines for reading and writing
2 files containing sampled audio data.
3
4 The src/ directory contains the source code for library itself.
5
6 The doc/ directory contains the libsndfile documentation.
7
8 The examples/ directory contains examples of how to write code using
9 libsndfile.
10
11 The tests/ directory contains programs which link against libsndfile
12 and test its functionality.
13
14 The src/GSM610 directory contains code written by Jutta Degener and Carsten
15 Bormann. Their original code can be found at :
16     http://kbs.cs.tu-berlin.de/~jutta/toast.html
17
18 The src/G72x directory contains code written and released by Sun Microsystems
19 under a suitably free license.
20
21 The src/ALAC directory contains code written and released by Apple Inc and
22 released under the Apache license.
23
24
25 LINUX
26 -----
27 Wherever possible, you should use the packages supplied by your Linux
28 distribution.
29
30 If you really do need to compile from source it should be as easy as:
31
32                 ./configure
33                 make
34                 make install
35
36 Since libsndfile optionally links against libFLAC, libogg, libvorbis and
37 libopus, you will need to install appropriate versions of these libraries
38 before running configure as above.
39
40 You can use CMake now to build under Linux, also under Windows and MacOS, see
41 README.md for details. CMake toolchain is usable, but still exterimental.
42
43
44 UNIX
45 ----
46 Compile as for Linux.
47
48
49 Win32/Win64
50 -----------
51
52 Official Windows binaries are compiled with Autotools and MinGW, but you can use
53 CMake to generate solution for Visual Studio. Details are described in
54 README.md.
55
56 It is still recommended to use the libsndfile binaries available on the
57 libsndfile web site.
58
59 MacOSX
60 ------
61 Building on MacOSX should be the same as building it on any other Unix.
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://libsndfile.github.io/libsndfile/
71
72 Bugs and support questions can be raised at :
73
74         https://github.com/libsndfile/libsndfile/issues