Vector Base Amplitude Panning. More...

#include <VBAP.h>

Inheritance diagram for csl::VBAP:

Public Member Functions
	VBAP (VBAPMode mode=kAuto, SpeakerLayout *layout=SpeakerLayout::defaultSpeakerLayout())
	Initializer for a VBAP Panner. Optionally a speaker layout can be specified. Defaults to auto, decided according to layout. If not specified uses the default speaker layout. More...

virtual	~VBAP ()

void	nextBuffer (Buffer &outputBuffer) throw (CException)
	Just as any Effect in CSL, this method gets called at runtime by the audio driver. Here is where the actual processing happens. More...

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

void	dump ()
	pretty-print the receiver More...

void	setSpeakerLayout (SpeakerLayout *aLayout)
	Set the speaker layout to be used by this panner. The panner will request the default layout if not set. More...

unsigned	numSources ()

virtual void	addSource (SpatialSource &s)
	number of active inputs. More...

virtual void	removeSource (SpatialSource &s)
	Remove a Sound Source. More...

virtual void	update (void *arg)
	Called when the speaker layout changes. 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)

Public Attributes
float	mPeriod
	virtual destructor (don't notify or delete observers in this version) More...

int	mKey
	key selector (e.g., MIDI chan) I receive update() mesages from my model; More...

Protected Member Functions
virtual void *	cache ()
	Returns an instance of it's cache data per sound source. More...

virtual void	speakerLayoutChanged ()
	called when the speaker layout changes, so panners update precalculated data More...

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

Protected Attributes
VBAPMode	mMode
	Prints useful information about this VBAP instance. More...

SpeakerSetLayout *	mSpeakerSetLayout
	A reference to the layout that contains the speaker pairs or triplets. More...

UGenVector	mSources
	SpatialSource... refers to its input UGen, but with the knowledge of its position within a space. More...

vector< void * >	mCache
	Vector of pointers to the prior I/O data. More...

SpeakerLayout *	mSpeakerLayout
	If null, it will use the default layout by calling SpeakerLayout::defaultSpeakerLayout();. More...

Buffer	mTempBuffer
	Buffer used to temporarily hold input source data. 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

Vector Base Amplitude Panning.

A panning technique that uses amplitude as the method for sound placement (just as stereo panning does). When multiple speakers are present, sets of all possible adjacent speaker pairs or in triples (depending if doing 3D or only 2D panning) are found, reducing the "Active speakers" to two or three. See Pulkki for more info.

Definition at line 61 of file VBAP.h.

Constructor & Destructor Documentation

VBAP::VBAP	(	VBAPMode	mode = `kAuto`,
		SpeakerLayout *	layout = `SpeakerLayout::defaultSpeakerLayout()`
	)

Initializer for a VBAP Panner. Optionally a speaker layout can be specified. Defaults to auto, decided according to layout. If not specified uses the default speaker layout.

The two parameters are optional.
The mode defines wether to consider elevation (full 3D) positions, or horizontal only (kPantophonic). If not specified, the mode is chosen automatically. If the SpeakerLayout contains speakers at different elevations, then it sets the mode to 3D. Otherwise, it is set to 2D.
The layout parameter allows to specify a different layout than the default. The recomended use is to create a layout and set it as default. Then any Panner can make use of it.
This parameter overrides the use of the default layout, using the layout passed here.

Definition at line 358 of file VBAP.cpp.

References csl::SpeakerLayout::isPeriphonic(), csl::kAuto, csl::kIgnore, csl::kPantophonic, csl::kPeriphonic, mMode, csl::SpatialPanner::mSpeakerLayout, mSpeakerSetLayout, csl::SpeakerLayout::numSpeakers(), csl::UnitGenerator::setCopyPolicy(), and csl::UnitGenerator::setNumChannels().

VBAP::~VBAP ( )

virtual

Definition at line 374 of file VBAP.cpp.

References mSpeakerSetLayout.

Member Function Documentation

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

virtual

Just as any Effect in CSL, this method gets called at runtime by the audio driver. Here is where the actual processing happens.

Implements csl::SpatialPanner.

Definition at line 390 of file VBAP.cpp.

void VBAP::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::SpatialPanner.

Definition at line 394 of file VBAP.cpp.

References csl::VBAPSourceCache::gains, csl::UnitGenerator::isActive(), csl::CPoint::len(), csl::logMsg(), csl::SpatialSource::nextBuffer(), csl::SpeakerSet::nodes, csl::CPoint::normalize(), csl::SpatialSource::position(), csl::SpatialSource::positionChanged(), csl::VBAPSourceCache::tripletIndex, vectorMultiply(), csl::CPoint::x, csl::CPoint::y, and csl::CPoint::z.

void csl::VBAP::dump ( void )

inlinevirtual

pretty-print the receiver

Reimplemented from csl::UnitGenerator.

Definition at line 73 of file VBAP.h.

void * VBAP::cache ( )

protectedvirtual

Returns an instance of it's cache data per sound source.

Reimplemented from csl::SpatialPanner.

Definition at line 386 of file VBAP.cpp.

void VBAP::speakerLayoutChanged ( )

protectedvirtual

called when the speaker layout changes, so panners update precalculated data

Reimplemented from csl::SpatialPanner.

Definition at line 378 of file VBAP.cpp.

References csl::SpatialPanner::mSpeakerLayout, mSpeakerSetLayout, csl::SpeakerLayout::numSpeakers(), and csl::UnitGenerator::setNumChannels().

void SpatialPanner::setSpeakerLayout ( SpeakerLayout * aLayout )

inherited

Set the speaker layout to be used by this panner. The panner will request the default layout if not set.

Definition at line 25 of file SpatialPanner.cpp.

References csl::Model::attachObserver(), csl::Model::detachObserver(), csl::SpatialPanner::mSpeakerLayout, and csl::SpatialPanner::speakerLayoutChanged().

Referenced by csl::SpatialPanner::SpatialPanner(), and csl::SpatialPanner::update().

unsigned csl::SpatialPanner::numSources ( )

inlineinherited

Definition at line 32 of file SpatialPanner.h.

References csl::SpatialPanner::mSources.

Referenced by csl::Spatializer::numSources().

void SpatialPanner::addSource ( SpatialSource & s )

virtualinherited

number of active inputs.

Add a souce to the list of inputs to be processed and create a cache object

Reimplemented in csl::AmbisonicPanner, csl::SimplePanner, and csl::SimplePanner.

Definition at line 41 of file SpatialPanner.cpp.

References csl::SpatialPanner::cache(), csl::SpatialPanner::mCache, and csl::SpatialPanner::mSources.

Referenced by csl::Spatializer::addSource(), main(), and csl::Spatializer::setPanningMode().

void SpatialPanner::removeSource ( SpatialSource & s )

virtualinherited

Remove a Sound Source.

Reimplemented in csl::AmbisonicPanner, csl::SimplePanner, and csl::SimplePanner.

Definition at line 56 of file SpatialPanner.cpp.

References csl::logMsg(), csl::SpatialPanner::mCache, and csl::SpatialPanner::mSources.

Referenced by csl::Spatializer::removeSource().

void SpatialPanner::update ( void * arg )

virtualinherited

Called when the speaker layout changes.

Called when the speaker layout changes, so panners update their data. This method is implemented only by the Panner class, and depending on the message sent, it calls the appropriate method implemented by subclasses. For example, when the speaker layout changes, the method calls "speakerLayoutChanged()", which should be implemented by subclasses interested to react to such change.

Implements csl::Observer.

Definition at line 83 of file SpatialPanner.cpp.

References csl::SpeakerLayout::defaultSpeakerLayout(), csl::SpatialPanner::mSpeakerLayout, csl::SpatialPanner::setSpeakerLayout(), and csl::SpatialPanner::speakerLayoutChanged().

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(), speakerLayoutChanged(), and 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 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 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.