sfFDN::AudioProcessor Class Reference

Base class for audio processors. More...

#include <audio_processor.h>

Inheritance diagram for sfFDN::AudioProcessor:

Public Member Functions
virtual void	Process (const AudioBuffer &input, AudioBuffer &output) noexcept SFFDN_NONBLOCKING=0
	Process audio buffers.
virtual uint32_t	InputChannelCount () const noexcept SFFDN_NONBLOCKING=0
	Returns the number of input channels this processor expects.
virtual uint32_t	OutputChannelCount () const noexcept SFFDN_NONBLOCKING=0
	Returns the number of output channels this processor produces.
virtual void	Clear ()=0
	Clears the internal state of the processor.
virtual std::unique_ptr< AudioProcessor >	Clone () const =0
	Creates a copy of the audio processor.

Protected Member Functions
	AudioProcessor (const AudioProcessor &)=default
AudioProcessor &	operator= (const AudioProcessor &)=default
	AudioProcessor (AudioProcessor &&) noexcept=default
AudioProcessor &	operator= (AudioProcessor &&) noexcept=default

Detailed Description

Base class for audio processors.

An AudioProcessor processes audio samples and outputs the result, e.g., applying effects or transformations.

Member Function Documentation

Clear()

virtual void sfFDN::AudioProcessor::Clear ( )

pure virtual

Clears the internal state of the processor.

This function should reset any internal buffers or states used by the processor without changing its configuration. For example, calling Clear() on an IIR filter should set its internal state to 0 while keeping its coefficients intact.

Implemented in sfFDN::AllpassFilter, sfFDN::AudioProcessorChain, sfFDN::CascadedBiquads, sfFDN::ControllableFullWaveRectifier, sfFDN::DattorroDelay, sfFDN::DelayBank, sfFDN::DelayBankTimeVarying, sfFDN::DelayInterp, sfFDN::DelayMatrix, sfFDN::DelayTimeVarying, sfFDN::FDN, sfFDN::FilterBank, sfFDN::FilterFeedbackMatrix, sfFDN::Fir, sfFDN::IIRFilterBank, sfFDN::OnePoleFilter, sfFDN::ParallelGains, sfFDN::PartitionedConvolver, sfFDN::RingModulator, sfFDN::ScalarFeedbackMatrix, sfFDN::SchroederAllpassSection, sfFDN::SignalDependentFractionalDelay, sfFDN::SparseFir, sfFDN::TimeVaryingFeedbackMatrix, sfFDN::TimeVaryingParallelGains, and sfFDN::TimeVaryingSchroederAllpassSection.

Clone()

virtual std::unique_ptr< AudioProcessor > sfFDN::AudioProcessor::Clone ( ) const

pure virtual

Creates a copy of the audio processor.

Returns

A unique pointer to the cloned audio processor.

Implemented in sfFDN::AllpassFilter, sfFDN::AudioProcessorChain, sfFDN::CascadedBiquads, sfFDN::ControllableFullWaveRectifier, sfFDN::DattorroDelay, sfFDN::DelayBank, sfFDN::DelayBankTimeVarying, sfFDN::DelayInterp, sfFDN::DelayMatrix, sfFDN::DelayTimeVarying, sfFDN::FDN, sfFDN::FilterBank, sfFDN::FilterFeedbackMatrix, sfFDN::Fir, sfFDN::IIRFilterBank, sfFDN::OnePoleFilter, sfFDN::ParallelGains, sfFDN::PartitionedConvolver, sfFDN::RingModulator, sfFDN::ScalarFeedbackMatrix, sfFDN::SchroederAllpassSection, sfFDN::SignalDependentFractionalDelay, sfFDN::SparseFir, sfFDN::TimeVaryingFeedbackMatrix, sfFDN::TimeVaryingParallelGains, and sfFDN::TimeVaryingSchroederAllpassSection.

InputChannelCount()

virtual uint32_t sfFDN::AudioProcessor::InputChannelCount ( ) const

pure virtualnoexcept

Returns the number of input channels this processor expects.

Implemented in sfFDN::AllpassFilter, sfFDN::AudioProcessorChain, sfFDN::CascadedBiquads, sfFDN::ControllableFullWaveRectifier, sfFDN::DattorroDelay, sfFDN::DelayBank, sfFDN::DelayBankTimeVarying, sfFDN::DelayInterp, sfFDN::DelayMatrix, sfFDN::DelayTimeVarying, sfFDN::FDN, sfFDN::FilterBank, sfFDN::FilterFeedbackMatrix, sfFDN::Fir, sfFDN::IIRFilterBank, sfFDN::OnePoleFilter, sfFDN::ParallelGains, sfFDN::PartitionedConvolver, sfFDN::RingModulator, sfFDN::ScalarFeedbackMatrix, sfFDN::SchroederAllpassSection, sfFDN::SignalDependentFractionalDelay, sfFDN::SparseFir, sfFDN::TimeVaryingFeedbackMatrix, sfFDN::TimeVaryingParallelGains, and sfFDN::TimeVaryingSchroederAllpassSection.

OutputChannelCount()

virtual uint32_t sfFDN::AudioProcessor::OutputChannelCount ( ) const

pure virtualnoexcept

Returns the number of output channels this processor produces.

Implemented in sfFDN::AllpassFilter, sfFDN::AudioProcessorChain, sfFDN::CascadedBiquads, sfFDN::ControllableFullWaveRectifier, sfFDN::DattorroDelay, sfFDN::DelayBank, sfFDN::DelayBankTimeVarying, sfFDN::DelayInterp, sfFDN::DelayMatrix, sfFDN::DelayTimeVarying, sfFDN::FDN, sfFDN::FilterBank, sfFDN::FilterFeedbackMatrix, sfFDN::Fir, sfFDN::IIRFilterBank, sfFDN::OnePoleFilter, sfFDN::ParallelGains, sfFDN::PartitionedConvolver, sfFDN::RingModulator, sfFDN::ScalarFeedbackMatrix, sfFDN::SchroederAllpassSection, sfFDN::SignalDependentFractionalDelay, sfFDN::SparseFir, sfFDN::TimeVaryingFeedbackMatrix, sfFDN::TimeVaryingParallelGains, and sfFDN::TimeVaryingSchroederAllpassSection.

Process()

virtual void sfFDN::AudioProcessor::Process ( const AudioBuffer & input, AudioBuffer & output )

pure virtualnoexcept

Process audio buffers.

Parameters

input	The input audio buffer.
output	The output audio buffer.

Implemented in sfFDN::AllpassFilter, sfFDN::AudioProcessorChain, sfFDN::CascadedBiquads, sfFDN::ControllableFullWaveRectifier, sfFDN::DattorroDelay, sfFDN::DelayBank, sfFDN::DelayBankTimeVarying, sfFDN::DelayInterp, sfFDN::DelayMatrix, sfFDN::DelayTimeVarying, sfFDN::FDN, sfFDN::FilterBank, sfFDN::FilterFeedbackMatrix, sfFDN::Fir, sfFDN::IIRFilterBank, sfFDN::OnePoleFilter, sfFDN::ParallelGains, sfFDN::PartitionedConvolver, sfFDN::RingModulator, sfFDN::ScalarFeedbackMatrix, sfFDN::SchroederAllpassSection, sfFDN::SignalDependentFractionalDelay, sfFDN::SparseFir, sfFDN::TimeVaryingFeedbackMatrix, sfFDN::TimeVaryingParallelGains, and sfFDN::TimeVaryingSchroederAllpassSection.

---

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

• include/sffdn/audio_processor.h