fsIAudioManager.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           fsIAudioManager.h
*
*       Purpose:        Music and sound effects handling.
*
*********************************************************************/
 
#ifndef fsIAudioManagerhdr
#define fsIAudioManagerhdr
 
#include <map>
#include <memory>
#include <vector>
 
#include <fsCore/src/fsCUniqueId.h>
#include <fsCore/src/fsTSingletonBackend.h>
 
class fsCResourceName;
class fsICachedSoundEffect;
class fsISoundEffectInstance;
class fsIMusicInstance;
 
 
class fsIAudioManager : public fsTSingletonBackend<fsIAudioManager>
{
        friend class fsTSingletonBackend<fsIAudioManager>;
 
public:
 
        void update(fsS32 pDelta);
 
        void globalVolumeSet(fsF32 pGlobalVolume);
 
        void musicPlay(const fsCResourceName& pFileName);
        void musicStop();
        void musicVolumeSet(fsF32 pMusicVolume);
 
        void effectCache(const fsCResourceName& pFileName);
        void effectPlay(const fsCResourceName& pFileName, fsBool pLoop = false);
        void effectsVolumeSet(fsF32 pEffectsVolume);
        fsF32 effectsVolumeGet() const;
 
        void effectsCacheFlush();
        void pause();
        void resume();
 
protected:
 
        static fsIAudioManager* backendInstanceCreate();
 
        void preDestroyDo() override { shutdown(); }
 
        virtual void effectsCacheFlushDo() = 0;
 
        virtual void updateDo(fsS32 pDelta) {}
 
        virtual void effectsVolumeSetDo(fsF32 pEffectsVolume) {}
 
        virtual void effectPlayDo(fsICachedSoundEffect* const pSoundEffect, fsBool pLoop) {}
 
        fsF32 globalVolumeGet() const;
 
        fsIAudioManager();
        virtual ~fsIAudioManager();
 
        std::map<fsCUniqueId, fsICachedSoundEffect*> mCachedEffects;
        std::vector<std::pair<fsISoundEffectInstance*, fsICachedSoundEffect*>> mLiveEffects;
        std::unique_ptr<fsIMusicInstance> mTune;
 
private:
 
        fsIAudioManager(fsIAudioManager const& pLHS);
        
        fsICachedSoundEffect* effectGet(const fsCResourceName& pFileName);
        void shutdown();
 
        fsF32 mGlobalVolume;
        fsF32 mMusicVolume;
        fsF32 mSFXVolume;
 
};
 
#endif