SoundNode.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "CoreMinimal.h"
#include "Math/RandomStream.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/Class.h"
#include "Sound/SoundWave.h"
#include "SoundNode.generated.h"
 
class FAudioDevice;
class UEdGraphNode;
struct FActiveSound;
struct FPropertyChangedEvent;
struct FWaveInstance;
 
/*-----------------------------------------------------------------------------
    USoundNode helper macros.
-----------------------------------------------------------------------------*/
 
struct FActiveSound;
 
#define DECLARE_SOUNDNODE_ELEMENT(Type,Name)                                                    \
    Type& Name = *((Type*)(Payload));                                                           \
    Payload += sizeof(Type);
 
#define DECLARE_SOUNDNODE_ELEMENT_PTR(Type,Name)                                                \
    Type* Name = (Type*)(Payload);                                                              \
    Payload += sizeof(Type);
 
#define RETRIEVE_SOUNDNODE_PAYLOAD( Size )                                                      \
        uint8*  Payload                 = NULL;                                                 \
        uint32* RequiresInitialization  = NULL;                                                 \
        {                                                                                       \
            uint32* TempOffset = ActiveSound.SoundNodeOffsetMap.Find(NodeWaveInstanceHash);     \
            uint32 Offset;                                                                      \
            if( !TempOffset )                                                                   \
            {                                                                                   \
                Offset = ActiveSound.SoundNodeData.AddZeroed( Size + sizeof(uint32));               \
                ActiveSound.SoundNodeOffsetMap.Add( NodeWaveInstanceHash, Offset );             \
                RequiresInitialization = (uint32*) &ActiveSound.SoundNodeData[Offset];          \
                *RequiresInitialization = 1;                                                    \
                Offset += sizeof(uint32);                                                           \
            }                                                                                   \
            else                                                                                \
            {                                                                                   \
                RequiresInitialization = (uint32*) &ActiveSound.SoundNodeData[*TempOffset];     \
                Offset = *TempOffset + sizeof(uint32);                                          \
            }                                                                                   \
            Payload = &ActiveSound.SoundNodeData[Offset];                                       \
        }
 
UCLASS(abstract, hidecategories=Object, editinlinenew, MinimalAPI)
class USoundNode : public UObject
{
    GENERATED_UCLASS_BODY()
 
    static const int32 MAX_ALLOWED_CHILD_NODES = 32;
 
    UPROPERTY(BlueprintReadOnly, Category = "SoundNode")
    TArray<TObjectPtr<class USoundNode>> ChildNodes;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TObjectPtr<UEdGraphNode>    GraphNode;
 
    ENGINE_API class UEdGraphNode* GetGraphNode() const;
#endif
 
    FRandomStream RandomStream;
 
    bool bIsRetainingAudio;
 
public:
    //~ Begin UObject Interface
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    ENGINE_API virtual void PostLoad() override;
    static ENGINE_API void AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector);
#endif //WITH_EDITOR
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
    ENGINE_API virtual bool CanBeClusterRoot() const override;
    ENGINE_API virtual bool CanBeInCluster() const override;
    ENGINE_API virtual void BeginDestroy() override;
    //~ End UObject Interface
 
    //
    //~ Begin USoundNode Interface.
    //
 
    virtual bool NotifyWaveInstanceFinished( struct FWaveInstance* WaveInstance )
    {
        return( false );
    }
 
    ENGINE_API virtual float GetMaxDistance() const;
 
    virtual bool SupportsSubtitles() const
    {
        return false;
    }
 
    ENGINE_API virtual float GetDuration();
 
    ENGINE_API virtual bool HasDelayNode() const;
 
    ENGINE_API virtual bool HasConcatenatorNode() const;
 
    ENGINE_API virtual bool HasAttenuationNode() const;
 
    ENGINE_API virtual bool IsPlayWhenSilent() const;
 
    ENGINE_API virtual void ParseNodes( FAudioDevice* AudioDevice, const UPTRINT NodeWaveInstanceHash, FActiveSound& ActiveSound, const struct FSoundParseParameters& ParseParams, TArray<FWaveInstance*>& WaveInstances );
 
    ENGINE_API virtual void GetAllNodes( TArray<USoundNode*>& SoundNodes );
 
    virtual int32 GetMaxChildNodes() const
    {
        return 1 ;
    }
 
    virtual int32 GetMinChildNodes() const
    {
        return 0;
    }
 
    ENGINE_API virtual int32 GetNumSounds(const UPTRINT NodeWaveInstanceHash, FActiveSound& ActiveSound) const;
 
 
    ENGINE_API virtual void CreateStartingConnectors( void );
    ENGINE_API virtual void InsertChildNode( int32 Index );
    ENGINE_API virtual void RemoveChildNode( int32 Index );
#if WITH_EDITOR
    ENGINE_API virtual void SetChildNodes(TArray<USoundNode*>& InChildNodes);
 
    virtual FText GetInputPinName(int32 PinIndex) const { return FText::GetEmpty(); }
 
    virtual FText GetTitle() const { return GetClass()->GetDisplayNameText(); }
 
    ENGINE_API void PlaceNode(int32 NodeColumn, int32 NodeRow, int32 RowCount );
 
    virtual void OnBeginPIE(const bool bIsSimulating) {};
 
    virtual void OnEndPIE(const bool bIsSimulating) {};
#endif //WITH_EDITOR
 
    static ENGINE_API UPTRINT GetNodeWaveInstanceHash(const UPTRINT ParentWaveInstanceHash, const USoundNode* ChildNode, const uint32 ChildIndex);
    static ENGINE_API UPTRINT GetNodeWaveInstanceHash(const UPTRINT ParentWaveInstanceHash, const UPTRINT ChildNodeHash, const uint32 ChildIndex);
 
 
    ENGINE_API virtual void PrimeChildWavePlayers(bool bRecurse);
 
    ENGINE_API virtual void RetainChildWavePlayers(bool bRecurse);
 
    ENGINE_API virtual void OverrideLoadingBehaviorOnChildWaves(const bool bRecurse, const ESoundWaveLoadingBehavior InLoadingBehavior);
 
    ENGINE_API virtual void ReleaseRetainerOnChildWavePlayers(bool bRecurse);
 
    ENGINE_API virtual void RemoveSoundWaveOnChildWavePlayers();
 
    ENGINE_API virtual void LoadChildWavePlayerAssets(bool bAddToRoot, bool bRecurse);
};