CNFB.h

Go to the documentation of this file.

// Copyright. 2019 - 2024 PSBD. All rights reserved.
 
#pragma once
 
#include "Capsule/CDefinesPrivate.h"
#include "Capsule/CError.h"
#include "Capsule/CNFBCalibrator.h"
#include "Capsule/CSession.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum clCNFBCallResult {
    clC_NFB_Success,           
    clC_NFB_NotInitialized,    
    clC_NFB_ModelIsNotTrained, 
    clC_NFB_ModelIsTrained,    
    clC_NFB_FailedToSendData   
} clCNFBCallResult;
 
typedef enum ccCNFBState {
    cc_NFB_Undefined,
    cc_NFB_Relaxation,
    cc_NFB_Concentration
} ccCNFBState;
 
typedef struct clCNFBUserState {
    const float* feedbackData;
    uint64_t feedbackSize;
    int64_t timestamp;
} clCNFBUserState;
 
CLC_CLASS_WN(ClassificationNFBPrivate, clCNFB);
CLC_STRUCT(clCNFBDelegateNFBUserState);
typedef void (*clCNFBHandlerNFBUserState)(clCNFB, const clCNFBUserState*);
CL_DLL void clCNFBDelegateNFBUserState_Set(clCNFBDelegateNFBUserState delegate,
                                           clCNFBHandlerNFBUserState callback) NOEXCEPT;
CL_DLL clCNFB clCNFB_Create(clCSession session) NOEXCEPT;
CL_DLL void clCNFB_Destroy(clCNFB nfb) NOEXCEPT;
 
CLC_STRUCT(clCNFBDelegate);
typedef void (*clCNFBHandler)(clCNFB);
CL_DLL void clCNFBDelegate_Set(clCNFBDelegate delegate, clCNFBHandler callback) NOEXCEPT;
 
CLC_STRUCT(clCNFBDelegateBool);
typedef void (*clCNFBHandlerBool)(clCNFB, bool);
CL_DLL void clCNFBDelegateBool_Set(clCNFBDelegateBool delegate,
                                   clCNFBHandlerBool callback) NOEXCEPT;
 
CLC_STRUCT(clCNFBDelegateString);
typedef void (*clCNFBHandlerString)(clCNFB, const char*);
CL_DLL void clCNFBDelegateString_Set(clCNFBDelegateString delegate,
                                     clCNFBHandlerString callback) NOEXCEPT;
 
CL_DLL clCNFBDelegate clCNFB_GetOnInitializedEvent(clCNFB nfb) NOEXCEPT;
CL_DLL clCNFBDelegate clCNFB_GetOnModelTrainedEvent(clCNFB nfb) NOEXCEPT;
CL_DLL clCNFBDelegateBool clCNFB_GetOnResetEvent(clCNFB nfb) NOEXCEPT;
CL_DLL clCNFBDelegateNFBUserState clCNFB_GetOnUserStateChangedEvent(clCNFB nfb) NOEXCEPT;
CL_DLL clCNFBDelegateString clCNFB_GetOnErrorEvent(clCNFB nfb) NOEXCEPT;
 
CL_DLL clCNFBCallResult clCNFB_Initialize(clCNFB nfb) NOEXCEPT;
CL_DLL clCNFBCallResult clCNFB_InitializeWithPeriod(clCNFB nfb, float userStatePeriod) NOEXCEPT;
CL_DLL clCNFBCallResult clCNFB_AddFeedbackFunction(clCNFB nfb, const char* feedbackFunction) NOEXCEPT;
 
CL_DLL clCNFBCallResult clCNFB_Train(clCNFB nfb) NOEXCEPT;
CL_DLL clCNFBCallResult clCNFB_Reset(clCNFB nfb) NOEXCEPT;
 
CL_DLL bool clCNFB_IsInitialized(clCNFB nfb) NOEXCEPT;
CL_DLL bool clCNFB_IsModelTrained(clCNFB nfb) NOEXCEPT;
 
CL_DLL clCNFB clCNFB_CreateCalibrated(clCNFBCalibrator calibrator, clCError* error) NOEXCEPT;
 
// DEPRECATED
CL_DLL clCNFBCallResult clCNFB_MarkState(clCNFB nfb, ccCNFBState userState) NOEXCEPT;
 
#ifdef __cplusplus
}
#endif