[SBC-4238] Windows Example

.github/workflows/run-tests-ci.yml

@@ -41,7 +41,7 @@ on:
 
 # Global environment variables
 env:
-  SDK_VERSION: '0.810.7'
+  SDK_VERSION: '9.0.0'
 
 jobs:
   test-x86_64:
@@ -58,10 +58,11 @@ jobs:
       - name: Build Docker image (x86_64)
         run: |
           docker build \
+            -f test-scripts/linux/Dockerfile \
             --build-arg SDK_VERSION=${{ inputs.sdk_version || env.SDK_VERSION }} \
             --build-arg ARCH=linux-x86_64 \
             --build-arg SCANBOT_LICENSE="${{ secrets.SCANBOT_LICENSE_KEY }}" \
-            --target all-tests \
+            --target sdk-verification \
             -t scanbot-linux-x86_64:latest .
 
       # Run the test suite with secure stdin approach

.gitignore

@@ -6,4 +6,5 @@ examples/nodejs/node_modules
 examples/java/libs/*.jar
 get-pip.py
 .env
-.venv
+.venv
+.vscode/

Libraries.txt

@@ -1,4 +1,4 @@
-Open Source libraries used in the Scanbot Linux SDK version 8.1.0:
+Open Source libraries used in the Scanbot Linux SDK version 9.0.0:
 
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 
@@ -1784,12 +1784,12 @@ defined by AIM ITS/04-023 International Technical Standard - Extended Channel In
 
 magic-enum
 
-Version v0.8.1
+Version v0.9.7
 (https://github.com/Neargye/magic_enum)
 
 MIT License
 
-Copyright (c) 2019 - 2022 Daniil Goncharov
+Copyright (c) 2019 - 2024 Daniil Goncharov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

examples/c/CMakeLists.txt

@@ -1,17 +1,25 @@
+# 3.10 is the version shipped with Ubuntu 18.04, which is the base of NVIDIA JetPack 4.6.
 cmake_minimum_required(VERSION 3.10)
 project(scanbotsdk_c_example C)
 set(CMAKE_C_STANDARD 99)
 
 # Find or download Scanbot SDK
 if(NOT SCANBOTSDK_VERSION)
-    message(FATAL_ERROR "SCANBOTSDK_VERSION is not set.")
+    set(SCANBOTSDK_VERSION "9.0.0")
 endif()
-set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/")
-set(SCANBOTSDK_DIR "${CMAKE_CURRENT_BINARY_DIR}/scanbotsdk")
+set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
 find_package(ScanbotSDK REQUIRED)
 
-file(GLOB_RECURSE SOURCE_FILES CONFIGURE_DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/src/*.c)
+file(GLOB_RECURSE SOURCE_FILES "${CMAKE_CURRENT_SOURCE_DIR}/src/*.c")
 add_executable(scanbotsdk_example ${SOURCE_FILES})
 target_include_directories(scanbotsdk_example PRIVATE include)
-target_link_libraries(scanbotsdk_example PRIVATE scanbotsdk)
+target_link_libraries(scanbotsdk_example PRIVATE ScanbotSDK::ScanbotSDK)
+
+if(WIN32)
+    add_custom_command(TARGET scanbotsdk_example POST_BUILD
+        COMMAND "${CMAKE_COMMAND}" -E copy_if_different
+            "$<TARGET_FILE:ScanbotSDK::ScanbotSDK>"
+            "$<TARGET_FILE_DIR:scanbotsdk_example>"
+    )
+endif()
 

examples/c/README.md

@@ -4,10 +4,10 @@
 
 > Scanbot SDK requires Jetpack 6.1, CUDA 12.6 and TensorRT 10.3 to run with GPU acceleration.
 
-* Install a C compiler, CMake and wget:
+* Install a C compiler and CMake:
 
 ```bash
-sudo apt install -y cmake build-essential wget
+sudo apt install -y cmake build-essential
 ```
 
 * Optionally, install CUDA and TensorRT for GPU acceleration. Make sure that you're running a supported Jetpack version.
@@ -29,48 +29,75 @@ sudo jetson_clocks --restore
 
 * You're now ready to run the examples.
 
-----
-
 ### Raspberry Pi OS, Ubuntu, Debian
 
-* Install a C compiler, CMake and wget:
+* Install a C compiler and CMake:
 
 ```bash
-sudo apt install -y cmake build-essential wget
+sudo apt install -y cmake build-essential
 ```
 
 * You're now ready to build the examples.
 
+### Windows
+
+Requirements:
+
+* Visual Studio C++ Build Tools
+* CMake 3.10+
+* Recommended: ninja
+
 ## Building the Examples
 
 In order to build all examples, run the following commands:
 
-```bash
-mkdir build
-cd build
-# Replace `<SCANBOTSDK_VERSION>` with the actual version number of the SDK you want to install.
-cmake -DSCANBOTSDK_VERSION=<SCANBOTSDK_VERSION> ..
-make
-```
+* With ninja (recommended):
+    ```bash
+    mkdir build
+    cd build
+    # Replace `<SCANBOTSDK_VERSION>` with the actual version number of the SDK you want to install.
+    cmake -GNinja -DSCANBOTSDK_VERSION=<SCANBOTSDK_VERSION> ..
+    ninja
+    ```
+
+* With make:
+
+    ```bash
+    mkdir build
+    cd build
+    # Replace `<SCANBOTSDK_VERSION>` with the actual version number of the SDK you want to install.
+    cmake -DSCANBOTSDK_VERSION=<SCANBOTSDK_VERSION> ..
+    make
+    ```
+
+* With MS Visual Studio (Windows-only):
+
+    ```powershell
+    mkdir build
+    cd build
+    # Replace `<SCANBOTSDK_VERSION>` with the actual version number of the SDK you want to install.
+    cmake "-DSCANBOTSDK_VERSION=<SCANBOTSDK_VERSION>" ..
+    msbuild scanbotsdk_c_example.sln
+    # scanbotsdk_example.exe will be created under Debug\
+    ```
+
 
 ## Usage
-The example supports four modes: **scan**, **analyze**, **classify**, and **parse**.
+The example supports five modes: **scan**, **analyze**, **enhance**, **parse**, and **live**.
 ```bash
 ./scanbotsdk_example scan <subcommand> --file <path/to/file.jpg> [--license <KEY>]
-./scanbotsdk_example scan <subcommand> --file <path/to/file.jpg> [--license <KEY>]
 ./scanbotsdk_example analyze <subcommand> --file <path/to/file.jpg> [--save <out.jpg>] [--license <KEY>]
-./scanbotsdk_example analyze <subcommand> --file <path/to/file.jpg> [--save <out.jpg>] [--license <KEY>]
-./scanbotsdk_example classify <subcommand> --file <path/to/file.jpg> [--license <KEY>]
+./scanbotsdk_example enhance <subcommand> --file <path/to/file.jpg> [--license <KEY>]
 ./scanbotsdk_example parse <subcommand> --text "<input>" [--license <KEY>]
 ./scanbotsdk_example live <subcommand> --file <path/to/file.jpg> [--license <KEY>] [--use_tensorrt]
-
 ```
 
 ## Example
 ```bash
 ./scanbotsdk_example scan barcode --file images/example.jpg --license <KEY>
 ./scanbotsdk_example analyze analyze_multi_page --file files/doc.pdf --license <KEY>
 ./scanbotsdk_example analyze crop_analyze --file images/doc.jpg --save out/crop.jpg --license <KEY>
+./scanbotsdk_example enhance document --file images/doc.jpg --license <KEY>
 ./scanbotsdk_example parse mrz --text "P<UTOERIKSSON<<ANNA<MARIA<<<<<<" --license <KEY>
 ./scanbotsdk_example live barcode --file images/example.jpg --license <KEY>
 ```

examples/c/cmake/Download.cmake

@@ -0,0 +1,17 @@
+# Download.cmake
+if(NOT URL OR NOT DEST)
+    message(FATAL_ERROR "Both URL and DEST variables must be defined.")
+endif()
+
+file(DOWNLOAD "${URL}" "${DEST}"
+     STATUS status
+     TLS_VERIFY ON
+)
+
+list(GET status 0 status_code)
+list(GET status 1 status_string)
+
+if(NOT status_code EQUAL 0)
+    file(REMOVE "${DEST}")
+    message(FATAL_ERROR "Download failed (${status_code}): ${status_string}")
+endif()

examples/c/cmake/FindScanbotSDK.cmake

@@ -1,47 +1,107 @@
-include(ExternalProject)
 include(FindPackageHandleStandardArgs)
 
-if(NOT SCANBOTSDK_DIR)
-message(FATAL_ERROR "SCANBOTSDK_DIR not set")
+if(TARGET ScanbotSDK::ScanbotSDK)
+  return()
 endif()
 
-if (NOT EXISTS ${SCANBOTSDK_DIR})
+if(NOT DEFINED SCANBOTSDK_VERSION)
+  message(FATAL_ERROR "SCANBOTSDK_VERSION is not set.")
+endif()
+
+if(NOT DEFINED SCANBOTSDK_DIR)
+  set(SCANBOTSDK_DIR "${CMAKE_CURRENT_BINARY_DIR}")
+endif()
+
+if(NOT EXISTS "${SCANBOTSDK_DIR}/scanbotsdk")
+  if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
+    if(CMAKE_SIZEOF_VOID_P EQUAL 4)
+      set(SCANBOTSDK_TARGET "windows-x86")
+    else()
+      set(SCANBOTSDK_TARGET "windows-x64")
+    endif()
+  elseif(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+    if(CMAKE_SYSTEM_PROCESSOR MATCHES ".*arm.*" OR CMAKE_SYSTEM_PROCESSOR MATCHES ".*aarch64.*")
+      set(SCANBOTSDK_TARGET "linux-aarch64")
+    else()
+      set(SCANBOTSDK_TARGET "linux-x86_64")
+    endif()
+  else()
+    message(FATAL_ERROR "System ${CMAKE_SYSTEM_NAME} not supported")
+  endif()
 
-  find_program(WGET_PATH wget REQUIRED)
+  set(_archive "${SCANBOTSDK_DIR}/scanbotsdk-${SCANBOTSDK_VERSION}-${SCANBOTSDK_TARGET}.tar.gz")
+  set(_url "https://github.com/doo/scanbot-sdk-example-linux/releases/download/standalone-sdk%2Fv${SCANBOTSDK_VERSION}/scanbotsdk-${SCANBOTSDK_VERSION}-${SCANBOTSDK_TARGET}.tar.gz")
 
-  message(STATUS "Downloading ScanbotSDK ${SCANBOTSDK_VERSION} to ${SCANBOTSDK_DIR}")
+  file(MAKE_DIRECTORY "${SCANBOTSDK_DIR}")
 
-  if ("${CMAKE_HOST_SYSTEM_PROCESSOR}" MATCHES ".*arm.*" OR "${CMAKE_HOST_SYSTEM_PROCESSOR}" MATCHES ".*aarch64.*")
-    set(SCANBOTSDK_ARCHITECTURE "aarch64")
-  else ()
-    set(SCANBOTSDK_ARCHITECTURE "x86_64")
-  endif ()
-  string(TOLOWER "${CMAKE_HOST_SYSTEM_NAME}-${SCANBOTSDK_ARCHITECTURE}" PLATFORM_ID)
-  set(URL "https://github.com/doo/scanbot-sdk-example-linux/releases/download/standalone-sdk%2Fv${SCANBOTSDK_VERSION}/scanbotsdk-${SCANBOTSDK_VERSION}-linux-${SCANBOTSDK_ARCHITECTURE}.tar.gz")
   execute_process(
-    COMMAND ${WGET_PATH} "${URL}"
-    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMAND "${CMAKE_COMMAND}"
+      "-DURL=${_url}"
+      "-DDEST=${_archive}"
+      -P "${CMAKE_CURRENT_LIST_DIR}/Download.cmake"
+    RESULT_VARIABLE _rc
   )
+  if(NOT _rc EQUAL 0)
+    file(REMOVE "${_archive}")
+    message(FATAL_ERROR "Failed to download Scanbot SDK from ${_url}")
+  endif()
+
   execute_process(
-    COMMAND tar -xf scanbotsdk-${SCANBOTSDK_VERSION}-${PLATFORM_ID}.tar.gz
-    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMAND "${CMAKE_COMMAND}" -E tar -xf "${_archive}"
+    WORKING_DIRECTORY "${SCANBOTSDK_DIR}"
+    RESULT_VARIABLE _rc
   )
+  if(NOT _rc EQUAL 0)
+    file(REMOVE "${_archive}")
+    file(REMOVE_RECURSE "${SCANBOTSDK_DIR}/scanbotsdk")
+    message(FATAL_ERROR "Failed to extract Scanbot SDK archive ${_archive}")
+  endif()
+
+  file(REMOVE "${_archive}")
 endif()
 
 find_library(ScanbotSDK_LIBS
-  NAMES libscanbotsdk.so
-  HINTS ${SCANBOTSDK_DIR}/lib/
-  )
+  NAMES scanbotsdk
+  PATHS "${SCANBOTSDK_DIR}/scanbotsdk/lib"
+  NO_DEFAULT_PATH
+)
 
 find_path(ScanbotSDK_INCLUDE_DIRS
   NAMES ScanbotSDK.h
-  HINTS ${SCANBOTSDK_DIR}/include/)
+  PATHS "${SCANBOTSDK_DIR}/scanbotsdk/include"
+  NO_DEFAULT_PATH
+)
+
+set(SCANBOTSDK_REQUIRED_VARS ScanbotSDK_LIBS ScanbotSDK_INCLUDE_DIRS)
+
+if(WIN32)
+  find_file(ScanbotSDK_DLL
+    NAMES scanbotsdk.dll
+    PATHS "${SCANBOTSDK_DIR}/scanbotsdk/lib"
+    NO_DEFAULT_PATH
+  )
+  list(APPEND SCANBOTSDK_REQUIRED_VARS ScanbotSDK_DLL)
+endif()
 
 find_package_handle_standard_args(ScanbotSDK
-  REQUIRED_VARS ScanbotSDK_LIBS ScanbotSDK_INCLUDE_DIRS)
+  REQUIRED_VARS ${SCANBOTSDK_REQUIRED_VARS}
+  VERSION_VAR SCANBOTSDK_VERSION
+)
+
+message(STATUS "Scanbot SDK third-party licenses are located at: ${SCANBOTSDK_DIR}/scanbotsdk/licenses/Libraries.txt")
 
-add_library(scanbotsdk SHARED IMPORTED)
-set_target_properties(scanbotsdk PROPERTIES
-        IMPORTED_LOCATION "${ScanbotSDK_LIBS}"
-        INTERFACE_INCLUDE_DIRECTORIES "${ScanbotSDK_INCLUDE_DIRS}"
-)
+add_library(ScanbotSDK::ScanbotSDK SHARED IMPORTED)
+set_target_properties(ScanbotSDK::ScanbotSDK PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES "${ScanbotSDK_INCLUDE_DIRS}"
+)
+
+if(WIN32)
+  set_target_properties(ScanbotSDK::ScanbotSDK PROPERTIES
+    IMPORTED_LOCATION "${ScanbotSDK_DLL}"
+    IMPORTED_IMPLIB "${ScanbotSDK_LIBS}"
+  )
+else()
+  set_target_properties(ScanbotSDK::ScanbotSDK PROPERTIES
+    IMPORTED_LOCATION "${ScanbotSDK_LIBS}"
+  )
+endif()

examples/c/include/snippets/enhancer/document_enhancer.h

@@ -0,0 +1,8 @@
+#ifndef DOCUMENT_ENHANCER_H
+#define DOCUMENT_ENHANCER_H
+
+#include <ScanbotSDK.h>
+
+scanbotsdk_error_code_t enhance_document(scanbotsdk_image_t *image);
+
+#endif

examples/c/src/main.c

@@ -21,7 +21,7 @@
 #include <snippets/document/detect_document.h>    
 #include <snippets/document/analyze_multi_page.h>
 #include <snippets/document/crop_and_analyze.h>
-#include <snippets/document/document_classifier.h>
+#include <snippets/enhancer/document_enhancer.h>
 
 #include <snippets/live/live_barcode.h>
 
@@ -69,13 +69,13 @@ int main(int argc, char *argv[]) {
         else if (strcmp(command, "vin")                == 0) ec = detect_vin(image);
         else { print_usage(argv[0]); ec = SCANBOTSDK_ERROR_INVALID_ARGUMENT; }
     }
-    else if (strcmp(category, "classify") == 0) {
+    else if (strcmp(category, "enhance") == 0) {
         if (!file_path) { print_usage(argv[0]); ec = SCANBOTSDK_ERROR_INVALID_ARGUMENT; goto cleanup; }
 
         ec = load_image_from_path(file_path, &image);
         if (ec != SCANBOTSDK_OK) goto cleanup;
 
-        if      (strcmp(command, "document") == 0) ec = classify_document(image);
+        if      (strcmp(command, "document") == 0) ec = enhance_document(image);
         else { print_usage(argv[0]); ec = SCANBOTSDK_ERROR_INVALID_ARGUMENT; }
     }
     else if (strcmp(category, "analyze") == 0) {