o3de/Gems/LmbrCentral/Code/Source/Audio/AudioProxyComponent.cpp

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#include "AudioProxyComponent.h"

#include <ISystem.h>
#include <MathConversion.h>

#include <AzCore/Component/Entity.h>
#include <AzCore/Serialization/EditContext.h>
#include <AzCore/Serialization/SerializeContext.h>

#include <AzCore/Debug/Trace.h>

namespace LmbrCentral
{
    //=========================================================================
    void AudioProxyComponent::Reflect(AZ::ReflectContext* context)
    {
        auto serializeContext = azrtti_cast<AZ::SerializeContext*>(context);
        if (serializeContext)
        {
            serializeContext->Class<AudioProxyComponent, AZ::Component>()
                ->Version(1)
                ;

            auto editContext = serializeContext->GetEditContext();
            if (editContext)
            {
                editContext->Class<AudioProxyComponent>("Audio Proxy", "The Audio Proxy component is a required dependency when you add other audio components to an entity")
                    ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
                        ->Attribute(AZ::Edit::Attributes::Category, "Audio")
                        ->Attribute(AZ::Edit::Attributes::Icon, "Icons/Components/AudioProxy.svg")
                        ->Attribute(AZ::Edit::Attributes::ViewportIcon, "Icons/Components/Viewport/AudioProxy.svg")
                        ->Attribute(AZ::Edit::Attributes::AppearsInAddComponentMenu, AZ_CRC_CE("Game"))
                        ->Attribute(AZ::Edit::Attributes::AddableByUser, true)
                        ->Attribute(AZ::Edit::Attributes::HelpPageURL, "https://o3de.org/docs/user-guide/components/reference/audio/proxy/")
                    ;
            }
        }
    }

    //=========================================================================
    void AudioProxyComponent::Activate()
    {
        AZ_Assert(!m_audioProxy, "AudioProxyComponent::Activate - Audio Proxy has been set already!");
        if (auto audioSystem = AZ::Interface<Audio::IAudioSystem>::Get(); audioSystem != nullptr)
        {
            m_audioProxy = audioSystem->GetAudioProxy();
        }

        if (m_audioProxy)
        {
            AZStd::string proxyName = AZStd::string::format("%s_audioproxy", GetEntity()->GetName().c_str());
            m_audioProxy->Initialize(proxyName.c_str(), reinterpret_cast<void*>(static_cast<uintptr_t>(static_cast<AZ::u64>(GetEntityId()))));
            m_audioProxy->SetObstructionCalcType(Audio::ObstructionType::Ignore);

            // don't need to set position on the proxy now, but initialize the transform from the entity.
            AZ::TransformBus::EventResult(m_transform, GetEntityId(), &AZ::TransformBus::Events::GetWorldTM);

            AudioProxyComponentRequestBus::Handler::BusConnect(GetEntityId());
            AZ::TransformNotificationBus::Handler::BusConnect(GetEntityId());
        }
    }

    //=========================================================================
    void AudioProxyComponent::Deactivate()
    {
        if (m_audioProxy)
        {
            AZ::TransformNotificationBus::Handler::BusDisconnect(GetEntityId());
            AudioProxyComponentRequestBus::Handler::BusDisconnect(GetEntityId());

            m_audioProxy->StopAllTriggers();
            m_audioProxy->Release();
            m_audioProxy = nullptr;
        }
    }

    //=========================================================================
    void AudioProxyComponent::OnTransformChanged(const AZ::Transform& /*local*/, const AZ::Transform& world)
    {
        m_transform = world;
        if (m_tracksEntityPosition)
        {
            m_audioProxy->SetPosition(m_transform);
        }
    }

    //=========================================================================
    bool AudioProxyComponent::ExecuteTrigger(const Audio::TAudioControlID triggerID)
    {
        if (triggerID != INVALID_AUDIO_CONTROL_ID)
        {
            // set the position at the Entity's current location.
            // need to poll in case we haven't hit a transform update yet.
            m_audioProxy->SetPosition(m_transform);

            // ...and kick it off...
            m_audioProxy->ExecuteTrigger(triggerID);
            return true;
        }

        return false;
    }

    //=========================================================================
    bool AudioProxyComponent::ExecuteSourceTrigger(const Audio::TAudioControlID triggerID, const Audio::SAudioSourceInfo& sourceInfo)
    {
        if (triggerID != INVALID_AUDIO_CONTROL_ID)
        {
            // set the position at the Entity's current location.
            // need to poll in case we haven't hit a transform update yet.
            m_audioProxy->SetPosition(m_transform);

            // ...and kick it off...
            m_audioProxy->ExecuteSourceTrigger(triggerID, sourceInfo);
            return true;
        }

        return false;
    }

    //=========================================================================
    void AudioProxyComponent::KillTrigger(const Audio::TAudioControlID triggerID)
    {
        m_audioProxy->StopTrigger(triggerID);
    }

    //=========================================================================
    void AudioProxyComponent::KillAllTriggers()
    {
        m_audioProxy->StopAllTriggers();
    }

    //=========================================================================
    void AudioProxyComponent::SetRtpcValue(const Audio::TAudioControlID rtpcID, float value)
    {
        m_audioProxy->SetRtpcValue(rtpcID, value);
    }

    //=========================================================================
    void AudioProxyComponent::SetSwitchState(const Audio::TAudioControlID switchID, const Audio::TAudioSwitchStateID stateID)
    {
        m_audioProxy->SetSwitchState(switchID, stateID);
    }

    //=========================================================================
    void AudioProxyComponent::SetEnvironmentAmount(const Audio::TAudioEnvironmentID environmentID, float amount)
    {
        m_audioProxy->SetEnvironmentAmount(environmentID, amount);
    }

    //=========================================================================
    void AudioProxyComponent::SetObstructionCalcType(const Audio::ObstructionType type)
    {
        m_audioProxy->SetObstructionCalcType(type);
    }

    //=========================================================================
    void AudioProxyComponent::SetPosition(const Audio::SATLWorldPosition& position)
    {
        m_audioProxy->SetPosition(position);
    }

    //=========================================================================
    void AudioProxyComponent::SetMultiplePositions(const Audio::MultiPositionParams& params)
    {
        m_audioProxy->SetMultiplePositions(params);
    }

} // namespace LmbrCentral