csl::Spatializer Class Reference

#include <SpatialAudio.h>

Inheritance diagram for csl::Spatializer:

List of all members.

Public Member Functions
	Spatializer (PannerType panMode=kAutomatic, SpeakerLayout *speakerLayout=SpeakerLayout::defaultSpeakerLayout())
	~Spatializer ()
void	addSource (SpatialSource &s)
	Add a sound souce to the list of inputs to be processed.
void	removeSource (SpatialSource &s)
	Remove a Sound Source.
unsigned	numSources ()
void	setPanningMode (PannerType panType)
	number of active inputs.
virtual void	update (void *arg)
	called when the speaker layout changes, so panners update precalculated data.
virtual void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
	fill the buffer with data :-)
Private Attributes
SpatialPanner *	mPanner
map< SpatialSource *, DistanceSimulator * >	mInputsHashMap
SpeakerLayout *	mSpeakerLayout

---

Detailed Description

Container class that simplifies the spatial audio interface. This layer hides most of the inner-working of audio spatialization, providing a simple interface for sound placement in a space.

---

Constructor & Destructor Documentation

Spatializer::Spatializer	(	PannerType	panMode = kAutomatic,
		SpeakerLayout *	speakerLayout = SpeakerLayout::defaultSpeakerLayout()
	)

References csl::kIgnore, csl::UnitGenerator::setCopyPolicy(), csl::UnitGenerator::setNumChannels(), and setPanningMode().

Spatializer::~Spatializer

(

)

References mPanner.

---

Member Function Documentation

void Spatializer::addSource

(

SpatialSource &

s

)

Add a sound souce to the list of inputs to be processed.

References csl::SpatialPanner::addSource(), mInputsHashMap, and mPanner.

Referenced by main().

void Spatializer::removeSource

(

SpatialSource &

s

)

Remove a Sound Source.

References csl::logMsg(), mInputsHashMap, mPanner, and csl::SpatialPanner::removeSource().

unsigned csl::Spatializer::numSources

(

)

[inline]

References mPanner, and csl::SpatialPanner::numSources().

void Spatializer::setPanningMode

(

PannerType

panType

)

number of active inputs.

Todo:

make all spat framework thread safe.

References csl::SpatialPanner::addSource(), csl::kAmbisonic, csl::kAutomatic, csl::kBinaural, csl::kLogWarning, csl::kPeriphonic, csl::kVBAP, csl::kWFS, csl::logMsg(), mInputsHashMap, mPanner, and mSpeakerLayout.

Referenced by Spatializer().

void Spatializer::update

(

void *

arg

)

[virtual]

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

Implements csl::Observer.

void Spatializer::nextBuffer	(	Buffer &	outputBuffer,
		unsigned	outBufNum
	)			throw (CException) [virtual]

fill the buffer with data :-)

Reimplemented from csl::UnitGenerator.

References csl::logMsg().

---

Member Data Documentation

SpatialPanner* csl::Spatializer::mPanner [private]

Referenced by addSource(), numSources(), removeSource(), setPanningMode(), and ~Spatializer().

map<SpatialSource *, DistanceSimulator *> csl::Spatializer::mInputsHashMap [private]

a map between a source passed/key and a the corresponding distance simulator (used for removing sources)

Referenced by addSource(), removeSource(), and setPanningMode().

SpeakerLayout* csl::Spatializer::mSpeakerLayout [private]

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

Referenced by setPanningMode().

---

The documentation for this class was generated from the following files:

• CSL/Spatializers/SpatialAudio.h
• CSL/Spatializers/SpatialAudio.cpp