sfFDN
Loading...
Searching...
No Matches
sfFDN::FilterBank Class Reference

Implements a bank of filters. More...

#include <filterbank.h>

Inheritance diagram for sfFDN::FilterBank:
[legend]
Collaboration diagram for sfFDN::FilterBank:
[legend]

Public Member Functions

 FilterBank ()
 Constructs an empty filter bank.
 
void Clear () override
 Clears the filter bank.
 
void AddFilter (std::unique_ptr< AudioProcessor > filter)
 Adds a filter to the filter bank.
 
void Process (const AudioBuffer &input, AudioBuffer &output) noexcept override
 Processes a block of input samples through the filter bank.
 
uint32_t InputChannelCount () const override
 Returns the number of input channels supported by this processor.
 
uint32_t OutputChannelCount () const override
 Returns the number of output channels produced by this processor.
 
std::unique_ptr< AudioProcessorClone () const override
 Creates a copy of the filter bank.
 
- Public Member Functions inherited from sfFDN::AudioProcessor

Detailed Description

Implements a bank of filters.

Member Function Documentation

◆ AddFilter()

void sfFDN::FilterBank::AddFilter ( std::unique_ptr< AudioProcessor > filter)

Adds a filter to the filter bank.

Parameters
filterA unique pointer to the filter to add. The FilterBank takes ownership of the filter.

◆ Clear()

void sfFDN::FilterBank::Clear ( )
overridevirtual

Clears the filter bank.

Implements sfFDN::AudioProcessor.

◆ Clone()

std::unique_ptr< AudioProcessor > sfFDN::FilterBank::Clone ( ) const
overridevirtual

Creates a copy of the filter bank.

Returns
A unique pointer to the cloned filter bank.

Implements sfFDN::AudioProcessor.

◆ InputChannelCount()

uint32_t sfFDN::FilterBank::InputChannelCount ( ) const
overridevirtual

Returns the number of input channels supported by this processor.

This is equal to the number of filters in the filter bank.

Returns
The number of input channels.

Implements sfFDN::AudioProcessor.

◆ OutputChannelCount()

uint32_t sfFDN::FilterBank::OutputChannelCount ( ) const
overridevirtual

Returns the number of output channels produced by this processor.

This is equal to the number of filters in the filter bank.

Returns
The number of output channels.

Implements sfFDN::AudioProcessor.

◆ Process()

void sfFDN::FilterBank::Process ( const AudioBuffer & input,
AudioBuffer & output )
overridevirtualnoexcept

Processes a block of input samples through the filter bank.

Parameters
inputThe input audio buffer.
outputThe output audio buffer. The input and output buffers must have the same number of channels and sample count. The number of channels must be equal to the number of filters in the filter bank.

Implements sfFDN::AudioProcessor.


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