Audacity  2.2.0
EffectWahwah Class Referencefinal

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

#include <Wahwah.h>

Inheritance diagram for EffectWahwah:
Effect

Public Member Functions

 EffectWahwah ()
 
virtual ~EffectWahwah ()
 
wxString 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 GetAutomationParameters (EffectAutomationParameters &parms) override
 
bool SetAutomationParameters (EffectAutomationParameters &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
 
wxString GetSymbol () override
 
wxString GetName () override
 
wxString GetVendor () override
 
wxString GetVersion () override
 
wxString GetDescription () override
 
EffectType GetType () override
 
wxString GetFamily () override
 
bool IsInteractive () override
 
bool IsDefault () override
 
bool IsLegacy () override
 
bool SupportsRealtime () override
 
bool SupportsAutomation () override
 
bool SetHost (EffectHostInterface *host) override
 
unsigned GetAudioInCount () override
 
unsigned GetAudioOutCount () override
 
int GetMidiInCount () override
 
int GetMidiOutCount () override
 
sampleCount GetLatency () override
 
size_t GetTailSize () override
 
void SetSampleRate (double rate) override
 
size_t SetBlockSize (size_t maxBlockSize) override
 
bool IsReady () override
 
bool ProcessInitialize (sampleCount totalLen, ChannelNames chanMap=NULL) override
 
bool ProcessFinalize () override
 
size_t ProcessBlock (float **inBlock, float **outBlock, size_t blockLen) override
 
bool RealtimeInitialize () override
 
bool RealtimeAddProcessor (unsigned numChannels, float sampleRate) override
 
bool RealtimeFinalize () override
 
bool RealtimeSuspend () override
 
bool RealtimeResume () override
 
bool RealtimeProcessStart () override
 
size_t RealtimeProcess (int group, float **inbuf, float **outbuf, size_t numSamples) override
 
bool RealtimeProcessEnd () override
 
bool ShowInterface (wxWindow *parent, bool forceModal=false) override
 
bool GetAutomationParameters (EffectAutomationParameters &parms) override
 
bool SetAutomationParameters (EffectAutomationParameters &parms) 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
 
wxString GetDurationFormat () override
 
virtual wxString 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, SelectedRegion *selectedRegion, 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{})
 

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
 
EffectWahwahStateArray 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 }
 
- 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)
 
TrackAddToOutputTracks (std::unique_ptr< Track > &&t)
 
TrackListinputTracks () const
 
- Protected Attributes inherited from Effect
ProgressDialogmProgress
 
double mProjectRate
 
double mSampleRate
 
TrackFactorymFactory
 
std::shared_ptr< TrackListmOutputTracks
 
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 adds a 'spectral glide'.

Constructor & Destructor Documentation

EffectWahwah::EffectWahwah ( )
EffectWahwah::~EffectWahwah ( )
virtual

Member Function Documentation

unsigned EffectWahwah::GetAudioInCount ( )
override
unsigned EffectWahwah::GetAudioOutCount ( )
override
bool EffectWahwah::GetAutomationParameters ( EffectAutomationParameters &  parms)
override

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

wxString EffectWahwah::GetDescription ( )
override

References XO.

wxString EffectWahwah::GetSymbol ( )
override

References WAHWAH_PLUGIN_SYMBOL.

EffectType EffectWahwah::GetType ( )
override
wxString EffectWahwah::ManualPage ( )
overridevirtual

Reimplemented from Effect.

void EffectWahwah::OnDepthSlider ( wxCommandEvent &  evt)
private
void EffectWahwah::OnDepthText ( wxCommandEvent &  evt)
private
void EffectWahwah::OnFreqOffSlider ( wxCommandEvent &  evt)
private
void EffectWahwah::OnFreqOffText ( wxCommandEvent &  evt)
private
void EffectWahwah::OnFreqSlider ( wxCommandEvent &  evt)
private
void EffectWahwah::OnFreqText ( wxCommandEvent &  evt)
private
void EffectWahwah::OnGainSlider ( wxCommandEvent &  evt)
private
void EffectWahwah::OnGainText ( wxCommandEvent &  evt)
private
void EffectWahwah::OnPhaseSlider ( wxCommandEvent &  evt)
private
void EffectWahwah::OnPhaseText ( wxCommandEvent &  evt)
private
void EffectWahwah::OnResonanceSlider ( wxCommandEvent &  evt)
private
void EffectWahwah::OnResonanceText ( wxCommandEvent &  evt)
private
size_t EffectWahwah::ProcessBlock ( float **  inBlock,
float **  outBlock,
size_t  blockLen 
)
override

References InstanceProcess(), and mMaster.

bool EffectWahwah::ProcessInitialize ( sampleCount  totalLen,
ChannelNames  chanMap = NULL 
)
override
bool EffectWahwah::RealtimeAddProcessor ( unsigned  numChannels,
float  sampleRate 
)
override

References InstanceInit(), and mSlaves.

bool EffectWahwah::RealtimeFinalize ( )
override

References mSlaves.

bool EffectWahwah::RealtimeInitialize ( )
override

References mSlaves, and Effect::SetBlockSize().

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

References InstanceProcess(), and mSlaves.

bool EffectWahwah::SetAutomationParameters ( EffectAutomationParameters &  parms)
override
bool EffectWahwah::SupportsRealtime ( )
override
bool EffectWahwah::TransferDataFromWindow ( )
overridevirtual

Reimplemented from Effect.

References Effect::mUIParent.

bool EffectWahwah::TransferDataToWindow ( )
overridevirtual

Member Data Documentation

wxSlider* EffectWahwah::mDepthS
private
wxTextCtrl* EffectWahwah::mDepthT
private
wxSlider* EffectWahwah::mFreqOfsS
private
wxTextCtrl* EffectWahwah::mFreqOfsT
private
wxSlider* EffectWahwah::mFreqS
private
wxTextCtrl* EffectWahwah::mFreqT
private

Referenced by OnFreqSlider(), and PopulateOrExchange().

EffectWahwahState EffectWahwah::mMaster
private

Referenced by ProcessBlock(), and ProcessInitialize().

wxSlider* EffectWahwah::mOutGainS
private
wxTextCtrl* EffectWahwah::mOutGainT
private

Referenced by OnGainSlider(), and PopulateOrExchange().

wxSlider* EffectWahwah::mPhaseS
private
wxTextCtrl* EffectWahwah::mPhaseT
private
wxSlider* EffectWahwah::mResS
private
wxTextCtrl* EffectWahwah::mResT
private
EffectWahwahStateArray EffectWahwah::mSlaves
private

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