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:

Public Member Functions
	EffectToneGen (bool isChirp)

virtual	~EffectToneGen ()

IdentInterfaceSymbol	GetSymbol () override

wxString	GetDescription () override

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

wxString	GetPath () override

IdentInterfaceSymbol	GetVendor () override

wxString	GetVersion () override

IdentInterfaceSymbol	GetFamilyId () 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

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, bool forceModal=false) override

bool	LoadUserPreset (const wxString &name) override

bool	SaveUserPreset (const wxString &name) override

wxArrayString	GetFactoryPresets () override

bool	LoadFactoryPreset (int id) override

bool	LoadFactoryDefaults () override

void	SetHostUI (EffectUIHostInterface *host) override

bool	PopulateUI (wxWindow *parent) override

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

NumericFormatId	GetDurationFormat () override

virtual NumericFormatId	GetSelectionFormat ()

void	SetDuration (double duration) override

bool	Apply () override

void	Preview () override

wxDialog *	CreateUI (wxWindow parent, EffectUIClientInterface client) override

wxString	GetUserPresetsGroup (const wxString &name) override

wxString	GetCurrentSettingsGroup () override

wxString	GetFactoryDefaultsGroup () override

virtual wxString	GetSavedStateGroup ()

bool	HasSharedConfigGroup (const wxString &group) override

bool	GetSharedConfigSubgroups (const wxString &group, wxArrayString &subgroups) override

bool	GetSharedConfig (const wxString &group, const wxString &key, wxString &value, const wxString &defval=wxEmptyString) override

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

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

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

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

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

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

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

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

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

bool	RemoveSharedConfigSubgroup (const wxString &group) override

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

bool	HasPrivateConfigGroup (const wxString &group) override

bool	GetPrivateConfigSubgroups (const wxString &group, wxArrayString &subgroups) override

bool	GetPrivateConfig (const wxString &group, const wxString &key, wxString &value, const wxString &defval=wxEmptyString) override

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

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

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

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

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

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

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

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

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

bool	RemovePrivateConfigSubgroup (const wxString &group) override

bool	RemovePrivateConfig (const wxString &group, const wxString &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 wxArrayString	GetUserPresets ()

virtual bool	HasCurrentSettings ()

virtual bool	HasFactoryDefaults ()

virtual wxString	GetPreset (wxWindow *parent, const wxString &parms)

virtual wxString	HelpPage ()

virtual bool	IsBatchProcessing ()

virtual void	SetBatchProcessing (bool start)

void	SetPresetParameters (const wxArrayString Names, const wxArrayString Values)

bool	DoEffect (wxWindow parent, double projectRate, TrackList list, TrackFactory factory, SelectedRegion selectedRegion, bool shouldPrompt=true)

bool	Delegate (Effect &delegate, wxWindow *parent, bool shouldPrompt)

bool	RealtimeAddProcessor (int group, unsigned chans, float rate)

size_t	RealtimeProcess (int group, unsigned chans, float inbuf, float outbuf, size_t numSamples)

bool	IsRealtimeActive ()

virtual bool	IsHidden ()

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

Public Member Functions inherited from EffectClientInterface
virtual	~EffectClientInterface ()

Public Member Functions inherited from EffectDefinitionInterface
virtual	~EffectDefinitionInterface ()

Public Member Functions inherited from IdentInterface
virtual	~IdentInterface ()

const wxString &	GetTranslatedName ()

Public Member Functions inherited from ParamsInterface
virtual	~ParamsInterface ()

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 }

Protected Member Functions inherited from Effect
virtual bool	Init ()

virtual bool	PromptUser (wxWindow *parent)

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)

bool	TrackProgress (int whichTrack, double frac, const wxString &=wxEmptyString)

bool	TrackGroupProgress (int whichGroup, double frac, const wxString &=wxEmptyString)

int	GetNumWaveTracks ()

int	GetNumWaveGroups ()

void	GetSamples (const WaveTrack track, sampleCount start, sampleCount *len)

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing ()

void	IncludeNotSelectedPreviewTracks (bool includeNotSelected)

void	CopyInputTracks ()

void	CopyInputTracks (int trackType)

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 (std::unique_ptr< Track > &&t)

TrackList *	inputTracks () const

Protected Attributes inherited from Effect
ProgressDialog *	mProgress

double	mProjectRate

double	mSampleRate

SelectedRegion *	mpSelectedRegion {}

TrackFactory *	mFactory

std::shared_ptr< TrackList >	mOutputTracks

double	mT0

double	mT1

double	mF0

double	mF1

wxArrayString	mPresetNames

wxArrayString	mPresetValues

int	mPass

wxDialog *	mUIDialog

wxWindow *	mUIParent

int	mUIResultID

sampleCount	mSampleCnt

int	mOutputTracksType

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 28 of file ToneGen.h.

Constructor & Destructor Documentation

EffectToneGen::EffectToneGen ( bool isChirp )

Definition at line 86 of file ToneGen.cpp.

References nInterpolations, and nWaveforms.

 {
    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);
 }

EffectToneGen::~EffectToneGen ( )

virtual

Definition at line 108 of file ToneGen.cpp.

109 {

110 }

Member Function Documentation

bool EffectToneGen::DefineParams ( ShuttleParams & S )

override

Definition at line 248 of file ToneGen.cpp.

References mAmplitude, mChirp, mFrequency, mInterpolation, mWaveform, nInterpolations, and nWaveforms.

                                                    {
    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 = (GetActiveProject() ? GetActiveProject()->GetRate() : 44100.0) / 2.0;
 //   mFrequency[1] = TrapDouble(mFrequency[1], MIN_EndFreq, freqMax);
 
 
    return true;
 }

unsigned EffectToneGen::GetAudioOutCount ( )

overridevirtual

Reimplemented from Effect.

Definition at line 144 of file ToneGen.cpp.

 {
    return 1;
 }

bool EffectToneGen::GetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 273 of file ToneGen.cpp.

References mAmplitude, mChirp, mFrequency, mInterpolation, and mWaveform.

 {
    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;
 }

wxString EffectToneGen::GetDescription ( )

overridevirtual

Reimplemented from Effect.

Definition at line 121 of file ToneGen.cpp.

References _(), and mChirp.

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

IdentInterfaceSymbol EffectToneGen::GetSymbol ( )

overridevirtual

Reimplemented from Effect.

Definition at line 114 of file ToneGen.cpp.

References CHIRP_PLUGIN_SYMBOL, mChirp, and TONE_PLUGIN_SYMBOL.

 {
    return mChirp
       ? CHIRP_PLUGIN_SYMBOL
       : TONE_PLUGIN_SYMBOL;
 }

EffectType EffectToneGen::GetType ( )

overridevirtual

Reimplemented from Effect.

Definition at line 137 of file ToneGen.cpp.

References EffectTypeGenerate.

 {
    return EffectTypeGenerate;
 }

wxString EffectToneGen::ManualPage ( )

overridevirtual

Reimplemented from Effect.

Definition at line 128 of file ToneGen.cpp.

References mChirp.

 {
    return mChirp
       ? wxT("Chirp")
       : wxT("Tone");
 }

void EffectToneGen::OnControlUpdate ( wxCommandEvent & evt )

private

Definition at line 475 of file ToneGen.cpp.

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

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

void EffectToneGen::PopulateOrExchange ( ShuttleGui & S )

overridevirtual

Reimplemented from Effect.

Definition at line 330 of file ToneGen.cpp.

References _(), ShuttleGuiBase::AddChoice(), ShuttleGuiBase::AddFixedText(), ShuttleGuiBase::AddPrompt(), ShuttleGuiBase::AddTextBox(), ShuttleGuiBase::AddTitle(), ShuttleGuiBase::AddWindow(), NumericTextCtrl::Options::AutoPos(), ShuttleGuiBase::EndHorizontalLay(), ShuttleGuiBase::EndMultiColumn(), GetActiveProject(), Effect::GetDuration(), Effect::GetDurationFormat(), ShuttleGuiBase::GetParent(), LocalizedStrings(), mAmplitude, mChirp, mFrequency, mInterpolation, Effect::mProjectRate, mToneDurationT, mWaveform, nInterpolations, nWaveforms, safenew, ShuttleGuiBase::StartHorizontalLay(), ShuttleGuiBase::StartMultiColumn(), and NumericConverter::TIME.

 {
    wxTextCtrl *t;
 
    S.StartMultiColumn(2, wxCENTER);
    {
       auto waveforms = LocalizedStrings(kWaveStrings, nWaveforms);
       wxChoice *c = S.AddChoice(_("Waveform:"), wxT(""), &waveforms);
       c->SetValidator(wxGenericValidator(&mWaveform));
 
       if (mChirp)
       {
          S.AddFixedText( {} );
          S.StartHorizontalLay(wxEXPAND);
          {
             S.StartHorizontalLay(wxLEFT, 50);
             {
                S.AddTitle(_("Start"));
             }
             S.EndHorizontalLay();
 
             S.StartHorizontalLay(wxLEFT, 50);
             {
                S.AddTitle(_("End"));
             }
             S.EndHorizontalLay();
          }
          S.EndHorizontalLay();
 
          S.AddPrompt(_("Frequency (Hz):"));
          S.StartHorizontalLay(wxEXPAND);
          {
             S.StartHorizontalLay(wxLEFT, 50);
             {
                FloatingPointValidator<double> vldStartFreq(6, &mFrequency[0], NumValidatorStyle::NO_TRAILING_ZEROES);
                vldStartFreq.SetRange(MIN_StartFreq, GetActiveProject()->GetRate() / 2.0);
                t = S.AddTextBox( {}, wxT(""), 12);
                t->SetName(_("Frequency Hertz Start"));
                t->SetValidator(vldStartFreq);
             }
             S.EndHorizontalLay();
 
             S.StartHorizontalLay(wxLEFT, 50);
             {
                FloatingPointValidator<double> vldEndFreq(6, &mFrequency[1], NumValidatorStyle::NO_TRAILING_ZEROES);
                vldEndFreq.SetRange(MIN_EndFreq, GetActiveProject()->GetRate() / 2.0);
                t = S.AddTextBox( {}, wxT(""), 12);
                t->SetName(_("Frequency Hertz End"));
                t->SetValidator(vldEndFreq);
             }
             S.EndHorizontalLay();
          }
          S.EndHorizontalLay();
 
          S.AddPrompt(_("Amplitude (0-1):"));
          S.StartHorizontalLay(wxEXPAND);
          {
             S.StartHorizontalLay(wxLEFT, 50);
             {
                FloatingPointValidator<double> vldStartAmp(6, &mAmplitude[0], NumValidatorStyle::NO_TRAILING_ZEROES);
                vldStartAmp.SetRange(MIN_StartAmp, MAX_StartAmp);
                t = S.AddTextBox( {}, wxT(""), 12);
                t->SetName(_("Amplitude Start"));
                t->SetValidator(vldStartAmp);
             }
             S.EndHorizontalLay();
 
             S.StartHorizontalLay(wxLEFT, 50);
             {
                FloatingPointValidator<double> vldEndAmp(6, &mAmplitude[1], NumValidatorStyle::NO_TRAILING_ZEROES);
                vldEndAmp.SetRange(MIN_EndAmp, MAX_EndAmp);
                t = S.AddTextBox( {}, wxT(""), 12);
                t->SetName(_("Amplitude End"));
                t->SetValidator(vldEndAmp);
             }
             S.EndHorizontalLay();
          }
          S.EndHorizontalLay();
 
          auto interpolations = LocalizedStrings(kInterStrings, nInterpolations);
          c = S.AddChoice(_("Interpolation:"), wxT(""), &interpolations);
          c->SetValidator(wxGenericValidator(&mInterpolation));
       }
       else
       {
          FloatingPointValidator<double> vldFrequency(6, &mFrequency[0], NumValidatorStyle::NO_TRAILING_ZEROES);
          vldFrequency.SetRange(MIN_Frequency, GetActiveProject()->GetRate() / 2.0);
          t = S.AddTextBox(_("Frequency (Hz):"), wxT(""), 12);
          t->SetValidator(vldFrequency);
 
          FloatingPointValidator<double> vldAmplitude(6, &mAmplitude[0], NumValidatorStyle::NO_TRAILING_ZEROES);
          vldAmplitude.SetRange(MIN_Amplitude, MAX_Amplitude);
          t = S.AddTextBox(_("Amplitude (0-1):"), wxT(""), 12);
          t->SetValidator(vldAmplitude);
       }
 
       S.AddPrompt(_("Duration:"));
       mToneDurationT = safenew
          NumericTextCtrl(S.GetParent(), wxID_ANY,
                          NumericConverter::TIME,
                          GetDurationFormat(),
                          GetDuration(),
                          mProjectRate,
                          NumericTextCtrl::Options{}
                             .AutoPos(true));
       mToneDurationT->SetName(_("Duration"));
       S.AddWindow(mToneDurationT, wxALIGN_LEFT | wxALL);
    }
    S.EndMultiColumn();
 
    return;
 }

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

overridevirtual

Reimplemented from Effect.

Definition at line 157 of file ToneGen.cpp.

References sampleCount::as_double(), kLogarithmic, kSawtooth, kSine, kSquare, kSquareNoAlias, M_PI, mAmplitude, mFrequency, mInterpolation, mLogFrequency, mPositionInCycles, mSample, Effect::mSampleCnt, Effect::mSampleRate, and mWaveform.

 {
    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 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)
          {
             //Hanning 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;
 }

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

overridevirtual

Reimplemented from Effect.

Definition at line 149 of file ToneGen.cpp.

References mPositionInCycles, and mSample.

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

bool EffectToneGen::SetAutomationParameters ( CommandParameters & parms )

overridevirtual

Reimplemented from Effect.

Definition at line 294 of file ToneGen.cpp.

References GetActiveProject(), AudacityProject::GetRate(), mAmplitude, mChirp, mFrequency, mInterpolation, mWaveform, nInterpolations, nWaveforms, ReadAndVerifyDouble, ReadAndVerifyEnum, and TrapDouble().

 {
    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 = (GetActiveProject() ? GetActiveProject()->GetRate() : 44100.0) / 2.0;
    mFrequency[1] = TrapDouble(mFrequency[1], MIN_EndFreq, freqMax);
 
    return true;
 }

bool EffectToneGen::TransferDataFromWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 455 of file ToneGen.cpp.

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

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

bool EffectToneGen::TransferDataToWindow ( )

overridevirtual

Reimplemented from Effect.

Definition at line 443 of file ToneGen.cpp.

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

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

Member Data Documentation

double EffectToneGen::mAmplitude[2]

private

Definition at line 77 of file ToneGen.h.

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

bool EffectToneGen::mChirp

private

Definition at line 65 of file ToneGen.h.

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

double EffectToneGen::mFrequency[2]

private

Definition at line 76 of file ToneGen.h.

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

int EffectToneGen::mInterpolation

private

Definition at line 75 of file ToneGen.h.

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

double EffectToneGen::mLogFrequency[2]

private

Definition at line 78 of file ToneGen.h.

Referenced by ProcessBlock().

double EffectToneGen::mPositionInCycles

private

Definition at line 70 of file ToneGen.h.

Referenced by ProcessBlock(), and ProcessInitialize().

sampleCount EffectToneGen::mSample

private

Definition at line 69 of file ToneGen.h.

Referenced by ProcessBlock(), and ProcessInitialize().

NumericTextCtrl* EffectToneGen::mToneDurationT

private

Definition at line 80 of file ToneGen.h.

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

int EffectToneGen::mWaveform

private

Definition at line 74 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

Member Function Documentation

Member Data Documentation