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