Checks whether the audio is identical to some signal. More...

#include <hart_equalsto.hpp>

Inheritance diagram for EqualsTo< SampleType >:

Public Member Functions
	EqualsTo (std::unique_ptr< SignalBase< SampleType > > &&referenceSignal, double toleranceLinear=(SampleType) 1e-5)
	Creates a matcher for a specific signal by transfering smart pointer details The reference signal can be something simple like a SineWave, or more complex signal with DSP effects chain and automation envelopes.

	EqualsTo (const SignalBase< SampleType > &referenceSignal, double toleranceLinear=(SampleType) 1e-5)
	Creates a matcher for a specific signal by copying it details The reference signal can be something simple like a SineWave, or more complex signal with DSP effects chain and automation envelopes.

	EqualsTo (SignalBase< SampleType > &&referenceSignal, double toleranceLinear=(SampleType) 1e-5)
	Creates a matcher for a specific signal by moving it details The reference signal can be something simple like a SineWave, or more complex signal with DSP effects chain and automation envelopes.

	EqualsTo (EqualsTo &&other) noexcept

	EqualsTo (const EqualsTo &other)

EqualsTo &	operator= (const EqualsTo &other)

EqualsTo &	operator= (EqualsTo &&other) noexcept

	~EqualsTo () override=default

void	prepare (double sampleRateHz, size_t, size_t numOutputChannels, size_t maxBlockSizeFrames) override
	Prepare for processing It is guaranteed that all subsequent process() calls will be in line with the arguments received in this callback. This callback is guaranteed to be called after canOperatePerBlock() If any of the values supplied by this callback are not supported by the matcher, it is expected to act as if the match has failed when match() gets called.

bool	match (AnalysisContext< SampleType > context) override
	Tells the host if the piece of audio satisfies Matcher's condition or not.

bool	canOperatePerBlock () const override
	Tells the host if it can operate on a block-by-block basis.

bool	supportsChannelLayout (size_t, size_t numOutputChannels) const override
	Tells the host whether this Matcher is capable of operating on audio with a specific number of channels.

bool	supportsSampleRate (double sampleRateHz) const override
	Tells whether this Matcher supports given sample rate.

void	reset () override
	Resets the matcher to its initial state.

virtual MatcherFailureDetails	getFailureDetails () const override
	Returns a description of why the match has failed.

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

Public Member Functions inherited from Matcher< SampleType, EqualsTo< SampleType > >
virtual std::unique_ptr< MatcherBase< SampleType > >	copy () const override
	Returns a smart pointer with a copy of this object.

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

EqualsTo< SampleType > &	atChannels (std::initializer_list< size_t > channelsToMatch) &
	Makes this matcher check only specific channels, and ignore the rest.

EqualsTo< SampleType > &&	atChannels (std::initializer_list< size_t > channelsToMatch) &&
	Makes this matcher check only specific channels, and ignore the rest.

EqualsTo< SampleType > &	atChannel (size_t channelToMatch) &
	Makes this matcher check only one specific channel, and ignore the rest.

EqualsTo< SampleType > &&	atChannel (size_t channelToMatch) &&
	Makes this matcher check only one specific channel, and ignore the rest.

EqualsTo< SampleType > &	atAllChannels () &
	Makes this matcher check all channels.

EqualsTo< SampleType > &&	atAllChannels () &&
	Makes this matcher check all channels.

EqualsTo< SampleType > &	atAllChannelsExcept (std::initializer_list< size_t > channelsToSkip) &
	Makes this matcher check only specific channels, and ignore the rest.

EqualsTo< SampleType > &&	atAllChannelsExcept (std::initializer_list< size_t > channelsToSkip) &&
	Makes this matcher check only specific channels, and ignore the rest.

Public Member Functions inherited from MatcherBase< SampleType >
virtual	~MatcherBase ()=default

	HART_DEPRECATED ("This method is deprecated. Switch to the one that uses AnalysisContext instead.") virtual bool match(const AudioBuffer< SampleType > &inputAudio
	Tells the host if the piece of audio satisfies Matcher's condition or not.

return	match (analysisContext)

void	prepareWithActiveChannels (double sampleRateHz, size_t numInputChannels, size_t numOutputChannels, size_t maxBlockSizeFrames)
	Prepare for processing, meant to be called by a host.

void	representWithActiveChannels (std::ostream &stream) const
	Makes a text representation of this Matcher with optional "atChannels" appendix.

Additional Inherited Members
Public Attributes inherited from MatcherBase< SampleType >
const AudioBuffer< SampleType > &	observedOutputAudio

Protected Member Functions inherited from MatcherBase< SampleType >
bool	appliesToChannel (size_t channel)
	Indicates whether this matcher should check a specific channel.

ChannelFlags	getChannelFlags () const
	Returns flags for the channels that the matcher should apply to.

Protected Attributes inherited from MatcherBase< SampleType >
ChannelFlags	m_channelsToMatch {true}

Related Symbols inherited from Matcher< SampleType, EqualsTo< SampleType > >
std::ostream &	operator<< (std::ostream &stream, const MatcherBase< SampleType > &matcher)
	Prints readable text representation of the Matcher object into the I/O stream.

Detailed Description

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

Checks whether the audio is identical to some signal.

Holds an internal Signal instance, and gets it to generate reference audio as the matcher receives new audio blocks through match(). Reports mismatch if even one of the frames in the audio does not match the reference signal within tolerance specified in epsilon during its instantiation.

Definition at line 23 of file hart_equalsto.hpp.

Constructor & Destructor Documentation

◆ EqualsTo() [1/5]

template<typename SampleType >

EqualsTo	(	std::unique_ptr< SignalBase< SampleType > > &&	referenceSignal,
		double	toleranceLinear = `(SampleType) 1e-5`
	)

inline

Creates a matcher for a specific signal by transfering smart pointer details The reference signal can be something simple like a SineWave, or more complex signal with DSP effects chain and automation envelopes.

Note: Tip: To compare audio to a pre-recorded wav file, you can use WavFile.

Parameters

referenceSignal	Signal to compare the incoming audio against
toleranceLinear	Absolute tolerance for comparing frames, in linear domain (not decibels)

Definition at line 33 of file hart_equalsto.hpp.

◆ EqualsTo() [2/5]

template<typename SampleType >

EqualsTo	(	const SignalBase< SampleType > &	referenceSignal,
		double	toleranceLinear = `(SampleType) 1e-5`
	)

inline

Creates a matcher for a specific signal by copying it details The reference signal can be something simple like a SineWave, or more complex signal with DSP effects chain and automation envelopes.

Note: Tip: To compare audio to a pre-recorded wav file, you can use WavFile.

Parameters

referenceSignal	Signal to compare the incoming audio against
toleranceLinear	Absolute tolerance for comparing frames, in linear domain (not decibels)

Definition at line 45 of file hart_equalsto.hpp.

◆ EqualsTo() [3/5]

template<typename SampleType >

EqualsTo	(	SignalBase< SampleType > &&	referenceSignal,
		double	toleranceLinear = `(SampleType) 1e-5`
	)

inline

Creates a matcher for a specific signal by moving it details The reference signal can be something simple like a SineWave, or more complex signal with DSP effects chain and automation envelopes.

Note: Tip: To compare audio to a pre-recorded wav file, you can use WavFile.

Parameters

referenceSignal	Signal to compare the incoming audio against
toleranceLinear	Absolute tolerance for comparing frames, in linear domain (not decibels)

Definition at line 56 of file hart_equalsto.hpp.

◆ EqualsTo() [4/5]

template<typename SampleType >

EqualsTo ( EqualsTo< SampleType > && other )

inlinenoexcept

Definition at line 61 of file hart_equalsto.hpp.

◆ EqualsTo() [5/5]

template<typename SampleType >

EqualsTo ( const EqualsTo< SampleType > & other )

inline

Definition at line 68 of file hart_equalsto.hpp.

◆ ~EqualsTo()

template<typename SampleType >

~EqualsTo ( )

overridedefault

Member Function Documentation

◆ operator=() [1/2]

template<typename SampleType >

EqualsTo & operator= ( const EqualsTo< SampleType > & other )

inline

Definition at line 75 of file hart_equalsto.hpp.

◆ operator=() [2/2]

template<typename SampleType >

EqualsTo & operator= ( EqualsTo< SampleType > && other )

inlinenoexcept

Definition at line 88 of file hart_equalsto.hpp.

◆ prepare()

template<typename SampleType >

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

inlineoverridevirtual

Prepare for processing It is guaranteed that all subsequent process() calls will be in line with the arguments received in this callback. This callback is guaranteed to be called after canOperatePerBlock() If any of the values supplied by this callback are not supported by the matcher, it is expected to act as if the match has failed when match() gets called.

Parameters

sampleRateHz	sample rate at which the audio should be interpreted
numInputChannels	Number of channels in the input (reference) audio
numOutputChannels	Number of channels in the output (observed) audio
maxBlockSizeFrames	Maximum block size in frames (samples)

Implements MatcherBase< SampleType >.

Definition at line 105 of file hart_equalsto.hpp.

◆ match()

template<typename SampleType >

bool match ( AnalysisContext< SampleType > analysisContext )

inlineoverridevirtual

Tells the host if the piece of audio satisfies Matcher's condition or not.

It is guaranteed to be called only after prepare(), or not be called at all. It is guaranteed to be handed a pair of AudioBuffers in line with values set by the last prepare() call. If canOperatePerBlock() has returned false, this callback is guaranteed to be handed a full piece of audio to check. Otherwise, it may still get a full piece of audio, or get data on a block-by-block basis.

Parameters

analysisContext Carries everything matcher should know about the input and output audio.

Returns: true if the audio satisfies the Matcher's condition, false otherwise

Reimplemented from MatcherBase< SampleType >.

Definition at line 112 of file hart_equalsto.hpp.

◆ canOperatePerBlock()

template<typename SampleType >

bool canOperatePerBlock ( ) const

inlineoverridevirtual

Tells the host if it can operate on a block-by-block basis.

Some types of conditions absolutely require having a full piece of audio to produce an appropriate response. For example, hart::PeaksAt matcher. Those types of matchers will return false on this callback. Matcher is guaranteed to receive a full piece of audio if this callback has returned false. Otherwise, it may receive audio either block-by-block basis, or still get a full piece of audio, if the host decides to do so.

Implements MatcherBase< SampleType >.

Definition at line 179 of file hart_equalsto.hpp.

◆ supportsChannelLayout()

template<typename SampleType >

bool supportsChannelLayout	(	size_t	,
		size_t
	)		const

inlineoverridevirtual

Tells the host whether this Matcher is capable of operating on audio with a specific number of channels.

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

Parameters

numInputChannels	Number of channels in input (reference) buffer that will need to be processed
numOutputChannels	Number of channels in output (observed) buffer that will need to be processed

Returns: true if signal is capable of processing audio with requested number of channels, false otherwise

Reimplemented from MatcherBase< SampleType >.

Definition at line 184 of file hart_equalsto.hpp.

◆ supportsSampleRate()

template<typename SampleType >

bool supportsSampleRate ( double ) const

inlineoverridevirtual

Tells whether this Matcher supports given sample rate.

It is guaranteed to be called before prepare()

Parameters

sampleRateHz sample rate at which the audio will be presented

Returns: true if matcher is capable of processing audio with a given sample rate, false otherwise

Reimplemented from MatcherBase< SampleType >.

Definition at line 189 of file hart_equalsto.hpp.

◆ reset()

template<typename SampleType >

void reset ( )

inlineoverridevirtual

Resets the matcher to its initial state.

Reimplemented from MatcherBase< SampleType >.

Definition at line 194 of file hart_equalsto.hpp.

◆ getFailureDetails()

template<typename SampleType >

virtual MatcherFailureDetails getFailureDetails ( ) const

inlineoverridevirtual

Returns a description of why the match has failed.

It is guaranteed to be called strictly after calling match(), or not called at all

Note: This method is a callback for the test host, so you probably don't need to call it yourself ever. If you're making a custom matcher, use it to communicate the data with test host.

Return values

MatcherFailureDetails::frame	Index of frame at which the match has failed
MatcherFailureDetails::channel	Index of channel at which the failure was detected
MatcherFailureDetails::description	Readable description of why the match has failed. Do not include the value of observed frame value or its timing in the description, as well as any of values printed by represent(), as all of this will be added to the output anyway. Also, query hart::CLIConfig for number of displayed decimal places, whenever applicable.

See also: MatcherFailureDetails

Implements MatcherBase< SampleType >.

Definition at line 199 of file hart_equalsto.hpp.

◆ represent()

template<typename SampleType >

void represent ( std::ostream & stream ) const

inlineoverridevirtual

Makes a text representation of this Matcher 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 hart::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 MatcherBase< SampleType >.

Definition at line 215 of file hart_equalsto.hpp.

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

include/matchers/hart_equalsto.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EqualsTo() [1/5]

◆ EqualsTo() [2/5]

◆ EqualsTo() [3/5]

◆ EqualsTo() [4/5]

◆ EqualsTo() [5/5]

◆ ~EqualsTo()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ prepare()

◆ match()

◆ canOperatePerBlock()

◆ supportsChannelLayout()

◆ supportsSampleRate()

◆ reset()

◆ getFailureDetails()

◆ represent()