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.
virtual void	setAudioInfo (AudioInfo info)
	Defines/updates the AudioInfo.
virtual void	setFrequency (float frequency)
	Abstract method: not implemented! Just provides an error message...
void	setInput (StkCls &instrument)
void	setPlayTime (uint32_t playMs, uint8_t upPercent=20, uint8_t downPercent=30)

Protected Member Functions
T	applyRamp (T sample)
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)
void	recalculatePlayTime ()

Protected Attributes
bool	active = false
bool	activeWarningIssued = false
uint32_t	currentSample = 0
uint8_t	downPercent = 40
float	factor = 1.0f
AudioInfo	info
T	max_value
StkCls *	p_instrument = nullptr
uint32_t	playMs = 0
uint32_t	playSamples = 0
float	rampDownDec = 0.0
uint32_t	rampDownSamples = 0
float	rampUpInc = 0.0
RingBuffer< uint8_t >	ring_buffer {0}
uint8_t	upPercent = 5
uint32_t	upSamples = 0

Detailed Description

template<class StkCls = stk::Generator, class T = int16_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

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

begin() [1/2]

template<class T = int16_t>

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in GeneratorFromArray< T >, and GeneratorFixedValue< T >.

begin() [2/2]

template<class StkCls = stk::Generator, class T = int16_t>

bool begin ( AudioInfo  cfg )

inlinevirtual

Starts the processing.

Reimplemented from SoundGenerator< T >.

defaultConfig()

template<class StkCls = stk::Generator, class T = int16_t>

AudioInfo defaultConfig ( )

inlinevirtual

provides the default configuration

Reimplemented from SoundGenerator< T >.

end()

template<class T = int16_t>

virtual void end ( )

inlinevirtualinherited

ends the processing

Reimplemented in GeneratorFromArray< T >.

isActive()

template<class T = int16_t>

virtual bool isActive ( )

inlinevirtualinherited

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

readSample()

template<class StkCls = stk::Generator, class T = int16_t>

T readSample ( )

inlinevirtual

Provides a single sample.

Implements SoundGenerator< T >.

setAudioInfo()

template<class T = int16_t>

virtual void setAudioInfo ( AudioInfo  info )

inlinevirtualinherited

Defines/updates the AudioInfo.

Reimplemented in SineWaveGenerator< T >, and SineWaveGenerator< int16_t >.

setFrequency()

template<class T = int16_t>

virtual void setFrequency ( float  frequency )

inlinevirtualinherited

Abstract method: not implemented! Just provides an error message...

Reimplemented in SineFromTable< T >, STKInstrument< StkCls, T >, SineWaveGenerator< T >, and SineWaveGenerator< int16_t >.

---

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

• src/AudioTools/AudioLibs/AudioSTK.h