Merge branch 'release/0.7.1'

Include full DEB installer generator

Author: J. Cappelletto

.github/workflows/ci.yml

@@ -12,6 +12,8 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+permissions:
+  contents: write
 jobs:
   build-test:
     strategy:
@@ -40,7 +42,8 @@ jobs:
                                   libopencv-dev \
                                   doxygen graphviz \
                                   libyaml-cpp-dev \
-                                  ccache
+                                  ccache \
+                                  dpkg-dev fakeroot
 
       - name: Enable ccache (Ubuntu)
         if: matrix.os == 'ubuntu-latest'
@@ -99,7 +102,17 @@ jobs:
           echo "VCPKG_TARGET_TRIPLET=x64-windows" >> $env:GITHUB_ENV
           echo "VCPKG_HOST_TRIPLET=x64-windows" >> $env:GITHUB_ENV
 
-      # -------- Configure --------
+      # Tag inference mechanism
+      - name: Derive version from tag (or fallback)
+        shell: bash
+        run: |
+          if [[ "${GITHUB_REF}" == refs/tags/v* ]]; then
+            echo "PKG_VERSION=${GITHUB_REF_NAME#v}" >> $GITHUB_ENV
+          else
+            echo "PKG_VERSION=${{ env.BUILD_TYPE }}-snapshot" >> $GITHUB_ENV
+          fi
+      
+          # -------- Configure --------
       - name: Configure (CMake)
         shell: pwsh
         run: |
@@ -108,6 +121,7 @@ jobs:
             "-G", "Ninja",
             "-DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}",
             "-DBUILD_TESTS=ON",
+            "-DPROJECT_VERSION=${{ env.PKG_VERSION }}",
             "-DCMAKE_RUNTIME_OUTPUT_DIRECTORY=build/bin",
             "-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=build/lib",
             "-DCMAKE_ARCHIVE_OUTPUT_DIRECTORY=build/lib"
@@ -150,14 +164,6 @@ jobs:
           if-no-files-found: ignore
           retention-days: 30
 
-      # -------- Package (CPack) --------
-    #   - name: CPack (package binaries)
-    #     if: (github.ref == 'refs/heads/master') || startsWith(github.ref, 'refs/tags/v')
-    #     working-directory: build
-    #     run: |
-    #       cpack -G ZIP
-    #       cpack -G TGZ
-
       # -------- Package (CPack via CMake target) --------
       - name: Package (CPack)
         if: (github.ref == 'refs/heads/master') || startsWith(github.ref, 'refs/tags/v')
@@ -176,9 +182,10 @@ jobs:
             build/bin/**/*.pdb
             build/lib/**/*.lib
             build/*.zip
-          retention-days: 30
+            build/*.tar.gz
+          retention-days: 14
 
-      - name: Upload artifacts (Linux TGZ)
+      - name: Upload artifacts (Linux packages)
         if: (matrix.os == 'ubuntu-latest') && ((github.ref == 'refs/heads/master') || startsWith(github.ref, 'refs/tags/v'))
         uses: actions/upload-artifact@v4
         with:
@@ -187,4 +194,41 @@ jobs:
             build/bin/videostrip_cli
             build/lib/**/*.a
             build/*.tar.gz
+            build/*.deb
           retention-days: 14
+
+  release:
+    if: startsWith(github.ref, 'refs/tags/v')      # only on tag like v0.7.0
+    needs: [ build-test ]                          # wait for matrix to finish
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download Windows artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: videostrip-windows-Release
+          path: artifacts/windows
+
+      - name: Download Linux artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: videostrip-linux-Release
+          path: artifacts/linux
+
+      - name: List files
+        run: find artifacts -type f -maxdepth 3 -printf "%p\n"
+
+      - name: Publish GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          draft: false
+          prerelease: false
+          files: |
+            artifacts/windows/*.zip
+            artifacts/windows/*.tar.gz
+            artifacts/linux/*.tar.gz
+            artifacts/linux/*.deb
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,5 +1,7 @@
 .vscode/*
 
+next_steps.md
+
 # Doxygen
 doc/html/*
 doc/latex/*

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.18)
-project(videostrip VERSION 0.7.0 LANGUAGES CXX)
+project(videostrip VERSION 0.7.1 LANGUAGES CXX)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -137,36 +137,58 @@ install(TARGETS videostrip_core
   LIBRARY DESTINATION lib
 )
 
+# TODO: Minimal manpage (optional). We do not have one yet, generate with help2man later.
+# install(FILES packaging/videostrip.1 DESTINATION share/man/man1)
+
 # Public headers (install only .hpp files from videostrip_core/)
-# If your headers live in subdirs (feature/, logging/), this will include them.
+# If the headers live in subdirs (feature/, logging/), this will include them.
 install(DIRECTORY ${CMAKE_SOURCE_DIR}/videostrip_core/
   DESTINATION include/videostrip_core
-  FILES_MATCHING
-    PATTERN "*.hpp"
+  FILES_MATCHING PATTERN "*.hpp"
 )
 
+# Install shared assets
+install(FILES configs/sample_config.yaml
+        DESTINATION share/videostrip)
 # Licenses / docs
 install(FILES ${CMAKE_SOURCE_DIR}/README.md ${CMAKE_SOURCE_DIR}/LICENSE
-  DESTINATION .
+  DESTINATION share/doc/videostrip
 )
 
 # -------------------------
 # CPack configuration
 # -------------------------
+
 set(CPACK_PACKAGE_NAME "videostrip")
-set(CPACK_PACKAGE_VENDOR "cappelletto")
+set(CPACK_PACKAGE_VENDOR "Rivermouth")
+set(CPACK_PACKAGE_CONTACT "[email protected]")
+set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Video transect utilities for 2D/3D mapping (CLI)")
 set(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}")
-set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Smart video frame extraction for 2D/3D reconstruction pipelines")
 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
 set(CPACK_RESOURCE_FILE_README  "${CMAKE_SOURCE_DIR}/README.md")
-
 # Nice archive base name: videostrip-0.7.0-Linux-x86_64, etc.
 string(TOLOWER "${CMAKE_SYSTEM_NAME}" _sysname_lc)
 set(CPACK_PACKAGE_FILE_NAME
   "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}"
 )
 
-# Generators we use in CI
-set(CPACK_GENERATOR "ZIP;TGZ")
-
-include(CPack)
+# Source + binary archives
+set(CPACK_GENERATOR "TGZ;ZIP;DEB")
+
+# Debian metadata (tune as you learn your shared libs)
+set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Jose Cappelletto")           # required
+set(CPACK_DEBIAN_PACKAGE_SECTION "science")
+set(CPACK_DEBIAN_ARCHITECTURE ${CMAKE_SYSTEM_PROCESSOR})
+
+# Runtime deps if linking dynamically; keep minimal first, then refine with ldd
+# Example: 
+set(CPACK_DEBIAN_PACKAGE_DEPENDS "libstdc++6, libgcc-s1")
+# TODO: 
+# Add correct libraries from OpenCV
+# set(CPACK_DEBIAN_PACKAGE_DEPENDS "libopencv-core4.8, libopencv-imgcodecs4.8")
+set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON)
+# Avoid the classic error: ensure CPack knows the project
+set(CPACK_PACKAGE_FILE_NAME "videostrip-${PROJECT_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}")
+
+include(CPack)
+# End of CPack configuration

tests/CMakeLists.txt

@@ -15,7 +15,7 @@ FetchContent_MakeAvailable(Catch2)
 include(Catch)  # provides catch_discover_tests()
 
 # ---- Common includes for tests (allow <videostrip_core/...> etc.) ----
-# Adjust if you need stricter scoping:
+# Adjust if we need stricter scoping:
 set(TEST_COMMON_INCLUDES
   ${CMAKE_SOURCE_DIR}
 )
@@ -82,7 +82,7 @@ if (EXISTS ${CONFIG_YAML_SRC})
       catch_discover_tests(test_config_yaml
         WORKING_DIRECTORY $<TARGET_FILE_DIR:test_config_yaml>
       )
-      # Optional explicit CTest name, if you kept add_test() elsewhere:
+      # Optional explicit CTest name
       add_test(NAME config_yaml COMMAND test_config_yaml)
     endif()
   else()

tests/test_core_smoke.cpp

@@ -3,7 +3,7 @@
 #include <fstream>
 #include <opencv2/opencv.hpp>
 
-#include <videostrip_core/videostrip_core.hpp>                // your public API
+#include <videostrip_core/videostrip_core.hpp>                // the public API
 #include <videostrip_core/feature/feature_extractor.hpp>      // used indirectly
 #include <videostrip_core/logging/logger.hpp>                 // ConsoleLogger
 
@@ -24,13 +24,6 @@ static fs::path make_tmp_dir(const std::string& name) {
     return base;
 }
 
-
-// static fs::path make_tmp_dir(const std::string& name) {
-//     auto base = fs::temp_directory_path() / ("vs_" + name + "_" + std::to_string(::getpid()));
-//     fs::create_directories(base);
-//     return base;
-// }
-
 TEST_CASE("core: synthetic video to images + CSV + YAML", "[core][smoke]") {
     // --- 1) Make synthetic video (20 frames @ 10 fps) ---
     const int W=320, H=240, FPS=10, N=20;

videostrip_cli/config_loader.hpp

@@ -34,7 +34,7 @@ void normalize_output_paths(ExtractorConfig& cfg, const std::string& base_dir);
 /**
  * @brief Merge precedence helper: dst = YAML ; then apply CLI overrides.
  *        Only overwrites fields when src has non-empty values / set flags.
- *        (You still need to clamp/validate after merging.)
+ *        (Still need to clamp/validate after merging.)
  */
 void merge_yaml_into(ExtractorConfig& dst, const ExtractorConfig& yamlCfg);
 

videostrip_gui/videostrip-gui.cpp

@@ -39,49 +39,6 @@ using namespace vs;
 
 int main(int argc, char *argv[])
 {
-    vs::vsGui       gui;
-    vs::VideoFile   video;
 
-    int retval = gui.Init();;   // OpenGL context setup
-    if (retval) {
-        vs::logc.error("main", "OpenGL + imgui context setup failed");
-        return retval;
-    }
-
-    // Our state
-    ImGui::SetNextWindowSize(ImVec2(750,400));
-    // Main loop
-
-    // let's populate with some data for testing purposes
-    if (video.peekFile("/home/cappelletto/Videos/fran01.mp4") == -1) {
-        vs::logc.error("main", "Video file peek failed");
-        return -1;
-    }
-    else{
-        vs::logc.info("main", "Video file peek success");
-    }
-
-    static bool window_flag = true;
-    while (!gui.ShouldClose() && window_flag)
-    {
-        // Poll and handle events (inputs, window resize, etc.)
-        // You can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if dear imgui wants to use your inputs.
-        // - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application.
-        // - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application.
-        // Generally you may always pass all inputs to dear imgui, and hide them from your application based on those two flags.
-        glfwPollEvents();
-        gui.NewFrame();
-
-        int r = drawWindowInput(video);
-        // now we call to the drawWindowInfo function
-        drawWindowInfo(video);  // read-only, could be const &
-
-        // Rendering
-        gui.Render();
-    }
-
-    // Cleanup
-    gui.Destroy();
-    vs::logc.info("main", "Exiting");
     return 0;
 }