source: orxonox.OLD/branches/2d-recalc/src/lib/sound/sound_engine.h @ 5802

/*!
 * @file sound_engine.h
 * Definition of the SoundEngine singleton Class
 */

#ifndef _SOUND_ENGINE_H
#define _SOUND_ENGINE_H

#include "base_object.h"
#include "alincl.h"

#define SOUND_DOPPLER_FACTOR       0.001          //!< A factor for the audible doppler effect
#define SOUND_DOPPLER_VELOCITY     5000000        //!< A factor for the TravelSpeed of sound

// FORWARD DEFINITION
class PNode;
template<class T> class tList;
class IniParser;


//! A class that represents a datastructure to play Sounds.
class SoundBuffer : public BaseObject
{
  public:
    SoundBuffer(const char* fileName);
    ~SoundBuffer();

    /** @returns the ID of the buffer used in this SoundBuffer */
    inline ALuint getID() const { return this->bufferID; }

  private:
    ALuint        bufferID;             //!< The address of the Buffer.

    ALsizei       size;                 //!< The size of the Buffer.
    ALboolean     loop;                 //!< loop information.
};

//! A class that represents a SoundSource
class SoundSource : public BaseObject
{
  public:
    SoundSource(const PNode* sourceNode = NULL, const SoundBuffer* buffer = NULL);
    ~SoundSource();

  // user interaction
    void play();
    void play(const SoundBuffer* buffer);
    void stop();
    void pause();
    void rewind();

  // development functions
    /** @returns The ID of this Source */
    inline ALuint getID() const { return this->sourceID; }
    /** @returns the SoundBuffer of this Source */
    inline const SoundBuffer* getBuffer() const { return this->buffer; }
    /** @returns the SourceNode of this Source */
    inline const PNode* getNode() const { return this->sourceNode;}

    void setRolloffFactor(ALfloat rolloffFactor);

  private:
    ALuint                 sourceID;              //!< The ID of the Source
    const SoundBuffer*     buffer;                //!< The buffer to play in this source.
    const PNode*           sourceNode;            //!< The SourceNode represente the position/velocity... of this source.
};



//! A class that handles audio via the openAudioLibrary
class SoundEngine : public BaseObject {

  public:
    virtual ~SoundEngine();
    /** @returns a Pointer to the only object of this Class */
    inline static SoundEngine* getInstance() { if (!SoundEngine::singletonRef) SoundEngine::singletonRef = new SoundEngine();  return SoundEngine::singletonRef; };

    void loadSettings(IniParser* iniParser);

    SoundSource* createSource(const char* fileName, PNode* sourceNode = NULL);

    /** @param listener the listener in the scene */
    void setListener(PNode* listener) { this->listener = listener; };
    void setDopplerValues(ALfloat dopplerFactor, ALfloat dopplerVelocity);


    /** @returns the Music Volume in % */
    inline float getMusicVolume() { return this->musicVolume; };
    /** @returns the Effects Volume in % */
    inline float getEffectsVolume() { return this->effectsVolume; };

    void update();

  // administrative
    void addBuffer(SoundBuffer* buffer);
    void removeBuffer(SoundBuffer* buffer);
    void addSource(SoundSource* source);

    void flushUnusedBuffers();
    void flushAllBuffers();
    void flushAllSources();
    bool initAudio();

  // error handling:
    static void PrintALErrorString(ALenum err);
  //  static void PrintALCErrorString(ALenum err);


  private:
    SoundEngine();
    void listDevices();

  private:
    static SoundEngine*      singletonRef;             //!< Reference to this class

    float                    musicVolume;              //!< the maximum volume of the music in % (0f,1f]
    float                    effectsVolume;            //!< the maximum volume of sound-effects in % (0f,1f]
    PNode*                   listener;                 //!< The listener of the Scene
    tList<BaseObject>*       bufferList;               //!< A list of buffers
    tList<BaseObject>*       sourceList;               //!< A list for all the sources in the scene.

};

#endif /* _SOUND_ENGINE_H */