1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
# Set OS-specific constants in non-deprecated way
include(GNUInstallDirs)
if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
include(ObsDefaults_macOS)
set(OS_MACOS ON)
set(OS_POSIX ON)
elseif(CMAKE_SYSTEM_NAME MATCHES "Linux|FreeBSD|OpenBSD")
include(ObsDefaults_Linux)
set(OS_POSIX ON)
string(TOUPPER "${CMAKE_SYSTEM_NAME}" _SYSTEM_NAME_U)
set(OS_${_SYSTEM_NAME_U} ON)
elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
include(ObsDefaults_Windows)
set(OS_WINDOWS ON)
set(OS_POSIX OFF)
endif()
# Create global property to hold list of activated modules
set_property(GLOBAL PROPERTY OBS_MODULE_LIST "")
# ######################################################################################################################
# GLOBAL HELPER FUNCTIONS #
# ######################################################################################################################
# Helper function to set up runtime or library targets
function(setup_binary_target target)
# Set up installation paths for program install
install(
TARGETS ${target}
RUNTIME DESTINATION ${OBS_EXECUTABLE_DESTINATION} COMPONENT ${target}_Runtime
LIBRARY DESTINATION ${OBS_LIBRARY_DESTINATION}
COMPONENT ${target}_Runtime
NAMELINK_COMPONENT ${target}_Development
ARCHIVE DESTINATION ${OBS_LIBRARY_DESTINATION} COMPONENT ${target}_Development
PUBLIC_HEADER
DESTINATION ${OBS_INCLUDE_DESTINATION}
COMPONENT ${target}_Development
EXCLUDE_FROM_ALL)
# Set up installation paths for development rundir
install(
TARGETS ${target}
RUNTIME DESTINATION ${OBS_EXECUTABLE_DESTINATION}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL
LIBRARY DESTINATION ${OBS_LIBRARY_DESTINATION}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL
PUBLIC_HEADER
DESTINATION ${OBS_INCLUDE_DESTINATION}
COMPONENT IGNORED
EXCLUDE_FROM_ALL)
add_custom_command(
TARGET ${target}
POST_BUILD
COMMAND "${CMAKE_COMMAND}" -E env DESTDIR= "${CMAKE_COMMAND}" --install .. --config $<CONFIG> --prefix
${OBS_OUTPUT_DIR}/$<CONFIG> --component obs_${target} > "$<IF:$<PLATFORM_ID:Windows>,nul,/dev/null>"
COMMENT "Installing OBS rundir"
VERBATIM)
endfunction()
# Helper function to set up OBS plugin targets
function(setup_plugin_target target)
set_target_properties(${target} PROPERTIES PREFIX "")
install(
TARGETS ${target}
RUNTIME DESTINATION ${OBS_PLUGIN_DESTINATION} COMPONENT ${target}_Runtime
LIBRARY DESTINATION ${OBS_PLUGIN_DESTINATION}
COMPONENT ${target}_Runtime
NAMELINK_COMPONENT ${target}_Development)
install(
TARGETS ${target}
RUNTIME DESTINATION ${OBS_PLUGIN_DESTINATION}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL
LIBRARY DESTINATION ${OBS_PLUGIN_DESTINATION}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL)
setup_target_resources("${target}" "obs-plugins/${target}")
set_property(GLOBAL APPEND PROPERTY OBS_MODULE_LIST "${target}")
add_custom_command(
TARGET ${target}
POST_BUILD
COMMAND "${CMAKE_COMMAND}" -E env DESTDIR= "${CMAKE_COMMAND}" --install .. --config $<CONFIG> --prefix
${OBS_OUTPUT_DIR}/$<CONFIG> --component obs_${target} > "$<IF:$<PLATFORM_ID:Windows>,nul,/dev/null>"
COMMENT "Installing ${target} to OBS rundir"
VERBATIM)
obs_status(ENABLED "${target}")
endfunction()
# Helper function to set up OBS scripting plugin targets
function(setup_script_plugin_target target)
install(
TARGETS ${target}
LIBRARY DESTINATION ${OBS_SCRIPT_PLUGIN_DESTINATION}
COMPONENT ${target}_Runtime
NAMELINK_COMPONENT ${target}_Development)
install(
TARGETS ${target}
LIBRARY DESTINATION ${OBS_SCRIPT_PLUGIN_DESTINATION}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL)
if(${target} STREQUAL "obspython")
install(
FILES "$<TARGET_FILE_DIR:${target}>/$<TARGET_FILE_BASE_NAME:${target}>.py"
DESTINATION ${OBS_SCRIPT_PLUGIN_DESTINATION}
COMPONENT ${target}_Runtime)
install(
FILES "$<TARGET_FILE_DIR:${target}>/$<TARGET_FILE_BASE_NAME:${target}>.py"
DESTINATION ${OBS_SCRIPT_PLUGIN_DESTINATION}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL)
endif()
set_property(GLOBAL APPEND PROPERTY OBS_SCRIPTING_MODULE_LIST "${target}")
add_custom_command(
TARGET ${target}
POST_BUILD
COMMAND "${CMAKE_COMMAND}" -E env DESTDIR= "${CMAKE_COMMAND}" --install .. --config $<CONFIG> --prefix
${OBS_OUTPUT_DIR}/$<CONFIG> --component obs_${target} > "$<IF:$<PLATFORM_ID:Windows>,nul,/dev/null>"
COMMENT "Installing ${target} to OBS rundir"
VERBATIM)
obs_status(ENABLED "${target}")
endfunction()
# Helper function to set up target resources (e.g. L10N files)
function(setup_target_resources target destination)
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/data")
install(
DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/data/
DESTINATION ${OBS_DATA_DESTINATION}/${destination}
USE_SOURCE_PERMISSIONS
COMPONENT ${target}_Runtime)
install(
DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/data/
DESTINATION ${OBS_DATA_DESTINATION}/${destination}
USE_SOURCE_PERMISSIONS
COMPONENT obs_${target}
EXCLUDE_FROM_ALL)
endif()
endfunction()
# Helper function to set up specific resource files for targets
function(add_target_resource target resource destination)
install(
FILES ${resource}
DESTINATION ${OBS_DATA_DESTINATION}/${destination}
COMPONENT ${target}_Runtime)
install(
FILES ${resource}
DESTINATION ${OBS_DATA_DESTINATION}/${destination}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL)
endfunction()
# Helper function to set up OBS app target
function(setup_obs_app target)
setup_binary_target(${target})
get_property(OBS_MODULE_LIST GLOBAL PROPERTY OBS_MODULE_LIST)
list(LENGTH OBS_MODULE_LIST _LEN)
if(_LEN GREATER 0)
add_dependencies(${target} ${OBS_MODULE_LIST})
endif()
get_property(OBS_SCRIPTING_MODULE_LIST GLOBAL PROPERTY OBS_SCRIPTING_MODULE_LIST)
list(LENGTH OBS_SCRIPTING_MODULE_LIST _LEN)
if(_LEN GREATER 0)
add_dependencies(${target} ${OBS_SCRIPTING_MODULE_LIST})
endif()
if(TARGET OBS::browser)
setup_target_browser(${target})
endif()
if(TARGET OBS::ffmpeg-mux)
add_dependencies(${target} OBS::ffmpeg-mux)
endif()
add_custom_command(
TARGET ${target}
POST_BUILD
COMMAND "${CMAKE_COMMAND}" -E env DESTDIR= "${CMAKE_COMMAND}" --install .. --config $<CONFIG> --prefix
${OBS_OUTPUT_DIR}/$<CONFIG> --component obs_rundir > "$<IF:$<PLATFORM_ID:Windows>,nul,/dev/null>"
COMMENT "Installing OBS rundir"
VERBATIM)
endfunction()
# Helper function to do additional setup for browser source plugin
function(setup_target_browser target)
install(
DIRECTORY ${CEF_ROOT_DIR}/Resources/
DESTINATION ${OBS_PLUGIN_DESTINATION}
COMPONENT ${target}_Runtime)
install(
DIRECTORY ${CEF_ROOT_DIR}/Release/
DESTINATION ${OBS_PLUGIN_DESTINATION}
COMPONENT ${target}_Runtime)
install(
DIRECTORY ${CEF_ROOT_DIR}/Resources/
DESTINATION ${OBS_OUTPUT_DIR}/$<CONFIG>/${OBS_PLUGIN_DESTINATION}
COMPONENT obs_rundir
EXCLUDE_FROM_ALL)
install(
DIRECTORY ${CEF_ROOT_DIR}/Release/
DESTINATION ${OBS_OUTPUT_DIR}/$<CONFIG>/${OBS_PLUGIN_DESTINATION}
COMPONENT obs_rundir
EXCLUDE_FROM_ALL)
endfunction()
# Helper function to export target to build and install tree. Allows usage of `find_package(libobs)` by other build
# trees
function(export_target target)
set(CMAKE_EXPORT_PACKAGE_REGISTRY OFF)
if(OS_LINUX OR OS_FREEBSD)
set(_EXCLUDE "")
else()
set(_EXCLUDE "EXCLUDE_FROM_ALL")
endif()
install(
TARGETS ${target}
EXPORT ${target}Targets
RUNTIME DESTINATION ${OBS_EXECUTABLE_DESTINATION}
COMPONENT obs_libraries
${_EXCLUDE}
LIBRARY DESTINATION ${OBS_LIBRARY_DESTINATION}
COMPONENT obs_libraries
${_EXCLUDE}
ARCHIVE DESTINATION ${OBS_LIBRARY_DESTINATION}
COMPONENT obs_libraries
${_EXCLUDE}
INCLUDES
DESTINATION ${OBS_INCLUDE_DESTINATION}
PUBLIC_HEADER
DESTINATION ${OBS_INCLUDE_DESTINATION}
COMPONENT obs_libraries
${_EXCLUDE})
get_target_property(target_type ${target} TYPE)
if(NOT target_type STREQUAL INTERFACE_LIBRARY)
include(GenerateExportHeader)
generate_export_header(${target} EXPORT_FILE_NAME ${CMAKE_CURRENT_BINARY_DIR}/${target}_EXPORT.h)
target_sources(${target} PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/${target}_EXPORT.h)
endif()
set(TARGETS_EXPORT_NAME "${target}Targets")
include(CMakePackageConfigHelpers)
configure_package_config_file(
${CMAKE_CURRENT_SOURCE_DIR}/cmake/${target}Config.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/${target}Config.cmake
INSTALL_DESTINATION ${OBS_CMAKE_DESTINATION}/${target}
PATH_VARS OBS_PLUGIN_DESTINATION OBS_DATA_DESTINATION)
write_basic_package_version_file(
${CMAKE_CURRENT_BINARY_DIR}/${target}ConfigVersion.cmake
VERSION ${OBS_VERSION_CANONICAL}
COMPATIBILITY SameMajorVersion)
export(
EXPORT ${target}Targets
FILE ${CMAKE_CURRENT_BINARY_DIR}/${TARGETS_EXPORT_NAME}.cmake
NAMESPACE OBS::)
export(PACKAGE "${target}")
install(
EXPORT ${TARGETS_EXPORT_NAME}
FILE ${TARGETS_EXPORT_NAME}.cmake
NAMESPACE OBS::
DESTINATION ${OBS_CMAKE_DESTINATION}/${target}
COMPONENT obs_libraries
${_EXCLUDE})
install(
FILES ${CMAKE_CURRENT_BINARY_DIR}/${target}Config.cmake ${CMAKE_CURRENT_BINARY_DIR}/${target}ConfigVersion.cmake
DESTINATION ${OBS_CMAKE_DESTINATION}/${target}
COMPONENT obs_libraries
${_EXCLUDE})
endfunction()
# Helper function to define available graphics modules for targets
function(define_graphic_modules target)
foreach(_GRAPHICS_API metal d3d11 opengl d3d9)
string(TOUPPER ${_GRAPHICS_API} _GRAPHICS_API_u)
if(TARGET OBS::libobs-${_GRAPHICS_API})
if(OS_POSIX AND NOT LINUX_PORTABLE)
target_compile_definitions(${target}
PRIVATE DL_${_GRAPHICS_API_u}="$<TARGET_SONAME_FILE_NAME:libobs-${_GRAPHICS_API}>")
else()
target_compile_definitions(${target}
PRIVATE DL_${_GRAPHICS_API_u}="$<TARGET_FILE_NAME:libobs-${_GRAPHICS_API}>")
endif()
add_dependencies(${target} OBS::libobs-${_GRAPHICS_API})
else()
target_compile_definitions(${target} PRIVATE DL_${_GRAPHICS_API_u}="")
endif()
endforeach()
endfunction()
macro(find_qt)
set(multiValueArgs COMPONENTS COMPONENTS_WIN COMPONENTS_MAC COMPONENTS_LINUX)
cmake_parse_arguments(FIND_QT "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
set(QT_NO_CREATE_VERSIONLESS_TARGETS ON)
find_package(
Qt6
COMPONENTS Core
REQUIRED)
set(QT_NO_CREATE_VERSIONLESS_TARGETS OFF)
if(OS_WINDOWS)
find_package(
Qt6
COMPONENTS ${FIND_QT_COMPONENTS} ${FIND_QT_COMPONENTS_WIN}
REQUIRED)
elseif(OS_MACOS)
find_package(
Qt6
COMPONENTS ${FIND_QT_COMPONENTS} ${FIND_QT_COMPONENTS_MAC}
REQUIRED)
else()
find_package(
Qt6
COMPONENTS ${FIND_QT_COMPONENTS} ${FIND_QT_COMPONENTS_LINUX}
REQUIRED)
endif()
list(APPEND FIND_QT_COMPONENTS "Core")
if("Gui" IN_LIST FIND_QT_COMPONENTS_LINUX)
list(APPEND FIND_QT_COMPONENTS_LINUX "GuiPrivate")
endif()
foreach(_COMPONENT IN LISTS FIND_QT_COMPONENTS FIND_QT_COMPONENTS_WIN FIND_QT_COMPONENTS_MAC FIND_QT_COMPONENTS_LINUX)
if(NOT TARGET Qt::${_COMPONENT} AND TARGET Qt6::${_COMPONENT})
add_library(Qt::${_COMPONENT} INTERFACE IMPORTED)
set_target_properties(Qt::${_COMPONENT} PROPERTIES INTERFACE_LINK_LIBRARIES "Qt6::${_COMPONENT}")
endif()
endforeach()
endmacro()
# Idea adapted from: https://github.com/edsiper/cmake-options
macro(set_option option value)
set(${option}
${value}
CACHE INTERNAL "")
endmacro()
function(obs_status status text)
set(_OBS_STATUS_DISABLED "OBS: DISABLED ")
set(_OBS_STATUS_ENABLED "OBS: ENABLED ")
set(_OBS_STATUS "OBS: ")
if(status STREQUAL "DISABLED")
message(STATUS "${_OBS_STATUS_DISABLED}${text}")
elseif(status STREQUAL "ENABLED")
message(STATUS "${_OBS_STATUS_ENABLED}${text}")
else()
message(${status} "${_OBS_STATUS}${text}")
endif()
endfunction()
if(OS_WINDOWS)
include(ObsHelpers_Windows)
elseif(OS_MACOS)
include(ObsHelpers_macOS)
elseif(OS_POSIX)
include(ObsHelpers_Linux)
endif()
# ######################################################################################################################
# LEGACY FALLBACKS #
# ######################################################################################################################
# Helper function to install OBS plugin with associated resource directory
function(_install_obs_plugin_with_data target source)
setup_plugin_target(${target})
if(NOT ${source} STREQUAL "data"
AND IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/${source}"
AND NOT OS_MACOS)
install(
DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${source}/
DESTINATION ${OBS_DATA_DESTINATION}/obs-plugins/${target}
USE_SOURCE_PERMISSIONS
COMPONENT ${target}_Runtime)
install(
DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${source}/
DESTINATION ${OBS_OUTPUT_DIR}/$<CONFIG>/${OBS_DATA_DESTINATION}/obs-plugins/${target}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL)
if(OS_WINDOWS AND DEFINED ENV{obsInstallerTempDir})
install(
DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${source}/
DESTINATION $ENV{obsInstallerTempDir}/${OBS_DATA_DESTINATION}/obs-plugins/${target}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL)
endif()
endif()
endfunction()
# Helper function to install OBS plugin
function(_install_obs_plugin target)
setup_plugin_target(${target})
endfunction()
# Helper function to install data for a target only
function(_install_obs_datatarget target destination)
install(
TARGETS ${target}
LIBRARY DESTINATION ${OBS_DATA_DESTINATION}/${destination}
COMPONENT ${target}_Runtime
NAMELINK_COMPONENT ${target}_Development
RUNTIME DESTINATION ${OBS_DATA_DESTINATION}/${destination} COMPONENT ${target}_Runtime)
install(
TARGETS ${target}
LIBRARY DESTINATION ${OBS_DATA_DESTINATION}/${destination}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL
RUNTIME DESTINATION ${OBS_DATA_DESTINATION}/${destination}
COMPONENT obs_${target}
EXCLUDE_FROM_ALL)
if(OS_WINDOWS)
if(MSVC)
add_target_resource(${target} "$<TARGET_PDB_FILE:${target}>" "${destination}" OPTIONAL)
endif()
if(DEFINED ENV{obsInstallerTempDir})
install(
TARGETS ${target}
RUNTIME
DESTINATION $ENV{obsInstallerTempDir}/${OBS_DATA_DESTINATION}/${destination}/$<TARGET_FILE_NAME:${target}>
COMPONENT obs_${target}
EXCLUDE_FROM_ALL
LIBRARY
DESTINATION $ENV{obsInstallerTempDir}/${OBS_DATA_DESTINATION}/${destination}/$<TARGET_FILE_NAME:${target}>
COMPONENT obs_${target}
EXCLUDE_FROM_ALL)
endif()
endif()
add_custom_command(
TARGET ${target}
POST_BUILD
COMMAND "${CMAKE_COMMAND}" -E env DESTDIR= "${CMAKE_COMMAND}" --install .. --config $<CONFIG> --prefix
${OBS_OUTPUT_DIR}/$<CONFIG> --component obs_${target} > "$<IF:$<PLATFORM_ID:Windows>,nul,/dev/null>"
COMMENT "Installing ${target} to OBS rundir"
VERBATIM)
endfunction()
# legacy_check: Macro to check for CMake framework version and include legacy list file
macro(legacy_check)
if(OBS_CMAKE_VERSION VERSION_LESS 3.0.0)
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/cmake/legacy.cmake)
include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/legacy.cmake)
endif()
return()
endif()
endmacro()
|
