Audacity 3.2.0
Classes | Public Member Functions | Static Public Attributes | Private Member Functions | Static Private Member Functions | Static Private Attributes | List of all members
EffectDtmf Class Referencefinal

An effect that generates DTMF tones. More...

#include <DtmfGen.h>

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

Classes

struct  Instance
 Temporary state of the computation. More...
 
struct  Validator
 

Public Member Functions

 EffectDtmf ()
 
virtual ~EffectDtmf ()
 
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...
 
unsigned GetAudioOutCount () const override
 How many output buffers to allocate at once. More...
 
std::unique_ptr< EffectUIValidatorPopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
 Add controls to effect panel; always succeeds. More...
 
std::shared_ptr< EffectInstanceMakeInstance () const override
 Make an object maintaining short-term state of an Effect. More...
 
- Public Member Functions inherited from EffectWithSettings< DtmfSettings, PerTrackEffect >
EffectSettings MakeSettings () const override
 
bool CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const override
 
- Public Member Functions inherited from PerTrackEffect
 ~PerTrackEffect () override
 
- 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
 
EffectType GetType () const override
 Type determines how it behaves. More...
 
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...
 
bool LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override
 Change settings to a user-named preset. More...
 
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...
 
bool LoadFactoryPreset (int id, EffectSettings &settings) const override
 Change settings to the preset whose name is GetFactoryPresets()[id] More...
 
bool LoadFactoryDefaults (EffectSettings &settings) const override
 Change settings back to "factory default". More...
 
unsigned GetAudioInCount () const override
 How many input buffers to allocate at once. More...
 
unsigned GetAudioOutCount () const override
 How many output buffers to allocate at once. More...
 
virtual const EffectParameterMethodsParameters () const
 
int ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false) override
 
std::unique_ptr< EffectUIValidatorPopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access) override
 Adds controls to a panel that is given as the parent window of S More...
 
bool IsGraphicalUI () override
 
bool ValidateUI (EffectSettings &) override
 
bool CloseUI () override
 
bool CanExportPresets () override
 
void ExportPresets (const EffectSettings &settings) const override
 
void ImportPresets (EffectSettings &settings) override
 
bool HasOptions () override
 
void ShowOptions () override
 
const EffectSettingsManagerGetDefinition () const override
 
virtual NumericFormatSymbol GetSelectionFormat ()
 
int ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false) override
 Usually applies factory to self and given access. More...
 
bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override
 
bool LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override
 
bool IsBatchProcessing () const override
 
void SetBatchProcessing () override
 
void UnsetBatchProcessing () override
 
bool TransferDataToWindow (const EffectSettings &settings) override
 Update controls for the settings. More...
 
bool TransferDataFromWindow (EffectSettings &settings) override
 Update the given settings from controls. More...
 
unsigned TestUIFlags (unsigned mask)
 
bool Delegate (Effect &delegate, EffectSettings &settings)
 Re-invoke DoEffect on another Effect object that implements the work. More...
 
int MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) const
 
bool EnableApply (bool enable=true)
 
wxWindow * GetUIParent ()
 
- Public Member Functions inherited from EffectBase
 EffectBase ()
 
 ~EffectBase () override
 
- Public Member Functions inherited from EffectUIClientInterface
virtual ~EffectUIClientInterface ()
 
virtual int ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false)=0
 
virtual bool IsGraphicalUI ()=0
 
virtual std::unique_ptr< EffectUIValidatorPopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)=0
 Adds controls to a panel that is given as the parent window of S More...
 
virtual bool CanExportPresets ()=0
 
virtual void ExportPresets (const EffectSettings &settings) const =0
 
virtual void ImportPresets (EffectSettings &settings)=0
 
virtual bool HasOptions ()=0
 
virtual void ShowOptions ()=0
 
- Public Member Functions inherited from EffectPlugin
EffectPluginoperator= (EffectPlugin &)=delete
 
virtual ~EffectPlugin ()
 
virtual const EffectSettingsManagerGetDefinition () const =0
 
virtual int ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)=0
 Usually applies factory to self and given access. More...
 
virtual void Preview (EffectSettingsAccess &access, bool dryOnly)=0
 
virtual bool SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0
 
virtual bool 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, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={}, const EffectSettingsAccessPtr &pAccess=nullptr)=0
 Unfortunately complicated dual-use function. More...
 
virtual bool TransferDataToWindow (const EffectSettings &settings)=0
 Update controls for the settings. More...
 
virtual bool TransferDataFromWindow (EffectSettings &settings)=0
 Update the given settings from controls. More...
 
- 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...
 
virtual unsigned GetAudioInCount () const =0
 How many input buffers to allocate at once. More...
 
virtual unsigned GetAudioOutCount () const =0
 How many output buffers to allocate at once. More...
 
virtual int GetMidiInCount () const
 Function that has not yet found a use. More...
 
virtual int GetMidiOutCount () const
 Function that has not yet found a use. 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
 
- 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
 

Static Public Attributes

static const ComponentInterfaceSymbol Symbol { XO("DTMF Tones") }
 
- 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>")
 

Private Member Functions

const EffectParameterMethodsParameters () const override
 

Static Private Member Functions

static bool MakeDtmfTone (float *buffer, size_t len, float fs, wxChar tone, sampleCount last, sampleCount total, float amplitude)
 

Static Private Attributes

static constexpr EffectParameter Sequence
 
static constexpr EffectParameter DutyCycle
 
static constexpr EffectParameter Amplitude
 

Additional Inherited Members

- Public Types inherited from Effect
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Public Types inherited from EffectPlugin
using EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >
 
- Public Types inherited from EffectDefinitionInterface
enum class  RealtimeSince : unsigned { Never , Since_3_2 , Always }
 In which versions of Audacity was an effect realtime capable? More...
 
- Static Public Member Functions inherited from EffectWithSettings< DtmfSettings, PerTrackEffect >
static DtmfSettingsGetSettings (EffectSettings &settings)
 Assume settings originated from MakeSettings() and copies thereof. More...
 
static const DtmfSettingsGetSettings (const EffectSettings &settings)
 Assume settings originated from MakeSettings() and copies thereof. More...
 
static DtmfSettingsFetchParameters (PerTrackEffect &, EffectSettings &s)
 
- Static Public Member Functions inherited from Effect
static EffectFetchParameters (Effect &e, EffectSettings &)
 
static void IncEffectCounter ()
 
- Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier GetSquashedName (const Identifier &ident)
 A utility that strips spaces and CamelCases a name. More...
 
- Protected Member Functions inherited from PerTrackEffect
bool DoPass1 () const
 
bool DoPass2 () const
 
bool Process (EffectInstance &instance, EffectSettings &settings) const
 
- Protected Member Functions inherited from Effect
bool EnablePreview (bool enable=true)
 
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...
 
virtual std::unique_ptr< EffectUIValidatorPopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)
 Add controls to effect panel; always succeeds. 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, const WaveTrack *pRight, sampleCount *start, sampleCount *len)
 
void CopyInputTracks (bool allSyncLockSelected=false)
 
std::shared_ptr< AddedAnalysisTrackAddAnalysisTrack (const wxString &name=wxString())
 
ModifiedAnalysisTrack ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())
 
TrackAddToOutputTracks (const std::shared_ptr< Track > &t)
 
- Protected Member Functions inherited from EffectBase
void Preview (EffectSettingsAccess &access, bool dryOnly) override
 
bool DoEffect (EffectSettings &settings, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent, const EffectDialogFactory &dialogFactory, const EffectSettingsAccessPtr &pAccess) override
 Unfortunately complicated dual-use function. More...
 
virtual bool CheckWhetherSkipEffect (const EffectSettings &settings) const =0
 After Init(), tell whether Process() should be skipped. More...
 
virtual double CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0
 
void SetLinearEffectFlag (bool linearEffectFlag)
 
void SetPreviewFullSelectionFlag (bool previewDurationFlag)
 
bool IsPreviewing () const
 
void IncludeNotSelectedPreviewTracks (bool includeNotSelected)
 
void ReplaceProcessedTracks (const bool bGoodResult)
 
const TrackListinputTracks () const
 
const AudacityProjectFindProject () const
 
virtual bool ValidateUI (EffectSettings &settings)=0
 
virtual bool CloseUI ()=0
 
- Protected Attributes inherited from PerTrackEffect
sampleCount mSampleCnt {}
 
- Protected Attributes inherited from Effect
wxWeakRef< wxDialog > mHostUIDialog
 This smart pointer tracks the lifetime of the dialog. More...
 
wxWindow * mUIParent {}
 
- Protected Attributes inherited from EffectBase
BasicUI::ProgressDialogmProgress {}
 
double mProjectRate {}
 
WaveTrackFactorymFactory {}
 
std::shared_ptr< TrackListmOutputTracks
 
double mT0 {}
 
double mT1 {}
 
wxArrayString mPresetNames
 
unsigned mUIFlags { 0 }
 
- Protected Attributes inherited from EffectUIClientInterface
friend EffectUIValidator
 
friend DefaultEffectUIValidator
 
- Static Protected Attributes inherited from EffectBase
static int nEffectsDone = 0
 

Detailed Description

An effect that generates DTMF tones.

Definition at line 41 of file DtmfGen.h.

Constructor & Destructor Documentation

◆ EffectDtmf()

EffectDtmf::EffectDtmf ( )

Definition at line 90 of file DtmfGen.cpp.

91{
92}

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectDtmf()

EffectDtmf::~EffectDtmf ( )
virtual

Definition at line 94 of file DtmfGen.cpp.

95{
96}

Member Function Documentation

◆ GetAudioOutCount()

unsigned EffectDtmf::GetAudioOutCount ( ) const
overridevirtual

How many output buffers to allocate at once.

Implements EffectInstanceFactory.

Definition at line 122 of file DtmfGen.cpp.

123{
124 return 1;
125}

◆ GetDescription()

TranslatableString EffectDtmf::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 105 of file DtmfGen.cpp.

106{
107 return XO("Generates dual-tone multi-frequency (DTMF) tones like those produced by the keypad on telephones");
108}
#define XO(s)
Definition: Internat.h:31

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectDtmf::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 100 of file DtmfGen.cpp.

101{
102 return Symbol;
103}
static const ComponentInterfaceSymbol Symbol
Definition: DtmfGen.h:45

References Symbol.

◆ GetType()

EffectType EffectDtmf::GetType ( ) const
overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 117 of file DtmfGen.cpp.

118{
119 return EffectTypeGenerate;
120}
@ EffectTypeGenerate

References EffectTypeGenerate.

◆ MakeDtmfTone()

bool EffectDtmf::MakeDtmfTone ( float *  buffer,
size_t  len,
float  fs,
wxChar  tone,
sampleCount  last,
sampleCount  total,
float  amplitude 
)
staticprivate

Definition at line 512 of file DtmfGen.cpp.

513{
514/*
515 --------------------------------------------
516 1209 Hz 1336 Hz 1477 Hz 1633 Hz
517
518 ABC DEF
519 697 Hz 1 2 3 A
520
521 GHI JKL MNO
522 770 Hz 4 5 6 B
523
524 PQRS TUV WXYZ
525 852 Hz 7 8 9 C
526
527 oper
528 941 Hz * 0 # D
529 --------------------------------------------
530 Essentially we need to generate two sin with
531 frequencies according to this table, and sum
532 them up.
533 sin wave is generated by:
534 s(n)=sin(2*pi*n*f/fs)
535
536 We will precalculate:
537 A= 2*pi*f1/fs
538 B= 2*pi*f2/fs
539
540 And use two switch statements to select the frequency
541
542 Note: added support for letters, like those on the keypad
543 This support is only for lowercase letters: uppercase
544 are still considered to be the 'military'/carrier extra
545 tones.
546*/
547
548 float f1, f2=0.0;
549 double A,B;
550
551 // select low tone: left column
552 switch (tone) {
553 case '1': case '2': case '3': case 'A':
554 case 'a': case 'b': case 'c':
555 case 'd': case 'e': case 'f':
556 f1=697;
557 break;
558 case '4': case '5': case '6': case 'B':
559 case 'g': case 'h': case 'i':
560 case 'j': case 'k': case 'l':
561 case 'm': case 'n': case 'o':
562 f1=770;
563 break;
564 case '7': case '8': case '9': case 'C':
565 case 'p': case 'q': case 'r': case 's':
566 case 't': case 'u': case 'v':
567 case 'w': case 'x': case 'y': case 'z':
568 f1=852;
569 break;
570 case '*': case '0': case '#': case 'D':
571 f1=941;
572 break;
573 default:
574 f1=0;
575 }
576
577 // select high tone: top row
578 switch (tone) {
579 case '1': case '4': case '7': case '*':
580 case 'g': case 'h': case 'i':
581 case 'p': case 'q': case 'r': case 's':
582 f2=1209;
583 break;
584 case '2': case '5': case '8': case '0':
585 case 'a': case 'b': case 'c':
586 case 'j': case 'k': case 'l':
587 case 't': case 'u': case 'v':
588 f2=1336;
589 break;
590 case '3': case '6': case '9': case '#':
591 case 'd': case 'e': case 'f':
592 case 'm': case 'n': case 'o':
593 case 'w': case 'x': case 'y': case 'z':
594 f2=1477;
595 break;
596 case 'A': case 'B': case 'C': case 'D':
597 f2=1633;
598 break;
599 default:
600 f2=0;
601 }
602
603 // precalculations
604 A=B=2*M_PI/fs;
605 A*=f1;
606 B*=f2;
607
608 // now generate the wave: 'last' is used to avoid phase errors
609 // when inside the inner for loop of the Process() function.
610 for(decltype(len) i = 0; i < len; i++) {
611 buffer[i] = amplitude * 0.5 *
612 (sin( A * (i + last).as_double() ) +
613 sin( B * (i + last).as_double() ));
614 }
615
616 // generate a fade-in of duration 1/250th of second
617 if (last == 0) {
618 A = wxMin(len, (fs / kFadeInOut));
619 for(size_t i = 0; i < A; i++) {
620 buffer[i] *= i/A;
621 }
622 }
623
624 // generate a fade-out of duration 1/250th of second
625 if (last >= total - len) {
626 // we are at the last buffer of 'len' size, so, offset is to
627 // backup 'A' samples, from 'len'
628 A = wxMin(len, (fs / kFadeInOut));
629 size_t offset = len - A;
630 wxASSERT(offset >= 0);
631 for(size_t i = 0; i < A; i++) {
632 buffer[i + offset] *= (1 - (i / A));
633 }
634 }
635 return true;
636}
#define M_PI
Definition: Distortion.cpp:29
static const double kFadeInOut
Definition: DtmfGen.cpp:54
#define A(N)
Definition: ToChars.cpp:62

References A, kFadeInOut, and M_PI.

Referenced by EffectDtmf::Instance::ProcessBlock().

Here is the caller graph for this function:

◆ MakeInstance()

std::shared_ptr< EffectInstance > EffectDtmf::MakeInstance ( ) const
overridevirtual

Make an object maintaining short-term state of an Effect.

One effect may have multiple instances extant simultaneously. Instances have state, may be implemented in foreign code, and are temporary, whereas EffectSettings represents persistent effect state that can be saved and reloaded from files.

Parameters
settingsmay be assumed to have a lifetime enclosing the instance's
Postcondition
true (no promises that the result isn't null)

Implements EffectInstanceFactory.

Definition at line 420 of file DtmfGen.cpp.

421{
422 // TODO: don't use Effect::mT0 and Effect::mSampleRate, but use an
423 // EffectContext (that class is not yet defined)
424 return std::make_shared<Instance>(*this, mT0);
425}
double mT0
Definition: EffectBase.h:106

References EffectBase::mT0.

◆ ManualPage()

ManualPageID EffectDtmf::ManualPage ( ) const
overridevirtual

Name of a page in the Audacity alpha manual, default is empty.

Reimplemented from EffectDefinitionInterface.

Definition at line 110 of file DtmfGen.cpp.

111{
112 return L"DTMF_Tones";
113}

◆ Parameters()

const EffectParameterMethods & EffectDtmf::Parameters ( ) const
overrideprivatevirtual

Reimplemented from Effect.

Definition at line 36 of file DtmfGen.cpp.

37{
40 > parameters{
41 [](EffectDtmf &, EffectSettings &es, DtmfSettings &s, bool updating){
42 if (updating) {
43 if (s.dtmfSequence.find_first_not_of(AllSymbols())
44 != wxString::npos)
45 return false;
46 s.Recalculate(es);
47 }
48 return true;
49 },
50 };
51 return parameters;
52}
Generates EffectParameterMethods overrides from variadic template arguments.
An effect that generates DTMF tones.
Definition: DtmfGen.h:43
EffectDtmf()
Definition: DtmfGen.cpp:90
static constexpr EffectParameter Amplitude
Definition: DtmfGen.h:88
static constexpr EffectParameter Sequence
Definition: DtmfGen.h:84
static constexpr EffectParameter DutyCycle
Definition: DtmfGen.h:86
Externalized state of a plug-in.

References anonymous_namespace{DtmfGen.cpp}::AllSymbols(), Amplitude, DutyCycle, EffectDtmf(), and Sequence.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectUIValidator > EffectDtmf::PopulateOrExchange ( ShuttleGui S,
EffectInstance instance,
EffectSettingsAccess access 
)
overridevirtual

Add controls to effect panel; always succeeds.

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

Reimplemented from Effect.

Definition at line 410 of file DtmfGen.cpp.

412{
413 auto &settings = access.Get();
414 auto &dtmfSettings = GetSettings(settings);
415 auto result = std::make_unique<Validator>(*this, access, dtmfSettings);
416 result->PopulateOrExchange(S, settings, mProjectRate);
417 return result;
418}
#define S(N)
Definition: ToChars.cpp:64
static Settings & settings()
Definition: TrackInfo.cpp:87
double mProjectRate
Definition: EffectBase.h:99
virtual const EffectSettings & Get()=0
static DtmfSettings & GetSettings(EffectSettings &settings)
Assume settings originated from MakeSettings() and copies thereof.
Definition: Effect.h:296

References EffectSettingsAccess::Get(), EffectWithSettings< DtmfSettings, PerTrackEffect >::GetSettings(), EffectBase::mProjectRate, S, and settings().

Here is the call graph for this function:

Member Data Documentation

◆ Amplitude

constexpr EffectParameter EffectDtmf::Amplitude
staticconstexprprivate
Initial value:
L"Amplitude", DtmfSettings::DefaultAmplitude, 0.001, 1.0, 1 }
static constexpr double DefaultAmplitude
Definition: DtmfGen.h:29
double dtmfAmplitude
Definition: DtmfGen.h:36

Definition at line 88 of file DtmfGen.h.

Referenced by Parameters(), and EffectDtmf::Validator::PopulateOrExchange().

◆ DutyCycle

constexpr EffectParameter EffectDtmf::DutyCycle
staticconstexprprivate

◆ Sequence

constexpr EffectParameter EffectDtmf::Sequence
staticconstexprprivate
Initial value:
L"Sequence", DtmfSettings::DefaultSequence, L"", L"", L""}
wxString dtmfSequence
Definition: DtmfGen.h:31
static constexpr wchar_t DefaultSequence[]
Definition: DtmfGen.h:27

Definition at line 84 of file DtmfGen.h.

Referenced by Parameters().

◆ Symbol

const ComponentInterfaceSymbol EffectDtmf::Symbol { XO("DTMF Tones") }
static

Definition at line 45 of file DtmfGen.h.

Referenced by GetSymbol().


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