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

#include <Mixer.h>

Inheritance diagram for csl::Mixer:

Public Member Functions
	Mixer ()
	Constructors.
	Mixer (unsigned chans)
	Mixer (UnitGenerator &mScale)
	Mixer (unsigned chans, UnitGenerator &mScale)
virtual	~Mixer ()
UGenVector *	getInputs (void)
unsigned	getNumInputs (void)
	list of inputs, arbitrary # of channels
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
void	deleteInputs ()
void	scaleInput (UnitGenerator &inp, float val)
	set the scale of an input
void	nextBuffer (Buffer &outputBuffer) throw (CException)
	fill the buffer with the next buffer_length of values
void	dump ()
	print info about this instance
unsigned	activeSources ()
bool	isActive ()
	query whether I'm currently active (Envelopes can go inactive)
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 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
virtual bool	isFixed ()
	query whether I'm fixed (StaticVariable overrides this)
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	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
Port *	getPort (CSL_MAP_KEY name)

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

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

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 43 of file Mixer.cpp.

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

Referenced by addSndtoBank(), csl::SimplePanner::addSource(), csl::SimplePanner::SimplePanner(), test50RandFreqEnv(), test_SHARC2(), test_SimpleP(), testBigPanMix(), testDynamicMixer(), testFanMix1(), testFanMix2(), testManyRandSOS(), testMultiTap(), testNDynamicFilters(), testOscBank(), testPanMix(), testSineMixer(), testSplitJoin2(), and testStringChorus().

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::deleteInputs ( )

Definition at line 114 of file Mixer.cpp.

References mScaleValues, and mSources.

Referenced by test50RandFreqEnv(), testBigPanMix(), testDynamicMixer(), testManyRandSOS(), testNDynamicFilters(), and testOscBank().

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

fill the buffer with the next buffer_length of values

Reimplemented from csl::UnitGenerator.

Definition at line 150 of file Mixer.cpp.

References DECLARE_SCALABLE_CONTROLS, csl::UnitGenerator::isActive(), csl::kLogError, LOAD_SCALABLE_CONTROLS, csl::logMsg(), csl::UnitGenerator::nextBuffer(), csl::UnitGenerator::numChannels(), and UPDATE_SCALABLE_CONTROLS.

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

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

void UnitGenerator::nextBuffer	(	Buffer &	outputBuffer,
		unsigned	outBufNum
	)		throw (CException)

virtualinherited

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

Reimplemented in csl::Joiner, csl::Splitter, csl::FanOut, SAFliter, csl::RandEnvelope, csl::Moog, csl::AmbisonicDecoder, csl::Impulse, csl::Square, csl::AmbisonicEncoder, csl::Sawtooth, csl::FSine, csl::MulOp, csl::Envelope, csl::Sine, csl::DynamicVariable, csl::Filter, csl::AmbisonicRotator, csl::CompOrCacheOscillator, csl::BufferStream, csl::AddOp, csl::FIR, csl::WavetableOscillator, csl::PinkNoise, csl::VBAP, csl::RtpReceiver, csl::SineAsScaled, csl::SpatialSource, csl::LineSegment, csl::StaticVariable, csl::AmbisonicMixer, csl::WhiteNoise, csl::SineAsPhased, csl::SpatialPanner, csl::Window, csl::RingBufferTap, csl::BinaryOp, csl::Freeverb, csl::KarplusString, csl::RtpSender, csl::Clipper, csl::Lorenz, csl::SimpleSine, csl::DistanceSimulator, and csl::WaveShaper.

Definition at line 605 of file CSL_Core.cpp.

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.

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

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

void Model::detachObserver ( Observer * o )

inherited

Definition at line 507 of file CGestalt.cpp.

References csl::logMsg().

Referenced by csl::SpatialPanner::setSpeakerLayout(), and csl::SpatialPanner::~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.

void Scalable::setScale ( UnitGenerator & scale )

inherited

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

Definition at line 887 of file CSL_Core.cpp.

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