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

#include <WaveClip.h>

Inheritance diagram for WaveClip:

Collaboration diagram for WaveClip:

Classes
class	ClearSequenceFinisher
	Fix consistency of cutlines and envelope after deleting from Sequences. More...

struct	CreateToken

struct	StrongInvariantScope

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

Public Types
using	Attachments = Site< WaveClip, WaveClipListener, ClientData::DeepCopying >

using	Channel = WaveClipChannel

Public Types inherited from ClientData::Site< WaveClip, WaveClipListener, ClientData::DeepCopying >
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 Types inherited from Observer::Publisher< CentShiftChange >
using	message_type = CentShiftChange

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const CentShiftChange &) >
	Type of functions that can be connected to the Publisher. More...

Public Types inherited from Observer::Publisher< PitchAndSpeedPresetChange >
using	message_type = PitchAndSpeedPresetChange

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const PitchAndSpeedPresetChange &) >
	Type of functions that can be connected to the Publisher. More...

Public Types inherited from Observer::Publisher< StretchRatioChange >
using	message_type = StretchRatioChange

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const StretchRatioChange &) >
	Type of functions that can be connected to the Publisher. More...

Public Types inherited from Observer::Publisher< WaveClipDtorCalled >
using	message_type = WaveClipDtorCalled

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const WaveClipDtorCalled &) >
	Type of functions that can be connected to the Publisher. More...

Public Member Functions
	WaveClip (size_t width, const SampleBlockFactoryPtr &factory, sampleFormat format, int rate)
	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 ()

double	Start () const override

double	End () const override

std::shared_ptr< ChannelInterval >	DoGetChannel (size_t iChannel) override
	Retrieve a channel. More...

auto	Channels ()

auto	Channels () const

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

bool	StrongInvariant () const

void	AssertOrRepairStrongInvariant ()

size_t	NChannels () const override
	How many Sequences the clip contains. More...

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

int	GetRate () const override

void	SetRate (int rate)

void	SetRawAudioTempo (double tempo)

PitchAndSpeedPreset	GetPitchAndSpeedPreset () const

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

void	StretchBy (double ratio)

double	GetStretchRatio () const override

bool	SetCentShift (int cents)

int	GetCentShift () const override

Observer::Subscription	SubscribeToCentShiftChange (std::function< void(int)> cb) const override

void	SetPitchAndSpeedPreset (PitchAndSpeedPreset preset)

virtual Observer::Subscription	SubscribeToPitchAndSpeedPresetChange (std::function< void(PitchAndSpeedPreset)> cb) const override

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

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

bool	IsEmpty () 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	TrimQuarternotesFromRight (double quarters)
	Same as `TrimRight`, but expressed as quarter notes. 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)

Envelope &	GetEnvelope () noexcept

const Envelope &	GetEnvelope () const noexcept

void	SetEnvelope (std::unique_ptr< Envelope > p)

const BlockArray *	GetSequenceBlockArray (size_t ii) const

Sequence *	GetSequence (size_t ii)

const Sequence *	GetSequence (size_t ii) const

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 >	AppendToChannel (size_t iChannel, constSamplePtr buffer, sampleFormat format, size_t len)

std::shared_ptr< SampleBlock >	AppendLegacyNewBlock (constSamplePtr buffer, sampleFormat format, size_t len)

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

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

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	RepairChannels ()
	Ensure that all sequences have the same sample count. More...

void	Clear (double t0, double t1)

void	ClearLeft (double t)

void	ClearRight (double t)

void	ClearAndAddCutLine (double t0, double t1)

void	AddCutLine (WaveClipHolder pClip)

bool	Paste (double t0, const WaveClip &other)

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

void	AppendSilence (double len, double envelopeValue)

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

const WaveClipConstHolders &	GetCutLines () const

size_t	NumCutLines () const

bool	FindCutLine (double cutLinePosition, double cutLineStart=nullptr, double cutLineEnd=nullptr) 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 (size_t ii, XMLWriter &xmlFile) const

bool	GetIsPlaceholder () const

void	SetIsPlaceholder (bool val)

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 (size_t ii) const

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

SampleFormats	GetSampleFormats () const

size_t	CountBlocks () const

void	DiscardRightChannel ()
	Reduce width. More...

void	SwapChannels ()

std::shared_ptr< WaveClip >	SplitChannels ()

void	MakeStereo (WaveClip &&other, bool mustAlign)

size_t	GetBestBlockSize (sampleCount t) const
	A hint for sizing of well aligned fetches. More...

size_t	GetMaxBlockSize () const

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


bool	HasEqualPitchAndSpeed (const WaveClip &other) const

bool	HasPitchOrSpeed () const

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	NChannels () const =0

virtual int	GetCentShift () const =0

virtual Observer::Subscription	SubscribeToCentShiftChange (std::function< void(int)> cb) const =0

virtual PitchAndSpeedPreset	GetPitchAndSpeedPreset () const =0

virtual Observer::Subscription	SubscribeToPitchAndSpeedPresetChange (std::function< void(PitchAndSpeedPreset)> cb) 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 WideChannelGroupInterval
	~WideChannelGroupInterval () override

virtual size_t	NChannels () const =0
	Report the number of channels. More...

template<typename IntervalType = ChannelInterval>
std::shared_ptr< IntervalType >	GetChannel (size_t iChannel)
	Retrieve a channel, cast to the given type. More...

template<typename IntervalType = const ChannelInterval>
auto	GetChannel (size_t iChannel) const -> std::enable_if_t< std::is_const_v< IntervalType >, std::shared_ptr< IntervalType > >

template<typename IntervalType = ChannelInterval>
IteratorRange< ChannelIterator< IntervalType > >	Channels ()
	Get range of ChannelInterval objects with mutative access. More...

template<typename IntervalType = const ChannelInterval>
auto	Channels () const -> std::enable_if_t< std::is_const_v< IntervalType >, IteratorRange< ChannelIterator< IntervalType > > >
	Get range of channels with read-only access. More...

Public Member Functions inherited from ChannelGroupInterval
	ChannelGroupInterval ()=default

virtual	~ChannelGroupInterval ()

virtual double	Start () const =0

virtual double	End () 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, ClientData::DeepCopying >
	~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...

Public Member Functions inherited from Observer::Publisher< CentShiftChange >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...

	Publisher (Publisher &&)=default

Publisher &	operator= (Publisher &&)=default

Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...

Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Public Member Functions inherited from Observer::Publisher< PitchAndSpeedPresetChange >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...

	Publisher (Publisher &&)=default

Publisher &	operator= (Publisher &&)=default

Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...

Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Public Member Functions inherited from Observer::Publisher< StretchRatioChange >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...

	Publisher (Publisher &&)=default

Publisher &	operator= (Publisher &&)=default

Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...

Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Public Member Functions inherited from Observer::Publisher< WaveClipDtorCalled >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...

	Publisher (Publisher &&)=default

Publisher &	operator= (Publisher &&)=default

Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...

Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Static Public Attributes
static const char *	WaveClip_tag = "waveclip"

Static Public Attributes inherited from Observer::Publisher< CentShiftChange >
static constexpr bool	notifies_all

Static Public Attributes inherited from Observer::Publisher< PitchAndSpeedPresetChange >
static constexpr bool	notifies_all

Static Public Attributes inherited from Observer::Publisher< StretchRatioChange >
static constexpr bool	notifies_all

Static Public Attributes inherited from Observer::Publisher< WaveClipDtorCalled >
static constexpr bool	notifies_all

Private Member Functions
	WaveClip (const WaveClip &)=delete

WaveClip &	operator= (const WaveClip &)=delete

size_t	GreatestAppendBufferLen () const

void	MarkChanged () noexcept
	Called by mutating operations; notifies listeners. More...

sampleCount	TimeToSequenceSamples (double t) const

bool	StretchRatioEquals (double value) const

sampleCount	GetNumSamples () const

const SampleBlockFactoryPtr &	GetFactory () const

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

void	StretchCutLines (double ratioChange)

double	SnapToTrackSample (double time) const noexcept

ClearSequenceFinisher	ClearSequence (double t0, double t1)

Static Private Member Functions
static void	TransferSequence (WaveClip &origClip, WaveClip &newClip)

static void	FixSplitCutlines (WaveClipHolders &myCutlines, WaveClipHolders &newCutlines)

Private Attributes
PitchAndSpeedPreset	mPitchAndSpeedPreset { PitchAndSpeedPreset::Default }

int	mCentShift { 0 }

double	mClipStretchRatio = 1.

std::optional< double >	mRawAudioTempo

std::optional< double >	mProjectTempo

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

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

std::unique_ptr< Envelope >	mEnvelope
	Envelope is unique, not per-sequence, and always non-null. 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, ClientData::DeepCopying >
static size_t	numFactories ()
	How many static factories have been registered with this specialization of Site. More...

virtual std::shared_ptr< ChannelInterval >	DoGetChannel (size_t iChannel)=0
	Retrieve a channel. More...

Protected Member Functions inherited from ClientData::Site< WaveClip, WaveClipListener, ClientData::DeepCopying >
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...

void	ForCorresponding (Site &other, const Function &function, bool create=true)

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	EraseIf (const Function &function)
	Erase attached objects satisfying a predicate. More...

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

Protected Member Functions inherited from Observer::Publisher< CentShiftChange >
CallbackReturn	Publish (const CentShiftChange &message)
	Send a message to connected callbacks. More...

Protected Member Functions inherited from Observer::Publisher< PitchAndSpeedPresetChange >
CallbackReturn	Publish (const PitchAndSpeedPresetChange &message)
	Send a message to connected callbacks. More...

Protected Member Functions inherited from Observer::Publisher< StretchRatioChange >
CallbackReturn	Publish (const StretchRatioChange &message)
	Send a message to connected callbacks. More...

Protected Member Functions inherited from Observer::Publisher< WaveClipDtorCalled >
CallbackReturn	Publish (const WaveClipDtorCalled &message)
	Send a message to connected callbacks. More...

Detailed Description

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

Definition at line 228 of file WaveClip.h.

Member Typedef Documentation

◆ Attachments

using WaveClip::Attachments = Site<WaveClip, WaveClipListener, ClientData::DeepCopying>

Definition at line 251 of file WaveClip.h.

◆ Channel

using WaveClip::Channel = WaveClipChannel

Definition at line 293 of file WaveClip.h.

Constructor & Destructor Documentation

◆ WaveClip() [1/5]

WaveClip::WaveClip ( const WaveClip & )

privatedelete

◆ WaveClip() [2/5]

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

typical constructor

Parameters

width how many sequences

Precondition: width > 0

Postcondition: NChannels() == width

Definition at line 223 of file WaveClip.cpp.

{
   assert(width > 0);
   mRate = rate;
   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(), factory, anonymous_namespace{ExportPCM.cpp}::format, mEnvelope, mRate, mSequences, and narrowestSampleFormat.

Here is the call graph for this function:

◆ WaveClip() [3/5]

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

inline

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: NChannels() == orig.NChannels(); !copyCutlines || NumCutLines() == orig.NumCutLines()

Definition at line 270 of file WaveClip.h.

273 : WaveClip{ orig, factory, copyCutlines, {} }

274 {}

WaveClip

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

Definition: WaveClip.h:238

◆ WaveClip() [4/5]

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: NChannels() == orig.NChannels()

Definition at line 281 of file WaveClip.cpp.

   : mCentShift { orig.mCentShift }
   , 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;
 
   // Deep copy of attachments
   Attachments &attachments = *this;
   attachments = orig;
 
   mIsPlaceholder = orig.GetIsPlaceholder();
 
   mSequences.reserve(orig.NChannels());
   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(NChannels() == orig.NChannels());
   assert(CheckInvariants());
}

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

Here is the call graph for this function:

◆ ~WaveClip()

WaveClip::~WaveClip ( )

virtual

Definition at line 335 of file WaveClip.cpp.

{
   Observer::Publisher<WaveClipDtorCalled>::Publish(WaveClipDtorCalled {});
}

References Observer::Publisher< Message, NotifyAll >::Publish().

Here is the call graph for this function:

◆ WaveClip() [5/5]

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

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

This is effectively private because CreateToken is private, but must be public to cooperate with make_shared.

The clip so constructed does NOT (yet) satisfy the class invariants!

Parameters

emptyCopy if true, don't make sequences

Postcondition: NChannels() == (token.emptyCopy ? 0 : orig.NChannels()); !copyCutlines || NumCutLines() == orig.NumCutLines()

Definition at line 238 of file WaveClip.cpp.

   : mCentShift { orig.mCentShift }
   , mPitchAndSpeedPreset { orig.mPitchAndSpeedPreset }
   , 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;
 
   // Deep copy of attachments
   Attachments &attachments = *this;
   attachments = orig;
 
   mSequences.reserve(orig.NChannels());
   if (!token.emptyCopy)
      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, token));
 
   mIsPlaceholder = orig.GetIsPlaceholder();
 
   assert(NChannels() == (token.emptyCopy ? 0 : orig.NChannels()));
   assert(token.emptyCopy || CheckInvariants());
   assert(!copyCutlines || NumCutLines() == orig.NumCutLines());
}

References CheckInvariants(), WaveClip::CreateToken::emptyCopy, factory, GetIsPlaceholder(), mCutLines, mEnvelope, mIsPlaceholder, mName, mRate, mSequenceOffset, mSequences, mTrimLeft, mTrimRight, NChannels(), and NumCutLines().

Here is the call graph for this function:

Member Function Documentation

◆ AddCutLine()

void WaveClip::AddCutLine ( WaveClipHolder pClip )

Precondition: NChannels() == pClip->NChannels()

Definition at line 1470 of file WaveClip.cpp.

{
   assert(NChannels() == pClip->NChannels());
   mCutLines.push_back(move(pClip));
   // New clip is assumed to have correct width
   assert(CheckInvariants());
}

References CheckInvariants(), mCutLines, and NChannels().

Referenced by ClearAndAddCutLine().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AfterPlayRegion()

bool WaveClip::AfterPlayRegion ( double t ) const

) <= t

Definition at line 1952 of file WaveClip.cpp.

{
   return GetPlayEndTime() <= t;
}

References GetPlayEndTime().

Here is the call graph for this function:

◆ Append() [1/2]

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 NChannels() In case of failure or exceptions, the clip contents are unchanged but un-flushed data are lost

Precondition: StrongInvariant()

Postcondition: StrongInvariant()

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 869 of file WaveClip.cpp.

{
   StrongInvariantScope scope{ *this };
 
   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 WaveClip::Transaction::Commit(), anonymous_namespace{ExportPCM.cpp}::format, MarkChanged(), mSequences, anonymous_namespace{wxCommandTargets.cpp}::scope, and UpdateEnvelopeTrackLen().

Here is the call graph for this function:

◆ Append() [2/2]

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

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

For stereo clips, typically this is invoked on left, then right channels, either alternating (as when recording) or in two batches (channel-major pattern of effect processing), which violates the strong invariant condition, then restores it (either repeatedly, or once).

Returns: true if at least one complete block was created In case of failure or exceptions, the clip contents are unchanged but un-flushed data are lost

Precondition: iChannel < NChannels(); iChannel + nChannels <= NChannels()

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 844 of file WaveClip.cpp.

{
   assert(iChannel < NChannels());
   assert(iChannel + nChannels <= NChannels());
 
   // No requirement or promise of the strong invariant, and therefore no
   // need for Transaction
 
   //wxLogDebug(wxT("Append: len=%lli"), (long long) len);
 
   bool appended = false;
   for (size_t ii = 0; ii < nChannels; ++ii)
      appended = mSequences[iChannel + ii]->Append(
         buffers[ii], format, len, stride, effectiveFormat)
            || appended;
 
   // use No-fail-guarantee
   UpdateEnvelopeTrackLen();
   MarkChanged();
 
   return appended;
}

References Append(), anonymous_namespace{ExportPCM.cpp}::format, anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, MarkChanged(), mSequences, NChannels(), and UpdateEnvelopeTrackLen().

Referenced by Append().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AppendLegacyNewBlock()

std::shared_ptr< SampleBlock > WaveClip::AppendLegacyNewBlock	(	constSamplePtr	buffer,
		sampleFormat	format,
		size_t	len
	)

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

Precondition: NChannels() == 1

Exception safety guarantee:: Strong

Definition at line 826 of file WaveClip.cpp.

{
   // This is a special use function for legacy files only and this assertion
   // does not need to be relaxed.  The clip is in a still unzipped track.
   assert(NChannels() == 1);
   return AppendToChannel(0, buffer, format, len);
}

References AppendToChannel(), anonymous_namespace{ExportPCM.cpp}::format, and NChannels().

Here is the call graph for this function:

◆ AppendLegacySharedBlock()

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

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

Precondition: NChannels() == 1

Exception safety guarantee:: Strong

Definition at line 835 of file WaveClip.cpp.

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

References mSequences, and NChannels().

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 1276 of file WaveClip.cpp.

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

References GetPlayEndTime(), and InsertSilence().

Here is the call graph for this function:

◆ AppendToChannel()

std::shared_ptr< SampleBlock > WaveClip::AppendToChannel	(	size_t	iChannel,
		constSamplePtr	buffer,
		sampleFormat	format,
		size_t	len
	)

Precondition: iChannel < NChannels()

Exception safety guarantee:: Strong

Definition at line 817 of file WaveClip.cpp.

{
   assert(iChannel < NChannels());
   return mSequences[iChannel]->AppendNewBlock(buffer, format, len);
}

References anonymous_namespace{ExportPCM.cpp}::format, anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, mSequences, and NChannels().

Referenced by AppendLegacyNewBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AssertOrRepairStrongInvariant()

void WaveClip::AssertOrRepairStrongInvariant ( )

When StrongInvariant() is false, violate an assertion in debug, but in release, establish it (or fail, propagating an exception)

Exception safety guarantee:: Strong

Definition at line 2030 of file WaveClip.cpp.

{
   if (!StrongInvariant()) {
      assert(false);
      RepairChannels();
      assert(StrongInvariant());
   }
}

References RepairChannels(), and StrongInvariant().

Referenced by WaveClip::StrongInvariantScope::StrongInvariantScope().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AtOrBeforePlayRegion()

bool WaveClip::AtOrBeforePlayRegion ( double t ) const

t <= [

Definition at line 1947 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 1942 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:

◆ Channels() [1/2]

auto WaveClip::Channels ( )

inline

Definition at line 295 of file WaveClip.h.

295 { return

296 WideChannelGroupInterval::Channels<Channel>(); }

◆ Channels() [2/2]

auto WaveClip::Channels ( ) const

inline

Definition at line 298 of file WaveClip.h.

298 { return

299 WideChannelGroupInterval::Channels<const Channel>(); }

◆ CheckInvariants()

bool WaveClip::CheckInvariants ( ) const

Check weak invariant conditions on mSequences and mCutlines.

Conditions are mSequences.size() > 0 all sequences are non-null all sequences have the same sample formats and sample block factory all cutlines satisfy the strong invariant

Definition at line 1979 of file WaveClip.cpp.

{
   const auto width = NChannels();
   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 sample formats, and sample block
         // factory
         return
         std::all_of(iter, end, [&](decltype(pFirst) pSequence) {
            return pSequence &&
               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) {
            if (!(pCutLine && pCutLine->NChannels() == width))
                return false;
            if (!pCutLine->StrongInvariant()) {
               pCutLine->AssertOrRepairStrongInvariant();
               return false;
            }
            return true;
         });
      }
   }
   return false;
}

References details::end(), mCutLines, mSequences, and NChannels().

Referenced by AddCutLine(), DiscardRightChannel(), HandleXMLEndTag(), MakeStereo(), StrongInvariant(), SwapChannels(), TransferSequence(), 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 1283 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);
   }
   Transaction transaction{ *this };
   ClearSequence(st0, st1)
      .Commit();
   transaction.Commit();
   MarkChanged();
 
   if (offset != .0)
      ShiftBy(offset);
}

References ClearSequence(), WaveClip::ClearSequenceFinisher::Commit(), GetPlayEndTime(), GetPlayStartTime(), GetSequenceEndTime(), GetSequenceStartTime(), GetTrimLeft(), MarkChanged(), 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.

Precondition: StrongInvariant()

Postcondition: StrongInvariant()

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

Definition at line 1406 of file WaveClip.cpp.

{
   StrongInvariantScope scope{ *this };
   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())
         .Commit();
      newClip->SetTrimRight(.0);
   }
   if(t0 > GetPlayStartTime())
   {
      newClip->ClearSequence(newClip->GetSequenceStartTime(), t0)
         .Commit();
      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();
   AddCutLine(move(newClip));
}

References AddCutLine(), Envelope::CollapseRegion(), CountSamples(), GetEnvelope(), GetFactory(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSequenceStartTime(), MarkChanged(), mCutLines, min(), mSequences, anonymous_namespace{wxCommandTargets.cpp}::scope, 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 1310 of file WaveClip.cpp.

{
   if (t > GetPlayStartTime() && t < GetPlayEndTime())
   {
      Transaction transaction{ *this };
      ClearSequence(GetSequenceStartTime(), t)
         .Commit();
      transaction.Commit();
      SetTrimLeft(.0);
      SetSequenceStartTime(t);
      MarkChanged();
   }
}

References ClearSequence(), WaveClip::ClearSequenceFinisher::Commit(), GetPlayEndTime(), GetPlayStartTime(), GetSequenceStartTime(), MarkChanged(), 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 1324 of file WaveClip.cpp.

{
   if (t > GetPlayStartTime() && t < GetPlayEndTime())
   {
      Transaction transaction{ *this };
      ClearSequence(t, GetSequenceEndTime())
         .Commit();
      transaction.Commit();
      SetTrimRight(.0);
      MarkChanged();
   }
}

References ClearSequence(), WaveClip::ClearSequenceFinisher::Commit(), GetPlayEndTime(), GetPlayStartTime(), GetSequenceEndTime(), MarkChanged(), and SetTrimRight().

Here is the call graph for this function:

◆ ClearSequence()

auto 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)

Precondition: StrongInvariant()

Postcondition: StrongInvariant()

Definition at line 1337 of file WaveClip.cpp.

{
   StrongInvariantScope scope{ *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)
      return {};
 
   // use Strong-guarantee
   for (auto &pSequence : mSequences)
      pSequence->Delete(s0, s1 - s0);
 
   return { this, t0, t1, clip_t0, clip_t1 };
}

References min(), and anonymous_namespace{wxCommandTargets.cpp}::scope.

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 1559 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 782 of file WaveClip.cpp.

{
   // This mutator does not require the strong invariant.  It leaves sample
   // counts unchanged in each sequence.
 
   // 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 = NChannels(); 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, MarkChanged(), mSequences, and NChannels().

Here is the call graph for this function:

◆ CountBlocks()

size_t WaveClip::CountBlocks ( ) const

Definition at line 693 of file WaveClip.cpp.

{
   return std::accumulate(mSequences.begin(), mSequences.end(), size_t{},
   [](size_t acc, auto &pSequence){
      return acc + pSequence->GetBlockArray().size(); });
}

References mSequences.

◆ CountSamples()

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

Counts number of sample times 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 1957 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 1936 of file WaveClip.cpp.

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

References GetPlayEndTime(), and GetPlayStartTime().

Here is the call graph for this function:

◆ DiscardRightChannel()

void WaveClip::DiscardRightChannel ( )

Reduce width.

Postcondition: NChannels() == 1

Definition at line 429 of file WaveClip.cpp.

{
   mSequences.resize(1);
   this->Attachments::ForEach([](WaveClipListener &attachment){
      attachment.Erase(1);
   });
   for (auto &pCutline : mCutLines)
      pCutline->DiscardRightChannel();
   assert(NChannels() == 1);
   assert(CheckInvariants());
}

References CheckInvariants(), WaveClipListener::Erase(), mCutLines, mSequences, and NChannels().

Referenced by SplitChannels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetChannel()

std::shared_ptr< ChannelInterval > WaveClip::DoGetChannel ( size_t iChannel )

overridevirtual

Retrieve a channel.

Postcondition: result: !(iChannel < NChannels()) || result

Implements WideChannelGroupInterval.

Definition at line 350 of file WaveClip.cpp.

{
   return std::make_shared<Channel>(*this, iChannel);
}

References anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel.

◆ End()

double WaveClip::End ( ) const

overridevirtual

Postcondition: result: Start() < result

Implements ChannelGroupInterval.

Definition at line 345 of file WaveClip.cpp.

{
   return GetPlayEndTime();
}

References GetPlayEndTime().

Referenced by anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::GetRightAdjustLimit(), and TimeStretching::SetClipStretchRatio().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EntirelyWithinPlayRegion()

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

t0 and t1 both ∈ [...)

Precondition: t0 <= t1

Definition at line 1914 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 1499 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 details::end(), GetSequenceStartTime(), mCutLines, and Paste().

Here is the call graph for this function:

◆ FindCutLine()

bool WaveClip::FindCutLine	(	double	cutLinePosition,
		double *	cutLineStart = `nullptr`,
		double *	cutLineEnd = `nullptr`
	)		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 1478 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:

◆ FixSplitCutlines()

void WaveClip::FixSplitCutlines	(	WaveClipHolders &	myCutlines,
		WaveClipHolders &	newCutlines
	)

staticprivate

Definition at line 462 of file WaveClip.cpp.

{
   auto beginMe = myCutlines.begin(),
      endMe = myCutlines.end();
   auto iterNew = newCutlines.begin(),
      endNew = newCutlines.end();
   for_each(beginMe, endMe, [&](const auto &myCutline){
      assert(iterNew != endNew);
      const auto pNew = *iterNew;
      TransferSequence(*myCutline, *pNew);
      // Recursion!
      FixSplitCutlines(myCutline->mCutLines, pNew->mCutLines);
      ++iterNew;
   });
   assert(iterNew == endNew);
}

References FixSplitCutlines(), and TransferSequence().

Referenced by FixSplitCutlines(), and SplitChannels().

Here is the call graph for this function:

Here is the caller 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 893 of file WaveClip.cpp.

{
   // Does not require or guarantee the strong invariant
 
   //wxLogDebug(wxT("WaveClip::Flush"));
   //wxLogDebug(wxT("   mAppendBufferLen=%lli"), (long long) mAppendBufferLen);
   //wxLogDebug(wxT("   previous sample count %lli"), (long long) mSequence->GetNumSamples());
 
   if (GreatestAppendBufferLen() > 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(), GreatestAppendBufferLen(), MarkChanged(), mSequences, and UpdateEnvelopeTrackLen().

Referenced by 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 < NChannels()

Definition at line 729 of file WaveClip.cpp.

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

References mSequences, and NChannels().

Referenced by WaveClipChannel::GetAppendBuffer(), and anonymous_namespace{WaveDataCache.cpp}::AppendBufferHelper::GetAppendBufferPointer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAppendBufferLen()

size_t WaveClip::GetAppendBufferLen ( size_t ii ) const

Parameters

ii	identifies the channel

Precondition: ii < NChannels()

Definition at line 423 of file WaveClip.cpp.

{
   assert(iChannel < NChannels());
   return mSequences[iChannel]->GetAppendBufferLen();
}

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

Referenced by WaveClipChannel::GetAppendBufferLen(), anonymous_namespace{WaveDataCache.cpp}::AppendBufferHelper::GetAppendBufferPointer(), GreatestAppendBufferLen(), and anonymous_namespace{WaveDataCache.cpp}::MakeDefaultDataProvider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBestBlockSize()

size_t WaveClip::GetBestBlockSize ( sampleCount t ) const

A hint for sizing of well aligned fetches.

Definition at line 701 of file WaveClip.cpp.

{
   return mSequences[0]->GetBestBlockSize(t);
}

References mSequences.

◆ GetCentShift()

int WaveClip::GetCentShift ( ) const

overridevirtual

Implements ClipInterface.

Definition at line 634 of file WaveClip.cpp.

{
   return mCentShift;
}

References mCentShift.

Referenced by anonymous_namespace{PitchAndSpeedDialog.cpp}::GetClipShift(), HasEqualPitchAndSpeed(), and HasPitchOrSpeed().

Here is the caller graph for this function:

◆ GetCutLines() [1/2]

const WaveClipHolders & WaveClip::GetCutLines ( )

inline

Get access to cut lines list.

Definition at line 728 of file WaveClip.h.

728{ return mCutLines; }

◆ GetCutLines() [2/2]

const WaveClipConstHolders & WaveClip::GetCutLines ( ) const

inline

Definition at line 729 of file WaveClip.h.

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

WaveClipConstHolders

std::vector< WaveClipConstHolder > WaveClipConstHolders

Definition: WaveClip.h:46

◆ GetEmptySequenceCopies()

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

private

Definition at line 719 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 Resample().

Here is the caller graph for this function:

◆ GetEnvelope() [1/2]

const Envelope & WaveClip::GetEnvelope ( ) const

inlinenoexcept

Definition at line 554 of file WaveClip.h.

554{ return *mEnvelope; }

◆ GetEnvelope() [2/2]

Envelope & WaveClip::GetEnvelope ( )

inlinenoexcept

Definition at line 553 of file WaveClip.h.

553{ return *mEnvelope; }

Referenced by ClearAndAddCutLine(), WaveClipChannel::GetEnvelope(), AUPImportFileHandle::HandleEnvelope(), InsertSilence(), and WaveClip::ClearSequenceFinisher::~ClearSequenceFinisher().

Here is the caller graph for this function:

◆ GetFactory()

const SampleBlockFactoryPtr & WaveClip::GetFactory ( ) const

private

Definition at line 713 of file WaveClip.cpp.

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

References mSequences.

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

Here is the caller graph for this function:

◆ GetIsPlaceholder()

bool WaveClip::GetIsPlaceholder ( ) const

inline

Definition at line 772 of file WaveClip.h.

772{ return mIsPlaceholder; }

Referenced by WaveClip().

Here is the caller graph for this function:

◆ GetMaxBlockSize()

size_t WaveClip::GetMaxBlockSize ( ) const

Definition at line 706 of file WaveClip.cpp.

{
   return std::accumulate(mSequences.begin(), mSequences.end(), size_t{},
   [](size_t acc, auto &pSequence){
      return std::max(acc, pSequence->GetMaxBlockSize()); });
}

References mSequences.

◆ 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 < NChannels()

Definition at line 740 of file WaveClip.cpp.

{
   assert(ii < NChannels());
   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(), min(), mSequences, NChannels(), THROW_INCONSISTENCY_EXCEPTION, and TimeToSequenceSamples().

Referenced by WaveClipChannel::GetMinMax().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetName()

const wxString & WaveClip::GetName ( ) const

Definition at line 1726 of file WaveClip.cpp.

{
   return mName;
}

References mName.

◆ GetNumSamples()

sampleCount WaveClip::GetNumSamples ( ) const

private

Definition at line 678 of file WaveClip.cpp.

{
   // Assume only the weak invariant
   sampleCount result = 0;
   for (auto &pSequence: mSequences)
      result = std::max(result, pSequence->GetNumSamples());
   return result;
}

References mSequences.

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

Here is the caller graph for this function:

◆ GetPitchAndSpeedPreset()

PitchAndSpeedPreset WaveClip::GetPitchAndSpeedPreset ( ) const

virtual

Implements ClipInterface.

Definition at line 1606 of file WaveClip.cpp.

{
   return mPitchAndSpeedPreset;
}

References mPitchAndSpeedPreset.

◆ GetPlayDuration()

double WaveClip::GetPlayDuration ( ) const

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

Definition at line 1784 of file WaveClip.cpp.

{
   return GetPlayEndTime() - GetPlayStartTime();
}

References GetPlayEndTime(), and GetPlayStartTime().

Referenced by IsEmpty().

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 1799 of file WaveClip.cpp.

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

References GetPlayEndTime(), and mRate.

Referenced by WaveClipChannel::GetPlayEndSample().

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 1772 of file WaveClip.cpp.

{
    const auto numSamples = GetNumSamples();
    double maxLen = mSequenceOffset +
                    ((numSamples + GreatestAppendBufferLen()).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 GetNumSamples(), GetStretchRatio(), GreatestAppendBufferLen(), mRate, mSequenceOffset, mTrimRight, and SnapToTrackSample().

Referenced by AUPImportFileHandle::AddSilence(), AfterPlayRegion(), AppendSilence(), Clear(), ClearAndAddCutLine(), ClearLeft(), ClearRight(), CountSamples(), CoversEntirePlayRegion(), WaveClipChannel::End(), End(), EntirelyWithinPlayRegion(), GetMinMax(), GetPlayDuration(), GetPlayEndSample(), WaveClipChannel::GetPlayEndTime(), InsertSilence(), IntersectsPlayRegion(), Paste(), WaveClipUIUtilities::SelectClip(), anonymous_namespace{ClipOverflowButtonHandle.cpp}::SelectInterval(), 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 1794 of file WaveClip.cpp.

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

References GetPlayStartTime(), and mRate.

Referenced by WaveClipChannel::GetPlayStartSample().

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 1762 of file WaveClip.cpp.

{
   return SnapToTrackSample(mSequenceOffset + mTrimLeft);
}

References mSequenceOffset, mTrimLeft, and SnapToTrackSample().

Referenced by AtOrBeforePlayRegion(), BeforePlayRegion(), Clear(), ClearAndAddCutLine(), ClearLeft(), ClearRight(), CountSamples(), CoversEntirePlayRegion(), GetMinMax(), GetPlayDuration(), GetPlayStartSample(), WaveClipChannel::GetPlayStartTime(), InsertSilence(), IntersectsPlayRegion(), Paste(), WaveClipUIUtilities::SelectClip(), anonymous_namespace{ClipOverflowButtonHandle.cpp}::SelectInterval(), WaveClipUtilities::SharesBoundaryWithNextClip(), SplitsPlayRegion(), WaveClipChannel::Start(), Start(), StretchBy(), 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 337 of file WaveClip.h.

   {
      return mRate;
   }

Referenced by ClearAndAddCutLine(), WaveClipChannel::GetRate(), InsertSilence(), Paste(), WaveClipUtilities::SharesBoundaryWithNextClip(), TrimQuarternotesFromRight(), UpdateEnvelopeTrackLen(), WaveBitmapCache::WaveBitmapCache(), and WaveClip::ClearSequenceFinisher::~ClearSequenceFinisher().

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 < NChannels()

Definition at line 764 of file WaveClip.cpp.

{
   assert(ii < NChannels());
   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 mSequences, NChannels(), THROW_INCONSISTENCY_EXCEPTION, and TimeToSequenceSamples().

Referenced by WaveClipChannel::GetRMS().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSampleFormats()

SampleFormats WaveClip::GetSampleFormats ( ) const

Definition at line 687 of file WaveClip.cpp.

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

References mSequences.

Referenced by anonymous_namespace{WaveDataCache.cpp}::AppendBufferHelper::GetAppendBufferPointer(), MakeStereo(), and 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 NChannels()

Parameters

start relative to clip play start sample

Definition at line 387 of file WaveClip.cpp.

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

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

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 < NChannels()

Definition at line 378 of file WaveClip.cpp.

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

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

Referenced by WaveClipUtilities::GetFloatAtTime(), WaveClipChannel::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 < NChannels(); stretched samples in [t0, t1) can be counted in a size_t

Definition at line 363 of file WaveClip.cpp.

{
   assert(iChannel < NChannels());
   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(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, min(), NChannels(), 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 < NChannels()

Implements ClipInterface.

Definition at line 355 of file WaveClip.cpp.

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

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

Referenced by WaveClipChannel::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 < NChannels()

Definition at line 571 of file WaveClip.h.

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

Referenced by WaveClipChannel::GetSequence(), and anonymous_namespace{WaveDataCache.cpp}::MakeDefaultDataProvider().

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 < NChannels()

Definition at line 578 of file WaveClip.h.

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

◆ GetSequenceBlockArray()

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

Parameters

ii	identifies the channel

Precondition: ii < NChannels()

Definition at line 417 of file WaveClip.cpp.

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

References mSequences, and NChannels().

Referenced by WaveClipChannel::GetSequenceBlockArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSequenceEndTime()

double WaveClip::GetSequenceEndTime ( ) const

Definition at line 1885 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(), anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::GetLeftAdjustLimit(), anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::GetRightAdjustLimit(), 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 1757 of file WaveClip.cpp.

{
    return GetNumSamples() * NChannels();
}

References GetNumSamples(), and NChannels().

Referenced by Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSequenceStartSample()

sampleCount WaveClip::GetSequenceStartSample ( ) const

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

Definition at line 1893 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 1872 of file WaveClip.cpp.

{
    // JS: mSequenceOffset is the minimum value and it is returned; no clipping to 0
    // Do we need to `SnapToTrackSample` before returning?
    return mSequenceOffset;
}

References mSequenceOffset.

Referenced by Clear(), ClearAndAddCutLine(), ClearLeft(), ExpandCutLine(), FindCutLine(), anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::GetLeftAdjustLimit(), anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::GetRightAdjustLimit(), GetSequenceEndTime(), InsertSilence(), OffsetCutLines(), Paste(), RemoveCutLine(), SetRate(), ShiftBy(), TimeToSequenceSamples(), WaveClip(), and WaveClip::ClearSequenceFinisher::~ClearSequenceFinisher().

Here is the caller graph for this function:

◆ GetStretchRatio()

double WaveClip::GetStretchRatio ( ) const

overridevirtual

Implements ClipTimes.

Definition at line 625 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 GetPlayEndTime(), GetSequenceEndTime(), WaveClipChannel::GetStretchRatio(), HasEqualPitchAndSpeed(), OnProjectTempoChange(), Paste(), SamplesToTime(), TimeStretching::SetClipStretchRatio(), SetRate(), WaveClipUtilities::SharesBoundaryWithNextClip(), StretchBy(), StretchLeftTo(), StretchRatioEquals(), TimeToSamples(), TrimQuarternotesFromRight(), UpdateEnvelopeTrackLen(), and WaveBitmapCache::WaveBitmapCache().

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 1815 of file WaveClip.cpp.

{
    return mTrimLeft;
}

References mTrimLeft.

Referenced by Clear(), and WaveClipChannel::GetTrimLeft().

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 1825 of file WaveClip.cpp.

{
    return mTrimRight;
}

References mTrimRight.

Referenced by WaveClipChannel::GetTrimRight().

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 1804 of file WaveClip.cpp.

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

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

Referenced by WaveClipChannel::GetVisibleSampleCount(), WaveClipUtilities::SetFloatsFromTime(), and WaveClipUtilities::SharesBoundaryWithNextClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GreatestAppendBufferLen()

size_t WaveClip::GreatestAppendBufferLen ( ) const

private

Definition at line 537 of file WaveClip.cpp.

{
   size_t result = 0;
   for (size_t iChannel = 0; iChannel < NChannels(); ++iChannel)
      result = std::max(result, mSequences[iChannel]->GetAppendBufferLen());
   return result;
}

References GetAppendBufferLen(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, mSequences, and NChannels().

Referenced by Flush(), and GetPlayEndTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleXMLChild()

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

overridevirtual

Implements XMLTagHandler.

Definition at line 1034 of file WaveClip.cpp.

{
   auto &pFirst = mSequences[0];
   if (tag == Sequence::Sequence_tag) {
      // Push back a new sequence prototyped from the empty sequence made
      // by the constructor.  See also HandleXMLEndTag above.
      // Assume sequences were serialized in channel iteration order.
      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_tag)
   {
      // 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));
      return mCutLines.back().get();
   }
   else
      return nullptr;
}

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

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 1020 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_tag)
      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, UpdateEnvelopeTrackLen(), and WaveClip_tag.

Here is the call graph for this function:

◆ HandleXMLTag()

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

overridevirtual

Implements XMLTagHandler.

Definition at line 947 of file WaveClip.cpp.

{
   if (tag == WaveClip_tag)
   {
      double dblValue;
      long longValue;
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (attr == Offset_attr)
         {
            if (!value.TryGet(dblValue))
               return false;
            SetSequenceStartTime(dblValue);
         }
         else if (attr == TrimLeft_attr)
         {
            if (!value.TryGet(dblValue))
               return false;
            SetTrimLeft(dblValue);
         }
         else if (attr == TrimRight_attr)
         {
            if (!value.TryGet(dblValue))
               return false;
            SetTrimRight(dblValue);
         }
         else if (attr == CentShiftAttr)
         {
            if (!value.TryGet(dblValue))
               return false;
            mCentShift = dblValue;
         }
         else if (attr == PitchAndSpeedPreset_attr)
         {
            if (!value.TryGet(longValue))
               return false;
            mPitchAndSpeedPreset = static_cast<PitchAndSpeedPreset>(longValue);
         }
         else if (attr == RawAudioTempo_attr)
         {
            if (!value.TryGet(dblValue))
               return false;
            if (dblValue == 0)
               mRawAudioTempo.reset();
            else
               mRawAudioTempo = dblValue;
         }
         else if (attr == ClipStretchRatio_attr)
         {
            if (!value.TryGet(dblValue))
               return false;
            mClipStretchRatio = dblValue;
         }
         else if (attr == Name_attr)
         {
            if(value.IsStringView())
               SetName(value.ToWString());
         }
         else if (Attachments::FindIf(
            [&](WaveClipListener &listener){
               return listener.HandleXMLAttribute(attr, value); }
         ))
            ;
      }
      return true;
   }
 
   return false;
}

References CentShiftAttr, ClipStretchRatio_attr, WaveClipListener::HandleXMLAttribute(), mCentShift, mClipStretchRatio, mPitchAndSpeedPreset, mRawAudioTempo, Name_attr, Offset_attr, PitchAndSpeedPreset_attr, RawAudioTempo_attr, SetName(), SetSequenceStartTime(), SetTrimLeft(), SetTrimRight(), TrimLeft_attr, TrimRight_attr, and WaveClip_tag.

Here is the call graph for this function:

◆ HasEqualPitchAndSpeed()

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

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

Definition at line 661 of file WaveClip.cpp.

{
   return StretchRatioEquals(other.GetStretchRatio()) &&
          GetCentShift() == other.GetCentShift();
}

References GetCentShift(), GetStretchRatio(), and StretchRatioEquals().

Here is the call graph for this function:

◆ HasPitchOrSpeed()

bool WaveClip::HasPitchOrSpeed ( ) const

Definition at line 667 of file WaveClip.cpp.

{
   return !StretchRatioEquals(1.0) || GetCentShift() != 0;
}

References GetCentShift(), and StretchRatioEquals().

Referenced by WaveClipChannel::HasPitchOrSpeed().

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

Precondition: StrongInvariant()

Postcondition: StrongInvariant()

Exception safety guarantee:: Strong

Definition at line 1229 of file WaveClip.cpp.

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

References ClearSequence(), WaveClip::ClearSequenceFinisher::Commit(), GetEnvelope(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSequenceEndTime(), GetSequenceStartTime(), MarkChanged(), mSequences, OffsetCutLines(), anonymous_namespace{wxCommandTargets.cpp}::scope, SetTrimRight(), TimeToSamples(), 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 1928 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 WaveClipChannel::Intersects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsEmpty()

bool WaveClip::IsEmpty ( ) const

Definition at line 1789 of file WaveClip.cpp.

{
   return std::floor(GetPlayDuration() * mRate + 0.5) < 2.0;
}

References GetPlayDuration(), and mRate.

Here is the call graph for this function:

◆ MakeStereo()

void WaveClip::MakeStereo	(	WaveClip &&	other,
		bool	mustAlign
	)

Steal the right side data from other All cutlines are lost in this! Cutlines are not copied from other.

Stating sufficient preconditions for the postondition. Even stronger preconditions on matching offset, trims, and rates could be stated.

Precondition: NChannels() == 1; other.NChannels() == 1; GetSampleFormats() == other.GetSampleFormats(); GetSampleBlockFactory() == other.GetSampleBlockFactory(); !mustAlign || GetNumSamples() == other.GetNumSamples()

Postcondition: !mustAlign || StrongInvariant()

Definition at line 512 of file WaveClip.cpp.

{
   assert(NChannels() == 1);
   assert(other.NChannels() == 1);
   assert(GetSampleFormats() == other.GetSampleFormats());
   assert(GetFactory() == other.GetFactory());
   assert(!mustAlign || GetNumSamples() == other.GetNumSamples());
 
   mCutLines.clear();
   mSequences.resize(2);
   mSequences[1] = move(other.mSequences[0]);
 
   this->Attachments::ForCorresponding(other,
   [mustAlign](WaveClipListener *pLeft, WaveClipListener *pRight){
      // Precondition of callback from ClientData::Site
      assert(pLeft && pRight);
      pLeft->MakeStereo(std::move(*pRight), mustAlign);
   });
 
   if (mustAlign)
      assert(StrongInvariant());
   else
      assert(CheckInvariants());
}

References CheckInvariants(), GetFactory(), GetNumSamples(), GetSampleFormats(), WaveClipListener::MakeStereo(), mCutLines, mSequences, NChannels(), and StrongInvariant().

Here is the call graph for this function:

◆ MarkChanged()

void WaveClip::MarkChanged ( )

privatenoexcept

Called by mutating operations; notifies listeners.

Exception safety guarantee:: No-fail

Definition at line 735 of file WaveClip.cpp.

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

References WaveClipListener::MarkChanged().

Referenced by Append(), Clear(), ClearAndAddCutLine(), ClearLeft(), ClearRight(), ConvertToSampleFormat(), Flush(), InsertSilence(), Paste(), Resample(), SetRate(), SetSamples(), SetSilence(), and ShiftBy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NChannels()

size_t WaveClip::NChannels ( ) const

overridevirtual

How many Sequences the clip contains.

Implements WideChannelGroupInterval.

Definition at line 373 of file WaveClip.cpp.

{
   return mSequences.size();
}

References mSequences.

Referenced by AddCutLine(), Append(), AppendLegacyNewBlock(), AppendLegacySharedBlock(), AppendToChannel(), CheckInvariants(), ConvertToSampleFormat(), DiscardRightChannel(), anonymous_namespace{WaveformView.cpp}::WaveformPainter::EnsureClip(), GetAppendBuffer(), GetAppendBufferLen(), GetMinMax(), GetRMS(), GetSamples(), GetSampleView(), GetSequenceBlockArray(), GetSequenceSamplesCount(), GreatestAppendBufferLen(), MakeStereo(), Paste(), RepairChannels(), SetSamples(), SplitChannels(), StrongInvariant(), SwapChannels(), and WaveClip().

Here is the caller graph for this function:

◆ NumCutLines()

size_t WaveClip::NumCutLines ( ) const

inline

Definition at line 731 of file WaveClip.h.

731{ return mCutLines.size(); }

Referenced by WaveClip().

Here is the caller graph for this function:

◆ 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 1550 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 545 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.value_or(newTempo);
 
   if (oldTempo.has_value())
   {
      const auto ratioChange = *oldTempo / newTempo;
      mSequenceOffset *= ratioChange;
      mTrimLeft *= ratioChange;
      mTrimRight *= ratioChange;
      StretchCutLines(ratioChange);
      mEnvelope->RescaleTimesBy(ratioChange);
   }
   mProjectTempo = newTempo;
   Observer::Publisher<StretchRatioChange>::Publish(
      StretchRatioChange { GetStretchRatio() });
}

References GetStretchRatio(), mEnvelope, mProjectTempo, mRawAudioTempo, mSequenceOffset, mTrimLeft, mTrimRight, Observer::Publisher< Message, NotifyAll >::Publish(), 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 1922 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 &	o
	)

Returns: true and succeed if and only if this->NChannels() == other.NChannels() and either this is empty or this->GetStretchRatio() == other.GetStretchRatio().

Precondition: StrongInvariant(); other.StrongInvariant()

Postcondition: StrongInvariant()

This says, same widths and ratios are sufficient for success

Postcondition: result: this->NChannels() != other.NChannels() || this->GetStretchRatio() != other.GetStretchRatio() || result

Exception safety guarantee:: Strong

Definition at line 1100 of file WaveClip.cpp.

{
   const WaveClip *pOther = &o;
   WaveClipHolder dup;
   if (!o.StrongInvariant()) {
      assert(false); // precondition not honored
      // But try to repair it and continue in release
      dup = std::make_shared<WaveClip>(o, o.GetFactory(), true);
      dup->RepairChannels();
      pOther = dup.get();
   }
   auto &other = *pOther;
 
   if (NChannels() != other.NChannels())
      // post is satisfied
      return false;
 
   if (GetSequenceSamplesCount() == 0)
   {
      // Empty clip: we're flexible and adopt the other's stretching.
      mRawAudioTempo = other.mRawAudioTempo;
      mClipStretchRatio = other.mClipStretchRatio;
      mProjectTempo = other.mProjectTempo;
   }
   else if (GetStretchRatio() != other.GetStretchRatio())
      // post is satisfied
      return false;
 
   StrongInvariantScope scope{ *this };
 
   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());
   // Delay the finish of the clearing of this clip
   ClearSequenceFinisher finisher;
 
   //seems like edge cases cannot happen, see WaveTrack::PasteWaveTrack
   auto &factory = GetFactory();
   if (t0 == GetPlayStartTime())
   {
      finisher = ClearSequence(GetSequenceStartTime(), t0);
      SetTrimLeft(other.GetTrimLeft());
 
      auto copy = std::make_shared<WaveClip>(other, factory, true);
      copy->ClearSequence(copy->GetPlayEndTime(), copy->GetSequenceEndTime())
         .Commit();
      newClip = std::move(copy);
   }
   else if (t0 == GetPlayEndTime())
   {
      finisher = ClearSequence(GetPlayEndTime(), GetSequenceEndTime());
      SetTrimRight(other.GetTrimRight());
 
      auto copy = std::make_shared<WaveClip>(other, factory, true);
      copy->ClearSequence(copy->GetSequenceStartTime(), copy->GetPlayStartTime())
         .Commit();
      newClip = std::move(copy);
   }
   else
   {
      newClip = std::make_shared<WaveClip>(other, factory, true);
      newClip->ClearSequence(newClip->GetPlayEndTime(), newClip->GetSequenceEndTime())
         .Commit();
      newClip->ClearSequence(newClip->GetSequenceStartTime(), newClip->GetPlayStartTime())
         .Commit();
      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.NChannels() == newClip->NChannels());
   // 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 = NChannels(); ii < width; ++ii)
      mSequences[ii]->Paste(s0, newClip->mSequences[ii].get());
 
   // Assume No-fail-guarantee in the remaining
 
   finisher.Commit();
   transaction.Commit();
   MarkChanged();
 
   const auto sampleTime = 1.0 / GetRate();
   const auto timeOffsetInEnvelope =
      s0.as_double() * GetStretchRatio() / mRate + GetSequenceStartTime();
   mEnvelope->PasteEnvelope(
      timeOffsetInEnvelope, 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(), ClearSequence(), WaveClip::ClearSequenceFinisher::Commit(), staffpad::vo::copy(), factory, GetFactory(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSampleFormats(), GetSequenceEndTime(), GetSequenceSamplesCount(), GetSequenceStartTime(), GetStretchRatio(), MarkChanged(), mClipStretchRatio, mCutLines, mEnvelope, mProjectTempo, mRate, mRawAudioTempo, mSequences, NChannels(), OffsetCutLines(), Paste(), anonymous_namespace{wxCommandTargets.cpp}::scope, SetTrimLeft(), SetTrimRight(), SampleFormats::Stored(), StrongInvariant(), and TimeToSequenceSamples().

Referenced by ExpandCutLine(), and Paste().

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 1533 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:

◆ RepairChannels()

void WaveClip::RepairChannels ( )

Ensure that all sequences have the same sample count.

Definition at line 918 of file WaveClip.cpp.

{
   if (NChannels() < 2)
      return;
   // Be sure of consistency of sample counts
   // We may be here because the drive can't hold another megabyte, but
   // note that InsertSilence makes silent blocks that don't occupy
   // space in the database table of blocks.
   // (However autosave may want to rewrite the document blob, so this solution
   // may yet not be perfect.)
   Transaction transaction{ *this };
   const auto maxSamples = GetNumSamples();
   for (const auto &pSequence: mSequences) {
      const auto numSamples = pSequence->GetNumSamples();
      if (pSequence->GetNumSamples() != maxSamples)
         pSequence->InsertSilence(numSamples, maxSamples - numSamples);
   }
   transaction.Commit();
}

References GetNumSamples(), mSequences, and NChannels().

Referenced by AssertOrRepairStrongInvariant().

Here is the call graph for this function:

Here is the caller 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 1612 of file WaveClip.cpp.

{
   // This mutator does not require the strong invariant.
 
   // 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 is always configured to have single channel.
   //Create Resample instance per each channel in the clip
   std::vector<::Resample> resample;
   for (unsigned n = 0; n < mSequences.size(); ++n)
      resample.emplace_back(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{};
      size_t nSequence = 0;
      for (auto &pSequence : mSequences) {
         auto &pNewSequence = *ppNewSequence++;
         if (
            inLen > 0 &&
            !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[nSequence].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 */
         );
         ++nSequence;
      }
      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();
      Attachments::ForEach( std::mem_fn( &WaveClipListener::Invalidate ) );
      MarkChanged();
   }
}

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

Here is the call graph for this function:

◆ SamplesToTime()

double WaveClip::SamplesToTime ( sampleCount s ) const

noexcept

Definition at line 1736 of file WaveClip.cpp.

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

References GetStretchRatio(), and mRate.

Referenced by SetRate(), and WaveClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetCentShift()

bool WaveClip::SetCentShift ( int cents )

Definition at line 1588 of file WaveClip.cpp.

{
   if (
      cents < TimeAndPitchInterface::MinCents ||
      cents > TimeAndPitchInterface::MaxCents)
      return false;
   mCentShift = cents;
   Observer::Publisher<CentShiftChange>::Publish(CentShiftChange { cents });
   return true;
}

References TimeAndPitchInterface::MaxCents, mCentShift, TimeAndPitchInterface::MinCents, and Observer::Publisher< Message, NotifyAll >::Publish().

Here is the call graph for this function:

◆ SetEnvelope()

void WaveClip::SetEnvelope ( std::unique_ptr< Envelope > p )

Precondition: p

Definition at line 411 of file WaveClip.cpp.

{
   assert(p);
   mEnvelope = move(p);
}

References mEnvelope.

◆ SetIsPlaceholder()

void WaveClip::SetIsPlaceholder ( bool val )

inline

Definition at line 773 of file WaveClip.h.

773{ mIsPlaceholder = val; }

◆ SetName()

void WaveClip::SetName ( const wxString & name )

Definition at line 1721 of file WaveClip.cpp.

{
   mName = name;
}

References mName, and name.

Referenced by HandleXMLTag().

Here is the caller graph for this function:

◆ SetPitchAndSpeedPreset()

void WaveClip::SetPitchAndSpeedPreset ( PitchAndSpeedPreset preset )

Definition at line 1599 of file WaveClip.cpp.

{
   mPitchAndSpeedPreset = preset;
   Observer::Publisher<PitchAndSpeedPresetChange>::Publish(
      PitchAndSpeedPresetChange { mPitchAndSpeedPreset });
}

References mPitchAndSpeedPreset, preset, and Observer::Publisher< Message, NotifyAll >::Publish().

Here is the call graph for this function:

◆ SetPlayStartTime()

void WaveClip::SetPlayStartTime ( double time )

Definition at line 1767 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 1568 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);
   const auto newLength =
      GetNumSamples().as_double() * GetStretchRatio() / mRate;
   mEnvelope->RescaleTimes(newLength);
   MarkChanged();
   SetSequenceStartTime(GetSequenceStartTime() * ratio);
}

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

Here is the call graph for this function:

◆ SetRawAudioTempo()

void WaveClip::SetRawAudioTempo ( double tempo )

Definition at line 1583 of file WaveClip.cpp.

{
   mRawAudioTempo = tempo;
}

References mRawAudioTempo.

◆ 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 < NChannels(); StrongInvariant()

Postcondition: StrongInvariant()

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 397 of file WaveClip.cpp.

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

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

Referenced by WaveClipUtilities::SetFloatsFromTime(), and WaveClipChannel::SetSamples().

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 1879 of file WaveClip.cpp.

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

References mEnvelope, and mSequenceOffset.

Referenced by ClearLeft(), HandleXMLTag(), SetPlayStartTime(), SetRate(), and ShiftBy().

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)

Precondition: StrongInvariant()

Postcondition: StrongInvariant()

Definition at line 1746 of file WaveClip.cpp.

{
   StrongInvariantScope scope{ *this };
   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, anonymous_namespace{wxCommandTargets.cpp}::scope, 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 1810 of file WaveClip.cpp.

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

References mTrimLeft.

Referenced by Clear(), 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 1820 of file WaveClip.cpp.

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

References mTrimRight.

Referenced by Clear(), ClearRight(), HandleXMLTag(), InsertSilence(), Paste(), and TrimRight().

Here is the caller graph for this function:

◆ ShiftBy()

void WaveClip::ShiftBy ( double delta )

noexcept

Exception safety guarantee:: No-fail

Definition at line 1898 of file WaveClip.cpp.

{
   SetSequenceStartTime(GetSequenceStartTime() + delta);
   MarkChanged();
}

References GetSequenceStartTime(), MarkChanged(), and SetSequenceStartTime().

Referenced by Clear(), ClearAndAddCutLine(), WaveTrackShifter::DoHorizontalOffset(), and WaveClip::ClearSequenceFinisher::~ClearSequenceFinisher().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SnapToTrackSample()

double WaveClip::SnapToTrackSample ( double time ) const

privatenoexcept

Definition at line 1741 of file WaveClip.cpp.

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

References mRate, and fast_float::round().

Referenced by GetPlayEndTime(), GetPlayStartTime(), TrimLeftTo(), and TrimRightTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SplitChannels()

std::shared_ptr< WaveClip > WaveClip::SplitChannels ( )

A stereo WaveClip becomes mono, keeping the left side and returning a new clip with the right side samples

Precondition: NChannels() == 2

Postcondition: NChannels() == 1; result: result->NChannels() == 1

Definition at line 480 of file WaveClip.cpp.

{
   assert(NChannels() == 2);
 
   // Make empty copies of this and all cutlines
   CreateToken token{ true };
   auto result = std::make_shared<WaveClip>(*this, GetFactory(), true, token);
 
   // Move one Sequence
   TransferSequence(*this, *result);
 
   // Must also do that for cutlines, which must be in correspondence, because
   // of the post of the constructor.
   // And possibly too for cutlines inside of cutlines!
   FixSplitCutlines(mCutLines, result->mCutLines);
 
   // Fix attachments in the new clip and assert consistency conditions between
   // the clip and its cutlines
   result->Attachments::ForEach([](WaveClipListener &attachment){
      attachment.Erase(0);
   });
   assert(result->CheckInvariants());
 
   // This call asserts invariants for this clip
   DiscardRightChannel();
 
   // Assert postconditions
   assert(NChannels() == 1);
   assert(result->NChannels() == 1);
   return result;
}

References DiscardRightChannel(), WaveClipListener::Erase(), FixSplitCutlines(), GetFactory(), mCutLines, NChannels(), and TransferSequence().

Here is the call 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 1904 of file WaveClip.cpp.

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

References GetPlayEndTime(), and GetPlayStartTime().

Here is the call graph for this function:

◆ Start()

double WaveClip::Start ( ) const

overridevirtual

Postcondition: result: result < End()

Implements ChannelGroupInterval.

Definition at line 340 of file WaveClip.cpp.

{
   return GetPlayStartTime();
}

References GetPlayStartTime().

Referenced by anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::GetLeftAdjustLimit(), and TimeStretching::SetClipStretchRatio().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StretchBy()

void WaveClip::StretchBy ( double ratio )

Definition at line 599 of file WaveClip.cpp.

{
   const auto pst = GetPlayStartTime();
   mSequenceOffset = pst - mTrimLeft * ratio;
   mTrimLeft *= ratio;
   mTrimRight *= ratio;
   mClipStretchRatio *= ratio;
   mEnvelope->SetOffset(mSequenceOffset);
   mEnvelope->RescaleTimesBy(ratio);
   StretchCutLines(ratio);
   Observer::Publisher<StretchRatioChange>::Publish(
      StretchRatioChange { GetStretchRatio() });
}

References GetPlayStartTime(), GetStretchRatio(), mClipStretchRatio, mEnvelope, mSequenceOffset, mTrimLeft, mTrimRight, Observer::Publisher< Message, NotifyAll >::Publish(), and StretchCutLines().

Referenced by StretchRightTo().

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 613 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(), StretchBy(), and StretchLeftTo().

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 569 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);
   Observer::Publisher<StretchRatioChange>::Publish(
      StretchRatioChange { GetStretchRatio() });
}

References GetPlayEndTime(), GetPlayStartTime(), GetStretchRatio(), mClipStretchRatio, mEnvelope, mSequenceOffset, mTrimLeft, mTrimRight, Observer::Publisher< Message, NotifyAll >::Publish(), and StretchCutLines().

Referenced by anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::StretchLeftTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StretchRatioEquals()

bool WaveClip::StretchRatioEquals ( double value ) const

private

Definition at line 672 of file WaveClip.cpp.

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

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

Referenced by HasEqualPitchAndSpeed(), and HasPitchOrSpeed().

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 588 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;
   StretchBy(ratioChange);
}

References GetPlayEndTime(), GetPlayStartTime(), and StretchBy().

Referenced by WaveTrackUtilities::ExpandClipTillNextOne(), TimeStretching::SetClipStretchRatio(), and anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::StretchRightTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StrongInvariant()

bool WaveClip::StrongInvariant ( ) const

A precondition for some mutating operations CheckInvariants() is true, and also all sequences have the same length

Definition at line 2013 of file WaveClip.cpp.

{
   if (!CheckInvariants())
      return false;
   const auto width = NChannels();
   auto iter = mSequences.begin(),
      end = mSequences.end();
   assert(iter != end); // because CheckInvariants is true
   auto &pFirst = *iter++;
   assert(pFirst); // likewise
   // All sequences must have the same lengths
   return all_of(iter, end, [&](decltype(pFirst) pSequence) {
      assert(pSequence); // likewise
      return pSequence->GetNumSamples() == pFirst->GetNumSamples();
   });
}

References CheckInvariants(), details::end(), mSequences, and NChannels().

Referenced by AssertOrRepairStrongInvariant(), MakeStereo(), and Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SubscribeToCentShiftChange()

Observer::Subscription WaveClip::SubscribeToCentShiftChange ( std::function< void(int)> cb ) const

overridevirtual

Implements ClipInterface.

Definition at line 640 of file WaveClip.cpp.

{
   // Consider the list of subcribers as a mutable member that doesn't change
   // real state
   return const_cast<WaveClip*>(this)->
   Observer::Publisher<CentShiftChange>::Subscribe(
      [cb](const CentShiftChange& cents) { cb(cents.newValue); });
}

References CentShiftChange::newValue.

◆ SubscribeToPitchAndSpeedPresetChange()

Observer::Subscription WaveClip::SubscribeToPitchAndSpeedPresetChange ( std::function< void(PitchAndSpeedPreset)> cb ) const

overridevirtual

Implements ClipInterface.

Definition at line 649 of file WaveClip.cpp.

{
   // Consider the list of subcribers as a mutable member that doesn't change
   // real state
   return const_cast<WaveClip*>(this)->
   Observer::Publisher<PitchAndSpeedPresetChange>::Subscribe(
      [cb](const PitchAndSpeedPresetChange& formant) {
         cb(formant.newValue);
      });
}

References PitchAndSpeedPresetChange::newValue.

◆ SwapChannels()

void WaveClip::SwapChannels ( )

Precondition: NChannels() == 2

Definition at line 441 of file WaveClip.cpp.

{
   assert(NChannels() == 2);
   this->Attachments::ForEach([](WaveClipListener &attachment){
      attachment.SwapChannels();
   });
   std::swap(mSequences[0], mSequences[1]);
   for (auto &pCutline : mCutLines)
      pCutline->SwapChannels();
   assert(CheckInvariants());
}

References CheckInvariants(), mCutLines, mSequences, NChannels(), anonymous_namespace{NoteTrack.cpp}::swap(), and WaveClipListener::SwapChannels().

Here is the call graph for this function:

◆ TimeToSamples()

sampleCount WaveClip::TimeToSamples ( double time ) const

overridevirtual

Implements ClipTimes.

Definition at line 1731 of file WaveClip.cpp.

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

References GetStretchRatio(), and mRate.

Referenced by CountSamples(), WaveClipUtilities::GetFloatAtTime(), GetSamples(), GetSampleView(), GetSequenceStartSample(), GetVisibleSampleCount(), InsertSilence(), WaveClipUtilities::SetFloatsFromTime(), SetRate(), SetSamples(), SetSilence(), WaveClipChannel::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 1970 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(), GetMinMax(), GetRMS(), InsertSilence(), and Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransferSequence()

void WaveClip::TransferSequence	(	WaveClip &	origClip,
		WaveClip &	newClip
	)

staticprivate

Definition at line 453 of file WaveClip.cpp.

{
   // Move right channel into result
   newClip.mSequences.resize(1);
   newClip.mSequences[0] = move(origClip.mSequences[1]);
   // Delayed satisfaction of the class invariants after the empty construction
   newClip.CheckInvariants();
}

References CheckInvariants(), and mSequences.

Referenced by FixSplitCutlines(), and SplitChannels().

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 1830 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 1859 of file WaveClip.cpp.

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

References GetPlayEndTime(), mSequenceOffset, mTrimLeft, and SnapToTrackSample().

Referenced by anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::TrimLeftTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TrimQuarternotesFromRight()

void WaveClip::TrimQuarternotesFromRight ( double quarters )

Same as TrimRight, but expressed as quarter notes.

Definition at line 1840 of file WaveClip.cpp.

{
   assert(mRawAudioTempo.has_value());
   if (!mRawAudioTempo.has_value())
      return;
   const auto secondsPerQuarter = 60 * GetStretchRatio() / *mRawAudioTempo;
   // MH https://github.com/audacity/audacity/issues/5878: Clip boundaries are
   // quantized to the sample period. Music durations aren't, though.
   // `quarters` was probably chosen such that the clip ends exactly at some
   // musical grid snapping point. However, if we right-trim by `quarters`,
   // the clip's play end time might be rounded up to the next sample period,
   // overlapping the next snapping point on the musical grid. We don't want
   // this, or it would disturb music producers who want to horizontally
   // duplicate loops.
   const auto quantizedTrim =
      std::ceil(quarters * secondsPerQuarter * GetRate()) / GetRate();
   TrimRight(quantizedTrim);
}

References GetRate(), GetStretchRatio(), mRawAudioTempo, and TrimRight().

Here is the call graph for this function:

◆ TrimRight()

void WaveClip::TrimRight ( double deltaTime )

Moves play end position by deltaTime.

Definition at line 1835 of file WaveClip.cpp.

{
   SetTrimRight(mTrimRight + deltaTime);
}

References mTrimRight, and SetTrimRight().

Referenced by TrimQuarternotesFromRight().

Here is the call graph for this function:

Here is the caller 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 1866 of file WaveClip.cpp.

{
   const auto endTime = SnapToTrackSample(GetSequenceEndTime());
   mTrimRight = endTime - std::clamp(to, GetPlayStartTime(), endTime);
}

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

Referenced by anonymous_namespace{WaveClipAdjustBorderHandle.cpp}::TrimRightTo().

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 807 of file WaveClip.cpp.

{
   // The envelope time points account for stretching.
   const auto len = GetNumSamples().as_double() * GetStretchRatio() / mRate;
   if (len != mEnvelope->GetTrackLen())
      mEnvelope->SetTrackLen(len, 1.0 / GetRate());
}

References sampleCount::as_double(), GetNumSamples(), GetRate(), GetStretchRatio(), 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 1909 of file WaveClip.cpp.

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

References GetPlayEndTime(), and GetPlayStartTime().

Referenced by WaveClipUtilities::GetFloatAtTime(), PartlyWithinPlayRegion(), and WaveClipChannel::WithinPlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteXML()

void WaveClip::WriteXML	(	size_t	ii,
		XMLWriter &	xmlFile
	)		const

Wave clip data has always been written by channel-major iteration and is still done so for compatibility. Therefore, the first argument.

Parameters

ii	identifies the channel

Precondition: ii < NChannels()

Definition at line 1066 of file WaveClip.cpp.

{
   assert(ii < NChannels());
 
   if (GetSequenceSamplesCount() <= 0)
      // Oops, I'm empty? How did that happen? Anyway, I do nothing but causing
      // problems, don't save me.
      return;
 
   xmlFile.StartTag(WaveClip_tag);
   xmlFile.WriteAttr(Offset_attr, mSequenceOffset, 8);
   xmlFile.WriteAttr(TrimLeft_attr, mTrimLeft, 8);
   xmlFile.WriteAttr(TrimRight_attr, mTrimRight, 8);
   xmlFile.WriteAttr(CentShiftAttr, mCentShift);
   xmlFile.WriteAttr(PitchAndSpeedPreset_attr,
      static_cast<long>(mPitchAndSpeedPreset));
   xmlFile.WriteAttr(RawAudioTempo_attr, mRawAudioTempo.value_or(0.), 8);
   xmlFile.WriteAttr(ClipStretchRatio_attr, mClipStretchRatio, 8);
   xmlFile.WriteAttr(Name_attr, mName);
   Attachments::ForEach([&](const WaveClipListener &listener){
      listener.WriteXMLAttributes(xmlFile);
   });
 
   mSequences[ii]->WriteXML(xmlFile);
   mEnvelope->WriteXML(xmlFile);
 
   for (const auto &clip: mCutLines)
      clip->WriteXML(ii, xmlFile);
 
   xmlFile.EndTag(WaveClip_tag);
}

References CentShiftAttr, ClipStretchRatio_attr, WaveTrackUtilities::GetSequenceSamplesCount(), Name_attr, Offset_attr, PitchAndSpeedPreset_attr, RawAudioTempo_attr, TrimLeft_attr, TrimRight_attr, and WaveClipListener::WriteXMLAttributes().

Referenced by WaveClipChannel::WriteXML().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mCentShift

int WaveClip::mCentShift { 0 }

private

Definition at line 950 of file WaveClip.h.

Referenced by GetCentShift(), HandleXMLTag(), and SetCentShift().

◆ mClipStretchRatio

double WaveClip::mClipStretchRatio = 1.

private

Definition at line 954 of file WaveClip.h.

Referenced by GetStretchRatio(), HandleXMLTag(), Paste(), StretchBy(), and StretchLeftTo().

◆ 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 973 of file WaveClip.h.

Referenced by AddCutLine(), CheckInvariants(), ClearAndAddCutLine(), CloseLock(), DiscardRightChannel(), ExpandCutLine(), FindCutLine(), HandleXMLChild(), MakeStereo(), OffsetCutLines(), Paste(), RemoveCutLine(), SplitChannels(), StretchCutLines(), SwapChannels(), WaveClip(), and WaveClip::ClearSequenceFinisher::~ClearSequenceFinisher().

◆ mEnvelope

std::unique_ptr<Envelope> WaveClip::mEnvelope

private

Envelope is unique, not per-sequence, and always non-null.

Definition at line 966 of file WaveClip.h.

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

◆ mIsPlaceholder

bool WaveClip::mIsPlaceholder { false }

private

Definition at line 976 of file WaveClip.h.

Referenced by WaveClip().

◆ mName

wxString WaveClip::mName

private

Definition at line 978 of file WaveClip.h.

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

◆ mPitchAndSpeedPreset

PitchAndSpeedPreset WaveClip::mPitchAndSpeedPreset { PitchAndSpeedPreset::Default }

private

Definition at line 949 of file WaveClip.h.

Referenced by GetPitchAndSpeedPreset(), HandleXMLTag(), and SetPitchAndSpeedPreset().

◆ mProjectTempo

std::optional<double> WaveClip::mProjectTempo

private

Definition at line 956 of file WaveClip.h.

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

◆ mRate

int WaveClip::mRate

private

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

Definition at line 959 of file WaveClip.h.

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

◆ mRawAudioTempo

std::optional<double> WaveClip::mRawAudioTempo

private

Definition at line 955 of file WaveClip.h.

Referenced by GetStretchRatio(), HandleXMLTag(), OnProjectTempoChange(), Paste(), SetRawAudioTempo(), and TrimQuarternotesFromRight().

◆ mSequenceOffset

double WaveClip::mSequenceOffset { 0 }

private

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

Definition at line 944 of file WaveClip.h.

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

◆ mSequences

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

private

◆ mTrimLeft

double WaveClip::mTrimLeft { 0 }

private

Definition at line 945 of file WaveClip.h.

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

◆ mTrimRight

double WaveClip::mTrimRight { 0 }

private

Definition at line 946 of file WaveClip.h.

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

◆ WaveClip_tag

const char * WaveClip::WaveClip_tag = "waveclip"

static

Definition at line 249 of file WaveClip.h.

Referenced by AUPImportFileHandle::HandleEnvelope(), AUPImportFileHandle::HandleWaveClip(), HandleXMLChild(), WaveTrack::HandleXMLChild(), HandleXMLEndTag(), WaveTrack::HandleXMLEndTag(), AUPImportFileHandle::HandleXMLEndTag(), HandleXMLTag(), and AUPImportFileHandle::HandleXMLTag().

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Attachments

◆ Channel

Constructor & Destructor Documentation

◆ WaveClip() [1/5]

◆ WaveClip() [2/5]

◆ WaveClip() [3/5]

◆ WaveClip() [4/5]

◆ ~WaveClip()

◆ WaveClip() [5/5]

Member Function Documentation

◆ AddCutLine()

◆ AfterPlayRegion()

◆ Append() [1/2]

◆ Append() [2/2]

◆ AppendLegacyNewBlock()

◆ AppendLegacySharedBlock()

◆ AppendSilence()

◆ AppendToChannel()

◆ AssertOrRepairStrongInvariant()

◆ AtOrBeforePlayRegion()

◆ BeforePlayRegion()

◆ Channels() [1/2]

◆ Channels() [2/2]

◆ CheckInvariants()

◆ Clear()

◆ ClearAndAddCutLine()

◆ ClearLeft()

◆ ClearRight()

◆ ClearSequence()

◆ CloseLock()

◆ ConvertToSampleFormat()

◆ CountBlocks()

◆ CountSamples()

◆ CoversEntirePlayRegion()

◆ DiscardRightChannel()

◆ DoGetChannel()

◆ End()

◆ EntirelyWithinPlayRegion()

◆ ExpandCutLine()

◆ FindCutLine()

◆ FixSplitCutlines()

◆ Flush()

◆ GetAppendBuffer()

◆ GetAppendBufferLen()

◆ GetBestBlockSize()

◆ GetCentShift()

◆ GetCutLines() [1/2]

◆ GetCutLines() [2/2]

◆ GetEmptySequenceCopies()

◆ GetEnvelope() [1/2]

◆ GetEnvelope() [2/2]

◆ GetFactory()

◆ GetIsPlaceholder()

◆ GetMaxBlockSize()

◆ GetMinMax()

◆ GetName()

◆ GetNumSamples()

◆ GetPitchAndSpeedPreset()

◆ GetPlayDuration()

◆ GetPlayEndSample()

◆ GetPlayEndTime()

◆ GetPlayStartSample()

◆ GetPlayStartTime()

◆ GetRate()

◆ GetRMS()

◆ GetSampleFormats()

◆ GetSamples() [1/2]

◆ GetSamples() [2/2]

◆ GetSampleView() [1/2]

◆ GetSampleView() [2/2]