CMakeLists.txt 30 KB

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