Audacity 3.2.0
Public Member Functions | Protected Attributes | List of all members
EffectInstanceWithBlockSize Class Reference

Inherit to add a state variable to an EffectInstance subclass. More...

#include <EffectInterface.h>

Inheritance diagram for EffectInstanceWithBlockSize:
[legend]
Collaboration diagram for EffectInstanceWithBlockSize:
[legend]

Public Member Functions

 ~EffectInstanceWithBlockSize () override
 
size_t GetBlockSize () const override
 
size_t SetBlockSize (size_t maxBlockSize) override
 
- Public Member Functions inherited from EffectInstance
virtual ~EffectInstance ()
 
virtual bool Init ()
 Call once to set up state for whole list of tracks to be processed. More...
 
virtual bool Process (EffectSettings &settings)=0
 Actually do the effect here. More...
 
virtual size_t GetBlockSize () const =0
 
virtual size_t SetBlockSize (size_t maxBlockSize)=0
 
virtual unsigned GetAudioInCount () const =0
 How many input buffers to allocate at once. More...
 
virtual unsigned GetAudioOutCount () const =0
 How many output buffers to allocate at once. More...
 
virtual bool RealtimeInitialize (EffectSettings &settings, double sampleRate)
 
virtual bool RealtimeAddProcessor (EffectSettings &settings, unsigned numChannels, float sampleRate)
 
virtual bool RealtimeSuspend ()
 
virtual bool RealtimeResume ()
 
virtual bool RealtimeProcessStart (EffectSettings &settings)
 settings are possibly changed, since last call, by an asynchronous dialog More...
 
virtual size_t RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples)
 
virtual bool RealtimeProcessEnd (EffectSettings &settings) noexcept
 settings can be updated to let a dialog change appearance at idle More...
 
virtual bool RealtimeFinalize (EffectSettings &settings) noexcept
 
virtual size_t GetTailSize () const
 
virtual void AssignSettings (EffectSettings &dst, EffectSettings &&src) const
 Main thread receives updates to settings from a processing thread. More...
 
virtual SampleCount GetLatency (const EffectSettings &settings, double sampleRate) const
 

Protected Attributes

size_t mBlockSize { 0 }
 

Additional Inherited Members

- Public Types inherited from EffectInstance
using SampleCount = uint64_t
 

Detailed Description

Inherit to add a state variable to an EffectInstance subclass.

Definition at line 522 of file EffectInterface.h.

Constructor & Destructor Documentation

◆ ~EffectInstanceWithBlockSize()

EffectInstanceWithBlockSize::~EffectInstanceWithBlockSize ( )
overridedefault

Member Function Documentation

◆ GetBlockSize()

size_t EffectInstanceWithBlockSize::GetBlockSize ( ) const
overridevirtual

Implements EffectInstance.

Definition at line 187 of file EffectInterface.cpp.

188{
189 return mBlockSize;
190}

References mBlockSize.

◆ SetBlockSize()

size_t EffectInstanceWithBlockSize::SetBlockSize ( size_t  maxBlockSize)
overridevirtual

Implements EffectInstance.

Definition at line 192 of file EffectInterface.cpp.

193{
194 return (mBlockSize = maxBlockSize);
195}

References mBlockSize.

Referenced by EffectReverb::Instance::RealtimeInitialize().

Here is the caller graph for this function:

Member Data Documentation

◆ mBlockSize

size_t EffectInstanceWithBlockSize::mBlockSize { 0 }
protected

Definition at line 530 of file EffectInterface.h.

Referenced by GetBlockSize(), and SetBlockSize().


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