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

#include <Effect.h>

Inheritance diagram for Effect:

Collaboration diagram for Effect:

Public Member Functions
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () const override

bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override

bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

EffectType	GetType () const override
	Type determines how it behaves. More...

EffectFamilySymbol	GetFamily () const override
	Report identifier and user-visible name of the effect protocol. More...

bool	IsInteractive () const override
	Whether the effect needs a dialog for entry of settings. More...

bool	IsDefault () const override
	Whether the effect sorts "above the line" in the menus. More...

RealtimeSince	RealtimeSupport () const override
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsAutomation () const override
	Whether the effect has any automatable controls. More...

bool	SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
	Store settings as keys and values. More...

bool	LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
	Restore settings from keys and values. More...

OptionalMessage	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override

bool	SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
	Save settings in the configuration file as a user-named preset. More...

RegistryPaths	GetFactoryPresets () const override
	Report names of factory presets. More...

OptionalMessage	LoadFactoryPreset (int id, EffectSettings &settings) const override

OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const override

virtual const EffectParameterMethods &	Parameters () const

bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...

bool	HasOptions () const override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatSymbol	GetSelectionFormat ()

bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override

OptionalMessage	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override

bool	IsBatchProcessing () const override

void	SetBatchProcessing () override

void	UnsetBatchProcessing () override

unsigned	TestUIFlags (unsigned mask)

bool	Delegate (Effect &delegate, EffectSettings &settings)
	Re-invoke DoEffect on another Effect object that implements the work. More...

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

void	SetTracks (TrackList *pTracks)

bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override

Public Member Functions inherited from EffectPlugin
EffectPlugin &	operator= (EffectPlugin &)=delete

virtual	~EffectPlugin ()

virtual bool	HasOptions () const =0

virtual bool	CanExportPresets () const =0
	Whether the effect supports export of presets to files, and importing too. More...

virtual const EffectSettingsManager &	GetDefinition () const =0

virtual void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly)=0
	Calculate temporary tracks of limited length with effect applied and play. More...

virtual bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0

virtual OptionalMessage	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0

virtual bool	IsBatchProcessing () const =0

virtual void	SetBatchProcessing ()=0

virtual void	UnsetBatchProcessing ()=0

virtual bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess=nullptr)=0

Public Member Functions inherited from EffectInstanceFactory
virtual	~EffectInstanceFactory ()

virtual std::shared_ptr< EffectInstance >	MakeInstance () const =0
	Make an object maintaining short-term state of an Effect. More...

Public Member Functions inherited from EffectSettingsManager
virtual	~EffectSettingsManager ()

virtual bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)

virtual bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const

virtual EffectSettings	MakeSettings () const

virtual bool	CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const
	Update one settings object from another. More...

virtual std::unique_ptr< EffectOutputs >	MakeOutputs () const
	Produce an object to hold values to send to effect output meters. More...

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetType () const =0
	Type determines how it behaves. More...

virtual EffectType	GetClassification () const
	Determines which menu it appears in; default same as GetType(). More...

virtual EffectFamilySymbol	GetFamily () const =0
	Report identifier and user-visible name of the effect protocol. More...

virtual bool	IsInteractive () const =0
	Whether the effect needs a dialog for entry of settings. More...

virtual bool	IsDefault () const =0
	Whether the effect sorts "above the line" in the menus. More...

virtual RealtimeSince	RealtimeSupport () const =0
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsRealtime () const

virtual bool	SupportsAutomation () const =0
	Whether the effect has any automatable controls. More...

virtual bool	EnablesDebug () const
	Whether the effect dialog should have a Debug button; default, always false. More...

virtual ManualPageID	ManualPage () const
	Name of a page in the Audacity alpha manual, default is empty. More...

virtual FilePath	HelpPage () const
	Fully qualified local help file name, default is empty. More...

virtual bool	IsHiddenFromMenus () const
	Default is false. More...

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Static Public Member Functions
static Effect *	FetchParameters (Effect &e, EffectSettings &)

static void	IncEffectCounter ()

Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...

Protected Member Functions
bool	CheckWhetherSkipEffect (const EffectSettings &settings) const override
	Default implementation returns false. More...

double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
	Default implementation returns `previewLength` More...

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

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

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

int	GetNumWaveTracks () const

int	GetNumWaveGroups () const

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

void	CopyInputTracks (bool allSyncLockSelected=false)

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

Protected Member Functions inherited from EffectBase
virtual std::any	BeginPreview (const EffectSettings &settings)
	Called when Preview() starts, to allow temporary effect state changes. More...

void	Preview (EffectSettingsAccess &access, std::function< void()> updateUI, bool dryOnly) final
	Calculate temporary tracks of limited length with effect applied and play. More...

virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...

virtual double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	ReplaceProcessedTracks (const bool bGoodResult)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Private Member Functions
wxString	GetSavedStateGroup ()

Private Attributes
bool	mIsBatch { false }

Additional Inherited Members
Public Types inherited from EffectPlugin
using	EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >

using	InstancePointer = std::shared_ptr< EffectInstanceEx >

using	InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) >

Public Types inherited from EffectDefinitionInterface
enum class	RealtimeSince : unsigned { Never , After_3_1 , Always }
	In which versions of Audacity was an effect realtime capable? More...

Public Attributes inherited from EffectBase
TrackList *	mTracks {}

Static Public Attributes inherited from EffectPlugin
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>")

Protected Attributes inherited from EffectBase
BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

std::shared_ptr< TrackList >	mOutputTracks

double	mT0 {}

double	mT1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

Base class for many of the effects in Audacity.

Definition at line 24 of file Effect.h.

Constructor & Destructor Documentation

◆ Effect()

Effect::Effect ( )

Definition at line 35 of file Effect.cpp.

36{

37}

◆ ~Effect()

Effect::~Effect ( )

virtual

Definition at line 39 of file Effect.cpp.

40{

41}

Member Function Documentation

◆ AddToOutputTracks()

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

protected

Definition at line 421 of file Effect.cpp.

{
   mIMap.push_back(NULL);
   mOMap.push_back(t.get());
   return mOutputTracks->Add(t);
}

References EffectBase::mIMap, EffectBase::mOMap, and EffectBase::mOutputTracks.

Referenced by NyquistEffect::ProcessOne().

Here is the caller graph for this function:

◆ CalcPreviewInputLength()

double Effect::CalcPreviewInputLength	(	const EffectSettings &	settings,
		double	previewLength
	)		const

overrideprotectedvirtual

Default implementation returns previewLength

Implements EffectBase.

Definition at line 433 of file Effect.cpp.

{
   return previewLength;
}

Referenced by PerTrackEffect::ProcessPass().

Here is the caller graph for this function:

◆ CanExportPresets()

bool Effect::CanExportPresets ( ) const

overridevirtual

Whether the effect supports export of presets to files, and importing too.

Implements EffectPlugin.

Definition at line 178 of file Effect.cpp.

{
   return true;
}

◆ CheckWhetherSkipEffect()

bool Effect::CheckWhetherSkipEffect ( const EffectSettings & settings ) const

overrideprotectedvirtual

Default implementation returns false.

Implements EffectBase.

Definition at line 428 of file Effect.cpp.

{
   return false;
}

◆ CopyInputTracks()

void Effect::CopyInputTracks ( bool allSyncLockSelected = false )

protected

Definition at line 396 of file Effect.cpp.

{
   // Reset map
   mIMap.clear();
   mOMap.clear();
 
   mOutputTracks = TrackList::Create(
      const_cast<AudacityProject*>( FindProject() ) // how to remove this const_cast?
  );
 
   auto trackRange = mTracks->Any() +
      [&] (const Track *pTrack) {
         return allSyncLockSelected
         ? SyncLock::IsSelectedOrSyncLockSelected(pTrack)
         : track_cast<const WaveTrack*>( pTrack ) && pTrack->GetSelected();
      };
 
   for (auto aTrack : trackRange)
   {
      Track *o = mOutputTracks->Add(aTrack->Duplicate());
      mIMap.push_back(aTrack);
      mOMap.push_back(o);
   }
}

References TrackList::Any(), TrackList::Create(), EffectBase::FindProject(), SyncLock::IsSelectedOrSyncLockSelected(), EffectBase::mIMap, EffectBase::mOMap, EffectBase::mOutputTracks, and EffectBase::mTracks.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Delegate()

bool Effect::Delegate	(	Effect &	delegate,
		EffectSettings &	settings
	)

Re-invoke DoEffect on another Effect object that implements the work.

Definition at line 329 of file Effect.cpp.

{
   NotifyingSelectedRegion region;
   region.setTimes( mT0, mT1 );
 
   return delegate.DoEffect(settings, {}, mProjectRate, mTracks, mFactory,
      region, mUIFlags, nullptr);
}

References EffectBase::DoEffect(), EffectBase::mFactory, EffectBase::mProjectRate, EffectBase::mT0, EffectBase::mT1, EffectBase::mTracks, EffectBase::mUIFlags, NotifyingSelectedRegion::setTimes(), and settings().

Referenced by NyquistEffect::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FetchParameters()

static Effect * Effect::FetchParameters	(	Effect &	e,
		EffectSettings &
	)

inlinestatic

Definition at line 34 of file Effect.h.

35 { return &e; }

◆ GetBounds()

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

protected

Definition at line 366 of file Effect.cpp.

{
   auto t0 = std::max( mT0, track.GetStartTime() );
   auto t1 = std::min( mT1, track.GetEndTime() );
 
   if ( pRight ) {
      t0 = std::min( t0, std::max( mT0, pRight->GetStartTime() ) );
      t1 = std::max( t1, std::min( mT1, pRight->GetEndTime() ) );
   }
 
   if (t1 > t0) {
      *start = track.TimeToLongSamples(t0);
      auto end = track.TimeToLongSamples(t1);
      *len = end - *start;
   }
   else {
      *start = 0;
      *len = 0;
   }
}

References PackedArray::end(), WaveTrack::GetEndTime(), WaveTrack::GetStartTime(), min(), EffectBase::mT0, EffectBase::mT1, and SampleTrack::TimeToLongSamples().

Referenced by VampEffect::Process(), and PerTrackEffect::ProcessPass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDefinition()

const EffectSettingsManager & Effect::GetDefinition ( ) const

overridevirtual

Implements EffectPlugin.

Definition at line 190 of file Effect.cpp.

{
   return *this;
}

Referenced by LoadUserPreset(), EffectChangeSpeed::OnChoice_Vinyl(), EffectChangeSpeed::PopulateOrExchange(), SaveUserPreset(), EffectChangeSpeed::TransferDataFromWindow(), and EffectChangeSpeed::Update_Vinyl().

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString Effect::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 65 of file Effect.cpp.

{
   return {};
}

◆ GetFactoryPresets()

RegistryPaths Effect::GetFactoryPresets ( ) const

overridevirtual

Report names of factory presets.

Implements EffectSettingsManager.

Definition at line 163 of file Effect.cpp.

{
   return {};
}

Referenced by LoadSettingsFromString().

Here is the caller graph for this function:

◆ GetFamily()

EffectFamilySymbol Effect::GetFamily ( ) const

overridevirtual

Report identifier and user-visible name of the effect protocol.

Implements EffectDefinitionInterface.

Definition at line 77 of file Effect.cpp.

{
   // Unusually, the internal and visible strings differ for the built-in
   // effect family.
   return { wxT("Audacity"), XO("Built-in") };
}

References wxT(), and XO().

Here is the call graph for this function:

◆ GetNumWaveGroups()

int Effect::GetNumWaveGroups ( ) const

inlineprotected

Definition at line 141 of file Effect.h.

141{ return mNumGroups; }

EffectBase::mNumGroups

int mNumGroups

Definition: EffectBase.h:143

References EffectBase::mNumGroups.

Referenced by NyquistEffect::Process(), and VampEffect::Process().

Here is the caller graph for this function:

◆ GetNumWaveTracks()

int Effect::GetNumWaveTracks ( ) const

inlineprotected

Definition at line 140 of file Effect.h.

140{ return mNumTracks; }

EffectBase::mNumTracks

int mNumTracks

Definition: EffectBase.h:142

References EffectBase::mNumTracks.

Referenced by EffectNormalize::AnalyseTrackData(), EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), EffectAutoDuck::Process(), EffectNormalize::ProcessOne(), EffectTwoPassSimpleMono::ProcessOne(), EffectNoiseRemoval::ShowHostInterface(), and EffectLoudness::UpdateProgress().

Here is the caller graph for this function:

◆ GetPath()

PluginPath Effect::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 45 of file Effect.cpp.

{
   return BUILTIN_EFFECT_PREFIX + GetSymbol().Internal();
}

References BUILTIN_EFFECT_PREFIX, GetSymbol(), and ComponentInterfaceSymbol::Internal().

Here is the call graph for this function:

◆ GetSavedStateGroup()

wxString Effect::GetSavedStateGroup ( )

private

Definition at line 202 of file Effect.cpp.

{
   return wxT("SavedState");
}

References wxT().

Referenced by SetBatchProcessing(), and UnsetBatchProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSelectionFormat()

NumericFormatSymbol Effect::GetSelectionFormat ( )

virtual

Definition at line 195 of file Effect.cpp.

{
   if( !IsBatchProcessing() && FindProject() )
      return ProjectNumericFormats::Get( *FindProject() ).GetSelectionFormat();
   return NumericConverter::HoursMinsSecondsFormat();
}

References EffectBase::FindProject(), ProjectNumericFormats::Get(), ProjectNumericFormats::GetSelectionFormat(), NumericConverter::HoursMinsSecondsFormat(), and IsBatchProcessing().

Referenced by NyquistEffect::BuildEffectWindow(), and EffectRepeat::DisplayNewTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol Effect::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 50 of file Effect.cpp.

{
   return {};
}

Referenced by GetPath().

Here is the caller graph for this function:

◆ GetType()

EffectType Effect::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 72 of file Effect.cpp.

{
   return EffectTypeNone;
}

References EffectTypeNone.

Referenced by PerTrackEffect::ProcessPass(), and VST3Editor::VST3Editor().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol Effect::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 55 of file Effect.cpp.

{
   return XO("Audacity");
}

References XO().

Here is the call graph for this function:

◆ GetVersion()

wxString Effect::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 60 of file Effect.cpp.

{
   return AUDACITY_VERSION_STRING;
}

◆ HasOptions()

bool Effect::HasOptions ( ) const

overridevirtual

Whether there are preferences applying to the effect's family, for which a UI may be needed to change them

Implements EffectPlugin.

Definition at line 183 of file Effect.cpp.

{
   return false;
}

◆ IncEffectCounter()

static void Effect::IncEffectCounter ( )

inlinestatic

Definition at line 110 of file Effect.h.

110{ nEffectsDone++;}

EffectBase::nEffectsDone

static int nEffectsDone

Definition: EffectBase.h:97

Referenced by SelectTracksCommand::Apply().

Here is the caller graph for this function:

◆ IsBatchProcessing()

bool Effect::IsBatchProcessing ( ) const

overridevirtual

Implements EffectPlugin.

Definition at line 302 of file Effect.cpp.

{
   return mIsBatch;
}

References mIsBatch.

Referenced by NyquistEffect::DoLoadSettings(), GetSelectionFormat(), EffectAmplify::Parameters(), EffectAmplify::PopulateOrExchange(), NyquistEffect::Process(), EffectNoiseReduction::ShowHostInterface(), and NyquistEffect::ShowHostInterface().

Here is the caller graph for this function:

◆ IsDefault()

bool Effect::IsDefault ( ) const

overridevirtual

Whether the effect sorts "above the line" in the menus.

Implements EffectDefinitionInterface.

Definition at line 89 of file Effect.cpp.

{
   return true;
}

◆ IsInteractive()

bool Effect::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Definition at line 84 of file Effect.cpp.

{
   return true;
}

◆ LoadFactoryDefaults()

OptionalMessage Effect::LoadFactoryDefaults ( EffectSettings & settings ) const

overridevirtual

Change settings back to "factory default"

Returns: nullopt for failure

Implements EffectSettingsManager.

Definition at line 173 of file Effect.cpp.

{
   return LoadUserPreset(FactoryDefaultsGroup(), settings);
}

References FactoryDefaultsGroup(), LoadUserPreset(), and settings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadFactoryPreset()

OptionalMessage Effect::LoadFactoryPreset	(	int	id,
		EffectSettings &	settings
	)		const

overridevirtual

Change settings to the preset whose name is GetFactoryPresets()[id]

Returns: nullopt for failure

Implements EffectSettingsManager.

Definition at line 168 of file Effect.cpp.

{
   return { nullptr };
}

Referenced by LoadSettingsFromString().

Here is the caller graph for this function:

◆ LoadSettings()

bool Effect::LoadSettings	(	const CommandParameters &	parms,
		EffectSettings &	settings
	)		const

overridevirtual

Restore settings from keys and values.

Returns: true on success

Implements EffectSettingsManager.

Definition at line 130 of file Effect.cpp.

{
   // The first argument, and with it the const_cast, will disappear when
   // all built-in effects are stateless.
   return Parameters().Set( *const_cast<Effect*>(this), parms, settings );
}

Referenced by EffectTruncSilence::LoadSettings(), and LoadSettingsFromString().

Here is the caller graph for this function:

◆ LoadSettingsFromString()

OptionalMessage Effect::LoadSettingsFromString	(	const wxString &	parms,
		EffectSettings &	settings
	)		const

overridevirtual

Implements EffectPlugin.

Definition at line 227 of file Effect.cpp.

{
   // If the string starts with one of certain significant substrings,
   // then the rest of the string is reinterpreted as part of a registry key,
   // and a user or factory preset is then loaded.
   // (Where did these prefixes come from?  See EffectPresetsDialog; and
   // ultimately the uses of it by EffectManager::GetPreset, which is used by
   // the macro management dialog)
   wxString preset = parms;
   OptionalMessage result;
   if (preset.StartsWith(kUserPresetIdent))
   {
      preset.Replace(kUserPresetIdent, wxEmptyString, false);
      result = LoadUserPreset(UserPresetsGroup(preset), settings);
   }
   else if (preset.StartsWith(kFactoryPresetIdent))
   {
      preset.Replace(kFactoryPresetIdent, wxEmptyString, false);
      auto presets = GetFactoryPresets();
      result = LoadFactoryPreset(
         make_iterator_range( presets ).index( preset ), settings );
   }
   else if (preset.StartsWith(kCurrentSettingsIdent))
   {
      preset.Replace(kCurrentSettingsIdent, wxEmptyString, false);
      result = LoadUserPreset(CurrentSettingsGroup(), settings);
   }
   else if (preset.StartsWith(kFactoryDefaultsIdent))
   {
      preset.Replace(kFactoryDefaultsIdent, wxEmptyString, false);
      result = LoadUserPreset(FactoryDefaultsGroup(), settings);
   }
   else
   {
      // If the string did not start with any of the significant substrings,
      // then use VisitSettings or LoadSettings to reinterpret it,
      // or use LoadSettings.
      // This interprets what was written by SaveSettings, above.
      CommandParameters eap(parms);
      ShuttleSetAutomation S;
      S.SetForValidating( &eap );
      // VisitSettings returns false if not defined for this effect.
      // To do: fix const_cast in use of VisitSettings
      if ( !const_cast<Effect*>(this)->VisitSettings(S, settings) ) {
         // the old method...
         if (LoadSettings(eap, settings))
            return { nullptr };
      }
      else if( !S.bOK )
         result = {};
      else{
         result = { nullptr };
         S.SetForWriting( &eap );
         const_cast<Effect*>(this)->VisitSettings(S, settings);
      }
   }
 
   if (!result)
   {
      using namespace BasicUI;
      ShowMessageBox(
         XO("%s: Could not load settings below. Default settings will be used.\n\n%s")
            .Format( GetName(), preset ),
         MessageBoxOptions{}.Caption(GetName()));
      // We are using default settings and we still wish to continue.
      result = { nullptr };
   }
   return result;
}

References BasicUI::MessageBoxOptions::Caption(), CurrentSettingsGroup(), FactoryDefaultsGroup(), GetFactoryPresets(), ComponentInterface::GetName(), EffectPlugin::kCurrentSettingsIdent, EffectPlugin::kFactoryDefaultsIdent, EffectPlugin::kFactoryPresetIdent, EffectPlugin::kUserPresetIdent, LoadFactoryPreset(), LoadSettings(), LoadUserPreset(), make_iterator_range(), preset, S, settings(), BasicUI::ShowMessageBox(), UserPresetsGroup(), VisitSettings(), and XO().

Referenced by LoadUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadUserPreset()

OptionalMessage Effect::LoadUserPreset	(	const RegistryPath &	name,
		EffectSettings &	settings
	)		const

overridevirtual

Change settings to a user-named preset

Returns: nullopt for failure

Implements EffectSettingsManager.

Definition at line 138 of file Effect.cpp.

{
   // Find one string in the registry and then reinterpret it
   // as complete settings
   wxString parms;
   if (!GetConfig(GetDefinition(), PluginSettings::Private,
      name, wxT("Parameters"), parms))
      return {};
 
   return LoadSettingsFromString(parms, settings);
}

References PluginSettings::GetConfig(), GetDefinition(), LoadSettingsFromString(), name, PluginSettings::Private, settings(), and wxT().

Referenced by LoadFactoryDefaults(), LoadSettingsFromString(), and UnsetBatchProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Parameters()

const EffectParameterMethods & Effect::Parameters ( ) const

virtual

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

Definition at line 104 of file Effect.cpp.

{
   static const CapturedParameters<Effect> empty;
   return empty;
}

Referenced by SaveSettings(), EffectNoiseReduction::TrackProgress(), and VisitSettings().

Here is the caller graph for this function:

◆ RealtimeSupport()

auto Effect::RealtimeSupport ( ) const

overridevirtual

Since which version of Audacity has the effect supported realtime?

Implements EffectDefinitionInterface.

Definition at line 94 of file Effect.cpp.

{
   return RealtimeSince::Never;
}

References EffectDefinitionInterface::Never.

◆ SaveSettings()

bool Effect::SaveSettings	(	const EffectSettings &	settings,
		CommandParameters &	parms
	)		const

overridevirtual

Store settings as keys and values.

The override may assume parms is initially empty

Returns: true on success

Implements EffectSettingsManager.

Definition at line 123 of file Effect.cpp.

{
   Parameters().Get( *this, settings, parms );
   return true;
}

References EffectParameterMethods::Get(), Parameters(), and settings().

Referenced by SaveSettingsAsString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveSettingsAsString()

bool Effect::SaveSettingsAsString	(	const EffectSettings &	settings,
		wxString &	parms
	)		const

overridevirtual

Implements EffectPlugin.

Definition at line 209 of file Effect.cpp.

{
   CommandParameters eap;
   ShuttleGetAutomation S;
   S.mpEap = &eap;
   if( VisitSettings( S, settings ) ){
      ;// got eap value using VisitSettings.
   }
   // Won't be needed in future
   else if (!SaveSettings(settings, eap))
   {
      return false;
   }
 
   return eap.GetParameters(parms);
}

References CommandParameters::GetParameters(), S, SaveSettings(), settings(), and VisitSettings().

Referenced by SaveUserPreset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveUserPreset()

bool Effect::SaveUserPreset	(	const RegistryPath &	name,
		const EffectSettings &	settings
	)		const

overridevirtual

Save settings in the configuration file as a user-named preset.

Implements EffectSettingsManager.

Definition at line 151 of file Effect.cpp.

{
   // Save all settings as a single string value in the registry
   wxString parms;
   if (!SaveSettingsAsString(settings, parms))
      return false;
 
   return SetConfig(GetDefinition(), PluginSettings::Private,
      name, wxT("Parameters"), parms);
}

References GetDefinition(), name, PluginSettings::Private, SaveSettingsAsString(), PluginSettings::SetConfig(), settings(), and wxT().

Referenced by SetBatchProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBatchProcessing()

void Effect::SetBatchProcessing ( )

overridevirtual

Implements EffectPlugin.

Definition at line 307 of file Effect.cpp.

{
   mIsBatch = true;
   // Save effect's internal state in a special registry path
   // just for this purpose
   // If effect is not stateful, this step doesn't really matter, and the
   // settings object is a dummy
   auto dummySettings = MakeSettings();
   SaveUserPreset(GetSavedStateGroup(), dummySettings);
}

References GetSavedStateGroup(), EffectSettingsManager::MakeSettings(), mIsBatch, and SaveUserPreset().

Referenced by NyquistEffect::ShowHostInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SupportsAutomation()

bool Effect::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Implements EffectDefinitionInterface.

Definition at line 99 of file Effect.cpp.

{
   return true;
}

◆ TestUIFlags()

unsigned Effect::TestUIFlags ( unsigned mask )

Definition at line 298 of file Effect.cpp.

                                          {
   return mask & mUIFlags;
}

References EffectBase::mUIFlags.

Referenced by NyquistEffect::ShowHostInterface().

Here is the caller graph for this function:

◆ TotalProgress()

bool Effect::TotalProgress	(	double	frac,
		const TranslatableString &	msg = `{}`
	)		const

protected

Definition at line 338 of file Effect.cpp.

{
   auto updateResult = (mProgress ?
      mProgress->Poll(frac * 1000, 1000, msg) :
      BasicUI::ProgressResult::Success);
   return (updateResult != BasicUI::ProgressResult::Success);
}

References EffectBase::mProgress, BasicUI::ProgressDialog::Poll(), and BasicUI::Success.

Referenced by EffectNormalize::AnalyseTrackData(), EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), EffectTruncSilence::DoRemoval(), NyquistEffect::GetCallback(), EffectAutoDuck::Process(), EffectStereoToMono::ProcessOne(), EffectNormalize::ProcessOne(), EffectTwoPassSimpleMono::ProcessOne(), NyquistEffect::PutCallback(), and EffectLoudness::UpdateProgress().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TrackGroupProgress()

bool Effect::TrackGroupProgress	(	int	whichGroup,
		double	frac,
		const TranslatableString &	msg = `{}`
	)		const

protected

Definition at line 356 of file Effect.cpp.

{
   auto updateResult = (mProgress ?
      mProgress->Poll((whichGroup + frac) * 1000,
         (double) mNumGroups * 1000, msg) :
      BasicUI::ProgressResult::Success);
   return (updateResult != BasicUI::ProgressResult::Success);
}

References EffectBase::mNumGroups, EffectBase::mProgress, BasicUI::ProgressDialog::Poll(), and BasicUI::Success.

Referenced by VampEffect::Process(), NyquistEffect::ProcessOne(), and PerTrackEffect::ProcessPass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TrackProgress()

bool Effect::TrackProgress	(	int	whichTrack,
		double	frac,
		const TranslatableString &	msg = `{}`
	)		const

protected

Definition at line 346 of file Effect.cpp.

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

References EffectBase::mNumTracks, EffectBase::mProgress, BasicUI::ProgressDialog::Poll(), and BasicUI::Success.

Referenced by BlockGenerator::GenerateTrack(), EffectRepeat::Process(), EffectSBSMS::Process(), VampEffect::Process(), NyquistEffect::ProcessOne(), EffectEqualization::ProcessOne(), EffectClickRemoval::ProcessOne(), EffectNoiseRemoval::ProcessOne(), EffectRepair::ProcessOne(), EffectFindClipping::ProcessOne(), EffectChangeSpeed::ProcessOne(), EffectSimpleMono::ProcessOne(), EffectPaulstretch::ProcessOne(), EffectReverse::ProcessOneClip(), and PerTrackEffect::ProcessPass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UnsetBatchProcessing()

void Effect::UnsetBatchProcessing ( )

overridevirtual

Implements EffectPlugin.

Definition at line 318 of file Effect.cpp.

{
   mIsBatch = false;
   // Restore effect's internal state from registry
   // If effect is not stateful, this call doesn't really matter, and the
   // settings object is a dummy
   auto dummySettings = MakeSettings();
   // Ignore failure
   (void ) LoadUserPreset(GetSavedStateGroup(), dummySettings);
}

References GetSavedStateGroup(), LoadUserPreset(), EffectSettingsManager::MakeSettings(), and mIsBatch.

Here is the call graph for this function:

◆ VisitSettings() [1/2]

bool Effect::VisitSettings	(	ConstSettingsVisitor &	visitor,
		const EffectSettings &	settings
	)		const

overridevirtual

Visit settings (read-only), if defined. false means no defined settings. Default implementation returns false

Reimplemented from EffectSettingsManager.

Definition at line 116 of file Effect.cpp.

{
   Parameters().Visit(*this, visitor, settings);
   return true;
}

References Parameters(), settings(), and EffectParameterMethods::Visit().

Here is the call graph for this function:

◆ VisitSettings() [2/2]

bool Effect::VisitSettings	(	SettingsVisitor &	visitor,
		EffectSettings &	settings
	)

overridevirtual

Visit settings (and maybe change them), if defined. false means no defined settings. Default implementation returns false

Reimplemented from EffectSettingsManager.

Definition at line 110 of file Effect.cpp.

{
   Parameters().Visit(*this, visitor, settings);
   return true;
}

References Parameters(), settings(), and EffectParameterMethods::Visit().

Referenced by LoadSettingsFromString(), SaveSettingsAsString(), and EffectEqualization::VisitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mIsBatch

bool Effect::mIsBatch { false }

private

Definition at line 159 of file Effect.h.

Referenced by IsBatchProcessing(), SetBatchProcessing(), and UnsetBatchProcessing().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Effect()

◆ ~Effect()

Member Function Documentation

◆ AddToOutputTracks()

◆ CalcPreviewInputLength()

◆ CanExportPresets()

◆ CheckWhetherSkipEffect()

◆ CopyInputTracks()

◆ Delegate()

◆ FetchParameters()

◆ GetBounds()

◆ GetDefinition()

◆ GetDescription()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetNumWaveGroups()

◆ GetNumWaveTracks()

◆ GetPath()

◆ GetSavedStateGroup()

◆ GetSelectionFormat()

◆ GetSymbol()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HasOptions()

◆ IncEffectCounter()

◆ IsBatchProcessing()

◆ IsDefault()

◆ IsInteractive()

◆ LoadFactoryDefaults()

◆ LoadFactoryPreset()

◆ LoadSettings()

◆ LoadSettingsFromString()

◆ LoadUserPreset()

◆ Parameters()

◆ RealtimeSupport()

◆ SaveSettings()

◆ SaveSettingsAsString()

◆ SaveUserPreset()

◆ SetBatchProcessing()

◆ SupportsAutomation()

◆ TestUIFlags()

◆ TotalProgress()

◆ TrackGroupProgress()

◆ TrackProgress()

◆ UnsetBatchProcessing()

◆ VisitSettings() [1/2]

◆ VisitSettings() [2/2]

Member Data Documentation

◆ mIsBatch