Produces a sine sweep. More...

#include <hart_sine_sweep.hpp>

Inheritance diagram for SineSweep< SampleType >:

Public Types
enum class	Loop { no , yes }
	Determines what to do after frequency sweep is done. More...

enum class	SweepType { linear , log }
	Determines how to change the frequency. More...

Public Member Functions
	SineSweep (double durationSeconds=1.0, double startFrequencyHz=20.0, double endFrequencyHz=20.0e3, SweepType type=SweepType::log, Loop loop=Loop::no, double initialPhaseRadians=0.0)
	Creates a sine sweep signal.

SineSweep	withDuration (double durationSeconds)
	Returns a new SineSweep instance with specified duration.

SineSweep	withStartFrequency (double startFrequencyHz)
	Returns a new SineSweep instance with specified start frequency.

SineSweep	withEndFrequency (double endFrequencyHz)
	Returns a new SineSweep instance with specified end frequency.

SineSweep	withType (SweepType type)
	Returns a new SineSweep instance with specified sweep type.

SineSweep	withLoop (Loop loop)
	Returns a new SineSweep instance with specified loop preference.

SineSweep	withPhase (double initialPhaseRadians)
	Returns a new SineSweep instance with specified initial phase.

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 (SineSweep)

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::SineSweep< SampleType >

Produces a sine sweep.

Outputs a signal at unity gain (-1.0..+1.0), linear or log sweep, up or down. Tip: If you want to get an low-high-low or a high-low-high sweep, set loop to Loop::yes, and duration of host's signal (see AudioTestBuilder::withDuration()) to 2x durationSeconds of this signal.

Definition at line 19 of file hart_sine_sweep.hpp.

Enumerator
no	Stop after finishing one sweep.
yes	Keep on sweeping back and forth.

Enumerator
linear	Linear sweep, for a white noise-like spectrum.
log	Logarithmic sweep, for a pink noise-like spectrum.

durationSeconds	Duration of sine sweep
startFrequencyHz	Start frequency of the sine sweep
endFrequencyHz	End frequency of the sine sweep
type	Linear or Log frequency sweep, see SweepType
loop	If Loop::no is selected, the Signal will produce silence after duration; if Loop::yes is selected, the signal will keep on going back and forth between start and end frequencies (up and down) indefinitely.
initialPhaseRadians	Initial phase of the signal

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)

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Loop

◆ SweepType

Constructor & Destructor Documentation

◆ SineSweep()

Member Function Documentation

◆ withDuration()

◆ withStartFrequency()

◆ withEndFrequency()

◆ withType()

◆ withLoop()

◆ withPhase()

◆ supportsNumChannels()

◆ prepare()

◆ renderNextBlock()

◆ reset()

◆ represent()

◆ HART_SIGNAL_DEFINE_COPY_AND_MOVE()