MockSampleBlock Class Reference

#include <MockSampleBlock.h>

Inheritance diagram for MockSampleBlock:

Collaboration diagram for MockSampleBlock:

Public Member Functions
	MockSampleBlock (long long id, constSamplePtr src, size_t numsamples, sampleFormat srcformat)
void	CloseLock () noexcept override
SampleBlockID	GetBlockID () const override
sampleFormat	GetSampleFormat () const override
size_t	GetSampleCount () const override
bool	GetSummary256 (float *dest, size_t frameoffset, size_t numframes) override
	Non-throwing, should fill with zeroes on failure. More...
bool	GetSummary64k (float *dest, size_t frameoffset, size_t numframes) override
	Non-throwing, should fill with zeroes on failure. More...
size_t	GetSpaceUsage () const override
void	SaveXML (XMLWriter &) override
size_t	DoGetSamples (samplePtr dest, sampleFormat destformat, size_t sampleoffset, size_t numsamples) override
MinMaxRMS	DoGetMinMaxRMS (size_t start, size_t len) override
MinMaxRMS	DoGetMinMaxRMS () const override
BlockSampleView	GetFloatSampleView (bool mayThrow) override
Public Member Functions inherited from SampleBlock
virtual	~SampleBlock ()
virtual void	CloseLock () noexcept=0
virtual SampleBlockID	GetBlockID () const =0
size_t	GetSamples (samplePtr dest, sampleFormat destformat, size_t sampleoffset, size_t numsamples, bool mayThrow=true)
virtual BlockSampleView	GetFloatSampleView (bool mayThrow)=0
virtual sampleFormat	GetSampleFormat () const =0
virtual size_t	GetSampleCount () const =0
virtual bool	GetSummary256 (float *dest, size_t frameoffset, size_t numframes)=0
	Non-throwing, should fill with zeroes on failure. More...
virtual bool	GetSummary64k (float *dest, size_t frameoffset, size_t numframes)=0
	Non-throwing, should fill with zeroes on failure. More...
MinMaxRMS	GetMinMaxRMS (size_t start, size_t len, bool mayThrow=true)
	Gets extreme values for the specified region. More...
MinMaxRMS	GetMinMaxRMS (bool mayThrow=true) const
	Gets extreme values for the entire block. More...
virtual size_t	GetSpaceUsage () const =0
virtual void	SaveXML (XMLWriter &xmlFile)=0

Public Attributes
const long long	id
const sampleFormat	srcFormat
const std::vector< char >	data

Additional Inherited Members
virtual size_t	DoGetSamples (samplePtr dest, sampleFormat destformat, size_t sampleoffset, size_t numsamples)=0
virtual MinMaxRMS	DoGetMinMaxRMS (size_t start, size_t len)=0
virtual MinMaxRMS	DoGetMinMaxRMS () const =0

Detailed Description

---

Audacity: A Digital Audio Editor

MockSampleBlock.h

Matthieu Hodgkinson

Definition at line 15 of file MockSampleBlock.h.

Constructor & Destructor Documentation

MockSampleBlock()

MockSampleBlock::MockSampleBlock	(	long long	id,
		constSamplePtr	src,
		size_t	numsamples,
		sampleFormat	srcformat
	)

Definition at line 25 of file MockSampleBlock.cpp.

    : id { id }
    , srcFormat { srcformat }
    , data { copyToVector(src, numsamples, srcformat) }
{
}

Member Function Documentation

CloseLock()

void MockSampleBlock::CloseLock ( )

overridevirtualnoexcept

Implements SampleBlock.

Definition at line 33 of file MockSampleBlock.cpp.

{
}

DoGetMinMaxRMS() [1/2]

MinMaxRMS MockSampleBlock::DoGetMinMaxRMS ( ) const

overridevirtual

Implements SampleBlock.

Definition at line 89 of file MockSampleBlock.cpp.

{
   return { 0, 0, 0 };
}

DoGetMinMaxRMS() [2/2]

MinMaxRMS MockSampleBlock::DoGetMinMaxRMS ( size_t  start, size_t  len  )

overridevirtual

Implements SampleBlock.

Definition at line 84 of file MockSampleBlock.cpp.

{
   return { 0, 0, 0 };
}

DoGetSamples()

size_t MockSampleBlock::DoGetSamples ( samplePtr  dest, sampleFormat  destformat, size_t  sampleoffset, size_t  numsamples  )

overridevirtual

Implements SampleBlock.

Definition at line 73 of file MockSampleBlock.cpp.

{
   const auto charOffset = sampleoffset * SAMPLE_SIZE(srcFormat);
   const auto numChars = numsamples * SAMPLE_SIZE(destformat);
   std::copy(
      data.data() + charOffset, data.data() + charOffset + numChars, dest);
   return numsamples;
}

References staffpad::vo::copy(), data, SAMPLE_SIZE, and srcFormat.

Here is the call graph for this function:

GetBlockID()

SampleBlockID MockSampleBlock::GetBlockID ( ) const

overridevirtual

Implements SampleBlock.

Definition at line 37 of file MockSampleBlock.cpp.

{
   return id;
}

References id.

GetFloatSampleView()

BlockSampleView MockSampleBlock::GetFloatSampleView ( bool  mayThrow )

overridevirtual

Implements SampleBlock.

Definition at line 94 of file MockSampleBlock.cpp.

{
   std::vector<float> floatData { reinterpret_cast<const float*>(data.data()),
                                  reinterpret_cast<const float*>(
                                     data.data() + data.size()) };
   return std::make_shared<std::vector<float>>(floatData);
}

References data.

GetSampleCount()

size_t MockSampleBlock::GetSampleCount ( ) const

overridevirtual

Implements SampleBlock.

Definition at line 47 of file MockSampleBlock.cpp.

{
   return data.size() / SAMPLE_SIZE(srcFormat);
}

References data, SAMPLE_SIZE, and srcFormat.

GetSampleFormat()

sampleFormat MockSampleBlock::GetSampleFormat ( ) const

overridevirtual

Implements SampleBlock.

Definition at line 42 of file MockSampleBlock.cpp.

{
   return srcFormat;
}

References srcFormat.

GetSpaceUsage()

size_t MockSampleBlock::GetSpaceUsage ( ) const

overridevirtual

Implements SampleBlock.

Definition at line 64 of file MockSampleBlock.cpp.

{
   return data.size();
}

References data.

GetSummary256()

bool MockSampleBlock::GetSummary256 ( float *  dest, size_t  frameoffset, size_t  numframes  )

overridevirtual

Non-throwing, should fill with zeroes on failure.

Implements SampleBlock.

Definition at line 52 of file MockSampleBlock.cpp.

{
   return true;
}

GetSummary64k()

bool MockSampleBlock::GetSummary64k ( float *  dest, size_t  frameoffset, size_t  numframes  )

overridevirtual

Non-throwing, should fill with zeroes on failure.

Implements SampleBlock.

Definition at line 58 of file MockSampleBlock.cpp.

{
   return true;
}

SaveXML()

void MockSampleBlock::SaveXML ( XMLWriter &  )

overridevirtual

Implements SampleBlock.

Definition at line 69 of file MockSampleBlock.cpp.

{
}

Member Data Documentation

data

const std::vector<char> MockSampleBlock::data

Definition at line 52 of file MockSampleBlock.h.

Referenced by DoGetSamples(), GetFloatSampleView(), GetSampleCount(), and GetSpaceUsage().

id

const long long MockSampleBlock::id

Definition at line 50 of file MockSampleBlock.h.

Referenced by GetBlockID().

srcFormat

const sampleFormat MockSampleBlock::srcFormat

Definition at line 51 of file MockSampleBlock.h.

Referenced by DoGetSamples(), GetSampleCount(), and GetSampleFormat().

---

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

• MockSampleBlock.h
• MockSampleBlock.cpp