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