1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-05-03 17:19:43 +02:00
audacity/src/effects/ToneGen.h
James Crook 1c988b4e3a 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
2018-02-24 14:20:22 -05:00

88 lines
2.1 KiB
C++

/**********************************************************************
Audacity: A Digital Audio Editor
ToneGen.h
Steve Jolly
This class implements a tone generator effect.
**********************************************************************/
#ifndef __AUDACITY_EFFECT_TONEGEN__
#define __AUDACITY_EFFECT_TONEGEN__
#include <wx/arrstr.h>
#include <wx/string.h>
#include "../widgets/NumericTextCtrl.h"
#include "Effect.h"
class ShuttleGui;
#define CHIRP_PLUGIN_SYMBOL XO("Chirp")
#define TONE_PLUGIN_SYMBOL XO("Tone")
class EffectToneGen final : public Effect
{
public:
EffectToneGen(bool isChirp);
virtual ~EffectToneGen();
// IdentInterface implementation
wxString GetSymbol() override;
wxString GetDescription() override;
wxString ManualPage() override;
// EffectDefinitionInterface implementation
EffectType GetType() override;
// EffectClientInterface implementation
unsigned GetAudioOutCount() override;
bool ProcessInitialize(sampleCount totalLen, ChannelNames chanMap = NULL) override;
size_t ProcessBlock(float **inBlock, float **outBlock, size_t blockLen) override;
bool DefineParams( ShuttleParams & S ) override;
bool GetAutomationParameters(CommandAutomationParameters & parms) override;
bool SetAutomationParameters(CommandAutomationParameters & parms) override;
// Effect implementation
void PopulateOrExchange(ShuttleGui & S);
bool TransferDataFromWindow() override;
bool TransferDataToWindow() override;
private:
// EffectToneGen implementation
void OnControlUpdate(wxCommandEvent & evt);
private:
bool mChirp;
// mSample is an external placeholder to remember the last "buffer"
// position so we use it to reinitialize from where we left
sampleCount mSample;
double mPositionInCycles;
// If we made these static variables,
// Tone and Chirp would share the same parameters.
int mWaveform;
int mInterpolation;
double mFrequency[2];
double mAmplitude[2];
double mLogFrequency[2];
wxArrayString mWaveforms;
wxArrayString mInterpolations;
NumericTextCtrl *mToneDurationT;
DECLARE_EVENT_TABLE()
};
#endif