Effect Class Reference

Base class for many of the effects in Audacity. More...

#include <Effect.h>

Inheritance diagram for Effect:

Classes
class	AddedAnalysisTrack
class	ModifiedAnalysisTrack

Public Types
enum	: long { DefaultMessageBoxStyle = wxOK | wxCENTRE }

Public Member Functions
	Effect ()
virtual	~Effect ()
wxString	GetPath () override
wxString	GetSymbol () override
wxString	GetName () override
wxString	GetVendor () override
wxString	GetVersion () override
wxString	GetDescription () override
EffectType	GetType () override
wxString	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
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	ShowInterface (wxWindow *parent, bool forceModal=false) override
bool	GetAutomationParameters (EffectAutomationParameters &parms) override
bool	SetAutomationParameters (EffectAutomationParameters &parms) override
bool	LoadUserPreset (const wxString &name) override
bool	SaveUserPreset (const wxString &name) override
wxArrayString	GetFactoryPresets () override
bool	LoadFactoryPreset (int id) override
bool	LoadFactoryDefaults () override
void	SetHostUI (EffectUIHostInterface *host) override
bool	PopulateUI (wxWindow *parent) override
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
wxString	GetDurationFormat () override
virtual wxString	GetSelectionFormat ()
void	SetDuration (double duration) override
bool	Apply () override
void	Preview () override
wxDialog *	CreateUI (wxWindow *parent, EffectUIClientInterface *client) override
wxString	GetUserPresetsGroup (const wxString &name) override
wxString	GetCurrentSettingsGroup () override
wxString	GetFactoryDefaultsGroup () override
virtual wxString	GetSavedStateGroup ()
bool	HasSharedConfigGroup (const wxString &group) override
bool	GetSharedConfigSubgroups (const wxString &group, wxArrayString &subgroups) override
bool	GetSharedConfig (const wxString &group, const wxString &key, wxString &value, const wxString &defval=wxEmptyString) override
bool	GetSharedConfig (const wxString &group, const wxString &key, int &value, int defval=0) override
bool	GetSharedConfig (const wxString &group, const wxString &key, bool &value, bool defval=false) override
bool	GetSharedConfig (const wxString &group, const wxString &key, float &value, float defval=0.0) override
bool	GetSharedConfig (const wxString &group, const wxString &key, double &value, double defval=0.0) override
bool	SetSharedConfig (const wxString &group, const wxString &key, const wxString &value) override
bool	SetSharedConfig (const wxString &group, const wxString &key, const int &value) override
bool	SetSharedConfig (const wxString &group, const wxString &key, const bool &value) override
bool	SetSharedConfig (const wxString &group, const wxString &key, const float &value) override
bool	SetSharedConfig (const wxString &group, const wxString &key, const double &value) override
bool	RemoveSharedConfigSubgroup (const wxString &group) override
bool	RemoveSharedConfig (const wxString &group, const wxString &key) override
bool	HasPrivateConfigGroup (const wxString &group) override
bool	GetPrivateConfigSubgroups (const wxString &group, wxArrayString &subgroups) override
bool	GetPrivateConfig (const wxString &group, const wxString &key, wxString &value, const wxString &defval=wxEmptyString) override
bool	GetPrivateConfig (const wxString &group, const wxString &key, int &value, int defval=0) override
bool	GetPrivateConfig (const wxString &group, const wxString &key, bool &value, bool defval=false) override
bool	GetPrivateConfig (const wxString &group, const wxString &key, float &value, float defval=0.0) override
bool	GetPrivateConfig (const wxString &group, const wxString &key, double &value, double defval=0.0) override
bool	SetPrivateConfig (const wxString &group, const wxString &key, const wxString &value) override
bool	SetPrivateConfig (const wxString &group, const wxString &key, const int &value) override
bool	SetPrivateConfig (const wxString &group, const wxString &key, const bool &value) override
bool	SetPrivateConfig (const wxString &group, const wxString &key, const float &value) override
bool	SetPrivateConfig (const wxString &group, const wxString &key, const double &value) override
bool	RemovePrivateConfigSubgroup (const wxString &group) override
bool	RemovePrivateConfig (const wxString &group, const wxString &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 wxArrayString	GetUserPresets ()
virtual bool	HasCurrentSettings ()
virtual bool	HasFactoryDefaults ()
virtual wxString	GetPreset (wxWindow *parent, const wxString &parms)
virtual wxString	ManualPage ()
virtual wxString	HelpPage ()
virtual bool	IsBatchProcessing ()
virtual void	SetBatchProcessing (bool start)
void	SetPresetParameters (const wxArrayString *Names, const wxArrayString *Values)
bool	DoEffect (wxWindow *parent, double projectRate, TrackList *list, TrackFactory *factory, SelectedRegion *selectedRegion, bool shouldPrompt=true)
bool	Delegate (Effect &delegate, wxWindow *parent, SelectedRegion *selectedRegion, bool shouldPrompt)
bool	RealtimeAddProcessor (int group, unsigned chans, float rate)
size_t	RealtimeProcess (int group, unsigned chans, float **inbuf, float **outbuf, size_t numSamples)
bool	IsRealtimeActive ()
virtual bool	IsHidden ()
int	MessageBox (const wxString &message, long style=DefaultMessageBoxStyle, const wxString &titleStr=wxString{})

Protected Member Functions
virtual bool	Init ()
virtual bool	PromptUser (wxWindow *parent)
virtual bool	CheckWhetherSkipEffect ()
virtual bool	Process ()
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)
bool	TrackProgress (int whichTrack, double frac, const wxString &=wxEmptyString)
bool	TrackGroupProgress (int whichGroup, double frac, const wxString &=wxEmptyString)
int	GetNumWaveTracks ()
int	GetNumWaveGroups ()
void	GetSamples (const WaveTrack *track, sampleCount *start, sampleCount *len)
void	SetLinearEffectFlag (bool linearEffectFlag)
void	SetPreviewFullSelectionFlag (bool previewDurationFlag)
bool	IsPreviewing ()
void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)
void	CopyInputTracks ()
void	CopyInputTracks (int trackType)
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 (std::unique_ptr< Track > &&t)
TrackList *	inputTracks () const

Protected Attributes
ProgressDialog *	mProgress
double	mProjectRate
double	mSampleRate
TrackFactory *	mFactory
std::shared_ptr< TrackList >	mOutputTracks
double	mT0
double	mT1
double	mF0
double	mF1
wxArrayString	mPresetNames
wxArrayString	mPresetValues
int	mPass
wxDialog *	mUIDialog
wxWindow *	mUIParent
int	mUIResultID
sampleCount	mSampleCnt
int	mOutputTracksType

Private Member Functions
void	CommonInit ()
void	CountWaveTracks ()
bool	ProcessTrack (int count, ChannelNames map, WaveTrack *left, WaveTrack *right, sampleCount leftStart, sampleCount rightStart, sampleCount len, FloatBuffers &inBuffer, FloatBuffers &outBuffer, ArrayOf< float * > &inBufPos, ArrayOf< float * > &outBufPos)

Private Attributes
TrackList *	mTracks
bool	mIsBatch
bool	mIsLinearEffect
bool	mPreviewWithNotSelected
bool	mPreviewFullSelection
bool	mIsSelection
double	mDuration
wxString	mDurationFormat
bool	mIsPreview
bool	mUIDebug
std::vector< Track * >	mIMap
std::vector< Track * >	mOMap
int	mNumTracks
int	mNumGroups
EffectClientInterface *	mClient
size_t	mNumAudioIn
size_t	mNumAudioOut
size_t	mBufferSize
size_t	mBlockSize
unsigned	mNumChannels
wxArrayInt	mGroupProcessor
int	mCurrentProcessor
wxCriticalSection	mRealtimeSuspendLock
int	mRealtimeSuspendCount

Static Private Attributes
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>")

Friends
class	EffectManager
class	EffectRack
class	EffectUIHost
class	EffectPresetsDialog

Detailed Description

Base class for many of the effects in Audacity.

Member Enumeration Documentation

anonymous enum : long

Enumerator
DefaultMessageBoxStyle

Constructor & Destructor Documentation

Effect::Effect

(

)

References GetActiveProject(), AudacityProject::GetRate(), mBlockSize, mBufferSize, mClient, mDuration, mIsBatch, mIsLinearEffect, mIsPreview, mNumAudioIn, mNumAudioOut, mNumChannels, mNumGroups, mNumTracks, mOutputTracksType, mPreviewFullSelection, mPreviewWithNotSelected, mProgress, mProjectRate, mRealtimeSuspendCount, mRealtimeSuspendLock, mT0, mT1, mTracks, mUIDebug, mUIDialog, mUIParent, and Track::None.

Effect::~Effect ( )

virtual

References mUIDialog.

Member Function Documentation

auto Effect::AddAnalysisTrack ( const wxString &  name = wxString() )

protected

References name, and safenew.

Referenced by EffectFindClipping::Process().

Track * Effect::AddToOutputTracks ( std::unique_ptr< Track > &&  t )

protected

References mIMap, mOMap, and mOutputTracks.

Referenced by NyquistEffect::ProcessOne().

bool Effect::Apply ( )

override

References GetActiveProject(), GetID(), AudacityProject::OnEffectFlags::kConfigured, and AudacityProject::OnEffect().

double Effect::CalcPreviewInputLength ( double  previewLength )

protectedvirtual

Reimplemented in EffectTruncSilence, EffectChangeSpeed, and EffectPaulstretch.

Referenced by Preview(), and ProcessTrack().

bool Effect::CanExportPresets ( )

override

virtual bool Effect::CheckWhetherSkipEffect ( )

inlineprotectedvirtual

Reimplemented in NyquistEffect, EffectBassTreble, EffectChangeSpeed, EffectClickRemoval, EffectNormalize, and EffectNoiseReduction.

Referenced by DoEffect().

bool Effect::CloseUI ( )

override

References mUIDialog, and mUIParent.

Referenced by EffectEqualization::CloseUI().

void Effect::CommonInit ( )

private

void Effect::CopyInputTracks ( )

protected

References Track::Wave.

Referenced by EffectTwoPassSimpleMono::Process(), EffectSimpleMono::Process(), EffectRepair::Process(), EffectReverse::Process(), EffectStereoToMono::Process(), EffectPaulstretch::Process(), EffectNoiseReduction::Process(), EffectRepeat::Process(), EffectNormalize::Process(), Generator::Process(), EffectClickRemoval::Process(), EffectAutoDuck::Process(), EffectChangeSpeed::Process(), NyquistEffect::Process(), EffectEqualization::Process(), Process(), EffectTruncSilence::ProcessAll(), and EffectTruncSilence::ProcessIndependently().

void Effect::CopyInputTracks ( int  trackType )

protected

References Track::All, TrackList::Create(), TrackListCondIterator::First(), mIMap, mOMap, mOutputTracks, mOutputTracksType, mTracks, and TrackListCondIterator::Next().

void Effect::CountWaveTracks ( )

private

References TrackListCondIterator::First(), Track::GetKind(), Track::GetLinked(), Track::GetSelected(), mNumGroups, mNumTracks, mTracks, TrackListCondIterator::Next(), and Track::Wave.

Referenced by DoEffect(), and Preview().

wxDialog * Effect::CreateUI ( wxWindow *  parent, EffectUIClientInterface *  client  )

override

References safenew.

Referenced by ShowInterface().

bool Effect::Delegate	(	Effect &	delegate,
		wxWindow *	parent,
		SelectedRegion *	selectedRegion,
		bool	shouldPrompt
	)

References DoEffect(), mFactory, mProjectRate, and mTracks.

Referenced by NyquistEffect::ShowInterface().

bool Effect::DoEffect	(	wxWindow *	parent,
		double	projectRate,
		TrackList *	list,
		TrackFactory *	factory,
		SelectedRegion *	selectedRegion,
		bool	shouldPrompt = true
	)

References _(), CheckWhetherSkipEffect(), CountWaveTracks(), SelectedRegion::duration(), End(), SelectedRegion::f0(), SelectedRegion::f1(), GetCurrentSettingsGroup(), GetDefaultDuration(), GetPrivateConfig(), GetType(), Init(), IsInteractive(), mDuration, mDurationFormat, mF0, mF1, mFactory, mOutputTracks, mProgress, mProjectRate, mT0, mT1, mTracks, name, pdlgHideStopButton, Process(), PromptUser(), QUANTIZED_TIME, ReplaceProcessedTracks(), SetPresetParameters(), SelectedRegion::setTimes(), SelectedRegion::t0(), SelectedRegion::t1(), SelectedRegion::UndefinedFrequency, and valueRestorer().

Referenced by Delegate(), and EffectManager::DoEffect().

bool Effect::EnableApply ( bool  enable = true )

protectedvirtual

References EnablePreview(), mUIDialog, and mUIParent.

Referenced by EffectAmplify::CheckClip(), EffectRepeat::DisplayNewTime(), EffectAmplify::OnAmpText(), EffectBassTreble::OnBassSlider(), EffectBassTreble::OnBassText(), EffectTruncSilence::OnControlChange(), EffectToneGen::OnControlUpdate(), EffectScienFilter::OnCutoff(), EffectWahwah::OnDepthSlider(), EffectPhaser::OnDepthSlider(), EffectWahwah::OnDepthText(), EffectPhaser::OnDepthText(), EffectPhaser::OnDryWetSlider(), EffectPhaser::OnDryWetText(), EffectPhaser::OnFeedbackSlider(), EffectPhaser::OnFeedbackText(), EffectWahwah::OnFreqOffSlider(), EffectWahwah::OnFreqOffText(), EffectWahwah::OnFreqSlider(), EffectPhaser::OnFreqSlider(), EffectWahwah::OnFreqText(), EffectPhaser::OnFreqText(), EffectWahwah::OnGainSlider(), EffectPhaser::OnGainSlider(), EffectBassTreble::OnGainSlider(), EffectBassTreble::OnGainText(), EffectWahwah::OnGainText(), EffectPhaser::OnGainText(), EffectAmplify::OnPeakText(), EffectWahwah::OnPhaseSlider(), EffectPhaser::OnPhaseSlider(), EffectWahwah::OnPhaseText(), EffectPhaser::OnPhaseText(), EffectWahwah::OnResonanceSlider(), EffectWahwah::OnResonanceText(), EffectScienFilter::OnRipple(), EffectPhaser::OnStagesSlider(), EffectPhaser::OnStagesText(), EffectScienFilter::OnStopbandRipple(), EffectPaulstretch::OnText(), EffectBassTreble::OnTrebleSlider(), EffectBassTreble::OnTrebleText(), EffectNormalize::UpdateUI(), and EffectChangeSpeed::UpdateUI().

void Effect::EnableDebug ( bool  enable = true )

protectedvirtual

References mUIDebug.

Referenced by NyquistEffect::PopulateOrExchange().

bool Effect::EnablePreview ( bool  enable = true )

protectedvirtual

References kFFwdID, kPlayID, kRewindID, mUIDialog, mUIParent, and SupportsRealtime().

Referenced by EnableApply(), and NyquistEffect::TransferDataToWindow().

void Effect::End ( )

protectedvirtual

Reimplemented in EffectAutoDuck, and EffectStereoToMono.

Referenced by DoEffect(), and Preview().

void Effect::ExportPresets ( )

override

unsigned Effect::GetAudioInCount ( )

override

References mClient.

Referenced by Process(), and Startup().

unsigned Effect::GetAudioOutCount ( )

override

References mClient.

Referenced by Process(), and Startup().

bool Effect::GetAutomationParameters ( EffectAutomationParameters &  parms )

override

References mClient.

Referenced by GetAutomationParameters(), EffectManager::GetEffectParameters(), and SaveUserPreset().

bool Effect::GetAutomationParameters ( wxString &  parms )

virtual

References GetAutomationParameters(), mUIDialog, and TransferDataFromWindow().

wxString Effect::GetCurrentSettingsGroup ( )

override

Referenced by DoEffect(), HasCurrentSettings(), NyquistEffect::Init(), EffectChangeSpeed::OnChoice_Vinyl(), EffectChangeSpeed::PopulateOrExchange(), EffectEqualization::PopulateUI(), SetAutomationParameters(), SetDuration(), EffectNoise::Startup(), EffectNormalize::Startup(), EffectAutoDuck::Startup(), EffectClickRemoval::Startup(), EffectCompressor::Startup(), EffectChangeSpeed::Startup(), EffectDtmf::Startup(), EffectTruncSilence::Startup(), EffectScienFilter::Startup(), EffectReverb::Startup(), EffectEqualization::Startup(), Startup(), EffectChangeSpeed::TransferDataFromWindow(), EffectChangeSpeed::Update_Vinyl(), and EffectEqualization::ValidateUI().

double Effect::GetDefaultDuration ( )

override

Referenced by DoEffect().

wxString Effect::GetDescription ( )

override

References mClient.

double Effect::GetDuration ( )

override

References mDuration.

Referenced by EffectSilence::GenerateTrack(), BlockGenerator::GenerateTrack(), EffectSilence::PopulateOrExchange(), EffectNoise::PopulateOrExchange(), EffectToneGen::PopulateOrExchange(), EffectDtmf::PopulateOrExchange(), Generator::Process(), EffectDtmf::ProcessInitialize(), EffectDtmf::Recalculate(), EffectSilence::TransferDataToWindow(), EffectNoise::TransferDataToWindow(), EffectToneGen::TransferDataToWindow(), and EffectDtmf::TransferDataToWindow().

wxString Effect::GetDurationFormat ( )

override

References mDurationFormat.

Referenced by EffectSilence::PopulateOrExchange(), EffectNoise::PopulateOrExchange(), EffectToneGen::PopulateOrExchange(), and EffectDtmf::PopulateOrExchange().

wxString Effect::GetFactoryDefaultsGroup ( )

override

Referenced by HasFactoryDefaults(), LoadFactoryDefaults(), SetAutomationParameters(), and Startup().

wxArrayString Effect::GetFactoryPresets ( )

override

References mClient.

Referenced by EffectManager::HasPresets(), and SetAutomationParameters().

wxString Effect::GetFamily ( )

override

References mClient, and XO.

Referenced by Preview().

PluginID Effect::GetID ( )

virtual

References PluginManager::GetID(), and mClient.

Referenced by Apply(), GetPrivateConfig(), GetPrivateConfigSubgroups(), GetSharedConfig(), GetSharedConfigSubgroups(), HasPrivateConfigGroup(), HasSharedConfigGroup(), RemovePrivateConfig(), RemovePrivateConfigSubgroup(), RemoveSharedConfig(), RemoveSharedConfigSubgroup(), SetPrivateConfig(), and SetSharedConfig().

sampleCount Effect::GetLatency ( )

override

References mClient.

Referenced by ProcessTrack().

int Effect::GetMidiInCount ( )

override

References mClient.

int Effect::GetMidiOutCount ( )

override

References mClient.

wxString Effect::GetName ( )

override

References GetSymbol(), and mClient.

Referenced by EffectClickRemoval::Process(), EffectPaulstretch::ProcessOne(), and EffectClickRemoval::ProcessOne().

int Effect::GetNumWaveGroups ( )

inlineprotected

Referenced by NyquistEffect::Process().

int Effect::GetNumWaveTracks ( )

inlineprotected

Referenced by EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), EffectAutoDuck::Process(), EffectTwoPassSimpleMono::ProcessOne(), and EffectNoiseReduction::PromptUser().

int Effect::GetPass ( )

protectedvirtual

References mPass.

wxString Effect::GetPath ( )

override

References BUILTIN_EFFECT_PREFIX, GetSymbol(), and mClient.

wxString Effect::GetPreset ( wxWindow *  parent, const wxString &  parms  )

virtual

References EffectPresetsDialog::GetSelected(), and EffectPresetsDialog::SetSelected().

Referenced by EffectManager::GetPreset().

bool Effect::GetPrivateConfig ( const wxString &  group, const wxString &  key, wxString &  value, const wxString &  defval = wxEmptyString  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetPrivateConfig().

Referenced by DoEffect(), LoadUserPreset(), EffectChangeSpeed::PopulateOrExchange(), Startup(), and EffectChangeSpeed::Update_Vinyl().

bool Effect::GetPrivateConfig ( const wxString &  group, const wxString &  key, int &  value, int  defval = 0  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetPrivateConfig().

bool Effect::GetPrivateConfig ( const wxString &  group, const wxString &  key, bool &  value, bool  defval = false  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetPrivateConfig().

bool Effect::GetPrivateConfig ( const wxString &  group, const wxString &  key, float &  value, float  defval = 0.0  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetPrivateConfig().

bool Effect::GetPrivateConfig ( const wxString &  group, const wxString &  key, double &  value, double  defval = 0.0  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetPrivateConfig().

bool Effect::GetPrivateConfigSubgroups ( const wxString &  group, wxArrayString &  subgroups  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetPrivateConfigSubgroups().

Referenced by GetUserPresets().

void Effect::GetSamples ( const WaveTrack *  track, sampleCount *  start, sampleCount *  len  )

protected

References WaveTrack::GetEndTime(), WaveTrack::GetStartTime(), GetType(), WaveTrack::InsertSilence(), mDuration, mT0, mT1, and WaveTrack::TimeToLongSamples().

Referenced by ProcessPass().

wxString Effect::GetSavedStateGroup ( )

virtual

Referenced by SetBatchProcessing().

wxString Effect::GetSelectionFormat ( )

virtual

References GetActiveProject(), and AudacityProject::GetSelectionFormat().

Referenced by EffectRepeat::DisplayNewTime().

bool Effect::GetSharedConfig ( const wxString &  group, const wxString &  key, wxString &  value, const wxString &  defval = wxEmptyString  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetSharedConfig().

bool Effect::GetSharedConfig ( const wxString &  group, const wxString &  key, int &  value, int  defval = 0  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetSharedConfig().

bool Effect::GetSharedConfig ( const wxString &  group, const wxString &  key, bool &  value, bool  defval = false  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetSharedConfig().

bool Effect::GetSharedConfig ( const wxString &  group, const wxString &  key, float &  value, float  defval = 0.0  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetSharedConfig().

bool Effect::GetSharedConfig ( const wxString &  group, const wxString &  key, double &  value, double  defval = 0.0  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetSharedConfig().

bool Effect::GetSharedConfigSubgroups ( const wxString &  group, wxArrayString &  subgroups  )

override

References PluginManager::Get(), GetID(), and PluginManager::GetSharedConfigSubgroups().

wxString Effect::GetSymbol ( )

override

References mClient.

Referenced by GetName(), and GetPath().

size_t Effect::GetTailSize ( )

override

References mClient.

EffectType Effect::GetType ( )

override

References mClient.

Referenced by DoEffect(), GetSamples(), Preview(), ProcessPass(), ProcessTrack(), and SetDuration().

wxArrayString Effect::GetUserPresets ( )

virtual

References GetPrivateConfigSubgroups(), and GetUserPresetsGroup().

Referenced by EffectManager::HasPresets().

wxString Effect::GetUserPresetsGroup ( const wxString &  name )

override

References name.

Referenced by GetUserPresets(), SetAutomationParameters(), and EffectReverb::Startup().

wxString Effect::GetVendor ( )

override

References mClient, and XO.

wxString Effect::GetVersion ( )

override

References AUDACITY_VERSION_STRING, and mClient.

bool Effect::HasCurrentSettings ( )

virtual

References GetCurrentSettingsGroup(), and HasPrivateConfigGroup().

Referenced by EffectManager::GetDefaultPreset(), and EffectManager::HasPresets().

bool Effect::HasFactoryDefaults ( )

virtual

References GetFactoryDefaultsGroup(), and HasPrivateConfigGroup().

Referenced by EffectManager::GetDefaultPreset(), and EffectManager::HasPresets().

bool Effect::HasOptions ( )

override

bool Effect::HasPrivateConfigGroup ( const wxString &  group )

override

References PluginManager::Get(), GetID(), and PluginManager::HasPrivateConfigGroup().

Referenced by HasCurrentSettings(), and HasFactoryDefaults().

bool Effect::HasSharedConfigGroup ( const wxString &  group )

override

References PluginManager::Get(), GetID(), and PluginManager::HasSharedConfigGroup().

wxString Effect::HelpPage ( )

virtual

Reimplemented in NyquistEffect.

bool Effect::HideUI ( )

override

void Effect::ImportPresets ( )

override

void Effect::IncludeNotSelectedPreviewTracks ( bool  includeNotSelected )

protected

References mPreviewWithNotSelected.

bool Effect::Init ( )

protectedvirtual

Reimplemented in EffectEqualization, NyquistEffect, EffectScienFilter, EffectAmplify, EffectChangeSpeed, EffectDtmf, EffectAutoDuck, EffectNoiseReduction, and Generator.

Referenced by DoEffect(), and Preview().

bool Effect::InitPass1 ( )

protectedvirtual

Reimplemented in EffectCompressor, and EffectTwoPassSimpleMono.

Referenced by Process().

bool Effect::InitPass2 ( )

protectedvirtual

Reimplemented in EffectCompressor, and EffectTwoPassSimpleMono.

Referenced by Process().

TrackList* Effect::inputTracks ( ) const

inlineprotected

Referenced by EffectTruncSilence::CalcPreviewInputLength(), EffectAutoDuck::Init(), EffectAmplify::Init(), EffectScienFilter::Init(), EffectCompressor::InitPass1(), EffectEqualization::PopulateOrExchange(), EffectFindClipping::Process(), EffectTruncSilence::ProcessAll(), and EffectTruncSilence::ProcessIndependently().

bool Effect::IsBatchProcessing ( )

virtual

References mIsBatch.

Referenced by EffectAmplify::PopulateOrExchange(), and PromptUser().

bool Effect::IsDefault ( )

override

References mClient.

bool Effect::IsGraphicalUI ( )

override

bool Effect::IsHidden ( )

virtual

Reimplemented in EffectStereoToMono.

Referenced by EffectManager::IsHidden().

bool Effect::IsInteractive ( )

override

References mClient.

Referenced by DoEffect(), and ShowInterface().

bool Effect::IsLegacy ( )

override

References mClient.

bool Effect::IsPreviewing ( )

inlineprotected

Referenced by NyquistEffect::Process(), and EffectPaulstretch::ProcessOne().

bool Effect::IsReady ( )

override

References mClient.

bool Effect::IsRealtimeActive

(

)

References mRealtimeSuspendCount.

bool Effect::LoadFactoryDefaults ( )

override

References GetFactoryDefaultsGroup(), LoadUserPreset(), and mClient.

Referenced by EffectChangeSpeed::LoadFactoryDefaults(), and EffectEqualization::LoadFactoryDefaults().

bool Effect::LoadFactoryPreset ( int  id )

override

References mClient.

Referenced by SetAutomationParameters().

bool Effect::LoadUserPreset ( const wxString &  name )

override

References GetPrivateConfig(), mClient, and SetAutomationParameters().

Referenced by NyquistEffect::Init(), LoadFactoryDefaults(), EffectEqualization::PopulateUI(), SetAutomationParameters(), SetBatchProcessing(), and Startup().

wxString Effect::ManualPage ( )

virtual

Reimplemented in EffectEqualization, NyquistEffect, EffectDistortion, EffectPhaser, EffectWahwah, EffectBassTreble, EffectReverb, EffectScienFilter, EffectTruncSilence, EffectCompressor, EffectAutoDuck, EffectClickRemoval, EffectAmplify, EffectChangeSpeed, EffectDtmf, EffectToneGen, EffectNormalize, EffectEcho, EffectNoise, EffectFindClipping, EffectRepeat, EffectSilence, and EffectPaulstretch.

int Effect::MessageBox	(	const wxString &	message,
		long	style = DefaultMessageBoxStyle,
		const wxString &	titleStr = wxString{}
	)

References _(), and mUIParent.

Referenced by SetAutomationParameters().

auto Effect::ModifyAnalysisTrack ( const LabelTrack *  pOrigTrack, const wxString &  name = wxString()  )

protected

Referenced by EffectFindClipping::Process().

void Effect::PopulateOrExchange ( ShuttleGui &  S )

protectedvirtual

Reimplemented in EffectEqualization, NyquistEffect, EffectDistortion, EffectPhaser, EffectWahwah, EffectBassTreble, EffectTruncSilence, EffectReverb, EffectScienFilter, EffectAmplify, EffectChangeSpeed, EffectAutoDuck, EffectDtmf, EffectClickRemoval, EffectCompressor, EffectToneGen, EffectEcho, EffectNormalize, EffectNoise, EffectFindClipping, EffectRepeat, EffectPaulstretch, and EffectSilence.

Referenced by EffectDialog::Init(), PopulateUI(), EffectDialog::TransferDataFromWindow(), and EffectDialog::TransferDataToWindow().

bool Effect::PopulateUI ( wxWindow *  parent )

override

References eIsCreating, mUIParent, and PopulateOrExchange().

void Effect::Preview ( )

override

Referenced by EffectAmplify::Preview().

void Effect::Preview ( bool  dryOnly )

protectedvirtual

Reimplemented in EffectAmplify.

References _(), TrackList::Add(), CalcPreviewInputLength(), WaveTrack::Copy(), CountWaveTracks(), TrackList::Create(), End(), TrackListCondIterator::First(), gAudioIO, GetFamily(), Track::GetSelected(), AudioIO::GetStreamTime(), GetType(), gPrefs, Init(), AudioIO::IsBusy(), AudioIO::IsStreamActive(), mDuration, mFactory, min(), mIsLinearEffect, mIsPreview, MixAndRender(), mNumTracks, mPreviewFullSelection, mPreviewWithNotSelected, mProgress, mProjectRate, mT0, mT1, mTracks, TrackListCondIterator::Next(), WaveTrack::NoDisplay, NYQUISTEFFECTS_FAMILY, Track::Offset(), pdlgHideCancelButton, Process(), ReplaceProcessedTracks(), ShowErrorDialog(), AudioIO::StartStream(), AudioIO::StopStream(), Success, ProgressDialog::Update(), valueRestorer(), and Track::Wave.

bool Effect::Process ( )

protectedvirtual

Reimplemented in EffectEqualization, NyquistEffect, EffectTruncSilence, EffectChangeSpeed, EffectAutoDuck, EffectClickRemoval, Generator, EffectNormalize, EffectFindClipping, EffectRepeat, EffectNoiseReduction, EffectPaulstretch, EffectStereoToMono, EffectRepair, EffectReverse, EffectSimpleMono, and EffectTwoPassSimpleMono.

References Track::All, CopyInputTracks(), GetAudioInCount(), GetAudioOutCount(), InitPass1(), InitPass2(), mNumAudioIn, mNumAudioOut, mPass, ProcessPass(), and ReplaceProcessedTracks().

Referenced by DoEffect(), and Preview().

size_t Effect::ProcessBlock ( float **  inBlock, float **  outBlock, size_t  blockLen  )

override

References mClient.

Referenced by ProcessTrack().

bool Effect::ProcessFinalize ( )

override

References mClient.

Referenced by ProcessTrack().

bool Effect::ProcessInitialize ( sampleCount  totalLen, ChannelNames  chanMap = NULL  )

override

References mClient.

Referenced by ProcessTrack().

bool Effect::ProcessPass ( )

protectedvirtual

Reimplemented in EffectTwoPassSimpleMono.

References WaveTrack::GetChannel(), Track::GetKind(), Track::GetLinked(), WaveTrack::GetMaxBlockSize(), WaveTrack::GetRate(), GetSamples(), Track::GetSelected(), GetType(), Track::IsSyncLockSelected(), Track::LeftChannel, mBlockSize, mBufferSize, mDuration, mNumAudioIn, mNumAudioOut, mNumChannels, mOutputTracks, mSampleCnt, mT0, mT1, ProcessTrack(), ArrayOf< X >::reinit(), ArraysOf< X >::reinit(), Track::RightChannel, SetBlockSize(), SetSampleRate(), Track::SyncLockAdjust(), WaveTrack::TimeToLongSamples(), and Track::Wave.

Referenced by Process().

bool Effect::ProcessTrack ( int  count, ChannelNames  map, WaveTrack *  left, WaveTrack *  right, sampleCount  leftStart, sampleCount  rightStart, sampleCount  len, FloatBuffers &  inBuffer, FloatBuffers &  outBuffer, ArrayOf< float * > &  inBufPos, ArrayOf< float * > &  outBufPos  )

private

References CalcPreviewInputLength(), WaveTrack::ClearAndPaste(), WaveTrack::Get(), GetActiveProject(), GetLatency(), WaveTrack::GetRate(), WaveTrack::GetSampleFormat(), AudacityProject::GetSel1(), GetType(), gPrefs, mBlockSize, mBufferSize, mDuration, mFactory, mIsPreview, mNumAudioOut, mNumChannels, mT0, mT1, TrackFactory::NewWaveTrack(), ProcessBlock(), ProcessFinalize(), ProcessInitialize(), WaveTrack::Set(), TrackGroupProgress(), and TrackProgress().

Referenced by ProcessPass().

bool Effect::PromptUser ( wxWindow *  parent )

protectedvirtual

Reimplemented in EffectNoiseReduction.

References IsBatchProcessing(), and ShowInterface().

Referenced by DoEffect(), and EffectManager::PromptUser().

bool Effect::RealtimeAddProcessor ( unsigned  numChannels, float  sampleRate  )

override

References mClient.

Referenced by EffectManager::RealtimeAddEffect(), and RealtimeAddProcessor().

bool Effect::RealtimeAddProcessor	(	int	group,
		unsigned	chans,
		float	rate
	)

References mCurrentProcessor, mGroupProcessor, mNumAudioIn, mNumAudioOut, and RealtimeAddProcessor().

bool Effect::RealtimeFinalize ( )

override

References mClient.

Referenced by EffectManager::RealtimeRemoveEffect().

bool Effect::RealtimeInitialize ( )

override

References mBlockSize, and mClient.

Referenced by EffectManager::RealtimeAddEffect().

size_t Effect::RealtimeProcess ( int  group, float **  inbuf, float **  outbuf, size_t  numSamples  )

override

References mClient.

Referenced by RealtimeProcess().

size_t Effect::RealtimeProcess	(	int	group,
		unsigned	chans,
		float **	inbuf,
		float **	outbuf,
		size_t	numSamples
	)

References mBlockSize, mGroupProcessor, min(), mNumAudioIn, mNumAudioOut, and RealtimeProcess().

bool Effect::RealtimeProcessEnd ( )

override

References mClient.

bool Effect::RealtimeProcessStart ( )

override

References mClient.

bool Effect::RealtimeResume ( )

override

References mClient, mRealtimeSuspendCount, and mRealtimeSuspendLock.

bool Effect::RealtimeSuspend ( )

override

References mClient, mRealtimeSuspendCount, and mRealtimeSuspendLock.

bool Effect::RemovePrivateConfig ( const wxString &  group, const wxString &  key  )

override

References PluginManager::Get(), GetID(), and PluginManager::RemovePrivateConfig().

bool Effect::RemovePrivateConfigSubgroup ( const wxString &  group )

override

References PluginManager::Get(), GetID(), and PluginManager::RemovePrivateConfigSubgroup().

bool Effect::RemoveSharedConfig ( const wxString &  group, const wxString &  key  )

override

References PluginManager::Get(), GetID(), and PluginManager::RemoveSharedConfig().

bool Effect::RemoveSharedConfigSubgroup ( const wxString &  group )

override

References PluginManager::Get(), GetID(), and PluginManager::RemoveSharedConfigSubgroup().

void Effect::ReplaceProcessedTracks ( const bool  bGoodResult )

protected

References TrackList::Add(), ODManager::Instance, ODManager::IsInstanceCreated(), mIMap, mOMap, mOutputTracks, mOutputTracksType, mTracks, Track::None, TrackList::Remove(), TrackList::Replace(), and ODManager::ReplaceWaveTrack().

Referenced by DoEffect(), Preview(), EffectTwoPassSimpleMono::Process(), EffectSimpleMono::Process(), EffectRepair::Process(), EffectReverse::Process(), EffectStereoToMono::Process(), EffectPaulstretch::Process(), EffectNoiseReduction::Process(), EffectRepeat::Process(), EffectNormalize::Process(), Generator::Process(), EffectClickRemoval::Process(), EffectAutoDuck::Process(), EffectChangeSpeed::Process(), EffectTruncSilence::Process(), NyquistEffect::Process(), EffectEqualization::Process(), and Process().

bool Effect::SaveUserPreset ( const wxString &  name )

override

References GetAutomationParameters(), mClient, and SetPrivateConfig().

Referenced by NyquistEffect::Init(), SetBatchProcessing(), EffectNoise::Startup(), EffectNormalize::Startup(), EffectAutoDuck::Startup(), EffectClickRemoval::Startup(), EffectChangeSpeed::Startup(), EffectCompressor::Startup(), EffectDtmf::Startup(), EffectTruncSilence::Startup(), EffectScienFilter::Startup(), EffectReverb::Startup(), EffectEqualization::Startup(), and Startup().

bool Effect::SetAutomationParameters ( EffectAutomationParameters &  parms )

override

References mClient.

Referenced by LoadUserPreset(), SetAutomationParameters(), and EffectManager::SetEffectParameters().

bool Effect::SetAutomationParameters ( const wxString &  parms )

virtual

References _(), GetCurrentSettingsGroup(), GetFactoryDefaultsGroup(), GetFactoryPresets(), GetUserPresetsGroup(), kCurrentSettingsIdent, kFactoryDefaultsIdent, kFactoryPresetIdent, kUserPresetIdent, LoadFactoryPreset(), LoadUserPreset(), MessageBox(), mUIDialog, SetAutomationParameters(), and TransferDataToWindow().

void Effect::SetBatchProcessing ( bool  start )

virtual

References GetSavedStateGroup(), LoadUserPreset(), mIsBatch, and SaveUserPreset().

Referenced by EffectManager::SetBatchProcessing().

size_t Effect::SetBlockSize ( size_t  maxBlockSize )

override

References mBlockSize, and mClient.

Referenced by ProcessPass(), EffectBassTreble::RealtimeInitialize(), EffectWahwah::RealtimeInitialize(), EffectPhaser::RealtimeInitialize(), and EffectDistortion::RealtimeInitialize().

void Effect::SetDuration ( double  duration )

override

References GetCurrentSettingsGroup(), GetType(), mDuration, mIsSelection, and SetPrivateConfig().

Referenced by EffectDtmf::OnDuration(), EffectDtmf::Recalculate(), EffectSilence::TransferDataFromWindow(), EffectNoise::TransferDataFromWindow(), EffectToneGen::TransferDataFromWindow(), and EffectDtmf::TransferDataFromWindow().

bool Effect::SetHost ( EffectHostInterface *  host )

override

References mClient.

Referenced by Startup().

void Effect::SetHostUI ( EffectUIHostInterface *  host )

override

void Effect::SetLinearEffectFlag ( bool  linearEffectFlag )

protected

References mIsLinearEffect.

Referenced by EffectEcho::EffectEcho(), EffectNoise::EffectNoise(), EffectSilence::EffectSilence(), and NyquistEffect::Parse().

void Effect::SetPresetParameters ( const wxArrayString *  Names, const wxArrayString *  Values  )

inline

Referenced by DoEffect().

void Effect::SetPreviewFullSelectionFlag ( bool  previewDurationFlag )

protected

References mPreviewFullSelection.

Referenced by NyquistEffect::Parse().

bool Effect::SetPrivateConfig ( const wxString &  group, const wxString &  key, const wxString &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetPrivateConfig().

Referenced by EffectChangeSpeed::OnChoice_Vinyl(), SaveUserPreset(), SetDuration(), EffectChangeSpeed::Startup(), EffectEqualization::Startup(), Startup(), EffectChangeSpeed::TransferDataFromWindow(), and EffectEqualization::ValidateUI().

bool Effect::SetPrivateConfig ( const wxString &  group, const wxString &  key, const int &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetPrivateConfig().

bool Effect::SetPrivateConfig ( const wxString &  group, const wxString &  key, const bool &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetPrivateConfig().

bool Effect::SetPrivateConfig ( const wxString &  group, const wxString &  key, const float &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetPrivateConfig().

bool Effect::SetPrivateConfig ( const wxString &  group, const wxString &  key, const double &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetPrivateConfig().

void Effect::SetSampleRate ( double  rate )

override

References mClient, and mSampleRate.

Referenced by ProcessPass().

bool Effect::SetSharedConfig ( const wxString &  group, const wxString &  key, const wxString &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetSharedConfig().

bool Effect::SetSharedConfig ( const wxString &  group, const wxString &  key, const int &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetSharedConfig().

bool Effect::SetSharedConfig ( const wxString &  group, const wxString &  key, const bool &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetSharedConfig().

bool Effect::SetSharedConfig ( const wxString &  group, const wxString &  key, const float &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetSharedConfig().

bool Effect::SetSharedConfig ( const wxString &  group, const wxString &  key, const double &  value  )

override

References PluginManager::Get(), GetID(), and PluginManager::SetSharedConfig().

bool Effect::ShowInterface ( wxWindow *  parent, bool  forceModal = false  )

override

References CreateUI(), IsInteractive(), ScreenshotCommand::MayCapture(), mClient, mUIDialog, SupportsRealtime(), and valueRestorer().

Referenced by PromptUser(), and NyquistEffect::ShowInterface().

void Effect::ShowOptions ( )

override

bool Effect::Startup ( EffectClientInterface *  client )

virtual

References GetAudioInCount(), GetAudioOutCount(), GetCurrentSettingsGroup(), GetFactoryDefaultsGroup(), GetPrivateConfig(), LoadUserPreset(), mClient, mNumAudioIn, mNumAudioOut, SaveUserPreset(), SetHost(), SetPrivateConfig(), and Startup().

bool Effect::Startup ( )

virtual

Reimplemented in EffectEqualization, EffectReverb, EffectScienFilter, EffectTruncSilence, EffectChangeSpeed, EffectCompressor, EffectDtmf, EffectClickRemoval, EffectAutoDuck, EffectNoise, and EffectNormalize.

Referenced by Startup().

bool Effect::SupportsAutomation ( )

override

References mClient.

bool Effect::SupportsRealtime ( )

override

References mClient.

Referenced by EffectManager::DoEffect(), EnablePreview(), and ShowInterface().

bool Effect::TotalProgress ( double  frac )

protected

References mProgress, Success, and ProgressDialog::Update().

Referenced by EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), NyquistEffect::GetCallback(), EffectAutoDuck::Process(), EffectTwoPassSimpleMono::ProcessOne(), and NyquistEffect::PutCallback().

bool Effect::TrackGroupProgress ( int  whichGroup, double  frac, const wxString &  msg = wxEmptyString  )

protected

References mNumGroups, mProgress, Success, and ProgressDialog::Update().

Referenced by NyquistEffect::ProcessOne(), and ProcessTrack().

bool Effect::TrackProgress ( int  whichTrack, double  frac, const wxString &  msg = wxEmptyString  )

protected

References mNumTracks, mProgress, Success, and ProgressDialog::Update().

Referenced by EffectNormalize::AnalyseDC(), BlockGenerator::GenerateTrack(), EffectRepeat::Process(), EffectRepair::ProcessOne(), EffectSimpleMono::ProcessOne(), EffectStereoToMono::ProcessOne(), EffectPaulstretch::ProcessOne(), EffectFindClipping::ProcessOne(), EffectNormalize::ProcessOne(), EffectClickRemoval::ProcessOne(), EffectChangeSpeed::ProcessOne(), NyquistEffect::ProcessOne(), EffectEqualization::ProcessOne(), EffectNoiseReduction::Worker::ProcessOne(), EffectReverse::ProcessOneClip(), and ProcessTrack().

bool Effect::TransferDataFromWindow ( )

protectedvirtual

Reimplemented in EffectEqualization, NyquistEffect, EffectDistortion, EffectPhaser, EffectWahwah, EffectBassTreble, EffectTruncSilence, EffectReverb, EffectScienFilter, EffectAmplify, EffectAutoDuck, EffectChangeSpeed, EffectClickRemoval, EffectCompressor, EffectDtmf, EffectEcho, EffectNormalize, EffectToneGen, EffectNoise, EffectFindClipping, EffectRepeat, EffectPaulstretch, and EffectSilence.

Referenced by GetAutomationParameters(), EffectNoiseReduction::Dialog::OnGetProfile(), EffectDialog::OnOk(), EffectNoiseReduction::Dialog::OnPreview(), and EffectNoiseReduction::Dialog::OnReduceNoise().

bool Effect::TransferDataToWindow ( )

protectedvirtual

Reimplemented in EffectEqualization, NyquistEffect, EffectDistortion, EffectPhaser, EffectWahwah, EffectBassTreble, EffectTruncSilence, EffectReverb, EffectScienFilter, EffectChangeSpeed, EffectAmplify, EffectDtmf, EffectAutoDuck, EffectClickRemoval, EffectCompressor, EffectToneGen, EffectEcho, EffectNormalize, EffectNoise, EffectFindClipping, EffectRepeat, EffectPaulstretch, and EffectSilence.

Referenced by SetAutomationParameters().

bool Effect::ValidateUI ( )

override

References mUIParent.

Friends And Related Function Documentation

friend class EffectManager

friend

friend class EffectPresetsDialog

friend

friend class EffectRack

friend

friend class EffectUIHost

friend

Member Data Documentation

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

staticprivate

Referenced by EffectManager::GetDefaultPreset(), SetAutomationParameters(), EffectPresetsDialog::SetPrefix(), EffectPresetsDialog::SetSelected(), and EffectPresetsDialog::UpdateUI().

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

staticprivate

Referenced by EffectManager::GetDefaultPreset(), SetAutomationParameters(), EffectPresetsDialog::SetPrefix(), EffectPresetsDialog::SetSelected(), and EffectPresetsDialog::UpdateUI().

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

staticprivate

Referenced by SetAutomationParameters(), EffectPresetsDialog::SetPrefix(), EffectPresetsDialog::SetSelected(), and EffectPresetsDialog::UpdateUI().

const wxString Effect::kUserPresetIdent = wxT("User Preset:")

staticprivate

Referenced by SetAutomationParameters(), EffectPresetsDialog::SetPrefix(), EffectPresetsDialog::SetSelected(), and EffectPresetsDialog::UpdateUI().

size_t Effect::mBlockSize

private

Referenced by Effect(), ProcessPass(), ProcessTrack(), RealtimeInitialize(), RealtimeProcess(), and SetBlockSize().

size_t Effect::mBufferSize

private

Referenced by Effect(), ProcessPass(), and ProcessTrack().

EffectClientInterface* Effect::mClient

private

Referenced by Effect(), EffectUIHost::EffectUIHost(), GetAudioInCount(), GetAudioOutCount(), GetAutomationParameters(), GetDescription(), GetFactoryPresets(), GetFamily(), GetID(), GetLatency(), GetMidiInCount(), GetMidiOutCount(), GetName(), GetPath(), GetSymbol(), GetTailSize(), GetType(), GetVendor(), GetVersion(), EffectUIHost::Initialize(), IsDefault(), IsInteractive(), IsLegacy(), IsReady(), LoadFactoryDefaults(), LoadFactoryPreset(), LoadUserPreset(), EffectUIHost::OnApply(), EffectUIHost::OnClose(), EffectUIHost::OnExport(), EffectUIHost::OnImport(), EffectUIHost::OnMenu(), EffectUIHost::OnOptions(), EffectUIHost::OnPlay(), ProcessBlock(), ProcessFinalize(), ProcessInitialize(), RealtimeAddProcessor(), RealtimeFinalize(), RealtimeInitialize(), RealtimeProcess(), RealtimeProcessEnd(), RealtimeProcessStart(), RealtimeResume(), RealtimeSuspend(), EffectUIHost::Resume(), SaveUserPreset(), SetAutomationParameters(), SetBlockSize(), SetHost(), SetSampleRate(), ShowInterface(), Startup(), SupportsAutomation(), SupportsRealtime(), and EffectUIHost::~EffectUIHost().

int Effect::mCurrentProcessor

private

Referenced by RealtimeAddProcessor().

double Effect::mDuration

private

Referenced by DoEffect(), Effect(), GetDuration(), GetSamples(), Preview(), ProcessPass(), ProcessTrack(), and SetDuration().

wxString Effect::mDurationFormat

private

Referenced by DoEffect(), and GetDurationFormat().

double Effect::mF0

protected

Referenced by DoEffect(), NyquistEffect::Init(), EffectNoiseReduction::Process(), NyquistEffect::Process(), and NyquistEffect::ShowInterface().

double Effect::mF1

protected

Referenced by DoEffect(), NyquistEffect::Init(), EffectNoiseReduction::Process(), NyquistEffect::Process(), and NyquistEffect::ShowInterface().

TrackFactory* Effect::mFactory

protected

Referenced by Effect::AddedAnalysisTrack::AddedAnalysisTrack(), Delegate(), DoEffect(), Preview(), EffectNoiseReduction::Process(), Generator::Process(), EffectPaulstretch::ProcessOne(), EffectChangeSpeed::ProcessOne(), NyquistEffect::ProcessOne(), and ProcessTrack().

wxArrayInt Effect::mGroupProcessor

private

Referenced by RealtimeAddProcessor(), and RealtimeProcess().

std::vector<Track*> Effect::mIMap

private

Referenced by AddToOutputTracks(), CopyInputTracks(), and ReplaceProcessedTracks().

bool Effect::mIsBatch

private

Referenced by Effect(), EffectUIHost::Initialize(), IsBatchProcessing(), EffectUIHost::OnApply(), SetBatchProcessing(), and EffectUIHost::UpdateControls().

bool Effect::mIsLinearEffect

private

Referenced by Effect(), Preview(), and SetLinearEffectFlag().

bool Effect::mIsPreview

private

Referenced by Effect(), Preview(), and ProcessTrack().

bool Effect::mIsSelection

private

Referenced by SetDuration().

size_t Effect::mNumAudioIn

private

Referenced by Effect(), Process(), ProcessPass(), RealtimeAddProcessor(), RealtimeProcess(), and Startup().

size_t Effect::mNumAudioOut

private

Referenced by Effect(), Process(), ProcessPass(), ProcessTrack(), RealtimeAddProcessor(), RealtimeProcess(), and Startup().

unsigned Effect::mNumChannels

private

Referenced by Effect(), ProcessPass(), and ProcessTrack().

int Effect::mNumGroups

private

Referenced by CountWaveTracks(), Effect(), and TrackGroupProgress().

int Effect::mNumTracks

private

Referenced by CountWaveTracks(), Effect(), Preview(), and TrackProgress().

std::vector<Track*> Effect::mOMap

private

Referenced by AddToOutputTracks(), CopyInputTracks(), and ReplaceProcessedTracks().

std::shared_ptr<TrackList> Effect::mOutputTracks

protected

Referenced by AddToOutputTracks(), CopyInputTracks(), DoEffect(), EffectSimpleMono::Process(), EffectRepair::Process(), EffectReverse::Process(), EffectStereoToMono::Process(), EffectPaulstretch::Process(), EffectNoiseReduction::Process(), EffectRepeat::Process(), EffectNormalize::Process(), Generator::Process(), EffectClickRemoval::Process(), EffectAutoDuck::Process(), EffectChangeSpeed::Process(), NyquistEffect::Process(), EffectEqualization::Process(), EffectTruncSilence::ProcessAll(), EffectTruncSilence::ProcessIndependently(), EffectStereoToMono::ProcessOne(), NyquistEffect::ProcessOne(), EffectTwoPassSimpleMono::ProcessPass(), ProcessPass(), and ReplaceProcessedTracks().

int Effect::mOutputTracksType

protected

Referenced by CopyInputTracks(), Effect(), and ReplaceProcessedTracks().

int Effect::mPass

protected

Referenced by GetPass(), and Process().

wxArrayString Effect::mPresetNames

protected

Referenced by NyquistEffect::Parse().

wxArrayString Effect::mPresetValues

protected

bool Effect::mPreviewFullSelection

private

Referenced by Effect(), Preview(), and SetPreviewFullSelectionFlag().

bool Effect::mPreviewWithNotSelected

private

Referenced by Effect(), IncludeNotSelectedPreviewTracks(), and Preview().

ProgressDialog* Effect::mProgress

protected

Referenced by EffectNormalize::AnalyseTrack(), DoEffect(), Effect(), Preview(), NyquistEffect::Process(), TotalProgress(), TrackGroupProgress(), and TrackProgress().

double Effect::mProjectRate

protected

Referenced by EffectPaulstretch::CalcPreviewInputLength(), Delegate(), EffectRepeat::DisplayNewTime(), DoEffect(), Effect(), EffectSilence::PopulateOrExchange(), EffectRepeat::PopulateOrExchange(), EffectNoise::PopulateOrExchange(), EffectToneGen::PopulateOrExchange(), EffectDtmf::PopulateOrExchange(), EffectChangeSpeed::PopulateOrExchange(), Preview(), and EffectPaulstretch::ProcessOne().

int Effect::mRealtimeSuspendCount

private

Referenced by Effect(), IsRealtimeActive(), RealtimeResume(), and RealtimeSuspend().

wxCriticalSection Effect::mRealtimeSuspendLock

private

Referenced by Effect(), RealtimeResume(), and RealtimeSuspend().

sampleCount Effect::mSampleCnt

protected

Referenced by EffectFade::ProcessBlock(), EffectToneGen::ProcessBlock(), and ProcessPass().

double Effect::mSampleRate

protected

Referenced by EffectNoiseReduction::Worker::Process(), EffectNoise::ProcessBlock(), EffectToneGen::ProcessBlock(), EffectDtmf::ProcessBlock(), EffectEcho::ProcessInitialize(), EffectDtmf::ProcessInitialize(), EffectReverb::ProcessInitialize(), EffectBassTreble::ProcessInitialize(), EffectWahwah::ProcessInitialize(), EffectPhaser::ProcessInitialize(), EffectDistortion::ProcessInitialize(), SetSampleRate(), and EffectNoiseReduction::Worker::Worker().

double Effect::mT0

protected

Referenced by EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), EffectTruncSilence::CalcPreviewInputLength(), EffectRepeat::DisplayNewTime(), DoEffect(), Effect(), GetSamples(), EffectChangeSpeed::Init(), EffectAmplify::Init(), Preview(), EffectSimpleMono::Process(), EffectReverse::Process(), EffectRepair::Process(), EffectPaulstretch::Process(), EffectNoiseReduction::Process(), EffectFindClipping::Process(), EffectRepeat::Process(), EffectNormalize::Process(), Generator::Process(), EffectClickRemoval::Process(), EffectAutoDuck::Process(), EffectChangeSpeed::Process(), NyquistEffect::Process(), EffectEqualization::Process(), EffectDtmf::ProcessInitialize(), EffectChangeSpeed::ProcessLabelTrack(), EffectPaulstretch::ProcessOne(), NyquistEffect::ProcessOne(), EffectTwoPassSimpleMono::ProcessPass(), ProcessPass(), ProcessTrack(), and NyquistEffect::ShowInterface().

double Effect::mT1

protected

Referenced by EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), EffectTruncSilence::CalcPreviewInputLength(), EffectRepeat::DisplayNewTime(), DoEffect(), Effect(), GetSamples(), EffectChangeSpeed::Init(), EffectAmplify::Init(), Preview(), EffectSimpleMono::Process(), EffectReverse::Process(), EffectRepair::Process(), EffectPaulstretch::Process(), EffectNoiseReduction::Process(), EffectRepeat::Process(), EffectFindClipping::Process(), EffectNormalize::Process(), Generator::Process(), EffectClickRemoval::Process(), EffectAutoDuck::Process(), EffectChangeSpeed::Process(), NyquistEffect::Process(), EffectEqualization::Process(), EffectTruncSilence::ProcessAll(), EffectTruncSilence::ProcessIndependently(), EffectChangeSpeed::ProcessLabelTrack(), NyquistEffect::ProcessOne(), EffectTwoPassSimpleMono::ProcessPass(), ProcessPass(), ProcessTrack(), and NyquistEffect::ShowInterface().

TrackList* Effect::mTracks

private

Referenced by Effect::AddedAnalysisTrack::AddedAnalysisTrack(), CopyInputTracks(), CountWaveTracks(), Delegate(), DoEffect(), Effect(), Effect::ModifiedAnalysisTrack::ModifiedAnalysisTrack(), Preview(), and ReplaceProcessedTracks().

bool Effect::mUIDebug

private

Referenced by Effect(), and EnableDebug().

wxDialog* Effect::mUIDialog

protected

Referenced by CloseUI(), Effect(), EnableApply(), EnablePreview(), GetAutomationParameters(), EffectReverb::LoadFactoryPreset(), EffectDistortion::LoadFactoryPreset(), SetAutomationParameters(), ShowInterface(), SpinSliderHandlers(), and ~Effect().

wxWindow* Effect::mUIParent

protected

Referenced by CloseUI(), Effect(), EnableApply(), EnablePreview(), EffectAutoDuck::Init(), MessageBox(), EffectBassTreble::OnBassSlider(), EffectBassTreble::OnBassText(), EffectTruncSilence::OnControlChange(), EffectToneGen::OnControlUpdate(), EffectScienFilter::OnCutoff(), EffectWahwah::OnDepthSlider(), EffectPhaser::OnDepthSlider(), EffectWahwah::OnDepthText(), EffectPhaser::OnDepthText(), EffectPhaser::OnDryWetSlider(), EffectPhaser::OnDryWetText(), EffectPhaser::OnFeedbackSlider(), EffectPhaser::OnFeedbackText(), EffectWahwah::OnFreqOffSlider(), EffectWahwah::OnFreqOffText(), EffectWahwah::OnFreqSlider(), EffectPhaser::OnFreqSlider(), EffectWahwah::OnFreqText(), EffectPhaser::OnFreqText(), EffectWahwah::OnGainSlider(), EffectPhaser::OnGainSlider(), EffectBassTreble::OnGainSlider(), EffectBassTreble::OnGainText(), EffectWahwah::OnGainText(), EffectPhaser::OnGainText(), NyquistEffect::OnLoad(), EffectEqualization::OnManage(), EditCurvesDialog::OnOK(), EffectWahwah::OnPhaseSlider(), EffectPhaser::OnPhaseSlider(), EffectWahwah::OnPhaseText(), EffectPhaser::OnPhaseText(), EffectWahwah::OnResonanceSlider(), EffectWahwah::OnResonanceText(), EffectScienFilter::OnRipple(), NyquistEffect::OnSave(), EffectScienFilter::OnSize(), EffectEqualization::OnSize(), NyquistEffect::OnSlider(), EffectPhaser::OnStagesSlider(), EffectPhaser::OnStagesText(), EffectScienFilter::OnStopbandRipple(), EffectPaulstretch::OnText(), NyquistEffect::OnText(), EffectBassTreble::OnTrebleSlider(), EffectBassTreble::OnTrebleText(), EffectEqualization::PopulateOrExchange(), EffectEqualization::PopulateUI(), PopulateUI(), NyquistEffect::Process(), NyquistEffect::ProcessOne(), EffectPaulstretch::TransferDataFromWindow(), EffectRepeat::TransferDataFromWindow(), EffectFindClipping::TransferDataFromWindow(), EffectNoise::TransferDataFromWindow(), EffectToneGen::TransferDataFromWindow(), EffectNormalize::TransferDataFromWindow(), EffectEcho::TransferDataFromWindow(), EffectClickRemoval::TransferDataFromWindow(), EffectCompressor::TransferDataFromWindow(), EffectDtmf::TransferDataFromWindow(), EffectAutoDuck::TransferDataFromWindow(), EffectChangeSpeed::TransferDataFromWindow(), EffectAmplify::TransferDataFromWindow(), EffectScienFilter::TransferDataFromWindow(), EffectReverb::TransferDataFromWindow(), EffectTruncSilence::TransferDataFromWindow(), EffectBassTreble::TransferDataFromWindow(), EffectWahwah::TransferDataFromWindow(), EffectPhaser::TransferDataFromWindow(), EffectDistortion::TransferDataFromWindow(), NyquistEffect::TransferDataFromWindow(), NyquistEffect::TransferDataToEffectWindow(), EffectPaulstretch::TransferDataToWindow(), EffectFindClipping::TransferDataToWindow(), EffectNoise::TransferDataToWindow(), EffectEcho::TransferDataToWindow(), EffectNormalize::TransferDataToWindow(), EffectToneGen::TransferDataToWindow(), EffectClickRemoval::TransferDataToWindow(), EffectAutoDuck::TransferDataToWindow(), EffectDtmf::TransferDataToWindow(), EffectChangeSpeed::TransferDataToWindow(), EffectScienFilter::TransferDataToWindow(), EffectTruncSilence::TransferDataToWindow(), EffectBassTreble::TransferDataToWindow(), EffectWahwah::TransferDataToWindow(), EffectPhaser::TransferDataToWindow(), EffectDistortion::TransferDataToWindow(), NyquistEffect::TransferDataToWindow(), EffectEqualization::TransferDataToWindow(), EffectScienFilter::TransferGraphLimitsFromWindow(), EffectEqualization::UpdateDraw(), EffectEqualization::UpdateGraphic(), EffectNormalize::UpdateUI(), EffectEqualization::ValidateUI(), and ValidateUI().

int Effect::mUIResultID

protected

Referenced by NyquistEffect::ShowInterface().

---

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

• Effect.h
• Effect.cpp