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 () override

TranslatableString	GetDescription () override

ManualPageID	ManualPage () override

EffectType	GetType () override

unsigned	GetAudioOutCount () override

bool	ProcessInitialize (sampleCount totalLen, ChannelNames chanMap=NULL) override

size_t	ProcessBlock (float inBlock, float outBlock, size_t blockLen) override

bool	DefineParams (ShuttleParams &S) override

bool	GetAutomationParameters (CommandParameters &parms) override

bool	SetAutomationParameters (CommandParameters &parms) override

void	PopulateOrExchange (ShuttleGui &S) override

bool	TransferDataFromWindow () override

bool	TransferDataToWindow () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () override

VendorSymbol	GetVendor () override

wxString	GetVersion () override

EffectFamilySymbol	GetFamily () override

bool	IsInteractive () override

bool	IsDefault () override

bool	IsLegacy () override

bool	SupportsRealtime () override

bool	SupportsAutomation () override

bool	SetHost (EffectHostInterface *host) override

unsigned	GetAudioInCount () override

int	GetMidiInCount () override

int	GetMidiOutCount () override

sampleCount	GetLatency () override

size_t	GetTailSize () override

void	SetSampleRate (double rate) override

size_t	SetBlockSize (size_t maxBlockSize) override

size_t	GetBlockSize () const override

bool	IsReady () override

bool	ProcessFinalize () override

bool	RealtimeInitialize () override

bool	RealtimeAddProcessor (unsigned numChannels, float sampleRate) override

bool	RealtimeFinalize () override

bool	RealtimeSuspend () override

bool	RealtimeResume () override

bool	RealtimeProcessStart () override

size_t	RealtimeProcess (int group, float inbuf, float outbuf, size_t numSamples) override

bool	RealtimeProcessEnd () override

bool	ShowInterface (wxWindow &parent, const EffectDialogFactory &factory, bool forceModal=false) override

bool	LoadUserPreset (const RegistryPath &name) override

bool	SaveUserPreset (const RegistryPath &name) override

RegistryPaths	GetFactoryPresets () override

bool	LoadFactoryPreset (int id) override

bool	LoadFactoryDefaults () override

void	SetHostUI (EffectUIHostInterface *host) override

bool	PopulateUI (ShuttleGui &S) final

bool	IsGraphicalUI () override

bool	ValidateUI () override

bool	HideUI () override

bool	CloseUI () override

bool	CanExportPresets () override

void	ExportPresets () override

void	ImportPresets () override

bool	HasOptions () override

void	ShowOptions () override

double	GetDefaultDuration () override

double	GetDuration () override

NumericFormatSymbol	GetDurationFormat () override

virtual NumericFormatSymbol	GetSelectionFormat ()

void	SetDuration (double duration) override

RegistryPath	GetUserPresetsGroup (const RegistryPath &name) override

RegistryPath	GetCurrentSettingsGroup () override

RegistryPath	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

bool	HasSharedConfigGroup (const RegistryPath &group) override

bool	GetSharedConfigSubgroups (const RegistryPath &group, RegistryPaths &subgroups) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval={}) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, int &value, int defval=0) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, bool &value, bool defval=false) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, float &value, float defval=0.0) override

bool	GetSharedConfig (const RegistryPath &group, const RegistryPath &key, double &value, double defval=0.0) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const wxString &value) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const int &value) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const bool &value) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const float &value) override

bool	SetSharedConfig (const RegistryPath &group, const RegistryPath &key, const double &value) override

bool	RemoveSharedConfigSubgroup (const RegistryPath &group) override

bool	RemoveSharedConfig (const RegistryPath &group, const RegistryPath &key) override

bool	HasPrivateConfigGroup (const RegistryPath &group) override

bool	GetPrivateConfigSubgroups (const RegistryPath &group, RegistryPaths &paths) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, wxString &value, const wxString &defval={}) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, int &value, int defval=0) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, bool &value, bool defval=false) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, float &value, float defval=0.0) override

bool	GetPrivateConfig (const RegistryPath &group, const RegistryPath &key, double &value, double defval=0.0) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const wxString &value) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const int &value) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const bool &value) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const float &value) override

bool	SetPrivateConfig (const RegistryPath &group, const RegistryPath &key, const double &value) override

bool	RemovePrivateConfigSubgroup (const RegistryPath &group) override

bool	RemovePrivateConfig (const RegistryPath &group, const RegistryPath &key) override

virtual PluginID	GetID ()

virtual bool	Startup (EffectClientInterface *client)

virtual bool	Startup ()

virtual bool	GetAutomationParameters (wxString &parms)

virtual bool	SetAutomationParameters (const wxString &parms)

virtual RegistryPaths	GetUserPresets ()

virtual bool	HasCurrentSettings ()

virtual bool	HasFactoryDefaults ()

virtual FilePath	HelpPage ()

virtual void	SetUIFlags (unsigned flags)

virtual unsigned	TestUIFlags (unsigned mask)

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

bool	DoEffect (double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={})

bool	Delegate (Effect &delegate, wxWindow &parent, const EffectDialogFactory &factory)

virtual bool	IsHidden ()

int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

Public Member Functions inherited from EffectClientInterface
virtual	~EffectClientInterface ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

virtual EffectType	GetClassification ()

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

TranslatableString	GetName ()

virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Public Member Functions inherited from EffectUIClientInterface
virtual	~EffectUIClientInterface ()

Public Member Functions inherited from EffectHostInterface
virtual	~EffectHostInterface ()

Public Member Functions inherited from ConfigClientInterface
virtual	~ConfigClientInterface ()

Private Member Functions
void	OnControlUpdate (wxCommandEvent &evt)

Private Attributes
bool	mChirp

sampleCount	mSample

double	mPositionInCycles

int	mWaveform

int	mInterpolation

double	mFrequency [2]

double	mAmplitude [2]

double	mLogFrequency [2]

NumericTextCtrl *	mToneDurationT

Additional Inherited Members
Public Types inherited from Effect
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

using	VetoDialogHook = bool()(wxDialog )

Public Types inherited from EffectClientInterface
using	EffectDialogFactory = std::function< wxDialog (wxWindow &parent, EffectHostInterface , EffectUIClientInterface *) >

Static Public Member Functions inherited from Effect
static VetoDialogHook	SetVetoDialogHook (VetoDialogHook hook)

static CommandID	GetSquashedName (wxString name)

static void	IncEffectCounter ()

Static Public Attributes inherited from Effect
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 Effect
virtual bool	Init ()

virtual bool	CheckWhetherSkipEffect ()

virtual bool	Process ()

virtual bool	ProcessPass ()

virtual bool	InitPass1 ()

virtual bool	InitPass2 ()

virtual int	GetPass ()

virtual void	End ()

virtual double	CalcPreviewInputLength (double previewLength)

virtual void	Preview (bool dryOnly)

virtual bool	EnableApply (bool enable=true)

virtual bool	EnablePreview (bool enable=true)

virtual void	EnableDebug (bool enable=true)

bool	TotalProgress (double frac, const TranslatableString &={})

bool	TrackProgress (int whichTrack, double frac, const TranslatableString &={})

bool	TrackGroupProgress (int whichGroup, double frac, const TranslatableString &={})

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

void	GetBounds (const WaveTrack &track, const WaveTrack pRight, sampleCount start, sampleCount *len)

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks (bool allSyncLockSelected=false)

std::shared_ptr< AddedAnalysisTrack >	AddAnalysisTrack (const wxString &name=wxString())

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

void	ReplaceProcessedTracks (const bool bGoodResult)

Track *	AddToOutputTracks (const std::shared_ptr< Track > &t)

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes inherited from Effect
ProgressDialog *	mProgress

double	mProjectRate

double	mSampleRate

wxWeakRef< NotifyingSelectedRegion >	mpSelectedRegion {}

WaveTrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxDialog *	mUIDialog

wxWindow *	mUIParent

int	mUIResultID

unsigned	mUIFlags

sampleCount	mSampleCnt

Static Protected Attributes inherited from Effect
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 21 of file ToneGen.h.

Constructor & Destructor Documentation

◆ EffectToneGen()

EffectToneGen::EffectToneGen ( bool isChirp )

Definition at line 102 of file ToneGen.cpp.

 {
    wxASSERT(nWaveforms == WXSIZEOF(kWaveStrings));
    wxASSERT(nInterpolations == WXSIZEOF(kInterStrings));
  
    mChirp = isChirp;
  
    mWaveform = DEF_Waveform;
    mFrequency[0] = DEF_StartFreq;
    mFrequency[1] = DEF_EndFreq;
    mAmplitude[0] = DEF_StartAmp;
    mAmplitude[1] = DEF_EndAmp;
    mInterpolation = DEF_Interp;
  
    // 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);
 }

References kInterStrings, kWaveStrings, nInterpolations, and nWaveforms.

◆ ~EffectToneGen()

EffectToneGen::~EffectToneGen ( )

virtual

Definition at line 124 of file ToneGen.cpp.

125 {

126 }

Member Function Documentation

◆ DefineParams()

bool EffectToneGen::DefineParams ( ShuttleParams & S )

override

Definition at line 274 of file ToneGen.cpp.

                                                    {
    if( mChirp ){
       S.SHUTTLE_PARAM( mFrequency[0], StartFreq  );
       S.SHUTTLE_PARAM( mFrequency[1], EndFreq  );
       S.SHUTTLE_PARAM( mAmplitude[0], StartAmp  );
       S.SHUTTLE_PARAM( mAmplitude[1], EndAmp  );
    } else {
       S.SHUTTLE_PARAM( mFrequency[0], Frequency  );
       S.SHUTTLE_PARAM( mAmplitude[0], Amplitude );
       // Slightly hacky way to set freq and ampl
       // since we do this whatever query to params was made.
       mFrequency[1] = mFrequency[0];
       mAmplitude[1] = mAmplitude[0];
    }
    S.SHUTTLE_ENUM_PARAM( mWaveform, Waveform, kWaveStrings, nWaveforms  );
    S.SHUTTLE_ENUM_PARAM( mInterpolation, Interp, kInterStrings, nInterpolations  );
  
  
 //   double freqMax = (FindProject() ? FindProject()->GetRate() : 44100.0) / 2.0;
 //   mFrequency[1] = TrapDouble(mFrequency[1], MIN_EndFreq, freqMax);
  
  
    return true;
 }

References kInterStrings, kWaveStrings, mAmplitude, mChirp, mFrequency, mInterpolation, mWaveform, nInterpolations, nWaveforms, and WaveTrackViewConstants::Waveform.

◆ GetAudioOutCount()

unsigned EffectToneGen::GetAudioOutCount ( )

overridevirtual

Reimplemented from Effect.

Definition at line 160 of file ToneGen.cpp.

 {
    return 1;
 }

◆ GetAutomationParameters()

bool EffectToneGen::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 299 of file ToneGen.cpp.

 {
    if (mChirp)
    {
       parms.Write(KEY_StartFreq, mFrequency[0]);
       parms.Write(KEY_EndFreq, mFrequency[1]);
       parms.Write(KEY_StartAmp, mAmplitude[0]);
       parms.Write(KEY_EndAmp, mAmplitude[1]);
    }
    else
    {
       parms.Write(KEY_Frequency, mFrequency[0]);
       parms.Write(KEY_Amplitude, mAmplitude[0]);
    }
  
    parms.Write(KEY_Waveform, kWaveStrings[mWaveform].Internal());
    parms.Write(KEY_Interp, kInterStrings[mInterpolation].Internal());
  
    return true;
 }

References Internal, kInterStrings, kWaveStrings, mAmplitude, mChirp, mFrequency, mInterpolation, and mWaveform.

◆ GetDescription()

TranslatableString EffectToneGen::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 137 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 ( )

overridevirtual

Reimplemented from Effect.

Definition at line 130 of file ToneGen.cpp.

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

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

◆ GetType()

EffectType EffectToneGen::GetType ( )

overridevirtual

Reimplemented from Effect.

Definition at line 153 of file ToneGen.cpp.

 {
    return EffectTypeGenerate;
 }

References EffectTypeGenerate.

◆ ManualPage()

ManualPageID EffectToneGen::ManualPage ( )

overridevirtual

Reimplemented from Effect.

Definition at line 144 of file ToneGen.cpp.

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

References mChirp.

◆ OnControlUpdate()

void EffectToneGen::OnControlUpdate ( wxCommandEvent & evt )

private

Definition at line 517 of file ToneGen.cpp.

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

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

Here is the call graph for this function:

◆ PopulateOrExchange()

void EffectToneGen::PopulateOrExchange ( ShuttleGui & S )

overridevirtual

Reimplemented from Effect.

Definition at line 360 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, &mFrequency[0],
                      NumValidatorStyle::NO_TRAILING_ZEROES,
                      MIN_StartFreq,
                      mProjectRate / 2.0
                   )
                   .AddTextBox( {}, wxT(""), 12);
             }
             S.EndHorizontalLay();
  
             S.StartHorizontalLay(wxLEFT, 50);
             {
                t = S.Name(XO("Frequency Hertz End"))
                   .Validator<FloatingPointValidator<double>>(
                      6, &mFrequency[1],
                      NumValidatorStyle::NO_TRAILING_ZEROES,
                      MIN_EndFreq,
                      mProjectRate / 2.0
                   )
                   .AddTextBox( {}, wxT(""), 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, &mAmplitude[0], NumValidatorStyle::NO_TRAILING_ZEROES,
                      MIN_StartAmp, MAX_StartAmp
                   )
                   .AddTextBox( {}, wxT(""), 12);
             }
             S.EndHorizontalLay();
  
             S.StartHorizontalLay(wxLEFT, 50);
             {
                t = S.Name(XO("Amplitude End"))
                   .Validator<FloatingPointValidator<double>>(
                      6, &mAmplitude[1], NumValidatorStyle::NO_TRAILING_ZEROES,
                      MIN_EndAmp, MAX_EndAmp
                   )
                   .AddTextBox( {}, wxT(""), 12);
             }
             S.EndHorizontalLay();
          }
          S.EndHorizontalLay();
  
          S.Validator<wxGenericValidator>(&mInterpolation)
             .AddChoice(XXO("I&nterpolation:"),
                Msgids( kInterStrings, nInterpolations ) );
       }
       else
       {
          t = S.Validator<FloatingPointValidator<double>>(
                6, &mFrequency[0], NumValidatorStyle::NO_TRAILING_ZEROES,
                MIN_Frequency,
                mProjectRate / 2.0
             )
             .AddTextBox(XXO("&Frequency (Hz):"), wxT(""), 12);
  
          t = S.Validator<FloatingPointValidator<double>>(
                6, &mAmplitude[0], NumValidatorStyle::NO_TRAILING_ZEROES,
                MIN_Amplitude, MAX_Amplitude
             )
             .AddTextBox(XXO("&Amplitude (0-1):"), wxT(""), 12);
       }
  
       S.AddPrompt(XXO("&Duration:"));
       mToneDurationT = safenew
          NumericTextCtrl(S.GetParent(), wxID_ANY,
                          NumericConverter::TIME,
                          GetDurationFormat(),
                          GetDuration(),
                          mProjectRate,
                          NumericTextCtrl::Options{}
                             .AutoPos(true));
       S.Name(XO("Duration"))
          .Position(wxALIGN_LEFT | wxALL)
          .AddWindow(mToneDurationT);
    }
    S.EndMultiColumn();
  
    return;
 }

References ShuttleGuiBase::AddFixedText(), ShuttleGuiBase::AddPrompt(), ShuttleGuiBase::AddTitle(), ShuttleGuiBase::AddWindow(), NumericTextCtrl::Options::AutoPos(), ShuttleGuiBase::EndHorizontalLay(), ShuttleGuiBase::EndMultiColumn(), Effect::GetDuration(), Effect::GetDurationFormat(), ShuttleGuiBase::GetParent(), kInterStrings, kWaveStrings, mAmplitude, mChirp, mFrequency, mInterpolation, Effect::mProjectRate, Msgids(), mToneDurationT, mWaveform, ShuttleGui::Name(), nInterpolations, nWaveforms, ShuttleGui::Position(), safenew, ShuttleGuiBase::StartHorizontalLay(), ShuttleGuiBase::StartMultiColumn(), NumericConverter::TIME, ShuttleGui::Validator(), XO, and XXO.

Here is the call graph for this function:

◆ ProcessBlock()

size_t EffectToneGen::ProcessBlock	(	float **	inBlock,
		float **	outBlock,
		size_t	blockLen
	)

overridevirtual

Reimplemented from Effect.

Definition at line 173 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 =
       (mAmplitude[1] - mAmplitude[0]) / doubleSampleCount;
    BlendedAmplitude = mAmplitude[0] +
       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(mFrequency[0]);
       mLogFrequency[1] = log10(mFrequency[1]);
       // 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 = (mFrequency[1] - mFrequency[0]) / doubleSampleCount;
       BlendedFrequency = mFrequency[0] + 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, mAmplitude, mFrequency, mInterpolation, mLogFrequency, mPositionInCycles, mSample, Effect::mSampleCnt, Effect::mSampleRate, and mWaveform.

Here is the call graph for this function:

◆ ProcessInitialize()

bool EffectToneGen::ProcessInitialize	(	sampleCount	totalLen,
		ChannelNames	chanMap = `NULL`
	)

overridevirtual

Reimplemented from Effect.

Definition at line 165 of file ToneGen.cpp.

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

References mPositionInCycles, and mSample.

◆ SetAutomationParameters()

bool EffectToneGen::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 320 of file ToneGen.cpp.

 {
    ReadAndVerifyEnum(Waveform,  kWaveStrings, nWaveforms);
    ReadAndVerifyEnum(Interp, kInterStrings, nInterpolations);
    if (mChirp)
    {
       ReadAndVerifyDouble(StartFreq);
       ReadAndVerifyDouble(EndFreq);
       ReadAndVerifyDouble(StartAmp);
       ReadAndVerifyDouble(EndAmp);
       mFrequency[0] = StartFreq;
       mFrequency[1] = EndFreq;
       mAmplitude[0] = StartAmp;
       mAmplitude[1] = EndAmp;
    }
    else
    {
       ReadAndVerifyDouble(Frequency);
       ReadAndVerifyDouble(Amplitude);
       mFrequency[0] = Frequency;
       mFrequency[1] = Frequency;
       mAmplitude[0] = Amplitude;
       mAmplitude[1] = Amplitude;
    }
  
    mWaveform = Waveform;
    mInterpolation = Interp;
  
    double freqMax =
       (FindProject()
          ? ProjectRate::Get( *FindProject() ).GetRate()
          : 44100.0)
       / 2.0;
    mFrequency[1] = TrapDouble(mFrequency[1], MIN_EndFreq, freqMax);
  
    return true;
 }

References Effect::FindProject(), ProjectRate::Get(), ProjectRate::GetRate(), kInterStrings, kWaveStrings, mAmplitude, mChirp, mFrequency, mInterpolation, mWaveform, nInterpolations, nWaveforms, ReadAndVerifyDouble, ReadAndVerifyEnum, TrapDouble(), and WaveTrackViewConstants::Waveform.

Here is the call graph for this function:

◆ TransferDataFromWindow()

bool EffectToneGen::TransferDataFromWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 497 of file ToneGen.cpp.

 {
    if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
    {
       return false;
    }
  
    if (!mChirp)
    {
       mFrequency[1] = mFrequency[0];
       mAmplitude[1] = mAmplitude[0];
    }
  
    SetDuration(mToneDurationT->GetValue());
  
    return true;
 }

References NumericConverter::GetValue(), mAmplitude, mChirp, mFrequency, mToneDurationT, Effect::mUIParent, and Effect::SetDuration().

Here is the call graph for this function:

◆ TransferDataToWindow()

bool EffectToneGen::TransferDataToWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 485 of file ToneGen.cpp.

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

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

Here is the call graph for this function:

Member Data Documentation

◆ mAmplitude

double EffectToneGen::mAmplitude[2]

private

Definition at line 70 of file ToneGen.h.

Referenced by DefineParams(), GetAutomationParameters(), PopulateOrExchange(), ProcessBlock(), SetAutomationParameters(), and TransferDataFromWindow().

◆ mChirp

bool EffectToneGen::mChirp

private

Definition at line 58 of file ToneGen.h.

Referenced by DefineParams(), GetAutomationParameters(), GetDescription(), GetSymbol(), ManualPage(), PopulateOrExchange(), SetAutomationParameters(), and TransferDataFromWindow().

◆ mFrequency

double EffectToneGen::mFrequency[2]

private

Definition at line 69 of file ToneGen.h.

Referenced by DefineParams(), GetAutomationParameters(), PopulateOrExchange(), ProcessBlock(), SetAutomationParameters(), and TransferDataFromWindow().

◆ mInterpolation

int EffectToneGen::mInterpolation

private

Definition at line 68 of file ToneGen.h.

Referenced by DefineParams(), GetAutomationParameters(), PopulateOrExchange(), ProcessBlock(), and SetAutomationParameters().

◆ mLogFrequency

double EffectToneGen::mLogFrequency[2]

private

Definition at line 71 of file ToneGen.h.

Referenced by ProcessBlock().

◆ mPositionInCycles

double EffectToneGen::mPositionInCycles

private

Definition at line 63 of file ToneGen.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mSample

sampleCount EffectToneGen::mSample

private

Definition at line 62 of file ToneGen.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mToneDurationT

NumericTextCtrl* EffectToneGen::mToneDurationT

private

Definition at line 73 of file ToneGen.h.

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

◆ mWaveform

int EffectToneGen::mWaveform

private

Definition at line 67 of file ToneGen.h.

Referenced by DefineParams(), GetAutomationParameters(), PopulateOrExchange(), ProcessBlock(), and SetAutomationParameters().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectToneGen()

◆ ~EffectToneGen()

Member Function Documentation

◆ DefineParams()

◆ GetAudioOutCount()

◆ GetAutomationParameters()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ ManualPage()

◆ OnControlUpdate()

◆ PopulateOrExchange()

◆ ProcessBlock()

◆ ProcessInitialize()

◆ SetAutomationParameters()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

Member Data Documentation

◆ mAmplitude

◆ mChirp

◆ mFrequency

◆ mInterpolation

◆ mLogFrequency

◆ mPositionInCycles

◆ mSample

◆ mToneDurationT

◆ mWaveform