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