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

#include <EffectBase.h>

Inheritance diagram for EffectBase:

Collaboration diagram for EffectBase:

Public Member Functions
	EffectBase ()

	~EffectBase () override

bool	IsLinearEffect () const

bool	PreviewsFullSelection () const

void	SetTracks (TrackList *pTracks)

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

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

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

void	ReplaceProcessedTracks (const bool bGoodResult)

void	CountWaveTracks ()

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

virtual	~EffectPlugin ()

virtual bool	HasOptions () const =0

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

virtual const EffectSettingsManager &	GetDefinition () const =0

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

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

virtual bool	IsBatchProcessing () const =0

virtual void	SetBatchProcessing ()=0

virtual void	UnsetBatchProcessing ()=0

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

Public Member Functions inherited from EffectInstanceFactory
virtual	~EffectInstanceFactory ()

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

Public Member Functions inherited from EffectSettingsManager
virtual	~EffectSettingsManager ()

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

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

virtual EffectSettings	MakeSettings () const

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

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

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

virtual RegistryPaths	GetFactoryPresets () const =0
	Report names of factory presets. More...

virtual OptionalMessage	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const =0

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

virtual OptionalMessage	LoadFactoryPreset (int id, EffectSettings &settings) const =0

virtual OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const =0

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

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

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

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

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

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

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

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

bool	SupportsRealtime () const

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

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

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

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

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

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Static Public Member Functions
static std::optional< InstancePointer >	FindInstance (EffectPlugin &plugin)

static InstanceFinder	DefaultInstanceFinder (EffectPlugin &plugin)

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

Public Attributes
TrackList *	mTracks {}

int	mNumTracks {}

BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

double	mT0 {}

double	mT1 {}

bool	mIsPreview { false }

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes
std::shared_ptr< TrackList >	mOutputTracks

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes
static int	nEffectsDone = 0

Private Member Functions
double	GetDefaultDuration ()

Private Attributes
bool	mIsLinearEffect { false }

bool	mPreviewFullSelection { false }

std::vector< Track * >	mIMap

std::vector< Track * >	mOMap

int	mNumGroups {}

Friends
class	Effect

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

using	InstancePointer = std::shared_ptr< EffectInstanceEx >

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

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

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

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

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

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

Detailed Description

Base class for many of the effects in Audacity.

Definition at line 26 of file EffectBase.h.

Constructor & Destructor Documentation

◆ EffectBase()

EffectBase::EffectBase ( )

Definition at line 34 of file EffectBase.cpp.

{
   // PRL:  I think this initialization of mProjectRate doesn't matter
   // because it is always reassigned in DoEffect before it is used
   // STF: but can't call AudioIOBase::GetOptimalSupportedSampleRate() here.
   // (Which is called to compute the default-default value.)  (Bug 2280)
   mProjectRate = QualitySettings::DefaultSampleRate.ReadWithDefault(44100);
}

References QualitySettings::DefaultSampleRate, mProjectRate, and Setting< T >::ReadWithDefault().

Here is the call graph for this function:

◆ ~EffectBase()

EffectBase::~EffectBase ( )

overridedefault

Member Function Documentation

◆ BeginPreview()

std::any EffectBase::BeginPreview ( const EffectSettings & settings )

virtual

Called when Preview() starts, to allow temporary effect state changes.

default returns a null

Returns: will undo its effects in its destructor before Preview() finishes

Reimplemented in EffectAmplify, and EffectTimeScale.

Definition at line 316 of file EffectBase.cpp.

{
   return {};
}

Referenced by EffectPreview().

Here is the caller graph for this function:

◆ CalcPreviewInputLength()

virtual double EffectBase::CalcPreviewInputLength	(	const EffectSettings &	settings,
		double	previewLength
	)		const

pure virtual

Implemented in Effect, EffectChangeSpeed, EffectPaulstretch, EffectTimeScale, and EffectTruncSilence.

Referenced by EffectPreview().

Here is the caller graph for this function:

◆ CheckWhetherSkipEffect()

virtual bool EffectBase::CheckWhetherSkipEffect ( const EffectSettings & settings ) const

protectedpure virtual

After Init(), tell whether Process() should be skipped.

Implemented in Effect, EffectBassTreble, EffectChangeSpeed, EffectClickRemoval, EffectNoiseRemoval, and EffectNormalize.

Referenced by DoEffect().

Here is the caller graph for this function:

◆ CountWaveTracks()

void EffectBase::CountWaveTracks ( )

Definition at line 310 of file EffectBase.cpp.

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

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

Referenced by DoEffect(), and EffectPreview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DefaultInstanceFinder()

auto EffectBase::DefaultInstanceFinder ( EffectPlugin & plugin )

static

Definition at line 331 of file EffectBase.cpp.

{
   return [&plugin](auto&) { return FindInstance(plugin); };
}

Referenced by Effect::Delegate().

Here is the caller graph for this function:

◆ DoEffect()

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

overridevirtual

Will only operate on tracks that have the "selected" flag set to true, which is consistent with Audacity's standard UI, and only when finder succeeds

Returns: true on success

Parameters

settings	Always given; only for processing
pAccess	Sometimes given; only for UI

Implements EffectPlugin.

Definition at line 54 of file EffectBase.cpp.

{
   auto cleanup0 = valueRestorer(mUIFlags, flags);
   wxASSERT(selectedRegion.duration() >= 0.0);
 
   mOutputTracks.reset();
 
   mFactory = factory;
   mProjectRate = projectRate;
 
   SetTracks(list);
   // Don't hold a dangling pointer when done
   Finally Do([&]{ SetTracks(nullptr); });
 
   // This is for performance purposes only, no additional recovery implied
   auto &pProject = *const_cast<AudacityProject*>(FindProject()); // how to remove this const_cast?
   TransactionScope trans(pProject, "Effect");
 
   // Update track/group counts
   CountWaveTracks();
 
   bool isSelection = false;
 
   auto duration = 0.0;
   if (GetType() == EffectTypeGenerate)
      GetConfig(GetDefinition(), PluginSettings::Private,
         CurrentSettingsGroup(),
         EffectSettingsExtra::DurationKey(), duration, GetDefaultDuration());
 
   WaveTrack *newTrack{};
   bool success = false;
   auto oldDuration = duration;
 
   auto cleanup = finally( [&] {
      if (!success) {
         if (newTrack) {
            mTracks->Remove(newTrack);
         }
         // On failure, restore the old duration setting
         settings.extra.SetDuration(oldDuration);
      }
      else
         trans.Commit();
 
      ReplaceProcessedTracks( false );
      mPresetNames.clear();
   } );
 
   // We don't yet know the effect type for code in the Nyquist Prompt, so
   // assume it requires a track and handle errors when the effect runs.
   if ((GetType() == EffectTypeGenerate || GetPath() == NYQUIST_PROMPT_ID) && (mNumTracks == 0)) {
      auto track = mFactory->Create();
      track->SetName(mTracks->MakeUniqueTrackName(WaveTrack::GetDefaultAudioTrackNamePreference()));
      newTrack = mTracks->Add(track);
      newTrack->SetSelected(true);
   }
 
   mT0 = selectedRegion.t0();
   mT1 = selectedRegion.t1();
   if (mT1 > mT0)
   {
      // there is a selection: let's fit in there...
      // MJS: note that this is just for the TTC and is independent of the track rate
      // but we do need to make sure we have the right number of samples at the project rate
      double quantMT0 = QUANTIZED_TIME(mT0, mProjectRate);
      double quantMT1 = QUANTIZED_TIME(mT1, mProjectRate);
      duration = quantMT1 - quantMT0;
      isSelection = true;
      mT1 = mT0 + duration;
   }
 
   // This is happening inside EffectSettingsAccess::ModifySettings
   auto newFormat = isSelection
      ? NumericConverterFormats::TimeAndSampleFormat()
      : NumericConverterFormats::DefaultSelectionFormat();
   auto updater = [&](EffectSettings &settings) {
      settings.extra.SetDuration(duration);
      settings.extra.SetDurationFormat( newFormat );
      return nullptr;
   };
   // Update our copy of settings; update the EffectSettingsAccess too,
   // if we are going to show a dialog
   updater(settings);
   if (pAccess)
      pAccess->ModifySettings(updater);
 
#ifdef EXPERIMENTAL_SPECTRAL_EDITING
   mF0 = selectedRegion.f0();
   mF1 = selectedRegion.f1();
   if( mF0 != SelectedRegion::UndefinedFrequency )
      mPresetNames.push_back(L"control-f0");
   if( mF1 != SelectedRegion::UndefinedFrequency )
      mPresetNames.push_back(L"control-f1");
 
#endif
   CountWaveTracks();
 
   // Allow the dialog factory to fill this in, but it might not
   std::shared_ptr<EffectInstance> pInstance;
 
   if (IsInteractive()) {
      if (!finder)
         return false;
      else if (auto result = finder(settings))
         pInstance = *result;
      else
         return false;
   }
 
   auto pInstanceEx = std::dynamic_pointer_cast<EffectInstanceEx>(pInstance);
   if (!pInstanceEx) {
      // Path that skipped the dialog factory -- effect may be non-interactive
      // or this is batch mode processing or repeat of last effect with stored
      // settings.
      pInstanceEx = std::dynamic_pointer_cast<EffectInstanceEx>(MakeInstance());
      // Note: Init may read parameters from preferences
      if (!pInstanceEx || !pInstanceEx->Init())
         return false;
   }
 
 
   // If the dialog was shown, then it has been closed without errors or
   // cancellation, and any change of duration has been saved in the config file
 
   bool returnVal = true;
   bool skipFlag = CheckWhetherSkipEffect(settings);
   if (skipFlag == false)
   {
      using namespace BasicUI;
      auto name = GetName();
      auto progress = MakeProgress(
         name,
         XO("Applying %s...").Format( name ),
         ProgressShowCancel
      );
      auto vr = valueRestorer( mProgress, progress.get() );
 
      assert(pInstanceEx); // null check above
      returnVal = pInstanceEx->Process(settings);
   }
 
   if (returnVal && (mT1 >= mT0 ))
   {
      selectedRegion.setTimes(mT0, mT1);
   }
 
   success = returnVal;
   return returnVal;
}

References TrackList::Add(), CheckWhetherSkipEffect(), TransactionScope::Commit(), CountWaveTracks(), WaveTrackFactory::Create(), CurrentSettingsGroup(), NumericConverterFormats::DefaultSelectionFormat(), NotifyingSelectedRegion::duration(), EffectSettingsExtra::DurationKey(), EffectTypeGenerate, NotifyingSelectedRegion::f0(), NotifyingSelectedRegion::f1(), cloud::factory, FindProject(), PluginSettings::GetConfig(), WaveTrack::GetDefaultAudioTrackNamePreference(), GetDefaultDuration(), EffectPlugin::GetDefinition(), ComponentInterface::GetName(), ComponentInterface::GetPath(), EffectDefinitionInterface::GetType(), EffectDefinitionInterface::IsInteractive(), EffectInstanceFactory::MakeInstance(), BasicUI::MakeProgress(), TrackList::MakeUniqueTrackName(), mFactory, mNumTracks, mOutputTracks, mPresetNames, mProgress, mProjectRate, mT0, mT1, mTracks, mUIFlags, name, NYQUIST_PROMPT_ID, PluginSettings::Private, BasicUI::ProgressShowCancel, QUANTIZED_TIME, TrackList::Remove(), ReplaceProcessedTracks(), NotifyingSelectedRegion::setTimes(), settings(), SetTracks(), NotifyingSelectedRegion::t0(), NotifyingSelectedRegion::t1(), NumericConverterFormats::TimeAndSampleFormat(), SelectedRegion::UndefinedFrequency, updater, valueRestorer(), and XO().

Referenced by Effect::Delegate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindInstance()

auto EffectBase::FindInstance ( EffectPlugin & plugin )

static

Definition at line 321 of file EffectBase.cpp.

{
   auto result = plugin.MakeInstance();
   if (auto pInstanceEx = std::dynamic_pointer_cast<EffectInstanceEx>(result)
      ; pInstanceEx && pInstanceEx->Init())
      return { pInstanceEx };
   return {};
}

Referenced by EffectUIHost::InitializeInstance().

Here is the caller graph for this function:

◆ FindProject()

const AudacityProject * EffectBase::FindProject ( ) const

protected

Definition at line 303 of file EffectBase.cpp.

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

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

Referenced by Effect::CopyInputTracks(), DoEffect(), Effect::GetSelectionFormat(), EffectEqualization::Init(), NyquistEffect::Init(), Generator::Process(), NyquistEffect::Process(), EffectTwoPassSimpleMono::Process(), EffectTruncSilence::ProcessIndependently(), and PerTrackEffect::ProcessPass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDefaultDuration()

double EffectBase::GetDefaultDuration ( )

private

Definition at line 45 of file EffectBase.cpp.

{
   return 30.0;
}

Referenced by DoEffect().

Here is the caller graph for this function:

◆ inputTracks()

const TrackList * EffectBase::inputTracks ( ) const

inlineprotected

Definition at line 94 of file EffectBase.h.

94{ return mTracks; }

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

Here is the caller graph for this function:

◆ IsLinearEffect()

bool EffectBase::IsLinearEffect ( ) const

inline

Definition at line 33 of file EffectBase.h.

33{ return mIsLinearEffect; }

EffectBase::mIsLinearEffect

bool mIsLinearEffect

Definition: EffectBase.h:132

Referenced by EffectPreview().

Here is the caller graph for this function:

◆ IsPreviewing()

bool EffectBase::IsPreviewing ( ) const

inlineprotected

Definition at line 89 of file EffectBase.h.

89{ return mIsPreview; }

EffectBase::mIsPreview

bool mIsPreview

Definition: EffectBase.h:120

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

Here is the caller graph for this function:

◆ PreviewsFullSelection()

bool EffectBase::PreviewsFullSelection ( ) const

inline

Definition at line 34 of file EffectBase.h.

34{ return mPreviewFullSelection; }

EffectBase::mPreviewFullSelection

bool mPreviewFullSelection

Definition: EffectBase.h:133

Referenced by EffectPreview().

Here is the caller graph for this function:

◆ ReplaceProcessedTracks()

void EffectBase::ReplaceProcessedTracks ( const bool bGoodResult )

Definition at line 224 of file EffectBase.cpp.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLinearEffectFlag()

void EffectBase::SetLinearEffectFlag ( bool linearEffectFlag )

protected

Definition at line 211 of file EffectBase.cpp.

{
   mIsLinearEffect = linearEffectFlag;
}

References mIsLinearEffect.

Referenced by EffectBassTreble::EffectBassTreble(), EffectDistortion::EffectDistortion(), EffectEcho::EffectEcho(), EffectEqualization::EffectEqualization(), EffectLoudness::EffectLoudness(), EffectNoise::EffectNoise(), EffectPhaser::EffectPhaser(), EffectReverb::EffectReverb(), EffectSilence::EffectSilence(), EffectWahwah::EffectWahwah(), and NyquistEffect::Parse().

Here is the caller graph for this function:

◆ SetPreviewFullSelectionFlag()

void EffectBase::SetPreviewFullSelectionFlag ( bool previewDurationFlag )

protected

Definition at line 216 of file EffectBase.cpp.

{
   mPreviewFullSelection = previewDurationFlag;
}

References mPreviewFullSelection.

Referenced by NyquistEffect::Parse().

Here is the caller graph for this function:

◆ SetTracks()

void EffectBase::SetTracks ( TrackList * pTracks )

inline

Definition at line 36 of file EffectBase.h.

36{ mTracks = pTracks; }

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

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ Effect

friend class Effect

friend

Definition at line 106 of file EffectBase.h.

Member Data Documentation

◆ mFactory

WaveTrackFactory* EffectBase::mFactory {}

Definition at line 117 of file EffectBase.h.

Referenced by Effect::Delegate(), DoEffect(), and EffectPreview().

◆ mIMap

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

private

Definition at line 135 of file EffectBase.h.

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

◆ mIsLinearEffect

bool EffectBase::mIsLinearEffect { false }

private

Definition at line 132 of file EffectBase.h.

Referenced by SetLinearEffectFlag().

◆ mIsPreview

bool EffectBase::mIsPreview { false }

Definition at line 120 of file EffectBase.h.

Referenced by EffectPreview().

◆ mNumGroups

int EffectBase::mNumGroups {}

private

Definition at line 138 of file EffectBase.h.

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

◆ mNumTracks

int EffectBase::mNumTracks {}

Definition at line 113 of file EffectBase.h.

Referenced by CountWaveTracks(), DoEffect(), EffectPreview(), Effect::GetNumWaveTracks(), and Effect::TrackProgress().

◆ mOMap

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

private

Definition at line 136 of file EffectBase.h.

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

◆ mOutputTracks

std::shared_ptr<TrackList> EffectBase::mOutputTracks

protected

Definition at line 97 of file EffectBase.h.

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

◆ mPresetNames

wxArrayString EffectBase::mPresetNames

protected

Definition at line 102 of file EffectBase.h.

Referenced by DoEffect(), and NyquistEffect::Parse().

◆ mPreviewFullSelection

bool EffectBase::mPreviewFullSelection { false }

private

Definition at line 133 of file EffectBase.h.

Referenced by SetPreviewFullSelectionFlag().

◆ mProgress

BasicUI::ProgressDialog* EffectBase::mProgress {}

Definition at line 114 of file EffectBase.h.

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

◆ mProjectRate

double EffectBase::mProjectRate {}

◆ mT0

double EffectBase::mT0 {}

Definition at line 118 of file EffectBase.h.

Referenced by EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), EffectTruncSilence::CalcPreviewInputLength(), Effect::Delegate(), EffectRepeat::DisplayNewTime(), DoEffect(), EffectPreview(), EffectTruncSilence::FindSilences(), Effect::GetBounds(), EffectAmplify::Init(), EffectChangeSpeed::Init(), EffectDtmf::MakeInstance(), EffectAutoDuck::Process(), EffectChangeSpeed::Process(), EffectClickRemoval::Process(), EffectEqualization::Process(), EffectFindClipping::Process(), Generator::Process(), EffectLoudness::Process(), EffectNoiseReduction::Process(), EffectNoiseRemoval::Process(), EffectNormalize::Process(), NyquistEffect::Process(), EffectPaulstretch::Process(), EffectRepair::Process(), EffectRepeat::Process(), EffectReverse::Process(), EffectSBSMS::Process(), EffectSimpleMono::Process(), EffectTimeScale::Process(), EffectTwoPassSimpleMono::Process(), EffectChangeSpeed::ProcessLabelTrack(), EffectSBSMS::ProcessLabelTrack(), NyquistEffect::ProcessOne(), EffectPaulstretch::ProcessOne(), EffectTwoPassSimpleMono::ProcessPass(), and PerTrackEffect::ProcessPass().

◆ mT1

double EffectBase::mT1 {}

Definition at line 119 of file EffectBase.h.

Referenced by EffectTruncSilence::Analyze(), EffectAutoDuck::ApplyDuckFade(), EffectTruncSilence::CalcPreviewInputLength(), Effect::Delegate(), EffectRepeat::DisplayNewTime(), DoEffect(), EffectPreview(), EffectTruncSilence::FindSilences(), Effect::GetBounds(), EffectAmplify::Init(), EffectChangeSpeed::Init(), EffectAutoDuck::Process(), EffectChangeSpeed::Process(), EffectClickRemoval::Process(), EffectEqualization::Process(), EffectFindClipping::Process(), Generator::Process(), EffectLoudness::Process(), EffectNoiseReduction::Process(), EffectNoiseRemoval::Process(), EffectNormalize::Process(), NyquistEffect::Process(), EffectPaulstretch::Process(), EffectRepair::Process(), EffectRepeat::Process(), EffectReverse::Process(), EffectSBSMS::Process(), EffectSimpleMono::Process(), EffectTimeScale::Process(), EffectTruncSilence::ProcessAll(), EffectTruncSilence::ProcessIndependently(), EffectChangeSpeed::ProcessLabelTrack(), EffectSBSMS::ProcessLabelTrack(), NyquistEffect::ProcessOne(), EffectTwoPassSimpleMono::ProcessPass(), and PerTrackEffect::ProcessPass().

◆ mTracks

TrackList* EffectBase::mTracks {}

Definition at line 112 of file EffectBase.h.

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

◆ mUIFlags

unsigned EffectBase::mUIFlags { 0 }

protected

Definition at line 103 of file EffectBase.h.

Referenced by Effect::Delegate(), DoEffect(), and Effect::TestUIFlags().

◆ nEffectsDone

int EffectBase::nEffectsDone = 0

staticprotected

Definition at line 92 of file EffectBase.h.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectBase()

◆ ~EffectBase()

Member Function Documentation

◆ BeginPreview()

◆ CalcPreviewInputLength()

◆ CheckWhetherSkipEffect()

◆ CountWaveTracks()

◆ DefaultInstanceFinder()

◆ DoEffect()

◆ FindInstance()

◆ FindProject()

◆ GetDefaultDuration()

◆ inputTracks()

◆ IsLinearEffect()

◆ IsPreviewing()

◆ PreviewsFullSelection()

◆ ReplaceProcessedTracks()

◆ SetLinearEffectFlag()

◆ SetPreviewFullSelectionFlag()

◆ SetTracks()

Friends And Related Function Documentation

◆ Effect

Member Data Documentation

◆ mFactory

◆ mIMap

◆ mIsLinearEffect

◆ mIsPreview

◆ mNumGroups

◆ mNumTracks

◆ mOMap

◆ mOutputTracks

◆ mPresetNames

◆ mPreviewFullSelection

◆ mProgress

◆ mProjectRate

◆ mT0

◆ mT1

◆ mTracks

◆ mUIFlags

◆ nEffectsDone