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

#include <SoundGenerator.h>

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.

◆ begin() [2/2]

template<class T = int16_t>

virtual bool begin ( AudioInfo info )

inlinevirtual

Starts the processing with the provided AudioInfo.

◆ defaultConfig()

template<class T = int16_t>

virtual AudioInfo defaultConfig ( )

inlinevirtual

Provides the default configuration.

◆ end() [1/2]

template<class T = int16_t>

virtual void end ( )

inlinevirtual

◆ 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.

◆ 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.

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

◆ 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.

◆ setFrequency()

template<class T = int16_t>

virtual void setFrequency ( float frequency )

inlinevirtual

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

◆ 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.

◆ 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:

src/AudioTools/CoreAudio/AudioEffects/SoundGenerator.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SoundGenerator()

◆ ~SoundGenerator()

Member Function Documentation

◆ applyRamp()

◆ audioInfo()

◆ begin() [1/2]

◆ begin() [2/2]

◆ defaultConfig()

◆ end() [1/2]

◆ end() [2/2]

◆ isActive()

◆ readBytes()

◆ readBytesFrames()

◆ readBytesFromBuffer()

◆ readSample()

◆ readSamples()

◆ recalculatePlayTime()

◆ restart()

◆ setAudioInfo()

◆ setFrequency()

◆ setPlayTime()

◆ setRampTimes()

Member Data Documentation

◆ active

◆ activeWarningIssued

◆ currentSample

◆ downMs

◆ downPercent

◆ downSamples

◆ factor

◆ info

◆ playMs

◆ playSamples

◆ rampDownDec

◆ rampUpInc

◆ ring_buffer

◆ upMs

◆ upPercent

◆ upSamples