Checks whether the audio peaks at specific level. More...
#include <hart_peaksat.hpp>
Public Member Functions | |
| PeaksAt (double targetDb, 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 if it 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 Matcher for test failure outputs. | |
 Public Member Functions inherited from Matcher< SampleType, PeaksAt< 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. | |
| PeaksAt< SampleType > & | atChannels (std::initializer_list< size_t > channelsToMatch) |
| Makes this matcher check only specific channels, and ignore the rest. | |
| PeaksAt< SampleType > & | atChannel (size_t channelToMatch) |
| Makes this matcher check only one specific channel, and ignore the rest. | |
| PeaksAt< SampleType > & | atAllChannels () |
| Makes this matcher check all channels. | |
| PeaksAt< SampleType > & | atAllChannelsExcept (std::initializer_list< size_t > channelsToSkip) |
| Makes this matcher check only specific channels, and ignore the rest. | |
| void | representWithActiveChannels (std::ostream &stream) const override |
| Makes a text representation of this Matcher with optional "atChannels" appendix. | |
| Public Member Functions inherited from MatcherBase< SampleType > | |
| virtual | ~MatcherBase ()=default |
Additional Inherited Members | |
| Protected Member Functions inherited from Matcher< SampleType, PeaksAt< SampleType > > | |
| bool | appliesToChannel (size_t channel) |
| Indicates whether this matcher should check a specific channel. | |
| Protected Attributes inherited from Matcher< SampleType, PeaksAt< SampleType > > | |
| ChannelFlags | m_channelsToMatch |
| Related Symbols inherited from Matcher< SampleType, PeaksAt< 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
Checks whether the audio peaks at specific level.
This matcher will calculate peak value of a full audio signal (not a per-block peaks) and compare against a value provided during instantiation with a provided tolerance. It checks where all selected channels peak collectively, not for each individual channel. To do more strict per channel checks, use multiple matchers with atChannel(), so that each matcher only targets one specific channel.
- 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 25 of file hart_peaksat.hpp.
Constructor & Destructor Documentation
◆ PeaksAt()
Creates a matcher for a specific peak level.
- Parameters
-
targetDb Expected sample peak value in decibels toleranceLinear Absolute tolerance for comparing frames, in linear domain (not decibels)
Definition at line 32 of file hart_peaksat.hpp.
Member Function Documentation
◆ prepare()
|
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 MatcherBase< SampleType >.
Definition at line 39 of file hart_peaksat.hpp.
◆ match()
|
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 MatcherBase< SampleType >.
Definition at line 41 of file hart_peaksat.hpp.
◆ canOperatePerBlock()
|
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 76 of file hart_peaksat.hpp.
◆ reset()
|
inlineoverridevirtual |
Resets the matcher to its initial state.
Implements MatcherBase< SampleType >.
Definition at line 81 of file hart_peaksat.hpp.
◆ getFailureDetails()
|
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 83 of file hart_peaksat.hpp.
◆ represent()
|
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 95 of file hart_peaksat.hpp.
The documentation for this class was generated from the following file:
- include/matchers/hart_peaksat.hpp
