Produces a sine wave at fixed frequency. More...

#include <hart_sinewave.hpp>

Inheritance diagram for SineWave< SampleType >:

Public Member Functions
	SineWave (double frequencyHz=(SampleType) 1000, double phaseRadians=(SampleType) 0)

bool	supportsNumChannels (size_t) const override
	Tells the host whether this Signal is capable of generating audio for a certain amount of cchannels.

void	prepare (double sampleRateHz, size_t, size_t) override
	Prepare the signal for rendering.

void	renderNextBlock (AudioBuffer< SampleType > &output) override
	Renders next block audio for the signal.

void	reset () override
	Resets the Signal to initial state.

void	represent (std::ostream &stream) const override
	Makes a text representation of this Signal for test failure outputs.

	HART_SIGNAL_DEFINE_COPY_AND_MOVE (SineWave)

Public Member Functions inherited from Signal< SampleType >
	Signal ()=default
	Default constructor.

	Signal (const Signal &other)
	Copies other signal.

	Signal (Signal &&other) noexcept
	Moves from other signal.

virtual	~Signal ()=default
	Destructor.

Signal &	operator= (const Signal &other)
	Copies from other signal.

Signal &	operator= (Signal &&other) noexcept
	Moves from other signal.

virtual bool	supportsSampleRate (double) const
	Tells whether this Signal supports given sample rate.

virtual std::unique_ptr< Signal< SampleType > >	copy () const =0
	Returns a smart pointer with a copy of this object.

virtual std::unique_ptr< Signal< SampleType > >	move ()=0
	Returns a smart pointer with a moved instance of this object.

Signal &	followedBy (const DSP< SampleType > &dsp)
	Adds a DSP effect to the end of signal's DSP chain by copying it.

Signal &	followedBy (std::unique_ptr< DSP< SampleType > > dsp)
	Adds a DSP effect to the end of signal's DSP chain by transfering a smart pointer.

template<typename DerivedDSP , typename = typename std::enable_if< std::is_base_of< DSP<SampleType>, typename std::decay<DerivedDSP>::type >::value >::type>
Signal &	followedBy (DerivedDSP &&dsp)
	Adds a DSP effect to the end of signal's DSP chain by moving it.

void	prepareWithDSPChain (double sampleRateHz, size_t numOutputChannels, size_t maxBlockSizeFrames)
	Prepares the signal and all attached effects in the DSP chain for rendering.

void	renderNextBlockWithDSPChain (AudioBuffer< SampleType > &output)
	Renders next block audio for the signal and all the effects in the DSP chain.

virtual void	resetWithDSPChain ()
	Resets to Signal and all the effects attached to its DSP chain to initial state.

Additional Inherited Members
Protected Member Functions inherited from Signal< SampleType >
void	setNumChannels (size_t numChannels)

size_t	getNumChannels ()

Related Symbols inherited from Signal< SampleType >
template<typename SampleType >
std::ostream &	operator<< (std::ostream &stream, const Signal< SampleType > &signal)
	Prints readable text representation of the Signal object into the I/O stream.

template<typename SampleType , typename DerivedDSP , typename std::enable_if< std::is_base_of< DSP< SampleType >, typename std::decay< DerivedDSP >::type >::value >::type >
Signal< SampleType > &	operator>> (Signal< SampleType > &signal, DerivedDSP &&dsp)
	Adds a DSP effect to the end of signal's DSP chain by moving it.

template<typename SampleType >
Signal< SampleType > &	operator>> (Signal< SampleType > &signal, const DSP< SampleType > &dsp)
	Adds a DSP effect to the end of signal's DSP chain by copying it.

template<typename SampleType >
Signal< SampleType > &&	operator>> (Signal< SampleType > &&signal, const DSP< SampleType > &dsp)
	Adds a DSP effect to the end of signal's DSP chain by copying it.

template<typename SampleType >
Signal< SampleType > &	operator>> (Signal< SampleType > &signal, std::unique_ptr< DSP< SampleType > > dsp)
	Adds a DSP effect to the end of signal's DSP chain by transfering it.

template<typename SampleType >
Signal< SampleType > &&	operator>> (Signal< SampleType > &&signal, std::unique_ptr< DSP< SampleType > > dsp)
	Adds a DSP effect to the end of signal's DSP chain by transfering it.

Detailed Description

template<typename SampleType>
class hart::SineWave< SampleType >

Produces a sine wave at fixed frequency.

Outputs a signal at 0dB peak (-1.0..+1.0)

Definition at line 18 of file hart_sinewave.hpp.

Constructor & Destructor Documentation

◆ SineWave()

template<typename SampleType >

SineWave	(	double	frequencyHz = `(SampleType) 1000`,
		double	phaseRadians = `(SampleType) 0`
	)

inline

Definition at line 22 of file hart_sinewave.hpp.

Member Function Documentation

◆ supportsNumChannels()

template<typename SampleType >

bool supportsNumChannels ( size_t ) const

inlineoverridevirtual

Tells the host whether this Signal is capable of generating audio for a certain amount of cchannels.

It is guaranteed that the signal will not receive unsupported number of channels in renderNextBlock(). This method is guaranteed to be called at least once before prepare()

Note: This method should only care about the Signal itself, and not the attached effects in DSP chain - they'll be queried separately

Parameters

numChannels Number of output channels that will need to be filled

Returns: true if signal is capable of filling this many channels with audio, false otherwise

Reimplemented from Signal< SampleType >.

Definition at line 33 of file hart_sinewave.hpp.

◆ prepare()

template<typename SampleType >

void prepare	(	double	sampleRateHz,
		size_t	numOutputChannels,
		size_t	maxBlockSizeFrames
	)

inlineoverridevirtual

Prepare the signal for rendering.

This method is guaranteed to be called after supportsNumChannels() and supportsSampleRate(), but before renderNextBlock(). It is guaranteed that numChannels obeys supportsNumChannels() preferences, same with sampleRateHz and supportsSampleRate(). It is guaranteed that all subsequent renderNextBlock() calls will be in line with the arguments received in this callback.

Parameters

sampleRateHz	sample rate at which the audio should be generated
numOutputChannels	Number of output channels to be filled
maxBlockSizeFrames	Maximum block size in frames (samples)

Implements Signal< SampleType >.

Definition at line 35 of file hart_sinewave.hpp.

◆ renderNextBlock()

template<typename SampleType >

void renderNextBlock ( AudioBuffer< SampleType > & output )

inlineoverridevirtual

Renders next block audio for the signal.

Depending on circumstances, this callback will either be called once to generate an entire piece of audio from start to finish, or called repeatedly, one block at a time. This method is guaranteed to be called strictly after prepare(), or not called at all. Number of channels and max block size are guaranteed to be in line with the ones set by prepare() callback. Assume sample rate to always be equal to the one received in the last prepare() callback. All audio blocks except the last one are guaranteed to be equal to maxBlockSizeFrames set in prepare() callback.

Warning: Remember that the very last block of audio is almost always smaller than the block size set in prepare(), so be careful with buffer bounds.

Note: Note that this method does not have to be real-time safe, as all rendering always happens offline. Also note that, unlike real-time audio applications, this method is called on the same thread as all others like prepare().

Parameters

output Output audio block

Implements Signal< SampleType >.

Definition at line 40 of file hart_sinewave.hpp.

◆ reset()

template<typename SampleType >

void reset ( )

inlineoverridevirtual

Resets the Signal to initial state.

Ideally should be implemented in a way that audio produced after resetting is identical to audio produced after instantiation

Implements Signal< SampleType >.

Definition at line 56 of file hart_sinewave.hpp.

◆ represent()

template<typename SampleType >

void represent ( std::ostream & stream ) const

inlineoverridevirtual

Makes a text representation of this Signal for test failure outputs.

It is strongly encouraged to follow python's repr() conventions for returned text - basically, put something like "MyClass(value1, value2)" (with no quotes) into the stream whenever possible, or "<Readable info in angled brackets>" otherwise. Also, use built-in stream manipulators like dbPrecision wherever applicable. Use HART_DEFINE_GENERIC_REPRESENT() to get a basic implementation for this method.

Parameters

[out] stream Output stream to write to

Implements Signal< SampleType >.

Definition at line 61 of file hart_sinewave.hpp.

◆ HART_SIGNAL_DEFINE_COPY_AND_MOVE()

template<typename SampleType >

HART_SIGNAL_DEFINE_COPY_AND_MOVE ( SineWave< SampleType > )

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

include/signals/hart_sinewave.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SineWave()

Member Function Documentation

◆ supportsNumChannels()

◆ prepare()

◆ renderNextBlock()

◆ reset()

◆ represent()

◆ HART_SIGNAL_DEFINE_COPY_AND_MOVE()