BinaryOp – An Effect that takes two input sources (UnitGenerators or scalars) and gives a single UnitGenerator as its output. BinaryOp is an abstract class who's nextBuffer method is to be implemented by subclasses. More...

#include <BinaryOp.h>

Inheritance diagram for csl::BinaryOp:

Public Member Functions
	BinaryOp (UnitGenerator &op1, UnitGenerator &op2)
	The constructor for dual-UnitGenerator operation. More...

	BinaryOp (UnitGenerator &op1, float op2)
	Constructuctor for operating a UnitGenerator and a fixed float. More...

	BinaryOp (float op1, UnitGenerator &op2)
	The same constructor, but with UGen and float inputs. More...

virtual	~BinaryOp ()
	The destructor. More...

void	dump ()
	Prints instance info. More...

void	setOperand (float op)
	Set the operand from a fixed float. More...

virtual bool	isActive ()
	am I active? More...

void	setInput (UnitGenerator &inp)
	set the receiver's input generator More...

void	setInline ()
	set the Effect to be inline 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...

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)

Port *	getPort (CSL_MAP_KEY name)

Public Attributes
bool	isInline
	whether to use input or buffer as source More...

Protected Member Functions
virtual void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum)=0 throw (CException)
	Abstract function that will do the processing for each buffer. More...

bool	isFixed ()
	Is the input fixed or a dynamic UnitGenerator? More...

bool	inputIsFixed ()

bool	operandIsFixed ()
	Is the operand fixed or a dynamic UnitGenerator? More...

sample	operandFixedValue (Buffer &outputBuffer)
	Convert the dynamic operand to a fixed sample (if operand is fixed) More...

void	pullInput (Buffer &outputBuffer) throw (CException)

void	pullInput (unsigned numFrames) throw (CException)
	trigger passed on here 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)

virtual void	trigger ()
	trigger passed on here get the input port More...

Port *	inPort ()

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

Protected Attributes
SampleBuffer	mInputPtr
	A pointer to my input's data. method to read the input value. 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...

Buffer *	mOutputCache
	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

BinaryOp – An Effect that takes two input sources (UnitGenerators or scalars) and gives a single UnitGenerator as its output. BinaryOp is an abstract class who's nextBuffer method is to be implemented by subclasses.

Definition at line 25 of file BinaryOp.h.

Constructor & Destructor Documentation

BinaryOp::BinaryOp	(	UnitGenerator &	op1,
		UnitGenerator &	op2
	)

The constructor for dual-UnitGenerator operation.

Definition at line 11 of file BinaryOp.cpp.

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

BinaryOp::BinaryOp	(	UnitGenerator &	op1,
		float	op2
	)

Constructuctor for operating a UnitGenerator and a fixed float.

Definition at line 18 of file BinaryOp.cpp.

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

BinaryOp::BinaryOp	(	float	op1,
		UnitGenerator &	op2
	)

The same constructor, but with UGen and float inputs.

Definition at line 25 of file BinaryOp.cpp.

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

BinaryOp::~BinaryOp ( )

virtual

The destructor.

Definition at line 32 of file BinaryOp.cpp.

Member Function Documentation

void BinaryOp::dump ( void )

virtual

Prints instance info.

Reimplemented from csl::UnitGenerator.

Definition at line 54 of file BinaryOp.cpp.

References CSL_OPERAND, csl::Port::dump(), csl::Effect::inPort(), and csl::Controllable::mInputs.

Referenced by testScaledSin().

void BinaryOp::setOperand ( float op )

Set the operand from a fixed float.

Definition at line 45 of file BinaryOp.cpp.

References CSL_OPERAND, csl::Controllable::mInputs, csl::Port::mUGen, and csl::Port::mValue.

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

protectedpure virtual

Abstract function that will do the processing for each buffer.

Reimplemented from csl::UnitGenerator.

Implemented in csl::MulOp, and csl::AddOp.

bool BinaryOp::isFixed ( )

inlineprotectedvirtual

Is the input fixed or a dynamic UnitGenerator?

Reimplemented from csl::UnitGenerator.

Definition at line 39 of file BinaryOp.cpp.

References inputIsFixed(), and operandIsFixed().

bool csl::BinaryOp::inputIsFixed ( )

inlineprotected

Definition at line 51 of file BinaryOp.h.

References csl::Effect::inPort().

Referenced by isFixed().

bool csl::BinaryOp::operandIsFixed ( )

inlineprotected

Is the operand fixed or a dynamic UnitGenerator?

Definition at line 55 of file BinaryOp.h.

References CSL_OPERAND, and csl::Controllable::mInputs.

Referenced by isFixed().

sample csl::BinaryOp::operandFixedValue ( Buffer & outputBuffer )

inlineprotected

Convert the dynamic operand to a fixed sample (if operand is fixed)

bool Effect::isActive ( )

virtualinherited

am I active?

Reimplemented from csl::UnitGenerator.

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

Definition at line 1105 of file CSL_Core.cpp.

References CSL_INPUT, csl::Port::isActive(), and csl::Controllable::mInputs.

Referenced by csl::Stereoverb::isActive().

void Effect::setInput ( UnitGenerator & inp )

inherited

set the receiver's input generator

Definition at line 1112 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_INPUT, csl::Effect::isInline, and csl::logMsg().

void csl::Effect::setInline ( )

inlineinherited

set the Effect to be inline

Definition at line 476 of file CSL_Core.h.

void Effect::pullInput	(	Buffer &	outputBuffer	)
throw	(	CException
	)

protectedinherited

Definition at line 1122 of file CSL_Core.cpp.

References CSL_INPUT, csl::logMsg(), and csl::Controllable::pullInput().

Referenced by csl::Convolver2::nextBuffer(), csl::Convolver::nextBuffer(), csl::InOut::nextBuffer(), csl::RingBuffer::nextBuffer(), csl::Panner::nextBuffer(), csl::FIR::nextBuffer(), csl::DynamicVariable::nextBuffer(), csl::Filter::nextBuffer(), csl::NtoMPanner::nextBuffer(), csl::StereoWidth::nextBuffer(), csl::Biquad::nextBuffer(), and SAFliter::nextBuffer().

void Effect::pullInput	(	unsigned	numFrames	)
throw	(	CException
	)

protectedinherited

trigger passed on here

Definition at line 1137 of file CSL_Core.cpp.

References csl::Buffer::buffer(), CSL_INPUT, csl::logMsg(), csl::Port::mBuffer, and csl::Controllable::pullInput().

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

protectedvirtualinherited

trigger passed on here get the input port

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::Joiner.

Definition at line 1148 of file CSL_Core.cpp.

References CSL_INPUT, and csl::Controllable::mInputs.

Port* csl::Effect::inPort ( )

inlineprotectedinherited

Definition at line 485 of file CSL_Core.h.

References CSL_INPUT.

Referenced by dump(), and inputIsFixed().

unsigned csl::UnitGenerator::frameRate ( )

inlineinherited

Definition at line 249 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by csl::CASoundFile::dump(), csl::Abst_SoundFile::dump(), and csl::SoundCue::dump().

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.

virtual unsigned csl::UnitGenerator::numChannels ( )

inlinevirtualinherited

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

Definition at line 252 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(), csl::Mixer::nextBuffer(), csl::Convolver2::setIRFile(), csl::Convolver::setIRFile(), and csl::SpatialSource::SpatialSource().

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

get/set the receiver's buffer copy policy

Definition at line 256 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	)
throw	(	CException
	)

virtualinherited

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 in csl::Joiner, csl::Splitter, csl::FanOut, csl::SoundCue, csl::Stereoverb, csl::StereoWidth, csl::Abst_SoundFile, csl::NtoMPanner, csl::RemoteStream, csl::BufferStream, csl::LSoundFile, csl::GrainPlayer, csl::Panner, csl::RingBuffer, csl::Instrument, csl::VBAP, csl::IFFT, csl::SpatialSource, csl::BinauralPanner, csl::InOut, csl::Spatializer, csl::Mixer, csl::SpatialPanner, csl::RingBufferTap, csl::Convolver, csl::AmbisonicPanner, csl::Convolver2, csl::FFT, csl::BlockResizer, csl::DelayLine, csl::SimplePanner, csl::SimplePanner, and csl::Microphone.

Definition at line 726 of file CSL_Core.cpp.

References csl::kCopy, csl::kExpand, csl::kIgnore, and csl::logMsg().

Referenced by csl::DistanceSimulator::nextBuffer(), csl::RingBufferTap::nextBuffer(), csl::Mixer::nextBuffer(), csl::AmbisonicMixer::nextBuffer(), csl::SpatialSource::nextBuffer(), csl::BufferStream::nextBuffer(), csl::Controllable::pullInput(), csl::PAIO::test(), and csl::FileIO::writeNextBuffer().

void UnitGenerator::addOutput ( UnitGenerator * ugen )

inherited

add to or return the UGen vector of outputs

Definition at line 670 of file CSL_Core.cpp.

References csl::Buffer::allocateBuffers(), csl::CGestalt::blockSize(), 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 680 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 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

Definition at line 518 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 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.

Port * Controllable::getPort ( CSL_MAP_KEY name )

inherited

Definition at line 920 of file CSL_Core.cpp.

References csl::Controllable::mInputs.

Referenced by csl::FrequencyAmount::getFrequency(), and csl::VSTIO::getParameter().