readme

   1 RtAudio - a set of C++ classes which provide a common API for realtime audio input/output across Linux (native ALSA, JACK, and OSS), SGI, Macintosh OS X (CoreAudio), and Windows (DirectSound and ASIO) operating systems.
   2
   3 By Gary P. Scavone, 2001-2005.
   4
   5 This distribution of RtAudio contains the following:
   6
   7 doc:      RtAudio documentation (see doc/html/index.html)
   8 tests:    example RtAudio programs
   9 asio:     header files necessary for ASIO compilation
  10 tests/Windows: Visual C++ 6.0 test program workspace and projects
  11
  12 OVERVIEW:
  13
  14 RtAudio is a set of C++ classes which provide a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA, JACK, and OSS), SGI, Macintosh OS X (CoreAudio), and Windows (DirectSound and ASIO) operating systems. RtAudio significantly simplifies the process of interacting with computer audio hardware. It was designed with the following goals:
  15
  16   - object oriented C++ design
  17   - simple, common API across all supported platforms
  18   - only two header files and one source file for easy inclusion in programming projects
  19   - allow simultaneous multi-api support
  20   - blocking functionality
  21   - callback functionality
  22   - extensive audio device parameter control
  23   - audio device capability probing
  24   - automatic internal conversion for data format, channel number compensation, de-interleaving, and byte-swapping
  25
  26 RtAudio incorporates the concept of audio streams, which represent audio output (playback) and/or input (recording). Available audio devices and their capabilities can be enumerated and then specified when opening a stream.  Where applicable, multiple API support can be compiled and a particular API specified when creating an RtAudio instance.
  27
  28 The RtAudio API provides both blocking (synchronous) and callback (asyncronous) functionality. Callbacks are typically used in conjunction with graphical user interfaces (GUI). Blocking functionality is often necessary for explicit control of multiple input/output stream synchronization or when audio must be synchronized with other system events.
  29
  30
  31 FURTHER READING:
  32
  33 For complete documentation on RtAudio, see the doc directory of the distribution or surf to http://music.mcgill.ca/~gary/rtaudio/.
  34
  35
  36 LEGAL AND ETHICAL:
  37
  38 The RtAudio license is similar to the the MIT License, with the added "feature" that modifications be sent to the developer.
  39
  40     RtAudio: a set of realtime audio i/o C++ classes
  41     Copyright (c) 2001-2005 Gary P. Scavone
  42
  43     Permission is hereby granted, free of charge, to any person
  44     obtaining a copy of this software and associated documentation files
  45     (the "Software"), to deal in the Software without restriction,
  46     including without limitation the rights to use, copy, modify, merge,
  47     publish, distribute, sublicense, and/or sell copies of the Software,
  48     and to permit persons to whom the Software is furnished to do so,
  49     subject to the following conditions:
  50
  51     The above copyright notice and this permission notice shall be
  52     included in all copies or substantial portions of the Software.
  53
  54     Any person wishing to distribute modifications to the Software is
  55     requested to send the modifications to the original developer so that
  56     they can be incorporated into the canonical version.
  57
  58     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  59     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  60     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  61     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
  62     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  63     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  64     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.