CSL  6.0
csl::KarplusString Class Reference

KarplusString – string model class. More...

#include <KarplusString.h>

+ Inheritance diagram for csl::KarplusString:

Public Member Functions

 KarplusString ()
 
 KarplusString (float frequency)
 
void setFrequency (float frequency)
 
void trigger ()
 reset internal buffers to re-pluck the string. More...
 
void dump ()
 print debugging info. More...
 
void nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
 The mono_next_buffer method does all the work. More...
 
virtual bool isActive ()
 query whether I'm currently active (Envelopes can go inactive) More...
 
unsigned frameRate ()
 
void setFrameRate (unsigned rate)
 get/set the receiver's frame rate More...
 
virtual unsigned numChannels ()
 
void setNumChannels (unsigned ch)
 get/set the receiver's number of outputs More...
 
BufferCopyPolicy copyPolicy ()
 
void setCopyPolicy (BufferCopyPolicy ch)
 get/set the receiver's buffer copy policy More...
 
virtual void nextBuffer (Buffer &outputBuffer) throw (CException)
 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. More...
 
virtual bool isFixed ()
 query whether I'm fixed (StaticVariable overrides this) More...
 
void addOutput (UnitGenerator *ugen)
 add to or return the UGen vector of outputs More...
 
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 More...
 
void handleFanOut (Buffer &outputBuffer) throw (CException)
 
virtual void setValue (sample theValue)
 set/get the value (not allowed in the abstract, useful for static values) More...
 
virtual sample value ()
 
void attachObserver (Observer *)
 (possibly notify obersvers on my death) More...
 
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 More...
 
virtual int evaluate (void *argument)
 
void setScale (UnitGenerator &scale)
 set the receiver's scale member to a UGen or a float More...
 
void setScale (float scale)
 
void setOffset (UnitGenerator &offset)
 set the receiver's offset member to a UGen or a float More...
 
void setOffset (float offset)
 
void isScaled ()
 answer whether scale = 1 & offset = 0 More...
 
PortgetPort (CSL_MAP_KEY name)
 
void setFrequency (UnitGenerator &frequency)
 Setter accessors. More...
 
void setPhase (float phase)
 

Public Attributes

Buffer mDelayLine
 the delay line (just a buffer, not a RingBuffer) More...
 

Protected Member Functions

void initDelayLine ()
 function to initialize the delay line More...
 
void zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
 utility method to zero out an outputBuffer More...
 
void addInput (CSL_MAP_KEY name, UnitGenerator &ugen)
 Plug in a unit generator to the named input slot. More...
 
void addInput (CSL_MAP_KEY name, float value)
 Plug in a float to the named input slot. More...
 
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. More...
 
void pullInput (Port *thePort, Buffer &theBuffer) throw (CException)
 

Protected Attributes

unsigned mIndex
 current index in the delay line More...
 
unsigned mDelayLength
 allocated size of the delay line More...
 
unsigned mEnergy
 energy left in buffer More...
 
float mFrequency
 
unsigned mFrameRate
 trigger ignored here More...
 
unsigned mNumChannels
 my "expected" number of output channels More...
 
BufferCopyPolicy mCopyPolicy
 the policy I use if asked for more or fewer channels More...
 
UGenVector mOutputs
 the vector of my output UGens More...
 
unsigned mNumOutputs
 the number of outputs More...
 
BuffermOutputCache
 my past output ring buffer (only used in case of fan-out) More...
 
unsigned mSequence
 the highest-seen buffer seq number More...
 
PortMap mInputs
 the map of my inputs or controls (used by the mix-in classes) More...
 
sample mPhase
 set phase More...
 

Detailed Description

KarplusString – string model class.

Definition at line 31 of file KarplusString.h.

Constructor & Destructor Documentation

KarplusString::KarplusString ( )

Definition at line 14 of file KarplusString.cpp.

References mEnergy, and mIndex.

KarplusString::KarplusString ( float  frequency)

Member Function Documentation

void KarplusString::setFrequency ( float  frequency)
void KarplusString::trigger ( void  )
virtual

reset internal buffers to re-pluck the string.

Reset time to 0.0 to restart envelope.

Reimplemented from csl::UnitGenerator.

Definition at line 28 of file KarplusString.cpp.

References csl::freqToKey(), mDelayLine, mEnergy, mFrequency, and csl::WhiteNoise::nextBuffer().

Referenced by testString().

void KarplusString::dump ( void  )
virtual

print debugging info.

Reimplemented from csl::UnitGenerator.

Definition at line 35 of file KarplusString.cpp.

References csl::Controllable::dump(), and csl::logMsg().

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

The mono_next_buffer method does all the work.

Reimplemented from csl::UnitGenerator.

Definition at line 59 of file KarplusString.cpp.

References DECLARE_SCALABLE_CONTROLS, LOAD_SCALABLE_CONTROLS, csl::logMsg(), and UPDATE_SCALABLE_CONTROLS.

virtual bool csl::KarplusString::isActive ( )
inlinevirtual

query whether I'm currently active (Envelopes can go inactive)

Reimplemented from csl::UnitGenerator.

Definition at line 41 of file KarplusString.h.

void KarplusString::initDelayLine ( )
protected

function to initialize the delay line

initialize and fill (with noise) the delay line

Definition at line 42 of file KarplusString.cpp.

References csl::Buffer::allocateBuffers(), mDelayLength, mDelayLine, mEnergy, mIndex, and csl::Buffer::setSize().

Referenced by KarplusString(), and setFrequency().

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

get/set the receiver's frame rate

Definition at line 250 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

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

get/set the receiver's number of outputs

Definition at line 253 of file CSL_Core.h.

References csl::UnitGenerator::mNumChannels.

Referenced by csl::BinauralPanner::BinauralPanner(), csl::Spatializer::Spatializer(), csl::VBAP::speakerLayoutChanged(), and csl::VBAP::VBAP().

BufferCopyPolicy csl::UnitGenerator::copyPolicy ( )
inlineinherited

Definition at line 255 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 271 of file CSL_Core.h.

UGenVector csl::UnitGenerator::outputs ( )
inlineinherited

Definition at line 277 of file CSL_Core.h.

References csl::UnitGenerator::mOutputs.

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

Definition at line 278 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 699 of file CSL_Core.cpp.

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

Definition at line 713 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 284 of file CSL_Core.h.

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

Reimplemented in csl::StaticVariable.

Definition at line 285 of file CSL_Core.h.

void UnitGenerator::zeroBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
)
protectedinherited

utility method to zero out an outputBuffer

Definition at line 663 of file CSL_Core.cpp.

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

void Model::attachObserver ( Observer o)
inherited

(possibly notify obersvers on my death)

register/remove observers

Definition at line 502 of file CGestalt.cpp.

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

Referenced by CSLMIDIComponent::CSLMIDIComponent(), and 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 540 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 270 of file CGestalt.h.

void Scalable::setScale ( float  scale)
inherited

Definition at line 1046 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 1053 of file CSL_Core.cpp.

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

void Scalable::setOffset ( float  offset)
inherited

Definition at line 1060 of file CSL_Core.cpp.

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

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 906 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 847 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 879 of file CSL_Core.cpp.

References csl::UnitGenerator::nextBuffer().

void csl::Phased::setPhase ( float  phase)
inlineinherited

Definition at line 507 of file CSL_Core.h.

References csl::Phased::mPhase.

Member Data Documentation

Buffer csl::KarplusString::mDelayLine

the delay line (just a buffer, not a RingBuffer)

Definition at line 41 of file KarplusString.h.

Referenced by initDelayLine(), and trigger().

unsigned csl::KarplusString::mIndex
protected

current index in the delay line

Definition at line 47 of file KarplusString.h.

Referenced by initDelayLine(), and KarplusString().

unsigned csl::KarplusString::mDelayLength
protected

allocated size of the delay line

Definition at line 48 of file KarplusString.h.

Referenced by initDelayLine(), KarplusString(), and setFrequency().

unsigned csl::KarplusString::mEnergy
protected

energy left in buffer

Definition at line 49 of file KarplusString.h.

Referenced by initDelayLine(), KarplusString(), setFrequency(), and trigger().

float csl::KarplusString::mFrequency
protected

Definition at line 50 of file KarplusString.h.

Referenced by KarplusString(), setFrequency(), and trigger().

BufferCopyPolicy csl::UnitGenerator::mCopyPolicy
protectedinherited

the policy I use if asked for more or fewer channels

Definition at line 293 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 295 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 296 of file CSL_Core.h.

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

unsigned csl::UnitGenerator::mSequence
protectedinherited

the highest-seen buffer seq number

Definition at line 297 of file CSL_Core.h.

sample csl::Phased::mPhase
protectedinherited

set phase

the actual phase accumulator

Definition at line 507 of file CSL_Core.h.

Referenced by csl::Phased::setPhase().


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