jcam_dll.h

Go to the documentation of this file.

//Ensures that this file isn't included twice within a translation unit.
#ifndef JCAM_DLL
#define JCAM_DLL

#include <stddef.h>

#if defined WIN32
#include <atlsafe.h>

    #if (defined JCAM_DYNAMIC_LIB && ! defined JCAM_STATIC_LIB) 
        // The following ifdef block is the standard way of creating macros which make exporting
        // from a DLL simpler. All files within this DLL are compiled with the JCAM_DLL_EXPORTS
        // symbol defined on the command line. This symbol should not be defined on any project
        // that uses this DLL. This way any other project whose source files include this file see
        // JCAM_DLL_API functions as being imported from a DLL, whereas this DLL sees symbols
        // defined with this macro as being exported.

        #if defined JCAM_DLL_EXPORTS
            #define JCAM_DLL_API extern "C" __declspec(dllexport)
        #else
            #define JCAM_DLL_API __declspec(dllimport)
        #endif

        #define STDCALL __stdcall    // Declare our calling convention.
    #elif (! defined JCAM_DYNAMIC_LIB && defined JCAM_STATIC_LIB)
        #define JCAM_DLL_API
        #define STDCALL __stdcall
    #else
        #error "You need to define either JCAM_DYNAMIC_LIB if you will distribute jcam_dll.dll with your software, or JCAM_STATIC_LIB if you're statically linking with jcam_dll.lib."
    #endif

#else //WIN32

    #define JCAM_DLL_API
    #define STDCALL
    #include <sys/socket.h>
    #include <netinet/in.h>
    #include <netinet/tcp.h>
#endif //WIN32

#ifdef __cplusplus
    //Tells the compiler to use C symbol naming conventions
    extern "C" {

    //Put things in a separate namespace so that there's no chance of collisions
    namespace joescan {
#endif //__cplusplus

#ifndef SWIG
#define CHECK_ELEMENT_SIZE(element, size) \
    extern char element ## size[static_cast<int>((sizeof(element) == (size)))]

CHECK_ELEMENT_SIZE(char, 1);
CHECK_ELEMENT_SIZE(short, 2);
CHECK_ELEMENT_SIZE(int, 4);
//CHECK_ELEMENT_SIZE(size_t, 4);
#endif

#ifndef INT8
typedef signed char         INT8;
typedef signed short        INT16;
typedef signed int          INT32;
typedef unsigned char       UINT8;
typedef unsigned short      UINT16;
typedef unsigned int        UINT32;
#endif

enum jsConstants
{
    OPERATION_FAILURE   = 21,
    SCANNER_FAILURE     = -1,
    INVALID_PARAMETER   = -2,
    PROFILE_UNAVAILABLE = -3,
    SOCKET_TIMEOUT      = -4,

    SYNC_MODE_OVERRUN = 0x00000001,

    MAX_HORIZONTAL = 324,
    MAX_VERTICAL   = 243,

    IPS_STATIC    = 0,
    IPS_BY_ID     = 1,
    IPS_BY_DHCP   = 2,
    STATUS_NORMAL = 0,
    STATUS_ACTIVE = 1,
    OPTIONS_SIZE  = 512,
    DATE_LENGTH = 32,
};

typedef enum jsLaserIndexTag
{
    LASER0 = 0,
    LASER1 = 1,
    LASER2 = 2,
    LASER3 = 3,
    LASER4 = 4,
} jsLaserIndex;

typedef void* JCONNECTION;

#pragma pack(1) //Tells compiler to use one-byte boundaries for packing structs.

typedef struct tagProfileDataPoint
{
    INT32 x;
    INT32 y;
    INT32 brightness;
} ProfileDataPoint;

typedef struct tagScanDataPoint
{
    INT32 data;
    INT32 status;
    INT32 brightness;
} ScanDataPoint;

typedef struct tagProfile
{
    INT32 sequenceNumber;
    INT32 location;
    INT32 sendLocation;
    INT32 laserOnTime;
    INT32 timeInHead;
    INT32 inputs;
    INT32 flags;
    INT32 laserIndex;
    INT32 reserved2;
    INT32 numberPoints;
    ProfileDataPoint data[MAX_VERTICAL];
} jsProfile;

typedef struct tagImage
{
    INT32 exposureTime;
    INT32 reserved1;
    INT32 reserved2;
    INT32 numberHorizontal;
    INT32 numberVertical;
    UINT8 image[MAX_HORIZONTAL * MAX_VERTICAL];
} jsImage;

typedef struct tagScan
{
    INT32 location;
    INT32 sendLocation;
    INT32 laserOnTime;
    INT32 timeInHead;
    INT32 inputs;
    INT32 flags;
    INT32 reserved1;
    INT32 reserved2;
    INT32 numberPoints;
    ScanDataPoint data[MAX_VERTICAL];
} jsScan;

typedef struct tagResponsePacket
{
    UINT8  macAddress[6];
    UINT8  currentIpSetup;
    UINT32 ipAddress;
    UINT32 serialNumber;
    UINT8  cableId;
    UINT8  status;
    UINT32 build;
    INT8   options[OPTIONS_SIZE];
} jsResponsePacket;

typedef struct tagOldCalibrationValue
{
    double x;
    double y;
    double roll;
    char date[DATE_LENGTH];
} jsOldCalibrationValue;

#pragma pack() //Use compiler default packing after this.

JCAM_DLL_API int STDCALL jsGetJcamDllMajorVersionNumber();
JCAM_DLL_API int STDCALL jsGetJcamDllMinorVersionNumber();
JCAM_DLL_API JCONNECTION STDCALL jsOpenConnection(char const * const host);
JCAM_DLL_API JCONNECTION STDCALL jsOpenConnectionInt(int const host);
JCAM_DLL_API JCONNECTION STDCALL jsOpenConnectionBase(char const * const host, UINT32 const cableID);
JCAM_DLL_API int STDCALL jsCloseConnection(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsSendProfileRequestN(JCONNECTION const jc, jsLaserIndex const laserIndex);
JCAM_DLL_API int STDCALL jsReadProfileN(JCONNECTION const jc, jsProfile * const profile);
JCAM_DLL_API int STDCALL jsGetProfileN(JCONNECTION const jc, jsLaserIndex const laserIndex, jsProfile * const profile);
JCAM_DLL_API int STDCALL jsGetProfileFromAllLasers(JCONNECTION const jc, jsProfile * const profiles, size_t const cProfiles);
JCAM_DLL_API int STDCALL jsGetImage(JCONNECTION const jc, jsImage * const image);
JCAM_DLL_API int STDCALL jsGetImageN(JCONNECTION const jc, jsLaserIndex const laserIndex, jsImage * const image);
JCAM_DLL_API int STDCALL jsGetScan(JCONNECTION const jc, jsScan * const scan);
JCAM_DLL_API int STDCALL jsGetScanN(JCONNECTION const jc, jsLaserIndex const laserIndex, jsScan * const scan);
JCAM_DLL_API int STDCALL jsGetImageScan(JCONNECTION const jc, jsImage * const image, jsScan * const scan);
JCAM_DLL_API int STDCALL jsGetImageScanN(JCONNECTION const jc, jsLaserIndex const laserIndex, jsImage * const image, jsScan * const scan);
JCAM_DLL_API int STDCALL jsGetDiagnosticScan(JCONNECTION const jc, int const cameraExposure, int const laserExposure, const jsLaserIndex laserIndex, jsScan * const scan);
JCAM_DLL_API int STDCALL jsGetDiagnosticImageScan(JCONNECTION const jc, int const cameraExposure, int const laserExposure, const jsLaserIndex laserIndex, jsImage * const image, jsScan * const scan);
JCAM_DLL_API int STDCALL jsEnterPulseSyncMode(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsEnterEncoderSyncMode(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsEnterTimeSyncMode(JCONNECTION const jc);

JCAM_DLL_API int STDCALL jsStartPulseMaster(JCONNECTION const jc, int pulseInterval, int pulseCount);
JCAM_DLL_API int STDCALL jsStopPulses(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsSetAlternatingExposure(JCONNECTION const jc, bool const enable, int const exposure1, int const exposure2);
JCAM_DLL_API int STDCALL jsHaltSyncMode(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsExitSyncMode(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsSendMultipleProfileRequest(JCONNECTION const jc, UINT32 const nProfiles);
JCAM_DLL_API int STDCALL jsReadMultipleProfiles(JCONNECTION const jc, jsProfile * const profiles, UINT32 nProfiles);
JCAM_DLL_API int STDCALL jsReadMultipleProfilesTimeout(JCONNECTION const jc, jsProfile * const profiles, UINT32 cProfiles, long timeoutMilliseconds);
JCAM_DLL_API int STDCALL jsGetMultipleProfiles(JCONNECTION const jc, jsProfile * const profiles, UINT32 const cProfiles);
JCAM_DLL_API int STDCALL jsSendProfileRequest(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsReadProfile(JCONNECTION const jc, jsProfile * const profile);
JCAM_DLL_API int STDCALL jsGetProfile(JCONNECTION const jc, jsProfile * const profile);
JCAM_DLL_API size_t STDCALL jsGetNumberOfOutstandingRequests(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsCleanUpOutstandingRequests(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsSetEncoderValue(JCONNECTION const jc, UINT16 newEncoderValue);
JCAM_DLL_API int STDCALL jsSetEncoderValue32(JCONNECTION const jc, UINT32 newEncoderValue);
JCAM_DLL_API int STDCALL jsBeginSendParameterFileToScanner(JCONNECTION const jc, char const * const filename);
JCAM_DLL_API int STDCALL jsEndSendParametersToScanner(JCONNECTION const jc);

JCAM_DLL_API int STDCALL jsSendParameterFileToScanner(JCONNECTION const jc, char const * const filename);
JCAM_DLL_API int STDCALL jsSendParametersToScanner(JCONNECTION const jc, char const * const parameters);
JCAM_DLL_API int STDCALL jsBeginSendParametersToScanner(JCONNECTION const jc, char const * const parameters);
JCAM_DLL_API int STDCALL jsGetParameterFileFromScanner(JCONNECTION const jc, char const * const filename);
JCAM_DLL_API size_t STDCALL jsGetNumberOfErrorMessages(JCONNECTION const jc);
JCAM_DLL_API char const * const STDCALL jsGetErrorMessage(JCONNECTION const jc, size_t i);
JCAM_DLL_API int STDCALL jsReadOldPositionCalibrationsN(JCONNECTION const jc, jsLaserIndex const laserIndex, jsOldCalibrationValue oldCalibrations[], UINT32 nCalibrations);

JCAM_DLL_API int STDCALL jsOverrideLaserAutoexposure(JCONNECTION const jc, double minLaserOn, double maxLaserOn, double defaultLaserOn, 
                                                     int staturatedIntensity, int saturatedPercentage, int laserThreshold, bool autoexposeLaser);
JCAM_DLL_API int STDCALL jsOverrideScanWindow(JCONNECTION const jc, double windowTop, double windowBottom, double windowLeft, double windowRight); 
JCAM_DLL_API int STDCALL jsOverrideSyncSettings(JCONNECTION const jc, double timeScannedInterval, double encoderPulseInterval, 
                                                double encoderScanInterval, int numberOfPhases, bool timeStaggeredScanning, 
                                                double laser0Phase, double laser1Phase, double laser2Phase, double laser3Phase, double laser4Phase, 
                                                bool untriggeredSyncScanning, bool startScanRisingEdgeTriggered); 

JCAM_DLL_API int STDCALL jsReadScanWindowN(JCONNECTION const jc, jsLaserIndex const laserIndex, int *top, int *bottom, int *left, int *right);
JCAM_DLL_API int STDCALL jsReadPositionCalibrationN(JCONNECTION const jc, jsLaserIndex const laserIndex, double *xOffset, double *yOffset, double *roll);
JCAM_DLL_API int STDCALL jsSendPositionCalibrationN(JCONNECTION const jc, jsLaserIndex const laserIndex, double const xOffset, double const yOffset, double const roll);
JCAM_DLL_API int STDCALL jsGetScannerStatusFromScanner(JCONNECTION const jc);
JCAM_DLL_API int STDCALL jsGetScannerStatusValue(JCONNECTION const jc, size_t i, int *value);
JCAM_DLL_API int STDCALL jsGetStatusDescriptionFromScanner(JCONNECTION const jc, UINT32 i, char * const description, UINT32 description_length);
JCAM_DLL_API int STDCALL jsGetImagePixel(jsImage const * const image, size_t const x, size_t const y);
JCAM_DLL_API int STDCALL jsFindAllScanners(jsResponsePacket responses[], const size_t nResponses);

#ifdef WIN32
JCAM_DLL_API int STDCALL jsFindAllScannersVB(LPSAFEARRAY lpsaResponses);
#endif

JCAM_DLL_API int STDCALL jsFindScannerByCableId(int const cableId, jsResponsePacket responses[], const size_t nResponses);
JCAM_DLL_API int STDCALL jsFindScannerBySerialNumber(int const serialNumber, jsResponsePacket responses[], const size_t nResponses);
JCAM_DLL_API int STDCALL jsSetStaticIpInt(UINT32 const serialNumber, UINT32 const staticIpAddress, UINT32 const netmask);
JCAM_DLL_API int STDCALL jsSetStaticIpChar(UINT32 const serialNumber, char const * const staticIpAddress, char const * const netmask);
JCAM_DLL_API int STDCALL jsSetBaseIpInt(UINT32 const serialNumber, UINT32 const baseIpAddress, UINT32 const netmask);
JCAM_DLL_API int STDCALL jsSetBaseIpChar(UINT32 const serialNumber, char const * const baseIpAddress, char const * const netmask);
JCAM_DLL_API int STDCALL jsSetCableId(UINT32 const serialNumber, UINT32 const cableId);
JCAM_DLL_API int STDCALL jsClearCableId(UINT32 const serialNumber);

JCAM_DLL_API int STDCALL jsIsInSyncMode(JCONNECTION const jc);

#ifdef __cplusplus
    } //namespace joescan {
#endif //__cplusplus

#if (defined JCAM_STATIC_LIB && defined WIN32)
#   include <windef.h>

    BOOL jsInitialize();


    void jsCleanup();
#endif // (defined JCAM_STATIC_LIB && defined WIN32)

#ifdef __cplusplus
    } //extern "C" {
#endif //__cplusplus

#endif //JCAM_DLL