#include <WaveTrackSink.h>

Inheritance diagram for WaveTrackSink:

Collaboration diagram for WaveTrackSink:

Public Member Functions
	WaveTrackSink (WaveChannel &left, WaveChannel pRight, WaveTrack pGenerated, sampleCount start, bool isProcessor, sampleFormat effectiveFormat)

	~WaveTrackSink () override

bool	AcceptsBuffers (const Buffers &buffers) const override
	Accepts buffers only if there is at least one channel. More...

bool	Acquire (Buffers &data) override
	Guarantee empty space in Buffers before they are written. More...

bool	Release (const Buffers &data, size_t curBlockSize) override
	Acknowledge receipt of data in Buffers, which caller may then Advance() More...

void	Flush (Buffers &data)

bool	IsOk () const
	Whether any errors have occurred in writing data. More...

Public Member Functions inherited from AudioGraph::Sink
virtual	~Sink ()

virtual bool	AcceptsBuffers (const Buffers &buffers) const =0

virtual bool	Acquire (Buffers &data)=0
	Guarantee empty space in Buffers before they are written. More...

virtual bool	Release (const Buffers &data, size_t curBlockSize)=0
	Acknowledge receipt of data in Buffers, which caller may then Advance() More...

Private Member Functions
void	DoConsume (Buffers &data)

Private Attributes
WaveChannel &	mLeft

WaveChannel *const	mpRight

WaveTrack *const	mpGenerated

WaveChannel *const	mGenLeft

WaveChannel *const	mGenRight

const bool	mIsProcessor

const sampleFormat	mEffectiveFormat

sampleCount	mOutPos

bool	mOk { true }

Additional Inherited Members
Public Types inherited from AudioGraph::Sink
using	Buffers = AudioGraph::Buffers

Detailed Description

Definition at line 27 of file WaveTrackSink.h.

Constructor & Destructor Documentation

◆ WaveTrackSink()

WaveTrackSink::WaveTrackSink	(	WaveChannel &	left,
		WaveChannel *	pRight,
		WaveTrack *	pGenerated,
		sampleCount	start,
		bool	isProcessor,
		sampleFormat	effectiveFormat
	)

Parameters

effectiveFormat This argument affects processors only, not generators

Definition at line 20 of file WaveTrackSink.cpp.

   : mLeft{ left }, mpRight{ pRight }
   , mpGenerated{ pGenerated }
   , mGenLeft{ pGenerated ? (*pGenerated->Channels().begin()).get() : nullptr }
   , mGenRight{ pRight && pGenerated
      ? (*pGenerated->Channels().rbegin()).get() : nullptr }
   , mIsProcessor{ isProcessor }
   , mEffectiveFormat{ effectiveFormat }
   , mOutPos{ start }
{
}

◆ ~WaveTrackSink()

WaveTrackSink::~WaveTrackSink ( )

overridedefault

Member Function Documentation

◆ AcceptsBuffers()

bool WaveTrackSink::AcceptsBuffers ( const Buffers & buffers ) const

overridevirtual

Accepts buffers only if there is at least one channel.

Implements AudioGraph::Sink.

Definition at line 37 of file WaveTrackSink.cpp.

{
   return buffers.Channels() > 0;
}

References AudioGraph::Buffers::Channels().

Here is the call graph for this function:

◆ Acquire()

bool WaveTrackSink::Acquire ( Buffers & data )

overridevirtual

Guarantee empty space in Buffers before they are written.

Returns: success

Postcondition: result: !result || data.BlockSize() <= data.Remaining()

Implements AudioGraph::Sink.

Definition at line 42 of file WaveTrackSink.cpp.

{
   if (data.BlockSize() <= data.Remaining()) {
      // post is satisfied
   }
   else
      // Output buffers have (mostly) filled
      // (less than one block remains; maybe nonzero because of samples
      // discarded for initial latency correction)
      DoConsume(data);
   return IsOk();
}

References AudioGraph::Buffers::BlockSize(), DoConsume(), IsOk(), and AudioGraph::Buffers::Remaining().

Here is the call graph for this function:

◆ DoConsume()

void WaveTrackSink::DoConsume ( Buffers & data )

private

Precondition: data.Channels() > 0

Postcondition: data.BlockSize() <= data.Remaining()

Definition at line 61 of file WaveTrackSink.cpp.

{
   // Satisfy pre of GetReadPosition()
   assert(data.Channels() > 0);
   const auto inputBufferCnt = data.Position();
   if (inputBufferCnt > 0) {
      // Some data still unwritten
      if (mIsProcessor) {
         mOk = mOk &&
            mLeft.Set(data.GetReadPosition(0),
               floatSample, mOutPos, inputBufferCnt, mEffectiveFormat);
         if (mpRight)
            mOk = mOk &&
               mpRight->Set(data.GetReadPosition(1),
                  floatSample, mOutPos, inputBufferCnt, mEffectiveFormat);
      }
      else if (mGenLeft) {
         mGenLeft->Append(data.GetReadPosition(0),
            floatSample, inputBufferCnt );
         if (mGenRight)
            mGenRight->Append(data.GetReadPosition(1),
               floatSample, inputBufferCnt);
      }
      // Satisfy post
      data.Rewind();
      // Bump to the next track position
      mOutPos += inputBufferCnt;
   }
   else {
      // Position is zero, therefore Remaining() is a positive multiple of
      // block size
   }
   // assert the post
   assert(data.BlockSize() <= data.Remaining());
}

References WaveChannel::Append(), AudioGraph::Buffers::BlockSize(), AudioGraph::Buffers::Channels(), floatSample, AudioGraph::Buffers::GetReadPosition(), mEffectiveFormat, mGenLeft, mGenRight, mIsProcessor, mLeft, mOk, mOutPos, mpRight, AudioGraph::Buffers::Position(), AudioGraph::Buffers::Remaining(), AudioGraph::Buffers::Rewind(), and WaveChannel::Set().

Referenced by Acquire(), and Flush().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Flush()

void WaveTrackSink::Flush ( Buffers & data )

Precondition: data.Channels() > 0

Postcondition: data.BlockSize() <= data.Remaining()

Definition at line 97 of file WaveTrackSink.cpp.

{
   DoConsume(data);
   if (mpGenerated)
      mpGenerated->Flush();
}

References DoConsume(), WaveTrack::Flush(), and mpGenerated.

Here is the call graph for this function:

◆ IsOk()

bool WaveTrackSink::IsOk ( ) const

inline

Whether any errors have occurred in writing data.

Definition at line 47 of file WaveTrackSink.h.

47{ return mOk; }

Referenced by Acquire().

Here is the caller graph for this function:

◆ Release()

bool WaveTrackSink::Release	(	const Buffers &	data,
		size_t	curBlockSize
	)

overridevirtual

Acknowledge receipt of data in Buffers, which caller may then Advance()

Returns: success

Precondition: AcceptsBuffers(data); curBlockSize <= data.BlockSize()

Implements AudioGraph::Sink.

Definition at line 55 of file WaveTrackSink.cpp.

{
   // May become non-trivial later
   return true;
}

Member Data Documentation

◆ mEffectiveFormat

const sampleFormat WaveTrackSink::mEffectiveFormat

private

Definition at line 62 of file WaveTrackSink.h.

Referenced by DoConsume().

◆ mGenLeft

WaveChannel* const WaveTrackSink::mGenLeft

private

Definition at line 59 of file WaveTrackSink.h.

Referenced by DoConsume().

◆ mGenRight

WaveChannel* const WaveTrackSink::mGenRight

private

Definition at line 60 of file WaveTrackSink.h.

Referenced by DoConsume().

◆ mIsProcessor

const bool WaveTrackSink::mIsProcessor

private

Definition at line 61 of file WaveTrackSink.h.

Referenced by DoConsume().

◆ mLeft

WaveChannel& WaveTrackSink::mLeft

private

Definition at line 56 of file WaveTrackSink.h.

Referenced by DoConsume().

◆ mOk

bool WaveTrackSink::mOk { true }

private

Definition at line 65 of file WaveTrackSink.h.

Referenced by DoConsume().

◆ mOutPos

sampleCount WaveTrackSink::mOutPos

private

Definition at line 64 of file WaveTrackSink.h.

Referenced by DoConsume().

◆ mpGenerated

WaveTrack* const WaveTrackSink::mpGenerated

private

Definition at line 58 of file WaveTrackSink.h.

Referenced by Flush().

◆ mpRight

WaveChannel* const WaveTrackSink::mpRight

private

Definition at line 57 of file WaveTrackSink.h.

Referenced by DoConsume().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WaveTrackSink()

◆ ~WaveTrackSink()

Member Function Documentation

◆ AcceptsBuffers()

◆ Acquire()

◆ DoConsume()

◆ Flush()

◆ IsOk()

◆ Release()

Member Data Documentation

◆ mEffectiveFormat

◆ mGenLeft

◆ mGenRight

◆ mIsProcessor

◆ mLeft

◆ mOk

◆ mOutPos

◆ mpGenerated

◆ mpRight