// Copyright Epic Games, Inc. All Rights Reserved. #include "MetasoundNoiseGenerator.h" #include "MetasoundAudioBuffer.h" #include "MetasoundEnumRegistrationMacro.h" #include "MetasoundExecutableOperator.h" #include "MetasoundFacade.h" #include "MetasoundNodeRegistrationMacro.h" #include "MetasoundDataTypeRegistrationMacro.h" #include "MetasoundOperatorSettings.h" #include "MetasoundPrimitives.h" #include "MetasoundStandardNodesNames.h" #include "MetasoundTrigger.h" #include "MetasoundVertex.h" #include "DSP/Noise.h" #include "MetasoundStandardNodesCategories.h" #define LOCTEXT_NAMESPACE "MetasoundStandardNodes_GeneratorNodes" namespace Metasound { enum class ENoiseType { Pink, White }; DECLARE_METASOUND_ENUM(ENoiseType, ENoiseType::Pink, METASOUNDSTANDARDNODES_API, FEnumNoiseType, FEnumNoiseTypeInfo, FEnumNoiseTypeReadRef, FEnumNoiseTypeWriteRef); DEFINE_METASOUND_ENUM_BEGIN(ENoiseType, FEnumNoiseType, "NoiseType") DEFINE_METASOUND_ENUM_ENTRY(ENoiseType::Pink, LOCTEXT("PinkDescription", "Pink Noise"), LOCTEXT("PinkDescriptionTT", "Pink noise or ​1⁄f noise, spectral density is inversely proportional to the frequency of the signal")), DEFINE_METASOUND_ENUM_ENTRY(ENoiseType::White, LOCTEXT("WhiteDescription", "White Noise"), LOCTEXT("WhiteDescriptionTT", "A random signal having equal intensity at different frequencies")), DEFINE_METASOUND_ENUM_END() class FNoiseOperator : public IOperator { public: static constexpr int32 DefaultSeed = INDEX_NONE; static TUniquePtr CreateOperator(const FCreateOperatorParams& InParams, FBuildErrorArray& OutErrors); static const FNodeClassMetadata& GetNodeInfo(); static FVertexInterface DeclareVertexInterface(); FNoiseOperator(const FOperatorSettings& InSettings, FInt32ReadRef&& InReadRef); virtual FDataReferenceCollection GetInputs() const override; virtual FDataReferenceCollection GetOutputs() const override; protected: FInt32ReadRef Seed; FAudioBufferWriteRef Out; int32 OldSeed; template static T MakeGenerator(int32 InSeed) { // If we the default seed, use the default noise generator constructor. if (InSeed == DefaultSeed) { return T{}; } else { return T{ InSeed }; } } template FORCEINLINE void CheckAndReseed(T& InOutGenerator) { // Reseed? int32 NewSeed = *Seed; if (OldSeed != NewSeed) { InOutGenerator = MakeGenerator(NewSeed); OldSeed = NewSeed; } } template FORCEINLINE void Generate(T& InGenerator) { float* WritePtr = Out->GetData(); for (int32 i = Out->Num(); i > 0; --i) { *WritePtr++ = InGenerator.Generate(); } } static constexpr const TCHAR* OutPinName = TEXT("Audio"); static constexpr const TCHAR* TriggerTypePinName = TEXT("Type"); static constexpr const TCHAR* SeedPinName = TEXT("Seed"); }; constexpr int32 FNoiseOperator::DefaultSeed; struct FNoiseOperator_White final : public FNoiseOperator { Audio::FWhiteNoise Generator; FNoiseOperator_White(const FOperatorSettings& InSettings, FInt32ReadRef&& InSeed) : FNoiseOperator{ InSettings, MoveTemp(InSeed) } , Generator{ MakeGenerator(*Seed) } {} void Execute() { // Reseed if necessary. CheckAndReseed(Generator); // Generate a block. Generate(Generator); } static void ExecuteFunction(IOperator* InOperator) { static_cast(InOperator)->Execute(); } FExecuteFunction GetExecuteFunction() override { return &FNoiseOperator_White::ExecuteFunction; } }; struct FNoiseOperator_Pink final : public FNoiseOperator { using FNoiseOperator::FNoiseOperator; Audio::FPinkNoise Generator; FNoiseOperator_Pink(const FOperatorSettings& InSettings, FInt32ReadRef&& InSeed) : FNoiseOperator{ InSettings, MoveTemp(InSeed) } , Generator{ MakeGenerator(*Seed) } {} static void ExecuteFunction(IOperator* InOperator) { static_cast(InOperator)->Execute(); } FExecuteFunction GetExecuteFunction() override { return &FNoiseOperator_Pink::ExecuteFunction; } void Execute() { // Reseed if necessary. CheckAndReseed(Generator); // Generate a block. Generate(Generator); } }; FNoiseOperator::FNoiseOperator(const FOperatorSettings& InSettings, FInt32ReadRef&& InReadRef) : Seed{ MoveTemp(InReadRef) } , Out{ FAudioBufferWriteRef::CreateNew(InSettings) } , OldSeed(*Seed) {} FDataReferenceCollection FNoiseOperator::GetInputs() const { FDataReferenceCollection InputDataReferences; InputDataReferences.AddDataReadReference(SeedPinName, FInt32ReadRef(Seed)); return InputDataReferences; } FDataReferenceCollection FNoiseOperator::GetOutputs() const { FDataReferenceCollection OutputDataReferences; OutputDataReferences.AddDataReadReference(OutPinName, FAudioBufferReadRef(Out)); return OutputDataReferences; } FVertexInterface FNoiseOperator::DeclareVertexInterface() { static const FVertexInterface Interface( FInputVertexInterface( TInputDataVertexModel(SeedPinName, LOCTEXT("SeedPinDescription", "Seed for seeding the Random Number Generator, -1 (default) will use current time"), FNoiseOperator::DefaultSeed), TInputDataVertexModel(TriggerTypePinName, LOCTEXT("NoiseTypeDescription", "Type of Noise to Generate")) ), FOutputVertexInterface( TOutputDataVertexModel(OutPinName, LOCTEXT("AudioOutDescription", "Audio output")) ) ); return Interface; } const FNodeClassMetadata& FNoiseOperator::GetNodeInfo() { auto InitNodeInfo = []() -> FNodeClassMetadata { FNodeClassMetadata Info; Info.ClassName = { StandardNodes::Namespace, TEXT("Noise"), StandardNodes::AudioVariant }; Info.MajorVersion = 1; Info.MinorVersion = 0; Info.DisplayName = LOCTEXT("Metasound_NoiseNodeDisplayNameX", "Noise"); Info.Description = LOCTEXT("Metasound_NoiseNodeDescription", "Noise Generator that produces different types of noise"); Info.Author = PluginAuthor; Info.PromptIfMissing = PluginNodeMissingPrompt; Info.DefaultInterface = DeclareVertexInterface(); Info.CategoryHierarchy.Emplace(NodeCategories::Generators); return Info; }; static const FNodeClassMetadata Info = InitNodeInfo(); return Info; } FNoiseNode::FNoiseNode(const FVertexName& InName, const FGuid& InInstanceID, int32 InDefaultSeed) : FNodeFacade(InName, InInstanceID, TFacadeOperatorClass()) , DefaultSeed(InDefaultSeed) {} FNoiseNode::FNoiseNode(const FNodeInitData& InInitData) : FNoiseNode(InInitData.InstanceName, InInitData.InstanceID, FNoiseOperator::DefaultSeed) {} TUniquePtr FNoiseOperator::CreateOperator(const FCreateOperatorParams& InParams, FBuildErrorArray& OutErrors) { const FNoiseNode& Node = static_cast(InParams.Node); const FDataReferenceCollection& InputCol = InParams.InputDataReferences; const FOperatorSettings& Settings = InParams.OperatorSettings; const FInputVertexInterface& InputInterface = DeclareVertexInterface().GetInputInterface(); // Static property pin, only used for factory. FEnumNoiseTypeReadRef Type = InputCol.GetDataReadReferenceOrConstruct(TriggerTypePinName); // Seed. FInt32ReadRef Seed = InputCol.GetDataReadReferenceOrConstruct(TriggerTypePinName, Node.GetDefaultSeed()); switch (*Type) { default: case ENoiseType::White: return MakeUnique(InParams.OperatorSettings, MoveTemp(Seed)); case ENoiseType::Pink: return MakeUnique(InParams.OperatorSettings, MoveTemp(Seed)); } checkNoEntry(); return nullptr; } METASOUND_REGISTER_NODE(FNoiseNode); } #undef LOCTEXT_NAMESPACE //MetasoundStandardNodes