Implements the Auto Ducking effect. More...

#include <AutoDuck.h>

Inheritance diagram for EffectAutoDuck:

Collaboration diagram for EffectAutoDuck:

Classes
class	Panel

Public Member Functions
	EffectAutoDuck ()

virtual	~EffectAutoDuck ()

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

bool	Init () override

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

std::unique_ptr< EffectEditor >	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

bool	DoTransferDataToWindow ()

bool	TransferDataFromWindow (EffectSettings &settings) override

Public Member Functions inherited from StatefulEffect
	~StatefulEffect () override

std::shared_ptr< EffectInstance >	MakeInstance () const override
	Make an object maintaining short-term state of an Effect. 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 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

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

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

Public Member Functions inherited from StatefulEffectUIServices
	~StatefulEffectUIServices () override

std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
	Allows PopulateOrExchange to return null. More...

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

virtual bool	TransferDataToWindow (const EffectSettings &settings)

virtual bool	TransferDataFromWindow (EffectSettings &settings)

Public Member Functions inherited from BasicEffectUIServices
int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override

void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override

OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override

void	ShowOptions (const EffectPlugin &plugin) const override

bool	ValidateUI (const EffectPlugin &context, EffectSettings &) const override

bool	CloseUI () const override

Public Member Functions inherited from EffectUIServices
virtual	~EffectUIServices ()

virtual int	ShowHostInterface (EffectBase &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)

virtual int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0

virtual std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
	Adds controls to a panel that is given as the parent window of `S` More...

virtual void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0

virtual OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0

virtual void	ShowOptions (const EffectPlugin &plugin) const =0

virtual bool	ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0

virtual bool	CloseUI () const =0

Static Public Member Functions
static EffectAutoDuck *	FetchParameters (EffectAutoDuck &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 Member Functions inherited from EffectUIServices
static int	DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

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

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

Private Member Functions
bool	ApplyDuckFade (int trackNum, WaveChannel &track, double t0, double t1)

void	OnValueChanged (wxCommandEvent &evt)

const EffectParameterMethods &	Parameters () const override

Private Attributes
wxWeakRef< wxWindow >	mUIParent {}

double	mDuckAmountDb

double	mInnerFadeDownLen

double	mInnerFadeUpLen

double	mOuterFadeDownLen

double	mOuterFadeUpLen

double	mThresholdDb

double	mMaximumPause

const WaveTrack *	mControlTrack {}

wxTextCtrl *	mDuckAmountDbBox

wxTextCtrl *	mInnerFadeDownLenBox

wxTextCtrl *	mInnerFadeUpLenBox

wxTextCtrl *	mOuterFadeDownLenBox

wxTextCtrl *	mOuterFadeUpLenBox

wxTextCtrl *	mThresholdDbBox

wxTextCtrl *	mMaximumPauseBox

Panel *	mPanel {}

Static Private Attributes
static constexpr EffectParameter	DuckAmountDb

static constexpr EffectParameter	InnerFadeDownLen

static constexpr EffectParameter	InnerFadeUpLen

static constexpr EffectParameter	OuterFadeDownLen

static constexpr EffectParameter	OuterFadeUpLen

static constexpr EffectParameter	ThresholdDb

static constexpr EffectParameter	MaximumPause

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 Types inherited from EffectUIServices
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

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 }

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 inherited from EffectBase
wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Detailed Description

Implements the Auto Ducking effect.

Definition at line 26 of file AutoDuck.h.

Constructor & Destructor Documentation

◆ EffectAutoDuck()

EffectAutoDuck::EffectAutoDuck ( )

Definition at line 87 of file AutoDuck.cpp.

{
   Parameters().Reset(*this);
   SetLinearEffectFlag(true);
}

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectAutoDuck()

EffectAutoDuck::~EffectAutoDuck ( )

virtual

Definition at line 93 of file AutoDuck.cpp.

94{

95}

Member Function Documentation

◆ ApplyDuckFade()

bool EffectAutoDuck::ApplyDuckFade	(	int	trackNum,
		WaveChannel &	track,
		double	t0,
		double	t1
	)

private

Definition at line 468 of file AutoDuck.cpp.

{
   bool cancel = false;
 
   auto start = track.TimeToLongSamples(t0);
   auto end = track.TimeToLongSamples(t1);
 
   Floats buf{ kBufSize };
   auto pos = start;
 
   auto fadeDownSamples = track.TimeToLongSamples(
      mOuterFadeDownLen + mInnerFadeDownLen);
   if (fadeDownSamples < 1)
      fadeDownSamples = 1;
 
   auto fadeUpSamples = track.TimeToLongSamples(
      mOuterFadeUpLen + mInnerFadeUpLen);
   if (fadeUpSamples < 1)
      fadeUpSamples = 1;
 
   float fadeDownStep = mDuckAmountDb / fadeDownSamples.as_double();
   float fadeUpStep = mDuckAmountDb / fadeUpSamples.as_double();
 
   while (pos < end) {
      const auto len = limitSampleBufferSize(kBufSize, end - pos);
      track.GetFloats(buf.get(), pos, len);
      for (auto i = pos; i < pos + len; ++i) {
         float gainDown = fadeDownStep * (i - start).as_float();
         float gainUp = fadeUpStep * (end - i).as_float();
 
         float gain;
         if (gainDown > gainUp)
            gain = gainDown;
         else
            gain = gainUp;
         if (gain < mDuckAmountDb)
            gain = mDuckAmountDb;
 
         // i - pos is bounded by len:
         buf[ ( i - pos ).as_size_t() ] *= DB_TO_LINEAR(gain);
      }
 
      if (!track.Set((samplePtr)buf.get(), floatSample, pos, len)) {
         cancel = true;
         break;
      }
 
      pos += len;
 
      float curTime = track.LongSamplesToTime(pos);
      float fractionFinished = (curTime - mT0) / (mT1 - mT0);
      if (TotalProgress((trackNum + 1 + fractionFinished) /
         (GetNumWaveTracks() + 1))
      ) {
         cancel = true;
         break;
      }
   }
 
   return cancel;
}

References DB_TO_LINEAR, PackedArray::end(), floatSample, WaveChannel::GetFloats(), Effect::GetNumWaveTracks(), kBufSize, limitSampleBufferSize(), WideSampleSequence::LongSamplesToTime(), mDuckAmountDb, mInnerFadeDownLen, mInnerFadeUpLen, mOuterFadeDownLen, mOuterFadeUpLen, EffectBase::mT0, EffectBase::mT1, WaveChannel::Set(), WideSampleSequence::TimeToLongSamples(), and Effect::TotalProgress().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoTransferDataToWindow()

bool EffectAutoDuck::DoTransferDataToWindow ( )

Definition at line 444 of file AutoDuck.cpp.

{
   // Issue 2324: don't remove these two lines
   if (!mUIParent->TransferDataToWindow())
      return false;
 
   mPanel->Refresh(false);
 
   return true;
}

References mPanel, and mUIParent.

Referenced by TransferDataToWindow().

Here is the caller graph for this function:

◆ FetchParameters()

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

inlinestatic

Definition at line 30 of file AutoDuck.h.

30{ return &e; }

◆ GetDescription()

TranslatableString EffectAutoDuck::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 104 of file AutoDuck.cpp.

{
   return XO("Reduces (ducks) the volume of one or more tracks whenever the volume of a specified \"control\" track reaches a particular level");
}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectAutoDuck::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 99 of file AutoDuck.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType EffectAutoDuck::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 116 of file AutoDuck.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

◆ Init()

bool EffectAutoDuck::Init ( )

overridevirtual

Default implementation does nothing, returns true

Reimplemented from StatefulEffectBase.

Definition at line 123 of file AutoDuck.cpp.

{
   mControlTrack = nullptr;
 
   // Find the control track, which is the non-selected wave track immediately
   // after the last selected wave track.  Fail if there is no such track or if
   // any selected track is not a wave track.
   bool lastWasSelectedWaveTrack = false;
   const WaveTrack *controlTrackCandidate = nullptr;
   for (auto t : *inputTracks()) {
      if (lastWasSelectedWaveTrack && !t->GetSelected())
         // This could be the control track, so remember it
         controlTrackCandidate = dynamic_cast<const WaveTrack *>(t);
 
      lastWasSelectedWaveTrack = false;
      if (t->GetSelected()) {
         bool ok = t->TypeSwitch<bool>(
            [&](const WaveTrack &) {
               lastWasSelectedWaveTrack = true;
               controlTrackCandidate = nullptr;
               return true;
            },
            [&](const Track &) {
               EffectUIServices::DoMessageBox(*this,
                  /* i18n-hint: Auto duck is the name of an effect that 'ducks'
                   (reduces the volume) of the audio automatically when there is
                   sound on another track.  Not as in 'Donald-Duck'!*/
                  XO("You selected a track which does not contain audio. "
                     "AutoDuck can only process audio tracks."),
                  wxICON_ERROR);
               return false;
            }
         );
         if (!ok)
            return false;
      }
   }
 
   if (!controlTrackCandidate) {
      EffectUIServices::DoMessageBox(*this,
         /* i18n-hint: Auto duck is the name of an effect that 'ducks' (reduces
          the volume) of the audio automatically when there is sound on another
          track.  Not as in 'Donald-Duck'!*/
         XO("Auto Duck needs a control track which must be placed below the "
            "selected track(s)."),
         wxICON_ERROR);
      return false;
   }
 
   mControlTrack = controlTrackCandidate;
   return true;
}

References EffectUIServices::DoMessageBox(), EffectBase::inputTracks(), mControlTrack, Track::TypeSwitch(), and XO().

Here is the call graph for this function:

◆ ManualPage()

ManualPageID EffectAutoDuck::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 109 of file AutoDuck.cpp.

{
   return L"Auto_Duck";
}

◆ OnValueChanged()

void EffectAutoDuck::OnValueChanged ( wxCommandEvent & evt )

private

Definition at line 531 of file AutoDuck.cpp.

{
   mPanel->Refresh(false);
}

References mPanel.

◆ Parameters()

const EffectParameterMethods & EffectAutoDuck::Parameters ( ) const

overrideprivatevirtual

Reimplemented from Effect.

Definition at line 42 of file AutoDuck.cpp.

{
   static CapturedParameters<EffectAutoDuck,
      DuckAmountDb, InnerFadeDownLen, InnerFadeUpLen, OuterFadeDownLen,
      OuterFadeUpLen, ThresholdDb, MaximumPause
   > parameters;
   return parameters;
}

References DuckAmountDb, EffectAutoDuck(), InnerFadeDownLen, InnerFadeUpLen, MaximumPause, OuterFadeDownLen, OuterFadeUpLen, and ThresholdDb.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > EffectAutoDuck::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 PopulateUI instead of a DefaultEffectEditor; default implementation returns null

Reimplemented from StatefulEffectUIServices.

Definition at line 361 of file AutoDuck.cpp.

{
   mUIParent = S.GetParent();
   S.SetBorder(5);
   S.StartVerticalLay(true);
   {
      S.AddSpace(0, 5);
 
      mPanel = safenew EffectAutoDuck::Panel(S.GetParent(), wxID_ANY, this);
      S.AddWindow(mPanel);
 
      S.AddSpace(0, 5);
 
      S.StartMultiColumn(6, wxCENTER);
      {
         mDuckAmountDbBox = S.Validator<FloatingPointValidator<double>>(
               1, &mDuckAmountDb, NumValidatorStyle::NO_TRAILING_ZEROES,
               DuckAmountDb.min, DuckAmountDb.max )
            .NameSuffix(XO("db"))
            .AddTextBox(XXO("Duck &amount:"), wxT(""), 10);
         S.AddUnits(XO("dB"));
 
         mMaximumPauseBox = S.Validator<FloatingPointValidator<double>>(
               2, &mMaximumPause, NumValidatorStyle::NO_TRAILING_ZEROES,
               MaximumPause.min, MaximumPause.max )
            .NameSuffix(XO("seconds"))
            .AddTextBox(XXO("Ma&ximum pause:"), wxT(""), 10);
         S.AddUnits(XO("seconds"));
 
         mOuterFadeDownLenBox = S.Validator<FloatingPointValidator<double>>(
               2, &mOuterFadeDownLen, NumValidatorStyle::NO_TRAILING_ZEROES,
               OuterFadeDownLen.min, OuterFadeDownLen.max )
            .NameSuffix(XO("seconds"))
            .AddTextBox(XXO("Outer fade &down length:"), wxT(""), 10);
         S.AddUnits(XO("seconds"));
 
         mOuterFadeUpLenBox = S.Validator<FloatingPointValidator<double>>(
               2, &mOuterFadeUpLen, NumValidatorStyle::NO_TRAILING_ZEROES,
               OuterFadeUpLen.min, OuterFadeUpLen.max )
            .NameSuffix(XO("seconds"))
            .AddTextBox(XXO("Outer fade &up length:"), wxT(""), 10);
         S.AddUnits(XO("seconds"));
 
         mInnerFadeDownLenBox = S.Validator<FloatingPointValidator<double>>(
               2, &mInnerFadeDownLen, NumValidatorStyle::NO_TRAILING_ZEROES,
               InnerFadeDownLen.min, InnerFadeDownLen.max )
            .NameSuffix(XO("seconds"))
            .AddTextBox(XXO("Inner fade d&own length:"), wxT(""), 10);
         S.AddUnits(XO("seconds"));
 
         mInnerFadeUpLenBox = S.Validator<FloatingPointValidator<double>>(
               2, &mInnerFadeUpLen, NumValidatorStyle::NO_TRAILING_ZEROES,
               InnerFadeUpLen.min, InnerFadeUpLen.max )
            .NameSuffix(XO("seconds"))
            .AddTextBox(XXO("Inner &fade up length:"), wxT(""), 10);
         S.AddUnits(XO("seconds"));
      }
      S.EndMultiColumn();
 
      S.StartMultiColumn(3, wxCENTER);
      {
         mThresholdDbBox = S.Validator<FloatingPointValidator<double>>(
               2, &mThresholdDb, NumValidatorStyle::NO_TRAILING_ZEROES,
               ThresholdDb.min, ThresholdDb.max )
            .NameSuffix(XO("db"))
            .AddTextBox(XXO("&Threshold:"), wxT(""), 10);
         S.AddUnits(XO("dB"));
      }
      S.EndMultiColumn();
 
   }
   S.EndVerticalLay();
 
   return nullptr;
}

References DuckAmountDb, InnerFadeDownLen, InnerFadeUpLen, EffectParameter< Structure, Member, Type, Value >::max, MaximumPause, mDuckAmountDb, mDuckAmountDbBox, EffectParameter< Structure, Member, Type, Value >::min, mInnerFadeDownLen, mInnerFadeDownLenBox, mInnerFadeUpLen, mInnerFadeUpLenBox, mMaximumPause, mMaximumPauseBox, mOuterFadeDownLen, mOuterFadeDownLenBox, mOuterFadeUpLen, mOuterFadeUpLenBox, mPanel, mThresholdDb, mThresholdDbBox, mUIParent, OuterFadeDownLen, OuterFadeUpLen, S, safenew, ThresholdDb, wxT(), XO(), and XXO().

Here is the call graph for this function:

◆ Process()

bool EffectAutoDuck::Process	(	EffectInstance &	instance,
		EffectSettings &	settings
	)

overridevirtual

Implements StatefulEffectBase.

Definition at line 176 of file AutoDuck.cpp.

{
   if (GetNumWaveTracks() == 0 || !mControlTrack)
      return false;
 
   bool cancel = false;
 
   auto start =
      mControlTrack->TimeToLongSamples(mT0 + mOuterFadeDownLen);
   auto end =
      mControlTrack->TimeToLongSamples(mT1 - mOuterFadeUpLen);
 
   if (end <= start)
      return false;
 
   TrackListHolder tempTracks;
   auto pControlTrack = mControlTrack;
   // If there is any stretch in the control track, substitute a temporary
   // rendering before trying to use GetFloats
   {
      auto &clips = pControlTrack->GetClips();
      const auto t0 = pControlTrack->LongSamplesToTime(start);
      const auto t1 = pControlTrack->LongSamplesToTime(end);
      if (WaveTrackUtilities::HasStretch(*pControlTrack, t0, t1)) {
         tempTracks = pControlTrack->Duplicate();
         if (tempTracks) {
            const auto pFirstTrack = *tempTracks->Any<WaveTrack>().begin();
            if (pFirstTrack)
            {
               using namespace BasicUI;
               const auto progress = MakeProgress(
                  XO("Pre-processing"),
                  XO("Rendering Control-Track Time-Stretched Audio"),
                  ProgressShowCancel);
               pFirstTrack->ApplyStretchRatio(
                  { { t0, t1 } }, [&](double progressFraction) {
                     const auto result =
                        progress->Poll(progressFraction * 1000, 1000);
                     if (result != ProgressResult::Success)
                        throw UserException {};
                  });
               pControlTrack = pFirstTrack;
            }
         }
      }
   }
 
   // the minimum number of samples we have to wait until the maximum
   // pause has been exceeded
   double maxPause = mMaximumPause;
 
   // We don't fade in until we have time enough to actually fade out again
   if (maxPause < mOuterFadeDownLen + mOuterFadeUpLen)
      maxPause = mOuterFadeDownLen + mOuterFadeUpLen;
 
   auto minSamplesPause =
      pControlTrack->TimeToLongSamples(maxPause);
 
   double threshold = DB_TO_LINEAR(mThresholdDb);
 
   // adjust the threshold so we can compare it to the rmsSum value
   threshold = threshold * threshold * kRMSWindowSize;
 
   int rmsPos = 0;
   double rmsSum = 0;
   // to make the progress bar appear more natural, we first look for all
   // duck regions and apply them all at once afterwards
   std::vector<AutoDuckRegion> regions;
   bool inDuckRegion = false;
   {
      Floats rmsWindow{ kRMSWindowSize, true };
 
      Floats buf{ kBufSize };
 
      // initialize the following two variables to prevent compiler warning
      double duckRegionStart = 0;
      sampleCount curSamplesPause = 0;
 
      auto pos = start;
 
      while (pos < end)
      {
         const auto len = limitSampleBufferSize( kBufSize, end - pos );
 
         pControlTrack->GetFloats(buf.get(), pos, len);
 
         for (auto i = pos; i < pos + len; i++)
         {
            rmsSum -= rmsWindow[rmsPos];
            // i - pos is bounded by len:
            auto index = ( i - pos ).as_size_t();
            rmsWindow[rmsPos] = buf[ index ] * buf[ index ];
            rmsSum += rmsWindow[rmsPos];
            rmsPos = (rmsPos + 1) % kRMSWindowSize;
 
            bool thresholdExceeded = rmsSum > threshold;
 
            if (thresholdExceeded)
            {
               // everytime the threshold is exceeded, reset our count for
               // the number of pause samples
               curSamplesPause = 0;
 
               if (!inDuckRegion)
               {
                  // the threshold has been exceeded for the first time, so
                  // let the duck region begin here
                  inDuckRegion = true;
                  duckRegionStart = pControlTrack->LongSamplesToTime(i);
               }
            }
 
            if (!thresholdExceeded && inDuckRegion)
            {
               // the threshold has not been exceeded and we are in a duck
               // region, but only fade in if the maximum pause has been
               // exceeded
               curSamplesPause += 1;
 
               if (curSamplesPause >= minSamplesPause)
               {
                  // do the actual duck fade and reset all values
                  double duckRegionEnd =
                     pControlTrack->LongSamplesToTime(i - curSamplesPause);
 
                  regions.push_back(AutoDuckRegion(
                     duckRegionStart - mOuterFadeDownLen,
                     duckRegionEnd + mOuterFadeUpLen));
 
                  inDuckRegion = false;
               }
            }
         }
 
         pos += len;
 
         if (TotalProgress(
            (pos - start).as_double() /
            (end - start).as_double() /
            (GetNumWaveTracks() + 1)
         ))
         {
            cancel = true;
            break;
         }
      }
 
      // apply last duck fade, if any
      if (inDuckRegion)
      {
         double duckRegionEnd =
            pControlTrack->LongSamplesToTime(end - curSamplesPause);
         regions.push_back(AutoDuckRegion(
            duckRegionStart - mOuterFadeDownLen,
            duckRegionEnd + mOuterFadeUpLen));
      }
   }
 
   if (!cancel) {
      EffectOutputTracks outputs { *mTracks, {{ mT0, mT1 }} };
 
      int trackNum = 0;
 
      for (auto iterTrack : outputs.Get().Selected<WaveTrack>()) {
         for (const auto pChannel : iterTrack->Channels())
            for (size_t i = 0; i < regions.size(); ++i) {
               const AutoDuckRegion& region = regions[i];
               if (ApplyDuckFade(trackNum++, *pChannel, region.t0, region.t1)) {
                  cancel = true;
                  goto done;
               }
            }
 
         done:
         if (cancel)
            break;
      }
 
      if (!cancel)
         outputs.Commit();
   }
 
   return !cancel;
}

References ApplyDuckFade(), PackedArray::begin(), DB_TO_LINEAR, PackedArray::end(), WaveTrack::GetClips(), Effect::GetNumWaveTracks(), WaveTrackUtilities::HasStretch(), kBufSize, kRMSWindowSize, limitSampleBufferSize(), BasicUI::MakeProgress(), mControlTrack, mMaximumPause, mOuterFadeDownLen, mOuterFadeUpLen, EffectBase::mT0, EffectBase::mT1, mThresholdDb, EffectBase::mTracks, BasicUI::ProgressShowCancel, BasicUI::Success, AutoDuckRegion::t0, AutoDuckRegion::t1, WideSampleSequence::TimeToLongSamples(), Effect::TotalProgress(), and XO().

Here is the call graph for this function:

◆ TransferDataFromWindow()

bool EffectAutoDuck::TransferDataFromWindow ( EffectSettings & settings )

overridevirtual

Update the given settings from controls; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 455 of file AutoDuck.cpp.

{
   if (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
   {
      return false;
   }
 
   return true;
}

References mUIParent.

◆ TransferDataToWindow()

bool EffectAutoDuck::TransferDataToWindow ( const EffectSettings & settings )

overridevirtual

Update controls for the settings; default does nothing, returns true

Reimplemented from StatefulEffectUIServices.

Definition at line 439 of file AutoDuck.cpp.

{
   return DoTransferDataToWindow();
}

References DoTransferDataToWindow().

Here is the call graph for this function:

Member Data Documentation

◆ DuckAmountDb

constexpr EffectParameter EffectAutoDuck::DuckAmountDb

staticconstexprprivate

Initial value:

{ &EffectAutoDuck::mDuckAmountDb,

L"DuckAmountDb", -12.0, -24.0, 0.0, 1 }

Definition at line 91 of file AutoDuck.h.

Referenced by EffectAutoDuck::Panel::OnMotion(), EffectAutoDuck::Panel::OnPaint(), Parameters(), and PopulateOrExchange().

◆ InnerFadeDownLen

constexpr EffectParameter EffectAutoDuck::InnerFadeDownLen

staticconstexprprivate

Initial value:

{ &EffectAutoDuck::mInnerFadeDownLen,

L"InnerFadeDownLen", 0.0, 0.0, 3.0, 1 }

Definition at line 93 of file AutoDuck.h.

Referenced by EffectAutoDuck::Panel::OnMotion(), EffectAutoDuck::Panel::OnPaint(), Parameters(), and PopulateOrExchange().

◆ InnerFadeUpLen

constexpr EffectParameter EffectAutoDuck::InnerFadeUpLen

staticconstexprprivate

Initial value:

{ &EffectAutoDuck::mInnerFadeUpLen,

L"InnerFadeUpLen", 0.0, 0.0, 3.0, 1 }

Definition at line 95 of file AutoDuck.h.

Referenced by EffectAutoDuck::Panel::OnMotion(), EffectAutoDuck::Panel::OnPaint(), Parameters(), and PopulateOrExchange().

◆ MaximumPause

constexpr EffectParameter EffectAutoDuck::MaximumPause

staticconstexprprivate

Initial value:

{ &EffectAutoDuck::mMaximumPause,

L"MaximumPause", 1.0, 0.0, DBL_MAX, 1 }

Definition at line 103 of file AutoDuck.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ mControlTrack

const WaveTrack* EffectAutoDuck::mControlTrack {}

private

Definition at line 75 of file AutoDuck.h.

Referenced by Init(), and Process().

◆ mDuckAmountDb

double EffectAutoDuck::mDuckAmountDb

private

Definition at line 67 of file AutoDuck.h.

Referenced by ApplyDuckFade(), and PopulateOrExchange().

◆ mDuckAmountDbBox

wxTextCtrl* EffectAutoDuck::mDuckAmountDbBox

private

Definition at line 77 of file AutoDuck.h.

Referenced by PopulateOrExchange().

◆ mInnerFadeDownLen

double EffectAutoDuck::mInnerFadeDownLen

private

Definition at line 68 of file AutoDuck.h.

Referenced by ApplyDuckFade(), and PopulateOrExchange().

◆ mInnerFadeDownLenBox

wxTextCtrl* EffectAutoDuck::mInnerFadeDownLenBox

private

Definition at line 78 of file AutoDuck.h.

Referenced by PopulateOrExchange().

◆ mInnerFadeUpLen

double EffectAutoDuck::mInnerFadeUpLen

private

Definition at line 69 of file AutoDuck.h.

Referenced by ApplyDuckFade(), and PopulateOrExchange().

◆ mInnerFadeUpLenBox

wxTextCtrl* EffectAutoDuck::mInnerFadeUpLenBox

private

Definition at line 79 of file AutoDuck.h.

Referenced by PopulateOrExchange().

◆ mMaximumPause

double EffectAutoDuck::mMaximumPause

private

Definition at line 73 of file AutoDuck.h.

Referenced by PopulateOrExchange(), and Process().

◆ mMaximumPauseBox

wxTextCtrl* EffectAutoDuck::mMaximumPauseBox

private

Definition at line 83 of file AutoDuck.h.

Referenced by PopulateOrExchange().

◆ mOuterFadeDownLen

double EffectAutoDuck::mOuterFadeDownLen

private

Definition at line 70 of file AutoDuck.h.

Referenced by ApplyDuckFade(), PopulateOrExchange(), and Process().

◆ mOuterFadeDownLenBox

wxTextCtrl* EffectAutoDuck::mOuterFadeDownLenBox

private

Definition at line 80 of file AutoDuck.h.

Referenced by PopulateOrExchange().

◆ mOuterFadeUpLen

double EffectAutoDuck::mOuterFadeUpLen

private

Definition at line 71 of file AutoDuck.h.

Referenced by ApplyDuckFade(), PopulateOrExchange(), and Process().

◆ mOuterFadeUpLenBox

wxTextCtrl* EffectAutoDuck::mOuterFadeUpLenBox

private

Definition at line 81 of file AutoDuck.h.

Referenced by PopulateOrExchange().

◆ mPanel

Panel* EffectAutoDuck::mPanel {}

private

Definition at line 86 of file AutoDuck.h.

Referenced by DoTransferDataToWindow(), OnValueChanged(), and PopulateOrExchange().

◆ mThresholdDb

double EffectAutoDuck::mThresholdDb

private

Definition at line 72 of file AutoDuck.h.

Referenced by PopulateOrExchange(), and Process().

◆ mThresholdDbBox

wxTextCtrl* EffectAutoDuck::mThresholdDbBox

private

Definition at line 82 of file AutoDuck.h.

Referenced by PopulateOrExchange().

◆ mUIParent

wxWeakRef<wxWindow> EffectAutoDuck::mUIParent {}

private

Definition at line 65 of file AutoDuck.h.

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

◆ OuterFadeDownLen

constexpr EffectParameter EffectAutoDuck::OuterFadeDownLen

staticconstexprprivate

Initial value:

{ &EffectAutoDuck::mOuterFadeDownLen,

L"OuterFadeDownLen", 0.5, 0.0, 3.0, 1 }

Definition at line 97 of file AutoDuck.h.

Referenced by EffectAutoDuck::Panel::OnMotion(), EffectAutoDuck::Panel::OnPaint(), Parameters(), and PopulateOrExchange().

◆ OuterFadeUpLen

constexpr EffectParameter EffectAutoDuck::OuterFadeUpLen

staticconstexprprivate

Initial value:

{ &EffectAutoDuck::mOuterFadeUpLen,

L"OuterFadeUpLen", 0.5, 0.0, 3.0, 1 }

Definition at line 99 of file AutoDuck.h.

Referenced by EffectAutoDuck::Panel::OnMotion(), EffectAutoDuck::Panel::OnPaint(), Parameters(), and PopulateOrExchange().

◆ Symbol

const ComponentInterfaceSymbol EffectAutoDuck::Symbol { XO("Auto Duck") }

static

Definition at line 31 of file AutoDuck.h.

Referenced by GetSymbol().

◆ ThresholdDb

constexpr EffectParameter EffectAutoDuck::ThresholdDb

staticconstexprprivate

Initial value:

{ &EffectAutoDuck::mThresholdDb,

L"ThresholdDb", -30.0, -100.0, 0.0, 1 }

Definition at line 101 of file AutoDuck.h.

Referenced by Parameters(), and PopulateOrExchange().

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

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EffectAutoDuck()

◆ ~EffectAutoDuck()

Member Function Documentation

◆ ApplyDuckFade()

◆ DoTransferDataToWindow()

◆ FetchParameters()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ Init()

◆ ManualPage()

◆ OnValueChanged()

◆ Parameters()

◆ PopulateOrExchange()

◆ Process()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

Member Data Documentation

◆ DuckAmountDb

◆ InnerFadeDownLen

◆ InnerFadeUpLen

◆ MaximumPause

◆ mControlTrack

◆ mDuckAmountDb

◆ mDuckAmountDbBox

◆ mInnerFadeDownLen

◆ mInnerFadeDownLenBox

◆ mInnerFadeUpLen

◆ mInnerFadeUpLenBox

◆ mMaximumPause

◆ mMaximumPauseBox

◆ mOuterFadeDownLen

◆ mOuterFadeDownLenBox

◆ mOuterFadeUpLen

◆ mOuterFadeUpLenBox

◆ mPanel

◆ mThresholdDb

◆ mThresholdDbBox

◆ mUIParent

◆ OuterFadeDownLen

◆ OuterFadeUpLen

◆ Symbol

◆ ThresholdDb