Public Member Functions
	Settings ()

	~Settings ()

bool	PromptUser (EffectNoiseReduction *effect, wxWindow &parent, bool bHasProfile, bool bAllowTwiddleSettings)

bool	PrefsIO (bool read)

bool	Validate (EffectNoiseReduction *effect) const

size_t	WindowSize () const

unsigned	StepsPerWindow () 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 246 of file NoiseReduction.cpp.

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

◆ ~Settings()

EffectNoiseReduction::Settings::~Settings ( )

inline

Definition at line 212 of file NoiseReduction.cpp.

212 {}

Member Function Documentation

◆ PrefsIO()

bool EffectNoiseReduction::Settings::PrefsIO ( bool read )

Definition at line 515 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"), 12.0 },
          { &Settings::mAttackTime, wxT("AttackTime"), 0.02 },
          { &Settings::mReleaseTime, wxT("ReleaseTime"), 0.10 },
          { &Settings::mFreqSmoothingBands, wxT("FreqSmoothing"), 3.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();
    }
 }

Referenced by PromptUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PromptUser()

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

Definition at line 462 of file NoiseReduction.cpp.

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

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

Here is the call graph for this function:

◆ StepsPerWindow()

unsigned EffectNoiseReduction::Settings::StepsPerWindow ( ) const

inline

Definition at line 220 of file NoiseReduction.cpp.

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

References mStepsPerWindowChoice.

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

Here is the caller graph for this function:

◆ Validate()

bool EffectNoiseReduction::Settings::Validate ( EffectNoiseReduction * effect ) const

Definition at line 582 of file NoiseReduction.cpp.

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