204 строк · 12 КиБ
code/crates/chl-wine/src/gamescope.rs
| 1 | //! Обёртка запуска в `gamescope` — вложенный композитор, ради надёжного HDR. |
| 2 | //! |
| 3 | //! **Почему не хватало «родного драйвера Wayland».** `wayland_driver` |
| 4 | //! (`PROTON_ENABLE_WAYLAND`/`winewayland.drv`, см. `chl_runtime::env`) отдаёт |
| 5 | //! HDR через `wp_color_manager_v1` самому композитору рабочего стола — и то, |
| 6 | //! насколько полно композитор реализует этот протокол, решает не Wine и не |
| 7 | //! этот лаунчер. На практике это и даёт замеченную перемежающуюся HDR: одна |
| 8 | //! и та же игра то получает её, то нет, без видимой причины на стороне |
| 9 | //! настроек. |
| 10 | //! |
| 11 | //! `gamescope` — тот же путь, которым Steam Deck отдаёт HDR в режиме игры: |
| 12 | //! сам владеет цепочкой показа кадров и говорит с композитором или |
| 13 | //! напрямую с DRM тем же протоколом, но из одной программы, которая для |
| 14 | //! этого и писалась, а не как побочная возможность драйвера Wine. Отсюда и |
| 15 | //! выбор — не замена `wayland_driver` в реестре настроек, а отдельный путь |
| 16 | //! рядом: у кого не заведётся `gamescope`, ничего не потеряет. |
| 17 | //! |
| 18 | //! **Порядок обёртки.** `gamescope` — самый внешний слой, а не внутренний: |
| 19 | //! ему самому нужен обычный сеанс (DRM, свой сокет Wayland на хосте), в |
| 20 | //! песочницу `bwrap` его заворачивать незачем и вредно. Всё, что должно |
| 21 | //! запуститься под ним — хоть `wine` напрямую, хоть уже собранный `bwrap` |
| 22 | //! (см. [`crate::sandbox::wrap`]) — оборачивается этой функцией последней. |
| 23 | //! |
| 24 | //! Переменные окружения копируются из исходной команды тем же приёмом, что |
| 25 | //! и в `sandbox::wrap`, но без `--clearenv`: `gamescope` — не песочница, ему |
| 26 | //! незачем терять собственное окружение хоста (`WAYLAND_DISPLAY`, |
| 27 | //! `XDG_RUNTIME_DIR`), через которое он и подключается к сеансу. |
| 28 | //! `Command::env` добавляет поверх унаследованного, а не стирает его. |
| 29 | |
| 30 | use std::path::{Path, PathBuf}; |
| 31 | use std::process::Command; |
| 32 | |
| 33 | /// Ищет `gamescope` в `PATH` — тем же приёмом, что и `sandbox::find_bwrap`. |
| 34 | /// |
| 35 | /// `None`, если не найден: настройка «HDR через gamescope» в этом случае не |
| 36 | /// должна ломать запуск, а просто не сработать (см. `Spec` в |
| 37 | /// `chl_core::settings`). |
| 38 | pub fn find_gamescope() -> Option<PathBuf> { |
| 39 | let paths = std::env::var_os("PATH")?; |
| 40 | std::env::split_paths(&paths).map(|dir| dir.join("gamescope")) |
| 41 | .chain([PathBuf::from("/usr/lib/extensions/vulkan/gamescope/bin/gamescope")]) |
| 42 | .find(|p| p.is_file()) |
| 43 | } |
| 44 | |
| 45 | /// Яркость белого SDR-картинки внутри HDR, нит: опорный белый BT.2408. |
| 46 | /// |
| 47 | /// Столько же протокол управления цветом Wayland считает опорным белым PQ, |
| 48 | /// если программа не сказала иного, и KWin приводит его к «яркости SDR» из |
| 49 | /// настроек экрана — поэтому SDR-кадры игры под gamescope выглядят так же |
| 50 | /// ярко, как рабочий стол. У gamescope своё умолчание — 400 нит, почти |
| 51 | /// вдвое ярче. |
| 52 | pub const SDR_REFERENCE_NITS: u32 = 203; |
| 53 | |
| 54 | /// Оборачивает готовую команду в `gamescope` с включённым HDR. |
| 55 | /// |
| 56 | /// `-W`/`-H` — размер вложенного окна; `-f` — на весь экран, а не окном |
| 57 | /// поверх рабочего стола: HDR-метаданные `gamescope` должен отдавать |
| 58 | /// поверхности, которая реально доходит до вывода, а не превью в углу. |
| 59 | /// |
| 60 | /// **Без `--hdr-itm-enabled`.** Обратное тональное отображение растягивает |
| 61 | /// SDR-кадры в HDR, и 25 сентября на World of Warcraft 3.3.5a (DirectX 9) |
| 62 | /// это дало пересвет: по снимку KWin яркость 0,177 → 0,221, насыщенность |
| 63 | /// 0,63 → 0,82 против SDR. FakeHDR из vkBasalt его не компенсирует (0,212 |
| 64 | /// под HDR). Кадры, которые игра сама отдаёт в HDR (DXVK_HDR, VKD3D), ITM не |
| 65 | /// трогает вовсе, так что HDR-играм он ничего не давал, а SDR-играм и |
| 66 | /// SDR-меню портил картинку. SDR теперь показывается с опорной яркостью |
| 67 | /// [`SDR_REFERENCE_NITS`]. |
| 68 | pub fn wrap(command: &Command, gamescope: &Path, width: u32, height: u32) -> Command { |
| 69 | wrap_inner(command, gamescope, width, height, false) |
| 70 | } |
| 71 | |
| 72 | /// Native HDR passthrough plus inverse tonemapping of SDR surfaces. |
| 73 | pub fn wrap_auto_hdr(command: &Command, gamescope: &Path, width: u32, height: u32) -> Command { |
| 74 | wrap_inner(command, gamescope, width, height, true) |
| 75 | } |
| 76 | |
| 77 | fn wrap_inner(command: &Command, gamescope: &Path, width: u32, height: u32, itm: bool) -> Command { |
| 78 | wrap_hdr(command, gamescope, width, height, itm, false) |
| 79 | } |
| 80 | |
| 81 | pub fn wrap_hdr(command: &Command, gamescope: &Path, width: u32, height: u32, itm: bool, force_pq: bool) -> Command { |
| 82 | let mut gs = Command::new(gamescope); |
| 83 | gs.args(["-W", &width.to_string()]); |
| 84 | gs.args(["-H", &height.to_string()]); |
| 85 | gs.arg("-f"); |
| 86 | gs.arg("--hdr-enabled"); |
| 87 | if force_pq { gs.arg("--hdr-debug-force-output"); } |
| 88 | if itm { gs.arg("--hdr-itm-enabled"); } |
| 89 | gs.args(["--hdr-sdr-content-nits", &SDR_REFERENCE_NITS.to_string()]); |
| 90 | |
| 91 | // Слои Vulkan, которые должны достаться игре, а не самому gamescope: он |
| 92 | // тоже программа Vulkan, и `ENABLE_VKBASALT=1` в его окружении грузил |
| 93 | // vkBasalt в композитор (проверено по /proc/<pid>/maps: слой был у |
| 94 | // gamescope-wl, а у Wow.exe — нет), то есть эффект ложился на всю |
| 95 | // картинку gamescope, а в игру не попадал. Такие переменные уходят |
| 96 | // игре через `env` в её командной строке. |
| 97 | let mut child_only = Vec::new(); |
| 98 | for (k, v) in command.get_envs() { |
| 99 | if let Some(v) = v { |
| 100 | if CHILD_ONLY.iter().any(|c| k == std::ffi::OsStr::new(c)) { |
| 101 | let mut kv = k.to_os_string(); |
| 102 | kv.push("="); |
| 103 | kv.push(v); |
| 104 | child_only.push(kv); |
| 105 | } else { |
| 106 | gs.env(k, v); |
| 107 | } |
| 108 | } else { |
| 109 | gs.env_remove(k); |
| 110 | } |
| 111 | } |
| 112 | if let Some(dir) = command.get_current_dir() { |
| 113 | gs.current_dir(dir); |
| 114 | } |
| 115 | |
| 116 | gs.arg("--"); |
| 117 | if !child_only.is_empty() { |
| 118 | gs.arg("/usr/bin/env"); |
| 119 | gs.args(child_only); |
| 120 | } |
| 121 | gs.arg(command.get_program()); |
| 122 | gs.args(command.get_args()); |
| 123 | gs |
| 124 | } |
| 125 | |
| 126 | /// Переменные, которые получает только игра внутри gamescope (см. [`wrap`]). |
| 127 | const CHILD_ONLY: &[&str] = &["ENABLE_VKBASALT"]; |
| 128 | |
| 129 | #[cfg(test)] |
| 130 | mod tests { |
| 131 | use super::*; |
| 132 | |
| 133 | #[test] |
| 134 | fn преобразование_sdr_включается_только_явным_режимом() { |
| 135 | let cmd = Command::new("wine"); |
| 136 | let gs = Path::new("gamescope"); |
| 137 | assert!(!wrap(&cmd, gs, 1920, 1080).get_args().any(|a| a == "--hdr-itm-enabled")); |
| 138 | let auto = wrap_auto_hdr(&cmd, gs, 1920, 1080); |
| 139 | let args: Vec<_> = auto.get_args().collect(); |
| 140 | assert!(args.iter().any(|a| *a == "--hdr-itm-enabled")); |
| 141 | assert!(args.windows(2).any(|a| a[0] == "--hdr-sdr-content-nits" && a[1] == "203")); |
| 142 | } |
| 143 | |
| 144 | fn base_command() -> Command { |
| 145 | let mut cmd = Command::new("/usr/bin/wine"); |
| 146 | cmd.env_clear(); |
| 147 | cmd.env("WINEPREFIX", "/games/pfx/pfx_default"); |
| 148 | cmd.env("WAYLAND_DISPLAY", "wayland-0"); |
| 149 | cmd.arg("game.exe"); |
| 150 | cmd.arg("--windowed"); |
| 151 | cmd |
| 152 | } |
| 153 | |
| 154 | /// Флаги и исходная программа с аргументами должны стоять в предсказуемом |
| 155 | /// порядке — от него зависит, что реально увидит `gamescope` после `--`. |
| 156 | #[test] |
| 157 | fn hdr_флаги_и_исходная_команда_идут_после_дефиса() { |
| 158 | let base = base_command(); |
| 159 | let wrapped = wrap(&base, Path::new("/usr/bin/gamescope"), 2560, 1440); |
| 160 | |
| 161 | assert_eq!(wrapped.get_program(), "/usr/bin/gamescope"); |
| 162 | let args: Vec<String> = |
| 163 | wrapped.get_args().map(|a| a.to_string_lossy().into_owned()).collect(); |
| 164 | assert_eq!( |
| 165 | args, |
| 166 | [ |
| 167 | "-W", "2560", "-H", "1440", "-f", "--hdr-enabled", "--hdr-sdr-content-nits", "203", |
| 168 | "--", "/usr/bin/wine", "game.exe", "--windowed" |
| 169 | ] |
| 170 | ); |
| 171 | } |
| 172 | |
| 173 | /// Переменные исходной команды (в т.ч. то, что несёт `PASS_THROUGH` из |
| 174 | /// `Prefix::command`) обязаны дойти до `gamescope`, иначе игра внутри |
| 175 | /// него не увидит ни свой префикс, ни сеанс. |
| 176 | #[test] |
| 177 | fn переменные_исходной_команды_доезжают_до_gamescope() { |
| 178 | let base = base_command(); |
| 179 | let wrapped = wrap(&base, Path::new("/usr/bin/gamescope"), 1920, 1080); |
| 180 | |
| 181 | let envs: std::collections::BTreeMap<String, String> = wrapped |
| 182 | .get_envs() |
| 183 | .filter_map(|(k, v)| Some((k.to_string_lossy().into_owned(), v?.to_string_lossy().into_owned()))) |
| 184 | .collect(); |
| 185 | assert_eq!(envs.get("WINEPREFIX").map(String::as_str), Some("/games/pfx/pfx_default")); |
| 186 | assert_eq!(envs.get("WAYLAND_DISPLAY").map(String::as_str), Some("wayland-0")); |
| 187 | } |
| 188 | |
| 189 | #[test] |
| 190 | fn vkbasalt_достаётся_игре_а_не_gamescope() { |
| 191 | let mut cmd = base_command(); |
| 192 | cmd.env("ENABLE_VKBASALT", "1"); |
| 193 | let gs = wrap(&cmd, Path::new("/usr/bin/gamescope"), 1920, 1080); |
| 194 | assert!( |
| 195 | !gs.get_envs().any(|(k, _)| k == "ENABLE_VKBASALT"), |
| 196 | "у самого gamescope переменной быть не должно" |
| 197 | ); |
| 198 | let args: Vec<String> = gs.get_args().map(|a| a.to_string_lossy().into_owned()).collect(); |
| 199 | let after = args.iter().position(|a| a == "--").unwrap(); |
| 200 | assert_eq!(&args[after + 1..after + 3], ["/usr/bin/env", "ENABLE_VKBASALT=1"]); |
| 201 | assert_eq!(args[after + 3], "/usr/bin/wine"); |
| 202 | } |
| 203 | } |
| 204 |