Mutex removal from several APIs, addition of PulseAudio support, documentation update...
[rtaudio-cdist.git] / install
1 RtAudio - a set of C++ classes which provide a common API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio, and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound and ASIO) operating systems.
2
3 By Gary P. Scavone, 2001-2012.
4
5 To configure and compile (on Unix systems and MinGW):
6
7 1. Unpack the RtAudio distribution (tar -xzf rtaudio-x.x.tar.gz).
8 2. From within the directory containing this file, run configure:
9
10    ./configure
11
12 3. Typing "make" will compile static and shared libraries.
13
14 4. From within the "tests" directory, type "make" to compile the example programs.
15
16 A few options can be passed to configure, including:
17
18   --enable-debug = enable various debug output
19   --with-alsa = choose native ALSA API support (linux only)
20   --with-pulse = choose native PulseAudio API support (linux only)
21   --with-oss = choose OSS API support (linux only)
22   --with-jack = choose JACK server support (linux or Macintosh OS-X)
23   --with-core = choose CoreAudio API support (Macintosh OS-X only)
24   --with-asio = choose ASIO API support (windows only)
25   --with-ds = choose DirectSound API support (windows only)
26
27 Typing "./configure --help" will display all the available options.  Note that you can provide more than one "--with-" flag to the configure script to enable multiple API support.
28
29 If you wish to use a different compiler than that selected by configure, specify that compiler in the command line (ex. to use CC):
30
31   ./configure CXX=CC
32
33 For Windows Users:
34
35 RtAudio compiles with the MinGW compiler or MS Visual Studio.
36
37 Visual C++ 6.0 project files are included for the test programs in the /tests/Windows/ directory.  These projects compile API support for both ASIO and DirectSound.  Version 4.0 of RtAudio was tested with the .net compiler and it will not compile in Visual C++ 6.0 because of its non-conformance to modern C++ standards.