AxsunOCTCapture.h

Go to the documentation of this file.

// AxsunOCTCapture.h 
// Copyright 2019 Axsun Technologies
#ifndef AXSUNOCTCAPTURE_H
#define AXSUNOCTCAPTURE_H

// includes
#include "AxsunCommonEnums.h"

#ifdef __cplusplus
#include <cstdint>          // for integer typedefs
#else
#include <stdint.h>         // for integer typedefs
#endif // __cplusplus

#ifdef __GNUC__
#include <stddef.h>         // for size_t on linux
#endif // __GNUC__


struct AxCaptureSession;

typedef struct AxCaptureSession* AOChandle;

typedef enum {
    U8,
    U16,
    U32,
    CMPLX,
    I16
} AxDataType;

typedef enum {
    SEPIA,
    GREYSCALE,
    INV_GREYSCALE,
    USER_COLORMAP
} AxColormap;

typedef enum {
    BINARY,
    JPEG,
    BMP,
    FILETYPE_RFU
} AxFileType;

typedef enum {
    RETRIEVE_TO_CALLER,
    DISPLAY_ONLY,
    RETRIEVE_AND_DISPLAY,
    REQUESTMODE_RFU
} AxRequestMode;

typedef enum {
    GIGABIT_ETHERNET,
    PCI_EXPRESS,
    NO_INTERFACE,
    INTERFACE_RFU
} AxInterface;

typedef enum {
    INIT_SCAN,
    DESTROY_SCAN,       
    SET_RECT_PATTERN,           
    LOAD_EXT_PATTERN,           
    CONTINUOUS_LINE_SCAN,    
    CONTINUOUS_RASTER_SCAN, 
    STOP_AT_POSITION,           
    SETUP_BURST_RASTER, 
    START_BURST_RASTER,
    WAIT_BURST,
    SET_SAMPLE_CLOCK,
    GET_DEVICE_SERIALNO,
    SELECT_DEVICE,
    COUNT_DEVICES,
    SET_MAX_VOLTAGE
} AxScannerCommand;

typedef struct {    // for analog waveform generation control
    uint32_t X_increments;
    uint32_t Y_increments;
    double X_range;
    double Y_range;
    double X_shift;
    double Y_shift;
    double Y_idle;
    double X_phase;
    double rotate;
} scan_params_t;

typedef struct {    // for analog waveform generation control
    uint32_t ext_X_increments;
    uint32_t ext_Y_increments;
    double * linear_pattern;
    double * raster_pattern;
} ext_pattern_t;

typedef void(__cdecl *AxConnectScannerCallbackFunction_t)(void*);

#ifdef _WINDOWS
#include "WinSock2.h"                   // for struct timeval
#pragma pack(push)
#pragma pack(1)                         // forces packing of data in AxPacket structure: sizeof(AxPacket) must be 34 bytes on Windows OS
#endif // _WINDOWS

typedef struct {
    uint16_t ascanLength;
    uint16_t dataTypeCode;
    uint16_t statusFlags;
    uint32_t frameNumber;
    uint32_t packetNumber;
    uint16_t framesPacketNumber;
    uint32_t imageNumber;
    uint16_t syncOffsetInFrame;
    uint16_t syncOffsetInAscan;
    uint8_t subsamp;
    uint8_t RFU;
    struct timeval packetTimeStamp;
#ifdef __GNUC__
} __attribute__((packed, aligned(1))) AxPacket;
#endif // __GNUC__
#ifdef _WINDOWS
} AxPacket;
#pragma pack(pop)
#endif // _WINDOWS


#ifdef __cplusplus
extern "C" {
#endif
 EXPORT 
        AxErr axStartSession(AOChandle* session, float capacity_MB);
 EXPORT 
        AxErr axSelectInterface(AOChandle session, AxInterface which_interface);
 EXPORT 
        AxErr axStopSession(AOChandle session);
 EXPORT 
        void axGetErrorString(AxErr errorcode, char* message_out);
 EXPORT 
        AxErr axGetMessage(AOChandle session, char* message_out);
 EXPORT 
        AxErr axGetStatus(AOChandle session, uint32_t * imaging, uint32_t * last_packet_in, uint32_t * last_frame_in, uint32_t *last_image_in, uint32_t * droppedPackets_, uint32_t *frames_since_sync);
 EXPORT 
        AxErr axGetDataRate(AOChandle session, double * datarate_Mbps);
 EXPORT 
        AxErr axGetImageInfo(AOChandle session, int64_t requested_image_number, uint32_t * returned_image_number, uint32_t * required_buffer_size);
 EXPORT 
        AxErr axGetImageInfoAdv(AOChandle session, int64_t requested_image_number, uint32_t * returned_image_number, int32_t * height, int32_t * width, AxDataType *data_type_out, uint32_t * required_buffer_size, uint8_t * force_trig, uint8_t * trig_too_fast);
 EXPORT 
        AxErr axRequestImage(AOChandle session, int64_t requested_image_number, uint32_t * returned_image_number, int32_t * height, int32_t * width, AxDataType *data_type_out, uint8_t * image_data_out, uint32_t output_buf_len);
 EXPORT 
        AxErr axRequestImageAdv(AOChandle session, int64_t requested_image_number, uint8_t * image_data_out, AxPacket * metadata_out, int32_t * height, int32_t * width, AxDataType *data_type_out, uint32_t output_buf_len, uint8_t average_number, AxRequestMode req_mode, uint8_t * force_trig, uint8_t * trig_too_fast);
 EXPORT 
        AxErr axImageRequestSize(AOChandle session, uint32_t start_Ascan, uint32_t total_Ascans);
 EXPORT 
        AxErr axGetFrameInfoAdv(AOChandle session, int64_t requested_frame_number, uint32_t * returned_frame_number, int32_t * height, int32_t * width, AxDataType *data_type_out, uint32_t * required_buffer_size);
 EXPORT 
        AxErr axRequestFrameAdv(AOChandle session, int64_t requested_frame_number, uint8_t * frame_data_out, AxPacket * metadata_out, int32_t * height, int32_t * width, AxDataType *data_type_out, uint32_t output_buf_len);
 EXPORT 
        AxErr axGetCompressedJPEGInfo(AOChandle session, int64_t requested_frame_number, uint32_t * returned_frame_number, uint32_t * required_buffer_size);
 EXPORT 
        AxErr axRequestCompressedJPEG(AOChandle session, int64_t requested_frame_number, uint8_t * JPEG_data_out, AxPacket * metadata_out, uint32_t output_buf_len);
 EXPORT 
        AxErr axSetupDisplay(AOChandle session, uint8_t window_style, int32_t w_left, int32_t w_top, int32_t w_width, int32_t w_height, uintptr_t parent_window_handle);
 EXPORT 
        AxErr axUpdateWindowStyle(AOChandle session, uint8_t window_style);
 EXPORT 
        AxErr axSelectInterpolation(AOChandle session, uint8_t interpolation);
 EXPORT 
        AxErr axDisplayImage(AOChandle session, int64_t requested_image_number, uint32_t * returned_image_number, int32_t * height, int32_t * width);
 EXPORT 
        AxErr axSelectColormap(AOChandle session, AxColormap colors);
 EXPORT 
        AxErr axLoadUserColormap(AOChandle session, uint8_t * user_colormap_in);
 EXPORT 
        AxErr axScanConvert(AOChandle session, uint8_t convert, uint8_t interpolation, float inner_radius, float outer_radius, float crop_inner, float crop_outer);
 EXPORT 
        AxErr axUpdateView(AOChandle session, int32_t w_left, int32_t w_top, int32_t w_width, int32_t w_height);
 EXPORT 
        AxErr axCropRect(AOChandle session, float crop_left, float crop_top, float crop_bottom, float crop_right);
 EXPORT 
        AxErr axAdjustBrightnessContrast(AOChandle session, float brightness, float contrast);
 EXPORT 
        AxErr axHideWindow(AOChandle session, uint32_t hidden);
 EXPORT 
        AxErr axSetTrigTimeout(AOChandle session, uint32_t framesUntilForceTrig_);
 EXPORT 
        AxErr axDownsampling(AOChandle session, uint8_t downsampling_state);
 EXPORT 
        AxErr axSaveFile(AOChandle session, const char * path_file, uint8_t full_buffer, int32_t * packets_written);
 EXPORT 
        AxErr axLoadFile(AOChandle session, const char * path_file, int32_t * packets_read);
 EXPORT 
        AxErr axClearBuffer(AOChandle session);
 EXPORT 
        AxErr axResizeBuffer(AOChandle session, float capacity_MB);
 EXPORT 
        AxErr axImagingCntrlPCIe(AOChandle session, int16_t number_of_images);
 EXPORT 
        AxErr axWriteFPGAreg(AOChandle session, uint16_t regnum, uint16_t regval);
 EXPORT 
        AxErr axWriteFPGAregBIT(AOChandle session, uint16_t regnum, uint8_t bitnum, uint8_t bitval);
 EXPORT 
        AxErr axPipelineMode(AOChandle session, AxPipelineMode mode);
 EXPORT 
        AxErr axReadFPGAreg(AOChandle session, uint16_t regnum, uint16_t *regval);
 EXPORT 
        AxErr axExportImages(AOChandle session, const char* path_directory, int32_t* images_exported, AxFileType file_type);
 EXPORT 
        AxErr axScanCmd(AxScannerCommand scan_command, double misc_scalar, scan_params_t * scan_parameters, ext_pattern_t * external_scan_pattern, void * RFU);
 EXPORT 
        AxErr axRegisterScannerConnectCallback(AxConnectScannerCallbackFunction_t callback_function, void * userData);

 EXPORT 
        int32_t axGetLibBuildCfg(void);
 EXPORT 
        int32_t axGetLibBuildDateTime(char* datetime_str);
 EXPORT 
        void axGetLibVersion(int32_t * major, int32_t * minor, int32_t * patch, int32_t * build, char* version_str);

#ifdef __cplusplus
}
#endif

#endif  // AXSUNOCTCAPTURE_H include guard