CMakeLists.txt 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757
  1. # SPDX-FileCopyrightText: 2018 yuzu Emulator Project
  2. # SPDX-FileCopyrightText: 2024 suyu Emulator Project
  3. # SPDX-License-Identifier: GPL-2.0-or-later
  4. cmake_minimum_required(VERSION 3.22)
  5. set(CMAKE_XCODE_GENERATE_TOP_LEVEL_PROJECT OFF)
  6. set(CMAKE_XCODE_EMIT_RELATIVE_PATH YES)
  7. project(suyu)
  8. list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules")
  9. list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/externals/cmake-modules")
  10. include(DownloadExternals)
  11. include(CMakeDependentOption)
  12. include(CTest)
  13. # Set bundled sdl2/qt as dependent options.
  14. # OFF by default, but if ENABLE_SDL2 and MSVC are true then ON
  15. option(ENABLE_SDL2 "Enable the SDL2 frontend" ON)
  16. CMAKE_DEPENDENT_OPTION(SUYU_USE_BUNDLED_SDL2 "Download bundled SDL2 binaries" ON "ENABLE_SDL2;MSVC" OFF)
  17. # On Linux system SDL2 is likely to be lacking HIDAPI support which have drawbacks but is needed for SDL motion
  18. CMAKE_DEPENDENT_OPTION(SUYU_USE_EXTERNAL_SDL2 "Compile external SDL2" ON "ENABLE_SDL2;NOT MSVC" OFF)
  19. cmake_dependent_option(ENABLE_LIBUSB "Enable the use of LibUSB" ON "NOT ANDROID" OFF)
  20. option(ENABLE_OPENGL "Enable OpenGL" ON)
  21. mark_as_advanced(FORCE ENABLE_OPENGL)
  22. option(ENABLE_QT "Enable the Qt frontend" ON)
  23. option(ENABLE_QT6 "Allow usage of Qt6 to be attempted" OFF)
  24. set(QT6_LOCATION "" CACHE PATH "Additional Location to search for Qt6 libraries like C:/Qt/6.3.1/msvc2019_64/")
  25. option(ENABLE_QT_TRANSLATION "Enable translations for the Qt frontend" OFF)
  26. CMAKE_DEPENDENT_OPTION(SUYU_USE_BUNDLED_QT "Download bundled Qt binaries" "${MSVC}" "ENABLE_QT" OFF)
  27. option(ENABLE_WEB_SERVICE "Enable web services (telemetry, etc.)" ON)
  28. option(SUYU_USE_BUNDLED_FFMPEG "Download/Build bundled FFmpeg" "${WIN32}")
  29. option(SUYU_USE_EXTERNAL_VULKAN_HEADERS "Use Vulkan-Headers from externals" ON)
  30. option(SUYU_USE_EXTERNAL_VULKAN_UTILITY_LIBRARIES "Use Vulkan-Utility-Libraries from externals" ON)
  31. option(SUYU_USE_QT_MULTIMEDIA "Use QtMultimedia for Camera" OFF)
  32. option(SUYU_USE_QT_WEB_ENGINE "Use QtWebEngine for web applet implementation" OFF)
  33. option(ENABLE_CUBEB "Enables the cubeb audio backend" ON)
  34. option(USE_DISCORD_PRESENCE "Enables Discord Rich Presence" OFF)
  35. option(SUYU_TESTS "Compile tests" "${BUILD_TESTING}")
  36. option(SUYU_USE_PRECOMPILED_HEADERS "Use precompiled headers" ON)
  37. option(SUYU_DOWNLOAD_ANDROID_VVL "Download validation layer binary for android" ON)
  38. CMAKE_DEPENDENT_OPTION(SUYU_ROOM "Compile LDN room server" ON "NOT ANDROID" OFF)
  39. CMAKE_DEPENDENT_OPTION(SUYU_CRASH_DUMPS "Compile crash dump (Minidump) support" OFF "WIN32 OR LINUX" OFF)
  40. option(SUYU_USE_BUNDLED_VCPKG "Use vcpkg for suyu dependencies" "${MSVC}")
  41. option(SUYU_CHECK_SUBMODULES "Check if submodules are present" ON)
  42. option(SUYU_ENABLE_LTO "Enable link-time optimization" OFF)
  43. option(SUYU_DOWNLOAD_TIME_ZONE_DATA "Always download time zone binaries" OFF)
  44. option(SUYU_ENABLE_PORTABLE "Allow suyu to enable portable mode if a user folder is found in the CWD" ON)
  45. CMAKE_DEPENDENT_OPTION(SUYU_USE_FASTER_LD "Check if a faster linker is available" ON "NOT WIN32" OFF)
  46. CMAKE_DEPENDENT_OPTION(USE_SYSTEM_MOLTENVK "Use the system MoltenVK lib (instead of the bundled one)" OFF "APPLE" OFF)
  47. option(USE_CCACHE "Use CCache for faster building" ON)
  48. set(DEFAULT_ENABLE_OPENSSL ON)
  49. if (ANDROID OR WIN32 OR APPLE)
  50. # - Windows defaults to the Schannel backend.
  51. # - macOS defaults to the SecureTransport backend.
  52. # - Android currently has no SSL backend as the NDK doesn't include any SSL
  53. # library; a proper 'native' backend would have to go through Java.
  54. # But you can force builds for those platforms to use OpenSSL if you have
  55. # your own copy of it.
  56. set(DEFAULT_ENABLE_OPENSSL OFF)
  57. endif()
  58. option(ENABLE_OPENSSL "Enable OpenSSL backend for ISslConnection" ${DEFAULT_ENABLE_OPENSSL})
  59. if (ANDROID AND SUYU_DOWNLOAD_ANDROID_VVL)
  60. set(vvl_version "sdk-1.3.261.1")
  61. set(vvl_zip_file "${CMAKE_BINARY_DIR}/externals/vvl-android.zip")
  62. if (NOT EXISTS "${vvl_zip_file}")
  63. # Download and extract validation layer release to externals directory
  64. set(vvl_base_url "https://github.com/KhronosGroup/Vulkan-ValidationLayers/releases/download")
  65. file(DOWNLOAD "${vvl_base_url}/${vvl_version}/android-binaries-${vvl_version}-android.zip"
  66. "${vvl_zip_file}" SHOW_PROGRESS)
  67. execute_process(COMMAND ${CMAKE_COMMAND} -E tar xf "${vvl_zip_file}"
  68. WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/externals")
  69. endif()
  70. # Copy the arm64 binary to src/android/app/main/jniLibs
  71. set(vvl_lib_path "${CMAKE_CURRENT_SOURCE_DIR}/src/android/app/src/main/jniLibs/arm64-v8a/")
  72. file(COPY "${CMAKE_BINARY_DIR}/externals/android-binaries-${vvl_version}/arm64-v8a/libVkLayer_khronos_validation.so"
  73. DESTINATION "${vvl_lib_path}")
  74. endif()
  75. if (ANDROID)
  76. set(CMAKE_SKIP_INSTALL_RULES ON)
  77. endif()
  78. if (SUYU_USE_BUNDLED_VCPKG)
  79. if (ANDROID)
  80. set(ENV{ANDROID_NDK_HOME} "${ANDROID_NDK}")
  81. list(APPEND VCPKG_MANIFEST_FEATURES "android")
  82. if (CMAKE_ANDROID_ARCH_ABI STREQUAL "arm64-v8a")
  83. set(VCPKG_TARGET_TRIPLET "arm64-android")
  84. # this is to avoid CMake using the host pkg-config to find the host
  85. # libraries when building for Android targets
  86. set(PKG_CONFIG_EXECUTABLE "aarch64-none-linux-android-pkg-config" CACHE FILEPATH "" FORCE)
  87. elseif (CMAKE_ANDROID_ARCH_ABI STREQUAL "x86_64")
  88. set(VCPKG_TARGET_TRIPLET "x64-android")
  89. set(PKG_CONFIG_EXECUTABLE "x86_64-none-linux-android-pkg-config" CACHE FILEPATH "" FORCE)
  90. else()
  91. message(FATAL_ERROR "Unsupported Android architecture ${CMAKE_ANDROID_ARCH_ABI}")
  92. endif()
  93. endif()
  94. if (MSVC)
  95. set(VCPKG_DOWNLOADS_PATH ${PROJECT_SOURCE_DIR}/externals/vcpkg/downloads)
  96. set(NASM_VERSION "2.16.01")
  97. set(NASM_DESTINATION_PATH ${VCPKG_DOWNLOADS_PATH}/nasm-${NASM_VERSION}-win64.zip)
  98. set(NASM_DOWNLOAD_URL "https://git.suyu.dev/suyu/ext-windows-bin/raw/branch/master/nasm/nasm-${NASM_VERSION}-win64.zip")
  99. if (NOT EXISTS ${NASM_DESTINATION_PATH})
  100. file(DOWNLOAD ${NASM_DOWNLOAD_URL} ${NASM_DESTINATION_PATH} SHOW_PROGRESS STATUS NASM_STATUS)
  101. if (NOT NASM_STATUS EQUAL 0)
  102. # Warn and not fail since vcpkg is supposed to download this package for us in the first place
  103. message(WARNING "External nasm vcpkg package download from ${NASM_DOWNLOAD_URL} failed with status ${NASM_STATUS}")
  104. endif()
  105. endif()
  106. endif()
  107. if (SUYU_TESTS)
  108. list(APPEND VCPKG_MANIFEST_FEATURES "suyu-tests")
  109. endif()
  110. if (ENABLE_WEB_SERVICE)
  111. list(APPEND VCPKG_MANIFEST_FEATURES "web-service")
  112. endif()
  113. if (ANDROID)
  114. list(APPEND VCPKG_MANIFEST_FEATURES "android")
  115. endif()
  116. include(${CMAKE_SOURCE_DIR}/externals/vcpkg/scripts/buildsystems/vcpkg.cmake)
  117. elseif(NOT "$ENV{VCPKG_TOOLCHAIN_FILE}" STREQUAL "")
  118. # Disable manifest mode (use vcpkg classic mode) when using a custom vcpkg installation
  119. option(VCPKG_MANIFEST_MODE "")
  120. include("$ENV{VCPKG_TOOLCHAIN_FILE}")
  121. endif()
  122. if (SUYU_USE_PRECOMPILED_HEADERS)
  123. if (MSVC AND CCACHE)
  124. # buildcache does not properly cache PCH files, leading to compilation errors.
  125. # See https://github.com/mbitsnbites/buildcache/discussions/230
  126. message(WARNING "buildcache does not properly support Precompiled Headers. Disabling PCH")
  127. set(DYNARMIC_USE_PRECOMPILED_HEADERS OFF CACHE BOOL "" FORCE)
  128. set(SUYU_USE_PRECOMPILED_HEADERS OFF CACHE BOOL "" FORCE)
  129. endif()
  130. endif()
  131. if (SUYU_USE_PRECOMPILED_HEADERS)
  132. message(STATUS "Using Precompiled Headers.")
  133. set(CMAKE_PCH_INSTANTIATE_TEMPLATES ON)
  134. endif()
  135. # Default to a Release build
  136. get_property(IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
  137. if (NOT IS_MULTI_CONFIG AND NOT CMAKE_BUILD_TYPE)
  138. set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: Debug Release RelWithDebInfo MinSizeRel." FORCE)
  139. message(STATUS "Defaulting to a Release build")
  140. endif()
  141. if(EXISTS ${PROJECT_SOURCE_DIR}/hooks/pre-commit AND NOT EXISTS ${PROJECT_SOURCE_DIR}/.git/hooks/pre-commit)
  142. if (EXISTS ${PROJECT_SOURCE_DIR}/.git/)
  143. message(STATUS "Copying pre-commit hook")
  144. file(COPY hooks/pre-commit DESTINATION ${PROJECT_SOURCE_DIR}/.git/hooks)
  145. endif()
  146. endif()
  147. # Sanity check : Check that all submodules are present
  148. # =======================================================================
  149. function(check_submodules_present)
  150. file(READ "${PROJECT_SOURCE_DIR}/.gitmodules" gitmodules)
  151. string(REGEX MATCHALL "path *= *[^ \t\r\n]*" gitmodules ${gitmodules})
  152. foreach(module ${gitmodules})
  153. string(REGEX REPLACE "path *= *" "" module ${module})
  154. if (NOT EXISTS "${PROJECT_SOURCE_DIR}/${module}/.git")
  155. message(FATAL_ERROR "Git submodule ${module} not found. "
  156. "Please run: \ngit submodule update --init --recursive")
  157. endif()
  158. endforeach()
  159. endfunction()
  160. if(EXISTS ${PROJECT_SOURCE_DIR}/.gitmodules AND SUYU_CHECK_SUBMODULES)
  161. check_submodules_present()
  162. endif()
  163. configure_file(${PROJECT_SOURCE_DIR}/dist/compatibility_list/compatibility_list.qrc
  164. ${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.qrc
  165. COPYONLY)
  166. if (EXISTS ${PROJECT_SOURCE_DIR}/dist/compatibility_list/compatibility_list.json)
  167. configure_file("${PROJECT_SOURCE_DIR}/dist/compatibility_list/compatibility_list.json"
  168. "${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.json"
  169. COPYONLY)
  170. endif()
  171. if (ENABLE_COMPATIBILITY_LIST_DOWNLOAD AND NOT EXISTS ${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.json)
  172. message(STATUS "Downloading compatibility list for suyu...")
  173. file(DOWNLOAD
  174. https://api.suyu.dev/gamedb/
  175. "${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.json" SHOW_PROGRESS)
  176. endif()
  177. if (NOT EXISTS ${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.json)
  178. file(WRITE ${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.json "")
  179. endif()
  180. # Detect current compilation architecture and create standard definitions
  181. # =======================================================================
  182. include(CheckSymbolExists)
  183. function(detect_architecture symbol arch)
  184. if (NOT DEFINED ARCHITECTURE)
  185. set(CMAKE_REQUIRED_QUIET 1)
  186. check_symbol_exists("${symbol}" "" ARCHITECTURE_${arch})
  187. unset(CMAKE_REQUIRED_QUIET)
  188. # The output variable needs to be unique across invocations otherwise
  189. # CMake's crazy scope rules will keep it defined
  190. if (ARCHITECTURE_${arch})
  191. set(ARCHITECTURE "${arch}" PARENT_SCOPE)
  192. set(ARCHITECTURE_${arch} 1 PARENT_SCOPE)
  193. add_definitions(-DARCHITECTURE_${arch}=1)
  194. endif()
  195. endif()
  196. endfunction()
  197. if (NOT ENABLE_GENERIC)
  198. if (MSVC)
  199. detect_architecture("_M_AMD64" x86_64)
  200. detect_architecture("_M_IX86" x86)
  201. detect_architecture("_M_ARM" arm)
  202. detect_architecture("_M_ARM64" arm64)
  203. else()
  204. detect_architecture("__x86_64__" x86_64)
  205. detect_architecture("__i386__" x86)
  206. detect_architecture("__arm__" arm)
  207. detect_architecture("__aarch64__" arm64)
  208. endif()
  209. endif()
  210. if (NOT DEFINED ARCHITECTURE)
  211. set(ARCHITECTURE "GENERIC")
  212. set(ARCHITECTURE_GENERIC 1)
  213. add_definitions(-DARCHITECTURE_GENERIC=1)
  214. endif()
  215. message(STATUS "Target architecture: ${ARCHITECTURE}")
  216. if (UNIX)
  217. add_definitions(-DSUYU_UNIX=1)
  218. endif()
  219. if (ARCHITECTURE_arm64 AND (ANDROID OR ${CMAKE_SYSTEM_NAME} STREQUAL "Linux"))
  220. set(HAS_NCE 1)
  221. add_definitions(-DHAS_NCE=1)
  222. endif()
  223. # Configure C++ standard
  224. # ===========================
  225. # boost asio's concept usage doesn't play nicely with some compilers yet.
  226. add_definitions(-DBOOST_ASIO_DISABLE_CONCEPTS)
  227. if (MSVC)
  228. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/std:c++20>)
  229. # boost still makes use of deprecated result_of.
  230. add_definitions(-D_HAS_DEPRECATED_RESULT_OF)
  231. else()
  232. set(CMAKE_CXX_STANDARD 20)
  233. set(CMAKE_CXX_STANDARD_REQUIRED ON)
  234. endif()
  235. # Output binaries to bin/
  236. set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin)
  237. # System imported libraries
  238. # =======================================================================
  239. # Enforce the search mode of non-required packages for better and shorter failure messages
  240. find_package(Boost 1.79.0 REQUIRED context)
  241. find_package(enet 1.3 MODULE)
  242. find_package(fmt 9 REQUIRED)
  243. find_package(LLVM 17.0.2 MODULE COMPONENTS Demangle)
  244. find_package(lz4 REQUIRED)
  245. find_package(nlohmann_json 3.8 REQUIRED)
  246. find_package(Opus 1.3 MODULE)
  247. find_package(RenderDoc MODULE)
  248. find_package(SimpleIni MODULE)
  249. find_package(stb MODULE)
  250. find_package(VulkanMemoryAllocator CONFIG)
  251. find_package(ZLIB 1.2 REQUIRED)
  252. find_package(zstd 1.5 REQUIRED)
  253. if (NOT SUYU_USE_EXTERNAL_VULKAN_HEADERS)
  254. find_package(VulkanHeaders 1.3.274 REQUIRED)
  255. endif()
  256. if (NOT SUYU_USE_EXTERNAL_VULKAN_UTILITY_LIBRARIES)
  257. find_package(VulkanUtilityLibraries REQUIRED)
  258. endif()
  259. if (ENABLE_LIBUSB)
  260. find_package(libusb 1.0.24 MODULE)
  261. endif()
  262. if (ARCHITECTURE_x86 OR ARCHITECTURE_x86_64)
  263. find_package(xbyak 7 CONFIG)
  264. endif()
  265. if (ARCHITECTURE_arm64)
  266. find_package(oaknut 2.0.1 CONFIG)
  267. endif()
  268. if (ARCHITECTURE_x86_64 OR ARCHITECTURE_arm64)
  269. find_package(dynarmic 6.4.0 CONFIG)
  270. endif()
  271. if (ENABLE_CUBEB)
  272. find_package(cubeb CONFIG)
  273. endif()
  274. if (USE_DISCORD_PRESENCE)
  275. find_package(DiscordRPC MODULE)
  276. endif()
  277. if (ENABLE_WEB_SERVICE)
  278. find_package(cpp-jwt 1.4 CONFIG)
  279. endif()
  280. if (ENABLE_WEB_SERVICE OR USE_DISCORD_PRESENCE)
  281. find_package(httplib 0.12 MODULE COMPONENTS OpenSSL)
  282. endif()
  283. if (SUYU_TESTS)
  284. find_package(Catch2 3.0.1 REQUIRED)
  285. endif()
  286. # boost:asio has functions that require AcceptEx et al
  287. if (MINGW)
  288. find_library(MSWSOCK_LIBRARY mswsock REQUIRED)
  289. endif()
  290. if(ENABLE_OPENSSL)
  291. find_package(OpenSSL 1.1.1 REQUIRED)
  292. endif()
  293. if (UNIX AND NOT APPLE)
  294. find_package(gamemode 1.7 MODULE)
  295. endif()
  296. # Please consider this as a stub
  297. if(ENABLE_QT6 AND Qt6_LOCATION)
  298. list(APPEND CMAKE_PREFIX_PATH "${Qt6_LOCATION}")
  299. endif()
  300. # QT6 searches for Vulkan::Headers, too, so we have to define it before QT6 has a chance to do it.
  301. add_subdirectory(externals)
  302. function(set_suyu_qt_components)
  303. # Best practice is to ask for all components at once, so they are from the same version
  304. set(SUYU_QT_COMPONENTS2 Core Widgets Concurrent)
  305. if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
  306. list(APPEND SUYU_QT_COMPONENTS2 DBus)
  307. endif()
  308. if (SUYU_USE_QT_MULTIMEDIA)
  309. list(APPEND SUYU_QT_COMPONENTS2 Multimedia)
  310. endif()
  311. if (SUYU_USE_QT_WEB_ENGINE)
  312. list(APPEND SUYU_QT_COMPONENTS2 WebEngineCore WebEngineWidgets)
  313. endif()
  314. if (ENABLE_QT_TRANSLATION)
  315. list(APPEND SUYU_QT_COMPONENTS2 LinguistTools)
  316. endif()
  317. if (USE_DISCORD_PRESENCE)
  318. list(APPEND SUYU_QT_COMPONENTS2 Network)
  319. endif()
  320. set(SUYU_QT_COMPONENTS ${SUYU_QT_COMPONENTS2} PARENT_SCOPE)
  321. endfunction(set_suyu_qt_components)
  322. # Qt5 requires that we find components, so it doesn't fit our pretty little find package function
  323. if(ENABLE_QT)
  324. set(QT_VERSION 5.15)
  325. # These are used to specify minimum versions
  326. set(QT5_VERSION 5.15)
  327. set(QT6_VERSION 6.3.1)
  328. set_suyu_qt_components()
  329. if (ENABLE_QT6)
  330. find_package(Qt6 ${QT6_VERSION} COMPONENTS ${SUYU_QT_COMPONENTS})
  331. endif()
  332. if (Qt6_FOUND)
  333. message(STATUS "suyu/CMakeLists.txt: Qt6Widgets_VERSION ${Qt6Widgets_VERSION}, setting QT_VERSION")
  334. set(QT_VERSION ${Qt6Widgets_VERSION})
  335. set(QT_MAJOR_VERSION 6)
  336. # Qt6 sets cxx_std_17 and we need to undo that
  337. set_target_properties(Qt6::Platform PROPERTIES INTERFACE_COMPILE_FEATURES "")
  338. else()
  339. message(STATUS "suyu/CMakeLists.txt: Qt6 not found/not selected, trying for Qt5")
  340. # When Qt6 partially found, need this set to use Qt5 when not specifying version
  341. set(QT_DEFAULT_MAJOR_VERSION 5)
  342. set(QT_MAJOR_VERSION 5)
  343. set(SUYU_USE_QT_MULTIMEDIA ON)
  344. # Check for system Qt on Linux, fallback to bundled Qt
  345. if (UNIX AND NOT APPLE)
  346. if (NOT SUYU_USE_BUNDLED_QT)
  347. find_package(Qt5 ${QT5_VERSION} COMPONENTS Widgets DBus Multimedia)
  348. endif()
  349. if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux" AND (NOT Qt5_FOUND OR SUYU_USE_BUNDLED_QT))
  350. # Check for dependencies, then enable bundled Qt download
  351. # Check that the system GLIBCXX version is compatible
  352. find_program(OBJDUMP objdump)
  353. if (NOT OBJDUMP)
  354. message(FATAL_ERROR "Required program `objdump` not found.")
  355. endif()
  356. find_library(LIBSTDCXX libstdc++.so.6)
  357. execute_process(
  358. COMMAND
  359. ${OBJDUMP} -T ${LIBSTDCXX}
  360. COMMAND
  361. grep GLIBCXX_3.4.28
  362. COMMAND
  363. sed "s/[0-9a-f]*.* //"
  364. COMMAND
  365. sed "s/ .*//"
  366. COMMAND
  367. sort -u
  368. OUTPUT_VARIABLE
  369. GLIBCXX_MET
  370. )
  371. if (NOT GLIBCXX_MET)
  372. message(FATAL_ERROR "Qt too old or not found, and bundled Qt package is not \
  373. compatible with this system. Either install Qt ${QT_VERSION}, or provide the path \
  374. to Qt by setting the variable Qt5_ROOT.")
  375. endif()
  376. # Check for headers
  377. find_package(PkgConfig REQUIRED)
  378. pkg_check_modules(QT_DEP_GLU QUIET glu>=9.0.0)
  379. if (NOT QT_DEP_GLU_FOUND)
  380. message(FATAL_ERROR "Qt bundled package dependency `glu` not found. \
  381. Perhaps `libglu1-mesa-dev` needs to be installed?")
  382. endif()
  383. pkg_check_modules(QT_DEP_MESA QUIET dri>=20.0.8)
  384. if (NOT QT_DEP_MESA_FOUND)
  385. message(FATAL_ERROR "Qt bundled package dependency `dri` not found. \
  386. Perhaps `mesa-common-dev` needs to be installed?")
  387. endif()
  388. # Check for X libraries
  389. set(BUNDLED_QT_REQUIREMENTS
  390. libxcb-icccm.so.4
  391. libxcb-image.so.0
  392. libxcb-keysyms.so.1
  393. libxcb-randr.so.0
  394. libxcb-render-util.so.0
  395. libxcb-render.so.0
  396. libxcb-shape.so.0
  397. libxcb-shm.so.0
  398. libxcb-sync.so.1
  399. libxcb-xfixes.so.0
  400. libxcb-xinerama.so.0
  401. libxcb-xkb.so.1
  402. libxcb.so.1
  403. libxkbcommon-x11.so.0
  404. libxkbcommon.so.0
  405. )
  406. set(UNRESOLVED_QT_DEPS "")
  407. foreach (REQUIREMENT ${BUNDLED_QT_REQUIREMENTS})
  408. find_library(BUNDLED_QT_${REQUIREMENT} ${REQUIREMENT})
  409. if (NOT BUNDLED_QT_${REQUIREMENT})
  410. set(UNRESOLVED_QT_DEPS ${UNRESOLVED_QT_DEPS} ${REQUIREMENT})
  411. endif()
  412. unset(BUNDLED_QT_${REQUIREMENT})
  413. endforeach()
  414. unset(BUNDLED_QT_REQUIREMENTS)
  415. if (NOT "${UNRESOLVED_QT_DEPS}" STREQUAL "")
  416. message(FATAL_ERROR "Bundled Qt package missing required dependencies: ${UNRESOLVED_QT_DEPS}")
  417. endif()
  418. set(SUYU_USE_BUNDLED_QT ON CACHE BOOL "Download bundled Qt" FORCE)
  419. endif()
  420. if (SUYU_USE_BUNDLED_QT)
  421. # Binary package currently does not support Qt webengine, so make sure it's disabled
  422. set(SUYU_USE_QT_WEB_ENGINE OFF CACHE BOOL "Use Qt Webengine" FORCE)
  423. endif()
  424. endif()
  425. set(SUYU_QT_NO_CMAKE_SYSTEM_PATH)
  426. if(SUYU_USE_BUNDLED_QT)
  427. if ((MSVC_VERSION GREATER_EQUAL 1920 AND MSVC_VERSION LESS 1940) AND ARCHITECTURE_x86_64)
  428. set(QT_BUILD qt-5.15.2-msvc2019_64)
  429. elseif ((${CMAKE_SYSTEM_NAME} STREQUAL "Linux") AND NOT MINGW AND ARCHITECTURE_x86_64)
  430. set(QT_BUILD qt5_5_15_2)
  431. else()
  432. message(FATAL_ERROR "No bundled Qt binaries for your toolchain. Disable SUYU_USE_BUNDLED_QT and provide your own.")
  433. endif()
  434. if (DEFINED QT_BUILD)
  435. download_bundled_external("qt/" ${QT_BUILD} QT_PREFIX)
  436. endif()
  437. set(QT_PREFIX_HINT HINTS "${QT_PREFIX}")
  438. set(SUYU_QT_NO_CMAKE_SYSTEM_PATH "NO_CMAKE_SYSTEM_PATH")
  439. # Binary package for Qt5 has Qt Multimedia
  440. set(SUYU_USE_QT_MULTIMEDIA ON CACHE BOOL "Use Qt Multimedia" FORCE)
  441. endif()
  442. set_suyu_qt_components()
  443. find_package(Qt5 ${QT5_VERSION} COMPONENTS ${SUYU_QT_COMPONENTS} ${QT_PREFIX_HINT} ${SUYU_QT_NO_CMAKE_SYSTEM_PATH})
  444. endif()
  445. endif()
  446. # find SDL2 exports a bunch of variables that are needed, so its easier to do this outside of the suyu_find_package
  447. if (ENABLE_SDL2)
  448. if (SUYU_USE_BUNDLED_SDL2)
  449. # Detect toolchain and platform
  450. if ((MSVC_VERSION GREATER_EQUAL 1920 AND MSVC_VERSION LESS 1940) AND ARCHITECTURE_x86_64)
  451. set(SDL2_VER "SDL2-2.28.2")
  452. else()
  453. message(FATAL_ERROR "No bundled SDL2 binaries for your toolchain. Disable SUYU_USE_BUNDLED_SDL2 and provide your own.")
  454. endif()
  455. if (DEFINED SDL2_VER)
  456. download_bundled_external("sdl2/" ${SDL2_VER} SDL2_PREFIX)
  457. endif()
  458. set(SDL2_FOUND YES)
  459. set(SDL2_INCLUDE_DIR "${SDL2_PREFIX}/include" CACHE PATH "Path to SDL2 headers")
  460. set(SDL2_LIBRARY "${SDL2_PREFIX}/lib/x64/SDL2.lib" CACHE PATH "Path to SDL2 library")
  461. set(SDL2_DLL_DIR "${SDL2_PREFIX}/lib/x64/" CACHE PATH "Path to SDL2.dll")
  462. add_library(SDL2::SDL2 INTERFACE IMPORTED)
  463. target_link_libraries(SDL2::SDL2 INTERFACE "${SDL2_LIBRARY}")
  464. target_include_directories(SDL2::SDL2 INTERFACE "${SDL2_INCLUDE_DIR}")
  465. elseif (SUYU_USE_EXTERNAL_SDL2)
  466. message(STATUS "Using SDL2 from externals.")
  467. else()
  468. find_package(SDL2 2.26.4 REQUIRED)
  469. endif()
  470. endif()
  471. # List of all FFmpeg components required
  472. set(FFmpeg_COMPONENTS
  473. avcodec
  474. avfilter
  475. avutil
  476. swscale)
  477. if (UNIX AND NOT APPLE AND NOT ANDROID)
  478. find_package(PkgConfig REQUIRED)
  479. pkg_check_modules(LIBVA libva)
  480. endif()
  481. if (NOT SUYU_USE_BUNDLED_FFMPEG)
  482. # Use system installed FFmpeg
  483. find_package(FFmpeg 4.3 REQUIRED QUIET COMPONENTS ${FFmpeg_COMPONENTS})
  484. endif()
  485. if (WIN32 AND SUYU_CRASH_DUMPS)
  486. set(BREAKPAD_VER "breakpad-c89f9dd")
  487. download_bundled_external("breakpad/" ${BREAKPAD_VER} BREAKPAD_PREFIX)
  488. set(BREAKPAD_CLIENT_INCLUDE_DIR "${BREAKPAD_PREFIX}/include")
  489. set(BREAKPAD_CLIENT_LIBRARY "${BREAKPAD_PREFIX}/lib/libbreakpad_client.lib")
  490. add_library(libbreakpad_client INTERFACE IMPORTED)
  491. target_link_libraries(libbreakpad_client INTERFACE "${BREAKPAD_CLIENT_LIBRARY}")
  492. target_include_directories(libbreakpad_client INTERFACE "${BREAKPAD_CLIENT_INCLUDE_DIR}")
  493. endif()
  494. # Prefer the -pthread flag on Linux.
  495. set(THREADS_PREFER_PTHREAD_FLAG ON)
  496. find_package(Threads REQUIRED)
  497. # Platform-specific library requirements
  498. # ======================================
  499. if (APPLE)
  500. # Umbrella framework for everything GUI-related
  501. find_library(COCOA_LIBRARY Cocoa)
  502. set(PLATFORM_LIBRARIES ${COCOA_LIBRARY} ${IOKIT_LIBRARY} ${COREVIDEO_LIBRARY})
  503. elseif (WIN32)
  504. # Target Windows 10
  505. add_definitions(-D_WIN32_WINNT=0x0A00 -DWINVER=0x0A00)
  506. set(PLATFORM_LIBRARIES winmm ws2_32 iphlpapi)
  507. if (MINGW)
  508. # PSAPI is the Process Status API
  509. set(PLATFORM_LIBRARIES ${PLATFORM_LIBRARIES} psapi imm32 version)
  510. endif()
  511. elseif (CMAKE_SYSTEM_NAME MATCHES "^(Linux|kFreeBSD|GNU|SunOS)$")
  512. set(PLATFORM_LIBRARIES rt)
  513. endif()
  514. # Setup a custom clang-format target (if clang-format can be found) that will run
  515. # against all the src files. This should be used before making a pull request.
  516. # =======================================================================
  517. set(CLANG_FORMAT_POSTFIX "-15")
  518. find_program(CLANG_FORMAT
  519. NAMES clang-format${CLANG_FORMAT_POSTFIX}
  520. clang-format
  521. PATHS ${PROJECT_BINARY_DIR}/externals)
  522. # if find_program doesn't find it, try to download from externals
  523. if (NOT CLANG_FORMAT)
  524. if (WIN32 AND NOT CMAKE_CROSSCOMPILING)
  525. message(STATUS "Clang format not found! Downloading...")
  526. set(CLANG_FORMAT "${PROJECT_BINARY_DIR}/externals/clang-format${CLANG_FORMAT_POSTFIX}.exe")
  527. file(DOWNLOAD
  528. https://git.suyu.dev/suyu/ext-windows-bin/raw/branch/master/clang-format${CLANG_FORMAT_POSTFIX}.exe
  529. "${CLANG_FORMAT}" SHOW_PROGRESS
  530. STATUS DOWNLOAD_SUCCESS)
  531. if (NOT DOWNLOAD_SUCCESS EQUAL 0)
  532. message(WARNING "Could not download clang format! Disabling the clang format target")
  533. file(REMOVE ${CLANG_FORMAT})
  534. unset(CLANG_FORMAT)
  535. endif()
  536. else()
  537. message(WARNING "Clang format not found! Disabling the clang format target")
  538. endif()
  539. endif()
  540. if (CLANG_FORMAT)
  541. set(SRCS ${PROJECT_SOURCE_DIR}/src)
  542. set(CCOMMENT "Running clang format against all the .h and .cpp files in src/")
  543. if (WIN32)
  544. add_custom_target(clang-format
  545. COMMAND powershell.exe -Command "Get-ChildItem '${SRCS}/*' -Include *.cpp,*.h -Recurse | Foreach {&'${CLANG_FORMAT}' -i $_.fullname}"
  546. COMMENT ${CCOMMENT})
  547. elseif(MINGW)
  548. add_custom_target(clang-format
  549. COMMAND find `cygpath -u ${SRCS}` -iname *.h -o -iname *.cpp | xargs `cygpath -u ${CLANG_FORMAT}` -i
  550. COMMENT ${CCOMMENT})
  551. else()
  552. add_custom_target(clang-format
  553. COMMAND find ${SRCS} -iname *.h -o -iname *.cpp | xargs ${CLANG_FORMAT} -i
  554. COMMENT ${CCOMMENT})
  555. endif()
  556. unset(SRCS)
  557. unset(CCOMMENT)
  558. endif()
  559. # Include source code
  560. # ===================
  561. # This function should be passed a list of all files in a target. It will automatically generate
  562. # file groups following the directory hierarchy, so that the layout of the files in IDEs matches the
  563. # one in the filesystem.
  564. function(create_target_directory_groups target_name)
  565. # Place any files that aren't in the source list in a separate group so that they don't get in
  566. # the way.
  567. source_group("Other Files" REGULAR_EXPRESSION ".")
  568. get_target_property(target_sources "${target_name}" SOURCES)
  569. foreach(file_name IN LISTS target_sources)
  570. get_filename_component(dir_name "${file_name}" PATH)
  571. # Group names use '\' as a separator even though the entire rest of CMake uses '/'...
  572. string(REPLACE "/" "\\" group_name "${dir_name}")
  573. source_group("${group_name}" FILES "${file_name}")
  574. endforeach()
  575. endfunction()
  576. # Prevent boost from linking against libs when building
  577. target_link_libraries(Boost::headers INTERFACE Boost::disable_autolinking)
  578. # Adjustments for MSVC + Ninja
  579. if (MSVC AND CMAKE_GENERATOR STREQUAL "Ninja")
  580. add_compile_options(
  581. /wd4464 # relative include path contains '..'
  582. /wd4711 # function 'function' selected for automatic inline expansion
  583. /wd4820 # 'bytes' bytes padding added after construct 'member_name'
  584. )
  585. endif()
  586. if (SUYU_USE_FASTER_LD AND CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
  587. # We will assume that if the compiler is GCC, it will attempt to use ld.bfd by default.
  588. # Try to pick a faster linker.
  589. find_program(LLD lld)
  590. find_program(MOLD mold)
  591. if (MOLD AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL "12.1")
  592. message(NOTICE "Selecting mold as linker")
  593. add_link_options("-fuse-ld=mold")
  594. elseif (LLD)
  595. message(NOTICE "Selecting lld as linker")
  596. add_link_options("-fuse-ld=lld")
  597. endif()
  598. endif()
  599. add_subdirectory(src)
  600. # Set suyu project or suyu-cmd project as default StartUp Project in Visual Studio depending on whether QT is enabled or not
  601. if(ENABLE_QT)
  602. set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT suyu)
  603. else()
  604. set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT suyu-cmd)
  605. endif()
  606. # Installation instructions
  607. # =========================
  608. # Install freedesktop.org metadata files, following those specifications:
  609. # https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html
  610. # https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html
  611. # https://specifications.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html
  612. # https://www.freedesktop.org/software/appstream/docs/
  613. if(ENABLE_QT AND UNIX AND NOT APPLE)
  614. install(FILES "dist/org.suyu_emu.suyu.desktop"
  615. DESTINATION "share/applications")
  616. install(FILES "dist/suyu.svg"
  617. DESTINATION "share/icons/hicolor/scalable/apps"
  618. RENAME "org.suyu_emu.suyu.svg")
  619. install(FILES "dist/org.suyu_emu.suyu.xml"
  620. DESTINATION "share/mime/packages")
  621. install(FILES "dist/org.suyu_emu.suyu.metainfo.xml"
  622. DESTINATION "share/metainfo")
  623. endif()
  624. # Enable CCACHE. Linux only for now.
  625. if (USE_CCACHE)
  626. find_program(CCACHE_PROGRAM ccache)
  627. if(CCACHE_PROGRAM)
  628. set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "${CCACHE_PROGRAM}")
  629. if (SUYU_USE_PRECOMPILED_HEADERS)
  630. message(NOTICE "To make use of CCache, set SUYU_USE_PRECOMPILED_HEADERS to OFF or else, it will barely be functional")
  631. endif()
  632. message(STATUS "CCache found.")
  633. else()
  634. message(STATUS "CCache has not been found and it will not be used. Install CCache or set USE_CCACHE to OFF")
  635. endif()
  636. endif()