A WaveTrack contains WaveClip(s). A WaveClip contains a Sequence. A Sequence is primarily an interface to an array of SeqBlock instances, corresponding to the audio sample blocks in the database. Contrast with RingBuffer. More...

#include <Sequence.h>

Inheritance diagram for Sequence:

[legend]

Collaboration diagram for Sequence:

[legend]

Public Member Functions
	Sequence (const SampleBlockFactoryPtr &pFactory, SampleFormats formats)

	Sequence (const Sequence &orig, const SampleBlockFactoryPtr &pFactory)

	Sequence (const Sequence &)=delete

Sequence &	operator= (const Sequence &) PROHIBITED

	~Sequence ()

sampleCount	GetNumSamples () const

bool	Get (samplePtr buffer, sampleFormat format, sampleCount start, size_t len, bool mayThrow) const

void	SetSamples (constSamplePtr buffer, sampleFormat format, sampleCount start, sampleCount len, sampleFormat effectiveFormat)
	Pass nullptr to set silence. More...

std::unique_ptr< Sequence >	Copy (const SampleBlockFactoryPtr &pFactory, sampleCount s0, sampleCount s1) const

void	Paste (sampleCount s0, const Sequence *src)

size_t	GetIdealAppendLen () const

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

void	Flush ()

SeqBlock::SampleBlockPtr	AppendNewBlock (constSamplePtr buffer, sampleFormat format, size_t len)

void	AppendSharedBlock (const SeqBlock::SampleBlockPtr &pBlock)
	Append a complete block, not coalescing. More...

void	Delete (sampleCount start, sampleCount len)

void	SetSilence (sampleCount s0, sampleCount len)

void	InsertSilence (sampleCount s0, sampleCount len)

const SampleBlockFactoryPtr &	GetFactory ()

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

bool	CloseLock ()

SampleFormats	GetSampleFormats () const

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

std::pair< float, float >	GetMinMax (sampleCount start, sampleCount len, bool mayThrow) const

float	GetRMS (sampleCount start, sampleCount len, bool mayThrow) const

sampleCount	GetBlockStart (sampleCount position) const

size_t	GetBestBlockSize (sampleCount start) const

size_t	GetMaxBlockSize () const

size_t	GetIdealBlockSize () const

BlockArray &	GetBlockArray ()

const BlockArray &	GetBlockArray () const

size_t	GetAppendBufferLen () const

constSamplePtr	GetAppendBuffer () const

int	FindBlock (sampleCount pos) const

void	ConsistencyCheck (const wxChar *whereStr, bool mayThrow=true) 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)

Static Public Member Functions
static void	SetMaxDiskBlockSize (size_t bytes)

static size_t	GetMaxDiskBlockSize ()

static bool	IsValidSampleFormat (const int nValue)
	true if nValue is one of the sampleFormat enum values More...

static bool	Read (samplePtr buffer, sampleFormat format, const SeqBlock &b, size_t blockRelativeStart, size_t len, bool mayThrow)

static void	DebugPrintf (const BlockArray &block, sampleCount numSamples, wxString *dest)

Private Member Functions
SeqBlock::SampleBlockPtr	DoAppend (constSamplePtr buffer, sampleFormat format, size_t len, bool coalesce)
	Does not do any dithering. More...

bool	Get (int b, samplePtr buffer, sampleFormat format, sampleCount start, size_t len, bool mayThrow) const

void	CommitChangesIfConsistent (BlockArray &newBlock, sampleCount numSamples, const wxChar *whereStr)

void	AppendBlocksIfConsistent (BlockArray &additionalBlocks, bool replaceLast, sampleCount numSamples, const wxChar *whereStr)

Static Private Member Functions
static void	AppendBlock (SampleBlockFactory *pFactory, sampleFormat format, BlockArray &blocks, sampleCount &numSamples, const SeqBlock &b)

static void	Blockify (SampleBlockFactory &factory, size_t maxSamples, sampleFormat format, BlockArray &list, sampleCount start, constSamplePtr buffer, size_t len)

static void	ConsistencyCheck (const BlockArray &block, size_t maxSamples, size_t from, sampleCount numSamples, const wxChar *whereStr, bool mayThrow=true)

Private Attributes
SampleBlockFactoryPtr	mpFactory

BlockArray	mBlock

SampleFormats	mSampleFormats

sampleCount	mNumSamples { 0 }

size_t	mMinSamples

size_t	mMaxSamples

SampleBuffer	mAppendBuffer {}

size_t	mAppendBufferLen { 0 }

sampleFormat	mAppendEffectiveFormat { narrowestSampleFormat }

bool	mErrorOpening { false }

Static Private Attributes
static size_t	sMaxDiskBlockSize = 1048576

Detailed Description

A WaveTrack contains WaveClip(s). A WaveClip contains a Sequence. A Sequence is primarily an interface to an array of SeqBlock instances, corresponding to the audio sample blocks in the database. Contrast with RingBuffer.

Definition at line 61 of file Sequence.h.

Constructor & Destructor Documentation

◆ Sequence() [1/3]

Sequence::Sequence	(	const SampleBlockFactoryPtr &	pFactory,
		SampleFormats	formats
	)

Definition at line 51 of file Sequence.cpp.

:  mpFactory(pFactory),
   mSampleFormats{ formats },
   mMinSamples(sMaxDiskBlockSize / SAMPLE_SIZE(mSampleFormats.Stored()) / 2),
   mMaxSamples(mMinSamples * 2)
{
}

◆ Sequence() [2/3]

Sequence::Sequence	(	const Sequence &	orig,
		const SampleBlockFactoryPtr &	pFactory
	)

Definition at line 63 of file Sequence.cpp.

:  mpFactory(pFactory),
   mSampleFormats{ orig.mSampleFormats },
   mMinSamples(orig.mMinSamples),
   mMaxSamples(orig.mMaxSamples)
{
   Paste(0, &orig);
}

References Paste().

Here is the call graph for this function:

◆ Sequence() [3/3]

Sequence::Sequence ( const Sequence & )

delete

◆ ~Sequence()

Sequence::~Sequence ( )

Definition at line 73 of file Sequence.cpp.

74{

75}

Member Function Documentation

◆ Append()

bool Sequence::Append	(	constSamplePtr	buffer,
		sampleFormat	format,
		size_t	len,
		size_t	stride,
		sampleFormat	effectiveFormat
	)

Samples may be retained in a memory buffer, pending Flush() If there are exceptions, an unspecified prefix of buffer may be appended

Returns: true if at least one sample block was added

Exception safety guarantee:: Weak

Exception safety guarantee:: Weak

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 1321 of file Sequence.cpp.

{
   effectiveFormat = std::min(effectiveFormat, format);
   const auto seqFormat = mSampleFormats.Stored();
   if (!mAppendBuffer.ptr())
      mAppendBuffer.Allocate(mMaxSamples, seqFormat);
 
   bool result = false;
   auto blockSize = GetIdealAppendLen();
   for(;;) {
      if (mAppendBufferLen >= blockSize) {
         // flush some previously appended contents
         // use Strong-guarantee
         // Already dithered if needed when accumulated into mAppendBuffer
         DoAppend(mAppendBuffer.ptr(), seqFormat, blockSize, true);
         // Change our effective format now that DoAppend didn't throw
         mSampleFormats.UpdateEffective(mAppendEffectiveFormat);
         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 = GetIdealAppendLen();
      }
 
      if (len == 0)
         break;
 
      // use No-fail-guarantee for rest of this "for"
      wxASSERT(mAppendBufferLen <= mMaxSamples);
      auto toCopy = std::min(len, mMaxSamples - mAppendBufferLen);
 
      // If dithering of appended material is done at all, it happens here
      CopySamples(buffer, format,
         mAppendBuffer.ptr() + mAppendBufferLen * SAMPLE_SIZE(seqFormat),
         seqFormat,
         toCopy,
         (seqFormat < effectiveFormat ? gHighQualityDither : DitherType::none),
         stride);
      mAppendEffectiveFormat =
         std::max(mAppendEffectiveFormat, effectiveFormat);
 
      mAppendBufferLen += toCopy;
      buffer += toCopy * SAMPLE_SIZE(format) * stride;
      len -= toCopy;
   }
 
   return result;
}

References SampleBuffer::Allocate(), CopySamples(), DoAppend(), format, GetIdealAppendLen(), gHighQualityDither, mAppendBuffer, mAppendBufferLen, mAppendEffectiveFormat, min(), mMaxSamples, mSampleFormats, none, SampleBuffer::ptr(), SAMPLE_SIZE, SampleFormats::Stored(), and SampleFormats::UpdateEffective().

Here is the call graph for this function:

◆ AppendBlock()

void Sequence::AppendBlock	(	SampleBlockFactory *	pFactory,
		sampleFormat	format,
		BlockArray &	blocks,
		sampleCount &	numSamples,
		const SeqBlock &	b
	)

staticprivate

Definition at line 757 of file Sequence.cpp.

{
   // Quick check to make sure that it doesn't overflow
   if (Overflows((mNumSamples.as_double()) + ((double)b.sb->GetSampleCount())))
      THROW_INCONSISTENCY_EXCEPTION;
 
   auto sb = ShareOrCopySampleBlock( pFactory, format, b.sb );
   SeqBlock newBlock(sb, mNumSamples);
 
   // We can assume newBlock.sb is not null
 
   mBlock.push_back(newBlock);
   mNumSamples += newBlock.sb->GetSampleCount();
 
   // Don't do a consistency check here because this
   // function gets called in an inner loop.
}

References sampleCount::as_double(), format, mBlock, mNumSamples, anonymous_namespace{Sequence.cpp}::Overflows(), SeqBlock::sb, anonymous_namespace{Sequence.cpp}::ShareOrCopySampleBlock(), and THROW_INCONSISTENCY_EXCEPTION.

Referenced by Copy(), and Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AppendBlocksIfConsistent()

void Sequence::AppendBlocksIfConsistent	(	BlockArray &	additionalBlocks,
		bool	replaceLast,
		sampleCount	numSamples,
		const wxChar *	whereStr
	)

private

Definition at line 1767 of file Sequence.cpp.

{
   // Any additional blocks are meant to be appended,
   // replacing the final block if there was one.
 
   if (additionalBlocks.empty())
      return;
 
   bool tmpValid = false;
   SeqBlock tmp;
 
   if ( replaceLast && ! mBlock.empty() ) {
      tmp = mBlock.back(), tmpValid = true;
      mBlock.pop_back();
   }
 
   auto prevSize = mBlock.size();
 
   bool consistent = false;
   auto cleanup = finally( [&] {
      if ( !consistent ) {
         mBlock.resize( prevSize );
         if ( tmpValid )
            mBlock.push_back( tmp );
      }
   } );
 
   std::copy( additionalBlocks.begin(), additionalBlocks.end(),
              std::back_inserter( mBlock ) );
 
   // Check consistency only of the blocks that were added,
   // avoiding quadratic time for repeated checking of repeating appends
   ConsistencyCheck( mBlock, mMaxSamples, prevSize, numSamples, whereStr ); // may throw
 
   // now commit
   // use No-fail-guarantee
 
   mNumSamples = numSamples;
   consistent = true;
}

References ConsistencyCheck(), mBlock, mMaxSamples, and mNumSamples.

Referenced by AppendSharedBlock(), and DoAppend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AppendNewBlock()

SeqBlock::SampleBlockPtr Sequence::AppendNewBlock	(	constSamplePtr	buffer,
		sampleFormat	format,
		size_t	len
	)

Append data, not coalescing blocks, returning a pointer to the new block. No dithering applied.

Exception safety guarantee:: Strong

Exception safety guarantee:: Strong

Definition at line 1286 of file Sequence.cpp.

{
   // Come here only when importing old .aup projects
   auto result = DoAppend( buffer, format, len, false );
   // Change our effective format now that DoAppend didn't throw
   mSampleFormats.UpdateEffective(format);
   return result;
}

References DoAppend(), format, mSampleFormats, and SampleFormats::UpdateEffective().

Here is the call graph for this function:

◆ AppendSharedBlock()

void Sequence::AppendSharedBlock ( const SeqBlock::SampleBlockPtr & pBlock )

Append a complete block, not coalescing.

Exception safety guarantee:: Strong

Definition at line 1297 of file Sequence.cpp.

{
   auto len = pBlock->GetSampleCount();
 
   // Quick check to make sure that it doesn't overflow
   if (Overflows(mNumSamples.as_double() + ((double)len)))
      THROW_INCONSISTENCY_EXCEPTION;
 
   BlockArray newBlock;
   newBlock.emplace_back( pBlock, mNumSamples );
   auto newNumSamples = mNumSamples + len;
 
   AppendBlocksIfConsistent(newBlock, false,
                            newNumSamples, wxT("Append"));
 
// JKC: During generate we use Append again and again.
// If generating a long sequence this test would give O(n^2)
// performance - not good!
#ifdef VERY_SLOW_CHECKING
   ConsistencyCheck(wxT("Append"));
#endif
}

References AppendBlocksIfConsistent(), sampleCount::as_double(), ConsistencyCheck(), mNumSamples, anonymous_namespace{Sequence.cpp}::Overflows(), THROW_INCONSISTENCY_EXCEPTION, and wxT().

Here is the call graph for this function:

◆ Blockify()

void Sequence::Blockify	(	SampleBlockFactory &	factory,
		size_t	maxSamples,
		sampleFormat	format,
		BlockArray &	list,
		sampleCount	start,
		constSamplePtr	buffer,
		size_t	len
	)

staticprivate

Definition at line 1498 of file Sequence.cpp.

{
   if (len <= 0)
      return;
 
   auto num = (len + (mMaxSamples - 1)) / mMaxSamples;
   list.reserve(list.size() + num);
 
   for (decltype(num) i = 0; i < num; i++) {
      SeqBlock b;
 
      const auto offset = i * len / num;
      b.start = start + offset;
      int newLen = ((i + 1) * len / num) - offset;
      auto bufStart = buffer + (offset * SAMPLE_SIZE(mSampleFormat));
 
      b.sb = factory.Create(bufStart, newLen, mSampleFormat);
 
      list.push_back(b);
   }
}

References cloud::factory, mMaxSamples, SAMPLE_SIZE, SeqBlock::sb, and SeqBlock::start.

Referenced by ConvertToSampleFormat(), Delete(), and Paste().

Here is the caller graph for this function:

◆ CloseLock()

bool Sequence::CloseLock ( )

Definition at line 87 of file Sequence.cpp.

{
   for (unsigned int i = 0; i < mBlock.size(); i++)
      mBlock[i].sb->CloseLock();
 
   return true;
}

References mBlock.

Referenced by WaveClip::CloseLock().

Here is the caller graph for this function:

◆ CommitChangesIfConsistent()

void Sequence::CommitChangesIfConsistent	(	BlockArray &	newBlock,
		sampleCount	numSamples,
		const wxChar *	whereStr
	)

private

Definition at line 1755 of file Sequence.cpp.

{
   ConsistencyCheck( newBlock, mMaxSamples, 0, numSamples, whereStr ); // may throw
 
   // now commit
   // use No-fail-guarantee
 
   mBlock.swap(newBlock);
   mNumSamples = numSamples;
}

References ConsistencyCheck(), mBlock, mMaxSamples, and mNumSamples.

Referenced by ConvertToSampleFormat(), Delete(), Paste(), and SetSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConsistencyCheck() [1/2]

static void Sequence::ConsistencyCheck	(	const BlockArray &	block,
		size_t	maxSamples,
		size_t	from,
		sampleCount	numSamples,
		const wxChar *	whereStr,
		bool	mayThrow = `true`
	)

staticprivate

◆ ConsistencyCheck() [2/2]

void Sequence::ConsistencyCheck	(	const wxChar *	whereStr,
		bool	mayThrow = `true`
	)		const

Definition at line 1699 of file Sequence.cpp.

{
   ConsistencyCheck(mBlock, mMaxSamples, 0, mNumSamples, whereStr, mayThrow);
}

References ConsistencyCheck(), mBlock, mMaxSamples, and mNumSamples.

Referenced by AppendBlocksIfConsistent(), AppendSharedBlock(), CommitChangesIfConsistent(), ConsistencyCheck(), Delete(), DoAppend(), and Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConvertToSampleFormat()

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

Returns: whether there was a change

Exception safety guarantee:: Strong

Exception safety guarantee:: Strong

Definition at line 137 of file Sequence.cpp.

{
   if (format == mSampleFormats.Stored())
      // no change
      return false;
 
   if (mBlock.size() == 0)
   {
      // Effective format can be made narrowest when there is no content
      mSampleFormats = { narrowestSampleFormat, format };
      return true;
   }
 
   // Decide the new pair of formats.  If becoming narrower than the effective,
   // this will change the effective.
   SampleFormats newFormats{ mSampleFormats.Effective(), format };
 
   const auto oldFormats = mSampleFormats;
   mSampleFormats = newFormats;
 
   const auto oldMinSamples = mMinSamples, oldMaxSamples = mMaxSamples;
   // These are the same calculations as in the constructor.
   mMinSamples = sMaxDiskBlockSize / SAMPLE_SIZE(mSampleFormats.Stored()) / 2;
   mMaxSamples = mMinSamples * 2;
 
   bool bSuccess = false;
   auto cleanup = finally( [&] {
      if (!bSuccess) {
         // Conversion failed. Revert these member vars.
         mSampleFormats = oldFormats;
         mMaxSamples = oldMaxSamples;
         mMinSamples = oldMinSamples;
      }
   } );
 
   BlockArray newBlockArray;
   // Use the ratio of old to NEW mMaxSamples to make a reasonable guess
   // at allocation.
   newBlockArray.reserve
      (1 + mBlock.size() * ((float)oldMaxSamples / (float)mMaxSamples));
 
   {
      size_t oldSize = oldMaxSamples;
      SampleBuffer bufferOld(oldSize, oldFormats.Stored());
      size_t newSize = oldMaxSamples;
      SampleBuffer bufferNew(newSize, format);
 
      for (size_t i = 0, nn = mBlock.size(); i < nn; i++)
      {
         SeqBlock &oldSeqBlock = mBlock[i];
         const auto &oldBlockFile = oldSeqBlock.sb;
         const auto len = oldBlockFile->GetSampleCount();
         ensureSampleBufferSize(bufferOld, oldFormats.Stored(), oldSize, len);
 
         // Dither won't happen here, reading back the same as-saved format
         Read(bufferOld.ptr(), oldFormats.Stored(), oldSeqBlock, 0, len, true);
 
         ensureSampleBufferSize(bufferNew, format, newSize, len);
 
         CopySamples(
            bufferOld.ptr(), oldFormats.Stored(), bufferNew.ptr(), format, len,
            // Do not dither to reformat samples if format is at least as wide
            // as the old effective (though format might be narrower than the
            // old stored).
            format < oldFormats.Effective()
               ? gHighQualityDither
               : DitherType::none );
 
         // Note this fix for http://bugzilla.audacityteam.org/show_bug.cgi?id=451,
         // using Blockify, allows (len < mMinSamples).
         // This will happen consistently when going from more bytes per sample to fewer...
         // This will create a block that's smaller than mMinSamples, which
         // shouldn't be allowed, but we agreed it's okay for now.
         //vvv ANSWER-ME: Does this cause any bugs, or failures on write, elsewhere?
         //    If so, need to special-case (len < mMinSamples) and start combining data
         //    from the old blocks... Oh no!
 
         // Using Blockify will handle the cases where len > the NEW mMaxSamples. Previous code did not.
         const auto blockstart = oldSeqBlock.start;
         Blockify(*mpFactory, mMaxSamples, format,
                  newBlockArray, blockstart, bufferNew.ptr(), len);
 
         if (progressReport)
            progressReport(len);
      }
   }
 
   // Invalidate all the old, non-aliased block files.
   // Aliased files will be converted at save, per comment above.
 
   // Commit the changes to block file array
   CommitChangesIfConsistent
      (newBlockArray, mNumSamples, wxT("Sequence::ConvertToSampleFormat()"));
 
   // Commit the other changes
   bSuccess = true;
 
   return true;
}

References Blockify(), CommitChangesIfConsistent(), CopySamples(), SampleFormats::Effective(), anonymous_namespace{Sequence.cpp}::ensureSampleBufferSize(), format, gHighQualityDither, mBlock, mMaxSamples, mMinSamples, mNumSamples, mpFactory, mSampleFormats, narrowestSampleFormat, none, SampleBuffer::ptr(), Read(), SAMPLE_SIZE, SeqBlock::sb, sMaxDiskBlockSize, SeqBlock::start, SampleFormats::Stored(), and wxT().

Referenced by AUPImportFileHandle::HandleSequence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Copy()

std::unique_ptr< Sequence > Sequence::Copy	(	const SampleBlockFactoryPtr &	pFactory,
		sampleCount	s0,
		sampleCount	s1
	)		const

Definition at line 389 of file Sequence.cpp.

{
   // Make a new Sequence object for the specified factory:
   auto dest = std::make_unique<Sequence>(pFactory, mSampleFormats);
   if (s0 >= s1 || s0 >= mNumSamples || s1 < 0) {
      return dest;
   }
 
   // Decide whether to share sample blocks or make new copies, when whole block
   // contents are used -- must copy if factories are different:
   auto pUseFactory = (pFactory == mpFactory) ? nullptr : pFactory.get();
 
   int numBlocks = mBlock.size();
 
   int b0 = FindBlock(s0);
   const int b1 = FindBlock(s1 - 1);
   wxASSERT(b0 >= 0);
   wxASSERT(b0 < numBlocks);
   wxASSERT(b1 < numBlocks);
   wxUnusedVar(numBlocks);
   wxASSERT(b0 <= b1);
 
   dest->mBlock.reserve(b1 - b0 + 1);
 
   auto bufferSize = mMaxSamples;
   const auto format = mSampleFormats.Stored();
   SampleBuffer buffer(bufferSize, format);
 
   int blocklen;
 
   // Do any initial partial block
 
   const SeqBlock &block0 = mBlock[b0];
   if (s0 != block0.start) {
      const auto &sb = block0.sb;
      // Nonnegative result is length of block0 or less:
      blocklen =
         ( std::min(s1, block0.start + sb->GetSampleCount()) - s0 ).as_size_t();
      wxASSERT(blocklen <= (int)mMaxSamples); // Vaughan, 2012-02-29
      ensureSampleBufferSize(buffer, format, bufferSize, blocklen);
      Get(b0, buffer.ptr(), format, s0, blocklen, true);
 
      dest->Append(
         buffer.ptr(), format, blocklen, 1, mSampleFormats.Effective());
   }
   else
      --b0;
 
   // If there are blocks in the middle, use the blocks whole
   for (int bb = b0 + 1; bb < b1; ++bb)
      AppendBlock(pUseFactory, format,
         dest->mBlock, dest->mNumSamples, mBlock[bb]);
      // Increase ref count or duplicate file
 
   // Do the last block
   if (b1 > b0) {
      // Probable case of a partial block
      const SeqBlock &block = mBlock[b1];
      const auto &sb = block.sb;
      // s1 is within block:
      blocklen = (s1 - block.start).as_size_t();
      wxASSERT(blocklen <= (int)mMaxSamples); // Vaughan, 2012-02-29
      if (blocklen < (int)sb->GetSampleCount()) {
         ensureSampleBufferSize(buffer, format, bufferSize, blocklen);
         Get(b1, buffer.ptr(), format, block.start, blocklen, true);
         dest->Append(
            buffer.ptr(), format, blocklen, 1, mSampleFormats.Effective());
      }
      else
         // Special case of a whole block
         AppendBlock(pUseFactory, format,
            dest->mBlock, dest->mNumSamples, block);
         // Increase ref count or duplicate file
   }
 
   dest->ConsistencyCheck(wxT("Sequence::Copy()"));
 
   return dest;
}

References AppendBlock(), SampleFormats::Effective(), anonymous_namespace{Sequence.cpp}::ensureSampleBufferSize(), FindBlock(), format, Get(), mBlock, min(), mMaxSamples, mNumSamples, mpFactory, mSampleFormats, SampleBuffer::ptr(), SeqBlock::sb, SeqBlock::start, SampleFormats::Stored(), and wxT().

Here is the call graph for this function:

◆ DebugPrintf()

void Sequence::DebugPrintf	(	const BlockArray &	block,
		sampleCount	numSamples,
		wxString *	dest
	)

static

Definition at line 1810 of file Sequence.cpp.

{
   unsigned int i;
   decltype(mNumSamples) pos = 0;
 
   for (i = 0; i < mBlock.size(); i++) {
      const SeqBlock &seqBlock = mBlock[i];
      *dest += wxString::Format
         (wxT("   Block %3u: start %8lld, len %8lld, refs %ld, id %lld"),
          i,
          seqBlock.start.as_long_long(),
          seqBlock.sb ? (long long) seqBlock.sb->GetSampleCount() : 0,
          seqBlock.sb ? seqBlock.sb.use_count() : 0,
          seqBlock.sb ? (long long) seqBlock.sb->GetBlockID() : 0);
 
      if ((pos != seqBlock.start) || !seqBlock.sb)
         *dest += wxT("      ERROR\n");
      else
         *dest += wxT("\n");
 
      if (seqBlock.sb)
         pos += seqBlock.sb->GetSampleCount();
   }
   if (pos != mNumSamples)
      *dest += wxString::Format
         (wxT("ERROR mNumSamples = %lld\n"), mNumSamples.as_long_long());
}

References sampleCount::as_long_long(), mBlock, mNumSamples, SeqBlock::sb, SeqBlock::start, and wxT().

Here is the call graph for this function:

◆ Delete()

void Sequence::Delete	(	sampleCount	start,
		sampleCount	len
	)

Exception safety guarantee:: Strong

Definition at line 1524 of file Sequence.cpp.

{
   if (len == 0)
      return;
 
   if (len < 0 || start < 0 || start + len > mNumSamples)
      THROW_INCONSISTENCY_EXCEPTION;
 
   auto &factory = *mpFactory;
 
   const unsigned int numBlocks = mBlock.size();
 
   const unsigned int b0 = FindBlock(start);
   unsigned int b1 = FindBlock(start + len - 1);
 
   const auto format = mSampleFormats.Stored();
   auto sampleSize = SAMPLE_SIZE(format);
 
   SeqBlock *pBlock;
   decltype(pBlock->sb->GetSampleCount()) length;
 
   // One buffer for reuse in various branches here
   SampleBuffer scratch;
   // The maximum size that should ever be needed
   auto scratchSize = mMaxSamples + mMinSamples;
 
   // Special case: if the samples to DELETE are all within a single
   // block and the resulting length is not too small, perform the
   // deletion within this block:
   if (b0 == b1 &&
       (length = (pBlock = &mBlock[b0])->sb->GetSampleCount()) - len >= mMinSamples) {
      SeqBlock &b = *pBlock;
      // start is within block
      auto pos = ( start - b.start ).as_size_t();
 
      // Guard against failure of this anyway below with limitSampleBufferSize
      wxASSERT(len < length);
 
      // len must be less than length
      // because start + len - 1 is also in the block...
      auto newLen = ( length - limitSampleBufferSize( length, len ) );
 
      scratch.Allocate(scratchSize, format);
      ensureSampleBufferSize(scratch, format, scratchSize, newLen);
 
      Read(scratch.ptr(), format, b, 0, pos, true);
      Read(scratch.ptr() + (pos * sampleSize), format,
           b,
           // ... and therefore pos + len
           // is not more than the length of the block
           ( pos + len ).as_size_t(), newLen - pos, true);
 
      b.sb = factory.Create(scratch.ptr(), newLen, format);
 
      // Don't make a duplicate array.  We can still give Strong-guarantee
      // if we modify only one block in place.
 
      // use No-fail-guarantee in remaining steps
 
      for (unsigned int j = b0 + 1; j < numBlocks; j++)
         mBlock[j].start -= len;
 
      mNumSamples -= len;
 
      // This consistency check won't throw, it asserts.
      // Proof that we kept consistency is not hard.
      ConsistencyCheck(wxT("Delete - branch one"), false);
      return;
   }
 
   // Create a NEW array of blocks
   BlockArray newBlock;
   newBlock.reserve(numBlocks - (b1 - b0) + 2);
 
   // Copy the blocks before the deletion point over to
   // the NEW array
   newBlock.insert(newBlock.end(), mBlock.begin(), mBlock.begin() + b0);
   unsigned int i;
 
   // First grab the samples in block b0 before the deletion point
   // into preBuffer.  If this is enough samples for its own block,
   // or if this would be the first block in the array, write it out.
   // Otherwise combine it with the previous block (splitting them
   // 50/50 if necessary).
   const SeqBlock &preBlock = mBlock[b0];
   // start is within preBlock
   auto preBufferLen = ( start - preBlock.start ).as_size_t();
   if (preBufferLen) {
      if (preBufferLen >= mMinSamples || b0 == 0) {
         if (!scratch.ptr())
            scratch.Allocate(scratchSize, format);
         ensureSampleBufferSize(scratch, format, scratchSize, preBufferLen);
         Read(scratch.ptr(), format, preBlock, 0, preBufferLen, true);
         auto pFile =
            factory.Create(scratch.ptr(), preBufferLen, format);
 
         newBlock.push_back(SeqBlock(pFile, preBlock.start));
      } else {
         const SeqBlock &prepreBlock = mBlock[b0 - 1];
         const auto prepreLen = prepreBlock.sb->GetSampleCount();
         const auto sum = prepreLen + preBufferLen;
 
         if (!scratch.ptr())
            scratch.Allocate(scratchSize, format);
         ensureSampleBufferSize(scratch, format, scratchSize,
                                sum);
 
         Read(scratch.ptr(), format, prepreBlock, 0, prepreLen, true);
         Read(scratch.ptr() + prepreLen*sampleSize, format,
              preBlock, 0, preBufferLen, true);
 
         newBlock.pop_back();
         Blockify(*mpFactory, mMaxSamples, format,
                  newBlock, prepreBlock.start, scratch.ptr(), sum);
      }
   }
   else {
      // The sample where we begin deletion happens to fall
      // right on the beginning of a block.
   }
 
   // Now, symmetrically, grab the samples in block b1 after the
   // deletion point into postBuffer.  If this is enough samples
   // for its own block, or if this would be the last block in
   // the array, write it out.  Otherwise combine it with the
   // subsequent block (splitting them 50/50 if necessary).
   const SeqBlock &postBlock = mBlock[b1];
   // start + len - 1 lies within postBlock
   const auto postBufferLen = (
       (postBlock.start + postBlock.sb->GetSampleCount()) - (start + len)
   ).as_size_t();
   if (postBufferLen) {
      if (postBufferLen >= mMinSamples || b1 == numBlocks - 1) {
         if (!scratch.ptr())
            // Last use of scratch, can ask for smaller
            scratch.Allocate(postBufferLen, format);
         // start + len - 1 lies within postBlock
         auto pos = (start + len - postBlock.start).as_size_t();
         Read(scratch.ptr(), format, postBlock, pos, postBufferLen, true);
         auto file =
            factory.Create(scratch.ptr(), postBufferLen, format);
 
         newBlock.push_back(SeqBlock(file, start));
      } else {
         SeqBlock &postpostBlock = mBlock[b1 + 1];
         const auto postpostLen = postpostBlock.sb->GetSampleCount();
         const auto sum = postpostLen + postBufferLen;
 
         if (!scratch.ptr())
            // Last use of scratch, can ask for smaller
            scratch.Allocate(sum, format);
         // start + len - 1 lies within postBlock
         auto pos = (start + len - postBlock.start).as_size_t();
         Read(scratch.ptr(), format, postBlock, pos, postBufferLen, true);
         Read(scratch.ptr() + (postBufferLen * sampleSize), format,
              postpostBlock, 0, postpostLen, true);
 
         Blockify(*mpFactory, mMaxSamples, format,
                  newBlock, start, scratch.ptr(), sum);
         b1++;
      }
   }
   else {
      // The sample where we begin deletion happens to fall
      // right on the end of a block.
   }
 
   // Copy the remaining blocks over from the old array
   for (i = b1 + 1; i < numBlocks; i++)
      newBlock.push_back(mBlock[i].Plus(-len));
 
   CommitChangesIfConsistent
      (newBlock, mNumSamples - len, wxT("Delete - branch two"));
}

References SampleBuffer::Allocate(), Blockify(), CommitChangesIfConsistent(), ConsistencyCheck(), anonymous_namespace{Sequence.cpp}::ensureSampleBufferSize(), cloud::factory, FindBlock(), format, limitSampleBufferSize(), mBlock, mMaxSamples, mMinSamples, mNumSamples, mpFactory, mSampleFormats, SampleBuffer::ptr(), Read(), SAMPLE_SIZE, SeqBlock::sb, SeqBlock::start, SampleFormats::Stored(), THROW_INCONSISTENCY_EXCEPTION, and wxT().

Referenced by WaveClip::ClearAndAddCutLine(), and WaveClip::ClearSequence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoAppend()

SeqBlock::SampleBlockPtr Sequence::DoAppend	(	constSamplePtr	buffer,
		sampleFormat	format,
		size_t	len,
		bool	coalesce
	)

private

Does not do any dithering.

Exception safety guarantee:: Strong

Definition at line 1376 of file Sequence.cpp.

{
   SeqBlock::SampleBlockPtr result;
 
   if (len == 0)
      return result;
 
   auto &factory = *mpFactory;
 
   // Quick check to make sure that it doesn't overflow
   if (Overflows(mNumSamples.as_double() + ((double)len)))
      THROW_INCONSISTENCY_EXCEPTION;
 
   BlockArray newBlock;
   sampleCount newNumSamples = mNumSamples;
 
   // If the last block is not full, we need to add samples to it
   int numBlocks = mBlock.size();
   SeqBlock *pLastBlock;
   decltype(pLastBlock->sb->GetSampleCount()) length;
   size_t bufferSize = mMaxSamples;
   const auto dstFormat = mSampleFormats.Stored();
   SampleBuffer buffer2(bufferSize, dstFormat);
   bool replaceLast = false;
   if (coalesce &&
       numBlocks > 0 &&
       (length =
        (pLastBlock = &mBlock.back())->sb->GetSampleCount()) < mMinSamples) {
      // Enlarge a sub-minimum block at the end
      const SeqBlock &lastBlock = *pLastBlock;
      const auto addLen = std::min(mMaxSamples - length, len);
 
      // Reading same format as was saved before causes no dithering
      Read(buffer2.ptr(), dstFormat, lastBlock, 0, length, true);
 
      CopySamples(buffer,
                  format,
                  buffer2.ptr() + length * SAMPLE_SIZE(dstFormat),
                  dstFormat,
                  addLen, DitherType::none);
 
      const auto newLastBlockLen = length + addLen;
      SampleBlockPtr pBlock = factory.Create(
         buffer2.ptr(),
         newLastBlockLen,
         dstFormat);
      SeqBlock newLastBlock(pBlock, lastBlock.start);
 
      newBlock.push_back( newLastBlock );
 
      len -= addLen;
      newNumSamples += addLen;
      buffer += addLen * SAMPLE_SIZE(format);
 
      replaceLast = true;
   }
   // Append the rest as NEW blocks
   while (len) {
      const auto idealSamples = GetIdealBlockSize();
      const auto addedLen = std::min(idealSamples, len);
      SampleBlockPtr pBlock;
      if (format == dstFormat) {
         pBlock = factory.Create(buffer, addedLen, dstFormat);
         // It's expected that when not requesting coalescence, the
         // data should fit in one block
         wxASSERT( coalesce || !result );
         result = pBlock;
      }
      else {
         CopySamples(buffer, format, buffer2.ptr(), dstFormat,
            addedLen, DitherType::none);
         pBlock = factory.Create(buffer2.ptr(), addedLen, dstFormat);
      }
 
      newBlock.push_back(SeqBlock(pBlock, newNumSamples));
 
      buffer += addedLen * SAMPLE_SIZE(format);
      newNumSamples += addedLen;
      len -= addedLen;
   }
 
   AppendBlocksIfConsistent(newBlock, replaceLast,
                            newNumSamples, wxT("Append"));
 
// JKC: During generate we use Append again and again.
// If generating a long sequence this test would give O(n^2)
// performance - not good!
#ifdef VERY_SLOW_CHECKING
   ConsistencyCheck(wxT("Append"));
#endif
 
   return result;
}

References AppendBlocksIfConsistent(), sampleCount::as_double(), ConsistencyCheck(), CopySamples(), cloud::factory, format, GetIdealBlockSize(), mBlock, min(), mMaxSamples, mMinSamples, mNumSamples, mpFactory, mSampleFormats, none, anonymous_namespace{Sequence.cpp}::Overflows(), SampleBuffer::ptr(), Read(), SAMPLE_SIZE, SeqBlock::sb, SeqBlock::start, SampleFormats::Stored(), THROW_INCONSISTENCY_EXCEPTION, and wxT().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindBlock()

int Sequence::FindBlock ( sampleCount pos ) const

Definition at line 1041 of file Sequence.cpp.

{
   wxASSERT(pos >= 0 && pos < mNumSamples);
 
   if (pos == 0)
      return 0;
 
   int numBlocks = mBlock.size();
 
   size_t lo = 0, hi = numBlocks, guess;
   sampleCount loSamples = 0, hiSamples = mNumSamples;
 
   while (true) {
      //this is not a binary search, but a
      //dictionary search where we guess something smarter than the binary division
      //of the unsearched area, since samples are usually proportional to block file number.
      const double frac = (pos - loSamples).as_double() /
         (hiSamples - loSamples).as_double();
      guess = std::min(hi - 1, lo + size_t(frac * (hi - lo)));
      const SeqBlock &block = mBlock[guess];
 
      wxASSERT(block.sb->GetSampleCount() > 0);
      wxASSERT(lo <= guess && guess < hi && lo < hi);
 
      if (pos < block.start) {
         wxASSERT(lo != guess);
         hi = guess;
         hiSamples = block.start;
      }
      else {
         const sampleCount nextStart = block.start + block.sb->GetSampleCount();
         if (pos < nextStart)
            break;
         else {
            wxASSERT(guess < hi - 1);
            lo = guess + 1;
            loSamples = nextStart;
         }
      }
   }
 
   const int rval = guess;
   wxASSERT(rval >= 0 && rval < numBlocks &&
            pos >= mBlock[rval].start &&
            pos < mBlock[rval].start + mBlock[rval].sb->GetSampleCount());
 
   return rval;
}

References mBlock, min(), mNumSamples, SeqBlock::sb, and SeqBlock::start.

Referenced by Copy(), Delete(), Get(), GetBestBlockSize(), GetBlockStart(), GetMinMax(), GetRMS(), GetWaveDisplay(), Paste(), and SetSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Flush()

void Sequence::Flush ( )

Exception safety guarantee:: Mixed

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

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

Definition at line 1476 of file Sequence.cpp.

{
   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 sequence in an un-flushed state.
 
         // Use No-fail-guarantee of these steps.
         mAppendBufferLen = 0;
         mAppendBuffer.Free();
         mAppendEffectiveFormat = narrowestSampleFormat; // defaulted again
      } );
 
      // Already dithered if needed when accumulated into mAppendBuffer:
      DoAppend(mAppendBuffer.ptr(), mSampleFormats.Stored(),
         mAppendBufferLen, true);
      // Change our effective format now that DoAppend didn't throw
      mSampleFormats.UpdateEffective(mAppendEffectiveFormat);
   }
}

References DoAppend(), SampleBuffer::Free(), mAppendBuffer, mAppendBufferLen, mAppendEffectiveFormat, mSampleFormats, narrowestSampleFormat, SampleBuffer::ptr(), SampleFormats::Stored(), and SampleFormats::UpdateEffective().

Here is the call graph for this function:

◆ Get() [1/2]

bool Sequence::Get	(	int	b,
		samplePtr	buffer,
		sampleFormat	format,
		sampleCount	start,
		size_t	len,
		bool	mayThrow
	)		const

private

Definition at line 1130 of file Sequence.cpp.

{
   bool result = true;
   while (len) {
      const SeqBlock &block = mBlock[b];
      // start is in block
      const auto bstart = (start - block.start).as_size_t();
      // bstart is not more than block length
      const auto blen = std::min(len, block.sb->GetSampleCount() - bstart);
 
      if (! Read(buffer, format, block, bstart, blen, mayThrow) )
         result = false;
 
      len -= blen;
      buffer += (blen * SAMPLE_SIZE(format));
      b++;
      start += blen;
   }
   return result;
}

References format, mBlock, min(), Read(), SAMPLE_SIZE, SeqBlock::sb, and SeqBlock::start.

Here is the call graph for this function:

◆ Get() [2/2]

bool Sequence::Get	(	samplePtr	buffer,
		sampleFormat	format,
		sampleCount	start,
		size_t	len,
		bool	mayThrow
	)		const

Definition at line 1112 of file Sequence.cpp.

{
   if (start == mNumSamples) {
      return len == 0;
   }
 
   if (start < 0 || start + len > mNumSamples) {
      if (mayThrow)
         THROW_INCONSISTENCY_EXCEPTION;
      ClearSamples( buffer, floatSample, 0, len );
      return false;
   }
   int b = FindBlock(start);
 
   return Get(b, buffer, format, start, len, mayThrow);
}

References ClearSamples(), FindBlock(), floatSample, format, Get(), mNumSamples, and THROW_INCONSISTENCY_EXCEPTION.

Referenced by Copy(), Get(), and Paste().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAppendBuffer()

constSamplePtr Sequence::GetAppendBuffer ( ) const

inline

Definition at line 221 of file Sequence.h.

221{ return mAppendBuffer.ptr(); }

Referenced by WaveClip::GetAppendBuffer().

Here is the caller graph for this function:

◆ GetAppendBufferLen()

size_t Sequence::GetAppendBufferLen ( ) const

inline

Definition at line 220 of file Sequence.h.

220{ return mAppendBufferLen; }

Referenced by WaveClip::GetAppendBufferLen().

Here is the caller graph for this function:

◆ GetBestBlockSize()

size_t Sequence::GetBestBlockSize ( sampleCount start ) const

Definition at line 782 of file Sequence.cpp.

{
   // This method returns a nice number of samples you should try to grab in
   // one big chunk in order to land on a block boundary, based on the starting
   // sample.  The value returned will always be nonzero and will be no larger
   // than the value of GetMaxBlockSize()
 
   if (start < 0 || start >= mNumSamples)
      return mMaxSamples;
 
   int b = FindBlock(start);
   int numBlocks = mBlock.size();
 
   const SeqBlock &block = mBlock[b];
   // start is in block:
   auto result = (block.start + block.sb->GetSampleCount() - start).as_size_t();
 
   decltype(result) length;
   while(result < mMinSamples && b+1<numBlocks &&
         ((length = mBlock[b+1].sb->GetSampleCount()) + result) <= mMaxSamples) {
      b++;
      result += length;
   }
 
   wxASSERT(result > 0 && result <= mMaxSamples);
 
   return result;
}

References FindBlock(), mBlock, mMaxSamples, mMinSamples, mNumSamples, SeqBlock::sb, and SeqBlock::start.

Here is the call graph for this function:

◆ GetBlockArray() [1/2]

BlockArray & Sequence::GetBlockArray ( )

inline

Definition at line 217 of file Sequence.h.

217{ return mBlock; }

Referenced by GetAllSeqBlocks(), and GetWaveDisplay().

Here is the caller graph for this function:

◆ GetBlockArray() [2/2]

const BlockArray & Sequence::GetBlockArray ( ) const

inline

Definition at line 218 of file Sequence.h.

218{ return mBlock; }

◆ GetBlockStart()

sampleCount Sequence::GetBlockStart ( sampleCount position ) const

Returns: possibly a large or negative value

Definition at line 776 of file Sequence.cpp.

{
   int b = FindBlock(position);
   return mBlock[b].start;
}

References FindBlock(), and mBlock.

Here is the call graph for this function:

◆ GetErrorOpening()

bool Sequence::GetErrorOpening ( )

inline

Definition at line 172 of file Sequence.h.

172{ return mErrorOpening; }

Sequence::mErrorOpening

bool mErrorOpening

Definition: Sequence.h:250

◆ GetFactory()

const SampleBlockFactoryPtr & Sequence::GetFactory ( )

inline

Definition at line 161 of file Sequence.h.

161{ return mpFactory; }

◆ GetIdealAppendLen()

size_t Sequence::GetIdealAppendLen ( ) const

Definition at line 1270 of file Sequence.cpp.

{
   int numBlocks = mBlock.size();
   const auto max = GetMaxBlockSize();
 
   if (numBlocks == 0)
      return max;
 
   const auto lastBlockLen = mBlock.back().sb->GetSampleCount();
   if (lastBlockLen >= max)
      return max;
   else
      return max - lastBlockLen;
}

References GetMaxBlockSize(), and mBlock.

Referenced by Append().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetIdealBlockSize()

size_t Sequence::GetIdealBlockSize ( ) const

Definition at line 82 of file Sequence.cpp.

{
   return mMaxSamples;
}

References mMaxSamples.

Referenced by DoAppend(), WaveTrack::GetIdealBlockSize(), and InsertSilence().

Here is the caller graph for this function:

◆ GetMaxBlockSize()

size_t Sequence::GetMaxBlockSize ( ) const

Definition at line 77 of file Sequence.cpp.

{
   return mMaxSamples;
}

References mMaxSamples.

Referenced by GetIdealAppendLen(), and GetWaveDisplay().

Here is the caller graph for this function:

◆ GetMaxDiskBlockSize()

size_t Sequence::GetMaxDiskBlockSize ( )

static

Definition at line 1845 of file Sequence.cpp.

{
   return sMaxDiskBlockSize;
}

References sMaxDiskBlockSize.

Referenced by BenchmarkDialog::OnRun().

Here is the caller graph for this function:

◆ GetMinMax()

std::pair< float, float > Sequence::GetMinMax	(	sampleCount	start,
		sampleCount	len,
		bool	mayThrow
	)		const

Definition at line 238 of file Sequence.cpp.

{
   if (len == 0 || mBlock.size() == 0) {
      return {
         0.f,
         // FLT_MAX?  So it doesn't look like a spurious '0' to a caller?
 
         0.f
         // -FLT_MAX?  So it doesn't look like a spurious '0' to a caller?
      };
   }
 
   float min = FLT_MAX;
   float max = -FLT_MAX;
 
   unsigned int block0 = FindBlock(start);
   unsigned int block1 = FindBlock(start + len - 1);
 
   // First calculate the min/max of the blocks in the middle of this region;
   // this is very fast because we have the min/max of every entire block
   // already in memory.
 
   for (unsigned b = block0 + 1; b < block1; ++b) {
      auto results = mBlock[b].sb->GetMinMaxRMS(mayThrow);
 
      if (results.min < min)
         min = results.min;
      if (results.max > max)
         max = results.max;
   }
 
   // Now we take the first and last blocks into account, noting that the
   // selection may only partly overlap these blocks.  If the overall min/max
   // of either of these blocks is within min...max, then we can ignore them.
   // If not, we need read some samples and summaries from disk.
   {
      const SeqBlock &theBlock = mBlock[block0];
      const auto &theFile = theBlock.sb;
      auto results = theFile->GetMinMaxRMS(mayThrow);
 
      if (results.min < min || results.max > max) {
         // start lies within theBlock:
         auto s0 = ( start - theBlock.start ).as_size_t();
         const auto maxl0 = (
            // start lies within theBlock:
            theBlock.start + theFile->GetSampleCount() - start
         ).as_size_t();
         wxASSERT(maxl0 <= mMaxSamples); // Vaughan, 2011-10-19
         const auto l0 = limitSampleBufferSize ( maxl0, len );
 
         results = theFile->GetMinMaxRMS(s0, l0, mayThrow);
         if (results.min < min)
            min = results.min;
         if (results.max > max)
            max = results.max;
      }
   }
 
   if (block1 > block0)
   {
      const SeqBlock &theBlock = mBlock[block1];
      const auto &theFile = theBlock.sb;
      auto results = theFile->GetMinMaxRMS(mayThrow);
 
      if (results.min < min || results.max > max) {
 
         // start + len - 1 lies in theBlock:
         const auto l0 = ( start + len - theBlock.start ).as_size_t();
         wxASSERT(l0 <= mMaxSamples); // Vaughan, 2011-10-19
 
         results = theFile->GetMinMaxRMS(0, l0, mayThrow);
         if (results.min < min)
            min = results.min;
         if (results.max > max)
            max = results.max;
      }
   }
 
   return { min, max };
}

References FindBlock(), limitSampleBufferSize(), mBlock, min(), mMaxSamples, SeqBlock::sb, and SeqBlock::start.

Here is the call graph for this function:

◆ GetNumSamples()

sampleCount Sequence::GetNumSamples ( ) const

inline

Definition at line 91 of file Sequence.h.

91{ return mNumSamples; }

Referenced by GetWaveDisplay(), and WaveClipWaveformCache::GetWaveDisplay().

Here is the caller graph for this function:

◆ GetRMS()

float Sequence::GetRMS	(	sampleCount	start,
		sampleCount	len,
		bool	mayThrow
	)		const

Definition at line 320 of file Sequence.cpp.

{
   // len is the number of samples that we want the rms of.
   // it may be longer than a block, and the code is carefully set up to handle that.
   if (len == 0 || mBlock.size() == 0)
      return 0.f;
 
   double sumsq = 0.0;
   sampleCount length = 0; // this is the cumulative length of the bits we have the ms of so far, and should end up == len
 
   unsigned int block0 = FindBlock(start);
   unsigned int block1 = FindBlock(start + len - 1);
 
   // First calculate the rms of the blocks in the middle of this region;
   // this is very fast because we have the rms of every entire block
   // already in memory.
   for (unsigned b = block0 + 1; b < block1; b++) {
      const SeqBlock &theBlock = mBlock[b];
      const auto &sb = theBlock.sb;
      auto results = sb->GetMinMaxRMS(mayThrow);
 
      const auto fileLen = sb->GetSampleCount();
      const auto blockRMS = results.RMS;
      sumsq += blockRMS * blockRMS * fileLen;
      length += fileLen;
   }
 
   // Now we take the first and last blocks into account, noting that the
   // selection may only partly overlap these blocks.
   // If not, we need read some samples and summaries from disk.
   {
      const SeqBlock &theBlock = mBlock[block0];
      const auto &sb = theBlock.sb;
      // start lies within theBlock
      auto s0 = ( start - theBlock.start ).as_size_t();
      // start lies within theBlock
      const auto maxl0 =
         (theBlock.start + sb->GetSampleCount() - start).as_size_t();
      wxASSERT(maxl0 <= mMaxSamples); // Vaughan, 2011-10-19
      const auto l0 = limitSampleBufferSize( maxl0, len );
 
      auto results = sb->GetMinMaxRMS(s0, l0, mayThrow);
      const auto partialRMS = results.RMS;
      sumsq += partialRMS * partialRMS * l0;
      length += l0;
   }
 
   if (block1 > block0) {
      const SeqBlock &theBlock = mBlock[block1];
      const auto &sb = theBlock.sb;
 
      // start + len - 1 lies within theBlock
      const auto l0 = ( start + len - theBlock.start ).as_size_t();
      wxASSERT(l0 <= mMaxSamples); // PRL: I think Vaughan missed this
 
      auto results = sb->GetMinMaxRMS(0, l0, mayThrow);
      const auto partialRMS = results.RMS;
      sumsq += partialRMS * partialRMS * l0;
      length += l0;
   }
 
   // PRL: catch bugs like 1320:
   wxASSERT(length == len);
 
   return sqrt(sumsq / length.as_double() );
}

References sampleCount::as_double(), FindBlock(), limitSampleBufferSize(), mBlock, mMaxSamples, SeqBlock::sb, and SeqBlock::start.

Here is the call graph for this function:

◆ GetSampleFormats()

SampleFormats Sequence::GetSampleFormats ( ) const

Definition at line 95 of file Sequence.cpp.

{
   return mSampleFormats;
}

References mSampleFormats.

◆ HandleXMLChild()

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

overridevirtual

Implements XMLTagHandler.

Definition at line 979 of file Sequence.cpp.

{
   if (tag == "waveblock")
   {
      return this;
   }
 
   return nullptr;
}

◆ HandleXMLEndTag()

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

override

Definition at line 937 of file Sequence.cpp.

{
   if (tag != "sequence" != 0)
   {
      return;
   }
 
   // Make sure that the sequence is valid.
 
   // Make sure that start times and lengths are consistent
   sampleCount numSamples = 0;
   for (unsigned b = 0, nn = mBlock.size(); b < nn;  b++)
   {
      SeqBlock &block = mBlock[b];
      if (block.start != numSamples)
      {
         wxLogWarning(
            wxT("Gap detected in project file.\n")
            wxT("   Start (%s) for block file %lld is not one sample past end of previous block (%s).\n")
            wxT("   Moving start so blocks are contiguous."),
            // PRL:  Why bother with Internat when the above is just wxT?
            Internat::ToString(block.start.as_double(), 0),
            block.sb->GetBlockID(),
            Internat::ToString(numSamples.as_double(), 0));
         block.start = numSamples;
         mErrorOpening = true;
      }
      numSamples += block.sb->GetSampleCount();
   }
 
   if (mNumSamples != numSamples)
   {
      wxLogWarning(
         wxT("Gap detected in project file. Correcting sequence sample count from %s to %s."),
         // PRL:  Why bother with Internat when the above is just wxT?
         Internat::ToString(mNumSamples.as_double(), 0),
         Internat::ToString(numSamples.as_double(), 0));
      mNumSamples = numSamples;
      mErrorOpening = true;
   }
}

References sampleCount::as_double(), mBlock, mErrorOpening, mNumSamples, SeqBlock::sb, SeqBlock::start, Internat::ToString(), and wxT().

Here is the call graph for this function:

◆ HandleXMLTag()

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

overridevirtual

Implements XMLTagHandler.

Definition at line 811 of file Sequence.cpp.

{
   auto &factory = *mpFactory;
 
   /* handle waveblock tag and its attributes */
   if (tag == "waveblock")
   {
      SeqBlock wb;
 
      // Give SampleBlock a go at the attributes first
      wb.sb = factory.CreateFromXML(mSampleFormats.Stored(), attrs);
      if (wb.sb == nullptr)
      {
         mErrorOpening = true;
         return false;
      }
 
      // loop through attrs, which is a null-terminated list of attribute-value pairs
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (attr == "start")
         {
            // This attribute is a sample offset, so can be 64bit
            sampleCount::type start;
 
            if (!value.TryGet(start))
            {
               mErrorOpening = true;
               return false;
            }
 
            wb.start = start;
         }
      }
 
      mBlock.push_back(wb);
 
      return true;
   }
 
   /* handle sequence tag and its attributes */
   if (tag == "sequence")
   {
      sampleFormat effective = floatSample, stored = floatSample;
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         long long nValue = 0;
 
         if (attr == "maxsamples")
         {
            // This attribute is a sample count, so can be 64bit
            if (!value.TryGet(nValue))
            {
               mErrorOpening = true;
               return false;
            }
 
            // Dominic, 12/10/2006:
            //    Let's check that maxsamples is >= 1024 and <= 64 * 1024 * 1024
            //    - that's a pretty wide range of reasonable values.
            if ((nValue < 1024) || (nValue > 64 * 1024 * 1024))
            {
               mErrorOpening = true;
               return false;
            }
 
            // nValue is now safe for size_t
            mMaxSamples = nValue;
         }
         else if (attr == "sampleformat")
         {
            // This attribute is a sample format, normal int
            long fValue;
 
            if (!value.TryGet(fValue) || !IsValidSampleFormat(fValue))
            {
               mErrorOpening = true;
               return false;
            }
            stored = static_cast<sampleFormat>( fValue );
         }
         else if (attr == "effectivesampleformat")
         {
            // This attribute is a sample format, normal int
            long fValue;
 
            if (!value.TryGet(fValue) || !IsValidSampleFormat(fValue))
            {
               mErrorOpening = true;
               return false;
            }
            effective = static_cast<sampleFormat>( fValue );
         }
         else if (attr == "numsamples")
         {
            // This attribute is a sample count, so can be 64bit
            if (!value.TryGet(nValue) || (nValue < 0))
            {
               mErrorOpening = true;
               return false;
            }
            mNumSamples = nValue;
         }
      } // for
 
      // Set at least the stored format as it was saved
      mSampleFormats = SampleFormats{ effective, stored };
 
      // Check whether the invariant of SampleFormats changed the value
      if (mSampleFormats.Effective() != effective) {
         mErrorOpening = true;
         return false;
      }
 
      return true;
   }
 
   return false;
}

References SampleFormats::Effective(), cloud::factory, floatSample, IsValidSampleFormat(), mBlock, mErrorOpening, mMaxSamples, mNumSamples, mpFactory, mSampleFormats, SeqBlock::sb, SeqBlock::start, and SampleFormats::Stored().

Here is the call graph for this function:

◆ InsertSilence()

void Sequence::InsertSilence	(	sampleCount	s0,
		sampleCount	len
	)

Exception safety guarantee:: Strong

Definition at line 707 of file Sequence.cpp.

{
   auto &factory = *mpFactory;
 
   // Quick check to make sure that it doesn't overflow
   if (Overflows((mNumSamples.as_double()) + (len.as_double())))
      THROW_INCONSISTENCY_EXCEPTION;
 
   if (len <= 0)
      return;
 
   // Create a NEW track containing as much silence as we
   // need to insert, and then call Paste to do the insertion.
 
   Sequence sTrack{ mpFactory, mSampleFormats };
 
   auto idealSamples = GetIdealBlockSize();
 
   sampleCount pos = 0;
 
   // Could nBlocks overflow a size_t?  Not very likely.  You need perhaps
   // 2 ^ 52 samples which is over 3000 years at 44.1 kHz.
   auto nBlocks = (len + idealSamples - 1) / idealSamples;
   sTrack.mBlock.reserve(nBlocks.as_size_t());
 
   const auto format = mSampleFormats.Stored();
   if (len >= idealSamples) {
      auto silentFile = factory.CreateSilent(
         idealSamples,
         format);
      while (len >= idealSamples) {
         sTrack.mBlock.push_back(SeqBlock(silentFile, pos));
 
         pos += idealSamples;
         len -= idealSamples;
      }
   }
   if (len != 0) {
      // len is not more than idealSamples:
      sTrack.mBlock.push_back(SeqBlock(
         factory.CreateSilent(len.as_size_t(), format), pos));
      pos += len;
   }
 
   sTrack.mNumSamples = pos;
 
   // use Strong-guarantee
   Paste(s0, &sTrack);
}

References sampleCount::as_double(), sampleCount::as_size_t(), cloud::factory, format, GetIdealBlockSize(), mNumSamples, mpFactory, mSampleFormats, anonymous_namespace{Sequence.cpp}::Overflows(), Paste(), SampleFormats::Stored(), and THROW_INCONSISTENCY_EXCEPTION.

Referenced by WaveClip::InsertSilence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsValidSampleFormat()

bool Sequence::IsValidSampleFormat ( const int nValue )

static

true if nValue is one of the sampleFormat enum values

Definition at line 1850 of file Sequence.cpp.

{
   auto nValue = static_cast<sampleFormat>(iValue);
   return (nValue == int16Sample) || (nValue == int24Sample) || (nValue == floatSample);
}

References floatSample, int16Sample, and int24Sample.

Referenced by AUPImportFileHandle::HandleSequence(), HandleXMLTag(), and WaveTrack::HandleXMLTag().

Here is the caller graph for this function:

◆ operator=()

Sequence & Sequence::operator= ( const Sequence & )

◆ Paste()

void Sequence::Paste	(	sampleCount	s,
		const Sequence *	src
	)

Exception safety guarantee:: Strong

Definition at line 494 of file Sequence.cpp.

{
   if ((s < 0) || (s > mNumSamples))
   {
      wxLogError(
         wxT("Sequence::Paste: sampleCount s %s is < 0 or > mNumSamples %s)."),
         // PRL:  Why bother with Internat when the above is just wxT?
         Internat::ToString(s.as_double(), 0),
         Internat::ToString(mNumSamples.as_double(), 0));
      THROW_INCONSISTENCY_EXCEPTION;
   }
 
   // Quick check to make sure that it doesn't overflow
   if (Overflows((mNumSamples.as_double()) + (src->mNumSamples.as_double())))
   {
      wxLogError(
         wxT("Sequence::Paste: mNumSamples %s + src->mNumSamples %s would overflow."),
         // PRL:  Why bother with Internat when the above is just wxT?
         Internat::ToString(mNumSamples.as_double(), 0),
         Internat::ToString(src->mNumSamples.as_double(), 0));
      THROW_INCONSISTENCY_EXCEPTION;
   }
 
   const auto format = mSampleFormats.Stored();
   if (src->mSampleFormats.Stored() != format)
   {
      wxLogError(
         wxT("Sequence::Paste: Sample format to be pasted, %s, does not match destination format, %s."),
         GetSampleFormatStr(src->mSampleFormats.Stored()).Debug(),
         GetSampleFormatStr(format).Debug());
      THROW_INCONSISTENCY_EXCEPTION;
   }
 
   const BlockArray &srcBlock = src->mBlock;
   auto addedLen = src->mNumSamples;
   const unsigned int srcNumBlocks = srcBlock.size();
   auto sampleSize = SAMPLE_SIZE(format);
 
   if (addedLen == 0 || srcNumBlocks == 0)
      return;
 
   const size_t numBlocks = mBlock.size();
 
   // Decide whether to share sample blocks or make new copies, when whole block
   // contents are used -- must copy if factories are different:
   auto pUseFactory =
      (src->mpFactory == mpFactory) ? nullptr : mpFactory.get();
 
   if (numBlocks == 0 ||
       (s == mNumSamples && mBlock.back().sb->GetSampleCount() >= mMinSamples)) {
      // Special case: this track is currently empty, or it's safe to append
      // onto the end because the current last block is longer than the
      // minimum size
 
      // Build and swap a copy so there is a strong exception safety guarantee
      BlockArray newBlock{ mBlock };
      sampleCount samples = mNumSamples;
      for (unsigned int i = 0; i < srcNumBlocks; i++)
         // AppendBlock may throw for limited disk space, if pasting from
         // one project into another.
         AppendBlock(pUseFactory, format,
            newBlock, samples, srcBlock[i]);
 
      CommitChangesIfConsistent
         (newBlock, samples, wxT("Paste branch one"));
      mSampleFormats.UpdateEffective(src->mSampleFormats.Effective());
      return;
   }
 
   const int b = (s == mNumSamples) ? mBlock.size() - 1 : FindBlock(s);
   wxASSERT((b >= 0) && (b < (int)numBlocks));
   SeqBlock *const pBlock = &mBlock[b];
   const auto length = pBlock->sb->GetSampleCount();
   const auto largerBlockLen = addedLen + length;
   // PRL: when insertion point is the first sample of a block,
   // and the following test fails, perhaps we could test
   // whether coalescence with the previous block is possible.
   if (largerBlockLen <= mMaxSamples) {
      // Special case: we can fit all of the NEW samples inside of
      // one block!
 
      SeqBlock &block = *pBlock;
      // largerBlockLen is not more than mMaxSamples...
      SampleBuffer buffer(largerBlockLen.as_size_t(), format);
 
      // ...and addedLen is not more than largerBlockLen
      auto sAddedLen = addedLen.as_size_t();
      // s lies within block:
      auto splitPoint = ( s - block.start ).as_size_t();
      Read(buffer.ptr(), format, block, 0, splitPoint, true);
      src->Get(0, buffer.ptr() + splitPoint*sampleSize,
               format, 0, sAddedLen, true);
      Read(buffer.ptr() + (splitPoint + sAddedLen) * sampleSize,
           format, block,
           splitPoint, length - splitPoint, true);
 
      // largerBlockLen is not more than mMaxSamples...
      block.sb = mpFactory->Create(
         buffer.ptr(),
         largerBlockLen.as_size_t(),
         format);
 
      // Don't make a duplicate array.  We can still give Strong-guarantee
      // if we modify only one block in place.
 
      // use No-fail-guarantee in remaining steps
      for (unsigned int i = b + 1; i < numBlocks; i++)
         mBlock[i].start += addedLen;
 
      mNumSamples += addedLen;
 
      // This consistency check won't throw, it asserts.
      // Proof that we kept consistency is not hard.
      ConsistencyCheck(wxT("Paste branch two"), false);
      mSampleFormats.UpdateEffective(src->mSampleFormats.Effective());
      return;
   }
 
   // Case three: if we are inserting four or fewer blocks,
   // it's simplest to just lump all the data together
   // into one big block along with the split block,
   // then resplit it all
   BlockArray newBlock;
   newBlock.reserve(numBlocks + srcNumBlocks + 2);
   newBlock.insert(newBlock.end(), mBlock.begin(), mBlock.begin() + b);
 
   SeqBlock &splitBlock = mBlock[b];
   auto splitLen = splitBlock.sb->GetSampleCount();
   // s lies within splitBlock
   auto splitPoint = ( s - splitBlock.start ).as_size_t();
 
   unsigned int i;
   if (srcNumBlocks <= 4) {
 
      // addedLen is at most four times maximum block size
      auto sAddedLen = addedLen.as_size_t();
      const auto sum = splitLen + sAddedLen;
 
      SampleBuffer sumBuffer(sum, format);
      Read(sumBuffer.ptr(), format, splitBlock, 0, splitPoint, true);
      src->Get(0, sumBuffer.ptr() + splitPoint * sampleSize,
               format,
               0, sAddedLen, true);
      Read(sumBuffer.ptr() + (splitPoint + sAddedLen) * sampleSize, format,
           splitBlock, splitPoint,
           splitLen - splitPoint, true);
 
      Blockify(*mpFactory, mMaxSamples, format,
               newBlock, splitBlock.start, sumBuffer.ptr(), sum);
   } else {
 
      // The final case is that we're inserting at least five blocks.
      // We divide these into three groups: the first two get merged
      // with the first half of the split block, the middle ones get
      // used whole, and the last two get merged with the last
      // half of the split block.
 
      const auto srcFirstTwoLen =
          srcBlock[0].sb->GetSampleCount() + srcBlock[1].sb->GetSampleCount();
      const auto leftLen = splitPoint + srcFirstTwoLen;
 
      const SeqBlock &penultimate = srcBlock[srcNumBlocks - 2];
      const auto srcLastTwoLen =
         penultimate.sb->GetSampleCount() +
         srcBlock[srcNumBlocks - 1].sb->GetSampleCount();
      const auto rightSplit = splitBlock.sb->GetSampleCount() - splitPoint;
      const auto rightLen = rightSplit + srcLastTwoLen;
 
      SampleBuffer sampleBuffer(std::max(leftLen, rightLen), format);
 
      Read(sampleBuffer.ptr(), format, splitBlock, 0, splitPoint, true);
      src->Get(0, sampleBuffer.ptr() + splitPoint*sampleSize,
               format, 0, srcFirstTwoLen, true);
 
      Blockify(*mpFactory, mMaxSamples, format,
               newBlock, splitBlock.start, sampleBuffer.ptr(), leftLen);
 
      for (i = 2; i < srcNumBlocks - 2; i++) {
         const SeqBlock &block = srcBlock[i];
         auto sb = ShareOrCopySampleBlock(
            pUseFactory, format, block.sb );
         newBlock.push_back(SeqBlock(sb, block.start + s));
      }
 
      auto lastStart = penultimate.start;
      src->Get(srcNumBlocks - 2, sampleBuffer.ptr(), format,
               lastStart, srcLastTwoLen, true);
      Read(sampleBuffer.ptr() + srcLastTwoLen * sampleSize, format,
           splitBlock, splitPoint, rightSplit, true);
 
      Blockify(*mpFactory, mMaxSamples, format,
               newBlock, s + lastStart, sampleBuffer.ptr(), rightLen);
   }
 
   // Copy remaining blocks to NEW block array and
   // swap the NEW block array in for the old
   for (i = b + 1; i < numBlocks; i++)
      newBlock.push_back(mBlock[i].Plus(addedLen));
 
   CommitChangesIfConsistent
      (newBlock, mNumSamples + addedLen, wxT("Paste branch three"));
 
   mSampleFormats.UpdateEffective(src->mSampleFormats.Effective());
}

References AppendBlock(), sampleCount::as_double(), Blockify(), CommitChangesIfConsistent(), ConsistencyCheck(), TranslatableString::Debug(), SampleFormats::Effective(), FindBlock(), format, Get(), GetSampleFormatStr(), mBlock, mMaxSamples, mMinSamples, mNumSamples, mpFactory, mSampleFormats, anonymous_namespace{Sequence.cpp}::Overflows(), SampleBuffer::ptr(), Read(), SAMPLE_SIZE, SeqBlock::sb, anonymous_namespace{Sequence.cpp}::ShareOrCopySampleBlock(), SeqBlock::start, SampleFormats::Stored(), THROW_INCONSISTENCY_EXCEPTION, Internat::ToString(), SampleFormats::UpdateEffective(), and wxT().

Referenced by InsertSilence(), and Sequence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Read()

bool Sequence::Read	(	samplePtr	buffer,
		sampleFormat	format,
		const SeqBlock &	b,
		size_t	blockRelativeStart,
		size_t	len,
		bool	mayThrow
	)

static

Definition at line 1091 of file Sequence.cpp.

{
   const auto &sb = b.sb;
 
   wxASSERT(blockRelativeStart + len <= sb->GetSampleCount());
 
   // Either throws, or of !mayThrow, tells how many were really read
   auto result = sb->GetSamples(buffer, format, blockRelativeStart, len, mayThrow);
 
   if (result != len)
   {
      wxLogWarning(wxT("Expected to read %ld samples, got %ld samples."),
                   len, result);
      return false;
   }
 
   return true;
}

References format, SeqBlock::sb, and wxT().

Referenced by ConvertToSampleFormat(), Delete(), DoAppend(), Get(), GetWaveDisplay(), Paste(), and SetSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMaxDiskBlockSize()

void Sequence::SetMaxDiskBlockSize ( size_t bytes )

static

Definition at line 1840 of file Sequence.cpp.

{
   sMaxDiskBlockSize = bytes;
}

References sMaxDiskBlockSize.

Referenced by AudacityApp::InitPart2(), and BenchmarkDialog::OnRun().

Here is the caller graph for this function:

◆ SetSamples()

void Sequence::SetSamples	(	constSamplePtr	buffer,
		sampleFormat	format,
		sampleCount	start,
		sampleCount	len,
		sampleFormat	effectiveFormat
	)

Pass nullptr to set silence.

Note that len is not size_t, because nullptr may be passed for buffer, in which case, silence is inserted, possibly a large amount.

Exception safety guarantee:: Strong

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 1154 of file Sequence.cpp.

{
   effectiveFormat = std::min(effectiveFormat, format);
   auto &factory = *mpFactory;
 
   const auto size = mBlock.size();
 
   if (start < 0 || start + len > mNumSamples)
      THROW_INCONSISTENCY_EXCEPTION;
 
   size_t tempSize = mMaxSamples;
   const auto dstFormat = mSampleFormats.Stored();
   // to do:  allocate this only on demand
   SampleBuffer scratch(tempSize, dstFormat);
 
   SampleBuffer temp;
   if (buffer && format != dstFormat) {
      temp.Allocate(tempSize, dstFormat);
   }
 
   int b = FindBlock(start);
   BlockArray newBlock;
   std::copy( mBlock.begin(), mBlock.begin() + b, std::back_inserter(newBlock) );
 
   while (len > 0
      // Redundant termination condition,
      // but it guards against infinite loop in case of inconsistencies
      // (too-small files, not yet seen?)
      // that cause the loop to make no progress because blen == 0
      && b < (int)size
   ) {
      newBlock.push_back( mBlock[b] );
      SeqBlock &block = newBlock.back();
      // start is within block
      const auto bstart = ( start - block.start ).as_size_t();
      const auto fileLength = block.sb->GetSampleCount();
 
      // the std::min is a guard against inconsistent Sequence
      const auto blen =
         limitSampleBufferSize( fileLength - std::min( bstart, fileLength ),
                                len );
      wxASSERT(blen == 0 || bstart + blen <= fileLength);
 
#if 0
      // PRL:  This inconsistency (too-big file) has been seen in "the wild"
      // in 2.2.0.  It is the least problematic kind of inconsistency.
      // We will tolerate it for 2.2.1.
      // Not known whether it is only in projects saved in earlier versions.
      // After 2.2.1, we should detect and correct it at file loading time.
      if (fileLength > mMaxSamples) {
         THROW_INCONSISTENCY_EXCEPTION;
      }
#endif
 
      ensureSampleBufferSize(scratch, dstFormat, tempSize, fileLength,
                             &temp);
 
      auto useBuffer = buffer;
      if (buffer && format != dstFormat)
      {
         // To do: remove the extra movement.
         // Note: we ensured temp can hold fileLength.  blen is not more
         CopySamples(buffer, format, temp.ptr(), dstFormat, blen,
            (dstFormat < effectiveFormat
               ? gHighQualityDither : DitherType::none));
         useBuffer = temp.ptr();
      }
 
      // We don't ever write to an existing block; to support Undo,
      // we copy the old block entirely into memory, dereference it,
      // make the change, and then write the NEW block to disk.
 
      if ( bstart > 0 || blen < fileLength ) {
         // First or last block is only partially overwritten
         Read(scratch.ptr(), dstFormat, block, 0, fileLength, true);
 
         if (useBuffer) {
            auto sampleSize = SAMPLE_SIZE(dstFormat);
            memcpy(scratch.ptr() +
                   bstart * sampleSize, useBuffer, blen * sampleSize);
         }
         else
            ClearSamples(scratch.ptr(), dstFormat, bstart, blen);
 
         block.sb = factory.Create(
            scratch.ptr(),
            fileLength,
            dstFormat);
      }
      else {
         // Avoid reading the disk when the replacement is total
         if (useBuffer)
            block.sb = factory.Create(useBuffer, fileLength, dstFormat);
         else
            block.sb = factory.CreateSilent(fileLength, dstFormat);
      }
 
      // blen might be zero for inconsistent Sequence...
      if( buffer )
         buffer += (blen * SAMPLE_SIZE(format));
 
      len -= blen;
      start += blen;
 
      // ... but this, at least, always guarantees some loop progress:
      b++;
   }
 
   std::copy( mBlock.begin() + b, mBlock.end(), std::back_inserter(newBlock) );
 
   CommitChangesIfConsistent( newBlock, mNumSamples, wxT("SetSamples") );
   
   mSampleFormats.UpdateEffective(effectiveFormat);
}

References SampleBuffer::Allocate(), ClearSamples(), CommitChangesIfConsistent(), CopySamples(), anonymous_namespace{Sequence.cpp}::ensureSampleBufferSize(), cloud::factory, FindBlock(), format, gHighQualityDither, limitSampleBufferSize(), mBlock, min(), mMaxSamples, mNumSamples, mpFactory, mSampleFormats, none, SampleBuffer::ptr(), Read(), SAMPLE_SIZE, SeqBlock::sb, size, SeqBlock::start, SampleFormats::Stored(), THROW_INCONSISTENCY_EXCEPTION, SampleFormats::UpdateEffective(), and wxT().

Referenced by SetSilence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSilence()

void Sequence::SetSilence	(	sampleCount	s0,
		sampleCount	len
	)

Exception safety guarantee:: Strong

Definition at line 700 of file Sequence.cpp.

{
   // Exact zeroes won't need dithering
   SetSamples(nullptr, mSampleFormats.Stored(), s0, len, narrowestSampleFormat);
}

References mSampleFormats, narrowestSampleFormat, SetSamples(), and SampleFormats::Stored().

Referenced by WaveClip::SetSilence().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteXML()

void Sequence::WriteXML ( XMLWriter & xmlFile ) const

Definition at line 990 of file Sequence.cpp.

{
   unsigned int b;
 
   xmlFile.StartTag(wxT("sequence"));
 
   xmlFile.WriteAttr(wxT("maxsamples"), mMaxSamples);
   xmlFile.WriteAttr(wxT("sampleformat"),
      static_cast<size_t>( mSampleFormats.Stored() ) );
   // This attribute was added in 3.0.3:
   xmlFile.WriteAttr( wxT("effectivesampleformat"),
      static_cast<size_t>( mSampleFormats.Effective() ));
   xmlFile.WriteAttr(wxT("numsamples"), mNumSamples.as_long_long() );
 
   for (b = 0; b < mBlock.size(); b++) {
      const SeqBlock &bb = mBlock[b];
 
      // See http://bugzilla.audacityteam.org/show_bug.cgi?id=451.
      if (bb.sb->GetSampleCount() > mMaxSamples)
      {
         // PRL:  Bill observed this error.  Not sure how it was caused.
         // I have added code in ConsistencyCheck that should abort the
         // editing operation that caused this, not fixing
         // the problem but moving the point of detection earlier if we
         // find a reproducible case.
         using namespace BasicUI;
         auto sMsg =
            XO("Sequence has block file exceeding maximum %s samples per block.\nTruncating to this maximum length.")
               .Format( Internat::ToString(((wxLongLong)mMaxSamples).ToDouble(), 0) );
         ShowMessageBox(
            sMsg,
            MessageBoxOptions{}
               .Caption(XO("Warning - Truncating Overlong Block File"))
               .IconStyle(Icon::Warning)
               .ButtonStyle(Button::Ok));
         wxLogWarning(sMsg.Translation()); //Debug?
//         bb.sb->SetLength(mMaxSamples);
      }
 
      xmlFile.StartTag(wxT("waveblock"));
      xmlFile.WriteAttr(wxT("start"), bb.start.as_long_long() );
 
      bb.sb->SaveXML(xmlFile);
 
      xmlFile.EndTag(wxT("waveblock"));
   }
 
   xmlFile.EndTag(wxT("sequence"));
}

References sampleCount::as_long_long(), BasicUI::MessageBoxOptions::Caption(), SeqBlock::sb, BasicUI::ShowMessageBox(), SeqBlock::start, Internat::ToString(), wxT(), and XO().

Here is the call graph for this function:

Member Data Documentation

◆ mAppendBuffer

SampleBuffer Sequence::mAppendBuffer {}

private

Definition at line 246 of file Sequence.h.

Referenced by Append(), and Flush().

◆ mAppendBufferLen

size_t Sequence::mAppendBufferLen { 0 }

private

Definition at line 247 of file Sequence.h.

Referenced by Append(), and Flush().

◆ mAppendEffectiveFormat

sampleFormat Sequence::mAppendEffectiveFormat { narrowestSampleFormat }

private

Definition at line 248 of file Sequence.h.

Referenced by Append(), and Flush().

◆ mBlock

BlockArray Sequence::mBlock

private

Definition at line 237 of file Sequence.h.

Referenced by AppendBlock(), AppendBlocksIfConsistent(), CloseLock(), CommitChangesIfConsistent(), ConsistencyCheck(), ConvertToSampleFormat(), Copy(), DebugPrintf(), Delete(), DoAppend(), FindBlock(), Get(), GetBestBlockSize(), GetBlockStart(), GetIdealAppendLen(), GetMinMax(), GetRMS(), HandleXMLEndTag(), HandleXMLTag(), Paste(), and SetSamples().

◆ mErrorOpening

bool Sequence::mErrorOpening { false }

private

Definition at line 250 of file Sequence.h.

Referenced by HandleXMLEndTag(), and HandleXMLTag().

◆ mMaxSamples

size_t Sequence::mMaxSamples

private

Definition at line 244 of file Sequence.h.

Referenced by Append(), AppendBlocksIfConsistent(), Blockify(), CommitChangesIfConsistent(), ConsistencyCheck(), ConvertToSampleFormat(), Copy(), Delete(), DoAppend(), GetBestBlockSize(), GetIdealBlockSize(), GetMaxBlockSize(), GetMinMax(), GetRMS(), HandleXMLTag(), Paste(), and SetSamples().

◆ mMinSamples

size_t Sequence::mMinSamples

private

Definition at line 243 of file Sequence.h.

Referenced by ConvertToSampleFormat(), Delete(), DoAppend(), GetBestBlockSize(), and Paste().

◆ mNumSamples

sampleCount Sequence::mNumSamples { 0 }

private

Definition at line 241 of file Sequence.h.

Referenced by AppendBlock(), AppendBlocksIfConsistent(), AppendSharedBlock(), CommitChangesIfConsistent(), ConsistencyCheck(), ConvertToSampleFormat(), Copy(), DebugPrintf(), Delete(), DoAppend(), FindBlock(), Get(), GetBestBlockSize(), HandleXMLEndTag(), HandleXMLTag(), InsertSilence(), Paste(), and SetSamples().

◆ mpFactory

SampleBlockFactoryPtr Sequence::mpFactory

private

Definition at line 235 of file Sequence.h.

Referenced by ConvertToSampleFormat(), Copy(), Delete(), DoAppend(), HandleXMLTag(), InsertSilence(), Paste(), and SetSamples().

◆ mSampleFormats

SampleFormats Sequence::mSampleFormats

private

Definition at line 238 of file Sequence.h.

Referenced by Append(), AppendNewBlock(), ConvertToSampleFormat(), Copy(), Delete(), DoAppend(), Flush(), GetSampleFormats(), HandleXMLTag(), InsertSilence(), Paste(), SetSamples(), and SetSilence().

◆ sMaxDiskBlockSize

size_t Sequence::sMaxDiskBlockSize = 1048576

staticprivate

Definition at line 229 of file Sequence.h.

Referenced by ConvertToSampleFormat(), GetMaxDiskBlockSize(), and SetMaxDiskBlockSize().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Sequence() [1/3]

◆ Sequence() [2/3]

◆ Sequence() [3/3]

◆ ~Sequence()

Member Function Documentation

◆ Append()

◆ AppendBlock()

◆ AppendBlocksIfConsistent()

◆ AppendNewBlock()

◆ AppendSharedBlock()

◆ Blockify()

◆ CloseLock()

◆ CommitChangesIfConsistent()

◆ ConsistencyCheck() [1/2]

◆ ConsistencyCheck() [2/2]

◆ ConvertToSampleFormat()

◆ Copy()

◆ DebugPrintf()

◆ Delete()

◆ DoAppend()

◆ FindBlock()

◆ Flush()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAppendBuffer()

◆ GetAppendBufferLen()

◆ GetBestBlockSize()

◆ GetBlockArray() [1/2]

◆ GetBlockArray() [2/2]

◆ GetBlockStart()

◆ GetErrorOpening()

◆ GetFactory()

◆ GetIdealAppendLen()

◆ GetIdealBlockSize()

◆ GetMaxBlockSize()

◆ GetMaxDiskBlockSize()

◆ GetMinMax()

◆ GetNumSamples()

◆ GetRMS()

◆ GetSampleFormats()

◆ HandleXMLChild()

◆ HandleXMLEndTag()

◆ HandleXMLTag()

◆ InsertSilence()

◆ IsValidSampleFormat()

◆ operator=()

◆ Paste()

◆ Read()

◆ SetMaxDiskBlockSize()

◆ SetSamples()

◆ SetSilence()

◆ WriteXML()

Member Data Documentation

◆ mAppendBuffer

◆ mAppendBufferLen

◆ mAppendEffectiveFormat

◆ mBlock

◆ mErrorOpening

◆ mMaxSamples

◆ mMinSamples

◆ mNumSamples

◆ mpFactory

◆ mSampleFormats

◆ sMaxDiskBlockSize