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

#include <Effect.h>

Inheritance diagram for Effect:

Classes
class	AddedAnalysisTrack

class	ModifiedAnalysisTrack

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

Public Member Functions
	Effect ()

virtual	~Effect ()

wxString	GetPath () override

IdentInterfaceSymbol	GetSymbol () override

IdentInterfaceSymbol	GetVendor () override

wxString	GetVersion () override

wxString	GetDescription () override

EffectType	GetType () override

IdentInterfaceSymbol	GetFamilyId () override

bool	IsInteractive () override

bool	IsDefault () override

bool	IsLegacy () override

bool	SupportsRealtime () override

bool	SupportsAutomation () override

bool	SetHost (EffectHostInterface *host) override

unsigned	GetAudioInCount () override

unsigned	GetAudioOutCount () override

int	GetMidiInCount () override

int	GetMidiOutCount () override

sampleCount	GetLatency () override

size_t	GetTailSize () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

bool	IsReady () override

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

bool	ProcessFinalize () override

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

bool	RealtimeInitialize () override

bool	RealtimeAddProcessor (unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	RealtimeProcessStart () override

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

bool	RealtimeProcessEnd () override

bool	ShowInterface (wxWindow *parent, bool forceModal=false) override

bool	GetAutomationParameters (CommandParameters &parms) override

bool	SetAutomationParameters (CommandParameters &parms) override

bool	LoadUserPreset (const wxString &name) override

bool	SaveUserPreset (const wxString &name) override

wxArrayString	GetFactoryPresets () override

bool	LoadFactoryPreset (int id) override

bool	LoadFactoryDefaults () override

void	SetHostUI (EffectUIHostInterface *host) override

bool	PopulateUI (wxWindow *parent) override

bool	IsGraphicalUI () override

bool	ValidateUI () override

bool	HideUI () override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets () override

void	ImportPresets () override

bool	HasOptions () override

void	ShowOptions () override

double	GetDefaultDuration () override

double	GetDuration () override

NumericFormatId	GetDurationFormat () override

virtual NumericFormatId	GetSelectionFormat ()

void	SetDuration (double duration) override

bool	Apply () override

void	Preview () override

wxDialog *	CreateUI (wxWindow parent, EffectUIClientInterface client) override

wxString	GetUserPresetsGroup (const wxString &name) override

wxString	GetCurrentSettingsGroup () override

wxString	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

bool	HasSharedConfigGroup (const wxString &group) override

bool	GetSharedConfigSubgroups (const wxString &group, wxArrayString &subgroups) override

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

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

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

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

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

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

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

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

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

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

bool	RemoveSharedConfigSubgroup (const wxString &group) override

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

bool	HasPrivateConfigGroup (const wxString &group) override

bool	GetPrivateConfigSubgroups (const wxString &group, wxArrayString &subgroups) override

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

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

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

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

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

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

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

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

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

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

bool	RemovePrivateConfigSubgroup (const wxString &group) override

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

virtual PluginID	GetID ()

virtual bool	Startup (EffectClientInterface *client)

virtual bool	Startup ()

virtual bool	GetAutomationParameters (wxString &parms)

virtual bool	SetAutomationParameters (const wxString &parms)

virtual wxArrayString	GetUserPresets ()

virtual bool	HasCurrentSettings ()

virtual bool	HasFactoryDefaults ()

virtual wxString	GetPreset (wxWindow *parent, const wxString &parms)

virtual wxString	ManualPage ()

virtual wxString	HelpPage ()

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

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

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

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

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

bool	IsRealtimeActive ()

virtual bool	IsHidden ()

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

Public Member Functions inherited from EffectClientInterface
virtual	~EffectClientInterface ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

Public Member Functions inherited from IdentInterface
virtual	~IdentInterface ()

const wxString &	GetTranslatedName ()

Public Member Functions inherited from ParamsInterface
virtual	~ParamsInterface ()

virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

Public Member Functions inherited from EffectHostInterface
virtual	~EffectHostInterface ()

Public Member Functions inherited from ConfigClientInterface
virtual	~ConfigClientInterface ()

Protected Member Functions
virtual bool	Init ()

virtual bool	PromptUser (wxWindow *parent)

virtual bool	CheckWhetherSkipEffect ()

virtual bool	Process ()

virtual bool	ProcessPass ()

virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual int	GetPass ()

virtual void	End ()

virtual double	CalcPreviewInputLength (double previewLength)

virtual void	Preview (bool dryOnly)

virtual void	PopulateOrExchange (ShuttleGui &S)

virtual bool	TransferDataToWindow ()

virtual bool	TransferDataFromWindow ()

virtual bool	EnableApply (bool enable=true)

virtual bool	EnablePreview (bool enable=true)

virtual void	EnableDebug (bool enable=true)

bool	TotalProgress (double frac)

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

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

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks ()

void	CopyInputTracks (int trackType)

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

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

void	ReplaceProcessedTracks (const bool bGoodResult)

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

TrackList *	inputTracks () const

Protected Attributes
ProgressDialog *	mProgress

double	mProjectRate

double	mSampleRate

SelectedRegion *	mpSelectedRegion {}

TrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

double	mF0

double	mF1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxDialog *	mUIDialog

wxWindow *	mUIParent

int	mUIResultID

sampleCount	mSampleCnt

int	mOutputTracksType

Private Member Functions
void	CommonInit ()

void	CountWaveTracks ()

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

Private Attributes
TrackList *	mTracks

bool	mIsBatch

bool	mIsLinearEffect

bool	mPreviewWithNotSelected

bool	mPreviewFullSelection

bool	mIsSelection

double	mDuration

NumericFormatId	mDurationFormat

bool	mIsPreview

bool	mUIDebug

std::vector< Track * >	mIMap

std::vector< Track * >	mOMap

int	mNumTracks

int	mNumGroups

EffectClientInterface *	mClient

size_t	mNumAudioIn

size_t	mNumAudioOut

size_t	mBufferSize

size_t	mBlockSize

unsigned	mNumChannels

std::vector< int >	mGroupProcessor

int	mCurrentProcessor

wxCriticalSection	mRealtimeSuspendLock

int	mRealtimeSuspendCount

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

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

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

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

Friends
class	EffectManager

class	EffectRack

class	EffectUIHost

class	EffectPresetsDialog

Detailed Description

Base class for many of the effects in Audacity.

Definition at line 62 of file Effect.h.

Member Enumeration Documentation

anonymous enum : long

Enumerator
DefaultMessageBoxStyle

Definition at line 268 of file Effect.h.

268 : long { DefaultMessageBoxStyle = wxOK | wxCENTRE };

Effect::DefaultMessageBoxStyle

Definition: Effect.h:268

Constructor & Destructor Documentation

Effect::Effect ( )

Definition at line 99 of file Effect.cpp.

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

 {
    mClient = NULL;
 
    mTracks = NULL;
    mOutputTracksType = Track::None;
    mT0 = 0.0;
    mT1 = 0.0;
    mDuration = 0.0;
    mIsPreview = false;
    mIsLinearEffect = false;
    mPreviewWithNotSelected = false;
    mPreviewFullSelection = false;
    mNumTracks = 0;
    mNumGroups = 0;
    mProgress = NULL;
 
    mRealtimeSuspendLock.Enter();
    mRealtimeSuspendCount = 1;    // Effects are initially suspended
    mRealtimeSuspendLock.Leave();
 
    mUIParent = NULL;
    mUIDialog = NULL;
 
    mNumAudioIn = 0;
    mNumAudioOut = 0;
 
    mBufferSize = 0;
    mBlockSize = 0;
    mNumChannels = 0;
 
    mUIDebug = false;
 
    AudacityProject *p = GetActiveProject();
    mProjectRate = p ? p->GetRate() : 44100;
 
    mIsBatch = false;
 }

Effect::~Effect ( )

virtual

Definition at line 138 of file Effect.cpp.

References mUIDialog.

 {
    if (mUIDialog)
    {
       mUIDialog->Close();
    }
 }

Member Function Documentation

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

protected

Definition at line 2104 of file Effect.cpp.

References name, and safenew.

Referenced by EffectFindClipping::Process().

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

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

protected

Definition at line 2067 of file Effect.cpp.

References mIMap, mOMap, and mOutputTracks.

Referenced by NyquistEffect::ProcessOne().

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

bool Effect::Apply ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 761 of file Effect.cpp.

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

Referenced by EffectUIHost::OnApply().

 {
    CommandContext context( *GetActiveProject() );
    // This is absolute hackage...but easy and I can't think of another way just now.
    //
    // It should callback to the EffectManager to kick off the processing
    return GetActiveProject()->DoEffect(GetID(), context,
       AudacityProject::OnEffectFlags::kConfigured);
 }

double Effect::CalcPreviewInputLength ( double previewLength )

protectedvirtual

Reimplemented in EffectTruncSilence, EffectChangeSpeed, and EffectPaulstretch.

Definition at line 2274 of file Effect.cpp.

Referenced by Preview(), and ProcessTrack().

 {
    return previewLength;
 }

bool Effect::CanExportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 693 of file Effect.cpp.

 {
    return false;
 }

virtual bool Effect::CheckWhetherSkipEffect ( )

inlineprotectedvirtual

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

Definition at line 297 of file Effect.h.

Referenced by DoEffect().

297 { return false; }

bool Effect::CloseUI ( )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in EffectEqualization.

Definition at line 682 of file Effect.cpp.

References mUIDialog, and mUIParent.

Referenced by EffectEqualization::CloseUI().

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

void Effect::CommonInit ( )

private

void Effect::CopyInputTracks ( )

protected

Definition at line 2036 of file Effect.cpp.

References Track::Wave.

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

 {
    CopyInputTracks(Track::Wave);
 }

void Effect::CopyInputTracks ( int trackType )

protected

Definition at line 2041 of file Effect.cpp.

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

 {
    // Reset map
    mIMap.clear();
    mOMap.clear();
 
    mOutputTracks = TrackList::Create();
    mOutputTracksType = trackType;
 
    //iterate over tracks of type trackType (All types if Track::All)
    TrackListOfKindIterator aIt(trackType, mTracks);
    t2bHash added;
 
    for (Track *aTrack = aIt.First(); aTrack; aTrack = aIt.Next())
    {
       // Include selected tracks, plus sync-lock selected tracks for Track::All.
       if (aTrack->GetSelected() ||
             (trackType == Track::All && aTrack->IsSyncLockSelected()))
       {
          Track *o = mOutputTracks->Add(aTrack->Duplicate());
          mIMap.push_back(aTrack);
          mOMap.push_back(o);
       }
    }
 }

void Effect::CountWaveTracks ( )

private

Definition at line 2251 of file Effect.cpp.

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

Referenced by DoEffect(), and Preview().

 {
    mNumTracks = 0;
    mNumGroups = 0;
 
    TrackListOfKindIterator iter(Track::Wave, mTracks);
    Track *t = iter.First();
 
    while(t) {
       if (!t->GetSelected()) {
          t = iter.Next();
          continue;
       }
 
       if (t->GetKind() == Track::Wave) {
          mNumTracks++;
          if (!t->GetLinked())
             mNumGroups++;
       }
       t = iter.Next();
    }
 }

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

overridevirtual

Implements EffectHostInterface.

Definition at line 776 of file Effect.cpp.

References safenew.

Referenced by ShowInterface().

 {
    Destroy_ptr<EffectUIHost> dlg
       { safenew EffectUIHost{ parent, this, client} };
 
    if (dlg->Initialize())
    {
       // release() is safe because parent will own it
       return dlg.release();
    }
 
    return NULL;
 }

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

Definition at line 1257 of file Effect.cpp.

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

Referenced by NyquistEffect::ShowInterface().

 {
    return delegate.DoEffect( parent, mProjectRate, mTracks, mFactory,
       mpSelectedRegion, shouldPrompt );
 }

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

Definition at line 1156 of file Effect.cpp.

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

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

 {
    wxASSERT(selectedRegion->duration() >= 0.0);
 
    mOutputTracks.reset();
 
    mpSelectedRegion = selectedRegion;
    mFactory = factory;
    mProjectRate = projectRate;
    mTracks = list;
    
    bool isSelection = false;
 
    mDuration = 0.0;
 
    if (GetType() == EffectTypeGenerate)
    {
       GetPrivateConfig(GetCurrentSettingsGroup(), wxT("LastUsedDuration"), mDuration, GetDefaultDuration());
    }
 
    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;
       mT1 = mT0 + mDuration;
 
       isSelection = true;
    }
 
    mDurationFormat = isSelection
       ? NumericConverter::TimeAndSampleFormat()
       : NumericConverter::DefaultSelectionFormat();
 
 #ifdef EXPERIMENTAL_SPECTRAL_EDITING
    mF0 = selectedRegion->f0();
    mF1 = selectedRegion->f1();
    wxArrayString Names;
    if( mF0 != SelectedRegion::UndefinedFrequency )
       Names.Add(wxT("control-f0"));
    if( mF1 != SelectedRegion::UndefinedFrequency )
       Names.Add(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 (shouldPrompt && IsInteractive() && !PromptUser(parent))
    {
       return false;
    }
 
    auto cleanup = finally( [&] {
       End();
 
       // In case of failed effect, be sure to free memory.
       ReplaceProcessedTracks( false );
    } );
 
    bool returnVal = true;
    bool skipFlag = CheckWhetherSkipEffect();
    if (skipFlag == false)
    {
       auto name = GetTranslatedName();
       ProgressDialog progress{
          name,
          wxString::Format(_("Applying %s..."), name),
          pdlgHideStopButton
       };
       auto vr = valueRestorer( mProgress, &progress );
 
       returnVal = Process();
    }
 
    if (returnVal)
    {
       selectedRegion->setTimes(mT0, mT1);
    }
 
    return returnVal;
 }

bool Effect::EnableApply ( bool enable = true )

protectedvirtual

Definition at line 1886 of file Effect.cpp.

References EnablePreview(), mUIDialog, and mUIParent.

 {
    // 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;
 }

void Effect::EnableDebug ( bool enable = true )

protectedvirtual

Definition at line 1956 of file Effect.cpp.

References mUIDebug.

Referenced by NyquistEffect::PopulateOrExchange().

 {
    mUIDebug = enable;
 }

bool Effect::EnablePreview ( bool enable = true )

protectedvirtual

Definition at line 1917 of file Effect.cpp.

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

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

 {
    // 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;
 }

void Effect::End ( )

protectedvirtual

Reimplemented in EffectAutoDuck, and EffectStereoToMono.

Definition at line 1867 of file Effect.cpp.

Referenced by DoEffect(), and Preview().

1868 {

1869 }

void Effect::ExportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 698 of file Effect.cpp.

699 {

700 }

unsigned Effect::GetAudioInCount ( )

overridevirtual

Implements EffectClientInterface.

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

Definition at line 282 of file Effect.cpp.

References EffectClientInterface::GetAudioInCount(), and mClient.

Referenced by Process(), and Startup().

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

unsigned Effect::GetAudioOutCount ( )

overridevirtual

Implements EffectClientInterface.

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

Definition at line 292 of file Effect.cpp.

References EffectClientInterface::GetAudioOutCount(), and mClient.

Referenced by Process(), and Startup().

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

bool Effect::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Implements EffectClientInterface.

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

Definition at line 564 of file Effect.cpp.

References EffectClientInterface::GetAutomationParameters(), and mClient.

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

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

bool Effect::GetAutomationParameters ( wxString & parms )

virtual

Definition at line 1002 of file Effect.cpp.

References ParamsInterface::DefineParams(), GetAutomationParameters(), CommandParameters::GetParameters(), ShuttleParams::mpEap, mUIDialog, and TransferDataFromWindow().

 {
    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);
 }

wxString Effect::GetCurrentSettingsGroup ( )

overridevirtual

double Effect::GetDefaultDuration ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 717 of file Effect.cpp.

Referenced by DoEffect().

 {
    return 30.0;
 }

wxString Effect::GetDescription ( )

overridevirtual

Implements IdentInterface.

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

Definition at line 198 of file Effect.cpp.

References IdentInterface::GetDescription(), and mClient.

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

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

double Effect::GetDuration ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 722 of file Effect.cpp.

References mDuration.

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

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

NumericFormatId Effect::GetDurationFormat ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 732 of file Effect.cpp.

References mDurationFormat.

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

 {
    return mDurationFormat;
 }

wxString Effect::GetFactoryDefaultsGroup ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 806 of file Effect.cpp.

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

 {
    return wxT("FactoryDefaults");
 }

wxArrayString Effect::GetFactoryPresets ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectReverb.

Definition at line 616 of file Effect.cpp.

References EffectClientInterface::GetFactoryPresets(), and mClient.

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

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

IdentInterfaceSymbol Effect::GetFamilyId ( )

overridevirtual

Implements EffectDefinitionInterface.

Reimplemented in NyquistEffect.

Definition at line 208 of file Effect.cpp.

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

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

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

PluginID Effect::GetID ( )

virtual

Definition at line 959 of file Effect.cpp.

References PluginManager::GetID(), and mClient.

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

 {
    if (mClient)
    {
       return PluginManager::GetID(mClient);
    }
 
    return PluginManager::GetID(this);
 }

sampleCount Effect::GetLatency ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 344 of file Effect.cpp.

References EffectClientInterface::GetLatency(), and mClient.

Referenced by ProcessTrack().

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

int Effect::GetMidiInCount ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 302 of file Effect.cpp.

References EffectClientInterface::GetMidiInCount(), and mClient.

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

int Effect::GetMidiOutCount ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 312 of file Effect.cpp.

References EffectClientInterface::GetMidiOutCount(), and mClient.

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

int Effect::GetNumWaveGroups ( )

inlineprotected

Definition at line 345 of file Effect.h.

Referenced by NyquistEffect::Process().

345 { return mNumGroups; }

Effect::mNumGroups

int mNumGroups

Definition: Effect.h:524

int Effect::GetNumWaveTracks ( )

inlineprotected

Definition at line 343 of file Effect.h.

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

343 { return mNumTracks; }

Effect::mNumTracks

int mNumTracks

Definition: Effect.h:523

int Effect::GetPass ( )

protectedvirtual

Definition at line 1275 of file Effect.cpp.

References mPass.

 {
    return mPass;
 }

wxString Effect::GetPath ( )

overridevirtual

Implements IdentInterface.

Reimplemented in NyquistEffect.

Definition at line 158 of file Effect.cpp.

References BUILTIN_EFFECT_PREFIX, IdentInterface::GetPath(), GetSymbol(), IdentInterfaceSymbol::Internal(), and mClient.

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

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

virtual

Definition at line 1110 of file Effect.cpp.

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

Referenced by EffectManager::GetPreset().

 {
    EffectPresetsDialog dlg(parent, this);
    dlg.Layout();
    dlg.Fit();
    dlg.SetSize(dlg.GetMinSize());
    dlg.CenterOnParent();
    dlg.SetSelected(parms);
 
    if (dlg.ShowModal())
    {
       return dlg.GetSelected();
    }
 
    return wxEmptyString;
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 897 of file Effect.cpp.

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

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

 {
    return PluginManager::Get().GetPrivateConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 902 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetPrivateConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 907 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetPrivateConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 912 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetPrivateConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 917 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetPrivateConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 892 of file Effect.cpp.

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

Referenced by GetUserPresets(), and EffectUIHost::LoadUserPresets().

 {
    return PluginManager::Get().GetPrivateConfigSubgroups(GetID(), group, subgroups);
 }

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

protected

Definition at line 2001 of file Effect.cpp.

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

Referenced by ProcessPass().

 {
    double trackStart = track->GetStartTime();
    double trackEnd = track->GetEndTime();
    double t0 = mT0 < trackStart ? trackStart : mT0;
    double t1 = mT1 > trackEnd ? trackEnd : mT1;
 
 #if 0
    if (GetType() & INSERT_EFFECT) {
       t1 = t0 + mDuration;
       if (mT0 == mT1) {
          // Not really part of the calculation, but convenient to put here
          track->InsertSilence(t0, t1);
       }
    }
 #endif
 
    if (t1 > t0) {
       *start = track->TimeToLongSamples(t0);
       auto end = track->TimeToLongSamples(t1);
       *len = end - *start;
    }
    else {
       *start = 0;
       *len  = 0;
    }
 }

wxString Effect::GetSavedStateGroup ( )

virtual

Definition at line 811 of file Effect.cpp.

Referenced by SetBatchProcessing().

 {
    return wxT("SavedState");
 }

NumericFormatId Effect::GetSelectionFormat ( )

virtual

Definition at line 737 of file Effect.cpp.

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

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

 {
    return GetActiveProject()->GetSelectionFormat();
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 827 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetSharedConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 832 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetSharedConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 837 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetSharedConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 842 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetSharedConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 847 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetSharedConfig(GetID(), group, key, value, defval);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 822 of file Effect.cpp.

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

 {
    return PluginManager::Get().GetSharedConfigSubgroups(GetID(), group, subgroups);
 }

IdentInterfaceSymbol Effect::GetSymbol ( )

overridevirtual

Implements IdentInterface.

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

Definition at line 168 of file Effect.cpp.

References IdentInterface::GetSymbol(), and mClient.

Referenced by GetPath().

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

size_t Effect::GetTailSize ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 354 of file Effect.cpp.

References EffectClientInterface::GetTailSize(), and mClient.

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

EffectType Effect::GetType ( )

overridevirtual

Implements EffectDefinitionInterface.

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

Definition at line 148 of file Effect.cpp.

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

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

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

wxArrayString Effect::GetUserPresets ( )

virtual

Definition at line 1089 of file Effect.cpp.

References GetPrivateConfigSubgroups(), and GetUserPresetsGroup().

Referenced by EffectManager::HasPresets().

 {
    wxArrayString presets;
 
    GetPrivateConfigSubgroups(GetUserPresetsGroup(wxEmptyString), presets);
 
    presets.Sort();
 
    return presets;
 }

wxString Effect::GetUserPresetsGroup ( const wxString & name )

overridevirtual

Implements EffectHostInterface.

Definition at line 790 of file Effect.cpp.

References name.

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

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

IdentInterfaceSymbol Effect::GetVendor ( )

overridevirtual

Implements IdentInterface.

Reimplemented in NyquistEffect.

Definition at line 178 of file Effect.cpp.

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

Referenced by EffectUIHost::OnMenu().

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

wxString Effect::GetVersion ( )

overridevirtual

Implements IdentInterface.

Reimplemented in NyquistEffect.

Definition at line 188 of file Effect.cpp.

References AUDACITY_VERSION_STRING, IdentInterface::GetVersion(), and mClient.

Referenced by EffectUIHost::OnMenu().

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

bool Effect::HasCurrentSettings ( )

virtual

Definition at line 1100 of file Effect.cpp.

References GetCurrentSettingsGroup(), and HasPrivateConfigGroup().

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

 {
    return HasPrivateConfigGroup(GetCurrentSettingsGroup());
 }

bool Effect::HasFactoryDefaults ( )

virtual

Definition at line 1105 of file Effect.cpp.

References GetFactoryDefaultsGroup(), and HasPrivateConfigGroup().

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

 {
    return HasPrivateConfigGroup(GetFactoryDefaultsGroup());
 }

bool Effect::HasOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 706 of file Effect.cpp.

 {
    return false;
 }

bool Effect::HasPrivateConfigGroup ( const wxString & group )

overridevirtual

Implements ConfigClientInterface.

Definition at line 887 of file Effect.cpp.

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

Referenced by HasCurrentSettings(), and HasFactoryDefaults().

 {
    return PluginManager::Get().HasPrivateConfigGroup(GetID(), group);
 }

bool Effect::HasSharedConfigGroup ( const wxString & group )

overridevirtual

Implements ConfigClientInterface.

Definition at line 817 of file Effect.cpp.

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

 {
    return PluginManager::Get().HasSharedConfigGroup(GetID(), group);
 }

wxString Effect::HelpPage ( )

virtual

Reimplemented in NyquistEffect.

Definition at line 1132 of file Effect.cpp.

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

 {
    return wxEmptyString;
 }

bool Effect::HideUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 677 of file Effect.cpp.

 {
    return true;
 }

void Effect::ImportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 702 of file Effect.cpp.

703 {

704 }

void Effect::IncludeNotSelectedPreviewTracks ( bool includeNotSelected )

protected

Definition at line 1972 of file Effect.cpp.

References mPreviewWithNotSelected.

 {
    mPreviewWithNotSelected = includeNotSelected;
 }

bool Effect::Init ( )

protectedvirtual

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

Definition at line 1264 of file Effect.cpp.

Referenced by DoEffect(), and Preview().

 {
    return true;
 }

bool Effect::InitPass1 ( )

protectedvirtual

Reimplemented in EffectCompressor, and EffectTwoPassSimpleMono.

Definition at line 1280 of file Effect.cpp.

Referenced by Process().

 {
    return true;
 }

bool Effect::InitPass2 ( )

protectedvirtual

Reimplemented in EffectCompressor, and EffectTwoPassSimpleMono.

Definition at line 1285 of file Effect.cpp.

Referenced by Process().

 {
    return false;
 }

TrackList* Effect::inputTracks ( ) const

inlineprotected

Definition at line 458 of file Effect.h.

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

458 { return mTracks; }

Effect::mTracks

TrackList * mTracks

Definition: Effect.h:505

bool Effect::IsBatchProcessing ( )

virtual

Definition at line 1137 of file Effect.cpp.

References mIsBatch.

Referenced by EffectAmplify::DefineParams(), EffectAmplify::GetAutomationParameters(), EffectUIHost::Initialize(), EffectAmplify::PopulateOrExchange(), PromptUser(), and EffectAmplify::SetAutomationParameters().

 {
    return mIsBatch;
 }

bool Effect::IsDefault ( )

overridevirtual

Implements EffectDefinitionInterface.

Reimplemented in NyquistEffect.

Definition at line 230 of file Effect.cpp.

References EffectDefinitionInterface::IsDefault(), and mClient.

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

bool Effect::IsGraphicalUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 667 of file Effect.cpp.

 {
    return false;
 }

bool Effect::IsHidden ( )

virtual

Reimplemented in EffectStereoToMono.

Definition at line 2467 of file Effect.cpp.

Referenced by EffectManager::IsHidden().

 {
    return false;
 }

bool Effect::IsInteractive ( )

overridevirtual

Implements EffectDefinitionInterface.

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

Definition at line 220 of file Effect.cpp.

References EffectDefinitionInterface::IsInteractive(), and mClient.

Referenced by DoEffect(), and ShowInterface().

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

bool Effect::IsLegacy ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 240 of file Effect.cpp.

References mClient.

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

bool Effect::IsPreviewing ( )

inlineprotected

Definition at line 361 of file Effect.h.

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

361 { return mIsPreview; }

Effect::mIsPreview

bool mIsPreview

Definition: Effect.h:516

bool Effect::IsReady ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 364 of file Effect.cpp.

References EffectClientInterface::IsReady(), and mClient.

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

bool Effect::IsRealtimeActive ( )

Definition at line 2462 of file Effect.cpp.

References mRealtimeSuspendCount.

 {
    return mRealtimeSuspendCount == 0;
 }

bool Effect::LoadFactoryDefaults ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectEqualization.

Definition at line 636 of file Effect.cpp.

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

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

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

bool Effect::LoadFactoryPreset ( int id )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectReverb.

Definition at line 626 of file Effect.cpp.

References EffectClientInterface::LoadFactoryPreset(), and mClient.

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

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

bool Effect::LoadUserPreset ( const wxString & name )

overridevirtual

Implements EffectClientInterface.

Definition at line 584 of file Effect.cpp.

References GetPrivateConfig(), EffectClientInterface::LoadUserPreset(), mClient, and SetAutomationParameters().

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

 {
    if (mClient)
    {
       return mClient->LoadUserPreset(name);
    }
 
    wxString parms;
    if (!GetPrivateConfig(name, wxT("Parameters"), parms))
    {
       return false;
    }
 
    return SetAutomationParameters(parms);
 }

wxString Effect::ManualPage ( )

virtual

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

Definition at line 1127 of file Effect.cpp.

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

 {
    return wxEmptyString;
 }

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

Definition at line 2646 of file Effect.cpp.

References _(), AudacityMessageBox(), IdentInterface::GetTranslatedName(), and mUIParent.

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

 {
    wxString title;
    if (titleStr.empty())
       title = GetTranslatedName();
    else
       title = wxString::Format(_("%s: %s"), GetTranslatedName(), titleStr);
    return AudacityMessageBox(message, title, style, mUIParent);
 }

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

protected

Definition at line 2155 of file Effect.cpp.

Referenced by EffectFindClipping::Process().

 {
    return{ this, pOrigTrack, name };
 }

void Effect::PopulateOrExchange ( ShuttleGui & S )

protectedvirtual

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

Definition at line 1871 of file Effect.cpp.

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

 {
    return;
 }

bool Effect::PopulateUI ( wxWindow * parent )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in EffectEqualization.

Definition at line 652 of file Effect.cpp.

References eIsCreating, mUIParent, and PopulateOrExchange().

 {
    mUIParent = parent;
    mUIParent->PushEventHandler(this);
 
 //   LoadUserPreset(GetCurrentSettingsGroup());
 
    ShuttleGui S(mUIParent, eIsCreating);
    PopulateOrExchange(S);
 
    mUIParent->SetMinSize(mUIParent->GetSizer()->GetMinSize());
 
    return true;
 }

void Effect::Preview ( )

overridevirtual

Implements EffectHostInterface.

Definition at line 771 of file Effect.cpp.

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

 {
    Preview(false);
 }

void Effect::Preview ( bool dryOnly )

protectedvirtual

Reimplemented in EffectAmplify.

Definition at line 2472 of file Effect.cpp.

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

 {
    if (mNumTracks == 0) { // nothing to preview
       return;
    }
 
    if (gAudioIO->IsBusy()) {
       return;
    }
 
    wxWindow *FocusDialog = wxWindow::FindFocus();
 
    double previewDuration;
    bool isNyquist = GetFamilyId() == 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) && !(isNyquist && 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(); } );
       }
    } );
 
    auto vr0 = valueRestorer( mT0 );
    auto vr1 = valueRestorer( mT1 );
    // Most effects should stop at t1.
    if (!mPreviewFullSelection)
       mT1 = t1;
 
    // 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
    auto uTracks = TrackList::Create();
    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);
       mixLeft->SetDisplay(WaveTrack::NoDisplay);
       mTracks->Add(std::move(mixLeft));
       if (mixRight) {
          mixRight->Offset(-mixRight->GetStartTime());
          mixRight->SetSelected(true);
          mTracks->Add(std::move(mixRight));
       }
    }
    else {
       TrackListOfKindIterator iter(Track::Wave, saveTracks);
       WaveTrack *src = (WaveTrack *) iter.First();
       while (src)
       {
          if (src->GetSelected() || mPreviewWithNotSelected) {
             auto dest = src->Copy(mT0, t1);
             dest->SetSelected(src->GetSelected());
             static_cast<WaveTrack*>(dest.get())->SetDisplay(WaveTrack::NoDisplay);
             mTracks->Add(std::move(dest));
          }
          src = (WaveTrack *) iter.Next();
       }
    }
 
    // 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{
          GetTranslatedName(),
          _("Preparing preview"),
          pdlgHideCancelButton
       }; // Have only "Stop" button.
       auto vr = valueRestorer( mProgress, &progress );
 
       auto vr2 = valueRestorer( mIsPreview, true );
 
       success = Process();
    }
 
    if (success)
    {
       auto tracks = 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
       AudioIOStartStreamOptions options { rate };
       int token =
          gAudioIO->StartStream(tracks, mT0, 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
             (GetTranslatedName(), _("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 {
          ShowErrorDialog(FocusDialog, _("Error"),
                          _("Error opening sound device.\nTry changing the audio host, playback device and the project sample rate."),
                          wxT("Error_opening_sound_device"));
       }
    }
 }

bool Effect::Process ( )

protectedvirtual

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

Definition at line 1290 of file Effect.cpp.

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

Referenced by DoEffect(), and Preview().

 {
    CopyInputTracks(Track::All);
    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;
 }

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

overridevirtual

Implements EffectClientInterface.

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

Definition at line 394 of file Effect.cpp.

References mClient, and EffectClientInterface::ProcessBlock().

Referenced by ProcessTrack().

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

bool Effect::ProcessFinalize ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectReverb.

Definition at line 384 of file Effect.cpp.

References mClient, and EffectClientInterface::ProcessFinalize().

Referenced by ProcessTrack().

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

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

overridevirtual

Implements EffectClientInterface.

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

Definition at line 374 of file Effect.cpp.

References mClient, and EffectClientInterface::ProcessInitialize().

Referenced by ProcessTrack().

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

bool Effect::ProcessPass ( )

protectedvirtual

Reimplemented in EffectTwoPassSimpleMono.

Definition at line 1316 of file Effect.cpp.

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

Referenced by Process().

 {
    bool bGoodResult = true;
    bool isGenerator = GetType() == EffectTypeGenerate;
 
    FloatBuffers inBuffer, outBuffer;
    ArrayOf<float *> inBufPos, outBufPos;
 
    ChannelName map[3];
 
    mBufferSize = 0;
    mBlockSize = 0;
 
    TrackListIterator iter(mOutputTracks.get());
    int count = 0;
    bool clear = false;
    Track* t = iter.First();
 
    for (t = iter.First(); t; t = iter.Next())
    {
       if (t->GetKind() != Track::Wave || !t->GetSelected())
       {
          if (t->IsSyncLockSelected())
          {
             t->SyncLockAdjust(mT1, mT0 + mDuration);
          }
          continue;
       }
 
       WaveTrack *left = (WaveTrack *)t;
       WaveTrack *right;
       sampleCount len;
       sampleCount leftStart;
       sampleCount rightStart;
 
       if (!isGenerator)
       {
          GetSamples(left, &leftStart, &len);
          mSampleCnt = len;
       }
       else
       {
          len = 0;
          leftStart = 0;
          mSampleCnt = left->TimeToLongSamples(mDuration);
       }
 
       mNumChannels = 1;
 
       if (left->GetChannel() == Track::LeftChannel)
       {
          map[0] = ChannelNameFrontLeft;
       }
       else if (left->GetChannel() == Track::RightChannel)
       {
          map[0] = ChannelNameFrontRight;
       }
       else
       {
          map[0] = ChannelNameMono;
       }
       map[1] = ChannelNameEOL;
 
       right = NULL;
       rightStart = 0;
       if (left->GetLinked() && mNumAudioIn > 1)
       {
          // Assume linked track is wave
          right = static_cast<WaveTrack *>(iter.Next());
          if (!isGenerator)
          {
             GetSamples(right, &rightStart, &len);
          }
          clear = false;
          mNumChannels = 2;
 
          if (right->GetChannel() == Track::LeftChannel)
          {
             map[1] = ChannelNameFrontLeft;
          }
          else if (right->GetChannel() == Track::RightChannel)
          {
             map[1] = ChannelNameFrontRight;
          }
          else
          {
             map[1] = ChannelNameMono;
          }
          map[2] = ChannelNameEOL;
       }
 
       // 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.
          // Output buffers get an extra mBlockSize worth to give extra room if
          // the plugin adds latency
          outBufPos.reinit( mNumAudioOut );
          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, leftStart, rightStart, len,
          inBuffer, outBuffer, inBufPos, outBufPos);
       if (!bGoodResult)
       {
          break;
       }
 
       count++;
    }
 
    if (bGoodResult && GetType() == EffectTypeGenerate)
    {
       mT1 = mT0 + mDuration;
    }
 
    return bGoodResult;
 }

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

private

Definition at line 1486 of file Effect.cpp.

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

Referenced by ProcessPass().

 {
    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 inLeftPos = leftStart;
    auto inRightPos = rightStart;
    auto outLeftPos = leftStart;
    auto outRightPos = rightStart;
 
    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::unique_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 = mFactory->NewWaveTrack(left->GetSampleFormat(), left->GetRate());
       genLeft->SetWaveColorIndex( left->GetWaveColorIndex() );
 
       if (right)
       {
          genRight = mFactory->NewWaveTrack(right->GetSampleFormat(), right->GetRate());
          genRight->SetWaveColorIndex( right->GetWaveColorIndex() );
       }
    }
 
    // 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->Get((samplePtr) inBuffer[0].get(), floatSample, inLeftPos, inputBufferCnt);
             if (right)
             {
                right->Get((samplePtr) inBuffer[1].get(), floatSample, inRightPos, 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.
       inLeftPos += curBlockSize;
       inRightPos += 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, outLeftPos, outputBufferCnt);
             if (right)
             {
                if (chans >= 2)
                {
                   right->Set((samplePtr) outBuffer[1].get(), floatSample, outRightPos, outputBufferCnt);
                }
                else
                {
                   right->Set((samplePtr) outBuffer[0].get(), floatSample, outRightPos, 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
          outLeftPos += outputBufferCnt;
          outRightPos += outputBufferCnt;
          outputBufferCnt = 0;
       }
 
       if (mNumChannels > 1)
       {
          if (TrackGroupProgress(count,
                (inLeftPos - leftStart).as_double() /
                (isGenerator ? genLength : len).as_double()))
          {
             rc = false;
             break;
          }
       }
       else
       {
          if (TrackProgress(count,
                (inLeftPos - leftStart).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, outLeftPos, outputBufferCnt);
          if (right)
          {
             if (chans >= 2)
             {
                right->Set((samplePtr) outBuffer[1].get(), floatSample, outRightPos, outputBufferCnt);
             }
             else
             {
                right->Set((samplePtr) outBuffer[0].get(), floatSample, outRightPos, 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)
    {
       AudacityProject *p = GetActiveProject();
 
       // PRL:  this code was here and could not have been the right
       // intent, mixing time and sampleCount values:
       // StepTimeWarper warper(mT0 + genLength, genLength - (mT1 - mT0));
 
       // This looks like what it should have been:
       // StepTimeWarper warper(mT0 + genDur, genDur - (mT1 - mT0));
       // But rather than fix it, I will just disable the use of it for now.
       // The purpose was to remap split lines inside the selected region when
       // a generator replaces it with sound of different duration.  But
       // the "correct" version might have the effect of mapping some splits too
       // far left, to before the selection.
       // In practice the wrong version probably did nothing most of the time,
       // because the cutoff time for the step time warper was 44100 times too
       // far from mT0.
 
       // 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().
       left->ClearAndPaste(mT0, p->GetSel1(), genLeft.get(), true, true,
                           nullptr /* &warper */);
 
       if (genRight)
       {
          genRight->Flush();
          right->ClearAndPaste(mT0, mT1, genRight.get(), true, true,
                               nullptr /* &warper */);
       }
    }
 
    } // End scope for cleanup
    return rc;
 }

bool Effect::PromptUser ( wxWindow * parent )

protectedvirtual

Reimplemented in EffectNoiseReduction.

Definition at line 1270 of file Effect.cpp.

References IsBatchProcessing(), and ShowInterface().

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

 {
    return ShowInterface(parent, IsBatchProcessing());
 }

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

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectPhaser, and EffectWahwah.

Definition at line 417 of file Effect.cpp.

References mClient, and EffectClientInterface::RealtimeAddProcessor().

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

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

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

Definition at line 2282 of file Effect.cpp.

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

 {
    auto ichans = chans;
    auto ochans = chans;
    auto gchans = chans;
 
    // Reset processor index
    if (group == 0)
    {
       mCurrentProcessor = 0;
       mGroupProcessor.clear();
    }
 
    // Remember the processor starting index
    mGroupProcessor.push_back(mCurrentProcessor);
 
    // Call the client until we run out of input or output channels
    while (ichans > 0 && ochans > 0)
    {
       // If we don't have enough input channels to accomodate the client's
       // requirements, then we replicate the input channels until the
       // client's needs are met.
       if (ichans < mNumAudioIn)
       {
          // All input channels have been consumed
          ichans = 0;
       }
       // Otherwise fullfil the client's needs with as many input channels as possible.
       // After calling the client with this set, we will loop back up to process more
       // of the input/output channels.
       else if (ichans >= mNumAudioIn)
       {
          gchans = mNumAudioIn;
          ichans -= gchans;
       }
 
       // If we don't have enough output channels to accomodate the client's
       // requirements, then we provide all of the output channels and fulfill
       // the client's needs with dummy buffers.  These will just get tossed.
       if (ochans < mNumAudioOut)
       {
          // All output channels have been consumed
          ochans = 0;
       }
       // Otherwise fullfil the client's needs with as many output channels as possible.
       // After calling the client with this set, we will loop back up to process more
       // of the input/output channels.
       else if (ochans >= mNumAudioOut)
       {
          ochans -= mNumAudioOut;
       }
 
       // Add a NEW processor
       RealtimeAddProcessor(gchans, rate);
 
       // Bump to next processor
       mCurrentProcessor++;
    }
 
    return true;
 }

bool Effect::RealtimeFinalize ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectPhaser, and EffectWahwah.

Definition at line 427 of file Effect.cpp.

References mClient, and EffectClientInterface::RealtimeFinalize().

Referenced by EffectManager::RealtimeRemoveEffect().

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

bool Effect::RealtimeInitialize ( )

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectPhaser, and EffectWahwah.

Definition at line 404 of file Effect.cpp.

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

Referenced by EffectManager::RealtimeAddEffect().

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

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

overridevirtual

Implements EffectClientInterface.

Reimplemented in EffectPhaser, and EffectWahwah.

Definition at line 491 of file Effect.cpp.

References mClient, and EffectClientInterface::RealtimeProcess().

Referenced by RealtimeProcess().

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

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

Definition at line 2347 of file Effect.cpp.

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

 {
    //
    // The caller passes the number of channels to process and specifies
    // the number of input and output buffers.  There will always be the
    // same number of output buffers as there are input buffers.
    //
    // Effects always require a certain number of input and output buffers,
    // so if the number of channels we're curently processing are different
    // than what the effect expects, then we use a few methods of satisfying
    // the effects requirements.
    float **clientIn = (float **) alloca(mNumAudioIn * sizeof(float *));
    float **clientOut = (float **) alloca(mNumAudioOut * sizeof(float *));
    float *dummybuf = (float *) alloca(numSamples * sizeof(float));
    decltype(numSamples) len = 0;
    auto ichans = chans;
    auto ochans = chans;
    auto gchans = chans;
    unsigned indx = 0;
    unsigned ondx = 0;
 
    int processor = mGroupProcessor[group];
 
    // Call the client until we run out of input or output channels
    while (ichans > 0 && ochans > 0)
    {
       // If we don't have enough input channels to accomodate the client's
       // requirements, then we replicate the input channels until the
       // client's needs are met.
       if (ichans < mNumAudioIn)
       {
          for (size_t i = 0; i < mNumAudioIn; i++)
          {
             if (indx == ichans)
             {
                indx = 0;
             }
             clientIn[i] = inbuf[indx++];
          }
 
          // All input channels have been consumed
          ichans = 0;
       }
       // Otherwise fullfil the client's needs with as many input channels as possible.
       // After calling the client with this set, we will loop back up to process more
       // of the input/output channels.
       else if (ichans >= mNumAudioIn)
       {
          gchans = 0;
          for (size_t i = 0; i < mNumAudioIn; i++, ichans--, gchans++)
          {
             clientIn[i] = inbuf[indx++];
          }
       }
 
       // If we don't have enough output channels to accomodate the client's
       // requirements, then we provide all of the output channels and fulfill
       // the client's needs with dummy buffers.  These will just get tossed.
       if (ochans < mNumAudioOut)
       {
          for (size_t i = 0; i < mNumAudioOut; i++)
          {
             if (i < ochans)
             {
                clientOut[i] = outbuf[i];
             }
             else
             {
                clientOut[i] = dummybuf;
             }
          }
 
          // All output channels have been consumed
          ochans = 0;
       }
       // Otherwise fullfil the client's needs with as many output channels as possible.
       // After calling the client with this set, we will loop back up to process more
       // of the input/output channels.
       else if (ochans >= mNumAudioOut)
       {
          for (size_t i = 0; i < mNumAudioOut; i++, ochans--)
          {
             clientOut[i] = outbuf[ondx++];
          }
       }
 
       // Finally call the plugin to process the block
       len = 0;
       for (decltype(numSamples) block = 0; block < numSamples; block += mBlockSize)
       {
          auto cnt = std::min(numSamples - block, mBlockSize);
          len += RealtimeProcess(processor, clientIn, clientOut, cnt);
 
          for (size_t i = 0 ; i < mNumAudioIn; i++)
          {
             clientIn[i] += cnt;
          }
 
          for (size_t i = 0 ; i < mNumAudioOut; i++)
          {
             clientOut[i] += cnt;
          }
       }
 
       // Bump to next processor
       processor++;
    }
 
    return len;
 }

bool Effect::RealtimeProcessEnd ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 504 of file Effect.cpp.

References mClient, and EffectClientInterface::RealtimeProcessEnd().

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

bool Effect::RealtimeProcessStart ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 481 of file Effect.cpp.

References mClient, and EffectClientInterface::RealtimeProcessStart().

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

bool Effect::RealtimeResume ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 459 of file Effect.cpp.

References mClient, mRealtimeSuspendCount, mRealtimeSuspendLock, and EffectClientInterface::RealtimeResume().

Referenced by EffectUIHost::Resume().

 {
    if (mClient)
    {
       if (mClient->RealtimeResume())
       {
          mRealtimeSuspendLock.Enter();
          mRealtimeSuspendCount--;
          mRealtimeSuspendLock.Leave();
          return true;
       }
 
       return false;
    }
 
    mRealtimeSuspendLock.Enter();
    mRealtimeSuspendCount--;
    mRealtimeSuspendLock.Leave();
 
    return true;
 }

bool Effect::RealtimeSuspend ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 437 of file Effect.cpp.

References mClient, mRealtimeSuspendCount, mRealtimeSuspendLock, and EffectClientInterface::RealtimeSuspend().

Referenced by EffectUIHost::OnEnable().

 {
    if (mClient)
    {
       if (mClient->RealtimeSuspend())
       {
          mRealtimeSuspendLock.Enter();
          mRealtimeSuspendCount++;
          mRealtimeSuspendLock.Leave();
          return true;
       }
 
       return false;
    }
 
    mRealtimeSuspendLock.Enter();
    mRealtimeSuspendCount++;
    mRealtimeSuspendLock.Leave();
 
    return true;
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 952 of file Effect.cpp.

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

 {
    return PluginManager::Get().RemovePrivateConfig(GetID(), group, key);
 }

bool Effect::RemovePrivateConfigSubgroup ( const wxString & group )

overridevirtual

Implements ConfigClientInterface.

Definition at line 947 of file Effect.cpp.

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

Referenced by EffectUIHost::OnDeletePreset().

 {
    return PluginManager::Get().RemovePrivateConfigSubgroup(GetID(), group);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 882 of file Effect.cpp.

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

 {
    return PluginManager::Get().RemoveSharedConfig(GetID(), group, key);
 }

bool Effect::RemoveSharedConfigSubgroup ( const wxString & group )

overridevirtual

Implements ConfigClientInterface.

Definition at line 877 of file Effect.cpp.

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

 {
    return PluginManager::Get().RemoveSharedConfigSubgroup(GetID(), group);
 }

void Effect::ReplaceProcessedTracks ( const bool bGoodResult )

protected

Definition at line 2162 of file Effect.cpp.

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

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

 {
    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();
 
       mOutputTracksType = Track::None;
 
       //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 = std::move(*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(std::move(o));
       }
       else
       {
          // Replace mTracks entry with the NEW track
          WaveTrack *newTrack = static_cast<WaveTrack*>(o.get());
          mTracks->Replace(t, std::move(o));
 
          // Swap the wavecache track the ondemand task uses, since now the NEW
          // one will be kept in the project
          if (ODManager::IsInstanceCreated()) {
             ODManager::Instance()->ReplaceWaveTrack((WaveTrack *)t,
                                                     newTrack);
          }
       }
    }
 
    // 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();
    mOutputTracksType = Track::None;
 }

bool Effect::SaveUserPreset ( const wxString & name )

overridevirtual

Implements EffectClientInterface.

Definition at line 600 of file Effect.cpp.

References GetAutomationParameters(), mClient, EffectClientInterface::SaveUserPreset(), and SetPrivateConfig().

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

 {
    if (mClient)
    {
       return mClient->SaveUserPreset(name);
    }
 
    wxString parms;
    if (!GetAutomationParameters(parms))
    {
       return false;
    }
 
    return SetPrivateConfig(name, wxT("Parameters"), parms);
 }

bool Effect::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Implements EffectClientInterface.

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

Definition at line 574 of file Effect.cpp.

References mClient, and EffectClientInterface::SetAutomationParameters().

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

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

bool Effect::SetAutomationParameters ( const wxString & parms )

virtual

Definition at line 1025 of file Effect.cpp.

References _(), ShuttleSetAutomation::bOK, ParamsInterface::DefineParams(), GetCurrentSettingsGroup(), GetFactoryDefaultsGroup(), GetFactoryPresets(), IdentInterface::GetTranslatedName(), GetUserPresetsGroup(), kCurrentSettingsIdent, kFactoryDefaultsIdent, kFactoryPresetIdent, kUserPresetIdent, LoadFactoryPreset(), LoadUserPreset(), MessageBox(), mUIDialog, SetAutomationParameters(), ShuttleSetAutomation::SetForValidating(), ShuttleSetAutomation::SetForWriting(), and TransferDataToWindow().

 {
    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);
       wxArrayString presets = GetFactoryPresets();
       success = LoadFactoryPreset(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(
          wxString::Format(
             _("%s: Could not load settings below. Default settings will be used.\n\n%s"),
             GetTranslatedName(),
             preset
          )
       );
 
       return false;
    }
 
    if (!mUIDialog)
    {
       return true;
    }
 
    return TransferDataToWindow();
 }

void Effect::SetBatchProcessing ( bool start )

virtual

Definition at line 1142 of file Effect.cpp.

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

Referenced by EffectManager::SetBatchProcessing().

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

size_t Effect::SetBlockSize ( size_t maxBlockSize )

overridevirtual

Implements EffectClientInterface.

Definition at line 332 of file Effect.cpp.

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

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

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

void Effect::SetDuration ( double duration )

overridevirtual

Implements EffectHostInterface.

Definition at line 742 of file Effect.cpp.

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

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

 {
    if (seconds < 0.0)
    {
       seconds = 0.0;
    }
 
    if (GetType() == EffectTypeGenerate)
    {
       SetPrivateConfig(GetCurrentSettingsGroup(), wxT("LastUsedDuration"), seconds);
    }
 
    mDuration = seconds;
 
    mIsSelection = false;
 
    return;
 }

bool Effect::SetHost ( EffectHostInterface * host )

overridevirtual

Implements EffectClientInterface.

Definition at line 272 of file Effect.cpp.

References mClient, and EffectClientInterface::SetHost().

Referenced by Startup().

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

void Effect::SetHostUI ( EffectUIHostInterface * host )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 648 of file Effect.cpp.

649 {

650 }

void Effect::SetLinearEffectFlag ( bool linearEffectFlag )

protected

Definition at line 1961 of file Effect.cpp.

References mIsLinearEffect.

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

 {
    mIsLinearEffect = linearEffectFlag;
 }

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

inline

Definition at line 240 of file Effect.h.

Referenced by DoEffect().

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

void Effect::SetPreviewFullSelectionFlag ( bool previewDurationFlag )

protected

Definition at line 1966 of file Effect.cpp.

References mPreviewFullSelection.

Referenced by NyquistEffect::Parse().

 {
    mPreviewFullSelection = previewDurationFlag;
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 922 of file Effect.cpp.

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

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

 {
    return PluginManager::Get().SetPrivateConfig(GetID(), group, key, value);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 927 of file Effect.cpp.

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

 {
    return PluginManager::Get().SetPrivateConfig(GetID(), group, key, value);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 932 of file Effect.cpp.

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

 {
    return PluginManager::Get().SetPrivateConfig(GetID(), group, key, value);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 937 of file Effect.cpp.

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

 {
    return PluginManager::Get().SetPrivateConfig(GetID(), group, key, value);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 942 of file Effect.cpp.

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

 {
    return PluginManager::Get().SetPrivateConfig(GetID(), group, key, value);
 }

void Effect::SetSampleRate ( double rate )

overridevirtual

Implements EffectClientInterface.

Definition at line 322 of file Effect.cpp.

References mClient, mSampleRate, and EffectClientInterface::SetSampleRate().

Referenced by ProcessPass().

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

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 852 of file Effect.cpp.

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

 {
    return PluginManager::Get().SetSharedConfig(GetID(), group, key, value);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 857 of file Effect.cpp.

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

 {
    return PluginManager::Get().SetSharedConfig(GetID(), group, key, value);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 862 of file Effect.cpp.

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

 {
    return PluginManager::Get().SetSharedConfig(GetID(), group, key, value);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 867 of file Effect.cpp.

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

 {
    return PluginManager::Get().SetSharedConfig(GetID(), group, key, value);
 }

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

overridevirtual

Implements ConfigClientInterface.

Definition at line 872 of file Effect.cpp.

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

 {
    return PluginManager::Get().SetSharedConfig(GetID(), group, key, value);
 }

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

overridevirtual

Implements EffectClientInterface.

Reimplemented in NyquistEffect.

Definition at line 514 of file Effect.cpp.

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

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

 {
    if (!IsInteractive())
    {
       return true;
    }
 
    if (mUIDialog)
    {
       if ( mUIDialog->Close(true) )
          mUIDialog = nullptr;
       return false;
    }
 
    if (mClient)
    {
       return mClient->ShowInterface(parent, forceModal);
    }
 
    // mUIDialog is null
    auto cleanup = valueRestorer( mUIDialog );
    
    mUIDialog = CreateUI(parent, this);
    if (!mUIDialog)
    {
       return false;
    }
 
 
    mUIDialog->Layout();
    mUIDialog->Fit();
    mUIDialog->SetMinSize(mUIDialog->GetSize());
 
    if( ScreenshotCommand::MayCapture( mUIDialog ) )
       return false;
 
    if( SupportsRealtime() && !forceModal )
    {
       mUIDialog->Show();
       cleanup.release();
 
       // Return false to bypass effect processing
       return false;
    }
 
    bool res = mUIDialog->ShowModal() != 0;
 
    return res;
 }

void Effect::ShowOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 711 of file Effect.cpp.

712 {

713 }

bool Effect::Startup ( EffectClientInterface * client )

virtual

Definition at line 969 of file Effect.cpp.

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

 {
    // 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;
    GetPrivateConfig(GetFactoryDefaultsGroup(), wxT("Initialized"), haveDefaults, false);
    if (!haveDefaults)
    {
       SaveUserPreset(GetFactoryDefaultsGroup());
       SetPrivateConfig(GetFactoryDefaultsGroup(), wxT("Initialized"), true);
    }
    LoadUserPreset(GetCurrentSettingsGroup());
 
    return Startup();
 }

bool Effect::Startup ( )

virtual

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

Definition at line 997 of file Effect.cpp.

Referenced by Startup().

 {
    return true;
 }

bool Effect::SupportsAutomation ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 260 of file Effect.cpp.

References mClient, and EffectDefinitionInterface::SupportsAutomation().

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

bool Effect::SupportsRealtime ( )

overridevirtual

Implements EffectDefinitionInterface.

Reimplemented in EffectPhaser, and EffectWahwah.

Definition at line 250 of file Effect.cpp.

References mClient, and EffectDefinitionInterface::SupportsRealtime().

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

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

bool Effect::TotalProgress ( double frac )

protected

Definition at line 1977 of file Effect.cpp.

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

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

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

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

protected

Definition at line 1993 of file Effect.cpp.

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

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

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

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

protected

Definition at line 1985 of file Effect.cpp.

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

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

bool Effect::TransferDataFromWindow ( )

protectedvirtual

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

Definition at line 1881 of file Effect.cpp.

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

 {
    return true;
 }

bool Effect::TransferDataToWindow ( )

protectedvirtual

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

Definition at line 1876 of file Effect.cpp.

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

 {
    return true;
 }

bool Effect::ValidateUI ( )

overridevirtual

Implements EffectUIClientInterface.

Reimplemented in EffectEqualization.

Definition at line 672 of file Effect.cpp.

References mUIParent.

 {
    return mUIParent->Validate();
 }

Friends And Related Function Documentation

friend class EffectManager

friend

Definition at line 546 of file Effect.h.

friend class EffectPresetsDialog

friend

Definition at line 549 of file Effect.h.

friend class EffectRack

friend

Definition at line 547 of file Effect.h.

friend class EffectUIHost

friend

Definition at line 548 of file Effect.h.

Member Data Documentation

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

staticprivate

Definition at line 543 of file Effect.h.

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

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

staticprivate

Definition at line 544 of file Effect.h.

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

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

staticprivate

Definition at line 542 of file Effect.h.

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

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

staticprivate

Definition at line 541 of file Effect.h.

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

size_t Effect::mBlockSize

private

Definition at line 532 of file Effect.h.

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

size_t Effect::mBufferSize

private

Definition at line 531 of file Effect.h.

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

EffectClientInterface* Effect::mClient

private

Definition at line 527 of file Effect.h.

Referenced by Effect(), EffectUIHost::EffectUIHost(), GetAudioInCount(), GetAudioOutCount(), GetAutomationParameters(), GetDescription(), GetFactoryPresets(), GetFamilyId(), GetID(), 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(), SetSampleRate(), ShowInterface(), Startup(), SupportsAutomation(), and SupportsRealtime().

int Effect::mCurrentProcessor

private

Definition at line 536 of file Effect.h.

Referenced by RealtimeAddProcessor().

double Effect::mDuration

private

Definition at line 513 of file Effect.h.

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

NumericFormatId Effect::mDurationFormat

private

Definition at line 514 of file Effect.h.

Referenced by DoEffect(), and GetDurationFormat().

double Effect::mF0

protected

Definition at line 463 of file Effect.h.

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

double Effect::mF1

protected

Definition at line 464 of file Effect.h.

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

TrackFactory* Effect::mFactory

protected

Definition at line 457 of file Effect.h.

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

std::vector<int> Effect::mGroupProcessor

private

Definition at line 535 of file Effect.h.

Referenced by RealtimeAddProcessor(), and RealtimeProcess().

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

private

Definition at line 520 of file Effect.h.

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

bool Effect::mIsBatch

private

Definition at line 507 of file Effect.h.

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

bool Effect::mIsLinearEffect

private

Definition at line 508 of file Effect.h.

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

bool Effect::mIsPreview

private

Definition at line 516 of file Effect.h.

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

bool Effect::mIsSelection

private

Definition at line 512 of file Effect.h.

Referenced by SetDuration().

size_t Effect::mNumAudioIn

private

Definition at line 528 of file Effect.h.

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

size_t Effect::mNumAudioOut

private

Definition at line 529 of file Effect.h.

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

unsigned Effect::mNumChannels

private

Definition at line 533 of file Effect.h.

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

int Effect::mNumGroups

private

Definition at line 524 of file Effect.h.

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

int Effect::mNumTracks

private

Definition at line 523 of file Effect.h.

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

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

private

Definition at line 521 of file Effect.h.

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

std::shared_ptr<TrackList> Effect::mOutputTracks

protected

int Effect::mOutputTracksType

protected

Definition at line 478 of file Effect.h.

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

int Effect::mPass

protected

Definition at line 468 of file Effect.h.

Referenced by GetPass(), and Process().

wxArrayString Effect::mPresetNames

protected

Definition at line 466 of file Effect.h.

Referenced by NyquistEffect::Parse().

wxArrayString Effect::mPresetValues

protected

Definition at line 467 of file Effect.h.

bool Effect::mPreviewFullSelection

private

Definition at line 510 of file Effect.h.

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

bool Effect::mPreviewWithNotSelected

private

Definition at line 509 of file Effect.h.

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

ProgressDialog* Effect::mProgress

protected

Definition at line 452 of file Effect.h.

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

double Effect::mProjectRate

protected

Definition at line 453 of file Effect.h.

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

SelectedRegion* Effect::mpSelectedRegion {}

protected

Definition at line 456 of file Effect.h.

Referenced by Delegate(), and DoEffect().

int Effect::mRealtimeSuspendCount

private

Definition at line 539 of file Effect.h.

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

wxCriticalSection Effect::mRealtimeSuspendLock

private

Definition at line 538 of file Effect.h.

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

sampleCount Effect::mSampleCnt

protected

Definition at line 475 of file Effect.h.

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

double Effect::mSampleRate

protected

Definition at line 455 of file Effect.h.

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

double Effect::mT0

protected

Definition at line 460 of file Effect.h.

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

double Effect::mT1

protected

Definition at line 461 of file Effect.h.

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

TrackList* Effect::mTracks

private

Definition at line 505 of file Effect.h.

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

bool Effect::mUIDebug

private

Definition at line 518 of file Effect.h.

Referenced by Effect(), EnableDebug(), and EffectUIHost::Initialize().

wxDialog* Effect::mUIDialog

protected

Definition at line 471 of file Effect.h.

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

wxWindow* Effect::mUIParent

protected

Definition at line 472 of file Effect.h.

int Effect::mUIResultID

protected

Definition at line 473 of file Effect.h.

Referenced by EffectUIHost::DoCancel(), EffectUIHost::OnApply(), EffectUIHost::OnDebug(), and NyquistEffect::ShowInterface().

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation