cmake: Update Linux build scripts to new 3.0 build path #9787

PatTheMav · 2023-11-01T16:43:07Z

Description

Completes the migration of OBS Studio's build system to the updated CMake 3.0 build path introduced to macOS and Windows before.

Important

This PR is directly based on top of #9769, which should be reviewed and merged first, at which point a rebase will reduce the amount of changes introduced by this PR.

Additional squashing of commits will be done after reviews are finished.

This PR builds on all the systems and methods introduced for other platforms before and extends it:

Added updated find modules for Linux-specific dependencies:
- JACK audio
- LibUUID
- Libdrm
- Libfdk
- Libpci
- Libudev
- Libv4l2
- Libva
- OSS
- PipeWire
- PulseAudio
- Sndio
- Sysinfo
- Wayland
- glib and gio
- X11-xcb
- XCB
- xkbcommon
Updates existing find modules to improve compatibility with Linux:
- FFmpeg (improved version extraction from ffversion.h)
- Libx264 (improved version extraction from x264_config.h)
- LuaJIT (switched version extraction to use LuaJIT version and not Lua version)
- MbedTLS (improved version extraction from mbedtls/version.h)
Find modules should be able to locate dependencies either via pkg-config hints or CMake's build in dependency detection
Added check for possibly separate math library provided by toolchain to explicitly link to it when necessary
Added some additional checks for the presence of headers in system include paths
Updated all Linux-specific modules:
- linux-alsa
- linux-capture
- linux-jack
- linux-pipewire
- linux-pulseaudio
- linux-v4l2
- oss-audio
- sndio
Updated Linux-specific code for already updated modules:
- libobs
- obs-libfdk
- obs-ffmpeg
- obs-outputs
- obs-qsv11
- UI
- aja
- vlc
Enabled support for Python 3.11+ outside of Windows and macOS
Fixed simple GCC compile warnings (unused code)
Add GCC-specific warning suppressions where appropriate (usually for parity with Clang-specific warnings)
Updated default GCC compiler flags for parity with Clang compiler flags
Retained reasonable FreeBSD compatibility (updated Cirrus CI file to enable CMake 3.0 builds for FreeBSD)
Updated CI build scripts and GitHub Actions workflows

Note

Lower CMake version boundary is not increased by this PR, the minimum required version on Linux will still be CMake 3.22.

Fixes #7407.
Fixes #7972.
Closes #10008.

Motivation and Context

Remove legacy code and improve CMake codebase for Linux (and FreeBSD) and achieve parity with Windows and macOS.

How Has This Been Tested?

Tested on Ubuntu 23.04 and FreeBSD 13.2.

Types of changes

Code cleanup (non-breaking change which makes code smaller or more readable)

Checklist:

My code has been run through clang-format.
I have read the contributing document.
My code is not on the master branch.
The code has been tested.
All commit messages are properly formatted and commits squashed where appropriate.
I have included updates to all appropriate documentation.

tytan652 · 2023-11-01T20:13:14Z

CMake 3.0 does not provide support for system ftl-sdk install.

tytan652 · 2023-11-01T21:14:11Z

Made a packaging test build on Arch Linux and many headers are missing as it is.

~~example.h~~ indicate a missing header compared to a build without the PR.

I didn't dig further but for some reason obs-browser-page locale file are no longer installed, ~~I don't know if it's intended~~ error.html is missing too. I do use your obs-browser branch.

tytan652 · 2023-11-01T21:29:21Z

I forgot to mention, the pkg-config file for libobs is no longer installed.
On Linux, even if there is a CMake package, this method is not universal among build-systems (pkg-config is).

PatTheMav · 2023-11-01T22:18:42Z

I forgot to mention, the pkg-config file for libobs is no longer installed. On Linux, even if there is a CMake package, this method is not universal among build-systems (pkg-config is).

We should add a handcrafted pkg-config file - generating it from CMake will break the moment generator expressions are used in the dependency graph (or at the very least make it complicated to generate one).

Some elements might be generated automatically (e.g. version) but CFlags and everything surround static/shared requirements should be written by hand.

I'm happy to add that if someone can provide me the template file for it.

plugins/obs-ffmpeg/cmake/dependencies.cmake

plugins/linux-v4l2/CMakeLists.txt

plugins/obs-filters/cmake/rnnoise.cmake

tytan652 · 2023-11-02T12:41:04Z

You should force the Flatpak to build with CMake 3.0 (without preset), there is many issues not revealed in CI because of that.

PatTheMav · 2023-11-02T12:42:41Z

You should force the Flatpak to build with CMake 3.0 (without preset), there is many issues not revealed in CI because of that.

I deliberately not updated that yet because I wanted to leave that to you or @GeorgesStavracas to update when you can support the migration.

tytan652 · 2023-11-02T12:47:11Z

I deliberately not updated that yet because I wanted to leave that to you or @GeorgesStavracas to update when you can support the migration.

I will not debug this post merge, this should pass all Linux CI with CMake 3.0. Also what migration ?

PatTheMav · 2023-11-02T12:52:28Z

I deliberately not updated that yet because I wanted to leave that to you or @GeorgesStavracas to update when you can support the migration.

I will not debug this post merge, this should pass all Linux CI with CMake 3.0. Also what migration ?

When this PR is merged, it will not automatically default to the new CMake build variant if no preset is selected, it is "opt-in" (like it is on Windows right now). That way packagers/maintainers can chose when to make the switch and report bugs that might not have been discovered during review without breaking the ability to still generate packages.

That timeframe until either a preset is required or the legacy code paths are removed is the migration period (so far we waited a full release cycle to remove the legacy path for macOS, Windows legacy and x86 slices might be removed with the version after the next) so the Flatpak update does not have to occur at the same time but can happen at a later point.

That's up to the Flatpak maintainers to decide and adapt.

tytan652 · 2023-11-02T12:55:57Z

AJA is broken, on Flatpak and Arch Linux.

[152/509] Linking CXX shared module plugins/aja/aja.so
FAILED: plugins/aja/aja.so 
: && /usr/bin/c++ -fPIC -O3 -DNDEBUG  -L/app/lib -shared  -o plugins/aja/aja.so plugins/aja/CMakeFiles/aja-support.dir/aja-card-manager.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-common.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-presets.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-props.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-routing.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-vpid-data.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-widget-io.cpp.o plugins/aja/CMakeFiles/aja.dir/aja-output.cpp.o plugins/aja/CMakeFiles/aja.dir/aja-source.cpp.o plugins/aja/CMakeFiles/aja.dir/audio-repack.c.o plugins/aja/CMakeFiles/aja.dir/main.cpp.o  -Wl,-rpath,/home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/lib:/home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/libobs:  libobs/libobs.so.30  /app/lib/libajantv2.a && cd /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/plugins/aja && /usr/bin/cmake -E make_directory /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/lib/obs-plugins && /usr/bin/cmake -E copy_if_different /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/plugins/aja/aja.so /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/lib/obs-plugins && cd /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/plugins/aja && /usr/bin/cmake -E make_directory /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/share/obs/obs-plugins/aja && /usr/bin/cmake -E copy_directory /home/tytan652/Programming/OBS/obs-studio/plugins/aja/data /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/share/obs/obs-plugins/aja
/usr/lib/gcc/x86_64-unknown-linux-gnu/12.2.0/../../../../x86_64-unknown-linux-gnu/bin/ld: plugins/aja/CMakeFiles/aja-support.dir/aja-routing.cpp.o: warning: relocation against `_ZTVSt9basic_iosIcSt11char_traitsIcEE@@GLIBCXX_3.4' in read-only section `.text.unlikely'
/usr/lib/gcc/x86_64-unknown-linux-gnu/12.2.0/../../../../x86_64-unknown-linux-gnu/bin/ld: plugins/aja/CMakeFiles/aja-support.dir/aja-card-manager.cpp.o: relocation R_X86_64_PC32 against symbol `__libc_single_threaded@@GLIBC_2.32' can not be used when making a shared object; recompile with -fPIC
/usr/lib/gcc/x86_64-unknown-linux-gnu/12.2.0/../../../../x86_64-unknown-linux-gnu/bin/ld: final link failed: bad value
collect2: error: ld returned 1 exit status
[157/509] Building C object plugins/linux-capture/CMakeFiles/linux-capture.dir/xshm-input.c.o
ninja: build stopped: subcommand failed.

tytan652

Review of the GIO finder with suggestions to make it work correctly.

cmake/finders/Findgio.cmake

PatTheMav · 2023-11-03T13:41:44Z

AJA is broken, on Flatpak and Arch Linux.

[152/509] Linking CXX shared module plugins/aja/aja.so
FAILED: plugins/aja/aja.so 
: && /usr/bin/c++ -fPIC -O3 -DNDEBUG  -L/app/lib -shared  -o plugins/aja/aja.so plugins/aja/CMakeFiles/aja-support.dir/aja-card-manager.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-common.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-presets.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-props.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-routing.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-vpid-data.cpp.o plugins/aja/CMakeFiles/aja-support.dir/aja-widget-io.cpp.o plugins/aja/CMakeFiles/aja.dir/aja-output.cpp.o plugins/aja/CMakeFiles/aja.dir/aja-source.cpp.o plugins/aja/CMakeFiles/aja.dir/audio-repack.c.o plugins/aja/CMakeFiles/aja.dir/main.cpp.o  -Wl,-rpath,/home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/lib:/home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/libobs:  libobs/libobs.so.30  /app/lib/libajantv2.a && cd /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/plugins/aja && /usr/bin/cmake -E make_directory /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/lib/obs-plugins && /usr/bin/cmake -E copy_if_different /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/plugins/aja/aja.so /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/lib/obs-plugins && cd /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/plugins/aja && /usr/bin/cmake -E make_directory /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/share/obs/obs-plugins/aja && /usr/bin/cmake -E copy_directory /home/tytan652/Programming/OBS/obs-studio/plugins/aja/data /home/tytan652/.cache/gnome-builder/projects/obs-studio/builds/com.obsproject.Studio.json-flatpak-org.kde.Platform-6.5-x86_64-linux-build-update/rundir/Release/share/obs/obs-plugins/aja
/usr/lib/gcc/x86_64-unknown-linux-gnu/12.2.0/../../../../x86_64-unknown-linux-gnu/bin/ld: plugins/aja/CMakeFiles/aja-support.dir/aja-routing.cpp.o: warning: relocation against `_ZTVSt9basic_iosIcSt11char_traitsIcEE@@GLIBCXX_3.4' in read-only section `.text.unlikely'
/usr/lib/gcc/x86_64-unknown-linux-gnu/12.2.0/../../../../x86_64-unknown-linux-gnu/bin/ld: plugins/aja/CMakeFiles/aja-support.dir/aja-card-manager.cpp.o: relocation R_X86_64_PC32 against symbol `__libc_single_threaded@@GLIBC_2.32' can not be used when making a shared object; recompile with -fPIC
/usr/lib/gcc/x86_64-unknown-linux-gnu/12.2.0/../../../../x86_64-unknown-linux-gnu/bin/ld: final link failed: bad value
collect2: error: ld returned 1 exit status
[157/509] Building C object plugins/linux-capture/CMakeFiles/linux-capture.dir/xshm-input.c.o
ninja: build stopped: subcommand failed.

That might require explicitly setting the POSITION_INDEPENDENT_CODE target property - I just have to find out for which target specifically.

plugins/aja/CMakeLists.txt

IGN-Styly · 2023-12-09T13:28:29Z

Fails to build on linux?

PatTheMav · 2023-12-20T18:25:54Z

PR has been rebased and updated but still requires the browser and websocket submodules to be updated first.

RytoEX · 2024-04-13T18:13:01Z

@PatTheMav and I did some off-thread testing and debugging and found a few lingering items to fix up. Will re-check this "soon".

New code path only taken if OBS_CMAKE_VERSION is set to 3.0.0 or greater, old functionality remains unchanged.

Also silences acknowledged compile warnings introduced by the updated compiler settings in the CMake update.

Also adds source package generation and updates Cirrus CI script.

RytoEX

Looks good on Windows 11. I tested on Ubuntu earlier today. If we missed something or if anything is not working it will surely be brought to our attention.

PatTheMav force-pushed the linux-build-update branch 4 times, most recently from 35f2103 to 84d4c4f Compare November 1, 2023 17:41

kkartaltepe reviewed Nov 2, 2023

View reviewed changes

plugins/obs-ffmpeg/cmake/dependencies.cmake Show resolved Hide resolved

kkartaltepe reviewed Nov 2, 2023

View reviewed changes

plugins/linux-v4l2/CMakeLists.txt Outdated Show resolved Hide resolved

tytan652 reviewed Nov 2, 2023

View reviewed changes

plugins/obs-filters/cmake/rnnoise.cmake Outdated Show resolved Hide resolved

PatTheMav force-pushed the linux-build-update branch from ba5b83a to 73ec829 Compare November 2, 2023 11:51

RytoEX added Code Cleanup Non-breaking change which makes code smaller or more readable New Feature New feature or plugin labels Nov 2, 2023

RytoEX added this to the OBS Studio (Next Version) milestone Nov 2, 2023

tytan652 suggested changes Nov 3, 2023

View reviewed changes

tytan652 mentioned this pull request Nov 3, 2023

cmake: Allow finding the CEF wrapper without a build folder on Linux #9794

Merged

6 tasks

tytan652 reviewed Nov 3, 2023

View reviewed changes

plugins/aja/CMakeLists.txt Show resolved Hide resolved

PatTheMav mentioned this pull request Dec 16, 2023

cmake: Expand generator exps in libobs pkgconfig #10008

Closed

6 tasks

hufman mentioned this pull request Dec 18, 2023

obs-studio: patch to fix libobs.po on arm64 NixOS/nixpkgs#275221

Merged

13 tasks

RytoEX self-assigned this Dec 20, 2023

PatTheMav force-pushed the linux-build-update branch from 73ec829 to 3d626f2 Compare December 20, 2023 18:03

PatTheMav force-pushed the linux-build-update branch 4 times, most recently from 975e1b8 to 15f890a Compare April 13, 2024 18:10

PatTheMav force-pushed the linux-build-update branch 2 times, most recently from f52ab63 to 197659a Compare April 13, 2024 22:46

RytoEX mentioned this pull request Apr 14, 2024

linux-pipewire: Remove unused variables #10531

Merged

6 tasks

PatTheMav force-pushed the linux-build-update branch from 197659a to c490439 Compare April 14, 2024 01:46

PatTheMav added 13 commits April 14, 2024 03:54

plugins: Fix compile errors introduced by CMake build framework 3.0

3e5c7ff

deps: Suppress acknowledged compile-time warnings for json11

12393f3

cmake: Add Linux component to CMake build framework 3.0

af6b574

libobs: Add changes for CMake build framework 3.0

9bb2549

New code path only taken if OBS_CMAKE_VERSION is set to 3.0.0 or greater, old functionality remains unchanged.

libobs-opengl: Add Linux-specific changes for CMake build framework 3.0

961e0a9

plugins: Add Linux-specific plugins for CMake build framework 3.0

d93732b

plugins: Update Linux slice of cross-platform plugins for CMake 3.0

72cbed9

Also silences acknowledged compile warnings introduced by the updated compiler settings in the CMake update.

plugins: Update platform selection for adding plugins to build tree

c0520d9

UI: Update Linux slice for CMake build framework 3.0

1c5ea79

obs-scripting: Update Linux slice for CMake build framework 3.0

ac2a8c0

test: Update Linux slice for CMake build framework 3.0

fbe76c1

UI: Make Sparkle updater a macOS-only feature

b9388be

CI: Update Linux build scripts to use CMake presets

218a9f2

Also adds source package generation and updates Cirrus CI script.

PatTheMav force-pushed the linux-build-update branch from c490439 to 218a9f2 Compare April 14, 2024 02:02

RytoEX approved these changes Apr 14, 2024

View reviewed changes

RytoEX merged commit fb4d658 into obsproject:master Apr 14, 2024

PatTheMav deleted the linux-build-update branch April 14, 2024 12:01

tbocek mentioned this pull request Apr 27, 2024

address issue #2 tbocek/obs-source-all#3

Merged

tytan652 mentioned this pull request May 9, 2024

UI: Improve and update app CMake 3 metainfo file #10658

Merged

6 tasks

RytoEX mentioned this pull request Jun 7, 2024

CI: Fix incorrect filenames in release creation #10797

Merged

6 tasks

mihawk90 mentioned this pull request Sep 24, 2025

OBS 32 -- WHIP option disappeared from Settings. #12645

Closed

Uh oh!

cmake: Update Linux build scripts to new 3.0 build path #9787

cmake: Update Linux build scripts to new 3.0 build path #9787

Conversation

PatTheMav commented Nov 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

tytan652 commented Nov 1, 2023

Uh oh!

tytan652 commented Nov 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tytan652 commented Nov 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PatTheMav commented Nov 1, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tytan652 commented Nov 2, 2023

Uh oh!

PatTheMav commented Nov 2, 2023

Uh oh!

tytan652 commented Nov 2, 2023

Uh oh!

PatTheMav commented Nov 2, 2023

Uh oh!

tytan652 commented Nov 2, 2023

Uh oh!

tytan652 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PatTheMav commented Nov 3, 2023

Uh oh!

Uh oh!

IGN-Styly commented Dec 9, 2023

Uh oh!

PatTheMav commented Dec 20, 2023

Uh oh!

RytoEX commented Apr 13, 2024

Uh oh!

RytoEX left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

PatTheMav commented Nov 1, 2023 •

edited

Loading

tytan652 commented Nov 1, 2023 •

edited

Loading

tytan652 commented Nov 1, 2023 •

edited

Loading

tytan652 left a comment •

edited

Loading