csl::DelayLine Class Reference

#include <DelayLine.h>

Inheritance diagram for csl::DelayLine:

List of all members.

Public Member Functions
	DelayLine (unsigned maxDelayInSamples)
	Constructor: takes the maximum delay lenght in samples.
float	delayTime ()
	Returns the delay amount in miliseconds.
unsigned	delayLength ()
	Returns the delay amount in samples.
float	setDelayTime (float delayInMiliseconds)
	Set the delay amount using miliseconds as unit of meassurment.
unsigned	setDelayLength (unsigned delayInSamples)
	Set the delay amount using samples as unit.
void	nextBuffer (Buffer &output) throw (CException)
	DelayLine (unsigned maxDelayInSamples)
float	delayTime ()
unsigned	delayLength ()
float	setDelayTime (float delayInMiliseconds)
unsigned	setDelayLength (unsigned delayInSamples)
void	nextBuffer (Buffer &output) throw (CException)
Protected Attributes
RingBuffer	mRingBuffer
unsigned	mMaxDelayInSamples
unsigned	mTotalDelayInSamples

---

Detailed Description

The delay line takes its input and write a delayed output

---

Constructor & Destructor Documentation

DelayLine::DelayLine

(

unsigned

maxDelayInSamples

)

Constructor: takes the maximum delay lenght in samples.

References csl::Buffer::allocateBuffers(), csl::kPositionEnd, csl::CGestalt::maxBufferFrames(), csl::RingBuffer::mBuffer, mMaxDelayInSamples, mRingBuffer, csl::RingBuffer::mTap, mTotalDelayInSamples, csl::CGestalt::numOutChannels(), csl::RingBufferTap::seekTo(), and csl::Buffer::setSize().

csl::DelayLine::DelayLine

(

unsigned

maxDelayInSamples

)

---

Member Function Documentation

float DelayLine::delayTime

(

)

Returns the delay amount in miliseconds.

< Returns the delay amount in miliseconds.

References delayLength(), and csl::UnitGenerator::mFrameRate.

unsigned DelayLine::delayLength

(

)

Returns the delay amount in samples.

References csl::Seekable::mCurrentFrame, csl::RingBuffer::mCurrentWriteFrame, mRingBuffer, csl::RingBuffer::mTap, and mTotalDelayInSamples.

Referenced by delayTime(), setDelayLength(), and setDelayTime().

float DelayLine::setDelayTime

(

float

delayInMiliseconds

)

Set the delay amount using miliseconds as unit of meassurment.

References delayLength(), csl::kLogError, csl::kPositionEnd, csl::logMsg(), csl::UnitGenerator::mFrameRate, mMaxDelayInSamples, mRingBuffer, csl::RingBuffer::mTap, and csl::RingBufferTap::seekTo().

unsigned DelayLine::setDelayLength

(

unsigned

delayInSamples

)

Set the delay amount using samples as unit.

References delayLength(), csl::kLogError, csl::kPositionEnd, csl::logMsg(), mMaxDelayInSamples, mRingBuffer, csl::RingBuffer::mTap, and csl::RingBufferTap::seekTo().

void DelayLine::nextBuffer

(

Buffer &

outputBuffer

)

throw (CException) [virtual]

get a buffer of Frames -- this is the core CSL "pull" function; the given buffer can be written into, and a changed() message is sent.

Reimplemented from csl::UnitGenerator.

References CSL_INPUT, csl::Port::mBuffer, and csl::Controllable::pullInput().

float csl::DelayLine::delayTime

(

)

unsigned csl::DelayLine::delayLength

(

)

float csl::DelayLine::setDelayTime

(

float

delayInMiliseconds

)

unsigned csl::DelayLine::setDelayLength

(

unsigned

delayInSamples

)

void csl::DelayLine::nextBuffer

(

Buffer &

outputBuffer

)

throw (CException) [virtual]

get a buffer of Frames -- this is the core CSL "pull" function; the given buffer can be written into, and a changed() message is sent.

Reimplemented from csl::UnitGenerator.

---

Member Data Documentation

RingBuffer csl::DelayLine::mRingBuffer [protected]

Referenced by delayLength(), DelayLine(), setDelayLength(), and setDelayTime().

unsigned csl::DelayLine::mMaxDelayInSamples [protected]

Referenced by DelayLine(), setDelayLength(), and setDelayTime().

unsigned csl::DelayLine::mTotalDelayInSamples [protected]

Referenced by delayLength(), and DelayLine().

---

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

• CSL/Processors/OLD/DelayLine.h
• CSL/Spatializers/VBAP/DelayLine.h
• CSL/Processors/OLD/DelayLine.cpp
• CSL/Spatializers/VBAP/DelayLine.cpp