NoiseReductionBase::Settings Class Reference

#include <NoiseReductionBase.h>

Public Member Functions
	Settings ()
	~Settings ()
bool	PrefsIO (bool read)
bool	Validate (NoiseReductionBase *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 47 of file NoiseReductionBase.h.

Constructor & Destructor Documentation

Settings()

NoiseReductionBase::Settings::Settings

(

)

Definition at line 179 of file NoiseReductionBase.cpp.

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

References PrefsIO().

Here is the call graph for this function:

~Settings()

NoiseReductionBase::Settings::~Settings ( )

inline

Definition at line 51 of file NoiseReductionBase.h.

      {
      }

Member Function Documentation

PrefsIO()

bool NoiseReductionBase::Settings::PrefsIO

(

bool

read

)

Definition at line 357 of file NoiseReductionBase.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{NoiseReductionBase.cpp}::DEFAULT_STEPS_PER_WINDOW_CHOICE, anonymous_namespace{NoiseReductionBase.cpp}::DEFAULT_WINDOW_SIZE_CHOICE, anonymous_namespace{NoiseReductionBase.cpp}::DM_DEFAULT_METHOD, anonymous_namespace{NoiseReductionBase.cpp}::DM_OLD_METHOD, audacity::BasicSettings::Flush(), gPrefs, mAttackTime, mFreqSmoothingBands, mMethod, mNewSensitivity, mNoiseGain, mNoiseReductionChoice, mOldSensitivity, mReleaseTime, mStepsPerWindowChoice, mWindowSizeChoice, mWindowTypes, NRC_ISOLATE_NOISE, NRC_LEAVE_RESIDUE, NRC_REDUCE_NOISE, anonymous_namespace{NoiseReductionBase.cpp}::readPrefs(), anonymous_namespace{NoiseReductionBase.cpp}::writePrefs(), anonymous_namespace{NoiseReductionBase.cpp}::WT_DEFAULT_WINDOW_TYPES, and wxT().

Referenced by Settings().

Here is the call graph for this function:

Here is the caller graph for this function:

SpectrumSize()

size_t NoiseReductionBase::Settings::SpectrumSize ( ) const

inline

Definition at line 66 of file NoiseReductionBase.h.

      {
         return 1 + WindowSize() / 2;
      }

StepSize()

size_t NoiseReductionBase::Settings::StepSize ( ) const

inline

Definition at line 70 of file NoiseReductionBase.h.

      {
         return WindowSize() / StepsPerWindow();
      }

Referenced by NoiseReductionBase::Worker::Worker().

Here is the caller graph for this function:

StepsPerWindow()

unsigned NoiseReductionBase::Settings::StepsPerWindow ( ) const

inline

Definition at line 62 of file NoiseReductionBase.h.

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

Referenced by NoiseReductionBase::Worker::Worker().

Here is the caller graph for this function:

Validate()

bool NoiseReductionBase::Settings::Validate

(

NoiseReductionBase *

effect

)

const

Definition at line 430 of file NoiseReductionBase.cpp.

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

References anonymous_namespace{NoiseReductionBase.cpp}::DM_MEDIAN, BasicUI::ShowMessageBox(), anonymous_namespace{NoiseReductionBase.cpp}::windowTypesInfo, and XO().

Here is the call graph for this function:

WindowSize()

size_t NoiseReductionBase::Settings::WindowSize ( ) const

inline

Definition at line 58 of file NoiseReductionBase.h.

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

Member Data Documentation

mAttackTime

double NoiseReductionBase::Settings::mAttackTime

Definition at line 83 of file NoiseReductionBase.h.

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

mDoProfile

bool NoiseReductionBase::Settings::mDoProfile

Definition at line 75 of file NoiseReductionBase.h.

mFreqSmoothingBands

double NoiseReductionBase::Settings::mFreqSmoothingBands

Definition at line 81 of file NoiseReductionBase.h.

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

mMethod

int NoiseReductionBase::Settings::mMethod

Definition at line 96 of file NoiseReductionBase.h.

Referenced by PrefsIO().

mNewSensitivity

double NoiseReductionBase::Settings::mNewSensitivity

Definition at line 80 of file NoiseReductionBase.h.

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

mNoiseGain

double NoiseReductionBase::Settings::mNoiseGain

Definition at line 82 of file NoiseReductionBase.h.

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

mNoiseReductionChoice

int NoiseReductionBase::Settings::mNoiseReductionChoice

Definition at line 90 of file NoiseReductionBase.h.

Referenced by PrefsIO().

mOldSensitivity

double NoiseReductionBase::Settings::mOldSensitivity

Definition at line 87 of file NoiseReductionBase.h.

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

mReleaseTime

double NoiseReductionBase::Settings::mReleaseTime

Definition at line 84 of file NoiseReductionBase.h.

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

mStepsPerWindowChoice

int NoiseReductionBase::Settings::mStepsPerWindowChoice

Definition at line 95 of file NoiseReductionBase.h.

Referenced by PrefsIO().

mWindowSizeChoice

int NoiseReductionBase::Settings::mWindowSizeChoice

Definition at line 94 of file NoiseReductionBase.h.

Referenced by PrefsIO().

mWindowTypes

int NoiseReductionBase::Settings::mWindowTypes

Definition at line 93 of file NoiseReductionBase.h.

Referenced by PrefsIO().

---

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

• NoiseReductionBase.h
• NoiseReductionBase.cpp