An Effect base class that implements a two pass process by using EffectSimpleMono. More...

#include <TwoPassSimpleMono.h>

Inheritance diagram for EffectTwoPassSimpleMono:

Collaboration diagram for EffectTwoPassSimpleMono:

Public Member Functions
bool	Process (EffectInstance &instance, EffectSettings &settings) override

Public Member Functions inherited from StatefulEffect
	~StatefulEffect () override

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

Public Member Functions inherited from StatefulEffectBase
virtual bool	Init ()

virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0

virtual bool	RealtimeInitialize (EffectSettings &settings, double sampleRate)

virtual bool	RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate)

virtual bool	RealtimeSuspend ()

virtual bool	RealtimeResume ()

virtual bool	RealtimeProcessStart (MessagePackage &package)
	settings are possibly changed, since last call, by an asynchronous dialog More...

virtual size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float const inBuf, float const outBuf, size_t numSamples)

virtual bool	RealtimeProcessEnd (EffectSettings &settings) noexcept
	settings can be updated to let a dialog change appearance at idle More...

virtual bool	RealtimeFinalize (EffectSettings &settings) noexcept

virtual size_t	SetBlockSize (size_t maxBlockSize)

virtual size_t	GetBlockSize () const

virtual unsigned	GetAudioInCount () const
	How many input buffers to allocate at once. More...

virtual unsigned	GetAudioOutCount () const
	How many output buffers to allocate at once. More...

virtual sampleCount	GetLatency () const

virtual bool	NeedsDither () const

virtual bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr)

virtual bool	ProcessFinalize () noexcept

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

EffectType	GetType () const override
	Type determines how it behaves. More...

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

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

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

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

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

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

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

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

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

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

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

OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const override

virtual const EffectParameterMethods &	Parameters () const

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 NumericFormatSymbol	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	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 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

Public Member Functions inherited from StatefulEffectUIServices
	~StatefulEffectUIServices () override

std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
	Allows PopulateOrExchange to return null. More...

virtual std::unique_ptr< EffectEditor >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)
	Add controls to effect panel; always succeeds. More...

virtual bool	TransferDataToWindow (const EffectSettings &settings)

virtual bool	TransferDataFromWindow (EffectSettings &settings)

Public Member Functions inherited from BasicEffectUIServices
int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override

void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override

OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override

void	ShowOptions (const EffectPlugin &plugin) const override

bool	ValidateUI (const EffectPlugin &context, EffectSettings &) const override

bool	CloseUI () const override

Public Member Functions inherited from EffectUIServices
virtual	~EffectUIServices ()

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

virtual int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0

virtual std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
	Adds controls to a panel that is given as the parent window of `S` More...

virtual void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0

virtual OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0

virtual void	ShowOptions (const EffectPlugin &plugin) const =0

virtual bool	ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0

virtual bool	CloseUI () const =0

Protected Member Functions
virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual bool	NewTrackPass1 ()

virtual bool	NewTrackPass2 ()

virtual bool	ProcessPass1 (float *WXUNUSED(buffer), size_t WXUNUSED(len))

virtual bool	ProcessPass2 (float *WXUNUSED(buffer), size_t WXUNUSED(len))

virtual bool	TwoBufferProcessPass1 (float buffer1, size_t len1, float WXUNUSED(buffer2), size_t WXUNUSED(len2))

virtual bool	TwoBufferProcessPass2 (float buffer1, size_t len1, float WXUNUSED(buffer2), size_t WXUNUSED(len2))

void	DisableSecondPass ()

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, const WaveTrack pRight, sampleCount start, sampleCount *len)

void	CopyInputTracks (bool allSyncLockSelected=false)

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

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
int	mCurTrackNum

double	mCurRate

double	mCurT0

double	mCurT1

int	mCurChannel

int	mPass

bool	mSecondPassDisabled

std::shared_ptr< TrackList >	mWorkTracks

std::shared_ptr< TrackList > *	mTrackLists [2]

Protected Attributes inherited from EffectBase
std::shared_ptr< TrackList >	mOutputTracks

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Private Member Functions
bool	ProcessOne (WaveTrack t, WaveTrack outTrack, sampleCount start, sampleCount end)

bool	ProcessPass (EffectSettings &settings)

Additional Inherited Members
Public Types inherited from StatefulEffectBase
using	MessagePackage = EffectInstance::MessagePackage

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

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

Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (Effect &e, EffectSettings &)

static void	IncEffectCounter ()

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

Static Public Member Functions inherited from EffectUIServices
static int	DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

Public Attributes inherited from EffectBase
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>")

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

An Effect base class that implements a two pass process by using EffectSimpleMono.

Inherit from it if your effect needs to pass twice over the data. It does the first pass on all selected tracks before going back and doing the second pass over all selected tracks.

Definition at line 20 of file TwoPassSimpleMono.h.

Member Function Documentation

◆ DisableSecondPass()

void EffectTwoPassSimpleMono::DisableSecondPass ( )

inlineprotected

Definition at line 68 of file TwoPassSimpleMono.h.

68{ mSecondPassDisabled = true; }

EffectTwoPassSimpleMono::mSecondPassDisabled

bool mSecondPassDisabled

Definition: TwoPassSimpleMono.h:77

Referenced by EffectCompressor::InitPass1().

Here is the caller graph for this function:

◆ InitPass1()

bool EffectTwoPassSimpleMono::InitPass1 ( )

protectedvirtual

Reimplemented in EffectCompressor.

Definition at line 232 of file TwoPassSimpleMono.cpp.

{
   return true;
}

Referenced by Process().

Here is the caller graph for this function:

◆ InitPass2()

bool EffectTwoPassSimpleMono::InitPass2 ( )

protectedvirtual

Reimplemented in EffectCompressor.

Definition at line 239 of file TwoPassSimpleMono.cpp.

{
   return true;
}

Referenced by Process().

Here is the caller graph for this function:

◆ NewTrackPass1()

bool EffectTwoPassSimpleMono::NewTrackPass1 ( )

protectedvirtual

Reimplemented in EffectCompressor.

Definition at line 221 of file TwoPassSimpleMono.cpp.

{
   return true;
}

Referenced by ProcessPass().

Here is the caller graph for this function:

◆ NewTrackPass2()

bool EffectTwoPassSimpleMono::NewTrackPass2 ( )

protectedvirtual

Definition at line 226 of file TwoPassSimpleMono.cpp.

{
   return true;
}

Referenced by ProcessPass().

Here is the caller graph for this function:

◆ Process()

bool EffectTwoPassSimpleMono::Process	(	EffectInstance &	instance,
		EffectSettings &	settings
	)

overridevirtual

Implements StatefulEffectBase.

Definition at line 26 of file TwoPassSimpleMono.cpp.

{
   mPass = 0;
   mSecondPassDisabled = false;
 
   InitPass1();
   this->CopyInputTracks(); // Set up mOutputTracks.
 
   mWorkTracks = TrackList::Create(
      const_cast<AudacityProject*>( FindProject() ) );
   for (auto track : mOutputTracks->Selected< WaveTrack >()) {
      mWorkTracks->Add(track->EmptyCopy())->ConvertToSampleFormat(floatSample);
      if( mT0 > 0 )
         mWorkTracks->back()->InsertSilence(0, mT0);
   }
 
   mTrackLists[0] = &mOutputTracks;
   mTrackLists[1] = mSecondPassDisabled ? &mOutputTracks : &mWorkTracks;
 
   bool bGoodResult = ProcessPass(settings);
 
   if (bGoodResult && !mSecondPassDisabled)
   {
      mPass = 1;
      if (InitPass2())
         bGoodResult = ProcessPass(settings);
   }
 
   mWorkTracks->Clear();
   mWorkTracks.reset();
 
   this->ReplaceProcessedTracks(bGoodResult);
   return bGoodResult;
}

References Effect::CopyInputTracks(), TrackList::Create(), EffectBase::FindProject(), floatSample, InitPass1(), InitPass2(), EffectBase::mOutputTracks, mPass, mSecondPassDisabled, EffectBase::mT0, mTrackLists, mWorkTracks, ProcessPass(), EffectBase::ReplaceProcessedTracks(), and settings().

Here is the call graph for this function:

◆ ProcessOne()

bool EffectTwoPassSimpleMono::ProcessOne	(	WaveTrack *	t,
		WaveTrack *	outTrack,
		sampleCount	start,
		sampleCount	end
	)

private

Definition at line 114 of file TwoPassSimpleMono.cpp.

{
   bool ret;
 
   //Get the length of the buffer (as double). len is
   //used simple to calculate a progress meter, so it is easier
   //to make it a double now than it is to do it later
   auto len = (end - start).as_double();
   auto maxblock = track->GetMaxBlockSize();
 
   //Initiate a processing buffer.  This buffer will (most likely)
   //be shorter than the length of the track being processed.
   Floats buffer1{ maxblock };
   Floats buffer2{ maxblock };
   auto samples1 =  limitSampleBufferSize(
      std::min( maxblock, track->GetBestBlockSize(start) ), end - start );
 
   //Get the samples from the track and put them in the buffer
   track->GetFloats(buffer1.get(), start, samples1);
 
   // Process the first buffer with a NULL previous buffer
   if (mPass == 0)
      ret = TwoBufferProcessPass1(NULL, 0, buffer1.get(), samples1);
   else
      ret = TwoBufferProcessPass2(NULL, 0, buffer1.get(), samples1);
   if (!ret)
      //Return false because the effect failed.
      return false;
 
   //Go through the track one buffer at a time. s counts which
   //sample the current buffer starts at.
   auto s = start + samples1;
   while (s < end) {
      //Get a block of samples (smaller than the size of the buffer)
      //Adjust the block size if it is the final block in the track
      auto samples2 = limitSampleBufferSize(
         std::min( track->GetBestBlockSize(s), maxblock ), end - s
      );
 
      //Get the samples from the track and put them in the buffer
      track->GetFloats(buffer2.get(), s, samples2);
 
      //Process the buffer.  If it fails, clean up and exit.
      if (mPass == 0)
         ret = TwoBufferProcessPass1(buffer1.get(), samples1, buffer2.get(), samples2);
      else
         ret = TwoBufferProcessPass2(buffer1.get(), samples1, buffer2.get(), samples2);
      if (!ret)
         //Return false because the effect failed.
         return false;
 
      //Processing succeeded. copy the newly-changed samples back
      //onto the track.
      if (mSecondPassDisabled || mPass != 0) {
         outTrack->Set((samplePtr)buffer1.get(), floatSample, s - samples1, samples1);
      }
      else {
         outTrack->Append((samplePtr)buffer1.get(), floatSample, samples1);
      }
 
      //Increment s one blockfull of samples
      s += samples2;
 
      //Update the Progress meter
      if (mSecondPassDisabled)
         ret = TotalProgress(
            (mCurTrackNum + (s-start).as_double()/len) /
            GetNumWaveTracks());
      else
         ret = TotalProgress(
            (mCurTrackNum + (s-start).as_double()/len + GetNumWaveTracks()*mPass) /
            (GetNumWaveTracks()*2));
      if (ret)
         //Return false because the effect failed.
         return false;
 
      // Rotate the buffers
      buffer1.swap(buffer2);
 
      std::swap(samples1, samples2);
   }
 
   // Send the last buffer with a NULL pointer for the current buffer
   if (mPass == 0)
      ret = TwoBufferProcessPass1(buffer1.get(), samples1, NULL, 0);
   else
      ret = TwoBufferProcessPass2(buffer1.get(), samples1, NULL, 0);
 
   if (!ret)
      //Return false because the effect failed.
      return false;
 
   //Processing succeeded. copy the newly-changed samples back
   //onto the track.
   if (mSecondPassDisabled || mPass != 0) {
      outTrack->Set((samplePtr)buffer1.get(), floatSample, s - samples1, samples1);
   }
   else {
      outTrack->Append((samplePtr)buffer1.get(), floatSample, samples1);
      outTrack->Flush();
   }
 
   //Return true because the effect processing succeeded.
   return true;
}

References WaveTrack::Append(), PackedArray::end(), floatSample, WaveTrack::Flush(), WaveTrack::GetBestBlockSize(), SampleTrack::GetFloats(), WaveTrack::GetMaxBlockSize(), Effect::GetNumWaveTracks(), limitSampleBufferSize(), mCurTrackNum, min(), mPass, mSecondPassDisabled, WaveTrack::Set(), anonymous_namespace{NoteTrack.cpp}::swap(), Effect::TotalProgress(), TwoBufferProcessPass1(), and TwoBufferProcessPass2().

Referenced by ProcessPass().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessPass()

bool EffectTwoPassSimpleMono::ProcessPass ( EffectSettings & settings )

private

Definition at line 61 of file TwoPassSimpleMono.cpp.

{
   //Iterate over each track
   mCurTrackNum = 0;
 
   auto outTracks = (*mTrackLists[1 - mPass])->Selected< WaveTrack >().begin();
   for( auto track : (*mTrackLists[mPass])->Selected< WaveTrack >() ) {
      auto outTrack = *outTracks;
 
      //Get start and end times from track
      double trackStart = track->GetStartTime();
      double trackEnd = track->GetEndTime();
 
      //Set the current bounds to whichever left marker is
      //greater and whichever right marker is less:
      mCurT0 = mT0 < trackStart? trackStart: mT0;
      mCurT1 = mT1 > trackEnd? trackEnd: mT1;
 
      // Process only if the right marker is to the right of the left marker
      if (mCurT1 > mCurT0) {
 
         //Transform the marker timepoints to samples
         auto start = track->TimeToLongSamples(mCurT0);
         auto end = track->TimeToLongSamples(mCurT1);
 
         //Get the track rate and samples
         mCurRate = track->GetRate();
         mCurChannel = track->GetChannel();
 
         //NewTrackPass1/2() returns true by default
         bool ret;
         if (mPass == 0)
            ret = NewTrackPass1();
         else
            ret = NewTrackPass2();
         if (!ret)
            return false;
 
         //ProcessOne() (implemented below) processes a single track
         if (!ProcessOne(track, outTrack, start, end))
            return false;
      }
 
      mCurTrackNum++;
      outTracks++;
   }
 
   return true;
}

References PackedArray::end(), mCurChannel, mCurRate, mCurT0, mCurT1, mCurTrackNum, mPass, EffectBase::mT0, EffectBase::mT1, mTrackLists, NewTrackPass1(), NewTrackPass2(), and ProcessOne().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessPass1()

virtual bool EffectTwoPassSimpleMono::ProcessPass1	(	float *	WXUNUSEDbuffer,
		size_t	WXUNUSEDlen
	)

inlineprotectedvirtual

Definition at line 45 of file TwoPassSimpleMono.h.

47 { return false; }

◆ ProcessPass2()

virtual bool EffectTwoPassSimpleMono::ProcessPass2	(	float *	WXUNUSEDbuffer,
		size_t	WXUNUSEDlen
	)

inlineprotectedvirtual

Definition at line 49 of file TwoPassSimpleMono.h.

51 { return false; }

◆ TwoBufferProcessPass1()

virtual bool EffectTwoPassSimpleMono::TwoBufferProcessPass1	(	float *	buffer1,
		size_t	len1,
		float *	WXUNUSEDbuffer2,
		size_t	WXUNUSEDlen2
	)

inlineprotectedvirtual

Definition at line 57 of file TwoPassSimpleMono.h.

59 { if(buffer1 != NULL) return ProcessPass1(buffer1, len1); else return true; }

EffectTwoPassSimpleMono::ProcessPass1

virtual bool ProcessPass1(float *WXUNUSED(buffer), size_t WXUNUSED(len))

Definition: TwoPassSimpleMono.h:46

Referenced by ProcessOne().

Here is the caller graph for this function:

◆ TwoBufferProcessPass2()

virtual bool EffectTwoPassSimpleMono::TwoBufferProcessPass2	(	float *	buffer1,
		size_t	len1,
		float *	WXUNUSEDbuffer2,
		size_t	WXUNUSEDlen2
	)

inlineprotectedvirtual

Definition at line 60 of file TwoPassSimpleMono.h.

62 { if(buffer1 != NULL) return ProcessPass2(buffer1, len1); else return true; }

EffectTwoPassSimpleMono::ProcessPass2

virtual bool ProcessPass2(float *WXUNUSED(buffer), size_t WXUNUSED(len))

Definition: TwoPassSimpleMono.h:50

Referenced by ProcessOne().

Here is the caller graph for this function:

Member Data Documentation

◆ mCurChannel

int EffectTwoPassSimpleMono::mCurChannel

protected

Definition at line 75 of file TwoPassSimpleMono.h.

Referenced by ProcessPass().

◆ mCurRate

double EffectTwoPassSimpleMono::mCurRate

protected

Definition at line 72 of file TwoPassSimpleMono.h.

Referenced by EffectCompressor::NewTrackPass1(), and ProcessPass().

◆ mCurT0

double EffectTwoPassSimpleMono::mCurT0

protected

Definition at line 73 of file TwoPassSimpleMono.h.

Referenced by ProcessPass().

◆ mCurT1

double EffectTwoPassSimpleMono::mCurT1

protected

Definition at line 74 of file TwoPassSimpleMono.h.

Referenced by ProcessPass().

◆ mCurTrackNum

int EffectTwoPassSimpleMono::mCurTrackNum

protected

Definition at line 71 of file TwoPassSimpleMono.h.

Referenced by ProcessOne(), and ProcessPass().

◆ mPass

int EffectTwoPassSimpleMono::mPass

protected

Definition at line 76 of file TwoPassSimpleMono.h.

Referenced by Process(), ProcessOne(), and ProcessPass().

◆ mSecondPassDisabled

bool EffectTwoPassSimpleMono::mSecondPassDisabled

protected

Definition at line 77 of file TwoPassSimpleMono.h.

Referenced by Process(), and ProcessOne().

◆ mTrackLists

std::shared_ptr<TrackList>* EffectTwoPassSimpleMono::mTrackLists[2]

protected

Definition at line 80 of file TwoPassSimpleMono.h.

Referenced by Process(), and ProcessPass().

◆ mWorkTracks

std::shared_ptr<TrackList> EffectTwoPassSimpleMono::mWorkTracks

protected

Definition at line 79 of file TwoPassSimpleMono.h.

Referenced by Process().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DisableSecondPass()

◆ InitPass1()

◆ InitPass2()

◆ NewTrackPass1()

◆ NewTrackPass2()

◆ Process()

◆ ProcessOne()

◆ ProcessPass()

◆ ProcessPass1()

◆ ProcessPass2()

◆ TwoBufferProcessPass1()

◆ TwoBufferProcessPass2()

Member Data Documentation

◆ mCurChannel

◆ mCurRate

◆ mCurT0

◆ mCurT1

◆ mCurTrackNum

◆ mPass

◆ mSecondPassDisabled

◆ mTrackLists

◆ mWorkTracks