HephAudio v3.1.0
A cross-platform C++ library for recording, playing, and processing audio on Windows, Android, Linux, iOS, and macOS.
Loading...
Searching...
No Matches
HephAudio::FrequencyDomainEffect Class Reference

base class for effects that are computed in the frequency domain. More...

#include <FrequencyDomainEffect.h>

Inheritance diagram for HephAudio::FrequencyDomainEffect:
HephAudio::OlaEffect HephAudio::DoubleBufferedAudioEffect HephAudio::AudioEffect HephAudio::Equalizer HephAudio::Spatializer HephAudio::BandCutFilter HephAudio::BandPassFilter HephAudio::HighPassFilter HephAudio::LowPassFilter

Public Member Functions

virtual ~FrequencyDomainEffect ()=default
 
virtual void SetWindow (const Window &wnd) override
 
- Public Member Functions inherited from HephAudio::OlaEffect
virtual ~OlaEffect ()=default
 
virtual size_t CalculateRequiredFrameCount (size_t outputFrameCount, const AudioFormatInfo &formatInfo) const
 
virtual void ResetInternalState () override
 
virtual void Process (AudioBuffer &buffer, size_t startIndex, size_t frameCount) override
 
virtual size_t GetHopSize () const
 
virtual void SetHopSize (size_t hopSize)
 
virtual size_t GetWindowSize () const
 
virtual void Process (AudioBuffer &buffer)
 
virtual void Process (AudioBuffer &buffer, size_t startIndex)
 
- Public Member Functions inherited from HephAudio::DoubleBufferedAudioEffect
virtual ~DoubleBufferedAudioEffect ()=default
 
- Public Member Functions inherited from HephAudio::AudioEffect
virtual ~AudioEffect ()=default
 
virtual std::string Name () const =0
 
virtual bool HasMTSupport () const
 
virtual bool HasRTSupport () const
 
virtual size_t GetThreadCount () const
 
virtual void SetThreadCount (size_t threadCount)
 
virtual size_t CalculateOutputFrameCount (size_t inputFrameCount, const AudioFormatInfo &formatInfo) const
 
virtual size_t CalculateAdvanceSize (size_t renderFrameCount, const AudioFormatInfo &formatInfo) const
 

Protected Member Functions

 FrequencyDomainEffect ()
 
 FrequencyDomainEffect (size_t hopSize)
 
 FrequencyDomainEffect (size_t hopSize, const Window &wnd)
 
- Protected Member Functions inherited from HephAudio::OlaEffect
 OlaEffect ()
 
 OlaEffect (size_t hopSize)
 
 OlaEffect (size_t hopSize, const Window &wnd)
 
virtual size_t CalculateMaxNumberOfOverlaps () const
 
virtual size_t CalculatePastSamplesSize () const
 
- Protected Member Functions inherited from HephAudio::DoubleBufferedAudioEffect
 DoubleBufferedAudioEffect ()
 
virtual AudioBuffer CreateOutputBuffer (const AudioBuffer &inputBuffer, size_t startIndex, size_t frameCount) const
 
virtual void InitializeOutputBuffer (const AudioBuffer &inputBuffer, AudioBuffer &outputBuffer, size_t startIndex, size_t frameCount) const
 
- Protected Member Functions inherited from HephAudio::AudioEffect
 AudioEffect ()
 
virtual void ProcessST (const AudioBuffer &inputBuffer, AudioBuffer &outputBuffer, size_t startIndex, size_t frameCount)=0
 
virtual void ProcessMT (const AudioBuffer &inputBuffer, AudioBuffer &outputBuffer, size_t startIndex, size_t frameCount)
 

Additional Inherited Members

- Protected Attributes inherited from HephAudio::OlaEffect
size_t hopSize
 
Heph::DoubleBuffer wnd
 
size_t currentIndex
 
AudioBuffer pastSamples
 
- Protected Attributes inherited from HephAudio::AudioEffect
size_t threadCount
 

Detailed Description

base class for effects that are computed in the frequency domain.

Constructor & Destructor Documentation

◆ FrequencyDomainEffect() [1/3]

HephAudio::FrequencyDomainEffect::FrequencyDomainEffect ( )
protected

creates a new instance and initializes it with default values.

◆ FrequencyDomainEffect() [2/3]

HephAudio::FrequencyDomainEffect::FrequencyDomainEffect ( size_t hopSize)
explicitprotected

creates a new instance and initializes it with the provided values.

Parameters
hopSizenumber of frames to advance each iteration.

◆ FrequencyDomainEffect() [3/3]

HephAudio::FrequencyDomainEffect::FrequencyDomainEffect ( size_t hopSize,
const Window & wnd )
protected

creates a new instance and initializes it with the provided values.

Parameters
hopSizenumber of frames to advance each iteration.
wndwindow that will be applied for overlap-add.

◆ ~FrequencyDomainEffect()

virtual HephAudio::FrequencyDomainEffect::~FrequencyDomainEffect ( )
virtualdefault

releases the resources and destroys the instance.

Member Function Documentation

◆ SetWindow()

virtual void HephAudio::FrequencyDomainEffect::SetWindow ( const Window & wnd)
overridevirtual

sets the window.

Parameters
wndwindow that will be applied for overlap-add.

Reimplemented from HephAudio::OlaEffect.

Reimplemented in HephAudio::Spatializer.