SoundMgr.H

Go to the documentation of this file.

#ifndef SOUNDMGR_H
#define SOUNDMGR_H

#include "IS3DCommon.H"

namespace IS3D {

// types of parameters that can be set for each sound
enum SOUNDPARAM {
  SP_LOOP = 0,    // 0.0 or 1.0
  SP_PITCH = 1,   // (0.0,1.0] default=1.0
  SP_GAIN = 2,    // [0.0,any] default=1.0 0.0=mute 1.0=normal
  SP_POSX = 3,    // default <0,0,0>
  SP_POSY = 4,
  SP_POSZ = 5,
  SP_VELX = 6,    // default <0,0,0>
  SP_VELY = 7,
  SP_VELZ = 8,

  SP_NUM_PARAMS = 9
};

typedef ReferenceCountedPointer<class SoundImplementation> SoundImplementationRef;
class SoundImplementation : public ReferenceCountedObject
{
public:
  // listener related
  virtual void setListenerLoc(const CoordinateFrame &m) = 0;
  virtual void setListenerVel(const Vector3 &v) =  0;
  virtual void setListenerGain(const float g) = 0;

  // for each sound, accessed via &filename
  virtual void load(const std::string &filename) = 0;
  virtual void play(const std::string &filename) = 0;
  virtual void stop(const std::string &filename) = 0;
  virtual void deleteSound(const std::string &filename) = 0;
  virtual void setParam(const std::string &filename, const SOUNDPARAM param, 
            const float value) = 0;
};


// after adding an implementation to the SOUNDMGR, either a 
// compiled-in implementation or a network interface to a soundserver,
// make calls to SOUNDMGR within a program to deal with sounds
class SoundMgr
{
public:

  // add a sound device to the manager..  need to do this before
  // anything can be played!
  // examples of implementations: 
  // 1. a network interface for a sound server
  // 2. code that makes calls to a sound library like OpenAL
  static void addImplementation(SoundImplementationRef simp);

  static void setListenerLoc(const CoordinateFrame &m);
  static void setListenerVel(const Vector3 &v);
  static void setListenerGain(float g);

  // load a sound into memory
  static void load(const std::string &filename);
  // play a sound, if not already loaded will try to load first
  static void play(const std::string &filename);
  // stop playing a sound
  static void stop(const std::string &filename);
  // remove a sound file from memory
  static void deleteSound(const std::string &filename);

  // sets a parameter for a sound, for example, pitch, freq, or gain.
  static void setParam(const std::string &filename, const SOUNDPARAM param, 
               const float value);
  
private:

  static void warnNoImplementation(const std::string &attemptedAction);

  static Array<SoundImplementationRef> _imp;

};

} // end namespace

#endif

---