AxsunOCTCapture.h

Go to the documentation of this file.

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

// defines
#ifdef _WINDOWS
#define EXPORT __declspec(dllexport)
#endif // _WINDOWS
#ifdef __GNUC__
#define EXPORT __attribute__((visibility("default")))
#endif // __GNUC__


// includes
#include <stdint.h>         // for integer typedefs
#ifdef __GNUC__
#include <stddef.h>         // for size_t on linux
#endif // __GNUC__


// enumerated data types
typedef enum data_type {
    u8,
    u16,
    u32,
    cmplx           // (16 bit Imaginary, 16 bit Real)
} data_type;

typedef enum colormap {
    sepia,
    greyscale,
    inv_grayscale,
    user
} colormap;

typedef enum request_mode {
    retrieve_to_caller,
    display_only,
    retrieve_and_display
} request_mode;

typedef enum scan_cmd_t {   // for analog waveform generation control
    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
} scan_cmd_t;

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 rotate;
} 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;

// public function declarations and descriptions

#ifdef __cplusplus
extern "C" {
#endif

    EXPORT int32_t axStartSession(uint32_t capacity);

    EXPORT int32_t axStopSession(void);

    EXPORT size_t axGetMessage(char* message_out);

    EXPORT int32_t axGetStatus(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);

    EXPORT float axGetDataRate(void);

    EXPORT int32_t axGetImageInfo(int64_t requested_image_number, uint32_t * returned_image_number, uint32_t * required_buffer_size);

    EXPORT int32_t axGetImageInfoAdv(int64_t requested_image_number, uint32_t * returned_image_number, int32_t * height, int32_t * width, data_type *data_type_out, uint32_t * required_buffer_size, uint8_t * force_trig, uint8_t * trig_too_fast);

    EXPORT int32_t axRequestImage(int64_t requested_image_number, uint32_t * returned_image_number, int32_t * height, int32_t * width, data_type *data_type_out, uint8_t * image_data_out, uint32_t output_buf_len);

    EXPORT int32_t axRequestImageAdv(int64_t requested_image_number, uint8_t * image_data_out, uint8_t * metadata_out, int32_t * height, int32_t * width, data_type *data_type_out, uint32_t output_buf_len, uint8_t average_number, request_mode req_mode, uint8_t * force_trig, uint8_t * trig_too_fast);

    EXPORT int32_t axImageRequestSize(uint32_t start_Ascan, uint32_t total_Ascans);

    EXPORT int32_t axGetFrameInfoAdv(int64_t requested_frame_number, uint32_t * returned_frame_number, int32_t * height, int32_t * width, data_type *data_type_out, uint32_t * required_buffer_size);

    EXPORT int32_t axRequestFrameAdv(int64_t requested_frame_number, uint8_t * frame_data_out, uint8_t * metadata_out, int32_t * height, int32_t * width, data_type *data_type_out, uint32_t output_buf_len);

    EXPORT int32_t axGetCompressedJPEGInfo(int64_t requested_frame_number, uint32_t * returned_frame_number, uint32_t * required_buffer_size);

    EXPORT int32_t axRequestCompressedJPEG(int64_t requested_frame_number, uint8_t * JPEG_data_out, uint8_t * metadata_out, uint32_t output_buf_len);

    EXPORT int32_t axSetupDisplay(uint8_t window_mode_in, int32_t w_left, int32_t w_top, int32_t w_width, int32_t w_height, uintptr_t parent_window_handle);

    EXPORT int32_t axDisplayImage(int64_t requested_image_number, uint32_t * returned_image_number, int32_t * height, int32_t * width);

    EXPORT int32_t axSelectColormap(colormap colors);

    EXPORT int32_t axLoadUserColormap(uint8_t * user_colormap_in);

    EXPORT int32_t axScanConvert(uint8_t convert, uint8_t interpolation, float inner_radius, float outer_radius, float crop_inner, float crop_outer);

    EXPORT int32_t axUpdateView(int32_t w_left, int32_t w_top, int32_t w_width, int32_t w_height);

    EXPORT int32_t axCropRect(float crop_left, float crop_top, float crop_bottom, float crop_right);

    EXPORT int32_t axAdjustBrightnessContrast(float brightness, float contrast);

    EXPORT int32_t axHideWindow(uint32_t hidden);

    EXPORT int32_t axSetTrigTimeout(uint32_t timeout_frames);

    EXPORT int32_t axDownsampling(uint32_t downsampling_state);

    EXPORT int32_t axSaveFile(const char * path_file, uint32_t full_buffer, uint32_t * packets_written);

    EXPORT int32_t axLoadFile(const char * path_file, uint32_t * packets_read);

    EXPORT int32_t axClearBuffer(void);

    EXPORT int32_t axStartSessionPCIe(uint32_t capacity);

    EXPORT int32_t axImagingCntrlPCIe(int16_t number_of_images);

    EXPORT int32_t axWriteFPGAreg(uint16_t regnum, uint16_t regval);

    EXPORT int32_t axWriteFPGAregBIT(uint16_t regnum, uint8_t bitnum, uint8_t bitval);

    EXPORT int32_t axPipelineMode(uint8_t mode);

    EXPORT int32_t axReadFPGAreg(uint16_t regnum, uint16_t *regval);

    EXPORT int32_t axScanCmd(scan_cmd_t scan_command, double misc_scalar, scan_params_t * scan_parameters, ext_pattern_t * external_scan_pattern, void * RFU);

#ifdef __cplusplus
}
#endif

#endif  // AXSUNOCTCAPTURE_H include guard