#include <ClipSegment.h>

Inheritance diagram for ClipSegment:

Collaboration diagram for ClipSegment:

Public Member Functions
	ClipSegment (const ClipInterface &, double durationToDiscard, PlaybackDirection)

	~ClipSegment () override

size_t	GetFloats (float const buffers, size_t numSamples) override
	Fills `buffers` with as many as `numSamples` or the number of remaining samples, whichever is smaller. More...

bool	Empty () const override
	Whether the segment has no more samples to provide. More...

size_t	NChannels () const override
	The number of channels in the segment. More...

Public Member Functions inherited from AudioSegment
virtual	~AudioSegment ()

virtual size_t	GetFloats (float const buffers, size_t numSamples)=0
	Fills `buffers` with as many as `numSamples` or the number of remaining samples, whichever is smaller. More...

virtual size_t	NChannels () const =0
	The number of channels in the segment. More...

virtual bool	Empty () const =0
	Whether the segment has no more samples to provide. More...

Private Attributes
const sampleCount	mTotalNumSamplesToProduce

sampleCount	mTotalNumSamplesProduced = 0

ClipTimeAndPitchSource	mSource

bool	mPreserveFormants

int	mCentShift

std::atomic< bool >	mUpdateFormantPreservation = false

std::atomic< bool >	mUpdateCentShift = false

std::unique_ptr< TimeAndPitchInterface >	mStretcher

Observer::Subscription	mOnSemitoneShiftChangeSubscription

Observer::Subscription	mOnFormantPreservationChangeSubscription

Detailed Description

It is important that objects of this class are instantiated and destroyed on the same thread, due to the owned Observer::Subscription.

Definition at line 30 of file ClipSegment.h.

Constructor & Destructor Documentation

◆ ClipSegment()

ClipSegment::ClipSegment	(	const ClipInterface &	clip,
		double	durationToDiscard,
		PlaybackDirection	direction
	)

Definition at line 41 of file ClipSegment.cpp.

    : mTotalNumSamplesToProduce { GetTotalNumSamplesToProduce(
         clip, durationToDiscard) }
    , mSource { clip, durationToDiscard, direction }
    , mPreserveFormants { clip.GetPitchAndSpeedPreset() ==
                          PitchAndSpeedPreset::OptimizeForVoice }
    , mCentShift { clip.GetCentShift() }
    , mStretcher { std::make_unique<StaffPadTimeAndPitch>(
         clip.GetRate(), clip.NChannels(), mSource,
         GetStretchingParameters(clip)) }
    , mOnSemitoneShiftChangeSubscription { clip.SubscribeToCentShiftChange(
         [this](int cents) {
            mCentShift = cents;
            mUpdateCentShift = true;
         }) }
    , mOnFormantPreservationChangeSubscription {
       clip.SubscribeToPitchAndSpeedPresetChange(
          [this](PitchAndSpeedPreset preset) {
             mPreserveFormants =
                preset == PitchAndSpeedPreset::OptimizeForVoice;
             mUpdateFormantPreservation = true;
          })
    }
{
}

References mCentShift, mUpdateCentShift, and OptimizeForVoice.

◆ ~ClipSegment()

ClipSegment::~ClipSegment ( )

override

Definition at line 69 of file ClipSegment.cpp.

{
   mOnSemitoneShiftChangeSubscription.Reset();
   mOnFormantPreservationChangeSubscription.Reset();
}

References mOnFormantPreservationChangeSubscription, mOnSemitoneShiftChangeSubscription, and Observer::Subscription::Reset().

Here is the call graph for this function:

Member Function Documentation

◆ Empty()

bool ClipSegment::Empty ( ) const

overridevirtual

Whether the segment has no more samples to provide.

Implements AudioSegment.

Definition at line 95 of file ClipSegment.cpp.

{
   return mTotalNumSamplesProduced == mTotalNumSamplesToProduce;
}

References mTotalNumSamplesProduced, and mTotalNumSamplesToProduce.

◆ GetFloats()

size_t ClipSegment::GetFloats	(	float const	buffers,
		size_t	numSamples
	)

overridevirtual

Fills buffers with as many as numSamples or the number of remaining samples, whichever is smaller.

Parameters

buffers	Pointers to buffers, one for each channel.
numSamples	The max. number of samples to write to each buffer.

Returns: The number of samples actually provided in each buffer.

Implements AudioSegment.

Definition at line 75 of file ClipSegment.cpp.

{
   // Check if formant preservation of pitch shift needs to be updated.
   // This approach is not immune to a race condition, but it is unlikely and
   // not critical, as it would only affect one playback pass, during which the
   // user could easily correct the mistake if needed. On the other hand, we
   // cannot trust that the observer subscriptions do not get called after
   // destruction of this object, so better not do anything too sophisticated
   // there.
   if (mUpdateFormantPreservation.exchange(false))
      mStretcher->OnFormantPreservationChange(mPreserveFormants);
   if (mUpdateCentShift.exchange(false))
      mStretcher->OnCentShiftChange(mCentShift);
   const auto numSamplesToProduce = limitSampleBufferSize(
      numSamples, mTotalNumSamplesToProduce - mTotalNumSamplesProduced);
   mStretcher->GetSamples(buffers, numSamplesToProduce);
   mTotalNumSamplesProduced += numSamplesToProduce;
   return numSamplesToProduce;
}

References limitSampleBufferSize(), mCentShift, mPreserveFormants, mStretcher, mTotalNumSamplesProduced, mTotalNumSamplesToProduce, mUpdateCentShift, and mUpdateFormantPreservation.

Here is the call graph for this function:

◆ NChannels()

size_t ClipSegment::NChannels ( ) const

overridevirtual

The number of channels in the segment.

Implements AudioSegment.

Definition at line 100 of file ClipSegment.cpp.

{
   return mSource.NChannels();
}

References mSource, and ClipTimeAndPitchSource::NChannels().

Here is the call graph for this function:

Member Data Documentation

◆ mCentShift

int ClipSegment::mCentShift

private

Definition at line 47 of file ClipSegment.h.

Referenced by ClipSegment(), and GetFloats().

◆ mOnFormantPreservationChangeSubscription

Observer::Subscription ClipSegment::mOnFormantPreservationChangeSubscription

private

Definition at line 55 of file ClipSegment.h.

Referenced by ~ClipSegment().

◆ mOnSemitoneShiftChangeSubscription

Observer::Subscription ClipSegment::mOnSemitoneShiftChangeSubscription

private

Definition at line 54 of file ClipSegment.h.

Referenced by ~ClipSegment().

◆ mPreserveFormants

bool ClipSegment::mPreserveFormants

private

Definition at line 46 of file ClipSegment.h.

Referenced by GetFloats().

◆ mSource

ClipTimeAndPitchSource ClipSegment::mSource

private

Definition at line 45 of file ClipSegment.h.

Referenced by NChannels().

◆ mStretcher

std::unique_ptr<TimeAndPitchInterface> ClipSegment::mStretcher

private

Definition at line 53 of file ClipSegment.h.

Referenced by GetFloats().

◆ mTotalNumSamplesProduced

sampleCount ClipSegment::mTotalNumSamplesProduced = 0

private

Definition at line 44 of file ClipSegment.h.

Referenced by Empty(), and GetFloats().

◆ mTotalNumSamplesToProduce

const sampleCount ClipSegment::mTotalNumSamplesToProduce

private

Definition at line 43 of file ClipSegment.h.

Referenced by Empty(), and GetFloats().

◆ mUpdateCentShift

std::atomic<bool> ClipSegment::mUpdateCentShift = false

private

Definition at line 49 of file ClipSegment.h.

Referenced by ClipSegment(), and GetFloats().

◆ mUpdateFormantPreservation

std::atomic<bool> ClipSegment::mUpdateFormantPreservation = false

private

Definition at line 48 of file ClipSegment.h.

Referenced by GetFloats().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ClipSegment()

◆ ~ClipSegment()

Member Function Documentation

◆ Empty()

◆ GetFloats()

◆ NChannels()

Member Data Documentation

◆ mCentShift

◆ mOnFormantPreservationChangeSubscription

◆ mOnSemitoneShiftChangeSubscription

◆ mPreserveFormants

◆ mSource

◆ mStretcher

◆ mTotalNumSamplesProduced

◆ mTotalNumSamplesToProduce

◆ mUpdateCentShift

◆ mUpdateFormantPreservation