A DSP host used for building and running tests inside a test case. More...

#include <hart_process_audio.hpp>

Public Member Functions
template<typename DSPType >
	AudioTestBuilder (DSPType &&dsp, typename std::enable_if< std::is_lvalue_reference< DSPType && >::value &&std::is_base_of< DSP< SampleType >, typename std::decay< DSPType >::type >::value >::type *=0)
	Copies the DSP instance into the host.

template<typename DSPType >
	AudioTestBuilder (DSPType &&dsp, typename std::enable_if< ! std::is_lvalue_reference< DSPType && >::value &&std::is_base_of< DSP< SampleType >, typename std::decay< DSPType >::type >::value >::type *=0)
	Moves the DSP instance into the host.

	AudioTestBuilder (std::unique_ptr< DSP< SampleType > > dsp)
	Transfers the DSP smart pointer into the host.

AudioTestBuilder &	withSampleRate (double sampleRateHz)
	Sets the sample rate for the test.

AudioTestBuilder &	withBlockSize (size_t blockSizeFrames)
	Sets the block size for the test.

AudioTestBuilder &	withValue (int id, double value)
	Sets the initial param value for the tested DSP.

AudioTestBuilder &	withDuration (double durationSeconds)
	Sets the total duration of the input signal to be processed.

AudioTestBuilder &	withInputSignal (const Signal< SampleType > &signal)
	Sets the input signal for the test.

AudioTestBuilder &	withInputChannels (size_t numInputChannels)
	Sets arbitrary number of input channels.

AudioTestBuilder &	withOutputChannels (size_t numOutputChannels)
	Sets arbitrary number of output channels.

AudioTestBuilder &	withStereoInput ()
	Sets number of input channels to two.

AudioTestBuilder &	withStereoOutput ()
	Sets number of output channels to two.

AudioTestBuilder &	withMonoInput ()
	Sets number of input channels to one.

AudioTestBuilder &	withMonoOutput ()
	Sets number of output channels to one.

AudioTestBuilder &	inMono ()
	Sets number of input and output channels to one.

AudioTestBuilder &	inStereo ()
	Sets number of input and output channels to two.

AudioTestBuilder &	expectTrue (const Matcher< SampleType > &matcher)
	Adds an "expect" check.

template<typename MatcherType >
AudioTestBuilder &	expectTrue (MatcherType &&matcher)
	Adds an "expect" check.

AudioTestBuilder &	expectFalse (const Matcher< SampleType > &matcher)
	Adds a reversed "expect" check.

template<typename MatcherType >
AudioTestBuilder &	expectFalse (MatcherType &&matcher)
	Adds a reversed "expect" check.

AudioTestBuilder &	assertTrue (const Matcher< SampleType > &matcher)
	Adds an "assert" check.

template<typename MatcherType >
AudioTestBuilder &	assertTrue (MatcherType &&matcher)
	Adds an "assert" check.

AudioTestBuilder &	assertFalse (const Matcher< SampleType > &matcher)
	Adds a reversed "assert" check.

template<typename MatcherType >
AudioTestBuilder &	assertFalse (MatcherType &&matcher)
	Adds a reversed "assert" check.

AudioTestBuilder &	saveOutputTo (const std::string &path, Save mode=Save::always, WavFormat wavFormat=WavFormat::pcm24)
	Enables saving output audio to a wav file.

AudioTestBuilder &	savePlotTo (const std::string &path, Save mode=Save::always)
	Enables saving a plot to an SVG file.

AudioTestBuilder &	withLabel (const std::string &testLabel)
	Adds a label to the test.

std::unique_ptr< DSP< SampleType > >	process ()
	Perfoems the test.

Related Symbols
(Note that these are not member symbols.)
template<typename DSPType >
AudioTestBuilder< typename std::decay< DSPType >::type::SampleTypePublicAlias >	processAudioWith (DSPType &&dsp)
	Call this to start building your test.

template<typename DSPType >
AudioTestBuilder< typename DSPType::SampleTypePublicAlias >	processAudioWith (std::unique_ptr< DSPType > &&dsp)
	Call this to start building your test.

Detailed Description

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

A DSP host used for building and running tests inside a test case.

Definition at line 38 of file hart_process_audio.hpp.

Constructor & Destructor Documentation

◆ AudioTestBuilder() [1/3]

template<typename SampleType >

template<typename DSPType >

AudioTestBuilder	(	DSPType &&	dsp,
		typename std::enable_if< std::is_lvalue_reference< DSPType && >::value &&std::is_base_of< DSP< SampleType >, typename std::decay< DSPType >::type >::value >::type *	= `0`
	)

inline

Copies the DSP instance into the host.

DSP instance will be moved into this host, and then returned by process(), so you can re-use it.

Parameters

dsp	Your DSP instance.

Definition at line 45 of file hart_process_audio.hpp.

◆ AudioTestBuilder() [2/3]

template<typename SampleType >

template<typename DSPType >

AudioTestBuilder	(	DSPType &&	dsp,
		typename std::enable_if< ! std::is_lvalue_reference< DSPType && >::value &&std::is_base_of< DSP< SampleType >, typename std::decay< DSPType >::type >::value >::type *	= `0`
	)

inline

Moves the DSP instance into the host.

DSP instance will be moved into this host, and then returned by process(), so you can re-use it.

Parameters

dsp	Your DSP instance

Definition at line 58 of file hart_process_audio.hpp.

◆ AudioTestBuilder() [3/3]

template<typename SampleType >

AudioTestBuilder ( std::unique_ptr< DSP< SampleType > > dsp )

inline

Transfers the DSP smart pointer into the host.

Use this if your DSP does not support copying or moving. It will be owned by this host, and then returned by process(), so you can re-use it.

Parameters

dsp	A smart pointer to your DSP instance

Definition at line 71 of file hart_process_audio.hpp.

Member Function Documentation

◆ withSampleRate()

template<typename SampleType >

AudioTestBuilder & withSampleRate ( double sampleRateHz )

inline

Sets the sample rate for the test.

All the signals, effects and sub hosts are guaranteed to be initialized to this sample rate

Parameters

sampleRateHz Sample rate in Hz. You can use frequency-related literails from Units.

Definition at line 79 of file hart_process_audio.hpp.

◆ withBlockSize()

template<typename SampleType >

AudioTestBuilder & withBlockSize ( size_t blockSizeFrames )

inline

Sets the block size for the test.

Parameters

blockSizeFrames Block size in frames (samples)

Definition at line 93 of file hart_process_audio.hpp.

◆ withValue()

template<typename SampleType >

AudioTestBuilder & withValue	(	int	id,
		double	value
	)

inline

Sets the initial param value for the tested DSP.

It will call DSP::setValue() for DSP under test

Parameters

id	Parameter ID (see DSP::setValue())
value	Value that needs to be set

Definition at line 106 of file hart_process_audio.hpp.

◆ withDuration()

template<typename SampleType >

AudioTestBuilder & withDuration ( double durationSeconds )

inline

Sets the total duration of the input signal to be processed.

Parameters

Duration of the signal in seconds. You can use time-related literails from Units.

Definition at line 115 of file hart_process_audio.hpp.

◆ withInputSignal()

template<typename SampleType >

AudioTestBuilder & withInputSignal ( const Signal< SampleType > & signal )

inline

Sets the input signal for the test.

Parameters

signal Input signal, see Signals

Definition at line 126 of file hart_process_audio.hpp.

◆ withInputChannels()

template<typename SampleType >

AudioTestBuilder & withInputChannels ( size_t numInputChannels )

inline

Sets arbitrary number of input channels.

For common mono and stereo cases, you may use dedicated methods like inStereo() or withMonoInput() instead of this one for better readability.

Parameters

numInputChannels Number of input channels

Definition at line 137 of file hart_process_audio.hpp.

◆ withOutputChannels()

template<typename SampleType >

AudioTestBuilder & withOutputChannels ( size_t numOutputChannels )

inline

Sets arbitrary number of output channels.

For common mono and stereo cases, you may use dedicated methods like inMono() or withStereoOutput() instead of this one for better readability.

Parameters

numOutputChannels Number of output channels

Definition at line 153 of file hart_process_audio.hpp.

◆ withStereoInput()

template<typename SampleType >

AudioTestBuilder & withStereoInput ( )

inline

Sets number of input channels to two.

Definition at line 166 of file hart_process_audio.hpp.

◆ withStereoOutput()

template<typename SampleType >

AudioTestBuilder & withStereoOutput ( )

inline

Sets number of output channels to two.

Definition at line 172 of file hart_process_audio.hpp.

◆ withMonoInput()

template<typename SampleType >

AudioTestBuilder & withMonoInput ( )

inline

Sets number of input channels to one.

Definition at line 178 of file hart_process_audio.hpp.

◆ withMonoOutput()

template<typename SampleType >

AudioTestBuilder & withMonoOutput ( )

inline

Sets number of output channels to one.

Definition at line 184 of file hart_process_audio.hpp.

◆ inMono()

template<typename SampleType >

AudioTestBuilder & inMono ( )

inline

Sets number of input and output channels to one.

Definition at line 190 of file hart_process_audio.hpp.

◆ inStereo()

template<typename SampleType >

AudioTestBuilder & inStereo ( )

inline

Sets number of input and output channels to two.

Definition at line 196 of file hart_process_audio.hpp.

◆ expectTrue() [1/2]

template<typename SampleType >

AudioTestBuilder & expectTrue ( const Matcher< SampleType > & matcher )

inline

Adds an "expect" check.

Parameters

matcher Matcher to perform the check, see Matchers

Definition at line 203 of file hart_process_audio.hpp.

◆ expectTrue() [2/2]

template<typename SampleType >

template<typename MatcherType >

AudioTestBuilder & expectTrue ( MatcherType && matcher )

inline

Adds an "expect" check.

Parameters

matcher Matcher to perform the check, see Matchers

Definition at line 212 of file hart_process_audio.hpp.

◆ expectFalse() [1/2]

template<typename SampleType >

AudioTestBuilder & expectFalse ( const Matcher< SampleType > & matcher )

inline

Adds a reversed "expect" check.

Parameters

matcher Matcher to perform the check, see Matchers

Definition at line 226 of file hart_process_audio.hpp.

◆ expectFalse() [2/2]

template<typename SampleType >

template<typename MatcherType >

AudioTestBuilder & expectFalse ( MatcherType && matcher )

inline

Adds a reversed "expect" check.

Parameters

matcher Matcher to perform the check, see Matchers

Definition at line 235 of file hart_process_audio.hpp.

◆ assertTrue() [1/2]

template<typename SampleType >

AudioTestBuilder & assertTrue ( const Matcher< SampleType > & matcher )

inline

Adds an "assert" check.

Parameters

matcher Matcher to perform the check, see Matchers

Definition at line 248 of file hart_process_audio.hpp.

◆ assertTrue() [2/2]

template<typename SampleType >

template<typename MatcherType >

AudioTestBuilder & assertTrue ( MatcherType && matcher )

inline

Adds an "assert" check.

Parameters

matcher Matcher to perform the check, see Matchers

Definition at line 257 of file hart_process_audio.hpp.

◆ assertFalse() [1/2]

template<typename SampleType >

AudioTestBuilder & assertFalse ( const Matcher< SampleType > & matcher )

inline

Adds a reversed "assert" check.

Parameters

matcher Matcher to perform the check, see Matchers

Definition at line 270 of file hart_process_audio.hpp.

◆ assertFalse() [2/2]

template<typename SampleType >

template<typename MatcherType >

AudioTestBuilder & assertFalse ( MatcherType && matcher )

inline

Adds a reversed "assert" check.

Parameters

matcher Matcher to perform the check, see Matchers

Definition at line 279 of file hart_process_audio.hpp.

◆ saveOutputTo()

template<typename SampleType >

AudioTestBuilder & saveOutputTo	(	const std::string &	path,
		Save	mode = `Save::always`,
		WavFormat	wavFormat = `WavFormat::pcm24`
	)

inline

Enables saving output audio to a wav file.

Parameters

path	File path - relative or absolute. If relative path is set, it will be appended to the provided `--data-root-path` CLI argument.
mode	When to save, see hart::Save
wavFormat	Format of the wav file, see hart::WavFormat for supported options

See also: HART_REQUIRES_DATA_PATH_ARG

Definition at line 295 of file hart_process_audio.hpp.

◆ savePlotTo()

template<typename SampleType >

AudioTestBuilder & savePlotTo	(	const std::string &	path,
		Save	mode = `Save::always`
	)

inline

Enables saving a plot to an SVG file.

This will plot an input and output audio as a waveform

Parameters

path	File path - relative or absolute. If relative path is set, it will be appended to the provided `--data-root-path` CLI argument.
mode	When to save, see hart::Save

See also: HART_REQUIRES_DATA_PATH_ARG

Definition at line 311 of file hart_process_audio.hpp.

◆ withLabel()

template<typename SampleType >

AudioTestBuilder & withLabel ( const std::string & testLabel )

inline

Adds a label to the test.

Useful when you call process() multiple times in one test case - the label will be put into test failure report to indicate exactly which test has failed.

Parameters

testLabel Any text, to be used as a label

Definition at line 325 of file hart_process_audio.hpp.

◆ process()

template<typename SampleType >

std::unique_ptr< DSP< SampleType > > process ( )

inline

Perfoems the test.

Call this after setting all the test parameters

Definition at line 333 of file hart_process_audio.hpp.

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

include/hart_process_audio.hpp

Public Member Functions

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ AudioTestBuilder() [1/3]

◆ AudioTestBuilder() [2/3]

◆ AudioTestBuilder() [3/3]

Member Function Documentation

◆ withSampleRate()

◆ withBlockSize()

◆ withValue()

◆ withDuration()

◆ withInputSignal()

◆ withInputChannels()

◆ withOutputChannels()

◆ withStereoInput()

◆ withStereoOutput()

◆ withMonoInput()

◆ withMonoOutput()

◆ inMono()

◆ inStereo()

◆ expectTrue() [1/2]

◆ expectTrue() [2/2]

◆ expectFalse() [1/2]

◆ expectFalse() [2/2]

◆ assertTrue() [1/2]

◆ assertTrue() [2/2]

◆ assertFalse() [1/2]

◆ assertFalse() [2/2]

◆ saveOutputTo()

◆ savePlotTo()

◆ withLabel()

◆ process()