Changeset 3887 in orxonox.OLD for orxonox/branches/sound_engine/src/lib/sound

Timestamp:

Apr 19, 2005, 12:28:55 AM (20 years ago)

Author:

bensch

Message:

orxonox/trunk: added some classes to handle Audio

Location:

orxonox/branches/sound_engine/src/lib/sound

Files:

• . (added)
• sound_engine.cc (copied) (copied from orxonox/branches/sound_engine/src/proto/proto_singleton.cc) (2 diffs)
• sound_engine.h (copied) (copied from orxonox/branches/sound_engine/src/proto/proto_singleton.h) (1 diff)

orxonox/branches/sound_engine/src/lib/sound/sound_engine.cc

@@ -10 +10 @@
 
    ### File Specific:
-   main-programmer: ...
+   main-programmer: Benjamin Grauer
    co-programmer: ...
+   
+   Some code was taken from Simon's first implementation of the SoundEngine.
 */
 
-//#define DEBUG_SPECIAL_MODULE DEBUG_MODULE_WORLD_ENTITY
+#define DEBUG_SPECIAL_MODULE DEBUG_MODULE_SOUND
 
-#include "proto_singleton.h"
+#include "sound_engine.h"
 
 using namespace std;
-
 
 /**
    \brief standard constructor
 */
-ProtoSingleton::ProtoSingleton () 
+SoundEngine::SoundEngine () 
 {
-   this->setClassName ("ProtoSingleton");
-
+   this->setClassName ("SoundEngine");
+   this->isInit = false;
+   this->enableSound();
 }
 
-/**
-   \brief the singleton reference to this class
-*/
-ProtoSingleton* ProtoSingleton::singletonRef = NULL;
+//! brief the singleton reference to this class
+SoundEngine* SoundEngine::singletonRef = NULL;
 
 /**
    \returns a Pointer to this Class
 */
-ProtoSingleton* ProtoSingleton::getInstance(void)
+SoundEngine* SoundEngine::getInstance(void)
 {
-  if (!ProtoSingleton::singletonRef)
-    ProtoSingleton::singletonRef = new ProtoSingleton();
-  return ProtoSingleton::singletonRef;
+  if (!SoundEngine::singletonRef)
+    SoundEngine::singletonRef = new SoundEngine();
+  return SoundEngine::singletonRef;
 }
 
@@ -49 +49 @@
 
 */
-ProtoSingleton::~ProtoSingleton () 
+SoundEngine::~SoundEngine () 
 {
-  ProtoSingleton::singletonRef = NULL;
+  SoundEngine::singletonRef = NULL;
+  
+  this->disableSound();
+}
 
+
+/**
+   \brief enables the SDL_mixer library
+*/
+void SoundEngine::enableSound(void)
+{
+  if (!this->isInit)
+    if (SDL_Init(SDL_INIT_AUDIO))
+      {
+        PRINTF(1)("SDL-sound could not be initialized\n");
+        return;
+      }
+  this->isInit = true;
 }
+
+/**
+   \brief disabled SDL_mixer
+*/
+void SoundEngine::disableSound(void)
+{
+  if (this->isInit)
+    {
+      SDL_QuitSubSystem(SDL_INIT_AUDIO);
+    }
+  else
+    PRINTF(4)("SDL_mixer was not initialized.\n");
+}
+
+/**
+   \brief checks if the compiled version and the local version of SDL_mixer match.
+   \returns true if match, false otherwise
+*/
+bool SoundEngine::checkVersion(void)
+{
+  SDL_version compile_version;
+  SDL_version link_version;
+  MIX_VERSION(&compile_version);
+  link_version = *Mix_Linked_Version();
+
+  if (compile_version.major == link_version.major &&
+      compile_version.minor == link_version.minor &&
+      compile_version.patch == link_version.patch)
+    {
+      return true;
+    }
+  else
+    {
+      PRINTF(2)("compiled with SDL_mixer version: %d.%d.%d\n", 
+                compile_version.major,
+                compile_version.minor,
+                compile_version.patch);
+      
+      PRINTF(2)("running with SDL_mixer version: %d.%d.%d\n", 
+                link_version.major,
+                link_version.minor,
+                link_version.patch);
+      return false;
+    }
+}

orxonox/branches/sound_engine/src/lib/sound/sound_engine.h

@@ -1 +1 @@
 /*! 
-    \file proto_singleton.h
-    \brief Definition of the proto class template, used quickly start work
-    
-    a simple file to copy and create a singleton-class from
+    \file sound_engine.h
+    \brief Definition of the SoundEngine
+
+    !!AVOID!!:
+    SDL_OpenAudio
+     Use Mix_OpenAudio instead. 
+    SDL_CloseAudio
+     Use Mix_CloseAudio instead. 
+    SDL_PauseAudio
+     Use Mix_Pause(-1) and Mix_PauseMusic instead, to pause.
+     Use Mix_Resume(-1) and Mix_ResumeMusic instead, to unpause. 
+    SDL_LockAudio
+     This is just not needed since SDL_mixer handles this for you.
+     Using it may cause problems as well. 
+    SDL_UnlockAudio
+     This is just not needed since SDL_mixer handles this for you.
+     Using it may cause problems as well. 
 */
 
-#ifndef _PROTO_SINGLETON_H
-#define _PROTO_SINGLETON_H
+#ifndef _SOUND_ENGINE_H
+#define _SOUND_ENGINE_H
 
 #include "base_object.h"
+#include <SDL_mixer.h>
 
-// FORWARD DEFINITION \\
+// FORWARD DEFINITION
 
-//! A default singleton class.
-class ProtoSingleton : public BaseObject {
+//! The Main Sound Engine
+class SoundEngine : public BaseObject {
 
  public:
-  static ProtoSingleton* getInstance(void);
-  virtual ~ProtoSingleton(void);
+  static SoundEngine* getInstance(void);
+  virtual ~SoundEngine(void);
 
  private:
-  ProtoSingleton(void);
-  static ProtoSingleton* singletonRef;
+  SoundEngine(void);
+  static SoundEngine* singletonRef;
+
+  
+  
+  void enableSound(void);
+  void disableSound(void);
+  static bool checkVersion(void);
+
+  bool isInit;
 };
 
-#endif /* _PROTO_SINGLETON_H */
+
+#endif /* _SOUND_ENGINE_H */