CSL  6.0
csl::SimplePanner Class Reference

Simple Panner. More...

#include <SimplePanner.h>

+ Inheritance diagram for csl::SimplePanner:

Public Member Functions

 SimplePanner ()
 Default constructor. More...
 
 ~SimplePanner ()
 
void addSource (SpatialSource &s)
 Implement Panner's addSource, inserting a panner to each source. More...
 
void removeSource (SpatialSource &s)
 Remove a sound source. More...
 
virtual void nextBuffer (Buffer &outputBuffer) throw (CException)
 fill the buffer with the next buffer_length of values More...
 
 SimplePanner ()
 
 ~SimplePanner ()
 
void addSource (SpatialSource &s)
 Implement Panner's addSource, inserting a panner to each source. More...
 
void removeSource (SpatialSource &s)
 Remove a sound source. More...
 
void nextBuffer (Buffer &outputBuffer) throw (CException)
 fill the buffer with the next buffer_length of values More...
 
void setSpeakerLayout (SpeakerLayout *aLayout)
 Set the speaker layout to be used by this panner. The panner will request the default layout if not set. More...
 
unsigned numSources ()
 
virtual void update (void *arg)
 Called when the speaker layout changes. More...
 
virtual 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 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 bool isFixed ()
 query whether I'm fixed (StaticVariable overrides this) More...
 
virtual bool isActive ()
 query whether I'm currently active (Envelopes can go inactive) 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 ()
 
virtual void dump ()
 pretty-print the receiver More...
 
virtual void trigger ()
 
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)
 

Public Attributes

float mPeriod
 virtual destructor (don't notify or delete observers in this version) More...
 
int mKey
 key selector (e.g., MIDI chan) I receive update() mesages from my model; More...
 

Protected Member Functions

virtual void * cache ()
 create the cache More...
 
virtual void speakerLayoutChanged ()
 
void zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
 utility method to zero out an outputBuffer More...
 

Protected Attributes

Mixer mDryMix
 direct send mixer More...
 
Mixer mFiltMix
 LPF filter send mix. More...
 
Mixer mRevMix
 reverb send mixer More...
 
Splitter mFiltSplit
 stereo-to-mono splitter (for filters) More...
 
Butter mRLPF
 left & More...
 
Butter mLLPF
 right lo-pass filters More...
 
Joiner mFiltJoin
 mono-to-stereo joiner (for filters) More...
 
Stereoverb mReverb
 stereo freeverb More...
 
Mixer mOutMix
 master output mixer More...
 
UGenVector mPanners
 Vector of pointers to the panners. More...
 
UGenIMap mPanners
 Vector of pointers to the panners. More...
 
UGenIMap mFanOuts
 Vector of pointers to the fan-outs. More...
 
UGenVector mSources
 SpatialSource... refers to its input UGen, but with the knowledge of its position within a space. More...
 
vector< void * > mCache
 Vector of pointers to the prior I/O data. More...
 
SpeakerLayoutmSpeakerLayout
 If null, it will use the default layout by calling SpeakerLayout::defaultSpeakerLayout();. More...
 
Buffer mTempBuffer
 Buffer used to temporarily hold input source data. More...
 
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...
 

Detailed Description

Simple Panner.

Definition at line 16 of file SimplePanner.h.

Constructor & Destructor Documentation

csl::SimplePanner::SimplePanner ( )
csl::SimplePanner::~SimplePanner ( )

Definition at line 38 of file SimplePanner.cpp.

csl::SimplePanner::SimplePanner ( )
csl::SimplePanner::~SimplePanner ( )

Member Function Documentation

void csl::SimplePanner::addSource ( SpatialSource s)
virtual

Implement Panner's addSource, inserting a panner to each source.

Reimplemented from csl::SpatialPanner.

Definition at line 44 of file SimplePanner.cpp.

References csl::Mixer::addInput(), mDryMix, mFiltMix, mPanners, mRevMix, and csl::SpatialPanner::mSources.

void csl::SimplePanner::removeSource ( SpatialSource s)
virtual

Remove a sound source.

Reimplemented from csl::SpatialPanner.

Definition at line 56 of file SimplePanner.cpp.

References mDryMix, mFiltMix, mPanners, mRevMix, csl::SpatialPanner::mSources, and csl::Mixer::removeInput().

void csl::SimplePanner::nextBuffer ( Buffer outputBuffer)
throw (CException
)
virtual

fill the buffer with the next buffer_length of values

Implements csl::SpatialPanner.

Definition at line 75 of file SimplePanner.cpp.

References CSL_TWOPI.

void csl::SimplePanner::addSource ( SpatialSource s)
virtual

Implement Panner's addSource, inserting a panner to each source.

Reimplemented from csl::SpatialPanner.

void csl::SimplePanner::removeSource ( SpatialSource s)
virtual

Remove a sound source.

Reimplemented from csl::SpatialPanner.

void csl::SimplePanner::nextBuffer ( Buffer outputBuffer)
throw (CException
)
virtual

fill the buffer with the next buffer_length of values

Implements csl::SpatialPanner.

void SpatialPanner::setSpeakerLayout ( SpeakerLayout aLayout)
inherited

Set the speaker layout to be used by this panner. The panner will request the default layout if not set.

Definition at line 25 of file SpatialPanner.cpp.

References csl::Model::attachObserver(), csl::Model::detachObserver(), csl::SpatialPanner::mSpeakerLayout, and csl::SpatialPanner::speakerLayoutChanged().

Referenced by csl::SpatialPanner::SpatialPanner(), and csl::SpatialPanner::update().

unsigned csl::SpatialPanner::numSources ( )
inlineinherited

Definition at line 32 of file SpatialPanner.h.

References csl::SpatialPanner::mSources.

Referenced by csl::Spatializer::numSources().

void SpatialPanner::update ( void *  arg)
virtualinherited

Called when the speaker layout changes.

Called when the speaker layout changes, so panners update their data. This method is implemented only by the Panner class, and depending on the message sent, it calls the appropriate method implemented by subclasses. For example, when the speaker layout changes, the method calls "speakerLayoutChanged()", which should be implemented by subclasses interested to react to such change.

Implements csl::Observer.

Definition at line 83 of file SpatialPanner.cpp.

References csl::SpeakerLayout::defaultSpeakerLayout(), csl::SpatialPanner::mSpeakerLayout, csl::SpatialPanner::setSpeakerLayout(), and csl::SpatialPanner::speakerLayoutChanged().

virtual void csl::SpatialPanner::nextBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
)
throw (CException
)
inlinevirtualinherited

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

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::VBAP.

Definition at line 42 of file SpatialPanner.h.

void * SpatialPanner::cache ( )
protectedvirtualinherited

create the cache

Reimplemented in csl::VBAP, and csl::BinauralPanner.

Definition at line 72 of file SpatialPanner.cpp.

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

virtual void csl::SpatialPanner::speakerLayoutChanged ( )
inlineprotectedvirtualinherited

Reimplemented in csl::VBAP.

Definition at line 57 of file SpatialPanner.h.

Referenced by csl::SpatialPanner::setSpeakerLayout(), and csl::SpatialPanner::update().

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.

virtual bool csl::UnitGenerator::isActive ( )
inlinevirtualinherited
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.

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 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.

Member Data Documentation

Mixer csl::SimplePanner::mDryMix
protected

direct send mixer

direct (dry) send mixer

Definition at line 27 of file SimplePanner.h.

Referenced by addSource(), removeSource(), and SimplePanner().

Mixer csl::SimplePanner::mFiltMix
protected

LPF filter send mix.

Definition at line 28 of file SimplePanner.h.

Referenced by addSource(), and removeSource().

Mixer csl::SimplePanner::mRevMix
protected

reverb send mixer

Definition at line 29 of file SimplePanner.h.

Referenced by addSource(), and removeSource().

Splitter csl::SimplePanner::mFiltSplit
protected

stereo-to-mono splitter (for filters)

Definition at line 31 of file SimplePanner.h.

Butter csl::SimplePanner::mRLPF
protected

left &

Definition at line 32 of file SimplePanner.h.

Butter csl::SimplePanner::mLLPF
protected

right lo-pass filters

Definition at line 33 of file SimplePanner.h.

Joiner csl::SimplePanner::mFiltJoin
protected

mono-to-stereo joiner (for filters)

Definition at line 34 of file SimplePanner.h.

Referenced by SimplePanner().

Stereoverb csl::SimplePanner::mReverb
protected

stereo freeverb

Definition at line 36 of file SimplePanner.h.

Referenced by SimplePanner().

Mixer csl::SimplePanner::mOutMix
protected

master output mixer

Definition at line 37 of file SimplePanner.h.

Referenced by SimplePanner().

UGenVector csl::SimplePanner::mPanners
protected

Vector of pointers to the panners.

Definition at line 39 of file SimplePanner.h.

Referenced by addSource(), and removeSource().

UGenIMap csl::SimplePanner::mPanners
protected

Vector of pointers to the panners.

Definition at line 39 of file SimplePanner2.h.

UGenIMap csl::SimplePanner::mFanOuts
protected

Vector of pointers to the fan-outs.

Definition at line 40 of file SimplePanner2.h.

UGenVector csl::SpatialPanner::mSources
protectedinherited

SpatialSource... refers to its input UGen, but with the knowledge of its position within a space.

Vector of pointers to the inputs

Definition at line 49 of file SpatialPanner.h.

Referenced by addSource(), csl::SpatialPanner::addSource(), csl::SpatialPanner::numSources(), removeSource(), and csl::SpatialPanner::removeSource().

vector<void *> csl::SpatialPanner::mCache
protectedinherited

Vector of pointers to the prior I/O data.

Definition at line 50 of file SpatialPanner.h.

Referenced by csl::SpatialPanner::addSource(), and csl::SpatialPanner::removeSource().

Buffer csl::SpatialPanner::mTempBuffer
protectedinherited

Buffer used to temporarily hold input source data.

Definition at line 54 of file SpatialPanner.h.

Referenced by csl::SpatialPanner::SpatialPanner(), and csl::SpatialPanner::~SpatialPanner().

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.

float csl::Observer::mPeriod
inherited

virtual destructor (don't notify or delete observers in this version)

max update rate

Definition at line 299 of file CGestalt.h.

Referenced by csl::Model::attachObserver(), and csl::Observer::Observer().

int csl::Observer::mKey
inherited

key selector (e.g., MIDI chan) I receive update() mesages from my model;

Definition at line 302 of file CGestalt.h.

Referenced by csl::Model::attachObserver(), and csl::Observer::Observer().


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