This allows multiple clips to be a part of one WaveTrack. More...

#include <WaveClip.h>

Inheritance diagram for WaveClip:

Collaboration diagram for WaveClip:

Classes
struct	Transaction
	Restores state when an update loop over mSequences fails midway. More...

Public Types
using	Caches = Site< WaveClip, WaveClipListener >

Public Types inherited from ClientData::Site< WaveClip, WaveClipListener >
using	DataType = WaveClipListener

using	DataPointer = UniquePtr< WaveClipListener >

using	DataFactory = std::function< DataPointer(WaveClip &) >
	Type of function from which RegisteredFactory is constructed; it builds attachments. More...

Public Member Functions
	WaveClip (size_t width, const SampleBlockFactoryPtr &factory, sampleFormat format, int rate, int colourIndex)
	typical constructor More...

	WaveClip (const WaveClip &orig, const SampleBlockFactoryPtr &factory, bool copyCutlines)

	WaveClip (const WaveClip &orig, const SampleBlockFactoryPtr &factory, bool copyCutlines, double t0, double t1)
	Copy only a range from the given WaveClip. More...

virtual	~WaveClip ()

bool	CheckInvariants () const
	Check invariant conditions on mSequences and mCutlines. More...

size_t	GetWidth () const override

void	ConvertToSampleFormat (sampleFormat format, const std::function< void(size_t)> &progressReport={})

int	GetRate () const override

void	SetRate (int rate)

void	StretchLeftTo (double to)
	Stretches from left to the absolute time (if in expected range) More...

void	StretchRightTo (double to)
	Sets from the right to the absolute time (if in expected range) More...

double	GetStretchRatio () const override

void	Resample (int rate, BasicUI::ProgressDialog *progress=nullptr)

void	ApplyStretchRatio (const std::function< void(double)> &reportProgress)
	Renders the stretching of the clip (preserving duration). More...

void	SetColourIndex (int index)

int	GetColourIndex () const

double	GetSequenceStartTime () const noexcept

void	SetSequenceStartTime (double startTime)

double	GetSequenceEndTime () const

sampleCount	GetSequenceStartSample () const
	Returns the index of the first sample of the underlying sequence. More...

sampleCount	GetSequenceSamplesCount () const

double	GetPlayStartTime () const noexcept override

void	SetPlayStartTime (double time)

double	GetPlayEndTime () const override

double	GetPlayDuration () const

sampleCount	GetPlayStartSample () const
	Real start time of the clip, quantized to raw sample rate (track's rate) More...

sampleCount	GetPlayEndSample () const
	Real end time of the clip, quantized to raw sample rate (track's rate) More...

sampleCount	GetVisibleSampleCount () const override

void	SetTrimLeft (double trim)
	Sets the play start offset in seconds from the beginning of the underlying sequence. More...

double	GetTrimLeft () const noexcept
	Returns the play start offset in seconds from the beginning of the underlying sequence. More...

void	SetTrimRight (double trim)
	Sets the play end offset in seconds from the ending of the underlying sequence. More...

double	GetTrimRight () const noexcept
	Returns the play end offset in seconds from the ending of the underlying sequence. More...

void	TrimLeft (double deltaTime)
	Moves play start position by deltaTime. More...

void	TrimRight (double deltaTime)
	Moves play end position by deltaTime. More...

void	TrimLeftTo (double to)
	Sets the the left trimming to the absolute time (if that is in bounds) More...

void	TrimRightTo (double to)
	Sets the the right trimming to the absolute time (if that is in bounds) More...

void	ShiftBy (double delta) noexcept

bool	SplitsPlayRegion (double t) const
	[ < t and t < ), such that if the track were split at `t`, it would split this clip in two of lengths > 0. More...

bool	WithinPlayRegion (double t) const
	t ∈ [...) More...

bool	BeforePlayRegion (double t) const
	t < [ More...

bool	AtOrBeforePlayRegion (double t) const
	t <= [ More...

bool	AfterPlayRegion (double t) const
	) <= t More...

bool	EntirelyWithinPlayRegion (double t0, double t1) const
	t0 and t1 both ∈ [...) More...

bool	PartlyWithinPlayRegion (double t0, double t1) const
	t0 xor t1 ∈ [...) More...

bool	IntersectsPlayRegion (double t0, double t1) const
	[t0, t1) ∩ [...) != ∅ More...

bool	CoversEntirePlayRegion (double t0, double t1) const
	t0 <= [ and ) <= t1, such that removing [t0, t1) from the track deletes this clip. More...

sampleCount	CountSamples (double t0, double t1) const

AudioSegmentSampleView	GetSampleView (size_t iChannel, sampleCount start, size_t length, bool mayThrow=true) const override
	Request up to `length` samples. The actual number of samples available from the returned view is queried through `AudioSegmentSampleView::GetSampleCount()`. More...

AudioSegmentSampleView	GetSampleView (size_t iChannel, double t0, double t1, bool mayThrow=true) const
	Request interval samples within [t0, t1). `t0` and `t1` are truncated to the clip's play start and end. Stretching influences the number of samples fitting into [t0, t1), i.e., half as many for twice as large a stretch ratio, due to a larger spacing of the raw samples. The actual number of samples available from the returned view is queried through `AudioSegmentSampleView::GetSampleCount()`. More...

bool	GetSamples (size_t ii, samplePtr buffer, sampleFormat format, sampleCount start, size_t len, bool mayThrow=true) const
	Get samples from one channel. More...

bool	GetSamples (samplePtr buffers[], sampleFormat format, sampleCount start, size_t len, bool mayThrow=true) const
	Get (non-interleaved) samples from all channels. More...

void	SetSamples (size_t ii, constSamplePtr buffer, sampleFormat format, sampleCount start, size_t len, sampleFormat effectiveFormat)

bool	GetFloatAtTime (double t, size_t iChannel, float &value, bool mayThrow) const

Envelope *	GetEnvelope ()

const Envelope *	GetEnvelope () const

BlockArray *	GetSequenceBlockArray (size_t ii)

const BlockArray *	GetSequenceBlockArray (size_t ii) const

Sequence *	GetSequence (size_t ii)

const Sequence *	GetSequence (size_t ii) const

void	MarkChanged ()

std::pair< float, float >	GetMinMax (size_t ii, double t0, double t1, bool mayThrow) const

float	GetRMS (size_t ii, double t0, double t1, bool mayThrow) const

void	UpdateEnvelopeTrackLen ()

std::shared_ptr< SampleBlock >	AppendNewBlock (samplePtr buffer, sampleFormat format, size_t len)

void	AppendSharedBlock (const std::shared_ptr< SampleBlock > &pBlock)

bool	Append (constSamplePtr buffers[], sampleFormat format, size_t len, unsigned int stride, sampleFormat effectiveFormat)

void	Flush ()
	Flush must be called after last Append. More...

void	Clear (double t0, double t1)

void	ClearLeft (double t)

void	ClearRight (double t)

void	ClearAndAddCutLine (double t0, double t1)

bool	Paste (double t0, const WaveClip &other)
	Paste data from other clip, resampling it if not equal rate. More...

void	InsertSilence (double t, double len, double *pEnvelopeValue=nullptr)

void	AppendSilence (double len, double envelopeValue)

WaveClipHolders &	GetCutLines ()
	Get access to cut lines list. More...

const WaveClipConstHolders &	GetCutLines () const

size_t	NumCutLines () const

bool	FindCutLine (double cutLinePosition, double cutLineStart=NULL, double cutLineEnd=NULL) const

void	ExpandCutLine (double cutLinePosition)

bool	RemoveCutLine (double cutLinePosition)
	Remove cut line, without expanding the audio in it. More...

void	OffsetCutLines (double t0, double len)
	Offset cutlines right to time 't0' by time amount 'len'. More...

void	CloseLock () noexcept
	Should be called upon project close. Not balanced by unlocking calls. More...

bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override

void	HandleXMLEndTag (const std::string_view &tag) override

XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override

void	WriteXML (XMLWriter &xmlFile) const

bool	GetIsPlaceholder () const

void	SetIsPlaceholder (bool val)

bool	SharesBoundaryWithNextClip (const WaveClip *next) const

void	SetName (const wxString &name)

const wxString &	GetName () const

sampleCount	TimeToSamples (double time) const override

double	SamplesToTime (sampleCount s) const noexcept

void	SetSilence (sampleCount offset, sampleCount length)
	Silences the 'length' amount of samples starting from 'offset'(relative to the play start) More...

constSamplePtr	GetAppendBuffer (size_t ii) const
	Get one channel of the append buffer. More...

size_t	GetAppendBufferLen () const

void	OnProjectTempoChange (const std::optional< double > &oldTempo, double newTempo)


bool	HasEqualStretchRatio (const WaveClip &other) const

bool	StretchRatioEquals (double value) const


void	SetFloatsFromTime (double t, size_t iChannel, const float *buffer, size_t numSamples, sampleFormat effectiveFormat)
	Considers `buffer` as audio starting at `TimeToSamples(t)` (relative to clip play start time) and with equal stretch ratio. Samples at intersecting indices are then copied, leaving non-intersecting clip samples untouched. E.g., buffer: [a b c d e] clip : [x y z] result: [d e z]. More...

void	SetFloatsCenteredAroundTime (double t, size_t iChannel, const float *buffer, size_t numSideSamples, sampleFormat effectiveFormat)
	Same as `SetFloatsFromTime`, but with `buffer` starting at `TimeToSamples(t0 - SamplesToTime(numSideSamples))`. `[buffer, buffer + 2 * numSizeSamples + 1)` is assumed to be a valid span of addresses. More...

void	SetFloatAtTime (double t, size_t iChannel, float value, sampleFormat effectiveFormat)

Public Member Functions inherited from ClipInterface
	~ClipInterface () override

virtual AudioSegmentSampleView	GetSampleView (size_t iChannel, sampleCount start, size_t length, bool mayThrow=true) const =0

virtual size_t	GetWidth () const =0

Public Member Functions inherited from ClipTimes
virtual	~ClipTimes ()

virtual sampleCount	GetVisibleSampleCount () const =0

virtual int	GetRate () const =0

virtual double	GetPlayStartTime () const =0

virtual double	GetPlayEndTime () const =0

virtual sampleCount	TimeToSamples (double time) const =0

virtual double	GetStretchRatio () const =0

Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()

virtual	~XMLTagHandler ()

virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0

virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))

virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))

virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

Public Member Functions inherited from ClientData::Site< WaveClip, WaveClipListener >
	~Site ()

	Site ()

	Site (const Site &other)

	Site (Site &&other)

Site &	operator= (const Site &other)

Site &	operator= (Site &&other)

size_t	size () const
	How many attachment pointers are in the Site. More...

Subclass &	Get (const RegisteredFactory &key)
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...

auto	Get (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass & >
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...

Subclass *	Find (const RegisteredFactory &key)
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...

auto	Find (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass * >
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...

void	Assign (const RegisteredFactory &key, ReplacementPointer &&replacement)
	Reassign Site's pointer to ClientData. More...

Private Member Functions
	WaveClip (const WaveClip &)=delete

WaveClip &	operator= (const WaveClip &)=delete

sampleCount	TimeToSequenceSamples (double t) const

sampleCount	GetNumSamples () const

SampleFormats	GetSampleFormats () const

const SampleBlockFactoryPtr &	GetFactory ()

std::vector< std::unique_ptr< Sequence > >	GetEmptySequenceCopies () const

void	StretchCutLines (double ratioChange)

double	SnapToTrackSample (double time) const noexcept

void	ClearSequence (double t0, double t1)

Private Attributes
double	mClipStretchRatio = 1.

std::optional< double >	mRawAudioTempo

std::optional< double >	mProjectTempo

int	mRate
	Sample rate of the raw audio, i.e., before stretching. More...

int	mColourIndex

std::vector< std::unique_ptr< Sequence > >	mSequences

std::unique_ptr< Envelope >	mEnvelope
	Envelope is unique, not per-sequence. More...

WaveClipHolders	mCutLines {}

bool	mIsPlaceholder { false }

wxString	mName


double	mSequenceOffset { 0 }

double	mTrimLeft { 0 }

double	mTrimRight { 0 }

Additional Inherited Members
Static Public Member Functions inherited from ClientData::Site< WaveClip, WaveClipListener >
static size_t	numFactories ()
	How many static factories have been registered with this specialization of Site. More...

Protected Member Functions inherited from ClientData::Site< WaveClip, WaveClipListener >
void	ForEach (const Function &function)
	Invoke function on each ClientData object that has been created in `this`. More...

void	ForEach (const Function &function) const
	Invoke function on each ClientData object that has been created in `this`. More...

WaveClipListener *	FindIf (const Function &function)
	Return pointer to first attachment in `this` that is not null and satisfies a predicate, or nullptr. More...

const WaveClipListener *	FindIf (const Function &function) const
	Return pointer to first attachment in `this` that is not null and satisfies a predicate, or nullptr. More...

void	BuildAll ()
	For each RegisteredFactory, if the corresponding attachment is absent in `this`, build and store it. More...

Detailed Description

This allows multiple clips to be a part of one WaveTrack.

Definition at line 99 of file WaveClip.h.

Member Typedef Documentation

◆ Caches

using WaveClip::Caches = Site< WaveClip, WaveClipListener >

Definition at line 112 of file WaveClip.h.

Constructor & Destructor Documentation

◆ WaveClip() [1/4]

WaveClip::WaveClip ( const WaveClip & )

privatedelete

◆ WaveClip() [2/4]

WaveClip::WaveClip	(	size_t	width,
		const SampleBlockFactoryPtr &	factory,
		sampleFormat	format,
		int	rate,
		int	colourIndex
	)

typical constructor

Parameters

width how many sequences

Precondition: width > 0

Postcondition: GetWidth() == width

Definition at line 44 of file WaveClip.cpp.

{
   assert(width > 0);
   mRate = rate;
   mColourIndex = colourIndex;
   mSequences.resize(width);
   for (auto &pSequence : mSequences)
      pSequence = std::make_unique<Sequence>(factory,
         SampleFormats{narrowestSampleFormat, format});
 
   mEnvelope = std::make_unique<Envelope>(true, 1e-7, 2.0, 1.0);
   assert(CheckInvariants());
}

References CheckInvariants(), cloud::factory, anonymous_namespace{ExportPCM.cpp}::format, mColourIndex, mEnvelope, mRate, mSequences, and narrowestSampleFormat.

Here is the call graph for this function:

◆ WaveClip() [3/4]

WaveClip::WaveClip	(	const WaveClip &	orig,
		const SampleBlockFactoryPtr &	factory,
		bool	copyCutlines
	)

essentially a copy constructor - but you must pass in the current sample block factory, because we might be copying from one project to another

Postcondition: GetWidth() == orig.GetWidth()

Definition at line 60 of file WaveClip.cpp.

    : mClipStretchRatio { orig.mClipStretchRatio }
    , mRawAudioTempo { orig.mRawAudioTempo }
    , mProjectTempo { orig.mProjectTempo }
{
   // essentially a copy constructor - but you must pass in the
   // current sample block factory, because we might be copying
   // from one project to another
 
   mSequenceOffset = orig.mSequenceOffset;
   mTrimLeft = orig.mTrimLeft;
   mTrimRight = orig.mTrimRight;
   mRate = orig.mRate;
   mColourIndex = orig.mColourIndex;
   mSequences.reserve(orig.GetWidth());
   for (auto &pSequence : orig.mSequences)
      mSequences.push_back(
         std::make_unique<Sequence>(*pSequence, factory));
 
   mEnvelope = std::make_unique<Envelope>(*orig.mEnvelope);
 
   mName = orig.mName;
 
   if (copyCutlines)
      for (const auto &clip: orig.mCutLines)
         mCutLines.push_back(std::make_shared<WaveClip>(*clip, factory, true));
 
   mIsPlaceholder = orig.GetIsPlaceholder();
 
   assert(GetWidth() == orig.GetWidth());
   assert(CheckInvariants());
}

References CheckInvariants(), cloud::factory, GetIsPlaceholder(), GetWidth(), mColourIndex, mCutLines, mEnvelope, mIsPlaceholder, mName, mRate, mSequenceOffset, mSequences, mTrimLeft, and mTrimRight.

Here is the call graph for this function:

◆ WaveClip() [4/4]

WaveClip::WaveClip	(	const WaveClip &	orig,
		const SampleBlockFactoryPtr &	factory,
		bool	copyCutlines,
		double	t0,
		double	t1
	)

Copy only a range from the given WaveClip.

Precondition: CountSamples(t1, t0) > 0

Postcondition: GetWidth() == orig.GetWidth()

Definition at line 95 of file WaveClip.cpp.

    : mClipStretchRatio { orig.mClipStretchRatio }
    , mRawAudioTempo { orig.mRawAudioTempo }
    , mProjectTempo { orig.mProjectTempo }
{
   assert(orig.CountSamples(t0, t1) > 0);
 
   mSequenceOffset = orig.mSequenceOffset;
 
   //Adjust trim values to sample-boundary
   if(t0 > orig.GetPlayStartTime()) {
      const auto s0 = orig.TimeToSamples(t0 - orig.GetSequenceStartTime());
      mTrimLeft = orig.SamplesToTime(s0);
 
   }
   else
      mTrimLeft = orig.mTrimLeft;
 
   if(t1 < orig.GetPlayEndTime())
   {
      const auto s1 = orig.TimeToSamples(orig.GetSequenceEndTime() - t1);
      mTrimRight = orig.SamplesToTime(s1);
   }
   else
      mTrimRight = orig.mTrimRight;
 
   mRate = orig.mRate;
   mColourIndex = orig.mColourIndex;
 
   mIsPlaceholder = orig.GetIsPlaceholder();
 
   mSequences.reserve(orig.GetWidth());
   for (auto &pSequence : orig.mSequences)
      mSequences.push_back(
         std::make_unique<Sequence>(*pSequence, factory));
 
   mEnvelope = std::make_unique<Envelope>(*orig.mEnvelope);
 
   if (copyCutlines)
      for (const auto &cutline : orig.mCutLines)
         mCutLines.push_back(
            std::make_shared<WaveClip>(*cutline, factory, true));
 
   assert(GetWidth() == orig.GetWidth());
   assert(CheckInvariants());
}

References CheckInvariants(), CountSamples(), cloud::factory, GetIsPlaceholder(), GetPlayEndTime(), GetPlayStartTime(), GetSequenceEndTime(), GetSequenceStartTime(), GetWidth(), mColourIndex, mCutLines, mEnvelope, mIsPlaceholder, mRate, mSequenceOffset, mSequences, mTrimLeft, mTrimRight, SamplesToTime(), and TimeToSamples().

Here is the call graph for this function:

◆ ~WaveClip()

WaveClip::~WaveClip ( )

virtual

Definition at line 145 of file WaveClip.cpp.

146{

147}

Member Function Documentation

◆ AfterPlayRegion()

bool WaveClip::AfterPlayRegion ( double t ) const

) <= t

Definition at line 1502 of file WaveClip.cpp.

{
   return GetPlayEndTime() <= t;
}

References GetPlayEndTime().

Here is the call graph for this function:

◆ Append()

bool WaveClip::Append	(	constSamplePtr	buffers[],
		sampleFormat	format,
		size_t	len,
		unsigned int	stride,
		sampleFormat	effectiveFormat
	)

Append (non-interleaved) samples to all channels You must call Flush after the last Append

Returns: true if at least one complete block was created assume as many buffers available as GetWidth() In case of failure or exceptions, the clip contents are unchanged but un-flushed data are lost

Parameters

effectiveFormat Make the effective format of the data at least the minumum of this value and `format`. (Maybe wider, if merging with preexistent data.) If the data are later narrowed from stored format, but not narrower than the effective, then no dithering will occur.

Definition at line 488 of file WaveClip.cpp.

{
   Finally Do{ [this]{ assert(CheckInvariants()); } };
 
   Transaction transaction{ *this };
 
   //wxLogDebug(wxT("Append: len=%lli"), (long long) len);
 
   size_t ii = 0;
   bool appended = false;
   for (auto &pSequence : mSequences)
      appended =
         pSequence->Append(buffers[ii++], format, len, stride, effectiveFormat)
         || appended;
 
   transaction.Commit();
   // use No-fail-guarantee
   UpdateEnvelopeTrackLen();
   MarkChanged();
 
   return appended;
}

References CheckInvariants(), WaveClip::Transaction::Commit(), anonymous_namespace{ExportPCM.cpp}::format, MarkChanged(), mSequences, and UpdateEnvelopeTrackLen().

Here is the call graph for this function:

◆ AppendNewBlock()

std::shared_ptr< SampleBlock > WaveClip::AppendNewBlock	(	samplePtr	buffer,
		sampleFormat	format,
		size_t	len
	)

For use in importing pre-version-3 projects to preserve sharing of blocks; no dithering applied

Precondition: GetWidth() == 1

Exception safety guarantee:: Strong

Definition at line 470 of file WaveClip.cpp.

{
   // This is a special use function for legacy files only and this assertion
   // does not need to be relaxed
   assert(GetWidth() == 1);
   return mSequences[0]->AppendNewBlock( buffer, format, len );
}

References anonymous_namespace{ExportPCM.cpp}::format, GetWidth(), and mSequences.

Here is the call graph for this function:

◆ AppendSharedBlock()

void WaveClip::AppendSharedBlock ( const std::shared_ptr< SampleBlock > & pBlock )

For use in importing pre-version-3 projects to preserve sharing of blocks

Precondition: GetWidth() == 1

Exception safety guarantee:: Strong

Definition at line 480 of file WaveClip.cpp.

{
   // This is a special use function for legacy files only and this assertion
   // does not need to be relaxed
   assert(GetWidth() == 1);
   mSequences[0]->AppendSharedBlock( pBlock );
}

References GetWidth(), and mSequences.

Here is the call graph for this function:

◆ AppendSilence()

void WaveClip::AppendSilence	(	double	len,
		double	envelopeValue
	)

Insert silence at the end, and causes the envelope to ramp linearly to the given value

Exception safety guarantee:: Strong

Definition at line 801 of file WaveClip.cpp.

{
   auto t = GetPlayEndTime();
   InsertSilence( t, len, &envelopeValue );
}

References GetPlayEndTime(), and InsertSilence().

Here is the call graph for this function:

◆ ApplyStretchRatio()

void WaveClip::ApplyStretchRatio ( const std::function< void(double)> & reportProgress )

Renders the stretching of the clip (preserving duration).

Postcondition: GetStretchRatio() == 1

Definition at line 1182 of file WaveClip.cpp.

{
   const auto stretchRatio = GetStretchRatio();
   if (stretchRatio == 1.0)
      return;
 
   auto success = false;
   auto newSequences = GetEmptySequenceCopies();
   bool swappedOnce = false;
 
   Finally Do { [&, trimLeftBeforeStretch = GetTrimLeft(),
                 trimRightBeforeStretch = GetTrimRight(),
                 offsetBeforeStretch = GetSequenceStartTime()] {
      if (success)
      {
         this->mClipStretchRatio = 1.0;
         this->mRawAudioTempo = this->mProjectTempo;
         assert(this->GetStretchRatio() == 1.0);
      }
      else
      {
         this->SetTrimLeft(trimLeftBeforeStretch);
         this->SetTrimRight(trimRightBeforeStretch);
         this->SetSequenceStartTime(offsetBeforeStretch);
         if (swappedOnce)
            std::swap(mSequences, newSequences);
      }
   } };
 
   const auto originalPlayStartTime = GetPlayStartTime();
   const auto originalPlayEndTime = GetPlayEndTime();
 
   // Leave 1 second of raw, unstretched audio before and after visible region
   // to ensure the algorithm is in a steady state when reaching the play
   // boundaries.
   TrimLeftTo(originalPlayStartTime - stretchRatio);
   TrimRightTo(originalPlayEndTime + stretchRatio);
 
   // Let's not use the `durationToDiscard` functionality of the
   // `TimeAndPitchSource`: this determines the source readout offset. We want
   // to do better here: feed earlier samples, but discard the early output.
   constexpr auto sourceDurationToDiscard = 0.;
   constexpr auto blockSize = 1024;
   const auto numChannels = GetWidth();
 
   ClipTimeAndPitchSource stretcherSource { *this, sourceDurationToDiscard,
                                            PlaybackDirection::forward };
   TimeAndPitchInterface::Parameters params;
   params.timeRatio = stretchRatio;
   StaffPadTimeAndPitch stretcher { GetRate(), numChannels, stretcherSource,
                                    std::move(params) };
 
   // Post-rendering sample counts, i.e., stretched units
   int beginSamplesToDiscard =
      (originalPlayStartTime - GetPlayStartTime()) * GetRate() + .5;
   const int endSamplesToDiscard =
      (GetPlayEndTime() - originalPlayEndTime) * GetRate() + .5;
   const auto totalNumOutSamples =
      sampleCount { GetVisibleSampleCount().as_double() * stretchRatio -
                    beginSamplesToDiscard - endSamplesToDiscard + .5 };
 
   sampleCount numOutSamples { 0 };
   AudioContainer container(blockSize, numChannels);
   while (numOutSamples < totalNumOutSamples)
   {
      const auto numSamplesToGet =
         limitSampleBufferSize(blockSize, totalNumOutSamples - numOutSamples);
      stretcher.GetSamples(container.Get(), numSamplesToGet);
      const auto numSamplesToConsume =
         std::max(0, static_cast<int>(numSamplesToGet) - beginSamplesToDiscard);
      beginSamplesToDiscard -= numSamplesToGet - numSamplesToConsume;
      if (numSamplesToConsume == 0)
         continue;
      auto channel = 0u;
      for (auto& newSequence : newSequences)
         newSequence->Append(
            reinterpret_cast<samplePtr>(
               container.Get()[channel++] + numSamplesToGet -
               numSamplesToConsume),
            floatSample, numSamplesToConsume, 1,
            widestSampleFormat /* computed samples need dither */
         );
      numOutSamples += numSamplesToConsume;
      if (reportProgress)
         reportProgress(
            numOutSamples.as_double() / totalNumOutSamples.as_double());
   }
 
   std::swap(mSequences, newSequences);
   swappedOnce = true;
 
   // Now that sequences are swapped we don't have hidden data anymore. The
   // position of the visible part must be preserved, though.
   SetTrimLeft(0.);
   SetTrimRight(0.);
   SetSequenceStartTime(originalPlayStartTime);
 
   Flush();
   Caches::ForEach(std::mem_fn(&WaveClipListener::Invalidate));
 
   success = true;
}

References sampleCount::as_double(), floatSample, Flush(), forward, AudioContainer::Get(), GetEmptySequenceCopies(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSequenceStartTime(), GetStretchRatio(), GetTrimLeft(), GetTrimRight(), GetVisibleSampleCount(), GetWidth(), WaveClipListener::Invalidate(), limitSampleBufferSize(), mClipStretchRatio, mProjectTempo, mRawAudioTempo, mSequences, params, SetSequenceStartTime(), SetTrimLeft(), SetTrimRight(), anonymous_namespace{NoteTrack.cpp}::swap(), TrimLeftTo(), TrimRightTo(), and widestSampleFormat.

Here is the call graph for this function:

◆ AtOrBeforePlayRegion()

bool WaveClip::AtOrBeforePlayRegion ( double t ) const

t <= [

Definition at line 1497 of file WaveClip.cpp.

{
   return t <= GetPlayStartTime();
}

References GetPlayStartTime().

Here is the call graph for this function:

◆ BeforePlayRegion()

bool WaveClip::BeforePlayRegion ( double t ) const

t < [

Definition at line 1492 of file WaveClip.cpp.

{
   return t < GetPlayStartTime();
}

References GetPlayStartTime().

Referenced by EntirelyWithinPlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckInvariants()

bool WaveClip::CheckInvariants ( ) const

Check invariant conditions on mSequences and mCutlines.

Definition at line 1529 of file WaveClip.cpp.

{
   const auto width = GetWidth();
   auto iter = mSequences.begin(),
      end = mSequences.end();
   // There must be at least one pointer
   if (iter != end) {
      // All pointers mut be non-null
      auto &pFirst = *iter++;
      if (pFirst) {
         // All sequences must have the same lengths, append buffer lengths,
         // sample formats, and sample block factory
         return
         std::all_of(iter, end, [&](decltype(pFirst) pSequence) {
            return pSequence &&
               pSequence->GetNumSamples() == pFirst->GetNumSamples() &&
               pSequence->GetAppendBufferLen() == pFirst->GetAppendBufferLen()
                  &&
               pSequence->GetSampleFormats() == pFirst->GetSampleFormats() &&
               pSequence->GetFactory() == pFirst->GetFactory();
         }) &&
         // All cut lines are non-null, satisfy the invariants, and match width
         std::all_of(mCutLines.begin(), mCutLines.end(),
         [width](const WaveClipHolder &pCutLine) {
            return pCutLine && pCutLine->GetWidth() == width &&
               pCutLine->CheckInvariants();
         });
      }
   }
   return false;
}

References PackedArray::end(), GetWidth(), mCutLines, and mSequences.

Referenced by Append(), ClearAndAddCutLine(), HandleXMLEndTag(), Paste(), and WaveClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Clear()

void WaveClip::Clear	(	double	t0,
		double	t1
	)

This name is consistent with WaveTrack::Clear. It performs a "Cut" operation (but without putting the cut audio to the clipboard)

Exception safety guarantee:: Strong

Definition at line 808 of file WaveClip.cpp.

{
    auto st0 = t0;
    auto st1 = t1;
    auto offset = .0;
    if (st0 <= GetPlayStartTime())
    {
        offset = (t0 - GetPlayStartTime()) + GetTrimLeft();
        st0 = GetSequenceStartTime();
 
        SetTrimLeft(.0);
    }
    if (st1 >= GetPlayEndTime())
    {
        st1 = GetSequenceEndTime();
        SetTrimRight(.0);
    }
    ClearSequence(st0, st1);
 
    if (offset != .0)
       ShiftBy(offset);
}

References ClearSequence(), GetPlayEndTime(), GetPlayStartTime(), GetSequenceEndTime(), GetSequenceStartTime(), GetTrimLeft(), SetTrimLeft(), SetTrimRight(), and ShiftBy().

Here is the call graph for this function:

◆ ClearAndAddCutLine()

void WaveClip::ClearAndAddCutLine	(	double	t0,
		double	t1
	)

Clear, and add cut line that starts at t0 and contains everything until t1 if there is at least one clip sample between t0 and t1, noop otherwise.

Exception safety guarantee:: Weak – This WaveClip remains destructible in case of AudacityException. But some cutlines may be deleted

Definition at line 913 of file WaveClip.cpp.

{
   if (t0 > GetPlayEndTime() || t1 < GetPlayStartTime() || CountSamples(t0, t1) == 0)
      return; // no samples to remove
 
   Transaction transaction{ *this };
 
   const double clip_t0 = std::max( t0, GetPlayStartTime() );
   const double clip_t1 = std::min( t1, GetPlayEndTime() );
 
   auto newClip = std::make_shared<WaveClip>(
      *this, GetFactory(), true, clip_t0, clip_t1);
   if(t1 < GetPlayEndTime())
   {
      newClip->ClearSequence(t1, newClip->GetSequenceEndTime());
      newClip->SetTrimRight(.0);
   }
   if(t0 > GetPlayStartTime())
   {
      newClip->ClearSequence(newClip->GetSequenceStartTime(), t0);
      newClip->SetTrimLeft(.0);
   }
 
   newClip->SetSequenceStartTime( clip_t0 - GetSequenceStartTime() );
 
   // Remove cutlines from this clip that were in the selection, shift
   // left those that were after the selection
   // May DELETE as we iterate, so don't use range-for
   for (auto it = mCutLines.begin(); it != mCutLines.end();)
   {
      WaveClip* clip = it->get();
      double cutlinePosition = GetSequenceStartTime() + clip->GetSequenceStartTime();
      if (cutlinePosition >= t0 && cutlinePosition <= t1)
         it = mCutLines.erase(it);
      else
      {
         if (cutlinePosition >= t1)
         {
            clip->ShiftBy(clip_t0 - clip_t1);
         }
         ++it;
      }
   }
 
   // Clear actual audio data
   auto s0 = TimeToSequenceSamples(t0);
   auto s1 = TimeToSequenceSamples(t1);
 
   // use Weak-guarantee
   for (auto &pSequence : mSequences)
      pSequence->Delete(s0, s1-s0);
 
   // Collapse envelope
   auto sampleTime = 1.0 / GetRate();
   GetEnvelope()->CollapseRegion( t0, t1, sampleTime );
 
   transaction.Commit();
   MarkChanged();
 
   mCutLines.push_back(std::move(newClip));
 
   // New cutline was copied from this so will have correct width
   assert(CheckInvariants());
}

References CheckInvariants(), Envelope::CollapseRegion(), CountSamples(), GetEnvelope(), GetFactory(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSequenceStartTime(), MarkChanged(), mCutLines, min(), mSequences, ShiftBy(), and TimeToSequenceSamples().

Here is the call graph for this function:

◆ ClearLeft()

void WaveClip::ClearLeft ( double t )

Removes samples starting from the left boundary of the clip till t, if it's inside the play region. Also removes trimmed (hidden) data, if present. Changes offset to make remaining samples stay at their old place. Destructive operation.

Definition at line 831 of file WaveClip.cpp.

{
   if (t > GetPlayStartTime() && t < GetPlayEndTime())
   {
      ClearSequence(GetSequenceStartTime(), t);
      SetTrimLeft(.0);
      SetSequenceStartTime(t);
   }
}

References ClearSequence(), GetPlayEndTime(), GetPlayStartTime(), GetSequenceStartTime(), SetSequenceStartTime(), and SetTrimLeft().

Here is the call graph for this function:

◆ ClearRight()

void WaveClip::ClearRight ( double t )

Removes samples starting from t (if it's inside the clip), till the right boundary. Also removes trimmed (hidden) data, if present. Destructive operation.

Definition at line 841 of file WaveClip.cpp.

{
   if (t > GetPlayStartTime() && t < GetPlayEndTime())
   {
      ClearSequence(t, GetSequenceEndTime());
      SetTrimRight(.0);
   }
}

References ClearSequence(), GetPlayEndTime(), GetPlayStartTime(), GetSequenceEndTime(), and SetTrimRight().

Here is the call graph for this function:

◆ ClearSequence()

void WaveClip::ClearSequence	(	double	t0,
		double	t1
	)

private

This name is consistent with WaveTrack::Clear. It performs a "Cut" operation (but without putting the cut audio to the clipboard)

Definition at line 850 of file WaveClip.cpp.

{
   Transaction transaction{ *this };
 
    auto clip_t0 = std::max(t0, GetSequenceStartTime());
    auto clip_t1 = std::min(t1, GetSequenceEndTime());
 
    auto s0 = TimeToSequenceSamples(clip_t0);
    auto s1 = TimeToSequenceSamples(clip_t1);
 
    if (s0 != s1)
    {
        // use Strong-guarantee
        for (auto &pSequence : mSequences)
           pSequence->Delete(s0, s1 - s0);
 
        // use No-fail-guarantee in the remaining
 
        // msmeyer
        //
        // Delete all cutlines that are within the given area, if any.
        //
        // Note that when cutlines are active, two functions are used:
        // Clear() and ClearAndAddCutLine(). ClearAndAddCutLine() is called
        // whenever the user directly calls a command that removes some audio, e.g.
        // "Cut" or "Clear" from the menu. This command takes care about recursive
        // preserving of cutlines within clips. Clear() is called when internal
        // operations want to remove audio. In the latter case, it is the right
        // thing to just remove all cutlines within the area.
        //
 
        // May DELETE as we iterate, so don't use range-for
        for (auto it = mCutLines.begin(); it != mCutLines.end();)
        {
            WaveClip* clip = it->get();
            double cutlinePosition = GetSequenceStartTime() + clip->GetSequenceStartTime();
            if (cutlinePosition >= t0 && cutlinePosition <= t1)
            {
                // This cutline is within the area, DELETE it
                it = mCutLines.erase(it);
            }
            else
            {
                if (cutlinePosition >= t1)
                {
                    clip->ShiftBy(clip_t0 - clip_t1);
                }
                ++it;
            }
        }
 
        // Collapse envelope
        auto sampleTime = 1.0 / GetRate();
        GetEnvelope()->CollapseRegion(t0, t1, sampleTime);
    }
 
    transaction.Commit();
    MarkChanged();
}

References Envelope::CollapseRegion(), GetEnvelope(), GetRate(), GetSequenceEndTime(), GetSequenceStartTime(), MarkChanged(), mCutLines, min(), mSequences, ShiftBy(), and TimeToSequenceSamples().

Referenced by Clear(), ClearLeft(), ClearRight(), InsertSilence(), and Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CloseLock()

void WaveClip::CloseLock ( )

noexcept

Should be called upon project close. Not balanced by unlocking calls.

Exception safety guarantee:: No-fail

Definition at line 1061 of file WaveClip.cpp.

{
   // Don't need a Transaction for noexcept operations
   for (auto &pSequence : mSequences)
      pSequence->CloseLock();
   for (const auto &cutline: mCutLines)
      cutline->CloseLock();
}

References mCutLines, and mSequences.

◆ ConvertToSampleFormat()

void WaveClip::ConvertToSampleFormat	(	sampleFormat	format,
		const std::function< void(size_t)> &	progressReport = `{}`
	)

Definition at line 440 of file WaveClip.cpp.

{
   // Note:  it is not necessary to do this recursively to cutlines.
   // They get converted as needed when they are expanded.
 
   Transaction transaction{ *this };
 
   auto bChanged = mSequences[0]->ConvertToSampleFormat(format, progressReport);
   for (size_t ii = 1, width = GetWidth(); ii < width; ++ii) {
      bool alsoChanged =
         mSequences[ii]->ConvertToSampleFormat(format, progressReport);
      // Class invariant implies:
      assert(bChanged == alsoChanged);
   }
   if (bChanged)
      MarkChanged();
 
   transaction.Commit();
}

References anonymous_namespace{ExportPCM.cpp}::format, GetWidth(), MarkChanged(), and mSequences.

Here is the call graph for this function:

◆ CountSamples()

sampleCount WaveClip::CountSamples	(	double	t0,
		double	t1
	)		const

Counts number of samples within t0 and t1 region. t0 and t1 are rounded to the nearest clip sample boundary, i.e. relative to clips start time offset.

Returns: Number of samples within t0 and t1 if t1 > t0, 0 otherwise

Definition at line 1507 of file WaveClip.cpp.

{
   if(t0 < t1)
   {
      t0 = std::max(t0, GetPlayStartTime());
      t1 = std::min(t1, GetPlayEndTime());
      const auto s0 = TimeToSamples(t0 - GetPlayStartTime());
      const auto s1 = TimeToSamples(t1 - GetPlayStartTime());
      return s1 - s0;
   }
   return { 0 };
}

References GetPlayEndTime(), GetPlayStartTime(), min(), and TimeToSamples().

Referenced by ClearAndAddCutLine(), and WaveClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CoversEntirePlayRegion()

bool WaveClip::CoversEntirePlayRegion	(	double	t0,
		double	t1
	)		const

t0 <= [ and ) <= t1, such that removing [t0, t1) from the track deletes this clip.

Precondition: t0 <= t1

Definition at line 1486 of file WaveClip.cpp.

{
   assert(t0 <= t1);
   return t0 <= GetPlayStartTime() && GetPlayEndTime() <= t1;
}

References GetPlayEndTime(), and GetPlayStartTime().

Here is the call graph for this function:

◆ EntirelyWithinPlayRegion()

bool WaveClip::EntirelyWithinPlayRegion	(	double	t0,
		double	t1
	)		const

t0 and t1 both ∈ [...)

Precondition: t0 <= t1

Definition at line 1464 of file WaveClip.cpp.

{
   assert(t0 <= t1);
   // t1 is the open end of the interval, hence it's ok if it's equal to the
   // open end of the play region.
   return !BeforePlayRegion(t0) && t1 <= GetPlayEndTime();
}

References BeforePlayRegion(), and GetPlayEndTime().

Here is the call graph for this function:

◆ ExpandCutLine()

void WaveClip::ExpandCutLine ( double cutLinePosition )

Expand cut line (that is, re-insert audio, then DELETE audio saved in cut line). Returns true if a cut line could be found and successfully expanded, false otherwise

Exception safety guarantee:: Strong

Definition at line 999 of file WaveClip.cpp.

{
   auto end = mCutLines.end();
   auto it = std::find_if( mCutLines.begin(), end,
      [&](const WaveClipHolder &cutline) {
         return fabs(GetSequenceStartTime() + cutline->GetSequenceStartTime() - cutLinePosition) < 0.0001;
      } );
 
   if ( it != end ) {
      auto *cutline = it->get();
      // assume Strong-guarantee from Paste
 
      // Envelope::Paste takes offset into account, WaveClip::Paste doesn't!
      // Do this to get the right result:
      cutline->mEnvelope->SetOffset(0);
 
      bool success =
         Paste(GetSequenceStartTime() + cutline->GetSequenceStartTime(),
            *cutline);
      assert(success); // class invariant promises cutlines have correct width
 
      // Now erase the cutline,
      // but be careful to find it again, because Paste above may
      // have modified the array of cutlines (if our cutline contained
      // another cutline!), invalidating the iterator we had.
      end = mCutLines.end();
      it = std::find_if(mCutLines.begin(), end,
         [=](const WaveClipHolder &p) { return p.get() == cutline; });
      if (it != end)
         mCutLines.erase(it); // deletes cutline!
      else {
         wxASSERT(false);
      }
   }
}

References PackedArray::end(), GetSequenceStartTime(), mCutLines, and Paste().

Here is the call graph for this function:

◆ FindCutLine()

bool WaveClip::FindCutLine	(	double	cutLinePosition,
		double *	cutLineStart = `NULL`,
		double *	cutLineEnd = `NULL`
	)		const

Find cut line at (approximately) this position. Returns true and fills in cutLineStart and cutLineEnd (if specified) if a cut line at this position could be found. Return false otherwise.

Definition at line 978 of file WaveClip.cpp.

{
   for (const auto &cutline: mCutLines)
   {
      if (fabs(GetSequenceStartTime() + cutline->GetSequenceStartTime() - cutLinePosition) < 0.0001)
      {
         auto startTime = GetSequenceStartTime() + cutline->GetSequenceStartTime();
         if (cutlineStart)
            *cutlineStart = startTime;
         if (cutlineEnd)
            *cutlineEnd = startTime + cutline->SamplesToTime(cutline->GetVisibleSampleCount());
         return true;
      }
   }
 
   return false;
}

References GetSequenceStartTime(), and mCutLines.

Here is the call graph for this function:

◆ Flush()

void WaveClip::Flush ( )

Flush must be called after last Append.

In case of exceptions, the clip contents are unchanged but un-flushed data are lost

Definition at line 512 of file WaveClip.cpp.

{
   //wxLogDebug(wxT("WaveClip::Flush"));
   //wxLogDebug(wxT("   mAppendBufferLen=%lli"), (long long) mAppendBufferLen);
   //wxLogDebug(wxT("   previous sample count %lli"), (long long) mSequence->GetNumSamples());
 
   if (GetAppendBufferLen() > 0) {
 
      Transaction transaction{ *this };
 
      for (auto &pSequence : mSequences)
         pSequence->Flush();
 
      transaction.Commit();
 
      // No-fail operations
      UpdateEnvelopeTrackLen();
      MarkChanged();
   }
 
   //wxLogDebug(wxT("now sample count %lli"), (long long) mSequence->GetNumSamples());
}

References WaveClip::Transaction::Commit(), GetAppendBufferLen(), MarkChanged(), mSequences, and UpdateEnvelopeTrackLen().

Referenced by ApplyStretchRatio(), WaveTrack::FlushOne(), and Resample().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAppendBuffer()

constSamplePtr WaveClip::GetAppendBuffer ( size_t ii ) const

Get one channel of the append buffer.

Parameters

ii	identifies the channel

Precondition: ii < GetWidth()

Definition at line 387 of file WaveClip.cpp.

{
   assert(ii < GetWidth());
   return mSequences[ii]->GetAppendBuffer();
}

References GetWidth(), and mSequences.

Referenced by WaveChannelInterval::GetAppendBuffer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAppendBufferLen()

size_t WaveClip::GetAppendBufferLen ( ) const

Definition at line 265 of file WaveClip.cpp.

{
   // All append buffers have equal lengths by class invariant
   return mSequences[0]->GetAppendBufferLen();
}

References mSequences.

Referenced by Flush(), WaveChannelInterval::GetAppendBufferLen(), and GetPlayEndTime().

Here is the caller graph for this function:

◆ GetColourIndex()

int WaveClip::GetColourIndex ( ) const

inline

Definition at line 189 of file WaveClip.h.

189{ return mColourIndex; }

Referenced by WaveChannelInterval::GetColourIndex().

Here is the caller graph for this function:

◆ GetCutLines() [1/2]

WaveClipHolders & WaveClip::GetCutLines ( )

inline

Get access to cut lines list.

Definition at line 512 of file WaveClip.h.

512{ return mCutLines; }

◆ GetCutLines() [2/2]

const WaveClipConstHolders & WaveClip::GetCutLines ( ) const

inline

Definition at line 513 of file WaveClip.h.

514 { return reinterpret_cast< const WaveClipConstHolders& >( mCutLines ); }

WaveClipConstHolders

std::vector< std::shared_ptr< const WaveClip > > WaveClipConstHolders

Definition: WaveClip.h:47

◆ GetEmptySequenceCopies()

std::vector< std::unique_ptr< Sequence > > WaveClip::GetEmptySequenceCopies ( ) const

private

Definition at line 377 of file WaveClip.cpp.

{
   decltype(mSequences) newSequences;
   newSequences.reserve(mSequences.size());
   for (auto& pSequence : mSequences)
      newSequences.push_back(std::make_unique<Sequence>(
         pSequence->GetFactory(), pSequence->GetSampleFormats()));
   return newSequences;
}

References mSequences.

Referenced by ApplyStretchRatio(), and Resample().

Here is the caller graph for this function:

◆ GetEnvelope() [1/2]

Envelope * WaveClip::GetEnvelope ( )

inline

Definition at line 393 of file WaveClip.h.

393{ return mEnvelope.get(); }

Referenced by ClearAndAddCutLine(), ClearSequence(), WaveChannelInterval::GetEnvelope(), WaveTrack::GetEnvelopeAtTime(), AUPImportFileHandle::HandleEnvelope(), WaveTrack::HandleXMLChild(), and InsertSilence().

Here is the caller graph for this function:

◆ GetEnvelope() [2/2]

const Envelope * WaveClip::GetEnvelope ( ) const

inline

Definition at line 394 of file WaveClip.h.

394{ return mEnvelope.get(); }

◆ GetFactory()

const SampleBlockFactoryPtr & WaveClip::GetFactory ( )

private

Definition at line 371 of file WaveClip.cpp.

{
   // All sequences have the same factory by class invariant
   return mSequences[0]->GetFactory();
}

References mSequences.

Referenced by ClearAndAddCutLine(), Paste(), and WaveClip::Transaction::Transaction().

Here is the caller graph for this function:

◆ GetFloatAtTime()

bool WaveClip::GetFloatAtTime	(	double	t,
		size_t	iChannel,
		float &	value,
		bool	mayThrow
	)		const

Parameters

t	relative to clip start sample

Definition at line 204 of file WaveClip.cpp.

{
   if (!WithinPlayRegion(t))
      return false;
   const auto start = TimeToSamples(t);
   return GetSamples(
      iChannel, reinterpret_cast<samplePtr>(&value), floatSample, start, 1u,
      mayThrow);
}

References floatSample, GetSamples(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, TimeToSamples(), and WithinPlayRegion().

Here is the call graph for this function:

◆ GetIsPlaceholder()

bool WaveClip::GetIsPlaceholder ( ) const

inline

Definition at line 549 of file WaveClip.h.

549{ return mIsPlaceholder; }

Referenced by WaveClip().

Here is the caller graph for this function:

◆ GetMinMax()

std::pair< float, float > WaveClip::GetMinMax	(	size_t	ii,
		double	t0,
		double	t1,
		bool	mayThrow
	)		const

Getting high-level data for one channel for screen display and clipping calculations and Contrast

Parameters

ii	identifies the channel

Precondition: ii < GetWidth()

Definition at line 398 of file WaveClip.cpp.

{
   assert(ii < GetWidth());
   t0 = std::max(t0, GetPlayStartTime());
   t1 = std::min(t1, GetPlayEndTime());
   if (t0 > t1) {
      if (mayThrow)
         THROW_INCONSISTENCY_EXCEPTION;
      return {
         0.f,  // harmless, but unused since Sequence::GetMinMax does not use these values
         0.f   // harmless, but unused since Sequence::GetMinMax does not use these values
      };
   }
 
   if (t0 == t1)
      return{ 0.f, 0.f };
 
   auto s0 = TimeToSequenceSamples(t0);
   auto s1 = TimeToSequenceSamples(t1);
 
   return mSequences[ii]->GetMinMax(s0, s1 - s0, mayThrow);
}

References GetPlayEndTime(), GetPlayStartTime(), GetWidth(), min(), mSequences, THROW_INCONSISTENCY_EXCEPTION, and TimeToSequenceSamples().

Here is the call graph for this function:

◆ GetName()

const wxString & WaveClip::GetName ( ) const

Definition at line 1305 of file WaveClip.cpp.

{
   return mName;
}

References mName.

◆ GetNumSamples()

sampleCount WaveClip::GetNumSamples ( ) const

private

Definition at line 359 of file WaveClip.cpp.

{
   // All sequences have equal lengths by class invariant
   return mSequences[0]->GetNumSamples();
}

References mSequences.

Referenced by GetPlayEndTime(), GetSampleView(), GetSequenceEndTime(), GetSequenceSamplesCount(), GetVisibleSampleCount(), Resample(), SetRate(), TimeToSequenceSamples(), and UpdateEnvelopeTrackLen().

Here is the caller graph for this function:

◆ GetPlayDuration()

double WaveClip::GetPlayDuration ( ) const

Always a multiple of the track's sample period, whether the clip is stretched or not.

Definition at line 1362 of file WaveClip.cpp.

{
   return GetPlayEndTime() - GetPlayStartTime();
}

References GetPlayEndTime(), and GetPlayStartTime().

Referenced by anonymous_namespace{WaveTrack.cpp}::GetSampleAccessArgs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlayEndSample()

sampleCount WaveClip::GetPlayEndSample ( ) const

Real end time of the clip, quantized to raw sample rate (track's rate)

Definition at line 1372 of file WaveClip.cpp.

{
   return sampleCount { GetPlayEndTime() * mRate + 0.5 };
}

References GetPlayEndTime(), and mRate.

Referenced by WaveTrack::ReverseOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlayEndTime()

double WaveClip::GetPlayEndTime ( ) const

overridevirtual

Open-end of play region. Always a multiple of the track's sample period, whether the clip is stretched or not.

Implements ClipTimes.

Definition at line 1350 of file WaveClip.cpp.

{
    const auto numSamples = GetNumSamples();
    double maxLen = mSequenceOffset +
                    ((numSamples + GetAppendBufferLen()).as_double()) *
                       GetStretchRatio() / mRate -
                    mTrimRight;
    // JS: calculated value is not the length;
    // it is a maximum value and can be negative; no clipping to 0
    return SnapToTrackSample(maxLen);
}

References GetAppendBufferLen(), GetNumSamples(), GetStretchRatio(), mRate, mSequenceOffset, mTrimRight, and SnapToTrackSample().

Referenced by AUPImportFileHandle::AddSilence(), AfterPlayRegion(), AppendSilence(), ApplyStretchRatio(), WaveTrack::CanInsertClip(), Clear(), ClearAndAddCutLine(), WaveTrack::ClearAndPasteOne(), ClearLeft(), ClearRight(), CountSamples(), CoversEntirePlayRegion(), WaveChannelInterval::End(), EntirelyWithinPlayRegion(), WaveTrack::GetAdjacentClip(), GetMinMax(), GetPlayDuration(), GetPlayEndSample(), WaveChannelInterval::GetPlayEndTime(), InsertSilence(), IntersectsPlayRegion(), WaveTrackUtils::IsClipSelected(), WaveTrack::MergeOneClipPair(), Paste(), WaveTrack::PasteOne(), SplitsPlayRegion(), StretchLeftTo(), StretchRightTo(), TrimLeftTo(), WaveClip(), and WithinPlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlayStartSample()

sampleCount WaveClip::GetPlayStartSample ( ) const

Real start time of the clip, quantized to raw sample rate (track's rate)

Definition at line 1367 of file WaveClip.cpp.

{
   return sampleCount { GetPlayStartTime() * mRate + 0.5 };
}

References GetPlayStartTime(), and mRate.

Referenced by WaveTrack::ReverseOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlayStartTime()

double WaveClip::GetPlayStartTime ( ) const

overridevirtualnoexcept

Closed-begin of play region. Always a multiple of the track's sample period, whether the clip is stretched or not.

Implements ClipTimes.

Definition at line 1340 of file WaveClip.cpp.

{
   return SnapToTrackSample(mSequenceOffset + mTrimLeft);
}

References mSequenceOffset, mTrimLeft, and SnapToTrackSample().

Referenced by ApplyStretchRatio(), AtOrBeforePlayRegion(), BeforePlayRegion(), WaveTrack::CanInsertClip(), Clear(), ClearAndAddCutLine(), WaveTrack::ClearAndPasteOne(), ClearLeft(), ClearRight(), CountSamples(), CoversEntirePlayRegion(), WaveTrack::GetAdjacentClip(), GetMinMax(), GetPlayDuration(), GetPlayStartSample(), WaveChannelInterval::GetPlayStartTime(), anonymous_namespace{WaveTrack.cpp}::GetSampleAccessArgs(), InsertSilence(), IntersectsPlayRegion(), WaveTrackUtils::IsClipSelected(), WaveTrack::JoinOne(), Paste(), WaveTrack::PasteOne(), WaveTrack::RightmostOrNewClip(), SharesBoundaryWithNextClip(), SplitsPlayRegion(), WaveChannelInterval::Start(), StretchLeftTo(), StretchRightTo(), TrimRightTo(), WaveClip(), and WithinPlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRate()

int WaveClip::GetRate ( ) const

inlineoverridevirtual

Implements ClipTimes.

Definition at line 156 of file WaveClip.h.

   {
      return mRate;
   }

Referenced by ApplyStretchRatio(), ClearAndAddCutLine(), ClearSequence(), WaveChannelInterval::GetRate(), anonymous_namespace{WaveTrack.cpp}::GetSampleAccessArgs(), InsertSilence(), Paste(), anonymous_namespace{SampleHandle.cpp}::SampleResolutionTest(), SharesBoundaryWithNextClip(), and UpdateEnvelopeTrackLen().

Here is the caller graph for this function:

◆ GetRMS()

float WaveClip::GetRMS	(	size_t	ii,
		double	t0,
		double	t1,
		bool	mayThrow
	)		const

Getting high-level data for one channel for screen display and clipping calculations and Contrast

Parameters

ii	identifies the channel

Precondition: ii < GetWidth()

Definition at line 422 of file WaveClip.cpp.

{
   assert(ii < GetWidth());
   if (t0 > t1) {
      if (mayThrow)
         THROW_INCONSISTENCY_EXCEPTION;
      return 0.f;
   }
 
   if (t0 == t1)
      return 0.f;
 
   auto s0 = TimeToSequenceSamples(t0);
   auto s1 = TimeToSequenceSamples(t1);
 
   return mSequences[ii]->GetRMS(s0, s1-s0, mayThrow);
}

References GetWidth(), mSequences, THROW_INCONSISTENCY_EXCEPTION, and TimeToSequenceSamples().

Here is the call graph for this function:

◆ GetSampleFormats()

SampleFormats WaveClip::GetSampleFormats ( ) const

private

Definition at line 365 of file WaveClip.cpp.

{
   // All sequences have the same formats by class invariant
   return mSequences[0]->GetSampleFormats();
}

References mSequences.

Referenced by Paste().

Here is the caller graph for this function:

◆ GetSamples() [1/2]

bool WaveClip::GetSamples	(	samplePtr	buffers[],
		sampleFormat	format,
		sampleCount	start,
		size_t	len,
		bool	mayThrow = `true`
	)		const

Get (non-interleaved) samples from all channels.

assume as many buffers available as GetWidth()

Parameters

start relative to clip play start sample

Definition at line 181 of file WaveClip.cpp.

{
   bool result = true;
   for (size_t ii = 0, width = GetWidth(); result && ii < width; ++ii)
      result = GetSamples(ii, buffers[ii], format, start, len, mayThrow);
   return result;
}

References anonymous_namespace{ExportPCM.cpp}::format, GetSamples(), and GetWidth().

Here is the call graph for this function:

◆ GetSamples() [2/2]

bool WaveClip::GetSamples	(	size_t	ii,
		samplePtr	buffer,
		sampleFormat	format,
		sampleCount	start,
		size_t	len,
		bool	mayThrow = `true`
	)		const

Get samples from one channel.

Parameters

ii	identifies the channel
start	relative to clip play start sample

Precondition: ii < GetWidth()

Definition at line 172 of file WaveClip.cpp.

{
   assert(ii < GetWidth());
   return mSequences[ii]
      ->Get(buffer, format, start + TimeToSamples(mTrimLeft), len, mayThrow);
}

References anonymous_namespace{ExportPCM.cpp}::format, GetWidth(), mSequences, mTrimLeft, and TimeToSamples().

Referenced by GetFloatAtTime(), WaveChannelInterval::GetSamples(), and GetSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSampleView() [1/2]

AudioSegmentSampleView WaveClip::GetSampleView	(	size_t	iChannel,
		double	t0,
		double	t1,
		bool	mayThrow = `true`
	)		const

Request interval samples within [t0, t1). t0 and t1 are truncated to the clip's play start and end. Stretching influences the number of samples fitting into [t0, t1), i.e., half as many for twice as large a stretch ratio, due to a larger spacing of the raw samples. The actual number of samples available from the returned view is queried through AudioSegmentSampleView::GetSampleCount().

Precondition: iChannel < GetWidth(); stretched samples in [t0, t1) can be counted in a size_t

Definition at line 157 of file WaveClip.cpp.

{
   assert(iChannel < GetWidth());
   const auto start = TimeToSamples(std::max(0., t0));
   const auto length =
      (std::min(GetNumSamples(), TimeToSamples(t1)) - start).as_size_t();
   return GetSampleView(iChannel, start, length, mayThrow);
}

References GetNumSamples(), GetSampleView(), GetWidth(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, min(), and TimeToSamples().

Here is the call graph for this function:

◆ GetSampleView() [2/2]

AudioSegmentSampleView WaveClip::GetSampleView	(	size_t	iChannel,
		sampleCount	start,
		size_t	length,
		bool	mayThrow = `true`
	)		const

overridevirtual

Request up to length samples. The actual number of samples available from the returned view is queried through AudioSegmentSampleView::GetSampleCount().

Parameters

start index of first clip sample from play start

Precondition: iChannel < GetWidth()

Implements ClipInterface.

Definition at line 149 of file WaveClip.cpp.

{
   assert(ii < GetWidth());
   return mSequences[ii]->GetFloatSampleView(
      start + TimeToSamples(mTrimLeft), length, mayThrow);
}

References GetWidth(), mSequences, mTrimLeft, and TimeToSamples().

Referenced by WaveChannelInterval::GetSampleView(), and GetSampleView().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSequence() [1/2]

Sequence * WaveClip::GetSequence ( size_t ii )

inline

Get low-level access to a sequence. Whenever possible, don't use this, but use more high-level functions inside WaveClip (or add them if you think they are useful for general use)

Precondition: ii < GetWidth()

Definition at line 412 of file WaveClip.h.

                                    {
      assert(ii < GetWidth());
      return mSequences[ii].get();
   }

Referenced by WaveTrack::GetIdealBlockSize(), WaveChannelInterval::GetSequence(), and WaveTrack::HandleXMLChild().

Here is the caller graph for this function:

◆ GetSequence() [2/2]

const Sequence * WaveClip::GetSequence ( size_t ii ) const

inline

Get low-level access to a sequence. Whenever possible, don't use this, but use more high-level functions inside WaveClip (or add them if you think they are useful for general use)

Precondition: ii < GetWidth()

Definition at line 419 of file WaveClip.h.

419{ return mSequences[ii].get(); }

◆ GetSequenceBlockArray() [1/2]

BlockArray * WaveClip::GetSequenceBlockArray ( size_t ii )

Parameters

ii	identifies the channel

Precondition: ii < GetWidth()

Definition at line 253 of file WaveClip.cpp.

{
   assert(ii < GetWidth());
   return &mSequences[ii]->GetBlockArray();
}

References GetWidth(), and mSequences.

Here is the call graph for this function:

◆ GetSequenceBlockArray() [2/2]

const BlockArray * WaveClip::GetSequenceBlockArray ( size_t ii ) const

Parameters

ii	identifies the channel

Precondition: ii < GetWidth()

Definition at line 259 of file WaveClip.cpp.

{
   assert(ii < GetWidth());
   return &mSequences[ii]->GetBlockArray();
}

References GetWidth(), and mSequences.

Here is the call graph for this function:

◆ GetSequenceEndTime()

double WaveClip::GetSequenceEndTime ( ) const

Definition at line 1436 of file WaveClip.cpp.

{
   const auto numSamples = GetNumSamples();
   double maxLen = GetSequenceStartTime() +
                   numSamples.as_double() * GetStretchRatio() / mRate;
   return maxLen;
}

References GetNumSamples(), GetSequenceStartTime(), GetStretchRatio(), and mRate.

Referenced by Clear(), ClearRight(), ClearSequence(), InsertSilence(), Paste(), TimeToSequenceSamples(), TrimRightTo(), and WaveClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSequenceSamplesCount()

sampleCount WaveClip::GetSequenceSamplesCount ( ) const

Returns the total number of samples in all underlying sequences (but not counting the cutlines)

Definition at line 1335 of file WaveClip.cpp.

{
    return GetNumSamples() * GetWidth();
}

References GetNumSamples(), and GetWidth().

Here is the call graph for this function:

◆ GetSequenceStartSample()

sampleCount WaveClip::GetSequenceStartSample ( ) const

Returns the index of the first sample of the underlying sequence.

Definition at line 1444 of file WaveClip.cpp.

{
    return TimeToSamples(mSequenceOffset);
}

References mSequenceOffset, and TimeToSamples().

Here is the call graph for this function:

◆ GetSequenceStartTime()

double WaveClip::GetSequenceStartTime ( ) const

noexcept

Definition at line 1424 of file WaveClip.cpp.

{
    // JS: mSequenceOffset is the minimum value and it is returned; no clipping to 0
    return mSequenceOffset;
}

References mSequenceOffset.

Referenced by ApplyStretchRatio(), Clear(), ClearAndAddCutLine(), WaveTrack::ClearAndPasteOne(), ClearLeft(), ClearSequence(), ExpandCutLine(), FindCutLine(), GetSequenceEndTime(), InsertSilence(), OffsetCutLines(), Paste(), RemoveCutLine(), SetRate(), TimeToSequenceSamples(), and WaveClip().

Here is the caller graph for this function:

◆ GetStretchRatio()

double WaveClip::GetStretchRatio ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 339 of file WaveClip.cpp.

{
   const auto dstSrcRatio =
      mProjectTempo.has_value() && mRawAudioTempo.has_value() ?
         *mRawAudioTempo / *mProjectTempo :
         1.0;
   return mClipStretchRatio * dstSrcRatio;
}

References mClipStretchRatio, mProjectTempo, and mRawAudioTempo.

Referenced by ApplyStretchRatio(), GetPlayEndTime(), anonymous_namespace{WaveTrack.cpp}::GetSampleAccessArgs(), GetSequenceEndTime(), WaveChannelInterval::GetStretchRatio(), HasEqualStretchRatio(), SharesBoundaryWithNextClip(), StretchRatioEquals(), and TimeToSamples().

Here is the caller graph for this function:

◆ GetTrimLeft()

double WaveClip::GetTrimLeft ( ) const

noexcept

Returns the play start offset in seconds from the beginning of the underlying sequence.

Definition at line 1388 of file WaveClip.cpp.

{
    return mTrimLeft;
}

References mTrimLeft.

Referenced by ApplyStretchRatio(), Clear(), WaveTrack::ClearAndPasteOne(), WaveChannelInterval::GetTrimLeft(), and Paste().

Here is the caller graph for this function:

◆ GetTrimRight()

double WaveClip::GetTrimRight ( ) const

noexcept

Returns the play end offset in seconds from the ending of the underlying sequence.

Definition at line 1398 of file WaveClip.cpp.

{
    return mTrimRight;
}

References mTrimRight.

Referenced by ApplyStretchRatio(), WaveTrack::ClearAndPasteOne(), WaveChannelInterval::GetTrimRight(), and Paste().

Here is the caller graph for this function:

◆ GetVisibleSampleCount()

sampleCount WaveClip::GetVisibleSampleCount ( ) const

overridevirtual

Returns a number of raw samples, not accounting for stretching.

Implements ClipTimes.

Definition at line 1377 of file WaveClip.cpp.

{
    return GetNumSamples()
       - TimeToSamples(mTrimRight) - TimeToSamples(mTrimLeft);
}

References GetNumSamples(), mTrimLeft, mTrimRight, and TimeToSamples().

Referenced by ApplyStretchRatio(), anonymous_namespace{WaveTrack.cpp}::GetSampleAccessArgs(), WaveChannelInterval::GetVisibleSampleCount(), SetFloatsFromTime(), and SharesBoundaryWithNextClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetWidth()

size_t WaveClip::GetWidth ( ) const

overridevirtual

How many Sequences the clip contains. Set at construction time; changes only if increased by deserialization

Implements ClipInterface.

Definition at line 167 of file WaveClip.cpp.

{
   return mSequences.size();
}

References mSequences.

Referenced by AppendNewBlock(), AppendSharedBlock(), ApplyStretchRatio(), CheckInvariants(), WaveTrack::ClearAndPasteOne(), ConvertToSampleFormat(), GetAppendBuffer(), GetMinMax(), GetRMS(), GetSamples(), GetSampleView(), GetSequenceBlockArray(), GetSequenceSamplesCount(), Paste(), SetSamples(), and WaveClip().

Here is the caller graph for this function:

◆ HandleXMLChild()

XMLTagHandler * WaveClip::HandleXMLChild ( const std::string_view & tag )

overridevirtual

Implements XMLTagHandler.

Definition at line 611 of file WaveClip.cpp.

{
   auto &pFirst = mSequences[0];
   if (tag == "sequence") {
      mSequences.push_back(std::make_unique<Sequence>(
         pFirst->GetFactory(), pFirst->GetSampleFormats()));
      return mSequences.back().get();
   }
   else if (tag == "envelope")
      return mEnvelope.get();
   else if (tag == "waveclip")
   {
      // Nested wave clips are cut lines
      auto format = pFirst->GetSampleFormats().Stored();
      // The format is not stored in WaveClip itself but passed to
      // Sequence::Sequence; but then the Sequence will deserialize format
      // again
      mCutLines.push_back(
         std::make_shared<WaveClip>(
            // Make only one channel now, but recursive deserialization
            // increases the width later
            1, pFirst->GetFactory(),
            format, mRate, 0 /*colourindex*/));
      return mCutLines.back().get();
   }
   else
      return NULL;
}

References anonymous_namespace{ExportPCM.cpp}::format, mCutLines, mEnvelope, mRate, and mSequences.

Referenced by AUPImportFileHandle::HandleSequence(), and AUPImportFileHandle::HandleWaveClip().

Here is the caller graph for this function:

◆ HandleXMLEndTag()

void WaveClip::HandleXMLEndTag ( const std::string_view & tag )

override

Definition at line 597 of file WaveClip.cpp.

{
   // All blocks were deserialized into new sequences; remove the one made
   // by the constructor which remains empty.
   mSequences.erase(mSequences.begin());
   mSequences.shrink_to_fit();
   if (tag == "waveclip")
      UpdateEnvelopeTrackLen();
   // A proof of this assertion assumes that nothing has happened since
   // construction of this, besides calls to the other deserialization
   // functions
   assert(CheckInvariants());
}

References CheckInvariants(), mSequences, and UpdateEnvelopeTrackLen().

Referenced by WaveTrack::HandleXMLEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleXMLTag()

bool WaveClip::HandleXMLTag	(	const std::string_view &	tag,
		const AttributesList &	attrs
	)

overridevirtual

Implements XMLTagHandler.

Definition at line 535 of file WaveClip.cpp.

{
   if (tag == "waveclip")
   {
      double dblValue;
      long longValue;
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (attr == "offset")
         {
            if (!value.TryGet(dblValue))
               return false;
            SetSequenceStartTime(dblValue);
         }
         else if (attr == "trimLeft")
         {
            if (!value.TryGet(dblValue))
               return false;
            SetTrimLeft(dblValue);
         }
         else if (attr == "trimRight")
         {
            if (!value.TryGet(dblValue))
               return false;
            SetTrimRight(dblValue);
         }
         else if (attr == "rawAudioTempo")
         {
            if (!value.TryGet(dblValue))
               return false;
            if (dblValue == 0)
               mRawAudioTempo.reset();
            else
               mRawAudioTempo = dblValue;
         }
         else if (attr == "clipStretchRatio")
         {
            if (!value.TryGet(dblValue))
               return false;
            mClipStretchRatio = dblValue;
         }
         else if (attr == "name")
         {
            if(value.IsStringView())
               SetName(value.ToWString());
         }
         else if (attr == "colorindex")
         {
            if (!value.TryGet(longValue))
               return false;
            SetColourIndex(longValue);
         }
      }
      return true;
   }
 
   return false;
}

References mClipStretchRatio, mRawAudioTempo, SetColourIndex(), SetName(), SetSequenceStartTime(), SetTrimLeft(), and SetTrimRight().

Here is the call graph for this function:

◆ HasEqualStretchRatio()

bool WaveClip::HasEqualStretchRatio ( const WaveClip & other ) const

Checks for stretch-ratio equality, accounting for rounding errors.

Definition at line 348 of file WaveClip.cpp.

{
   return StretchRatioEquals(other.GetStretchRatio());
}

References GetStretchRatio(), and StretchRatioEquals().

Referenced by WaveTrack::ClearAndPasteOne(), and WaveTrack::MergeOneClipPair().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InsertSilence()

void WaveClip::InsertSilence	(	double	t,
		double	len,
		double *	pEnvelopeValue = `nullptr`
	)

Insert silence - note that this is an efficient operation for large amounts of silence

Exception safety guarantee:: Strong

Definition at line 757 of file WaveClip.cpp.

{
   Transaction transaction{ *this };
 
   if (t == GetPlayStartTime() && t > GetSequenceStartTime())
      ClearSequence(GetSequenceStartTime(), t);
   else if (t == GetPlayEndTime() && t < GetSequenceEndTime()) {
      ClearSequence(t, GetSequenceEndTime());
      SetTrimRight(.0);
   }
 
   auto s0 = TimeToSequenceSamples(t);
   auto slen = (sampleCount)floor(len * mRate + 0.5);
 
   // use Strong-guarantee
   for (auto &pSequence : mSequences)
      pSequence->InsertSilence(s0, slen);
 
   transaction.Commit();
 
   // use No-fail-guarantee
   OffsetCutLines(t, len);
 
   const auto sampleTime = 1.0 / GetRate();
   auto pEnvelope = GetEnvelope();
   if ( pEnvelopeValue ) {
 
      // Preserve limit value at the end
      auto oldLen = pEnvelope->GetTrackLen();
      auto newLen = oldLen + len;
      pEnvelope->Cap( sampleTime );
 
      // Ramp across the silence to the given value
      pEnvelope->SetTrackLen( newLen, sampleTime );
      pEnvelope->InsertOrReplace
         ( pEnvelope->GetOffset() + newLen, *pEnvelopeValue );
   }
   else
      pEnvelope->InsertSpace( t, len );
 
   MarkChanged();
}

References ClearSequence(), GetEnvelope(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSequenceEndTime(), GetSequenceStartTime(), MarkChanged(), mRate, mSequences, OffsetCutLines(), SetTrimRight(), and TimeToSequenceSamples().

Referenced by AUPImportFileHandle::AddSilence(), and AppendSilence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IntersectsPlayRegion()

bool WaveClip::IntersectsPlayRegion	(	double	t0,
		double	t1
	)		const

[t0, t1) ∩ [...) != ∅

Precondition: t0 <= t1

Definition at line 1478 of file WaveClip.cpp.

{
   assert(t0 <= t1);
   // t1 is the open end of the interval, so it must be excluded from the closed
   // begin of the play region.
   return t0 < GetPlayEndTime() && GetPlayStartTime() < t1;
}

References GetPlayEndTime(), and GetPlayStartTime().

Referenced by WaveChannelInterval::Intersects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MarkChanged()

void WaveClip::MarkChanged ( )

WaveTrack calls this whenever data in the wave clip changes. It is called automatically when WaveClip has a chance to know that something has changed, like when member functions SetSamples() etc. are called.

Exception safety guarantee:: No-fail

Definition at line 393 of file WaveClip.cpp.

{
   Caches::ForEach( std::mem_fn( &WaveClipListener::MarkChanged ) );
}

References WaveClipListener::MarkChanged().

Referenced by Append(), ClearAndAddCutLine(), ClearSequence(), ConvertToSampleFormat(), Flush(), InsertSilence(), Paste(), SetRate(), SetSamples(), and SetSilence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NumCutLines()

size_t WaveClip::NumCutLines ( ) const

inline

Definition at line 515 of file WaveClip.h.

515{ return mCutLines.size(); }

◆ OffsetCutLines()

void WaveClip::OffsetCutLines	(	double	t0,
		double	len
	)

Offset cutlines right to time 't0' by time amount 'len'.

Exception safety guarantee:: No-fail

Definition at line 1052 of file WaveClip.cpp.

{
   for (const auto &cutLine : mCutLines)
   {
      if (GetSequenceStartTime() + cutLine->GetSequenceStartTime() >= t0)
         cutLine->ShiftBy(len);
   }
}

References GetSequenceStartTime(), and mCutLines.

Referenced by InsertSilence(), and Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnProjectTempoChange()

void WaveClip::OnProjectTempoChange	(	const std::optional< double > &	oldTempo,
		double	newTempo
	)

Definition at line 271 of file WaveClip.cpp.

{
   if (!mRawAudioTempo.has_value())
      // When we have tempo detection ready (either by header-file
      // read-up or signal analysis) we can use something smarter than that. In
      // the meantime, use the tempo of the project when the clip is created as
      // source tempo.
      mRawAudioTempo = oldTempo;
 
   if (oldTempo.has_value())
   {
      const auto ratioChange = *mProjectTempo / newTempo;
      mSequenceOffset *= ratioChange;
      mTrimLeft *= ratioChange;
      mTrimRight *= ratioChange;
      StretchCutLines(ratioChange);
      mEnvelope->RescaleTimesBy(ratioChange);
   }
   mProjectTempo = newTempo;
}

References mEnvelope, mProjectTempo, mRawAudioTempo, mSequenceOffset, mTrimLeft, mTrimRight, and StretchCutLines().

Here is the call graph for this function:

◆ operator=()

WaveClip & WaveClip::operator= ( const WaveClip & )

privatedelete

◆ PartlyWithinPlayRegion()

bool WaveClip::PartlyWithinPlayRegion	(	double	t0,
		double	t1
	)		const

t0 xor t1 ∈ [...)

Precondition: t0 <= t1

Definition at line 1472 of file WaveClip.cpp.

{
   assert(t0 <= t1);
   return WithinPlayRegion(t0) != WithinPlayRegion(t1);
}

References WithinPlayRegion().

Here is the call graph for this function:

◆ Paste()

bool WaveClip::Paste	(	double	t0,
		const WaveClip &	other
	)

Paste data from other clip, resampling it if not equal rate.

Returns: true and succeed if and only if this->GetWidth() == other.GetWidth()

Exception safety guarantee:: Strong

Definition at line 663 of file WaveClip.cpp.

{
   if (GetWidth() != other.GetWidth())
      return false;
 
   Finally Do{ [this]{ assert(CheckInvariants()); } };
 
   Transaction transaction{ *this };
 
   const bool clipNeedsResampling = other.mRate != mRate;
   const bool clipNeedsNewFormat =
      other.GetSampleFormats().Stored() != GetSampleFormats().Stored();
   std::shared_ptr<WaveClip> newClip;
 
   t0 = std::clamp(t0, GetPlayStartTime(), GetPlayEndTime());
 
   //seems like edge cases cannot happen, see WaveTrack::PasteWaveTrack
   auto &factory = GetFactory();
   if (t0 == GetPlayStartTime())
   {
       ClearSequence(GetSequenceStartTime(), t0);
       SetTrimLeft(other.GetTrimLeft());
 
       auto copy = std::make_shared<WaveClip>(other, factory, true);
       copy->ClearSequence(copy->GetPlayEndTime(), copy->GetSequenceEndTime());
       newClip = std::move(copy);
   }
   else if (t0 == GetPlayEndTime())
   {
       ClearSequence(GetPlayEndTime(), GetSequenceEndTime());
       SetTrimRight(other.GetTrimRight());
 
       auto copy = std::make_shared<WaveClip>(other, factory, true);
       copy->ClearSequence(copy->GetSequenceStartTime(), copy->GetPlayStartTime());
       newClip = std::move(copy);
   }
   else
   {
      newClip = std::make_shared<WaveClip>(other, factory, true);
      newClip->ClearSequence(newClip->GetPlayEndTime(), newClip->GetSequenceEndTime());
      newClip->ClearSequence(newClip->GetSequenceStartTime(), newClip->GetPlayStartTime());
      newClip->SetTrimLeft(0);
      newClip->SetTrimRight(0);
   }
 
   if (clipNeedsResampling || clipNeedsNewFormat)
   {
      auto copy = std::make_shared<WaveClip>(*newClip.get(), factory, true);
      if (clipNeedsResampling)
         // The other clip's rate is different from ours, so resample
          copy->Resample(mRate);
      if (clipNeedsNewFormat)
         // Force sample formats to match.
         copy->ConvertToSampleFormat(GetSampleFormats().Stored());
      newClip = std::move(copy);
   }
 
   // Paste cut lines contained in pasted clip
   WaveClipHolders newCutlines;
   for (const auto &cutline: newClip->mCutLines)
   {
      auto cutlineCopy = std::make_shared<WaveClip>(*cutline, factory,
         // Recursively copy cutlines of cutlines.  They don't need
         // their offsets adjusted.
         true);
      cutlineCopy->ShiftBy(t0 - GetSequenceStartTime());
      newCutlines.push_back(std::move(cutlineCopy));
   }
 
   sampleCount s0 = TimeToSequenceSamples(t0);
 
   // Because newClip was made above as a copy of (a copy of) other
   assert(other.GetWidth() == newClip->GetWidth());
   // And other has the same width as this, so this loop is safe
   // Assume Strong-guarantee from Sequence::Paste
   for (size_t ii = 0, width = GetWidth(); ii < width; ++ii)
      mSequences[ii]->Paste(s0, newClip->mSequences[ii].get());
 
   transaction.Commit();
 
   // Assume No-fail-guarantee in the remaining
   MarkChanged();
   auto sampleTime = 1.0 / GetRate();
   mEnvelope->PasteEnvelope
      (s0.as_double()/mRate + GetSequenceStartTime(), newClip->mEnvelope.get(), sampleTime);
   OffsetCutLines(t0, newClip->GetPlayEndTime() - newClip->GetPlayStartTime());
 
   for (auto &holder : newCutlines)
      mCutLines.push_back(std::move(holder));
 
   return true;
}

References sampleCount::as_double(), CheckInvariants(), ClearSequence(), staffpad::vo::copy(), cloud::factory, GetFactory(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSampleFormats(), GetSequenceEndTime(), GetSequenceStartTime(), GetTrimLeft(), GetTrimRight(), GetWidth(), MarkChanged(), mCutLines, mEnvelope, mRate, mSequences, OffsetCutLines(), Paste(), SetTrimLeft(), SetTrimRight(), SampleFormats::Stored(), and TimeToSequenceSamples().

Referenced by WaveTrack::ClearAndPasteOne(), ExpandCutLine(), WaveTrack::MergeOneClipPair(), Paste(), and WaveTrack::PasteOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveCutLine()

bool WaveClip::RemoveCutLine ( double cutLinePosition )

Remove cut line, without expanding the audio in it.

Definition at line 1035 of file WaveClip.cpp.

{
   for (auto it = mCutLines.begin(); it != mCutLines.end(); ++it)
   {
      const auto &cutline = *it;
      //std::numeric_limits<double>::epsilon() or (1.0 / static_cast<double>(mRate))?
      if (fabs(GetSequenceStartTime() + cutline->GetSequenceStartTime() - cutLinePosition) < 0.0001)
      {
         mCutLines.erase(it); // deletes cutline!
         return true;
      }
   }
 
   return false;
}

References GetSequenceStartTime(), and mCutLines.

Here is the call graph for this function:

◆ Resample()

void WaveClip::Resample	(	int	rate,
		BasicUI::ProgressDialog *	progress = `nullptr`
	)

Exception safety guarantee:: Strong

We want to keep going as long as we have something to feed the resampler with OR as long as the resampler spews out samples (which could continue for a few iterations after we stop feeding it)

Definition at line 1085 of file WaveClip.cpp.

{
   // Note:  it is not necessary to do this recursively to cutlines.
   // They get resampled as needed when they are expanded.
 
   if (rate == mRate)
      return; // Nothing to do
 
   // This function does its own RAII without a Transaction
 
   double factor = (double)rate / (double)mRate;
   ::Resample resample(true, factor, factor); // constant rate resampling
 
   const size_t bufsize = 65536;
   Floats inBuffer{ bufsize };
   Floats outBuffer{ bufsize };
   sampleCount pos = 0;
   bool error = false;
   int outGenerated = 0;
   const auto numSamples = GetNumSamples();
 
   // These sequences are appended to below
   auto newSequences = GetEmptySequenceCopies();
 
   while (pos < numSamples || outGenerated > 0) {
      const auto inLen = limitSampleBufferSize( bufsize, numSamples - pos );
 
      bool isLast = ((pos + inLen) == numSamples);
 
      auto ppNewSequence = newSequences.begin();
      std::optional<std::pair<size_t, size_t>> results{};
      for (auto &pSequence : mSequences) {
         auto &pNewSequence = *ppNewSequence++;
         if (!pSequence->Get((samplePtr)inBuffer.get(), floatSample, pos, inLen, true))
         {
            error = true;
            break;
         }
 
         // Expect the same results for all channels, or else fail
         auto newResults = resample.Process(factor, inBuffer.get(), inLen,
            isLast, outBuffer.get(), bufsize);
         if (!results)
            results.emplace(newResults);
         else if (*results != newResults) {
            error = true;
            break;
         }
 
         outGenerated = results->second;
         if (outGenerated < 0) {
            error = true;
            break;
         }
 
         pNewSequence->Append((samplePtr)outBuffer.get(), floatSample,
            outGenerated, 1,
            widestSampleFormat /* computed samples need dither */
         );
      }
      if (results)
         pos += results->first;
 
      if (progress)
      {
         auto updateResult = progress->Poll(
            pos.as_long_long(),
            numSamples.as_long_long()
         );
         error = (updateResult != BasicUI::ProgressResult::Success);
         if (error)
            throw UserException{};
      }
   }
 
   if (error)
      throw SimpleMessageBoxException{
         ExceptionType::Internal,
         XO("Resampling failed."),
         XO("Warning"),
         "Error:_Resampling"
      };
   else
   {
      // Use No-fail-guarantee in these steps
      mSequences = move(newSequences);
      mRate = rate;
      Flush();
      Caches::ForEach( std::mem_fn( &WaveClipListener::Invalidate ) );
   }
}

References sampleCount::as_long_long(), floatSample, Flush(), GetEmptySequenceCopies(), GetNumSamples(), Internal, WaveClipListener::Invalidate(), limitSampleBufferSize(), mRate, mSequences, BasicUI::ProgressDialog::Poll(), Resample::Process(), BasicUI::Success, widestSampleFormat, and XO().

Here is the call graph for this function:

◆ SamplesToTime()

double WaveClip::SamplesToTime ( sampleCount s ) const

noexcept

Definition at line 1315 of file WaveClip.cpp.

{
   return s.as_double() * GetStretchRatio() / mRate;
}

Referenced by anonymous_namespace{WaveTrack.cpp}::RoundToNearestClipSample(), SetFloatsCenteredAroundTime(), SetRate(), and WaveClip().

Here is the caller graph for this function:

◆ SetColourIndex()

void WaveClip::SetColourIndex ( int index )

inline

Definition at line 188 of file WaveClip.h.

188{ mColourIndex = index; }

Referenced by HandleXMLTag().

Here is the caller graph for this function:

◆ SetFloatAtTime()

void WaveClip::SetFloatAtTime	(	double	t,
		size_t	iChannel,
		float	value,
		sampleFormat	effectiveFormat
	)

Definition at line 247 of file WaveClip.cpp.

{
   SetFloatsCenteredAroundTime(t, iChannel, &value, 0u, effectiveFormat);
}

References anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, and SetFloatsCenteredAroundTime().

Here is the call graph for this function:

◆ SetFloatsCenteredAroundTime()

void WaveClip::SetFloatsCenteredAroundTime	(	double	t,
		size_t	iChannel,
		const float *	buffer,
		size_t	numSideSamples,
		sampleFormat	effectiveFormat
	)

Same as SetFloatsFromTime, but with buffer starting at TimeToSamples(t0 - SamplesToTime(numSideSamples)). [buffer, buffer + 2 * numSizeSamples + 1) is assumed to be a valid span of addresses.

Definition at line 238 of file WaveClip.cpp.

{
   SetFloatsFromTime(
      t - SamplesToTime(numSideSamples), iChannel, buffer,
      2 * numSideSamples + 1, effectiveFormat);
}

References anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, SamplesToTime(), and SetFloatsFromTime().

Referenced by SetFloatAtTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFloatsFromTime()

void WaveClip::SetFloatsFromTime	(	double	t,
		size_t	iChannel,
		const float *	buffer,
		size_t	numSamples,
		sampleFormat	effectiveFormat
	)

Considers buffer as audio starting at TimeToSamples(t) (relative to clip play start time) and with equal stretch ratio. Samples at intersecting indices are then copied, leaving non-intersecting clip samples untouched. E.g., buffer: [a b c d e] clip : [x y z] result: [d e z].

Succeed with out-of-bounds requests, only changing what is in bounds.

Definition at line 215 of file WaveClip.cpp.

{
   const auto maybeNegativeStart = TimeToSamples(t);
   const auto maybeOutOfBoundEnd = maybeNegativeStart + numFloats;
   const auto effectiveStart = std::max(sampleCount { 0 }, maybeNegativeStart);
   const auto effectiveEnd =
      std::min(GetVisibleSampleCount(), maybeOutOfBoundEnd);
   if (effectiveStart >= effectiveEnd)
      return;
   // Cannot be greater than `numFloats` -> safe cast
   const auto effectiveLen = (effectiveEnd - effectiveStart).as_size_t();
   // Cannot be greater than `numFloats` -> safe cast
   const auto numLeadingZeros =
      (effectiveStart - maybeNegativeStart).as_size_t();
   const auto offsetBuffer =
      reinterpret_cast<const char*>(buffer + numLeadingZeros);
   SetSamples(
      iChannel, offsetBuffer, floatSample, effectiveStart, effectiveLen,
      effectiveFormat);
}

References floatSample, GetVisibleSampleCount(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, min(), SetSamples(), and TimeToSamples().

Referenced by SetFloatsCenteredAroundTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetIsPlaceholder()

void WaveClip::SetIsPlaceholder ( bool val )

inline

Definition at line 550 of file WaveClip.h.

550{ mIsPlaceholder = val; }

◆ SetName()

void WaveClip::SetName ( const wxString & name )

Definition at line 1300 of file WaveClip.cpp.

{
   mName = name;
}

References mName, and name.

Referenced by HandleXMLTag(), and PasteOverPreservingClips().

Here is the caller graph for this function:

◆ SetPlayStartTime()

void WaveClip::SetPlayStartTime ( double time )

Definition at line 1345 of file WaveClip.cpp.

{
   SetSequenceStartTime(time - mTrimLeft);
}

References mTrimLeft, and SetSequenceStartTime().

Here is the call graph for this function:

◆ SetRate()

void WaveClip::SetRate ( int rate )

Definition at line 1070 of file WaveClip.cpp.

{
   const auto trimLeftSampleNum = TimeToSamples(mTrimLeft);
   const auto trimRightSampleNum = TimeToSamples(mTrimRight);
   auto ratio = static_cast<double>(mRate) / rate;
   mRate = rate;
   mTrimLeft = SamplesToTime(trimLeftSampleNum);
   mTrimRight = SamplesToTime(trimRightSampleNum);
   auto newLength = GetNumSamples().as_double() / mRate;
   mEnvelope->RescaleTimes( newLength );
   MarkChanged();
   SetSequenceStartTime(GetSequenceStartTime() * ratio);
}

References sampleCount::as_double(), GetNumSamples(), GetSequenceStartTime(), MarkChanged(), mEnvelope, mRate, mTrimLeft, mTrimRight, SamplesToTime(), SetSequenceStartTime(), and TimeToSamples().

Here is the call graph for this function:

◆ SetSamples()

void WaveClip::SetSamples	(	size_t	ii,
		constSamplePtr	buffer,
		sampleFormat	format,
		sampleCount	start,
		size_t	len,
		sampleFormat	effectiveFormat
	)

Parameters

ii	identifies the channel

Precondition: ii < GetWidth()

Parameters

start relative to clip play start sample

Exception safety guarantee:: Strong

Parameters

effectiveFormat Make the effective format of the data at least the minumum of this value and `format`. (Maybe wider, if merging with preexistent data.) If the data are later narrowed from stored format, but not narrower than the effective, then no dithering will occur.

Definition at line 191 of file WaveClip.cpp.

{
   assert(ii < GetWidth());
   // use Strong-guarantee
   mSequences[ii]->SetSamples(buffer, format,
      start + TimeToSamples(mTrimLeft), len, effectiveFormat);
 
   // use No-fail-guarantee
   MarkChanged();
}

References anonymous_namespace{ExportPCM.cpp}::format, GetWidth(), MarkChanged(), mSequences, mTrimLeft, and TimeToSamples().

Referenced by SetFloatsFromTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSequenceStartTime()

void WaveClip::SetSequenceStartTime ( double startTime )

Definition at line 1430 of file WaveClip.cpp.

{
    mSequenceOffset = startTime;
    mEnvelope->SetOffset(startTime);
}

References mEnvelope, and mSequenceOffset.

Referenced by ApplyStretchRatio(), WaveTrack::ClearAndPasteOne(), ClearLeft(), WaveTrack::HandleXMLChild(), HandleXMLTag(), SetPlayStartTime(), and SetRate().

Here is the caller graph for this function:

◆ SetSilence()

void WaveClip::SetSilence	(	sampleCount	offset,
		sampleCount	length
	)

Silences the 'length' amount of samples starting from 'offset'(relative to the play start)

Definition at line 1325 of file WaveClip.cpp.

{
   const auto start = TimeToSamples(mTrimLeft) + offset;
   Transaction transaction{ *this };
   for (auto &pSequence : mSequences)
      pSequence->SetSilence(start, length);
   transaction.Commit();
   MarkChanged();
}

References WaveClip::Transaction::Commit(), MarkChanged(), mSequences, mTrimLeft, and TimeToSamples().

Here is the call graph for this function:

◆ SetTrimLeft()

void WaveClip::SetTrimLeft ( double trim )

Sets the play start offset in seconds from the beginning of the underlying sequence.

Definition at line 1383 of file WaveClip.cpp.

{
    mTrimLeft = std::max(.0, trim);
}

References mTrimLeft.

Referenced by ApplyStretchRatio(), Clear(), WaveTrack::ClearAndPasteOne(), ClearLeft(), HandleXMLTag(), Paste(), and TrimLeft().

Here is the caller graph for this function:

◆ SetTrimRight()

void WaveClip::SetTrimRight ( double trim )

Sets the play end offset in seconds from the ending of the underlying sequence.

Definition at line 1393 of file WaveClip.cpp.

{
    mTrimRight = std::max(.0, trim);
}

References mTrimRight.

Referenced by ApplyStretchRatio(), Clear(), WaveTrack::ClearAndPasteOne(), ClearRight(), HandleXMLTag(), InsertSilence(), Paste(), and TrimRight().

Here is the caller graph for this function:

◆ SharesBoundaryWithNextClip()

bool WaveClip::SharesBoundaryWithNextClip ( const WaveClip * next ) const

Definition at line 1289 of file WaveClip.cpp.

{
   double endThis = GetRate() * GetPlayStartTime() +
                    GetVisibleSampleCount().as_double() * GetStretchRatio();
   double startNext = next->GetRate() * next->GetPlayStartTime();
 
   // given that a double has about 15 significant digits, using a criterion
   // of half a sample should be safe in all normal usage.
   return fabs(startNext - endThis) < 0.5;
}

References sampleCount::as_double(), GetPlayStartTime(), GetRate(), GetStretchRatio(), and GetVisibleSampleCount().

Here is the call graph for this function:

◆ ShiftBy()

void WaveClip::ShiftBy ( double delta )

noexcept

Exception safety guarantee:: No-fail

Definition at line 1449 of file WaveClip.cpp.

{
    SetSequenceStartTime(GetSequenceStartTime() + delta);
}

Referenced by Clear(), ClearAndAddCutLine(), WaveTrack::ClearAndPasteOne(), ClearSequence(), and WaveTrack::CopyOne().

Here is the caller graph for this function:

◆ SnapToTrackSample()

double WaveClip::SnapToTrackSample ( double time ) const

privatenoexcept

Definition at line 1320 of file WaveClip.cpp.

{
   return std::round(t * mRate) / mRate;
}

References fast_float::round().

Referenced by GetPlayEndTime(), and GetPlayStartTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SplitsPlayRegion()

bool WaveClip::SplitsPlayRegion ( double t ) const

[ < t and t < ), such that if the track were split at t, it would split this clip in two of lengths > 0.

The play region is an open-closed interval, [...), where "[ = GetPlayStartTime()", and ") = GetPlayEndTime()."

Definition at line 1454 of file WaveClip.cpp.

{
   return GetPlayStartTime() < t && t < GetPlayEndTime();
}

References GetPlayEndTime(), and GetPlayStartTime().

Referenced by WaveTrack::ApplyStretchRatioOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StretchCutLines()

void WaveClip::StretchCutLines ( double ratioChange )

private

Definition at line 327 of file WaveClip.cpp.

{
   for (const auto& cutline : mCutLines)
   {
      cutline->mSequenceOffset *= ratioChange;
      cutline->mTrimLeft *= ratioChange;
      cutline->mTrimRight *= ratioChange;
      cutline->mClipStretchRatio *= ratioChange;
      cutline->mEnvelope->RescaleTimesBy(ratioChange);
   }
}

References mCutLines.

Referenced by OnProjectTempoChange(), StretchLeftTo(), and StretchRightTo().

Here is the caller graph for this function:

◆ StretchLeftTo()

void WaveClip::StretchLeftTo ( double to )

Stretches from left to the absolute time (if in expected range)

Definition at line 293 of file WaveClip.cpp.

{
   const auto pet = GetPlayEndTime();
   if (to >= pet)
      return;
   const auto oldPlayDuration = pet - GetPlayStartTime();
   const auto newPlayDuration = pet - to;
   const auto ratioChange = newPlayDuration / oldPlayDuration;
   mSequenceOffset = pet - (pet - mSequenceOffset) * ratioChange;
   mTrimLeft *= ratioChange;
   mTrimRight *= ratioChange;
   mClipStretchRatio *= ratioChange;
   mEnvelope->SetOffset(mSequenceOffset);
   mEnvelope->RescaleTimesBy(ratioChange);
   StretchCutLines(ratioChange);
}

References GetPlayEndTime(), GetPlayStartTime(), mClipStretchRatio, mEnvelope, mSequenceOffset, mTrimLeft, mTrimRight, and StretchCutLines().

Here is the call graph for this function:

◆ StretchRatioEquals()

bool WaveClip::StretchRatioEquals ( double value ) const

Definition at line 353 of file WaveClip.cpp.

{
   return TimeAndPitchInterface::IsPassThroughMode(
      1 + GetStretchRatio() - value);
}

References GetStretchRatio(), and TimeAndPitchInterface::IsPassThroughMode().

Referenced by HasEqualStretchRatio().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StretchRightTo()

void WaveClip::StretchRightTo ( double to )

Sets from the right to the absolute time (if in expected range)

Definition at line 310 of file WaveClip.cpp.

{
   const auto pst = GetPlayStartTime();
   if (to <= pst)
      return;
   const auto oldPlayDuration = GetPlayEndTime() - pst;
   const auto newPlayDuration = to - pst;
   const auto ratioChange = newPlayDuration / oldPlayDuration;
   mSequenceOffset = pst - mTrimLeft * ratioChange;
   mTrimLeft *= ratioChange;
   mTrimRight *= ratioChange;
   mClipStretchRatio *= ratioChange;
   mEnvelope->SetOffset(mSequenceOffset);
   mEnvelope->RescaleTimesBy(ratioChange);
   StretchCutLines(ratioChange);
}

References GetPlayEndTime(), GetPlayStartTime(), mClipStretchRatio, mEnvelope, mSequenceOffset, mTrimLeft, mTrimRight, and StretchCutLines().

Here is the call graph for this function:

◆ TimeToSamples()

sampleCount WaveClip::TimeToSamples ( double time ) const

overridevirtual

Implements ClipTimes.

Definition at line 1310 of file WaveClip.cpp.

{
   return sampleCount(floor(time * mRate / GetStretchRatio() + 0.5));
}

References GetStretchRatio(), and mRate.

Referenced by CountSamples(), GetFloatAtTime(), GetSamples(), GetSampleView(), GetSequenceStartSample(), GetVisibleSampleCount(), SetFloatsFromTime(), SetRate(), SetSamples(), SetSilence(), WaveChannelInterval::TimeToSamples(), TimeToSequenceSamples(), and WaveClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TimeToSequenceSamples()

sampleCount WaveClip::TimeToSequenceSamples ( double t ) const

private

Definition at line 1520 of file WaveClip.cpp.

{
    if (t < GetSequenceStartTime())
        return 0;
    else if (t > GetSequenceEndTime())
        return GetNumSamples();
    return TimeToSamples(t - GetSequenceStartTime());
}

References GetNumSamples(), GetSequenceEndTime(), GetSequenceStartTime(), and TimeToSamples().

Referenced by ClearAndAddCutLine(), ClearSequence(), GetMinMax(), GetRMS(), InsertSilence(), and Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TrimLeft()

void WaveClip::TrimLeft ( double deltaTime )

Moves play start position by deltaTime.

Definition at line 1403 of file WaveClip.cpp.

{
   SetTrimLeft(mTrimLeft + deltaTime);
}

References mTrimLeft, and SetTrimLeft().

Here is the call graph for this function:

◆ TrimLeftTo()

void WaveClip::TrimLeftTo ( double to )

Sets the the left trimming to the absolute time (if that is in bounds)

Definition at line 1413 of file WaveClip.cpp.

{
   mTrimLeft =
      std::clamp(to, mSequenceOffset, GetPlayEndTime()) - mSequenceOffset;
}

References GetPlayEndTime(), mSequenceOffset, and mTrimLeft.

Referenced by ApplyStretchRatio().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TrimRight()

void WaveClip::TrimRight ( double deltaTime )

Moves play end position by deltaTime.

Definition at line 1408 of file WaveClip.cpp.

{
   SetTrimRight(mTrimRight + deltaTime);
}

References mTrimRight, and SetTrimRight().

Here is the call graph for this function:

◆ TrimRightTo()

void WaveClip::TrimRightTo ( double to )

Sets the the right trimming to the absolute time (if that is in bounds)

Definition at line 1419 of file WaveClip.cpp.

{
    mTrimRight = GetSequenceEndTime() - std::clamp(to, GetPlayStartTime(), GetSequenceEndTime());
}

References GetPlayStartTime(), GetSequenceEndTime(), and mTrimRight.

Referenced by ApplyStretchRatio().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateEnvelopeTrackLen()

void WaveClip::UpdateEnvelopeTrackLen ( )

Whenever you do an operation to the sequence that will change the number of samples (that is, the length of the clip), you will want to call this function to tell the envelope about it.

Exception safety guarantee:: No-fail

Definition at line 462 of file WaveClip.cpp.

{
   auto len = (GetNumSamples().as_double()) / mRate;
   if (len != mEnvelope->GetTrackLen())
      mEnvelope->SetTrackLen(len, 1.0 / GetRate());
}

References sampleCount::as_double(), GetNumSamples(), GetRate(), mEnvelope, and mRate.

Referenced by Append(), Flush(), and HandleXMLEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WithinPlayRegion()

bool WaveClip::WithinPlayRegion ( double t ) const

t ∈ [...)

Definition at line 1459 of file WaveClip.cpp.

{
   return GetPlayStartTime() <= t && t < GetPlayEndTime();
}

References GetPlayEndTime(), and GetPlayStartTime().

Referenced by GetFloatAtTime(), and PartlyWithinPlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteXML()

void WaveClip::WriteXML ( XMLWriter & xmlFile ) const

Definition at line 640 of file WaveClip.cpp.

{
   xmlFile.StartTag(wxT("waveclip"));
   xmlFile.WriteAttr(wxT("offset"), mSequenceOffset, 8);
   xmlFile.WriteAttr(wxT("trimLeft"), mTrimLeft, 8);
   xmlFile.WriteAttr(wxT("trimRight"), mTrimRight, 8);
   xmlFile.WriteAttr(wxT("rawAudioTempo"), mRawAudioTempo.value_or(0.), 8);
   xmlFile.WriteAttr(wxT("clipStretchRatio"), mClipStretchRatio, 8);
   xmlFile.WriteAttr(wxT("name"), mName);
   xmlFile.WriteAttr(wxT("colorindex"), mColourIndex );
 
   for (auto &pSequence : mSequences)
      pSequence->WriteXML(xmlFile);
   mEnvelope->WriteXML(xmlFile);
 
   for (const auto &clip: mCutLines)
      clip->WriteXML(xmlFile);
 
   xmlFile.EndTag(wxT("waveclip"));
}

References wxT().

Here is the call graph for this function:

Member Data Documentation

◆ mClipStretchRatio

double WaveClip::mClipStretchRatio = 1.

private

Definition at line 615 of file WaveClip.h.

Referenced by ApplyStretchRatio(), GetStretchRatio(), HandleXMLTag(), StretchLeftTo(), and StretchRightTo().

◆ mColourIndex

int WaveClip::mColourIndex

private

Definition at line 621 of file WaveClip.h.

Referenced by WaveClip().

◆ mCutLines

WaveClipHolders WaveClip::mCutLines {}

private

Cut Lines are nothing more than ordinary wave clips, with the offset relative to the start of the clip.

Invariant: all are non-null

Definition at line 639 of file WaveClip.h.

Referenced by CheckInvariants(), ClearAndAddCutLine(), ClearSequence(), CloseLock(), ExpandCutLine(), FindCutLine(), HandleXMLChild(), OffsetCutLines(), Paste(), RemoveCutLine(), StretchCutLines(), and WaveClip().

◆ mEnvelope

std::unique_ptr<Envelope> WaveClip::mEnvelope

private

Envelope is unique, not per-sequence.

Definition at line 632 of file WaveClip.h.

Referenced by HandleXMLChild(), OnProjectTempoChange(), Paste(), SetRate(), SetSequenceStartTime(), StretchLeftTo(), StretchRightTo(), UpdateEnvelopeTrackLen(), and WaveClip().

◆ mIsPlaceholder

bool WaveClip::mIsPlaceholder { false }

private

Definition at line 642 of file WaveClip.h.

Referenced by WaveClip().

◆ mName

wxString WaveClip::mName

private

Definition at line 645 of file WaveClip.h.

Referenced by GetName(), SetName(), and WaveClip().

◆ mProjectTempo

std::optional<double> WaveClip::mProjectTempo

private

Definition at line 617 of file WaveClip.h.

Referenced by ApplyStretchRatio(), GetStretchRatio(), and OnProjectTempoChange().

◆ mRate

int WaveClip::mRate

private

Sample rate of the raw audio, i.e., before stretching.

Definition at line 620 of file WaveClip.h.

Referenced by GetPlayEndSample(), GetPlayEndTime(), GetPlayStartSample(), GetSequenceEndTime(), HandleXMLChild(), InsertSilence(), Paste(), Resample(), SetRate(), TimeToSamples(), UpdateEnvelopeTrackLen(), and WaveClip().

◆ mRawAudioTempo

std::optional<double> WaveClip::mRawAudioTempo

private

Definition at line 616 of file WaveClip.h.

Referenced by ApplyStretchRatio(), GetStretchRatio(), HandleXMLTag(), and OnProjectTempoChange().

◆ mSequenceOffset

double WaveClip::mSequenceOffset { 0 }

private

Real-time durations, i.e., stretching the clip modifies these.

Definition at line 608 of file WaveClip.h.

Referenced by GetPlayEndTime(), GetPlayStartTime(), GetSequenceStartSample(), GetSequenceStartTime(), OnProjectTempoChange(), SetSequenceStartTime(), StretchLeftTo(), StretchRightTo(), TrimLeftTo(), and WaveClip().

◆ mSequences

std::vector<std::unique_ptr<Sequence> > WaveClip::mSequences

private

Invariant: mSequences.size() > 0; all are non-null; all sequences have the same lengths, append buffer lengths, sample formats, and sample block factory; all cutlines have the same width

Definition at line 630 of file WaveClip.h.

Referenced by Append(), AppendNewBlock(), AppendSharedBlock(), ApplyStretchRatio(), CheckInvariants(), ClearAndAddCutLine(), ClearSequence(), CloseLock(), ConvertToSampleFormat(), Flush(), GetAppendBuffer(), GetAppendBufferLen(), GetEmptySequenceCopies(), GetFactory(), GetMinMax(), GetNumSamples(), GetRMS(), GetSampleFormats(), GetSamples(), GetSampleView(), GetSequenceBlockArray(), GetWidth(), HandleXMLChild(), HandleXMLEndTag(), InsertSilence(), Paste(), Resample(), SetSamples(), SetSilence(), WaveClip::Transaction::Transaction(), and WaveClip().

◆ mTrimLeft

double WaveClip::mTrimLeft { 0 }

private

Definition at line 609 of file WaveClip.h.

Referenced by GetPlayStartTime(), GetSamples(), GetSampleView(), GetTrimLeft(), GetVisibleSampleCount(), OnProjectTempoChange(), SetPlayStartTime(), SetRate(), SetSamples(), SetSilence(), SetTrimLeft(), StretchLeftTo(), StretchRightTo(), TrimLeft(), TrimLeftTo(), WaveClip(), and WaveClip::Transaction::~Transaction().

◆ mTrimRight

double WaveClip::mTrimRight { 0 }

private

Definition at line 610 of file WaveClip.h.

Referenced by GetPlayEndTime(), GetTrimRight(), GetVisibleSampleCount(), OnProjectTempoChange(), SetRate(), SetTrimRight(), StretchLeftTo(), StretchRightTo(), TrimRight(), TrimRightTo(), WaveClip(), and WaveClip::Transaction::~Transaction().

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

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Caches

Constructor & Destructor Documentation

◆ WaveClip() [1/4]

◆ WaveClip() [2/4]

◆ WaveClip() [3/4]

◆ WaveClip() [4/4]

◆ ~WaveClip()

Member Function Documentation

◆ AfterPlayRegion()

◆ Append()

◆ AppendNewBlock()

◆ AppendSharedBlock()

◆ AppendSilence()

◆ ApplyStretchRatio()

◆ AtOrBeforePlayRegion()

◆ BeforePlayRegion()

◆ CheckInvariants()

◆ Clear()

◆ ClearAndAddCutLine()

◆ ClearLeft()

◆ ClearRight()

◆ ClearSequence()

◆ CloseLock()

◆ ConvertToSampleFormat()

◆ CountSamples()

◆ CoversEntirePlayRegion()

◆ EntirelyWithinPlayRegion()

◆ ExpandCutLine()

◆ FindCutLine()

◆ Flush()

◆ GetAppendBuffer()

◆ GetAppendBufferLen()

◆ GetColourIndex()

◆ GetCutLines() [1/2]

◆ GetCutLines() [2/2]

◆ GetEmptySequenceCopies()

◆ GetEnvelope() [1/2]

◆ GetEnvelope() [2/2]

◆ GetFactory()

◆ GetFloatAtTime()

◆ GetIsPlaceholder()

◆ GetMinMax()

◆ GetName()

◆ GetNumSamples()

◆ GetPlayDuration()

◆ GetPlayEndSample()

◆ GetPlayEndTime()

◆ GetPlayStartSample()

◆ GetPlayStartTime()

◆ GetRate()

◆ GetRMS()

◆ GetSampleFormats()

◆ GetSamples() [1/2]

◆ GetSamples() [2/2]

◆ GetSampleView() [1/2]

◆ GetSampleView() [2/2]

◆ GetSequence() [1/2]

◆ GetSequence() [2/2]

◆ GetSequenceBlockArray() [1/2]

◆ GetSequenceBlockArray() [2/2]

◆ GetSequenceEndTime()

◆ GetSequenceSamplesCount()

◆ GetSequenceStartSample()

◆ GetSequenceStartTime()

◆ GetStretchRatio()

◆ GetTrimLeft()

◆ GetTrimRight()

◆ GetVisibleSampleCount()

◆ GetWidth()

◆ HandleXMLChild()

◆ HandleXMLEndTag()

◆ HandleXMLTag()