tetrees/Plugins/Wwise/Source/WwiseUtils/Private/WwiseUnrealHelper.cpp

/*******************************************************************************
The content of this file includes portions of the proprietary AUDIOKINETIC Wwise
Technology released in source code form as part of the game integration package.
The content of this file may not be used without valid licenses to the
AUDIOKINETIC Wwise Technology.
Note that the use of the game engine is subject to the Unreal(R) Engine End User
License Agreement at https://www.unrealengine.com/en-US/eula/unreal
 
License Usage
 
Licensees holding valid licenses to the AUDIOKINETIC Wwise Technology may use
this file in accordance with the end user license agreement provided with the
software or, alternatively, in accordance with the terms contained
in a written agreement between you and Audiokinetic Inc.
Copyright (c) 2023 Audiokinetic Inc.
*******************************************************************************/

#include "WwiseUnrealHelper.h"

#include "Misc/Guid.h"
#include "Misc/Paths.h"
#include "Wwise/Stats/Global.h"

namespace WwiseUnrealHelper
{
	const TCHAR* MediaFolderName = TEXT("Media");
	const TCHAR* ExternalSourceFolderName = TEXT("ExternalSources");
	constexpr auto SoundBankNamePrefix = TEXT("SB_");
	const FGuid InitBankID(0x701ECBBD, 0x9C7B4030, 0x8CDB749E, 0xE5D1C7B9);

	FString(*GetWwisePluginDirectoryPtr)();
	FString(*GetWwiseProjectPathPtr)();
	FString(*GetSoundBankDirectoryPtr)();
	FString(*GetStagePathPtr)();
	
	void SetHelperFunctions(FString(* GetWwisePluginDirectoryImpl)(), FString(* GetWwiseProjectPathImpl)(),
		FString(* GetSoundBankDirectoryImpl)(), FString(* GetStagePathImpl)())
	{
		GetWwisePluginDirectoryPtr = GetWwisePluginDirectoryImpl;
		GetWwiseProjectPathPtr = GetWwiseProjectPathImpl;
		GetSoundBankDirectoryPtr = GetSoundBankDirectoryImpl;
		GetStagePathPtr = GetStagePathImpl;
	}

	FString GetWwisePluginDirectory()
	{
		if (!GetWwisePluginDirectoryPtr)
		{
			UE_LOG(LogWwiseUtils, Error, TEXT("WwiseUnrealHelper::GetWwisePluginDirectory implementation not set."));
			return {};
		}	
		return GetWwisePluginDirectoryPtr();
	}

	FString GetWwiseProjectPath()
	{
		if (!GetWwiseProjectPathPtr)
		{
			UE_LOG(LogWwiseUtils, Error, TEXT("WwiseUnrealHelper::GetWwiseProjectPath implementation not set."));
			return {};
		}	
		return GetWwiseProjectPathPtr();
	}

	FString GetSoundBankDirectory()
	{
		if (!GetSoundBankDirectoryPtr)
		{
			UE_LOG(LogWwiseUtils, Error, TEXT("WwiseUnrealHelper::GetSoundBankDirectory implementation not set."));
			return {};
		}	
		return GetSoundBankDirectoryPtr();
	}

	FString GetStagePath()
	{
		if (!GetStagePathPtr)
		{
			UE_LOG(LogWwiseUtils, Error, TEXT("WwiseUnrealHelper::GetStagePath implementation not set."));
			return {};
		}	
		return GetStagePathPtr();
	}

	void TrimPath(FString& Path)
	{
		Path.TrimStartAndEndInline();
	}

	FString GetProjectDirectory()
	{
		return FPaths::ConvertRelativePathToFull(FPaths::ProjectDir());
	}

	FString GetContentDirectory()
	{
		return FPaths::ConvertRelativePathToFull(FPaths::ProjectContentDir());
	}

	FString GetThirdPartyDirectory()
	{
		return FPaths::Combine(GetWwisePluginDirectory(), TEXT("ThirdParty"));
	}

	FString GetExternalSourceDirectory()
	{
		return FPaths::Combine(GetSoundBankDirectory(), ExternalSourceFolderName);
	}

	FString GetWwiseProjectDirectoryPath()
	{
		return FPaths::GetPath(GetWwiseProjectPath()) + TEXT("/");
	}

	bool MakePathRelativeToWwiseProject(FString& AbsolutePath)
	{

		auto wwiseProjectRoot = WwiseUnrealHelper::GetWwiseProjectDirectoryPath();
#if PLATFORM_WINDOWS
		AbsolutePath.ReplaceInline(TEXT("/"), TEXT("\\"));
		wwiseProjectRoot.ReplaceInline(TEXT("/"), TEXT("\\"));
#endif
		bool success = FPaths::MakePathRelativeTo(AbsolutePath, *wwiseProjectRoot);
#if PLATFORM_WINDOWS
		AbsolutePath.ReplaceInline(TEXT("/"), TEXT("\\"));
#endif
		return success;
	}

	FString GetWwiseSoundBankInfoCachePath()
	{
		return FPaths::Combine(FPaths::GetPath(GetWwiseProjectPath()), TEXT(".cache"), TEXT("SoundBankInfoCache.dat"));
	}

#if WITH_EDITOR
	FString GuidToBankName(const FGuid& Guid)
	{
		if (Guid == InitBankID)
		{
			return TEXT("Init");
		}

		return FString(SoundBankNamePrefix) + Guid.ToString(EGuidFormats::Digits);
	}

	FGuid BankNameToGuid(const FString& BankName)
	{
		FString copy = BankName;
		copy.RemoveFromStart(SoundBankNamePrefix);

		FGuid result;
		FGuid::ParseExact(copy, EGuidFormats::Digits, result);

		return result;
	}

	FString FormatFolderPath(const FString folderPath)
	{
		auto path = folderPath.Replace(TEXT("\\"), TEXT("/"));
		if (path[0] == '/') {
			path.RemoveAt(0);
		}
		return path;
	}
#endif
}