EffectManager Class Reference

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

#include <EffectManager.h>

Collaboration diagram for EffectManager:

Public Types
enum	: unsigned {   kNone = 0x00 , kConfigured = 0x01 , kSkipState = 0x02 , kDontRepeatLast = 0x04 ,   kRepeatGen = 0x08 , kRepeatNyquistPrompt = 0x10 }
using	EffectPresetDialog = std::function< std::optional< wxString >(EffectPlugin &, const wxString &preset)>

Public Member Functions
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	IsHidden (const PluginID &ID)
bool	HasPresets (const PluginID &ID)
wxString	GetPreset (const PluginID &ID, const wxString &params, EffectPresetDialog)
wxString	GetDefaultPreset (const PluginID &ID)
void	SetSkipStateFlag (bool flag)
bool	GetSkipStateFlag ()
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 Member Functions
EffectAndDefaultSettings &	DoGetEffect (const PluginID &ID)

Private Attributes
EffectMap	mEffects
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 51 of file EffectManager.h.

Member Typedef Documentation

EffectPresetDialog

using EffectManager::EffectPresetDialog = std::function<std::optional<wxString>( EffectPlugin&, const wxString& preset)>

Definition at line 85 of file EffectManager.h.

Member Enumeration Documentation

anonymous enum

anonymous enum : unsigned

Enumerator
kNone
kConfigured
kSkipState
kDontRepeatLast
kRepeatGen
kRepeatNyquistPrompt

Definition at line 55 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,
   };

Member Function Documentation

DoGetEffect()

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

private

Definition at line 268 of file EffectManager.cpp.

{
   static EffectAndDefaultSettings empty;
 
   // Must have a "valid" ID
   if (ID.empty())
      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
         return empty;
   }
}

References anonymous_namespace{EffectManager.cpp}::LoadComponent(), mEffects, and settings().

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 33 of file EffectManager.cpp.

{
   static EffectManager em;
   return em;
}

Referenced by anonymous_namespace{MenuHelper.cpp}::AddGroupedEffectMenuItems(), anonymous_namespace{MenuHelper.cpp}::AddSortedEffectMenuItems(), EffectAndCommandPluginManager::BatchProcessingOff(), EffectAndCommandPluginManager::BatchProcessingOn(), 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(), EffectAndCommandPluginManager::DoAudacityCommand(), AudacityApplicationLogic::DoEffect(), EffectAndCommandPluginManager::GetCommandDefinition(), EffectAndCommandPluginManager::GetCommandTip(), EffectAndCommandPluginManager::GetCommandUrl(), EffectAndCommandPluginManager::GetEffectParameters(), GetInstanceFactory(), anonymous_namespace{MenuHelper.cpp}::IsEnabledPlugin(), MacroCommandsCatalog::MacroCommandsCatalog(), EffectNoiseReduction::Dialog::OnGetProfile(), NyqBench::OnGo(), MacroCommandDialog::OnItemSelected(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnOptionsClicked(), NyquistEffect::Process(), MacroCommands::PromptForPresetFor(), EffectAndCommandPluginManager::PromptUser(), MacroCommandDialog::SetCommandAndParams(), EffectAndCommandPluginManager::SetEffectParameters(), RealtimeEffectStateUI::Show(), and RealtimeEffectStateUI::UpdateTitle().

Here is the caller graph for this function:

GetDefaultPreset()

wxString EffectManager::GetDefaultPreset

(

const PluginID &

ID

)

Definition at line 175 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 EffectAndCommandPluginManager::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 210 of file EffectManager.cpp.

{
   return GetEffectAndDefaultSettings(ID).second;
}

References GetEffectAndDefaultSettings().

Referenced by AudacityApplicationLogic::DoEffect().

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 205 of file EffectManager.cpp.

{
   return DoGetEffect(ID).effect;
}

References DoGetEffect(), and EffectAndDefaultSettings::effect.

Referenced by AudacityApplicationLogic::DoEffect(), GetDefaultPreset(), GetEffectFamilyName(), GetInstanceFactory(), GetPreset(), GetVendorName(), HasPresets(), IsHidden(), anonymous_namespace{RealtimeEffectPanel.cpp}::RealtimeEffectControl::OnOptionsClicked(), 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 216 of file EffectManager.cpp.

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

References DoGetEffect().

Referenced by GetDefaultSettings(), EffectAndCommandPluginManager::GetEffectParameters(), and EffectAndCommandPluginManager::SetEffectParameters().

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 60 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(), GetEffect(), and anonymous_namespace{RealtimeEffectPanel.cpp}::GetPlugin().

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

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 292 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,
		EffectPresetDialog	dialog
	)

Definition at line 137 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"));
   }
 
   if (const auto answer = dialog(*effect, preset))
      preset = *answer;
   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 95 of file EffectManager.cpp.

{
   return mSkipStateFlag;
}

References mSkipStateFlag.

Referenced by AudacityApplicationLogic::DoEffect().

Here is the caller graph for this function:

GetVendorName()

TranslatableString EffectManager::GetVendorName

(

const PluginID &

ID

)

Definition at line 71 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(), GetEffect(), and anonymous_namespace{RealtimeEffectPanel.cpp}::GetPlugin().

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 121 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().

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 83 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:

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 41 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:

SetSkipStateFlag()

void EffectManager::SetSkipStateFlag

(

bool

flag

)

Allow effects to disable saving the state at run time

Definition at line 90 of file EffectManager.cpp.

{
   mSkipStateFlag = flag;
}

References flag, and mSkipStateFlag.

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

Here is the caller graph for this function:

UnregisterEffect()

void EffectManager::UnregisterEffect

(

const PluginID &

ID

)

Used only by Nyquist Workbench module.

Definition at line 53 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

mEffects

EffectMap EffectManager::mEffects

private

Definition at line 126 of file EffectManager.h.

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

mHostEffects

EffectOwnerMap EffectManager::mHostEffects

private

Definition at line 127 of file EffectManager.h.

mNumEffects

int EffectManager::mNumEffects

private

Definition at line 129 of file EffectManager.h.

mSkipStateFlag

bool EffectManager::mSkipStateFlag

private

Definition at line 133 of file EffectManager.h.

Referenced by GetSkipStateFlag(), and SetSkipStateFlag().

---

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

• EffectManager.h
• EffectManager.cpp