EffectTwoPassSimpleMono Class Reference

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

#include <TwoPassSimpleMono.h>

Inheritance diagram for EffectTwoPassSimpleMono:

Collaboration diagram for EffectTwoPassSimpleMono:

Public Member Functions
	~EffectTwoPassSimpleMono () override
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
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
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))
	Override this method to actually process audio. More...
virtual bool	ProcessPass2 (float *WXUNUSED(buffer), size_t WXUNUSED(len))
virtual bool	TwoBufferProcessPass1 (float *buffer1, size_t len1, float *buffer2, size_t len2)
virtual bool	TwoBufferProcessPass2 (float *buffer1, size_t len1, float *buffer2, size_t len2)
void	DisableSecondPass ()
	Call this if you know in advance that no second pass will be needed. More...
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
int	mCurTrackNum
double	mCurRate
double	mCurT0
double	mCurT1
int	mPass
bool	mSecondPassDisabled
std::shared_ptr< TrackList >	mWorkTracks
TrackList *	mTrackLists [2]
Protected Attributes inherited from EffectBase
wxArrayString	mPresetNames
unsigned	mUIFlags { 0 }

Private Member Functions
bool	ProcessOne (WaveChannel &t, WaveChannel &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 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
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

An Effect base class that implements a two pass process.

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 19 of file TwoPassSimpleMono.h.

Constructor & Destructor Documentation

~EffectTwoPassSimpleMono()

EffectTwoPassSimpleMono::~EffectTwoPassSimpleMono ( )

overridedefault

Member Function Documentation

DisableSecondPass()

void EffectTwoPassSimpleMono::DisableSecondPass ( )

inlineprotected

Call this if you know in advance that no second pass will be needed.

This is used as a hint for the progress bar

Definition at line 83 of file TwoPassSimpleMono.h.

{ mSecondPassDisabled = true; }

Referenced by EffectCompressor::InitPass1().

Here is the caller graph for this function:

InitPass1()

bool EffectTwoPassSimpleMono::InitPass1 ( )

protectedvirtual

Override these methods if you need to initialize something before each pass. Return false if processing should stop.

Reimplemented in EffectCompressor.

Definition at line 242 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 249 of file TwoPassSimpleMono.cpp.

{
   return true;
}

Referenced by Process().

Here is the caller graph for this function:

NewTrackPass1()

bool EffectTwoPassSimpleMono::NewTrackPass1 ( )

protectedvirtual

Override these methods if you need to do things before every track (including the first one)

Reimplemented in EffectCompressor.

Definition at line 231 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 236 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 24 of file TwoPassSimpleMono.cpp.

{
   mPass = 0;
   mSecondPassDisabled = false;
 
   InitPass1();
   EffectOutputTracks outputs { *mTracks, GetType(), { { mT0, mT1 } } };
 
   mWorkTracks = TrackList::Create(const_cast<AudacityProject*>(FindProject()));
   for (auto track : outputs.Get().Selected<WaveTrack>()) {
      auto pNewTracks = track->WideEmptyCopy();
      mWorkTracks->Append(std::move(*pNewTracks));
   }
   for (const auto pNewTrack : mWorkTracks->Any<WaveTrack>()) {
      pNewTrack->ConvertToSampleFormat(floatSample);
   }
 
   mTrackLists[0] = &outputs.Get();
   mTrackLists[1] = mSecondPassDisabled ? mTrackLists[0] : &*mWorkTracks;
 
   bool bGoodResult = ProcessPass(settings);
   if (bGoodResult && !mSecondPassDisabled) {
      mPass = 1;
      if (InitPass2())
         bGoodResult = ProcessPass(settings);
   }
 
   mWorkTracks->Clear();
   mWorkTracks.reset();
 
   if (bGoodResult)
      outputs.Commit();
 
   return bGoodResult;
}

References TrackList::Create(), EffectBase::FindProject(), floatSample, TrackList::Get(), EffectDefinitionInterface::GetType(), InitPass1(), InitPass2(), mPass, mSecondPassDisabled, EffectBase::mT0, EffectBase::mT1, mTrackLists, EffectBase::mTracks, mWorkTracks, ProcessPass(), and settings().

Here is the call graph for this function:

ProcessOne()

bool EffectTwoPassSimpleMono::ProcessOne ( WaveChannel &  t, WaveChannel &  outTrack, sampleCount  start, sampleCount  end  )

private

Definition at line 122 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(nullptr, 0, buffer1.get(), samples1);
   else
      ret = TwoBufferProcessPass2(nullptr, 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) {
         if (!outTrack.Set((samplePtr)buffer1.get(), floatSample, s - samples1,
            samples1))
            return false;
      }
      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, nullptr, 0);
   else
      ret = TwoBufferProcessPass2(buffer1.get(), samples1, nullptr, 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) {
      if (!outTrack.Set((samplePtr)buffer1.get(), floatSample, s - samples1,
         samples1))
         return false;
   }
   else
      outTrack.Append((samplePtr)buffer1.get(), floatSample, samples1);
 
   // Return true because the effect processing succeeded.
   return true;
}

References WaveChannel::Append(), PackedArray::end(), floatSample, WaveChannel::GetBestBlockSize(), WaveChannel::GetFloats(), WaveChannel::GetMaxBlockSize(), Effect::GetNumWaveTracks(), limitSampleBufferSize(), mCurTrackNum, min(), mPass, mSecondPassDisabled, WaveChannel::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 the orignal track
      double trackStart = mPass == 0 ? track->GetStartTime() : (*outTracks)->GetStartTime();
      double trackEnd = mPass == 0 ? track->GetEndTime() : (*outTracks)->GetEndTime();
 
      // Set the current bounds to whichever left marker is
      // greater and whichever right marker is less:
      mCurT0 = std::max(trackStart, mT0);
      mCurT1 = std::min(trackEnd, mT1);
 
      // So that in ProcessOne(), when mPass == 0, samples are
      // appended starting at mCurT0
      if (!mSecondPassDisabled && mPass == 0 && mCurT0 > 0)
            (*outTracks)->InsertSilence(0, mCurT0);
 
      // 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();
 
         // 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
         auto outIter = outTrack->Channels().begin();
         for (const auto pChannel : track->Channels())
            if (!ProcessOne(*pChannel, **outIter++, start, end))
               return false;
         if (!mSecondPassDisabled && mPass == 0)
            outTrack->Flush();
      }
 
      ++mCurTrackNum;
      ++outTracks;
   }
 
   return true;
}

References PackedArray::end(), mCurRate, mCurT0, mCurT1, mCurTrackNum, min(), mPass, mSecondPassDisabled, 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

Override this method to actually process audio.

Definition at line 45 of file TwoPassSimpleMono.h.

   { return false; }

ProcessPass2()

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

inlineprotectedvirtual

Definition at line 49 of file TwoPassSimpleMono.h.

   { return false; }

TwoBufferProcessPass1()

virtual bool EffectTwoPassSimpleMono::TwoBufferProcessPass1 ( float *  buffer1, size_t  len1, float *  buffer2, size_t  len2  )

inlineprotectedvirtual

Override this method to actually process audio with access to 2 sequential buffers at a time

Either buffer1 or buffer2 may be modified as needed This allows implementation of processing with delays The default just calls the one-buffer-at-a-time method

Reimplemented in EffectCompressor.

Definition at line 60 of file TwoPassSimpleMono.h.

   {
      if (buffer1)
         return ProcessPass1(buffer1, len1);
      else return true;
   }

Referenced by ProcessOne().

Here is the caller graph for this function:

TwoBufferProcessPass2()

virtual bool EffectTwoPassSimpleMono::TwoBufferProcessPass2 ( float *  buffer1, size_t  len1, float *  buffer2, size_t  len2  )

inlineprotectedvirtual

Definition at line 68 of file TwoPassSimpleMono.h.

   {
      if(buffer1)
         return ProcessPass2(buffer1, len1);
      else return true;
   }

Referenced by ProcessOne().

Here is the caller graph for this function:

Member Data Documentation

mCurRate

double EffectTwoPassSimpleMono::mCurRate

protected

Definition at line 87 of file TwoPassSimpleMono.h.

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

mCurT0

double EffectTwoPassSimpleMono::mCurT0

protected

Definition at line 88 of file TwoPassSimpleMono.h.

Referenced by ProcessPass().

mCurT1

double EffectTwoPassSimpleMono::mCurT1

protected

Definition at line 89 of file TwoPassSimpleMono.h.

Referenced by ProcessPass().

mCurTrackNum

int EffectTwoPassSimpleMono::mCurTrackNum

protected

Definition at line 86 of file TwoPassSimpleMono.h.

Referenced by ProcessOne(), and ProcessPass().

mPass

int EffectTwoPassSimpleMono::mPass

protected

Definition at line 90 of file TwoPassSimpleMono.h.

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

mSecondPassDisabled

bool EffectTwoPassSimpleMono::mSecondPassDisabled

protected

Definition at line 91 of file TwoPassSimpleMono.h.

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

mTrackLists

TrackList* EffectTwoPassSimpleMono::mTrackLists[2]

protected

Definition at line 94 of file TwoPassSimpleMono.h.

Referenced by Process(), and ProcessPass().

mWorkTracks

std::shared_ptr<TrackList> EffectTwoPassSimpleMono::mWorkTracks

protected

Definition at line 93 of file TwoPassSimpleMono.h.

Referenced by Process().

---

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

• TwoPassSimpleMono.h
• TwoPassSimpleMono.cpp