Effect Class Reference

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

#include <Effect.h>

Inheritance diagram for Effect:

Collaboration diagram for Effect:

Classes
class	AddedAnalysisTrack
class	ModifiedAnalysisTrack

Public Types
enum	: long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
Public Types inherited from EffectPlugin
using	EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
Public Types inherited from EffectDefinitionInterface
enum class	RealtimeSince : unsigned { Never , Since_3_2 , Always }
	In which versions of Audacity was an effect realtime capable? More...

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
int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override
EffectUIClientInterface *	GetEffectUIClientInterface () override
	Returns the EffectUIClientInterface instance for this effect. More...
std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) override
	Adds controls to a panel that is given as the parent window of S More...
bool	IsGraphicalUI () override
bool	ValidateUI (EffectSettings &) override
bool	CloseUI () override
bool	CanExportPresets () override
void	ExportPresets (const EffectSettings &settings) const override
OptionalMessage	ImportPresets (EffectSettings &settings) override
bool	HasOptions () override
void	ShowOptions () override
const EffectSettingsManager &	GetDefinition () const override
virtual NumericFormatSymbol	GetSelectionFormat ()
int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false) override
	Usually applies factory to self and given access. More...
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
bool	TransferDataToWindow (const EffectSettings &settings) override
	Update controls for the settings. More...
bool	TransferDataFromWindow (EffectSettings &settings) override
	Update the given settings from controls. More...
unsigned	TestUIFlags (unsigned mask)
bool	Delegate (Effect &delegate, EffectSettings &settings)
	Re-invoke DoEffect on another Effect object that implements the work. More...
int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) const
bool	EnableApply (bool enable=true)
wxWindow *	GetUIParent ()
Public Member Functions inherited from EffectBase
	EffectBase ()
	~EffectBase () override
void	SetTracks (TrackList *pTracks)
Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()
virtual int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal=false)=0
virtual bool	IsGraphicalUI ()=0
virtual std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)=0
	Adds controls to a panel that is given as the parent window of S More...
virtual bool	CanExportPresets ()=0
virtual void	ExportPresets (const EffectSettings &settings) const =0
virtual OptionalMessage	ImportPresets (EffectSettings &settings)=0
virtual bool	HasOptions ()=0
virtual void	ShowOptions ()=0
virtual bool	ValidateUI (EffectSettings &settings)=0
virtual bool	CloseUI ()=0
Public Member Functions inherited from EffectPlugin
EffectPlugin &	operator= (EffectPlugin &)=delete
virtual	~EffectPlugin ()
virtual const EffectSettingsManager &	GetDefinition () const =0
virtual int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)=0
	Usually applies factory to self and given access. More...
virtual EffectUIClientInterface *	GetEffectUIClientInterface ()=0
	Returns the EffectUIClientInterface instance for this effect. More...
virtual void	Preview (EffectSettingsAccess &access, bool dryOnly)=0
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, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={}, const EffectSettingsAccessPtr &pAccess=nullptr)=0
	Unfortunately complicated dual-use function. More...
virtual bool	TransferDataToWindow (const EffectSettings &settings)=0
	Update controls for the settings. More...
virtual bool	TransferDataFromWindow (EffectSettings &settings)=0
	Update the given settings from controls. More...
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	EnablePreview (bool enable=true)
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...
virtual std::unique_ptr< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)
	Add controls to effect panel; always succeeds. 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)
std::shared_ptr< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())
ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())
Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)
Protected Member Functions inherited from EffectBase
void	Preview (EffectSettingsAccess &access, bool dryOnly) override
bool	DoEffect (EffectSettings &settings, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent, const EffectDialogFactory &dialogFactory, const EffectSettingsAccessPtr &pAccess) override
	Unfortunately complicated dual-use function. 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

Protected Attributes
wxWeakRef< wxDialog >	mHostUIDialog
	This smart pointer tracks the lifetime of the dialog. More...
wxWindow *	mUIParent {}
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 }

Private Member Functions
wxString	GetSavedStateGroup ()

Private Attributes
bool	mIsBatch { false }

Additional Inherited Members
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>")
Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

Base class for many of the effects in Audacity.

Definition at line 60 of file Effect.h.

Member Enumeration Documentation

anonymous enum

anonymous enum : long

Enumerator
DefaultMessageBoxStyle

Definition at line 176 of file Effect.h.

: long { DefaultMessageBoxStyle = wxOK | wxCENTRE };

Constructor & Destructor Documentation

Effect()

Effect::Effect

(

)

Definition at line 58 of file Effect.cpp.

{
}

~Effect()

Effect::~Effect ( )

virtual

Definition at line 62 of file Effect.cpp.

{
   // Destroying what is usually the unique Effect object of its subclass,
   // which lasts until the end of the session.
   // Maybe there is a non-modal realtime dialog still open.
   if (mHostUIDialog)
      mHostUIDialog->Close();
}

References mHostUIDialog.

Member Function Documentation

AddAnalysisTrack()

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

protected

Definition at line 796 of file Effect.cpp.

{
   return std::shared_ptr<AddedAnalysisTrack>
      { safenew AddedAnalysisTrack{ this, name } };
}

References name, and safenew.

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

Here is the caller graph for this function:

AddToOutputTracks()

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

protected

Definition at line 760 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.

Reimplemented in EffectPaulstretch, EffectTimeScale, and EffectTruncSilence.

Definition at line 857 of file Effect.cpp.

{
   return previewLength;
}

Referenced by PerTrackEffect::ProcessPass().

Here is the caller graph for this function:

CanExportPresets()

bool Effect::CanExportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 320 of file Effect.cpp.

{
   return true;
}

CheckWhetherSkipEffect()

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

overrideprotectedvirtual

Default implementation returns false.

Implements EffectBase.

Reimplemented in EffectNoiseRemoval, and EffectNormalize.

Definition at line 852 of file Effect.cpp.

{
   return false;
}

CloseUI()

bool Effect::CloseUI ( )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in EffectEqualization, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 313 of file Effect.cpp.

{
   mUIParent = nullptr;
   mUIDialog = nullptr;
   return true;
}

References EffectBase::mUIDialog, and mUIParent.

Referenced by EffectEqualization::CloseUI().

Here is the caller graph for this function:

CopyInputTracks()

void Effect::CopyInputTracks ( bool  allSyncLockSelected = false )

protected

Definition at line 733 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();
      };
 
   t2bHash added;
 
   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 586 of file Effect.cpp.

{
   NotifyingSelectedRegion region;
   region.setTimes( mT0, mT1 );
 
   return delegate.DoEffect(settings, mProjectRate, mTracks, mFactory,
      region, mUIFlags, nullptr, nullptr, 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:

EnableApply()

bool Effect::EnableApply

(

bool

enable = true

)

Definition at line 612 of file Effect.cpp.

{
   // May be called during initialization, so try to find the dialog
   wxWindow *dlg = mUIDialog;
   if (!dlg && mUIParent)
   {
      dlg = wxGetTopLevelParent(mUIParent);
   }
 
   if (dlg)
   {
      wxWindow *apply = dlg->FindWindow(wxID_APPLY);
 
      // Don't allow focus to get trapped
      if (!enable)
      {
         wxWindow *focus = dlg->FindFocus();
         if (focus == apply)
         {
            dlg->FindWindow(wxID_CLOSE)->SetFocus();
         }
      }
 
      if (apply)
         apply->Enable(enable);
   }
 
   EnablePreview(enable);
 
   return enable;
}

References EnablePreview(), EffectBase::mUIDialog, and mUIParent.

Referenced by EffectAmplify::CheckClip(), EffectRepeat::DisplayNewTime(), EffectPhaser::Validator::EnableApplyFromTransferDataFromWindow(), EffectWahwah::Validator::EnableApplyFromTransferDataToWindow(), EffectPhaser::Validator::EnableApplyFromValidate(), EffectWahwah::Validator::EnableApplyFromValidate(), EffectAmplify::OnAmpText(), EffectBassTreble::OnBassSlider(), EffectBassTreble::OnBassText(), EffectTruncSilence::OnControlChange(), EffectToneGen::OnControlUpdate(), EffectScienFilter::OnCutoff(), EffectBassTreble::OnGainSlider(), EffectBassTreble::OnGainText(), EffectAmplify::OnPeakText(), EffectScienFilter::OnRipple(), EffectScienFilter::OnStopbandRipple(), EffectPaulstretch::OnText(), EffectTimeScale::OnText_PitchHalfStepsEnd(), EffectTimeScale::OnText_PitchHalfStepsStart(), EffectTimeScale::OnText_PitchPercentChangeEnd(), EffectTimeScale::OnText_PitchPercentChangeStart(), EffectTimeScale::OnText_RatePercentChangeEnd(), EffectTimeScale::OnText_RatePercentChangeStart(), EffectBassTreble::OnTrebleSlider(), EffectBassTreble::OnTrebleText(), EffectChangeSpeed::UpdateUI(), EffectLoudness::UpdateUI(), and EffectNormalize::UpdateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

EnablePreview()

bool Effect::EnablePreview ( bool  enable = true )

protected

Definition at line 644 of file Effect.cpp.

{
   // May be called during initialization, so try to find the dialog
   wxWindow *dlg = mUIDialog;
   if (!dlg && mUIParent)
   {
      dlg = wxGetTopLevelParent(mUIParent);
   }
 
   if (dlg)
   {
      wxWindow *play = dlg->FindWindow(kPlayID);
      if (play)
      {
         // Don't allow focus to get trapped
         if (!enable)
         {
            wxWindow *focus = dlg->FindFocus();
            if (focus == play)
            {
               dlg->FindWindow(wxID_CLOSE)->SetFocus();
            }
         }
 
         play->Enable(enable);
      }
   }
 
   return enable;
}

References kPlayID, EffectBase::mUIDialog, and mUIParent.

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

Here is the caller graph for this function:

ExportPresets()

void Effect::ExportPresets ( const EffectSettings &  settings ) const

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 334 of file Effect.cpp.

{
   wxString params;
   SaveSettingsAsString(settings, params);
   auto commandId = GetSquashedName(GetSymbol().Internal());
   params =  commandId.GET() + ":" + params;
 
   auto path = SelectFile(FileNames::Operation::Presets,
                                     XO("Export Effect Parameters"),
                                     wxEmptyString,
                                     wxEmptyString,
                                     wxEmptyString,
                                     PresetTypes(),
                                     wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER,
                                     nullptr);
   if (path.empty()) {
      return;
   }
 
   // Create/Open the file
   wxFFile f(path, wxT("wb"));
   if (!f.IsOpened())
   {
      AudacityMessageBox(
         XO("Could not open file: \"%s\"").Format( path ),
         XO("Error Saving Effect Presets"),
         wxICON_EXCLAMATION,
         NULL);
      return;
   }
 
   f.Write(params);
   if (f.Error())
   {
      AudacityMessageBox(
         XO("Error writing to file: \"%s\"").Format( path ),
         XO("Error Saving Effect Presets"),
         wxICON_EXCLAMATION,
         NULL);
   }
 
   f.Close();
 
 
   //SetWindowTitle();
 
}

References AudacityMessageBox(), EffectDefinitionInterface::GetSquashedName(), GetSymbol(), Internal, params, PresetTypes(), SaveSettingsAsString(), SelectFile(), settings(), wxT(), and XO.

Here is the call graph for this function:

FetchParameters()

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

inlinestatic

Definition at line 71 of file Effect.h.

   { return &e; }

GetBounds()

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

protected

Definition at line 703 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 448 of file Effect.cpp.

{
   return *this;
}

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

Here is the caller graph for this function:

GetDescription()

TranslatableString Effect::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Reimplemented in EffectEqualization, EffectFade, EffectFindClipping, EffectInvert, LadspaEffect, EffectLoudness, LV2Effect, EffectNoise, EffectNoiseReduction, EffectNormalize, NyquistEffect, EffectPaulstretch, EffectPhaser, EffectRepair, EffectRepeat, EffectReverb, EffectReverse, EffectScienFilter, EffectSilence, EffectStereoToMono, EffectTimeScale, EffectToneGen, EffectTruncSilence, VampEffect, VSTEffect, VST3Effect, and EffectWahwah.

Definition at line 93 of file Effect.cpp.

{
   return {};
}

GetEffectUIClientInterface()

EffectUIClientInterface * Effect::GetEffectUIClientInterface ( )

overridevirtual

Returns the EffectUIClientInterface instance for this effect.

Usually returns self. May return nullptr. EffectPlugin is responsible for the lifetime of the returned instance.

Returns

EffectUIClientInterface object or nullptr, if the effect does not implement the interface.

Implements EffectPlugin.

Definition at line 871 of file Effect.cpp.

{
   return this;
}

GetFactoryPresets()

RegistryPaths Effect::GetFactoryPresets ( ) const

overridevirtual

Report names of factory presets.

Implements EffectSettingsManager.

Reimplemented in EffectEqualization, LadspaEffect, LV2Effect, EffectReverb, VSTEffect, and VST3Effect.

Definition at line 263 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.

Reimplemented in LadspaEffect, LV2Effect, NyquistEffect, VampEffect, VSTEffect, and VST3Effect.

Definition at line 105 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 225 of file Effect.h.

{ return mNumGroups; }

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 224 of file Effect.h.

{ return mNumTracks; }

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.

Reimplemented in LadspaEffect, LV2Effect, NyquistEffect, VampEffect, VSTEffect, and VST3Effect.

Definition at line 73 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 460 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 453 of file Effect.cpp.

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

References EffectBase::FindProject(), ProjectSettings::Get(), ProjectSettings::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.

Reimplemented in EffectEqualization, EffectFade, EffectFindClipping, EffectInvert, LadspaEffect, EffectLoudness, LV2Effect, EffectNoise, EffectNoiseReduction, EffectNormalize, NyquistEffect, EffectPaulstretch, EffectPhaser, EffectRepair, EffectRepeat, EffectReverb, EffectReverse, EffectSBSMS, EffectScienFilter, EffectSilence, EffectStereoToMono, EffectTimeScale, EffectToneGen, EffectTruncSilence, VampEffect, VSTEffect, VST3Effect, and EffectWahwah.

Definition at line 78 of file Effect.cpp.

{
   return {};
}

Referenced by ExportPresets(), GetPath(), and ImportPresets().

Here is the caller graph for this function:

GetType()

EffectType Effect::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Reimplemented in EffectEqualization, EffectFade, EffectFindClipping, EffectInvert, LadspaEffect, EffectLoudness, LV2Effect, EffectNoise, EffectNoiseReduction, EffectNoiseRemoval, EffectNormalize, NyquistEffect, EffectPaulstretch, EffectPhaser, EffectRepair, EffectRepeat, EffectReverb, EffectReverse, EffectScienFilter, EffectSilence, EffectStereoToMono, EffectTimeScale, EffectToneGen, EffectTruncSilence, VampEffect, VSTEffect, VST3Effect, and EffectWahwah.

Definition at line 100 of file Effect.cpp.

{
   return EffectTypeNone;
}

References EffectTypeNone.

Referenced by PerTrackEffect::ProcessPass().

Here is the caller graph for this function:

GetUIParent()

wxWindow * Effect::GetUIParent ( )

inline

Definition at line 310 of file Effect.h.

{ return mUIParent; }

Referenced by EffectPhaser::Validator::EnableApplyFromTransferDataFromWindow(), EffectWahwah::Validator::EnableApplyFromTransferDataToWindow(), EffectPhaser::Validator::EnableApplyFromValidate(), EffectWahwah::Validator::EnableApplyFromValidate(), EffectPhaser::Validator::UpdateUI(), and EffectPhaser::Validator::ValidateUI().

Here is the caller graph for this function:

GetVendor()

VendorSymbol Effect::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Reimplemented in LadspaEffect, LV2Effect, NyquistEffect, VampEffect, VSTEffect, and VST3Effect.

Definition at line 83 of file Effect.cpp.

{
   return XO("Audacity");
}

References XO.

GetVersion()

wxString Effect::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Reimplemented in LadspaEffect, LV2Effect, NyquistEffect, VampEffect, VSTEffect, and VST3Effect.

Definition at line 88 of file Effect.cpp.

{
   return AUDACITY_VERSION_STRING;
}

HasOptions()

bool Effect::HasOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 437 of file Effect.cpp.

{
   return false;
}

ImportPresets()

OptionalMessage Effect::ImportPresets ( EffectSettings &  settings )

overridevirtual

Returns

nullopt for failure

Implements EffectUIClientInterface.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 382 of file Effect.cpp.

{
   wxString params;
 
   auto path = SelectFile(FileNames::Operation::Presets,
                                     XO("Import Effect Parameters"),
                                     wxEmptyString,
                                     wxEmptyString,
                                     wxEmptyString,
                                     PresetTypes(),
                                     wxFD_OPEN | wxRESIZE_BORDER,
                                     nullptr);
   if (path.empty()) {
      return {};
   }
 
   wxFFile f(path);
   if (!f.IsOpened())
      return {};
 
   OptionalMessage result{};
 
   if (f.ReadAll(&params)) {
      wxString ident = params.BeforeFirst(':');
      params = params.AfterFirst(':');
 
      auto commandId = GetSquashedName(GetSymbol().Internal());
 
      if (ident != commandId) {
         // effect identifiers are a sensible length!
         // must also have some params.
         if ((params.Length() < 2 ) || (ident.Length() < 2) || (ident.Length() > 30))
         {
            Effect::MessageBox(
               /* i18n-hint %s will be replaced by a file name */
               XO("%s: is not a valid presets file.\n")
               .Format(wxFileNameFromPath(path)));
         }
         else
         {
            Effect::MessageBox(
               /* i18n-hint %s will be replaced by a file name */
               XO("%s: is for a different Effect, Generator or Analyzer.\n")
               .Format(wxFileNameFromPath(path)));
         }
         return {};
      }
      result = LoadSettingsFromString(params, settings);
   }
 
   //SetWindowTitle();
 
   return result;
}

References EffectDefinitionInterface::GetSquashedName(), GetSymbol(), ident(), Internal, LoadSettingsFromString(), MessageBox(), params, PresetTypes(), SelectFile(), settings(), and XO.

Here is the call graph for this function:

IncEffectCounter()

static void Effect::IncEffectCounter ( )

inlinestatic

Definition at line 181 of file Effect.h.

{ nEffectsDone++;}

Referenced by SelectTracksCommand::Apply().

Here is the caller graph for this function:

IsBatchProcessing()

bool Effect::IsBatchProcessing ( ) const

overridevirtual

Implements EffectPlugin.

Definition at line 559 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.

Reimplemented in LadspaEffect, LV2Effect, NyquistEffect, VampEffect, VSTEffect, and VST3Effect.

Definition at line 117 of file Effect.cpp.

{
   return true;
}

IsGraphicalUI()

bool Effect::IsGraphicalUI ( )

overridevirtual

Returns

false

Implements EffectUIClientInterface.

Reimplemented in VSTEffect.

Definition at line 303 of file Effect.cpp.

{
   return false;
}

IsInteractive()

bool Effect::IsInteractive ( ) const

overridevirtual

Whether the effect needs a dialog for entry of settings.

Implements EffectDefinitionInterface.

Reimplemented in EffectFade, EffectInvert, LadspaEffect, LV2Effect, NyquistEffect, EffectRepair, EffectReverse, EffectStereoToMono, VampEffect, VSTEffect, and VST3Effect.

Definition at line 112 of file Effect.cpp.

{
   return true;
}

Referenced by ShowHostInterface().

Here is the caller graph for this function:

LoadFactoryDefaults()

OptionalMessage Effect::LoadFactoryDefaults ( EffectSettings &  settings ) const

overridevirtual

Change settings back to "factory default"

Returns

nullopt for failure

Implements EffectSettingsManager.

Reimplemented in EffectEqualization.

Definition at line 273 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.

Reimplemented in EffectEqualization, LadspaEffect, LV2Effect, EffectReverb, VSTEffect, and VST3Effect.

Definition at line 268 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.

Reimplemented in LadspaEffect, LV2Effect, NyquistEffect, EffectTruncSilence, VampEffect, VSTEffect, and VST3Effect.

Definition at line 230 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 );
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

LoadSettingsFromString()

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

overridevirtual

Implements EffectPlugin.

Definition at line 485 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)
   {
      Effect::MessageBox(
         XO("%s: Could not load settings below. Default settings will be used.\n\n%s")
            .Format( GetName(), preset ) );
      // We are using default settings and we still wish to continue.
      result = { nullptr };
      //return false;
   }
   return result;
}

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

Referenced by ImportPresets(), and 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.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 238 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:

MessageBox()

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

Definition at line 863 of file Effect.cpp.

{
   auto title = titleStr.empty()
      ? GetName()
      : XO("%s: %s").Format( GetName(), titleStr );
   return AudacityMessageBox( message, title, style, mUIParent );
}

References AudacityMessageBox(), TranslatableString::empty(), ComponentInterface::GetName(), mUIParent, title, and XO.

Referenced by ImportPresets(), EffectAutoDuck::Init(), EffectEqualization::Init(), NyquistEffect::Init(), EffectScienFilter::Init(), VampEffect::Init(), EffectEqualization::LoadCurves(), LoadSettingsFromString(), NyquistEffect::OnLoad(), NyquistEffect::OnSave(), NyquistEffect::OnTime(), NyquistEffect::ParseProgram(), EffectClickRemoval::Process(), Generator::Process(), EffectNoiseReduction::Process(), NyquistEffect::Process(), EffectRepair::Process(), VampEffect::Process(), EffectTruncSilence::ProcessIndependently(), EffectDtmf::Instance::ProcessInitialize(), EffectEcho::Instance::ProcessInitialize(), NyquistEffect::ProcessOne(), EffectClickRemoval::ProcessOne(), EffectFindClipping::ProcessOne(), EffectPaulstretch::ProcessOne(), EffectEqualization::setCurve(), NyquistEffect::TransferDataFromEffectWindow(), and EffectEqualization::ValidateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

ModifyAnalysisTrack()

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

protected

Definition at line 846 of file Effect.cpp.

{
   return{ this, pOrigTrack, name };
}

References name.

Referenced by EffectFindClipping::Process().

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 141 of file Effect.cpp.

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

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

Here is the caller graph for this function:

PopulateOrExchange()

std::unique_ptr< EffectUIValidator > Effect::PopulateOrExchange ( ShuttleGui &  S, EffectInstance &  instance, EffectSettingsAccess &  access, const EffectOutputs *  pOutputs  )

protectedvirtual

Add controls to effect panel; always succeeds.

Returns

if not null, then return it from Effect::PopulateUI instead of a DefaultEffectUIValidator; default implementation returns null

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

Definition at line 595 of file Effect.cpp.

{
   return nullptr;
}

Referenced by PopulateUI().

Here is the caller graph for this function:

PopulateUI()

std::unique_ptr< EffectUIValidator > Effect::PopulateUI ( ShuttleGui &  S, EffectInstance &  instance, EffectSettingsAccess &  access, const EffectOutputs *  pOutputs  )

overridevirtual

Adds controls to a panel that is given as the parent window of S

Parameters

S	interface for adding controls to a panel in a dialog
instance	guaranteed to have a lifetime containing that of the returned object
access	guaranteed to have a lifetime containing that of the returned object
pOutputs	null, or else points to outputs with lifetime containing that of the returned object

Returns

null for failure; else an object invoked to retrieve values of UI controls; it might also hold some state needed to implement event handlers of the controls; it will exist only while the dialog continues to exist

Implements EffectUIClientInterface.

Reimplemented in LV2Effect, VSTEffect, and VST3Effect.

Definition at line 280 of file Effect.cpp.

{
   auto parent = S.GetParent();
   mUIParent = parent;
 
//   LoadUserPreset(CurrentSettingsGroup());
 
   // Let the effect subclass provide its own validator if it wants
   auto result = PopulateOrExchange(S, instance, access, pOutputs);
 
   mUIParent->SetMinSize(mUIParent->GetSizer()->GetMinSize());
 
   if (!result) {
      // No custom validator object?  Then use the default
      result = std::make_unique<DefaultEffectUIValidator>(
         *this, access, S.GetParent());
      mUIParent->PushEventHandler(this);
   }
   return result;
}

References mUIParent, PopulateOrExchange(), and S.

Here is the call graph for this function:

RealtimeSupport()

auto Effect::RealtimeSupport ( ) const

overridevirtual

Since which version of Audacity has the effect supported realtime?

Implements EffectDefinitionInterface.

Reimplemented in LadspaEffect, LV2Effect, EffectPhaser, EffectReverb, VSTEffect, VST3Effect, and EffectWahwah.

Definition at line 122 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.

Reimplemented in LadspaEffect, LV2Effect, NyquistEffect, VampEffect, VSTEffect, and VST3Effect.

Definition at line 223 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 467 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 ExportPresets(), and 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.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 251 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 564 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:

ShowClientInterface()

int Effect::ShowClientInterface ( wxWindow &  parent, wxDialog &  dialog, EffectUIValidator *  pValidator, bool  forceModal  )

overridevirtual

Returns

0 if destructive effect processing should not proceed (and there may be a non-modal dialog still opened); otherwise, modal dialog return code

Implements EffectUIClientInterface.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 147 of file Effect.cpp.

{
   // Remember the dialog with a weak pointer, but don't control its lifetime
   mUIDialog = &dialog;
   mUIDialog->Layout();
   mUIDialog->Fit();
   mUIDialog->SetMinSize(mUIDialog->GetSize());
   if (VetoDialogHook::Call(mUIDialog))
      return 0;
   if (SupportsRealtime() && !forceModal) {
      mUIDialog->Show();
      // Return false to bypass effect processing
      return 0;
   }
   return mUIDialog->ShowModal();
}

References GlobalHook< VetoDialogHook, bool(wxDialog *) >::Call(), EffectBase::mUIDialog, and EffectDefinitionInterface::SupportsRealtime().

Here is the call graph for this function:

ShowHostInterface()

int Effect::ShowHostInterface ( wxWindow &  parent, const EffectDialogFactory &  factory, std::shared_ptr< EffectInstance > &  pInstance, EffectSettingsAccess &  access, bool  forceModal = false  )

overridevirtual

Usually applies factory to self and given access.

But there are a few unusual overrides for historical reasons

Parameters

pInstance	may be passed to factory, and is only guaranteed to have lifetime suitable for a modal dialog, unless the dialog stores a copy of pInstance
access	is only guaranteed to have lifetime suitable for a modal dialog, unless the dialog stores access.shared_from_this()

Returns

0 if destructive effect processing should not proceed (and there may be a non-modal dialog still opened); otherwise, modal dialog return code

Implements EffectPlugin.

Reimplemented in EffectNoiseReduction, EffectNoiseRemoval, and NyquistEffect.

Definition at line 165 of file Effect.cpp.

{
   if (!IsInteractive())
      // Effect without UI just proceeds quietly to apply it destructively.
      return wxID_APPLY;
 
   if (mHostUIDialog)
   {
      // Realtime effect has shown its nonmodal dialog, now hides it, and does
      // nothing else.
      if ( mHostUIDialog->Close(true) )
         mHostUIDialog = nullptr;
      return 0;
   }
 
   // Create the dialog
   // Host, not client, is responsible for invoking the factory and managing
   // the lifetime of the dialog.
   // The usual factory lets the client (which is this, when self-hosting)
   // populate it.  That factory function is called indirectly through a
   // std::function to avoid source code dependency cycles.
   EffectUIClientInterface *const client = this;
   auto results = factory(parent, *this, *client, access);
   mHostUIDialog = results.pDialog;
   pInstance = results.pInstance;
   if (!mHostUIDialog)
      return 0;
 
   // Let the client show the dialog and decide whether to keep it open
   auto result = client->ShowClientInterface(parent, *mHostUIDialog,
      results.pValidator, forceModal);
   if (mHostUIDialog && !mHostUIDialog->IsShown())
      // Client didn't show it, or showed it modally and closed it
      // So destroy it.
      // (I think mHostUIDialog only needs to be a local variable in this
      // function -- that it is always null when the function begins -- but
      // that may change. PRL)
      mHostUIDialog->Destroy();
 
   return result;
}

References cloud::factory, IsInteractive(), mHostUIDialog, and EffectUIClientInterface::ShowClientInterface().

Referenced by NyquistEffect::ShowHostInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowOptions()

void Effect::ShowOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 442 of file Effect.cpp.

{
}

SupportsAutomation()

bool Effect::SupportsAutomation ( ) const

overridevirtual

Whether the effect has any automatable controls.

Implements EffectDefinitionInterface.

Reimplemented in LadspaEffect, LV2Effect, EffectNoiseRemoval, VSTEffect, and VST3Effect.

Definition at line 127 of file Effect.cpp.

{
   return true;
}

TestUIFlags()

unsigned Effect::TestUIFlags

(

unsigned

mask

)

Definition at line 555 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 675 of file Effect.cpp.

{
   auto updateResult = (mProgress ?
      mProgress->Poll(frac * 1000, 1000, msg) :
      ProgressResult::Success);
   return (updateResult != 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 693 of file Effect.cpp.

{
   auto updateResult = (mProgress ?
      mProgress->Poll((whichGroup + frac) * 1000,
         (double) mNumGroups * 1000, msg) :
      ProgressResult::Success);
   return (updateResult != 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 683 of file Effect.cpp.

{
   auto updateResult = (mProgress ?
      mProgress->Poll((whichTrack + frac) * 1000,
         (double) mNumTracks * 1000, msg) :
      ProgressResult::Success);
   return (updateResult != 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:

TransferDataFromWindow()

bool Effect::TransferDataFromWindow ( EffectSettings &  settings )

overridevirtual

Update the given settings from controls.

Implements EffectPlugin.

Reimplemented in EffectFindClipping, EffectLoudness, EffectNoise, EffectNormalize, NyquistEffect, EffectPaulstretch, EffectRepeat, EffectScienFilter, EffectSilence, EffectTimeScale, EffectToneGen, EffectTruncSilence, and VampEffect.

Definition at line 607 of file Effect.cpp.

{
   return true;
}

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

Here is the caller graph for this function:

TransferDataToWindow()

bool Effect::TransferDataToWindow ( const EffectSettings &  settings )

overridevirtual

Update controls for the settings.

Implements EffectPlugin.

Reimplemented in EffectEqualization, EffectFindClipping, EffectLoudness, EffectNoise, EffectNormalize, NyquistEffect, EffectPaulstretch, EffectRepeat, EffectScienFilter, EffectSilence, EffectTimeScale, EffectToneGen, EffectTruncSilence, and VampEffect.

Definition at line 602 of file Effect.cpp.

{
   return true;
}

UnsetBatchProcessing()

void Effect::UnsetBatchProcessing ( )

overridevirtual

Implements EffectPlugin.

Definition at line 575 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:

ValidateUI()

bool Effect::ValidateUI ( EffectSettings &  )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in EffectEqualization.

Definition at line 308 of file Effect.cpp.

{
   return true;
}

Referenced by LadspaEffect::Validator::OnCheckBox(), EffectPhaser::Validator::OnDepthSlider(), EffectWahwah::Validator::OnDepthSlider(), EffectPhaser::Validator::OnDepthText(), EffectWahwah::Validator::OnDepthText(), EffectPhaser::Validator::OnDryWetSlider(), EffectPhaser::Validator::OnDryWetText(), EffectPhaser::Validator::OnFeedbackSlider(), EffectPhaser::Validator::OnFeedbackText(), EffectWahwah::Validator::OnFreqOffSlider(), EffectWahwah::Validator::OnFreqOffText(), EffectPhaser::Validator::OnFreqSlider(), EffectWahwah::Validator::OnFreqSlider(), EffectPhaser::Validator::OnFreqText(), EffectWahwah::Validator::OnFreqText(), EffectPhaser::Validator::OnGainSlider(), EffectWahwah::Validator::OnGainSlider(), EffectPhaser::Validator::OnGainText(), EffectWahwah::Validator::OnGainText(), EffectPhaser::Validator::OnPhaseSlider(), EffectWahwah::Validator::OnPhaseSlider(), EffectPhaser::Validator::OnPhaseText(), EffectWahwah::Validator::OnPhaseText(), EffectWahwah::Validator::OnResonanceSlider(), EffectWahwah::Validator::OnResonanceText(), LadspaEffect::Validator::OnSlider(), EffectPhaser::Validator::OnStagesSlider(), EffectPhaser::Validator::OnStagesText(), LadspaEffect::Validator::OnTextCtrl(), and SpinSliderHandlers().

Here is the caller 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.

Reimplemented in EffectEqualization, and NyquistEffect.

Definition at line 216 of file Effect.cpp.

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

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.

Reimplemented in EffectEqualization, and NyquistEffect.

Definition at line 210 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

mHostUIDialog

wxWeakRef<wxDialog> Effect::mHostUIDialog

protected

This smart pointer tracks the lifetime of the dialog.

Definition at line 306 of file Effect.h.

Referenced by ShowHostInterface(), and ~Effect().

mIsBatch

bool Effect::mIsBatch { false }

private

Definition at line 315 of file Effect.h.

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

mUIParent

wxWindow* Effect::mUIParent {}

protected

Definition at line 307 of file Effect.h.

Referenced by CloseUI(), EffectAutoDuck::DoTransferDataToWindow(), EnableApply(), EnablePreview(), MessageBox(), EffectBassTreble::OnBassSlider(), EffectBassTreble::OnBassText(), EffectTruncSilence::OnControlChange(), EffectToneGen::OnControlUpdate(), EffectScienFilter::OnCutoff(), NyquistEffect::OnFileButton(), EffectBassTreble::OnGainSlider(), EffectBassTreble::OnGainText(), NyquistEffect::OnLoad(), EffectEqualization::OnManage(), EditCurvesDialog::OnOK(), EffectScienFilter::OnRipple(), NyquistEffect::OnSave(), EffectEqualization::OnSize(), EffectScienFilter::OnSize(), NyquistEffect::OnSlider(), EffectScienFilter::OnStopbandRipple(), NyquistEffect::OnText(), EffectPaulstretch::OnText(), EffectTimeScale::OnText_PitchHalfStepsEnd(), EffectTimeScale::OnText_PitchHalfStepsStart(), EffectTimeScale::OnText_PitchPercentChangeEnd(), EffectTimeScale::OnText_PitchPercentChangeStart(), EffectTimeScale::OnText_RatePercentChangeEnd(), EffectTimeScale::OnText_RatePercentChangeStart(), NyquistEffect::OnTime(), EffectBassTreble::OnTrebleSlider(), EffectBassTreble::OnTrebleText(), EffectEqualization::PopulateOrExchange(), PopulateUI(), NyquistEffect::Process(), LadspaEffect::ShowOptions(), NyquistEffect::TransferDataFromEffectWindow(), EffectAmplify::TransferDataFromWindow(), EffectAutoDuck::TransferDataFromWindow(), EffectBassTreble::TransferDataFromWindow(), EffectChangeSpeed::TransferDataFromWindow(), EffectClickRemoval::TransferDataFromWindow(), EffectCompressor::TransferDataFromWindow(), EffectDistortion::TransferDataFromWindow(), EffectFindClipping::TransferDataFromWindow(), EffectLoudness::TransferDataFromWindow(), EffectNoise::TransferDataFromWindow(), EffectNormalize::TransferDataFromWindow(), NyquistEffect::TransferDataFromWindow(), EffectPaulstretch::TransferDataFromWindow(), EffectRepeat::TransferDataFromWindow(), EffectScienFilter::TransferDataFromWindow(), EffectTimeScale::TransferDataFromWindow(), EffectToneGen::TransferDataFromWindow(), EffectTruncSilence::TransferDataFromWindow(), VampEffect::TransferDataFromWindow(), NyquistEffect::TransferDataToEffectWindow(), EffectBassTreble::TransferDataToWindow(), EffectChangeSpeed::TransferDataToWindow(), EffectClickRemoval::TransferDataToWindow(), EffectDistortion::TransferDataToWindow(), EffectEqualization::TransferDataToWindow(), EffectFindClipping::TransferDataToWindow(), EffectLoudness::TransferDataToWindow(), EffectNoise::TransferDataToWindow(), EffectNormalize::TransferDataToWindow(), NyquistEffect::TransferDataToWindow(), EffectPaulstretch::TransferDataToWindow(), EffectScienFilter::TransferDataToWindow(), EffectTimeScale::TransferDataToWindow(), EffectToneGen::TransferDataToWindow(), EffectTruncSilence::TransferDataToWindow(), VampEffect::TransferDataToWindow(), EffectScienFilter::TransferGraphLimitsFromWindow(), EffectEqualization::UpdateDraw(), EffectEqualization::UpdateGraphic(), EffectLoudness::UpdateUI(), and EffectNormalize::UpdateUI().

---

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

• Effect.h
• Effect.cpp