#include <VSTEffect.h>

Inheritance diagram for VSTEffect:

Collaboration diagram for VSTEffect:

Classes
struct	ModuleDeleter

Public Member Functions
	VSTEffect (const PluginPath &path, VSTEffect *master=NULL)

virtual	~VSTEffect ()

PluginPath	GetPath () override

ComponentInterfaceSymbol	GetSymbol () override

VendorSymbol	GetVendor () override

wxString	GetVersion () override

TranslatableString	GetDescription () override

EffectType	GetType () override

EffectFamilySymbol	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

size_t	GetBlockSize () const 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, const EffectDialogFactory &factory, bool forceModal=false) override

bool	GetAutomationParameters (CommandParameters &parms) override

bool	SetAutomationParameters (CommandParameters &parms) 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) 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

void	OnTimer ()

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

virtual	~XMLTagHandler ()

virtual void	HandleXMLEndTag (const wxChar *WXUNUSED(tag))

virtual void	HandleXMLContent (const wxString &WXUNUSED(content))

bool	ReadXMLTag (const char tag, const char *attrs)

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

Public Member Functions inherited from VSTEffectLink
virtual	~VSTEffectLink ()

Static Public Member Functions
static intptr_t	AudioMaster (AEffect effect, int32_t opcode, int32_t index, intptr_t value, void ptr, float opt)

Private Types
using	ModuleHandle = std::unique_ptr< char, ModuleDeleter >

Private Member Functions
bool	Load ()

void	Unload ()

std::vector< int >	GetEffectIDs ()

bool	LoadParameters (const RegistryPath &group)

bool	SaveParameters (const RegistryPath &group)

unsigned	GetChannelCount ()

void	SetChannelCount (unsigned numChannels)

void	OnSlider (wxCommandEvent &evt)

void	OnSizeWindow (wxCommandEvent &evt)

void	OnUpdateDisplay (wxCommandEvent &evt)

void	RemoveHandler ()

void	OnProgram (wxCommandEvent &evt)

void	OnProgramText (wxCommandEvent &evt)

void	OnLoad (wxCommandEvent &evt)

void	OnSave (wxCommandEvent &evt)

void	OnSettings (wxCommandEvent &evt)

void	BuildPlain ()

void	BuildFancy ()

wxSizer *	BuildProgramBar ()

void	RefreshParameters (int skip=-1)

bool	LoadFXB (const wxFileName &fn)

bool	LoadFXP (const wxFileName &fn)

bool	LoadXML (const wxFileName &fn)

bool	LoadFXProgram (unsigned char **bptr, ssize_t &len, int index, bool dryrun)

void	SaveFXB (const wxFileName &fn)

void	SaveFXP (const wxFileName &fn)

void	SaveXML (const wxFileName &fn)

void	SaveFXProgram (wxMemoryBuffer &buf, int index)

bool	HandleXMLTag (const wxChar tag, const wxChar *attrs) override

void	HandleXMLEndTag (const wxChar *tag) override

void	HandleXMLContent (const wxString &content) override

XMLTagHandler *	HandleXMLChild (const wxChar *tag) override

VstTimeInfo *	GetTimeInfo ()

float	GetSampleRate ()

int	GetProcessLevel ()

void	SetBufferDelay (int samples)

void	NeedIdle ()

void	NeedEditIdle (bool state)

void	SizeWindow (int w, int h)

void	UpdateDisplay ()

void	Automate (int index, float value)

void	PowerOn ()

void	PowerOff ()

int	GetString (wxString &outstr, int opcode, int index=0)

wxString	GetString (int opcode, int index=0)

void	SetString (int opcode, const wxString &str, int index=0)

intptr_t	callDispatcher (int opcode, int index, intptr_t value, void *ptr, float opt) override

void	callProcessReplacing (float inputs, float outputs, int sampleframes)

void	callSetParameter (int index, float value)

float	callGetParameter (int index)

void	callSetProgram (int index)

void	callSetChunk (bool isPgm, int len, void *buf)

void	callSetChunk (bool isPgm, int len, void buf, VstPatchChunkInfo info)

	wxCRIT_SECT_DECLARE_MEMBER (mDispatcherLock)

Static Private Member Functions
static wxString	b64encode (const void *in, int len)

static int	b64decode (const wxString &in, void *out)

Private Attributes
EffectHostInterface *	mHost

PluginID	mID

PluginPath	mPath

unsigned	mAudioIns

unsigned	mAudioOuts

int	mMidiIns

int	mMidiOuts

bool	mAutomatable

float	mSampleRate

size_t	mUserBlockSize

wxString	mName

wxString	mVendor

wxString	mDescription

int	mVersion

bool	mInteractive

int	mVstVersion

bool	mReady

ModuleHandle	mModule

AEffect *	mAEffect

VstTimeInfo	mTimeInfo

bool	mUseLatency

int	mBufferDelay

unsigned	mBlockSize

int	mProcessLevel

bool	mHasPower

bool	mWantsIdle

bool	mWantsEditIdle

std::unique_ptr< VSTEffectTimer >	mTimer

int	mTimerGuard

VSTEffect *	mMaster

VSTEffectArray	mSlaves

unsigned	mNumChannels

FloatBuffers	mMasterIn

FloatBuffers	mMasterOut

size_t	mNumSamples

wxDialog *	mDialog

wxWindow *	mParent

EffectUIHostInterface *	mUIHost

wxSizerItem *	mContainer

bool	mGui

VSTControl *	mControl

NumericTextCtrl *	mDuration

ArrayOf< wxStaticText * >	mNames

ArrayOf< wxSlider * >	mSliders

ArrayOf< wxStaticText * >	mDisplays

ArrayOf< wxStaticText * >	mLabels

bool	mInSet

bool	mInChunk

wxString	mChunk

long	mXMLVersion

VstPatchChunkInfo	mXMLInfo

Static Private Attributes
static intptr_t	mCurrentEffectID

Friends
class	VSTEffectsModule

Additional Inherited Members
Public Types inherited from EffectClientInterface
using	EffectDialogFactory = std::function< wxDialog (wxWindow &parent, EffectHostInterface , EffectUIClientInterface *) >

Detailed Description

VSTEffect is an Audacity EffectClientInterface that forwards actual audio processing via a VSTEffectLink

Definition at line 92 of file VSTEffect.h.

Member Typedef Documentation

◆ ModuleHandle

using VSTEffect::ModuleHandle = std::unique_ptr < char, ModuleDeleter >

private

Definition at line 283 of file VSTEffect.h.

Constructor & Destructor Documentation

◆ VSTEffect()

VSTEffect::VSTEffect	(	const PluginPath &	path,
		VSTEffect *	master = `NULL`
	)

Definition at line 1129 of file VSTEffect.cpp.

 :  mPath(path),
    mMaster(master)
 {
    mHost = NULL;
    mModule = NULL;
    mAEffect = NULL;
    mDialog = NULL;
  
    mTimer = std::make_unique<VSTEffectTimer>(this);
    mTimerGuard = 0;
  
    mInteractive = false;
    mAudioIns = 0;
    mAudioOuts = 0;
    mMidiIns = 0;
    mMidiOuts = 0;
    mSampleRate = 44100;
    mBlockSize = mUserBlockSize = 8192;
    mBufferDelay = 0;
    mProcessLevel = 1;         // in GUI thread
    mHasPower = false;
    mWantsIdle = false;
    mWantsEditIdle = false;
    mUseLatency = true;
    mReady = false;
  
    memset(&mTimeInfo, 0, sizeof(mTimeInfo));
    mTimeInfo.samplePos = 0.0;
    mTimeInfo.sampleRate = 44100.0;  // this is a bogus value, but it's only for the display
    mTimeInfo.nanoSeconds = wxGetUTCTimeMillis().ToDouble();
    mTimeInfo.tempo = 120.0;
    mTimeInfo.timeSigNumerator = 4;
    mTimeInfo.timeSigDenominator = 4;
    mTimeInfo.flags = kVstTempoValid | kVstNanosValid;
  
    // UI
    
    mGui = false;
    mContainer = NULL;
  
    // If we're a slave then go ahead a load immediately
    if (mMaster)
    {
       Load();
    }
 }

References VstTimeInfo::flags, kVstNanosValid, kVstTempoValid, Load(), mAEffect, mAudioIns, mAudioOuts, mBlockSize, mBufferDelay, mContainer, mDialog, mGui, mHasPower, mHost, mInteractive, mMaster, mMidiIns, mMidiOuts, mModule, mProcessLevel, mReady, mSampleRate, mTimeInfo, mTimer, mTimerGuard, mUseLatency, mUserBlockSize, mWantsEditIdle, mWantsIdle, VstTimeInfo::nanoSeconds, VstTimeInfo::samplePos, VstTimeInfo::sampleRate, VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

Here is the call graph for this function:

◆ ~VSTEffect()

VSTEffect::~VSTEffect ( )

virtual

Definition at line 1177 of file VSTEffect.cpp.

 {
    if (mDialog)
    {
       mDialog->Close();
    }
  
    Unload();
 }

References mDialog, and Unload().

Here is the call graph for this function:

Member Function Documentation

◆ AudioMaster()

intptr_t VSTEffect::AudioMaster	(	AEffect *	effect,
		int32_t	opcode,
		int32_t	index,
		intptr_t	value,
		void *	ptr,
		float	opt
	)

static

Definition at line 941 of file VSTEffect.cpp.

 {
    VSTEffect *vst = (effect ? (VSTEffect *) effect->ptr2 : NULL);
  
    // Handles operations during initialization...before VSTEffect has had a
    // chance to set its instance pointer.
    switch (opcode)
    {
       case audioMasterVersion:
          return (intptr_t) 2400;
  
       case audioMasterCurrentId:
          return mCurrentEffectID;
  
       case audioMasterGetVendorString:
          strcpy((char *) ptr, "Audacity Team");    // Do not translate, max 64 + 1 for null terminator
          return 1;
  
       case audioMasterGetProductString:
          strcpy((char *) ptr, "Audacity");         // Do not translate, max 64 + 1 for null terminator
          return 1;
  
       case audioMasterGetVendorVersion:
          return (intptr_t) (AUDACITY_VERSION << 24 |
                             AUDACITY_RELEASE << 16 |
                             AUDACITY_REVISION << 8 |
                             AUDACITY_MODLEVEL);
  
       // Some (older) effects depend on an effIdle call when requested.  An
       // example is the Antress Modern plugins which uses the call to update
       // the editors display when the program (preset) changes.
       case audioMasterNeedIdle:
          if (vst)
          {
             vst->NeedIdle();
             return 1;
          }
          return 0;
  
       // We would normally get this if the effect editor is dipslayed and something "major"
       // has changed (like a program change) instead of multiple automation calls.
       // Since we don't do anything with the parameters while the editor is displayed,
       // there's no need for us to do anything.
       case audioMasterUpdateDisplay:
          if (vst)
          {
             vst->UpdateDisplay();
             return 1;
          }
          return 0;
  
       // Return the current time info.
       case audioMasterGetTime:
          if (vst)
          {
             return (intptr_t) vst->GetTimeInfo();
          }
          return 0;
  
       // Inputs, outputs, or initial delay has changed...all we care about is initial delay.
       case audioMasterIOChanged:
          if (vst)
          {
             vst->SetBufferDelay(effect->initialDelay);
             return 1;
          }
          return 0;
  
       case audioMasterGetSampleRate:
          if (vst)
          {
             return (intptr_t) vst->GetSampleRate();
          }
          return 0;
  
       case audioMasterIdle:
          wxYieldIfNeeded();
          return 1;
  
       case audioMasterGetCurrentProcessLevel:
          if (vst)
          {
             return vst->GetProcessLevel();
          }
          return 0;
  
       case audioMasterGetLanguage:
          return kVstLangEnglish;
  
       // We always replace, never accumulate
       case audioMasterWillReplaceOrAccumulate:
          return 1;
  
       // Resize the window to accommodate the effect size
       case audioMasterSizeWindow:
          if (vst)
          {
             vst->SizeWindow(index, value);
          }
          return 1;
  
       case audioMasterCanDo:
       {
          char *s = (char *) ptr;
          if (strcmp(s, "acceptIOChanges") == 0 ||
             strcmp(s, "sendVstTimeInfo") == 0 ||
             strcmp(s, "startStopProcess") == 0 ||
             strcmp(s, "shellCategory") == 0 ||
             strcmp(s, "sizeWindow") == 0)
          {
             return 1;
          }
  
 #if defined(VST_DEBUG)
 #if defined(__WXMSW__)
          wxLogDebug(wxT("VST canDo: %s"), wxString::FromAscii((char *)ptr));
 #else
          wxPrintf(wxT("VST canDo: %s\n"), wxString::FromAscii((char *)ptr));
 #endif
 #endif
  
          return 0;
       }
  
       case audioMasterBeginEdit:
       case audioMasterEndEdit:
          return 0;
  
       case audioMasterAutomate:
          if (vst)
          {
             vst->Automate(index, opt);
          }
          return 0;
  
       // We're always connected (sort of)
       case audioMasterPinConnected:
  
       // We don't do MIDI yet
       case audioMasterWantMidi:
       case audioMasterProcessEvents:
  
          // Don't need to see any messages about these
          return 0;
    }
  
 #if defined(VST_DEBUG)
 #if defined(__WXMSW__)
    wxLogDebug(wxT("vst: %p opcode: %d index: %d value: %p ptr: %p opt: %f user: %p"),
               effect, (int) opcode, (int) index, (void *) value, ptr, opt, vst);
 #else
    wxPrintf(wxT("vst: %p opcode: %d index: %d value: %p ptr: %p opt: %f user: %p\n"),
             effect, (int) opcode, (int) index, (void *) value, ptr, opt, vst);
 #endif
 #endif
  
    return 0;
 }

References audioMasterAutomate, audioMasterBeginEdit, audioMasterCanDo, audioMasterCurrentId, audioMasterEndEdit, audioMasterGetCurrentProcessLevel, audioMasterGetLanguage, audioMasterGetProductString, audioMasterGetSampleRate, audioMasterGetTime, audioMasterGetVendorString, audioMasterGetVendorVersion, audioMasterIdle, audioMasterIOChanged, audioMasterNeedIdle, audioMasterPinConnected, audioMasterProcessEvents, audioMasterSizeWindow, audioMasterUpdateDisplay, audioMasterVersion, audioMasterWantMidi, audioMasterWillReplaceOrAccumulate, Automate(), GetProcessLevel(), GetSampleRate(), GetTimeInfo(), kVstLangEnglish, NeedIdle(), SetBufferDelay(), SizeWindow(), and UpdateDisplay().

Referenced by Load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Automate()

void VSTEffect::Automate	(	int	index,
		float	value
	)

private

Definition at line 2513 of file VSTEffect.cpp.

 {
    // Just ignore it if we're a slave
    if (mMaster)
    {
       return;
    }
  
    for (const auto &slave : mSlaves)
       slave->callSetParameter(index, value);
  
    return;
 }

References mMaster, and mSlaves.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ b64decode()

int VSTEffect::b64decode	(	const wxString &	in,
		void *	out
	)

staticprivate

Definition at line 2702 of file VSTEffect.cpp.

 {
    int len = in.length();
    unsigned char *p = (unsigned char *) out;
  
    if (len % 4)  //Sanity check
    {
       return 0;
    }
  
    int padding = 0;
    if (len)
    {
       if (in[len - 1] == padc)
       {
          padding++;
       }
  
       if (in[len - 2] == padc)
       {
          padding++;
       }
    }
  
    //const char *a = in.mb_str();
    //Setup a vector to hold the result
    unsigned long temp = 0; //Holds decoded quanta
    int i = 0;
    while (i < len)
    {
       for (int quantumPosition = 0; quantumPosition < 4; quantumPosition++)
       {
          unsigned char c = in[i];
          temp <<= 6;
  
          if (c >= 0x41 && c <= 0x5A)
          {
             temp |= c - 0x41;
          }
          else if (c >= 0x61 && c <= 0x7A)
          {
             temp |= c - 0x47;
          }
          else if (c >= 0x30 && c <= 0x39)
          {
             temp |= c + 0x04;
          }
          else if (c == 0x2B)
          {
             temp |= 0x3E;
          }
          else if (c == 0x2F)
          {
             temp |= 0x3F;
          }
          else if (c == padc)
          {
             switch (len - i)
             {
                case 1: //One pad character
                   *p++ = (temp >> 16) & 0x000000FF;
                   *p++ = (temp >> 8) & 0x000000FF;
                   return p - (unsigned char *) out;
                case 2: //Two pad characters
                   *p++ = (temp >> 10) & 0x000000FF;
                   return p - (unsigned char *) out;
             }
          }
          i++;
       }
       *p++ = (temp >> 16) & 0x000000FF;
       *p++ = (temp >> 8) & 0x000000FF;
       *p++ = temp & 0x000000FF;
    }
  
    return p - (unsigned char *) out;
 }

References padc.

Referenced by HandleXMLEndTag(), and LoadParameters().

Here is the caller graph for this function:

◆ b64encode()

wxString VSTEffect::b64encode	(	const void *	in,
		int	len
	)

staticprivate

Definition at line 2662 of file VSTEffect.cpp.

 {
    unsigned char *p = (unsigned char *) in;
    wxString out;
  
    unsigned long temp;
    for (int i = 0; i < len / 3; i++)
    {
       temp  = (*p++) << 16; //Convert to big endian
       temp += (*p++) << 8;
       temp += (*p++);
       out += cset[(temp & 0x00FC0000) >> 18];
       out += cset[(temp & 0x0003F000) >> 12];
       out += cset[(temp & 0x00000FC0) >> 6];
       out += cset[(temp & 0x0000003F)];
    }
  
    switch (len % 3)
    {
       case 1:
          temp  = (*p++) << 16; //Convert to big endian
          out += cset[(temp & 0x00FC0000) >> 18];
          out += cset[(temp & 0x0003F000) >> 12];
          out += padc;
          out += padc;
       break;
  
       case 2:
          temp  = (*p++) << 16; //Convert to big endian
          temp += (*p++) << 8;
          out += cset[(temp & 0x00FC0000) >> 18];
          out += cset[(temp & 0x0003F000) >> 12];
          out += cset[(temp & 0x00000FC0) >> 6];
          out += padc;
       break;
    }
  
    return out;
 }

References cset, and padc.

Referenced by SaveParameters(), and SaveXML().

Here is the caller graph for this function:

◆ BuildFancy()

void VSTEffect::BuildFancy ( )

private

Definition at line 2802 of file VSTEffect.cpp.

 {
    // Turn the power on...some effects need this when the editor is open
    PowerOn();
  
    auto control = Destroy_ptr<VSTControl>{ safenew VSTControl };
    if (!control)
    {
       return;
    }
  
    if (!control->Create(mParent, this))
    {
       return;
    }
  
    {
       auto mainSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
  
       mainSizer->Add((mControl = control.release()), 0, wxALIGN_CENTER);
  
       mParent->SetMinSize(wxDefaultSize);
       mParent->SetSizer(mainSizer.release());
    }
  
    NeedEditIdle(true);
  
    mDialog->Bind(wxEVT_SIZE, OnSize);
  
 #ifdef __WXMAC__
 #ifdef __WX_EVTLOOP_BUSY_WAITING__
    wxEventLoop::SetBusyWaiting(true);
 #endif
 #endif
  
    return;
 }

References mControl, mDialog, mParent, NeedEditIdle(), OnSize(), PowerOn(), and safenew.

Referenced by PopulateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildPlain()

void VSTEffect::BuildPlain ( )

private

Definition at line 2840 of file VSTEffect.cpp.

 {
    wxASSERT(mParent); // To justify safenew
    wxScrolledWindow *const scroller = safenew wxScrolledWindow(mParent,
       wxID_ANY,
       wxDefaultPosition,
       wxDefaultSize,
       wxVSCROLL | wxTAB_TRAVERSAL);
  
    {
       auto mainSizer = std::make_unique<wxBoxSizer>(wxVERTICAL);
  
       // Try to give the window a sensible default/minimum size
       scroller->SetMinSize(wxSize(wxMax(600, mParent->GetSize().GetWidth() * 2 / 3),
          mParent->GetSize().GetHeight() / 2));
       scroller->SetScrollRate(0, 20);
  
       // This fools NVDA into not saying "Panel" when the dialog gets focus
       scroller->SetName(wxT("\a"));
       scroller->SetLabel(wxT("\a"));
  
       mainSizer->Add(scroller, 1, wxEXPAND | wxALL, 5);
       mParent->SetSizer(mainSizer.release());
    }
  
    mNames.reinit(static_cast<size_t>(mAEffect->numParams));
    mSliders.reinit(static_cast<size_t>(mAEffect->numParams));
    mDisplays.reinit(static_cast<size_t>(mAEffect->numParams));
    mLabels.reinit(static_cast<size_t>(mAEffect->numParams));
  
    {
       auto paramSizer = std::make_unique<wxStaticBoxSizer>(wxVERTICAL, scroller, _("Effect Settings"));
  
       {
          auto gridSizer = std::make_unique<wxFlexGridSizer>(4, 0, 0);
          gridSizer->AddGrowableCol(1);
  
          // Add the duration control for generators
          if (GetType() == EffectTypeGenerate)
          {
             wxControl *item = safenew wxStaticText(scroller, 0, _("Duration:"));
             gridSizer->Add(item, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_RIGHT | wxALL, 5);
             mDuration = safenew
                NumericTextCtrl(scroller, ID_Duration,
                   NumericConverter::TIME,
                   mHost->GetDurationFormat(),
                   mHost->GetDuration(),
                   mSampleRate,
                   NumericTextCtrl::Options{}
                      .AutoPos(true));
             mDuration->SetName( XO("Duration") );
             gridSizer->Add(mDuration, 0, wxALIGN_CENTER_VERTICAL | wxALL, 5);
             gridSizer->Add(1, 1, 0);
             gridSizer->Add(1, 1, 0);
          }
  
          // Find the longest parameter name.
          int namew = 0;
          int w;
          int h;
          for (int i = 0; i < mAEffect->numParams; i++)
          {
             wxString text = GetString(effGetParamName, i);
  
             if (text.Right(1) != wxT(':'))
             {
                text += wxT(':');
             }
  
             scroller->GetTextExtent(text, &w, &h);
             if (w > namew)
             {
                namew = w;
             }
          }
  
          scroller->GetTextExtent(wxT("HHHHHHHH"), &w, &h);
  
          for (int i = 0; i < mAEffect->numParams; i++)
          {
             mNames[i] = safenew wxStaticText(scroller,
                wxID_ANY,
                wxEmptyString,
                wxDefaultPosition,
                wxSize(namew, -1),
                wxALIGN_RIGHT | wxST_NO_AUTORESIZE);
             gridSizer->Add(mNames[i], 0, wxALIGN_CENTER_VERTICAL | wxALIGN_RIGHT | wxALL, 5);
  
             mSliders[i] = safenew wxSliderWrapper(scroller,
                ID_Sliders + i,
                0,
                0,
                1000,
                wxDefaultPosition,
                wxSize(200, -1));
             gridSizer->Add(mSliders[i], 0, wxALIGN_CENTER_VERTICAL | wxEXPAND | wxALL, 5);
 #if wxUSE_ACCESSIBILITY
             // so that name can be set on a standard control
             mSliders[i]->SetAccessible(safenew WindowAccessible(mSliders[i]));
 #endif
  
             mDisplays[i] = safenew wxStaticText(scroller,
                wxID_ANY,
                wxEmptyString,
                wxDefaultPosition,
                wxSize(w, -1),
                wxALIGN_RIGHT | wxST_NO_AUTORESIZE);
             gridSizer->Add(mDisplays[i], 0, wxALIGN_CENTER_VERTICAL | wxALIGN_RIGHT | wxALL, 5);
  
             mLabels[i] = safenew wxStaticText(scroller,
                wxID_ANY,
                wxEmptyString,
                wxDefaultPosition,
                wxSize(w, -1),
                wxALIGN_LEFT | wxST_NO_AUTORESIZE);
             gridSizer->Add(mLabels[i], 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT | wxALL, 5);
          }
  
          paramSizer->Add(gridSizer.release(), 1, wxEXPAND | wxALL, 5);
       }
       scroller->SetSizer(paramSizer.release());
    }
  
    RefreshParameters();
  
    mSliders[0]->SetFocus();
 }

References _, NumericTextCtrl::Options::AutoPos(), EffectTypeGenerate, effGetParamName, EffectHostInterface::GetDuration(), EffectHostInterface::GetDurationFormat(), GetString(), GetType(), ID_Duration, ID_Sliders, mAEffect, mDisplays, mDuration, mHost, mLabels, mNames, mParent, mSampleRate, mSliders, AEffect::numParams, RefreshParameters(), ArrayOf< X >::reinit(), safenew, NumericTextCtrl::SetName(), NumericConverter::TIME, and XO.

Referenced by PopulateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildProgramBar()

wxSizer* VSTEffect::BuildProgramBar ( )

private

◆ callDispatcher()

intptr_t VSTEffect::callDispatcher	(	int	opcode,
		int	index,
		intptr_t	value,
		void *	ptr,
		float	opt
	)

overrideprivatevirtual

Implements VSTEffectLink.

Definition at line 2568 of file VSTEffect.cpp.

 {
    // Needed since we might be in the dispatcher when the timer pops
    wxCRIT_SECT_LOCKER(locker, mDispatcherLock);
    return mAEffect->dispatcher(mAEffect, opcode, index, value, ptr, opt);
 }

References AEffect::dispatcher, and mAEffect.

Referenced by callSetChunk(), callSetParameter(), callSetProgram(), GetEffectIDs(), GetString(), HandleXMLEndTag(), HandleXMLTag(), Load(), LoadFXB(), LoadFXProgram(), LoadXML(), OnTimer(), PowerOff(), PowerOn(), ProcessInitialize(), RealtimeAddProcessor(), SaveFXB(), SaveFXP(), SaveFXProgram(), SaveParameters(), SaveXML(), SetAutomationParameters(), SetString(), and Unload().

Here is the caller graph for this function:

◆ callGetParameter()

float VSTEffect::callGetParameter ( int index )

private

Definition at line 2582 of file VSTEffect.cpp.

 {
    return mAEffect->getParameter(mAEffect, index);
 }

References AEffect::getParameter, and mAEffect.

Referenced by GetAutomationParameters(), RealtimeAddProcessor(), RefreshParameters(), SaveFXProgram(), and SaveXML().

Here is the caller graph for this function:

◆ callProcessReplacing()

void VSTEffect::callProcessReplacing	(	float **	inputs,
		float **	outputs,
		int	sampleframes
	)

private

Definition at line 2576 of file VSTEffect.cpp.

 {
    mAEffect->processReplacing(mAEffect, inputs, outputs, sampleframes);
 }

References mAEffect, and AEffect::processReplacing.

Referenced by ProcessBlock().

Here is the caller graph for this function:

◆ callSetChunk() [1/2]

void VSTEffect::callSetChunk	(	bool	isPgm,
		int	len,
		void *	buf
	)

private

Definition at line 2609 of file VSTEffect.cpp.

 {
    VstPatchChunkInfo info;
  
    memset(&info, 0, sizeof(info));
    info.version = 1;
    info.pluginUniqueID = mAEffect->uniqueID;
    info.pluginVersion = mAEffect->version;
    info.numElements = isPgm ? mAEffect->numParams : mAEffect->numPrograms;
  
    callSetChunk(isPgm, len, buf, &info);
 }

References mAEffect, VstPatchChunkInfo::numElements, AEffect::numParams, AEffect::numPrograms, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, AEffect::uniqueID, AEffect::version, and VstPatchChunkInfo::version.

Referenced by HandleXMLEndTag(), LoadFXB(), LoadFXProgram(), LoadParameters(), and RealtimeAddProcessor().

Here is the caller graph for this function:

◆ callSetChunk() [2/2]

void VSTEffect::callSetChunk	(	bool	isPgm,
		int	len,
		void *	buf,
		VstPatchChunkInfo *	info
	)

private

Definition at line 2622 of file VSTEffect.cpp.

 {
    if (isPgm)
    {
       // Ask the effect if this is an acceptable program
       if (callDispatcher(effBeginLoadProgram, 0, 0, info, 0.0) == -1)
       {
          return;
       }
    }
    else
    {
       // Ask the effect if this is an acceptable bank
       if (callDispatcher(effBeginLoadBank, 0, 0, info, 0.0) == -1)
       {
          return;
       }
    }
  
    callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
    callDispatcher(effSetChunk, isPgm ? 1 : 0, len, buf, 0.0);
    callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
  
    for (const auto &slave : mSlaves)
       slave->callSetChunk(isPgm, len, buf, info);
 }

References callDispatcher(), effBeginLoadBank, effBeginLoadProgram, effBeginSetProgram, effEndSetProgram, effSetChunk, and mSlaves.

Here is the call graph for this function:

◆ callSetParameter()

void VSTEffect::callSetParameter	(	int	index,
		float	value
	)

private

Definition at line 2587 of file VSTEffect.cpp.

 {
    if (mVstVersion == 0 || callDispatcher(effCanBeAutomated, 0, index, NULL, 0.0))
    {
       mAEffect->setParameter(mAEffect, index, value);
  
       for (const auto &slave : mSlaves)
          slave->callSetParameter(index, value);
    }
 }

References callDispatcher(), effCanBeAutomated, mAEffect, mSlaves, mVstVersion, and AEffect::setParameter.

Referenced by HandleXMLTag(), LoadFXProgram(), OnSlider(), RealtimeAddProcessor(), and SetAutomationParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ callSetProgram()

void VSTEffect::callSetProgram ( int index )

private

Definition at line 2598 of file VSTEffect.cpp.

 {
    callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
  
    callDispatcher(effSetProgram, 0, index, NULL, 0.0);
    for (const auto &slave : mSlaves)
       slave->callSetProgram(index);
  
    callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
 }

References callDispatcher(), effBeginSetProgram, effEndSetProgram, effSetProgram, and mSlaves.

Referenced by Load(), LoadFactoryPreset(), and LoadFXB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CanExportPresets()

bool VSTEffect::CanExportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1843 of file VSTEffect.cpp.

 {
    return true;
 }

◆ CloseUI()

bool VSTEffect::CloseUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1814 of file VSTEffect.cpp.

 {
 #ifdef __WXMAC__
 #ifdef __WX_EVTLOOP_BUSY_WAITING__
    wxEventLoop::SetBusyWaiting(false);
 #endif
    mControl->Close();
 #endif
  
    mParent->RemoveEventHandler(this);
  
    PowerOff();
  
    NeedEditIdle(false);
  
    RemoveHandler();
  
    mNames.reset();
    mSliders.reset();
    mDisplays.reset();
    mLabels.reset();
  
    mUIHost = NULL;
    mParent = NULL;
    mDialog = NULL;
  
    return true;
 }

References VSTControl::Close(), mControl, mDialog, mDisplays, mLabels, mNames, mParent, mSliders, mUIHost, NeedEditIdle(), PowerOff(), and RemoveHandler().

Referenced by Unload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ExportPresets()

void VSTEffect::ExportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1849 of file VSTEffect.cpp.

 {
    wxString path;
  
    // Ask the user for the real name
    //
    // Passing a valid parent will cause some effects dialogs to malfunction
    // upon returning from the SelectFile().
    path = SelectFile(FileNames::Operation::Presets,
       XO("Save VST Preset As:"),
       wxEmptyString,
       wxT("preset"),
       wxT("xml"),
       {
         { XO("Standard VST bank file"), { wxT("fxb") }, true },
         { XO("Standard VST program file"), { wxT("fxp") }, true },
         { XO("Audacity VST preset file"), { wxT("xml") }, true },
       },
       wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER,
       NULL);
  
    // User canceled...
    if (path.empty())
    {
       return;
    }
  
    wxFileName fn(path);
    wxString ext = fn.GetExt();
    if (ext.CmpNoCase(wxT("fxb")) == 0)
    {
       SaveFXB(fn);
    }
    else if (ext.CmpNoCase(wxT("fxp")) == 0)
    {
       SaveFXP(fn);
    }
    else if (ext.CmpNoCase(wxT("xml")) == 0)
    {
       // may throw
       SaveXML(fn);
    }
    else
    {
       // This shouldn't happen, but complain anyway
       AudacityMessageBox(
          XO("Unrecognized file extension."),
          XO("Error Saving VST Presets"),
          wxOK | wxCENTRE,
          mParent);
  
       return;
    }
 }

References AudacityMessageBox(), fn, mParent, SaveFXB(), SaveFXP(), SaveXML(), SelectFile(), and XO.

Here is the call graph for this function:

◆ GetAudioInCount()

unsigned VSTEffect::GetAudioInCount ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1336 of file VSTEffect.cpp.

 {
    return mAudioIns;
 }

References mAudioIns.

◆ GetAudioOutCount()

unsigned VSTEffect::GetAudioOutCount ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1341 of file VSTEffect.cpp.

 {
    return mAudioOuts;
 }

References mAudioOuts.

◆ GetAutomationParameters()

bool VSTEffect::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Implements EffectClientInterface.

Definition at line 1640 of file VSTEffect.cpp.

 {
    for (int i = 0; i < mAEffect->numParams; i++)
    {
       wxString name = GetString(effGetParamName, i);
       if (name.empty())
       {
          name.Printf(wxT("parm_%d"), i);
       }
  
       float value = callGetParameter(i);
       if (!parms.Write(name, value))
       {
          return false;
       }
    }
  
    return true;
 }

References callGetParameter(), effGetParamName, TranslatableString::empty(), GetString(), mAEffect, name, and AEffect::numParams.

Referenced by SaveParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlockSize()

size_t VSTEffect::GetBlockSize ( ) const

overridevirtual

Implements EffectClientInterface.

Definition at line 1362 of file VSTEffect.cpp.

 {
    return mBlockSize;
 }

References mBlockSize.

◆ GetChannelCount()

unsigned VSTEffect::GetChannelCount ( )

private

Definition at line 1445 of file VSTEffect.cpp.

 {
    return mNumChannels;
 }

References mNumChannels.

◆ GetDescription()

TranslatableString VSTEffect::GetDescription ( )

overridevirtual

Implements ComponentInterface.

Definition at line 1225 of file VSTEffect.cpp.

 {
    // VST does have a product string opcode and some effects return a short
    // description, but most do not or they just return the name again.  So,
    // try to provide some sort of useful information.
    return XO("Audio In: %d, Audio Out: %d").Format( mAudioIns, mAudioOuts );
 }

References mAudioIns, mAudioOuts, and XO.

Referenced by VSTEffectsModule::Check().

Here is the caller graph for this function:

◆ GetEffectIDs()

std::vector< int > VSTEffect::GetEffectIDs ( )

private

Definition at line 2298 of file VSTEffect.cpp.

 {
    std::vector<int> effectIDs;
  
    // Are we a shell?
    if (mVstVersion >= 2 && (VstPlugCategory) callDispatcher(effGetPlugCategory, 0, 0, NULL, 0) == kPlugCategShell)
    {
       char name[64];
       int effectID;
  
       effectID = (int) callDispatcher(effShellGetNextPlugin, 0, 0, &name, 0);
       while (effectID)
       {
          effectIDs.push_back(effectID);
          effectID = (int) callDispatcher(effShellGetNextPlugin, 0, 0, &name, 0);
       }
    }
  
    return effectIDs;
 }

References callDispatcher(), effGetPlugCategory, effShellGetNextPlugin, kPlugCategShell, mVstVersion, and name.

Referenced by VSTEffectsModule::Check().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFactoryPresets()

RegistryPaths VSTEffect::GetFactoryPresets ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1707 of file VSTEffect.cpp.

 {
    RegistryPaths progs;
  
    // Some plugins, like Guitar Rig 5, only report 128 programs while they have hundreds.  While
    // I was able to come up with a hack in the Guitar Rig case to gather all of the program names
    // it would not let me set a program outside of the first 128.
    if (mVstVersion >= 2)
    {
       for (int i = 0; i < mAEffect->numPrograms; i++)
       {
          progs.push_back(GetString(effGetProgramNameIndexed, i));
       }
    }
  
    return progs;
 }

References effGetProgramNameIndexed, GetString(), mAEffect, mVstVersion, and AEffect::numPrograms.

Here is the call graph for this function:

◆ GetFamily()

EffectFamilySymbol VSTEffect::GetFamily ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 1258 of file VSTEffect.cpp.

 {
    return VSTPLUGINTYPE;
 }

References VSTPLUGINTYPE.

◆ GetLatency()

sampleCount VSTEffect::GetLatency ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1372 of file VSTEffect.cpp.

 {
    if (mUseLatency)
    {
       // ??? Threading issue ???
       auto delay = mBufferDelay;
       mBufferDelay = 0;
       return delay;
    }
  
    return 0;
 }

References mBufferDelay, and mUseLatency.

◆ GetMidiInCount()

int VSTEffect::GetMidiInCount ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1346 of file VSTEffect.cpp.

 {
    return mMidiIns;
 }

References mMidiIns.

◆ GetMidiOutCount()

int VSTEffect::GetMidiOutCount ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1351 of file VSTEffect.cpp.

 {
    return mMidiOuts;
 }

References mMidiOuts.

◆ GetPath()

PluginPath VSTEffect::GetPath ( )

overridevirtual

Implements ComponentInterface.

Definition at line 1191 of file VSTEffect.cpp.

 {
    return mPath;
 }

References mPath.

Referenced by VSTEffectsModule::Check().

Here is the caller graph for this function:

◆ GetProcessLevel()

int VSTEffect::GetProcessLevel ( )

private

Definition at line 2445 of file VSTEffect.cpp.

 {
    return mProcessLevel;
 }

References mProcessLevel.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ GetSampleRate()

float VSTEffect::GetSampleRate ( )

private

Definition at line 2440 of file VSTEffect.cpp.

 {
    return mTimeInfo.sampleRate;
 }

References mTimeInfo, and VstTimeInfo::sampleRate.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ GetString() [1/2]

wxString VSTEffect::GetString	(	int	opcode,
		int	index = `0`
	)

private

Definition at line 2551 of file VSTEffect.cpp.

 {
    wxString str;
  
    GetString(str, opcode, index);
  
    return str;
 }

References GetString().

Here is the call graph for this function:

◆ GetString() [2/2]

int VSTEffect::GetString	(	wxString &	outstr,
		int	opcode,
		int	index = `0`
	)

private

Definition at line 2538 of file VSTEffect.cpp.

 {
    char buf[256];
  
    memset(buf, 0, sizeof(buf));
  
    callDispatcher(opcode, index, 0, buf, 0.0);
  
    outstr = wxString::FromUTF8(buf);
  
    return 0;
 }

References callDispatcher().

Referenced by BuildPlain(), GetAutomationParameters(), GetFactoryPresets(), GetString(), Load(), RefreshParameters(), SaveXML(), and SetAutomationParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol VSTEffect::GetSymbol ( )

overridevirtual

Implements ComponentInterface.

Definition at line 1196 of file VSTEffect.cpp.

 {
    return mName;
 }

References mName.

Referenced by VSTEffectsModule::Check(), HandleXMLTag(), and SaveXML().

Here is the caller graph for this function:

◆ GetTailSize()

size_t VSTEffect::GetTailSize ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1385 of file VSTEffect.cpp.

 {
    return 0;
 }

◆ GetTimeInfo()

VstTimeInfo * VSTEffect::GetTimeInfo ( )

private

Definition at line 2434 of file VSTEffect.cpp.

 {
    mTimeInfo.nanoSeconds = wxGetUTCTimeMillis().ToDouble();
    return &mTimeInfo;
 }

References mTimeInfo, and VstTimeInfo::nanoSeconds.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ GetType()

EffectType VSTEffect::GetType ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 1237 of file VSTEffect.cpp.

 {
    if (mAudioIns == 0 && mAudioOuts == 0 && mMidiIns == 0 && mMidiOuts == 0)
    {
       return EffectTypeTool;
    }
  
    if (mAudioIns == 0 && mMidiIns == 0)
    {
       return EffectTypeGenerate;
    }
  
    if (mAudioOuts == 0 && mMidiOuts == 0)
    {
       return EffectTypeAnalyze;
    }
  
    return EffectTypeProcess;
 }

References EffectTypeAnalyze, EffectTypeGenerate, EffectTypeProcess, EffectTypeTool, mAudioIns, mAudioOuts, mMidiIns, and mMidiOuts.

Referenced by BuildPlain(), VSTEffectsModule::Check(), SupportsRealtime(), and ValidateUI().

Here is the caller graph for this function:

◆ GetVendor()

VendorSymbol VSTEffect::GetVendor ( )

overridevirtual

Implements ComponentInterface.

Definition at line 1201 of file VSTEffect.cpp.

 {
    return { mVendor };
 }

References mVendor.

Referenced by VSTEffectsModule::Check().

Here is the caller graph for this function:

◆ GetVersion()

wxString VSTEffect::GetVersion ( )

overridevirtual

Implements ComponentInterface.

Definition at line 1206 of file VSTEffect.cpp.

 {
    wxString version;
  
    bool skipping = true;
    for (int i = 0, s = 0; i < 4; i++, s += 8)
    {
       int dig = (mVersion >> s) & 0xff;
       if (dig != 0 || !skipping)
       {
          version += !skipping ? wxT(".") : wxT("");
          version += wxString::Format(wxT("%d"), dig);
          skipping = false;
       }
    }
  
    return version;
 }

References mVersion.

Referenced by VSTEffectsModule::Check().

Here is the caller graph for this function:

◆ HandleXMLChild()

XMLTagHandler * VSTEffect::HandleXMLChild ( const wxChar * tag )

overrideprivatevirtual

Implements XMLTagHandler.

Definition at line 3983 of file VSTEffect.cpp.

 {
    if (wxStrcmp(tag, wxT("vstprogrampersistence")) == 0)
    {
       return this;
    }
  
    if (wxStrcmp(tag, wxT("effect")) == 0)
    {
       return this;
    }
  
    if (wxStrcmp(tag, wxT("program")) == 0)
    {
       return this;
    }
  
    if (wxStrcmp(tag, wxT("param")) == 0)
    {
       return this;
    }
  
    if (wxStrcmp(tag, wxT("chunk")) == 0)
    {
       return this;
    }
  
    return NULL;
 }

◆ HandleXMLContent()

void VSTEffect::HandleXMLContent ( const wxString & content )

overrideprivate

Definition at line 3975 of file VSTEffect.cpp.

 {
    if (mInChunk)
    {
       mChunk += wxString(content).Trim(true).Trim(false);
    }
 }

References mChunk, and mInChunk.

◆ HandleXMLEndTag()

void VSTEffect::HandleXMLEndTag ( const wxChar * tag )

overrideprivate

Definition at line 3945 of file VSTEffect.cpp.

 {
    if (wxStrcmp(tag, wxT("chunk")) == 0)
    {
       if (mChunk.length())
       {
          ArrayOf<char> buf{ mChunk.length() / 4 * 3 };
  
          int len = VSTEffect::b64decode(mChunk, buf.get());
          if (len)
          {
             callSetChunk(true, len, buf.get(), &mXMLInfo);
          }
  
          mChunk.clear();
       }
       mInChunk = false;
    }
  
    if (wxStrcmp(tag, wxT("program")) == 0)
    {
       if (mInSet)
       {
          callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
  
          mInSet = false;
       }
    }
 }

References b64decode(), callDispatcher(), callSetChunk(), effEndSetProgram, mChunk, mInChunk, mInSet, and mXMLInfo.

Here is the call graph for this function:

◆ HandleXMLTag()

bool VSTEffect::HandleXMLTag	(	const wxChar *	tag,
		const wxChar **	attrs
	)

overrideprivatevirtual

Implements XMLTagHandler.

Definition at line 3701 of file VSTEffect.cpp.

 {
    if (wxStrcmp(tag, wxT("vstprogrampersistence")) == 0)
    {
       while (*attrs)
       {
          const wxChar *attr = *attrs++;
          const wxChar *value = *attrs++;
  
          if (!value)
          {
             break;
          }
  
          const wxString strValue = value;
  
          if (wxStrcmp(attr, wxT("version")) == 0)
          {
             if (!XMLValueChecker::IsGoodInt(strValue) || !strValue.ToLong(&mXMLVersion))
             {
                return false;
             }
  
             if (mXMLVersion < 1 || mXMLVersion > 2)
             {
                return false;
             }
          }
          else
          {
             return false;
          }
       }
  
       return true;
    }
  
    if (wxStrcmp(tag, wxT("effect")) == 0)
    {
       memset(&mXMLInfo, 0, sizeof(mXMLInfo));
       mXMLInfo.version = 1;
       mXMLInfo.pluginUniqueID = mAEffect->uniqueID;
       mXMLInfo.pluginVersion = mAEffect->version;
       mXMLInfo.numElements = mAEffect->numParams;
  
       while (*attrs)
       {
          const wxChar *attr = *attrs++;
          const wxChar *value = *attrs++;
  
          if (!value)
          {
             break;
          }
  
          const wxString strValue = value;
  
          if (wxStrcmp(attr, wxT("name")) == 0)
          {
             if (!XMLValueChecker::IsGoodString(strValue))
             {
                return false;
             }
  
             if (value != GetSymbol().Internal())
             {
                auto msg = XO("This parameter file was saved from %s. Continue?")
                   .Format( value );
                int result = AudacityMessageBox(
                   msg,
                   XO("Confirm"),
                   wxYES_NO,
                   mParent );
                if (result == wxNO)
                {
                   return false;
                }
             }
          }
          else if (wxStrcmp(attr, wxT("version")) == 0)
          {
             long version;
             if (!XMLValueChecker::IsGoodInt(strValue) || !strValue.ToLong(&version))
             {
                return false;
             }
  
             mXMLInfo.pluginVersion = (int) version;
          }
          else if (mXMLVersion > 1 && wxStrcmp(attr, wxT("uniqueID")) == 0)
          {
             long uniqueID;
             if (!XMLValueChecker::IsGoodInt(strValue) || !strValue.ToLong(&uniqueID))
             {
                return false;
             }
  
             mXMLInfo.pluginUniqueID = (int) uniqueID;
          }
          else if (mXMLVersion > 1 && wxStrcmp(attr, wxT("numParams")) == 0)
          {
             long numParams;
             if (!XMLValueChecker::IsGoodInt(strValue) || !strValue.ToLong(&numParams))
             {
                return false;
             }
  
             mXMLInfo.numElements = (int) numParams;
          }
          else
          {
             return false;
          }
       }
  
       return true;
    }
  
    if (wxStrcmp(tag, wxT("program")) == 0)
    {
       while (*attrs)
       {
          const wxChar *attr = *attrs++;
          const wxChar *value = *attrs++;
  
          if (!value)
          {
             break;
          }
  
          const wxString strValue = value;
  
          if (wxStrcmp(attr, wxT("name")) == 0)
          {
             if (!XMLValueChecker::IsGoodString(strValue))
             {
                return false;
             }
  
             if (strValue.length() > 24)
             {
                return false;
             }
  
             int ndx = 0; //mProgram->GetCurrentSelection();
             if (ndx == wxNOT_FOUND)
             {
                ndx = 0;
             }
  
             SetString(effSetProgramName, strValue, ndx);
          }
          else
          {
             return false;
          }
       }
  
       mInChunk = false;
  
       if (callDispatcher(effBeginLoadProgram, 0, 0, &mXMLInfo, 0.0) == -1)
       {
          return false;
       }
  
       callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
  
       mInSet = true;
  
       return true;
    }
  
    if (wxStrcmp(tag, wxT("param")) == 0)
    {
       long ndx = -1;
       double val = -1.0;
       while (*attrs)
       {
          const wxChar *attr = *attrs++;
          const wxChar *value = *attrs++;
  
          if (!value)
          {
             break;
          }
  
          const wxString strValue = value;
  
          if (wxStrcmp(attr, wxT("index")) == 0)
          {
             if (!XMLValueChecker::IsGoodInt(strValue) || !strValue.ToLong(&ndx))
             {
                return false;
             }
  
             if (ndx < 0 || ndx >= mAEffect->numParams)
             {
                // Could be a different version of the effect...probably should
                // tell the user
                return false;
             }
          }
          else if (wxStrcmp(attr, wxT("name")) == 0)
          {
             if (!XMLValueChecker::IsGoodString(strValue))
             {
                return false;
             }
             // Nothing to do with it for now
          }
          else if (wxStrcmp(attr, wxT("value")) == 0)
          {
             if (!XMLValueChecker::IsGoodInt(strValue) ||
                !Internat::CompatibleToDouble(strValue, &val))
             {
                return false;
             }
  
             if (val < 0.0 || val > 1.0)
             {
                return false;
             }
          }
       }
  
       if (ndx == -1 || val == -1.0)
       {
          return false;
       }
  
       callSetParameter(ndx, val);
  
       return true;
    }
  
    if (wxStrcmp(tag, wxT("chunk")) == 0)
    {
       mInChunk = true;
       return true;
    }
  
    return false;
 }

References AudacityMessageBox(), callDispatcher(), callSetParameter(), Internat::CompatibleToDouble(), effBeginLoadProgram, effBeginSetProgram, effSetProgramName, GetSymbol(), Internal, XMLValueChecker::IsGoodInt(), XMLValueChecker::IsGoodString(), mAEffect, mInChunk, mInSet, mParent, mXMLInfo, mXMLVersion, VstPatchChunkInfo::numElements, AEffect::numParams, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, SetString(), AEffect::uniqueID, AEffect::version, VstPatchChunkInfo::version, and XO.

Here is the call graph for this function:

◆ HasOptions()

bool VSTEffect::HasOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1976 of file VSTEffect.cpp.

 {
    return true;
 }

◆ HideUI()

bool VSTEffect::HideUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1809 of file VSTEffect.cpp.

 {
    return true;
 }

◆ ImportPresets()

void VSTEffect::ImportPresets ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1909 of file VSTEffect.cpp.

 {
    wxString path;
  
    // Ask the user for the real name
    path = SelectFile(FileNames::Operation::Presets,
       XO("Load VST Preset:"),
       wxEmptyString,
       wxT("preset"),
       wxT("xml"),
       { {
          XO("VST preset files"),
          { wxT("fxb"), wxT("fxp"), wxT("xml") },
          true
       } },
       wxFD_OPEN | wxRESIZE_BORDER,
       mParent);
  
    // User canceled...
    if (path.empty())
    {
       return;
    }
  
    wxFileName fn(path);
    wxString ext = fn.GetExt();
    bool success = false;
    if (ext.CmpNoCase(wxT("fxb")) == 0)
    {
       success = LoadFXB(fn);
    }
    else if (ext.CmpNoCase(wxT("fxp")) == 0)
    {
       success = LoadFXP(fn);
    }
    else if (ext.CmpNoCase(wxT("xml")) == 0)
    {
       success = LoadXML(fn);
    }
    else
    {
       // This shouldn't happen, but complain anyway
       AudacityMessageBox(
          XO("Unrecognized file extension."),
          XO("Error Loading VST Presets"),
          wxOK | wxCENTRE,
          mParent);
  
          return;
    }
  
    if (!success)
    {
       AudacityMessageBox(
          XO("Unable to load presets file."),
          XO("Error Loading VST Presets"),
          wxOK | wxCENTRE,
          mParent);
  
       return;
    }
  
    RefreshParameters();
  
    return;
 }

References AudacityMessageBox(), fn, LoadFXB(), LoadFXP(), LoadXML(), mParent, RefreshParameters(), SelectFile(), and XO.

Here is the call graph for this function:

◆ IsDefault()

bool VSTEffect::IsDefault ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 1268 of file VSTEffect.cpp.

 {
    return false;
 }

◆ IsGraphicalUI()

bool VSTEffect::IsGraphicalUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1789 of file VSTEffect.cpp.

 {
    return mGui;
 }

References mGui.

◆ IsInteractive()

bool VSTEffect::IsInteractive ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 1263 of file VSTEffect.cpp.

 {
    return mInteractive;
 }

References mInteractive.

Referenced by VSTEffectsModule::Check().

Here is the caller graph for this function:

◆ IsLegacy()

bool VSTEffect::IsLegacy ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 1273 of file VSTEffect.cpp.

 {
    return false;
 }

◆ IsReady()

bool VSTEffect::IsReady ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1390 of file VSTEffect.cpp.

 {
    return mReady;
 }

References mReady.

Referenced by ShowInterface().

Here is the caller graph for this function:

◆ Load()

bool VSTEffect::Load ( )

private

Definition at line 1998 of file VSTEffect.cpp.

 {
    vstPluginMain pluginMain;
    bool success = false;
  
    long effectID = 0;
    wxString realPath = mPath.BeforeFirst(wxT(';'));
    mPath.AfterFirst(wxT(';')).ToLong(&effectID);
    mCurrentEffectID = (intptr_t) effectID;
  
    mModule = NULL;
    mAEffect = NULL;
  
 #if defined(__WXMAC__)
    // Start clean
    mBundleRef.reset();
  
    mResource = ResourceHandle{};
  
    // Convert the path to a CFSTring
    wxCFStringRef path(realPath);
  
    // Convert the path to a URL
    CFURLRef urlRef =
       CFURLCreateWithFileSystemPath(kCFAllocatorDefault,
       path,
       kCFURLPOSIXPathStyle,
       true);
    if (urlRef == NULL)
    {
       return false;
    }
  
    // Create the bundle using the URL
    BundleHandle bundleRef{ CFBundleCreate(kCFAllocatorDefault, urlRef) };
  
    // Done with the URL
    CFRelease(urlRef);
  
    // Bail if the bundle wasn't created
    if (!bundleRef)
    {
       return false;
    }
  
    // Retrieve a reference to the executable
    CFURLRef exeRef = CFBundleCopyExecutableURL(bundleRef.get());
    if (!exeRef)
       return false;
  
    // Convert back to path
    UInt8 exePath[PLATFORM_MAX_PATH];
    Boolean good = CFURLGetFileSystemRepresentation(exeRef, true, exePath, sizeof(exePath));
  
    // Done with the executable reference
    CFRelease(exeRef);
  
    // Bail if we couldn't resolve the executable path
    if (good == FALSE)
       return false;
  
    // Attempt to open it
    mModule.reset((char*)dlopen((char *) exePath, RTLD_NOW | RTLD_LOCAL));
    if (!mModule)
       return false;
  
    // Try to locate the NEW plugin entry point
    pluginMain = (vstPluginMain) dlsym(mModule.get(), "VSTPluginMain");
  
    // If not found, try finding the old entry point
    if (pluginMain == NULL)
    {
       pluginMain = (vstPluginMain) dlsym(mModule.get(), "main_macho");
    }
  
    // Must not be a VST plugin
    if (pluginMain == NULL)
    {
       mModule.reset();
       return false;
    }
  
    // Need to keep the bundle reference around so we can map the
    // resources.
    mBundleRef = std::move(bundleRef);
  
    // Open the resource map ... some plugins (like GRM Tools) need this.
    mResource = ResourceHandle{
       mBundleRef.get(), CFBundleOpenBundleResourceMap(mBundleRef.get())
    };
  
 #elif defined(__WXMSW__)
  
    {
       wxLogNull nolog;
  
       // Try to load the library
       auto lib = std::make_unique<wxDynamicLibrary>(realPath);
       if (!lib) 
          return false;
  
       // Bail if it wasn't successful
       if (!lib->IsLoaded())
          return false;
  
       // Try to find the entry point, while suppressing error messages
       pluginMain = (vstPluginMain) lib->GetSymbol(wxT("VSTPluginMain"));
       if (pluginMain == NULL)
       {
          pluginMain = (vstPluginMain) lib->GetSymbol(wxT("main"));
          if (pluginMain == NULL)
             return false;
       }
  
       // Save the library reference
       mModule = std::move(lib);
    }
  
 #else
  
    // Attempt to load it
    //
    // Spent a few days trying to figure out why some VSTs where running okay and
    // others were hit or miss.  The cause was that we export all of Audacity's
    // symbols and some of the loaded libraries were picking up Audacity's and 
    // not their own.
    //
    // So far, I've only seen this issue on Linux, but we might just be getting
    // lucky on the Mac and Windows.  The sooner we stop exporting everything
    // the better.
    //
    // To get around the problem, I just added the RTLD_DEEPBIND flag to the load
    // and that "basically" puts Audacity last when the loader needs to resolve
    // symbols.
    //
    // Once we define a proper external API, the flags can be removed.
 #ifndef RTLD_DEEPBIND
 #define RTLD_DEEPBIND 0
 #endif
    ModuleHandle lib {
       (char*) dlopen((const char *)wxString(realPath).ToUTF8(),
                      RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND)
    };
    if (!lib) 
    {
       return false;
    }
  
    // Try to find the entry point, while suppressing error messages
    pluginMain = (vstPluginMain) dlsym(lib.get(), "VSTPluginMain");
    if (pluginMain == NULL)
    {
       pluginMain = (vstPluginMain) dlsym(lib.get(), "main");
       if (pluginMain == NULL)
          return false;
    }
  
    // Save the library reference
    mModule = std::move(lib);
  
 #endif
  
    // Initialize the plugin
    try
    {
       mAEffect = pluginMain(VSTEffect::AudioMaster);
    }
    catch (...)
    {
       wxLogMessage(wxT("VST plugin initialization failed\n"));
       mAEffect = NULL;
    }
  
    // Was it successful?
    if (mAEffect)
    {
       // Save a reference to ourselves
       //
       // Note:  Some hosts use "user" and some use "ptr2/resvd2".  It might
       //        be worthwhile to check if user is NULL before using it and
       //        then falling back to "ptr2/resvd2".
       mAEffect->ptr2 = this;
  
       // Give the plugin an initial sample rate and blocksize
       callDispatcher(effSetSampleRate, 0, 0, NULL, 48000.0);
       callDispatcher(effSetBlockSize, 0, 512, NULL, 0);
  
       // Ask the plugin to identify itself...might be needed for older plugins
       callDispatcher(effIdentify, 0, 0, NULL, 0);
  
       // Open the plugin
       callDispatcher(effOpen, 0, 0, NULL, 0.0);
  
       // Get the VST version the plugin understands
       mVstVersion = callDispatcher(effGetVstVersion, 0, 0, NULL, 0);
  
       // Set it again in case plugin ignored it before the effOpen
       callDispatcher(effSetSampleRate, 0, 0, NULL, 48000.0);
       callDispatcher(effSetBlockSize, 0, 512, NULL, 0);
  
       // Ensure that it looks like a plugin and can deal with ProcessReplacing
       // calls.  Also exclude synths for now.
       if (mAEffect->magic == kEffectMagic &&
          !(mAEffect->flags & effFlagsIsSynth) &&
          mAEffect->flags & effFlagsCanReplacing)
       {
          if (mVstVersion >= 2)
          {
             mName = GetString(effGetEffectName);
             if (mName.length() == 0)
             {
                mName = GetString(effGetProductString);
             }
          }
          if (mName.length() == 0)
          {
             mName = wxFileName{realPath}.GetName();
          }
  
          if (mVstVersion >= 2)
          {
             mVendor = GetString(effGetVendorString);
             mVersion = wxINT32_SWAP_ON_LE(callDispatcher(effGetVendorVersion, 0, 0, NULL, 0));
          }
          if (mVersion == 0)
          {
             mVersion = wxINT32_SWAP_ON_LE(mAEffect->version);
          }
  
          if (mAEffect->flags & effFlagsHasEditor || mAEffect->numParams != 0)
          {
             mInteractive = true;
          }
  
          mAudioIns = mAEffect->numInputs;
          mAudioOuts = mAEffect->numOutputs;
  
          mMidiIns = 0;
          mMidiOuts = 0;
  
          // Check to see if parameters can be automated.  This isn't a guarantee
          // since it could be that the effect simply doesn't support the opcode.
          mAutomatable = false;
          for (int i = 0; i < mAEffect->numParams; i++)
          {
             if (callDispatcher(effCanBeAutomated, 0, i, NULL, 0.0))
             {
                mAutomatable = true;
                break;
             }
          }
  
          // Make sure we start out with a valid program selection
          // I've found one plugin (SoundHack +morphfilter) that will
          // crash Audacity when saving the initial default parameters
          // with this.
          callSetProgram(0);
  
          // Pretty confident that we're good to go
          success = true;
       }
    }
  
    if (!success)
    {
       Unload();
    }
  
    return success;
 }

References AudioMaster(), callDispatcher(), callSetProgram(), effCanBeAutomated, effFlagsCanReplacing, effFlagsHasEditor, effFlagsIsSynth, effGetEffectName, effGetProductString, effGetVendorString, effGetVendorVersion, effGetVstVersion, effIdentify, effOpen, effSetBlockSize, effSetSampleRate, AEffect::flags, GetString(), kEffectMagic, mAEffect, AEffect::magic, mAudioIns, mAudioOuts, mAutomatable, mCurrentEffectID, mInteractive, mMidiIns, mMidiOuts, mModule, mName, mPath, mVendor, mVersion, mVstVersion, AEffect::numInputs, AEffect::numOutputs, AEffect::numParams, PLATFORM_MAX_PATH, AEffect::ptr2, RTLD_DEEPBIND, Unload(), and AEffect::version.

Referenced by SetHost(), and VSTEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadFactoryDefaults()

bool VSTEffect::LoadFactoryDefaults ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1734 of file VSTEffect.cpp.

 {
    if (!LoadParameters(mHost->GetFactoryDefaultsGroup()))
    {
       return false;
    }
  
    RefreshParameters();
  
    return true;
 }

References EffectHostInterface::GetFactoryDefaultsGroup(), LoadParameters(), mHost, and RefreshParameters().

Here is the call graph for this function:

◆ LoadFactoryPreset()

bool VSTEffect::LoadFactoryPreset ( int id )

overridevirtual

Implements EffectClientInterface.

Definition at line 1725 of file VSTEffect.cpp.

 {
    callSetProgram(id);
  
    RefreshParameters();
  
    return true;
 }

References callSetProgram(), and RefreshParameters().

Here is the call graph for this function:

◆ LoadFXB()

bool VSTEffect::LoadFXB ( const wxFileName & fn )

private

Definition at line 3051 of file VSTEffect.cpp.

 {
    bool ret = false;
  
    // Try to open the file...will be closed automatically when method returns
    wxFFile f(fn.GetFullPath(), wxT("rb"));
    if (!f.IsOpened())
    {
       return false;
    }
  
    // Allocate memory for the contents
    ArrayOf<unsigned char> data{ size_t(f.Length()) };
    if (!data)
    {
       AudacityMessageBox(
          XO("Unable to allocate memory when loading presets file."),
          XO("Error Loading VST Presets"),
          wxOK | wxCENTRE,
          mParent);
       return false;
    }
    unsigned char *bptr = data.get();
  
    do
    {
       // Read in the whole file
       ssize_t len = f.Read((void *) bptr, f.Length());
       if (f.Error())
       {
          AudacityMessageBox(
             XO("Unable to read presets file."),
             XO("Error Loading VST Presets"),
             wxOK | wxCENTRE,
             mParent);
          break;
       }
  
       // Most references to the data are via an "int" array
       int32_t *iptr = (int32_t *) bptr;
  
       // Verify that we have at least enough for the header
       if (len < 156)
       {
          break;
       }
  
       // Verify that we probably have an FX file
       if (wxINT32_SWAP_ON_LE(iptr[0]) != CCONST('C', 'c', 'n', 'K'))
       {
          break;
       }
  
       // Ignore the size...sometimes it's there, other times it's zero
  
       // Get the version and verify
       int version = wxINT32_SWAP_ON_LE(iptr[3]);
       if (version != 1 && version != 2)
       {
          break;
       }
  
       VstPatchChunkInfo info =
       {
          1,
          wxINT32_SWAP_ON_LE(iptr[4]),
          wxINT32_SWAP_ON_LE(iptr[5]),
          wxINT32_SWAP_ON_LE(iptr[6]),
          ""
       };
  
       // Ensure this program looks to belong to the current plugin
       if ((info.pluginUniqueID != mAEffect->uniqueID) &&
           (info.pluginVersion != mAEffect->version) &&
           (info.numElements != mAEffect->numPrograms))
       {
          break;
       }
  
       // Get the number of programs
       int numProgs = info.numElements;
  
       // Get the current program index
       int curProg = 0;
       if (version >= 2)
       {
          curProg = wxINT32_SWAP_ON_LE(iptr[7]);
          if (curProg < 0 || curProg >= numProgs)
          {
             break;
          }
       }
  
       // Is it a bank of programs?
       if (wxINT32_SWAP_ON_LE(iptr[2]) == CCONST('F', 'x', 'B', 'k'))
       {
          // Drop the header
          bptr += 156;
          len -= 156;
  
          unsigned char *tempPtr = bptr;
          ssize_t tempLen = len;
  
          // Validate all of the programs
          for (int i = 0; i < numProgs; i++)
          {
             if (!LoadFXProgram(&tempPtr, tempLen, i, true))
             {
                break;
             }
          }
  
          // Ask the effect if this is an acceptable bank
          if (callDispatcher(effBeginLoadBank, 0, 0, &info, 0.0) == -1)
          {
             return false;
          }
  
          // Start loading the individual programs
          for (int i = 0; i < numProgs; i++)
          {
             ret = LoadFXProgram(&bptr, len, i, false);
          }
       }
       // Or maybe a bank chunk?
       else if (wxINT32_SWAP_ON_LE(iptr[2]) == CCONST('F', 'B', 'C', 'h'))
       {
          // Can't load programs chunks if the plugin doesn't support it
          if (!(mAEffect->flags & effFlagsProgramChunks))
          {
             break;
          }
  
          // Verify that we have enough to grab the chunk size
          if (len < 160)
          {
             break;
          }
  
          // Get the chunk size
          int size = wxINT32_SWAP_ON_LE(iptr[39]);
  
          // We finally know the full length of the program
          int proglen = 160 + size;
  
          // Verify that we have enough for the entire program
          if (len < proglen)
          {
             break;
          }
  
          // Set the entire bank in one shot
          callSetChunk(false, size, &iptr[40], &info);
  
          // Success
          ret = true;
       }
       // Unrecognizable type
       else
       {
          break;
       }
  
       // Set the active program
       if (ret && version >= 2)
       {
          callSetProgram(curProg);
       }
    } while (false);
  
    return ret;
 }

References AudacityMessageBox(), callDispatcher(), callSetChunk(), callSetProgram(), CCONST, effBeginLoadBank, effFlagsProgramChunks, AEffect::flags, fn, LoadFXProgram(), mAEffect, mParent, VstPatchChunkInfo::numElements, AEffect::numPrograms, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, AEffect::uniqueID, AEffect::version, and XO.

Referenced by ImportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadFXP()

bool VSTEffect::LoadFXP ( const wxFileName & fn )

private

Definition at line 3224 of file VSTEffect.cpp.

 {
    bool ret = false;
  
    // Try to open the file...will be closed automatically when method returns
    wxFFile f(fn.GetFullPath(), wxT("rb"));
    if (!f.IsOpened())
    {
       return false;
    }
  
    // Allocate memory for the contents
    ArrayOf<unsigned char> data{ size_t(f.Length()) };
    if (!data)
    {
       AudacityMessageBox(
          XO("Unable to allocate memory when loading presets file."),
          XO("Error Loading VST Presets"),
          wxOK | wxCENTRE,
          mParent);
       return false;
    }
    unsigned char *bptr = data.get();
  
    do
    {
       // Read in the whole file
       ssize_t len = f.Read((void *) bptr, f.Length());
       if (f.Error())
       {
          AudacityMessageBox(
             XO("Unable to read presets file."),
             XO("Error Loading VST Presets"),
             wxOK | wxCENTRE,
             mParent);
          break;
       }
  
       // Get (or default) currently selected program
       int i = 0; //mProgram->GetCurrentSelection();
       if (i < 0)
       {
          i = 0;   // default to first program
       }
  
       // Go verify and set the program
       ret = LoadFXProgram(&bptr, len, i, false);
    } while (false);
  
    return ret;
 }

References AudacityMessageBox(), fn, LoadFXProgram(), mParent, and XO.

Referenced by ImportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadFXProgram()

bool VSTEffect::LoadFXProgram	(	unsigned char **	bptr,
		ssize_t &	len,
		int	index,
		bool	dryrun
	)

private

Definition at line 3276 of file VSTEffect.cpp.

 {
    // Most references to the data are via an "int" array
    int32_t *iptr = (int32_t *) *bptr;
  
    // Verify that we have at least enough for a program without parameters
    if (len < 28)
    {
       return false;
    }
  
    // Verify that we probably have an FX file
    if (wxINT32_SWAP_ON_LE(iptr[0]) != CCONST('C', 'c', 'n', 'K'))
    {
       return false;
    }
  
    // Ignore the size...sometimes it's there, other times it's zero
  
    // Get the version and verify
 #if defined(IS_THIS_AN_FXP_ARTIFICAL_LIMITATION)
    int version = wxINT32_SWAP_ON_LE(iptr[3]);
    if (version != 1)
    {
       return false;
    }
 #endif
  
    VstPatchChunkInfo info =
    {
       1,
       wxINT32_SWAP_ON_LE(iptr[4]),
       wxINT32_SWAP_ON_LE(iptr[5]),
       wxINT32_SWAP_ON_LE(iptr[6]),
       ""
    };
  
    // Ensure this program looks to belong to the current plugin
    if ((info.pluginUniqueID != mAEffect->uniqueID) &&
          (info.pluginVersion != mAEffect->version) &&
          (info.numElements != mAEffect->numParams))
    {
       return false;
    }
  
    // Get the number of parameters
    int numParams = info.numElements;
  
    // At this point, we have to have enough to include the program name as well
    if (len < 56)
    {
       return false;
    }
  
    // Get the program name
    wxString progName(wxString::From8BitData((char *)&iptr[7]));
  
    // Might be a regular program
    if (wxINT32_SWAP_ON_LE(iptr[2]) == CCONST('F', 'x', 'C', 'k'))
    {
       // We finally know the full length of the program
       int proglen = 56 + (numParams * sizeof(float));
  
       // Verify that we have enough for all of the parameter values
       if (len < proglen)
       {
          return false;
       }
  
       // Validate all of the parameter values
       for (int i = 0; i < numParams; i++)
       {
          uint32_t ival = wxUINT32_SWAP_ON_LE(iptr[14 + i]);
          float val = reinterpretAsFloat(ival);
          if (val < 0.0 || val > 1.0)
          {
             return false;
          }
       }
          
       // They look okay...time to start changing things
       if (!dryrun)
       {
          // Ask the effect if this is an acceptable program
          if (callDispatcher(effBeginLoadProgram, 0, 0, &info, 0.0) == -1)
          {
             return false;
          }
  
          // Load all of the parameters
          callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
          for (int i = 0; i < numParams; i++)
          {
             wxUint32 val = wxUINT32_SWAP_ON_LE(iptr[14 + i]);
             callSetParameter(i, reinterpretAsFloat(val));
          }
          callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
       }
  
       // Update in case we're loading an "FxBk" format bank file
       *bptr += proglen;
       len -= proglen;
    }
    // Maybe we have a program chunk
    else if (wxINT32_SWAP_ON_LE(iptr[2]) == CCONST('F', 'P', 'C', 'h'))
    {
       // Can't load programs chunks if the plugin doesn't support it
       if (!(mAEffect->flags & effFlagsProgramChunks))
       {
          return false;
       }
  
       // Verify that we have enough to grab the chunk size
       if (len < 60)
       {
          return false;
       }
  
       // Get the chunk size
       int size = wxINT32_SWAP_ON_LE(iptr[14]);
  
       // We finally know the full length of the program
       int proglen = 60 + size;
  
       // Verify that we have enough for the entire program
       if (len < proglen)
       {
          return false;
       }
  
       // Set the entire program in one shot
       if (!dryrun)
       {
          callSetChunk(true, size, &iptr[15], &info);
       }
  
       // Update in case we're loading an "FxBk" format bank file
       *bptr += proglen;
       len -= proglen;
    }
    else
    {
       // Unknown type
       return false;
    }
    
    if (!dryrun)
    {
       SetString(effSetProgramName, wxString(progName), index);
    }
  
    return true;
 }

References callDispatcher(), callSetChunk(), callSetParameter(), CCONST, effBeginLoadProgram, effBeginSetProgram, effEndSetProgram, effFlagsProgramChunks, effSetProgramName, AEffect::flags, mAEffect, VstPatchChunkInfo::numElements, AEffect::numParams, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, reinterpretAsFloat(), SetString(), AEffect::uniqueID, and AEffect::version.

Referenced by LoadFXB(), and LoadFXP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadParameters()

bool VSTEffect::LoadParameters ( const RegistryPath & group )

private

Definition at line 2319 of file VSTEffect.cpp.

 {
    wxString value;
  
    VstPatchChunkInfo info = {1, mAEffect->uniqueID, mAEffect->version, mAEffect->numParams, ""};
    mHost->GetPrivateConfig(group, wxT("UniqueID"), info.pluginUniqueID, info.pluginUniqueID);
    mHost->GetPrivateConfig(group, wxT("Version"), info.pluginVersion, info.pluginVersion);
    mHost->GetPrivateConfig(group, wxT("Elements"), info.numElements, info.numElements);
  
    if ((info.pluginUniqueID != mAEffect->uniqueID) ||
        (info.pluginVersion != mAEffect->version) ||
        (info.numElements != mAEffect->numParams))
    {
       return false;
    }
  
    if (mHost->GetPrivateConfig(group, wxT("Chunk"), value, wxEmptyString))
    {
       ArrayOf<char> buf{ value.length() / 4 * 3 };
  
       int len = VSTEffect::b64decode(value, buf.get());
       if (len)
       {
          callSetChunk(true, len, buf.get(), &info);
       }
  
       return true;
    }
  
    wxString parms;
    if (!mHost->GetPrivateConfig(group, wxT("Parameters"), parms, wxEmptyString))
    {
       return false;
    }
  
    CommandParameters eap;
    if (!eap.SetParameters(parms))
    {
       return false;
    }
  
    return SetAutomationParameters(eap);
 }

References b64decode(), callSetChunk(), ConfigClientInterface::GetPrivateConfig(), mAEffect, mHost, VstPatchChunkInfo::numElements, AEffect::numParams, VstPatchChunkInfo::pluginUniqueID, VstPatchChunkInfo::pluginVersion, SetAutomationParameters(), CommandParameters::SetParameters(), AEffect::uniqueID, and AEffect::version.

Referenced by LoadFactoryDefaults(), LoadUserPreset(), and SetHost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadUserPreset()

bool VSTEffect::LoadUserPreset ( const RegistryPath & name )

overridevirtual

Implements EffectClientInterface.

Definition at line 1690 of file VSTEffect.cpp.

 {
    if (!LoadParameters(name))
    {
       return false;
    }
  
    RefreshParameters();
  
    return true;
 }

References LoadParameters(), name, and RefreshParameters().

Here is the call graph for this function:

◆ LoadXML()

bool VSTEffect::LoadXML ( const wxFileName & fn )

private

Definition at line 3430 of file VSTEffect.cpp.

 {
    mInChunk = false;
    mInSet = false;
  
    // default to read as XML file
    // Load the program
    XMLFileReader reader;
    bool ok = reader.Parse(this, fn.GetFullPath());
  
    // Something went wrong with the file, clean up
    if (mInSet)
    {
       callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
  
       mInSet = false;
    }
  
    if (!ok)
    {
       // Inform user of load failure
       AudacityMessageBox(
          reader.GetErrorStr(),
          XO("Error Loading VST Presets"),
          wxOK | wxCENTRE,
          mParent);
       return false;
    }
  
    return true;
 }

References AudacityMessageBox(), callDispatcher(), effEndSetProgram, fn, XMLFileReader::GetErrorStr(), mInChunk, mInSet, mParent, XMLFileReader::Parse(), and XO.

Referenced by ImportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NeedEditIdle()

void VSTEffect::NeedEditIdle ( bool state )

private

Definition at line 2428 of file VSTEffect.cpp.

 {
    mWantsEditIdle = state;
    mTimer->Start(100);
 }

References mTimer, and mWantsEditIdle.

Referenced by BuildFancy(), and CloseUI().

Here is the caller graph for this function:

◆ NeedIdle()

void VSTEffect::NeedIdle ( )

private

Definition at line 2422 of file VSTEffect.cpp.

 {
    mWantsIdle = true;
    mTimer->Start(100);
 }

References mTimer, and mWantsIdle.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ OnLoad()

void VSTEffect::OnLoad ( wxCommandEvent & evt )

private

◆ OnProgram()

void VSTEffect::OnProgram ( wxCommandEvent & evt )

private

◆ OnProgramText()

void VSTEffect::OnProgramText ( wxCommandEvent & evt )

private

◆ OnSave()

void VSTEffect::OnSave ( wxCommandEvent & evt )

private

◆ OnSettings()

void VSTEffect::OnSettings ( wxCommandEvent & evt )

private

◆ OnSizeWindow()

void VSTEffect::OnSizeWindow ( wxCommandEvent & evt )

private

Definition at line 3019 of file VSTEffect.cpp.

 {
    if (!mControl)
    {
       return;
    }
  
    mControl->SetMinSize(wxSize(evt.GetInt(), (int) evt.GetExtraLong()));
    mControl->SetSize(wxSize(evt.GetInt(), (int) evt.GetExtraLong()));
  
    // DO NOT CHANGE THE ORDER OF THESE
    //
    // Guitar Rig (and possibly others) Cocoa VSTs can resize too large
    // if the bounds are unlimited.
    mDialog->SetMinSize(wxDefaultSize);
    mDialog->SetMaxSize(wxDefaultSize);
    mDialog->Layout();
    mDialog->SetMinSize(mDialog->GetBestSize());
    mDialog->SetMaxSize(mDialog->GetBestSize());
    mDialog->Fit();
 }

References mControl, and mDialog.

◆ OnSlider()

void VSTEffect::OnSlider ( wxCommandEvent & evt )

private

Definition at line 3041 of file VSTEffect.cpp.

 {
    wxSlider *s = (wxSlider *) evt.GetEventObject();
    int i = s->GetId() - ID_Sliders;
  
    callSetParameter(i, s->GetValue() / 1000.0);
  
    RefreshParameters(i);
 }

References callSetParameter(), ID_Sliders, and RefreshParameters().

Here is the call graph for this function:

◆ OnTimer()

void VSTEffect::OnTimer ( )

Definition at line 2397 of file VSTEffect.cpp.

 {
    wxRecursionGuard guard(mTimerGuard);
  
    // Ignore it if we're recursing
    if (guard.IsInside())
    {
       return;
    }
  
    if (mVstVersion >= 2 && mWantsIdle)
    {
       int ret = callDispatcher(effIdle, 0, 0, NULL, 0.0);
       if (!ret)
       {
          mWantsIdle = false;
       }
    }
  
    if (mWantsEditIdle)
    {
       callDispatcher(effEditIdle, 0, 0, NULL, 0.0);
    }
 }

References callDispatcher(), effEditIdle, effIdle, mTimerGuard, mVstVersion, mWantsEditIdle, and mWantsIdle.

Referenced by VSTEffectTimer::Notify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnUpdateDisplay()

void VSTEffect::OnUpdateDisplay ( wxCommandEvent & evt )

private

◆ PopulateUI()

bool VSTEffect::PopulateUI ( ShuttleGui & S )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1755 of file VSTEffect.cpp.

 {
    auto parent = S.GetParent();
    mDialog = static_cast<wxDialog *>(wxGetTopLevelParent(parent));
    mParent = parent;
  
    mParent->PushEventHandler(this);
  
    // Determine if the VST editor is supposed to be used or not
    mHost->GetSharedConfig(wxT("Options"),
                           wxT("UseGUI"),
                           mGui,
                           true);
    mGui = mAEffect->flags & effFlagsHasEditor ? mGui : false;
  
    // Must use the GUI editor if parameters aren't provided
    if (mAEffect->numParams == 0)
    {
       mGui = true;
    }
  
    // Build the appropriate dialog type
    if (mGui)
    {
       BuildFancy();
    }
    else
    {
       BuildPlain();
    }
  
    return true;
 }

References BuildFancy(), BuildPlain(), effFlagsHasEditor, AEffect::flags, ShuttleGuiBase::GetParent(), ConfigClientInterface::GetSharedConfig(), mAEffect, mDialog, mGui, mHost, mParent, and AEffect::numParams.

Here is the call graph for this function:

◆ PowerOff()

void VSTEffect::PowerOff ( )

private

Definition at line 2468 of file VSTEffect.cpp.

 {
    if (mHasPower)
    {
       // Tell the effect we're going to stop processing
       if (mVstVersion >= 2)
       {
          callDispatcher(effStopProcess, 0, 0, NULL, 0.0);
       }
  
       // Turn the power off
       callDispatcher(effMainsChanged, 0, 0, NULL, 0.0);
  
       // Set state
       mHasPower = false;
    }
 }

References callDispatcher(), effMainsChanged, effStopProcess, mHasPower, and mVstVersion.

Referenced by CloseUI(), ProcessFinalize(), RealtimeSuspend(), and Unload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PowerOn()

void VSTEffect::PowerOn ( )

private

Definition at line 2450 of file VSTEffect.cpp.

 {
    if (!mHasPower)
    {
       // Turn the power on
       callDispatcher(effMainsChanged, 0, 1, NULL, 0.0);
  
       // Tell the effect we're going to start processing
       if (mVstVersion >= 2)
       {
          callDispatcher(effStartProcess, 0, 0, NULL, 0.0);
       }
  
       // Set state
       mHasPower = true;
    }
 }

References callDispatcher(), effMainsChanged, effStartProcess, mHasPower, and mVstVersion.

Referenced by BuildFancy(), ProcessInitialize(), and RealtimeResume().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessBlock()

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

overridevirtual

Implements EffectClientInterface.

Definition at line 1430 of file VSTEffect.cpp.

 {
    // Only call the effect if there's something to do...some do not like zero-length block
    if (blockLen)
    {
       // Go let the plugin moleste the samples
       callProcessReplacing(inBlock, outBlock, blockLen);
  
       // And track the position
       mTimeInfo.samplePos += (double) blockLen;
    }
  
    return blockLen;
 }

References callProcessReplacing(), mTimeInfo, and VstTimeInfo::samplePos.

Referenced by RealtimeProcessEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessFinalize()

bool VSTEffect::ProcessFinalize ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1421 of file VSTEffect.cpp.

 {
    mReady = false;
  
    PowerOff();
  
    return true;
 }

References mReady, and PowerOff().

Referenced by RealtimeFinalize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessInitialize()

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

overridevirtual

Implements EffectClientInterface.

Definition at line 1395 of file VSTEffect.cpp.

 {
    // Initialize time info
    memset(&mTimeInfo, 0, sizeof(mTimeInfo));
    mTimeInfo.sampleRate = mSampleRate;
    mTimeInfo.nanoSeconds = wxGetUTCTimeMillis().ToDouble();
    mTimeInfo.tempo = 120.0;
    mTimeInfo.timeSigNumerator = 4;
    mTimeInfo.timeSigDenominator = 4;
    mTimeInfo.flags = kVstTempoValid | kVstNanosValid | kVstTransportPlaying;
  
    // Set processing parameters...power must be off for this
    callDispatcher(effSetSampleRate, 0, 0, NULL, mSampleRate);
    callDispatcher(effSetBlockSize, 0, mBlockSize, NULL, 0.0);
  
    // Turn on the power
    PowerOn();
  
    // Set the initial buffer delay
    SetBufferDelay(mAEffect->initialDelay);
  
    mReady = true;
  
    return true;
 }

References callDispatcher(), effSetBlockSize, effSetSampleRate, VstTimeInfo::flags, AEffect::initialDelay, kVstNanosValid, kVstTempoValid, kVstTransportPlaying, mAEffect, mBlockSize, mReady, mSampleRate, mTimeInfo, VstTimeInfo::nanoSeconds, PowerOn(), VstTimeInfo::sampleRate, SetBufferDelay(), VstTimeInfo::tempo, VstTimeInfo::timeSigDenominator, and VstTimeInfo::timeSigNumerator.

Referenced by RealtimeAddProcessor(), RealtimeInitialize(), and ShowInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RealtimeAddProcessor()

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

overridevirtual

Implements EffectClientInterface.

Definition at line 1463 of file VSTEffect.cpp.

 {
    mSlaves.push_back(std::make_unique<VSTEffect>(mPath, this));
    VSTEffect *const slave = mSlaves.back().get();
  
    slave->SetBlockSize(mBlockSize);
    slave->SetChannelCount(numChannels);
    slave->SetSampleRate(sampleRate);
  
    int clen = 0;
    if (mAEffect->flags & effFlagsProgramChunks)
    {
       void *chunk = NULL;
  
       clen = (int) callDispatcher(effGetChunk, 1, 0, &chunk, 0.0); // get master's chunk, for the program only
       if (clen != 0)
       {
          slave->callSetChunk(true, clen, chunk); // copy state to slave, for the program only
       }
    }
  
    if (clen == 0)
    {
       callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
  
       for (int i = 0; i < mAEffect->numParams; i++)
       {
          slave->callSetParameter(i, callGetParameter(i));
       }
  
       callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
    }
  
    return slave->ProcessInitialize(0, NULL);
 }

References callDispatcher(), callGetParameter(), callSetChunk(), callSetParameter(), effBeginSetProgram, effEndSetProgram, effFlagsProgramChunks, effGetChunk, AEffect::flags, mAEffect, mBlockSize, mPath, mSlaves, AEffect::numParams, ProcessInitialize(), SetBlockSize(), SetChannelCount(), and SetSampleRate().

Here is the call graph for this function:

◆ RealtimeFinalize()

bool VSTEffect::RealtimeFinalize ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1499 of file VSTEffect.cpp.

 {
    for (const auto &slave : mSlaves)
       slave->ProcessFinalize();
    mSlaves.clear();
  
    mMasterIn.reset();
  
    mMasterOut.reset();
  
    return ProcessFinalize();
 }

References mMasterIn, mMasterOut, mSlaves, and ProcessFinalize().

Here is the call graph for this function:

◆ RealtimeInitialize()

bool VSTEffect::RealtimeInitialize ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1455 of file VSTEffect.cpp.

 {
    mMasterIn.reinit( mAudioIns, mBlockSize, true );
    mMasterOut.reinit( mAudioOuts, mBlockSize );
  
    return ProcessInitialize(0, NULL);
 }

References mAudioIns, mAudioOuts, mBlockSize, mMasterIn, mMasterOut, ProcessInitialize(), and ArraysOf< X >::reinit().

Here is the call graph for this function:

◆ RealtimeProcess()

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

overridevirtual

Implements EffectClientInterface.

Definition at line 1542 of file VSTEffect.cpp.

 {
    wxASSERT(numSamples <= mBlockSize);
  
    for (unsigned int c = 0; c < mAudioIns; c++)
    {
       for (decltype(numSamples) s = 0; s < numSamples; s++)
       {
          mMasterIn[c][s] += inbuf[c][s];
       }
    }
    mNumSamples = std::max(numSamples, mNumSamples);
  
    return mSlaves[group]->ProcessBlock(inbuf, outbuf, numSamples);
 }

References mAudioIns, mBlockSize, mMasterIn, mNumSamples, and mSlaves.

◆ RealtimeProcessEnd()

bool VSTEffect::RealtimeProcessEnd ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1558 of file VSTEffect.cpp.

 {
    // These casts to float** should be safe...
    ProcessBlock(
       reinterpret_cast <float**> (mMasterIn.get()),
       reinterpret_cast <float**> (mMasterOut.get()),
       mNumSamples);
  
    return true;
 }

References mMasterIn, mMasterOut, mNumSamples, and ProcessBlock().

Here is the call graph for this function:

◆ RealtimeProcessStart()

bool VSTEffect::RealtimeProcessStart ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1532 of file VSTEffect.cpp.

 {
    for (unsigned int i = 0; i < mAudioIns; i++)
       memset(mMasterIn[i].get(), 0, mBlockSize * sizeof(float));
  
    mNumSamples = 0;
  
    return true;
 }

References mAudioIns, mBlockSize, mMasterIn, and mNumSamples.

◆ RealtimeResume()

bool VSTEffect::RealtimeResume ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1522 of file VSTEffect.cpp.

 {
    PowerOn();
  
    for (const auto &slave : mSlaves)
       slave->PowerOn();
  
    return true;
 }

References mSlaves, and PowerOn().

Here is the call graph for this function:

◆ RealtimeSuspend()

bool VSTEffect::RealtimeSuspend ( )

overridevirtual

Implements EffectClientInterface.

Definition at line 1512 of file VSTEffect.cpp.

 {
    PowerOff();
  
    for (const auto &slave : mSlaves)
       slave->PowerOff();
  
    return true;
 }

References mSlaves, and PowerOff().

Here is the call graph for this function:

◆ RefreshParameters()

void VSTEffect::RefreshParameters ( int skip = -1 )

private

Definition at line 2968 of file VSTEffect.cpp.

 {
    if (!mNames)
    {
       return;
    }
  
    for (int i = 0; i < mAEffect->numParams; i++)
    {
       wxString text = GetString(effGetParamName, i);
  
       text = text.Trim(true).Trim(false);
  
       wxString name = text;
  
       if (text.Right(1) != wxT(':'))
       {
          text += wxT(':');
       }
       mNames[i]->SetLabel(text);
  
       // For some parameters types like on/off, setting the slider value has
       // a side effect that causes it to only move when the parameter changes
       // from off to on.  However, this prevents changing the value using the
       // keyboard, so we skip the active slider if any.
       if (i != skip)
       {
          mSliders[i]->SetValue(callGetParameter(i) * 1000);
       }
       name = text;
  
       text = GetString(effGetParamDisplay, i);
       if (text.empty())
       {
          text.Printf(wxT("%.5g"),callGetParameter(i));
       }
       mDisplays[i]->SetLabel(wxString::Format(wxT("%8s"), text));
       name += wxT(' ') + text;
  
       text = GetString(effGetParamDisplay, i);
       if (!text.empty())
       {
          text.Printf(wxT("%-8s"), GetString(effGetParamLabel, i));
          mLabels[i]->SetLabel(wxString::Format(wxT("%8s"), text));
          name += wxT(' ') + text;
       }
  
       mSliders[i]->SetName(name);
    }
 }

References callGetParameter(), effGetParamDisplay, effGetParamLabel, effGetParamName, GetString(), mAEffect, mDisplays, mLabels, mNames, mSliders, name, and AEffect::numParams.

Referenced by BuildPlain(), ImportPresets(), LoadFactoryDefaults(), LoadFactoryPreset(), LoadUserPreset(), and OnSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveHandler()

void VSTEffect::RemoveHandler ( )

private

Definition at line 2780 of file VSTEffect.cpp.

2781 {

2782 }

Referenced by CloseUI().

Here is the caller graph for this function:

◆ SaveFXB()

void VSTEffect::SaveFXB ( const wxFileName & fn )

private

Definition at line 3462 of file VSTEffect.cpp.

 {
    // Create/Open the file
    const wxString fullPath{fn.GetFullPath()};
    wxFFile f(fullPath, wxT("wb"));
    if (!f.IsOpened())
    {
       AudacityMessageBox(
          XO("Could not open file: \"%s\"").Format( fullPath ),
          XO("Error Saving VST Presets"),
          wxOK | wxCENTRE,
          mParent);
       return;
    }
  
    wxMemoryBuffer buf;
    wxInt32 subType;
    void *chunkPtr = nullptr;
    int chunkSize = 0;
    int dataSize = 148;
    wxInt32 tab[8];
    int curProg = 0 ; //mProgram->GetCurrentSelection();
  
    if (mAEffect->flags & effFlagsProgramChunks)
    {
       subType = CCONST('F', 'B', 'C', 'h');
  
       chunkSize = callDispatcher(effGetChunk, 0, 0, &chunkPtr, 0.0);
       dataSize += 4 + chunkSize;
    }
    else
    {
       subType = CCONST('F', 'x', 'B', 'k');
  
       for (int i = 0; i < mAEffect->numPrograms; i++)
       {
          SaveFXProgram(buf, i);
       }
  
       dataSize += buf.GetDataLen();
    }
  
    tab[0] = wxINT32_SWAP_ON_LE(CCONST('C', 'c', 'n', 'K'));
    tab[1] = wxINT32_SWAP_ON_LE(dataSize);
    tab[2] = wxINT32_SWAP_ON_LE(subType);
    tab[3] = wxINT32_SWAP_ON_LE(curProg >= 0 ? 2 : 1);
    tab[4] = wxINT32_SWAP_ON_LE(mAEffect->uniqueID);
    tab[5] = wxINT32_SWAP_ON_LE(mAEffect->version);
    tab[6] = wxINT32_SWAP_ON_LE(mAEffect->numPrograms);
    tab[7] = wxINT32_SWAP_ON_LE(curProg >= 0 ? curProg : 0);
  
    f.Write(tab, sizeof(tab));
    if (!f.Error())
    {
       char padding[124];
       memset(padding, 0, sizeof(padding));
       f.Write(padding, sizeof(padding));
  
       if (!f.Error())
       {
          if (mAEffect->flags & effFlagsProgramChunks)
          {
             wxInt32 size = wxINT32_SWAP_ON_LE(chunkSize);
             f.Write(&size, sizeof(size));
             f.Write(chunkPtr, chunkSize);
          }
          else
          {
             f.Write(buf.GetData(), buf.GetDataLen());
          }
       }
    }
  
    if (f.Error())
    {
       AudacityMessageBox(
          XO("Error writing to file: \"%s\"").Format( fullPath ),
          XO("Error Saving VST Presets"),
          wxOK | wxCENTRE,
          mParent);
    }
  
    f.Close();
  
    return;
 }

References AudacityMessageBox(), callDispatcher(), CCONST, effFlagsProgramChunks, effGetChunk, AEffect::flags, fn, mAEffect, mParent, AEffect::numPrograms, SaveFXProgram(), AEffect::uniqueID, AEffect::version, and XO.

Referenced by ExportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveFXP()

void VSTEffect::SaveFXP ( const wxFileName & fn )

private

Definition at line 3549 of file VSTEffect.cpp.

 {
    // Create/Open the file
    const wxString fullPath{ fn.GetFullPath() };
    wxFFile f(fullPath, wxT("wb"));
    if (!f.IsOpened())
    {
       AudacityMessageBox(
          XO("Could not open file: \"%s\"").Format( fullPath ),
          XO("Error Saving VST Presets"),
          wxOK | wxCENTRE,
          mParent);
       return;
    }
  
    wxMemoryBuffer buf;
  
    int ndx = callDispatcher(effGetProgram, 0, 0, NULL, 0.0);
    SaveFXProgram(buf, ndx);
  
    f.Write(buf.GetData(), buf.GetDataLen());
    if (f.Error())
    {
       AudacityMessageBox(
          XO("Error writing to file: \"%s\"").Format( fullPath ),
          XO("Error Saving VST Presets"),
          wxOK | wxCENTRE,
          mParent);
    }
  
    f.Close();
  
    return;
 }

References AudacityMessageBox(), callDispatcher(), effGetProgram, fn, mParent, SaveFXProgram(), and XO.

Referenced by ExportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveFXProgram()

void VSTEffect::SaveFXProgram	(	wxMemoryBuffer &	buf,
		int	index
	)

private

Definition at line 3584 of file VSTEffect.cpp.

 {
    wxInt32 subType;
    void *chunkPtr;
    int chunkSize;
    int dataSize = 48;
    char progName[28];
    wxInt32 tab[7];
  
    callDispatcher(effGetProgramNameIndexed, index, 0, &progName, 0.0);
    progName[27] = '\0';
    chunkSize = strlen(progName);
    memset(&progName[chunkSize], 0, sizeof(progName) - chunkSize);
  
    if (mAEffect->flags & effFlagsProgramChunks)
    {
       subType = CCONST('F', 'P', 'C', 'h');
  
       chunkSize = callDispatcher(effGetChunk, 1, 0, &chunkPtr, 0.0);
       dataSize += 4 + chunkSize;
    }
    else
    {
       subType = CCONST('F', 'x', 'C', 'k');
  
       dataSize += (mAEffect->numParams << 2);
    }
  
    tab[0] = wxINT32_SWAP_ON_LE(CCONST('C', 'c', 'n', 'K'));
    tab[1] = wxINT32_SWAP_ON_LE(dataSize);
    tab[2] = wxINT32_SWAP_ON_LE(subType);
    tab[3] = wxINT32_SWAP_ON_LE(1);
    tab[4] = wxINT32_SWAP_ON_LE(mAEffect->uniqueID);
    tab[5] = wxINT32_SWAP_ON_LE(mAEffect->version);
    tab[6] = wxINT32_SWAP_ON_LE(mAEffect->numParams);
  
    buf.AppendData(tab, sizeof(tab));
    buf.AppendData(progName, sizeof(progName));
  
    if (mAEffect->flags & effFlagsProgramChunks)
    {
       wxInt32 size = wxINT32_SWAP_ON_LE(chunkSize);
       buf.AppendData(&size, sizeof(size));
       buf.AppendData(chunkPtr, chunkSize);
    }
    else
    {
       for (int i = 0; i < mAEffect->numParams; i++)
       {
          float val = callGetParameter(i);
          wxUint32 ival = wxUINT32_SWAP_ON_LE(reinterpretAsUint32(val));
          buf.AppendData(&ival, sizeof(ival));
       }
    }
  
    return;
 }

References callDispatcher(), callGetParameter(), CCONST, effFlagsProgramChunks, effGetChunk, effGetProgramNameIndexed, AEffect::flags, mAEffect, AEffect::numParams, reinterpretAsUint32(), AEffect::uniqueID, and AEffect::version.

Referenced by SaveFXB(), and SaveFXP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveParameters()

bool VSTEffect::SaveParameters ( const RegistryPath & group )

private

Definition at line 2363 of file VSTEffect.cpp.

 {
    mHost->SetPrivateConfig(group, wxT("UniqueID"), mAEffect->uniqueID);
    mHost->SetPrivateConfig(group, wxT("Version"), mAEffect->version);
    mHost->SetPrivateConfig(group, wxT("Elements"), mAEffect->numParams);
  
    if (mAEffect->flags & effFlagsProgramChunks)
    {
       void *chunk = NULL;
       int clen = (int) callDispatcher(effGetChunk, 1, 0, &chunk, 0.0);
       if (clen <= 0)
       {
          return false;
       }
  
       mHost->SetPrivateConfig(group, wxT("Chunk"), VSTEffect::b64encode(chunk, clen));
       return true;
    }
  
    CommandParameters eap;
    if (!GetAutomationParameters(eap))
    {
       return false;
    }
  
    wxString parms;
    if (!eap.GetParameters(parms))
    {
       return false;
    }
  
    return mHost->SetPrivateConfig(group, wxT("Parameters"), parms);
 }

References b64encode(), callDispatcher(), effFlagsProgramChunks, effGetChunk, AEffect::flags, GetAutomationParameters(), CommandParameters::GetParameters(), mAEffect, mHost, AEffect::numParams, ConfigClientInterface::SetPrivateConfig(), AEffect::uniqueID, and AEffect::version.

Referenced by SaveUserPreset(), and SetHost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveUserPreset()

bool VSTEffect::SaveUserPreset ( const RegistryPath & name )

overridevirtual

Implements EffectClientInterface.

Definition at line 1702 of file VSTEffect.cpp.

 {
    return SaveParameters(name);
 }

References name, and SaveParameters().

Here is the call graph for this function:

◆ SaveXML()

void VSTEffect::SaveXML ( const wxFileName & fn )

private

Definition at line 3643 of file VSTEffect.cpp.

 {
    XMLFileWriter xmlFile{ fn.GetFullPath(), XO("Error Saving Effect Presets") };
  
    xmlFile.StartTag(wxT("vstprogrampersistence"));
    xmlFile.WriteAttr(wxT("version"), wxT("2"));
  
    xmlFile.StartTag(wxT("effect"));
    // Use internal name only in persistent information
    xmlFile.WriteAttr(wxT("name"), GetSymbol().Internal());
    xmlFile.WriteAttr(wxT("uniqueID"), mAEffect->uniqueID);
    xmlFile.WriteAttr(wxT("version"), mAEffect->version);
    xmlFile.WriteAttr(wxT("numParams"), mAEffect->numParams);
  
    xmlFile.StartTag(wxT("program"));
    xmlFile.WriteAttr(wxT("name"), wxEmptyString); //mProgram->GetValue());
  
    int clen = 0;
    if (mAEffect->flags & effFlagsProgramChunks)
    {
       void *chunk = NULL;
  
       clen = (int) callDispatcher(effGetChunk, 1, 0, &chunk, 0.0);
       if (clen != 0)
       {
          xmlFile.StartTag(wxT("chunk"));
          xmlFile.WriteSubTree(VSTEffect::b64encode(chunk, clen) + wxT('\n'));
          xmlFile.EndTag(wxT("chunk"));
       }
    }
  
    if (clen == 0)
    {
       for (int i = 0; i < mAEffect->numParams; i++)
       {
          xmlFile.StartTag(wxT("param"));
  
          xmlFile.WriteAttr(wxT("index"), i);
          xmlFile.WriteAttr(wxT("name"),
                            GetString(effGetParamName, i));
          xmlFile.WriteAttr(wxT("value"),
                            wxString::Format(wxT("%f"),
                            callGetParameter(i)));
  
          xmlFile.EndTag(wxT("param"));
       }
    }
  
    xmlFile.EndTag(wxT("program"));
  
    xmlFile.EndTag(wxT("effect"));
  
    xmlFile.EndTag(wxT("vstprogrampersistence"));
  
    xmlFile.Commit();
 }

References b64encode(), callDispatcher(), callGetParameter(), effFlagsProgramChunks, effGetChunk, effGetParamName, AEffect::flags, fn, GetString(), GetSymbol(), Internal, mAEffect, AEffect::numParams, AEffect::uniqueID, AEffect::version, and XO.

Referenced by ExportPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAutomationParameters()

bool VSTEffect::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Implements EffectClientInterface.

Definition at line 1660 of file VSTEffect.cpp.

 {
    callDispatcher(effBeginSetProgram, 0, 0, NULL, 0.0);
    for (int i = 0; i < mAEffect->numParams; i++)
    {
       wxString name = GetString(effGetParamName, i);
       if (name.empty())
       {
          name.Printf(wxT("parm_%d"), i);
       }
  
       double d = 0.0;
       if (!parms.Read(name, &d))
       {
          return false;
       }
  
       if (d >= -1.0 && d <= 1.0)
       {
          callSetParameter(i, d);
          for (const auto &slave : mSlaves)
             slave->callSetParameter(i, d);
       }
    }
    callDispatcher(effEndSetProgram, 0, 0, NULL, 0.0);
  
    return true;
 }

References callDispatcher(), callSetParameter(), effBeginSetProgram, effEndSetProgram, effGetParamName, TranslatableString::empty(), GetString(), mAEffect, mSlaves, name, and AEffect::numParams.

Referenced by LoadParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBlockSize()

size_t VSTEffect::SetBlockSize ( size_t maxBlockSize )

overridevirtual

Implements EffectClientInterface.

Definition at line 1356 of file VSTEffect.cpp.

 {
    mBlockSize = std::min( maxBlockSize, mUserBlockSize );
    return mBlockSize;
 }

References mBlockSize, min(), and mUserBlockSize.

Referenced by RealtimeAddProcessor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBufferDelay()

void VSTEffect::SetBufferDelay ( int samples )

private

Definition at line 2527 of file VSTEffect.cpp.

 {
    // We do not support negative delay
    if (samples >= 0 && mUseLatency)
    {
       mBufferDelay = samples;
    }
  
    return;
 }

References mBufferDelay, and mUseLatency.

Referenced by AudioMaster(), and ProcessInitialize().

Here is the caller graph for this function:

◆ SetChannelCount()

void VSTEffect::SetChannelCount ( unsigned numChannels )

private

Definition at line 1450 of file VSTEffect.cpp.

 {
    mNumChannels = numChannels;
 }

References mNumChannels.

Referenced by RealtimeAddProcessor().

Here is the caller graph for this function:

◆ SetHost()

bool VSTEffect::SetHost ( EffectHostInterface * host )

overridevirtual

Implements EffectClientInterface.

Definition at line 1292 of file VSTEffect.cpp.

 {
    mHost = host;
  
    if (!mAEffect)
    {
       Load();
    }
  
    if (!mAEffect)
    {
       return false;
    }
  
    // If we have a master then there's no need to load settings since the master will feed
    // us everything we need.
    if (mMaster)
    {
       return true;
    }
  
    if (mHost)
    {
       int userBlockSize;
       mHost->GetSharedConfig(wxT("Options"), wxT("BufferSize"), userBlockSize, 8192);
       mUserBlockSize = std::max( 1, userBlockSize );
       mHost->GetSharedConfig(wxT("Options"), wxT("UseLatency"), mUseLatency, true);
  
       mBlockSize = mUserBlockSize;
  
       bool haveDefaults;
       mHost->GetPrivateConfig(mHost->GetFactoryDefaultsGroup(), wxT("Initialized"), haveDefaults, false);
       if (!haveDefaults)
       {
          SaveParameters(mHost->GetFactoryDefaultsGroup());
          mHost->SetPrivateConfig(mHost->GetFactoryDefaultsGroup(), wxT("Initialized"), true);
       }
  
       LoadParameters(mHost->GetCurrentSettingsGroup());
    }
  
    return true;
 }

References EffectHostInterface::GetCurrentSettingsGroup(), EffectHostInterface::GetFactoryDefaultsGroup(), ConfigClientInterface::GetPrivateConfig(), ConfigClientInterface::GetSharedConfig(), Load(), LoadParameters(), mAEffect, mBlockSize, mHost, mMaster, mUseLatency, mUserBlockSize, SaveParameters(), and ConfigClientInterface::SetPrivateConfig().

Referenced by VSTEffectsModule::Check().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetHostUI()

void VSTEffect::SetHostUI ( EffectUIHostInterface * host )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1750 of file VSTEffect.cpp.

 {
    mUIHost = host;
 }

References mUIHost.

◆ SetSampleRate()

void VSTEffect::SetSampleRate ( double rate )

overridevirtual

Implements EffectClientInterface.

Definition at line 1367 of file VSTEffect.cpp.

 {
    mSampleRate = (float) rate;
 }

References mSampleRate.

Referenced by RealtimeAddProcessor().

Here is the caller graph for this function:

◆ SetString()

void VSTEffect::SetString	(	int	opcode,
		const wxString &	str,
		int	index = `0`
	)

private

Definition at line 2560 of file VSTEffect.cpp.

 {
    char buf[256];
    strcpy(buf, str.Left(255).ToUTF8());
  
    callDispatcher(opcode, index, 0, buf, 0.0);
 }

References callDispatcher().

Referenced by HandleXMLTag(), and LoadFXProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowInterface()

bool VSTEffect::ShowInterface	(	wxWindow &	parent,
		const EffectDialogFactory &	factory,
		bool	forceModal = `false`
	)

overridevirtual

Some history...

Before we ran into the Antress plugin problem with buffer size limitations, (see below) we just had a plain old effect loop...get the input samples, pass them to the effect, save the output samples.

But, the hack I put in to limit the buffer size to only 8k (normally 512k or so) severely impacted performance. So, Michael C. added some intermediate buffering that sped things up quite a bit and this is how things have worked for quite a while. It still didn't get the performance back to the pre-hack stage, but it was a definite benefit.

History over...

I've recently (May 2014) tried newer versions of the Antress effects and they no longer seem to have a problem with buffer size. So, I've made a bit of a compromise...I've made the buffer size user configurable. Should have done this from the beginning. I've left the default 8k, just in case, but now the user can set the buffering based on their specific setup and needs.

And at the same time I added buffer delay compensation, which allows Audacity to account for latency introduced by some effects. This is based on information provided by the effect, so it will not work with all effects since they don't all provide the information (kn0ck0ut is one).

Implements EffectClientInterface.

Definition at line 1595 of file VSTEffect.cpp.

 {
    if (mDialog)
    {
       if ( mDialog->Close(true) )
          mDialog = nullptr;
       return false;
    }
  
    // mDialog is null
    auto cleanup = valueRestorer( mDialog );
  
    //   mProcessLevel = 1;      // in GUI thread
  
    // Set some defaults since some VSTs need them...these will be reset when
    // normal or realtime processing begins
    if (!IsReady())
    {
       mSampleRate = 44100;
       mBlockSize = 8192;
       ProcessInitialize(0, NULL);
    }
  
    if ( factory )
       mDialog = factory(parent, mHost, this);
    if (!mDialog)
    {
       return false;
    }
    mDialog->CentreOnParent();
  
    if (SupportsRealtime() && !forceModal)
    {
       mDialog->Show();
       cleanup.release();
  
       return false;
    }
  
    bool res = mDialog->ShowModal() != 0;
  
    return res;
 }

References factory, IsReady(), mBlockSize, mDialog, mHost, mSampleRate, ProcessInitialize(), SupportsRealtime(), and valueRestorer().

Here is the call graph for this function:

◆ ShowOptions()

void VSTEffect::ShowOptions ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1981 of file VSTEffect.cpp.

 {
    VSTEffectOptionsDialog dlg(mParent, mHost);
    if (dlg.ShowModal())
    {
       // Reinitialize configuration settings
       int userBlockSize;
       mHost->GetSharedConfig(wxT("Options"), wxT("BufferSize"), userBlockSize, 8192);
       mUserBlockSize = std::max( 1, userBlockSize );
       mHost->GetSharedConfig(wxT("Options"), wxT("UseLatency"), mUseLatency, true);
    }
 }

References ConfigClientInterface::GetSharedConfig(), mHost, mParent, mUseLatency, and mUserBlockSize.

Here is the call graph for this function:

◆ SizeWindow()

void VSTEffect::SizeWindow	(	int	w,
		int	h
	)

private

Definition at line 2486 of file VSTEffect.cpp.

 {
    // Queue the event to make the resizes smoother
    if (mParent)
    {
       wxCommandEvent sw(EVT_SIZEWINDOW);
       sw.SetInt(w);
       sw.SetExtraLong(h);
       mParent->GetEventHandler()->AddPendingEvent(sw);
    }
  
    return;
 }

References mParent.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ SupportsAutomation()

bool VSTEffect::SupportsAutomation ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 1283 of file VSTEffect.cpp.

 {
    return mAutomatable;
 }

References mAutomatable.

Referenced by VSTEffectsModule::Check().

Here is the caller graph for this function:

◆ SupportsRealtime()

bool VSTEffect::SupportsRealtime ( )

overridevirtual

Implements EffectDefinitionInterface.

Definition at line 1278 of file VSTEffect.cpp.

 {
    return GetType() == EffectTypeProcess;
 }

References EffectTypeProcess, and GetType().

Referenced by ShowInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Unload()

void VSTEffect::Unload ( )

private

Definition at line 2269 of file VSTEffect.cpp.

 {
    if (mDialog)
    {
       CloseUI();
    }
  
    if (mAEffect)
    {
       // Turn the power off
       PowerOff();
  
       // Finally, close the plugin
       callDispatcher(effClose, 0, 0, NULL, 0.0);
       mAEffect = NULL;
    }
  
    if (mModule)
    {
 #if defined(__WXMAC__)
       mResource.reset();
       mBundleRef.reset();
 #endif
  
       mModule.reset();
       mAEffect = NULL;
    }
 }

References callDispatcher(), CloseUI(), effClose, mAEffect, mDialog, mModule, and PowerOff().

Referenced by Load(), and ~VSTEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateDisplay()

void VSTEffect::UpdateDisplay ( )

private

Definition at line 2500 of file VSTEffect.cpp.

 {
 #if 0
    // Tell the dialog to refresh effect information
    if (mParent)
    {
       wxCommandEvent ud(EVT_UPDATEDISPLAY);
       mParent->GetEventHandler()->AddPendingEvent(ud);
    }
 #endif
    return;
 }

References mParent.

Referenced by AudioMaster().

Here is the caller graph for this function:

◆ ValidateUI()

bool VSTEffect::ValidateUI ( )

overridevirtual

Implements EffectUIClientInterface.

Definition at line 1794 of file VSTEffect.cpp.

 {
    if (!mParent->Validate() || !mParent->TransferDataFromWindow())
    {
       return false;
    }
  
    if (GetType() == EffectTypeGenerate)
    {
       mHost->SetDuration(mDuration->GetValue());
    }
  
    return true;
 }

References EffectTypeGenerate, GetType(), NumericConverter::GetValue(), mDuration, mHost, mParent, and EffectHostInterface::SetDuration().

Here is the call graph for this function:

◆ wxCRIT_SECT_DECLARE_MEMBER()

VSTEffect::wxCRIT_SECT_DECLARE_MEMBER ( mDispatcherLock )

private

Friends And Related Function Documentation

◆ VSTEffectsModule

friend class VSTEffectsModule

friend

Definition at line 394 of file VSTEffect.h.

Member Data Documentation

◆ mAEffect

AEffect* VSTEffect::mAEffect

private

Definition at line 345 of file VSTEffect.h.

Referenced by BuildPlain(), callDispatcher(), callGetParameter(), callProcessReplacing(), callSetChunk(), callSetParameter(), GetAutomationParameters(), GetFactoryPresets(), HandleXMLTag(), Load(), LoadFXB(), LoadFXProgram(), LoadParameters(), PopulateUI(), ProcessInitialize(), RealtimeAddProcessor(), RefreshParameters(), SaveFXB(), SaveFXProgram(), SaveParameters(), SaveXML(), SetAutomationParameters(), SetHost(), Unload(), and VSTEffect().

◆ mAudioIns

unsigned VSTEffect::mAudioIns

private

Definition at line 289 of file VSTEffect.h.

Referenced by GetAudioInCount(), GetDescription(), GetType(), Load(), RealtimeInitialize(), RealtimeProcess(), RealtimeProcessStart(), and VSTEffect().

◆ mAudioOuts

unsigned VSTEffect::mAudioOuts

private

Definition at line 290 of file VSTEffect.h.

Referenced by GetAudioOutCount(), GetDescription(), GetType(), Load(), RealtimeInitialize(), and VSTEffect().

◆ mAutomatable

bool VSTEffect::mAutomatable

private

Definition at line 293 of file VSTEffect.h.

Referenced by Load(), and SupportsAutomation().

◆ mBlockSize

unsigned VSTEffect::mBlockSize

private

Definition at line 352 of file VSTEffect.h.

Referenced by GetBlockSize(), ProcessInitialize(), RealtimeAddProcessor(), RealtimeInitialize(), RealtimeProcess(), RealtimeProcessStart(), SetBlockSize(), SetHost(), ShowInterface(), and VSTEffect().

◆ mBufferDelay

int VSTEffect::mBufferDelay

private

Definition at line 350 of file VSTEffect.h.

Referenced by GetLatency(), SetBufferDelay(), and VSTEffect().

◆ mChunk

wxString VSTEffect::mChunk

private

Definition at line 388 of file VSTEffect.h.

Referenced by HandleXMLContent(), and HandleXMLEndTag().

◆ mContainer

wxSizerItem* VSTEffect::mContainer

private

Definition at line 375 of file VSTEffect.h.

Referenced by VSTEffect().

◆ mControl

VSTControl* VSTEffect::mControl

private

Definition at line 378 of file VSTEffect.h.

Referenced by BuildFancy(), CloseUI(), and OnSizeWindow().

◆ mCurrentEffectID

intptr_t VSTEffect::mCurrentEffectID

staticprivate

Definition at line 303 of file VSTEffect.h.

Referenced by Load().

◆ mDescription

wxString VSTEffect::mDescription

private

Definition at line 298 of file VSTEffect.h.

◆ mDialog

wxDialog* VSTEffect::mDialog

private

Definition at line 372 of file VSTEffect.h.

Referenced by BuildFancy(), CloseUI(), OnSizeWindow(), PopulateUI(), ShowInterface(), Unload(), VSTEffect(), and ~VSTEffect().

◆ mDisplays

ArrayOf<wxStaticText *> VSTEffect::mDisplays

private

Definition at line 383 of file VSTEffect.h.

Referenced by BuildPlain(), CloseUI(), and RefreshParameters().

◆ mDuration

NumericTextCtrl* VSTEffect::mDuration

private

Definition at line 380 of file VSTEffect.h.

Referenced by BuildPlain(), and ValidateUI().

◆ mGui

bool VSTEffect::mGui

private

Definition at line 376 of file VSTEffect.h.

Referenced by IsGraphicalUI(), PopulateUI(), and VSTEffect().

◆ mHasPower

bool VSTEffect::mHasPower

private

Definition at line 355 of file VSTEffect.h.

Referenced by PowerOff(), PowerOn(), and VSTEffect().

◆ mHost

EffectHostInterface* VSTEffect::mHost

private

Definition at line 286 of file VSTEffect.h.

Referenced by BuildPlain(), LoadFactoryDefaults(), LoadParameters(), PopulateUI(), SaveParameters(), SetHost(), ShowInterface(), ShowOptions(), ValidateUI(), and VSTEffect().

◆ mID

PluginID VSTEffect::mID

private

Definition at line 287 of file VSTEffect.h.

◆ mInChunk

bool VSTEffect::mInChunk

private

Definition at line 387 of file VSTEffect.h.

Referenced by HandleXMLContent(), HandleXMLEndTag(), HandleXMLTag(), and LoadXML().

◆ mInSet

bool VSTEffect::mInSet

private

Definition at line 386 of file VSTEffect.h.

Referenced by HandleXMLEndTag(), HandleXMLTag(), and LoadXML().

◆ mInteractive

bool VSTEffect::mInteractive

private

Definition at line 300 of file VSTEffect.h.

Referenced by IsInteractive(), Load(), and VSTEffect().

◆ mLabels

ArrayOf<wxStaticText *> VSTEffect::mLabels

private

Definition at line 384 of file VSTEffect.h.

Referenced by BuildPlain(), CloseUI(), and RefreshParameters().

◆ mMaster

VSTEffect* VSTEffect::mMaster

private

Definition at line 365 of file VSTEffect.h.

Referenced by Automate(), SetHost(), and VSTEffect().

◆ mMasterIn

FloatBuffers VSTEffect::mMasterIn

private

Definition at line 368 of file VSTEffect.h.

Referenced by RealtimeFinalize(), RealtimeInitialize(), RealtimeProcess(), RealtimeProcessEnd(), and RealtimeProcessStart().

◆ mMasterOut

FloatBuffers VSTEffect::mMasterOut

private

Definition at line 368 of file VSTEffect.h.

Referenced by RealtimeFinalize(), RealtimeInitialize(), and RealtimeProcessEnd().

◆ mMidiIns

int VSTEffect::mMidiIns

private

Definition at line 291 of file VSTEffect.h.

Referenced by GetMidiInCount(), GetType(), Load(), and VSTEffect().

◆ mMidiOuts

int VSTEffect::mMidiOuts

private

Definition at line 292 of file VSTEffect.h.

Referenced by GetMidiOutCount(), GetType(), Load(), and VSTEffect().

◆ mModule

ModuleHandle VSTEffect::mModule

private

Definition at line 307 of file VSTEffect.h.

Referenced by Load(), Unload(), and VSTEffect().

◆ mName

wxString VSTEffect::mName

private

Definition at line 296 of file VSTEffect.h.

Referenced by GetSymbol(), and Load().

◆ mNames

ArrayOf<wxStaticText *> VSTEffect::mNames

private

Definition at line 381 of file VSTEffect.h.

Referenced by BuildPlain(), CloseUI(), and RefreshParameters().

◆ mNumChannels

unsigned VSTEffect::mNumChannels

private

Definition at line 367 of file VSTEffect.h.

Referenced by GetChannelCount(), and SetChannelCount().

◆ mNumSamples

size_t VSTEffect::mNumSamples

private

Definition at line 369 of file VSTEffect.h.

Referenced by RealtimeProcess(), RealtimeProcessEnd(), and RealtimeProcessStart().

◆ mParent

wxWindow* VSTEffect::mParent

private

Definition at line 373 of file VSTEffect.h.

Referenced by BuildFancy(), BuildPlain(), CloseUI(), ExportPresets(), HandleXMLTag(), ImportPresets(), LoadFXB(), LoadFXP(), LoadXML(), PopulateUI(), SaveFXB(), SaveFXP(), ShowOptions(), SizeWindow(), UpdateDisplay(), and ValidateUI().

◆ mPath

PluginPath VSTEffect::mPath

private

Definition at line 288 of file VSTEffect.h.

Referenced by GetPath(), Load(), and RealtimeAddProcessor().

◆ mProcessLevel

int VSTEffect::mProcessLevel

private

Definition at line 354 of file VSTEffect.h.

Referenced by GetProcessLevel(), and VSTEffect().

◆ mReady

bool VSTEffect::mReady

private

Definition at line 305 of file VSTEffect.h.

Referenced by IsReady(), ProcessFinalize(), ProcessInitialize(), and VSTEffect().

◆ mSampleRate

float VSTEffect::mSampleRate

private

Definition at line 294 of file VSTEffect.h.

Referenced by BuildPlain(), ProcessInitialize(), SetSampleRate(), ShowInterface(), and VSTEffect().

◆ mSlaves

VSTEffectArray VSTEffect::mSlaves

private

Definition at line 366 of file VSTEffect.h.

Referenced by Automate(), callSetChunk(), callSetParameter(), callSetProgram(), RealtimeAddProcessor(), RealtimeFinalize(), RealtimeProcess(), RealtimeResume(), RealtimeSuspend(), and SetAutomationParameters().

◆ mSliders

ArrayOf<wxSlider *> VSTEffect::mSliders

private

Definition at line 382 of file VSTEffect.h.

Referenced by BuildPlain(), CloseUI(), and RefreshParameters().

◆ mTimeInfo

VstTimeInfo VSTEffect::mTimeInfo

private

Definition at line 347 of file VSTEffect.h.

Referenced by GetSampleRate(), GetTimeInfo(), ProcessBlock(), ProcessInitialize(), and VSTEffect().

◆ mTimer

std::unique_ptr<VSTEffectTimer> VSTEffect::mTimer

private

Definition at line 361 of file VSTEffect.h.

Referenced by NeedEditIdle(), NeedIdle(), and VSTEffect().

◆ mTimerGuard

int VSTEffect::mTimerGuard

private

Definition at line 362 of file VSTEffect.h.

Referenced by OnTimer(), and VSTEffect().

◆ mUIHost

EffectUIHostInterface* VSTEffect::mUIHost

private

Definition at line 374 of file VSTEffect.h.

Referenced by CloseUI(), and SetHostUI().

◆ mUseLatency

bool VSTEffect::mUseLatency

private

Definition at line 349 of file VSTEffect.h.

Referenced by GetLatency(), SetBufferDelay(), SetHost(), ShowOptions(), and VSTEffect().

◆ mUserBlockSize

size_t VSTEffect::mUserBlockSize

private

Definition at line 295 of file VSTEffect.h.

Referenced by SetBlockSize(), SetHost(), ShowOptions(), and VSTEffect().

◆ mVendor

wxString VSTEffect::mVendor

private

Definition at line 297 of file VSTEffect.h.

Referenced by GetVendor(), and Load().

◆ mVersion

int VSTEffect::mVersion

private

Definition at line 299 of file VSTEffect.h.

Referenced by GetVersion(), and Load().

◆ mVstVersion

int VSTEffect::mVstVersion

private

Definition at line 301 of file VSTEffect.h.

Referenced by callSetParameter(), GetEffectIDs(), GetFactoryPresets(), Load(), OnTimer(), PowerOff(), and PowerOn().

◆ mWantsEditIdle

bool VSTEffect::mWantsEditIdle

private

Definition at line 357 of file VSTEffect.h.

Referenced by NeedEditIdle(), OnTimer(), and VSTEffect().

◆ mWantsIdle

bool VSTEffect::mWantsIdle

private

Definition at line 356 of file VSTEffect.h.

Referenced by NeedIdle(), OnTimer(), and VSTEffect().

◆ mXMLInfo

VstPatchChunkInfo VSTEffect::mXMLInfo

private

Definition at line 390 of file VSTEffect.h.

Referenced by HandleXMLEndTag(), and HandleXMLTag().

◆ mXMLVersion

long VSTEffect::mXMLVersion

private

Definition at line 389 of file VSTEffect.h.

Referenced by HandleXMLTag().

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

Classes

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ModuleHandle

Constructor & Destructor Documentation

◆ VSTEffect()

◆ ~VSTEffect()

Member Function Documentation

◆ AudioMaster()

◆ Automate()

◆ b64decode()

◆ b64encode()

◆ BuildFancy()

◆ BuildPlain()

◆ BuildProgramBar()

◆ callDispatcher()

◆ callGetParameter()

◆ callProcessReplacing()

◆ callSetChunk() [1/2]

◆ callSetChunk() [2/2]

◆ callSetParameter()

◆ callSetProgram()

◆ CanExportPresets()

◆ CloseUI()

◆ ExportPresets()

◆ GetAudioInCount()

◆ GetAudioOutCount()

◆ GetAutomationParameters()

◆ GetBlockSize()

◆ GetChannelCount()

◆ GetDescription()

◆ GetEffectIDs()

◆ GetFactoryPresets()

◆ GetFamily()

◆ GetLatency()

◆ GetMidiInCount()

◆ GetMidiOutCount()

◆ GetPath()

◆ GetProcessLevel()

◆ GetSampleRate()

◆ GetString() [1/2]

◆ GetString() [2/2]

◆ GetSymbol()

◆ GetTailSize()

◆ GetTimeInfo()

◆ GetType()

◆ GetVendor()

◆ GetVersion()

◆ HandleXMLChild()

◆ HandleXMLContent()

◆ HandleXMLEndTag()

◆ HandleXMLTag()

◆ HasOptions()

◆ HideUI()

◆ ImportPresets()

◆ IsDefault()

◆ IsGraphicalUI()

◆ IsInteractive()

◆ IsLegacy()

◆ IsReady()

◆ Load()

◆ LoadFactoryDefaults()

◆ LoadFactoryPreset()

◆ LoadFXB()

◆ LoadFXP()

◆ LoadFXProgram()

◆ LoadParameters()

◆ LoadUserPreset()

◆ LoadXML()

◆ NeedEditIdle()

◆ NeedIdle()