csl::AmbisonicEncoder Class Reference

#include <Ambisonic.h>

Inheritance diagram for csl::AmbisonicEncoder:

csl::AmbisonicUnitGenerator csl::UnitGenerator csl::Model

List of all members.

Public Member Functions

 AmbisonicEncoder ()
 Default constructor.
 AmbisonicEncoder (SpatialSource &input, unsigned order=1)
 Initialize with uniform Ambisonic order.
 AmbisonicEncoder (SpatialSource &input, unsigned horder, unsigned vorder)
 Initialize with hybrid Ambisonic order.
virtual ~AmbisonicEncoder ()
 Destructor.
void setInput (SpatialSource &input)
 Set my input.
SpatialSourceinput ()
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

SampleBuffer mWeights
 Encoding weights for each order (per source).
PortmInputPort
 Holds the input to be encoded.


Constructor & Destructor Documentation

AmbisonicEncoder::AmbisonicEncoder (  ) 

Default constructor.

AmbisonicEncoder::AmbisonicEncoder ( SpatialSource input,
unsigned  order = 1 
)

Initialize with uniform Ambisonic order.

References initialize(), and setInput().

AmbisonicEncoder::AmbisonicEncoder ( SpatialSource input,
unsigned  horder,
unsigned  vorder 
)

Initialize with hybrid Ambisonic order.

References initialize(), and setInput().

AmbisonicEncoder::~AmbisonicEncoder (  )  [virtual]

Destructor.

References mInputPort, and mWeights.


Member Function Documentation

void AmbisonicEncoder::setInput ( SpatialSource input  ) 

Set my input.

Use to set the input to be encoded.

References csl::UnitGenerator::addOutput(), csl::logMsg(), mInputPort, csl::Port::mUGen, and csl::UnitGenerator::removeOutput().

Referenced by AmbisonicEncoder().

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

References mInputPort, and csl::Port::mUGen.

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

void AmbisonicEncoder::initialize (  )  [protected]

Initializing method called by constructors.

References AMBI_INVSQRT2, csl::UnitGenerator::mNumChannels, and mWeights.

Referenced by AmbisonicEncoder().


Member Data Documentation

Encoding weights for each order (per source).

Referenced by initialize(), and ~AmbisonicEncoder().

Holds the input to be encoded.

Referenced by input(), setInput(), and ~AmbisonicEncoder().


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

Generated on Thu Sep 17 23:14:17 2009 for CSL by  doxygen 1.5.8