UnrealEngineUWP/Engine/Plugins/Runtime/Metasound/Source/MetasoundStandardNodes/Private/MetasoundADSRNode.cpp

// Copyright Epic Games, Inc. All Rights Reserved.

#include "MetasoundADSRNode.h"

#include "DSP/Envelope.h"
#include "Internationalization/Text.h"
#include "MetasoundAudioBuffer.h"
#include "MetasoundExecutableOperator.h"
#include "MetasoundNodeRegistrationMacro.h"
#include "MetasoundPrimitives.h"
#include "MetasoundStandardNodesNames.h"
#include "MetasoundTime.h"
#include "MetasoundTrigger.h"

#define LOCTEXT_NAMESPACE "MetasoundStandardNodes"

namespace Metasound
{
	class FADSROperator : public TExecutableOperator<FADSROperator>
	{
		public:
			struct FADSRReferences
			{
				FFloatTimeReadRef Attack;
				FFloatTimeReadRef Decay;
				FFloatReadRef SustainLevel;
				FFloatTimeReadRef Release;
			};

			static const FNodeClassMetadata& GetNodeInfo();
			static const FVertexInterface& GetVertexInterface();
			static TUniquePtr<IOperator> CreateOperator(const FCreateOperatorParams& InParams, FBuildErrorArray& OutErrors);

			FADSROperator(const FOperatorSettings& InSettings, const FTriggerReadRef& InTriggerAttack, const FTriggerReadRef& InTriggerRelease, const FADSRReferences& InADSRData);

			virtual FDataReferenceCollection GetInputs() const override;
			virtual FDataReferenceCollection GetOutputs() const override;
			void Execute();

		private:

			void GenerateEnvelope(int32 InStartFrame, int32 InEndFrame);
			void Start();

			Audio::FEnvelope Envelope;

			FTriggerReadRef TriggerAttack;
			FTriggerReadRef TriggerRelease;

			FTriggerWriteRef TriggerAttackComplete;
			FTriggerWriteRef TriggerDecayComplete;
			FTriggerWriteRef TriggerReleaseComplete;

			bool bReleased;

			FSampleTime TimeUntilRelease;
			FSampleTime TimePerBlock;
			FADSRReferences ADSRReferences;
			FAudioBufferWriteRef EnvelopeBuffer;
	};

	FADSROperator::FADSROperator(const FOperatorSettings& InSettings, const FTriggerReadRef& InTriggerAttack, const FTriggerReadRef& InTriggerRelease, const FADSRReferences& InADSRData)
	:	TriggerAttack(InTriggerAttack)
	,	TriggerRelease(InTriggerRelease)
	,	TriggerAttackComplete(FTriggerWriteRef::CreateNew(InSettings))
	,	TriggerDecayComplete(FTriggerWriteRef::CreateNew(InSettings))
	,	TriggerReleaseComplete(FTriggerWriteRef::CreateNew(InSettings))
	,	bReleased(false)
	,	TimeUntilRelease(0, InSettings.GetSampleRate())
	,	TimePerBlock(InSettings.GetNumFramesPerBlock(), InSettings.GetSampleRate())
	,	ADSRReferences(InADSRData)
	,	EnvelopeBuffer(FAudioBufferWriteRef::CreateNew(InSettings.GetNumFramesPerBlock()))
	{
		check(EnvelopeBuffer->Num() == InSettings.GetNumFramesPerBlock());

		Envelope.Init(InSettings.GetSampleRate());
	}

	FDataReferenceCollection FADSROperator::GetInputs() const
	{
		FDataReferenceCollection InputDataReferences;
		InputDataReferences.AddDataReadReference(TEXT("Attack"), FFloatTimeReadRef(ADSRReferences.Attack));
		InputDataReferences.AddDataReadReference(TEXT("Decay"), FFloatTimeReadRef(ADSRReferences.Decay));
		InputDataReferences.AddDataReadReference(TEXT("Release"), FFloatTimeReadRef(ADSRReferences.Release));
		InputDataReferences.AddDataReadReference(TEXT("Sustain Level"), FFloatReadRef(ADSRReferences.SustainLevel));
		InputDataReferences.AddDataReadReference(TEXT("Trigger Attack"), FTriggerReadRef(TriggerAttack));
		InputDataReferences.AddDataReadReference(TEXT("Trigger Release"), FTriggerReadRef(TriggerRelease));
		return InputDataReferences;
	}

	FDataReferenceCollection FADSROperator::GetOutputs() const
	{
		FDataReferenceCollection OutputDataReferences;
		OutputDataReferences.AddDataReadReference(TEXT("Envelope"), FAudioBufferReadRef(EnvelopeBuffer));
		OutputDataReferences.AddDataReadReference(TEXT("Attack Complete"), FTriggerReadRef(TriggerAttackComplete));
		OutputDataReferences.AddDataReadReference(TEXT("Decay Complete"), FTriggerReadRef(TriggerDecayComplete));
		OutputDataReferences.AddDataReadReference(TEXT("Release Complete"), FTriggerReadRef(TriggerReleaseComplete));
		return OutputDataReferences;
	}

	void FADSROperator::GenerateEnvelope(int32 InStartFrame, int32 InEndFrame)
	{
		float* EnvelopeData = EnvelopeBuffer->GetData();
		const bool bWasDone = Envelope.IsDone();

		Audio::FEnvelope::EEnvelopeState EnvState = Envelope.GetState();

		int32 AttackCompleteFrame = -1;
		int32 DecayCompleteFrame = -1;
		int32 ReleaseCompleteFrame = -1;

		TimeUntilRelease -= TimePerBlock;

		auto GenerateLambda = [&] (int32 InFrame)
		{
			const float EnvValue = Envelope.Generate();
			if (Envelope.GetState() != EnvState)
			{
				switch (EnvState)
				{
				case Audio::FEnvelope::EEnvelopeState::Attack:
					AttackCompleteFrame = InFrame;
					break;

				case Audio::FEnvelope::EEnvelopeState::Decay:
					DecayCompleteFrame = InFrame;
					break;

				case Audio::FEnvelope::EEnvelopeState::Release:
					ReleaseCompleteFrame = InFrame;
					break;

				default:
					break;
				}

				EnvState = Envelope.GetState();
			}

			return EnvValue;
		};

		for (int32 i = InStartFrame; i < InEndFrame; i++)
		{
			EnvelopeData[i] = GenerateLambda(i);
		}

		if (AttackCompleteFrame >= 0)
		{
			TriggerAttackComplete->TriggerFrame(AttackCompleteFrame);
		}

		if (DecayCompleteFrame >= 0)
		{
			TriggerDecayComplete->TriggerFrame(DecayCompleteFrame);
		}

		if (Envelope.IsDone() && !bWasDone && ReleaseCompleteFrame >= 0)
		{
			TriggerReleaseComplete->TriggerFrame(ReleaseCompleteFrame);
		}
	}

	void FADSROperator::Execute()
	{
		Envelope.SetAttackTime(ADSRReferences.Attack->GetMilliseconds());
		Envelope.SetDecayTime(ADSRReferences.Decay->GetMilliseconds());
		Envelope.SetReleaseTime(ADSRReferences.Release->GetMilliseconds());
		Envelope.SetSustainGain(*ADSRReferences.SustainLevel);

		TriggerAttackComplete->AdvanceBlock();
		TriggerDecayComplete->AdvanceBlock();
		TriggerReleaseComplete->AdvanceBlock();

		TriggerRelease->ExecuteBlock(
			// OnPreTrigger
			[&](int32 StartFrame, int32 EndFrame)
			{
			},
			// OnTrigger
			[&](int32 StartFrame, int32 EndFrame)
			{
				if (!bReleased)
				{
					bReleased = true;
					TimeUntilRelease = *(ADSRReferences.Release);

					const int32 ReleaseFrame = TimeUntilRelease.GetNumSamples();
					if (ReleaseFrame < EndFrame)
					{
						GenerateEnvelope(StartFrame, ReleaseFrame);
						Envelope.Stop();
						GenerateEnvelope(ReleaseFrame, EndFrame);
					}
					else
					{
						Envelope.Stop();
						GenerateEnvelope(StartFrame, EndFrame);
					}
				}
			}
		);

		TriggerAttack->ExecuteBlock(
			// OnPreTrigger
			[&](int32 StartFrame, int32 EndFrame)
			{
				GenerateEnvelope(StartFrame, EndFrame);
			},
			// OnTrigger
			[&](int32 StartFrame, int32 EndFrame)
			{
				Start();
				if (!Envelope.IsDone())
				{
					GenerateEnvelope(StartFrame, EndFrame);
				}
			}
		);
	}

	void FADSROperator::Start()
	{
		if (Envelope.IsDone())
		{
			Envelope.Start();
			bReleased = false;
		}
	}

	const FVertexInterface& FADSROperator::GetVertexInterface()
	{
		static const FVertexInterface Interface(
			FInputVertexInterface(
				TInputDataVertexModel<FFloatTime>(TEXT("Attack"), LOCTEXT("AttackDurationTooltip", "Attack duration."), 0.01f),
				TInputDataVertexModel<FFloatTime>(TEXT("Decay"), LOCTEXT("DecayDurationTooltip", "Decay duration."), 0.02f),
				TInputDataVertexModel<FFloatTime>(TEXT("Release"), LOCTEXT("ReleaseDurationTooltip", "Release duration."), 1.0f),
				TInputDataVertexModel<float>(TEXT("Sustain Level"), LOCTEXT("SustainLevelTooltip", "Sustain level [0.0f, 1.0f]."), 0.7f),
				TInputDataVertexModel<FTrigger>(TEXT("Trigger Attack"), LOCTEXT("TriggerAttackTooltip", "Trigger the envelope's attack.")),
				TInputDataVertexModel<FTrigger>(TEXT("Trigger Release"), LOCTEXT("TriggerReleaseTooltip", "Trigger the envelope's release."))
			),
			FOutputVertexInterface(
				TOutputDataVertexModel<FAudioBuffer>(TEXT("Envelope"), LOCTEXT("EnvelopeTooltip", "The output envelope")),
				TOutputDataVertexModel<FTrigger>(TEXT("Attack Complete"), LOCTEXT("AttackCompleteTooltip", "Triggered when the envelope attack is complete")),
				TOutputDataVertexModel<FTrigger>(TEXT("Decay Complete"), LOCTEXT("DecayCompleteTooltip", "Triggered when the envelope decay is complete")),
				TOutputDataVertexModel<FTrigger>(TEXT("Release Complete"), LOCTEXT("ReleaseCompleteTooltip", "Triggered when the envelope is released"))
			)
		);

		return Interface;
	}

	const FNodeClassMetadata& FADSROperator::GetNodeInfo()
	{
		auto InitNodeInfo = []() -> FNodeClassMetadata
		{
			FNodeClassMetadata Info;
			Info.ClassName = {Metasound::StandardNodes::Namespace, TEXT("ADSR"), Metasound::StandardNodes::AudioVariant};
			Info.MajorVersion = 1;
			Info.MinorVersion = 0;
			Info.DisplayName = LOCTEXT("Metasound_ADSRNodeDisplayName", "ADSR");
			Info.Description = LOCTEXT("Metasound_ADSRNodeDescription", "Emits an ADSR (Attack, decay, sustain, & release) envelope when triggered.");
			Info.Author = PluginAuthor;
			Info.PromptIfMissing = PluginNodeMissingPrompt;
			Info.DefaultInterface = GetVertexInterface();

			return Info;
		};

		static const FNodeClassMetadata Info = InitNodeInfo();

		return Info;
	}

	TUniquePtr<IOperator> FADSROperator::CreateOperator(const FCreateOperatorParams& InParams, FBuildErrorArray& OutErrors)
	{
		const FADSRNode& ADSRNode = static_cast<const FADSRNode&>(InParams.Node);
		const FDataReferenceCollection& InputCollection = InParams.InputDataReferences;
		const FInputVertexInterface& InputInterface = GetVertexInterface().GetInputInterface();

		// TODO: Could no-op this if the trigger is not connected.
		FTriggerReadRef TriggerAttack = InputCollection.GetDataReadReferenceOrConstruct<FTrigger>(TEXT("Trigger Attack"), InParams.OperatorSettings);
		FTriggerReadRef TriggerRelease = InputCollection.GetDataReadReferenceOrConstruct<FTrigger>(TEXT("Trigger Release"), InParams.OperatorSettings);

		// TODO: If none of these are connected, could pre-generate ADSR envelope and return a different operator.
		FADSRReferences ADSRReferences =
		{
			InputCollection.GetDataReadReferenceOrConstructWithVertexDefault<FFloatTime, float>(InputInterface, TEXT("Attack")),
			InputCollection.GetDataReadReferenceOrConstructWithVertexDefault<FFloatTime, float>(InputInterface, TEXT("Decay")),
			InputCollection.GetDataReadReferenceOrConstructWithVertexDefault<float>(InputInterface, TEXT("Sustain Level")),
			InputCollection.GetDataReadReferenceOrConstructWithVertexDefault<FFloatTime, float>(InputInterface, TEXT("Release")),
		};

		return MakeUnique<FADSROperator>(InParams.OperatorSettings, TriggerAttack, TriggerRelease, ADSRReferences);
	}

	FADSRNode::FADSRNode(const FNodeInitData& InitData)
		: FNodeFacade(InitData.InstanceName, InitData.InstanceID, TFacadeOperatorClass<FADSROperator>())
	{
	}

	METASOUND_REGISTER_NODE(FADSRNode)
}

#undef LOCTEXT_NAMESPACE