ScanbotSDKDocumentScannerTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/DocumentScannerTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_DOCUMENTSCANNERTYPES_H
#define SCANBOTSDK_DOCUMENTSCANNERTYPES_H
 
 
#include <ScanbotSDKImage.h>
#include <ScanbotSDKTypes.h>
#include <common/ScanbotSDKCommonTypes.h>
#include <geometry/ScanbotSDKGeometry.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <ScanbotSDKErrorCode.h>
#include <ScanbotSDKDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 

typedef enum scanbotsdk_document_scanner_engine_mode_t {

    SCANBOTSDK_DOCUMENT_SCANNER_ENGINE_MODE_ML = 0,

    SCANBOTSDK_DOCUMENT_SCANNER_ENGINE_MODE_LEGACY = 1,
 
} scanbotsdk_document_scanner_engine_mode_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_engine_mode_t_to_string(scanbotsdk_document_scanner_engine_mode_t value, const char** result);

typedef struct scanbotsdk_document_scanner_parameters_t scanbotsdk_document_scanner_parameters_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_create(
    int accepted_angle_score,
    int accepted_size_score,
    int accepted_brightness_threshold,
    int accepted_aspect_ratio_score,
    scanbotsdk_aspect_ratio_t** aspect_ratios,
    size_t aspect_ratios_size,
    bool ignore_orientation_mismatch,
    int already_cropped_score_threshold,
    scanbotsdk_document_scanner_parameters_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_create_with_defaults(
    scanbotsdk_document_scanner_parameters_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_free(scanbotsdk_document_scanner_parameters_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_get_accepted_angle_score(scanbotsdk_document_scanner_parameters_t* self, int* accepted_angle_score);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_set_accepted_angle_score(scanbotsdk_document_scanner_parameters_t* self, int accepted_angle_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_get_accepted_size_score(scanbotsdk_document_scanner_parameters_t* self, int* accepted_size_score);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_set_accepted_size_score(scanbotsdk_document_scanner_parameters_t* self, int accepted_size_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_get_accepted_brightness_threshold(scanbotsdk_document_scanner_parameters_t* self, int* accepted_brightness_threshold);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_set_accepted_brightness_threshold(scanbotsdk_document_scanner_parameters_t* self, int accepted_brightness_threshold);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_get_accepted_aspect_ratio_score(scanbotsdk_document_scanner_parameters_t* self, int* accepted_aspect_ratio_score);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_set_accepted_aspect_ratio_score(scanbotsdk_document_scanner_parameters_t* self, int accepted_aspect_ratio_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_get_aspect_ratios(scanbotsdk_document_scanner_parameters_t* self, scanbotsdk_aspect_ratio_t** aspect_ratios, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_get_aspect_ratios_size(scanbotsdk_document_scanner_parameters_t* self, size_t* size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_set_aspect_ratios(scanbotsdk_document_scanner_parameters_t* self, scanbotsdk_aspect_ratio_t** aspect_ratios, size_t aspect_ratios_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_get_ignore_orientation_mismatch(scanbotsdk_document_scanner_parameters_t* self, bool* ignore_orientation_mismatch);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_set_ignore_orientation_mismatch(scanbotsdk_document_scanner_parameters_t* self, bool ignore_orientation_mismatch);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_get_already_cropped_score_threshold(scanbotsdk_document_scanner_parameters_t* self, int* already_cropped_score_threshold);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_parameters_set_already_cropped_score_threshold(scanbotsdk_document_scanner_parameters_t* self, int already_cropped_score_threshold);
 

typedef struct scanbotsdk_partially_visible_document_configuration_t scanbotsdk_partially_visible_document_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_create(
    bool allow_partially_visible_documents,
    int accumulation_duration,
    int retention_time,
    int minimum_brightness,
    scanbotsdk_partially_visible_document_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_create_with_defaults(
    scanbotsdk_partially_visible_document_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_free(scanbotsdk_partially_visible_document_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_get_allow_partially_visible_documents(scanbotsdk_partially_visible_document_configuration_t* self, bool* allow_partially_visible_documents);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_set_allow_partially_visible_documents(scanbotsdk_partially_visible_document_configuration_t* self, bool allow_partially_visible_documents);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_get_accumulation_duration(scanbotsdk_partially_visible_document_configuration_t* self, int* accumulation_duration);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_set_accumulation_duration(scanbotsdk_partially_visible_document_configuration_t* self, int accumulation_duration);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_get_retention_time(scanbotsdk_partially_visible_document_configuration_t* self, int* retention_time);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_set_retention_time(scanbotsdk_partially_visible_document_configuration_t* self, int retention_time);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_get_minimum_brightness(scanbotsdk_partially_visible_document_configuration_t* self, int* minimum_brightness);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_partially_visible_document_configuration_set_minimum_brightness(scanbotsdk_partially_visible_document_configuration_t* self, int minimum_brightness);
 

typedef struct scanbotsdk_document_scanner_configuration_t scanbotsdk_document_scanner_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_create(
    scanbotsdk_document_scanner_engine_mode_t engine_mode,
    scanbotsdk_processing_mode_t processing_mode,
    scanbotsdk_document_scanner_parameters_t* parameters,
    scanbotsdk_partially_visible_document_configuration_t* partially_visible_document_configuration,
    scanbotsdk_document_scanner_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_create_with_defaults(
    scanbotsdk_document_scanner_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_free(scanbotsdk_document_scanner_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_get_engine_mode(scanbotsdk_document_scanner_configuration_t* self, scanbotsdk_document_scanner_engine_mode_t* engine_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_set_engine_mode(scanbotsdk_document_scanner_configuration_t* self, scanbotsdk_document_scanner_engine_mode_t engine_mode);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_get_processing_mode(scanbotsdk_document_scanner_configuration_t* self, scanbotsdk_processing_mode_t* processing_mode);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_set_processing_mode(scanbotsdk_document_scanner_configuration_t* self, scanbotsdk_processing_mode_t processing_mode);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_get_parameters(scanbotsdk_document_scanner_configuration_t* self, scanbotsdk_document_scanner_parameters_t** parameters);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_set_parameters(scanbotsdk_document_scanner_configuration_t* self, scanbotsdk_document_scanner_parameters_t* parameters);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_get_partially_visible_document_configuration(scanbotsdk_document_scanner_configuration_t* self, scanbotsdk_partially_visible_document_configuration_t** partially_visible_document_configuration);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanner_configuration_set_partially_visible_document_configuration(scanbotsdk_document_scanner_configuration_t* self, scanbotsdk_partially_visible_document_configuration_t* partially_visible_document_configuration);
 

typedef enum scanbotsdk_document_displacement_t {

    SCANBOTSDK_DOCUMENT_DISPLACEMENT_NONE = 0,

    SCANBOTSDK_DOCUMENT_DISPLACEMENT_UP = 1,

    SCANBOTSDK_DOCUMENT_DISPLACEMENT_UPPER_RIGHT = 2,

    SCANBOTSDK_DOCUMENT_DISPLACEMENT_RIGHT = 3,

    SCANBOTSDK_DOCUMENT_DISPLACEMENT_LOWER_RIGHT = 4,

    SCANBOTSDK_DOCUMENT_DISPLACEMENT_DOWN = 5,

    SCANBOTSDK_DOCUMENT_DISPLACEMENT_LOWER_LEFT = 6,

    SCANBOTSDK_DOCUMENT_DISPLACEMENT_LEFT = 7,

    SCANBOTSDK_DOCUMENT_DISPLACEMENT_UPPER_LEFT = 8,
 
} scanbotsdk_document_displacement_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_displacement_t_to_string(scanbotsdk_document_displacement_t value, const char** result);

typedef enum scanbotsdk_document_detection_status_t {

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_NOT_ACQUIRED = 0,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_OK = 1,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_OK_BUT_TOO_SMALL = 2,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_OK_BUT_BAD_ANGLES = 3,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_OK_BUT_BAD_ASPECT_RATIO = 4,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_OK_BUT_ORIENTATION_MISMATCH = 5,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_OK_BUT_OFF_CENTER = 6,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_OK_BUT_TOO_DARK = 7,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_OK_BUT_ALREADY_CROPPED = 8,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_ERROR_NOTHING_DETECTED = 9,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_ERROR_PARTIALLY_VISIBLE = 10,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_ERROR_PARTIALLY_VISIBLE_TOO_CLOSE = 11,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_ERROR_TOO_DARK = 12,

    SCANBOTSDK_DOCUMENT_DETECTION_STATUS_ERROR_TOO_NOISY = 13,
 
} scanbotsdk_document_detection_status_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_status_t_to_string(scanbotsdk_document_detection_status_t value, const char** result);

typedef struct scanbotsdk_document_detection_scores_t scanbotsdk_document_detection_scores_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_create(
    double total_score,
    double distance_score,
    double angle_score,
    double size_score,
    double aspect_ratio_score,
    double line_coverage_score,
    double width_score,
    double height_score,
    double already_cropped_score,
    scanbotsdk_document_detection_scores_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_free(scanbotsdk_document_detection_scores_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_get_total_score(scanbotsdk_document_detection_scores_t* self, double* total_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_get_distance_score(scanbotsdk_document_detection_scores_t* self, double* distance_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_get_angle_score(scanbotsdk_document_detection_scores_t* self, double* angle_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_get_size_score(scanbotsdk_document_detection_scores_t* self, double* size_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_get_aspect_ratio_score(scanbotsdk_document_detection_scores_t* self, double* aspect_ratio_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_get_line_coverage_score(scanbotsdk_document_detection_scores_t* self, double* line_coverage_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_get_width_score(scanbotsdk_document_detection_scores_t* self, double* width_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_get_height_score(scanbotsdk_document_detection_scores_t* self, double* height_score);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_scores_get_already_cropped_score(scanbotsdk_document_detection_scores_t* self, double* already_cropped_score);
 

typedef struct scanbotsdk_document_detection_result_t scanbotsdk_document_detection_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_free(scanbotsdk_document_detection_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_status(scanbotsdk_document_detection_result_t* self, scanbotsdk_document_detection_status_t* status);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_detection_scores(scanbotsdk_document_detection_result_t* self, scanbotsdk_document_detection_scores_t** detection_scores);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_points(scanbotsdk_document_detection_result_t* self, scanbotsdk_point_t** points);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_points_size(scanbotsdk_document_detection_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_horizontal_lines(scanbotsdk_document_detection_result_t* self, scanbotsdk_line_segment_int_t** horizontal_lines, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_horizontal_lines_size(scanbotsdk_document_detection_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_vertical_lines(scanbotsdk_document_detection_result_t* self, scanbotsdk_line_segment_int_t** vertical_lines, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_vertical_lines_size(scanbotsdk_document_detection_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_points_normalized(scanbotsdk_document_detection_result_t* self, scanbotsdk_pointf_t** points_normalized);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_points_normalized_size(scanbotsdk_document_detection_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_horizontal_lines_normalized(scanbotsdk_document_detection_result_t* self, scanbotsdk_line_segment_float_t** horizontal_lines_normalized, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_horizontal_lines_normalized_size(scanbotsdk_document_detection_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_vertical_lines_normalized(scanbotsdk_document_detection_result_t* self, scanbotsdk_line_segment_float_t** vertical_lines_normalized, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_vertical_lines_normalized_size(scanbotsdk_document_detection_result_t* self, size_t* size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_aspect_ratio(scanbotsdk_document_detection_result_t* self, double* aspect_ratio);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_average_brightness(scanbotsdk_document_detection_result_t* self, int* average_brightness);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_displacement(scanbotsdk_document_detection_result_t* self, scanbotsdk_document_displacement_t* displacement);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_detection_result_get_displacement_vector(scanbotsdk_document_detection_result_t* self, scanbotsdk_pointf_t* displacement_vector);
 

typedef struct scanbotsdk_document_scanning_result_t scanbotsdk_document_scanning_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanning_result_free(scanbotsdk_document_scanning_result_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanning_result_get_detection_result(scanbotsdk_document_scanning_result_t* self, scanbotsdk_document_detection_result_t** detection_result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_scanning_result_get_cropped_image(scanbotsdk_document_scanning_result_t* self, scanbotsdk_image_t** cropped_image);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_DOCUMENTSCANNERTYPES_H */