DtmfSettings Struct Reference

#include <DtmfGen.h>

Public Member Functions
void	Recalculate (EffectSettings &settings)

Public Attributes
wxString	dtmfSequence {DefaultSequence}
size_t	dtmfNTones = dtmfSequence.length()
double	dtmfTone {}
double	dtmfSilence {}
double	dtmfDutyCycle {DefaultDutyCycle}
double	dtmfAmplitude {DefaultAmplitude}

Static Public Attributes
static constexpr wchar_t	DefaultSequence [] = L"audacity"
static constexpr double	DefaultDutyCycle = 55.0
static constexpr double	DefaultAmplitude = 0.8

Detailed Description

Definition at line 26 of file DtmfGen.h.

Member Function Documentation

Recalculate()

void DtmfSettings::Recalculate

(

EffectSettings &

settings

)

Definition at line 471 of file DtmfGen.cpp.

{
   auto &extra = settings.extra;
   // remember that dtmfDutyCycle is in range (0.0-100.0)
 
   dtmfNTones = dtmfSequence.length();
 
   if (dtmfNTones==0) {
      // no tones, all zero: don't do anything
      // this should take care of the case where user got an empty
      // dtmf sequence into the generator: track won't be generated
      extra.SetDuration(0.0);
      dtmfTone = 0;
      dtmfSilence = 0;
   } else {
      if (dtmfNTones==1) {
        // single tone, as long as the sequence
          dtmfTone = extra.GetDuration();
          dtmfSilence = 0;
      } else {
         // Don't be fooled by the fact that you divide the sequence into dtmfNTones:
         // the last slot will only contain a tone, not ending with silence.
         // Given this, the right thing to do is to divide the sequence duration
         // by dtmfNTones tones and (dtmfNTones-1) silences each sized according to the duty
         // cycle: original division was:
         // slot=mDuration / (dtmfNTones*(dtmfDutyCycle/DutyCycle.max)+(dtmfNTones-1)*(1.0-dtmfDutyCycle/DutyCycle.max))
         // which can be simplified in the one below.
         // Then just take the part that belongs to tone or silence.
         //
         double slot = extra.GetDuration()
            / ((double)dtmfNTones + (dtmfDutyCycle / 100.0) - 1);
         dtmfTone = slot * (dtmfDutyCycle / 100.0); // seconds
         dtmfSilence = slot * (1.0 - (dtmfDutyCycle / 100.0)); // seconds
 
         // Note that in the extremes we have:
         // - dutyCycle=100%, this means no silence, so each tone will measure mDuration/dtmfNTones
         // - dutyCycle=0%, this means no tones, so each silence slot will measure mDuration/(NTones-1)
         // But we always count:
         // - dtmfNTones tones
         // - dtmfNTones-1 silences
      }
   }
 
   // `this` is the settings copy in the validator
   // Update the EffectSettings held by the dialog
   EffectDtmf::GetSettings(settings) = *this;
}

References EffectWithSettings< DtmfSettings, PerTrackEffect >::GetSettings(), and settings().

Here is the call graph for this function:

Member Data Documentation

DefaultAmplitude

constexpr double DtmfSettings::DefaultAmplitude = 0.8

staticconstexpr

Definition at line 29 of file DtmfGen.h.

DefaultDutyCycle

constexpr double DtmfSettings::DefaultDutyCycle = 55.0

staticconstexpr

Definition at line 28 of file DtmfGen.h.

DefaultSequence

constexpr wchar_t DtmfSettings::DefaultSequence[] = L"audacity"

staticconstexpr

Definition at line 27 of file DtmfGen.h.

dtmfAmplitude

double DtmfSettings::dtmfAmplitude {DefaultAmplitude}

Definition at line 36 of file DtmfGen.h.

dtmfDutyCycle

double DtmfSettings::dtmfDutyCycle {DefaultDutyCycle}

Definition at line 35 of file DtmfGen.h.

dtmfNTones

size_t DtmfSettings::dtmfNTones = dtmfSequence.length()

Definition at line 32 of file DtmfGen.h.

dtmfSequence

wxString DtmfSettings::dtmfSequence {DefaultSequence}

Definition at line 31 of file DtmfGen.h.

dtmfSilence

double DtmfSettings::dtmfSilence {}

Definition at line 34 of file DtmfGen.h.

dtmfTone

double DtmfSettings::dtmfTone {}

Definition at line 33 of file DtmfGen.h.

---

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

• DtmfGen.h
• DtmfGen.cpp