Only handles single sound sources because objects have different positions. Two objects can't ocuppy the same position, and usually distance cues go before the panning, so handling multiple sources by one Distance simulator, would producde a multi-channel object, where the positions aren't dynamic anymore. More...

#include <DistanceSimulator.h>

Inheritance diagram for csl::DistanceSimulator:

List of all members.

Public Member Functions
	DistanceSimulator (UnitGenerator &source)
	DistanceSimulator (SpatialSource &source)
	~DistanceSimulator ()
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	positionChanged ()
	Returns wether the sound source position changed since last block call.
virtual void	setPosition (CPoint pos)
	Set the sound source position in cartesian coordinates.
virtual void	setPosition (float x=0., float y=0., float z=0.)
virtual void	setPosition (double x=0., double y=0., double z=0.)
virtual void	setPosition (char s, float azi=0, float ele=0, float dist=1.0)
	Set the sound source position in spherical coordinates (degrees).
virtual void	setPosition (char s, double azi=0, double ele=0, double dist=1.0)
CPoint &	getPosition ()
void	setAzimuth (float val)
void	setElevation (float val)
	Sets the horizontal angle.
void	setDistance (float val)
	Sets the angle of elevation.
float	azimuth ()
	Sets the distance from the center.
float	elevation ()
	Returns the horizontal angle.
float	distance ()
	Returns the angle of elevation.
CPoint *	position (unsigned channelNum=0)
	Returns the distance from the center.
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.
void	dump ()
	pretty-print the receiver
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 bool	isFixed ()
	query whether I'm fixed (StaticVariable overrides this)
virtual bool	isActive ()
	query whether I'm currently active (Envelopes can go inactive)
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 ()
virtual void	trigger ()
	trigger passed on here
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)
void	isScaled ()
	answer whether scale = 1 & offset = 0
Port *	getPort (CSL_MAP_KEY name)

Protected Member Functions
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
IntensityAttenuationCue *	mIntensityCue
AirAbsorptionCue *	mAirAbsorptionCue
CPoint *	mPosition
	source position
bool	mPositionChanged
	true if this source's position has changed recently
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

Only handles single sound sources because objects have different positions. Two objects can't ocuppy the same position, and usually distance cues go before the panning, so handling multiple sources by one Distance simulator, would producde a multi-channel object, where the positions aren't dynamic anymore.

Definition at line 24 of file DistanceSimulator.h.

Constructor & Destructor Documentation

DistanceSimulator::DistanceSimulator ( UnitGenerator & source )

Definition at line 13 of file DistanceSimulator.cpp.

References csl::Controllable::addInput(), CSL_INPUT, mAirAbsorptionCue, mIntensityCue, and csl::SpatialSource::mPosition.

DistanceSimulator::DistanceSimulator ( SpatialSource & source )

Definition at line 20 of file DistanceSimulator.cpp.

References csl::Controllable::addInput(), CSL_INPUT, mAirAbsorptionCue, mIntensityCue, csl::SpatialSource::mPosition, and csl::SpatialSource::position().

DistanceSimulator::~DistanceSimulator ( )

Definition at line 27 of file DistanceSimulator.cpp.

References mAirAbsorptionCue, and mIntensityCue.

Member Function Documentation

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

virtual

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

Reimplemented from csl::SpatialSource.

Definition at line 40 of file DistanceSimulator.cpp.

References CSL_INPUT, csl::Port::mUGen, and csl::UnitGenerator::nextBuffer().

bool DistanceSimulator::positionChanged ( )

virtual

Returns wether the sound source position changed since last block call.

Returns whether the sound source position changed since last block call.

Reimplemented from csl::SpatialSource.

Definition at line 34 of file DistanceSimulator.cpp.

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

void SpatialSource::setPosition ( CPoint pos )

virtualinherited

Set the sound source position in cartesian coordinates.

Definition at line 46 of file SpatialSource.cpp.

References csl::SpatialSource::mPosition.

Referenced by main(), PMESource::set_position(), test_Ambi_horiz(), test_Binaural_horiz(), test_Binaural_vertAxial(), test_Binaural_vertMedian(), test_SimpleP(), test_VBAP_horiz(), and PMESource::update_position().

void SpatialSource::setPosition	(	float	x = `0.`,
		float	y = `0.`,
		float	z = `0.`
	)

virtualinherited

Definition at line 50 of file SpatialSource.cpp.

References csl::SpatialSource::mPosition, csl::SpatialSource::mPositionChanged, and csl::CPoint::set().

void SpatialSource::setPosition	(	double	x = `0.`,
		double	y = `0.`,
		double	z = `0.`
	)

virtualinherited

Definition at line 58 of file SpatialSource.cpp.

References csl::SpatialSource::mPosition, csl::SpatialSource::mPositionChanged, and csl::CPoint::set().

void SpatialSource::setPosition	(	char	s,
		float	azi = `0`,
		float	ele = `0`,
		float	dist = `1.0`
	)

virtualinherited

Set the sound source position in spherical coordinates (degrees).

Definition at line 66 of file SpatialSource.cpp.

References CSL_PI, kPolar, csl::SpatialSource::mPosition, csl::SpatialSource::mPositionChanged, and csl::CPoint::set().

void SpatialSource::setPosition	(	char	s,
		double	azi = `0`,
		double	ele = `0`,
		double	dist = `1.0`
	)

virtualinherited

Definition at line 74 of file SpatialSource.cpp.

References CSL_PI, kPolar, csl::SpatialSource::mPosition, csl::SpatialSource::mPositionChanged, and csl::CPoint::set().

CPoint& csl::SpatialSource::getPosition ( )

inlineinherited

Definition at line 42 of file SpatialSource.h.

References csl::SpatialSource::mPosition.

Referenced by PMESource::get_position(), and PMESource::update_position().

void csl::SpatialSource::setAzimuth ( float val )

inlineinherited

Definition at line 52 of file SpatialSource.h.

References csl::SpatialSource::mPosition, and csl::CPoint::setAzimuth().

void csl::SpatialSource::setElevation ( float val )

inlineinherited

Sets the horizontal angle.

Definition at line 53 of file SpatialSource.h.

References csl::SpatialSource::mPosition, and csl::CPoint::setElevation().

void csl::SpatialSource::setDistance ( float val )

inlineinherited

Sets the angle of elevation.

Definition at line 54 of file SpatialSource.h.

References csl::SpatialSource::mPosition, and csl::CPoint::setMagnitude().

float csl::SpatialSource::azimuth ( )

inlineinherited

Sets the distance from the center.

Definition at line 56 of file SpatialSource.h.

References csl::SpatialSource::mPosition, and csl::CPoint::theta().

Referenced by csl::SpatialSource::dump(), and csl::AmbisonicEncoder::nextBuffer().

float csl::SpatialSource::elevation ( )

inlineinherited

Returns the horizontal angle.

Definition at line 57 of file SpatialSource.h.

References csl::CPoint::ele(), and csl::SpatialSource::mPosition.

Referenced by csl::SpatialSource::dump(), and csl::AmbisonicEncoder::nextBuffer().

float csl::SpatialSource::distance ( )

inlineinherited

Returns the angle of elevation.

Definition at line 58 of file SpatialSource.h.

References csl::SpatialSource::mPosition, and csl::CPoint::r().

Referenced by csl::SpatialSource::dump().

CPoint * SpatialSource::position ( unsigned channelNum = 0 )

inherited

Returns the distance from the center.

Definition at line 40 of file SpatialSource.cpp.

References csl::SpatialSource::mPosition.

Referenced by DistanceSimulator(), csl::BinauralPanner::nextBuffer(), and csl::VBAP::nextBuffer().

void SpatialSource::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 from csl::UnitGenerator.

Definition at line 99 of file SpatialSource.cpp.

References csl::logMsg().

void SpatialSource::dump ( void )

virtualinherited

pretty-print the receiver

Reimplemented from csl::UnitGenerator.

Definition at line 82 of file SpatialSource.cpp.

References csl::SpatialSource::azimuth(), csl::SpatialSource::distance(), and csl::SpatialSource::elevation().

Referenced by test_Ambi_horiz(), test_Binaural_horiz(), test_Binaural_vertAxial(), test_Binaural_vertMedian(), test_SimpleP(), and test_VBAP_horiz().

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

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.

virtual bool csl::UnitGenerator::isActive ( )

inlinevirtualinherited

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

Reimplemented in csl::Joiner, csl::Effect, csl::RandEnvelope, csl::SoundCue, csl::Stereoverb, csl::Abst_SoundFile, csl::Envelope, csl::Instrument, csl::Mixer, and csl::KarplusString.

Definition at line 249 of file CSL_Core.h.

Referenced by csl::Instrument::isActive(), csl::Port::isActive(), csl::Mixer::nextBuffer(), csl::BinauralPanner::nextBuffer(), csl::AmbisonicMixer::nextBuffer(), and csl::VBAP::nextBuffer().

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

virtualinherited

trigger passed on here

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

Definition at line 917 of file CSL_Core.cpp.

References CSL_OFFSET, CSL_SCALE, and csl::Controllable::mInputs.

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