|
cannam@140
|
1 README for PortAudio
|
|
cannam@140
|
2
|
|
cannam@140
|
3 /*
|
|
cannam@140
|
4 * PortAudio Portable Real-Time Audio Library
|
|
cannam@140
|
5 * Latest Version at: http://www.portaudio.com
|
|
cannam@140
|
6 *
|
|
cannam@140
|
7 * Copyright (c) 1999-2008 Phil Burk and Ross Bencina
|
|
cannam@140
|
8 *
|
|
cannam@140
|
9 * Permission is hereby granted, free of charge, to any person obtaining
|
|
cannam@140
|
10 * a copy of this software and associated documentation files
|
|
cannam@140
|
11 * (the "Software"), to deal in the Software without restriction,
|
|
cannam@140
|
12 * including without limitation the rights to use, copy, modify, merge,
|
|
cannam@140
|
13 * publish, distribute, sublicense, and/or sell copies of the Software,
|
|
cannam@140
|
14 * and to permit persons to whom the Software is furnished to do so,
|
|
cannam@140
|
15 * subject to the following conditions:
|
|
cannam@140
|
16 *
|
|
cannam@140
|
17 * The above copyright notice and this permission notice shall be
|
|
cannam@140
|
18 * included in all copies or substantial portions of the Software.
|
|
cannam@140
|
19 *
|
|
cannam@140
|
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
cannam@140
|
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
cannam@140
|
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
cannam@140
|
23 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
|
|
cannam@140
|
24 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
|
cannam@140
|
25 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
cannam@140
|
26 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
cannam@140
|
27 */
|
|
cannam@140
|
28
|
|
cannam@140
|
29 /*
|
|
cannam@140
|
30 * The text above constitutes the entire PortAudio license; however,
|
|
cannam@140
|
31 * the PortAudio community also makes the following non-binding requests:
|
|
cannam@140
|
32 *
|
|
cannam@140
|
33 * Any person wishing to distribute modifications to the Software is
|
|
cannam@140
|
34 * requested to send the modifications to the original developer so that
|
|
cannam@140
|
35 * they can be incorporated into the canonical version. It is also
|
|
cannam@140
|
36 * requested that these non-binding requests be included along with the
|
|
cannam@140
|
37 * license above.
|
|
cannam@140
|
38 */
|
|
cannam@140
|
39
|
|
cannam@140
|
40
|
|
cannam@140
|
41 PortAudio is a portable audio I/O library designed for cross-platform
|
|
cannam@140
|
42 support of audio. It uses either a callback mechanism to request audio
|
|
cannam@140
|
43 processing, or blocking read/write calls to buffer data between the
|
|
cannam@140
|
44 native audio subsystem and the client. Audio can be processed in various
|
|
cannam@140
|
45 formats, including 32 bit floating point, and will be converted to the
|
|
cannam@140
|
46 native format internally.
|
|
cannam@140
|
47
|
|
cannam@140
|
48 Documentation:
|
|
cannam@140
|
49 Documentation is available in "/doc/html/index.html"
|
|
cannam@140
|
50 Also see "src/common/portaudio.h" for API spec.
|
|
cannam@140
|
51 Also see http://www.portaudio.com/docs/
|
|
cannam@140
|
52 And see the "test/" directory for many examples of usage
|
|
cannam@140
|
53 (we suggest "test/patest_saw.c" for an example)
|
|
cannam@140
|
54
|
|
cannam@140
|
55 For information on compiling programs with PortAudio, please see the
|
|
cannam@140
|
56 tutorial at:
|
|
cannam@140
|
57
|
|
cannam@140
|
58 http://portaudio.com/trac/wiki/TutorialDir/TutorialStart
|
|
cannam@140
|
59
|
|
cannam@140
|
60 We have an active mailing list for user and developer discussions.
|
|
cannam@140
|
61 Please feel free to join. See http://www.portaudio.com for details.
|
|
cannam@140
|
62
|
|
cannam@140
|
63
|
|
cannam@140
|
64 Important Files and Folders:
|
|
cannam@140
|
65 include/portaudio.h = header file for PortAudio API. Specifies API.
|
|
cannam@140
|
66 src/common/ = platform independant code, host independant
|
|
cannam@140
|
67 code for all implementations.
|
|
cannam@140
|
68 src/os = os specific (but host api neutral) code
|
|
cannam@140
|
69 src/hostapi = implementations for different host apis
|
|
cannam@140
|
70
|
|
cannam@140
|
71
|
|
cannam@140
|
72 Host API Implementations:
|
|
cannam@140
|
73 src/hostapi/alsa = Advanced Linux Sound Architecture (ALSA)
|
|
cannam@140
|
74 src/hostapi/asihpi = AudioScience HPI
|
|
cannam@140
|
75 src/hostapi/asio = ASIO for Windows and Macintosh
|
|
cannam@140
|
76 src/hostapi/coreaudio = Macintosh Core Audio for OS X
|
|
cannam@140
|
77 src/hostapi/dsound = Windows Direct Sound
|
|
cannam@140
|
78 src/hostapi/jack = JACK Audio Connection Kit
|
|
cannam@140
|
79 src/hostapi/oss = Unix Open Sound System (OSS)
|
|
cannam@140
|
80 src/hostapi/wasapi = Windows Vista WASAPI
|
|
cannam@140
|
81 src/hostapi/wdmks = Windows WDM Kernel Streaming
|
|
cannam@140
|
82 src/hostapi/wmme = Windows MultiMedia Extensions (MME)
|
|
cannam@140
|
83
|
|
cannam@140
|
84
|
|
cannam@140
|
85 Test Programs:
|
|
cannam@140
|
86 test/pa_fuzz.c = guitar fuzz box
|
|
cannam@140
|
87 test/pa_devs.c = print a list of available devices
|
|
cannam@140
|
88 test/pa_minlat.c = determine minimum latency for your machine
|
|
cannam@140
|
89 test/paqa_devs.c = self test that opens all devices
|
|
cannam@140
|
90 test/paqa_errs.c = test error detection and reporting
|
|
cannam@140
|
91 test/patest_clip.c = hear a sine wave clipped and unclipped
|
|
cannam@140
|
92 test/patest_dither.c = hear effects of dithering (extremely subtle)
|
|
cannam@140
|
93 test/patest_pink.c = fun with pink noise
|
|
cannam@140
|
94 test/patest_record.c = record and playback some audio
|
|
cannam@140
|
95 test/patest_maxsines.c = how many sine waves can we play? Tests Pa_GetCPULoad().
|
|
cannam@140
|
96 test/patest_sine.c = output a sine wave in a simple PA app
|
|
cannam@140
|
97 test/patest_sync.c = test syncronization of audio and video
|
|
cannam@140
|
98 test/patest_wire.c = pass input to output, wire simulator
|
