arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SoundGenerator< T > Class Template Referenceabstract
Arduino Audio Tools » DSP » Generators

Base class to define the abstract interface for the sound generating classes. More...

#include <SoundGenerator.h>

Inheritance diagram for SoundGenerator< T >:
FloatSineGenerator< int16_t > STKGenerator< stk::Instrmnt, int16_t > STKGenerator< StkCls, int16_t > FastIntSineGenerator< T > FloatSineGenerator< T > GeneratorFixedValue< T > GeneratorFromArray< T > GeneratorFromStream< T > GeneratorMixer< T > GeneratorQueue< T > PinkNoiseGenerator< T > STKGenerator< StkCls, T > SawToothGenerator< T > SilenceGenerator< T > SineFromTable< T > SquareWaveGenerator< T > TestGenerator< T > WhiteNoiseGenerator< T >

Public Member Functions

 SoundGenerator ()
 
virtual ~SoundGenerator ()
 
virtual AudioInfo audioInfo ()
 Provides the AudioInfo.
 
virtual bool begin ()
 Starts the processing.
 
virtual bool begin (AudioInfo info)
 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 ()=0
 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 = false
 
bool activeWarningIssued = false
 
uint32_t currentSample = 0
 
uint32_t downMs = 0
 
uint8_t downPercent = 40
 
uint32_t downSamples = 0
 
float factor = 1.0f
 
AudioInfo info
 
uint32_t playMs = 0
 
uint32_t playSamples = 0
 
float rampDownDec = 0.0
 
float rampUpInc = 0.0
 
RingBuffer< uint8_t > ring_buffer {0}
 
uint32_t upMs = 0
 
uint8_t upPercent = 5
 
uint32_t upSamples = 0
 

Detailed Description

template<class T = int16_t>
class audio_tools::SoundGenerator< T >

Base class to define the abstract interface for the sound generating classes.

Author
Phil Schatzmann
Copyright
GPLv3
Template Parameters
T

Constructor & Destructor Documentation

◆ SoundGenerator()

template<class T = int16_t>
SoundGenerator ( )
inline

◆ ~SoundGenerator()

template<class T = int16_t>
virtual ~SoundGenerator ( )
inlinevirtual

Member Function Documentation

◆ applyRamp()

template<class T = int16_t>
T applyRamp ( T  sample)
inlineprotected

◆ audioInfo()

template<class T = int16_t>
virtual AudioInfo audioInfo ( )
inlinevirtual

Provides the AudioInfo.

◆ begin() [1/2]

template<class T = int16_t>
virtual bool begin ( )
inlinevirtual

Starts the processing.

Reimplemented in SineFromTable< T >, FloatSineGenerator< T >, FloatSineGenerator< int16_t >, FastIntSineGenerator< T >, SquareWaveGenerator< T >, SawToothGenerator< T >, GeneratorFromArray< T >, and GeneratorFixedValue< T >.

◆ begin() [2/2]

template<class T = int16_t>
virtual bool begin ( AudioInfo  info)
inlinevirtual

Starts the processing with the provided AudioInfo.

Reimplemented in STKGenerator< StkCls, T >, STKGenerator< stk::Instrmnt, int16_t >, STKGenerator< StkCls, int16_t >, Synthesizer, GeneratorFixedValue< T >, SoundGeneratorModulation< T, effectsuite_t >, FloatSineGenerator< T >, FloatSineGenerator< int16_t >, FastIntSineGenerator< T >, SquareWaveGenerator< T >, SawToothGenerator< T >, and GeneratorFromArray< T >.

◆ defaultConfig()

template<class T = int16_t>
virtual AudioInfo defaultConfig ( )
inlinevirtual

Provides the default configuration.

Reimplemented in STKGenerator< StkCls, T >, STKGenerator< stk::Instrmnt, int16_t >, STKGenerator< StkCls, int16_t >, FloatSineGenerator< T >, and FloatSineGenerator< int16_t >.

◆ end() [1/2]

template<class T = int16_t>
virtual void end ( )
inlinevirtual

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

◆ end() [2/2]

template<class T = int16_t>
virtual void end ( bool  allow_rampdown)
inlinevirtual

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

template<class T = int16_t>
virtual bool isActive ( )
inlinevirtual

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

◆ readBytes()

template<class T = int16_t>
virtual size_t readBytes ( uint8_t *  data,
size_t  len 
)
inlinevirtual

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

Reimplemented in GeneratorQueue< T >.

◆ readBytesFrames()

template<class T = int16_t>
size_t readBytesFrames ( uint8_t *  buffer,
size_t  lengthBytes,
int  frames,
int  channels 
)
inlineprotected

◆ readBytesFromBuffer()

template<class T = int16_t>
size_t readBytesFromBuffer ( uint8_t *  buffer,
size_t  lengthBytes,
int  frame_size,
int  channels 
)
inlineprotected

◆ readSample()

template<class T = int16_t>
virtual T readSample ( )
pure virtual

Provides a single sample.

Implemented in STKGenerator< StkCls, T >, STKGenerator< stk::Instrmnt, int16_t >, STKGenerator< StkCls, int16_t >, WhiteNoiseGenerator< T >, PinkNoiseGenerator< T >, SilenceGenerator< T >, GeneratorFromStream< T >, SineFromTable< T >, GeneratorMixer< T >, SoundGeneratorModulation< T, effectsuite_t >, AudioEffects< GeneratorT >, FloatSineGenerator< T >, FloatSineGenerator< int16_t >, FastSineGenerator< T >, FastIntSineGenerator< T >, SquareWaveGenerator< T >, SawToothGenerator< T >, GeneratorFromArray< T >, GeneratorFixedValue< T >, TestGenerator< T >, GeneratorQueue< T >, and Synthesizer.

◆ readSamples()

template<class T = int16_t>
virtual size_t readSamples ( T *  data,
size_t  len 
)
inlinevirtual

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

Reimplemented in GeneratorQueue< T >.

◆ recalculatePlayTime()

template<class T = int16_t>
void recalculatePlayTime ( )
inlineprotected

◆ restart()

template<class T = int16_t>
virtual void restart ( )
inlinevirtual

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

◆ setAudioInfo()

template<class T = int16_t>
virtual void setAudioInfo ( AudioInfo  info)
inlinevirtual

Defines/updates the AudioInfo.

Reimplemented in FloatSineGenerator< T >, FloatSineGenerator< int16_t >, FastIntSineGenerator< T >, SquareWaveGenerator< T >, and SawToothGenerator< T >.

◆ setFrequency()

template<class T = int16_t>
virtual void setFrequency ( float  frequency)
inlinevirtual

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

Reimplemented in GeneratorQueue< T >, SineFromTable< T >, STKInstrument< StkCls, T >, FloatSineGenerator< T >, FloatSineGenerator< int16_t >, FastIntSineGenerator< T >, SquareWaveGenerator< T >, SawToothGenerator< T >, and GeneratorFromArray< T >.

◆ setPlayTime()

template<class T = int16_t>
virtual void setPlayTime ( uint32_t  playMs,
uint8_t  upPercent = 20,
uint8_t  downPercent = 30 
)
inlinevirtual

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

Reimplemented in GeneratorQueue< T >.

◆ setRampTimes()

template<class T = int16_t>
virtual void setRampTimes ( uint32_t  playMs,
uint32_t  upMs = 5,
uint32_t  downMs = 5 
)
inlinevirtual

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

template<class T = int16_t>
bool active = false
protected

◆ activeWarningIssued

template<class T = int16_t>
bool activeWarningIssued = false
protected

◆ currentSample

template<class T = int16_t>
uint32_t currentSample = 0
protected

◆ downMs

template<class T = int16_t>
uint32_t downMs = 0
protected

◆ downPercent

template<class T = int16_t>
uint8_t downPercent = 40
protected

◆ downSamples

template<class T = int16_t>
uint32_t downSamples = 0
protected

◆ factor

template<class T = int16_t>
float factor = 1.0f
protected

◆ info

template<class T = int16_t>
AudioInfo info
protected

◆ playMs

template<class T = int16_t>
uint32_t playMs = 0
protected

◆ playSamples

template<class T = int16_t>
uint32_t playSamples = 0
protected

◆ rampDownDec

template<class T = int16_t>
float rampDownDec = 0.0
protected

◆ rampUpInc

template<class T = int16_t>
float rampUpInc = 0.0
protected

◆ ring_buffer

template<class T = int16_t>
RingBuffer<uint8_t> ring_buffer {0}
protected

◆ upMs

template<class T = int16_t>
uint32_t upMs = 0
protected

◆ upPercent

template<class T = int16_t>
uint8_t upPercent = 5
protected

◆ upSamples

template<class T = int16_t>
uint32_t upSamples = 0
protected
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8