An open source port of Pure Data to the iPhone
C Shell Pure Data Other
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
PdLib
liblo-0.26
.gitignore
README.markdown

README.markdown

pdlib

The need for pdlib came from the development of iJam, which needed an audio back end. After looking for existing solutions, few synthesizers were free to use in commercial projects, and those that available were typically limited in the sounds they could produce. I was familiar with Rjdj and their decision to use Pure Data as their audio synthesizer, but they hadn't opted to release their port.

One of the goals of pdlib was to minimize changes to vanilla Pure Data; as such, only the command-line parsing and the audio hardware interface have been rewritten. It is based on Pure Data v0.42-5.

The project is currently hosted on Github under the FreeBSD license for my contribution. Pure Data itself is under a BSD-style license. Be aware, though, that PdListTest uses example code from Martin Peach for the Pure Data OSC parts and his work is under GPL.

As it stands, Pure Data wasn't really written to be embedded in other systems, and was dependent on PortAudio, which wasn't compatible with the iPhone's audio system. I ended up basically rewriting the audio hardware interface layer of Pure Data to use the iPhone's RemoteIO Audio unit. Apple's documentation for that system is sparse, so I found articles by Mike Tyson and Chris Adamson to be invaluable.

The current iteration of pdlib doesn't explicitly support any communication between the host programming environment and the Pure Data system. What I've done for iJam is use Martin Peach's osc patches, specifically routeosc, along with his udpreceive patch to receive audio events from the Objective-C code on a specific port. Then we use liblo to send OSC messages so communication is all socket-based. This was done in part because Pure Data is not thread-safe. Because only one instance of PD can run in a single process, the PdController library runs as a singleton. PdLibTest, included in the release, shows how pdlib can be used in an Xcode project.

Installation

To build and install pdlib as a static library for linking into other iPhone projects, I've created a shell script which kicks off the requisite Xcode builds and creates a fat binary. This has been tested on OS X 10.6, but should work on 10.5 as well. This takes in a prefix argument. In short, to install pdlib to $YOUR_PREFIX:

cd PdLib
./install.sh $YOUR_PREFIX

Then make sure to add both $YOUR_PREFIX/include to your project's Header Search Path as well as $YOUR_PREFIX/lib to the Library Search Path in addition to adding $YOUR_PREFIX/lib/libpd.a to your current target's linked libraries.

PdLibTest is dependent on liblo, which is included in the package. As building fat static libraries for iPhoneOS is somewhat complicated, I made a quick install script that installs a fat binary of liblo for iPhone into /usr/local. This uses a build_for_iphone script written by Christopher Stawarz. PdLibTest is already preconfigured to search for the /usr/local header and library paths (/include and /lib, respectively). To install liblo for iPhone:

cd liblo-0.26
sudo ./quickinstall.sh 

Usage

PdController is an Objective-C singleton, and has a number of properties that can be set to change how Pure Data is configured. Note that changes in these properties or only reflected in Pure Data after a start or restart of the system. The properties include:

  • soundRate: the frequency of Pure Data in Hz. Defaults to 22050
  • blockSize: How many samples to generate for each DSP tick. Smaller blocks sizes mean smaller latency, but is more processor intensive. I've defaulted to 256, while vanilla Pure Data is set to 64. Because of this, this value needs to be a multiple of 64.
  • nOutChannels: 1 or 2. How many channels we want to support. Set to 2 for now. Changing to mono has not been tested, but should work.
  • nInChannels: 1 or 2. How many channels we want to support. Set to 2 for now. Changing to mono has not been tested, but should work.
  • callbackFn: Optional; a function that is to be called on every DSP tick. This is often useful as a timer mechanism for UI events, etc. The callback function should run quickly, as this runs on CoreAudio's callback thread and needs to finish before the next DSP cycle. In other words, try to minimize system calls, etc. I typically use it to call GUI events asynchronously, etc. with performSelectorOnMainThread:.
  • externs: an NSArray of NSStrings. Each should be a valid path to externs that should be loaded into the system at start-up.
  • openfiles: an NSArray of NSStrings that specify which files should be opened as PD starts up.
  • liddir: an NSString that specifies the directory where the .pd files are located. This is recursive.

See PdListTest for a working example of PdController.

Future improvements

  • Add a mechanism to directly send messages to Pd via PdController
  • Add test cases
  • Verify that openFile: is working correctly