SpeakerLayout.h

Go to the documentation of this file.

//
//  SpeakerLayout.h -- Class for loading and parsing loudspeaker position information used 
//      by the Spatializer and Auralizer classes.
//  See the copyright notice and acknowledgment of authors in the file COPYRIGHT
//  Created by Jorge Castellanos on 6/16/06. Hacked 8/09 by STP.
//

#ifndef SPEAKERLAYOUT_H
#define SPEAKERLAYOUT_H

#include "CSL_Core.h"
#include "CPoint.h"

namespace csl {

class Speaker;      // Forward declaration. See below.

class SpeakerLayout : public Model {
public:
    // Constructors & destructor:
    SpeakerLayout(const char *filePath = NULL); 
    virtual ~SpeakerLayout();               

    void readSpeakerFile(const char *filePath);

    static SpeakerLayout *defaultSpeakerLayout();
    static void setDefaultSpeakerLayout(SpeakerLayout *defaultLayout);
    
    void addSpeaker(float azimuth, float elevation = 0.0, float radius = 1.0);
    void addSpeaker(float x, float y, float z, float xNorm, float yNorm, float zNorm, float gain);

    unsigned numSpeakers() const { return mSpeakers.size(); };  

    void normalizeSpeakerDistances(float radius = 0);
    
    Speaker *speakerAtIndex(unsigned speakerIndex) const { return mSpeakers[speakerIndex]; };

    bool isPeriphonic() { return (mDimensions == 3); }; 
    void dump();

protected:
    vector<Speaker *> mSpeakers;            


private:
    unsigned mDimensions;
//  void cartesianToSphericalRadians(); // convert speaker layout given in cartesian coordinates to spherical radians
    static SpeakerLayout *sDefaultSpeakerLayout;
    float *mSpeakerDistanceDeltas;      
    
public:
    SpeakerLayout &operator=(const SpeakerLayout &layout); 
};


class StereoSpeakerLayout : public SpeakerLayout {
public:
    StereoSpeakerLayout();
};


class Speaker {
public:
    Speaker(float azimuth, float elevation, float radius = 1.0);
    
    // constructor with normal point. x,y,z are position, xNorm,yNorm,zNorm are a point to which the speaker is facing. converted to a normalized vector by Speaker class.
    Speaker(float x, float y, float z, float xNorm, float yNorm, float zNorm, float gain = 1.0);

    ~Speaker() { };
    
    CPoint position()   { return mPosition; }; // Return the position of the speaker.
    float azimuth() { return mPosition.theta(); };
    float elevation()   { return mPosition.ele(); };
    float radius()      { return mPosition.r(); };
    void setRadius(float radius); 
    
    CPoint normal() { return mNormal; }; // Return the normal of the speaker.
    float speakerGain()     { return mGain;};
    
    void dump(); 

protected:
    CPoint mPosition;
    CPoint mNormal; // normal vector for speaker
    float mGain;    // a speaker dependant gain, defaults to 1.
}; 

}

#endif