---

ISound.h

Go to the documentation of this file.

/***********************************************************\
Copyright (C) James Boer, 2002. 
All rights reserved worldwide.

This software is provided "as is" without express or implied
warranties. You may freely copy and compile this source into
applications you distribute provided that the copyright text
below is included in the resulting source code, for example:
"Portions Copyright (C) James Boer, 2002"
\***********************************************************/
#ifndef ISOUND_H__
#define ISOUND_H__

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Audio
{
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 

struct BackgroundInit
{
        BackgroundInit()        {  Clear();  }
        void Clear()
        {
                m_pSound = 0;
                m_fMinVolume = 1.0f;
                m_fMaxVolume = 1.0f;
                m_fMinVolumeTime = 0.0f;
                m_fMaxVolumeTime = 0.0f;
                m_fMinPitch = 1.0f;
                m_fMaxPitch = 1.0f;
                m_fMinPitchTime = 0.0f;
                m_fMaxPitchTime = 0.0f;
        };

        ISound*                         m_pSound;
        float                           m_fMinVolume;
        float                           m_fMaxVolume;
        float                           m_fMinVolumeTime;
        float                           m_fMaxVolumeTime;
        float                           m_fMinPitch;
        float                           m_fMaxPitch;
        float                           m_fMinPitchTime;
        float                           m_fMaxPitchTime;
};

struct PeriodicInit
{
        PeriodicInit()  {  Clear();  }
        void Clear()
        {
                m_pSound3D = 0;
                m_fMinPitch = 1.0f;
                m_fMaxPitch = 1.0f;
                m_fMinDelay = 0.0f;
                m_fMaxDelay = 0.0f;
                m_fXRange = 25.0f;
                m_fYRange = 25.0f;
                m_fZRange = 25.0f;
                m_fMinDistance = 0.0f;
        };
        ISound3D*                       m_pSound3D;
        float                           m_fMinPitch;
        float                           m_fMaxPitch;
        float                           m_fMinDelay;
        float                           m_fMaxDelay;
        float                           m_fXRange;
        float                           m_fYRange;
        float                           m_fZRange;
        float                           m_fMinDistance;
};



class ISoundScape : public IPlayable
{
public:
        virtual bool Init() = 0;

        virtual bool AddElement(const BackgroundInit& init) = 0;
        virtual bool AddElement(const PeriodicInit& init) = 0;

        virtual bool SetVolume(float fVolume) = 0;
        virtual bool GetVolume(float& fVolume) const = 0;

};


class ISoundManager
{
public:

        virtual bool Init() = 0;
        virtual void Term() = 0;
        virtual bool IsInitialized() = 0;

        virtual bool LoadScript(std::string sFileName) = 0;
        virtual bool RemoveAll() = 0;

        virtual bool GetSound(std::string sSoundName, ISound*& pSound) = 0;
        virtual bool GetSoundInit(std::string sSoundName, SoundInit& init) = 0;
        virtual bool ReleaseSound(std::string sSoundName, ISound* pSound) = 0;
        virtual bool IsSoundRegistered(std::string sSoundName) = 0;
        virtual void ResetSoundItr() = 0;
        virtual bool GetNextSound(std::string& sSoundName) = 0;
        virtual bool RemoveSound(std::string sSoundName) = 0;
        virtual bool RemoveAllSounds() = 0;

        virtual bool GetSound3D(std::string sSound3DName, ISound3D*& pSound3D) = 0;
        virtual bool GetSound3DInit(std::string sSound3DName, Sound3DInit& init) = 0;
        virtual bool ReleaseSound3D(std::string sSound3DName, ISound3D* pSound3D) = 0;
        virtual bool IsSound3DRegistered(std::string sSound3DName) = 0;
        virtual void ResetSound3DItr() = 0;
        virtual bool GetNextSound3D(std::string& sSound3DName) = 0;
        virtual bool RemoveSound3D(std::string sSound3DName) = 0;
        virtual bool RemoveAllSounds3D() = 0;

        virtual bool CreateSoundScape(ISoundScape*& pSoundScape) = 0;
        virtual bool InitSoundScape(std::string sSoundScapeName, ISoundScape*& pSoundScape) = 0;
        virtual bool IsSoundScapeRegistered(std::string sSoundScapeName) = 0;
        virtual void ResetSoundScapeItr() = 0;
        virtual bool GetNextSoundScape(std::string& sSoundScapeName) = 0;
        virtual bool RemoveSoundScape(std::string sSoundScapeName) = 0;
        virtual bool RemoveAllSoundScapes() = 0;
};

inline static ISoundManager* SoundMgr()
{  return AudioScriptFactory::GetSoundMgr();  }

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}; // namespace Audio
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

#endif // ISOUND_H__

---