Plonk|Plink|Plank Documentation

Introduction

Plonk|Plink|Plank implements a set of resuable functions and DSP for audio software development.

Installation

Currently is currently an example project for iOS and an example project for Mac OS X using PortAudio.

Plonk|Plink|Plank are easy to include in a project and are not tied to a particular host environment. Just add all the files in the /src directory (recursively) to a project. To use Plonk just include plonk/plonk.h (this automatically includes plank/plank.h as Plonk is dependent on Plank).

Getting started

There are a few compile options that can be configured using preprocessor macros. First, you should ensure that DEBUG=1 is defined for a Debug build and NDEBUG=1 is defined for a Release build.

Plank (these options also affect the behaviour of Plink and Plonk)

• PLANK_VEC_VDSP=1 : Use Apple's Accelerate vDSP library for vector processing where possible (the default is to use scalar code). You must also link to the Accelerate framework.
• PLANK_FFT_VDSP=1 : Use Apple's Accelerate vDSP library for FFT processing (the default is to use FFTReal which is included in the source tree). You must also link to the Accelerate framework.
• PLANK_OGGVORBIS=1 : Enable Ogg Vorbis support. You must include the files in ext/vorbis in your project too.

Plonk

• PLONK_USEPLINK=1 : Use the Plink library where possible. This effectively enables optimised versions of some processing units since Plink may be leveraging vectorised code directly (rather than relying of compiler optimisations via the template code in Plonk).
• PLONK_AUDIOHOST_PORTAUDIO=1 : Use the PortAudio audio host. You must also link to the PortAudio library.
• PLONK_AUDIOHOST_IOS=1 : Use the Apple iOS audio host. You must also link to the CoreAudio, AudioUnit and AudioToolbox frameworks.
• PLONK_AUDIOHOST_JUCE=1 : Use the Juce audio host. You must also link to Juce (either the static library or otherwise using the Introjucer to generate the project).

Plink None

You should read the section core concepts in Plonk then use the macplnk (requires Xcode 3.2.6 or later) or iosplnk (requires Xcode 4.3.3 or later) projects as a starting point. (Windows project - winplnk - coming soon.)