VoxtaAudioPlayback.h

Go to the documentation of this file.

// Copyright(c) 2024 grrimgrriefer & DZnnah, see LICENSE for details.
 
#pragma once
#include "CoreMinimal.h"
#include "Components/AudioComponent.h"
#include "AbstractA2FWeightProvider.h"
#include "LipSyncType.h"
#include "VoxtaAudioPlayback.generated.h"
 
class MessageChunkAudioContainer;
class UActorComponent;
class UAudio2FacePlaybackHandler;
class UVoxtaClient;
class USoundWaveProcedural;
struct FBaseCharData;
struct FChatMessage;

UCLASS(HideCategories = (Mobility, Rendering, LOD), ClassGroup = Voxta, meta = (BlueprintSpawnableComponent))
class UNREALVOXTA_API UVoxtaAudioPlayback : public UAudioComponent, public IA2FWeightProvider
{
    GENERATED_BODY()
 
#pragma region delegate declarations
public:
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FVoxtaMessageAudioPlaybackCompleted, const FGuid&, messageId);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FVoxtaMessageAudioChunkReadyForCustomPlayback, const TArray<uint8>&, rawBytes, const USoundWaveProcedural*, processedSoundWave, FGuid, audioChunkGuid);

    DECLARE_MULTICAST_DELEGATE_OneParam(FVoxtaMessageAudioPlaybackCompletedNative, const FGuid&);
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FVoxtaMessageAudioChunkReadyForCustomPlaybackNative, const TArray<uint8>&, const USoundWaveProcedural*, FGuid);
#pragma endregion
 
#pragma region events
public:
    UPROPERTY(BlueprintAssignable, Category = "Voxta", meta = (IsBindableEvent = "True"))
    FVoxtaMessageAudioPlaybackCompleted VoxtaMessageAudioPlaybackFinishedEvent;
    FVoxtaMessageAudioPlaybackCompletedNative VoxtaMessageAudioPlaybackFinishedEventNative;

    UPROPERTY(BlueprintAssignable, Category = "Voxta", meta = (IsBindableEvent = "True"))
    FVoxtaMessageAudioChunkReadyForCustomPlayback VoxtaMessageAudioChunkReadyForCustomPlaybackEvent;

    FVoxtaMessageAudioChunkReadyForCustomPlaybackNative VoxtaMessageAudioChunkReadyForCustomPlaybackEventNative;
#pragma endregion
 
#pragma region public API
public:
    UFUNCTION(BlueprintCallable, Category = "Voxta")
    void Initialize(const FGuid& characterId);

    void Initialize(const FGuid& characterId, LipSyncType lipSyncType);

    UFUNCTION(BlueprintCallable, Category = "Voxta")
    void MarkAudioChunkCustomPlaybackComplete(const FGuid& guid);

    virtual void PlaybackMessage(const FBaseCharData& sender, const FChatMessage& message);

    LipSyncType GetLipSyncType() const;
#pragma endregion
 
#pragma region IA2FWeightProvider overrides
public:
    virtual void GetA2FCurveWeightsPreUpdate(TArray<float>& targetArrayRef) override;
#pragma endregion
 
#pragma region UActorComponent overrides
protected:
    virtual void BeginPlay() override;

    virtual void EndPlay(const EEndPlayReason::Type endPlayReason) override;
#pragma endregion
 
#pragma region private helper classes
private:
    enum class AudioPlaybackInternalState : uint8
    {
        Idle,
        Playing,
        Done
    };
#pragma endregion
 
#pragma region data
protected:
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Voxta", meta = (AllowPrivateAccess = "true", DisplayName = "Lipsync Type"))
    LipSyncType m_lipSyncType = LipSyncType::None;
    FGuid m_characterId;
    UVoxtaClient* m_clientReference;
 
private:
    // TODO: use interface so we don't have to cast to cast to UAudio2FacePlaybackHandler or
    // UOVRLipSyncPlaybackActorComponent everytime
    UPROPERTY()
    UObject* m_lipSyncHandler;
 
    FGuid m_currentlyPlayingMessageId;
    TArray<TSharedPtr<MessageChunkAudioContainer>> m_orderedAudio;
 
    FDelegateHandle m_playbackFinishedHandle;
 
    FString m_hostAddress;
    int m_hostPort;
    AudioPlaybackInternalState m_internalState;
    int m_currentAudioClipIndex = 0;
#pragma endregion
 
#pragma region private API
protected:
    void InitializeInternal(bool autoRegisterHandler = true);
 
private:
    void PlayCurrentAudioChunkIfAvailable();

    UFUNCTION()
    void OnAudioPlaybackFinished(UAudioComponent* component);

    void MarkAudioChunkPlaybackCompleteInternal();

    void OnChunkStateChange(const MessageChunkAudioContainer* finishedChunk);

    void Cleanup();
#pragma endregion
};