Merge tk-1001-2 into tk-cutfade, resolving conflicts in audio_mixer.cpp

Author: TomKaltz

BUILDING.md

@@ -38,11 +38,11 @@ You can figure out which files you need by looking at each of the `ExternalProje
 
 1. Install Visual Studio 2022.
 
-3. `git clone --single-branch --branch master https://github.com/CasparCG/server casparcg-server-master`
+2. `git clone --single-branch --branch master https://github.com/CasparCG/server casparcg-server-master`
 
-4. Open the cloned folder in Visual Studio.
+3. Open the cloned folder in Visual Studio.
 
-5. Build All and ensure it builds successfully
+4. Build All and ensure it builds successfully
 
 # Linux
 
@@ -83,7 +83,8 @@ Before beginning, check the build options section below, to decide if you want t
 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`
+7. `cmake --build . --parallel`
+8. `cmake --install . --prefix staging`
 
 If all goes to plan, a folder called 'staging' has been created with everything you need to run CasparCG server.
 
@@ -96,3 +97,5 @@ If all goes to plan, a folder called 'staging' has been created with everything
 -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
 
 -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
+
+-DCASPARCG_BINARY_NAME=casparcg-server - (Linux only) generate the executable with the specified name. This also reconfigures the install target to be a bit more friendly with system package managers.

src/CMakeModules/Bootstrap_Linux.cmake

@@ -14,6 +14,7 @@ endif()
 set(ENABLE_HTML ON CACHE BOOL "Enable CEF and HTML producer")
 set(USE_STATIC_BOOST OFF CACHE BOOL "Use shared library version of Boost")
 set(USE_SYSTEM_CEF ON CACHE BOOL "Use the version of cef from your OS (only tested with Ubuntu)")
+set(CASPARCG_BINARY_NAME "casparcg" CACHE STRING "Custom name of the binary to build (this disables some install files)")
 
 # Determine build (target) platform
 SET (PLATFORM_FOLDER_NAME "linux")
@@ -28,21 +29,31 @@ MARK_AS_ADVANCED (CMAKE_INSTALL_PREFIX)
 if (USE_STATIC_BOOST)
 	SET (Boost_USE_STATIC_LIBS ON)
 endif()
-FIND_PACKAGE (Boost 1.74.0 COMPONENTS system thread chrono filesystem log_setup log locale regex date_time coroutine REQUIRED)
-FIND_PACKAGE (FFmpeg REQUIRED)
-FIND_PACKAGE (OpenGL REQUIRED COMPONENTS OpenGL GLX)
-FIND_PACKAGE (GLEW REQUIRED)
-FIND_PACKAGE (TBB REQUIRED)
-FIND_PACKAGE (OpenAL REQUIRED)
-FIND_PACKAGE (SFML 2 COMPONENTS graphics window system REQUIRED)
-FIND_PACKAGE (X11 REQUIRED)
+find_package(Boost 1.74.0 COMPONENTS system thread chrono filesystem log_setup log locale regex date_time coroutine REQUIRED)
+find_package(FFmpeg REQUIRED)
+find_package(OpenGL REQUIRED COMPONENTS OpenGL GLX)
+find_package(GLEW REQUIRED)
+find_package(TBB REQUIRED)
+find_package(OpenAL REQUIRED)
+find_package(SFML 2 COMPONENTS graphics window REQUIRED)
+find_package(X11 REQUIRED)
+
+# support for Ubuntu 22.04
+if (NOT TARGET OpenAL::OpenAL)
+    add_library(OpenAL::OpenAL INTERFACE IMPORTED)
+    target_include_directories(OpenAL::OpenAL INTERFACE ${OPENAL_INCLUDE_DIR})
+    target_link_libraries(OpenAL::OpenAL INTERFACE ${OPENAL_LIBRARY})
+endif()
 
 if (ENABLE_HTML)
     if (USE_SYSTEM_CEF)
         set(CEF_LIB_PATH "/usr/lib/casparcg-cef-131")
-        set(CEF_INCLUDE_PATH "/usr/include/casparcg-cef-131")
 
-        set(CEF_LIB
+        add_library(CEF::CEF INTERFACE IMPORTED)
+        target_include_directories(CEF::CEF INTERFACE
+            "/usr/include/casparcg-cef-131"
+        )
+        target_link_libraries(CEF::CEF INTERFACE
             "-Wl,-rpath,${CEF_LIB_PATH} ${CEF_LIB_PATH}/libcef.so"
             "${CEF_LIB_PATH}/libcef_dll_wrapper.a"
         )
@@ -61,22 +72,35 @@ if (ENABLE_HTML)
         ExternalProject_Get_Property(cef SOURCE_DIR)
         ExternalProject_Get_Property(cef BINARY_DIR)
 
-        # Note: All of these must be referenced in the BUILD_BYPRODUCTS above, to satisfy ninja
-        set(CEF_LIB
+        add_library(CEF::CEF INTERFACE IMPORTED)
+        target_include_directories(CEF::CEF INTERFACE
+            "${SOURCE_DIR}"
+        )
+        target_link_libraries(CEF::CEF INTERFACE
+            # Note: All of these must be referenced in the BUILD_BYPRODUCTS above, to satisfy ninja
             "${SOURCE_DIR}/Release/libcef.so"
             "${BINARY_DIR}/libcef_dll_wrapper/libcef_dll_wrapper.a"
         )
 
-        set(CEF_INCLUDE_PATH "${SOURCE_DIR}")
-        set(CEF_BIN_PATH "${SOURCE_DIR}/Release")
-        set(CEF_RESOURCE_PATH "${SOURCE_DIR}/Resources")
+        install(DIRECTORY ${SOURCE_DIR}/Resources/locales TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Resources/chrome_100_percent.pak TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Resources/chrome_200_percent.pak TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Resources/icudtl.dat TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Resources/resources.pak TYPE LIB)
+
+        install(FILES ${SOURCE_DIR}/Release/chrome-sandbox TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Release/libcef.so TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Release/libEGL.so TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Release/libGLESv2.so TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Release/libvk_swiftshader.so TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Release/libvulkan.so.1 TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Release/snapshot_blob.bin TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Release/v8_context_snapshot.bin TYPE LIB)
+        install(FILES ${SOURCE_DIR}/Release/vk_swiftshader_icd.json TYPE LIB)
     endif()
 endif ()
 
 SET (BOOST_INCLUDE_PATH "${Boost_INCLUDE_DIRS}")
-SET (TBB_INCLUDE_PATH "${TBB_INCLUDE_DIRS}")
-SET (GLEW_INCLUDE_PATH "${GLEW_INCLUDE_DIRS}")
-SET (SFML_INCLUDE_PATH "${SFML_INCLUDE_DIR}")
 SET (FFMPEG_INCLUDE_PATH "${FFMPEG_INCLUDE_DIRS}")
 
 LINK_DIRECTORIES("${FFMPEG_LIBRARY_DIRS}")

src/CMakeModules/Bootstrap_Windows.cmake

@@ -1,6 +1,7 @@
 cmake_minimum_required (VERSION 3.16)
 
 include(ExternalProject)
+include(FetchContent)
 
 if(POLICY CMP0135)
 	cmake_policy(SET CMP0135 NEW)
@@ -33,6 +34,17 @@ function(casparcg_add_runtime_dependency_dir FILE_TO_COPY)
 		set(CASPARCG_RUNTIME_DEPENDENCIES_DEBUG_DIRS "${CASPARCG_RUNTIME_DEPENDENCIES_DEBUG_DIRS}" "${FILE_TO_COPY}" CACHE INTERNAL "")
 	endif()
 endfunction()
+function(casparcg_add_runtime_dependency_from_target TARGET)
+	get_target_property(_runtime_lib_name ${TARGET} IMPORTED_LOCATION_RELEASE)
+	if (NOT "${_runtime_lib_name}" STREQUAL "")
+		set(CASPARCG_RUNTIME_DEPENDENCIES_RELEASE "${CASPARCG_RUNTIME_DEPENDENCIES_RELEASE}" "${_runtime_lib_name}" CACHE INTERNAL "")
+	endif()
+
+	get_target_property(_runtime_lib_name ${TARGET} IMPORTED_LOCATION_DEBUG)
+	if (NOT "${_runtime_lib_name}" STREQUAL "")
+		set(CASPARCG_RUNTIME_DEPENDENCIES_DEBUG "${CASPARCG_RUNTIME_DEPENDENCIES_DEBUG}" "${_runtime_lib_name}" CACHE INTERNAL "")
+	endif()
+endfunction()
 
 casparcg_add_runtime_dependency("${PROJECT_SOURCE_DIR}/shell/casparcg.config")
 
@@ -65,7 +77,7 @@ else ()
 		--with-libraries=regex
 		--with-libraries=system
 		--with-libraries=thread
-	BUILD_COMMAND ./b2 install debug release --prefix=${BOOST_INSTALL_DIR} link=static threading=multi runtime-link=shared -j ${CONFIG_CPU_COUNT} 
+	BUILD_COMMAND ./b2 install debug release --prefix=${BOOST_INSTALL_DIR} link=static threading=multi runtime-link=shared -j ${CONFIG_CPU_COUNT}
 	INSTALL_COMMAND ""
 	)
 	set(BOOST_INCLUDE_PATH "${BOOST_INSTALL_DIR}/include/boost-1_74")
@@ -101,69 +113,59 @@ casparcg_add_runtime_dependency("${FFMPEG_BIN_PATH}/swscale-8.dll")
 casparcg_add_runtime_dependency("${FFMPEG_BIN_PATH}/ffmpeg.exe")
 casparcg_add_runtime_dependency("${FFMPEG_BIN_PATH}/ffprobe.exe")
 
+get_property(is_multi_config GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
+
 set(EXTERNAL_CMAKE_ARGS "")
-if (NOT CMAKE_GENERATOR MATCHES "Visual Studio")
+if (is_multi_config)
 	set(EXTERNAL_CMAKE_ARGS "-DCMAKE_BUILD_TYPE:STRING=$<CONFIG>")
+else()
+	set(EXTERNAL_CMAKE_ARGS "-DCMAKE_BUILD_TYPE:STRING=${CMAKE_BUILD_TYPE}")
 endif ()
 
 # TBB
-casparcg_add_external_project(tbb)
-ExternalProject_Add(tbb
+FetchContent_Declare(tbb
 	URL ${CASPARCG_DOWNLOAD_MIRROR}/tbb/oneapi-tbb-2021.1.1-win.zip
 	URL_HASH MD5=51bf49044d477dea67670abd92f8814c
 	DOWNLOAD_DIR ${CASPARCG_DOWNLOAD_CACHE}
-	CONFIGURE_COMMAND ""
-	BUILD_COMMAND ""
-	INSTALL_COMMAND ""
 )
-ExternalProject_Get_Property(tbb SOURCE_DIR)
-set(TBB_INCLUDE_PATH "${SOURCE_DIR}/include")
-set(TBB_BIN_PATH "${SOURCE_DIR}/redist/intel64/vc14")
-link_directories("${SOURCE_DIR}/lib/intel64/vc14")
-casparcg_add_runtime_dependency("${TBB_BIN_PATH}/tbb12.dll" "Release")
-casparcg_add_runtime_dependency("${TBB_BIN_PATH}/tbb12_debug.dll" "Debug")
-casparcg_add_runtime_dependency("${TBB_BIN_PATH}/tbbmalloc.dll" "Release")
-casparcg_add_runtime_dependency("${TBB_BIN_PATH}/tbbmalloc_debug.dll" "Debug")
-casparcg_add_runtime_dependency("${TBB_BIN_PATH}/tbbmalloc_proxy.dll" "Release")
-casparcg_add_runtime_dependency("${TBB_BIN_PATH}/tbbmalloc_proxy_debug.dll" "Debug")
+FetchContent_MakeAvailable(tbb)
+
+list(APPEND CMAKE_PREFIX_PATH ${tbb_SOURCE_DIR}/lib/cmake/tbb)
+find_package(tbb REQUIRED)
+
+casparcg_add_runtime_dependency_from_target(TBB::tbb)
+casparcg_add_runtime_dependency_from_target(TBB::tbbmalloc)
+casparcg_add_runtime_dependency_from_target(TBB::tbbmalloc_proxy)
 
 # GLEW
-casparcg_add_external_project(glew)
-ExternalProject_Add(glew
+FetchContent_Declare(glew
 	URL ${CASPARCG_DOWNLOAD_MIRROR}/glew/glew-2.2.0-win32.zip
 	URL_HASH MD5=1feddfe8696c192fa46a0df8eac7d4bf
 	DOWNLOAD_DIR ${CASPARCG_DOWNLOAD_CACHE}
-	CONFIGURE_COMMAND ""
-	BUILD_COMMAND ""
-	INSTALL_COMMAND ""
 )
-ExternalProject_Get_Property(glew SOURCE_DIR)
-set(GLEW_INCLUDE_PATH ${SOURCE_DIR}/include)
-set(GLEW_BIN_PATH ${SOURCE_DIR}/bin/Release/x64)
-link_directories(${SOURCE_DIR}/lib/Release/x64)
-add_definitions( -DGLEW_NO_GLU )
-casparcg_add_runtime_dependency("${GLEW_BIN_PATH}/glew32.dll")
+FetchContent_MakeAvailable(glew)
+
+add_library(GLEW::glew INTERFACE IMPORTED)
+target_include_directories(GLEW::glew INTERFACE ${glew_SOURCE_DIR}/include)
+target_link_directories(GLEW::glew INTERFACE ${glew_SOURCE_DIR}/lib/Release/x64)
+target_link_libraries(GLEW::glew INTERFACE glew32)
+casparcg_add_runtime_dependency("${glew_SOURCE_DIR}/bin/Release/x64/glew32.dll")
 
 # SFML
-casparcg_add_external_project(sfml)
-ExternalProject_Add(sfml
-	URL ${CASPARCG_DOWNLOAD_MIRROR}/sfml/SFML-2.4.2-windows-vc14-64-bit.zip
-	URL_HASH MD5=8a2f747335fa21a7a232976daa9031ac
+FetchContent_Declare(sfml
+	URL ${CASPARCG_DOWNLOAD_MIRROR}/sfml/SFML-2.6.2-windows-vc17-64-bit.zip
+	URL_HASH MD5=dee0602d6f94d1843eef4d7568d2c23d
 	DOWNLOAD_DIR ${CASPARCG_DOWNLOAD_CACHE}
-	CONFIGURE_COMMAND ""
-	BUILD_COMMAND ""
-	INSTALL_COMMAND ""
 )
-ExternalProject_Get_Property(sfml SOURCE_DIR)
-set(SFML_INCLUDE_PATH ${SOURCE_DIR}/include)
-set(SFML_BIN_PATH "${SOURCE_DIR}/bin")
-link_directories(${SOURCE_DIR}/lib)
-casparcg_add_runtime_dependency("${SFML_BIN_PATH}/sfml-graphics-d-2.dll" "Debug")
-casparcg_add_runtime_dependency("${SFML_BIN_PATH}/sfml-graphics-2.dll" "Release")
-casparcg_add_runtime_dependency("${SFML_BIN_PATH}/sfml-window-d-2.dll" "Debug")
-casparcg_add_runtime_dependency("${SFML_BIN_PATH}/sfml-window-2.dll" "Release")
-casparcg_add_runtime_dependency("${SFML_BIN_PATH}/sfml-system-d-2.dll" "Debug")
-casparcg_add_runtime_dependency("${SFML_BIN_PATH}/sfml-system-2.dll" "Release")
+FetchContent_MakeAvailable(sfml)
+
+list(APPEND CMAKE_PREFIX_PATH ${sfml_SOURCE_DIR}/lib/cmake/SFML)
+# set(SFML_STATIC_LIBRARIES TRUE)
+find_package(SFML 2 COMPONENTS graphics window REQUIRED)
+
+casparcg_add_runtime_dependency_from_target(sfml-graphics)
+casparcg_add_runtime_dependency_from_target(sfml-window)
+casparcg_add_runtime_dependency_from_target(sfml-system)
 
 #ZLIB
 casparcg_add_external_project(zlib)
@@ -178,27 +180,26 @@ ExternalProject_Get_Property(zlib SOURCE_DIR)
 ExternalProject_Get_Property(zlib BINARY_DIR)
 set(ZLIB_INCLUDE_PATH "${SOURCE_DIR};${BINARY_DIR}")
 
-if (CMAKE_GENERATOR MATCHES "Visual Studio")
+if (is_multi_config)
 	link_directories(${BINARY_DIR}/Release)
 else()
 	link_directories(${BINARY_DIR})
 endif()
 
-# OPENAL
-casparcg_add_external_project(openal)
-ExternalProject_Add(openal
+# OpenAL
+FetchContent_Declare(openal
 	URL ${CASPARCG_DOWNLOAD_MIRROR}/openal/openal-soft-1.19.1-bin.zip
 	URL_HASH MD5=b78ef1ba26f7108e763f92df6bbc3fa5
 	DOWNLOAD_DIR ${CASPARCG_DOWNLOAD_CACHE}
-	BUILD_IN_SOURCE 1
-	CONFIGURE_COMMAND ""
-	BUILD_COMMAND ${CMAKE_COMMAND} -E copy bin/Win64/soft_oal.dll bin/Win64/OpenAL32.dll
-	INSTALL_COMMAND ""
 )
-ExternalProject_Get_Property(openal SOURCE_DIR)
-set(OPENAL_INCLUDE_PATH "${SOURCE_DIR}/include")
-link_directories("${SOURCE_DIR}/libs/Win64")
-casparcg_add_runtime_dependency("${SOURCE_DIR}/bin/Win64/OpenAL32.dll")
+FetchContent_MakeAvailable(openal)
+file(COPY_FILE ${openal_SOURCE_DIR}/bin/Win64/soft_oal.dll ${openal_SOURCE_DIR}/bin/Win64/OpenAL32.dll)
+
+add_library(OpenAL::OpenAL INTERFACE IMPORTED)
+target_include_directories(OpenAL::OpenAL INTERFACE ${openal_SOURCE_DIR}/include)
+target_link_directories(OpenAL::OpenAL INTERFACE ${openal_SOURCE_DIR}/libs/Win64)
+target_link_libraries(OpenAL::OpenAL INTERFACE OpenAL32)
+casparcg_add_runtime_dependency("${openal_SOURCE_DIR}/bin/Win64/OpenAL32.dll")
 
 # flash template host
 casparcg_add_external_project(flashtemplatehost)
@@ -219,7 +220,6 @@ set(TEMPLATE_HOST_PATH "${SOURCE_DIR}")
 set(LIBERATION_FONTS_BIN_PATH "${PROJECT_SOURCE_DIR}/shell/liberation-fonts")
 casparcg_add_runtime_dependency("${LIBERATION_FONTS_BIN_PATH}/LiberationMono-Regular.ttf")
 
-message("TEST ${EXTERNAL_CMAKE_ARGS}")
 # CEF
 if (ENABLE_HTML)
 	casparcg_add_external_project(cef)
@@ -233,30 +233,33 @@ if (ENABLE_HTML)
 	ExternalProject_Get_Property(cef SOURCE_DIR)
 	ExternalProject_Get_Property(cef BINARY_DIR)
 
+    add_library(CEF::CEF INTERFACE IMPORTED)
+	add_dependencies(CEF::CEF cef)
+    target_include_directories(CEF::CEF INTERFACE
+        "${SOURCE_DIR}"
+    )
 
-	set(CEF_INCLUDE_PATH ${SOURCE_DIR})
 	set(CEF_RESOURCE_PATH ${SOURCE_DIR}/Resources)
 	set(CEF_BIN_PATH ${SOURCE_DIR}/Release)
-	link_directories(${SOURCE_DIR}/Release)
-	link_directories(${BINARY_DIR}/libcef_dll_wrapper)
-
-	if (CMAKE_GENERATOR MATCHES "Visual Studio")
-	set(CEF_LIB
-			libcef
-			optimized Release/libcef_dll_wrapper
-			debug Debug/libcef_dll_wrapper)
+
+	if (is_multi_config)
+	    target_link_libraries(CEF::CEF INTERFACE
+			${SOURCE_DIR}/Release/libcef.lib
+			optimized ${BINARY_DIR}/libcef_dll_wrapper/Release/libcef_dll_wrapper.lib
+			debug ${BINARY_DIR}/libcef_dll_wrapper/Debug/libcef_dll_wrapper.lib)
 	else()
-	set(CEF_LIB
-			libcef
-			libcef_dll_wrapper)
+		link_directories(${SOURCE_DIR}/Release ${BINARY_DIR}/libcef_dll_wrapper)
+		target_link_libraries(CEF::CEF INTERFACE
+			libcef.lib
+			libcef_dll_wrapper.lib)
 	endif()
 
 	casparcg_add_runtime_dependency_dir("${CEF_RESOURCE_PATH}/locales")
 	casparcg_add_runtime_dependency("${CEF_RESOURCE_PATH}/chrome_100_percent.pak")
 	casparcg_add_runtime_dependency("${CEF_RESOURCE_PATH}/chrome_200_percent.pak")
 	casparcg_add_runtime_dependency("${CEF_RESOURCE_PATH}/resources.pak")
 	casparcg_add_runtime_dependency("${CEF_RESOURCE_PATH}/icudtl.dat")
-	
+
 	casparcg_add_runtime_dependency("${CEF_BIN_PATH}/snapshot_blob.bin")
 	casparcg_add_runtime_dependency("${CEF_BIN_PATH}/v8_context_snapshot.bin")
 	casparcg_add_runtime_dependency("${CEF_BIN_PATH}/libcef.dll")