MuteStateMachine.h

Go to the documentation of this file.

#pragma once
 
namespace krotos
{
    class MuteStateMachine
    {
      public:
        enum MuteState
        {
            Muted,
            RampUp,
            RampDown,
            Playing
        };
 
        inline void nextState(bool targetMuteState) // Calculate what to do next
        {
            if (targetMuteState) // If the user wants mute
            {
                switch (m_currentState)
                {
                case MuteState::RampUp:
                case MuteState::Playing:
                    m_currentState = MuteState::RampDown;
                    break;
                case MuteState::RampDown:
                    m_currentState = MuteState::Muted;
                    break;
                case MuteState::Muted:
                default: // If aready muted, state doesn't change
                    break;
                }
            }
            else // If the user wants un-mute
            {
                switch (m_currentState)
                {
                case MuteState::RampDown:
                case MuteState::Muted:
                    m_currentState = MuteState::RampUp;
                    break;
                case MuteState::RampUp:
                    m_currentState = MuteState::Playing;
                    break;
                case MuteState::Playing:
                default: // If aready playing, state doesn't change
                    break;
                }
            }
        }
 
        inline bool isMuted() { return m_currentState == MuteState::Muted; }
 
        inline bool isPlayingWithNoRamp() { return m_currentState == MuteState::Playing; }
 
        inline bool isNotRamping()
        {
            return (m_currentState != MuteState::RampUp) && (m_currentState != MuteState::RampDown);
        }
 
        inline bool isRampingDown() { return m_currentState == MuteState::RampDown; }
 
        inline bool isMuted(bool targetMuteState)
        {
            nextState(targetMuteState);
            return isMuted();
        }
 
        inline bool isPlaying() { return m_currentState != MuteState::Muted; }
 
      private:
        MuteState m_currentState{MuteState::Muted};
    };
} // namespace krotos