StaffPadTimeAndPitch Class Reference

#include <StaffPadTimeAndPitch.h>

Inheritance diagram for StaffPadTimeAndPitch:

Collaboration diagram for StaffPadTimeAndPitch:

Public Member Functions
	StaffPadTimeAndPitch (int sampleRate, size_t numChannels, TimeAndPitchSource &, const Parameters &)
void	GetSamples (float *const *, size_t) override
void	OnCentShiftChange (int cents) override
void	OnFormantPreservationChange (bool preserve) override
Public Member Functions inherited from TimeAndPitchInterface
virtual void	GetSamples (float *const *, size_t)=0
virtual void	OnCentShiftChange (int cents)=0
virtual void	OnFormantPreservationChange (bool preserve)=0
virtual	~TimeAndPitchInterface ()

Private Member Functions
bool	IllState () const
void	InitializeStretcher ()

Private Attributes
const int	mSampleRate
const std::unique_ptr< FormantShifterLoggerInterface >	mFormantShifterLogger
TimeAndPitchInterface::Parameters	mParameters
FormantShifter	mFormantShifter
std::unique_ptr< staffpad::TimeAndPitch >	mTimeAndPitch
TimeAndPitchSource &	mAudioSource
AudioContainer	mReadBuffer
const size_t	mNumChannels

Additional Inherited Members
Static Public Member Functions inherited from TimeAndPitchInterface
static bool	IsPassThroughMode (double stretchRatio)
Static Public Attributes inherited from TimeAndPitchInterface
static constexpr auto	MaxCents = 1200
static constexpr auto	MinCents = -1200

Detailed Description

Definition at line 7 of file StaffPadTimeAndPitch.h.

Constructor & Destructor Documentation

StaffPadTimeAndPitch()

StaffPadTimeAndPitch::StaffPadTimeAndPitch	(	int	sampleRate,
		size_t	numChannels,
		TimeAndPitchSource &	audioSource,
		const Parameters &	parameters
	)

Definition at line 80 of file StaffPadTimeAndPitch.cpp.

    : mSampleRate(sampleRate)
    , mParameters(parameters)
    , mFormantShifterLogger(GetFormantShifterLogger(sampleRate))
    , mFormantShifter(
         sampleRate,
         TimeAndPitchExperimentalSettings::GetCutoffQuefrencyOverride()
            .value_or(0.002),
         *mFormantShifterLogger)
    , mAudioSource(audioSource)
    , mReadBuffer(maxBlockSize, numChannels)
    , mNumChannels(numChannels)
{
   if (mParameters.preserveFormants)
      mFormantShifter.Reset(
         GetFftSize(sampleRate, parameters.preserveFormants));
   if (
      !TimeAndPitchInterface::IsPassThroughMode(mParameters.timeRatio) ||
      // No need for sophisticated comparison for pitch ratio, as our UI doesn't
      // allow changes smaller than a cent.
      mParameters.pitchRatio != 1.)
      InitializeStretcher();
}

References anonymous_namespace{StaffPadTimeAndPitch.cpp}::GetFftSize(), InitializeStretcher(), TimeAndPitchInterface::IsPassThroughMode(), mFormantShifter, mParameters, TimeAndPitchInterface::Parameters::pitchRatio, TimeAndPitchInterface::Parameters::preserveFormants, FormantShifter::Reset(), anonymous_namespace{ClipSegmentTest.cpp}::sampleRate, and TimeAndPitchInterface::Parameters::timeRatio.

Here is the call graph for this function:

Member Function Documentation

GetSamples()

void StaffPadTimeAndPitch::GetSamples ( float *const *  output, size_t  outputLen  )

overridevirtual

Implements TimeAndPitchInterface.

Definition at line 106 of file StaffPadTimeAndPitch.cpp.

{
   if (!mTimeAndPitch)
      // Pass-through
      return mAudioSource.Pull(output, outputLen);
 
   auto numOutputSamples = 0u;
   while (numOutputSamples < outputLen)
   {
      if (IllState())
      {
         for (auto i = 0u; i < mNumChannels; ++i)
            std::fill_n(
               output[i] + numOutputSamples, outputLen - numOutputSamples, 0.f);
         return;
      }
      auto numOutputSamplesAvailable =
         mTimeAndPitch->getNumAvailableOutputSamples();
      while (numOutputSamplesAvailable <= 0)
      {
         auto numRequired = mTimeAndPitch->getSamplesToNextHop();
         while (numRequired > 0)
         {
            const auto numSamplesToFeed = std::min(numRequired, maxBlockSize);
            mAudioSource.Pull(mReadBuffer.Get(), numSamplesToFeed);
            mFormantShifterLogger->NewSamplesComing(numSamplesToFeed);
            mTimeAndPitch->feedAudio(mReadBuffer.Get(), numSamplesToFeed);
            numRequired -= numSamplesToFeed;
         }
         numOutputSamplesAvailable =
            mTimeAndPitch->getNumAvailableOutputSamples();
      }
      while (numOutputSamples < outputLen && numOutputSamplesAvailable > 0)
      {
         const auto numSamplesToGet =
            std::min({ maxBlockSize, numOutputSamplesAvailable,
                       static_cast<int>(outputLen - numOutputSamples) });
         // More-than-stereo isn't supported
         assert(mNumChannels <= 2);
         float* buffer[2] {};
         GetOffsetBuffer(buffer, output, mNumChannels, numOutputSamples);
         mTimeAndPitch->retrieveAudio(buffer, numSamplesToGet);
         numOutputSamplesAvailable -= numSamplesToGet;
         numOutputSamples += numSamplesToGet;
      }
   }
}

References AudioContainer::Get(), anonymous_namespace{StaffPadTimeAndPitch.cpp}::GetOffsetBuffer(), IllState(), mAudioSource, anonymous_namespace{StaffPadTimeAndPitch.cpp}::maxBlockSize, mFormantShifterLogger, min(), mNumChannels, mReadBuffer, mTimeAndPitch, and TimeAndPitchSource::Pull().

Referenced by TEST_CASE().

Here is the call graph for this function:

Here is the caller graph for this function:

IllState()

bool StaffPadTimeAndPitch::IllState ( ) const

private

Definition at line 213 of file StaffPadTimeAndPitch.cpp.

{
   // It doesn't require samples, yet it doesn't have output samples available.
   // Note that this must not be a permanent state, and may recover if the user
   // changes the pitch shift.
   // TODO: try to fix this in the stretcher implementation.
   return mTimeAndPitch->getSamplesToNextHop() <= 0 &&
          mTimeAndPitch->getNumAvailableOutputSamples() <= 0;
}

References mTimeAndPitch.

Referenced by GetSamples(), and InitializeStretcher().

Here is the caller graph for this function:

InitializeStretcher()

void StaffPadTimeAndPitch::InitializeStretcher ( )

private

Definition at line 178 of file StaffPadTimeAndPitch.cpp.

{
   mTimeAndPitch = CreateTimeAndPitch(
      mSampleRate, mNumChannels, mParameters, mFormantShifter);
   auto numOutputSamplesToDiscard =
      mTimeAndPitch->getLatencySamplesForStretchRatio(
         mParameters.timeRatio * mParameters.pitchRatio);
   AudioContainer container(maxBlockSize, mNumChannels);
   while (numOutputSamplesToDiscard > 0)
   {
      if (IllState())
         return;
      auto numRequired = mTimeAndPitch->getSamplesToNextHop();
      while (numRequired > 0)
      {
         const auto numSamplesToFeed = std::min(maxBlockSize, numRequired);
         mAudioSource.Pull(container.Get(), numSamplesToFeed);
         mTimeAndPitch->feedAudio(container.Get(), numSamplesToFeed);
         numRequired -= numSamplesToFeed;
      }
      const auto totalNumSamplesToRetrieve = std::min(
         mTimeAndPitch->getNumAvailableOutputSamples(),
         numOutputSamplesToDiscard);
      auto totalNumRetrievedSamples = 0;
      while (totalNumRetrievedSamples < totalNumSamplesToRetrieve)
      {
         const auto numSamplesToRetrieve = std::min(
            maxBlockSize, totalNumSamplesToRetrieve - totalNumRetrievedSamples);
         mTimeAndPitch->retrieveAudio(container.Get(), numSamplesToRetrieve);
         totalNumRetrievedSamples += numSamplesToRetrieve;
      }
      numOutputSamplesToDiscard -= totalNumSamplesToRetrieve;
   }
}

References anonymous_namespace{StaffPadTimeAndPitch.cpp}::CreateTimeAndPitch(), AudioContainer::Get(), IllState(), mAudioSource, anonymous_namespace{StaffPadTimeAndPitch.cpp}::maxBlockSize, mFormantShifter, min(), mNumChannels, mParameters, mSampleRate, mTimeAndPitch, TimeAndPitchInterface::Parameters::pitchRatio, TimeAndPitchSource::Pull(), and TimeAndPitchInterface::Parameters::timeRatio.

Referenced by OnCentShiftChange(), OnFormantPreservationChange(), and StaffPadTimeAndPitch().

Here is the call graph for this function:

Here is the caller graph for this function:

OnCentShiftChange()

void StaffPadTimeAndPitch::OnCentShiftChange ( int  cents )

overridevirtual

Implements TimeAndPitchInterface.

Definition at line 154 of file StaffPadTimeAndPitch.cpp.

{
   mParameters.pitchRatio = std::pow(2., cents / 1200.);
   // If pitch shifing was zero before, now it isn't. If it was non-zero before,
   // we don't unset the stretcher even if the new pitch shift is zero, or
   // someone playing around with the effect could hear glitches.
   if (!mTimeAndPitch)
      InitializeStretcher();
   else
      mTimeAndPitch->setTimeStretchAndPitchFactor(
         mParameters.timeRatio, mParameters.pitchRatio);
}

References InitializeStretcher(), mParameters, mTimeAndPitch, TimeAndPitchInterface::Parameters::pitchRatio, and TimeAndPitchInterface::Parameters::timeRatio.

Here is the call graph for this function:

OnFormantPreservationChange()

void StaffPadTimeAndPitch::OnFormantPreservationChange ( bool  preserve )

overridevirtual

Implements TimeAndPitchInterface.

Definition at line 167 of file StaffPadTimeAndPitch.cpp.

{
   mParameters.preserveFormants = preserve;
   const auto fftSize = GetFftSize(mSampleRate, preserve);
   preserve ? mFormantShifter.Reset(fftSize) : mFormantShifter.Reset();
   // FFT size is a constant of the stretcher, so we need to reset it - if there
   // is a stretcher.
   if (mTimeAndPitch)
      InitializeStretcher();
}

References anonymous_namespace{StaffPadTimeAndPitch.cpp}::GetFftSize(), InitializeStretcher(), mFormantShifter, mParameters, mSampleRate, mTimeAndPitch, TimeAndPitchInterface::Parameters::preserveFormants, and FormantShifter::Reset().

Here is the call graph for this function:

Member Data Documentation

mAudioSource

TimeAndPitchSource& StaffPadTimeAndPitch::mAudioSource

private

Definition at line 27 of file StaffPadTimeAndPitch.h.

Referenced by GetSamples(), and InitializeStretcher().

mFormantShifter

FormantShifter StaffPadTimeAndPitch::mFormantShifter

private

Definition at line 25 of file StaffPadTimeAndPitch.h.

Referenced by InitializeStretcher(), OnFormantPreservationChange(), and StaffPadTimeAndPitch().

mFormantShifterLogger

const std::unique_ptr<FormantShifterLoggerInterface> StaffPadTimeAndPitch::mFormantShifterLogger

private

Definition at line 23 of file StaffPadTimeAndPitch.h.

Referenced by GetSamples().

mNumChannels

const size_t StaffPadTimeAndPitch::mNumChannels

private

Definition at line 29 of file StaffPadTimeAndPitch.h.

Referenced by GetSamples(), and InitializeStretcher().

mParameters

TimeAndPitchInterface::Parameters StaffPadTimeAndPitch::mParameters

private

Definition at line 24 of file StaffPadTimeAndPitch.h.

Referenced by InitializeStretcher(), OnCentShiftChange(), OnFormantPreservationChange(), and StaffPadTimeAndPitch().

mReadBuffer

AudioContainer StaffPadTimeAndPitch::mReadBuffer

private

Definition at line 28 of file StaffPadTimeAndPitch.h.

Referenced by GetSamples().

mSampleRate

const int StaffPadTimeAndPitch::mSampleRate

private

Definition at line 22 of file StaffPadTimeAndPitch.h.

Referenced by InitializeStretcher(), and OnFormantPreservationChange().

mTimeAndPitch

std::unique_ptr<staffpad::TimeAndPitch> StaffPadTimeAndPitch::mTimeAndPitch

private

Definition at line 26 of file StaffPadTimeAndPitch.h.

Referenced by GetSamples(), IllState(), InitializeStretcher(), OnCentShiftChange(), and OnFormantPreservationChange().

---

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

• StaffPadTimeAndPitch.h
• StaffPadTimeAndPitch.cpp