ObsPluginHelpers.cmake 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  1. if(POLICY CMP0087)
  2. cmake_policy(SET CMP0087 NEW)
  3. endif()
  4. set(OBS_STANDALONE_PLUGIN_DIR "${CMAKE_SOURCE_DIR}/release")
  5. set(INCLUDED_LIBOBS_CMAKE_MODULES ON)
  6. include(GNUInstallDirs)
  7. if("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
  8. set(OS_MACOS ON)
  9. set(OS_POSIX ON)
  10. elseif("${CMAKE_SYSTEM_NAME}" MATCHES "Linux|FreeBSD|OpenBSD")
  11. set(OS_POSIX ON)
  12. string(TOUPPER "${CMAKE_SYSTEM_NAME}" _SYSTEM_NAME_U)
  13. set(OS_${_SYSTEM_NAME_U} ON)
  14. elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Windows")
  15. set(OS_WINDOWS ON)
  16. set(OS_POSIX OFF)
  17. endif()
  18. # Old-Style plugin detected, find "modern" libobs variant instead and set
  19. # global include directories to fix "bad" plugin behaviour
  20. if(DEFINED LIBOBS_INCLUDE_DIR AND NOT TARGET OBS::libobs)
  21. message(DEPRECATION "You are using an outdated method of adding 'libobs' to your project. Refer to the updated wiki on how to build and export 'libobs' and use it in your plugin projects.")
  22. find_package(libobs REQUIRED)
  23. if(TARGET OBS::libobs)
  24. set_target_properties(OBS::libobs PROPERTIES IMPORTED_GLOBAL TRUE)
  25. message(STATUS "OBS: Using modern libobs target")
  26. add_library(libobs ALIAS OBS::libobs)
  27. if(OS_WINDOWS)
  28. add_library(w32-pthreads ALIAS OBS::w32-pthreads)
  29. endif()
  30. endif()
  31. endif()
  32. if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND (OS_WINDOWS OR OS_MACOS))
  33. set(CMAKE_INSTALL_PREFIX "${OBS_STANDALONE_PLUGIN_DIR}" CACHE STRING "Directory to install OBS plugin after building" FORCE)
  34. endif()
  35. if(NOT CMAKE_BUILD_TYPE)
  36. set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING
  37. "OBS build type [Release, RelWithDebInfo, Debug, MinSizeRel]" FORCE)
  38. set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS Release RelWithDebInfo Debug MinSizeRel)
  39. endif()
  40. file(RELATIVE_PATH RELATIVE_INSTALL_PATH "${CMAKE_SOURCE_DIR}" "${CMAKE_INSTALL_PREFIX}")
  41. file(RELATIVE_PATH RELATIVE_BUILD_PATH "${CMAKE_SOURCE_DIR}" "${CMAKE_BINARY_DIR}")
  42. # Set-up OS-specific environment and helper functions
  43. if(OS_MACOS)
  44. if(NOT CMAKE_OSX_ARCHITECTURES)
  45. set(CMAKE_OSX_ARCHITECTURES "x86_64" CACHE STRING "OBS plugin build architecture for macOS - x86_64 required at least" FORCE)
  46. endif()
  47. if(NOT CMAKE_OSX_DEPLOYMENT_TARGET)
  48. set(CMAKE_OSX_DEPLOYMENT_TARGET "10.13" CACHE STRING "OBS plugin deployment target for macOS - 10.13+ required" FORCE)
  49. endif()
  50. if(NOT DEFINED OBS_CODESIGN_LINKER)
  51. set(OBS_CODESIGN_LINKER ON CACHE BOOL "Enable linker code-signing on macOS (v11+ required" FORCE)
  52. endif()
  53. if(NOT DEFINED OBS_BUNDLE_CODESIGN_IDENTITY)
  54. set(OBS_BUNDLE_CODESIGN_IDENTITY "-" CACHE STRING "Codesign identity for macOS" FORCE)
  55. endif()
  56. # Xcode configuration
  57. if(XCODE)
  58. # Tell Xcode to pretend the linker signed binaries so that
  59. # editing with install_name_tool preserves ad-hoc signatures.
  60. # See CMake Issue 21854.
  61. # This option is supported by codesign on macOS 11 or higher.
  62. set(CMAKE_XCODE_GENERATE_SCHEME ON)
  63. if(OBS_CODESIGN_LINKER)
  64. set(CMAKE_XCODE_ATTRIBUTE_OTHER_CODE_SIGN_FLAGS "-o linker-signed")
  65. endif()
  66. endif()
  67. # Set default options for bundling on macOS
  68. set(CMAKE_MACOSX_RPATH ON)
  69. set(CMAKE_SKIP_BUILD_RPATH OFF)
  70. set(CMAKE_BUILD_WITH_INSTALL_RPATH OFF)
  71. set(CMAKE_INSTALL_RPATH "@executable_path/../Frameworks/")
  72. set(CMAKE_INSTALL_RPATH_USE_LINK_PATH OFF)
  73. function(setup_plugin_target target)
  74. if(NOT DEFINED MACOSX_PLUGIN_GUI_IDENTIFIER)
  75. message(FATAL_ERROR "No 'MACOSX_PLUGIN_GUI_IDENTIFIER' set, but is required to build plugin bundles on macOS - example: 'com.yourname.pluginname'")
  76. endif()
  77. if(NOT DEFINED MACOSX_PLUGIN_BUNDLE_VERSION)
  78. message(FATAL_ERROR "No 'MACOSX_PLUGIN_BUNDLE_VERSION' set, but is required to build plugin bundles on macOS - example: '25'")
  79. endif()
  80. if(NOT DEFINED MACOSX_PLUGIN_SHORT_VERSION_STRING)
  81. message(FATAL_ERROR "No 'MACOSX_PLUGIN_SHORT_VERSION_STRING' set, but is required to build plugin bundles on macOS - example: '1.0.2'")
  82. endif()
  83. set(MACOSX_PLUGIN_BUNDLE_NAME "${target}" PARENT_SCOPE)
  84. set(MACOSX_PLUGIN_BUNDLE_VERSION "${MACOSX_BUNDLE_BUNDLE_VERSION}" PARENT_SCOPE)
  85. set(MACOSX_PLUGIN_SHORT_VERSION_STRING "${MACOSX_BUNDLE_SHORT_VERSION_STRING}" PARENT_SCOPE)
  86. set(MACOSX_PLUGIN_EXECUTABLE_NAME "${target}" PARENT_SCOPE)
  87. set(MACOSX_PLUGIN_BUNDLE_TYPE "BNDL" PARENT_SCOPE)
  88. install(TARGETS ${target}
  89. LIBRARY DESTINATION "."
  90. COMPONENT obs_plugins
  91. NAMELINK_COMPONENT ${target}_Development)
  92. install(CODE
  93. "execute_process(COMMAND /bin/sh -c \"install_name_tool \\
  94. -change ${CMAKE_PREFIX_PATH}/lib/QtWidgets.framework/Versions/5/QtWidgets @rpath/QtWidgets.framework/Versions/5/QtWidgets \\
  95. -change ${CMAKE_PREFIX_PATH}/lib/QtCore.framework/Versions/5/QtCore @rpath/QtCore.framework/Versions/5/QtCore \\
  96. -change ${CMAKE_PREFIX_PATH}/lib/QtGui.framework/Versions/5/QtGui @rpath/QtGui.framework/Versions/5/QtGui \\
  97. ${CMAKE_INSTALL_PREFIX}/${target}.plugin/Contents/MacOS/${target}\")")
  98. if(NOT XCODE)
  99. install(CODE
  100. "execute_process(COMMAND /bin/sh -c \"/usr/bin/codesign --force --sign \\\"${OBS_BUNDLE_CODESIGN_IDENTITY}\\\" --options runtime --entitlements ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/../bundle/macOS/entitlements.plist ${CMAKE_INSTALL_PREFIX}/${target}.plugin\")")
  101. endif()
  102. set_target_properties(${target} PROPERTIES
  103. BUNDLE ON
  104. BUNDLE_EXTENSION "plugin"
  105. OUTPUT_NAME ${target}
  106. MACOSX_BUNDLE_INFO_PLIST "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/../bundle/macOS/Plugin-Info.plist.in"
  107. XCODE_ATTRIBUTE_PRODUCT_BUNDLE_IDENTIFIER "${MACOSX_PLUGIN_GUI_IDENTIFIER}"
  108. XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "${OBS_BUNDLE_CODESIGN_IDENTITY}"
  109. XCODE_ATTRIBUTE_CODE_SIGN_ENTITLEMENTS "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/../bundle/macOS/entitlements.plist")
  110. add_custom_command(TARGET ${target} POST_BUILD
  111. COMMAND /bin/sh -c "codesign --force --sign \"-\" $<$<BOOL:${OBS_CODESIGN_LINKER}>:--options linker-signed >\"$<TARGET_BUNDLE_DIR:${target}>\""
  112. COMMENT "Codesigning ${target}"
  113. VERBATIM)
  114. install_bundle_resources(${target})
  115. endfunction()
  116. function(install_bundle_resources target)
  117. if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/data")
  118. file(GLOB_RECURSE _DATA_FILES "${CMAKE_CURRENT_SOURCE_DIR}/data/*")
  119. foreach(_DATA_FILE IN LISTS _DATA_FILES)
  120. file(RELATIVE_PATH _RELATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/data/ ${_DATA_FILE})
  121. get_filename_component(_RELATIVE_PATH "${_RELATIVE_PATH}" PATH)
  122. target_sources(${target}
  123. PRIVATE ${_DATA_FILE})
  124. set_source_files_properties(${_DATA_FILE} PROPERTIES
  125. MACOSX_PACKAGE_LOCATION "Resources/${_RELATIVE_PATH}")
  126. string(REPLACE "\\" "\\\\" _GROUP_NAME "${_RELATIVE_PATH}")
  127. source_group("Resources\\${_GROUP_NAME}" FILES ${_DATA_FILE})
  128. endforeach()
  129. endif()
  130. endfunction()
  131. else()
  132. if(CMAKE_SIZEOF_VOID_P EQUAL 8)
  133. set(_ARCH_SUFFIX 64)
  134. else()
  135. set(_ARCH_SUFFIX 32)
  136. endif()
  137. set(OBS_OUTPUT_DIR "${CMAKE_BINARY_DIR}/rundir")
  138. if(OS_POSIX)
  139. IF(NOT LINUX_PORTABLE)
  140. set(OBS_LIBRARY_DESTINATION "${CMAKE_INSTALL_LIBDIR}")
  141. set(OBS_PLUGIN_DESTINATION "${OBS_LIBRARY_DESTINATION}/obs-plugins")
  142. set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
  143. set(OBS_DATA_DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/obs")
  144. else()
  145. set(OBS_LIBRARY_DESTINATION "bin/${_ARCH_SUFFIX}bit")
  146. set(OBS_PLUGIN_DESTINATION "obs-plugins/${_ARCH_SUFFIX}bit")
  147. set(CMAKE_INSTALL_RPATH "$ORIGIN/" "${CMAKE_INSTALL_PREFIX}/${OBS_LIBRARY_DESTINATION}")
  148. set(OBS_DATA_DESTINATION "data")
  149. endif()
  150. if(OS_LINUX)
  151. set(CPACK_PACKAGE_NAME "${CMAKE_PROJECT_NAME}")
  152. set(CPACK_DEBIAN_PACKAGE_MAINTAINER "${LINUX_MAINTAINER_EMAIL}")
  153. set(CPACK_PACKAGE_VERSION "${CMAKE_PROJECT_VERSION}")
  154. set(CPACK_GENERATOR "DEB")
  155. set(CPACK_DEBIAN_PACKAGE_DEPENDS
  156. "obs-studio (>= 27.0.0), libqt5core5a (>= 5.9.0~beta), \
  157. libqt5gui5 (>= 5.3.0), libqt5widgets5 (>= 5.7.0)")
  158. if(NOT LINUX_PORTABLE)
  159. set(CPACK_SET_DESTDIR ON)
  160. endif()
  161. include(CPack)
  162. endif()
  163. else()
  164. set(OBS_LIBRARY_DESTINATION "bin/${_ARCH_SUFFIX}bit")
  165. set(OBS_LIBRARY32_DESTINATION "bin/32bit")
  166. set(OBS_LIBRARY64_DESTINATION "bin/64bit")
  167. set(OBS_PLUGIN_DESTINATION "obs-plugins/${_ARCH_SUFFIX}bit")
  168. set(OBS_PLUGIN32_DESTINATION "obs-plugins/32bit")
  169. set(OBS_PLUGIN64_DESTINATION "obs-plugins/64bit")
  170. set(OBS_DATA_DESTINATION "data")
  171. endif()
  172. function(setup_plugin_target target)
  173. set_target_properties(${target} PROPERTIES
  174. PREFIX "")
  175. install(TARGETS ${target}
  176. RUNTIME DESTINATION "${OBS_PLUGIN_DESTINATION}"
  177. COMPONENT ${target}_Runtime
  178. LIBRARY DESTINATION "${OBS_PLUGIN_DESTINATION}"
  179. COMPONENT ${target}_Runtime
  180. NAMELINK_COMPONENT ${target}_Development)
  181. add_custom_command(TARGET ${target} POST_BUILD
  182. COMMAND "${CMAKE_COMMAND}" -E copy
  183. "$<TARGET_FILE:${target}>"
  184. "${OBS_OUTPUT_DIR}/$<CONFIG>/${OBS_PLUGIN_DESTINATION}/$<TARGET_FILE_NAME:${target}>"
  185. VERBATIM)
  186. if(OS_WINDOWS)
  187. add_custom_command(TARGET ${target} POST_BUILD
  188. COMMAND "${CMAKE_COMMAND}" -E "$<IF:$<OR:$<CONFIG:Debug>,$<CONFIG:RelWithDebInfo>>,copy,true>"
  189. "$<TARGET_PDB_FILE:${target}>"
  190. "${OBS_OUTPUT_DIR}/$<CONFIG>/${OBS_PLUGIN_DESTINATION}/"
  191. VERBATIM)
  192. endif()
  193. if(MSVC)
  194. target_link_options(${target}
  195. PRIVATE
  196. "LINKER:/OPT:REF"
  197. "$<$<NOT:$<EQUAL:${CMAKE_SIZEOF_VOID_P},8>>:LINKER\:/SAFESEH\:NO>"
  198. "$<$<CONFIG:DEBUG>:LINKER\:/INCREMENTAL:NO>"
  199. "$<$<CONFIG:RELWITHDEBINFO>:LINKER\:/INCREMENTAL:NO>")
  200. endif()
  201. setup_target_resources("${target}" "obs-plugins/${target}")
  202. if(OS_WINDOWS AND DEFINED OBS_BUILD_DIR)
  203. setup_target_for_testing(${target})
  204. endif()
  205. endfunction()
  206. function(setup_target_resources target destination)
  207. if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/data")
  208. install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/data/"
  209. DESTINATION "${OBS_DATA_DESTINATION}/${destination}"
  210. USE_SOURCE_PERMISSIONS)
  211. add_custom_command(TARGET ${target} POST_BUILD
  212. COMMAND "${CMAKE_COMMAND}" -E copy_directory
  213. "${CMAKE_CURRENT_SOURCE_DIR}/data"
  214. "${OBS_OUTPUT_DIR}/$<CONFIG>/${OBS_DATA_DESTINATION}/${destination}"
  215. VERBATIM)
  216. endif()
  217. endfunction()
  218. if(OS_WINDOWS)
  219. function(setup_target_for_testing target)
  220. add_custom_command(TARGET ${target} POST_BUILD
  221. COMMAND "${CMAKE_COMMAND}" -E copy
  222. "$<TARGET_FILE:${target}>"
  223. "${OBS_BUILD_DIR}/rundir/$<CONFIG>/${OBS_PLUGIN_DESTINATION}/$<TARGET_FILE_NAME:${target}>"
  224. COMMAND "${CMAKE_COMMAND}" -E "$<IF:$<OR:$<CONFIG:Debug>,$<CONFIG:RelWithDebInfo>>,copy,true>"
  225. "$<TARGET_PDB_FILE:${target}>"
  226. "${OBS_BUILD_DIR}/rundir/$<CONFIG>/${OBS_PLUGIN_DESTINATION}/$<TARGET_FILE_NAME:${target}>"
  227. COMMAND "${CMAKE_COMMAND}" -E make_directory
  228. "${OBS_BUILD_DIR}/rundir/$<CONFIG>/${OBS_DATA_DESTINATION}/obs-plugins/${target}"
  229. COMMAND "${CMAKE_COMMAND}" -E copy_directory
  230. "${CMAKE_CURRENT_SOURCE_DIR}/data"
  231. "${OBS_BUILD_DIR}/rundir/$<CONFIG>/${OBS_DATA_DESTINATION}/obs-plugins/${target}"
  232. VERBATIM)
  233. endfunction()
  234. endif()
  235. endif()