[4504] | 1 | /*! |
---|
| 2 | \file sound_engine.h |
---|
| 3 | \brief Definition of the SoundEngine singleton Class |
---|
| 4 | */ |
---|
| 5 | |
---|
| 6 | #ifndef _SOUND_ENGINE_H |
---|
| 7 | #define _SOUND_ENGINE_H |
---|
| 8 | |
---|
| 9 | #include "base_object.h" |
---|
| 10 | #include "alincl.h" |
---|
| 11 | |
---|
| 12 | |
---|
[4506] | 13 | #define SOUND_DOPPLER_FACTOR 0.001 //!< A factor for the audible doppler effect |
---|
| 14 | #define SOUND_DOPPLER_VELOCITY 5000000 //!< A factor for the TravelSpeed of sound |
---|
[4504] | 15 | |
---|
| 16 | // FORWARD DEFINITION |
---|
| 17 | class PNode; |
---|
| 18 | template<class T> class tList; |
---|
| 19 | |
---|
| 20 | |
---|
| 21 | //! A class that represents a datastructure to play Sounds. |
---|
| 22 | class SoundBuffer |
---|
| 23 | { |
---|
| 24 | public: |
---|
| 25 | SoundBuffer(const char* fileName); |
---|
| 26 | ~SoundBuffer(void); |
---|
| 27 | |
---|
[4506] | 28 | /** \returns the ID of the buffer used in this SoundBuffer */ |
---|
[4504] | 29 | inline ALuint getID(void) { return this->bufferID; } |
---|
| 30 | |
---|
| 31 | private: |
---|
[4506] | 32 | ALuint bufferID; //!< The address of the Buffer. |
---|
[4504] | 33 | |
---|
[4506] | 34 | ALsizei size; //!< The size of the Buffer. |
---|
| 35 | ALboolean loop; //!< loop information. |
---|
[4504] | 36 | }; |
---|
| 37 | |
---|
| 38 | //! A class that represents a SoundSource |
---|
| 39 | class SoundSource |
---|
| 40 | { |
---|
| 41 | public: |
---|
| 42 | SoundSource(SoundBuffer* buffer, PNode* sourceNode = NULL); |
---|
| 43 | ~SoundSource(void); |
---|
[4506] | 44 | |
---|
[4504] | 45 | // user interaction |
---|
| 46 | void play(); |
---|
| 47 | void stop(); |
---|
| 48 | void pause(); |
---|
| 49 | void rewind(); |
---|
[4506] | 50 | |
---|
[4504] | 51 | // development functions |
---|
| 52 | /** \returns The ID of this Source */ |
---|
| 53 | inline ALuint getID(void) const { return this->sourceID; } |
---|
| 54 | /** \returns the SoundBuffer of this Source */ |
---|
| 55 | inline SoundBuffer* getBuffer(void) const { return this->buffer; } |
---|
| 56 | /** \returns the SourceNode of this Source */ |
---|
| 57 | inline PNode* getNode(void) const { return this->sourceNode;} |
---|
| 58 | |
---|
| 59 | void setRolloffFactor(ALfloat rolloffFactor); |
---|
| 60 | |
---|
| 61 | private: |
---|
[4506] | 62 | ALuint sourceID; //!< The ID of the Source |
---|
| 63 | SoundBuffer* buffer; //!< The buffer to play in this source. |
---|
| 64 | PNode* sourceNode; //!< The SourceNode represente the position/velocity... of this source. |
---|
[4504] | 65 | }; |
---|
| 66 | |
---|
| 67 | |
---|
| 68 | |
---|
| 69 | //! A class that handles audio via the openAudioLibrary |
---|
| 70 | class SoundEngine : public BaseObject { |
---|
| 71 | |
---|
| 72 | public: |
---|
| 73 | virtual ~SoundEngine(void); |
---|
[4519] | 74 | /** \returns a Pointer to the only object of this Class */ |
---|
| 75 | inline static SoundEngine* getInstance(void) { if (!singletonRef) singletonRef = new SoundEngine(); return singletonRef; }; |
---|
[4504] | 76 | |
---|
| 77 | SoundSource* createSource(const char* fileName, PNode* sourceNode = NULL); |
---|
| 78 | |
---|
| 79 | void setListener(PNode* listener); |
---|
| 80 | void setDopplerValues(ALfloat dopplerFactor, ALfloat dopplerVelocity); |
---|
| 81 | |
---|
| 82 | |
---|
| 83 | void addBuffer(SoundBuffer* buffer); |
---|
| 84 | void removeBuffer(SoundBuffer* buffer); |
---|
| 85 | void addSource(SoundSource* source); |
---|
| 86 | void removeSource(SoundSource* source); |
---|
| 87 | |
---|
| 88 | void update(void); |
---|
| 89 | |
---|
| 90 | // administrative |
---|
| 91 | void flushUnusedBuffers(void); |
---|
| 92 | void flushAllBuffers(void); |
---|
| 93 | bool initAudio(void); |
---|
| 94 | |
---|
| 95 | // error handling: |
---|
| 96 | static void PrintALErrorString(ALenum err); |
---|
| 97 | // static void PrintALCErrorString(ALenum err); |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | private: |
---|
| 101 | SoundEngine(void); |
---|
[4506] | 102 | static SoundEngine* singletonRef; //!< Reference to this class |
---|
[4504] | 103 | |
---|
| 104 | |
---|
[4506] | 105 | PNode* listener; //!< The listener of the Scene |
---|
| 106 | tList<SoundBuffer>* bufferList; //!< A list of buffers |
---|
| 107 | tList<SoundSource>* sourceList; //!< A list for all the sources in the scene. |
---|
[4504] | 108 | |
---|
| 109 | }; |
---|
| 110 | |
---|
| 111 | #endif /* _SOUND_ENGINE_H */ |
---|