redgpu/ezEngine: An open source C++ game engine.

Code/EnginePlugins/FmodPlugin/FmodStartup.cpp
196 строк6 KB
Jan Krassnigg
Moved config files needed at runtime into dedicated sub-folder (#891)
14 мар 2023, 22:04
14 мар 2023, 22:04d6a0f3f
#include <FmodPlugin/FmodPluginPCH.h>

#include <FmodPlugin/FmodIncludes.h>
#include <FmodPlugin/FmodSingleton.h>
#include <FmodPlugin/Resources/FmodSoundBankResource.h>
#include <FmodPlugin/Resources/FmodSoundEventResource.h>
#include <Foundation/Configuration/Startup.h>
#include <Foundation/IO/FileSystem/FileReader.h>
#include <Foundation/IO/FileSystem/FileWriter.h>
#include <Foundation/IO/OpenDdlReader.h>
#include <Foundation/IO/OpenDdlUtils.h>
#include <Foundation/IO/OpenDdlWriter.h>
#include <GameEngine/GameApplication/GameApplication.h>

static ezFmodSoundBankResourceLoader s_SoundBankResourceLoader;
static ezFmodSoundEventResourceLoader s_SoundEventResourceLoader;

// clang-format off
EZ_BEGIN_SUBSYSTEM_DECLARATION(Fmod, FmodPlugin)

  BEGIN_SUBSYSTEM_DEPENDENCIES
    "Foundation",
    "Core"
  END_SUBSYSTEM_DEPENDENCIES

  ON_CORESYSTEMS_STARTUP
  {
  }

  ON_CORESYSTEMS_SHUTDOWN
  {
  }

  ON_HIGHLEVELSYSTEMS_STARTUP
  {
    ezResourceManager::SetResourceTypeLoader<ezFmodSoundBankResource>(&s_SoundBankResourceLoader);
    ezResourceManager::SetResourceTypeLoader<ezFmodSoundEventResource>(&s_SoundEventResourceLoader);

    ezResourceManager::RegisterResourceForAssetType("Sound Bank", ezGetStaticRTTI<ezFmodSoundBankResource>());
    ezResourceManager::RegisterResourceForAssetType("Sound Event", ezGetStaticRTTI<ezFmodSoundEventResource>());

    {
      ezFmodSoundEventResourceDescriptor desc;
      ezFmodSoundEventResourceHandle hResource = ezResourceManager::CreateResource<ezFmodSoundEventResource>("FmodEventMissing", std::move(desc), "Fallback for missing sound event");
      ezResourceManager::SetResourceTypeMissingFallback<ezFmodSoundEventResource>(hResource);
    }

    {
      ezFmodSoundBankResourceDescriptor desc;
      ezFmodSoundBankResourceHandle hResource = ezResourceManager::CreateResource<ezFmodSoundBankResource>("FmodBankMissing", std::move(desc), "Fallback for missing sound bank");
      ezResourceManager::SetResourceTypeMissingFallback<ezFmodSoundBankResource>(hResource);
    }

    ezGameApplicationBase::GetGameApplicationBaseInstance()->m_ExecutionEvents.AddEventHandler(&ezFmod::GameApplicationEventHandler);

    ezFmod::GetSingleton()->Startup();
  }

  ON_HIGHLEVELSYSTEMS_SHUTDOWN
  {
    ezGameApplicationBase::GetGameApplicationBaseInstance()->m_ExecutionEvents.RemoveEventHandler(&ezFmod::GameApplicationEventHandler);

    ezFmod::GetSingleton()->Shutdown();
    ezResourceManager::SetResourceTypeLoader<ezFmodSoundBankResource>(nullptr);
    ezResourceManager::SetResourceTypeLoader<ezFmodSoundEventResource>(nullptr);

    ezFmodSoundEventResource::CleanupDynamicPluginReferences();
    ezFmodSoundBankResource::CleanupDynamicPluginReferences();
  }

EZ_END_SUBSYSTEM_DECLARATION;
// clang-format on

void ezFmodConfiguration::Save(ezOpenDdlWriter& ref_ddl) const
{
  ezOpenDdlUtils::StoreString(ref_ddl, m_sMasterSoundBank, "MasterBank");
  ezOpenDdlUtils::StoreUInt16(ref_ddl, m_uiVirtualChannels, "VirtualChannels");
  ezOpenDdlUtils::StoreUInt32(ref_ddl, m_uiSamplerRate, "SamplerRate");

  switch (m_SpeakerMode)
  {
    case ezFmodSpeakerMode::ModeStereo:
      ezOpenDdlUtils::StoreString(ref_ddl, "Stereo", "Mode");
      break;
    case ezFmodSpeakerMode::Mode5Point1:
      ezOpenDdlUtils::StoreString(ref_ddl, "5.1", "Mode");
      break;
    case ezFmodSpeakerMode::Mode7Point1:
      ezOpenDdlUtils::StoreString(ref_ddl, "7.1", "Mode");
      break;
  }
}

void ezFmodConfiguration::Load(const ezOpenDdlReaderElement& ddl)
{
  if (const ezOpenDdlReaderElement* pElement = ddl.FindChildOfType(ezOpenDdlPrimitiveType::String, "MasterBank"))
  {
    m_sMasterSoundBank = pElement->GetPrimitivesString()[0];
  }

  if (const ezOpenDdlReaderElement* pElement = ddl.FindChildOfType(ezOpenDdlPrimitiveType::UInt16, "VirtualChannels"))
  {
    m_uiVirtualChannels = pElement->GetPrimitivesUInt16()[0];
  }

  if (const ezOpenDdlReaderElement* pElement = ddl.FindChildOfType(ezOpenDdlPrimitiveType::UInt32, "SamplerRate"))
  {
    m_uiSamplerRate = pElement->GetPrimitivesUInt32()[0];
  }

  if (const ezOpenDdlReaderElement* pElement = ddl.FindChildOfType(ezOpenDdlPrimitiveType::String, "Mode"))
  {
    auto mode = pElement->GetPrimitivesString()[0];

    if (mode == "Stereo")
      m_SpeakerMode = ezFmodSpeakerMode::ModeStereo;
    else if (mode == "7.1")
      m_SpeakerMode = ezFmodSpeakerMode::Mode7Point1;
    else
      m_SpeakerMode = ezFmodSpeakerMode::Mode5Point1;
  }
}

bool ezFmodConfiguration::operator==(const ezFmodConfiguration& rhs) const
{
  if (m_sMasterSoundBank != rhs.m_sMasterSoundBank)
    return false;
  if (m_uiVirtualChannels != rhs.m_uiVirtualChannels)
    return false;
  if (m_uiSamplerRate != rhs.m_uiSamplerRate)
    return false;
  if (m_SpeakerMode != rhs.m_SpeakerMode)
    return false;

  return true;
}

ezResult ezFmodAssetProfiles::Save(ezStringView sFile) const
{
  ezFileWriter file;
  EZ_SUCCEED_OR_RETURN(file.Open(sFile));

  ezOpenDdlWriter ddl;
  ddl.SetOutputStream(&file);

  for (auto it = m_AssetProfiles.GetIterator(); it.IsValid(); ++it)
  {
    if (!it.Key().IsEmpty())
    {
      ddl.BeginObject("Platform", it.Key());

      it.Value().Save(ddl);

      ddl.EndObject();
    }
  }

  return EZ_SUCCESS;
}

ezResult ezFmodAssetProfiles::Load(ezStringView sFile)
{
  m_AssetProfiles.Clear();

#if EZ_ENABLED(EZ_MIGRATE_RUNTIMECONFIGS)
  if (sFile == s_sConfigFile)
  {
    sFile = ezFileSystem::MigrateFileLocation(":project/FmodConfig.ddl", s_sConfigFile);
  }
#endif

  ezFileReader file;
  EZ_SUCCEED_OR_RETURN(file.Open(sFile));

  ezOpenDdlReader ddl;
  EZ_SUCCEED_OR_RETURN(ddl.ParseDocument(file));

  const ezOpenDdlReaderElement* pRoot = ddl.GetRootElement();
  const ezOpenDdlReaderElement* pChild = pRoot->GetFirstChild();

  while (pChild)
  {
    if (pChild->IsCustomType("Platform") && pChild->HasName())
    {
      auto& cfg = m_AssetProfiles[pChild->GetName()];

      cfg.Load(*pChild);
    }

    pChild = pChild->GetSibling();
  }

  return EZ_SUCCESS;
}

EZ_STATICLINK_FILE(FmodPlugin, FmodPlugin_FmodStartup);