3rdparty/iaxclient/lib/portaudio/README.txt

   1 README for PortAudio
   2 Implementations for PC DirectSound and Mac SoundManager
   3
   4 /*
   5  * PortAudio Portable Real-Time Audio Library
   6  * Latest Version at: http://www.portaudio.com//
   7  *
   8  * Copyright (c) 1999-2000 Phil Burk and Ross Bencina
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining
  11  * a copy of this software and associated documentation files
  12  * (the "Software"), to deal in the Software without restriction,
  13  * including without limitation the rights to use, copy, modify, merge,
  14  * publish, distribute, sublicense, and/or sell copies of the Software,
  15  * and to permit persons to whom the Software is furnished to do so,
  16  * subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be
  19  * included in all copies or substantial portions of the Software.
  20  *
  21  * Any person wishing to distribute modifications to the Software is
  22  * requested to send the modifications to the original developer so that
  23  * they can be incorporated into the canonical version.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  28  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
  29  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  30  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  31  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  32  *
  33  */
  34
  35 PortAudio is a portable audio I/O library designed for cross-platform
  36 support of audio. It uses a callback mechanism to request audio processing.
  37 Audio can be generated in various formats, including 32 bit floating point,
  38 and will be converted to the native format internally.
  39
  40 Documentation:
  41         See "pa_common/portaudio.h" for API spec.
  42         See docs folder for a tutorial.
  43         Also see http://www.portaudio.com/docs/
  44         And see "pa_tests/patest_saw.c" for an example.
  45
  46 For information on compiling programs with PortAudio, please see the
  47 tutorial at:
  48
  49   http://www.portaudio.com/docs/pa_tutorial.html
  50
  51 Important Files and Folders:
  52         pa_common/              = platform independant code
  53         pa_common/portaudio.h   = header file for PortAudio API. Specifies API.
  54         pa_common/pa_lib.c      = host independant code for all implementations.
  55
  56     pablio                  = simple blocking read/write interface
  57
  58 Platform Implementations
  59     pa_asio                 = ASIO for Windows and Macintosh
  60     pa_beos                 = BeOS
  61     pa_mac_sm               = Macintosh Sound Manager for OS 8,9 and Carbon
  62     pa_mac_core             = Macintosh Core Audio for OS X
  63     pa_sgi                  = Silicon Graphics AL
  64     pa_unix_oss             = OSS implementation for various Unixes
  65     pa_win_ds               = Windows Direct Sound
  66     pa_win_wmme             = Windows MME (most widely supported)
  67
  68 Test Programs
  69         pa_tests/pa_fuzz.c = guitar fuzz box
  70         pa_tests/pa_devs.c = print a list of available devices
  71         pa_tests/pa_minlat.c = determine minimum latency for your machine
  72         pa_tests/paqa_devs.c = self test that opens all devices
  73         pa_tests/paqa_errs.c = test error detection and reporting
  74         pa_tests/patest_clip.c = hear a sine wave clipped and unclipped
  75         pa_tests/patest_dither.c = hear effects of dithering (extremely subtle)
  76         pa_tests/patest_pink.c = fun with pink noise
  77         pa_tests/patest_record.c = record and playback some audio
  78         pa_tests/patest_maxsines.c = how many sine waves can we play? Tests Pa_GetCPULoad().
  79         pa_tests/patest_sine.c = output a sine wave in a simple PA app
  80         pa_tests/patest_sync.c = test syncronization of audio and video
  81         pa_tests/patest_wire.c = pass input to output, wire simulator