SoundGenerator< T > Class Template Reference

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

#include <SoundGenerator.h>

Inheritance diagram for SoundGenerator< T >:

Public Member Functions
virtual AudioInfo	audioInfo ()
	Provides the AudioInfo.
virtual bool	begin ()
virtual bool	begin (AudioInfo info)
virtual 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.
virtual T	readSample ()=0
	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	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
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 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

Member Function Documentation

begin() [1/2]

template<class T = int16_t>

virtual bool begin ( )

inlinevirtual

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

begin() [2/2]

template<class T = int16_t>

virtual bool begin ( AudioInfo  info )

inlinevirtual

Reimplemented in STKGenerator< StkCls, T >, STKGenerator< stk::Instrmnt, int16_t >, and STKGenerator< StkCls, int16_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 >, SineWaveGenerator< T >, and SineWaveGenerator< int16_t >.

end()

template<class T = int16_t>

virtual void end ( )

inlinevirtual

ends the processing

Reimplemented in GeneratorFromArray< T >.

isActive()

template<class T = int16_t>

virtual bool isActive ( )

inlinevirtual

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

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 >, SquareWaveGenerator< T >, WhiteNoiseGenerator< T >, PinkNoiseGenerator< T >, SilenceGenerator< T >, GeneratorFromStream< T >, SineFromTable< T >, GeneratorMixer< T >, SoundGeneratorModulation< T >, AudioEffects< GeneratorT >, SineWaveGenerator< T >, SineWaveGenerator< int16_t >, FastSineGenerator< T >, FastSineGenerator< int16_t >, SawToothGenerator< T >, GeneratorFromArray< T >, GeneratorFixedValue< T >, TestGenerator< T >, and Synthesizer.

setAudioInfo()

template<class T = int16_t>

virtual void setAudioInfo ( AudioInfo  info )

inlinevirtual

Defines/updates the AudioInfo.

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

setFrequency()

template<class T = int16_t>

virtual void setFrequency ( float  frequency )

inlinevirtual

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/CoreAudio/AudioEffects/SoundGenerator.h