AudioSystem.h

Go to the documentation of this file.

// File: AudioSystem.h
// Description: Initialilze FMOD and holds messages for audio playback
// Author(s):  Marcelo Escamilla (marcelo.escamilla@digipen.edu) worked on the audio playback parts and system initialization
//             Ori Balashov (ori.balashov@digipen.edu) Helped with message implementation
// 2025 / 10 / 20
// (C) Digipen 2025
// newSystemStub.h
//   ____   __                  __  __
// /\__  _\/\ \                /\ \/\ \
// \/_/\ \/\ \ \___      __    \ \ \_\ \    ___   __  __    ____     __
//    \ \ \ \ \  _ `\  /'__`\   \ \  _  \  / __`\/\ \/\ \  /',__\  /'__`\
//     \ \ \ \ \ \ \ \/\  __/    \ \ \ \ \/\ \L\ \ \ \_\ \/\__, `\/\  __/
//      \ \_\ \ \_\ \_\ \____\    \ \_\ \_\ \____/\ \____/\/\____/\ \____\
//       \/_/  \/_/\/_/\/____/     \/_/\/_/\/___/  \/___/  \/___/  \/____/
#pragma once
 
#include "Framework/System.h"
#include <FMOD/fmod.h>
#include <FMOD/fmod.hpp>
 
struct Message;
 
namespace sys
{
class AudioSystem : public System
{
public:
#pragma region static_functions

    static auto getEnum() -> Type
    {
        return Type::AudioSystem;
    }
 
#pragma endregion
 
    // this constructor will initialize FMOD init stuff should only be called once
    AudioSystem();
    // Shutdown code
    ~AudioSystem() override;
    AudioSystem(const AudioSystem& other);
    AudioSystem(AudioSystem&& other) noexcept;
    auto operator=(const AudioSystem& other) -> AudioSystem&;
    auto operator=(AudioSystem&& other) noexcept -> AudioSystem&;
 
 
#pragma region overridden_functions
 
    auto clone() const -> std::unique_ptr<GameObject> override
    {
        return std::make_unique<AudioSystem>(*this);
    }
 
    auto systemShowMenu() -> void override;
 
    auto onUpdate(float dt) -> void override;
 
    auto endWindow() -> void override
    {
    }; // for debug ImGUI
    auto onRender() -> void override;
    auto load(const Stream& stream) -> void override;
    auto save(Stream& stream) const -> void override;
 
#pragma endregion
 
#pragma region AudioSystem_Functions

    auto stopAll() -> void;

    auto getFMODSystem() -> FMOD::System*
    {
        return this->member;
    }

    auto getOverrideChannelGroup() -> FMOD::ChannelGroup*
    {
        return this->overrideGroup;
    }

    auto getMasterChannelGroup() -> FMOD::ChannelGroup*
    {
        return this->masterGroup;
    }

    auto getMusicChannelGroup() -> FMOD::ChannelGroup*
    {
        return this->musicGroup;
    }

    auto setMusicPitch(float gain) -> void
    {
        if (musicGroup)
        {
            musicGroup->setPitch(gain);
        }
    }

    auto getSFXChannelGroup() -> FMOD::ChannelGroup*
    {
        return this->sfxGroup;
    }

    auto setSFXPitch(float gain) -> void
    {
        if (sfxGroup)
        {
            sfxGroup->setPitch(gain);
        }
    }

    auto getUIChannelGroup() -> FMOD::ChannelGroup*
    {
        return this->uiGroup;
    }

    auto setUIPitch(float gain) -> void
    {
        if (uiGroup)
        {
            uiGroup->setPitch(gain);
        }
    }

    auto setMasterPitch(float gain) -> void
    {
        if (masterGroup)
        {
            masterGroup->setPitch(gain);
        }
    }

    auto setOverridePitch(float gain) -> void
    {
        if (overrideGroup)
        {
            overrideGroup->setPitch(gain);
        }
    }

    auto setMuted(bool muted) -> void
    {
        if (overrideGroup)
        {
            overrideGroup->setMute(muted);
        }
    }

    auto setOverrideVolume(float volume) -> void
    {
        if (overrideGroup)
        {
            overrideGroup->setVolume(volume);
        }
    }

    auto getOverrideVolume() const -> float
    {
        auto volume = 0.0f;
        if (overrideGroup)
        {
            overrideGroup->getVolume(&volume);
        }
        return volume;
    }

    auto setMasterVolume(float volume) -> void
    {
        if (masterGroup)
        {
            masterGroup->setVolume(volume);
        }
    }

    auto getMasterVolume() const -> float
    {
        auto volume = 0.0f;
        if (masterGroup)
        {
            masterGroup->getVolume(&volume);
        }
        return volume;
    }

    auto setMusicVolume(float volume) -> void
    {
        if (musicGroup)
        {
            musicGroup->setVolume(volume);
        }
    }

    auto getMusicVolume() const -> float
    {
        auto volume = 0.0f;
        if (musicGroup)
        {
            musicGroup->getVolume(&volume);
        }
        return volume;
    }

    auto setSFXVolume(float volume) -> void
    {
        if (sfxGroup)
        {
            sfxGroup->setVolume(volume);
        }
    }

    auto getSFXVolume() -> float
    {
        auto volume = 0.0f;
        if (sfxGroup)
        {
            sfxGroup->getVolume(&volume);
        }
        return volume;
    }

    auto setUIVolume(float volume) -> void
    {
        if (uiGroup)
        {
            uiGroup->setVolume(volume);
        }
    }

    auto getUIVolume() const -> float
    {
        auto volume = 0.0f;
        if (uiGroup)
        {
            uiGroup->getVolume(&volume);
        }
        return volume;
    }
    
    auto playAudio(const std::string& soundEffect) const -> void;
    auto playModulatedAudio(const std::string& soundEffect) const -> void;
    auto playPitchedAudio(const std::string& soundEffect, float pitch) const -> void;
    auto playVolumedAudio(const std::string& soundEffect, float volume) const -> void;
 
#pragma endregion
 
private:
#pragma region member_variables
    FMOD::System* member;
    FMOD::ChannelGroup* masterGroup;
    FMOD::ChannelGroup* musicGroup;
    FMOD::ChannelGroup* sfxGroup;
    FMOD::ChannelGroup* uiGroup;
    FMOD::ChannelGroup* overrideGroup; // exists solely for the purpose of allowing temporary overrides of pitch for all
 
#pragma endregion
 
#pragma region helper_functions
 
#pragma endregion
 
#pragma region AudioSystem_Messages
 
    auto linkMessages() -> void;
 
    auto receivePlayAudioMessage(const Message* message) -> Message;
    auto receivePlayModulatedMessage(const Message* message) -> Message;
    auto receiveIncreaseVolume(const Message* message) -> Message;
    auto receiveDecreaseVolume(const Message* message) -> Message;
 
#pragma endregion
 
#pragma region static_variables
 
#pragma endregion
 
 
};
}