CSL  5.2
csl::RingBufferTap Class Reference

RingBufferTap is a reader that loops over a buffer. More...

#include <RingBuffer.h>

+ Inheritance diagram for csl::RingBufferTap:

List of all members.

Public Member Functions

 RingBufferTap (RingBuffer *parent=0, int offset=0)
 Create a tap on a ring buffer, optionally offset relative to the current write position.
void setOffset (int offset)
unsigned duration ()
 number of frames in the Seekable
unsigned seekTo (int position, SeekPosition whence) throw (CException)
 general-purpose seek on a stream
void setLoopStart (unsigned frame)
void setLoopEnd (unsigned frame)
void setBuffer (RingBuffer *parent)
void nextBuffer (Buffer &outputBuffer) throw (CException)
 nextBuffer method
void nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
 really compute the next buffer given an offset base channel; this is called by nextBuffer, possibly multiple times
void destructiveNextBuffer (Buffer &outputBuffer) throw (CException)
 zeroing as it goes.
void destructiveNextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
unsigned frameRate ()
void setFrameRate (unsigned rate)
 get/set the receiver's frame rate
virtual unsigned numChannels ()
void setNumChannels (unsigned ch)
 get/set the receiver's number of outputs
BufferCopyPolicy copyPolicy ()
void setCopyPolicy (BufferCopyPolicy ch)
 get/set the receiver's buffer copy policy
virtual bool isFixed ()
 query whether I'm fixed (StaticVariable overrides this)
virtual bool isActive ()
 query whether I'm currently active (Envelopes can go inactive)
void addOutput (UnitGenerator *ugen)
 add to or return the UGen vector of outputs
void removeOutput (UnitGenerator *ugen)
UGenVector outputs ()
virtual unsigned numOutputs ()
bool checkFanOut (Buffer &outputBuffer) throw (CException)
 check for fan-out and copy previous buffer; return true if fanning out
void handleFanOut (Buffer &outputBuffer) throw (CException)
virtual void setValue (sample theValue)
 set/get the value (not allowed in the abstract, useful for static values)
virtual sample value ()
virtual void dump ()
 pretty-print the receiver
virtual void trigger ()
void attachObserver (Observer *)
 (possibly notify obersvers on my death)
void detachObserver (Observer *)
void changed (void *argument)
 this is what I send to myself to notify my observers; It's not overridden in general. It results in the observers receiving update() calls < override evaluate to filter updates to the observer map
virtual int evaluate (void *argument)
void setScale (UnitGenerator &scale)
 set the receiver's scale member to a UGen or a float
void setScale (float scale)
void setOffset (UnitGenerator &offset)
 set the receiver's offset member to a UGen or a float
void setOffset (float offset)
virtual void trigger ()
 trigger passed on here
void isScaled ()
 answer whether scale = 1 & offset = 0
PortgetPort (CSL_MAP_KEY name)
virtual void reset () throw (CException)
 reset-to-zero

Public Attributes

unsigned mLoopStartFrame
 Number of frames from the beginning to start a loop at.
unsigned mLoopEndFrame
 Number of frames away from buffer end.
unsigned mCurrentFrame
 where I currently am in the buffer
double mActualFrame
 where I actually am in the buffer

Protected Member Functions

void zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
 utility method to zero out an outputBuffer
void addInput (CSL_MAP_KEY name, UnitGenerator &ugen)
 Plug in a unit generator to the named input slot.
void addInput (CSL_MAP_KEY name, float value)
 Plug in a float to the named input slot.
void pullInput (Port *thePort, unsigned numFrames) throw (CException)
 method to read the control values (in case they're dynamic). this sends nextBuffer() to the input.
void pullInput (Port *thePort, Buffer &theBuffer) throw (CException)
virtual void dump ()
 pretty-print the receiver's input/controls map

Protected Attributes

unsigned mTempCurrentFrame
RingBuffermParentBuffer
unsigned mFrameRate
 trigger ignored here
unsigned mNumChannels
 my "expected" number of output channels
BufferCopyPolicy mCopyPolicy
 the policy I use if asked for more or fewer channels
UGenVector mOutputs
 the vector of my output UGens
unsigned mNumOutputs
 the number of outputs
BuffermOutputCache
 my past output ring buffer (only used in case of fan-out)
unsigned mSequence
 the highest-seen buffer seq number
PortMap mInputs
 the map of my inputs or controls (used by the mix-in classes)

Friends

class RingBuffer
 Allow RingBuffer to access private members of RingBufferTap.

Detailed Description

RingBufferTap is a reader that loops over a buffer.

Definition at line 21 of file RingBuffer.h.


Constructor & Destructor Documentation

RingBufferTap::RingBufferTap ( RingBuffer parent = 0,
int  offset = 0 
)

Create a tap on a ring buffer, optionally offset relative to the current write position.

Definition at line 16 of file RingBuffer.cpp.

References setOffset().


Member Function Documentation

void RingBufferTap::setOffset ( int  offset)
unsigned RingBufferTap::duration ( )
virtual

number of frames in the Seekable

Implements csl::Seekable.

Definition at line 23 of file RingBuffer.cpp.

References csl::RingBuffer::mBuffer, csl::Buffer::mNumFrames, and mParentBuffer.

unsigned RingBufferTap::seekTo ( int  position,
SeekPosition  whence 
) throw (CException)
virtual

general-purpose seek on a stream

Implements csl::Seekable.

Definition at line 138 of file RingBuffer.cpp.

References csl::kPositionCurrent, csl::kPositionEnd, and csl::kPositionStart.

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

void csl::RingBufferTap::setLoopStart ( unsigned  frame)
inline

Definition at line 36 of file RingBuffer.h.

References mLoopStartFrame.

Referenced by csl::RingBuffer::setLoopStart().

void csl::RingBufferTap::setLoopEnd ( unsigned  frame)
inline

Definition at line 37 of file RingBuffer.h.

References mLoopEndFrame.

Referenced by csl::RingBuffer::setLoopEnd().

void csl::RingBufferTap::setBuffer ( RingBuffer parent)
inline

Definition at line 38 of file RingBuffer.h.

References mParentBuffer.

Referenced by csl::RingBuffer::RingBuffer().

void RingBufferTap::nextBuffer ( Buffer outputBuffer) throw (CException)
virtual

nextBuffer method

Reimplemented from csl::UnitGenerator.

Definition at line 42 of file RingBuffer.cpp.

References csl::UnitGenerator::nextBuffer().

void RingBufferTap::nextBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
) throw (CException)
virtual

really compute the next buffer given an offset base channel; this is called by nextBuffer, possibly multiple times

Reimplemented from csl::UnitGenerator.

Definition at line 52 of file RingBuffer.cpp.

References memcpy().

void RingBufferTap::destructiveNextBuffer ( Buffer outputBuffer) throw (CException)

zeroing as it goes.

Definition at line 89 of file RingBuffer.cpp.

void RingBufferTap::destructiveNextBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
) throw (CException)

Definition at line 102 of file RingBuffer.cpp.

References memcpy().

void csl::UnitGenerator::setFrameRate ( unsigned  rate)
inlineinherited

get/set the receiver's frame rate

Definition at line 226 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by m3_header().

void csl::UnitGenerator::setNumChannels ( unsigned  ch)
inlineinherited
BufferCopyPolicy csl::UnitGenerator::copyPolicy ( )
inlineinherited

Definition at line 231 of file CSL_Core.h.

References csl::UnitGenerator::mCopyPolicy.

void csl::UnitGenerator::setCopyPolicy ( BufferCopyPolicy  ch)
inlineinherited
virtual bool csl::UnitGenerator::isFixed ( )
inlinevirtualinherited

query whether I'm fixed (StaticVariable overrides this)

Reimplemented in csl::StaticVariable, and csl::BinaryOp.

Definition at line 247 of file CSL_Core.h.

virtual bool csl::UnitGenerator::isActive ( )
inlinevirtualinherited
UGenVector csl::UnitGenerator::outputs ( )
inlineinherited

Definition at line 253 of file CSL_Core.h.

References csl::UnitGenerator::mOutputs.

virtual unsigned csl::UnitGenerator::numOutputs ( )
inlinevirtualinherited

Definition at line 254 of file CSL_Core.h.

References csl::UnitGenerator::mNumOutputs.

bool UnitGenerator::checkFanOut ( Buffer outputBuffer) throw (CException)
inherited

check for fan-out and copy previous buffer; return true if fanning out

Definition at line 549 of file CSL_Core.cpp.

void UnitGenerator::handleFanOut ( Buffer outputBuffer) throw (CException)
inherited

Definition at line 563 of file CSL_Core.cpp.

References csl_max.

virtual void csl::UnitGenerator::setValue ( sample  theValue)
inlinevirtualinherited

set/get the value (not allowed in the abstract, useful for static values)

Reimplemented in csl::DynamicVariable, and csl::StaticVariable.

Definition at line 260 of file CSL_Core.h.

virtual sample csl::UnitGenerator::value ( )
inlinevirtualinherited

Reimplemented in csl::StaticVariable.

Definition at line 261 of file CSL_Core.h.

virtual void csl::UnitGenerator::trigger ( void  )
inlinevirtualinherited
void UnitGenerator::zeroBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
)
protectedinherited

utility method to zero out an outputBuffer

Definition at line 513 of file CSL_Core.cpp.

References csl::Buffer::mMonoBufferByteSize, and csl::Buffer::monoBuffer().

void Model::attachObserver ( Observer o)
inherited

(possibly notify obersvers on my death)

register/remove observers

Definition at line 491 of file CGestalt.cpp.

References csl::logMsg(), csl::Observer::mKey, and csl::Observer::mPeriod.

Referenced by csl::SpatialPanner::setSpeakerLayout().

void Model::detachObserver ( Observer o)
inherited
void Model::changed ( void *  argument)
inherited

this is what I send to myself to notify my observers; It's not overridden in general. It results in the observers receiving update() calls < override evaluate to filter updates to the observer map

Definition at line 529 of file CGestalt.cpp.

References csl::logMsg().

Referenced by csl::SpeakerLayout::addSpeaker(), csl::MIDIIn::handleIncomingMidiMessage(), and csl::SpeakerLayout::setDefaultSpeakerLayout().

virtual int csl::Model::evaluate ( void *  argument)
inlinevirtualinherited

Reimplemented in csl::MIDIIn.

Definition at line 259 of file CGestalt.h.

void Scalable::setScale ( float  scale)
inherited

Definition at line 894 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_SCALE, and csl::logMsg().

void Scalable::setOffset ( UnitGenerator offset)
inherited

set the receiver's offset member to a UGen or a float

Definition at line 901 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_OFFSET, and csl::logMsg().

void Scalable::setOffset ( float  offset)
inherited

Reimplemented in csl::RandEnvelope.

Definition at line 908 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_OFFSET, and csl::logMsg().

void Scalable::trigger ( void  )
virtualinherited

trigger passed on here

Reimplemented in csl::RandEnvelope, csl::Abst_SoundFile, csl::Envelope, and csl::KarplusString.

Definition at line 917 of file CSL_Core.cpp.

References CSL_OFFSET, CSL_SCALE, and csl::Controllable::mInputs.

void csl::Scalable::isScaled ( )
inherited

answer whether scale = 1 & offset = 0

Port * Controllable::getPort ( CSL_MAP_KEY  name)
inherited
void Controllable::addInput ( CSL_MAP_KEY  name,
float  value 
)
protectedinherited

Plug in a float to the named input slot.

Definition at line 754 of file CSL_Core.cpp.

References csl::logMsg(), csl::Controllable::mInputs, and csl::Port::mValue.

void Controllable::pullInput ( Port thePort,
unsigned  numFrames 
) throw (CException)
protectedinherited

method to read the control values (in case they're dynamic). this sends nextBuffer() to the input.

Definition at line 695 of file CSL_Core.cpp.

References csl::kSamples, csl::logMsg(), csl::Buffer::mIsPopulated, csl::Buffer::mNumFrames, csl::Buffer::mType, csl::UnitGenerator::nextBuffer(), and csl::Buffer::zeroBuffers().

Referenced by csl::Panner::nextBuffer(), csl::NtoMPanner::nextBuffer(), and csl::Effect::pullInput().

void Controllable::pullInput ( Port thePort,
Buffer theBuffer 
) throw (CException)
protectedinherited

Definition at line 727 of file CSL_Core.cpp.

References csl::UnitGenerator::nextBuffer().

void Controllable::dump ( void  )
protectedvirtualinherited
void Seekable::reset ( ) throw (CException)
virtualinherited

reset-to-zero

Definition at line 1123 of file CSL_Core.cpp.

References csl::kPositionStart, and csl::Seekable::seekTo().


Friends And Related Function Documentation

friend class RingBuffer
friend

Allow RingBuffer to access private members of RingBufferTap.

Definition at line 24 of file RingBuffer.h.


Member Data Documentation

unsigned csl::RingBufferTap::mLoopStartFrame

Number of frames from the beginning to start a loop at.

Definition at line 30 of file RingBuffer.h.

Referenced by setLoopStart().

unsigned csl::RingBufferTap::mLoopEndFrame

Number of frames away from buffer end.

Definition at line 31 of file RingBuffer.h.

Referenced by setLoopEnd().

unsigned csl::RingBufferTap::mTempCurrentFrame
protected

Definition at line 46 of file RingBuffer.h.

RingBuffer* csl::RingBufferTap::mParentBuffer
protected

Definition at line 47 of file RingBuffer.h.

Referenced by duration(), setBuffer(), and setOffset().

unsigned csl::UnitGenerator::mNumChannels
protectedinherited
BufferCopyPolicy csl::UnitGenerator::mCopyPolicy
protectedinherited

the policy I use if asked for more or fewer channels

Definition at line 269 of file CSL_Core.h.

Referenced by csl::UnitGenerator::copyPolicy(), and csl::UnitGenerator::setCopyPolicy().

UGenVector csl::UnitGenerator::mOutputs
protectedinherited
unsigned csl::UnitGenerator::mNumOutputs
protectedinherited

the number of outputs

Definition at line 271 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput(), csl::UnitGenerator::numOutputs(), and csl::UnitGenerator::removeOutput().

Buffer* csl::UnitGenerator::mOutputCache
protectedinherited

my past output ring buffer (only used in case of fan-out)

Definition at line 272 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput().

unsigned csl::UnitGenerator::mSequence
protectedinherited

the highest-seen buffer seq number

Definition at line 273 of file CSL_Core.h.

double csl::Seekable::mActualFrame
inherited

where I actually am in the buffer

Definition at line 551 of file CSL_Core.h.


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