csl::AmbisonicEncoder Class Reference

#include <Ambisonic.h>

Inheritance diagram for csl::AmbisonicEncoder:

List of all members.

---

Detailed Description

AmbisonicEncoder -- Higher Order Ambisonic encoding class

Higher Order Ambisonic class for positioning mono sound sources into an Ambisonic encoded soundfield. The position information is fed to the encoder as two multichannel framestreams (azimuth and elevation). It is possible to specify either one uniform Ambisonic order or to define the horizontal and vertical order separately (hybrid order encoding). If no order(s) is/are specified, first order Ambisonic will be used (B-Format).

Public Member Functions
	AmbisonicEncoder ()
	Default constructor.
	AmbisonicEncoder (SpatSource &input, unsigned order=1)
	Initialize with uniform Ambisonic order.
	AmbisonicEncoder (SpatSource &input, unsigned horder, unsigned vorder)
	Initialize with hybrid Ambisonic order.
virtual	~AmbisonicEncoder ()
	Destructor.
void	setInput (SpatSource &input)
	Set my input.
SpatSource *	input ()
virtual void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
	Does the DSP processing for the Ambisonic Encoder.
Protected Member Functions
void	initialize ()
	Initializing method called by constructors.
Protected Attributes
sample *	mWeights
	Encoding weights for each order (per source).
UGenPort *	mInputPort
	Holds the input to be encoded.

---

Constructor & Destructor Documentation

AmbisonicEncoder::AmbisonicEncoder (   )

Default constructor.

AmbisonicEncoder::AmbisonicEncoder (  SpatSource &  input, unsigned  order = 1 )

Initialize with uniform Ambisonic order.

AmbisonicEncoder::AmbisonicEncoder (  SpatSource &  input, unsigned  horder, unsigned  vorder )

Initialize with hybrid Ambisonic order.

AmbisonicEncoder::~AmbisonicEncoder (   )  [virtual]

Destructor.

---

Member Function Documentation

void AmbisonicEncoder::setInput (  SpatSource &  input  )

Set my input.

SpatSource* csl::AmbisonicEncoder::input (   )  [inline]

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

Does the DSP processing for the Ambisonic Encoder.

void AmbisonicEncoder::initialize (   )  [protected]

Initializing method called by constructors.

---

Member Data Documentation

sample* csl::AmbisonicEncoder::mWeights [protected]

Encoding weights for each order (per source).

UGenPort* csl::AmbisonicEncoder::mInputPort [protected]

Holds the input to be encoded.

---

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

• CSL/Spatializers/Ambisonic/Ambisonic.h
• CSL/Spatializers/Ambisonic/Ambisonic.cpp

---