An Effect that changes frequencies in a time varying manner. More...

#include <Phaser.h>

Inheritance diagram for EffectPhaser:

Collaboration diagram for EffectPhaser:

Public Member Functions
	EffectPhaser ()

virtual	~EffectPhaser ()

ComponentInterfaceSymbol	GetSymbol () const override

TranslatableString	GetDescription () const override

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

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

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

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

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

bool	ProcessInitialize (EffectSettings &settings, double sampleRate, sampleCount totalLen, ChannelNames chanMap) override

size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen) override
	Called for destructive effect computation. More...

bool	RealtimeInitialize (EffectSettings &settings, double sampleRate) override

bool	RealtimeAddProcessor (EffectSettings &settings, unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize (EffectSettings &settings) noexcept override

size_t	RealtimeProcess (size_t group, EffectSettings &settings, const float const inbuf, float const outbuf, size_t numSamples) override

std::unique_ptr< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
	Add controls to effect panel; always succeeds. More...

bool	TransferDataToWindow (const EffectSettings &settings) override
	Update controls for the settings. More...

bool	TransferDataFromWindow (EffectSettings &settings) override
	Update the given settings from controls. More...

Public Member Functions inherited from StatefulPerTrackEffect
std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. More...

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

virtual sampleCount	GetLatency ()

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

virtual bool	ProcessFinalize ()

virtual size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen)
	Called for destructive effect computation. More...

Public Member Functions inherited from StatefulEffectBase
virtual bool	Init ()
	Call once to set up state for whole list of tracks to be processed. More...

virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0
	Actually do the effect here. More...

virtual bool	RealtimeInitialize (EffectSettings &settings, double sampleRate)

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

virtual bool	RealtimeSuspend ()

virtual bool	RealtimeResume ()

virtual bool	RealtimeProcessStart (EffectSettings &settings)
	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

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

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

bool	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
	Change settings to a user-named preset. More...

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

bool	LoadFactoryPreset (int id, EffectSettings &settings) const override
	Change settings to the preset whose name is `GetFactoryPresets()[id]` More...

bool	LoadFactoryDefaults (EffectSettings &settings) const override
	Change settings back to "factory default". More...

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

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

virtual const EffectParameterMethods &	Parameters () const

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override

std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
	Adds controls to a panel that is given as the parent window of `S` More...

bool	IsGraphicalUI () override

bool	ValidateUI (EffectSettings &) override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets (const EffectSettings &settings) const override

void	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatSymbol	GetSelectionFormat ()

int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false) override
	Usually applies factory to self and given access. More...

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

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

bool	IsBatchProcessing () const override

void	SetBatchProcessing () override

void	UnsetBatchProcessing () override

bool	TransferDataToWindow (const EffectSettings &settings) override
	Update controls for the settings. More...

bool	TransferDataFromWindow (EffectSettings &settings) override
	Update the given settings from controls. More...

unsigned	TestUIFlags (unsigned mask)

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

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

bool	EnableApply (bool enable=true)

wxWindow *	GetUIParent ()

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

virtual int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false)=0

virtual bool	IsGraphicalUI ()=0

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

virtual bool	CanExportPresets ()=0

virtual void	ExportPresets (const EffectSettings &settings) const =0

virtual void	ImportPresets (EffectSettings &settings)=0

virtual bool	HasOptions ()=0

virtual void	ShowOptions ()=0

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

virtual	~EffectPlugin ()

virtual const EffectSettingsManager &	GetDefinition () const =0

virtual int	ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)=0
	Usually applies factory to self and given access. More...

virtual void	Preview (EffectSettingsAccess &access, bool dryOnly)=0

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

virtual bool	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, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={}, const EffectSettingsAccessPtr &pAccess=nullptr)=0
	Unfortunately complicated dual-use function. More...

virtual bool	TransferDataToWindow (const EffectSettings &settings)=0
	Update controls for the settings. More...

virtual bool	TransferDataFromWindow (EffectSettings &settings)=0
	Update the given settings from controls. More...

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

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

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

virtual int	GetMidiInCount () const
	Function that has not yet found a use. More...

virtual int	GetMidiOutCount () const
	Function that has not yet found a use. 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...

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

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

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

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

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

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

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

bool	SupportsRealtime () const

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

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

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

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

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

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Static Public Member Functions
static EffectPhaser *	FetchParameters (EffectPhaser &e, EffectSettings &)

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

static void	IncEffectCounter ()

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 Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Phaser") }

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>")

Private Member Functions
void	InstanceInit (EffectPhaserState &data, float sampleRate)

size_t	InstanceProcess (EffectSettings &settings, EffectPhaserState &data, const float const inBlock, float const outBlock, size_t blockLen)

void	OnStagesSlider (wxCommandEvent &evt)

void	OnDryWetSlider (wxCommandEvent &evt)

void	OnFeedbackSlider (wxCommandEvent &evt)

void	OnDepthSlider (wxCommandEvent &evt)

void	OnPhaseSlider (wxCommandEvent &evt)

void	OnFreqSlider (wxCommandEvent &evt)

void	OnGainSlider (wxCommandEvent &evt)

void	OnStagesText (wxCommandEvent &evt)

void	OnDryWetText (wxCommandEvent &evt)

void	OnFeedbackText (wxCommandEvent &evt)

void	OnDepthText (wxCommandEvent &evt)

void	OnPhaseText (wxCommandEvent &evt)

void	OnFreqText (wxCommandEvent &evt)

void	OnGainText (wxCommandEvent &evt)

const EffectParameterMethods &	Parameters () const override

Private Attributes
EffectPhaserState	mMaster

std::vector< EffectPhaserState >	mSlaves

int	mStages

int	mDryWet

double	mFreq

double	mPhase

int	mDepth

int	mFeedback

double	mOutGain

wxTextCtrl *	mStagesT

wxTextCtrl *	mDryWetT

wxTextCtrl *	mFreqT

wxTextCtrl *	mPhaseT

wxTextCtrl *	mDepthT

wxTextCtrl *	mFeedbackT

wxTextCtrl *	mOutGainT

wxSlider *	mStagesS

wxSlider *	mDryWetS

wxSlider *	mFreqS

wxSlider *	mPhaseS

wxSlider *	mDepthS

wxSlider *	mFeedbackS

wxSlider *	mOutGainS

Static Private Attributes
static constexpr EffectParameter	Stages

static constexpr EffectParameter	DryWet

static constexpr EffectParameter	Freq

static constexpr EffectParameter	Phase

static constexpr EffectParameter	Depth

static constexpr EffectParameter	Feedback

static constexpr EffectParameter	OutGain

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

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

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

Protected Member Functions inherited from PerTrackEffect
bool	DoPass1 () const

bool	DoPass2 () const

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

Protected Member Functions inherited from Effect
bool	EnablePreview (bool enable=true)

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

virtual std::unique_ptr< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)
	Add controls to effect panel; always succeeds. 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)

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

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

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

Protected Member Functions inherited from EffectBase
void	Preview (EffectSettingsAccess &access, bool dryOnly) override

bool	DoEffect (EffectSettings &settings, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent, const EffectDialogFactory &dialogFactory, const EffectSettingsAccessPtr &pAccess) override
	Unfortunately complicated dual-use function. More...

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

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

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	ReplaceProcessedTracks (const bool bGoodResult)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

virtual bool	ValidateUI (EffectSettings &settings)=0

virtual bool	CloseUI ()=0

Protected Attributes inherited from PerTrackEffect
sampleCount	mSampleCnt {}

Protected Attributes inherited from Effect
wxWeakRef< wxDialog >	mHostUIDialog
	This smart pointer tracks the lifetime of the dialog. More...

wxWindow *	mUIParent {}

Protected Attributes inherited from EffectBase
BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

std::shared_ptr< TrackList >	mOutputTracks

double	mT0 {}

double	mT1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Protected Attributes inherited from EffectUIClientInterface
friend	EffectUIValidator

friend	DefaultEffectUIValidator

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

An Effect that changes frequencies in a time varying manner.

Definition at line 43 of file Phaser.h.

Constructor & Destructor Documentation

◆ EffectPhaser()

EffectPhaser::EffectPhaser ( )

Definition at line 91 of file Phaser.cpp.

{
   Parameters().Reset(*this);
   SetLinearEffectFlag(true);
}

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectPhaser()

EffectPhaser::~EffectPhaser ( )

virtual

Definition at line 97 of file Phaser.cpp.

98{

99}

Member Function Documentation

◆ FetchParameters()

static EffectPhaser * EffectPhaser::FetchParameters	(	EffectPhaser &	e,
		EffectSettings &
	)

inlinestatic

Definition at line 47 of file Phaser.h.

47{ return &e; }

◆ GetAudioInCount()

unsigned EffectPhaser::GetAudioInCount ( ) const

overridevirtual

How many input buffers to allocate at once.

If the effect ALWAYS processes channels independently, this can return 1

Reimplemented from Effect.

Definition at line 132 of file Phaser.cpp.

{
   return 1;
}

◆ GetAudioOutCount()

unsigned EffectPhaser::GetAudioOutCount ( ) const

overridevirtual

How many output buffers to allocate at once.

Reimplemented from Effect.

Definition at line 137 of file Phaser.cpp.

{
   return 1;
}

◆ GetDescription()

TranslatableString EffectPhaser::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 108 of file Phaser.cpp.

{
   return XO("Combines phase-shifted signals with the original signal");
}

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectPhaser::GetSymbol ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 103 of file Phaser.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType EffectPhaser::GetType ( ) const

overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 120 of file Phaser.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

◆ InstanceInit()

void EffectPhaser::InstanceInit	(	EffectPhaserState &	data,
		float	sampleRate
	)

private

Definition at line 313 of file Phaser.cpp.

{
   data.samplerate = sampleRate;
 
   for (int j = 0; j < mStages; j++)
   {
      data.old[j] = 0;
   }
 
   data.skipcount = 0;
   data.gain = 0;
   data.fbout = 0;
   data.laststages = 0;
   data.outgain = 0;
 
   return;
}

References EffectPhaserState::fbout, EffectPhaserState::gain, EffectPhaserState::laststages, mStages, EffectPhaserState::old, EffectPhaserState::outgain, EffectPhaserState::samplerate, and EffectPhaserState::skipcount.

Referenced by ProcessInitialize(), and RealtimeAddProcessor().

Here is the caller graph for this function:

◆ InstanceProcess()

size_t EffectPhaser::InstanceProcess	(	EffectSettings &	settings,
		EffectPhaserState &	data,
		const float const	inBlock,
		float const	outBlock,
		size_t	blockLen
	)

private

Definition at line 331 of file Phaser.cpp.

{
   const float *ibuf = inBlock[0];
   float *obuf = outBlock[0];
 
   for (int j = data.laststages; j < mStages; j++)
   {
      data.old[j] = 0;
   }
   data.laststages = mStages;
 
   data.lfoskip = mFreq * 2 * M_PI / data.samplerate;
   data.phase = mPhase * M_PI / 180;
   data.outgain = DB_TO_LINEAR(mOutGain);
 
   for (decltype(blockLen) i = 0; i < blockLen; i++)
   {
      double in = ibuf[i];
 
      double m = in + data.fbout * mFeedback / 101;  // Feedback must be less than 100% to avoid infinite gain.
 
      if (((data.skipcount++) % lfoskipsamples) == 0)
      {
         //compute sine between 0 and 1
         data.gain =
            (1.0 +
             cos(data.skipcount.as_double() * data.lfoskip
                 + data.phase)) / 2.0;
 
         // change lfo shape
         data.gain = expm1(data.gain * phaserlfoshape) / expm1(phaserlfoshape);
 
         // attenuate the lfo
         data.gain = 1.0 - data.gain / 255.0 * mDepth;
      }
 
      // phasing routine
      for (int j = 0; j < mStages; j++)
      {
         double tmp = data.old[j];
         data.old[j] = data.gain * tmp + m;
         m = tmp - data.gain * data.old[j];
      }
      data.fbout = m;
 
      obuf[i] = (float) (data.outgain * (m * mDryWet + in * (255 - mDryWet)) / 255);
   }
 
   return blockLen;
}

References sampleCount::as_double(), DB_TO_LINEAR, EffectPhaserState::fbout, EffectPhaserState::gain, EffectPhaserState::laststages, EffectPhaserState::lfoskip, lfoskipsamples, M_PI, mDepth, mDryWet, mFeedback, mFreq, mOutGain, mPhase, mStages, EffectPhaserState::old, EffectPhaserState::outgain, EffectPhaserState::phase, phaserlfoshape, EffectPhaserState::samplerate, and EffectPhaserState::skipcount.

Referenced by ProcessBlock(), and RealtimeProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ManualPage()

ManualPageID EffectPhaser::ManualPage ( ) const

overridevirtual

Name of a page in the Audacity alpha manual, default is empty.

Reimplemented from EffectDefinitionInterface.

Definition at line 113 of file Phaser.cpp.

{
   return L"Phaser";
}

◆ OnDepthSlider()

void EffectPhaser::OnDepthSlider ( wxCommandEvent & evt )

private

Definition at line 416 of file Phaser.cpp.

{
   mDepth = evt.GetInt() / Depth.scale;
   mDepthT->GetValidator()->TransferToWindow();
   EnableApply(mUIParent->Validate());
}

References Depth, Effect::EnableApply(), mDepth, mDepthT, Effect::mUIParent, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnDepthText()

void EffectPhaser::OnDepthText ( wxCommandEvent & evt )

private

Definition at line 481 of file Phaser.cpp.

{
   if (!EnableApply(mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mDepthS->SetValue((int) (mDepth * Depth.scale));
}

References Depth, Effect::EnableApply(), mDepth, mDepthS, Effect::mUIParent, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnDryWetSlider()

void EffectPhaser::OnDryWetSlider ( wxCommandEvent & evt )

private

Definition at line 391 of file Phaser.cpp.

{
   mDryWet = evt.GetInt() / DryWet.scale;
   mDryWetT->GetValidator()->TransferToWindow();
   EnableApply(mUIParent->Validate());
}

References DryWet, Effect::EnableApply(), mDryWet, mDryWetT, Effect::mUIParent, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnDryWetText()

void EffectPhaser::OnDryWetText ( wxCommandEvent & evt )

private

Definition at line 451 of file Phaser.cpp.

{
   if (!EnableApply(mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mDryWetS->SetValue((int) (mDryWet * DryWet.scale));
}

References DryWet, Effect::EnableApply(), mDryWet, mDryWetS, Effect::mUIParent, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnFeedbackSlider()

void EffectPhaser::OnFeedbackSlider ( wxCommandEvent & evt )

private

Definition at line 423 of file Phaser.cpp.

{
   int val = evt.GetInt();
   val = ((val + (val > 0 ? 5 : -5)) / 10) * 10; // round to nearest multiple of 10
   val = val > Feedback.max * Feedback.scale ? Feedback.max * Feedback.scale : val;
   mFeedbackS->SetValue(val);
   mFeedback = val / Feedback.scale;
   mFeedbackT->GetValidator()->TransferToWindow();
   EnableApply(mUIParent->Validate());
}

References Effect::EnableApply(), Feedback, EffectParameter< Structure, Member, Type, Value >::max, mFeedback, mFeedbackS, mFeedbackT, Effect::mUIParent, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnFeedbackText()

void EffectPhaser::OnFeedbackText ( wxCommandEvent & evt )

private

Definition at line 491 of file Phaser.cpp.

{
   if (!EnableApply(mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mFeedbackS->SetValue((int) (mFeedback * Feedback.scale));
}

References Effect::EnableApply(), Feedback, mFeedback, mFeedbackS, Effect::mUIParent, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnFreqSlider()

void EffectPhaser::OnFreqSlider ( wxCommandEvent & evt )

private

Definition at line 398 of file Phaser.cpp.

{
   mFreq = (double) evt.GetInt() / Freq.scale;
   if (mFreq < Freq.min) mFreq = Freq.min;
   mFreqT->GetValidator()->TransferToWindow();
   EnableApply(mUIParent->Validate());
}

References Effect::EnableApply(), Freq, mFreq, mFreqT, EffectParameter< Structure, Member, Type, Value >::min, Effect::mUIParent, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnFreqText()

void EffectPhaser::OnFreqText ( wxCommandEvent & evt )

private

Definition at line 461 of file Phaser.cpp.

{
   if (!EnableApply(mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mFreqS->SetValue((int) (mFreq * Freq.scale));
}

References Effect::EnableApply(), Freq, mFreq, mFreqS, Effect::mUIParent, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnGainSlider()

void EffectPhaser::OnGainSlider ( wxCommandEvent & evt )

private

Definition at line 434 of file Phaser.cpp.

{
   mOutGain = evt.GetInt() / OutGain.scale;
   mOutGainT->GetValidator()->TransferToWindow();
   EnableApply(mUIParent->Validate());
}

References Effect::EnableApply(), mOutGain, mOutGainT, Effect::mUIParent, OutGain, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnGainText()

void EffectPhaser::OnGainText ( wxCommandEvent & evt )

private

Definition at line 501 of file Phaser.cpp.

{
   if (!EnableApply(mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mOutGainS->SetValue((int) (mOutGain * OutGain.scale));
}

References Effect::EnableApply(), mOutGain, mOutGainS, Effect::mUIParent, OutGain, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnPhaseSlider()

void EffectPhaser::OnPhaseSlider ( wxCommandEvent & evt )

private

Definition at line 406 of file Phaser.cpp.

{
   int val = ((evt.GetInt() + 5) / 10) * 10; // round to nearest multiple of 10
   val = val > Phase.max * Phase.scale ? Phase.max * Phase.scale : val;
   mPhaseS->SetValue(val);
   mPhase =  (double) val / Phase.scale;
   mPhaseT->GetValidator()->TransferToWindow();
   EnableApply(mUIParent->Validate());
}

References Effect::EnableApply(), EffectParameter< Structure, Member, Type, Value >::max, mPhase, mPhaseS, mPhaseT, Effect::mUIParent, Phase, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnPhaseText()

void EffectPhaser::OnPhaseText ( wxCommandEvent & evt )

private

Definition at line 471 of file Phaser.cpp.

{
   if (!EnableApply(mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mPhaseS->SetValue((int) (mPhase * Phase.scale));
}

References Effect::EnableApply(), mPhase, mPhaseS, Effect::mUIParent, Phase, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ OnStagesSlider()

void EffectPhaser::OnStagesSlider ( wxCommandEvent & evt )

private

Definition at line 384 of file Phaser.cpp.

{
   mStages = (evt.GetInt() / Stages.scale) & ~1;  // must be even;
   mStagesT->GetValidator()->TransferToWindow();
   EnableApply(mUIParent->Validate());
}

References Effect::EnableApply(), mStages, mStagesT, Effect::mUIParent, EffectParameter< Structure, Member, Type, Value >::scale, and Stages.

Here is the call graph for this function:

◆ OnStagesText()

void EffectPhaser::OnStagesText ( wxCommandEvent & evt )

private

Definition at line 441 of file Phaser.cpp.

{
   if (!EnableApply(mUIParent->TransferDataFromWindow()))
   {
      return;
   }
 
   mStagesS->SetValue((int) (mStages * Stages.scale));
}

References Effect::EnableApply(), mStages, mStagesS, Effect::mUIParent, EffectParameter< Structure, Member, Type, Value >::scale, and Stages.

Here is the call graph for this function:

◆ Parameters()

const EffectParameterMethods & EffectPhaser::Parameters ( ) const

overrideprivatevirtual

Reimplemented from Effect.

Definition at line 45 of file Phaser.cpp.

{
   static CapturedParameters<EffectPhaser,
      Stages, DryWet, Freq, Phase, Depth, Feedback, OutGain
   > parameters{
      [](EffectPhaser &, EffectSettings &, EffectPhaser &e, bool updating){
         if (updating)
            e.mStages &= ~1; // must be even, but don't complain about it
         return true;
      },
   };
   return parameters;
}

References Depth, DryWet, EffectPhaser(), Feedback, Freq, OutGain, Phase, and Stages.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectUIValidator > EffectPhaser::PopulateOrExchange	(	ShuttleGui &	S,
		EffectInstance &	instance,
		EffectSettingsAccess &	access
	)

overridevirtual

Add controls to effect panel; always succeeds.

Returns: if not null, then return it from Effect::PopulateUI instead of a DefaultEffectUIValidator; default implementation returns null

Reimplemented from Effect.

Definition at line 193 of file Phaser.cpp.

{
   S.SetBorder(5);
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol(2);
 
      mStagesT = S.Id(ID_Stages)
         .Validator<IntegerValidator<int>>(
            &mStages, NumValidatorStyle::DEFAULT, Stages.min, Stages.max)
         .AddTextBox(XXO("&Stages:"), L"", 15);
 
      mStagesS = S.Id(ID_Stages)
         .Name(XO("Stages"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Stages.def * Stages.scale, Stages.max * Stages.scale, Stages.min * Stages.scale);
      mStagesS->SetLineSize(2);
 
      mDryWetT = S.Id(ID_DryWet)
         .Validator<IntegerValidator<int>>(
            &mDryWet, NumValidatorStyle::DEFAULT, DryWet.min, DryWet.max)
         .AddTextBox(XXO("&Dry/Wet:"), L"", 15);
 
      mDryWetS = S.Id(ID_DryWet)
         .Name(XO("Dry Wet"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, DryWet.def * DryWet.scale, DryWet.max * DryWet.scale, DryWet.min * DryWet.scale);
 
      mFreqT = S.Id(ID_Freq)
         .Validator<FloatingPointValidator<double>>(
            5, &mFreq, NumValidatorStyle::ONE_TRAILING_ZERO, Freq.min, Freq.max)
         .AddTextBox(XXO("LFO Freq&uency (Hz):"), L"", 15);
 
      mFreqS = S.Id(ID_Freq)
         .Name(XO("LFO frequency in hertz"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Freq.def * Freq.scale, Freq.max * Freq.scale, 0.0);
 
      mPhaseT = S.Id(ID_Phase)
         .Validator<FloatingPointValidator<double>>(
            1, &mPhase, NumValidatorStyle::DEFAULT, Phase.min, Phase.max)
         .AddTextBox(XXO("LFO Sta&rt Phase (deg.):"), L"", 15);
 
      mPhaseS = S.Id(ID_Phase)
         .Name(XO("LFO start phase in degrees"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Phase.def * Phase.scale, Phase.max * Phase.scale, Phase.min * Phase.scale);
      mPhaseS->SetLineSize(10);
 
      mDepthT = S.Id(ID_Depth)
         .Validator<IntegerValidator<int>>(
            &mDepth, NumValidatorStyle::DEFAULT, Depth.min, Depth.max)
         .AddTextBox(XXO("Dept&h:"), L"", 15);
 
      mDepthS = S.Id(ID_Depth)
         .Name(XO("Depth in percent"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Depth.def * Depth.scale, Depth.max * Depth.scale, Depth.min * Depth.scale);
 
      mFeedbackT = S.Id(ID_Feedback)
         .Validator<IntegerValidator<int>>(
            &mFeedback, NumValidatorStyle::DEFAULT, Feedback.min, Feedback.max)
         .AddTextBox(XXO("Feedbac&k (%):"), L"", 15);
 
      mFeedbackS = S.Id(ID_Feedback)
         .Name(XO("Feedback in percent"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, Feedback.def * Feedback.scale, Feedback.max * Feedback.scale, Feedback.min * Feedback.scale);
      mFeedbackS->SetLineSize(10);
 
      mOutGainT = S.Id(ID_OutGain)
         .Validator<FloatingPointValidator<double>>(
            1, &mOutGain, NumValidatorStyle::DEFAULT, OutGain.min, OutGain.max)
         .AddTextBox(XXO("&Output gain (dB):"), L"", 12);
 
      mOutGainS = S.Id(ID_OutGain)
         .Name(XO("Output gain (dB)"))
         .Style(wxSL_HORIZONTAL)
         .MinSize( { 100, -1 } )
         .AddSlider( {}, OutGain.def * OutGain.scale, OutGain.max * OutGain.scale, OutGain.min * OutGain.scale);
   }
   S.EndMultiColumn();
   return nullptr;
}

References EffectParameter< Structure, Member, Type, Value >::def, Depth, DryWet, Feedback, Freq, ID_Depth, ID_DryWet, ID_Feedback, ID_Freq, ID_OutGain, ID_Phase, ID_Stages, EffectParameter< Structure, Member, Type, Value >::max, mDepth, mDepthS, mDepthT, mDryWet, mDryWetS, mDryWetT, mFeedback, mFeedbackS, mFeedbackT, mFreq, mFreqS, mFreqT, EffectParameter< Structure, Member, Type, Value >::min, mOutGain, mOutGainS, mOutGainT, mPhase, mPhaseS, mPhaseT, mStages, mStagesS, mStagesT, OutGain, Phase, S, EffectParameter< Structure, Member, Type, Value >::scale, Stages, XO, and XXO.

◆ ProcessBlock()

size_t EffectPhaser::ProcessBlock	(	EffectSettings &	settings,
		const float const	inBlock,
		float const	outBlock,
		size_t	blockLen
	)

overridevirtual

Called for destructive effect computation.

Reimplemented from StatefulPerTrackEffect.

Definition at line 151 of file Phaser.cpp.

{
   return InstanceProcess(settings, mMaster, inBlock, outBlock, blockLen);
}

References InstanceProcess(), mMaster, and settings().

Here is the call graph for this function:

◆ ProcessInitialize()

bool EffectPhaser::ProcessInitialize	(	EffectSettings &	settings,
		double	sampleRate,
		sampleCount	totalLen,
		ChannelNames	chanMap
	)

overridevirtual

Called at start of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true

Reimplemented from StatefulPerTrackEffect.

Definition at line 142 of file Phaser.cpp.

{
   InstanceInit(mMaster, sampleRate);
   if (chanMap[0] == ChannelNameFrontRight)
      mMaster.phase += M_PI;
   return true;
}

References ChannelNameFrontRight, InstanceInit(), M_PI, mMaster, and EffectPhaserState::phase.

Here is the call graph for this function:

◆ RealtimeAddProcessor()

bool EffectPhaser::RealtimeAddProcessor	(	EffectSettings &	settings,
		unsigned	numChannels,
		float	sampleRate
	)

overridevirtual

Returns: success Default implementation does nothing, returns true Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 164 of file Phaser.cpp.

{
   EffectPhaserState slave;
 
   InstanceInit(slave, sampleRate);
 
   mSlaves.push_back(slave);
 
   return true;
}

References InstanceInit(), and mSlaves.

Here is the call graph for this function:

◆ RealtimeFinalize()

bool EffectPhaser::RealtimeFinalize ( EffectSettings & settings )

overridevirtualnoexcept

Returns: success Default implementation does nothing, returns true Default implementation does nothing, returns false

Reimplemented from StatefulEffectBase.

Definition at line 176 of file Phaser.cpp.

{
   mSlaves.clear();
 
   return true;
}

◆ RealtimeInitialize()

bool EffectPhaser::RealtimeInitialize	(	EffectSettings &	settings,
		double	sampleRate
	)

overridevirtual

Returns: success Default implementation does nothing, returns false (so assume realtime is not supported). Other member functions related to realtime return true or zero, but will not be called, unless a derived class overrides RealtimeInitialize. Default implementation does nothing, returns false

Reimplemented from StatefulEffectBase.

Definition at line 157 of file Phaser.cpp.

{
   SetBlockSize(512);
   mSlaves.clear();
   return true;
}

References mSlaves, and StatefulPerTrackEffect::SetBlockSize().

Here is the call graph for this function:

◆ RealtimeProcess()

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

overridevirtual

Returns: success Default implementation does nothing, returns 0 Default implementation does nothing, returns 0

Reimplemented from StatefulEffectBase.

Definition at line 183 of file Phaser.cpp.

{
   if (group >= mSlaves.size())
      return 0;
   return InstanceProcess(settings, mSlaves[group], inbuf, outbuf, numSamples);
}

References InstanceProcess(), mSlaves, and settings().

Here is the call graph for this function:

◆ RealtimeSupport()

auto EffectPhaser::RealtimeSupport ( ) const

overridevirtual

Since which version of Audacity has the effect supported realtime?

Reimplemented from Effect.

Definition at line 125 of file Phaser.cpp.

{
   // TODO reenable after achieving statelessness
   return RealtimeSince::Never;
//   return RealtimeSince::Always;
}

References EffectDefinitionInterface::Never.

◆ TransferDataFromWindow()

bool EffectPhaser::TransferDataFromWindow ( EffectSettings & settings )

overridevirtual

Update the given settings from controls.

Reimplemented from Effect.

Definition at line 300 of file Phaser.cpp.

{
   if (mStages & 1)    // must be even
   {
      mStages &= ~1;
      mStagesT->GetValidator()->TransferToWindow();
   }
 
   return true;
}

References mStages, and mStagesT.

◆ TransferDataToWindow()

bool EffectPhaser::TransferDataToWindow ( const EffectSettings & settings )

overridevirtual

Update controls for the settings.

Reimplemented from Effect.

Definition at line 287 of file Phaser.cpp.

{
   mStagesS->SetValue((int) (mStages * Stages.scale));
   mDryWetS->SetValue((int) (mDryWet * DryWet.scale));
   mFreqS->SetValue((int) (mFreq * Freq.scale));
   mPhaseS->SetValue((int) (mPhase * Phase.scale));
   mDepthS->SetValue((int) (mDepth * Depth.scale));
   mFeedbackS->SetValue((int) (mFeedback * Feedback.scale));
   mOutGainS->SetValue((int) (mOutGain * OutGain.scale));
 
   return true;
}