Dialog used with EffectNoiseRemoval. More...

#include <NoiseRemoval.h>

Inheritance diagram for NoiseRemovalDialog:

Collaboration diagram for NoiseRemovalDialog:

Public Member Functions
	NoiseRemovalDialog (EffectNoiseRemoval effect, EffectSettingsAccess &access, wxWindow parent)

wxSizer *	MakeNoiseRemovalDialog (bool call_fit=true, bool set_sizer=true)

void	PopulateOrExchange (ShuttleGui &S) override

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

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

Public Attributes
EffectNoiseRemoval *	m_pEffect

EffectSettingsAccess &	mAccess

wxButton *	m_pButton_GetProfile

wxButton *	m_pButton_Preview

wxButton *	m_pButton_RemoveNoise

wxRadioButton *	mKeepSignal

wxRadioButton *	mKeepNoise

wxSlider *	mSensitivityS

wxSlider *	mGainS

wxSlider *	mFreqS

wxSlider *	mTimeS

wxTextCtrl *	mSensitivityT

wxTextCtrl *	mGainT

wxTextCtrl *	mFreqT

wxTextCtrl *	mTimeT

double	mSensitivity

double	mGain

double	mFreq

double	mTime

bool	mbLeaveNoise

Private Member Functions
void	OnGetProfile (wxCommandEvent &event)

void	OnKeepNoise (wxCommandEvent &event)

void	OnPreview (wxCommandEvent &event) override

void	OnRemoveNoise (wxCommandEvent &event)

void	OnCancel (wxCommandEvent &event)

void	OnSensitivityText (wxCommandEvent &event)

void	OnGainText (wxCommandEvent &event)

void	OnFreqText (wxCommandEvent &event)

void	OnTimeText (wxCommandEvent &event)

void	OnSensitivitySlider (wxCommandEvent &event)

void	OnGainSlider (wxCommandEvent &event)

void	OnFreqSlider (wxCommandEvent &event)

void	OnTimeSlider (wxCommandEvent &event)

Detailed Description

Dialog used with EffectNoiseRemoval.

Definition at line 137 of file NoiseRemoval.h.

Constructor & Destructor Documentation

◆ NoiseRemovalDialog()

NoiseRemovalDialog::NoiseRemovalDialog	(	EffectNoiseRemoval *	effect,
		EffectSettingsAccess &	access,
		wxWindow *	parent
	)

Definition at line 650 of file NoiseRemoval.cpp.

   : EffectDialog( parent, XO("Noise Removal"), EffectTypeProcess)
   , mAccess{ access }
{
   m_pEffect = effect;
 
   // NULL out the control members until the controls are created.
   m_pButton_GetProfile = NULL;
   m_pButton_Preview = NULL;
   m_pButton_RemoveNoise = NULL;
 
   Init();
 
   m_pButton_Preview =
      (wxButton *)wxWindow::FindWindowById(ID_EFFECT_PREVIEW, this);
   m_pButton_RemoveNoise =
      (wxButton *)wxWindow::FindWindowById(wxID_OK, this);
}

Member Function Documentation

◆ MakeNoiseRemovalDialog()

wxSizer * NoiseRemovalDialog::MakeNoiseRemovalDialog	(	bool	call_fit = `true`,
		bool	set_sizer = `true`
	)

◆ OnCancel()

void NoiseRemovalDialog::OnCancel ( wxCommandEvent & event )

private

Definition at line 717 of file NoiseRemoval.cpp.

{
   EndModal(0);
}

◆ OnFreqSlider()

void NoiseRemovalDialog::OnFreqSlider ( wxCommandEvent & event )

private

Definition at line 847 of file NoiseRemoval.cpp.

{
   mFreq = mFreqS->GetValue() * 10;
   mFreqT->SetValue(wxString::Format(wxT("%d"), (int)mFreq));
}

References mFreq, mFreqS, mFreqT, and wxT().

Here is the call graph for this function:

◆ OnFreqText()

void NoiseRemovalDialog::OnFreqText ( wxCommandEvent & event )

private

Definition at line 823 of file NoiseRemoval.cpp.

{
   mFreqT->GetValue().ToDouble(&mFreq);
   mFreqS->SetValue(std::clamp<long>(mFreq / 10, FREQ_MIN, FREQ_MAX));
}

References FREQ_MAX, FREQ_MIN, mFreq, mFreqS, and mFreqT.

◆ OnGainSlider()

void NoiseRemovalDialog::OnGainSlider ( wxCommandEvent & event )

private

Definition at line 841 of file NoiseRemoval.cpp.

{
   mGain = mGainS->GetValue();
   mGainT->SetValue(wxString::Format(wxT("%d"), (int)mGain));
}

References mGain, mGainS, mGainT, and wxT().

Here is the call graph for this function:

◆ OnGainText()

void NoiseRemovalDialog::OnGainText ( wxCommandEvent & event )

private

Definition at line 817 of file NoiseRemoval.cpp.

{
   mGainT->GetValue().ToDouble(&mGain);
   mGainS->SetValue(std::clamp<long>(mGain, GAIN_MIN, GAIN_MAX));
}

References GAIN_MAX, GAIN_MIN, mGain, mGainS, and mGainT.

◆ OnGetProfile()

void NoiseRemovalDialog::OnGetProfile ( wxCommandEvent & event )

private

Definition at line 670 of file NoiseRemoval.cpp.

{
   EndModal(1);
}

◆ OnKeepNoise()

void NoiseRemovalDialog::OnKeepNoise ( wxCommandEvent & event )

private

Definition at line 675 of file NoiseRemoval.cpp.

{
   mbLeaveNoise = mKeepNoise->GetValue();
}

References mbLeaveNoise, and mKeepNoise.

◆ OnPreview()

void NoiseRemovalDialog::OnPreview ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from EffectDialog.

Definition at line 680 of file NoiseRemoval.cpp.

{
   // Save & restore parameters around Preview, because we didn't do OK.
   bool oldDoProfile = m_pEffect->mDoProfile;
   bool oldLeaveNoise = m_pEffect->mbLeaveNoise;
   double oldSensitivity = m_pEffect->mSensitivity;
   double oldGain = m_pEffect->mNoiseGain;
   double oldFreq = m_pEffect->mFreqSmoothingHz;
   double oldTime = m_pEffect->mAttackDecayTime;
 
   TransferDataFromWindow();
 
   m_pEffect->mDoProfile = false;
   m_pEffect->mbLeaveNoise = mbLeaveNoise;
   m_pEffect->mSensitivity = mSensitivity;
   m_pEffect->mNoiseGain = -mGain;
   m_pEffect->mFreqSmoothingHz =  mFreq;
   m_pEffect->mAttackDecayTime =  mTime;
 
   auto cleanup = finally( [&] {
      m_pEffect->mSensitivity = oldSensitivity;
      m_pEffect->mNoiseGain = oldGain;
      m_pEffect->mFreqSmoothingHz =  oldFreq;
      m_pEffect->mAttackDecayTime =  oldTime;
      m_pEffect->mbLeaveNoise = oldLeaveNoise;
      m_pEffect->mDoProfile = oldDoProfile;
   } );
 
   EffectPreview(*m_pEffect, mAccess, false);
}

References EffectPreview(), m_pEffect, mAccess, EffectNoiseRemoval::mAttackDecayTime, EffectNoiseRemoval::mbLeaveNoise, mbLeaveNoise, EffectNoiseRemoval::mDoProfile, mFreq, EffectNoiseRemoval::mFreqSmoothingHz, mGain, EffectNoiseRemoval::mNoiseGain, EffectNoiseRemoval::mSensitivity, mSensitivity, mTime, and TransferDataFromWindow().

Here is the call graph for this function:

◆ OnRemoveNoise()

void NoiseRemovalDialog::OnRemoveNoise ( wxCommandEvent & event )

private

Definition at line 711 of file NoiseRemoval.cpp.

{
   mbLeaveNoise = mKeepNoise->GetValue();
   EndModal(2);
}

References mbLeaveNoise, and mKeepNoise.

◆ OnSensitivitySlider()

void NoiseRemovalDialog::OnSensitivitySlider ( wxCommandEvent & event )

private

Definition at line 835 of file NoiseRemoval.cpp.

{
   mSensitivity = mSensitivityS->GetValue()/100.0 - 20.0;
   mSensitivityT->SetValue(wxString::Format(wxT("%.2f"), mSensitivity));
}

References mSensitivity, mSensitivityS, mSensitivityT, and wxT().

Here is the call graph for this function:

◆ OnSensitivityText()

void NoiseRemovalDialog::OnSensitivityText ( wxCommandEvent & event )

private

Definition at line 811 of file NoiseRemoval.cpp.

{
   mSensitivityT->GetValue().ToDouble(&mSensitivity);
   mSensitivityS->SetValue(std::clamp<long>(mSensitivity*100.0 + (SENSITIVITY_MAX-SENSITIVITY_MIN+1)/2.0, SENSITIVITY_MIN, SENSITIVITY_MAX));
}

References mSensitivity, mSensitivityS, mSensitivityT, SENSITIVITY_MAX, and SENSITIVITY_MIN.

◆ OnTimeSlider()

void NoiseRemovalDialog::OnTimeSlider ( wxCommandEvent & event )

private

Definition at line 853 of file NoiseRemoval.cpp.

{
   mTime = mTimeS->GetValue() / (TIME_MAX*1.0);
   mTimeT->SetValue(wxString::Format(wxT("%.2f"), mTime));
}

References mTime, mTimeS, mTimeT, TIME_MAX, and wxT().

Here is the call graph for this function:

◆ OnTimeText()

void NoiseRemovalDialog::OnTimeText ( wxCommandEvent & event )

private

Definition at line 829 of file NoiseRemoval.cpp.

{
   mTimeT->GetValue().ToDouble(&mTime);
   mTimeS->SetValue(std::clamp<long>(mTime * TIME_MAX + 0.5, TIME_MIN, TIME_MAX));
}

References mTime, mTimeS, mTimeT, TIME_MAX, and TIME_MIN.

◆ PopulateOrExchange()

void NoiseRemovalDialog::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 722 of file NoiseRemoval.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 remove noise.\n"));
 
      S.StartMultiColumn(3, wxEXPAND);
      S.SetStretchyCol(2);
      {
         mGainT = S.Id(ID_GAIN_TEXT)
            .Validator<wxTextValidator>(wxFILTER_NUMERIC)
            .AddTextBox(XXO("Noise re&duction (dB):"), wxT(""), 0);
 
         mGainS = S.Id(ID_GAIN_SLIDER)
            .Name(XO("Noise reduction"))
            .Style(wxSL_HORIZONTAL)
            .MinSize( { 150, -1 } )
            .AddSlider( {}, 0, GAIN_MAX, GAIN_MIN);
 
         mSensitivityT = S.Id(ID_SENSITIVITY_TEXT)
            .Validator<wxTextValidator>(wxFILTER_NUMERIC)
            .AddTextBox(XXO("&Sensitivity (dB):"), wxT(""), 0);
         mSensitivityS = S.Id(ID_SENSITIVITY_SLIDER)
            .Name(XO("Sensitivity"))
            .Style(wxSL_HORIZONTAL)
            .MinSize( { 150, -1 } )
            .AddSlider( {}, 0, SENSITIVITY_MAX, SENSITIVITY_MIN);
 
         mFreqT = S.Id(ID_FREQ_TEXT)
            .Validator<wxTextValidator>(wxFILTER_NUMERIC)
            .AddTextBox(XXO("Fr&equency smoothing (Hz):"), wxT(""), 0);
         mFreqS = S.Id(ID_FREQ_SLIDER)
            .Name(XO("Frequency smoothing"))
            .Style(wxSL_HORIZONTAL)
            .MinSize( { 150, -1 } )
            .AddSlider( {}, 0, FREQ_MAX, FREQ_MIN);
 
         mTimeT = S.Id(ID_TIME_TEXT)
            .Validator<wxTextValidator>(wxFILTER_NUMERIC)
            .AddTextBox(XXO("Attac&k/decay time (secs):"), wxT(""), 0);
         mTimeS = S.Id(ID_TIME_SLIDER)
            .Name(XO("Attack/decay time"))
            .Style(wxSL_HORIZONTAL)
            .MinSize( { 150, -1 } )
            .AddSlider( {}, 0, TIME_MAX, TIME_MIN);
 
         S.AddPrompt(XXO("Noise:"));
         mKeepSignal = S.Id(ID_RADIOBUTTON_KEEPSIGNAL)
               .AddRadioButton(XXO("Re&move"));
         mKeepNoise = S.Id(ID_RADIOBUTTON_KEEPNOISE)
               .AddRadioButtonToGroup(XXO("&Isolate"));
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
}

References FREQ_MAX, FREQ_MIN, GAIN_MAX, GAIN_MIN, ID_BUTTON_GETPROFILE, ID_FREQ_SLIDER, ID_FREQ_TEXT, ID_GAIN_SLIDER, ID_GAIN_TEXT, ID_RADIOBUTTON_KEEPNOISE, ID_RADIOBUTTON_KEEPSIGNAL, ID_SENSITIVITY_SLIDER, ID_SENSITIVITY_TEXT, ID_TIME_SLIDER, ID_TIME_TEXT, m_pButton_GetProfile, mFreqS, mFreqT, mGainS, mGainT, mKeepNoise, mKeepSignal, mSensitivityS, mSensitivityT, mTimeS, mTimeT, S, SENSITIVITY_MAX, SENSITIVITY_MIN, TIME_MAX, TIME_MIN, wxT(), XO(), and XXO().

Here is the call graph for this function:

◆ TransferDataFromWindow()

bool NoiseRemovalDialog::TransferDataFromWindow ( )

override

Definition at line 805 of file NoiseRemoval.cpp.

{
   // Nothing to do here
   return true;
}

Referenced by OnPreview().

Here is the caller graph for this function:

◆ TransferDataToWindow()

bool NoiseRemovalDialog::TransferDataToWindow ( )

override

Definition at line 788 of file NoiseRemoval.cpp.

{
   mSensitivityT->SetValue(wxString::Format(wxT("%.2f"), mSensitivity));
   mGainT->SetValue(wxString::Format(wxT("%d"), (int)mGain));
   mFreqT->SetValue(wxString::Format(wxT("%d"), (int)mFreq));
   mTimeT->SetValue(wxString::Format(wxT("%.2f"), mTime));
   mKeepNoise->SetValue(mbLeaveNoise);
   mKeepSignal->SetValue(!mbLeaveNoise);
 
   mSensitivityS->SetValue(std::clamp<long>(mSensitivity*100.0 + (SENSITIVITY_MAX-SENSITIVITY_MIN+1)/2.0, SENSITIVITY_MIN, SENSITIVITY_MAX));
   mGainS->SetValue(std::clamp<long>(mGain, GAIN_MIN, GAIN_MAX));
   mFreqS->SetValue(std::clamp<long>(mFreq / 10, FREQ_MIN, FREQ_MAX));
   mTimeS->SetValue(std::clamp<long>(mTime * TIME_MAX + 0.5, TIME_MIN, TIME_MAX));
 
   return true;
}