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

Timestamp:

Jul 28, 2005, 1:19:50 AM (20 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.h (modified) (3 diffs)

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

@@ -1 +1 @@
 /*!
  * @file ogg_player.h
- *  Ogg-Player definition
+ * Ogg-Player definition
  */
 
@@ -8 +8 @@
 #define _OGG_PLAYER_H
 
-#include <string>
 #include <iostream>
 using namespace std;
+
+#include "base_object.h"
 
 #include <AL/al.h>
@@ -21 +22 @@
 
 
+// the definition of a Ogg-Player
+class OggPlayer : public BaseObject
+  {
+  public:
+    OggPlayer(const char* fileName = NULL);
 
-class OggStream
-{
-    public:
+    void open(const char* fileName);
+    void release();
+    void display();
+    bool playback();
+    bool playing();
+    bool update();
 
-        void open(string path);
-        void release();
-        void display();
-        bool playback();
-        bool playing();
-        bool update();
+  protected:
 
-    protected:
+    bool stream(ALuint buffer);
+    void empty();
+    void check();
+    const char* errorString(int code);
 
-        bool stream(ALuint buffer);
-        void empty();
-        void check();
-        const char* errorString(int code);
+  private:
 
-    private:
+    FILE*               oggFile;              //!< general file-handler, to open the sound-file
+    OggVorbis_File      oggStream;            //!< The stream this Ogg-player is playing back
+    vorbis_info*        vorbisInfo;           //!< The information held in the opened ogg-file
+    vorbis_comment*     vorbisComment;        //!< Comments about the ogg-file
 
-        FILE*             oggFile;
-        OggVorbis_File    oggStream;
-        vorbis_info*      vorbisInfo;
-        vorbis_comment*   vorbisComment;
-
-        ALuint            buffers[2];
-        ALuint            source;
-        ALenum            format;
-};
+    ALuint              buffers[2];           //!< buffers that handle sequentially buffering of the audio
+    ALuint              source;               //!< The source we play back on
+    ALenum              format;               //!< The format we play back
+  };