build: add freebsd support

Author: ReenigneArcher

.github/workflows/ci-freebsd.yml

@@ -0,0 +1,223 @@
+---
+name: CI-FreeBSD
+permissions:
+  contents: read
+
+on:
+  workflow_call:
+    inputs:
+      release_commit:
+        required: true
+        type: string
+      release_version:
+        required: true
+        type: string
+
+env:
+  FREEBSD_CLANG_VERSION: 19
+
+jobs:
+  build_freebsd:
+    name: ${{ matrix.cmake_processor }}-${{ matrix.bsd_release }}
+    if: github.event_name != 'pull_request' || matrix.pr == true
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - bsd_release: "14.3"
+            arch: x86_64
+            cmake_processor: amd64
+            pr: true
+            runner: ubuntu-latest
+          - bsd_release: "14.3"
+            arch: aarch64
+            cmake_processor: aarch64
+            pr: false
+            runner: ubuntu-latest  # ubuntu-24.04-arm is slower with the FreeBSD VM
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          submodules: recursive
+
+      - name: Get Processor Count
+        id: processor_count
+        shell: bash
+        run: |
+          PROCESSOR_COUNT=$(nproc)
+          echo "PROCESSOR_COUNT=${PROCESSOR_COUNT}" >> "${GITHUB_OUTPUT}"
+          echo "PROCESSOR_COUNT: $PROCESSOR_COUNT"
+
+      - name: Setup FreeBSD
+        uses: vmactions/freebsd-vm@v1.2.3
+        with:
+          arch: ${{ matrix.arch }}
+          cpu: ${{ steps.processor_count.outputs.PROCESSOR_COUNT }}
+          # TODO: there is no libcap for freebsd... we need graphics/libdrm if we find a way to use libcap
+          # TODO: docs are off because doxygen is too old: https://www.freshports.org/devel/doxygen/ must be >= 1.10
+          prepare: |
+            set -e
+
+            pkg update
+            pkg upgrade -y
+            pkg install -y \
+              audio/opus \
+              audio/pulseaudio \
+              devel/cmake-core \
+              devel/evdev-proto \
+              devel/git \
+              devel/libayatana-appindicator \
+              devel/libevdev \
+              devel/libnotify \
+              devel/llvm${{ env.FREEBSD_CLANG_VERSION }} \
+              devel/ninja \
+              devel/pkgconf \
+              ftp/curl \
+              graphics/libdrm \
+              graphics/wayland \
+              lang/python312 \
+              multimedia/libva \
+              net/miniupnpc \
+              ports-mgmt/pkg \
+              security/openssl \
+              shells/bash \
+              www/npm \
+              x11/libX11 \
+              x11/libxcb \
+              x11/libXfixes \
+              x11/libXrandr \
+              x11/libXtst \
+              x11-servers/xorg-server
+
+            # create symlink for shebang bash compatibility
+            ln -s /usr/local/bin/bash /bin/bash
+
+            # setup python
+            ln -s /usr/local/bin/python3.12 /usr/local/bin/python
+          release: ${{ matrix.bsd_release }}
+          run: |
+            set -e
+
+            # fix git safe.directory issues
+            git config --global --add safe.directory "*"
+
+            # install gcvor
+            python -m pip install gcovr
+          sync: nfs
+
+      - name: Configure
+        env:
+          BRANCH: ${{ github.head_ref || github.ref_name }}
+          BUILD_VERSION: ${{ inputs.release_version }}
+          COMMIT: ${{ inputs.release_commit }}
+        shell: freebsd {0}
+        run: |
+          set -e
+          cd "${GITHUB_WORKSPACE}"
+
+          export BRANCH="${BRANCH}"
+          export BUILD_VERSION="${BUILD_VERSION}"
+          export COMMIT="${COMMIT}"
+
+          cc_path="$(which clang${{ env.FREEBSD_CLANG_VERSION }})"
+          cxx_path="$(which clang++${{ env.FREEBSD_CLANG_VERSION }})"
+
+          export CC="${cc_path}"
+          export CXX="${cxx_path}"
+
+          mkdir -p build
+          cmake \
+            -B build \
+            -G Ninja \
+            -S . \
+            -DBUILD_DOCS=OFF \
+            -DBUILD_WERROR=OFF \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_INSTALL_PREFIX=/usr/local \
+            -DSUNSHINE_ASSETS_DIR=share/assets \
+            -DSUNSHINE_EXECUTABLE_PATH=/usr/local/bin/sunshine \
+            -DSUNSHINE_ENABLE_CUDA=OFF \
+            -DSUNSHINE_ENABLE_DRM=OFF \
+            -DSUNSHINE_ENABLE_WAYLAND=OFF \
+            -DSUNSHINE_ENABLE_X11=ON \
+            -DSUNSHINE_PUBLISHER_NAME='${{ github.repository_owner }}' \
+            -DSUNSHINE_PUBLISHER_WEBSITE='https://app.lizardbyte.dev' \
+            -DSUNSHINE_PUBLISHER_ISSUE_URL='https://app.lizardbyte.dev/support'
+
+      - name: Build
+        shell: freebsd {0}
+        run: |
+          set -e
+          cd "${GITHUB_WORKSPACE}"
+          ninja -C build
+
+      - name: Package
+        shell: freebsd {0}
+        run: |
+          set -e
+          cd "${GITHUB_WORKSPACE}"
+
+          mkdir -p artifacts
+
+          cd build
+          cpack -G FREEBSD
+
+          # move compiled files to artifacts
+          mv ./cpack_artifacts/Sunshine.pkg \
+            ../artifacts/Sunshine-FreeBSD-${{ matrix.bsd_release }}-${{ matrix.cmake_processor }}.pkg
+
+      - name: Debug +MANIFEST
+        if: always()
+        shell: bash
+        working-directory: build/cpack_artifacts
+        run: cat ./_CPack_Packages/FreeBSD/FREEBSD/Sunshine/+MANIFEST
+
+      - name: Test
+        id: test
+        if: always()
+        shell: freebsd {0}
+        run: |
+          set -e
+          cd "${GITHUB_WORKSPACE}/build/tests"
+
+          export DISPLAY=:1
+          Xvfb ${DISPLAY} -screen 0 1024x768x24 &
+
+          ./test_sunshine --gtest_color=yes --gtest_output=xml:test_results.xml
+
+      - name: Generate gcov report
+        id: test_report
+        # any except canceled or skipped
+        if: >-
+          always() &&
+          (steps.test.outcome == 'success' || steps.test.outcome == 'failure')
+        shell: freebsd {0}
+        run: |
+          cd "${GITHUB_WORKSPACE}/build"
+          python -m gcovr . -r ../src \
+            --exclude-noncode-lines \
+            --exclude-throw-branches \
+            --exclude-unreachable-branches \
+            --verbose \
+            --xml-pretty \
+            -o coverage.xml
+
+      - name: Upload coverage artifact
+        if: >-
+          always() &&
+          (steps.test_report.outcome == 'success')
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-FreeBSD-${{ matrix.bsd_release }}-${{ matrix.cmake_processor }}
+          path: |
+            build/coverage.xml
+            build/tests/test_results.xml
+          if-no-files-found: error
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-FreeBSD-${{ matrix.bsd_release }}-${{ matrix.cmake_processor }}
+          path: artifacts/
+          if-no-files-found: error

.github/workflows/ci.yml

@@ -69,6 +69,14 @@ jobs:
       GH_BOT_TOKEN: ${{ secrets.GH_BOT_TOKEN }}
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+  build-freebsd:
+    name: FreeBSD
+    needs: release-setup
+    uses: ./.github/workflows/ci-freebsd.yml
+    with:
+      release_commit: ${{ needs.release-setup.outputs.release_commit }}
+      release_version: ${{ needs.release-setup.outputs.release_version }}
+
   build-homebrew:
     name: Homebrew
     needs: release-setup
@@ -124,8 +132,10 @@ jobs:
     if: >-
       always() &&
       !cancelled() &&
-      startsWith(github.repository, 'LizardByte/')
+      startsWith(github.repository, 'LizardByte/') &&
+      (github.event_name != 'pull_request' || matrix.pr == true)
     needs:
+      - build-freebsd
       - build-linux
       - build-linux-flatpak
       - build-homebrew
@@ -135,18 +145,30 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          - name: FreeBSD-14.3-amd64
+            coverage: true
+            pr: true
+          - name: FreeBSD-14.3-aarch64
+            coverage: true
+            pr: false
           - name: Linux-AppImage
             coverage: true
+            pr: true
           - name: Homebrew-macos-14
             coverage: false
+            pr: true
           - name: Homebrew-macos-15
             coverage: false
+            pr: true
           - name: Homebrew-macos-26
             coverage: false
+            pr: true
           - name: Homebrew-ubuntu-latest
             coverage: false
+            pr: true
           - name: Windows-AMD64
             coverage: true
+            pr: true
     steps:
       - name: Checkout
         uses: actions/checkout@v5

CMakeLists.txt

@@ -24,6 +24,10 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
     set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+if(CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
+    set(FREEBSD ON)
+endif()
+
 # set the module path, used for includes
 set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 

cmake/compile_definitions/linux.cmake

@@ -1,6 +1,10 @@
 # linux specific compile definitions
 
-add_compile_definitions(SUNSHINE_PLATFORM="linux")
+if(FREEBSD)
+    add_compile_definitions(SUNSHINE_PLATFORM="freebsd")
+else()
+    add_compile_definitions(SUNSHINE_PLATFORM="linux")
+endif()
 
 # AppImage
 if(${SUNSHINE_BUILD_APPIMAGE})
@@ -211,6 +215,9 @@ endif()
 # These need to be set before adding the inputtino subdirectory in order for them to be picked up
 set(LIBEVDEV_CUSTOM_INCLUDE_DIR "${EVDEV_INCLUDE_DIR}")
 set(LIBEVDEV_CUSTOM_LIBRARY "${EVDEV_LIBRARY}")
+if(FREEBSD)
+    set(USE_UHID OFF)
+endif()
 
 add_subdirectory("${CMAKE_SOURCE_DIR}/third-party/inputtino")
 list(APPEND SUNSHINE_EXTERNAL_LIBRARIES inputtino::libinputtino)

cmake/dependencies/common.cmake

@@ -30,6 +30,9 @@ include_directories(SYSTEM ${MINIUPNP_INCLUDE_DIRS})
 if(NOT DEFINED FFMPEG_PREPARED_BINARIES)
     if(WIN32)
         set(FFMPEG_PLATFORM_LIBRARIES mfplat ole32 strmiids mfuuid vpl)
+    elseif(FREEBSD)
+        # numa is not available on FreeBSD
+        set(FFMPEG_PLATFORM_LIBRARIES va va-drm va-x11 X11)
     elseif(UNIX AND NOT APPLE)
         set(FFMPEG_PLATFORM_LIBRARIES numa va va-drm va-x11 X11)
     endif()

cmake/packaging/linux.cmake

@@ -30,6 +30,14 @@ else()
     endif()
 endif()
 
+# RPM specific
+set(CPACK_RPM_PACKAGE_LICENSE "GPLv3")
+
+# FreeBSD specific
+set(CPACK_FREEBSD_PACKAGE_MAINTAINER "${CPACK_PACKAGE_VENDOR}")
+set(CPACK_FREEBSD_PACKAGE_ORIGIN "misc/${CPACK_PACKAGE_NAME}")
+set(CPACK_FREEBSD_PACKAGE_LICENSE "GPLv3")
+
 # Post install
 set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/postinst")
 set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/postinst")
@@ -73,6 +81,14 @@ set(CPACK_RPM_PACKAGE_REQUIRES "\
             openssl >= 3.0.2, \
             pulseaudio-libs >= 10.0, \
             which >= 2.21")
+list(APPEND CPACK_FREEBSD_PACKAGE_DEPS
+            audio/opus
+            ftp/curl
+            devel/libevdev
+            x11/libX11
+            net/miniupnpc
+            security/openssl
+)
 
 if(NOT BOOST_USE_STATIC)
     set(CPACK_DEBIAN_PACKAGE_DEPENDS "\
@@ -87,6 +103,9 @@ if(NOT BOOST_USE_STATIC)
                 boost-locale >= ${Boost_VERSION}, \
                 boost-log >= ${Boost_VERSION}, \
                 boost-program-options >= ${Boost_VERSION}")
+    list(APPEND CPACK_FREEBSD_PACKAGE_DEPS
+                devel/boost-libs
+    )
 endif()
 
 # This should automatically figure out dependencies, doesn't work with the current config
@@ -137,6 +156,10 @@ if(${SUNSHINE_TRAY} STREQUAL 1)
     set(CPACK_RPM_PACKAGE_REQUIRES "\
                     ${CPACK_RPM_PACKAGE_REQUIRES}, \
                     libappindicator-gtk3 >= 12.10.0")
+    list(APPEND CPACK_FREEBSD_PACKAGE_DEPS
+                    devel/libayatana-appindicator
+                    devel/libnotify
+    )
 endif()
 
 # desktop file