WaveCacheSampleBlock Struct Reference

Helper structure used to transfer the data between the data and graphics layers. More...

#include <WaveDataCache.h>

Collaboration diagram for WaveCacheSampleBlock:

Classes
struct	Summary
	Summary calculated over the requested range. More...

Public Types
enum class	Type { Samples , MinMaxRMS256 , MinMaxRMS64k }
	Type of the data of the request. More...

Public Member Functions
bool	ContainsSample (int64_t sampleIndex) const noexcept
	Checks if sample is in the range represented by this block. More...
float *	GetWritePointer (size_t floatsCount)
	Gets a pointer to a data buffer enough to store floatsCount floats. More...
void	Reset () noexcept

Public Attributes
Type	DataType { Type::Samples }
int64_t	FirstSample { 0 }
size_t	NumSamples { 0 }

Private Member Functions
Summary	GetSummary (int64_t from, size_t samplesCount, const Summary &initializer) const noexcept

Private Attributes
std::vector< float >	mData

Friends
class	WaveDataCache

Detailed Description

Helper structure used to transfer the data between the data and graphics layers.

Definition at line 26 of file WaveDataCache.h.

Member Enumeration Documentation

Type

enum class WaveCacheSampleBlock::Type

strong

Type of the data of the request.

Enumerator
Samples	Each element of the resulting array is a sample.
MinMaxRMS256	Each element of the resulting array is a tuple (min, max, rms) calculated over 256 samples.
MinMaxRMS64k	Each element of the resulting array is a tuple (min, max, rms) calculated over 256 samples.

Definition at line 29 of file WaveDataCache.h.

   {
      Samples,
      MinMaxRMS256,
      MinMaxRMS64k,
   };

Member Function Documentation

ContainsSample()

bool WaveCacheSampleBlock::ContainsSample ( int64_t  sampleIndex ) const

noexcept

Checks if sample is in the range represented by this block.

Definition at line 387 of file WaveDataCache.cpp.

{
   return sampleIndex >= FirstSample &&
          (sampleIndex < (FirstSample + NumSamples));
}

Referenced by WaveDataCache::InitializeElement().

Here is the caller graph for this function:

GetSummary()

WaveCacheSampleBlock::Summary WaveCacheSampleBlock::GetSummary ( int64_t  from, size_t  samplesCount, const Summary &  initializer  ) const

privatenoexcept

Definition at line 439 of file WaveDataCache.cpp.

{
   from = from - FirstSample;
   samplesCount =
      std::min<size_t>(samplesCount, std::max<int64_t>(0, NumSamples - from));
 
   const auto to = from + samplesCount;
 
   const float* data =
      static_cast<const float*>(static_cast<const void*>(mData.data()));
 
   Summary summary = initializer;
 
   summary.SamplesCount = samplesCount;
 
   switch (DataType)
   {
   case WaveCacheSampleBlock::Type::Samples:
      summary.SumItemsCount += samplesCount;
 
      for (auto sampleIndex = from; sampleIndex < to; ++sampleIndex)
      {
         const float sample = data[sampleIndex];
 
         summary.Min = std::min(summary.Min, sample);
         summary.Max = std::max(summary.Max, sample);
 
         summary.SquaresSum += double(sample) * double(sample);
      }
 
      assert(summary.Min <= summary.Max);
 
      break;
   case WaveCacheSampleBlock::Type::MinMaxRMS256:
      processBlock<256>(data, from, samplesCount, summary);
      break;
   case WaveCacheSampleBlock::Type::MinMaxRMS64k:
      processBlock<64 * 1024>(data, from, samplesCount, summary);
      break;
   default:
      break;
   }
 
   return summary;
}

References Journal::Events::anonymous_namespace{JournalEvents.cpp}::initializer, WaveCacheSampleBlock::Summary::Max, WaveCacheSampleBlock::Summary::Min, min(), MinMaxRMS256, MinMaxRMS64k, Samples, WaveCacheSampleBlock::Summary::SamplesCount, WaveCacheSampleBlock::Summary::SquaresSum, and WaveCacheSampleBlock::Summary::SumItemsCount.

Referenced by WaveDataCache::InitializeElement().

Here is the call graph for this function:

Here is the caller graph for this function:

GetWritePointer()

float * WaveCacheSampleBlock::GetWritePointer

(

size_t

floatsCount

)

Gets a pointer to a data buffer enough to store floatsCount floats.

Definition at line 393 of file WaveDataCache.cpp.

{
   mData.resize(floatsCount);
   return mData.data();
}

References mData.

Referenced by anonymous_namespace{WaveDataCache.cpp}::AppendBufferHelper::FillBlocksFromAppendBuffer().

Here is the caller graph for this function:

Reset()

void WaveCacheSampleBlock::Reset ( )

noexcept

Definition at line 399 of file WaveDataCache.cpp.

{
   FirstSample = 0;
   NumSamples  = 0;
}

References FirstSample, and NumSamples.

Referenced by WaveDataCache::InitializeElement().

Here is the caller graph for this function:

Friends And Related Function Documentation

WaveDataCache

friend class WaveDataCache

friend

Definition at line 76 of file WaveDataCache.h.

Member Data Documentation

DataType

Type WaveCacheSampleBlock::DataType { Type::Samples }

Definition at line 58 of file WaveDataCache.h.

Referenced by WaveDataCache::InitializeElement().

FirstSample

int64_t WaveCacheSampleBlock::FirstSample { 0 }

Definition at line 59 of file WaveDataCache.h.

Referenced by Reset().

mData

std::vector<float> WaveCacheSampleBlock::mData

private

Definition at line 74 of file WaveDataCache.h.

Referenced by GetWritePointer().

NumSamples

size_t WaveCacheSampleBlock::NumSamples { 0 }

Definition at line 60 of file WaveDataCache.h.

Referenced by Reset().

---

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

• WaveDataCache.h
• WaveDataCache.cpp