An Effect that adds a 'spectral glide'. More...

#include <Wahwah.h>

Inheritance diagram for EffectWahwah:

Collaboration diagram for EffectWahwah:

Public Member Functions
	EffectWahwah ()

virtual	~EffectWahwah ()

ComponentInterfaceSymbol	GetSymbol () override

TranslatableString	GetDescription () override

ManualPageID	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 FilePath	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("Wahwah") }

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 (EffectWahwahState &data, float sampleRate)

size_t	InstanceProcess (EffectWahwahState &data, float inBlock, float outBlock, size_t blockLen)

void	OnFreqSlider (wxCommandEvent &evt)

void	OnPhaseSlider (wxCommandEvent &evt)

void	OnDepthSlider (wxCommandEvent &evt)

void	OnResonanceSlider (wxCommandEvent &evt)

void	OnFreqOffSlider (wxCommandEvent &evt)

void	OnGainSlider (wxCommandEvent &evt)

void	OnFreqText (wxCommandEvent &evt)

void	OnPhaseText (wxCommandEvent &evt)

void	OnDepthText (wxCommandEvent &evt)

void	OnResonanceText (wxCommandEvent &evt)

void	OnFreqOffText (wxCommandEvent &evt)

void	OnGainText (wxCommandEvent &evt)

Private Attributes
EffectWahwahState	mMaster

std::vector< EffectWahwahState >	mSlaves

double	mFreq

double	mPhase

int	mDepth

double	mRes

int	mFreqOfs

double	mOutGain

wxTextCtrl *	mFreqT

wxTextCtrl *	mPhaseT

wxTextCtrl *	mDepthT

wxTextCtrl *	mResT

wxTextCtrl *	mFreqOfsT

wxTextCtrl *	mOutGainT

wxSlider *	mFreqS

wxSlider *	mPhaseS

wxSlider *	mDepthS

wxSlider *	mResS

wxSlider *	mFreqOfsS

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 adds a 'spectral glide'.

Definition at line 39 of file Wahwah.h.

Constructor & Destructor Documentation

◆ EffectWahwah()

EffectWahwah::EffectWahwah ( )

Definition at line 81 of file Wahwah.cpp.

 {
    mFreq = DEF_Freq;
    mPhase = DEF_Phase;
    mDepth = DEF_Depth;
    mRes = DEF_Res;
    mFreqOfs = DEF_FreqOfs;
    mOutGain = DEF_OutGain;
  
    SetLinearEffectFlag(true);
 }

◆ ~EffectWahwah()

EffectWahwah::~EffectWahwah ( )

virtual

Definition at line 93 of file Wahwah.cpp.

94 {

95 }

Member Function Documentation

◆ DefineParams()

bool EffectWahwah::DefineParams ( ShuttleParams & S )

override

Definition at line 195 of file Wahwah.cpp.

                                                   {
    S.SHUTTLE_PARAM( mFreq, Freq );
    S.SHUTTLE_PARAM( mPhase, Phase );
    S.SHUTTLE_PARAM( mDepth, Depth );
    S.SHUTTLE_PARAM( mRes, Res );
    S.SHUTTLE_PARAM( mFreqOfs, FreqOfs );
    S.SHUTTLE_PARAM( mOutGain, OutGain );
    return true;
 }

References mDepth, mFreq, mFreqOfs, mOutGain, mPhase, and mRes.

◆ GetAudioInCount()

unsigned EffectWahwah::GetAudioInCount ( )

overridevirtual

Reimplemented from Effect.

Definition at line 132 of file Wahwah.cpp.

 {
    return 1;
 }

◆ GetAudioOutCount()

unsigned EffectWahwah::GetAudioOutCount ( )

overridevirtual

Reimplemented from Effect.

Definition at line 137 of file Wahwah.cpp.

 {
    return 1;
 }

◆ GetAutomationParameters()

bool EffectWahwah::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 205 of file Wahwah.cpp.

 {
    parms.Write(KEY_Freq, mFreq);
    parms.Write(KEY_Phase, mPhase);
    parms.Write(KEY_Depth, mDepth);
    parms.Write(KEY_Res, mRes);
    parms.Write(KEY_FreqOfs, mFreqOfs);
    parms.Write(KEY_OutGain, mOutGain);
    
    return true;
 }

References mDepth, mFreq, mFreqOfs, mOutGain, mPhase, and mRes.

◆ GetDescription()

TranslatableString EffectWahwah::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 104 of file Wahwah.cpp.

 {
    return XO("Rapid tone quality variations, like that guitar sound so popular in the 1970's");
 }

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectWahwah::GetSymbol ( )

overridevirtual

Reimplemented from Effect.

Definition at line 99 of file Wahwah.cpp.

 {
    return Symbol;
 }

References Symbol.

◆ GetType()

EffectType EffectWahwah::GetType ( )

overridevirtual

Reimplemented from Effect.

Definition at line 116 of file Wahwah.cpp.

 {
    return EffectTypeProcess;
 }

References EffectTypeProcess.

◆ InstanceInit()

void EffectWahwah::InstanceInit	(	EffectWahwahState &	data,
		float	sampleRate
	)

private

Definition at line 346 of file Wahwah.cpp.

 {
    data.samplerate = sampleRate;
    data.lfoskip = mFreq * 2 * M_PI / sampleRate;
    data.skipcount = 0;
    data.xn1 = 0;
    data.xn2 = 0;
    data.yn1 = 0;
    data.yn2 = 0;
    data.b0 = 0;
    data.b1 = 0;
    data.b2 = 0;
    data.a0 = 0;
    data.a1 = 0;
    data.a2 = 0;
  
    data.depth = mDepth / 100.0;
    data.freqofs = mFreqOfs / 100.0;
    data.phase = mPhase * M_PI / 180.0;
    data.outgain = DB_TO_LINEAR(mOutGain);
 }

Referenced by ProcessInitialize(), and RealtimeAddProcessor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InstanceProcess()

size_t EffectWahwah::InstanceProcess	(	EffectWahwahState &	data,
		float **	inBlock,
		float **	outBlock,
		size_t	blockLen
	)

private

Definition at line 368 of file Wahwah.cpp.

 {
    float *ibuf = inBlock[0];
    float *obuf = outBlock[0];
    double frequency, omega, sn, cs, alpha;
    double in, out;
  
    data.lfoskip = mFreq * 2 * M_PI / data.samplerate;
    data.depth = mDepth / 100.0;
    data.freqofs = mFreqOfs / 100.0;
  
    data.phase = mPhase * M_PI / 180.0;
    data.outgain = DB_TO_LINEAR(mOutGain);
  
    for (decltype(blockLen) i = 0; i < blockLen; i++)
    {
       in = (double) ibuf[i];
  
       if ((data.skipcount++) % lfoskipsamples == 0)
       {
          frequency = (1 + cos(data.skipcount * data.lfoskip + data.phase)) / 2;
          frequency = frequency * data.depth * (1 - data.freqofs) + data.freqofs;
          frequency = exp((frequency - 1) * 6);
          omega = M_PI * frequency;
          sn = sin(omega);
          cs = cos(omega);
          alpha = sn / (2 * mRes);
          data.b0 = (1 - cs) / 2;
          data.b1 = 1 - cs;
          data.b2 = (1 - cs) / 2;
          data.a0 = 1 + alpha;
          data.a1 = -2 * cs;
          data.a2 = 1 - alpha;
       };
       out = (data.b0 * in + data.b1 * data.xn1 + data.b2 * data.xn2 - data.a1 * data.yn1 - data.a2 * data.yn2) / data.a0;
       data.xn2 = data.xn1;
       data.xn1 = in;
       data.yn2 = data.yn1;
       data.yn1 = out;
       out *= data.outgain;
  
       obuf[i] = (float) out;
    }
  
    return blockLen;
 }

Referenced by ProcessBlock(), and RealtimeProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ManualPage()

ManualPageID EffectWahwah::ManualPage ( )

overridevirtual

Reimplemented from Effect.

Definition at line 109 of file Wahwah.cpp.

 {
    return L"Wahwah";
 }

◆ OnDepthSlider()

void EffectWahwah::OnDepthSlider ( wxCommandEvent & evt )

private

Definition at line 432 of file Wahwah.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 EffectWahwah::OnDepthText ( wxCommandEvent & evt )

private

Definition at line 480 of file Wahwah.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:

◆ OnFreqOffSlider()

void EffectWahwah::OnFreqOffSlider ( wxCommandEvent & evt )

private

Definition at line 446 of file Wahwah.cpp.

 {
    mFreqOfs = evt.GetInt() / SCL_FreqOfs;
    mFreqOfsT->GetValidator()->TransferToWindow();
    EnableApply(mUIParent->Validate());
 }

References Effect::EnableApply(), mFreqOfs, mFreqOfsT, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnFreqOffText()

void EffectWahwah::OnFreqOffText ( wxCommandEvent & evt )

private

Definition at line 500 of file Wahwah.cpp.

 {
    if (!EnableApply(mUIParent->TransferDataFromWindow()))
    {
       return;
    }
  
    mFreqOfsS->SetValue((int) (mFreqOfs * SCL_FreqOfs));
 }

References Effect::EnableApply(), mFreqOfs, mFreqOfsS, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnFreqSlider()

void EffectWahwah::OnFreqSlider ( wxCommandEvent & evt )

private

Definition at line 415 of file Wahwah.cpp.

 {
    mFreq = (double) evt.GetInt() / SCL_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 EffectWahwah::OnFreqText ( wxCommandEvent & evt )

private

Definition at line 460 of file Wahwah.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 EffectWahwah::OnGainSlider ( wxCommandEvent & evt )

private

Definition at line 453 of file Wahwah.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 EffectWahwah::OnGainText ( wxCommandEvent & evt )

private

Definition at line 510 of file Wahwah.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 EffectWahwah::OnPhaseSlider ( wxCommandEvent & evt )

private

Definition at line 422 of file Wahwah.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 EffectWahwah::OnPhaseText ( wxCommandEvent & evt )

private

Definition at line 470 of file Wahwah.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:

◆ OnResonanceSlider()

void EffectWahwah::OnResonanceSlider ( wxCommandEvent & evt )

private

Definition at line 439 of file Wahwah.cpp.

 {
    mRes = (double) evt.GetInt() / SCL_Res;
    mResT->GetValidator()->TransferToWindow();
    EnableApply(mUIParent->Validate());
 }

References Effect::EnableApply(), mRes, mResT, and Effect::mUIParent.

Here is the call graph for this function:

◆ OnResonanceText()

void EffectWahwah::OnResonanceText ( wxCommandEvent & evt )

private

Definition at line 490 of file Wahwah.cpp.

 {
    if (!EnableApply(mUIParent->TransferDataFromWindow()))
    {
       return;
    }
  
    mResS->SetValue((int) (mRes * SCL_Res));
 }

References Effect::EnableApply(), mRes, mResS, and Effect::mUIParent.

Here is the call graph for this function:

◆ PopulateOrExchange()

void EffectWahwah::PopulateOrExchange ( ShuttleGui & S )

overridevirtual

Reimplemented from Effect.

Definition at line 238 of file Wahwah.cpp.

 {
    S.SetBorder(5);
    S.AddSpace(0, 5);
  
    S.StartMultiColumn(3, wxEXPAND);
    {
       S.SetStretchyCol(2);
    
       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(""), 12);
  
       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, MIN_Freq * SCL_Freq);
  
       mPhaseT = S.Id(ID_Phase)
          .Validator<FloatingPointValidator<double>>(
             1, &mPhase, NumValidatorStyle::DEFAULT, MIN_Phase, MAX_Phase)
          .AddTextBox(XXO("LFO Sta&rt Phase (deg.):"), wxT(""), 12);
  
       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(""), 12);
  
       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);
  
       mResT = S.Id(ID_Res)
          .Validator<FloatingPointValidator<double>>(
             1, &mRes, NumValidatorStyle::DEFAULT, MIN_Res, MAX_Res)
          .AddTextBox(XXO("Reso&nance:"), wxT(""), 12);
  
       mResS = S.Id(ID_Res)
          .Name(XO("Resonance"))
          .Style(wxSL_HORIZONTAL)
          .MinSize( { 100, -1 } )
          .AddSlider( {}, DEF_Res * SCL_Res, MAX_Res * SCL_Res, MIN_Res * SCL_Res);
  
       mFreqOfsT = S.Id(ID_FreqOfs)
          .Validator<IntegerValidator<int>>(
             &mFreqOfs, NumValidatorStyle::DEFAULT, MIN_FreqOfs, MAX_FreqOfs)
          .AddTextBox(XXO("Wah Frequency Offse&t (%):"), wxT(""), 12);
  
       mFreqOfsS = S.Id(ID_FreqOfs)
          .Name(XO("Wah frequency offset in percent"))
          .Style(wxSL_HORIZONTAL)
          .MinSize( { 100, -1 } )
          .AddSlider( {}, DEF_FreqOfs * SCL_FreqOfs, MAX_FreqOfs * SCL_FreqOfs, MIN_FreqOfs * SCL_FreqOfs);
  
       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_Freq, ID_FreqOfs, ID_OutGain, ID_Phase, ID_Res, mDepth, mDepthS, mDepthT, mFreq, mFreqOfs, mFreqOfsS, mFreqOfsT, mFreqS, mFreqT, ShuttleGui::MinSize(), mOutGain, mOutGainS, mOutGainT, mPhase, mPhaseS, mPhaseT, mRes, mResS, mResT, ShuttleGui::Name(), ShuttleGuiBase::SetBorder(), ShuttleGuiBase::SetStretchyCol(), ShuttleGuiBase::StartMultiColumn(), ShuttleGui::Validator(), XO, and XXO.

Here is the call graph for this function:

◆ ProcessBlock()

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

overridevirtual

Reimplemented from Effect.

Definition at line 154 of file Wahwah.cpp.

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

References InstanceProcess(), and mMaster.

Here is the call graph for this function:

◆ ProcessInitialize()

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

overridevirtual

Reimplemented from Effect.

Definition at line 142 of file Wahwah.cpp.

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

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

Here is the call graph for this function:

◆ RealtimeAddProcessor()

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

overridevirtual

Reimplemented from Effect.

Definition at line 168 of file Wahwah.cpp.

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

References InstanceInit(), and mSlaves.

Here is the call graph for this function:

◆ RealtimeFinalize()

bool EffectWahwah::RealtimeFinalize ( )

overridevirtual

Reimplemented from Effect.

Definition at line 179 of file Wahwah.cpp.

 {
    mSlaves.clear();
  
    return true;
 }

References mSlaves.

◆ RealtimeInitialize()

bool EffectWahwah::RealtimeInitialize ( )

overridevirtual

Reimplemented from Effect.

Definition at line 159 of file Wahwah.cpp.

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

References mSlaves, and Effect::SetBlockSize().

Here is the call graph for this function:

◆ RealtimeProcess()

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

overridevirtual

Reimplemented from Effect.

Definition at line 186 of file Wahwah.cpp.

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

References InstanceProcess(), and mSlaves.

Here is the call graph for this function:

◆ SetAutomationParameters()

bool EffectWahwah::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 217 of file Wahwah.cpp.

 {
    ReadAndVerifyDouble(Freq);
    ReadAndVerifyDouble(Phase);
    ReadAndVerifyInt(Depth);
    ReadAndVerifyDouble(Res);
    ReadAndVerifyInt(FreqOfs);
    ReadAndVerifyDouble(OutGain);
  
    mFreq = Freq;
    mPhase = Phase;
    mDepth = Depth;
    mRes = Res;
    mFreqOfs = FreqOfs;
    mOutGain = OutGain;
  
    return true;
 }

References mDepth, mFreq, mFreqOfs, mOutGain, mPhase, mRes, ReadAndVerifyDouble, and ReadAndVerifyInt.

◆ SupportsRealtime()

bool EffectWahwah::SupportsRealtime ( )

overridevirtual

Reimplemented from Effect.

Definition at line 121 of file Wahwah.cpp.

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

◆ TransferDataFromWindow()

bool EffectWahwah::TransferDataFromWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 334 of file Wahwah.cpp.

 {
    if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
    {
       return false;
    }
  
    return true;
 }

References Effect::mUIParent.

◆ TransferDataToWindow()

bool EffectWahwah::TransferDataToWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 317 of file Wahwah.cpp.

 {
    if (!mUIParent->TransferDataToWindow())
    {
       return false;
    }
  
    mFreqS->SetValue((int) (mFreq * SCL_Freq));
    mPhaseS->SetValue((int) (mPhase * SCL_Phase));
    mDepthS->SetValue((int) (mDepth * SCL_Depth));
    mResS->SetValue((int) (mRes * SCL_Res));
    mFreqOfsS->SetValue((int) (mFreqOfs * SCL_FreqOfs));
    mOutGainS->SetValue((int) (mOutGain * SCL_OutGain));
  
    return true;
 }

References mDepth, mDepthS, mFreq, mFreqOfs, mFreqOfsS, mFreqS, mOutGain, mOutGainS, mPhase, mPhaseS, mRes, mResS, and Effect::mUIParent.

Member Data Documentation

◆ mDepth

int EffectWahwah::mDepth

private

Definition at line 119 of file Wahwah.h.

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

◆ mDepthS

wxSlider* EffectWahwah::mDepthS

private

Definition at line 133 of file Wahwah.h.

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

◆ mDepthT

wxTextCtrl* EffectWahwah::mDepthT

private

Definition at line 126 of file Wahwah.h.

Referenced by OnDepthSlider(), and PopulateOrExchange().

◆ mFreq

double EffectWahwah::mFreq

private

Definition at line 117 of file Wahwah.h.

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

◆ mFreqOfs

int EffectWahwah::mFreqOfs

private

Definition at line 121 of file Wahwah.h.

Referenced by DefineParams(), GetAutomationParameters(), InstanceInit(), InstanceProcess(), OnFreqOffSlider(), OnFreqOffText(), PopulateOrExchange(), SetAutomationParameters(), and TransferDataToWindow().

◆ mFreqOfsS

wxSlider* EffectWahwah::mFreqOfsS

private

Definition at line 135 of file Wahwah.h.

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

◆ mFreqOfsT

wxTextCtrl* EffectWahwah::mFreqOfsT

private

Definition at line 128 of file Wahwah.h.

Referenced by OnFreqOffSlider(), and PopulateOrExchange().

◆ mFreqS

wxSlider* EffectWahwah::mFreqS

private

Definition at line 131 of file Wahwah.h.

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

◆ mFreqT

wxTextCtrl* EffectWahwah::mFreqT

private

Definition at line 124 of file Wahwah.h.

Referenced by OnFreqSlider(), and PopulateOrExchange().

◆ mMaster

EffectWahwahState EffectWahwah::mMaster

private

Definition at line 102 of file Wahwah.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mOutGain

double EffectWahwah::mOutGain

private

Definition at line 122 of file Wahwah.h.

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

◆ mOutGainS

wxSlider* EffectWahwah::mOutGainS

private

Definition at line 136 of file Wahwah.h.

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

◆ mOutGainT

wxTextCtrl* EffectWahwah::mOutGainT

private

Definition at line 129 of file Wahwah.h.

Referenced by OnGainSlider(), and PopulateOrExchange().

◆ mPhase

double EffectWahwah::mPhase

private

Definition at line 118 of file Wahwah.h.

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

◆ mPhaseS

wxSlider* EffectWahwah::mPhaseS

private

Definition at line 132 of file Wahwah.h.

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

◆ mPhaseT

wxTextCtrl* EffectWahwah::mPhaseT

private

Definition at line 125 of file Wahwah.h.

Referenced by OnPhaseSlider(), and PopulateOrExchange().

◆ mRes

double EffectWahwah::mRes

private

Definition at line 120 of file Wahwah.h.

Referenced by DefineParams(), GetAutomationParameters(), InstanceProcess(), OnResonanceSlider(), OnResonanceText(), PopulateOrExchange(), SetAutomationParameters(), and TransferDataToWindow().

◆ mResS

wxSlider* EffectWahwah::mResS

private

Definition at line 134 of file Wahwah.h.

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

◆ mResT

wxTextCtrl* EffectWahwah::mResT

private

Definition at line 127 of file Wahwah.h.

Referenced by OnResonanceSlider(), and PopulateOrExchange().

◆ mSlaves

std::vector<EffectWahwahState> EffectWahwah::mSlaves

private

Definition at line 103 of file Wahwah.h.

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

◆ Symbol

const ComponentInterfaceSymbol EffectWahwah::Symbol { XO("Wahwah") }

static

Definition at line 42 of file Wahwah.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

◆ EffectWahwah()

◆ ~EffectWahwah()

Member Function Documentation

◆ DefineParams()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetAutomationParameters()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ InstanceInit()

◆ InstanceProcess()

◆ ManualPage()

◆ OnDepthSlider()

◆ OnDepthText()

◆ OnFreqOffSlider()

◆ OnFreqOffText()

◆ OnFreqSlider()

◆ OnFreqText()

◆ OnGainSlider()

◆ OnGainText()

◆ OnPhaseSlider()

◆ OnPhaseText()

◆ OnResonanceSlider()

◆ OnResonanceText()

◆ PopulateOrExchange()

◆ ProcessBlock()

◆ ProcessInitialize()

◆ RealtimeAddProcessor()

◆ RealtimeFinalize()

◆ RealtimeInitialize()

◆ RealtimeProcess()

◆ SetAutomationParameters()

◆ SupportsRealtime()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

Member Data Documentation

◆ mDepth

◆ mDepthS

◆ mDepthT

◆ mFreq

◆ mFreqOfs

◆ mFreqOfsS

◆ mFreqOfsT

◆ mFreqS

◆ mFreqT

◆ mMaster

◆ mOutGain

◆ mOutGainS

◆ mOutGainT

◆ mPhase

◆ mPhaseS

◆ mPhaseT

◆ mRes

◆ mResS

◆ mResT

◆ mSlaves

◆ Symbol