CSL  6.0
csl::AmbisonicDecoder Class Reference

#include <Ambisonic.h>

+ Inheritance diagram for csl::AmbisonicDecoder:

Public Member Functions

 AmbisonicDecoder (AmbisonicUnitGenerator &input, SpeakerLayout *layout=SpeakerLayout::defaultSpeakerLayout(), AmbisonicDecoderMethod method=kPROJECTION, AmbisonicDecoderFlavour flavour=kBASIC)
 Defaults to standard speaker layout as defined in "HOA_SpeakerLayout" class and to Ambisonic order of encoded input. More...
 
 AmbisonicDecoder (UnitGenerator &input, unsigned order, SpeakerLayout *layout=SpeakerLayout::defaultSpeakerLayout(), AmbisonicDecoderMethod method=kPROJECTION, AmbisonicDecoderFlavour flavour=kBASIC)
 Initializes with uniform Ambisonic order, defaults to standard speaker layout as defined in "HOA_SpeakerLayout" class. More...
 
 AmbisonicDecoder (UnitGenerator &input, unsigned hOrder, unsigned vOrder, SpeakerLayout *layout=SpeakerLayout::defaultSpeakerLayout(), AmbisonicDecoderMethod method=kPROJECTION, AmbisonicDecoderFlavour flavour=kBASIC)
 Initializes with hybrid Ambisonic order. More...
 
 ~AmbisonicDecoder ()
 Destructor. More...
 
virtual void nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
 Does the DSP processing for the Ambisonic Decoder. More...
 
AmbisonicOrder order ()
 
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 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...
 
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 dump ()
 pretty-print the receiver More...
 
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)
 

Protected Member Functions

void initialize (UnitGenerator &input, AmbisonicDecoderMethod method, AmbisonicDecoderFlavour flavour)
 initializing method called by constructors More...
 
void asProjection ()
 Create the decoding matrix "D" using the projection method. More...
 
void asPseudoInverse ()
 create the decoding matrix "D" using the pseudoinverse method More...
 
void makeInPhase (unsigned greaterOrder)
 Adjusts the decoding matrix D for in-phase flavour. More...
 
void makeMaxRE (unsigned greaterOrder)
 Adjusts the decoding matrix D for Max rE flavour. More...
 
void makeTransposedReEncodingMatrix (float **transposeMatrix)
 Utility method that creates the transposed re-encoding matrix C'. More...
 
void setOrder (AmbisonicOrder order)
 Returns the Ambisonic order. More...
 
unsigned channelsToUniformOrder (const unsigned channels)
 
unsigned greaterOrder (const AmbisonicOrder order)
 Compares the horizontal and vertical Ambisonic order of a hybrid order and returns the largest. More...
 
unsigned orderToChannels (const AmbisonicOrder order)
 Returns the number of Ambisonic channels from a hybrid Ambisonic order: N = 2*M_h + 1 + (M_v + 1)^2 - (2*M_v + 1) More...
 
unsigned orderToChannels (unsigned order)
 Returns the number of Ambisonic channels corresponding to a uniform Ambisonic order: N = (M+1)^2. More...
 
unsigned orderToHorizontalChannels (const AmbisonicOrder order)
 Returns the number of horizontal Ambisonic channels from a hybrid Ambisonic order: N_h = 2*M_h + 1. More...
 
unsigned orderToVerticalChannels (const AmbisonicOrder order)
 Returns the number of vertical Ambisonic channels from a hybrid Ambisonic order: N_v = (M_v + 1)^2 - (2*M_v + 1) More...
 
void channelIndexer (unsigned *indexArray)
 Calculates a lookup table to map Ambisonic channel index to actually used UnitGenerator channel. More...
 
void invChannelIndexer (unsigned *indexArray)
 Calculates a lookup table to map actually used UnitGenerator channel to Ambisonic channel index. More...
 
void zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
 utility method to zero out an outputBuffer More...
 

Protected Attributes

PortmInputPort
 
float mNumChannelsInv
 
int * mIOChannelMap
 
SampleBufferVector mDecodingMatrix
 
SpeakerLayoutmSpeakerLayout
 
AmbisonicDecoderMethod mDecodingMethod
 
AmbisonicDecoderFlavour mDecoderFlavour
 
AmbisonicOrder mOrder
 the order of the Unit Generator 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...
 
BuffermOutputCache
 my past output ring buffer (only used in case of fan-out) More...
 
unsigned mSequence
 the highest-seen buffer seq number More...
 

Related Functions

(Note that these are not member functions.)

void singularValueDecomposition (sample **a, int m, int n, sample *w, sample **v)
 
void fumaEncodingWeights (SampleBuffer weights, const AmbisonicOrder &order, float azimuth, float elevation)
 
void fumaIndexedEncodingWeights (SampleBuffer weights, const AmbisonicOrder &order, sample &azimuth, sample &elevation)
 

Detailed Description

Definition at line 172 of file Ambisonic.h.

Constructor & Destructor Documentation

AmbisonicDecoder::AmbisonicDecoder ( AmbisonicUnitGenerator input,
SpeakerLayout layout = SpeakerLayout::defaultSpeakerLayout(),
AmbisonicDecoderMethod  method = kPROJECTION,
AmbisonicDecoderFlavour  flavour = kBASIC 
)

Defaults to standard speaker layout as defined in "HOA_SpeakerLayout" class and to Ambisonic order of encoded input.

Definition at line 291 of file Ambisonic.cpp.

References initialize().

AmbisonicDecoder::AmbisonicDecoder ( UnitGenerator input,
unsigned  order,
SpeakerLayout layout = SpeakerLayout::defaultSpeakerLayout(),
AmbisonicDecoderMethod  method = kPROJECTION,
AmbisonicDecoderFlavour  flavour = kBASIC 
)

Initializes with uniform Ambisonic order, defaults to standard speaker layout as defined in "HOA_SpeakerLayout" class.

Definition at line 298 of file Ambisonic.cpp.

References initialize().

AmbisonicDecoder::AmbisonicDecoder ( UnitGenerator input,
unsigned  hOrder,
unsigned  vOrder,
SpeakerLayout layout = SpeakerLayout::defaultSpeakerLayout(),
AmbisonicDecoderMethod  method = kPROJECTION,
AmbisonicDecoderFlavour  flavour = kBASIC 
)

Initializes with hybrid Ambisonic order.

Definition at line 305 of file Ambisonic.cpp.

References initialize().

AmbisonicDecoder::~AmbisonicDecoder ( )

Member Function Documentation

void AmbisonicDecoder::nextBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
)
throw (CException
)
virtual

Does the DSP processing for the Ambisonic Decoder.

Reimplemented from csl::UnitGenerator.

Definition at line 667 of file Ambisonic.cpp.

References csl::Buffer::buffer(), csl::kLogError, csl::kSamples, csl::logMsg(), csl::Buffer::mIsPopulated, csl::Buffer::mNumFrames, and csl::Buffer::mType.

void AmbisonicDecoder::asProjection ( )
protected

Create the decoding matrix "D" using the projection method.

build the Decoding matrix D using the projection method D = (1/L) * C'

Definition at line 457 of file Ambisonic.cpp.

References makeTransposedReEncodingMatrix(), mDecodingMatrix, csl::UnitGenerator::mNumChannels, mSpeakerLayout, and csl::SpeakerLayout::numSpeakers().

Referenced by initialize().

void AmbisonicDecoder::asPseudoInverse ( )
protected

create the decoding matrix "D" using the pseudoinverse method

Build the Decoding matrix D using the pseudo inverse method
D = pinv(C) = C' * inv(C * C').
Pseudo inverse code based on the matrix library found at: http://home1.gte.net/edwin2/Matrix/.

Definition at line 474 of file Ambisonic.cpp.

References makeTransposedReEncodingMatrix(), mDecodingMatrix, csl::UnitGenerator::mNumChannels, mSpeakerLayout, csl::SpeakerLayout::numSpeakers(), and csl::AmbisonicUnitGenerator::singularValueDecomposition().

Referenced by initialize().

void AmbisonicDecoder::makeInPhase ( unsigned  greaterOrder)
protected

Adjusts the decoding matrix D for in-phase flavour.

Scales the decoding matrix according to the factors for in-phase decoding.

Definition at line 638 of file Ambisonic.cpp.

References csl::AmbisonicUnitGenerator::channelsToUniformOrder(), mDecodingMatrix, csl::UnitGenerator::mNumChannels, mSpeakerLayout, and csl::SpeakerLayout::numSpeakers().

Referenced by initialize().

void AmbisonicDecoder::makeMaxRE ( unsigned  greaterOrder)
protected

Adjusts the decoding matrix D for Max rE flavour.

Scales the decoding matrix according to the factors for max rE decoding.

Definition at line 610 of file Ambisonic.cpp.

References csl::AmbisonicUnitGenerator::channelsToUniformOrder(), csl::AmbisonicUnitGenerator::greaterOrder(), mDecodingMatrix, csl::UnitGenerator::mNumChannels, mSpeakerLayout, and csl::SpeakerLayout::numSpeakers().

Referenced by initialize().

void AmbisonicDecoder::makeTransposedReEncodingMatrix ( float **  transposeMatrix)
protected
AmbisonicOrder csl::AmbisonicUnitGenerator::order ( )
inlineinherited
void AmbisonicUnitGenerator::setOrder ( AmbisonicOrder  order)
protectedinherited

Returns the Ambisonic order.

Definition at line 59 of file Ambisonic.cpp.

References csl::AmbisonicUnitGenerator::initOrder(), and csl::AmbisonicUnitGenerator::mOrder.

unsigned AmbisonicUnitGenerator::channelsToUniformOrder ( const unsigned  channels)
protectedinherited

Definition at line 66 of file Ambisonic.cpp.

Referenced by makeInPhase(), and makeMaxRE().

unsigned AmbisonicUnitGenerator::greaterOrder ( const AmbisonicOrder  order)
protectedinherited

Compares the horizontal and vertical Ambisonic order of a hybrid order and returns the largest.

Definition at line 71 of file Ambisonic.cpp.

References csl::AmbisonicOrder::horizontalOrder, and csl::AmbisonicOrder::verticalOrder.

Referenced by csl::AmbisonicUnitGenerator::channelIndexer(), csl::AmbisonicRotator::initialize(), initialize(), and makeMaxRE().

unsigned AmbisonicUnitGenerator::orderToChannels ( const AmbisonicOrder  order)
protectedinherited

Returns the number of Ambisonic channels from a hybrid Ambisonic order: N = 2*M_h + 1 + (M_v + 1)^2 - (2*M_v + 1)

Definition at line 75 of file Ambisonic.cpp.

References csl::AmbisonicOrder::horizontalOrder, and csl::AmbisonicOrder::verticalOrder.

Referenced by csl::AmbisonicUnitGenerator::channelIndexer(), csl::AmbisonicRotator::initialize(), initialize(), csl::AmbisonicUnitGenerator::initOrder(), and csl::AmbisonicUnitGenerator::invChannelIndexer().

unsigned AmbisonicUnitGenerator::orderToChannels ( unsigned  order)
protectedinherited

Returns the number of Ambisonic channels corresponding to a uniform Ambisonic order: N = (M+1)^2.

Definition at line 80 of file Ambisonic.cpp.

unsigned AmbisonicUnitGenerator::orderToHorizontalChannels ( const AmbisonicOrder  order)
protectedinherited

Returns the number of horizontal Ambisonic channels from a hybrid Ambisonic order: N_h = 2*M_h + 1.

Definition at line 85 of file Ambisonic.cpp.

References csl::AmbisonicOrder::horizontalOrder.

unsigned AmbisonicUnitGenerator::orderToVerticalChannels ( const AmbisonicOrder  order)
protectedinherited

Returns the number of vertical Ambisonic channels from a hybrid Ambisonic order: N_v = (M_v + 1)^2 - (2*M_v + 1)

Definition at line 90 of file Ambisonic.cpp.

References csl::AmbisonicOrder::verticalOrder.

void AmbisonicUnitGenerator::channelIndexer ( unsigned *  indexArray)
protectedinherited
void AmbisonicUnitGenerator::invChannelIndexer ( unsigned *  indexArray)
protectedinherited

Calculates a lookup table to map actually used UnitGenerator channel to Ambisonic channel index.

Definition at line 146 of file Ambisonic.cpp.

References csl::AmbisonicOrder::horizontalOrder, csl::AmbisonicUnitGenerator::mOrder, csl::AmbisonicUnitGenerator::orderToChannels(), and csl::AmbisonicOrder::verticalOrder.

Referenced by initialize().

unsigned csl::UnitGenerator::frameRate ( )
inlineinherited
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.

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

Friends And Related Function Documentation

void singularValueDecomposition ( sample **  a,
int  m,
int  n,
sample w,
sample **  v 
)
related

Given a matrix a[m][n], this routine computes its singular value decomposition, A = U*W*V^{T}. The matrix U replaces a on output. The diagonal matrix of singular values W is output as a vector w[n]. The matrix V (not the transpose V^{T}) is output as v[n][n]. m must be greater or equal to n; if it is smaller, then a should be filled up to square with zero rows.

Definition at line 630 of file AmbisonicUtilities.cpp.

References MAX, PYTHAG, and SIGN.

Referenced by asPseudoInverse().

void fumaEncodingWeights ( SampleBuffer  weights,
const AmbisonicOrder order,
float  azimuth,
float  elevation 
)
related
void fumaIndexedEncodingWeights ( SampleBuffer  weights,
const AmbisonicOrder order,
sample azimuth,
sample elevation 
)
related

Member Data Documentation

Port* csl::AmbisonicDecoder::mInputPort
protected

Definition at line 198 of file Ambisonic.h.

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

float csl::AmbisonicDecoder::mNumChannelsInv
protected

Definition at line 199 of file Ambisonic.h.

int* csl::AmbisonicDecoder::mIOChannelMap
protected

Definition at line 200 of file Ambisonic.h.

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

SampleBufferVector csl::AmbisonicDecoder::mDecodingMatrix
protected
SpeakerLayout* csl::AmbisonicDecoder::mSpeakerLayout
protected
AmbisonicDecoderMethod csl::AmbisonicDecoder::mDecodingMethod
protected

Definition at line 203 of file Ambisonic.h.

Referenced by initialize().

AmbisonicDecoderFlavour csl::AmbisonicDecoder::mDecoderFlavour
protected

Definition at line 204 of file Ambisonic.h.

Referenced by initialize().

BufferCopyPolicy csl::UnitGenerator::mCopyPolicy
protectedinherited

the policy I use if asked for more or fewer channels

Definition at line 293 of file CSL_Core.h.

Referenced by csl::UnitGenerator::copyPolicy(), and csl::UnitGenerator::setCopyPolicy().

UGenVector csl::UnitGenerator::mOutputs
protectedinherited
unsigned csl::UnitGenerator::mNumOutputs
protectedinherited

the number of outputs

Definition at line 295 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput(), csl::UnitGenerator::numOutputs(), and csl::UnitGenerator::removeOutput().

Buffer* csl::UnitGenerator::mOutputCache
protectedinherited

my past output ring buffer (only used in case of fan-out)

Definition at line 296 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput().

unsigned csl::UnitGenerator::mSequence
protectedinherited

the highest-seen buffer seq number

Definition at line 297 of file CSL_Core.h.


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