cli: add model search path

.github/workflows/pkg-check.yml

@@ -0,0 +1,69 @@
+name: Package Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build package (static ggml)
+    runs-on: ubuntu-24.04
+    timeout-minutes: 20
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential cmake ninja-build
+
+      - name: Build package archive
+        run: |
+          bash ./scripts/pkg-check/check-package.sh build \
+            --work-dir "$RUNNER_TEMP/pkg-check-build" \
+            --archive "$RUNNER_TEMP/pkg-check-build/visioncpp-package.tgz"
+
+      - name: Upload package archive
+        uses: actions/upload-artifact@v4
+        with:
+          name: visioncpp-package-linux
+          path: ${{ runner.temp }}/pkg-check-build/visioncpp-package.tgz
+          if-no-files-found: error
+
+  check:
+    name: Verify package (consumer check)
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+    needs: build
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential cmake ninja-build
+
+      - name: Download package archive
+        uses: actions/download-artifact@v4
+        with:
+          name: visioncpp-package-linux
+          path: ${{ runner.temp }}/pkg-check-artifact
+
+      - name: Verify package from archive
+        run: |
+          bash ./scripts/pkg-check/check-package.sh check \
+            --work-dir "$RUNNER_TEMP/pkg-check-check" \
+            --from-archive "$RUNNER_TEMP/pkg-check-artifact/visioncpp-package.tgz"

CMakeLists.txt

@@ -1,15 +1,25 @@
 cmake_minimum_required(VERSION 3.28)
 
-project(vision.cpp VERSION 0.3.0 LANGUAGES CXX)
+project(vision.cpp VERSION 0.3.1 LANGUAGES CXX)
 
 option(BUILD_SHARED_LIBS "Build shared libraries instead of static libraries" ON)
 option(VISP_VULKAN "Enable Vulkan support" OFF)
 option(VISP_DEV "Enable development mode" OFF)
 option(VISP_CI "Enable for continuous integration environment" OFF)
 option(VISP_TESTS "Build tests" ${PROJECT_IS_TOP_LEVEL})
+option(VISP_INSTALL_MODELS "Download and install default models" OFF)
 option(VISP_FMT_LIB "Use external fmt library instead of standard C++ <format>" OFF)
+option(VISP_STATIC_GGML "Force static build of ggml" OFF)
 option(VISP_ASAN "Enable AddressSanitizer" OFF)
 
+include(GNUInstallDirs)
+set(VISP_INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR} CACHE PATH "Location of header files")
+set(VISP_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR} CACHE PATH "Location of library files")
+set(VISP_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR} CACHE PATH "Location of binary files")
+if(VISP_INSTALL_MODELS)
+  set(VISP_MODEL_INSTALL_DIR "${CMAKE_INSTALL_DATAROOTDIR}/visioncpp" CACHE PATH "Directory to install default models to")
+endif()
+
 if(PROJECT_IS_TOP_LEVEL)
   set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
   set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
@@ -94,6 +104,15 @@ if(VISP_FMT_LIB)
   list(APPEND VISP_DEFINITIONS VISP_FMT_LIB)
 endif()
 
+set(BUILD_SHARED_LIBS_SAVED ${BUILD_SHARED_LIBS})
+if(VISP_STATIC_GGML)
+  set(BUILD_SHARED_LIBS OFF)
+  set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+  set(GGML_STATIC ON)
+  # Find shared libgomp before ggml finds a static version
+  # - undo https://github.com/ggml-org/llama.cpp/pull/16031
+  find_package(OpenMP)
+endif()
 set(GGML_VULKAN ${VISP_VULKAN})
 set(GGML_LLAMAFILE ON)
 if(VISP_CI)
@@ -110,6 +129,7 @@ if(VISP_CI)
   endif()
 endif()
 add_subdirectory(depend/llama/ggml)
+set(BUILD_SHARED_LIBS ${BUILD_SHARED_LIBS_SAVED})
 
 # Vision.cpp libraries and executables
 
@@ -121,15 +141,13 @@ add_subdirectory(src/cli)
 if(VISP_TESTS)
   enable_testing()
   add_subdirectory(tests)
+endif()
+if(VISP_TESTS OR VISP_INSTALL_MODELS)
   add_subdirectory(models)
 endif()
 
 # Installation
 
-set(VISP_INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR} CACHE PATH "Location of header files")
-set(VISP_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR} CACHE PATH "Location of library files")
-set(VISP_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR} CACHE PATH "Location of binary files")
-
 install(TARGETS visioncpp
   RUNTIME DESTINATION ${VISP_BIN_INSTALL_DIR}
   LIBRARY DESTINATION ${VISP_LIB_INSTALL_DIR}
@@ -138,6 +156,9 @@ install(DIRECTORY include/ DESTINATION ${VISP_INCLUDE_INSTALL_DIR})
 if(PROJECT_IS_TOP_LEVEL)
   install(FILES README.md LICENSE DESTINATION .)
 endif()
+if(VISP_INSTALL_MODELS)
+  install(FILES ${VISP_DEFAULT_MODELS} DESTINATION ${VISP_MODEL_INSTALL_DIR})
+endif()
 
 install(TARGETS vision-cli RUNTIME DESTINATION ${VISP_BIN_INSTALL_DIR})
 

models/CMakeLists.txt

@@ -1,37 +1,43 @@
-# Download models used in tests (happens only if VISP_TESTS is enabled)
+# Download models used in tests or for installation
 
-message(STATUS "Checking for models/MobileSAM-F16.gguf")
-file(DOWNLOAD
+function(download_model url filename hash)
+  message(STATUS "Checking for ${filename}")
+  file(DOWNLOAD
+    ${url}
+    ${CMAKE_CURRENT_LIST_DIR}/${filename}
+    EXPECTED_HASH ${hash}
+    SHOW_PROGRESS
+  )
+  set(DEFAULT_MODELS "${DEFAULT_MODELS};${CMAKE_CURRENT_LIST_DIR}/${filename}" PARENT_SCOPE)
+endfunction()
+
+
+download_model(
   "https://huggingface.co/Acly/MobileSAM-GGUF/resolve/main/MobileSAM-F16.gguf"
-  ${CMAKE_CURRENT_LIST_DIR}/MobileSAM-F16.gguf
-  EXPECTED_HASH "SHA256=b546366475e3ad744bb2eaf7634df88e9aaf25f6622797d2de300f5a530831f7"
-  SHOW_PROGRESS
+  "MobileSAM-F16.gguf"
+  "SHA256=b546366475e3ad744bb2eaf7634df88e9aaf25f6622797d2de300f5a530831f7"
 )
-message(STATUS "Checking for models/BiRefNet-lite-F16.gguf")
-file(DOWNLOAD
+download_model(
   "https://huggingface.co/Acly/BiRefNet-GGUF/resolve/main/BiRefNet-lite-F16.gguf"
-  ${CMAKE_CURRENT_LIST_DIR}/BiRefNet-lite-F16.gguf
-  EXPECTED_HASH "SHA256=7b5397a2c98d66677f8f74317774bbeac49dbb321b8a3dc744af913db71d4fa5"
-  SHOW_PROGRESS
+  "BiRefNet-lite-F16.gguf"
+  "SHA256=7b5397a2c98d66677f8f74317774bbeac49dbb321b8a3dc744af913db71d4fa5"
 )
-message(STATUS "Checking for models/Depth-Anything-V2-Small-F16.gguf")
-file(DOWNLOAD
+download_model(
   "https://huggingface.co/Acly/Depth-Anything-V2-GGUF/resolve/main/Depth-Anything-V2-Small-F16.gguf"
-  ${CMAKE_CURRENT_LIST_DIR}/Depth-Anything-V2-Small-F16.gguf
-  EXPECTED_HASH "SHA256=0f83332d6a8b4375cd7fdcc168f3e3636f474f8e84b0959e903f513aace782f5"
-  SHOW_PROGRESS
+  "Depth-Anything-V2-Small-F16.gguf"
+  "SHA256=0f83332d6a8b4375cd7fdcc168f3e3636f474f8e84b0959e903f513aace782f5"
 )
-message(STATUS "Checking for models/MIGAN-512-places2-F16.gguf")
-file(DOWNLOAD
+download_model(
   "https://huggingface.co/Acly/MIGAN-GGUF/resolve/main/MIGAN-512-places2-F16.gguf"
-  ${CMAKE_CURRENT_LIST_DIR}/MIGAN-512-places2-F16.gguf
-  EXPECTED_HASH "SHA256=3e47592bf716d0dc306f8dc02d4476cfcdaf2c055fa3c3c8e0ced4db775eb64b"
-  SHOW_PROGRESS
+  "MIGAN-512-places2-F16.gguf"
+  "SHA256=3e47592bf716d0dc306f8dc02d4476cfcdaf2c055fa3c3c8e0ced4db775eb64b"
 )
-message(STATUS "Checking for models/RealESRGAN-x4plus_anime-6B-F16.gguf")
-file(DOWNLOAD
-  "https://huggingface.co/Acly/Real-ESRGAN-GGUF/resolve/main/RealESRGAN-x4plus_anime-6B-F16.gguf"
-  ${CMAKE_CURRENT_LIST_DIR}/RealESRGAN-x4plus_anime-6B-F16.gguf
-  EXPECTED_HASH "SHA256=730469c5a2269cdef96d0d58aacf87bcf25d7a0d92256685808e6cdce0675c09"
-  SHOW_PROGRESS
-)
+if(VISP_TESTS)
+  download_model(
+    "https://huggingface.co/Acly/Real-ESRGAN-GGUF/resolve/main/RealESRGAN-x4plus_anime-6B-F16.gguf"
+    "RealESRGAN-x4plus_anime-6B-F16.gguf"
+    "SHA256=730469c5a2269cdef96d0d58aacf87bcf25d7a0d92256685808e6cdce0675c09"
+  )
+endif()
+
+set(VISP_DEFAULT_MODELS "${DEFAULT_MODELS}" PARENT_SCOPE)

scripts/cmake/visioncpp-config.cmake.in

@@ -3,6 +3,7 @@
 set_and_check(VISP_INCLUDE_DIR "@PACKAGE_VISP_INCLUDE_INSTALL_DIR@")
 set_and_check(VISP_LIB_DIR "@PACKAGE_VISP_LIB_INSTALL_DIR@")
 
+include(CMakeFindDependencyMacro)
 find_dependency(ggml)
 
 find_library(VISP_LIBRARY visioncpp REQUIRED HINTS ${VISP_LIB_DIR} NO_CMAKE_FIND_ROOT_PATH)

scripts/pkg-check/CMakeLists.txt

@@ -0,0 +1,9 @@
+cmake_minimum_required(VERSION 3.28)
+
+project(visioncpp_pkg_check LANGUAGES C CXX)
+
+find_package(visioncpp CONFIG REQUIRED)
+
+add_executable(pkg-check main.cpp)
+target_link_libraries(pkg-check PRIVATE visioncpp)
+set_target_properties(pkg-check PROPERTIES BUILD_RPATH "$<TARGET_FILE_DIR:visioncpp>")