// Copyright Epic Games, Inc. All Rights Reserved. #pragma once #include "CoreMinimal.h" #include "MetasoundBasicNode.h" #include "MetasoundBuilderInterface.h" #include "MetasoundBuildError.h" #include "MetasoundNodeInterface.h" #include "MetasoundNodeRegistrationMacro.h" #include "MetasoundOperatorInterface.h" #include "MetasoundDataFactory.h" #include "MetasoundDataReference.h" #include "MetasoundExecutableOperator.h" #include "MetasoundFrontend.h" #include "MetasoundFrontendNodesCategories.h" #include "MetasoundVertex.h" #include namespace Metasound { namespace AutoConverterNodePrivate { struct FConvertDataTypeInfo { FName FromDataTypeName; FText FromDataTypeText; FName ToDataTypeName; FText ToDataTypeText; bool bIsFromEnum; bool bIsToEnum; }; METASOUNDFRONTEND_API FVertexName GetInputName(const FConvertDataTypeInfo& InInfo); METASOUNDFRONTEND_API FVertexName GetOutputName(const FConvertDataTypeInfo& InInfo); METASOUNDFRONTEND_API FVertexInterface CreateVertexInterface(const FConvertDataTypeInfo& InInfo); METASOUNDFRONTEND_API FNodeClassMetadata CreateAutoConverterNodeMetadata(const FConvertDataTypeInfo& InInfo); } // Determines whether an auto converter node will be registered to convert // between two types. template struct TIsAutoConvertible { static constexpr bool bIsConvertible = std::is_convertible::value; // Handle case of converting enums to/from integers. static constexpr bool bIsIntToEnumConversion = std::is_same::value && TEnumTraits::bIsEnum; static constexpr bool bIsEnumToIntConversion = TEnumTraits::bIsEnum && std::is_same::value; static constexpr bool Value = bIsConvertible || bIsIntToEnumConversion || bIsEnumToIntConversion; }; // This convenience node can be registered and will invoke static_cast(FromDataType) every time it is executed, // with a special case for enum <-> int32 conversions. template class TAutoConverterNode : public FBasicNode { static_assert(TIsAutoConvertible::Value, "Tried to create an auto converter node between two types we can't static_cast between."); static AutoConverterNodePrivate::FConvertDataTypeInfo GetConverterDataTypeInfo() { return AutoConverterNodePrivate::FConvertDataTypeInfo { GetMetasoundDataTypeName(), GetMetasoundDataTypeDisplayText(), GetMetasoundDataTypeName(), GetMetasoundDataTypeDisplayText(), TEnumTraits::bIsEnum, TEnumTraits::bIsEnum }; } public: static const FVertexName& GetInputName() { static const FVertexName InputName = GetMetasoundDataTypeName(); return InputName; } static const FVertexName& GetOutputName() { static const FVertexName OutputName = GetMetasoundDataTypeName(); return OutputName; } static FVertexInterface DeclareVertexInterface() { using namespace AutoConverterNodePrivate; return CreateVertexInterface(GetConverterDataTypeInfo()); } static const FNodeClassMetadata& GetAutoConverterNodeMetadata() { using namespace AutoConverterNodePrivate; static const FNodeClassMetadata Info = CreateAutoConverterNodeMetadata(GetConverterDataTypeInfo()); return Info; } private: /** FConverterOperator converts from "FromDataType" to "ToDataType" using * a implicit conversion operators. */ class FConverterOperator : public TExecutableOperator { public: FConverterOperator(TDataReadReference InFromDataReference, TDataWriteReference InToDataReference) : FromData(InFromDataReference) , ToData(InToDataReference) { Execute(); } virtual ~FConverterOperator() {} virtual void BindInputs(FInputVertexInterfaceData& InVertexData) override { InVertexData.BindReadVertex(GetInputName(), FromData); } virtual void BindOutputs(FOutputVertexInterfaceData& InVertexData) override { InVertexData.BindReadVertex(GetOutputName(), ToData); } void Execute() { // enum -> int32 if constexpr (TIsAutoConvertible::bIsEnumToIntConversion) { // Convert from enum wrapper to inner enum type, then to int typename TEnumTraits::InnerType InnerEnum = static_cast::InnerType>(*FromData); *ToData = static_cast(InnerEnum); } // int32 -> enum else if constexpr (TIsAutoConvertible::bIsIntToEnumConversion) { const int32 FromInt = *FromData; // Convert from int to inner enum type typename TEnumTraits::InnerType InnerEnum = static_cast::InnerType>(FromInt); // Update tracking for previous int value we tried to convert, used to prevent log spam if it's an invalid enum value if (FromInt != PreviousIntValueForEnumConversion) { PreviousIntValueForEnumConversion = FromInt; bHasLoggedInvalidEnum = false; } // If int value is invalid for this enum, return enum default value TOptional EnumName = ToDataType::ToName(InnerEnum); if (!EnumName.IsSet()) { if (!bHasLoggedInvalidEnum) { UE_LOG(LogMetaSound, Warning, TEXT("Cannot convert int32 value '%d' to enum type '%s'. No valid corresponding enum value exists, so returning enum default value instead."), FromInt, *GetMetasoundDataTypeDisplayText().ToString()); bHasLoggedInvalidEnum = true; } *ToData = static_cast(TEnumTraits::DefaultValue); } else { // Convert from inner enum type to int *ToData = static_cast(InnerEnum); } } else { *ToData = static_cast(*FromData); } } void Reset(const IOperator::FResetParams& InParams) { PreviousIntValueForEnumConversion = 0; bHasLoggedInvalidEnum = false; Execute(); } private: TDataReadReference FromData; TDataWriteReference ToData; // To prevent log spam, keep track of whether we've logged an invalid enum value being converted already // and the previous int value (need both bool and int for the initial case) bool bHasLoggedInvalidEnum = false; int32 PreviousIntValueForEnumConversion = 0; }; /** FConverterOperatorFactory creates an operator which converts from * "FromDataType" to "ToDataType". */ class FCoverterOperatorFactory : public IOperatorFactory { public: FCoverterOperatorFactory() = default; virtual TUniquePtr CreateOperator(const FBuildOperatorParams& InParams, FBuildResults& OutResults) override { TDataWriteReference WriteReference = TDataWriteReferenceFactory::CreateExplicitArgs(InParams.OperatorSettings); TDataReadReference ReadReference = InParams.InputData.GetOrCreateDefaultDataReadReference(GetInputName(), InParams.OperatorSettings); return MakeUnique(MoveTemp(ReadReference), MoveTemp(WriteReference)); } }; public: TAutoConverterNode(const FNodeInitData& InInitData) : TAutoConverterNode(FNodeData(InInitData.InstanceName, InInitData.InstanceID, DeclareVertexInterface()), MakeShared(GetAutoConverterNodeMetadata())) { } TAutoConverterNode(FNodeData InNodeData, TSharedRef InClassMetadata) : FBasicNode(MoveTemp(InNodeData), MoveTemp(InClassMetadata)) , Factory(MakeOperatorFactoryRef()) { } virtual ~TAutoConverterNode() = default; virtual FOperatorFactorySharedRef GetDefaultOperatorFactory() const override { return Factory; } private: FOperatorFactorySharedRef Factory; }; } // namespace Metasound