STKGenerator< StkCls, T > Class Template Reference

The Synthesis ToolKit in C++ (STK) is a set of open source audio signal processing and algorithmic synthesis classes written in the C++ programming language. You need to install https://github.com/pschatzmann/Arduino-STK. More...

#include <AudioSTK.h>

Inheritance diagram for STKGenerator< StkCls, T >:

Public Member Functions
	STKGenerator (StkCls &instrument)
virtual AudioInfo	audioInfo ()
	Provides the AudioInfo.
virtual bool	begin ()
bool	begin (AudioInfo cfg)
	Starts the processing.
AudioInfo	defaultConfig ()
	provides the default configuration
virtual void	end ()
	ends the processing
virtual bool	isActive ()
virtual size_t	readBytes (uint8_t *data, size_t len)
	Provides the data as byte array with the requested number of channels.
T	readSample ()
	Provides a single sample.
void	setAmplitude (float amplitude)
	Defines the amplitude (0.0 ... 1.0)
virtual void	setAudioInfo (AudioInfo info)
	Defines/updates the AudioInfo.
void	setFrequency (float frequency) override
	sets the frequency
void	setInput (StkCls &instrument)

Protected Member Functions
size_t	readBytesFrames (uint8_t *buffer, size_t lengthBytes, int frames, int channels)
size_t	readBytesFromBuffer (uint8_t *buffer, size_t lengthBytes, int frame_size, int channels)

Protected Attributes
bool	active
bool	activeWarningIssued
float	amplitude = 0.9
AudioInfo	info
T	max_value
StkCls *	p_instrument = nullptr
RingBuffer< uint8_t >	ring_buffer

Detailed Description

template<class StkCls, class T>
class audio_tools::STKGenerator< StkCls, T >

The Synthesis ToolKit in C++ (STK) is a set of open source audio signal processing and algorithmic synthesis classes written in the C++ programming language. You need to install https://github.com/pschatzmann/Arduino-STK.

You can find further informarmation in the original Readme of the STK Project

Like many other sound libraries it originates from an University (Princeton) and can look back at a very long history: it was created in 1995. In the 90s the computers had limited processor power and memory available. In todays world we can get some cheap Microcontrollers, which provide almost the same capabilities.

Template Parameters

T

Member Function Documentation

begin()

template<class StkCls , class T >

bool begin ( AudioInfo  cfg )

inlinevirtual

Starts the processing.

Reimplemented from SoundGenerator< T >.

defaultConfig()

template<class StkCls , class T >

AudioInfo defaultConfig ( )

inlinevirtual

provides the default configuration

Reimplemented from SoundGenerator< T >.

isActive()

virtual bool isActive ( )

inlinevirtualinherited

Checks if the begin method has been called - after end() isActive returns false

readSample()

template<class StkCls , class T >

T readSample ( )

inlinevirtual

Provides a single sample.

Implements SoundGenerator< T >.

setFrequency()

template<class StkCls , class T >

void setFrequency ( float  frequency )

inlineoverridevirtual

sets the frequency

Reimplemented from SoundGenerator< T >.

---

The documentation for this class was generated from the following file:

• src/AudioTools/AudioLibs/AudioSTK.h