Skip to content

Latest commit

 

History

History
95 lines (55 loc) · 4.04 KB

BUILDING.md

File metadata and controls

95 lines (55 loc) · 4.04 KB
Raw

Building the CasparCG Server

The CasparCG Server source code uses the CMake build system in order to easily generate build systems for multiple platforms. CMake is basically a build system for generating build systems.

On Windows we can use CMake to generate a .sln file and .vcproj files. On Linux CMake can generate make files or ninja files. Qt Creator has support for loading CMakeLists.txt files directly.

Dependency caching

CMake will automatically download some dependencies as part of the build process. These are taken from https://github.com/CasparCG/dependencies/releases (make sure to expand the 'Assets' group under each release to see the files), most of which are direct copies of distributions from upstream.

During the build, you can specify the CMake option CASPARCG_DOWNLOAD_MIRROR to download from an alternate HTTP server (such as an internally hosted mirror), or CASPARCG_DOWNLOAD_CACHE to use a specific path on disk for the local cache of these files, by default a folder called external will be created inside the build directory to cache these files.

If you want to be able to build CasparCG offline, you may need to manually seed this cache. You can do so by placing the correct tar.gz or zip into a folder and using CASPARCG_DOWNLOAD_CACHE to tell CMake where to find it. You can figure out which files you need by looking at each of the ExternalProject_Add function calls inside of Bootstrap_Linux.cmake or Bootstrap_Windows.cmake. Some of the ones listed are optional, depending on other CMake flags.

Windows

Building distributable

  1. Install Visual Studio 2022.

  2. Install CMake (http://www.cmake.org/download/).

  3. Install 7-zip (https://www.7-zip.org/).

  4. git clone --single-branch --branch master https://github.com/CasparCG/server casparcg-server-master

  5. cd casparcg-server-master

  6. .\tools\windows\build.bat

  7. Copy the dist\casparcg_server.zip file for distribution

Development using Visual Studio

  1. Install Visual Studio 2022.

  2. Install CMake (http://www.cmake.org/download/).

  3. git clone --single-branch --branch master https://github.com/CasparCG/server casparcg-server-master

  4. cd casparcg-server-master

  5. mkdir build

  6. cd build

  7. cmake -G "Visual Studio 17 2022" -A x64 ../src

  8. Open CasparCG Server.sln

Linux

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

  1. ./tools/linux/extract-from-docker

You will then find a folder called casparcg_server which should contain everything you need to run CasparCG Server.

Note: if you ran docker with sudo, CasparCG server will not be able to run without sudo out of the box. For security reasons we do not recommend to run CasparCG with sudo. Instead you can use chown to change the ownership of the CasparCG Server folder.

Development

Before beginning, check the build options section below, to decide if you want to use any to simplify or customise your build.

  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
  7. make -j8

If all goes to plan, a folder called 'staging' has been created with everything you need to run CasparCG server.

Build options

-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_SYSTEM_FFMPEG - (Linux only) use the version of ffmpeg from your OS.