Audacity 3.2.0
Public Member Functions | Public Attributes | List of all members
EffectEcho::Instance Struct Reference
Inheritance diagram for EffectEcho::Instance:
[legend]
Collaboration diagram for EffectEcho::Instance:
[legend]

Public Member Functions

 Instance (const PerTrackEffect &effect)
 
bool ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap) override
 
size_t ProcessBlock (EffectSettings &settings, const float *const *inBlock, float *const *outBlock, size_t blockLen) override
 Called for destructive effect computation. More...
 
bool ProcessFinalize () noexcept override
 
unsigned GetAudioOutCount () const override
 How many output buffers to allocate at once. More...
 
unsigned GetAudioInCount () const override
 How many input buffers to allocate at once. More...
 
- Public Member Functions inherited from PerTrackEffect::Instance
 Instance (const PerTrackEffect &processor)
 
 ~Instance () override
 
bool Process (EffectSettings &settings) final
 Uses the other virtual functions of this class. More...
 
bool ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap) override
 
bool ProcessFinalize () noexcept override
 
- Public Member Functions inherited from EffectInstanceEx
 ~EffectInstanceEx () override
 
virtual bool ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap)=0
 
virtual bool ProcessFinalize () noexcept=0
 
virtual size_t ProcessBlock (EffectSettings &settings, const float *const *inBlock, float *const *outBlock, size_t blockLen)=0
 Called for destructive effect computation. More...
 
- 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
 
- Public Member Functions inherited from EffectInstanceWithBlockSize
 ~EffectInstanceWithBlockSize () override
 
size_t GetBlockSize () const override
 
size_t SetBlockSize (size_t maxBlockSize) override
 

Public Attributes

Floats history
 
size_t histPos
 
size_t histLen
 

Additional Inherited Members

- Public Types inherited from EffectInstance
using SampleCount = uint64_t
 
- Protected Attributes inherited from PerTrackEffect::Instance
const PerTrackEffectmProcessor
 
- Protected Attributes inherited from EffectInstanceWithBlockSize
size_t mBlockSize { 0 }
 

Detailed Description

Definition at line 46 of file Echo.cpp.

Constructor & Destructor Documentation

◆ Instance()

EffectEcho::Instance::Instance ( const PerTrackEffect effect)
inline

Definition at line 50 of file Echo.cpp.

Member Function Documentation

◆ GetAudioInCount()

unsigned EffectEcho::Instance::GetAudioInCount ( ) const
inlineoverridevirtual

How many input buffers to allocate at once.

If the instance processes channels independently, this can return 1 The result is not necessarily well defined before RealtimeInitialize

Implements EffectInstance.

Definition at line 67 of file Echo.cpp.

68 {
69 return 1;
70 }

◆ GetAudioOutCount()

unsigned EffectEcho::Instance::GetAudioOutCount ( ) const
inlineoverridevirtual

How many output buffers to allocate at once.

The result is not necessarily well defined before RealtimeInitialize

Implements EffectInstance.

Definition at line 62 of file Echo.cpp.

63 {
64 return 1;
65 }

◆ ProcessBlock()

size_t EffectEcho::Instance::ProcessBlock ( EffectSettings settings,
const float *const *  inBlock,
float *const *  outBlock,
size_t  blockLen 
)
overridevirtual

Called for destructive effect computation.

Implements EffectInstanceEx.

Definition at line 152 of file Echo.cpp.

154{
155 auto& echoSettings = GetSettings(settings);
156
157 const float *ibuf = inBlock[0];
158 float *obuf = outBlock[0];
159
160 for (decltype(blockLen) i = 0; i < blockLen; i++, histPos++)
161 {
162 if (histPos == histLen)
163 {
164 histPos = 0;
165 }
166 history[histPos] = obuf[i] = ibuf[i] + history[histPos] * echoSettings.decay;
167 }
168
169 return blockLen;
170}
static Settings & settings()
Definition: TrackInfo.cpp:87
static EffectEchoSettings & GetSettings(EffectSettings &settings)
Assume settings originated from MakeSettings() and copies thereof.
Definition: Effect.h:330

References EffectWithSettings< EffectEchoSettings, PerTrackEffect >::GetSettings(), and settings().

Here is the call graph for this function:

◆ ProcessFinalize()

bool EffectEcho::Instance::ProcessFinalize ( )
overridevirtualnoexcept

Called at end of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true This may be called during stack unwinding:

Implements EffectInstanceEx.

Definition at line 147 of file Echo.cpp.

148{
149 return true;
150}

◆ ProcessInitialize()

bool EffectEcho::Instance::ProcessInitialize ( EffectSettings settings,
double  sampleRate,
ChannelNames  chanMap 
)
overridevirtual

Called at start of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true

Parameters
chanMapnull or array terminated with ChannelNameEOL. Do not retain the pointer
Postcondition
GetAudioInCount() and GetAudioOutCount() are well defined

Implements EffectInstanceEx.

Definition at line 120 of file Echo.cpp.

122{
123 auto& echoSettings = GetSettings(settings);
124 if (echoSettings.delay == 0.0)
125 return false;
126
127 histPos = 0;
128 auto requestedHistLen = (sampleCount) (sampleRate * echoSettings.delay);
129
130 // Guard against extreme delay values input by the user
131 try {
132 // Guard against huge delay values from the user.
133 // Don't violate the assertion in as_size_t
134 if (requestedHistLen !=
135 (histLen = static_cast<size_t>(requestedHistLen.as_long_long())))
136 throw std::bad_alloc{};
137 history.reinit(histLen, true);
138 }
139 catch ( const std::bad_alloc& ) {
140 mProcessor.MessageBox( XO("Requested value exceeds memory capacity.") );
141 return false;
142 }
143
144 return history != NULL;
145}
#define XO(s)
Definition: Internat.h:31
void reinit(Integral count, bool initialize=false)
Definition: MemoryX.h:57
int MessageBox(const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) const
Definition: Effect.cpp:854
const PerTrackEffect & mProcessor
Positions or offsets within audio files need a wide type.
Definition: SampleCount.h:19

References EffectWithSettings< EffectEchoSettings, PerTrackEffect >::GetSettings(), histLen, history, histPos, Effect::MessageBox(), PerTrackEffect::Instance::mProcessor, ArrayOf< X >::reinit(), settings(), and XO.

Here is the call graph for this function:

Member Data Documentation

◆ histLen

size_t EffectEcho::Instance::histLen

Definition at line 74 of file Echo.cpp.

Referenced by ProcessInitialize().

◆ history

Floats EffectEcho::Instance::history

Definition at line 72 of file Echo.cpp.

Referenced by ProcessInitialize().

◆ histPos

size_t EffectEcho::Instance::histPos

Definition at line 73 of file Echo.cpp.

Referenced by ProcessInitialize().


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