Playthrough.h

// Copyright 2022 Charisma Entertainment Ltd

#pragma once

#include "CharismaEvents.h"
#include "Client.h"
#include "CoreMinimal.h"
#include "Engine/EngineTypes.h"
#include "Interfaces/IHttpResponse.h"
#include "Math/UnrealMathUtility.h"
#include "MicrophoneCapture.h"
#include "Room.h"
#include "UObject/NoExportTypes.h"

#include "Playthrough.generated.h"

UENUM(BlueprintType, Category = "Charisma|Playthrough")
enum class ECharismaSpeechAudioFormat : uint8
{
	None UMETA(DisplayName = "No speech"),
	Mp3 UMETA(DisplayName = "mp3"),
	Wav UMETA(DisplayName = "wav"),
	Pcm UMETA(DisplayName = "pcm"),
	Ogg UMETA(DisplayName = "ogg")
};

UENUM(BlueprintType, Category = "Charisma|Playthrough")
enum class ECharismaSpeechRecognitionAWSLanguageCode : uint8
{
	DE_DE UMETA(DisplayName = "de-DE"),
	EN_AU UMETA(DisplayName = "en-AU"),
	EN_GB UMETA(DisplayName = "en-GB"),
	EN_US UMETA(DisplayName = "en-US"),
	ES_US UMETA(DisplayName = "es-US"),
	FR_CA UMETA(DisplayName = "fr-CA"),
	FR_FR UMETA(DisplayName = "fr-FR"),
	IT_IT UMETA(DisplayName = "it-IT"),
	JA_JP UMETA(DisplayName = "ja-JP"),
	KO_KR UMETA(DisplayName = "ko-KR"),
	PT_BR UMETA(DisplayName = "pt-BR"),
	ZH_CN UMETA(DisplayName = "zh-CN"),
};

UENUM(BlueprintType, Category = "Charisma|Playthrough")
enum class ECharismaPlaythroughConnectionState : uint8
{
	Disconnected,
	Connecting,
	Reconnecting,
	Connected,
};

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FMessageHistoryDelegate, const FCharismaMessageHistoryResponse&, MessageHistory);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FPlaythroughInfoDelegate, const FCharismaPlaythroughInfoResponse&, PlaythroughInfo);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FChangeConnectionStateDelegate, ECharismaPlaythroughConnectionState, PreviousConnectionState,
	ECharismaPlaythroughConnectionState, ConnectionState);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FTypingDelegate, bool, IsTyping);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FMessageDelegate, const FCharismaMessageEvent&, MessageEvent);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FErrorDelegate, const FCharismaErrorEvent&, ErrorEvent);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FPingSuccessDelegate);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FPingFailureDelegate);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FSpeechRecognitionResultDelegate, const FString&, Transcript, bool, IsFinal);

UCLASS(ClassGroup = (Custom), meta = (BlueprintSpawnableComponent))
class CHARISMAMODULE_API UPlaythrough : public UObject
{
	GENERATED_BODY()

public:
	UPlaythrough();
	~UPlaythrough();

	// Member

	UFUNCTION(BlueprintCallable, meta = (WorldContext = "WorldContextObject"), Category = "Charisma|Playthrough")
	static UPlaythrough* NewPlaythroughObject(UObject* WorldContextObject, const FString& Token, const FString& PlaythroughUuid);

	static const nlohmann::json SdkInfo;

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough")
	void Connect();

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough")
	void Disconnect();

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void Action(const FString& ConversationUuid, const FString& ActionName) const;

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void Start(const FString& ConversationUuid, const int32 SceneIndex, const int32 StartGraphId,
		const FString& StartGraphReferenceId,
		const ECharismaSpeechAudioFormat SpeechAudioFormat = ECharismaSpeechAudioFormat::None);

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void Reply(const FString& ConversationUuid, const FString& Message) const;

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void Resume(const FString& ConversationUuid) const;

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void Tap(const FString& ConversationUuid) const;

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void ToggleSpeech(const ECharismaSpeechAudioFormat AudioFormat);

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void Play() const;

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void Pause() const;

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void StartSpeechRecognition(const ECharismaSpeechRecognitionAWSLanguageCode LanguageCode, bool& bWasSuccessful);

	UFUNCTION(BlueprintCallable, Category = "Charisma|Playthrough Events")
	void StopSpeechRecognition();

	// Events

	UPROPERTY(BlueprintAssignable, Category = "Charisma|Playthrough Events")
	FChangeConnectionStateDelegate OnChangeConnectionState;

	UPROPERTY(BlueprintAssignable, Category = "Charisma|Playthrough Events")
	FMessageDelegate OnMessage;

	UPROPERTY(BlueprintAssignable, Category = "Charisma|Playthrough Events")
	FErrorDelegate OnError;

	UPROPERTY(BlueprintAssignable, Category = "Charisma|Playthrough Events")
	FTypingDelegate OnTyping;

	UPROPERTY(BlueprintAssignable, Category = "Charisma|Playthrough Events")
	FPingSuccessDelegate OnPingSuccess;

	UPROPERTY(BlueprintAssignable, Category = "Charisma|Playthrough Events")
	FPingFailureDelegate OnPingFailure;

	UPROPERTY(BlueprintAssignable, Category = "Charisma|Playthrough Events")
	FSpeechRecognitionResultDelegate OnSpeechRecognitionResult;

	UPROPERTY(BlueprintReadWrite, Category = "Charisma|Playthrough")
	TArray<FCharismaEmotion> PlaythroughEmotions;

	UPROPERTY(BlueprintReadWrite, Category = "Charisma|Playthrough")
	TArray<FCharismaMemory> PlaythroughMemories;

	UPROPERTY(BlueprintReadWrite, Category = "Charisma|Playthrough")
	float TimeBetweenPings = 2.0f;

	UPROPERTY(BlueprintReadWrite, Category = "Charisma|Playthrough")
	uint8 MinimumPingsToConsiderFailed = 3;

private:
	UFUNCTION()
	void ReconnectionFlow();

	UFUNCTION()
	void ReconnectionFlowCreate();

	UFUNCTION()
	void ReconnectionDelay();

	UFUNCTION()
	void FirePing();

	UFUNCTION()
	void ChangeConnectionState(ECharismaPlaythroughConnectionState NewConnectionState);

	// Member

	SpeechConfig GetSpeechConfig(const ECharismaSpeechAudioFormat AudioFormat) const;

	void OnRoomJoined(TSharedPtr<Room<void>> Room);

	// Properties

	TSharedPtr<Client> ClientInstance;

	TSharedPtr<Room<void>> RoomInstance;

	FString CurToken;

	FString CurPlaythroughUuid;

	UObject* CurWorldContextObject;

	uint8 PingCount = 0;

	FTimerHandle PingTimerHandle;

	uint8 ReconnectionTryCount = 0;

	float ReconnectionTryDelay = 5.0f;

	float ReconnectionTryJitter = 3.0f;

	bool bCalledByDisconnect = false;

	ECharismaPlaythroughConnectionState ConnectionState = ECharismaPlaythroughConnectionState::Disconnected;

	ECharismaSpeechAudioFormat SpeechAudioFormat = ECharismaSpeechAudioFormat::None;

	TSharedPtr<UMicrophoneCapture> MicrophoneCaptureInstance;
};