2010-01-23 19:44:49 +00:00
|
|
|
/**********************************************************************
|
|
|
|
|
2013-06-19 02:25:21 +00:00
|
|
|
Audacity: A Digital Audio Editor
|
|
|
|
Audacity(R) is copyright (c) 1999-2012 Audacity Team.
|
|
|
|
License: GPL v2. See License.txt.
|
2010-01-23 19:44:49 +00:00
|
|
|
|
|
|
|
ChangePitch.h
|
2014-06-03 20:30:19 +00:00
|
|
|
Vaughan Johnson, Dominic Mazzoni, Steve Daulton
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2013-06-19 02:25:21 +00:00
|
|
|
******************************************************************//**
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2013-06-19 02:25:21 +00:00
|
|
|
\file ChangePitch.h
|
2014-06-03 20:30:19 +00:00
|
|
|
\brief Change Pitch effect provides raising or lowering
|
2013-06-19 02:25:21 +00:00
|
|
|
the pitch without changing the tempo.
|
|
|
|
|
|
|
|
*//*******************************************************************/
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2021-05-09 15:16:56 +00:00
|
|
|
|
2010-01-23 19:44:49 +00:00
|
|
|
#if USE_SOUNDTOUCH
|
|
|
|
|
|
|
|
#ifndef __AUDACITY_EFFECT_CHANGEPITCH__
|
|
|
|
#define __AUDACITY_EFFECT_CHANGEPITCH__
|
|
|
|
|
2016-08-13 16:27:55 +00:00
|
|
|
#if USE_SBSMS
|
|
|
|
#include "SBSMSEffect.h"
|
|
|
|
#endif
|
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
#include "SoundTouchEffect.h"
|
|
|
|
|
2018-11-11 21:18:23 +00:00
|
|
|
class wxSlider;
|
2018-11-14 16:07:06 +00:00
|
|
|
class wxChoice;
|
2018-11-11 22:30:55 +00:00
|
|
|
class wxCheckBox;
|
2018-11-11 21:11:18 +00:00
|
|
|
class wxTextCtrl;
|
2018-11-14 20:23:25 +00:00
|
|
|
class wxSpinCtrl;
|
2015-06-18 14:24:36 +00:00
|
|
|
class ShuttleGui;
|
|
|
|
|
2016-02-24 06:06:39 +00:00
|
|
|
class EffectChangePitch final : public EffectSoundTouch
|
2013-06-19 02:25:21 +00:00
|
|
|
{
|
2015-04-17 03:53:42 +00:00
|
|
|
public:
|
2019-01-17 22:33:49 +00:00
|
|
|
static const ComponentInterfaceSymbol Symbol;
|
|
|
|
|
2010-01-23 19:44:49 +00:00
|
|
|
EffectChangePitch();
|
2015-04-17 03:53:42 +00:00
|
|
|
virtual ~EffectChangePitch();
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2018-11-02 15:31:44 +00:00
|
|
|
// ComponentInterface implementation
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2018-11-02 15:31:44 +00:00
|
|
|
ComponentInterfaceSymbol GetSymbol() override;
|
2019-12-08 18:53:48 +00:00
|
|
|
TranslatableString GetDescription() override;
|
2021-06-06 16:18:35 +00:00
|
|
|
ManualPageID ManualPage() override;
|
2010-01-23 19:44:49 +00: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
2018-01-14 18:51:41 +00:00
|
|
|
// EffectDefinitionInterface implementation
|
2014-06-03 20:30:19 +00:00
|
|
|
|
2016-02-24 06:06:47 +00:00
|
|
|
EffectType GetType() override;
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
// EffectClientInterface implementation
|
2010-01-23 19:44:49 +00: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
2018-01-14 18:51:41 +00:00
|
|
|
bool DefineParams( ShuttleParams & S ) override;
|
2018-02-21 14:24:25 +00:00
|
|
|
bool GetAutomationParameters(CommandParameters & parms) override;
|
|
|
|
bool SetAutomationParameters(CommandParameters & parms) override;
|
2016-02-24 06:06:47 +00:00
|
|
|
bool LoadFactoryDefaults() override;
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
// Effect implementation
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2016-02-24 06:06:47 +00:00
|
|
|
bool Init() override;
|
|
|
|
bool Process() override;
|
|
|
|
bool CheckWhetherSkipEffect() override;
|
|
|
|
void PopulateOrExchange(ShuttleGui & S) override;
|
|
|
|
bool TransferDataToWindow() override;
|
|
|
|
bool TransferDataFromWindow() override;
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2013-02-23 04:33:20 +00:00
|
|
|
private:
|
2015-04-17 03:53:42 +00:00
|
|
|
// EffectChangePitch implementation
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
// Deduce m_FromFrequency from the samples at the beginning of
|
|
|
|
// the selection. Then set some other params accordingly.
|
2016-02-24 06:06:47 +00:00
|
|
|
void DeduceFrequencies();
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2013-02-23 04:33:20 +00:00
|
|
|
// calculations
|
2016-02-13 15:43:16 +00:00
|
|
|
void Calc_ToPitch(); // Update m_nToPitch from NEW m_dSemitonesChange.
|
2014-06-03 20:30:19 +00:00
|
|
|
void Calc_ToOctave();
|
2013-06-18 04:35:35 +00:00
|
|
|
void Calc_SemitonesChange_fromPitches();
|
|
|
|
void Calc_SemitonesChange_fromOctaveChange();
|
|
|
|
void Calc_SemitonesChange_fromPercentChange();
|
2013-06-19 02:25:21 +00:00
|
|
|
void Calc_ToFrequency(); // Update m_ToFrequency from m_FromFrequency & m_dPercentChange.
|
2016-02-13 15:43:16 +00:00
|
|
|
void Calc_PercentChange(); // Update m_dPercentChange based on NEW m_dSemitonesChange.
|
2013-02-23 04:33:20 +00:00
|
|
|
|
|
|
|
// handlers
|
2015-04-17 03:53:42 +00:00
|
|
|
void OnChoice_FromPitch(wxCommandEvent & evt);
|
|
|
|
void OnSpin_FromOctave(wxCommandEvent & evt);
|
|
|
|
void OnChoice_ToPitch(wxCommandEvent & evt);
|
|
|
|
void OnSpin_ToOctave(wxCommandEvent & evt);
|
2013-02-23 04:33:20 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
void OnText_SemitonesChange(wxCommandEvent & evt);
|
2013-02-23 04:33:20 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
void OnText_FromFrequency(wxCommandEvent & evt);
|
|
|
|
void OnText_ToFrequency(wxCommandEvent & evt);
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
void OnText_PercentChange(wxCommandEvent & evt);
|
|
|
|
void OnSlider_PercentChange(wxCommandEvent & evt);
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2013-02-23 04:33:20 +00:00
|
|
|
// helper fns for controls
|
2013-05-28 01:50:59 +00:00
|
|
|
void Update_Choice_FromPitch();
|
2013-06-18 04:35:35 +00:00
|
|
|
void Update_Spin_FromOctave();
|
2013-02-23 04:33:20 +00:00
|
|
|
void Update_Choice_ToPitch();
|
2013-06-18 04:35:35 +00:00
|
|
|
void Update_Spin_ToOctave();
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2013-02-23 04:33:20 +00:00
|
|
|
void Update_Text_SemitonesChange();
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2013-06-18 04:35:35 +00:00
|
|
|
void Update_Text_FromFrequency();
|
2013-02-23 04:33:20 +00:00
|
|
|
void Update_Text_ToFrequency();
|
|
|
|
|
2013-06-19 02:25:21 +00:00
|
|
|
void Update_Text_PercentChange(); // Update control per current m_dPercentChange.
|
|
|
|
void Update_Slider_PercentChange(); // Update control per current m_dPercentChange.
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2015-04-17 03:53:42 +00:00
|
|
|
private:
|
2016-08-13 16:27:55 +00:00
|
|
|
bool mUseSBSMS;
|
2015-04-17 03:53:42 +00:00
|
|
|
// effect parameters
|
|
|
|
int m_nFromPitch; // per PitchIndex()
|
|
|
|
int m_nFromOctave; // per PitchOctave()
|
|
|
|
int m_nToPitch; // per PitchIndex()
|
|
|
|
int m_nToOctave; // per PitchOctave()
|
|
|
|
|
|
|
|
double m_FromFrequency; // starting frequency of selection
|
|
|
|
double m_ToFrequency; // target frequency of selection
|
|
|
|
|
|
|
|
double m_dSemitonesChange; // how many semitones to change pitch
|
|
|
|
double m_dStartFrequency; // starting frequency of first 0.2s of selection
|
|
|
|
double m_dPercentChange; // percent change to apply to pitch
|
|
|
|
// Slider is (-100, 200], but textCtrls can set higher.
|
|
|
|
|
2014-06-03 20:30:19 +00:00
|
|
|
bool m_bLoopDetect; // Used to avoid loops in initialization and in event handling.
|
2010-01-23 19:44:49 +00:00
|
|
|
|
|
|
|
// controls
|
2013-02-23 04:33:20 +00:00
|
|
|
wxChoice * m_pChoice_FromPitch;
|
2013-06-18 04:35:35 +00:00
|
|
|
wxSpinCtrl * m_pSpin_FromOctave;
|
2013-02-23 04:33:20 +00:00
|
|
|
wxChoice * m_pChoice_ToPitch;
|
2013-06-18 04:35:35 +00:00
|
|
|
wxSpinCtrl * m_pSpin_ToOctave;
|
2013-02-23 04:33:20 +00:00
|
|
|
wxTextCtrl * m_pTextCtrl_SemitonesChange;
|
|
|
|
|
|
|
|
wxTextCtrl * m_pTextCtrl_FromFrequency;
|
|
|
|
wxTextCtrl * m_pTextCtrl_ToFrequency;
|
|
|
|
wxTextCtrl * m_pTextCtrl_PercentChange;
|
|
|
|
wxSlider * m_pSlider_PercentChange;
|
2010-01-23 19:44:49 +00:00
|
|
|
|
2016-08-13 16:27:55 +00:00
|
|
|
#if USE_SBSMS
|
|
|
|
wxCheckBox * mUseSBSMSCheckBox;
|
|
|
|
#endif
|
|
|
|
|
2016-09-18 14:26:29 +00:00
|
|
|
DECLARE_EVENT_TABLE()
|
2010-01-23 19:44:49 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // __AUDACITY_EFFECT_CHANGEPITCH__
|
|
|
|
|
|
|
|
#endif // USE_SOUNDTOUCH
|