Files
UnrealEngineUWP/Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Private/MetasoundSettings.cpp
rob gay 4f7ee4c0bb Update MetaSound cook to strip unsupported MetaSound platform page data
#jira UE-193186, UE-194160
#rb phil.popp, helen.yang
#rnx
[FYI] sondra.moyls, jon.huller

[CL 35783577 by rob gay in ue5-main branch]
2024-08-23 17:27:50 -04:00

426 lines
12 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#include "MetasoundSettings.h"
#include "Algo/Count.h"
#include "HAL/IConsoleManager.h"
#include "MetasoundFrontendDocument.h"
#define LOCTEXT_NAMESPACE "MetaSound"
namespace Metasound::SettingsPrivate
{
#if WITH_EDITOR
template<typename SettingsStructType>
TSet<FName> GetStructNames(const TArray<SettingsStructType>& InSettings, int32 IgnoreIndex = INDEX_NONE)
{
TSet<FName> Names;
for (int32 Index = 0; Index < InSettings.Num(); ++Index)
{
if (Index != IgnoreIndex)
{
Names.Add(InSettings[Index].Name);
}
}
return Names;
}
/** Generate new name for the item. **/
static FName GenerateUniqueName(const TSet<FName>& Names, const TCHAR* InBaseName)
{
FString NewName = InBaseName;
for (int32 Postfix = 1; Names.Contains(*NewName); ++Postfix)
{
NewName = FString::Format(TEXT("{0}_{1}"), { InBaseName, Postfix });
}
return FName(*NewName);
}
template<typename SettingsStructType>
void OnCreateNewSettingsStruct(const TArray<SettingsStructType>& InSettings, const FString& InBaseName, SettingsStructType& OutNewItem)
{
const TSet<FName> Names = GetStructNames(InSettings);
OutNewItem.Name = GenerateUniqueName(Names, *InBaseName);
OutNewItem.UniqueId = FGuid::NewGuid();
}
template<typename SettingsStructType>
void OnRenameSettingsStruct(const TArray<SettingsStructType>& InSettings, int32 Index, const FString& InBaseName, SettingsStructType& OutRenamed)
{
if (OutRenamed.Name.IsNone())
{
const TSet<FName> Names = GetStructNames(InSettings);
OutRenamed.Name = GenerateUniqueName(Names, *InBaseName);
}
else
{
const TSet<FName> Names = GetStructNames(InSettings, Index);
if (Names.Contains(OutRenamed.Name))
{
OutRenamed.Name = GenerateUniqueName(Names, *OutRenamed.Name.ToString());
}
}
}
#endif // WITH_EDITOR
template<typename SettingsStructType>
const SettingsStructType* FindSettingsStruct(const TArray<SettingsStructType>& Settings, const FGuid& InUniqueID)
{
auto MatchesIDPredicate = [&InUniqueID](const SettingsStructType& Struct) { return Struct.UniqueId == InUniqueID; };
return Settings.FindByPredicate(MatchesIDPredicate);
}
template<typename SettingsStructType>
const SettingsStructType* FindSettingsStruct(const TArray<SettingsStructType>& Settings, FName Name)
{
auto MatchesNamePredicate = [Name](const SettingsStructType& Struct) { return Struct.Name == Name; };
return Settings.FindByPredicate(MatchesNamePredicate);
}
#if WITH_EDITOR
template<typename SettingsStructType>
void PostEditChainChangedStructMember(FPropertyChangedChainEvent& PostEditChangeChainProperty, TArray<SettingsStructType>& StructSettings, FName PropertyName, const FString& NewItemName)
{
const int32 ItemIndex = PostEditChangeChainProperty.GetArrayIndex(PropertyName.ToString());
if (TDoubleLinkedList<FProperty*>::TDoubleLinkedListNode* HeadNode = PostEditChangeChainProperty.PropertyChain.GetHead())
{
const FProperty* Prop = HeadNode->GetValue();
if (Prop->GetName() != PropertyName)
{
return;
}
}
// Item changed..
if (ItemIndex != INDEX_NONE && StructSettings.IsValidIndex(ItemIndex))
{
SettingsStructType& Item = StructSettings[ItemIndex];
if (PostEditChangeChainProperty.GetPropertyName() == "Name")
{
OnRenameSettingsStruct<SettingsStructType>(StructSettings, ItemIndex, NewItemName, Item);
}
else if (PostEditChangeChainProperty.GetPropertyName() == PropertyName)
{
// Array change add or duplicate
if (PostEditChangeChainProperty.ChangeType == EPropertyChangeType::ArrayAdd
|| PostEditChangeChainProperty.ChangeType == EPropertyChangeType::Duplicate)
{
OnCreateNewSettingsStruct<SettingsStructType>(StructSettings, NewItemName, Item);
}
}
}
// Handle pasting separately as we might not have a valid index in the case of pasting when array is empty.
if (PostEditChangeChainProperty.GetPropertyName() == PropertyName)
{
// Paste...
if (PostEditChangeChainProperty.ChangeType == EPropertyChangeType::ValueSet)
{
const int32 IndexOfPastedItem = ItemIndex != INDEX_NONE ? ItemIndex : 0;
if (StructSettings.IsValidIndex(IndexOfPastedItem))
{
SettingsStructType& Item = StructSettings[IndexOfPastedItem];
OnCreateNewSettingsStruct<SettingsStructType>(StructSettings, NewItemName, Item);
}
}
}
}
#endif // WITH_EDITOR
} // namespace Metasound::SettingsPrivate
#if WITH_EDITOR
bool FMetaSoundPageSettings::ExcludePageFromCook(FName PlatformName) const
{
if (PlatformCanTargetPage(PlatformName))
{
return false;
}
return Exclude.GetValueForPlatform(PlatformName);
}
TArray<FName> FMetaSoundPageSettings::GetImplementedPlatforms() const
{
TArray<FName> PlatformNames;
Target.PerPlatform.GetKeys(PlatformNames);
return PlatformNames;
}
bool FMetaSoundPageSettings::PlatformCanTargetPage(FName PlatformName) const
{
const bool bIsTargeted = Target.GetValueForPlatform(PlatformName);
return bIsTargeted;
}
void UMetaSoundSettings::ConformPageSettings(bool bNotifyDefaultRenamed)
{
using namespace Metasound;
bool bTargetFound = false;
bool bDefaultRenamed = false;
for (int32 Index = PageSettings.Num() - 1; Index >= 0; --Index)
{
FMetaSoundPageSettings& Page = PageSettings[Index];
const bool bIsDefaultName = Page.Name == Frontend::DefaultPageName;
if (bIsDefaultName)
{
const TSet<FName> PageNames(GetPageNames());
Page.Name = SettingsPrivate::GenerateUniqueName(PageNames, *Page.Name.ToString());
bDefaultRenamed = true;
}
bTargetFound |= TargetPageName == Page.Name;
}
DefaultPageSettings.Target = PageSettings.IsEmpty();
if (DefaultPageSettings.Target.GetValue())
{
TargetPageName = DefaultPageSettings.Name;
}
else
{
if (!bTargetFound)
{
TargetPageName = PageSettings.Last().Name;
}
}
#if WITH_EDITORONLY_DATA
{
FScopeLock Lock(&CookPlatformTargetCritSec);
CookPlatformTargetPageIDs.Reset();
CookPlatformTargetPage = { };
}
#endif // WITH_EDITORONLY_DATA
TargetPageNameOverride.Reset();
if (bNotifyDefaultRenamed && bDefaultRenamed)
{
OnDefaultRenamed.Broadcast();
}
}
#endif // WITH_EDITOR
const FMetaSoundPageSettings* UMetaSoundSettings::FindPageSettings(FName Name) const
{
if (Name == Metasound::Frontend::DefaultPageName)
{
return &GetDefaultPageSettings();
}
return Metasound::SettingsPrivate::FindSettingsStruct(PageSettings, Name);
}
const FMetaSoundPageSettings* UMetaSoundSettings::FindPageSettings(const FGuid& InPageID) const
{
if (InPageID == Metasound::Frontend::DefaultPageID)
{
return &GetDefaultPageSettings();
}
return Metasound::SettingsPrivate::FindSettingsStruct(PageSettings, InPageID);
}
const FMetaSoundQualitySettings* UMetaSoundSettings::FindQualitySettings(FName Name) const
{
return Metasound::SettingsPrivate::FindSettingsStruct(QualitySettings, Name);
}
const FMetaSoundQualitySettings* UMetaSoundSettings::FindQualitySettings(const FGuid& InQualityID) const
{
return Metasound::SettingsPrivate::FindSettingsStruct(QualitySettings, InQualityID);
}
const FMetaSoundPageSettings& UMetaSoundSettings::GetDefaultPageSettings() const
{
return DefaultPageSettings;
}
#if WITH_EDITOR
TArray<FName> UMetaSoundSettings::GetImplementedPagePlatforms() const
{
TSet<FName> PlatformNames { FPlatformProperties::IniPlatformName() };
IteratePageSettings([&](const FMetaSoundPageSettings& PageSettings)
{
TArray<FName> PagePlatforms = PageSettings.GetImplementedPlatforms();
PlatformNames.Append(MoveTemp(PagePlatforms));
});
return PlatformNames.Array();
}
#endif // WITH_EDITOR
#if WITH_EDITORONLY_DATA
const TArray<FGuid>& UMetaSoundSettings::GetCookedTargetPageIDs(FName PlatformName) const
{
FScopeLock Lock(&CookPlatformTargetCritSec);
if (PlatformName != CookPlatformTargetPage)
{
CookPlatformTargetPage = PlatformName;
CookPlatformTargetPageIDs.Reset();
Algo::TransformIf(PageSettings, CookPlatformTargetPageIDs,
[&PlatformName](const FMetaSoundPageSettings& PageSetting)
{
#if WITH_EDITOR
return PageSetting.PlatformCanTargetPage(PlatformName);
#else // !WITH_EDITOR
return true;
#endif // !WITH_EDITOR
},
[](const FMetaSoundPageSettings& PageSetting)
{
return PageSetting.UniqueId;
});
}
return CookPlatformTargetPageIDs;
}
#endif // WITH_EDITORONLY_DATA
const FMetaSoundPageSettings& UMetaSoundSettings::GetTargetPageSettings() const
{
const FName TargetPage = TargetPageNameOverride.IsSet() ? *TargetPageNameOverride : TargetPageName;
if (const FMetaSoundPageSettings* TargetSettings = FindPageSettings(TargetPage))
{
if (TargetSettings->Target.GetValue())
{
return *TargetSettings;
}
}
for (const FMetaSoundPageSettings& Setting : PageSettings)
{
if (Setting.Target.GetValue())
{
return Setting;
}
}
return DefaultPageSettings;
}
#if WITH_EDITOR
void UMetaSoundSettings::PostEditChangeChainProperty(FPropertyChangedChainEvent& PostEditChangeChainProperty)
{
using namespace Metasound::SettingsPrivate;
PostEditChainChangedStructMember(PostEditChangeChainProperty, PageSettings, GetPageSettingPropertyName(), TEXT("New Page"));
PostEditChainChangedStructMember(PostEditChangeChainProperty, QualitySettings, GetQualitySettingPropertyName(), TEXT("New Quality"));
constexpr bool bNotifyDefaultRenamed = true;
ConformPageSettings(bNotifyDefaultRenamed);
Super::PostEditChangeChainProperty(PostEditChangeChainProperty);
}
void UMetaSoundSettings::PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent)
{
Super::PostEditChangeProperty(PropertyChangedEvent);
constexpr bool bNotifyDefaultRenamed = true;
ConformPageSettings(bNotifyDefaultRenamed);
if (PropertyChangedEvent.MemberProperty->GetName() == GetPageSettingPropertyName())
{
OnPageSettingsUpdated.Broadcast();
}
DenyListCacheChangeID++;
}
void UMetaSoundSettings::PostInitProperties()
{
Super::PostInitProperties();
}
#endif // WITH_EDITOR
bool UMetaSoundSettings::SetTargetPage(FName PageName)
{
if (const FMetaSoundPageSettings* PageSetting = FindPageSettings(PageName))
{
if (TargetPageName != PageSetting->Name)
{
if (PageSetting->Target.GetValue())
{
TargetPageNameOverride = PageSetting->Name;
return true;
}
}
}
return false;
}
#if WITH_EDITORONLY_DATA
Metasound::Engine::FOnSettingsDefaultConformed& UMetaSoundSettings::GetOnDefaultRenamedDelegate()
{
return OnDefaultRenamed;
}
Metasound::Engine::FOnPageSettingsUpdated& UMetaSoundSettings::GetOnPageSettingsUpdatedDelegate()
{
return OnPageSettingsUpdated;
}
FName UMetaSoundSettings::GetPageSettingPropertyName()
{
return GET_MEMBER_NAME_CHECKED(UMetaSoundSettings, PageSettings);
}
FName UMetaSoundSettings::GetQualitySettingPropertyName()
{
return GET_MEMBER_NAME_CHECKED(UMetaSoundSettings, QualitySettings);
}
#endif // WITH_EDITORONLY_DATA
#if WITH_EDITOR
TArray<FName> UMetaSoundSettings::GetPageNames()
{
if (const UMetaSoundSettings* Settings = GetDefault<UMetaSoundSettings>())
{
TArray<FName> Names;
Settings->IteratePageSettings([&Names](const FMetaSoundPageSettings& PageSetting)
{
Names.Add(PageSetting.Name);
});
return Names;
}
return { };
}
TArray<FName> UMetaSoundSettings::GetQualityNames()
{
if (const UMetaSoundSettings* Settings = GetDefault<UMetaSoundSettings>())
{
TArray<FName> Names;
auto GetName = [](const FMetaSoundQualitySettings& Quality) { return Quality.Name; };
Algo::Transform(Settings->GetQualitySettings(), Names, GetName);
return Names;
}
return { };
}
#endif // WITH_EDITOR
void UMetaSoundSettings::IteratePageSettings(TFunctionRef<void(const FMetaSoundPageSettings&)> Iter, bool bReverse) const
{
if (bReverse)
{
for (int32 Index = PageSettings.Num() - 1; Index >= 0; --Index)
{
Iter(PageSettings[Index]);
}
Iter(GetDefaultPageSettings());
}
else
{
Iter(GetDefaultPageSettings());
for (const FMetaSoundPageSettings& Setting : PageSettings)
{
Iter(Setting);
}
}
}
#undef LOCTEXT_NAMESPACE // MetaSound