tb_audio_manager.hpp

#ifndef TurtleBrains_AudioManager_hpp
#define TurtleBrains_AudioManager_hpp

#include <turtle_brains/core/tb_configuration.hpp>
#if defined(tb_with_audio)

#include <turtle_brains/core/tb_noncopyable.hpp>
#include <turtle_brains/core/tb_string.hpp>
#include <turtle_brains/core/tb_types.hpp>
#include <turtle_brains/audio/tb_audio_controller.hpp>

#include <memory>

namespace tbImplementation { class AudioManagerCreator; struct AudioManagerData; }

namespace TurtleBrains
{
    namespace Audio
    {
        class AudioManager : public tbCore::Noncopyable
        {
        public:

            //
            // example_event_table.json
            //
            //{ "audio_events":[
            //  "version":2,
            //  "root_path":"data/../audio",
            //  { "name":"simple", "source":"data/sound.wav" },
            //  { "name":"loop", "source":"data/sound.wav", "looping":true },
            //  { "name":"music", "source":"data/music.ogg", "looping":true, "music":true },
            //  { "name":"music_streaming", "source":"data/music.ogg", "looping":true, "music":true, "streaming":true },
            //  { "name":"music_loop_points", "source":"data/music.ogg", "looping":true, "music":true, "streaming":true, "start_loop":50000, "end_loop":403032 },
            //  { "name":"music_jingle", "source":"data/jingle.wav", "music":true },
            //  { "name":"extra", "source":"data/sound.wav", "pitch":1.0, "volume":1.0 },
            //  { "name":"multi_file", "source":[
            //      "data/sound1.wav",
            //      "data/sound2.wav" ]
            //  },
            //  { "name":"multi_custom", "source":[
            //      { "file":"data/sound1.wav", "pitch":1.0, "volume":1.0 },
            //      { "file":"data/sound2.wav", "min_pitch":0.8, "max_pitch":1.2, "min_volume":0.5, "max_volume":0.6 } ]
            //  },
            //  { "name":"multi_mixed", "source":[
            //      "data/sound1.wav",
            //      "data/sound2.wav",
            //      { "file":"data/sound3.wav", "pitch":1.0, "volume":1.0 },
            //      { "file":"data/sound4.wav", "min_pitch":0.8, "max_pitch":1.2, "min_volume":0.5, "max_volume":0.6 }  ]
            //      }
            //  ]
            // }
            //
            // The json data does not need to contain the optional parameters shown below with their default values.
            //   looping(false), pitch(1.0), volume(1.0), min_pitch(1.0), max_pitch(1.0), min_volume(1.0), max_volume(1.0)
            //
            bool LoadEventTable(const tbCore::tbString& eventTableName, const tbCore::tbString& eventTableFile);

            void UnloadEventTable(const tbCore::tbString& eventTableName);

            AudioHandle CreateSoundFromFile(const tbCore::tbString& filename, const bool isStreaming = false);

            void DestroySound(const AudioHandle& audioHandle);

            bool HasEvent(const tbCore::tbString& eventTableName, const tbCore::tbString& eventName);

            AudioController PlayEvent(const tbCore::tbString& eventTableName, const tbCore::tbString& eventName);

            AudioController PlaySound(const AudioHandle& audioHandle, const bool isLooping = false, const bool isMusic = false);

            float GetGlobalMusicVolume(void) const;

            void SetGlobalMusicVolume(const float musicVolume);

            float GetGlobalEffectVolume(void) const;

            void SetGlobalEffectVolume(const float effectVolume);

            void PauseAllAudio(void);

            void ResumeAllAudio(void);

            tbCore::uint64 ComputeMemoryUsage(void) const;

        private:
            friend class tbImplementation::AudioManagerCreator;

            AudioManager(void);

            ~AudioManager(void);

            std::unique_ptr<tbImplementation::AudioManagerData> mData;
        };

        extern AudioManager& theAudioManager;

        void OpenAudioDevice(void);

        void CloseAudioDevice(void);

        void UpdateAudioDevice(void);

    }; /* namespace Audio */
}; /* namespace TurtleBrains */

namespace tbAudio = TurtleBrains::Audio;

#endif /* tb_with_audio */
#endif /* TurtleBrains_AudioManager_hpp */