Changeset 8771 in orxonox.OLD for branches/atmospheric_engine/src/lib/sound

Timestamp:

Jun 24, 2006, 3:35:07 PM (18 years ago)

Author:

amaechler

Message:

branches/atmospheric_engine: rainsound fade working and comments

Location:

branches/atmospheric_engine/src/lib/sound

Files:

• sound_source.cc (modified) (4 diffs)
• sound_source.h (modified) (1 diff)

branches/atmospheric_engine/src/lib/sound/sound_source.cc

@@ -164 +164 @@
 
   /**
-  * @brief Plays back buffer on this Source with gain
-  * @param buffer the buffer to play back on this Source
+   * @brief Plays back buffer on this Source with gain
+   * @param buffer the buffer to play back on this Source
+   * @param gain the gain of the sound buffer 
   */
   void SoundSource::play(const SoundBuffer* buffer, float gain)
@@ -189 +190 @@
       SoundEngine::checkError("Play Source", __LINE__);
   }
-  
-   /**
+
+  /**
    * @brief Plays back buffer on this Source with gain and looping possibility
    * @param buffer the buffer to play back on this Source
-    */
+   *  @param gain the gain of the sound buffer
+   * @param loop if true, sound gets looped
+   */
   void SoundSource::play(const SoundBuffer* buffer, float gain, bool loop)
   {
@@ -204 +207 @@
     alSourceStop(this->sourceID);
     alSourcei (this->sourceID, AL_BUFFER, buffer->getID());
-    
+
     if (loop)
-        alSourcei (this->sourceID, AL_LOOPING,  AL_TRUE);
+      alSourcei (this->sourceID, AL_LOOPING,  AL_TRUE);
     else
-        alSourcei (this->sourceID, AL_LOOPING,  AL_FALSE);
-    
+      alSourcei (this->sourceID, AL_LOOPING,  AL_FALSE);
+
     alSourcef (this->sourceID, AL_GAIN, gain);
 
@@ -220 +223 @@
     if (DEBUG_LEVEL >= 3)
       SoundEngine::checkError("Play Source", __LINE__);
-  } 
-
-
-  /**
-  * @brief Stops playback of a SoundSource
-  */
+  }
+
+  /**
+   * @brief Changes the volume of an (active) buffer
+   * @param buffer the buffer to play back on this Source
+   * @param gain the new gain value
+   */
+  void SoundSource::gain(const SoundBuffer* buffer, float gain)
+  {
+    // alSourcei (this->sourceID, AL_BUFFER, buffer->getID());
+    alSourcef (this->sourceID, AL_GAIN, gain);
+  }
+
+  /**
+   * @brief Stops playback of a SoundSource
+   */
   void SoundSource::stop()
   {

branches/atmospheric_engine/src/lib/sound/sound_source.h

@@ -14 +14 @@
 namespace OrxSound
 {
-        class SoundBuffer;
-        //! A class that represents a SoundSource
-        class SoundSource : public BaseObject
-        {
-                public:
-                        SoundSource(const PNode* sourceNode = NULL, const SoundBuffer* buffer = NULL);
-                        SoundSource(const SoundSource& source);
-                        SoundSource& operator=(const SoundSource& source);
-                        bool operator==(const SoundSource& source);
-                        
-                        virtual ~SoundSource();
-                        
-                        // user interaction
-                        void play();
-                        void play(const SoundBuffer* buffer);
-                        void play(const SoundBuffer* buffer, float gain);
-      void play(const SoundBuffer* buffer, float gain, bool loop);   
+  class SoundBuffer;
+  //! A class that represents a SoundSource
+  class SoundSource : public BaseObject
+  {
+  public:
+    SoundSource(const PNode* sourceNode = NULL, const SoundBuffer* buffer = NULL);
+    SoundSource(const SoundSource& source);
+    SoundSource& operator=(const SoundSource& source);
+    bool operator==(const SoundSource& source);
 
-                        void stop();
-                        void pause();
-                        void rewind();
-                        void fadein(const SoundBuffer* buffer, ALfloat duration);
-                        
-                        
-                        // development functions
-                        /** @returns The ID of this Source */
-                        inline ALuint getID() const { return this->sourceID; };
-                        /** @returns true, if the Source is Playing */
-                        inline bool   isPlaying() const { return this->bPlay; };
-                        void setSourceNode(const PNode* sourceNode);
-                        /** @returns the SoundBuffer of this Source */
-                        inline const SoundBuffer* getBuffer() const { return this->buffer; };
-                        /** @returns the SourceNode of this Source */
-                        inline const PNode* getNode() const { return this->sourceNode; };
-                        /** @param resident if the Source is Resident */
-                        inline void setResident(bool resident) { this->resident = resident; };
-                        /** @returns true if the alSource is Resident */
-                        inline bool isResident() const { return this->resident; };
-                        
-                        void setRolloffFactor(ALfloat rolloffFactor);
-                        
-                        static void resetSource(ALuint sourceID);
-                
-                private:
-                        bool retrieveSource();
-                        
-                private:
-                        bool                   bPlay;           //!< If the Source is Playing.
-                        bool                   resident;        //!< If the alSource should be resident (if true, the alSource will be returned on deletion).
-                        ALuint                 sourceID;        //!< The ID of the Source
-                        const SoundBuffer*     buffer;          //!< The buffer to play in this source.
-                        const PNode*           sourceNode;      //!< The SourceNode representing the position/velocity... of this source.
-        };
+    virtual ~SoundSource();
+
+    // user interaction
+    void play();
+    void play(const SoundBuffer* buffer);
+    void play(const SoundBuffer* buffer, float gain);
+    void play(const SoundBuffer* buffer, float gain, bool loop);
+
+    void gain(const SoundBuffer* buffer, float gain);
+
+    void stop();
+    void pause();
+    void rewind();
+    void fadein(const SoundBuffer* buffer, ALfloat duration);
+
+    // development functions
+    /** @returns The ID of this Source */
+    inline ALuint getID() const { return this->sourceID; };
+    /** @returns true, if the Source is Playing */
+    inline bool isPlaying() const { return this->bPlay; };
+    void setSourceNode(const PNode* sourceNode);
+    /** @returns the SoundBuffer of this Source */
+    inline const SoundBuffer* getBuffer() const { return this->buffer; };
+    /** @returns the SourceNode of this Source */
+    inline const PNode* getNode() const { return this->sourceNode; };
+    /** @param resident if the Source is Resident */
+    inline void setResident(bool resident) { this->resident = resident; };
+    /** @returns true if the alSource is Resident */
+    inline bool isResident() const { return this->resident; };
+
+    void setRolloffFactor(ALfloat rolloffFactor);
+
+    static void resetSource(ALuint sourceID);
+
+  private:
+    bool                   retrieveSource();
+
+  private:
+    bool                   bPlay;       //!< If the Source is Playing.
+    bool                   resident;    //!< If the alSource should be resident (if true, the alSource will be returned on deletion).
+    ALuint                 sourceID;    //!< The ID of the Source
+    const SoundBuffer*     buffer;      //!< The buffer to play in this source.
+    const PNode*           sourceNode;  //!< The SourceNode representing the position/velocity... of this source.
+  };
 }
 #endif /* _SOUND_SOURCE_H */