EffectNoiseReduction::Settings Class Reference

Public Member Functions
	Settings ()
	~Settings ()
int	PromptUser (EffectNoiseReduction *effect, EffectSettingsAccess &access, wxWindow &parent, bool bHasProfile, bool bAllowTwiddleSettings)
bool	PrefsIO (bool read)
bool	Validate (EffectNoiseReduction *effect) const
size_t	WindowSize () const
unsigned	StepsPerWindow () const
size_t	SpectrumSize () const
size_t	StepSize () const

Public Attributes
bool	mDoProfile
double	mNewSensitivity
double	mFreqSmoothingBands
double	mNoiseGain
double	mAttackTime
double	mReleaseTime
double	mOldSensitivity
int	mNoiseReductionChoice
int	mWindowTypes
int	mWindowSizeChoice
int	mStepsPerWindowChoice
int	mMethod

Detailed Description

Definition at line 208 of file NoiseReduction.cpp.

Constructor & Destructor Documentation

Settings()

EffectNoiseReduction::Settings::Settings

(

)

Definition at line 248 of file NoiseReduction.cpp.

   : mDoProfile{ true }
{
   PrefsIO(true);
}

References PrefsIO().

Here is the call graph for this function:

~Settings()

EffectNoiseReduction::Settings::~Settings ( )

inline

Definition at line 212 of file NoiseReduction.cpp.

{}

Member Function Documentation

PrefsIO()

bool EffectNoiseReduction::Settings::PrefsIO

(

bool

read

)

Definition at line 535 of file NoiseReduction.cpp.

{
   static const double DEFAULT_OLD_SENSITIVITY = 0.0;
 
   static const PrefsTableEntry<Settings, double> doubleTable[] = {
         { &Settings::mNewSensitivity, wxT("Sensitivity"), 6.0 },
         { &Settings::mNoiseGain, wxT("Gain"), 6.0 },
         { &Settings::mAttackTime, wxT("AttackTime"), 0.02 },
         { &Settings::mReleaseTime, wxT("ReleaseTime"), 0.10 },
         { &Settings::mFreqSmoothingBands, wxT("FreqSmoothing"), 6.0 },
 
         // Advanced settings
         { &Settings::mOldSensitivity, wxT("OldSensitivity"), DEFAULT_OLD_SENSITIVITY },
   };
   static auto doubleTableSize = sizeof(doubleTable) / sizeof(doubleTable[0]);
 
   static const PrefsTableEntry<Settings, int> intTable[] = {
         { &Settings::mNoiseReductionChoice, wxT("ReductionChoice"), NRC_REDUCE_NOISE },
 
         // Advanced settings
         { &Settings::mWindowTypes, wxT("WindowTypes"), WT_DEFAULT_WINDOW_TYPES },
         { &Settings::mWindowSizeChoice, wxT("WindowSize"), DEFAULT_WINDOW_SIZE_CHOICE },
         { &Settings::mStepsPerWindowChoice, wxT("StepsPerWindow"), DEFAULT_STEPS_PER_WINDOW_CHOICE },
         { &Settings::mMethod, wxT("Method"), DM_DEFAULT_METHOD },
   };
   static auto intTableSize = sizeof(intTable) / sizeof(intTable[0]);
 
   static const wxString prefix(wxT("/Effects/NoiseReduction/"));
 
   if (read) {
      readPrefs(this, prefix, doubleTable, doubleTableSize);
      readPrefs(this, prefix, intTable, intTableSize);
 
      // Ignore preferences for unavailable options.
#if !(defined(RESIDUE_CHOICE) || defined (ISOLATE_CHOICE))
      mNoiseReductionChoice == NRC_REDUCE_NOISE;
#elif !(defined(RESIDUE_CHOICE))
      if (mNoiseReductionChoice == NRC_LEAVE_RESIDUE)
         mNoiseReductionChoice = NRC_ISOLATE_NOISE;
#elif !(defined(ISOLATE_CHOICE))
      if (mNoiseReductionChoice == NRC_ISOLATE_NOISE)
         mNoiseReductionChoice = NRC_LEAVE_RESIDUE;
#endif
 
#ifndef ADVANCED_SETTINGS
      // Initialize all hidden advanced settings to defaults.
      mWindowTypes = WT_DEFAULT_WINDOW_TYPES;
      mWindowSizeChoice = DEFAULT_WINDOW_SIZE_CHOICE;
      mStepsPerWindowChoice = DEFAULT_STEPS_PER_WINDOW_CHOICE;
      mMethod = DM_DEFAULT_METHOD;
      mOldSensitivity = DEFAULT_OLD_SENSITIVITY;
#endif
 
#ifndef OLD_METHOD_AVAILABLE
      if (mMethod == DM_OLD_METHOD)
         mMethod = DM_DEFAULT_METHOD;
#endif
 
      return true;
   }
   else {
      writePrefs(this, prefix, doubleTable, doubleTableSize);
      writePrefs(this, prefix, intTable, intTableSize);
      return gPrefs->Flush();
   }
}

References anonymous_namespace{NoiseReduction.cpp}::DEFAULT_STEPS_PER_WINDOW_CHOICE, anonymous_namespace{NoiseReduction.cpp}::DEFAULT_WINDOW_SIZE_CHOICE, anonymous_namespace{NoiseReduction.cpp}::DM_DEFAULT_METHOD, anonymous_namespace{NoiseReduction.cpp}::DM_OLD_METHOD, audacity::BasicSettings::Flush(), gPrefs, mAttackTime, mFreqSmoothingBands, mMethod, mNewSensitivity, mNoiseGain, mNoiseReductionChoice, mOldSensitivity, mReleaseTime, mStepsPerWindowChoice, mWindowSizeChoice, mWindowTypes, anonymous_namespace{NoiseReduction.cpp}::NRC_ISOLATE_NOISE, anonymous_namespace{NoiseReduction.cpp}::NRC_LEAVE_RESIDUE, anonymous_namespace{NoiseReduction.cpp}::NRC_REDUCE_NOISE, anonymous_namespace{NoiseReduction.cpp}::readPrefs(), anonymous_namespace{NoiseReduction.cpp}::writePrefs(), anonymous_namespace{NoiseReduction.cpp}::WT_DEFAULT_WINDOW_TYPES, and wxT().

Referenced by PromptUser(), and Settings().

Here is the call graph for this function:

Here is the caller graph for this function:

PromptUser()

int EffectNoiseReduction::Settings::PromptUser	(	EffectNoiseReduction *	effect,
		EffectSettingsAccess &	access,
		wxWindow &	parent,
		bool	bHasProfile,
		bool	bAllowTwiddleSettings
	)

Definition at line 479 of file NoiseReduction.cpp.

{
   EffectNoiseReduction::Dialog dlog(effect, access,
      this, &parent, bHasProfile, bAllowTwiddleSettings);
 
   dlog.CentreOnParent();
   dlog.ShowModal();
 
   const auto returnCode = dlog.GetReturnCode();
   if (!returnCode)
      return 0;
 
   *this = dlog.GetTempSettings();
   mDoProfile = (returnCode == 1);
 
   if (!PrefsIO(false))
      return 0;
   return returnCode;
}

References EffectNoiseReduction::Dialog::GetTempSettings(), mDoProfile, and PrefsIO().

Here is the call graph for this function:

SpectrumSize()

size_t EffectNoiseReduction::Settings::SpectrumSize ( ) const

inline

Definition at line 221 of file NoiseReduction.cpp.

{ return 1 + WindowSize() / 2; }

References WindowSize().

Here is the call graph for this function:

StepSize()

size_t EffectNoiseReduction::Settings::StepSize ( ) const

inline

Definition at line 222 of file NoiseReduction.cpp.

{ return WindowSize() / StepsPerWindow(); }

References StepsPerWindow(), and WindowSize().

Referenced by EffectNoiseReduction::Worker::Worker().

Here is the call graph for this function:

Here is the caller graph for this function:

StepsPerWindow()

unsigned EffectNoiseReduction::Settings::StepsPerWindow ( ) const

inline

Definition at line 220 of file NoiseReduction.cpp.

{ return 1u << (1 + mStepsPerWindowChoice); }

References mStepsPerWindowChoice.

Referenced by StepSize(), and EffectNoiseReduction::Worker::Worker().

Here is the caller graph for this function:

Validate()

bool EffectNoiseReduction::Settings::Validate

(

EffectNoiseReduction *

effect

)

const

Definition at line 602 of file NoiseReduction.cpp.

{
   if (StepsPerWindow() < windowTypesInfo[mWindowTypes].minSteps) {
      EffectUIServices::DoMessageBox(*effect,
         XO("Steps per block are too few for the window types.") );
      return false;
   }
 
   if (StepsPerWindow() > WindowSize()) {
      EffectUIServices::DoMessageBox(*effect,
         XO("Steps per block cannot exceed the window size.") );
      return false;
   }
 
   if (mMethod == DM_MEDIAN && StepsPerWindow() > 4) {
      EffectUIServices::DoMessageBox(*effect,
         XO(
"Median method is not implemented for more than four steps per window.") );
      return false;
   }
 
   return true;
}

References anonymous_namespace{NoiseReduction.cpp}::DM_MEDIAN, EffectUIServices::DoMessageBox(), anonymous_namespace{NoiseReduction.cpp}::windowTypesInfo, and XO().

Here is the call graph for this function:

WindowSize()

size_t EffectNoiseReduction::Settings::WindowSize ( ) const

inline

Definition at line 219 of file NoiseReduction.cpp.

{ return 1u << (3 + mWindowSizeChoice); }

References mWindowSizeChoice.

Referenced by SpectrumSize(), and StepSize().

Here is the caller graph for this function:

Member Data Documentation

mAttackTime

double EffectNoiseReduction::Settings::mAttackTime

Definition at line 232 of file NoiseReduction.cpp.

Referenced by anonymous_namespace{NoiseReduction.cpp}::controlInfo(), PrefsIO(), and EffectNoiseReduction::Worker::Worker().

mDoProfile

bool EffectNoiseReduction::Settings::mDoProfile

Definition at line 224 of file NoiseReduction.cpp.

Referenced by PromptUser().

mFreqSmoothingBands

double EffectNoiseReduction::Settings::mFreqSmoothingBands

Definition at line 230 of file NoiseReduction.cpp.

Referenced by anonymous_namespace{NoiseReduction.cpp}::controlInfo(), and PrefsIO().

mMethod

int EffectNoiseReduction::Settings::mMethod

Definition at line 245 of file NoiseReduction.cpp.

Referenced by PrefsIO().

mNewSensitivity

double EffectNoiseReduction::Settings::mNewSensitivity

Definition at line 229 of file NoiseReduction.cpp.

Referenced by anonymous_namespace{NoiseReduction.cpp}::controlInfo(), and PrefsIO().

mNoiseGain

double EffectNoiseReduction::Settings::mNoiseGain

Definition at line 231 of file NoiseReduction.cpp.

Referenced by anonymous_namespace{NoiseReduction.cpp}::controlInfo(), PrefsIO(), and EffectNoiseReduction::Worker::Worker().

mNoiseReductionChoice

int EffectNoiseReduction::Settings::mNoiseReductionChoice

Definition at line 239 of file NoiseReduction.cpp.

Referenced by PrefsIO().

mOldSensitivity

double EffectNoiseReduction::Settings::mOldSensitivity

Definition at line 236 of file NoiseReduction.cpp.

Referenced by anonymous_namespace{NoiseReduction.cpp}::controlInfo(), PrefsIO(), and EffectNoiseReduction::Worker::Worker().

mReleaseTime

double EffectNoiseReduction::Settings::mReleaseTime

Definition at line 233 of file NoiseReduction.cpp.

Referenced by anonymous_namespace{NoiseReduction.cpp}::controlInfo(), PrefsIO(), and EffectNoiseReduction::Worker::Worker().

mStepsPerWindowChoice

int EffectNoiseReduction::Settings::mStepsPerWindowChoice

Definition at line 244 of file NoiseReduction.cpp.

Referenced by PrefsIO(), and StepsPerWindow().

mWindowSizeChoice

int EffectNoiseReduction::Settings::mWindowSizeChoice

Definition at line 243 of file NoiseReduction.cpp.

Referenced by PrefsIO(), and WindowSize().

mWindowTypes

int EffectNoiseReduction::Settings::mWindowTypes

Definition at line 242 of file NoiseReduction.cpp.

Referenced by PrefsIO().

---

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

• NoiseReduction.cpp