CSL  5.2
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
csl::SpatialPanner Class Reference

Base class for all panners. Handles source management and holds a speaker layout. More...

#include <SpatialPanner.h>

+ Inheritance diagram for csl::SpatialPanner:

List of all members.

Public Member Functions

 SpatialPanner (SpeakerLayout *layout=SpeakerLayout::defaultSpeakerLayout())
 Constructor - a SpeakerLayout can be specified.
virtual ~SpatialPanner ()
void setSpeakerLayout (SpeakerLayout *aLayout)
 Set the speaker layout to be used by this panner. The panner will request the default layout if not set.
unsigned numSources ()
virtual void addSource (SpatialSource &s)
 number of active inputs.
virtual void removeSource (SpatialSource &s)
 Remove a Sound Source.
virtual void update (void *arg)
 Called when the speaker layout changes.
virtual void nextBuffer (Buffer &outputBuffer)=0 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.
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
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)

Public Attributes

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

Protected Member Functions

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

Protected Attributes

UGenVector mSources
 SpatialSource... refers to its input UGen, but with the knowledge of its position within a space.
vector< void * > mCache
 Vector of pointers to the prior I/O data.
SpeakerLayout * mSpeakerLayout
 If null, it will use the default layout by calling SpeakerLayout::defaultSpeakerLayout();.
Buffer mTempBuffer
 Buffer used to temporarily hold input source data.
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
Buffer * mOutputCache
 my past output ring buffer (only used in case of fan-out)
unsigned mSequence
 the highest-seen buffer seq number

Detailed Description

Base class for all panners. Handles source management and holds a speaker layout.

Todo:
Update all Panners so that they rebuild their caches when changing the speaker layout.

Definition at line 22 of file SpatialPanner.h.

Constructor & Destructor Documentation

SpatialPanner::SpatialPanner ( SpeakerLayout *  layout = SpeakerLayout::defaultSpeakerLayout())

Constructor - a SpeakerLayout can be specified.

Definition at line 11 of file SpatialPanner.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::blockSize(), mTempBuffer, csl::Buffer::setSize(), and setSpeakerLayout().

SpatialPanner::~SpatialPanner ( )
virtual

Definition at line 20 of file SpatialPanner.cpp.

References csl::Model::detachObserver(), csl::Buffer::freeBuffers(), mSpeakerLayout, and mTempBuffer.

Member Function Documentation

void SpatialPanner::setSpeakerLayout ( SpeakerLayout *  aLayout)

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(), mSpeakerLayout, and speakerLayoutChanged().

Referenced by SpatialPanner(), and update().

unsigned csl::SpatialPanner::numSources ( )
inline

Definition at line 32 of file SpatialPanner.h.

References mSources.

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

void SpatialPanner::addSource ( SpatialSource &  s)
virtual

number of active inputs.

Add a souce to the list of inputs to be processed and create a cache object

Reimplemented in csl::AmbisonicPanner, csl::SimplePanner, and csl::SimplePanner.

Definition at line 41 of file SpatialPanner.cpp.

References cache(), mCache, and mSources.

Referenced by csl::Spatializer::addSource(), main(), and csl::Spatializer::setPanningMode().

void SpatialPanner::removeSource ( SpatialSource &  s)
virtual

Remove a Sound Source.

Reimplemented in csl::AmbisonicPanner, csl::SimplePanner, and csl::SimplePanner.

Definition at line 56 of file SpatialPanner.cpp.

References csl::logMsg(), mCache, and mSources.

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

void SpatialPanner::update ( void *  arg)
virtual

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(), mSpeakerLayout, setSpeakerLayout(), and speakerLayoutChanged().

virtual void csl::SpatialPanner::nextBuffer ( Buffer &  outputBuffer) throw (CException)
pure 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.

Implemented in csl::VBAP, csl::BinauralPanner, csl::AmbisonicPanner, csl::SimplePanner, and csl::SimplePanner.

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

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 ( )
protectedvirtual

create the cache

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

Definition at line 72 of file SpatialPanner.cpp.

Referenced by addSource().

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

Reimplemented in csl::VBAP.

Definition at line 57 of file SpatialPanner.h.

Referenced by setSpeakerLayout(), and update().

unsigned csl::UnitGenerator::frameRate ( )
inlineinherited

Definition at line 225 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by csl::CASoundFile::dump(), csl::Abst_SoundFile::dump(), csl::SoundCue::dump(), csl::Filter::init(), csl::SndFileInstrument::playNote(), and csl::SndFileInstrument::playOSC().

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

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

Reimplemented in csl::Splitter, and csl::Stereoverb.

Definition at line 228 of file CSL_Core.h.

References csl::UnitGenerator::mNumChannels.

Referenced by csl::AmbisonicMixer::addInput(), csl::BlockResizer::BlockResizer(), csl::Port::checkBuffer(), csl::Effect::Effect(), csl::AmbisonicRotator::initialize(), csl::AmbisonicDecoder::initialize(), m3_output(), csl::Mixer::nextBuffer(), and csl::SpatialSource::SpatialSource().

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

get/set the receiver's number of outputs

Definition at line 229 of file CSL_Core.h.

References csl::UnitGenerator::mNumChannels.

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

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

get/set the receiver's buffer copy policy

Definition at line 232 of file CSL_Core.h.

References csl::UnitGenerator::mCopyPolicy.

Referenced by csl::AmbisonicPanner::AmbisonicPanner(), csl::BinauralPanner::BinauralPanner(), csl::AmbisonicUnitGenerator::initOrder(), csl::Noise::Noise(), csl::PinkNoise::PinkNoise(), csl::Spatializer::Spatializer(), and csl::VBAP::VBAP().

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

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

Reimplemented in csl::Joiner, csl::Effect, csl::RandEnvelope, csl::SoundCue, csl::Stereoverb, csl::Abst_SoundFile, csl::Envelope, csl::Instrument, csl::Mixer, and csl::KarplusString.

Definition at line 249 of file CSL_Core.h.

Referenced by csl::Instrument::isActive(), csl::Port::isActive(), csl::Mixer::nextBuffer(), csl::BinauralPanner::nextBuffer(), csl::AmbisonicMixer::nextBuffer(), and csl::VBAP::nextBuffer().

void UnitGenerator::addOutput ( UnitGenerator *  ugen)
inherited

add to or return the UGen vector of outputs

Definition at line 520 of file CSL_Core.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::maxBufferFrames(), csl::UnitGenerator::mNumOutputs, csl::UnitGenerator::mOutputCache, and csl::UnitGenerator::mOutputs.

Referenced by csl::Mixer::addInput(), csl::Controllable::addInput(), csl::AmbisonicRotator::initialize(), csl::AmbisonicDecoder::initialize(), csl::AmbisonicEncoder::setInput(), and csl::IO::setRoot().

void UnitGenerator::removeOutput ( UnitGenerator *  ugen)
inherited

Definition at line 530 of file CSL_Core.cpp.

References csl::UnitGenerator::mNumOutputs, and csl::UnitGenerator::mOutputs.

Referenced by csl::IO::clearRoot(), csl::AmbisonicEncoder::setInput(), csl::AmbisonicDecoder::~AmbisonicDecoder(), and csl::AmbisonicRotator::~AmbisonicRotator().

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.

void UnitGenerator::dump ( void  )
virtualinherited

pretty-print the receiver

Reimplemented in csl::RandEnvelope, csl::SumOfSines, csl::SoundCue, csl::Abst_SoundFile, csl::Envelope, csl::Filter, csl::VBAP, csl::SineAsScaled, csl::LineSegment, csl::SpatialSource, csl::SineAsPhased, csl::Mixer, csl::Window, csl::KarplusString, csl::Oscillator, csl::AmbisonicPanner, csl::BinaryOp, csl::Lorenz, csl::Clipper, csl::CASoundFile, and csl::Noise.

Definition at line 543 of file CSL_Core.cpp.

References csl::logMsg(), and csl::UnitGenerator::mOutputs.

Referenced by csl::Port::dump(), dumpTest(), and testSimpleSines().

virtual void csl::UnitGenerator::trigger ( void  )
inlinevirtualinherited

Reimplemented in csl::Joiner, csl::Effect, csl::RandEnvelope, csl::SoundCue, csl::Abst_SoundFile, csl::Envelope, csl::LineSegment, and csl::KarplusString.

Definition at line 264 of file CSL_Core.h.

Referenced by csl::Instrument::play(), csl::Instrument::release(), and csl::Port::trigger().

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 setSpeakerLayout().

void Model::detachObserver ( Observer *  o)
inherited

Definition at line 507 of file CGestalt.cpp.

References csl::logMsg().

Referenced by setSpeakerLayout(), and ~SpatialPanner().

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.

Member Data Documentation

UGenVector csl::SpatialPanner::mSources
protected

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 csl::SimplePanner::addSource(), addSource(), numSources(), csl::SimplePanner::removeSource(), and removeSource().

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

Vector of pointers to the prior I/O data.

Definition at line 50 of file SpatialPanner.h.

Referenced by addSource(), and removeSource().

SpeakerLayout* csl::SpatialPanner::mSpeakerLayout
protected

If null, it will use the default layout by calling SpeakerLayout::defaultSpeakerLayout();.

Definition at line 52 of file SpatialPanner.h.

Referenced by setSpeakerLayout(), csl::VBAP::speakerLayoutChanged(), update(), csl::VBAP::VBAP(), ~SpatialPanner(), csl::StereoPanner::~StereoPanner(), and csl::SurroundPanner::~SurroundPanner().

Buffer csl::SpatialPanner::mTempBuffer
protected

Buffer used to temporarily hold input source data.

Definition at line 54 of file SpatialPanner.h.

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

unsigned csl::UnitGenerator::mFrameRate
protectedinherited

trigger ignored here

the frame rate – initialized to be the default by the constructor

Definition at line 264 of file CSL_Core.h.

Referenced by csl::Abst_SoundFile::convertRate(), csl::RtpSender::createRtpSession(), csl::RtpReceiver::createRtpSession(), csl::Lorenz::dump(), csl::Abst_SoundFile::durationInSecs(), csl::UnitGenerator::frameRate(), csl::Filter::init(), csl::CASoundFile::initFromSndfile(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), csl::RandEnvelope::nextSegment(), csl::SquareBL::nextWaveInto(), csl::SumOfSines::nextWaveInto(), csl::CASoundFile::openForRead(), csl::MP3File::openForRead(), csl::DelayLine::setDelayTime(), csl::UnitGenerator::setFrameRate(), csl::Abst_SoundFile::setStartSec(), csl::Abst_SoundFile::setStopSec(), csl::Butter::setupCoeffs(), csl::Formant::setupCoeffs(), csl::Notch::setupCoeffs(), csl::Moog::setupCoeffs(), and csl::DecodedFile::writeBuffer().

unsigned csl::UnitGenerator::mNumChannels
protectedinherited

my "expected" number of output channels

Definition at line 268 of file CSL_Core.h.

Referenced by csl::AmbisonicMixer::addInput(), csl::Mixer::allocateOpBuffer(), csl::AmbisonicDecoder::asProjection(), csl::AmbisonicDecoder::asPseudoInverse(), csl::BlockResizer::BlockResizer(), csl::Abst_SoundFile::channels(), csl::Abst_SoundFile::checkBuffer(), csl::DecodedFile::checkBufferStack(), csl::FMInstrument::FMInstrument(), csl::GrainPlayer::GrainPlayer(), csl::AdditiveInstrument::init(), csl::JSoundFile::initFromSndfile(), csl::LSoundFile::initFromSndfile(), csl::AmbisonicMixer::initialize(), csl::SndFileInstrument::initialize(), csl::AmbisonicRotator::initialize(), csl::AmbisonicEncoder::initialize(), csl::AmbisonicDecoder::initialize(), csl::AmbisonicUnitGenerator::initOrder(), csl::RemoteStream::initPacket(), csl::Joiner::isActive(), csl::AmbisonicDecoder::makeInPhase(), csl::AmbisonicDecoder::makeMaxRE(), csl::DecodedFile::mergeBuffers(), csl::Abst_SoundFile::mergeToMono(), csl::Mixer::Mixer(), csl::UnitGenerator::numChannels(), csl::CASoundFile::openForRead(), csl::MP3File::openForRead(), csl::Panner::Panner(), csl::CASoundFile::readBufferFromFile(), csl::JSoundFile::readBufferFromFile(), csl::LSoundFile::readBufferFromFile(), csl::RemoteStream::RemoteStream(), csl::UnitGenerator::setNumChannels(), csl::WavetableOscillator::setWaveform(), csl::Joiner::trigger(), csl::DecodedFile::writeBuffer(), and csl::AmbisonicRotator::~AmbisonicRotator().

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

the vector of my output UGens

Definition at line 270 of file CSL_Core.h.

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

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.

float csl::Observer::mPeriod
inherited

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

max update rate

Definition at line 286 of file CGestalt.h.

Referenced by csl::Model::attachObserver().

int csl::Observer::mKey
inherited

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

Definition at line 289 of file CGestalt.h.

Referenced by csl::Model::attachObserver().

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