OpenMW/apps/openmw/mwsound/soundmanager.hpp

#ifndef GAME_SOUND_SOUNDMANAGER_H
#define GAME_SOUND_SOUNDMANAGER_H

#include <string>

#include <OgreResourceGroupManager.h>

#include <components/files/filelibrary.hpp>

#include "../mwworld/ptr.hpp"


namespace Ogre
{
    class Root;
    class Camera;
}

namespace MWWorld
{
    struct Environment;
}

namespace MWSound
{
    class Sound_Output;
    class Sound_Decoder;
    class Sound;

    typedef boost::shared_ptr<Sound_Decoder> DecoderPtr;

    class SoundManager
    {
        Ogre::ResourceGroupManager *mResourceMgr;

        // This is used for case insensitive and slash-type agnostic file
        // finding. It takes DOS paths (any case, \\ slashes or / slashes)
        // relative to the sound dir, and translates them into full paths
        // of existing files in the filesystem, if they exist.
        bool mFSStrict;

        MWWorld::Environment& mEnvironment;

        std::auto_ptr<Sound_Output> mOutput;

        boost::shared_ptr<Sound> mMusic;
        std::string mCurrentPlaylist;

        typedef boost::shared_ptr<Sound> SoundPtr;
        typedef std::map<std::string,SoundPtr> IDMap;
        typedef std::map<MWWorld::Ptr,IDMap> SoundMap;
        SoundMap mActiveSounds;
        IDMap mLooseSounds;

        std::string lookup(const std::string &soundId,
                  float &volume, float &min, float &max);
        void play3d(const std::string &file,
            MWWorld::Ptr ptr, const std::string &id,
            float volume, float pitch, float min, float max,
            bool loop, bool untracked=false);
        void streamMusicFull(const std::string& filename);
        bool isPlaying(MWWorld::Ptr ptr, const std::string &id) const;
        void updateRegionSound(float duration);

    protected:
        DecoderPtr getDecoder();
        friend class OpenAL_Output;

    public:
        SoundManager(Ogre::Root*, Ogre::Camera*,
                   const Files::PathContainer& dataDir, bool useSound, bool fsstrict,
                   MWWorld::Environment& environment);
        ~SoundManager();

        void stopMusic();
        ///< Stops music if it's playing

        void streamMusic(const std::string& filename);
        ///< Play a soundifle
        /// \param filename name of a sound file in "Music/" in the data directory.

        void startRandomTitle();
        ///< Starts a random track from the current playlist

        bool isMusicPlaying();
        ///< Returns true if music is playing

        void playPlaylist(const std::string &playlist);
        ///< Start playing music from the selected folder
        /// \param name of the folder that contains the playlist

        void say(MWWorld::Ptr reference, const std::string& filename);
        ///< Make an actor say some text.
        /// \param filename name of a sound file in "Sound/Vo/" in the data directory.

        bool sayDone(MWWorld::Ptr reference) const;
        ///< Is actor not speaking?

        void playSound(const std::string& soundId, float volume, float pitch, bool loop=false);
        ///< Play a sound, independently of 3D-position

        void playSound3D(MWWorld::Ptr reference, const std::string& soundId,
                         float volume, float pitch, bool loop,
                         bool untracked=false);
        ///< Play a sound from an object

        void stopSound3D(MWWorld::Ptr reference, const std::string& soundId="");
        ///< Stop the given object from playing the given sound, If no soundId is given,
        /// all sounds for this reference will stop.

        void stopSound(MWWorld::Ptr::CellStore *cell);
        ///< Stop all sounds for the given cell.

        void stopSound(const std::string& soundId);
        ///< Stop a non-3d looping sound

        bool getSoundPlaying(MWWorld::Ptr reference, const std::string& soundId) const;
        ///< Is the given sound currently playing on the given object?

        void updateObject(MWWorld::Ptr reference);
        ///< Update the position of all sounds connected to the given object.

        void update(float duration);
    };
}

#endif