An Effect object is at once host and client: it is self-hosting. More...

#include <Effect.h>

Inheritance diagram for Effect:

Collaboration diagram for Effect:

Classes
class	AddedAnalysisTrack

class	ModifiedAnalysisTrack

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

using	VetoDialogHook = bool()(wxDialog )

Public Member Functions
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () override

ComponentInterfaceSymbol	GetSymbol () override

VendorSymbol	GetVendor () override

wxString	GetVersion () override

TranslatableString	GetDescription () override

EffectType	GetType () override

EffectFamilySymbol	GetFamily () override

bool	IsInteractive () override

bool	IsDefault () override

bool	IsLegacy () override

bool	SupportsRealtime () override

bool	SupportsAutomation () override

bool	SetHost (EffectHostInterface *host) override

unsigned	GetAudioInCount () override

unsigned	GetAudioOutCount () override

int	GetMidiInCount () override

int	GetMidiOutCount () override

sampleCount	GetLatency () override

size_t	GetTailSize () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

bool	IsReady () override

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

bool	ProcessFinalize () override

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

bool	RealtimeInitialize () override

bool	RealtimeAddProcessor (unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	RealtimeProcessStart () override

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

bool	RealtimeProcessEnd () override

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override

bool	GetAutomationParameters (CommandParameters &parms) override

bool	SetAutomationParameters (CommandParameters &parms) override

bool	LoadUserPreset (const RegistryPath &name) override

bool	SaveUserPreset (const RegistryPath &name) override

RegistryPaths	GetFactoryPresets () override

bool	LoadFactoryPreset (int id) override

bool	LoadFactoryDefaults () override

bool	PopulateUI (ShuttleGui &S) final
	Adds controls to a panel that is given as the parent window of `S` More...

bool	IsGraphicalUI () override

bool	ValidateUI () override

bool	HideUI () override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets () override

void	ImportPresets () override

bool	HasOptions () override

void	ShowOptions () override

EffectDefinitionInterface &	GetDefinition () override

double	GetDefaultDuration () override

double	GetDuration () override

NumericFormatSymbol	GetDurationFormat () override

virtual NumericFormatSymbol	GetSelectionFormat ()

void	SetDuration (double duration) override

RegistryPath	GetUserPresetsGroup (const RegistryPath &name) override

RegistryPath	GetCurrentSettingsGroup () override

RegistryPath	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

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

virtual bool	Startup (EffectUIClientInterface *client)

virtual bool	Startup ()

virtual bool	GetAutomationParameters (wxString &parms)

virtual bool	SetAutomationParameters (const wxString &parms)

virtual RegistryPaths	GetUserPresets ()

virtual bool	HasCurrentSettings ()

virtual bool	HasFactoryDefaults ()

virtual ManualPageID	ManualPage ()

virtual FilePath	HelpPage ()

virtual void	SetUIFlags (unsigned flags)

virtual unsigned	TestUIFlags (unsigned mask)

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

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

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

virtual bool	IsHidden ()

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

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

Public Member Functions inherited from EffectClientInterface
virtual	~EffectClientInterface ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetClassification ()

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

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

TranslatableString	GetName ()

virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Public Member Functions inherited from EffectUIHostInterface
virtual	~EffectUIHostInterface ()

Public Member Functions inherited from EffectHostInterface
virtual	~EffectHostInterface ()

Static Public Member Functions
static VetoDialogHook	SetVetoDialogHook (VetoDialogHook hook)

static CommandID	GetSquashedName (wxString name)

static void	IncEffectCounter ()

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

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

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

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

Protected Member Functions
virtual bool	Init ()

virtual bool	CheckWhetherSkipEffect ()

virtual bool	Process ()

virtual bool	ProcessPass ()

virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual int	GetPass ()

virtual void	End ()

virtual double	CalcPreviewInputLength (double previewLength)

virtual void	Preview (bool dryOnly)

virtual void	PopulateOrExchange (ShuttleGui &S)

virtual bool	TransferDataToWindow ()

virtual bool	TransferDataFromWindow ()

virtual bool	EnableApply (bool enable=true)

virtual bool	EnablePreview (bool enable=true)

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

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

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

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks (bool allSyncLockSelected=false)

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

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

void	ReplaceProcessedTracks (const bool bGoodResult)

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

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes
ProgressDialog *	mProgress

double	mProjectRate

double	mSampleRate

wxWeakRef< NotifyingSelectedRegion >	mpSelectedRegion {}

WaveTrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxWindowPtr< wxDialog >	mHostUIDialog
	This smart pointer controls the lifetime of the dialog. More...

wxWeakRef< wxDialog >	mUIDialog
	This weak pointer may be the same as the above, or null. More...

wxWindow *	mUIParent

unsigned	mUIFlags

sampleCount	mSampleCnt

Static Protected Attributes
static int	nEffectsDone =0

Private Member Functions
void	CountWaveTracks ()

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

Private Attributes
TrackList *	mTracks

bool	mIsBatch

bool	mIsLinearEffect

bool	mPreviewWithNotSelected

bool	mPreviewFullSelection

double	mDuration

NumericFormatSymbol	mDurationFormat

bool	mIsPreview

std::vector< Track * >	mIMap

std::vector< Track * >	mOMap

int	mNumTracks

int	mNumGroups

EffectUIClientInterface *	mClient

size_t	mNumAudioIn

size_t	mNumAudioOut

size_t	mBufferSize

size_t	mBlockSize

unsigned	mNumChannels

Friends
class	EffectUIHost

Detailed Description

An Effect object is at once host and client: it is self-hosting.

Base class for many of the effects in Audacity.

Definition at line 73 of file Effect.h.

Member Typedef Documentation

◆ VetoDialogHook

using Effect::VetoDialogHook = bool (*) ( wxDialog* )

Definition at line 91 of file Effect.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : long

Enumerator
DefaultMessageBoxStyle

Definition at line 244 of file Effect.h.

244 : long { DefaultMessageBoxStyle = wxOK | wxCENTRE };

Constructor & Destructor Documentation

◆ Effect()

Effect::Effect ( )

Definition at line 86 of file Effect.cpp.

 {
    mClient = NULL;
  
    mTracks = NULL;
    mT0 = 0.0;
    mT1 = 0.0;
    mDuration = 0.0;
    mIsPreview = false;
    mIsLinearEffect = false;
    mPreviewWithNotSelected = false;
    mPreviewFullSelection = false;
    mNumTracks = 0;
    mNumGroups = 0;
    mProgress = NULL;
  
    mUIParent = NULL;
    mUIFlags = 0;
  
    mNumAudioIn = 0;
    mNumAudioOut = 0;
  
    mBufferSize = 0;
    mBlockSize = 0;
    mNumChannels = 0;
  
    // PRL:  I think this initialization of mProjectRate doesn't matter
    // because it is always reassigned in DoEffect before it is used
    // STF: but can't call AudioIOBase::GetOptimalSupportedSampleRate() here.
    // (Which is called to compute the default-default value.)  (Bug 2280)
    mProjectRate = QualitySettings::DefaultSampleRate.ReadWithDefault(44100);
  
    mIsBatch = false;
 }

References QualitySettings::DefaultSampleRate, mBlockSize, mBufferSize, mClient, mDuration, mIsBatch, mIsLinearEffect, mIsPreview, mNumAudioIn, mNumAudioOut, mNumChannels, mNumGroups, mNumTracks, mPreviewFullSelection, mPreviewWithNotSelected, mProgress, mProjectRate, mT0, mT1, mTracks, mUIFlags, mUIParent, and Setting< T >::ReadWithDefault().

Here is the call graph for this function:

◆ ~Effect()

Effect::~Effect ( )

virtual

Definition at line 121 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 1996 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 1959 of file Effect.cpp.

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

References mIMap, mOMap, and mOutputTracks.

Referenced by NyquistEffect::ProcessOne().

Here is the caller graph for this function:

◆ CalcPreviewInputLength()

double Effect::CalcPreviewInputLength ( double previewLength )

protectedvirtual

Reimplemented in EffectTruncSilence, EffectTimeScale, EffectPaulstretch, and EffectChangeSpeed.

Definition at line 2146 of file Effect.cpp.

 {
    return previewLength;
 }

Referenced by Preview(), and ProcessTrack().

Here is the caller graph for this function:

◆ CanExportPresets()

bool Effect::CanExportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 667 of file Effect.cpp.

 {
    return true;
 }

◆ CheckWhetherSkipEffect()

virtual bool Effect::CheckWhetherSkipEffect ( )

inlineprotectedvirtual

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

Definition at line 269 of file Effect.h.

269 { return false; }

Referenced by DoEffect().

Here is the caller graph for this function:

◆ CloseUI()

bool Effect::CloseUI ( )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in EffectEqualization.

Definition at line 656 of file Effect.cpp.

 {
    if (mUIParent)
       mUIParent->RemoveEventHandler(this);
  
    mUIParent = NULL;
    mUIDialog = NULL;
  
    return true;
 }

References 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 1932 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(), FindProject(), SyncLock::IsSelectedOrSyncLockSelected(), mIMap, mOMap, mOutputTracks, and mTracks.

Referenced by 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:

◆ CountWaveTracks()

void Effect::CountWaveTracks ( )

private

Definition at line 2140 of file Effect.cpp.

 {
    mNumTracks = mTracks->Selected< const WaveTrack >().size();
    mNumGroups = mTracks->SelectedLeaders< const WaveTrack >().size();
 }

References mNumGroups, mNumTracks, mTracks, TrackList::Selected(), TrackList::SelectedLeaders(), and size.

Referenced by DoEffect(), and Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Delegate()

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

Definition at line 1206 of file Effect.cpp.

 {
    NotifyingSelectedRegion region;
    region.setTimes( mT0, mT1 );
  
    return delegate.DoEffect( mProjectRate, mTracks, mFactory,
       region, &parent, factory );
 }

References DoEffect(), factory, mFactory, mProjectRate, mT0, mT1, mTracks, and NotifyingSelectedRegion::setTimes().

Referenced by NyquistEffect::ShowHostInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoEffect()

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

Definition at line 1073 of file Effect.cpp.

 {
    wxASSERT(selectedRegion.duration() >= 0.0);
  
    mOutputTracks.reset();
  
    mpSelectedRegion = &selectedRegion;
    mFactory = factory;
    mProjectRate = projectRate;
    mTracks = list;
  
    // This is for performance purposes only, no additional recovery implied
    auto &pProject = *const_cast<AudacityProject*>(FindProject()); // how to remove this const_cast?
    auto &pIO = ProjectFileIO::Get(pProject);
    TransactionScope trans(pIO.GetConnection(), "Effect");
  
    // Update track/group counts
    CountWaveTracks();
  
    bool isSelection = false;
  
    mDuration = 0.0;
    if (GetType() == EffectTypeGenerate)
    {
       GetConfig(GetDefinition(), PluginSettings::Private,
          GetCurrentSettingsGroup(),
          wxT("LastUsedDuration"), mDuration, GetDefaultDuration());
    }
  
    WaveTrack *newTrack{};
    bool success = false;
    auto oldDuration = mDuration;
  
    auto cleanup = finally( [&] {
       if (!success) {
          if (newTrack) {
             mTracks->Remove(newTrack);
          }
          // LastUsedDuration may have been modified by Preview.
          SetDuration(oldDuration);
       }
       else
          trans.Commit();
  
       End();
       ReplaceProcessedTracks( false );
    } );
  
    // We don't yet know the effect type for code in the Nyquist Prompt, so
    // assume it requires a track and handle errors when the effect runs.
    if ((GetType() == EffectTypeGenerate || GetPath() == NYQUIST_PROMPT_ID) && (mNumTracks == 0)) {
       newTrack = mTracks->Add(mFactory->NewWaveTrack());
       newTrack->SetSelected(true);
    }
  
    mT0 = selectedRegion.t0();
    mT1 = selectedRegion.t1();
    if (mT1 > mT0)
    {
       // there is a selection: let's fit in there...
       // MJS: note that this is just for the TTC and is independent of the track rate
       // but we do need to make sure we have the right number of samples at the project rate
       double quantMT0 = QUANTIZED_TIME(mT0, mProjectRate);
       double quantMT1 = QUANTIZED_TIME(mT1, mProjectRate);
       mDuration = quantMT1 - quantMT0;
       isSelection = true;
       mT1 = mT0 + mDuration;
    }
  
    mDurationFormat = isSelection
       ? NumericConverter::TimeAndSampleFormat()
       : NumericConverter::DefaultSelectionFormat();
  
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
    mF0 = selectedRegion.f0();
    mF1 = selectedRegion.f1();
    wxArrayString Names;
    if( mF0 != SelectedRegion::UndefinedFrequency )
       Names.push_back(wxT("control-f0"));
    if( mF1 != SelectedRegion::UndefinedFrequency )
       Names.push_back(wxT("control-f1"));
    SetPresetParameters( &Names, NULL );
  
 #endif
    CountWaveTracks();
  
    // Note: Init may read parameters from preferences
    if (!Init())
    {
       return false;
    }
  
    // Prompting will be bypassed when applying an effect that has already
    // been configured, e.g. repeating the last effect on a different selection.
    // Prompting may call Effect::Preview
    if ( pParent && dialogFactory &&
       IsInteractive() &&
       !ShowHostInterface( *pParent, dialogFactory, IsBatchProcessing() ) )
    {
       return false;
    }
  
    bool returnVal = true;
    bool skipFlag = CheckWhetherSkipEffect();
    if (skipFlag == false)
    {
       auto name = GetName();
       ProgressDialog progress{
          name,
          XO("Applying %s...").Format( name ),
          pdlgHideStopButton
       };
       auto vr = valueRestorer( mProgress, &progress );
  
       {
          returnVal = Process();
       }
    }
  
    if (returnVal && (mT1 >= mT0 ))
    {
       selectedRegion.setTimes(mT0, mT1);
    }
  
    success = returnVal;
    return returnVal;
 }

References TrackList::Add(), CheckWhetherSkipEffect(), TransactionScope::Commit(), CountWaveTracks(), NumericConverter::DefaultSelectionFormat(), NotifyingSelectedRegion::duration(), EffectTypeGenerate, End(), NotifyingSelectedRegion::f0(), NotifyingSelectedRegion::f1(), factory, FindProject(), ProjectFileIO::Get(), PluginSettings::GetConfig(), GetCurrentSettingsGroup(), GetDefaultDuration(), GetDefinition(), ComponentInterface::GetName(), GetPath(), GetType(), Init(), IsBatchProcessing(), IsInteractive(), mDuration, mDurationFormat, mFactory, mNumTracks, mOutputTracks, mProgress, mProjectRate, mpSelectedRegion, mT0, mT1, mTracks, name, WaveTrackFactory::NewWaveTrack(), NYQUIST_PROMPT_ID, pdlgHideStopButton, PluginSettings::Private, Process(), QUANTIZED_TIME, TrackList::Remove(), ReplaceProcessedTracks(), SetDuration(), SetPresetParameters(), NotifyingSelectedRegion::setTimes(), ShowHostInterface(), NotifyingSelectedRegion::t0(), NotifyingSelectedRegion::t1(), NumericConverter::TimeAndSampleFormat(), SelectedRegion::UndefinedFrequency, valueRestorer(), and XO.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableApply()

bool Effect::EnableApply ( bool enable = true )

protectedvirtual

Definition at line 1792 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();
          }
       }
  
       apply->Enable(enable);
    }
  
    EnablePreview(enable);
  
    return enable;
 }

References EnablePreview(), mUIDialog, and mUIParent.

Here is the call graph for this function:

◆ EnablePreview()

bool Effect::EnablePreview ( bool enable = true )

protectedvirtual

Definition at line 1823 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)
       {
          wxWindow *rewind = dlg->FindWindow(kRewindID);
          wxWindow *ffwd = dlg->FindWindow(kFFwdID);
  
          // Don't allow focus to get trapped
          if (!enable)
          {
             wxWindow *focus = dlg->FindFocus();
             if (focus && (focus == play || focus == rewind || focus == ffwd))
             {
                dlg->FindWindow(wxID_CLOSE)->SetFocus();
             }
          }
  
          play->Enable(enable);
          if (SupportsRealtime())
          {
             rewind->Enable(enable);
             ffwd->Enable(enable);
          }
       }
    }
  
    return enable;
 }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ End()

void Effect::End ( )

protectedvirtual

Reimplemented in VampEffect, EffectNoiseRemoval, and EffectAutoDuck.

Definition at line 1773 of file Effect.cpp.

1774 {

1775 }

Referenced by DoEffect(), and Preview().

Here is the caller graph for this function:

◆ ExportPresets()

void Effect::ExportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 681 of file Effect.cpp.

 {
    wxString params;
    GetAutomationParameters(params);
    wxString commandId = GetSquashedName(GetSymbol().Internal()).GET();
    params =  commandId + ":" + 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(), Identifier::GET(), GetAutomationParameters(), GetSquashedName(), GetSymbol(), Internal, params, PresetTypes(), SelectFile(), and XO.

Here is the call graph for this function:

◆ FindProject()

const AudacityProject * Effect::FindProject ( ) const

protected

Definition at line 2133 of file Effect.cpp.

 {
    if (!inputTracks())
       return nullptr;
    return inputTracks()->GetOwner();
 }

References TrackList::GetOwner(), and inputTracks().

Referenced by CopyInputTracks(), DoEffect(), GetSelectionFormat(), EffectEqualization::Init(), NyquistEffect::Init(), Generator::Process(), NyquistEffect::Process(), EffectTwoPassSimpleMono::Process(), EffectTruncSilence::ProcessIndependently(), ProcessTrack(), and EffectToneGen::SetAutomationParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAudioInCount()

unsigned Effect::GetAudioInCount ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectWahwah, VampEffect, EffectStereoToMono, EffectScienFilter, EffectReverb, EffectPhaser, EffectInvert, and EffectFade.

Definition at line 266 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetAudioInCount();
    }
  
    return 0;
 }

References EffectClientInterface::GetAudioInCount(), and mClient.

Referenced by Process(), and Startup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAudioOutCount()

unsigned Effect::GetAudioOutCount ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectWahwah, EffectToneGen, EffectStereoToMono, EffectScienFilter, EffectReverb, EffectPhaser, EffectNoise, EffectInvert, and EffectFade.

Definition at line 276 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetAudioOutCount();
    }
  
    return 0;
 }

References EffectClientInterface::GetAudioOutCount(), and mClient.

Referenced by Process(), and Startup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAutomationParameters() [1/2]

bool Effect::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Implements EffectClientInterface.

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

Definition at line 540 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetAutomationParameters(parms);
    }
  
    return true;
 }

References EffectClientInterface::GetAutomationParameters(), and mClient.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAutomationParameters() [2/2]

bool Effect::GetAutomationParameters ( wxString & parms )

virtual

Definition at line 928 of file Effect.cpp.

 {
    CommandParameters eap;
  
    if (mUIDialog && !TransferDataFromWindow())
    {
       return false;
    }
  
    ShuttleGetAutomation S;
    S.mpEap = &eap;
    if( DefineParams( S ) ){
       ;// got eap value using DefineParams.
    }
    // Won't be needed in future
    else if (!GetAutomationParameters(eap))
    {
       return false;
    }
  
    return eap.GetParameters(parms);
 }

References ComponentInterface::DefineParams(), GetAutomationParameters(), CommandParameters::GetParameters(), mUIDialog, S, and TransferDataFromWindow().

Here is the call graph for this function:

◆ GetBlockSize()

size_t Effect::GetBlockSize ( ) const

overridevirtual

Implements EffectClientInterface.

Definition at line 328 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetBlockSize();
    }
  
    return mBlockSize;
 }

References EffectClientInterface::GetBlockSize(), mBlockSize, and mClient.

Here is the call graph for this function:

◆ GetBounds()

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

protected

Definition at line 1902 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 WaveTrack::GetEndTime(), WaveTrack::GetStartTime(), min(), mT0, mT1, and WaveTrack::TimeToLongSamples().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCurrentSettingsGroup()

RegistryPath Effect::GetCurrentSettingsGroup ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 876 of file Effect.cpp.

 {
    return wxT("CurrentSettings");
 }

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

Here is the caller graph for this function:

◆ GetDefaultDuration()

double Effect::GetDefaultDuration ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 820 of file Effect.cpp.

 {
    return 30.0;
 }

Referenced by DoEffect().

Here is the caller graph for this function:

◆ GetDefinition()

EffectDefinitionInterface & Effect::GetDefinition ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 815 of file Effect.cpp.

 {
    return mClient ? *mClient : *this;
 }

References mClient.

Referenced by DoEffect(), GetID(), GetUserPresets(), HasCurrentSettings(), HasFactoryDefaults(), LoadUserPreset(), EffectUIHost::LoadUserPresets(), EffectChangeSpeed::OnChoice_Vinyl(), EffectUIHost::OnDeletePreset(), EffectChangeSpeed::PopulateOrExchange(), SaveUserPreset(), SetDuration(), EffectChangeSpeed::Startup(), EffectEqualization::Startup(), Startup(), EffectChangeSpeed::TransferDataFromWindow(), EffectChangeSpeed::Update_Vinyl(), and EffectEqualization::ValidateUI().

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString Effect::GetDescription ( )

overridevirtual

Implements ComponentInterface.

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

Definition at line 182 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetDescription();
    }
  
    return {};
 }

References ComponentInterface::GetDescription(), and mClient.

Referenced by EffectManager::GetCommandTip(), and EffectUIHost::OnMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDuration()

double Effect::GetDuration ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 825 of file Effect.cpp.

 {
    if (mDuration < 0.0)
    {
       mDuration = 0.0;
    }
  
    return mDuration;
 }

References mDuration.

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

Here is the caller graph for this function:

◆ GetDurationFormat()

NumericFormatSymbol Effect::GetDurationFormat ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 835 of file Effect.cpp.

 {
    return mDurationFormat;
 }

References mDurationFormat.

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

Here is the caller graph for this function:

◆ GetFactoryDefaultsGroup()

RegistryPath Effect::GetFactoryDefaultsGroup ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 881 of file Effect.cpp.

 {
    return wxT("FactoryDefaults");
 }

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

Here is the caller graph for this function:

◆ GetFactoryPresets()

RegistryPaths Effect::GetFactoryPresets ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectReverb, and EffectEqualization.

Definition at line 594 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetFactoryPresets();
    }
  
    return {};
 }

References EffectClientInterface::GetFactoryPresets(), and mClient.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFamily()

EffectFamilySymbol Effect::GetFamily ( )

overridevirtual

Implements EffectDefinitionInterface.

Reimplemented in VampEffect, and NyquistEffect.

Definition at line 192 of file Effect.cpp.

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

References EffectDefinitionInterface::GetFamily(), mClient, and XO.

Referenced by EffectUIHost::OnHelp(), EffectUIHost::OnMenu(), and Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLatency()

sampleCount Effect::GetLatency ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 338 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetLatency();
    }
  
    return 0;
 }

References EffectClientInterface::GetLatency(), and mClient.

Referenced by ProcessTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMidiInCount()

int Effect::GetMidiInCount ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 286 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetMidiInCount();
    }
  
    return 0;
 }

References EffectClientInterface::GetMidiInCount(), and mClient.

Here is the call graph for this function:

◆ GetMidiOutCount()

int Effect::GetMidiOutCount ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 296 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetMidiOutCount();
    }
  
    return 0;
 }

References EffectClientInterface::GetMidiOutCount(), and mClient.

Here is the call graph for this function:

◆ GetNumWaveGroups()

int Effect::GetNumWaveGroups ( )

inlineprotected

Definition at line 315 of file Effect.h.

315 { return mNumGroups; }

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

Here is the caller graph for this function:

◆ GetNumWaveTracks()

int Effect::GetNumWaveTracks ( )

inlineprotected

Definition at line 314 of file Effect.h.

314 { return 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:

◆ GetPass()

int Effect::GetPass ( )

protectedvirtual

Definition at line 1222 of file Effect.cpp.

 {
    return mPass;
 }

References mPass.

◆ GetPath()

PluginPath Effect::GetPath ( )

overridevirtual

Implements ComponentInterface.

Reimplemented in VampEffect, and NyquistEffect.

Definition at line 142 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetPath();
    }
  
    return BUILTIN_EFFECT_PREFIX + GetSymbol().Internal();
 }

References BUILTIN_EFFECT_PREFIX, ComponentInterface::GetPath(), GetSymbol(), ComponentInterfaceSymbol::Internal(), and mClient.

Referenced by DoEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSavedStateGroup()

wxString Effect::GetSavedStateGroup ( )

virtual

Definition at line 886 of file Effect.cpp.

 {
    return wxT("SavedState");
 }

Referenced by SetBatchProcessing().

Here is the caller graph for this function:

◆ GetSelectionFormat()

NumericFormatSymbol Effect::GetSelectionFormat ( )

virtual

Definition at line 840 of file Effect.cpp.

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

References 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:

◆ GetSquashedName()

CommandID Effect::GetSquashedName ( wxString name )

static

Definition at line 780 of file Effect.cpp.

 {
    // Get rid of leading and trailing white space
    name.Trim(true).Trim(false);
  
    if (name.empty())
    {
       return name;
    }
  
    wxStringTokenizer st(name, wxT(" "));
    wxString id;
  
    // CamelCase the name
    while (st.HasMoreTokens())
    {
       wxString tok = st.GetNextToken();
  
       id += tok.Left(1).MakeUpper() + tok.Mid(1).MakeLower();
    }
  
    return id;
 }

References TranslatableString::empty(), id, and name.

Referenced by ExportPresets(), EffectManager::GetCommandIdentifier(), and ImportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol Effect::GetSymbol ( )

overridevirtual

Implements ComponentInterface.

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

Definition at line 152 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetSymbol();
    }
  
    return {};
 }

References ComponentInterface::GetSymbol(), and mClient.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTailSize()

size_t Effect::GetTailSize ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 348 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetTailSize();
    }
  
    return 0;
 }

References EffectClientInterface::GetTailSize(), and mClient.

Here is the call graph for this function:

◆ GetType()

EffectType Effect::GetType ( )

overridevirtual

Implements EffectDefinitionInterface.

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

Definition at line 132 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetType();
    }
  
    return EffectTypeNone;
 }

References EffectTypeNone, EffectDefinitionInterface::GetType(), and mClient.

Referenced by EffectUIHost::BuildButtonBar(), DoEffect(), EffectUIHost::OnApply(), Preview(), ProcessPass(), ProcessTrack(), SetDuration(), and EffectUIHost::UpdateControls().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUserPresets()

RegistryPaths Effect::GetUserPresets ( )

virtual

Definition at line 1012 of file Effect.cpp.

 {
    RegistryPaths presets;
  
    GetConfigSubgroups(GetDefinition(), PluginSettings::Private,
       GetUserPresetsGroup(wxEmptyString), presets);
  
    std::sort( presets.begin(), presets.end() );
  
    return presets;
 }

References PluginSettings::GetConfigSubgroups(), GetDefinition(), GetUserPresetsGroup(), and PluginSettings::Private.

Referenced by EffectManager::HasPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUserPresetsGroup()

RegistryPath Effect::GetUserPresetsGroup ( const RegistryPath & name )

overridevirtual

Implements EffectHostInterface.

Definition at line 865 of file Effect.cpp.

 {
    RegistryPath group = wxT("UserPresets");
    if (!name.empty())
    {
       group += wxCONFIG_PATH_SEPARATOR + name;
    }
  
    return group;
 }

References TranslatableString::empty(), and name.

Referenced by GetUserPresets(), EffectUIHost::LoadUserPresets(), EffectUIHost::OnDeletePreset(), EffectUIHost::OnSaveAs(), EffectUIHost::OnUserPreset(), SetAutomationParameters(), and EffectReverb::Startup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol Effect::GetVendor ( )

overridevirtual

Implements ComponentInterface.

Reimplemented in VampEffect, and NyquistEffect.

Definition at line 162 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetVendor();
    }
  
    return XO("Audacity");
 }

References ComponentInterface::GetVendor(), mClient, and XO.

Referenced by EffectUIHost::OnMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVersion()

wxString Effect::GetVersion ( )

overridevirtual

Implements ComponentInterface.

Reimplemented in VampEffect, and NyquistEffect.

Definition at line 172 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->GetVersion();
    }
  
    return AUDACITY_VERSION_STRING;
 }

References ComponentInterface::GetVersion(), and mClient.

Referenced by EffectUIHost::OnMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasCurrentSettings()

bool Effect::HasCurrentSettings ( )

virtual

Definition at line 1024 of file Effect.cpp.

 {
    return HasConfigGroup(GetDefinition(),
       PluginSettings::Private, GetCurrentSettingsGroup());
 }

References GetCurrentSettingsGroup(), GetDefinition(), PluginSettings::HasConfigGroup(), and PluginSettings::Private.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasFactoryDefaults()

bool Effect::HasFactoryDefaults ( )

virtual

Definition at line 1030 of file Effect.cpp.

 {
    return HasConfigGroup(GetDefinition(),
       PluginSettings::Private, GetFactoryDefaultsGroup());
 }

References GetDefinition(), GetFactoryDefaultsGroup(), PluginSettings::HasConfigGroup(), and PluginSettings::Private.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasOptions()

bool Effect::HasOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 804 of file Effect.cpp.

 {
    return false;
 }

◆ HelpPage()

FilePath Effect::HelpPage ( )

virtual

Reimplemented in NyquistEffect.

Definition at line 1041 of file Effect.cpp.

 {
    return {};
 }

Referenced by EffectUIHost::Initialize(), and EffectUIHost::OnHelp().

Here is the caller graph for this function:

◆ HideUI()

bool Effect::HideUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 651 of file Effect.cpp.

 {
    return true;
 }

◆ ImportPresets()

void Effect::ImportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 729 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()) {
       if (f.ReadAll(&params)) {
          wxString ident = params.BeforeFirst(':');
          params = params.AfterFirst(':');
  
          wxString commandId = GetSquashedName(GetSymbol().Internal()).GET();
  
          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;
          }
          SetAutomationParameters(params);
       }
    }
  
    //SetWindowTitle();
  
 }

References Identifier::GET(), GetSquashedName(), GetSymbol(), ident(), Internal, MessageBox(), params, PresetTypes(), SelectFile(), SetAutomationParameters(), and XO.

Here is the call graph for this function:

◆ IncEffectCounter()

static void Effect::IncEffectCounter ( )

inlinestatic

Definition at line 249 of file Effect.h.

249 { nEffectsDone++;};

Referenced by SelectTracksCommand::Apply().

Here is the caller graph for this function:

◆ IncludeNotSelectedPreviewTracks()

void Effect::IncludeNotSelectedPreviewTracks ( bool includeNotSelected )

protected

Definition at line 1873 of file Effect.cpp.

 {
    mPreviewWithNotSelected = includeNotSelected;
 }

References mPreviewWithNotSelected.

◆ Init()

bool Effect::Init ( )

protectedvirtual

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

Definition at line 1217 of file Effect.cpp.

 {
    return true;
 }

Referenced by DoEffect(), and Preview().

Here is the caller graph for this function:

◆ InitPass1()

bool Effect::InitPass1 ( )

protectedvirtual

Reimplemented in EffectTwoPassSimpleMono, and EffectCompressor.

Definition at line 1227 of file Effect.cpp.

 {
    return true;
 }

Referenced by Process().

Here is the caller graph for this function:

◆ InitPass2()

bool Effect::InitPass2 ( )

protectedvirtual

Reimplemented in EffectTwoPassSimpleMono, and EffectCompressor.

Definition at line 1232 of file Effect.cpp.

 {
    return false;
 }

Referenced by Process().

Here is the caller graph for this function:

◆ inputTracks()

const TrackList* Effect::inputTracks ( ) const

inlineprotected

Definition at line 431 of file Effect.h.

431 { return mTracks; }

Referenced by EffectTruncSilence::CalcPreviewInputLength(), FindProject(), EffectAmplify::Init(), EffectAutoDuck::Init(), EffectScienFilter::Init(), VampEffect::Init(), EffectCompressor::InitPass1(), EffectFindClipping::Process(), VampEffect::Process(), EffectTruncSilence::ProcessAll(), EffectTruncSilence::ProcessIndependently(), and EffectStereoToMono::ProcessOne().

Here is the caller graph for this function:

◆ IsBatchProcessing()

bool Effect::IsBatchProcessing ( )

virtual

Definition at line 1054 of file Effect.cpp.

 {
    return mIsBatch;
 }

References mIsBatch.

Referenced by EffectUIHost::BuildButtonBar(), NyquistEffect::CheckWhetherSkipEffect(), EffectAmplify::DefineParams(), DoEffect(), EffectAmplify::GetAutomationParameters(), GetSelectionFormat(), EffectAmplify::PopulateOrExchange(), EffectEqualization::PopulateOrExchange(), EffectManager::PromptUser(), EffectAmplify::SetAutomationParameters(), NyquistEffect::SetAutomationParameters(), and NyquistEffect::ShowHostInterface().

Here is the caller graph for this function:

◆ IsDefault()

bool Effect::IsDefault ( )

overridevirtual

Implements EffectDefinitionInterface.

Reimplemented in VampEffect, and NyquistEffect.

Definition at line 214 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->IsDefault();
    }
  
    return true;
 }

References EffectDefinitionInterface::IsDefault(), and mClient.

Here is the call graph for this function:

◆ IsGraphicalUI()

bool Effect::IsGraphicalUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 641 of file Effect.cpp.

 {
    return false;
 }

◆ IsHidden()

bool Effect::IsHidden ( )

virtual

Reimplemented in EffectStereoToMono.

Definition at line 2151 of file Effect.cpp.

 {
    return false;
 }

Referenced by EffectManager::IsHidden().

Here is the caller graph for this function:

◆ IsInteractive()

bool Effect::IsInteractive ( )

overridevirtual

Implements EffectDefinitionInterface.

Reimplemented in VampEffect, EffectStereoToMono, EffectReverse, EffectRepair, NyquistEffect, EffectInvert, and EffectFade.

Definition at line 204 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->IsInteractive();
    }
  
    return true;
 }

References EffectDefinitionInterface::IsInteractive(), and mClient.

Referenced by DoEffect(), and ShowHostInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsLegacy()

bool Effect::IsLegacy ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 224 of file Effect.cpp.

 {
    if (mClient)
    {
       return false;
    }
  
    return true;
 }

References mClient.

◆ IsPreviewing()

bool Effect::IsPreviewing ( )

inlineprotected

Definition at line 332 of file Effect.h.

332 { return mIsPreview; }

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

Here is the caller graph for this function:

◆ IsReady()

bool Effect::IsReady ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 358 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->IsReady();
    }
  
    return true;
 }

References EffectClientInterface::IsReady(), and mClient.

Here is the call graph for this function:

◆ LoadFactoryDefaults()

bool Effect::LoadFactoryDefaults ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectEqualization.

Definition at line 614 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->LoadFactoryDefaults();
    }
  
    return LoadUserPreset(GetFactoryDefaultsGroup());
 }

References GetFactoryDefaultsGroup(), EffectClientInterface::LoadFactoryDefaults(), LoadUserPreset(), and mClient.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadFactoryPreset()

bool Effect::LoadFactoryPreset ( int id )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectReverb, and EffectEqualization.

Definition at line 604 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->LoadFactoryPreset(id);
    }
  
    return true;
 }

References EffectClientInterface::LoadFactoryPreset(), and mClient.

Referenced by EffectUIHost::OnFactoryPreset(), and SetAutomationParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadUserPreset()

bool Effect::LoadUserPreset ( const RegistryPath & name )

overridevirtual

Implements EffectClientInterface.

Definition at line 560 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->LoadUserPreset(name);
    }
  
    wxString parms;
    if (!GetConfig(GetDefinition(), PluginSettings::Private,
       name, wxT("Parameters"), parms))
    {
       return false;
    }
  
    return SetAutomationParameters(parms);
 }

References PluginSettings::GetConfig(), GetDefinition(), EffectClientInterface::LoadUserPreset(), mClient, name, PluginSettings::Private, and SetAutomationParameters().

Referenced by LoadFactoryDefaults(), EffectUIHost::OnUserPreset(), EffectEqualization::PopulateOrExchange(), SetAutomationParameters(), SetBatchProcessing(), and Startup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ManualPage()

ManualPageID Effect::ManualPage ( )

virtual

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

Definition at line 1036 of file Effect.cpp.

 {
    return {};
 }

Referenced by EffectManager::GetCommandUrl(), EffectUIHost::Initialize(), and EffectUIHost::OnHelp().

Here is the caller graph for this function:

◆ MessageBox()

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

Definition at line 2342 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(), NyquistEffect::OnLoad(), NyquistEffect::OnSave(), NyquistEffect::OnTime(), NyquistEffect::ParseProgram(), EffectClickRemoval::Process(), Generator::Process(), EffectNoiseReduction::Process(), NyquistEffect::Process(), EffectRepair::Process(), VampEffect::Process(), EffectTruncSilence::ProcessIndependently(), EffectDtmf::ProcessInitialize(), EffectEcho::ProcessInitialize(), NyquistEffect::ProcessOne(), EffectClickRemoval::ProcessOne(), EffectFindClipping::ProcessOne(), EffectPaulstretch::ProcessOne(), SetAutomationParameters(), 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 2046 of file Effect.cpp.

 {
    return{ this, pOrigTrack, name };
 }

References name.

Referenced by EffectFindClipping::Process().

Here is the caller graph for this function:

◆ PopulateOrExchange()

void Effect::PopulateOrExchange ( ShuttleGui & S )

protectedvirtual

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

Definition at line 1777 of file Effect.cpp.

 {
    return;
 }

Referenced by PopulateUI().

Here is the caller graph for this function:

◆ PopulateUI()

bool Effect::PopulateUI ( ShuttleGui & S )

finalvirtual

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

Implements EffectUIClientInterface.

Definition at line 626 of file Effect.cpp.

 {
    auto parent = S.GetParent();
    mUIParent = parent;
    mUIParent->PushEventHandler(this);
  
 //   LoadUserPreset(GetCurrentSettingsGroup());
  
    PopulateOrExchange(S);
  
    mUIParent->SetMinSize(mUIParent->GetSizer()->GetMinSize());
  
    return true;
 }

References mUIParent, PopulateOrExchange(), and S.

Here is the call graph for this function:

◆ Preview()

void Effect::Preview ( bool dryOnly )

protectedvirtual

Reimplemented in EffectTimeScale, and EffectAmplify.

Definition at line 2156 of file Effect.cpp.

 {
    if (mNumTracks == 0) { // nothing to preview
       return;
    }
  
    auto gAudioIO = AudioIO::Get();
    if (gAudioIO->IsBusy()) {
       return;
    }
  
    wxWindow *FocusDialog = wxWindow::FindFocus();
  
    double previewDuration;
    bool isNyquist = GetFamily() == NYQUISTEFFECTS_FAMILY;
    bool isGenerator = GetType() == EffectTypeGenerate;
  
    // Mix a few seconds of audio from all of the tracks
    double previewLen;
    gPrefs->Read(wxT("/AudioIO/EffectsPreviewLen"), &previewLen, 6.0);
  
    const double rate = mProjectRate;
  
    if (isNyquist && isGenerator) {
       previewDuration = CalcPreviewInputLength(previewLen);
    }
    else {
       previewDuration = wxMin(mDuration, CalcPreviewInputLength(previewLen));
    }
  
    double t1 = mT0 + previewDuration;
  
    if ((t1 > mT1) && !isGenerator) {
       t1 = mT1;
    }
  
    if (t1 <= mT0)
       return;
  
    bool success = true;
  
    auto cleanup = finally( [&] {
  
       // Effect is already inited; we will call Process, End, and then Init
       // again, so the state is exactly the way it was before Preview
       // was called.
       if (!dryOnly) {
          End();
          GuardedCall( [&]{ Init(); } );
       }
  
       // In case any dialog control depends on mT1 or mDuration:
       if ( mUIDialog )
          mUIDialog->TransferDataToWindow();
    } );
  
    auto vr0 = valueRestorer( mT0 );
    auto vr1 = valueRestorer( mT1 );
    // Most effects should stop at t1.
    if (!mPreviewFullSelection)
       mT1 = t1;
  
    // In case any dialog control depends on mT1 or mDuration:
    if ( mUIDialog ) {
       mUIDialog->TransferDataToWindow();
    }
  
    // Save the original track list
    TrackList *saveTracks = mTracks;
  
    auto cleanup2 = finally( [&] {
       mTracks = saveTracks;
       if (FocusDialog) {
          FocusDialog->SetFocus();
       }
  
       // In case of failed effect, be sure to free memory.
       ReplaceProcessedTracks( false );
    } );
  
    // Build NEW tracklist from rendering tracks
    // Set the same owning project, so FindProject() can see it within Process()
    const auto pProject = saveTracks->GetOwner();
    auto uTracks = TrackList::Create( pProject );
    mTracks = uTracks.get();
  
    // Linear Effect preview optimised by pre-mixing to one track.
    // Generators need to generate per track.
    if (mIsLinearEffect && !isGenerator) {
       WaveTrack::Holder mixLeft, mixRight;
       MixAndRender(saveTracks, mFactory, rate, floatSample, mT0, t1, mixLeft, mixRight);
       if (!mixLeft)
          return;
  
       mixLeft->Offset(-mixLeft->GetStartTime());
       mixLeft->SetSelected(true);
       WaveTrackView::Get( *mixLeft )
          .SetDisplay(WaveTrackViewConstants::NoDisplay);
       auto pLeft = mTracks->Add( mixLeft );
       Track *pRight{};
       if (mixRight) {
          mixRight->Offset(-mixRight->GetStartTime());
          mixRight->SetSelected(true);
          pRight = mTracks->Add( mixRight );
          mTracks->MakeMultiChannelTrack(*pLeft, 2, true);
       }
    }
    else {
       for (auto src : saveTracks->Any< const WaveTrack >()) {
          if (src->GetSelected() || mPreviewWithNotSelected) {
             auto dest = src->Copy(mT0, t1);
             dest->SetSelected(src->GetSelected());
             WaveTrackView::Get( *static_cast<WaveTrack*>(dest.get()) )
                .SetDisplay(WaveTrackViewConstants::NoDisplay);
             mTracks->Add( dest );
          }
       }
    }
  
    // NEW tracks start at time zero.
    // Adjust mT0 and mT1 to be the times to process, and to
    // play back in these tracks
    mT1 -= mT0;
    mT0 = 0.0;
  
    // Update track/group counts
    CountWaveTracks();
  
    // Apply effect
    if (!dryOnly) {
       ProgressDialog progress{
          GetName(),
          XO("Preparing preview"),
          pdlgHideCancelButton
       }; // Have only "Stop" button.
       auto vr = valueRestorer( mProgress, &progress );
  
       auto vr2 = valueRestorer( mIsPreview, true );
  
       success = Process();
    }
  
    if (success)
    {
       auto tracks = ProjectAudioManager::GetAllPlaybackTracks(*mTracks, true);
  
       // Some effects (Paulstretch) may need to generate more
       // than previewLen, so take the min.
       t1 = std::min(mT0 + previewLen, mT1);
  
       // Start audio playing
       auto options = DefaultPlayOptions(*pProject);
       int token = gAudioIO->StartStream(tracks, mT0, t1, t1, options);
  
       if (token) {
          auto previewing = ProgressResult::Success;
          // The progress dialog must be deleted before stopping the stream
          // to allow events to flow to the app during StopStream processing.
          // The progress dialog blocks these events.
          {
             ProgressDialog progress
             (GetName(), XO("Previewing"), pdlgHideCancelButton);
  
             while (gAudioIO->IsStreamActive(token) && previewing == ProgressResult::Success) {
                ::wxMilliSleep(100);
                previewing = progress.Update(gAudioIO->GetStreamTime() - mT0, t1 - mT0);
             }
          }
  
          gAudioIO->StopStream();
  
          while (gAudioIO->IsBusy()) {
             ::wxMilliSleep(100);
          }
       }
       else {
          using namespace BasicUI;
          ShowErrorDialog(
             wxWidgetsWindowPlacement{ FocusDialog }, XO("Error"),
             XO("Error opening sound device.\nTry changing the audio host, playback device and the project sample rate."),
             wxT("Error_opening_sound_device"),
             ErrorDialogOptions{ ErrorDialogType::ModalErrorReport } );
       }
    }
 }

References TrackList::Add(), TrackList::Any(), CalcPreviewInputLength(), CountWaveTracks(), TrackList::Create(), DefaultPlayOptions(), EffectTypeGenerate, End(), floatSample, AudioIO::Get(), WaveTrackView::Get(), ProjectAudioManager::GetAllPlaybackTracks(), GetFamily(), ComponentInterface::GetName(), TrackList::GetOwner(), GetType(), gPrefs, GuardedCall(), Init(), TrackList::MakeMultiChannelTrack(), mDuration, mFactory, min(), mIsLinearEffect, mIsPreview, MixAndRender(), mNumTracks, mPreviewFullSelection, mPreviewWithNotSelected, mProgress, mProjectRate, mT0, mT1, mTracks, mUIDialog, WaveTrackViewConstants::NoDisplay, NYQUISTEFFECTS_FAMILY, Track::Offset(), pdlgHideCancelButton, Process(), ReplaceProcessedTracks(), WaveTrackView::SetDisplay(), BasicUI::ShowErrorDialog(), BasicUI::Success, ProgressDialog::Update(), valueRestorer(), and XO.

Referenced by EffectUIHost::OnPlay(), NoiseRemovalDialog::OnPreview(), EffectAmplify::Preview(), and EffectTimeScale::Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Process()

bool Effect::Process ( )

protectedvirtual

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

Definition at line 1237 of file Effect.cpp.

 {
    CopyInputTracks(true);
    bool bGoodResult = true;
  
    // It's possible that the number of channels the effect expects changed based on
    // the parameters (the Audacity Reverb effect does when the stereo width is 0).
    mNumAudioIn = GetAudioInCount();
    mNumAudioOut = GetAudioOutCount();
  
    mPass = 1;
    if (InitPass1())
    {
       bGoodResult = ProcessPass();
       mPass = 2;
       if (bGoodResult && InitPass2())
       {
          bGoodResult = ProcessPass();
       }
    }
  
    ReplaceProcessedTracks(bGoodResult);
  
    return bGoodResult;
 }

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

Referenced by DoEffect(), and Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessBlock()

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

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectWahwah, EffectToneGen, EffectScienFilter, EffectReverb, EffectPhaser, EffectNoise, EffectInvert, and EffectFade.

Definition at line 388 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->ProcessBlock(inBlock, outBlock, blockLen);
    }
  
    return 0;
 }

References mClient, and EffectClientInterface::ProcessBlock().

Referenced by ProcessTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessFinalize()

bool Effect::ProcessFinalize ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectReverb.

Definition at line 378 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->ProcessFinalize();
    }
  
    return true;
 }

References mClient, and EffectClientInterface::ProcessFinalize().

Referenced by ProcessTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessInitialize()

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

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectWahwah, EffectToneGen, EffectScienFilter, EffectReverb, EffectPhaser, and EffectFade.

Definition at line 368 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->ProcessInitialize(totalLen, chanMap);
    }
  
    return true;
 }

References mClient, and EffectClientInterface::ProcessInitialize().

Referenced by ProcessTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessPass()

bool Effect::ProcessPass ( )

protectedvirtual

Reimplemented in EffectTwoPassSimpleMono.

Definition at line 1263 of file Effect.cpp.

 {
    bool bGoodResult = true;
    bool isGenerator = GetType() == EffectTypeGenerate;
  
    FloatBuffers inBuffer, outBuffer;
    ArrayOf<float *> inBufPos, outBufPos;
  
    ChannelName map[3];
  
    mBufferSize = 0;
    mBlockSize = 0;
  
    int count = 0;
    bool clear = false;
  
    const bool multichannel = mNumAudioIn > 1;
    auto range = multichannel
       ? mOutputTracks->Leaders()
       : mOutputTracks->Any();
    range.VisitWhile( bGoodResult,
       [&](WaveTrack *left, const Track::Fallthrough &fallthrough) {
          if (!left->GetSelected())
             return fallthrough();
  
          sampleCount len = 0;
          sampleCount start = 0;
  
          mNumChannels = 0;
          WaveTrack *right{};
  
          // Iterate either over one track which could be any channel,
          // or if multichannel, then over all channels of left,
          // which is a leader.
          for (auto channel :
               TrackList::Channels(left).StartingWith(left)) {
             if (channel->GetChannel() == Track::LeftChannel)
                map[mNumChannels] = ChannelNameFrontLeft;
             else if (channel->GetChannel() == Track::RightChannel)
                map[mNumChannels] = ChannelNameFrontRight;
             else
                map[mNumChannels] = ChannelNameMono;
  
             ++ mNumChannels;
             map[mNumChannels] = ChannelNameEOL;
  
             if (! multichannel)
                break;
  
             if (mNumChannels == 2) {
                // TODO: more-than-two-channels
                right = channel;
                clear = false;
                // Ignore other channels
                break;
             }
          }
  
          if (!isGenerator)
          {
             GetBounds(*left, right, &start, &len);
             mSampleCnt = len;
          }
          else
             mSampleCnt = left->TimeToLongSamples(mDuration);
  
          // Let the client know the sample rate
          SetSampleRate(left->GetRate());
  
          // Get the block size the client wants to use
          auto max = left->GetMaxBlockSize() * 2;
          mBlockSize = SetBlockSize(max);
  
          // Calculate the buffer size to be at least the max rounded up to the clients
          // selected block size.
          const auto prevBufferSize = mBufferSize;
          mBufferSize = ((max + (mBlockSize - 1)) / mBlockSize) * mBlockSize;
  
          // If the buffer size has changed, then (re)allocate the buffers
          if (prevBufferSize != mBufferSize)
          {
             // Always create the number of input buffers the client expects even if we don't have
             // the same number of channels.
             inBufPos.reinit( mNumAudioIn );
             inBuffer.reinit( mNumAudioIn, mBufferSize );
  
             // We won't be using more than the first 2 buffers, so clear the rest (if any)
             for (size_t i = 2; i < mNumAudioIn; i++)
             {
                for (size_t j = 0; j < mBufferSize; j++)
                {
                   inBuffer[i][j] = 0.0;
                }
             }
  
             // Always create the number of output buffers the client expects even if we don't have
             // the same number of channels.
             outBufPos.reinit( mNumAudioOut );
             // Output buffers get an extra mBlockSize worth to give extra room if
             // the plugin adds latency
             outBuffer.reinit( mNumAudioOut, mBufferSize + mBlockSize );
          }
  
          // (Re)Set the input buffer positions
          for (size_t i = 0; i < mNumAudioIn; i++)
          {
             inBufPos[i] = inBuffer[i].get();
          }
  
          // (Re)Set the output buffer positions
          for (size_t i = 0; i < mNumAudioOut; i++)
          {
             outBufPos[i] = outBuffer[i].get();
          }
  
          // Clear unused input buffers
          if (!right && !clear && mNumAudioIn > 1)
          {
             for (size_t j = 0; j < mBufferSize; j++)
             {
                inBuffer[1][j] = 0.0;
             }
             clear = true;
          }
  
          // Go process the track(s)
          bGoodResult = ProcessTrack(
             count, map, left, right, start, len,
             inBuffer, outBuffer, inBufPos, outBufPos);
          if (!bGoodResult)
             return;
  
          count++;
       },
       [&](Track *t) {
          if (SyncLock::IsSyncLockSelected(t))
             t->SyncLockAdjust(mT1, mT0 + mDuration);
       }
    );
  
    if (bGoodResult && GetType() == EffectTypeGenerate)
    {
       mT1 = mT0 + mDuration;
    }
  
    return bGoodResult;
 }

References ChannelNameEOL, ChannelNameFrontLeft, ChannelNameFrontRight, ChannelNameMono, TrackList::Channels(), EffectTypeGenerate, GetBounds(), WaveTrack::GetMaxBlockSize(), WaveTrack::GetRate(), Track::GetSelected(), GetType(), SyncLock::IsSyncLockSelected(), Track::LeftChannel, mBlockSize, mBufferSize, mDuration, mNumAudioIn, mNumAudioOut, mNumChannels, mOutputTracks, mSampleCnt, mT0, mT1, ProcessTrack(), ArraysOf< X >::reinit(), ArrayOf< X >::reinit(), Track::RightChannel, SetBlockSize(), SetSampleRate(), and WaveTrack::TimeToLongSamples().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessTrack()

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

private

Definition at line 1411 of file Effect.cpp.

 {
    bool rc = true;
  
    // Give the plugin a chance to initialize
    if (!ProcessInitialize(len, map))
    {
       return false;
    }
  
    { // Start scope for cleanup
    auto cleanup = finally( [&] {
       // Allow the plugin to cleanup
       if (!ProcessFinalize())
       {
          // In case of non-exceptional flow of control, set rc
          rc = false;
       }
    } );
  
    // For each input block of samples, we pass it to the effect along with a
    // variable output location.  This output location is simply a pointer into a
    // much larger buffer.  This reduces the number of calls required to add the
    // samples to the output track.
    //
    // Upon return from the effect, the output samples are "moved to the left" by
    // the number of samples in the current latency setting, effectively removing any
    // delay introduced by the effect.
    //
    // At the same time the total number of delayed samples are gathered and when
    // there is no further input data to process, the loop continues to call the
    // effect with an empty input buffer until the effect has had a chance to
    // return all of the remaining delayed samples.
    auto inPos = start;
    auto outPos = start;
  
    auto inputRemaining = len;
    decltype(GetLatency()) curDelay = 0, delayRemaining = 0;
    decltype(mBlockSize) curBlockSize = 0;
  
    decltype(mBufferSize) inputBufferCnt = 0;
    decltype(mBufferSize) outputBufferCnt = 0;
    bool cleared = false;
  
    auto chans = std::min<unsigned>(mNumAudioOut, mNumChannels);
  
    std::shared_ptr<WaveTrack> genLeft, genRight;
  
    decltype(len) genLength = 0;
    bool isGenerator = GetType() == EffectTypeGenerate;
    bool isProcessor = GetType() == EffectTypeProcess;
    double genDur = 0;
    if (isGenerator)
    {
       if (mIsPreview) {
          gPrefs->Read(wxT("/AudioIO/EffectsPreviewLen"), &genDur, 6.0);
          genDur = wxMin(mDuration, CalcPreviewInputLength(genDur));
       }
       else {
          genDur = mDuration;
       }
  
       genLength = sampleCount((left->GetRate() * genDur) + 0.5);  // round to nearest sample
       delayRemaining = genLength;
       cleared = true;
  
       // Create temporary tracks
       genLeft = left->EmptyCopy();
  
       if (right)
          genRight = right->EmptyCopy();
    }
  
    // Call the effect until we run out of input or delayed samples
    while (inputRemaining != 0 || delayRemaining != 0)
    {
       // Still working on the input samples
       if (inputRemaining != 0)
       {
          // Need to refill the input buffers
          if (inputBufferCnt == 0)
          {
             // Calculate the number of samples to get
             inputBufferCnt =
                limitSampleBufferSize( mBufferSize, inputRemaining );
  
             // Fill the input buffers
             left->GetFloats(inBuffer[0].get(), inPos, inputBufferCnt);
             if (right)
             {
                right->GetFloats(inBuffer[1].get(), inPos, inputBufferCnt);
             }
  
             // Reset the input buffer positions
             for (size_t i = 0; i < mNumChannels; i++)
             {
                inBufPos[i] = inBuffer[i].get();
             }
          }
  
          // Calculate the number of samples to process
          curBlockSize = mBlockSize;
          if (curBlockSize > inputRemaining)
          {
             // We've reached the last block...set current block size to what's left
             // inputRemaining is positive and bounded by a size_t
             curBlockSize = inputRemaining.as_size_t();
             inputRemaining = 0;
  
             // Clear the remainder of the buffers so that a full block can be passed
             // to the effect
             auto cnt = mBlockSize - curBlockSize;
             for (size_t i = 0; i < mNumChannels; i++)
             {
                for (decltype(cnt) j = 0 ; j < cnt; j++)
                {
                   inBufPos[i][j + curBlockSize] = 0.0;
                }
             }
  
             // Might be able to use up some of the delayed samples
             if (delayRemaining != 0)
             {
                // Don't use more than needed
                cnt = limitSampleBufferSize(cnt, delayRemaining);
                delayRemaining -= cnt;
                curBlockSize += cnt;
             }
          }
       }
       // We've exhausted the input samples and are now working on the delay
       else if (delayRemaining != 0)
       {
          // Calculate the number of samples to process
          curBlockSize = limitSampleBufferSize( mBlockSize, delayRemaining );
          delayRemaining -= curBlockSize;
  
          // From this point on, we only want to feed zeros to the plugin
          if (!cleared)
          {
             // Reset the input buffer positions
             for (size_t i = 0; i < mNumChannels; i++)
             {
                inBufPos[i] = inBuffer[i].get();
  
                // And clear
                for (size_t j = 0; j < mBlockSize; j++)
                {
                   inBuffer[i][j] = 0.0;
                }
             }
             cleared = true;
          }
       }
  
       // Finally call the plugin to process the block
       decltype(curBlockSize) processed;
       try
       {
          processed = ProcessBlock(inBufPos.get(), outBufPos.get(), curBlockSize);
       }
       catch( const AudacityException & WXUNUSED(e) )
       {
          // PRL: Bug 437:
          // Pass this along to our application-level handler
          throw;
       }
       catch(...)
       {
          // PRL:
          // Exceptions for other reasons, maybe in third-party code...
          // Continue treating them as we used to, but I wonder if these
          // should now be treated the same way.
          return false;
       }
       wxASSERT(processed == curBlockSize);
       wxUnusedVar(processed);
  
       // Bump to next input buffer position
       if (inputRemaining != 0)
       {
          for (size_t i = 0; i < mNumChannels; i++)
          {
             inBufPos[i] += curBlockSize;
          }
          inputRemaining -= curBlockSize;
          inputBufferCnt -= curBlockSize;
       }
  
       // "ls" and "rs" serve as the input sample index for the left and
       // right channels when processing the input samples.  If we flip
       // over to processing delayed samples, they simply become counters
       // for the progress display.
       inPos += curBlockSize;
  
       // Get the current number of delayed samples and accumulate
       if (isProcessor)
       {
          {
             auto delay = GetLatency();
             curDelay += delay;
             delayRemaining += delay;
          }
  
          // If the plugin has delayed the output by more samples than our current
          // block size, then we leave the output pointers alone.  This effectively
          // removes those delayed samples from the output buffer.
          if (curDelay >= curBlockSize)
          {
             curDelay -= curBlockSize;
             curBlockSize = 0;
          }
          // We have some delayed samples, at the beginning of the output samples,
          // so overlay them by shifting the remaining output samples.
          else if (curDelay > 0)
          {
             // curDelay is bounded by curBlockSize:
             auto delay = curDelay.as_size_t();
             curBlockSize -= delay;
             for (size_t i = 0; i < chans; i++)
             {
                memmove(outBufPos[i], outBufPos[i] + delay, sizeof(float) * curBlockSize);
             }
             curDelay = 0;
          }
       }
  
       // Adjust the number of samples in the output buffers
       outputBufferCnt += curBlockSize;
  
       // Still have room in the output buffers
       if (outputBufferCnt < mBufferSize)
       {
          // Bump to next output buffer position
          for (size_t i = 0; i < chans; i++)
          {
             outBufPos[i] += curBlockSize;
          }
       }
       // Output buffers have filled
       else
       {
          if (isProcessor)
          {
             // Write them out
             left->Set((samplePtr) outBuffer[0].get(), floatSample, outPos, outputBufferCnt);
             if (right)
             {
                if (chans >= 2)
                {
                   right->Set((samplePtr) outBuffer[1].get(), floatSample, outPos, outputBufferCnt);
                }
                else
                {
                   right->Set((samplePtr) outBuffer[0].get(), floatSample, outPos, outputBufferCnt);
                }
             }
          }
          else if (isGenerator)
          {
             genLeft->Append((samplePtr) outBuffer[0].get(), floatSample, outputBufferCnt);
             if (genRight)
             {
                genRight->Append((samplePtr) outBuffer[1].get(), floatSample, outputBufferCnt);
             }
          }
  
          // Reset the output buffer positions
          for (size_t i = 0; i < chans; i++)
          {
             outBufPos[i] = outBuffer[i].get();
          }
  
          // Bump to the next track position
          outPos += outputBufferCnt;
          outputBufferCnt = 0;
       }
  
       if (mNumChannels > 1)
       {
          if (TrackGroupProgress(count,
                (inPos - start).as_double() /
                (isGenerator ? genLength : len).as_double()))
          {
             rc = false;
             break;
          }
       }
       else
       {
          if (TrackProgress(count,
                (inPos - start).as_double() /
                (isGenerator ? genLength : len).as_double()))
          {
             rc = false;
             break;
          }
       }
    }
  
    // Put any remaining output
    if (rc && outputBufferCnt)
    {
       if (isProcessor)
       {
          left->Set((samplePtr) outBuffer[0].get(), floatSample, outPos, outputBufferCnt);
          if (right)
          {
             if (chans >= 2)
             {
                right->Set((samplePtr) outBuffer[1].get(), floatSample, outPos, outputBufferCnt);
             }
             else
             {
                right->Set((samplePtr) outBuffer[0].get(), floatSample, outPos, outputBufferCnt);
             }
          }
       }
       else if (isGenerator)
       {
          genLeft->Append((samplePtr) outBuffer[0].get(), floatSample, outputBufferCnt);
          if (genRight)
          {
             genRight->Append((samplePtr) outBuffer[1].get(), floatSample, outputBufferCnt);
          }
       }
    }
  
    if (rc && isGenerator)
    {
       auto pProject = FindProject();
  
       // Transfer the data from the temporary tracks to the actual ones
       genLeft->Flush();
       // mT1 gives us the NEW selection. We want to replace up to GetSel1().
       auto &selectedRegion = ViewInfo::Get( *pProject ).selectedRegion;
       auto t1 = selectedRegion.t1();
       PasteTimeWarper warper{ t1, mT0 + genLeft->GetEndTime() };
       left->ClearAndPaste(mT0, t1, genLeft.get(), true, true,
          &warper);
  
       if (genRight)
       {
          genRight->Flush();
          right->ClearAndPaste(mT0, selectedRegion.t1(),
             genRight.get(), true, true, nullptr /* &warper */);
       }
    }
  
    } // End scope for cleanup
    return rc;
 }

References WaveTrack::Append(), CalcPreviewInputLength(), WaveTrack::ClearAndPaste(), EffectTypeGenerate, EffectTypeProcess, WaveTrack::EmptyCopy(), FindProject(), floatSample, WaveTrack::Flush(), ViewInfo::Get(), WaveTrack::GetEndTime(), WaveTrack::GetFloats(), GetLatency(), WaveTrack::GetRate(), GetType(), gPrefs, limitSampleBufferSize(), mBlockSize, mBufferSize, mDuration, mIsPreview, mNumAudioOut, mNumChannels, mT0, ProcessBlock(), ProcessFinalize(), ProcessInitialize(), ViewInfo::selectedRegion, WaveTrack::Set(), NotifyingSelectedRegion::t1(), TrackGroupProgress(), and TrackProgress().

Referenced by ProcessPass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RealtimeAddProcessor()

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

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectWahwah, and EffectPhaser.

Definition at line 411 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->RealtimeAddProcessor(numChannels, sampleRate);
    }
  
    return true;
 }

References mClient, and EffectClientInterface::RealtimeAddProcessor().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool Effect::RealtimeFinalize ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectWahwah, and EffectPhaser.

Definition at line 421 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->RealtimeFinalize();
    }
  
    return false;
 }

References mClient, and EffectClientInterface::RealtimeFinalize().

Here is the call graph for this function:

◆ RealtimeInitialize()

bool Effect::RealtimeInitialize ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectWahwah, and EffectPhaser.

Definition at line 398 of file Effect.cpp.

 {
    if (mClient)
    {
       mBlockSize = mClient->SetBlockSize(512);
       return mClient->RealtimeInitialize();
    }
  
    mBlockSize = 512;
  
    return false;
 }

References mBlockSize, mClient, EffectClientInterface::RealtimeInitialize(), and EffectClientInterface::SetBlockSize().

Here is the call graph for this function:

◆ RealtimeProcess()

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

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectWahwah, and EffectPhaser.

Definition at line 457 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->RealtimeProcess(group, inbuf, outbuf, numSamples);
    }
  
    return 0;
 }

References mClient, and EffectClientInterface::RealtimeProcess().

Here is the call graph for this function:

◆ RealtimeProcessEnd()

bool Effect::RealtimeProcessEnd ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 470 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->RealtimeProcessEnd();
    }
  
    return true;
 }

References mClient, and EffectClientInterface::RealtimeProcessEnd().

Here is the call graph for this function:

◆ RealtimeProcessStart()

bool Effect::RealtimeProcessStart ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 447 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->RealtimeProcessStart();
    }
  
    return true;
 }

References mClient, and EffectClientInterface::RealtimeProcessStart().

Here is the call graph for this function:

◆ RealtimeResume()

bool Effect::RealtimeResume ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 439 of file Effect.cpp.

 {
    if (mClient)
       return mClient->RealtimeResume();
  
    return true;
 }

References mClient, and EffectClientInterface::RealtimeResume().

Here is the call graph for this function:

◆ RealtimeSuspend()

bool Effect::RealtimeSuspend ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 431 of file Effect.cpp.

 {
    if (mClient)
       return mClient->RealtimeSuspend();
  
    return true;
 }

References mClient, and EffectClientInterface::RealtimeSuspend().

Here is the call graph for this function:

◆ ReplaceProcessedTracks()

void Effect::ReplaceProcessedTracks ( const bool bGoodResult )

protected

Definition at line 2054 of file Effect.cpp.

 {
    if (!bGoodResult) {
       // Free resources, unless already freed.
  
       // Processing failed or was cancelled so throw away the processed tracks.
       if ( mOutputTracks )
          mOutputTracks->Clear();
  
       // Reset map
       mIMap.clear();
       mOMap.clear();
  
       //TODO:undo the non-gui ODTask transfer
       return;
    }
  
    // Assume resources need to be freed.
    wxASSERT(mOutputTracks); // Make sure we at least did the CopyInputTracks().
  
    auto iterOut = mOutputTracks->ListOfTracks::begin(),
       iterEnd = mOutputTracks->ListOfTracks::end();
  
    size_t cnt = mOMap.size();
    size_t i = 0;
  
    for (; iterOut != iterEnd; ++i) {
       ListOfTracks::value_type o = *iterOut;
       // If tracks were removed from mOutputTracks, then there will be
       // tracks in the map that must be removed from mTracks.
       while (i < cnt && mOMap[i] != o.get()) {
          const auto t = mIMap[i];
          if (t) {
             mTracks->Remove(t);
          }
          i++;
       }
  
       // This should never happen
       wxASSERT(i < cnt);
  
       // Remove the track from the output list...don't DELETE it
       iterOut = mOutputTracks->erase(iterOut);
  
       const auto  t = mIMap[i];
       if (t == NULL)
       {
          // This track is a NEW addition to output tracks; add it to mTracks
          mTracks->Add( o );
       }
       else
       {
          // Replace mTracks entry with the NEW track
          mTracks->Replace(t, o);
       }
    }
  
    // If tracks were removed from mOutputTracks, then there may be tracks
    // left at the end of the map that must be removed from mTracks.
    while (i < cnt) {
       const auto t = mIMap[i];
       if (t) {
          mTracks->Remove(t);
       }
       i++;
    }
  
    // Reset map
    mIMap.clear();
    mOMap.clear();
  
    // Make sure we processed everything
    wxASSERT(mOutputTracks->empty());
  
    // The output list is no longer needed
    mOutputTracks.reset();
    nEffectsDone++;
 }

References TrackList::Add(), mIMap, mOMap, mOutputTracks, mTracks, nEffectsDone, TrackList::Remove(), and TrackList::Replace().

Referenced by DoEffect(), EffectTruncSilence::DoRemoval(), EffectTruncSilence::FindSilences(), Preview(), 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(), EffectTruncSilence::Process(), and EffectTwoPassSimpleMono::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveUserPreset()

bool Effect::SaveUserPreset ( const RegistryPath & name )

overridevirtual

Implements EffectClientInterface.

Definition at line 577 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->SaveUserPreset(name);
    }
  
    wxString parms;
    if (!GetAutomationParameters(parms))
    {
       return false;
    }
  
    return SetConfig(GetDefinition(), PluginSettings::Private,
       name, wxT("Parameters"), parms);
 }

References GetAutomationParameters(), GetDefinition(), mClient, name, PluginSettings::Private, EffectClientInterface::SaveUserPreset(), and PluginSettings::SetConfig().

Referenced by EffectUIHost::OnApply(), EffectUIHost::OnSaveAs(), SetBatchProcessing(), EffectAutoDuck::Startup(), EffectChangeSpeed::Startup(), EffectClickRemoval::Startup(), EffectCompressor::Startup(), EffectDtmf::Startup(), EffectEqualization::Startup(), EffectLoudness::Startup(), EffectNoise::Startup(), EffectNormalize::Startup(), EffectReverb::Startup(), EffectScienFilter::Startup(), EffectTruncSilence::Startup(), and Startup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAutomationParameters() [1/2]

bool Effect::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Implements EffectClientInterface.

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

Definition at line 550 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->SetAutomationParameters(parms);
    }
  
    return true;
 }

References mClient, and EffectClientInterface::SetAutomationParameters().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAutomationParameters() [2/2]

bool Effect::SetAutomationParameters ( const wxString & parms )

virtual

Definition at line 951 of file Effect.cpp.

 {
    wxString preset = parms;
    bool success = false;
    if (preset.StartsWith(kUserPresetIdent))
    {
       preset.Replace(kUserPresetIdent, wxEmptyString, false);
       success = LoadUserPreset(GetUserPresetsGroup(preset));
    }
    else if (preset.StartsWith(kFactoryPresetIdent))
    {
       preset.Replace(kFactoryPresetIdent, wxEmptyString, false);
       auto presets = GetFactoryPresets();
       success = LoadFactoryPreset( make_iterator_range( presets ).index( preset ) );
    }
    else if (preset.StartsWith(kCurrentSettingsIdent))
    {
       preset.Replace(kCurrentSettingsIdent, wxEmptyString, false);
       success = LoadUserPreset(GetCurrentSettingsGroup());
    }
    else if (preset.StartsWith(kFactoryDefaultsIdent))
    {
       preset.Replace(kFactoryDefaultsIdent, wxEmptyString, false);
       success = LoadUserPreset(GetFactoryDefaultsGroup());
    }
    else
    {
       CommandParameters eap(parms);
       ShuttleSetAutomation S;
       S.SetForValidating( &eap );
       // DefineParams returns false if not defined for this effect.
       if( !DefineParams( S ) )
          // the old method...
          success = SetAutomationParameters(eap);
       else if( !S.bOK )
          success = false;
       else{
          success = true;
          S.SetForWriting( &eap );
          DefineParams( S );
       }
    }
  
    if (!success)
    {
       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.
       return true;
       //return false;
    }
  
    if (!mUIDialog)
    {
       return true;
    }
  
    return TransferDataToWindow();
 }

References ComponentInterface::DefineParams(), GetCurrentSettingsGroup(), GetFactoryDefaultsGroup(), GetFactoryPresets(), ComponentInterface::GetName(), GetUserPresetsGroup(), kCurrentSettingsIdent, kFactoryDefaultsIdent, kFactoryPresetIdent, kUserPresetIdent, LoadFactoryPreset(), LoadUserPreset(), make_iterator_range(), MessageBox(), mUIDialog, S, SetAutomationParameters(), TransferDataToWindow(), and XO.

Here is the call graph for this function:

◆ SetBatchProcessing()

void Effect::SetBatchProcessing ( bool start )

virtual

Definition at line 1059 of file Effect.cpp.

 {
    mIsBatch = start;
  
    if (start)
    {
       SaveUserPreset(GetSavedStateGroup());
    }
    else
    {
       LoadUserPreset(GetSavedStateGroup());
    }
 }

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

Referenced by EffectManager::SetBatchProcessing(), and NyquistEffect::ShowHostInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBlockSize()

size_t Effect::SetBlockSize ( size_t maxBlockSize )

overridevirtual

Implements EffectClientInterface.

Definition at line 316 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->SetBlockSize(maxBlockSize);
    }
  
    mBlockSize = maxBlockSize;
  
    return mBlockSize;
 }

References mBlockSize, mClient, and EffectClientInterface::SetBlockSize().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDuration()

void Effect::SetDuration ( double duration )

overridevirtual

Implements EffectHostInterface.

Definition at line 847 of file Effect.cpp.

 {
    if (seconds < 0.0)
    {
       seconds = 0.0;
    }
  
    if (GetType() == EffectTypeGenerate)
    {
       SetConfig(GetDefinition(), PluginSettings::Private,
          GetCurrentSettingsGroup(), wxT("LastUsedDuration"), seconds);
    }
  
    mDuration = seconds;
  
    return;
 }

References EffectTypeGenerate, GetCurrentSettingsGroup(), GetDefinition(), GetType(), mDuration, PluginSettings::Private, and PluginSettings::SetConfig().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetHost()

bool Effect::SetHost ( EffectHostInterface * host )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 256 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->SetHost(host);
    }
  
    return true;
 }

References mClient, and EffectUIClientInterface::SetHost().

Referenced by Startup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLinearEffectFlag()

void Effect::SetLinearEffectFlag ( bool linearEffectFlag )

protected

Definition at line 1862 of file Effect.cpp.

 {
    mIsLinearEffect = linearEffectFlag;
 }

References mIsLinearEffect.

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

Here is the caller graph for this function:

◆ SetPresetParameters()

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

inline

Definition at line 221 of file Effect.h.

                                                                                            {
       if( Names ) mPresetNames = *Names;
       if( Values ) mPresetValues = *Values;
    }

Referenced by DoEffect().

Here is the caller graph for this function:

◆ SetPreviewFullSelectionFlag()

void Effect::SetPreviewFullSelectionFlag ( bool previewDurationFlag )

protected

Definition at line 1867 of file Effect.cpp.

 {
    mPreviewFullSelection = previewDurationFlag;
 }

References mPreviewFullSelection.

Referenced by NyquistEffect::Parse().

Here is the caller graph for this function:

◆ SetSampleRate()

void Effect::SetSampleRate ( double rate )

overridevirtual

Implements EffectClientInterface.

Definition at line 306 of file Effect.cpp.

 {
    if (mClient)
    {
       mClient->SetSampleRate(rate);
    }
  
    mSampleRate = rate;
 }

Referenced by ProcessPass().

Here is the caller graph for this function:

◆ SetUIFlags()

void Effect::SetUIFlags ( unsigned flags )

virtual

Definition at line 1046 of file Effect.cpp.

                                       {
    mUIFlags = flags;
 }

References mUIFlags.

Referenced by EffectUI::DoEffect().

Here is the caller graph for this function:

◆ SetVetoDialogHook()

auto Effect::SetVetoDialogHook ( VetoDialogHook hook )

static

Definition at line 77 of file Effect.cpp.

 {
    auto &theHook = GetVetoDialogHook();
    auto result = theHook;
    theHook = hook;
    return result;
 }

References anonymous_namespace{Effect.cpp}::GetVetoDialogHook().

Referenced by ScreenshotCommand::ScreenshotCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowClientInterface()

int Effect::ShowClientInterface	(	wxWindow &	parent,
		wxDialog &	dialog,
		bool	forceModal = `false`
	)

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.

Definition at line 480 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());
  
    auto hook = GetVetoDialogHook();
    if( hook && hook( mUIDialog ) )
       return 0;
  
    if( SupportsRealtime() && !forceModal )
    {
       mUIDialog->Show();
       // Return false to bypass effect processing
       return 0;
    }
  
    return mUIDialog->ShowModal();
 }

References anonymous_namespace{Effect.cpp}::GetVetoDialogHook(), mUIDialog, and SupportsRealtime().

Here is the call graph for this function:

◆ ShowHostInterface()

int Effect::ShowHostInterface	(	wxWindow &	parent,
		const EffectDialogFactory &	factory,
		bool	forceModal = `false`
	)

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 EffectUIHostInterface.

Reimplemented in NyquistEffect, EffectNoiseRemoval, and EffectNoiseReduction.

Definition at line 503 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.
    const auto client = mClient ? mClient : this;
    mHostUIDialog = factory(parent, *this, *client);
    if (!mHostUIDialog)
       return 0;
  
    // Let the client show the dialog and decide whether to keep it open
    auto result = client->ShowClientInterface(parent, *mHostUIDialog, forceModal);
    if (!mHostUIDialog->IsShown())
       // Client didn't show it, or showed it modally and closed it
       // So destroy it
       mHostUIDialog.reset();
  
    return result;
 }

References factory, IsInteractive(), mClient, and mHostUIDialog.

Referenced by DoEffect(), EffectManager::PromptUser(), and 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.

Definition at line 809 of file Effect.cpp.

810 {

811 }

◆ Startup() [1/2]

bool Effect::Startup ( )

virtual

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

Definition at line 923 of file Effect.cpp.

 {
    return true;
 }

Referenced by Startup().

Here is the caller graph for this function:

◆ Startup() [2/2]

bool Effect::Startup ( EffectUIClientInterface * client )

virtual

Definition at line 893 of file Effect.cpp.

 {
    // Let destructor know we need to be shutdown
    mClient = client;
  
    // Set host so client startup can use our services
    if (!SetHost(this))
    {
       // Bail if the client startup fails
       mClient = NULL;
       return false;
    }
  
    mNumAudioIn = GetAudioInCount();
    mNumAudioOut = GetAudioOutCount();
  
    bool haveDefaults;
    GetConfig(GetDefinition(), PluginSettings::Private, GetFactoryDefaultsGroup(),
       wxT("Initialized"), haveDefaults, false);
    if (!haveDefaults)
    {
       SaveUserPreset(GetFactoryDefaultsGroup());
       SetConfig(GetDefinition(), PluginSettings::Private, GetFactoryDefaultsGroup(),
          wxT("Initialized"), true);
    }
    LoadUserPreset(GetCurrentSettingsGroup());
  
    return Startup();
 }

References GetAudioInCount(), GetAudioOutCount(), PluginSettings::GetConfig(), GetCurrentSettingsGroup(), GetDefinition(), GetFactoryDefaultsGroup(), LoadUserPreset(), mClient, mNumAudioIn, mNumAudioOut, PluginSettings::Private, SaveUserPreset(), PluginSettings::SetConfig(), SetHost(), and Startup().

Here is the call graph for this function:

◆ SupportsAutomation()

bool Effect::SupportsAutomation ( )

overridevirtual

Implements EffectDefinitionInterface.

Reimplemented in EffectNoiseRemoval.

Definition at line 244 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->SupportsAutomation();
    }
  
    return true;
 }

References mClient, and EffectDefinitionInterface::SupportsAutomation().

Here is the call graph for this function:

◆ SupportsRealtime()

bool Effect::SupportsRealtime ( )

overridevirtual

Implements EffectDefinitionInterface.

Reimplemented in EffectWahwah, and EffectPhaser.

Definition at line 234 of file Effect.cpp.

 {
    if (mClient)
    {
       return mClient->SupportsRealtime();
    }
  
    return false;
 }

References mClient, and EffectDefinitionInterface::SupportsRealtime().

Referenced by EffectUIHost::BuildButtonBar(), EffectUI::DoEffect(), EnablePreview(), and ShowClientInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TestUIFlags()

unsigned Effect::TestUIFlags ( unsigned mask )

virtual

Definition at line 1050 of file Effect.cpp.

                                           {
    return mask & mUIFlags;
 }

References mUIFlags.

Referenced by NyquistEffect::ShowHostInterface().

Here is the caller graph for this function:

◆ TotalProgress()

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

protected

Definition at line 1878 of file Effect.cpp.

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

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

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 = `{}`
	)

protected

Definition at line 1894 of file Effect.cpp.

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

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

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

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 = `{}`
	)

protected

Definition at line 1886 of file Effect.cpp.

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

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

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 ProcessTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransferDataFromWindow()

bool Effect::TransferDataFromWindow ( )

protectedvirtual

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

Definition at line 1787 of file Effect.cpp.

 {
    return true;
 }

Referenced by GetAutomationParameters(), EffectNoiseReduction::Dialog::OnGetProfile(), EffectUIHost::OnPlay(), EffectNoiseReduction::Dialog::OnPreview(), EffectNoiseReduction::Dialog::OnReduceNoise(), and EffectUIHost::TransferDataFromWindow().

Here is the caller graph for this function:

◆ TransferDataToWindow()

bool Effect::TransferDataToWindow ( )

protectedvirtual

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

Definition at line 1782 of file Effect.cpp.

 {
    return true;
 }

Referenced by SetAutomationParameters(), and EffectUIHost::TransferDataToWindow().

Here is the caller graph for this function:

◆ ValidateUI()

bool Effect::ValidateUI ( )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in EffectEqualization.

Definition at line 646 of file Effect.cpp.

 {
    return mUIParent->Validate();
 }

References mUIParent.

Friends And Related Function Documentation

◆ EffectUIHost

friend class EffectUIHost

friend

Definition at line 510 of file Effect.h.

Member Data Documentation

◆ kCurrentSettingsIdent

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

static

Definition at line 507 of file Effect.h.

Referenced by EffectManager::GetDefaultPreset(), SetAutomationParameters(), anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::SetPrefix(), anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::SetSelected(), and anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::UpdateUI().

◆ kFactoryDefaultsIdent

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

static

Definition at line 508 of file Effect.h.

Referenced by EffectManager::GetDefaultPreset(), SetAutomationParameters(), anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::SetPrefix(), anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::SetSelected(), and anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::UpdateUI().

◆ kFactoryPresetIdent

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

static

Definition at line 506 of file Effect.h.

Referenced by SetAutomationParameters(), anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::SetPrefix(), anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::SetSelected(), and anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::UpdateUI().

◆ kUserPresetIdent

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

static

Definition at line 505 of file Effect.h.

Referenced by SetAutomationParameters(), anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::SetPrefix(), anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::SetSelected(), and anonymous_namespace{EffectManager.cpp}::EffectPresetsDialog::UpdateUI().

◆ mBlockSize

size_t Effect::mBlockSize

private

Definition at line 501 of file Effect.h.

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

◆ mBufferSize

size_t Effect::mBufferSize

private

Definition at line 500 of file Effect.h.

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

◆ mClient

EffectUIClientInterface* Effect::mClient

private

Definition at line 496 of file Effect.h.

Referenced by Effect(), GetAudioInCount(), GetAudioOutCount(), GetAutomationParameters(), GetBlockSize(), GetDefinition(), GetDescription(), GetFactoryPresets(), GetFamily(), GetLatency(), GetMidiInCount(), GetMidiOutCount(), GetPath(), GetSymbol(), GetTailSize(), GetType(), GetVendor(), GetVersion(), IsDefault(), IsInteractive(), IsLegacy(), IsReady(), LoadFactoryDefaults(), LoadFactoryPreset(), LoadUserPreset(), ProcessBlock(), ProcessFinalize(), ProcessInitialize(), RealtimeAddProcessor(), RealtimeFinalize(), RealtimeInitialize(), RealtimeProcess(), RealtimeProcessEnd(), RealtimeProcessStart(), RealtimeResume(), RealtimeSuspend(), SaveUserPreset(), SetAutomationParameters(), SetBlockSize(), SetHost(), ShowHostInterface(), Startup(), SupportsAutomation(), SupportsRealtime(), and EffectNoiseReduction::TrackProgress().

◆ mDuration

double Effect::mDuration

private

Definition at line 484 of file Effect.h.

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

◆ mDurationFormat

NumericFormatSymbol Effect::mDurationFormat

private

Definition at line 485 of file Effect.h.

Referenced by DoEffect(), and GetDurationFormat().

◆ mFactory

WaveTrackFactory* Effect::mFactory

protected

Definition at line 430 of file Effect.h.

Referenced by Delegate(), DoEffect(), and Preview().

◆ mHostUIDialog

wxWindowPtr<wxDialog> Effect::mHostUIDialog

protected

This smart pointer controls the lifetime of the dialog.

Definition at line 446 of file Effect.h.

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

◆ mIMap

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

private

Definition at line 489 of file Effect.h.

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

◆ mIsBatch

bool Effect::mIsBatch

private

Definition at line 479 of file Effect.h.

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

◆ mIsLinearEffect

bool Effect::mIsLinearEffect

private

Definition at line 480 of file Effect.h.

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

◆ mIsPreview

bool Effect::mIsPreview

private

Definition at line 487 of file Effect.h.

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

◆ mNumAudioIn

size_t Effect::mNumAudioIn

private

Definition at line 497 of file Effect.h.

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

◆ mNumAudioOut

size_t Effect::mNumAudioOut

private

Definition at line 498 of file Effect.h.

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

◆ mNumChannels

unsigned Effect::mNumChannels

private

Definition at line 502 of file Effect.h.

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

◆ mNumGroups

int Effect::mNumGroups

private

Definition at line 493 of file Effect.h.

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

◆ mNumTracks

int Effect::mNumTracks

private

Definition at line 492 of file Effect.h.

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

◆ mOMap

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

private

Definition at line 490 of file Effect.h.

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

◆ mOutputTracks

std::shared_ptr<TrackList> Effect::mOutputTracks

protected

Definition at line 433 of file Effect.h.

Referenced by AddToOutputTracks(), EffectLoudness::AllocBuffers(), CopyInputTracks(), DoEffect(), EffectTruncSilence::DoRemoval(), 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(), EffectTruncSilence::ProcessIndependently(), NyquistEffect::ProcessOne(), EffectStereoToMono::ProcessOne(), ProcessPass(), and ReplaceProcessedTracks().

◆ mPass

int Effect::mPass

protected

Definition at line 442 of file Effect.h.

Referenced by GetPass(), and Process().

◆ mPresetNames

wxArrayString Effect::mPresetNames

protected

Definition at line 440 of file Effect.h.

Referenced by NyquistEffect::Parse().

◆ mPresetValues

wxArrayString Effect::mPresetValues

protected

Definition at line 441 of file Effect.h.

◆ mPreviewFullSelection

bool Effect::mPreviewFullSelection

private

Definition at line 482 of file Effect.h.

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

◆ mPreviewWithNotSelected

bool Effect::mPreviewWithNotSelected

private

Definition at line 481 of file Effect.h.

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

◆ mProgress

ProgressDialog* Effect::mProgress

protected

Definition at line 425 of file Effect.h.

Referenced by DoEffect(), Effect(), Preview(), EffectStereoToMono::Process(), TotalProgress(), TrackGroupProgress(), and TrackProgress().

◆ mProjectRate

◆ mpSelectedRegion

wxWeakRef<NotifyingSelectedRegion> Effect::mpSelectedRegion {}

protected

Definition at line 429 of file Effect.h.

Referenced by DoEffect().

◆ mSampleCnt

sampleCount Effect::mSampleCnt

protected

Definition at line 452 of file Effect.h.

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

◆ mSampleRate

double Effect::mSampleRate

protected

Definition at line 428 of file Effect.h.

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

◆ mT0

double Effect::mT0

protected

Definition at line 434 of file Effect.h.

Referenced by EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), EffectTruncSilence::CalcPreviewInputLength(), Delegate(), EffectRepeat::DisplayNewTime(), DoEffect(), Effect(), EffectTruncSilence::FindSilences(), GetBounds(), EffectAmplify::Init(), EffectChangeSpeed::Init(), Preview(), EffectAutoDuck::Process(), EffectChangeSpeed::Process(), EffectClickRemoval::Process(), EffectEqualization::Process(), EffectFindClipping::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(), EffectTimeScale::Process(), EffectTwoPassSimpleMono::Process(), EffectDtmf::ProcessInitialize(), EffectChangeSpeed::ProcessLabelTrack(), EffectSBSMS::ProcessLabelTrack(), NyquistEffect::ProcessOne(), EffectPaulstretch::ProcessOne(), ProcessPass(), EffectTwoPassSimpleMono::ProcessPass(), ProcessTrack(), and NyquistEffect::ShowHostInterface().

◆ mT1

double Effect::mT1

protected

Definition at line 435 of file Effect.h.

Referenced by EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), EffectTruncSilence::CalcPreviewInputLength(), Delegate(), EffectRepeat::DisplayNewTime(), DoEffect(), Effect(), EffectTruncSilence::FindSilences(), GetBounds(), EffectAmplify::Init(), EffectChangeSpeed::Init(), Preview(), EffectAutoDuck::Process(), EffectChangeSpeed::Process(), EffectClickRemoval::Process(), EffectEqualization::Process(), EffectFindClipping::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(), EffectTimeScale::Process(), EffectTruncSilence::ProcessAll(), EffectTruncSilence::ProcessIndependently(), EffectChangeSpeed::ProcessLabelTrack(), EffectSBSMS::ProcessLabelTrack(), NyquistEffect::ProcessOne(), ProcessPass(), EffectTwoPassSimpleMono::ProcessPass(), and NyquistEffect::ShowHostInterface().

◆ mTracks

TrackList* Effect::mTracks

private

Definition at line 477 of file Effect.h.

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

◆ mUIDialog

wxWeakRef<wxDialog> Effect::mUIDialog

protected

This weak pointer may be the same as the above, or null.

Definition at line 448 of file Effect.h.

Referenced by CloseUI(), EnableApply(), EnablePreview(), GetAutomationParameters(), EffectDistortion::LoadFactoryPreset(), EffectEqualization::LoadFactoryPreset(), EffectReverb::LoadFactoryPreset(), Preview(), SetAutomationParameters(), ShowClientInterface(), and SpinSliderHandlers().

◆ mUIFlags

unsigned Effect::mUIFlags

protected

Definition at line 450 of file Effect.h.

Referenced by Effect(), SetUIFlags(), and TestUIFlags().

◆ mUIParent

wxWindow* Effect::mUIParent

protected

Definition at line 449 of file Effect.h.

◆ nEffectsDone

int Effect::nEffectsDone =0

staticprotected

Definition at line 345 of file Effect.h.

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ VetoDialogHook

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Effect()

◆ ~Effect()

Member Function Documentation

◆ AddAnalysisTrack()

◆ AddToOutputTracks()

◆ CalcPreviewInputLength()

◆ CanExportPresets()

◆ CheckWhetherSkipEffect()

◆ CloseUI()

◆ CopyInputTracks()

◆ CountWaveTracks()

◆ Delegate()

◆ DoEffect()

◆ EnableApply()

◆ EnablePreview()

◆ End()

◆ ExportPresets()

◆ FindProject()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetAutomationParameters() [1/2]

◆ GetAutomationParameters() [2/2]

◆ GetBlockSize()

◆ GetBounds()

◆ GetCurrentSettingsGroup()

◆ GetDefaultDuration()

◆ GetDefinition()

◆ GetDescription()

◆ GetDuration()

◆ GetDurationFormat()

◆ GetFactoryDefaultsGroup()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetLatency()

◆ GetMidiInCount()

◆ GetMidiOutCount()

◆ GetNumWaveGroups()

◆ GetNumWaveTracks()

◆ GetPass()

◆ GetPath()

◆ GetSavedStateGroup()

◆ GetSelectionFormat()

◆ GetSquashedName()

◆ GetSymbol()

◆ GetTailSize()

◆ GetType()

◆ GetUserPresets()

◆ GetUserPresetsGroup()

◆ GetVendor()

◆ GetVersion()

◆ HasCurrentSettings()

◆ HasFactoryDefaults()

◆ HasOptions()

◆ HelpPage()

◆ HideUI()

◆ ImportPresets()

◆ IncEffectCounter()

◆ IncludeNotSelectedPreviewTracks()

◆ Init()

◆ InitPass1()

◆ InitPass2()

◆ inputTracks()

◆ IsBatchProcessing()