Changeset 7306 in orxonox.OLD for trunk/src/lib/sound

Timestamp:

Apr 16, 2006, 10:12:11 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: Play Stop Rewind and Pause work perfectly: you can test this in this revision

Location:

trunk/src/lib/sound

Files:

• ogg_player.cc (modified) (15 diffs)
• ogg_player.h (modified) (4 diffs)

trunk/src/lib/sound/ogg_player.cc

@@ -49 +49 @@
 }
 
+/**
+ * @brief deletes the OggPlayer
+ */
 OggPlayer::~OggPlayer()
 {
@@ -127 +130 @@
   SoundEngine::checkError("OggPlayer::open()::SetSourceProperties", __LINE__);
 
+  // Set to State Stopped
+  this->state |= OggPlayer::Stopped;
   return true;
 }
@@ -139 +144 @@
   if (!(this->state & FileOpened))
     return false;
+
+  this->state &= ~(OggPlayer::Stopped | OggPlayer::Paused);
   if (this->musicThread == NULL)
     return ((this->musicThread = SDL_CreateThread(OggPlayer::createAudioThread, (void*)this)) != NULL);
@@ -146 +153 @@
 
 void OggPlayer::stop()
-{}
+{
+  this->state &= ~(OggPlayer::Playing | OggPlayer::Paused);
+  this->state |= OggPlayer::Stopped;
+
+  this->suspend();
+  this->rewind();
+}
 
 void OggPlayer::pause()
-{}
-
+{
+  this->state &= ~OggPlayer::Playing;
+
+  if (!(this->state & OggPlayer::Stopped))
+    this->state |= OggPlayer::Paused;
+
+  this->suspend();
+}
+
+/**
+ * @brief rewind to the beginning, and play (if already playing)
+ */
 void OggPlayer::rewind()
-{}
+{
+  this->jumpTo(0.0f);
+}
 
 /**
@@ -160 +185 @@
 void OggPlayer::jumpTo(float timeCode)
 {
-  if (this->state & FileOpened)
+  if (this->state & OggPlayer::FileOpened)
     ov_time_seek(&this->oggStream, timeCode);
 }
+
+/**
+ * @returns the Length of the Music in Seconds
+ */
+float OggPlayer::length()
+{
+  if (this->state & OggPlayer::FileOpened)
+    return ov_time_total(&this->oggStream, -1);
+  else
+    return 0.0f;
+}
+
 
 /**
@@ -183 +220 @@
 // INTERNAL FUNCTIONS //
 ////////////////////////
+/**
+ * @brief creates a Thread for Playing back the music even if the rest of the Engine is slow
+ * @param oggPlayer the OggPlayer to play back
+ * @returns -1 on error.
+ */
 int OggPlayer::createAudioThread(void* oggPlayer)
 {
@@ -190 +232 @@
   PRINTF(4)("STARTIG AUDIO THREAD\n");
 
-  ogg->playback();
-
-  while (ogg->state & Playing)
+  if (!ogg->playback())
+    return -1;
+
+  while (ogg->state & OggPlayer::Playing)
   {
     ogg->update();
@@ -200 +243 @@
 }
 
+
 /**
  * @brief plays back the sound
@@ -206 +250 @@
 bool OggPlayer::playback()
 {
-  if (!(this->state & FileOpened))
-    return false;
-
-  if(this->isPlaying())
+  if (!(this->state & OggPlayer::FileOpened))
+    return false;
+
+  if(this->state & OggPlayer::Playing)
     return true;
-  this->state |= Playing;
+  this->state |= OggPlayer::Playing;
 
   if(!this->stream(this->buffers[0]) || !this->stream(this->buffers[1]))
@@ -233 +277 @@
 
 /**
- * updates the stream, this has to be done every few parts of a second, for sound-consistency
+ * @brief waits for the AudioThread to be finished.
+ */
+void OggPlayer::suspend()
+{
+  if (this->musicThread != NULL)
+  {
+    assert (!(this->state & Playing));
+    SDL_WaitThread(this->musicThread, NULL);
+    this->musicThread = NULL;
+  }
+  if (this->state & OggPlayer::SourceAllocated)
+  {
+    alSourceStop(this->source);
+    alSourcei(this->source, AL_BUFFER, 0);
+  }
+}
+
+/**
+ * @brief updates the stream, this has to be done every few parts of a second, for sound-consistency
  * @returns true, if the Sound is playing flawlessly
  */
@@ -267 +329 @@
 
 /**
- * gets a new Stream from buffer
+ * @brief gets a new Stream from buffer
  * @param buffer the buffer to get the stream from
  * @return true, if everything worked as planed
@@ -311 +373 @@
   {
     assert(alIsSource(this->source));
-    if (this->state & Playing);
+    if (this->state & OggPlayer::Playing);
     {
-      alSourceStop(source);
+      this->state &= ~OggPlayer::Playing;
+      // Kill the Music Thread.
+      if (this->musicThread != NULL)
+        this->suspend();
+
       SoundEngine::checkError("OggPlayer::release()::alSourceStop", __LINE__);
-      this->state & !Playing;
     }
     empty();
@@ -321 +386 @@
     SoundEngine::getInstance()->pushALSource(this->source);
     this->source = 0;
-    this->state &= !SourceAllocated;
+    this->state &= ~SourceAllocated;
   }
   if (this->state & BuffersAllocated)
@@ -330 +395 @@
     this->buffers[0] = 0;
     this->buffers[1] = 0;
-    this->state &= !BuffersAllocated;
+    this->state &= ~BuffersAllocated;
   }
 
@@ -336 +401 @@
   {
     ov_clear(&oggStream);
-    this->state &= ! FileOpened;
-  }
-
-  // Kill the Music Thread.
-  if (this->musicThread != NULL)
-  {
-    assert (!(this->state & Playing));
-    SDL_WaitThread(this->musicThread, NULL);
-    this->musicThread = NULL;
-  }
+    this->state &= ~FileOpened;
+  }
+
 }
 

trunk/src/lib/sound/ogg_player.h

@@ -20 +20 @@
 
 
-#define OGG_PLAYER_BUFFER_SIZE (8096 * 2)
+#define OGG_PLAYER_BUFFER_SIZE (8096 * 4)
 
 
@@ -33 +33 @@
    */
   typedef enum {
-    None                   = 0x000,
-    FileOpened             = 0x100,
-    SourceAllocated        = 0x200,
-    BuffersAllocated       = 0x400,
-    Stopped                = 0x010,
-    Playing                = 0x020,
-    Paused                 = 0x040,
-    Error                  = 0x001,
+    None                   = 0x000,   //!< Initialized
+    FileOpened             = 0x100,   //!< File is Opened
+    SourceAllocated        = 0x200,   //!< Source is Allocated.
+    BuffersAllocated       = 0x400,   //!< 2 Buffers are Allocated.
+    Stopped                = 0x010,   //!< OggPlayer is stopped.
+    Playing                = 0x020,   //!< OggPlayer is Playing.
+    Paused                 = 0x040,   //!< OggPlayer is Paused.
+    Error                  = 0x001,   //!< An Error has occured.
   } State;
 
@@ -56 +56 @@
   void jumpTo(float timeCode);
 
+  float length();
   bool isPlaying();
   bool getState() { return this->state; };
@@ -67 +68 @@
   static int createAudioThread(void* oggPlayer);
   bool playback();
+  void suspend();
   bool update();