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 () override

TranslatableString	GetDescription () override

wxString	ManualPage () override

EffectType	GetType () override

bool	SupportsRealtime () override

unsigned	GetAudioInCount () override

unsigned	GetAudioOutCount () override

bool	ProcessInitialize (sampleCount totalLen, ChannelNames chanMap=NULL) 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

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

bool	DefineParams (ShuttleParams &S) override

bool	GetAutomationParameters (CommandParameters &parms) override

bool	SetAutomationParameters (CommandParameters &parms) override

void	PopulateOrExchange (ShuttleGui &S) override

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () override

VendorSymbol	GetVendor () override

wxString	GetVersion () override

EffectFamilySymbol	GetFamily () override

bool	IsInteractive () override

bool	IsDefault () override

bool	IsLegacy () override

bool	SupportsAutomation () override

bool	SetHost (EffectHostInterface *host) 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	ProcessFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	RealtimeProcessStart () override

bool	RealtimeProcessEnd () override

bool	ShowInterface (wxWindow &parent, const EffectDialogFactory &factory, bool forceModal=false) 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	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 ()

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Phaser") }

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

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

size_t	InstanceProcess (EffectPhaserState &data, float inBlock, float 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)

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

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

Protected Member Functions inherited from Effect
virtual bool	Init ()

virtual bool	CheckWhetherSkipEffect ()

virtual bool	Process ()

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

Static Protected Attributes inherited from Effect
static int	nEffectsDone =0

Detailed Description

An Effect that changes frequencies in a time varying manner.

Definition at line 42 of file Phaser.h.

Constructor & Destructor Documentation

◆ EffectPhaser()

EffectPhaser::EffectPhaser ( )

Definition at line 89 of file Phaser.cpp.

 {
    mStages = DEF_Stages;
    mDryWet = DEF_DryWet;
    mFreq = DEF_Freq;
    mPhase = DEF_Phase;
    mDepth = DEF_Depth;
    mFeedback = DEF_Feedback;
    mOutGain = DEF_OutGain;
  
    SetLinearEffectFlag(true);
 }

◆ ~EffectPhaser()

EffectPhaser::~EffectPhaser ( )

virtual

Definition at line 102 of file Phaser.cpp.

103 {

104 }

Member Function Documentation

◆ DefineParams()

bool EffectPhaser::DefineParams ( ShuttleParams & S )

override

Definition at line 202 of file Phaser.cpp.

                                                   {
    S.SHUTTLE_PARAM( mStages,    Stages );
    S.SHUTTLE_PARAM( mDryWet,    DryWet );
    S.SHUTTLE_PARAM( mFreq,      Freq );
    S.SHUTTLE_PARAM( mPhase,     Phase );
    S.SHUTTLE_PARAM( mDepth,     Depth );
    S.SHUTTLE_PARAM( mFeedback,  Feedback );
    S.SHUTTLE_PARAM( mOutGain,   OutGain );
    return true;
 }

References mDepth, mDryWet, mFeedback, mFreq, mOutGain, mPhase, and mStages.

◆ GetAudioInCount()

unsigned EffectPhaser::GetAudioInCount ( )

overridevirtual

Reimplemented from Effect.

Definition at line 141 of file Phaser.cpp.

 {
    return 1;
 }

◆ GetAudioOutCount()

unsigned EffectPhaser::GetAudioOutCount ( )

overridevirtual

Reimplemented from Effect.

Definition at line 146 of file Phaser.cpp.

 {
    return 1;
 }

◆ GetAutomationParameters()

bool EffectPhaser::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 213 of file Phaser.cpp.

 {
    parms.Write(KEY_Stages, mStages);
    parms.Write(KEY_DryWet, mDryWet);
    parms.Write(KEY_Freq, mFreq);
    parms.Write(KEY_Phase, mPhase);
    parms.Write(KEY_Depth, mDepth);
    parms.Write(KEY_Feedback, mFeedback);
    parms.Write(KEY_OutGain, mOutGain);
  
    return true;
 }

References mDepth, mDryWet, mFeedback, mFreq, mOutGain, mPhase, and mStages.

◆ GetDescription()

TranslatableString EffectPhaser::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 113 of file Phaser.cpp.

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

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectPhaser::GetSymbol ( )

overridevirtual

Reimplemented from Effect.

Definition at line 108 of file Phaser.cpp.

 {
    return Symbol;
 }

References Symbol.

◆ GetType()

EffectType EffectPhaser::GetType ( )

overridevirtual

Reimplemented from Effect.

Definition at line 125 of file Phaser.cpp.

 {
    return EffectTypeProcess;
 }

References EffectTypeProcess.

◆ InstanceInit()

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

private

Definition at line 382 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	(	EffectPhaserState &	data,
		float **	inBlock,
		float **	outBlock,
		size_t	blockLen
	)

private

Definition at line 400 of file Phaser.cpp.

 {
    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()

wxString EffectPhaser::ManualPage ( )

overridevirtual

Reimplemented from Effect.

Definition at line 118 of file Phaser.cpp.

 {
    return wxT("Phaser");
 }

◆ OnDepthSlider()

void EffectPhaser::OnDepthSlider ( wxCommandEvent & evt )

private

Definition at line 483 of file Phaser.cpp.

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

References Effect::EnableApply(), mDepth, mDepthT, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnDepthText()

void EffectPhaser::OnDepthText ( wxCommandEvent & evt )

private

Definition at line 548 of file Phaser.cpp.

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

References Effect::EnableApply(), mDepth, mDepthS, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnDryWetSlider()

void EffectPhaser::OnDryWetSlider ( wxCommandEvent & evt )

private

Definition at line 458 of file Phaser.cpp.

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

References Effect::EnableApply(), mDryWet, mDryWetT, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnDryWetText()

void EffectPhaser::OnDryWetText ( wxCommandEvent & evt )

private

Definition at line 518 of file Phaser.cpp.

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

References Effect::EnableApply(), mDryWet, mDryWetS, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnFeedbackSlider()

void EffectPhaser::OnFeedbackSlider ( wxCommandEvent & evt )

private

Definition at line 490 of file Phaser.cpp.

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

References Effect::EnableApply(), mFeedback, mFeedbackS, mFeedbackT, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnFeedbackText()

void EffectPhaser::OnFeedbackText ( wxCommandEvent & evt )

private

Definition at line 558 of file Phaser.cpp.

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

References Effect::EnableApply(), mFeedback, mFeedbackS, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnFreqSlider()

void EffectPhaser::OnFreqSlider ( wxCommandEvent & evt )

private

Definition at line 465 of file Phaser.cpp.

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

References Effect::EnableApply(), mFreq, mFreqT, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnFreqText()

void EffectPhaser::OnFreqText ( wxCommandEvent & evt )

private

Definition at line 528 of file Phaser.cpp.

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

References Effect::EnableApply(), mFreq, mFreqS, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnGainSlider()

void EffectPhaser::OnGainSlider ( wxCommandEvent & evt )

private

Definition at line 501 of file Phaser.cpp.

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

References Effect::EnableApply(), mOutGain, mOutGainT, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnGainText()

void EffectPhaser::OnGainText ( wxCommandEvent & evt )

private

Definition at line 568 of file Phaser.cpp.

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

References Effect::EnableApply(), mOutGain, mOutGainS, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnPhaseSlider()

void EffectPhaser::OnPhaseSlider ( wxCommandEvent & evt )

private

Definition at line 473 of file Phaser.cpp.

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

References Effect::EnableApply(), mPhase, mPhaseS, mPhaseT, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnPhaseText()

void EffectPhaser::OnPhaseText ( wxCommandEvent & evt )

private

Definition at line 538 of file Phaser.cpp.

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

References Effect::EnableApply(), mPhase, mPhaseS, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnStagesSlider()

void EffectPhaser::OnStagesSlider ( wxCommandEvent & evt )

private

Definition at line 451 of file Phaser.cpp.

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

References Effect::EnableApply(), mStages, mStagesT, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnStagesText()

void EffectPhaser::OnStagesText ( wxCommandEvent & evt )

private

Definition at line 508 of file Phaser.cpp.

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

References Effect::EnableApply(), mStages, mStagesS, and Effect::mUIParent.

Here is the call graph for this function:

◆ PopulateOrExchange()

void EffectPhaser::PopulateOrExchange ( ShuttleGui & S )

overridevirtual

Reimplemented from Effect.

Definition at line 254 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, MIN_Stages, MAX_Stages)
          .AddTextBox(XXO("&Stages:"), wxT(""), 15);
  
       mStagesS = S.Id(ID_Stages)
          .Name(XO("Stages"))
          .Style(wxSL_HORIZONTAL)
          .MinSize( { 100, -1 } )
          .AddSlider( {}, DEF_Stages * SCL_Stages, MAX_Stages * SCL_Stages, MIN_Stages * SCL_Stages);
       mStagesS->SetLineSize(2);
  
       mDryWetT = S.Id(ID_DryWet)
          .Validator<IntegerValidator<int>>(
             &mDryWet, NumValidatorStyle::DEFAULT, MIN_DryWet, MAX_DryWet)
          .AddTextBox(XXO("&Dry/Wet:"), wxT(""), 15);
  
       mDryWetS = S.Id(ID_DryWet)
          .Name(XO("Dry Wet"))
          .Style(wxSL_HORIZONTAL)
          .MinSize( { 100, -1 } )
          .AddSlider( {}, DEF_DryWet * SCL_DryWet, MAX_DryWet * SCL_DryWet, MIN_DryWet * SCL_DryWet);
  
       mFreqT = S.Id(ID_Freq)
          .Validator<FloatingPointValidator<double>>(
             5, &mFreq, NumValidatorStyle::ONE_TRAILING_ZERO, MIN_Freq, MAX_Freq)
          .AddTextBox(XXO("LFO Freq&uency (Hz):"), wxT(""), 15);
  
       mFreqS = S.Id(ID_Freq)
          .Name(XO("LFO frequency in hertz"))
          .Style(wxSL_HORIZONTAL)
          .MinSize( { 100, -1 } )
          .AddSlider( {}, DEF_Freq * SCL_Freq, MAX_Freq * SCL_Freq, 0.0);
  
       mPhaseT = S.Id(ID_Phase)
          .Validator<FloatingPointValidator<double>>(
             1, &mPhase, NumValidatorStyle::DEFAULT, MIN_Phase, MAX_Phase)
          .AddTextBox(XXO("LFO Sta&rt Phase (deg.):"), wxT(""), 15);
  
       mPhaseS = S.Id(ID_Phase)
          .Name(XO("LFO start phase in degrees"))
          .Style(wxSL_HORIZONTAL)
          .MinSize( { 100, -1 } )
          .AddSlider( {}, DEF_Phase * SCL_Phase, MAX_Phase * SCL_Phase, MIN_Phase * SCL_Phase);
       mPhaseS->SetLineSize(10);
  
       mDepthT = S.Id(ID_Depth)
          .Validator<IntegerValidator<int>>(
             &mDepth, NumValidatorStyle::DEFAULT, MIN_Depth, MAX_Depth)
          .AddTextBox(XXO("Dept&h:"), wxT(""), 15);
  
       mDepthS = S.Id(ID_Depth)
          .Name(XO("Depth in percent"))
          .Style(wxSL_HORIZONTAL)
          .MinSize( { 100, -1 } )
          .AddSlider( {}, DEF_Depth * SCL_Depth, MAX_Depth * SCL_Depth, MIN_Depth * SCL_Depth);
  
       mFeedbackT = S.Id(ID_Feedback)
          .Validator<IntegerValidator<int>>(
             &mFeedback, NumValidatorStyle::DEFAULT, MIN_Feedback, MAX_Feedback)
          .AddTextBox(XXO("Feedbac&k (%):"), wxT(""), 15);
  
       mFeedbackS = S.Id(ID_Feedback)
          .Name(XO("Feedback in percent"))
          .Style(wxSL_HORIZONTAL)
          .MinSize( { 100, -1 } )
          .AddSlider( {}, DEF_Feedback * SCL_Feedback, MAX_Feedback * SCL_Feedback, MIN_Feedback * SCL_Feedback);
       mFeedbackS->SetLineSize(10);
  
       mOutGainT = S.Id(ID_OutGain)
          .Validator<FloatingPointValidator<double>>(
             1, &mOutGain, NumValidatorStyle::DEFAULT, MIN_OutGain, MAX_OutGain)
          .AddTextBox(XXO("&Output gain (dB):"), wxT(""), 12);
  
       mOutGainS = S.Id(ID_OutGain)
          .Name(XO("Output gain (dB)"))
          .Style(wxSL_HORIZONTAL)
          .MinSize( { 100, -1 } )
          .AddSlider( {}, DEF_OutGain * SCL_OutGain, MAX_OutGain * SCL_OutGain, MIN_OutGain * SCL_OutGain);
    }
    S.EndMultiColumn();
 }

References ShuttleGui::AddSpace(), ShuttleGuiBase::EndMultiColumn(), ShuttleGui::Id(), ID_Depth, ID_DryWet, ID_Feedback, ID_Freq, ID_OutGain, ID_Phase, ID_Stages, mDepth, mDepthS, mDepthT, mDryWet, mDryWetS, mDryWetT, mFeedback, mFeedbackS, mFeedbackT, mFreq, mFreqS, mFreqT, ShuttleGui::MinSize(), mOutGain, mOutGainS, mOutGainT, mPhase, mPhaseS, mPhaseT, mStages, mStagesS, mStagesT, ShuttleGui::Name(), ShuttleGuiBase::SetBorder(), ShuttleGuiBase::SetStretchyCol(), ShuttleGuiBase::StartMultiColumn(), ShuttleGui::Validator(), XO, and XXO.

Here is the call graph for this function:

◆ ProcessBlock()

size_t EffectPhaser::ProcessBlock	(	float **	inBlock,
		float **	outBlock,
		size_t	blockLen
	)

overridevirtual

Reimplemented from Effect.

Definition at line 162 of file Phaser.cpp.

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

References InstanceProcess(), and mMaster.

Here is the call graph for this function:

◆ ProcessInitialize()

bool EffectPhaser::ProcessInitialize	(	sampleCount	totalLen,
		ChannelNames	chanMap = `NULL`
	)

overridevirtual

Reimplemented from Effect.

Definition at line 151 of file Phaser.cpp.

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

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

Here is the call graph for this function:

◆ RealtimeAddProcessor()

bool EffectPhaser::RealtimeAddProcessor	(	unsigned	numChannels,
		float	sampleRate
	)

overridevirtual

Reimplemented from Effect.

Definition at line 176 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 ( )

overridevirtual

Reimplemented from Effect.

Definition at line 187 of file Phaser.cpp.

 {
    mSlaves.clear();
  
    return true;
 }

References mSlaves.

◆ RealtimeInitialize()

bool EffectPhaser::RealtimeInitialize ( )

overridevirtual

Reimplemented from Effect.

Definition at line 167 of file Phaser.cpp.

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

References mSlaves, and Effect::SetBlockSize().

Here is the call graph for this function:

◆ RealtimeProcess()

size_t EffectPhaser::RealtimeProcess	(	int	group,
		float **	inbuf,
		float **	outbuf,
		size_t	numSamples
	)

overridevirtual

Reimplemented from Effect.

Definition at line 194 of file Phaser.cpp.

 {
  
    return InstanceProcess(mSlaves[group], inbuf, outbuf, numSamples);
 }

References InstanceProcess(), and mSlaves.

Here is the call graph for this function:

◆ SetAutomationParameters()

bool EffectPhaser::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 226 of file Phaser.cpp.

 {
    ReadAndVerifyInt(Stages);
    ReadAndVerifyInt(DryWet);
    ReadAndVerifyDouble(Freq);
    ReadAndVerifyDouble(Phase);
    ReadAndVerifyInt(Depth);
    ReadAndVerifyInt(Feedback);
    ReadAndVerifyDouble(OutGain);
  
    if (Stages & 1)    // must be even, but don't complain about it
    {
       Stages &= ~1;
    }
  
    mFreq = Freq;
    mFeedback = Feedback;
    mStages = Stages;
    mDryWet = DryWet;
    mDepth = Depth;
    mPhase = Phase;
    mOutGain = OutGain;
  
    return true;
 }

References mDepth, mDryWet, mFeedback, mFreq, mOutGain, mPhase, mStages, ReadAndVerifyDouble, and ReadAndVerifyInt.

◆ SupportsRealtime()

bool EffectPhaser::SupportsRealtime ( )

overridevirtual

Reimplemented from Effect.

Definition at line 130 of file Phaser.cpp.

 {
 #if defined(EXPERIMENTAL_REALTIME_AUDACITY_EFFECTS)
    return true;
 #else
    return false;
 #endif
 }

◆ TransferDataFromWindow()

bool EffectPhaser::TransferDataFromWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 364 of file Phaser.cpp.

 {
    if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
    {
       return false;
    }
  
    if (mStages & 1)    // must be even
    {
       mStages &= ~1;
       mStagesT->GetValidator()->TransferToWindow();
    }
  
    return true;
 }

References mStages, mStagesT, and Effect::mUIParent.

◆ TransferDataToWindow()

bool EffectPhaser::TransferDataToWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 346 of file Phaser.cpp.

 {
    if (!mUIParent->TransferDataToWindow())
    {
       return false;
    }
  
    mStagesS->SetValue((int) (mStages * SCL_Stages));
    mDryWetS->SetValue((int) (mDryWet * SCL_DryWet));
    mFreqS->SetValue((int) (mFreq * SCL_Freq));
    mPhaseS->SetValue((int) (mPhase * SCL_Phase));
    mDepthS->SetValue((int) (mDepth * SCL_Depth));
    mFeedbackS->SetValue((int) (mFeedback * SCL_Feedback));
    mOutGainS->SetValue((int) (mOutGain * SCL_OutGain));
  
    return true;
 }

References mDepth, mDepthS, mDryWet, mDryWetS, mFeedback, mFeedbackS, mFreq, mFreqS, mOutGain, mOutGainS, mPhase, mPhaseS, mStages, mStagesS, and Effect::mUIParent.

Member Data Documentation

◆ mDepth

int EffectPhaser::mDepth

private

Definition at line 126 of file Phaser.h.

Referenced by DefineParams(), GetAutomationParameters(), InstanceProcess(), OnDepthSlider(), OnDepthText(), PopulateOrExchange(), SetAutomationParameters(), and TransferDataToWindow().

◆ mDepthS

wxSlider* EffectPhaser::mDepthS

private

Definition at line 142 of file Phaser.h.

Referenced by OnDepthText(), PopulateOrExchange(), and TransferDataToWindow().

◆ mDepthT

wxTextCtrl* EffectPhaser::mDepthT

private

Definition at line 134 of file Phaser.h.

Referenced by OnDepthSlider(), and PopulateOrExchange().

◆ mDryWet

int EffectPhaser::mDryWet

private

Definition at line 123 of file Phaser.h.

Referenced by DefineParams(), GetAutomationParameters(), InstanceProcess(), OnDryWetSlider(), OnDryWetText(), PopulateOrExchange(), SetAutomationParameters(), and TransferDataToWindow().

◆ mDryWetS

wxSlider* EffectPhaser::mDryWetS

private

Definition at line 139 of file Phaser.h.

Referenced by OnDryWetText(), PopulateOrExchange(), and TransferDataToWindow().

◆ mDryWetT

wxTextCtrl* EffectPhaser::mDryWetT

private

Definition at line 131 of file Phaser.h.

Referenced by OnDryWetSlider(), and PopulateOrExchange().

◆ mFeedback

int EffectPhaser::mFeedback

private

Definition at line 127 of file Phaser.h.

Referenced by DefineParams(), GetAutomationParameters(), InstanceProcess(), OnFeedbackSlider(), OnFeedbackText(), PopulateOrExchange(), SetAutomationParameters(), and TransferDataToWindow().

◆ mFeedbackS

wxSlider* EffectPhaser::mFeedbackS

private

Definition at line 143 of file Phaser.h.

Referenced by OnFeedbackSlider(), OnFeedbackText(), PopulateOrExchange(), and TransferDataToWindow().

◆ mFeedbackT

wxTextCtrl* EffectPhaser::mFeedbackT

private

Definition at line 135 of file Phaser.h.

Referenced by OnFeedbackSlider(), and PopulateOrExchange().

◆ mFreq

double EffectPhaser::mFreq

private

Definition at line 124 of file Phaser.h.

Referenced by DefineParams(), GetAutomationParameters(), InstanceProcess(), OnFreqSlider(), OnFreqText(), PopulateOrExchange(), SetAutomationParameters(), and TransferDataToWindow().

◆ mFreqS

wxSlider* EffectPhaser::mFreqS

private

Definition at line 140 of file Phaser.h.

Referenced by OnFreqText(), PopulateOrExchange(), and TransferDataToWindow().

◆ mFreqT

wxTextCtrl* EffectPhaser::mFreqT

private

Definition at line 132 of file Phaser.h.

Referenced by OnFreqSlider(), and PopulateOrExchange().

◆ mMaster

EffectPhaserState EffectPhaser::mMaster

private

Definition at line 118 of file Phaser.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mOutGain

double EffectPhaser::mOutGain

private

Definition at line 128 of file Phaser.h.

Referenced by DefineParams(), GetAutomationParameters(), InstanceProcess(), OnGainSlider(), OnGainText(), PopulateOrExchange(), SetAutomationParameters(), and TransferDataToWindow().

◆ mOutGainS

wxSlider* EffectPhaser::mOutGainS

private

Definition at line 144 of file Phaser.h.

Referenced by OnGainText(), PopulateOrExchange(), and TransferDataToWindow().

◆ mOutGainT

wxTextCtrl* EffectPhaser::mOutGainT

private

Definition at line 136 of file Phaser.h.

Referenced by OnGainSlider(), and PopulateOrExchange().

◆ mPhase

double EffectPhaser::mPhase

private

Definition at line 125 of file Phaser.h.

Referenced by DefineParams(), GetAutomationParameters(), InstanceProcess(), OnPhaseSlider(), OnPhaseText(), PopulateOrExchange(), SetAutomationParameters(), and TransferDataToWindow().

◆ mPhaseS

wxSlider* EffectPhaser::mPhaseS

private

Definition at line 141 of file Phaser.h.

Referenced by OnPhaseSlider(), OnPhaseText(), PopulateOrExchange(), and TransferDataToWindow().

◆ mPhaseT

wxTextCtrl* EffectPhaser::mPhaseT

private

Definition at line 133 of file Phaser.h.

Referenced by OnPhaseSlider(), and PopulateOrExchange().

◆ mSlaves

std::vector<EffectPhaserState> EffectPhaser::mSlaves

private

Definition at line 119 of file Phaser.h.

Referenced by RealtimeAddProcessor(), RealtimeFinalize(), RealtimeInitialize(), and RealtimeProcess().

◆ mStages

int EffectPhaser::mStages

private

Definition at line 122 of file Phaser.h.

Referenced by DefineParams(), GetAutomationParameters(), InstanceInit(), InstanceProcess(), OnStagesSlider(), OnStagesText(), PopulateOrExchange(), SetAutomationParameters(), TransferDataFromWindow(), and TransferDataToWindow().

◆ mStagesS

wxSlider* EffectPhaser::mStagesS

private

Definition at line 138 of file Phaser.h.

Referenced by OnStagesText(), PopulateOrExchange(), and TransferDataToWindow().

◆ mStagesT

wxTextCtrl* EffectPhaser::mStagesT

private

Definition at line 130 of file Phaser.h.

Referenced by OnStagesSlider(), PopulateOrExchange(), and TransferDataFromWindow().

◆ Symbol

const ComponentInterfaceSymbol EffectPhaser::Symbol { XO("Phaser") }

static

Definition at line 45 of file Phaser.h.

Referenced by GetSymbol().

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

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectPhaser()

◆ ~EffectPhaser()

Member Function Documentation

◆ DefineParams()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetAutomationParameters()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ InstanceInit()

◆ InstanceProcess()

◆ ManualPage()

◆ OnDepthSlider()

◆ OnDepthText()

◆ OnDryWetSlider()

◆ OnDryWetText()

◆ OnFeedbackSlider()

◆ OnFeedbackText()

◆ OnFreqSlider()

◆ OnFreqText()

◆ OnGainSlider()

◆ OnGainText()

◆ OnPhaseSlider()

◆ OnPhaseText()

◆ OnStagesSlider()

◆ OnStagesText()

◆ PopulateOrExchange()

◆ ProcessBlock()

◆ ProcessInitialize()

◆ RealtimeAddProcessor()

◆ RealtimeFinalize()

◆ RealtimeInitialize()

◆ RealtimeProcess()

◆ SetAutomationParameters()

◆ SupportsRealtime()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

Member Data Documentation

◆ mDepth

◆ mDepthS

◆ mDepthT

◆ mDryWet

◆ mDryWetS

◆ mDryWetT

◆ mFeedback

◆ mFeedbackS

◆ mFeedbackT

◆ mFreq

◆ mFreqS

◆ mFreqT

◆ mMaster

◆ mOutGain

◆ mOutGainS

◆ mOutGainT

◆ mPhase

◆ mPhaseS

◆ mPhaseT

◆ mSlaves

◆ mStages

◆ mStagesS

◆ mStagesT

◆ Symbol