#include <VSTEditor.h>

Inheritance diagram for VSTEditor:

Collaboration diagram for VSTEditor:

Public Member Functions
	VSTEditor (VSTInstance &instance, EffectType type, bool gui, const EffectUIServices &services, EffectSettingsAccess &access, wxWindow *pParent, int numParams)

	~VSTEditor () override

VSTInstance &	GetInstance () const

bool	ValidateUI () override
	Get settings data from the panel; may make error dialogs and return false. More...

bool	UpdateUI () override
	Update appearance of the panel for changes in settings. More...

void	OnClose () override

void	BuildPlain (EffectSettingsAccess &access, EffectType effectType, double projectRate)

void	BuildFancy (EffectInstance &instance)

void	OnTimer ()

void	RefreshParameters (int skip=-1) const

void	Automate (int index, float value) override

void	OnSlider (wxCommandEvent &evt)

int	ShowDialog (bool nonModal)

bool	IsGraphicalUI () override

void	Flush () override

Public Member Functions inherited from EffectEditor
	EffectEditor (const EffectUIServices &services, EffectSettingsAccess &access)

virtual	~EffectEditor ()

virtual bool	ValidateUI ()=0
	Get settings data from the panel; may make error dialogs and return false. More...

virtual bool	UpdateUI ()
	Update appearance of the panel for changes in settings. More...

virtual bool	IsGraphicalUI ()

virtual void	Disconnect ()
	On the first call only, may disconnect from further event handling. More...

virtual void	OnClose ()

Public Member Functions inherited from Observer::Publisher< EffectSettingChanged >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...

	Publisher (Publisher &&)=default

Publisher &	operator= (Publisher &&)=default

Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...

Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

virtual void	Idle ()

virtual void	NeedIdle ()

virtual void	SizeWindow (int w, int h)

virtual void	Automate (int index, float value)

virtual void	Flush ()

Public Attributes
std::unique_ptr< VSTTimer >	mTimer

Protected Member Functions
void	SizeWindow (int w, int h) override

Protected Member Functions inherited from EffectEditor
template<typename EventTag , typename Class , typename Event >
void	BindTo (wxEvtHandler &src, const EventTag &eventType, void(Class::*pmf)(Event &))

Protected Member Functions inherited from Observer::Publisher< EffectSettingChanged >
CallbackReturn	Publish (const EffectSettingChanged &message)
	Send a message to connected callbacks. More...

Private Member Functions
void	NotifyParameterChanged (int index, float value)

void	OnIdle (wxIdleEvent &evt)

bool	FetchSettingsFromInstance (EffectSettings &settings)

bool	StoreSettingsToInstance (const EffectSettings &settings)

void	NeedEditIdle (bool state)

void	NeedIdle () override

void	Idle () override

void	OnSizeWindow (wxCommandEvent &evt)

Private Attributes
VSTInstance &	mInstance

const EffectType	mType

const bool	mGui

int	mTimerGuard { 0 }

bool	mWantsEditIdle { false }

bool	mWantsIdle { false }

std::vector< std::pair< int, double > >	mLastMovements {}

ArrayOf< wxStaticText * >	mNames

ArrayOf< wxSlider * >	mSliders

ArrayOf< wxStaticText * >	mDisplays

ArrayOf< wxStaticText * >	mLabels

NumericTextCtrl *	mDuration

wxWindow *	mParent

wxWeakRef< wxDialog >	mDialog

VSTControl *	mControl {}

std::vector< wxString >	mParamNames

int	mNumParams { 0 }

Additional Inherited Members
Public Types inherited from Observer::Publisher< EffectSettingChanged >
using	message_type = EffectSettingChanged

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const EffectSettingChanged &) >
	Type of functions that can be connected to the Publisher. More...

Static Public Member Functions inherited from EffectEditor
static bool	EnableApply (wxWindow *parent, bool enable=true)
	Enable or disable the Apply button of the dialog that contains parent. More...

static bool	EnablePreview (wxWindow *parent, bool enable=true)

Static Public Attributes inherited from EffectEditor
static constexpr int	kPlayID = 20102

Static Public Attributes inherited from Observer::Publisher< EffectSettingChanged >
static constexpr bool	notifies_all

Protected Attributes inherited from EffectEditor
const EffectUIServices &	mUIServices

EffectSettingsAccess &	mAccess

bool	mUIClosed { false }

Detailed Description

Definition at line 30 of file VSTEditor.h.

Constructor & Destructor Documentation

◆ VSTEditor()

VSTEditor::VSTEditor	(	VSTInstance &	instance,
		EffectType	type,
		bool	gui,
		const EffectUIServices &	services,
		EffectSettingsAccess &	access,
		wxWindow *	pParent,
		int	numParams
	)

Note the parameter names for later use

Definition at line 516 of file VSTEditor.cpp.

   : EffectEditor(services, access),
     mType{ type },
     mInstance(instance),
     mGui{ gui },
     mParent(pParent),
     mDialog( static_cast<wxDialog*>(wxGetTopLevelParent(pParent)) ),
     mNumParams(numParams)
{
   // In case of nondestructive processing, put an initial message in the
   // queue for the instance
   mAccess.ModifySettings([&](EffectSettings &settings){
      return GetInstance().MakeMessageFS(VSTInstance::GetSettings(settings));
   });
 
   auto settings = mAccess.Get();
   StoreSettingsToInstance(settings);
 
   mInstance.ForEachParameter([&](const VSTWrapper::ParameterInfo &pi) {
      mParamNames.push_back(pi.mName);
      return true;
   } );
 
   mTimer = std::make_unique<VSTTimer>(this);
 
   wxTheApp->Bind(wxEVT_IDLE, &VSTEditor::OnIdle, this);
}

References VSTWrapper::ForEachParameter(), EffectSettingsAccess::Get(), GetInstance(), VSTWrapper::GetSettings(), EffectEditor::mAccess, VSTWrapper::MakeMessageFS(), mInstance, EffectSettingsAccess::ModifySettings(), mParamNames, mTimer, OnIdle(), MIR::anonymous_namespace{MirUtils.cpp}::pi, settings(), and StoreSettingsToInstance().

Here is the call graph for this function:

◆ ~VSTEditor()

VSTEditor::~VSTEditor ( )

override

Definition at line 510 of file VSTEditor.cpp.

{
   // Just for extra safety
   GetInstance().SetOwningValidator(nullptr);
}

References GetInstance(), and VSTInstance::SetOwningValidator().

Here is the call graph for this function:

Member Function Documentation

◆ Automate()

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

overridevirtual

Reimplemented from VSTUIWrapper.

Definition at line 559 of file VSTEditor.cpp.

{
   NotifyParameterChanged(index, value);
   // Send changed settings (only) to the worker thread
   mAccess.Set(GetInstance().MakeMessage(index, value));
   mLastMovements.emplace_back(index, value);
}

References GetInstance(), EffectEditor::mAccess, mLastMovements, NotifyParameterChanged(), and EffectSettingsAccess::Set().

Here is the call graph for this function:

◆ BuildFancy()

void VSTEditor::BuildFancy ( EffectInstance & instance )

Definition at line 242 of file VSTEditor.cpp.

{
   auto& vstEffInstance = dynamic_cast<VSTInstance&>(instance);
 
   // Turn the power on...some effects need this when the editor is open
   vstEffInstance.PowerOn();
 
   auto control = Destroy_ptr<VSTControl>{ safenew VSTControl };
   if (!control)
   {
      return;
   }
 
   if (!control->Create(mParent, &vstEffInstance))
   {
      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);
 
 
   BindTo(*mDialog, EVT_SIZEWINDOW, &VSTEditor::OnSizeWindow);
 
#ifdef __WXMAC__
#ifdef __WX_EVTLOOP_BUSY_WAITING__
   wxEventLoop::SetBusyWaiting(true);
#endif
#endif
 
   return;
}

References EffectEditor::BindTo(), mControl, mDialog, mParent, NeedEditIdle(), OnSize(), OnSizeWindow(), VSTInstance::PowerOn(), and safenew.

Here is the call graph for this function:

◆ BuildPlain()

void VSTEditor::BuildPlain	(	EffectSettingsAccess &	access,
		EffectType	effectType,
		double	projectRate
	)

Definition at line 285 of file VSTEditor.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>   (mNumParams));
   mSliders.reinit(static_cast<size_t> (mNumParams));
   mDisplays.reinit(static_cast<size_t>(mNumParams));
   mLabels.reinit(static_cast<size_t>  (mNumParams));
 
   {
      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 (effectType == EffectTypeGenerate)
         {
            wxControl *item = safenew wxStaticText(scroller, 0, _("Duration:"));
            gridSizer->Add(item, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_RIGHT | wxALL, 5);
            auto &extra = access.Get().extra;
            mDuration = safenew
               NumericTextCtrl(FormatterContext::SampleRateContext(projectRate),
                  scroller, ID_Duration,
                  NumericConverterType_TIME(),
                  extra.GetDurationFormat(),
                  extra.GetDuration(),
                  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 < mNumParams; i++)
         {
            wxString text = GetInstance().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 < mNumParams; 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
 
            // Bind the slider to ::OnSlider
            BindTo(*mSliders[i], wxEVT_COMMAND_SLIDER_UPDATED, &VSTEditor::OnSlider);
 
            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(), EffectEditor::BindTo(), EffectTypeGenerate, effGetParamName, EffectSettings::extra, EffectSettingsAccess::Get(), GetInstance(), VSTWrapper::GetString(), ID_Duration, ID_Sliders, mDisplays, mDuration, mLabels, mNames, mNumParams, mParent, mSliders, NumericConverterType_TIME(), OnSlider(), RefreshParameters(), ArrayOf< X >::reinit(), safenew, FormatterContext::SampleRateContext(), NumericTextCtrl::SetName(), wxT(), and XO().

Here is the call graph for this function:

◆ FetchSettingsFromInstance()

bool VSTEditor::FetchSettingsFromInstance ( EffectSettings & settings )

private

Definition at line 567 of file VSTEditor.cpp.

{
   return mInstance.FetchSettings(VSTWrapper::GetSettings(settings));
}

References VSTWrapper::FetchSettings(), VSTWrapper::GetSettings(), mInstance, and settings().

Referenced by ValidateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Flush()

void VSTEditor::Flush ( )

overridevirtual

Reimplemented from VSTUIWrapper.

Definition at line 106 of file VSTEditor.cpp.

{
   mAccess.Flush();
}

References EffectSettingsAccess::Flush(), and EffectEditor::mAccess.

Here is the call graph for this function:

◆ GetInstance()

VSTInstance & VSTEditor::GetInstance ( ) const

Definition at line 554 of file VSTEditor.cpp.

{
   return mInstance;
}

References mInstance.

Referenced by Automate(), BuildPlain(), NotifyParameterChanged(), OnClose(), OnIdle(), OnSlider(), OnTimer(), RefreshParameters(), ValidateUI(), VSTEditor(), and ~VSTEditor().

Here is the caller graph for this function:

◆ Idle()

void VSTEditor::Idle ( )

overrideprivatevirtual

Reimplemented from VSTUIWrapper.

Definition at line 142 of file VSTEditor.cpp.

{
   wxYieldIfNeeded();
}

◆ IsGraphicalUI()

bool VSTEditor::IsGraphicalUI ( )

overridevirtual

Default implementation returns false

Returns: true if using a native plug-in UI, not widgets

Reimplemented from EffectEditor.

Definition at line 101 of file VSTEditor.cpp.

{
   return mGui;
}

References mGui.

◆ NeedEditIdle()

void VSTEditor::NeedEditIdle ( bool state )

private

Definition at line 147 of file VSTEditor.cpp.

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

References mTimer, and mWantsEditIdle.

Referenced by BuildFancy(), and OnClose().

Here is the caller graph for this function:

◆ NeedIdle()

void VSTEditor::NeedIdle ( )

overrideprivatevirtual

Reimplemented from VSTUIWrapper.

Definition at line 136 of file VSTEditor.cpp.

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

References mTimer, and mWantsIdle.

◆ NotifyParameterChanged()

void VSTEditor::NotifyParameterChanged	(	int	index,
		float	value
	)

private

Definition at line 153 of file VSTEditor.cpp.

{
   const auto& settings = VSTWrapper::GetSettings(mAccess.Get());
 
   GetInstance().ForEachParameter(
      [index, value, &settings, this](const auto& pi)
      {
         if (pi.mID != index)
            return true;
 
         auto it = settings.mParamsMap.find(pi.mName);
 
         // For consistency with other plugin families
         constexpr float epsilon = 1.0e-5f;
 
         if (
            it == settings.mParamsMap.end() || !it->second.has_value() ||
            std::abs(*it->second - value) > epsilon)
            Publish(EffectSettingChanged { size_t(index), value });
 
         return false;
      });
}

References VSTWrapper::ForEachParameter(), EffectSettingsAccess::Get(), GetInstance(), VSTWrapper::GetSettings(), EffectEditor::mAccess, MIR::anonymous_namespace{MirUtils.cpp}::pi, Observer::Publisher< EffectSettingChanged >::Publish(), and settings().

Referenced by Automate(), and OnSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnClose()

void VSTEditor::OnClose ( )

overridevirtual

Handle the UI OnClose event. Default implementation calls mUIServices.CloseUI()

Reimplemented from EffectEditor.

Definition at line 592 of file VSTEditor.cpp.

{
 
#ifdef __WXMAC__
#ifdef __WX_EVTLOOP_BUSY_WAITING__
   wxEventLoop::SetBusyWaiting(false);
#endif
   if (mControl)
      mControl->Close();
#endif
 
   // Tell the instance not to use me anymore - if we do not do this,
   // hiding the gui and then showing it again *while playing*, would leave
   // the instance with a dangling pointer to the old owning validator
   // for a fraction of time, thereby causing a crash.
   GetInstance().SetOwningValidator(nullptr);
 
   NeedEditIdle(false);
 
   mNames.reset();
   mSliders.reset();
   mDisplays.reset();
   mLabels.reset();
 
   mParent = NULL;
   mDialog = NULL;
 
   mAccess.Flush();
 
   ValidateUI();
}

References VSTControl::Close(), EffectSettingsAccess::Flush(), GetInstance(), EffectEditor::mAccess, mControl, mDialog, mDisplays, mLabels, mNames, mParent, mSliders, NeedEditIdle(), VSTInstance::SetOwningValidator(), and ValidateUI().

Here is the call graph for this function:

◆ OnIdle()

void VSTEditor::OnIdle ( wxIdleEvent & evt )

private

Definition at line 177 of file VSTEditor.cpp.

{
   evt.Skip();
   if (!mLastMovements.empty()) {
      // Be sure the instance has got any messages
      mAccess.Flush();
      mAccess.ModifySettings([&](EffectSettings& settings) {
         // Update settings, for stickiness
         // But don't do a complete FetchSettingsFromInstance
         for (auto [index, value] : mLastMovements) {
            if (index >= 0 && index < mParamNames.size()) {
               const auto &string = mParamNames[index];
               auto &mySettings = VSTWrapper::GetSettings(settings);
               mySettings.mParamsMap[string] = value;
            }
         }
         // Succeed but with a null message
         return nullptr;
      });
      for (auto [index, _] : mLastMovements)
         RefreshParameters(index);
      mLastMovements.clear();
   }
 
   GetInstance().DeferChunkApplication();
 
   if ( GetInstance().OnePresetWasLoadedWhilePlaying() )
   {
      RefreshParameters();
   }
 
}

References _, VSTInstance::DeferChunkApplication(), EffectSettingsAccess::Flush(), GetInstance(), EffectEditor::mAccess, mLastMovements, EffectSettingsAccess::ModifySettings(), mParamNames, RefreshParameters(), and settings().

Referenced by VSTEditor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnSizeWindow()

void VSTEditor::OnSizeWindow ( wxCommandEvent & evt )

private

Definition at line 468 of file VSTEditor.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.

Referenced by BuildFancy().

Here is the caller graph for this function:

◆ OnSlider()

void VSTEditor::OnSlider ( wxCommandEvent & evt )

Definition at line 490 of file VSTEditor.cpp.

{
   wxSlider *s = (wxSlider *) evt.GetEventObject();
   int i = s->GetId() - ID_Sliders;
   float value = s->GetValue() / 1000.0;
 
   NotifyParameterChanged(i, value);
   // Send changed settings (only) to the worker thread
   mAccess.Set(GetInstance().MakeMessage(i, value));
   mLastMovements.emplace_back(i, value);
}

References GetInstance(), ID_Sliders, EffectEditor::mAccess, mLastMovements, NotifyParameterChanged(), and EffectSettingsAccess::Set().

Referenced by BuildPlain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnTimer()

void VSTEditor::OnTimer ( )

Definition at line 111 of file VSTEditor.cpp.

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

References VSTWrapper::callDispatcher(), effEditIdle, effIdle, GetInstance(), mTimerGuard, mWantsEditIdle, and mWantsIdle.

Referenced by VSTTimer::Notify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RefreshParameters()

void VSTEditor::RefreshParameters ( int skip = -1 ) const

Definition at line 417 of file VSTEditor.cpp.

{
   if (!mNames)
   {
      return;
   }
 
   for (int i = 0; i < mNumParams; i++)
   {
      wxString text = GetInstance().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(GetInstance().callGetParameter(i) * 1000);
      }
      name = text;
 
      text = GetInstance().GetString(effGetParamDisplay, i);
      if (text.empty())
      {
         text.Printf(wxT("%.5g"), GetInstance().callGetParameter(i));
      }
      mDisplays[i]->SetLabel(wxString::Format(wxT("%8s"), text));
      name += wxT(' ') + text;
 
      text = GetInstance().GetString(effGetParamDisplay, i);
      if (!text.empty())
      {
         text.Printf(wxT("%-8s"), GetInstance().GetString(effGetParamLabel, i));
         mLabels[i]->SetLabel(wxString::Format(wxT("%8s"), text));
         name += wxT(' ') + text;
      }
 
      mSliders[i]->SetName(name);
   }
}

References effGetParamDisplay, effGetParamLabel, effGetParamName, GetInstance(), VSTWrapper::GetString(), mDisplays, mLabels, mNames, mNumParams, mSliders, name, and wxT().

Referenced by BuildPlain(), OnIdle(), and UpdateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowDialog()

int VSTEditor::ShowDialog ( bool nonModal )

Definition at line 88 of file VSTEditor.cpp.

{
   mDialog->CentreOnParent();
 
   if (nonModal)
   {
      mDialog->Show();
      return 0;
   }
 
   return mDialog->ShowModal();
}

References mDialog.

Referenced by VSTEffect::ShowClientInterface().

Here is the caller graph for this function:

◆ SizeWindow()

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

overrideprotectedvirtual

Reimplemented from VSTUIWrapper.

Definition at line 210 of file VSTEditor.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.

◆ StoreSettingsToInstance()

bool VSTEditor::StoreSettingsToInstance ( const EffectSettings & settings )

private

Definition at line 572 of file VSTEditor.cpp.

{
   return mInstance.StoreSettings(VSTWrapper::GetSettings(settings));
}

References VSTWrapper::GetSettings(), mInstance, settings(), and VSTWrapper::StoreSettings().

Referenced by VSTEditor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateUI()

bool VSTEditor::UpdateUI ( )

overridevirtual

Update appearance of the panel for changes in settings.

Default implementation does nothing, returns true

Returns: true if successful

Reimplemented from EffectEditor.

Definition at line 502 of file VSTEditor.cpp.

{
   // Update the controls on the plain UI
   RefreshParameters();
 
   return true;
}

References RefreshParameters().

Here is the call graph for this function:

◆ ValidateUI()

bool VSTEditor::ValidateUI ( )

overridevirtual

Get settings data from the panel; may make error dialogs and return false.

Returns: true only if panel settings are acceptable

Implements EffectEditor.

Definition at line 577 of file VSTEditor.cpp.

{
   mAccess.ModifySettings([this](EffectSettings& settings)
   {
      if (mType == EffectTypeGenerate)
         settings.extra.SetDuration(mDuration->GetValue());
 
      FetchSettingsFromInstance(settings);
 
      return GetInstance().MakeMessage();
   });
 
   return true;
}

References EffectTypeGenerate, FetchSettingsFromInstance(), GetInstance(), NumericConverter::GetValue(), EffectEditor::mAccess, VSTInstance::MakeMessage(), mDuration, EffectSettingsAccess::ModifySettings(), mType, and settings().

Referenced by OnClose().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mControl

VSTControl* VSTEditor::mControl {}

private

Definition at line 108 of file VSTEditor.h.

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

◆ mDialog

wxWeakRef<wxDialog> VSTEditor::mDialog

private

Definition at line 106 of file VSTEditor.h.

Referenced by BuildFancy(), OnClose(), OnSizeWindow(), and ShowDialog().

◆ mDisplays

ArrayOf<wxStaticText*> VSTEditor::mDisplays

private

Definition at line 101 of file VSTEditor.h.

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

◆ mDuration

NumericTextCtrl* VSTEditor::mDuration

private

Definition at line 103 of file VSTEditor.h.

Referenced by BuildPlain(), and ValidateUI().

◆ mGui

const bool VSTEditor::mGui

private

Definition at line 81 of file VSTEditor.h.

Referenced by IsGraphicalUI().

◆ mInstance

VSTInstance& VSTEditor::mInstance

private

Definition at line 79 of file VSTEditor.h.

Referenced by FetchSettingsFromInstance(), GetInstance(), StoreSettingsToInstance(), and VSTEditor().

◆ mLabels

ArrayOf<wxStaticText*> VSTEditor::mLabels

private

Definition at line 102 of file VSTEditor.h.

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

◆ mLastMovements

std::vector<std::pair<int, double> > VSTEditor::mLastMovements {}

private

Definition at line 97 of file VSTEditor.h.

Referenced by Automate(), OnIdle(), and OnSlider().

◆ mNames

ArrayOf<wxStaticText*> VSTEditor::mNames

private

Definition at line 99 of file VSTEditor.h.

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

◆ mNumParams

int VSTEditor::mNumParams { 0 }

private

Definition at line 113 of file VSTEditor.h.

Referenced by BuildPlain(), and RefreshParameters().

◆ mParamNames

std::vector<wxString> VSTEditor::mParamNames

private

Definition at line 111 of file VSTEditor.h.

Referenced by OnIdle(), and VSTEditor().

◆ mParent

wxWindow* VSTEditor::mParent

private

Definition at line 105 of file VSTEditor.h.

Referenced by BuildFancy(), BuildPlain(), OnClose(), and SizeWindow().

◆ mSliders

ArrayOf<wxSlider*> VSTEditor::mSliders

private

Definition at line 100 of file VSTEditor.h.

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

◆ mTimer

std::unique_ptr<VSTTimer> VSTEditor::mTimer

Definition at line 58 of file VSTEditor.h.

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

◆ mTimerGuard

int VSTEditor::mTimerGuard { 0 }

private

Definition at line 91 of file VSTEditor.h.

Referenced by OnTimer().

◆ mType

const EffectType VSTEditor::mType

private

Definition at line 80 of file VSTEditor.h.

Referenced by ValidateUI().

◆ mWantsEditIdle

bool VSTEditor::mWantsEditIdle { false }

private

Definition at line 93 of file VSTEditor.h.

Referenced by NeedEditIdle(), and OnTimer().

◆ mWantsIdle

bool VSTEditor::mWantsIdle { false }

private

Definition at line 94 of file VSTEditor.h.

Referenced by NeedIdle(), and OnTimer().

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

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VSTEditor()

◆ ~VSTEditor()

Member Function Documentation

◆ Automate()

◆ BuildFancy()

◆ BuildPlain()

◆ FetchSettingsFromInstance()

◆ Flush()

◆ GetInstance()

◆ Idle()

◆ IsGraphicalUI()

◆ NeedEditIdle()

◆ NeedIdle()

◆ NotifyParameterChanged()

◆ OnClose()

◆ OnIdle()

◆ OnSizeWindow()

◆ OnSlider()

◆ OnTimer()

◆ RefreshParameters()

◆ ShowDialog()

◆ SizeWindow()

◆ StoreSettingsToInstance()

◆ UpdateUI()

◆ ValidateUI()

Member Data Documentation

◆ mControl

◆ mDialog

◆ mDisplays

◆ mDuration

◆ mGui

◆ mInstance

◆ mLabels

◆ mLastMovements

◆ mNames

◆ mNumParams

◆ mParamNames

◆ mParent

◆ mSliders

◆ mTimer

◆ mTimerGuard

◆ mType

◆ mWantsEditIdle

◆ mWantsIdle