SoundGeneratorModulation< T, effectsuite_t > Class Template Reference

SoundGenerator using the ModulationBaseClass to generate the samples. More...

#include <AudioEffectsSuite.h>

Inheritance diagram for SoundGeneratorModulation< T, effectsuite_t >:

Public Member Functions
	SoundGeneratorModulation (ModulationBaseClass< effectsuite_t > &mod, int freq)
virtual AudioInfo	audioInfo ()
	Provides the AudioInfo.
virtual bool	begin ()
	Starts the processing.
bool	begin (AudioInfo info) override
	Starts the processing with the provided AudioInfo.
virtual AudioInfo	defaultConfig ()
	Provides the default configuration.
virtual void	end ()
virtual void	end (bool allow_rampdown)
virtual bool	isActive ()
	Checks if the begin method has been called - after end() isActive is false.
virtual size_t	readBytes (uint8_t *data, size_t len)
	Provides the data as byte array with the requested number of channels.
virtual T	readSample () override
	Provides a single sample.
virtual size_t	readSamples (T *data, size_t len)
virtual void	restart ()
	Restarts the generator, e.g. after a play time has been defined and reached.
virtual void	setAudioInfo (AudioInfo info)
	Defines/updates the AudioInfo.
virtual void	setFrequency (float frequency)
	Abstract method: not implemented! Just provides an error message...
virtual void	setPlayTime (uint32_t playMs, uint8_t upPercent=20, uint8_t downPercent=30)
	Defines the play time in ms and the ramp up and ramp down time in percent.
virtual void	setRampTimes (uint32_t playMs, uint32_t upMs=5, uint32_t downMs=5)

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
bool	activeWarningIssued
uint32_t	currentSample
uint32_t	downMs
uint8_t	downPercent
uint32_t	downSamples
float	factor
int	freq
AudioInfo	info
float	max_value =32767
ModulationBaseClass< effectsuite_t > *	p_mod =nullptr
uint32_t	playMs
uint32_t	playSamples
float	rampDownDec
float	rampUpInc
RingBuffer< uint8_t >	ring_buffer
uint32_t	upMs
uint8_t	upPercent
uint32_t	upSamples

Detailed Description

template<class T, typename effectsuite_t = effectsuite_t_default>
class audio_tools::SoundGeneratorModulation< T, effectsuite_t >

SoundGenerator using the ModulationBaseClass to generate the samples.

Template Parameters

T

Constructor & Destructor Documentation

SoundGeneratorModulation()

template<class T , typename effectsuite_t = effectsuite_t_default>

SoundGeneratorModulation ( ModulationBaseClass< effectsuite_t > &  mod, int  freq  )

inline

Member Function Documentation

applyRamp()

T applyRamp ( T  sample )

inlineprotectedinherited

audioInfo()

virtual AudioInfo audioInfo ( )

inlinevirtualinherited

Provides the AudioInfo.

begin() [1/2]

virtual bool begin ( )

inlinevirtualinherited

Starts the processing.

begin() [2/2]

template<class T , typename effectsuite_t = effectsuite_t_default>

bool begin ( AudioInfo  info )

inlineoverridevirtual

Starts the processing with the provided AudioInfo.

Reimplemented from SoundGenerator< T >.

defaultConfig()

virtual AudioInfo defaultConfig ( )

inlinevirtualinherited

Provides the default configuration.

end() [1/2]

virtual void end ( )

inlinevirtualinherited

end() [2/2]

virtual void end ( bool  allow_rampdown )

inlinevirtualinherited

Ends the processing. If either setPlayTime() or setRampTimes() have been set, then allow_rampdown=true will start a ramp-down instead of stopping immediately.

isActive()

virtual bool isActive ( )

inlinevirtualinherited

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

readBytes()

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

inlinevirtualinherited

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

readBytesFrames()

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

inlineprotectedinherited

readBytesFromBuffer()

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

inlineprotectedinherited

readSample()

template<class T , typename effectsuite_t = effectsuite_t_default>

virtual T readSample ( )

inlineoverridevirtual

Provides a single sample.

Implements SoundGenerator< T >.

readSamples()

virtual size_t readSamples ( T *  data, size_t  len  )

inlinevirtualinherited

Provides the data as T array (interleaved by channel) with the requested number of samples (values, not frames)

recalculatePlayTime()

void recalculatePlayTime ( )

inlineprotectedinherited

restart()

virtual void restart ( )

inlinevirtualinherited

Restarts the generator, e.g. after a play time has been defined and reached.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlinevirtualinherited

Defines/updates the AudioInfo.

setFrequency()

virtual void setFrequency ( float  frequency )

inlinevirtualinherited

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

setPlayTime()

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

inlinevirtualinherited

Defines the play time in ms and the ramp up and ramp down time in percent.

setRampTimes()

virtual void setRampTimes ( uint32_t  playMs, uint32_t  upMs = 5, uint32_t  downMs = 5  )

inlinevirtualinherited

Alternative to setPlayTime. It sets ramp-up and ramp-down times in ms instead of percentages. If playMs == 0, it will play indefinitely. restart();begin(); starts the ramp-up and sustain as normal, but it will sustain forever. end(true) triggers a ramp-down then inactive.

Member Data Documentation

active

bool active

protectedinherited

activeWarningIssued

bool activeWarningIssued

protectedinherited

currentSample

uint32_t currentSample

protectedinherited

downMs

uint32_t downMs

protectedinherited

downPercent

uint8_t downPercent

protectedinherited

downSamples

uint32_t downSamples

protectedinherited

factor

float factor

protectedinherited

freq

template<class T , typename effectsuite_t = effectsuite_t_default>

int freq

protected

info

AudioInfo info

protectedinherited

max_value

template<class T , typename effectsuite_t = effectsuite_t_default>

float max_value =32767

protected

p_mod

template<class T , typename effectsuite_t = effectsuite_t_default>

ModulationBaseClass<effectsuite_t>* p_mod =nullptr

protected

playMs

uint32_t playMs

protectedinherited

playSamples

uint32_t playSamples

protectedinherited

rampDownDec

float rampDownDec

protectedinherited

rampUpInc

float rampUpInc

protectedinherited

ring_buffer

RingBuffer<uint8_t> ring_buffer

protectedinherited

upMs

uint32_t upMs

protectedinherited

upPercent

uint8_t upPercent

protectedinherited

upSamples

uint32_t upSamples

protectedinherited

---

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

• src/AudioTools/AudioLibs/AudioEffectsSuite.h