VBAP.h

Go to the documentation of this file.

#ifndef CSL_VBAP_H
#define CSL_VBAP_H

#include "CSL_Core.h"
#include "SpatialPanner.h"

//#define CSL_DEBUG

#define MAX_NUM_VBAP_SOURCES 8

#include <iostream>

#define _NO_EXCEPTION

#include "matrix.h"

#ifndef _NO_NAMESPACE
  using namespace std;
  using namespace math;
#  define STD std
#else
#  define STD
#endif

#  define TRYBEGIN()
#  define CATCHERROR()

typedef matrix<double> CSLMatrix;

namespace csl {

#define deg2rad(x)   (((double)x ) * CSL_TWOPI) / 360.0

typedef enum {
    kAuto = 0,
    kPantophonic = 2,       
    kPeriphonic = 3         
} VBAPMode;

class SpeakerSetLayout;  // Forward declaration. See below.



class VBAP : public SpatialPanner {
public:
    VBAP(VBAPMode mode = kAuto, SpeakerLayout *layout = SpeakerLayout::defaultSpeakerLayout()); 

    virtual ~VBAP();
    
    void nextBuffer(Buffer &outputBuffer, unsigned outBufNum) throw (CException);

    void dump() { }; 

protected:
    VBAPMode mMode;     
    SpeakerSetLayout *mSpeakerSetLayout;  
 
    virtual void *cache();      
    virtual void speakerLayoutChanged();    

};

class StereoPanner : public VBAP {
public:
    StereoPanner();
    virtual ~StereoPanner();

    void addInput(UnitGenerator &input, float panPosition);
    
};

class SurroundPanner : public VBAP {
public:
    SurroundPanner(unsigned numSpeakers = 5, bool useSubwoofer = true);
    virtual ~SurroundPanner();

};

// Used for caching data from previous callbacks. Each SpatialSource has its own set of data to be remembered.
// This is just for internal use of the VBAP object.
class VBAPSourceCache {
public:
    VBAPSourceCache() : tripletIndex(0) { };
    ~VBAPSourceCache() { };
    
    float gains[3];
    unsigned tripletIndex;
};
 
class SpeakerSet { 
public:
    SpeakerSet(unsigned size = 3);
    ~SpeakerSet();

    unsigned *nodes;        
    CSLMatrix *invL;        
    void dump();        
};

/*// **** SPEAKER TRIPLET LAYOUT  ***** 
TO AVOID BUILDING A TRIPLET LAYOUT PER VBAP INSTANCE, THE VBAP CLASS WILL HAVE A STATIC METHOD THAT 
RETURS A MAP OF THE SPEAKER LAYOUT (KEY) AND THE TRIPLET SPEAKER LAYOUT (VALUE). THIS WAY, IF ANOTHER
INSTANCE HAS ALREADY CREATED A TRIPLET LAYOUT (IN OTHER WORDS IF A NEW INSTANCE IS USING THE SAME LAYOUT
THAN THE ALREADY CREATED INSTANCE) THEN A POINTER TO THE TRIPLET LAYOUT WILL BE RETURNED.
AS AN ALTERNATIVE, INSTEAD OF A MAP, THE TRIPLET SPEAKER LAYOUT WILL HOLD A POINTER TO THE SPEAKER LAYOUT
AND WILL BE ABLE TO COMPARE TO A PASSED POINTER. IN THES CASE, A STATIC VECTOR OF TRIPLET LAYOUTS WOULD HOLD
THE ALREADY CREATED TRIPLET LAYOUTS AND WHEN CREATING A NEW VBAP INSTANCE, IT WOULD GO THRU EACH TRIPLET LAYOUT
(IF ANY) COMPARING SPEAKER LAYOUT ADDRESSES. IF A MATCH IS FOUND, THE TRIPLET LAYOUT WOULD BE SET TO BE THE OBJECT
HELD BY THE VBAP INSTANCE (EACH VBAP INSTANCE WILL KEEP ITS OWN POINTER TO ITS TRIPLET LAYOUT OBJECT. FOR THIS TO WORK
SOME SORT OF COUNT WILL BE NEEDED SO WHEN NO OBJECT IS KEEPING A TRIPLET, THEN IT SHOULD GET DESTROYED.
WHEN SETTING THE SPEAKER LAYOUT, THE OBJECT WILL HAVE TO SEARCH AGAIN FOR TRIPLET LAYOUTS ALREADY CREATED, AND RE COMPUTE 
ONE IF NONE EXISTS.
ADVANTAGES: 
    A) THE TRIPLET FINDING GOES TO THE LAYOUT AND AWAY FROM THE VBAP, SIMPLIFYING THE VABAP INTERFACE.
    B) SAVES MEMORY USAGE BY HAVING ONLY ONE INSTANCE OF TRIPLETS FOR EACH LAYOUT USED.
        IN MOST CASES, ONLY ONE LAYOUT IS USED, WHICH TRANSLATIES INTO ONLY ONE SET OF TRIPLETS IN MEMORY.
    C) SAVES COMPUTATION BY NOT RECALCULATING TRIPLETS FOR EACH VBAP INSTANCE. IT DOES IT ONLY ON ONE.
    
COST:
    A) COMPUTATIONALLY THE COST IS MINIMAL. AT INSTANTIATION TIME, THE OBJECT HAS TO SEARCH THRU A VECTOR. 
        THIS BECOMES NULL IF NO OBJECTS ARE USED AND INSIGNIFICANT WHEN ONE OR MORE OBJECTS ARE INSTANTIATED.
    B) REGARDING MEMORY, IT'LL HAVE TO LOAD STATICALLY A VECTOR AT APP LOAD TIME...

*/
class SpeakerSetLayout {
friend class VBAP; // Grant VBAP the access to your private members.
public:
    SpeakerSetLayout(SpeakerLayout *aLayout, VBAPMode mode = kAuto); 
    ~SpeakerSetLayout();                

    SpeakerLayout *speakerLayout() { return mSpeakerLayout; }; // Ussed to compare layouts in case it's already calculated.

    void dump();

private:
    // THE TRIPLETS SHOULD BE SHARED AMONG ALL VBAP OBJECTS, UNLESS MULTIPLE LAYOUTS ARE USED SIMULTANEOUSLY.
    SpeakerSet **mTriplets; // list of output triples
    SpeakerLayout *mSpeakerLayout;
    unsigned mNumTriplets;
    unsigned mMode;
    
    void findSpeakerTriplets() throw(CException);
    void findSpeakerPairs() throw(CException);
    void invertTripleMatrix(SpeakerSet *lst);
    void addTriple(SpeakerSet *lst);
    void removeTriple(SpeakerSet *lst);
    bool evaluateCrossing(CPoint &li, CPoint &lj, CPoint &ln, CPoint &lm);
};

} // end namespace

#endif

---