EffectNoiseReduction::Dialog Class Reference

Dialog used with EffectNoiseReduction. More...

Inheritance diagram for EffectNoiseReduction::Dialog:

Collaboration diagram for EffectNoiseReduction::Dialog:

Public Member Functions
	Dialog (EffectNoiseReduction *effect, EffectSettingsAccess &access, Settings *settings, wxWindow *parent, bool bHasProfile, bool bAllowTwiddleSettings)
void	PopulateOrExchange (ShuttleGui &S) override
bool	TransferDataToWindow () override
bool	TransferDataFromWindow () override
const Settings &	GetTempSettings () const
Public Member Functions inherited from EffectDialog
	EffectDialog (wxWindow *parent, const TranslatableString &title, int type=0, int flags=wxDEFAULT_DIALOG_STYLE, int additionalButtons=0)
void	Init ()
bool	TransferDataToWindow () override
bool	TransferDataFromWindow () override
bool	Validate () override
virtual void	PopulateOrExchange (ShuttleGui &S)
virtual void	OnPreview (wxCommandEvent &evt)
virtual void	OnOk (wxCommandEvent &evt)
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	DisableControlsIfIsolating ()
void	OnGetProfile (wxCommandEvent &event)
void	OnNoiseReductionChoice (wxCommandEvent &event)
void	OnPreview (wxCommandEvent &event) override
void	OnReduceNoise (wxCommandEvent &event)
void	OnCancel (wxCommandEvent &event)
void	OnHelp (wxCommandEvent &event)
void	OnText (wxCommandEvent &event)
void	OnSlider (wxCommandEvent &event)

Private Attributes
EffectNoiseReduction *	m_pEffect
EffectSettingsAccess &	mAccess
	This dialog is modal, so mAccess will live long enough for it. More...
EffectNoiseReduction::Settings *	m_pSettings
EffectNoiseReduction::Settings	mTempSettings
bool	mbHasProfile
bool	mbAllowTwiddleSettings
wxRadioButton *	mKeepSignal
wxRadioButton *	mResidue

Detailed Description

Dialog used with EffectNoiseReduction.

Definition at line 361 of file NoiseReduction.cpp.

Constructor & Destructor Documentation

Dialog()

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

Definition at line 1405 of file NoiseReduction.cpp.

   : EffectDialog( parent, XO("Noise Reduction"), EffectTypeProcess,wxDEFAULT_DIALOG_STYLE, eHelpButton )
   , m_pEffect(effect)
   , mAccess{access}
   , m_pSettings(settings) // point to
   , mTempSettings(*settings)  // copy
   , mbHasProfile(bHasProfile)
   , mbAllowTwiddleSettings(bAllowTwiddleSettings)
   // NULL out the control members until the controls are created.
   , mKeepSignal(NULL)
#ifdef ISOLATE_CHOICE
   , mKeepNoise(NULL)
#endif
#ifdef RESIDUE_CHOICE
   , mResidue(NULL)
#endif
{
   EffectDialog::Init();
 
   wxButton *const pButtonPreview =
      (wxButton *)wxWindow::FindWindowById(ID_EFFECT_PREVIEW, this);
   wxButton *const pButtonReduceNoise =
      (wxButton *)wxWindow::FindWindowById(wxID_OK, this);
 
   if (mbHasProfile || mbAllowTwiddleSettings) {
      pButtonPreview->Enable(!mbAllowTwiddleSettings);
      pButtonReduceNoise->SetFocus();
   }
   else {
      pButtonPreview->Enable(false);
      pButtonReduceNoise->Enable(false);
   }
}

Member Function Documentation

DisableControlsIfIsolating()

void EffectNoiseReduction::Dialog::DisableControlsIfIsolating ( )

private

Definition at line 1442 of file NoiseReduction.cpp.

{
   // If Isolate is chosen, disable controls that define
   // "what to do with noise" rather than "what is noise."
   // Else, enable them.
   // This does NOT include sensitivity, NEW or old, nor
   // the choice of window functions, size, or step.
   // The method choice is not included, because it affects
   // which sensitivity slider is operative, and that is part
   // of what defines noise.
 
   static const int toDisable[] = {
      ID_GAIN_SLIDER,
      ID_GAIN_TEXT,
 
      ID_FREQ_SLIDER,
      ID_FREQ_TEXT,
 
#ifdef ATTACK_AND_RELEASE
      ID_ATTACK_TIME_SLIDER,
      ID_ATTACK_TIME_TEXT,
 
      ID_RELEASE_TIME_SLIDER,
      ID_RELEASE_TIME_TEXT,
#endif
   };
   static const auto nToDisable = sizeof(toDisable) / sizeof(toDisable[0]);
 
   bool bIsolating =
#ifdef ISOLATE_CHOICE
      mKeepNoise->GetValue();
#else
      false;
#endif
   for (auto ii = nToDisable; ii--;)
      wxWindow::FindWindowById(toDisable[ii], this)->Enable(!bIsolating);
}

References ID_FREQ_SLIDER, ID_FREQ_TEXT, ID_GAIN_SLIDER, and ID_GAIN_TEXT.

GetTempSettings()

const Settings & EffectNoiseReduction::Dialog::GetTempSettings ( ) const

inline

Definition at line 374 of file NoiseReduction.cpp.

   { return mTempSettings; }

References mTempSettings.

Referenced by EffectNoiseReduction::Settings::PromptUser().

Here is the caller graph for this function:

OnCancel()

void EffectNoiseReduction::Dialog::OnCancel ( wxCommandEvent &  event )

private

Definition at line 1553 of file NoiseReduction.cpp.

{
   EndModal(0);
}

OnGetProfile()

void EffectNoiseReduction::Dialog::OnGetProfile ( wxCommandEvent &  event )

private

Definition at line 1494 of file NoiseReduction.cpp.

{
   // Project has not be changed so skip pushing state
   EffectManager::Get().SetSkipStateFlag(true);
 
   if (!TransferDataFromWindow())
      return;
 
   // Return code distinguishes this first step from the actual effect
   EndModal(1);
}

References EffectManager::Get(), EffectManager::SetSkipStateFlag(), and StatefulEffectUIServices::TransferDataFromWindow().

Here is the call graph for this function:

OnHelp()

void EffectNoiseReduction::Dialog::OnHelp ( wxCommandEvent &  event )

private

Definition at line 1558 of file NoiseReduction.cpp.

{
   HelpSystem::ShowHelp(this, "Noise_Reduction", true);
}

References HelpSystem::ShowHelp().

Here is the call graph for this function:

OnNoiseReductionChoice()

void EffectNoiseReduction::Dialog::OnNoiseReductionChoice ( wxCommandEvent &  event )

private

Definition at line 1507 of file NoiseReduction.cpp.

{
   if (mKeepSignal->GetValue())
      mTempSettings.mNoiseReductionChoice = NRC_REDUCE_NOISE;
#ifdef ISOLATE_CHOICE
   else if (mKeepNoise->GetValue())
      mTempSettings.mNoiseReductionChoice = NRC_ISOLATE_NOISE;
#endif
#ifdef RESIDUE_CHOICE
   else
      mTempSettings.mNoiseReductionChoice = NRC_LEAVE_RESIDUE;
#endif
   DisableControlsIfIsolating();
}

References anonymous_namespace{NoiseReduction.cpp}::NRC_ISOLATE_NOISE, anonymous_namespace{NoiseReduction.cpp}::NRC_LEAVE_RESIDUE, and anonymous_namespace{NoiseReduction.cpp}::NRC_REDUCE_NOISE.

OnPreview()

void EffectNoiseReduction::Dialog::OnPreview ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from EffectDialog.

Definition at line 1529 of file NoiseReduction.cpp.

{
   if (!TransferDataFromWindow())
      return;
 
   // Save & restore parameters around Preview, because we didn't do OK.
   auto cleanup = valueRestorer( *m_pSettings );
   *m_pSettings = mTempSettings;
   m_pSettings->mDoProfile = false;
 
   EffectPreview(*m_pEffect, mAccess,
      // Don't need any UI updates for preview
      {},
      false);
}

References EffectPreview(), StatefulEffectUIServices::TransferDataFromWindow(), and valueRestorer().

Here is the call graph for this function:

OnReduceNoise()

void EffectNoiseReduction::Dialog::OnReduceNoise ( wxCommandEvent &  event )

private

Definition at line 1545 of file NoiseReduction.cpp.

{
   if (!TransferDataFromWindow())
      return;
 
   EndModal(2);
}

References StatefulEffectUIServices::TransferDataFromWindow().

Here is the call graph for this function:

OnSlider()

void EffectNoiseReduction::Dialog::OnSlider ( wxCommandEvent &  event )

private

Definition at line 1757 of file NoiseReduction.cpp.

{
   int id = event.GetId();
   int idx = (id - FIRST_SLIDER) / 2;
   const ControlInfo &info = controlInfo()[idx];
   wxSlider* slider =
      static_cast<wxSlider*>(wxWindow::FindWindowById(id, this));
   wxTextCtrl* text =
      static_cast<wxTextCtrl*>(wxWindow::FindWindowById(id + 1, this));
   double &field = mTempSettings.*(info.field);
 
   field = info.Value(slider->GetValue());
   text->SetValue(info.Text(field));
}

References anonymous_namespace{NoiseReduction.cpp}::controlInfo(), field, and FIRST_SLIDER.

Here is the call graph for this function:

OnText()

void EffectNoiseReduction::Dialog::OnText ( wxCommandEvent &  event )

private

Definition at line 1742 of file NoiseReduction.cpp.

{
   int id = event.GetId();
   int idx = (id - FIRST_SLIDER - 1) / 2;
   const ControlInfo &info = controlInfo()[idx];
   wxTextCtrl* text =
      static_cast<wxTextCtrl*>(wxWindow::FindWindowById(id, this));
   wxSlider* slider =
      static_cast<wxSlider*>(wxWindow::FindWindowById(id - 1, this));
   double &field = mTempSettings.*(info.field);
 
   text->GetValue().ToDouble(&field);
   slider->SetValue(info.SliderSetting(field));
}

References anonymous_namespace{NoiseReduction.cpp}::controlInfo(), field, and FIRST_SLIDER.

Here is the call graph for this function:

PopulateOrExchange()

void EffectNoiseReduction::Dialog::PopulateOrExchange ( ShuttleGui &  S )

overridevirtual

This is a virtual function which will be overridden to provide the actual parameters that we want for each kind of dialog.

Reimplemented from EffectDialog.

Definition at line 1563 of file NoiseReduction.cpp.

{
   S.StartStatic(XO("Step 1"));
   {
      S.AddVariableText(XO(
"Select a few seconds of just noise so Audacity knows what to filter out,\nthen click Get Noise Profile:"));
      //m_pButton_GetProfile =
      S.Id(ID_BUTTON_GETPROFILE).AddButton(XXO("&Get Noise Profile"));
   }
   S.EndStatic();
 
   S.StartStatic(XO("Step 2"));
   {
      S.AddVariableText(XO(
"Select all of the audio you want filtered, choose how much noise you want\nfiltered out, and then click 'OK' to reduce noise.\n"));
 
      S.StartMultiColumn(3, wxEXPAND);
      S.SetStretchyCol(2);
      {
         for (int id = FIRST_SLIDER; id < END_OF_BASIC_SLIDERS; id += 2) {
            const ControlInfo &info = controlInfo()[(id - FIRST_SLIDER) / 2];
            info.CreateControls(id, S);
         }
      }
      S.EndMultiColumn();
 
      S.StartMultiColumn(
         2
#ifdef RESIDUE_CHOICE
         +1
#endif
#ifdef ISOLATE_CHOICE
         +1
#endif
         ,
         wxALIGN_CENTER_HORIZONTAL);
      {
         S.AddPrompt(XXO("Noise:"));
         mKeepSignal = S.Id(ID_RADIOBUTTON_KEEPSIGNAL)
               /* i18n-hint: Translate differently from "Residue" ! */
               .AddRadioButton(XXO("Re&duce"));
#ifdef ISOLATE_CHOICE
         mKeepNoise = S.Id(ID_RADIOBUTTON_KEEPNOISE)
               .AddRadioButtonToGroup(XXO("&Isolate"));
#endif
#ifdef RESIDUE_CHOICE
         mResidue = S.Id(ID_RADIOBUTTON_RESIDUE)
               /* i18n-hint: Means the difference between effect and original sound.  Translate differently from "Reduce" ! */
               .AddRadioButtonToGroup(XXO("Resid&ue"));
#endif
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
 
#ifdef ADVANCED_SETTINGS
   S.StartStatic(XO("Advanced Settings"));
   {
      S.StartMultiColumn(2);
      {
         S.TieChoice(XXO("&Window types:"),
            mTempSettings.mWindowTypes,
            []{
               TranslatableStrings windowTypeChoices;
               for (size_t ii = 0; ii < WT_N_WINDOW_TYPES; ++ii)
                  windowTypeChoices.push_back(windowTypesInfo[ii].name);
               return windowTypeChoices;
            }()
         );
 
         S.TieChoice(XXO("Window si&ze:"),
            mTempSettings.mWindowSizeChoice,
            {
               XO("8") ,
               XO("16") ,
               XO("32") ,
               XO("64") ,
               XO("128") ,
               XO("256") ,
               XO("512") ,
               XO("1024") ,
               XO("2048 (default)") ,
               XO("4096") ,
               XO("8192") ,
               XO("16384") ,
            }
         );
 
         S.TieChoice(XXO("S&teps per window:"),
            mTempSettings.mStepsPerWindowChoice,
            {
               XO("2") ,
               XO("4 (default)") ,
               XO("8") ,
               XO("16") ,
               XO("32") ,
               XO("64") ,
            }
         );
 
         S.Id(ID_CHOICE_METHOD)
         .TieChoice(XXO("Discrimination &method:"),
            mTempSettings.mMethod,
            []{
               TranslatableStrings methodChoices;
               auto nn = DM_N_METHODS;
#ifndef OLD_METHOD_AVAILABLE
               --nn;
#endif
               for (auto ii = 0; ii < nn; ++ii)
                  methodChoices.push_back(discriminationMethodInfo[ii].name);
               return methodChoices;
            }());
      }
      S.EndMultiColumn();
 
      S.StartMultiColumn(3, wxEXPAND);
      S.SetStretchyCol(2);
      {
         for (int id = END_OF_BASIC_SLIDERS; id < END_OF_ADVANCED_SLIDERS; id += 2) {
            const ControlInfo &info = controlInfo()[(id - FIRST_SLIDER) / 2];
            info.CreateControls(id, S);
         }
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
#endif
}

References anonymous_namespace{NoiseReduction.cpp}::controlInfo(), anonymous_namespace{NoiseReduction.cpp}::ControlInfo::CreateControls(), anonymous_namespace{NoiseReduction.cpp}::discriminationMethodInfo, anonymous_namespace{NoiseReduction.cpp}::DM_N_METHODS, END_OF_BASIC_SLIDERS, FIRST_SLIDER, ID_BUTTON_GETPROFILE, ID_RADIOBUTTON_KEEPSIGNAL, ID_RADIOBUTTON_RESIDUE, anonymous_namespace{NoiseReduction.cpp}::DiscriminationMethodInfo::name, anonymous_namespace{NoiseReduction.cpp}::WindowTypesInfo::name, RESIDUE_CHOICE, S, anonymous_namespace{NoiseReduction.cpp}::windowTypesInfo, anonymous_namespace{NoiseReduction.cpp}::WT_N_WINDOW_TYPES, XO(), and XXO().

Here is the call graph for this function:

TransferDataFromWindow()

bool EffectNoiseReduction::Dialog::TransferDataFromWindow ( )

override

Definition at line 1728 of file NoiseReduction.cpp.

{
   if( !wxWindow::Validate() )
      return false;
   // Do the choice controls:
   if (!EffectDialog::TransferDataFromWindow())
      return false;
 
   wxCommandEvent dummy;
   OnNoiseReductionChoice(dummy);
 
   return mTempSettings.Validate(m_pEffect);
}

References EffectDialog::TransferDataFromWindow().

Here is the call graph for this function:

TransferDataToWindow()

bool EffectNoiseReduction::Dialog::TransferDataToWindow ( )

override

Definition at line 1694 of file NoiseReduction.cpp.

{
   // Do the choice controls:
   if (!EffectDialog::TransferDataToWindow())
      return false;
 
   for (int id = FIRST_SLIDER; id < END_OF_SLIDERS; id += 2) {
      wxSlider* slider =
         static_cast<wxSlider*>(wxWindow::FindWindowById(id, this));
      wxTextCtrl* text =
         static_cast<wxTextCtrl*>(wxWindow::FindWindowById(id + 1, this));
      const ControlInfo &info = controlInfo()[(id - FIRST_SLIDER) / 2];
      const double field = mTempSettings.*(info.field);
      text->SetValue(info.Text(field));
      slider->SetValue(info.SliderSetting(field));
   }
 
   mKeepSignal->SetValue(mTempSettings.mNoiseReductionChoice == NRC_REDUCE_NOISE);
#ifdef ISOLATE_CHOICE
   mKeepNoise->SetValue(mTempSettings.mNoiseReductionChoice == NRC_ISOLATE_NOISE);
#endif
#ifdef RESIDUE_CHOICE
   mResidue->SetValue(mTempSettings.mNoiseReductionChoice == NRC_LEAVE_RESIDUE);
#endif
 
   // Set the enabled states of controls
   DisableControlsIfIsolating();
#ifdef ADVANCED_SETTINGS
   EnableDisableSensitivityControls();
#endif
 
   return true;
}

References anonymous_namespace{NoiseReduction.cpp}::controlInfo(), END_OF_SLIDERS, field, FIRST_SLIDER, anonymous_namespace{NoiseReduction.cpp}::NRC_ISOLATE_NOISE, anonymous_namespace{NoiseReduction.cpp}::NRC_LEAVE_RESIDUE, anonymous_namespace{NoiseReduction.cpp}::NRC_REDUCE_NOISE, and EffectDialog::TransferDataToWindow().

Here is the call graph for this function:

Member Data Documentation

m_pEffect

EffectNoiseReduction* EffectNoiseReduction::Dialog::m_pEffect

private

Definition at line 400 of file NoiseReduction.cpp.

m_pSettings

EffectNoiseReduction::Settings* EffectNoiseReduction::Dialog::m_pSettings

private

Definition at line 403 of file NoiseReduction.cpp.

mAccess

EffectSettingsAccess& EffectNoiseReduction::Dialog::mAccess

private

This dialog is modal, so mAccess will live long enough for it.

Definition at line 402 of file NoiseReduction.cpp.

mbAllowTwiddleSettings

bool EffectNoiseReduction::Dialog::mbAllowTwiddleSettings

private

Definition at line 407 of file NoiseReduction.cpp.

mbHasProfile

bool EffectNoiseReduction::Dialog::mbHasProfile

private

Definition at line 406 of file NoiseReduction.cpp.

mKeepSignal

wxRadioButton* EffectNoiseReduction::Dialog::mKeepSignal

private

Definition at line 410 of file NoiseReduction.cpp.

mResidue

wxRadioButton* EffectNoiseReduction::Dialog::mResidue

private

Definition at line 415 of file NoiseReduction.cpp.

mTempSettings

EffectNoiseReduction::Settings EffectNoiseReduction::Dialog::mTempSettings

private

Definition at line 404 of file NoiseReduction.cpp.

Referenced by GetTempSettings().

---

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

• NoiseReduction.cpp