Audacity 3.2.0
Public Attributes | Static Public Attributes | Friends | List of all members
ReverbSettings Struct Reference

#include <ReverbBase.h>

Public Attributes

double mRoomSize { roomSizeDefault }
 
double mPreDelay { preDelayDefault }
 
double mReverberance { reverberanceDefault }
 
double mHfDamping { hfDampingDefault }
 
double mToneLow { toneLowDefault }
 
double mToneHigh { toneHighDefault }
 
double mWetGain { wetGainDefault }
 
double mDryGain { dryGainDefault }
 
double mStereoWidth { stereoWidthDefault }
 
bool mWetOnly { wetOnlyDefault }
 

Static Public Attributes

static constexpr double roomSizeDefault = 75.0
 
static constexpr double preDelayDefault = 10.0
 
static constexpr double reverberanceDefault = 50.0
 
static constexpr double hfDampingDefault = 50.0
 
static constexpr double toneLowDefault = 100.0
 
static constexpr double toneHighDefault = 100.0
 
static constexpr double wetGainDefault = -1.0
 
static constexpr double dryGainDefault = -1.0
 
static constexpr double stereoWidthDefault = 100.0
 
static constexpr bool wetOnlyDefault = false
 

Friends

bool operator== (const ReverbSettings &a, const ReverbSettings &b)
 
bool OnlySimpleParametersChanged (const ReverbSettings &a, const ReverbSettings &b)
 

Detailed Description

Definition at line 7 of file ReverbBase.h.

Friends And Related Function Documentation

◆ OnlySimpleParametersChanged

bool OnlySimpleParametersChanged ( const ReverbSettings a,
const ReverbSettings b 
)
friend

Definition at line 369 of file ReverbBase.cpp.

371{
372 // A "simple" reverb parameter is one that when changed, does not require the
373 // reverb allpass/comb filters to be reset. This distinction enables us to
374 // code things so that the user can keep hearing the processed sound while
375 // they tweak one of the simple parameters.
376
377 const bool oneSimpleParameterChanged =
378
379 (a.mReverberance != b.mReverberance) || (a.mHfDamping != b.mHfDamping) ||
380 (a.mToneLow != b.mToneLow) || (a.mToneHigh != b.mToneHigh) ||
381 (a.mWetGain != b.mWetGain);
382
383 const bool allNonSimpleParametersStayedTheSame =
384
385 (a.mRoomSize == b.mRoomSize) && (a.mPreDelay == b.mPreDelay) &&
386 (a.mStereoWidth == b.mStereoWidth);
387
388 return oneSimpleParameterChanged && allNonSimpleParametersStayedTheSame;
389}
double mPreDelay
Definition: ReverbBase.h:21
double mReverberance
Definition: ReverbBase.h:22
double mToneHigh
Definition: ReverbBase.h:25
double mWetGain
Definition: ReverbBase.h:26
double mToneLow
Definition: ReverbBase.h:24
double mHfDamping
Definition: ReverbBase.h:23
double mRoomSize
Definition: ReverbBase.h:20
double mStereoWidth
Definition: ReverbBase.h:28

◆ operator==

bool operator== ( const ReverbSettings a,
const ReverbSettings b 
)
friend

Definition at line 358 of file ReverbBase.cpp.

359{
360 // With C++20, all of this can be replaced by =default
361 return (a.mRoomSize == b.mRoomSize) && (a.mPreDelay == b.mPreDelay) &&
362 (a.mReverberance == b.mReverberance) &&
363 (a.mHfDamping == b.mHfDamping) && (a.mToneLow == b.mToneLow) &&
364 (a.mToneHigh == b.mToneHigh) && (a.mWetGain == b.mWetGain) &&
365 (a.mDryGain == b.mDryGain) && (a.mStereoWidth == b.mStereoWidth) &&
366 (a.mWetOnly == b.mWetOnly);
367}
double mDryGain
Definition: ReverbBase.h:27

Member Data Documentation

◆ dryGainDefault

constexpr double ReverbSettings::dryGainDefault = -1.0
staticconstexpr

Definition at line 16 of file ReverbBase.h.

◆ hfDampingDefault

constexpr double ReverbSettings::hfDampingDefault = 50.0
staticconstexpr

Definition at line 12 of file ReverbBase.h.

◆ mDryGain

double ReverbSettings::mDryGain { dryGainDefault }

Definition at line 27 of file ReverbBase.h.

◆ mHfDamping

double ReverbSettings::mHfDamping { hfDampingDefault }

Definition at line 23 of file ReverbBase.h.

◆ mPreDelay

double ReverbSettings::mPreDelay { preDelayDefault }

Definition at line 21 of file ReverbBase.h.

◆ mReverberance

double ReverbSettings::mReverberance { reverberanceDefault }

Definition at line 22 of file ReverbBase.h.

◆ mRoomSize

double ReverbSettings::mRoomSize { roomSizeDefault }

Definition at line 20 of file ReverbBase.h.

Referenced by EffectReverb::Editor::ValidateUI().

◆ mStereoWidth

double ReverbSettings::mStereoWidth { stereoWidthDefault }

Definition at line 28 of file ReverbBase.h.

◆ mToneHigh

double ReverbSettings::mToneHigh { toneHighDefault }

Definition at line 25 of file ReverbBase.h.

◆ mToneLow

double ReverbSettings::mToneLow { toneLowDefault }

Definition at line 24 of file ReverbBase.h.

◆ mWetGain

double ReverbSettings::mWetGain { wetGainDefault }

Definition at line 26 of file ReverbBase.h.

◆ mWetOnly

bool ReverbSettings::mWetOnly { wetOnlyDefault }

Definition at line 29 of file ReverbBase.h.

◆ preDelayDefault

constexpr double ReverbSettings::preDelayDefault = 10.0
staticconstexpr

Definition at line 10 of file ReverbBase.h.

◆ reverberanceDefault

constexpr double ReverbSettings::reverberanceDefault = 50.0
staticconstexpr

Definition at line 11 of file ReverbBase.h.

◆ roomSizeDefault

constexpr double ReverbSettings::roomSizeDefault = 75.0
staticconstexpr

Definition at line 9 of file ReverbBase.h.

◆ stereoWidthDefault

constexpr double ReverbSettings::stereoWidthDefault = 100.0
staticconstexpr

Definition at line 17 of file ReverbBase.h.

◆ toneHighDefault

constexpr double ReverbSettings::toneHighDefault = 100.0
staticconstexpr

Definition at line 14 of file ReverbBase.h.

◆ toneLowDefault

constexpr double ReverbSettings::toneLowDefault = 100.0
staticconstexpr

Definition at line 13 of file ReverbBase.h.

◆ wetGainDefault

constexpr double ReverbSettings::wetGainDefault = -1.0
staticconstexpr

Definition at line 15 of file ReverbBase.h.

◆ wetOnlyDefault

constexpr bool ReverbSettings::wetOnlyDefault = false
staticconstexpr

Definition at line 18 of file ReverbBase.h.


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