PortAudio 2.0

PortAudio Tutorials

These tutorials takes you through a hands-on example of using PortAudio to make sound. If you'd prefer to start with a top-down overview of the PortAudio API, check out the PortAudio API Overview.

# Downloading

First thing you need to do is download the PortAudio source code either as a tarball from the website, or from the Subversion Repository.

# Compiling

Once you've downloaded PortAudio you'll need to compile it, which of course, depends on your environment:

- Windows
  - Building PortAudio for Windows using Microsoft Visual Studio
  - Building Portaudio for Windows with MinGW
  - Building Portaudio for Windows with ASIO support using MSVC
- Mac OS X
  - Building Portaudio for Mac OS X
- POSIX
  - Building Portaudio for Linux

You can also use CMake to generate project files for PortAudio on Windows, OS X or Linux or include PortAudio easily in your own CMake project. See PortAudio on Windows, OS X or Linux via. CMake.

Many platforms with GCC/make can use the simple ./configure && make combination and simply use the resulting libraries in their code.

# Programming with PortAudio

Below are the steps to writing a PortAudio application using the callback technique:

- Write a callback function that will be called by PortAudio when audio processing is needed.
- Initialize the PA library and open a stream for audio I/O.
- Start the stream. Your callback function will be now be called repeatedly by PA in the background.
- In your callback you can read audio data from the inputBuffer and/or write data to the outputBuffer.
- Stop the stream by returning 1 from your callback, or by calling a stop function.
- Close the stream and terminate the library.

In addition to this "Callback" architecture, V19 also supports a "Blocking I/O" model which uses read and write calls which may be more familiar to non-audio programmers. Note that at this time, not all APIs support this functionality.

In this tutorial, we'll show how to use the callback architecture to play a sawtooth wave. Much of the tutorial is taken from the file paex_saw.c, which is part of the PortAudio distribution. When you're done with this tutorial, you'll be armed with the basic knowledge you need to write an audio program. If you need more sample code, look in the "examples" and "test" directory of the PortAudio distribution. Another great source of info is the portaudio.h Doxygen page, which documents the entire V19 API. Also see the page for tips on programming PortAudio on the PortAudio wiki.

# Programming Tutorial Contents

- Writing a Callback Function
- Initializing PortAudio
- Opening a Stream Using Defaults
- Starting, Stopping and Aborting a Stream
- Closing a Stream and Terminating PortAudio
- Utility Functions
- Enumerating and Querying PortAudio Devices
- Blocking Read/Write Functions

If you are upgrading from V18, you may want to look at the Proposed Enhancements to PortAudio, which describes the differences between V18 and V19.

Once you have a basic understanding of how to use PortAudio, you might be interested in Exploring PortAudio.

Next: Writing a Callback Function