.editorconfig

@@ -7,3 +7,12 @@ indent_size = 4
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
+
+[*.diff]
+trim_trailing_whitespace = false
+
+[*.patch]
+trim_trailing_whitespace = false
+
+[debian/rules]
+indent_style = tab

.github/workflows/linux-system.yml

@@ -11,38 +11,98 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                os:
-                    - ubuntu-20.04
-                    - ubuntu-22.04
+                include:
+                    - os: ubuntu-22.04
+                      distribution: jammy
+                    - os: ubuntu-24.04
+                      distribution: noble
 
         runs-on: ${{ matrix.os }}
 
         steps:
             - uses: actions/checkout@v4
 
             - name: Setup environment
+              id: setup-env
               run: |
+                  ln -s tools/linux/deb/ubuntu-${{ matrix.distribution }}/debian ./
+
+                  # Build a version number for this build
+                  GH_REF="${GITHUB_REF##*/}"
+                  GH_REF=$(echo "$GH_REF" | sed 's/[\/]/_/g' | sed 's/ /_/g')
+
+                  VERSION_MAJOR=$(grep -oPi 'set\(CONFIG_VERSION_MAJOR \K\d+' src/CMakeLists.txt)
+                  VERSION_MINOR=$(grep -oPi 'set\(CONFIG_VERSION_MINOR \K\d+' src/CMakeLists.txt)
+                  VERSION_PATCH=$(grep -oPi 'set\(CONFIG_VERSION_BUG \K\d+' src/CMakeLists.txt)
+
+                  BUILD_VERSION="${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}~${GH_REF}-${{ matrix.distribution }}+${GITHUB_SHA:0:7}"
+                  echo "BUILD_VERSION=$BUILD_VERSION" >> $GITHUB_OUTPUT
+                  echo "Building as $BUILD_VERSION"
+
+                  BUILD_FILENAME="casparcg-server-${BUILD_VERSION}"
+                  echo "BUILD_FILENAME=$BUILD_FILENAME" >> $GITHUB_OUTPUT
+
+                  # install some needed tooling
                   sudo apt-get update
-                  sudo ./tools/linux/install-dependencies
-
-                  sudo apt-get install -y libboost-all-dev \
-                    libavcodec-dev \
-                    libavformat-dev \
-                    libavdevice-dev \
-                    libavutil-dev \
-                    libavfilter-dev \
-                    libswscale-dev \
-                    libpostproc-dev \
-                    libswresample-dev
+                  sudo apt-get -y install software-properties-common build-essential dpkg-dev debhelper devscripts
+                  sudo add-apt-repository ppa:casparcg/ppa
+
+                  # Put something in the changelog
+                  export DEBEMAIL="builds@casparcg.com"
+                  export DEBFULLNAME="CasparCG Builds"
+                  dch -v "$BUILD_VERSION" --create -D ${{ matrix.distribution }} --package casparcg-server-beta "Build"
+
+                  # Install build dependencies
+                  sudo apt-get build-dep .
+
+                  # update the control file to reference the current cef version
+                  CASPARCG_CEF_VER=$(dpkg-query -W -f='${Version}' casparcg-cef-131)
+                  sed -i "s/@CASPARCG_CEF_VER@/${CASPARCG_CEF_VER}/" debian/control
+
+                  # Download required packages
+                  cd ..
+                  apt-get download casparcg-cef-131=$CASPARCG_CEF_VER
+                  apt-get download casparcg-scanner
+              env:
+                  CI: 1
 
             - name: Run build
               run: |
+                  # Perform build
+                  debuild -b -uc -us
+              env:
+                  CI: 1
+
+            - name: Collect artifacts
+              id: artifacts
+              run: |
+                  mkdir -p dist
+                  mv ../*.deb dist/
 
-                  mkdir build
-                  cd build
+                  # collect some docs for the zip
+                  cp README.md dist/
+                  cp tools/linux/deb/INSTALLING dist/
 
-                  cmake ../src -DUSE_STATIC_BOOST=OFF -DUSE_SYSTEM_FFMPEG=ON
-                  make -j2
+                  # check if a release branch, or master, or a tag
+                  if [[ "${{ github.ref_name }}" == "master" || "${{ github.ref_name }}" == "2.3.x-lts" ]]
+                  then
+                    # Only proceed if we have an sftp password
+                    if [ -n "${{ secrets.SFTP_PASSWORD }}" ]
+                    then
+                      zip -r "${{ steps.setup-env.outputs.BUILD_FILENAME }}.zip" dist
+
+                      set -x
+                      eval $(ssh-agent -s)
+                      mkdir -v -m 700 $HOME/.ssh
+                      ssh-keyscan -H ${{ secrets.SFTP_HOST }} > $HOME/.ssh/known_hosts
+                      sshpass -p '${{ secrets.SFTP_PASSWORD }}' rsync -avvz --mkpath "${{ steps.setup-env.outputs.BUILD_FILENAME }}.zip" "${{ secrets.SFTP_USERNAME }}@${{ secrets.SFTP_HOST }}:${{ secrets.SFTP_ROOT }}/${{ github.ref_name }}/${{ steps.setup-env.outputs.BUILD_FILENAME }}.zip"
+                    fi
+                  fi
 
               env:
                   CI: 1
+
+            - uses: actions/upload-artifact@v4
+              with:
+                  name: ${{ steps.setup-env.outputs.BUILD_FILENAME }}
+                  path: dist

.github/workflows/linux.yml

@@ -19,61 +19,5 @@ jobs:
             - name: Run build
               run: |
                   ./tools/linux/build-in-docker
-                  ./tools/linux/extract-from-docker
-
               env:
                   CI: 1
-
-            - name: Download media-scanner
-              uses: robinraju/release-downloader@v1.10
-              with:
-                  repository: "casparcg/media-scanner"
-                  latest: true
-                  fileName: "*-linux-x64.zip"
-                  tarBall: false
-                  zipBall: false
-                  out-file-path: "casparcg_server/media-scanner"
-                  extract: true
-
-            - name: Tidy media-scanner download
-              shell: bash
-              run: |
-                  rm casparcg_server/media-scanner/*.zip
-                  mv casparcg_server/media-scanner/* casparcg_server/
-                  rmdir casparcg_server/media-scanner
-                  chmod +x casparcg_server/scanner
-
-            - name: Rename build
-              id: "rename-build"
-              shell: bash
-              run: |
-                  TARGET=casparcg-server-${{ github.sha }}-ubuntu22.zip
-                  zip -r "$TARGET" casparcg_server/
-
-                  echo "artifactname=$TARGET" >> $GITHUB_OUTPUT
-
-                  # check if a release branch, or master, or a tag
-                  if [[ "${{ github.ref_name }}" == "master" || "${{ github.ref_name }}" == "2.3.x-lts" ]]
-                  then
-                    # Only proceed if we have an sftp password
-                    if [ -n "${{ secrets.SFTP_PASSWORD }}" ]
-                    then
-
-                        echo "uploadname=$TARGET" >> $GITHUB_OUTPUT
-                    fi
-                  fi
-
-            - uses: actions/upload-artifact@v4
-              with:
-                  name: upload-artifact
-                  path: ${{ steps.rename-build.outputs.artifactname }}
-
-            - name: Copy single file to remote
-              uses: garygrossgarten/github-action-scp@v0.8.0
-              if: ${{ steps.rename-build.outputs.uploadname }}
-              with:
-                  local: "${{ steps.rename-build.outputs.uploadname }}"
-                  remote: "${{ secrets.SFTP_ROOT }}/${{ github.ref_name }}/${{ steps.rename-build.outputs.uploadname }}"
-                  host: ${{ secrets.SFTP_HOST }}
-                  username: ${{ secrets.SFTP_USERNAME }}
-                  password: ${{ secrets.SFTP_PASSWORD }}

.github/workflows/windows.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
     build:
-        runs-on: windows-2019
+        runs-on: windows-2022
 
         steps:
             - uses: actions/checkout@v4
@@ -63,6 +63,7 @@ jobs:
             - name: Copy single file to remote
               uses: garygrossgarten/github-action-scp@v0.8.0
               if: ${{ steps.rename-build.outputs.uploadname }}
+              timeout-minutes: 5
               with:
                   local: "${{ steps.rename-build.outputs.uploadname }}"
                   remote: "${{ secrets.SFTP_ROOT }}/${{ github.ref_name }}/${{ steps.rename-build.outputs.uploadname }}"

.gitignore

@@ -14,3 +14,7 @@ casparcg_server
 
 src/cmake-build-*
 src/.idea
+
+# debian build artifacts
+/debian
+/obj-*

BUILDING.md

@@ -20,35 +20,52 @@ You can figure out which files you need by looking at each of the `ExternalProje
 
 # Windows
 
-## Development using Visual Studio
+## Building distributable
 
-1. Install Visual Studio 2019.
+1. Install Visual Studio 2022.
 
-2. Install CMake (http://www.cmake.org/download/).
+2. Install 7-zip (https://www.7-zip.org/).
 
 3. `git clone --single-branch --branch master https://github.com/CasparCG/server casparcg-server-master`
 
 4. `cd casparcg-server-master`
 
-5. `mkdir build`
+5. `.\tools\windows\build.bat`
+
+6. Copy the `dist\casparcg_server.zip` file for distribution
+
+## Development using Visual Studio
+
+1. Install Visual Studio 2022.
 
-6. `cd build`
+3. `git clone --single-branch --branch master https://github.com/CasparCG/server casparcg-server-master`
 
-7. `cmake -G "Visual Studio 16 2019" -A x64 ../src`
+4. Open the cloned folder in Visual Studio.
 
-8. Open `CasparCG Server.sln`
+5. Build All and ensure it builds successfully
 
 # Linux
 
-## Building inside Docker
+## Building on your system
+
+We only officially support Ubuntu LTS releases, other distros may work but often run into build issues. We are happy to accept PRs to resolve these issues, but are unlikely to write fixes ourselves.
+
+We currently document two approaches to building CasparCG. The recommended way is to use the `deb` packaging we have in the repository, but we only provide that for Ubuntu LTS releases.
+Other deb based distros can work with some tweaks to one of those, other distros will need something else which is not documented here.
+
+We also provide a script to produce a build in docker, but this is not recommended unless absolutely necessary. The resulting builds are often rather brittle depending on where they are used.
+
+To perform a custom build, follow the Development steps below, and you may need to do some extra packaging steps, or install steps on the target systems.
+
+### Building inside Docker
 
 1. `git clone --single-branch --branch master https://github.com/CasparCG/server casparcg-server-master`
 2. `cd casparcg-server-master`
 3. `./tools/linux/build-in-docker`
 
 If all goes to plan, a docker image `casparcg/server` has been created containing CasparCG Server.
 
-## Extracting CasparCG Server from Docker
+### Extracting CasparCG Server from Docker
 
 1. `./tools/linux/extract-from-docker`
 
@@ -63,9 +80,9 @@ Before beginning, check the build options section below, to decide if you want t
 1. `git clone --single-branch --branch master https://github.com/CasparCG/server casparcg-server-master`
 2. `cd casparcg-server-master`
 3. Install dependencies, this can be done with `sudo ./tools/linux/install-dependencies`
-4. `mkdir build && cd build`
-5. `cmake ../src`
-6. If not using system ffmpeg, run `./_deps/ffmpeg-lib-src/ffmpeg/install-ffmpeg-dependencies` to install the dependencies needed by the ffmpeg build
+4. If using system CEF (default & recommended), `sudo add-apt-repository ppa:casparcg/ppa` and `sudo apt-get install casparcg-cef-131-dev`
+5. `mkdir build && cd build`
+6. `cmake ../src` You can add any of the build options from below to this command
 7. `make -j8`
 
 If all goes to plan, a folder called 'staging' has been created with everything you need to run CasparCG server.
@@ -74,6 +91,8 @@ If all goes to plan, a folder called 'staging' has been created with everything
 
 -DENABLE_HTML=OFF - useful if you lack CEF, and would like to build without that module.
 
--DUSE_STATIC_BOOST=OFF - (Linux only) link against shared version of Boost.
+-DUSE_STATIC_BOOST=ON - (Linux only, default OFF) statically link against Boost.
+
+-DUSE_SYSTEM_CEF=OFF - (Linux only, default ON) use the version of CEF from your OS. This expects to be using builds from https://launchpad.net/~casparcg/+archive/ubuntu/ppa
 
--DUSE_SYSTEM_FFMPEG - (Linux only) use the version of ffmpeg from your OS.
+-DDIAG_FONT_PATH - Specify an alternate path/font to use for the DIAG window. On linux, this will often want to be set to an absolute path of a font