A two-pass effect to reduce background noise. More...

#include <NoiseReduction.h>

Inheritance diagram for EffectNoiseReduction:

Collaboration diagram for EffectNoiseReduction:

Classes
class	Dialog
	Dialog used with EffectNoiseReduction. More...

class	Settings

class	Statistics

class	Worker

Public Member Functions
	EffectNoiseReduction ()

virtual	~EffectNoiseReduction ()

ComponentInterfaceSymbol	GetSymbol () override

TranslatableString	GetDescription () override

EffectType	GetType () override

bool	ShowInterface (wxWindow &parent, const EffectDialogFactory &factory, bool forceModal=false) override

bool	Init () override

bool	CheckWhetherSkipEffect () override

bool	Process () override

bool	TrackProgress (int whichTrack, double frac, const TranslatableString &={})

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () override

VendorSymbol	GetVendor () override

wxString	GetVersion () override

EffectFamilySymbol	GetFamily () override

bool	IsInteractive () override

bool	IsDefault () override

bool	IsLegacy () override

bool	SupportsRealtime () override

bool	SupportsAutomation () override

bool	SetHost (EffectHostInterface *host) override

unsigned	GetAudioInCount () override

unsigned	GetAudioOutCount () override

int	GetMidiInCount () override

int	GetMidiOutCount () override

sampleCount	GetLatency () override

size_t	GetTailSize () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

bool	IsReady () override

bool	ProcessInitialize (sampleCount totalLen, ChannelNames chanMap=NULL) override

bool	ProcessFinalize () override

size_t	ProcessBlock (float inBlock, float outBlock, size_t blockLen) override

bool	RealtimeInitialize () override

bool	RealtimeAddProcessor (unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	RealtimeProcessStart () override

size_t	RealtimeProcess (int group, float inbuf, float outbuf, size_t numSamples) override

bool	RealtimeProcessEnd () override

bool	GetAutomationParameters (CommandParameters &parms) override

bool	SetAutomationParameters (CommandParameters &parms) override

bool	LoadUserPreset (const RegistryPath &name) override

bool	SaveUserPreset (const RegistryPath &name) override

RegistryPaths	GetFactoryPresets () override

bool	LoadFactoryPreset (int id) override

bool	LoadFactoryDefaults () override

void	SetHostUI (EffectUIHostInterface *host) override

bool	PopulateUI (ShuttleGui &S) final

bool	IsGraphicalUI () override

bool	ValidateUI () override

bool	HideUI () override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets () override

void	ImportPresets () override

bool	HasOptions () override

void	ShowOptions () override

double	GetDefaultDuration () override

double	GetDuration () override

NumericFormatSymbol	GetDurationFormat () override

virtual NumericFormatSymbol	GetSelectionFormat ()

void	SetDuration (double duration) override

RegistryPath	GetUserPresetsGroup (const RegistryPath &name) override

RegistryPath	GetCurrentSettingsGroup () override

RegistryPath	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

bool	HasSharedConfigGroup (const RegistryPath &group) override

bool	GetSharedConfigSubgroups (const RegistryPath &group, RegistryPaths &subgroups) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval={}) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, int &value, int defval=0) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, bool &value, bool defval=false) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, float &value, float defval=0.0) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, double &value, double defval=0.0) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const wxString &value) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const int &value) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const bool &value) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const float &value) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const double &value) override

bool	RemoveSharedConfigSubgroup (const RegistryPath &group) override

bool	RemoveSharedConfig (const RegistryPath &group, const RegistryPath &key) override

bool	HasPrivateConfigGroup (const RegistryPath &group) override

bool	GetPrivateConfigSubgroups (const RegistryPath &group, RegistryPaths &paths) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval={}) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, int &value, int defval=0) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, bool &value, bool defval=false) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, float &value, float defval=0.0) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, double &value, double defval=0.0) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const wxString &value) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const int &value) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const bool &value) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const float &value) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const double &value) override

bool	RemovePrivateConfigSubgroup (const RegistryPath &group) override

bool	RemovePrivateConfig (const RegistryPath &group, const RegistryPath &key) override

virtual PluginID	GetID ()

virtual bool	Startup (EffectClientInterface *client)

virtual bool	Startup ()

virtual bool	GetAutomationParameters (wxString &parms)

virtual bool	SetAutomationParameters (const wxString &parms)

virtual RegistryPaths	GetUserPresets ()

virtual bool	HasCurrentSettings ()

virtual bool	HasFactoryDefaults ()

virtual ManualPageID	ManualPage ()

virtual FilePath	HelpPage ()

virtual void	SetUIFlags (unsigned flags)

virtual unsigned	TestUIFlags (unsigned mask)

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

bool	DoEffect (double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={})

bool	Delegate (Effect &delegate, wxWindow &parent, const EffectDialogFactory &factory)

virtual bool	IsHidden ()

int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

Public Member Functions inherited from EffectClientInterface
virtual	~EffectClientInterface ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetClassification ()

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

TranslatableString	GetName ()

virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

Public Member Functions inherited from EffectHostInterface
virtual	~EffectHostInterface ()

Public Member Functions inherited from ConfigClientInterface
virtual	~ConfigClientInterface ()

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Noise Reduction") }

Static Public Attributes inherited from Effect
static const wxString	kUserPresetIdent = wxT("User Preset:")

static const wxString	kFactoryPresetIdent = wxT("Factory Preset:")

static const wxString	kCurrentSettingsIdent = wxT("<Current Settings>")

static const wxString	kFactoryDefaultsIdent = wxT("<Factory Defaults>")

Private Attributes
std::unique_ptr< Settings >	mSettings

std::unique_ptr< Statistics >	mStatistics

Friends
class	Dialog

Additional Inherited Members
Public Types inherited from Effect
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

using	VetoDialogHook = bool()(wxDialog )

Public Types inherited from EffectClientInterface
using	EffectDialogFactory = std::function< wxDialog (wxWindow &parent, EffectHostInterface , EffectUIClientInterface *) >

Static Public Member Functions inherited from Effect
static VetoDialogHook	SetVetoDialogHook (VetoDialogHook hook)

static CommandID	GetSquashedName (wxString name)

static void	IncEffectCounter ()

Protected Member Functions inherited from Effect
virtual bool	ProcessPass ()

virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual int	GetPass ()

virtual void	End ()

virtual double	CalcPreviewInputLength (double previewLength)

virtual void	Preview (bool dryOnly)

virtual void	PopulateOrExchange (ShuttleGui &S)

virtual bool	TransferDataToWindow ()

virtual bool	TransferDataFromWindow ()

virtual bool	EnableApply (bool enable=true)

virtual bool	EnablePreview (bool enable=true)

virtual void	EnableDebug (bool enable=true)

bool	TotalProgress (double frac, const TranslatableString &={})

bool	TrackProgress (int whichTrack, double frac, const TranslatableString &={})

bool	TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={})

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

void	GetBounds (const WaveTrack &track, const WaveTrack pRight, sampleCount start, sampleCount *len)

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks (bool allSyncLockSelected=false)

std::shared_ptr< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())

void	ReplaceProcessedTracks (const bool bGoodResult)

Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes inherited from Effect
ProgressDialog *	mProgress

double	mProjectRate

double	mSampleRate

wxWeakRef< NotifyingSelectedRegion >	mpSelectedRegion {}

WaveTrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxDialog *	mUIDialog

wxWindow *	mUIParent

int	mUIResultID

unsigned	mUIFlags

sampleCount	mSampleCnt

Static Protected Attributes inherited from Effect
static int	nEffectsDone =0

Detailed Description

A two-pass effect to reduce background noise.

The first pass is done over just noise. For each windowed sample of the sound, we take a FFT and then statistics are tabulated for each frequency band.

During the noise reduction phase, we start by setting a gain control for each frequency band such that if the sound has exceeded the previously-determined threshold, the gain is set to 0 dB, otherwise the gain is set lower (e.g. -18 dB), to suppress the noise. Then time-smoothing is applied so that the gain for each frequency band moves slowly, and then frequency-smoothing is applied so that a single frequency is never suppressed or boosted in isolation. Lookahead is employed; this effect is not designed for real-time but if it were, there would be a significant delay.

The gain controls are applied to the complex FFT of the signal, and then the inverse FFT is applied. A Hann window may be applied (depending on the advanced window types setting), and then the output signal is then pieced together using overlap/add.

Definition at line 18 of file NoiseReduction.h.

Constructor & Destructor Documentation

◆ EffectNoiseReduction()

EffectNoiseReduction::EffectNoiseReduction ( )

Definition at line 410 of file NoiseReduction.cpp.

 : mSettings(std::make_unique<EffectNoiseReduction::Settings>())
 {
    Init();
 }

References Init().

Here is the call graph for this function:

◆ ~EffectNoiseReduction()

EffectNoiseReduction::~EffectNoiseReduction ( )

virtual

Definition at line 416 of file NoiseReduction.cpp.

417 {

418 }

Member Function Documentation

◆ CheckWhetherSkipEffect()

bool EffectNoiseReduction::CheckWhetherSkipEffect ( )

overridevirtual

Reimplemented from Effect.

Definition at line 444 of file NoiseReduction.cpp.

 {
    return false;
 }

◆ GetDescription()

TranslatableString EffectNoiseReduction::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 427 of file NoiseReduction.cpp.

 {
    return XO("Removes background noise such as fans, tape noise, or hums");
 }

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectNoiseReduction::GetSymbol ( )

overridevirtual

Reimplemented from Effect.

Definition at line 422 of file NoiseReduction.cpp.

 {
    return Symbol;
 }

References Symbol.

◆ GetType()

EffectType EffectNoiseReduction::GetType ( )

overridevirtual

Reimplemented from Effect.

Definition at line 434 of file NoiseReduction.cpp.

 {
    return EffectTypeProcess;
 }

References EffectTypeProcess.

◆ Init()

bool EffectNoiseReduction::Init ( )

overridevirtual

Reimplemented from Effect.

Definition at line 439 of file NoiseReduction.cpp.

 {
    return true;
 }

Referenced by EffectNoiseReduction().

Here is the caller graph for this function:

◆ Process()

bool EffectNoiseReduction::Process ( )

overridevirtual

Reimplemented from Effect.

Definition at line 616 of file NoiseReduction.cpp.

 {
    // This same code will either reduce noise or profile it
  
    this->CopyInputTracks(); // Set up mOutputTracks.
  
    auto track = * (mOutputTracks->Selected< const WaveTrack >()).begin();
    if (!track)
       return false;
  
    // Initialize statistics if gathering them, or check for mismatched (advanced)
    // settings if reducing noise.
    if (mSettings->mDoProfile) {
       size_t spectrumSize = 1 + mSettings->WindowSize() / 2;
       mStatistics = std::make_unique<Statistics>
          (spectrumSize, track->GetRate(), mSettings->mWindowTypes);
    }
    else if (mStatistics->mWindowSize != mSettings->WindowSize()) {
       // possible only with advanced settings
       ::Effect::MessageBox(
          XO("You must specify the same window size for steps 1 and 2.") );
       return false;
    }
    else if (mStatistics->mWindowTypes != mSettings->mWindowTypes) {
       // A warning only
       ::Effect::MessageBox(
          XO("Warning: window types are not the same as for profiling.") );
    }
  
    eWindowFunctions inWindowType, outWindowType;
    switch (mSettings->mWindowTypes) {
    case WT_RECTANGULAR_HANN:
       inWindowType = eWinFuncRectangular;
       outWindowType = eWinFuncHann;
       break;
    case WT_HANN_RECTANGULAR:
       inWindowType = eWinFuncHann;
       outWindowType = eWinFuncRectangular;
       break;
    case WT_BLACKMAN_HANN:
       inWindowType = eWinFuncBlackman;
       outWindowType = eWinFuncHann;
       break;
    case WT_HAMMING_RECTANGULAR:
       inWindowType = eWinFuncHamming;
       outWindowType = eWinFuncRectangular;
       break;
    case WT_HAMMING_HANN:
       inWindowType = eWinFuncHamming;
       outWindowType = eWinFuncHann;
       break;
    default:
       wxASSERT(false);
       [[fallthrough]] ;
    case WT_HANN_HANN:
       inWindowType = outWindowType = eWinFuncHann;
       break;
    }
    Worker worker{ inWindowType, outWindowType,
       *this, *mSettings, *mStatistics
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
       , mF0, mF1
 #endif
    };
    bool bGoodResult = worker.Process(*mOutputTracks, mT0, mT1);
    if (mSettings->mDoProfile) {
       if (bGoodResult)
          mSettings->mDoProfile = false; // So that "repeat last effect" will reduce noise
       else
          mStatistics.reset(); // So that profiling must be done again before noise reduction
    }
    this->ReplaceProcessedTracks(bGoodResult);
    return bGoodResult;
 }

References Effect::CopyInputTracks(), eWinFuncBlackman, eWinFuncHamming, eWinFuncHann, eWinFuncRectangular, Effect::MessageBox(), Effect::mOutputTracks, mSettings, mStatistics, Effect::mT0, Effect::mT1, Effect::ReplaceProcessedTracks(), anonymous_namespace{NoiseReduction.cpp}::WT_BLACKMAN_HANN, anonymous_namespace{NoiseReduction.cpp}::WT_HAMMING_HANN, anonymous_namespace{NoiseReduction.cpp}::WT_HAMMING_RECTANGULAR, anonymous_namespace{NoiseReduction.cpp}::WT_HANN_HANN, anonymous_namespace{NoiseReduction.cpp}::WT_HANN_RECTANGULAR, anonymous_namespace{NoiseReduction.cpp}::WT_RECTANGULAR_HANN, and XO.

Here is the call graph for this function:

◆ ShowInterface()

bool EffectNoiseReduction::ShowInterface	(	wxWindow &	parent,
		const EffectDialogFactory &	factory,
		bool	forceModal = `false`
	)

overridevirtual

Reimplemented from Effect.

Definition at line 449 of file NoiseReduction.cpp.

 {
    // to do: use forceModal correctly
  
    // Doesn't use the factory but substitutes its own dialog
  
    // We may want to twiddle the levels if we are setting
    // from an automation dialog
    return mSettings->PromptUser(this, parent,
       bool(mStatistics), forceModal);
 }

References mSettings, and mStatistics.

◆ TrackProgress()

bool Effect::TrackProgress

Definition at line 339 of file Effect.cpp.

 {
    auto updateResult = (mProgress ?
       mProgress->Update(whichTrack + frac, (double) mNumTracks, msg) :
       ProgressResult::Success);
    return (updateResult != ProgressResult::Success);
 }

References EffectClientInterface::GetLatency(), and Effect::mClient.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ Dialog

friend class Dialog

friend

Definition at line 53 of file NoiseReduction.h.

Member Data Documentation

◆ mSettings

std::unique_ptr<Settings> EffectNoiseReduction::mSettings

private

Definition at line 55 of file NoiseReduction.h.

Referenced by Process(), and ShowInterface().

◆ mStatistics

std::unique_ptr<Statistics> EffectNoiseReduction::mStatistics

private

Definition at line 56 of file NoiseReduction.h.

Referenced by EffectNoiseReduction::Worker::Classify(), EffectNoiseReduction::Worker::FinishTrackStatistics(), EffectNoiseReduction::Worker::GatherStatistics(), Process(), EffectNoiseReduction::Worker::Process(), and ShowInterface().

◆ Symbol

const ComponentInterfaceSymbol EffectNoiseReduction::Symbol { XO("Noise Reduction") }

static

Definition at line 20 of file NoiseReduction.h.

Referenced by GetSymbol().

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

Classes

Public Member Functions

Static Public Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectNoiseReduction()

◆ ~EffectNoiseReduction()

Member Function Documentation

◆ CheckWhetherSkipEffect()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ Init()

◆ Process()

◆ ShowInterface()

◆ TrackProgress()

Friends And Related Function Documentation

◆ Dialog

Member Data Documentation

◆ mSettings

◆ mStatistics

◆ Symbol