Skip to content
Wrapper to use the Synthesis Toolkit with Cinder
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets/rawwaves
samples/StkTest
src
.gitignore
LICENSE.txt
cinderblock.png
cinderblock.xml
readme.md

readme.md

Cinder-Stk

Wrapper to use the Synthesis Toolkit with Cinder.

Brief

The STK packages many C++ classes for audio processing, including instruments, effects, filters, and more. It is highly regarded for is cross-platform, raw design that allows it to be easily embeddable in various other systems. In this repo, I've only included the files for DSP, while ci::audio covers things like hardware I/O and processing the audio graph.

For convenience, the Stk Instrmnt and Effect classes have been wrapped into audio::Node types so they can be easily connected with other cinder audio nodes. However this is adds a bit of indirection and copying so if best performance is crucial, it's recommended to make a custom audio::Node and run whatever STK algorithms and tick()s you like from a single Node::process().

Installation

If you're installing with TinderBox and decide to copy the source to your project, currently you'll have to additionally copy the STK's rawwaves folder into your assets directory to use some of the Instruments. If you install as 'relative', it should just work when you call cistk::initRawwavePath().

Usage

You need to do two things before using (enabling cinder's audio processing graph) to use the STK classes:

stk::Stk::setSampleRate( audio::master()->getSampleRate() ); // 1) set the samplerate
cistk::initRawwavePath(); // 2) configure the path to the rawwaves folder

The easiest way to get started is to #include "cistk/CinderStk.h", which will give you access to everything in the library. Other than that seem the StkTestApp for how to use the InstrumentNode or EffectNode wrappers, or their source for how to use STK directly.

See here for an overview on cinder's audio capabilities.

You can’t perform that action at this time.