aboutsummaryrefslogtreecommitdiff
path: root/pd/portaudio/README.txt
blob: 4cfc6166ef64207f0e283eec34ace96d63ce95fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
README for PortAudio
Implementations for PC DirectSound and Mac SoundManager

/*
 * PortAudio Portable Real-Time Audio Library
 * Latest Version at: http://www.portaudio.com//
 *
 * Copyright (c) 1999-2000 Phil Burk and Ross Bencina
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files
 * (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * Any person wishing to distribute modifications to the Software is
 * requested to send the modifications to the original developer so that
 * they can be incorporated into the canonical version.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

PortAudio is a portable audio I/O library designed for cross-platform
support of audio. It uses a callback mechanism to request audio processing.
Audio can be generated in various formats, including 32 bit floating point,
and will be converted to the native format internally.

Documentation:
	See "pa_common/portaudio.h" for API spec.
	See docs folder for a tutorial.
	Also see http://www.portaudio.com/docs/
	And see "pa_tests/patest_saw.c" for an example.

For information on compiling programs with PortAudio, please see the
tutorial at:

  http://www.portaudio.com/docs/pa_tutorial.html
  
Important Files and Folders:
	pa_common/              = platform independant code
	pa_common/portaudio.h   = header file for PortAudio API. Specifies API.
	pa_common/pa_lib.c      = host independant code for all implementations.

    pablio                  = simple blocking read/write interface
    
Platform Implementations
    pa_asio                 = ASIO for Windows and Macintosh
    pa_beos                 = BeOS
    pa_mac_sm               = Macintosh Sound Manager for OS 8,9 and Carbon
    pa_mac_core             = Macintosh Core Audio for OS X
    pa_sgi                  = Silicon Graphics AL
    pa_unix_oss             = OSS implementation for various Unixes
    pa_win_ds               = Windows Direct Sound
    pa_win_wmme             = Windows MME (most widely supported)
    
Test Programs
	pa_tests/pa_fuzz.c = guitar fuzz box
	pa_tests/pa_devs.c = print a list of available devices
	pa_tests/pa_minlat.c = determine minimum latency for your machine
	pa_tests/paqa_devs.c = self test that opens all devices
	pa_tests/paqa_errs.c = test error detection and reporting
	pa_tests/patest_clip.c = hear a sine wave clipped and unclipped
	pa_tests/patest_dither.c = hear effects of dithering (extremely subtle)
	pa_tests/patest_pink.c = fun with pink noise
	pa_tests/patest_record.c = record and playback some audio
	pa_tests/patest_maxsines.c = how many sine waves can we play? Tests Pa_GetCPULoad().
	pa_tests/patest_sine.c = output a sine wave in a simple PA app
	pa_tests/patest_sync.c = test syncronization of audio and video
	pa_tests/patest_wire.c = pass input to output, wire simulator