Changeset 6382 for code/branches/presentation2

Timestamp:

Dec 19, 2009, 12:18:41 AM (15 years ago)

Author:

rgrieder

Message:

Several small changes in sound:

• Fixed a bug that caused a sound source to be initialised on pause() even it already existed
• The XML parameter is now called "looping" instead of "loop" because looping was used really all over the code
• The "play" XML parameter doesn't exist anymore, use "playOnLoad" for AmbientSound only.
• Added "pitch" XML parameter
• Changes in synchronisation policy: Ambient sound should not synchronise the state but instead th new playOnLoad parameter

Location:

code/branches/presentation2

Files:

• data/levels/presentationHS09b.oxw (modified) (2 diffs)
• data/levels/sound.oxw (modified) (2 diffs)
• data/levels/templates/spaceship_HXY.oxt (modified) (1 diff)
• data/levels/templates/spaceship_Transporter.oxt (modified) (1 diff)
• src/orxonox/sound/AmbientSound.cc (modified) (9 diffs)
• src/orxonox/sound/AmbientSound.h (modified) (2 diffs)
• src/orxonox/sound/BaseSound.cc (modified) (5 diffs)
• src/orxonox/sound/BaseSound.h (modified) (2 diffs)
• src/orxonox/sound/WorldSound.cc (modified) (2 diffs)
• src/orxonox/sound/WorldSound.h (modified) (2 diffs)

code/branches/presentation2/data/levels/presentationHS09b.oxw

@@ -25 +25 @@
 
 
-<AmbientSound ambientSource="Mars.ogg" loop="true" play="true" />
+<AmbientSound ambientSource="Mars.ogg" looping="true" playOnLoad="true" />
 
    <Light type=directional position="0,0,0" direction="0.253, 0.593, -0.765" diffuse="1.0, 0.9, 0.9, 1.0" specular="1.0, 0.9, 0.9, 1.0" />
@@ -258 +258 @@
 
 
-<AmbientSound ambientSource="Earth.ogg" loop="true" play="false">
+<AmbientSound ambientSource="Earth.ogg" looping="true" playOnLoad="false">
        <events>
           <activity>

code/branches/presentation2/data/levels/sound.oxw

@@ -18 +18 @@
   >
 
-  <AmbientSound ambientSource="Earth.ogg" loop="true" play="true" />
-  <AmbientSound ambientSource="Mars.ogg" loop="true" play="false">
+  <AmbientSound ambientSource="Earth.ogg" looping="true" playOnLoad="true" />
+  <AmbientSound ambientSource="Mars.ogg" looping="true">
         <events>
                 <activity>
@@ -30 +30 @@
         </events>
   </AmbientSound>
-  <AmbientSound ambientSource="Jupiter.ogg" loop="true" play="false">
+  <AmbientSound ambientSource="Jupiter.ogg" looping="true">
         <events>
                 <activity>

code/branches/presentation2/data/levels/templates/spaceship_HXY.oxt

@@ -69 +69 @@
   >
     <EffectContainer condition="idle">
-      <WorldSound mainstate="activity" source="sounds/Engine_idle.ogg" loop=1 active=false/>
+      <WorldSound mainstate="activity" source="sounds/Engine_idle.ogg" looping=1 active=false/>
     </EffectContainer>
     <EffectContainer condition="not idle">

code/branches/presentation2/data/levels/templates/spaceship_Transporter.oxt

@@ -69 +69 @@
   >
     <EffectContainer condition="idle">
-      <WorldSound mainstate="activity" source="sounds/Engine_idle.ogg" loop=1 active=false/>
+      <WorldSound mainstate="activity" source="sounds/Engine_idle.ogg" looping=1 active=false/>
     </EffectContainer>
     <EffectContainer condition="not idle">

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

@@ -42 +42 @@
 
     AmbientSound::AmbientSound(BaseObject* creator)
-        : BaseObject(creator), Synchronisable(creator)
+        : BaseObject(creator)
+        , Synchronisable(creator)
+        , bPlayOnLoad_(false)
     {
         RegisterObject(AmbientSound);
@@ -49 +51 @@
         this->setVolume(0);
         this->registerVariables();
-    }
-
-    AmbientSound::~AmbientSound()
-    {
     }
 
@@ -67 +65 @@
     {
         registerVariable(ambientSource_, ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::ambientSourceChanged));
-        registerVariable(bLooping_, ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::loopingChanged));
-        registerVariable(pitch_, ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::pitchChanged));
-        registerVariable((int&)(BaseSound::state_), ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::stateChanged));
+        registerVariable(bLooping_,      ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::loopingChanged));
+        registerVariable(pitch_,         ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::pitchChanged));
+        registerVariable(bPlayOnLoad_,   ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::playOnLoadChanged));
     }
 
@@ -76 +74 @@
         SUPER(AmbientSound, XMLPort, xmlelement, mode);
         BaseSound::XMLPortExtern(xmlelement, mode);
-        XMLPortParam(AmbientSound, "ambientsource", setAmbientSource, getAmbientSource, xmlelement, mode);
+        XMLPortParam(AmbientSound, "ambientSource", setAmbientSource, getAmbientSource, xmlelement, mode);
+        XMLPortParam(AmbientSound, "playOnLoad", setPlayOnLoad, getPlayOnLoad, xmlelement, mode);
     }
 
@@ -88 +87 @@
     {
         if (GameMode::playsSound())
-        {
             SoundManager::getInstance().registerAmbientSound(this);
-        }
-        else
-            BaseSound::play();
-    }
-
-    void AmbientSound::doPlay()
-    {
-        BaseSound::play();
     }
 
@@ -103 +93 @@
     {
         if (GameMode::playsSound())
-        {
             SoundManager::getInstance().unregisterAmbientSound(this);
-        }
-        else
-            BaseSound::stop();
-    }
-
-    void AmbientSound::doStop()
-    {
-        BaseSound::stop();
     }
 
@@ -118 +99 @@
     {
         if (GameMode::playsSound())
-        {
             SoundManager::getInstance().pauseAmbientSound(this);
-        }
-        else
-            BaseSound::pause();
     }
     
@@ -129 +106 @@
         assert(GameMode::playsSound());
         return SoundManager::getInstance().getRealVolume(SoundType::Music);
-    }
-
-    void AmbientSound::doPause()
-    {
-        BaseSound::pause();
     }
 
@@ -150 +122 @@
     }
 
+    void AmbientSound::setPlayOnLoad(bool val)
+    {
+        this->bPlayOnLoad_ = val;
+        if (val)
+            this->play();
+    }
+
     void AmbientSound::changedActivity()
     {

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

@@ -50 +50 @@
     public:
         AmbientSound(BaseObject* creator);
-        ~AmbientSound();
 
         void XMLPort(Element& xmlelement, XMLPort::Mode mode);
@@ -61 +60 @@
 
         void setAmbientSource(const std::string& source);
-        const std::string& getAmbientSource() const { return this->ambientSource_; }
-        inline void ambientSourceChanged(){ this->setAmbientSource(this->ambientSource_); }
+        inline const std::string& getAmbientSource() const
+            { return this->ambientSource_; }
+
+        void setPlayOnLoad(bool val);
+        bool getPlayOnLoad() const
+            { return this->bPlayOnLoad_; }
+
+    protected:
+        ~AmbientSound() { }
 
     private:
-        virtual void preDestroy();
-        void doPlay();
-        void doStop();
-        void doPause();
+        void preDestroy();
         void registerVariables();
         float getRealVolume();
+        inline void ambientSourceChanged()
+            { this->setAmbientSource(this->ambientSource_); }
+        inline void playOnLoadChanged()
+            { this->setPlayOnLoad(this->bPlayOnLoad_); }
 
         std::string ambientSource_; //!< Analogous to source_, but mood independent
+        bool        bPlayOnLoad_;   //!< Play the sound immediately when loaded
     };
 }

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

@@ -64 +64 @@
     void BaseSound::XMLPortExtern(Element& xmlelement, XMLPort::Mode mode)
     {
-        XMLPortParam(BaseSound, "volume", setVolume,  getVolume,  xmlelement, mode);
-        XMLPortParam(BaseSound, "loop",   setLooping, getLooping, xmlelement, mode);
-        XMLPortParam(BaseSound, "play",   setPlaying, isPlaying,  xmlelement, mode);
-        XMLPortParam(BaseSound, "source", setSource,  getSource,  xmlelement, mode);
-    }
-
-    void BaseSound::play()
+        XMLPortParam(BaseSound, "volume",  setVolume,  getVolume,  xmlelement, mode);
+        XMLPortParam(BaseSound, "looping", setLooping, getLooping, xmlelement, mode);
+        XMLPortParam(BaseSound, "pitch",   setPitch,   getPitch,   xmlelement, mode);
+        XMLPortParam(BaseSound, "source",  setSource,  getSource,  xmlelement, mode);
+    }
+
+    void BaseSound::doPlay()
     {
         this->state_ = Playing;
@@ -76 +76 @@
         {
             if (!alIsSource(this->audioSource_))
+            {
                 this->audioSource_ = SoundManager::getInstance().getSoundSource();
-            if (!alIsSource(this->audioSource_))
-                return;
-            this->initialiseSource();
+                if (!alIsSource(this->audioSource_))
+                    return;
+                this->initialiseSource();
+            }
 
             alSourcePlay(this->audioSource_);
@@ -87 +89 @@
     }
 
-    void BaseSound::stop()
+    void BaseSound::doStop()
     {
         this->state_ = Stopped;
@@ -103 +105 @@
     }
 
-    void BaseSound::pause()
+    void BaseSound::doPause()
     {
         if (this->isStopped())
@@ -242 +244 @@
             State state = this->state_; // save
             if (this->isPlaying() || this->isPaused())
-                BaseSound::play();
+                doPlay();
             if (state == Paused)
             {
                 this->state_ = Paused;
-                BaseSound::pause();
+                doPause();
             }
         }

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

@@ -51 +51 @@
     public:
         BaseSound();
-        virtual ~BaseSound();
 
         void XMLPortExtern(Element& xmlelement, XMLPort::Mode mode);
 
-        virtual void play();
-        virtual void stop();
-        virtual void pause();
+        virtual void play()  { this->doPlay(); }
+        virtual void stop()  { this->doStop(); }
+        virtual void pause() { this->doPause(); }
 
         bool isPlaying() const { return this->state_ == Playing; }
         bool isPaused()  const { return this->state_ == Paused; }
         bool isStopped() const { return this->state_ == Stopped; }
-
-        void setPlaying(bool val)
-            { val ? this->play() : this->stop(); }
 
         virtual void setSource(const std::string& source);
@@ -90 +86 @@
             Paused
         };
+
+        virtual ~BaseSound();
+
+        void doPlay();
+        void doStop();
+        void doPause();
 
         // network callbacks

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

@@ -51 +51 @@
         this->registerVariables();
     }
-
-    WorldSound::~WorldSound()
-    {
-    }
     
     void WorldSound::registerVariables()
     {
-        registerVariable(volume_, ObjectDirection::ToClient, new NetworkCallback<WorldSound>(this, &WorldSound::volumeChanged));
-        registerVariable(source_, ObjectDirection::ToClient, new NetworkCallback<WorldSound>(this, &WorldSound::sourceChanged));
+        registerVariable(volume_,   ObjectDirection::ToClient, new NetworkCallback<WorldSound>(this, &WorldSound::volumeChanged));
+        registerVariable(source_,   ObjectDirection::ToClient, new NetworkCallback<WorldSound>(this, &WorldSound::sourceChanged));
         registerVariable(bLooping_, ObjectDirection::ToClient, new NetworkCallback<WorldSound>(this, &WorldSound::loopingChanged));
+        registerVariable(pitch_,    ObjectDirection::ToClient, new NetworkCallback<WorldSound>(this, &WorldSound::pitchChanged));
         registerVariable((int&)(BaseSound::state_), ObjectDirection::ToClient, new NetworkCallback<WorldSound>(this, &WorldSound::stateChanged));
-        registerVariable(pitch_, ObjectDirection::ToClient, new NetworkCallback<WorldSound>(this, &WorldSound::pitchChanged));
     }
 
@@ -125 +121 @@
     float WorldSound::getRealVolume()
     {
+        assert(GameMode::playsSound());
         return SoundManager::getInstance().getRealVolume(SoundType::Effects);
     }

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

@@ -46 +46 @@
     public:
         WorldSound(BaseObject* creator);
-        ~WorldSound();
 
         void XMLPort(Element& xmlelement, XMLPort::Mode mode);
@@ -53 +52 @@
 
         void tick(float dt);
+
+    protected:
+        ~WorldSound() {}
 
     private: