CNFBCalibrator.h

Go to the documentation of this file.

// Copyright. 2019 - 2024 PSBD. All rights reserved.
 
#pragma once
 
#include "Capsule/CDefinesPrivate.h"
#include "Capsule/CSession.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
CLC_CLASS_WN(NFBCalibratorPrivate, clCNFBCalibrator);
 
CL_DLL clCNFBCalibrator clCNFBCalibrator_CreateOrGet(clCSession session) NOEXCEPT;
 
typedef enum clCIndividualNFBCalibrationStage {
    clCIndividualNFBCalibrationStage1,
    clCIndividualNFBCalibrationStage2,
    clCIndividualNFBCalibrationStage3,
    clCIndividualNFBCalibrationStage4,
} clCIndividualNFBCalibrationStage;
CL_DLL void clCNFBCalibrator_CalibrateIndividualNFB(clCNFBCalibrator nfbCalibrator,
                                                    clCIndividualNFBCalibrationStage stage,
                                                    clCError* error) NOEXCEPT;
 
CL_DLL void clCNFBCalibrator_CalibrateIndividualNFBQuick(clCNFBCalibrator nfbCalibratorPtr,
                                                         clCError* error) NOEXCEPT;
 
CLC_STRUCT(clCNFBCalibratorDelegateIndividualNFBCalibrationStage);
typedef void (*clCNFBCalibratorHandlerIndividualNFBCalibrationStage)(clCNFBCalibrator);
CL_DLL void clCNFBCalibratorDelegateIndividualNFBCalibrationStage_Set(
    clCNFBCalibratorDelegateIndividualNFBCalibrationStage delegate,
    clCNFBCalibratorHandlerIndividualNFBCalibrationStage handler) NOEXCEPT;
CL_DLL clCNFBCalibratorDelegateIndividualNFBCalibrationStage
clCNFBCalibrator_GetOnIndividualNFBStageFinishedEvent(clCNFBCalibrator nfbCalibrator) NOEXCEPT;
 
struct clCIndividualNFBData {
    float individualFrequency = 0.0f;
    float individualPeakFrequency = 0.0f;
    float individualPeakFrequencyPower = 0.0f;
    float individualPeakFrequencySuppression = 0.0f;
    float individualBandwidth = 0.0f;
    float individualNormalizedPower = 0.0f;
    float lowerFrequency = 0.0f;
    float upperFrequency = 0.0f;
};
 
typedef enum clCIndividualNFBCalibrationFailReason {
    clC_IndividualNFBCalibrationFailReason_None = 0,
    clC_IndividualNFBCalibrationFailReason_TooManyArtifacts,
    clC_IndividualNFBCalibrationFailReason_PeakIsABorder,
} clCIndividualNFBCalibrationFailReason;
 
CLC_STRUCT(clCNFBCalibratorDelegateIndividualNFBCalibrated);
typedef void (*clCNFBCalibratorHandlerIndividualNFBCalibrated)(
    clCNFBCalibrator, const clCIndividualNFBData*, clCIndividualNFBCalibrationFailReason);
CL_DLL void clCNFBCalibratorDelegateIndividualNFBCalibrated_Set(
    clCNFBCalibratorDelegateIndividualNFBCalibrated delegate,
    clCNFBCalibratorHandlerIndividualNFBCalibrated handler) NOEXCEPT;
CL_DLL clCNFBCalibratorDelegateIndividualNFBCalibrated
clCNFBCalibrator_GetOnIndividualNFBCalibratedEvent(clCNFBCalibrator nfbCalibrator) NOEXCEPT;
 
CL_DLL bool clCNFBCalibrator_IsCalibrated(clCNFBCalibrator nfbCalibrator) NOEXCEPT;
CL_DLL bool clCNFBCalibrator_HasCalibrationFailed(clCNFBCalibrator nfbCalibrator) NOEXCEPT;
 
CL_DLL bool clCNFBCalibrator_IsReady(clCNFBCalibrator nfbCalibrator) NOEXCEPT;
 
CLC_STRUCT(clCNFBCalibratorDelegateReadyToCalibrate);
typedef void (*clCNFBCalibratorHandlerReadyToCalibrate)(clCNFBCalibrator);
CL_DLL void clCNFBCalibratorDelegateReadyToCalibrate_Set(
    clCNFBCalibratorDelegateReadyToCalibrate delegate,
    clCNFBCalibratorHandlerReadyToCalibrate handler) NOEXCEPT;
CL_DLL clCNFBCalibratorDelegateReadyToCalibrate
clCNFBCalibrator_GetOnReadyToCalibrate(clCNFBCalibrator nfbCalibrator) NOEXCEPT;
 
#ifdef __cplusplus
}
#endif