#include <Instrument.h>

Inheritance diagram for csl::Instrument:

Public Member Functions
	Instrument ()
	Constructors. More...

	Instrument (Instrument &)
	copy constructor More...

	~Instrument ()

UnitGenerator *	graph ()
	Accessors. More...

UGenMap *	genMap ()
	my UGen graph More...

UGenVector *	envelopes ()
	the map of ugens in the graph by name More...

const string	name ()
	the vector of envelopes to query or trigger More...

UnitGenerator *	genNamed (string name)
	answer my name answer the number of channels More...

AccessorVector	getAccessors ()
	Accessor management. More...

unsigned	numAccessors ()
	answer the accessor vector More...

virtual void	setParameter (unsigned selector, int argc, void *argv, const char types)
	answer the number of accessors More...

virtual void	nextBuffer (Buffer &outputBuffer) throw (CException)
	set a named parameter More...

virtual bool	isActive ()
	Envelope query and re-trigger. More...

virtual void	play ()

virtual void	playOSC (int argc, void *argv, const char types)

virtual void	playNote (int argc, void *argv, const char types)
	Play a note (subclasses refine) More...

virtual void	playMIDI (float dur, int chan, int key, int vel)

virtual void	release ()

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

Protected Member Functions
void	zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
	utility method to zero out an outputBuffer More...

Protected Attributes
UnitGenerator *	mGraph
	Caches. More...

string	mName
	my name More...

UGenMap	mUGens
	the map of ugens in the graph by name More...

UGenVector	mEnvelopes
	the vector of envelopes to query or trigger More...

AccessorVector	mAccessors
	the accessor vector 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...

Detailed Description

Instrument class (abstract)

Definition at line 56 of file Instrument.h.

Constructor & Destructor Documentation

Instrument::Instrument ( )

Constructors.

Definition at line 12 of file Instrument.cpp.

Instrument::Instrument ( Instrument & in )

copy constructor

Definition at line 22 of file Instrument.cpp.

References envelopes(), genMap(), getAccessors(), mAccessors, mEnvelopes, and mUGens.

Instrument::~Instrument ( )

Definition at line 37 of file Instrument.cpp.

Member Function Documentation

UnitGenerator* csl::Instrument::graph ( )

inline

Accessors.

Definition at line 63 of file Instrument.h.

References mGraph.

UGenMap* csl::Instrument::genMap ( )

inline

my UGen graph

Definition at line 64 of file Instrument.h.

References mUGens.

Referenced by Instrument().

UGenVector* csl::Instrument::envelopes ( )

inline

the map of ugens in the graph by name

Definition at line 65 of file Instrument.h.

References mEnvelopes.

Referenced by Instrument().

const string csl::Instrument::name ( )

inline

the vector of envelopes to query or trigger

Definition at line 67 of file Instrument.h.

References mName.

Referenced by setupOSCInstrLibrary().

UnitGenerator * Instrument::genNamed ( string name )

answer my name answer the number of channels

get a UGen from the graph

Definition at line 47 of file Instrument.cpp.

References mUGens.

AccessorVector csl::Instrument::getAccessors ( )

inline

Accessor management.

Definition at line 72 of file Instrument.h.

References mAccessors.

Referenced by Instrument(), and setupOSCInstrLibrary().

unsigned csl::Instrument::numAccessors ( )

inline

answer the accessor vector

Definition at line 73 of file Instrument.h.

References mAccessors.

Referenced by setupOSCInstrLibrary().

virtual void csl::Instrument::setParameter	(	unsigned	selector,
		int	argc,
		void **	argv,
		const char *	types
	)

inlinevirtual

answer the number of accessors

Reimplemented in csl::VAdditiveInstrument, csl::FancyFMInstrument, csl::FMInstrument, csl::SndFileInstrument, and csl::AdditiveInstrument.

Definition at line 74 of file Instrument.h.

Referenced by floatParamSetter(), intParamSetter(), csl::MIDIPlayer::start(), and stringParamSetter().

void Instrument::nextBuffer	(	Buffer &	outputBuffer	)
throw	(	CException
	)

virtual

set a named parameter

get a UGen from the graph

Sample creation

Reimplemented from csl::UnitGenerator.

Definition at line 41 of file Instrument.cpp.

bool Instrument::isActive ( )

virtual

Envelope query and re-trigger.

Reimplemented from csl::UnitGenerator.

Definition at line 57 of file Instrument.cpp.

References FALSE, csl::UnitGenerator::isActive(), mEnvelopes, mGraph, and TRUE.

Referenced by csl::MIDIPlayer::start().

void Instrument::play ( )

virtual

Reimplemented in csl::SampleBankInstrument, and csl::SndFileInstrument.

Definition at line 70 of file Instrument.cpp.

References mEnvelopes, and csl::UnitGenerator::trigger().

Referenced by csl::AdditiveInstrument::playMIDI(), csl::FMInstrument::playMIDI(), csl::FancyFMInstrument::playMIDI(), csl::AdditiveInstrument::playNote(), csl::FMInstrument::playNote(), playNote(), csl::AdditiveInstrument::playOSC(), csl::FMInstrument::playOSC(), csl::FancyFMInstrument::playOSC(), testFancyFMInstrument(), and testFMInstrument().

virtual void csl::Instrument::playOSC	(	int	argc,
		void **	argv,
		const char *	types
	)

inlinevirtual

Reimplemented in csl::SampleBankInstrument, csl::VAdditiveInstrument, csl::FancyFMInstrument, csl::FMInstrument, csl::SndFileInstrument, and csl::AdditiveInstrument.

Definition at line 81 of file Instrument.h.

Referenced by playWithArgs().

virtual void csl::Instrument::playNote	(	int	argc,
		void **	argv,
		const char *	types
	)

inlinevirtual

Play a note (subclasses refine)

Definition at line 82 of file Instrument.h.

virtual void csl::Instrument::playMIDI	(	float	dur,
		int	chan,
		int	key,
		int	vel
	)

inlinevirtual

Reimplemented in csl::VAdditiveInstrument, csl::FancyFMInstrument, csl::FMInstrument, and csl::AdditiveInstrument.

Definition at line 83 of file Instrument.h.

Referenced by csl::MIDIPlayer::start().

void Instrument::release ( )

virtual

Definition at line 76 of file Instrument.cpp.

References mEnvelopes, and csl::UnitGenerator::trigger().

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,
		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::Biquad, csl::Impulse, csl::Square, csl::AmbisonicEncoder, csl::Sawtooth, csl::FSine, csl::MulOp, csl::Envelope, csl::Filter, csl::Sine, csl::DynamicVariable, csl::AmbisonicRotator, csl::BufferStream, csl::CompOrCacheOscillator, csl::AddOp, csl::FIR, csl::WavetableOscillator, csl::PinkNoise, csl::VBAP, 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::Clipper, csl::Lorenz, csl::SimpleSine, csl::DistanceSimulator, and csl::WaveShaper.

Definition at line 755 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 271 of file CSL_Core.h.

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

virtualinherited

pretty-print the receiver

Reimplemented in csl::RandEnvelope, csl::SumOfSines, csl::SoundCue, csl::Abst_SoundFile, csl::Filter, csl::Envelope, csl::BufferStream, 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::Noise, and csl::CASoundFile.

Definition at line 693 of file CSL_Core.cpp.

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

Referenced by csl::Noise::dump(), csl::Clipper::dump(), csl::Filter::dump(), 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 288 of file CSL_Core.h.

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

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.