#include <NoiseBase.h>

Inheritance diagram for NoiseBase:

Collaboration diagram for NoiseBase:

Public Member Functions
	NoiseBase ()

virtual	~NoiseBase ()

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

Public Member Functions inherited from StatefulPerTrackEffect
	~StatefulPerTrackEffect () override

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

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

bool	ProcessFinalize () noexcept override

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

virtual bool	Process (EffectInstance &instance, EffectSettings &settings)=0

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

virtual bool	NeedsDither () const

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

virtual bool	ProcessFinalize () noexcept

Public Member Functions inherited from PerTrackEffect
	~PerTrackEffect () override

Public Member Functions inherited from Effect
	Effect ()

virtual	~Effect ()

PluginPath	GetPath () const override

bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings) override

bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const override

ComponentInterfaceSymbol	GetSymbol () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

TranslatableString	GetDescription () const override

EffectFamilySymbol	GetFamily () const override
	Report identifier and user-visible name of the effect protocol. More...

bool	IsInteractive () const override
	Whether the effect needs a dialog for entry of settings. More...

bool	IsDefault () const override
	Whether the effect sorts "above the line" in the menus. More...

RealtimeSince	RealtimeSupport () const override
	Since which version of Audacity has the effect supported realtime? More...

bool	SupportsAutomation () const override
	Whether the effect has any automatable controls. More...

bool	SaveSettings (const EffectSettings &settings, CommandParameters &parms) const override
	Store settings as keys and values. More...

bool	LoadSettings (const CommandParameters &parms, EffectSettings &settings) const override
	Restore settings from keys and values. More...

OptionalMessage	LoadUserPreset (const RegistryPath &name, EffectSettings &settings) const override

bool	SaveUserPreset (const RegistryPath &name, const EffectSettings &settings) const override
	Save settings in the configuration file as a user-named preset. More...

RegistryPaths	GetFactoryPresets () const override
	Report names of factory presets. More...

OptionalMessage	LoadFactoryPreset (int id, EffectSettings &settings) const override

OptionalMessage	LoadFactoryDefaults (EffectSettings &settings) const override

virtual const EffectParameterMethods &	Parameters () const

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

bool	HasOptions () const override

const EffectSettingsManager &	GetDefinition () const override

virtual NumericFormatID	GetSelectionFormat ()

bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const override

OptionalMessage	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const override

bool	IsBatchProcessing () const override

void	SetBatchProcessing () override

void	UnsetBatchProcessing () override

unsigned	TestUIFlags (unsigned mask)

bool	Delegate (Effect &delegate, EffectSettings &settings, InstanceFinder finder={})
	Re-invoke DoEffect on another Effect object that implements the work. More...

Public Member Functions inherited from EffectBase
	EffectBase ()

	~EffectBase () override

bool	IsLinearEffect () const

bool	PreviewsFullSelection () const

void	SetTracks (TrackList *pTracks)

double	GetDefaultDuration ()

virtual std::any	BeginPreview (const EffectSettings &settings)
	Called when Preview() starts, to allow temporary effect state changes. More...

bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess) override

virtual double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const =0

void	CountWaveTracks ()

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

virtual	~EffectPlugin ()

virtual bool	HasOptions () const =0

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

virtual const EffectSettingsManager &	GetDefinition () const =0

virtual bool	SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0

virtual OptionalMessage	LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0

virtual bool	IsBatchProcessing () const =0

virtual void	SetBatchProcessing ()=0

virtual void	UnsetBatchProcessing ()=0

virtual bool	DoEffect (EffectSettings &settings, const InstanceFinder &finder, double projectRate, TrackList list, WaveTrackFactory factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, const EffectSettingsAccessPtr &pAccess=nullptr)=0

Public Member Functions inherited from EffectInstanceFactory
virtual	~EffectInstanceFactory ()

virtual std::shared_ptr< EffectInstance >	MakeInstance () const =0
	Make an object maintaining short-term state of an Effect. More...

Public Member Functions inherited from EffectSettingsManager
virtual	~EffectSettingsManager ()

virtual bool	VisitSettings (SettingsVisitor &visitor, EffectSettings &settings)

virtual bool	VisitSettings (ConstSettingsVisitor &visitor, const EffectSettings &settings) const

virtual 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 NoiseBase *	FetchParameters (NoiseBase &e, EffectSettings &)

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

Static Public Member Functions inherited from EffectBase
static std::optional< InstancePointer >	FindInstance (EffectPlugin &plugin)

static InstanceFinder	DefaultInstanceFinder (EffectPlugin &plugin)

Static Public Member Functions inherited from EffectDefinitionInterface
static Identifier	GetSquashedName (const Identifier &ident)
	A utility that strips spaces and CamelCases a name. More...

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

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 Types
enum	kTypes { kWhite , kPink , kBrownian , nTypes }

Protected Member Functions
const EffectParameterMethods &	Parameters () const override

Protected Member Functions inherited from PerTrackEffect
bool	DoPass1 () const

bool	DoPass2 () const

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

std::shared_ptr< EffectOutputTracks >	MakeOutputTracks ()

void	DestroyOutputTracks () const

Protected Member Functions inherited from Effect
bool	CheckWhetherSkipEffect (const EffectSettings &settings) const override
	Default implementation returns false. More...

double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override
	Default implementation returns `previewLength` More...

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

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

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

int	GetNumWaveTracks () const

int	GetNumWaveGroups () const

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

Protected Member Functions inherited from EffectBase
virtual bool	CheckWhetherSkipEffect (const EffectSettings &settings) const =0
	After Init(), tell whether Process() should be skipped. More...

void	SetLinearEffectFlag (bool linearEffectFlag)

void	SetPreviewFullSelectionFlag (bool previewDurationFlag)

bool	IsPreviewing () const

const TrackList *	inputTracks () const

const AudacityProject *	FindProject () const

Protected Attributes
double	mSampleRate {}

int	mType

double	mAmp

float	y

float	z

float	buf0

float	buf1

float	buf2

float	buf3

float	buf4

float	buf5

float	buf6

Protected Attributes inherited from PerTrackEffect
sampleCount	mSampleCnt {}

Protected Attributes inherited from EffectBase
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Static Protected Attributes
static const EnumValueSymbol	kTypeStrings [nTypes]

static constexpr EnumParameter	Type

static constexpr EffectParameter	Amp

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

Public Types inherited from EffectPlugin
using	EffectSettingsAccessPtr = std::shared_ptr< EffectSettingsAccess >

using	InstancePointer = std::shared_ptr< EffectInstanceEx >

using	InstanceFinder = std::function< std::optional< InstancePointer >(EffectSettings &settings) >

Public Types inherited from EffectDefinitionInterface
enum class	RealtimeSince : unsigned { Never , After_3_1 , Always }
	In which versions of Audacity was an effect realtime capable? More...

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

int	mNumTracks {}

BasicUI::ProgressDialog *	mProgress {}

double	mProjectRate {}

WaveTrackFactory *	mFactory {}

double	mT0 {}

double	mT1 {}

bool	mIsPreview { false }

Detailed Description

Definition at line 15 of file NoiseBase.h.

Member Enumeration Documentation

◆ kTypes

enum NoiseBase::kTypes

protected

Enumerator
kWhite
kPink
kBrownian
nTypes

Definition at line 56 of file NoiseBase.h.

   {
      kWhite,
      kPink,
      kBrownian,
      nTypes
   };

Constructor & Destructor Documentation

◆ NoiseBase()

NoiseBase::NoiseBase ( )

Definition at line 36 of file NoiseBase.cpp.

{
   Parameters().Reset(*this);
 
   SetLinearEffectFlag(true);
 
   y = z = buf0 = buf1 = buf2 = buf3 = buf4 = buf5 = buf6 = 0;
}

References buf0, buf1, buf2, buf3, buf4, buf5, buf6, Parameters(), EffectParameterMethods::Reset(), EffectBase::SetLinearEffectFlag(), y, and z.

Here is the call graph for this function:

◆ ~NoiseBase()

NoiseBase::~NoiseBase ( )

virtual

Definition at line 45 of file NoiseBase.cpp.

46{

47}

Member Function Documentation

◆ FetchParameters()

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

inlinestatic

Definition at line 18 of file NoiseBase.h.

   {
      return &e;
   }

◆ GetAudioOutCount()

unsigned NoiseBase::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 73 of file NoiseBase.cpp.

{
   return 1;
}

◆ GetDescription()

TranslatableString NoiseBase::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 56 of file NoiseBase.cpp.

{
   return XO("Generates one of three different types of noise");
}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol NoiseBase::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 51 of file NoiseBase.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType NoiseBase::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 68 of file NoiseBase.cpp.

{
   return EffectTypeGenerate;
}

References EffectTypeGenerate.

◆ ManualPage()

ManualPageID NoiseBase::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 61 of file NoiseBase.cpp.

{
   return L"Noise";
}

◆ Parameters()

const EffectParameterMethods & NoiseBase::Parameters ( ) const

overrideprotectedvirtual

Reimplemented from Effect.

Definition at line 24 of file NoiseBase.cpp.

{
   static CapturedParameters<NoiseBase, Type, Amp> parameters;
   return parameters;
}

Referenced by NoiseBase().

Here is the caller graph for this function:

◆ ProcessBlock()

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

overridevirtual

Called for destructive effect computation.

Implements StatefulPerTrackEffect.

Definition at line 85 of file NoiseBase.cpp.

{
   float* buffer = outbuf[0];
 
   float white;
   float amplitude;
   float div = ((float)RAND_MAX) / 2.0f;
 
   switch (mType)
   {
   default:
   case kWhite: // white
      for (decltype(size) i = 0; i < size; i++)
      {
         buffer[i] = mAmp * ((rand() / div) - 1.0f);
      }
      break;
 
   case kPink: // pink
      // based on Paul Kellet's "instrumentation grade" algorithm.
 
      // 0.129f is an experimental normalization factor.
      amplitude = mAmp * 0.129f;
      for (decltype(size) i = 0; i < size; i++)
      {
         white = (rand() / div) - 1.0f;
         buf0 = 0.99886f * buf0 + 0.0555179f * white;
         buf1 = 0.99332f * buf1 + 0.0750759f * white;
         buf2 = 0.96900f * buf2 + 0.1538520f * white;
         buf3 = 0.86650f * buf3 + 0.3104856f * white;
         buf4 = 0.55000f * buf4 + 0.5329522f * white;
         buf5 = -0.7616f * buf5 - 0.0168980f * white;
         buffer[i] = amplitude * (buf0 + buf1 + buf2 + buf3 + buf4 + buf5 +
                                  buf6 + white * 0.5362);
         buf6 = white * 0.115926;
      }
      break;
 
   case kBrownian: // Brownian
      // float leakage=0.997; // experimental value at 44.1kHz
      // double scaling = 0.05; // experimental value at 44.1kHz
      // min and max protect against instability at extreme sample rates.
      float leakage = ((mSampleRate - 144.0) / mSampleRate < 0.9999) ?
                         (mSampleRate - 144.0) / mSampleRate :
                         0.9999f;
 
      float scaling =
         (9.0 / sqrt(mSampleRate) > 0.01) ? 9.0 / sqrt(mSampleRate) : 0.01f;
 
      for (decltype(size) i = 0; i < size; i++)
      {
         white = (rand() / div) - 1.0f;
         z = leakage * y + white * scaling;
         y = fabs(z) > 1.0 ? leakage * y - white * scaling : z;
         buffer[i] = mAmp * y;
      }
      break;
   }
 
   return size;
}

References buf0, buf1, buf2, buf3, buf4, buf5, buf6, kBrownian, kPink, kWhite, mAmp, mSampleRate, mType, size, staffpad::audio::simd::sqrt(), y, and z.

Here is the call graph for this function:

◆ ProcessInitialize()

bool NoiseBase::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 StatefulEffectBase.

Definition at line 78 of file NoiseBase.cpp.

{
   mSampleRate = sampleRate;
   return true;
}

References mSampleRate, and anonymous_namespace{ClipSegmentTest.cpp}::sampleRate.

Member Data Documentation

◆ Amp

constexpr EffectParameter NoiseBase::Amp

staticconstexprprotected

Initial value:

{
      &NoiseBase::mAmp, L"Amplitude", 0.8, 0.0, 1.0, 1
   }

Definition at line 68 of file NoiseBase.h.

Referenced by EffectNoise::PopulateOrExchange().

◆ buf0

float NoiseBase::buf0

protected

Definition at line 52 of file NoiseBase.h.

Referenced by NoiseBase(), and ProcessBlock().

◆ buf1

float NoiseBase::buf1

protected

Definition at line 52 of file NoiseBase.h.

Referenced by NoiseBase(), and ProcessBlock().

◆ buf2

float NoiseBase::buf2

protected

Definition at line 52 of file NoiseBase.h.

Referenced by NoiseBase(), and ProcessBlock().

◆ buf3

float NoiseBase::buf3

protected

Definition at line 52 of file NoiseBase.h.

Referenced by NoiseBase(), and ProcessBlock().

◆ buf4

float NoiseBase::buf4

protected

Definition at line 52 of file NoiseBase.h.

Referenced by NoiseBase(), and ProcessBlock().

◆ buf5

float NoiseBase::buf5

protected

Definition at line 52 of file NoiseBase.h.

Referenced by NoiseBase(), and ProcessBlock().

◆ buf6

float NoiseBase::buf6

protected

Definition at line 52 of file NoiseBase.h.

Referenced by NoiseBase(), and ProcessBlock().

◆ kTypeStrings

const EnumValueSymbol NoiseBase::kTypeStrings

staticprotected

Initial value:

= {
   
   { XC("White", "noise") },
   
   { XC("Pink", "noise") },
   
   { XC("Brownian", "noise") }
}

Definition at line 63 of file NoiseBase.h.

Referenced by EffectNoise::PopulateOrExchange().

◆ mAmp

double NoiseBase::mAmp

protected

Definition at line 50 of file NoiseBase.h.

Referenced by EffectNoise::PopulateOrExchange(), and ProcessBlock().

◆ mSampleRate

double NoiseBase::mSampleRate {}

protected

Definition at line 48 of file NoiseBase.h.

Referenced by ProcessBlock(), and ProcessInitialize().

◆ mType

int NoiseBase::mType

protected

Definition at line 49 of file NoiseBase.h.

Referenced by EffectNoise::PopulateOrExchange(), and ProcessBlock().

◆ Symbol

const ComponentInterfaceSymbol NoiseBase::Symbol { XO("Noise") }

static

Definition at line 22 of file NoiseBase.h.

Referenced by GetSymbol().

◆ Type

constexpr EnumParameter NoiseBase::Type

staticconstexprprotected

Initial value:

{
      &NoiseBase::mType, L"Type", kWhite, 0, nTypes - 1, 1, kTypeStrings, nTypes
   }

Definition at line 65 of file NoiseBase.h.

◆ y

float NoiseBase::y

protected

Definition at line 52 of file NoiseBase.h.

Referenced by NoiseBase(), and ProcessBlock().

◆ z

float NoiseBase::z

protected

Definition at line 52 of file NoiseBase.h.

Referenced by NoiseBase(), and ProcessBlock().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ kTypes

Constructor & Destructor Documentation

◆ NoiseBase()

◆ ~NoiseBase()

Member Function Documentation

◆ FetchParameters()

◆ GetAudioOutCount()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ ManualPage()

◆ Parameters()

◆ ProcessBlock()

◆ ProcessInitialize()

Member Data Documentation

◆ Amp

◆ buf0

◆ buf1

◆ buf2

◆ buf3

◆ buf4

◆ buf5

◆ buf6

◆ kTypeStrings

◆ mAmp

◆ mSampleRate

◆ mType

◆ Symbol

◆ Type

◆ y

◆ z