VoiceCaptureWindows.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Interfaces/VoiceCapture.h"
#include "VoicePackage.h"
#include "VoiceDelayBuffer.h"
#include "DSP/EnvelopeFollower.h"
#include "Containers/Ticker.h"
#include "Windows/WindowsHWrapper.h"
#include "SampleBuffer.h"
 
typedef struct IDirectSound8 *LPDIRECTSOUND8;
 
class IVoiceCapture;
class FVoiceCaptureWindows;
struct FVoiceCaptureWindowsVars;
 
class FVoiceCaptureDeviceWindows
{
private:
 
    static FVoiceCaptureDeviceWindows* Singleton;
    TArray<IVoiceCapture*> ActiveVoiceCaptures;
    bool bInitialized;
 
    bool Init();
    void Shutdown();
 
PACKAGE_SCOPE:
 
    static FVoiceCaptureDeviceWindows* Create();
    static void Destroy();
    void FreeVoiceCaptureObject(IVoiceCapture* VoiceCaptureObj);
 
public:
 
    struct FCaptureDeviceInfo
    {
        FString DeviceName;
        GUID DeviceId;
        bool bIsDefault;
    };
 
    LPDIRECTSOUND8 DirectSound;
 
    FString HMDAudioInputDevice;
    FCaptureDeviceInfo DefaultVoiceCaptureDevice;
 
    TMap<FString, FCaptureDeviceInfo> Devices;
 
    FVoiceCaptureDeviceWindows();
    ~FVoiceCaptureDeviceWindows();
 
    FVoiceCaptureWindows* CreateVoiceCaptureObject(const FString& DeviceName, int32 SampleRate, int32 NumChannels);
 
    static FVoiceCaptureDeviceWindows* Get();
};
 
class FVoiceCaptureWindows : public IVoiceCapture, public FTSTickerObjectBase
{
public:
 
    FVoiceCaptureWindows();
    ~FVoiceCaptureWindows();
 
    // IVoiceCapture
    virtual bool Init(const FString& DeviceName, int32 SampleRate, int32 NumChannels) override;
    virtual void Shutdown() override;
    virtual bool Start() override;
    virtual void Stop() override;
    virtual bool ChangeDevice(const FString& DeviceName, int32 SampleRate, int32 NumChannels) override;
    virtual bool IsCapturing() override;
    virtual EVoiceCaptureState::Type GetCaptureState(uint32& OutAvailableVoiceData) const override;
    virtual EVoiceCaptureState::Type GetVoiceData(uint8* OutVoiceBuffer, uint32 InVoiceBufferSize, uint32& OutAvailableVoiceData) override;
    virtual EVoiceCaptureState::Type GetVoiceData(uint8* OutVoiceBuffer, uint32 InVoiceBufferSize, uint32& OutAvailableVoiceData, uint64& OutSampleCounter) override;
    virtual int32 GetBufferSize() const override;
    virtual void DumpState() const override;
    virtual float GetCurrentAmplitude() const override;
 
    // FTSTickerObjectBase
    virtual bool Tick(float DeltaTime) override;
    
private:
 
    FVoiceCaptureWindowsVars* CV;
    double LastCaptureTime;
    EVoiceCaptureState::Type VoiceCaptureState;
    TArray<uint8> UncompressedAudioBuffer;
    uint64 SampleCounter; 
    uint64 CachedSampleStart;
    uint64 CurrentSampleStart;
 
    bool bSampleStartCached;
 
    int32 NumInputChannels;
 
    Audio::TSampleBuffer<float> ConversionBuffer;
 
    FVoiceDelayBuffer<int16> LookaheadBuffer;
    /*
    * This buffer is used in case someone starts speaking again in the middle of a buffer
    * they were otherwise silent in.
    */
    FVoiceDelayBuffer<int16> ReleaseBuffer;
 
    /*
    * Envelope following DSP object.
    * Configured using the MicSilenceDetectionConfig namespace in VoiceConfig.h and the CVars defined in VoiceConfig.cpp.
    */
    Audio::FInlineEnvelopeFollower MicLevelDetector;
    /*
    * Whether the microphone level is above the threshold set 
    */
    bool bIsMicActive;
 
    Audio::FLinearEase NoiseGateAttenuator;
 
    bool bWasMicAboveNoiseGateThreshold;
 
    bool CreateCaptureBuffer(const FString& DeviceName, int32 SampleRate, int32 NumChannels);
 
    void FreeCaptureBuffer();
 
    void ProcessData();
    bool CreateNotifications(uint32 BufferSize);
};