VST3Utils Class Reference

Provides a set of useful functions, used across the Audacity VST3 module. More...

#include <VST3Utils.h>

Static Public Member Functions
static wxString	MakePluginPathString (const wxString &modulePath, const std::string &effectUIDString)
static bool	ParsePluginPath (const wxString &pluginPath, wxString *modulePath, std::string *effectUIDString)
static wxString	ToWxString (const Steinberg::Vst::TChar *str)
static wxString	MakeAutomationParameterKey (const Steinberg::Vst::ParameterInfo &info)
static bool	ParseAutomationParameterKey (const wxString &key, Steinberg::Vst::ParamID &paramId)
static wxString	MakeFactoryPresetID (Steinberg::Vst::UnitID unitId, Steinberg::int32 programIndex)
static bool	ParseFactoryPresetID (const wxString &presetId, Steinberg::Vst::UnitID &unitId, Steinberg::int32 &programIndex)
static wxString	GetFactoryPresetsPath (const VST3::Hosting::ClassInfo &effectClassInfo)

Detailed Description

Provides a set of useful functions, used across the Audacity VST3 module.

Definition at line 36 of file VST3Utils.h.

Member Function Documentation

GetFactoryPresetsPath()

wxString VST3Utils::GetFactoryPresetsPath ( const VST3::Hosting::ClassInfo &  effectClassInfo )

static

Definition at line 145 of file VST3Utils.cpp.

{
   return GetPresetsPath(
      GetFactoryPresetsBasePath(),
      effectClassInfo
   );
}

References anonymous_namespace{VST3Utils.cpp}::GetFactoryPresetsBasePath(), and anonymous_namespace{VST3Utils.cpp}::GetPresetsPath().

Referenced by VST3Wrapper::FindFactoryPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeAutomationParameterKey()

wxString VST3Utils::MakeAutomationParameterKey ( const Steinberg::Vst::ParameterInfo &  info )

static

Definition at line 99 of file VST3Utils.cpp.

{
   auto suffix = ToWxString(parameterInfo.shortTitle);
   if(suffix.empty())
      suffix = ToWxString(parameterInfo.title);
 
   if(!suffix.empty())
      return wxString::Format("%lu_", static_cast<unsigned long>(parameterInfo.id)) + suffix;
 
   return wxString::Format("%lu", static_cast<unsigned long>(parameterInfo.id));
}

References ToWxString().

Here is the call graph for this function:

MakeFactoryPresetID()

wxString VST3Utils::MakeFactoryPresetID ( Steinberg::Vst::UnitID  unitId, Steinberg::int32  programIndex  )

static

Definition at line 124 of file VST3Utils.cpp.

{
   return wxString::Format("%d:%d",
      static_cast<int>(unitId),
      static_cast<int>(programIndex));
}

Referenced by VST3Wrapper::FindFactoryPresets().

Here is the caller graph for this function:

MakePluginPathString()

wxString VST3Utils::MakePluginPathString ( const wxString &  modulePath, const std::string &  effectUIDString  )

static

Definition at line 69 of file VST3Utils.cpp.

{
   return wxString::Format("%s;%s", modulePath, effectUIDString); 
}

Referenced by VST3EffectBase::GetPath().

Here is the caller graph for this function:

ParseAutomationParameterKey()

bool VST3Utils::ParseAutomationParameterKey ( const wxString &  key, Steinberg::Vst::ParamID &  paramId  )

static

Definition at line 111 of file VST3Utils.cpp.

{
   const auto pos = key.Find('_');
   const auto idStr = pos == wxNOT_FOUND ? key : key.Left(pos);
   unsigned long value { };
   if(idStr.ToULong(&value))
   {
      paramId = static_cast<Steinberg::Vst::ParamID>(value);
      return true;
   }
   return false;
}

References key.

ParseFactoryPresetID()

bool VST3Utils::ParseFactoryPresetID ( const wxString &  presetId, Steinberg::Vst::UnitID &  unitId, Steinberg::int32 &  programIndex  )

static

Definition at line 131 of file VST3Utils.cpp.

{
   auto parts = wxSplit(presetId, ':');
   long nums[2]{};
   if(parts.size() == 2 && parts[0].ToLong(&nums[0]) && parts[1].ToLong(&nums[1]))
   {
      unitId = static_cast<Steinberg::Vst::UnitID>(nums[0]);
      programIndex = static_cast<Steinberg::int32>(nums[1]);
      return true;
   }
   return false;
}

Referenced by VST3Wrapper::LoadPreset().

Here is the caller graph for this function:

ParsePluginPath()

bool VST3Utils::ParsePluginPath ( const wxString &  pluginPath, wxString *  modulePath, std::string *  effectUIDString  )

static

Definition at line 74 of file VST3Utils.cpp.

{
   const auto sep = pluginPath.Find(';', true);
   if(sep != wxNOT_FOUND &&
      //modulePath not empty
      sep > 0 &&
      //effectUIDString not empty
      static_cast<size_t>(sep) < pluginPath.Length() - 1)
   {
      if(modulePath != nullptr)
         *modulePath = pluginPath.Left(sep);
      if(effectUIDString != nullptr)
         *effectUIDString = pluginPath.Mid(static_cast<size_t>(sep) + 1);
      return true;
   }
   return false;
}

Referenced by VST3EffectsModule::CheckPluginExist(), and VST3EffectsModule::LoadPlugin().

Here is the caller graph for this function:

ToWxString()

wxString VST3Utils::ToWxString ( const Steinberg::Vst::TChar *  str )

static

Definition at line 93 of file VST3Utils.cpp.

{
   static const wxCSConv csConv { wxFONTENCODING_UTF16 };
   return { reinterpret_cast<const char*>(str), csConv };
}

References str.

Referenced by VST3Wrapper::FindFactoryPresets(), MakeAutomationParameterKey(), anonymous_namespace{VST3ParametersWindow.cpp}::VST3ValueText::SetNormalizedValue(), anonymous_namespace{VST3ParametersWindow.cpp}::VST3ContinuousParameter::UpdateAccessible(), anonymous_namespace{VST3ParametersWindow.cpp}::VST3DiscreteParameter::UpdateAccessible(), and VST3ParametersWindow::VST3ParametersWindow().

Here is the caller graph for this function:

---

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

• VST3Utils.h
• VST3Utils.cpp