UnrealEngineUWP/Engine/Plugins/Runtime/Metasound/Source/MetasoundEngine/Public/MetasoundSource.h

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once

#include "CoreMinimal.h"
#include "MetasoundFrontend.h"
#include "MetasoundFrontendDataLayout.h"
#include "MetasoundAssetBase.h"

#include "Sound/SoundWaveProcedural.h"


#if WITH_EDITORONLY_DATA
#include "EdGraph/EdGraph.h"
#include "Misc/AssertionMacros.h"
#endif // WITH_EDITORONLY_DATA

#include "MetasoundSource.generated.h"


/**
 * This Metasound type can be played as an audio source.
 */
UCLASS(hidecategories = object, BlueprintType)
class METASOUNDENGINE_API UMetasoundSource : public USoundWaveProcedural, public FMetasoundAssetBase
{
	GENERATED_BODY()

protected:
	UPROPERTY(EditAnywhere, Category = CustomView)
	FMetasoundDocument RootMetasoundDocument;

#if WITH_EDITORONLY_DATA
	UPROPERTY()
	UEdGraph* Graph;
#endif // WITH_EDITORONLY_DATA

public:
	UMetasoundSource(const FObjectInitializer& ObjectInitializer);

#if WITH_EDITORONLY_DATA
	// Returns document name (for editor purposes, and avoids making document public for edit
	// while allowing editor to reference directly)
	static FName GetDocumentPropertyName()
	{
		return GET_MEMBER_NAME_CHECKED(UMetasoundSource, RootMetasoundDocument);
	}

	// Returns the graph associated with this Metasound. Graph is required to be referenced on
	// Metasound UObject for editor serialization purposes.
	// @return Editor graph associated with UMetasoundSource.
	virtual UEdGraph* GetGraph() override
	{
		return Graph;
	}

	virtual const UEdGraph* GetGraph() const override
	{
		return Graph;
	}

	virtual UEdGraph& GetGraphChecked() override
	{
		check(Graph);
		return *Graph;
	}

	virtual const UEdGraph& GetGraphChecked() const override
	{
		check(Graph);
		return *Graph;
	}

	// Sets the graph associated with this Metasound. Graph is required to be referenced on
	// Metasound UObject for editor serialization purposes.
	// @param Editor graph associated with UMetasoundSource.
	virtual void SetGraph(UEdGraph* InGraph) override
	{
		Graph = InGraph;
	}
#endif // WITH_EDITORONLY_DATA

	FMetasoundDocument& GetDocument() override
	{
		return RootMetasoundDocument;
	}

	const FMetasoundDocument& GetDocument() const override
	{
		return RootMetasoundDocument;
	}

	UObject* GetOwningAsset() const override
	{
		// Hack to allow handles to manipulate while providing
		// ability to inspect via a handle from the const version of GetRootGraphHandle()
		return const_cast<UObject*>(CastChecked<const UObject>(this));
	}

	// Updates the Metasound's metadata (name, author, etc).
	// @param InMetadata Metadata containing corrections to the class metadata.
	void SetMetadata(FMetasoundClassMetadata& InMetadata) override;

	bool IsPlayable() const override;
	bool SupportsSubtitles() const override;
	float GetDuration() override;
	ISoundGeneratorPtr CreateSoundGenerator(const FSoundGeneratorInitParams& InParams) override;
	void PostLoad() override;

	// Get the most up to date archetype for metasound sources.
	virtual FMetasoundArchetype GetArchetype() const override;

private:

	static const FString& GetOnPlayInputName();
	static const FString& GetAudioOutputName();
	static const FString& GetIsFinishedOutputName();
	static const FString& GetAudioDeviceHandleVariableName();
};