EffectManager Class Reference

EffectManager is the class that handles effects and effect categories. More...

#include <EffectManager.h>

Collaboration diagram for EffectManager:

Classes
struct	UnsetBatchProcessing
	A custom deleter for std::unique_ptr. More...

Public Types
enum	: unsigned {   kNone = 0x00 , kConfigured = 0x01 , kSkipState = 0x02 , kDontRepeatLast = 0x04 ,   kRepeatGen = 0x08 , kRepeatNyquistPrompt = 0x10 }

Public Member Functions
	EffectManager ()
virtual	~EffectManager ()
const PluginID &	RegisterEffect (std::unique_ptr< EffectPlugin > uEffect)
	Here solely for the purpose of Nyquist Workbench until a better solution is devised. More...
void	UnregisterEffect (const PluginID &ID)
	Used only by Nyquist Workbench module. More...
TranslatableString	GetEffectFamilyName (const PluginID &ID)
TranslatableString	GetVendorName (const PluginID &ID)
bool	DoAudacityCommand (const PluginID &ID, const CommandContext &, wxWindow *parent, bool shouldPrompt=true)
ComponentInterfaceSymbol	GetCommandSymbol (const PluginID &ID)
TranslatableString	GetCommandName (const PluginID &ID)
CommandID	GetCommandIdentifier (const PluginID &ID)
TranslatableString	GetCommandDescription (const PluginID &ID)
ManualPageID	GetCommandUrl (const PluginID &ID)
TranslatableString	GetCommandTip (const PluginID &ID)
void	GetCommandDefinition (const PluginID &ID, const CommandContext &context, int flags)
bool	IsHidden (const PluginID &ID)
bool	SupportsAutomation (const PluginID &ID)
wxString	GetEffectParameters (const PluginID &ID)
bool	SetEffectParameters (const PluginID &ID, const wxString &params)
bool	PromptUser (const PluginID &ID, const EffectDialogFactory &factory, wxWindow &parent)
	Shows an effect or command dialog so the user can specify settings for later. More...
bool	HasPresets (const PluginID &ID)
wxString	GetPreset (const PluginID &ID, const wxString &params, wxWindow *parent)
wxString	GetDefaultPreset (const PluginID &ID)
BatchProcessingScope	SetBatchProcessing (const PluginID &ID)
	Begin a scope that ends when the returned object is destroyed. More...
void	SetSkipStateFlag (bool flag)
bool	GetSkipStateFlag ()
const PluginID &	GetEffectByIdentifier (const CommandID &strTarget)
EffectPlugin *	GetEffect (const PluginID &ID)
EffectSettings *	GetDefaultSettings (const PluginID &ID)
std::pair< EffectPlugin *, EffectSettings * >	GetEffectAndDefaultSettings (const PluginID &ID)

Static Public Member Functions
static const EffectInstanceFactory *	GetInstanceFactory (const PluginID &ID)
static EffectManager &	Get ()

Private Types
using	BatchProcessingScope = std::unique_ptr< EffectManager, UnsetBatchProcessing >

Private Member Functions
void	BatchProcessingOn (const PluginID &ID)
void	BatchProcessingOff (const PluginID &ID)
EffectAndDefaultSettings &	DoGetEffect (const PluginID &ID)
AudacityCommand *	GetAudacityCommand (const PluginID &ID)

Private Attributes
EffectMap	mEffects
AudacityCommandMap	mCommands
EffectOwnerMap	mHostEffects
int	mNumEffects
bool	mSkipStateFlag

Detailed Description

EffectManager is the class that handles effects and effect categories.

It maintains a graph of effect categories and subcategories, registers and unregisters effects and can return filtered lists of effects.

Definition at line 47 of file EffectManager.h.

Member Typedef Documentation

BatchProcessingScope

using EffectManager::BatchProcessingScope = std::unique_ptr< EffectManager, UnsetBatchProcessing >

private

Definition at line 131 of file EffectManager.h.

Member Enumeration Documentation

anonymous enum

anonymous enum : unsigned

Enumerator
kNone
kConfigured
kSkipState
kDontRepeatLast
kRepeatGen
kRepeatNyquistPrompt

Definition at line 51 of file EffectManager.h.

        : unsigned {
      // No flags specified
      kNone = 0x00,
      // Flag used to disable prompting for configuration parameteres.
      kConfigured = 0x01,
      // Flag used to disable saving the state after processing.
      kSkipState = 0x02,
      // Flag used to disable "Repeat Last Effect"
      kDontRepeatLast = 0x04,
      // Flag used to disable "Select All during Repeat Generator Effect"
      kRepeatGen = 0x08,
      // Flag used for repeating Nyquist Prompt
      kRepeatNyquistPrompt = 0x10,
   };

Constructor & Destructor Documentation

EffectManager()

EffectManager::EffectManager

(

)

Definition at line 48 of file EffectManager.cpp.

{
   mSkipStateFlag = false;
}

References mSkipStateFlag.

~EffectManager()

EffectManager::~EffectManager ( )

virtual

Definition at line 53 of file EffectManager.cpp.

{
}

Member Function Documentation

BatchProcessingOff()

void EffectManager::BatchProcessingOff ( const PluginID &  ID )

private

Definition at line 765 of file EffectManager.cpp.

{
   if (auto effect = GetEffect(ID))
      effect->UnsetBatchProcessing();
   else if (auto command = GetAudacityCommand(ID))
      command->SetBatchProcessing(false);
}

References GetAudacityCommand(), and GetEffect().

Referenced by EffectManager::UnsetBatchProcessing::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

BatchProcessingOn()

void EffectManager::BatchProcessingOn ( const PluginID &  ID )

private

Definition at line 757 of file EffectManager.cpp.

{
   if (auto effect = GetEffect(ID))
      effect->SetBatchProcessing();
   else if (auto command = GetAudacityCommand(ID))
      command->SetBatchProcessing(true);
}

References GetAudacityCommand(), and GetEffect().

Here is the call graph for this function:

DoAudacityCommand()

bool EffectManager::DoAudacityCommand	(	const PluginID &	ID,
		const CommandContext &	context,
		wxWindow *	parent,
		bool	shouldPrompt = true
	)

Run a command given the plugin ID

Definition at line 78 of file EffectManager.cpp.

{
   this->SetSkipStateFlag(false);
   AudacityCommand *command = GetAudacityCommand(ID);
   
   if (!command)
   {
      return false;
   }
 
   bool res = command->DoAudacityCommand(parent, context, shouldPrompt);
 
   return res;
}

References AudacityCommand::DoAudacityCommand(), GetAudacityCommand(), and SetSkipStateFlag().

Referenced by CommandDispatch::DoAudacityCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

DoGetEffect()

EffectAndDefaultSettings & EffectManager::DoGetEffect ( const PluginID &  ID )

private

Definition at line 836 of file EffectManager.cpp.

{
   static EffectAndDefaultSettings empty;
 
   // Must have a "valid" ID
   if (ID.empty())
      return empty;
 
   // If it is actually a command then refuse it (as an effect).
   if( mCommands.find( ID ) != mCommands.end() )
      return empty;
 
   if (auto iter = mEffects.find(ID); iter != mEffects.end())
      return iter->second;
   else {
      // This will instantiate the effect client if it hasn't already been done
      auto [component, settings] = LoadComponent(ID);
      if (!component)
         return empty;
 
      if (auto effect = dynamic_cast<EffectPlugin *>(component))
         return (mEffects[ID] = { effect, std::move(settings) });
      else {
         if ( !dynamic_cast<AudacityCommand *>(component) )
            AudacityMessageBox(
               XO(
"Attempting to initialize the following effect failed:\n\n%s\n\nMore information may be available in 'Help > Diagnostics > Show Log'")
                  .Format( GetCommandName(ID) ),
               XO("Effect failed to initialize"));
 
         return empty;
      }
   }
}

References AudacityMessageBox(), GetCommandName(), anonymous_namespace{EffectManager.cpp}::LoadComponent(), mCommands, mEffects, settings(), and XO().

Referenced by GetEffect(), and GetEffectAndDefaultSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

Get()

EffectManager & EffectManager::Get ( )

static

Get the singleton instance of the EffectManager. Probably not safe for multi-thread use.

Definition at line 42 of file EffectManager.cpp.

{
   static EffectManager em;
   return em;
}

Referenced by anonymous_namespace{MenuHelper.cpp}::AddGroupedEffectMenuItems(), anonymous_namespace{MenuHelper.cpp}::AddSortedEffectMenuItems(), anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), MacroCommands::ApplyCommand(), MacroCommands::ApplyEffectCommand(), HelpCommand::ApplyInner(), anonymous_namespace{MenuHelper.cpp}::ComapareEffectsByTypeAndPublisher(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByPublisher(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByPublisherAndName(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByType(), anonymous_namespace{MenuHelper.cpp}::CompareEffectsByTypeAndName(), CommandDispatch::DoAudacityCommand(), EffectUI::DoEffect(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), anonymous_namespace{PluginMenus.cpp}::GenerateMenu(), MacroCommands::GetCurrentParamsFor(), GetInstanceFactory(), CommandDispatch::HandleTextualCommand(), anonymous_namespace{MenuHelper.cpp}::IsEnabledPlugin(), MacroCommandsCatalog::MacroCommandsCatalog(), anonymous_namespace{BatchProcessDialog.cpp}::OnApplyMacroDirectlyByName(), CommandDispatch::OnAudacityCommand(), EffectNoiseReduction::Dialog::OnGetProfile(), NyqBench::OnGo(), MacroCommandDialog::OnItemSelected(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnOptionsClicked(), anonymous_namespace{TrackMenus.cpp}::OnStereoToMono(), PluginMenuItems(), NyquistEffect::Process(), MacroCommands::PromptForParamsFor(), MacroCommands::PromptForPresetFor(), GetInfoCommand::SendCommands(), MacroCommandDialog::SetCommandAndParams(), RealtimeEffectStateUI::Show(), anonymous_namespace{TrackMenus.cpp}::TracksMenu(), and RealtimeEffectStateUI::UpdateTitle().

Here is the caller graph for this function:

GetAudacityCommand()

AudacityCommand * EffectManager::GetAudacityCommand ( const PluginID &  ID )

private

Definition at line 871 of file EffectManager.cpp.

{
   // Must have a "valid" ID
   if (ID.empty())
   {
      return NULL;
   }
 
   if (mCommands.find(ID) == mCommands.end()) {
      // This will instantiate the command if it hasn't already been done
      auto command =
         dynamic_cast<AudacityCommand *>(PluginManager::Get().Load(ID));
      if (command)
      {
         command->Init();
         mCommands[ID] = command;
         return command;
      }
 
      AudacityMessageBox(
         XO(
"Attempting to initialize the following command failed:\n\n%s\n\nMore information may be available in 'Help > Diagnostics > Show Log'")
            .Format( GetCommandName(ID) ),
         XO("Command failed to initialize"));
 
      return NULL;
   }
 
   return mCommands[ID];
}

References AudacityMessageBox(), PluginManager::Get(), GetCommandName(), AudacityCommand::Init(), PluginManager::Load(), mCommands, and XO().

Referenced by BatchProcessingOff(), BatchProcessingOn(), DoAudacityCommand(), GetCommandDefinition(), GetCommandDescription(), GetCommandTip(), GetCommandUrl(), GetEffectParameters(), PromptUser(), and SetEffectParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCommandDefinition()

void EffectManager::GetCommandDefinition	(	const PluginID &	ID,
		const CommandContext &	context,
		int	flags
	)

Definition at line 168 of file EffectManager.cpp.

{
   const EffectSettingsManager *effect = nullptr;
   const EffectSettings *settings;
   AudacityCommand *command = nullptr;
 
   if (auto [edi, pSettings] = GetEffectAndDefaultSettings(ID); edi) {
      effect = &edi->GetDefinition();
      assert(pSettings); // postcondition
      settings = pSettings;
   }
   else
      command = GetAudacityCommand( ID );
   if ( !effect && !command )
      return;
 
   ConstSettingsVisitor NullShuttle;
 
   // Test if it defines any parameters at all.
   bool bHasParams = command
      ? command->VisitSettings( NullShuttle )
      : effect->VisitSettings( NullShuttle, *settings );
   if ( (flags == 0) && !bHasParams )
      return;
 
   // This is capturing the output context into the shuttle.
   ShuttleGetDefinition S(  *context.pOutput.get()->mStatusTarget.get() );
   S.StartStruct();
   // using GET to expose a CommandID to the user!
   // Macro command details are one place that we do expose Identifier
   // to (more sophisticated) users
   S.AddItem( GetCommandIdentifier( ID ).GET(), "id" );
   S.AddItem( GetCommandName( ID ).Translation(), "name" );
   if ( bHasParams ) {
      S.StartField( "params" );
      S.StartArray();
      command
         ? command->VisitSettings( S )
         : effect->VisitSettings( S, *settings );
      S.EndArray();
      S.EndField();
   }
   // use GET() to expose some details to macro programming users
   S.AddItem( GetCommandUrl( ID ).GET(), "url" );
   // The tip is a translated string!
   S.AddItem( GetCommandTip( ID ).Translation(), "tip" );
   S.EndStruct();
}

References GetAudacityCommand(), GetCommandIdentifier(), GetCommandName(), GetCommandTip(), GetCommandUrl(), GetEffectAndDefaultSettings(), CommandContext::pOutput, S, settings(), AudacityCommand::VisitSettings(), and EffectSettingsManager::VisitSettings().

Referenced by HelpCommand::ApplyInner(), and GetInfoCommand::SendCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCommandDescription()

TranslatableString EffectManager::GetCommandDescription

(

const PluginID &

ID

)

Definition at line 135 of file EffectManager.cpp.

{
   if (GetEffect(ID))
      return XO("Applied effect: %s").Format( GetCommandName(ID) );
   if (GetAudacityCommand(ID))
      return XO("Applied command: %s").Format( GetCommandName(ID) );
 
   return {};
}

References GetAudacityCommand(), GetCommandName(), GetEffect(), and XO().

Referenced by EffectUI::DoEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCommandIdentifier()

CommandID EffectManager::GetCommandIdentifier

(

const PluginID &

ID

)

Definition at line 129 of file EffectManager.cpp.

{
   auto name = PluginManager::Get().GetSymbol(ID).Internal();
   return EffectDefinitionInterface::GetSquashedName(name);
}

References PluginManager::Get(), EffectDefinitionInterface::GetSquashedName(), PluginManager::GetSymbol(), ComponentInterfaceSymbol::Internal(), and name.

Referenced by GetCommandDefinition(), GetEffectByIdentifier(), CommandDispatch::HandleTextualCommand(), MacroCommandsCatalog::MacroCommandsCatalog(), and GetInfoCommand::SendCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCommandName()

TranslatableString EffectManager::GetCommandName

(

const PluginID &

ID

)

Definition at line 102 of file EffectManager.cpp.

{
   return GetCommandSymbol(ID).Msgid();
}

References GetCommandSymbol(), and ComponentInterfaceSymbol::Msgid().

Referenced by EffectUI::DoEffect(), DoGetEffect(), GetAudacityCommand(), GetCommandDefinition(), GetCommandDescription(), and anonymous_namespace{BatchProcessDialog.cpp}::OnApplyMacroDirectlyByName().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCommandSymbol()

ComponentInterfaceSymbol EffectManager::GetCommandSymbol

(

const PluginID &

ID

)

Definition at line 97 of file EffectManager.cpp.

{
   return PluginManager::Get().GetSymbol(ID);
}

References PluginManager::Get(), and PluginManager::GetSymbol().

Referenced by GetCommandName().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCommandTip()

TranslatableString EffectManager::GetCommandTip

(

const PluginID &

ID

)

Definition at line 156 of file EffectManager.cpp.

{
   if (auto pEff = GetEffect(ID))
      return pEff->GetDefinition().GetDescription();
   AudacityCommand * pCom = GetAudacityCommand(ID);
   if( pCom )
      return pCom->GetDescription();
 
   return {};
}

References GetAudacityCommand(), AudacityCommand::GetDescription(), and GetEffect().

Referenced by GetCommandDefinition().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCommandUrl()

ManualPageID EffectManager::GetCommandUrl

(

const PluginID &

ID

)

Definition at line 145 of file EffectManager.cpp.

{
   if (auto pEff = GetEffect(ID))
      return pEff->GetDefinition().ManualPage();
   AudacityCommand * pCom = GetAudacityCommand(ID);
   if( pCom )
      return pCom->ManualPage();
 
   return wxEmptyString;
}

References GetAudacityCommand(), GetEffect(), and AudacityCommand::ManualPage().

Referenced by GetCommandDefinition().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDefaultPreset()

wxString EffectManager::GetDefaultPreset

(

const PluginID &

ID

)

Definition at line 727 of file EffectManager.cpp.

{
   auto effect = GetEffect(ID);
 
   if (!effect)
   {
      return wxEmptyString;
   }
 
   wxString preset;
   if (HasCurrentSettings(*effect))
   {
      preset = EffectPlugin::kCurrentSettingsIdent;
   }
   else if (HasFactoryDefaults(*effect))
   {
      preset = EffectPlugin::kFactoryDefaultsIdent;
   }
 
   if (!preset.empty())
   {
      CommandParameters eap;
 
      eap.Write(wxT("Use Preset"), preset);
      eap.GetParameters(preset);
   }
 
   return preset;
}

References GetEffect(), CommandParameters::GetParameters(), HasCurrentSettings(), HasFactoryDefaults(), EffectPlugin::kCurrentSettingsIdent, EffectPlugin::kFactoryDefaultsIdent, preset, and wxT().

Referenced by GetEffectParameters(), and MacroCommandDialog::OnItemSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDefaultSettings()

EffectSettings * EffectManager::GetDefaultSettings

(

const PluginID &

ID

)

Get default settings by effect ID. May return nullptr

Definition at line 778 of file EffectManager.cpp.

{
   return GetEffectAndDefaultSettings(ID).second;
}

References GetEffectAndDefaultSettings().

Referenced by EffectUI::DoEffect(), and PromptUser().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEffect()

EffectPlugin * EffectManager::GetEffect

(

const PluginID &

ID

)

Return an effect by its ID.

Definition at line 773 of file EffectManager.cpp.

{
   return DoGetEffect(ID).effect;
}

References DoGetEffect(), and EffectAndDefaultSettings::effect.

Referenced by BatchProcessingOff(), BatchProcessingOn(), EffectUI::DoEffect(), GetCommandDescription(), GetCommandTip(), GetCommandUrl(), GetDefaultPreset(), GetEffectFamilyName(), GetInstanceFactory(), GetPreset(), GetVendorName(), HasPresets(), IsHidden(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnOptionsClicked(), PromptUser(), RealtimeEffectStateUI::Show(), and RealtimeEffectStateUI::UpdateTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEffectAndDefaultSettings()

std::pair< EffectPlugin *, EffectSettings * > EffectManager::GetEffectAndDefaultSettings

(

const PluginID &

ID

)

Get effect and default settings by effect ID.

Postcondition

result: !result.first || result.second (if first member is not null, then the second is not null)

Definition at line 784 of file EffectManager.cpp.

{
   auto &results = DoGetEffect(ID);
   if (results.effect)
      return {results.effect, &results.settings};
   else
      return {nullptr, nullptr};
}

References DoGetEffect().

Referenced by GetCommandDefinition(), GetDefaultSettings(), GetEffectParameters(), and SetEffectParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEffectByIdentifier()

const PluginID & EffectManager::GetEffectByIdentifier

(

const CommandID &

strTarget

)

Definition at line 903 of file EffectManager.cpp.

{
   static PluginID empty;
   if (strTarget.empty()) // set GetCommandIdentifier to wxT("") to not show an effect in Batch mode
   {
      return empty;
   }
 
   PluginManager & pm = PluginManager::Get();
   // Effects OR Generic commands...
   for (auto &plug
        : pm.PluginsOfType(PluginTypeEffect | PluginTypeAudacityCommand)) {
      auto &ID = plug.GetID();
      if (GetCommandIdentifier(ID) == strTarget)
         return ID;
   }
   return empty;
}

References Identifier::empty(), PluginManager::Get(), GetCommandIdentifier(), PluginManager::PluginsOfType(), PluginTypeAudacityCommand, and PluginTypeEffect.

Referenced by MacroCommands::ApplyCommand(), HelpCommand::ApplyInner(), MacroCommands::GetCurrentParamsFor(), MacroCommandDialog::OnItemSelected(), MacroCommands::PromptForParamsFor(), MacroCommands::PromptForPresetFor(), MacroCommandDialog::SetCommandAndParams(), and anonymous_namespace{TrackMenus.cpp}::TracksMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEffectFamilyName()

TranslatableString EffectManager::GetEffectFamilyName

(

const PluginID &

ID

)

Definition at line 107 of file EffectManager.cpp.

{
   if(auto description = PluginManager::Get().GetPlugin(ID))
      return TranslatableString { description->GetEffectFamily(), {} };
 
   auto effect = GetEffect(ID);
   if (effect)
      return effect->GetDefinition().GetFamily().Msgid();
   return {};
}

References PluginManager::Get(), and GetEffect().

Referenced by anonymous_namespace{MenuHelper.cpp}::AddSortedEffectMenuItems().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEffectParameters()

wxString EffectManager::GetEffectParameters

(

const PluginID &

ID

)

Definition at line 248 of file EffectManager.cpp.

{
   auto pair = GetEffectAndDefaultSettings(ID);
   if (auto effect = pair.first) {
      assert(pair.second); // postcondition
      wxString parms;
 
      effect->SaveSettingsAsString(*pair.second, parms);
 
      // Some effects don't have automatable parameters and will not return
      // anything, so try to get the active preset (current or factory).
      if (parms.empty())
      {
         parms = GetDefaultPreset(ID);
      }
 
      return parms;
   }
 
   AudacityCommand *command = GetAudacityCommand(ID);
   
   if (command)
   {
      wxString parms;
 
      command->SaveSettingsAsString(parms);
 
      // Some effects don't have automatable parameters and will not return
      // anything, so try to get the active preset (current or factory).
      if (parms.empty())
      {
         parms = GetDefaultPreset(ID);
      }
 
      return parms;
   }
   return wxEmptyString;
}

References GetAudacityCommand(), GetDefaultPreset(), GetEffectAndDefaultSettings(), and AudacityCommand::SaveSettingsAsString().

Referenced by MacroCommands::GetCurrentParamsFor(), and MacroCommands::PromptForParamsFor().

Here is the call graph for this function:

Here is the caller graph for this function:

GetInstanceFactory()

const EffectInstanceFactory * EffectManager::GetInstanceFactory ( const PluginID &  ID )

static

Find the singleton EffectInstanceFactory for ID.

Definition at line 923 of file EffectManager.cpp.

{
   return Get().GetEffect(ID);
}

References Get(), and GetEffect().

Here is the call graph for this function:

GetPreset()

wxString EffectManager::GetPreset	(	const PluginID &	ID,
		const wxString &	params,
		wxWindow *	parent
	)

Definition at line 681 of file EffectManager.cpp.

{
   auto effect = GetEffect(ID);
 
   if (!effect)
   {
      return wxEmptyString;
   }
 
   CommandParameters eap(params);
 
   wxString preset;
   if (eap.HasEntry(wxT("Use Preset")))
   {
      preset = eap.Read(wxT("Use Preset"));
   }
 
   {
      EffectPresetsDialog dlg(parent, effect);
      dlg.Layout();
      dlg.Fit();
      dlg.SetSize(dlg.GetMinSize());
      dlg.CenterOnParent();
      dlg.SetSelected(preset);
      
      if (dlg.ShowModal())
         preset = dlg.GetSelected();
      else
         preset = wxEmptyString;
   }
 
   if (preset.empty())
   {
      return preset;
   }
 
   // This cleans a config "file" backed by a string in memory.
   eap.DeleteAll();
   
   eap.Write(wxT("Use Preset"), preset);
   eap.GetParameters(preset);
 
   return preset;
}

References GetEffect(), CommandParameters::GetParameters(), CommandParameters::HasEntry(), params, preset, and wxT().

Referenced by MacroCommands::PromptForPresetFor().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSkipStateFlag()

bool EffectManager::GetSkipStateFlag

(

)

Definition at line 231 of file EffectManager.cpp.

{
   return mSkipStateFlag;
}

References mSkipStateFlag.

Referenced by EffectUI::DoEffect().

Here is the caller graph for this function:

GetVendorName()

TranslatableString EffectManager::GetVendorName

(

const PluginID &

ID

)

Definition at line 118 of file EffectManager.cpp.

{
   if(auto description = PluginManager::Get().GetPlugin(ID))
      return TranslatableString { description->GetVendor(), {} };
   
   auto effect = GetEffect(ID);
   if (effect)
      return effect->GetDefinition().GetVendor().Msgid();
   return {};
}

References PluginManager::Get(), and GetEffect().

Referenced by anonymous_namespace{MenuHelper.cpp}::AddSortedEffectMenuItems().

Here is the call graph for this function:

Here is the caller graph for this function:

HasPresets()

bool EffectManager::HasPresets

(

const PluginID &

ID

)

Definition at line 393 of file EffectManager.cpp.

{
   auto effect = GetEffect(ID);
 
   if (!effect)
   {
      return false;
   }
 
   return GetUserPresets(*effect).size() > 0 ||
          effect->GetDefinition().GetFactoryPresets().size() > 0 ||
          HasCurrentSettings(*effect) ||
          HasFactoryDefaults(*effect);
}

References GetEffect(), GetUserPresets(), HasCurrentSettings(), and HasFactoryDefaults().

Referenced by MacroCommandDialog::OnItemSelected(), and MacroCommandDialog::SetCommandAndParams().

Here is the call graph for this function:

Here is the caller graph for this function:

IsHidden()

bool EffectManager::IsHidden

(

const PluginID &

ID

)

Definition at line 219 of file EffectManager.cpp.

{
   if(auto effect = GetEffect(ID))
      return effect->GetDefinition().IsHiddenFromMenus();
   return false;
}

References GetEffect().

Referenced by anonymous_namespace{MenuHelper.cpp}::IsEnabledPlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

PromptUser()

bool EffectManager::PromptUser	(	const PluginID &	ID,
		const EffectDialogFactory &	factory,
		wxWindow &	parent
	)

Shows an effect or command dialog so the user can specify settings for later.

It is used when defining a macro. It does not invoke the effect or command.

Show the effect dialog, only so that the user can choose settings, for instance to define a macro.

Definition at line 330 of file EffectManager.cpp.

{
   bool result = false;
   if (auto effect = dynamic_cast<Effect*>(GetEffect(ID))) {
 
      auto empty = TrackList::Create(nullptr);
      auto pEffectBase = dynamic_cast<EffectBase*>(effect);
      if (pEffectBase)
         // This allows effects to call Init() safely
         pEffectBase->SetTracks(empty.get());
      Finally Do([&]{
         // reverse the side-effect
         if (pEffectBase)
            pEffectBase->SetTracks(nullptr);
      });
 
      std::shared_ptr<EffectInstance> pInstance;
      if (const auto pSettings = GetDefaultSettings(ID)) {
         const auto pServices = dynamic_cast<EffectUIServices *>(effect);
         result = pServices && pServices->ShowHostInterface(*effect,
            parent, factory,
            pInstance,
            *std::make_shared<SimpleEffectSettingsAccess>(*pSettings),
            effect->IsBatchProcessing() ) != 0;
      }
      return result;
   }
 
   AudacityCommand *command = GetAudacityCommand(ID);
 
   if (command)
   {
      result = command->PromptUser(&parent);
      return result;
   }
 
   return result;
}

References TrackList::Create(), factory, GetAudacityCommand(), GetDefaultSettings(), GetEffect(), AudacityCommand::PromptUser(), EffectBase::SetTracks(), and EffectUIServices::ShowHostInterface().

Here is the call graph for this function:

RegisterEffect()

const PluginID & EffectManager::RegisterEffect

(

std::unique_ptr< EffectPlugin >

uEffect

)

Here solely for the purpose of Nyquist Workbench until a better solution is devised.

Register an effect so it can be executed. uEffect is expected to be a self-hosting Nyquist effect

Definition at line 59 of file EffectManager.cpp.

{
   auto pEffect = uEffect.get();
   const PluginID & ID =
      PluginManager::Get().RegisterPlugin(std::move(uEffect), PluginTypeEffect);
   mEffects[ID] = { pEffect, {} };
   return ID;
}

References PluginManager::Get(), mEffects, PluginTypeEffect, and PluginManager::RegisterPlugin().

Referenced by NyqBench::OnGo().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBatchProcessing()

BatchProcessingScope EffectManager::SetBatchProcessing ( const PluginID &  ID )

inline

Begin a scope that ends when the returned object is destroyed.

Within this scope, "batch" (i.e. macro) processing happens, and Effects that are not yet stateless may change their state temporarily, but it is restored afterward

Definition at line 140 of file EffectManager.h.

   {
      BatchProcessingOn(ID); return BatchProcessingScope{ this, {ID} };
   }

Referenced by MacroCommands::ApplyEffectCommand(), and MacroCommands::PromptForParamsFor().

Here is the caller graph for this function:

SetEffectParameters()

bool EffectManager::SetEffectParameters	(	const PluginID &	ID,
		const wxString &	params
	)

Definition at line 288 of file EffectManager.cpp.

{
   auto pair = GetEffectAndDefaultSettings(ID);
   if (auto effect = pair.first) {
      assert(pair.second); // postcondition
      auto &settings = *pair.second;
      CommandParameters eap(params);
 
      // Check first for what GetDefaultPreset() might have written
      if (eap.HasEntry(wxT("Use Preset")))
      {
         return effect->LoadSettingsFromString(
            eap.Read(wxT("Use Preset")), settings).has_value();
      }
 
      return effect->LoadSettingsFromString(params, settings).has_value();
   }
   AudacityCommand *command = GetAudacityCommand(ID);
   
   if (command)
   {
      // Set defaults (if not initialised) before setting values.
      command->Init(); 
      CommandParameters eap(params);
 
      // Check first for what GetDefaultPreset() might have written
      if (eap.HasEntry(wxT("Use Preset")))
      {
         return command
            ->LoadSettingsFromString(eap.Read(wxT("Use Preset")));
      }
 
      return command->LoadSettingsFromString(params);
   }
   return false;
}

References GetAudacityCommand(), GetEffectAndDefaultSettings(), CommandParameters::HasEntry(), AudacityCommand::Init(), AudacityCommand::LoadSettingsFromString(), params, settings(), and wxT().

Here is the call graph for this function:

SetSkipStateFlag()

void EffectManager::SetSkipStateFlag

(

bool

flag

)

Allow effects to disable saving the state at run time

Definition at line 226 of file EffectManager.cpp.

{
   mSkipStateFlag = flag;
}

References flag, and mSkipStateFlag.

Referenced by DoAudacityCommand(), EffectUI::DoEffect(), EffectNoiseReduction::Dialog::OnGetProfile(), and NyquistEffect::Process().

Here is the caller graph for this function:

SupportsAutomation()

bool EffectManager::SupportsAutomation

(

const PluginID &

ID

)

Support for batch commands

Definition at line 236 of file EffectManager.cpp.

{
   const PluginDescriptor *plug =  PluginManager::Get().GetPlugin(ID);
   if (plug)
   {
      return plug->IsEffectAutomatable();
   }
 
   return false;
}

References PluginManager::Get(), PluginManager::GetPlugin(), and PluginDescriptor::IsEffectAutomatable().

Here is the call graph for this function:

UnregisterEffect()

void EffectManager::UnregisterEffect

(

const PluginID &

ID

)

Used only by Nyquist Workbench module.

Definition at line 71 of file EffectManager.cpp.

{
   PluginID id = ID;
   PluginManager::Get().UnregisterPlugin(id);
   mEffects.erase(id);
}

References PluginManager::Get(), mEffects, and PluginManager::UnregisterPlugin().

Referenced by NyqBench::OnGo().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCommands

AudacityCommandMap EffectManager::mCommands

private

Definition at line 171 of file EffectManager.h.

Referenced by DoGetEffect(), and GetAudacityCommand().

mEffects

EffectMap EffectManager::mEffects

private

Definition at line 170 of file EffectManager.h.

Referenced by DoGetEffect(), RegisterEffect(), and UnregisterEffect().

mHostEffects

EffectOwnerMap EffectManager::mHostEffects

private

Definition at line 172 of file EffectManager.h.

mNumEffects

int EffectManager::mNumEffects

private

Definition at line 174 of file EffectManager.h.

mSkipStateFlag

bool EffectManager::mSkipStateFlag

private

Definition at line 178 of file EffectManager.h.

Referenced by EffectManager(), GetSkipStateFlag(), and SetSkipStateFlag().

---

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

• EffectManager.h
• EffectManager.cpp