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

#include <PerTrackEffect.h>

Inheritance diagram for PerTrackEffect:

Collaboration diagram for PerTrackEffect:

Classes
class	Instance

Public Member Functions
	~PerTrackEffect () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () const override

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

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

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

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

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

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

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

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

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

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

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

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

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

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

OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const override

virtual const EffectParameterMethods &	Parameters () const

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

bool	HasOptions () const override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatID	GetSelectionFormat ()

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

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

bool	IsBatchProcessing () const override

void	SetBatchProcessing () override

void	UnsetBatchProcessing () override

unsigned	TestUIFlags (unsigned mask)

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

Public Member Functions inherited from EffectBase
	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	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 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

Protected Member Functions
bool	DoPass1 () const

bool	DoPass2 () const

bool	Process (EffectInstance &instance, EffectSettings &settings) const

std::shared_ptr< EffectOutputTracks >	MakeOutputTracks ()

void	DestroyOutputTracks () const

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

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

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

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

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

int	GetNumWaveTracks () const

int	GetNumWaveGroups () const

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

Protected Member Functions inherited from EffectBase
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
sampleCount	mSampleCnt {}

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Private Types
using	Buffers = AudioGraph::Buffers

using	Factory = std::function< std::shared_ptr< EffectInstance >()>

Private Member Functions
bool	ProcessPass (TrackList &outputs, Instance &instance, EffectSettings &settings)

Static Private Member Functions
static bool	ProcessTrack (int channel, const Factory &factory, EffectSettings &settings, AudioGraph::Source &source, AudioGraph::Sink &sink, std::optional< sampleCount > genLength, double sampleRate, const SampleTrack &wt, Buffers &inBuffers, Buffers &outBuffers)

Private Attributes
std::shared_ptr< EffectOutputTracks >	mpOutputTracks

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 Member Functions inherited from Effect
static Effect *	FetchParameters (Effect &e, EffectSettings &)

Static Public Member Functions inherited from EffectBase
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 inherited from EffectBase
std::shared_ptr< TrackList >	mTracks {}

int	mNumTracks {}

BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

double	mT0 {}

double	mT1 {}

bool	mIsPreview { false }

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.

Base class for Effects that treat each (mono or stereo) track independently of other tracks.

Its override of Effect::Process() uses ProcessInitialize(), ProcessBlock(), and ProcessFinalize() methods of its instance made by MakeInstance(), which must be a subclass of PerTrackEffect::Instance. Also uses GetLatency() to determine how many leading output samples to discard and how many extra samples to produce.

Definition at line 37 of file PerTrackEffect.h.

Member Typedef Documentation

◆ Buffers

using PerTrackEffect::Buffers = AudioGraph::Buffers

private

Definition at line 78 of file PerTrackEffect.h.

◆ Factory

using PerTrackEffect::Factory = std::function<std::shared_ptr<EffectInstance>()>

private

Definition at line 82 of file PerTrackEffect.h.

Constructor & Destructor Documentation

◆ ~PerTrackEffect()

PerTrackEffect::~PerTrackEffect ( )

overridedefault

Member Function Documentation

◆ DestroyOutputTracks()

void PerTrackEffect::DestroyOutputTracks ( ) const

protected

Definition at line 387 of file PerTrackEffect.cpp.

{
   mpOutputTracks.reset();
}

References mpOutputTracks.

Referenced by Process().

Here is the caller graph for this function:

◆ DoPass1()

bool PerTrackEffect::DoPass1 ( ) const

protected

Definition at line 54 of file PerTrackEffect.cpp.

{
   return true;
}

Referenced by Process().

Here is the caller graph for this function:

◆ DoPass2()

bool PerTrackEffect::DoPass2 ( ) const

protected

Definition at line 59 of file PerTrackEffect.cpp.

{
   return false;
}

Referenced by Process().

Here is the caller graph for this function:

◆ MakeOutputTracks()

std::shared_ptr< EffectOutputTracks > PerTrackEffect::MakeOutputTracks ( )

protected

Definition at line 380 of file PerTrackEffect.cpp.

{
   return mpOutputTracks =
      std::make_shared<EffectOutputTracks>(*mTracks, GetType(),
         EffectOutputTracks::TimeInterval{ mT0, mT1 }, true);
}

References EffectDefinitionInterface::GetType(), mpOutputTracks, EffectBase::mT0, EffectBase::mT1, and EffectBase::mTracks.

Referenced by EffectAmplify::Init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Process()

bool PerTrackEffect::Process	(	EffectInstance &	instance,
		EffectSettings &	settings
	)		const

protected

Definition at line 64 of file PerTrackEffect.cpp.

{
   auto pThis = const_cast<PerTrackEffect *>(this);
 
   // Destroy any pre-formed output tracks when done
   auto pOutputs = mpOutputTracks.get();
 
   std::optional<EffectOutputTracks> outputs;
   if (!pOutputs)
      pOutputs = &outputs.emplace(*mTracks, GetType(),
         EffectOutputTracks::TimeInterval{ mT0, mT1 }, true);
 
   bool bGoodResult = true;
   // mPass = 1;
   if (DoPass1()) {
      auto &myInstance = dynamic_cast<Instance&>(instance);
      bGoodResult = pThis->ProcessPass(pOutputs->Get(), myInstance, settings);
      // mPass = 2;
      if (bGoodResult && DoPass2())
         bGoodResult = pThis->ProcessPass(pOutputs->Get(), myInstance, settings);
   }
   if (bGoodResult)
      pOutputs->Commit();
   DestroyOutputTracks();
   return bGoodResult;
}

References DestroyOutputTracks(), DoPass1(), DoPass2(), EffectDefinitionInterface::GetType(), mpOutputTracks, EffectBase::mT0, EffectBase::mT1, EffectBase::mTracks, and settings().

Referenced by StatefulPerTrackEffect::Process(), and PerTrackEffect::Instance::Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessPass()

bool PerTrackEffect::ProcessPass	(	TrackList &	outputs,
		Instance &	instance,
		EffectSettings &	settings
	)

private

Definition at line 92 of file PerTrackEffect.cpp.

{
   const auto duration = settings.extra.GetDuration();
   bool bGoodResult = true;
   bool isGenerator = GetType() == EffectTypeGenerate;
   bool isProcessor = GetType() == EffectTypeProcess;
 
   Buffers inBuffers, outBuffers;
   ChannelName map[3];
   size_t prevBufferSize = 0;
   int count = 0;
   bool clear = false;
 
   // 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).
   const auto numAudioIn = instance.GetAudioInCount();
   const auto numAudioOut = instance.GetAudioOutCount();
   if (numAudioOut < 1)
      return false;
 
   // Instances that can be reused in each loop pass
   std::vector<std::shared_ptr<EffectInstance>> recycledInstances{
      // First one is the given one; any others pushed onto here are
      // discarded when we exit
      std::dynamic_pointer_cast<EffectInstanceEx>(instance.shared_from_this())
   };
 
   const bool multichannel = numAudioIn > 1;
   int iChannel = 0;
   TrackListHolder results;
   const auto waveTrackVisitor =
      [&](WaveTrack &wt, WaveChannel &chan, bool isFirst) {
         if (isFirst)
            iChannel = 0;
 
         sampleCount len = 0;
         sampleCount start = 0;
         WaveChannel *pRight{};
 
         const int channel = (multichannel ? -1 : iChannel++);
         const auto numChannels = MakeChannelMap(wt, channel, map);
         if (multichannel) {
            assert(numAudioIn > 1);
            if (numChannels == 2) {
               // TODO: more-than-two-channels
               pRight = (*wt.Channels().rbegin()).get();
               clear = false;
            }
         }
 
         if (!isGenerator) {
            GetBounds(wt, &start, &len);
            mSampleCnt = len;
            if (len > 0 && numAudioIn < 1) {
               bGoodResult = false;
               return;
            }
         }
         else
            mSampleCnt = wt.TimeToLongSamples(duration);
 
         const auto sampleRate = wt.GetRate();
 
         // Get the block size the client wants to use
         auto max = wt.GetMaxBlockSize() * 2;
         const auto blockSize = instance.SetBlockSize(max);
         if (blockSize == 0) {
            bGoodResult = false;
            return;
         }
 
         // Calculate the buffer size to be at least the max rounded up to the clients
         // selected block size.
         const auto bufferSize =
            ((max + (blockSize - 1)) / blockSize) * blockSize;
         if (bufferSize == 0) {
            bGoodResult = false;
            return;
         }
 
         // Always create the number of input buffers the client expects even
         // if we don't have
         // the same number of channels.
         // (These resizes may do nothing after the first track)
 
         if (len > 0)
            assert(numAudioIn > 0); // checked above
         inBuffers.Reinit(
            // TODO fix this hack for making Generator progress work without
            // assertion violations.  Make a dummy Source class that doesn't
            // care about the buffers.
            std::max(1u, numAudioIn),
            blockSize,
            std::max<size_t>(1, bufferSize / blockSize));
         if (len > 0)
            // post of Reinit later satisfies pre of Source::Acquire()
            assert(inBuffers.Channels() > 0);
 
         if (prevBufferSize != bufferSize) {
            // Buffer size has changed
            // We won't be using more than the first 2 buffers,
            // so clear the rest (if any)
            for (size_t i = 2; i < numAudioIn; i++)
               inBuffers.ClearBuffer(i, bufferSize);
         }
         prevBufferSize = bufferSize;
 
         // Always create the number of output buffers the client expects
         // even if we don't have the same number of channels.
         // (These resizes may do nothing after the first track)
         // Output buffers get an extra blockSize worth to give extra room if
         // the plugin adds latency -- PRL:  actually not important to do
         assert(numAudioOut > 0); // checked above
         outBuffers.Reinit(numAudioOut, blockSize,
            (bufferSize / blockSize) + 1);
         // post of Reinit satisfies pre of ProcessTrack
         assert(outBuffers.Channels() > 0);
 
         // (Re)Set the input buffer positions
         inBuffers.Rewind();
 
         // Clear unused input buffers
         if (!pRight && !clear && numAudioIn > 1) {
            inBuffers.ClearBuffer(1, bufferSize);
            clear = true;
         }
 
         const auto genLength = [this, &settings, &wt, isGenerator](
         ) -> std::optional<sampleCount> {
            double genDur = 0;
            if (isGenerator) {
               const auto duration = settings.extra.GetDuration();
               if (IsPreviewing()) {
                  gPrefs->Read(wxT("/AudioIO/EffectsPreviewLen"), &genDur, 6.0);
                  genDur = std::min(duration, CalcPreviewInputLength(settings, genDur));
               }
               else
                  genDur = duration;
               // round to nearest sample
               return sampleCount{ (wt.GetRate() * genDur) + 0.5 };
            }
            else
               return {};
         }();
 
         const auto pollUser = [this, numChannels, count, start,
            length = (genLength ? *genLength : len).as_double()
         ](sampleCount inPos){
            if (numChannels > 1) {
               if (TrackGroupProgress(
                  count, (inPos - start).as_double() / length)
               )
                  return false;
            }
            else {
               if (TrackProgress(count, (inPos - start).as_double() / length))
                  return false;
            }
            return true;
         };
 
         // Assured above
         assert(len == 0 || inBuffers.Channels() > 0);
         // TODO fix this hack to make the time remaining of the generator
         // progress dialog correct
         if (len == 0 && genLength)
            len = *genLength;
         WideSampleSource source{
            chan, size_t(pRight ? 2 : 1), start, len, pollUser };
         // Assert source is safe to Acquire inBuffers
         assert(source.AcceptsBuffers(inBuffers));
         assert(source.AcceptsBlockSize(inBuffers.BlockSize()));
 
         // Make "wide" or "narrow" copy of the track if generating
         // Old generator code may still proceed "interval-major" and later
         // join mono into stereo
         auto wideTrack =
            (pRight && isGenerator) ? wt.EmptyCopy() : nullptr;
         auto narrowTrack =
            (!pRight && isGenerator) ? wt.EmptyCopy(1) : nullptr;
         const auto pGenerated = wideTrack
            ? wideTrack
            : narrowTrack;
 
         WaveTrackSink sink{ chan, pRight, pGenerated.get(), start, isProcessor,
            instance.NeedsDither() ? widestSampleFormat : narrowestSampleFormat
         };
         assert(sink.AcceptsBuffers(outBuffers));
 
         // Go process the track(s)
         const auto factory =
         [this, &recycledInstances, counter = 0]() mutable {
            auto index = counter++;
            if (index < recycledInstances.size())
               return recycledInstances[index];
            else
               return recycledInstances.emplace_back(MakeInstance());
         };
         bGoodResult = ProcessTrack(channel, factory, settings, source, sink,
            genLength, sampleRate, wt, inBuffers, outBuffers);
         if (bGoodResult) {
            sink.Flush(outBuffers);
            bGoodResult = sink.IsOk();
            if (bGoodResult && pGenerated) {
               if (!results)
                  results = TrackList::Temporary(nullptr, pGenerated);
               else {
                  results->Add(pGenerated);
                  if (!multichannel && !isFirst && narrowTrack) {
                     // Generated a stereo track, in channel-major fashion.
                     // Get the last track but one -- generated in the previous
                     // pass
                     const auto pLast =
                        static_cast<WaveTrack*>(*std::next(results->rbegin()));
                     pLast->ZipClips();
                  }
               }
            }
         }
         if (!bGoodResult)
            return;
         ++count;
      };
   const auto defaultTrackVisitor =
      [&](Track &t) {
         if (SyncLock::IsSyncLockSelected(t))
            t.SyncLockAdjust(mT1, mT0 + duration);
      };
 
   outputs.Any().VisitWhile(bGoodResult,
      [&](auto &&fallthrough){ return [&](WaveTrack &wt) {
         if (!wt.GetSelected())
            return fallthrough();
         const auto channels = wt.Channels();
         if (multichannel)
            waveTrackVisitor(wt, **channels.begin(), true);
         else {
            bool first = true;
            for (const auto pChannel : channels) {
               waveTrackVisitor(wt, *pChannel, first);
               first = false;
            }
         }
         if (results) {
            const auto t1 = ViewInfo::Get(*FindProject()).selectedRegion.t1();
            PasteTimeWarper warper { t1,
                                     mT0 + (*results->begin())->GetEndTime() };
            wt.ClearAndPaste(mT0, t1,
               static_cast<WaveTrack&>(*results->DetachFirst()),
               true, true, &warper);
            results.reset();
         }
      }; },
      defaultTrackVisitor
   );
 
   if (bGoodResult && GetType() == EffectTypeGenerate)
      mT1 = mT0 + duration;
 
   return bGoodResult;
}

References TrackList::Any(), AudioGraph::Buffers::BlockSize(), Effect::CalcPreviewInputLength(), WaveTrack::Channels(), AudioGraph::Buffers::Channels(), WaveTrack::ClearAndPaste(), AudioGraph::Buffers::ClearBuffer(), EffectTypeGenerate, EffectTypeProcess, factory, EffectBase::FindProject(), ViewInfo::Get(), EffectInstance::GetAudioInCount(), EffectInstance::GetAudioOutCount(), Effect::GetBounds(), WaveTrack::GetMaxBlockSize(), WaveTrack::GetRate(), Track::GetSelected(), EffectDefinitionInterface::GetType(), gPrefs, anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, EffectBase::IsPreviewing(), SyncLock::IsSyncLockSelected(), MakeChannelMap(), EffectInstanceFactory::MakeInstance(), min(), mSampleCnt, EffectBase::mT0, EffectBase::mT1, narrowestSampleFormat, EffectInstance::NeedsDither(), ProcessTrack(), audacity::BasicSettings::Read(), AudioGraph::Buffers::Reinit(), AudioGraph::Buffers::Rewind(), anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, ViewInfo::selectedRegion, EffectInstance::SetBlockSize(), settings(), NotifyingSelectedRegion::t1(), TrackList::Temporary(), WideSampleSequence::TimeToLongSamples(), Effect::TrackGroupProgress(), Effect::TrackProgress(), widestSampleFormat, wxT(), and WaveTrack::ZipClips().

Here is the call graph for this function:

◆ ProcessTrack()

bool PerTrackEffect::ProcessTrack	(	int	channel,
		const Factory &	factory,
		EffectSettings &	settings,
		AudioGraph::Source &	source,
		AudioGraph::Sink &	sink,
		std::optional< sampleCount >	genLength,
		double	sampleRate,
		const SampleTrack &	wt,
		Buffers &	inBuffers,
		Buffers &	outBuffers
	)

staticprivate

Previous contents of inBuffers and outBuffers are ignored

Parameters

channel selects one channel if non-negative; else all channels

Precondition: source.AcceptsBuffers(inBuffers); source.AcceptsBlockSize(inBuffers.BlockSize()); sink.AcceptsBuffers(outBuffers); inBuffers.BlockSize() == outBuffers.BlockSize(); channel < track.NChannels()

Definition at line 355 of file PerTrackEffect.cpp.

{
   assert(upstream.AcceptsBuffers(inBuffers));
   assert(sink.AcceptsBuffers(outBuffers));
 
   const auto blockSize = inBuffers.BlockSize();
   assert(upstream.AcceptsBlockSize(blockSize));
   assert(blockSize == outBuffers.BlockSize());
 
   auto pSource = EffectStage::Create(channel, upstream, inBuffers,
      factory, settings, sampleRate, genLength, wt);
   if (!pSource)
      return false;
   assert(pSource->AcceptsBlockSize(blockSize)); // post of ctor
   assert(pSource->AcceptsBuffers(outBuffers));
 
   AudioGraph::Task task{ *pSource, outBuffers, sink };
   return task.RunLoop();
}

References AudioGraph::Source::AcceptsBlockSize(), AudioGraph::Sink::AcceptsBuffers(), AudioGraph::Source::AcceptsBuffers(), AudioGraph::Buffers::BlockSize(), EffectStage::Create(), factory, anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and settings().

Referenced by ProcessPass().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mpOutputTracks

std::shared_ptr<EffectOutputTracks> PerTrackEffect::mpOutputTracks

mutableprivate

Definition at line 102 of file PerTrackEffect.h.

Referenced by DestroyOutputTracks(), MakeOutputTracks(), and Process().

◆ mSampleCnt

sampleCount PerTrackEffect::mSampleCnt {}

protected

Definition at line 69 of file PerTrackEffect.h.

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

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Buffers

◆ Factory

Constructor & Destructor Documentation

◆ ~PerTrackEffect()

Member Function Documentation

◆ DestroyOutputTracks()

◆ DoPass1()

◆ DoPass2()

◆ MakeOutputTracks()

◆ Process()

◆ ProcessPass()

◆ ProcessTrack()

Member Data Documentation

◆ mpOutputTracks

◆ mSampleCnt