WaveBitmapCache Class Reference

Cache containing rasterized bitmaps representing the waveform. More...

#include <WaveBitmapCache.h>

Inheritance diagram for WaveBitmapCache:

Collaboration diagram for WaveBitmapCache:

Classes
struct	LookupHelper

Public Member Functions
	WaveBitmapCache (const WaveClip &waveClip, std::shared_ptr< WaveDataCache > dataCache, ElementFactory elementFactory)
	~WaveBitmapCache () override
WaveBitmapCache &	SetPaintParameters (const WavePaintParameters &params)
WaveBitmapCache &	SetSelection (const ZoomInfo &zoomInfo, double t0, double t1, bool selected)
Public Member Functions inherited from GraphicsDataCache< WaveBitmapCacheElement >
	GraphicsDataCache (const GraphicsDataCache &)=delete
	GraphicsDataCache (double scaledSampleRate, ElementFactory elementFactory)
GraphicsDataCache &	operator= (const GraphicsDataCache &)=delete
	~GraphicsDataCache () override
IteratorRange< GraphicsDataCacheIterator< WaveBitmapCacheElement > >	PerformLookup (const ZoomInfo &zoomInfo, double t0, double t1)
const WaveBitmapCacheElement *	PerformLookup (GraphicsDataCacheKey key)
void	setInitializer (Initializer initializer)
Public Member Functions inherited from GraphicsDataCacheBase
virtual	~GraphicsDataCacheBase ()=default
void	Invalidate ()
	Invalidate the cache content. More...
double	GetScaledSampleRate () const noexcept
	Returns the sample rate associated with cache. More...
void	UpdateViewportWidth (int64_t width) noexcept
int64_t	GetMaxViewportWidth () const noexcept

Private Member Functions
bool	InitializeElement (const GraphicsDataCacheKey &key, WaveBitmapCacheElement &element) override
void	CheckCache (const ZoomInfo &, double, double) override

Private Attributes
WavePaintParameters	mPaintParamters
struct {
int64_t   FirstPixel { -1 }
int64_t   LastPixel { -1 }
}	mSelection
std::unique_ptr< LookupHelper >	mLookupHelper
const Envelope *	mEnvelope { nullptr }
size_t	mEnvelopeVersion { 0 }
const WaveClip &	mWaveClip
Observer::Subscription	mStretchChangedSubscription

Additional Inherited Members
Public Types inherited from GraphicsDataCache< WaveBitmapCacheElement >
using	ElementFactory = std::function< std::unique_ptr< WaveBitmapCacheElement >()>
using	Initializer = std::function< bool(const GraphicsDataCacheKey &Key, WaveBitmapCacheElement &element)>
Static Public Attributes inherited from GraphicsDataCacheBase
static constexpr uint32_t	CacheElementWidth = 256
Protected Types inherited from GraphicsDataCacheBase
using	Lookup = std::vector< LookupElement >
	Cache lookup is a vector, with items sorted using Key. More...
virtual void	CheckCache (const ZoomInfo &, double, double)
virtual bool	InitializeElement (const GraphicsDataCacheKey &key, WaveBitmapCacheElement &element)
Protected Member Functions inherited from GraphicsDataCacheBase
	GraphicsDataCacheBase (double scaledSampleRate)
void	SetScaledSampleRate (double scaledSampleRate)
virtual GraphicsDataCacheElementBase *	CreateElement (const GraphicsDataCacheKey &key)=0
	Create a new Cache element. Implementation is responsible of the lifetime control. More...
virtual void	DisposeElement (GraphicsDataCacheElementBase *element)=0
	This method is called, when the cache element should be evicted. Implementation may not deallocate the object. More...
virtual bool	UpdateElement (const GraphicsDataCacheKey &key, GraphicsDataCacheElementBase &element)=0
	This method is called on all elements matching the request that are not complete (i. e. IsComplete if false). More...
BaseLookupResult	PerformBaseLookup (const ZoomInfo &zoomInfo, double t0, double t1)
	Perform a lookup inside the cache. This method modifies mLookup and invalidates any previous result. More...
const GraphicsDataCacheElementBase *	PerformBaseLookup (GraphicsDataCacheKey key)
	Perform a lookup for the given key. This method modifies mLookup and invalidates any previous result. More...

Detailed Description

Cache containing rasterized bitmaps representing the waveform.

Definition at line 41 of file WaveBitmapCache.h.

Constructor & Destructor Documentation

WaveBitmapCache()

WaveBitmapCache::WaveBitmapCache	(	const WaveClip &	waveClip,
		std::shared_ptr< WaveDataCache >	dataCache,
		ElementFactory	elementFactory
	)

Definition at line 298 of file WaveBitmapCache.cpp.

    : GraphicsDataCache { waveClip.GetRate() / waveClip.GetStretchRatio(),
                          std::move(elementFactory) }
    , mLookupHelper { std::make_unique<LookupHelper>(std::move(dataCache)) }
    , mWaveClip { waveClip }
    , mStretchChangedSubscription {
       const_cast<WaveClip&>(waveClip)
          .Observer::Publisher<StretchRatioChange>::Subscribe(
             [this](const StretchRatioChange&) {
                SetScaledSampleRate(
                   mWaveClip.GetRate() / mWaveClip.GetStretchRatio());
             })
    }
{
}

References WaveClip::GetRate(), WaveClip::GetStretchRatio(), mWaveClip, and GraphicsDataCacheBase::SetScaledSampleRate().

Here is the call graph for this function:

~WaveBitmapCache()

WaveBitmapCache::~WaveBitmapCache ( )

overridedefault

Member Function Documentation

CheckCache()

void WaveBitmapCache::CheckCache ( const ZoomInfo &  , double  , double    )

overrideprivatevirtual

Reimplemented from GraphicsDataCache< WaveBitmapCacheElement >.

Definition at line 357 of file WaveBitmapCache.cpp.

{
   if (mEnvelope != nullptr && mEnvelopeVersion != mEnvelope->GetVersion())
   {
      mEnvelopeVersion = mEnvelope->GetVersion();
      Invalidate();
   }
}

References Envelope::GetVersion(), GraphicsDataCacheBase::Invalidate(), mEnvelope, and mEnvelopeVersion.

Here is the call graph for this function:

InitializeElement()

bool WaveBitmapCache::InitializeElement ( const GraphicsDataCacheKey &  key, WaveBitmapCacheElement &  element  )

overrideprivatevirtual

Reimplemented from GraphicsDataCache< WaveBitmapCacheElement >.

Definition at line 366 of file WaveBitmapCache.cpp.

{
   if (mPaintParamters.Height == 0)
      return false;
 
   if (!mLookupHelper->PerformLookup(this, key))
   {
      const auto width = 1;
      const auto height = mPaintParamters.Height;
      const auto bytes = element.Allocate(width, height);
      std::memset(bytes, 0, width * height * 3);
      return true;
   }
 
   auto sw = FrameStatistics::CreateStopwatch(
      FrameStatistics::SectionID::WaveBitmapCache);
 
   const auto columnsCount = mLookupHelper->AvailableColumns;
 
   const auto defaultColor = Triplet(mPaintParamters.BlankColor);
 
   const auto height = static_cast<uint32_t>(mPaintParamters.Height);
 
   auto rowData = element.Allocate(columnsCount, height);
 
   for (uint32_t row = 0; row < height; ++row)
   {
      auto colorFunction = mLookupHelper->ColorFunctions.data();
 
      for (size_t pixel = 0; pixel < columnsCount; ++pixel)
      {
         const auto color = colorFunction->GetColor(row, defaultColor);
 
         *rowData++ = color.r;
         *rowData++ = color.g;
         *rowData++ = color.b;
 
         ++colorFunction;
      }
   }
 
   element.AvailableColumns = columnsCount;
   element.IsComplete = mLookupHelper->IsComplete;
 
   return true;
}

References WaveBitmapCacheElement::Allocate(), WaveBitmapCacheElement::AvailableColumns, WavePaintParameters::BlankColor, FrameStatistics::CreateStopwatch(), WavePaintParameters::Height, GraphicsDataCacheElementBase::IsComplete, key, mLookupHelper, mPaintParamters, and FrameStatistics::WaveBitmapCache.

Here is the call graph for this function:

SetPaintParameters()

WaveBitmapCache & WaveBitmapCache::SetPaintParameters

(

const WavePaintParameters &

params

)

Definition at line 322 of file WaveBitmapCache.cpp.

{
   if (mPaintParamters != params)
   {
      mPaintParamters = params;
      mEnvelope = params.AttachedEnvelope;
      mEnvelopeVersion = mEnvelope != nullptr ? mEnvelope->GetVersion() : 0;
 
      Invalidate();
   }
 
   return *this;
}

References Envelope::GetVersion(), GraphicsDataCacheBase::Invalidate(), mEnvelope, mEnvelopeVersion, mPaintParamters, and params.

Here is the call graph for this function:

SetSelection()

WaveBitmapCache & WaveBitmapCache::SetSelection	(	const ZoomInfo &	zoomInfo,
		double	t0,
		double	t1,
		bool	selected
	)

Definition at line 336 of file WaveBitmapCache.cpp.

{
   const auto empty = !selected || t0 > t1 ||
                      ((t1 - t0) < std::numeric_limits<double>::epsilon());
 
   const auto first = empty ? int64_t(-1) : zoomInfo.TimeToPosition(t0);
   const auto last =
      empty ? int64_t(-1) : std::max(zoomInfo.TimeToPosition(t1), first + 1);
 
   if (mSelection.FirstPixel != first || mSelection.LastPixel != last)
   {
      mSelection.FirstPixel = first;
      mSelection.LastPixel = last;
 
      Invalidate();
   }
 
   return *this;
}

References GraphicsDataCacheBase::Invalidate(), mSelection, and ZoomInfo::TimeToPosition().

Here is the call graph for this function:

Member Data Documentation

FirstPixel

int64_t WaveBitmapCache::FirstPixel { -1 }

Definition at line 64 of file WaveBitmapCache.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

LastPixel

int64_t WaveBitmapCache::LastPixel { -1 }

Definition at line 65 of file WaveBitmapCache.h.

Referenced by WaveBitmapCache::LookupHelper::PerformLookup().

mEnvelope

const Envelope* WaveBitmapCache::mEnvelope { nullptr }

private

Definition at line 75 of file WaveBitmapCache.h.

Referenced by CheckCache(), WaveBitmapCache::LookupHelper::PerformLookup(), and SetPaintParameters().

mEnvelopeVersion

size_t WaveBitmapCache::mEnvelopeVersion { 0 }

private

Definition at line 76 of file WaveBitmapCache.h.

Referenced by CheckCache(), and SetPaintParameters().

mLookupHelper

std::unique_ptr<LookupHelper> WaveBitmapCache::mLookupHelper

private

Definition at line 73 of file WaveBitmapCache.h.

Referenced by InitializeElement().

mPaintParamters

WavePaintParameters WaveBitmapCache::mPaintParamters

private

Definition at line 60 of file WaveBitmapCache.h.

Referenced by InitializeElement(), WaveBitmapCache::LookupHelper::PerformLookup(), and SetPaintParameters().

struct { ... } WaveBitmapCache::mSelection

Referenced by WaveBitmapCache::LookupHelper::PerformLookup(), and SetSelection().

mStretchChangedSubscription

Observer::Subscription WaveBitmapCache::mStretchChangedSubscription

private

Definition at line 79 of file WaveBitmapCache.h.

mWaveClip

const WaveClip& WaveBitmapCache::mWaveClip

private

Definition at line 78 of file WaveBitmapCache.h.

Referenced by WaveBitmapCache().

---

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

• WaveBitmapCache.h
• WaveBitmapCache.cpp