ChangeTempoBase Class Reference

#include <ChangeTempoBase.h>

Inheritance diagram for ChangeTempoBase:

Collaboration diagram for ChangeTempoBase:

Public Member Functions
	ChangeTempoBase ()
virtual	~ChangeTempoBase ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
ManualPageID	ManualPage () const override
EffectType	GetType () const override
bool	SupportsAutomation () const override
bool	Init () override
bool	CheckWhetherSkipEffect (const EffectSettings &settings) const override
bool	Process (EffectInstance &instance, EffectSettings &settings) override
double	CalcPreviewInputLength (const EffectSettings &settings, double previewLength) const override

Static Public Member Functions
static ChangeTempoBase *	FetchParameters (ChangeTempoBase &e, EffectSettings &)

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

Protected Member Functions
const EffectParameterMethods &	Parameters () const override

Protected Attributes
bool	mUseSBSMS
double	m_PercentChange
double	m_FromBPM
double	m_ToBPM
double	m_FromLength
double	m_ToLength
bool	m_bLoopDetect

Static Protected Attributes
static constexpr EffectParameter	Percentage
static constexpr EffectParameter	UseSBSMS

Detailed Description

Definition at line 6 of file ChangeTempoBase.h.

Constructor & Destructor Documentation

ChangeTempoBase()

ChangeTempoBase::ChangeTempoBase

(

)

Definition at line 33 of file ChangeTempoBase.cpp.

{
   // mUseSBSMS always defaults to false and its value is used only if USE_SBSMS
   // is defined
   Parameters().Reset(*this);
   m_FromBPM = 0.0; // indicates not yet set
   m_ToBPM = 0.0;   // indicates not yet set
   m_FromLength = 0.0;
   m_ToLength = 0.0;
 
   m_bLoopDetect = false;
 
   SetLinearEffectFlag(true);
}

References m_bLoopDetect, m_FromBPM, m_FromLength, m_ToBPM, m_ToLength, Parameters(), and EffectParameterMethods::Reset().

Here is the call graph for this function:

~ChangeTempoBase()

ChangeTempoBase::~ChangeTempoBase ( )

virtual

Definition at line 48 of file ChangeTempoBase.cpp.

{
}

Member Function Documentation

CalcPreviewInputLength()

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

override

Definition at line 83 of file ChangeTempoBase.cpp.

{
   return previewLength * (100.0 + m_PercentChange) / 100.0;
}

References m_PercentChange.

CheckWhetherSkipEffect()

bool ChangeTempoBase::CheckWhetherSkipEffect ( const EffectSettings &  settings ) const

override

Definition at line 89 of file ChangeTempoBase.cpp.

{
   return (m_PercentChange == 0.0);
}

References m_PercentChange.

FetchParameters()

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

inlinestatic

Definition at line 10 of file ChangeTempoBase.h.

   {
      return &e;
   }

GetDescription()

TranslatableString ChangeTempoBase::GetDescription ( ) const

override

Definition at line 59 of file ChangeTempoBase.cpp.

{
   return XO("Changes the tempo of a selection without changing its pitch");
}

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol ChangeTempoBase::GetSymbol ( ) const

override

Definition at line 54 of file ChangeTempoBase.cpp.

{
   return Symbol;
}

References Symbol.

GetType()

EffectType ChangeTempoBase::GetType ( ) const

override

Definition at line 71 of file ChangeTempoBase.cpp.

{
   return EffectTypeProcess;
}

References EffectTypeProcess.

Init()

bool ChangeTempoBase::Init ( )

override

Definition at line 94 of file ChangeTempoBase.cpp.

{
   // The selection might have changed since the last time ChangeTempoBase
   // was invoked, so recalculate the Length parameters.
   m_FromLength = mT1 - mT0;
   m_ToLength = (m_FromLength * 100.0) / (100.0 + m_PercentChange);
 
   return true;
}

References m_FromLength, m_PercentChange, and m_ToLength.

ManualPage()

ManualPageID ChangeTempoBase::ManualPage ( ) const

override

Definition at line 64 of file ChangeTempoBase.cpp.

{
   return L"Change_Tempo";
}

Parameters()

const EffectParameterMethods & ChangeTempoBase::Parameters ( ) const

overrideprotected

Definition at line 25 of file ChangeTempoBase.cpp.

{
   static CapturedParameters<ChangeTempoBase, Percentage, UseSBSMS> parameters;
   return parameters;
}

Referenced by ChangeTempoBase().

Here is the caller graph for this function:

Process()

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

override

Already processing; don't make a dialog

Definition at line 104 of file ChangeTempoBase.cpp.

{
   bool success = false;
 
#if USE_SBSMS
   if (mUseSBSMS)
   {
      double tempoRatio = 1.0 + m_PercentChange / 100.0;
      SBSMSBase proxy;
      proxy.mProxyEffectName = XO("High Quality Tempo Change");
      proxy.setParameters(tempoRatio, 1.0);
      success = Delegate(proxy, settings);
   }
   else
#endif
   {
      auto initer = [&](soundtouch::SoundTouch* soundtouch) {
         soundtouch->setTempoChange(m_PercentChange);
      };
      double mT1Dashed = mT0 + (mT1 - mT0) / (m_PercentChange / 100.0 + 1.0);
      RegionTimeWarper warper {
         mT0, mT1, std::make_unique<LinearTimeWarper>(mT0, mT0, mT1, mT1Dashed)
      };
      success = SoundTouchBase::ProcessWithTimeWarper(initer, warper, false);
   }
 
   if (success)
      mT1 = mT0 + (mT1 - mT0) / (m_PercentChange / 100 + 1.);
 
   return success;
}

References m_PercentChange, SBSMSBase::mProxyEffectName, mUseSBSMS, SBSMSBase::setParameters(), settings(), and XO().

Here is the call graph for this function:

SupportsAutomation()

bool ChangeTempoBase::SupportsAutomation ( ) const

override

Definition at line 76 of file ChangeTempoBase.cpp.

{
   return true;
}

Member Data Documentation

m_bLoopDetect

bool ChangeTempoBase::m_bLoopDetect

protected

Definition at line 49 of file ChangeTempoBase.h.

Referenced by ChangeTempoBase().

m_FromBPM

double ChangeTempoBase::m_FromBPM

protected

Definition at line 44 of file ChangeTempoBase.h.

Referenced by ChangeTempoBase().

m_FromLength

double ChangeTempoBase::m_FromLength

protected

Definition at line 46 of file ChangeTempoBase.h.

Referenced by ChangeTempoBase(), and Init().

m_PercentChange

double ChangeTempoBase::m_PercentChange

protected

Definition at line 42 of file ChangeTempoBase.h.

Referenced by CalcPreviewInputLength(), CheckWhetherSkipEffect(), Init(), and Process().

m_ToBPM

double ChangeTempoBase::m_ToBPM

protected

Definition at line 45 of file ChangeTempoBase.h.

Referenced by ChangeTempoBase().

m_ToLength

double ChangeTempoBase::m_ToLength

protected

Definition at line 47 of file ChangeTempoBase.h.

Referenced by ChangeTempoBase(), and Init().

mUseSBSMS

bool ChangeTempoBase::mUseSBSMS

protected

Definition at line 41 of file ChangeTempoBase.h.

Referenced by Process().

Percentage

constexpr EffectParameter ChangeTempoBase::Percentage

staticconstexprprotected

Initial value:

{
      &ChangeTempoBase::m_PercentChange, L"Percentage", 0.0, -95.0, 3000.0, 1
   }

Definition at line 51 of file ChangeTempoBase.h.

Symbol

const ComponentInterfaceSymbol ChangeTempoBase::Symbol { XO("Change Tempo") }

static

Definition at line 14 of file ChangeTempoBase.h.

Referenced by GetSymbol().

UseSBSMS

constexpr EffectParameter ChangeTempoBase::UseSBSMS

staticconstexprprotected

Initial value:

{
      &ChangeTempoBase::mUseSBSMS, L"SBSMS", false, false, true, 1
   }

Definition at line 54 of file ChangeTempoBase.h.

---

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

• ChangeTempoBase.h
• ChangeTempoBase.cpp