CMakeLists.txt 28 KB

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