AudioSegmentSampleView Class Reference

#include <AudioSegmentSampleView.h>

Collaboration diagram for AudioSegmentSampleView:

Public Member Functions
	AudioSegmentSampleView (std::vector< BlockSampleView > blockViews, size_t start, size_t length)
	Constructs an AudioSegmentSampleView from BlockSampleViews. More...
	AudioSegmentSampleView (size_t length)
	Constructs a silent AudioSegmentSampleView. More...
void	Copy (float *buffer, size_t bufferSize) const
	Copies up to GetSampleCount() or bufferSize samples, whichever is less, into buffer. Samples after that are zeroed. More...
void	AddTo (float *buffer, size_t bufferSize) const
	Adds up to GetSampleCount() or bufferSize samples, whichever is less, into buffer. Samples after that are left unchanged. More...
size_t	GetSampleCount () const
	The number of samples in this view. More...

Private Member Functions
void	DoCopy (float *buffer, size_t bufferSize) const
void	DoAdd (float *buffer, size_t bufferSize) const

Private Attributes
const std::vector< BlockSampleView >	mBlockViews
const size_t	mStart = 0
const size_t	mLength
const bool	mIsSilent

Detailed Description

Definition at line 25 of file AudioSegmentSampleView.h.

Constructor & Destructor Documentation

AudioSegmentSampleView() [1/2]

AudioSegmentSampleView::AudioSegmentSampleView	(	std::vector< BlockSampleView >	blockViews,
		size_t	start,
		size_t	length
	)

Constructs an AudioSegmentSampleView from BlockSampleViews.

Parameters

blockViews	A continuous sequence of samples, segmented in blocks.
start	Index of the first sample in blockViews to look at.
length	The number of samples from start to look at.

Precondition

!blockViews.empty()

start < blockViews[0].size()

length <= sum(sizes(blockViews)) - start

---

Audacity: A Digital Audio Editor

AudioSegmentSampleView.cpp

Matthieu Hodgkinson

Definition at line 17 of file AudioSegmentSampleView.cpp.

    : mBlockViews { std::move(blockViews) }
    , mStart { start }
    , mLength { length }
    , mIsSilent { false }
{
   assert(
      start + length <=
      std::accumulate(
         mBlockViews.begin(), mBlockViews.end(), 0u,
         [](size_t acc, const auto& block) { return acc + block->size(); }));
}

References mBlockViews.

AudioSegmentSampleView() [2/2]

AudioSegmentSampleView::AudioSegmentSampleView

(

size_t

length

)

Constructs a silent AudioSegmentSampleView.

Parameters

length

The number of "silence samples".

Definition at line 31 of file AudioSegmentSampleView.cpp.

    : mLength { length }
    , mIsSilent { true }
{
}

Member Function Documentation

AddTo()

void AudioSegmentSampleView::AddTo	(	float *	buffer,
		size_t	bufferSize
	)		const

Adds up to GetSampleCount() or bufferSize samples, whichever is less, into buffer. Samples after that are left unchanged.

Definition at line 43 of file AudioSegmentSampleView.cpp.

{
   if (mIsSilent)
      return;
   DoAdd(buffer, bufferSize);
}

References DoAdd(), and mIsSilent.

Here is the call graph for this function:

Copy()

void AudioSegmentSampleView::Copy	(	float *	buffer,
		size_t	bufferSize
	)		const

Copies up to GetSampleCount() or bufferSize samples, whichever is less, into buffer. Samples after that are zeroed.

Definition at line 37 of file AudioSegmentSampleView.cpp.

{
   mIsSilent ? std::fill(buffer, buffer + bufferSize, 0.f) :
               DoCopy(buffer, bufferSize);
}

References DoCopy(), and mIsSilent.

Referenced by ClipTimeAndPitchSource::Pull().

Here is the call graph for this function:

Here is the caller graph for this function:

DoAdd()

void AudioSegmentSampleView::DoAdd ( float *  buffer, size_t  bufferSize  ) const

private

Definition at line 61 of file AudioSegmentSampleView.cpp.

{
   size_t toWrite { limitSampleBufferSize(bufferSize, mLength) };
   size_t written = 0u;
   size_t offset = mStart;
   for (const auto& block : mBlockViews)
   {
      const auto toWriteFromBlock = std::min(block->size() - offset, toWrite);
      const auto src = block->data() + offset;
      const auto dst = buffer + written;
      std::transform(src, src + toWriteFromBlock, dst, dst, std::plus {});
      toWrite -= toWriteFromBlock;
      written += toWriteFromBlock;
      offset = 0;
   }
}

References limitSampleBufferSize(), mBlockViews, min(), mLength, and mStart.

Referenced by AddTo(), and DoCopy().

Here is the call graph for this function:

Here is the caller graph for this function:

DoCopy()

void AudioSegmentSampleView::DoCopy ( float *  buffer, size_t  bufferSize  ) const

private

Definition at line 55 of file AudioSegmentSampleView.cpp.

{
   std::fill(buffer, buffer + bufferSize, 0.f);
   DoAdd(buffer, bufferSize);
}

References DoAdd().

Referenced by Copy().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSampleCount()

size_t AudioSegmentSampleView::GetSampleCount

(

)

const

The number of samples in this view.

Definition at line 50 of file AudioSegmentSampleView.cpp.

{
   return mLength;
}

References mLength.

Member Data Documentation

mBlockViews

const std::vector<BlockSampleView> AudioSegmentSampleView::mBlockViews

private

Definition at line 67 of file AudioSegmentSampleView.h.

Referenced by AudioSegmentSampleView(), and DoAdd().

mIsSilent

const bool AudioSegmentSampleView::mIsSilent

private

Definition at line 70 of file AudioSegmentSampleView.h.

Referenced by AddTo(), and Copy().

mLength

const size_t AudioSegmentSampleView::mLength

private

Definition at line 69 of file AudioSegmentSampleView.h.

Referenced by DoAdd(), and GetSampleCount().

mStart

const size_t AudioSegmentSampleView::mStart = 0

private

Definition at line 68 of file AudioSegmentSampleView.h.

Referenced by DoAdd().

---

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

• AudioSegmentSampleView.h
• AudioSegmentSampleView.cpp