VSTEffectOptionsDialog Class Reference

#include <VSTEffectOptionsDialog.h>

Inheritance diagram for VSTEffectOptionsDialog:

Collaboration diagram for VSTEffectOptionsDialog:

Public Member Functions
	VSTEffectOptionsDialog (const EffectDefinitionInterface &effect)
virtual	~VSTEffectOptionsDialog ()
void	PopulateOrExchange (ShuttleGui &S)
void	OnOk (wxCommandEvent &evt)
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Attributes
const EffectDefinitionInterface &	mEffect
int	mBufferSize
bool	mUseLatency
bool	mUseGUI

Detailed Description

Dialog for configuring latency, buffer size and graphics mode for a VST effect.

Definition at line 22 of file VSTEffectOptionsDialog.h.

Constructor & Destructor Documentation

VSTEffectOptionsDialog()

VSTEffectOptionsDialog::VSTEffectOptionsDialog ( const EffectDefinitionInterface &  effect )

explicit

Definition at line 25 of file VSTEffectOptionsDialog.cpp.

   : wxDialogWrapper{ nullptr, wxID_ANY, XO("VST Effect Options") }
   , mEffect{ effect }
{
   GetConfig(mEffect, PluginSettings::Shared, wxT("Options"),
      wxT("BufferSize"), mBufferSize, 8192);
   GetConfig(mEffect, PluginSettings::Shared, wxT("Options"),
      wxT("UseLatency"), mUseLatency, true);
   GetConfig(mEffect, PluginSettings::Shared, wxT("Options"),
      wxT("UseGUI"), mUseGUI, true);
 
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
}

References XO().

Here is the call graph for this function:

~VSTEffectOptionsDialog()

VSTEffectOptionsDialog::~VSTEffectOptionsDialog ( )

virtual

Definition at line 41 of file VSTEffectOptionsDialog.cpp.

{
}

Member Function Documentation

OnOk()

void VSTEffectOptionsDialog::OnOk

(

wxCommandEvent &

evt

)

Definition at line 118 of file VSTEffectOptionsDialog.cpp.

{
   if (!Validate())
   {
      return;
   }
 
   ShuttleGui S(this, eIsGettingFromDialog);
   PopulateOrExchange(S);
 
   SetConfig(mEffect, PluginSettings::Shared, wxT("Options"),
      wxT("BufferSize"), mBufferSize);
   SetConfig(mEffect, PluginSettings::Shared, wxT("Options"),
      wxT("UseLatency"), mUseLatency);
   SetConfig(mEffect, PluginSettings::Shared, wxT("Options"),
      wxT("UseGUI"), mUseGUI);
 
   EndModal(wxID_OK);
}

References eIsGettingFromDialog, mBufferSize, mEffect, mUseGUI, mUseLatency, PopulateOrExchange(), S, PluginSettings::SetConfig(), PluginSettings::Shared, and wxT().

Here is the call graph for this function:

PopulateOrExchange()

void VSTEffectOptionsDialog::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 45 of file VSTEffectOptionsDialog.cpp.

{
   S.SetBorder(5);
   S.StartHorizontalLay(wxEXPAND, 1);
   {
      S.StartVerticalLay(false);
      {
         S.StartStatic(XO("Buffer Size"));
         {
            S.AddVariableText( XO(
"The buffer size controls the number of samples sent to the effect "
"on each iteration. Smaller values will cause slower processing and "
"some effects require 8192 samples or less to work properly. However "
"most effects can accept large buffers and using them will greatly "
"reduce processing time."),
               false, 0, 650);
 
            S.StartHorizontalLay(wxALIGN_LEFT);
            {
               wxTextCtrl *t;
               t = S.Validator<IntegerValidator<int>>(
                     &mBufferSize, NumValidatorStyle::DEFAULT, 8, 1048576 * 1)
                  .MinSize( { 100, -1 } )
                  .TieNumericTextBox(XXO("&Buffer Size (8 to 1048576 samples):"),
                                       mBufferSize,
                                       12);
            }
            S.EndHorizontalLay();
         }
         S.EndStatic();
 
         S.StartStatic(XO("Latency Compensation"));
         {
            S.AddVariableText( XO(
"As part of their processing, some VST effects must delay returning "
"audio to Audacity. When not compensating for this delay, you will "
"notice that small silences have been inserted into the audio. "
"Enabling this option will provide that compensation, but it may "
"not work for all VST effects."),
               false, 0, 650);
 
            S.StartHorizontalLay(wxALIGN_LEFT);
            {
               S.TieCheckBox(XXO("Enable &compensation"),
                             mUseLatency);
            }
            S.EndHorizontalLay();
         }
         S.EndStatic();
 
         S.StartStatic(XO("Graphical Mode"));
         {
            S.AddVariableText( XO(
"Most VST effects have a graphical interface for setting parameter values."
" A basic text-only method is also available. "
" Reopen the effect for this to take effect."),
               false, 0, 650);
            S.TieCheckBox(XXO("Enable &graphical interface"),
                          mUseGUI);
         }
         S.EndStatic();
      }
      S.EndVerticalLay();
   }
   S.EndHorizontalLay();
 
   S.AddStandardButtons();
 
   Layout();
   Fit();
   Center();
}

References mBufferSize, mUseGUI, mUseLatency, S, XO(), and XXO().

Referenced by OnOk().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mBufferSize

int VSTEffectOptionsDialog::mBufferSize

private

Definition at line 34 of file VSTEffectOptionsDialog.h.

Referenced by OnOk(), and PopulateOrExchange().

mEffect

const EffectDefinitionInterface& VSTEffectOptionsDialog::mEffect

private

Definition at line 33 of file VSTEffectOptionsDialog.h.

Referenced by OnOk().

mUseGUI

bool VSTEffectOptionsDialog::mUseGUI

private

Definition at line 36 of file VSTEffectOptionsDialog.h.

Referenced by OnOk(), and PopulateOrExchange().

mUseLatency

bool VSTEffectOptionsDialog::mUseLatency

private

Definition at line 35 of file VSTEffectOptionsDialog.h.

Referenced by OnOk(), and PopulateOrExchange().

---

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

• VSTEffectOptionsDialog.h
• VSTEffectOptionsDialog.cpp