#include <DtmfBase.h>

Inheritance diagram for DtmfBase:

Collaboration diagram for DtmfBase:

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

Public Member Functions
	DtmfBase ()

virtual	~DtmfBase ()

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...

std::shared_ptr< EffectInstance >	MakeInstance () 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

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 EffectParameterMethods &	Parameters () const

bool	CanExportPresets () const override
	Whether the effect supports export of presets to files, and importing too. More...

bool	HasOptions () const override

const EffectSettingsManager &	GetDefinition () 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
EffectPlugin &	operator= (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 EffectSettingsManager &	GetDefinition () 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< EffectInstance >	MakeInstance () 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 std::unique_ptr< EffectOutputs >	MakeOutputs () 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

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("DTMF Tones") }

static constexpr std::array< char, 6 *7 >	kSymbols

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
const EffectParameterMethods &	Parameters () const override

Protected Member Functions inherited from PerTrackEffect
bool	DoPass1 () const

bool	DoPass2 () const

bool	Process (EffectInstance &instance, EffectSettings &settings) const

std::shared_ptr< EffectOutputTracks >	MakeOutputTracks ()

void	DestroyOutputTracks () const

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 TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Static Protected Attributes
static constexpr EffectParameter	Sequence

static constexpr EffectParameter	DutyCycle

static constexpr EffectParameter	Amplitude

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

Additional Inherited Members
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...

Static Public Member Functions inherited from EffectWithSettings< DtmfSettings, PerTrackEffect >
static DtmfSettings &	GetSettings (EffectSettings &settings)
	Assume settings originated from MakeSettings() and copies thereof. More...

static const DtmfSettings &	GetSettings (const EffectSettings &settings)
	Assume settings originated from MakeSettings() and copies thereof. More...

static DtmfSettings *	FetchParameters (PerTrackEffect &, EffectSettings &s)

Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (Effect &e, EffectSettings &)

Static Public Member Functions inherited from EffectBase
static std::optional< InstancePointer >	FindInstance (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...

Public Attributes inherited from EffectBase
std::shared_ptr< TrackList >	mTracks {}

int	mNumTracks {}

BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

double	mT0 {}

double	mT1 {}

bool	mIsPreview { false }

Protected Attributes inherited from PerTrackEffect
sampleCount	mSampleCnt {}

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Detailed Description

Definition at line 28 of file DtmfBase.h.

Constructor & Destructor Documentation

◆ DtmfBase()

DtmfBase::DtmfBase ( )

Definition at line 27 of file DtmfBase.cpp.

28{

29}

◆ ~DtmfBase()

DtmfBase::~DtmfBase ( )

virtual

Definition at line 31 of file DtmfBase.cpp.

32{

33}

Member Function Documentation

◆ GetDescription()

TranslatableString DtmfBase::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 61 of file DtmfBase.cpp.

{
   return XO(
      "Generates dual-tone multi-frequency (DTMF) tones like those produced by the keypad on telephones");
}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol DtmfBase::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 56 of file DtmfBase.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType DtmfBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 74 of file DtmfBase.cpp.

{
   return EffectTypeGenerate;
}

References EffectTypeGenerate.

◆ MakeDtmfTone()

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

staticprivate

Definition at line 282 of file DtmfBase.cpp.

{
   /*
     --------------------------------------------
                 1209 Hz 1336 Hz 1477 Hz 1633 Hz
 
                             ABC     DEF
      697 Hz          1       2       3       A
 
                     GHI     JKL     MNO
      770 Hz          4       5       6       B
 
                     PQRS     TUV     WXYZ
      852 Hz          7       8       9       C
 
                             oper
      941 Hz          *       0       #       D
     --------------------------------------------
     Essentially we need to generate two sin with
     frequencies according to this table, and sum
     them up.
     sin wave is generated by:
      s(n)=sin(2*pi*n*f/fs)
 
     We will precalculate:
        A= 2*pi*f1/fs
        B= 2*pi*f2/fs
 
     And use two switch statements to select the frequency
 
     Note: added support for letters, like those on the keypad
           This support is only for lowercase letters: uppercase
           are still considered to be the 'military'/carrier extra
           tones.
   */
 
   float f1, f2 = 0.0;
   double A, B;
 
   // select low tone: left column
   switch (tone)
   {
   case '1':
   case '2':
   case '3':
   case 'A':
   case 'a':
   case 'b':
   case 'c':
   case 'd':
   case 'e':
   case 'f':
      f1 = 697;
      break;
   case '4':
   case '5':
   case '6':
   case 'B':
   case 'g':
   case 'h':
   case 'i':
   case 'j':
   case 'k':
   case 'l':
   case 'm':
   case 'n':
   case 'o':
      f1 = 770;
      break;
   case '7':
   case '8':
   case '9':
   case 'C':
   case 'p':
   case 'q':
   case 'r':
   case 's':
   case 't':
   case 'u':
   case 'v':
   case 'w':
   case 'x':
   case 'y':
   case 'z':
      f1 = 852;
      break;
   case '*':
   case '0':
   case '#':
   case 'D':
      f1 = 941;
      break;
   default:
      f1 = 0;
   }
 
   // select high tone: top row
   switch (tone)
   {
   case '1':
   case '4':
   case '7':
   case '*':
   case 'g':
   case 'h':
   case 'i':
   case 'p':
   case 'q':
   case 'r':
   case 's':
      f2 = 1209;
      break;
   case '2':
   case '5':
   case '8':
   case '0':
   case 'a':
   case 'b':
   case 'c':
   case 'j':
   case 'k':
   case 'l':
   case 't':
   case 'u':
   case 'v':
      f2 = 1336;
      break;
   case '3':
   case '6':
   case '9':
   case '#':
   case 'd':
   case 'e':
   case 'f':
   case 'm':
   case 'n':
   case 'o':
   case 'w':
   case 'x':
   case 'y':
   case 'z':
      f2 = 1477;
      break;
   case 'A':
   case 'B':
   case 'C':
   case 'D':
      f2 = 1633;
      break;
   default:
      f2 = 0;
   }
 
   // precalculations
   A = B = 2 * M_PI / fs;
   A *= f1;
   B *= f2;
 
   // now generate the wave: 'last' is used to avoid phase errors
   // when inside the inner for loop of the Process() function.
   for (decltype(len) i = 0; i < len; i++)
   {
      buffer[i] =
         amplitude * 0.5 *
         (sin(A * (i + last).as_double()) + sin(B * (i + last).as_double()));
   }
 
   // generate a fade-in of duration 1/250th of second
   if (last == 0)
   {
      A = std::min<double>(len, (fs / kFadeInOut));
      for (size_t i = 0; i < A; i++)
      {
         buffer[i] *= i / A;
      }
   }
 
   // generate a fade-out of duration 1/250th of second
   if (last >= total - len)
   {
      // we are at the last buffer of 'len' size, so, offset is to
      // backup 'A' samples, from 'len'
      A = std::min<double>(len, (fs / kFadeInOut));
      size_t offset = len - A;
      wxASSERT(offset >= 0);
      for (size_t i = 0; i < A; i++)
      {
         buffer[i + offset] *= (1 - (i / A));
      }
   }
   return true;
}

References A, kFadeInOut, and M_PI.

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

Here is the caller graph for this function:

◆ MakeInstance()

std::shared_ptr< EffectInstance > DtmfBase::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

settings may 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 477 of file DtmfBase.cpp.

{
   // TODO: don't use Effect::mT0 and Effect::mSampleRate, but use an
   // EffectContext (that class is not yet defined)
   return std::make_shared<Instance>(*this, mT0);
}

References EffectBase::mT0.

◆ ManualPage()

ManualPageID DtmfBase::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 67 of file DtmfBase.cpp.

{
   return L"DTMF_Tones";
}

◆ Parameters()

const EffectParameterMethods & DtmfBase::Parameters ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 35 of file DtmfBase.cpp.

{
   static CapturedParameters<DtmfBase, Sequence, DutyCycle, Amplitude>
      parameters {
         [](DtmfBase&, EffectSettings& es, DtmfSettings& s, bool updating) {
            if (updating)
            {
               if (
                  s.dtmfSequence.find_first_not_of(AllSymbols()) !=
                  wxString::npos)
                  return false;
               s.Recalculate(es);
            }
            return true;
         },
      };
   return parameters;
}

References anonymous_namespace{DtmfBase.cpp}::AllSymbols(), and Tuple::detail::npos().

Here is the call graph for this function:

Member Data Documentation

◆ Amplitude

constexpr EffectParameter DtmfBase::Amplitude

staticconstexprprotected

Initial value:

{ &DtmfSettings::dtmfAmplitude,
                                                L"Amplitude",
                                                DtmfSettings::DefaultAmplitude,
                                                0.001,
                                                1.0,
                                                1 }

Definition at line 117 of file DtmfBase.h.

Referenced by EffectDtmf::Editor::PopulateOrExchange().

◆ DutyCycle

constexpr EffectParameter DtmfBase::DutyCycle

staticconstexprprotected

Initial value:

{ &DtmfSettings::dtmfDutyCycle,
                                                L"Duty Cycle",
                                                DtmfSettings::DefaultDutyCycle,
                                                0.0,
                                                100.0,
                                                10.0 }

Definition at line 111 of file DtmfBase.h.

Referenced by EffectDtmf::Editor::OnDutyCycle(), EffectDtmf::Editor::PopulateOrExchange(), EffectDtmf::Editor::UpdateUI(), and EffectDtmf::Editor::ValidateUI().

◆ kSymbols

constexpr std::array<char, 6 * 7> DtmfBase::kSymbols

staticconstexpr

Initial value:

{
      '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '*', '#', 'A', 'B',
      'C', 'D', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l',
      'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z'
   }

Definition at line 34 of file DtmfBase.h.

Referenced by anonymous_namespace{DtmfBase.cpp}::AllSymbols(), and EffectDtmf::Editor::PopulateOrExchange().

◆ Sequence

constexpr EffectParameter DtmfBase::Sequence

staticconstexprprotected

Initial value:

{ &DtmfSettings::dtmfSequence,
                                               L"Sequence",
                                               DtmfSettings::DefaultSequence,
                                               L"",
                                               L"",
                                               L"" }

Definition at line 105 of file DtmfBase.h.

◆ Symbol

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

static

Definition at line 32 of file DtmfBase.h.

Referenced by GetSymbol().

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

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DtmfBase()

◆ ~DtmfBase()

Member Function Documentation

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ MakeDtmfTone()

◆ MakeInstance()

◆ ManualPage()

◆ Parameters()

Member Data Documentation

◆ Amplitude

◆ DutyCycle

◆ kSymbols

◆ Sequence

◆ Symbol