Audacity  2.2.0
LadspaEffect Class Referencefinal

An Effect that calls up a LADSPA plug in, i.e. many possible effects from this one class. More...

#include <LadspaEffect.h>

Inheritance diagram for LadspaEffect:

Public Member Functions

 LadspaEffect (const wxString &path, int index)
 
virtual ~LadspaEffect ()
 
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
 
void SetSampleRate (double rate) override
 
size_t SetBlockSize (size_t maxBlockSize) override
 
sampleCount GetLatency () override
 
size_t GetTailSize () 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
 

Private Member Functions

bool Load ()
 
void Unload ()
 
bool LoadParameters (const wxString &group)
 
bool SaveParameters (const wxString &group)
 
LADSPA_Handle InitInstance (float sampleRate)
 
void FreeInstance (LADSPA_Handle handle)
 
void OnCheckBox (wxCommandEvent &evt)
 
void OnSlider (wxCommandEvent &evt)
 
void OnTextCtrl (wxCommandEvent &evt)
 
void RefreshControls (bool outputOnly=false)
 

Private Attributes

wxString mPath
 
int mIndex
 
EffectHostInterface * mHost
 
wxDynamicLibrary mLib
 
const LADSPA_DescriptormData
 
wxString pluginName
 
bool mReady
 
LADSPA_Handle mMaster
 
double mSampleRate
 
size_t mBlockSize
 
bool mInteractive
 
unsigned mAudioIns
 
ArrayOf< unsigned long > mInputPorts
 
unsigned mAudioOuts
 
ArrayOf< unsigned long > mOutputPorts
 
int mNumInputControls
 
Floats mInputControls
 
int mNumOutputControls
 
Floats mOutputControls
 
bool mUseLatency
 
int mLatencyPort
 
bool mLatencyDone
 
LadspaSlaveArray mSlaves
 
EffectUIHostInterface * mUIHost
 
NumericTextCtrlmDuration
 
wxDialog * mDialog
 
wxWindow * mParent
 
ArrayOf< wxSlider * > mSliders
 
ArrayOf< wxTextCtrl * > mFields
 
ArrayOf< wxStaticText * > mLabels
 
ArrayOf< wxCheckBox * > mToggles
 
ArrayOf< LadspaEffectMeter * > mMeters
 

Friends

class LadspaEffectsModule
 

Detailed Description

An Effect that calls up a LADSPA plug in, i.e. many possible effects from this one class.

Constructor & Destructor Documentation

LadspaEffect::LadspaEffect ( const wxString &  path,
int  index 
)
LadspaEffect::~LadspaEffect ( )
virtual

Member Function Documentation

bool LadspaEffect::CanExportPresets ( )
override
bool LadspaEffect::CloseUI ( )
override
void LadspaEffect::ExportPresets ( )
override
void LadspaEffect::FreeInstance ( LADSPA_Handle  handle)
private
unsigned LadspaEffect::GetAudioInCount ( )
override
unsigned LadspaEffect::GetAudioOutCount ( )
override
bool LadspaEffect::GetAutomationParameters ( EffectAutomationParameters &  parms)
override
wxString LadspaEffect::GetDescription ( )
override

References LAT1CTOWX.

wxArrayString LadspaEffect::GetFactoryPresets ( )
override
wxString LadspaEffect::GetFamily ( )
override

References LADSPAEFFECTS_FAMILY.

sampleCount LadspaEffect::GetLatency ( )
override
int LadspaEffect::GetMidiInCount ( )
override
int LadspaEffect::GetMidiOutCount ( )
override
wxString LadspaEffect::GetName ( )
override
wxString LadspaEffect::GetPath ( )
override
wxString LadspaEffect::GetSymbol ( )
override

References LAT1CTOWX.

size_t LadspaEffect::GetTailSize ( )
override
EffectType LadspaEffect::GetType ( )
override
wxString LadspaEffect::GetVendor ( )
override

References LAT1CTOWX.

wxString LadspaEffect::GetVersion ( )
override

References _().

bool LadspaEffect::HasOptions ( )
override
bool LadspaEffect::HideUI ( )
override
void LadspaEffect::ImportPresets ( )
override
LADSPA_Handle LadspaEffect::InitInstance ( float  sampleRate)
private
bool LadspaEffect::IsDefault ( )
override
bool LadspaEffect::IsGraphicalUI ( )
override
bool LadspaEffect::IsInteractive ( )
override
bool LadspaEffect::IsLegacy ( )
override
bool LadspaEffect::IsReady ( )
override
bool LadspaEffect::Load ( )
private
bool LadspaEffect::LoadFactoryDefaults ( )
override
bool LadspaEffect::LoadFactoryPreset ( int  id)
override
bool LadspaEffect::LoadParameters ( const wxString &  group)
private
bool LadspaEffect::LoadUserPreset ( const wxString &  name)
override
void LadspaEffect::OnCheckBox ( wxCommandEvent &  evt)
private

References ID_Toggles.

size_t LadspaEffect::ProcessBlock ( float **  inBlock,
float **  outBlock,
size_t  blockLen 
)
override
bool LadspaEffect::ProcessFinalize ( )
override
bool LadspaEffect::ProcessInitialize ( sampleCount  totalLen,
ChannelNames  chanMap = NULL 
)
override
bool LadspaEffect::RealtimeAddProcessor ( unsigned  numChannels,
float  sampleRate 
)
override
bool LadspaEffect::RealtimeFinalize ( )
override
bool LadspaEffect::RealtimeInitialize ( )
override
size_t LadspaEffect::RealtimeProcess ( int  group,
float **  inbuf,
float **  outbuf,
size_t  numSamples 
)
override
bool LadspaEffect::RealtimeProcessEnd ( )
override
bool LadspaEffect::RealtimeProcessStart ( )
override
bool LadspaEffect::RealtimeResume ( )
override
bool LadspaEffect::RealtimeSuspend ( )
override
bool LadspaEffect::SaveParameters ( const wxString &  group)
private
bool LadspaEffect::SaveUserPreset ( const wxString &  name)
override
bool LadspaEffect::SetAutomationParameters ( EffectAutomationParameters &  parms)
override
size_t LadspaEffect::SetBlockSize ( size_t  maxBlockSize)
override
void LadspaEffect::SetHostUI ( EffectUIHostInterface *  host)
override
void LadspaEffect::SetSampleRate ( double  rate)
override
bool LadspaEffect::ShowInterface ( wxWindow *  parent,
bool  forceModal = false 
)
override

References valueRestorer().

void LadspaEffect::ShowOptions ( )
override
bool LadspaEffect::SupportsAutomation ( )
override
bool LadspaEffect::SupportsRealtime ( )
override
void LadspaEffect::Unload ( )
private
bool LadspaEffect::ValidateUI ( )
override

Friends And Related Function Documentation

friend class LadspaEffectsModule
friend

Member Data Documentation

unsigned LadspaEffect::mAudioIns
private
unsigned LadspaEffect::mAudioOuts
private
size_t LadspaEffect::mBlockSize
private
const LADSPA_Descriptor* LadspaEffect::mData
private

Referenced by OnTextCtrl().

wxDialog* LadspaEffect::mDialog
private
NumericTextCtrl* LadspaEffect::mDuration
private
ArrayOf<wxTextCtrl*> LadspaEffect::mFields
private

Referenced by OnTextCtrl().

EffectHostInterface* LadspaEffect::mHost
private
int LadspaEffect::mIndex
private
Floats LadspaEffect::mInputControls
private
ArrayOf<unsigned long> LadspaEffect::mInputPorts
private
bool LadspaEffect::mInteractive
private
ArrayOf<wxStaticText*> LadspaEffect::mLabels
private
bool LadspaEffect::mLatencyDone
private
int LadspaEffect::mLatencyPort
private
wxDynamicLibrary LadspaEffect::mLib
private
LADSPA_Handle LadspaEffect::mMaster
private
ArrayOf<LadspaEffectMeter *> LadspaEffect::mMeters
private
int LadspaEffect::mNumInputControls
private
int LadspaEffect::mNumOutputControls
private
Floats LadspaEffect::mOutputControls
private
ArrayOf<unsigned long> LadspaEffect::mOutputPorts
private
wxWindow* LadspaEffect::mParent
private
wxString LadspaEffect::mPath
private
bool LadspaEffect::mReady
private
double LadspaEffect::mSampleRate
private
LadspaSlaveArray LadspaEffect::mSlaves
private
ArrayOf<wxSlider*> LadspaEffect::mSliders
private

Referenced by OnTextCtrl().

ArrayOf<wxCheckBox*> LadspaEffect::mToggles
private
EffectUIHostInterface* LadspaEffect::mUIHost
private
bool LadspaEffect::mUseLatency
private
wxString LadspaEffect::pluginName
private

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