STK Stream for Instrument. More...

#include <AudioSTK.h>

Inheritance diagram for STKInstrument< StkCls, T >:

Public Member Functions
	STKInstrument ()=default

	STKInstrument (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 ()

void	noteOff ()

void	noteOn (float freq, float vol)

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)

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

float	amplitude = 1.0

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::Instrmnt, class T = int16_t>
class audio_tools::STKInstrument< StkCls, T >

STK Stream for Instrument.

Constructor & Destructor Documentation

◆ STKInstrument() [1/2]

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

STKInstrument ( )

default

◆ STKInstrument() [2/2]

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

STKInstrument ( StkCls & instrument )

inline

Member Function Documentation

◆ applyRamp()

template<class T = int16_t>

T applyRamp ( T sample )

inlineprotectedinherited

◆ audioInfo()

template<class T = int16_t>

virtual AudioInfo audioInfo ( )

inlinevirtualinherited

Provides the AudioInfo.

◆ begin() [1/2]

template<class T = int16_t>

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in SineFromTable< T >, SineWaveGenerator< T >, SineWaveGenerator< int16_t >, GeneratorFromArray< T >, and GeneratorFixedValue< T >.

◆ begin() [2/2]

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

bool begin ( AudioInfo cfg )

inlinevirtualinherited

Starts the processing.

Reimplemented from SoundGenerator< T >.

◆ defaultConfig()

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

AudioInfo defaultConfig ( )

inlinevirtualinherited

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

◆ noteOff()

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

void noteOff ( )

inline

◆ noteOn()

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

void noteOn	(	float	freq,
		float	vol
	)

inline

◆ readBytes()

template<class T = int16_t>

virtual size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlinevirtualinherited

Provides the data as byte array with the requested number of channels.

◆ readBytesFrames()

template<class T = int16_t>

size_t readBytesFrames	(	uint8_t *	buffer,
		size_t	lengthBytes,
		int	frames,
		int	channels
	)

inlineprotectedinherited

◆ readBytesFromBuffer()

template<class T = int16_t>

size_t readBytesFromBuffer	(	uint8_t *	buffer,
		size_t	lengthBytes,
		int	frame_size,
		int	channels
	)

inlineprotectedinherited

◆ readSample()

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

T readSample ( )

inlinevirtualinherited

Provides a single sample.

Implements SoundGenerator< T >.

◆ recalculatePlayTime()

template<class T = int16_t>

void recalculatePlayTime ( )

inlineprotectedinherited

◆ setAmplitude()

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

void setAmplitude ( float amplitude )

inline

Defines the amplitude (0.0 ... 1.0)

◆ 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 StkCls = stk::Instrmnt, class T = int16_t>

void setFrequency ( float frequency )

inlineoverridevirtual

sets the frequency

Reimplemented from SoundGenerator< T >.

◆ setInput()

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

void setInput ( StkCls & instrument )

inlineinherited

◆ setPlayTime()

template<class T = int16_t>

void setPlayTime	(	uint32_t	playMs,
		uint8_t	upPercent = `20`,
		uint8_t	downPercent = `30`
	)

inlineinherited

Member Data Documentation

◆ active

template<class T = int16_t>

bool active = false

protectedinherited

◆ activeWarningIssued

template<class T = int16_t>

bool activeWarningIssued = false

protectedinherited

◆ amplitude

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

float amplitude = 1.0

protected

◆ currentSample

template<class T = int16_t>

uint32_t currentSample = 0

protectedinherited

◆ downPercent

template<class T = int16_t>

uint8_t downPercent = 40

protectedinherited

◆ factor

template<class T = int16_t>

float factor = 1.0f

protectedinherited

◆ info

template<class T = int16_t>

AudioInfo info

protectedinherited

◆ max_value

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

T max_value

protectedinherited

◆ p_instrument

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

StkCls* p_instrument = nullptr

protectedinherited

◆ playMs

template<class T = int16_t>

uint32_t playMs = 0

protectedinherited

◆ playSamples

template<class T = int16_t>

uint32_t playSamples = 0

protectedinherited

◆ rampDownDec

template<class T = int16_t>

float rampDownDec = 0.0

protectedinherited

◆ rampDownSamples

template<class T = int16_t>

uint32_t rampDownSamples = 0

protectedinherited

◆ rampUpInc

template<class T = int16_t>

float rampUpInc = 0.0

protectedinherited

◆ ring_buffer

template<class T = int16_t>

RingBuffer<uint8_t> ring_buffer {0}

protectedinherited

◆ upPercent

template<class T = int16_t>

uint8_t upPercent = 5

protectedinherited

◆ upSamples

template<class T = int16_t>

uint32_t upSamples = 0

protectedinherited

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

src/AudioTools/AudioLibs/AudioSTK.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ STKInstrument() [1/2]

◆ STKInstrument() [2/2]

Member Function Documentation

◆ applyRamp()

◆ audioInfo()

◆ begin() [1/2]

◆ begin() [2/2]

◆ defaultConfig()

◆ end()

◆ isActive()

◆ noteOff()

◆ noteOn()

◆ readBytes()

◆ readBytesFrames()

◆ readBytesFromBuffer()

◆ readSample()

◆ recalculatePlayTime()

◆ setAmplitude()

◆ setAudioInfo()

◆ setFrequency()

◆ setInput()

◆ setPlayTime()

Member Data Documentation

◆ active

◆ activeWarningIssued

◆ amplitude

◆ currentSample

◆ downPercent

◆ factor

◆ info

◆ max_value

◆ p_instrument

◆ playMs

◆ playSamples

◆ rampDownDec

◆ rampDownSamples

◆ rampUpInc

◆ ring_buffer

◆ upPercent

◆ upSamples