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

#include <WaveClip.h>

Inheritance diagram for WaveClip:

Collaboration diagram for WaveClip:

Public Types
using	Caches = Site< WaveClip, WaveClipListener >

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

using	DataPointer = UniquePtr< WaveClipListener >

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

Public Member Functions
	WaveClip (const SampleBlockFactoryPtr &factory, sampleFormat format, int rate, int colourIndex)

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

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

virtual	~WaveClip ()

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

sampleCount	TimeToSequenceSamples (double t) const

sampleCount	ToSequenceSamples (sampleCount s) const

int	GetRate () const

void	SetRate (int rate)

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

void	SetColourIndex (int index)

int	GetColourIndex () const

double	GetSequenceStartTime () const noexcept

void	SetSequenceStartTime (double startTime)

double	GetSequenceEndTime () const

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

sampleCount	GetSequenceEndSample () const
	Returns the index of the sample next after the last sample of the underlying sequence. More...

sampleCount	GetSequenceSamplesCount () const
	Returns the total number of samples in underlying sequence (not counting the cutlines) More...

double	GetPlayStartTime () const noexcept

void	SetPlayStartTime (double time)

double	GetPlayEndTime () const

sampleCount	GetPlayStartSample () const

sampleCount	GetPlayEndSample () const

sampleCount	GetPlaySamplesCount () const

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

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

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

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

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

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

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

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

void	Offset (double delta) noexcept

bool	WithinPlayRegion (double t) const

bool	BeforePlayStartTime (double t) const

bool	AfterPlayEndTime (double t) const

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

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

Envelope *	GetEnvelope ()

const Envelope *	GetEnvelope () const

BlockArray *	GetSequenceBlockArray ()

const BlockArray *	GetSequenceBlockArray () const

Sequence *	GetSequence ()

const Sequence *	GetSequence () const

void	MarkChanged ()

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

float	GetRMS (double t0, double t1, bool mayThrow=true) const

void	UpdateEnvelopeTrackLen ()

std::shared_ptr< SampleBlock >	AppendNewBlock (samplePtr buffer, sampleFormat format, size_t len)
	For use in importing pre-version-3 projects to preserve sharing of blocks. More...

void	AppendSharedBlock (const std::shared_ptr< SampleBlock > &pBlock)
	For use in importing pre-version-3 projects to preserve sharing of blocks. More...

bool	Append (constSamplePtr buffer, sampleFormat format, size_t len, unsigned int stride)

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

void	Clear (double t0, double t1)

void	ClearLeft (double t)

void	ClearRight (double t)

void	ClearAndAddCutLine (double t0, double t1)
	Clear, and add cut line that starts at t0 and contains everything until t1. More...

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

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

void	AppendSilence (double len, double envelopeValue)

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

const WaveClipConstHolders &	GetCutLines () const

size_t	NumCutLines () const

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

void	ExpandCutLine (double cutLinePosition)

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

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

void	CloseLock ()

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

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

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

void	WriteXML (XMLWriter &xmlFile) const

bool	GetIsPlaceholder () const

void	SetIsPlaceholder (bool val)

bool	SharesBoundaryWithNextClip (const WaveClip *next) const

void	SetName (const wxString &name)

const wxString &	GetName () const

sampleCount	TimeToSamples (double time) const noexcept

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

const SampleBuffer &	GetAppendBuffer () const

size_t	GetAppendBufferLen () const

Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()

virtual	~XMLTagHandler ()

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

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

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

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

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

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

	Site ()

	Site (const Site &other)

	Site (Site &&other)

Site &	operator= (const Site &other)

Site &	operator= (Site &&other)

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

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

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

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

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

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

Protected Member Functions
void	ClearSequence (double t0, double t1)

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

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

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

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

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

Protected Attributes
double	mSequenceOffset { 0 }

double	mTrimLeft { 0 }

double	mTrimRight { 0 }

int	mRate

int	mColourIndex

std::unique_ptr< Sequence >	mSequence

std::unique_ptr< Envelope >	mEnvelope

SampleBuffer	mAppendBuffer {}

size_t	mAppendBufferLen { 0 }

WaveClipHolders	mCutLines {}

bool	mIsPlaceholder { false }

Private Member Functions
	WaveClip (const WaveClip &) PROHIBITED

WaveClip &	operator= (const WaveClip &) PROHIBITED

Private Attributes
wxString	mName

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

Detailed Description

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

Definition at line 99 of file WaveClip.h.

Member Typedef Documentation

◆ Caches

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

Definition at line 110 of file WaveClip.h.

Constructor & Destructor Documentation

◆ WaveClip() [1/4]

WaveClip::WaveClip ( const WaveClip & )

private

◆ WaveClip() [2/4]

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

Definition at line 43 of file WaveClip.cpp.

{
   mRate = rate;
   mColourIndex = colourIndex;
   mSequence = std::make_unique<Sequence>(factory, format);
 
   mEnvelope = std::make_unique<Envelope>(true, 1e-7, 2.0, 1.0);
}

References factory, format, mColourIndex, mEnvelope, mRate, and mSequence.

◆ WaveClip() [3/4]

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

Definition at line 53 of file WaveClip.cpp.

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

References factory, GetIsPlaceholder(), mColourIndex, mCutLines, mEnvelope, mIsPlaceholder, mName, mRate, mSequence, mSequenceOffset, mTrimLeft, and mTrimRight.

Here is the call graph for this function:

◆ WaveClip() [4/4]

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

Definition at line 80 of file WaveClip.cpp.

{
   // Copy only a range of the other WaveClip
 
   mSequenceOffset = orig.mSequenceOffset;
   mTrimLeft = orig.mTrimLeft + (t0 > orig.GetPlayStartTime()? t0 - orig.GetPlayStartTime() : 0);
   mTrimRight = orig.mTrimRight + (t1 < orig.GetPlayEndTime()? orig.GetPlayEndTime() - t1 : 0);
   
   mRate = orig.mRate;
   mColourIndex = orig.mColourIndex;
 
   mIsPlaceholder = orig.GetIsPlaceholder();
 
   auto s0 = orig.TimeToSequenceSamples(t0);
   auto s1 = orig.TimeToSequenceSamples(t1);
 
   mSequence = std::make_unique<Sequence>(*orig.mSequence, factory);
 
   mEnvelope = std::make_unique<Envelope>(*orig.mEnvelope);
 
   if ( copyCutlines )
      // Copy cutline clips that fall in the range
      for (const auto &ppClip : orig.mCutLines)
      {
         const WaveClip* clip = ppClip.get();
         double cutlinePosition = orig.GetSequenceStartTime() + clip->GetSequenceStartTime();
         if (cutlinePosition >= t0 && cutlinePosition <= t1)
         {
            auto newCutLine =
               std::make_unique< WaveClip >( *clip, factory, true );
            newCutLine->SetSequenceStartTime( cutlinePosition - t0 );
            mCutLines.push_back(std::move(newCutLine));
         }
      }
}

References factory, GetIsPlaceholder(), GetPlayEndTime(), GetPlayStartTime(), GetSequenceStartTime(), mColourIndex, mCutLines, mEnvelope, mIsPlaceholder, mRate, mSequence, mSequenceOffset, mTrimLeft, mTrimRight, and TimeToSequenceSamples().

Here is the call graph for this function:

◆ ~WaveClip()

WaveClip::~WaveClip ( )

virtual

Definition at line 120 of file WaveClip.cpp.

121{

122}

Member Function Documentation

◆ AfterPlayEndTime()

bool WaveClip::AfterPlayEndTime ( double t ) const

Definition at line 1031 of file WaveClip.cpp.

{
    auto ts = TimeToSamples(t);
    return ts >= GetPlayEndSample() + mAppendBufferLen;
}

References GetPlayEndSample(), mAppendBufferLen, and TimeToSamples().

Here is the call graph for this function:

◆ Append()

bool WaveClip::Append	(	constSamplePtr	buffer,
		sampleFormat	format,
		size_t	len,
		unsigned int	stride
	)

You must call Flush after the last Append

Returns: true if at least one complete block was created

Exception safety guarantee:: Partial – Some prefix (maybe none) of the buffer is appended, and no content already flushed to disk is lost.

Definition at line 229 of file WaveClip.cpp.

{
   //wxLogDebug(wxT("Append: len=%lli"), (long long) len);
   bool result = false;
 
   auto maxBlockSize = mSequence->GetMaxBlockSize();
   auto blockSize = mSequence->GetIdealAppendLen();
   sampleFormat seqFormat = mSequence->GetSampleFormat();
 
   if (!mAppendBuffer.ptr())
      mAppendBuffer.Allocate(maxBlockSize, seqFormat);
 
   auto cleanup = finally( [&] {
      // use No-fail-guarantee
      UpdateEnvelopeTrackLen();
      MarkChanged();
   } );
 
   for(;;) {
      if (mAppendBufferLen >= blockSize) {
         // flush some previously appended contents
         // use Strong-guarantee
         mSequence->Append(mAppendBuffer.ptr(), seqFormat, blockSize);
         result = true;
 
         // use No-fail-guarantee for rest of this "if"
         memmove(mAppendBuffer.ptr(),
                 mAppendBuffer.ptr() + blockSize * SAMPLE_SIZE(seqFormat),
                 (mAppendBufferLen - blockSize) * SAMPLE_SIZE(seqFormat));
         mAppendBufferLen -= blockSize;
         blockSize = mSequence->GetIdealAppendLen();
      }
 
      if (len == 0)
         break;
 
      // use No-fail-guarantee for rest of this "for"
      wxASSERT(mAppendBufferLen <= maxBlockSize);
      auto toCopy = std::min(len, maxBlockSize - mAppendBufferLen);
 
      CopySamples(buffer, format,
                  mAppendBuffer.ptr() + mAppendBufferLen * SAMPLE_SIZE(seqFormat),
                  seqFormat,
                  toCopy,
                  gHighQualityDither,
                  stride);
 
      mAppendBufferLen += toCopy;
      buffer += toCopy * SAMPLE_SIZE(format) * stride;
      len -= toCopy;
   }
 
   return result;
}

References SampleBuffer::Allocate(), CopySamples(), format, gHighQualityDither, mAppendBuffer, mAppendBufferLen, MarkChanged(), min(), mSequence, SampleBuffer::ptr(), SAMPLE_SIZE, and UpdateEnvelopeTrackLen().

Referenced by WaveTrack::Append().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AppendNewBlock()

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

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

Exception safety guarantee:: Strong

Definition at line 214 of file WaveClip.cpp.

{
   return mSequence->AppendNewBlock( buffer, format, len );
}

References format, and mSequence.

◆ AppendSharedBlock()

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

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

Exception safety guarantee:: Strong

Definition at line 221 of file WaveClip.cpp.

{
   mSequence->AppendSharedBlock( pBlock );
}

References mSequence.

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

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

References GetPlayEndTime(), and InsertSilence().

Here is the call graph for this function:

◆ BeforePlayStartTime()

bool WaveClip::BeforePlayStartTime ( double t ) const

Definition at line 1025 of file WaveClip.cpp.

{
    auto ts = TimeToSamples(t);
    return ts <= GetPlayStartSample();
}

References GetPlayStartSample(), and TimeToSamples().

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

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

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

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.

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

Definition at line 629 of file WaveClip.cpp.

{
   if (t0 > GetPlayEndTime() || t1 < GetPlayStartTime())
      return; // time out of bounds
 
   const double clip_t0 = std::max( t0, GetPlayStartTime() );
   const double clip_t1 = std::min( t1, GetPlayEndTime() );
 
   auto newClip = std::make_unique< WaveClip >
      (*this, mSequence->GetFactory(), true, clip_t0, clip_t1);
 
   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->Offset(clip_t0 - clip_t1);
         }
         ++it;
      }
   }
 
   // Clear actual audio data
   auto s0 = TimeToSequenceSamples(t0);
   auto s1 = TimeToSequenceSamples(t1);
 
   // use Weak-guarantee
   GetSequence()->Delete(s0, s1-s0);
 
   // Collapse envelope
   auto sampleTime = 1.0 / GetRate();
   GetEnvelope()->CollapseRegion( t0, t1, sampleTime );
   
   MarkChanged();
 
   mCutLines.push_back(std::move(newClip));
}

References Envelope::CollapseRegion(), Sequence::Delete(), GetEnvelope(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSequence(), GetSequenceStartTime(), MarkChanged(), mCutLines, min(), mSequence, Offset(), 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 550 of file WaveClip.cpp.

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

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

Here is the call graph for this function:

◆ ClearRight()

void WaveClip::ClearRight ( double t )

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

Definition at line 560 of file WaveClip.cpp.

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

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

Here is the call graph for this function:

◆ ClearSequence()

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

protected

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

Definition at line 569 of file WaveClip.cpp.

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

References Envelope::CollapseRegion(), Sequence::Delete(), GetEnvelope(), GetRate(), GetSequence(), GetSequenceEndTime(), GetSequenceStartTime(), MarkChanged(), mCutLines, min(), Offset(), and TimeToSequenceSamples().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CloseLock()

void WaveClip::CloseLock ( )

Definition at line 755 of file WaveClip.cpp.

{
   GetSequence()->CloseLock();
   for (const auto &cutline: mCutLines)
      cutline->CloseLock();
}

References Sequence::CloseLock(), GetSequence(), and mCutLines.

Here is the call graph for this function:

◆ ConvertToSampleFormat()

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

Definition at line 194 of file WaveClip.cpp.

{
   // Note:  it is not necessary to do this recursively to cutlines.
   // They get converted as needed when they are expanded.
 
   auto bChanged = mSequence->ConvertToSampleFormat(format, progressReport);
   if (bChanged)
      MarkChanged();
}

References format, MarkChanged(), and mSequence.

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 697 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);
 
      Paste(GetSequenceStartTime()+cutline->GetSequenceStartTime(), cutline);
      // Now erase the cutline,
      // but be careful to find it again, because Paste above may
      // have modified the array of cutlines (if our cutline contained
      // another cutline!), invalidating the iterator we had.
      end = mCutLines.end();
      it = std::find_if(mCutLines.begin(), end,
         [=](const WaveClipHolder &p) { return p.get() == cutline; });
      if (it != end)
         mCutLines.erase(it); // deletes cutline!
      else {
         wxASSERT(false);
      }
   }
}

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

Here is the call graph for this function:

◆ FindCutLine()

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

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

Definition at line 677 of file WaveClip.cpp.

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

References GetSequenceStartTime(), and mCutLines.

Here is the call graph for this function:

◆ Flush()

void WaveClip::Flush ( )

Flush must be called after last Append.

Exception safety guarantee:: Mixed

Exception safety guarantee:: No-fail – The clip will be in a flushed state.

Exception safety guarantee:: Partial – Some initial portion (maybe none) of the append buffer of the clip gets appended; no previously flushed contents are lost.

Definition at line 290 of file WaveClip.cpp.

{
   //wxLogDebug(wxT("WaveClip::Flush"));
   //wxLogDebug(wxT("   mAppendBufferLen=%lli"), (long long) mAppendBufferLen);
   //wxLogDebug(wxT("   previous sample count %lli"), (long long) mSequence->GetNumSamples());
 
   if (mAppendBufferLen > 0) {
 
      auto cleanup = finally( [&] {
         // Blow away the append buffer even in case of failure.  May lose some
         // data but don't leave the track in an un-flushed state.
 
         // Use No-fail-guarantee of these steps.
         mAppendBufferLen = 0;
         UpdateEnvelopeTrackLen();
         MarkChanged();
      } );
 
      mSequence->Append(mAppendBuffer.ptr(), mSequence->GetSampleFormat(),
         mAppendBufferLen);
   }
 
   //wxLogDebug(wxT("now sample count %lli"), (long long) mSequence->GetNumSamples());
}

References mAppendBuffer, mAppendBufferLen, MarkChanged(), mSequence, SampleBuffer::ptr(), and UpdateEnvelopeTrackLen().

Referenced by WaveTrack::Flush().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAppendBuffer()

const SampleBuffer & WaveClip::GetAppendBuffer ( ) const

inline

Definition at line 327 of file WaveClip.h.

327{ return mAppendBuffer; }

Referenced by WaveClipWaveformCache::GetWaveDisplay().

Here is the caller graph for this function:

◆ GetAppendBufferLen()

size_t WaveClip::GetAppendBufferLen ( ) const

inline

Definition at line 328 of file WaveClip.h.

328{ return mAppendBufferLen; }

Referenced by WaveClipWaveformCache::GetWaveDisplay().

Here is the caller graph for this function:

◆ GetColourIndex()

int WaveClip::GetColourIndex ( ) const

inline

Definition at line 149 of file WaveClip.h.

149{ return mColourIndex;};

Referenced by anonymous_namespace{WaveformView.cpp}::DrawClipWaveform().

Here is the caller graph for this function:

◆ GetCutLines() [1/2]

WaveClipHolders & WaveClip::GetCutLines ( )

inline

Get access to cut lines list.

Definition at line 276 of file WaveClip.h.

276{ return mCutLines; }

◆ GetCutLines() [2/2]

const WaveClipConstHolders & WaveClip::GetCutLines ( ) const

inline

Definition at line 277 of file WaveClip.h.

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

WaveClipConstHolders

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

Definition: WaveClip.h:43

◆ GetEnvelope() [1/2]

Envelope * WaveClip::GetEnvelope ( )

inline

Definition at line 205 of file WaveClip.h.

205{ return mEnvelope.get(); }

Referenced by SetEnvelopeCommand::ApplyInner(), ClearAndAddCutLine(), ClearSequence(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), WaveTrack::GetEnvelopeAtTime(), AUPImportFileHandle::HandleEnvelope(), WaveTrack::HandleXMLChild(), and InsertSilence().

Here is the caller graph for this function:

◆ GetEnvelope() [2/2]

const Envelope * WaveClip::GetEnvelope ( ) const

inline

Definition at line 206 of file WaveClip.h.

206{ return mEnvelope.get(); }

◆ GetIsPlaceholder()

bool WaveClip::GetIsPlaceholder ( ) const

inline

Definition at line 312 of file WaveClip.h.

312{ return mIsPlaceholder; }

Referenced by WaveClip().

Here is the caller graph for this function:

◆ GetMinMax()

std::pair< float, float > WaveClip::GetMinMax	(	double	t0,
		double	t1,
		bool	mayThrow = `true`
	)		const

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

Definition at line 156 of file WaveClip.cpp.

{
   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 mSequence->GetMinMax(s0, s1-s0, mayThrow);
}

References mSequence, THROW_INCONSISTENCY_EXCEPTION, and TimeToSequenceSamples().

Here is the call graph for this function:

◆ GetName()

const wxString & WaveClip::GetName ( ) const

Definition at line 872 of file WaveClip.cpp.

{
   return mName;
}

References mName.

◆ GetPlayEndSample()

sampleCount WaveClip::GetPlayEndSample ( ) const

Definition at line 925 of file WaveClip.cpp.

{
    return GetPlayStartSample() + GetPlaySamplesCount();
}

References GetPlaySamplesCount(), and GetPlayStartSample().

Referenced by AfterPlayEndTime(), EffectReverse::ProcessOneWave(), and WithinPlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlayEndTime()

double WaveClip::GetPlayEndTime ( ) const

Definition at line 908 of file WaveClip.cpp.

{
    auto numSamples = mSequence->GetNumSamples();
 
    double maxLen = GetSequenceStartTime() + ((numSamples + mAppendBufferLen).as_double()) / mRate 
       - SamplesToTime(TimeToSamples(mTrimRight));
    // JS: calculated value is not the length;
    // it is a maximum value and can be negative; no clipping to 0
 
    return maxLen;
}

References GetSequenceStartTime(), mAppendBufferLen, mRate, mSequence, mTrimRight, SamplesToTime(), and TimeToSamples().

Referenced by AUPImportFileHandle::AddSilence(), AppendSilence(), SetClipCommand::ApplyInner(), SetEnvelopeCommand::ApplyInner(), WaveTrack::CanInsertClip(), Clear(), ClearAndAddCutLine(), WaveTrack::ClearAndPaste(), ClearLeft(), ClearRight(), ClipParameters::ClipParameters(), ClipParameters::GetClipRect(), InsertSilence(), WaveTrackUtils::IsClipSelected(), WaveTrack::MergeClips(), Paste(), WaveTrack::PasteWaveTrack(), TrimLeftTo(), WaveTrack::UpdateLocationsCache(), and WaveClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlaySamplesCount()

sampleCount WaveClip::GetPlaySamplesCount ( ) const

Definition at line 930 of file WaveClip.cpp.

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

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

Referenced by anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), GetPlayEndSample(), and SharesBoundaryWithNextClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlayStartSample()

sampleCount WaveClip::GetPlayStartSample ( ) const

Definition at line 920 of file WaveClip.cpp.

{
    return TimeToSamples(GetPlayStartTime());
}

References GetPlayStartTime(), and TimeToSamples().

Referenced by BeforePlayStartTime(), WaveTrack::GetClipAtSample(), GetPlayEndSample(), EffectReverse::ProcessOneWave(), and WithinPlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPlayStartTime()

double WaveClip::GetPlayStartTime ( ) const

noexcept

Definition at line 898 of file WaveClip.cpp.

{
    return mSequenceOffset + SamplesToTime(TimeToSamples(mTrimLeft));
}

References mSequenceOffset, mTrimLeft, SamplesToTime(), and TimeToSamples().

Referenced by SetClipCommand::ApplyInner(), SetEnvelopeCommand::ApplyInner(), WaveTrack::CanInsertClip(), Clear(), ClearAndAddCutLine(), WaveTrack::ClearAndPaste(), ClearLeft(), ClearRight(), ClipParameters::ClipParameters(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), ClipParameters::GetClipRect(), GetPlayStartSample(), InsertSilence(), WaveTrackUtils::IsClipSelected(), Paste(), WaveTrack::PasteWaveTrack(), WaveTrack::RightmostOrNewClip(), SharesBoundaryWithNextClip(), TrimRightTo(), and WaveClip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRate()

int WaveClip::GetRate ( ) const

inline

Definition at line 139 of file WaveClip.h.

139{ return mRate; }

Referenced by ClearAndAddCutLine(), ClearSequence(), ClipParameters::ClipParameters(), anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples(), ClipParameters::GetClipRect(), WaveClipSpectrumCache::GetSpectrogram(), WaveClipWaveformCache::GetWaveDisplay(), InsertSilence(), Paste(), SharesBoundaryWithNextClip(), and UpdateEnvelopeTrackLen().

Here is the caller graph for this function:

◆ GetRMS()

float WaveClip::GetRMS	(	double	t0,
		double	t1,
		bool	mayThrow = `true`
	)		const

Definition at line 177 of file WaveClip.cpp.

{
   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 mSequence->GetRMS(s0, s1-s0, mayThrow);
}

References mSequence, THROW_INCONSISTENCY_EXCEPTION, and TimeToSequenceSamples().

Here is the call graph for this function:

◆ GetSamples()

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

Definition at line 124 of file WaveClip.cpp.

{
   return mSequence->Get(buffer, format, start + TimeToSamples(mTrimLeft), len, mayThrow);
}

References format, mSequence, mTrimLeft, and TimeToSamples().

Referenced by anonymous_namespace{WaveformView.cpp}::DrawIndividualSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSequence() [1/2]

Sequence * WaveClip::GetSequence ( )

inline

Definition at line 213 of file WaveClip.h.

213{ return mSequence.get(); }

Referenced by ClearAndAddCutLine(), ClearSequence(), CloseLock(), WaveTrack::GetIdealBlockSize(), WaveTrack::GetSequenceAtTime(), WaveClipWaveformCache::GetWaveDisplay(), AUPImportFileHandle::HandleSequence(), WaveTrack::HandleXMLChild(), InsertSilence(), and SetSilence().

Here is the caller graph for this function:

◆ GetSequence() [2/2]

const Sequence * WaveClip::GetSequence ( ) const

inline

Definition at line 214 of file WaveClip.h.

214{ return mSequence.get(); }

◆ GetSequenceBlockArray() [1/2]

BlockArray * WaveClip::GetSequenceBlockArray ( )

Definition at line 141 of file WaveClip.cpp.

{
   return &mSequence->GetBlockArray();
}

References mSequence.

◆ GetSequenceBlockArray() [2/2]

const BlockArray * WaveClip::GetSequenceBlockArray ( ) const

Definition at line 146 of file WaveClip.cpp.

{
   return &mSequence->GetBlockArray();
}

References mSequence.

◆ GetSequenceEndSample()

sampleCount WaveClip::GetSequenceEndSample ( ) const

Returns the index of the sample next after the last sample of the underlying sequence.

Definition at line 1004 of file WaveClip.cpp.

{
    return GetSequenceStartSample() + mSequence->GetNumSamples();
}

References GetSequenceStartSample(), and mSequence.

Here is the call graph for this function:

◆ GetSequenceEndTime()

double WaveClip::GetSequenceEndTime ( ) const

Definition at line 988 of file WaveClip.cpp.

{
    auto numSamples = mSequence->GetNumSamples();
 
    double maxLen = GetSequenceStartTime() + (numSamples + mAppendBufferLen).as_double() / mRate;
    // JS: calculated value is not the length;
    // it is a maximum value and can be negative; no clipping to 0
 
    return maxLen;
}

References GetSequenceStartTime(), mAppendBufferLen, mRate, and mSequence.

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

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 underlying sequence (not counting the cutlines)

Definition at line 893 of file WaveClip.cpp.

{
    return mSequence->GetNumSamples();
}

References mSequence.

Referenced by WaveClipSpectrumCache::GetSpectrogram().

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

{
    return TimeToSamples(mSequenceOffset);
}

References mSequenceOffset, and TimeToSamples().

Referenced by GetSequenceEndSample(), and ToSequenceSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSequenceStartTime()

double WaveClip::GetSequenceStartTime ( ) const

noexcept

Definition at line 976 of file WaveClip.cpp.

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

References mSequenceOffset.

Referenced by Clear(), ClearAndAddCutLine(), WaveTrack::ClearAndPaste(), ClearLeft(), ClearSequence(), ExpandCutLine(), FindCutLine(), GetPlayEndTime(), GetSequenceEndTime(), WaveClipSpectrumCache::GetSpectrogram(), InsertSilence(), OffsetCutLines(), Paste(), RemoveCutLine(), TimeToSequenceSamples(), TrimLeftTo(), WaveTrack::UpdateLocationsCache(), and WaveClip().

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

{
    return mTrimLeft;
}

References mTrimLeft.

Referenced by Clear(), WaveTrack::ClearAndPaste(), WaveClipSpectrumCache::GetSpectrogram(), WaveClipWaveformCache::GetWaveDisplay(), Paste(), and SetSilence().

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

{
    return mTrimRight;
}

References mTrimRight.

Referenced by WaveTrack::ClearAndPaste(), WaveClipSpectrumCache::GetSpectrogram(), and Paste().

Here is the caller graph for this function:

◆ HandleXMLChild()

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

overridevirtual

Implements XMLTagHandler.

Definition at line 368 of file WaveClip.cpp.

{
   if (tag == "sequence")
      return mSequence.get();
   else if (tag == "envelope")
      return mEnvelope.get();
   else if (tag == "waveclip")
   {
      // Nested wave clips are cut lines
      mCutLines.push_back(
         std::make_unique<WaveClip>(mSequence->GetFactory(),
            mSequence->GetSampleFormat(), mRate, 0 /*colourindex*/));
      return mCutLines.back().get();
   }
   else
      return NULL;
}

References mCutLines, mEnvelope, mRate, and mSequence.

Referenced by AUPImportFileHandle::HandleWaveClip().

Here is the caller graph for this function:

◆ HandleXMLEndTag()

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

override

Definition at line 362 of file WaveClip.cpp.

{
   if (tag == "waveclip")
      UpdateEnvelopeTrackLen();
}

References UpdateEnvelopeTrackLen().

Referenced by WaveTrack::HandleXMLEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleXMLTag()

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

overridevirtual

Implements XMLTagHandler.

Definition at line 315 of file WaveClip.cpp.

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

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

Here is the call graph for this function:

◆ InsertSilence()

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

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

Exception safety guarantee:: Strong

Definition at line 481 of file WaveClip.cpp.

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

References ClearSequence(), GetEnvelope(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSequence(), GetSequenceEndTime(), GetSequenceStartTime(), Sequence::InsertSilence(), MarkChanged(), mRate, OffsetCutLines(), SetTrimRight(), and TimeToSequenceSamples().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MarkChanged()

void WaveClip::MarkChanged ( )

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

Exception safety guarantee:: No-fail

Definition at line 151 of file WaveClip.cpp.

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

References WaveClipListener::MarkChanged().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NumCutLines()

size_t WaveClip::NumCutLines ( ) const

inline

Definition at line 279 of file WaveClip.h.

279{ return mCutLines.size(); }

Referenced by WaveTrack::UpdateLocationsCache().

Here is the caller graph for this function:

◆ Offset()

void WaveClip::Offset ( double delta )

noexcept

Exception safety guarantee:: No-fail

Definition at line 1009 of file WaveClip.cpp.

{
    SetSequenceStartTime(GetSequenceStartTime() + delta);
}

Referenced by Clear(), ClearAndAddCutLine(), WaveTrack::ClearAndPaste(), ClearSequence(), and WaveTrack::Copy().

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

{
   for (const auto &cutLine : mCutLines)
   {
      if (GetSequenceStartTime() + cutLine->GetSequenceStartTime() >= t0)
         cutLine->Offset(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:

◆ operator=()

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

private

◆ Paste()

void WaveClip::Paste	(	double	t0,
		const WaveClip *	other
	)

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

Exception safety guarantee:: Strong

Definition at line 406 of file WaveClip.cpp.

{
   const bool clipNeedsResampling = other->mRate != mRate;
   const bool clipNeedsNewFormat =
      other->mSequence->GetSampleFormat() != mSequence->GetSampleFormat();
   std::unique_ptr<WaveClip> newClip;
 
   t0 = std::clamp(t0, GetPlayStartTime(), GetPlayEndTime());
 
   //seems like edge cases cannot happen, see WaveTrack::PasteWaveTrack
   if (t0 == GetPlayStartTime())
   {
       ClearSequence(GetSequenceStartTime(), t0);
       SetTrimLeft(other->GetTrimLeft());
 
       auto copy = std::make_unique<WaveClip>(*other, mSequence->GetFactory(), true);
       copy->ClearSequence(copy->GetPlayEndTime(), copy->GetSequenceEndTime());
       newClip = std::move(copy);
   }
   else if (t0 == GetPlayEndTime())
   {
       ClearSequence(GetPlayEndTime(), GetSequenceEndTime());
       SetTrimRight(other->GetTrimRight());
 
       auto copy = std::make_unique<WaveClip>(*other, mSequence->GetFactory(), true);
       copy->ClearSequence(copy->GetSequenceStartTime(), copy->GetPlayStartTime());
       newClip = std::move(copy);
   }
   else
   {
       newClip = std::make_unique<WaveClip>(*other, mSequence->GetFactory(), true,
           other->GetPlayStartTime(), other->GetPlayEndTime());
   }
 
   if (clipNeedsResampling || clipNeedsNewFormat)
   {
      auto copy = std::make_unique<WaveClip>(*newClip.get(), mSequence->GetFactory(), 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(mSequence->GetSampleFormat());
      newClip = std::move(copy);
   }
 
   // Paste cut lines contained in pasted clip
   WaveClipHolders newCutlines;
   for (const auto &cutline: newClip->mCutLines)
   {
      auto cutlineCopy = std::make_unique<WaveClip>(*cutline, mSequence->GetFactory(), 
         // Recursively copy cutlines of cutlines.  They don't need
         // their offsets adjusted.
         true);
      cutlineCopy->Offset(t0 - GetSequenceStartTime());
      newCutlines.push_back(std::move(cutlineCopy));
   }
 
   sampleCount s0 = TimeToSequenceSamples(t0);
 
   // Assume Strong-guarantee from Sequence::Paste
   mSequence->Paste(s0, newClip->mSequence.get());
 
   // Assume No-fail-guarantee in the remaining
   MarkChanged();
   auto sampleTime = 1.0 / GetRate();
   mEnvelope->PasteEnvelope
      (s0.as_double()/mRate + GetSequenceStartTime(), newClip->mEnvelope.get(), sampleTime);
   OffsetCutLines(t0, newClip->GetPlayEndTime() - newClip->GetPlayStartTime());
 
   for (auto &holder : newCutlines)
      mCutLines.push_back(std::move(holder));
}

References sampleCount::as_double(), ClearSequence(), GetPlayEndTime(), GetPlayStartTime(), GetRate(), GetSequenceEndTime(), GetSequenceStartTime(), GetTrimLeft(), GetTrimRight(), MarkChanged(), mCutLines, mEnvelope, mRate, mSequence, OffsetCutLines(), SetTrimLeft(), SetTrimRight(), and TimeToSequenceSamples().

Referenced by WaveTrack::ClearAndPaste(), ExpandCutLine(), WaveTrack::MergeClips(), and WaveTrack::PasteWaveTrack().

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

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

References GetSequenceStartTime(), and mCutLines.

Here is the call graph for this function:

◆ Resample()

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

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

{
   // Note:  it is not necessary to do this recursively to cutlines.
   // They get resampled as needed when they are expanded.
 
   if (rate == mRate)
      return; // Nothing to do
 
   double factor = (double)rate / (double)mRate;
   ::Resample resample(true, factor, factor); // constant rate resampling
 
   const size_t bufsize = 65536;
   Floats inBuffer{ bufsize };
   Floats outBuffer{ bufsize };
   sampleCount pos = 0;
   bool error = false;
   int outGenerated = 0;
   auto numSamples = mSequence->GetNumSamples();
 
   auto newSequence =
      std::make_unique<Sequence>(mSequence->GetFactory(), mSequence->GetSampleFormat());
 
   while (pos < numSamples || outGenerated > 0)
   {
      const auto inLen = limitSampleBufferSize( bufsize, numSamples - pos );
 
      bool isLast = ((pos + inLen) == numSamples);
 
      if (!mSequence->Get((samplePtr)inBuffer.get(), floatSample, pos, inLen, true))
      {
         error = true;
         break;
      }
 
      const auto results = resample.Process(factor, inBuffer.get(), inLen, isLast,
                                            outBuffer.get(), bufsize);
      outGenerated = results.second;
 
      pos += results.first;
 
      if (outGenerated < 0)
      {
         error = true;
         break;
      }
 
      newSequence->Append((samplePtr)outBuffer.get(), floatSample,
                          outGenerated);
 
      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
      mSequence = std::move(newSequence);
      mRate = rate;
      Caches::ForEach( std::mem_fn( &WaveClipListener::Invalidate ) );
   }
}

References floatSample, Internal, WaveClipListener::Invalidate(), limitSampleBufferSize(), mRate, mSequence, BasicUI::ProgressDialog::Poll(), Resample::Process(), BasicUI::Success, and XO.

Here is the call graph for this function:

◆ SamplesToTime()

double WaveClip::SamplesToTime ( sampleCount s ) const

noexcept

Definition at line 882 of file WaveClip.cpp.

{
    return s.as_double() / mRate;
}

Referenced by GetPlayEndTime(), and GetPlayStartTime().

Here is the caller graph for this function:

◆ SetColourIndex()

void WaveClip::SetColourIndex ( int index )

inline

Definition at line 148 of file WaveClip.h.

148{ mColourIndex = index;};

Referenced by SetClipCommand::ApplyInner(), and HandleXMLTag().

Here is the caller graph for this function:

◆ SetIsPlaceholder()

void WaveClip::SetIsPlaceholder ( bool val )

inline

Definition at line 313 of file WaveClip.h.

313{ mIsPlaceholder = val; }

◆ SetName()

void WaveClip::SetName ( const wxString & name )

Definition at line 867 of file WaveClip.cpp.

{
   mName = name;
}

References mName, and name.

Referenced by SetClipCommand::ApplyInner(), and HandleXMLTag().

Here is the caller graph for this function:

◆ SetPlayStartTime()

void WaveClip::SetPlayStartTime ( double time )

Definition at line 903 of file WaveClip.cpp.

{
    SetSequenceStartTime(time - mTrimLeft);
}

References mTrimLeft, and SetSequenceStartTime().

Referenced by SetClipCommand::ApplyInner().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetRate()

void WaveClip::SetRate ( int rate )

Definition at line 762 of file WaveClip.cpp.

{
   mRate = rate;
   auto newLength = mSequence->GetNumSamples().as_double() / mRate;
   mEnvelope->RescaleTimes( newLength );
   MarkChanged();
}

References MarkChanged(), mEnvelope, mRate, and mSequence.

Here is the call graph for this function:

◆ SetSamples()

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

Exception safety guarantee:: Strong

Definition at line 131 of file WaveClip.cpp.

{
   // use Strong-guarantee
   mSequence->SetSamples(buffer, format, start + TimeToSamples(mTrimLeft), len);
 
   // use No-fail-guarantee
   MarkChanged();
}

References format, MarkChanged(), mSequence, mTrimLeft, and TimeToSamples().

Here is the call graph for this function:

◆ SetSequenceStartTime()

void WaveClip::SetSequenceStartTime ( double startTime )

Definition at line 982 of file WaveClip.cpp.

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

References mEnvelope, and mSequenceOffset.

Referenced by WaveTrack::ClearAndPaste(), ClearLeft(), WaveTrack::HandleXMLChild(), HandleXMLTag(), and SetPlayStartTime().

Here is the caller graph for this function:

◆ SetSilence()

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

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

Definition at line 887 of file WaveClip.cpp.

{
    GetSequence()->SetSilence(TimeToSamples(GetTrimLeft()) + offset, length);
    MarkChanged();
}

References GetSequence(), GetTrimLeft(), MarkChanged(), Sequence::SetSilence(), 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 936 of file WaveClip.cpp.

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

References mTrimLeft.

Referenced by Clear(), WaveTrack::ClearAndPaste(), ClearLeft(), HandleXMLTag(), and Paste().

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

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

References mTrimRight.

Referenced by Clear(), WaveTrack::ClearAndPaste(), ClearRight(), HandleXMLTag(), InsertSilence(), and Paste().

Here is the caller graph for this function:

◆ SharesBoundaryWithNextClip()

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

Definition at line 857 of file WaveClip.cpp.

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

References sampleCount::as_double(), GetPlaySamplesCount(), GetPlayStartTime(), and GetRate().

Here is the call graph for this function:

◆ TimeToSamples()

sampleCount WaveClip::TimeToSamples ( double time ) const

noexcept

Definition at line 877 of file WaveClip.cpp.

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

Referenced by AfterPlayEndTime(), BeforePlayStartTime(), GetPlayEndTime(), GetPlaySamplesCount(), GetPlayStartSample(), GetPlayStartTime(), GetSamples(), GetSequenceStartSample(), SetSamples(), SetSilence(), TimeToSequenceSamples(), and WithinPlayRegion().

Here is the caller graph for this function:

◆ TimeToSequenceSamples()

sampleCount WaveClip::TimeToSequenceSamples ( double t ) const

Definition at line 1037 of file WaveClip.cpp.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ToSequenceSamples()

sampleCount WaveClip::ToSequenceSamples ( sampleCount s ) const

Definition at line 1046 of file WaveClip.cpp.

{
    return s - GetSequenceStartSample();
}

References GetSequenceStartSample().

Here is the call graph for this function:

◆ TrimLeft()

void WaveClip::TrimLeft ( double deltaTime )

Moves play start position by deltaTime.

Definition at line 956 of file WaveClip.cpp.

{
    mTrimLeft += deltaTime;
}

References mTrimLeft.

◆ TrimLeftTo()

void WaveClip::TrimLeftTo ( double to )

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

Definition at line 966 of file WaveClip.cpp.

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

References GetPlayEndTime(), GetSequenceStartTime(), and mTrimLeft.

Here is the call graph for this function:

◆ TrimRight()

void WaveClip::TrimRight ( double deltaTime )

Moves play end position by deltaTime.

Definition at line 961 of file WaveClip.cpp.

{
    mTrimRight += deltaTime;
}

References mTrimRight.

◆ TrimRightTo()

void WaveClip::TrimRightTo ( double to )

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

Definition at line 971 of file WaveClip.cpp.

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

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

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

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

References GetRate(), mEnvelope, mRate, and mSequence.

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

Definition at line 1019 of file WaveClip.cpp.

{
    auto ts = TimeToSamples(t);
    return ts > GetPlayStartSample() && ts < GetPlayEndSample() + mAppendBufferLen;
}

References GetPlayEndSample(), GetPlayStartSample(), mAppendBufferLen, and TimeToSamples().

Here is the call graph for this function:

◆ WriteXML()

void WaveClip::WriteXML ( XMLWriter & xmlFile ) const

Definition at line 386 of file WaveClip.cpp.

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

Member Data Documentation

◆ mAppendBuffer

SampleBuffer WaveClip::mAppendBuffer {}

protected

Definition at line 347 of file WaveClip.h.

Referenced by Append(), and Flush().

◆ mAppendBufferLen

size_t WaveClip::mAppendBufferLen { 0 }

protected

Definition at line 348 of file WaveClip.h.

Referenced by AfterPlayEndTime(), Append(), Flush(), GetPlayEndTime(), GetSequenceEndTime(), and WithinPlayRegion().

◆ mColourIndex

int WaveClip::mColourIndex

protected

Definition at line 342 of file WaveClip.h.

Referenced by WaveClip().

◆ mCutLines

WaveClipHolders WaveClip::mCutLines {}

protected

Definition at line 352 of file WaveClip.h.

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

◆ mEnvelope

std::unique_ptr<Envelope> WaveClip::mEnvelope

protected

Definition at line 345 of file WaveClip.h.

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

◆ mIsPlaceholder

bool WaveClip::mIsPlaceholder { false }

protected

Definition at line 355 of file WaveClip.h.

Referenced by WaveClip().

◆ mName

wxString WaveClip::mName

private

Definition at line 358 of file WaveClip.h.

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

◆ mRate

int WaveClip::mRate

protected

Definition at line 341 of file WaveClip.h.

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

◆ mSequence

std::unique_ptr<Sequence> WaveClip::mSequence

protected

Definition at line 344 of file WaveClip.h.

Referenced by Append(), AppendNewBlock(), AppendSharedBlock(), ClearAndAddCutLine(), ConvertToSampleFormat(), Flush(), GetMinMax(), GetPlayEndTime(), GetPlaySamplesCount(), GetRMS(), GetSamples(), GetSequenceBlockArray(), GetSequenceEndSample(), GetSequenceEndTime(), GetSequenceSamplesCount(), HandleXMLChild(), Paste(), Resample(), SetRate(), SetSamples(), TimeToSequenceSamples(), UpdateEnvelopeTrackLen(), and WaveClip().

◆ mSequenceOffset

double WaveClip::mSequenceOffset { 0 }

protected

Definition at line 337 of file WaveClip.h.

Referenced by GetPlayStartTime(), GetSequenceStartSample(), GetSequenceStartTime(), SetSequenceStartTime(), and WaveClip().

◆ mTrimLeft

double WaveClip::mTrimLeft { 0 }

protected

Definition at line 338 of file WaveClip.h.

Referenced by GetPlaySamplesCount(), GetPlayStartTime(), GetSamples(), GetTrimLeft(), SetPlayStartTime(), SetSamples(), SetTrimLeft(), TrimLeft(), TrimLeftTo(), and WaveClip().

◆ mTrimRight

double WaveClip::mTrimRight { 0 }

protected

Definition at line 339 of file WaveClip.h.

Referenced by GetPlayEndTime(), GetPlaySamplesCount(), GetTrimRight(), SetTrimRight(), TrimRight(), TrimRightTo(), and WaveClip().

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Caches

Constructor & Destructor Documentation

◆ WaveClip() [1/4]

◆ WaveClip() [2/4]

◆ WaveClip() [3/4]

◆ WaveClip() [4/4]

◆ ~WaveClip()

Member Function Documentation

◆ AfterPlayEndTime()

◆ Append()

◆ AppendNewBlock()

◆ AppendSharedBlock()

◆ AppendSilence()

◆ BeforePlayStartTime()

◆ Clear()

◆ ClearAndAddCutLine()

◆ ClearLeft()

◆ ClearRight()

◆ ClearSequence()

◆ CloseLock()

◆ ConvertToSampleFormat()

◆ ExpandCutLine()

◆ FindCutLine()

◆ Flush()

◆ GetAppendBuffer()

◆ GetAppendBufferLen()

◆ GetColourIndex()

◆ GetCutLines() [1/2]

◆ GetCutLines() [2/2]

◆ GetEnvelope() [1/2]

◆ GetEnvelope() [2/2]

◆ GetIsPlaceholder()

◆ GetMinMax()

◆ GetName()

◆ GetPlayEndSample()

◆ GetPlayEndTime()

◆ GetPlaySamplesCount()

◆ GetPlayStartSample()

◆ GetPlayStartTime()

◆ GetRate()

◆ GetRMS()

◆ GetSamples()

◆ GetSequence() [1/2]

◆ GetSequence() [2/2]

◆ GetSequenceBlockArray() [1/2]

◆ GetSequenceBlockArray() [2/2]

◆ GetSequenceEndSample()

◆ GetSequenceEndTime()

◆ GetSequenceSamplesCount()

◆ GetSequenceStartSample()

◆ GetSequenceStartTime()

◆ GetTrimLeft()

◆ GetTrimRight()

◆ HandleXMLChild()

◆ HandleXMLEndTag()

◆ HandleXMLTag()

◆ InsertSilence()

◆ MarkChanged()

◆ NumCutLines()

◆ Offset()

◆ OffsetCutLines()

◆ operator=()

◆ Paste()

◆ RemoveCutLine()

◆ Resample()

◆ SamplesToTime()

◆ SetColourIndex()

◆ SetIsPlaceholder()

◆ SetName()

◆ SetPlayStartTime()

◆ SetRate()