An Effect that can generate a sine, square or sawtooth wave. An extended mode of EffectToneGen supports 'chirps' where the frequency changes smoothly during the tone. More...

#include <ToneGen.h>

Inheritance diagram for EffectToneGen:

[legend]

Collaboration diagram for EffectToneGen:

[legend]

Public Member Functions
	EffectToneGen (bool isChirp)

virtual	~EffectToneGen ()

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

bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap) override

size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen) override
	Called for destructive effect computation. More...

std::unique_ptr< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) override
	Add controls to effect panel; always succeeds. More...

bool	TransferDataToWindow (const EffectSettings &settings) override
	Update controls for the settings. More...

bool	TransferDataFromWindow (EffectSettings &settings) override
	Update the given settings from controls. More...

Public Member Functions inherited from StatefulPerTrackEffect
std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. More...

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

virtual bool	ProcessInitialize (EffectSettings &settings, double sampleRate, ChannelNames chanMap=nullptr)

virtual bool	ProcessFinalize () noexcept

virtual size_t	ProcessBlock (EffectSettings &settings, const float const inBlock, float const outBlock, size_t blockLen)=0
	Called for destructive effect computation. More...

Public Member Functions inherited from StatefulEffectBase
virtual bool	Init ()
	Call once to set up state for whole list of tracks to be processed. More...

virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0
	Actually do the effect here. More...

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

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

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

int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal) override

EffectUIClientInterface *	GetEffectUIClientInterface () override
	Returns the EffectUIClientInterface instance for this effect. More...

std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) 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

OptionalMessage	ImportPresets (EffectSettings &settings) override

bool	HasOptions () override

void	ShowOptions () override

const EffectSettingsManager &	GetDefinition () 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

OptionalMessage	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

void	SetTracks (TrackList *pTracks)

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

virtual int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal=false)=0

virtual bool	IsGraphicalUI ()=0

virtual std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)=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 OptionalMessage	ImportPresets (EffectSettings &settings)=0

virtual bool	HasOptions ()=0

virtual void	ShowOptions ()=0

virtual bool	ValidateUI (EffectSettings &settings)=0

virtual bool	CloseUI ()=0

Public Member Functions inherited from EffectPlugin
EffectPlugin &	operator= (EffectPlugin &)=delete

virtual	~EffectPlugin ()

virtual const EffectSettingsManager &	GetDefinition () 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 EffectUIClientInterface *	GetEffectUIClientInterface ()=0
	Returns the EffectUIClientInterface instance for this effect. More...

virtual void	Preview (EffectSettingsAccess &access, bool dryOnly)=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, 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< 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 EffectSettings	MakeSettings () const

virtual bool	CopySettingsContents (const EffectSettings &src, EffectSettings &dst) const
	Update one settings object from another. More...

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 Member Functions
static EffectToneGen *	FetchParameters (EffectToneGen &e, EffectSettings &)

Static Public Member Functions inherited from Effect
static Effect *	FetchParameters (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...

Private Types
enum	kWaveforms { kSine , kSquare , kSawtooth , kSquareNoAlias , kTriangle , nWaveforms }

enum	kInterpolations { kLinear , kLogarithmic , nInterpolations }

Private Member Functions
void	OnControlUpdate (wxCommandEvent &evt)

void	PostSet ()

const EffectParameterMethods &	Parameters () const override

Private Attributes
double	mSampleRate {}

const bool	mChirp

sampleCount	mSample

double	mPositionInCycles

int	mWaveform

int	mInterpolation

double	mFrequency0

double	mFrequency1

double	mAmplitude0

double	mAmplitude1

double	mLogFrequency [2]

NumericTextCtrl *	mToneDurationT

Static Private Attributes
static const EnumValueSymbol	kWaveStrings [nWaveforms]

static const EnumValueSymbol	kInterStrings [nInterpolations]

static constexpr EffectParameter	StartFreq

static constexpr EffectParameter	EndFreq

static constexpr EffectParameter	StartAmp

static constexpr EffectParameter	EndAmp

static constexpr EffectParameter	Frequency

static constexpr EffectParameter	Amplitude

static constexpr EnumParameter	Waveform

static constexpr EnumParameter	Interp

Additional Inherited Members
Public Types inherited from StatefulEffectBase
using	MessagePackage = EffectInstance::MessagePackage

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 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 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< EffectUIValidator >	PopulateOrExchange (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs)
	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< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

ModifiedAnalysisTrack	ModifyAnalysisTrack (const LabelTrack *pOrigTrack, const wxString &name=wxString())

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

const AudacityProject *	FindProject () const

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::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

std::shared_ptr< TrackList >	mOutputTracks

double	mT0 {}

double	mT1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes inherited from EffectBase
static int	nEffectsDone = 0

Detailed Description

An Effect that can generate a sine, square or sawtooth wave. An extended mode of EffectToneGen supports 'chirps' where the frequency changes smoothly during the tone.

Definition at line 23 of file ToneGen.h.

Member Enumeration Documentation

◆ kInterpolations

enum EffectToneGen::kInterpolations

private

Enumerator
kLinear
kLogarithmic
nInterpolations

Definition at line 98 of file ToneGen.h.

   {
      kLinear,
      kLogarithmic,
      nInterpolations
   };

◆ kWaveforms

enum EffectToneGen::kWaveforms

private

Enumerator
kSine
kSquare
kSawtooth
kSquareNoAlias
kTriangle
nWaveforms

Definition at line 86 of file ToneGen.h.

   {
      kSine,
      kSquare,
      kSawtooth,
      kSquareNoAlias,
      kTriangle,
      nWaveforms
   };

Constructor & Destructor Documentation

◆ EffectToneGen()

EffectToneGen::EffectToneGen ( bool isChirp )

Definition at line 91 of file ToneGen.cpp.

   : mChirp{ isChirp }
{
   Parameters().Reset(*this);
 
   wxASSERT(nWaveforms == WXSIZEOF(kWaveStrings));
   wxASSERT(nInterpolations == WXSIZEOF(kInterStrings));
 
   // Chirp varies over time so must use selected duration.
   // TODO: When previewing, calculate only the first 'preview length'.
   if (isChirp)
      SetLinearEffectFlag(false);
   else
      SetLinearEffectFlag(true);
}

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectToneGen()

EffectToneGen::~EffectToneGen ( )

virtual

Definition at line 107 of file ToneGen.cpp.

108{

109}

Member Function Documentation

◆ FetchParameters()

static EffectToneGen * EffectToneGen::FetchParameters	(	EffectToneGen &	e,
		EffectSettings &
	)

inlinestatic

Definition at line 27 of file ToneGen.h.

27{ return &e; }

◆ GetAudioOutCount()

unsigned EffectToneGen::GetAudioOutCount ( ) const

overridevirtual

How many output buffers to allocate at once.

The result is not necessarily well defined before RealtimeInitialize Default implementation returns 0

Reimplemented from StatefulEffectBase.

Definition at line 141 of file ToneGen.cpp.

{
   return 1;
}

◆ GetDescription()

TranslatableString EffectToneGen::GetDescription ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 120 of file ToneGen.cpp.

{
   return mChirp
      ? XO("Generates an ascending or descending tone of one of four types")
      : XO("Generates a constant frequency tone of one of four types");
}

References mChirp, and XO.

◆ GetSymbol()

ComponentInterfaceSymbol EffectToneGen::GetSymbol ( ) const

overridevirtual

Reimplemented from Effect.

Definition at line 113 of file ToneGen.cpp.

{
   return mChirp
      ? EffectChirp::Symbol
      : EffectTone::Symbol;
}

References mChirp, EffectChirp::Symbol, and EffectTone::Symbol.

◆ GetType()

EffectType EffectToneGen::GetType ( ) const

overridevirtual

Type determines how it behaves.

Reimplemented from Effect.

Definition at line 136 of file ToneGen.cpp.

{
   return EffectTypeGenerate;
}

References EffectTypeGenerate.

◆ ManualPage()

ManualPageID EffectToneGen::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 127 of file ToneGen.cpp.

{
   return mChirp
      ? L"Chirp"
      : L"Tone";
}

References mChirp.

◆ OnControlUpdate()

void EffectToneGen::OnControlUpdate ( wxCommandEvent & evt )

private

Definition at line 426 of file ToneGen.cpp.

{
   if (!EnableApply(mUIParent->TransferDataFromWindow()))
   {
      return;
   }
}

References Effect::EnableApply(), and Effect::mUIParent.

Here is the call graph for this function:

◆ Parameters()

const EffectParameterMethods & EffectToneGen::Parameters ( ) const

overrideprivatevirtual

Reimplemented from Effect.

Definition at line 53 of file ToneGen.cpp.

{
   static const auto postSet =
   [](EffectToneGen &, EffectSettings &, EffectToneGen &e, bool updating) {
      if (updating)
         e.PostSet();
      return true;
   };
   static CapturedParameters<EffectToneGen,
      StartFreq, EndFreq, StartAmp, EndAmp, Waveform, Interp
   > chirpParameters{ postSet };
   static CapturedParameters<EffectToneGen,
      Frequency, Amplitude, Waveform, Interp
   > toneParameters{ postSet };
   if (mChirp)
      return chirpParameters;
   else
      return toneParameters;
}

References Amplitude, EffectToneGen(), EndAmp, EndFreq, Frequency, Interp, mChirp, StartAmp, StartFreq, and Waveform.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectUIValidator > EffectToneGen::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 Effect::PopulateUI instead of a DefaultEffectUIValidator; default implementation returns null

Reimplemented from Effect.

Definition at line 273 of file ToneGen.cpp.

{
   wxTextCtrl *t;
 
   S.StartMultiColumn(2, wxCENTER);
   {
      S.Validator<wxGenericValidator>(&mWaveform)
         .AddChoice(XXO("&Waveform:"),
            Msgids( kWaveStrings, nWaveforms ) );
 
      if (mChirp)
      {
         S.AddFixedText( {} );
         S.StartHorizontalLay(wxEXPAND);
         {
            S.StartHorizontalLay(wxLEFT, 50);
            {
               S.AddTitle(XO("Start"));
            }
            S.EndHorizontalLay();
 
            S.StartHorizontalLay(wxLEFT, 50);
            {
               S.AddTitle(XO("End"));
            }
            S.EndHorizontalLay();
         }
         S.EndHorizontalLay();
 
         S.AddPrompt(XXO("&Frequency (Hz):"));
         S.StartHorizontalLay(wxEXPAND);
         {
            S.StartHorizontalLay(wxLEFT, 50);
            {
               t = S.Name(XO("Frequency Hertz Start"))
                  .Validator<FloatingPointValidator<double>>(
                     6, &mFrequency0,
                     NumValidatorStyle::NO_TRAILING_ZEROES,
                     StartFreq.min,
                     mProjectRate / 2.0 )
                  .AddTextBox( {}, L"", 12);
            }
            S.EndHorizontalLay();
 
            S.StartHorizontalLay(wxLEFT, 50);
            {
               t = S.Name(XO("Frequency Hertz End"))
                  .Validator<FloatingPointValidator<double>>(
                     6, &mFrequency1,
                     NumValidatorStyle::NO_TRAILING_ZEROES,
                     EndFreq.min,
                     mProjectRate / 2.0 )
                  .AddTextBox( {}, L"", 12);
            }
            S.EndHorizontalLay();
         }
         S.EndHorizontalLay();
 
         S.AddPrompt(XXO("&Amplitude (0-1):"));
         S.StartHorizontalLay(wxEXPAND);
         {
            S.StartHorizontalLay(wxLEFT, 50);
            {
               t = S.Name(XO("Amplitude Start"))
                  .Validator<FloatingPointValidator<double>>(
                     6, &mAmplitude0, NumValidatorStyle::NO_TRAILING_ZEROES,
                     StartAmp.min, StartAmp.max )
                  .AddTextBox( {}, L"", 12);
            }
            S.EndHorizontalLay();
 
            S.StartHorizontalLay(wxLEFT, 50);
            {
               t = S.Name(XO("Amplitude End"))
                  .Validator<FloatingPointValidator<double>>(
                     6, &mAmplitude1, NumValidatorStyle::NO_TRAILING_ZEROES,
                     EndAmp.min, EndAmp.max )
                  .AddTextBox( {}, L"", 12);
            }
            S.EndHorizontalLay();
         }
         S.EndHorizontalLay();
 
         S.Validator<wxGenericValidator>(&mInterpolation)
            .AddChoice(XXO("I&nterpolation:"),
               Msgids( kInterStrings, nInterpolations ) );
      }
      else
      {
         t = S.Validator<FloatingPointValidator<double>>(
               6, &mFrequency0, NumValidatorStyle::NO_TRAILING_ZEROES,
               Frequency.min,
               mProjectRate / 2.0 )
            .AddTextBox(XXO("&Frequency (Hz):"), L"", 12);
 
         t = S.Validator<FloatingPointValidator<double>>(
               6, &mAmplitude0, NumValidatorStyle::NO_TRAILING_ZEROES,
               Amplitude.min, Amplitude.max )
            .AddTextBox(XXO("&Amplitude (0-1):"), L"", 12);
      }
 
      S.AddPrompt(XXO("&Duration:"));
      auto &extra = access.Get().extra;
      mToneDurationT = safenew
         NumericTextCtrl(S.GetParent(), wxID_ANY,
                         NumericConverter::TIME,
                         extra.GetDurationFormat(),
                         extra.GetDuration(),
                         mProjectRate,
                         NumericTextCtrl::Options{}
                            .AutoPos(true));
      S.Name(XO("Duration"))
         .Position(wxALIGN_LEFT | wxALL)
         .AddWindow(mToneDurationT);
   }
   S.EndMultiColumn();
 
   return nullptr;
}

References Amplitude, NumericTextCtrl::Options::AutoPos(), EndAmp, EndFreq, EffectSettings::extra, Frequency, EffectSettingsAccess::Get(), kInterStrings, kWaveStrings, mAmplitude0, mAmplitude1, EffectParameter< Structure, Member, Type, Value >::max, mChirp, mFrequency0, mFrequency1, EffectParameter< Structure, Member, Type, Value >::min, mInterpolation, EffectBase::mProjectRate, Msgids(), mToneDurationT, mWaveform, nInterpolations, nWaveforms, S, safenew, StartAmp, StartFreq, NumericConverter::TIME, XO, and XXO.

Here is the call graph for this function:

◆ PostSet()

void EffectToneGen::PostSet ( )

private

Definition at line 257 of file ToneGen.cpp.

{
   if (!mChirp) {
      mFrequency1 = mFrequency0;
      mAmplitude1 = mAmplitude0;
   }
//   double freqMax =
//      (FindProject()
//         ? ProjectRate::Get( *FindProject() ).GetRate()
//         : 44100.0)
//      / 2.0;
//   mFrequency1 = std::clamp<double>(mFrequency1, EndFreq.min, freqMax);
}

References mAmplitude0, mAmplitude1, mChirp, mFrequency0, and mFrequency1.

◆ ProcessBlock()

size_t EffectToneGen::ProcessBlock	(	EffectSettings &	settings,
		const float const	inBlock,
		float const	outBlock,
		size_t	blockLen
	)

overridevirtual

Called for destructive effect computation.

Implements StatefulPerTrackEffect.

Definition at line 155 of file ToneGen.cpp.

{
   float *buffer = outBlock[0];
   double throwaway = 0;        //passed to modf but never used
   double f = 0.0;
   double a, b;
   int k;
 
   double frequencyQuantum;
   double BlendedFrequency;
   double BlendedAmplitude;
   double BlendedLogFrequency = 0.0;
 
   // calculate delta, and reposition from where we left
   auto doubleSampleCount = mSampleCnt.as_double();
   auto doubleSample = mSample.as_double();
   double amplitudeQuantum =
      (mAmplitude1 - mAmplitude0) / doubleSampleCount;
   BlendedAmplitude = mAmplitude0 +
      amplitudeQuantum * doubleSample;
 
   // precalculations:
   double pre2PI = 2.0 * M_PI;
   double pre4divPI = 4.0 / M_PI;
 
   // initial setup should calculate deltas
   if (mInterpolation == kLogarithmic)
   {
      // this for log interpolation
      mLogFrequency[0] = log10(mFrequency0);
      mLogFrequency[1] = log10(mFrequency1);
      // calculate delta, and reposition from where we left
      frequencyQuantum = (mLogFrequency[1] - mLogFrequency[0]) / doubleSampleCount;
      BlendedLogFrequency = mLogFrequency[0] + frequencyQuantum * doubleSample;
      BlendedFrequency = pow(10.0, BlendedLogFrequency);
   }
   else
   {
      // this for regular case, linear interpolation
      frequencyQuantum = (mFrequency1 - mFrequency0) / doubleSampleCount;
      BlendedFrequency = mFrequency0 + frequencyQuantum * doubleSample;
   }
 
   // synth loop
   for (decltype(blockLen) i = 0; i < blockLen; i++)
   {
      switch (mWaveform)
      {
      case kSine:
         f = sin(pre2PI * mPositionInCycles / mSampleRate);
         break;
      case kSquare:
         f = (modf(mPositionInCycles / mSampleRate, &throwaway) < 0.5) ? 1.0 : -1.0;
         break;
      case kSawtooth:
         f = (2.0 * modf(mPositionInCycles / mSampleRate + 0.5, &throwaway)) - 1.0;
         break;
      case kTriangle:
         f = modf(mPositionInCycles / mSampleRate, &throwaway);
         if(f < 0.25) {
             f *= 4.0;
         } else if(f > 0.75) {
             f = (f - 1.0) * 4.0;
         } else { /* f >= 0.25 || f <= 0.75 */
             f = (0.5 - f) * 4.0;
         }
         break;
      case kSquareNoAlias:    // Good down to 110Hz @ 44100Hz sampling.
         //do fundamental (k=1) outside loop
         b = (1.0 + cos((pre2PI * BlendedFrequency) / mSampleRate)) / pre4divPI;  //scaling
         f = pre4divPI * sin(pre2PI * mPositionInCycles / mSampleRate);
         for (k = 3; (k < 200) && (k * BlendedFrequency < mSampleRate / 2.0); k += 2)
         {
            //Hann Window in freq domain
            a = 1.0 + cos((pre2PI * k * BlendedFrequency) / mSampleRate);
            //calc harmonic, apply window, scale to amplitude of fundamental
            f += a * sin(pre2PI * mPositionInCycles / mSampleRate * k) / (b * k);
         }
      }
      // insert value in buffer
      buffer[i] = (float) (BlendedAmplitude * f);
      // update freq,amplitude
      mPositionInCycles += BlendedFrequency;
      BlendedAmplitude += amplitudeQuantum;
      if (mInterpolation == kLogarithmic)
      {
         BlendedLogFrequency += frequencyQuantum;
         BlendedFrequency = pow(10.0, BlendedLogFrequency);
      }
      else
      {
         BlendedFrequency += frequencyQuantum;
      }
   }
 
   // update external placeholder
   mSample += blockLen;
 
   return blockLen;
}

References sampleCount::as_double(), kLogarithmic, kSawtooth, kSine, kSquare, kSquareNoAlias, kTriangle, M_PI, mAmplitude0, mAmplitude1, mFrequency0, mFrequency1, mInterpolation, mLogFrequency, mPositionInCycles, mSample, PerTrackEffect::mSampleCnt, mSampleRate, and mWaveform.

Here is the call graph for this function:

◆ ProcessInitialize()

bool EffectToneGen::ProcessInitialize	(	EffectSettings &	settings,
		double	sampleRate,
		ChannelNames	chanMap
	)

overridevirtual

Called at start of destructive processing, for each (mono/stereo) track Default implementation does nothing, returns true

Parameters

chanMap null or array terminated with ChannelNameEOL. Do not retain the pointer

Postcondition: GetAudioInCount() and GetAudioOutCount() are well defined

Reimplemented from StatefulPerTrackEffect.

Definition at line 146 of file ToneGen.cpp.

{
   mSampleRate = sampleRate;
   mPositionInCycles = 0.0;
   mSample = 0;
   return true;
}

References mPositionInCycles, mSample, and mSampleRate.

◆ TransferDataFromWindow()

bool EffectToneGen::TransferDataFromWindow ( EffectSettings & settings )

overridevirtual

Update the given settings from controls.

Reimplemented from Effect.

Definition at line 406 of file ToneGen.cpp.

{
   if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
   {
      return false;
   }
 
   if (!mChirp)
   {
      mFrequency1 = mFrequency0;
      mAmplitude1 = mAmplitude0;
   }
 
   settings.extra.SetDuration(mToneDurationT->GetValue());
 
   return true;
}

References NumericConverter::GetValue(), mAmplitude0, mAmplitude1, mChirp, mFrequency0, mFrequency1, mToneDurationT, Effect::mUIParent, and settings().

Here is the call graph for this function:

◆ TransferDataToWindow()

bool EffectToneGen::TransferDataToWindow ( const EffectSettings & settings )

overridevirtual

Update controls for the settings.

Reimplemented from Effect.

Definition at line 395 of file ToneGen.cpp.

{
   if (!mUIParent->TransferDataToWindow())
   {
      return false;
   }
 
   mToneDurationT->SetValue(settings.extra.GetDuration());
   return true;
}

References mToneDurationT, Effect::mUIParent, settings(), and NumericTextCtrl::SetValue().

Here is the call graph for this function:

Member Data Documentation

◆ Amplitude

constexpr EffectParameter EffectToneGen::Amplitude

staticconstexprprivate

Initial value:

{ &EffectToneGen::mAmplitude0,

L"Amplitude", 0.8, 0.0, 1.0, 1 }

Definition at line 118 of file ToneGen.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ EndAmp

constexpr EffectParameter EffectToneGen::EndAmp

staticconstexprprivate

Initial value:

{ &EffectToneGen::mAmplitude1,

L"EndAmp", 0.1, 0.0, 1.0, 1 }

Definition at line 114 of file ToneGen.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ EndFreq

constexpr EffectParameter EffectToneGen::EndFreq

staticconstexprprivate

Initial value:

{ &EffectToneGen::mFrequency1,

L"EndFreq", 1320.0, 1.0, DBL_MAX, 1 }

Definition at line 110 of file ToneGen.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ Frequency

constexpr EffectParameter EffectToneGen::Frequency

staticconstexprprivate

Initial value:

{ &EffectToneGen::mFrequency0,

L"Frequency", 440.0, 1.0, DBL_MAX, 1 }

Definition at line 116 of file ToneGen.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ Interp

constexpr EnumParameter EffectToneGen::Interp

staticconstexprprivate

Initial value:

{ &EffectToneGen::mInterpolation,

L"Interpolation", 0, 0, nInterpolations - 1, 1, kInterStrings, nInterpolations }

Definition at line 122 of file ToneGen.h.

Referenced by Parameters().

◆ kInterStrings

const EnumValueSymbol EffectToneGen::kInterStrings

staticprivate

Initial value:

=
{
   
   { XO("Linear") },
   { XO("Logarithmic") }
}

Definition at line 105 of file ToneGen.h.

Referenced by PopulateOrExchange().

◆ kWaveStrings

const EnumValueSymbol EffectToneGen::kWaveStrings

staticprivate

Initial value:

=
{
   { XO("Sine") },
   { XO("Square") },
   { XO("Sawtooth") },
   { XO("Square, no alias") },
   { XC("Triangle", "waveform") }
}

Definition at line 96 of file ToneGen.h.

Referenced by PopulateOrExchange().

◆ mAmplitude0

double EffectToneGen::mAmplitude0

private

Definition at line 75 of file ToneGen.h.

Referenced by PopulateOrExchange(), PostSet(), ProcessBlock(), and TransferDataFromWindow().

◆ mAmplitude1

double EffectToneGen::mAmplitude1

private

Definition at line 76 of file ToneGen.h.

Referenced by PopulateOrExchange(), PostSet(), ProcessBlock(), and TransferDataFromWindow().

◆ mChirp

const bool EffectToneGen::mChirp

private

Definition at line 62 of file ToneGen.h.

Referenced by GetDescription(), GetSymbol(), ManualPage(), Parameters(), PopulateOrExchange(), PostSet(), and TransferDataFromWindow().

◆ mFrequency0

double EffectToneGen::mFrequency0

private

Definition at line 73 of file ToneGen.h.

Referenced by PopulateOrExchange(), PostSet(), ProcessBlock(), and TransferDataFromWindow().

◆ mFrequency1

double EffectToneGen::mFrequency1

private

Definition at line 74 of file ToneGen.h.

Referenced by PopulateOrExchange(), PostSet(), ProcessBlock(), and TransferDataFromWindow().

◆ mInterpolation

int EffectToneGen::mInterpolation

private

Definition at line 72 of file ToneGen.h.

Referenced by PopulateOrExchange(), and ProcessBlock().

◆ mLogFrequency

double EffectToneGen::mLogFrequency[2]

private

Definition at line 77 of file ToneGen.h.

Referenced by ProcessBlock().

◆ mPositionInCycles

double EffectToneGen::mPositionInCycles

private

Definition at line 67 of file ToneGen.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mSample

sampleCount EffectToneGen::mSample

private

Definition at line 66 of file ToneGen.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mSampleRate

double EffectToneGen::mSampleRate {}

private

Definition at line 61 of file ToneGen.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mToneDurationT

NumericTextCtrl* EffectToneGen::mToneDurationT

private

Definition at line 79 of file ToneGen.h.

Referenced by PopulateOrExchange(), TransferDataFromWindow(), and TransferDataToWindow().

◆ mWaveform

int EffectToneGen::mWaveform

private

Definition at line 71 of file ToneGen.h.

Referenced by PopulateOrExchange(), and ProcessBlock().

◆ StartAmp

constexpr EffectParameter EffectToneGen::StartAmp

staticconstexprprivate

Initial value:

{ &EffectToneGen::mAmplitude0,

L"StartAmp", 0.8, 0.0, 1.0, 1 }

Definition at line 112 of file ToneGen.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ StartFreq

constexpr EffectParameter EffectToneGen::StartFreq

staticconstexprprivate

Initial value:

{ &EffectToneGen::mFrequency0,

L"StartFreq", 440.0, 1.0, DBL_MAX, 1 }

Definition at line 108 of file ToneGen.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ Waveform

constexpr EnumParameter EffectToneGen::Waveform

staticconstexprprivate

Initial value:

{ &EffectToneGen::mWaveform,

L"Waveform", 0, 0, nWaveforms - 1, 1, kWaveStrings, nWaveforms }

Definition at line 120 of file ToneGen.h.

Referenced by Parameters().

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

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ kInterpolations

◆ kWaveforms

Constructor & Destructor Documentation

◆ EffectToneGen()

◆ ~EffectToneGen()

Member Function Documentation

◆ FetchParameters()

◆ GetAudioOutCount()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ ManualPage()

◆ OnControlUpdate()

◆ Parameters()

◆ PopulateOrExchange()

◆ PostSet()

◆ ProcessBlock()

◆ ProcessInitialize()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

Member Data Documentation

◆ Amplitude

◆ EndAmp

◆ EndFreq

◆ Frequency

◆ Interp

◆ kInterStrings

◆ kWaveStrings

◆ mAmplitude0

◆ mAmplitude1

◆ mChirp

◆ mFrequency0

◆ mFrequency1

◆ mInterpolation

◆ mLogFrequency

◆ mPositionInCycles

◆ mSample

◆ mSampleRate

◆ mToneDurationT

◆ mWaveform

◆ StartAmp

◆ StartFreq

◆ Waveform