CMakeLists.txt 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702
  1. cmake_minimum_required(VERSION 3.15)
  2. list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules")
  3. list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/externals/cmake-modules")
  4. list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/externals/find-modules")
  5. include(DownloadExternals)
  6. include(CMakeDependentOption)
  7. project(yuzu)
  8. # Set bundled sdl2/qt as dependent options.
  9. # OFF by default, but if ENABLE_SDL2 and MSVC are true then ON
  10. option(ENABLE_SDL2 "Enable the SDL2 frontend" ON)
  11. CMAKE_DEPENDENT_OPTION(YUZU_USE_BUNDLED_SDL2 "Download bundled SDL2 binaries" ON "ENABLE_SDL2;MSVC" OFF)
  12. # On Linux system SDL2 is likely to be lacking HIDAPI support which have drawbacks but is needed for SDL motion
  13. option(YUZU_ALLOW_SYSTEM_SDL2 "Try using system SDL2 before fallling back to one from externals" OFF)
  14. option(ENABLE_QT "Enable the Qt frontend" ON)
  15. option(ENABLE_QT_TRANSLATION "Enable translations for the Qt frontend" OFF)
  16. CMAKE_DEPENDENT_OPTION(YUZU_USE_BUNDLED_QT "Download bundled Qt binaries" "${MSVC}" "ENABLE_QT" OFF)
  17. option(ENABLE_WEB_SERVICE "Enable web services (telemetry, etc.)" ON)
  18. option(YUZU_USE_BUNDLED_BOOST "Download bundled Boost" OFF)
  19. option(YUZU_USE_BUNDLED_LIBUSB "Compile bundled libusb" OFF)
  20. CMAKE_DEPENDENT_OPTION(YUZU_USE_BUNDLED_FFMPEG "Download/Build bundled FFmpeg" ON "WIN32" OFF)
  21. option(YUZU_USE_QT_WEB_ENGINE "Use QtWebEngine for web applet implementation" OFF)
  22. option(YUZU_ENABLE_BOXCAT "Enable the Boxcat service, a yuzu high-level implementation of BCAT" ON)
  23. option(ENABLE_CUBEB "Enables the cubeb audio backend" ON)
  24. option(USE_DISCORD_PRESENCE "Enables Discord Rich Presence" OFF)
  25. if (NOT ENABLE_WEB_SERVICE)
  26. set(YUZU_ENABLE_BOXCAT OFF)
  27. endif()
  28. # Default to a Release build
  29. get_property(IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
  30. if (NOT IS_MULTI_CONFIG AND NOT CMAKE_BUILD_TYPE)
  31. set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: Debug Release RelWithDebInfo MinSizeRel." FORCE)
  32. message(STATUS "Defaulting to a Release build")
  33. endif()
  34. if(EXISTS ${PROJECT_SOURCE_DIR}/hooks/pre-commit AND NOT EXISTS ${PROJECT_SOURCE_DIR}/.git/hooks/pre-commit)
  35. message(STATUS "Copying pre-commit hook")
  36. file(COPY hooks/pre-commit
  37. DESTINATION ${PROJECT_SOURCE_DIR}/.git/hooks)
  38. endif()
  39. # Sanity check : Check that all submodules are present
  40. # =======================================================================
  41. function(check_submodules_present)
  42. file(READ "${PROJECT_SOURCE_DIR}/.gitmodules" gitmodules)
  43. string(REGEX MATCHALL "path *= *[^ \t\r\n]*" gitmodules ${gitmodules})
  44. foreach(module ${gitmodules})
  45. string(REGEX REPLACE "path *= *" "" module ${module})
  46. if (NOT EXISTS "${PROJECT_SOURCE_DIR}/${module}/.git")
  47. message(FATAL_ERROR "Git submodule ${module} not found. "
  48. "Please run: git submodule update --init --recursive")
  49. endif()
  50. endforeach()
  51. endfunction()
  52. if(EXISTS ${PROJECT_SOURCE_DIR}/.gitmodules)
  53. check_submodules_present()
  54. endif()
  55. configure_file(${PROJECT_SOURCE_DIR}/dist/compatibility_list/compatibility_list.qrc
  56. ${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.qrc
  57. COPYONLY)
  58. if (ENABLE_COMPATIBILITY_LIST_DOWNLOAD AND NOT EXISTS ${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.json)
  59. message(STATUS "Downloading compatibility list for yuzu...")
  60. file(DOWNLOAD
  61. https://api.yuzu-emu.org/gamedb/
  62. "${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.json" SHOW_PROGRESS)
  63. endif()
  64. if (NOT EXISTS ${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.json)
  65. file(WRITE ${PROJECT_BINARY_DIR}/dist/compatibility_list/compatibility_list.json "")
  66. endif()
  67. # Detect current compilation architecture and create standard definitions
  68. # =======================================================================
  69. include(CheckSymbolExists)
  70. function(detect_architecture symbol arch)
  71. if (NOT DEFINED ARCHITECTURE)
  72. set(CMAKE_REQUIRED_QUIET 1)
  73. check_symbol_exists("${symbol}" "" ARCHITECTURE_${arch})
  74. unset(CMAKE_REQUIRED_QUIET)
  75. # The output variable needs to be unique across invocations otherwise
  76. # CMake's crazy scope rules will keep it defined
  77. if (ARCHITECTURE_${arch})
  78. set(ARCHITECTURE "${arch}" PARENT_SCOPE)
  79. set(ARCHITECTURE_${arch} 1 PARENT_SCOPE)
  80. add_definitions(-DARCHITECTURE_${arch}=1)
  81. endif()
  82. endif()
  83. endfunction()
  84. if (NOT ENABLE_GENERIC)
  85. if (MSVC)
  86. detect_architecture("_M_AMD64" x86_64)
  87. detect_architecture("_M_IX86" x86)
  88. detect_architecture("_M_ARM" ARM)
  89. detect_architecture("_M_ARM64" ARM64)
  90. else()
  91. detect_architecture("__x86_64__" x86_64)
  92. detect_architecture("__i386__" x86)
  93. detect_architecture("__arm__" ARM)
  94. detect_architecture("__aarch64__" ARM64)
  95. endif()
  96. endif()
  97. if (NOT DEFINED ARCHITECTURE)
  98. set(ARCHITECTURE "GENERIC")
  99. set(ARCHITECTURE_GENERIC 1)
  100. add_definitions(-DARCHITECTURE_GENERIC=1)
  101. endif()
  102. message(STATUS "Target architecture: ${ARCHITECTURE}")
  103. if (UNIX)
  104. add_definitions(-DYUZU_UNIX=1)
  105. endif()
  106. # Configure C++ standard
  107. # ===========================
  108. # boost asio's concept usage doesn't play nicely with some compilers yet.
  109. add_definitions(-DBOOST_ASIO_DISABLE_CONCEPTS)
  110. if (MSVC)
  111. add_compile_options(/std:c++latest)
  112. # cubeb and boost still make use of deprecated result_of.
  113. add_definitions(-D_HAS_DEPRECATED_RESULT_OF)
  114. else()
  115. set(CMAKE_CXX_STANDARD 20)
  116. set(CMAKE_CXX_STANDARD_REQUIRED ON)
  117. endif()
  118. # Output binaries to bin/
  119. set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin)
  120. # System imported libraries
  121. # If not found, download any missing through Conan
  122. # =======================================================================
  123. set(CONAN_CMAKE_SILENT_OUTPUT TRUE)
  124. set(CMAKE_FIND_PACKAGE_PREFER_CONFIG TRUE)
  125. if (YUZU_CONAN_INSTALLED)
  126. if (IS_MULTI_CONFIG)
  127. include(${CMAKE_BINARY_DIR}/conanbuildinfo_multi.cmake)
  128. else()
  129. include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
  130. endif()
  131. list(APPEND CMAKE_MODULE_PATH "${CMAKE_BINARY_DIR}")
  132. list(APPEND CMAKE_PREFIX_PATH "${CMAKE_BINARY_DIR}")
  133. conan_basic_setup()
  134. message(STATUS "Adding conan installed libraries to the search path")
  135. endif()
  136. macro(yuzu_find_packages)
  137. set(options FORCE_REQUIRED)
  138. cmake_parse_arguments(FN "${options}" "" "" ${ARGN})
  139. # Cmake has a *serious* lack of 2D array or associative array...
  140. # Capitalization matters here. We need the naming to match the generated paths from Conan
  141. set(REQUIRED_LIBS
  142. # Cmake Pkg Prefix Version Conan Pkg
  143. "Catch2 2.13 catch2/2.13.0"
  144. "fmt 8.0 fmt/8.0.0"
  145. "lz4 1.8 lz4/1.9.2"
  146. "nlohmann_json 3.8 nlohmann_json/3.8.0"
  147. "ZLIB 1.2 zlib/1.2.11"
  148. "zstd 1.5 zstd/1.5.0"
  149. # can't use opus until AVX check is fixed: https://github.com/yuzu-emu/yuzu/pull/4068
  150. #"opus 1.3 opus/1.3.1"
  151. )
  152. foreach(PACKAGE ${REQUIRED_LIBS})
  153. string(REGEX REPLACE "[ \t\r\n]+" ";" PACKAGE_SPLIT ${PACKAGE})
  154. list(GET PACKAGE_SPLIT 0 PACKAGE_PREFIX)
  155. list(GET PACKAGE_SPLIT 1 PACKAGE_VERSION)
  156. list(GET PACKAGE_SPLIT 2 PACKAGE_CONAN)
  157. # This function is called twice, once to check if the packages exist on the system already
  158. # and a second time to check if conan installed them properly. The second check passes in FORCE_REQUIRED
  159. if (NOT ${PACKAGE_PREFIX}_FOUND)
  160. if (FN_FORCE_REQUIRED)
  161. find_package(${PACKAGE_PREFIX} ${PACKAGE_VERSION} REQUIRED)
  162. else()
  163. find_package(${PACKAGE_PREFIX} ${PACKAGE_VERSION})
  164. endif()
  165. endif()
  166. if (NOT ${PACKAGE_PREFIX}_FOUND)
  167. list(APPEND CONAN_REQUIRED_LIBS ${PACKAGE_CONAN})
  168. else()
  169. # Set a legacy findPackage.cmake style PACKAGE_LIBRARIES variable for subprojects that rely on this
  170. set(${PACKAGE_PREFIX}_LIBRARIES "${PACKAGE_PREFIX}::${PACKAGE_PREFIX}")
  171. endif()
  172. endforeach()
  173. unset(FN_FORCE_REQUIRED)
  174. endmacro()
  175. if (NOT YUZU_USE_BUNDLED_BOOST)
  176. find_package(Boost 1.73.0 CONFIG COMPONENTS context headers QUIET)
  177. endif()
  178. if (Boost_FOUND)
  179. set(Boost_LIBRARIES Boost::boost)
  180. # Conditionally add Boost::context only if the active version of the Conan or system Boost package provides it
  181. # The old version is missing Boost::context, so we want to avoid adding in that case
  182. # The new version requires adding Boost::context to prevent linking issues
  183. #
  184. # This one is used by Conan on subsequent CMake configures, not the first configure.
  185. if (TARGET Boost::context)
  186. list(APPEND Boost_LIBRARIES Boost::context)
  187. endif()
  188. elseif (${CMAKE_SYSTEM_NAME} STREQUAL "Linux" OR YUZU_USE_BUNDLED_BOOST)
  189. message(STATUS "Boost 1.73.0 or newer not found, falling back to externals")
  190. set(YUZU_USE_BUNDLED_BOOST ON CACHE BOOL "Download bundled Boost" FORCE)
  191. # Use yuzu Boost binaries
  192. set(Boost_EXT_NAME "boost_1_75_0")
  193. set(Boost_PATH "${CMAKE_BINARY_DIR}/externals/${Boost_EXT_NAME}")
  194. download_bundled_external("boost/" ${Boost_EXT_NAME} "")
  195. set(Boost_USE_DEBUG_RUNTIME FALSE)
  196. set(Boost_USE_STATIC_LIBS ON)
  197. find_package(Boost 1.75.0 CONFIG REQUIRED COMPONENTS context headers PATHS ${Boost_PATH} NO_DEFAULT_PATH)
  198. # Manually set the include dirs since the find_package sets it incorrectly
  199. set(Boost_INCLUDE_DIRS ${Boost_PATH}/include CACHE PATH "Path to Boost headers" FORCE)
  200. include_directories(SYSTEM "${Boost_INCLUDE_DIRS}")
  201. else()
  202. message(STATUS "Boost 1.73.0 or newer not found, falling back to Conan")
  203. list(APPEND CONAN_REQUIRED_LIBS "boost/1.73.0")
  204. endif()
  205. # Attempt to locate any packages that are required and report the missing ones in CONAN_REQUIRED_LIBS
  206. yuzu_find_packages()
  207. # Qt5 requires that we find components, so it doesn't fit our pretty little find package function
  208. if(ENABLE_QT)
  209. set(QT_VERSION 5.12)
  210. # We want to load the generated conan qt config so that we get the QT_ROOT var so that we can use the official
  211. # Qt5Config inside the root folder instead of the conan generated one.
  212. if(EXISTS ${CMAKE_BINARY_DIR}/qtConfig.cmake)
  213. include(${CMAKE_BINARY_DIR}/qtConfig.cmake)
  214. list(APPEND CMAKE_MODULE_PATH "${CONAN_QT_ROOT_RELEASE}")
  215. list(APPEND CMAKE_PREFIX_PATH "${CONAN_QT_ROOT_RELEASE}")
  216. endif()
  217. # Check for system Qt on Linux, fallback to bundled Qt
  218. if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
  219. if (NOT YUZU_USE_BUNDLED_QT)
  220. find_package(Qt5 ${QT_VERSION} COMPONENTS Widgets QUIET)
  221. if (NOT Qt5_FOUND)
  222. set(YUZU_USE_BUNDLED_QT ON CACHE BOOL "Download bundled Qt" FORCE)
  223. endif()
  224. endif()
  225. if (YUZU_USE_BUNDLED_QT)
  226. # Binary package currently does not support Qt webengine, so make sure it's disabled
  227. set(YUZU_USE_QT_WEB_ENGINE OFF CACHE BOOL "Use Qt Webengine" FORCE)
  228. endif()
  229. endif()
  230. # Workaround for an issue where conan tries to build Qt from scratch instead of download prebuilt binaries
  231. set(QT_PREFIX_HINT)
  232. if(YUZU_USE_BUNDLED_QT)
  233. if ((MSVC_VERSION GREATER_EQUAL 1910 AND MSVC_VERSION LESS 1930) AND ARCHITECTURE_x86_64)
  234. set(QT_BUILD qt-5.12.8-msvc2017_64)
  235. elseif ((${CMAKE_SYSTEM_NAME} STREQUAL "Linux") AND NOT MINGW AND ARCHITECTURE_x86_64)
  236. set(QT_BUILD qt5_5_15_2)
  237. else()
  238. message(FATAL_ERROR "No bundled Qt binaries for your toolchain. Disable YUZU_USE_BUNDLED_QT and provide your own.")
  239. endif()
  240. if (DEFINED QT_BUILD)
  241. download_bundled_external("qt/" ${QT_BUILD} QT_PREFIX)
  242. endif()
  243. set(QT_PREFIX_HINT HINTS "${QT_PREFIX}")
  244. endif()
  245. find_package(Qt5 ${QT_VERSION} REQUIRED COMPONENTS Widgets ${QT_PREFIX_HINT} NO_CMAKE_SYSTEM_PATH)
  246. if (YUZU_USE_QT_WEB_ENGINE)
  247. find_package(Qt5 COMPONENTS WebEngineCore WebEngineWidgets)
  248. endif()
  249. if (ENABLE_QT_TRANSLATION)
  250. find_package(Qt5 REQUIRED COMPONENTS LinguistTools ${QT_PREFIX_HINT})
  251. endif()
  252. endif()
  253. # find SDL2 exports a bunch of variables that are needed, so its easier to do this outside of the yuzu_find_package
  254. if (ENABLE_SDL2)
  255. if (YUZU_USE_BUNDLED_SDL2)
  256. # Detect toolchain and platform
  257. if ((MSVC_VERSION GREATER_EQUAL 1910 AND MSVC_VERSION LESS 1930) AND ARCHITECTURE_x86_64)
  258. set(SDL2_VER "SDL2-2.0.15-prerelease")
  259. else()
  260. message(FATAL_ERROR "No bundled SDL2 binaries for your toolchain. Disable YUZU_USE_BUNDLED_SDL2 and provide your own.")
  261. endif()
  262. if (DEFINED SDL2_VER)
  263. download_bundled_external("sdl2/" ${SDL2_VER} SDL2_PREFIX)
  264. endif()
  265. set(SDL2_FOUND YES)
  266. set(SDL2_INCLUDE_DIR "${SDL2_PREFIX}/include" CACHE PATH "Path to SDL2 headers")
  267. set(SDL2_LIBRARY "${SDL2_PREFIX}/lib/x64/SDL2.lib" CACHE PATH "Path to SDL2 library")
  268. set(SDL2_DLL_DIR "${SDL2_PREFIX}/lib/x64/" CACHE PATH "Path to SDL2.dll")
  269. add_library(SDL2 INTERFACE)
  270. target_link_libraries(SDL2 INTERFACE "${SDL2_LIBRARY}")
  271. target_include_directories(SDL2 INTERFACE "${SDL2_INCLUDE_DIR}")
  272. else()
  273. if (YUZU_ALLOW_SYSTEM_SDL2)
  274. find_package(SDL2 2.0.15 QUIET)
  275. if (SDL2_FOUND)
  276. # Some installations don't set SDL2_LIBRARIES
  277. if("${SDL2_LIBRARIES}" STREQUAL "")
  278. message(WARNING "SDL2_LIBRARIES wasn't set, manually setting to SDL2::SDL2")
  279. set(SDL2_LIBRARIES "SDL2::SDL2")
  280. endif()
  281. include_directories(SYSTEM ${SDL2_INCLUDE_DIRS})
  282. add_library(SDL2 INTERFACE)
  283. target_link_libraries(SDL2 INTERFACE "${SDL2_LIBRARIES}")
  284. else()
  285. message(STATUS "SDL2 2.0.15 or newer not found, falling back to externals.")
  286. endif()
  287. else()
  288. message(STATUS "Using SDL2 from externals.")
  289. endif()
  290. endif()
  291. endif()
  292. # Install any missing dependencies with conan install
  293. if (CONAN_REQUIRED_LIBS)
  294. message(STATUS "Packages ${CONAN_REQUIRED_LIBS} not found!")
  295. # Use Conan to fetch the libraries that aren't found
  296. # Download conan.cmake automatically, you can also just copy the conan.cmake file
  297. if(NOT EXISTS "${CMAKE_BINARY_DIR}/conan.cmake")
  298. message(STATUS "Downloading conan.cmake from https://github.com/conan-io/cmake-conan")
  299. file(DOWNLOAD "https://github.com/conan-io/cmake-conan/raw/v0.15/conan.cmake"
  300. "${CMAKE_BINARY_DIR}/conan.cmake")
  301. endif()
  302. include(${CMAKE_BINARY_DIR}/conan.cmake)
  303. set(CONAN_LIB_OPTIONS
  304. libzip:with_openssl=False
  305. libzip:enable_windows_crypto=False
  306. )
  307. conan_check(VERSION 1.24.0 REQUIRED)
  308. # Manually add iconv to fix a dep conflict between qt and sdl2
  309. # We don't need to add it through find_package or anything since the other two can find it just fine
  310. if ("${CONAN_REQUIRED_LIBS}" MATCHES "qt" AND "${CONAN_REQUIRED_LIBS}" MATCHES "sdl")
  311. list(APPEND CONAN_REQUIRED_LIBS "libiconv/1.16")
  312. endif()
  313. if (IS_MULTI_CONFIG)
  314. conan_cmake_run(REQUIRES ${CONAN_REQUIRED_LIBS}
  315. OPTIONS ${CONAN_LIB_OPTIONS}
  316. BUILD missing
  317. CONFIGURATION_TYPES "Release;Debug"
  318. GENERATORS cmake_multi cmake_find_package_multi)
  319. include(${CMAKE_BINARY_DIR}/conanbuildinfo_multi.cmake)
  320. else()
  321. conan_cmake_run(REQUIRES ${CONAN_REQUIRED_LIBS}
  322. OPTIONS ${CONAN_LIB_OPTIONS}
  323. BUILD missing
  324. GENERATORS cmake cmake_find_package_multi)
  325. include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
  326. endif()
  327. list(APPEND CMAKE_MODULE_PATH "${CMAKE_BINARY_DIR}")
  328. list(APPEND CMAKE_PREFIX_PATH "${CMAKE_BINARY_DIR}")
  329. conan_basic_setup()
  330. set(YUZU_CONAN_INSTALLED TRUE CACHE BOOL "If true, the following builds will add conan to the lib search path" FORCE)
  331. # Now that we've installed what we are missing, try to locate them again,
  332. # this time with required, so we bail if its not found.
  333. yuzu_find_packages(FORCE_REQUIRED)
  334. if (NOT Boost_FOUND)
  335. find_package(Boost 1.73.0 REQUIRED COMPONENTS context headers)
  336. set(Boost_LIBRARIES Boost::boost)
  337. # Conditionally add Boost::context only if the active version of the Conan Boost package provides it
  338. # The old version is missing Boost::context, so we want to avoid adding in that case
  339. # The new version requires adding Boost::context to prevent linking issues
  340. if (TARGET Boost::context)
  341. list(APPEND Boost_LIBRARIES Boost::context)
  342. endif()
  343. endif()
  344. # Due to issues with variable scopes in functions, we need to also find_package(qt5) outside of the function
  345. if(ENABLE_QT)
  346. list(APPEND CMAKE_MODULE_PATH "${CONAN_QT_ROOT_RELEASE}")
  347. list(APPEND CMAKE_PREFIX_PATH "${CONAN_QT_ROOT_RELEASE}")
  348. find_package(Qt5 5.12 REQUIRED COMPONENTS Widgets)
  349. if (YUZU_USE_QT_WEB_ENGINE)
  350. find_package(Qt5 REQUIRED COMPONENTS WebEngineCore WebEngineWidgets)
  351. endif()
  352. endif()
  353. endif()
  354. # Reexport some targets that are named differently when using the upstream CmakeConfig vs the generated Conan config
  355. # In order to ALIAS targets to a new name, they first need to be IMPORTED_GLOBAL
  356. # Dynarmic checks for target `boost` and so we want to make sure it can find it through our system instead of using their external
  357. if (TARGET Boost::Boost)
  358. set_target_properties(Boost::Boost PROPERTIES IMPORTED_GLOBAL TRUE)
  359. add_library(Boost::boost ALIAS Boost::Boost)
  360. add_library(boost ALIAS Boost::Boost)
  361. elseif (TARGET Boost::boost)
  362. set_target_properties(Boost::boost PROPERTIES IMPORTED_GLOBAL TRUE)
  363. add_library(boost ALIAS Boost::boost)
  364. endif()
  365. # Ensure libusb is properly configured (based on dolphin libusb include)
  366. if(NOT APPLE AND NOT YUZU_USE_BUNDLED_LIBUSB)
  367. include(FindPkgConfig)
  368. if (PKG_CONFIG_FOUND)
  369. pkg_check_modules(LIBUSB QUIET libusb-1.0>=1.0.24)
  370. else()
  371. find_package(LibUSB)
  372. endif()
  373. if (LIBUSB_FOUND)
  374. add_library(usb INTERFACE)
  375. target_include_directories(usb INTERFACE "${LIBUSB_INCLUDE_DIRS}")
  376. target_link_libraries(usb INTERFACE "${LIBUSB_LIBRARIES}")
  377. else()
  378. message(WARNING "libusb not found, falling back to externals")
  379. set(YUZU_USE_BUNDLED_LIBUSB ON)
  380. endif()
  381. endif()
  382. # List of all FFmpeg components required
  383. set(FFmpeg_COMPONENTS
  384. avcodec
  385. avutil
  386. swscale)
  387. if (NOT YUZU_USE_BUNDLED_FFMPEG)
  388. # Use system installed FFmpeg
  389. find_package(FFmpeg QUIET COMPONENTS ${FFmpeg_COMPONENTS})
  390. if (FFmpeg_FOUND)
  391. # Overwrite aggregate defines from FFmpeg module to avoid over-linking libraries.
  392. # Prevents shipping too many libraries with the AppImage.
  393. set(FFmpeg_LIBRARIES "")
  394. set(FFmpeg_INCLUDE_DIR "")
  395. foreach(COMPONENT ${FFmpeg_COMPONENTS})
  396. set(FFmpeg_LIBRARIES ${FFmpeg_LIBRARIES} ${FFmpeg_LIBRARY_${COMPONENT}} CACHE PATH "Paths to FFmpeg libraries" FORCE)
  397. set(FFmpeg_INCLUDE_DIR ${FFmpeg_INCLUDE_DIR} ${FFmpeg_INCLUDE_${COMPONENT}} CACHE PATH "Path to FFmpeg headers" FORCE)
  398. endforeach()
  399. else()
  400. message(WARNING "FFmpeg not found, falling back to externals")
  401. set(YUZU_USE_BUNDLED_FFMPEG ON)
  402. endif()
  403. endif()
  404. if (YUZU_USE_BUNDLED_FFMPEG)
  405. if (NOT WIN32)
  406. # Build FFmpeg from externals
  407. message(STATUS "Using FFmpeg from externals")
  408. # FFmpeg has source that requires one of nasm or yasm to assemble it.
  409. # REQUIRED throws an error if not found here during configuration rather than during compilation.
  410. find_program(ASSEMBLER NAMES nasm yasm REQUIRED)
  411. set(FFmpeg_PREFIX ${PROJECT_SOURCE_DIR}/externals/ffmpeg)
  412. set(FFmpeg_BUILD_DIR ${PROJECT_BINARY_DIR}/externals/ffmpeg)
  413. set(FFmpeg_MAKEFILE ${FFmpeg_BUILD_DIR}/Makefile)
  414. make_directory(${FFmpeg_BUILD_DIR})
  415. # Read version string from external
  416. file(READ ${FFmpeg_PREFIX}/RELEASE FFmpeg_VERSION)
  417. set(FFmpeg_FOUND NO)
  418. if (NOT FFmpeg_VERSION STREQUAL "")
  419. set(FFmpeg_FOUND YES)
  420. endif()
  421. unset(FFmpeg_LIBRARIES CACHE)
  422. foreach(COMPONENT ${FFmpeg_COMPONENTS})
  423. set(FFmpeg_${COMPONENT}_PREFIX "${FFmpeg_BUILD_DIR}/lib${COMPONENT}")
  424. set(FFmpeg_${COMPONENT}_LIB_NAME "lib${COMPONENT}.a")
  425. set(FFmpeg_${COMPONENT}_LIBRARY "${FFmpeg_${COMPONENT}_PREFIX}/${FFmpeg_${COMPONENT}_LIB_NAME}")
  426. set(FFmpeg_LIBRARIES
  427. ${FFmpeg_LIBRARIES}
  428. ${FFmpeg_${COMPONENT}_LIBRARY}
  429. CACHE PATH "Paths to FFmpeg libraries" FORCE)
  430. endforeach()
  431. set(FFmpeg_INCLUDE_DIR
  432. "${FFmpeg_PREFIX};${FFmpeg_BUILD_DIR}"
  433. CACHE PATH "Path to FFmpeg headers" FORCE)
  434. # `configure` parameters builds only exactly what yuzu needs from FFmpeg
  435. # `--disable-{vaapi,vdpau}` is needed to avoid linking issues
  436. add_custom_command(
  437. OUTPUT
  438. ${FFmpeg_MAKEFILE}
  439. COMMAND
  440. /bin/bash ${FFmpeg_PREFIX}/configure
  441. --disable-avdevice
  442. --disable-avfilter
  443. --disable-avformat
  444. --disable-doc
  445. --disable-everything
  446. --disable-ffmpeg
  447. --disable-ffprobe
  448. --disable-network
  449. --disable-postproc
  450. --disable-swresample
  451. --disable-vaapi
  452. --disable-vdpau
  453. --enable-decoder=h264
  454. --enable-decoder=vp9
  455. WORKING_DIRECTORY
  456. ${FFmpeg_BUILD_DIR}
  457. )
  458. # Workaround for Ubuntu 18.04's older version of make not being able to call make as a child
  459. # with context of the jobserver. Also helps ninja users.
  460. execute_process(
  461. COMMAND
  462. nproc
  463. OUTPUT_VARIABLE
  464. SYSTEM_THREADS)
  465. add_custom_command(
  466. OUTPUT
  467. ${FFmpeg_LIBRARIES}
  468. COMMAND
  469. make -j${SYSTEM_THREADS}
  470. WORKING_DIRECTORY
  471. ${FFmpeg_BUILD_DIR}
  472. )
  473. # ALL makes this custom target build every time
  474. # but it won't actually build if the DEPENDS parameter is up to date
  475. add_custom_target(ffmpeg-configure ALL DEPENDS ${FFmpeg_MAKEFILE})
  476. add_custom_target(ffmpeg-build ALL DEPENDS ${FFmpeg_LIBRARIES} ffmpeg-configure)
  477. if (FFmpeg_FOUND)
  478. message(STATUS "Found FFmpeg version ${FFmpeg_VERSION}")
  479. else()
  480. message(FATAL_ERROR "FFmpeg not found")
  481. endif()
  482. else() # WIN32
  483. # Use yuzu FFmpeg binaries
  484. set(FFmpeg_EXT_NAME "ffmpeg-4.3.1")
  485. set(FFmpeg_PATH "${CMAKE_BINARY_DIR}/externals/${FFmpeg_EXT_NAME}")
  486. download_bundled_external("ffmpeg/" ${FFmpeg_EXT_NAME} "")
  487. set(FFmpeg_FOUND YES)
  488. set(FFmpeg_INCLUDE_DIR "${FFmpeg_PATH}/include" CACHE PATH "Path to FFmpeg headers" FORCE)
  489. set(FFmpeg_LIBRARY_DIR "${FFmpeg_PATH}/bin" CACHE PATH "Path to FFmpeg library directory" FORCE)
  490. set(FFmpeg_DLL_DIR "${FFmpeg_PATH}/bin" CACHE PATH "Path to FFmpeg dll's" FORCE)
  491. set(FFmpeg_LIBRARIES
  492. ${FFmpeg_LIBRARY_DIR}/swscale.lib
  493. ${FFmpeg_LIBRARY_DIR}/avcodec.lib
  494. ${FFmpeg_LIBRARY_DIR}/avutil.lib
  495. CACHE PATH "Paths to FFmpeg libraries" FORCE)
  496. endif()
  497. endif()
  498. unset(FFmpeg_COMPONENTS)
  499. # Prefer the -pthread flag on Linux.
  500. set(THREADS_PREFER_PTHREAD_FLAG ON)
  501. find_package(Threads REQUIRED)
  502. # Platform-specific library requirements
  503. # ======================================
  504. if (APPLE)
  505. # Umbrella framework for everything GUI-related
  506. find_library(COCOA_LIBRARY Cocoa)
  507. set(PLATFORM_LIBRARIES ${COCOA_LIBRARY} ${IOKIT_LIBRARY} ${COREVIDEO_LIBRARY})
  508. elseif (WIN32)
  509. # WSAPoll and SHGetKnownFolderPath (AppData/Roaming) didn't exist before WinNT 6.x (Vista)
  510. add_definitions(-D_WIN32_WINNT=0x0600 -DWINVER=0x0600)
  511. set(PLATFORM_LIBRARIES winmm ws2_32)
  512. if (MINGW)
  513. # PSAPI is the Process Status API
  514. set(PLATFORM_LIBRARIES ${PLATFORM_LIBRARIES} psapi imm32 version)
  515. endif()
  516. elseif (CMAKE_SYSTEM_NAME MATCHES "^(Linux|kFreeBSD|GNU|SunOS)$")
  517. set(PLATFORM_LIBRARIES rt)
  518. endif()
  519. # Setup a custom clang-format target (if clang-format can be found) that will run
  520. # against all the src files. This should be used before making a pull request.
  521. # =======================================================================
  522. set(CLANG_FORMAT_POSTFIX "-10")
  523. find_program(CLANG_FORMAT
  524. NAMES clang-format${CLANG_FORMAT_POSTFIX}
  525. clang-format
  526. PATHS ${PROJECT_BINARY_DIR}/externals)
  527. # if find_program doesn't find it, try to download from externals
  528. if (NOT CLANG_FORMAT)
  529. if (WIN32 AND NOT CMAKE_CROSSCOMPILING)
  530. message(STATUS "Clang format not found! Downloading...")
  531. set(CLANG_FORMAT "${PROJECT_BINARY_DIR}/externals/clang-format${CLANG_FORMAT_POSTFIX}.exe")
  532. file(DOWNLOAD
  533. https://github.com/yuzu-emu/ext-windows-bin/raw/master/clang-format${CLANG_FORMAT_POSTFIX}.exe
  534. "${CLANG_FORMAT}" SHOW_PROGRESS
  535. STATUS DOWNLOAD_SUCCESS)
  536. if (NOT DOWNLOAD_SUCCESS EQUAL 0)
  537. message(WARNING "Could not download clang format! Disabling the clang format target")
  538. file(REMOVE ${CLANG_FORMAT})
  539. unset(CLANG_FORMAT)
  540. endif()
  541. else()
  542. message(WARNING "Clang format not found! Disabling the clang format target")
  543. endif()
  544. endif()
  545. if (CLANG_FORMAT)
  546. set(SRCS ${PROJECT_SOURCE_DIR}/src)
  547. set(CCOMMENT "Running clang format against all the .h and .cpp files in src/")
  548. if (WIN32)
  549. add_custom_target(clang-format
  550. COMMAND powershell.exe -Command "Get-ChildItem '${SRCS}/*' -Include *.cpp,*.h -Recurse | Foreach {&'${CLANG_FORMAT}' -i $_.fullname}"
  551. COMMENT ${CCOMMENT})
  552. elseif(MINGW)
  553. add_custom_target(clang-format
  554. COMMAND find `cygpath -u ${SRCS}` -iname *.h -o -iname *.cpp | xargs `cygpath -u ${CLANG_FORMAT}` -i
  555. COMMENT ${CCOMMENT})
  556. else()
  557. add_custom_target(clang-format
  558. COMMAND find ${SRCS} -iname *.h -o -iname *.cpp | xargs ${CLANG_FORMAT} -i
  559. COMMENT ${CCOMMENT})
  560. endif()
  561. unset(SRCS)
  562. unset(CCOMMENT)
  563. endif()
  564. # Include source code
  565. # ===================
  566. # This function should be passed a list of all files in a target. It will automatically generate
  567. # file groups following the directory hierarchy, so that the layout of the files in IDEs matches the
  568. # one in the filesystem.
  569. function(create_target_directory_groups target_name)
  570. # Place any files that aren't in the source list in a separate group so that they don't get in
  571. # the way.
  572. source_group("Other Files" REGULAR_EXPRESSION ".")
  573. get_target_property(target_sources "${target_name}" SOURCES)
  574. foreach(file_name IN LISTS target_sources)
  575. get_filename_component(dir_name "${file_name}" PATH)
  576. # Group names use '\' as a separator even though the entire rest of CMake uses '/'...
  577. string(REPLACE "/" "\\" group_name "${dir_name}")
  578. source_group("${group_name}" FILES "${file_name}")
  579. endforeach()
  580. endfunction()
  581. # Prevent boost from linking against libs when building
  582. add_definitions(-DBOOST_ERROR_CODE_HEADER_ONLY
  583. -DBOOST_SYSTEM_NO_LIB
  584. -DBOOST_DATE_TIME_NO_LIB
  585. -DBOOST_REGEX_NO_LIB
  586. )
  587. enable_testing()
  588. add_subdirectory(externals)
  589. add_subdirectory(src)
  590. # Set yuzu project or yuzu-cmd project as default StartUp Project in Visual Studio depending on whether QT is enabled or not
  591. if(ENABLE_QT)
  592. set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT yuzu)
  593. else()
  594. set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT yuzu-cmd)
  595. endif()
  596. # Installation instructions
  597. # =========================
  598. # Install freedesktop.org metadata files, following those specifications:
  599. # http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html
  600. # http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html
  601. # http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html
  602. if(ENABLE_QT AND UNIX AND NOT APPLE)
  603. install(FILES "${PROJECT_SOURCE_DIR}/dist/yuzu.desktop"
  604. DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications")
  605. install(FILES "${PROJECT_SOURCE_DIR}/dist/yuzu.svg"
  606. DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/apps")
  607. install(FILES "${PROJECT_SOURCE_DIR}/dist/yuzu.xml"
  608. DESTINATION "${CMAKE_INSTALL_PREFIX}/share/mime/packages")
  609. endif()