MovieSceneAudioSection.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Channels/MovieSceneAudioTriggerChannel.h"
#include "Channels/MovieSceneBoolChannel.h"
#include "Channels/MovieSceneFloatChannel.h"
#include "Channels/MovieSceneIntegerChannel.h"
#include "Channels/MovieSceneStringChannel.h"
#include "Components/AudioComponent.h"
#include "Decorations/MovieSceneScalingAnchors.h"
#include "CoreMinimal.h"
#include "EntitySystem/IMovieSceneEntityProvider.h"
#include "MovieSceneSection.h"
#include "Sections/MovieSceneActorReferenceSection.h"
#include "Sound/SoundAttenuation.h"
#include "UObject/ObjectMacros.h"
 
#include "MovieSceneAudioSection.generated.h"
 
class USoundBase;
 
UCLASS(MinimalAPI)
class UMovieSceneAudioSection
    : public UMovieSceneSection
    , public IMovieSceneEntityProvider
    , public IMovieSceneScalingDriver
{
    GENERATED_UCLASS_BODY()
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Sequencer|Section")
    MOVIESCENETRACKS_API void SetSound(class USoundBase* InSound);
 
    UFUNCTION(BlueprintPure, Category = "Sequencer|Section")
    class USoundBase* GetSound() const {return Sound;}
 
    UFUNCTION(BlueprintPure, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API USoundBase* GetPlaybackSound() const;
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    void SetStartOffset(FFrameNumber InStartOffset) {StartFrameOffset = InStartOffset;}
 
    UFUNCTION(BlueprintPure, Category = "Sequencer|Section")
    FFrameNumber GetStartOffset() const {return StartFrameOffset;}
 
    const FMovieSceneFloatChannel& GetSoundVolumeChannel() const { return SoundVolume; }
 
    const FMovieSceneFloatChannel& GetPitchMultiplierChannel() const { return PitchMultiplier; }
 
    float GetSoundVolume(FFrameTime InTime) const
    {
        float OutValue = 0.f;
        SoundVolume.Evaluate(InTime, OutValue);
        return OutValue;
    }
 
    float GetPitchMultiplier(FFrameTime InTime) const
    {
        float OutValue = 0.f;
        PitchMultiplier.Evaluate(InTime, OutValue);
        return OutValue;
    }
 
    UFUNCTION(BlueprintPure, Category = "Sequencer|Section")
    bool GetLooping() const { return bLooping; }
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    void SetLooping(bool bInLooping) { bLooping = bInLooping; }
 
    UFUNCTION(BlueprintPure, Category = "Sequencer|Section")
    bool GetSuppressSubtitles() const { return bSuppressSubtitles; }
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    void SetSuppressSubtitles(bool bInSuppressSubtitles) { bSuppressSubtitles = bInSuppressSubtitles; }
 
    UFUNCTION(BlueprintPure, Category = "Sequencer|Section")
    bool GetOverrideAttenuation() const { return bOverrideAttenuation; }
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    void SetOverrideAttenuation(bool bInOverrideAttenuation) { bOverrideAttenuation = bInOverrideAttenuation; }
 
    UFUNCTION(BlueprintPure, Category = "Sequencer|Section")
    USoundAttenuation* GetAttenuationSettings() const { return AttenuationSettings; }
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    void SetAttenuationSettings(USoundAttenuation* InAttenuationSettings) { AttenuationSettings = InAttenuationSettings; }
 
    /*
     * @return The attach actor data
     */
    const FMovieSceneActorReferenceData& GetAttachActorData() const { return AttachActorData; }
 
    /*
     * @return The attach component given the bound actor and the actor attach key with the component and socket names
     */
    MOVIESCENETRACKS_API USceneComponent* GetAttachComponent(const AActor* InParentActor, const FMovieSceneActorReferenceKey& Key) const;
 
    MOVIESCENETRACKS_API virtual void PostLoad() override;
 
    void SetOnQueueSubtitles(const FOnQueueSubtitles& InOnQueueSubtitles)
    {
        OnQueueSubtitles = InOnQueueSubtitles;
    }
 
    const FOnQueueSubtitles& GetOnQueueSubtitles() const
    {
        return OnQueueSubtitles;
    }
 
    void SetOnAudioFinished(const FOnAudioFinished& InOnAudioFinished)
    {
        OnAudioFinished = InOnAudioFinished;
    }
 
    const FOnAudioFinished& GetOnAudioFinished() const
    {
        return OnAudioFinished;
    }
    
    void SetOnAudioPlaybackPercent(const FOnAudioPlaybackPercent& InOnAudioPlaybackPercent)
    {
        OnAudioPlaybackPercent = InOnAudioPlaybackPercent;
    }
 
    const FOnAudioPlaybackPercent& GetOnAudioPlaybackPercent() const
    {
        return OnAudioPlaybackPercent;
    }
    
    void ForEachInput(TFunction<void(FName, const FMovieSceneBoolChannel&)> InFunction) const { ForEachInternal(InFunction, Inputs_Bool); }
    void ForEachInput(TFunction<void(FName, const FMovieSceneStringChannel&)> InFunction) const { ForEachInternal(InFunction, Inputs_String); }
    void ForEachInput(TFunction<void(FName, const FMovieSceneIntegerChannel&)> InFunction) const  { ForEachInternal(InFunction, Inputs_Int); }
    void ForEachInput(TFunction<void(FName, const FMovieSceneFloatChannel&)> InFunction) const { ForEachInternal(InFunction, Inputs_Float); }
    void ForEachInput(TFunction<void(FName, const FMovieSceneAudioTriggerChannel&)> InFunction) const { ForEachInternal(InFunction, Inputs_Trigger); }
 
public:
 
    //~ UMovieSceneSection interface
    MOVIESCENETRACKS_API virtual TOptional<TRange<FFrameNumber> > GetAutoSizeRange() const override;
    MOVIESCENETRACKS_API virtual void TrimSection(FQualifiedFrameTime TrimTime, bool bTrimLeft, bool bDeleteKeys) override;
    MOVIESCENETRACKS_API virtual UMovieSceneSection* SplitSection(FQualifiedFrameTime SplitTime, bool bDeleteKeys) override;
    MOVIESCENETRACKS_API virtual TOptional<FFrameTime> GetOffsetTime() const override;
    MOVIESCENETRACKS_API virtual void MigrateFrameTimes(FFrameRate SourceRate, FFrameRate DestinationRate) override;
    MOVIESCENETRACKS_API virtual EMovieSceneChannelProxyType CacheChannelProxy() override;
    MOVIESCENETRACKS_API virtual UObject* GetSourceObject() const override;
 
    //~ IMovieSceneEntityProvider interface
    MOVIESCENETRACKS_API virtual bool PopulateEvaluationFieldImpl(const TRange<FFrameNumber>& EffectiveRange, const FMovieSceneEvaluationFieldEntityMetaData& InMetaData, FMovieSceneEntityComponentFieldBuilder* OutFieldBuilder) override;
    MOVIESCENETRACKS_API virtual void ImportEntityImpl(UMovieSceneEntitySystemLinker* EntityLinker, const FEntityImportParams& Params, FImportedEntity* OutImportedEntity) override;
 
    //~ IMovieSceneScalingDriver interface
    MOVIESCENETRACKS_API virtual void PopulateInitialAnchors(TMap<FGuid, FMovieSceneScalingAnchor>& OutAnchors) override;
    MOVIESCENETRACKS_API virtual void PopulateAnchors(TMap<FGuid, FMovieSceneScalingAnchor>& OutAnchors) override;
 
private:
 
    template<typename ChannelType, typename ForEachFunction>
    inline static void ForEachInternal(ForEachFunction InFunction, const TMap<FName, ChannelType>& InMapToIterate) 
    {
        for (auto& Item : InMapToIterate)
        {
            InFunction(Item.Key, Item.Value);
        }   
    }
 
    MOVIESCENETRACKS_API void SetupSoundInputParameters(USoundBase* InSoundBase);
 
    UPROPERTY(EditAnywhere, Category="Audio", BlueprintGetter=GetSound, BlueprintSetter=SetSound)
    TObjectPtr<USoundBase> Sound;
 
    UPROPERTY(EditAnywhere, Category="Audio", meta=(UIFrameDisplayAs="NonMusical|Position"))
    FFrameNumber StartFrameOffset;
 
    UPROPERTY()
    float StartOffset_DEPRECATED;
 
    UPROPERTY( )
    float AudioStartTime_DEPRECATED;
    
    UPROPERTY( )
    float AudioDilationFactor_DEPRECATED;
 
    UPROPERTY( )
    float AudioVolume_DEPRECATED;
 
    UPROPERTY( )
    FMovieSceneFloatChannel SoundVolume;
 
    UPROPERTY( )
    FMovieSceneFloatChannel PitchMultiplier;
 
    UPROPERTY()
    TMap<FName, FMovieSceneFloatChannel> Inputs_Float;
    UPROPERTY()
    TMap<FName, FMovieSceneStringChannel> Inputs_String;
    UPROPERTY()
    TMap<FName, FMovieSceneBoolChannel> Inputs_Bool;
    UPROPERTY()
    TMap<FName, FMovieSceneIntegerChannel> Inputs_Int;
    UPROPERTY()
    TMap<FName, FMovieSceneAudioTriggerChannel> Inputs_Trigger;
 
    UPROPERTY()
    FMovieSceneActorReferenceData AttachActorData;
 
    /* Allow looping if the section length is greater than the sound duration */
    UPROPERTY(EditAnywhere, Category = "Audio")
    bool bLooping;
 
    UPROPERTY(EditAnywhere, Category = "Audio")
    bool bSuppressSubtitles;
 
    UPROPERTY( EditAnywhere, Category="Attenuation" )
    bool bOverrideAttenuation;
 
    UPROPERTY( EditAnywhere, Category="Attenuation", meta = (EditCondition = "bOverrideAttenuation") )
    TObjectPtr<class USoundAttenuation> AttenuationSettings;
 
    UPROPERTY()
    FOnQueueSubtitles OnQueueSubtitles;
 
    UPROPERTY()
    FOnAudioFinished OnAudioFinished;
 
    UPROPERTY()
    FOnAudioPlaybackPercent OnAudioPlaybackPercent;
};