1c988b4e3a
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
113 lines
5.5 KiB
C++
113 lines
5.5 KiB
C++
/**********************************************************************
|
|
|
|
Audacity: A Digital Audio Editor
|
|
|
|
ConfigInterface.h
|
|
|
|
Leland Lucius
|
|
|
|
Copyright (c) 2014, Audacity Team
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
|
|
1. Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
|
|
2. Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
|
|
3. Neither the name of the copyright holder nor the names of its
|
|
contributors may be used to endorse or promote products derived from
|
|
this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
**********************************************************************/
|
|
|
|
#ifndef __AUDACITY_CONFIGINTERFACE_H__
|
|
#define __AUDACITY_CONFIGINTERFACE_H__
|
|
|
|
/*************************************************************************************//**
|
|
|
|
\class ConfigClientInterface
|
|
|
|
\brief ConfigClientInterface is an unholy get/set configuration class, which
|
|
differentiates between private and shared config. It should probably be replaced
|
|
with a Shuttle.
|
|
|
|
*******************************************************************************************/
|
|
class AUDACITY_DLL_API ConfigClientInterface /* not final */
|
|
{
|
|
public:
|
|
virtual ~ConfigClientInterface() {};
|
|
|
|
virtual bool HasSharedConfigGroup(const wxString & group) = 0;
|
|
virtual bool GetSharedConfigSubgroups(const wxString & group, wxArrayString & subgroups) = 0;
|
|
|
|
virtual bool GetSharedConfig(const wxString & group, const wxString & key, wxString & value, const wxString & defval) = 0;
|
|
virtual bool GetSharedConfig(const wxString & group, const wxString & key, int & value, int defval) = 0;
|
|
virtual bool GetSharedConfig(const wxString & group, const wxString & key, bool & value, bool defval) = 0;
|
|
virtual bool GetSharedConfig(const wxString & group, const wxString & key, float & value, float defval) = 0;
|
|
virtual bool GetSharedConfig(const wxString & group, const wxString & key, double & value, double defval) = 0;
|
|
|
|
virtual bool SetSharedConfig(const wxString & group, const wxString & key, const wxString & value) = 0;
|
|
virtual bool SetSharedConfig(const wxString & group, const wxString & key, const int & value) = 0;
|
|
virtual bool SetSharedConfig(const wxString & group, const wxString & key, const bool & value) = 0;
|
|
virtual bool SetSharedConfig(const wxString & group, const wxString & key, const float & value) = 0;
|
|
virtual bool SetSharedConfig(const wxString & group, const wxString & key, const double & value) = 0;
|
|
|
|
virtual bool RemoveSharedConfigSubgroup(const wxString & group) = 0;
|
|
virtual bool RemoveSharedConfig(const wxString & group, const wxString & key) = 0;
|
|
|
|
virtual bool HasPrivateConfigGroup(const wxString & group) = 0;
|
|
virtual bool GetPrivateConfigSubgroups(const wxString & group, wxArrayString & subgroups) = 0;
|
|
|
|
virtual bool GetPrivateConfig(const wxString & group, const wxString & key, wxString & value, const wxString & defval) = 0;
|
|
virtual bool GetPrivateConfig(const wxString & group, const wxString & key, int & value, int defval) = 0;
|
|
virtual bool GetPrivateConfig(const wxString & group, const wxString & key, bool & value, bool defval) = 0;
|
|
virtual bool GetPrivateConfig(const wxString & group, const wxString & key, float & value, float defval) = 0;
|
|
virtual bool GetPrivateConfig(const wxString & group, const wxString & key, double & value, double defval) = 0;
|
|
|
|
virtual bool SetPrivateConfig(const wxString & group, const wxString & key, const wxString & value) = 0;
|
|
virtual bool SetPrivateConfig(const wxString & group, const wxString & key, const int & value) = 0;
|
|
virtual bool SetPrivateConfig(const wxString & group, const wxString & key, const bool & value) = 0;
|
|
virtual bool SetPrivateConfig(const wxString & group, const wxString & key, const float & value) = 0;
|
|
virtual bool SetPrivateConfig(const wxString & group, const wxString & key, const double & value) = 0;
|
|
|
|
virtual bool RemovePrivateConfigSubgroup(const wxString & group) = 0;
|
|
virtual bool RemovePrivateConfig(const wxString & group, const wxString & key) = 0;
|
|
};
|
|
|
|
#if 0
|
|
/*************************************************************************************//**
|
|
|
|
\class ConfigHostInterface
|
|
|
|
\brief ConfigHostInterface appears not to be used.
|
|
|
|
*******************************************************************************************/
|
|
class ConfigHostInterface
|
|
{
|
|
public:
|
|
virtual ~ConfigHostInterface() {};
|
|
|
|
};
|
|
#endif
|
|
|
|
#endif // __AUDACITY_CONFIGINTERFACE_H__
|