VoiceCapture.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "VoicePackage.h"
#include "DSP/MultithreadedPatching.h"
 
class Error;
 
namespace EVoiceCaptureState
{
    enum Type
    {
        UnInitialized,
        NotCapturing,
        Ok,
        NoData,
        Stopping,
        BufferTooSmall,
        Error
    };
 
    inline const TCHAR* ToString(EVoiceCaptureState::Type VoiceCaptureState)
    {
        switch (VoiceCaptureState)
        {
        case UnInitialized:
            {
                return TEXT("Uninitialized");
            }
        case NotCapturing:
            {
                return TEXT("Not Capturing");
            }
        case Ok:
            {
                return TEXT("Ok");
            }
        case NoData:
            {
                return TEXT("No Data");
            }
        case Stopping:
            {
                return TEXT("Stopping");
            }
        case BufferTooSmall:
            {
                return TEXT("BufferTooSmall");
            }
        case Error:
            {
                return TEXT("Error");
            }
        }
        return TEXT("");
    }
}
 
class IVoiceCapture : public TSharedFromThis<IVoiceCapture>
{
 
protected:
 
    IVoiceCapture() {};
 
    Audio::FPatchSplitter MicrophoneOutput;
 
public:
    
    virtual ~IVoiceCapture() {}
 
    virtual bool Init(const FString& DeviceName, int32 SampleRate, int32 NumChannels) = 0;
 
    virtual void Shutdown() = 0;
 
    virtual bool Start() = 0;
 
    virtual void Stop() = 0;
 
    virtual bool ChangeDevice(const FString& DeviceName, int32 SampleRate, int32 NumChannels) = 0;
 
    virtual bool IsCapturing() = 0;
 
    virtual EVoiceCaptureState::Type GetCaptureState(uint32& OutAvailableVoiceData) const = 0;
 
    virtual EVoiceCaptureState::Type GetVoiceData(uint8* OutVoiceBuffer, uint32 InVoiceBufferSize, uint32& OutAvailableVoiceData) { return EVoiceCaptureState::UnInitialized; };
    virtual EVoiceCaptureState::Type GetVoiceData(uint8* OutVoiceBuffer, uint32 InVoiceBufferSize, uint32& OutAvailableVoiceData, uint64& OutSampleCounter) { return GetVoiceData(OutVoiceBuffer, InVoiceBufferSize, OutAvailableVoiceData); };
 
    virtual int32 GetBufferSize() const = 0;
 
    virtual void DumpState() const = 0;
 
    Audio::FPatchOutputStrongPtr GetMicrophoneAudio(int32 MaxExpectedLatencyInSamples, float Gain)
    {
        return MicrophoneOutput.AddNewPatch(MaxExpectedLatencyInSamples, Gain);
    }
 
    virtual float GetCurrentAmplitude() const
    {
        return -1.0f;
    }
};