CMakeLists.txt 28 KB

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