labrecorder 1.0.0rc0__tar.gz

labrecorder-1.0.0rc0/.github/workflows/build.yml

@@ -0,0 +1,287 @@
+# =============================================================================
+# LabRecorder Build Workflow
+# =============================================================================
+# This workflow builds, tests, and packages LabRecorder for all supported
+# platforms.
+#
+# Features:
+#   - Multi-platform builds (Linux, macOS, Windows)
+#   - Qt6 integration
+#   - Automatic liblsl fetch via FetchContent
+#   - CPack packaging
+#   - macOS code signing and notarization (on release)
+# =============================================================================
+
+name: Build
+
+on:
+  push:
+    branches: [main, master, dev]
+    tags: ['v*']
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+env:
+  BUILD_TYPE: Release
+
+jobs:
+  # ===========================================================================
+  # Build Job - Multi-platform builds
+  # ===========================================================================
+  build:
+    name: ${{ matrix.config.name }}
+    runs-on: ${{ matrix.config.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - { name: "Ubuntu 22.04", os: ubuntu-22.04 }
+          - { name: "Ubuntu 24.04", os: ubuntu-24.04 }
+          - { name: "macOS", os: macos-14, cmake_extra: '-DCMAKE_OSX_ARCHITECTURES="x86_64;arm64"' }
+          - { name: "Windows", os: windows-latest }
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # -----------------------------------------------------------------------
+      # Install CMake 3.28+ (Ubuntu 22.04 ships with 3.22)
+      # -----------------------------------------------------------------------
+      - name: Install CMake
+        if: runner.os == 'Linux'
+        uses: lukka/get-cmake@latest
+
+      # -----------------------------------------------------------------------
+      # Install Qt6 (6.8 LTS across all platforms)
+      # -----------------------------------------------------------------------
+      - name: Install Linux dependencies
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libgl1-mesa-dev libxkbcommon-dev libxcb-cursor0
+
+      - name: Install Qt
+        uses: jurplel/install-qt-action@v4
+        with:
+          version: '6.8.*'
+          cache: true
+
+      # -----------------------------------------------------------------------
+      # Configure
+      # -----------------------------------------------------------------------
+      - name: Configure CMake
+        run: >
+          cmake -S . -B build
+          -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }}
+          -DCMAKE_INSTALL_PREFIX=${{ github.workspace }}/install
+          -DLSL_FETCH_IF_MISSING=ON
+          ${{ matrix.config.cmake_extra }}
+
+      # -----------------------------------------------------------------------
+      # Build
+      # -----------------------------------------------------------------------
+      - name: Build
+        run: cmake --build build --config ${{ env.BUILD_TYPE }} --parallel
+
+      # -----------------------------------------------------------------------
+      # Install
+      # -----------------------------------------------------------------------
+      - name: Install
+        run: cmake --install build --config ${{ env.BUILD_TYPE }}
+
+      # -----------------------------------------------------------------------
+      # Test CLI
+      # -----------------------------------------------------------------------
+      - name: Test CLI (Linux)
+        if: runner.os == 'Linux'
+        run: ./install/bin/LabRecorderCLI --help || true
+
+      - name: Test CLI (macOS)
+        if: runner.os == 'macOS'
+        run: ./install/LabRecorderCLI --help || true
+
+      - name: Test CLI (Windows)
+        if: runner.os == 'Windows'
+        run: ./install/LabRecorderCLI.exe --help || true
+
+      # -----------------------------------------------------------------------
+      # Package
+      # -----------------------------------------------------------------------
+      - name: Package
+        run: cpack -C ${{ env.BUILD_TYPE }}
+        working-directory: build
+
+      # -----------------------------------------------------------------------
+      # Upload Artifacts
+      # -----------------------------------------------------------------------
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: package-${{ matrix.config.os }}
+          path: |
+            build/*.zip
+            build/*.tar.gz
+            build/*.deb
+          if-no-files-found: ignore
+
+  # ===========================================================================
+  # macOS Signing and Notarization (Release only)
+  # ===========================================================================
+  sign-macos:
+    name: Sign & Notarize (macOS)
+    needs: build
+    if: github.event_name == 'release'
+    runs-on: macos-14
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download macOS Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: package-macos-14
+          path: packages
+
+      - name: Extract Package
+        run: |
+          cd packages
+          tar -xzf *.tar.gz
+          # Move contents out of versioned subdirectory to packages/
+          SUBDIR=$(ls -d LabRecorder-*/ | head -1)
+          mv "$SUBDIR"/* .
+          rmdir "$SUBDIR"
+          ls -la
+
+      # -----------------------------------------------------------------------
+      # Install Apple Certificates
+      # -----------------------------------------------------------------------
+      - name: Install Apple Certificates
+        env:
+          MACOS_CERTIFICATE: ${{ secrets.PROD_MACOS_CERTIFICATE }}
+          MACOS_CERTIFICATE_PWD: ${{ secrets.PROD_MACOS_CERTIFICATE_PWD }}
+        run: |
+          # Create temporary keychain
+          KEYCHAIN_PATH=$RUNNER_TEMP/build.keychain
+          MACOS_CI_KEYCHAIN_PWD=$(openssl rand -base64 32)
+          security create-keychain -p "$MACOS_CI_KEYCHAIN_PWD" $KEYCHAIN_PATH
+          security default-keychain -s $KEYCHAIN_PATH
+          security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
+          security unlock-keychain -p "$MACOS_CI_KEYCHAIN_PWD" $KEYCHAIN_PATH
+
+          # Import certificate
+          CERTIFICATE_PATH=$RUNNER_TEMP/build_certificate.p12
+          echo -n "$MACOS_CERTIFICATE" | base64 --decode -o $CERTIFICATE_PATH
+          security import $CERTIFICATE_PATH -P "$MACOS_CERTIFICATE_PWD" -k $KEYCHAIN_PATH -A -t cert -f pkcs12
+          rm $CERTIFICATE_PATH
+
+          # Allow codesign to access keychain
+          security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_CI_KEYCHAIN_PWD" $KEYCHAIN_PATH
+          security list-keychain -d user -s $KEYCHAIN_PATH
+
+          # Extract identity name and export to environment
+          IDENTITY=$(security find-identity -v -p codesigning $KEYCHAIN_PATH | grep "Developer ID Application" | head -1 | awk -F'"' '{print $2}')
+          echo "APPLE_CODE_SIGN_IDENTITY_APP=$IDENTITY" >> $GITHUB_ENV
+
+      # -----------------------------------------------------------------------
+      # Setup Notarization Credentials
+      # -----------------------------------------------------------------------
+      - name: Setup Notarization
+        env:
+          NOTARIZATION_APPLE_ID: ${{ secrets.PROD_MACOS_NOTARIZATION_APPLE_ID }}
+          NOTARIZATION_PWD: ${{ secrets.PROD_MACOS_NOTARIZATION_PWD }}
+          NOTARIZATION_TEAM_ID: ${{ secrets.PROD_MACOS_NOTARIZATION_TEAM_ID }}
+        run: |
+          xcrun notarytool store-credentials "notarize-profile" \
+            --apple-id "$NOTARIZATION_APPLE_ID" \
+            --password "$NOTARIZATION_PWD" \
+            --team-id "$NOTARIZATION_TEAM_ID"
+          echo "APPLE_NOTARIZE_KEYCHAIN_PROFILE=notarize-profile" >> $GITHUB_ENV
+
+      # -----------------------------------------------------------------------
+      # Sign and Notarize
+      # -----------------------------------------------------------------------
+      - name: Sign and Notarize
+        env:
+          ENTITLEMENTS_FILE: ${{ github.workspace }}/app.entitlements
+        run: |
+          # Sign GUI app bundle (--deep handles all nested code including lsl.framework)
+          APP_PATH=$(find packages -name "*.app" -type d | head -1)
+          if [[ -n "$APP_PATH" ]]; then
+            ./scripts/sign_and_notarize.sh "$APP_PATH" --notarize
+          fi
+
+          # Sign CLI and its bundled lsl.framework
+          CLI_PATH=$(find packages -name "LabRecorderCLI" -type f | head -1)
+          if [[ -n "$CLI_PATH" ]]; then
+            CLI_DIR=$(dirname "$CLI_PATH")
+            # Sign framework first (dependency must be signed before dependent)
+            if [[ -d "$CLI_DIR/Frameworks/lsl.framework" ]]; then
+              codesign --force --sign "$APPLE_CODE_SIGN_IDENTITY_APP" --options runtime \
+                "$CLI_DIR/Frameworks/lsl.framework"
+            fi
+            ./scripts/sign_and_notarize.sh "$CLI_PATH" --notarize
+          fi
+
+      # -----------------------------------------------------------------------
+      # Repackage
+      # -----------------------------------------------------------------------
+      - name: Repackage
+        run: |
+          cd packages
+
+          # Debug: show what we have
+          echo "Contents of packages directory:"
+          ls -la
+
+          # Remove original unsigned package
+          rm -f *.tar.gz
+
+          # Get project version from CMakeLists.txt
+          VERSION=$(grep -A1 'project(LabRecorder' ../CMakeLists.txt | grep VERSION | sed 's/.*VERSION \([0-9.]*\).*/\1/')
+          echo "Detected version: $VERSION"
+
+          # Create signed package with CLI and its Frameworks (universal binary)
+          tar -cvzf "LabRecorder-${VERSION}-macOS_universal-signed.tar.gz" \
+            LabRecorder.app LabRecorderCLI Frameworks LabRecorder.cfg LICENSE README.md
+
+          echo "Created package:"
+          ls -la *.tar.gz
+
+      - name: Upload Signed Package
+        uses: actions/upload-artifact@v4
+        with:
+          name: package-macos-signed
+          path: packages/*-signed.tar.gz
+
+      - name: Upload to Release
+        if: github.event_name == 'release'
+        uses: softprops/action-gh-release@v2
+        with:
+          files: packages/*-signed.tar.gz
+
+  # ===========================================================================
+  # Upload unsigned packages to release
+  # ===========================================================================
+  release:
+    name: Upload to Release
+    needs: build
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download All Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+
+      - name: Upload to Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            artifacts/**/*.zip
+            artifacts/package-ubuntu-*/*.tar.gz
+            artifacts/**/*.deb

labrecorder-1.0.0rc0/.gitignore

@@ -0,0 +1,21 @@
+*.ui.autosave
+ui_*.h
+/build*/
+/package*/
+/install*/
+/CMakeLists.txt.user
+/CMakeLists.json
+/.vs/
+/.vscode/
+/out/
+/CMakeSettings.json
+# CLion
+.idea/
+cmake-build-debug/
+cmake-build-release/
+# Generated by CI scripts - or maintainers debugging CI scripts:
+liblsl.deb
+install-qt.sh
+.DS_Store
+
+/dist/

labrecorder-1.0.0rc0/.travis.yml

@@ -0,0 +1,38 @@
+language: cpp
+compiler: clang
+env:
+  APP_VERSION="1.13.1"
+matrix:
+  include:
+  - os: osx
+    osx_image: xcode10.1
+before_install:
+- mkdir LSL
+- brew update
+- brew upgrade cmake
+install:
+- git clone https://github.com/sccn/liblsl.git
+- cmake -S liblsl -B liblsl/build -DCMAKE_INSTALL_PREFIX=$PWD/LSL/ -DLSL_UNIXFOLDERS=ON ..
+- cmake --build liblsl/build --config Release --target install
+before_script:
+- brew install qt;
+- export LSL_INSTALL_ROOT=LSL
+script:
+- cmake --version
+- cmake -S . -B build -DLSL_INSTALL_ROOT=${LSL_INSTALL_ROOT} -DQt5_DIR=/usr/local/opt/qt/lib/cmake/Qt5
+- cmake --build build --config Release --target install
+- cd build/install/Labrecorder
+- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then for app in *.app; do /usr/local/opt/qt/bin/macdeployqt
+  ${app} -dmg; mv "${app%.app}.dmg" "${app%.app}-${APP_VERSION}-${TRAVIS_OSX_IMAGE}.dmg";
+  done; fi
+deploy:
+  provider: releases
+  skip_cleanup: true
+  api_key:
+    secure: FQ+xqPuImk2ie4KeoDrP1u+6TB2qIoLPTk0wr7EEv+7oBfLodExVSyC67TEUVKUVnAYv2E1FFfHLZPUzMeiuFT6o40jkwekHEte3dbgWTgmW9iqiDw4eK5X0obZbDoYLJBbOiQfUsgH8nKpE/U5MprTpQ3KKQr2CjbcqGZnDY6k2yNope70bMe//4zBgv+qjvR1CDeI8sSrSUkBgDgVhujqNzS8I0FPoLAmJuBuFiA5Y7f/uwO17M1Nfso9WnNiWA8XhgJ1mgoA8BYrIx9hP2niK4gkFJ3p/iV0IK51KNxEELIQ7IKw/U12CLYD7+hKFBpyrZGcgCwXCHXR/G3/kNsxJrk395u+78gTLdiE3AuksWQZ+f+6br2pBG3UBTu/Qm3cVcVQRtNArKXDgiCaMc0qECL51o6qNTzPhLAHvGVGZCOjp34vW44MMWtKh584LqShojN/DH1OBUR3PjaHHiuxQMuaUXHto8SDfl0ZRSaeyElI+6kmU3XfTJfqFq2DpTX5LMYoiZUXwMKKQtWTGp8I2axL1LCnUsX/nlY63AoCY7CJTwX+DE1//YBwOsfafQ/VOMIpzQCXJNuHR3EAFVk+qcFt0wTVu/aa2oTkBaGN67LE22/pkwT4kxpI3kaXDo94CE0diEZWu4hHHNoQF1C/WuH/DH4HErJW8tPGrEm8=
+  file:
+  - LabRecorder-${APP_VERSION}-${TRAVIS_OSX_IMAGE}.dmg
+  - LabRecorderCLI-${APP_VERSION}-${TRAVIS_OSX_IMAGE}.dmg
+  on:
+    repo: labstreaminglayer/App-LabRecorder
+    tags: true

labrecorder-1.0.0rc0/BUILD.md

@@ -0,0 +1,125 @@
+# Building Lab Recorder
+
+This file includes quick start recipes. To see general principles, look [here](https://github.com/labstreaminglayer/labstreaminglayer/blob/master/doc/BUILD.md).
+
+
+## Windows - CMake - Visual Studio 2017
+
+Starting with Visual Studio 2017, Microsoft began to support much closer integration with CMake. Generally, this uses the Visual Studio GUI as a wrapper around the CMake build files, so you should not expect to see most of the Visual Studio Project configuration options that you are familiar with, and CMake projects cannot be directly blended with non-CMake Visual Studio projects. There are also some weird gotchas, described below.
+
+You will need to download and install:<BR/>
+ * [The full LabStreamingLayer meta project](https://github.com/labstreaminglayer/labstreaminglayer) -> Clone (include --recursive flag) or download  
+ * [Visual Studio Community 2017](https://imagine.microsoft.com/en-us/Catalog/Product/530)
+ * [CMake 3.12.1](https://cmake.org/files/v3.12/)
+ * [Qt 5.11.1](https://download.qt.io/archive/qt/5.11/) 
+ * [Boost 1.65.1](https://sourceforge.net/projects/boost/files/boost-binaries/1.65.1/boost_1_65_1-msvc-14.1-32.exe/download)
+
+
+From Visual Studio:<BR/> 
+ * File -> Open -> CMake -> labstreaminglayer/CMakeLists.txt
+ * Wait while CMake configures automatically and until CMake menu turns black
+ * Select x86-Release
+ * CMake menu -> Change CMake Settings -> LabStreamingLayer
+
+Add the "variable" section to the x86-Release group, so that it looks approximately like this:
+```
+{
+  "name": "x86-Release",
+  "generator": "Ninja",
+  "configurationType": "RelWithDebInfo",
+  "inheritEnvironments": [ "msvc_x86" ],
+  "buildRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\build\\${name}",
+  "installRoot": "${env.USERPROFILE}\\CMakeBuilds\\${workspaceHash}\\install\\${name}",
+  "cmakeCommandArgs": "",
+  "buildCommandArgs": "-v",
+  "ctestCommandArgs": "",
+  "variables": [
+    {
+      "name": "Qt5_DIR",
+      "value": "C:\\Qt\\5.11.1\\msvc2015\\lib\\cmake\\Qt5 "
+    },
+    {
+      "name": "BOOST_ROOT",
+      "value": "C:\\local\\boost_1_65_1"
+    },
+    {
+      "name": "LSLAPPS_LabRecorder",
+      "value": "ON"
+    }
+  ]
+}
+```
+	
+ * Also consider changing the build and install roots, as the default path is obscure. When you save this file, CMake should reconfigure, and show the output in the output window (including any CMake configuration errors).
+
+ * Note that it is not a typo that Qt refers to msvc2015 rather than msvc2017.
+
+ * Select Startup Item (green arrow dropdown) -> LabRecorder.exe (Install)
+
+ * Click the green arrow. The application should launch.
+
+Note that if you change Qt versions, or other significant changes, it will be necessary to do a full rebuild before CMake correctly notices the change. CMake -> Clean All is not sufficient to force this.
+
+Just deleting the build folder causes an unfortunate error (build folder not found) on rebuild. To do a full rebuild, it is necessary to change the build and install folder paths in CMake -> Change CMake Settings -> LabStreamingLayer, build, then delete the old folder, change the path back, and build again.
+
+
+## Windows - CMake - Legacy
+
+This procedure also works in Visual Studio 2017, if desired. Generally, I'd recommend sticking with the newer procedure and Visual Studio 2017.
+
+This procedure generates a Visual Studio type project from the CMake files, which can then be opened in Visual Studio.
+
+You will need to download and install:<BR/>
+ * The full [LabStreamingLayer meta project](https://github.com/labstreaminglayer/labstreaminglayer) -> Clone (include --recursive flag) or download  
+ * Desired Visual Studio Version (the example uses 2015).
+ * [CMake 3.12.1](https://cmake.org/files/v3.12/)
+ * [Qt 5.11.1](https://download.qt.io/archive/qt/5.11/) 
+ * [Boost 1.65.1](https://sourceforge.net/projects/boost/files/boost-binaries/1.65.1/boost_1_65_1-msvc-14.1-32.exe/download)
+
+From the command line, from the labstreaminglayer folder:
+ * labstreaminglayer\build>cmake .. -G "Visual Studio 14 2015" -DQt5_DIR="C:/Qt/5.11.1/msvc2015/lib/cmake/Qt5" -DBOOST_ROOT=C:\boost\boost_1_65_1 -DLSLAPPS_LabRecorder=ON
+
+ * labstreaminglayer\build>cmake --build . --config Release --target install
+
+To see a list of possible generators, run the command with garbage in the -G option. 
+
+The executable is in labstreaminglayer\build\install\LabRecorder.
+
+You can open the Visual Studio Project with labstreaminglayer\build\LabStreamingLayer.sln.
+
+The command line install feature does not put build products in the sample place as when you build inside of Visual Studio. To get running to work inside of Visual Studio, it is necessary to copy the support files from labstreaminglayer\build\install\LabRecorder to labstreaminglayer\build\Apps\LabRecorder\Release. You must also right click LabRecorder -> Set as Startup Project and select Release and Win32.<BR/>
+
+If any significant changes are made to the project (such as changing Qt or Visual Stuido version) it is recommended that you delete or rename the build folder and start over. Various partial cleaning processes do not work well.
+
+
+## Linux
+
+    * Ubuntu (/Debian)
+        * `sudo apt-get install build-essential cmake qt5-default libboost-all-dev`
+
+1. Open a Command Prompt / Terminal (Windows: MSVC Command Prompt) and change into this directory.
+1. Make a build subdirectory: `mkdir build && cd build`
+1. Call cmake
+    * `cmake ..`
+    * If your liblsl binaries are not in `../../LSL/liblsl/build/install`, add the path (`cmake -DLSL_INSTALL_ROOT=/path/to/liblsl/binaries ..`)
+    * Optional: Use a [generator](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html#visual-studio-generators)
+1. You may need to specify additional cmake options.
+ . Build everything and copy the files to the `install` folder:
+    * `cmake --build . --target install`	
+
+
+## OS X
+
+    * Use [homebrew](https://brew.sh/)
+        * `brew install cmake qt boost`
+
+1. Open a Command Prompt / Terminal (Windows: MSVC Command Prompt) and change into this directory.
+1. Make a build subdirectory: `mkdir build && cd build`
+1. Call cmake
+    * `cmake ..`
+    * If your liblsl binaries are not in `../../LSL/liblsl/build/install`, add the path (`cmake -DLSL_INSTALL_ROOT=/path/to/liblsl/binaries ..`)
+    * Optional: Use a [generator](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html#visual-studio-generators)
+1. You may need to specify additional cmake options.
+ . Build everything and copy the files to the `install` folder:
+    * `cmake --build . --target install`
+