BasicEffectUIServices Class Reference

#include <BasicEffectUIServices.h>

Inheritance diagram for BasicEffectUIServices:

Collaboration diagram for BasicEffectUIServices:

Public Member Functions
int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override
void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override
OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override
void	ShowOptions (const EffectPlugin &plugin) const override
bool	ValidateUI (const EffectPlugin &context, EffectSettings &) const override
bool	CloseUI () const override
Public Member Functions inherited from EffectUIServices
virtual	~EffectUIServices ()
virtual int	ShowHostInterface (EffectBase &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)
virtual int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0
virtual std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
	Adds controls to a panel that is given as the parent window of S More...
virtual void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0
virtual OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0
virtual void	ShowOptions (const EffectPlugin &plugin) const =0
virtual bool	ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0
virtual bool	CloseUI () const =0

Additional Inherited Members
Public Types inherited from EffectUIServices
enum	: long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
Static Public Member Functions inherited from EffectUIServices
static int	DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

Detailed Description

Supplies implementations of all pure virtual functions of the base class except PopulateUI

Definition at line 21 of file BasicEffectUIServices.h.

Member Function Documentation

CloseUI()

bool BasicEffectUIServices::CloseUI ( ) const

overridevirtual

Implements EffectUIServices.

Reimplemented in LV2Effect.

Definition at line 43 of file BasicEffectUIServices.cpp.

{
   return true;
}

Referenced by VST3Effect::~VST3Effect().

Here is the caller graph for this function:

ExportPresets()

void BasicEffectUIServices::ExportPresets ( const EffectPlugin &  plugin, const EffectSettings &  settings  ) const

overridevirtual

Implements EffectUIServices.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 57 of file BasicEffectUIServices.cpp.

{
   wxString params;
   plugin.SaveSettingsAsString(settings, params);
   auto commandId = plugin.GetSquashedName(plugin.GetSymbol().Internal());
   params =  commandId.GET() + ":" + params;
 
   auto path = SelectFile(FileNames::Operation::Presets,
                                     XO("Export Effect Parameters"),
                                     wxEmptyString,
                                     wxEmptyString,
                                     wxEmptyString,
                                     PresetTypes(),
                                     wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER,
                                     nullptr);
   if (path.empty()) {
      return;
   }
 
   // Create/Open the file
   wxFFile f(path, wxT("wb"));
   if (!f.IsOpened())
   {
      AudacityMessageBox(
         XO("Could not open file: \"%s\"").Format( path ),
         XO("Error Saving Effect Presets"),
         wxICON_EXCLAMATION,
         NULL);
      return;
   }
 
   f.Write(params);
   if (f.Error())
   {
      AudacityMessageBox(
         XO("Error writing to file: \"%s\"").Format( path ),
         XO("Error Saving Effect Presets"),
         wxICON_EXCLAMATION,
         NULL);
   }
 
   f.Close();
 
 
   //SetWindowTitle();
 
}

References AudacityMessageBox(), EffectDefinitionInterface::GetSquashedName(), ComponentInterface::GetSymbol(), ComponentInterfaceSymbol::Internal(), params, PresetTypes(), EffectPlugin::SaveSettingsAsString(), SelectFile(), settings(), wxT(), and XO().

Here is the call graph for this function:

ImportPresets()

OptionalMessage BasicEffectUIServices::ImportPresets ( const EffectPlugin &  plugin, EffectSettings &  settings  ) const

overridevirtual

Returns

nullopt for failure

Implements EffectUIServices.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 106 of file BasicEffectUIServices.cpp.

{
   wxString params;
 
   auto path = SelectFile(FileNames::Operation::Presets,
                                     XO("Import Effect Parameters"),
                                     wxEmptyString,
                                     wxEmptyString,
                                     wxEmptyString,
                                     PresetTypes(),
                                     wxFD_OPEN | wxRESIZE_BORDER,
                                     nullptr);
   if (path.empty()) {
      return {};
   }
 
   wxFFile f(path);
   if (!f.IsOpened())
      return {};
 
   OptionalMessage result{};
 
   if (f.ReadAll(&params)) {
      wxString ident = params.BeforeFirst(':');
      params = params.AfterFirst(':');
 
      auto commandId = plugin.GetSquashedName(plugin.GetSymbol().Internal());
 
      if (ident != commandId) {
         // effect identifiers are a sensible length!
         // must also have some params.
         if ((params.Length() < 2 ) || (ident.Length() < 2) ||
             (ident.Length() > 30))
         {
            EffectUIServices::DoMessageBox(plugin,
               /* i18n-hint %s will be replaced by a file name */
               XO("%s: is not a valid presets file.\n")
               .Format(wxFileNameFromPath(path)));
         }
         else
         {
            EffectUIServices::DoMessageBox(plugin,
               /* i18n-hint %s will be replaced by a file name */
               XO("%s: is for a different Effect, Generator or Analyzer.\n")
               .Format(wxFileNameFromPath(path)));
         }
         return {};
      }
      result = plugin.LoadSettingsFromString(params, settings);
   }
 
   //SetWindowTitle();
 
   return result;
}

References EffectUIServices::DoMessageBox(), EffectDefinitionInterface::GetSquashedName(), ComponentInterface::GetSymbol(), ident(), ComponentInterfaceSymbol::Internal(), EffectPlugin::LoadSettingsFromString(), params, PresetTypes(), SelectFile(), settings(), and XO().

Here is the call graph for this function:

ShowClientInterface()

int BasicEffectUIServices::ShowClientInterface ( const EffectPlugin &  plugin, wxWindow &  parent, wxDialog &  dialog, EffectEditor *  pEditor, bool  forceModal  ) const

overridevirtual

Returns

0 if destructive effect processing should not proceed (and there may be a non-modal dialog still opened); otherwise, modal dialog return code

Implements EffectUIServices.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 23 of file BasicEffectUIServices.cpp.

{
   dialog.Layout();
   dialog.Fit();
   dialog.SetMinSize(dialog.GetSize());
   if (plugin.SupportsRealtime() && !forceModal) {
      dialog.Show();
      // Return false to bypass effect processing
      return 0;
   }
   return dialog.ShowModal();
}

References EffectDefinitionInterface::SupportsRealtime().

Here is the call graph for this function:

ShowOptions()

void BasicEffectUIServices::ShowOptions ( const EffectPlugin &  plugin ) const

overridevirtual

Implements EffectUIServices.

Reimplemented in LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Definition at line 163 of file BasicEffectUIServices.cpp.

{
}

ValidateUI()

bool BasicEffectUIServices::ValidateUI ( const EffectPlugin &  context, EffectSettings &    ) const

overridevirtual

Implements EffectUIServices.

Reimplemented in EffectEqualization.

Definition at line 37 of file BasicEffectUIServices.cpp.

{
   return true;
}

Referenced by EffectBassTreble::Editor::OnBassSlider(), EffectBassTreble::Editor::OnBassText(), EffectDistortion::Editor::OnDCBlockCheckbox(), EffectPhaser::Editor::OnDepthSlider(), EffectWahwah::Editor::OnDepthSlider(), EffectPhaser::Editor::OnDepthText(), EffectWahwah::Editor::OnDepthText(), EffectPhaser::Editor::OnDryWetSlider(), EffectPhaser::Editor::OnDryWetText(), EffectPhaser::Editor::OnFeedbackSlider(), EffectPhaser::Editor::OnFeedbackText(), EffectWahwah::Editor::OnFreqOffSlider(), EffectWahwah::Editor::OnFreqOffText(), EffectPhaser::Editor::OnFreqSlider(), EffectWahwah::Editor::OnFreqSlider(), EffectPhaser::Editor::OnFreqText(), EffectWahwah::Editor::OnFreqText(), EffectBassTreble::Editor::OnGainSlider(), EffectPhaser::Editor::OnGainSlider(), EffectWahwah::Editor::OnGainSlider(), EffectBassTreble::Editor::OnGainText(), EffectPhaser::Editor::OnGainText(), EffectWahwah::Editor::OnGainText(), EffectBassTreble::Editor::OnLinkCheckbox(), EffectDistortion::Editor::OnNoiseFloorSlider(), EffectDistortion::Editor::OnNoiseFloorText(), EffectDistortion::Editor::OnParam1Slider(), EffectDistortion::Editor::OnParam1Text(), EffectDistortion::Editor::OnParam2Slider(), EffectDistortion::Editor::OnParam2Text(), EffectPhaser::Editor::OnPhaseSlider(), EffectWahwah::Editor::OnPhaseSlider(), EffectPhaser::Editor::OnPhaseText(), EffectWahwah::Editor::OnPhaseText(), EffectDistortion::Editor::OnRepeatsSlider(), EffectDistortion::Editor::OnRepeatsText(), EffectWahwah::Editor::OnResonanceSlider(), EffectWahwah::Editor::OnResonanceText(), EffectPhaser::Editor::OnStagesSlider(), EffectPhaser::Editor::OnStagesText(), EffectDistortion::Editor::OnThresholdSlider(), EffectDistortion::Editor::OnThresholdText(), EffectBassTreble::Editor::OnTrebleSlider(), EffectBassTreble::Editor::OnTrebleText(), EffectDistortion::Editor::OnTypeChoice(), and SpinSliderHandlers().

Here is the caller graph for this function:

---

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

• BasicEffectUIServices.h
• BasicEffectUIServices.cpp