VoxtaAudioInput.h

Go to the documentation of this file.

// Copyright(c) 2024 grrimgrriefer & DZnnah, see LICENSE for details.
 
#pragma once
 
#include "CoreMinimal.h"
#include "VoxtaData/Public/VoxtaMicrophoneState.h"
#include "VoxtaAudioUtility/Public/AudioCaptureHandler.h"
#include "AudioWebSocket.h"  
#include "VoxtaAudioInput.generated.h"
 
class UVoxtaClient;

UCLASS(Category = "Voxta")
class UNREALVOXTA_API UVoxtaAudioInput : public UObject
{
    GENERATED_BODY()
 
#pragma region delegate declarations
public:
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FVoxtaAudioInputStateChanged, VoxtaMicrophoneState, newState);
    DECLARE_MULTICAST_DELEGATE_OneParam(FVoxtaAudioInputStateChangedNative, VoxtaMicrophoneState);
#pragma endregion
 
#pragma region events
public:
    UPROPERTY(BlueprintAssignable, Category = "Voxta", meta = (IsBindableEvent = "True"))
    FVoxtaAudioInputStateChanged VoxtaAudioInputStateChangedEvent;
    FVoxtaAudioInputStateChangedNative VoxtaAudioInputStateChangedEventNative;
#pragma endregion
 
#pragma region public API
public:
    void InitializeSocket(int bufferMs = 200, int sampleRate = 16000, int inputChannels = 1);

    void Cleanup();

    bool IsInitialized() const;

    void ConnectToCurrentChat();

    void DisconnectFromChat();

    UFUNCTION(BlueprintCallable, Category = "Voxta")
    void StartAudioTesting(int sampleRate = 16000, int inputChannels = 1);

    UFUNCTION(BlueprintCallable, Category = "Voxta")
    void StopAudioTesting();

    UFUNCTION(BlueprintCallable, Category = "Voxta")
    void StartStreaming(bool isTestMode = false);

    UFUNCTION(BlueprintCallable, Category = "Voxta")
    void StopStreaming();

    UFUNCTION(BlueprintCallable, Category = "Voxta")
    VoxtaMicrophoneState GetCurrentState() const;

    UFUNCTION(BlueprintPure, Category = "Voxta")
    bool IsRecording() const;

    UFUNCTION(BlueprintPure, Category = "Voxta")
    bool IsInputSilent() const;

    UFUNCTION(BlueprintCallable, Category = "Voxta")
    float GetInputDecibels() const;

    UFUNCTION(BlueprintCallable, Category = "Voxta")
    const FString& GetInputDeviceName() const;

    UFUNCTION(BlueprintCallable, Category = "Voxta")
    void ConfigureSilenceThresholds(float micNoiseGateThreshold, float silenceDetectionThreshold, float micInputGain);
#pragma endregion
 
#pragma region UObject overrides
    virtual void BeginDestroy() override;
#pragma endregion
 
#pragma region data
private:
    UPROPERTY(BlueprintReadOnly, Category = "Voxta", meta = (AllowPrivateAccess = "true", DisplayName = "Current Mic Noise Gate Threshold"))
    float m_micNoiseGateThreshold = 0.001f;
 
    UPROPERTY(BlueprintReadOnly, Category = "Voxta", meta = (AllowPrivateAccess = "true", DisplayName = "Current Silence Detection Threshold"))
    float m_silenceDetectionThreshold = 0.001f;
 
    UPROPERTY(BlueprintReadOnly, Category = "Voxta", meta = (AllowPrivateAccess = "true", DisplayName = "Current Mic Input Gain"))
    float m_micInputGain = 6.f;
 
    int m_bufferMs = 0;
    int m_sampleRate = 0;
    int m_inputChannels = 0;
 
    UPROPERTY()
    UVoxtaClient* m_voxtaClient = nullptr;
 
    AudioCaptureHandler m_audioCaptureDevice;
    TSharedPtr<AudioWebSocket> m_audioWebSocket = nullptr;
    VoxtaMicrophoneState m_connectionState = VoxtaMicrophoneState::Uninitialized;
 
    FDelegateHandle m_connectedHandle;
    FDelegateHandle m_connectionErrorHandle;
    FDelegateHandle m_closedHandle;
#pragma endregion
 
#pragma region private API
private:
    void ChatSessionHandshake();
 
    void UpdateConnectionState(VoxtaMicrophoneState newState);
 
#pragma region IWebSocket listeners
private:
    void OnSocketConnected();
    void OnSocketConnectionError(const FString& error);
    void OnSocketClosed(int statusCode, const FString& reason, bool wasClean);
#pragma endregion
#pragma endregion
};