UDSoundRuntime.hpp

Go to the documentation of this file.

#pragma once
 
#include "AudioRuntime.hpp"
#include "DataBanks.hpp"
#include "IBarScoreStripPlayback.hpp"
#include "PennybagsCatalog.hpp"
#include "TokenVoiceCatalog.hpp"
 
#include <array>
#include <cstddef>
#include <cstdint>
#include <expected>
#include <optional>
#include <string>
 
namespace monopoly::udsound
{
    inline constexpr data::DataTag WarningTag = 0x0849;
    inline constexpr data::DataTag ClickTag = 0x084A;
    inline constexpr data::DataTag BuildTag = 0x084B;
    inline constexpr data::DataTag CashUpTag = 0x084C;
    inline constexpr data::DataTag CashDownTag = 0x084D;
    inline constexpr data::DataTag CreditsTag = 0x084E;
    inline constexpr data::DataTag MusicBaseTag = 0x084F;
    inline constexpr data::DataTag SaveFailureTag = 0x0856;
    inline constexpr data::DataTag UnbuildTag = 0x085B;
    inline constexpr data::DataTag SirenBaseTag = 0x066B;
    inline constexpr std::uint8_t SirenCount = 2;
    inline constexpr std::uint8_t MusicTuneCount = 5;
 
    struct TokenVoicePlayResult
    {
        bool skipped{};
        bool started{};
        bool queued{};
    };
    class Runtime final
    {
    public:
        [[nodiscard]] std::expected<void, std::string> warning(audio::Runtime& audio);
        [[nodiscard]] std::expected<void, std::string> click(audio::Runtime& audio);
        [[nodiscard]] std::expected<void, std::string> build(audio::Runtime& audio);
        [[nodiscard]] std::expected<void, std::string> unbuild(audio::Runtime& audio);
        [[nodiscard]] std::expected<void, std::string> saveFailure(audio::Runtime& audio);
        [[nodiscard]] std::expected<void, std::string> siren(
            audio::Runtime& audio, std::uint8_t variant);
        [[nodiscard]] std::expected<void, std::string> cashUp(audio::Runtime& audio);
        [[nodiscard]] std::expected<void, std::string> cashDown(audio::Runtime& audio);
        [[nodiscard]] std::expected<void, std::string> syncMusic(
            audio::Runtime& audio, bool gameInProgress, bool musicOn,
            std::uint8_t tuneIndex, bool creditsActive = false);
        [[nodiscard]] std::expected<void, std::string> syncCash(
            audio::Runtime& audio, ibar::ScoreCashChange change);
 
        [[nodiscard]] std::expected<TokenVoicePlayResult, std::string> tokenVoice(
            audio::Runtime& audio, bool voicesOn, std::uint8_t token,
            TokenVoiceLine line, TokenVoiceClipPolicy policy,
            std::uint32_t randomValue);
        [[nodiscard]] std::expected<TokenVoicePlayResult, std::string> pennybagsVoice(
            audio::Runtime& audio, bool hostCommentsOn, PennybagsVoice voice,
            TokenVoiceClipPolicy policy, std::uint32_t randomValue);
        [[nodiscard]] std::expected<TokenVoicePlayResult, std::string> pennybagsSpecific(
            audio::Runtime& audio, bool hostCommentsOn, data::DataId wave,
            TokenVoiceClipPolicy policy);
        [[nodiscard]] std::expected<bool, std::string> syncTokenVoices(
            audio::Runtime& audio);
        void watchTokenVoice(audio::Runtime& audio, std::uint8_t token) noexcept;
        void watchPennybags(audio::Runtime& audio) noexcept;
        [[nodiscard]] bool tokenVoiceActive(
            const audio::Runtime& audio, std::uint8_t token) const noexcept;
        [[nodiscard]] bool talkingQueueIdle(const audio::Runtime& audio) const noexcept;
        [[nodiscard]] bool postLockVoiceSlotEmpty() const noexcept
        { return !pendingTalkingVoice_; }
 
        void reset(audio::Runtime* audio = nullptr) noexcept;
        [[nodiscard]] std::optional<data::DataId> currentMusic() const noexcept
        { return currentMusic_; }
 
    private:
        struct PendingTalkingVoice
        {
            std::optional<std::uint8_t> token;
            data::DataId wave{};
            float gain{1.0F};
        };
        [[nodiscard]] bool anyTalking(const audio::Runtime& audio) const noexcept;
        void stopTalking(audio::Runtime& audio) noexcept;
        void watchTalking(const audio::Runtime& audio) noexcept;
        [[nodiscard]] std::expected<void, std::string> startTalkingVoice(
            audio::Runtime& audio, const PendingTalkingVoice& voice);
        [[nodiscard]] std::expected<TokenVoicePlayResult, std::string> playTalkingVoice(
            audio::Runtime& audio, PendingTalkingVoice voice,
            TokenVoiceClipPolicy policy);
 
        std::optional<data::DataId> currentMusic_;
        std::uint8_t creditsMusicStatus_{};
        std::optional<PendingTalkingVoice> pendingTalkingVoice_;
        std::array<bool, TokenVoiceTokenCount> watchedTokenVoices_{};
        bool watchedPennybags_{};
    };
}