CSL  5.2
csl::AmbisonicRotator Class Reference

#include <AmbisonicUtilities.h>

+ Inheritance diagram for csl::AmbisonicRotator:

List of all members.

Public Member Functions

 AmbisonicRotator (AmbisonicUnitGenerator &input)
 initializes with no rotation
 AmbisonicRotator (UnitGenerator &input, unsigned order)
 initializes with uniform Ambisonic order and no rotation
 AmbisonicRotator (UnitGenerator &input, unsigned vorder, unsigned horder)
 initializes with hybrid Ambisonic order and no rotation
 ~AmbisonicRotator ()
void setNthInput (float amount, Axes axis)
void setTilt (float amount)
void setTumble (float amount)
void setRotate (float amount)
virtual 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
AmbisonicOrder order ()
unsigned frameRate ()
void setFrameRate (unsigned rate)
 get/set the receiver's frame rate
virtual unsigned numChannels ()
void setNumChannels (unsigned ch)
 get/set the receiver's number of outputs
BufferCopyPolicy copyPolicy ()
void setCopyPolicy (BufferCopyPolicy ch)
 get/set the receiver's buffer copy policy
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.
virtual bool isFixed ()
 query whether I'm fixed (StaticVariable overrides this)
virtual bool isActive ()
 query whether I'm currently active (Envelopes can go inactive)
void addOutput (UnitGenerator *ugen)
 add to or return the UGen vector of outputs
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
void handleFanOut (Buffer &outputBuffer) throw (CException)
virtual void setValue (sample theValue)
 set/get the value (not allowed in the abstract, useful for static values)
virtual sample value ()
virtual void dump ()
 pretty-print the receiver
virtual void trigger ()
void attachObserver (Observer *)
 (possibly notify obersvers on my death)
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
virtual int evaluate (void *argument)

Protected Member Functions

void setOrder (AmbisonicOrder order)
 Returns the Ambisonic order.
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.
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)
unsigned orderToChannels (unsigned order)
 Returns the number of Ambisonic channels corresponding to a uniform Ambisonic order: N = (M+1)^2.
unsigned orderToHorizontalChannels (const AmbisonicOrder order)
 Returns the number of horizontal Ambisonic channels from a hybrid Ambisonic order: N_h = 2*M_h + 1.
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)
void channelIndexer (unsigned *indexArray)
 Calculates a lookup table to map Ambisonic channel index to actually used UnitGenerator channel.
void invChannelIndexer (unsigned *indexArray)
 Calculates a lookup table to map actually used UnitGenerator channel to Ambisonic channel index.
void zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
 utility method to zero out an outputBuffer

Protected Attributes

unsigned mNumFrames
unsigned mGreaterOrder
unsigned mNumChannelsGreaterOrder
unsigned * mChannelIndex
unsigned * mInputChannelIndex
bool mShouldRotate
bool mShouldTurn
bool mShouldTilt
AmbisonicOrder mOrder
 the order of the Unit Generator
unsigned mFrameRate
 trigger ignored here
unsigned mNumChannels
 my "expected" number of output channels
BufferCopyPolicy mCopyPolicy
 the policy I use if asked for more or fewer channels
UGenVector mOutputs
 the vector of my output UGens
unsigned mNumOutputs
 the number of outputs
BuffermOutputCache
 my past output ring buffer (only used in case of fan-out)
unsigned mSequence
 the highest-seen buffer seq number

Private Member Functions

void initialize (UnitGenerator &input)
void tiltFirstOrder ()
void tiltSecondOrder ()
void tiltThirdOrder ()
void tumbleFirstOrder ()
void tumbleSecondOrder ()
void tumbleThirdOrder ()
void rotateZerothOrder ()
void rotateFirstOrderHorizontal ()
void rotateSecondOrderHorizontal ()
void rotateThirdOrderHorizontal ()
void rotateFirstOrderVertical ()
void rotateSecondOrderVertical ()
void rotateThirdOrderVertical ()

Private Attributes

PortmInputPort
sample mRotate
sample mTumble
sample mTilt
SampleBuffer mSinAngle
SampleBuffer mCosAngle
SampleBufferVector mOutPtr
SampleBufferVector mInPtr

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 84 of file AmbisonicUtilities.h.


Constructor & Destructor Documentation

AmbisonicRotator::AmbisonicRotator ( AmbisonicUnitGenerator input)

initializes with no rotation

Definition at line 145 of file AmbisonicUtilities.cpp.

References initialize().

AmbisonicRotator::AmbisonicRotator ( UnitGenerator input,
unsigned  order 
)

initializes with uniform Ambisonic order and no rotation

Definition at line 150 of file AmbisonicUtilities.cpp.

References initialize().

AmbisonicRotator::AmbisonicRotator ( UnitGenerator input,
unsigned  vorder,
unsigned  horder 
)

initializes with hybrid Ambisonic order and no rotation

Definition at line 155 of file AmbisonicUtilities.cpp.

References initialize().


Member Function Documentation

void AmbisonicRotator::setNthInput ( float  amount,
Axes  axis 
)
void AmbisonicRotator::setTilt ( float  amount)
void AmbisonicRotator::setTumble ( float  amount)
void AmbisonicRotator::setRotate ( float  amount)

Definition at line 279 of file AmbisonicUtilities.cpp.

References mRotate, and mShouldRotate.

Referenced by csl::AmbisonicPanner::rotate(), and setNthInput().

void AmbisonicRotator::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::UnitGenerator.

Definition at line 294 of file AmbisonicUtilities.cpp.

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

void AmbisonicRotator::tiltFirstOrder ( )
private

Definition at line 394 of file AmbisonicUtilities.cpp.

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

void AmbisonicRotator::tiltSecondOrder ( )
private
void AmbisonicRotator::tiltThirdOrder ( )
private

Definition at line 431 of file AmbisonicUtilities.cpp.

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

Referenced by tiltSecondOrder().

void AmbisonicRotator::tumbleFirstOrder ( )
private

Definition at line 458 of file AmbisonicUtilities.cpp.

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

void AmbisonicRotator::tumbleSecondOrder ( )
private
void AmbisonicRotator::tumbleThirdOrder ( )
private

Definition at line 491 of file AmbisonicUtilities.cpp.

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

Referenced by tumbleSecondOrder().

void csl::AmbisonicRotator::rotateZerothOrder ( )
private
void AmbisonicRotator::rotateFirstOrderHorizontal ( )
private
void AmbisonicRotator::rotateSecondOrderHorizontal ( )
private
void AmbisonicRotator::rotateThirdOrderHorizontal ( )
private

Definition at line 564 of file AmbisonicUtilities.cpp.

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

Referenced by rotateSecondOrderHorizontal().

void csl::AmbisonicRotator::rotateFirstOrderVertical ( )
private
void AmbisonicRotator::rotateSecondOrderVertical ( )
private
void AmbisonicRotator::rotateThirdOrderVertical ( )
private

Definition at line 580 of file AmbisonicUtilities.cpp.

References mCosAngle, mNumFrames, mOutPtr, and mSinAngle.

Referenced by rotateSecondOrderVertical().

AmbisonicOrder csl::AmbisonicUnitGenerator::order ( )
inlineinherited
void AmbisonicUnitGenerator::setOrder ( AmbisonicOrder  order)
protectedinherited

Returns the Ambisonic order.

Definition at line 61 of file Ambisonic.cpp.

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

unsigned AmbisonicUnitGenerator::channelsToUniformOrder ( const unsigned  channels)
protectedinherited
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 73 of file Ambisonic.cpp.

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

Referenced by csl::AmbisonicUnitGenerator::channelIndexer(), initialize(), csl::AmbisonicDecoder::initialize(), and csl::AmbisonicDecoder::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 77 of file Ambisonic.cpp.

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

Referenced by csl::AmbisonicUnitGenerator::channelIndexer(), initialize(), csl::AmbisonicDecoder::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 82 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 87 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 92 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 148 of file Ambisonic.cpp.

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

Referenced by csl::AmbisonicDecoder::initialize().

void csl::UnitGenerator::setFrameRate ( unsigned  rate)
inlineinherited

get/set the receiver's frame rate

Definition at line 226 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by m3_header().

void csl::UnitGenerator::setNumChannels ( unsigned  ch)
inlineinherited
BufferCopyPolicy csl::UnitGenerator::copyPolicy ( )
inlineinherited

Definition at line 231 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 247 of file CSL_Core.h.

virtual bool csl::UnitGenerator::isActive ( )
inlinevirtualinherited
UGenVector csl::UnitGenerator::outputs ( )
inlineinherited

Definition at line 253 of file CSL_Core.h.

References csl::UnitGenerator::mOutputs.

virtual unsigned csl::UnitGenerator::numOutputs ( )
inlinevirtualinherited

Definition at line 254 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 549 of file CSL_Core.cpp.

void UnitGenerator::handleFanOut ( Buffer outputBuffer) throw (CException)
inherited

Definition at line 563 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 260 of file CSL_Core.h.

virtual sample csl::UnitGenerator::value ( )
inlinevirtualinherited

Reimplemented in csl::StaticVariable.

Definition at line 261 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 513 of file CSL_Core.cpp.

References csl::Buffer::mMonoBufferByteSize, and csl::Buffer::monoBuffer().

void Model::attachObserver ( Observer o)
inherited

(possibly notify obersvers on my death)

register/remove observers

Definition at line 491 of file CGestalt.cpp.

References csl::logMsg(), csl::Observer::mKey, and csl::Observer::mPeriod.

Referenced by 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 529 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 259 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 627 of file AmbisonicUtilities.cpp.

References MAX, PYTHAG, and SIGN.

Referenced by csl::AmbisonicDecoder::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

unsigned csl::AmbisonicRotator::mGreaterOrder
protected

Definition at line 108 of file AmbisonicUtilities.h.

Referenced by initialize(), tiltSecondOrder(), and tumbleSecondOrder().

unsigned csl::AmbisonicRotator::mNumChannelsGreaterOrder
protected

Definition at line 109 of file AmbisonicUtilities.h.

Referenced by initialize().

unsigned* csl::AmbisonicRotator::mChannelIndex
protected

Definition at line 110 of file AmbisonicUtilities.h.

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

unsigned* csl::AmbisonicRotator::mInputChannelIndex
protected

Definition at line 111 of file AmbisonicUtilities.h.

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

bool csl::AmbisonicRotator::mShouldRotate
protected

Definition at line 112 of file AmbisonicUtilities.h.

Referenced by initialize(), and setRotate().

bool csl::AmbisonicRotator::mShouldTurn
protected

Definition at line 112 of file AmbisonicUtilities.h.

Referenced by initialize(), and setTumble().

bool csl::AmbisonicRotator::mShouldTilt
protected

Definition at line 112 of file AmbisonicUtilities.h.

Referenced by initialize(), and setTilt().

Port* csl::AmbisonicRotator::mInputPort
private

Definition at line 115 of file AmbisonicUtilities.h.

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

sample csl::AmbisonicRotator::mRotate
private

Definition at line 117 of file AmbisonicUtilities.h.

Referenced by setRotate().

sample csl::AmbisonicRotator::mTumble
private

Definition at line 117 of file AmbisonicUtilities.h.

Referenced by setTumble().

sample csl::AmbisonicRotator::mTilt
private

Definition at line 117 of file AmbisonicUtilities.h.

Referenced by setTilt().

SampleBufferVector csl::AmbisonicRotator::mInPtr
private

Definition at line 119 of file AmbisonicUtilities.h.

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

BufferCopyPolicy csl::UnitGenerator::mCopyPolicy
protectedinherited

the policy I use if asked for more or fewer channels

Definition at line 269 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 271 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 272 of file CSL_Core.h.

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

unsigned csl::UnitGenerator::mSequence
protectedinherited

the highest-seen buffer seq number

Definition at line 273 of file CSL_Core.h.


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