Changeset 5896 for code/branches/core5/src/orxonox/sound/BaseSound.cc

Timestamp:

Oct 6, 2009, 11:12:01 PM (15 years ago)

Author:

rgrieder

Message:

Added some basic sound classes: WorldSound (to be used for 3D sound, is a WorldEntity) and AmbientSound (BaseObject, just add it somewhere and it will play with playOnLoad=true).
Also moved the sound listener device updating to the HumanController. We might want to modify this again so that the listener is at the camera position again, not at the space ship.

File:

• code/branches/core5/src/orxonox/sound/BaseSound.cc (moved) (moved from code/branches/core5/src/orxonox/sound/SoundBase.cc) (9 diffs)

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

@@ -21 +21 @@
  *
  *   Author:
- *       Erwin 'vaiursch' Herrsche
+ *      Erwin 'vaiursch' Herrsche
  *   Co-authors:
- *      ...
+ *      Reto Grieder
  *
  */
 
-#include "SoundBase.h"
-
-#include <string>
+#include "BaseSound.h"
+
 #include <vector>
 #include <AL/alut.h>
 #include <vorbis/vorbisfile.h>
 
-#include "util/Math.h"
+#include "core/CoreIncludes.h"
+#include "core/GameMode.h"
 #include "core/Resource.h"
-#include "worldentities/WorldEntity.h"
-#include "SoundManager.h"
 
 namespace orxonox
 {
-    SoundBase::SoundBase(WorldEntity* entity)
-    {
-        this->source_ = 0;
-        this->buffer_ = 0;
-        this->entity_ = entity;
-
-        SoundManager::getInstance().addSound(this);
-    }
-
-    SoundBase::~SoundBase()
-    {
-        alSourcei(this->source_, AL_BUFFER, 0);
-        alDeleteSources(1, &this->source_);
-        alDeleteBuffers(1, &this->buffer_);
-    }
-
-    void SoundBase::attachToEntity(WorldEntity* entity)
-    {
-        this->entity_ = entity;
-        this->update();
-    }
-
-    void SoundBase::update() {
-        if(this->entity_ != NULL && alIsSource(this->source_)) {
-            const Vector3& pos = this->entity_->getPosition();
-            alSource3f(this->source_, AL_POSITION, pos.x, pos.y, pos.z);
-            ALenum error = alGetError();
-            if(error == AL_INVALID_VALUE)
-                COUT(2) << "Sound: OpenAL: Invalid sound position" << std::endl;
-
-            const Vector3& vel = this->entity_->getVelocity();
-            alSource3f(this->source_, AL_VELOCITY, vel.x, vel.y, vel.z);
-            error = alGetError();
-            if(error == AL_INVALID_VALUE)
-                COUT(2) << "Sound: OpenAL: Invalid sound velocity" << std::endl;
-
-            const Quaternion& orient = this->entity_->getOrientation();
-            Vector3 at = orient.zAxis();
-            alSource3f(this->source_, AL_DIRECTION, at.x, at.y, at.z);
-            error = alGetError();
-            if(error == AL_INVALID_VALUE)
-                COUT(2) << "Sound: OpenAL: Invalid sound direction" << std::endl;
-        }
-    }
-
-    void SoundBase::play(bool loop) {
-        if(alIsSource(this->source_)) {
-            if(loop)
+    BaseSound::BaseSound()
+        : source_(0)
+        , buffer_(0)
+        , bPlayOnLoad_(false)
+        , bLoop_(false)
+    {
+        RegisterRootObject(BaseSound);
+    }
+
+    BaseSound::~BaseSound()
+    {
+        this->setSoundFile("");
+    }
+
+    void BaseSound::play()
+    {
+        if (alIsSource(this->source_))
+        {
+            if (this->bLoop_)
                 alSourcei(this->source_, AL_LOOPING, AL_TRUE);
             else
@@ -94 +63 @@
             alSourcePlay(this->source_);
 
-            if(alGetError() != AL_NO_ERROR)
+            if (alGetError() != AL_NO_ERROR)
             {
                  COUT(2) << "Sound: OpenAL: Error playin sound " << this->source_ << std::endl;
@@ -101 +70 @@
     }
 
-    void SoundBase::stop() {
-        if(alIsSource(this->source_)) {
+    void BaseSound::stop()
+    {
+        if (alIsSource(this->source_))
             alSourceStop(this->source_);
-        }
-    }
-
-    void SoundBase::pause() {
-        if(alIsSource(this->source_)) {
+    }
+
+    void BaseSound::pause()
+    {
+        if (alIsSource(this->source_))
             alSourcePause(this->source_);
-        }
-    }
-
-    bool SoundBase::isPlaying() {
-        if(alIsSource(this->source_)) {
+    }
+
+    bool BaseSound::isPlaying()
+    {
+        if (alIsSource(this->source_))
             return getSourceState() == AL_PLAYING;
-        }
         return false;
     }
 
-    bool SoundBase::isPaused() {
-        if(alIsSource(this->source_)) {
+    bool BaseSound::isPaused()
+    {
+        if (alIsSource(this->source_))
             return getSourceState() == AL_PAUSED;
-        }
         return true;
     }
 
-    bool SoundBase::isStopped() {
-        if(alIsSource(this->source_)) {
+    bool BaseSound::isStopped()
+    {
+        if (alIsSource(this->source_))
             return getSourceState() == AL_INITIAL || getSourceState() == AL_STOPPED;
-        }
         return true;
     }
 
-    bool SoundBase::loadFile(const std::string& filename) {
-        if(!SoundManager::getInstance().isSoundAvailable())
-        {
-            COUT(3) << "Sound: not available, skipping " << filename << std::endl;
-            return false;
-        }
-
-        COUT(3) << "Sound: OpenAL ALUT: loading file " << filename << std::endl;
+    void BaseSound::setPlayOnLoad(bool val)
+    {
+        this->bPlayOnLoad_ = true;
+        this->play();
+    }
+
+    void BaseSound::setSoundFile(const std::string& soundFile)
+    {
+        this->soundFile_ = soundFile;
+        if (!GameMode::playsSound())
+            return;
+
+        if (soundFile.empty() && alIsSource(this->source_))
+        {
+            // Unload sound
+            alSourcei(this->source_, AL_BUFFER, 0);
+            alDeleteSources(1, &this->source_);
+            alDeleteBuffers(1, &this->buffer_);
+            return;
+        }
+
+        COUT(3) << "Sound: OpenAL ALUT: loading file " << soundFile << std::endl;
         // Get DataStream from the resources
-        shared_ptr<ResourceInfo> fileInfo = Resource::getInfo(filename);
-        if (fileInfo == NULL) {
-            COUT(2) << "Warning: Sound file '" << filename << "' not found" << std::endl;
-            return false;
-        }
-        DataStreamPtr stream = Resource::open(filename);
+        shared_ptr<ResourceInfo> fileInfo = Resource::getInfo(soundFile);
+        if (fileInfo == NULL)
+        {
+            COUT(2) << "Warning: Sound file '" << soundFile << "' not found" << std::endl;
+            return;
+        }
+        DataStreamPtr stream = Resource::open(soundFile);
         // Read everything into a temporary buffer
         char* buffer = new char[fileInfo->size];
@@ -156 +140 @@
         delete[] buffer;
 
-        if(this->buffer_ == AL_NONE) {
+        if (this->buffer_ == AL_NONE)
+        {
             COUT(2) << "Sound: OpenAL ALUT: " << alutGetErrorString(alutGetError()) << std::endl;
-            if(filename.find("ogg", 0) != std::string::npos)
-            {
-                COUT(2) << "Sound: Trying fallback ogg loader" << std::endl;
-                this->buffer_ = loadOggFile(filename);
-            }
-
-            if(this->buffer_ == AL_NONE)
-            {
-                COUT(2) << "Sound: fallback ogg loader failed: " << alutGetErrorString(alutGetError()) << std::endl;
-                return false;
-            }
+            return;
+            //if (filename.find("ogg", 0) != std::string::npos)
+            //{
+            //    COUT(2) << "Sound: Trying fallback ogg loader" << std::endl;
+            //    this->buffer_ = loadOggFile(filename);
+            //}
+
+            //if (this->buffer_ == AL_NONE)
+            //{
+            //    COUT(2) << "Sound: fallback ogg loader failed: " << alutGetErrorString(alutGetError()) << std::endl;
+            //    return;
+            //}
         }
 
         alGenSources(1, &this->source_);
         alSourcei(this->source_, AL_BUFFER, this->buffer_);
-        if(alGetError() != AL_NO_ERROR) {
-            COUT(2) << "Sound: OpenAL: Error loading sample file: " << filename << std::endl;
-            return false;
-        }
-        return true;
-    }
-
-    ALint SoundBase::getSourceState() {
+        if (alGetError() != AL_NO_ERROR)
+        {
+            COUT(2) << "Sound: OpenAL: Error loading sample file: " << soundFile << std::endl;
+            return;
+        }
+
+        alSource3f(this->source_, AL_POSITION,  0, 0, 0);
+
+        if (this->bPlayOnLoad_)
+            this->play();
+    }
+
+    ALint BaseSound::getSourceState()
+    {
         ALint state;
         alGetSourcei(this->source_, AL_SOURCE_STATE, &state);
@@ -186 +178 @@
     }
 
-    ALuint SoundBase::loadOggFile(const std::string& filename)
+#if 0 // Not yet supported because of missing resource implementation
+    ALuint BaseSound::loadOggFile(const std::string& filename)
     {
         char inbuffer[4096];
@@ -199 +192 @@
         FILE* f = fopen(filename.c_str(), "rb");
 
-        if(ov_open(f, &vf, NULL, 0) < 0)
+        if (ov_open(f, &vf, NULL, 0) < 0)
         {
             COUT(2) << "Sound: libvorbisfile: File does not seem to be an Ogg Vorbis bitstream" << std::endl;
@@ -206 +199 @@
         }
 
-        while(!eof)
+        while (!eof)
         {
             long ret = ov_read(&vf, inbuffer, sizeof(inbuffer), 0, 2, 1, &current_section);
@@ -226 +219 @@
 
         vorbisInfo = ov_info(&vf, -1);
-        if(vorbisInfo->channels == 1)
+        if (vorbisInfo->channels == 1)
             format = AL_FORMAT_MONO16;
         else
@@ -237 +230 @@
         return buffer;
     }
+#endif
+
 } // namespace: orxonox