krisp-audio-sdk-nc.hpp

 
#pragma once
 
#include <memory>
#include <type_traits>
#include <vector>
 
#include "krisp-audio-api-definitions.hpp"
 
namespace Krisp::AudioSdk
{
template <typename FrameDataType>
class NcSession;
 
struct RingtoneCfg
{
    ModelInfo modelInfo;
};
 
struct NcSessionConfig
{
    SamplingRate inputSampleRate;
 
    FrameDuration inputFrameDuration;
 
    SamplingRate outputSampleRate;
 
    ModelInfo* modelInfo;
 
    bool enableSessionStats;
 
    RingtoneCfg* ringtoneCfg = nullptr;
};
 
struct BvcConfig
{
    std::vector<std::string> allowList;
 
    std::vector<std::string> blockList;
 
    std::string deviceName;
 
    bool forceBvcForUnknownDevice;
};
 
struct NcSessionConfigWithAutoModelSelect
{
    SamplingRate inputSampleRate;
 
    FrameDuration inputFrameDuration;
 
    SamplingRate outputSampleRate;
 
    std::vector<ModelInfo> modelInfoList;
 
    bool enableSessionStats;
 
    BvcConfig* bvcConfig = nullptr;
};
 
struct EnergyInfo
{
    uint8_t voiceEnergy;
 
    uint8_t noiseEnergy;
};
 
enum class CleanedSecondarySpeechStatus
{
    Undefined = 0,
 
    Detected = 1,
 
    NotDetected = 2
};
 
struct PerFrameStats
{
    EnergyInfo energy;
 
    //  Undefined will be returned in case of running the NC.
    CleanedSecondarySpeechStatus cleanedSecondarySpeechStatus;
};
 
struct VoiceStats
{
    uint32_t talkTimeMs;
};
 
struct NoiseStats
{
    uint32_t noNoiseMs;
 
    uint32_t lowNoiseMs;
 
    uint32_t mediumNoiseMs;
 
    uint32_t highNoiseMs;
 
    uint32_t cleanedSecondarySpeechMs;
 
    uint32_t cleanedSecondarySpeechNotDetectedMs;
 
    uint32_t cleanedSecondarySpeechUndefinedMs;
};
 
struct SessionStats
{
    VoiceStats voiceStats;
 
    NoiseStats noiseStats;
};
 
template <typename FrameDataType>
class KRISP_AUDIO_API Nc
{
    static_assert(std::is_same<FrameDataType, float>::value || std::is_same<FrameDataType, int16_t>::value,
                  "FrameDataType must be either float or int16_t");
public:
    virtual ~Nc();
 
    static std::shared_ptr<Nc<FrameDataType>> create(const NcSessionConfig& config);
 
    static std::shared_ptr<Nc<FrameDataType>> create(const NcSessionConfigWithAutoModelSelect& config);
 
    void process(
        const FrameDataType* inputSamples,
        size_t numInputSamples,
        FrameDataType* outputSamples,
        size_t numOutputSamples,
        float noiseSuppressionLevel = 100,
        PerFrameStats* frameStats = nullptr);
 
    void getSessionStats(SessionStats* stats);
 
private:
    std::shared_ptr<NcSession<FrameDataType>> _session;
};
 
} // namespace Krisp::AudioSdk