Resource manager can now load sfx and music as samples.

(added a new sfx to test the sound engine)

6 files changed, 369 insertions, 5 deletions

diff --git a/src/resources/music.cpp b/src/resources/music.cpp
new file mode 100644
index 00000000..7c353f03
--- /dev/null
+++ b/src/resources/music.cpp
@@ -0,0 +1,89 @@
+/*
+ *  The Mana World
+ *  Copyright 2004 The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  The Mana World is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  The Mana World is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with The Mana World; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *  $Id$
+ */
+
+#include "music.h"
+#include "resourcemanager.h"
+
+Music::Music(Mix_Chunk *music):
+    music(music)
+{
+    channel = -1;
+}
+
+Music::~Music()
+{
+    unload();
+}
+
+Music* Music::load(void* buffer, unsigned int bufferSize)
+{
+    // Load the raw file data from the buffer in an RWops structure
+    SDL_RWops *rw = SDL_RWFromMem(buffer, bufferSize);
+
+    // Use Mix_LoadMUS to load the raw music data
+    //Mix_Music* music = Mix_LoadMUS_RW(rw); Need to be implemeted
+    Mix_Chunk *tmpMusic = Mix_LoadWAV_RW(rw, 0);
+    
+    // Now free the SDL_RWops data
+    SDL_FreeRW(rw);
+
+    return new Music(tmpMusic);
+}
+
+void Music::unload()
+{
+    //Mix_FreeMusic(music);
+    Mix_FreeChunk(music);
+    music = NULL;
+    loaded = false;
+}
+
+bool Music::play(int loops)
+{
+    /*
+     * Warning: loops should be always set to -1 (infinite) with current
+     * implementation to avoid halting the playback of other samples
+     */
+     
+    /*if (Mix_PlayMusic(music, loops))
+        return true;*/
+    Mix_VolumeChunk(music, 120);
+    channel = Mix_PlayChannel(-1, music, loops);
+    if (channel != -1)
+        return true;
+    return false;
+}
+
+bool Music::stop()
+{
+    /*
+     * Warning: very dungerous trick, it could try to stop channels occupied
+     * by samples rather than the current music file
+     */
+     
+    //Mix_HaltMusic();
+    if (channel != -1)
+        Mix_HaltChannel(channel);
+    // Never fails
+    return true;
+}
diff --git a/src/resources/music.h b/src/resources/music.h
new file mode 100644
index 00000000..ab440e4b
--- /dev/null
+++ b/src/resources/music.h
@@ -0,0 +1,87 @@
+/*
+ *  The Mana World
+ *  Copyright 2004 The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  The Mana World is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  The Mana World is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with The Mana World; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *  $Id$
+ */
+
+#ifndef _TMW_MUSIC_H
+#define _TMW_MUSIC_H
+
+#include "resource.h"
+#include <SDL.h>
+#include <SDL_mixer.h>
+
+/**
+ * Defines a class for loading and storing music.
+ */
+class Music : public Resource
+{
+    public:
+        /**
+         * Destructor.
+         */
+        virtual ~Music();
+
+        /**
+         * Loads an image from a buffer in memory.
+         *
+         * @param buffer     The memory buffer containing the music data.
+         * @param bufferSize The size of the memory buffer in bytes.
+         *
+         * @return <code>NULL</code> if the an error occurred, a valid pointer
+         *         otherwise.
+         */
+        static Music *load(void* buffer, unsigned int bufferSize);
+
+        /**
+         * Frees the resources created by SDL.
+         */
+        virtual void unload();
+
+        /**
+         * Plays the music.
+         *
+         * @param loops     Number of times to repeat the playback.
+         *
+         * @return <code>true</code> if the playback started properly
+         *         <code>false</code> otherwise.
+         */
+        virtual bool play(int loops);
+
+        /**
+         * Stops the music.
+         *
+         * @return <code>true</code> if the playback was stopped properly
+         *         <code>false</code> otherwise.
+         */
+        virtual bool stop();
+
+    protected:
+        /**
+         * Constructor.
+         */
+        Music(Mix_Chunk *music);
+
+        //Mix_Music *music;
+        Mix_Chunk *music;
+        int channel;
+};
+
+#endif
diff --git a/src/resources/resourcemanager.cpp b/src/resources/resourcemanager.cpp
index cc5c9562..47c4daa4 100644
--- a/src/resources/resourcemanager.cpp
+++ b/src/resources/resourcemanager.cpp
@@ -95,7 +95,24 @@ Resource* ResourceManager::get(const E_RESOURCE_TYPE &type,
             logger.log("Warning: Map resource not supported.");
             break;
         case MUSIC:
-            logger.log("Warning: Music resource not supported.");
+            {
+                // Load the music resource file
+                int fileSize;
+                void *buffer = loadFile(idPath, fileSize);
+
+                if (buffer != NULL)
+                {
+                    // Let the music class load it
+                    resource = reinterpret_cast<Resource*>(Music::load(buffer,
+                                fileSize));
+
+                    // Cleanup
+                    free(buffer);
+                }
+                else {
+                    logger.log("Warning: resource doesn't exist!");
+                }
+            }
             break;
         case IMAGE:
             {
@@ -115,9 +132,7 @@ Resource* ResourceManager::get(const E_RESOURCE_TYPE &type,
                 else {
                     logger.log("Warning: resource doesn't exist!");
                 }
-
             }
-
             break;
         case SCRIPT:
             logger.log("Warning: Script resource not supported.");
@@ -126,7 +141,24 @@ Resource* ResourceManager::get(const E_RESOURCE_TYPE &type,
             logger.log("Warning: Tileset resource not supported.");
             break;
         case SOUND_EFFECT:
-            logger.log("Warning: Sound FX resource not supported.");
+            {
+                // Load the sample resource file
+                int fileSize;
+                void *buffer = loadFile(idPath, fileSize);
+
+                if (buffer != NULL)
+                {
+                    // Let the sound effect class load it
+                    resource = reinterpret_cast<Resource*>(SoundEffect::load(
+                            buffer, fileSize));
+
+                    // Cleanup
+                    free(buffer);
+                }
+                else {
+                    logger.log("Warning: resource doesn't exist!");
+                }
+            }
             break;
         default: 
             logger.log("Warning: Unknown resource type");
@@ -153,6 +185,16 @@ Image *ResourceManager::getImage(const std::string &idPath, int flags)
     return (Image*)get(IMAGE, idPath, flags);
 }
 
+Music *ResourceManager::getMusic(const std::string &idPath)
+{
+      return (Music*)get(MUSIC, idPath, 0);
+}
+
+SoundEffect *ResourceManager::getSoundEffect(const std::string &idPath)
+{
+      return (SoundEffect*)get(SOUND_EFFECT, idPath, 0);
+}
+
 ResourceManager* ResourceManager::getInstance()
 {
     // Create a new instance if necessary.
diff --git a/src/resources/resourcemanager.h b/src/resources/resourcemanager.h
index 1933cc76..d8f4cb90 100644
--- a/src/resources/resourcemanager.h
+++ b/src/resources/resourcemanager.h
@@ -28,6 +28,8 @@
 #include <string>
 #include "resource.h"
 #include "image.h"
+#include "music.h"
+#include "soundeffect.h"
 
 /**
  * A resource entry descriptor.
@@ -86,9 +88,11 @@ class ResourceManager
                 int flags = 0);
 
         /**
-         * Convenience wrapper around ResourceManager::create.
+         * Convenience wrappers around ResourceManager::create.
          */
         Image *getImage(const std::string &idPath, int flags = 0);
+        Music *getMusic(const std::string &idPath);
+        SoundEffect *getSoundEffect(const std::string &idPath);
 
         /**
          * Returns an instance of the class, creating one if it does not
diff --git a/src/resources/soundeffect.cpp b/src/resources/soundeffect.cpp
new file mode 100644
index 00000000..5d51ef12
--- /dev/null
+++ b/src/resources/soundeffect.cpp
@@ -0,0 +1,64 @@
+/*
+ *  The Mana World
+ *  Copyright 2004 The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  The Mana World is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  The Mana World is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with The Mana World; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *  $Id$
+ */
+
+#include "soundeffect.h"
+#include "resourcemanager.h"
+
+SoundEffect::SoundEffect(Mix_Chunk *soundEffect):
+    soundEffect(soundEffect)
+{
+}
+
+SoundEffect::~SoundEffect()
+{
+    unload();
+}
+
+SoundEffect* SoundEffect::load(void* buffer, unsigned int bufferSize)
+{
+    // Load the raw file data from the buffer in an RWops structure
+    SDL_RWops *rw = SDL_RWFromMem(buffer, bufferSize);
+
+    // Use Mix_LoadWAV_RW to load the raw music data
+    Mix_Chunk *tmpSoundEffect = Mix_LoadWAV_RW(rw, 0);
+    
+    // Now free the SDL_RWops data
+    SDL_FreeRW(rw);
+
+    return new SoundEffect(tmpSoundEffect);
+}
+
+void SoundEffect::unload()
+{
+    Mix_FreeChunk(soundEffect);
+    soundEffect = NULL;
+    loaded = false;
+}
+
+bool SoundEffect::play(int loops, int volume)
+{
+    Mix_VolumeChunk(soundEffect, volume);
+    if (Mix_PlayChannel(-1, soundEffect, loops) != -1)
+        return true;
+    return false;
+}
diff --git a/src/resources/soundeffect.h b/src/resources/soundeffect.h
new file mode 100644
index 00000000..959a8e2e
--- /dev/null
+++ b/src/resources/soundeffect.h
@@ -0,0 +1,78 @@
+/*
+ *  The Mana World
+ *  Copyright 2004 The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  The Mana World is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  The Mana World is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with The Mana World; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *  $Id$
+ */
+
+#ifndef _TMW_SOUND_EFFECT_H
+#define _TMW_SOUND_EFFECT_H
+
+#include "resource.h"
+#include <SDL.h>
+#include <SDL_mixer.h>
+
+/**
+ * Defines a class for loading and storing sound effects.
+ */
+class SoundEffect : public Resource
+{
+    public:
+        /**
+         * Destructor.
+         */
+        virtual ~SoundEffect();
+
+        /**
+         * Loads a sample from a buffer in memory.
+         *
+         * @param buffer     The memory buffer containing the sample data.
+         * @param bufferSize The size of the memory buffer in bytes.
+         *
+         * @return <code>NULL</code> if the an error occurred, a valid pointer
+         *         otherwise.
+         */
+        static SoundEffect *load(void* buffer, unsigned int bufferSize);
+
+        /**
+         * Frees the resources created by SDL.
+         */
+        virtual void unload();
+
+        /**
+         * Plays the sample.
+         *
+         * @param loops     Number of times to repeat the playback.
+         * @param volume    Sample playback volume.
+         *
+         * @return <code>true</code> if the playback started properly
+         *         <code>false</code> otherwise.
+         */
+        virtual bool play(int loops, int volume);
+
+    protected:
+        /**
+         * Constructor.
+         */
+        SoundEffect(Mix_Chunk *soundEffect);
+
+        Mix_Chunk *soundEffect;
+};
+
+#endif