FastSineGenerator< T > Class Template Reference

Sine wave which is based on a fast approximation function using floating point math. More...

#include <CodecOpusOgg.h>

Inheritance diagram for FastSineGenerator< T >:

Public Member Functions
	FastSineGenerator (float amplitude=NumberConverter::maxValueT< T >(), float phase=0.0)
	FastSineGenerator (float amplitude=NumberConverter::maxValueT< T >(), float phase=0.0)
virtual AudioInfo	audioInfo ()
	Provides the AudioInfo.
bool	begin () override
virtual bool	begin (AudioInfo info)
	Starts the processing with the provided AudioInfo.
virtual AudioInfo	defaultConfig () override
	Provides the default configuration.
virtual void	end ()
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 T	readSample () override
	Provides a single sample.
virtual size_t	readSamples (int16_t *data, size_t len)
virtual void	restart ()
	Restarts the generator, e.g. after a play time has been defined and reached.
void	setAmplitude (float amp)
virtual void	setAudioInfo (AudioInfo info) override
	Defines/updates the AudioInfo.
void	setFrequency (float frequency) override
	Defines the frequency - after the processing has been started.
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
int16_t	applyRamp (int16_t sample)
void	logStatus ()
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 ()
float	sine (float t)
	sine approximation.
float	sine (float t)
	sine approximation.

Protected Attributes
bool	active
bool	activeWarningIssued
uint32_t	currentSample
const float	double_Pi
uint32_t	downMs
uint8_t	downPercent
uint32_t	downSamples
float	factor
AudioInfo	info
float	m_amplitude
float	m_cycles
float	m_deltaTime
volatile float	m_frequency
float	m_phase
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 = int16_t>
class audio_tools::audio_tools::FastSineGenerator< T >

Sine wave which is based on a fast approximation function using floating point math.

Author

Vivian Leigh Stewart

Copyright

GPLv3

Template Parameters

T

Constructor & Destructor Documentation

FastSineGenerator() [1/2]

template<class T = int16_t>

FastSineGenerator ( float amplitude = NumberConverter::maxValueT<T>(), float phase = 0.0 )

inline

FastSineGenerator() [2/2]

template<class T = int16_t>

FastSineGenerator ( float amplitude = NumberConverter::maxValueT<T>(), float phase = 0.0 )

inline

Member Function Documentation

applyRamp()

int16_t applyRamp ( int16_t sample )

inlineprotectedinherited

audioInfo()

virtual AudioInfo audioInfo ( )

inlinevirtualinherited

Provides the AudioInfo.

begin() [1/2]

bool begin ( )

inlineoverrideinherited

begin() [2/2]

virtual bool begin ( AudioInfo info )

inlinevirtualinherited

Starts the processing with the provided AudioInfo.

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

defaultConfig()

virtual AudioInfo defaultConfig ( )

inlineoverridevirtualinherited

Provides the default configuration.

Reimplemented from SoundGenerator< int16_t >.

end()

virtual void end ( )

inlinevirtualinherited

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

isActive()

virtual bool isActive ( )

inlinevirtualinherited

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

logStatus()

void logStatus ( )

inlineprotectedinherited

readBytes()

virtual size_t readBytes ( uint8_t * data, size_t len )

inlinevirtualinherited

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

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

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() [1/2]

template<class T = int16_t>

virtual T readSample ( )

inlineoverridevirtual

Provides a single sample.

Reimplemented from FloatSineGenerator< int16_t >.

readSample() [2/2]

template<class T = int16_t>

virtual T readSample ( )

inlineoverridevirtual

Provides a single sample.

Reimplemented from FloatSineGenerator< int16_t >.

readSamples()

virtual size_t readSamples ( int16_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.

setAmplitude()

void setAmplitude ( float amp )

inlineinherited

setAudioInfo()

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtualinherited

Defines/updates the AudioInfo.

Reimplemented from SoundGenerator< int16_t >.

setFrequency()

void setFrequency ( float frequency )

inlineoverridevirtualinherited

Defines the frequency - after the processing has been started.

Reimplemented from SoundGenerator< int16_t >.

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.

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

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.

sine() [1/2]

template<class T = int16_t>

float sine ( float t )

inlineprotected

sine approximation.

sine() [2/2]

template<class T = int16_t>

float sine ( float t )

inlineprotected

sine approximation.

Member Data Documentation

active

bool active

protectedinherited

activeWarningIssued

bool activeWarningIssued

protectedinherited

currentSample

uint32_t currentSample

protectedinherited

double_Pi

const float double_Pi

protectedinherited

downMs

uint32_t downMs

protectedinherited

downPercent

uint8_t downPercent

protectedinherited

downSamples

uint32_t downSamples

protectedinherited

factor

float factor

protectedinherited

info

AudioInfo info

protectedinherited

m_amplitude

float m_amplitude

protectedinherited

m_cycles

float m_cycles

protectedinherited

m_deltaTime

float m_deltaTime

protectedinherited

m_frequency

volatile float m_frequency

protectedinherited

m_phase

float m_phase

protectedinherited

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

• src/AudioTools/AudioCodecs/CodecOpusOgg.h
• src/AudioTools/AudioCodecs/CodecTSDemux.h