An Extreme Time Stretch and Time Smear effect. More...

#include <Paulstretch.h>

Inheritance diagram for EffectPaulstretch:

Collaboration diagram for EffectPaulstretch:

Public Member Functions
	EffectPaulstretch ()

virtual	~EffectPaulstretch ()

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

double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const 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	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

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)

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 EffectPaulstretch *	FetchParameters (EffectPaulstretch &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("Paulstretch") }

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
void	OnText (wxCommandEvent &evt)

size_t	GetBufferSize (double rate) const

bool	ProcessOne (const WaveChannel &track, WaveChannel &outputTrack, double t0, double t1, int count)

const EffectParameterMethods &	Parameters () const override

Private Attributes
wxWeakRef< wxWindow >	mUIParent

float	mAmount

float	mTime_resolution

Static Private Attributes
static constexpr EffectParameter	Amount

static constexpr EffectParameter	Time

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
double	mF0 {}

double	mF1 {}

wxArrayString	mPresetNames

unsigned	mUIFlags { 0 }

Detailed Description

An Extreme Time Stretch and Time Smear effect.

Definition at line 21 of file Paulstretch.h.

Constructor & Destructor Documentation

◆ EffectPaulstretch()

EffectPaulstretch::EffectPaulstretch ( )

Definition at line 97 of file Paulstretch.cpp.

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

Referenced by Parameters().

Here is the caller graph for this function:

◆ ~EffectPaulstretch()

EffectPaulstretch::~EffectPaulstretch ( )

virtual

Definition at line 104 of file Paulstretch.cpp.

105{

106}

Member Function Documentation

◆ CalcPreviewInputLength()

double EffectPaulstretch::CalcPreviewInputLength	(	const EffectSettings &	settings,
		double	previewLength
	)		const

overridevirtual

Implements EffectBase.

Definition at line 134 of file Paulstretch.cpp.

{
   // FIXME: Preview is currently at the project rate, but should really be
   // at the track rate (bugs 1284 and 852).
   auto minDuration = GetBufferSize(mProjectRate) * 2 + 1;
 
   // Preview playback may need to be trimmed but this is the smallest selection that we can use.
   double minLength = std::max<double>(minDuration / mProjectRate, previewLength / mAmount);
 
   return minLength;
}

References GetBufferSize(), mAmount, and EffectBase::mProjectRate.

Here is the call graph for this function:

◆ FetchParameters()

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

inlinestatic

Definition at line 25 of file Paulstretch.h.

25{ return &e; }

◆ GetBufferSize()

size_t EffectPaulstretch::GetBufferSize ( double rate ) const

private

Definition at line 251 of file Paulstretch.cpp.

{
   // Audacity's fft requires a power of 2
   float tmp = rate * mTime_resolution / 2.0;
   tmp = log(tmp) / log(2.0);
   tmp = pow(2.0, floor(tmp + 0.5));
 
   auto stmp = size_t(tmp);
   if (stmp != tmp)
      // overflow
      return 0;
   if (stmp >= 2 * stmp)
      // overflow
      return 0;
 
   return std::max<size_t>(stmp, 128);
}

References mTime_resolution.

Referenced by CalcPreviewInputLength(), and ProcessOne().

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString EffectPaulstretch::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 115 of file Paulstretch.cpp.

{
   return XO("Paulstretch is only for an extreme time-stretch or \"stasis\" effect");
}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectPaulstretch::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 110 of file Paulstretch.cpp.

{
   return Symbol;
}

References Symbol.

◆ GetType()

EffectType EffectPaulstretch::GetType ( ) const

overridevirtual

Type determines how it behaves.

Implements EffectDefinitionInterface.

Definition at line 127 of file Paulstretch.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

Referenced by Process().

Here is the caller graph for this function:

◆ ManualPage()

ManualPageID EffectPaulstretch::ManualPage ( ) const

overridevirtual

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

Reimplemented from EffectDefinitionInterface.

Definition at line 120 of file Paulstretch.cpp.

{
   return L"Paulstretch";
}

◆ OnText()

void EffectPaulstretch::OnText ( wxCommandEvent & evt )

private

Definition at line 245 of file Paulstretch.cpp.

{
   EffectEditor::EnableApply(
      mUIParent, mUIParent->TransferDataFromWindow());
}

References EffectEditor::EnableApply(), and mUIParent.

Here is the call graph for this function:

◆ Parameters()

const EffectParameterMethods & EffectPaulstretch::Parameters ( ) const

overrideprivatevirtual

Reimplemented from Effect.

Definition at line 37 of file Paulstretch.cpp.

{
   static CapturedParameters<EffectPaulstretch,
      Amount, Time
   > parameters;
   return parameters;
}

References Amount, EffectPaulstretch(), and Time.

Here is the call graph for this function:

◆ PopulateOrExchange()

std::unique_ptr< EffectEditor > EffectPaulstretch::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 198 of file Paulstretch.cpp.

{
   mUIParent = S.GetParent();
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S
         .Validator<FloatingPointValidator<float>>(
            1, &mAmount, NumValidatorStyle::DEFAULT, Amount.min)
         /* i18n-hint: This is how many times longer the sound will be, e.g. applying
          * the effect to a 1-second sample, with the default Stretch Factor of 10.0
          * will give an (approximately) 10 second sound
          */
         .AddTextBox(XXO("&Stretch Factor:"), wxT(""), 10);
 
      S
         .Validator<FloatingPointValidator<float>>(
            3, &mTime_resolution, NumValidatorStyle::ONE_TRAILING_ZERO, Time.min)
         .AddTextBox(XXO("&Time Resolution (seconds):"), L"", 10);
   }
   S.EndMultiColumn();
   return nullptr;
};

References Amount, mAmount, EffectParameter< Structure, Member, Type, Value >::min, mTime_resolution, mUIParent, S, Time, wxT(), and XXO().

Here is the call graph for this function:

◆ Process()

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

overridevirtual

Implements StatefulEffectBase.

Definition at line 148 of file Paulstretch.cpp.

{
   // Pass true because sync lock adjustment is needed
   EffectOutputTracks outputs { *mTracks, GetType(), { { mT0, mT1 } }, true };
   auto newT1 = mT1;
   int count = 0;
   // Process selected wave tracks first, to find the new t1 value
   for (const auto track : outputs.Get().Selected<WaveTrack>()) {
      double trackStart = track->GetStartTime();
      double trackEnd = track->GetEndTime();
      double t0 = mT0 < trackStart ? trackStart : mT0;
      double t1 = mT1 > trackEnd ? trackEnd : mT1;
      if (t1 > t0) {
         auto tempTrack = track->EmptyCopy();
         const auto channels = track->Channels();
         auto iter = tempTrack->Channels().begin();
         for (const auto pChannel : channels) {
            if (!ProcessOne(*pChannel, **iter++, t0, t1, count++))
               return false;
         }
         tempTrack->Flush();
         newT1 = std::max(newT1, mT0 + tempTrack->GetEndTime());
         PasteTimeWarper warper { t1, t0 + tempTrack->GetEndTime() };
         constexpr auto preserve = false;
         constexpr auto merge = true;
         track->ClearAndPaste(t0, t1, *tempTrack, preserve, merge, &warper);
      }
      else
         count += track->NChannels();
   }
 
   // Sync lock adjustment of other tracks
   outputs.Get().Any().Visit(
      [&](auto &&fallthrough){ return [&](WaveTrack &track) {
         if (!track.IsSelected())
            fallthrough();
      }; },
      [&](Track &track) {
         if (SyncLock::IsSyncLockSelected(track))
            track.SyncLockAdjust(mT1, newT1);
      }
   );
   mT1 = newT1;
 
   outputs.Commit();
 
   return true;
}

References GetType(), SyncLock::IsSyncLockSelected(), EffectBase::mT0, EffectBase::mT1, EffectBase::mTracks, and ProcessOne().

Here is the call graph for this function:

◆ ProcessOne()

bool EffectPaulstretch::ProcessOne	(	const WaveChannel &	track,
		WaveChannel &	outputTrack,
		double	t0,
		double	t1,
		int	count
	)

private

Definition at line 269 of file Paulstretch.cpp.

{
   const auto badAllocMessage =
      XO("Requested value exceeds memory capacity.");
 
   const auto rate = track.GetTrack().GetRate();
   const auto stretch_buf_size = GetBufferSize(rate);
   if (stretch_buf_size == 0) {
      EffectUIServices::DoMessageBox(*this, badAllocMessage);
      return {};
   }
 
   double amount = this->mAmount;
 
   auto start = track.TimeToLongSamples(t0);
   auto end = track.TimeToLongSamples(t1);
   auto len = end - start;
 
   const auto minDuration = stretch_buf_size * 2 + 1;
   if (minDuration < stretch_buf_size) {
      // overflow!
      EffectUIServices::DoMessageBox(*this, badAllocMessage);
      return {};
   }
 
   if (len < minDuration) {   //error because the selection is too short
 
      float maxTimeRes = log( len.as_double() ) / log(2.0);
      maxTimeRes = pow(2.0, floor(maxTimeRes) + 0.5);
      maxTimeRes = maxTimeRes / rate;
 
      if (this->IsPreviewing()) {
         double defaultPreviewLen;
         gPrefs->Read(wxT("/AudioIO/EffectsPreviewLen"), &defaultPreviewLen, 6.0);
 
         if ((minDuration / mProjectRate) < defaultPreviewLen) {
            EffectUIServices::DoMessageBox(*this,
               /* i18n-hint: 'Time Resolution' is the name of a control in the Paulstretch effect.*/
               XO("Audio selection too short to preview.\n\n"
                  "Try increasing the audio selection to at least %.1f seconds,\n"
                  "or reducing the 'Time Resolution' to less than %.1f seconds.")
                  .Format(
                     (minDuration / rate) + 0.05, // round up to 1/10 s.
                     floor(maxTimeRes * 10.0) / 10.0),
               wxOK | wxICON_EXCLAMATION );
         }
         else {
            EffectUIServices::DoMessageBox(*this,
               /* i18n-hint: 'Time Resolution' is the name of a control in the Paulstretch effect.*/
               XO("Unable to Preview.\n\n"
                  "For the current audio selection, the maximum\n"
                  "'Time Resolution' is %.1f seconds.")
                  .Format( floor(maxTimeRes * 10.0) / 10.0 ),
               wxOK | wxICON_EXCLAMATION );
         }
      }
      else {
         EffectUIServices::DoMessageBox(*this,
            /* i18n-hint: 'Time Resolution' is the name of a control in the Paulstretch effect.*/
            XO("The 'Time Resolution' is too long for the selection.\n\n"
               "Try increasing the audio selection to at least %.1f seconds,\n"
               "or reducing the 'Time Resolution' to less than %.1f seconds.")
               .Format(
                  (minDuration / rate) + 0.05, // round up to 1/10 s.
                  floor(maxTimeRes * 10.0) / 10.0),
            wxOK | wxICON_EXCLAMATION );
      }
 
      return {};
   }
 
   auto dlen = len.as_double();
   double adjust_amount = dlen /
      (dlen - ((double)stretch_buf_size * 2.0));
   amount = 1.0 + (amount - 1.0) * adjust_amount;
 
   try {
      // This encloses all the allocations of buffers, including those in
      // the constructor of the PaulStretch object
 
      PaulStretch stretch(amount, stretch_buf_size, rate);
 
      auto nget = stretch.get_nsamples_for_fill();
 
      auto bufsize = stretch.poolsize;
      Floats buffer0{ bufsize };
      float *bufferptr0 = buffer0.get();
      bool first_time = true;
 
      const auto fade_len = std::min<size_t>(100, bufsize / 2 - 1);
      bool cancelled = false;
 
      {
         Floats fade_track_smps{ fade_len };
         decltype(len) s=0;
 
         while (s < len) {
            track.GetFloats(bufferptr0, start + s, nget);
            stretch.process(buffer0.get(), nget);
 
            if (first_time) {
               stretch.process(buffer0.get(), 0);
            };
 
            s += nget;
 
            if (first_time){//blend the start of the selection
               track.GetFloats(fade_track_smps.get(), start, fade_len);
               first_time = false;
               for (size_t i = 0; i < fade_len; i++){
                  float fi = (float)i / (float)fade_len;
                  stretch.out_buf[i] =
                     stretch.out_buf[i] * fi + (1.0 - fi) * fade_track_smps[i];
               }
            }
            if (s >= len){//blend the end of the selection
               track.GetFloats(fade_track_smps.get(), end - fade_len, fade_len);
               for (size_t i = 0; i < fade_len; i++){
                  float fi = (float)i / (float)fade_len;
                  auto i2 = bufsize / 2 - 1 - i;
                  stretch.out_buf[i2] =
                     stretch.out_buf[i2] * fi + (1.0 - fi) *
                     fade_track_smps[fade_len - 1 - i];
               }
            }
 
            outputTrack.Append((samplePtr)stretch.out_buf.get(), floatSample, stretch.out_bufsize);
 
            nget = stretch.get_nsamples();
            if (TrackProgress(count,
               s.as_double() / len.as_double()
            )) {
               cancelled = true;
               break;
            }
         }
      }
 
      if (!cancelled)
         return true;
   }
   catch ( const std::bad_alloc& ) {
      EffectUIServices::DoMessageBox(*this, badAllocMessage);
   }
   return false;
};

References WaveChannel::Append(), EffectUIServices::DoMessageBox(), details::end(), floatSample, PaulStretch::get_nsamples(), PaulStretch::get_nsamples_for_fill(), GetBufferSize(), WaveChannel::GetFloats(), WaveTrack::GetRate(), WaveChannel::GetTrack(), gPrefs, EffectBase::IsPreviewing(), mAmount, EffectBase::mProjectRate, PaulStretch::out_buf, PaulStretch::out_bufsize, PaulStretch::poolsize, PaulStretch::process(), audacity::BasicSettings::Read(), WideSampleSequence::TimeToLongSamples(), Effect::TrackProgress(), wxT(), and XO().

Referenced by Process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransferDataFromWindow()

bool EffectPaulstretch::TransferDataFromWindow ( EffectSettings & settings )

overridevirtual

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

Reimplemented from StatefulEffectUIServices.

Definition at line 233 of file Paulstretch.cpp.

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

References mUIParent.

◆ TransferDataToWindow()

bool EffectPaulstretch::TransferDataToWindow ( const EffectSettings & settings )

overridevirtual

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

Reimplemented from StatefulEffectUIServices.

Definition at line 223 of file Paulstretch.cpp.

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

References mUIParent.

Member Data Documentation

◆ Amount

constexpr EffectParameter EffectPaulstretch::Amount

staticconstexprprivate

Initial value:

{ &EffectPaulstretch::mAmount,

L"Stretch Factor", 10.0f, 1.0, FLT_MAX, 1 }

Definition at line 69 of file Paulstretch.h.

Referenced by Parameters(), and PopulateOrExchange().

◆ mAmount

float EffectPaulstretch::mAmount

private

Definition at line 63 of file Paulstretch.h.

Referenced by CalcPreviewInputLength(), PopulateOrExchange(), and ProcessOne().

◆ mTime_resolution

float EffectPaulstretch::mTime_resolution

private

Definition at line 64 of file Paulstretch.h.

Referenced by GetBufferSize(), and PopulateOrExchange().

◆ mUIParent

wxWeakRef<wxWindow> EffectPaulstretch::mUIParent

private

Definition at line 61 of file Paulstretch.h.

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

◆ Symbol

const ComponentInterfaceSymbol EffectPaulstretch::Symbol { XO("Paulstretch") }

static

Definition at line 26 of file Paulstretch.h.

Referenced by GetSymbol().

◆ Time

constexpr EffectParameter EffectPaulstretch::Time

staticconstexprprivate

Initial value:

{ &EffectPaulstretch::mTime_resolution,

L"Time Resolution", 0.25f, 0.00099f, FLT_MAX, 1 }

Definition at line 71 of file Paulstretch.h.

Referenced by Parameters(), and PopulateOrExchange().

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

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

◆ EffectPaulstretch()

◆ ~EffectPaulstretch()

Member Function Documentation

◆ CalcPreviewInputLength()

◆ FetchParameters()

◆ GetBufferSize()

◆ GetDescription()

◆ GetSymbol()

◆ GetType()

◆ ManualPage()

◆ OnText()

◆ Parameters()

◆ PopulateOrExchange()

◆ Process()

◆ ProcessOne()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

Member Data Documentation

◆ Amount

◆ mAmount

◆ mTime_resolution

◆ mUIParent

◆ Symbol

◆ Time