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

Timestamp:

Apr 16, 2006, 8:46:38 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: cleanup of the SoundEngine. man, this was necessary

File:

• trunk/src/lib/sound/ogg_player.h (modified) (3 diffs)

trunk/src/lib/sound/ogg_player.h

@@ -27 +27 @@
 {
 public:
-  OggPlayer(const std::string& fileName = "");
-  virtual ~OggPlayer();
-
-  bool open(const std::string& fileName);
-  void release();
-  bool play();
-  bool playing();
-  bool update();
-
-  void jumpTo(float timeCode);
-
-  void debug();
-  void printState();
-
-  static int createAudioThread(void* oggPlayer);
-
-
-protected:
-  bool stream(ALuint buffer);
-  void empty();
-  const char* errorString(int code);
-
-private:
-  bool playback();
-
-
-public:
+  /**
+   * An enumerator defining in what State the OggPlayer is.
+   * The OggPlayer can be in multiple States listed here.
+   * It can as an example be in FileOpened and Stopped.
+   */
   typedef enum {
     None                   = 0x000,
@@ -65 +43 @@
   } State;
 
+  OggPlayer(const std::string& fileName = "");
+  virtual ~OggPlayer();
+  /** @param state compare this State with the internal State */
+  bool operator==(OggPlayer::State state) { return this->state & state; };
+
+  bool open(const std::string& fileName = "");
+
+  bool play();
+  void stop();
+  void pause();
+  void rewind(); // convenience
+  void jumpTo(float timeCode);
+
+  bool isPlaying();
+  bool getState() { return this->state; };
+
+  void debug() const;
+  void printState() const;
+  const char* getVorbisError(int code);
+
+
+private:
+  static int createAudioThread(void* oggPlayer);
+  bool playback();
+  bool update();
+
+  void release();
+
+  bool stream(ALuint buffer);
+  void empty();
+
+public:
+
 private:
   FILE*               oggFile;              //!< general file-handler, to open the sound-file
@@ -74 +85 @@
   ALuint              source;               //!< The source we play back on
   ALenum              format;               //!< The format we play back
-  unsigned int        state;
+  unsigned int        state;                //!< The States the OggPlayer is in (this can be multiple entries from OggPlayer::State).
 
   SDL_Thread*         musicThread;          //!< The Thread in which music is Played back.