#include <BasicFMInstrument.h>

Inheritance diagram for csl::FMInstrument:

Public Member Functions
	FMInstrument ()
	Constructor. More...

	FMInstrument (FMInstrument &)
	copy constructor More...

	~FMInstrument ()

virtual void	setParameter (unsigned selector, int argc, void *argv, const char types)
	Plug functions. More...

void	parseArgs (int argc, void *argv, const char types)
	Play functions. More...

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

void	playNote (float dur=1, float ampl=1, float c_fr=110, float m_fr=110, float ind=1, float pos=0, float att=0.1, float dec=0.1, float sus=0.5, float rel=0.1, float i_att=0.1, float i_dec=0.1, float i_sus=0.5, float i_rel=0.1)

void	playMIDI (float dur, int chan, int key, int vel)
	These are the UGens of the DSP graph (i.e., the FM instrument) More...

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	nextBuffer (Buffer &outputBuffer) throw (CException)
	set a named parameter 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	isActive ()
	Envelope query and re-trigger. More...

virtual void	play ()

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

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

Public Attributes
ADSR	mAEnv

ADSR	mIEnv
	amplitude & modulation index envelopes More...

Osc	mCar

Osc	mMod
	2 sine oscillators, carrier and modulator More...

Panner	mPanner
	stereo panner More...

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

FMInstrument.

Definition at line 40 of file BasicFMInstrument.h.

Constructor & Destructor Documentation

FMInstrument::FMInstrument ( )

Constructor.

Definition at line 20 of file BasicFMInstrument.cpp.

References BASE_FREQ, CSL_FLOAT_TYPE, csl::Instrument::mAccessors, mAEnv, mCar, csl::Instrument::mEnvelopes, csl::Instrument::mGraph, mIEnv, mMod, csl::Instrument::mName, csl::UnitGenerator::mNumChannels, mPanner, csl::Instrument::mUGens, csl::Envelope::scaleValues(), set_amplitude_f, set_attack_f, set_c_freq_f, set_decay_f, set_duration_f, set_iattack_f, set_idecay_f, set_index_f, set_irelease_f, set_isustain_f, set_m_freq_f, set_position_f, set_release_f, and set_sustain_f.

FMInstrument::FMInstrument ( FMInstrument & in )

copy constructor

Definition at line 63 of file BasicFMInstrument.cpp.

FMInstrument::~FMInstrument ( )

Definition at line 73 of file BasicFMInstrument.cpp.

Member Function Documentation

void FMInstrument::setParameter	(	unsigned	selector,
		int	argc,
		void **	argv,
		const char *	types
	)

virtual

Plug functions.

Reimplemented from csl::Instrument.

Reimplemented in csl::FancyFMInstrument.

Definition at line 77 of file BasicFMInstrument.cpp.

References csl::kLogError, csl::logMsg(), mAEnv, mIEnv, mMod, mPanner, csl::Envelope::scaleValues(), set_amplitude_f, set_attack_f, set_c_freq_f, set_decay_f, set_duration_f, set_iattack_f, set_idecay_f, set_index_f, set_irelease_f, set_isustain_f, set_m_freq_f, set_position_f, set_release_f, set_sustain_f, csl::ADSR::setAttack(), csl::ADSR::setDecay(), csl::ADSR::setDuration(), csl::Panner::setPosition(), csl::ADSR::setRelease(), and csl::ADSR::setSustain().

Referenced by csl::FancyFMInstrument::setParameter(), and testFMInstrument().

void FMInstrument::parseArgs	(	int	argc,
		void **	argv,
		const char *	types
	)

Play functions.

Definition at line 130 of file BasicFMInstrument.cpp.

References csl::kLogError, csl::logMsg(), mAEnv, mIEnv, mMod, mPanner, csl::Envelope::scaleValues(), csl::ADSR::setAttack(), csl::ADSR::setDecay(), csl::ADSR::setDuration(), csl::Panner::setPosition(), csl::ADSR::setRelease(), csl::Scalable::setScale(), and csl::ADSR::setSustain().

Referenced by playOSC(), and csl::FancyFMInstrument::playOSC().

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

virtual

Reimplemented from csl::Instrument.

Reimplemented in csl::FancyFMInstrument.

Definition at line 177 of file BasicFMInstrument.cpp.

References parseArgs(), and csl::Instrument::play().

void FMInstrument::playNote	(	float	dur = `1`,
		float	ampl = `1`,
		float	c_fr = `110`,
		float	m_fr = `110`,
		float	ind = `1`,
		float	pos = `0`,
		float	att = `0.1`,
		float	dec = `0.1`,
		float	sus = `0.5`,
		float	rel = `0.1`,
		float	i_att = `0.1`,
		float	i_dec = `0.1`,
		float	i_sus = `0.5`,
		float	i_rel = `0.1`
	)

Definition at line 184 of file BasicFMInstrument.cpp.

References mAEnv, mIEnv, mMod, mPanner, csl::Instrument::play(), csl::Envelope::scaleValues(), csl::ADSR::setAttack(), csl::ADSR::setDecay(), csl::ADSR::setDuration(), csl::Panner::setPosition(), csl::ADSR::setRelease(), and csl::ADSR::setSustain().

void FMInstrument::playMIDI	(	float	dur,
		int	chan,
		int	key,
		int	vel
	)

virtual

These are the UGens of the DSP graph (i.e., the FM instrument)

Reimplemented from csl::Instrument.

Reimplemented in csl::FancyFMInstrument.

Definition at line 206 of file BasicFMInstrument.cpp.

References csl::keyToFreq(), mAEnv, mIEnv, mMod, csl::Instrument::play(), csl::Envelope::scaleValues(), and csl::ADSR::setDuration().

UnitGenerator* csl::Instrument::graph ( )

inlineinherited

Accessors.

Definition at line 63 of file Instrument.h.

References csl::Instrument::mGraph.

UGenMap* csl::Instrument::genMap ( )

inlineinherited

my UGen graph

Definition at line 64 of file Instrument.h.

References csl::Instrument::mUGens.

Referenced by csl::Instrument::Instrument().

UGenVector* csl::Instrument::envelopes ( )

inlineinherited

the map of ugens in the graph by name

Definition at line 65 of file Instrument.h.

References csl::Instrument::mEnvelopes.

Referenced by csl::Instrument::Instrument().

const string csl::Instrument::name ( )

inlineinherited

the vector of envelopes to query or trigger

Definition at line 67 of file Instrument.h.

References csl::Instrument::mName.

Referenced by setupOSCInstrLibrary().

UnitGenerator * Instrument::genNamed ( string name )

inherited

answer my name answer the number of channels

get a UGen from the graph

Definition at line 47 of file Instrument.cpp.

References csl::Instrument::mUGens.

AccessorVector csl::Instrument::getAccessors ( )

inlineinherited

Accessor management.

Definition at line 72 of file Instrument.h.

References csl::Instrument::mAccessors.

Referenced by csl::Instrument::Instrument(), and setupOSCInstrLibrary().

unsigned csl::Instrument::numAccessors ( )

inlineinherited

answer the accessor vector

Definition at line 73 of file Instrument.h.

References csl::Instrument::mAccessors.

Referenced by setupOSCInstrLibrary().

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

virtualinherited

set a named parameter

get a UGen from the graph

Sample creation

Reimplemented from csl::UnitGenerator.

Definition at line 41 of file Instrument.cpp.

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.

bool Instrument::isActive ( )

virtualinherited

Envelope query and re-trigger.

Reimplemented from csl::UnitGenerator.

Definition at line 57 of file Instrument.cpp.

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

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

void Instrument::play ( )

virtualinherited

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

Definition at line 70 of file Instrument.cpp.

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

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

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

inlinevirtualinherited

Play a note (subclasses refine)

Definition at line 82 of file Instrument.h.

void Instrument::release ( )

virtualinherited

Definition at line 76 of file Instrument.cpp.

References csl::Instrument::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().

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