Changeset 6322 for code/branches/presentation2/src/orxonox

Timestamp:

Dec 11, 2009, 2:15:43 PM (15 years ago)

Author:

rgrieder

Message:

Added audio source management. This should reduce the problems when loading too many sounds.
However if there are too many players shooting at the same time, some sounds may still not play.

Location:

code/branches/presentation2/src/orxonox/sound

Files:

• AmbientSound.cc (modified) (1 diff)
• AmbientSound.h (modified) (1 diff)
• BaseSound.cc (modified) (14 diffs)
• BaseSound.h (modified) (1 diff)
• SoundManager.cc (modified) (6 diffs)
• SoundManager.h (modified) (2 diffs)
• WorldSound.cc (modified) (1 diff)
• WorldSound.h (modified) (1 diff)

code/branches/presentation2/src/orxonox/sound/AmbientSound.cc

@@ -119 +119 @@
     float AmbientSound::getVolumeGain()
     {
+        assert(GameMode::playsSound());
         return SoundManager::getInstance().getVolume(SoundType::ambient);
     }

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

@@ -50 +50 @@
     public:
         AmbientSound(BaseObject* creator);
-        virtual ~AmbientSound();
+        ~AmbientSound();
 
-        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
-        virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
-        virtual void changedActivity();
+        void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+        void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
+        void changedActivity();
 
-        virtual void play();
-        virtual void stop();
-        virtual void pause();
+        void play();
+        void stop();
+        void pause();
         
-        virtual float getVolumeGain();
+        float getVolumeGain();
 
-        virtual void setAmbientSource(const std::string& source);
+        void setAmbientSource(const std::string& source);
         const std::string& getAmbientSource() const { return this->ambientSource_; }
         inline void ambientSourceChanged(){ this->setAmbientSource(this->ambientSource_); }

code/branches/presentation2/src/orxonox/sound/BaseSound.cc

@@ -43 +43 @@
 {
     BaseSound::BaseSound()
-        : audioSource_(0)
-        , bPooling_(false)
+        : bPooling_(false)
         , volume_(1.0)
         , bLooping_(false)
@@ -52 +51 @@
         RegisterRootObject(BaseSound);
 
-        if (GameMode::playsSound())
-        {
-            alGenSources(1, &this->audioSource_);
-            if (!alIsSource(this->audioSource_))
-                COUT(1) << "Sound: Source generation failed: " << SoundManager::getALErrorString(alGetError()) << std::endl;
-
-            if (alIsSource(this->audioSource_))
-            {
-                alSourcei(this->audioSource_, AL_REFERENCE_DISTANCE, 20);
-                alSourcei(this->audioSource_, AL_MAX_DISTANCE, 10000);
-            }
-        }
+        // Initialise audioSource_ to a value that is not a source
+        // 0 is unfortunately not guaranteed to be no source ID.
+        this->audioSource_ = 123456789;
+        while (alIsSource(++this->audioSource_));
     }
 
     BaseSound::~BaseSound()
     {
-        this->setSource(std::string());
-        if (GameMode::playsSound() && alIsSource(this->audioSource_))
-            alDeleteSources(1, &this->audioSource_);
+        this->stop();
     }
 
@@ -84 +73 @@
     {
         this->state_ = Playing;
-        if (GameMode::playsSound() && alIsSource(this->audioSource_) && this->getSourceState() != AL_PLAYING)
-        {
+        if (GameMode::playsSound() && this->getSourceState() != AL_PLAYING && this->soundBuffer_ != NULL)
+        {
+            if (!alIsSource(this->audioSource_))
+                this->audioSource_ = SoundManager::getInstance().getSoundSource();
+            if (!alIsSource(this->audioSource_))
+                return;
+            this->initialiseSource();
+
             alSourcePlay(this->audioSource_);
-
             if (int error = alGetError())
-                COUT(2) << "Sound: Error playing sound: " << error << std::endl;
+                COUT(2) << "Sound: Error playing sound: " << SoundManager::getALErrorString(error) << std::endl;
         }
     }
@@ -96 +90 @@
     {
         this->state_ = Stopped;
-        if (GameMode::playsSound() && alIsSource(this->audioSource_))
+        if (alIsSource(this->audioSource_))
+        {
             alSourceStop(this->audioSource_);
+            // Release buffer
+            alSourcei(this->audioSource_, AL_BUFFER, AL_NONE);
+            // Release source again
+            SoundManager::getInstance().releaseSoundSource(this->audioSource_);
+            // Get a no source ID
+            this->audioSource_ += 123455;
+            while (alIsSource(++this->audioSource_));
+        }
     }
 
@@ -105 +108 @@
             return;
         this->state_ = Paused;
-        if (GameMode::playsSound() && alIsSource(this->audioSource_))
+        if (alIsSource(this->audioSource_))
             alSourcePause(this->audioSource_);
     }
@@ -111 +114 @@
     ALint BaseSound::getSourceState() const
     {
-        if (GameMode::playsSound() && alIsSource(this->audioSource_))
+        if (alIsSource(this->audioSource_))
         {
             ALint state;
@@ -121 +124 @@
     }
 
+    void BaseSound::initialiseSource()
+    {
+        this->updateVolume();
+        this->setPitch(this->getPitch());
+        this->setLooping(this->getLooping());
+        alSource3f(this->audioSource_, AL_POSITION,  0, 0, 0);
+        alSource3f(this->audioSource_, AL_VELOCITY,  0, 0, 0);
+        alSource3f(this->audioSource_, AL_DIRECTION, 0, 0, 0);
+        alSourcei(this->audioSource_, AL_REFERENCE_DISTANCE, 20);
+        alSourcei(this->audioSource_, AL_MAX_DISTANCE, 10000);
+        if (ALint error = alGetError())
+            COUT(2) << "Sound Warning: Setting source parameters to 0 failed: "
+                    << SoundManager::getALErrorString(error) << std::endl;
+        assert(this->soundBuffer_ != NULL);
+        alSourcei(this->audioSource_, AL_BUFFER, this->soundBuffer_->getBuffer());
+        if (ALuint error = alGetError())
+            COUT(1) << "Sound Error: Could not set buffer \"" << this->source_ << "\": " << SoundManager::getALErrorString(error) << std::endl;
+    }
+
     void BaseSound::setVolume(float vol)
     {
@@ -136 +158 @@
     float BaseSound::getVolumeGain()
     {
+        assert(GameMode::playsSound());
         return SoundManager::getInstance().getVolume(SoundType::none);
     }
@@ -143 +166 @@
         if (alIsSource(this->audioSource_))
         {
-            alSourcef(this->audioSource_, AL_GAIN, this->volume_*this->getVolumeGain());
+            float volume = this->volume_ * this->getVolumeGain();
+            alSourcef(this->audioSource_, AL_GAIN, volume);
             if (int error = alGetError())
-                COUT(2) << "Sound: Error setting volume: " << error << std::endl;
+                COUT(2) << "Sound: Error setting volume to " << volume
+                        << ": " << SoundManager::getALErrorString(error) << std::endl;
         }
     }
@@ -152 +177 @@
     {
         this->bLooping_ = val;
-        if (GameMode::playsSound() && alIsSource(this->audioSource_))
+        if (alIsSource(this->audioSource_))
             alSourcei(this->audioSource_, AL_LOOPING, (val ? AL_TRUE : AL_FALSE));
     }
@@ -165 +190 @@
         }        
         this->pitch_ = pitch;
-        if (GameMode::playsSound() && alIsSource(this->audioSource_))
+        if (alIsSource(this->audioSource_))
         {
             if (int error = alGetError())
-                COUT(2) << "Sound: Error setting pitch: " << error << std::endl;
+                COUT(2) << "Sound: Error setting pitch: " << SoundManager::getALErrorString(error) << std::endl;
             alSourcef(this->audioSource_, AL_PITCH, pitch);
         }
@@ -183 +208 @@
         if (this->soundBuffer_ != NULL)
         {
+            // Stopping is imperative here!
             if (alIsSource(this->audioSource_))
             {
                 alSourceStop(this->audioSource_);
-                // Unload old buffer first
-                alSourcei(this->audioSource_, AL_BUFFER, 0);
+                alSourcei(this->audioSource_, AL_BUFFER, AL_NONE);
             }
             SoundManager::getInstance().releaseSoundBuffer(this->soundBuffer_, this->bPooling_);
@@ -194 +219 @@
 
         this->source_ = source;
-        if (source_.empty() || !alIsSource(this->audioSource_))
+        if (source_.empty())
             return;
 
@@ -201 +226 @@
             return;
 
-        alSourcei(this->audioSource_, AL_BUFFER, this->soundBuffer_->getBuffer());
-        if (ALuint error = alGetError())
-        {
-            COUT(1) << "Sound Error: Could not load file \"" << source << "\": " << SoundManager::getALErrorString(error) << std::endl;
-            return;
-        }
-
-        alSource3f(this->audioSource_, AL_POSITION,  0, 0, 0);
-        this->updateVolume();
-        this->setPitch(this->getPitch());
-        this->setLooping(getLooping());
-        if (this->isPlaying() || this->isPaused())
-        {
-            alSourcePlay(this->audioSource_);
-            if (int error = alGetError())
-                COUT(2) << "Sound: Error playing sound: " << error << std::endl;
-        }
-        if (this->isPaused())
-            alSourcePause(this->audioSource_);
+        if (alIsSource(this->audioSource_))
+        {
+            alSourcei(this->audioSource_, AL_BUFFER, this->soundBuffer_->getBuffer());
+            if (ALuint error = alGetError())
+            {
+                COUT(1) << "Sound Error: Could not set buffer \"" << source << "\": " << SoundManager::getALErrorString(error) << std::endl;
+                return;
+            }
+
+            if (this->isPlaying() || this->isPaused())
+            {
+                alSourcePlay(this->audioSource_);
+                if (int error = alGetError())
+                    COUT(2) << "Sound: Error playing sound: " << SoundManager::getALErrorString(error) << std::endl;
+            }
+            if (this->isPaused())
+                alSourcePause(this->audioSource_);
+        }
     }
     

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

@@ -96 +96 @@
             Paused
         };
+        virtual void initialiseSource();
         ALint getSourceState() const;
 

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

@@ -87 +87 @@
             COUT(1) << "Sound: Just getting the DLL with the dependencies is not enough for Windows (esp. Windows 7)!" << std::endl;
 #endif
-            ThrowException(InitialisationFailed, "Sound: OpenAL error: Could not open sound device.");
+            ThrowException(InitialisationFailed, "Sound Error: Could not open sound device.");
         }
         Loki::ScopeGuard closeDeviceGuard = Loki::MakeGuard(&alcCloseDevice, this->device_);
@@ -100 +100 @@
 
         GameMode::setPlaysSound(true);
+        Loki::ScopeGuard resetPlaysSoundGuard = Loki::MakeGuard(&GameMode::setPlaysSound, false);
 
         // Get some information about the sound
@@ -110 +111 @@
         else
             COUT(2) << "Sound Warning: MIME Type retrieval failed: " << alutGetErrorString(alutGetError()) << std::endl;
+        
+        this->setVolumeInternal(1.0, SoundType::none);
+        this->setVolumeInternal(1.0, SoundType::ambient);
+        this->setVolumeInternal(1.0, SoundType::effects);
+        
+        this->mute_[SoundType::none] = false;
+        this->mute_[SoundType::ambient] = false;
+        this->mute_[SoundType::effects] = false;
+
+        this->setConfigValues();
+
+        // Try to get at least one source
+        ALuint source;
+        alGenSources(1, &source);
+        if (!alGetError() && alIsSource(source))
+            this->soundSources_.push_back(source);
+        else
+            ThrowException(InitialisationFailed, "Sound Error: Could not even create a single source");
+        // Get the rest of the sources
+        alGenSources(1, &source);
+        unsigned int count = 1;
+        while (alIsSource(source) && !alGetError() && count <= this->maxSources_)
+        {
+            this->soundSources_.push_back(source);
+            alGenSources(1, &source);
+            ++count;
+        }
 
         // Disarm guards
@@ -115 +143 @@
         closeDeviceGuard.Dismiss();
         desroyContextGuard.Dismiss();
-        
-        this->setVolumeInternal(1.0, SoundType::none);
-        this->setVolumeInternal(1.0, SoundType::ambient);
-        this->setVolumeInternal(1.0, SoundType::effects);
-        
-        this->mute_[SoundType::none] = false;
-        this->mute_[SoundType::ambient] = false;
-        this->mute_[SoundType::effects] = false;
-
-        this->setConfigValues();
+        resetPlaysSoundGuard.Dismiss();
 
         COUT(4) << "Sound: Initialisation complete" << std::endl;
@@ -164 +183 @@
             .description("Determines how fast sounds should fade, per second.")
             .callback(this, &SoundManager::checkFadeStepValidity);
-            
+
         SetConfigValue(soundVolume_, 1.0f)
             .description("Defines the overall volume.")
             .callback(this, &SoundManager::checkSoundVolumeValidity);
-            
+
         SetConfigValue(ambientVolume_, 1.0f)
             .description("Defines the ambient volume.")
             .callback(this, &SoundManager::checkAmbientVolumeValidity);
-            
+
         SetConfigValue(effectsVolume_, 1.0f)
             .description("Defines the effects volume.")
             .callback(this, &SoundManager::checkEffectsVolumeValidity);
+
+        SetConfigValue(maxSources_, 1024)
+            .description("Maximum number of sources to be made available");
     }
 
@@ -595 +617 @@
         }
     }
+
+    ALuint SoundManager::getSoundSource()
+    {
+        if (!this->soundSources_.empty())
+        {
+            ALuint source = this->soundSources_.back();
+            this->soundSources_.pop_back();
+            return source;
+        }
+        else
+        {
+            // Return no source ID
+            ALuint source = 123456789;
+            while (alIsSource(++source));
+            return source;
+        }
+    }
+
+    void SoundManager::releaseSoundSource(ALuint source)
+    {
+#ifndef NDEBUG
+        for (std::vector<ALuint>::const_iterator it = this->soundSources_.begin(); it != this->soundSources_.end(); ++it)
+            assert((*it) != source);
+#endif
+        this->soundSources_.push_back(source);
+    }
 }

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

@@ -102 +102 @@
         void releaseSoundBuffer(const shared_ptr<SoundBuffer>& buffer, bool bPoolBuffer);
 
+        ALuint getSoundSource();
+        void releaseSoundSource(ALuint source);
+
         static std::string getALErrorString(ALenum error);
 
@@ -144 +147 @@
         typedef std::map<std::string, shared_ptr<SoundBuffer> > SoundBufferMap;
         SoundBufferMap soundBuffers_;
+
+        unsigned int maxSources_;
+        std::vector<ALuint> soundSources_;
         
         static SoundManager* singletonPtr_s;

code/branches/presentation2/src/orxonox/sound/WorldSound.cc

@@ -76 +76 @@
     }
 
+    void WorldSound::initialiseSource()
+    {
+        BaseSound::initialiseSource();
+        this->tick(0); // update position, orientation and velocity
+    }
+
     void WorldSound::tick(float dt)
     {

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

@@ -58 +58 @@
     private:
         void registerVariables();
+        void initialiseSource();
     };
 }