MovieSceneAudioSystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "EntitySystem/MovieSceneEntityIDs.h"
#include "EntitySystem/MovieSceneSequenceInstanceHandle.h"
#include "MovieSceneTracksComponentTypes.h"
#include "UObject/ObjectMacros.h"
#include "Channels/MovieSceneAudioTriggerChannel.h"
#include "EntitySystem/MovieSceneEntitySystem.h"
#include "Generators/SoundWaveScrubber.h"
 
#include "MovieSceneAudioSystem.generated.h"
 
class IAudioParameterControllerInterface;
class UAudioComponent;
class UMovieSceneAudioSection;
class USoundBase;
struct FMoveSceneAudioTriggerState;
 
namespace UE::MovieScene
{
    struct FGatherAudioInputs;
    struct FGatherAudioTriggers;
    struct FEvaluateAudio;
    struct FPreAnimatedAudioStorage;
 
    struct FAudioComponentInputEvaluationData
    {
        TMap<FName, float> Inputs_Float;
        TMap<FName, FString> Inputs_String;
        TMap<FName, bool> Inputs_Bool;
        TMap<FName, int32> Inputs_Int;
        TArray<FName> Inputs_Trigger;
    };
 
    struct FAudioComponentEvaluationData
    {
        TWeakObjectPtr<UAudioComponent> AudioComponent;
 
#if WITH_EDITOR
        TObjectPtr<UScrubbedSound> ScrubbedSound;
#endif
 
        double VolumeMultiplier = 1.0;
 
        double PitchMultiplier = 1.0;
 
        TOptional<float> PartialDesyncComputation;
 
        TOptional<float> LastAudioTime;
        TOptional<float> LastContextTime;
 
        bool bEvaluatedThisFrame = false;
 
        bool bAudioComponentHasBeenPlayed = false;
    };
}
 
UCLASS()
class UMovieSceneAudioSystem : public UMovieSceneEntitySystem
{
    GENERATED_BODY()
 
public:
 
    using FInstanceHandle = UE::MovieScene::FInstanceHandle;
    using FMovieSceneEntityID = UE::MovieScene::FMovieSceneEntityID;
    using FAudioComponentEvaluationData = UE::MovieScene::FAudioComponentEvaluationData;
    using FAudioComponentInputEvaluationData = UE::MovieScene::FAudioComponentInputEvaluationData;
 
    UMovieSceneAudioSystem(const FObjectInitializer& ObjInit);
 
    //~ UMovieSceneEntitySystem members
    virtual void OnLink() override;
    virtual void OnUnlink() override;
    virtual void OnSchedulePersistentTasks(UE::MovieScene::IEntitySystemScheduler* TaskScheduler) override;
    virtual void OnRun(FSystemTaskPrerequisites& InPrerequisites, FSystemSubsequentTasks& Subsequents) override;
 
    FAudioComponentEvaluationData* GetAudioComponentEvaluationData(FInstanceHandle InstanceHandle, FObjectKey ActorKey, FObjectKey SectionKey);
 
    FAudioComponentEvaluationData* AddBoundObjectAudioComponent(FInstanceHandle InstanceHandle, UMovieSceneAudioSection* Section, UObject* PrincipalObject);
 
    FAudioComponentEvaluationData* AddRootAudioComponent(FInstanceHandle InstanceHandle, UMovieSceneAudioSection* Section, UWorld* World);
 
    void StopSound(FInstanceHandle InstanceHandle, FObjectKey ActorKey, FObjectKey SectionKey);
 
    void ResetSharedData();
 
    // To expose the class to GC //
    static void AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector);
 
private:
 
    using FInstanceObjectKey = TTuple<FInstanceHandle, FObjectKey>;
 
    using FAudioComponentBySectionKey = TMap<FInstanceObjectKey, FAudioComponentEvaluationData>;
    using FAudioComponentsByActorKey = TMap<FObjectKey, FAudioComponentBySectionKey>;
    FAudioComponentsByActorKey AudioComponentsByActorKey;
 
    using FAudioInputsBySectionKey = TMap<FInstanceObjectKey, FAudioComponentInputEvaluationData>;
    FAudioInputsBySectionKey AudioInputsBySectionKey;
 
    TSharedPtr<UE::MovieScene::FPreAnimatedAudioStorage> PreAnimatedStorage;
 
    friend struct UE::MovieScene::FGatherAudioInputs;
    friend struct UE::MovieScene::FGatherAudioTriggers;
    friend struct UE::MovieScene::FEvaluateAudio;
};