Temp Spatial Sound Source. More...

#include <SpatialSource.h>

Inheritance diagram for csl::SpatialSource:

Public Member Functions
	SpatialSource ()
	constructors More...

	SpatialSource (UnitGenerator &input, float azi=0.0, float ele=0.0, float dist=1.0)

virtual	~SpatialSource ()

virtual void	setPosition (CPoint pos)
	Set the sound source position in cartesian coordinates. More...

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

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

void	setDistance (float val)
	Sets the angle of elevation. More...

float	azimuth ()
	Sets the distance from the center. More...

float	elevation ()
	Returns the horizontal angle. More...

float	distance ()
	Returns the angle of elevation. More...

CPoint *	position (unsigned channelNum=0)
	Returns the distance from the center. More...

virtual bool	positionChanged ()
	Returns whether the sound source position changed since last block call. 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 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	dump ()
	pretty-print the receiver 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 bool	isFixed ()
	query whether I'm fixed (StaticVariable overrides this) More...

virtual bool	isActive ()
	query whether I'm currently active (Envelopes can go inactive) 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	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)

void	setScale (UnitGenerator &scale)
	set the receiver's scale member to a UGen or a float More...

void	setScale (float scale)

void	setOffset (UnitGenerator &offset)
	set the receiver's offset member to a UGen or a float More...

void	setOffset (float offset)

virtual void	trigger ()
	trigger passed on here More...

void	isScaled ()
	answer whether scale = 1 & offset = 0 More...

Port *	getPort (CSL_MAP_KEY name)

Protected Member Functions
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...

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)

Protected Attributes
CPoint *	mPosition
	source position More...

bool	mPositionChanged
	true if this source's position has changed recently 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

Temp Spatial Sound Source.

Definition at line 29 of file SpatialSource.h.

Constructor & Destructor Documentation

SpatialSource::SpatialSource ( )

constructors

Definition at line 19 of file SpatialSource.cpp.

SpatialSource::SpatialSource	(	UnitGenerator &	input,
		float	azi = `0.0`,
		float	ele = `0.0`,
		float	dist = `1.0`
	)

Definition at line 21 of file SpatialSource.cpp.

References csl::Controllable::addInput(), CSL_INPUT, CSL_PI, kPolar, csl::logMsg(), mPosition, and csl::UnitGenerator::numChannels().

SpatialSource::~SpatialSource ( )

virtual

Definition at line 33 of file SpatialSource.cpp.

References mPosition.

Member Function Documentation

void SpatialSource::setPosition ( CPoint pos )

virtual

Set the sound source position in cartesian coordinates.

Definition at line 46 of file SpatialSource.cpp.

References 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.`
	)

virtual

Definition at line 50 of file SpatialSource.cpp.

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

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

virtual

Definition at line 58 of file SpatialSource.cpp.

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

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

virtual

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

Definition at line 66 of file SpatialSource.cpp.

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

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

virtual

Definition at line 74 of file SpatialSource.cpp.

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

CPoint& csl::SpatialSource::getPosition ( )

inline

Definition at line 42 of file SpatialSource.h.

References mPosition.

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

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

inline

Definition at line 52 of file SpatialSource.h.

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

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

inline

Sets the horizontal angle.

Definition at line 53 of file SpatialSource.h.

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

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

inline

Sets the angle of elevation.

Definition at line 54 of file SpatialSource.h.

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

float csl::SpatialSource::azimuth ( )

inline

Sets the distance from the center.

Definition at line 56 of file SpatialSource.h.

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

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

float csl::SpatialSource::elevation ( )

inline

Returns the horizontal angle.

Definition at line 57 of file SpatialSource.h.

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

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

float csl::SpatialSource::distance ( )

inline

Returns the angle of elevation.

Definition at line 58 of file SpatialSource.h.

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

Referenced by dump().

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

Returns the distance from the center.

Definition at line 40 of file SpatialSource.cpp.

References mPosition.

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

virtual bool csl::SpatialSource::positionChanged ( )

inlinevirtual

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

Reimplemented in csl::DistanceSimulator.

Definition at line 63 of file SpatialSource.h.

References mPositionChanged.

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

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

Reimplemented in csl::DistanceSimulator.

Definition at line 93 of file SpatialSource.cpp.

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

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

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

virtual

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 )

virtual

pretty-print the receiver

Reimplemented from csl::UnitGenerator.

Definition at line 82 of file SpatialSource.cpp.

References azimuth(), distance(), and 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 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 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.

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::Abst_SoundFile, csl::Stereoverb, csl::Envelope, csl::Instrument, csl::Mixer, and csl::KarplusString.

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

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.

void Scalable::setScale ( UnitGenerator & scale )

inherited

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

Definition at line 1039 of file CSL_Core.cpp.

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