cannam@140: README for PortAudio cannam@140: cannam@140: /* cannam@140: * PortAudio Portable Real-Time Audio Library cannam@140: * Latest Version at: http://www.portaudio.com cannam@140: * cannam@140: * Copyright (c) 1999-2008 Phil Burk and Ross Bencina cannam@140: * cannam@140: * Permission is hereby granted, free of charge, to any person obtaining cannam@140: * a copy of this software and associated documentation files cannam@140: * (the "Software"), to deal in the Software without restriction, cannam@140: * including without limitation the rights to use, copy, modify, merge, cannam@140: * publish, distribute, sublicense, and/or sell copies of the Software, cannam@140: * and to permit persons to whom the Software is furnished to do so, cannam@140: * subject to the following conditions: cannam@140: * cannam@140: * The above copyright notice and this permission notice shall be cannam@140: * included in all copies or substantial portions of the Software. cannam@140: * cannam@140: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, cannam@140: * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF cannam@140: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. cannam@140: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR cannam@140: * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF cannam@140: * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION cannam@140: * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. cannam@140: */ cannam@140: cannam@140: /* cannam@140: * The text above constitutes the entire PortAudio license; however, cannam@140: * the PortAudio community also makes the following non-binding requests: cannam@140: * cannam@140: * Any person wishing to distribute modifications to the Software is cannam@140: * requested to send the modifications to the original developer so that cannam@140: * they can be incorporated into the canonical version. It is also cannam@140: * requested that these non-binding requests be included along with the cannam@140: * license above. cannam@140: */ cannam@140: cannam@140: cannam@140: PortAudio is a portable audio I/O library designed for cross-platform cannam@140: support of audio. It uses either a callback mechanism to request audio cannam@140: processing, or blocking read/write calls to buffer data between the cannam@140: native audio subsystem and the client. Audio can be processed in various cannam@140: formats, including 32 bit floating point, and will be converted to the cannam@140: native format internally. cannam@140: cannam@140: Documentation: cannam@140: Documentation is available in "/doc/html/index.html" cannam@140: Also see "src/common/portaudio.h" for API spec. cannam@140: Also see http://www.portaudio.com/docs/ cannam@140: And see the "test/" directory for many examples of usage cannam@140: (we suggest "test/patest_saw.c" for an example) cannam@140: cannam@140: For information on compiling programs with PortAudio, please see the cannam@140: tutorial at: cannam@140: cannam@140: http://portaudio.com/trac/wiki/TutorialDir/TutorialStart cannam@140: cannam@140: We have an active mailing list for user and developer discussions. cannam@140: Please feel free to join. See http://www.portaudio.com for details. cannam@140: cannam@140: cannam@140: Important Files and Folders: cannam@140: include/portaudio.h = header file for PortAudio API. Specifies API. cannam@140: src/common/ = platform independant code, host independant cannam@140: code for all implementations. cannam@140: src/os = os specific (but host api neutral) code cannam@140: src/hostapi = implementations for different host apis cannam@140: cannam@140: cannam@140: Host API Implementations: cannam@140: src/hostapi/alsa = Advanced Linux Sound Architecture (ALSA) cannam@140: src/hostapi/asihpi = AudioScience HPI cannam@140: src/hostapi/asio = ASIO for Windows and Macintosh cannam@140: src/hostapi/coreaudio = Macintosh Core Audio for OS X cannam@140: src/hostapi/dsound = Windows Direct Sound cannam@140: src/hostapi/jack = JACK Audio Connection Kit cannam@140: src/hostapi/oss = Unix Open Sound System (OSS) cannam@140: src/hostapi/wasapi = Windows Vista WASAPI cannam@140: src/hostapi/wdmks = Windows WDM Kernel Streaming cannam@140: src/hostapi/wmme = Windows MultiMedia Extensions (MME) cannam@140: cannam@140: cannam@140: Test Programs: cannam@140: test/pa_fuzz.c = guitar fuzz box cannam@140: test/pa_devs.c = print a list of available devices cannam@140: test/pa_minlat.c = determine minimum latency for your machine cannam@140: test/paqa_devs.c = self test that opens all devices cannam@140: test/paqa_errs.c = test error detection and reporting cannam@140: test/patest_clip.c = hear a sine wave clipped and unclipped cannam@140: test/patest_dither.c = hear effects of dithering (extremely subtle) cannam@140: test/patest_pink.c = fun with pink noise cannam@140: test/patest_record.c = record and playback some audio cannam@140: test/patest_maxsines.c = how many sine waves can we play? Tests Pa_GetCPULoad(). cannam@140: test/patest_sine.c = output a sine wave in a simple PA app cannam@140: test/patest_sync.c = test syncronization of audio and video cannam@140: test/patest_wire.c = pass input to output, wire simulator