spc_ctrlr.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
// SpaceController-DLL - Copyright (c) Spacecontrol GmbH, D-82229 Seefeld
//------------------------------------------------------------------------------
//
//
// Erzeugt am 17. April 2007, 10:07
//
// Datum    Autor  Aenderung (neue Eintraege oben)
// -------- ------ -------------------------------------------------------------
// 17.04.07 fse    erzeugt
//------------------------------------------------------------------------------

#ifndef _spc_ctrlr_H
#define _spc_ctrlr_H

//------------------------------------------------------------------------------

#ifndef __cplusplus
#error spc_ctrlr.h is only for C++!
#endif

#ifdef _WIN32
        // SI_EXPORTING ist definiert, wenn wir die SiApp-DLL bauen, dann werden die
        // Funktionen aus sc_dll.cc statisch gelinkt, SC_API wird als leer definiert.
        // SC_EXPORTING ist definiert, wenn wir die SC-DLL bauen, dann werden die
        // Funktionen aus sc_dll.cc exportiert und koennen dynamisch gelinkt werden,
        // SC_API wird als __declspec(dllexport) definiert.
        // Wenn weder SI_EXPORTING noch SC_EXPORTING definiert sind, kann spc_ctrlr.h
        // von Applikationen inkludiert werden, die die SC-DLL dynamisch linken
        // wollen, SC_API wird als __declspec(dllimport) definiert.
        #ifdef SI_EXPORTING
                #define SC_API
        #else
                #ifdef SC_EXPORTING
                        #define SC_API __declspec(dllexport)
                #else
                        #define SC_API __declspec(dllimport)
                #endif
        #endif
        #include <winsock2.h> // ersetzt wg. Compiler-Warnung ...
//      #include <windows.h>  // ... "#warning Please include winsock2.h before windows.h"
#else
        #define SC_API         
        #ifdef __linux__
                #include <X11/Xlib.h>
        #endif
#endif

#include <string>
#include <vector>
#include "scDevPars.h"

class Message;

using namespace std;

//------------------------------------------------------------------------------

#define MIN_STD_MODE                   0                     
#define MAX_STD_MODE                   7                     
#define MIN_CMPR_MODE                  0                     
#define MAX_CMPR_MODE                119                     
#define MIN_PERIOD                     0                     
#define MAX_PERIOD                   405                     
#define MIN_SENS                       0                     
#define MAX_SENS                      15                     
#define MIN_NULL_RAD                   0                     
#define MAX_NULL_RAD                  15                     
#define MIN_BRIGHTNESS                 0                     
#define MAX_BRIGHTNESS                15                     
#define MIN_COLOR_VAL                  0                     
#define MAX_COLOR_VAL                255                     
#define MAX_AVE_NUM                   15                     
#define NO_BRGHT_CHANGE MAX_BRIGHTNESS+1                     
#define FORCE_SET_BRIGHTNESS          20                     
#define MIN_LMH_BND                    0                     
#define MAX_LMH_BND                 5000                     
#define RAW_DATA_LEN                  28                     
#define MAX_FRM_REC_DATA_LEN          83                     
#define RAM_PAGE_PART_LEN             69                     
#define LED_NUM                       33                     
#define MAX_DEV_NUM                   16                     
#define MIN_KEY_IDX                    0                     
#define MAX_KEY_IDX                   16                     
#define MAX_STR_LEN                   32                     
#define MAX_DSPL_STR_LEN              40                     
#define MIN_DSPL_ROW                   0                     
#define MAX_DSPL_ROW                   6                     
#define FLAG_OFFSET                  100                     
#define MOTION_EVT       "MotionEvent"                       
#define BUT_PRESS_EVT    "ButtonPressEvent"                  
#define BUT_REL_EVT      "ButtonReleaseEvent"                
#define CMD_EVT          "CommandEvent"                      
#define TASK_BAR_EVT     "TaskBarEvent"                      
#define UNNAMED_TRNS     "unnamedTrncvr"                     
#define DEV_DCN_EVT      "DeviceDisconnectEvent"             
#define SB_MOTION_EVT    "SpaceballMotionEventType"          
#define SB_BUT_PRESS_EVT "SpaceballButtonPressEventType"     
#define SB_BUT_REL_EVT   "SpaceballButtonReleaseEventType"   
#define SB_CMD_EVT       "SpaceballPassThruCommandEventType" 
#define SW_CMD_EVT       "SpaceWarePassThruCommandEventType" 

//------------------------------------------------------------------------------

//  fse, 08.08.07

enum WinEvents
{
        MotionEvent = 24869,
        ButtonPressEvent,
        ButtonReleaseEvent,
        CommandEvent,
        TaskBarEvent
};
                                                 
//  fse, 08.08.07
                                                 
enum WinCommands
{
        MagellanNoCommand, // <- needed only for the Linux version
        MagellanStop,      // <- needed only for the Linux version by fse
        MagellanSetWindowCommand = 27695,
        MagellanApplicationSensitivity,
        MagellanRingBell,
        MagellanApplicationStarts,
        MagellanModeChange,
        MagellanNullRadiusChange,
        MagellanControlPanel,
        MagellanInternSendCommand,
        MagellanSetActiveLed,
        StopDriver,
        OpenControlPanel,
        ShowVersionInfo
};

//  fse, 20.02.08

enum ScKey
{
        SC_KEY_1 = 0,
        SC_KEY_2,
        SC_KEY_3,
        SC_KEY_4,
        SC_KEY_5,
        SC_KEY_6,       // 5
        SC_KEY_CTRL,
        SC_KEY_ALT,
        SC_KEY_SHIFT,
        SC_KEY_ESC,
        SC_KEY_FRONT,   // 10
        SC_KEY_RIGHT,
        SC_KEY_TOP,
        SC_KEY_FIT,
        SC_KEY_2D3D,
        SC_KEY_PANEL,   // 15
        SC_KEY_MENU,
        SC_KEY_1_B,
        SC_KEY_2_B,
        SC_KEY_3_B,
        SC_KEY_4_B,     // 20
        SC_KEY_5_B,
        SC_KEY_6_B,
        SC_KEY_CTRL_B,
        SC_KEY_ALT_B,
        SC_KEY_SHIFT_B, // 25
        SC_KEY_ESC_B,
        SC_KEY_FRONT_B,
        SC_KEY_RIGHT_B,
        SC_KEY_TOP_B,
        SC_KEY_FIT_B,   // 30
        SC_KEY_2D3D_B,
        SC_KEY_PANEL_B,
        SC_KEY_MENU_B,
        SC_KEY_END
};


// ACHTUNG: Im Falle einer Aenderung muessen die gleichnamigen final ints in
// ScDllWrapper.java angepasst werden!
//  fse, 24.06.13

enum DaemonPar
{
        BAUD,
        MAX_BYTES_IN_RX_QUEUE,
//      REMOTE_SOFTWARE,
//      IPV4_ADDR,
        PORT,
        CFG_AUTO_CHANGE,
        REMEMBER_LAST_CONFIG,
//      EXCLUSIVE_APPL,
        DISABLE_CUBE_DEMO,
        EXPLORER_DELAY,
        DEVICE_TIMEOUT,
        SEND_MODE,
        SEND_DELAY,
        CAP_CHARACTERISTIC,
        SINGLE_COM_PER_APPL,
        ENABLE_LEGACY_COM1,
        ENABLE_LEGACY_COM2,
//      EXCLUSIVE_DEVICE,
        BLINK_PERIOD,
        SEARCH_TOP_WINDOW,
        SKIP_TIMEOUT,
        TIME_BEFORE_SLEEPING,
        WHEEL_ACCELERATOR,
        DEVICE_CHECKING_TIME,
        PROGRAM_PARS_END
};

//  fse, 11.02.09

enum ScDaemonMode
{
        SC_DMN_NRM,     // normaler Modus
        SC_DMN_TST_SPC, // Testmodus fuer SpaceController
        SC_DMN_TST_GEN, // Testmodus fuer GEN
        SC_DMN_END
};

//------------------------------------------------------------------------------

//  fse, 08.08.07

struct ScCom
{
        #ifdef _WIN32
        DWORD mMotionEvt;     
        DWORD mButPressEvt;   
        DWORD mButRelEvt;     
        DWORD mCmdEvt;        
        DWORD mTaskBarEvt;    
        #endif
        #ifdef __linux__
        Atom  mMotionEvt;     
        Atom  mButPressEvt;   
        Atom  mButRelEvt;     
        Atom  mCmdEvt;        
        Atom  mDevDcnEvt;     
        Atom  mSbMotionEvt;   
        Atom  mSbButPressEvt; 
        Atom  mSbButRelEvt;   
        Atom  mSbCmdEvt;      
        Atom  mSwCmdEvt;      
        #endif
        #ifdef __APPLE__
        // Old Spacemouse interface not available.
        #endif
};

//------------------------------------------------------------------------------

#define MAX_SERIALNO_LEN 16 
#define MAX_DESCRPTN_LEN 64 

//  DLL problem: 
//  Unfortunately it is not possible to retrieve strings out of a DLL if the
//  string memory is not allocated before by the application using the DLL.
//  Strings as structure members can not be retrieved even if the memory is
//  allocated before. (This destroys the advantage of strings over character
//  arrays.)
//  Therefore character arrays are used in all the following structs.
//  This would be not necessary under Linux using shared objects.
//  ACHTUNG: AENDERUNGEN AUCH IN ScDevInfo.java und spacecontrol_src.py
//  EINPFLEGEN!
//  fse, 09.05.07

struct ScDevInfo
{
        int  mId;                                 
        char mSerialNo[MAX_SERIALNO_LEN];         
        char mDescrptn[MAX_DESCRPTN_LEN];         
        void setId      (int   in ) { mId = in; } 
        void setSerialNo(char* inP) { strncpy(mSerialNo, inP, MAX_SERIALNO_LEN); mSerialNo[MAX_SERIALNO_LEN-1] = 0; } 
        void setDescrptn(char* inP) { strncpy(mDescrptn, inP, MAX_DESCRPTN_LEN); mDescrptn[MAX_DESCRPTN_LEN-1] = 0; } 
};

//------------------------------------------------------------------------------

#define MAX_VERSION_LEN 16   
#define MAX_FILENAME_LEN 256 

//  fse, 31.05.07

struct ScVersion
{
        char mVrsn[MAX_VERSION_LEN];  
        char mPath[MAX_FILENAME_LEN]; 
        void setVrsn(char* inP) { strncpy(mVrsn, inP, MAX_VERSION_LEN ); mVrsn[MAX_VERSION_LEN-1 ] = 0; } 
        void setPath(char* inP) { strncpy(mPath, inP, MAX_FILENAME_LEN); mPath[MAX_FILENAME_LEN-1] = 0; } 
};

//------------------------------------------------------------------------------

#define MAX_APPL_NAME_LEN  32 
#define MAX_APPL_STATE_LEN 32 
// fse, 28.02.17: MAX_APPL_STATE_LEN von 16 auf 32 verdoppelt, weil Blender u.a.
// den Status "Default-nonnormal" zurueckgibt => 2 Bytes zu lang fuer 16 Bytes.

//  fse, 16.04.08

struct ScFgAppl
{
        char mName [MAX_APPL_NAME_LEN ]; 
        char mState[MAX_APPL_STATE_LEN]; 
        void setName (char* inP) { strncpy(mName , inP, MAX_APPL_NAME_LEN ); mName [MAX_APPL_NAME_LEN -1] = 0; } 
        void setState(char* inP) { strncpy(mState, inP, MAX_APPL_STATE_LEN); mState[MAX_APPL_STATE_LEN-1] = 0; } 
};

//------------------------------------------------------------------------------

//  fse, 14.09.07

struct ScFilename
{
        char mFilename[MAX_FILENAME_LEN]; 
        void setFilename(char* inP) { strncpy(mFilename, inP, MAX_FILENAME_LEN); mFilename[MAX_FILENAME_LEN-1] = 0; } 
};
                  
//------------------------------------------------------------------------------

//  ACHTUNG: Pro Element eine Ausnahmeklasse in ScDllWrapper definieren!
//  ACHTUNG: Eine Kopie dieser Enumeration liegt auf Java-Seite in der Datei
//           ScStatus.java. Aenderungen auch dort einpflegen!
//  ACHTUNG: Auch ScDllWrapper.intToStatus(int rc) in ScDllWrapper.java
//           anpassen!
//  fse, 03.09.12: SC_EXEC_ERROR ergaenzt.
//  fse, 11.07.14: SC_THREAD_ERROR ergaenzt.
//  fse, 08.07.15: SC_WRONG_USER ergaenzt.

enum ScStatus
{
        SC_OK                    , 
        SC_COMMUNICATION_ERROR   , 
        SC_WRONG_DEVICE_INDEX    , 
        SC_PARAMETER_OUT_OF_RANGE, 
        SC_FILE_IO_ERROR         , 
        SC_KEYSTROKE_ERROR       , 
        SC_APPL_NOT_FOUND        , 
        SC_REGISTRY_ERROR        , 
        SC_NOT_SUPPORTED         , 
        SC_EXEC_CMD_ERROR        , 
        SC_THREAD_ERROR          , 
        SC_WRONG_USER            , 
        SC_ERR_END                 
};


//------------------------------------------------------------------------------


typedef int (*stdDataCallbackP)(short x, short y, short z, short a, short b, short c, int traLmh, int rotLmh, int event, long tvSec, long tvUsec);

//------------------------------------------------------------------------------

#ifdef __cplusplus
extern "C"
{
#endif
        
SC_API char*    scStatusToStr(ScStatus ks);
SC_API ScStatus scIsProcessRunning(char* processName, bool* isRunningP);
SC_API ScStatus scSetCurrentUserRegValue  (char* keyP, char* nameP, char* valueP);
SC_API ScStatus scQueryCurrentUserRegValue(char* keyP, char* nameP, int len, char* valueP);
SC_API ScStatus scDelCurrentUserRegValue  (char* keyP, char* nameP);

SC_API ScStatus scConnect2(bool isAlwaysReceivingData, char* applName);
SC_API ScStatus scConnect();
SC_API ScStatus scDisconnect();
SC_API ScStatus scStop();
SC_API ScStatus scGetDmnVrsn(char* versionP, char* pathP);
SC_API ScStatus scGetDevNum (int* devNumP, int* usedDevNumP, int* maxDevIdxP);
SC_API ScStatus scGetFgAppl (char* fgApplP, char* fgApplStateP);
SC_API ScStatus scGetDllLogPars(char logFile[gMaxFileNameLen], int* maxSizeP, bool* isLogToFileP, bool* isLogToCnslP, bool* isWrnP, bool* isCrtP, bool* isTrcP, bool* isDcmP, bool* isIcmP, bool* isInfP, bool* isDbgP, bool* isTmpP, char exclFileToLog[gMaxFileNameLen]);
SC_API ScStatus scSetDllLogPars(char logFile[gMaxFileNameLen], int  maxSize , bool  isLogToFile , bool  isLogToCnsl , bool  isWrn , bool  isCrt , bool  isTrc , bool  isDcm , bool  isIcm , bool  isInf , bool  isDbg , bool  isTmp , char exclFileToLog[gMaxFileNameLen]);
SC_API ScStatus scSetState2(char* state);
SC_API ScStatus scSetState(char* str1, char* str2);
SC_API ScStatus scSetMode(ScDaemonMode mode);

SC_API ScStatus scGetDaemonPar(int par, int* valP);
SC_API ScStatus scSetDaemonPar(int par, int* valP);

SC_API ScStatus scGetDevInfo  (int devIdx, ScDevInfo* diP);

SC_API ScStatus scGetDefDevPars       (int devIdx, ScDevPars* dpP);
SC_API ScStatus scGetDevPars          (int devIdx, ScDevPars* dpP);
SC_API ScStatus scSetDevPars          (int devIdx, ScDevPars* dpP);
SC_API ScStatus scSetDevParsToDefaults(int devIdx, ScDevPars* dpP);

SC_API ScStatus scGetBasicSettings(int devIdx, ScBasicSettings* bsP);
SC_API ScStatus scSetBasicSettings(int devIdx, ScBasicSettings* bsP);

SC_API ScStatus scGetAdvancedSettings(int devIdx, ScAdvancedSettings* asP);
SC_API ScStatus scSetAdvancedSettings(int devIdx, ScAdvancedSettings* bsP);

SC_API ScStatus scGetAdvSens  (int devIdx, ScAdvSens* dpP);
SC_API ScStatus scSetAdvSens  (int devIdx, ScAdvSens* dpP);

SC_API ScStatus scGetStdMode  (int devIdx, unsigned char* bitmaskP);
SC_API ScStatus scSetStdMode  (int devIdx, unsigned char* bitmaskP);

SC_API ScStatus scGetCmprMode (int devIdx, unsigned char* bitmaskP);
SC_API ScStatus scSetCmprMode (int devIdx, unsigned char* bitmaskP);

SC_API ScStatus scGetSens     (int devIdx, int* transSensP, int* rotSensP);
SC_API ScStatus scSetSens     (int devIdx, int* transSensP, int* rotSensP);

SC_API ScStatus scGetXTraSens (int devIdx, int* sensP);
SC_API ScStatus scSetXTraSens (int devIdx, int* sensP);

SC_API ScStatus scGetYTraSens (int devIdx, int* sensP);
SC_API ScStatus scSetYTraSens (int devIdx, int* sensP);

SC_API ScStatus scGetZTraSens (int devIdx, int* sensP);
SC_API ScStatus scSetZTraSens (int devIdx, int* sensP);

SC_API ScStatus scGetXRotSens (int devIdx, int* sensP);
SC_API ScStatus scSetXRotSens (int devIdx, int* sensP);

SC_API ScStatus scGetYRotSens (int devIdx, int* sensP);
SC_API ScStatus scSetYRotSens (int devIdx, int* sensP);

SC_API ScStatus scGetZRotSens (int devIdx, int* sensP);
SC_API ScStatus scSetZRotSens (int devIdx, int* sensP);

SC_API ScStatus scGetSendDelay(int devIdx, int* maxPeriodP, int* minPeriodP);
SC_API ScStatus scSetSendDelay(int devIdx, int* maxPeriodP, int* minPeriodP);

SC_API ScStatus scGetNullRad  (int devIdx, int* nullRadP);
SC_API ScStatus scSetNullRad  (int devIdx, int* nullRadP);

SC_API ScStatus scSetStdZero  (int devIdx);

//SC_API ScStatus scGetStdData  (int devIdx, short* xP, short* yP, short* zP, short* aP, short* bP, short* cP, int* traLmhP, int* rotLmhP, int* eventP, long* tvSecP, long* tvUsecP);
SC_API ScStatus scFetchStdData(int devIdx, short* xP, short* yP, short* zP, short* aP, short* bP, short* cP, int* traLmhP, int* rotLmhP, int* eventP, long* tvSecP, long* tvUsecP);
SC_API ScStatus scGetRawData  (int devIdx, unsigned char buf[RAW_DATA_LEN]);

SC_API ScStatus scGetTra    (int devIdx, bool* isTraP);
SC_API ScStatus scSetTra    (int devIdx, bool* isTraP);

SC_API ScStatus scGetXTra   (int devIdx, bool* isTraP);
SC_API ScStatus scSetXTra   (int devIdx, bool* isTraP);

SC_API ScStatus scGetYTra   (int devIdx, bool* isTraP);
SC_API ScStatus scSetYTra   (int devIdx, bool* isTraP);

SC_API ScStatus scGetZTra   (int devIdx, bool* isTraP);
SC_API ScStatus scSetZTra   (int devIdx, bool* isTraP);

SC_API ScStatus scGetXTraRev(int devIdx, bool* isRevP);
SC_API ScStatus scSetXTraRev(int devIdx, bool* isRevP);

SC_API ScStatus scGetYTraRev(int devIdx, bool* isRevP);
SC_API ScStatus scSetYTraRev(int devIdx, bool* isRevP);

SC_API ScStatus scGetZTraRev(int devIdx, bool* isRevP);
SC_API ScStatus scSetZTraRev(int devIdx, bool* isRevP);

SC_API ScStatus scGetRot    (int devIdx, bool* isRotP);
SC_API ScStatus scSetRot    (int devIdx, bool* isRotP);

SC_API ScStatus scGetXRot   (int devIdx, bool* isRotP);
SC_API ScStatus scSetXRot   (int devIdx, bool* isRotP);

SC_API ScStatus scGetYRot   (int devIdx, bool* isRotP);
SC_API ScStatus scSetYRot   (int devIdx, bool* isRotP);

SC_API ScStatus scGetZRot   (int devIdx, bool* isRotP);
SC_API ScStatus scSetZRot   (int devIdx, bool* isRotP);

SC_API ScStatus scGetXRotRev(int devIdx, bool* isRevP);
SC_API ScStatus scSetXRotRev(int devIdx, bool* isRevP);

SC_API ScStatus scGetYRotRev(int devIdx, bool* isRevP);
SC_API ScStatus scSetYRotRev(int devIdx, bool* isRevP);

SC_API ScStatus scGetZRotRev(int devIdx, bool* isRevP);
SC_API ScStatus scSetZRotRev(int devIdx, bool* isRevP);

SC_API ScStatus scGetDom    (int devIdx, bool* isDomP);
SC_API ScStatus scSetDom    (int devIdx, bool* isDomP);

SC_API ScStatus scReadMsg   (int devIdx, char* msgP);

SC_API ScStatus scGetCfgFilename(int devIdx, char* filenameP);
SC_API ScStatus scSaveDevPars   (int devIdx, char* filenameP);
SC_API ScStatus scLoadDevPars   (int devIdx, char* filenameP, ScDevPars* dpP);

SC_API ScStatus scPressKey  (int devIdx, int key);
SC_API ScStatus scRelKey    (int devIdx, int key);

SC_API ScStatus scSetLed    (int devIdx, int ledNo, int* brightnessP);
SC_API ScStatus scGetLed    (int devIdx, int ledNo, int* brightnessP);

SC_API ScStatus scSetLeds   (int devIdx, int* redP, int* greenP, int* blueP);
//SC_API ScStatus ScGetLeds   (int devIdx, int* redP, int* greenP, int* blueP);

SC_API ScStatus scSetLedsEx (int devIdx, char brightness[LED_NUM]);
SC_API ScStatus scGetLedsEx (int devIdx, char brightness[LED_NUM]);

SC_API ScStatus scSetLcd     (int devIdx, int* brightnessP);
SC_API ScStatus scGetLcd     (int devIdx, int* brightnessP);
SC_API ScStatus scSetLcdColor(int devIdx, int* redP, int* greenP, int* blueP);

SC_API ScStatus scSetDsplString(int devIdx, int row, char text[MAX_DSPL_STR_LEN], int* charNumP);

SC_API ScStatus scGetFmwUpdtState(int devIdx, int* mcuIdP, int* progressP);

SC_API ScStatus scExecCmd(int devIdx, char* cmdP);

SC_API ScStatus scTriggerFunction(int devIdx, int funcIdx);
SC_API ScStatus scTransferCallbackFunction(int devIdx, stdDataCallbackP cbP);

//SC_API ScStatus   scGetSettings();
//SC_API ScStatus   scGetLogPars();
//SC_API void  scPrintVersion();

//SC_API ScStatus   scGetDevices(ScDevInfoList** dilPP);

#ifdef __cplusplus
}
#endif
        
//------------------------------------------------------------------------------

#endif  /* _spc_ctrlr_H */

//------------------------------------------------------------------------------
//-------------------------------------- ---------------------------------------
//------------------------- ------------------------- --------------------------
//------------------ ------------------- ------------------- -------------------
//-------------- --------------- --------------- --------------- ---------------
//------------ ------------ ------------ ------------ ------------ -------------