LV2Preferences::Dialog Class Reference

#include <LV2Preferences.h>

Inheritance diagram for LV2Preferences::Dialog:

Collaboration diagram for LV2Preferences::Dialog:

Public Member Functions
	Dialog (const EffectDefinitionInterface &effect)
virtual	~Dialog ()
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

Definition at line 53 of file LV2Preferences.h.

Constructor & Destructor Documentation

Dialog()

LV2Preferences::Dialog::Dialog ( const EffectDefinitionInterface &  effect )

explicit

Definition at line 92 of file LV2Preferences.cpp.

   : wxDialogWrapper{ nullptr, wxID_ANY, XO("LV2 Effect Settings") }
   , mEffect{ effect }
{
   using namespace LV2Preferences;
   GetBufferSize(mEffect, mBufferSize);
   GetUseLatency(mEffect, mUseLatency);
   GetUseGUI(mEffect, mUseGUI);
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
}

References XO().

Here is the call graph for this function:

~Dialog()

LV2Preferences::Dialog::~Dialog ( )

virtual

Definition at line 104 of file LV2Preferences.cpp.

{
}

Member Function Documentation

OnOk()

void LV2Preferences::Dialog::OnOk

(

wxCommandEvent &

evt

)

Definition at line 189 of file LV2Preferences.cpp.

{
   if (!Validate())
   {
      return;
   }
 
   ShuttleGui S(this, eIsGettingFromDialog);
   PopulateOrExchange(S);
 
   using namespace LV2Preferences;
   SetBufferSize(mEffect, mBufferSize);
   SetUseLatency(mEffect, mUseLatency);
   SetUseGUI(mEffect, mUseGUI);
 
   EndModal(wxID_OK);
}

References eIsGettingFromDialog, S, LV2Preferences::SetBufferSize(), LV2Preferences::SetUseGUI(), and LV2Preferences::SetUseLatency().

Here is the call graph for this function:

PopulateOrExchange()

void LV2Preferences::Dialog::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 108 of file LV2Preferences.cpp.

{
   S.SetBorder(5);
   S.StartHorizontalLay(wxEXPAND, 1);
   {
      S.StartVerticalLay(false);
      {
         // This really shouldn't be required for LV2 plugins because they have the ability
         // to specify their exact requirements in the TTL file and/or to check the host
         // supplied min/max values.  However, I've run across one (Harrison Consoles XT-EQ)
         // that crashed on sizes greater than 8192.
         S.StartStatic(XO("Buffer Size"));
         {
            IntegerValidator<int> vld(&mBufferSize);
            vld.SetRange(8, DEFAULT_BLOCKSIZE);
 
            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.TieNumericTextBox(
                  XXO("&Buffer Size (8 to %d) samples:")
                     .Format( DEFAULT_BLOCKSIZE ),
                  mBufferSize,
                  12);
               t->SetMinSize(wxSize(100, -1));
               t->SetValidator(vld);
            }
            S.EndHorizontalLay();
         }
         S.EndStatic();
 
         S.StartStatic(XO("Latency Compensation"));
         {
            S.AddVariableText( XO(
"As part of their processing, some LV2 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 setting will provide that compensation, but it may "
"not work for all LV2 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(
"LV2 effects can 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 LV2Preferences::DEFAULT_BLOCKSIZE, S, XO(), and XXO().

Here is the call graph for this function:

Member Data Documentation

mBufferSize

int LV2Preferences::Dialog::mBufferSize {}

private

Definition at line 65 of file LV2Preferences.h.

mEffect

const EffectDefinitionInterface& LV2Preferences::Dialog::mEffect

private

Definition at line 64 of file LV2Preferences.h.

mUseGUI

bool LV2Preferences::Dialog::mUseGUI {}

private

Definition at line 67 of file LV2Preferences.h.

mUseLatency

bool LV2Preferences::Dialog::mUseLatency {}

private

Definition at line 66 of file LV2Preferences.h.

---

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

• LV2Preferences.h
• LV2Preferences.cpp