peak_afl.h

Go to the documentation of this file.

 
#pragma once
 
#include <peak_ipl/backend/peak_ipl_backend.h>
#include <peak/backend/peak_backend.h>
 
/* Function declaration modifiers */
#if defined(_WIN32)
#    ifndef PEAK_AFL_NO_DECLSPEC_STATEMENTS
#        ifdef PEAK_AFL_EXPORTING
#            define PEAK_AFL_EXPORT __declspec(dllexport)
#        else
#            define PEAK_AFL_EXPORT __declspec(dllimport)
#        endif
#    else
#        define PEAK_AFL_EXPORT
#    endif
#    if defined(_M_IX86) || defined(__i386__)
#        define PEAK_AFL_CALLCONV __cdecl
#    else
#        define PEAK_AFL_CALLCONV
#    endif
#else
#    define PEAK_AFL_EXPORT
#    define PEAK_AFL_CALLCONV
#endif
 
#ifdef __cplusplus
#    include <cstddef>
#    include <cstdint>
 
extern "C" {
#else
#    include <stddef.h>
#    include <stdint.h>
#endif
 
 
typedef void* peak_afl_controller_handle;
typedef void* peak_afl_manager_handle;
 
#define PEAK_AFL_VERSION_CODE(major, minor, subminor, patch) (((major) << 24) + ((minor) << 16) + ((subminor) << 8) + (patch))
#define PEAK_AFL_API_STATUS PEAK_AFL_EXPORT peak_afl_status PEAK_AFL_CALLCONV
 
typedef enum peak_afl_status
{
    PEAK_AFL_STATUS_SUCCESS = 0,
 
    PEAK_AFL_STATUS_ERROR = 1,
 
    PEAK_AFL_STATUS_NOT_INITIALIZED = 2,
 
    PEAK_AFL_STATUS_INVALID_PARAMETER = 3,
 
    PEAK_AFL_STATUS_ACCESS_DENIED = 4,
 
    PEAK_AFL_STATUS_BUSY = 5,
 
    PEAK_AFL_STATUS_BUFFER_TOO_SMALL = 6,
 
    PEAK_AFL_STATUS_INVALID_IMAGE_FORMAT = 7,
 
    PEAK_AFL_STATUS_NOT_SUPPORTED = 8,
 
    /* Value adjusted */
    PEAK_AFL_STATUS_VALUE_ADJUSTED = 9
} peak_afl_status;
 
typedef enum peak_afl_controllerType
{
    PEAK_AFL_CONTROLLER_TYPE_INVALID = 0,
 
    PEAK_AFL_CONTROLLER_TYPE_BRIGHTNESS = 1,
 
    PEAK_AFL_CONTROLLER_TYPE_WHITE_BALANCE = 2,
 
    PEAK_AFL_CONTROLLER_TYPE_AUTOFOCUS = 5
} peak_afl_controllerType;
 
typedef enum peak_afl_controller_automode
{
    PEAK_AFL_CONTROLLER_AUTOMODE_OFF,
 
    PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS,
 
    PEAK_AFL_CONTROLLER_AUTOMODE_ONCE
} peak_afl_controller_automode;
 
typedef enum peak_afl_controller_status
{
    PEAK_AFL_CONTROLLER_STATUS_UNDEFINED,
 
    PEAK_AFL_CONTROLLER_STATUS_OFF,
 
    PEAK_AFL_CONTROLLER_STATUS_IN_PROGRESS,
 
    PEAK_AFL_CONTROLLER_STATUS_FINISHED,
 
    PEAK_AFL_CONTROLLER_STATUS_BUSY,
 
    PEAK_AFL_CONTROLLER_STATUS_CANCELED,
 
    PEAK_AFL_CONTROLLER_STATUS_ERROR
} peak_afl_controller_status;
 
typedef enum peak_afl_controller_algorithm
{
    PEAK_AFL_CONTROLLER_ALGORITHM_AUTO,
 
    PEAK_AFL_CONTROLLER_ALGORITHM_GOLDEN_RATIO_SEARCH,
 
    PEAK_AFL_CONTROLLER_ALGORITHM_HILL_CLIMBING_SEARCH,
 
    PEAK_AFL_CONTROLLER_ALGORITHM_GLOBAL_SEARCH,
 
    PEAK_AFL_CONTROLLER_ALGORITHM_FULL_SCAN
} peak_afl_controller_algorithm;
 
typedef enum peak_afl_controller_brightness_algorithm
{
    PEAK_AFL_CONTROLLER_BRIGHTNESS_ALGORITHM_MEDIAN,
 
    PEAK_AFL_CONTROLLER_BRIGHTNESS_ALGORITHM_MEAN,
} peak_afl_controller_brightness_algorithm;
 
typedef enum peak_afl_controller_sharpness_algorithm
{
    PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_AUTO,
 
    PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_TENENGRAD,
 
    PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_SOBEL,
 
    PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_MEAN_SCORE,
 
    PEAK_AFL_CONTROLLER_SHARPNESS_ALGORITHM_HISTOGRAM_VARIANCE
} peak_afl_controller_sharpness_algorithm;
 
typedef enum peak_afl_controller_brightness_component
{
    PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_EXPOSURE = 0x01,
 
    PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_GAIN = 0x02,
 
    PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_ANALOG_GAIN = 0x03,
 
    PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_DIGITAL_GAIN = 0x04,
    
    PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_COMBINED_GAIN = 0x05,
    
    PEAK_AFL_CONTROLLER_BRIGHTNESS_COMPONENT_HOST_GAIN = 0x06,
 
} peak_afl_controller_brightness_component;
 
typedef enum peak_afl_roi_weight
{
    PEAK_AFL_CONTROLLER_ROI_WEIGHT_WEAK = 0x0021,
 
    PEAK_AFL_CONTROLLER_ROI_WEIGHT_MEDIUM = 0x0042,
 
    PEAK_AFL_CONTROLLER_ROI_WEIGHT_STRONG = 0x0063
} peak_afl_roi_weight;
 
typedef enum peak_afl_callback_type
{
    PEAK_AFL_CONTROLLER_CALLBACK_FINISHED,
 
    PEAK_AFL_CONTROLLER_CALLBACK_PROCESSING_DATA
} peak_afl_callback_type;
 
typedef void(PEAK_AFL_CALLCONV* PEAK_AFL_CALLBACK_FINISHED_FUNC)(void* context);
 
typedef void(PEAK_AFL_CALLCONV* PEAK_AFL_CALLBACK_PROCESSING_DATA_FUNC)(int focusValue, int sharpnessValue, void* context);
 
typedef enum peak_afl_roi_preset
{
    PEAK_AFL_CONTROLLER_ROI_PRESET_CENTER
} peak_afl_roi_preset;
 
typedef struct
{
    uint32_t width;
 
    uint32_t height;
} peak_afl_size;
 
typedef struct
{
    uint32_t x;
 
    uint32_t y;
} peak_afl_position;
 
typedef struct
{
    uint32_t x;
 
    uint32_t y;
 
    uint32_t width;
 
    uint32_t height;
} peak_afl_rectangle;
 
typedef struct
{
    peak_afl_rectangle roi;
 
    peak_afl_roi_weight weight;
} peak_afl_weighted_rectangle;
 
typedef struct
{
    int min;
 
    int max;
} peak_afl_controller_limit;
 
typedef struct
{
    double min;
    double max;
} peak_afl_double_limit;
 
typedef uint8_t peak_afl_BOOL8;
 
#define PEAK_AFL_TRUE 1
 
#define PEAK_AFL_FALSE 0
 
PEAK_AFL_API_STATUS peak_afl_Init(void);
 
PEAK_AFL_API_STATUS peak_afl_Exit(void);
 
PEAK_AFL_API_STATUS peak_afl_GetLastError(peak_afl_status* lastErrorCode, char* lastErrorMessage, size_t* lastErrorMessageSize);
 
PEAK_AFL_API_STATUS peak_afl_GetVersion(
    uint32_t* majorVersion, uint32_t* minorVersion, uint32_t* subminorVersion, uint32_t* patchVersion);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_Create(peak_afl_manager_handle* handle, PEAK_NODE_MAP_HANDLE nodeMapHandle);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_Destroy(peak_afl_manager_handle handle);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_AddController(peak_afl_manager_handle handle, peak_afl_manager_handle controller);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_RemoveController(
    peak_afl_manager_handle handle, peak_afl_manager_handle controller);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_Process(peak_afl_manager_handle handle, PEAK_IPL_IMAGE_HANDLE imageHandle);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_CreateController(
    peak_afl_manager_handle handle, peak_afl_controller_handle* controller, peak_afl_controllerType controllerType);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_DestroyAllController(peak_afl_manager_handle handle);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_DestroyController(
    peak_afl_manager_handle handle, peak_afl_controller_handle controller);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_SetGainIPL(peak_afl_manager_handle handle, PEAK_IPL_GAIN_HANDLE gainHandle);
 
PEAK_AFL_API_STATUS peak_afl_AutoFeatureManager_Status(peak_afl_manager_handle handle, peak_afl_BOOL8* running);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Create(
    peak_afl_controller_handle* controller, peak_afl_controllerType controllerType);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Destroy(peak_afl_controller_handle controller);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_SkipFrames_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_SkipFrames_Set(peak_afl_controller_handle controller, uint32_t count);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_SkipFrames_Get(peak_afl_controller_handle controller, uint32_t* count);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_SkipFrames_GetRange(
    peak_afl_controller_handle controller, uint32_t* min, uint32_t* max, uint32_t* inc);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_ROI_IsSupported(peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_ROI_Set(peak_afl_controller_handle controller, peak_afl_rectangle roi);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_ROI_Get(peak_afl_controller_handle controller, peak_afl_rectangle* roi);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_ROI_Preset_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_ROI_Preset_Set(peak_afl_controller_handle controller, peak_afl_roi_preset roiPreset);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Mode_IsSupported(peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Mode_Set(peak_afl_controller_handle controller, peak_afl_controller_automode mode);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Mode_Get(peak_afl_controller_handle controller, peak_afl_controller_automode* mode);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessAlgorithm_Set(peak_afl_controller_handle controller, peak_afl_controller_brightness_algorithm algorithm);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessAlgorithm_Get(peak_afl_controller_handle controller, peak_afl_controller_brightness_algorithm* algorithm);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessAlgorithm_IsSupported(peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Mode_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Unit_IsSupported(
    peak_afl_controller_handle controller, peak_afl_controller_brightness_component unit, peak_afl_BOOL8* supported);
PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Mode_Set(
    peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_automode mode);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Mode_Get(
    peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_automode* mode);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Status(
    peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_status* status);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Callback_Set(peak_afl_controller_handle controller,
    peak_afl_controller_brightness_component component, peak_afl_callback_type type, void* funcPtr, void* context);
 
 
PEAK_AFL_API_STATUS  peak_afl_AutoController_ExposureLimit_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_ExposureLimit_Set(peak_afl_controller_handle controller, peak_afl_double_limit limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_ExposureLimit_Get(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Status(peak_afl_controller_handle controller, peak_afl_controller_status* status);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GetLastAutoAverage(peak_afl_controller_handle controller, uint8_t* average);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GetLastAutoAverages(
    peak_afl_controller_handle controller, uint8_t* averageRed, uint8_t* averageGreen, uint8_t* averageBlue);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTarget_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTarget_Set(peak_afl_controller_handle controller, uint32_t target);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTarget_Get(peak_afl_controller_handle controller, uint32_t* target);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTarget_GetRange(
    peak_afl_controller_handle controller, uint32_t* min, uint32_t* max, uint32_t* inc);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTolerance_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTolerance_Set(peak_afl_controller_handle controller, uint32_t tolerance);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTolerance_Get(peak_afl_controller_handle controller, uint32_t* tolerance);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTolerance_GetRange(
    peak_afl_controller_handle controller, uint32_t* min, uint32_t* max, uint32_t* inc);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoPercentile_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoPercentile_Set(peak_afl_controller_handle controller, double percentile);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoPercentile_Get(peak_afl_controller_handle controller, double* percentile);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_AutoPercentile_GetRange(
    peak_afl_controller_handle controller, double* min, double* max, double* inc);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Type_Get(peak_afl_controller_handle controller, peak_afl_controllerType* type);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Algorithm_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Algorithm_Set(
    peak_afl_controller_handle controller, peak_afl_controller_algorithm algorithm);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Algorithm_Get(
    peak_afl_controller_handle controller, peak_afl_controller_algorithm* algorithm);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Algorithm_GetList(
    peak_afl_controller_handle controller, peak_afl_controller_algorithm* typeList, uint32_t* listSize);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_SharpnessAlgorithm_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_SharpnessAlgorithm_Set(
    peak_afl_controller_handle controller, peak_afl_controller_sharpness_algorithm algorithm);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_SharpnessAlgorithm_Get(
    peak_afl_controller_handle controller, peak_afl_controller_sharpness_algorithm* algorithm);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_SharpnessAlgorithm_GetList(
    peak_afl_controller_handle controller, peak_afl_controller_sharpness_algorithm* typeList, uint32_t* listSize);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Callback_Set(
    peak_afl_controller_handle controller, peak_afl_callback_type type, void* funcPtr, void* context);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Weighted_ROI_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Weighted_ROI_Min_Size(peak_afl_controller_handle controller, peak_afl_size* size);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Weighted_ROI_Set(
    peak_afl_controller_handle controller, const peak_afl_weighted_rectangle* weightedRoiList, uint32_t listSize);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Weighted_ROI_Get(
    peak_afl_controller_handle controller, peak_afl_weighted_rectangle* weightedRoiList, uint32_t* listSize);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Limit_IsSupported(peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Limit_Default(
    peak_afl_controller_handle controller, peak_afl_controller_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Limit_Set(peak_afl_controller_handle controller, peak_afl_controller_limit limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Limit_Get(peak_afl_controller_handle controller, peak_afl_controller_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_Default(peak_afl_controller_handle controller, uint8_t* hysteresis);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_Set(peak_afl_controller_handle controller, uint8_t hysteresis);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_Get(peak_afl_controller_handle controller, uint8_t* hysteresis);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_GetRange(
    peak_afl_controller_handle controller, uint8_t* min, uint8_t* max, uint8_t* inc);
 
PEAK_AFL_API_STATUS  peak_afl_AutoController_GainLimit_IsSupported(
    peak_afl_controller_handle controller, peak_afl_BOOL8* supported);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainLimit_Set(peak_afl_controller_handle controller, peak_afl_double_limit limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainLimit_Get(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainLimit_GetRange(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainAnalogLimit_Set(peak_afl_controller_handle controller, peak_afl_double_limit limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainAnalogLimit_Get(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainAnalogLimit_GetRange(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainDigitalLimit_Set(peak_afl_controller_handle controller, peak_afl_double_limit limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainDigitalLimit_Get(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainDigitalLimit_GetRange(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainCombinedLimit_Set(peak_afl_controller_handle controller, peak_afl_double_limit limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainCombinedLimit_Get(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainCombinedLimit_GetRange(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainHostLimit_Set(peak_afl_controller_handle controller, peak_afl_double_limit limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainHostLimit_Get(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
PEAK_AFL_API_STATUS peak_afl_AutoController_GainHostLimit_GetRange(peak_afl_controller_handle controller, peak_afl_double_limit* limit);
 
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus