EffectAndCommandPluginManager Class Reference

#include <EffectAndCommandPluginManager.h>

Collaboration diagram for EffectAndCommandPluginManager:

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

Public Types
using	DialogInvoker = std::function< bool(Effect &, EffectSettings &, std::shared_ptr< EffectInstance > &)>

Public Member Functions
bool	DoAudacityCommand (const PluginID &ID, const CommandContext &, bool shouldPrompt=true)
void	GetCommandDefinition (const PluginID &ID, const CommandContext &context, int flags)
wxString	GetEffectParameters (const PluginID &ID)
bool	SetEffectParameters (const PluginID &ID, const wxString &params)
bool	PromptUser (const PluginID &ID, AudacityProject &project, DialogInvoker dialogInvoker)
	Shows an effect or command dialog so the user can specify settings for later. More...
BatchProcessingScope	SetBatchProcessing (const PluginID &ID)
	Begin a scope that ends when the returned object is destroyed. More...

Static Public Member Functions
static EffectAndCommandPluginManager &	Get ()

Private Types
using	BatchProcessingScope = std::unique_ptr< EffectAndCommandPluginManager, UnsetBatchProcessing >
using	AudacityCommandMap = std::unordered_map< wxString, AudacityCommand * >

Private Member Functions
void	BatchProcessingOn (const PluginID &ID)
void	BatchProcessingOff (const PluginID &ID)
ManualPageID	GetCommandUrl (const PluginID &ID)
TranslatableString	GetCommandTip (const PluginID &ID)
AudacityCommand *	GetAudacityCommand (const PluginID &ID)

Private Attributes
AudacityCommandMap	mCommands

Detailed Description

Definition at line 35 of file EffectAndCommandPluginManager.h.

Member Typedef Documentation

AudacityCommandMap

using EffectAndCommandPluginManager::AudacityCommandMap = std::unordered_map<wxString, AudacityCommand*>

private

Definition at line 89 of file EffectAndCommandPluginManager.h.

BatchProcessingScope

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

private

Definition at line 72 of file EffectAndCommandPluginManager.h.

DialogInvoker

using EffectAndCommandPluginManager::DialogInvoker = std::function<bool( Effect&, EffectSettings&, std::shared_ptr<EffectInstance>&)>

Definition at line 40 of file EffectAndCommandPluginManager.h.

Member Function Documentation

BatchProcessingOff()

void EffectAndCommandPluginManager::BatchProcessingOff ( const PluginID &  ID )

private

Definition at line 160 of file EffectAndCommandPluginManager.cpp.

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

References EffectManager::Get(), and GetAudacityCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

BatchProcessingOn()

void EffectAndCommandPluginManager::BatchProcessingOn ( const PluginID &  ID )

private

Definition at line 152 of file EffectAndCommandPluginManager.cpp.

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

References EffectManager::Get(), and GetAudacityCommand().

Referenced by SetBatchProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

DoAudacityCommand()

bool EffectAndCommandPluginManager::DoAudacityCommand	(	const PluginID &	ID,
		const CommandContext &	context,
		bool	shouldPrompt = true
	)

Run a command given the plugin ID

Definition at line 26 of file EffectAndCommandPluginManager.cpp.

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

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

Referenced by CommandDispatch::DoAudacityCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Get()

EffectAndCommandPluginManager & EffectAndCommandPluginManager::Get ( )

static

Definition at line 20 of file EffectAndCommandPluginManager.cpp.

{
   static EffectAndCommandPluginManager ecm;
   return ecm;
}

Referenced by MacroCommands::ApplyEffectCommand(), HelpCommand::ApplyInner(), CommandDispatch::DoAudacityCommand(), MacroCommands::GetCurrentParamsFor(), MacroCommands::PromptForParamsFor(), and GetInfoCommand::SendCommands().

Here is the caller graph for this function:

GetAudacityCommand()

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

private

Definition at line 45 of file EffectAndCommandPluginManager.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;
      }
 
      BasicUI::ShowMessageBox(
         XO("Attempting to initialize the following command failed:\n\n%s\n\nMore information may be available in 'Help > Diagnostics > Show Log'")
            .Format(PluginManager::Get().GetName(ID)),
         BasicUI::MessageBoxOptions {}.Caption(
            XO("Command failed to initialize")));
 
      return NULL;
   }
 
   return mCommands[ID];
}

References BasicUI::MessageBoxOptions::Caption(), PluginManager::Get(), AudacityCommand::Init(), PluginManager::Load(), mCommands, BasicUI::ShowMessageBox(), and XO().

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

Here is the call graph for this function:

Here is the caller graph for this function:

GetCommandDefinition()

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

Definition at line 100 of file EffectAndCommandPluginManager.cpp.

{
   const EffectSettingsManager* effect = nullptr;
   const EffectSettings* settings;
   AudacityCommand* command = nullptr;
 
   if (auto [edi, pSettings] =
          EffectManager::Get().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
   const auto& pm = PluginManager::Get();
   S.AddItem(pm.GetCommandIdentifier(ID).GET(), "id");
   S.AddItem(pm.GetName(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 EffectManager::Get(), PluginManager::Get(), GetAudacityCommand(), GetCommandTip(), GetCommandUrl(), 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:

GetCommandTip()

TranslatableString EffectAndCommandPluginManager::GetCommandTip ( const PluginID &  ID )

private

Definition at line 89 of file EffectAndCommandPluginManager.cpp.

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

References EffectManager::Get(), GetAudacityCommand(), and AudacityCommand::GetDescription().

Referenced by GetCommandDefinition().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCommandUrl()

ManualPageID EffectAndCommandPluginManager::GetCommandUrl ( const PluginID &  ID )

private

Definition at line 77 of file EffectAndCommandPluginManager.cpp.

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

References EffectManager::Get(), GetAudacityCommand(), and AudacityCommand::ManualPage().

Referenced by GetCommandDefinition().

Here is the call graph for this function:

Here is the caller graph for this function:

GetEffectParameters()

wxString EffectAndCommandPluginManager::GetEffectParameters

(

const PluginID &

ID

)

Support for batch commands

Definition at line 169 of file EffectAndCommandPluginManager.cpp.

{
   auto pair = EffectManager::Get().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 = EffectManager::Get().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 = EffectManager::Get().GetDefaultPreset(ID);
      }
 
      return parms;
   }
   return wxEmptyString;
}

References EffectManager::Get(), GetAudacityCommand(), EffectManager::GetDefaultPreset(), EffectManager::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:

PromptUser()

bool EffectAndCommandPluginManager::PromptUser	(	const PluginID &	ID,
		AudacityProject &	project,
		DialogInvoker	dialogInvoker
	)

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 253 of file EffectAndCommandPluginManager.cpp.

{
   bool result = false;
   if (auto effect = dynamic_cast<Effect*>(EffectManager::Get().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 = EffectManager::Get().GetDefaultSettings(ID))
         result = dialogInvoker(*effect, *pSettings, pInstance);
      return result;
   }
 
   AudacityCommand* command = GetAudacityCommand(ID);
 
   if (command)
   {
      result = command->PromptUser(project);
      return result;
   }
 
   return result;
}

References TrackList::Create(), EffectManager::Get(), GetAudacityCommand(), project, AudacityCommand::PromptUser(), and EffectBase::SetTracks().

Referenced by MacroCommands::PromptForParamsFor().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBatchProcessing()

BatchProcessingScope EffectAndCommandPluginManager::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 82 of file EffectAndCommandPluginManager.h.

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

References BatchProcessingOn().

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

Here is the call graph for this function:

Here is the caller graph for this function:

SetEffectParameters()

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

Definition at line 210 of file EffectAndCommandPluginManager.cpp.

{
   auto pair = EffectManager::Get().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 EffectManager::Get(), GetAudacityCommand(), EffectManager::GetEffectAndDefaultSettings(), CommandParameters::HasEntry(), AudacityCommand::Init(), AudacityCommand::LoadSettingsFromString(), params, settings(), and wxT().

Here is the call graph for this function:

Member Data Documentation

mCommands

AudacityCommandMap EffectAndCommandPluginManager::mCommands

private

Definition at line 96 of file EffectAndCommandPluginManager.h.

Referenced by GetAudacityCommand().

---

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

• EffectAndCommandPluginManager.h
• EffectAndCommandPluginManager.cpp