You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Gary Scavone c2e079dae4 Added pulse audio fix that was just applied to master. 4 years ago
cmake cmake: make CMakeLists.txt more similar to RtMidi's 5 years ago
contrib Change "Direct Sound" to "DirectSound" 5 years ago
doc A few minor documentation updates for release 5.1.0. 4 years ago
include Update ASIO headers to version 2.3. 6 years ago
tests Modified CoreAudio cleanup in case of error during initialization, fixed duplex streamtime bug for single device in CoreAudio, updated playsaw.cpp with interrupt handler instead of cin.get() function. 4 years ago
.gitattributes Prevent .gitignore and friends from being exported to the final archive 6 years ago
.gitignore fix cmake build system missing variables in pkgconfig 5 years ago
.travis.yml Remove Travis config for non-existent '--with-winmm' option 5 years ago
CMakeLists.txt [cmake] support previous RTAUDIO_BUILD_* variables 4 years ago
ChangeLog Realtime fixes 5 years ago
Makefile.am Removed RtAudioError class and created a new enum for error types. Only implemented for RtApiCore and RtApiDummy, not rtaudio_c. 4 years ago
README.md Documentation and version updates before release 5.1.0 4 years ago
RtAudio.cpp Added pulse audio fix that was just applied to master. 4 years ago
RtAudio.h No exception updates for Jack API. 4 years ago
autogen.sh Port the build system to automake. 8 years ago
configure.ac Removed RtAudioError class and created a new enum for error types. Only implemented for RtApiCore and RtApiDummy, not rtaudio_c. 4 years ago
install.txt Documentation and version updates before release 5.1.0 4 years ago
rtaudio.pc.in automake: Fix rtaudio.pc prefix variable 5 years ago
rtaudio_c.cpp Added new setErrorCallback() function and removed errorCallback argument in openStream(). Also added RtAudioError::Type return value to openStream(), startStream(), stopStream() and abortStream() functions, but only implemented in RtApiCore. 4 years ago
rtaudio_c.h [doc] document C interface. 4 years ago

README.md

RtAudio

Build Status

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.

By Gary P. Scavone, 2001-2019 (and many other developers!)

This distribution of RtAudio contains the following:

  • doc: RtAudio documentation (see doc/html/index.html)
  • tests: example RtAudio programs
  • include: header and source files necessary for ASIO, DS & OSS compilation
  • tests/Windows: Visual C++ .net test program workspace and projects

Overview

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:

  • object-oriented C++ design
  • simple, common API across all supported platforms
  • only one source and one header file for easy inclusion in programming projects
  • allow simultaneous multi-api support
  • support dynamic connection of devices
  • provide extensive audio device parameter control
  • allow audio device capability probing
  • automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping

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.

Further Reading

For complete documentation on RtAudio, see the doc directory of the distribution or surf to http://www.music.mcgill.ca/~gary/rtaudio/.

The RtAudio license is similar to the MIT License.

RtAudio: a set of realtime audio i/o C++ classes
Copyright (c) 2001-2019 Gary P. Scavone

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

Any person wishing to distribute modifications to the Software is
asked to send the modifications to the original developer so that
they can be incorporated into the canonical version.  This is,
however, not a binding provision of this license.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.