Iedk.h

Go to the documentation of this file.

#ifndef IEDK_H
#define IEDK_H

#ifdef __cplusplus
extern "C" {
#endif

#if (!EDK_STATIC_LIB)
#   ifdef EDK_EXPORTS
#       ifdef _WIN32
#           define EDK_API __declspec(dllexport)
#       else
#           if (defined __GNUC__ && __GNUC__ >= 4) || defined __INTEL_COMPILER || defined __clang__
#               define EDK_API __attribute__ ((visibility("default")))
#           else
#               define EDK_API
#           endif
#       endif
#   else
#       ifdef _WIN32
#           define EDK_API __declspec(dllimport)
#       else
#           define EDK_API
#       endif
#   endif
#else
#   include "IEmotivProfile.h"
#   include "IEmoStatePerformanceMetric.h"
#   include "IedkOptimization.h"
#   define EDK_API extern
#endif

#include "IedkErrorCode.h"
#include "IEmoStateDLL.h"
#include "FacialExpressionDetection.h"
#include "MentalCommandDetection.h"



    typedef void* EmoStateHandle;



    typedef void* EmoEngineEventHandle;

    
    typedef enum IEE_DataChannels_enum {
        IED_COUNTER = 0,        
        IED_INTERPOLATED,       
        IED_RAW_CQ,             
        IED_AF3,                
        IED_F7,                 
        IED_F3,                 
        IED_FC5,                
        IED_T7,                 
        IED_P7,                 
        IED_Pz,                 
        IED_O1 = IED_Pz,        
        IED_O2,                 
        IED_P8,                 
        IED_T8,                 
        IED_FC6,                
        IED_F4,                 
        IED_F8,                 
        IED_AF4,                
        IED_GYROX,              
        IED_GYROY,              
        IED_TIMESTAMP,          
        IED_ES_TIMESTAMP,       
        IED_FUNC_ID,            
        IED_FUNC_VALUE,         
        IED_MARKER,             
        IED_SYNC_SIGNAL         
    } IEE_DataChannel_t;

    

    typedef void* DataHandle;


    typedef enum IEE_Event_enum {
        IEE_UnknownEvent          = 0x0000,     
        IEE_EmulatorError         = 0x0001,     
        IEE_ReservedEvent         = 0x0002,     
        IEE_UserAdded             = 0x0010,     
        IEE_UserRemoved           = 0x0020,     
        IEE_EmoStateUpdated       = 0x0040,     
        IEE_ProfileEvent          = 0x0080,     
        IEE_MentalCommandEvent    = 0x0100,     
        IEE_FacialExpressionEvent = 0x0200,     
        IEE_InternalStateChanged  = 0x0400,     
        IEE_AllEvent              = IEE_UserAdded | IEE_UserRemoved | IEE_EmoStateUpdated |
                                    IEE_ProfileEvent | IEE_MentalCommandEvent |
                                    IEE_FacialExpressionEvent | IEE_InternalStateChanged
    } IEE_Event_t;


    typedef struct IInputSensorDescriptor_struct {
        IEE_InputChannels_t channelId;  
        int                 fExists;    
        const char*         pszLabel;   
        double              xLoc;       
        double              yLoc;       
        double              zLoc;       
    } IInputSensorDescriptor_t;


    typedef enum IEE_Detection_enum {
        DT_BlinkAndWink     = 0x0001,   
        DT_FacialExpression = 0x0002,   
        DT_EyeMovement      = 0x0004,   
        DT_Excitement       = 0x0008,   
        DT_Engagement       = 0x0010,   
        DT_Relaxation       = 0x0020,   
        DT_Interest         = 0x0040,   
        DT_Stress           = 0x0080,   
        DT_Focus            = 0x0100,   
        DT_MentalCommand    = 0x0200,   
        DT_AllDetections    = (DT_BlinkAndWink | DT_FacialExpression | DT_EyeMovement |
                               DT_Excitement | DT_Engagement | DT_Relaxation |
                               DT_Interest | DT_Stress | DT_Focus |
                               DT_MentalCommand)

    } IEE_Detection_t;


    typedef enum IEE_MotionDataChannel_enum {
        IMD_COUNTER = 0,        
        IMD_GYROX,              
        IMD_GYROY,              
        IMD_GYROZ,              
        IMD_ACCX,               
        IMD_ACCY,               
        IMD_ACCZ,               
        IMD_MAGX,               
        IMD_MAGY,               
        IMD_MAGZ,               
        IMD_TIMESTAMP           
    } IEE_MotionDataChannel_t;
    
    
    typedef enum IEE_WindowingTypes_enum {
        IEE_HANNING   = 0,      
        IEE_HAMMING   = 1,      
        IEE_HANN      = 2,      
        IEE_BLACKMAN  = 3,      
        IEE_RECTANGLE = 4       
    } IEE_WindowingTypes;
    
    

    EDK_API int
        IEE_EngineConnect(const char* strDevID = "Emotiv Systems-5");

    

    EDK_API int
        IEE_EngineRemoteConnect(const char* szHost,
                                unsigned short port);
    


    EDK_API int
        IEE_EngineDisconnect();



    EDK_API int
        IEE_EnableDiagnostics(const char* szFilename,
                              int fEnable,
                              int nReserved);

    

    EDK_API EmoEngineEventHandle
        IEE_EmoEngineEventCreate();

    

    EDK_API void
        IEE_EmoEngineEventFree(EmoEngineEventHandle hEvent);

    

    EDK_API EmoStateHandle
        IEE_EmoStateCreate();

    

    EDK_API void
        IEE_EmoStateFree(EmoStateHandle hState);



    EDK_API IEE_Event_t
        IEE_EmoEngineEventGetType(EmoEngineEventHandle hEvent);



    EDK_API int
        IEE_EmoEngineEventGetUserId(EmoEngineEventHandle hEvent,
                                    unsigned int *pUserIdOut);



    EDK_API int
        IEE_EmoEngineEventGetEmoState(EmoEngineEventHandle hEvent,
                                      EmoStateHandle hEmoState);



    EDK_API int
        IEE_EngineGetNextEvent(EmoEngineEventHandle hEvent);



    EDK_API int
        IEE_EngineClearEventQueue(int eventTypes);



    EDK_API int
        IEE_EngineGetNumUser(unsigned int* pNumUserOut);



    EDK_API int
        IEE_SetHardwarePlayerDisplay(unsigned int userId,
                                     unsigned int playerNum);



    EDK_API int 
        IEE_GetHeadsetSettings(unsigned int userId, 
                               unsigned int* EPOCmode, 
                               unsigned int* eegRate, 
                               unsigned int* eegRes, 
                               unsigned int* memsRate, 
                               unsigned int* memsRes);



    EDK_API int 
        IEE_SetHeadsetSettings(unsigned int userId, 
                               unsigned int EPOCmode, 
                               unsigned int eegRate, 
                               unsigned int eegRes, 
                               unsigned int memsRate, 
                               unsigned int memsRes);



    EDK_API int
        IEE_HeadsetGetSensorDetails(IEE_InputChannels_t channelId,
                                    IInputSensorDescriptor_t* pDescriptorOut);



    EDK_API int
        IEE_HardwareGetVersion(unsigned int userId,
                               unsigned long* pHwVersionOut);


    EDK_API int
        IEE_SoftwareGetVersion(char* pszVersionOut,
                               unsigned int nVersionChars,
                               unsigned long* pBuildNumOut);



    EDK_API int
        IEE_HeadsetGetSerialNumber(unsigned int userId, 
                                    char** pHwSerialOut);



    EDK_API int
        IEE_HeadsetGetGyroDelta(unsigned int userId,
                                int* pXOut,
                                int* pYOut);



    EDK_API int
        IEE_HeadsetGyroRezero(unsigned int userId);


    //  This handle can be reused by the caller to retrieve subsequent data.
    EDK_API DataHandle
        IEE_MotionDataCreate();



    EDK_API void
        IEE_MotionDataFree(DataHandle hData);



    EDK_API int
        IEE_MotionDataUpdateHandle(unsigned int userId,
                                   DataHandle hData);



    EDK_API int
        IEE_MotionDataGet(DataHandle hData,
                          IEE_MotionDataChannel_t channel,
                          double buffer[],
                          unsigned int bufferSizeInSample);



    EDK_API int
        IEE_MotionDataGetMultiChannels(DataHandle hData,
                                       IEE_MotionDataChannel_t channels[],
                                       unsigned int nChannels,
                                       double* buffer[],
                                       unsigned int bufferSizeInSample);



    EDK_API int
        IEE_MotionDataGetNumberOfSample(DataHandle hData,
                                        unsigned int* nSampleOut);



    EDK_API int
        IEE_MotionDataSetBufferSizeInSec(float bufferSizeInSec);



    EDK_API int
        IEE_MotionDataGetBufferSizeInSec(float* pBufferSizeInSecOut);
    


    EDK_API int
        IEE_MotionDataGetSamplingRate(unsigned int userId,
                                      unsigned int* samplingRateOut);



    EDK_API void
        IEE_EnableDetections(unsigned long value);
    
    

    EDK_API void
        IEE_CheckDetectionsEnabled(unsigned long* result);

    

    EDK_API int
        IEE_GetAverageBandPowers(unsigned int userId, IEE_DataChannel_t channel,
                                 double* theta, double* alpha, double* low_beta, double* high_beta, double* gamma);

    

    EDK_API int
        IEE_FFTSetWindowingType(unsigned int userId, IEE_WindowingTypes type);
    


    EDK_API int
        IEE_FFTGetWindowingType(unsigned int userId, IEE_WindowingTypes *type);
    
    
    
#if defined(__APPLE__)
    

    EDK_API bool
        IEE_EmoInitDevice();
    
#endif
    
#if defined(__APPLE__) || defined(__ANDROID__)
    

    EDK_API int
        IEE_ConnectInsightDevice(int indexDevice);
    
    

    EDK_API void
        IEE_GetInsightSignalStrength(int* value, int indexDevice);
    
    

    EDK_API int
        IEE_GetInsightDeviceCount();
    
    

    EDK_API const char*
        IEE_GetInsightDeviceName(int index);

    

    EDK_API void
        IEE_GetInsightDeviceState(int* state, int index);

    

    EDK_API int
        IEE_ConnectEpocPlusDevice(int indexDevice, bool isSettingMode=false);
    
    

    EDK_API void
        IEE_GetEpocPlusSignalStrength(int* value, int indexDevice);
    
    

    EDK_API int
        IEE_GetEpocPlusDeviceCount();
    
    

    EDK_API const char*
        IEE_GetEpocPlusDeviceName(int index);

    

    EDK_API void
        IEE_GetEpocPlusDeviceState(int* state, int index);
    
#endif
    
#ifdef __cplusplus
}
#endif
#endif // IEDK_H