An abstract Effect class that simplifies the implementation of a basic monaural effect. Inherit from it if your effect just modifies a single track in place and doesn't care how many samples it gets at a time. More...

#include <SimpleMono.h>

Inheritance diagram for EffectSimpleMono:

[legend]

Collaboration diagram for EffectSimpleMono:

[legend]

Public Member Functions
bool	Process () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () override

ComponentInterfaceSymbol	GetSymbol () override

VendorSymbol	GetVendor () override

wxString	GetVersion () override

TranslatableString	GetDescription () override

EffectType	GetType () override

EffectFamilySymbol	GetFamily () override

bool	IsInteractive () override

bool	IsDefault () override

bool	IsLegacy () override

bool	SupportsRealtime () override

bool	SupportsAutomation () override

bool	SetHost (EffectHostInterface *host) override

unsigned	GetAudioInCount () override

unsigned	GetAudioOutCount () override

int	GetMidiInCount () override

int	GetMidiOutCount () override

sampleCount	GetLatency () override

size_t	GetTailSize () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

bool	IsReady () override

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

bool	ProcessFinalize () override

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

bool	RealtimeInitialize () override

bool	RealtimeAddProcessor (unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	RealtimeProcessStart () override

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

bool	RealtimeProcessEnd () override

bool	ShowInterface (wxWindow &parent, const EffectDialogFactory &factory, bool forceModal=false) override

bool	GetAutomationParameters (CommandParameters &parms) override

bool	SetAutomationParameters (CommandParameters &parms) override

bool	LoadUserPreset (const RegistryPath &name) override

bool	SaveUserPreset (const RegistryPath &name) override

RegistryPaths	GetFactoryPresets () override

bool	LoadFactoryPreset (int id) override

bool	LoadFactoryDefaults () override

void	SetHostUI (EffectUIHostInterface *host) override

bool	PopulateUI (ShuttleGui &S) final

bool	IsGraphicalUI () override

bool	ValidateUI () override

bool	HideUI () override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets () override

void	ImportPresets () override

bool	HasOptions () override

void	ShowOptions () override

double	GetDefaultDuration () override

double	GetDuration () override

NumericFormatSymbol	GetDurationFormat () override

virtual NumericFormatSymbol	GetSelectionFormat ()

void	SetDuration (double duration) override

RegistryPath	GetUserPresetsGroup (const RegistryPath &name) override

RegistryPath	GetCurrentSettingsGroup () override

RegistryPath	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

bool	HasSharedConfigGroup (const RegistryPath &group) override

bool	GetSharedConfigSubgroups (const RegistryPath &group, RegistryPaths &subgroups) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval={}) override

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

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

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

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

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

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

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

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

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

bool	RemoveSharedConfigSubgroup (const RegistryPath &group) override

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

bool	HasPrivateConfigGroup (const RegistryPath &group) override

bool	GetPrivateConfigSubgroups (const RegistryPath &group, RegistryPaths &paths) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval={}) override

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

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

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

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

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

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

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

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

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

bool	RemovePrivateConfigSubgroup (const RegistryPath &group) override

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

virtual PluginID	GetID ()

virtual bool	Startup (EffectClientInterface *client)

virtual bool	Startup ()

virtual bool	GetAutomationParameters (wxString &parms)

virtual bool	SetAutomationParameters (const wxString &parms)

virtual RegistryPaths	GetUserPresets ()

virtual bool	HasCurrentSettings ()

virtual bool	HasFactoryDefaults ()

virtual wxString	ManualPage ()

virtual wxString	HelpPage ()

virtual void	SetUIFlags (unsigned flags)

virtual unsigned	TestUIFlags (unsigned mask)

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

bool	DoEffect (double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={})

bool	Delegate (Effect &delegate, wxWindow &parent, const EffectDialogFactory &factory)

virtual bool	IsHidden ()

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

Public Member Functions inherited from EffectClientInterface
virtual	~EffectClientInterface ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetClassification ()

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

TranslatableString	GetName ()

virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

Public Member Functions inherited from EffectHostInterface
virtual	~EffectHostInterface ()

Public Member Functions inherited from ConfigClientInterface
virtual	~ConfigClientInterface ()

Protected Member Functions
virtual bool	NewTrackSimpleMono ()=0

virtual bool	ProcessSimpleMono (float *buffer, size_t len)=0

Protected Member Functions inherited from Effect
virtual bool	Init ()

virtual bool	CheckWhetherSkipEffect ()

virtual bool	ProcessPass ()

virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual int	GetPass ()

virtual void	End ()

virtual double	CalcPreviewInputLength (double previewLength)

virtual void	Preview (bool dryOnly)

virtual void	PopulateOrExchange (ShuttleGui &S)

virtual bool	TransferDataToWindow ()

virtual bool	TransferDataFromWindow ()

virtual bool	EnableApply (bool enable=true)

virtual bool	EnablePreview (bool enable=true)

virtual void	EnableDebug (bool enable=true)

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

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

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

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks (bool allSyncLockSelected=false)

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

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

void	ReplaceProcessedTracks (const bool bGoodResult)

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

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes
int	mCurTrackNum

double	mCurRate

double	mCurT0

double	mCurT1

int	mCurChannel

Protected Attributes inherited from Effect
ProgressDialog *	mProgress

double	mProjectRate

double	mSampleRate

wxWeakRef< NotifyingSelectedRegion >	mpSelectedRegion {}

WaveTrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxDialog *	mUIDialog

wxWindow *	mUIParent

int	mUIResultID

unsigned	mUIFlags

sampleCount	mSampleCnt

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

Additional Inherited Members
Public Types inherited from Effect
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

using	VetoDialogHook = bool()(wxDialog )

Public Types inherited from EffectClientInterface
using	EffectDialogFactory = std::function< wxDialog (wxWindow &parent, EffectHostInterface , EffectUIClientInterface *) >

Static Public Member Functions inherited from Effect
static VetoDialogHook	SetVetoDialogHook (VetoDialogHook hook)

static CommandID	GetSquashedName (wxString name)

static void	IncEffectCounter ()

Static Public Attributes inherited from Effect
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 Effect
static int	nEffectsDone =0

Detailed Description

An abstract Effect class that simplifies the implementation of a basic monaural effect. Inherit from it if your effect just modifies a single track in place and doesn't care how many samples it gets at a time.

Your derived class only needs to implement GetSymbol, GetEffectAction, and ProcessSimpleMono.

Definition at line 24 of file SimpleMono.h.

Member Function Documentation

◆ NewTrackSimpleMono()

bool EffectSimpleMono::NewTrackSimpleMono ( )

protectedpure virtual

Definition at line 125 of file SimpleMono.cpp.

 {
    return true;
 }

Referenced by Process().

Here is the caller graph for this function:

◆ Process()

bool EffectSimpleMono::Process ( )

overridevirtual

Reimplemented from Effect.

Definition at line 29 of file SimpleMono.cpp.

 {
    //Iterate over each track
    this->CopyInputTracks(); // Set up mOutputTracks.
    bool bGoodResult = true;
  
    mCurTrackNum = 0;
    for( auto pOutWaveTrack : mOutputTracks->Selected< WaveTrack >() )
    {
       //Get start and end times from track
       double trackStart = pOutWaveTrack->GetStartTime();
       double trackEnd = pOutWaveTrack->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 = pOutWaveTrack->TimeToLongSamples(mCurT0);
          auto end = pOutWaveTrack->TimeToLongSamples(mCurT1);
  
          //Get the track rate and samples
          mCurRate = pOutWaveTrack->GetRate();
          mCurChannel = pOutWaveTrack->GetChannel();
  
          //NewTrackSimpleMono() will returns true by default
          //ProcessOne() processes a single track
          if (!NewTrackSimpleMono() || !ProcessOne(pOutWaveTrack, start, end))
          {
             bGoodResult = false;
             break;
          }
       }
  
       mCurTrackNum++;
    }
  
    this->ReplaceProcessedTracks(bGoodResult);
    return bGoodResult;
 }

References Effect::CopyInputTracks(), mCurChannel, mCurRate, mCurT0, mCurT1, mCurTrackNum, Effect::mOutputTracks, Effect::mT0, Effect::mT1, NewTrackSimpleMono(), ProcessOne(), and Effect::ReplaceProcessedTracks().

Here is the call graph for this function:

◆ ProcessOne()

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

private

Definition at line 77 of file SimpleMono.cpp.

 {
    //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();
  
    //Initiate a processing buffer.  This buffer will (most likely)
    //be shorter than the length of the track being processed.
    Floats buffer{ track->GetMaxBlockSize() };
  
    //Go through the track one buffer at a time. s counts which
    //sample the current buffer starts at.
    auto s = start;
    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
       const auto block =
          limitSampleBufferSize( track->GetBestBlockSize(s), end - s );
  
       //Get the samples from the track and put them in the buffer
       track->Get((samplePtr) buffer.get(), floatSample, s, block);
  
       //Process the buffer.  If it fails, clean up and exit.
       if (!ProcessSimpleMono(buffer.get(), block))
          //Return false because the effect failed.
          return false;
  
       //Processing succeeded. copy the newly-changed samples back
       //onto the track.
       track->Set((samplePtr) buffer.get(), floatSample, s, block);
  
       //Increment s one blockfull of samples
       s += block;
  
       //Update the Progress meter
       if (TrackProgress(mCurTrackNum,
                         (s - start).as_double() /
                         len))
          return false;
    }
  
    //Return true because the effect processing succeeded.
    return true;
 }

References floatSample, WaveTrack::Get(), WaveTrack::GetBestBlockSize(), WaveTrack::GetMaxBlockSize(), limitSampleBufferSize(), mCurTrackNum, ProcessSimpleMono(), WaveTrack::Set(), and Effect::TrackProgress().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessSimpleMono()

virtual bool EffectSimpleMono::ProcessSimpleMono	(	float *	buffer,
		size_t	len
	)

int EffectSimpleMono::mCurTrackNum

protected

Definition at line 41 of file SimpleMono.h.

Referenced by Process(), and ProcessOne().

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

◆ NewTrackSimpleMono()

◆ Process()

◆ ProcessOne()

◆ ProcessSimpleMono()

Member Data Documentation

◆ mCurChannel

◆ mCurRate

◆ mCurT0

◆ mCurT1

◆ mCurTrackNum