Checks whether the audio peaks below specific level. More...

#include <hart_peaksbelow.hpp>

Inheritance diagram for PeaksBelow< SampleType >:

Public Member Functions
	PeaksBelow (double thresholdDb, double toleranceLinear=1e-3)
	Creates a matcher for a specific peak level.

void	prepare (double, size_t, size_t) 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 (const AudioBuffer< SampleType > &observedAudio) override
	Tells the host if the piece of audio satisfies Matcher's condition or not.

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

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 Macther for test failure outputs.

	HART_MATCHER_DEFINE_COPY_AND_MOVE (PeaksBelow)

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

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

virtual	~Matcher ()=default
	Destructor.

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

Detailed Description

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

Checks whether the audio peaks below specific level.

Note: Tip: To check if the audio peaks above some level, just flip your assertion, e.g.
expectFalse (PeaksBelow (-3_Db))

hart::AudioBuffer
Definition hart_audio_buffer.hpp:12

hart::PeaksBelow
Checks whether the audio peaks below specific level.
Definition hart_peaksbelow.hpp:23

or
assertFalse (PeaksBelow (-3_Db))

Attention: It checks the sample peaks, not the inter-sample peaks (a popular metric in audio mastering community). Fon inter-sample peak checking, you can make your own custom Matcher..

Definition at line 21 of file hart_peaksbelow.hpp.

Constructor & Destructor Documentation

◆ PeaksBelow()

template<typename SampleType >

PeaksBelow	(	double	thresholdDb,
		double	toleranceLinear = `1e-3`
	)

inline

Creates a matcher for a specific peak level.

Parameters

thresholdDb	Expected sample peak threshold in decibels
toleranceLinear	Absolute tolerance for comparing frames, in linear domain (not decibels)

Definition at line 28 of file hart_peaksbelow.hpp.

Member Function Documentation

◆ prepare()

template<typename SampleType >

void prepare	(	double	sampleRateHz,
		size_t	numChannels,
		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
numChannels	Number of audio channels
maxBlockSizeFrames	Maximum block size in frames (samples)

Implements Matcher< SampleType >.

Definition at line 34 of file hart_peaksbelow.hpp.

◆ match()

template<typename SampleType >

bool match ( const AudioBuffer< SampleType > & observedAudio )

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 an AudioBuffer 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

observedAudio A piece of audio to check

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

Implements Matcher< SampleType >.

Definition at line 36 of file hart_peaksbelow.hpp.

◆ canOperatePerBlock()

template<typename SampleType >

bool canOperatePerBlock ( )

inlineoverridevirtual

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

Some types of conditions absolutely require having a full piece of audio to produce an appropriate responce. For example, 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 Matcher< SampleType >.

Definition at line 57 of file hart_peaksbelow.hpp.

◆ reset()

template<typename SampleType >

void reset ( )

inlineoverridevirtual

Resets the matcher to its initial state.

Implements Matcher< SampleType >.

Definition at line 62 of file hart_peaksbelow.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 CLIConfig for number of displayed decimal places, whenever applicable.

See also: MatcherFailureDetails

Implements Matcher< SampleType >.

Definition at line 64 of file hart_peaksbelow.hpp.

◆ represent()

template<typename SampleType >

void represent ( std::ostream & stream ) const

inlineoverridevirtual

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

Definition at line 77 of file hart_peaksbelow.hpp.

◆ HART_MATCHER_DEFINE_COPY_AND_MOVE()

template<typename SampleType >

HART_MATCHER_DEFINE_COPY_AND_MOVE ( PeaksBelow< SampleType > )

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

include/matchers/hart_peaksbelow.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PeaksBelow()

Member Function Documentation

◆ prepare()

◆ match()

◆ canOperatePerBlock()

◆ reset()

◆ getFailureDetails()

◆ represent()

◆ HART_MATCHER_DEFINE_COPY_AND_MOVE()