New virtual function in ModuleInterface

include/audacity/ModuleInterface.h

@@ -76,6 +76,11 @@ public:
    // Called just prior to deletion to allow releasing any resources.
    virtual void Terminate() = 0;
 
+   // A symbol identifying the family of plugin provided by this module;
+   // if it is not empty, then the family as a whole can be enabled or
+   // disabled by the user in Preferences
+   virtual EffectFamilySymbol GetOptionalFamilySymbol() = 0;
+
    // "Paths" returned by FindPluginPaths() and passed back to
    // DiscoverPluginsAtPath() have module-specific meaning.
    // They are not necessarily file system paths to existent files that

src/commands/LoadCommands.cpp

@@ -224,6 +224,12 @@ void BuiltinCommandsModule::Terminate()
    return;
 }
 
+EffectFamilySymbol BuiltinCommandsModule::GetOptionalFamilySymbol()
+{
+   // Commands are not enabled and disabled in EffectsPrefs
+   return {};
+}
+
 const FileExtensions &BuiltinCommandsModule::GetFileExtensions()
 {
    static FileExtensions empty;

src/commands/LoadCommands.h

@@ -39,6 +39,7 @@ public:
 
    bool Initialize() override;
    void Terminate() override;
+   EffectFamilySymbol GetOptionalFamilySymbol() override;
 
    const FileExtensions &GetFileExtensions() override;
    FilePath InstallPath() override { return {}; }

src/effects/LoadEffects.cpp

@@ -290,6 +290,13 @@ void BuiltinEffectsModule::Terminate()
    return;
 }
 
+EffectFamilySymbol BuiltinEffectsModule::GetOptionalFamilySymbol()
+{
+   // Returns empty, because there should not be an option in Preferences to
+   // disable the built-in effects.
+   return {};
+}
+
 const FileExtensions &BuiltinEffectsModule::GetFileExtensions()
 {
    static FileExtensions empty;

src/effects/LoadEffects.h

@@ -38,6 +38,7 @@ public:
 
    bool Initialize() override;
    void Terminate() override;
+   EffectFamilySymbol GetOptionalFamilySymbol() override;
 
    const FileExtensions &GetFileExtensions() override;
    FilePath InstallPath() override { return {}; }

src/effects/VST/VSTEffect.cpp

@@ -366,6 +366,15 @@ void VSTEffectsModule::Terminate()
    return;
 }
 
+EffectFamilySymbol VSTEffectsModule::GetOptionalFamilySymbol()
+{
+#if USE_VST
+   return VSTPLUGINTYPE;
+#else
+   return {};
+#endif
+}
+
 const FileExtensions &VSTEffectsModule::GetFileExtensions()
 {
    static FileExtensions result{{ _T("vst") }};

src/effects/VST/VSTEffect.h

@@ -417,6 +417,7 @@ public:
 
    bool Initialize() override;
    void Terminate() override;
+   EffectFamilySymbol GetOptionalFamilySymbol() override;
 
    const FileExtensions &GetFileExtensions() override;
    FilePath InstallPath() override;

src/effects/audiounits/AudioUnitEffect.cpp

@@ -153,6 +153,15 @@ void AudioUnitEffectsModule::Terminate()
    return;
 }
 
+EffectFamilySymbol AudioUnitEffectsModule::GetOptionalFamilySymbol()
+{
+#if USE_AUDIO_UNITS
+   return AUDIOUNITEFFECTS_FAMILY;
+#else
+   return {};
+#endif
+}
+
 bool AudioUnitEffectsModule::AutoRegisterPlugins(PluginManagerInterface & pm)
 {
    // Nothing to be done here

src/effects/audiounits/AudioUnitEffect.h

@@ -241,6 +241,7 @@ public:
 
    bool Initialize() override;
    void Terminate() override;
+   EffectFamilySymbol GetOptionalFamilySymbol() override;
 
    const FileExtensions &GetFileExtensions() override;
    FilePath InstallPath() override { return {}; }

src/effects/ladspa/LadspaEffect.cpp

@@ -162,6 +162,15 @@ void LadspaEffectsModule::Terminate()
    return;
 }
 
+EffectFamilySymbol LadspaEffectsModule::GetOptionalFamilySymbol()
+{
+#if USE_LADSPA
+   return LADSPAEFFECTS_FAMILY;
+#else
+   return {};
+#endif
+}
+
 const FileExtensions &LadspaEffectsModule::GetFileExtensions()
 {
    static FileExtensions result{{

src/effects/ladspa/LadspaEffect.h

@@ -222,6 +222,7 @@ public:
 
    bool Initialize() override;
    void Terminate() override;
+   EffectFamilySymbol GetOptionalFamilySymbol() override;
 
    const FileExtensions &GetFileExtensions() override;
    FilePath InstallPath() override;

src/effects/lv2/LoadLV2.cpp

@@ -207,6 +207,15 @@ void LV2EffectsModule::Terminate()
    return;
 }
 
+EffectFamilySymbol LV2EffectsModule::GetOptionalFamilySymbol()
+{
+#if USE_LV2
+   return LV2EFFECTS_FAMILY;
+#else
+   return {};
+#endif
+}
+
 const FileExtensions &LV2EffectsModule::GetFileExtensions()
 {
    static FileExtensions empty;

src/effects/lv2/LoadLV2.h

@@ -85,6 +85,7 @@ public:
 
    bool Initialize() override;
    void Terminate() override;
+   EffectFamilySymbol GetOptionalFamilySymbol() override;
 
    const FileExtensions &GetFileExtensions() override;
    FilePath InstallPath() override { return {}; }

src/effects/nyquist/LoadNyquist.cpp

@@ -154,6 +154,15 @@ void NyquistEffectsModule::Terminate()
    return;
 }
 
+EffectFamilySymbol NyquistEffectsModule::GetOptionalFamilySymbol()
+{
+#if USE_NYQUIST
+   return NYQUISTEFFECTS_FAMILY;
+#else
+   return {};
+#endif
+}
+
 const FileExtensions &NyquistEffectsModule::GetFileExtensions()
 {
    static FileExtensions result{{ _T("ny") }};

src/effects/nyquist/LoadNyquist.h

@@ -36,6 +36,8 @@ public:
 
    bool Initialize() override;
    void Terminate() override;
+   EffectFamilySymbol GetOptionalFamilySymbol() override;
+
 
    const FileExtensions &GetFileExtensions() override;
    FilePath InstallPath() override;

src/effects/vamp/LoadVamp.cpp

@@ -111,6 +111,15 @@ void VampEffectsModule::Terminate()
    return;
 }
 
+EffectFamilySymbol VampEffectsModule::GetOptionalFamilySymbol()
+{
+#if USE_VAMP
+   return VAMPEFFECTS_FAMILY;
+#else
+   return {};
+#endif
+}
+
 const FileExtensions &VampEffectsModule::GetFileExtensions()
 {
    static FileExtensions empty;

src/effects/vamp/LoadVamp.h

@@ -44,6 +44,7 @@ public:
 
    bool Initialize() override;
    void Terminate() override;
+   EffectFamilySymbol GetOptionalFamilySymbol() override;
 
    const FileExtensions &GetFileExtensions() override;
    FilePath InstallPath() override { return {}; }