xref: /third_party/libsnd/README (revision b815c7f3)
1b815c7f3Sopenharmony_ciThis is libsndfile, 1.1.0
2b815c7f3Sopenharmony_ci
3b815c7f3Sopenharmony_cilibsndfile is a library of C routines for reading and writing
4b815c7f3Sopenharmony_cifiles containing sampled audio data.
5b815c7f3Sopenharmony_ci
6b815c7f3Sopenharmony_ciThe src/ directory contains the source code for library itself.
7b815c7f3Sopenharmony_ci
8b815c7f3Sopenharmony_ciThe doc/ directory contains the libsndfile documentation.
9b815c7f3Sopenharmony_ci
10b815c7f3Sopenharmony_ciThe examples/ directory contains examples of how to write code using
11b815c7f3Sopenharmony_cilibsndfile.
12b815c7f3Sopenharmony_ci
13b815c7f3Sopenharmony_ciThe tests/ directory contains programs which link against libsndfile
14b815c7f3Sopenharmony_ciand test its functionality.
15b815c7f3Sopenharmony_ci
16b815c7f3Sopenharmony_ciThe src/GSM610 directory contains code written by Jutta Degener and Carsten
17b815c7f3Sopenharmony_ciBormann. Their original code can be found at :
18b815c7f3Sopenharmony_ci    http://kbs.cs.tu-berlin.de/~jutta/toast.html
19b815c7f3Sopenharmony_ci
20b815c7f3Sopenharmony_ciThe src/G72x directory contains code written and released by Sun Microsystems
21b815c7f3Sopenharmony_ciunder a suitably free license.
22b815c7f3Sopenharmony_ci
23b815c7f3Sopenharmony_ciThe src/ALAC directory contains code written and released by Apple Inc and
24b815c7f3Sopenharmony_cireleased under the Apache license.
25b815c7f3Sopenharmony_ci
26b815c7f3Sopenharmony_ci
27b815c7f3Sopenharmony_ciLINUX
28b815c7f3Sopenharmony_ci-----
29b815c7f3Sopenharmony_ciWhereever possible, you should use the packages supplied by your Linux
30b815c7f3Sopenharmony_cidistribution.
31b815c7f3Sopenharmony_ci
32b815c7f3Sopenharmony_ciIf you really do need to compile from source it should be as easy as:
33b815c7f3Sopenharmony_ci
34b815c7f3Sopenharmony_ci		./configure
35b815c7f3Sopenharmony_ci		make
36b815c7f3Sopenharmony_ci		make install
37b815c7f3Sopenharmony_ci
38b815c7f3Sopenharmony_ciSince libsndfile optionally links against libFLAC, libogg, libvorbis and
39b815c7f3Sopenharmony_cilibopus, you will need to install appropriate versions of these libraries
40b815c7f3Sopenharmony_cibefore running configure as above.
41b815c7f3Sopenharmony_ci
42b815c7f3Sopenharmony_ciYou can use CMake now to build under Linux, also under Windows and MacOS, see
43b815c7f3Sopenharmony_ciREADME.md for details. CMake toolchain is usable, but still exterimental.
44b815c7f3Sopenharmony_ci
45b815c7f3Sopenharmony_ci
46b815c7f3Sopenharmony_ciUNIX
47b815c7f3Sopenharmony_ci----
48b815c7f3Sopenharmony_ciCompile as for Linux.
49b815c7f3Sopenharmony_ci
50b815c7f3Sopenharmony_ci
51b815c7f3Sopenharmony_ciWin32/Win64
52b815c7f3Sopenharmony_ci-----------
53b815c7f3Sopenharmony_ci
54b815c7f3Sopenharmony_ciOfficial Windows binaries are compiled with Autotools and MinGW, but you can use
55b815c7f3Sopenharmony_ciCMake to generate solution for Visual Studio. Details are described in
56b815c7f3Sopenharmony_ciREADME.md.
57b815c7f3Sopenharmony_ci
58b815c7f3Sopenharmony_ciIt is still recommended to use the libsndfile binaries available on the
59b815c7f3Sopenharmony_cilibsndfile web site.
60b815c7f3Sopenharmony_ci
61b815c7f3Sopenharmony_ciMacOSX
62b815c7f3Sopenharmony_ci------
63b815c7f3Sopenharmony_ciBuilding on MacOSX should be the same as building it on any other Unix.
64b815c7f3Sopenharmony_ci
65b815c7f3Sopenharmony_ci
66b815c7f3Sopenharmony_ciCONTACTS
67b815c7f3Sopenharmony_ci--------
68b815c7f3Sopenharmony_ci
69b815c7f3Sopenharmony_cilibsndfile was written by Erik de Castro Lopo (erikd AT mega-nerd DOT com).
70b815c7f3Sopenharmony_ciThe libsndfile home page is at :
71b815c7f3Sopenharmony_ci
72b815c7f3Sopenharmony_ci	http://libsndfile.github.io/libsndfile/
73b815c7f3Sopenharmony_ci
74b815c7f3Sopenharmony_ciBugs and support questions can be raised at :
75b815c7f3Sopenharmony_ci
76b815c7f3Sopenharmony_ci	https://github.com/libsndfile/libsndfile/issues
77