README.md

   1 # RtAudio
   2
   3 [![Build Status](https://travis-ci.org/thestk/rtaudio.svg?branch=master)](https://travis-ci.org/thestk/rtaudio)
   4
   5 A set of C++ classes that provide a common API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound, ASIO and WASAPI) operating systems.
   6
   7 By Gary P. Scavone, 2001-2017 (and many other developers!)
   8
   9 This distribution of RtAudio contains the following:
  10
  11 - doc:      RtAudio documentation (see doc/html/index.html)
  12 - tests:    example RtAudio programs
  13 - include:  header and source files necessary for ASIO, DS & OSS compilation
  14 - tests/Windows: Visual C++ .net test program workspace and projects
  15
  16 ## Overview
  17
  18 RtAudio is a set of C++ classes that provides a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio and OSS), Macintosh OS X and Windows (DirectSound, ASIO and WASAPI) operating systems.  RtAudio significantly simplifies the process of interacting with computer audio hardware.  It was designed with the following objectives:
  19
  20   - object-oriented C++ design
  21   - simple, common API across all supported platforms
  22   - only one source and one header file for easy inclusion in programming projects
  23   - allow simultaneous multi-api support
  24   - support dynamic connection of devices
  25   - provide extensive audio device parameter control
  26   - allow audio device capability probing
  27   - automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping
  28
  29 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.  See the \ref apinotes section for information specific to each of the supported audio APIs.
  30
  31 ## Further Reading
  32
  33 For complete documentation on RtAudio, see the doc directory of the distribution or surf to http://www.music.mcgill.ca/~gary/rtaudio/.
  34
  35
  36 ## Legal and ethical:
  37
  38 The RtAudio license is similar to the MIT License.
  39
  40     RtAudio: a set of realtime audio i/o C++ classes
  41     Copyright (c) 2001-2017 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     asked to send the modifications to the original developer so that
  56     they can be incorporated into the canonical version.  This is,
  57     however, not a binding provision of this license.
  58
  59     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  60     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  61     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  62     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
  63     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  64     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  65     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.