Changeset 5899

Timestamp:

Oct 7, 2009, 11:19:19 AM (15 years ago)

Author:

rgrieder

Message:

Renaming BaseSound::setSoundFile (and all its associates) to setSource to be compliant with classes like ParicleInterface.

Location:

code/branches/core5

Files:

• data/levels/presentation_pong.oxw (modified) (2 diffs)
• src/orxonox/gamestates/GSMainMenu.cc (modified) (1 diff)
• src/orxonox/sound/AmbientSound.cc (modified) (1 diff)
• src/orxonox/sound/BaseSound.cc (modified) (9 diffs)
• src/orxonox/sound/BaseSound.h (modified) (2 diffs)
• src/orxonox/sound/WorldSound.cc (modified) (4 diffs)

code/branches/core5/data/levels/presentation_pong.oxw

@@ -46 +46 @@
  gametype     = Pong
 >
-  <AmbientSound soundFile="ambient/mainmenu.wav" playOnLoad=true />
+  <AmbientSound source="ambient/mainmenu.wav" playOnLoad=true />
 
   <Scene
@@ -85 +85 @@
           <ParticleSpawner name=scoreeffect_left position="-120,0,-45" source="Orxonox/sparks2" lifetime=0.1 autostart=0 />
 
-          <WorldSound name="scoreSound" position="0,0,0" soundFile="sounds/pong_score.wav" >
+          <WorldSound name="scoreSound" position="0,0,0" source="sounds/pong_score.wav" >
             <events>
               <play>

code/branches/core5/src/orxonox/gamestates/GSMainMenu.cc

@@ -63 +63 @@
             // Load sound
             this->ambient_ = new AmbientSound(0);
-            this->ambient_->setSoundFile("ambient/mainmenu.wav");
+            this->ambient_->setSource("ambient/mainmenu.wav");
         }
     }

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

@@ -49 +49 @@
     {
         SUPER(AmbientSound, XMLPort, xmlelement, mode);
-        XMLPortParamExtern(AmbientSound, BaseSound, this, "soundFile", setSoundFile, getSoundFile, xmlelement, mode);
+        XMLPortParamExtern(AmbientSound, BaseSound, this, "source", setSource, getSource, xmlelement, mode);
         XMLPortParamExtern(AmbientSound, BaseSound, this, "loop", setLoop, getLoop, xmlelement, mode);
         XMLPortParamExtern(AmbientSound, BaseSound, this, "playOnLoad", setPlayOnLoad, getPlayOnLoad, xmlelement, mode);

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

@@ -40 +40 @@
 {
     BaseSound::BaseSound()
-        : source_(0)
-        , buffer_(0)
+        : audioSource_(0)
+        , audioBuffer_(0)
         , bPlayOnLoad_(false)
         , bLoop_(false)
@@ -50 +50 @@
     BaseSound::~BaseSound()
     {
-        this->setSoundFile("");
+        this->setSource("");
     }
 
     void BaseSound::play()
     {
-        if (alIsSource(this->source_))
+        if (alIsSource(this->audioSource_))
         {
             if (this->bLoop_)
-                alSourcei(this->source_, AL_LOOPING, AL_TRUE);
+                alSourcei(this->audioSource_, AL_LOOPING, AL_TRUE);
             else
-                alSourcei(this->source_, AL_LOOPING, AL_FALSE);
-            alSourcePlay(this->source_);
+                alSourcei(this->audioSource_, AL_LOOPING, AL_FALSE);
+            alSourcePlay(this->audioSource_);
 
             if (alGetError() != AL_NO_ERROR)
             {
-                 COUT(2) << "Sound: OpenAL: Error playin sound " << this->source_ << std::endl;
+                 COUT(2) << "Sound: OpenAL: Error playin sound " << this->audioSource_ << std::endl;
             }
         }
@@ -72 +72 @@
     void BaseSound::stop()
     {
-        if (alIsSource(this->source_))
-            alSourceStop(this->source_);
+        if (alIsSource(this->audioSource_))
+            alSourceStop(this->audioSource_);
     }
 
     void BaseSound::pause()
     {
-        if (alIsSource(this->source_))
-            alSourcePause(this->source_);
+        if (alIsSource(this->audioSource_))
+            alSourcePause(this->audioSource_);
     }
 
     bool BaseSound::isPlaying()
     {
-        if (alIsSource(this->source_))
+        if (alIsSource(this->audioSource_))
             return getSourceState() == AL_PLAYING;
         return false;
@@ -91 +91 @@
     bool BaseSound::isPaused()
     {
-        if (alIsSource(this->source_))
+        if (alIsSource(this->audioSource_))
             return getSourceState() == AL_PAUSED;
         return true;
@@ -98 +98 @@
     bool BaseSound::isStopped()
     {
-        if (alIsSource(this->source_))
+        if (alIsSource(this->audioSource_))
             return getSourceState() == AL_INITIAL || getSourceState() == AL_STOPPED;
         return true;
@@ -109 +109 @@
     }
 
-    void BaseSound::setSoundFile(const std::string& soundFile)
-    {
-        this->soundFile_ = soundFile;
+    void BaseSound::setSource(const std::string& source)
+    {
+        this->source_ = source;
         if (!GameMode::playsSound())
             return;
 
-        if (soundFile.empty() && alIsSource(this->source_))
+        if (source.empty() && alIsSource(this->audioSource_))
         {
             // 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;
+            alSourcei(this->audioSource_, AL_BUFFER, 0);
+            alDeleteSources(1, &this->audioSource_);
+            alDeleteBuffers(1, &this->audioBuffer_);
+            return;
+        }
+
+        COUT(3) << "Sound: OpenAL ALUT: loading file " << source << std::endl;
         // Get DataStream from the resources
-        shared_ptr<ResourceInfo> fileInfo = Resource::getInfo(soundFile);
+        shared_ptr<ResourceInfo> fileInfo = Resource::getInfo(source);
         if (fileInfo == NULL)
         {
-            COUT(2) << "Warning: Sound file '" << soundFile << "' not found" << std::endl;
-            return;
-        }
-        DataStreamPtr stream = Resource::open(soundFile);
+            COUT(2) << "Warning: Sound file '" << source << "' not found" << std::endl;
+            return;
+        }
+        DataStreamPtr stream = Resource::open(source);
         // Read everything into a temporary buffer
         char* buffer = new char[fileInfo->size];
         stream->read(buffer, fileInfo->size);
 
-        this->buffer_ = alutCreateBufferFromFileImage(buffer, fileInfo->size);
+        this->audioBuffer_ = alutCreateBufferFromFileImage(buffer, fileInfo->size);
         delete[] buffer;
 
-        if (this->buffer_ == AL_NONE)
+        if (this->audioBuffer_ == AL_NONE)
         {
             COUT(2) << "Sound: OpenAL ALUT: " << alutGetErrorString(alutGetError()) << std::endl;
@@ -147 +147 @@
             //{
             //    COUT(2) << "Sound: Trying fallback ogg loader" << std::endl;
-            //    this->buffer_ = loadOggFile(filename);
+            //    this->audioBuffer_ = loadOggFile(filename);
             //}
 
-            //if (this->buffer_ == AL_NONE)
+            //if (this->audioBuffer_ == AL_NONE)
             //{
             //    COUT(2) << "Sound: fallback ogg loader failed: " << alutGetErrorString(alutGetError()) << std::endl;
@@ -157 +157 @@
         }
 
-        alGenSources(1, &this->source_);
-        alSourcei(this->source_, AL_BUFFER, this->buffer_);
+        alGenSources(1, &this->audioSource_);
+        alSourcei(this->audioSource_, AL_BUFFER, this->audioBuffer_);
         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);
+            COUT(2) << "Sound: OpenAL: Error loading sample file: " << source << std::endl;
+            return;
+        }
+
+        alSource3f(this->audioSource_, AL_POSITION,  0, 0, 0);
 
         if (this->bPlayOnLoad_)
@@ -174 +174 @@
     {
         ALint state;
-        alGetSourcei(this->source_, AL_SOURCE_STATE, &state);
+        alGetSourcei(this->audioSource_, AL_SOURCE_STATE, &state);
         return state;
     }

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

@@ -55 +55 @@
         bool isStopped();
 
-        void setSoundFile(const std::string& soundFile);
-        const std::string& getSoundFile() { return this->soundFile_; }
+        void setSource(const std::string& source);
+        const std::string& getSource() { return this->source_; }
 
         bool getPlayOnLoad() { return this->bPlayOnLoad_; }
@@ -65 +65 @@
 
     protected:
-        //ALuint loadOggFile(const std::string& filename);
+        ALuint loadOggFile(const std::string& filename);
         ALint getSourceState();
 
-        ALuint source_;
-        ALuint buffer_;
+        ALuint audioSource_;
+        ALuint audioBuffer_;
 
     private:
-        std::string soundFile_;
+        std::string source_;
         bool bPlayOnLoad_;
         bool bLoop_;

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

@@ -52 +52 @@
     {
         SUPER(WorldSound, XMLPort, xmlelement, mode);
-        XMLPortParamExtern(WorldSound, BaseSound, this, "soundFile", setSoundFile, getSoundFile, xmlelement, mode);
+        XMLPortParamExtern(WorldSound, BaseSound, this, "source", setSource, getSource, xmlelement, mode);
         XMLPortParamExtern(WorldSound, BaseSound, this, "loop", setLoop, getLoop, xmlelement, mode);
         XMLPortParamExtern(WorldSound, BaseSound, this, "playOnLoad", setPlayOnLoad, getPlayOnLoad, xmlelement, mode);
@@ -65 +65 @@
     void WorldSound::tick(float dt)
     {
-        if (alIsSource(this->source_))
+        if (alIsSource(this->audioSource_))
         {
             const Vector3& pos = this->getWorldPosition();
-            alSource3f(this->source_, AL_POSITION, pos.x, pos.y, pos.z);
+            alSource3f(this->audioSource_, AL_POSITION, pos.x, pos.y, pos.z);
             ALenum error = alGetError();
             if (error == AL_INVALID_VALUE)
@@ -74 +74 @@
 
             const Vector3& vel = this->getVelocity();
-            alSource3f(this->source_, AL_VELOCITY, vel.x, vel.y, vel.z);
+            alSource3f(this->audioSource_, AL_VELOCITY, vel.x, vel.y, vel.z);
             error = alGetError();
             if (error == AL_INVALID_VALUE)
@@ -81 +81 @@
             const Quaternion& orient = this->getWorldOrientation();
             Vector3 at = orient.zAxis();
-            alSource3f(this->source_, AL_DIRECTION, at.x, at.y, at.z);
+            alSource3f(this->audioSource_, AL_DIRECTION, at.x, at.y, at.z);
             error = alGetError();
             if (error == AL_INVALID_VALUE)