CSL  6.0
csl::Mixer Class Reference

Mixer – The n-input m-channel mixer class. More...

#include <Mixer.h>

+ Inheritance diagram for csl::Mixer:

Public Member Functions

 Mixer ()
 Constructors. More...
 
 Mixer (unsigned chans)
 
 Mixer (UnitGenerator &mScale)
 
 Mixer (unsigned chans, UnitGenerator &mScale)
 
virtual ~Mixer ()
 
UGenVectorgetInputs (void)
 
unsigned getNumInputs (void)
 list of inputs, arbitrary # of channels More...
 
void addInput (UnitGenerator &inp)
 
void addInput (UnitGenerator *inp)
 
void addInput (UnitGenerator &inp, float ampl)
 
void addInput (UnitGenerator *inp, float ampl)
 
void removeInput (UnitGenerator &inp)
 
void removeInput (UnitGenerator *inp)
 number of active inputs More...
 
void deleteInputs ()
 
void scaleInput (UnitGenerator &inp, float val)
 set the scale of an input More...
 
void nextBuffer (Buffer &outputBuffer) throw (CException)
 fill the buffer with the next buffer_length of values More...
 
void dump ()
 print info about this instance More...
 
unsigned activeSources ()
 
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, unsigned outBufNum) throw (CException)
 really compute the next buffer given an offset base channel; this is called by nextBuffer, possibly multiple times 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 ()
 
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)
 
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)
 
virtual void trigger ()
 trigger passed on here More...
 
void isScaled ()
 answer whether scale = 1 & offset = 0 More...
 
PortgetPort (CSL_MAP_KEY name)
 

Protected Member Functions

void allocateOpBuffer (unsigned chans)
 allocate the op buffer 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

UGenVector mSources
 mixers with inputs are always active More...
 
FloatVector mScaleValues
 scales of inputs More...
 
Buffer mOpBuffer
 buffer used for operations, if needed More...
 
bool hasScales
 set to true if any of the scale values != 1.0 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...
 
PortMap mInputs
 the map of my inputs or controls (used by the mix-in classes) More...
 

Detailed Description

Mixer – The n-input m-channel mixer class.

This is like a binary operator, except that it has an array of inputs and cycles through them for each output buffer. Clients can add and remove inputs at run-time.

Definition at line 21 of file Mixer.h.

Constructor & Destructor Documentation

Mixer::Mixer ( )

Constructors.

Definition at line 17 of file Mixer.cpp.

References allocateOpBuffer(), and csl::UnitGenerator::mNumChannels.

Mixer::Mixer ( unsigned  chans)

Definition at line 22 of file Mixer.cpp.

References allocateOpBuffer(), and csl::UnitGenerator::mNumChannels.

Mixer::Mixer ( UnitGenerator mScale)

Definition at line 27 of file Mixer.cpp.

References allocateOpBuffer(), and csl::UnitGenerator::mNumChannels.

Mixer::Mixer ( unsigned  chans,
UnitGenerator mScale 
)

Definition at line 32 of file Mixer.cpp.

References allocateOpBuffer(), and csl::UnitGenerator::mNumChannels.

Mixer::~Mixer ( )
virtual

Definition at line 37 of file Mixer.cpp.

References csl::Buffer::freeBuffers(), and mOpBuffer.

Member Function Documentation

UGenVector* csl::Mixer::getInputs ( void  )
inline

Definition at line 29 of file Mixer.h.

References mSources.

Referenced by testDynamicMixer().

unsigned Mixer::getNumInputs ( void  )

list of inputs, arbitrary # of channels

number of active inputs add/remove inputs

Definition at line 95 of file Mixer.cpp.

References mSources.

void Mixer::addInput ( UnitGenerator inp)

Definition at line 49 of file Mixer.cpp.

References csl::UnitGenerator::addOutput(), mScaleValues, and mSources.

void Mixer::addInput ( UnitGenerator inp,
float  ampl 
)

Definition at line 55 of file Mixer.cpp.

References csl::UnitGenerator::addOutput(), mScaleValues, and mSources.

void Mixer::addInput ( UnitGenerator inp,
float  ampl 
)

Definition at line 61 of file Mixer.cpp.

References csl::UnitGenerator::addOutput(), mScaleValues, and mSources.

void Mixer::removeInput ( UnitGenerator inp)

Definition at line 69 of file Mixer.cpp.

References mScaleValues, and mSources.

Referenced by csl::SimplePanner::removeSource(), and testDynamicMixer().

void Mixer::removeInput ( UnitGenerator inp)

number of active inputs

Definition at line 81 of file Mixer.cpp.

References mScaleValues, and mSources.

void Mixer::scaleInput ( UnitGenerator inp,
float  val 
)

set the scale of an input

Definition at line 102 of file Mixer.cpp.

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

Referenced by csl::SimplePanner::SimplePanner(), and testDynamicMixer().

void Mixer::nextBuffer ( Buffer outputBuffer)
throw (CException
)
virtual
void Mixer::dump ( void  )
virtual

print info about this instance

Reimplemented from csl::UnitGenerator.

Definition at line 232 of file Mixer.cpp.

References mSources.

unsigned Mixer::activeSources ( )

Definition at line 132 of file Mixer.cpp.

References mSources.

bool csl::Mixer::isActive ( )
inlinevirtual

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

Reimplemented from csl::UnitGenerator.

Definition at line 47 of file Mixer.h.

void Mixer::allocateOpBuffer ( unsigned  chans)
protected

allocate the op buffer

Definition at line 124 of file Mixer.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::blockSize(), csl::UnitGenerator::mNumChannels, mOpBuffer, and csl::Buffer::setSize().

Referenced by Mixer().

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.

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.

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 Scalable::trigger ( void  )
virtualinherited

trigger passed on here

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

Definition at line 1069 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 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().

Member Data Documentation

UGenVector csl::Mixer::mSources
protected

mixers with inputs are always active

vector of inputs, arbitrary # of channels

Definition at line 47 of file Mixer.h.

Referenced by activeSources(), addInput(), deleteInputs(), dump(), getInputs(), getNumInputs(), removeInput(), and scaleInput().

FloatVector csl::Mixer::mScaleValues
protected

scales of inputs

Definition at line 51 of file Mixer.h.

Referenced by addInput(), deleteInputs(), removeInput(), and scaleInput().

Buffer csl::Mixer::mOpBuffer
protected

buffer used for operations, if needed

Definition at line 52 of file Mixer.h.

Referenced by allocateOpBuffer(), and ~Mixer().

bool csl::Mixer::hasScales
protected

set to true if any of the scale values != 1.0

Definition at line 54 of file Mixer.h.

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.


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