#ifndef GAME_MWBASE_SOUNDMANAGER_H
#define GAME_MWBASE_SOUNDMANAGER_H

#include <string>

#include <boost/shared_ptr.hpp>

#include <components/settings/settings.hpp>

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

namespace Ogre
{
    class Vector3;
}

namespace MWWorld
{
    class CellStore;
}

namespace MWSound
{
    class Sound;
}

namespace MWBase
{
    typedef boost::shared_ptr<MWSound::Sound> SoundPtr;

    /// \brief Interface for sound manager (implemented in MWSound)
    class SoundManager
    {
        public:

            enum PlayMode {
                Play_Normal  = 0, /* tracked, non-looping, multi-instance, environment */
                Play_Loop    = 1<<0, /* Sound will continually loop until explicitly stopped */
                Play_NoEnv   = 1<<1, /* Do not apply environment effects (eg, underwater filters) */
                Play_NoTrack = 1<<2  /* (3D only) Play the sound at the given object's position
                                      * but do not keep it updated (the sound will not move with
                                      * the object and will not stop when the object is deleted. */
            };

        private:

            SoundManager (const SoundManager&);
            ///< not implemented

            SoundManager& operator= (const SoundManager&);
            ///< not implemented

        public:

            SoundManager() {}

            virtual ~SoundManager() {}

            virtual void processChangedSettings(const Settings::CategorySettingVector& settings) = 0;

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

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

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

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

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

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

            virtual void say(const std::string& filename) = 0;
            ///< Say some text, without an actor ref
            /// \param filename name of a sound file in "Sound/" in the data directory.

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

            virtual void stopSay(MWWorld::Ptr reference=MWWorld::Ptr()) = 0;
            ///< Stop an actor speaking

            virtual SoundPtr playSound(const std::string& soundId, float volume, float pitch,
                int mode=Play_Normal) = 0;
            ///< Play a sound, independently of 3D-position

            virtual SoundPtr playSound3D(MWWorld::Ptr reference, const std::string& soundId,
                                 float volume, float pitch, int mode=Play_Normal) = 0;
            ///< Play a sound from an object

            virtual void stopSound3D(MWWorld::Ptr reference, const std::string& soundId) = 0;
            ///< Stop the given object from playing the given sound,

            virtual void stopSound3D(MWWorld::Ptr reference) = 0;
            ///< Stop the given object from playing all sounds.

            virtual void stopSound(const MWWorld::CellStore *cell) = 0;
            ///< Stop all sounds for the given cell.

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

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

            virtual void update(float duration) = 0;

            virtual void setListenerPosDir(const Ogre::Vector3 &pos, const Ogre::Vector3 &dir, const Ogre::Vector3 &up) = 0;
    };

    inline int operator|(SoundManager::PlayMode a, SoundManager::PlayMode b)
    { return static_cast<int> (a) | static_cast<int> (b); }
    inline int operator&(SoundManager::PlayMode a, SoundManager::PlayMode b)
    { return static_cast<int> (a) & static_cast<int> (b); }
}

#endif