Audacity 3.2.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
EffectLegacyCompressor Class Referencefinal

#include <LegacyCompressor.h>

Inheritance diagram for EffectLegacyCompressor:
[legend]
Collaboration diagram for EffectLegacyCompressor:
[legend]

Public Member Functions

std::unique_ptr< EffectEditorPopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) override
 Add controls to effect panel; always succeeds. More...
 
bool DoTransferDataFromWindow ()
 
bool TransferDataToWindow (const EffectSettings &settings) override
 
bool TransferDataFromWindow (EffectSettings &settings) override
 
- Public Member Functions inherited from LegacyCompressorBase
 LegacyCompressorBase ()
 
virtual ~LegacyCompressorBase ()
 
ComponentInterfaceSymbol GetSymbol () const override
 
TranslatableString GetDescription () const override
 
ManualPageID ManualPage () const override
 Name of a page in the Audacity alpha manual, default is empty. More...
 
EffectType GetType () const override
 Type determines how it behaves. More...
 
- Public Member Functions inherited from EffectTwoPassSimpleMono
 ~EffectTwoPassSimpleMono () override
 
bool Process (EffectInstance &instance, EffectSettings &settings) override
 
- Public Member Functions inherited from StatefulEffect
 ~StatefulEffect () override
 
std::shared_ptr< EffectInstanceMakeInstance () const override
 Make an object maintaining short-term state of an Effect. More...
 
- Public Member Functions inherited from StatefulEffectBase
virtual bool Init ()
 
virtual bool Process (EffectInstance &instance, EffectSettings &settings)=0
 
virtual bool RealtimeInitialize (EffectSettings &settings, double sampleRate)
 
virtual bool RealtimeAddProcessor (EffectSettings &settings, EffectOutputs *pOutputs, unsigned numChannels, float sampleRate)
 
virtual bool RealtimeSuspend ()
 
virtual bool RealtimeResume ()
 
virtual bool RealtimeProcessStart (MessagePackage &package)
 settings are possibly changed, since last call, by an asynchronous dialog More...
 
virtual size_t RealtimeProcess (size_t group, EffectSettings &settings, const float *const *inBuf, float *const *outBuf, size_t numSamples)
 
virtual bool RealtimeProcessEnd (EffectSettings &settings) noexcept
 settings can be updated to let a dialog change appearance at idle More...
 
virtual bool RealtimeFinalize (EffectSettings &settings) noexcept
 
virtual size_t SetBlockSize (size_t maxBlockSize)
 
virtual size_t GetBlockSize () const
 
virtual unsigned GetAudioInCount () const
 How many input buffers to allocate at once. More...
 
virtual unsigned GetAudioOutCount () const
 How many output buffers to allocate at once. More...
 
virtual sampleCount GetLatency () const
 
virtual bool NeedsDither () const
 
virtual bool ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr)
 
virtual bool ProcessFinalize () noexcept
 
- Public Member Functions inherited from Effect
 Effect ()
 
virtual ~Effect ()
 
PluginPath GetPath () const override
 
bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override
 
bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override
 
ComponentInterfaceSymbol GetSymbol () const override
 
VendorSymbol GetVendor () const override
 
wxString GetVersion () const override
 
TranslatableString GetDescription () const override
 
EffectFamilySymbol GetFamily () const override
 Report identifier and user-visible name of the effect protocol. More...
 
bool IsInteractive () const override
 Whether the effect needs a dialog for entry of settings. More...
 
bool IsDefault () const override
 Whether the effect sorts "above the line" in the menus. More...
 
RealtimeSince RealtimeSupport () const override
 Since which version of Audacity has the effect supported realtime? More...
 
bool SupportsAutomation () const override
 Whether the effect has any automatable controls. More...
 
bool SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
 Store settings as keys and values. More...
 
bool LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
 Restore settings from keys and values. More...
 
OptionalMessage LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
 
bool SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
 Save settings in the configuration file as a user-named preset. More...
 
RegistryPaths GetFactoryPresets () const override
 Report names of factory presets. More...
 
OptionalMessage LoadFactoryPreset (int id, EffectSettings &settings) const override
 
OptionalMessage LoadFactoryDefaults (EffectSettings &settings) const override
 
virtual const EffectParameterMethodsParameters () const
 
bool CanExportPresets () const override
 Whether the effect supports export of presets to files, and importing too. More...
 
bool HasOptions () const override
 
const EffectSettingsManagerGetDefinition () const override
 
virtual NumericFormatID GetSelectionFormat ()
 
bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override
 
OptionalMessage LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override
 
bool IsBatchProcessing () const override
 
void SetBatchProcessing () override
 
void UnsetBatchProcessing () override
 
unsigned TestUIFlags (unsigned mask)
 
bool Delegate (Effect &delegate, EffectSettings &settings, InstanceFinder finder={})
 Re-invoke DoEffect on another Effect object that implements the work. More...
 
- Public Member Functions inherited from EffectBase
 EffectBase ()
 
 ~EffectBase () override
 
bool IsLinearEffect () const
 
bool PreviewsFullSelection () const
 
void SetTracks (TrackList *pTracks)
 
double GetDefaultDuration ()
 
virtual std::any BeginPreview (const EffectSettings &settings)
 Called when Preview() starts, to allow temporary effect state changes. More...
 
bool DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override
 
virtual double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0
 
void CountWaveTracks ()
 
- Public Member Functions inherited from EffectPlugin
EffectPluginoperator= (EffectPlugin &)=delete
 
virtual ~EffectPlugin ()
 
virtual bool HasOptions () const =0
 
virtual bool CanExportPresets () const =0
 Whether the effect supports export of presets to files, and importing too. More...
 
virtual const EffectSettingsManagerGetDefinition () const =0
 
virtual bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0
 
virtual OptionalMessage LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0
 
virtual bool IsBatchProcessing () const =0
 
virtual void SetBatchProcessing ()=0
 
virtual void UnsetBatchProcessing ()=0
 
virtual bool DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess=nullptr)=0
 
- Public Member Functions inherited from EffectInstanceFactory
virtual ~EffectInstanceFactory ()
 
virtual std::shared_ptr< EffectInstanceMakeInstance () const =0
 Make an object maintaining short-term state of an Effect. More...
 
- Public Member Functions inherited from EffectSettingsManager
virtual ~EffectSettingsManager ()
 
virtual bool VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)
 
virtual bool VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const
 
virtual EffectSettings MakeSettings () const
 
virtual bool CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const
 Update one settings object from another. More...
 
virtual std::unique_ptr< EffectOutputsMakeOutputs () const
 Produce an object to hold values to send to effect output meters. More...
 
- Public Member Functions inherited from EffectDefinitionInterface
virtual ~EffectDefinitionInterface ()
 
virtual EffectType GetType () const =0
 Type determines how it behaves. More...
 
virtual EffectType GetClassification () const
 Determines which menu it appears in; default same as GetType(). More...
 
virtual EffectFamilySymbol GetFamily () const =0
 Report identifier and user-visible name of the effect protocol. More...
 
virtual bool IsInteractive () const =0
 Whether the effect needs a dialog for entry of settings. More...
 
virtual bool IsDefault () const =0
 Whether the effect sorts "above the line" in the menus. More...
 
virtual RealtimeSince RealtimeSupport () const =0
 Since which version of Audacity has the effect supported realtime? More...
 
bool SupportsRealtime () const
 
virtual bool SupportsAutomation () const =0
 Whether the effect has any automatable controls. More...
 
virtual bool EnablesDebug () const
 Whether the effect dialog should have a Debug button; default, always false. More...
 
virtual ManualPageID ManualPage () const
 Name of a page in the Audacity alpha manual, default is empty. More...
 
virtual FilePath HelpPage () const
 Fully qualified local help file name, default is empty. More...
 
virtual bool IsHiddenFromMenus () const
 Default is false. More...
 
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
 
virtual PluginPath GetPath () const =0
 
virtual ComponentInterfaceSymbol GetSymbol () const =0
 
virtual VendorSymbol GetVendor () const =0
 
virtual wxString GetVersion () const =0
 
virtual TranslatableString GetDescription () const =0
 
TranslatableString GetName () const
 
- Public Member Functions inherited from StatefulEffectUIServices
 ~StatefulEffectUIServices () override
 
std::unique_ptr< EffectEditorPopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
 Allows PopulateOrExchange to return null. More...
 
virtual std::unique_ptr< EffectEditorPopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)
 Add controls to effect panel; always succeeds. More...
 
virtual bool TransferDataToWindow (const EffectSettings &settings)
 
virtual bool TransferDataFromWindow (EffectSettings &settings)
 
- Public Member Functions inherited from BasicEffectUIServices
int ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override
 
void ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override
 
OptionalMessage ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override
 
void ShowOptions (const EffectPlugin &plugin) const override
 
bool ValidateUI (const EffectPlugin &context, EffectSettings &) const override
 
bool CloseUI () const override
 
- Public Member Functions inherited from EffectUIServices
virtual ~EffectUIServices ()
 
virtual int ShowHostInterface (EffectBase &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)
 
virtual int ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0
 
virtual std::unique_ptr< EffectEditorPopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
 Adds controls to a panel that is given as the parent window of S More...
 
virtual void ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0
 
virtual OptionalMessage ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0
 
virtual void ShowOptions (const EffectPlugin &plugin) const =0
 
virtual bool ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0
 
virtual bool CloseUI () const =0
 

Private Member Functions

void OnSlider (wxCommandEvent &evt)
 
void UpdateUI ()
 

Private Attributes

wxWeakRef< wxWindow > mUIParent {}
 
EffectLegacyCompressorPanelmPanel
 
wxStaticText * mThresholdLabel
 
wxSlider * mThresholdSlider
 
wxStaticText * mThresholdText
 
wxStaticText * mNoiseFloorLabel
 
wxSlider * mNoiseFloorSlider
 
wxStaticText * mNoiseFloorText
 
wxStaticText * mRatioLabel
 
wxSlider * mRatioSlider
 
wxStaticText * mRatioText
 
wxStaticText * mAttackLabel
 
wxSlider * mAttackSlider
 
wxStaticText * mAttackText
 
wxStaticText * mDecayLabel
 
wxSlider * mDecaySlider
 
wxStaticText * mDecayText
 
wxCheckBox * mGainCheckBox
 
wxCheckBox * mPeakCheckBox
 

Additional Inherited Members

- Public Types inherited from StatefulEffectBase
using MessagePackage = EffectInstance::MessagePackage
 
- Public Types inherited from EffectPlugin
using EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
 
using InstancePointer = std::shared_ptr< EffectInstanceEx >
 
using InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) >
 
- Public Types inherited from EffectDefinitionInterface
enum class  RealtimeSince : unsigned { Never , After_3_1 , Always }
 In which versions of Audacity was an effect realtime capable? More...
 
- Public Types inherited from EffectUIServices
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Static Public Member Functions inherited from LegacyCompressorBase
static LegacyCompressorBaseFetchParameters (LegacyCompressorBase &e, EffectSettings &)
 
- Static Public Member Functions inherited from Effect
static EffectFetchParameters (Effect &e, EffectSettings &)
 
- Static Public Member Functions inherited from EffectBase
static std::optional< InstancePointerFindInstance (EffectPlugin &plugin)
 
static InstanceFinder DefaultInstanceFinder (EffectPlugin &plugin)
 
- Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier GetSquashedName (const Identifier &ident)
 A utility that strips spaces and CamelCases a name. More...
 
- Static Public Member Functions inherited from EffectUIServices
static int DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
 
- Public Attributes inherited from EffectBase
std::shared_ptr< TrackListmTracks {}
 
int mNumTracks {}
 
BasicUI::ProgressDialogmProgress {}
 
double mProjectRate {}
 
WaveTrackFactorymFactory {}
 
double mT0 {}
 
double mT1 {}
 
bool mIsPreview { false }
 
- Static Public Attributes inherited from LegacyCompressorBase
static const ComponentInterfaceSymbol Symbol
 
- Static Public Attributes inherited from EffectPlugin
static const wxString kUserPresetIdent = wxT("User Preset:")
 
static const wxString kFactoryPresetIdent = wxT("Factory Preset:")
 
static const wxString kCurrentSettingsIdent = wxT("<Current Settings>")
 
static const wxString kFactoryDefaultsIdent = wxT("<Factory Defaults>")
 
- Protected Member Functions inherited from LegacyCompressorBase
bool InitPass1 () override
 
bool InitPass2 () override
 
bool NewTrackPass1 () override
 
bool ProcessPass2 (float *buffer, size_t len) override
 
bool TwoBufferProcessPass1 (float *buffer1, size_t len1, float *buffer2, size_t len2) override
 
const EffectParameterMethodsParameters () const override
 
- Protected Member Functions inherited from EffectTwoPassSimpleMono
virtual bool InitPass1 ()
 
virtual bool InitPass2 ()
 
virtual bool NewTrackPass1 ()
 
virtual bool NewTrackPass2 ()
 
virtual bool ProcessPass1 (float *WXUNUSED(buffer), size_t WXUNUSED(len))
 Override this method to actually process audio. More...
 
virtual bool ProcessPass2 (float *WXUNUSED(buffer), size_t WXUNUSED(len))
 
virtual bool TwoBufferProcessPass1 (float *buffer1, size_t len1, float *buffer2, size_t len2)
 
virtual bool TwoBufferProcessPass2 (float *buffer1, size_t len1, float *buffer2, size_t len2)
 
void DisableSecondPass ()
 Call this if you know in advance that no second pass will be needed. More...
 
- Protected Member Functions inherited from Effect
bool CheckWhetherSkipEffect (const EffectSettings &settings) const override
 Default implementation returns false. More...
 
double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
 Default implementation returns previewLength More...
 
bool TotalProgress (double frac, const TranslatableString &={}) const
 
bool TrackProgress (int whichTrack, double frac, const TranslatableString &={}) const
 
bool TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={}) const
 
int GetNumWaveTracks () const
 
int GetNumWaveGroups () const
 
void GetBounds (const WaveTrack &track, sampleCount *start, sampleCount *len)
 
- Protected Member Functions inherited from EffectBase
virtual bool CheckWhetherSkipEffect (const EffectSettings &settings) const =0
 After Init(), tell whether Process() should be skipped. More...
 
void SetLinearEffectFlag (bool linearEffectFlag)
 
void SetPreviewFullSelectionFlag (bool previewDurationFlag)
 
bool IsPreviewing () const
 
const TrackListinputTracks () const
 
const AudacityProjectFindProject () const
 
- Protected Attributes inherited from LegacyCompressorBase
double mRMSSum
 
size_t mCircleSize
 
size_t mCirclePos
 
Doubles mCircle
 
double mAttackTime
 
double mThresholdDB
 
double mNoiseFloorDB
 
double mRatio
 
bool mNormalize
 
bool mUsePeak
 
double mDecayTime
 
double mAttackFactor
 
double mAttackInverseFactor
 
double mDecayFactor
 
double mThreshold
 
double mCompression
 
double mNoiseFloor
 
int mNoiseCounter
 
double mGain
 
double mLastLevel
 
Floats mFollow1
 
Floats mFollow2
 
size_t mFollowLen
 
double mMax
 
- Protected Attributes inherited from EffectTwoPassSimpleMono
int mCurTrackNum
 
double mCurRate
 
double mCurT0
 
double mCurT1
 
int mPass
 
bool mSecondPassDisabled
 
std::shared_ptr< TrackListmWorkTracks
 
TrackListmTrackLists [2]
 
- Protected Attributes inherited from EffectBase
double mF0 {}
 
double mF1 {}
 
wxArrayString mPresetNames
 
unsigned mUIFlags { 0 }
 
- Static Protected Attributes inherited from LegacyCompressorBase
static constexpr EffectParameter Threshold
 
static constexpr EffectParameter NoiseFloor
 
static constexpr EffectParameter Ratio
 
static constexpr EffectParameter AttackTime
 
static constexpr EffectParameter ReleaseTime
 
static constexpr EffectParameter Normalize
 
static constexpr EffectParameter UsePeak
 

Detailed Description

Definition at line 24 of file LegacyCompressor.h.

Member Function Documentation

◆ DoTransferDataFromWindow()

bool EffectLegacyCompressor::DoTransferDataFromWindow ( )

Definition at line 234 of file LegacyCompressor.cpp.

235{
236 // To do: eliminate this by using control validators instead
237 mThresholdDB = (double) mThresholdSlider->GetValue();
238 mNoiseFloorDB = (double) mNoiseFloorSlider->GetValue() / NoiseFloor.scale;
239 mRatio = (double) mRatioSlider->GetValue() / Ratio.scale;
240 mAttackTime = (double) mAttackSlider->GetValue() / 100.0; //AttackTime.scale;
241 mDecayTime = (double) mDecaySlider->GetValue() / ReleaseTime.scale;
242 mNormalize = mGainCheckBox->GetValue();
243 mUsePeak = mPeakCheckBox->GetValue();
244
245 return true;
246}
static constexpr EffectParameter ReleaseTime
static constexpr EffectParameter Ratio
static constexpr EffectParameter NoiseFloor
const Type scale
Scaling factor, for slider control.

References mAttackSlider, LegacyCompressorBase::mAttackTime, mDecaySlider, LegacyCompressorBase::mDecayTime, mGainCheckBox, LegacyCompressorBase::mNoiseFloorDB, mNoiseFloorSlider, LegacyCompressorBase::mNormalize, mPeakCheckBox, LegacyCompressorBase::mRatio, mRatioSlider, LegacyCompressorBase::mThresholdDB, mThresholdSlider, LegacyCompressorBase::mUsePeak, LegacyCompressorBase::NoiseFloor, LegacyCompressorBase::Ratio, LegacyCompressorBase::ReleaseTime, and EffectParameter< Structure, Member, Type, Value >::scale.

Referenced by OnSlider(), and TransferDataFromWindow().

Here is the caller graph for this function:

◆ OnSlider()

void EffectLegacyCompressor::OnSlider ( wxCommandEvent &  evt)
private

Definition at line 248 of file LegacyCompressor.cpp.

References DoTransferDataFromWindow(), and UpdateUI().

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > EffectLegacyCompressor::PopulateOrExchange ( ShuttleGui S,
EffectInstance instance,
EffectSettingsAccess access,
const EffectOutputs pOutputs 
)
overridevirtual

Add controls to effect panel; always succeeds.

Returns
if not null, then return it from PopulateUI instead of a DefaultEffectEditor; default implementation returns null

Reimplemented from StatefulEffectUIServices.

Definition at line 92 of file LegacyCompressor.cpp.

94{
95 mUIParent = S.GetParent();
96 S.SetBorder(5);
97
98 S.StartHorizontalLay(wxEXPAND, true);
99 {
100 S.SetBorder(10);
102 S.GetParent(), wxID_ANY, mThresholdDB, mNoiseFloorDB, mRatio);
103 S.Prop(true)
104 .Position(wxEXPAND | wxALL)
105 .MinSize( { 400, 200 } )
106 .AddWindow(mPanel);
107 S.SetBorder(5);
108 }
109 S.EndHorizontalLay();
110
111 S.StartStatic( {} );
112 {
113 S.StartMultiColumn(3, wxEXPAND);
114 {
115 S.SetStretchyCol(1);
116 mThresholdLabel = S.AddVariableText(XO("&Threshold:"), true,
117 wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
119 .Name(XO("Threshold"))
120 .Style(wxSL_HORIZONTAL)
121 .AddSlider( {},
125 mThresholdText = S.AddVariableText(ThresholdFormat(999), true,
126 wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
127
128 mNoiseFloorLabel = S.AddVariableText(XO("&Noise Floor:"), true,
129 wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
131 .Name(XO("Noise Floor"))
132 .Style(wxSL_HORIZONTAL)
133 .AddSlider( {},
137 mNoiseFloorText = S.AddVariableText(ThresholdFormat(999),
138 true, wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
139
140 mRatioLabel = S.AddVariableText(XO("&Ratio:"), true,
141 wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
143 .Name(XO("Ratio"))
144 .Style(wxSL_HORIZONTAL)
145 .AddSlider( {},
148 Ratio.min * Ratio.scale);
149 mRatioSlider->SetPageSize(5);
150 mRatioText = S.AddVariableText(RatioTextFormat( 1, 99.9 ), true,
151 wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
152
153 /* i18n-hint: Particularly in percussion, sounds can be regarded as having
154 * an 'attack' phase where the sound builds up and a 'decay' where the
155 * sound dies away. So this means 'onset duration'. */
156 mAttackLabel = S.AddVariableText(XO("&Attack Time:"), true,
157 wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
159 /* i18n-hint: Particularly in percussion, sounds can be regarded as having
160 * an 'attack' phase where the sound builds up and a 'decay' where the
161 * sound dies away. So this means 'onset duration'. */
162 .Name(XO("Attack Time"))
163 .Style(wxSL_HORIZONTAL)
164 .AddSlider( {},
168 mAttackText = S.AddVariableText(
169 AttackTimeFormat(9.99),
170 true, wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
171
172 /* i18n-hint: Particularly in percussion, sounds can be regarded as having
173 * an 'attack' phase where the sound builds up and a 'decay' or 'release' where the
174 * sound dies away. */
175 mDecayLabel = S.AddVariableText(XO("R&elease Time:"), true,
176 wxALIGN_RIGHT | wxALIGN_CENTER_VERTICAL);
178 /* i18n-hint: Particularly in percussion, sounds can be regarded as having
179 * an 'attack' phase where the sound builds up and a 'decay' or 'release' where the
180 * sound dies away. */
181 .Name(XO("Release Time"))
182 .Style(wxSL_HORIZONTAL)
183 .AddSlider( {},
187
188 mDecayText = S.AddVariableText(
189 DecayTimeFormat(99.9),
190 true, wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL);
191 }
192 S.EndMultiColumn();
193 }
194 S.EndStatic();
195
196 S.StartHorizontalLay(wxCENTER, false);
197 {
198 /* i18n-hint: Make-up, i.e. correct for any reduction, rather than fabricate it.*/
199 mGainCheckBox = S.AddCheckBox(XXO("Ma&ke-up gain for 0 dB after compressing"),
200 Normalize.def);
201 /* i18n-hint: "Compress" here means reduce variations of sound volume,
202 NOT related to file-size compression; Peaks means extremes in volume */
203 mPeakCheckBox = S.AddCheckBox(XXO("C&ompress based on Peaks"),
204 UsePeak.def);
205 }
206 S.EndHorizontalLay();
207 return nullptr;
208}
XO("Cut/Copy/Paste")
XXO("&Cut/Copy/Paste Toolbar")
@ ID_Ratio
@ ID_Threshold
@ ID_Attack
@ ID_NoiseFloor
@ ID_Decay
#define safenew
Definition: MemoryX.h:10
#define S(N)
Definition: ToChars.cpp:64
wxStaticText * mRatioLabel
wxWeakRef< wxWindow > mUIParent
wxStaticText * mRatioText
wxStaticText * mNoiseFloorText
wxStaticText * mAttackLabel
wxStaticText * mDecayLabel
wxStaticText * mThresholdText
wxStaticText * mNoiseFloorLabel
wxStaticText * mAttackText
wxStaticText * mThresholdLabel
EffectLegacyCompressorPanel * mPanel
wxStaticText * mDecayText
static constexpr EffectParameter Normalize
static constexpr EffectParameter AttackTime
static constexpr EffectParameter UsePeak
static constexpr EffectParameter Threshold
TranslatableString AttackTimeFormat(double value)
TranslatableString DecayTimeFormat(double value)
TranslatableString RatioTextFormat(int sliderValue, double value)
TranslatableString ThresholdFormat(int value)
const Type def
Default value.
const Type min
Minimum value.
const Type max
Maximum value.

References LegacyCompressorBase::AttackTime, anonymous_namespace{LegacyCompressor.cpp}::AttackTimeFormat(), anonymous_namespace{LegacyCompressor.cpp}::DecayTimeFormat(), EffectParameter< Structure, Member, Type, Value >::def, ID_Attack, ID_Decay, ID_NoiseFloor, ID_Ratio, ID_Threshold, mAttackLabel, mAttackSlider, mAttackText, EffectParameter< Structure, Member, Type, Value >::max, mDecayLabel, mDecaySlider, mDecayText, mGainCheckBox, EffectParameter< Structure, Member, Type, Value >::min, LegacyCompressorBase::mNoiseFloorDB, mNoiseFloorLabel, mNoiseFloorSlider, mNoiseFloorText, mPanel, mPeakCheckBox, LegacyCompressorBase::mRatio, mRatioLabel, mRatioSlider, mRatioText, LegacyCompressorBase::mThresholdDB, mThresholdLabel, mThresholdSlider, mThresholdText, mUIParent, LegacyCompressorBase::NoiseFloor, LegacyCompressorBase::Normalize, LegacyCompressorBase::Ratio, anonymous_namespace{LegacyCompressor.cpp}::RatioTextFormat(), LegacyCompressorBase::ReleaseTime, S, safenew, EffectParameter< Structure, Member, Type, Value >::scale, LegacyCompressorBase::Threshold, anonymous_namespace{LegacyCompressor.cpp}::ThresholdFormat(), LegacyCompressorBase::UsePeak, XO(), and XXO().

Here is the call graph for this function:

◆ TransferDataFromWindow()

bool EffectLegacyCompressor::TransferDataFromWindow ( EffectSettings settings)
overridevirtual

Update the given settings from controls; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 225 of file LegacyCompressor.cpp.

226{
227 if (!mUIParent->Validate())
228 {
229 return false;
230 }
232}

References DoTransferDataFromWindow(), and mUIParent.

Here is the call graph for this function:

◆ TransferDataToWindow()

bool EffectLegacyCompressor::TransferDataToWindow ( const EffectSettings settings)
overridevirtual

◆ UpdateUI()

void EffectLegacyCompressor::UpdateUI ( )
private

Definition at line 254 of file LegacyCompressor.cpp.

255{
256 mThresholdLabel->SetName(wxString::Format(_("Threshold %d dB"), (int) mThresholdDB));
257 mThresholdText->SetLabel(ThresholdFormat((int) mThresholdDB).Translation());
258 mThresholdText->SetName(mThresholdText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
259
260 mNoiseFloorLabel->SetName(wxString::Format(_("Noise Floor %d dB"), (int) mNoiseFloorDB));
261 mNoiseFloorText->SetLabel(ThresholdFormat((int) mNoiseFloorDB).Translation());
262 mNoiseFloorText->SetName(mNoiseFloorText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
263
264 mRatioLabel->SetName(
266 mRatioText->SetLabel(
268 mRatioText->SetName(mRatioText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
269
270 mAttackLabel->SetName(wxString::Format(_("Attack Time %.2f secs"), mAttackTime));
271 mAttackText->SetLabel(AttackTimeFormat(mAttackTime).Translation());
272 mAttackText->SetName(mAttackText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
273
274 mDecayLabel->SetName(wxString::Format(_("Release Time %.1f secs"), mDecayTime));
275 mDecayText->SetLabel(DecayTimeFormat(mDecayTime).Translation());
276 mDecayText->SetName(mDecayText->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
277
278 mPanel->Refresh(false);
279
280 return;
281}
#define _(s)
Definition: Internat.h:73
wxString Translation() const
TranslatableString RatioLabelFormat(int sliderValue, double value)

References _, anonymous_namespace{LegacyCompressor.cpp}::AttackTimeFormat(), anonymous_namespace{LegacyCompressor.cpp}::DecayTimeFormat(), mAttackLabel, mAttackText, LegacyCompressorBase::mAttackTime, mDecayLabel, mDecayText, LegacyCompressorBase::mDecayTime, LegacyCompressorBase::mNoiseFloorDB, mNoiseFloorLabel, mNoiseFloorText, mPanel, LegacyCompressorBase::mRatio, mRatioLabel, mRatioSlider, mRatioText, LegacyCompressorBase::mThresholdDB, mThresholdLabel, mThresholdText, anonymous_namespace{LegacyCompressor.cpp}::RatioLabelFormat(), anonymous_namespace{LegacyCompressor.cpp}::RatioTextFormat(), anonymous_namespace{LegacyCompressor.cpp}::ThresholdFormat(), and TranslatableString::Translation().

Referenced by OnSlider(), and TransferDataToWindow().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ mAttackLabel

wxStaticText* EffectLegacyCompressor::mAttackLabel
private

Definition at line 57 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mAttackSlider

wxSlider* EffectLegacyCompressor::mAttackSlider
private

◆ mAttackText

wxStaticText* EffectLegacyCompressor::mAttackText
private

Definition at line 59 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mDecayLabel

wxStaticText* EffectLegacyCompressor::mDecayLabel
private

Definition at line 61 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mDecaySlider

wxSlider* EffectLegacyCompressor::mDecaySlider
private

◆ mDecayText

wxStaticText* EffectLegacyCompressor::mDecayText
private

Definition at line 63 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mGainCheckBox

wxCheckBox* EffectLegacyCompressor::mGainCheckBox
private

◆ mNoiseFloorLabel

wxStaticText* EffectLegacyCompressor::mNoiseFloorLabel
private

Definition at line 49 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mNoiseFloorSlider

wxSlider* EffectLegacyCompressor::mNoiseFloorSlider
private

◆ mNoiseFloorText

wxStaticText* EffectLegacyCompressor::mNoiseFloorText
private

Definition at line 51 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mPanel

EffectLegacyCompressorPanel* EffectLegacyCompressor::mPanel
private

Definition at line 43 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mPeakCheckBox

wxCheckBox* EffectLegacyCompressor::mPeakCheckBox
private

◆ mRatioLabel

wxStaticText* EffectLegacyCompressor::mRatioLabel
private

Definition at line 53 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mRatioSlider

wxSlider* EffectLegacyCompressor::mRatioSlider
private

◆ mRatioText

wxStaticText* EffectLegacyCompressor::mRatioText
private

Definition at line 55 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mThresholdLabel

wxStaticText* EffectLegacyCompressor::mThresholdLabel
private

Definition at line 45 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mThresholdSlider

wxSlider* EffectLegacyCompressor::mThresholdSlider
private

◆ mThresholdText

wxStaticText* EffectLegacyCompressor::mThresholdText
private

Definition at line 47 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and UpdateUI().

◆ mUIParent

wxWeakRef<wxWindow> EffectLegacyCompressor::mUIParent {}
private

Definition at line 41 of file LegacyCompressor.h.

Referenced by PopulateOrExchange(), and TransferDataFromWindow().


The documentation for this class was generated from the following files: