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

#include <Phaser.h>

Inheritance diagram for EffectPhaser:

Public Member Functions
	EffectPhaser ()

virtual	~EffectPhaser ()

IdentInterfaceSymbol	GetSymbol () override

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

wxString	GetPath () override

IdentInterfaceSymbol	GetVendor () override

wxString	GetVersion () override

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

bool	IsReady () override

bool	ProcessFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	RealtimeProcessStart () override

bool	RealtimeProcessEnd () override

bool	ShowInterface (wxWindow *parent, bool forceModal=false) override

bool	LoadUserPreset (const wxString &name) override

bool	SaveUserPreset (const wxString &name) override

wxArrayString	GetFactoryPresets () override

bool	LoadFactoryPreset (int id) override

bool	LoadFactoryDefaults () override

void	SetHostUI (EffectUIHostInterface *host) override

bool	PopulateUI (wxWindow *parent) override

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

NumericFormatId	GetDurationFormat () override

virtual NumericFormatId	GetSelectionFormat ()

void	SetDuration (double duration) override

bool	Apply () override

void	Preview () override

wxDialog *	CreateUI (wxWindow parent, EffectUIClientInterface client) override

wxString	GetUserPresetsGroup (const wxString &name) override

wxString	GetCurrentSettingsGroup () override

wxString	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

bool	HasSharedConfigGroup (const wxString &group) override

bool	GetSharedConfigSubgroups (const wxString &group, wxArrayString &subgroups) override

bool	GetSharedConfig (const wxString &group, const wxString &key, wxString &value, const wxString &defval=wxEmptyString) override

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

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

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

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

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

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

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

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

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

bool	RemoveSharedConfigSubgroup (const wxString &group) override

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

bool	HasPrivateConfigGroup (const wxString &group) override

bool	GetPrivateConfigSubgroups (const wxString &group, wxArrayString &subgroups) override

bool	GetPrivateConfig (const wxString &group, const wxString &key, wxString &value, const wxString &defval=wxEmptyString) override

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

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

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

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

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

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

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

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

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

bool	RemovePrivateConfigSubgroup (const wxString &group) override

bool	RemovePrivateConfig (const wxString &group, const wxString &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 wxArrayString	GetUserPresets ()

virtual bool	HasCurrentSettings ()

virtual bool	HasFactoryDefaults ()

virtual wxString	GetPreset (wxWindow *parent, const wxString &parms)

virtual wxString	HelpPage ()

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

bool	DoEffect (wxWindow parent, double projectRate, TrackList list, TrackFactory factory, SelectedRegion selectedRegion, bool shouldPrompt=true)

bool	Delegate (Effect &delegate, wxWindow *parent, bool shouldPrompt)

bool	RealtimeAddProcessor (int group, unsigned chans, float rate)

size_t	RealtimeProcess (int group, unsigned chans, float inbuf, float outbuf, size_t numSamples)

bool	IsRealtimeActive ()

virtual bool	IsHidden ()

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

Public Member Functions inherited from EffectClientInterface
virtual	~EffectClientInterface ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

Public Member Functions inherited from IdentInterface
virtual	~IdentInterface ()

const wxString &	GetTranslatedName ()

Public Member Functions inherited from ParamsInterface
virtual	~ParamsInterface ()

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

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 }

Protected Member Functions inherited from Effect
virtual bool	Init ()

virtual bool	PromptUser (wxWindow *parent)

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)

bool	TrackProgress (int whichTrack, double frac, const wxString &=wxEmptyString)

bool	TrackGroupProgress (int whichGroup, double frac, const wxString &=wxEmptyString)

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

void	GetSamples (const WaveTrack track, sampleCount start, sampleCount *len)

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks ()

void	CopyInputTracks (int trackType)

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 (std::unique_ptr< Track > &&t)

TrackList *	inputTracks () const

Protected Attributes inherited from Effect
ProgressDialog *	mProgress

double	mProjectRate

double	mSampleRate

SelectedRegion *	mpSelectedRegion {}

TrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

double	mF0

double	mF1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxDialog *	mUIDialog

wxWindow *	mUIParent

int	mUIResultID

sampleCount	mSampleCnt

int	mOutputTracksType

Detailed Description

An Effect that changes frequencies in a time varying manner.

Definition at line 47 of file Phaser.h.

Constructor & Destructor Documentation

EffectPhaser::EffectPhaser ( )

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

virtual

Definition at line 96 of file Phaser.cpp.

97 {

98 }

Member Function Documentation

bool EffectPhaser::DefineParams ( ShuttleParams & S )

override

Definition at line 196 of file Phaser.cpp.

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

                                                   {
    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;
 }

unsigned EffectPhaser::GetAudioInCount ( )

overridevirtual

Reimplemented from Effect.

Definition at line 135 of file Phaser.cpp.

 {
    return 1;
 }

unsigned EffectPhaser::GetAudioOutCount ( )

overridevirtual

Reimplemented from Effect.

Definition at line 140 of file Phaser.cpp.

 {
    return 1;
 }

bool EffectPhaser::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 207 of file Phaser.cpp.

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

 {
    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;
 }

wxString EffectPhaser::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 107 of file Phaser.cpp.

References _().

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

IdentInterfaceSymbol EffectPhaser::GetSymbol ( )

overridevirtual

Reimplemented from Effect.

Definition at line 102 of file Phaser.cpp.

References PHASER_PLUGIN_SYMBOL.

 {
    return PHASER_PLUGIN_SYMBOL;
 }

EffectType EffectPhaser::GetType ( )

overridevirtual

Reimplemented from Effect.

Definition at line 119 of file Phaser.cpp.

References EffectTypeProcess.

 {
    return EffectTypeProcess;
 }

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

private

Definition at line 369 of file Phaser.cpp.

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

Referenced by ProcessInitialize(), and RealtimeAddProcessor().

 {
    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;
 }

size_t EffectPhaser::InstanceProcess	(	EffectPhaserState &	data,
		float **	inBlock,
		float **	outBlock,
		size_t	blockLen
	)

private

Definition at line 387 of file Phaser.cpp.

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

 {
    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;
 }

wxString EffectPhaser::ManualPage ( )

overridevirtual

Reimplemented from Effect.

Definition at line 112 of file Phaser.cpp.

 {
    return wxT("Phaser");
 }

void EffectPhaser::OnDepthSlider ( wxCommandEvent & evt )

private

Definition at line 470 of file Phaser.cpp.

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

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

void EffectPhaser::OnDepthText ( wxCommandEvent & evt )

private

Definition at line 535 of file Phaser.cpp.

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

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

void EffectPhaser::OnDryWetSlider ( wxCommandEvent & evt )

private

Definition at line 445 of file Phaser.cpp.

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

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

void EffectPhaser::OnDryWetText ( wxCommandEvent & evt )

private

Definition at line 505 of file Phaser.cpp.

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

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

void EffectPhaser::OnFeedbackSlider ( wxCommandEvent & evt )

private

Definition at line 477 of file Phaser.cpp.

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

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

void EffectPhaser::OnFeedbackText ( wxCommandEvent & evt )

private

Definition at line 545 of file Phaser.cpp.

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

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

void EffectPhaser::OnFreqSlider ( wxCommandEvent & evt )

private

Definition at line 452 of file Phaser.cpp.

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

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

void EffectPhaser::OnFreqText ( wxCommandEvent & evt )

private

Definition at line 515 of file Phaser.cpp.

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

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

void EffectPhaser::OnGainSlider ( wxCommandEvent & evt )

private

Definition at line 488 of file Phaser.cpp.

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

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

void EffectPhaser::OnGainText ( wxCommandEvent & evt )

private

Definition at line 555 of file Phaser.cpp.

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

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

void EffectPhaser::OnPhaseSlider ( wxCommandEvent & evt )

private

Definition at line 460 of file Phaser.cpp.

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

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

void EffectPhaser::OnPhaseText ( wxCommandEvent & evt )

private

Definition at line 525 of file Phaser.cpp.

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

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

void EffectPhaser::OnStagesSlider ( wxCommandEvent & evt )

private

Definition at line 438 of file Phaser.cpp.

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

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

void EffectPhaser::OnStagesText ( wxCommandEvent & evt )

private

Definition at line 495 of file Phaser.cpp.

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

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

void EffectPhaser::PopulateOrExchange ( ShuttleGui & S )

overridevirtual

Reimplemented from Effect.

Definition at line 248 of file Phaser.cpp.

References _(), ShuttleGuiBase::AddSlider(), ShuttleGui::AddSpace(), ShuttleGuiBase::AddTextBox(), 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, mOutGain, mOutGainS, mOutGainT, mPhase, mPhaseS, mPhaseT, mStages, mStagesS, mStagesT, ShuttleGuiBase::SetBorder(), ShuttleGuiBase::SetStretchyCol(), ShuttleGuiBase::SetStyle(), and ShuttleGuiBase::StartMultiColumn().

 {
    S.SetBorder(5);
    S.AddSpace(0, 5);
 
    S.StartMultiColumn(3, wxEXPAND);
    {
       S.SetStretchyCol(2);
 
       IntegerValidator<int> vldStages(&mStages);
       vldStages.SetRange(MIN_Stages, MAX_Stages);
       mStagesT = S.Id(ID_Stages).AddTextBox(_("&Stages:"), wxT(""), 15);
       mStagesT->SetValidator(vldStages);
 
       S.SetStyle(wxSL_HORIZONTAL);
       mStagesS = S.Id(ID_Stages).AddSlider( {}, DEF_Stages * SCL_Stages, MAX_Stages * SCL_Stages, MIN_Stages * SCL_Stages);
       mStagesS->SetName(_("Stages"));
       mStagesS->SetLineSize(2);
       mStagesS->SetMinSize(wxSize(100, -1));
 
       IntegerValidator<int> vldDryWet(&mDryWet);
       vldDryWet.SetRange(MIN_DryWet, MAX_DryWet);
       mDryWetT = S.Id(ID_DryWet).AddTextBox(_("&Dry/Wet:"), wxT(""), 15);
       mDryWetT->SetValidator(vldDryWet);
 
       S.SetStyle(wxSL_HORIZONTAL);
       mDryWetS = S.Id(ID_DryWet).AddSlider( {}, DEF_DryWet * SCL_DryWet, MAX_DryWet * SCL_DryWet, MIN_DryWet * SCL_DryWet);
       mDryWetS->SetName(_("Dry Wet"));
       mDryWetS->SetMinSize(wxSize(100, -1));
 
       FloatingPointValidator<double> vldFreq(5, &mFreq, NumValidatorStyle::ONE_TRAILING_ZERO);
       vldFreq.SetRange(MIN_Freq, MAX_Freq);
       mFreqT = S.Id(ID_Freq).AddTextBox(_("LFO Freq&uency (Hz):"), wxT(""), 15);
       mFreqT->SetValidator(vldFreq);
 
       S.SetStyle(wxSL_HORIZONTAL);
       mFreqS = S.Id(ID_Freq).AddSlider( {}, DEF_Freq * SCL_Freq, MAX_Freq * SCL_Freq, 0.0);
       mFreqS ->SetName(_("LFO frequency in hertz"));
       mFreqS ->SetMinSize(wxSize(100, -1));
 
       FloatingPointValidator<double> vldPhase(1, &mPhase);
       vldPhase.SetRange(MIN_Phase, MAX_Phase);
       mPhaseT = S.Id(ID_Phase).AddTextBox(_("LFO Sta&rt Phase (deg.):"), wxT(""), 15);
       mPhaseT->SetValidator(vldPhase);
 
       S.SetStyle(wxSL_HORIZONTAL);
       mPhaseS = S.Id(ID_Phase).AddSlider( {}, DEF_Phase * SCL_Phase, MAX_Phase * SCL_Phase, MIN_Phase * SCL_Phase);
       mPhaseS->SetName(_("LFO start phase in degrees"));
       mPhaseS->SetLineSize(10);
       mPhaseS->SetMinSize(wxSize(100, -1));
 
       IntegerValidator<int> vldDepth(&mDepth);
       vldDepth.SetRange(MIN_Depth, MAX_Depth);
       mDepthT = S.Id(ID_Depth).AddTextBox(_("Dept&h:"), wxT(""), 15);
       mDepthT->SetValidator(vldDepth);
 
       S.SetStyle(wxSL_HORIZONTAL);
       mDepthS = S.Id(ID_Depth).AddSlider( {}, DEF_Depth * SCL_Depth, MAX_Depth * SCL_Depth, MIN_Depth * SCL_Depth);
       mDepthS->SetName(_("Depth in percent"));
       mDepthS->SetMinSize(wxSize(100, -1));
 
       IntegerValidator<int> vldFeedback(&mFeedback);
       vldFeedback.SetRange(MIN_Feedback, MAX_Feedback);
       mFeedbackT = S.Id(ID_Feedback).AddTextBox(_("Feedbac&k (%):"), wxT(""), 15);
       mFeedbackT->SetValidator(vldFeedback);
 
       S.SetStyle(wxSL_HORIZONTAL);
       mFeedbackS = S.Id(ID_Feedback).AddSlider( {}, DEF_Feedback * SCL_Feedback, MAX_Feedback * SCL_Feedback, MIN_Feedback * SCL_Feedback);
       mFeedbackS->SetName(_("Feedback in percent"));
       mFeedbackS->SetLineSize(10);
       mFeedbackS->SetMinSize(wxSize(100, -1));
 
       FloatingPointValidator<double> vldoutgain(1, &mOutGain);
       vldoutgain.SetRange(MIN_OutGain, MAX_OutGain);
       mOutGainT = S.Id(ID_OutGain).AddTextBox(_("&Output gain (dB):"), wxT(""), 12);
       mOutGainT->SetValidator(vldoutgain);
 
       S.SetStyle(wxSL_HORIZONTAL);
       mOutGainS = S.Id(ID_OutGain).AddSlider( {}, DEF_OutGain * SCL_OutGain, MAX_OutGain * SCL_OutGain, MIN_OutGain * SCL_OutGain);
       mOutGainS->SetName(_("Output gain (dB)"));
       mOutGainS->SetMinSize(wxSize(100, -1));
    }
    S.EndMultiColumn();
 }

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

overridevirtual

Reimplemented from Effect.

Definition at line 156 of file Phaser.cpp.

References InstanceProcess(), and mMaster.

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

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

overridevirtual

Reimplemented from Effect.

Definition at line 145 of file Phaser.cpp.

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

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

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

overridevirtual

Reimplemented from Effect.

Definition at line 170 of file Phaser.cpp.

References InstanceInit(), and mSlaves.

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

bool EffectPhaser::RealtimeFinalize ( )

overridevirtual

Reimplemented from Effect.

Definition at line 181 of file Phaser.cpp.

References mSlaves.

 {
    mSlaves.clear();
 
    return true;
 }

bool EffectPhaser::RealtimeInitialize ( )

overridevirtual

Reimplemented from Effect.

Definition at line 161 of file Phaser.cpp.

References mSlaves, and Effect::SetBlockSize().

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

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

overridevirtual

Reimplemented from Effect.

Definition at line 188 of file Phaser.cpp.

References InstanceProcess(), and mSlaves.

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

bool EffectPhaser::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 220 of file Phaser.cpp.

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

 {
    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;
 }

bool EffectPhaser::SupportsRealtime ( )

overridevirtual

Reimplemented from Effect.

Definition at line 124 of file Phaser.cpp.

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

bool EffectPhaser::TransferDataFromWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 351 of file Phaser.cpp.

References mStages, mStagesT, and Effect::mUIParent.

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

bool EffectPhaser::TransferDataToWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 333 of file Phaser.cpp.

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

 {
    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;
 }