Changeset 6370 for code/branches/presentation2/src/orxonox/sound/SoundManager.h

Timestamp:

Dec 17, 2009, 11:10:39 AM (14 years ago)

Author:

rgrieder

Message:

Little cleanup in sound stuff and MoodManager.
Caution: Renamed SoundTypes to {All, Music, Effects}!

File:

• code/branches/presentation2/src/orxonox/sound/SoundManager.h (modified) (5 diffs)

code/branches/presentation2/src/orxonox/sound/SoundManager.h

@@ -50 +50 @@
     // forward declaration
     class SoundBuffer;
-    
+
     //! Enum for the sound type.
     namespace SoundType
@@ -56 +56 @@
         enum Value
         {
-            none,
-            ambient,
-            effects
+            All     = 0,
+            Music   = 1,
+            Effects = 2
         };
     }
-    
-    /**
-     * The SoundManager class manages the OpenAL device, context and listener
-     * position. It is a singleton.
-     *
-     */
+
+    //! The SoundManager class manages the OpenAL device, context and listener position.
     class _OrxonoxExport SoundManager
     // tolua_end
@@ -94 +90 @@
         void pauseAmbientSound(AmbientSound* ambient);
 
+        // tolua_begin
         void setVolume(float vol, SoundType::Value type);
-        float getVolume(SoundType::Value type); // tolua_export
+        float getVolume(SoundType::Value type);
+        float getRealVolume(SoundType::Value type);
 
-        void toggleMute(SoundType::Value type); // tolua_export
-        bool getMute(SoundType::Value type); // tolua_export
+        void toggleMute(SoundType::Value type);
+        bool getMute(SoundType::Value type);
+        // tolua_end
 
         shared_ptr<SoundBuffer> getSoundBuffer(const std::string& filename);
@@ -114 +113 @@
 
         void checkFadeStepValidity();
-        bool checkVolumeValidity(SoundType::Value type);
-        void checkSoundVolumeValidity(void);
-        void checkAmbientVolumeValidity(void);
-        void checkEffectsVolumeValidity(void);
 
-        float checkVolumeRange(float vol);
-
+        void checkVolumeValidity(SoundType::Value type);
+        void checkSoundVolumeValidity()   { this->checkVolumeValidity(SoundType::All); }
+        void checkAmbientVolumeValidity() { this->checkVolumeValidity(SoundType::Music); }
+        void checkEffectsVolumeValidity() { this->checkVolumeValidity(SoundType::Effects); }
         void updateVolume(SoundType::Value type);
 
-        void setVolumeInternal(float vol, SoundType::Value type);
-        float getVolumeInternal(SoundType::Value type);
-
+        // OpenAL device/context related
         std::vector<std::string> deviceNames_;
         ALCdevice* device_;
         ALCcontext* context_;
 
+        // Ambient sound related
         typedef std::list<std::pair<AmbientSound*, bool> > AmbientList;
-        AmbientList ambientSounds_;
-
-        float crossFadeStep_;       //!< Absolute change per second (0.1 means 10% of the nominal volume) for cross fading
+        AmbientList                        ambientSounds_;
+        //! Absolute change per second (0.1 means 10% of the nominal volume) for cross fading
+        float                              crossFadeStep_;
         std::list<SmartPtr<AmbientSound> > fadeInList_;
         std::list<SmartPtr<AmbientSound> > fadeOutList_;
 
-        float soundVolume_;
-        float ambientVolume_;
-        float effectsVolume_;
-        std::map<SoundType::Value, bool> mute_;
+        // Volume related
+        float volume_[3];
+        float mute_[3];
 
+        // Sound buffer related
         static const unsigned int maxEffectsPoolSize_s = 40 * 1024 * 1024;
         unsigned int effectsPoolSize_;
@@ -149 +145 @@
         SoundBufferMap soundBuffers_;
 
+        // Sound source related
         unsigned int maxSources_;
         std::vector<ALuint> soundSources_;