1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-10-21 22:12:58 +02:00

Automation: AudacityCommand

This is a squash of 50 commits.

This merges the capabilities of BatchCommands and Effects using a new
AudacityCommand class.  AudacityCommand provides one function to specify the
parameters, and then we leverage that one function in automation, whether by chains,
mod-script-pipe or (future) Nyquist.

- Now have AudacityCommand which is using the same mechanism as Effect
- Has configurable parameters
- Has data-entry GUI (built using shuttle GUI)
- Registers with PluginManager.
- Menu commands now provided in chains, and to python batch.
   - Tested with Zoom Toggle.

- ShuttleParams now can set, get, set defaults, validate and specify
the parameters.
- Bugfix: Don't overwrite values with defaults first time out.
- Add DefineParams function for all built-in effects.
- Extend CommandContext to carry output channels for results.

We abuse EffectsManager.  It handles both Effects and
AudacityCommands now.  In time an Effect should become a special case of
AudacityCommand and we'll split and rename the EffectManager class.

- Don't use 'default' as a parameter name.
- Massive renaming for CommandDefinitionInterface
- EffectIdentInterface becomes EffectDefinitionInterface
- EffectAutomationParameters becomes CommandAutomationParameters
- PluginType is now a bit field.

This way we can search for related types at the same time.

- Most old batch commands made into AudacityCommands.
The ones that weren't are for a reason.  They are used by mod-script-pipe
to carry commands and responses across from a non-GUI thread to the GUI
thread.

- Major tidy up of ScreenshotCommand
- Reworking of SelectCommand
- GetPreferenceCommand and SetPreferenceCommand
- GetTrackInfo and SetTrackInfo
- GetInfoCommand
- Help, Open, Save, Import and Export commands.
- Removed obsolete commands ExecMenu, GetProjectInfo and SetProjectInfo
  which are now better handled by other commands.

- JSONify "GetInfo: Commands" output, i.e. commas in the right places.

- General work on better Doxygen.
    - Lyrics -> LyricsPanel
    - Meter -> MeterPanel
- Updated Linux makefile.
- Scripting commands added into Extra menu.
- Distinct names for previously duplicated find-clipping parameters.
- Fixed longstanding error with erroneous status field number which
  previously caused an ASSERT in debug.
- Sensible formatting of numbers in Chains, 0.1 not 0.1000000000137
This commit is contained in:
James Crook
2018-01-14 18:51:41 +00:00
committed by Paul Licameli
parent b7b01d48e0
commit 1c988b4e3a
191 changed files with 4659 additions and 2768 deletions

View File

@@ -6,15 +6,16 @@
PreferenceCommands.h
Dan Horgan
James Crook
******************************************************************//**
\class SetPreferenceCommand
\brief Command for setting a preference to a given value
\class GetPreferenceCommand
\brief Command for getting the value of a preference
\class SetPreferenceCommand
\brief Command for setting a preference to a given value
*//*******************************************************************/
#ifndef __PREFERENCECOMMANDS__
@@ -25,46 +26,43 @@
// GetPreference
class GetPreferenceCommandType final : public CommandType
#define GET_PREFERENCE_PLUGIN_SYMBOL XO("Get Preference")
#define SET_PREFERENCE_PLUGIN_SYMBOL XO("Set Preference")
class GetPreferenceCommand final : public AudacityCommand
{
public:
wxString BuildName() override;
void BuildSignature(CommandSignature &signature) override;
CommandHolder Create(std::unique_ptr<CommandOutputTarget> &&target) override;
};
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return GET_PREFERENCE_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Gets the value of a single preference.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
bool Apply(const CommandContext & context) override;
class GetPreferenceCommand final : public CommandImplementation
{
public:
GetPreferenceCommand(CommandType &type,
std::unique_ptr<CommandOutputTarget> &&target)
: CommandImplementation(type, std::move(target))
{ }
// AudacityCommand overrides
wxString ManualPage() override {return wxT("Preferences");};
virtual ~GetPreferenceCommand();
bool Apply(CommandExecutionContext context) override;
wxString mName;
};
// SetPreference
class SetPreferenceCommandType final : public CommandType
class SetPreferenceCommand final : public AudacityCommand
{
public:
wxString BuildName() override;
void BuildSignature(CommandSignature &signature) override;
CommandHolder Create(std::unique_ptr<CommandOutputTarget> &&target) override;
};
// CommandDefinitionInterface overrides
wxString GetSymbol() override {return SET_PREFERENCE_PLUGIN_SYMBOL;};
wxString GetDescription() override {return _("Sets the value of a single preference.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
bool Apply(const CommandContext & context) override;
class SetPreferenceCommand final : public CommandImplementation
{
public:
SetPreferenceCommand(CommandType &type,
std::unique_ptr<CommandOutputTarget> &&target)
: CommandImplementation(type, std::move(target))
{ }
// AudacityCommand overrides
wxString ManualPage() override {return wxT("Preferences");};
virtual ~SetPreferenceCommand();
bool Apply(CommandExecutionContext context) override;
wxString mName;
wxString mValue;
bool mbReload;
};
#endif /* End of include guard: __PREFERENCECOMMANDS__ */