Changeset 4961 in orxonox.OLD for orxonox/trunk/src/lib/sound/ogg_player.cc

Timestamp:

Jul 28, 2005, 1:19:50 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: music now plays back, as one would expect, and the ReosurceManager handles ogg's.
Also the naming has changed a bit, and doxygen tags are complete in ogg_player.h/cc

File:

• orxonox/trunk/src/lib/sound/ogg_player.cc (modified) (10 diffs)

orxonox/trunk/src/lib/sound/ogg_player.cc

@@ -23 +23 @@
 #include "debug.h"
 
-void OggStream::open(string path)
+
+/**
+ * initializes an Ogg-player from a file
+ * @param fileName the file to load
+ */
+OggPlayer::OggPlayer(const char* fileName)
+{
+  this->setClassID(CL_SOUND_OGG_PLAYER, "OggPlayer");
+  if (fileName != NULL)
+  {
+    this->open(fileName);
+    this->setName(fileName);
+  }
+}
+
+/**
+ * opens a file for playback
+ * @param fileName the file to open
+ */
+void OggPlayer::open(const char* fileName)
 {
     int result;
 
-    if(!(oggFile = fopen(path.c_str(), "rb")))
+    if(!(oggFile = fopen(fileName, "rb")))
         PRINTF(2)("Could not open Ogg file.");
 
@@ -58 +77 @@
 }
 
-
-
-
-void OggStream::release()
+/**
+ * releases a stream
+ */
+void OggPlayer::release()
 {
     alSourceStop(source);
@@ -73 +92 @@
 }
 
-
-
-
-void OggStream::display()
+/**
+ * displays some info about the ogg-file
+ */
+void OggPlayer::display()
 {
     cout
@@ -96 +115 @@
 
 
-
-
-bool OggStream::playback()
+/**
+ * plays back the sound
+ * @return true if running, false otherwise
+ */
+bool OggPlayer::playback()
 {
     if(playing())
@@ -115 +136 @@
 }
 
-
-
-
-bool OggStream::playing()
+/**
+ *
+ * @returns true if the file is playing
+ */
+bool OggPlayer::playing()
 {
     ALenum state;
@@ -127 +149 @@
 }
 
-
-
-
-bool OggStream::update()
+/**
+ * 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
+ */
+bool OggPlayer::update()
 {
     int processed;
@@ -153 +176 @@
 }
 
-
-
-
-bool OggStream::stream(ALuint buffer)
+/**
+ * gets a new Stream from buffer
+ * @param buffer the buffer to get the stream from
+ * @return true, if everything worked as planed
+ */
+bool OggPlayer::stream(ALuint buffer)
 {
     char pcm[BUFFER_SIZE];
@@ -186 +211 @@
 
 
-
-
-void OggStream::empty()
+/**
+ * empties the buffers
+ */
+void OggPlayer::empty()
 {
     int queued;
@@ -203 +229 @@
 }
 
-
-
-
-void OggStream::check()
+/**
+ * checks for errors
+ */
+void OggPlayer::check()
 {
         int error = alGetError();
@@ -214 +240 @@
 }
 
-
-
-const char* OggStream::errorString(int code)
+/**
+ * returns errors
+ * @param code the error-code
+ * @return the error as a String
+ */
+const char* OggPlayer::errorString(int code)
 {
      switch(code)