cmake: Clean-up pass and code optimization to prepare for Linux update #9769

PatTheMav · 2023-10-27T14:18:41Z

Description

Cleans up the CMake code-base based on experience after the recent CMake build system updates:

Change OS-specific code branches to platform-specific generator expressions
Enforce list sorting in some places to ensure consistency
Disable CMake formatting for custom functions that are not recognised by cmake-format or for updated CMake functions whose updated signatures it doesn't support
Switch interface libraries to object libraries where possible
Remove custom CMake policy code for policies that were set to NEW by CMake 3.22+ anyway.
Remove support for Qt5 in dependency resolution
FFmpeg package selection uses an explicit version parameter (6.0.0+ on Windows and macOS, 5.1.0+ on Ubuntu)
Windows 🪟: Update Windows warning suppressions by investigating their root causes (some warnings' root causes need to be fixed upstream) and making suppressions more specific
Windows 🪟: Enable fallback configurations for libraries' optimised build types
macOS 🍏: Remove support for any generator besides Xcode on macOS

Important

An accompanying update of obs-browser will also
requires the CEF wrapper library to be re-built for Windows following the proper procedure outlined in the documentation: https://bitbucket.org/chromiumembedded/cef/wiki/LinkingDifferentRunTimeLibraries.md

Without updating the submodule the project will still build without issues.

Motivation and Context

Moving platform-specific source file and library dependency information into global blocks with generator expressions makes the requirements more explicit (and also groups all source code dependencies into one logical place), removing the need to search for their inclusion in other parts of the file (and reduces amount if code branches, which also improves cmake-lint checks).

Changes are mostly cosmetic or attempt to reduce complexity by removing seldom-used options or features introduced in recent updates. Windows-specific changes also aim to make more informed decisions about which warnings are suppressed and why.

How Has This Been Tested?

Preliminary tests looked fine, specific tests are still pending:

Builds on Windows 11 (Browser disabled)
Builds on Windows 11 (With fixed runtime library for CEF-wrapper)
Builds on Windows 11 (CMake Legacy, Browser disabled)
Builds on Windows 11 (CMake Legacy, with fixed runtime library for CEF-wrapper)
Builds on macOS 13
Builds on macOS 14
Builds on Ubuntu 22.04 (CMake Legacy, AJA+WebRTC+New MPEGTS output disabled)
Builds on Ubuntu 23.04 (CMake Legacy)
Builds on FreeBSD 13.2 (CMake Legacy, AJA+JACK disabled)

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-10-28T23:27:47Z

Some changes around shared UI code might conflicts with #9350.

RytoEX

Mostly questions seeking rationale and clarification. Builds locally on Windows 11. Haven't done any further in-depth testing.

plugins/obs-qsv11/CMakeLists.txt

UI/cmake/ui-qt.cmake

plugins/win-capture/get-graphics-offsets/CMakeLists.txt

plugins/win-capture/graphics-hook/CMakeLists.txt

plugins/win-capture/inject-helper/CMakeLists.txt

plugins/win-dshow/virtualcam-module/CMakeLists.txt

PatTheMav · 2023-11-03T14:23:30Z

Force-pushed an update to address some reviews, also:

Added explicit checks for OS_OPENBSD and OpenBSD platform id
Switched from C_COMPILE_ID checks to COMPILE_LANG_AND_ID, which has the benefit of applying the expression when the target's source code language and associated compiler id match (and not just if the compiler id for the language in general matches).
Removed the addition if the -py3 flag to swig, which has been deprecated a while ago.

RytoEX

Second pass.

UI/cmake/feature-whatsnew.cmake

UI/cmake/ui-qt.cmake

UI/frontend-plugins/aja-output-ui/CMakeLists.txt

libobs-opengl/CMakeLists.txt

libobs/CMakeLists.txt

plugins/obs-outputs/cmake/ftl.cmake

plugins/text-freetype2/CMakeLists.txt

RytoEX

Quick review of files I hadn't marked viewed since last review.

cmake/windows/compilerconfig.cmake

plugins/text-freetype2/CMakeLists.txt

RytoEX · 2023-12-14T23:43:25Z

Remove support for Qt5, removed helper function used during transition

I think this was left in for now to ease the transition of submodules to removing their use of it. We can remove the actual CMake function in the next major release. In any case, the PR description may need updating.

PatTheMav · 2023-12-16T17:17:54Z

Remove support for Qt5, removed helper function used during transition

I think this was left in for now to ease the transition of submodules to removing their use of it. We can remove the actual CMake function in the next major release. In any case, the PR description may need updating.

Updated the description - Qt5 was indeed removed in the parts that resolve dependencies of the main app but the helper function is still there.

PatTheMav · 2023-12-18T22:43:10Z

Rebased and squashed commits into logical units.

RytoEX

Local tests seemed fine. CI is green.

find_qt was necessary during the transitional period between Qt5 and Qt6. With Qt6 being the only supported Qt version (for open source) for the time being, code complexity can be reduced for easier maintenance.

Also manually updates some CMake script files to make code more readable.

Allows the customized UI elements used by OBS Studio to more cleanly be integrated into consumers of the same elements, mainly frontend plugins in the main source tree.

Also updates CMake formatting with manual format choices.

RytoEX self-assigned this Oct 27, 2023

RytoEX added the Code Cleanup Non-breaking change which makes code smaller or more readable label Oct 27, 2023

PatTheMav force-pushed the cmake-cleanup branch from f6284e6 to 98f792b Compare October 27, 2023 18:57

This was referenced Nov 1, 2023

cmake: Update formatting and switch to native find_package call for Qt6 obsproject/obs-browser#424

Merged

cmake: Update formatting and switch to native find_package call for Qt6 obsproject/obs-websocket#1178

Merged

RytoEX requested changes Nov 2, 2023

View reviewed changes

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

tytan652 mentioned this pull request Nov 3, 2023

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

Merged

6 tasks

PatTheMav force-pushed the cmake-cleanup branch from 98f792b to 430c85b Compare November 3, 2023 14:21

PatTheMav force-pushed the cmake-cleanup branch from 430c85b to 23a727a Compare November 3, 2023 15:02

RytoEX requested changes Nov 3, 2023

View reviewed changes

PatTheMav force-pushed the cmake-cleanup branch 2 times, most recently from 9d072ea to df3ae0f Compare November 9, 2023 17:13

PatTheMav force-pushed the cmake-cleanup branch from df3ae0f to d11b33f Compare November 17, 2023 15:51

PatTheMav marked this pull request as ready for review November 17, 2023 15:52

PatTheMav force-pushed the cmake-cleanup branch from d11b33f to dec1427 Compare November 23, 2023 12:56

RytoEX requested changes Dec 6, 2023

View reviewed changes

cmake/windows/compilerconfig.cmake Outdated Show resolved Hide resolved

cmake/windows/compilerconfig.cmake Outdated Show resolved Hide resolved

cmake/windows/compilerconfig.cmake Show resolved Hide resolved

plugins/text-freetype2/CMakeLists.txt Outdated Show resolved Hide resolved

PatTheMav force-pushed the cmake-cleanup branch 5 times, most recently from 3aa635a to ac34889 Compare December 11, 2023 14:29

PatTheMav mentioned this pull request Dec 16, 2023

cmake: Expand generator exps in libobs pkgconfig #10008

Closed

6 tasks

PatTheMav force-pushed the cmake-cleanup branch from ac34889 to 2eb0862 Compare December 18, 2023 22:42

RytoEX approved these changes Dec 18, 2023

View reviewed changes

PatTheMav force-pushed the cmake-cleanup branch from 2eb0862 to dd60f14 Compare December 19, 2023 02:31

RytoEX changed the title ~~cmake: Clean-up pass and code optimisation to prepare for Linux update~~ cmake: Clean-up pass and code optimization to prepare for Linux update Dec 19, 2023

PatTheMav added 13 commits December 19, 2023 23:39

cmake: Replace custom Qt discovery function with CMake default

a175714

find_qt was necessary during the transitional period between Qt5 and Qt6. With Qt6 being the only supported Qt version (for open source) for the time being, code complexity can be reduced for easier maintenance.

cmake: Update FFmpeg find package to use explicit version

ac7512b

deps: Update CMake target source lists with alphabetic sorting

7f5a0ec

Also manually updates some CMake script files to make code more readable.

libobs: Update CMake target source lists with alphabetic sorting

165c7b2

libobs-opengl: Update CMake formatting with manual format choices

24ade96

plugins: Update CMake formatting with manual format choices

ad912e7

aja: Add shared interface library for plugin and frontend-plugin

fc78c40

UI: Add UI support interface library with custom Qt elements

11f8b9a

Allows the customized UI elements used by OBS Studio to more cleanly be integrated into consumers of the same elements, mainly frontend plugins in the main source tree.

UI: Update CMake target source lists with alphabetic sorting

b475968

Also updates CMake formatting with manual format choices.

test: Update CMake target source lists with alphabetic sorting

324817b

cmake: Update CMake formatting with manual format choices

bbc7e54

cmake: Remove support for generators besides Xcode on macOS

3f28453

libobs-d3d11: Remove unnecessary quoting of CMake generator expression

9e7bddb

PatTheMav force-pushed the cmake-cleanup branch from dd60f14 to 9e7bddb Compare December 19, 2023 22:40

RytoEX merged commit c4ce858 into obsproject:master Dec 19, 2023

PatTheMav deleted the cmake-cleanup branch December 19, 2023 23:11

Uh oh!

cmake: Clean-up pass and code optimization to prepare for Linux update #9769

cmake: Clean-up pass and code optimization to prepare for Linux update #9769

Uh oh!

Conversation

PatTheMav commented Oct 27, 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 Oct 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RytoEX left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PatTheMav commented Nov 3, 2023

Uh oh!

RytoEX left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RytoEX left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RytoEX commented Dec 14, 2023

Uh oh!

PatTheMav commented Dec 16, 2023

Uh oh!

PatTheMav commented Dec 18, 2023

Uh oh!

RytoEX left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

PatTheMav commented Oct 27, 2023 •

edited

Loading

tytan652 commented Oct 28, 2023 •

edited

Loading