#include <AudioUnitEffectOptionsDialog.h>

Inheritance diagram for AudioUnitEffectOptionsDialog:

Collaboration diagram for AudioUnitEffectOptionsDialog:

Public Member Functions
	AudioUnitEffectOptionsDialog (const EffectDefinitionInterface &effect)

virtual	~AudioUnitEffectOptionsDialog ()

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

bool	mUseLatency

TranslatableString	mUITypeString

Detailed Description

Definition at line 30 of file AudioUnitEffectOptionsDialog.h.

Constructor & Destructor Documentation

◆ AudioUnitEffectOptionsDialog()

AudioUnitEffectOptionsDialog::AudioUnitEffectOptionsDialog ( const EffectDefinitionInterface & effect )

explicit

Definition at line 30 of file AudioUnitEffectOptionsDialog.cpp.

   : wxDialogWrapper{ nullptr, wxID_ANY, XO("Audio Unit Effect Options") }
   , mEffect{ effect }
{
   // Consult preferences
   // Decide mUseLatency, which affects GetLatency(), which is actually used
   // so far only in destructive effect processing
   GetConfig(effect, PluginSettings::Shared, OptionsKey, UseLatencyKey,
      mUseLatency, true);
 
   wxString uiType;
   GetConfig(effect, PluginSettings::Shared, OptionsKey, UITypeKey,
      uiType, FullValue.MSGID().GET() /* Config stores un-localized string */);
   // Get the localization of the string for display to the user
   mUITypeString = TranslatableString{ uiType, {} };
 
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
}

References XO().

Here is the call graph for this function:

◆ ~AudioUnitEffectOptionsDialog()

AudioUnitEffectOptionsDialog::~AudioUnitEffectOptionsDialog ( )

virtual

Definition at line 51 of file AudioUnitEffectOptionsDialog.cpp.

52{

53}

Member Function Documentation

◆ OnOk()

void AudioUnitEffectOptionsDialog::OnOk ( wxCommandEvent & evt )

Definition at line 117 of file AudioUnitEffectOptionsDialog.cpp.

{
   if (!Validate())
      return;
 
   // This re-visits the controls, not to create them but to transfer values out
   ShuttleGui S(this, eIsGettingFromDialog);
   PopulateOrExchange(S);
 
   // un-translate the type
   auto uiType = mUITypeString.MSGID().GET();
 
   // Save changed values to the config file
   SetConfig(mEffect, PluginSettings::Shared, OptionsKey, UseLatencyKey,
      mUseLatency);
   SetConfig(mEffect, PluginSettings::Shared, OptionsKey, UITypeKey, uiType);
   
   EndModal(wxID_OK);
}

References eIsGettingFromDialog, Identifier::GET(), mEffect, TranslatableString::MSGID(), mUITypeString, mUseLatency, OptionsKey, PopulateOrExchange(), S, PluginSettings::SetConfig(), PluginSettings::Shared, UITypeKey, and UseLatencyKey.

Here is the call graph for this function:

◆ PopulateOrExchange()

void AudioUnitEffectOptionsDialog::PopulateOrExchange ( ShuttleGui & S )

Definition at line 55 of file AudioUnitEffectOptionsDialog.cpp.

{
   S.SetBorder(5);
   S.StartHorizontalLay(wxEXPAND, 1);
   {
      S.StartVerticalLay(false);
      {
         S.StartStatic(XO("Latency Compensation"));
         {
            S.AddVariableText(XO(
"As part of their processing, some Audio Unit 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 Audio Unit effects."),
               false, 0, 650);
 
            S.StartHorizontalLay(wxALIGN_LEFT);
            {
               S.TieCheckBox(XXO("Enable &compensation"),
                             mUseLatency);
            }
            S.EndHorizontalLay();
         }
         S.EndStatic();
 
         S.StartStatic(XO("User Interface"));
         {
            S.AddVariableText(XO(
"Select \"Full\" to use the graphical interface if supplied by the Audio Unit."
" Select \"Generic\" to use the system supplied generic interface."
#if defined(HAVE_AUDIOUNIT_BASIC_SUPPORT)
" Select \"Basic\" for a basic text-only interface."
#endif
" Reopen the effect for this to take effect."),
               false, 0, 650);
 
            S.StartHorizontalLay(wxALIGN_LEFT);
            {
               S.TieChoice(XXO("Select &interface"),
                  mUITypeString,
                  {
                     FullValue,
                     GenericValue,
#if defined(HAVE_AUDIOUNIT_BASIC_SUPPORT)
                     BasicValue,
#endif
                  });
            }
            S.EndHorizontalLay();
         }
         S.EndStatic();
      }
      S.EndVerticalLay();
   }
   S.EndHorizontalLay();
   S.AddStandardButtons();
   Layout();
   Fit();
   Center();
}