AxsunOCTCapture.h

Go to the documentation of this file.

// AxsunOCTCapture.h 
// Copyright 2021 Axsun Technologies
 
#ifndef AXSUNOCTCAPTURE_H
#define AXSUNOCTCAPTURE_H
 
// includes
#include "AxsunCommonEnums.h"
 
// defines
#ifdef __cplusplus
constexpr auto MOST_RECENT_IMAGE = uint32_t{ 0 };
#else
#define MOST_RECENT_IMAGE 0
#endif  // __cplusplus
 
struct CaptureSession;
 
typedef struct CaptureSession* AOChandle;
 
typedef enum 
#ifdef __cplusplus
class
#endif // __cplusplus
AxDimension {
    XY,
    XZ,
    YZ
} AxDimension;
 
typedef enum 
#ifdef __cplusplus
class
#endif // __cplusplus
AxColormap {
    SEPIA,
    GREYSCALE,
    INV_GREYSCALE,
    USER_COLORMAP
} AxColormap;
 
typedef enum 
#ifdef __cplusplus
class
#endif // __cplusplus
AxFileType {
    BINARY,
    JPEG,
    BMP,
    PNG,
    RAW3D,
    FILETYPE_RFU
} AxFileType;
 
typedef enum 
#ifdef __cplusplus
class
#endif // __cplusplus
AxRequestMode {
    RETRIEVE_TO_CALLER,
    DISPLAY_ONLY,
    RETRIEVE_AND_DISPLAY,
    REQUESTMODE_RFU
} AxRequestMode;
 
typedef enum
#ifdef __cplusplus
class
#endif // __cplusplus
AxDAQEvent {
    IMAGING_STOP = 0,
    IMAGING_START = 1,
    RECORD_DONE = 2,
    RECORD_START = 3,
    CALIBRATION_DONE = 4,
    CALIBRATION_START = 5,
    LOAD_DONE = 6,
    LOAD_START = 7,
    EXPORT_DONE = 8,
    EXPORT_START = 9,
    EXPORT_CANCELED_BY_USER = 10,
    EXPORT_CANCELED_BY_ERROR = 11
} AxDAQEvent;
 
typedef enum 
#ifdef __cplusplus
class
#endif // __cplusplus
AxInterface {
    GIGABIT_ETHERNET,
    PCI_EXPRESS,
    NO_INTERFACE,
    INTERFACE_RFU
} AxInterface;
 
typedef enum
#ifdef __cplusplus
class
#endif // __cplusplus
AxWindowLinkage {
    NO_LINKAGE = 0,
    PARENT_CHILD = 1,
    OWNER_OWNED = 2
} AxWindowLinkage;
 
typedef enum 
#ifdef __cplusplus
class
#endif // __cplusplus
AxScannerCommand {
    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,
    SET_DIGITAL_OUTPUT,
    SET_SQUAREWAVE_OUTPUT,
    SET_XSINE_YRAMP_PATTERN,
    SET_AUX_DC_ANALOG_OUTPUT,
    SET_AUX_DC_ANALOG_MAX,
    SET_AUX_DC_ANALOG_MIN,
    GET_DEVICE_MODEL_NUMBER,    
    SET_XSINE_YSINE_PATTERN
} AxScannerCommand;
 
typedef struct scan_params_t {  // 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 X_symmetry;
} scan_params_t;
 
typedef struct ext_pattern_t {  // 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 struct request_prefs_t {
    
    AxRequestMode request_mode;
    int32_t which_window; 
    uint32_t average_number;
    
    int32_t crop_width_offset;
    int32_t crop_width_total;
    int32_t crop_height_offset;
    int32_t crop_height_total;
    int16_t to8bit_shift;
    uint16_t to8Bit_min;
    uint8_t downsample;
    uint8_t dezipper;
} request_prefs_t;
 
 
typedef struct export_prefs_t {
    uint32_t width;
    uint32_t height;
    double contrast;
    double brightness;
    AxColormap colormap;
    int32_t opencv_colormap;
    int32_t movie_fps;
} export_prefs_t;
 
typedef struct axpacket_t {
    uint32_t image_number;
    uint32_t frame_number;
    uint32_t packet_number;
    uint16_t ascan_length;
    uint16_t data_type_code;
    uint16_t status_flags;
    uint16_t frames_packet_number;
    uint16_t sync_offset;
    uint8_t subsamp;
    uint8_t RFU;
    struct axtimeval_t time_stamp;
} axpacket_t;
 
typedef struct image_info_t {
    uint32_t image_number;
    int32_t height;
    int32_t width;
    uint32_t size_bytes;
    AxDataType data_type;
    AxPipelineMode pipeline_mode;
    AxChannelMode channel_mode;
    struct axtimeval_t time_stamp;
    uint8_t subsampling_factor;
    uint8_t shift_adj;
    uint8_t force_trig;
    uint8_t trig_too_fast;
    uint8_t burst_recorded;
    uint8_t test_vector_data;
    axpacket_t last_packet_metadata;
} image_info_t;
 
typedef struct new_image_callback_data_t {
    AOChandle session;
    uint32_t image_number;  
    uint32_t required_buffer_size;
    uint32_t waiting_callbacks;
} new_image_callback_data_t;
 
typedef struct span_t {
    const uint8_t* start;
    size_t size_bytes;
} span_t;
 
typedef void(__cdecl* AxNewImageCallbackFunction_t)(new_image_callback_data_t, void*);
 
typedef void(__cdecl* AxConnectScannerCallbackFunction_t)(void*);
 
typedef void(__cdecl* AxCallbackFunction_t)(int32_t, void*);
 
 
#ifdef __cplusplus
extern "C" {
#endif
 AXSUN_EXPORTS 
        AxErr __cdecl axStartSession(AOChandle* session, float capacity_MB);
 AXSUN_EXPORTS 
        AxErr __cdecl axSelectInterface(AOChandle session, AxInterface which_interface);
 AXSUN_EXPORTS 
        AxErr __cdecl axGetSelectedInterface(AOChandle session, AxInterface* selected_interface);
 AXSUN_EXPORTS 
        AxErr __cdecl axStopSession(AOChandle session);
 AXSUN_EXPORTS 
        void __cdecl axGetErrorString(AxErr errorcode, char* message_out);
 AXSUN_EXPORTS 
        AxErr __cdecl axGetMessage(AOChandle session, char* message_out);
 AXSUN_EXPORTS 
        AxErr __cdecl axGetStatus(AOChandle session, uint32_t * imaging, uint32_t * last_packet_in, uint32_t * last_frame_in, uint32_t *last_image_in, uint32_t * dropped_packets, uint32_t *frames_since_sync);
 AXSUN_EXPORTS 
        AxErr __cdecl axGetDataRate(AOChandle session, double * datarate_Mbps);
 AXSUN_EXPORTS 
        AxErr __cdecl axGetImageRate(AOChandle session, int32_t * images_per_second);
 AXSUN_EXPORTS 
        AxErr __cdecl axGetImageInfo(AOChandle session, uint32_t requested_image, image_info_t* image_info);
 AXSUN_EXPORTS 
        AxErr __cdecl 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);
 AXSUN_EXPORTS 
        AxErr __cdecl axRequestImage(AOChandle session, uint32_t requested_image, request_prefs_t prefs, uint32_t output_buf_len, uint8_t * image_data_out, image_info_t* image_info);
 AXSUN_EXPORTS 
        AxErr __cdecl axRequestImagePointer(AOChandle session, uint32_t requested_image, image_info_t* image_info, span_t* part1, span_t* part2);
 AXSUN_EXPORTS 
        AxErr __cdecl axRequestImageAdv(AOChandle session, int64_t requested_image_number, uint8_t * image_data_out, axpacket_t * metadata_out, int32_t * height, int32_t * width, AxDataType *data_type_out, uint32_t output_buf_len, request_prefs_t prefs, uint8_t * force_trig, uint8_t * trig_too_fast);
 AXSUN_EXPORTS 
        AxErr __cdecl 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);
 AXSUN_EXPORTS 
        AxErr __cdecl axRequestFrameAdv(AOChandle session, int64_t requested_frame_number, uint8_t * frame_data_out, axpacket_t * metadata_out, int32_t * height, int32_t * width, AxDataType *data_type_out, uint32_t output_buf_len);
 AXSUN_EXPORTS 
        AxErr __cdecl axGetCompressedJPEGInfo(AOChandle session, int64_t requested_frame_number, uint32_t * returned_frame_number, uint32_t * required_buffer_size);
 AXSUN_EXPORTS 
        AxErr __cdecl axRequestCompressedJPEG(AOChandle session, int64_t requested_frame_number, uint8_t * JPEG_data_out, axpacket_t * metadata_out, uint32_t output_buf_len);
 AXSUN_EXPORTS 
        AxErr __cdecl 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 linked_window_handle);
 AXSUN_EXPORTS 
        AxErr __cdecl axCountWindows(AOChandle session, int32_t * num_of_windows);
 AXSUN_EXPORTS 
        AxErr __cdecl axUpdateWindowStyle(AOChandle session, int32_t which_window,  uint8_t window_style);
 AXSUN_EXPORTS 
        AxErr __cdecl axLinkWindows(AOChandle session, int32_t which_window, AxWindowLinkage linkage, uintptr_t linked_handle);
 AXSUN_EXPORTS 
        AxErr __cdecl axSelectInterpolation(AOChandle session, int32_t which_window, uint8_t interpolation);
 AXSUN_EXPORTS 
        AxErr __cdecl axDisplayImage(AOChandle session, int64_t requested_image_number, uint32_t * returned_image_number, int32_t * height, int32_t * width);
 AXSUN_EXPORTS 
        AxErr __cdecl axSelectColormap(AOChandle session, int32_t which_window, AxColormap colors);
 AXSUN_EXPORTS 
        AxErr __cdecl axLoadUserColormap(AOChandle session, int32_t which_window, uint8_t * user_colormap_in);
 AXSUN_EXPORTS 
        AxErr __cdecl axScanConvert(AOChandle session, int32_t which_window, uint8_t convert, float inner_radius, float outer_radius, float crop_inner, float crop_outer);
 AXSUN_EXPORTS 
        AxErr __cdecl axUpdateView(AOChandle session, int32_t which_window, int32_t w_left, int32_t w_top, int32_t w_width, int32_t w_height);
 AXSUN_EXPORTS 
        AxErr __cdecl axCropRect(AOChandle session, int32_t which_window, float crop_left, float crop_top, float crop_bottom, float crop_right);
 AXSUN_EXPORTS 
        AxErr __cdecl axAdjustBrightnessContrast(AOChandle session, int32_t which_window, float brightness, float contrast);
 AXSUN_EXPORTS 
        AxErr __cdecl axHideWindow(AOChandle session, int32_t which_window, uint32_t state);
 AXSUN_EXPORTS 
        AxErr __cdecl axSetTrigTimeout(AOChandle session, uint32_t framesUntilForceTrig);
 AXSUN_EXPORTS 
        AxErr __cdecl axSaveFile(AOChandle session, const char * path_file, uint8_t full_buffer, int32_t * packets_written);
 AXSUN_EXPORTS 
        AxErr __cdecl axLoadFile(AOChandle session, const char * path_file, int32_t * packets_read);
 AXSUN_EXPORTS 
        AxErr __cdecl axResizeBuffer(AOChandle session, float capacity_MB);
 AXSUN_EXPORTS 
        AxErr __cdecl axImagingCntrlPCIe(AOChandle session, int16_t number_of_images);
 
 AXSUN_EXPORTS 
        const char* __cdecl axGetPCIeDriverVersion();
 
 AXSUN_EXPORTS 
        AxErr __cdecl axWriteFPGAreg(AOChandle session, uint16_t regnum, uint16_t regval);
 AXSUN_EXPORTS 
        AxErr __cdecl axWriteFPGAregBIT(AOChandle session, uint16_t regnum, uint8_t bitnum, uint8_t bitval);
 AXSUN_EXPORTS 
        AxErr __cdecl axWriteFPGAarray(AOChandle session, uint16_t regnum, uint16_t* regvals, int32_t number_of_words);
 AXSUN_EXPORTS 
        AxErr __cdecl axPipelineMode(AOChandle session, AxPipelineMode mode, AxChannelMode channels);
 AXSUN_EXPORTS 
        AxErr __cdecl axReadFPGAreg(AOChandle session, uint16_t regnum, uint16_t *regval);
 AXSUN_EXPORTS 
        AxErr __cdecl axExportImages(AOChandle session, const char* path_directory, int32_t* images_exported, AxFileType file_type);
 AXSUN_EXPORTS 
        AxErr __cdecl axExportImagesAdv(AOChandle session, const char* path_directory, int32_t* images_exported, AxFileType file_type, uint32_t start_image, uint32_t end_image, request_prefs_t request_prefs, export_prefs_t export_prefs);
 AXSUN_EXPORTS 
        AxErr __cdecl axExportImagesAsync(AOChandle session, const char* path_directory, AxFileType file_type, uint32_t start_image, uint32_t end_image, request_prefs_t request_prefs, export_prefs_t export_prefs);
 AXSUN_EXPORTS 
        AxErr __cdecl axCancelExport(AOChandle session);
 
 AXSUN_EXPORTS 
        AxErr __cdecl axScanCmd(AxScannerCommand scan_command, double misc_scalar, const scan_params_t* scan_parameters, ext_pattern_t* external_scan_pattern, void * RFU);
 AXSUN_EXPORTS 
        AxErr __cdecl axRegisterScannerConnectCallback(AxConnectScannerCallbackFunction_t callback_function, void * userData);
 AXSUN_EXPORTS 
        AxErr __cdecl axRegisterDAQCallback(AOChandle session, AxCallbackFunction_t callback_function, void * user_data);
 AXSUN_EXPORTS 
        AxErr __cdecl axReportImagingState(AOChandle session);
 AXSUN_EXPORTS 
        AxErr __cdecl axRegisterExportCallback(AOChandle session, AxCallbackFunction_t callback_function, void * user_data);
 AXSUN_EXPORTS 
        AxErr __cdecl axRegisterNewImageCallback(AOChandle session, AxNewImageCallbackFunction_t callback_function, void * user_data);
 AXSUN_EXPORTS 
        int32_t __cdecl axGetLibBuildCfg(void);
 AXSUN_EXPORTS 
        int32_t __cdecl axGetLibBuildDateTime(char* datetime_str);
 AXSUN_EXPORTS 
        void __cdecl axGetLibVersion(int32_t * major, int32_t * minor, int32_t * patch, int32_t * build, char* version_str);
 
#ifdef __cplusplus
}   // extern "C"
#endif
 
#endif  // AXSUNOCTCAPTURE_H include guard