SquareWaveGenerator< T > Class Template Reference

Generates a square wave sound. More...

#include <SoundGenerator.h>

Inheritance diagram for SquareWaveGenerator< T >:

Public Member Functions
	SquareWaveGenerator (float amplitude=32767.0f, float phase=0.0f)
virtual AudioInfo	audioInfo ()
	Provides the AudioInfo.
bool	begin () override
bool	begin (AudioInfo info) override
bool	begin (AudioInfo info, float frequency)
bool	begin (int channels, int sample_rate, float frequency)
virtual AudioInfo	defaultConfig () override
	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 ()
	Provides a single sample.
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.

Protected Member Functions
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)
float	sine (float t)
	sine approximation.
T	value (T value, T amplitude)

Protected Attributes
bool	active = false
bool	activeWarningIssued = false
const float	double_Pi = 2.0f * PI
AudioInfo	info
float	m_amplitude = 1.0f
float	m_cycles = 0.0f
float	m_deltaTime = 0.0f
volatile float	m_frequency = 0.0f
float	m_phase = 0.0f
RingBuffer< uint8_t >	ring_buffer {0}

Detailed Description

template<class T>
class audio_tools::SquareWaveGenerator< T >

Generates a square wave sound.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

begin() [1/2]

template<class T >

bool begin ( )

inlineoverridevirtualinherited

Reimplemented from SoundGenerator< T >.

begin() [2/2]

template<class T >

bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from SoundGenerator< T >.

defaultConfig()

template<class T >

virtual AudioInfo defaultConfig ( )

inlineoverridevirtualinherited

Provides the default configuration.

Reimplemented from SoundGenerator< T >.

end()

template<class T >

virtual void end ( )

inlinevirtualinherited

ends the processing

Reimplemented in GeneratorFromArray< T >.

isActive()

template<class T >

virtual bool isActive ( )

inlinevirtualinherited

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

readSample()

template<class T >

virtual T readSample ( )

inlinevirtual

Provides a single sample.

Reimplemented from FastSineGenerator< T >.

setAudioInfo()

template<class T >

virtual void setAudioInfo ( AudioInfo  info )

inlineoverridevirtualinherited

Defines/updates the AudioInfo.

Reimplemented from SoundGenerator< T >.

setFrequency()

template<class T >

void setFrequency ( float  frequency )

inlineoverridevirtualinherited

Defines the frequency - after the processing has been started.

Reimplemented from SoundGenerator< T >.

---

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

• src/AudioTools/CoreAudio/AudioEffects/SoundGenerator.h